ultracart_rest_api_v2_typescript 4.1.156 → 4.1.157
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.
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +20 -17
- package/dist/apis/SfvbApi.js +10 -8
- package/dist/models/SfvbContainerResponse.d.ts +6 -0
- package/dist/models/SfvbContainerResponse.js +2 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +20 -17
- package/src/models/SfvbContainerResponse.ts +8 -0
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.157
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.157 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.157 | 09/18/2026 | sfvb internal testing |
|
|
88
89
|
| 4.1.156 | 09/16/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.155 | 09/15/2026 | sfvb internal testing |
|
|
90
91
|
| 4.1.154 | 09/14/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -362,7 +362,7 @@ export interface SfvbApiInterface {
|
|
|
362
362
|
*/
|
|
363
363
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
364
364
|
/**
|
|
365
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
365
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
366
366
|
* @summary Read a container stored outside the file system
|
|
367
367
|
* @param {number} storefrontOid
|
|
368
368
|
* @param {string} ownerType
|
|
@@ -374,12 +374,12 @@ export interface SfvbApiInterface {
|
|
|
374
374
|
*/
|
|
375
375
|
getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
376
376
|
/**
|
|
377
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
377
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
378
378
|
* Read a container stored outside the file system
|
|
379
379
|
*/
|
|
380
380
|
getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
381
381
|
/**
|
|
382
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
382
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
383
383
|
* @summary Read the CJSON stored in one container history entry
|
|
384
384
|
* @param {number} storefrontOid
|
|
385
385
|
* @param {number} containerHistoryOid
|
|
@@ -392,7 +392,7 @@ export interface SfvbApiInterface {
|
|
|
392
392
|
*/
|
|
393
393
|
getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
|
|
394
394
|
/**
|
|
395
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
395
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
396
396
|
* Read the CJSON stored in one container history entry
|
|
397
397
|
*/
|
|
398
398
|
getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
|
|
@@ -602,7 +602,7 @@ export interface SfvbApiInterface {
|
|
|
602
602
|
*/
|
|
603
603
|
installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
606
606
|
* @summary Version history for a container stored outside the file system
|
|
607
607
|
* @param {number} storefrontOid
|
|
608
608
|
* @param {string} [ownerType]
|
|
@@ -614,6 +614,7 @@ export interface SfvbApiInterface {
|
|
|
614
614
|
*/
|
|
615
615
|
listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
|
|
616
616
|
/**
|
|
617
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
617
618
|
* Version history for a container stored outside the file system
|
|
618
619
|
*/
|
|
619
620
|
listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
|
|
@@ -704,7 +705,7 @@ export interface SfvbApiInterface {
|
|
|
704
705
|
*/
|
|
705
706
|
listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
|
|
706
707
|
/**
|
|
707
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
708
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
708
709
|
* @summary Write a container stored outside the file system
|
|
709
710
|
* @param {number} storefrontOid
|
|
710
711
|
* @param {string} ownerType
|
|
@@ -718,7 +719,7 @@ export interface SfvbApiInterface {
|
|
|
718
719
|
*/
|
|
719
720
|
putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
720
721
|
/**
|
|
721
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
722
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
722
723
|
* Write a container stored outside the file system
|
|
723
724
|
*/
|
|
724
725
|
putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
@@ -853,7 +854,7 @@ export interface SfvbApiInterface {
|
|
|
853
854
|
*/
|
|
854
855
|
reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
|
|
855
856
|
/**
|
|
856
|
-
* 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.
|
|
857
|
+
* 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.
|
|
857
858
|
* @summary Revert a container stored outside the file system
|
|
858
859
|
* @param {number} storefrontOid
|
|
859
860
|
* @param {string} ownerType
|
|
@@ -867,7 +868,7 @@ export interface SfvbApiInterface {
|
|
|
867
868
|
*/
|
|
868
869
|
revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
869
870
|
/**
|
|
870
|
-
* 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.
|
|
871
|
+
* 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.
|
|
871
872
|
* Revert a container stored outside the file system
|
|
872
873
|
*/
|
|
873
874
|
revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
@@ -1060,22 +1061,22 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
1060
1061
|
*/
|
|
1061
1062
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
1062
1063
|
/**
|
|
1063
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1064
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1064
1065
|
* Read a container stored outside the file system
|
|
1065
1066
|
*/
|
|
1066
1067
|
getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
1067
1068
|
/**
|
|
1068
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1069
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1069
1070
|
* Read a container stored outside the file system
|
|
1070
1071
|
*/
|
|
1071
1072
|
getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
1072
1073
|
/**
|
|
1073
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
1074
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
1074
1075
|
* Read the CJSON stored in one container history entry
|
|
1075
1076
|
*/
|
|
1076
1077
|
getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
|
|
1077
1078
|
/**
|
|
1078
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
1079
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
1079
1080
|
* Read the CJSON stored in one container history entry
|
|
1080
1081
|
*/
|
|
1081
1082
|
getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
|
|
@@ -1218,10 +1219,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
1218
1219
|
*/
|
|
1219
1220
|
installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
1220
1221
|
/**
|
|
1222
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
1221
1223
|
* Version history for a container stored outside the file system
|
|
1222
1224
|
*/
|
|
1223
1225
|
listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
|
|
1224
1226
|
/**
|
|
1227
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
1225
1228
|
* Version history for a container stored outside the file system
|
|
1226
1229
|
*/
|
|
1227
1230
|
listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
|
|
@@ -1284,12 +1287,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
1284
1287
|
*/
|
|
1285
1288
|
listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
|
|
1286
1289
|
/**
|
|
1287
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
1290
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
1288
1291
|
* Write a container stored outside the file system
|
|
1289
1292
|
*/
|
|
1290
1293
|
putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
1291
1294
|
/**
|
|
1292
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
1295
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
1293
1296
|
* Write a container stored outside the file system
|
|
1294
1297
|
*/
|
|
1295
1298
|
putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
@@ -1374,12 +1377,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
1374
1377
|
*/
|
|
1375
1378
|
reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
|
|
1376
1379
|
/**
|
|
1377
|
-
* 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.
|
|
1380
|
+
* 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.
|
|
1378
1381
|
* Revert a container stored outside the file system
|
|
1379
1382
|
*/
|
|
1380
1383
|
revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
1381
1384
|
/**
|
|
1382
|
-
* 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.
|
|
1385
|
+
* 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.
|
|
1383
1386
|
* Revert a container stored outside the file system
|
|
1384
1387
|
*/
|
|
1385
1388
|
revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -640,7 +640,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
640
640
|
});
|
|
641
641
|
};
|
|
642
642
|
/**
|
|
643
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
643
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
644
644
|
* Read a container stored outside the file system
|
|
645
645
|
*/
|
|
646
646
|
SfvbApi.prototype.getSfvbContainerRaw = function (requestParameters, initOverrides) {
|
|
@@ -690,7 +690,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
690
690
|
});
|
|
691
691
|
};
|
|
692
692
|
/**
|
|
693
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
693
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
694
694
|
* Read a container stored outside the file system
|
|
695
695
|
*/
|
|
696
696
|
SfvbApi.prototype.getSfvbContainer = function (requestParameters, initOverrides) {
|
|
@@ -708,7 +708,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
708
708
|
});
|
|
709
709
|
};
|
|
710
710
|
/**
|
|
711
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
711
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
712
712
|
* Read the CJSON stored in one container history entry
|
|
713
713
|
*/
|
|
714
714
|
SfvbApi.prototype.getSfvbContainerVersionRaw = function (requestParameters, initOverrides) {
|
|
@@ -761,7 +761,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
761
761
|
});
|
|
762
762
|
};
|
|
763
763
|
/**
|
|
764
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
764
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
765
765
|
* Read the CJSON stored in one container history entry
|
|
766
766
|
*/
|
|
767
767
|
SfvbApi.prototype.getSfvbContainerVersion = function (requestParameters, initOverrides) {
|
|
@@ -1636,6 +1636,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
1636
1636
|
});
|
|
1637
1637
|
};
|
|
1638
1638
|
/**
|
|
1639
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
1639
1640
|
* Version history for a container stored outside the file system
|
|
1640
1641
|
*/
|
|
1641
1642
|
SfvbApi.prototype.listSfvbContainerVersionsRaw = function (requestParameters, initOverrides) {
|
|
@@ -1685,6 +1686,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
1685
1686
|
});
|
|
1686
1687
|
};
|
|
1687
1688
|
/**
|
|
1689
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
1688
1690
|
* Version history for a container stored outside the file system
|
|
1689
1691
|
*/
|
|
1690
1692
|
SfvbApi.prototype.listSfvbContainerVersions = function (requestParameters, initOverrides) {
|
|
@@ -2063,7 +2065,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2063
2065
|
});
|
|
2064
2066
|
};
|
|
2065
2067
|
/**
|
|
2066
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
2068
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
2067
2069
|
* Write a container stored outside the file system
|
|
2068
2070
|
*/
|
|
2069
2071
|
SfvbApi.prototype.putSfvbContainerRaw = function (requestParameters, initOverrides) {
|
|
@@ -2124,7 +2126,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2124
2126
|
});
|
|
2125
2127
|
};
|
|
2126
2128
|
/**
|
|
2127
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
2129
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
2128
2130
|
* Write a container stored outside the file system
|
|
2129
2131
|
*/
|
|
2130
2132
|
SfvbApi.prototype.putSfvbContainer = function (requestParameters, initOverrides) {
|
|
@@ -2691,7 +2693,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2691
2693
|
});
|
|
2692
2694
|
};
|
|
2693
2695
|
/**
|
|
2694
|
-
* 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.
|
|
2696
|
+
* 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.
|
|
2695
2697
|
* Revert a container stored outside the file system
|
|
2696
2698
|
*/
|
|
2697
2699
|
SfvbApi.prototype.revertSfvbContainerRaw = function (requestParameters, initOverrides) {
|
|
@@ -2752,7 +2754,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2752
2754
|
});
|
|
2753
2755
|
};
|
|
2754
2756
|
/**
|
|
2755
|
-
* 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.
|
|
2757
|
+
* 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.
|
|
2756
2758
|
* Revert a container stored outside the file system
|
|
2757
2759
|
*/
|
|
2758
2760
|
SfvbApi.prototype.revertSfvbContainer = function (requestParameters, initOverrides) {
|
|
@@ -39,6 +39,12 @@ export interface SfvbContainerResponse {
|
|
|
39
39
|
* @memberof SfvbContainerResponse
|
|
40
40
|
*/
|
|
41
41
|
last_modified?: string;
|
|
42
|
+
/**
|
|
43
|
+
* The merchant item id of the owning item, for item containers only and absent for every other owner type. owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached. It is read fresh on every call and so reflects a renamed item. A container's own id embeds this value, which is what a preview session keys an item container on.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof SfvbContainerResponse
|
|
46
|
+
*/
|
|
47
|
+
merchant_item_id?: string;
|
|
42
48
|
/**
|
|
43
49
|
* Identifier of the owning object within its store.
|
|
44
50
|
* @type {string}
|
|
@@ -47,6 +47,7 @@ function SfvbContainerResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
47
|
'container_name': !(0, runtime_1.exists)(json, 'container_name') ? undefined : json['container_name'],
|
|
48
48
|
'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
49
49
|
'last_modified': !(0, runtime_1.exists)(json, 'last_modified') ? undefined : json['last_modified'],
|
|
50
|
+
'merchant_item_id': !(0, runtime_1.exists)(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
|
|
50
51
|
'owner_object_id': !(0, runtime_1.exists)(json, 'owner_object_id') ? undefined : json['owner_object_id'],
|
|
51
52
|
'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
|
|
52
53
|
};
|
|
@@ -64,6 +65,7 @@ function SfvbContainerResponseToJSON(value) {
|
|
|
64
65
|
'container_name': value.container_name,
|
|
65
66
|
'hash_sha256': value.hash_sha256,
|
|
66
67
|
'last_modified': value.last_modified,
|
|
68
|
+
'merchant_item_id': value.merchant_item_id,
|
|
67
69
|
'owner_object_id': value.owner_object_id,
|
|
68
70
|
'owner_type': value.owner_type,
|
|
69
71
|
};
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -577,7 +577,7 @@ export interface SfvbApiInterface {
|
|
|
577
577
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
578
578
|
|
|
579
579
|
/**
|
|
580
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
580
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
581
581
|
* @summary Read a container stored outside the file system
|
|
582
582
|
* @param {number} storefrontOid
|
|
583
583
|
* @param {string} ownerType
|
|
@@ -590,13 +590,13 @@ export interface SfvbApiInterface {
|
|
|
590
590
|
getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
591
591
|
|
|
592
592
|
/**
|
|
593
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
593
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
594
594
|
* Read a container stored outside the file system
|
|
595
595
|
*/
|
|
596
596
|
getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
597
597
|
|
|
598
598
|
/**
|
|
599
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
599
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
600
600
|
* @summary Read the CJSON stored in one container history entry
|
|
601
601
|
* @param {number} storefrontOid
|
|
602
602
|
* @param {number} containerHistoryOid
|
|
@@ -610,7 +610,7 @@ export interface SfvbApiInterface {
|
|
|
610
610
|
getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
|
|
611
611
|
|
|
612
612
|
/**
|
|
613
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
613
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
614
614
|
* Read the CJSON stored in one container history entry
|
|
615
615
|
*/
|
|
616
616
|
getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
|
|
@@ -849,7 +849,7 @@ export interface SfvbApiInterface {
|
|
|
849
849
|
installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
850
850
|
|
|
851
851
|
/**
|
|
852
|
-
*
|
|
852
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
853
853
|
* @summary Version history for a container stored outside the file system
|
|
854
854
|
* @param {number} storefrontOid
|
|
855
855
|
* @param {string} [ownerType]
|
|
@@ -862,6 +862,7 @@ export interface SfvbApiInterface {
|
|
|
862
862
|
listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
|
|
863
863
|
|
|
864
864
|
/**
|
|
865
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
865
866
|
* Version history for a container stored outside the file system
|
|
866
867
|
*/
|
|
867
868
|
listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
|
|
@@ -965,7 +966,7 @@ export interface SfvbApiInterface {
|
|
|
965
966
|
listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
|
|
966
967
|
|
|
967
968
|
/**
|
|
968
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
969
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
969
970
|
* @summary Write a container stored outside the file system
|
|
970
971
|
* @param {number} storefrontOid
|
|
971
972
|
* @param {string} ownerType
|
|
@@ -980,7 +981,7 @@ export interface SfvbApiInterface {
|
|
|
980
981
|
putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
981
982
|
|
|
982
983
|
/**
|
|
983
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
984
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
984
985
|
* Write a container stored outside the file system
|
|
985
986
|
*/
|
|
986
987
|
putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
@@ -1132,7 +1133,7 @@ export interface SfvbApiInterface {
|
|
|
1132
1133
|
reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
|
|
1133
1134
|
|
|
1134
1135
|
/**
|
|
1135
|
-
* 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.
|
|
1136
|
+
* 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.
|
|
1136
1137
|
* @summary Revert a container stored outside the file system
|
|
1137
1138
|
* @param {number} storefrontOid
|
|
1138
1139
|
* @param {string} ownerType
|
|
@@ -1147,7 +1148,7 @@ export interface SfvbApiInterface {
|
|
|
1147
1148
|
revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
|
|
1148
1149
|
|
|
1149
1150
|
/**
|
|
1150
|
-
* 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.
|
|
1151
|
+
* 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.
|
|
1151
1152
|
* Revert a container stored outside the file system
|
|
1152
1153
|
*/
|
|
1153
1154
|
revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
|
|
@@ -1687,7 +1688,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1687
1688
|
}
|
|
1688
1689
|
|
|
1689
1690
|
/**
|
|
1690
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1691
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1691
1692
|
* Read a container stored outside the file system
|
|
1692
1693
|
*/
|
|
1693
1694
|
async getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>> {
|
|
@@ -1731,7 +1732,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1731
1732
|
}
|
|
1732
1733
|
|
|
1733
1734
|
/**
|
|
1734
|
-
* owner_type is one of upsell, email, postcardfront, postcardback or item. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1735
|
+
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1735
1736
|
* Read a container stored outside the file system
|
|
1736
1737
|
*/
|
|
1737
1738
|
async getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse> {
|
|
@@ -1740,7 +1741,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1740
1741
|
}
|
|
1741
1742
|
|
|
1742
1743
|
/**
|
|
1743
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
1744
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
1744
1745
|
* Read the CJSON stored in one container history entry
|
|
1745
1746
|
*/
|
|
1746
1747
|
async getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>> {
|
|
@@ -1788,7 +1789,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1788
1789
|
}
|
|
1789
1790
|
|
|
1790
1791
|
/**
|
|
1791
|
-
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
|
|
1792
|
+
* Inspect or diff an earlier version without reverting to it. The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
|
|
1792
1793
|
* Read the CJSON stored in one container history entry
|
|
1793
1794
|
*/
|
|
1794
1795
|
async getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion> {
|
|
@@ -2413,6 +2414,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
2413
2414
|
}
|
|
2414
2415
|
|
|
2415
2416
|
/**
|
|
2417
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
2416
2418
|
* Version history for a container stored outside the file system
|
|
2417
2419
|
*/
|
|
2418
2420
|
async listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>> {
|
|
@@ -2456,6 +2458,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
2456
2458
|
}
|
|
2457
2459
|
|
|
2458
2460
|
/**
|
|
2461
|
+
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
2459
2462
|
* Version history for a container stored outside the file system
|
|
2460
2463
|
*/
|
|
2461
2464
|
async listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse> {
|
|
@@ -2720,7 +2723,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
2720
2723
|
}
|
|
2721
2724
|
|
|
2722
2725
|
/**
|
|
2723
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
2726
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
2724
2727
|
* Write a container stored outside the file system
|
|
2725
2728
|
*/
|
|
2726
2729
|
async putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>> {
|
|
@@ -2779,7 +2782,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
2779
2782
|
}
|
|
2780
2783
|
|
|
2781
2784
|
/**
|
|
2782
|
-
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
|
|
2785
|
+
* Validation is mandatory and runs here regardless of whether the caller validated first. The previous value is snapshotted before the write, so the change can be reverted. Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid. Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
|
|
2783
2786
|
* Write a container stored outside the file system
|
|
2784
2787
|
*/
|
|
2785
2788
|
async putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse> {
|
|
@@ -3221,7 +3224,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
3221
3224
|
}
|
|
3222
3225
|
|
|
3223
3226
|
/**
|
|
3224
|
-
* 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.
|
|
3227
|
+
* 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.
|
|
3225
3228
|
* Revert a container stored outside the file system
|
|
3226
3229
|
*/
|
|
3227
3230
|
async revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>> {
|
|
@@ -3280,7 +3283,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
3280
3283
|
}
|
|
3281
3284
|
|
|
3282
3285
|
/**
|
|
3283
|
-
* 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.
|
|
3286
|
+
* 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.
|
|
3284
3287
|
* Revert a container stored outside the file system
|
|
3285
3288
|
*/
|
|
3286
3289
|
async revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse> {
|
|
@@ -43,6 +43,12 @@ export interface SfvbContainerResponse {
|
|
|
43
43
|
* @memberof SfvbContainerResponse
|
|
44
44
|
*/
|
|
45
45
|
last_modified?: string;
|
|
46
|
+
/**
|
|
47
|
+
* The merchant item id of the owning item, for item containers only and absent for every other owner type. owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached. It is read fresh on every call and so reflects a renamed item. A container's own id embeds this value, which is what a preview session keys an item container on.
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof SfvbContainerResponse
|
|
50
|
+
*/
|
|
51
|
+
merchant_item_id?: string;
|
|
46
52
|
/**
|
|
47
53
|
* Identifier of the owning object within its store.
|
|
48
54
|
* @type {string}
|
|
@@ -96,6 +102,7 @@ export function SfvbContainerResponseFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
96
102
|
'container_name': !exists(json, 'container_name') ? undefined : json['container_name'],
|
|
97
103
|
'hash_sha256': !exists(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
98
104
|
'last_modified': !exists(json, 'last_modified') ? undefined : json['last_modified'],
|
|
105
|
+
'merchant_item_id': !exists(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
|
|
99
106
|
'owner_object_id': !exists(json, 'owner_object_id') ? undefined : json['owner_object_id'],
|
|
100
107
|
'owner_type': !exists(json, 'owner_type') ? undefined : json['owner_type'],
|
|
101
108
|
};
|
|
@@ -114,6 +121,7 @@ export function SfvbContainerResponseToJSON(value?: SfvbContainerResponse | null
|
|
|
114
121
|
'container_name': value.container_name,
|
|
115
122
|
'hash_sha256': value.hash_sha256,
|
|
116
123
|
'last_modified': value.last_modified,
|
|
124
|
+
'merchant_item_id': value.merchant_item_id,
|
|
117
125
|
'owner_object_id': value.owner_object_id,
|
|
118
126
|
'owner_type': value.owner_type,
|
|
119
127
|
};
|