@wix/referral 1.0.1 → 1.0.3

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

@@ -1,379 +1,1753 @@
-/** 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;
+/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
+interface ReferralProgram {
+    /** Referral program name. */
+    name?: string | null;
     /**
-     * ReferralEvent ID.
+     * Referral program status.
      * @readonly
      */
-    _id?: string | null;
+    status?: ProgramStatus;
     /** 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.
+     * Program's creation date and time.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferralEvent was last updated.
+     * Program's last update date and time
      * @readonly
      */
     _updatedDate?: Date;
+    /** Referred friend reward configuration. */
+    referredFriendReward?: Reward$1;
+    /** Referring customer reward configuration. */
+    referringCustomerReward?: Reward$1;
+    /** List of actions that complete referral. */
+    successfulReferralActions?: Action[];
+    /**
+     * Set to true if user has required plan to activate program.
+     * @readonly
+     * @deprecated Set to true if user has required plan to activate program.
+     * @replacedBy GetReferralProgramPremiumFeatures
+     * @removalDate 2024-09-01
+     */
+    isPremium?: boolean;
+    /** Emails configuration. */
+    emails?: Emails;
+}
+declare enum ProgramStatus {
+    /** unknown status. */
+    UNKNOWN = "UNKNOWN",
+    /** initial program status (program was created but was not enabled yet). */
+    DRAFT = "DRAFT",
+    /** program is active. */
+    ACTIVE = "ACTIVE",
+    /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
+    PAUSED = "PAUSED"
+}
+interface Reward$1 extends RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$1;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$1;
+    /** Type of the reward. */
+    type?: Type;
 }
 /** @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 RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$1;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$1;
 }
-interface ReferredFriendSignupEvent {
-    /** The referred friend ID. */
-    referredFriendId?: string;
+declare enum Type {
+    /** Unknown reward type. */
+    UNKNOWN = "UNKNOWN",
+    /** Coupon reward type. */
+    COUPON = "COUPON",
+    /** Loyalty points reward type. */
+    LOYALTY_POINTS = "LOYALTY_POINTS",
+    /** No reward type. */
+    NOTHING = "NOTHING"
 }
-interface V1SuccessfulReferralEvent {
-    /** The referred friend ID. */
-    referredFriendId?: string;
-    /** The referring customer ID. */
-    referringCustomerId?: string;
+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;
 }
-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;
+/** @oneof */
+interface CouponDiscountTypeOptionsOneOf$1 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$1;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$1;
 }
