ultracart_api 4.1.226 → 4.1.227

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c3131895afcb281803e49d636846ec15358a684552f90cab1b880e15cd1355
-  data.tar.gz: ab6bdf275099e086dd4d36ce07cb705894ab7d0b9b9fcd410041d92ff93bd921
+  metadata.gz: 9cebb20eb6b5e4505c97751fdc80c2ef40598ac560a4f3b35e7787468c22af6e
+  data.tar.gz: dc802f516b52ca2d4da126b1407ba78b926f62e8e6573abc1bd8bf9bb91e2a22
 SHA512:
-  metadata.gz: c53f4efbd29f1be9d09b314f9ae2080436116dc33aea108454a482b337ade38506fd89aa3da59419225155cb5070dc0e222993aa0c1098e60ed980ca36a561fe
-  data.tar.gz: e42f873a047fb0b2dc7dc3e8a3eaeb107d6d0498ee482462a5214e98228ad1d9d332ec54a7137fc98a7bff32cc384af9d6be3769b76ebebcc70d4b4f92b263b3
+  metadata.gz: 46669da4eceeb6072c7c791e0cc9a9dc51860654714711e65fa9c4713ef0fb7d682898682f217bfece4aa4ba261de6b463d115d7abb429ee3d9208f3c609f320
+  data.tar.gz: 612105c33ada9046e36a7295f6c6196dbcb15a807c236fc740f12ba7286ee5a6b15cc576b4af5c7f48236ee20b83ba4cfd27c7e54a8d4b543223b7874c97b407

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.226
+- Package version: 4.1.227
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.226'
+gem 'ultracart_api', '4.1.227'
 ```
 
 install:
@@ -584,6 +584,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
 *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
 *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
+*UltracartClient::SfvbApi* | [**get_sfvb_sitemaps**](docs/SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt
 *UltracartClient::SfvbApi* | [**get_sfvb_smart_attribution**](docs/SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration
 *UltracartClient::SfvbApi* | [**get_sfvb_test_orders**](docs/SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders
 *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
@@ -2145,6 +2146,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbRedirectsResponse](docs/SfvbRedirectsResponse.md)
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
+ - [UltracartClient::SfvbRobotsTxt](docs/SfvbRobotsTxt.md)
  - [UltracartClient::SfvbSecretHandle](docs/SfvbSecretHandle.md)
  - [UltracartClient::SfvbSecretKind](docs/SfvbSecretKind.md)
  - [UltracartClient::SfvbSecretKindsResponse](docs/SfvbSecretKindsResponse.md)
@@ -2170,6 +2172,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
  - [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
  - [UltracartClient::SfvbSiteAttributesResponse](docs/SfvbSiteAttributesResponse.md)
+ - [UltracartClient::SfvbSitemap](docs/SfvbSitemap.md)
+ - [UltracartClient::SfvbSitemapFile](docs/SfvbSitemapFile.md)
+ - [UltracartClient::SfvbSitemapsResponse](docs/SfvbSitemapsResponse.md)
  - [UltracartClient::SfvbSmartAttribution](docs/SfvbSmartAttribution.md)
  - [UltracartClient::SfvbSmartAttributionPlatform](docs/SfvbSmartAttributionPlatform.md)
  - [UltracartClient::SfvbSmartAttributionRequest](docs/SfvbSmartAttributionRequest.md)
@@ -2403,6 +2408,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.227 | 11/04/2026 | sfvb internal testing |
 | 4.1.226 | 11/04/2026 | sfvb internal testing |
 | 4.1.225 | 11/03/2026 | sfvb internal testing |
 | 4.1.224 | 11/03/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -112,6 +112,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
 | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
 | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
+| [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
 | [**get_sfvb_smart_attribution**](SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration |
 | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
 | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
@@ -6104,6 +6105,59 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_sitemaps
+
+> <SfvbSitemapsResponse> get_sfvb_sitemaps(storefront_oid)
+
+Read a storefront's sitemaps and robots.txt
+
+The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on.  Read only.  The files are rebuilt nightly, so a page change shows in them after the next build. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_sitemaps_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbSitemapsResponse>, Integer, Hash)> get_sfvb_sitemaps_with_http_info(storefront_oid)
+
+```ruby
+begin
+  # Read a storefront's sitemaps and robots.txt
+  data, status_code, headers = api_instance.get_sfvb_sitemaps_with_http_info(storefront_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbSitemapsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_sitemaps_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+
+### Return type
+
+[**SfvbSitemapsResponse**](SfvbSitemapsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_smart_attribution
 
 > <SfvbSmartAttribution> get_sfvb_smart_attribution(storefront_oid)

data/docs/SfvbRobotsTxt.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbRobotsTxt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_file** | **Boolean** | True when the merchant has their own /robots.txt file, which is served after UltraCart's entries. | [optional] |
+| **sitemap_lines** | **Array<String>** | The Sitemap lines it serves, UltraCart's own first, then any in the merchant's own robots.txt file. | [optional] |
+| **url** | **String** | The robots.txt URL on the storefront's host. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRobotsTxt.new(
+  custom_file: null,
+  sitemap_lines: null,
+  url: null
+)
+```
+

data/docs/SfvbSitemap.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbSitemap
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **child_files** | [**Array<SfvbSitemapFile>**](SfvbSitemapFile.md) | For an index, the child files it lists, in order. | [optional] |
+| **format** | **String** | sitemaps.org (the index to register with Google Search Console and Bing), google-0.84 (the older Google schema) or urllist (a plain URL list). | [optional] |
+| **last_built** | **String** | When the nightly build last wrote the sitemap, as ISO 8601. | [optional] |
+| **path** | **String** | The sitemap's path on the storefront. | [optional] |
+| **size_bytes** | **Integer** | The file's size in bytes. | [optional] |
+| **url** | **String** | The sitemap's https URL, the one to register. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSitemap.new(
+  child_files: null,
+  format: null,
+  last_built: null,
+  path: null,
+  size_bytes: null,
+  url: null
+)
+```
+

data/docs/SfvbSitemapFile.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSitemapFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_built** | **String** | When the nightly build last wrote the file, as ISO 8601. | [optional] |
+| **path** | **String** | The file's path on the storefront, such as /sitemapsdotorg1.xml.gz. | [optional] |
+| **size_bytes** | **Integer** | The file's size in bytes, compressed for a .gz file. | [optional] |
+| **url** | **String** | The file's https URL on the storefront's host. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSitemapFile.new(
+  last_built: null,
+  path: null,
+  size_bytes: null,
+  url: null
+)
+```
+

data/docs/SfvbSitemapsResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbSitemapsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The host the sitemaps are built for. | [optional] |
+| **notes** | **Array<String>** | What a person should know about these sitemaps, such as when they are rebuilt. | [optional] |
+| **prevent_indexing** | **Boolean** | True when the storefront's Prevent Indexing setting is on.  The sitemaps are still served, but every page tells search engines not to index it. | [optional] |
+| **robots_txt** | [**SfvbRobotsTxt**](SfvbRobotsTxt.md) |  | [optional] |
+| **sitemaps** | [**Array<SfvbSitemap>**](SfvbSitemap.md) | The sitemaps that exist, sitemaps.org first.  Empty until the nightly build has run. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSitemapsResponse.new(
+  host: null,
+  notes: null,
+  prevent_indexing: null,
+  robots_txt: null,
+  sitemaps: null,
+  storefront_oid: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -7762,6 +7762,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Read a storefront's sitemaps and robots.txt
+    # The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on.  Read only.  The files are rebuilt nightly, so a page change shows in them after the next build. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbSitemapsResponse]
+    def get_sfvb_sitemaps(storefront_oid, opts = {})
+      data, _status_code, _headers = get_sfvb_sitemaps_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Read a storefront's sitemaps and robots.txt
+    # The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on.  Read only.  The files are rebuilt nightly, so a page change shows in them after the next build. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbSitemapsResponse, Integer, Hash)>] SfvbSitemapsResponse data, response status code and response headers
+    def get_sfvb_sitemaps_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_sitemaps ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_sitemaps"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/sitemaps'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbSitemapsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_sitemaps",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_sitemaps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read a storefront's Smart Attribution configuration
     # The mode, model, global credit split, lookback and platforms, the platforms detected from the tracking integrations that are not configured yet, and the hash_sha256 a change or delete sends back as If-Match.  When configured is false the values are the defaults an enable would save. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_robots_txt.rb

@@ -0,0 +1,242 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbRobotsTxt
+    # True when the merchant has their own /robots.txt file, which is served after UltraCart's entries.
+    attr_accessor :custom_file
+
+    # The Sitemap lines it serves, UltraCart's own first, then any in the merchant's own robots.txt file.
+    attr_accessor :sitemap_lines
+
+    # The robots.txt URL on the storefront's host.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'custom_file' => :'custom_file',
+        :'sitemap_lines' => :'sitemap_lines',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'custom_file' => :'Boolean',
+        :'sitemap_lines' => :'Array<String>',
+        :'url' => :'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 `UltracartClient::SfvbRobotsTxt` 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 `UltracartClient::SfvbRobotsTxt`. 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?(:'custom_file')
+        self.custom_file = attributes[:'custom_file']
+      end
+
+      if attributes.key?(:'sitemap_lines')
+        if (value = attributes[:'sitemap_lines']).is_a?(Array)
+          self.sitemap_lines = value
+        end
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 &&
+          custom_file == o.custom_file &&
+          sitemap_lines == o.sitemap_lines &&
+          url == o.url
+    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
+      [custom_file, sitemap_lines, url].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = UltracartClient.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