@wix/referral 1.0.16 → 1.0.18

package/type-bundles/meta.bundle.d.ts

@@ -39,7 +39,7 @@ interface ReferralProgram$1 {
      */
     referringCustomerReward?: Reward$3;
     /**
-     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
+     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an item.
      *
      * Possible values:
      *
@@ -84,7 +84,7 @@ declare enum ProgramStatus$1 {
 interface Reward$3 extends RewardOptionsOneOf$1 {
     /** Options for coupon reward type. */
     couponOptions?: Coupon$5;
-    /** Options for Loyalty points reward type. */
+    /** Options for the Loyalty points reward type. */
     loyaltyPointsOptions?: LoyaltyPoints$3;
     /** Type of the reward. */
     type?: Type$1;
@@ -93,7 +93,7 @@ interface Reward$3 extends RewardOptionsOneOf$1 {
 interface RewardOptionsOneOf$1 {
     /** Options for coupon reward type. */
     couponOptions?: Coupon$5;
-    /** Options for Loyalty points reward type. */
+    /** Options for the Loyalty points reward type. */
     loyaltyPointsOptions?: LoyaltyPoints$3;
 }
 declare enum Type$1 {
@@ -109,7 +109,7 @@ declare enum Type$1 {
 interface Coupon$5 extends CouponDiscountTypeOptionsOneOf$5, CouponScopeOrMinSubtotalOneOf$5 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$5;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$5;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -149,7 +149,7 @@ interface Coupon$5 extends CouponDiscountTypeOptionsOneOf$5, CouponScopeOrMinSub
 interface CouponDiscountTypeOptionsOneOf$5 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$5;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$5;
 }
 /** @oneof */
@@ -170,7 +170,7 @@ declare enum DiscountType$5 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$5 {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$5 {
@@ -180,7 +180,7 @@ interface PercentageDiscount$5 {
 interface CouponScope$5 {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group$5;
 }
 interface Group$5 {
@@ -221,7 +221,10 @@ interface Emails$1 {
      * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
      */
     encourageToReferFriends?: App$1[];
-    /** Whether to notify customers about their referral reward email. Set to `true` to enable email notifications. */
+    /**
+     * Whether to send email notifications to referring customers when they receive a referral reward.
+     * If true, referring customers will be notified by email when their referred friend completes a qualifying action (for example, placing an order).
+     */
     notifyCustomersAboutReward?: boolean;
 }
 declare enum App$1 {
@@ -240,7 +243,7 @@ declare enum App$1 {
 }
 interface PremiumFeatures$1 {
     /**
-     * Whether the user has access to the referral program feature.
+     * Whether the site owner has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -351,7 +354,7 @@ interface PauseReferralProgramResponse$1 {
     referralProgram?: ReferralProgram$1;
 }
 interface GetAISocialMediaPostsSuggestionsRequest$1 {
-    /** Topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. For example, fitness, education, technology. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse$1 {
@@ -367,7 +370,7 @@ interface AISocialMediaPostSuggestion$1 {
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest$1 {
-    /** Topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. For example, fitness, education, technology. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse$1 {
@@ -500,7 +503,7 @@ interface ReferralProgram {
      */
     referringCustomerReward?: Reward$2;
     /**
-     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
+     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an item.
      *
      * Possible values:
      *
@@ -545,7 +548,7 @@ declare enum ProgramStatus {
 interface Reward$2 extends RewardOptionsOneOf {
     /** Options for coupon reward type. */
     couponOptions?: Coupon$4;
-    /** Options for Loyalty points reward type. */
+    /** Options for the Loyalty points reward type. */
     loyaltyPointsOptions?: LoyaltyPoints$2;
     /** Type of the reward. */
     type?: Type;
@@ -554,7 +557,7 @@ interface Reward$2 extends RewardOptionsOneOf {
 interface RewardOptionsOneOf {
     /** Options for coupon reward type. */
     couponOptions?: Coupon$4;
-    /** Options for Loyalty points reward type. */
+    /** Options for the Loyalty points reward type. */
     loyaltyPointsOptions?: LoyaltyPoints$2;
 }
 declare enum Type {
@@ -570,7 +573,7 @@ declare enum Type {
 interface Coupon$4 extends CouponDiscountTypeOptionsOneOf$4, CouponScopeOrMinSubtotalOneOf$4 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$4;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$4;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -610,7 +613,7 @@ interface Coupon$4 extends CouponDiscountTypeOptionsOneOf$4, CouponScopeOrMinSub
 interface CouponDiscountTypeOptionsOneOf$4 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$4;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$4;
 }
 /** @oneof */
@@ -631,7 +634,7 @@ declare enum DiscountType$4 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$4 {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$4 {
@@ -641,7 +644,7 @@ interface PercentageDiscount$4 {
 interface CouponScope$4 {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group$4;
 }
 interface Group$4 {
@@ -682,7 +685,10 @@ interface Emails {
      * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
      */
     encourageToReferFriends?: App[];
-    /** Whether to notify customers about their referral reward email. Set to `true` to enable email notifications. */
+    /**
+     * Whether to send email notifications to referring customers when they receive a referral reward.
+     * If true, referring customers will be notified by email when their referred friend completes a qualifying action (for example, placing an order).
+     */
     notifyCustomersAboutReward?: boolean;
 }
 declare enum App {
@@ -701,7 +707,7 @@ declare enum App {
 }
 interface PremiumFeatures {
     /**
-     * Whether the user has access to the referral program feature.
+     * Whether the site owner has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -812,7 +818,7 @@ interface PauseReferralProgramResponse {
     referralProgram?: ReferralProgram;
 }
 interface GetAISocialMediaPostsSuggestionsRequest {
-    /** Topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. For example, fitness, education, technology. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse {
@@ -828,7 +834,7 @@ interface AISocialMediaPostSuggestion {
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest {
-    /** Topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. For example, fitness, education, technology. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse {
@@ -1307,7 +1313,7 @@ declare enum Status$5 {
 interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$3;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -1347,7 +1353,7 @@ interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSub
 interface CouponDiscountTypeOptionsOneOf$3 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$3;
 }
 /** @oneof */
@@ -1368,7 +1374,7 @@ declare enum DiscountType$3 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$3 {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$3 {
@@ -1378,7 +1384,7 @@ interface PercentageDiscount$3 {
 interface CouponScope$3 {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group$3;
 }
 interface Group$3 {
@@ -1849,7 +1855,7 @@ declare enum Status$4 {
 interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$2;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -1889,7 +1895,7 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
 interface CouponDiscountTypeOptionsOneOf$2 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$2;
 }
 /** @oneof */
@@ -1910,7 +1916,7 @@ declare enum DiscountType$2 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$2 {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$2 {
@@ -1920,7 +1926,7 @@ interface PercentageDiscount$2 {
 interface CouponScope$2 {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group$2;
 }
 interface Group$2 {
@@ -2180,7 +2186,7 @@ declare enum Status$3 {
 interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$1;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$1;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -2220,7 +2226,7 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
 interface CouponDiscountTypeOptionsOneOf$1 {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$1;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount$1;
 }
 /** @oneof */
@@ -2241,7 +2247,7 @@ declare enum DiscountType$1 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$1 {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$1 {
@@ -2251,7 +2257,7 @@ interface PercentageDiscount$1 {
 interface CouponScope$1 {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group$1;
 }
 interface Group$1 {
@@ -2524,7 +2530,7 @@ declare enum Status$2 {
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
@@ -2564,7 +2570,7 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
 interface CouponDiscountTypeOptionsOneOf {
     /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount. */
+    /** Options for percentage discounts. */
     percentageOptions?: PercentageDiscount;
 }
 /** @oneof */
@@ -2585,7 +2591,7 @@ declare enum DiscountType {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount {
-    /** Amount of discount as a fixed value. */
+    /** Amount of the discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount {
@@ -2595,7 +2601,7 @@ interface PercentageDiscount {
 interface CouponScope {
     /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
+    /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
     group?: Group;
 }
 interface Group {