cloudmersive-validate-api-client 2.0.1 → 2.0.6

data/docs/NameApi.md

@@ -0,0 +1,283 @@
+# 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
+ - **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
+
+
+
+# **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
+ - **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
+ - **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
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/ParseAddressRequest.md

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

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

@@ -0,0 +1,63 @@
+# CloudmersiveValidateApiClient::PhoneNumberApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**phone_number_syntax_only**](PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
+
+
+# **phone_number_syntax_only**
+> PhoneNumberValidationResponse phone_number_syntax_only(value)
+
+Validate phone number (basic)
+
+Validate a phone number by analyzing the syntax
+
+### 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::PhoneNumberApi.new
+
+value = CloudmersiveValidateApiClient::PhoneNumberValidateRequest.new # PhoneNumberValidateRequest | Phone number to validate in a PhoneNumberValidateRequest object.  Try a phone number such as \"1.800.463.3339\", and either leave DefaultCountryCode blank or use \"US\".
+
+
+begin
+  #Validate phone number (basic)
+  result = api_instance.phone_number_syntax_only(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling PhoneNumberApi->phone_number_syntax_only: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | [**PhoneNumberValidateRequest**](PhoneNumberValidateRequest.md)| Phone number to validate in a PhoneNumberValidateRequest object.  Try a phone number such as \"1.800.463.3339\", and either leave DefaultCountryCode blank or use \"US\". | 
+
+### Return type
+
+[**PhoneNumberValidationResponse**](PhoneNumberValidationResponse.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/PhoneNumberValidateRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::PhoneNumberValidateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | Raw phone number string to parse as input for validation | [optional] 
+**default_country_code** | **String** | Optional, default country code.  If left blank, will default to \"US\". | [optional] 
+
+

data/docs/PhoneNumberValidationResponse.md

@@ -0,0 +1,15 @@
+# CloudmersiveValidateApiClient::PhoneNumberValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_valid** | **BOOLEAN** | True if the phone number is valid, false otherwise | [optional] 
+**successful** | **BOOLEAN** | True if the operation was successful, false if there was an error during validation.  See IsValid for validation result. | [optional] 
+**phone_number_type** | **String** | Type of phone number; possible values are: FixedLine, Mobile, FixedLineOrMobile, TollFree, PremiumRate,   SharedCost, Voip, PersonalNumber, Pager, Uan, Voicemail, Unknown | [optional] 
+**e164_format** | **String** | E.164 format of the phone number | [optional] 
+**international_format** | **String** | Internaltional format of the phone number | [optional] 
+**national_format** | **String** | National format of the phone number | [optional] 
+**country_code** | **String** | Two digit country code of the phone number | [optional] 
+**country_name** | **String** | User-friendly long name of the country for the phone number | [optional] 
+
+

data/docs/Timezone.md

@@ -0,0 +1,10 @@
+# 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] 
+**now** | **DateTime** | The current time (Now) in this time zone | [optional] 
+
+

data/docs/TorNodeResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::TorNodeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_tor_node** | **BOOLEAN** | True if the input IP address is a Tor exit node, false otherwise | [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
+
+
+