@wix/referral 1.0.47 → 1.0.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.47",
+  "version": "1.0.49",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,10 +22,10 @@
   ],
   "dependencies": {
     "@wix/referral_customers": "1.0.18",
-    "@wix/referral_friends": "1.0.17",
-    "@wix/referral_programs": "1.0.25",
-    "@wix/referral_rewards": "1.0.16",
-    "@wix/referral_tracker": "1.0.21"
+    "@wix/referral_friends": "1.0.19",
+    "@wix/referral_programs": "1.0.26",
+    "@wix/referral_rewards": "1.0.17",
+    "@wix/referral_tracker": "1.0.22"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -50,5 +50,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "631cd2a2bc2401e8997f16c89fb314967e550bc82f83a186bc5fd09a"
+  "falconPackageHash": "d06cf004f2bf5e090f10bc90abd087e944d2bbea4e455e7ee4cd26a4"
 }

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

@@ -506,18 +506,7 @@ interface ReferralProgram {
      * Specifies the reward given to an existing customer who referred a new customer to the business.
      */
     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 item.
-     *
-     * Possible values:
-     *
-     * - `UNKNOWN`: Action is unknown.
-     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant 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. */
     successfulReferralActions?: Action[];
     /** Configures email notifications for the referral program. */
     emails?: Emails;
@@ -529,13 +518,13 @@ interface ReferralProgram {
 }
 /** Status of the referral program. */
 declare enum ProgramStatus {
-    /** The status of the referral program is unknown. This value is not used. */
+    /** Unknown program status. */
     UNKNOWN = "UNKNOWN",
-    /** The referral program is in a draft state and is being modified. It is not yet active. */
+    /** Referral program is in a draft state and is being modified. It is not yet active. */
     DRAFT = "DRAFT",
-    /** The referral program is active. */
+    /** Referral program is active. */
     ACTIVE = "ACTIVE",
-    /** The referral program is paused. */
+    /** Referral program is paused. */
     PAUSED = "PAUSED"
 }
 interface Reward$2 extends RewardOptionsOneOf$1 {
@@ -574,14 +563,7 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
     scope?: CouponScope$2;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$2;
     /**
      * Whether the coupon is limited to one item.
@@ -655,7 +637,7 @@ declare enum Action {
     UNKNOWN = "UNKNOWN",
     /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Referred friend ordered and paid for a plan */
+    /** Referred friend ordered and paid for a plan. */
     PLAN_ORDERED = "PLAN_ORDERED",
     /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
@@ -665,18 +647,7 @@ declare enum Action {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
-    /**
-     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
-     *
-     * Available apps:
-     *
-     * - `UNKNOWN`: Unknown email.
-     * - `STORES`: Send an email to customers who've placed an order with stores.
-     * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
-     * - `EVENTS`: Send an email to customers who've placed an order with events.
-     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
-     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
-     */
+    /** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
     encourageToReferFriends?: App[];
     /**
      * Whether to send email notifications to referring customers when they receive a referral reward.
@@ -2392,13 +2363,6 @@ interface V1Coupon$1 {
     code?: string;
     /**
      * 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;
@@ -2409,13 +2373,13 @@ interface V1Coupon$1 {
     couponSpecification?: Coupon$1;
 }
 declare enum Status$2 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
@@ -2429,14 +2393,7 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
     scope?: CouponScope$1;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$1;
     /**
      * Whether the coupon is limited to one item.
@@ -3040,15 +2997,7 @@ interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewa
      * @readonly
      */
     _updatedDate?: Date | null;
-    /**
-     * 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.
-     */
+    /** Type of reward given. */
     rewardType?: RewardTypeType;
 }
 /** @oneof */
@@ -3072,9 +3021,9 @@ interface ReferralRewardRewardTypeOptionsOneOf {
     loyaltyPoints?: V1LoyaltyPoints;
 }
 declare enum RewardTypeType {
-    /** Unknown reward. */
+    /** Unknown reward type. */
     UNKNOWN = "UNKNOWN",
-    /** A loyalty coupon is given. */
+    /** Loyalty coupon is given. */
     COUPON = "COUPON",
     /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -3094,13 +3043,6 @@ interface V1Coupon {
     code?: string;
     /**
      * 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$1;
@@ -3111,13 +3053,13 @@ interface V1Coupon {
     couponSpecification?: Coupon;
 }
 declare enum Status$1 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
@@ -3131,14 +3073,7 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
     scope?: CouponScope;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType;
     /**
      * Whether the coupon is limited to one item.
@@ -3180,7 +3115,7 @@ declare enum DiscountType {
     FIXED_AMOUNT = "FIXED_AMOUNT",
     /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping. */
+    /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount {
@@ -3622,12 +3557,20 @@ interface GetReferralRewardSignature {
 declare function queryReferralRewards$1(httpClient: HttpClient): QueryReferralRewardsSignature;
 interface QueryReferralRewardsSignature {
     /**
-     * Retrieves a list of referral rewards, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referral rewards.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
-     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     * The `queryReferralRewards()` function builds a query to retrieve a list of events and returns a `ReferralRewardsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
+     *
+     * You can refine the query by chaining `ReferralRewardsQueryBuilder` functions onto the query. `ReferralRewardsQueryBuilder` functions enable you to sort, filter, and control the results `queryReferralRewards()` returns.
+     *
+     * `queryReferralRewards()` runs with these `ReferralRewardsQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryReferralRewards()` are applied in the order they're called. For example, if you apply ascending('rewardedReferredFriendId') and then descending('rewardType'), the results are sorted first by the referred friend ID, and then, if there are multiple results with the same ID, the items are sorted by reward type.
      */
     (options?: QueryReferralRewardsOptions | undefined): ReferralRewardsQueryBuilder;
 }
@@ -3717,7 +3660,7 @@ declare enum Status {
     UNKNOWN = "UNKNOWN",
     /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** Status after the referred friend completes specific actions, such as making a purchase. */
+    /** Status after the referred friend completes a specific action, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest {
@@ -4195,8 +4138,9 @@ interface GetReferredFriendSignature {
     /**
      * Retrieves a referred friend by ID.
      * @param - ID of the referred friend to retrieve.
+     * @returns Retrieved referred friend.
      */
-    (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
+    (referredFriendId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
 }
 declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
 interface GetReferredFriendByContactIdSignature {
@@ -4205,9 +4149,8 @@ interface GetReferredFriendByContactIdSignature {
      *
      * You can use `me` instead of a specific contact ID to get the referred friend for the current identity's contact.
      * @param - Contact ID or "me" to get the current identity's contact.
-     * @returns Retrieved referred friend.
      */
-    (contactId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
+    (contactId: string): Promise<GetReferredFriendByContactIdResponse & GetReferredFriendByContactIdResponseNonNullableFields>;
 }
 declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
 interface UpdateReferredFriendSignature {

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

@@ -506,18 +506,7 @@ interface ReferralProgram {
      * Specifies the reward given to an existing customer who referred a new customer to the business.
      */
     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 item.
-     *
-     * Possible values:
-     *
-     * - `UNKNOWN`: Action is unknown.
-     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant 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. */
     successfulReferralActions?: Action[];
     /** Configures email notifications for the referral program. */
     emails?: Emails;
@@ -529,13 +518,13 @@ interface ReferralProgram {
 }
 /** Status of the referral program. */
 declare enum ProgramStatus {
-    /** The status of the referral program is unknown. This value is not used. */
+    /** Unknown program status. */
     UNKNOWN = "UNKNOWN",
-    /** The referral program is in a draft state and is being modified. It is not yet active. */
+    /** Referral program is in a draft state and is being modified. It is not yet active. */
     DRAFT = "DRAFT",
-    /** The referral program is active. */
+    /** Referral program is active. */
     ACTIVE = "ACTIVE",
-    /** The referral program is paused. */
+    /** Referral program is paused. */
     PAUSED = "PAUSED"
 }
 interface Reward$2 extends RewardOptionsOneOf$1 {
@@ -574,14 +563,7 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
     scope?: CouponScope$2;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$2;
     /**
      * Whether the coupon is limited to one item.
@@ -655,7 +637,7 @@ declare enum Action {
     UNKNOWN = "UNKNOWN",
     /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Referred friend ordered and paid for a plan */
+    /** Referred friend ordered and paid for a plan. */
     PLAN_ORDERED = "PLAN_ORDERED",
     /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
@@ -665,18 +647,7 @@ declare enum Action {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
-    /**
-     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
-     *
-     * Available apps:
-     *
-     * - `UNKNOWN`: Unknown email.
-     * - `STORES`: Send an email to customers who've placed an order with stores.
-     * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
-     * - `EVENTS`: Send an email to customers who've placed an order with events.
-     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
-     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
-     */
+    /** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
     encourageToReferFriends?: App[];
     /**
      * Whether to send email notifications to referring customers when they receive a referral reward.
@@ -2392,13 +2363,6 @@ interface V1Coupon$1 {
     code?: string;
     /**
      * 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;
@@ -2409,13 +2373,13 @@ interface V1Coupon$1 {
     couponSpecification?: Coupon$1;
 }
 declare enum Status$2 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
@@ -2429,14 +2393,7 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
     scope?: CouponScope$1;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$1;
     /**
      * Whether the coupon is limited to one item.
@@ -3040,15 +2997,7 @@ interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewa
      * @readonly
      */
     _updatedDate?: Date | null;
-    /**
-     * 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.
-     */
+    /** Type of reward given. */
     rewardType?: RewardTypeType;
 }
 /** @oneof */
@@ -3072,9 +3021,9 @@ interface ReferralRewardRewardTypeOptionsOneOf {
     loyaltyPoints?: V1LoyaltyPoints;
 }
 declare enum RewardTypeType {
-    /** Unknown reward. */
+    /** Unknown reward type. */
     UNKNOWN = "UNKNOWN",
-    /** A loyalty coupon is given. */
+    /** Loyalty coupon is given. */
     COUPON = "COUPON",
     /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -3094,13 +3043,6 @@ interface V1Coupon {
     code?: string;
     /**
      * 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$1;
@@ -3111,13 +3053,13 @@ interface V1Coupon {
     couponSpecification?: Coupon;
 }
 declare enum Status$1 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
@@ -3131,14 +3073,7 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
     scope?: CouponScope;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType;
     /**
      * Whether the coupon is limited to one item.
@@ -3180,7 +3115,7 @@ declare enum DiscountType {
     FIXED_AMOUNT = "FIXED_AMOUNT",
     /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping. */
+    /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount {
@@ -3622,12 +3557,20 @@ interface GetReferralRewardSignature {
 declare function queryReferralRewards$1(httpClient: HttpClient): QueryReferralRewardsSignature;
 interface QueryReferralRewardsSignature {
     /**
-     * Retrieves a list of referral rewards, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referral rewards.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
-     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     * The `queryReferralRewards()` function builds a query to retrieve a list of events and returns a `ReferralRewardsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
+     *
+     * You can refine the query by chaining `ReferralRewardsQueryBuilder` functions onto the query. `ReferralRewardsQueryBuilder` functions enable you to sort, filter, and control the results `queryReferralRewards()` returns.
+     *
+     * `queryReferralRewards()` runs with these `ReferralRewardsQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryReferralRewards()` are applied in the order they're called. For example, if you apply ascending('rewardedReferredFriendId') and then descending('rewardType'), the results are sorted first by the referred friend ID, and then, if there are multiple results with the same ID, the items are sorted by reward type.
      */
     (options?: QueryReferralRewardsOptions | undefined): ReferralRewardsQueryBuilder;
 }
@@ -3717,7 +3660,7 @@ declare enum Status {
     UNKNOWN = "UNKNOWN",
     /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** Status after the referred friend completes specific actions, such as making a purchase. */
+    /** Status after the referred friend completes a specific action, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest {
@@ -4195,8 +4138,9 @@ interface GetReferredFriendSignature {
     /**
      * Retrieves a referred friend by ID.
      * @param - ID of the referred friend to retrieve.
+     * @returns Retrieved referred friend.
      */
-    (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
+    (referredFriendId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
 }
 declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
 interface GetReferredFriendByContactIdSignature {
@@ -4205,9 +4149,8 @@ interface GetReferredFriendByContactIdSignature {
      *
      * You can use `me` instead of a specific contact ID to get the referred friend for the current identity's contact.
      * @param - Contact ID or "me" to get the current identity's contact.
-     * @returns Retrieved referred friend.
      */
-    (contactId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
+    (contactId: string): Promise<GetReferredFriendByContactIdResponse & GetReferredFriendByContactIdResponseNonNullableFields>;
 }
 declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
 interface UpdateReferredFriendSignature {

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

@@ -28,18 +28,7 @@ interface ReferralProgram$1 {
      * Specifies the reward given to an existing customer who referred a new customer to the business.
      */
     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 item.
-     *
-     * Possible values:
-     *
-     * - `UNKNOWN`: Action is unknown.
-     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant 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. */
     successfulReferralActions?: Action$1[];
     /** Configures email notifications for the referral program. */
     emails?: Emails$1;
@@ -51,13 +40,13 @@ interface ReferralProgram$1 {
 }
 /** Status of the referral program. */
 declare enum ProgramStatus$1 {
-    /** The status of the referral program is unknown. This value is not used. */
+    /** Unknown program status. */
     UNKNOWN = "UNKNOWN",
-    /** The referral program is in a draft state and is being modified. It is not yet active. */
+    /** Referral program is in a draft state and is being modified. It is not yet active. */
     DRAFT = "DRAFT",
-    /** The referral program is active. */
+    /** Referral program is active. */
     ACTIVE = "ACTIVE",
-    /** The referral program is paused. */
+    /** Referral program is paused. */
     PAUSED = "PAUSED"
 }
 interface Reward$3 extends RewardOptionsOneOf$1 {
@@ -96,14 +85,7 @@ interface Coupon$5 extends CouponDiscountTypeOptionsOneOf$5, CouponScopeOrMinSub
     scope?: CouponScope$5;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$5;
     /**
      * Whether the coupon is limited to one item.
@@ -177,7 +159,7 @@ declare enum Action$1 {
     UNKNOWN = "UNKNOWN",
     /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Referred friend ordered and paid for a plan */
+    /** Referred friend ordered and paid for a plan. */
     PLAN_ORDERED = "PLAN_ORDERED",
     /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
@@ -187,18 +169,7 @@ declare enum Action$1 {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails$1 {
-    /**
-     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
-     *
-     * Available apps:
-     *
-     * - `UNKNOWN`: Unknown email.
-     * - `STORES`: Send an email to customers who've placed an order with stores.
-     * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
-     * - `EVENTS`: Send an email to customers who've placed an order with events.
-     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
-     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
-     */
+    /** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
     encourageToReferFriends?: App$1[];
     /**
      * Whether to send email notifications to referring customers when they receive a referral reward.
@@ -388,18 +359,7 @@ interface ReferralProgram {
      * Specifies the reward given to an existing customer who referred a new customer to the business.
      */
     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 item.
-     *
-     * Possible values:
-     *
-     * - `UNKNOWN`: Action is unknown.
-     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant 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. */
     successfulReferralActions?: Action[];
     /** Configures email notifications for the referral program. */
     emails?: Emails;
@@ -411,13 +371,13 @@ interface ReferralProgram {
 }
 /** Status of the referral program. */
 declare enum ProgramStatus {
-    /** The status of the referral program is unknown. This value is not used. */
+    /** Unknown program status. */
     UNKNOWN = "UNKNOWN",
-    /** The referral program is in a draft state and is being modified. It is not yet active. */
+    /** Referral program is in a draft state and is being modified. It is not yet active. */
     DRAFT = "DRAFT",
-    /** The referral program is active. */
+    /** Referral program is active. */
     ACTIVE = "ACTIVE",
-    /** The referral program is paused. */
+    /** Referral program is paused. */
     PAUSED = "PAUSED"
 }
 interface Reward$2 extends RewardOptionsOneOf {
@@ -456,14 +416,7 @@ interface Coupon$4 extends CouponDiscountTypeOptionsOneOf$4, CouponScopeOrMinSub
     scope?: CouponScope$4;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$4;
     /**
      * Whether the coupon is limited to one item.
@@ -537,7 +490,7 @@ declare enum Action {
     UNKNOWN = "UNKNOWN",
     /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Referred friend ordered and paid for a plan */
+    /** Referred friend ordered and paid for a plan. */
     PLAN_ORDERED = "PLAN_ORDERED",
     /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
@@ -547,18 +500,7 @@ declare enum Action {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
-    /**
-     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
-     *
-     * Available apps:
-     *
-     * - `UNKNOWN`: Unknown email.
-     * - `STORES`: Send an email to customers who've placed an order with stores.
-     * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
-     * - `EVENTS`: Send an email to customers who've placed an order with events.
-     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
-     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
-     */
+    /** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
     encourageToReferFriends?: App[];
     /**
      * Whether to send email notifications to referring customers when they receive a referral reward.
@@ -1074,13 +1016,6 @@ interface V1Coupon$3 {
     code?: string;
     /**
      * 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$5;
@@ -1091,13 +1026,13 @@ interface V1Coupon$3 {
     couponSpecification?: Coupon$3;
 }
 declare enum Status$5 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
@@ -1111,14 +1046,7 @@ interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSub
     scope?: CouponScope$3;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$3;
     /**
      * Whether the coupon is limited to one item.
@@ -1616,13 +1544,6 @@ interface V1Coupon$2 {
     code?: string;
     /**
      * 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$4;
@@ -1633,13 +1554,13 @@ interface V1Coupon$2 {
     couponSpecification?: Coupon$2;
 }
 declare enum Status$4 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
@@ -1653,14 +1574,7 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
     scope?: CouponScope$2;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$2;
     /**
      * Whether the coupon is limited to one item.
@@ -1893,15 +1807,7 @@ interface ReferralReward$1 extends ReferralRewardReceiverOneOf$1, ReferralReward
      * @readonly
      */
     updatedDate?: Date | null;
-    /**
-     * 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.
-     */
+    /** Type of reward given. */
     rewardType?: RewardTypeType$1;
 }
 /** @oneof */
@@ -1925,9 +1831,9 @@ interface ReferralRewardRewardTypeOptionsOneOf$1 {
     loyaltyPoints?: V1LoyaltyPoints$1;
 }
 declare enum RewardTypeType$1 {
-    /** Unknown reward. */
+    /** Unknown reward type. */
     UNKNOWN = "UNKNOWN",
-    /** A loyalty coupon is given. */
+    /** Loyalty coupon is given. */
     COUPON = "COUPON",
     /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -1947,13 +1853,6 @@ interface V1Coupon$1 {
     code?: string;
     /**
      * 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;
@@ -1964,13 +1863,13 @@ interface V1Coupon$1 {
     couponSpecification?: Coupon$1;
 }
 declare enum Status$3 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
@@ -1984,14 +1883,7 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
     scope?: CouponScope$1;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType$1;
     /**
      * Whether the coupon is limited to one item.
@@ -2033,7 +1925,7 @@ declare enum DiscountType$1 {
     FIXED_AMOUNT = "FIXED_AMOUNT",
     /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping. */
+    /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$1 {
@@ -2237,15 +2129,7 @@ interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewa
      * @readonly
      */
     _updatedDate?: Date | null;
-    /**
-     * 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.
-     */
+    /** Type of reward given. */
     rewardType?: RewardTypeType;
 }
 /** @oneof */
@@ -2269,9 +2153,9 @@ interface ReferralRewardRewardTypeOptionsOneOf {
     loyaltyPoints?: V1LoyaltyPoints;
 }
 declare enum RewardTypeType {
-    /** Unknown reward. */
+    /** Unknown reward type. */
     UNKNOWN = "UNKNOWN",
-    /** A loyalty coupon is given. */
+    /** Loyalty coupon is given. */
     COUPON = "COUPON",
     /** Loyalty points are awarded. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -2291,13 +2175,6 @@ interface V1Coupon {
     code?: string;
     /**
      * 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;
@@ -2308,13 +2185,13 @@ interface V1Coupon {
     couponSpecification?: Coupon;
 }
 declare enum Status$2 {
-    /** The coupon status is unknown or not specified. */
+    /** Coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** The coupon is active and can be applied to purchases. */
+    /** Coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** The coupon has been applied and can't be used again. */
+    /** Coupon was applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** The coupon has been deleted and is no longer valid. */
+    /** Coupon was deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
@@ -2328,14 +2205,7 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
     scope?: CouponScope;
     /** Coupon name. */
     name?: string;
-    /**
-     * 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`.
-     */
+    /** Coupon discount type. */
     discountType?: DiscountType;
     /**
      * Whether the coupon is limited to one item.
@@ -2377,7 +2247,7 @@ declare enum DiscountType {
     FIXED_AMOUNT = "FIXED_AMOUNT",
     /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping. */
+    /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount {
@@ -2607,7 +2477,7 @@ declare enum Status$1 {
     UNKNOWN = "UNKNOWN",
     /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** Status after the referred friend completes specific actions, such as making a purchase. */
+    /** Status after the referred friend completes a specific action, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest$1 {
@@ -2794,7 +2664,7 @@ declare enum Status {
     UNKNOWN = "UNKNOWN",
     /** Initial status when the referred friend joins the site as a member. */
     SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
-    /** Status after the referred friend completes specific actions, such as making a purchase. */
+    /** Status after the referred friend completes a specific action, such as making a purchase. */
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest {