cloudmersive-validate-api-client 1.3.5 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -8
- data/cloudmersive-validate-api-client.gemspec +1 -1
- data/docs/AddressApi.md +111 -1
- data/docs/AddressGetServersResponse.md +2 -2
- data/docs/AddressVerifySyntaxOnlyResponse.md +3 -0
- data/docs/DomainApi.md +60 -5
- 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 +63 -0
- data/docs/UserAgentValidateRequest.md +8 -0
- data/docs/UserAgentValidateResponse.md +21 -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 +8 -0
- data/docs/ValidateUrlRequestSyntaxOnly.md +1 -1
- data/docs/ValidateUrlResponseFull.md +12 -0
- data/docs/VatApi.md +1 -1
- 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 +16 -1
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +112 -2
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +61 -6
- 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 +78 -0
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +2 -2
- 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 +189 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +319 -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 +189 -0
- 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 +229 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +2 -2
- 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 +25 -1
- data/spec/api/domain_api_spec.rb +14 -2
- 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 +47 -0
- data/spec/api/vat_api_spec.rb +1 -1
- 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 +42 -0
- data/spec/models/user_agent_validate_response_spec.rb +120 -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 +42 -0
- data/spec/models/validate_url_request_syntax_only_spec.rb +1 -1
- data/spec/models/validate_url_response_full_spec.rb +66 -0
- 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 +60 -16
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 13df5321a985dfdbbabdba068cc518b9e265e3044dcd9a8eed682dd741d0a9f2
|
4
|
+
data.tar.gz: 04f195e201367e9bbc07a92b21031bf4966bbdee8e48d267008019a68ed5961f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a5f0b2b7dfd415190a973c18687ba7cd3465b92a6c54bd175134a1a721349edef0c5c5da49649aadcb10243f72cdcd34bd66eb2d49b00666f2d27a3f398c7499
|
7
|
+
data.tar.gz: a2444c2063a4bf85f8eda2fe3c6f8e3ea0a018b5c80d32e139184027ba34678bf93282574ffbd718d32be67d0fe53c526bdeaeb8152e115a5b4defa0ed48fd23
|
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.1
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-validate-api-client-1.
|
26
|
+
gem install ./cloudmersive-validate-api-client-1.4.1.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.1.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-validate-api-client', '~> 1.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 1.4.1'
|
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,19 +83,25 @@ 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
|
87
89
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
88
90
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
91
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
89
92
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
90
93
|
*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
|
91
94
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
92
95
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
93
96
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
97
|
+
*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
|
94
98
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
99
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
95
100
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
96
101
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
97
102
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
98
103
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
104
|
+
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
99
105
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Lookup a VAT code
|
100
106
|
|
101
107
|
|
@@ -112,13 +118,26 @@ Class | Method | HTTP request | Description
|
|
112
118
|
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
113
119
|
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
114
120
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
121
|
+
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
122
|
+
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
115
123
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
116
124
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
125
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
126
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
|
117
127
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
118
128
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
119
129
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
120
130
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
131
|
+
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
132
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
133
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
134
|
+
- [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
|
135
|
+
- [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
|
136
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
137
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
138
|
+
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
121
139
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
|
140
|
+
- [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
|
122
141
|
- [CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly](docs/ValidateUrlResponseSyntaxOnly.md)
|
123
142
|
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
124
143
|
- [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
|
data/docs/AddressApi.md
CHANGED
@@ -4,9 +4,119 @@ 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
|
8
10
|
|
9
11
|
|
12
|
+
# **address_country**
|
13
|
+
> ValidateCountryResponse address_country(input)
|
14
|
+
|
15
|
+
Validate and normalize country information, return ISO 3166-1 country codes and country name
|
16
|
+
|
17
|
+
Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'cloudmersive-validate-api-client'
|
23
|
+
# setup authorization
|
24
|
+
CloudmersiveValidateApiClient.configure do |config|
|
25
|
+
# Configure API key authorization: Apikey
|
26
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
32
|
+
|
33
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
34
|
+
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Validate and normalize country information, return ISO 3166-1 country codes and country name
|
38
|
+
result = api_instance.address_country(input)
|
39
|
+
p result
|
40
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
41
|
+
puts "Exception when calling AddressApi->address_country: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[Apikey](../README.md#Apikey)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json, text/json
|
62
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **address_get_timezone**
|
67
|
+
> GetTimezonesResponse address_get_timezone(input)
|
68
|
+
|
69
|
+
Gets IANA/Olsen time zones for a country
|
70
|
+
|
71
|
+
Gets the IANA/Olsen time zones for a country.
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'cloudmersive-validate-api-client'
|
77
|
+
# setup authorization
|
78
|
+
CloudmersiveValidateApiClient.configure do |config|
|
79
|
+
# Configure API key authorization: Apikey
|
80
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
83
|
+
end
|
84
|
+
|
85
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
86
|
+
|
87
|
+
input = CloudmersiveValidateApiClient::GetTimezonesRequest.new # GetTimezonesRequest | Input request
|
88
|
+
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Gets IANA/Olsen time zones for a country
|
92
|
+
result = api_instance.address_get_timezone(input)
|
93
|
+
p result
|
94
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
95
|
+
puts "Exception when calling AddressApi->address_get_timezone: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
### Parameters
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**input** | [**GetTimezonesRequest**](GetTimezonesRequest.md)| Input request |
|
104
|
+
|
105
|
+
### Return type
|
106
|
+
|
107
|
+
[**GetTimezonesResponse**](GetTimezonesResponse.md)
|
108
|
+
|
109
|
+
### Authorization
|
110
|
+
|
111
|
+
[Apikey](../README.md#Apikey)
|
112
|
+
|
113
|
+
### HTTP request headers
|
114
|
+
|
115
|
+
- **Content-Type**: application/json, text/json
|
116
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
117
|
+
|
118
|
+
|
119
|
+
|
10
120
|
# **address_parse_string**
|
11
121
|
> ParseAddressResponse address_parse_string(input)
|
12
122
|
|
@@ -56,7 +166,7 @@ Name | Type | Description | Notes
|
|
56
166
|
|
57
167
|
### HTTP request headers
|
58
168
|
|
59
|
-
- **Content-Type**: application/json, text/json
|
169
|
+
- **Content-Type**: application/json, text/json
|
60
170
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
171
|
|
62
172
|
|
@@ -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
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
8
8
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
9
|
+
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
9
10
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
10
11
|
|
11
12
|
|
@@ -58,7 +59,7 @@ Name | Type | Description | Notes
|
|
58
59
|
|
59
60
|
### HTTP request headers
|
60
61
|
|
61
|
-
- **Content-Type**:
|
62
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
62
63
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
63
64
|
|
64
65
|
|
@@ -112,7 +113,61 @@ Name | Type | Description | Notes
|
|
112
113
|
|
113
114
|
### HTTP request headers
|
114
115
|
|
115
|
-
- **Content-Type**:
|
116
|
+
- **Content-Type**: text/javascript, application/json, text/json
|
117
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
# **domain_url_full**
|
122
|
+
> ValidateUrlResponseFull domain_url_full(request)
|
123
|
+
|
124
|
+
Validate a URL fully
|
125
|
+
|
126
|
+
Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.
|
127
|
+
|
128
|
+
### Example
|
129
|
+
```ruby
|
130
|
+
# load the gem
|
131
|
+
require 'cloudmersive-validate-api-client'
|
132
|
+
# setup authorization
|
133
|
+
CloudmersiveValidateApiClient.configure do |config|
|
134
|
+
# Configure API key authorization: Apikey
|
135
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
136
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
137
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
138
|
+
end
|
139
|
+
|
140
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
141
|
+
|
142
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | Input URL request
|
143
|
+
|
144
|
+
|
145
|
+
begin
|
146
|
+
#Validate a URL fully
|
147
|
+
result = api_instance.domain_url_full(request)
|
148
|
+
p result
|
149
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
150
|
+
puts "Exception when calling DomainApi->domain_url_full: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
### Parameters
|
155
|
+
|
156
|
+
Name | Type | Description | Notes
|
157
|
+
------------- | ------------- | ------------- | -------------
|
158
|
+
**request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)| Input URL request |
|
159
|
+
|
160
|
+
### Return type
|
161
|
+
|
162
|
+
[**ValidateUrlResponseFull**](ValidateUrlResponseFull.md)
|
163
|
+
|
164
|
+
### Authorization
|
165
|
+
|
166
|
+
[Apikey](../README.md#Apikey)
|
167
|
+
|
168
|
+
### HTTP request headers
|
169
|
+
|
170
|
+
- **Content-Type**: application/json, text/json
|
116
171
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
117
172
|
|
118
173
|
|
@@ -138,7 +193,7 @@ end
|
|
138
193
|
|
139
194
|
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
140
195
|
|
141
|
-
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly |
|
196
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
|
142
197
|
|
143
198
|
|
144
199
|
begin
|
@@ -154,7 +209,7 @@ end
|
|
154
209
|
|
155
210
|
Name | Type | Description | Notes
|
156
211
|
------------- | ------------- | ------------- | -------------
|
157
|
-
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)|
|
212
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information |
|
158
213
|
|
159
214
|
### Return type
|
160
215
|
|
@@ -166,7 +221,7 @@ Name | Type | Description | Notes
|
|
166
221
|
|
167
222
|
### HTTP request headers
|
168
223
|
|
169
|
-
- **Content-Type**: application/json, text/json
|
224
|
+
- **Content-Type**: application/json, text/json
|
170
225
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
171
226
|
|
172
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
|
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::LeadEnrichmentApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**lead_enrichment_enrich_lead**](LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
|
8
|
+
|
9
|
+
|
10
|
+
# **lead_enrichment_enrich_lead**
|
11
|
+
> LeadEnrichmentResponse lead_enrichment_enrich_lead(request)
|
12
|
+
|
13
|
+
Enrich an input lead with additional fields of data
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'cloudmersive-validate-api-client'
|
19
|
+
# setup authorization
|
20
|
+
CloudmersiveValidateApiClient.configure do |config|
|
21
|
+
# Configure API key authorization: Apikey
|
22
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
23
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
24
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = CloudmersiveValidateApiClient::LeadEnrichmentApi.new
|
28
|
+
|
29
|
+
request = CloudmersiveValidateApiClient::LeadEnrichmentRequest.new # LeadEnrichmentRequest | Input lead with known fields set, and unknown fields left blank (null)
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Enrich an input lead with additional fields of data
|
34
|
+
result = api_instance.lead_enrichment_enrich_lead(request)
|
35
|
+
p result
|
36
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
37
|
+
puts "Exception when calling LeadEnrichmentApi->lead_enrichment_enrich_lead: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**request** | [**LeadEnrichmentRequest**](LeadEnrichmentRequest.md)| Input lead with known fields set, and unknown fields left blank (null) |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**LeadEnrichmentResponse**](LeadEnrichmentResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
[Apikey](../README.md#Apikey)
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json, text/json
|
58
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
59
|
+
|
60
|
+
|
61
|
+
|