ultracart_rest_api_v2_typescript 4.1.174 → 4.1.175

package/.openapi-generator/FILES

@@ -1060,6 +1060,8 @@ src/models/SfvbPageItemsResponse.ts
 src/models/SfvbPageListResponse.ts
 src/models/SfvbPageMultimedia.ts
 src/models/SfvbPageMultimediaRequest.ts
+src/models/SfvbPageRefreshRequest.ts
+src/models/SfvbPageRefreshResponse.ts
 src/models/SfvbPageResponse.ts
 src/models/SfvbPageSelectors.ts
 src/models/SfvbPageSettingsRequest.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.174
+## ultracart_rest_api_v2_typescript@4.1.175
 
 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.174 --save
+npm install ultracart_rest_api_v2_typescript@4.1.175 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.175 | 09/29/2026 | sfvb internal testing |
 | 4.1.174 | 09/25/2026 | sfvb internal testing |
 | 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
 | 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -375,6 +375,10 @@ export interface PutSfvbThemeAttributesRequest {
     themeOid: number;
     attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
 }
+export interface RefreshSfvbPageRequest {
+    storefrontOid: number;
+    pageRefreshRequest: SfvbPageRefreshRequest;
+}
 export interface RemoveSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -1679,6 +1683,21 @@ export interface SfvbApiInterface {
      * Change a theme\'s colors, fonts and settings
      */
     putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * @summary Drop one page\'s cached copy
+     * @param {number} storefrontOid
+     * @param {SfvbPageRefreshRequest} pageRefreshRequest The page to refresh
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>>;
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * Drop one page\'s cached copy
+     */
+    refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse>;
     /**
      * Removes posts by blog_post_oid, at most 500 at a time.  Every oid must be on the page, and one that is not changes nothing.  The posts themselves are not touched.  Always needs sfvb_publish.
      * @summary Take blog posts off a page
@@ -2705,6 +2724,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Change a theme\'s colors, fonts and settings
      */
     putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * Drop one page\'s cached copy
+     */
+    refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>>;
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * Drop one page\'s cached copy
+     */
+    refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse>;
     /**
      * Removes posts by blog_post_oid, at most 500 at a time.  Every oid must be on the page, and one that is not changes nothing.  The posts themselves are not touched.  Always needs sfvb_publish.
      * Take blog posts off a page

package/dist/apis/SfvbApi.js

@@ -5121,6 +5121,70 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * Drop one page\'s cached copy
+     */
+    SfvbApi.prototype.refreshSfvbPageRaw = 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 refreshSfvbPage.');
+                        }
+                        if (requestParameters.pageRefreshRequest === null || requestParameters.pageRefreshRequest === undefined) {
+                            throw new runtime.RequiredError('pageRefreshRequest', 'Required parameter requestParameters.pageRefreshRequest was null or undefined when calling refreshSfvbPage.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        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}/pages/refresh".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbPageRefreshRequestToJSON)(requestParameters.pageRefreshRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbPageRefreshResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped.
+     * Drop one page\'s cached copy
+     */
+    SfvbApi.prototype.refreshSfvbPage = 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.refreshSfvbPageRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Removes posts by blog_post_oid, at most 500 at a time.  Every oid must be on the page, and one that is not changes nothing.  The posts themselves are not touched.  Always needs sfvb_publish.
      * Take blog posts off a page

package/dist/models/SfvbPageRefreshRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 SfvbPageRefreshRequest
+ */
+export interface SfvbPageRefreshRequest {
+    /**
+     * The page to refresh.  A path such as /shop/coffee.html, or a full URL on this storefront's host.  The query string is ignored, and a path ending in / means its index.html.  One page per request.
+     * @type {string}
+     * @memberof SfvbPageRefreshRequest
+     */
+    url?: string;
+}
+/**
+ * Check if a given object implements the SfvbPageRefreshRequest interface.
+ */
+export declare function instanceOfSfvbPageRefreshRequest(value: object): boolean;
+export declare function SfvbPageRefreshRequestFromJSON(json: any): SfvbPageRefreshRequest;
+export declare function SfvbPageRefreshRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshRequest;
+export declare function SfvbPageRefreshRequestToJSON(value?: SfvbPageRefreshRequest | null): any;

package/dist/models/SfvbPageRefreshRequest.js

@@ -0,0 +1,50 @@
+"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.SfvbPageRefreshRequestToJSON = exports.SfvbPageRefreshRequestFromJSONTyped = exports.SfvbPageRefreshRequestFromJSON = exports.instanceOfSfvbPageRefreshRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbPageRefreshRequest interface.
+ */
+function instanceOfSfvbPageRefreshRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPageRefreshRequest = instanceOfSfvbPageRefreshRequest;
+function SfvbPageRefreshRequestFromJSON(json) {
+    return SfvbPageRefreshRequestFromJSONTyped(json, false);
+}
+exports.SfvbPageRefreshRequestFromJSON = SfvbPageRefreshRequestFromJSON;
+function SfvbPageRefreshRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
+    };
+}
+exports.SfvbPageRefreshRequestFromJSONTyped = SfvbPageRefreshRequestFromJSONTyped;
+function SfvbPageRefreshRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'url': value.url,
+    };
+}
+exports.SfvbPageRefreshRequestToJSON = SfvbPageRefreshRequestToJSON;

