ultracart_api 4.1.154 → 4.1.156

data/lib/ultracart_api/models/sfvb_preview_access_response.rb

@@ -0,0 +1,290 @@
+=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 SfvbPreviewAccessResponse
+    # One time link on the storefront's own host.  Opening it in any browser, including an agent's built in browser with no UltraCart login, gets past the storefront lock and applies the preview session and theme for the rest of that browser's session, then redirects to path.  It is a credential until used, so do not paste it anywhere other than the browser that should open it.
+    attr_accessor :access_url
+
+    # Seconds left to open access_url.  It stops working after that, and after its first use.
+    attr_accessor :expires_in_seconds
+
+    # Storefront path the browser lands on, after reserved preview parameters are removed.
+    attr_accessor :path
+
+    # The preview session applied, when one was requested.
+    attr_accessor :preview_session_id
+
+    # How long the browser stays in preview once access_url is opened.  The remaining life of the preview session, or eight hours when none was given.  Ending the preview session ends preview in that browser at its next page.  The user and their storefront permission are checked again on every page, so removing either ends it sooner.
+    attr_accessor :session_lifetime_seconds
+
+    # Always true.  A second open of access_url returns 410.
+    attr_accessor :single_use
+
+    # The theme shown, when one was requested.
+    attr_accessor :theme_oid
+
+    # Plain language instructions, safe to show a user.
+    attr_accessor :usage_note
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'access_url' => :'access_url',
+        :'expires_in_seconds' => :'expires_in_seconds',
+        :'path' => :'path',
+        :'preview_session_id' => :'preview_session_id',
+        :'session_lifetime_seconds' => :'session_lifetime_seconds',
+        :'single_use' => :'single_use',
+        :'theme_oid' => :'theme_oid',
+        :'usage_note' => :'usage_note'
+      }
+    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
+      {
+        :'access_url' => :'String',
+        :'expires_in_seconds' => :'Integer',
+        :'path' => :'String',
+        :'preview_session_id' => :'String',
+        :'session_lifetime_seconds' => :'Integer',
+        :'single_use' => :'Boolean',
+        :'theme_oid' => :'Integer',
+        :'usage_note' => :'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::SfvbPreviewAccessResponse` 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::SfvbPreviewAccessResponse`. 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?(:'access_url')
+        self.access_url = attributes[:'access_url']
+      end
+
+      if attributes.key?(:'expires_in_seconds')
+        self.expires_in_seconds = attributes[:'expires_in_seconds']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'preview_session_id')
+        self.preview_session_id = attributes[:'preview_session_id']
+      end
+
+      if attributes.key?(:'session_lifetime_seconds')
+        self.session_lifetime_seconds = attributes[:'session_lifetime_seconds']
+      end
+
+      if attributes.key?(:'single_use')
+        self.single_use = attributes[:'single_use']
+      end
+
+      if attributes.key?(:'theme_oid')
+        self.theme_oid = attributes[:'theme_oid']
+      end
+
+      if attributes.key?(:'usage_note')
+        self.usage_note = attributes[:'usage_note']
+      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 &&
+          access_url == o.access_url &&
+          expires_in_seconds == o.expires_in_seconds &&
+          path == o.path &&
+          preview_session_id == o.preview_session_id &&
+          session_lifetime_seconds == o.session_lifetime_seconds &&
+          single_use == o.single_use &&
+          theme_oid == o.theme_oid &&
+          usage_note == o.usage_note
+    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
+      [access_url, expires_in_seconds, path, preview_session_id, session_lifetime_seconds, single_use, theme_oid, usage_note].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_version_response.rb

@@ -36,6 +36,12 @@ module UltracartClient
     # Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut.
     attr_accessor :max_library_results_per_page
 
+    # How deeply store menu entries can nest.
+    attr_accessor :max_menu_depth
+
+    # Most entries one store menu can hold, counting every level of the tree.  A menu is navigation that renders on every page, so this is deliberately far below what the storage would physically accept.
+    attr_accessor :max_menu_items
+
     # Largest payload one preview session may hold, in bytes.
     attr_accessor :max_preview_session_bytes
 
@@ -95,6 +101,8 @@ module UltracartClient
         :'max_cjson_bytes' => :'max_cjson_bytes',
         :'max_directory_entries' => :'max_directory_entries',
         :'max_library_results_per_page' => :'max_library_results_per_page',
+        :'max_menu_depth' => :'max_menu_depth',
+        :'max_menu_items' => :'max_menu_items',
         :'max_preview_session_bytes' => :'max_preview_session_bytes',
         :'max_revertable_bytes' => :'max_revertable_bytes',
         :'max_search_results' => :'max_search_results',
@@ -122,6 +130,8 @@ module UltracartClient
         :'max_cjson_bytes' => :'Integer',
         :'max_directory_entries' => :'Integer',
         :'max_library_results_per_page' => :'Integer',
+        :'max_menu_depth' => :'Integer',
+        :'max_menu_items' => :'Integer',
         :'max_preview_session_bytes' => :'Integer',
         :'max_revertable_bytes' => :'Integer',
         :'max_search_results' => :'Integer',
@@ -183,6 +193,14 @@ module UltracartClient
         self.max_library_results_per_page = attributes[:'max_library_results_per_page']
       end
 
