ultracart_rest_api_v2_typescript 4.1.224 → 4.1.226
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 +4 -2
- package/dist/models/SfvbTrackingProvider.d.ts +6 -0
- package/dist/models/SfvbTrackingProvider.js +2 -0
- package/dist/models/SfvbTrackingProviderConsent.d.ts +1 -1
- package/dist/models/SfvbTrackingProviderConsent.js +2 -2
- package/dist/models/SfvbTrackingProviderEvent.d.ts +6 -6
- package/dist/models/SfvbTrackingProviderEvent.js +2 -2
- package/dist/models/SfvbTrackingProviderField.d.ts +6 -0
- package/dist/models/SfvbTrackingProviderField.js +2 -0
- package/package.json +1 -1
- package/src/models/SfvbTrackingProvider.ts +8 -0
- package/src/models/SfvbTrackingProviderConsent.ts +3 -3
- package/src/models/SfvbTrackingProviderEvent.ts +8 -8
- package/src/models/SfvbTrackingProviderField.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.226
|
|
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.226 --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.226 | 11/04/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.225 | 11/03/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.224 | 11/03/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.223 | 11/03/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.222 | 11/03/2026 | sfvb internal testing |
|
|
@@ -27,6 +27,12 @@ export interface SfvbTrackingProvider {
|
|
|
27
27
|
* @memberof SfvbTrackingProvider
|
|
28
28
|
*/
|
|
29
29
|
admin_path?: string;
|
|
30
|
+
/**
|
|
31
|
+
* On a dry run, whether the real write needs an approved tracking_provider.change request.
|
|
32
|
+
* @type {boolean}
|
|
33
|
+
* @memberof SfvbTrackingProvider
|
|
34
|
+
*/
|
|
35
|
+
approval_needed?: boolean;
|
|
30
36
|
/**
|
|
31
37
|
* On a write, each setting it changed, or would change on a dry run. Secrets read only set or cleared.
|
|
32
38
|
* @type {Array<SfvbTrackingChange>}
|
|
@@ -39,6 +39,7 @@ function SfvbTrackingProviderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
39
|
}
|
|
40
40
|
return {
|
|
41
41
|
'admin_path': !(0, runtime_1.exists)(json, 'admin_path') ? undefined : json['admin_path'],
|
|
42
|
+
'approval_needed': !(0, runtime_1.exists)(json, 'approval_needed') ? undefined : json['approval_needed'],
|
|
42
43
|
'changes': !(0, runtime_1.exists)(json, 'changes') ? undefined : (json['changes'].map(SfvbTrackingChange_1.SfvbTrackingChangeFromJSON)),
|
|
43
44
|
'configured': !(0, runtime_1.exists)(json, 'configured') ? undefined : json['configured'],
|
|
44
45
|
'consent': !(0, runtime_1.exists)(json, 'consent') ? undefined : (0, SfvbTrackingProviderConsent_1.SfvbTrackingProviderConsentFromJSON)(json['consent']),
|
|
@@ -66,6 +67,7 @@ function SfvbTrackingProviderToJSON(value) {
|
|
|
66
67
|
}
|
|
67
68
|
return {
|
|
68
69
|
'admin_path': value.admin_path,
|
|
70
|
+
'approval_needed': value.approval_needed,
|
|
69
71
|
'changes': value.changes === undefined ? undefined : (value.changes.map(SfvbTrackingChange_1.SfvbTrackingChangeToJSON)),
|
|
70
72
|
'configured': value.configured,
|
|
71
73
|
'consent': (0, SfvbTrackingProviderConsent_1.SfvbTrackingProviderConsentToJSON)(value.consent),
|
|
@@ -32,7 +32,7 @@ function SfvbTrackingProviderConsentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
32
32
|
return json;
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
|
-
'
|
|
35
|
+
'disabled': !(0, runtime_1.exists)(json, 'disabled') ? undefined : json['disabled'],
|
|
36
36
|
'region': !(0, runtime_1.exists)(json, 'region') ? undefined : json['region'],
|
|
37
37
|
'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
|
|
38
38
|
};
|
|
@@ -46,7 +46,7 @@ function SfvbTrackingProviderConsentToJSON(value) {
|
|
|
46
46
|
return null;
|
|
47
47
|
}
|
|
48
48
|
return {
|
|
49
|
-
'
|
|
49
|
+
'disabled': value.disabled,
|
|
50
50
|
'region': value.region,
|
|
51
51
|
'type': value.type,
|
|
52
52
|
};
|
|
@@ -16,17 +16,17 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface SfvbTrackingProviderEvent {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {
|
|
19
|
+
* True when the event is sent to the provider.
|
|
20
|
+
* @type {boolean}
|
|
21
21
|
* @memberof SfvbTrackingProviderEvent
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
enabled?: boolean;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {
|
|
25
|
+
* AddPaymentInfo, AddToCart, AddToWishlist, CompleteRegistration, InitiateCheckout, Lead, Search or ViewContent.
|
|
26
|
+
* @type {string}
|
|
27
27
|
* @memberof SfvbTrackingProviderEvent
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
name?: string;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
32
|
* Check if a given object implements the SfvbTrackingProviderEvent interface.
|
|
@@ -32,8 +32,8 @@ function SfvbTrackingProviderEventFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
32
32
|
return json;
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
|
+
'enabled': !(0, runtime_1.exists)(json, 'enabled') ? undefined : json['enabled'],
|
|
35
36
|
'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
|
|
36
|
-
'_true': !(0, runtime_1.exists)(json, 'true') ? undefined : json['true'],
|
|
37
37
|
};
|
|
38
38
|
}
|
|
39
39
|
exports.SfvbTrackingProviderEventFromJSONTyped = SfvbTrackingProviderEventFromJSONTyped;
|
|
@@ -45,8 +45,8 @@ function SfvbTrackingProviderEventToJSON(value) {
|
|
|
45
45
|
return null;
|
|
46
46
|
}
|
|
47
47
|
return {
|
|
48
|
+
'enabled': value.enabled,
|
|
48
49
|
'name': value.name,
|
|
49
|
-
'true': value._true,
|
|
50
50
|
};
|
|
51
51
|
}
|
|
52
52
|
exports.SfvbTrackingProviderEventToJSON = SfvbTrackingProviderEventToJSON;
|
|
@@ -81,6 +81,12 @@ export interface SfvbTrackingProviderField {
|
|
|
81
81
|
* @memberof SfvbTrackingProviderField
|
|
82
82
|
*/
|
|
83
83
|
type?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Present only when this storefront can't turn the field on, and why. Turning it off still works.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof SfvbTrackingProviderField
|
|
88
|
+
*/
|
|
89
|
+
unavailable_reason?: string;
|
|
84
90
|
/**
|
|
85
91
|
* The stored value. Booleans are true or false. Null when blank. Never present for a secret.
|
|
86
92
|
* @type {string}
|
|
@@ -43,6 +43,7 @@ function SfvbTrackingProviderFieldFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
43
|
'set': !(0, runtime_1.exists)(json, 'set') ? undefined : json['set'],
|
|
44
44
|
'sink': !(0, runtime_1.exists)(json, 'sink') ? undefined : json['sink'],
|
|
45
45
|
'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
|
|
46
|
+
'unavailable_reason': !(0, runtime_1.exists)(json, 'unavailable_reason') ? undefined : json['unavailable_reason'],
|
|
46
47
|
'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
|
|
47
48
|
'writable': !(0, runtime_1.exists)(json, 'writable') ? undefined : json['writable'],
|
|
48
49
|
};
|
|
@@ -67,6 +68,7 @@ function SfvbTrackingProviderFieldToJSON(value) {
|
|
|
67
68
|
'set': value.set,
|
|
68
69
|
'sink': value.sink,
|
|
69
70
|
'type': value.type,
|
|
71
|
+
'unavailable_reason': value.unavailable_reason,
|
|
70
72
|
'value': value.value,
|
|
71
73
|
'writable': value.writable,
|
|
72
74
|
};
|
package/package.json
CHANGED
|
@@ -62,6 +62,12 @@ export interface SfvbTrackingProvider {
|
|
|
62
62
|
* @memberof SfvbTrackingProvider
|
|
63
63
|
*/
|
|
64
64
|
admin_path?: string;
|
|
65
|
+
/**
|
|
66
|
+
* On a dry run, whether the real write needs an approved tracking_provider.change request.
|
|
67
|
+
* @type {boolean}
|
|
68
|
+
* @memberof SfvbTrackingProvider
|
|
69
|
+
*/
|
|
70
|
+
approval_needed?: boolean;
|
|
65
71
|
/**
|
|
66
72
|
* On a write, each setting it changed, or would change on a dry run. Secrets read only set or cleared.
|
|
67
73
|
* @type {Array<SfvbTrackingChange>}
|
|
@@ -176,6 +182,7 @@ export function SfvbTrackingProviderFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
176
182
|
return {
|
|
177
183
|
|
|
178
184
|
'admin_path': !exists(json, 'admin_path') ? undefined : json['admin_path'],
|
|
185
|
+
'approval_needed': !exists(json, 'approval_needed') ? undefined : json['approval_needed'],
|
|
179
186
|
'changes': !exists(json, 'changes') ? undefined : ((json['changes'] as Array<any>).map(SfvbTrackingChangeFromJSON)),
|
|
180
187
|
'configured': !exists(json, 'configured') ? undefined : json['configured'],
|
|
181
188
|
'consent': !exists(json, 'consent') ? undefined : SfvbTrackingProviderConsentFromJSON(json['consent']),
|
|
@@ -204,6 +211,7 @@ export function SfvbTrackingProviderToJSON(value?: SfvbTrackingProvider | null):
|
|
|
204
211
|
return {
|
|
205
212
|
|
|
206
213
|
'admin_path': value.admin_path,
|
|
214
|
+
'approval_needed': value.approval_needed,
|
|
207
215
|
'changes': value.changes === undefined ? undefined : ((value.changes as Array<any>).map(SfvbTrackingChangeToJSON)),
|
|
208
216
|
'configured': value.configured,
|
|
209
217
|
'consent': SfvbTrackingProviderConsentToJSON(value.consent),
|
|
@@ -24,7 +24,7 @@ export interface SfvbTrackingProviderConsent {
|
|
|
24
24
|
* @type {boolean}
|
|
25
25
|
* @memberof SfvbTrackingProviderConsent
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
disabled?: boolean;
|
|
28
28
|
/**
|
|
29
29
|
* Which shoppers the gate applies to. all, eea or non_us.
|
|
30
30
|
* @type {string}
|
|
@@ -60,7 +60,7 @@ export function SfvbTrackingProviderConsentFromJSONTyped(json: any, ignoreDiscri
|
|
|
60
60
|
}
|
|
61
61
|
return {
|
|
62
62
|
|
|
63
|
-
'
|
|
63
|
+
'disabled': !exists(json, 'disabled') ? undefined : json['disabled'],
|
|
64
64
|
'region': !exists(json, 'region') ? undefined : json['region'],
|
|
65
65
|
'type': !exists(json, 'type') ? undefined : json['type'],
|
|
66
66
|
};
|
|
@@ -75,7 +75,7 @@ export function SfvbTrackingProviderConsentToJSON(value?: SfvbTrackingProviderCo
|
|
|
75
75
|
}
|
|
76
76
|
return {
|
|
77
77
|
|
|
78
|
-
'
|
|
78
|
+
'disabled': value.disabled,
|
|
79
79
|
'region': value.region,
|
|
80
80
|
'type': value.type,
|
|
81
81
|
};
|
|
@@ -20,17 +20,17 @@ import { exists, mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface SfvbTrackingProviderEvent {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {
|
|
23
|
+
* True when the event is sent to the provider.
|
|
24
|
+
* @type {boolean}
|
|
25
25
|
* @memberof SfvbTrackingProviderEvent
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
enabled?: boolean;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {
|
|
29
|
+
* AddPaymentInfo, AddToCart, AddToWishlist, CompleteRegistration, InitiateCheckout, Lead, Search or ViewContent.
|
|
30
|
+
* @type {string}
|
|
31
31
|
* @memberof SfvbTrackingProviderEvent
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
name?: string;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
|
|
@@ -54,8 +54,8 @@ export function SfvbTrackingProviderEventFromJSONTyped(json: any, ignoreDiscrimi
|
|
|
54
54
|
}
|
|
55
55
|
return {
|
|
56
56
|
|
|
57
|
+
'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
|
|
57
58
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
58
|
-
'_true': !exists(json, 'true') ? undefined : json['true'],
|
|
59
59
|
};
|
|
60
60
|
}
|
|
61
61
|
|
|
@@ -68,8 +68,8 @@ export function SfvbTrackingProviderEventToJSON(value?: SfvbTrackingProviderEven
|
|
|
68
68
|
}
|
|
69
69
|
return {
|
|
70
70
|
|
|
71
|
+
'enabled': value.enabled,
|
|
71
72
|
'name': value.name,
|
|
72
|
-
'true': value._true,
|
|
73
73
|
};
|
|
74
74
|
}
|
|
75
75
|
|
|
@@ -85,6 +85,12 @@ export interface SfvbTrackingProviderField {
|
|
|
85
85
|
* @memberof SfvbTrackingProviderField
|
|
86
86
|
*/
|
|
87
87
|
type?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Present only when this storefront can't turn the field on, and why. Turning it off still works.
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof SfvbTrackingProviderField
|
|
92
|
+
*/
|
|
93
|
+
unavailable_reason?: string;
|
|
88
94
|
/**
|
|
89
95
|
* The stored value. Booleans are true or false. Null when blank. Never present for a secret.
|
|
90
96
|
* @type {string}
|
|
@@ -131,6 +137,7 @@ export function SfvbTrackingProviderFieldFromJSONTyped(json: any, ignoreDiscrimi
|
|
|
131
137
|
'set': !exists(json, 'set') ? undefined : json['set'],
|
|
132
138
|
'sink': !exists(json, 'sink') ? undefined : json['sink'],
|
|
133
139
|
'type': !exists(json, 'type') ? undefined : json['type'],
|
|
140
|
+
'unavailable_reason': !exists(json, 'unavailable_reason') ? undefined : json['unavailable_reason'],
|
|
134
141
|
'value': !exists(json, 'value') ? undefined : json['value'],
|
|
135
142
|
'writable': !exists(json, 'writable') ? undefined : json['writable'],
|
|
136
143
|
};
|
|
@@ -156,6 +163,7 @@ export function SfvbTrackingProviderFieldToJSON(value?: SfvbTrackingProviderFiel
|
|
|
156
163
|
'set': value.set,
|
|
157
164
|
'sink': value.sink,
|
|
158
165
|
'type': value.type,
|
|
166
|
+
'unavailable_reason': value.unavailable_reason,
|
|
159
167
|
'value': value.value,
|
|
160
168
|
'writable': value.writable,
|
|
161
169
|
};
|