ultracart_api 4.1.153 → 4.1.154

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e85ec4d8c8f205c28e0eb38c7542fc901b7de62a315a4d7dcca2c58aab386b0
-  data.tar.gz: f750082b045c19460b77dae4330a936d37c16b30ea51e08b8961dff9c4c9a8bd
+  metadata.gz: 37ac39f21f4d4926dc445c05679cf88a52c25751ae967e68d2a04ce2db104c86
+  data.tar.gz: 97a320a75abbf442e767bbc17d549e1f980687e2db385229f6d75dbe11d4482c
 SHA512:
-  metadata.gz: 66fa2b4121de7d02ebef906981fd45076568e382c06e4a69b543969725b76d73d361051339954dd5ffef182bc028917cacc7847883b4861f799c83ce45f88a67
-  data.tar.gz: d2c6ca8f0f88fd02379c5dc102b26578ddda34ab62a4dddc294d2174edb1340011a51c5115c8d04e8cc868ef437cfd6d8d91e5deae7c28982422724b5fdaa8c1
+  metadata.gz: de44ec246f9b2af49724ae1bb120ce8d2b79a9a68db06e98ffb734fa51c7bc9599f57f2232d63f5a7eae3ad174af5523fd46d6ef0a14c303f00b114a5136dfdf
+  data.tar.gz: 0f6a6d5026cd0175acb8da55d748ce4d0a6f6f1ae4ca5ec12052d477e994ef633fbc6d94da1faf3abdd6133df8577d372b79c405f3d75fa023d34a166282b8e6

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.153
+- Package version: 4.1.154
 - 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.153'
+gem 'ultracart_api', '4.1.154'
 ```
 
 install:
@@ -482,7 +482,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
 *UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
 *UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry
-*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema for one element type
+*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
 *UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
 *UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
 *UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
@@ -1952,6 +1952,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |

data/docs/SfvbApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
 | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
 | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
-| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema for one element type |
+| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
 | [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
 | [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
 | [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
@@ -598,7 +598,9 @@ end
 
 > <SfvbElementSchemaResponse> get_sfvb_element(element_type)
 
-Configuration schema for one element type
+Configuration schema and field card for one element type
+
+schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
 
 
 ### Examples
@@ -615,7 +617,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Configuration schema for one element type
+  # Configuration schema and field card for one element type
   data, status_code, headers = api_instance.get_sfvb_element_with_http_info(element_type)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/SfvbElement.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **doc_available** | **Boolean** | True when a markdown field card for this element is available from elements/{element_type}. | [optional] |
 | **schema_available** | **Boolean** | True when a per element configuration schema is available from elements/{element_type}. | [optional] |
 | **type** | **String** | The element type as it appears in the type property of a CJSON node. | [optional] |
 
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbElement.new(
+  doc_available: null,
   schema_available: null,
   type: null
 )

data/docs/SfvbElementSchemaResponse.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **schema** | **String** | JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet. | [optional] |
+| **doc** | **String** | Markdown field card for this element, as a string.  Omitted when no field card has been published for this element. | [optional] |
+| **schema** | **String** | Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element. | [optional] |
 | **type** | **String** | The element type. | [optional] |
 
 ## Example
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbElementSchemaResponse.new(
+  doc: null,
   schema: null,
   type: null
 )

data/docs/SfvbThemeJobResponse.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **complete** | **Boolean** | True once the job has stopped, whether it succeeded or failed. | [optional] |
 | **description** | **String** | Human readable description of the job. | [optional] |
-| **error_message** | **String** | Failure detail.  Populated only when status is error. | [optional] |
+| **error_message** | **String** | What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log. | [optional] |
 | **finished_dts** | **String** | When the job stopped.  Null until it does. | [optional] |
 | **job_id** | **Integer** | Job handle.  Poll getSfvbThemeJob with this. | [optional] |
 | **progress** | **Integer** | Percent complete, 0-100. | [optional] |

data/lib/ultracart_api/api/sfvb_api.rb

@@ -759,7 +759,8 @@ module UltracartClient
       return data, status_code, headers
     end
 
-    # Configuration schema for one element type
+    # Configuration schema and field card for one element type
+    # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
     # @param element_type [String] 
     # @param [Hash] opts the optional parameters
     # @return [SfvbElementSchemaResponse]
@@ -768,7 +769,8 @@ module UltracartClient
       data
     end
 
-    # Configuration schema for one element type
+    # Configuration schema and field card for one element type
+    # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
     # @param element_type [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SfvbElementSchemaResponse, Integer, Hash)>] SfvbElementSchemaResponse data, response status code and response headers

data/lib/ultracart_api/models/sfvb_element.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbElement
+    # True when a markdown field card for this element is available from elements/{element_type}.
+    attr_accessor :doc_available
+
     # True when a per element configuration schema is available from elements/{element_type}.
     attr_accessor :schema_available
 
@@ -24,6 +27,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'doc_available' => :'doc_available',
         :'schema_available' => :'schema_available',
         :'type' => :'type'
       }
@@ -37,6 +41,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'doc_available' => :'Boolean',
         :'schema_available' => :'Boolean',
         :'type' => :'String'
       }
@@ -63,6 +68,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'doc_available')
+        self.doc_available = attributes[:'doc_available']
+      end
+
       if attributes.key?(:'schema_available')
         self.schema_available = attributes[:'schema_available']
       end
@@ -90,6 +99,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          doc_available == o.doc_available &&
           schema_available == o.schema_available &&
           type == o.type
     end
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [schema_available, type].hash
+      [doc_available, schema_available, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_element_schema_response.rb

@@ -15,7 +15,10 @@ require 'time'
 
 module UltracartClient
   class SfvbElementSchemaResponse
-    # JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet.
+    # Markdown field card for this element, as a string.  Omitted when no field card has been published for this element.
+    attr_accessor :doc
+
+    # Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element.
     attr_accessor :schema
 
     # The element type.
@@ -24,6 +27,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'doc' => :'doc',
         :'schema' => :'schema',
         :'type' => :'type'
       }
@@ -37,6 +41,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'doc' => :'String',
         :'schema' => :'String',
         :'type' => :'String'
       }
@@ -63,6 +68,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'doc')
+        self.doc = attributes[:'doc']
+      end
+
       if attributes.key?(:'schema')
         self.schema = attributes[:'schema']
       end
@@ -90,6 +99,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          doc == o.doc &&
           schema == o.schema &&
           type == o.type
     end
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [schema, type].hash
+      [doc, schema, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_theme_job_response.rb

@@ -21,7 +21,7 @@ module UltracartClient
     # Human readable description of the job.
     attr_accessor :description
 
-    # Failure detail.  Populated only when status is error.
+    # What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log.
     attr_accessor :error_message
 
     # When the job stopped.  Null until it does.

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.153
+  version: 4.1.154
 platform: ruby
 authors:
 - UltraCart