ultracart_rest_api_v2_typescript 4.1.144 → 4.1.146

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.144
+## ultracart_rest_api_v2_typescript@4.1.146
 
 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.144 --save
+npm install ultracart_rest_api_v2_typescript@4.1.146 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.143 | 09/02/2026 | sfvb - internal development |
 | 4.1.142 | 08/26/2026 | sfvb - internal test |

package/dist/apis/SfvbApi.d.ts

@@ -378,7 +378,7 @@ export interface SfvbApiInterface {
      */
     getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
     /**
-     *
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * @summary URL that renders a preview session
      * @param {number} storefrontOid
      * @param {string} previewSessionId
@@ -389,6 +389,7 @@ export interface SfvbApiInterface {
      */
     getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
@@ -894,10 +895,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * URL that renders a preview session
      */
     getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;

package/dist/apis/SfvbApi.js

@@ -893,6 +893,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * URL that renders a preview session
      */
     SfvbApi.prototype.getSfvbPreviewUrlRaw = function (requestParameters, initOverrides) {
@@ -939,6 +940,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it.
      * URL that renders a preview session
      */
     SfvbApi.prototype.getSfvbPreviewUrl = function (requestParameters, initOverrides) {

package/dist/models/SfvbContainerResponse.d.ts

@@ -15,24 +15,12 @@
  * @interface SfvbContainerResponse
  */
 export interface SfvbContainerResponse {
-    /**
-     * True when this container lives in the theme currently serving live traffic.  Writing to it requires the sfvb_publish scope.
-     * @type {boolean}
-     * @memberof SfvbContainerResponse
-     */
-    active_theme?: boolean;
     /**
      * The container JSON.  Runtime state is stripped on the way out.
      * @type {string}
      * @memberof SfvbContainerResponse
      */
     cjson?: string;
-    /**
-     * Container id as the compiler will derive it.
-     * @type {string}
-     * @memberof SfvbContainerResponse
-     */
-    container_id?: string;
     /**
      * Container name.
      * @type {string}
@@ -46,7 +34,7 @@ export interface SfvbContainerResponse {
      */
     hash_sha256?: string;
     /**
-     * When the container was last modified, where the store records it.
+     * 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.
      * @type {string}
      * @memberof SfvbContainerResponse
      */
@@ -63,18 +51,6 @@ export interface SfvbContainerResponse {
      * @memberof SfvbContainerResponse
      */
     owner_type?: SfvbContainerResponseOwnerTypeEnum;
-    /**
-     * File path, for theme and page containers only.
-     * @type {string}
-     * @memberof SfvbContainerResponse
-     */
-    path?: string;
-    /**
-     * File version, for theme and page containers only.
-     * @type {number}
-     * @memberof SfvbContainerResponse
-     */
-    version?: number;
 }
 /**
  * @export

package/dist/models/SfvbContainerResponse.js

@@ -43,16 +43,12 @@ function SfvbContainerResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'active_theme': !(0, runtime_1.exists)(json, 'active_theme') ? undefined : json['active_theme'],
         'cjson': !(0, runtime_1.exists)(json, 'cjson') ? undefined : json['cjson'],
-        'container_id': !(0, runtime_1.exists)(json, 'container_id') ? undefined : json['container_id'],
         'container_name': !(0, runtime_1.exists)(json, 'container_name') ? undefined : json['container_name'],
         'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
         'last_modified': !(0, runtime_1.exists)(json, 'last_modified') ? undefined : json['last_modified'],
         'owner_object_id': !(0, runtime_1.exists)(json, 'owner_object_id') ? undefined : json['owner_object_id'],
         'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
-        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
-        'version': !(0, runtime_1.exists)(json, 'version') ? undefined : json['version'],
     };
 }
 exports.SfvbContainerResponseFromJSONTyped = SfvbContainerResponseFromJSONTyped;
@@ -64,16 +60,12 @@ function SfvbContainerResponseToJSON(value) {
         return null;
     }
     return {
-        'active_theme': value.active_theme,
         'cjson': value.cjson,
-        'container_id': value.container_id,
         'container_name': value.container_name,
         'hash_sha256': value.hash_sha256,
         'last_modified': value.last_modified,
         'owner_object_id': value.owner_object_id,
         'owner_type': value.owner_type,
-        'path': value.path,
-        'version': value.version,
     };
 }
 exports.SfvbContainerResponseToJSON = SfvbContainerResponseToJSON;

package/dist/models/SfvbFileVersion.d.ts

@@ -34,7 +34,7 @@ export interface SfvbFileVersion {
      */
     edited_by?: string;
     /**
-     * History record oid.
+     * History record oid, for correlating an entry with the file manager.  Absent on the entry marked current, which is the content on disk right now and has no history row of its own.  Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it.  Fetch and revert a file version by path plus version instead.
      * @type {number}
      * @memberof SfvbFileVersion
      */
@@ -52,7 +52,7 @@ export interface SfvbFileVersion {
      */
     last_modified?: string;
     /**
-     * True when this version can be reverted to.
+     * True when this version can be reverted to, which is every entry except the one marked current.  Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false.  Test whether the key is present, or simpler still, use current.
      * @type {boolean}
      * @memberof SfvbFileVersion
      */

package/dist/models/SfvbPreviewUrlResponse.d.ts

@@ -46,7 +46,7 @@ export interface SfvbPreviewUrlResponse {
      */
     requires_browser_session?: boolean;
     /**
-     * Always false.  The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.
+     * The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.  This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false.  Do not test it for equality with false.  usage_note carries the same warning as a string and does survive.
      * @type {boolean}
      * @memberof SfvbPreviewUrlResponse
      */

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -561,7 +561,7 @@ export interface SfvbApiInterface {
     getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
 
     /**
-     * 
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it. 
      * @summary URL that renders a preview session
      * @param {number} storefrontOid 
      * @param {string} previewSessionId 
@@ -573,6 +573,7 @@ export interface SfvbApiInterface {
     getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
 
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it. 
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
@@ -1610,6 +1611,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it. 
      * URL that renders a preview session
      */
     async getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>> {
@@ -1649,6 +1651,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
+     * Refuses a session that does not exist, so a URL you receive is for a session that was really there.  expires_in_seconds is the time actually remaining, not the configured lifetime.  Needs a token that resolves to a user, because a preview session belongs to the person who created it. 
      * URL that renders a preview session
      */
     async getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse> {

package/src/models/SfvbContainerResponse.ts

@@ -19,24 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface SfvbContainerResponse
  */
 export interface SfvbContainerResponse {
-    /**
-     * True when this container lives in the theme currently serving live traffic.  Writing to it requires the sfvb_publish scope.
-     * @type {boolean}
-     * @memberof SfvbContainerResponse
-     */
-    active_theme?: boolean;
     /**
      * The container JSON.  Runtime state is stripped on the way out.
      * @type {string}
      * @memberof SfvbContainerResponse
      */
     cjson?: string;
-    /**
-     * Container id as the compiler will derive it.
-     * @type {string}
-     * @memberof SfvbContainerResponse
-     */
-    container_id?: string;
     /**
      * Container name.
      * @type {string}
@@ -50,7 +38,7 @@ export interface SfvbContainerResponse {
      */
     hash_sha256?: string;
     /**
-     * When the container was last modified, where the store records it.
+     * 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.
      * @type {string}
      * @memberof SfvbContainerResponse
      */
@@ -67,18 +55,6 @@ export interface SfvbContainerResponse {
      * @memberof SfvbContainerResponse
      */
     owner_type?: SfvbContainerResponseOwnerTypeEnum;
-    /**
-     * File path, for theme and page containers only.
-     * @type {string}
-     * @memberof SfvbContainerResponse
-     */
-    path?: string;
-    /**
-     * File version, for theme and page containers only.
-     * @type {number}
-     * @memberof SfvbContainerResponse
-     */
-    version?: number;
 }
 
 
@@ -116,16 +92,12 @@ export function SfvbContainerResponseFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'active_theme': !exists(json, 'active_theme') ? undefined : json['active_theme'],
         'cjson': !exists(json, 'cjson') ? undefined : json['cjson'],
-        'container_id': !exists(json, 'container_id') ? undefined : json['container_id'],
         'container_name': !exists(json, 'container_name') ? undefined : json['container_name'],
         'hash_sha256': !exists(json, 'hash_sha256') ? undefined : json['hash_sha256'],
         'last_modified': !exists(json, 'last_modified') ? undefined : json['last_modified'],
         'owner_object_id': !exists(json, 'owner_object_id') ? undefined : json['owner_object_id'],
         'owner_type': !exists(json, 'owner_type') ? undefined : json['owner_type'],
-        'path': !exists(json, 'path') ? undefined : json['path'],
-        'version': !exists(json, 'version') ? undefined : json['version'],
     };
 }
 
@@ -138,16 +110,12 @@ export function SfvbContainerResponseToJSON(value?: SfvbContainerResponse | null
     }
     return {
         
-        'active_theme': value.active_theme,
         'cjson': value.cjson,
-        'container_id': value.container_id,
         'container_name': value.container_name,
         'hash_sha256': value.hash_sha256,
         'last_modified': value.last_modified,
         'owner_object_id': value.owner_object_id,
         'owner_type': value.owner_type,
-        'path': value.path,
-        'version': value.version,
     };
 }
 

package/src/models/SfvbFileVersion.ts

@@ -38,7 +38,7 @@ export interface SfvbFileVersion {
      */
     edited_by?: string;
     /**
-     * History record oid.
+     * History record oid, for correlating an entry with the file manager.  Absent on the entry marked current, which is the content on disk right now and has no history row of its own.  Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it.  Fetch and revert a file version by path plus version instead.
      * @type {number}
      * @memberof SfvbFileVersion
      */
@@ -56,7 +56,7 @@ export interface SfvbFileVersion {
      */
     last_modified?: string;
     /**
-     * True when this version can be reverted to.
+     * True when this version can be reverted to, which is every entry except the one marked current.  Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false.  Test whether the key is present, or simpler still, use current.
      * @type {boolean}
      * @memberof SfvbFileVersion
      */

package/src/models/SfvbPreviewUrlResponse.ts

@@ -50,7 +50,7 @@ export interface SfvbPreviewUrlResponse {
      */
     requires_browser_session?: boolean;
     /**
-     * Always false.  The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.
+     * The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.  This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false.  Do not test it for equality with false.  usage_note carries the same warning as a string and does survive.
      * @type {boolean}
      * @memberof SfvbPreviewUrlResponse
      */