cloudmersive-validate-api-client 2.0.1 → 2.0.6

data/docs/FirstNameValidationRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::FirstNameValidationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | First name to process | [optional] 
+
+

data/docs/FirstNameValidationResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::FirstNameValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional] 
+**validation_result** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional] 
+
+

data/docs/FullEmailValidationResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveValidateApiClient::FullEmailValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_address** | **BOOLEAN** | True if the email address is valid overall, false otherwise | [optional] 
+**mail_server_used_for_validation** | **String** | Email server connected to for verification | [optional] 
+**valid_syntax** | **BOOLEAN** | True if the syntax of the email address is valid, false otherwise.  This is one component of ValidAddress, but not the only one. | [optional] 
+**valid_domain** | **BOOLEAN** | True if the domain name of the email address is valid, false otherwise.  This is one component of ValidAddress, but not the only one. | [optional] 
+**valid_smtp** | **BOOLEAN** | True if the email address was verified by the remote server, false otherwise.  This is one component of ValidAddress, but not the only one. | [optional] 
+**is_catchall_domain** | **BOOLEAN** | True if the domain is a catch-all domain name, false otherwise.  Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails.  Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time. | [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/FullNameValidationRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::FullNameValidationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**full_name_string** | **String** | Full name to process as a free-form string; supports many components such as First Name, Middle Name, Last Name, Title, Nickname, Suffix, and Display Name | [optional] 
+
+

data/docs/FullNameValidationResponse.md

@@ -0,0 +1,17 @@
+# CloudmersiveValidateApiClient::FullNameValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional] 
+**validation_result_first_name** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional] 
+**validation_result_last_name** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional] 
+**title** | **String** | The person's title (if supplied), e.g. \"Mr.\" or \"Ms.\" | [optional] 
+**first_name** | **String** | The first name (given name) | [optional] 
+**middle_name** | **String** | The middle name(s); if there are multiple names they will be separated by spaces | [optional] 
+**last_name** | **String** | The last name (surname) | [optional] 
+**nick_name** | **String** | Nickname (if supplied) | [optional] 
+**suffix** | **String** | Suffix to the name, e.g. \"Jr.\" or \"Sr.\" | [optional] 
+**display_name** | **String** | The full display name of the name | [optional] 
+
+

data/docs/GeolocateResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveValidateApiClient::GeolocateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_code** | **String** | Two-letter country code of IP address | [optional] 
+**country_name** | **String** | Country name of IP address | [optional] 
+**city** | **String** | City of IP address | [optional] 
+**region_code** | **String** | State/region code of IP address | [optional] 
+**region_name** | **String** | State/region of IP address | [optional] 
+**zip_code** | **String** | Zip or postal code of IP address | [optional] 
+**timezone_standard_name** | **String** | Timezone of IP address | [optional] 
+**latitude** | **Float** | Latitude of IP address | [optional] 
+**longitude** | **Float** | Longitude of IP address | [optional] 
+
+

