cloudmersive-validate-api-client 1.3.4 → 1.4.0

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

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**name_get_gender**](NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
+[**name_identifier**](NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
 [**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
 [**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
 [**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
@@ -59,7 +60,61 @@ 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
+
+
+
+# **name_identifier**
+> ValidateIdentifierResponse name_identifier(input)
+
+Validate a code identifier
+
+Determines if the input name is a valid technical / code identifier.  Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed.  For example, a valid identifier might be \"helloWorld\" but not \"hello*World\".
+
+### 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::NameApi.new
+
+input = CloudmersiveValidateApiClient::ValidateIdentifierRequest.new # ValidateIdentifierRequest | Identifier validation request information
+
+
+begin
+  #Validate a code identifier
+  result = api_instance.name_identifier(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling NameApi->name_identifier: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**ValidateIdentifierRequest**](ValidateIdentifierRequest.md)| Identifier validation request information | 
+
+### Return type
+
+[**ValidateIdentifierResponse**](ValidateIdentifierResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -113,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
 
 
@@ -167,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
 
 
@@ -221,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] 
 
 

data/docs/PhoneNumberApi.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**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 

data/docs/Timezone.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::Timezone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the Time Zone | [optional] 
+**base_utc_offset** | **String** | UTC offset for this time zone | [optional] 
+
+

data/docs/UserAgentApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveValidateApiClient::UserAgentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**user_agent_parse**](UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
+
+
+# **user_agent_parse**
+> UserAgentValidateResponse user_agent_parse(request)
+
+Parse an HTTP User-Agent string, identify robots
+
+Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+
+### 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::UserAgentApi.new
+
+request = CloudmersiveValidateApiClient::UserAgentValidateRequest.new # UserAgentValidateRequest | Input parse request
+
+
+begin
+  #Parse an HTTP User-Agent string, identify robots
+  result = api_instance.user_agent_parse(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling UserAgentApi->user_agent_parse: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UserAgentValidateRequest**](UserAgentValidateRequest.md)| Input parse request | 
+
+### Return type
+
+[**UserAgentValidateResponse**](UserAgentValidateResponse.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/UserAgentValidateRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::UserAgentValidateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_agent_string** | **String** | The user agent string you wish to parse and validate | [optional] 
+
+

data/docs/UserAgentValidateResponse.md

@@ -0,0 +1,21 @@
+# CloudmersiveValidateApiClient::UserAgentValidateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**is_bot** | **BOOLEAN** | True if the request is a known robot, false otherwise | [optional] 
+**bot_name** | **String** | Optional; name of the robot if the request was from a known robot, otherwise null | [optional] 
+**bot_url** | **String** | Optional; if available, the URL to the robot | [optional] 
+**operating_system** | **String** | Operating System of the User-Agent (e.g. Windows) | [optional] 
+**operating_system_cpu_platform** | **String** | The CPU platform of the User-Agent (e.g. x64) | [optional] 
+**operating_system_version** | **String** | The version of the operating system of the User-Agent (e.g. \"10\" for Windows 10) | [optional] 
+**device_type** | **String** | Device type of the User-Agent; possible values are \"DESKTOP\", \"SMARTPHONE\", \"TABLET\" | [optional] 
+**device_brand_name** | **String** | Brand name of the User-Agent | [optional] 
+**device_model** | **String** | Model name or number of the User-Agent | [optional] 
+**browser_name** | **String** | Name of the Browser | [optional] 
+**browser_version** | **String** | Version of the Browser | [optional] 
+**browser_engine_name** | **String** | Name of the Browser Engine | [optional] 
+**browser_engine_version** | **String** | Version of the Browser Engine | [optional] 
+
+

data/docs/ValidateCountryRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::ValidateCountryRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**raw_country_input** | **String** | Raw country input - can be a two-letter code (FIPS 10-4 or ISO 3166-1), three-letter code (ISO 3166-1) or country name | [optional] 
+
+

data/docs/ValidateCountryResponse.md

@@ -0,0 +1,13 @@
+# CloudmersiveValidateApiClient::ValidateCountryResponse
+
+## 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/ValidateIdentifierRequest.md

@@ -0,0 +1,15 @@
+# CloudmersiveValidateApiClient::ValidateIdentifierRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **String** | Text string identifier input | [optional] 
+**allow_whitespace** | **BOOLEAN** | True if whitespace is allowed in the identifier, false otherwise | [optional] 
+**allow_hyphens** | **BOOLEAN** | True if hyphens are allowd in the identifier, false otherwise | [optional] 
+**allow_underscore** | **BOOLEAN** | True if underscores are allowed in the identifier, false otherwise | [optional] 
+**allow_numbers** | **BOOLEAN** | True if numbers are allowed in the identifier, false otherwise | [optional] 
+**allow_periods** | **BOOLEAN** | True if periods are allowed in the identifier, false otherwise | [optional] 
+**max_length** | **Integer** | Optional; maximum length, if any, of the identifier | [optional] 
+**min_length** | **Integer** | Optional; minimum length, if any, of the identifier | [optional] 
+
+

data/docs/ValidateIdentifierResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::ValidateIdentifierResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_identifier** | **BOOLEAN** | True if the input identifier is valid, false otherwise | [optional] 
+**error** | **String** | Resulting error from the identifier validation; possible errors are: \"InputIsEmpty\", \"ContainsWhitespace\", \"ContainsNumbers\", \"ContainsHyphen\", \"ContainsUnderscore\", \"ContainsPeriod\", \"TooShort\", \"TooLong\", \"ContainsSpecialCharacters\" | [optional] 
+
+

data/docs/ValidateUrlRequestFull.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::ValidateUrlRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/ValidateUrlRequestSyntaxOnly.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/ValidateUrlResponseFull.md

@@ -0,0 +1,12 @@
+# CloudmersiveValidateApiClient::ValidateUrlResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_url** | **BOOLEAN** | True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise | [optional] 
+**valid_syntax** | **BOOLEAN** | True if the URL has valid syntax, false otherwise | [optional] 
+**valid_domain** | **BOOLEAN** | True if the domain name is valid and exists, false otherwise | [optional] 
+**valid_endpoint** | **BOOLEAN** | True if the endpoint is up and responsive and passes a virus scan check, false otherwise | [optional] 
+**well_formed_url** | **String** | Well-formed version of the URL | [optional] 
+
+

data/docs/ValidateUrlResponseSyntaxOnly.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_url** | **BOOLEAN** | True if the URL is valid, false otherwise | [optional] 
+**well_formed_url** | **String** | Well-formed version of the URL | [optional] 
+
+