ultracart_api 4.1.168 → 4.1.169

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f4754f78264cf68898eaf7dad3421dcbe656b37b7c4fd52d60854451eb2f58
-  data.tar.gz: 1fc1ed8254ed10d546cec9fa666d2354ab6cd13440420de25eb48f7188e4693e
+  metadata.gz: af4e728f4f35eebebe3e1901f0722a8e371817673158952eb269920182c15a10
+  data.tar.gz: 62de7b74a1febf6f41c62b59520379da2876bd5c1181e9dc50f9ba7bfc1e95f7
 SHA512:
-  metadata.gz: 6c8666281be3c9e01602e209fb58eb0e310e02a4e195e9a92fe03d03a91e26e35430b8c13081c005f75887cedf52d1ba02661db2889bb04c1148dfd1e518c931
-  data.tar.gz: b68167847cce043ede4207626630e8b4c8d7fcb75bb2c93a4eb044dc541b39ba48f9d4480dfe568a5ac2663637f40846ced659e877c3ce972556460e9c9b2196
+  metadata.gz: 2b1f7fa59aa0a039c1219e75ca3b8b42dd41a1fdfe297f7b6e09fd5b6c186fb0df83305d4405abf9bd41c5d3af490fd2ee8ed58122cc46a381ee1d8f4c0463fa
+  data.tar.gz: 855bfd76f0855e7989b52fa7a3b1e26c010cb54d55769f3127d3ffa280a1f8b5c7dd34c5fdddf4a24e038ab2d1d4a025f48ef79b1db45d9b1ec83b6e94b85cd2

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.168
+- Package version: 4.1.169
 - 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.168'
+gem 'ultracart_api', '4.1.169'
 ```
 
 install:
@@ -514,6 +514,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
 *UltracartClient::SfvbApi* | [**list_sfvb_file_versions**](docs/SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file
 *UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
+*UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
 *UltracartClient::SfvbApi* | [**list_sfvb_pages**](docs/SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages
 *UltracartClient::SfvbApi* | [**list_sfvb_storefronts**](docs/SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts
 *UltracartClient::SfvbApi* | [**list_sfvb_templates**](docs/SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates
@@ -1797,6 +1798,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
+ - [UltracartClient::SfvbItemContainer](docs/SfvbItemContainer.md)
+ - [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
  - [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
  - [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
  - [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
@@ -2022,6 +2025,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.169 | 09/22/2026 | sfvb builder |
 | 4.1.168 | 09/21/2026 | further automation testing |
 | 4.1.167 | 09/21/2026 | automation test |
 | 4.1.165 | 09/21/2026 | automation testing |

data/docs/SfvbApi.md

@@ -46,6 +46,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
 | [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
 | [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
+| [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
 | [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
 | [**list_sfvb_storefronts**](SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts |
 | [**list_sfvb_templates**](SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates |
@@ -2348,6 +2349,64 @@ end
 - **Accept**: application/json
 
 
+## list_sfvb_item_containers
+
+> <SfvbItemContainersResponse> list_sfvb_item_containers(storefront_oid, opts)
+
+List the item containers on the account
+
+An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller's storefront but does not narrow the result. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the list_sfvb_item_containers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbItemContainersResponse>, Integer, Hash)> list_sfvb_item_containers_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # List the item containers on the account
+  data, status_code, headers = api_instance.list_sfvb_item_containers_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbItemContainersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->list_sfvb_item_containers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **merchant_item_id** | **String** | Restrict to one item, by the merchant item id a storefront carries | [optional] |
+| **merchant_item_oid** | **Integer** | Restrict to one item, by oid.  Send this or merchant_item_id, not both | [optional] |
+| **container_name** | **String** | Restrict to one slot name, matched without regard to case | [optional] |
+| **max_results** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+[**SfvbItemContainersResponse**](SfvbItemContainersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_sfvb_pages
 
 > <SfvbPageListResponse> list_sfvb_pages(storefront_oid, opts)

data/docs/SfvbItemContainer.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbItemContainer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson_size** | **Integer** | Size of the CJSON in UTF-8 bytes, which is the same unit the container version size and the upsell offer cjson_size use. | [optional] |
+| **container_name** | **String** | The slot name.  This is the value an itemcontainer element's itemContainerName setting holds, which is what ties a container to the element that renders it. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of the container's CJSON.  Identical to the value a read of the container returns, so a listing is enough to start an If-Match write without reading first. | [optional] |
+| **last_modified** | **String** | When the container was last written.  Absent for a container untouched since the storage began recording the time, so read an absent value as unknown rather than as never modified. | [optional] |
+| **merchant_item_id** | **String** | The owning item's merchant item id.  This is the identifier a storefront carries and a merchant recognizes; the oid appears nowhere on a rendered page.  Send it as owner_type itemid to address the same container without converting it first. | [optional] |
+| **owner_object_id** | **String** | The merchant item oid, spelled the way containers/item/{owner_object_id} takes it. | [optional] |
+| **owner_type** | **String** | Always item.  Carried so a row is usable as an address without the caller having to know which listing it came from. | [optional] |
+| **used_elements** | **Array<String>** | The element types this container uses, recorded by the storage when it was written.  A large cjson_size beside a handful of element types is the signature of markup pasted into a single html element.  Absent on a container written before the storage began recording this. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemContainer.new(
+  cjson_size: null,
+  container_name: null,
+  hash_sha256: null,
+  last_modified: null,
+  merchant_item_id: null,
+  owner_object_id: null,
+  owner_type: null,
+  used_elements: null
+)
+```
+

