cloudmersive-validate-api-client 1.3.7 → 2.0.1

data/docs/FullNameValidationRequest.md

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

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

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

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

@@ -1,9 +0,0 @@
-# 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/IPAddressApi.md

@@ -1,63 +0,0 @@
-# CloudmersiveValidateApiClient::IPAddressApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
-
-
-# **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**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-

data/docs/LastNameValidationRequest.md

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

data/docs/LastNameValidationResponse.md

@@ -1,9 +0,0 @@
-# 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/NameApi.md

@@ -1,283 +0,0 @@
-# CloudmersiveValidateApiClient::NameApi
-
-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
-
-
-# **name_get_gender**
-> GetGenderResponse name_get_gender(input)
-
-Get the gender of a first name
-
-Determines the gender of a first name (given 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::NameApi.new
-
-input = CloudmersiveValidateApiClient::GetGenderRequest.new # GetGenderRequest | Gender request information
-
-
-begin
-  #Get the gender of a first name
-  result = api_instance.name_get_gender(input)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling NameApi->name_get_gender: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input** | [**GetGenderRequest**](GetGenderRequest.md)| Gender request information | 
-
-### Return type
-
-[**GetGenderResponse**](GetGenderResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- - **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, application/xml, text/xml, application/x-www-form-urlencoded
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **name_validate_first_name**
-> FirstNameValidationResponse name_validate_first_name(input)
-
-Validate a first name
-
-Determines if a string is a valid first name (given 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::NameApi.new
-
-input = CloudmersiveValidateApiClient::FirstNameValidationRequest.new # FirstNameValidationRequest | Validation request information
-
-
-begin
-  #Validate a first name
-  result = api_instance.name_validate_first_name(input)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling NameApi->name_validate_first_name: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input** | [**FirstNameValidationRequest**](FirstNameValidationRequest.md)| Validation request information | 
-
-### Return type
-
-[**FirstNameValidationResponse**](FirstNameValidationResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **name_validate_full_name**
-> FullNameValidationResponse name_validate_full_name(input)
-
-Parse and validate a full name
-
-Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
-
-### 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::FullNameValidationRequest.new # FullNameValidationRequest | Validation request information
-
-
-begin
-  #Parse and validate a full name
-  result = api_instance.name_validate_full_name(input)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling NameApi->name_validate_full_name: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input** | [**FullNameValidationRequest**](FullNameValidationRequest.md)| Validation request information | 
-
-### Return type
-
-[**FullNameValidationResponse**](FullNameValidationResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-
-# **name_validate_last_name**
-> LastNameValidationResponse name_validate_last_name(input)
-
-Validate a last name
-
-Determines if a string is a valid last name (surname)
-
-### 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::LastNameValidationRequest.new # LastNameValidationRequest | Validation request information
-
-
-begin
-  #Validate a last name
-  result = api_instance.name_validate_last_name(input)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling NameApi->name_validate_last_name: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input** | [**LastNameValidationRequest**](LastNameValidationRequest.md)| Validation request information | 
-
-### Return type
-
-[**LastNameValidationResponse**](LastNameValidationResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
- - **Accept**: application/json, text/json, application/xml, text/xml
-
-
-

data/docs/ParseAddressRequest.md

@@ -1,9 +0,0 @@
-# CloudmersiveValidateApiClient::ParseAddressRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address_string** | **String** | A mailing address or street address formatted as a single text string; this will be parsed into its components | [optional] 
-**capitalization_mode** | **String** | Optional; indicates how the parsed output should be capitalized; default is Title Case; possible values are: \"Uppercase\" will set the capitalization to UPPER CASE; \"Lowercase\" will set the capitalization to lower case; \"Titlecase\" will set the capitalization to Title Case; and \"Originalcase\" will preserve the original casing as much as possible | [optional] 
-
-

data/docs/ParseAddressResponse.md

@@ -1,15 +0,0 @@
-# CloudmersiveValidateApiClient::ParseAddressResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** | True if the parsing operation was successful, false otherwise | [optional] 
-**building** | **String** | The name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\".  This will often by null. | [optional] 
-**street_number** | **String** | The street number or house number of the address.  For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"1600\".  This value will typically be populated for most addresses. | [optional] 
-**street** | **String** | The name of the street or road of the address.  For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"Pennsylvania Avenue NW\". | [optional] 
-**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] 
-
-