cloudmersive-validate-api-client 1.2.9

data/docs/FullEmailValidationResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::FullEmailValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_address** | **BOOLEAN** | True if the email address is valid, false otherwise | [optional] 
+**mail_server_used_for_validation** | **String** | Email server connected to for verification | [optional] 
+
+

data/docs/GeolocateResponse.md

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

@@ -0,0 +1,63 @@
+# 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/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, application/xml, text/xml, application/x-www-form-urlencoded
+ - **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/VatApi.md

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

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::VatLookupRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vat_code** | **String** |  | [optional] 
+
+

data/docs/VatLookupResponse.md

@@ -0,0 +1,12 @@
+# CloudmersiveValidateApiClient::VatLookupResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_code** | **String** |  | [optional] 
+**vat_number** | **String** |  | [optional] 
+**is_valid** | **BOOLEAN** |  | [optional] 
+**business_name** | **String** |  | [optional] 
+**business_address** | **String** |  | [optional] 
+
+

data/docs/WhoisResponse.md

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

@@ -0,0 +1,55 @@
+#!/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

@@ -0,0 +1,54 @@
+=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: unset
+
+=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/full_email_validation_response'
+require 'cloudmersive-validate-api-client/models/geolocate_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/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/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/phone_number_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

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

@@ -0,0 +1,133 @@
+=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: unset
+
+=end
+
+require "uri"
+
+module CloudmersiveValidateApiClient
+  class DomainApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Validate a domain name
+    # Check whether a domain name is valid or not.  API performs a live validation by contacting DNS services to validate the existence of the domain name.
+    # @param domain Domain name to check, for example \"cloudmersive.com\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [CheckResponse]
+    def domain_check(domain, opts = {})
+      data, _status_code, _headers = domain_check_with_http_info(domain, opts)
+      return data
+    end
+
+    # Validate a domain name
+    # Check whether a domain name is valid or not.  API performs a live validation by contacting DNS services to validate the existence of the domain name.
+    # @param domain Domain name to check, for example \"cloudmersive.com\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CheckResponse, Fixnum, Hash)>] CheckResponse data, response status code and response headers
+    def domain_check_with_http_info(domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DomainApi.domain_check ..."
+      end
+      # verify the required parameter 'domain' is set
+      if @api_client.config.client_side_validation && domain.nil?
+        fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_check"
+      end
+      # resource path
+      local_var_path = "/validate/domain/check"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(domain)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CheckResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get WHOIS information for a domain
+    # Validate whether a domain name exists, and also return the full WHOIS record for that domain name.  WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
+    # @param domain Domain name to check, for example \&quot;cloudmersive.com\&quot;.   The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [WhoisResponse]
+    def domain_post(domain, opts = {})
+      data, _status_code, _headers = domain_post_with_http_info(domain, opts)
+      return data
+    end
+
+    # Get WHOIS information for a domain
+    # Validate whether a domain name exists, and also return the full WHOIS record for that domain name.  WHOIS records include all the registration details of the domain name, such as information about the domain&#39;s owners.
+    # @param domain Domain name to check, for example \&quot;cloudmersive.com\&quot;.   The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WhoisResponse, Fixnum, Hash)>] WhoisResponse data, response status code and response headers
+    def domain_post_with_http_info(domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DomainApi.domain_post ..."
+      end
+      # verify the required parameter 'domain' is set
+      if @api_client.config.client_side_validation && domain.nil?
+        fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_post"
+      end
+      # resource path
+      local_var_path = "/validate/domain/whois"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(domain)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'WhoisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end