ultracart_api 4.1.154 → 4.1.155

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ac39f21f4d4926dc445c05679cf88a52c25751ae967e68d2a04ce2db104c86
-  data.tar.gz: 97a320a75abbf442e767bbc17d549e1f980687e2db385229f6d75dbe11d4482c
+  metadata.gz: 24314cf0f18fc69b1c86c36bf3286ae46d625958a18800271a20d225ec797a9c
+  data.tar.gz: 03da8af5d356bdbe3d03ca56057f38a03deff2b2fe2a9cbe038666eb6a0cee54
 SHA512:
-  metadata.gz: de44ec246f9b2af49724ae1bb120ce8d2b79a9a68db06e98ffb734fa51c7bc9599f57f2232d63f5a7eae3ad174af5523fd46d6ef0a14c303f00b114a5136dfdf
-  data.tar.gz: 0f6a6d5026cd0175acb8da55d748ce4d0a6f6f1ae4ca5ec12052d477e994ef633fbc6d94da1faf3abdd6133df8577d372b79c405f3d75fa023d34a166282b8e6
+  metadata.gz: 2a3f15bff02873f539363351665d678ee06534356f44851f5415ac69c71212c2a15f71a4715d540d5894311392183c2ad2b10d0dcb2ebbb7e50d941ae74f7491
+  data.tar.gz: f081572ef243c7c9690a7bc235763ae4249dc602005d36000326ff24d184ee7cda5e52f35297326149c3c951484e317ed2cdd52b4a60d86e63d2b9ccb39d5ce4

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.154
+- Package version: 4.1.155
 - 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.154'
+gem 'ultracart_api', '4.1.155'
 ```
 
 install:
@@ -473,6 +473,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
 *UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
 *UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
+*UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
 *UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
 *UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
 *UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
@@ -1764,6 +1765,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
  - [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
  - [UltracartClient::SfvbPageResponse](docs/SfvbPageResponse.md)
+ - [UltracartClient::SfvbPreviewAccessRequest](docs/SfvbPreviewAccessRequest.md)
+ - [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
  - [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
@@ -1952,6 +1955,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.155 | 09/15/2026 | sfvb internal testing |
 | 4.1.154 | 09/14/2026 | sfvb internal testing |
 | 4.1.153 | 09/14/2026 | sfvb internal testing |
 | 4.1.152 | 09/09/2026 | sfvb - internal testing |

data/docs/SfvbApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
+| [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
 | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
 | [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
 | [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
@@ -103,6 +104,60 @@ end
 - **Accept**: application/json
 
 
+## create_sfvb_preview_access
+
+> <SfvbPreviewAccessResponse> create_sfvb_preview_access(storefront_oid, opts)
+
+One time link that opens a preview in a browser with no UltraCart login
+
+The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the create_sfvb_preview_access_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPreviewAccessResponse>, Integer, Hash)> create_sfvb_preview_access_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # One time link that opens a preview in a browser with no UltraCart login
+  data, status_code, headers = api_instance.create_sfvb_preview_access_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPreviewAccessResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->create_sfvb_preview_access_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **preview_access** | [**SfvbPreviewAccessRequest**](SfvbPreviewAccessRequest.md) | What the browser should see | [optional] |
+
+### Return type
+
+[**SfvbPreviewAccessResponse**](SfvbPreviewAccessResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_sfvb_preview_session
 
 > <SfvbPreviewSessionResponse> create_sfvb_preview_session(storefront_oid)

data/docs/SfvbPreviewAccessRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbPreviewAccessRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** | Storefront path to land on, beginning with a slash.  Defaults to / | [optional] |
+| **preview_session_id** | **String** | Staged preview session to show.  It must be one this user created and it must not have expired.  Leave it out to show the saved containers with nothing staged. | [optional] |
+| **theme_oid** | **Integer** | Theme to show, which may be inactive.  Must belong to this storefront.  Defaults to the active theme. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPreviewAccessRequest.new(
+  path: null,
+  preview_session_id: null,
+  theme_oid: null
+)
+```
+

