ultracart_rest_api_v2_typescript 4.1.172 → 4.1.173
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/models/EmailFlow.d.ts +21 -0
- package/dist/models/EmailFlow.js +13 -1
- package/package.json +1 -1
- package/src/models/EmailFlow.ts +27 -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.173
|
|
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.173 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
87
88
|
| 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
88
89
|
| 4.1.171 | 09/23/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.170 | 09/22/2026 | sfvb internal testing |
|
|
@@ -135,6 +135,18 @@ export interface EmailFlow {
|
|
|
135
135
|
* @memberof EmailFlow
|
|
136
136
|
*/
|
|
137
137
|
open_rate_formatted?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Number of days after the last enrollment before a customer may enter this flow again. Only used when reentry_policy is after_days. Maximum 1095.
|
|
140
|
+
* @type {number}
|
|
141
|
+
* @memberof EmailFlow
|
|
142
|
+
*/
|
|
143
|
+
reentry_delay_days?: number;
|
|
144
|
+
/**
|
|
145
|
+
* Whether a customer may enter this flow again after a previous enrollment. anytime (default), after_days (see reentry_delay_days), or never. Enrollment history is kept for 3 years, so never means not within 3 years of the last enrollment.
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof EmailFlow
|
|
148
|
+
*/
|
|
149
|
+
reentry_policy?: EmailFlowReentryPolicyEnum;
|
|
138
150
|
/**
|
|
139
151
|
* Revenue, formatted
|
|
140
152
|
* @type {string}
|
|
@@ -202,6 +214,15 @@ export interface EmailFlow {
|
|
|
202
214
|
*/
|
|
203
215
|
trigger_type?: string;
|
|
204
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* @export
|
|
219
|
+
*/
|
|
220
|
+
export declare const EmailFlowReentryPolicyEnum: {
|
|
221
|
+
readonly Anytime: "anytime";
|
|
222
|
+
readonly AfterDays: "after_days";
|
|
223
|
+
readonly Never: "never";
|
|
224
|
+
};
|
|
225
|
+
export type EmailFlowReentryPolicyEnum = typeof EmailFlowReentryPolicyEnum[keyof typeof EmailFlowReentryPolicyEnum];
|
|
205
226
|
/**
|
|
206
227
|
* Check if a given object implements the EmailFlow interface.
|
|
207
228
|
*/
|
package/dist/models/EmailFlow.js
CHANGED
|
@@ -13,8 +13,16 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.EmailFlowToJSON = exports.EmailFlowFromJSONTyped = exports.EmailFlowFromJSON = exports.instanceOfEmailFlow = void 0;
|
|
16
|
+
exports.EmailFlowToJSON = exports.EmailFlowFromJSONTyped = exports.EmailFlowFromJSON = exports.instanceOfEmailFlow = exports.EmailFlowReentryPolicyEnum = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
exports.EmailFlowReentryPolicyEnum = {
|
|
22
|
+
Anytime: 'anytime',
|
|
23
|
+
AfterDays: 'after_days',
|
|
24
|
+
Never: 'never'
|
|
25
|
+
};
|
|
18
26
|
/**
|
|
19
27
|
* Check if a given object implements the EmailFlow interface.
|
|
20
28
|
*/
|
|
@@ -52,6 +60,8 @@ function EmailFlowFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
60
|
'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
53
61
|
'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
|
|
54
62
|
'open_rate_formatted': !(0, runtime_1.exists)(json, 'open_rate_formatted') ? undefined : json['open_rate_formatted'],
|
|
63
|
+
'reentry_delay_days': !(0, runtime_1.exists)(json, 'reentry_delay_days') ? undefined : json['reentry_delay_days'],
|
|
64
|
+
'reentry_policy': !(0, runtime_1.exists)(json, 'reentry_policy') ? undefined : json['reentry_policy'],
|
|
55
65
|
'revenue_formatted': !(0, runtime_1.exists)(json, 'revenue_formatted') ? undefined : json['revenue_formatted'],
|
|
56
66
|
'revenue_per_customer_formatted': !(0, runtime_1.exists)(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
|
|
57
67
|
'screenshot_large_full_url': !(0, runtime_1.exists)(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
|
|
@@ -94,6 +104,8 @@ function EmailFlowToJSON(value) {
|
|
|
94
104
|
'merchant_id': value.merchant_id,
|
|
95
105
|
'name': value.name,
|
|
96
106
|
'open_rate_formatted': value.open_rate_formatted,
|
|
107
|
+
'reentry_delay_days': value.reentry_delay_days,
|
|
108
|
+
'reentry_policy': value.reentry_policy,
|
|
97
109
|
'revenue_formatted': value.revenue_formatted,
|
|
98
110
|
'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
|
|
99
111
|
'screenshot_large_full_url': value.screenshot_large_full_url,
|
package/package.json
CHANGED
package/src/models/EmailFlow.ts
CHANGED
|
@@ -139,6 +139,18 @@ export interface EmailFlow {
|
|
|
139
139
|
* @memberof EmailFlow
|
|
140
140
|
*/
|
|
141
141
|
open_rate_formatted?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Number of days after the last enrollment before a customer may enter this flow again. Only used when reentry_policy is after_days. Maximum 1095.
|
|
144
|
+
* @type {number}
|
|
145
|
+
* @memberof EmailFlow
|
|
146
|
+
*/
|
|
147
|
+
reentry_delay_days?: number;
|
|
148
|
+
/**
|
|
149
|
+
* Whether a customer may enter this flow again after a previous enrollment. anytime (default), after_days (see reentry_delay_days), or never. Enrollment history is kept for 3 years, so never means not within 3 years of the last enrollment.
|
|
150
|
+
* @type {string}
|
|
151
|
+
* @memberof EmailFlow
|
|
152
|
+
*/
|
|
153
|
+
reentry_policy?: EmailFlowReentryPolicyEnum;
|
|
142
154
|
/**
|
|
143
155
|
* Revenue, formatted
|
|
144
156
|
* @type {string}
|
|
@@ -209,6 +221,17 @@ export interface EmailFlow {
|
|
|
209
221
|
|
|
210
222
|
|
|
211
223
|
|
|
224
|
+
/**
|
|
225
|
+
* @export
|
|
226
|
+
*/
|
|
227
|
+
export const EmailFlowReentryPolicyEnum = {
|
|
228
|
+
Anytime: 'anytime',
|
|
229
|
+
AfterDays: 'after_days',
|
|
230
|
+
Never: 'never'
|
|
231
|
+
} as const;
|
|
232
|
+
export type EmailFlowReentryPolicyEnum = typeof EmailFlowReentryPolicyEnum[keyof typeof EmailFlowReentryPolicyEnum];
|
|
233
|
+
|
|
234
|
+
|
|
212
235
|
/**
|
|
213
236
|
* Check if a given object implements the EmailFlow interface.
|
|
214
237
|
*/
|
|
@@ -248,6 +271,8 @@ export function EmailFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean):
|
|
|
248
271
|
'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
249
272
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
250
273
|
'open_rate_formatted': !exists(json, 'open_rate_formatted') ? undefined : json['open_rate_formatted'],
|
|
274
|
+
'reentry_delay_days': !exists(json, 'reentry_delay_days') ? undefined : json['reentry_delay_days'],
|
|
275
|
+
'reentry_policy': !exists(json, 'reentry_policy') ? undefined : json['reentry_policy'],
|
|
251
276
|
'revenue_formatted': !exists(json, 'revenue_formatted') ? undefined : json['revenue_formatted'],
|
|
252
277
|
'revenue_per_customer_formatted': !exists(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
|
|
253
278
|
'screenshot_large_full_url': !exists(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
|
|
@@ -291,6 +316,8 @@ export function EmailFlowToJSON(value?: EmailFlow | null): any {
|
|
|
291
316
|
'merchant_id': value.merchant_id,
|
|
292
317
|
'name': value.name,
|
|
293
318
|
'open_rate_formatted': value.open_rate_formatted,
|
|
319
|
+
'reentry_delay_days': value.reentry_delay_days,
|
|
320
|
+
'reentry_policy': value.reentry_policy,
|
|
294
321
|
'revenue_formatted': value.revenue_formatted,
|
|
295
322
|
'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
|
|
296
323
|
'screenshot_large_full_url': value.screenshot_large_full_url,
|