cloudmersive-validate-api-client 1.3.6 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +25 -9
- data/cloudmersive-validate-api-client.gemspec +1 -1
- data/docs/AddressApi.md +166 -1
- data/docs/AddressGetServersResponse.md +2 -2
- data/docs/AddressVerifySyntaxOnlyResponse.md +3 -0
- data/docs/DomainApi.md +8 -8
- data/docs/EmailApi.md +3 -3
- data/docs/GetTimezonesRequest.md +8 -0
- data/docs/GetTimezonesResponse.md +13 -0
- data/docs/IPAddressApi.md +1 -1
- data/docs/LeadEnrichmentApi.md +61 -0
- data/docs/LeadEnrichmentRequest.md +21 -0
- data/docs/LeadEnrichmentResponse.md +25 -0
- data/docs/NameApi.md +59 -4
- data/docs/ParseAddressResponse.md +2 -1
- data/docs/PhoneNumberApi.md +1 -1
- data/docs/Timezone.md +10 -0
- data/docs/UserAgentApi.md +1 -1
- data/docs/ValidateAddressRequest.md +13 -0
- data/docs/ValidateAddressResponse.md +10 -0
- data/docs/ValidateCountryRequest.md +8 -0
- data/docs/ValidateCountryResponse.md +13 -0
- data/docs/ValidateIdentifierRequest.md +15 -0
- data/docs/ValidateIdentifierResponse.md +9 -0
- data/docs/ValidateUrlRequestFull.md +1 -1
- data/docs/ValidateUrlRequestSyntaxOnly.md +1 -1
- data/docs/VatApi.md +5 -5
- data/docs/VatLookupRequest.md +1 -1
- data/docs/VatLookupResponse.md +12 -5
- data/docs/WhoisResponse.md +11 -0
- data/lib/cloudmersive-validate-api-client.rb +13 -1
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +167 -2
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +9 -9
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +4 -4
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +2 -2
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +78 -0
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +60 -5
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +2 -2
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +2 -2
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +6 -6
- data/lib/cloudmersive-validate-api-client/api_client.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-validate-api-client/configuration.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +3 -1
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +35 -5
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +241 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +319 -0
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +359 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +18 -8
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/timezone.rb +209 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +239 -0
- data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +209 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +241 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +259 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +2 -1
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +2 -1
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +2 -1
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +80 -5
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +112 -2
- data/lib/cloudmersive-validate-api-client/version.rb +2 -2
- data/spec/api/address_api_spec.rb +37 -1
- data/spec/api/domain_api_spec.rb +3 -3
- data/spec/api/email_api_spec.rb +1 -1
- data/spec/api/ip_address_api_spec.rb +1 -1
- data/spec/api/lead_enrichment_api_spec.rb +47 -0
- data/spec/api/name_api_spec.rb +13 -1
- data/spec/api/phone_number_api_spec.rb +1 -1
- data/spec/api/user_agent_api_spec.rb +1 -1
- data/spec/api/vat_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/address_get_servers_response_spec.rb +1 -1
- data/spec/models/address_verify_syntax_only_response_spec.rb +19 -1
- data/spec/models/check_response_spec.rb +1 -1
- data/spec/models/first_name_validation_request_spec.rb +1 -1
- data/spec/models/first_name_validation_response_spec.rb +1 -1
- data/spec/models/full_email_validation_response_spec.rb +1 -1
- data/spec/models/full_name_validation_request_spec.rb +1 -1
- data/spec/models/full_name_validation_response_spec.rb +1 -1
- data/spec/models/geolocate_response_spec.rb +1 -1
- data/spec/models/get_gender_request_spec.rb +1 -1
- data/spec/models/get_gender_response_spec.rb +1 -1
- data/spec/models/get_timezones_request_spec.rb +42 -0
- data/spec/models/get_timezones_response_spec.rb +72 -0
- data/spec/models/last_name_validation_request_spec.rb +1 -1
- data/spec/models/last_name_validation_response_spec.rb +1 -1
- data/spec/models/lead_enrichment_request_spec.rb +120 -0
- data/spec/models/lead_enrichment_response_spec.rb +144 -0
- data/spec/models/parse_address_request_spec.rb +1 -1
- data/spec/models/parse_address_response_spec.rb +8 -2
- data/spec/models/phone_number_validate_request_spec.rb +1 -1
- data/spec/models/phone_number_validation_response_spec.rb +1 -1
- data/spec/models/timezone_spec.rb +54 -0
- data/spec/models/user_agent_validate_request_spec.rb +1 -1
- data/spec/models/user_agent_validate_response_spec.rb +1 -1
- data/spec/models/validate_address_request_spec.rb +72 -0
- data/spec/models/validate_address_response_spec.rb +54 -0
- data/spec/models/validate_country_request_spec.rb +42 -0
- data/spec/models/validate_country_response_spec.rb +72 -0
- data/spec/models/validate_identifier_request_spec.rb +84 -0
- data/spec/models/validate_identifier_response_spec.rb +48 -0
- data/spec/models/validate_url_request_full_spec.rb +1 -1
- data/spec/models/validate_url_request_syntax_only_spec.rb +1 -1
- data/spec/models/validate_url_response_full_spec.rb +1 -1
- data/spec/models/validate_url_response_syntax_only_spec.rb +1 -1
- data/spec/models/vat_lookup_request_spec.rb +1 -1
- data/spec/models/vat_lookup_response_spec.rb +43 -1
- data/spec/models/whois_response_spec.rb +67 -1
- data/spec/spec_helper.rb +1 -1
- metadata +51 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1dd31c396fb2d49d594cb0acf9389b9d9eafb01730cdde578e076b02399126a2
|
|
4
|
+
data.tar.gz: 19351b79a40f5fd76e00d9959cd663fb2cbb071974c9ff649c036ac3ef4c8dc6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b2f4e4d201eb955b6dcd9d546f3569ed794734a351b1d3fd4e5753b6f49d7f429e112daeeecf731c23ba33014c886d0587082d8ce8085bcdcb82649d35419585
|
|
7
|
+
data.tar.gz: 11895ff892a925b1a5376b1cb743e3abb859610c06640d509b714845a945f20f41503fca85369e4f0ca0c911279a1ba8d7f39fa0f2c1950b8cea9dd6c441e939
|
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: 1.
|
|
10
|
+
- Package version: 1.4.2
|
|
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-1.
|
|
26
|
+
gem install ./cloudmersive-validate-api-client-1.4.2.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.4.2.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', '~> 1.
|
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 1.4.2'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -64,15 +64,15 @@ end
|
|
|
64
64
|
|
|
65
65
|
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
|
66
66
|
|
|
67
|
-
input = CloudmersiveValidateApiClient::
|
|
67
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
begin
|
|
71
|
-
#
|
|
72
|
-
result = api_instance.
|
|
71
|
+
#Validate and normalize country information, return ISO 3166-1 country codes and country name
|
|
72
|
+
result = api_instance.address_country(input)
|
|
73
73
|
p result
|
|
74
74
|
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
75
|
-
puts "Exception when calling AddressApi->
|
|
75
|
+
puts "Exception when calling AddressApi->address_country: #{e}"
|
|
76
76
|
end
|
|
77
77
|
|
|
78
78
|
```
|
|
@@ -83,7 +83,10 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
83
83
|
|
|
84
84
|
Class | Method | HTTP request | Description
|
|
85
85
|
------------ | ------------- | ------------- | -------------
|
|
86
|
+
*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
|
|
87
|
+
*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
|
|
86
88
|
*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
|
|
89
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
|
87
90
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
|
88
91
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
|
89
92
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
|
@@ -92,13 +95,15 @@ Class | Method | HTTP request | Description
|
|
|
92
95
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
|
93
96
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
|
94
97
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
|
98
|
+
*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
|
|
95
99
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
|
100
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
|
96
101
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
|
97
102
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
|
98
103
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
|
99
104
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
|
100
105
|
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
|
101
|
-
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup |
|
|
106
|
+
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
|
102
107
|
|
|
103
108
|
|
|
104
109
|
## Documentation for Models
|
|
@@ -114,14 +119,25 @@ Class | Method | HTTP request | Description
|
|
|
114
119
|
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
|
115
120
|
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
|
116
121
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
|
122
|
+
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
|
123
|
+
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
|
117
124
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
|
118
125
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
|
126
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
|
127
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
|
|
119
128
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
|
120
129
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
|
121
130
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
|
122
131
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
|
132
|
+
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
|
123
133
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
|
124
134
|
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
|
135
|
+
- [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
|
|
136
|
+
- [CloudmersiveValidateApiClient::ValidateAddressResponse](docs/ValidateAddressResponse.md)
|
|
137
|
+
- [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
|
|
138
|
+
- [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
|
|
139
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
|
140
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
|
125
141
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
|
126
142
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
|
|
127
143
|
- [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
|
data/docs/AddressApi.md
CHANGED
|
@@ -4,7 +4,118 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**address_country**](AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
|
|
8
|
+
[**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
|
7
9
|
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
|
10
|
+
[**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **address_country**
|
|
14
|
+
> ValidateCountryResponse address_country(input)
|
|
15
|
+
|
|
16
|
+
Validate and normalize country information, return ISO 3166-1 country codes and country name
|
|
17
|
+
|
|
18
|
+
Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'cloudmersive-validate-api-client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
26
|
+
# Configure API key authorization: Apikey
|
|
27
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
|
33
|
+
|
|
34
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Validate and normalize country information, return ISO 3166-1 country codes and country name
|
|
39
|
+
result = api_instance.address_country(input)
|
|
40
|
+
p result
|
|
41
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
42
|
+
puts "Exception when calling AddressApi->address_country: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[Apikey](../README.md#Apikey)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: application/json, text/json
|
|
63
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
# **address_get_timezone**
|
|
68
|
+
> GetTimezonesResponse address_get_timezone(input)
|
|
69
|
+
|
|
70
|
+
Gets IANA/Olsen time zones for a country
|
|
71
|
+
|
|
72
|
+
Gets the IANA/Olsen time zones for a country.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'cloudmersive-validate-api-client'
|
|
78
|
+
# setup authorization
|
|
79
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
80
|
+
# Configure API key authorization: Apikey
|
|
81
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
82
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
83
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
|
87
|
+
|
|
88
|
+
input = CloudmersiveValidateApiClient::GetTimezonesRequest.new # GetTimezonesRequest | Input request
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
begin
|
|
92
|
+
#Gets IANA/Olsen time zones for a country
|
|
93
|
+
result = api_instance.address_get_timezone(input)
|
|
94
|
+
p result
|
|
95
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
96
|
+
puts "Exception when calling AddressApi->address_get_timezone: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
Name | Type | Description | Notes
|
|
103
|
+
------------- | ------------- | ------------- | -------------
|
|
104
|
+
**input** | [**GetTimezonesRequest**](GetTimezonesRequest.md)| Input request |
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
[**GetTimezonesResponse**](GetTimezonesResponse.md)
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[Apikey](../README.md#Apikey)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: application/json, text/json
|
|
117
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
118
|
+
|
|
8
119
|
|
|
9
120
|
|
|
10
121
|
# **address_parse_string**
|
|
@@ -56,7 +167,61 @@ Name | Type | Description | Notes
|
|
|
56
167
|
|
|
57
168
|
### HTTP request headers
|
|
58
169
|
|
|
59
|
-
- **Content-Type**: application/json, text/json
|
|
170
|
+
- **Content-Type**: application/json, text/json
|
|
171
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
# **address_validate_address**
|
|
176
|
+
> ValidateAddressResponse address_validate_address(input)
|
|
177
|
+
|
|
178
|
+
Validate a street address
|
|
179
|
+
|
|
180
|
+
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.
|
|
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::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
begin
|
|
200
|
+
#Validate a street address
|
|
201
|
+
result = api_instance.address_validate_address(input)
|
|
202
|
+
p result
|
|
203
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
204
|
+
puts "Exception when calling AddressApi->address_validate_address: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
Name | Type | Description | Notes
|
|
211
|
+
------------- | ------------- | ------------- | -------------
|
|
212
|
+
**input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**ValidateAddressResponse**](ValidateAddressResponse.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
[Apikey](../README.md#Apikey)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: application/json, text/json
|
|
60
225
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
61
226
|
|
|
62
227
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**success** | **BOOLEAN** |
|
|
7
|
-
**servers** | **Array<String>** |
|
|
6
|
+
**success** | **BOOLEAN** | True if partial address validation was successufl, false otherwise | [optional]
|
|
7
|
+
**servers** | **Array<String>** | Email servers for this email address | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -4,5 +4,8 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**valid_address** | **BOOLEAN** | True if the email address is syntactically valid, false if it is not | [optional]
|
|
7
|
+
**domain** | **String** | Domain name of the email address | [optional]
|
|
8
|
+
**is_free_email_provider** | **BOOLEAN** | True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise. | [optional]
|
|
9
|
+
**is_disposable** | **BOOLEAN** | True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there. | [optional]
|
|
7
10
|
|
|
8
11
|
|
data/docs/DomainApi.md
CHANGED
|
@@ -59,7 +59,7 @@ Name | Type | Description | Notes
|
|
|
59
59
|
|
|
60
60
|
### HTTP request headers
|
|
61
61
|
|
|
62
|
-
- **Content-Type**:
|
|
62
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
63
63
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
64
64
|
|
|
65
65
|
|
|
@@ -113,7 +113,7 @@ Name | Type | Description | Notes
|
|
|
113
113
|
|
|
114
114
|
### HTTP request headers
|
|
115
115
|
|
|
116
|
-
- **Content-Type**:
|
|
116
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
117
117
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
118
118
|
|
|
119
119
|
|
|
@@ -139,7 +139,7 @@ end
|
|
|
139
139
|
|
|
140
140
|
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
141
141
|
|
|
142
|
-
request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull |
|
|
142
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | Input URL request
|
|
143
143
|
|
|
144
144
|
|
|
145
145
|
begin
|
|
@@ -155,7 +155,7 @@ end
|
|
|
155
155
|
|
|
156
156
|
Name | Type | Description | Notes
|
|
157
157
|
------------- | ------------- | ------------- | -------------
|
|
158
|
-
**request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)|
|
|
158
|
+
**request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)| Input URL request |
|
|
159
159
|
|
|
160
160
|
### Return type
|
|
161
161
|
|
|
@@ -167,7 +167,7 @@ Name | Type | Description | Notes
|
|
|
167
167
|
|
|
168
168
|
### HTTP request headers
|
|
169
169
|
|
|
170
|
-
- **Content-Type**: application/json, text/json
|
|
170
|
+
- **Content-Type**: application/json, text/json
|
|
171
171
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
172
172
|
|
|
173
173
|
|
|
@@ -193,7 +193,7 @@ end
|
|
|
193
193
|
|
|
194
194
|
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
195
195
|
|
|
196
|
-
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly |
|
|
196
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
|
|
197
197
|
|
|
198
198
|
|
|
199
199
|
begin
|
|
@@ -209,7 +209,7 @@ end
|
|
|
209
209
|
|
|
210
210
|
Name | Type | Description | Notes
|
|
211
211
|
------------- | ------------- | ------------- | -------------
|
|
212
|
-
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)|
|
|
212
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information |
|
|
213
213
|
|
|
214
214
|
### Return type
|
|
215
215
|
|
|
@@ -221,7 +221,7 @@ Name | Type | Description | Notes
|
|
|
221
221
|
|
|
222
222
|
### HTTP request headers
|
|
223
223
|
|
|
224
|
-
- **Content-Type**: application/json, text/json
|
|
224
|
+
- **Content-Type**: application/json, text/json
|
|
225
225
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
226
226
|
|
|
227
227
|
|
data/docs/EmailApi.md
CHANGED
|
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
|
|
|
58
58
|
|
|
59
59
|
### HTTP request headers
|
|
60
60
|
|
|
61
|
-
- **Content-Type**:
|
|
61
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
62
62
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
63
63
|
|
|
64
64
|
|
|
@@ -112,7 +112,7 @@ Name | Type | Description | Notes
|
|
|
112
112
|
|
|
113
113
|
### HTTP request headers
|
|
114
114
|
|
|
115
|
-
- **Content-Type**:
|
|
115
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
116
116
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
117
117
|
|
|
118
118
|
|
|
@@ -166,7 +166,7 @@ Name | Type | Description | Notes
|
|
|
166
166
|
|
|
167
167
|
### HTTP request headers
|
|
168
168
|
|
|
169
|
-
- **Content-Type**:
|
|
169
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
170
170
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
171
171
|
|
|
172
172
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::GetTimezonesRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**country_code_or_name** | **String** | Can be the two-letter, three-letter country codes or country name | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::GetTimezonesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
|
7
|
+
**country_full_name** | **String** | Full name of the country | [optional]
|
|
8
|
+
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
|
9
|
+
**fips_two_letter_code** | **String** | Two-letter FIPS 10-4 country code | [optional]
|
|
10
|
+
**three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
|
|
11
|
+
**timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/IPAddressApi.md
CHANGED
|
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
|
|
|
56
56
|
|
|
57
57
|
### HTTP request headers
|
|
58
58
|
|
|
59
|
-
- **Content-Type**:
|
|
59
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
|
60
60
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
61
61
|
|
|
62
62
|
|