ultracart_rest_api_v2_typescript 4.1.181 → 4.1.182

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.181
+## ultracart_rest_api_v2_typescript@4.1.182
 
 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.181 --save
+npm install ultracart_rest_api_v2_typescript@4.1.182 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.182 | 10/02/2026 | sfvb internal testing |
 | 4.1.181 | 10/02/2026 | sfvb internal testing |
 | 4.1.180 | 10/02/2026 | sfvb internal builder |
 | 4.1.179 | 10/01/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -1957,7 +1957,7 @@ export interface SfvbApiInterface {
      */
     removeSfvbPageItems(requestParameters: RemoveSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * @summary Render a CJSON node to HTML
      * @param {number} storefrontOid
      * @param {number} themeOid
@@ -1968,7 +1968,7 @@ export interface SfvbApiInterface {
      */
     renderSfvbWidgetsRaw(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRenderResponse>>;
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * Render a CJSON node to HTML
      */
     renderSfvbWidgets(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRenderResponse>;
@@ -3107,12 +3107,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     removeSfvbPageItems(requestParameters: RemoveSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * Render a CJSON node to HTML
      */
     renderSfvbWidgetsRaw(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRenderResponse>>;
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * Render a CJSON node to HTML
      */
     renderSfvbWidgets(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRenderResponse>;

package/dist/apis/SfvbApi.js

@@ -6032,7 +6032,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * Render a CJSON node to HTML
      */
     SfvbApi.prototype.renderSfvbWidgetsRaw = function (requestParameters, initOverrides) {
@@ -6081,7 +6081,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
      * Render a CJSON node to HTML
      */
     SfvbApi.prototype.renderSfvbWidgets = function (requestParameters, initOverrides) {

package/dist/models/SfvbRenderRequest.d.ts

@@ -75,6 +75,12 @@ export interface SfvbRenderRequest {
      * @memberof SfvbRenderRequest
      */
     context_upsell_offer_oid?: number;
+    /**
+     * True renders every branch the way the builder shows it, for styling content a shopper only sometimes sees.  Omitted or false renders what a shopper sees, with conditions, prices and sale state evaluated against the context item.
+     * @type {boolean}
+     * @memberof SfvbRenderRequest
+     */
+    edit_mode?: boolean;
     /**
      * Language ISO code.  Defaults to ENG.
      * @type {string}

package/dist/models/SfvbRenderRequest.js

@@ -42,6 +42,7 @@ function SfvbRenderRequestFromJSONTyped(json, ignoreDiscriminator) {
         'context_order_id': !(0, runtime_1.exists)(json, 'context_order_id') ? undefined : json['context_order_id'],
         'context_page_number': !(0, runtime_1.exists)(json, 'context_page_number') ? undefined : json['context_page_number'],
         'context_upsell_offer_oid': !(0, runtime_1.exists)(json, 'context_upsell_offer_oid') ? undefined : json['context_upsell_offer_oid'],
+        'edit_mode': !(0, runtime_1.exists)(json, 'edit_mode') ? undefined : json['edit_mode'],
         'language_iso_code': !(0, runtime_1.exists)(json, 'language_iso_code') ? undefined : json['language_iso_code'],
         'uri': !(0, runtime_1.exists)(json, 'uri') ? undefined : json['uri'],
     };
@@ -65,6 +66,7 @@ function SfvbRenderRequestToJSON(value) {
         'context_order_id': value.context_order_id,
         'context_page_number': value.context_page_number,
         'context_upsell_offer_oid': value.context_upsell_offer_oid,
+        'edit_mode': value.edit_mode,
         'language_iso_code': value.language_iso_code,
         'uri': value.uri,
     };

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -2523,7 +2523,7 @@ export interface SfvbApiInterface {
     removeSfvbPageItems(requestParameters: RemoveSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
 
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. 
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees. 
      * @summary Render a CJSON node to HTML
      * @param {number} storefrontOid 
      * @param {number} themeOid 
@@ -2535,7 +2535,7 @@ export interface SfvbApiInterface {
     renderSfvbWidgetsRaw(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRenderResponse>>;
 
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. 
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees. 
      * Render a CJSON node to HTML
      */
     renderSfvbWidgets(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRenderResponse>;
@@ -7335,7 +7335,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. 
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees. 
      * Render a CJSON node to HTML
      */
     async renderSfvbWidgetsRaw(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRenderResponse>> {
@@ -7378,7 +7378,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. 
+     * Renders one node in the context of a theme and a page.  Unlike compile this is stateful.  Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id.  One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.  By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item.  Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees. 
      * Render a CJSON node to HTML
      */
     async renderSfvbWidgets(requestParameters: RenderSfvbWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRenderResponse> {

package/src/models/SfvbRenderRequest.ts

@@ -79,6 +79,12 @@ export interface SfvbRenderRequest {
      * @memberof SfvbRenderRequest
      */
     context_upsell_offer_oid?: number;
+    /**
+     * True renders every branch the way the builder shows it, for styling content a shopper only sometimes sees.  Omitted or false renders what a shopper sees, with conditions, prices and sale state evaluated against the context item.
+     * @type {boolean}
+     * @memberof SfvbRenderRequest
+     */
+    edit_mode?: boolean;
     /**
      * Language ISO code.  Defaults to ENG.
      * @type {string}
@@ -124,6 +130,7 @@ export function SfvbRenderRequestFromJSONTyped(json: any, ignoreDiscriminator: b
         'context_order_id': !exists(json, 'context_order_id') ? undefined : json['context_order_id'],
         'context_page_number': !exists(json, 'context_page_number') ? undefined : json['context_page_number'],
         'context_upsell_offer_oid': !exists(json, 'context_upsell_offer_oid') ? undefined : json['context_upsell_offer_oid'],
+        'edit_mode': !exists(json, 'edit_mode') ? undefined : json['edit_mode'],
         'language_iso_code': !exists(json, 'language_iso_code') ? undefined : json['language_iso_code'],
         'uri': !exists(json, 'uri') ? undefined : json['uri'],
     };
@@ -148,6 +155,7 @@ export function SfvbRenderRequestToJSON(value?: SfvbRenderRequest | null): any {
         'context_order_id': value.context_order_id,
         'context_page_number': value.context_page_number,
         'context_upsell_offer_oid': value.context_upsell_offer_oid,
+        'edit_mode': value.edit_mode,
         'language_iso_code': value.language_iso_code,
         'uri': value.uri,
     };