ultracart_api 4.1.252 → 4.1.253

data/lib/ultracart_api/models/sfvb_search_facets_request.rb

@@ -0,0 +1,244 @@
+=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 SfvbSearchFacetsRequest
+    # The Cost facet price breaks, 1 to 20 whole amounts in the base currency, each 1 to 10,000,000, smallest first.  Replaces the list.
+    attr_accessor :cost_price_points
+
+    # True to check the change and report it without saving.
+    attr_accessor :dry_run
+
+    # The facets to change.
+    attr_accessor :facets
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cost_price_points' => :'cost_price_points',
+        :'dry_run' => :'dry_run',
+        :'facets' => :'facets'
+      }
+    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
+      {
+        :'cost_price_points' => :'Array<Integer>',
+        :'dry_run' => :'Boolean',
+        :'facets' => :'Array<SfvbSearchFacetUpdate>'
+      }
+    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::SfvbSearchFacetsRequest` 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::SfvbSearchFacetsRequest`. 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?(:'cost_price_points')
+        if (value = attributes[:'cost_price_points']).is_a?(Array)
+          self.cost_price_points = value
+        end
+      end
+
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'facets')
+        if (value = attributes[:'facets']).is_a?(Array)
+          self.facets = 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 &&
+          cost_price_points == o.cost_price_points &&
+          dry_run == o.dry_run &&
+          facets == o.facets
+    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
+      [cost_price_points, dry_run, facets].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

data/lib/ultracart_api/models/sfvb_search_facets_response.rb

@@ -0,0 +1,286 @@
+=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 SfvbSearchFacetsResponse
+    # After a change, the facets it changed.
+    attr_accessor :changed_facets
+
+    # The Cost facet price breaks, smallest first.
+    attr_accessor :cost_price_points
+
+    # True when nothing was saved.
+    attr_accessor :dry_run
+
+    # Every facet the storefront can offer, in the fixed order shoppers see them.
+    attr_accessor :facets
+
+    # Hash of the facets and price points.  Send it as If-Match on a change.
+    attr_accessor :hash_sha256
+
+    # After a change, true when the price points changed.
+    attr_accessor :price_points_changed
+
+    # After a change, the search index rebuild it started.  none, quick (minutes, small catalogs), slow (the regular rebuild cycle) or failed (the change is saved but the rebuild could not be started; save again or contact support).
+    attr_accessor :rebuild
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'changed_facets' => :'changed_facets',
+        :'cost_price_points' => :'cost_price_points',
+        :'dry_run' => :'dry_run',
+        :'facets' => :'facets',
+        :'hash_sha256' => :'hash_sha256',
+        :'price_points_changed' => :'price_points_changed',
+        :'rebuild' => :'rebuild'
+      }
+    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
+      {
+        :'changed_facets' => :'Array<String>',
+        :'cost_price_points' => :'Array<Integer>',
+        :'dry_run' => :'Boolean',
+        :'facets' => :'Array<SfvbSearchFacet>',
+        :'hash_sha256' => :'String',
+        :'price_points_changed' => :'Boolean',
+        :'rebuild' => :'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::SfvbSearchFacetsResponse` 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::SfvbSearchFacetsResponse`. 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?(:'changed_facets')
+        if (value = attributes[:'changed_facets']).is_a?(Array)
+          self.changed_facets = value
+        end
+      end
+
+      if attributes.key?(:'cost_price_points')
+        if (value = attributes[:'cost_price_points']).is_a?(Array)
+          self.cost_price_points = value
+        end
+      end
+
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'facets')
+        if (value = attributes[:'facets']).is_a?(Array)
+          self.facets = value
+        end
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'price_points_changed')
+        self.price_points_changed = attributes[:'price_points_changed']
+      end
+
+      if attributes.key?(:'rebuild')
+        self.rebuild = attributes[:'rebuild']
+      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 &&
+          changed_facets == o.changed_facets &&
+          cost_price_points == o.cost_price_points &&
+          dry_run == o.dry_run &&
+          facets == o.facets &&
+          hash_sha256 == o.hash_sha256 &&
+          price_points_changed == o.price_points_changed &&
+          rebuild == o.rebuild
+    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
+      [changed_facets, cost_price_points, dry_run, facets, hash_sha256, price_points_changed, rebuild].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

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.252'
+  VERSION = '4.1.253'
 end

