cloudmersive-validate-api-client 1.3.7 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f26be0b3362767667fe698407688872c59b0a2463bfae60d206edecbb785ac
-  data.tar.gz: 6330ac5d1ab93155b4ddc3c5408034a2b2df0d0aa5ac390bb93f0b0683258be7
+  metadata.gz: d2f6eac190c34cad7cbdaf3d120199a0d7d385bc51bdddc068af99dccd987696
+  data.tar.gz: 9070a4f22fb7d095592a8abe4a39fe66c6e1a8aef9b8086348f9dc4c54d30384
 SHA512:
-  metadata.gz: 5e1f9c00dce06668b21f3dd359b660f8bb08121d04390dd11cededef5b91935cda7ba9f911244e4c10f2f6560789bb54ea6ece008792a95ea6bb58c4999faf21
-  data.tar.gz: c1c9daac46befe30649f2a04ea95e0720b07b75d27ab4e5142b15999cc12b284e87af465de39edf055572f4e23ecb9d1c4172bfda0f48d01c91a726d2a9270b6
+  metadata.gz: f712df54ae0c0e4f3e00aec4a793d1a936bcfcafb79e243f978401348a83900fca46d9a8b3cd1b49021e9e12ebbaed8a6e32da86fcac726454e2021506a5b845
+  data.tar.gz: 4eb45a418278746102f24933bc6a255038ff03ff6fe082534d04b2e5e5c802de73acd39c23fc8f019ca86e089258d9da74802115987e5fe1d702adad75abe999

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.3.7
+- Package version: 1.3.9
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-1.3.7.gem
+gem install ./cloudmersive-validate-api-client-1.3.9.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.7.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.9.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 1.3.7'
+    gem 'cloudmersive-validate-api-client', '~> 1.3.9'
 
 ### Install from Git
 
@@ -64,15 +64,15 @@ end
 
 api_instance = CloudmersiveValidateApiClient::AddressApi.new
 
-input = CloudmersiveValidateApiClient::ParseAddressRequest.new # ParseAddressRequest | Input parse request
+input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
 
 
 begin
-  #Parse an unstructured input text string into an international, formatted address
-  result = api_instance.address_parse_string(input)
+  #Validate and normalize country information, return ISO 3166-1 country codes and country name
+  result = api_instance.address_country(input)
   p result
 rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling AddressApi->address_parse_string: #{e}"
