cloudmersive-validate-api-client 1.4.2 → 2.0.1

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,16 +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_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

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

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

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

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

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

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

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

@@ -1,13 +0,0 @@
-# CloudmersiveValidateApiClient::ValidateAddressRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**street_address** | **String** | Required; Street address to validate, such as '2950 Buskirk Ave.' | [optional] 
-**city** | **String** | Required; City part of the addrerss to validate, such as 'Walnut Creek' | [optional] 
-**state_or_province** | **String** | Required; State or province of the address to validate, such as 'CA' or 'California' | [optional] 
-**postal_code** | **String** | Optional (recommended); Zip code or postal code of the address to validate, such as '94597' | [optional] 
-**country_full_name** | **String** | Optional (recommended); Name of the country, such as 'United States'.  If left blank, and CountryCode is also left blank, will default to United States.  Global countries are supported. | [optional] 
-**country_code** | **String** | Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country.  If left blank, and CountryFullName is also left blank, will default to United States.  Global countries are supported. | [optional] 
-
-

data/docs/ValidateAddressResponse.md

@@ -1,10 +0,0 @@
-# CloudmersiveValidateApiClient::ValidateAddressResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**valid_address** | **BOOLEAN** | True if the address is valid, false otherwise | [optional] 
-**latitude** | **Float** | If the address is valid, the degrees latitude of the validated address, null otherwise | [optional] 
-**longitude** | **Float** | If the address is valid, the degrees longitude of the validated address, null otherwise | [optional] 
-
-

data/docs/ValidateCountryRequest.md

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

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

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

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

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

data/docs/ValidateUrlRequestSyntaxOnly.md

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

data/docs/ValidateUrlResponseFull.md

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

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

data/docs/VatApi.md

@@ -1,63 +0,0 @@
-# CloudmersiveValidateApiClient::VatApi
-
-All URIs are relative to *https://api.cloudmersive.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**vat_vat_lookup**](VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
-
-
-# **vat_vat_lookup**
-> VatLookupResponse vat_vat_lookup(input)
-
-Validate a VAT number
-
-Checks if a VAT code is valid, and if it is, returns more information about it.  The first two letters of the VAT number must be letters that indicate the country, such as LU20260743.  Possible country codes include Austria (AT), Belgium (BE), Bulgaria (BG), Cyprus (CY), Czech Republic (CZ), Germany (DE), Denmark (DK), Estonia (EE), Greece (EL), Spain (ES), Finland (FI), France (FR), United Kingdom (GB), Croatia (HR), Hungary (HU), Ireland (IE), Italy (IT), Lithuania (LT), Luxembourg (LU), Latvia (LV), Malta (MT), The Netherlands (NL), Poland (PL), Portugal (PT), Romania (RO), Sweden (SE), Slovenia (SI), Slovakia (SK).
-
-### 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::VatApi.new
-
-input = CloudmersiveValidateApiClient::VatLookupRequest.new # VatLookupRequest | Input VAT code
-
-
-begin
-  #Validate a VAT number
-  result = api_instance.vat_vat_lookup(input)
-  p result
-rescue CloudmersiveValidateApiClient::ApiError => e
-  puts "Exception when calling VatApi->vat_vat_lookup: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **input** | [**VatLookupRequest**](VatLookupRequest.md)| Input VAT code | 
-
-### Return type
-
-[**VatLookupResponse**](VatLookupResponse.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/VatLookupRequest.md

@@ -1,8 +0,0 @@
-# CloudmersiveValidateApiClient::VatLookupRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**vat_code** | **String** | VAT code to lookup; example \"CZ25123891\" | [optional] 
-
-

data/docs/VatLookupResponse.md

@@ -1,19 +0,0 @@
-# CloudmersiveValidateApiClient::VatLookupResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**country_code** | **String** | Two-letter country code | [optional] 
-**vat_number** | **String** | VAT number | [optional] 
-**is_valid** | **BOOLEAN** | True if the VAT code is valid, false otherwise | [optional] 
-**business_name** | **String** | Name of the business | [optional] 
-**business_address** | **String** | Business address as a single string | [optional] 
-**business_building** | **String** | For the business address, the name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\".  This will often by null. | [optional] 
-**business_street_number** | **String** | For the business address, 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] 
-**business_street** | **String** | For the business address, 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] 
-**business_city** | **String** | For the business address, the city of the address. | [optional] 
-**business_state_or_province** | **String** | For the business address, the state or province of the address. | [optional] 
-**business_postal_code** | **String** | For the business address, the postal code or zip code of the address. | [optional] 
-**business_country** | **String** | For the business address, country of the address, if present in the address.  If not included in the address it will be null. | [optional] 
-
-