@wix/referral 1.0.14 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/referral_customers": "1.0.5",
-    "@wix/referral_friends": "1.0.4",
+    "@wix/referral_customers": "1.0.6",
+    "@wix/referral_friends": "1.0.5",
     "@wix/referral_programs": "1.0.7",
     "@wix/referral_rewards": "1.0.4",
     "@wix/referral_tracker": "1.0.10"
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "15bcf97d6b28f74c7ac82e3dc8eea59ddc9a18afe26944b4323f6df4"
+  "falconPackageHash": "bbf7fbe99d9bc40d610f2f40d4b70953894060b4ff7baf3ade03c830"
 }

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

@@ -3276,34 +3276,35 @@ declare namespace context$2 {
 
 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;
@@ -3311,47 +3312,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 {
@@ -3411,9 +3414,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryReferredFriendResponse {
-    /** The retrieved ReferredFriends. */
+    /** Retrieved referred friends. */
     referredFriends?: ReferredFriend[];
-    /** CursorPagingMetadata. */
+    /** Cursor paging metadata. */
     metadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
@@ -3647,45 +3650,49 @@ interface ReferredFriendDeletedEnvelope {
     metadata: EventMetadata$1;
 }
 interface CreateReferredFriendOptions {
-    /** Referral code for referred friend */
+    /** Referral code for the referred friend. */
     referralCode?: string | null;
 }
 interface UpdateReferredFriend {
     /**
-     * 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;
 }
 interface DeleteReferredFriendOptions {
-    /** 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 QueryCursorResult$1 {
@@ -3769,56 +3776,69 @@ interface ReferredFriendsQueryBuilder {
 declare function createReferredFriend$1(httpClient: HttpClient): CreateReferredFriendSignature;
 interface CreateReferredFriendSignature {
     /**
-     * Try to create the ReferredFriend or return existing entity if it already exists.
+     * Creates a new referred friend or returns an existing entity if it already exists.
+     *
+     * This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#site-members).
      *
-     * Must be called with member identity.
-     * Referral code must be provided either in the request or via scope.
-     * Member must be eligible to become referred friend.
+     * A referral code must be provided either in the request or via scope.
+     *
+     * The member must be eligible to become a referred friend.
      */
     (options?: CreateReferredFriendOptions | undefined): Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
 }
 declare function getReferredFriend$1(httpClient: HttpClient): GetReferredFriendSignature;
 interface GetReferredFriendSignature {
     /**
-     * Get a ReferredFriend by id.
-     * @param - Id of the ReferredFriend to retrieve.
+     * Retrieves a referred friend by ID.
+     * @param - ID of the referred friend to retrieve.
      */
     (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
 }
 declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
 interface GetReferredFriendByContactIdSignature {
     /**
-     * Get a ReferredFriend by contactId.
+     * Retrieves a referred friend by contact ID.
      *
-     * You can provide "me" instead of specific contact id to get referring friend for current identity's contact.
-     * @param - Contact id or "me" to get current identity's Contact.
-     * @returns The retrieved ReferredFriend.
+     * 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>;
 }
 declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
 interface UpdateReferredFriendSignature {
     /**
-     * Update a ReferredFriend, supports partial update.
+     * Updates a referred friend. Supports partial updates.
      *
-     * Pass the latest `revision` for a successful update.
-     * @param - ReferredFriend ID.
-     * @returns The updated ReferredFriend.
+     * You must pass the latest revision for a successful update.
+     * @param - ID of the referred friend.
+     * @returns Updated referred friend.
      */
     (_id: string, referredFriend: UpdateReferredFriend): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
 }
 declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredFriendSignature;
 interface DeleteReferredFriendSignature {
     /**
-     * Delete a ReferredFriend.
-     * @param - Id of the ReferredFriend to delete.
+     * Deletes a referred friend.
      */
     (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
 }
 declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
 interface QueryReferredFriendSignature {
     /**
-     * Query ReferredFriends using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     *
+     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     *
+     * You can filter by:
+     * - `referring_customer_id`
+     * - `status`
+     * - `created_date`
+     *
+     * 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).
      */
     (): ReferredFriendsQueryBuilder;
 }
@@ -4320,9 +4340,9 @@ interface GenerateReferringCustomerForContactSignature {
     /**
      * Creates a new referring customer or returns an existing one for the provided contact ID.
      *
-     * You can use "me" instead of a specific contact ID to generate a referring customer for the current identity's contact.
+     * You can use `"me"`` instead of a specific contact ID to generate a referring customer for the current identity's contact.
      *
-     * See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) to learn more about identies.
+     * See the [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) article to learn more about identies.
      * @param - Contact ID or `"me"` to generate the current identity's referring customer.
      */
     (contactId: string): Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
@@ -4349,7 +4369,7 @@ interface QueryReferringCustomersSignature {
     /**
      * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
      *
-     * TODO: This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
+     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
      * `contact_id`, `referral_code`, `created_date`, `updated_date`.
      *
      * To learn about working with _Query_ endpoints, see

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

@@ -3276,34 +3276,35 @@ declare namespace index_d$2 {
 
 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;
@@ -3311,47 +3312,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 {
@@ -3411,9 +3414,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryReferredFriendResponse {
-    /** The retrieved ReferredFriends. */
+    /** Retrieved referred friends. */
     referredFriends?: ReferredFriend[];
-    /** CursorPagingMetadata. */
+    /** Cursor paging metadata. */
     metadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
@@ -3647,45 +3650,49 @@ interface ReferredFriendDeletedEnvelope {
     metadata: EventMetadata$1;
 }
 interface CreateReferredFriendOptions {
-    /** Referral code for referred friend */
+    /** Referral code for the referred friend. */
     referralCode?: string | null;
 }
 interface UpdateReferredFriend {
     /**
-     * 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;
 }
 interface DeleteReferredFriendOptions {
-    /** 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 QueryCursorResult$1 {
@@ -3769,56 +3776,69 @@ interface ReferredFriendsQueryBuilder {
 declare function createReferredFriend$1(httpClient: HttpClient): CreateReferredFriendSignature;
 interface CreateReferredFriendSignature {
     /**
-     * Try to create the ReferredFriend or return existing entity if it already exists.
+     * Creates a new referred friend or returns an existing entity if it already exists.
+     *
+     * This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#site-members).
      *
-     * Must be called with member identity.
-     * Referral code must be provided either in the request or via scope.
-     * Member must be eligible to become referred friend.
+     * A referral code must be provided either in the request or via scope.
+     *
+     * The member must be eligible to become a referred friend.
      */
     (options?: CreateReferredFriendOptions | undefined): Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
 }
 declare function getReferredFriend$1(httpClient: HttpClient): GetReferredFriendSignature;
 interface GetReferredFriendSignature {
     /**
-     * Get a ReferredFriend by id.
-     * @param - Id of the ReferredFriend to retrieve.
+     * Retrieves a referred friend by ID.
+     * @param - ID of the referred friend to retrieve.
      */
     (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
 }
 declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
 interface GetReferredFriendByContactIdSignature {
     /**
-     * Get a ReferredFriend by contactId.
+     * Retrieves a referred friend by contact ID.
      *
-     * You can provide "me" instead of specific contact id to get referring friend for current identity's contact.
-     * @param - Contact id or "me" to get current identity's Contact.
-     * @returns The retrieved ReferredFriend.
+     * 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>;
 }
 declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
 interface UpdateReferredFriendSignature {
     /**
-     * Update a ReferredFriend, supports partial update.
+     * Updates a referred friend. Supports partial updates.
      *
-     * Pass the latest `revision` for a successful update.
-     * @param - ReferredFriend ID.
-     * @returns The updated ReferredFriend.
+     * You must pass the latest revision for a successful update.
+     * @param - ID of the referred friend.
+     * @returns Updated referred friend.
      */
     (_id: string, referredFriend: UpdateReferredFriend): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
 }
 declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredFriendSignature;
 interface DeleteReferredFriendSignature {
     /**
-     * Delete a ReferredFriend.
-     * @param - Id of the ReferredFriend to delete.
+     * Deletes a referred friend.
      */
     (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
 }
 declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
 interface QueryReferredFriendSignature {
     /**
-     * Query ReferredFriends using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
+     *
+     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     *
+     * You can filter by:
+     * - `referring_customer_id`
+     * - `status`
+     * - `created_date`
+     *
+     * 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).
      */
     (): ReferredFriendsQueryBuilder;
 }
@@ -4320,9 +4340,9 @@ interface GenerateReferringCustomerForContactSignature {
     /**
      * Creates a new referring customer or returns an existing one for the provided contact ID.
      *
-     * You can use "me" instead of a specific contact ID to generate a referring customer for the current identity's contact.
+     * You can use `"me"`` instead of a specific contact ID to generate a referring customer for the current identity's contact.
      *
-     * See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) to learn more about identies.
+     * See the [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) article to learn more about identies.
      * @param - Contact ID or `"me"` to generate the current identity's referring customer.
      */
     (contactId: string): Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
@@ -4349,7 +4369,7 @@ interface QueryReferringCustomersSignature {
     /**
      * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
      *
-     * TODO: This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
+     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
      * `contact_id`, `referral_code`, `created_date`, `updated_date`.
      *
      * To learn about working with _Query_ endpoints, see

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

@@ -2677,34 +2677,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 +2713,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 +2815,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 +2863,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 +2899,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 +3001,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 {