cloudmersive-validate-api-client 1.3.9 → 2.0.2

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/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/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,12 +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] 
-
-

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 | Lookup a VAT code
-
-
-# **vat_vat_lookup**
-> VatLookupResponse vat_vat_lookup(input)
-
-Lookup a VAT code
-
-Checks if a VAT code is valid, and if it is, returns more information about it
-
-### 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
-  #Lookup a VAT code
-  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] 
-
-

data/docs/WhoisResponse.md

@@ -1,22 +0,0 @@
-# CloudmersiveValidateApiClient::WhoisResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**valid_domain** | **BOOLEAN** | True if the domain is valid, false if it is not | [optional] 
-**registrant_name** | **String** | Name of the domain registrant | [optional] 
-**registrant_organization** | **String** | Organization name of the domain registrant | [optional] 
-**registrant_email** | **String** | Email address of the domain registrant | [optional] 
-**registrant_street_number** | **String** | Street number of the address of the domain registrant, if available | [optional] 
-**registrant_street** | **String** | Street name of the address of the domain registrant, if available | [optional] 
-**registrant_city** | **String** | City of the domain registrant, if available | [optional] 
-**registrant_state_or_province** | **String** | State or Province of the address of the domain registrant, if available | [optional] 
-**registrant_postal_code** | **String** | Postal code of the address of the domain registrant, if available | [optional] 
-**registrant_country** | **String** | Country of the address of the domain registrant, if available | [optional] 
-**registrant_raw_address** | **String** | Raw address string of the domain registrant, if available | [optional] 
-**registrant_telephone** | **String** | Telephone number of the address of the domain registrant | [optional] 
-**whois_server** | **String** | Server used to lookup WHOIS information (may change based on lookup). | [optional] 
-**raw_text_record** | **String** | WHOIS raw text record | [optional] 
-**created_dt** | **DateTime** | Creation date for the record | [optional] 
-
-

data/git_push.sh

@@ -1,55 +0,0 @@
-#!/bin/sh
-#
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
-#
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=`git remote`
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'
-