ultracart_rest_api_v2_typescript 4.1.142 → 4.1.144

package/.openapi-generator/FILES

@@ -1000,6 +1000,8 @@ src/models/SfvbFileEntry.ts
 src/models/SfvbFileRevertRequest.ts
 src/models/SfvbFileSearchRequest.ts
 src/models/SfvbFileSearchResponse.ts
+src/models/SfvbFileUploadRequest.ts
+src/models/SfvbFileUploadUrlResponse.ts
 src/models/SfvbFileVersion.ts
 src/models/SfvbFileVersionsResponse.ts
 src/models/SfvbFileWriteRequest.ts

package/README.md

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

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
@@ -26,6 +26,10 @@ export interface DeleteSfvbPreviewSessionRequest {
     storefrontOid: number;
     previewSessionId: string;
 }
+export interface DownloadSfvbFileRequest {
+    storefrontOid: number;
+    path?: string;
+}
 export interface DuplicateSfvbThemeRequest {
     storefrontOid: number;
     themeOid: number;
@@ -55,6 +59,10 @@ export interface GetSfvbFileContentRequest {
     path?: string;
     version?: number;
 }
+export interface GetSfvbFileUploadUrlRequest {
+    storefrontOid: number;
+    extension: string;
+}
 export interface GetSfvbLibraryEntryRequest {
     storefrontOid: number;
     libraryOid: number;
@@ -152,6 +160,11 @@ export interface SearchSfvbLibraryRequest {
     pageNumber?: number;
     resultsPerPage?: number;
 }
+export interface UploadSfvbFileRequest {
+    storefrontOid: number;
+    fileUploadRequest: SfvbFileUploadRequest;
+    ifMatch?: string;
+}
 export interface ValidateSfvbCjsonRequest {
     validateRequest: SfvbValidateRequest;
 }
@@ -226,6 +239,21 @@ export interface SfvbApiInterface {
      * Delete a preview session
      */
     deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * @summary Read a storefront file\'s raw bytes
+     * @param {number} storefrontOid
+     * @param {string} [path]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    downloadSfvbFileRaw(requestParameters: DownloadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * Read a storefront file\'s raw bytes
+     */
+    downloadSfvbFile(requestParameters: DownloadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Copies a theme into a new one and returns a job handle to poll.  Asynchronous, because copying a theme copies every file in it.  Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme.  This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
      * @summary Duplicate a theme
@@ -304,7 +332,7 @@ export interface SfvbApiInterface {
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * @summary Read a storefront file
      * @param {number} storefrontOid
      * @param {string} [path]
@@ -315,10 +343,25 @@ export interface SfvbApiInterface {
      */
     getSfvbFileContentRaw(requestParameters: GetSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileContentResponse>>;
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * Read a storefront file
      */
     getSfvbFileContent(requestParameters: GetSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileContentResponse>;
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * @summary Get a URL to upload a binary asset to
+     * @param {number} storefrontOid
+     * @param {string} extension
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbFileUploadUrlRaw(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileUploadUrlResponse>>;
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * Get a URL to upload a binary asset to
+     */
+    getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
     /**
      * Returns the fragment as authored.  If it references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
      * @summary Read one library entry including its CJSON
@@ -673,6 +716,22 @@ export interface SfvbApiInterface {
      * Search the element library
      */
     searchSfvbLibrary(requestParameters: SearchSfvbLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryResponse>;
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * @summary Store a binary asset that was already uploaded
+     * @param {number} storefrontOid
+     * @param {SfvbFileUploadRequest} fileUploadRequest Where to store the uploaded bytes
+     * @param {string} [ifMatch] Content hash from the last read.  Required when the file already exists; 428 when absent, 412 when stale.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    uploadSfvbFileRaw(requestParameters: UploadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileWriteResponse>>;
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * Store a binary asset that was already uploaded
+     */
+    uploadSfvbFile(requestParameters: UploadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
     /**
      * Runs the structural schema, the contextual business rules for the destination owner type, and the quality lint.  A document that fails returns HTTP 200 with valid false rather than a transport error - the request was well formed, the document was not.
      * @summary Validate CJSON
@@ -748,6 +807,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Delete a preview session
      */
     deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * Read a storefront file\'s raw bytes
+     */
+    downloadSfvbFileRaw(requestParameters: DownloadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * Read a storefront file\'s raw bytes
+     */
+    downloadSfvbFile(requestParameters: DownloadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Copies a theme into a new one and returns a job handle to poll.  Asynchronous, because copying a theme copies every file in it.  Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme.  This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
      * Duplicate a theme
@@ -795,15 +864,25 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * Read a storefront file
      */
     getSfvbFileContentRaw(requestParameters: GetSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileContentResponse>>;
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * Read a storefront file
      */
     getSfvbFileContent(requestParameters: GetSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileContentResponse>;
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * Get a URL to upload a binary asset to
+     */
+    getSfvbFileUploadUrlRaw(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileUploadUrlResponse>>;
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * Get a URL to upload a binary asset to
+     */
+    getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
     /**
      * Returns the fragment as authored.  If it references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
      * Read one library entry including its CJSON
@@ -1026,6 +1105,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Search the element library
      */
     searchSfvbLibrary(requestParameters: SearchSfvbLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryResponse>;
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * Store a binary asset that was already uploaded
+     */
+    uploadSfvbFileRaw(requestParameters: UploadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFileWriteResponse>>;
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * Store a binary asset that was already uploaded
+     */
+    uploadSfvbFile(requestParameters: UploadSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
     /**
      * Runs the structural schema, the contextual business rules for the destination owner type, and the quality lint.  A document that fails returns HTTP 200 with valid false rather than a transport error - the request was well formed, the document was not.
      * Validate CJSON

package/dist/apis/SfvbApi.js

@@ -321,6 +321,66 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * Read a storefront file\'s raw bytes
+     */
+    SfvbApi.prototype.downloadSfvbFileRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling downloadSfvbFile.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.path !== undefined) {
+                            queryParameters['path'] = requestParameters.path;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/files/download".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Returns the file itself rather than a JSON envelope, for any type including binaries that files/content refuses.  Use this to verify what you uploaded, and note it is the only way to read a file inside a theme that is not active - such a file is served to nobody until the theme is promoted, so it has no public URL to fetch instead.  On success the body is the file; on failure it is the usual JSON error object, so do not assume the content type without checking the status.
+     * Read a storefront file\'s raw bytes
+     */
+    SfvbApi.prototype.downloadSfvbFile = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.downloadSfvbFileRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Copies a theme into a new one and returns a job handle to poll.  Asynchronous, because copying a theme copies every file in it.  Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme.  This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
      * Duplicate a theme
@@ -644,7 +704,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * Read a storefront file
      */
     SfvbApi.prototype.getSfvbFileContentRaw = function (requestParameters, initOverrides) {
@@ -691,7 +751,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns the current content, or an earlier version when version is supplied.  The content hash is returned as an ETag; send it back as If-Match when writing.
+     * Returns the current content, or an earlier version when version is supplied.  Send the body\'s hash_sha256 back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so prefer the body value.
      * Read a storefront file
      */
     SfvbApi.prototype.getSfvbFileContent = function (requestParameters, initOverrides) {
@@ -708,6 +768,68 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * Get a URL to upload a binary asset to
+     */
+    SfvbApi.prototype.getSfvbFileUploadUrlRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbFileUploadUrl.');
+                        }
+                        if (requestParameters.extension === null || requestParameters.extension === undefined) {
+                            throw new runtime.RequiredError('extension', 'Required parameter requestParameters.extension was null or undefined when calling getSfvbFileUploadUrl.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/files/upload_url/{extension}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("extension", "}"), encodeURIComponent(String(requestParameters.extension))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbFileUploadUrlResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps.  Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given.  The bytes never pass through the API server.  The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file.  The URL is short lived and the key is bound to your account.
+     * Get a URL to upload a binary asset to
+     */
+    SfvbApi.prototype.getSfvbFileUploadUrl = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbFileUploadUrlRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Returns the fragment as authored.  If it references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
      * Read one library entry including its CJSON
@@ -2191,6 +2313,73 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * Store a binary asset that was already uploaded
+     */
+    SfvbApi.prototype.uploadSfvbFileRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling uploadSfvbFile.');
+                        }
+                        if (requestParameters.fileUploadRequest === null || requestParameters.fileUploadRequest === undefined) {
+                            throw new runtime.RequiredError('fileUploadRequest', 'Required parameter requestParameters.fileUploadRequest was null or undefined when calling uploadSfvbFile.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
+                            headerParameters['If-Match'] = String(requestParameters.ifMatch);
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/files/upload".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbFileUploadRequestToJSON)(requestParameters.fileUploadRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbFileWriteResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The second half of the two step upload.  The bytes are fetched from the key, checked against the extension they claim to be, and written exactly as a text write is - so the same If-Match precondition, the same read only refusal and the same publish gate apply.  An SVG is sanitized before it is stored.  Writing outside /themes/ requires sfvb_publish, because anything served off the storefront root is live by definition.
+     * Store a binary asset that was already uploaded
+     */
+    SfvbApi.prototype.uploadSfvbFile = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.uploadSfvbFileRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Runs the structural schema, the contextual business rules for the destination owner type, and the quality lint.  A document that fails returns HTTP 200 with valid false rather than a transport error - the request was well formed, the document was not.
      * Validate CJSON

package/dist/models/SfvbContainerVersion.d.ts

@@ -28,7 +28,7 @@ export interface SfvbContainerVersion {
      */
     comment?: string;
     /**
-     * History record oid.  Pass to the revert operation on the owning container.
+     * History record oid.  Pass to the revert operation on the owning container.  Absent on the entry marked current, which holds the value stored right now, has no history row of its own, and so cannot be fetched or reverted to.
      * @type {number}
      * @memberof SfvbContainerVersion
      */

package/dist/models/SfvbFileContentResponse.d.ts

@@ -34,7 +34,7 @@ export interface SfvbFileContentResponse {
      */
     fs_file_oid?: number;
     /**
-     * SHA-256 of the content.  Also returned as the ETag header; send it back as If-Match when writing.
+     * SHA-256 of the content.  Send this back as If-Match when writing.  The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so this body value is the authoritative one.  Both forms are accepted on write.
      * @type {string}
      * @memberof SfvbFileContentResponse
      */

package/dist/models/SfvbFileEntry.d.ts

@@ -34,7 +34,7 @@ export interface SfvbFileEntry {
      */
     fs_directory_oid?: number;
     /**
-     * StoreFront file system file oid.
+     * StoreFront file system file oid.  Absent on a directory entry, which has no file oid.
      * @type {number}
      * @memberof SfvbFileEntry
      */
@@ -100,7 +100,7 @@ export interface SfvbFileEntry {
      */
     valid?: boolean;
     /**
-     * Current version number of the file.
+     * Current version number of the file.  Absent on a directory entry, which is not versioned.
      * @type {number}
      * @memberof SfvbFileEntry
      */

package/dist/models/SfvbFileUploadRequest.d.ts

@@ -0,0 +1,49 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbFileUploadRequest
+ */
+export interface SfvbFileUploadRequest {
+    /**
+     * Optional comment recorded against the version this write creates.
+     * @type {string}
+     * @memberof SfvbFileUploadRequest
+     */
+    comment?: string;
+    /**
+     * Create the file if it does not exist.  Defaults to true.
+     * @type {boolean}
+     * @memberof SfvbFileUploadRequest
+     */
+    create_if_missing?: boolean;
+    /**
+     * The key returned when the upload URL was issued.
+     * @type {string}
+     * @memberof SfvbFileUploadRequest
+     */
+    key?: string;
+    /**
+     * Storefront path to write, for example /assets/imgs/hero.jpg.  The extension must match the one the upload URL was issued for, and must match the bytes.
+     * @type {string}
+     * @memberof SfvbFileUploadRequest
+     */
+    path?: string;
+}
+/**
+ * Check if a given object implements the SfvbFileUploadRequest interface.
+ */
+export declare function instanceOfSfvbFileUploadRequest(value: object): boolean;
+export declare function SfvbFileUploadRequestFromJSON(json: any): SfvbFileUploadRequest;
+export declare function SfvbFileUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbFileUploadRequest;
+export declare function SfvbFileUploadRequestToJSON(value?: SfvbFileUploadRequest | null): any;

package/dist/models/SfvbFileUploadRequest.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbFileUploadRequestToJSON = exports.SfvbFileUploadRequestFromJSONTyped = exports.SfvbFileUploadRequestFromJSON = exports.instanceOfSfvbFileUploadRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbFileUploadRequest interface.
+ */
+function instanceOfSfvbFileUploadRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbFileUploadRequest = instanceOfSfvbFileUploadRequest;
+function SfvbFileUploadRequestFromJSON(json) {
+    return SfvbFileUploadRequestFromJSONTyped(json, false);
+}
+exports.SfvbFileUploadRequestFromJSON = SfvbFileUploadRequestFromJSON;
+function SfvbFileUploadRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'comment': !(0, runtime_1.exists)(json, 'comment') ? undefined : json['comment'],
+        'create_if_missing': !(0, runtime_1.exists)(json, 'create_if_missing') ? undefined : json['create_if_missing'],
+        'key': !(0, runtime_1.exists)(json, 'key') ? undefined : json['key'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+    };
+}
+exports.SfvbFileUploadRequestFromJSONTyped = SfvbFileUploadRequestFromJSONTyped;
+function SfvbFileUploadRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'comment': value.comment,
+        'create_if_missing': value.create_if_missing,
+        'key': value.key,
+        'path': value.path,
+    };
+}
+exports.SfvbFileUploadRequestToJSON = SfvbFileUploadRequestToJSON;