@wix/auto_sdk_ecom_discount-rules 1.0.0 → 1.0.2
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/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +257 -58
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +1 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts +277 -61
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +1 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +257 -58
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +1 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts +277 -61
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +257 -58
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts +277 -61
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +1 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +257 -58
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +1 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts +277 -61
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface DiscountRule {
|
|
2
2
|
/**
|
|
3
3
|
* Discount rule ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -26,7 +27,11 @@ export interface DiscountRule {
|
|
|
26
27
|
* Default: `true`
|
|
27
28
|
*/
|
|
28
29
|
active?: boolean | null;
|
|
29
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Discount rule name.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 50
|
|
34
|
+
*/
|
|
30
35
|
name?: string | null;
|
|
31
36
|
/**
|
|
32
37
|
* Discount rule trigger.
|
|
@@ -104,7 +109,11 @@ export interface Scope extends ScopeScopeItemsOneOf {
|
|
|
104
109
|
catalogItemFilter?: CatalogItemFilter;
|
|
105
110
|
/** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
|
|
106
111
|
customFilter?: CustomFilter;
|
|
107
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* Scope ID.
|
|
114
|
+
* @minLength 1
|
|
115
|
+
* @maxLength 100
|
|
116
|
+
*/
|
|
108
117
|
_id?: string;
|
|
109
118
|
/** Scope type. */
|
|
110
119
|
type?: ScopeType;
|
|
@@ -124,13 +133,24 @@ export declare enum ScopeType {
|
|
|
124
133
|
CUSTOM_FILTER = "CUSTOM_FILTER"
|
|
125
134
|
}
|
|
126
135
|
export interface CatalogItemFilter {
|
|
127
|
-
/**
|
|
136
|
+
/**
|
|
137
|
+
* Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`.
|
|
138
|
+
* @format GUID
|
|
139
|
+
*/
|
|
128
140
|
catalogAppId?: string;
|
|
129
|
-
/**
|
|
141
|
+
/**
|
|
142
|
+
* ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores.
|
|
143
|
+
* @minLength 1
|
|
144
|
+
* @maxLength 36
|
|
145
|
+
* @maxSize 50
|
|
146
|
+
*/
|
|
130
147
|
catalogItemIds?: string[];
|
|
131
148
|
}
|
|
132
149
|
export interface CustomFilter {
|
|
133
|
-
/**
|
|
150
|
+
/**
|
|
151
|
+
* Custom filter app ID, when relevant.
|
|
152
|
+
* @format GUID
|
|
153
|
+
*/
|
|
134
154
|
appId?: string;
|
|
135
155
|
/**
|
|
136
156
|
* Custom filter in `{ "key": "value" }` form.
|
|
@@ -140,33 +160,66 @@ export interface CustomFilter {
|
|
|
140
160
|
params?: Record<string, any> | null;
|
|
141
161
|
}
|
|
142
162
|
export interface And {
|
|
143
|
-
/**
|
|
163
|
+
/**
|
|
164
|
+
* List of triggers to have an "AND" operator between their results.
|
|
165
|
+
* @minSize 2
|
|
166
|
+
* @maxSize 5
|
|
167
|
+
*/
|
|
144
168
|
triggers?: DiscountTrigger[];
|
|
145
169
|
}
|
|
146
170
|
export interface Or {
|
|
147
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* List of triggers to have an "OR" operator between their results.
|
|
173
|
+
* @minSize 2
|
|
174
|
+
* @maxSize 5
|
|
175
|
+
*/
|
|
148
176
|
triggers?: DiscountTrigger[];
|
|
149
177
|
}
|
|
150
178
|
export interface Custom {
|
|
151
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Trigger ID.
|
|
181
|
+
* @minLength 1
|
|
182
|
+
* @maxLength 100
|
|
183
|
+
*/
|
|
152
184
|
_id?: string;
|
|
153
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* ID of the app that created the trigger.
|
|
187
|
+
* @format GUID
|
|
188
|
+
*/
|
|
154
189
|
appId?: string;
|
|
155
190
|
}
|
|
156
191
|
export interface SubtotalRange {
|
|
157
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Relevant scopes for `"SPECIFIC_ITEMS"` target type.
|
|
194
|
+
* @maxSize 50
|
|
195
|
+
*/
|
|
158
196
|
scopes?: Scope[];
|
|
159
|
-
/**
|
|
197
|
+
/**
|
|
198
|
+
* Minimum subtotal price (inclusive).
|
|
199
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
|
|
200
|
+
*/
|
|
160
201
|
from?: string | null;
|
|
161
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Maximum subtotal price (inclusive).
|
|
204
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
|
|
205
|
+
*/
|
|
162
206
|
to?: string | null;
|
|
163
207
|
}
|
|
164
208
|
export interface ItemQuantityRange {
|
|
165
|
-
/**
|
|
209
|
+
/**
|
|
210
|
+
* Relevant scopes for `"SPECIFIC_ITEMS"` target type.
|
|
211
|
+
* @maxSize 50
|
|
212
|
+
*/
|
|
166
213
|
scopes?: Scope[];
|
|
167
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Minimum item quantity (inclusive).
|
|
216
|
+
* @min 1
|
|
217
|
+
*/
|
|
168
218
|
from?: number | null;
|
|
169
|
-
/**
|
|
219
|
+
/**
|
|
220
|
+
* Maximum item quantity (inclusive).
|
|
221
|
+
* @min 1
|
|
222
|
+
*/
|
|
170
223
|
to?: number | null;
|
|
171
224
|
}
|
|
172
225
|
export declare enum TriggerType {
|
|
@@ -189,15 +242,29 @@ export interface ActiveTimeInfo {
|
|
|
189
242
|
end?: Date | null;
|
|
190
243
|
}
|
|
191
244
|
export interface Discounts {
|
|
192
|
-
/**
|
|
245
|
+
/**
|
|
246
|
+
* Discounts.
|
|
247
|
+
* @minSize 1
|
|
248
|
+
* @maxSize 1
|
|
249
|
+
*/
|
|
193
250
|
values?: Discount[];
|
|
194
251
|
}
|
|
195
252
|
export interface Discount extends DiscountDiscountOneOf {
|
|
196
|
-
/**
|
|
253
|
+
/**
|
|
254
|
+
* Percentage to discount from original price.
|
|
255
|
+
* @min 0.1
|
|
256
|
+
* @max 100
|
|
257
|
+
*/
|
|
197
258
|
percentage?: number;
|
|
198
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* Amount to discount from original price.
|
|
261
|
+
* @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
|
|
262
|
+
*/
|
|
199
263
|
fixedAmount?: string;
|
|
200
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* Fixed price. Line item will be fixed to this price.
|
|
266
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
|
|
267
|
+
*/
|
|
201
268
|
fixedPrice?: string;
|
|
202
269
|
/**
|
|
203
270
|
* Discount target.
|
|
@@ -218,11 +285,21 @@ export interface Discount extends DiscountDiscountOneOf {
|
|
|
218
285
|
}
|
|
219
286
|
/** @oneof */
|
|
220
287
|
export interface DiscountDiscountOneOf {
|
|
221
|
-
/**
|
|
288
|
+
/**
|
|
289
|
+
* Percentage to discount from original price.
|
|
290
|
+
* @min 0.1
|
|
291
|
+
* @max 100
|
|
292
|
+
*/
|
|
222
293
|
percentage?: number;
|
|
223
|
-
/**
|
|
294
|
+
/**
|
|
295
|
+
* Amount to discount from original price.
|
|
296
|
+
* @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
|
|
297
|
+
*/
|
|
224
298
|
fixedAmount?: string;
|
|
225
|
-
/**
|
|
299
|
+
/**
|
|
300
|
+
* Fixed price. Line item will be fixed to this price.
|
|
301
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
|
|
302
|
+
*/
|
|
226
303
|
fixedPrice?: string;
|
|
227
304
|
}
|
|
228
305
|
export declare enum Type {
|
|
@@ -232,7 +309,11 @@ export declare enum Type {
|
|
|
232
309
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS"
|
|
233
310
|
}
|
|
234
311
|
export interface SpecificItemsInfo {
|
|
235
|
-
/**
|
|
312
|
+
/**
|
|
313
|
+
* All associated scopes for `"SPECIFIC_ITEMS"` target type.
|
|
314
|
+
* @minSize 1
|
|
315
|
+
* @maxSize 50
|
|
316
|
+
*/
|
|
236
317
|
scopes?: Scope[];
|
|
237
318
|
}
|
|
238
319
|
export declare enum DiscountType {
|
|
@@ -254,31 +335,53 @@ export interface BuyXGetYInfo {
|
|
|
254
335
|
* For example, when the value of `limit` is `2`, with a "2+1" sale on all items, the following logic applies:
|
|
255
336
|
* + Buy 2 get 1, buy 3 get 1.
|
|
256
337
|
* + Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on.
|
|
338
|
+
* @min 1
|
|
257
339
|
*/
|
|
258
340
|
limit?: number | null;
|
|
259
341
|
}
|
|
260
342
|
export interface CustomerBuy extends CustomerBuyConditionOneOf {
|
|
261
|
-
/**
|
|
343
|
+
/**
|
|
344
|
+
* Minimum number of items the customer must add to the cart to be eligible for a discount.
|
|
345
|
+
* @min 1
|
|
346
|
+
*/
|
|
262
347
|
minimumQuantity?: number;
|
|
263
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* Minimum price the customer must add to the cart to be eligible for a discount.
|
|
350
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
351
|
+
*/
|
|
264
352
|
minimumSpend?: string | null;
|
|
265
|
-
/**
|
|
353
|
+
/**
|
|
354
|
+
* Scopes of the items that must be added to the cart to enable the discount.
|
|
355
|
+
* @minSize 1
|
|
356
|
+
* @maxSize 50
|
|
357
|
+
*/
|
|
266
358
|
scopes?: Scope[];
|
|
267
359
|
}
|
|
268
360
|
/** @oneof */
|
|
269
361
|
export interface CustomerBuyConditionOneOf {
|
|
270
|
-
/**
|
|
362
|
+
/**
|
|
363
|
+
* Minimum number of items the customer must add to the cart to be eligible for a discount.
|
|
364
|
+
* @min 1
|
|
365
|
+
*/
|
|
271
366
|
minimumQuantity?: number;
|
|
272
|
-
/**
|
|
367
|
+
/**
|
|
368
|
+
* Minimum price the customer must add to the cart to be eligible for a discount.
|
|
369
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
370
|
+
*/
|
|
273
371
|
minimumSpend?: string | null;
|
|
274
372
|
}
|
|
275
373
|
export interface CustomerGet {
|
|
276
374
|
/**
|
|
277
375
|
* Exact number of items in the cart that will be discounted.
|
|
278
376
|
* If the cart contains fewer items than the value of quantity, the discount will not apply.
|
|
377
|
+
* @min 1
|
|
279
378
|
*/
|
|
280
379
|
quantity?: number;
|
|
281
|
-
/**
|
|
380
|
+
/**
|
|
381
|
+
* Scopes of the items that will be discounted.
|
|
382
|
+
* @minSize 1
|
|
383
|
+
* @maxSize 50
|
|
384
|
+
*/
|
|
282
385
|
scopes?: Scope[];
|
|
283
386
|
}
|
|
284
387
|
export declare enum Status {
|
|
@@ -301,11 +404,17 @@ export interface DiscountSettings {
|
|
|
301
404
|
* Default: `false`
|
|
302
405
|
*/
|
|
303
406
|
includeSubscription?: boolean | null;
|
|
304
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* Maximum total number of uses allowed for the discount rule.
|
|
409
|
+
* @min 1
|
|
410
|
+
* @max 2147483646
|
|
411
|
+
*/
|
|
305
412
|
usageLimit?: number | null;
|
|
306
413
|
/**
|
|
307
414
|
* The usage limit per user per discount.
|
|
308
415
|
* When not provided, this setting will not apply.
|
|
416
|
+
* @min 1
|
|
417
|
+
* @max 2147483646
|
|
309
418
|
*/
|
|
310
419
|
usageLimitPerUser?: number | null;
|
|
311
420
|
}
|
|
@@ -337,7 +446,10 @@ export interface CreateDiscountRuleResponse {
|
|
|
337
446
|
discountRule?: DiscountRule;
|
|
338
447
|
}
|
|
339
448
|
export interface GetDiscountRuleRequest {
|
|
340
|
-
/**
|
|
449
|
+
/**
|
|
450
|
+
* ID of the discount rule to retrieve.
|
|
451
|
+
* @format GUID
|
|
452
|
+
*/
|
|
341
453
|
discountRuleId: string;
|
|
342
454
|
}
|
|
343
455
|
export interface GetDiscountRuleResponse {
|
|
@@ -353,7 +465,10 @@ export interface UpdateDiscountRuleResponse {
|
|
|
353
465
|
discountRule?: DiscountRule;
|
|
354
466
|
}
|
|
355
467
|
export interface DeleteDiscountRuleRequest {
|
|
356
|
-
/**
|
|
468
|
+
/**
|
|
469
|
+
* ID of the discount rule to delete.
|
|
470
|
+
* @format GUID
|
|
471
|
+
*/
|
|
357
472
|
discountRuleId: string;
|
|
358
473
|
}
|
|
359
474
|
export interface DeleteDiscountRuleResponse {
|
|
@@ -380,7 +495,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
380
495
|
cursorPaging?: CursorPaging;
|
|
381
496
|
}
|
|
382
497
|
export interface Sorting {
|
|
383
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* Name of the field to sort by.
|
|
500
|
+
* @maxLength 512
|
|
501
|
+
*/
|
|
384
502
|
fieldName?: string;
|
|
385
503
|
/** Sort order. */
|
|
386
504
|
order?: SortOrder;
|
|
@@ -390,19 +508,26 @@ export declare enum SortOrder {
|
|
|
390
508
|
DESC = "DESC"
|
|
391
509
|
}
|
|
392
510
|
export interface PlatformPaging {
|
|
393
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* Number of items to load.
|
|
513
|
+
* @max 100
|
|
514
|
+
*/
|
|
394
515
|
limit?: number | null;
|
|
395
516
|
/** Number of items to skip in the current sort order. */
|
|
396
517
|
offset?: number | null;
|
|
397
518
|
}
|
|
398
519
|
export interface CursorPaging {
|
|
399
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* Maximum number of items to return in the results.
|
|
522
|
+
* @max 100
|
|
523
|
+
*/
|
|
400
524
|
limit?: number | null;
|
|
401
525
|
/**
|
|
402
526
|
* Pointer to the next or previous page in the list of results.
|
|
403
527
|
*
|
|
404
528
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
405
529
|
* Not relevant for the first request.
|
|
530
|
+
* @maxLength 16000
|
|
406
531
|
*/
|
|
407
532
|
cursor?: string | null;
|
|
408
533
|
}
|
|
@@ -423,30 +548,56 @@ export interface PlatformPagingMetadata {
|
|
|
423
548
|
cursors?: Cursors;
|
|
424
549
|
}
|
|
425
550
|
export interface Cursors {
|
|
426
|
-
/**
|
|
551
|
+
/**
|
|
552
|
+
* Cursor string pointing to the next page in the list of results.
|
|
553
|
+
* @maxLength 16000
|
|
554
|
+
*/
|
|
427
555
|
next?: string | null;
|
|
428
|
-
/**
|
|
556
|
+
/**
|
|
557
|
+
* Cursor pointing to the previous page in the list of results.
|
|
558
|
+
* @maxLength 16000
|
|
559
|
+
*/
|
|
429
560
|
prev?: string | null;
|
|
430
561
|
}
|
|
431
562
|
export interface GetAppliedDiscountsRequest {
|
|
432
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* Line items for which to check for discount rules.
|
|
565
|
+
* @maxSize 1000
|
|
566
|
+
*/
|
|
433
567
|
lineItems?: LineItem[];
|
|
434
|
-
/**
|
|
568
|
+
/**
|
|
569
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
570
|
+
* @format GUID
|
|
571
|
+
*/
|
|
435
572
|
purchaseFlowId?: string | null;
|
|
436
573
|
}
|
|
437
574
|
export interface LineItem {
|
|
438
|
-
/**
|
|
575
|
+
/**
|
|
576
|
+
* Line item ID.
|
|
577
|
+
* @minLength 1
|
|
578
|
+
* @maxLength 100
|
|
579
|
+
*/
|
|
439
580
|
_id?: string;
|
|
440
|
-
/**
|
|
581
|
+
/**
|
|
582
|
+
* Line item quantity.
|
|
583
|
+
* @max 100000
|
|
584
|
+
*/
|
|
441
585
|
quantity?: number | null;
|
|
442
586
|
/** Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration). */
|
|
443
587
|
catalogReference?: CatalogReference;
|
|
444
|
-
/**
|
|
588
|
+
/**
|
|
589
|
+
* Line item price.
|
|
590
|
+
* @decimalValue options { gte:0 }
|
|
591
|
+
*/
|
|
445
592
|
price?: string;
|
|
446
593
|
}
|
|
447
594
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
448
595
|
export interface CatalogReference {
|
|
449
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* ID of the item within the catalog it belongs to.
|
|
598
|
+
* @minLength 1
|
|
599
|
+
* @maxLength 36
|
|
600
|
+
*/
|
|
450
601
|
catalogItemId?: string;
|
|
451
602
|
/**
|
|
452
603
|
* ID of the app providing the catalog.
|
|
@@ -457,12 +608,13 @@ export interface CatalogReference {
|
|
|
457
608
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
458
609
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
459
610
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
611
|
+
* @minLength 1
|
|
460
612
|
*/
|
|
461
613
|
appId?: string;
|
|
462
614
|
/**
|
|
463
615
|
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
464
616
|
*
|
|
465
|
-
* For products and variants from a Wix Stores catalog, learn more about
|
|
617
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
466
618
|
*/
|
|
467
619
|
options?: Record<string, any> | null;
|
|
468
620
|
}
|
|
@@ -473,13 +625,20 @@ export interface GetAppliedDiscountsResponse {
|
|
|
473
625
|
export interface AppliedDiscount {
|
|
474
626
|
/** Discount type. */
|
|
475
627
|
discountType?: Type;
|
|
476
|
-
/**
|
|
628
|
+
/**
|
|
629
|
+
* IDs of line items the discount applies to, in GUID format.
|
|
630
|
+
* @format GUID
|
|
631
|
+
* @maxSize 1000
|
|
632
|
+
*/
|
|
477
633
|
lineItemIds?: string[];
|
|
478
634
|
/** Applied discount rule. */
|
|
479
635
|
appliedDiscountRule?: AppliedDiscountRule;
|
|
480
636
|
}
|
|
481
637
|
export interface AppliedDiscountRule {
|
|
482
|
-
/**
|
|
638
|
+
/**
|
|
639
|
+
* Applied discount rule ID.
|
|
640
|
+
* @format GUID
|
|
641
|
+
*/
|
|
483
642
|
_id?: string;
|
|
484
643
|
/** Discount rule name. */
|
|
485
644
|
name?: DiscountRuleName;
|
|
@@ -489,21 +648,31 @@ export interface AppliedDiscountRule {
|
|
|
489
648
|
discountRuleType?: DiscountType;
|
|
490
649
|
}
|
|
491
650
|
export interface DiscountRuleName {
|
|
492
|
-
/**
|
|
651
|
+
/**
|
|
652
|
+
* Original discount rule name (in site's default language).
|
|
653
|
+
* @minLength 1
|
|
654
|
+
* @maxLength 256
|
|
655
|
+
*/
|
|
493
656
|
original?: string;
|
|
494
657
|
/**
|
|
495
658
|
* Translated discount rule name according to buyer language.
|
|
496
659
|
*
|
|
497
660
|
* Default: `original`
|
|
661
|
+
* @minLength 1
|
|
662
|
+
* @maxLength 500
|
|
498
663
|
*/
|
|
499
664
|
translated?: string | null;
|
|
500
665
|
}
|
|
501
666
|
export interface MultiCurrencyPrice {
|
|
502
|
-
/**
|
|
667
|
+
/**
|
|
668
|
+
* Amount.
|
|
669
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
670
|
+
*/
|
|
503
671
|
amount?: string;
|
|
504
672
|
/**
|
|
505
673
|
* Converted amount.
|
|
506
674
|
* @readonly
|
|
675
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
507
676
|
*/
|
|
508
677
|
convertedAmount?: string;
|
|
509
678
|
/**
|
|
@@ -594,9 +763,15 @@ export interface DiscountRuleUsageLimitReached {
|
|
|
594
763
|
rule?: DiscountRule;
|
|
595
764
|
}
|
|
596
765
|
export interface MessageEnvelope {
|
|
597
|
-
/**
|
|
766
|
+
/**
|
|
767
|
+
* App instance ID.
|
|
768
|
+
* @format GUID
|
|
769
|
+
*/
|
|
598
770
|
instanceId?: string | null;
|
|
599
|
-
/**
|
|
771
|
+
/**
|
|
772
|
+
* Event type.
|
|
773
|
+
* @maxLength 150
|
|
774
|
+
*/
|
|
600
775
|
eventType?: string;
|
|
601
776
|
/** The identification type and identity data. */
|
|
602
777
|
identity?: IdentificationData;
|
|
@@ -604,26 +779,50 @@ export interface MessageEnvelope {
|
|
|
604
779
|
data?: string;
|
|
605
780
|
}
|
|
606
781
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
607
|
-
/**
|
|
782
|
+
/**
|
|
783
|
+
* ID of a site visitor that has not logged in to the site.
|
|
784
|
+
* @format GUID
|
|
785
|
+
*/
|
|
608
786
|
anonymousVisitorId?: string;
|
|
609
|
-
/**
|
|
787
|
+
/**
|
|
788
|
+
* ID of a site visitor that has logged in to the site.
|
|
789
|
+
* @format GUID
|
|
790
|
+
*/
|
|
610
791
|
memberId?: string;
|
|
611
|
-
/**
|
|
792
|
+
/**
|
|
793
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
794
|
+
* @format GUID
|
|
795
|
+
*/
|
|
612
796
|
wixUserId?: string;
|
|
613
|
-
/**
|
|
797
|
+
/**
|
|
798
|
+
* ID of an app.
|
|
799
|
+
* @format GUID
|
|
800
|
+
*/
|
|
614
801
|
appId?: string;
|
|
615
802
|
/** @readonly */
|
|
616
803
|
identityType?: WebhookIdentityType;
|
|
617
804
|
}
|
|
618
805
|
/** @oneof */
|
|
619
806
|
export interface IdentificationDataIdOneOf {
|
|
620
|
-
/**
|
|
807
|
+
/**
|
|
808
|
+
* ID of a site visitor that has not logged in to the site.
|
|
809
|
+
* @format GUID
|
|
810
|
+
*/
|
|
621
811
|
anonymousVisitorId?: string;
|
|
622
|
-
/**
|
|
812
|
+
/**
|
|
813
|
+
* ID of a site visitor that has logged in to the site.
|
|
814
|
+
* @format GUID
|
|
815
|
+
*/
|
|
623
816
|
memberId?: string;
|
|
624
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
819
|
+
* @format GUID
|
|
820
|
+
*/
|
|
625
821
|
wixUserId?: string;
|
|
626
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* ID of an app.
|
|
824
|
+
* @format GUID
|
|
825
|
+
*/
|
|
627
826
|
appId?: string;
|
|
628
827
|
}
|
|
629
828
|
export declare enum WebhookIdentityType {
|
|
@@ -703,9 +902,15 @@ export interface QueryDiscountRulesResponseNonNullableFields {
|
|
|
703
902
|
discountRules: DiscountRuleNonNullableFields[];
|
|
704
903
|
}
|
|
705
904
|
export interface BaseEventMetadata {
|
|
706
|
-
/**
|
|
905
|
+
/**
|
|
906
|
+
* App instance ID.
|
|
907
|
+
* @format GUID
|
|
908
|
+
*/
|
|
707
909
|
instanceId?: string | null;
|
|
708
|
-
/**
|
|
910
|
+
/**
|
|
911
|
+
* Event type.
|
|
912
|
+
* @maxLength 150
|
|
913
|
+
*/
|
|
709
914
|
eventType?: string;
|
|
710
915
|
/** The identification type and identity data. */
|
|
711
916
|
identity?: IdentificationData;
|
|
@@ -767,6 +972,8 @@ export interface DiscountRuleCreatedEnvelope {
|
|
|
767
972
|
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
768
973
|
* @webhook
|
|
769
974
|
* @eventType wix.ecom.discounts.v1.discount_rule_created
|
|
975
|
+
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
976
|
+
* @slug created
|
|
770
977
|
*/
|
|
771
978
|
export declare function onDiscountRuleCreated(handler: (event: DiscountRuleCreatedEnvelope) => void | Promise<void>): void;
|
|
772
979
|
export interface DiscountRuleDeletedEnvelope {
|
|
@@ -787,6 +994,8 @@ export interface DiscountRuleDeletedEnvelope {
|
|
|
787
994
|
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
788
995
|
* @webhook
|
|
789
996
|
* @eventType wix.ecom.discounts.v1.discount_rule_deleted
|
|
997
|
+
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
998
|
+
* @slug deleted
|
|
790
999
|
*/
|
|
791
1000
|
export declare function onDiscountRuleDeleted(handler: (event: DiscountRuleDeletedEnvelope) => void | Promise<void>): void;
|
|
792
1001
|
export interface DiscountRuleUpdatedEnvelope {
|
|
@@ -808,6 +1017,8 @@ export interface DiscountRuleUpdatedEnvelope {
|
|
|
808
1017
|
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
809
1018
|
* @webhook
|
|
810
1019
|
* @eventType wix.ecom.discounts.v1.discount_rule_updated
|
|
1020
|
+
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
1021
|
+
* @slug updated
|
|
811
1022
|
*/
|
|
812
1023
|
export declare function onDiscountRuleUpdated(handler: (event: DiscountRuleUpdatedEnvelope) => void | Promise<void>): void;
|
|
813
1024
|
/**
|
|
@@ -885,6 +1096,7 @@ export declare function updateDiscountRule(_id: string | null, discountRule: Upd
|
|
|
885
1096
|
export interface UpdateDiscountRule {
|
|
886
1097
|
/**
|
|
887
1098
|
* Discount rule ID.
|
|
1099
|
+
* @format GUID
|
|
888
1100
|
* @readonly
|
|
889
1101
|
*/
|
|
890
1102
|
_id?: string | null;
|
|
@@ -910,7 +1122,11 @@ export interface UpdateDiscountRule {
|
|
|
910
1122
|
* Default: `true`
|
|
911
1123
|
*/
|
|
912
1124
|
active?: boolean | null;
|
|
913
|
-
/**
|
|
1125
|
+
/**
|
|
1126
|
+
* Discount rule name.
|
|
1127
|
+
* @minLength 1
|
|
1128
|
+
* @maxLength 50
|
|
1129
|
+
*/
|
|
914
1130
|
name?: string | null;
|
|
915
1131
|
/**
|
|
916
1132
|
* Discount rule trigger.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-discounts-v1-discount-rule-discount-rules.universal.js","sourceRoot":"","sources":["../../../src/ecom-discounts-v1-discount-rule-discount-rules.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,wCAAwC,MAAM,0DAA0D,CAAC;
|
|
1
|
+
{"version":3,"file":"ecom-discounts-v1-discount-rule-discount-rules.universal.js","sourceRoot":"","sources":["../../../src/ecom-discounts-v1-discount-rule-discount-rules.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,wCAAwC,MAAM,0DAA0D,CAAC;AAuIrH,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,6BAA6B;IAC7B,0CAA6B,CAAA;IAC7B,uCAAuC;IACvC,4CAA+B,CAAA;AACjC,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAmGD,MAAM,CAAN,IAAY,WAYX;AAZD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,mGAAmG;IACnG,0BAAW,CAAA;IACX,oEAAoE;IACpE,gDAAiC,CAAA;IACjC,sFAAsF;IACtF,0DAA2C,CAAA;IAC3C,6DAA6D;IAC7D,gCAAiB,CAAA;IACjB,+CAA+C;IAC/C,wBAAS,CAAA;AACX,CAAC,EAZW,WAAW,KAAX,WAAW,QAYtB;AAyED,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,iCAAiC;IACjC,+BAAuB,CAAA;IACvB,6CAA6C;IAC7C,yCAAiC,CAAA;AACnC,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf;AAWD,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,4CAA4C;IAC5C,yCAAyB,CAAA;IACzB,wCAAwC;IACxC,6CAA6B,CAAA;IAC7B,yCAAyC;IACzC,2CAA2B,CAAA;AAC7B,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAiED,MAAM,CAAN,IAAY,MASX;AATD,WAAY,MAAM;IAChB,kCAAkC;IAClC,iCAAuB,CAAA;IACvB,2BAA2B;IAC3B,uBAAa,CAAA;IACb,mEAAmE;IACnE,6BAAmB,CAAA;IACnB,8DAA8D;IAC9D,6BAAmB,CAAA;AACrB,CAAC,EATW,MAAM,KAAN,MAAM,QASjB;AA2BD,oCAAoC;AACpC,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,iDAAiD;IACjD,6CAAuB,CAAA;IACvB,8DAA8D;IAC9D,+DAAyC,CAAA;AAC3C,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B;AA2FD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAwVD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAqPD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,YAA0B;IAE1B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,YAAY,EAAE,YAAY;KAC3B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAa,CAAC;IAC7E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;YAClD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,cAAsB;IAEtB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAa,CAAC;IAC7E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAkB,EAClB,YAAgC;IAEhC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,YAAY,EAAE,EAAE,GAAG,YAAY,EAAE,EAAE,EAAE,GAAG,EAAE;KAC3C,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAa,CAAC;IAC7E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;YAChD,wBAAwB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACvD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,EAAE,cAAc,CAAC,CACxB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAoED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,cAAsB;IAEtB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,kBAAkB;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,YAAY,CAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAkC,EAAE,EAAE;YACjD,MAAM,OAAO,GACX,wCAAwC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAyC,EAAE,EAAE;YAChE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA6C,CAAC;YACrE,OAAO,qCAAqC,CAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EACpB,IAAI,GACqC,EAAE,EAAE;YAC7C,MAAM,eAAe,GAAG,uCAAuC,CAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,aAAa;gBACrC,cAAc,EAAE,eAAe,EAAE,cAAc;aAChD,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC"}
|