cloudmersive-validate-api-client 1.3.7 → 1.3.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -8
- data/docs/AddressApi.md +56 -1
- data/docs/AddressVerifySyntaxOnlyResponse.md +3 -0
- data/docs/DomainApi.md +8 -8
- data/docs/EmailApi.md +3 -3
- 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 +5 -5
- data/docs/ParseAddressResponse.md +2 -1
- data/docs/PhoneNumberApi.md +1 -1
- data/docs/UserAgentApi.md +1 -1
- data/docs/ValidateCountryRequest.md +8 -0
- data/docs/ValidateCountryResponse.md +12 -0
- data/docs/VatApi.md +1 -1
- data/docs/VatLookupResponse.md +8 -1
- data/docs/WhoisResponse.md +11 -0
- data/lib/cloudmersive-validate-api-client.rb +5 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +56 -1
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +8 -8
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +78 -0
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +5 -5
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +34 -4
- 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_response.rb +17 -7
- data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +229 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +75 -5
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +111 -1
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/address_api_spec.rb +12 -0
- data/spec/api/domain_api_spec.rb +2 -2
- data/spec/api/lead_enrichment_api_spec.rb +47 -0
- data/spec/models/address_verify_syntax_only_response_spec.rb +18 -0
- 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_response_spec.rb +7 -1
- data/spec/models/validate_country_request_spec.rb +42 -0
- data/spec/models/validate_country_response_spec.rb +66 -0
- data/spec/models/vat_lookup_response_spec.rb +42 -0
- data/spec/models/whois_response_spec.rb +66 -0
- metadata +17 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d2f6eac190c34cad7cbdaf3d120199a0d7d385bc51bdddc068af99dccd987696
|
4
|
+
data.tar.gz: 9070a4f22fb7d095592a8abe4a39fe66c6e1a8aef9b8086348f9dc4c54d30384
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f712df54ae0c0e4f3e00aec4a793d1a936bcfcafb79e243f978401348a83900fca46d9a8b3cd1b49021e9e12ebbaed8a6e32da86fcac726454e2021506a5b845
|
7
|
+
data.tar.gz: 4eb45a418278746102f24933bc6a255038ff03ff6fe082534d04b2e5e5c802de73acd39c23fc8f019ca86e089258d9da74802115987e5fe1d702adad75abe999
|
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.3.
|
10
|
+
- Package version: 1.3.9
|
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.3.
|
26
|
+
gem install ./cloudmersive-validate-api-client-1.3.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.9.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.3.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 1.3.9'
|
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,6 +83,7 @@ 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
|
86
87
|
*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
88
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
88
89
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
@@ -92,6 +93,7 @@ Class | Method | HTTP request | Description
|
|
92
93
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
93
94
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
94
95
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
96
|
+
*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
97
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
96
98
|
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
97
99
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
@@ -117,12 +119,16 @@ Class | Method | HTTP request | Description
|
|
117
119
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
118
120
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
119
121
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
122
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
123
|
+
- [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
|
120
124
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
121
125
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
122
126
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
123
127
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
124
128
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
125
129
|
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
130
|
+
- [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
|
131
|
+
- [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
|
126
132
|
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
127
133
|
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
128
134
|
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
data/docs/AddressApi.md
CHANGED
@@ -4,9 +4,64 @@ 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
|
7
8
|
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
8
9
|
|
9
10
|
|
11
|
+
# **address_country**
|
12
|
+
> ValidateCountryResponse address_country(input)
|
13
|
+
|
14
|
+
Validate and normalize country information, return ISO 3166-1 country codes and country name
|
15
|
+
|
16
|
+
Validates and normalizes country information, and returns key information about a country.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'cloudmersive-validate-api-client'
|
22
|
+
# setup authorization
|
23
|
+
CloudmersiveValidateApiClient.configure do |config|
|
24
|
+
# Configure API key authorization: Apikey
|
25
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
31
|
+
|
32
|
+
input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
|
33
|
+
|
34
|
+
|
35
|
+
begin
|
36
|
+
#Validate and normalize country information, return ISO 3166-1 country codes and country name
|
37
|
+
result = api_instance.address_country(input)
|
38
|
+
p result
|
39
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
40
|
+
puts "Exception when calling AddressApi->address_country: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
### Parameters
|
45
|
+
|
46
|
+
Name | Type | Description | Notes
|
47
|
+
------------- | ------------- | ------------- | -------------
|
48
|
+
**input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
|
49
|
+
|
50
|
+
### Return type
|
51
|
+
|
52
|
+
[**ValidateCountryResponse**](ValidateCountryResponse.md)
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
[Apikey](../README.md#Apikey)
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: application/json, text/json
|
61
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
62
|
+
|
63
|
+
|
64
|
+
|
10
65
|
# **address_parse_string**
|
11
66
|
> ParseAddressResponse address_parse_string(input)
|
12
67
|
|
@@ -56,7 +111,7 @@ Name | Type | Description | Notes
|
|
56
111
|
|
57
112
|
### HTTP request headers
|
58
113
|
|
59
|
-
- **Content-Type**: application/json, text/json
|
114
|
+
- **Content-Type**: application/json, text/json
|
60
115
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
116
|
|
62
117
|
|
@@ -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
|
|
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
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::LeadEnrichmentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**contact_business_email** | **String** | The person's business email address for the lead | [optional]
|
7
|
+
**contact_first_name** | **String** | The person's first name for the lead | [optional]
|
8
|
+
**contact_last_name** | **String** | The person's last name for the lead | [optional]
|
9
|
+
**company_name** | **String** | Name of the company for the lead | [optional]
|
10
|
+
**company_domain_name** | **String** | Domain name / website for the lead | [optional]
|
11
|
+
**company_house_number** | **String** | House number of the address of the company for the lead | [optional]
|
12
|
+
**company_street** | **String** | Street name of the address of the company for the lead | [optional]
|
13
|
+
**company_city** | **String** | City of the address of the company for the lead | [optional]
|
14
|
+
**company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional]
|
15
|
+
**company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional]
|
16
|
+
**company_country** | **String** | Country of the address of the company for the lead | [optional]
|
17
|
+
**company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional]
|
18
|
+
**company_telephone** | **String** | Telephone of the company office for the lead | [optional]
|
19
|
+
**company_vat_number** | **String** | VAT number of the company for the lead | [optional]
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::LeadEnrichmentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**lead_type** | **String** | The type of the lead; possible types are Junk (a single individual using a disposable/throwaway email address); Individual (a single individual, typically a consumer, not purchasing on behalf of a business); SmallBusiness (a small business, typically with fewer than 100 employees); MediumBusiness (a medium business, larger than 100 employees but fewer than 1000 employees); Enterprise (a large business with greater than 1000 employees); Business (a business customer of unknown size) | [optional]
|
8
|
+
**contact_business_email** | **String** | The person's business email address for the lead | [optional]
|
9
|
+
**contact_first_name** | **String** | The person's first name for the lead | [optional]
|
10
|
+
**contact_last_name** | **String** | The person's last name for the lead | [optional]
|
11
|
+
**contact_gender** | **String** | Gender for contact name; possible values are Male, Female, and Neutral (can be applied to Male or Female). Requires ContactFirstName. | [optional]
|
12
|
+
**company_name** | **String** | Name of the company for the lead | [optional]
|
13
|
+
**company_domain_name** | **String** | Domain name / website for the lead | [optional]
|
14
|
+
**company_house_number** | **String** | House number of the address of the company for the lead | [optional]
|
15
|
+
**company_street** | **String** | Street name of the address of the company for the lead | [optional]
|
16
|
+
**company_city** | **String** | City of the address of the company for the lead | [optional]
|
17
|
+
**company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional]
|
18
|
+
**company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional]
|
19
|
+
**company_country** | **String** | Country Name of the address of the company for the lead | [optional]
|
20
|
+
**company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional]
|
21
|
+
**company_telephone** | **String** | Telephone of the company office for the lead | [optional]
|
22
|
+
**company_vat_number** | **String** | VAT number of the company for the lead | [optional]
|
23
|
+
**employee_count** | **Integer** | Count of employees at the company (estimated), if available | [optional]
|
24
|
+
|
25
|
+
|
data/docs/NameApi.md
CHANGED
@@ -60,7 +60,7 @@ Name | Type | Description | Notes
|
|
60
60
|
|
61
61
|
### HTTP request headers
|
62
62
|
|
63
|
-
- **Content-Type**: application/json, text/json
|
63
|
+
- **Content-Type**: application/json, text/json
|
64
64
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
65
65
|
|
66
66
|
|
@@ -114,7 +114,7 @@ Name | Type | Description | Notes
|
|
114
114
|
|
115
115
|
### HTTP request headers
|
116
116
|
|
117
|
-
- **Content-Type**: application/json, text/json
|
117
|
+
- **Content-Type**: application/json, text/json
|
118
118
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
119
119
|
|
120
120
|
|
@@ -168,7 +168,7 @@ Name | Type | Description | Notes
|
|
168
168
|
|
169
169
|
### HTTP request headers
|
170
170
|
|
171
|
-
- **Content-Type**: application/json, text/json
|
171
|
+
- **Content-Type**: application/json, text/json
|
172
172
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
173
173
|
|
174
174
|
|
@@ -222,7 +222,7 @@ Name | Type | Description | Notes
|
|
222
222
|
|
223
223
|
### HTTP request headers
|
224
224
|
|
225
|
-
- **Content-Type**: application/json, text/json
|
225
|
+
- **Content-Type**: application/json, text/json
|
226
226
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
227
227
|
|
228
228
|
|
@@ -276,7 +276,7 @@ Name | Type | Description | Notes
|
|
276
276
|
|
277
277
|
### HTTP request headers
|
278
278
|
|
279
|
-
- **Content-Type**: application/json, text/json
|
279
|
+
- **Content-Type**: application/json, text/json
|
280
280
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
281
281
|
|
282
282
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**city** | **String** | The city of the address. | [optional]
|
11
11
|
**state_or_province** | **String** | The state or province of the address. | [optional]
|
12
12
|
**postal_code** | **String** | The postal code or zip code of the address. | [optional]
|
13
|
-
**
|
13
|
+
**country_full_name** | **String** | Country of the address, if present in the address. If not included in the address it will be null. | [optional]
|
14
|
+
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
14
15
|
|
15
16
|
|