@wix/referral 1.0.13 → 1.0.14

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

@@ -1765,106 +1765,109 @@ declare namespace index_d$4 {
 }
 
 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$1;
 }
 /** @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$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",
@@ -1872,23 +1875,23 @@ declare enum Reward$1 {
     NOTHING = "NOTHING"
 }
 interface CreateReferralEventRequest {
-    /** ReferralEvent to be created */
+    /** Referral event to create */
     referralEvent?: ReferralEvent;
 }
 interface CreateReferralEventResponse {
-    /** The created ReferralEvent */
+    /** Created referral event */
     referralEvent?: ReferralEvent;
 }
 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$3;
 }
 interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
@@ -1942,9 +1945,9 @@ interface CursorPaging$3 {
     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$3;
 }
 interface CursorPagingMetadata$3 {
@@ -1969,72 +1972,71 @@ interface Cursors$3 {
 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$3;
-    /** 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$3;
 }
 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$3;
-    /** 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$3;
 }
 interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
@@ -2043,28 +2045,28 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
     /** 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;
     /**
-     * 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.
@@ -2072,7 +2074,7 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
      */
     totalAmountSpent?: string;
     /**
-     * friend signup date.
+     * Date and time of friend signup.
      * @readonly
      */
     signupDate?: Date;
@@ -2585,52 +2587,67 @@ interface ReferralEventsQueryBuilder {
     find: () => Promise<ReferralEventsQueryResult>;
 }
 interface QueryReferringCustomerTotalsOptions {
-    /** Query to filter ReferringCustomerTotals. */
+    /** Query to filter referring customer totals. */
     query?: CursorQuery$3;
-    /** List of contact ids to filter ReferringCustomerTotals. */
+    /** List of contact IDs to filter referring customer totals. */
     contactIds?: string[];
 }
 interface QueryReferredFriendActionsOptions {
-    /** Query to filter ReferredFriendActions. */
+    /** Query to filter referred friend actions. */
     query?: CursorQuery$3;
-    /** List of contact ids to filter ReferredFriendActions. */
+    /** List of contact IDs to filter referred friend actions. */
     contactIds?: string[];
 }
 
 declare function getReferralEvent$1(httpClient: HttpClient): GetReferralEventSignature;
 interface GetReferralEventSignature {
     /**
-     * Get a ReferralEvent by id.
-     * @param - Id of the ReferralEvent to retrieve
-     * @returns The retrieved ReferralEvent
+     * Retrieves a referral event by ID.
+     * @param - ID of the referral event to retrieve.
+     * @returns Retrieved referral event.
      */
     (referralEventId: string): Promise<ReferralEvent & ReferralEventNonNullableFields>;
 }
 declare function queryReferralEvent$1(httpClient: HttpClient): QueryReferralEventSignature;
 interface QueryReferralEventSignature {
     /**
-     * Query ReferralEvents
+     * Retrieves a list of referral events, given the provided paging, filtering, and sorting.
+     *
+     * 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).
      */
     (): ReferralEventsQueryBuilder;
 }
 declare function getReferralStatistics$1(httpClient: HttpClient): GetReferralStatisticsSignature;
 interface GetReferralStatisticsSignature {
     /**
-     * Get referral statistics.
+     * Retrieves referral statistics.
      */
     (): Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
 }
 declare function queryReferringCustomerTotals$1(httpClient: HttpClient): QueryReferringCustomerTotalsSignature;
 interface QueryReferringCustomerTotalsSignature {
     /**
-     * Query referring customer totals.
+     * Retrieves a list of referring customer totals, given the provided paging, filtering, and sorting.
+     *
+     * 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).
      */
     (options?: QueryReferringCustomerTotalsOptions | undefined): Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
 }
 declare function queryReferredFriendActions$1(httpClient: HttpClient): QueryReferredFriendActionsSignature;
 interface QueryReferredFriendActionsSignature {
     /**
-     * Query referred friend actions.
+     * Retrieves a list of referred friend actions, given the provided paging, filtering, and sorting.
+     *
+     * 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).
      */
     (options?: QueryReferredFriendActionsOptions | undefined): Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
 }