@wix/referral 1.0.2 → 1.0.3

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

@@ -1,3 +1,658 @@
+/** 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$1;
+    /** Referring customer reward configuration. */
+    referringCustomerReward?: Reward$1;
+    /** List of actions that complete referral. */
+    successfulReferralActions?: Action[];
+    /**
+     * Set to true if user has required plan to activate program.
+     * @readonly
+     * @deprecated Set to true if user has required plan to activate program.
+     * @replacedBy GetReferralProgramPremiumFeatures
+     * @removalDate 2024-09-01
+     */
+    isPremium?: boolean;
+    /** Emails configuration. */
+    emails?: Emails;
+}
+declare enum ProgramStatus {
+    /** unknown status. */
+    UNKNOWN = "UNKNOWN",
+    /** initial program status (program was created but was not enabled yet). */
+    DRAFT = "DRAFT",
+    /** program is active. */
+    ACTIVE = "ACTIVE",
+    /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
+    PAUSED = "PAUSED"
+}
+interface Reward$1 extends RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$1;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$1;
+    /** Type of the reward. */
+    type?: Type;
+}
+/** @oneof */
+interface RewardOptionsOneOf {
+    /** Options for coupon reward type. */
+    couponOptions?: Coupon$1;
+    /** Options for Loyalty points reward type. */
+    loyaltyPointsOptions?: LoyaltyPoints$1;
+}
+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$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$1;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$1;
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope$1;
+    /** Coupon name. */
+    name?: string;
+    /** Coupon discount type. */
+    discountType?: DiscountType$1;
+    /** Limit the coupon to only apply to one item in cart. */
+    limitedToOneItem?: boolean | null;
+    /** If true, coupon also applies to subscriptions. */
+    appliesToSubscriptions?: boolean | null;
+    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    discountedCycleCount?: number | null;
+}
+/** @oneof */
+interface CouponDiscountTypeOptionsOneOf$1 {
+    /** Options for fixed amount discount type. */
+    fixedAmountOptions?: FixedAmountDiscount$1;
+    /** Options for percentage discount type. */
+    percentageOptions?: PercentageDiscount$1;
+}
+/** @oneof */
+interface CouponScopeOrMinSubtotalOneOf$1 {
+    /** Limit the coupon to carts with a subtotal above this number. */
+    minimumSubtotal?: number;
+    /** Specifies the type of line items this coupon will apply to. */
+    scope?: CouponScope$1;
+}
+declare enum DiscountType$1 {
+    /** Unknown discount type. */
+    UNKNOWN = "UNKNOWN",
+    /** Discount as a fixed amount. */
+    FIXED_AMOUNT = "FIXED_AMOUNT",
+    /** Discount as a percentage. */
+    PERCENTAGE = "PERCENTAGE",
+    /** Free shipping. */
+    FREE_SHIPPING = "FREE_SHIPPING"
+}
+interface FixedAmountDiscount$1 {
+    /** Fixed amount to discount. */
+    amount?: number;
+}
+interface PercentageDiscount$1 {
+    /** Percentage to discount. */
+    percentage?: number;
+}
+interface CouponScope$1 {
+    /** Namespace of the coupon scope. */
+    namespace?: string;
+    /** Group of the coupon scope. */
+    group?: Group$1;
+}
+interface Group$1 {
+    /** Name of the group. */
+    name?: string;
+    /** Entity ID of the group. */
+    entityId?: string | null;
+}
+interface LoyaltyPoints$1 {
+    /** Amount of points to give. */
+    amount?: number;
+}
+declare enum Action {
+    /** Unknown action. */
+    UNKNOWN = "UNKNOWN",
+    /** Store order placed. */
+    STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
+    /** Pricing plan ordered. */
+    PLAN_ORDERED = "PLAN_ORDERED",
+    /** Wix events ticket ordered. */
+    TICKET_ORDERED = "TICKET_ORDERED",
+    /** Bookings session booked. */
+    SESSION_BOOKED = "SESSION_BOOKED",
+    /** Restaurant order placed. */
+    RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
+}
+interface Emails {
+    /** Encourage customers to refer their friends email. Select for which apps to enable. */
+    encourageToReferFriends?: App[];
+    /** Notify customers about their referral reward email. Set true to enable email. */
+    notifyCustomersAboutReward?: boolean;
+}
+declare enum App {
+    /** Unknown app. */
+    UNKNOWN = "UNKNOWN",
+    /** Wix stores. */
+    STORES = "STORES",
+    /** Wix pricing plans. */
+    PRICING_PLANS = "PRICING_PLANS",
+    /** Wix events. */
+    EVENTS = "EVENTS",
+    /** Wix bookings. */
+    BOOKINGS = "BOOKINGS",
+    /** Wix restaurants. */
+    RESTAURANTS = "RESTAURANTS"
+}
+interface GetReferralProgramResponse {
+    /** The retrieved ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface Cursors$3 {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface UpdateReferralProgramResponse {
+    /** The updated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface ActivateReferralProgramResponse {
+    /** The activated ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface PauseReferralProgramResponse {
+    /** The paused ReferralProgram. */
+    referralProgram?: ReferralProgram;
+}
+interface GetAISocialMediaPostsSuggestionsResponse {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface AISocialMediaPostSuggestion {
+    /** The suggested post content. */
+    postContent?: string;
+    /** The suggested hashtags. */
+    hashtags?: string[];
+}
+interface GenerateAISocialMediaPostsSuggestionsResponse {
+    /** The generated suggestions. */
+    suggestions?: AISocialMediaPostSuggestion[];
+    /** The refer friends page URL. */
+    referFriendsPageUrl?: string | null;
+}
+interface GetReferralProgramPremiumFeaturesResponse {
+    /**
+     * Set to true if user has referral program feature.
+     * @readonly
+     */
+    referralProgram?: boolean;
+}
+interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType$3;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$3 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType$3 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface GetReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface UpdateReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface ActivateReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface PauseReferralProgramResponseNonNullableFields {
+    referralProgram?: {
+        status: ProgramStatus;
+        referredFriendReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        referringCustomerReward?: {
+            couponOptions?: {
+                fixedAmountOptions?: {
+                    amount: number;
+                };
+                percentageOptions?: {
+                    percentage: number;
+                };
+                minimumSubtotal: number;
+                scope?: {
+                    namespace: string;
+                    group?: {
+                        name: string;
+                    };
+                };
+                name: string;
+                discountType: DiscountType$1;
+            };
+            loyaltyPointsOptions?: {
+                amount: number;
+            };
+            type: Type;
+        };
+        successfulReferralActions: Action[];
+        isPremium: boolean;
+        emails?: {
+            encourageToReferFriends: App[];
+            notifyCustomersAboutReward: boolean;
+        };
+    };
+}
+interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields {
+    suggestions: {
+        postContent: string;
+        hashtags: string[];
+    }[];
+}
+interface GetReferralProgramPremiumFeaturesResponseNonNullableFields {
+    referralProgram: boolean;
+}
+interface BaseEventMetadata$3 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$3;
+}
+interface EventMetadata$3 extends BaseEventMetadata$3 {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface ProgramUpdatedEnvelope {
+    entity: ReferralProgram;
+    metadata: EventMetadata$3;
+}
+interface QueryCursorResult$3 {
+    cursors: Cursors$3;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ReferralProgramsQueryResult extends QueryCursorResult$3 {
+    items: ReferralProgram[];
+    query: ReferralProgramsQueryBuilder;
+    next: () => Promise<ReferralProgramsQueryResult>;
+    prev: () => Promise<ReferralProgramsQueryResult>;
+}
+interface ReferralProgramsQueryBuilder {
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ReferralProgramsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReferralProgramsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReferralProgramsQueryResult>;
+}
+interface GetAiSocialMediaPostsSuggestionsOptions {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+interface GenerateAiSocialMediaPostsSuggestionsOptions {
+    /** The topic to generate suggestions for. */
+    topic?: string;
+}
+
+type RESTFunctionDescriptor$3<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$3) => T;
+interface HttpClient$3 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$3<TResponse, TData>): Promise<HttpResponse$3<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory$3<TResponse = any, TData = any> = (context: any) => RequestOptions$3<TResponse, TData>;
+type HttpResponse$3<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions$3<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata$3;
+type APIMetadata$3 = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction$3<T extends RESTFunctionDescriptor$3> = T extends RESTFunctionDescriptor$3<infer U> ? U : never;
+type EventDefinition$3<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition$3<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$3<Payload, Type>;
+type EventHandler$3<T extends EventDefinition$3> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition$3<T extends EventDefinition$3<any, string>> = (handler: EventHandler$3<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function getReferralProgram$1(httpClient: HttpClient$3): () => Promise<GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields>;
+declare function queryReferralPrograms$1(httpClient: HttpClient$3): () => ReferralProgramsQueryBuilder;
+declare function updateReferralProgram$1(httpClient: HttpClient$3): (referralProgram: ReferralProgram) => Promise<UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields>;
+declare function activateReferralProgram$1(httpClient: HttpClient$3): () => Promise<ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields>;
+declare function pauseReferralProgram$1(httpClient: HttpClient$3): () => Promise<PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields>;
+declare function getAiSocialMediaPostsSuggestions$1(httpClient: HttpClient$3): (options?: GetAiSocialMediaPostsSuggestionsOptions) => Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
+declare function generateAiSocialMediaPostsSuggestions$1(httpClient: HttpClient$3): (options?: GenerateAiSocialMediaPostsSuggestionsOptions) => Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
+declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient$3): () => Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
+declare const onProgramUpdated$1: EventDefinition$3<ProgramUpdatedEnvelope, "wix.loyalty.referral.v1.program_updated">;
+
+declare const getReferralProgram: BuildRESTFunction$3<typeof getReferralProgram$1>;
+declare const queryReferralPrograms: BuildRESTFunction$3<typeof queryReferralPrograms$1>;
+declare const updateReferralProgram: BuildRESTFunction$3<typeof updateReferralProgram$1>;
+declare const activateReferralProgram: BuildRESTFunction$3<typeof activateReferralProgram$1>;
+declare const pauseReferralProgram: BuildRESTFunction$3<typeof pauseReferralProgram$1>;
+declare const getAiSocialMediaPostsSuggestions: BuildRESTFunction$3<typeof getAiSocialMediaPostsSuggestions$1>;
+declare const generateAiSocialMediaPostsSuggestions: BuildRESTFunction$3<typeof generateAiSocialMediaPostsSuggestions$1>;
+declare const getReferralProgramPremiumFeatures: BuildRESTFunction$3<typeof getReferralProgramPremiumFeatures$1>;
+declare const onProgramUpdated: BuildEventDefinition$3<typeof onProgramUpdated$1>;
+
+declare const context$3_activateReferralProgram: typeof activateReferralProgram;
+declare const context$3_generateAiSocialMediaPostsSuggestions: typeof generateAiSocialMediaPostsSuggestions;
+declare const context$3_getAiSocialMediaPostsSuggestions: typeof getAiSocialMediaPostsSuggestions;
+declare const context$3_getReferralProgram: typeof getReferralProgram;
+declare const context$3_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
+declare const context$3_onProgramUpdated: typeof onProgramUpdated;
+declare const context$3_pauseReferralProgram: typeof pauseReferralProgram;
+declare const context$3_queryReferralPrograms: typeof queryReferralPrograms;
+declare const context$3_updateReferralProgram: typeof updateReferralProgram;
+declare namespace context$3 {
+  export { context$3_activateReferralProgram as activateReferralProgram, context$3_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, context$3_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, context$3_getReferralProgram as getReferralProgram, context$3_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, context$3_onProgramUpdated as onProgramUpdated, context$3_pauseReferralProgram as pauseReferralProgram, context$3_queryReferralPrograms as queryReferralPrograms, context$3_updateReferralProgram as updateReferralProgram };
+}
+
 /** ReferralEvent. */
 interface ReferralEvent extends ReferralEventEventTypeOneOf {
     /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
@@ -306,17 +961,17 @@ declare enum Status$1 {
     DELETED = "DELETED"
 }
 interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
     /** Specifies the type of line items this coupon will apply to. */
     scope?: CouponScope;
-    /** Coupon name */
+    /** Coupon name. */
     name?: string;
-    /** Coupon discount type */
+    /** Coupon discount type. */
     discountType?: DiscountType;
     /** Limit the coupon to only apply to one item in cart. */
     limitedToOneItem?: boolean | null;
@@ -327,9 +982,9 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf {
-    /** Options for fixed amount discount type */
+    /** Options for fixed amount discount type. */
     fixedAmountOptions?: FixedAmountDiscount;
-    /** Options for percentage discount type */
+    /** Options for percentage discount type. */
     percentageOptions?: PercentageDiscount;
 }
 /** @oneof */
@@ -340,27 +995,33 @@ interface CouponScopeOrMinSubtotalOneOf {
     scope?: CouponScope;
 }
 declare enum DiscountType {
+    /** 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 {
-    /** Fixed amount to discount */
+    /** Fixed amount to discount. */
     amount?: number;
 }
 interface PercentageDiscount {
+    /** Percentage to discount. */
     percentage?: number;
 }
 interface CouponScope {
+    /** Namespace of the coupon scope. */
     namespace?: string;
+    /** Group of the coupon scope. */
     group?: Group;
 }
 interface Group {
+    /** Name of the group. */
     name?: string;
+    /** Entity ID of the group. */
     entityId?: string | null;
 }
 interface LoyaltyPoints {
@@ -1341,4 +2002,4 @@ declare namespace context {
   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 customers, context$1 as friends, context$2 as tracker };
+export { context as customers, context$1 as friends, context$3 as programs, context$2 as tracker };