ultracart_rest_api_v2_typescript 4.1.173 → 4.1.175

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1060,6 +1060,8 @@ src/models/SfvbPageItemsResponse.ts
1060
1060
  src/models/SfvbPageListResponse.ts
1061
1061
  src/models/SfvbPageMultimedia.ts
1062
1062
  src/models/SfvbPageMultimediaRequest.ts
1063
+ src/models/SfvbPageRefreshRequest.ts
1064
+ src/models/SfvbPageRefreshResponse.ts
1063
1065
  src/models/SfvbPageResponse.ts
1064
1066
  src/models/SfvbPageSelectors.ts
1065
1067
  src/models/SfvbPageSettingsRequest.ts
@@ -1078,6 +1080,9 @@ src/models/SfvbSiteAttributesResponse.ts
1078
1080
  src/models/SfvbStorefront.ts
1079
1081
  src/models/SfvbStorefrontsResponse.ts
1080
1082
  src/models/SfvbTemplate.ts
1083
+ src/models/SfvbTemplateResolveCandidate.ts
1084
+ src/models/SfvbTemplateResolvePath.ts
1085
+ src/models/SfvbTemplateResolveResponse.ts
1081
1086
  src/models/SfvbTemplatesResponse.ts
1082
1087
  src/models/SfvbTheme.ts
1083
1088
  src/models/SfvbThemeAttribute.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.173
2
+ ## ultracart_rest_api_v2_typescript@4.1.175
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.173 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.175 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.175 | 09/29/2026 | sfvb internal testing |
88
+ | 4.1.174 | 09/25/2026 | sfvb internal testing |
87
89
  | 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
88
90
  | 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |
89
91
  | 4.1.171 | 09/23/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- 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, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ 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';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -375,6 +375,10 @@ export interface PutSfvbThemeAttributesRequest {
375
375
  themeOid: number;
376
376
  attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
377
377
  }