data/docs/SfvbItemContainersResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbItemContainersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_containers** | [**Array<SfvbItemContainer>**](SfvbItemContainer.md) | The containers on this page, ordered by merchant item id then container name. | [optional] |
+| **max_results** | **Integer** | The cap that was applied. | [optional] |
+| **next_offset** | **Integer** | Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue. | [optional] |
+| **offset** | **Integer** | Containers skipped to produce this page. | [optional] |
+| **result_count** | **Integer** | Number of containers returned on this page. | [optional] |
+| **total_count** | **Integer** | Total containers matching the filter.  With container_name supplied this is the answer to how many items carry that slot. | [optional] |
+| **truncated** | **Boolean** | True when containers exist beyond this page.  next_offset is populated when it is. | [optional] |
+| **truncation_advice** | **String** | Advice for the caller when truncated is true. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemContainersResponse.new(
+  item_containers: null,
+  max_results: null,
+  next_offset: null,
+  offset: null,
+  result_count: null,
+  total_count: null,
+  truncated: null,
+  truncation_advice: null
+)
+```
+

data/lib/ultracart_api/api/sfvb_api.rb

@@ -3001,6 +3001,85 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # List the item containers on the account
+    # An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller's storefront but does not narrow the result. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :merchant_item_id Restrict to one item, by the merchant item id a storefront carries
+    # @option opts [Integer] :merchant_item_oid Restrict to one item, by oid.  Send this or merchant_item_id, not both
+    # @option opts [String] :container_name Restrict to one slot name, matched without regard to case
+    # @option opts [Integer] :max_results 
+    # @option opts [Integer] :offset 
+    # @return [SfvbItemContainersResponse]
+    def list_sfvb_item_containers(storefront_oid, opts = {})
+      data, _status_code, _headers = list_sfvb_item_containers_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # List the item containers on the account
+    # An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller's storefront but does not narrow the result. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :merchant_item_id Restrict to one item, by the merchant item id a storefront carries
+    # @option opts [Integer] :merchant_item_oid Restrict to one item, by oid.  Send this or merchant_item_id, not both
+    # @option opts [String] :container_name Restrict to one slot name, matched without regard to case
+    # @option opts [Integer] :max_results 
+    # @option opts [Integer] :offset 
+    # @return [Array<(SfvbItemContainersResponse, Integer, Hash)>] SfvbItemContainersResponse data, response status code and response headers
+    def list_sfvb_item_containers_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.list_sfvb_item_containers ...'
+      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.list_sfvb_item_containers"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/item_containers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
+      query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
+      query_params[:'container_name'] = opts[:'container_name'] if !opts[:'container_name'].nil?
+      query_params[:'max_results'] = opts[:'max_results'] if !opts[:'max_results'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbItemContainersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.list_sfvb_item_containers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#list_sfvb_item_containers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List the storefront's pages
     # Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_item_container.rb

@@ -0,0 +1,326 @@
+=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 SfvbItemContainer
+    # Size of the CJSON in UTF-8 bytes, which is the same unit the container version size and the upsell offer cjson_size use.
+    attr_accessor :cjson_size
+
+    # The slot name.  This is the value an itemcontainer element's itemContainerName setting holds, which is what ties a container to the element that renders it.
+    attr_accessor :container_name
+
+    # SHA-256 of the container's CJSON.  Identical to the value a read of the container returns, so a listing is enough to start an If-Match write without reading first.
+    attr_accessor :hash_sha256
+
+    # When the container was last written.  Absent for a container untouched since the storage began recording the time, so read an absent value as unknown rather than as never modified.
+    attr_accessor :last_modified
+
+    # The owning item's merchant item id.  This is the identifier a storefront carries and a merchant recognizes; the oid appears nowhere on a rendered page.  Send it as owner_type itemid to address the same container without converting it first.
+    attr_accessor :merchant_item_id
+
+    # The merchant item oid, spelled the way containers/item/{owner_object_id} takes it.
+    attr_accessor :owner_object_id
+
+    # Always item.  Carried so a row is usable as an address without the caller having to know which listing it came from.
+    attr_accessor :owner_type
+
+    # The element types this container uses, recorded by the storage when it was written.  A large cjson_size beside a handful of element types is the signature of markup pasted into a single html element.  Absent on a container written before the storage began recording this.
+    attr_accessor :used_elements
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cjson_size' => :'cjson_size',
+        :'container_name' => :'container_name',
+        :'hash_sha256' => :'hash_sha256',
+        :'last_modified' => :'last_modified',
+        :'merchant_item_id' => :'merchant_item_id',
+        :'owner_object_id' => :'owner_object_id',
+        :'owner_type' => :'owner_type',
+        :'used_elements' => :'used_elements'
+      }
+    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
+      {
+        :'cjson_size' => :'Integer',
+        :'container_name' => :'String',
+        :'hash_sha256' => :'String',
+        :'last_modified' => :'String',
+        :'merchant_item_id' => :'String',
+        :'owner_object_id' => :'String',
+        :'owner_type' => :'String',
+        :'used_elements' => :'Array<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::SfvbItemContainer` 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::SfvbItemContainer`. 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?(:'cjson_size')
+        self.cjson_size = attributes[:'cjson_size']
+      end
+
+      if attributes.key?(:'container_name')
+        self.container_name = attributes[:'container_name']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'last_modified')
+        self.last_modified = attributes[:'last_modified']
+      end
+
+      if attributes.key?(:'merchant_item_id')
+        self.merchant_item_id = attributes[:'merchant_item_id']
+      end
+
+      if attributes.key?(:'owner_object_id')
+        self.owner_object_id = attributes[:'owner_object_id']
+      end
+
+      if attributes.key?(:'owner_type')
+        self.owner_type = attributes[:'owner_type']
+      end
+
+      if attributes.key?(:'used_elements')
+        if (value = attributes[:'used_elements']).is_a?(Array)
+          self.used_elements = 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?
+      owner_type_validator = EnumAttributeValidator.new('String', ["item"])
+      return false unless owner_type_validator.valid?(@owner_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] owner_type Object to be assigned
+    def owner_type=(owner_type)
+      validator = EnumAttributeValidator.new('String', ["item"])
+      unless validator.valid?(owner_type)
+        fail ArgumentError, "invalid value for \"owner_type\", must be one of #{validator.allowable_values}."
+      end
+      @owner_type = owner_type
+    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 &&
+          cjson_size == o.cjson_size &&
+          container_name == o.container_name &&
+          hash_sha256 == o.hash_sha256 &&
+          last_modified == o.last_modified &&
+          merchant_item_id == o.merchant_item_id &&
+          owner_object_id == o.owner_object_id &&
+          owner_type == o.owner_type &&
+          used_elements == o.used_elements
+    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
+      [cjson_size, container_name, hash_sha256, last_modified, merchant_item_id, owner_object_id, owner_type, used_elements].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_item_containers_response.rb

@@ -0,0 +1,292 @@
+=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 SfvbItemContainersResponse
+    # The containers on this page, ordered by merchant item id then container name.
+    attr_accessor :item_containers
+
+    # The cap that was applied.
+    attr_accessor :max_results
+
+    # Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue.
+    attr_accessor :next_offset
+
+    # Containers skipped to produce this page.
+    attr_accessor :offset
+
+    # Number of containers returned on this page.
+    attr_accessor :result_count
+
+    # Total containers matching the filter.  With container_name supplied this is the answer to how many items carry that slot.
+    attr_accessor :total_count
+
+    # True when containers exist beyond this page.  next_offset is populated when it is.
+    attr_accessor :truncated
+
+    # Advice for the caller when truncated is true.
+    attr_accessor :truncation_advice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'item_containers' => :'item_containers',
+        :'max_results' => :'max_results',
+        :'next_offset' => :'next_offset',
+        :'offset' => :'offset',
+        :'result_count' => :'result_count',
+        :'total_count' => :'total_count',
+        :'truncated' => :'truncated',
+        :'truncation_advice' => :'truncation_advice'
+      }
+    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
+      {
+        :'item_containers' => :'Array<SfvbItemContainer>',
+        :'max_results' => :'Integer',
+        :'next_offset' => :'Integer',
+        :'offset' => :'Integer',
+        :'result_count' => :'Integer',
+        :'total_count' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'truncation_advice' => :'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::SfvbItemContainersResponse` 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::SfvbItemContainersResponse`. 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?(:'item_containers')
+        if (value = attributes[:'item_containers']).is_a?(Array)
+          self.item_containers = value
+        end
+      end
+
+      if attributes.key?(:'max_results')
+        self.max_results = attributes[:'max_results']
+      end
+
+      if attributes.key?(:'next_offset')
+        self.next_offset = attributes[:'next_offset']
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.key?(:'result_count')
+        self.result_count = attributes[:'result_count']
+      end
+
+      if attributes.key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'truncation_advice')
+        self.truncation_advice = attributes[:'truncation_advice']
+      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 &&
+          item_containers == o.item_containers &&
+          max_results == o.max_results &&
+          next_offset == o.next_offset &&
+          offset == o.offset &&
+          result_count == o.result_count &&
+          total_count == o.total_count &&
+          truncated == o.truncated &&
+          truncation_advice == o.truncation_advice
+    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
+      [item_containers, max_results, next_offset, offset, result_count, total_count, truncated, truncation_advice].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.168'
+  VERSION = '4.1.169'
 end

data/lib/ultracart_api.rb

@@ -1015,6 +1015,8 @@ require 'ultracart_api/models/sfvb_file_versions_response'
 require 'ultracart_api/models/sfvb_file_write_request'
 require 'ultracart_api/models/sfvb_file_write_response'
 require 'ultracart_api/models/sfvb_files_response'
+require 'ultracart_api/models/sfvb_item_container'
+require 'ultracart_api/models/sfvb_item_containers_response'
 require 'ultracart_api/models/sfvb_library_entry'
 require 'ultracart_api/models/sfvb_library_facet'
 require 'ultracart_api/models/sfvb_library_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.168
+  version: 4.1.169
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-21 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1077,6 +1077,8 @@ files:
 - docs/SfvbFileWriteRequest.md
 - docs/SfvbFileWriteResponse.md
 - docs/SfvbFilesResponse.md
+- docs/SfvbItemContainer.md
+- docs/SfvbItemContainersResponse.md
 - docs/SfvbLibraryEntry.md
 - docs/SfvbLibraryFacet.md
 - docs/SfvbLibraryResponse.md
@@ -2258,6 +2260,8 @@ files:
 - lib/ultracart_api/models/sfvb_file_write_request.rb
 - lib/ultracart_api/models/sfvb_file_write_response.rb
 - lib/ultracart_api/models/sfvb_files_response.rb
+- lib/ultracart_api/models/sfvb_item_container.rb
+- lib/ultracart_api/models/sfvb_item_containers_response.rb
 - lib/ultracart_api/models/sfvb_library_entry.rb
 - lib/ultracart_api/models/sfvb_library_facet.rb
 - lib/ultracart_api/models/sfvb_library_response.rb