package/dist/models/SfvbPageRefreshResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 SfvbPageRefreshResponse
+ */
+export interface SfvbPageRefreshResponse {
+    /**
+     * A plain sentence saying what happened.
+     * @type {string}
+     * @memberof SfvbPageRefreshResponse
+     */
+    message?: string;
+    /**
+     * The page path the refresh used, after normalization.
+     * @type {string}
+     * @memberof SfvbPageRefreshResponse
+     */
+    path?: string;
+    /**
+     * True when a cached copy was dropped.  The next request renders the page fresh.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    refreshed?: boolean;
+    /**
+     * True when the page had a cache entry.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    was_cached?: boolean;
+    /**
+     * True when that entry was being served from cache.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    was_valid?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbPageRefreshResponse interface.
+ */
+export declare function instanceOfSfvbPageRefreshResponse(value: object): boolean;
+export declare function SfvbPageRefreshResponseFromJSON(json: any): SfvbPageRefreshResponse;
+export declare function SfvbPageRefreshResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshResponse;
+export declare function SfvbPageRefreshResponseToJSON(value?: SfvbPageRefreshResponse | null): any;

package/dist/models/SfvbPageRefreshResponse.js

@@ -0,0 +1,58 @@
+"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.SfvbPageRefreshResponseToJSON = exports.SfvbPageRefreshResponseFromJSONTyped = exports.SfvbPageRefreshResponseFromJSON = exports.instanceOfSfvbPageRefreshResponse = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbPageRefreshResponse interface.
+ */
+function instanceOfSfvbPageRefreshResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPageRefreshResponse = instanceOfSfvbPageRefreshResponse;
+function SfvbPageRefreshResponseFromJSON(json) {
+    return SfvbPageRefreshResponseFromJSONTyped(json, false);
+}
+exports.SfvbPageRefreshResponseFromJSON = SfvbPageRefreshResponseFromJSON;
+function SfvbPageRefreshResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'message': !(0, runtime_1.exists)(json, 'message') ? undefined : json['message'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'refreshed': !(0, runtime_1.exists)(json, 'refreshed') ? undefined : json['refreshed'],
+        'was_cached': !(0, runtime_1.exists)(json, 'was_cached') ? undefined : json['was_cached'],
+        'was_valid': !(0, runtime_1.exists)(json, 'was_valid') ? undefined : json['was_valid'],
+    };
+}
+exports.SfvbPageRefreshResponseFromJSONTyped = SfvbPageRefreshResponseFromJSONTyped;
+function SfvbPageRefreshResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'message': value.message,
+        'path': value.path,
+        'refreshed': value.refreshed,
+        'was_cached': value.was_cached,
+        'was_valid': value.was_valid,
+    };
+}
+exports.SfvbPageRefreshResponseToJSON = SfvbPageRefreshResponseToJSON;

package/dist/models/index.d.ts

@@ -1030,6 +1030,8 @@ export * from './SfvbPageItemsResponse';
 export * from './SfvbPageListResponse';
 export * from './SfvbPageMultimedia';
 export * from './SfvbPageMultimediaRequest';
+export * from './SfvbPageRefreshRequest';
+export * from './SfvbPageRefreshResponse';
 export * from './SfvbPageResponse';
 export * from './SfvbPageSelectors';
 export * from './SfvbPageSettingsRequest';

package/dist/models/index.js

@@ -1048,6 +1048,8 @@ __exportStar(require("./SfvbPageItemsResponse"), exports);
 __exportStar(require("./SfvbPageListResponse"), exports);
 __exportStar(require("./SfvbPageMultimedia"), exports);
 __exportStar(require("./SfvbPageMultimediaRequest"), exports);