+      if attributes.key?(:'max_menu_depth')
+        self.max_menu_depth = attributes[:'max_menu_depth']
+      end
+
+      if attributes.key?(:'max_menu_items')
+        self.max_menu_items = attributes[:'max_menu_items']
+      end
+
       if attributes.key?(:'max_preview_session_bytes')
         self.max_preview_session_bytes = attributes[:'max_preview_session_bytes']
       end
@@ -257,6 +275,8 @@ module UltracartClient
           max_cjson_bytes == o.max_cjson_bytes &&
           max_directory_entries == o.max_directory_entries &&
           max_library_results_per_page == o.max_library_results_per_page &&
+          max_menu_depth == o.max_menu_depth &&
+          max_menu_items == o.max_menu_items &&
           max_preview_session_bytes == o.max_preview_session_bytes &&
           max_revertable_bytes == o.max_revertable_bytes &&
           max_search_results == o.max_search_results &&
@@ -277,7 +297,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [container_manager_version, container_versions_retained, element_count, max_asset_bytes, max_cjson_bytes, max_directory_entries, max_library_results_per_page, max_preview_session_bytes, max_revertable_bytes, max_search_results, max_template_bytes, max_text_read_bytes, max_video_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
+      [container_manager_version, container_versions_retained, element_count, max_asset_bytes, max_cjson_bytes, max_directory_entries, max_library_results_per_page, max_menu_depth, max_menu_items, max_preview_session_bytes, max_revertable_bytes, max_search_results, max_template_bytes, max_text_read_bytes, max_video_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -1004,12 +1004,18 @@ require 'ultracart_api/models/sfvb_files_response'
 require 'ultracart_api/models/sfvb_library_entry'
 require 'ultracart_api/models/sfvb_library_facet'
 require 'ultracart_api/models/sfvb_library_response'
+require 'ultracart_api/models/sfvb_menu'
+require 'ultracart_api/models/sfvb_menu_item'
+require 'ultracart_api/models/sfvb_menu_write_request'
+require 'ultracart_api/models/sfvb_menus_response'
 require 'ultracart_api/models/sfvb_page_attribute'
 require 'ultracart_api/models/sfvb_page_attribute_update'
 require 'ultracart_api/models/sfvb_page_attribute_update_request'
 require 'ultracart_api/models/sfvb_page_multimedia'
 require 'ultracart_api/models/sfvb_page_multimedia_request'
 require 'ultracart_api/models/sfvb_page_response'
+require 'ultracart_api/models/sfvb_preview_access_request'
+require 'ultracart_api/models/sfvb_preview_access_response'
 require 'ultracart_api/models/sfvb_preview_session_request'
 require 'ultracart_api/models/sfvb_preview_session_response'
 require 'ultracart_api/models/sfvb_preview_url_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.154
+  version: 4.1.156
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-14 00:00:00.000000000 Z
+date: 2026-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1066,12 +1066,18 @@ files:
 - docs/SfvbLibraryEntry.md
 - docs/SfvbLibraryFacet.md
 - docs/SfvbLibraryResponse.md
+- docs/SfvbMenu.md
+- docs/SfvbMenuItem.md
+- docs/SfvbMenuWriteRequest.md
+- docs/SfvbMenusResponse.md
 - docs/SfvbPageAttribute.md
 - docs/SfvbPageAttributeUpdate.md
 - docs/SfvbPageAttributeUpdateRequest.md
 - docs/SfvbPageMultimedia.md
 - docs/SfvbPageMultimediaRequest.md
 - docs/SfvbPageResponse.md
+- docs/SfvbPreviewAccessRequest.md
+- docs/SfvbPreviewAccessResponse.md
 - docs/SfvbPreviewSessionRequest.md
 - docs/SfvbPreviewSessionResponse.md
 - docs/SfvbPreviewUrlResponse.md
@@ -2207,12 +2213,18 @@ files:
 - lib/ultracart_api/models/sfvb_library_entry.rb
 - lib/ultracart_api/models/sfvb_library_facet.rb
 - lib/ultracart_api/models/sfvb_library_response.rb
+- lib/ultracart_api/models/sfvb_menu.rb
+- lib/ultracart_api/models/sfvb_menu_item.rb
+- lib/ultracart_api/models/sfvb_menu_write_request.rb
+- lib/ultracart_api/models/sfvb_menus_response.rb
 - lib/ultracart_api/models/sfvb_page_attribute.rb
 - lib/ultracart_api/models/sfvb_page_attribute_update.rb
 - lib/ultracart_api/models/sfvb_page_attribute_update_request.rb
 - lib/ultracart_api/models/sfvb_page_multimedia.rb
 - lib/ultracart_api/models/sfvb_page_multimedia_request.rb
 - lib/ultracart_api/models/sfvb_page_response.rb
+- lib/ultracart_api/models/sfvb_preview_access_request.rb
+- lib/ultracart_api/models/sfvb_preview_access_response.rb
 - lib/ultracart_api/models/sfvb_preview_session_request.rb
 - lib/ultracart_api/models/sfvb_preview_session_response.rb
 - lib/ultracart_api/models/sfvb_preview_url_response.rb