@wix/referral 1.0.5 → 1.0.6

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

@@ -1,3 +1,1254 @@
+/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
+interface ReferralProgram$1 {
+    /** Referral program name. */
+    name?: string | null;
+    /**
+     * Referral program status.
+     * @readonly
+     */
+    status?: ProgramStatus$1;
+    /** 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;
+    /**
+     * Program's creation date and time.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Program's last update date and time
+     * @readonly
+     */
+    updatedDate?: Date;
+    /** Referred friend reward configuration. */
+    referredFriendReward?: Reward$3;
+    /** Referring customer reward configuration. */
+    referringCustomerReward?: Reward$3;
+    /** List of actions that complete referral. */
+    successfulReferralActions?: Action$1[];
+    /**
+     * 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$1;
+}
+declare enum ProgramStatus$1 {
+    /** 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$3 extends RewardOptionsOneOf$1 {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$5;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$3;
+    /** Type of the reward. */
+    type?: Type$1;
+}
+/** @oneof */
+interface RewardOptionsOneOf$1 {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$5;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$3;
+}
+declare enum Type$1 {
+    /** Unknown reward type. */
+    UNKNOWN = "UNKNOWN",
+    /** Coupon reward type. */
+    COUPON = "COUPON",
+    /** Loyalty points reward type. */
+    LOYALTY_POINTS = "LOYALTY_POINTS",
+    /** No reward type. */
+    NOTHING = "NOTHING"
+}
+interface Coupon$5 extends CouponDiscountTypeOptionsOneOf$5, CouponScopeOrMinSubtotalOneOf$5 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$5;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$5;
+    /** 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$5;
+    /** Coupon name. */
+    name?: string;
+    /** Coupon discount type. */
+    discountType?: DiscountType$5;
+    /** 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$5 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$5;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$5;
+}
+/** @oneof */
+interface CouponScopeOrMinSubtotalOneOf$5 {
+    /** 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$5;
+}
+declare enum DiscountType$5 {
+    /** 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$5 {
+    /** Fixed amount to discount. */
+    amount?: number;
+}
+interface PercentageDiscount$5 {
+    /** Percentage to discount. */
+    percentage?: number;
+}
+interface CouponScope$5 {
+    /** Namespace of the coupon scope. */
+    namespace?: string;
+    /** Group of the coupon scope. */
+    group?: Group$5;
+}
+interface Group$5 {
+    /** Name of the group. */
+    name?: string;
+    /** Entity ID of the group. */
+    entityId?: string | null;
+}
+interface LoyaltyPoints$3 {
+    /** Amount of points to give. */
+    amount?: number;
+}
+declare enum Action$1 {
+    /** 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$1 {
+    /** Encourage customers to refer their friends email. Select for which apps to enable. */
+    encourageToReferFriends?: App$1[];
+    /** Notify customers about their referral reward email. Set true to enable email. */
+    notifyCustomersAboutReward?: boolean;
+}
+declare enum App$1 {
+    /** 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 GetReferralProgramRequest$1 {
+}
+interface GetReferralProgramResponse$1 {
+    /** The retrieved ReferralProgram. */
+    referralProgram?: ReferralProgram$1;
+}
+interface QueryReferralProgramsRequest$1 {
+    /** Query to filter ReferralPrograms. */
+    query: CursorQuery$9;
+}
+interface CursorQuery$9 extends CursorQueryPagingMethodOneOf$9 {
+    /** 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$9;
+    /**
+     * 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$9[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf$9 {
+    /** 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$9;
+}
+interface Sorting$9 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$9;
+}
+declare enum SortOrder$9 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging$9 {
+    /** 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 QueryReferralProgramsResponse$1 {
+    /** ReferralPrograms that match the query. */
+    referralPrograms?: ReferralProgram$1[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata$9;
+}
+interface CursorPagingMetadata$9 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors$9;
+    /**
+     * 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$9 {
+    /** 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 UpdateReferralProgramRequest$1 {
+    /** ReferralProgram to be updated, may be partial. */
+    referralProgram: ReferralProgram$1;
+}
+interface UpdateReferralProgramResponse$1 {
+    /** The updated ReferralProgram. */
+    referralProgram?: ReferralProgram$1;
+}
+interface ActivateReferralProgramRequest$1 {
+}
+interface ActivateReferralProgramResponse$1 {
+    /** The activated ReferralProgram. */
+    referralProgram?: ReferralProgram$1;
+}
+interface PauseReferralProgramRequest$1 {
+}
+interface PauseReferralProgramResponse$1 {
+    /** The paused ReferralProgram. */
+    referralProgram?: ReferralProgram$1;
+}
+interface GetAISocialMediaPostsSuggestionsRequest$1 {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+interface GetAISocialMediaPostsSuggestionsResponse$1 {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion$1[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface AISocialMediaPostSuggestion$1 {
+    /** The suggested post content. */
+    postContent?: string;
+    /** The suggested hashtags. */
+    hashtags?: string[];
+}
+interface GenerateAISocialMediaPostsSuggestionsRequest$1 {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+interface GenerateAISocialMediaPostsSuggestionsResponse$1 {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion$1[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface GetReferralProgramPremiumFeaturesRequest$1 {
+}
+interface GetReferralProgramPremiumFeaturesResponse$1 {
+    /**
+     * Set to true if user has referral program feature.
+     * @readonly
+     */
+    referralProgram?: boolean;
+}
+interface GetReferralProgramResponseNonNullableFields$1 {
+    referralProgram?: {
+        status: ProgramStatus$1;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        successfulReferralActions: Action$1[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App$1[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface QueryReferralProgramsResponseNonNullableFields$1 {
+    referralPrograms: {
+        status: ProgramStatus$1;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        successfulReferralActions: Action$1[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App$1[];
+            notifyCustomersAboutReward: boolean;
+        };
+    }[];
+}
+interface UpdateReferralProgramResponseNonNullableFields$1 {
+    referralProgram?: {
+        status: ProgramStatus$1;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        successfulReferralActions: Action$1[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App$1[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface ActivateReferralProgramResponseNonNullableFields$1 {
+    referralProgram?: {
+        status: ProgramStatus$1;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        successfulReferralActions: Action$1[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App$1[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface PauseReferralProgramResponseNonNullableFields$1 {
+    referralProgram?: {
+        status: ProgramStatus$1;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$5;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type$1;
+        };
+        successfulReferralActions: Action$1[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App$1[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields$1 {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields$1 {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GetReferralProgramPremiumFeaturesResponseNonNullableFields$1 {
+    referralProgram: boolean;
+}
+
+/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
+interface ReferralProgram {
+    /** Referral program name. */
+    name?: string | null;
+    /**
+     * Referral program status.
+     * @readonly
+     */
+    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;
+    /**
+     * Program's creation date and time.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Program's last update date and time
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Referred friend reward configuration. */
+    referredFriendReward?: Reward$2;
+    /** Referring customer reward configuration. */
+    referringCustomerReward?: Reward$2;
+    /** 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$2 extends RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$4;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$2;
+    /** Type of the reward. */
+    type?: Type;
+}
+/** @oneof */
+interface RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$4;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$2;
+}
+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 Coupon$4 extends CouponDiscountTypeOptionsOneOf$4, CouponScopeOrMinSubtotalOneOf$4 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$4;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$4;
+    /** 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$4;
+    /** Coupon name. */
+    name?: string;
+    /** Coupon discount type. */
+    discountType?: DiscountType$4;
+    /** 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$4 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$4;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$4;
+}
+/** @oneof */
+interface CouponScopeOrMinSubtotalOneOf$4 {
+    /** 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$4;
+}
+declare enum DiscountType$4 {
+    /** 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$4 {
+    /** Fixed amount to discount. */
+    amount?: number;
+}
+interface PercentageDiscount$4 {
+    /** Percentage to discount. */
+    percentage?: number;
+}
+interface CouponScope$4 {
+    /** Namespace of the coupon scope. */
+    namespace?: string;
+    /** Group of the coupon scope. */
+    group?: Group$4;
+}
+interface Group$4 {
+    /** Name of the group. */
+    name?: string;
+    /** Entity ID of the group. */
+    entityId?: string | null;
+}
+interface LoyaltyPoints$2 {
+    /** 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 GetReferralProgramRequest {
+}
+interface GetReferralProgramResponse {
+    /** The retrieved ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface QueryReferralProgramsRequest {
+    /** Query to filter ReferralPrograms. */
+    query: CursorQuery$8;
+}
+interface CursorQuery$8 extends CursorQueryPagingMethodOneOf$8 {
+    /** 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$8;
+    /**
+     * 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$8[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf$8 {
+    /** 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$8;
+}
+interface Sorting$8 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$8;
+}
+declare enum SortOrder$8 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CursorPaging$8 {
+    /** 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 QueryReferralProgramsResponse {
+    /** ReferralPrograms that match the query. */
+    referralPrograms?: ReferralProgram[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata$8;
+}
+interface CursorPagingMetadata$8 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors$8;
+    /**
+     * 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$8 {
+    /** 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 UpdateReferralProgramRequest {
+    /** ReferralProgram to be updated, may be partial. */
+    referralProgram: ReferralProgram;
+}
+interface UpdateReferralProgramResponse {
+    /** The updated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface ActivateReferralProgramRequest {
+}
+interface ActivateReferralProgramResponse {
+    /** The activated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface PauseReferralProgramRequest {
+}
+interface PauseReferralProgramResponse {
+    /** The paused ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface GetAISocialMediaPostsSuggestionsRequest {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+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 GenerateAISocialMediaPostsSuggestionsRequest {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+interface GenerateAISocialMediaPostsSuggestionsResponse {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface GetReferralProgramPremiumFeaturesRequest {
+}
+interface GetReferralProgramPremiumFeaturesResponse {
+    /**
+     * Set to true if user has referral program feature.
+     * @readonly
+     */
+    referralProgram?: boolean;
+}
+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$4;
+            };
+            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$4;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface QueryReferralProgramsResponseNonNullableFields {
+    referralPrograms: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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$4;
+            };
+            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;
+}
+
+type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getReferralProgram(): __PublicMethodMetaInfo$4<'GET', {}, GetReferralProgramRequest, GetReferralProgramRequest$1, GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields, GetReferralProgramResponse$1 & GetReferralProgramResponseNonNullableFields$1>;
+declare function queryReferralPrograms(): __PublicMethodMetaInfo$4<'POST', {}, QueryReferralProgramsRequest, QueryReferralProgramsRequest$1, QueryReferralProgramsResponse & QueryReferralProgramsResponseNonNullableFields, QueryReferralProgramsResponse$1 & QueryReferralProgramsResponseNonNullableFields$1>;
+declare function updateReferralProgram(): __PublicMethodMetaInfo$4<'PATCH', {}, UpdateReferralProgramRequest, UpdateReferralProgramRequest$1, UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields, UpdateReferralProgramResponse$1 & UpdateReferralProgramResponseNonNullableFields$1>;
+declare function activateReferralProgram(): __PublicMethodMetaInfo$4<'PATCH', {}, ActivateReferralProgramRequest, ActivateReferralProgramRequest$1, ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields, ActivateReferralProgramResponse$1 & ActivateReferralProgramResponseNonNullableFields$1>;
+declare function pauseReferralProgram(): __PublicMethodMetaInfo$4<'PATCH', {}, PauseReferralProgramRequest, PauseReferralProgramRequest$1, PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields, PauseReferralProgramResponse$1 & PauseReferralProgramResponseNonNullableFields$1>;
+declare function getAiSocialMediaPostsSuggestions(): __PublicMethodMetaInfo$4<'GET', {}, GetAISocialMediaPostsSuggestionsRequest, GetAISocialMediaPostsSuggestionsRequest$1, GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields, GetAISocialMediaPostsSuggestionsResponse$1 & GetAISocialMediaPostsSuggestionsResponseNonNullableFields$1>;
+declare function generateAiSocialMediaPostsSuggestions(): __PublicMethodMetaInfo$4<'POST', {}, GenerateAISocialMediaPostsSuggestionsRequest, GenerateAISocialMediaPostsSuggestionsRequest$1, GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, GenerateAISocialMediaPostsSuggestionsResponse$1 & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields$1>;
+declare function getReferralProgramPremiumFeatures(): __PublicMethodMetaInfo$4<'GET', {}, GetReferralProgramPremiumFeaturesRequest, GetReferralProgramPremiumFeaturesRequest$1, GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields, GetReferralProgramPremiumFeaturesResponse$1 & GetReferralProgramPremiumFeaturesResponseNonNullableFields$1>;
+
+declare const meta$4_activateReferralProgram: typeof activateReferralProgram;
+declare const meta$4_generateAiSocialMediaPostsSuggestions: typeof generateAiSocialMediaPostsSuggestions;
+declare const meta$4_getAiSocialMediaPostsSuggestions: typeof getAiSocialMediaPostsSuggestions;
+declare const meta$4_getReferralProgram: typeof getReferralProgram;
+declare const meta$4_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
+declare const meta$4_pauseReferralProgram: typeof pauseReferralProgram;
+declare const meta$4_queryReferralPrograms: typeof queryReferralPrograms;
+declare const meta$4_updateReferralProgram: typeof updateReferralProgram;
+declare namespace meta$4 {
+  export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_activateReferralProgram as activateReferralProgram, meta$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, meta$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, meta$4_getReferralProgram as getReferralProgram, meta$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, meta$4_pauseReferralProgram as pauseReferralProgram, meta$4_queryReferralPrograms as queryReferralPrograms, meta$4_updateReferralProgram as updateReferralProgram };
+}
+
 /** ReferralEvent. */
 interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
     /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
@@ -338,17 +1589,17 @@ declare enum Status$5 {
     DELETED = "DELETED"
 }
 interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount$3;
     /** 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$3;
-    /** Coupon name */
+    /** Coupon name. */
     name?: string;
-    /** Coupon discount type */
+    /** Coupon discount type. */
     discountType?: DiscountType$3;
     /** Limit the coupon to only apply to one item in cart. */
     limitedToOneItem?: boolean | null;
@@ -359,9 +1610,9 @@ interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSub
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$3 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount$3;
 }
 /** @oneof */
@@ -372,27 +1623,33 @@ interface CouponScopeOrMinSubtotalOneOf$3 {
     scope?: CouponScope$3;
 }
 declare enum DiscountType$3 {
+    /** Unknown discount type. */
     UNKNOWN = "UNKNOWN",
-    /** Discount as a fixed amount */
+    /** Discount as a fixed amount. */
     FIXED_AMOUNT = "FIXED_AMOUNT",
-    /** Discount as a percentage */
+    /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping */
+    /** Free shipping. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$3 {
-    /** Fixed amount to discount */
+    /** Fixed amount to discount. */
     amount?: number;
 }
 interface PercentageDiscount$3 {
+    /** Percentage to discount. */
     percentage?: number;
 }
 interface CouponScope$3 {
+    /** Namespace of the coupon scope. */
     namespace?: string;
+    /** Group of the coupon scope. */
     group?: Group$3;
 }
 interface Group$3 {
+    /** Name of the group. */
     name?: string;
+    /** Entity ID of the group. */
     entityId?: string | null;
 }
 interface LoyaltyPoints$1 {
@@ -851,17 +2108,17 @@ declare enum Status$4 {
     DELETED = "DELETED"
 }
 interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount$2;
     /** 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$2;
-    /** Coupon name */
+    /** Coupon name. */
     name?: string;
-    /** Coupon discount type */
+    /** Coupon discount type. */
     discountType?: DiscountType$2;
     /** Limit the coupon to only apply to one item in cart. */
     limitedToOneItem?: boolean | null;
@@ -872,9 +2129,9 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$2 {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount$2;
 }
 /** @oneof */
@@ -885,27 +2142,33 @@ interface CouponScopeOrMinSubtotalOneOf$2 {
     scope?: CouponScope$2;
 }
 declare enum DiscountType$2 {
+    /** Unknown discount type. */
     UNKNOWN = "UNKNOWN",
-    /** Discount as a fixed amount */
+    /** Discount as a fixed amount. */
     FIXED_AMOUNT = "FIXED_AMOUNT",
-    /** Discount as a percentage */
+    /** Discount as a percentage. */
     PERCENTAGE = "PERCENTAGE",
-    /** Free shipping */
+    /** Free shipping. */
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$2 {
-    /** Fixed amount to discount */
+    /** Fixed amount to discount. */
     amount?: number;
 }
 interface PercentageDiscount$2 {
+    /** Percentage to discount. */
     percentage?: number;
 }
 interface CouponScope$2 {
+    /** Namespace of the coupon scope. */
     namespace?: string;
+    /** Group of the coupon scope. */
     group?: Group$2;
 }
 interface Group$2 {
+    /** Name of the group. */
     name?: string;
+    /** Entity ID of the group. */
     entityId?: string | null;
 }
 interface LoyaltyPoints {
@@ -2493,4 +3756,4 @@ declare namespace meta {
   export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_deleteReferringCustomer as deleteReferringCustomer, meta_generateReferringCustomerForContact as generateReferringCustomerForContact, meta_getReferringCustomer as getReferringCustomer, meta_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, meta_queryReferringCustomers as queryReferringCustomers };
 }
 
-export { meta as customers, meta$1 as friends, meta$2 as rewards, meta$3 as tracker };
+export { meta as customers, meta$1 as friends, meta$4 as programs, meta$2 as rewards, meta$3 as tracker };