-interface V1Trigger {
-    /** The app id of the app that triggered the event. */
+/** @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 discount type. */
+    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 to discount. */
+    percentage?: number;
+}
+interface CouponScope$1 {
+    /** Namespace of the coupon scope. */
+    namespace?: string;
+    /** Group of the coupon scope. */
+    group?: Group$1;
+}
+interface Group$1 {
+    /** Name of the group. */
+    name?: string;
+    /** Entity ID of the group. */
+    entityId?: string | null;
+}
+interface LoyaltyPoints$1 {
+    /** Amount of points to give. */
+    amount?: number;
+}
+declare enum Action {
+    /** Unknown action. */
+    UNKNOWN = "UNKNOWN",
+    /** Store order placed. */
+    STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
+    /** Pricing plan ordered. */
+    PLAN_ORDERED = "PLAN_ORDERED",
+    /** Wix events ticket ordered. */
+    TICKET_ORDERED = "TICKET_ORDERED",
+    /** Bookings session booked. */
+    SESSION_BOOKED = "SESSION_BOOKED",
+    /** Restaurant order placed. */
+    RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
+}
+interface Emails {
+    /** Encourage customers to refer their friends email. Select for which apps to enable. */
+    encourageToReferFriends?: App[];
+    /** Notify customers about their referral reward email. Set true to enable email. */
+    notifyCustomersAboutReward?: boolean;
+}
+declare enum App {
+    /** Unknown app. */
+    UNKNOWN = "UNKNOWN",
+    /** Wix stores. */
+    STORES = "STORES",
+    /** Wix pricing plans. */
+    PRICING_PLANS = "PRICING_PLANS",
+    /** Wix events. */
+    EVENTS = "EVENTS",
+    /** Wix bookings. */
+    BOOKINGS = "BOOKINGS",
+    /** Wix restaurants. */
+    RESTAURANTS = "RESTAURANTS"
+}
+interface GetReferralProgramResponse {
+    /** The retrieved ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface Cursors$3 {
+    /** 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 UpdateReferralProgramResponse {
+    /** The updated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface ActivateReferralProgramResponse {
+    /** The activated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface PauseReferralProgramResponse {
+    /** The paused ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface GetAISocialMediaPostsSuggestionsResponse {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface AISocialMediaPostSuggestion {
+    /** The suggested post content. */
+    postContent?: string;
+    /** The suggested hashtags. */
+    hashtags?: string[];
+}
+interface GenerateAISocialMediaPostsSuggestionsResponse {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface GetReferralProgramPremiumFeaturesResponse {
+    /**
+     * Set to true if user has referral program feature.
+     * @readonly
+     */
+    referralProgram?: boolean;
+}
+interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
+    /** 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;
-    /** The activity type that triggered the event. */
-    activityType?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType$3;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$3 {
+    /** 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$3 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface GetReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface UpdateReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface ActivateReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface PauseReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GetReferralProgramPremiumFeaturesResponseNonNullableFields {
+    referralProgram: boolean;
+}
+interface BaseEventMetadata$3 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$3;
+}
+interface EventMetadata$3 extends BaseEventMetadata$3 {
+    /**
+     * 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 ProgramUpdatedEnvelope {
+    entity: ReferralProgram;
+    metadata: EventMetadata$3;
+}
+interface QueryCursorResult$3 {
+    cursors: Cursors$3;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferralProgramsQueryResult extends QueryCursorResult$3 {
+    items: ReferralProgram[];
+    query: ReferralProgramsQueryBuilder;
+    next: () => Promise<ReferralProgramsQueryResult>;
+    prev: () => Promise<ReferralProgramsQueryResult>;
+}
+interface ReferralProgramsQueryBuilder {
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ReferralProgramsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReferralProgramsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferralProgramsQueryResult>;
+}
+interface GetAiSocialMediaPostsSuggestionsOptions {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+interface GenerateAiSocialMediaPostsSuggestionsOptions {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+
+type RESTFunctionDescriptor$3<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$3) => T;
+interface HttpClient$3 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$3<TResponse, TData>): Promise<HttpResponse$3<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory$3<TResponse = any, TData = any> = (context: any) => RequestOptions$3<TResponse, TData>;
+type HttpResponse$3<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions$3<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata$3;
+type APIMetadata$3 = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction$3<T extends RESTFunctionDescriptor$3> = T extends RESTFunctionDescriptor$3<infer U> ? U : never;
+type EventDefinition$3<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition$3<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$3<Payload, Type>;
+type EventHandler$3<T extends EventDefinition$3> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition$3<T extends EventDefinition$3<any, string>> = (handler: EventHandler$3<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function getReferralProgram$1(httpClient: HttpClient$3): () => Promise<GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields>;
+declare function queryReferralPrograms$1(httpClient: HttpClient$3): () => ReferralProgramsQueryBuilder;
+declare function updateReferralProgram$1(httpClient: HttpClient$3): (referralProgram: ReferralProgram) => Promise<UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields>;
+declare function activateReferralProgram$1(httpClient: HttpClient$3): () => Promise<ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields>;
+declare function pauseReferralProgram$1(httpClient: HttpClient$3): () => Promise<PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields>;
+declare function getAiSocialMediaPostsSuggestions$1(httpClient: HttpClient$3): (options?: GetAiSocialMediaPostsSuggestionsOptions) => Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
+declare function generateAiSocialMediaPostsSuggestions$1(httpClient: HttpClient$3): (options?: GenerateAiSocialMediaPostsSuggestionsOptions) => Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
+declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient$3): () => Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
+declare const onProgramUpdated$1: EventDefinition$3<ProgramUpdatedEnvelope, "wix.loyalty.referral.v1.program_updated">;
+
+declare const getReferralProgram: BuildRESTFunction$3<typeof getReferralProgram$1>;
+declare const queryReferralPrograms: BuildRESTFunction$3<typeof queryReferralPrograms$1>;
+declare const updateReferralProgram: BuildRESTFunction$3<typeof updateReferralProgram$1>;
+declare const activateReferralProgram: BuildRESTFunction$3<typeof activateReferralProgram$1>;
+declare const pauseReferralProgram: BuildRESTFunction$3<typeof pauseReferralProgram$1>;
+declare const getAiSocialMediaPostsSuggestions: BuildRESTFunction$3<typeof getAiSocialMediaPostsSuggestions$1>;
+declare const generateAiSocialMediaPostsSuggestions: BuildRESTFunction$3<typeof generateAiSocialMediaPostsSuggestions$1>;
+declare const getReferralProgramPremiumFeatures: BuildRESTFunction$3<typeof getReferralProgramPremiumFeatures$1>;
+declare const onProgramUpdated: BuildEventDefinition$3<typeof onProgramUpdated$1>;
+
+declare const context$3_activateReferralProgram: typeof activateReferralProgram;
+declare const context$3_generateAiSocialMediaPostsSuggestions: typeof generateAiSocialMediaPostsSuggestions;
+declare const context$3_getAiSocialMediaPostsSuggestions: typeof getAiSocialMediaPostsSuggestions;
+declare const context$3_getReferralProgram: typeof getReferralProgram;
+declare const context$3_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
+declare const context$3_onProgramUpdated: typeof onProgramUpdated;
+declare const context$3_pauseReferralProgram: typeof pauseReferralProgram;
+declare const context$3_queryReferralPrograms: typeof queryReferralPrograms;
+declare const context$3_updateReferralProgram: typeof updateReferralProgram;
+declare namespace context$3 {
+  export { context$3_activateReferralProgram as activateReferralProgram, context$3_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, context$3_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, context$3_getReferralProgram as getReferralProgram, context$3_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, context$3_onProgramUpdated as onProgramUpdated, context$3_pauseReferralProgram as pauseReferralProgram, context$3_queryReferralPrograms as queryReferralPrograms, context$3_updateReferralProgram as updateReferralProgram };
+}
+
+/** 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 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 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$2;
+    /**
+     * 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$2 {
+    /** 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 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 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 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$1;
+    /**
+     * Coupon specification.
+     * @readonly
+     */
+    couponSpecification?: Coupon;
+}
+declare enum Status$1 {
+    /** Unknown coupon 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 discount type. */
+    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 to discount. */
+    percentage?: number;
+}
+interface CouponScope {
+    /** Namespace of the coupon scope. */
+    namespace?: string;
+    /** Group of the coupon scope. */
+    group?: Group;
+}
+interface Group {
+    /** Name of the group. */
+    name?: string;
+    /** Entity ID of the group. */
+    entityId?: string | null;
+}
+interface LoyaltyPoints {
+    /**
+     * Loyalty transaction ID.
+     * @readonly
+     */
+    transactionId?: string;
+    /**
+     * Loyalty points amount given.
+     * @readonly
+     */
+    amount?: number;
+}
+interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
+    /** 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$2;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$2 {
+    /** 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$2 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+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$1;
+            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$2 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$2;
+}
+interface EventMetadata$2 extends BaseEventMetadata$2 {
+    /**
+     * 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$2;
+}
+interface QueryCursorResult$2 {
+    cursors: Cursors$2;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferralEventsQueryResult extends QueryCursorResult$2 {
+    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[];
+}
+
+type RESTFunctionDescriptor$2<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$2) => T;
+interface HttpClient$2 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$2<TResponse, TData>): Promise<HttpResponse$2<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory$2<TResponse = any, TData = any> = (context: any) => RequestOptions$2<TResponse, TData>;
+type HttpResponse$2<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions$2<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata$2;
+type APIMetadata$2 = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction$2<T extends RESTFunctionDescriptor$2> = T extends RESTFunctionDescriptor$2<infer U> ? U : never;
+type EventDefinition$2<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition$2<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$2<Payload, Type>;
+type EventHandler$2<T extends EventDefinition$2> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition$2<T extends EventDefinition$2<any, string>> = (handler: EventHandler$2<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function getReferralEvent$1(httpClient: HttpClient$2): (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$1(httpClient: HttpClient$2): () => ReferralEventsQueryBuilder;
+declare function getReferralStatistics$1(httpClient: HttpClient$2): () => Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
+declare function queryReferringCustomerTotals$1(httpClient: HttpClient$2): (options?: QueryReferringCustomerTotalsOptions) => Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
+declare function queryReferredFriendActions$1(httpClient: HttpClient$2): (options?: QueryReferredFriendActionsOptions) => Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
+declare const onReferralEventCreated$1: EventDefinition$2<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
+
+declare const getReferralEvent: BuildRESTFunction$2<typeof getReferralEvent$1>;
+declare const queryReferralEvent: BuildRESTFunction$2<typeof queryReferralEvent$1>;
+declare const getReferralStatistics: BuildRESTFunction$2<typeof getReferralStatistics$1>;
+declare const queryReferringCustomerTotals: BuildRESTFunction$2<typeof queryReferringCustomerTotals$1>;
+declare const queryReferredFriendActions: BuildRESTFunction$2<typeof queryReferredFriendActions$1>;
+declare const onReferralEventCreated: BuildEventDefinition$2<typeof onReferralEventCreated$1>;
+
+declare const context$2_getReferralEvent: typeof getReferralEvent;
+declare const context$2_getReferralStatistics: typeof getReferralStatistics;
+declare const context$2_onReferralEventCreated: typeof onReferralEventCreated;
+declare const context$2_queryReferralEvent: typeof queryReferralEvent;
+declare const context$2_queryReferredFriendActions: typeof queryReferredFriendActions;
+declare const context$2_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
+declare namespace context$2 {
+  export { context$2_getReferralEvent as getReferralEvent, context$2_getReferralStatistics as getReferralStatistics, context$2_onReferralEventCreated as onReferralEventCreated, context$2_queryReferralEvent as queryReferralEvent, context$2_queryReferredFriendActions as queryReferredFriendActions, context$2_queryReferringCustomerTotals as queryReferringCustomerTotals };
 }
-interface RewardEvent extends RewardEventReceiverOneOf {
+
+/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
+interface ReferredFriend {
     /**
-     * The referring customer ID.
+     * ReferredFriend ID.
      * @readonly
      */
-    rewardedReferringCustomerId?: string;
+    _id?: string;
     /**
-     * The referred friend ID.
+     * ReferredFriend Contact ID.
      * @readonly
      */
-    rewardedReferredFriendId?: string;
-    /** The referral reward ID. */
-    referralRewardId?: string;
-    /** The reward type. */
-    rewardType?: Reward;
-}
-/** @oneof */
-interface RewardEventReceiverOneOf {
+    contactId?: string;
     /**
-     * The referring customer ID.
+     * Customer who referred.
      * @readonly
      */
-    rewardedReferringCustomerId?: string;
+    referringCustomerId?: string;
+    /** Status of the ReferredFriend. */
+    status?: Status;
     /**
-     * The referred friend ID.
+     * 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.
      * @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 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;
+    revision?: string | null;
     /**
-     * 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`
+     * Represents the time this ReferredFriend was created.
+     * @readonly
      */
-    filter?: Record<string, any> | null;
+    _createdDate?: Date;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Represents the time this ReferredFriend was last updated.
+     * @readonly
      */
-    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;
+    _updatedDate?: Date;
 }
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
+declare enum Status {
+    /** Unknown status. */
+    UNKNOWN = "UNKNOWN",
+    /** Initial status, when Referred friend joins site as member. */
+    SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
+    /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
+    ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
-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 CreateReferredFriendResponse {
+    /** The created ReferredFriend. */
+    referredFriend?: ReferredFriend;
 }
-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 GetReferredFriendResponse {
+    /** The retrieved ReferredFriend. */
+    referredFriend?: ReferredFriend;
 }
-interface Cursors {
+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 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 IdentificationData$1 extends IdentificationDataIdOneOf$1 {
+    /** 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$1;
 }
-interface QueryReferringCustomerTotalsResponse {
-    /** List of ReferringCustomerTotals that match the query. */
-    referringCustomerTotals?: ReferringCustomerTotal[];
-    /** Paging metadata. */
-    metadata?: CursorPagingMetadata;
+/** @oneof */
+interface IdentificationDataIdOneOf$1 {
+    /** 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;
 }
-interface ReferringCustomerTotal {
+declare enum WebhookIdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CreateReferredFriendResponseNonNullableFields {
+    referredFriend?: {
+        _id: string;
+        contactId: string;
+        referringCustomerId: string;
+        status: Status;
+    };
+}
+interface GetReferredFriendResponseNonNullableFields {
+    referredFriend?: {
+        _id: string;
+        contactId: string;
+        referringCustomerId: string;
+        status: Status;
+    };
+}
+interface BaseEventMetadata$1 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$1;
+}
+interface EventMetadata$1 extends BaseEventMetadata$1 {
     /**
-     * Referring customer id.
-     * @readonly
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
      */
-    referringCustomerId?: string;
+    _id?: string;
     /**
-     * Contact id.
-     * @readonly
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
      */
-    contactId?: string;
+    entityFqdn?: string;
     /**
-     * Last successful referral date.
-     * @readonly
+     * 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
      */
-    lastSuccessfulReferral?: Date;
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
     /**
-     * Total successful referrals made by this customer.
-     * @readonly
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
      */
-    totalSuccessfulReferrals?: number;
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
     /**
-     * Total amount generated by friends referred by this customer.
+     * 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 ReferredFriendCreatedEnvelope {
+    entity: ReferredFriend;
+    metadata: EventMetadata$1;
+}
+interface ReferredFriendUpdatedEnvelope {
+    entity: ReferredFriend;
+    metadata: EventMetadata$1;
+}
+interface ReferredFriendDeletedEnvelope {
+    metadata: EventMetadata$1;
+}
+interface UpdateReferredFriend {
+    /**
+     * ReferredFriend ID.
      * @readonly
      */
-    totalAmountGenerated?: string;
+    _id?: string;
     /**
-     * Last friend action date.
+     * ReferredFriend Contact ID.
      * @readonly
      */
-    lastFriendAction?: Date;
+    contactId?: string;
     /**
-     * Total friends that have actions done.
+     * Customer who referred.
      * @readonly
      */
-    totalFriendsWithActions?: number;
-}
-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;
+    referringCustomerId?: string;
+    /** Status of the ReferredFriend. */
+    status?: Status;
     /**
-     * Referred friend id.
+     * 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.
      * @readonly
      */
-    referredFriendId?: string;
+    revision?: string | null;
     /**
-     * Contact id.
+     * Represents the time this ReferredFriend was created.
      * @readonly
      */
-    contactId?: string;
+    _createdDate?: Date;
     /**
-     * First action trigger.
+     * Represents the time this ReferredFriend was last updated.
      * @readonly
      */
-    trigger?: V1Trigger;
-    /**
-     * First action date.
-     * @readonly
+    _updatedDate?: Date;
+}
+interface DeleteReferredFriendOptions {
+    /** The revision of the ReferredFriend. */
+    revision?: string;
+}
+interface QueryCursorResult$1 {
+    cursors: Cursors$1;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferredFriendsQueryResult extends QueryCursorResult$1 {
+    items: ReferredFriend[];
+    query: ReferredFriendsQueryBuilder;
+    next: () => Promise<ReferredFriendsQueryResult>;
+    prev: () => Promise<ReferredFriendsQueryResult>;
+}
+interface ReferredFriendsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'referringCustomerId', value: string) => ReferredFriendsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate', value: any[]) => ReferredFriendsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate', value: any) => ReferredFriendsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate', value: boolean) => ReferredFriendsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate'>) => ReferredFriendsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
      */