data/docs/GetGenderRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::GetGenderRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | Input first name (given name) to get the gender of | [optional] 
+**country_code** | **String** | Optional; the country for this name, possible values are \"US\", \"LY\", \"NI\", \"TT\", \"MK\", \"KZ\", \"BO\", \"UG\", \"TZ\", \"CL\", \"SI\", \"MA\", \"RW\", \"VN\", \"AW\", \"CY\", \"BH\", \"SG\", \"ZA\", \"MU\", \"BR\", \"TN\", \"KH\", \"US\", \"TH\", \"TW\", \"UY\", \"DO\", \"CO\", \"UA\", \"QA\", \"BY\", \"SN\", \"SD\", \"FJ\", \"LB\", \"BE\", \"ML\", \"LV\", \"FR\", \"TM\", \"NG\", \"EC\", \"NO\", \"SL\", \"CR\", \"PA\", \"GE\", \"CH\", \"KR\", \"RS\", \"ZM\", \"FI\", \"BF\", \"MC\", \"AU\", \"GA\", \"LS\", \"RU\", \"IN\", \"SE\", \"LK\", \"BZ\", \"MX\", \"GH\", \"AF\", \"TJ\", \"BN\", \"DZ\", \"CM\", \"GR\", \"MD\", \"HN\", \"AT\", \"NZ\", \"SV\", \"GW\", \"NA\", \"AR\", \"MZ\", \"PK\", \"MN\", \"IQ\", \"BW\", \"VE\", \"PT\", \"BS\", \"AL\", \"TG\", \"ID\", \"ET\", \"CF\", \"JP\", \"BB\", \"PH\", \"CU\", \"BD\", \"AO\", \"SM\", \"LC\", \"ME\", \"RO\",  DANIL\"O\"\", \"ES\", \"EE\", \"IL\", \"ZW\", \"SY\", \"MW\", \"LU\", \"IR\", \"SC\", \"NL\", \"JO\", \"AM\", \"DE\", \"GL\", \"OM\", \"DK\", \"HR\", \"LI\", \"TD\", \"KM\", \"BA\", \"GM\", \"GD\", \"CA\", \"CZ\", \"MR\", \"ST\", \"IS\", \"LR\", \"IE\", \"VC\", \"AE\", \"KG\", \"DJ\", \"TR\", \"KE\", \"NE\", \"UZ\", \"CN\", \"GQ\", \"SK\", \"BJ\", \"MG\", \"BT\", \"EG\", \"PL\", \"IT\", \"SA\", \"MY\", \"CI\", \"AG\", \"AD\", \"KS\", \"HU\", \"CG\", \"KP\", \"DM\", \"GN\", \"GT\", \"NP\", \"JM\", \"LA\", \"GB\", \"BG\", \"HT\", \"PE\", \"AZ\", \"LT\", \"SZ\", \"PY\", \"MT\", \"VA\" | [optional] 
+
+

data/docs/GetGenderResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::GetGenderResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**gender** | **String** | Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female) | [optional] 
+
+

data/docs/GetTimezonesRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::GetTimezonesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_code_or_name** | **String** | Can be the two-letter, three-letter country codes or country name | [optional] 
+
+

data/docs/GetTimezonesResponse.md

@@ -0,0 +1,13 @@
+# CloudmersiveValidateApiClient::GetTimezonesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**country_full_name** | **String** | Full name of the country | [optional] 
+**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional] 
+**fips_two_letter_code** | **String** | Two-letter FIPS 10-4 country code | [optional] 
+**three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional] 
+**timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional] 
+
+

data/docs/IPAddressApi.md

@@ -0,0 +1,173 @@
+# CloudmersiveValidateApiClient::IPAddressApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**i_p_address_is_threat**](IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
+[**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
+[**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
+
+
+# **i_p_address_is_threat**
+> IPThreatResponse i_p_address_is_threat(value)
+
+Check if IP address is a known threat
+
+Check if the input IP address is a known threat IP address.  Checks against known bad IPs, botnets, compromised servers, and other lists of threats.
+
+### 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::IPAddressApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a known threat
+  result = api_instance.i_p_address_is_threat(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling IPAddressApi->i_p_address_is_threat: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**IPThreatResponse**](IPThreatResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **i_p_address_is_tor_node**
+> TorNodeResponse i_p_address_is_tor_node(value)
+
+Check if IP address is a Tor node server
+
+Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+
+### 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::IPAddressApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a Tor node server
+  result = api_instance.i_p_address_is_tor_node(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling IPAddressApi->i_p_address_is_tor_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**TorNodeResponse**](TorNodeResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **i_p_address_post**
+> GeolocateResponse i_p_address_post(value)
+
+Geolocate an IP address
+
+Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc.  Useful for security and UX applications.
+
+### 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::IPAddressApi.new
+
+value = 'value_example' # String | IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Geolocate an IP address
+  result = api_instance.i_p_address_post(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling IPAddressApi->i_p_address_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**GeolocateResponse**](GeolocateResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/IPThreatResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::IPThreatResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_threat** | **BOOLEAN** | True if the input IP address is a threat, false otherwise | [optional] 
+**threat_type** | **String** | Specifies the type of IP threat; possible values include Blocklist, Botnet, WebBot | [optional] 
+
+

data/docs/LastNameValidationRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::LastNameValidationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_name** | **String** | Last name to process | [optional] 
+
+

data/docs/LastNameValidationResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::LastNameValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional] 
+**validation_result** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional] 
+
+

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] 
+
+