cloudmersive-validate-api-client 1.3.7 → 2.0.1

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, application/xml, text/xml, application/x-www-form-urlencoded
- - **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, application/xml, text/xml, application/x-www-form-urlencoded
- - **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/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, application/xml, text/xml, application/x-www-form-urlencoded
- - **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,12 +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 | [optional] 
-
-

data/docs/WhoisResponse.md

@@ -1,11 +0,0 @@
-# CloudmersiveValidateApiClient::WhoisResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**valid_domain** | **BOOLEAN** | True if the domain is valid, false if it is not | [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'
-

data/lib/cloudmersive-validate-api-client.rb

@@ -1,75 +0,0 @@
-=begin
-#validateapi
-
-#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
-
-OpenAPI spec version: v1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-# Common files
-require 'cloudmersive-validate-api-client/api_client'
-require 'cloudmersive-validate-api-client/api_error'
-require 'cloudmersive-validate-api-client/version'
-require 'cloudmersive-validate-api-client/configuration'
-
-# Models
-require 'cloudmersive-validate-api-client/models/address_get_servers_response'
-require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_response'
-require 'cloudmersive-validate-api-client/models/check_response'
-require 'cloudmersive-validate-api-client/models/first_name_validation_request'
-require 'cloudmersive-validate-api-client/models/first_name_validation_response'
-require 'cloudmersive-validate-api-client/models/full_email_validation_response'
-require 'cloudmersive-validate-api-client/models/full_name_validation_request'
-require 'cloudmersive-validate-api-client/models/full_name_validation_response'
-require 'cloudmersive-validate-api-client/models/geolocate_response'
-require 'cloudmersive-validate-api-client/models/get_gender_request'
-require 'cloudmersive-validate-api-client/models/get_gender_response'
-require 'cloudmersive-validate-api-client/models/last_name_validation_request'
-require 'cloudmersive-validate-api-client/models/last_name_validation_response'
-require 'cloudmersive-validate-api-client/models/parse_address_request'
-require 'cloudmersive-validate-api-client/models/parse_address_response'
-require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
-require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
-require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
-require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
-require 'cloudmersive-validate-api-client/models/validate_identifier_request'
-require 'cloudmersive-validate-api-client/models/validate_identifier_response'
-require 'cloudmersive-validate-api-client/models/validate_url_request_full'
-require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
-require 'cloudmersive-validate-api-client/models/validate_url_response_full'
-require 'cloudmersive-validate-api-client/models/validate_url_response_syntax_only'
-require 'cloudmersive-validate-api-client/models/vat_lookup_request'
-require 'cloudmersive-validate-api-client/models/vat_lookup_response'
-require 'cloudmersive-validate-api-client/models/whois_response'
-
-# APIs
-require 'cloudmersive-validate-api-client/api/address_api'
-require 'cloudmersive-validate-api-client/api/domain_api'
-require 'cloudmersive-validate-api-client/api/email_api'
-require 'cloudmersive-validate-api-client/api/ip_address_api'
-require 'cloudmersive-validate-api-client/api/name_api'
-require 'cloudmersive-validate-api-client/api/phone_number_api'
-require 'cloudmersive-validate-api-client/api/user_agent_api'
-require 'cloudmersive-validate-api-client/api/vat_api'
-
-module CloudmersiveValidateApiClient
-  class << self
-    # Customize default settings for the SDK using block.
-    #   CloudmersiveValidateApiClient.configure do |config|
-    #     config.username = "xxx"
-    #     config.password = "xxx"
-    #   end
-    # If no block given, return the default Configuration object.
-    def configure
-      if block_given?
-        yield(Configuration.default)
-      else
-        Configuration.default
-      end
-    end
-  end
-end