@wix/referral 1.0.15 → 1.0.17

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 {
@@ -2062,160 +2068,202 @@ declare namespace meta$3 {
   export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getReferralEvent as getReferralEvent, meta$3_getReferralStatistics as getReferralStatistics, meta$3_queryReferralEvent as queryReferralEvent, meta$3_queryReferredFriendActions as queryReferredFriendActions, meta$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
 }
 
-/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
 interface ReferralReward$1 extends ReferralRewardReceiverOneOf$1, ReferralRewardRewardTypeOptionsOneOf$1 {
     /**
-     * Referring customer ID.
+     * ID of the referring customer who received the reward.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * Referred friend ID.
+     * ID of the referred friend who received the reward.
      * @readonly
      */
     rewardedReferredFriendId?: string;
-    /** Coupon reward type options. */
+    /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
     coupon?: V1Coupon$1;
-    /** Loyalty points reward type options. */
+    /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
     loyaltyPoints?: V1LoyaltyPoints$1;
     /**
-     * ReferralReward ID.
+     * Referral reward ID.
      * @readonly
      */
     id?: string | null;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referral reward is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referral reward.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferralReward was created.
+     * Date and time the referral reward was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this ReferralReward was last updated.
+     * Date and time the referral reward was last updated.
      * @readonly
      */
     updatedDate?: Date;
-    /** Reward type. */
+    /**
+     * Type of reward given.
+     *
+     * Possible values:
+     * - `UNKNOWN`: Unknown reward.
+     * - `COUPON`: A loyalty coupon is given.
+     * - `LOYALTY_POINTS`: Loyalty points are awarded.
+     * - `NOTHING`: No reward is given.
+     */
     rewardType?: RewardTypeType$1;
 }
 /** @oneof */
 interface ReferralRewardReceiverOneOf$1 {
     /**
-     * Referring customer ID.
+     * ID of the referring customer who received the reward.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * Referred friend ID.
+     * ID of the referred friend who received the reward.
      * @readonly
      */
     rewardedReferredFriendId?: string;
 }
 /** @oneof */
 interface ReferralRewardRewardTypeOptionsOneOf$1 {
-    /** Coupon reward type options. */
+    /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
     coupon?: V1Coupon$1;
-    /** Loyalty points reward type options. */
+    /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
     loyaltyPoints?: V1LoyaltyPoints$1;
 }
 declare enum RewardTypeType$1 {
-    /** Unknown reward type. */
+    /** Unknown reward. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon reward type. */
+    /** A loyalty coupon is given. */
     COUPON = "COUPON",
-    /** Loyalty points reward type. */
+    /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
-    /** No reward. */
+    /** No reward is given. */
     NOTHING = "NOTHING"
 }
 interface V1Coupon$1 {
     /**
-     * Coupon ID.
+     * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
      * @readonly
      */
     id?: string;
     /**
-     * Coupon code.
+     * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
      * @readonly
      */
     code?: string;
     /**
-     * Coupon status.
+     * Current status of the coupon.
+     *
+     * Possible values:
+     *
+     * - `UNKNOWN`: Unknown coupon status.
+     * - `ACTIVE`: Coupon is active and can be applied.
+     * - `APPLIED`: Coupon was already applied and can't be used anymore.
+     * - `DELETED`: Coupon was deleted.
      * @readonly
      */
     status?: Status$3;
     /**
-     * Coupon specification.
+     * Detailed specifications of the coupon.
      * @readonly
      */
     couponSpecification?: Coupon$1;
 }
 declare enum Status$3 {
-    /** Unknown coupon status. */
+    /** The coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon is active and can be applied. */
+    /** The coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** Coupon was already applied and can not be used anymore. */
+    /** The coupon has been applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** Coupon was deleted. */
+    /** The coupon has been deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$1;
-    /** Options for percentage discount type */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$1;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$1;
-    /** Coupon name */
+    /** Coupon name. */
     name?: string;
-    /** Coupon discount type */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType$1;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$1 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$1;
-    /** Options for percentage discount type */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$1;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf$1 {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$1;
 }
 declare enum DiscountType$1 {
+    /** Unknown discount type. */
     UNKNOWN = "UNKNOWN",
-    /** Discount as a fixed amount */
+    /** Discount as a fixed amount. */
     FIXED_AMOUNT = "FIXED_AMOUNT",
-    /** Discount as a percentage */
+    /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping */
+    /** Free shipping. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$1 {
-    /** Fixed amount to discount */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$1 {
+    /** Percentage of discount. */
     percentage?: number;
 }
 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 */
     group?: Group$1;
 }
 interface Group$1 {
+    /** Name of the group. */
     name?: string;
+    /** Entity ID of the group. */
     entityId?: string | null;
 }
 interface V1LoyaltyPoints$1 {
@@ -2225,46 +2273,52 @@ interface V1LoyaltyPoints$1 {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
 }
 interface GetReferralRewardRequest$1 {
-    /** Id of the ReferralReward to retrieve. */
+    /** Referral reward ID. */
     id: string;
 }
 interface GetReferralRewardResponse$1 {
-    /** The retrieved ReferralReward. */
+    /** Retrieved referral reward. */
     referralReward?: ReferralReward$1;
 }
 interface QueryReferralRewardsRequest$1 {
-    /** Query to filter ReferralRewards. */
+    /** Query to filter referral rewards. */
     query: CursorQuery$5;
-    /** Filter by contact id or set to "me" for current identity's rewards. */
+    /** Contact ID to filter rewards by. Use `"me"` for current identity's rewards. */
     contactId?: string | null;
 }
 interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$5;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$5[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$5 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$5;
 }
 interface Sorting$5 {
@@ -2289,13 +2343,13 @@ interface CursorPaging$5 {
     cursor?: string | null;
 }
 interface QueryReferralRewardsResponse$1 {
-    /** The retrieved ReferralRewards. */
+    /** Retrieved referral rewards. */
     referralRewards?: ReferralReward$1[];
     /** Metadata for paging. */
     metadata?: CursorPagingMetadata$5;
 }
 interface CursorPagingMetadata$5 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$5;
@@ -2358,160 +2412,202 @@ interface QueryReferralRewardsResponseNonNullableFields$1 {
     referralRewards: ReferralRewardNonNullableFields$1[];
 }
 
-/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
 interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewardTypeOptionsOneOf {
     /**
-     * Referring customer ID.
+     * ID of the referring customer who received the reward.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * Referred friend ID.
+     * ID of the referred friend who received the reward.
      * @readonly
      */
     rewardedReferredFriendId?: string;
-    /** Coupon reward type options. */
+    /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
     coupon?: V1Coupon;
-    /** Loyalty points reward type options. */
+    /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
     loyaltyPoints?: V1LoyaltyPoints;
     /**
-     * ReferralReward ID.
+     * Referral reward ID.
      * @readonly
      */
     _id?: string | null;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referral reward is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referral reward.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferralReward was created.
+     * Date and time the referral reward was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferralReward was last updated.
+     * Date and time the referral reward was last updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** Reward type. */
+    /**
+     * Type of reward given.
+     *
+     * Possible values:
+     * - `UNKNOWN`: Unknown reward.
+     * - `COUPON`: A loyalty coupon is given.
+     * - `LOYALTY_POINTS`: Loyalty points are awarded.
+     * - `NOTHING`: No reward is given.
+     */
     rewardType?: RewardTypeType;
 }
 /** @oneof */
 interface ReferralRewardReceiverOneOf {
     /**
-     * Referring customer ID.
+     * ID of the referring customer who received the reward.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * Referred friend ID.
+     * ID of the referred friend who received the reward.
      * @readonly
      */
     rewardedReferredFriendId?: string;
 }
 /** @oneof */
 interface ReferralRewardRewardTypeOptionsOneOf {
-    /** Coupon reward type options. */
+    /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
     coupon?: V1Coupon;
-    /** Loyalty points reward type options. */
+    /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
     loyaltyPoints?: V1LoyaltyPoints;
 }
 declare enum RewardTypeType {
-    /** Unknown reward type. */
+    /** Unknown reward. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon reward type. */
+    /** A loyalty coupon is given. */
     COUPON = "COUPON",
-    /** Loyalty points reward type. */
+    /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
-    /** No reward. */
+    /** No reward is given. */
     NOTHING = "NOTHING"
 }
 interface V1Coupon {
     /**
-     * Coupon ID.
+     * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
      * @readonly
      */
     _id?: string;
     /**
-     * Coupon code.
+     * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
      * @readonly
      */
     code?: string;
     /**
-     * Coupon status.
+     * Current status of the coupon.
+     *
+     * Possible values:
+     *
+     * - `UNKNOWN`: Unknown coupon status.
+     * - `ACTIVE`: Coupon is active and can be applied.
+     * - `APPLIED`: Coupon was already applied and can't be used anymore.
+     * - `DELETED`: Coupon was deleted.
      * @readonly
      */
     status?: Status$2;
     /**
-     * Coupon specification.
+     * Detailed specifications of the coupon.
      * @readonly
      */
     couponSpecification?: Coupon;
 }
 declare enum Status$2 {
-    /** Unknown coupon status. */
+    /** The coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon is active and can be applied. */
+    /** The coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** Coupon was already applied and can not be used anymore. */
+    /** The coupon has been applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** Coupon was deleted. */
+    /** The coupon has been deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount type */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope;
-    /** Coupon name */
+    /** Coupon name. */
     name?: string;
-    /** Coupon discount type */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount type */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope;
 }
 declare enum DiscountType {
+    /** Unknown discount type. */
     UNKNOWN = "UNKNOWN",
-    /** Discount as a fixed amount */
+    /** Discount as a fixed amount. */
     FIXED_AMOUNT = "FIXED_AMOUNT",
-    /** Discount as a percentage */
+    /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping */
+    /** Free shipping. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount {
-    /** Fixed amount to discount */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount {
+    /** Percentage of discount. */
     percentage?: number;
 }
 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 */
     group?: Group;
 }
 interface Group {
+    /** Name of the group. */
     name?: string;
+    /** Entity ID of the group. */
     entityId?: string | null;
 }
 interface V1LoyaltyPoints {
@@ -2521,46 +2617,52 @@ interface V1LoyaltyPoints {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
 }
 interface GetReferralRewardRequest {
-    /** Id of the ReferralReward to retrieve. */
+    /** Referral reward ID. */
     _id: string;
 }
 interface GetReferralRewardResponse {
-    /** The retrieved ReferralReward. */
+    /** Retrieved referral reward. */
     referralReward?: ReferralReward;
 }
 interface QueryReferralRewardsRequest {
-    /** Query to filter ReferralRewards. */
+    /** Query to filter referral rewards. */
     query: CursorQuery$4;
-    /** Filter by contact id or set to "me" for current identity's rewards. */
+    /** Contact ID to filter rewards by. Use `"me"` for current identity's rewards. */
     contactId?: string | null;
 }
 interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$4;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$4[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$4 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$4;
 }
 interface Sorting$4 {
@@ -2585,13 +2687,13 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface QueryReferralRewardsResponse {
-    /** The retrieved ReferralRewards. */
+    /** Retrieved referral rewards. */
     referralRewards?: ReferralReward[];
     /** Metadata for paging. */
     metadata?: CursorPagingMetadata$4;
 }
 interface CursorPagingMetadata$4 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$4;