@wix/auto_sdk_loyalty_earning-rules 1.0.7 → 1.0.9

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.
Files changed (138) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.d.ts +28 -0
  11. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js +39 -0
  12. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js.map +1 -0
  13. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.d.ts +48 -0
  14. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js +353 -0
  15. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js.map +1 -0
  16. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.d.ts +28 -0
  17. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js +180 -0
  18. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js.map +1 -0
  19. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.d.ts +93 -0
  20. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js +97 -0
  21. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map +1 -0
  22. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.d.ts +942 -0
  23. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js +151 -0
  24. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js.map +1 -0
  25. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts +1280 -0
  26. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js +514 -0
  27. package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.d.ts +28 -0
  39. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js +28 -0
  40. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js.map +1 -0
  41. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.d.ts +48 -0
  42. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js +342 -0
  43. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js.map +1 -0
  44. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.d.ts +28 -0
  45. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js +146 -0
  46. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js.map +1 -0
  47. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.d.ts +93 -0
  48. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js +78 -0
  49. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map +1 -0
  50. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.d.ts +942 -0
  51. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js +148 -0
  52. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js.map +1 -0
  53. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts +1280 -0
  54. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js +480 -0
  55. package/build/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.d.ts +28 -0
  66. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js +39 -0
  67. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js.map +1 -0
  68. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.d.ts +48 -0
  69. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js +353 -0
  70. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js.map +1 -0
  71. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.d.ts +28 -0
  72. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js +180 -0
  73. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js.map +1 -0
  74. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.d.ts +93 -0
  75. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js +97 -0
  76. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map +1 -0
  77. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.d.ts +942 -0
  78. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js +151 -0
  79. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js.map +1 -0
  80. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts +1285 -0
  81. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js +514 -0
  82. package/build/internal/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.d.ts +28 -0
  93. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js +28 -0
  94. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.context.js.map +1 -0
  95. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.d.ts +48 -0
  96. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js +342 -0
  97. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.http.js.map +1 -0
  98. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.d.ts +28 -0
  99. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js +146 -0
  100. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.meta.js.map +1 -0
  101. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.d.ts +93 -0
  102. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js +78 -0
  103. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.public.js.map +1 -0
  104. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.d.ts +942 -0
  105. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js +148 -0
  106. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.types.js.map +1 -0
  107. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts +1285 -0
  108. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js +480 -0
  109. package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.js.map +1 -0
  110. package/package.json +13 -14
  111. package/build/index.d.mts +0 -112
  112. package/build/index.d.ts +0 -112
  113. package/build/index.js +0 -732
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -694
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -112
  118. package/build/internal/index.d.ts +0 -112
  119. package/build/internal/index.js +0 -732
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -694
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/loyalty-v1-loyalty-earning-rule-earning-rules.universal-DOjaPKYu.d.mts +0 -643
  124. package/build/internal/loyalty-v1-loyalty-earning-rule-earning-rules.universal-DOjaPKYu.d.ts +0 -643
  125. package/build/internal/meta.d.mts +0 -322
  126. package/build/internal/meta.d.ts +0 -322
  127. package/build/internal/meta.js +0 -500
  128. package/build/internal/meta.js.map +0 -1
  129. package/build/internal/meta.mjs +0 -466
  130. package/build/internal/meta.mjs.map +0 -1
  131. package/build/loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.d.mts +0 -638
  132. package/build/loyalty-v1-loyalty-earning-rule-earning-rules.universal-ByA9SEhi.d.ts +0 -638
  133. package/build/meta.d.mts +0 -322
  134. package/build/meta.d.ts +0 -322
  135. package/build/meta.js +0 -500
  136. package/build/meta.js.map +0 -1
  137. package/build/meta.mjs +0 -466
  138. package/build/meta.mjs.map +0 -1
