cloudmersive-validate-api-client 1.4.2 → 2.0.1

data/docs/AddressGetServersResponse.md

@@ -1,9 +0,0 @@
-# CloudmersiveValidateApiClient::AddressGetServersResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **BOOLEAN** | True if partial address validation was successufl, false otherwise | [optional] 
-**servers** | **Array<String>** | Email servers for this email address | [optional] 
-
-

data/docs/AddressVerifySyntaxOnlyResponse.md

@@ -1,11 +0,0 @@
-# CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse
-
-## Properties
-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/CheckResponse.md

@@ -1,8 +0,0 @@
-# CloudmersiveValidateApiClient::CheckResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**valid_domain** | **BOOLEAN** | True if the domain name was valid, false if it is not | [optional] 
-
-

data/docs/DomainApi.md

@@ -1,228 +0,0 @@
-# CloudmersiveValidateApiClient::DomainApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
-[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
-[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
-[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
-
-
-# **domain_check**
-> CheckResponse domain_check(domain)
-
-Validate a domain name
-
-Check whether a domain name is valid or not.  API performs a live validation by contacting DNS services to validate the existence of the domain name.
-
-### 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::DomainApi.new
-
-domain = "domain_example" # String | Domain name to check, for example \"cloudmersive.com\".  The input is a string so be sure to enclose it in double-quotes.
-
-
-begin
-  #Validate a domain name
-  result = api_instance.domain_check(domain)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling DomainApi->domain_check: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain** | **String**| Domain name to check, for example \"cloudmersive.com\".  The input is a string so be sure to enclose it in double-quotes. | 
-
-### Return type
-
-[**CheckResponse**](CheckResponse.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
-
-
-
-# **domain_post**
-> WhoisResponse domain_post(domain)
-
-Get WHOIS information for a domain
-
-Validate whether a domain name exists, and also return the full WHOIS record for that domain name.  WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
-
-### 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::DomainApi.new
-
-domain = "domain_example" # String | Domain name to check, for example \"cloudmersive.com\".   The input is a string so be sure to enclose it in double-quotes.
-
-
-begin
-  #Get WHOIS information for a domain
-  result = api_instance.domain_post(domain)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling DomainApi->domain_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain** | **String**| Domain name to check, for example \"cloudmersive.com\".   The input is a string so be sure to enclose it in double-quotes. | 
-
-### Return type
-
-[**WhoisResponse**](WhoisResponse.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
-
-
-
-# **domain_url_full**
-> ValidateUrlResponseFull domain_url_full(request)
-
-Validate a URL fully
-
-Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
-
-### 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::DomainApi.new
-
-request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | Input URL request
-
-
-begin
-  #Validate a URL fully
-  result = api_instance.domain_url_full(request)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling DomainApi->domain_url_full: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)| Input URL request | 
-
-### Return type
-
-[**ValidateUrlResponseFull**](ValidateUrlResponseFull.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **domain_url_syntax_only**
-> ValidateUrlResponseSyntaxOnly domain_url_syntax_only(request)
-
-Validate a URL syntactically
-
-Validate whether a URL is syntactically valid (does not check endpoint for validity).  Accepts various types of input and produces a well-formed URL as output.
-
-### 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::DomainApi.new
-
-request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
-
-
-begin
-  #Validate a URL syntactically
-  result = api_instance.domain_url_syntax_only(request)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling DomainApi->domain_url_syntax_only: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information | 
-
-### Return type
-
-[**ValidateUrlResponseSyntaxOnly**](ValidateUrlResponseSyntaxOnly.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/EmailApi.md

@@ -1,173 +0,0 @@
-# CloudmersiveValidateApiClient::EmailApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**email_address_get_servers**](EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
-[**email_full_validation**](EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
-[**email_post**](EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
-
-
-# **email_address_get_servers**
-> AddressGetServersResponse email_address_get_servers(email)
-
-Partially check whether an email address is valid
-
-Validate an email address by identifying whether its parent domain has email servers defined.  This call is less limited than syntaxOnly but not as comprehensive as address/full.
-
-### 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::EmailApi.new
-
-email = "email_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
-
-
-begin
-  #Partially check whether an email address is valid
-  result = api_instance.email_address_get_servers(email)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling EmailApi->email_address_get_servers: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email** | **String**| Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes. | 
-
-### Return type
-
-[**AddressGetServersResponse**](AddressGetServersResponse.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
-
-
-
-# **email_full_validation**
-> FullEmailValidationResponse email_full_validation(email)
-
-Fully validate an email address
-
-Performs a full validation of the email address.  Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
-
-### 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::EmailApi.new
-
-email = "email_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
-
-
-begin
-  #Fully validate an email address
-  result = api_instance.email_full_validation(email)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling EmailApi->email_full_validation: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email** | **String**| Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes. | 
-
-### Return type
-
-[**FullEmailValidationResponse**](FullEmailValidationResponse.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
-
-
-
-# **email_post**
-> AddressVerifySyntaxOnlyResponse email_post(value)
-
-Validate email adddress for syntactic correctness only
-
-Validate whether a given email address is syntactically correct via a limited local-only check.  Use the address/full API to do a full validation.
-
-### 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::EmailApi.new
-
-value = "value_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
-
-
-begin
-  #Validate email adddress for syntactic correctness only
-  result = api_instance.email_post(value)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling EmailApi->email_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **value** | **String**| Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes. | 
-
-### Return type
-
-[**AddressVerifySyntaxOnlyResponse**](AddressVerifySyntaxOnlyResponse.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/FirstNameValidationRequest.md

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

data/docs/FirstNameValidationResponse.md

@@ -1,9 +0,0 @@
-# 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] 
-
-