@wix/referral 1.0.0

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

@@ -0,0 +1,948 @@
+/** 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 CreateReferralEventRequest {
+    /** ReferralEvent to be created */
+    referralEvent?: ReferralEvent;
+}
+interface CreateReferralEventResponse {
+    /** The created ReferralEvent */
+    referralEvent?: ReferralEvent;
+}
+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 DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface UndeleteInfo {
+    deletedDate?: Date;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface SuccessfulReferralEvent {
+    /** ReferredFriend that completed his referral details */
+    referredFriendDetails?: ReferredFriendDetails;
+}
+interface ReferredFriendDetails {
+    /**
+     * ReferredFriend ID
+     * @readonly
+     */
+    referredFriendId?: string;
+    /**
+     * ReferredFriend Contact ID
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Customer who referred this ReferredFriend
+     * @readonly
+     */
+    referringCustomerId?: string;
+}
+interface ReferredFriendActionEvent {
+    referredFriendDetails?: ReferredFriendDetails;
+    trigger?: Trigger;
+    amount?: string | null;
+    currency?: string | null;
+    orderId?: string | null;
+}
+interface Trigger {
+    appId?: string;
+    activityType?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+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;
+    }[];
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface ReferralEventCreatedEnvelope {
+    entity: ReferralEvent;
+    metadata: EventMetadata;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferralEventsQueryResult extends QueryCursorResult {
+    items: ReferralEvent[];
+    query: ReferralEventsQueryBuilder;
+    next: () => Promise<ReferralEventsQueryResult>;
+    prev: () => Promise<ReferralEventsQueryResult>;
+}
+interface ReferralEventsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_createdDate' | '_updatedDate', value: any[]) => ReferralEventsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_createdDate' | '_updatedDate', value: boolean) => ReferralEventsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => ReferralEventsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => ReferralEventsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ReferralEventsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReferralEventsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferralEventsQueryResult>;
+}
+interface QueryReferringCustomerTotalsOptions {
+    /** Query to filter ReferringCustomerTotals. */
+    query?: CursorQuery;
+    /** List of contact ids to filter ReferringCustomerTotals. */
+    contactIds?: string[];
+}
+interface QueryReferredFriendActionsOptions {
+    /** Query to filter ReferredFriendActions. */
+    query?: CursorQuery;
+    /** List of contact ids to filter ReferredFriendActions. */
+    contactIds?: string[];
+}
+
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function getReferralEvent(httpClient: HttpClient): (referralEventId: string) => Promise<ReferralEvent & {
+    referredFriendSignupEvent?: {
+        referredFriendId: string;
+    } | undefined;
+    successfulReferralEvent?: {
+        referredFriendId: string;
+        referringCustomerId: string;
+    } | undefined;
+    actionEvent?: {
+        referredFriendId: string;
+        referringCustomerId: string;
+        trigger?: {
+            appId: string;
+            activityType: string;
+        } | undefined;
+    } | undefined;
+    rewardEvent?: {
+        rewardedReferringCustomerId: string;
+        rewardedReferredFriendId: string;
+        referralRewardId: string;
+        rewardType: Reward;
+    } | undefined;
+}>;
+declare function queryReferralEvent(httpClient: HttpClient): () => ReferralEventsQueryBuilder;
+declare function getReferralStatistics(httpClient: HttpClient): () => Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
+declare function queryReferringCustomerTotals(httpClient: HttpClient): (options?: QueryReferringCustomerTotalsOptions) => Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
+declare function queryReferredFriendActions(httpClient: HttpClient): (options?: QueryReferredFriendActionsOptions) => Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
+declare const onReferralEventCreated: EventDefinition<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_BaseEventMetadata = BaseEventMetadata;
+type index_d_Coupon = Coupon;
+type index_d_CouponDiscountTypeOptionsOneOf = CouponDiscountTypeOptionsOneOf;
+type index_d_CouponScope = CouponScope;
+type index_d_CouponScopeOrMinSubtotalOneOf = CouponScopeOrMinSubtotalOneOf;
+type index_d_CreateReferralEventRequest = CreateReferralEventRequest;
+type index_d_CreateReferralEventResponse = CreateReferralEventResponse;
+type index_d_CursorPaging = CursorPaging;
+type index_d_CursorPagingMetadata = CursorPagingMetadata;
+type index_d_CursorQuery = CursorQuery;
+type index_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;
+type index_d_Cursors = Cursors;
+type index_d_DiscountType = DiscountType;
+declare const index_d_DiscountType: typeof DiscountType;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_Empty = Empty;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_EventMetadata = EventMetadata;
+type index_d_FixedAmountDiscount = FixedAmountDiscount;
+type index_d_GetReferralEventRequest = GetReferralEventRequest;
+type index_d_GetReferralEventResponse = GetReferralEventResponse;
+type index_d_GetReferralEventResponseNonNullableFields = GetReferralEventResponseNonNullableFields;
+type index_d_GetReferralStatisticsRequest = GetReferralStatisticsRequest;
+type index_d_GetReferralStatisticsResponse = GetReferralStatisticsResponse;
+type index_d_GetReferralStatisticsResponseNonNullableFields = GetReferralStatisticsResponseNonNullableFields;
+type index_d_Group = Group;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_LoyaltyPoints = LoyaltyPoints;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_PercentageDiscount = PercentageDiscount;
+type index_d_QueryReferralEventRequest = QueryReferralEventRequest;
+type index_d_QueryReferralEventResponse = QueryReferralEventResponse;
+type index_d_QueryReferralEventResponseNonNullableFields = QueryReferralEventResponseNonNullableFields;
+type index_d_QueryReferredFriendActionsOptions = QueryReferredFriendActionsOptions;
+type index_d_QueryReferredFriendActionsRequest = QueryReferredFriendActionsRequest;
+type index_d_QueryReferredFriendActionsResponse = QueryReferredFriendActionsResponse;
+type index_d_QueryReferredFriendActionsResponseNonNullableFields = QueryReferredFriendActionsResponseNonNullableFields;
+type index_d_QueryReferringCustomerTotalsOptions = QueryReferringCustomerTotalsOptions;
+type index_d_QueryReferringCustomerTotalsRequest = QueryReferringCustomerTotalsRequest;
+type index_d_QueryReferringCustomerTotalsResponse = QueryReferringCustomerTotalsResponse;
+type index_d_QueryReferringCustomerTotalsResponseNonNullableFields = QueryReferringCustomerTotalsResponseNonNullableFields;
+type index_d_ReferralEvent = ReferralEvent;
+type index_d_ReferralEventCreatedEnvelope = ReferralEventCreatedEnvelope;
+type index_d_ReferralEventEventTypeOneOf = ReferralEventEventTypeOneOf;
+type index_d_ReferralEventsQueryBuilder = ReferralEventsQueryBuilder;
+type index_d_ReferralEventsQueryResult = ReferralEventsQueryResult;
+type index_d_ReferredFriendAction = ReferredFriendAction;
+type index_d_ReferredFriendActionEvent = ReferredFriendActionEvent;
+type index_d_ReferredFriendActionRewardTypeOptionsOneOf = ReferredFriendActionRewardTypeOptionsOneOf;
+type index_d_ReferredFriendDetails = ReferredFriendDetails;
+type index_d_ReferredFriendSignupEvent = ReferredFriendSignupEvent;
+type index_d_ReferringCustomerTotal = ReferringCustomerTotal;
+type index_d_Reward = Reward;
+declare const index_d_Reward: typeof Reward;
+type index_d_RewardEvent = RewardEvent;
+type index_d_RewardEventReceiverOneOf = RewardEventReceiverOneOf;
+type index_d_SortOrder = SortOrder;
+declare const index_d_SortOrder: typeof SortOrder;
+type index_d_Sorting = Sorting;
+type index_d_Status = Status;
+declare const index_d_Status: typeof Status;
+type index_d_SuccessfulReferralEvent = SuccessfulReferralEvent;
+type index_d_Trigger = Trigger;
+type index_d_UndeleteInfo = UndeleteInfo;
+type index_d_V1ActionEvent = V1ActionEvent;
+type index_d_V1Coupon = V1Coupon;
+type index_d_V1SuccessfulReferralEvent = V1SuccessfulReferralEvent;
+type index_d_V1Trigger = V1Trigger;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+declare const index_d___metadata: typeof __metadata;
+declare const index_d_getReferralEvent: typeof getReferralEvent;
+declare const index_d_getReferralStatistics: typeof getReferralStatistics;
+declare const index_d_onReferralEventCreated: typeof onReferralEventCreated;
+declare const index_d_queryReferralEvent: typeof queryReferralEvent;
+declare const index_d_queryReferredFriendActions: typeof queryReferredFriendActions;
+declare const index_d_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_Coupon as Coupon, type index_d_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type index_d_CouponScope as CouponScope, type index_d_CouponScopeOrMinSubtotalOneOf as CouponScopeOrMinSubtotalOneOf, type index_d_CreateReferralEventRequest as CreateReferralEventRequest, type index_d_CreateReferralEventResponse as CreateReferralEventResponse, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, index_d_DiscountType as DiscountType, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_FixedAmountDiscount as FixedAmountDiscount, type index_d_GetReferralEventRequest as GetReferralEventRequest, type index_d_GetReferralEventResponse as GetReferralEventResponse, type index_d_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type index_d_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type index_d_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type index_d_GetReferralStatisticsResponseNonNullableFields as GetReferralStatisticsResponseNonNullableFields, type index_d_Group as Group, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_LoyaltyPoints as LoyaltyPoints, type index_d_MessageEnvelope as MessageEnvelope, type index_d_PercentageDiscount as PercentageDiscount, type index_d_QueryReferralEventRequest as QueryReferralEventRequest, type index_d_QueryReferralEventResponse as QueryReferralEventResponse, type index_d_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type index_d_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type index_d_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type index_d_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type index_d_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type index_d_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type index_d_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type index_d_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type index_d_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type index_d_ReferralEvent as ReferralEvent, type index_d_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type index_d_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type index_d_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type index_d_ReferralEventsQueryResult as ReferralEventsQueryResult, type index_d_ReferredFriendAction as ReferredFriendAction, type index_d_ReferredFriendActionEvent as ReferredFriendActionEvent, type index_d_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type index_d_ReferredFriendDetails as ReferredFriendDetails, type index_d_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type index_d_ReferringCustomerTotal as ReferringCustomerTotal, index_d_Reward as Reward, type index_d_RewardEvent as RewardEvent, type index_d_RewardEventReceiverOneOf as RewardEventReceiverOneOf, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_Status as Status, type index_d_SuccessfulReferralEvent as SuccessfulReferralEvent, type index_d_Trigger as Trigger, type index_d_UndeleteInfo as UndeleteInfo, type index_d_V1ActionEvent as V1ActionEvent, type index_d_V1Coupon as V1Coupon, type index_d_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type index_d_V1Trigger as V1Trigger, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_getReferralEvent as getReferralEvent, index_d_getReferralStatistics as getReferralStatistics, index_d_onReferralEventCreated as onReferralEventCreated, index_d_queryReferralEvent as queryReferralEvent, index_d_queryReferredFriendActions as queryReferredFriendActions, index_d_queryReferringCustomerTotals as queryReferringCustomerTotals };
+}
+
+export { index_d as tracker };