-    actionDate?: Date;
-    /** Issued reward type. */
-    rewardType?: Reward;
-    /** Total number of actions. */
-    totalActions?: number;
-    /**
-     * Total amount spent by this referred friend.
-     * @readonly
+    descending: (...propertyNames: Array<'referringCustomerId' | 'status' | '_createdDate' | '_updatedDate'>) => ReferredFriendsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
      */
-    totalAmountSpent?: string;
-    /**
-     * friend signup date.
-     * @readonly
+    limit: (limit: number) => ReferredFriendsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
      */
-    signupDate?: Date;
+    skipTo: (cursor: string) => ReferredFriendsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferredFriendsQueryResult>;
 }
-/** @oneof */
-interface ReferredFriendActionRewardTypeOptionsOneOf {
-    /** Coupon reward type options. */
-    coupon?: V1Coupon;
-    /** Loyalty points reward type options. */
-    loyaltyPoints?: LoyaltyPoints;
+
+type RESTFunctionDescriptor$1<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$1) => T;
+interface HttpClient$1 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
 }
-interface V1Coupon {
+type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
+type HttpResponse$1<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions$1<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata$1;
+type APIMetadata$1 = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction$1<T extends RESTFunctionDescriptor$1> = T extends RESTFunctionDescriptor$1<infer U> ? U : never;
+type EventDefinition$1<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
+type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createReferredFriend$1(httpClient: HttpClient$1): () => Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
+declare function getReferredFriend$1(httpClient: HttpClient$1): (referredFriendId: string) => Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
+declare function getReferredFriendByContactId$1(httpClient: HttpClient$1): (contactId: string) => Promise<ReferredFriend & {
+    _id: string;
+    contactId: string;
+    referringCustomerId: string;
+    status: Status;
+}>;
+declare function updateReferredFriend$1(httpClient: HttpClient$1): (_id: string, referredFriend: UpdateReferredFriend) => Promise<ReferredFriend & {
+    _id: string;
+    contactId: string;
+    referringCustomerId: string;
+    status: Status;
+}>;
+declare function deleteReferredFriend$1(httpClient: HttpClient$1): (referredFriendId: string, options?: DeleteReferredFriendOptions) => Promise<void>;
+declare function queryReferredFriend$1(httpClient: HttpClient$1): () => ReferredFriendsQueryBuilder;
+declare const onReferredFriendCreated$1: EventDefinition$1<ReferredFriendCreatedEnvelope, "wix.loyalty.referral.v1.referred_friend_created">;
+declare const onReferredFriendUpdated$1: EventDefinition$1<ReferredFriendUpdatedEnvelope, "wix.loyalty.referral.v1.referred_friend_updated">;
+declare const onReferredFriendDeleted$1: EventDefinition$1<ReferredFriendDeletedEnvelope, "wix.loyalty.referral.v1.referred_friend_deleted">;
+
+declare const createReferredFriend: BuildRESTFunction$1<typeof createReferredFriend$1>;
+declare const getReferredFriend: BuildRESTFunction$1<typeof getReferredFriend$1>;
+declare const getReferredFriendByContactId: BuildRESTFunction$1<typeof getReferredFriendByContactId$1>;
+declare const updateReferredFriend: BuildRESTFunction$1<typeof updateReferredFriend$1>;
+declare const deleteReferredFriend: BuildRESTFunction$1<typeof deleteReferredFriend$1>;
+declare const queryReferredFriend: BuildRESTFunction$1<typeof queryReferredFriend$1>;
+declare const onReferredFriendCreated: BuildEventDefinition$1<typeof onReferredFriendCreated$1>;
+declare const onReferredFriendUpdated: BuildEventDefinition$1<typeof onReferredFriendUpdated$1>;
+declare const onReferredFriendDeleted: BuildEventDefinition$1<typeof onReferredFriendDeleted$1>;
+
+declare const context$1_createReferredFriend: typeof createReferredFriend;
+declare const context$1_deleteReferredFriend: typeof deleteReferredFriend;
+declare const context$1_getReferredFriend: typeof getReferredFriend;
+declare const context$1_getReferredFriendByContactId: typeof getReferredFriendByContactId;
+declare const context$1_onReferredFriendCreated: typeof onReferredFriendCreated;
+declare const context$1_onReferredFriendDeleted: typeof onReferredFriendDeleted;
+declare const context$1_onReferredFriendUpdated: typeof onReferredFriendUpdated;
+declare const context$1_queryReferredFriend: typeof queryReferredFriend;
+declare const context$1_updateReferredFriend: typeof updateReferredFriend;
+declare namespace context$1 {
+  export { context$1_createReferredFriend as createReferredFriend, context$1_deleteReferredFriend as deleteReferredFriend, context$1_getReferredFriend as getReferredFriend, context$1_getReferredFriendByContactId as getReferredFriendByContactId, context$1_onReferredFriendCreated as onReferredFriendCreated, context$1_onReferredFriendDeleted as onReferredFriendDeleted, context$1_onReferredFriendUpdated as onReferredFriendUpdated, context$1_queryReferredFriend as queryReferredFriend, context$1_updateReferredFriend as updateReferredFriend };
+}
+
+/** ReferringCustomer is the main entity of ReferringCustomers. */
+interface ReferringCustomer {
     /**
-     * Coupon ID.
+     * ReferringCustomer id.
      * @readonly
      */
     _id?: string;
     /**
-     * Coupon code.
-     * @readonly
-     */
-    code?: string;
-    /**
-     * Coupon status.
+     * Contact id.
      * @readonly
      */
-    status?: Status;
+    contactId?: string;
     /**
-     * Coupon specification.
+     * Referral code.
      * @readonly
      */
-    couponSpecification?: Coupon;
-}
-declare enum Status {
-    /** Unknown coupon 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 {
+    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?: string | null;
     /**
-     * Loyalty transaction ID.
+     * Represents the time this ReferringCustomer was created.
      * @readonly
      */
-    transactionId?: string;
+    _createdDate?: Date;
     /**
-     * Loyalty points amount given.
+     * Represents the time this ReferringCustomer was last updated.
      * @readonly
      */
-    amount?: number;
+    _updatedDate?: Date;
+}
+interface GenerateReferringCustomerForContactResponse {
+    /** The created ReferringCustomer. */
+    referringCustomer?: ReferringCustomer;
+}
+interface GetReferringCustomerByReferralCodeResponse {
+    /** The retrieved ReferringCustomer. */
+    referringCustomer?: ReferringCustomer;
+}
+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 IdentificationData extends IdentificationDataIdOneOf {
     /** ID of a site visitor that has not logged in to the site. */
@@ -405,58 +1779,19 @@ declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface GetReferralStatisticsResponseNonNullableFields {
-    totalSignUpsCompleted: number;
-    totalActionsCompleted: number;
-    totalAmountGenerated: string;
-}
-interface QueryReferringCustomerTotalsResponseNonNullableFields {
-    referringCustomerTotals: {
-        referringCustomerId: string;
+interface GenerateReferringCustomerForContactResponseNonNullableFields {
+    referringCustomer?: {
+        _id: string;
         contactId: string;
-        totalSuccessfulReferrals: number;
-        totalAmountGenerated: string;
-        totalFriendsWithActions: number;
-    }[];
+        referralCode: string;
+    };
 }
-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;
+interface GetReferringCustomerByReferralCodeResponseNonNullableFields {
+    referringCustomer?: {
+        _id: string;
         contactId: string;
-        trigger?: {
-            appId: string;
-            activityType: string;
-        };
-        rewardType: Reward;
-        totalActions: number;
-        totalAmountSpent: string;
-    }[];
+        referralCode: string;
+    };
 }
 interface BaseEventMetadata {
     /** App instance ID. */
@@ -504,8 +1839,11 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface ReferralEventCreatedEnvelope {
-    entity: ReferralEvent;
+interface ReferringCustomerCreatedEnvelope {
+    entity: ReferringCustomer;
+    metadata: EventMetadata;
+}
+interface ReferringCustomerDeletedEnvelope {
     metadata: EventMetadata;
 }
 interface QueryCursorResult {
@@ -515,87 +1853,85 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface ReferralEventsQueryResult extends QueryCursorResult {
-    items: ReferralEvent[];
-    query: ReferralEventsQueryBuilder;
-    next: () => Promise<ReferralEventsQueryResult>;
-    prev: () => Promise<ReferralEventsQueryResult>;
+interface ReferringCustomersQueryResult extends QueryCursorResult {
+    items: ReferringCustomer[];
+    query: ReferringCustomersQueryBuilder;
+    next: () => Promise<ReferringCustomersQueryResult>;
+    prev: () => Promise<ReferringCustomersQueryResult>;
 }
-interface ReferralEventsQueryBuilder {
+interface ReferringCustomersQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    eq: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    eq: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    ne: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    ne: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'contactId' | 'referralCode', value: string) => ReferringCustomersQueryBuilder;
     /** @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;
+    hasSome: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any[]) => ReferringCustomersQueryBuilder;
     /** @documentationMaturity preview */
-    in: (propertyName: '_createdDate' | '_updatedDate', value: any) => ReferralEventsQueryBuilder;
+    in: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
     /** @documentationMaturity preview */
-    exists: (propertyName: '_createdDate' | '_updatedDate', value: boolean) => ReferralEventsQueryBuilder;
+    exists: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: boolean) => ReferringCustomersQueryBuilder;
     /** @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;
+    ascending: (...propertyNames: Array<'contactId' | 'referralCode' | '_createdDate' | '_updatedDate'>) => ReferringCustomersQueryBuilder;
     /** @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;
+    descending: (...propertyNames: Array<'contactId' | 'referralCode' | '_createdDate' | '_updatedDate'>) => ReferringCustomersQueryBuilder;
     /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
      * @documentationMaturity preview
      */
-    limit: (limit: number) => ReferralEventsQueryBuilder;
+    limit: (limit: number) => ReferringCustomersQueryBuilder;
     /** @param cursor - A pointer to specific record
      * @documentationMaturity preview
      */
-    skipTo: (cursor: string) => ReferralEventsQueryBuilder;
+    skipTo: (cursor: string) => ReferringCustomersQueryBuilder;
     /** @documentationMaturity preview */
-    find: () => Promise<ReferralEventsQueryResult>;
-}
-interface QueryReferringCustomerTotalsOptions {
-    /** Query to filter ReferringCustomerTotals. */
-    query?: CursorQuery;
-    /** List of contact ids to filter ReferringCustomerTotals. */
-    contactIds?: string[];
+    find: () => Promise<ReferringCustomersQueryResult>;
 }
-interface QueryReferredFriendActionsOptions {
-    /** Query to filter ReferredFriendActions. */
-    query?: CursorQuery;
-    /** List of contact ids to filter ReferredFriendActions. */
-    contactIds?: string[];
+interface DeleteReferringCustomerOptions {
+    /** The revision of the ReferringCustomer. */
+    revision?: string;
 }
 
 type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -621,57 +1957,49 @@ type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
-    transformations?: unknown;
+    transformations?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
 type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
 type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
 
-declare function getReferralEvent$1(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 global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function generateReferringCustomerForContact$1(httpClient: HttpClient): (contactId: string) => Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
+declare function getReferringCustomer$1(httpClient: HttpClient): (referringCustomerId: string) => Promise<ReferringCustomer & {
+    _id: string;
+    contactId: string;
+    referralCode: string;
 }>;
-declare function queryReferralEvent$1(httpClient: HttpClient): () => ReferralEventsQueryBuilder;
-declare function getReferralStatistics$1(httpClient: HttpClient): () => Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
-declare function queryReferringCustomerTotals$1(httpClient: HttpClient): (options?: QueryReferringCustomerTotalsOptions) => Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
-declare function queryReferredFriendActions$1(httpClient: HttpClient): (options?: QueryReferredFriendActionsOptions) => Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
-declare const onReferralEventCreated$1: EventDefinition<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
+declare function getReferringCustomerByReferralCode$1(httpClient: HttpClient): (referralCode: string) => Promise<GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields>;
+declare function queryReferringCustomers$1(httpClient: HttpClient): () => ReferringCustomersQueryBuilder;
+declare function deleteReferringCustomer$1(httpClient: HttpClient): (referringCustomerId: string, options?: DeleteReferringCustomerOptions) => Promise<void>;
+declare const onReferringCustomerCreated$1: EventDefinition<ReferringCustomerCreatedEnvelope, "wix.loyalty.referral.v1.referring_customer_created">;
+declare const onReferringCustomerDeleted$1: EventDefinition<ReferringCustomerDeletedEnvelope, "wix.loyalty.referral.v1.referring_customer_deleted">;
 
-declare const getReferralEvent: BuildRESTFunction<typeof getReferralEvent$1>;
-declare const queryReferralEvent: BuildRESTFunction<typeof queryReferralEvent$1>;
-declare const getReferralStatistics: BuildRESTFunction<typeof getReferralStatistics$1>;
-declare const queryReferringCustomerTotals: BuildRESTFunction<typeof queryReferringCustomerTotals$1>;
-declare const queryReferredFriendActions: BuildRESTFunction<typeof queryReferredFriendActions$1>;
-declare const onReferralEventCreated: BuildEventDefinition<typeof onReferralEventCreated$1>;
+declare const generateReferringCustomerForContact: BuildRESTFunction<typeof generateReferringCustomerForContact$1>;
+declare const getReferringCustomer: BuildRESTFunction<typeof getReferringCustomer$1>;
+declare const getReferringCustomerByReferralCode: BuildRESTFunction<typeof getReferringCustomerByReferralCode$1>;
+declare const queryReferringCustomers: BuildRESTFunction<typeof queryReferringCustomers$1>;
+declare const deleteReferringCustomer: BuildRESTFunction<typeof deleteReferringCustomer$1>;
+declare const onReferringCustomerCreated: BuildEventDefinition<typeof onReferringCustomerCreated$1>;
+declare const onReferringCustomerDeleted: BuildEventDefinition<typeof onReferringCustomerDeleted$1>;
 
-declare const context_getReferralEvent: typeof getReferralEvent;
-declare const context_getReferralStatistics: typeof getReferralStatistics;
-declare const context_onReferralEventCreated: typeof onReferralEventCreated;
-declare const context_queryReferralEvent: typeof queryReferralEvent;
-declare const context_queryReferredFriendActions: typeof queryReferredFriendActions;
-declare const context_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
+declare const context_deleteReferringCustomer: typeof deleteReferringCustomer;
+declare const context_generateReferringCustomerForContact: typeof generateReferringCustomerForContact;
+declare const context_getReferringCustomer: typeof getReferringCustomer;
+declare const context_getReferringCustomerByReferralCode: typeof getReferringCustomerByReferralCode;
+declare const context_onReferringCustomerCreated: typeof onReferringCustomerCreated;
+declare const context_onReferringCustomerDeleted: typeof onReferringCustomerDeleted;
+declare const context_queryReferringCustomers: typeof queryReferringCustomers;
 declare namespace context {
-  export { context_getReferralEvent as getReferralEvent, context_getReferralStatistics as getReferralStatistics, context_onReferralEventCreated as onReferralEventCreated, context_queryReferralEvent as queryReferralEvent, context_queryReferredFriendActions as queryReferredFriendActions, context_queryReferringCustomerTotals as queryReferringCustomerTotals };
+  export { context_deleteReferringCustomer as deleteReferringCustomer, context_generateReferringCustomerForContact as generateReferringCustomerForContact, context_getReferringCustomer as getReferringCustomer, context_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, context_onReferringCustomerCreated as onReferringCustomerCreated, context_onReferringCustomerDeleted as onReferringCustomerDeleted, context_queryReferringCustomers as queryReferringCustomers };
 }
 
-export { context as tracker };
+export { context as customers, context$1 as friends, context$3 as programs, context$2 as tracker };