@wix/referral 1.0.12 → 1.0.14

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

@@ -2,16 +2,21 @@ interface ReferralProgram$1 {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program. Possible values:
+     * Status of the referral program.
      *
-     * - `UNKNOWN`: Status is unknown. This value is never used.
-     * - `DRAFT`: Referral program is in a draft state and is currently being modified. Not yet active.
-     * - `ACTIVE`: Referral program is active.
-     * - `PAUSED`: Referral program is paused.
+     * Possible values:
+     *
+     * - `UNKNOWN`: The status of the referral program is unknown. This value is not used.
+     * - `DRAFT`: The referral program is in a draft state and is being modified. It is not yet active.
+     * - `ACTIVE`: The referral program is active.
+     * - `PAUSED`: The referral program is paused.
      * @readonly
      */
     status?: ProgramStatus$1;
-    /** Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current `revision` must be passed when updating the program. */
+    /**
+     * Revision number, which increments by 1 each time the program is updated.
+     * To prevent conflicting changes, the current `revision` must be passed when updating the program.
+     */
     revision?: string | null;
     /**
      * Date and time the program was created.
@@ -19,7 +24,7 @@ interface ReferralProgram$1 {
      */
     createdDate?: Date;
     /**
-     * Date and time the program was updated.
+     * Date and time the program was last updated.
      * @readonly
      */
     updatedDate?: Date;
@@ -34,7 +39,7 @@ interface ReferralProgram$1 {
      */
     referringCustomerReward?: Reward$3;
     /**
-     * A list of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
+     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
      *
      * Possible values:
      *
@@ -48,8 +53,12 @@ interface ReferralProgram$1 {
     successfulReferralActions?: Action$1[];
     /**
      * Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @readonly
      * @deprecated Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
@@ -200,7 +209,7 @@ declare enum Action$1 {
 }
 interface Emails$1 {
     /**
-     * Encourage customers to refer their friends via email. Select which apps to enable.
+     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
      *
      * Available apps:
      *
@@ -231,7 +240,7 @@ declare enum App$1 {
 }
 interface PremiumFeatures$1 {
     /**
-     * Whether the user has the referral program feature.
+     * Whether the user has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -454,16 +463,21 @@ interface ReferralProgram {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program. Possible values:
+     * Status of the referral program.
      *
-     * - `UNKNOWN`: Status is unknown. This value is never used.
-     * - `DRAFT`: Referral program is in a draft state and is currently being modified. Not yet active.
-     * - `ACTIVE`: Referral program is active.
-     * - `PAUSED`: Referral program is paused.
+     * Possible values:
+     *
+     * - `UNKNOWN`: The status of the referral program is unknown. This value is not used.
+     * - `DRAFT`: The referral program is in a draft state and is being modified. It is not yet active.
+     * - `ACTIVE`: The referral program is active.
+     * - `PAUSED`: The referral program is paused.
      * @readonly
      */
     status?: ProgramStatus;
-    /** Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current `revision` must be passed when updating the program. */
+    /**
+     * Revision number, which increments by 1 each time the program is updated.
+     * To prevent conflicting changes, the current `revision` must be passed when updating the program.
+     */
     revision?: string | null;
     /**
      * Date and time the program was created.
@@ -471,7 +485,7 @@ interface ReferralProgram {
      */
     _createdDate?: Date;
     /**
-     * Date and time the program was updated.
+     * Date and time the program was last updated.
      * @readonly
      */
     _updatedDate?: Date;
@@ -486,7 +500,7 @@ interface ReferralProgram {
      */
     referringCustomerReward?: Reward$2;
     /**
-     * A list of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
+     * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
      *
      * Possible values:
      *
@@ -500,8 +514,12 @@ interface ReferralProgram {
     successfulReferralActions?: Action[];
     /**
      * Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @readonly
      * @deprecated Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
@@ -652,7 +670,7 @@ declare enum Action {
 }
 interface Emails {
     /**
-     * Encourage customers to refer their friends via email. Select which apps to enable.
+     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
      *
      * Available apps:
      *
@@ -683,7 +701,7 @@ declare enum App {
 }
 interface PremiumFeatures {
     /**
-     * Whether the user has the referral program feature.
+     * Whether the user has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -934,106 +952,109 @@ declare namespace meta$4 {
 }
 
 interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
-    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    /** Event triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
-    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    /** Event triggered when a referral is successful. For example, customer places and pays for an order. */
     successfulReferralEvent?: V1SuccessfulReferralEvent$1;
-    /** ActionEvent is an event that is triggered when an action is performed. */
+    /** Event triggered when an action is performed. For example, placing an order. */
     actionEvent?: V1ActionEvent$1;
-    /** RewardEvent is an event that is triggered when a reward is given. */
+    /** Event triggered when a reward is given. */
     rewardEvent?: RewardEvent$1;
     /**
-     * ReferralEvent ID.
+     * Referral event ID.
      * @readonly
      */
     id?: string | null;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referral event is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referral event.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferralEvent was created.
+     * Date and time the referral event was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this ReferralEvent was last updated.
+     * Date and time the referral event was last updated.
      * @readonly
      */
     updatedDate?: Date;
 }
 /** @oneof */
 interface ReferralEventEventTypeOneOf$1 {
-    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    /** Event triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
-    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    /** Event triggered when a referral is successful. For example, customer places and pays for an order. */
     successfulReferralEvent?: V1SuccessfulReferralEvent$1;
-    /** ActionEvent is an event that is triggered when an action is performed. */
+    /** Event triggered when an action is performed. For example, placing an order. */
     actionEvent?: V1ActionEvent$1;
-    /** RewardEvent is an event that is triggered when a reward is given. */
+    /** Event triggered when a reward is given. */
     rewardEvent?: RewardEvent$1;
 }
 interface ReferredFriendSignupEvent$1 {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
 }
 interface V1SuccessfulReferralEvent$1 {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
-    /** The referring customer ID. */
+    /** ID of the referring customer */
     referringCustomerId?: string;
 }
 interface V1ActionEvent$1 {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
-    /** The referring customer ID. */
+    /** ID of the referring customer */
     referringCustomerId?: string;
-    /** The trigger of the action. */
+    /** Trigger for the action */
     trigger?: V1Trigger$1;
-    /** Amount. */
+    /** Amount associated with the action. */
     amount?: string | null;
-    /** Currency. */
+    /** Currency of the amount. */
     currency?: string | null;
-    /** Order ID. */
+    /** ID of the associated order. */
     orderId?: string | null;
 }
 interface V1Trigger$1 {
-    /** The app id of the app that triggered the event. */
+    /** ID of the app that triggered the event */
     appId?: string;
-    /** The activity type that triggered the event. */
+    /** Type of activity that triggered the event */
     activityType?: string;
 }
 interface RewardEvent$1 extends RewardEventReceiverOneOf$1 {
     /**
-     * The referring customer ID.
+     * ID of the rewarded referring customer.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * The referred friend ID.
+     * ID of the rewarded referred friend.
      * @readonly
      */
     rewardedReferredFriendId?: string;
-    /** The referral reward ID. */
+    /** ID of the referral reward. */
     referralRewardId?: string;
-    /** The reward type. */
+    /** Type of reward. */
     rewardType?: Reward$1;
 }
 /** @oneof */
 interface RewardEventReceiverOneOf$1 {
     /**
-     * The referring customer ID.
+     * ID of the rewarded referring customer.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * The referred friend ID.
+     * ID of the rewarded referred friend.
      * @readonly
      */
     rewardedReferredFriendId?: string;
 }
 declare enum Reward$1 {
-    /** Unknown reward type. */
+    /** Unknown reward. This field is not used. */
     UNKNOWN = "UNKNOWN",
-    /** Reward is a coupon. */
+    /** Reward is a coupon */
     COUPON = "COUPON",
     /** Reward is loyalty points. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -1041,15 +1062,15 @@ declare enum Reward$1 {
     NOTHING = "NOTHING"
 }
 interface GetReferralEventRequest$1 {
-    /** Id of the ReferralEvent to retrieve */
+    /** ID of the referral event to retrieve. */
     referralEventId: string;
 }
 interface GetReferralEventResponse$1 {
-    /** The retrieved ReferralEvent */
+    /** Retrieved referral event. */
     referralEvent?: ReferralEvent$1;
 }
 interface QueryReferralEventRequest$1 {
-    /** Query to filter ReferralEvents. */
+    /** Query to filter referral events */
     query: CursorQuery$7;
 }
 interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {
@@ -1103,9 +1124,9 @@ interface CursorPaging$7 {
     cursor?: string | null;
 }
 interface QueryReferralEventResponse$1 {
-    /** List of ReferralEvents that match the query. */
+    /** List of referral events. */
     referralEvents?: ReferralEvent$1[];
-    /** Paging metadata. */
+    /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata$7;
 }
 interface CursorPagingMetadata$7 {
@@ -1130,72 +1151,71 @@ interface Cursors$7 {
 interface GetReferralStatisticsRequest$1 {
 }
 interface GetReferralStatisticsResponse$1 {
-    /** Total sign ups completed by referred friends */
+    /** Total number of sign-ups completed by referred friends. */
     totalSignUpsCompleted?: number;
-    /** Total actions completed by referred friends */
+    /** Total number of actions completed by referred friends. */
     totalActionsCompleted?: number;
-    /** Total amount of purchases made by referred friends */
+    /** Total amount of purchases made by referred friends. */
     totalAmountGenerated?: string;
 }
 interface QueryReferringCustomerTotalsRequest$1 {
-    /** Query to filter ReferringCustomerTotals. */
+    /** Query to filter referring customer totals. */
     query?: CursorQuery$7;
-    /** List of contact ids to filter ReferringCustomerTotals. */
+    /** List of contact IDs to filter referring customer totals. */
     contactIds?: string[];
 }
 interface QueryReferringCustomerTotalsResponse$1 {
-    /** List of ReferringCustomerTotals that match the query. */
     referringCustomerTotals?: ReferringCustomerTotal$1[];
-    /** Paging metadata. */
+    /** Paging metadata */
     metadata?: CursorPagingMetadata$7;
 }
 interface ReferringCustomerTotal$1 {
     /**
-     * Referring customer id.
+     * ID of the referring customer.
      * @readonly
      */
     referringCustomerId?: string;
     /**
-     * Contact id.
+     * Contact ID.
      * @readonly
      */
     contactId?: string;
     /**
-     * Last successful referral date.
+     * Date and time of the last successful referral.
      * @readonly
      */
     lastSuccessfulReferral?: Date;
     /**
-     * Total successful referrals made by this customer.
+     * Total number of successful referrals made by this customer.
      * @readonly
      */
     totalSuccessfulReferrals?: number;
     /**
-     * Total amount generated by friends referred by this customer.
+     * Total amount of revenue generated by friends referred by this customer.
      * @readonly
      */
     totalAmountGenerated?: string;
     /**
-     * Last friend action date.
+     * Date and time of the last friend action.
      * @readonly
      */
     lastFriendAction?: Date;
     /**
-     * Total friends that have actions done.
+     * Number of friends who have completed actions.
      * @readonly
      */
     totalFriendsWithActions?: number;
 }
 interface QueryReferredFriendActionsRequest$1 {
-    /** Query to filter ReferredFriendActions. */
+    /** Query to filter referred friend actions. */
     query?: CursorQuery$7;
-    /** List of contact ids to filter ReferredFriendActions. */
+    /** List of contact IDs to filter referred friend actions. */
     contactIds?: string[];
 }
 interface QueryReferredFriendActionsResponse$1 {
-    /** List of ReferredFriendActions that match the query. */
+    /** List of referred friend actions matching the query. */
     referredFriendActions?: ReferredFriendAction$1[];
-    /** Paging metadata. */
+    /** Paging metadata */
     metadata?: CursorPagingMetadata$7;
 }
 interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOneOf$1 {
@@ -1204,28 +1224,28 @@ interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOn
     /** Loyalty points reward type options. */
     loyaltyPoints?: LoyaltyPoints$1;
     /**
-     * Referred friend id.
+     * Referred friend ID.
      * @readonly
      */
     referredFriendId?: string;
     /**
-     * Contact id.
+     * Contact ID.
      * @readonly
      */
     contactId?: string;
     /**
-     * First action trigger.
+     * Trigger for the first action.
      * @readonly
      */
     trigger?: V1Trigger$1;
     /**
-     * First action date.
+     * Date and time of the first action.
      * @readonly
      */
     actionDate?: Date;
-    /** Issued reward type. */
+    /** Type of issued reward. */
     rewardType?: Reward$1;
-    /** Total number of actions. */
+    /** Number of actions completed. */
     totalActions?: number;
     /**
      * Total amount spent by this referred friend.
@@ -1233,7 +1253,7 @@ interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOn
      */
     totalAmountSpent?: string;
     /**
-     * friend signup date.
+     * Date and time of friend signup.
      * @readonly
      */
     signupDate?: Date;
@@ -1474,106 +1494,109 @@ interface QueryReferredFriendActionsResponseNonNullableFields$1 {
 }
 
 interface ReferralEvent extends ReferralEventEventTypeOneOf {
-    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    /** Event triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent;
-    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    /** Event triggered when a referral is successful. For example, customer places and pays for an order. */
     successfulReferralEvent?: V1SuccessfulReferralEvent;
-    /** ActionEvent is an event that is triggered when an action is performed. */
+    /** Event triggered when an action is performed. For example, placing an order. */
     actionEvent?: V1ActionEvent;
-    /** RewardEvent is an event that is triggered when a reward is given. */
+    /** Event triggered when a reward is given. */
     rewardEvent?: RewardEvent;
     /**
-     * ReferralEvent ID.
+     * Referral event ID.
      * @readonly
      */
     _id?: string | null;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referral event is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referral event.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferralEvent was created.
+     * Date and time the referral event was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferralEvent was last updated.
+     * Date and time the referral event was last updated.
      * @readonly
      */
     _updatedDate?: Date;
 }
 /** @oneof */
 interface ReferralEventEventTypeOneOf {
-    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    /** Event triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent;
-    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    /** Event triggered when a referral is successful. For example, customer places and pays for an order. */
     successfulReferralEvent?: V1SuccessfulReferralEvent;
-    /** ActionEvent is an event that is triggered when an action is performed. */
+    /** Event triggered when an action is performed. For example, placing an order. */
     actionEvent?: V1ActionEvent;
-    /** RewardEvent is an event that is triggered when a reward is given. */
+    /** Event triggered when a reward is given. */
     rewardEvent?: RewardEvent;
 }
 interface ReferredFriendSignupEvent {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
 }
 interface V1SuccessfulReferralEvent {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
-    /** The referring customer ID. */
+    /** ID of the referring customer */
     referringCustomerId?: string;
 }
 interface V1ActionEvent {
-    /** The referred friend ID. */
+    /** ID of the referred friend */
     referredFriendId?: string;
-    /** The referring customer ID. */
+    /** ID of the referring customer */
     referringCustomerId?: string;
-    /** The trigger of the action. */
+    /** Trigger for the action */
     trigger?: V1Trigger;
-    /** Amount. */
+    /** Amount associated with the action. */
     amount?: string | null;
-    /** Currency. */
+    /** Currency of the amount. */
     currency?: string | null;
-    /** Order ID. */
+    /** ID of the associated order. */
     orderId?: string | null;
 }
 interface V1Trigger {
-    /** The app id of the app that triggered the event. */
+    /** ID of the app that triggered the event */
     appId?: string;
-    /** The activity type that triggered the event. */
+    /** Type of activity that triggered the event */
     activityType?: string;
 }
 interface RewardEvent extends RewardEventReceiverOneOf {
     /**
-     * The referring customer ID.
+     * ID of the rewarded referring customer.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * The referred friend ID.
+     * ID of the rewarded referred friend.
      * @readonly
      */
     rewardedReferredFriendId?: string;
-    /** The referral reward ID. */
+    /** ID of the referral reward. */
     referralRewardId?: string;
-    /** The reward type. */
+    /** Type of reward. */
     rewardType?: Reward;
 }
 /** @oneof */
 interface RewardEventReceiverOneOf {
     /**
-     * The referring customer ID.
+     * ID of the rewarded referring customer.
      * @readonly
      */
     rewardedReferringCustomerId?: string;
     /**
-     * The referred friend ID.
+     * ID of the rewarded referred friend.
      * @readonly
      */
     rewardedReferredFriendId?: string;
 }
 declare enum Reward {
-    /** Unknown reward type. */
+    /** Unknown reward. This field is not used. */
     UNKNOWN = "UNKNOWN",
-    /** Reward is a coupon. */
+    /** Reward is a coupon */
     COUPON = "COUPON",
     /** Reward is loyalty points. */
     LOYALTY_POINTS = "LOYALTY_POINTS",
@@ -1581,15 +1604,15 @@ declare enum Reward {
     NOTHING = "NOTHING"
 }
 interface GetReferralEventRequest {
-    /** Id of the ReferralEvent to retrieve */
+    /** ID of the referral event to retrieve. */
     referralEventId: string;
 }
 interface GetReferralEventResponse {
-    /** The retrieved ReferralEvent */
+    /** Retrieved referral event. */
     referralEvent?: ReferralEvent;
 }
 interface QueryReferralEventRequest {
-    /** Query to filter ReferralEvents. */
+    /** Query to filter referral events */
     query: CursorQuery$6;
 }
 interface CursorQuery$6 extends CursorQueryPagingMethodOneOf$6 {
@@ -1643,9 +1666,9 @@ interface CursorPaging$6 {
     cursor?: string | null;
 }
 interface QueryReferralEventResponse {
-    /** List of ReferralEvents that match the query. */
+    /** List of referral events. */
     referralEvents?: ReferralEvent[];
-    /** Paging metadata. */
+    /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata$6;
 }
 interface CursorPagingMetadata$6 {
@@ -1670,72 +1693,71 @@ interface Cursors$6 {
 interface GetReferralStatisticsRequest {
 }
 interface GetReferralStatisticsResponse {
-    /** Total sign ups completed by referred friends */
+    /** Total number of sign-ups completed by referred friends. */
     totalSignUpsCompleted?: number;
-    /** Total actions completed by referred friends */
+    /** Total number of actions completed by referred friends. */
     totalActionsCompleted?: number;
-    /** Total amount of purchases made by referred friends */
+    /** Total amount of purchases made by referred friends. */
     totalAmountGenerated?: string;
 }
 interface QueryReferringCustomerTotalsRequest {
-    /** Query to filter ReferringCustomerTotals. */
+    /** Query to filter referring customer totals. */
     query?: CursorQuery$6;
-    /** List of contact ids to filter ReferringCustomerTotals. */
+    /** List of contact IDs to filter referring customer totals. */
     contactIds?: string[];
 }
 interface QueryReferringCustomerTotalsResponse {
-    /** List of ReferringCustomerTotals that match the query. */
     referringCustomerTotals?: ReferringCustomerTotal[];
-    /** Paging metadata. */
+    /** Paging metadata */
     metadata?: CursorPagingMetadata$6;
 }
 interface ReferringCustomerTotal {
     /**
-     * Referring customer id.
+     * ID of the referring customer.
      * @readonly
      */
     referringCustomerId?: string;
     /**
-     * Contact id.
+     * Contact ID.
      * @readonly
      */
     contactId?: string;
     /**
-     * Last successful referral date.
+     * Date and time of the last successful referral.
      * @readonly
      */
     lastSuccessfulReferral?: Date;
     /**
-     * Total successful referrals made by this customer.
+     * Total number of successful referrals made by this customer.
      * @readonly
      */
     totalSuccessfulReferrals?: number;
     /**
-     * Total amount generated by friends referred by this customer.
+     * Total amount of revenue generated by friends referred by this customer.
      * @readonly
      */
     totalAmountGenerated?: string;
     /**
-     * Last friend action date.
+     * Date and time of the last friend action.
      * @readonly
      */
     lastFriendAction?: Date;
     /**
-     * Total friends that have actions done.
+     * Number of friends who have completed actions.
      * @readonly
      */
     totalFriendsWithActions?: number;
 }
 interface QueryReferredFriendActionsRequest {
-    /** Query to filter ReferredFriendActions. */
+    /** Query to filter referred friend actions. */
     query?: CursorQuery$6;
-    /** List of contact ids to filter ReferredFriendActions. */
+    /** List of contact IDs to filter referred friend actions. */
     contactIds?: string[];
 }
 interface QueryReferredFriendActionsResponse {
-    /** List of ReferredFriendActions that match the query. */
+    /** List of referred friend actions matching the query. */
     referredFriendActions?: ReferredFriendAction[];
-    /** Paging metadata. */
+    /** Paging metadata */
     metadata?: CursorPagingMetadata$6;
 }
 interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
@@ -1744,28 +1766,28 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
     /** Loyalty points reward type options. */
     loyaltyPoints?: LoyaltyPoints;
     /**
-     * Referred friend id.
+     * Referred friend ID.
      * @readonly
      */
     referredFriendId?: string;
     /**
-     * Contact id.
+     * Contact ID.
      * @readonly
      */
     contactId?: string;
     /**
-     * First action trigger.
+     * Trigger for the first action.
      * @readonly
      */
     trigger?: V1Trigger;
     /**
-     * First action date.
+     * Date and time of the first action.
      * @readonly
      */
     actionDate?: Date;
-    /** Issued reward type. */
+    /** Type of issued reward. */
     rewardType?: Reward;
-    /** Total number of actions. */
+    /** Number of actions completed. */
     totalActions?: number;
     /**
      * Total amount spent by this referred friend.
@@ -1773,7 +1795,7 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
      */
     totalAmountSpent?: string;
     /**
-     * friend signup date.
+     * Date and time of friend signup.
      * @readonly
      */
     signupDate?: Date;
@@ -3057,55 +3079,58 @@ declare namespace meta$1 {
 /** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer$1 {
     /**
-     * ReferringCustomer id.
+     * ID of the referring customer.
      * @readonly
      */
     id?: string;
     /**
-     * Contact id.
+     * Contact ID associated with the referring customer.
      * @readonly
      */
     contactId?: string;
     /**
-     * Referral code.
+     * Unique code for the referral. For example, `GxpxwAoMqxH8`.
      * @readonly
      */
     referralCode?: string;
-    /** 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 referring customer is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referring customer.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferringCustomer was created.
+     * Date and time the referring customer was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this ReferringCustomer was last updated.
+     * Date and time the referring customer was last updated.
      * @readonly
      */
     updatedDate?: Date;
 }
 interface GenerateReferringCustomerForContactRequest$1 {
-    /** Contact id or "me" to generate current identity's referring customer. */
+    /** Contact ID or `"me"` to generate the current identity's referring customer. */
     contactId: string;
 }
 interface GenerateReferringCustomerForContactResponse$1 {
-    /** The created ReferringCustomer. */
+    /** Created referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface GetReferringCustomerRequest$1 {
-    /** Id of the ReferringCustomer to retrieve. */
+    /** ID of the referring customer to retrieve. */
     referringCustomerId: string;
 }
 interface GetReferringCustomerResponse$1 {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface GetReferringCustomerByReferralCodeRequest$1 {
-    /** Referral Code of the ReferringCustomer to retrieve. */
+    /** Referral code of the referring customer to retrieve. */
     referralCode: string;
 }
 interface GetReferringCustomerByReferralCodeResponse$1 {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface QueryReferringCustomersRequest$1 {
@@ -3113,26 +3138,32 @@ interface QueryReferringCustomersRequest$1 {
     query: CursorQuery$1;
 }
 interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$1;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$1[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$1 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$1;
 }
 interface Sorting$1 {
@@ -3157,13 +3188,13 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryReferringCustomersResponse$1 {
-    /** The retrieved ReferringCustomers. */
+    /** List of retrieved referring customers. */
     referringCustomers?: ReferringCustomer$1[];
     /** Paging metadata. */
     metadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$1;
@@ -3182,9 +3213,9 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface DeleteReferringCustomerRequest$1 {
-    /** Id of the ReferringCustomer to delete. */
+    /** ID of the referring customer to delete. */
     referringCustomerId: string;
-    /** The revision of the ReferringCustomer. */
+    /** Revision number of the referring customer. */
     revision?: string;
 }
 interface DeleteReferringCustomerResponse$1 {
@@ -3210,55 +3241,58 @@ interface QueryReferringCustomersResponseNonNullableFields$1 {
 /** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer {
     /**
-     * ReferringCustomer id.
+     * ID of the referring customer.
      * @readonly
      */
     _id?: string;
     /**
-     * Contact id.
+     * Contact ID associated with the referring customer.
      * @readonly
      */
     contactId?: string;
     /**
-     * Referral code.
+     * Unique code for the referral. For example, `GxpxwAoMqxH8`.
      * @readonly
      */
     referralCode?: string;
-    /** 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 referring customer is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referring customer.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferringCustomer was created.
+     * Date and time the referring customer was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferringCustomer was last updated.
+     * Date and time the referring customer was last updated.
      * @readonly
      */
     _updatedDate?: Date;
 }
 interface GenerateReferringCustomerForContactRequest {
-    /** Contact id or "me" to generate current identity's referring customer. */
+    /** Contact ID or `"me"` to generate the current identity's referring customer. */
     contactId: string;
 }
 interface GenerateReferringCustomerForContactResponse {
-    /** The created ReferringCustomer. */
+    /** Created referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface GetReferringCustomerRequest {
-    /** Id of the ReferringCustomer to retrieve. */
+    /** ID of the referring customer to retrieve. */
     referringCustomerId: string;
 }
 interface GetReferringCustomerResponse {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface GetReferringCustomerByReferralCodeRequest {
-    /** Referral Code of the ReferringCustomer to retrieve. */
+    /** Referral code of the referring customer to retrieve. */
     referralCode: string;
 }
 interface GetReferringCustomerByReferralCodeResponse {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface QueryReferringCustomersRequest {
@@ -3266,26 +3300,32 @@ interface QueryReferringCustomersRequest {
     query: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
 }
 interface Sorting {
@@ -3310,13 +3350,13 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryReferringCustomersResponse {
-    /** The retrieved ReferringCustomers. */
+    /** List of retrieved referring customers. */
     referringCustomers?: ReferringCustomer[];
     /** Paging metadata. */
     metadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors;
@@ -3335,9 +3375,9 @@ interface Cursors {
     prev?: string | null;
 }
 interface DeleteReferringCustomerRequest {
-    /** Id of the ReferringCustomer to delete. */
+    /** ID of the referring customer to delete. */
     referringCustomerId: string;
-    /** The revision of the ReferringCustomer. */
+    /** Revision number of the referring customer. */
     revision?: string;
 }
 interface DeleteReferringCustomerResponse {