cloudmersive-validate-api-client 2.1.9 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b14865010ef033e3b2eb06a1ead269e3e1282f68298cc426469d6b05308f5101
-  data.tar.gz: 2cebdb3e846f47bb3fa2e8d5c9c346271d3418c82d79507a622ea74e9cbdeb71
+  metadata.gz: b718b14d76475a079bd8b6170efa4b446eeb1f72f1dc675e668fc7df317702f7
+  data.tar.gz: 743e6ffadb3143a39d6b1396cbbb49451253474f210997ae1cb96cf8570f9e27
 SHA512:
-  metadata.gz: 7aa827e35f6d854d22b9b50d2276f0ccc51ca5f2446a2ff0e5fd0e50d6837ea57ef1dc4beb4e2f8cafeda2a3bb5f40a24b2a55d6af01e86bbe851b0061319f09
-  data.tar.gz: 76cec04103d7d4818c83bcc518daa22c8ba71fb3bc33ac9c19806d82a1aee4e12985d80ed720b8847da27a623fa5dc36d60252219cac5761e95f23f21c5122c8
+  metadata.gz: 5b4cef8c87f1a63adb8f30eaf38b655004ab274da06d27379b3368f5d47742c1853ca6ec945fc27b11b0a5f79790b11d660d56e0cb558769dc94cfed5379474d
+  data.tar.gz: 7f3be0521871024a35d9e8d802727f61475ecfc1761ccb7bcdadaf844708b34fc8ebf2e04e68bfc41b6bac778907dda92c090b7b800b97277407c98e0d657671

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: 2.1.9
+- Package version: 2.2.0
 - 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-2.1.9.gem
+gem install ./cloudmersive-validate-api-client-2.2.0.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.9.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.0.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', '~> 2.1.9'
+    gem 'cloudmersive-validate-api-client', '~> 2.2.0'
 
 ### Install from Git
 
@@ -132,6 +132,8 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection_batch**](docs/TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
 *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss**](docs/TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
 *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss_batch**](docs/TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
+*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe**](docs/TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
+*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe_batch**](docs/TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
 *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_protect_xss**](docs/TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
 *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 | Validate a VAT number
@@ -217,6 +219,10 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::XssProtectionBatchResponse](docs/XssProtectionBatchResponse.md)
  - [CloudmersiveValidateApiClient::XssProtectionRequestItem](docs/XssProtectionRequestItem.md)
  - [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchRequest](docs/XxeDetectionBatchRequest.md)
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchResponse](docs/XxeDetectionBatchResponse.md)
+ - [CloudmersiveValidateApiClient::XxeDetectionRequestItem](docs/XxeDetectionRequestItem.md)
+ - [CloudmersiveValidateApiClient::XxeDetectionResult](docs/XxeDetectionResult.md)
 
 
 ## Documentation for Authorization

data/docs/TextInputApi.md

