ultracart_api 4.1.156 → 4.1.157

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb86992bc479fd054fc72958e6622d59bd4cb72f2dbb13f7db9e69ef2517e0e
-  data.tar.gz: bf9953831d56669b3c62cf555be9631ec74e78bae97a83e0cbc5f67397ac8d1c
+  metadata.gz: 9a92c02a477046100fa9bb81d90ce5912f2ef0f1f48683b51c98e34c1df71287
+  data.tar.gz: 9496625114b7bba219bc0198c389e5b84afcf52bb55704570f77db6122d24d36
 SHA512:
-  metadata.gz: d28e46f9455289b3b14ae48c7a4dbe5494208704671bbd17fd9ebf11c2a31ca18ce8d2249967b0c9ee9aa4411d30eecf5e8bcd2209f0bac4a27dd808d30be23c
-  data.tar.gz: 5292805e1e2d9213267e48623ed2fdba79e332dfcfd3b9cf7ab91b082b8f6f7cdd4bb167d8becfc655499b84c857a40f48aa7467cb07f2a77cd9bb73293d4484
+  metadata.gz: fe801ea021b22c5d654b7f6e6ea21842c89a103d8923bb1ab65d33d14bfa4a03e105b34f4291734165736aa8ae14c9728e42d60aab45b0542b2319bb489adb32
+  data.tar.gz: cf281a37520c9c3885190f30e9c31e6367fa04e8c67512b413d81b3b3cb1c99bae3d12174bb4ffbad79a7ed84b8a8a0ee0bb4961addfdc3e8c7b9c1ddedab73c

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.156
+- Package version: 4.1.157
 - 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.156'
+gem 'ultracart_api', '4.1.157'
 ```
 
 install:
@@ -1962,6 +1962,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.157 | 09/18/2026 | sfvb internal testing |
 | 4.1.156 | 09/16/2026 | sfvb internal testing |
 | 4.1.155 | 09/15/2026 | sfvb internal testing |
 | 4.1.154 | 09/14/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -545,7 +545,7 @@ end
 
 Read a container stored outside the file system
 
-owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
+owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
 
 
 ### Examples
@@ -601,7 +601,7 @@ end
 
 Read the CJSON stored in one container history entry
 
-Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. 
+Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id. 
 
 
 ### Examples
@@ -1406,6 +1406,8 @@ end
 
 Version history for a container stored outside the file system
 
+Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names. 
+
 
 ### Examples
 
@@ -1777,7 +1779,7 @@ end
 
 Write a container stored outside the file system
 
-Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. 
+Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other. 
 
 
 ### Examples
@@ -2277,7 +2279,7 @@ end
 
 Revert a container stored outside the file system
 
-The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. 
+The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round. 
 
 
 ### Examples

data/docs/SfvbContainerResponse.md

@@ -8,6 +8,7 @@
 | **container_name** | **String** | Container name. | [optional] |
 | **hash_sha256** | **String** | SHA-256 of the cjson.  Send back as If-Match when writing. | [optional] |
 | **last_modified** | **String** | When the container was last modified, in the store's own record of it.  Every owner type reports this.  It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified.  Two behaviours worth knowing.  A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.  An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer. | [optional] |
+| **merchant_item_id** | **String** | The merchant item id of the owning item, for item containers only and absent for every other owner type.  owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached.  It is read fresh on every call and so reflects a renamed item.  A container's own id embeds this value, which is what a preview session keys an item container on. | [optional] |
 | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
 | **owner_type** | **String** | Where this container lives. | [optional] |
 
@@ -21,6 +22,7 @@ instance = UltracartClient::SfvbContainerResponse.new(
   container_name: null,
   hash_sha256: null,
   last_modified: null,
+  merchant_item_id: null,
   owner_object_id: null,
   owner_type: null
 )

data/lib/ultracart_api/api/sfvb_api.rb

@@ -673,7 +673,7 @@ module UltracartClient
     end
 
     # Read a container stored outside the file system
-    # owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
+    # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 
@@ -686,7 +686,7 @@ module UltracartClient
     end
 
     # Read a container stored outside the file system
-    # owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
+    # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 
@@ -752,7 +752,7 @@ module UltracartClient
     end
 
     # Read the CJSON stored in one container history entry
-    # Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. 
+    # Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id. 
     # @param storefront_oid [Integer] 
     # @param container_history_oid [Integer] 
     # @param [Hash] opts the optional parameters
@@ -766,7 +766,7 @@ module UltracartClient
     end
 
     # Read the CJSON stored in one container history entry
-    # Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. 
+    # Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id. 
     # @param storefront_oid [Integer] 
     # @param container_history_oid [Integer] 
     # @param [Hash] opts the optional parameters
@@ -1777,6 +1777,7 @@ module UltracartClient
     end
 
     # Version history for a container stored outside the file system
+    # Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names. 
     # @param storefront_oid [Integer] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :owner_type 
@@ -1789,6 +1790,7 @@ module UltracartClient
     end
 
     # Version history for a container stored outside the file system
+    # Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names. 
     # @param storefront_oid [Integer] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :owner_type 
@@ -2233,7 +2235,7 @@ module UltracartClient
     end
 
     # Write a container stored outside the file system
-    # Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. 
+    # Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 
@@ -2248,7 +2250,7 @@ module UltracartClient
     end
 
     # Write a container stored outside the file system
-    # Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. 
+    # Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 
@@ -2976,7 +2978,7 @@ module UltracartClient
     end
 
     # Revert a container stored outside the file system
-    # The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. 
+    # The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 
@@ -2991,7 +2993,7 @@ module UltracartClient
     end
 
     # Revert a container stored outside the file system
-    # The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. 
+    # The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round. 
     # @param storefront_oid [Integer] 
     # @param owner_type [String] 
     # @param owner_object_id [String] 

data/lib/ultracart_api/models/sfvb_container_response.rb

@@ -27,6 +27,9 @@ module UltracartClient
     # When the container was last modified, in the store's own record of it.  Every owner type reports this.  It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified.  Two behaviours worth knowing.  A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.  An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer.
     attr_accessor :last_modified
 
+    # The merchant item id of the owning item, for item containers only and absent for every other owner type.  owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached.  It is read fresh on every call and so reflects a renamed item.  A container's own id embeds this value, which is what a preview session keys an item container on.
+    attr_accessor :merchant_item_id
+
     # Identifier of the owning object within its store.
     attr_accessor :owner_object_id
 
@@ -62,6 +65,7 @@ module UltracartClient
         :'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'
       }
@@ -79,6 +83,7 @@ module UltracartClient
         :'container_name' => :'String',
         :'hash_sha256' => :'String',
         :'last_modified' => :'String',
+        :'merchant_item_id' => :'String',
         :'owner_object_id' => :'String',
         :'owner_type' => :'String'
       }
@@ -121,6 +126,10 @@ module UltracartClient
         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
@@ -164,6 +173,7 @@ module UltracartClient
           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
     end
@@ -177,7 +187,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cjson, container_name, hash_sha256, last_modified, owner_object_id, owner_type].hash
+      [cjson, container_name, hash_sha256, last_modified, merchant_item_id, owner_object_id, owner_type].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.156'
+  VERSION = '4.1.157'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.156
+  version: 4.1.157
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-16 00:00:00.000000000 Z
+date: 2026-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus