ultracart_rest_api_v2_typescript 4.1.145 → 4.1.146
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
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.146
|
|
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.146 --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.146 | 09/03/2026 | sfvb - internal testing |
|
|
88
89
|
| 4.1.145 | 09/02/2026 | sfvb - internal testing |
|
|
89
90
|
| 4.1.144 | 09/02/2026 | sfvb - internal testing |
|
|
90
91
|
| 4.1.143 | 09/02/2026 | sfvb - internal development |
|
|
@@ -15,24 +15,12 @@
|
|
|
15
15
|
* @interface SfvbContainerResponse
|
|
16
16
|
*/
|
|
17
17
|
export interface SfvbContainerResponse {
|
|
18
|
-
/**
|
|
19
|
-
* True when this container lives in the theme currently serving live traffic. Writing to it requires the sfvb_publish scope.
|
|
20
|
-
* @type {boolean}
|
|
21
|
-
* @memberof SfvbContainerResponse
|
|
22
|
-
*/
|
|
23
|
-
active_theme?: boolean;
|
|
24
18
|
/**
|
|
25
19
|
* The container JSON. Runtime state is stripped on the way out.
|
|
26
20
|
* @type {string}
|
|
27
21
|
* @memberof SfvbContainerResponse
|
|
28
22
|
*/
|
|
29
23
|
cjson?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Container id as the compiler will derive it.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof SfvbContainerResponse
|
|
34
|
-
*/
|
|
35
|
-
container_id?: string;
|
|
36
24
|
/**
|
|
37
25
|
* Container name.
|
|
38
26
|
* @type {string}
|
|
@@ -46,7 +34,7 @@ export interface SfvbContainerResponse {
|
|
|
46
34
|
*/
|
|
47
35
|
hash_sha256?: string;
|
|
48
36
|
/**
|
|
49
|
-
* When the container was last modified,
|
|
37
|
+
* When the container was last modified, in the store's own record of it. Present for email, postcardfront and postcardback. Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container. Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
|
|
50
38
|
* @type {string}
|
|
51
39
|
* @memberof SfvbContainerResponse
|
|
52
40
|
*/
|
|
@@ -63,18 +51,6 @@ export interface SfvbContainerResponse {
|
|
|
63
51
|
* @memberof SfvbContainerResponse
|
|
64
52
|
*/
|
|
65
53
|
owner_type?: SfvbContainerResponseOwnerTypeEnum;
|
|
66
|
-
/**
|
|
67
|
-
* File path, for theme and page containers only.
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof SfvbContainerResponse
|
|
70
|
-
*/
|
|
71
|
-
path?: string;
|
|
72
|
-
/**
|
|
73
|
-
* File version, for theme and page containers only.
|
|
74
|
-
* @type {number}
|
|
75
|
-
* @memberof SfvbContainerResponse
|
|
76
|
-
*/
|
|
77
|
-
version?: number;
|
|
78
54
|
}
|
|
79
55
|
/**
|
|
80
56
|
* @export
|
|
@@ -43,16 +43,12 @@ function SfvbContainerResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
43
|
return json;
|
|
44
44
|
}
|
|
45
45
|
return {
|
|
46
|
-
'active_theme': !(0, runtime_1.exists)(json, 'active_theme') ? undefined : json['active_theme'],
|
|
47
46
|
'cjson': !(0, runtime_1.exists)(json, 'cjson') ? undefined : json['cjson'],
|
|
48
|
-
'container_id': !(0, runtime_1.exists)(json, 'container_id') ? undefined : json['container_id'],
|
|
49
47
|
'container_name': !(0, runtime_1.exists)(json, 'container_name') ? undefined : json['container_name'],
|
|
50
48
|
'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
51
49
|
'last_modified': !(0, runtime_1.exists)(json, 'last_modified') ? undefined : json['last_modified'],
|
|
52
50
|
'owner_object_id': !(0, runtime_1.exists)(json, 'owner_object_id') ? undefined : json['owner_object_id'],
|
|
53
51
|
'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
|
|
54
|
-
'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
|
|
55
|
-
'version': !(0, runtime_1.exists)(json, 'version') ? undefined : json['version'],
|
|
56
52
|
};
|
|
57
53
|
}
|
|
58
54
|
exports.SfvbContainerResponseFromJSONTyped = SfvbContainerResponseFromJSONTyped;
|
|
@@ -64,16 +60,12 @@ function SfvbContainerResponseToJSON(value) {
|
|
|
64
60
|
return null;
|
|
65
61
|
}
|
|
66
62
|
return {
|
|
67
|
-
'active_theme': value.active_theme,
|
|
68
63
|
'cjson': value.cjson,
|
|
69
|
-
'container_id': value.container_id,
|
|
70
64
|
'container_name': value.container_name,
|
|
71
65
|
'hash_sha256': value.hash_sha256,
|
|
72
66
|
'last_modified': value.last_modified,
|
|
73
67
|
'owner_object_id': value.owner_object_id,
|
|
74
68
|
'owner_type': value.owner_type,
|
|
75
|
-
'path': value.path,
|
|
76
|
-
'version': value.version,
|
|
77
69
|
};
|
|
78
70
|
}
|
|
79
71
|
exports.SfvbContainerResponseToJSON = SfvbContainerResponseToJSON;
|
|
@@ -34,7 +34,7 @@ export interface SfvbFileVersion {
|
|
|
34
34
|
*/
|
|
35
35
|
edited_by?: string;
|
|
36
36
|
/**
|
|
37
|
-
* History record oid.
|
|
37
|
+
* History record oid, for correlating an entry with the file manager. Absent on the entry marked current, which is the content on disk right now and has no history row of its own. Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it. Fetch and revert a file version by path plus version instead.
|
|
38
38
|
* @type {number}
|
|
39
39
|
* @memberof SfvbFileVersion
|
|
40
40
|
*/
|
|
@@ -52,7 +52,7 @@ export interface SfvbFileVersion {
|
|
|
52
52
|
*/
|
|
53
53
|
last_modified?: string;
|
|
54
54
|
/**
|
|
55
|
-
* True when this version can be reverted to.
|
|
55
|
+
* True when this version can be reverted to, which is every entry except the one marked current. Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false. Test whether the key is present, or simpler still, use current.
|
|
56
56
|
* @type {boolean}
|
|
57
57
|
* @memberof SfvbFileVersion
|
|
58
58
|
*/
|
package/package.json
CHANGED
|
@@ -19,24 +19,12 @@ import { exists, mapValues } from '../runtime';
|
|
|
19
19
|
* @interface SfvbContainerResponse
|
|
20
20
|
*/
|
|
21
21
|
export interface SfvbContainerResponse {
|
|
22
|
-
/**
|
|
23
|
-
* True when this container lives in the theme currently serving live traffic. Writing to it requires the sfvb_publish scope.
|
|
24
|
-
* @type {boolean}
|
|
25
|
-
* @memberof SfvbContainerResponse
|
|
26
|
-
*/
|
|
27
|
-
active_theme?: boolean;
|
|
28
22
|
/**
|
|
29
23
|
* The container JSON. Runtime state is stripped on the way out.
|
|
30
24
|
* @type {string}
|
|
31
25
|
* @memberof SfvbContainerResponse
|
|
32
26
|
*/
|
|
33
27
|
cjson?: string;
|
|
34
|
-
/**
|
|
35
|
-
* Container id as the compiler will derive it.
|
|
36
|
-
* @type {string}
|
|
37
|
-
* @memberof SfvbContainerResponse
|
|
38
|
-
*/
|
|
39
|
-
container_id?: string;
|
|
40
28
|
/**
|
|
41
29
|
* Container name.
|
|
42
30
|
* @type {string}
|
|
@@ -50,7 +38,7 @@ export interface SfvbContainerResponse {
|
|
|
50
38
|
*/
|
|
51
39
|
hash_sha256?: string;
|
|
52
40
|
/**
|
|
53
|
-
* When the container was last modified,
|
|
41
|
+
* When the container was last modified, in the store's own record of it. Present for email, postcardfront and postcardback. Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container. Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
|
|
54
42
|
* @type {string}
|
|
55
43
|
* @memberof SfvbContainerResponse
|
|
56
44
|
*/
|
|
@@ -67,18 +55,6 @@ export interface SfvbContainerResponse {
|
|
|
67
55
|
* @memberof SfvbContainerResponse
|
|
68
56
|
*/
|
|
69
57
|
owner_type?: SfvbContainerResponseOwnerTypeEnum;
|
|
70
|
-
/**
|
|
71
|
-
* File path, for theme and page containers only.
|
|
72
|
-
* @type {string}
|
|
73
|
-
* @memberof SfvbContainerResponse
|
|
74
|
-
*/
|
|
75
|
-
path?: string;
|
|
76
|
-
/**
|
|
77
|
-
* File version, for theme and page containers only.
|
|
78
|
-
* @type {number}
|
|
79
|
-
* @memberof SfvbContainerResponse
|
|
80
|
-
*/
|
|
81
|
-
version?: number;
|
|
82
58
|
}
|
|
83
59
|
|
|
84
60
|
|
|
@@ -116,16 +92,12 @@ export function SfvbContainerResponseFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
116
92
|
}
|
|
117
93
|
return {
|
|
118
94
|
|
|
119
|
-
'active_theme': !exists(json, 'active_theme') ? undefined : json['active_theme'],
|
|
120
95
|
'cjson': !exists(json, 'cjson') ? undefined : json['cjson'],
|
|
121
|
-
'container_id': !exists(json, 'container_id') ? undefined : json['container_id'],
|
|
122
96
|
'container_name': !exists(json, 'container_name') ? undefined : json['container_name'],
|
|
123
97
|
'hash_sha256': !exists(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
124
98
|
'last_modified': !exists(json, 'last_modified') ? undefined : json['last_modified'],
|
|
125
99
|
'owner_object_id': !exists(json, 'owner_object_id') ? undefined : json['owner_object_id'],
|
|
126
100
|
'owner_type': !exists(json, 'owner_type') ? undefined : json['owner_type'],
|
|
127
|
-
'path': !exists(json, 'path') ? undefined : json['path'],
|
|
128
|
-
'version': !exists(json, 'version') ? undefined : json['version'],
|
|
129
101
|
};
|
|
130
102
|
}
|
|
131
103
|
|
|
@@ -138,16 +110,12 @@ export function SfvbContainerResponseToJSON(value?: SfvbContainerResponse | null
|
|
|
138
110
|
}
|
|
139
111
|
return {
|
|
140
112
|
|
|
141
|
-
'active_theme': value.active_theme,
|
|
142
113
|
'cjson': value.cjson,
|
|
143
|
-
'container_id': value.container_id,
|
|
144
114
|
'container_name': value.container_name,
|
|
145
115
|
'hash_sha256': value.hash_sha256,
|
|
146
116
|
'last_modified': value.last_modified,
|
|
147
117
|
'owner_object_id': value.owner_object_id,
|
|
148
118
|
'owner_type': value.owner_type,
|
|
149
|
-
'path': value.path,
|
|
150
|
-
'version': value.version,
|
|
151
119
|
};
|
|
152
120
|
}
|
|
153
121
|
|
|
@@ -38,7 +38,7 @@ export interface SfvbFileVersion {
|
|
|
38
38
|
*/
|
|
39
39
|
edited_by?: string;
|
|
40
40
|
/**
|
|
41
|
-
* History record oid.
|
|
41
|
+
* History record oid, for correlating an entry with the file manager. Absent on the entry marked current, which is the content on disk right now and has no history row of its own. Unlike container_history_oid on a container version, this is NOT addressable through this API - nothing accepts it. Fetch and revert a file version by path plus version instead.
|
|
42
42
|
* @type {number}
|
|
43
43
|
* @memberof SfvbFileVersion
|
|
44
44
|
*/
|
|
@@ -56,7 +56,7 @@ export interface SfvbFileVersion {
|
|
|
56
56
|
*/
|
|
57
57
|
last_modified?: string;
|
|
58
58
|
/**
|
|
59
|
-
* True when this version can be reverted to.
|
|
59
|
+
* True when this version can be reverted to, which is every entry except the one marked current. Note that it is absent rather than false on that entry - false booleans are omitted across this API, so a generated client sees undefined rather than false. Test whether the key is present, or simpler still, use current.
|
|
60
60
|
* @type {boolean}
|
|
61
61
|
* @memberof SfvbFileVersion
|
|
62
62
|
*/
|