@wix/referral 1.0.14 → 1.0.16

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

@@ -2062,160 +2062,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 +2267,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 +2337,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 +2406,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 +2611,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 +2681,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;
@@ -2677,34 +2773,35 @@ declare namespace meta$2 {
 
 interface ReferredFriend$1 {
     /**
-     * ReferredFriend ID.
+     * ID of the referred friend.
      * @readonly
      */
     id?: string;
     /**
-     * ReferredFriend Contact ID.
+     * Contact ID of the referred friend.
      * @readonly
      */
     contactId?: string;
     /**
-     * Customer who referred.
+     * ID of the customer who referred this friend.
      * @readonly
      */
     referringCustomerId?: string;
-    /** Status of the ReferredFriend. */
+    /** Status of the referred friend. */
     status?: Status$1;
     /**
-     * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
+     * Revision number, which increments by 1 each time the referred friend is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Represents the time this ReferredFriend was created.
+     * Date and time the referred friend was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this ReferredFriend was last updated.
+     * Date and time the referred friend was last updated.
      * @readonly
      */
     updatedDate?: Date;
@@ -2712,47 +2809,49 @@ interface ReferredFriend$1 {
 declare enum Status$1 {
     /** Unknown status. */
     UNKNOWN = "UNKNOWN",
-    /** Initial status, when Referred friend joins site as member. */
+    /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
+    /** Status after the referred friend completes specific actions, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest$1 {
-    /** Referral code for referred friend */
+    /** Referral code for the referred friend. */
     referralCode?: string | null;
 }
 interface CreateReferredFriendResponse$1 {
-    /** The created ReferredFriend. */
+    /** Created referred friend. */
     referredFriend?: ReferredFriend$1;
 }
 interface GetReferredFriendRequest$1 {
-    /** Id of the ReferredFriend to retrieve. */
+    /** ID of the referred friend to retrieve. */
     referredFriendId: string;
 }
 interface GetReferredFriendResponse$1 {
-    /** The retrieved ReferredFriend. */
+    /** Retrieved referred friend. */
     referredFriend?: ReferredFriend$1;
 }
 interface GetReferredFriendByContactIdRequest$1 {
-    /** Contact id or "me" to get current identity's Contact. */
+    /** Contact ID or "me" to get the current identity's contact. */
     contactId: string;
 }
 interface GetReferredFriendByContactIdResponse$1 {
-    /** The retrieved ReferredFriend. */
+    /** Retrieved referred friend. */
     referredFriend?: ReferredFriend$1;
 }
 interface UpdateReferredFriendRequest$1 {
-    /** ReferredFriend to be updated, may be partial. */
+    /** Referred friend to be updated. May be partial. */
     referredFriend: ReferredFriend$1;
 }
 interface UpdateReferredFriendResponse$1 {
-    /** The updated ReferredFriend. */
+    /** Updated referred friend. */
     referredFriend?: ReferredFriend$1;
 }
 interface DeleteReferredFriendRequest$1 {
-    /** Id of the ReferredFriend to delete. */
     referredFriendId: string;
-    /** The revision of the ReferredFriend. */
+    /**
+     * Revision number, which increments by 1 each time the referred friend is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
+     */
     revision?: string;
 }
 interface DeleteReferredFriendResponse$1 {
@@ -2812,9 +2911,9 @@ interface CursorPaging$3 {
     cursor?: string | null;
 }
 interface QueryReferredFriendResponse$1 {
-    /** The retrieved ReferredFriends. */
+    /** Retrieved referred friends. */
     referredFriends?: ReferredFriend$1[];
-    /** CursorPagingMetadata. */
+    /** Cursor paging metadata. */
     metadata?: CursorPagingMetadata$3;
 }
 interface CursorPagingMetadata$3 {
@@ -2860,34 +2959,35 @@ interface QueryReferredFriendResponseNonNullableFields$1 {
 
 interface ReferredFriend {
     /**
-     * ReferredFriend ID.
+     * ID of the referred friend.
      * @readonly
      */
     _id?: string;
     /**
-     * ReferredFriend Contact ID.
+     * Contact ID of the referred friend.
      * @readonly
      */
     contactId?: string;
     /**
-     * Customer who referred.
+     * ID of the customer who referred this friend.
      * @readonly
      */
     referringCustomerId?: string;
-    /** Status of the ReferredFriend. */
+    /** Status of the referred friend. */
     status?: Status;
     /**
-     * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
+     * Revision number, which increments by 1 each time the referred friend is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Represents the time this ReferredFriend was created.
+     * Date and time the referred friend was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferredFriend was last updated.
+     * Date and time the referred friend was last updated.
      * @readonly
      */
     _updatedDate?: Date;
@@ -2895,47 +2995,49 @@ interface ReferredFriend {
 declare enum Status {
     /** Unknown status. */
     UNKNOWN = "UNKNOWN",
-    /** Initial status, when Referred friend joins site as member. */
+    /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
+    /** Status after the referred friend completes specific actions, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest {
-    /** Referral code for referred friend */
+    /** Referral code for the referred friend. */
     referralCode?: string | null;
 }
 interface CreateReferredFriendResponse {
-    /** The created ReferredFriend. */
+    /** Created referred friend. */
     referredFriend?: ReferredFriend;
 }
 interface GetReferredFriendRequest {
-    /** Id of the ReferredFriend to retrieve. */
+    /** ID of the referred friend to retrieve. */
     referredFriendId: string;
 }
 interface GetReferredFriendResponse {
-    /** The retrieved ReferredFriend. */
+    /** Retrieved referred friend. */
     referredFriend?: ReferredFriend;
 }
 interface GetReferredFriendByContactIdRequest {
-    /** Contact id or "me" to get current identity's Contact. */
+    /** Contact ID or "me" to get the current identity's contact. */
     contactId: string;
 }
 interface GetReferredFriendByContactIdResponse {
-    /** The retrieved ReferredFriend. */
+    /** Retrieved referred friend. */
     referredFriend?: ReferredFriend;
 }
 interface UpdateReferredFriendRequest {
-    /** ReferredFriend to be updated, may be partial. */
+    /** Referred friend to be updated. May be partial. */
     referredFriend: ReferredFriend;
 }
 interface UpdateReferredFriendResponse {
-    /** The updated ReferredFriend. */
+    /** Updated referred friend. */
     referredFriend?: ReferredFriend;
 }
 interface DeleteReferredFriendRequest {
-    /** Id of the ReferredFriend to delete. */
     referredFriendId: string;
-    /** The revision of the ReferredFriend. */
+    /**
+     * Revision number, which increments by 1 each time the referred friend is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
+     */
     revision?: string;
 }
 interface DeleteReferredFriendResponse {
@@ -2995,9 +3097,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface QueryReferredFriendResponse {
-    /** The retrieved ReferredFriends. */
+    /** Retrieved referred friends. */
     referredFriends?: ReferredFriend[];
-    /** CursorPagingMetadata. */
+    /** Cursor paging metadata. */
     metadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {