ultracart_api 4.1.173 → 4.1.175

data/lib/ultracart_api/models/sfvb_template_resolve_path.rb

@@ -0,0 +1,252 @@
+=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 SfvbTemplateResolvePath
+    # Every file of that name below this path, in the order the storefront searches.
+    attr_accessor :candidates
+
+    # False when the theme has no such directory, so the storefront skips this path.
+    attr_accessor :directory_found
+
+    # The candidate this path supplies, relative to the theme root, or null.  It is the first candidate that is not skipped.
+    attr_accessor :match
+
+    # The resource path, relative to the theme root.  / is the theme root itself.
+    attr_accessor :resource_path
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'candidates' => :'candidates',
+        :'directory_found' => :'directory_found',
+        :'match' => :'match',
+        :'resource_path' => :'resource_path'
+      }
+    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
+      {
+        :'candidates' => :'Array<SfvbTemplateResolveCandidate>',
+        :'directory_found' => :'Boolean',
+        :'match' => :'String',
+        :'resource_path' => :'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::SfvbTemplateResolvePath` 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::SfvbTemplateResolvePath`. 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?(:'candidates')
+        if (value = attributes[:'candidates']).is_a?(Array)
+          self.candidates = value
+        end
+      end
+
+      if attributes.key?(:'directory_found')
+        self.directory_found = attributes[:'directory_found']
+      end
+
+      if attributes.key?(:'match')
+        self.match = attributes[:'match']
+      end
+
+      if attributes.key?(:'resource_path')
+        self.resource_path = attributes[:'resource_path']
+      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 &&
+          candidates == o.candidates &&
+          directory_found == o.directory_found &&
+          match == o.match &&
+          resource_path == o.resource_path
+    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
+      [candidates, directory_found, match, resource_path].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_template_resolve_response.rb

@@ -0,0 +1,282 @@
+=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 SfvbTemplateResolveResponse
+    # Whether resolved_path is a file.  False means a page naming this template cannot render.
+    attr_accessor :exists
+
+    # True when no resource path held the name, so the storefront fell back to the name at the theme root.
+    attr_accessor :fallback
+
+    # The template file name that was resolved, as a page's group_template or item_template holds it.
+    attr_accessor :name
+
+    # The file a page naming this template renders, relative to theme_path.  This is the storefront's own answer.
+    attr_accessor :resolved_path
+
+    # The theme's resource paths in search order, each with the files of that name found below it.  The first path with a match wins, which is how a theme copy overrides a shared core copy.
+    attr_accessor :resource_paths
+
+    # The theme the name was resolved in.
+    attr_accessor :theme_oid
+
+    # The theme's path in the file manager, such as /themes/Elements/.
+    attr_accessor :theme_path
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'exists' => :'exists',
+        :'fallback' => :'fallback',
+        :'name' => :'name',
+        :'resolved_path' => :'resolved_path',
+        :'resource_paths' => :'resource_paths',
+        :'theme_oid' => :'theme_oid',
+        :'theme_path' => :'theme_path'
+      }
+    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
+      {
+        :'exists' => :'Boolean',
+        :'fallback' => :'Boolean',
+        :'name' => :'String',
+        :'resolved_path' => :'String',
+        :'resource_paths' => :'Array<SfvbTemplateResolvePath>',
+        :'theme_oid' => :'Integer',
+        :'theme_path' => :'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::SfvbTemplateResolveResponse` 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::SfvbTemplateResolveResponse`. 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?(:'exists')
+        self.exists = attributes[:'exists']
+      end
+
+      if attributes.key?(:'fallback')
+        self.fallback = attributes[:'fallback']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'resolved_path')
+        self.resolved_path = attributes[:'resolved_path']
+      end
+
+      if attributes.key?(:'resource_paths')
+        if (value = attributes[:'resource_paths']).is_a?(Array)
+          self.resource_paths = value
+        end
+      end
+
+      if attributes.key?(:'theme_oid')
+        self.theme_oid = attributes[:'theme_oid']
+      end
+
+      if attributes.key?(:'theme_path')
+        self.theme_path = attributes[:'theme_path']
+      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 &&
+          exists == o.exists &&
+          fallback == o.fallback &&
+          name == o.name &&
+          resolved_path == o.resolved_path &&
+          resource_paths == o.resource_paths &&
+          theme_oid == o.theme_oid &&
+          theme_path == o.theme_path
+    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
+      [exists, fallback, name, resolved_path, resource_paths, theme_oid, theme_path].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.173'
+  VERSION = '4.1.175'
 end

data/lib/ultracart_api.rb

@@ -1049,6 +1049,8 @@ require 'ultracart_api/models/sfvb_page_items_response'
 require 'ultracart_api/models/sfvb_page_list_response'
 require 'ultracart_api/models/sfvb_page_multimedia'
 require 'ultracart_api/models/sfvb_page_multimedia_request'
+require 'ultracart_api/models/sfvb_page_refresh_request'
+require 'ultracart_api/models/sfvb_page_refresh_response'
 require 'ultracart_api/models/sfvb_page_response'
 require 'ultracart_api/models/sfvb_page_selectors'
 require 'ultracart_api/models/sfvb_page_settings_request'
@@ -1067,6 +1069,9 @@ require 'ultracart_api/models/sfvb_site_attributes_response'
 require 'ultracart_api/models/sfvb_storefront'
 require 'ultracart_api/models/sfvb_storefronts_response'
 require 'ultracart_api/models/sfvb_template'
+require 'ultracart_api/models/sfvb_template_resolve_candidate'
+require 'ultracart_api/models/sfvb_template_resolve_path'
+require 'ultracart_api/models/sfvb_template_resolve_response'
 require 'ultracart_api/models/sfvb_templates_response'
 require 'ultracart_api/models/sfvb_theme'
 require 'ultracart_api/models/sfvb_theme_attribute'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.173
+  version: 4.1.175
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-24 00:00:00.000000000 Z
+date: 2026-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1111,6 +1111,8 @@ files:
 - docs/SfvbPageListResponse.md
 - docs/SfvbPageMultimedia.md
 - docs/SfvbPageMultimediaRequest.md
+- docs/SfvbPageRefreshRequest.md
+- docs/SfvbPageRefreshResponse.md
 - docs/SfvbPageResponse.md
 - docs/SfvbPageSelectors.md
 - docs/SfvbPageSettingsRequest.md
@@ -1129,6 +1131,9 @@ files:
 - docs/SfvbStorefront.md
 - docs/SfvbStorefrontsResponse.md
 - docs/SfvbTemplate.md
+- docs/SfvbTemplateResolveCandidate.md
+- docs/SfvbTemplateResolvePath.md
+- docs/SfvbTemplateResolveResponse.md
 - docs/SfvbTemplatesResponse.md
 - docs/SfvbTheme.md
 - docs/SfvbThemeAttribute.md
@@ -2314,6 +2319,8 @@ files:
 - lib/ultracart_api/models/sfvb_page_list_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
+- lib/ultracart_api/models/sfvb_page_refresh_response.rb
 - lib/ultracart_api/models/sfvb_page_response.rb
 - lib/ultracart_api/models/sfvb_page_selectors.rb
 - lib/ultracart_api/models/sfvb_page_settings_request.rb
@@ -2332,6 +2339,9 @@ files:
 - lib/ultracart_api/models/sfvb_storefront.rb
 - lib/ultracart_api/models/sfvb_storefronts_response.rb
 - lib/ultracart_api/models/sfvb_template.rb
+- lib/ultracart_api/models/sfvb_template_resolve_candidate.rb
+- lib/ultracart_api/models/sfvb_template_resolve_path.rb
+- lib/ultracart_api/models/sfvb_template_resolve_response.rb
 - lib/ultracart_api/models/sfvb_templates_response.rb
 - lib/ultracart_api/models/sfvb_theme.rb
 - lib/ultracart_api/models/sfvb_theme_attribute.rb