@wix/referral 1.0.1 → 1.0.2

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

@@ -154,7 +154,7 @@ 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;
+    cursors?: Cursors$2;
     /**
      * Whether there are more pages to retrieve following the current page.
      *
@@ -163,7 +163,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+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. */
@@ -288,14 +288,14 @@ interface V1Coupon {
      * Coupon status.
      * @readonly
      */
-    status?: Status;
+    status?: Status$1;
     /**
      * Coupon specification.
      * @readonly
      */
     couponSpecification?: Coupon;
 }
-declare enum Status {
+declare enum Status$1 {
     /** Unknown coupon status. */
     UNKNOWN = "UNKNOWN",
     /** Coupon is active and can be applied. */
@@ -375,7 +375,7 @@ interface LoyaltyPoints {
      */
     amount?: number;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+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. */
@@ -385,10 +385,10 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     /** ID of an app. */
     appId?: string;
     /** @readonly */
-    identityType?: WebhookIdentityType;
+    identityType?: WebhookIdentityType$2;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+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. */
@@ -398,7 +398,7 @@ interface IdentificationDataIdOneOf {
     /** ID of an app. */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+declare enum WebhookIdentityType$2 {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -424,7 +424,7 @@ interface QueryReferredFriendActionsResponseNonNullableFields {
         coupon?: {
             _id: string;
             code: string;
-            status: Status;
+            status: Status$1;
             couponSpecification?: {
                 fixedAmountOptions?: {
                     amount: number;
@@ -458,15 +458,15 @@ interface QueryReferredFriendActionsResponseNonNullableFields {
         totalAmountSpent: string;
     }[];
 }
-interface BaseEventMetadata {
+interface BaseEventMetadata$2 {
     /** App instance ID. */
     instanceId?: string | null;
     /** Event type. */
     eventType?: string;
     /** The identification type and identity data. */
-    identity?: IdentificationData;
+    identity?: IdentificationData$2;
 }
-interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata$2 extends BaseEventMetadata$2 {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -506,16 +506,16 @@ interface EventMetadata extends BaseEventMetadata {
 }
 interface ReferralEventCreatedEnvelope {
     entity: ReferralEvent;
-    metadata: EventMetadata;
+    metadata: EventMetadata$2;
 }
-interface QueryCursorResult {
-    cursors: Cursors;
+interface QueryCursorResult$2 {
+    cursors: Cursors$2;
     hasNext: () => boolean;
     hasPrev: () => boolean;
     length: number;
     pageSize: number;
 }
-interface ReferralEventsQueryResult extends QueryCursorResult {
+interface ReferralEventsQueryResult extends QueryCursorResult$2 {
     items: ReferralEvent[];
     query: ReferralEventsQueryBuilder;
     next: () => Promise<ReferralEventsQueryResult>;
@@ -593,42 +593,50 @@ interface QueryReferredFriendActionsOptions {
     contactIds?: 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>>;
+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<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
+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<_TResponse = any, Data = any> = {
+type RequestOptions$2<_TResponse = any, Data = any> = {
     method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
     url: string;
     data?: Data;
     params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
+} & APIMetadata$2;
+type APIMetadata$2 = {
     methodFqn?: string;
     entityFqdn?: string;
     packageName?: string;
 };
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = 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?: unknown;
+    transformations?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: 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 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 function getReferralEvent$1(httpClient: HttpClient): (referralEventId: string) => Promise<ReferralEvent & {
+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;
@@ -651,27 +659,686 @@ declare function getReferralEvent$1(httpClient: HttpClient): (referralEventId: s
         rewardType: Reward;
     } | undefined;
 }>;
-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 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 };
+}
+
+/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
+interface ReferredFriend {
+    /**
+     * ReferredFriend ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ReferredFriend Contact ID.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Customer who referred.
+     * @readonly
+     */
+    referringCustomerId?: string;
+    /** Status of the ReferredFriend. */
+    status?: Status;
+    /**
+     * 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
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this ReferredFriend was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this ReferredFriend was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+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 CreateReferredFriendResponse {
+    /** The created ReferredFriend. */
+    referredFriend?: ReferredFriend;
+}
+interface GetReferredFriendResponse {
+    /** The retrieved ReferredFriend. */
+    referredFriend?: ReferredFriend;
+}
+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 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;
+}
+/** @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;
+}
+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 {
+    /**
+     * 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 ReferredFriendCreatedEnvelope {
+    entity: ReferredFriend;
+    metadata: EventMetadata$1;
+}
+interface ReferredFriendUpdatedEnvelope {
+    entity: ReferredFriend;
+    metadata: EventMetadata$1;
+}
+interface ReferredFriendDeletedEnvelope {
+    metadata: EventMetadata$1;
+}
+interface UpdateReferredFriend {
+    /**
+     * ReferredFriend ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ReferredFriend Contact ID.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Customer who referred.
+     * @readonly
+     */
+    referringCustomerId?: string;
+    /** Status of the ReferredFriend. */
+    status?: Status;
+    /**
+     * 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
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this ReferredFriend was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this ReferredFriend was last updated.
+     * @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
+     */
+    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
+     */
+    limit: (limit: number) => ReferredFriendsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReferredFriendsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferredFriendsQueryResult>;
+}
+
+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>;
+}
+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 {
+    /**
+     * ReferringCustomer id.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Contact id.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Referral code.
+     * @readonly
+     */
+    referralCode?: string;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. */
+    revision?: string | null;
+    /**
+     * Represents the time this ReferringCustomer was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this ReferringCustomer was last updated.
+     * @readonly
+     */
+    _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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface GenerateReferringCustomerForContactResponseNonNullableFields {
+    referringCustomer?: {
+        _id: string;
+        contactId: string;
+        referralCode: string;
+    };
+}
+interface GetReferringCustomerByReferralCodeResponseNonNullableFields {
+    referringCustomer?: {
+        _id: string;
+        contactId: string;
+        referralCode: string;
+    };
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface ReferringCustomerCreatedEnvelope {
+    entity: ReferringCustomer;
+    metadata: EventMetadata;
+}
+interface ReferringCustomerDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferringCustomersQueryResult extends QueryCursorResult {
+    items: ReferringCustomer[];
+    query: ReferringCustomersQueryBuilder;
+    next: () => Promise<ReferringCustomersQueryResult>;
+    prev: () => Promise<ReferringCustomersQueryResult>;
+}
+interface ReferringCustomersQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    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: '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) => ReferringCustomersQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    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) => ReferringCustomersQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    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: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any[]) => ReferringCustomersQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'contactId' | 'referralCode' | '_createdDate' | '_updatedDate', value: any) => ReferringCustomersQueryBuilder;
+    /** @documentationMaturity preview */
+    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<'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<'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) => ReferringCustomersQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReferringCustomersQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferringCustomersQueryResult>;
+}
+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> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+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 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 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$2 as tracker };