@@ -8,6 +8,8 @@ Method | HTTP request | Description
 [**text_input_check_sql_injection_batch**](TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
 [**text_input_check_xss**](TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
 [**text_input_check_xss_batch**](TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
+[**text_input_check_xxe**](TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
+[**text_input_check_xxe_batch**](TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
 [**text_input_protect_xss**](TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
 
 
@@ -231,6 +233,122 @@ Name | Type | Description  | Notes
 
 
 
+# **text_input_check_xxe**
+> XxeDetectionResult text_input_check_xxe(value, opts)
+
+Protect text input from XML External Entity (XXE) attacks
+
+Detects XXE (XML External Entity) attacks from text input.
+
+### 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::TextInputApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+opts = { 
+  allow_internet_urls: true, # BOOLEAN | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false.
+  known_safe_urls: 'known_safe_urls_example', # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
+  known_unsafe_urls: 'known_unsafe_urls_example' # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
+}
+
+begin
+  #Protect text input from XML External Entity (XXE) attacks
+  result = api_instance.text_input_check_xxe(value, opts)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_xxe: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+ **allow_internet_urls** | **BOOLEAN**| Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false. | [optional] 
+ **known_safe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional] 
+ **known_unsafe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional] 
+
+### Return type
+
+[**XxeDetectionResult**](XxeDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **text_input_check_xxe_batch**
+> XxeDetectionBatchResponse text_input_check_xxe_batch(request)
+
+Protect text input from XML External Entity (XXE) attacks
+
+Detects XXE (XML External Entity) attacks from text input.
+
+### 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::TextInputApi.new
+
+request = CloudmersiveValidateApiClient::XxeDetectionBatchRequest.new # XxeDetectionBatchRequest | 
+
+
+begin
+  #Protect text input from XML External Entity (XXE) attacks
+  result = api_instance.text_input_check_xxe_batch(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_xxe_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**XxeDetectionBatchRequest**](XxeDetectionBatchRequest.md)|  | 
+
+### Return type
+
+[**XxeDetectionBatchResponse**](XxeDetectionBatchResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **text_input_protect_xss**
 > XssProtectionResult text_input_protect_xss(value)
 

data/docs/XxeDetectionBatchRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::XxeDetectionBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_items** | [**Array<XxeDetectionRequestItem>**](XxeDetectionRequestItem.md) | Multiple items to protect for XXE | [optional] 
+
+

data/docs/XxeDetectionBatchResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::XxeDetectionBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result_items** | [**Array<XxeDetectionResult>**](XxeDetectionResult.md) | Results from performing a batch XSS protection operation | [optional] 
+
+

data/docs/XxeDetectionRequestItem.md

@@ -0,0 +1,11 @@
+# CloudmersiveValidateApiClient::XxeDetectionRequestItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** | Individual input text item to protect from XXE | [optional] 
+**allow_internet_urls** | **BOOLEAN** | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false. | [optional] 
+**known_safe_urls** | **Array<String>** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional] 
+**known_unsafe_urls** | **Array<String>** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional] 
+
+

data/docs/XxeDetectionResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::XxeDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_xxe** | **BOOLEAN** | True if the input contained XXE threats, false otherwise | [optional] 
+
+

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

@@ -95,6 +95,10 @@ require 'cloudmersive-validate-api-client/models/xss_protection_batch_request'
 require 'cloudmersive-validate-api-client/models/xss_protection_batch_response'
 require 'cloudmersive-validate-api-client/models/xss_protection_request_item'
 require 'cloudmersive-validate-api-client/models/xss_protection_result'
+require 'cloudmersive-validate-api-client/models/xxe_detection_batch_request'
+require 'cloudmersive-validate-api-client/models/xxe_detection_batch_response'
+require 'cloudmersive-validate-api-client/models/xxe_detection_request_item'
+require 'cloudmersive-validate-api-client/models/xxe_detection_result'
 
 # APIs
 require 'cloudmersive-validate-api-client/api/address_api'

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

@@ -238,6 +238,123 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Protect text input from XML External Entity (XXE) attacks
+    # Detects XXE (XML External Entity) attacks from text input.
+    # @param value User-facing text input.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :allow_internet_urls Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false.
+    # @option opts [String] :known_safe_urls Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
+    # @option opts [String] :known_unsafe_urls Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
+    # @return [XxeDetectionResult]
+    def text_input_check_xxe(value, opts = {})
+      data, _status_code, _headers = text_input_check_xxe_with_http_info(value, opts)
+      data
+    end
+
+    # Protect text input from XML External Entity (XXE) attacks
+    # Detects XXE (XML External Entity) attacks from text input.
+    # @param value User-facing text input.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :allow_internet_urls Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block.  Default is false.
+    # @option opts [String] :known_safe_urls Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
+    # @option opts [String] :known_unsafe_urls Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
+    # @return [Array<(XxeDetectionResult, Fixnum, Hash)>] XxeDetectionResult data, response status code and response headers
+    def text_input_check_xxe_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_xxe ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_xxe"
+      end
+      # resource path
+      local_var_path = '/validate/text-input/check/xxe'
+
+      # 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'])
+      header_params[:'allowInternetUrls'] = opts[:'allow_internet_urls'] if !opts[:'allow_internet_urls'].nil?
+      header_params[:'knownSafeUrls'] = opts[:'known_safe_urls'] if !opts[:'known_safe_urls'].nil?
+      header_params[:'knownUnsafeUrls'] = opts[:'known_unsafe_urls'] if !opts[:'known_unsafe_urls'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'XxeDetectionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TextInputApi#text_input_check_xxe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Protect text input from XML External Entity (XXE) attacks
+    # Detects XXE (XML External Entity) attacks from text input.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [XxeDetectionBatchResponse]
+    def text_input_check_xxe_batch(request, opts = {})
+      data, _status_code, _headers = text_input_check_xxe_batch_with_http_info(request, opts)
+      data
+    end
+
+    # Protect text input from XML External Entity (XXE) attacks
+    # Detects XXE (XML External Entity) attacks from text input.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(XxeDetectionBatchResponse, Fixnum, Hash)>] XxeDetectionBatchResponse data, response status code and response headers
+    def text_input_check_xxe_batch_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_xxe_batch ...'
+      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 TextInputApi.text_input_check_xxe_batch"
+      end
+      # resource path
+      local_var_path = '/validate/text-input/check/xxe/batch'
+
+      # 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'])
+
+      # 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 => 'XxeDetectionBatchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TextInputApi#text_input_check_xxe_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
     # Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization.  Returns the normalized result, as well as information on whether the original input contained an XSS risk.
     # @param value User-facing text input.

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

@@ -0,0 +1,188 @@
+=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.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveValidateApiClient
+  # Input to a batch XXE detection operation
+  class XxeDetectionBatchRequest
+    # Multiple items to protect for XXE
+    attr_accessor :request_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_items' => :'RequestItems'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'request_items' => :'Array<XxeDetectionRequestItem>'
+      }
+    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?(:'RequestItems')
+        if (value = attributes[:'RequestItems']).is_a?(Array)
+          self.request_items = value
+        end
+      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
+      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?
+      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 &&
+          request_items == o.request_items
+    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
+      [request_items].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 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