@wix/referral 1.0.33 → 1.0.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.33",
+  "version": "1.0.35",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -19,10 +19,10 @@
   ],
   "dependencies": {
     "@wix/referral_customers": "1.0.14",
-    "@wix/referral_friends": "1.0.10",
-    "@wix/referral_programs": "1.0.19",
+    "@wix/referral_friends": "1.0.11",
+    "@wix/referral_programs": "1.0.20",
     "@wix/referral_rewards": "1.0.13",
-    "@wix/referral_tracker": "1.0.15"
+    "@wix/referral_tracker": "1.0.16"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "136d2f2d04c9655789579dc82cc20eb39a8e5dbaf30a0504b041b98e"
+  "falconPackageHash": "0d2d37779fb713ff0f56e4f148745237dd99e7d8bf7f955bf39bd7a9"
 }

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

@@ -567,7 +567,7 @@ declare enum DiscountType$2 {
     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$2 {
@@ -597,15 +597,15 @@ interface LoyaltyPoints$2 {
 declare enum Action {
     /** Unknown action. */
     UNKNOWN = "UNKNOWN",
-    /** Store order placed. */
+    /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Pricing plan ordered. */
+    /** Referred friend ordered and paid for a plan */
     PLAN_ORDERED = "PLAN_ORDERED",
-    /** Wix events ticket ordered. */
+    /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
-    /** Bookings session booked. */
+    /** Referred friend booked and paid for a session. */
     SESSION_BOOKED = "SESSION_BOOKED",
-    /** Restaurant order placed. */
+    /** Referred friend placed and paid for a restaurant order. */
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
@@ -631,15 +631,15 @@ interface Emails {
 declare enum App {
     /** Unknown app. */
     UNKNOWN = "UNKNOWN",
-    /** Wix stores. */
+    /** Send an email to customers who've placed an order with stores. */
     STORES = "STORES",
-    /** Wix pricing plans. */
+    /** Send an email to customers who've placed an order with pricing plans. */
     PRICING_PLANS = "PRICING_PLANS",
-    /** Wix events. */
+    /** Send an email to customers who've placed an order with events. */
     EVENTS = "EVENTS",
-    /** Wix bookings. */
+    /** Send an email to customers who've placed an order with bookings. */
     BOOKINGS = "BOOKINGS",
-    /** Wix restaurants. */
+    /** Send an email to customers who've placed an order with restaurants. */
     RESTAURANTS = "RESTAURANTS"
 }
 interface PremiumFeatures {
@@ -2439,7 +2439,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 {
@@ -3732,10 +3732,11 @@ interface UpdateReferredFriendResponse {
     referredFriend?: ReferredFriend;
 }
 interface DeleteReferredFriendRequest {
+    /** ID of the referred friend to delete. */
     referredFriendId: string;
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }
@@ -4073,7 +4074,7 @@ interface UpdateReferredFriend {
 interface DeleteReferredFriendOptions {
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }
@@ -4202,20 +4203,27 @@ declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredF
 interface DeleteReferredFriendSignature {
     /**
      * Deletes a referred friend.
+     * @param - ID of the referred friend to delete.
      */
     (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
 }
 declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
 interface QueryReferredFriendSignature {
     /**
-     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referred friends.
      *
-     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     * The `queryReferredFriend()` function builds a query to retrieve a list of events and returns a `ReferredFriendsQueryBuilder` object.
      *
-     * 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 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 `ReferredFriendsQueryBuilder` functions onto the query. `ReferredFriendsQueryBuilder` functions enable you to sort, filter, and control the results `queryReferredFriend()` returns.
+     *
+     * `queryReferredFriend()` runs with these `ReferredFriendQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryReferredFriend()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('referringCustomerId'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by referring customer ID.
      */
     (): ReferredFriendsQueryBuilder;
 }

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

@@ -567,7 +567,7 @@ declare enum DiscountType$2 {
     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$2 {
@@ -597,15 +597,15 @@ interface LoyaltyPoints$2 {
 declare enum Action {
     /** Unknown action. */
     UNKNOWN = "UNKNOWN",
-    /** Store order placed. */
+    /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Pricing plan ordered. */
+    /** Referred friend ordered and paid for a plan */
     PLAN_ORDERED = "PLAN_ORDERED",
-    /** Wix events ticket ordered. */
+    /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
-    /** Bookings session booked. */
+    /** Referred friend booked and paid for a session. */
     SESSION_BOOKED = "SESSION_BOOKED",
-    /** Restaurant order placed. */
+    /** Referred friend placed and paid for a restaurant order. */
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
@@ -631,15 +631,15 @@ interface Emails {
 declare enum App {
     /** Unknown app. */
     UNKNOWN = "UNKNOWN",
-    /** Wix stores. */
+    /** Send an email to customers who've placed an order with stores. */
     STORES = "STORES",
-    /** Wix pricing plans. */
+    /** Send an email to customers who've placed an order with pricing plans. */
     PRICING_PLANS = "PRICING_PLANS",
-    /** Wix events. */
+    /** Send an email to customers who've placed an order with events. */
     EVENTS = "EVENTS",
-    /** Wix bookings. */
+    /** Send an email to customers who've placed an order with bookings. */
     BOOKINGS = "BOOKINGS",
-    /** Wix restaurants. */
+    /** Send an email to customers who've placed an order with restaurants. */
     RESTAURANTS = "RESTAURANTS"
 }
 interface PremiumFeatures {
@@ -2439,7 +2439,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 {
@@ -3732,10 +3732,11 @@ interface UpdateReferredFriendResponse {
     referredFriend?: ReferredFriend;
 }
 interface DeleteReferredFriendRequest {
+    /** ID of the referred friend to delete. */
     referredFriendId: string;
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }
@@ -4073,7 +4074,7 @@ interface UpdateReferredFriend {
 interface DeleteReferredFriendOptions {
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }
@@ -4202,20 +4203,27 @@ declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredF
 interface DeleteReferredFriendSignature {
     /**
      * Deletes a referred friend.
+     * @param - ID of the referred friend to delete.
      */
     (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
 }
 declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
 interface QueryReferredFriendSignature {
     /**
-     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referred friends.
      *
-     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     * The `queryReferredFriend()` function builds a query to retrieve a list of events and returns a `ReferredFriendsQueryBuilder` object.
      *
-     * 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 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 `ReferredFriendsQueryBuilder` functions onto the query. `ReferredFriendsQueryBuilder` functions enable you to sort, filter, and control the results `queryReferredFriend()` returns.
+     *
+     * `queryReferredFriend()` runs with these `ReferredFriendQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     *
+     * The functions that are chained to `queryReferredFriend()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('referringCustomerId'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by referring customer ID.
      */
     (): ReferredFriendsQueryBuilder;
 }

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

@@ -157,7 +157,7 @@ declare enum DiscountType$5 {
     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$5 {
@@ -187,15 +187,15 @@ interface LoyaltyPoints$3 {
 declare enum Action$1 {
     /** Unknown action. */
     UNKNOWN = "UNKNOWN",
-    /** Store order placed. */
+    /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Pricing plan ordered. */
+    /** Referred friend ordered and paid for a plan */
     PLAN_ORDERED = "PLAN_ORDERED",
-    /** Wix events ticket ordered. */
+    /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
-    /** Bookings session booked. */
+    /** Referred friend booked and paid for a session. */
     SESSION_BOOKED = "SESSION_BOOKED",
-    /** Restaurant order placed. */
+    /** Referred friend placed and paid for a restaurant order. */
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails$1 {
@@ -221,15 +221,15 @@ interface Emails$1 {
 declare enum App$1 {
     /** Unknown app. */
     UNKNOWN = "UNKNOWN",
-    /** Wix stores. */
+    /** Send an email to customers who've placed an order with stores. */
     STORES = "STORES",
-    /** Wix pricing plans. */
+    /** Send an email to customers who've placed an order with pricing plans. */
     PRICING_PLANS = "PRICING_PLANS",
-    /** Wix events. */
+    /** Send an email to customers who've placed an order with events. */
     EVENTS = "EVENTS",
-    /** Wix bookings. */
+    /** Send an email to customers who've placed an order with bookings. */
     BOOKINGS = "BOOKINGS",
-    /** Wix restaurants. */
+    /** Send an email to customers who've placed an order with restaurants. */
     RESTAURANTS = "RESTAURANTS"
 }
 interface PremiumFeatures$1 {
@@ -530,7 +530,7 @@ declare enum DiscountType$4 {
     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$4 {
@@ -560,15 +560,15 @@ interface LoyaltyPoints$2 {
 declare enum Action {
     /** Unknown action. */
     UNKNOWN = "UNKNOWN",
-    /** Store order placed. */
+    /** Referred friend ordered and paid for an order in a store. */
     STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
-    /** Pricing plan ordered. */
+    /** Referred friend ordered and paid for a plan */
     PLAN_ORDERED = "PLAN_ORDERED",
-    /** Wix events ticket ordered. */
+    /** Referred friend ordered and paid for a ticket. */
     TICKET_ORDERED = "TICKET_ORDERED",
-    /** Bookings session booked. */
+    /** Referred friend booked and paid for a session. */
     SESSION_BOOKED = "SESSION_BOOKED",
-    /** Restaurant order placed. */
+    /** Referred friend placed and paid for a restaurant order. */
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
@@ -594,15 +594,15 @@ interface Emails {
 declare enum App {
     /** Unknown app. */
     UNKNOWN = "UNKNOWN",
-    /** Wix stores. */
+    /** Send an email to customers who've placed an order with stores. */
     STORES = "STORES",
-    /** Wix pricing plans. */
+    /** Send an email to customers who've placed an order with pricing plans. */
     PRICING_PLANS = "PRICING_PLANS",
-    /** Wix events. */
+    /** Send an email to customers who've placed an order with events. */
     EVENTS = "EVENTS",
-    /** Wix bookings. */
+    /** Send an email to customers who've placed an order with bookings. */
     BOOKINGS = "BOOKINGS",
-    /** Wix restaurants. */
+    /** Send an email to customers who've placed an order with restaurants. */
     RESTAURANTS = "RESTAURANTS"
 }
 interface PremiumFeatures {
@@ -1186,7 +1186,7 @@ declare enum DiscountType$3 {
     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$3 {
@@ -1728,7 +1728,7 @@ declare enum DiscountType$2 {
     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$2 {
@@ -2669,10 +2669,11 @@ interface UpdateReferredFriendResponse$1 {
     referredFriend?: ReferredFriend$1;
 }
 interface DeleteReferredFriendRequest$1 {
+    /** ID of the referred friend to delete. */
     referredFriendId: string;
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }
@@ -2855,10 +2856,11 @@ interface UpdateReferredFriendResponse {
     referredFriend?: ReferredFriend;
 }
 interface DeleteReferredFriendRequest {
+    /** ID of the referred friend to delete. */
     referredFriendId: string;
     /**
      * 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.
+     * To prevent conflicting changes, the current revision must be passed when deleting the referred friend.
      */
     revision?: string;
 }