ultracart_rest_api_v2_typescript 4.1.153 → 4.1.154

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.153
+## ultracart_rest_api_v2_typescript@4.1.154
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.153 --save
+npm install ultracart_rest_api_v2_typescript@4.1.154 --save
 ```
 
 ```typescript
@@ -85,6 +85,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 |

package/dist/apis/SfvbApi.d.ts

@@ -365,8 +365,8 @@ export interface SfvbApiInterface {
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
     /**
-     *
-     * @summary Configuration schema 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.
+     * @summary Configuration schema and field card for one element type
      * @param {string} elementType
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -374,7 +374,8 @@ export interface SfvbApiInterface {
      */
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
     /**
-     * Configuration schema 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.
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**
@@ -991,11 +992,13 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
     /**
-     * Configuration schema 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.
+     * Configuration schema and field card for one element type
      */
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
     /**
-     * Configuration schema 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.
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**

package/dist/apis/SfvbApi.js

@@ -718,7 +718,8 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Configuration schema 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.
+     * Configuration schema and field card for one element type
      */
     SfvbApi.prototype.getSfvbElementRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -758,7 +759,8 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Configuration schema 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.
+     * Configuration schema and field card for one element type
      */
     SfvbApi.prototype.getSfvbElement = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/models/SfvbElement.d.ts

@@ -15,6 +15,12 @@
  * @interface SfvbElement
  */
 export interface SfvbElement {
+    /**
+     * True when a markdown field card for this element is available from elements/{element_type}.
+     * @type {boolean}
+     * @memberof SfvbElement
+     */
+    doc_available?: boolean;
     /**
      * True when a per element configuration schema is available from elements/{element_type}.
      * @type {boolean}

package/dist/models/SfvbElement.js

@@ -32,6 +32,7 @@ function SfvbElementFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'doc_available': !(0, runtime_1.exists)(json, 'doc_available') ? undefined : json['doc_available'],
         'schema_available': !(0, runtime_1.exists)(json, 'schema_available') ? undefined : json['schema_available'],
         'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
     };
@@ -45,6 +46,7 @@ function SfvbElementToJSON(value) {
         return null;
     }
     return {
+        'doc_available': value.doc_available,
         'schema_available': value.schema_available,
         'type': value.type,
     };

package/dist/models/SfvbElementSchemaResponse.d.ts

@@ -16,7 +16,13 @@
  */
 export interface 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.
+     * @type {string}
+     * @memberof SfvbElementSchemaResponse
+     */
+    doc?: 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.
      * @type {string}
      * @memberof SfvbElementSchemaResponse
      */

package/dist/models/SfvbElementSchemaResponse.js

@@ -32,6 +32,7 @@ function SfvbElementSchemaResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'doc': !(0, runtime_1.exists)(json, 'doc') ? undefined : json['doc'],
         'schema': !(0, runtime_1.exists)(json, 'schema') ? undefined : json['schema'],
         'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
     };
@@ -45,6 +46,7 @@ function SfvbElementSchemaResponseToJSON(value) {
         return null;
     }
     return {
+        'doc': value.doc,
         'schema': value.schema,
         'type': value.type,
     };

package/dist/models/SfvbThemeJobResponse.d.ts

@@ -28,7 +28,7 @@ export interface SfvbThemeJobResponse {
      */
     description?: string;
     /**
-     * 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.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.153",
+  "version": "4.1.154",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/SfvbApi.ts

@@ -563,8 +563,8 @@ export interface SfvbApiInterface {
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
 
     /**
-     * 
-     * @summary Configuration schema 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. 
+     * @summary Configuration schema and field card for one element type
      * @param {string} elementType 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -573,7 +573,8 @@ export interface SfvbApiInterface {
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
 
     /**
-     * Configuration schema 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. 
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
 
@@ -1647,7 +1648,8 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Configuration schema 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. 
+     * Configuration schema and field card for one element type
      */
     async getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>> {
         if (requestParameters.elementType === null || requestParameters.elementType === undefined) {
@@ -1678,7 +1680,8 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Configuration schema 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. 
+     * Configuration schema and field card for one element type
      */
     async getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse> {
         const response = await this.getSfvbElementRaw(requestParameters, initOverrides);

package/src/models/SfvbElement.ts

@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface SfvbElement
  */
 export interface SfvbElement {
+    /**
+     * True when a markdown field card for this element is available from elements/{element_type}.
+     * @type {boolean}
+     * @memberof SfvbElement
+     */
+    doc_available?: boolean;
     /**
      * True when a per element configuration schema is available from elements/{element_type}.
      * @type {boolean}
@@ -54,6 +60,7 @@ export function SfvbElementFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
+        'doc_available': !exists(json, 'doc_available') ? undefined : json['doc_available'],
         'schema_available': !exists(json, 'schema_available') ? undefined : json['schema_available'],
         'type': !exists(json, 'type') ? undefined : json['type'],
     };
@@ -68,6 +75,7 @@ export function SfvbElementToJSON(value?: SfvbElement | null): any {
     }
     return {
         
+        'doc_available': value.doc_available,
         'schema_available': value.schema_available,
         'type': value.type,
     };

package/src/models/SfvbElementSchemaResponse.ts

@@ -20,7 +20,13 @@ import { exists, mapValues } from '../runtime';
  */
 export interface 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.
+     * @type {string}
+     * @memberof SfvbElementSchemaResponse
+     */
+    doc?: 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.
      * @type {string}
      * @memberof SfvbElementSchemaResponse
      */
@@ -54,6 +60,7 @@ export function SfvbElementSchemaResponseFromJSONTyped(json: any, ignoreDiscrimi
     }
     return {
         
+        'doc': !exists(json, 'doc') ? undefined : json['doc'],
         'schema': !exists(json, 'schema') ? undefined : json['schema'],
         'type': !exists(json, 'type') ? undefined : json['type'],
     };
@@ -68,6 +75,7 @@ export function SfvbElementSchemaResponseToJSON(value?: SfvbElementSchemaRespons
     }
     return {
         
+        'doc': value.doc,
         'schema': value.schema,
         'type': value.type,
     };

package/src/models/SfvbThemeJobResponse.ts

@@ -32,7 +32,7 @@ export interface SfvbThemeJobResponse {
      */
     description?: string;
     /**
-     * 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.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */