@wix/referral 1.0.32 → 1.0.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.32",
+  "version": "1.0.34",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/referral_customers": "1.0.13",
-    "@wix/referral_friends": "1.0.10",
+    "@wix/referral_customers": "1.0.14",
+    "@wix/referral_friends": "1.0.11",
     "@wix/referral_programs": "1.0.19",
     "@wix/referral_rewards": "1.0.13",
     "@wix/referral_tracker": "1.0.15"
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "a22ef39efa0431cd64f663316cca6925946e1d880e47f29f6e3ade84"
+  "falconPackageHash": "1a7df3244e3a998ad4bbc7303820de5c4f7c73688c40faf2801f29f2"
 }

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

@@ -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;
 }
@@ -4310,7 +4318,6 @@ declare namespace context$1 {
   export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_CreateReferredFriendOptions as CreateReferredFriendOptions, type context$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type context$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type context$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type context$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type context$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type context$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type context$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type context$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type context$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type context$1_GetReferredFriendRequest as GetReferredFriendRequest, type context$1_GetReferredFriendResponse as GetReferredFriendResponse, type context$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type context$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type context$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type context$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type context$1_ReferredFriend as ReferredFriend, type context$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type context$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type context$1_ReferredFriendDetails as ReferredFriendDetails, type context$1_ReferredFriendNonNullableFields as ReferredFriendNonNullableFields, type context$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type context$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type context$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, type RestoreInfo$1 as RestoreInfo, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, context$1_Status as Status, type context$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type context$1_UpdateReferredFriend as UpdateReferredFriend, type context$1_UpdateReferredFriendRequest as UpdateReferredFriendRequest, type context$1_UpdateReferredFriendResponse as UpdateReferredFriendResponse, type context$1_UpdateReferredFriendResponseNonNullableFields as UpdateReferredFriendResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicOnReferredFriendCreatedType as _publicOnReferredFriendCreatedType, type context$1__publicOnReferredFriendDeletedType as _publicOnReferredFriendDeletedType, type context$1__publicOnReferredFriendUpdatedType as _publicOnReferredFriendUpdatedType, context$1_createReferredFriend as createReferredFriend, context$1_deleteReferredFriend as deleteReferredFriend, context$1_getReferredFriend as getReferredFriend, context$1_getReferredFriendByContactId as getReferredFriendByContactId, context$1_onReferredFriendCreated as onReferredFriendCreated, context$1_onReferredFriendDeleted as onReferredFriendDeleted, context$1_onReferredFriendUpdated as onReferredFriendUpdated, onReferredFriendCreated$1 as publicOnReferredFriendCreated, onReferredFriendDeleted$1 as publicOnReferredFriendDeleted, onReferredFriendUpdated$1 as publicOnReferredFriendUpdated, context$1_queryReferredFriend as queryReferredFriend, context$1_updateReferredFriend as updateReferredFriend };
 }
 
-/** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer {
     /**
      * ID of the referring customer.
@@ -4748,12 +4755,19 @@ interface GetReferringCustomerByReferralCodeSignature {
 declare function queryReferringCustomers$1(httpClient: HttpClient): QueryReferringCustomersSignature;
 interface QueryReferringCustomersSignature {
     /**
-     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referring customers.
      *
-     * 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 `queryReferringCustomers()` function builds a query to retrieve a list of events and returns a `ReferringCustomersQueryBuilder` 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 `ReferringCustomersQueryBuilder` functions onto the query. `ReferringCustomersQueryBuilder` functions enable you to sort, filter, and control the results `queryReferringCustomers()` returns.
+     *
+     * `queryReferringCustomers()` runs with these `ReferringCustomersQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     * The functions that are chained to `queryReferringCustomers()` are applied in the order they're called. For example, if you apply ascending('referralCode') and then descending('contactID'), the results are sorted first by the referral code, and then, if there are multiple results with the same referral code, the items are sorted by contact ID.
      */
     (): ReferringCustomersQueryBuilder;
 }

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

@@ -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;
 }
@@ -4310,7 +4318,6 @@ declare namespace index_d$1 {
   export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_CreateReferredFriendOptions as CreateReferredFriendOptions, type index_d$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type index_d$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type index_d$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type index_d$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type index_d$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type index_d$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type index_d$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type index_d$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type index_d$1_GetReferredFriendRequest as GetReferredFriendRequest, type index_d$1_GetReferredFriendResponse as GetReferredFriendResponse, type index_d$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type index_d$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type index_d$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type index_d$1_ReferredFriend as ReferredFriend, type index_d$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type index_d$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type index_d$1_ReferredFriendDetails as ReferredFriendDetails, type index_d$1_ReferredFriendNonNullableFields as ReferredFriendNonNullableFields, type index_d$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type index_d$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type index_d$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, type RestoreInfo$1 as RestoreInfo, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, index_d$1_Status as Status, type index_d$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type index_d$1_UpdateReferredFriend as UpdateReferredFriend, type index_d$1_UpdateReferredFriendRequest as UpdateReferredFriendRequest, type index_d$1_UpdateReferredFriendResponse as UpdateReferredFriendResponse, type index_d$1_UpdateReferredFriendResponseNonNullableFields as UpdateReferredFriendResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, type index_d$1__publicOnReferredFriendCreatedType as _publicOnReferredFriendCreatedType, type index_d$1__publicOnReferredFriendDeletedType as _publicOnReferredFriendDeletedType, type index_d$1__publicOnReferredFriendUpdatedType as _publicOnReferredFriendUpdatedType, index_d$1_createReferredFriend as createReferredFriend, index_d$1_deleteReferredFriend as deleteReferredFriend, index_d$1_getReferredFriend as getReferredFriend, index_d$1_getReferredFriendByContactId as getReferredFriendByContactId, index_d$1_onReferredFriendCreated as onReferredFriendCreated, index_d$1_onReferredFriendDeleted as onReferredFriendDeleted, index_d$1_onReferredFriendUpdated as onReferredFriendUpdated, onReferredFriendCreated$1 as publicOnReferredFriendCreated, onReferredFriendDeleted$1 as publicOnReferredFriendDeleted, onReferredFriendUpdated$1 as publicOnReferredFriendUpdated, index_d$1_queryReferredFriend as queryReferredFriend, index_d$1_updateReferredFriend as updateReferredFriend };
 }
 
-/** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer {
     /**
      * ID of the referring customer.
@@ -4748,12 +4755,19 @@ interface GetReferringCustomerByReferralCodeSignature {
 declare function queryReferringCustomers$1(httpClient: HttpClient): QueryReferringCustomersSignature;
 interface QueryReferringCustomersSignature {
     /**
-     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of referring customers.
      *
-     * 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 `queryReferringCustomers()` function builds a query to retrieve a list of events and returns a `ReferringCustomersQueryBuilder` 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 `ReferringCustomersQueryBuilder` functions onto the query. `ReferringCustomersQueryBuilder` functions enable you to sort, filter, and control the results `queryReferringCustomers()` returns.
+     *
+     * `queryReferringCustomers()` runs with these `ReferringCustomersQueryBuilder` defaults, which you can override:
+     *
+     * - `limit(50)`
+     * - `descending("_createdDate")`
+     * The functions that are chained to `queryReferringCustomers()` are applied in the order they're called. For example, if you apply ascending('referralCode') and then descending('contactID'), the results are sorted first by the referral code, and then, if there are multiple results with the same referral code, the items are sorted by contact ID.
      */
     (): ReferringCustomersQueryBuilder;
 }

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

@@ -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;
 }
@@ -3000,7 +3002,6 @@ declare namespace meta$1 {
   export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_createReferredFriend as createReferredFriend, meta$1_deleteReferredFriend as deleteReferredFriend, meta$1_getReferredFriend as getReferredFriend, meta$1_getReferredFriendByContactId as getReferredFriendByContactId, meta$1_queryReferredFriend as queryReferredFriend, meta$1_updateReferredFriend as updateReferredFriend };
 }
 
-/** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer$1 {
     /**
      * ID of the referring customer.
@@ -3162,7 +3163,6 @@ interface QueryReferringCustomersResponseNonNullableFields$1 {
     referringCustomers: ReferringCustomerNonNullableFields$1[];
 }
 
-/** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer {
     /**
      * ID of the referring customer.