ultracart_api 4.1.146 → 4.1.147

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '036368fdee38b26ea356d002fd6d655ea9f4759ed13b01d66fd7b99737452573'
-  data.tar.gz: e5ee50e86b0e48f43fe29c513f6d90f0fc8c0de9d2b97f46ca3686a90cf46a2c
+  metadata.gz: 490ac8086f81d0ada26de478aa8456404659ba28b4589f778117e1aeab05d043
+  data.tar.gz: c3df95b939b310dbd25c9b24e02c2004c2a540787506fb01f49c4b2413c08b37
 SHA512:
-  metadata.gz: 35da706c21aea107d4af2816c082c18c9dcf0198fc776d6b8a2318cbdcb9ec849b5440fd9b8e284680e58c814ded1754288b4234eef3323f9786512097d06723
-  data.tar.gz: 34ac9ffd5893e93a84f325120c40e03a5e2e0a64fd2195cae5af3aabfb353b21af54c2c9f73e4d906d5af361822f35482e6971f0c041c3889a51d5be20f3b91a
+  metadata.gz: 4115a13993932d0c78cc857bc053e96586797d97dc8b7a22e860f889ea0f33acd854f07d6c08994bf0b37b8c3f47d2852348bb684fd67ef427222538d6a2547b
+  data.tar.gz: a7022fa9cf5acd43820c5383d55559046f586440d728b496da373d4c508f9f626a1e689084c1935b405014dbee3306eee752c7d2ac66d89cbbe99797287ef5b4

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.146
+- Package version: 4.1.147
 - 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.146'
