freeclimb 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad359c65ec1da2cff52f44bab57f5f01fe852e4e9ac09c65fdecf724566349ff
-  data.tar.gz: dac1dae63f315c7e7ac52c1c7717875b8b5f4227e33d16723992e76189926090
+  metadata.gz: 1ad32fa62459bb0e4d1887a289ba7ad5b77aa6fca78d4a1db3bf29881275e130
+  data.tar.gz: 89fd14f2c7d3329a56806f29ae46b44a3106e74b5639fd596894851fef36c845
 SHA512:
-  metadata.gz: a71b0e3b0eb8b3ed799f69e929ea690509df38780a07ef5db5895e8b713b0a00518732953e595e0f433dabf27dce064d1edab0640775f477d20977c29685c2c2
-  data.tar.gz: 4cb9c899de0346d5b3427d3760b66ed16e3d937f425ccf8c44ee7b0cf05577435bc8942f5af80769ea729c3f0de5f3c0eca6747c9b61fe55e9800ea0e6f364bb
+  metadata.gz: 15225dd8b0ed975eea0e66b92e55b25891d6792b1bbc163ad64264cfba758239343cf809801276e95dd32c48aa05b11069aff28cb94a39963867d6585c894402
+  data.tar.gz: df9ca5026bf77fc5b681158ca5d87255047f54a147d2af040a630a0c8a8a17fa210e614b92e3c4f3e26aecf27ebc650bdee4dbaa6e17d3807faabff4df66a3b3

data/CHANGELOG.md