data/docs/SfvbPreviewAccessResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbPreviewAccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_url** | **String** | 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. | [optional] |
+| **expires_in_seconds** | **Integer** | Seconds left to open access_url.  It stops working after that, and after its first use. | [optional] |
+| **path** | **String** | Storefront path the browser lands on, after reserved preview parameters are removed. | [optional] |
+| **preview_session_id** | **String** | The preview session applied, when one was requested. | [optional] |
+| **session_lifetime_seconds** | **Integer** | 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.  The user and their storefront permission are checked again on every page, so removing either ends it sooner. | [optional] |
+| **single_use** | **Boolean** | Always true.  A second open of access_url returns 410. | [optional] |
+| **theme_oid** | **Integer** | The theme shown, when one was requested. | [optional] |
+| **usage_note** | **String** | Plain language instructions, safe to show a user. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPreviewAccessResponse.new(
+  access_url: null,
+  expires_in_seconds: null,
+  path: null,
+  preview_session_id: null,
+  session_lifetime_seconds: null,
+  single_use: null,
+  theme_oid: null,
+  usage_note: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -101,6 +101,77 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # One time link that opens a preview in a browser with no UltraCart login
+    # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SfvbPreviewAccessRequest] :preview_access What the browser should see
+    # @return [SfvbPreviewAccessResponse]
+    def create_sfvb_preview_access(storefront_oid, opts = {})
+      data, _status_code, _headers = create_sfvb_preview_access_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # One time link that opens a preview in a browser with no UltraCart login
+    # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SfvbPreviewAccessRequest] :preview_access What the browser should see
+    # @return [Array<(SfvbPreviewAccessResponse, Integer, Hash)>] SfvbPreviewAccessResponse data, response status code and response headers
+    def create_sfvb_preview_access_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.create_sfvb_preview_access ...'
+      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.create_sfvb_preview_access"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/preview_access'.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'])
+      # 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[:'preview_access'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbPreviewAccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.create_sfvb_preview_access",
+        :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: SfvbApi#create_sfvb_preview_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a preview session
     # Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor's habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_preview_access_request.rb

@@ -0,0 +1,240 @@
+=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 SfvbPreviewAccessRequest
+    # Storefront path to land on, beginning with a slash.  Defaults to /
+    attr_accessor :path
+
+    # Staged preview session to show.  It must be one this user created and it must not have expired.  Leave it out to show the saved containers with nothing staged.
+    attr_accessor :preview_session_id
+
+    # Theme to show, which may be inactive.  Must belong to this storefront.  Defaults to the active theme.
+    attr_accessor :theme_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'path' => :'path',
+        :'preview_session_id' => :'preview_session_id',
+        :'theme_oid' => :'theme_oid'
+      }
+    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
+      {
+        :'path' => :'String',
+        :'preview_session_id' => :'String',
+        :'theme_oid' => :'Integer'
+      }
+    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::SfvbPreviewAccessRequest` 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::SfvbPreviewAccessRequest`. 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?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'preview_session_id')
+        self.preview_session_id = attributes[:'preview_session_id']
+      end
+
+      if attributes.key?(:'theme_oid')
+        self.theme_oid = attributes[:'theme_oid']
+      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 &&
+          path == o.path &&
+          preview_session_id == o.preview_session_id &&
+          theme_oid == o.theme_oid
+    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
+      [path, preview_session_id, theme_oid].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_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.  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/version.rb

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

data/lib/ultracart_api.rb

@@ -1010,6 +1010,8 @@ 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.155
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-14 00:00:00.000000000 Z
+date: 2026-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1072,6 +1072,8 @@ files:
 - docs/SfvbPageMultimedia.md
 - docs/SfvbPageMultimediaRequest.md
 - docs/SfvbPageResponse.md
+- docs/SfvbPreviewAccessRequest.md
+- docs/SfvbPreviewAccessResponse.md
 - docs/SfvbPreviewSessionRequest.md
 - docs/SfvbPreviewSessionResponse.md
 - docs/SfvbPreviewUrlResponse.md
@@ -2213,6 +2215,8 @@ files:
 - 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