@wix/auto_sdk_ecom_discount-rules 1.0.15 → 1.0.17
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/{internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts → ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.d.mts} +86 -282
- package/build/{cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts → ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.d.ts} +86 -282
- package/build/index.d.mts +98 -0
- package/build/index.d.ts +98 -0
- package/build/index.js +609 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +570 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts → ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.d.mts} +86 -282
- package/build/{es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.d.ts → internal/ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.d.ts} +86 -282
- package/build/internal/index.d.mts +98 -0
- package/build/internal/index.d.ts +98 -0
- package/build/internal/index.js +609 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +570 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +484 -0
- package/build/internal/meta.d.ts +484 -0
- package/build/internal/meta.js +352 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +321 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +484 -0
- package/build/meta.d.ts +484 -0
- package/build/meta.js +352 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +321 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.d.ts +0 -25
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.js +0 -36
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.d.ts +0 -48
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.js +0 -271
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.d.ts +0 -23
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js +0 -123
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.d.ts +0 -80
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.js +0 -98
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +0 -831
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js +0 -76
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +0 -1
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js +0 -371
- package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.d.ts +0 -25
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.js +0 -25
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.js.map +0 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.d.ts +0 -48
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.js +0 -263
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.js.map +0 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.d.ts +0 -23
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js +0 -92
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js.map +0 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.d.ts +0 -80
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.js +0 -82
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.js.map +0 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +0 -831
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js +0 -73
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +0 -1
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js +0 -340
- package/build/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.d.ts +0 -25
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.js +0 -36
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.d.ts +0 -48
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.js +0 -271
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.d.ts +0 -23
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js +0 -123
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.d.ts +0 -80
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.js +0 -98
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +0 -831
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js +0 -76
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js +0 -371
- package/build/internal/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.d.ts +0 -25
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.js +0 -25
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.context.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.d.ts +0 -48
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.js +0 -263
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.http.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.d.ts +0 -23
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js +0 -92
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.meta.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.d.ts +0 -80
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.js +0 -82
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.public.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts +0 -831
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js +0 -73
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map +0 -1
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js +0 -340
- package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface DiscountRule {
|
|
1
|
+
interface DiscountRule {
|
|
3
2
|
/**
|
|
4
3
|
* Discount rule ID.
|
|
5
4
|
* @format GUID
|
|
@@ -65,7 +64,7 @@ export interface DiscountRule {
|
|
|
65
64
|
usageCount?: number;
|
|
66
65
|
}
|
|
67
66
|
/** DiscountTrigger - description of a set of conditions, that if met, will trigger the associated rule actions */
|
|
68
|
-
|
|
67
|
+
interface DiscountTrigger extends DiscountTriggerTriggerOneOf {
|
|
69
68
|
/** Chain multiple triggers with the `and` operator. */
|
|
70
69
|
and?: And;
|
|
71
70
|
/** Chain multiple triggers with the `or` operator. */
|
|
@@ -87,7 +86,7 @@ export interface DiscountTrigger extends DiscountTriggerTriggerOneOf {
|
|
|
87
86
|
triggerType?: TriggerTypeWithLiterals;
|
|
88
87
|
}
|
|
89
88
|
/** @oneof */
|
|
90
|
-
|
|
89
|
+
interface DiscountTriggerTriggerOneOf {
|
|
91
90
|
/** Chain multiple triggers with the `and` operator. */
|
|
92
91
|
and?: And;
|
|
93
92
|
/** Chain multiple triggers with the `or` operator. */
|
|
@@ -105,7 +104,7 @@ export interface DiscountTriggerTriggerOneOf {
|
|
|
105
104
|
* 2. Specific catalog item - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id` + `catalog_item_ids`
|
|
106
105
|
* 3. External catalog filter - type = CUSTOM_FILTER, CustomFilter with 'app_id' + 'params'
|
|
107
106
|
*/
|
|
108
|
-
|
|
107
|
+
interface Scope extends ScopeScopeItemsOneOf {
|
|
109
108
|
/** Catalog item filter. Must be passed with `type."CATALOG_ITEM"`. */
|
|
110
109
|
catalogItemFilter?: CatalogItemFilter;
|
|
111
110
|
/** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
|
|
@@ -120,13 +119,13 @@ export interface Scope extends ScopeScopeItemsOneOf {
|
|
|
120
119
|
type?: ScopeTypeWithLiterals;
|
|
121
120
|
}
|
|
122
121
|
/** @oneof */
|
|
123
|
-
|
|
122
|
+
interface ScopeScopeItemsOneOf {
|
|
124
123
|
/** Catalog item filter. Must be passed with `type."CATALOG_ITEM"`. */
|
|
125
124
|
catalogItemFilter?: CatalogItemFilter;
|
|
126
125
|
/** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
|
|
127
126
|
customFilter?: CustomFilter;
|
|
128
127
|
}
|
|
129
|
-
|
|
128
|
+
declare enum ScopeType {
|
|
130
129
|
UNDEFINED_SCOPE = "UNDEFINED_SCOPE",
|
|
131
130
|
/** Specific catalog items */
|
|
132
131
|
CATALOG_ITEM = "CATALOG_ITEM",
|
|
@@ -134,8 +133,8 @@ export declare enum ScopeType {
|
|
|
134
133
|
CUSTOM_FILTER = "CUSTOM_FILTER"
|
|
135
134
|
}
|
|
136
135
|
/** @enumType */
|
|
137
|
-
|
|
138
|
-
|
|
136
|
+
type ScopeTypeWithLiterals = ScopeType | 'UNDEFINED_SCOPE' | 'CATALOG_ITEM' | 'CUSTOM_FILTER';
|
|
137
|
+
interface CatalogItemFilter {
|
|
139
138
|
/**
|
|
140
139
|
* Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`.
|
|
141
140
|
* @format GUID
|
|
@@ -149,7 +148,7 @@ export interface CatalogItemFilter {
|
|
|
149
148
|
*/
|
|
150
149
|
catalogItemIds?: string[];
|
|
151
150
|
}
|
|
152
|
-
|
|
151
|
+
interface CustomFilter {
|
|
153
152
|
/**
|
|
154
153
|
* Custom filter app ID, when relevant.
|
|
155
154
|
* @format GUID
|
|
@@ -162,7 +161,7 @@ export interface CustomFilter {
|
|
|
162
161
|
*/
|
|
163
162
|
params?: Record<string, any> | null;
|
|
164
163
|
}
|
|
165
|
-
|
|
164
|
+
interface And {
|
|
166
165
|
/**
|
|
167
166
|
* List of triggers to have an "AND" operator between their results.
|
|
168
167
|
* @minSize 2
|
|
@@ -170,7 +169,7 @@ export interface And {
|
|
|
170
169
|
*/
|
|
171
170
|
triggers?: DiscountTrigger[];
|
|
172
171
|
}
|
|
173
|
-
|
|
172
|
+
interface Or {
|
|
174
173
|
/**
|
|
175
174
|
* List of triggers to have an "OR" operator between their results.
|
|
176
175
|
* @minSize 2
|
|
@@ -178,7 +177,7 @@ export interface Or {
|
|
|
178
177
|
*/
|
|
179
178
|
triggers?: DiscountTrigger[];
|
|
180
179
|
}
|
|
181
|
-
|
|
180
|
+
interface Custom {
|
|
182
181
|
/**
|
|
183
182
|
* Trigger ID.
|
|
184
183
|
* @minLength 1
|
|
@@ -191,7 +190,7 @@ export interface Custom {
|
|
|
191
190
|
*/
|
|
192
191
|
appId?: string;
|
|
193
192
|
}
|
|
194
|
-
|
|
193
|
+
interface SubtotalRange {
|
|
195
194
|
/**
|
|
196
195
|
* Relevant scopes for `"SPECIFIC_ITEMS"` target type.
|
|
197
196
|
* @maxSize 50
|
|
@@ -208,7 +207,7 @@ export interface SubtotalRange {
|
|
|
208
207
|
*/
|
|
209
208
|
to?: string | null;
|
|
210
209
|
}
|
|
211
|
-
|
|
210
|
+
interface ItemQuantityRange {
|
|
212
211
|
/**
|
|
213
212
|
* Relevant scopes for `"SPECIFIC_ITEMS"` target type.
|
|
214
213
|
* @maxSize 50
|
|
@@ -225,7 +224,7 @@ export interface ItemQuantityRange {
|
|
|
225
224
|
*/
|
|
226
225
|
to?: number | null;
|
|
227
226
|
}
|
|
228
|
-
|
|
227
|
+
declare enum TriggerType {
|
|
229
228
|
UNDEFINED = "UNDEFINED",
|
|
230
229
|
/** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */
|
|
231
230
|
AND = "AND",
|
|
@@ -239,14 +238,14 @@ export declare enum TriggerType {
|
|
|
239
238
|
OR = "OR"
|
|
240
239
|
}
|
|
241
240
|
/** @enumType */
|
|
242
|
-
|
|
243
|
-
|
|
241
|
+
type TriggerTypeWithLiterals = TriggerType | 'UNDEFINED' | 'AND' | 'SUBTOTAL_RANGE' | 'ITEM_QUANTITY_RANGE' | 'CUSTOM' | 'OR';
|
|
242
|
+
interface ActiveTimeInfo {
|
|
244
243
|
/** Date and time the discount rule is active **from**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
245
244
|
start?: Date | null;
|
|
246
245
|
/** Date and time the discount rule is active **till**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
247
246
|
end?: Date | null;
|
|
248
247
|
}
|
|
249
|
-
|
|
248
|
+
interface Discounts {
|
|
250
249
|
/**
|
|
251
250
|
* Discounts.
|
|
252
251
|
* @minSize 1
|
|
@@ -254,7 +253,7 @@ export interface Discounts {
|
|
|
254
253
|
*/
|
|
255
254
|
values?: Discount[];
|
|
256
255
|
}
|
|
257
|
-
|
|
256
|
+
interface Discount extends DiscountDiscountOneOf {
|
|
258
257
|
/**
|
|
259
258
|
* Percentage to discount from original price.
|
|
260
259
|
* @min 0.1
|
|
@@ -289,7 +288,7 @@ export interface Discount extends DiscountDiscountOneOf {
|
|
|
289
288
|
discountType?: DiscountTypeWithLiterals;
|
|
290
289
|
}
|
|
291
290
|
/** @oneof */
|
|
292
|
-
|
|
291
|
+
interface DiscountDiscountOneOf {
|
|
293
292
|
/**
|
|
294
293
|
* Percentage to discount from original price.
|
|
295
294
|
* @min 0.1
|
|
@@ -307,15 +306,15 @@ export interface DiscountDiscountOneOf {
|
|
|
307
306
|
*/
|
|
308
307
|
fixedPrice?: string;
|
|
309
308
|
}
|
|
310
|
-
|
|
309
|
+
declare enum Type {
|
|
311
310
|
/** Target type is not defined */
|
|
312
311
|
UNDEFINED = "UNDEFINED",
|
|
313
312
|
/** Target type is a set of specific items */
|
|
314
313
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS"
|
|
315
314
|
}
|
|
316
315
|
/** @enumType */
|
|
317
|
-
|
|
318
|
-
|
|
316
|
+
type TypeWithLiterals = Type | 'UNDEFINED' | 'SPECIFIC_ITEMS';
|
|
317
|
+
interface SpecificItemsInfo {
|
|
319
318
|
/**
|
|
320
319
|
* All associated scopes for `"SPECIFIC_ITEMS"` target type.
|
|
321
320
|
* @minSize 1
|
|
@@ -323,7 +322,7 @@ export interface SpecificItemsInfo {
|
|
|
323
322
|
*/
|
|
324
323
|
scopes?: Scope[];
|
|
325
324
|
}
|
|
326
|
-
|
|
325
|
+
declare enum DiscountType {
|
|
327
326
|
UNDEFINED = "UNDEFINED",
|
|
328
327
|
/** Price is reduced by percentage value. */
|
|
329
328
|
PERCENTAGE = "PERCENTAGE",
|
|
@@ -333,8 +332,8 @@ export declare enum DiscountType {
|
|
|
333
332
|
FIXED_PRICE = "FIXED_PRICE"
|
|
334
333
|
}
|
|
335
334
|
/** @enumType */
|
|
336
|
-
|
|
337
|
-
|
|
335
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNDEFINED' | 'PERCENTAGE' | 'FIXED_AMOUNT' | 'FIXED_PRICE';
|
|
336
|
+
interface BuyXGetYInfo {
|
|
338
337
|
/** Information about which items must be in the cart (buy X) for the discount to apply (get Y). */
|
|
339
338
|
customerBuys?: CustomerBuy;
|
|
340
339
|
/** Information about which items will be discounted (get Y). */
|
|
@@ -348,7 +347,7 @@ export interface BuyXGetYInfo {
|
|
|
348
347
|
*/
|
|
349
348
|
limit?: number | null;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface CustomerBuy extends CustomerBuyConditionOneOf {
|
|
352
351
|
/**
|
|
353
352
|
* Minimum number of items the customer must add to the cart to be eligible for a discount.
|
|
354
353
|
* @min 1
|
|
@@ -367,7 +366,7 @@ export interface CustomerBuy extends CustomerBuyConditionOneOf {
|
|
|
367
366
|
scopes?: Scope[];
|
|
368
367
|
}
|
|
369
368
|
/** @oneof */
|
|
370
|
-
|
|
369
|
+
interface CustomerBuyConditionOneOf {
|
|
371
370
|
/**
|
|
372
371
|
* Minimum number of items the customer must add to the cart to be eligible for a discount.
|
|
373
372
|
* @min 1
|
|
@@ -379,7 +378,7 @@ export interface CustomerBuyConditionOneOf {
|
|
|
379
378
|
*/
|
|
380
379
|
minimumSpend?: string | null;
|
|
381
380
|
}
|
|
382
|
-
|
|
381
|
+
interface CustomerGet {
|
|
383
382
|
/**
|
|
384
383
|
* Exact number of items in the cart that will be discounted.
|
|
385
384
|
* If the cart contains fewer items than the value of quantity, the discount will not apply.
|
|
@@ -393,7 +392,7 @@ export interface CustomerGet {
|
|
|
393
392
|
*/
|
|
394
393
|
scopes?: Scope[];
|
|
395
394
|
}
|
|
396
|
-
|
|
395
|
+
declare enum Status {
|
|
397
396
|
/** Rule status is not defined. */
|
|
398
397
|
UNDEFINED = "UNDEFINED",
|
|
399
398
|
/** Rule status is live. */
|
|
@@ -404,9 +403,9 @@ export declare enum Status {
|
|
|
404
403
|
PENDING = "PENDING"
|
|
405
404
|
}
|
|
406
405
|
/** @enumType */
|
|
407
|
-
|
|
406
|
+
type StatusWithLiterals = Status | 'UNDEFINED' | 'LIVE' | 'EXPIRED' | 'PENDING';
|
|
408
407
|
/** The discount settings */
|
|
409
|
-
|
|
408
|
+
interface DiscountSettings {
|
|
410
409
|
/** Discount applies to either `ALL_ITEMS`, or to the `LOWEST_PRICED_ITEM`. */
|
|
411
410
|
appliesTo?: AppliedSubjectTypeWithLiterals;
|
|
412
411
|
/**
|
|
@@ -430,7 +429,7 @@ export interface DiscountSettings {
|
|
|
430
429
|
usageLimitPerUser?: number | null;
|
|
431
430
|
}
|
|
432
431
|
/** TODO: check if can be removed */
|
|
433
|
-
|
|
432
|
+
declare enum AppliedSubjectType {
|
|
434
433
|
UNDEFINED = "UNDEFINED",
|
|
435
434
|
/** Discount applies to all items at checkout. */
|
|
436
435
|
ALL_ITEMS = "ALL_ITEMS",
|
|
@@ -438,8 +437,8 @@ export declare enum AppliedSubjectType {
|
|
|
438
437
|
LOWEST_PRICED_ITEM = "LOWEST_PRICED_ITEM"
|
|
439
438
|
}
|
|
440
439
|
/** @enumType */
|
|
441
|
-
|
|
442
|
-
|
|
440
|
+
type AppliedSubjectTypeWithLiterals = AppliedSubjectType | 'UNDEFINED' | 'ALL_ITEMS' | 'LOWEST_PRICED_ITEM';
|
|
441
|
+
interface ExtendedFields {
|
|
443
442
|
/**
|
|
444
443
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
445
444
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -450,47 +449,47 @@ export interface ExtendedFields {
|
|
|
450
449
|
*/
|
|
451
450
|
namespaces?: Record<string, Record<string, any>>;
|
|
452
451
|
}
|
|
453
|
-
|
|
452
|
+
interface CreateDiscountRuleRequest {
|
|
454
453
|
/** Discount rule info. */
|
|
455
454
|
discountRule: DiscountRule;
|
|
456
455
|
}
|
|
457
|
-
|
|
456
|
+
interface CreateDiscountRuleResponse {
|
|
458
457
|
/** Discount rule. */
|
|
459
458
|
discountRule?: DiscountRule;
|
|
460
459
|
}
|
|
461
|
-
|
|
460
|
+
interface GetDiscountRuleRequest {
|
|
462
461
|
/**
|
|
463
462
|
* ID of the discount rule to retrieve.
|
|
464
463
|
* @format GUID
|
|
465
464
|
*/
|
|
466
465
|
discountRuleId: string;
|
|
467
466
|
}
|
|
468
|
-
|
|
467
|
+
interface GetDiscountRuleResponse {
|
|
469
468
|
/** The requested discount rule. */
|
|
470
469
|
discountRule?: DiscountRule;
|
|
471
470
|
}
|
|
472
|
-
|
|
471
|
+
interface UpdateDiscountRuleRequest {
|
|
473
472
|
/** Discount rule info. */
|
|
474
473
|
discountRule: DiscountRule;
|
|
475
474
|
}
|
|
476
|
-
|
|
475
|
+
interface UpdateDiscountRuleResponse {
|
|
477
476
|
/** Updated discount rule. */
|
|
478
477
|
discountRule?: DiscountRule;
|
|
479
478
|
}
|
|
480
|
-
|
|
479
|
+
interface DeleteDiscountRuleRequest {
|
|
481
480
|
/**
|
|
482
481
|
* ID of the discount rule to delete.
|
|
483
482
|
* @format GUID
|
|
484
483
|
*/
|
|
485
484
|
discountRuleId: string;
|
|
486
485
|
}
|
|
487
|
-
|
|
486
|
+
interface DeleteDiscountRuleResponse {
|
|
488
487
|
}
|
|
489
|
-
|
|
488
|
+
interface QueryDiscountRulesRequest {
|
|
490
489
|
/** Query options. */
|
|
491
490
|
query?: PlatformQuery;
|
|
492
491
|
}
|
|
493
|
-
|
|
492
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
494
493
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
495
494
|
paging?: PlatformPaging;
|
|
496
495
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
@@ -501,13 +500,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
501
500
|
sort?: Sorting[];
|
|
502
501
|
}
|
|
503
502
|
/** @oneof */
|
|
504
|
-
|
|
503
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
505
504
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
506
505
|
paging?: PlatformPaging;
|
|
507
506
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
508
507
|
cursorPaging?: CursorPaging;
|
|
509
508
|
}
|
|
510
|
-
|
|
509
|
+
interface Sorting {
|
|
511
510
|
/**
|
|
512
511
|
* Name of the field to sort by.
|
|
513
512
|
* @maxLength 512
|
|
@@ -516,13 +515,13 @@ export interface Sorting {
|
|
|
516
515
|
/** Sort order. */
|
|
517
516
|
order?: SortOrderWithLiterals;
|
|
518
517
|
}
|
|
519
|
-
|
|
518
|
+
declare enum SortOrder {
|
|
520
519
|
ASC = "ASC",
|
|
521
520
|
DESC = "DESC"
|
|
522
521
|
}
|
|
523
522
|
/** @enumType */
|
|
524
|
-
|
|
525
|
-
|
|
523
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
524
|
+
interface PlatformPaging {
|
|
526
525
|
/**
|
|
527
526
|
* Number of items to load.
|
|
528
527
|
* @max 100
|
|
@@ -531,7 +530,7 @@ export interface PlatformPaging {
|
|
|
531
530
|
/** Number of items to skip in the current sort order. */
|
|
532
531
|
offset?: number | null;
|
|
533
532
|
}
|
|
534
|
-
|
|
533
|
+
interface CursorPaging {
|
|
535
534
|
/**
|
|
536
535
|
* Maximum number of items to return in the results.
|
|
537
536
|
* @max 100
|
|
@@ -546,13 +545,13 @@ export interface CursorPaging {
|
|
|
546
545
|
*/
|
|
547
546
|
cursor?: string | null;
|
|
548
547
|
}
|
|
549
|
-
|
|
548
|
+
interface QueryDiscountRulesResponse {
|
|
550
549
|
/** List of discount rules. */
|
|
551
550
|
discountRules?: DiscountRule[];
|
|
552
551
|
/** Details on the paged set of results returned. */
|
|
553
552
|
pagingMetadata?: PlatformPagingMetadata;
|
|
554
553
|
}
|
|
555
|
-
|
|
554
|
+
interface PlatformPagingMetadata {
|
|
556
555
|
/** The number of items returned in this response. */
|
|
557
556
|
count?: number | null;
|
|
558
557
|
/** The offset which was requested. Returned if offset paging was used. */
|
|
@@ -562,7 +561,7 @@ export interface PlatformPagingMetadata {
|
|
|
562
561
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
563
562
|
cursors?: Cursors;
|
|
564
563
|
}
|
|
565
|
-
|
|
564
|
+
interface Cursors {
|
|
566
565
|
/**
|
|
567
566
|
* Cursor string pointing to the next page in the list of results.
|
|
568
567
|
* @maxLength 16000
|
|
@@ -574,7 +573,7 @@ export interface Cursors {
|
|
|
574
573
|
*/
|
|
575
574
|
prev?: string | null;
|
|
576
575
|
}
|
|
577
|
-
|
|
576
|
+
interface GetAppliedDiscountsRequest {
|
|
578
577
|
/**
|
|
579
578
|
* Line items for which to check for discount rules.
|
|
580
579
|
* @maxSize 1000
|
|
@@ -586,7 +585,7 @@ export interface GetAppliedDiscountsRequest {
|
|
|
586
585
|
*/
|
|
587
586
|
purchaseFlowId?: string | null;
|
|
588
587
|
}
|
|
589
|
-
|
|
588
|
+
interface LineItem {
|
|
590
589
|
/**
|
|
591
590
|
* Line item ID.
|
|
592
591
|
* @minLength 1
|
|
@@ -607,7 +606,7 @@ export interface LineItem {
|
|
|
607
606
|
price?: string;
|
|
608
607
|
}
|
|
609
608
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
610
|
-
|
|
609
|
+
interface CatalogReference {
|
|
611
610
|
/**
|
|
612
611
|
* ID of the item within the catalog it belongs to.
|
|
613
612
|
* @minLength 1
|
|
@@ -633,11 +632,11 @@ export interface CatalogReference {
|
|
|
633
632
|
*/
|
|
634
633
|
options?: Record<string, any> | null;
|
|
635
634
|
}
|
|
636
|
-
|
|
635
|
+
interface GetAppliedDiscountsResponse {
|
|
637
636
|
/** All eligible discounts. */
|
|
638
637
|
appliedDiscounts?: AppliedDiscount[];
|
|
639
638
|
}
|
|
640
|
-
|
|
639
|
+
interface AppliedDiscount {
|
|
641
640
|
/** Discount type. */
|
|
642
641
|
discountType?: TypeWithLiterals;
|
|
643
642
|
/**
|
|
@@ -649,7 +648,7 @@ export interface AppliedDiscount {
|
|
|
649
648
|
/** Applied discount rule. */
|
|
650
649
|
appliedDiscountRule?: AppliedDiscountRule;
|
|
651
650
|
}
|
|
652
|
-
|
|
651
|
+
interface AppliedDiscountRule {
|
|
653
652
|
/**
|
|
654
653
|
* Applied discount rule ID.
|
|
655
654
|
* @format GUID
|
|
@@ -662,7 +661,7 @@ export interface AppliedDiscountRule {
|
|
|
662
661
|
/** Discount rule type. */
|
|
663
662
|
discountRuleType?: DiscountTypeWithLiterals;
|
|
664
663
|
}
|
|
665
|
-
|
|
664
|
+
interface DiscountRuleName {
|
|
666
665
|
/**
|
|
667
666
|
* Original discount rule name (in site's default language).
|
|
668
667
|
* @minLength 1
|
|
@@ -678,7 +677,7 @@ export interface DiscountRuleName {
|
|
|
678
677
|
*/
|
|
679
678
|
translated?: string | null;
|
|
680
679
|
}
|
|
681
|
-
|
|
680
|
+
interface MultiCurrencyPrice {
|
|
682
681
|
/**
|
|
683
682
|
* Amount.
|
|
684
683
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -701,7 +700,7 @@ export interface MultiCurrencyPrice {
|
|
|
701
700
|
*/
|
|
702
701
|
formattedConvertedAmount?: string;
|
|
703
702
|
}
|
|
704
|
-
|
|
703
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
705
704
|
createdEvent?: EntityCreatedEvent;
|
|
706
705
|
updatedEvent?: EntityUpdatedEvent;
|
|
707
706
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -736,19 +735,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
736
735
|
entityEventSequence?: string | null;
|
|
737
736
|
}
|
|
738
737
|
/** @oneof */
|
|
739
|
-
|
|
738
|
+
interface DomainEventBodyOneOf {
|
|
740
739
|
createdEvent?: EntityCreatedEvent;
|
|
741
740
|
updatedEvent?: EntityUpdatedEvent;
|
|
742
741
|
deletedEvent?: EntityDeletedEvent;
|
|
743
742
|
actionEvent?: ActionEvent;
|
|
744
743
|
}
|
|
745
|
-
|
|
744
|
+
interface EntityCreatedEvent {
|
|
746
745
|
entity?: string;
|
|
747
746
|
}
|
|
748
|
-
|
|
747
|
+
interface RestoreInfo {
|
|
749
748
|
deletedDate?: Date | null;
|
|
750
749
|
}
|
|
751
|
-
|
|
750
|
+
interface EntityUpdatedEvent {
|
|
752
751
|
/**
|
|
753
752
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
754
753
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -756,20 +755,20 @@ export interface EntityUpdatedEvent {
|
|
|
756
755
|
*/
|
|
757
756
|
currentEntity?: string;
|
|
758
757
|
}
|
|
759
|
-
|
|
758
|
+
interface EntityDeletedEvent {
|
|
760
759
|
/** Entity that was deleted. */
|
|
761
760
|
deletedEntity?: string | null;
|
|
762
761
|
}
|
|
763
|
-
|
|
762
|
+
interface ActionEvent {
|
|
764
763
|
body?: string;
|
|
765
764
|
}
|
|
766
|
-
|
|
765
|
+
interface Empty {
|
|
767
766
|
}
|
|
768
|
-
|
|
767
|
+
interface DiscountRuleUsageLimitReached {
|
|
769
768
|
/** Discount Rule */
|
|
770
769
|
rule?: DiscountRule;
|
|
771
770
|
}
|
|
772
|
-
|
|
771
|
+
interface MessageEnvelope {
|
|
773
772
|
/**
|
|
774
773
|
* App instance ID.
|
|
775
774
|
* @format GUID
|
|
@@ -785,7 +784,7 @@ export interface MessageEnvelope {
|
|
|
785
784
|
/** Stringify payload. */
|
|
786
785
|
data?: string;
|
|
787
786
|
}
|
|
788
|
-
|
|
787
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
789
788
|
/**
|
|
790
789
|
* ID of a site visitor that has not logged in to the site.
|
|
791
790
|
* @format GUID
|
|
@@ -810,7 +809,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
810
809
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
811
810
|
}
|
|
812
811
|
/** @oneof */
|
|
813
|
-
|
|
812
|
+
interface IdentificationDataIdOneOf {
|
|
814
813
|
/**
|
|
815
814
|
* ID of a site visitor that has not logged in to the site.
|
|
816
815
|
* @format GUID
|
|
@@ -832,7 +831,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
832
831
|
*/
|
|
833
832
|
appId?: string;
|
|
834
833
|
}
|
|
835
|
-
|
|
834
|
+
declare enum WebhookIdentityType {
|
|
836
835
|
UNKNOWN = "UNKNOWN",
|
|
837
836
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
838
837
|
MEMBER = "MEMBER",
|
|
@@ -840,8 +839,8 @@ export declare enum WebhookIdentityType {
|
|
|
840
839
|
APP = "APP"
|
|
841
840
|
}
|
|
842
841
|
/** @enumType */
|
|
843
|
-
|
|
844
|
-
|
|
842
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
843
|
+
interface BaseEventMetadata {
|
|
845
844
|
/**
|
|
846
845
|
* App instance ID.
|
|
847
846
|
* @format GUID
|
|
@@ -855,7 +854,7 @@ export interface BaseEventMetadata {
|
|
|
855
854
|
/** The identification type and identity data. */
|
|
856
855
|
identity?: IdentificationData;
|
|
857
856
|
}
|
|
858
|
-
|
|
857
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
859
858
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
860
859
|
_id?: string;
|
|
861
860
|
/**
|
|
@@ -885,160 +884,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
885
884
|
*/
|
|
886
885
|
entityEventSequence?: string | null;
|
|
887
886
|
}
|
|
888
|
-
|
|
887
|
+
interface DiscountRuleCreatedEnvelope {
|
|
889
888
|
entity: DiscountRule;
|
|
890
889
|
metadata: EventMetadata;
|
|
891
890
|
}
|
|
892
|
-
|
|
893
|
-
* Triggered when a discount rule is created.
|
|
894
|
-
* @permissionScope Manage Stores - all permissions
|
|
895
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
896
|
-
* @permissionScope Manage Stores
|
|
897
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
898
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
899
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
900
|
-
* @permissionScope Read Stores - all read permissions
|
|
901
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
902
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
903
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
904
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
905
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
906
|
-
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
907
|
-
* @webhook
|
|
908
|
-
* @eventType wix.ecom.discounts.v1.discount_rule_created
|
|
909
|
-
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
910
|
-
* @slug created
|
|
911
|
-
*/
|
|
912
|
-
export declare function onDiscountRuleCreated(handler: (event: DiscountRuleCreatedEnvelope) => void | Promise<void>): void;
|
|
913
|
-
export interface DiscountRuleDeletedEnvelope {
|
|
891
|
+
interface DiscountRuleDeletedEnvelope {
|
|
914
892
|
metadata: EventMetadata;
|
|
915
893
|
}
|
|
916
|
-
|
|
917
|
-
* Triggered when a discount rule is deleted.
|
|
918
|
-
* @permissionScope Manage Stores - all permissions
|
|
919
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
920
|
-
* @permissionScope Manage Stores
|
|
921
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
922
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
923
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
924
|
-
* @permissionScope Read Stores - all read permissions
|
|
925
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
926
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
927
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
928
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
929
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
930
|
-
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
931
|
-
* @webhook
|
|
932
|
-
* @eventType wix.ecom.discounts.v1.discount_rule_deleted
|
|
933
|
-
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
934
|
-
* @slug deleted
|
|
935
|
-
*/
|
|
936
|
-
export declare function onDiscountRuleDeleted(handler: (event: DiscountRuleDeletedEnvelope) => void | Promise<void>): void;
|
|
937
|
-
export interface DiscountRuleUpdatedEnvelope {
|
|
894
|
+
interface DiscountRuleUpdatedEnvelope {
|
|
938
895
|
entity: DiscountRule;
|
|
939
896
|
metadata: EventMetadata;
|
|
940
897
|
}
|
|
941
|
-
|
|
942
|
-
* Triggered when a discount rule is updated.
|
|
943
|
-
* @permissionScope Manage Stores - all permissions
|
|
944
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
945
|
-
* @permissionScope Manage Stores
|
|
946
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
947
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
948
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
949
|
-
* @permissionScope Read Stores - all read permissions
|
|
950
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
951
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
952
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
953
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
954
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
955
|
-
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
956
|
-
* @webhook
|
|
957
|
-
* @eventType wix.ecom.discounts.v1.discount_rule_updated
|
|
958
|
-
* @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
|
|
959
|
-
* @slug updated
|
|
960
|
-
*/
|
|
961
|
-
export declare function onDiscountRuleUpdated(handler: (event: DiscountRuleUpdatedEnvelope) => void | Promise<void>): void;
|
|
962
|
-
type DiscountRuleNonNullablePaths = `trigger.and.triggers` | `trigger.or.triggers` | `trigger.customTrigger._id` | `trigger.customTrigger.appId` | `trigger.subtotalRange.scopes` | `trigger.subtotalRange.scopes.${number}.catalogItemFilter.catalogAppId` | `trigger.subtotalRange.scopes.${number}.customFilter.appId` | `trigger.subtotalRange.scopes.${number}._id` | `trigger.subtotalRange.scopes.${number}.type` | `trigger.itemQuantityRange.scopes` | `trigger.triggerType` | `discounts.values` | `discounts.values.${number}.percentage` | `discounts.values.${number}.fixedAmount` | `discounts.values.${number}.fixedPrice` | `discounts.values.${number}.targetType` | `discounts.values.${number}.discountType` | `status` | `usageCount`;
|
|
963
|
-
/**
|
|
964
|
-
* Creates a new discount rule.
|
|
965
|
-
*
|
|
966
|
-
*
|
|
967
|
-
* The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.
|
|
968
|
-
* @param discountRule - Discount rule info.
|
|
969
|
-
* @public
|
|
970
|
-
* @requiredField discountRule
|
|
971
|
-
* @requiredField discountRule.discounts
|
|
972
|
-
* @requiredField discountRule.name
|
|
973
|
-
* @permissionId ECOM.DISCOUNT_RULES_CREATE
|
|
974
|
-
* @permissionScope Manage Stores - all permissions
|
|
975
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
976
|
-
* @permissionScope Manage Stores
|
|
977
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
978
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
979
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
980
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
981
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
982
|
-
* @applicableIdentity APP
|
|
983
|
-
* @returns Discount rule.
|
|
984
|
-
* @fqn com.wix.ecom.discounts.DiscountRuleService.CreateDiscountRule
|
|
985
|
-
*/
|
|
986
|
-
export declare function createDiscountRule(discountRule: NonNullablePaths<DiscountRule, `discounts` | `name`>): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths>>;
|
|
987
|
-
/**
|
|
988
|
-
* Retrieves a discount rule.
|
|
989
|
-
*
|
|
990
|
-
*
|
|
991
|
-
* The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.
|
|
992
|
-
* @param discountRuleId - ID of the discount rule to retrieve.
|
|
993
|
-
* @public
|
|
994
|
-
* @requiredField discountRuleId
|
|
995
|
-
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
996
|
-
* @permissionScope Manage Stores - all permissions
|
|
997
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
998
|
-
* @permissionScope Manage Stores
|
|
999
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1000
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1001
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1002
|
-
* @permissionScope Read Stores - all read permissions
|
|
1003
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1004
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1005
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1006
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1007
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1008
|
-
* @applicableIdentity APP
|
|
1009
|
-
* @returns The requested discount rule.
|
|
1010
|
-
* @fqn com.wix.ecom.discounts.DiscountRuleService.GetDiscountRule
|
|
1011
|
-
*/
|
|
1012
|
-
export declare function getDiscountRule(discountRuleId: string): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths>>;
|
|
1013
|
-
/**
|
|
1014
|
-
* Updates a discount rule's properties.
|
|
1015
|
-
*
|
|
1016
|
-
*
|
|
1017
|
-
* The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.
|
|
1018
|
-
*
|
|
1019
|
-
* Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.
|
|
1020
|
-
* @param _id - Discount rule ID.
|
|
1021
|
-
* @public
|
|
1022
|
-
* @requiredField _id
|
|
1023
|
-
* @requiredField discountRule
|
|
1024
|
-
* @requiredField discountRule.revision
|
|
1025
|
-
* @param discountRule - Discount rule info.
|
|
1026
|
-
* @param options - Discount rule info.
|
|
1027
|
-
* @permissionId ECOM.DISCOUNT_RULES_UPDATE
|
|
1028
|
-
* @permissionScope Manage Stores - all permissions
|
|
1029
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1030
|
-
* @permissionScope Manage Stores
|
|
1031
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1032
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1033
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1034
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1035
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1036
|
-
* @applicableIdentity APP
|
|
1037
|
-
* @returns Updated discount rule.
|
|
1038
|
-
* @fqn com.wix.ecom.discounts.DiscountRuleService.UpdateDiscountRule
|
|
1039
|
-
*/
|
|
1040
|
-
export declare function updateDiscountRule(_id: string, discountRule: NonNullablePaths<UpdateDiscountRule, `revision`>): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths>>;
|
|
1041
|
-
export interface UpdateDiscountRule {
|
|
898
|
+
interface UpdateDiscountRule {
|
|
1042
899
|
/**
|
|
1043
900
|
* Discount rule ID.
|
|
1044
901
|
* @format GUID
|
|
@@ -1103,60 +960,6 @@ export interface UpdateDiscountRule {
|
|
|
1103
960
|
*/
|
|
1104
961
|
usageCount?: number;
|
|
1105
962
|
}
|
|
1106
|
-
/**
|
|
1107
|
-
* Deletes a discount rule.
|
|
1108
|
-
*
|
|
1109
|
-
*
|
|
1110
|
-
* The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.
|
|
1111
|
-
* @param discountRuleId - ID of the discount rule to delete.
|
|
1112
|
-
* @public
|
|
1113
|
-
* @requiredField discountRuleId
|
|
1114
|
-
* @permissionId ECOM.DISCOUNT_RULES_DELETE
|
|
1115
|
-
* @permissionScope Manage Stores - all permissions
|
|
1116
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1117
|
-
* @permissionScope Manage Stores
|
|
1118
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1119
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1120
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1121
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1122
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1123
|
-
* @applicableIdentity APP
|
|
1124
|
-
* @fqn com.wix.ecom.discounts.DiscountRuleService.DeleteDiscountRule
|
|
1125
|
-
*/
|
|
1126
|
-
export declare function deleteDiscountRule(discountRuleId: string): Promise<void>;
|
|
1127
|
-
/**
|
|
1128
|
-
* Creates a query to retrieve a list of discount rules.
|
|
1129
|
-
*
|
|
1130
|
-
*
|
|
1131
|
-
* The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.
|
|
1132
|
-
*
|
|
1133
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.
|
|
1134
|
-
*
|
|
1135
|
-
* You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.
|
|
1136
|
-
*
|
|
1137
|
-
* By default, `queryDiscountRules()` sorts results by [`ascending("_id")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.
|
|
1138
|
-
*
|
|
1139
|
-
* To learn how to query posts, refer to the table below.
|
|
1140
|
-
*
|
|
1141
|
-
* The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.
|
|
1142
|
-
* @public
|
|
1143
|
-
* @permissionScope Manage Stores - all permissions
|
|
1144
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1145
|
-
* @permissionScope Manage Stores
|
|
1146
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1147
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1148
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1149
|
-
* @permissionScope Read Stores - all read permissions
|
|
1150
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1151
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1152
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1153
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1154
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1155
|
-
* @permissionId ECOM.DISCOUNT_RULES_READ
|
|
1156
|
-
* @applicableIdentity APP
|
|
1157
|
-
* @fqn com.wix.ecom.discounts.DiscountRuleService.QueryDiscountRules
|
|
1158
|
-
*/
|
|
1159
|
-
export declare function queryDiscountRules(): DiscountRulesQueryBuilder;
|
|
1160
963
|
interface QueryCursorResult {
|
|
1161
964
|
cursors: Cursors;
|
|
1162
965
|
hasNext: () => boolean;
|
|
@@ -1164,13 +967,13 @@ interface QueryCursorResult {
|
|
|
1164
967
|
length: number;
|
|
1165
968
|
pageSize: number;
|
|
1166
969
|
}
|
|
1167
|
-
|
|
970
|
+
interface DiscountRulesQueryResult extends QueryCursorResult {
|
|
1168
971
|
items: DiscountRule[];
|
|
1169
972
|
query: DiscountRulesQueryBuilder;
|
|
1170
973
|
next: () => Promise<DiscountRulesQueryResult>;
|
|
1171
974
|
prev: () => Promise<DiscountRulesQueryResult>;
|
|
1172
975
|
}
|
|
1173
|
-
|
|
976
|
+
interface DiscountRulesQueryBuilder {
|
|
1174
977
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1175
978
|
* @param value - Value to compare against.
|
|
1176
979
|
*/
|
|
@@ -1215,4 +1018,5 @@ export interface DiscountRulesQueryBuilder {
|
|
|
1215
1018
|
skipTo: (cursor: string) => DiscountRulesQueryBuilder;
|
|
1216
1019
|
find: () => Promise<DiscountRulesQueryResult>;
|
|
1217
1020
|
}
|
|
1218
|
-
|
|
1021
|
+
|
|
1022
|
+
export { type GetAppliedDiscountsRequest as $, AppliedSubjectType as A, type BuyXGetYInfo as B, type CatalogItemFilter as C, type DiscountRule as D, type ExtendedFields as E, type CreateDiscountRuleResponse as F, type GetDiscountRuleRequest as G, type GetDiscountRuleResponse as H, type ItemQuantityRange as I, type UpdateDiscountRuleRequest as J, type UpdateDiscountRuleResponse as K, type DeleteDiscountRuleRequest as L, type DeleteDiscountRuleResponse as M, type PlatformQueryPagingMethodOneOf as N, type Or as O, type PlatformQuery as P, type QueryDiscountRulesRequest as Q, type Sorting as R, ScopeType as S, TriggerType as T, type UpdateDiscountRule as U, type PlatformPaging as V, WebhookIdentityType as W, type CursorPaging as X, type QueryDiscountRulesResponse as Y, type PlatformPagingMetadata as Z, type Cursors as _, type DiscountRulesQueryBuilder as a, type LineItem as a0, type CatalogReference as a1, type GetAppliedDiscountsResponse as a2, type AppliedDiscount as a3, type AppliedDiscountRule as a4, type DiscountRuleName as a5, type MultiCurrencyPrice as a6, type DomainEvent as a7, type DomainEventBodyOneOf as a8, type EntityCreatedEvent as a9, type RestoreInfo as aa, type EntityUpdatedEvent as ab, type EntityDeletedEvent as ac, type ActionEvent as ad, type Empty as ae, type DiscountRuleUsageLimitReached as af, type MessageEnvelope as ag, type IdentificationData as ah, type IdentificationDataIdOneOf as ai, type BaseEventMetadata as aj, type EventMetadata as ak, type DiscountRulesQueryResult as al, type DiscountRuleCreatedEnvelope as b, type DiscountRuleDeletedEnvelope as c, type DiscountRuleUpdatedEnvelope as d, Type as e, DiscountType as f, Status as g, SortOrder as h, type DiscountTrigger as i, type DiscountTriggerTriggerOneOf as j, type Scope as k, type ScopeScopeItemsOneOf as l, type CustomFilter as m, type And as n, type Custom as o, type SubtotalRange as p, type ActiveTimeInfo as q, type Discounts as r, type Discount as s, type DiscountDiscountOneOf as t, type SpecificItemsInfo as u, type CustomerBuy as v, type CustomerBuyConditionOneOf as w, type CustomerGet as x, type DiscountSettings as y, type CreateDiscountRuleRequest as z };
|