+  puts "Exception when calling AddressApi->address_country: #{e}"
 end
 
 ```
@@ -83,6 +83,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*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
 *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
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 *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
 *CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
 *CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
 *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
+*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
 *CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
 *CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
 *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
  - [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
  - [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
  - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
+ - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
+ - [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
  - [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
  - [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
+ - [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
+ - [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
  - [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
  - [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
  - [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)

data/docs/AddressApi.md

@@ -4,9 +4,64 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**address_country**](AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
 [**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
 
 
+# **address_country**
+> ValidateCountryResponse address_country(input)
+
+Validate and normalize country information, return ISO 3166-1 country codes and country name
+
+Validates and normalizes country information, and returns key information about a country.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::AddressApi.new
+
+input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
+
+
+begin
+  #Validate and normalize country information, return ISO 3166-1 country codes and country name
+  result = api_instance.address_country(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling AddressApi->address_country: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request | 
+
+### Return type
+
+[**ValidateCountryResponse**](ValidateCountryResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **address_parse_string**
 > ParseAddressResponse address_parse_string(input)
 
@@ -56,7 +111,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/AddressVerifySyntaxOnlyResponse.md

@@ -4,5 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **valid_address** | **BOOLEAN** | True if the email address is syntactically valid, false if it is not | [optional] 
+**domain** | **String** | Domain name of the email address | [optional] 
+**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] 
+**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] 
 
 

data/docs/DomainApi.md

@@ -59,7 +59,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -113,7 +113,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -139,7 +139,7 @@ end
 
 api_instance = CloudmersiveValidateApiClient::DomainApi.new
 
-request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | 
+request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | Input URL request
 
 
 begin
@@ -155,7 +155,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)|  | 
+ **request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)| Input URL request | 
 
 ### Return type
 
@@ -167,7 +167,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -193,7 +193,7 @@ end
 
 api_instance = CloudmersiveValidateApiClient::DomainApi.new
 
-request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | 
+request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
 
 
 begin
@@ -209,7 +209,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)|  | 
+ **request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information | 
 
 ### Return type
 
@@ -221,7 +221,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/EmailApi.md

@@ -58,7 +58,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -112,7 +112,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -166,7 +166,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/IPAddressApi.md

@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: text/javascript, application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/LeadEnrichmentApi.md

@@ -0,0 +1,61 @@
+# CloudmersiveValidateApiClient::LeadEnrichmentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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
+
+
+# **lead_enrichment_enrich_lead**
+> LeadEnrichmentResponse lead_enrichment_enrich_lead(request)
+
+Enrich an input lead with additional fields of data
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::LeadEnrichmentApi.new
+
+request = CloudmersiveValidateApiClient::LeadEnrichmentRequest.new # LeadEnrichmentRequest | Input lead with known fields set, and unknown fields left blank (null)
+
+
+begin
+  #Enrich an input lead with additional fields of data
+  result = api_instance.lead_enrichment_enrich_lead(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling LeadEnrichmentApi->lead_enrichment_enrich_lead: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**LeadEnrichmentRequest**](LeadEnrichmentRequest.md)| Input lead with known fields set, and unknown fields left blank (null) | 
+
+### Return type
+
+[**LeadEnrichmentResponse**](LeadEnrichmentResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/LeadEnrichmentRequest.md

@@ -0,0 +1,21 @@
+# CloudmersiveValidateApiClient::LeadEnrichmentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_business_email** | **String** | The person's business email address for the lead | [optional] 
+**contact_first_name** | **String** | The person's first name for the lead | [optional] 
+**contact_last_name** | **String** | The person's last name for the lead | [optional] 
+**company_name** | **String** | Name of the company for the lead | [optional] 
+**company_domain_name** | **String** | Domain name / website for the lead | [optional] 
+**company_house_number** | **String** | House number of the address of the company for the lead | [optional] 
+**company_street** | **String** | Street name of the address of the company for the lead | [optional] 
+**company_city** | **String** | City of the address of the company for the lead | [optional] 
+**company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional] 
+**company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional] 
+**company_country** | **String** | Country of the address of the company for the lead | [optional] 
+**company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional] 
+**company_telephone** | **String** | Telephone of the company office for the lead | [optional] 
+**company_vat_number** | **String** | VAT number of the company for the lead | [optional] 
+
+

data/docs/LeadEnrichmentResponse.md

@@ -0,0 +1,25 @@
+# CloudmersiveValidateApiClient::LeadEnrichmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**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] 
+**contact_business_email** | **String** | The person's business email address for the lead | [optional] 
+**contact_first_name** | **String** | The person's first name for the lead | [optional] 
+**contact_last_name** | **String** | The person's last name for the lead | [optional] 
+**contact_gender** | **String** | Gender for contact name; possible values are Male, Female, and Neutral (can be applied to Male or Female).  Requires ContactFirstName. | [optional] 
+**company_name** | **String** | Name of the company for the lead | [optional] 
+**company_domain_name** | **String** | Domain name / website for the lead | [optional] 
+**company_house_number** | **String** | House number of the address of the company for the lead | [optional] 
+**company_street** | **String** | Street name of the address of the company for the lead | [optional] 
+**company_city** | **String** | City of the address of the company for the lead | [optional] 
+**company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional] 
+**company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional] 
+**company_country** | **String** | Country Name of the address of the company for the lead | [optional] 
+**company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional] 
+**company_telephone** | **String** | Telephone of the company office for the lead | [optional] 
+**company_vat_number** | **String** | VAT number of the company for the lead | [optional] 
+**employee_count** | **Integer** | Count of employees at the company (estimated), if available | [optional] 
+
+

data/docs/NameApi.md

@@ -60,7 +60,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -114,7 +114,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -168,7 +168,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -222,7 +222,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -276,7 +276,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/ParseAddressResponse.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **city** | **String** | The city of the address. | [optional] 
 **state_or_province** | **String** | The state or province of the address. | [optional] 
 **postal_code** | **String** | The postal code or zip code of the address. | [optional] 
-**country** | **String** | Country of the address, if present in the address.  If not included in the address it will be null. | [optional] 
+**country_full_name** | **String** | Country of the address, if present in the address.  If not included in the address it will be null. | [optional] 
+**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]