378
+ export interface RefreshSfvbPageRequest {
379
+ storefrontOid: number;
380
+ pageRefreshRequest: SfvbPageRefreshRequest;
381
+ }
378
382
  export interface RemoveSfvbPageBlogPostsRequest {
379
383
  storefrontOid: number;
380
384
  path: string;
@@ -394,6 +398,11 @@ export interface ReserveSfvbWidgetIdsRequest {
394
398
  storefrontOid: number;
395
399
  count?: number;
396
400
  }
401
+ export interface ResolveSfvbTemplateRequest {
402
+ storefrontOid: number;
403
+ name: string;
404
+ themeOid?: number;
405
+ }
397
406
  export interface RevertSfvbContainerRequest {
398
407
  storefrontOid: number;
399
408
  ownerType: string;
@@ -739,7 +748,7 @@ export interface SfvbApiInterface {
739
748
  */
740
749
  duplicateSfvbUpsellPath(requestParameters: DuplicateSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
741
750
  /**
742
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
751
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
743
752
  * @summary End an experiment
744
753
  * @param {number} storefrontOid
745
754
  * @param {number} experimentOid
@@ -750,7 +759,7 @@ export interface SfvbApiInterface {
750
759
  */
751
760
  endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
752
761
  /**
753
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
762
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
754
763
  * End an experiment
755
764
  */
756
765
  endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
@@ -1674,6 +1683,21 @@ export interface SfvbApiInterface {
1674
1683
  * Change a theme\'s colors, fonts and settings
1675
1684
  */
1676
1685
  putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
1686
+ /**
1687
+ * 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.
1688
+ * @summary Drop one page\'s cached copy
1689
+ * @param {number} storefrontOid
1690
+ * @param {SfvbPageRefreshRequest} pageRefreshRequest The page to refresh
1691
+ * @param {*} [options] Override http request option.
1692
+ * @throws {RequiredError}
1693
+ * @memberof SfvbApiInterface
1694
+ */
1695
+ refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>>;
1696
+ /**
1697
+ * 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.
1698
+ * Drop one page\'s cached copy
1699
+ */
1700
+ refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse>;
1677
1701
  /**
1678
1702
  * 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.
1679
1703
  * @summary Take blog posts off a page
@@ -1737,6 +1761,22 @@ export interface SfvbApiInterface {
1737
1761
  * Reserve a block of widget ids
1738
1762
  */
1739
1763
  reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
1764
+ /**
1765
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
1766
+ * @summary Resolve a template name to the file a page renders
1767
+ * @param {number} storefrontOid
1768
+ * @param {string} name The template file name, such as catalog.vm
1769
+ * @param {number} [themeOid] Resolve in this theme instead of the active theme
1770
+ * @param {*} [options] Override http request option.
1771
+ * @throws {RequiredError}
1772
+ * @memberof SfvbApiInterface
1773
+ */
1774
+ resolveSfvbTemplateRaw(requestParameters: ResolveSfvbTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTemplateResolveResponse>>;
1775
+ /**
1776
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
1777
+ * Resolve a template name to the file a page renders
1778
+ */
1779
+ resolveSfvbTemplate(requestParameters: ResolveSfvbTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTemplateResolveResponse>;
1740
1780
  /**
1741
1781
  * The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
1742
1782
  * @summary Revert a container stored outside the file system
@@ -2101,12 +2141,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2101
2141
  */
2102
2142
  duplicateSfvbUpsellPath(requestParameters: DuplicateSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
2103
2143
  /**
2104
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
2144
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
2105
2145
  * End an experiment
2106
2146
  */
2107
2147
  endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
2108
2148
  /**
2109
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
2149
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
2110
2150
  * End an experiment
2111
2151
  */
2112
2152
  endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
@@ -2684,6 +2724,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2684
2724
  * Change a theme\'s colors, fonts and settings
2685
2725
  */
2686
2726
  putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
2727
+ /**
2728
+ * 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.
2729
+ * Drop one page\'s cached copy
2730
+ */
2731
+ refreshSfvbPageRaw(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageRefreshResponse>>;
2732
+ /**
2733
+ * 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.
2734
+ * Drop one page\'s cached copy
2735
+ */
2736
+ refreshSfvbPage(requestParameters: RefreshSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageRefreshResponse>;
2687
2737
  /**
2688
2738
  * 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.
2689
2739
  * Take blog posts off a page
@@ -2724,6 +2774,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2724
2774
  * Reserve a block of widget ids
2725
2775
  */
2726
2776
  reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
2777
+ /**
2778
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
2779
+ * Resolve a template name to the file a page renders
2780
+ */
2781
+ resolveSfvbTemplateRaw(requestParameters: ResolveSfvbTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTemplateResolveResponse>>;
2782
+ /**
2783
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
2784
+ * Resolve a template name to the file a page renders
2785
+ */
2786
+ resolveSfvbTemplate(requestParameters: ResolveSfvbTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTemplateResolveResponse>;
2727
2787
  /**
2728
2788
  * The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
2729
2789
  * Revert a container stored outside the file system
@@ -1239,7 +1239,7 @@ var SfvbApi = /** @class */ (function (_super) {
1239
1239
  });
1240
1240
  };
1241
1241
  /**
1242
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
1242
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
1243
1243
  * End an experiment
1244
1244
  */
1245
1245
  SfvbApi.prototype.endSfvbExperimentRaw = function (requestParameters, initOverrides) {
@@ -1285,7 +1285,7 @@ var SfvbApi = /** @class */ (function (_super) {
1285
1285
  });
1286
1286
  };
1287
1287
  /**
1288
- * Ends a running experiment. With winner_variation_number the winner gets all new visitors, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Visitors already assigned to a url experiment keep their page for up to 30 days. Always needs sfvb_publish.
1288
+ * Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
1289
1289
  * End an experiment
1290
1290
  */
1291
1291
  SfvbApi.prototype.endSfvbExperiment = function (requestParameters, initOverrides) {
@@ -5121,6 +5121,70 @@ var SfvbApi = /** @class */ (function (_super) {
5121
5121
  });
5122
5122
  });
5123
5123
  };
5124
+ /**
5125
+ * 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.
5126
+ * Drop one page\'s cached copy
5127
+ */
5128
+ SfvbApi.prototype.refreshSfvbPageRaw = function (requestParameters, initOverrides) {
5129
+ return __awaiter(this, void 0, void 0, function () {
5130
+ var queryParameters, headerParameters, _a, _b, response;
5131
+ return __generator(this, function (_c) {
5132
+ switch (_c.label) {
5133
+ case 0:
5134
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
5135
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling refreshSfvbPage.');
5136
+ }
5137
+ if (requestParameters.pageRefreshRequest === null || requestParameters.pageRefreshRequest === undefined) {
5138
+ throw new runtime.RequiredError('pageRefreshRequest', 'Required parameter requestParameters.pageRefreshRequest was null or undefined when calling refreshSfvbPage.');
5139
+ }
5140
+ queryParameters = {};
5141
+ headerParameters = {};
5142
+ headerParameters['Content-Type'] = 'application/json';
5143
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5144
+ // oauth required
5145
+ _a = headerParameters;
5146
+ _b = "Authorization";
5147
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
5148
+ case 1:
5149
+ // oauth required
5150
+ _a[_b] = _c.sent();
5151
+ _c.label = 2;
5152
+ case 2:
5153
+ if (this.configuration && this.configuration.apiKey) {
5154
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5155
+ }
5156
+ return [4 /*yield*/, this.request({
5157
+ path: "/sfvb/storefronts/{storefront_oid}/pages/refresh".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
5158
+ method: 'POST',
5159
+ headers: headerParameters,
5160
+ query: queryParameters,
5161
+ body: (0, models_1.SfvbPageRefreshRequestToJSON)(requestParameters.pageRefreshRequest),
5162
+ }, initOverrides)];
5163
+ case 3:
5164
+ response = _c.sent();
5165
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbPageRefreshResponseFromJSON)(jsonValue); })];
5166
+ }
5167
+ });
5168
+ });
5169
+ };
5170
+ /**
5171
+ * 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.
5172
+ * Drop one page\'s cached copy
5173
+ */
5174
+ SfvbApi.prototype.refreshSfvbPage = function (requestParameters, initOverrides) {
5175
+ return __awaiter(this, void 0, void 0, function () {
5176
+ var response;
5177
+ return __generator(this, function (_a) {
5178
+ switch (_a.label) {
5179
+ case 0: return [4 /*yield*/, this.refreshSfvbPageRaw(requestParameters, initOverrides)];
5180
+ case 1:
5181
+ response = _a.sent();
5182
+ return [4 /*yield*/, response.value()];
5183
+ case 2: return [2 /*return*/, _a.sent()];
5184
+ }
5185
+ });
5186
+ });
5187
+ };
5124
5188
  /**
5125
5189
  * 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.
5126
5190
  * Take blog posts off a page
@@ -5390,6 +5454,74 @@ var SfvbApi = /** @class */ (function (_super) {
5390
5454
  });
5391
5455
  });
5392
5456
  };
5457
+ /**
5458
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
5459
+ * Resolve a template name to the file a page renders
5460
+ */
5461
+ SfvbApi.prototype.resolveSfvbTemplateRaw = function (requestParameters, initOverrides) {
5462
+ return __awaiter(this, void 0, void 0, function () {
5463
+ var queryParameters, headerParameters, _a, _b, response;
5464
+ return __generator(this, function (_c) {
5465
+ switch (_c.label) {
5466
+ case 0:
5467
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
5468
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling resolveSfvbTemplate.');
5469
+ }
5470
+ if (requestParameters.name === null || requestParameters.name === undefined) {
5471
+ throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling resolveSfvbTemplate.');
5472
+ }
5473
+ queryParameters = {};
5474
+ if (requestParameters.name !== undefined) {
5475
+ queryParameters['name'] = requestParameters.name;
5476
+ }
5477
+ if (requestParameters.themeOid !== undefined) {
5478
+ queryParameters['theme_oid'] = requestParameters.themeOid;
5479
+ }
5480
+ headerParameters = {};
5481
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5482
+ // oauth required
5483
+ _a = headerParameters;
5484
+ _b = "Authorization";
5485
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
5486
+ case 1:
5487
+ // oauth required
5488
+ _a[_b] = _c.sent();
5489
+ _c.label = 2;
5490
+ case 2:
5491
+ if (this.configuration && this.configuration.apiKey) {
5492
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5493
+ }
5494
+ return [4 /*yield*/, this.request({
5495
+ path: "/sfvb/storefronts/{storefront_oid}/templates/resolve".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
5496
+ method: 'GET',
5497
+ headers: headerParameters,
5498
+ query: queryParameters,
5499
+ }, initOverrides)];
5500
+ case 3:
5501
+ response = _c.sent();
5502
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbTemplateResolveResponseFromJSON)(jsonValue); })];
5503
+ }
5504
+ });
5505
+ });
5506
+ };
5507
+ /**
5508
+ * A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
5509
+ * Resolve a template name to the file a page renders
5510
+ */
5511
+ SfvbApi.prototype.resolveSfvbTemplate = function (requestParameters, initOverrides) {
5512
+ return __awaiter(this, void 0, void 0, function () {
5513
+ var response;
5514
+ return __generator(this, function (_a) {
5515
+ switch (_a.label) {
5516
+ case 0: return [4 /*yield*/, this.resolveSfvbTemplateRaw(requestParameters, initOverrides)];
5517
+ case 1:
5518
+ response = _a.sent();
5519
+ return [4 /*yield*/, response.value()];
5520
+ case 2: return [2 /*return*/, _a.sent()];
5521
+ }
5522
+ });
5523
+ });
5524
+ };
5393
5525
  /**
5394
5526
  * The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
5395
5527
  * Revert a container stored outside the file system
@@ -0,0 +1,31 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbPageRefreshRequest
16
+ */
17
+ export interface SfvbPageRefreshRequest {
18
+ /**
19
+ * 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.
20
+ * @type {string}
21
+ * @memberof SfvbPageRefreshRequest
22
+ */
23
+ url?: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the SfvbPageRefreshRequest interface.
27
+ */
28
+ export declare function instanceOfSfvbPageRefreshRequest(value: object): boolean;
29
+ export declare function SfvbPageRefreshRequestFromJSON(json: any): SfvbPageRefreshRequest;
30
+ export declare function SfvbPageRefreshRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshRequest;
31
+ export declare function SfvbPageRefreshRequestToJSON(value?: SfvbPageRefreshRequest | null): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbPageRefreshRequestToJSON = exports.SfvbPageRefreshRequestFromJSONTyped = exports.SfvbPageRefreshRequestFromJSON = exports.instanceOfSfvbPageRefreshRequest = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbPageRefreshRequest interface.
20
+ */
21
+ function instanceOfSfvbPageRefreshRequest(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbPageRefreshRequest = instanceOfSfvbPageRefreshRequest;
26
+ function SfvbPageRefreshRequestFromJSON(json) {
27
+ return SfvbPageRefreshRequestFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbPageRefreshRequestFromJSON = SfvbPageRefreshRequestFromJSON;
30
+ function SfvbPageRefreshRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
36
+ };
37
+ }
38
+ exports.SfvbPageRefreshRequestFromJSONTyped = SfvbPageRefreshRequestFromJSONTyped;
39
+ function SfvbPageRefreshRequestToJSON(value) {
40
+ if (value === undefined) {
41
+ return undefined;
42
+ }
43
+ if (value === null) {
44
+ return null;
45
+ }
46
+ return {
47
+ 'url': value.url,
48
+ };
49
+ }
50
+ exports.SfvbPageRefreshRequestToJSON = SfvbPageRefreshRequestToJSON;
@@ -0,0 +1,55 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbPageRefreshResponse
16
+ */
17
+ export interface SfvbPageRefreshResponse {
18
+ /**
19
+ * A plain sentence saying what happened.
20
+ * @type {string}
21
+ * @memberof SfvbPageRefreshResponse
22
+ */
23
+ message?: string;
24
+ /**
25
+ * The page path the refresh used, after normalization.
26
+ * @type {string}
27
+ * @memberof SfvbPageRefreshResponse
28
+ */
29
+ path?: string;
30
+ /**
31
+ * True when a cached copy was dropped. The next request renders the page fresh.
32
+ * @type {boolean}
33
+ * @memberof SfvbPageRefreshResponse
34
+ */
35
+ refreshed?: boolean;
36
+ /**
37
+ * True when the page had a cache entry.
38
+ * @type {boolean}
39
+ * @memberof SfvbPageRefreshResponse
40
+ */
41
+ was_cached?: boolean;
42
+ /**
43
+ * True when that entry was being served from cache.
44
+ * @type {boolean}
45
+ * @memberof SfvbPageRefreshResponse
46
+ */
47
+ was_valid?: boolean;
48
+ }
49
+ /**
50
+ * Check if a given object implements the SfvbPageRefreshResponse interface.
51
+ */
52
+ export declare function instanceOfSfvbPageRefreshResponse(value: object): boolean;
53
+ export declare function SfvbPageRefreshResponseFromJSON(json: any): SfvbPageRefreshResponse;
54
+ export declare function SfvbPageRefreshResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPageRefreshResponse;
55
+ export declare function SfvbPageRefreshResponseToJSON(value?: SfvbPageRefreshResponse | null): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbPageRefreshResponseToJSON = exports.SfvbPageRefreshResponseFromJSONTyped = exports.SfvbPageRefreshResponseFromJSON = exports.instanceOfSfvbPageRefreshResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbPageRefreshResponse interface.
20
+ */
21
+ function instanceOfSfvbPageRefreshResponse(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbPageRefreshResponse = instanceOfSfvbPageRefreshResponse;
26
+ function SfvbPageRefreshResponseFromJSON(json) {
27
+ return SfvbPageRefreshResponseFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbPageRefreshResponseFromJSON = SfvbPageRefreshResponseFromJSON;
30
+ function SfvbPageRefreshResponseFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'message': !(0, runtime_1.exists)(json, 'message') ? undefined : json['message'],
36
+ 'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
37
+ 'refreshed': !(0, runtime_1.exists)(json, 'refreshed') ? undefined : json['refreshed'],
38
+ 'was_cached': !(0, runtime_1.exists)(json, 'was_cached') ? undefined : json['was_cached'],
39
+ 'was_valid': !(0, runtime_1.exists)(json, 'was_valid') ? undefined : json['was_valid'],
40
+ };
41
+ }
42
+ exports.SfvbPageRefreshResponseFromJSONTyped = SfvbPageRefreshResponseFromJSONTyped;
43
+ function SfvbPageRefreshResponseToJSON(value) {
44
+ if (value === undefined) {
45
+ return undefined;
46
+ }
47
+ if (value === null) {
48
+ return null;
49
+ }
50
+ return {
51
+ 'message': value.message,
52
+ 'path': value.path,
53
+ 'refreshed': value.refreshed,
54
+ 'was_cached': value.was_cached,
55
+ 'was_valid': value.was_valid,
56
+ };
57
+ }
58
+ exports.SfvbPageRefreshResponseToJSON = SfvbPageRefreshResponseToJSON;
@@ -0,0 +1,37 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbTemplateResolveCandidate
16
+ */
17
+ export interface SfvbTemplateResolveCandidate {
18
+ /**
19
+ * Why the storefront never uses this file for a page, or null. snippets means it sits in the resource path's own snippets folder.
20
+ * @type {string}
21
+ * @memberof SfvbTemplateResolveCandidate
22
+ */
23
+ skipped?: string;
24
+ /**
25
+ * Where the file sits inside the theme.
26
+ * @type {string}
27
+ * @memberof SfvbTemplateResolveCandidate
28
+ */
29
+ theme_relative_path?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the SfvbTemplateResolveCandidate interface.
33
+ */
34
+ export declare function instanceOfSfvbTemplateResolveCandidate(value: object): boolean;
35
+ export declare function SfvbTemplateResolveCandidateFromJSON(json: any): SfvbTemplateResolveCandidate;
36
+ export declare function SfvbTemplateResolveCandidateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTemplateResolveCandidate;
37
+ export declare function SfvbTemplateResolveCandidateToJSON(value?: SfvbTemplateResolveCandidate | null): any;