data/lib/ultracart_api.rb

@@ -1231,6 +1231,8 @@ require 'ultracart_api/models/sfvb_page_items_add_request'
 require 'ultracart_api/models/sfvb_page_items_remove_request'
 require 'ultracart_api/models/sfvb_page_items_response'
 require 'ultracart_api/models/sfvb_page_list_response'
+require 'ultracart_api/models/sfvb_page_move_request'
+require 'ultracart_api/models/sfvb_page_move_response'
 require 'ultracart_api/models/sfvb_page_multimedia'
 require 'ultracart_api/models/sfvb_page_multimedia_request'
 require 'ultracart_api/models/sfvb_page_refresh_request'
@@ -1279,6 +1281,10 @@ require 'ultracart_api/models/sfvb_redirects_response'
 require 'ultracart_api/models/sfvb_render_request'
 require 'ultracart_api/models/sfvb_render_response'
 require 'ultracart_api/models/sfvb_robots_txt'
+require 'ultracart_api/models/sfvb_search_facet'
+require 'ultracart_api/models/sfvb_search_facet_update'
+require 'ultracart_api/models/sfvb_search_facets_request'
+require 'ultracart_api/models/sfvb_search_facets_response'
 require 'ultracart_api/models/sfvb_secret_handle'
 require 'ultracart_api/models/sfvb_secret_kind'
 require 'ultracart_api/models/sfvb_secret_kinds_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.252
+  version: 4.1.253
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-12 00:00:00.000000000 Z
+date: 2026-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1293,6 +1293,8 @@ files:
 - docs/SfvbPageItemsRemoveRequest.md
 - docs/SfvbPageItemsResponse.md
 - docs/SfvbPageListResponse.md
+- docs/SfvbPageMoveRequest.md
+- docs/SfvbPageMoveResponse.md
 - docs/SfvbPageMultimedia.md
 - docs/SfvbPageMultimediaRequest.md
 - docs/SfvbPageRefreshRequest.md
@@ -1341,6 +1343,10 @@ files:
 - docs/SfvbRenderRequest.md
 - docs/SfvbRenderResponse.md
 - docs/SfvbRobotsTxt.md
+- docs/SfvbSearchFacet.md
+- docs/SfvbSearchFacetUpdate.md
+- docs/SfvbSearchFacetsRequest.md
+- docs/SfvbSearchFacetsResponse.md
 - docs/SfvbSecretHandle.md
 - docs/SfvbSecretKind.md
 - docs/SfvbSecretKindsResponse.md
@@ -2797,6 +2803,8 @@ files:
 - lib/ultracart_api/models/sfvb_page_items_remove_request.rb
 - lib/ultracart_api/models/sfvb_page_items_response.rb
 - lib/ultracart_api/models/sfvb_page_list_response.rb
+- lib/ultracart_api/models/sfvb_page_move_request.rb
+- lib/ultracart_api/models/sfvb_page_move_response.rb
 - lib/ultracart_api/models/sfvb_page_multimedia.rb
 - lib/ultracart_api/models/sfvb_page_multimedia_request.rb
 - lib/ultracart_api/models/sfvb_page_refresh_request.rb
@@ -2845,6 +2853,10 @@ files:
 - lib/ultracart_api/models/sfvb_render_request.rb
 - lib/ultracart_api/models/sfvb_render_response.rb
 - lib/ultracart_api/models/sfvb_robots_txt.rb
+- lib/ultracart_api/models/sfvb_search_facet.rb
+- lib/ultracart_api/models/sfvb_search_facet_update.rb
+- lib/ultracart_api/models/sfvb_search_facets_request.rb
+- lib/ultracart_api/models/sfvb_search_facets_response.rb
 - lib/ultracart_api/models/sfvb_secret_handle.rb
 - lib/ultracart_api/models/sfvb_secret_kind.rb
 - lib/ultracart_api/models/sfvb_secret_kinds_response.rb