cloudmersive-validate-api-client 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6bfce70a2d0aeed84aa2f8534ed8e27ac91f23928da85a3c240cfff9924cdfa
-  data.tar.gz: ba33691519f32aa96a7d02d69e94d96ef7383e0e41cff23aae05273fc7fffb93
+  metadata.gz: 7135177ad51c8502ae852be5bc3617dc7c2223fc72f6cf73e4f018b536ff3b89
+  data.tar.gz: 4e03d4a5bc7f40e648406778707abf5a24c106ab39d0c7970f6ed696eaf0a196
 SHA512:
-  metadata.gz: 26907fe136c8911a82fe471ed4d64b9e146062b564b316269e10ecb200b737c562d36875ba044e872ac7d3c7b9a74c67f9497f94d12b7bc7b371d9f68fb324c9
-  data.tar.gz: d9e8761ab1abb1a9fdc92901ff93ab2a767e855cc8cf5bb0800a16e380f594ac52805f1a0c15dbfd0d4ae3b3f9899e5501321af32047087284a49cc094478b11
+  metadata.gz: c86c6819ed7f137ef233b5a4b0873a213f8474c780f79373d373a364e87a821bec557c91cb629cf9a05580a0a9ac4dd03595d7a748b3130d27858d45bad5cc71
+  data.tar.gz: c49afb5ccd636f80a7527afaa5575dfc3f257d70e33cc1e97dcbbbd544533d3f9bd0c8196120709e09af296eb8559abbf9ae3ade8047321dfbd9c8cf4cf2cab4

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.3.5
+- Package version: 1.3.6
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-1.3.5.gem
+gem install ./cloudmersive-validate-api-client-1.3.6.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.6.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 1.3.5'
+    gem 'cloudmersive-validate-api-client', '~> 1.3.6'
 
 ### Install from Git
 
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::AddressApi* | [**address_parse_string**](docs/AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
+*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
 *CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
 *CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
@@ -96,6 +97,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
 *CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
+*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
 *CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Lookup a VAT code
 
 
@@ -118,7 +120,11 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
+ - [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
+ - [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
+ - [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
  - [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
+ - [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
  - [CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly](docs/ValidateUrlResponseSyntaxOnly.md)
  - [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
  - [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)

data/docs/DomainApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 [**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
+[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
 [**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
 
 
@@ -117,6 +118,60 @@ Name | Type | Description  | Notes
 
 
 
+# **domain_url_full**
+> ValidateUrlResponseFull domain_url_full(request)
+
+Validate a URL fully
+
+Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+
+### 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::DomainApi.new
+
+request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull | 
+
+
+begin
+  #Validate a URL fully
+  result = api_instance.domain_url_full(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DomainApi->domain_url_full: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)|  | 
+
+### Return type
+
+[**ValidateUrlResponseFull**](ValidateUrlResponseFull.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
+
+
+
 # **domain_url_syntax_only**
 > ValidateUrlResponseSyntaxOnly domain_url_syntax_only(request)
 

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, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/UserAgentValidateRequest.md

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

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

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

data/docs/ValidateUrlResponseFull.md

@@ -0,0 +1,12 @@
+# 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/lib/cloudmersive-validate-api-client.rb

@@ -34,7 +34,11 @@ 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_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'
@@ -47,6 +51,7 @@ 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

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

@@ -130,6 +130,61 @@ module CloudmersiveValidateApiClient
       return data, status_code, headers
     end
 
+    # Validate a URL fully
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateUrlResponseFull]
+    def domain_url_full(request, opts = {})
+      data, _status_code, _headers = domain_url_full_with_http_info(request, opts)
+      return data
+    end
+
+    # Validate a URL fully
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateUrlResponseFull, Fixnum, Hash)>] ValidateUrlResponseFull data, response status code and response headers
+    def domain_url_full_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DomainApi.domain_url_full ..."
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_url_full"
+      end
+      # resource path
+      local_var_path = "/validate/domain/url/full"
+
+      # 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(request)
+      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 => 'ValidateUrlResponseFull')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_url_full\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate a URL syntactically
     # Validate whether a URL is syntactically valid (does not check endpoint for validity).  Accepts various types of input and produces a well-formed URL as output.
     # @param request 

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

@@ -0,0 +1,78 @@
+=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 UserAgentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 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.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [UserAgentValidateResponse]
+    def user_agent_parse(request, opts = {})
+      data, _status_code, _headers = user_agent_parse_with_http_info(request, opts)
+      return data
+    end
+
+    # 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.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserAgentValidateResponse, Fixnum, Hash)>] UserAgentValidateResponse data, response status code and response headers
+    def user_agent_parse_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UserAgentApi.user_agent_parse ..."
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling UserAgentApi.user_agent_parse"
+      end
+      # resource path
+      local_var_path = "/validate/useragent/parse"
+
+      # 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(request)
+      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 => 'UserAgentValidateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserAgentApi#user_agent_parse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,189 @@
+=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 'date'
+
+module CloudmersiveValidateApiClient
+  # User-Agent parse and validation request
+  class UserAgentValidateRequest
+    # The user agent string you wish to parse and validate
+    attr_accessor :user_agent_string
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_agent_string' => :'UserAgentString'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'user_agent_string' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'UserAgentString')
+        self.user_agent_string = attributes[:'UserAgentString']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          user_agent_string == o.user_agent_string
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [user_agent_string].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveValidateApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end