@wix/referral 1.0.34 → 1.0.36

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/referral",
3
- "version": "1.0.34",
3
+ "version": "1.0.36",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@wix/referral_customers": "1.0.14",
22
22
  "@wix/referral_friends": "1.0.11",
23
- "@wix/referral_programs": "1.0.19",
23
+ "@wix/referral_programs": "1.0.21",
24
24
  "@wix/referral_rewards": "1.0.13",
25
- "@wix/referral_tracker": "1.0.15"
25
+ "@wix/referral_tracker": "1.0.16"
26
26
  },
27
27
  "devDependencies": {
28
28
  "glob": "^10.4.1",
@@ -47,5 +47,5 @@
47
47
  "fqdn": ""
48
48
  }
49
49
  },
50
- "falconPackageHash": "1a7df3244e3a998ad4bbc7303820de5c4f7c73688c40faf2801f29f2"
50
+ "falconPackageHash": "1c8ce0b59293b714d67857de5bf5f84d3f8afaee7207704b0af31056"
51
51
  }
@@ -451,18 +451,6 @@ interface ReferralProgram {
451
451
  * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
452
452
  */
453
453
  successfulReferralActions?: Action[];
454
- /**
455
- * Whether the user has the required plan to use the referral program.
456
- *
457
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
458
- * @readonly
459
- * @deprecated Whether the user has the required plan to use the referral program.
460
- *
461
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
462
- * @replacedBy GetReferralProgramPremiumFeatures
463
- * @targetRemovalDate 2024-09-01
464
- */
465
- isPremium?: boolean;
466
454
  /** Configures email notifications for the referral program. */
467
455
  emails?: Emails;
468
456
  /**
@@ -567,7 +555,7 @@ declare enum DiscountType$2 {
567
555
  FIXED_AMOUNT = "FIXED_AMOUNT",
568
556
  /** Discount as a percentage. */
569
557
  PERCENTAGE = "PERCENTAGE",
570
- /** Free shipping. */
558
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
571
559
  FREE_SHIPPING = "FREE_SHIPPING"
572
560
  }