+gem 'ultracart_api', '4.1.147'
 ```
 
 install:
@@ -1927,6 +1927,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.147 | 09/04/2026 | sfvb - internal testing |
 | 4.1.146 | 09/03/2026 | sfvb - internal testing |
 | 4.1.145 | 09/02/2026 | sfvb - internal testing |
 | 4.1.144 | 09/02/2026 | sfvb - internal testing |

data/docs/SfvbApi.md

@@ -103,7 +103,7 @@ end
 
 Create a preview session
 
-Returns a server generated session id to push containers into.  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. 
+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. 
 
 
 ### Examples
@@ -1554,7 +1554,7 @@ end
 
 Push containers into a preview session
 
-Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
 
 
 ### Examples

data/docs/SfvbContainerResponse.md

@@ -7,7 +7,7 @@
 | **cjson** | **String** | The container JSON.  Runtime state is stripped on the way out. | [optional] |
 | **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.  Present for email, postcardfront and postcardback.  Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container.  Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports. | [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] |
 | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
 | **owner_type** | **String** | Where this container lives. | [optional] |
 

data/docs/SfvbThemeDuplicateRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **folder** | **String** | Directory name for the new theme under /themes/.  Letters and numbers; it is cleansed before use.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
+| **folder** | **String** | Directory name for the new theme under /themes/.  Letters and numbers, one path segment.  Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
 | **target_storefront_oid** | **Integer** | Storefront to create the copy on.  Defaults to the storefront in the path.  Supply it only when copying a theme between storefronts you own. | [optional] |
 | **theme_name** | **String** | Name for the new theme. | [optional] |
 

data/docs/SfvbThemeJobResponse.md

@@ -15,7 +15,7 @@
 | **status** | **String** | Raw job status. | [optional] |
 | **submitted_dts** | **String** | When the job was queued. | [optional] |
 | **success** | **Boolean** | True only when the job finished successfully.  Check complete first. | [optional] |
-| **target_path** | **String** | Path the new theme was created at.  Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result.  Once the job completes, list themes and match on this path. | [optional] |
+| **target_path** | **String** | Path the new theme is being created at.  Returned when the job is started and on every poll, so you do not have to keep the response that started it.  The theme oid itself is NOT returned, so once the job completes you list themes and match on this path.  It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending. | [optional] |
 
 ## Example
 

data/docs/SfvbVersionResponse.md

@@ -7,10 +7,16 @@
 | **container_manager_version** | **String** | Container manager version used to compile for this merchant. | [optional] |
 | **container_versions_retained** | **Integer** | Versions kept per non-file container before the oldest are pruned.  Beyond this, history is gone - not merely paginated. | [optional] |
 | **element_count** | **Integer** | Number of element types this version recognizes. | [optional] |
+| **max_asset_bytes** | **Integer** | Largest binary asset that can be uploaded, in bytes, for every accepted type except video. | [optional] |
 | **max_cjson_bytes** | **Integer** | Largest CJSON document that will be parsed, in bytes. | [optional] |
+| **max_directory_entries** | **Integer** | Most entries one directory listing returns.  Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for.  The listing does set a truncated flag when it drops entries. | [optional] |
+| **max_library_results_per_page** | **Integer** | Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut. | [optional] |
 | **max_preview_session_bytes** | **Integer** | Largest payload one preview session may hold, in bytes. | [optional] |
+| **max_revertable_bytes** | **Integer** | Largest historical version files/revert will restore, in bytes.  Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to. | [optional] |
 | **max_search_results** | **Integer** | Hard ceiling on file search results per page. | [optional] |
-| **max_template_bytes** | **Integer** | Largest template file that can be written, in bytes. | [optional] |
+| **max_template_bytes** | **Integer** | Largest .vm template that can be written, in bytes.  Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back.  Use max_text_read_bytes for that. | [optional] |
+| **max_text_read_bytes** | **Integer** | Largest file files/content will return as text, in bytes.  A file above this is refused with sfvb.too_large however small its history versions are.  Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template.  Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling. | [optional] |
+| **max_video_bytes** | **Integer** | Largest video that can be uploaded, in bytes.  Video is the one type allowed past max_asset_bytes. | [optional] |
 | **max_widget_ids_per_request** | **Integer** | Most widget ids that can be reserved in one call. | [optional] |
 | **preview_session_ttl_seconds** | **Integer** | Seconds a preview session survives before expiring. | [optional] |
 | **release** | **String** | Release channel selected for this merchant. | [optional] |
@@ -24,10 +30,16 @@ instance = UltracartClient::SfvbVersionResponse.new(
   container_manager_version: null,
   container_versions_retained: null,
   element_count: null,
+  max_asset_bytes: null,
   max_cjson_bytes: null,
+  max_directory_entries: null,
+  max_library_results_per_page: null,
   max_preview_session_bytes: null,
+  max_revertable_bytes: null,
   max_search_results: null,
   max_template_bytes: null,
+  max_text_read_bytes: null,
+  max_video_bytes: null,
   max_widget_ids_per_request: null,
   preview_session_ttl_seconds: null,
   release: null

data/lib/ultracart_api/api/sfvb_api.rb

@@ -102,7 +102,7 @@ module UltracartClient
     end
 
     # Create a preview session
-    # Returns a server generated session id to push containers into.  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. 
+    # 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] 
     # @param [Hash] opts the optional parameters
     # @return [SfvbPreviewSessionResponse]
@@ -112,7 +112,7 @@ module UltracartClient
     end
 
     # Create a preview session
-    # Returns a server generated session id to push containers into.  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. 
+    # 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] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SfvbPreviewSessionResponse, Integer, Hash)>] SfvbPreviewSessionResponse data, response status code and response headers
@@ -1990,7 +1990,7 @@ module UltracartClient
     end
 
     # Push containers into a preview session
-    # Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+    # Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
     # @param storefront_oid [Integer] 
     # @param preview_session_id [String] 
     # @param preview_session [SfvbPreviewSessionRequest] Containers to stage in the preview session
@@ -2003,7 +2003,7 @@ module UltracartClient
     end
 
     # Push containers into a preview session
-    # Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+    # Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
     # @param storefront_oid [Integer] 
     # @param preview_session_id [String] 
     # @param preview_session [SfvbPreviewSessionRequest] Containers to stage in the preview session

data/lib/ultracart_api/models/sfvb_container_response.rb

@@ -24,7 +24,7 @@ module UltracartClient
     # SHA-256 of the cjson.  Send back as If-Match when writing.
     attr_accessor :hash_sha256
 
-    # When the container was last modified, in the store's own record of it.  Present for email, postcardfront and postcardback.  Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container.  Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
+    # 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
 
     # Identifier of the owning object within its store.

data/lib/ultracart_api/models/sfvb_theme_duplicate_request.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module UltracartClient
   class SfvbThemeDuplicateRequest
-    # Directory name for the new theme under /themes/.  Letters and numbers; it is cleansed before use.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
+    # Directory name for the new theme under /themes/.  Letters and numbers, one path segment.  Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
     attr_accessor :folder
 
     # Storefront to create the copy on.  Defaults to the storefront in the path.  Supply it only when copying a theme between storefronts you own.

data/lib/ultracart_api/models/sfvb_theme_job_response.rb

@@ -48,7 +48,7 @@ module UltracartClient
     # True only when the job finished successfully.  Check complete first.
     attr_accessor :success
 
-    # Path the new theme was created at.  Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result.  Once the job completes, list themes and match on this path.
+    # Path the new theme is being created at.  Returned when the job is started and on every poll, so you do not have to keep the response that started it.  The theme oid itself is NOT returned, so once the job completes you list themes and match on this path.  It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending.
     attr_accessor :target_path
 
     class EnumAttributeValidator

data/lib/ultracart_api/models/sfvb_version_response.rb

@@ -24,18 +24,36 @@ module UltracartClient
     # Number of element types this version recognizes.
     attr_accessor :element_count
 
+    # Largest binary asset that can be uploaded, in bytes, for every accepted type except video.
+    attr_accessor :max_asset_bytes
+
     # Largest CJSON document that will be parsed, in bytes.
     attr_accessor :max_cjson_bytes
 
+    # Most entries one directory listing returns.  Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for.  The listing does set a truncated flag when it drops entries.
+    attr_accessor :max_directory_entries
+
+    # Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut.
+    attr_accessor :max_library_results_per_page
+
     # Largest payload one preview session may hold, in bytes.
     attr_accessor :max_preview_session_bytes
 
+    # Largest historical version files/revert will restore, in bytes.  Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to.
+    attr_accessor :max_revertable_bytes
+
     # Hard ceiling on file search results per page.
     attr_accessor :max_search_results
 
-    # Largest template file that can be written, in bytes.
+    # Largest .vm template that can be written, in bytes.  Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back.  Use max_text_read_bytes for that.
     attr_accessor :max_template_bytes
 
+    # Largest file files/content will return as text, in bytes.  A file above this is refused with sfvb.too_large however small its history versions are.  Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template.  Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling.
+    attr_accessor :max_text_read_bytes
+
+    # Largest video that can be uploaded, in bytes.  Video is the one type allowed past max_asset_bytes.
+    attr_accessor :max_video_bytes
+
     # Most widget ids that can be reserved in one call.
     attr_accessor :max_widget_ids_per_request
 
@@ -73,10 +91,16 @@ module UltracartClient
         :'container_manager_version' => :'container_manager_version',
         :'container_versions_retained' => :'container_versions_retained',
         :'element_count' => :'element_count',
+        :'max_asset_bytes' => :'max_asset_bytes',
         :'max_cjson_bytes' => :'max_cjson_bytes',
+        :'max_directory_entries' => :'max_directory_entries',
+        :'max_library_results_per_page' => :'max_library_results_per_page',
         :'max_preview_session_bytes' => :'max_preview_session_bytes',
+        :'max_revertable_bytes' => :'max_revertable_bytes',
         :'max_search_results' => :'max_search_results',
         :'max_template_bytes' => :'max_template_bytes',
+        :'max_text_read_bytes' => :'max_text_read_bytes',
+        :'max_video_bytes' => :'max_video_bytes',
         :'max_widget_ids_per_request' => :'max_widget_ids_per_request',
         :'preview_session_ttl_seconds' => :'preview_session_ttl_seconds',
         :'release' => :'release'
@@ -94,10 +118,16 @@ module UltracartClient
         :'container_manager_version' => :'String',
         :'container_versions_retained' => :'Integer',
         :'element_count' => :'Integer',
+        :'max_asset_bytes' => :'Integer',
         :'max_cjson_bytes' => :'Integer',
+        :'max_directory_entries' => :'Integer',
+        :'max_library_results_per_page' => :'Integer',
         :'max_preview_session_bytes' => :'Integer',
+        :'max_revertable_bytes' => :'Integer',
         :'max_search_results' => :'Integer',
         :'max_template_bytes' => :'Integer',
+        :'max_text_read_bytes' => :'Integer',
+        :'max_video_bytes' => :'Integer',
         :'max_widget_ids_per_request' => :'Integer',
         :'preview_session_ttl_seconds' => :'Integer',
         :'release' => :'String'
@@ -137,14 +167,30 @@ module UltracartClient
         self.element_count = attributes[:'element_count']
       end
 
+      if attributes.key?(:'max_asset_bytes')
+        self.max_asset_bytes = attributes[:'max_asset_bytes']
+      end
+
       if attributes.key?(:'max_cjson_bytes')
         self.max_cjson_bytes = attributes[:'max_cjson_bytes']
       end
 
+      if attributes.key?(:'max_directory_entries')
+        self.max_directory_entries = attributes[:'max_directory_entries']
+      end
+
+      if attributes.key?(:'max_library_results_per_page')
+        self.max_library_results_per_page = attributes[:'max_library_results_per_page']
+      end
+
       if attributes.key?(:'max_preview_session_bytes')
         self.max_preview_session_bytes = attributes[:'max_preview_session_bytes']
       end
 
+      if attributes.key?(:'max_revertable_bytes')
+        self.max_revertable_bytes = attributes[:'max_revertable_bytes']
+      end
+
       if attributes.key?(:'max_search_results')
         self.max_search_results = attributes[:'max_search_results']
       end
@@ -153,6 +199,14 @@ module UltracartClient
         self.max_template_bytes = attributes[:'max_template_bytes']
       end
 
+      if attributes.key?(:'max_text_read_bytes')
+        self.max_text_read_bytes = attributes[:'max_text_read_bytes']
+      end
+
+      if attributes.key?(:'max_video_bytes')
+        self.max_video_bytes = attributes[:'max_video_bytes']
+      end
+
       if attributes.key?(:'max_widget_ids_per_request')
         self.max_widget_ids_per_request = attributes[:'max_widget_ids_per_request']
       end
@@ -199,10 +253,16 @@ module UltracartClient
           container_manager_version == o.container_manager_version &&
           container_versions_retained == o.container_versions_retained &&
           element_count == o.element_count &&
+          max_asset_bytes == o.max_asset_bytes &&
           max_cjson_bytes == o.max_cjson_bytes &&
+          max_directory_entries == o.max_directory_entries &&
+          max_library_results_per_page == o.max_library_results_per_page &&
           max_preview_session_bytes == o.max_preview_session_bytes &&
+          max_revertable_bytes == o.max_revertable_bytes &&
           max_search_results == o.max_search_results &&
           max_template_bytes == o.max_template_bytes &&
+          max_text_read_bytes == o.max_text_read_bytes &&
+          max_video_bytes == o.max_video_bytes &&
           max_widget_ids_per_request == o.max_widget_ids_per_request &&
           preview_session_ttl_seconds == o.preview_session_ttl_seconds &&
           release == o.release
@@ -217,7 +277,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [container_manager_version, container_versions_retained, element_count, max_cjson_bytes, max_preview_session_bytes, max_search_results, max_template_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
+      [container_manager_version, container_versions_retained, element_count, max_asset_bytes, max_cjson_bytes, max_directory_entries, max_library_results_per_page, max_preview_session_bytes, max_revertable_bytes, max_search_results, max_template_bytes, max_text_read_bytes, max_video_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

metadata

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