@@ -1,638 +0,0 @@
1
- /**
2
- * A loyalty earning rule defines how customers earn points in a loyalty program.
3
- * You can create rules for different activities, such as making purchases.
4
- */
5
- interface LoyaltyEarningRule extends LoyaltyEarningRuleTypeOneOf {
6
- /** Fixed amount of points awarded for each qualifying activity. */
7
- fixedAmount?: FixedAmount;
8
- /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
9
- conversionRate?: ConversionRate;
10
- /**
11
- * Loyalty earning rule ID.
12
- * @format GUID
13
- * @readonly
14
- */
15
- _id?: string | null;
16
- /**
17
- * ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.
18
- * @format GUID
19
- */
20
- sourceAppId?: string;
21
- /**
22
- * ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.
23
- * @minLength 1
24
- * @maxLength 80
25
- */
26
- triggerAppId?: string;
27
- /**
28
- * Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`.
29
- * @minLength 1
30
- * @maxLength 80
31
- */
32
- triggerActivityType?: string;
33
- /**
34
- * Name of the earning rule.
35
- * @minLength 1
36
- * @maxLength 50
37
- */
38
- title?: string;
39
- /** Current status of the earning rule. */
40
- status?: Status;
41
- /**
42
- * Revision number, incremented by 1 each time the earning rule is updated.
43
- * Pass the latest revision when updating to prevent conflicting changes.
44
- */
45
- revision?: string | null;
46
- /**
47
- * Date and time the earning rule was created.
48
- * @readonly
49
- */
50
- _createdDate?: Date | null;
51
- /**
52
- * Date and time the earning rule was last updated.
53
- * @readonly
54
- */
55
- _updatedDate?: Date | null;
56
- /**
57
- * Additional metadata about the earning rule.
58
- * @readonly
59
- */
60
- metadata?: Metadata;
61
- }
62
- /** @oneof */
63
- interface LoyaltyEarningRuleTypeOneOf {
64
- /** Fixed amount of points awarded for each qualifying activity. */
65
- fixedAmount?: FixedAmount;
66
- /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
67
- conversionRate?: ConversionRate;
68
- }
69
- /** Fixed amount type of earning rule. */
70
- interface FixedAmount {
71
- /**
72
- * Fixed amount configurations for each tier.
73
- * @maxSize 21
74
- */
75
- configs?: FixedAmountConfig[];
76
- }
77
- interface FixedAmountConfig {
78
- /**
79
- * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction#terminology) is used.
80
- * @format GUID
81
- * @readonly
82
- */
83
- tierId?: string | null;
84
- /** Number of points to award. */
85
- points?: number;
86
- }
87
- /**
88
- * Conversion rate type of earning rule.
89
- * Customers earn points based on the amount spent.
90
- * For example, for every $10 spent, a customer might earn 1 point.
91
- */
92
- interface ConversionRate {
93
- /**
94
- * Conversion rate configurations for each tier.
95
- *
96
- * Points are awarded proportionally to the amount spent.
97
- *
98
- * Formula: `(amount spent) / (money_amount * points)`.
99
- * @maxSize 21
100
- */
101
- configs?: ConversionRateConfig[];
102
- /**
103
- * Specifies which field in the Wix automations trigger payload [REST](https://dev.wix.com/docs/rest/business-management/automations/introduction#how-do-automations-work)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/automations/triggered-events/reporting-and-canceling-events) to use for calculating points in conversion rate rules.
104
- * For example, if set to "priceSummary.totalAmount", the rule uses the total order amount to calculate loyalty points to be awarded.
105
- * This field is only applicable for automated earning rules.
106
- */
107
- field?: string | null;
108
- }
109
- interface ConversionRateConfig {
110
- /**
111
- * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction) is used.
112
- * @format GUID
113
- * @readonly
114
- */
115
- tierId?: string | null;
116
- /**
117
- * The amount of money used as a reference for point calculation.
118
- * Points are awarded proportionally to the amount spent.
119
- *
120
- * For example, if set to 10, 1 point is awarded for every 10 units of currency spent (assuming `points` is set to 1).
121
- *
122
- * Formula for points is: `(amount spent) / (money_amount * points)`.
123
- */
124
- moneyAmount?: number;
125
- /**
126
- * Points given for the specified `money_amount`.
127
- * Works in conjunction with `money_amount` to define the earning rule.
128
- *
129
- * For example: If `money_amount` is 20 and `points` is 10:
130
- * - Spending 10 units of currency earns 5 points
131
- * - Spending 20 units of currency earns 10 points
132
- * - Spending 30 units of currency earns 15 points
133
- */
134
- points?: number;
135
- }
136
- declare enum Status {
137
- /** Status is unknown or not specified. */
138
- UNKNOWN = "UNKNOWN",
139
- /** Earning rule is active and can assign points. */
140
- ACTIVE = "ACTIVE",
141
- /** Earning rule is paused and can't assign points. */
142
- PAUSED = "PAUSED"
143
- }
144
- interface Metadata {
145
- /** Whether the earning rule can be deleted. */
146
- canBeDeleted?: boolean;
147
- }
148
- interface LoyaltyEarningRuleTypeTag {
149
- /** Type of custom earning rule. */
150
- ruleType?: LoyaltyEarningRuleTypeTagType;
151
- }
152
- declare enum LoyaltyEarningRuleTypeTagType {
153
- /** Type is unknown or not specified. */
154
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
155
- /** Earning rule for a customer's birthday. */
156
- BIRTHDAY = "BIRTHDAY"
157
- }
158
- interface EarningRuleDisabled {
159
- }
160
- interface CreateLoyaltyEarningRuleRequest {
161
- /** Earning rule to create. */
162
- earningRule: LoyaltyEarningRule;
163
- }
164
- interface CreateLoyaltyEarningRuleResponse {
165
- /** Created earning rule. */
166
- earningRule?: LoyaltyEarningRule;
167
- }
168
- interface BulkCreateLoyaltyEarningRulesRequest {
169
- /**
170
- * Earning rules to create.
171
- * @minSize 1
172
- * @maxSize 100
173
- */
174
- earningRules: LoyaltyEarningRule[];
175
- }
176
- interface BulkCreateLoyaltyEarningRulesResponse {
177
- /** Created earning rules. */
178
- results?: BulkLoyaltyEarningRuleResult[];
179
- /** Additional metadata for the created earning rules. */
180
- bulkActionMetadata?: BulkActionMetadata;
181
- }
182
- interface BulkLoyaltyEarningRuleResult {
183
- /** Additional metadata for the created earning rules. */
184
- itemMetadata?: ItemMetadata;
185
- /** Created earning rule. */
186
- item?: LoyaltyEarningRule;
187
- }
188
- interface ItemMetadata {
189
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
190
- _id?: string | null;
191
- /** Index of the item within the request array. Allows for correlation between request and response items. */
192
- originalIndex?: number;
193
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
194
- success?: boolean;
195
- /** Details about the error in case of failure. */
196
- error?: ApplicationError;
197
- }
198
- interface ApplicationError {
199
- /** Error code. */
200
- code?: string;
201
- /** Description of the error. */
202
- description?: string;
203
- /** Data related to the error. */
204
- data?: Record<string, any> | null;
205
- }
206
- interface BulkActionMetadata {
207
- /** Number of items that were successfully processed. */
208
- totalSuccesses?: number;
209
- /** Number of items that couldn't be processed. */
210
- totalFailures?: number;
211
- /** Number of failures without details because detailed failure threshold was exceeded. */
212
- undetailedFailures?: number;
213
- }
214
- interface CreateCustomLoyaltyEarningRuleRequest {
215
- /** Type of the custom earning rule. */
216
- type: Type;
217
- /** Custom earning rule to create. */
218
- earningRule?: CustomLoyaltyEarningRule;
219
- }
220
- declare enum Type {
221
- /** Unknown type. This value is not used. */
222
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
223
- /** Earning rule for social media. */
224
- SOCIAL_MEDIA = "SOCIAL_MEDIA",
225
- /** Earning rule for birthdays. */
226
- BIRTHDAY = "BIRTHDAY"
227
- }
228
- /** Used in CreateCustomLoyaltyEarningRuleRequest */
229
- interface CustomLoyaltyEarningRule extends CustomLoyaltyEarningRuleTypeOneOf {
230
- /** Fixed amount of points awarded for each qualifying activity. */
231
- fixedAmount?: FixedAmount;
232
- /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
233
- conversionRate?: ConversionRate;
234
- /**
235
- * Name of the earning rule.
236
- * @minLength 1
237
- * @maxLength 50
238
- */
239
- title?: string;
240
- }
241
- /** @oneof */
242
- interface CustomLoyaltyEarningRuleTypeOneOf {
243
- /** Fixed amount of points awarded for each qualifying activity. */
244
- fixedAmount?: FixedAmount;
245
- /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
246
- conversionRate?: ConversionRate;
247
- }
248
- interface CreateCustomLoyaltyEarningRuleResponse {
249
- /** Created earning rule. */
250
- earningRule?: LoyaltyEarningRule;
251
- }
252
- interface GetLoyaltyEarningRuleRequest {
253
- /**
254
- * ID of the earning rule to retrieve.
255
- * @format GUID
256
- */
257
- _id: string;
258
- }
259
- interface GetLoyaltyEarningRuleResponse {
260
- /** Retrieved earning rule. */
261
- earningRule?: LoyaltyEarningRule;
262
- }
263
- interface UpdateLoyaltyEarningRuleRequest {
264
- /** Earning rule to update. */
265
- earningRule: LoyaltyEarningRule;
266
- }
267
- interface UpdateLoyaltyEarningRuleResponse {
268
- /** The updated earning rule. */
269
- earningRule?: LoyaltyEarningRule;
270
- }
271
- interface DeleteLoyaltyEarningRuleRequest {
272
- /**
273
- * ID of the earning rule to delete.
274
- * @format GUID
275
- */
276
- _id: string;
277
- /**
278
- * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
279
- * Pass the latest revision when updating to prevent conflicting changes.
280
- */
281
- revision?: string;
282
- }
283
- interface DeleteLoyaltyEarningRuleResponse {
284
- }
285
- interface DeleteAutomationEarningRuleRequest {
286
- /**
287
- * ID of the earning rule to delete.
288
- * @format GUID
289
- */
290
- _id: string;
291
- }
292
- interface DeleteAutomationEarningRuleResponse {
293
- }
294
- interface ListEarningRulesRequest {
295
- /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
296
- triggerAppId?: string | null;
297
- /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */
298
- triggerActivityType?: string | null;
299
- }
300
- interface ListEarningRulesResponse {
301
- /** Retrieved earning rules. */
302
- earningRules?: LoyaltyEarningRule[];
303
- }
304
- interface ListEarningRulesInTierRequest {
305
- /**
306
- * ID of the tier for which the earning rules will be returned.
307
- * @format GUID
308
- */
309
- tierId?: string | null;
310
- /** Pagination options. */
311
- paging?: CursorPaging;
312
- }
313
- interface CursorPaging {
314
- /**
315
- * Maximum number of items to return in the results.
316
- * @max 100
317
- */
318
- limit?: number | null;
319
- /**
320
- * Pointer to the next or previous page in the list of results.
321
- *
322
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
323
- * Not relevant for the first request.
324
- * @maxLength 16000
325
- */
326
- cursor?: string | null;
327
- }
328
- interface ListEarningRulesInTierResponse {
329
- /** Retrieved earning rules. */
330
- earningRules?: LoyaltyEarningRule[];
331
- /** Details on the paged set of results returned. */
332
- pagingMetadata?: PagingMetadataV2;
333
- }
334
- interface PagingMetadataV2 {
335
- /** Number of items returned in the response. */
336
- count?: number | null;
337
- /** Offset that was requested. */
338
- offset?: number | null;
339
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
340
- total?: number | null;
341
- /** Flag that indicates the server failed to calculate the `total` field. */
342
- tooManyToCount?: boolean | null;
343
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
344
- cursors?: Cursors;
345
- }
346
- interface Cursors {
347
- /**
348
- * Cursor string pointing to the next page in the list of results.
349
- * @maxLength 16000
350
- */
351
- next?: string | null;
352
- /**
353
- * Cursor pointing to the previous page in the list of results.
354
- * @maxLength 16000
355
- */
356
- prev?: string | null;
357
- }
358
- interface DomainEvent extends DomainEventBodyOneOf {
359
- createdEvent?: EntityCreatedEvent;
360
- updatedEvent?: EntityUpdatedEvent;
361
- deletedEvent?: EntityDeletedEvent;
362
- actionEvent?: ActionEvent;
363
- /**
364
- * Unique event ID.
365
- * Allows clients to ignore duplicate webhooks.
366
- */
367
- _id?: string;
368
- /**
369
- * Assumes actions are also always typed to an entity_type
370
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
371
- */
372
- entityFqdn?: string;
373
- /**
374
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
375
- * This is although the created/updated/deleted notion is duplication of the oneof types
376
- * Example: created/updated/deleted/started/completed/email_opened
377
- */
378
- slug?: string;
379
- /** ID of the entity associated with the event. */
380
- entityId?: string;
381
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
382
- eventTime?: Date | null;
383
- /**
384
- * Whether the event was triggered as a result of a privacy regulation application
385
- * (for example, GDPR).
386
- */
387
- triggeredByAnonymizeRequest?: boolean | null;
388
- /** If present, indicates the action that triggered the event. */
389
- originatedFrom?: string | null;
390
- /**
391
- * A sequence number defining the order of updates to the underlying entity.
392
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
393
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
394
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
395
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
396
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
397
- */
398
- entityEventSequence?: string | null;
399
- }
400
- /** @oneof */
401
- interface DomainEventBodyOneOf {
402
- createdEvent?: EntityCreatedEvent;
403
- updatedEvent?: EntityUpdatedEvent;
404
- deletedEvent?: EntityDeletedEvent;
405
- actionEvent?: ActionEvent;
406
- }
407
- interface EntityCreatedEvent {
408
- entity?: string;
409
- }
410
- interface RestoreInfo {
411
- deletedDate?: Date | null;
412
- }
413
- interface EntityUpdatedEvent {
414
- /**
415
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
416
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
417
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
418
- */
419
- currentEntity?: string;
420
- }
421
- interface EntityDeletedEvent {
422
- /** Entity that was deleted */
423
- deletedEntity?: string | null;
424
- }
425
- interface ActionEvent {
426
- body?: string;
427
- }
428
- interface Empty {
429
- }
430
- interface MessageEnvelope {
431
- /**
432
- * App instance ID.
433
- * @format GUID
434
- */
435
- instanceId?: string | null;
436
- /**
437
- * Event type.
438
- * @maxLength 150
439
- */
440
- eventType?: string;
441
- /** The identification type and identity data. */
442
- identity?: IdentificationData;
443
- /** Stringify payload. */
444
- data?: string;
445
- }
446
- interface IdentificationData extends IdentificationDataIdOneOf {
447
- /**
448
- * ID of a site visitor that has not logged in to the site.
449
- * @format GUID
450
- */
451
- anonymousVisitorId?: string;
452
- /**
453
- * ID of a site visitor that has logged in to the site.
454
- * @format GUID
455
- */
456
- memberId?: string;
457
- /**
458
- * ID of a Wix user (site owner, contributor, etc.).
459
- * @format GUID
460
- */
461
- wixUserId?: string;
462
- /**
463
- * ID of an app.
464
- * @format GUID
465
- */
466
- appId?: string;
467
- /** @readonly */
468
- identityType?: WebhookIdentityType;
469
- }
470
- /** @oneof */
471
- interface IdentificationDataIdOneOf {
472
- /**
473
- * ID of a site visitor that has not logged in to the site.
474
- * @format GUID
475
- */
476
- anonymousVisitorId?: string;
477
- /**
478
- * ID of a site visitor that has logged in to the site.
479
- * @format GUID
480
- */
481
- memberId?: string;
482
- /**
483
- * ID of a Wix user (site owner, contributor, etc.).
484
- * @format GUID
485
- */
486
- wixUserId?: string;
487
- /**
488
- * ID of an app.
489
- * @format GUID
490
- */
491
- appId?: string;
492
- }
493
- declare enum WebhookIdentityType {
494
- UNKNOWN = "UNKNOWN",
495
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
496
- MEMBER = "MEMBER",
497
- WIX_USER = "WIX_USER",
498
- APP = "APP"
499
- }
500
- interface BaseEventMetadata {
501
- /**
502
- * App instance ID.
503
- * @format GUID
504
- */
505
- instanceId?: string | null;
506
- /**
507
- * Event type.
508
- * @maxLength 150
509
- */
510
- eventType?: string;
511
- /** The identification type and identity data. */
512
- identity?: IdentificationData;
513
- }
514
- interface EventMetadata extends BaseEventMetadata {
515
- /**
516
- * Unique event ID.
517
- * Allows clients to ignore duplicate webhooks.
518
- */
519
- _id?: string;
520
- /**
521
- * Assumes actions are also always typed to an entity_type
522
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
523
- */
524
- entityFqdn?: string;
525
- /**
526
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
527
- * This is although the created/updated/deleted notion is duplication of the oneof types
528
- * Example: created/updated/deleted/started/completed/email_opened
529
- */
530
- slug?: string;
531
- /** ID of the entity associated with the event. */
532
- entityId?: string;
533
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
534
- eventTime?: Date | null;
535
- /**
536
- * Whether the event was triggered as a result of a privacy regulation application
537
- * (for example, GDPR).
538
- */
539
- triggeredByAnonymizeRequest?: boolean | null;
540
- /** If present, indicates the action that triggered the event. */
541
- originatedFrom?: string | null;
542
- /**
543
- * A sequence number defining the order of updates to the underlying entity.
544
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
545
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
546
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
547
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
548
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
549
- */
550
- entityEventSequence?: string | null;
551
- }
552
- interface LoyaltyEarningRuleCreatedEnvelope {
553
- entity: LoyaltyEarningRule;
554
- metadata: EventMetadata;
555
- }
556
- interface LoyaltyEarningRuleDeletedEnvelope {
557
- metadata: EventMetadata;
558
- }
559
- interface LoyaltyEarningRuleUpdatedEnvelope {
560
- entity: LoyaltyEarningRule;
561
- metadata: EventMetadata;
562
- }
563
- interface CreateCustomLoyaltyEarningRuleOptions {
564
- /** Custom earning rule to create. */
565
- earningRule?: CustomLoyaltyEarningRule;
566
- }
567
- interface UpdateLoyaltyEarningRule {
568
- /** Fixed amount of points awarded for each qualifying activity. */
569
- fixedAmount?: FixedAmount;
570
- /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
571
- conversionRate?: ConversionRate;
572
- /**
573
- * Loyalty earning rule ID.
574
- * @format GUID
575
- * @readonly
576
- */
577
- _id?: string | null;
578
- /**
579
- * ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.
580
- * @format GUID
581
- */
582
- sourceAppId?: string;
583
- /**
584
- * ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.
585
- * @minLength 1
586
- * @maxLength 80
587
- */
588
- triggerAppId?: string;
589
- /**
590
- * Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`.
591
- * @minLength 1
592
- * @maxLength 80
593
- */
594
- triggerActivityType?: string;
595
- /**
596
- * Name of the earning rule.
597
- * @minLength 1
598
- * @maxLength 50
599
- */
600
- title?: string;
601
- /** Current status of the earning rule. */
602
- status?: Status;
603
- /**
604
- * Revision number, incremented by 1 each time the earning rule is updated.
605
- * Pass the latest revision when updating to prevent conflicting changes.
606
- */
607
- revision?: string | null;
608
- /**
609
- * Date and time the earning rule was created.
610
- * @readonly
611
- */
612
- _createdDate?: Date | null;
613
- /**
614
- * Date and time the earning rule was last updated.
615
- * @readonly
616
- */
617
- _updatedDate?: Date | null;
618
- /**
619
- * Additional metadata about the earning rule.
620
- * @readonly
621
- */
622
- metadata?: Metadata;
623
- }
624
- interface DeleteLoyaltyEarningRuleOptions {
625
- /**
626
- * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
627
- * Pass the latest revision when updating to prevent conflicting changes.
628
- */
629
- revision?: string;
630
- }
631
- interface ListEarningRulesOptions {
632
- /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
633
- triggerAppId?: string | null;
634
- /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */
635
- triggerActivityType?: string | null;
636
- }
637
-
638
- export { type IdentificationData as $, type ApplicationError as A, type BulkCreateLoyaltyEarningRulesResponse as B, type CreateCustomLoyaltyEarningRuleOptions as C, type DeleteLoyaltyEarningRuleOptions as D, type EarningRuleDisabled as E, type FixedAmount as F, type GetLoyaltyEarningRuleRequest as G, type CursorPaging as H, type ItemMetadata as I, type ListEarningRulesInTierResponse as J, type Cursors as K, type LoyaltyEarningRule as L, type Metadata as M, type DomainEvent as N, type DomainEventBodyOneOf as O, type PagingMetadataV2 as P, type EntityCreatedEvent as Q, type RestoreInfo as R, Status as S, Type as T, type UpdateLoyaltyEarningRule as U, type EntityUpdatedEvent as V, WebhookIdentityType as W, type EntityDeletedEvent as X, type ActionEvent as Y, type Empty as Z, type MessageEnvelope as _, type CreateCustomLoyaltyEarningRuleResponse as a, type IdentificationDataIdOneOf as a0, type BaseEventMetadata as a1, type EventMetadata as a2, type LoyaltyEarningRuleCreatedEnvelope as a3, type LoyaltyEarningRuleDeletedEnvelope as a4, type LoyaltyEarningRuleUpdatedEnvelope as a5, type UpdateLoyaltyEarningRuleResponse as b, type ListEarningRulesOptions as c, type ListEarningRulesResponse as d, LoyaltyEarningRuleTypeTagType as e, type LoyaltyEarningRuleTypeOneOf as f, type FixedAmountConfig as g, type ConversionRate as h, type ConversionRateConfig as i, type LoyaltyEarningRuleTypeTag as j, type CreateLoyaltyEarningRuleRequest as k, type CreateLoyaltyEarningRuleResponse as l, type BulkCreateLoyaltyEarningRulesRequest as m, type BulkLoyaltyEarningRuleResult as n, type BulkActionMetadata as o, type CreateCustomLoyaltyEarningRuleRequest as p, type CustomLoyaltyEarningRule as q, type CustomLoyaltyEarningRuleTypeOneOf as r, type GetLoyaltyEarningRuleResponse as s, type UpdateLoyaltyEarningRuleRequest as t, type DeleteLoyaltyEarningRuleRequest as u, type DeleteLoyaltyEarningRuleResponse as v, type DeleteAutomationEarningRuleRequest as w, type DeleteAutomationEarningRuleResponse as x, type ListEarningRulesRequest as y, type ListEarningRulesInTierRequest as z };