+__exportStar(require("./SfvbPageRefreshRequest"), exports);
+__exportStar(require("./SfvbPageRefreshResponse"), exports);
 __exportStar(require("./SfvbPageResponse"), exports);
 __exportStar(require("./SfvbPageSelectors"), exports);
 __exportStar(require("./SfvbPageSettingsRequest"), exports);

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -159,6 +159,12 @@ import {
     SfvbPageMultimediaRequest,
     SfvbPageMultimediaRequestFromJSON,
     SfvbPageMultimediaRequestToJSON,
+    SfvbPageRefreshRequest,
+    SfvbPageRefreshRequestFromJSON,
+    SfvbPageRefreshRequestToJSON,
+    SfvbPageRefreshResponse,
+    SfvbPageRefreshResponseFromJSON,
+    SfvbPageRefreshResponseToJSON,
     SfvbPageResponse,
     SfvbPageResponseFromJSON,
     SfvbPageResponseToJSON,
@@ -697,6 +703,11 @@ export interface PutSfvbThemeAttributesRequest {
     attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
 }
 
+export interface RefreshSfvbPageRequest {
+    storefrontOid: number;
+    pageRefreshRequest: SfvbPageRefreshRequest;
+}
+
 export interface RemoveSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -2171,6 +2182,23 @@ export interface SfvbApiInterface {
      */
     putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
 
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped. 
+     * @summary Drop one page\'s cached copy
+     * @param {number} storefrontOid 
+     * @param {SfvbPageRefreshRequest} pageRefreshRequest The page to refresh
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>>;
+
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped. 
+     * Drop one page\'s cached copy
+     */
+    refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse>;
+
     /**
      * Removes posts by blog_post_oid, at most 500 at a time.  Every oid must be on the page, and one that is not changes nothing.  The posts themselves are not touched.  Always needs sfvb_publish. 
      * @summary Take blog posts off a page
@@ -6311,6 +6339,54 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped. 
+     * Drop one page\'s cached copy
+     */
+    async refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling refreshSfvbPage.');
+        }
+
+        if (requestParameters.pageRefreshRequest === null || requestParameters.pageRefreshRequest === undefined) {
+            throw new runtime.RequiredError('pageRefreshRequest','Required parameter requestParameters.pageRefreshRequest was null or undefined when calling refreshSfvbPage.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/pages/refresh`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SfvbPageRefreshRequestToJSON(requestParameters.pageRefreshRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbPageRefreshResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The next request renders the page fresh.  Use it when a write succeeded, a read shows the new value, and the public page still shows the old one.  Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL.  One page per request.  The response says whether the page had a cached copy and whether anything was dropped. 
+     * Drop one page\'s cached copy
+     */
+    async refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse> {
+        const response = await this.refreshSfvbPageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Removes posts by blog_post_oid, at most 500 at a time.  Every oid must be on the page, and one that is not changes nothing.  The posts themselves are not touched.  Always needs sfvb_publish. 
      * Take blog posts off a page

package/src/models/SfvbPageRefreshRequest.ts

@@ -0,0 +1,67 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbPageRefreshRequest
+ */
+export interface SfvbPageRefreshRequest {
+    /**
+     * The page to refresh.  A path such as /shop/coffee.html, or a full URL on this storefront's host.  The query string is ignored, and a path ending in / means its index.html.  One page per request.
+     * @type {string}
+     * @memberof SfvbPageRefreshRequest
+     */
+    url?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbPageRefreshRequest interface.
+ */
+export function instanceOfSfvbPageRefreshRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPageRefreshRequestFromJSON(json: any): SfvbPageRefreshRequest {
+    return SfvbPageRefreshRequestFromJSONTyped(json, false);
+}
+
+export function SfvbPageRefreshRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'url': !exists(json, 'url') ? undefined : json['url'],
+    };
+}
+
+export function SfvbPageRefreshRequestToJSON(value?: SfvbPageRefreshRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'url': value.url,
+    };
+}
+

package/src/models/SfvbPageRefreshResponse.ts

@@ -0,0 +1,99 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbPageRefreshResponse
+ */
+export interface SfvbPageRefreshResponse {
+    /**
+     * A plain sentence saying what happened.
+     * @type {string}
+     * @memberof SfvbPageRefreshResponse
+     */
+    message?: string;
+    /**
+     * The page path the refresh used, after normalization.
+     * @type {string}
+     * @memberof SfvbPageRefreshResponse
+     */
+    path?: string;
+    /**
+     * True when a cached copy was dropped.  The next request renders the page fresh.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    refreshed?: boolean;
+    /**
+     * True when the page had a cache entry.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    was_cached?: boolean;
+    /**
+     * True when that entry was being served from cache.
+     * @type {boolean}
+     * @memberof SfvbPageRefreshResponse
+     */
+    was_valid?: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbPageRefreshResponse interface.
+ */
+export function instanceOfSfvbPageRefreshResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPageRefreshResponseFromJSON(json: any): SfvbPageRefreshResponse {
+    return SfvbPageRefreshResponseFromJSONTyped(json, false);
+}
+
+export function SfvbPageRefreshResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'message': !exists(json, 'message') ? undefined : json['message'],
+        'path': !exists(json, 'path') ? undefined : json['path'],
+        'refreshed': !exists(json, 'refreshed') ? undefined : json['refreshed'],
+        'was_cached': !exists(json, 'was_cached') ? undefined : json['was_cached'],
+        'was_valid': !exists(json, 'was_valid') ? undefined : json['was_valid'],
+    };
+}
+
+export function SfvbPageRefreshResponseToJSON(value?: SfvbPageRefreshResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'message': value.message,
+        'path': value.path,
+        'refreshed': value.refreshed,
+        'was_cached': value.was_cached,
+        'was_valid': value.was_valid,
+    };
+}
+

package/src/models/index.ts

@@ -1032,6 +1032,8 @@ export * from './SfvbPageItemsResponse';
 export * from './SfvbPageListResponse';
 export * from './SfvbPageMultimedia';
 export * from './SfvbPageMultimediaRequest';
+export * from './SfvbPageRefreshRequest';
+export * from './SfvbPageRefreshResponse';
 export * from './SfvbPageResponse';
 export * from './SfvbPageSelectors';
 export * from './SfvbPageSettingsRequest';