573
561
  interface FixedAmountDiscount$2 {
@@ -597,15 +585,15 @@ interface LoyaltyPoints$2 {
597
585
  declare enum Action {
598
586
  /** Unknown action. */
599
587
  UNKNOWN = "UNKNOWN",
600
- /** Store order placed. */
588
+ /** Referred friend ordered and paid for an order in a store. */
601
589
  STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
602
- /** Pricing plan ordered. */
590
+ /** Referred friend ordered and paid for a plan */
603
591
  PLAN_ORDERED = "PLAN_ORDERED",
604
- /** Wix events ticket ordered. */
592
+ /** Referred friend ordered and paid for a ticket. */
605
593
  TICKET_ORDERED = "TICKET_ORDERED",
606
- /** Bookings session booked. */
594
+ /** Referred friend booked and paid for a session. */
607
595
  SESSION_BOOKED = "SESSION_BOOKED",
608
- /** Restaurant order placed. */
596
+ /** Referred friend placed and paid for a restaurant order. */
609
597
  RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
610
598
  }
611
599
  interface Emails {
@@ -631,15 +619,15 @@ interface Emails {
631
619
  declare enum App {
632
620
  /** Unknown app. */
633
621
  UNKNOWN = "UNKNOWN",
634
- /** Wix stores. */
622
+ /** Send an email to customers who've placed an order with stores. */
635
623
  STORES = "STORES",
636
- /** Wix pricing plans. */
624
+ /** Send an email to customers who've placed an order with pricing plans. */
637
625
  PRICING_PLANS = "PRICING_PLANS",
638
- /** Wix events. */
626
+ /** Send an email to customers who've placed an order with events. */
639
627
  EVENTS = "EVENTS",
640
- /** Wix bookings. */
628
+ /** Send an email to customers who've placed an order with bookings. */
641
629
  BOOKINGS = "BOOKINGS",
642
- /** Wix restaurants. */
630
+ /** Send an email to customers who've placed an order with restaurants. */
643
631
  RESTAURANTS = "RESTAURANTS"
644
632
  }
645
633
  interface PremiumFeatures {
@@ -1713,7 +1701,6 @@ interface ReferralProgramNonNullableFields {
1713
1701
  referredFriendReward?: RewardNonNullableFields;
1714
1702
  referringCustomerReward?: RewardNonNullableFields;
1715
1703
  successfulReferralActions: Action[];
1716
- isPremium: boolean;
1717
1704
  emails?: EmailsNonNullableFields;
1718
1705
  premiumFeatures?: PremiumFeaturesNonNullableFields;
1719
1706
  }
@@ -2439,7 +2426,7 @@ declare enum DiscountType$1 {
2439
2426
  FIXED_AMOUNT = "FIXED_AMOUNT",
2440
2427
  /** Discount as a percentage. */
2441
2428
  PERCENTAGE = "PERCENTAGE",
2442
- /** Free shipping. */
2429
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
2443
2430
  FREE_SHIPPING = "FREE_SHIPPING"
2444
2431
  }
2445
2432
  interface FixedAmountDiscount$1 {
@@ -451,18 +451,6 @@ interface ReferralProgram {
451
451
  * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
452
452
  */
453
453
  successfulReferralActions?: Action[];
454
- /**
455
- * Whether the user has the required plan to use the referral program.
456
- *
457
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
458
- * @readonly
459
- * @deprecated Whether the user has the required plan to use the referral program.
460
- *
461
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
462
- * @replacedBy GetReferralProgramPremiumFeatures
463
- * @targetRemovalDate 2024-09-01
464
- */
465
- isPremium?: boolean;
466
454
  /** Configures email notifications for the referral program. */
467
455
  emails?: Emails;
468
456
  /**
@@ -567,7 +555,7 @@ declare enum DiscountType$2 {
567
555
  FIXED_AMOUNT = "FIXED_AMOUNT",
568
556
  /** Discount as a percentage. */
569
557
  PERCENTAGE = "PERCENTAGE",
570
- /** Free shipping. */
558
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
571
559
  FREE_SHIPPING = "FREE_SHIPPING"
572
560
  }
573
561
  interface FixedAmountDiscount$2 {
@@ -597,15 +585,15 @@ interface LoyaltyPoints$2 {
597
585
  declare enum Action {
598
586
  /** Unknown action. */
599
587
  UNKNOWN = "UNKNOWN",
600
- /** Store order placed. */
588
+ /** Referred friend ordered and paid for an order in a store. */
601
589
  STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
602
- /** Pricing plan ordered. */
590
+ /** Referred friend ordered and paid for a plan */
603
591
  PLAN_ORDERED = "PLAN_ORDERED",
604
- /** Wix events ticket ordered. */
592
+ /** Referred friend ordered and paid for a ticket. */
605
593
  TICKET_ORDERED = "TICKET_ORDERED",
606
- /** Bookings session booked. */
594
+ /** Referred friend booked and paid for a session. */
607
595
  SESSION_BOOKED = "SESSION_BOOKED",
608
- /** Restaurant order placed. */
596
+ /** Referred friend placed and paid for a restaurant order. */
609
597
  RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
610
598
  }
611
599
  interface Emails {
@@ -631,15 +619,15 @@ interface Emails {
631
619
  declare enum App {
632
620
  /** Unknown app. */
633
621
  UNKNOWN = "UNKNOWN",
634
- /** Wix stores. */
622
+ /** Send an email to customers who've placed an order with stores. */
635
623
  STORES = "STORES",
636
- /** Wix pricing plans. */
624
+ /** Send an email to customers who've placed an order with pricing plans. */
637
625
  PRICING_PLANS = "PRICING_PLANS",
638
- /** Wix events. */
626
+ /** Send an email to customers who've placed an order with events. */
639
627
  EVENTS = "EVENTS",
640
- /** Wix bookings. */
628
+ /** Send an email to customers who've placed an order with bookings. */
641
629
  BOOKINGS = "BOOKINGS",
642
- /** Wix restaurants. */
630
+ /** Send an email to customers who've placed an order with restaurants. */
643
631
  RESTAURANTS = "RESTAURANTS"
644
632
  }
645
633
  interface PremiumFeatures {
@@ -1713,7 +1701,6 @@ interface ReferralProgramNonNullableFields {
1713
1701
  referredFriendReward?: RewardNonNullableFields;
1714
1702
  referringCustomerReward?: RewardNonNullableFields;
1715
1703
  successfulReferralActions: Action[];
1716
- isPremium: boolean;
1717
1704
  emails?: EmailsNonNullableFields;
1718
1705
  premiumFeatures?: PremiumFeaturesNonNullableFields;
1719
1706
  }
@@ -2439,7 +2426,7 @@ declare enum DiscountType$1 {
2439
2426
  FIXED_AMOUNT = "FIXED_AMOUNT",
2440
2427
  /** Discount as a percentage. */
2441
2428
  PERCENTAGE = "PERCENTAGE",
2442
- /** Free shipping. */
2429
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
2443
2430
  FREE_SHIPPING = "FREE_SHIPPING"
2444
2431
  }
2445
2432
  interface FixedAmountDiscount$1 {
@@ -41,18 +41,6 @@ interface ReferralProgram$1 {
41
41
  * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
42
42
  */
43
43
  successfulReferralActions?: Action$1[];
44
- /**
45
- * Whether the user has the required plan to use the referral program.
46
- *
47
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
48
- * @readonly
49
- * @deprecated Whether the user has the required plan to use the referral program.
50
- *
51
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
52
- * @replacedBy GetReferralProgramPremiumFeatures
53
- * @targetRemovalDate 2024-09-01
54
- */
55
- isPremium?: boolean;
56
44
  /** Configures email notifications for the referral program. */
57
45
  emails?: Emails$1;
58
46
  /**
@@ -157,7 +145,7 @@ declare enum DiscountType$5 {
157
145
  FIXED_AMOUNT = "FIXED_AMOUNT",
158
146
  /** Discount as a percentage. */
159
147
  PERCENTAGE = "PERCENTAGE",
160
- /** Free shipping. */
148
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
161
149
  FREE_SHIPPING = "FREE_SHIPPING"
162
150
  }
163
151
  interface FixedAmountDiscount$5 {
@@ -187,15 +175,15 @@ interface LoyaltyPoints$3 {
187
175
  declare enum Action$1 {
188
176
  /** Unknown action. */
189
177
  UNKNOWN = "UNKNOWN",
190
- /** Store order placed. */
178
+ /** Referred friend ordered and paid for an order in a store. */
191
179
  STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
192
- /** Pricing plan ordered. */
180
+ /** Referred friend ordered and paid for a plan */
193
181
  PLAN_ORDERED = "PLAN_ORDERED",
194
- /** Wix events ticket ordered. */
182
+ /** Referred friend ordered and paid for a ticket. */
195
183
  TICKET_ORDERED = "TICKET_ORDERED",
196
- /** Bookings session booked. */
184
+ /** Referred friend booked and paid for a session. */
197
185
  SESSION_BOOKED = "SESSION_BOOKED",
198
- /** Restaurant order placed. */
186
+ /** Referred friend placed and paid for a restaurant order. */
199
187
  RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
200
188
  }
201
189
  interface Emails$1 {
@@ -221,15 +209,15 @@ interface Emails$1 {
221
209
  declare enum App$1 {
222
210
  /** Unknown app. */
223
211
  UNKNOWN = "UNKNOWN",
224
- /** Wix stores. */
212
+ /** Send an email to customers who've placed an order with stores. */
225
213
  STORES = "STORES",
226
- /** Wix pricing plans. */
214
+ /** Send an email to customers who've placed an order with pricing plans. */
227
215
  PRICING_PLANS = "PRICING_PLANS",
228
- /** Wix events. */
216
+ /** Send an email to customers who've placed an order with events. */
229
217
  EVENTS = "EVENTS",
230
- /** Wix bookings. */
218
+ /** Send an email to customers who've placed an order with bookings. */
231
219
  BOOKINGS = "BOOKINGS",
232
- /** Wix restaurants. */
220
+ /** Send an email to customers who've placed an order with restaurants. */
233
221
  RESTAURANTS = "RESTAURANTS"
234
222
  }
235
223
  interface PremiumFeatures$1 {
@@ -341,7 +329,6 @@ interface ReferralProgramNonNullableFields$1 {
341
329
  referredFriendReward?: RewardNonNullableFields$1;
342
330
  referringCustomerReward?: RewardNonNullableFields$1;
343
331
  successfulReferralActions: Action$1[];
344
- isPremium: boolean;
345
332
  emails?: EmailsNonNullableFields$1;
346
333
  premiumFeatures?: PremiumFeaturesNonNullableFields$1;
347
334
  }
@@ -414,18 +401,6 @@ interface ReferralProgram {
414
401
  * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
415
402
  */
416
403
  successfulReferralActions?: Action[];
417
- /**
418
- * Whether the user has the required plan to use the referral program.
419
- *
420
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
421
- * @readonly
422
- * @deprecated Whether the user has the required plan to use the referral program.
423
- *
424
- * Deprecated: Use [Get Referral Program Premium Features](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features) instead.
425
- * @replacedBy GetReferralProgramPremiumFeatures
426
- * @targetRemovalDate 2024-09-01
427
- */
428
- isPremium?: boolean;
429
404
  /** Configures email notifications for the referral program. */
430
405
  emails?: Emails;
431
406
  /**
@@ -530,7 +505,7 @@ declare enum DiscountType$4 {
530
505
  FIXED_AMOUNT = "FIXED_AMOUNT",
531
506
  /** Discount as a percentage. */
532
507
  PERCENTAGE = "PERCENTAGE",
533
- /** Free shipping. */
508
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
534
509
  FREE_SHIPPING = "FREE_SHIPPING"
535
510
  }
536
511
  interface FixedAmountDiscount$4 {
@@ -560,15 +535,15 @@ interface LoyaltyPoints$2 {
560
535
  declare enum Action {
561
536
  /** Unknown action. */
562
537
  UNKNOWN = "UNKNOWN",
563
- /** Store order placed. */
538
+ /** Referred friend ordered and paid for an order in a store. */
564
539
  STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
565
- /** Pricing plan ordered. */
540
+ /** Referred friend ordered and paid for a plan */
566
541
  PLAN_ORDERED = "PLAN_ORDERED",
567
- /** Wix events ticket ordered. */
542
+ /** Referred friend ordered and paid for a ticket. */
568
543
  TICKET_ORDERED = "TICKET_ORDERED",
569
- /** Bookings session booked. */
544
+ /** Referred friend booked and paid for a session. */
570
545
  SESSION_BOOKED = "SESSION_BOOKED",
571
- /** Restaurant order placed. */
546
+ /** Referred friend placed and paid for a restaurant order. */
572
547
  RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
573
548
  }
574
549
  interface Emails {
@@ -594,15 +569,15 @@ interface Emails {
594
569
  declare enum App {
595
570
  /** Unknown app. */
596
571
  UNKNOWN = "UNKNOWN",
597
- /** Wix stores. */
572
+ /** Send an email to customers who've placed an order with stores. */
598
573
  STORES = "STORES",
599
- /** Wix pricing plans. */
574
+ /** Send an email to customers who've placed an order with pricing plans. */
600
575
  PRICING_PLANS = "PRICING_PLANS",
601
- /** Wix events. */
576
+ /** Send an email to customers who've placed an order with events. */
602
577
  EVENTS = "EVENTS",
603
- /** Wix bookings. */
578
+ /** Send an email to customers who've placed an order with bookings. */
604
579
  BOOKINGS = "BOOKINGS",
605
- /** Wix restaurants. */
580
+ /** Send an email to customers who've placed an order with restaurants. */
606
581
  RESTAURANTS = "RESTAURANTS"
607
582
  }
608
583
  interface PremiumFeatures {
@@ -714,7 +689,6 @@ interface ReferralProgramNonNullableFields {
714
689
  referredFriendReward?: RewardNonNullableFields;
715
690
  referringCustomerReward?: RewardNonNullableFields;
716
691
  successfulReferralActions: Action[];
717
- isPremium: boolean;
718
692
  emails?: EmailsNonNullableFields;
719
693
  premiumFeatures?: PremiumFeaturesNonNullableFields;
720
694
  }
@@ -1186,7 +1160,7 @@ declare enum DiscountType$3 {
1186
1160
  FIXED_AMOUNT = "FIXED_AMOUNT",
1187
1161
  /** Discount as a percentage. */
1188
1162
  PERCENTAGE = "PERCENTAGE",
1189
- /** Free shipping. */
1163
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
1190
1164
  FREE_SHIPPING = "FREE_SHIPPING"
1191
1165
  }
1192
1166
  interface FixedAmountDiscount$3 {
@@ -1728,7 +1702,7 @@ declare enum DiscountType$2 {
1728
1702
  FIXED_AMOUNT = "FIXED_AMOUNT",
1729
1703
  /** Discount as a percentage. */
1730
1704
  PERCENTAGE = "PERCENTAGE",
1731
- /** Free shipping. */
1705
+ /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
1732
1706
  FREE_SHIPPING = "FREE_SHIPPING"
1733
1707
  }
1734
1708
  interface FixedAmountDiscount$2 {