@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="4.8.0"></a>
+
+## [4.8.0] - 2024-10-08
+
+### Added
+
+- Add KnowledgeBase API to SDK
+
 <a name="4.7.0"></a>
 
 ## [4.7.0] - 2024-09-12

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.7.0)
+    freeclimb (4.8.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.4.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -17,14 +17,14 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
@@ -34,18 +34,18 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     facets (3.1.0)
-    factory_bot (6.4.6)
+    factory_bot (6.5.0)
       activesupport (>= 5.0.0)
     ffi (1.17.0)
-    hashdiff (1.1.0)
-    i18n (1.14.4)
+    hashdiff (1.1.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.6)
-    method_source (1.0.0)
-    minitest (5.22.3)
+    method_source (1.1.0)
+    minitest (5.25.1)
     mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -56,21 +56,21 @@ GEM
       pry (>= 0.13, < 0.15)
     psych (5.1.2)
       stringio
-    public_suffix (5.0.5)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rexml (3.2.6)
+    rexml (3.3.8)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -83,13 +83,13 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.1.0)
+    stringio (3.1.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
-    webmock (3.23.0)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.7.0
+- Package version: 4.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
 
 Add this to the Gemfile:
 
-    gem 'freeclimb', '~> 4.7.0'
+    gem 'freeclimb', '~> 4.8.0'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.7.0.gem
+gem install ./freeclimb-4.8.0.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.7.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.8.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -103,6 +103,7 @@ Class | Method | HTTP request | Description
 *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
 *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
 *Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
+*Freeclimb::DefaultApi* | [**create_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
 *Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
 *Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
 *Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
@@ -183,6 +184,8 @@ Class | Method | HTTP request | Description
  - [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
  - [Freeclimb::CallStatus](docs/CallStatus.md)
  - [Freeclimb::Capabilities](docs/Capabilities.md)
+ - [Freeclimb::CompletionRequest](docs/CompletionRequest.md)
+ - [Freeclimb::CompletionResult](docs/CompletionResult.md)
  - [Freeclimb::ConferenceList](docs/ConferenceList.md)
  - [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
  - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)

data/docs/CompletionRequest.md

@@ -0,0 +1,18 @@
+# Freeclimb::CompletionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Question to ask the Knowledge Base |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CompletionRequest.new(
+  query: null
+)
+```
+

data/docs/CompletionResult.md

@@ -0,0 +1,20 @@
+# Freeclimb::CompletionResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | The generative response from the KnowledgeBase |  |
+| **status** | **String** | Completion result status. Possible values: success, no_context |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CompletionResult.new(
+  response: null,
+  status: null
+)
+```
+

data/docs/DefaultApi.md

@@ -12,6 +12,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
@@ -401,6 +403,80 @@ end
 - **Accept**: application/json
 
 
+## create_knowledge_base_completion
+
+Query the knowledge base
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+knowledge_base_id = 'knowledge_base_id_example' # String | A string that uniquely identifies the KnowledgeBase resource.
+
+opts = {
+  completion_request: Freeclimb::CompletionRequest.new({query: 'query_example'}) # CompletionRequest | Completion request details
+}
+
+begin
+
+  # Query the knowledge base
+  result = api_instance.create_knowledge_base_completion(knowledge_base_id, opts)
+  p result
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->create_knowledge_base_completion: #{e}"
+end
+```
+
+#### Using the create_knowledge_base_completion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompletionResult>, Integer, Hash)> create_knowledge_base_completion_with_http_info(account_id, knowledge_base_id, opts)
+
+```ruby
+begin
+  # Query the knowledge base
+  data, status_code, headers = api_instance.create_knowledge_base_completion_with_http_info(knowledge_base_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompletionResult>
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->create_knowledge_base_completion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **knowledge_base_id** | **String** | A string that uniquely identifies the KnowledgeBase resource. |  |
+| **completion_request** | [**CompletionRequest**](CompletionRequest.md) | Completion request details | [optional] |
+
+
+### Return type
+
+[**CompletionResult**](CompletionResult.md)
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## delete_a_recording
 
 Delete a Recording

data/docs/SMSTenDLCCampaign.md

@@ -82,7 +82,7 @@ instance = Freeclimb::SMSTenDLCCampaign.new(
   optout_message: null,
   reference_id: null,
   mock: null,
-  next_renewal_or_expiration_date: Fri Dec 31 18:00:00 CST 1999
+  next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
 )
 ```
 

data/lib/freeclimb/api/default_api.rb

@@ -277,6 +277,75 @@ module Freeclimb
       return data, status_code, headers
     end
 
+    # Query the knowledge base
+    # @param knowledge_base_id [String] A string that uniquely identifies the KnowledgeBase resource.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CompletionRequest] :completion_request Completion request details
+    # @return [CompletionResult]
+    def create_knowledge_base_completion(knowledge_base_id, opts = {})
+      data, _status_code, _headers = create_knowledge_base_completion_with_http_info(knowledge_base_id, opts)
+      data
+    end
+
+    # Query the knowledge base
+    # @param knowledge_base_id [String] A string that uniquely identifies the KnowledgeBase resource.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CompletionRequest] :completion_request Completion request details
+    # @return [Array<(CompletionResult, Integer, Hash)>] CompletionResult data, response status code and response headers
+    def create_knowledge_base_completion_with_http_info(knowledge_base_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.create_knowledge_base_completion ...'
+      end
+
+      # verify the required parameter 'knowledge_base_id' is set
+      if @api_client.config.client_side_validation && knowledge_base_id.nil?
+        fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling DefaultApi.create_knowledge_base_completion"
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'knowledgeBaseId' + '}', CGI.escape(knowledge_base_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'completion_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompletionResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.create_knowledge_base_completion",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#create_knowledge_base_completion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a Recording
     # @param recording_id [String] String that uniquely identifies this recording resource.
     # @param [Hash] opts the optional parameters

data/lib/freeclimb/models/completion_request.rb

@@ -0,0 +1,246 @@
+=begin
+#FreeClimb API
+
+#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@freeclimb.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  class CompletionRequest
+    # Question to ask the Knowledge Base
+    attr_accessor :query
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'query' => :'query'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'query' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::CompletionRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::CompletionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      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
+      if @query.nil?
+        invalid_properties.push('invalid value for "query", query cannot be nil.')
+      end
+
+      if @query.to_s.length > 2000
+        invalid_properties.push('invalid value for "query", the character length must be smaller than or equal to 2000.')
+      end
+
+      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?
+      
+      if @query.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query Value to be assigned
+    def query=(query)
+      if query.nil?
+        fail ArgumentError, 'query cannot be nil'
+      end
+
+      if query.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "query", the character length must be smaller than or equal to 2000.'
+      end
+
+      @query = query
+    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 &&
+          query == o.query
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [query].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Freeclimb.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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