@wix/referral 1.0.0

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

@@ -0,0 +1,1053 @@
+/** ReferralEvent. */
+interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
+    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
+    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    successfulReferralEvent?: V1SuccessfulReferralEvent$1;
+    /** ActionEvent is an event that is triggered when an action is performed. */
+    actionEvent?: V1ActionEvent$1;
+    /** RewardEvent is an event that is triggered when a reward is given. */
+    rewardEvent?: RewardEvent$1;
+    /**
+     * ReferralEvent 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?: string | null;
+    /**
+     * Represents the time this ReferralEvent was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Represents the time this ReferralEvent was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+}
+/** @oneof */
+interface ReferralEventEventTypeOneOf$1 {
+    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
+    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    successfulReferralEvent?: V1SuccessfulReferralEvent$1;
+    /** ActionEvent is an event that is triggered when an action is performed. */
+    actionEvent?: V1ActionEvent$1;
+    /** RewardEvent is an event that is triggered when a reward is given. */
+    rewardEvent?: RewardEvent$1;
+}
+interface ReferredFriendSignupEvent$1 {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+}
+interface V1SuccessfulReferralEvent$1 {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+    /** The referring customer ID. */
+    referringCustomerId?: string;
+}
+interface V1ActionEvent$1 {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+    /** The referring customer ID. */
+    referringCustomerId?: string;
+    /** The trigger of the action. */
+    trigger?: V1Trigger$1;
+    /** Amount. */
+    amount?: string | null;
+    /** Currency. */
+    currency?: string | null;
+    /** Order ID. */
+    orderId?: string | null;
+}
+interface V1Trigger$1 {
+    /** The app id of the app that triggered the event. */
+    appId?: string;
+    /** The activity type that triggered the event. */
+    activityType?: string;
+}
+interface RewardEvent$1 extends RewardEventReceiverOneOf$1 {
+    /**
+     * The referring customer ID.
+     * @readonly
+     */
+    rewardedReferringCustomerId?: string;
+    /**
+     * The referred friend ID.
+     * @readonly
+     */
+    rewardedReferredFriendId?: string;
+    /** The referral reward ID. */
+    referralRewardId?: string;
+    /** The reward type. */
+    rewardType?: Reward$1;
+}
+/** @oneof */
+interface RewardEventReceiverOneOf$1 {
+    /**
+     * The referring customer ID.
+     * @readonly
+     */
+    rewardedReferringCustomerId?: string;
+    /**
+     * The referred friend ID.
+     * @readonly
+     */
+    rewardedReferredFriendId?: string;
+}
+declare enum Reward$1 {
+    /** Unknown reward type. */
+    UNKNOWN = "UNKNOWN",
+    /** Reward is a coupon. */
+    COUPON = "COUPON",
+    /** Reward is loyalty points. */
+    LOYALTY_POINTS = "LOYALTY_POINTS",
+    /** No reward. */
+    NOTHING = "NOTHING"
+}
+interface GetReferralEventRequest$1 {
+    /** Id of the ReferralEvent to retrieve */
+    referralEventId: string;
+}
+interface GetReferralEventResponse$1 {
+    /** The retrieved ReferralEvent */
+    referralEvent?: ReferralEvent$1;
+}
+interface QueryReferralEventRequest$1 {
+    /** Query to filter ReferralEvents. */
+    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`. */
+    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?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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`. */
+    cursorPaging?: CursorPaging$1;
+}
+interface Sorting$1 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$1;
+}
+declare enum SortOrder$1 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging$1 {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryReferralEventResponse$1 {
+    /** List of ReferralEvents that match the query. */
+    referralEvents?: ReferralEvent$1[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata$1;
+}
+interface CursorPagingMetadata$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors$1;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors$1 {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface GetReferralStatisticsRequest$1 {
+}
+interface GetReferralStatisticsResponse$1 {
+    /** Total sign ups completed by referred friends */
+    totalSignUpsCompleted?: number;
+    /** Total actions completed by referred friends */
+    totalActionsCompleted?: number;
+    /** Total amount of purchases made by referred friends */
+    totalAmountGenerated?: string;
+}
+interface QueryReferringCustomerTotalsRequest$1 {
+    /** Query to filter ReferringCustomerTotals. */
+    query?: CursorQuery$1;
+    /** List of contact ids to filter ReferringCustomerTotals. */
+    contactIds?: string[];
+}
+interface QueryReferringCustomerTotalsResponse$1 {
+    /** List of ReferringCustomerTotals that match the query. */
+    referringCustomerTotals?: ReferringCustomerTotal$1[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata$1;
+}
+interface ReferringCustomerTotal$1 {
+    /**
+     * Referring customer id.
+     * @readonly
+     */
+    referringCustomerId?: string;
+    /**
+     * Contact id.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Last successful referral date.
+     * @readonly
+     */
+    lastSuccessfulReferral?: Date;
+    /**
+     * Total successful referrals made by this customer.
+     * @readonly
+     */
+    totalSuccessfulReferrals?: number;
+    /**
+     * Total amount generated by friends referred by this customer.
+     * @readonly
+     */
+    totalAmountGenerated?: string;
+    /**
+     * Last friend action date.
+     * @readonly
+     */
+    lastFriendAction?: Date;
+    /**
+     * Total friends that have actions done.
+     * @readonly
+     */
+    totalFriendsWithActions?: number;
+}
+interface QueryReferredFriendActionsRequest$1 {
+    /** Query to filter ReferredFriendActions. */
+    query?: CursorQuery$1;
+    /** List of contact ids to filter ReferredFriendActions. */
+    contactIds?: string[];
+}
+interface QueryReferredFriendActionsResponse$1 {
+    /** List of ReferredFriendActions that match the query. */
+    referredFriendActions?: ReferredFriendAction$1[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata$1;
+}
+interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOneOf$1 {
+    /** Coupon reward type options. */
+    coupon?: V1Coupon$1;
+    /** Loyalty points reward type options. */
+    loyaltyPoints?: LoyaltyPoints$1;
+    /**
+     * Referred friend id.
+     * @readonly
+     */
+    referredFriendId?: string;
+    /**
+     * Contact id.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * First action trigger.
+     * @readonly
+     */
+    trigger?: V1Trigger$1;
+    /**
+     * First action date.
+     * @readonly
+     */
+    actionDate?: Date;
+    /** Issued reward type. */
+    rewardType?: Reward$1;
+    /** Total number of actions. */
+    totalActions?: number;
+    /**
+     * Total amount spent by this referred friend.
+     * @readonly
+     */
+    totalAmountSpent?: string;
+    /**
+     * friend signup date.
+     * @readonly
+     */
+    signupDate?: Date;
+}
+/** @oneof */
+interface ReferredFriendActionRewardTypeOptionsOneOf$1 {
+    /** Coupon reward type options. */
+    coupon?: V1Coupon$1;
+    /** Loyalty points reward type options. */
+    loyaltyPoints?: LoyaltyPoints$1;
+}
+interface V1Coupon$1 {
+    /**
+     * Coupon id
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Coupon code
+     * @readonly
+     */
+    code?: string;
+    /**
+     * Coupon status
+     * @readonly
+     */
+    status?: Status$1;
+    /**
+     * Coupon specification
+     * @readonly
+     */
+    couponSpecification?: Coupon$1;
+}
+declare enum Status$1 {
+    UNKNOWN = "UNKNOWN",
+    /** Coupon is active and can be applied */
+    ACTIVE = "ACTIVE",
+    /** Coupon was already applied and can not be used anymore */
+    APPLIED = "APPLIED",
+    /** Coupon was deleted */
+    DELETED = "DELETED"
+}
+interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
+    /** Options for fixed amount discount type */
+    fixedAmountOptions?: FixedAmountDiscount$1;
+    /** Options for percentage discount type */
+    percentageOptions?: PercentageDiscount$1;
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope$1;
+    /** Coupon name */
+    name?: string;
+    /** Coupon discount type */
+    discountType?: DiscountType$1;
+    /** Limit the coupon to only apply to one item in cart. */
+    limitedToOneItem?: boolean | null;
+    /** If true, coupon also applies to subscriptions. */
+    appliesToSubscriptions?: boolean | null;
+    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    discountedCycleCount?: number | null;
+}
+/** @oneof */
+interface CouponDiscountTypeOptionsOneOf$1 {
+    /** Options for fixed amount discount type */
+    fixedAmountOptions?: FixedAmountDiscount$1;
+    /** Options for percentage discount type */
+    percentageOptions?: PercentageDiscount$1;
+}
+/** @oneof */
+interface CouponScopeOrMinSubtotalOneOf$1 {
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope$1;
+}
+declare enum DiscountType$1 {
+    UNKNOWN = "UNKNOWN",
+    /** Discount as a fixed amount */
+    FIXED_AMOUNT = "FIXED_AMOUNT",
+    /** Discount as a percentage */
+    PERCENTAGE = "PERCENTAGE",
+    /** Free shipping */
+    FREE_SHIPPING = "FREE_SHIPPING"
+}
+interface FixedAmountDiscount$1 {
+    /** Fixed amount to discount */
+    amount?: number;
+}
+interface PercentageDiscount$1 {
+    percentage?: number;
+}
+interface CouponScope$1 {
+    namespace?: string;
+    group?: Group$1;
+}
+interface Group$1 {
+    name?: string;
+    entityId?: string | null;
+}
+interface LoyaltyPoints$1 {
+    /**
+     * Loyalty transaction id
+     * @readonly
+     */
+    transactionId?: string;
+    /**
+     * Loyalty points amount given
+     * @readonly
+     */
+    amount?: number;
+}
+interface GetReferralEventResponseNonNullableFields$1 {
+    referralEvent?: {
+        referredFriendSignupEvent?: {
+            referredFriendId: string;
+        };
+        successfulReferralEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+        };
+        actionEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+            trigger?: {
+                appId: string;
+                activityType: string;
+            };
+        };
+        rewardEvent?: {
+            rewardedReferringCustomerId: string;
+            rewardedReferredFriendId: string;
+            referralRewardId: string;
+            rewardType: Reward$1;
+        };
+    };
+}
+interface QueryReferralEventResponseNonNullableFields$1 {
+    referralEvents: {
+        referredFriendSignupEvent?: {
+            referredFriendId: string;
+        };
+        successfulReferralEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+        };
+        actionEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+            trigger?: {
+                appId: string;
+                activityType: string;
+            };
+        };
+        rewardEvent?: {
+            rewardedReferringCustomerId: string;
+            rewardedReferredFriendId: string;
+            referralRewardId: string;
+            rewardType: Reward$1;
+        };
+    }[];
+}
+interface GetReferralStatisticsResponseNonNullableFields$1 {
+    totalSignUpsCompleted: number;
+    totalActionsCompleted: number;
+    totalAmountGenerated: string;
+}
+interface QueryReferringCustomerTotalsResponseNonNullableFields$1 {
+    referringCustomerTotals: {
+        referringCustomerId: string;
+        contactId: string;
+        totalSuccessfulReferrals: number;
+        totalAmountGenerated: string;
+        totalFriendsWithActions: number;
+    }[];
+}
+interface QueryReferredFriendActionsResponseNonNullableFields$1 {
+    referredFriendActions: {
+        coupon?: {
+            id: string;
+            code: string;
+            status: Status$1;
+            couponSpecification?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+        };
+        loyaltyPoints?: {
+            transactionId: string;
+            amount: number;
+        };
+        referredFriendId: string;
+        contactId: string;
+        trigger?: {
+            appId: string;
+            activityType: string;
+        };
+        rewardType: Reward$1;
+        totalActions: number;
+        totalAmountSpent: string;
+    }[];
+}
+
+/** ReferralEvent. */
+interface ReferralEvent extends ReferralEventEventTypeOneOf {
+    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    referredFriendSignupEvent?: ReferredFriendSignupEvent;
+    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    successfulReferralEvent?: V1SuccessfulReferralEvent;
+    /** ActionEvent is an event that is triggered when an action is performed. */
+    actionEvent?: V1ActionEvent;
+    /** RewardEvent is an event that is triggered when a reward is given. */
+    rewardEvent?: RewardEvent;
+    /**
+     * ReferralEvent 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?: string | null;
+    /**
+     * Represents the time this ReferralEvent was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this ReferralEvent was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+/** @oneof */
+interface ReferralEventEventTypeOneOf {
+    /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
+    referredFriendSignupEvent?: ReferredFriendSignupEvent;
+    /** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
+    successfulReferralEvent?: V1SuccessfulReferralEvent;
+    /** ActionEvent is an event that is triggered when an action is performed. */
+    actionEvent?: V1ActionEvent;
+    /** RewardEvent is an event that is triggered when a reward is given. */
+    rewardEvent?: RewardEvent;
+}
+interface ReferredFriendSignupEvent {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+}
+interface V1SuccessfulReferralEvent {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+    /** The referring customer ID. */
+    referringCustomerId?: string;
+}
+interface V1ActionEvent {
+    /** The referred friend ID. */
+    referredFriendId?: string;
+    /** The referring customer ID. */
+    referringCustomerId?: string;
+    /** The trigger of the action. */
+    trigger?: V1Trigger;
+    /** Amount. */
+    amount?: string | null;
+    /** Currency. */
+    currency?: string | null;
+    /** Order ID. */
+    orderId?: string | null;
+}
+interface V1Trigger {
+    /** The app id of the app that triggered the event. */
+    appId?: string;
+    /** The activity type that triggered the event. */
+    activityType?: string;
+}
+interface RewardEvent extends RewardEventReceiverOneOf {
+    /**
+     * The referring customer ID.
+     * @readonly
+     */
+    rewardedReferringCustomerId?: string;
+    /**
+     * The referred friend ID.
+     * @readonly
+     */
+    rewardedReferredFriendId?: string;
+    /** The referral reward ID. */
+    referralRewardId?: string;
+    /** The reward type. */
+    rewardType?: Reward;
+}
+/** @oneof */
+interface RewardEventReceiverOneOf {
+    /**
+     * The referring customer ID.
+     * @readonly
+     */
+    rewardedReferringCustomerId?: string;
+    /**
+     * The referred friend ID.
+     * @readonly
+     */
+    rewardedReferredFriendId?: string;
+}
+declare enum Reward {
+    /** Unknown reward type. */
+    UNKNOWN = "UNKNOWN",
+    /** Reward is a coupon. */
+    COUPON = "COUPON",
+    /** Reward is loyalty points. */
+    LOYALTY_POINTS = "LOYALTY_POINTS",
+    /** No reward. */
+    NOTHING = "NOTHING"
+}
+interface GetReferralEventRequest {
+    /** Id of the ReferralEvent to retrieve */
+    referralEventId: string;
+}
+interface GetReferralEventResponse {
+    /** The retrieved ReferralEvent */
+    referralEvent?: ReferralEvent;
+}
+interface QueryReferralEventRequest {
+    /** Query to filter ReferralEvents. */
+    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`. */
+    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?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryReferralEventResponse {
+    /** List of ReferralEvents that match the query. */
+    referralEvents?: ReferralEvent[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface GetReferralStatisticsRequest {
+}
+interface GetReferralStatisticsResponse {
+    /** Total sign ups completed by referred friends */
+    totalSignUpsCompleted?: number;
+    /** Total actions completed by referred friends */
+    totalActionsCompleted?: number;
+    /** Total amount of purchases made by referred friends */
+    totalAmountGenerated?: string;
+}
+interface QueryReferringCustomerTotalsRequest {
+    /** Query to filter ReferringCustomerTotals. */
+    query?: CursorQuery;
+    /** List of contact ids to filter ReferringCustomerTotals. */
+    contactIds?: string[];
+}
+interface QueryReferringCustomerTotalsResponse {
+    /** List of ReferringCustomerTotals that match the query. */
+    referringCustomerTotals?: ReferringCustomerTotal[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface ReferringCustomerTotal {
+    /**
+     * Referring customer id.
+     * @readonly
+     */
+    referringCustomerId?: string;
+    /**
+     * Contact id.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Last successful referral date.
+     * @readonly
+     */
+    lastSuccessfulReferral?: Date;
+    /**
+     * Total successful referrals made by this customer.
+     * @readonly
+     */
+    totalSuccessfulReferrals?: number;
+    /**
+     * Total amount generated by friends referred by this customer.
+     * @readonly
+     */
+    totalAmountGenerated?: string;
+    /**
+     * Last friend action date.
+     * @readonly
+     */
+    lastFriendAction?: Date;
+    /**
+     * Total friends that have actions done.
+     * @readonly
+     */
+    totalFriendsWithActions?: number;
+}
+interface QueryReferredFriendActionsRequest {
+    /** Query to filter ReferredFriendActions. */
+    query?: CursorQuery;
+    /** List of contact ids to filter ReferredFriendActions. */
+    contactIds?: string[];
+}
+interface QueryReferredFriendActionsResponse {
+    /** List of ReferredFriendActions that match the query. */
+    referredFriendActions?: ReferredFriendAction[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
+    /** Coupon reward type options. */
+    coupon?: V1Coupon;
+    /** Loyalty points reward type options. */
+    loyaltyPoints?: LoyaltyPoints;
+    /**
+     * Referred friend id.
+     * @readonly
+     */
+    referredFriendId?: string;
+    /**
+     * Contact id.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * First action trigger.
+     * @readonly
+     */
+    trigger?: V1Trigger;
+    /**
+     * First action date.
+     * @readonly
+     */
+    actionDate?: Date;
+    /** Issued reward type. */
+    rewardType?: Reward;
+    /** Total number of actions. */
+    totalActions?: number;
+    /**
+     * Total amount spent by this referred friend.
+     * @readonly
+     */
+    totalAmountSpent?: string;
+    /**
+     * friend signup date.
+     * @readonly
+     */
+    signupDate?: Date;
+}
+/** @oneof */
+interface ReferredFriendActionRewardTypeOptionsOneOf {
+    /** Coupon reward type options. */
+    coupon?: V1Coupon;
+    /** Loyalty points reward type options. */
+    loyaltyPoints?: LoyaltyPoints;
+}
+interface V1Coupon {
+    /**
+     * Coupon id
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Coupon code
+     * @readonly
+     */
+    code?: string;
+    /**
+     * Coupon status
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Coupon specification
+     * @readonly
+     */
+    couponSpecification?: Coupon;
+}
+declare enum Status {
+    UNKNOWN = "UNKNOWN",
+    /** Coupon is active and can be applied */
+    ACTIVE = "ACTIVE",
+    /** Coupon was already applied and can not be used anymore */
+    APPLIED = "APPLIED",
+    /** Coupon was deleted */
+    DELETED = "DELETED"
+}
+interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
+    /** Options for fixed amount discount type */
+    fixedAmountOptions?: FixedAmountDiscount;
+    /** Options for percentage discount type */
+    percentageOptions?: PercentageDiscount;
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope;
+    /** Coupon name */
+    name?: string;
+    /** Coupon discount type */
+    discountType?: DiscountType;
+    /** Limit the coupon to only apply to one item in cart. */
+    limitedToOneItem?: boolean | null;
+    /** If true, coupon also applies to subscriptions. */
+    appliesToSubscriptions?: boolean | null;
+    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    discountedCycleCount?: number | null;
+}
+/** @oneof */
+interface CouponDiscountTypeOptionsOneOf {
+    /** Options for fixed amount discount type */
+    fixedAmountOptions?: FixedAmountDiscount;
+    /** Options for percentage discount type */
+    percentageOptions?: PercentageDiscount;
+}
+/** @oneof */
+interface CouponScopeOrMinSubtotalOneOf {
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope;
+}
+declare enum DiscountType {
+    UNKNOWN = "UNKNOWN",
+    /** Discount as a fixed amount */
+    FIXED_AMOUNT = "FIXED_AMOUNT",
+    /** Discount as a percentage */
+    PERCENTAGE = "PERCENTAGE",
+    /** Free shipping */
+    FREE_SHIPPING = "FREE_SHIPPING"
+}
+interface FixedAmountDiscount {
+    /** Fixed amount to discount */
+    amount?: number;
+}
+interface PercentageDiscount {
+    percentage?: number;
+}
+interface CouponScope {
+    namespace?: string;
+    group?: Group;
+}
+interface Group {
+    name?: string;
+    entityId?: string | null;
+}
+interface LoyaltyPoints {
+    /**
+     * Loyalty transaction id
+     * @readonly
+     */
+    transactionId?: string;
+    /**
+     * Loyalty points amount given
+     * @readonly
+     */
+    amount?: number;
+}
+interface GetReferralEventResponseNonNullableFields {
+    referralEvent?: {
+        referredFriendSignupEvent?: {
+            referredFriendId: string;
+        };
+        successfulReferralEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+        };
+        actionEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+            trigger?: {
+                appId: string;
+                activityType: string;
+            };
+        };
+        rewardEvent?: {
+            rewardedReferringCustomerId: string;
+            rewardedReferredFriendId: string;
+            referralRewardId: string;
+            rewardType: Reward;
+        };
+    };
+}
+interface QueryReferralEventResponseNonNullableFields {
+    referralEvents: {
+        referredFriendSignupEvent?: {
+            referredFriendId: string;
+        };
+        successfulReferralEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+        };
+        actionEvent?: {
+            referredFriendId: string;
+            referringCustomerId: string;
+            trigger?: {
+                appId: string;
+                activityType: string;
+            };
+        };
+        rewardEvent?: {
+            rewardedReferringCustomerId: string;
+            rewardedReferredFriendId: string;
+            referralRewardId: string;
+            rewardType: Reward;
+        };
+    }[];
+}
+interface GetReferralStatisticsResponseNonNullableFields {
+    totalSignUpsCompleted: number;
+    totalActionsCompleted: number;
+    totalAmountGenerated: string;
+}
+interface QueryReferringCustomerTotalsResponseNonNullableFields {
+    referringCustomerTotals: {
+        referringCustomerId: string;
+        contactId: string;
+        totalSuccessfulReferrals: number;
+        totalAmountGenerated: string;
+        totalFriendsWithActions: number;
+    }[];
+}
+interface QueryReferredFriendActionsResponseNonNullableFields {
+    referredFriendActions: {
+        coupon?: {
+            _id: string;
+            code: string;
+            status: Status;
+            couponSpecification?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType;
+            };
+        };
+        loyaltyPoints?: {
+            transactionId: string;
+            amount: number;
+        };
+        referredFriendId: string;
+        contactId: string;
+        trigger?: {
+            appId: string;
+            activityType: string;
+        };
+        rewardType: Reward;
+        totalActions: number;
+        totalAmountSpent: string;
+    }[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getReferralEvent(): __PublicMethodMetaInfo<'GET', {
+    referralEventId: string;
+}, GetReferralEventRequest, GetReferralEventRequest$1, GetReferralEventResponse & GetReferralEventResponseNonNullableFields, GetReferralEventResponse$1 & GetReferralEventResponseNonNullableFields$1>;
+declare function queryReferralEvent(): __PublicMethodMetaInfo<'POST', {}, QueryReferralEventRequest, QueryReferralEventRequest$1, QueryReferralEventResponse & QueryReferralEventResponseNonNullableFields, QueryReferralEventResponse$1 & QueryReferralEventResponseNonNullableFields$1>;
+declare function getReferralStatistics(): __PublicMethodMetaInfo<'GET', {}, GetReferralStatisticsRequest, GetReferralStatisticsRequest$1, GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields, GetReferralStatisticsResponse$1 & GetReferralStatisticsResponseNonNullableFields$1>;
+declare function queryReferringCustomerTotals(): __PublicMethodMetaInfo<'POST', {}, QueryReferringCustomerTotalsRequest, QueryReferringCustomerTotalsRequest$1, QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields, QueryReferringCustomerTotalsResponse$1 & QueryReferringCustomerTotalsResponseNonNullableFields$1>;
+declare function queryReferredFriendActions(): __PublicMethodMetaInfo<'POST', {}, QueryReferredFriendActionsRequest, QueryReferredFriendActionsRequest$1, QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields, QueryReferredFriendActionsResponse$1 & QueryReferredFriendActionsResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_getReferralEvent: typeof getReferralEvent;
+declare const meta_getReferralStatistics: typeof getReferralStatistics;
+declare const meta_queryReferralEvent: typeof queryReferralEvent;
+declare const meta_queryReferredFriendActions: typeof queryReferredFriendActions;
+declare const meta_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getReferralEvent as getReferralEvent, meta_getReferralStatistics as getReferralStatistics, meta_queryReferralEvent as queryReferralEvent, meta_queryReferredFriendActions as queryReferredFriendActions, meta_queryReferringCustomerTotals as queryReferringCustomerTotals };
+}
+
+export { meta as tracker };