@wix/auto_sdk_loyalty_programs 1.0.15 → 1.0.17

package/build/internal/cjs/src/loyalty-v1-program-programs.universal.d.ts

@@ -0,0 +1,1474 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+/**
+ * A loyalty program allows sites to maintain customer reward accounts. Site owners can create a
+ * loyalty program to increase customer retention. Read more about the loyalty program in
+ * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
+ */
+export interface LoyaltyProgram {
+    /**
+     * Program name.
+     * @minLength 2
+     * @maxLength 50
+     */
+    name?: string | null;
+    /** Information about the program's collectible entity. */
+    pointDefinition?: PointDefinition;
+    /**
+     * Program status. Customers can only earn or redeem points while the program is `ACTIVE`.
+     *
+     * Default: `"DRAFT"`
+     * @readonly
+     */
+    status?: ProgramStatus;
+    /**
+     * Date and time the program was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the program was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Configuration for the points expiration feature. */
+    pointsExpiration?: PointsExpiration;
+    /**
+     * Information about the available program premium features.
+     * @readonly
+     */
+    premiumFeatures?: PremiumFeatures;
+}
+export interface PointDefinition {
+    /**
+     * Display name for the program's collectible unit.
+     *
+     * It's recommended to use a plural, for example `Stars`.
+     *
+     * In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
+     *
+     * Default: `Points`.
+     * @maxLength 20
+     */
+    customName?: string | null;
+    /** Image URL. See [Image]($w/image/introduction) for more information on URL formats for images. */
+    icon?: string;
+}
+export interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
+export declare enum ProgramStatus {
+    /** Unknown program status. */
+    UNKNOWN = "UNKNOWN",
+    /** Program was created but is not enabled yet. */
+    DRAFT = "DRAFT",
+    /** Program is active. */
+    ACTIVE = "ACTIVE",
+    /** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
+    PAUSED = "PAUSED"
+}
+export interface PointsExpiration {
+    /**
+     * Status of the points expiration feature.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * How many months a member should be inactive to lose the collected points.
+     * @min 1
+     * @max 12
+     */
+    monthsOfInactivity?: number;
+    /**
+     * Percentage of points that a member loses after being inactive.
+     * @min 1
+     * @max 100
+     */
+    expiringPointsPercentage?: number;
+}
+export declare enum Status {
+    /** Unknown points expiration status. This value is not used. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Points expiration feature is disabled. */
+    DISABLED = "DISABLED",
+    /** Points expiration feature is enabled. */
+    ENABLED = "ENABLED"
+}
+export interface PremiumFeatures {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+export interface SocialMediaSettings {
+    /**
+     * List of social media channels
+     * @maxSize 5
+     */
+    channels?: SocialMediaChannel[];
+}
+export interface SocialMediaChannel {
+    /** Social media channel type */
+    type?: Type;
+    /** Enable or disable social media channel */
+    enabled?: boolean;
+    /**
+     * Social media channel ID. For example, Instagram username.
+     * @minLength 1
+     * @maxLength 255
+     */
+    _id?: string;
+    /**
+     * Social media channel URL
+     * @readonly
+     * @format WEB_URL
+     */
+    url?: string | null;
+}
+export declare enum Type {
+    /** Unknown social media channel type. */
+    UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
+    /** Facebook social media channel. */
+    FACEBOOK = "FACEBOOK",
+    /** Instagram social media channel. */
+    INSTAGRAM = "INSTAGRAM",
+    /** LinkedIn social media channel. */
+    LINKEDIN = "LINKEDIN",
+    /** X social media channel. */
+    X = "X",
+    /** TikTok social media channel. */
+    TIKTOK = "TIKTOK"
+}
+export interface GetLoyaltyProgramRequest {
+}
+export interface GetLoyaltyProgramResponse {
+    /** Retrieved loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface BulkGetLoyaltyProgramRequest {
+}
+export interface BulkGetLoyaltyProgramResponse {
+    /** Retrieved loyalty programs. */
+    programInSites?: ProgramInSite[];
+}
+export interface ProgramInSite {
+    /**
+     * Metasite ID.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface UpdateLoyaltyProgramRequest {
+    /** Loyalty program fields to update. */
+    loyaltyProgram: LoyaltyProgram;
+}
+export interface UpdateLoyaltyProgramResponse {
+    /** Updated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface PointsExpirationConfigurationChanged {
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+    /** Points expiration configuration changes */
+    pointsExpirationChanges?: PointsExpirationChanges;
+}
+export interface PointsExpirationChanges {
+    monthsOfInactivity?: number | null;
+    expiringPointsPercentage?: number | null;
+}
+export interface ActivateLoyaltyProgramRequest {
+}
+export interface ActivateLoyaltyProgramResponse {
+    /** Activated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface LoyaltyProgramActivated {
+    /** Activated loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface PauseLoyaltyProgramRequest {
+}
+export interface PauseLoyaltyProgramResponse {
+    /** Paused loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface GetLoyaltyProgramDescriptionRequest {
+    /**
+     * List of description fields to retrieve. Supported values: `description`, `updatedDate`.
+     * @maxSize 2
+     */
+    fields?: string[];
+}
+export interface GetLoyaltyProgramDescriptionResponse {
+    /** Retrieved loyalty program description. */
+    description?: string | null;
+    /** Date and time of the latest description update. */
+    _updatedDate?: Date | null;
+}
+export interface UpdateLoyaltyProgramDescriptionRequest {
+    /**
+     * Loyalty program description to update.
+     * @minLength 1
+     * @maxLength 1000000
+     */
+    description?: string;
+}
+export interface UpdateLoyaltyProgramDescriptionResponse {
+}
+export interface LoyaltyProgramDescriptionUpdated {
+}
+export interface GetLoyaltyProgramPremiumFeaturesRequest {
+}
+export interface GetLoyaltyProgramPremiumFeaturesResponse {
+    /**
+     * Whether there are any loyalty program premium features.
+     * @readonly
+     */
+    loyaltyProgram?: boolean;
+    /**
+     * Whether this loyalty program includes tiers.
+     * @readonly
+     */
+    tiers?: boolean;
+    /**
+     * Whether this loyalty program includes point expiration.
+     * @readonly
+     */
+    pointsExpiration?: boolean;
+}
+export interface EnablePointsExpirationRequest {
+}
+export interface EnablePointsExpirationResponse {
+    /** Loyalty program with enabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface PointsExpirationEnabled {
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface DisablePointsExpirationRequest {
+}
+export interface DisablePointsExpirationResponse {
+    /** Loyalty program with disabled points expiration feature. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface PointsExpirationDisabled {
+    /** Loyalty program. */
+    loyaltyProgram?: LoyaltyProgram;
+}
+export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+    /**
+     * A meta site id.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
+     */
+    assets?: Asset[];
+}
+/** @oneof */
+export interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+}
+export interface Asset {
+    /**
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export interface SiteCreated {
+    /**
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
+     */
+    originTemplateId?: string;
+    /**
+     * An account id of the owner.
+     * @format GUID
+     */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * @format GUID
+     */
+    originMetaSiteId?: string | null;
+    /**
+     * A meta site name (URL slug).
+     * @maxLength 20
+     */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
+    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_FORMS = "STANDALONE_FORMS",
+    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_EVENTS = "STANDALONE_EVENTS",
+    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
+    MIMIR = "MIMIR"
+}
+/** Site transferred to another user. */
+export interface SiteTransferred {
+    /**
+     * A previous owner id (user that transfers meta site).
+     * @format GUID
+     */
+    oldOwnerId?: string;
+    /**
+     * A new owner id (user that accepts meta site).
+     * @format GUID
+     */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /**
+     * A reason (flow).
+     * @maxLength 255
+     */
+    deleteOrigin?: string;
+    /**
+     * A service that deleted it.
+     * @maxLength 255
+     */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE",
+    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /**
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
+     */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+export interface ServiceProvisioned {
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
+    instanceId?: string;
+    /**
+     * An instance id from which this instance is originated.
+     * @maxLength 36
+     */
+    originInstanceId?: string;
+    /**
+     * A version.
+     * @maxLength 500
+     */
+    version?: string | null;
+    /**
+     * The origin meta site id
+     * @format GUID
+     */
+    originMetaSiteId?: string | null;
+}
+export interface ServiceRemoved {
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
+    instanceId?: string;
+    /**
+     * A version.
+     * @maxLength 500
+     */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+export interface SiteRenamed {
+    /**
+     * A new meta site name (URL slug).
+     * @maxLength 20
+     */
+    newSiteName?: string;
+    /**
+     * A previous meta site name (URL slug).
+     * @maxLength 255
+     */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+/**
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
+ *
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
+ *
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
+ */
+export interface SiteUrlChanged {
+}
+/**
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
+ * Consumed by other teams to remove relevant data.
+ */
+export interface SitePurgedExternally {
+    /**
+     * @maxLength 2048
+     * @maxSize 100
+     * @deprecated
+     * @targetRemovalDate 2025-04-15
+     */
+    appDefId?: string[];
+}
+export interface Empty {
+}
+export interface FeatureEvent extends FeatureEventEventOneOf {
+    /**
+     * Information about an event that makes a feature eligible to the user.
+     * Triggered for example, for new features or when a feature is reassigned
+     * to an account or a site.
+     */
+    enabled?: FeatureEnabled;
+    /**
+     * Information about an event that disables a feature for the user.
+     * Triggered for example, when a feature is unassigned from a site,
+     * reassigned to a different site, or the user switched to a different contract.
+     */
+    disabled?: FeatureDisabled;
+    /**
+     * Information about an event that updates a feature. An `updated` event
+     * is triggered for example by the
+     * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
+     * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
+     * endpoints.
+     */
+    updated?: FeatureUpdated;
+    /**
+     * Information about an event that cancels a feature for the user.
+     * Triggered for example, when a feature is canceled, transferred to
+     * another account, or the user switched to a different contract.
+     */
+    cancelled?: FeatureCancelled;
+    /**
+     * Timestamp of the event in
+     * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
+     */
+    timestamp?: Date | null;
+}
+/** @oneof */
+export interface FeatureEventEventOneOf {
+    /**
+     * Information about an event that makes a feature eligible to the user.
+     * Triggered for example, for new features or when a feature is reassigned
+     * to an account or a site.
+     */
+    enabled?: FeatureEnabled;
+    /**
+     * Information about an event that disables a feature for the user.
+     * Triggered for example, when a feature is unassigned from a site,
+     * reassigned to a different site, or the user switched to a different contract.
+     */
+    disabled?: FeatureDisabled;
+    /**
+     * Information about an event that updates a feature. An `updated` event
+     * is triggered for example by the
+     * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
+     * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
+     * endpoints.
+     */
+    updated?: FeatureUpdated;
+    /**
+     * Information about an event that cancels a feature for the user.
+     * Triggered for example, when a feature is canceled, transferred to
+     * another account, or the user switched to a different contract.
+     */
+    cancelled?: FeatureCancelled;
+}
+/** Feature created or enabled after disabled state */
+export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
+    /** Information about a transfer from another account. */
+    transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
+    /** Information about a transfer from another site. */
+    reassignedFromSite?: ReassignedFromSiteReason;
+    /** Information about a feature that hadn't been assigned to site. */
+    assignedFromFloating?: AssignedFromFloatingReason;
+    /** Information about the new feature. */
+    newFeature?: NewFeatureReason;
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+    /** Information about the manually created features. */
+    manualFeatureCreation?: ManualFeatureCreationReason;
+    /** Information about a feature that was migrated from legacy. */
+    migratedFromLegacy?: MigratedFromLegacyReason;
+    /** Enabled feature. */
+    feature?: Feature;
+    /**
+     * Information about a transfer from another account.
+     * __Deprecated__. Use `reason.transferred_from_another_account` instead.
+     * @format GUID
+     */
+    transferredFromAccount?: string | null;
+    /**
+     * Information about a transfer from another site.
+     * __Deprecated__. Use `reason.reassigned_from_site` instead.
+     * @format GUID
+     */
+    reassignedFromMetasite?: string | null;
+}
+/** @oneof */
+export interface FeatureEnabledReasonOneOf {
+    /** Information about a transfer from another account. */
+    transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
+    /** Information about a transfer from another site. */
+    reassignedFromSite?: ReassignedFromSiteReason;
+    /** Information about a feature that hadn't been assigned to site. */
+    assignedFromFloating?: AssignedFromFloatingReason;
+    /** Information about the new feature. */
+    newFeature?: NewFeatureReason;
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+    /** Information about the manually created features. */
+    manualFeatureCreation?: ManualFeatureCreationReason;
+    /** Information about a feature that was migrated from legacy. */
+    migratedFromLegacy?: MigratedFromLegacyReason;
+}
+export interface Feature extends FeatureQuantityInfoOneOf {
+    /**
+     * Deprecated. Use `enabled` instead.
+     * @deprecated
+     */
+    booleanFeature?: BooleanFeature;
+    /**
+     * Deprecated. Use `quotaInfo` instead.
+     * @deprecated
+     */
+    quotaFeature?: QuotaFeature;
+    /**
+     * ID of the feature. __Note:__ Isn't unique. For example, all features that
+     * are available to free Wix accounts or site in some capacity have
+     * `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Unique name of the feature. Only lower case letters, numbers, and dashes
+     * `-` are supported. Used in the endpoints of the
+     * [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)
+     * to specify the feature. Not visible to customers. We recommend to start
+     * the unique name with a prefix describing your organization or Wix company.
+     * For example, `bookings` or `crm`.
+     *
+     * Min: 2 characters
+     * Max: 50 characters
+     * @minLength 2
+     * @maxLength 50
+     */
+    uniqueName?: string;
+    /**
+     * Information about whether the feature belongs to a Wix account or site.
+     * Account features have `context.userId`. Site features have `context.metaSiteId` in case
+     * they're assigned to a specific site. Site features that aren't assigned to
+     * a specific site have neither ID.
+     */
+    context?: FeatureContext;
+    /**
+     * Deprecated.
+     * @readonly
+     * @deprecated
+     */
+    createdAt?: Date | null;
+    /**
+     * Deprecated.
+     * @readonly
+     * @deprecated
+     */
+    updatedAt?: Date | null;
+    /**
+     * Information about how often customers can use the feature during a specific
+     * period. Available only for quota features.
+     */
+    quotaInfo?: QuotaInfo;
+    /**
+     * Whether the customer is currently allowed to use the feature.
+     * `true` means that the customer can use the feature. This means a boolean
+     * feature is active or a quota feature has remaining usage.
+     * `false` means that the customer can't use the feature.
+     * This means a boolean feature isn't active or a quota feature doesn't
+     * have remaining usage.
+     */
+    enabled?: boolean;
+    /**
+     * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
+     * to which the feature instance belongs.
+     * @format GUID
+     */
+    subscriptionId?: string | null;
+    /**
+     * Metadata of the feature. Wix Premium uses the metadata object to indicate
+     * that customers who purchase a product with the feature also get
+     * access to an additional product. For these bundled products `metadata`
+     * looks like this: `{"tpa": "{"appDefId": "sample-app-def-id-1234567890", "vendorProductId": "sample-productId"}}"`.
+     * But you can use the `metadata` property for other purposes, too.
+     */
+    metadata?: Record<string, string>;
+}
+/** @oneof */
+export interface FeatureQuantityInfoOneOf {
+    /**
+     * Deprecated. Use `enabled` instead.
+     * @deprecated
+     */
+    booleanFeature?: BooleanFeature;
+    /**
+     * Deprecated. Use `quotaInfo` instead.
+     * @deprecated
+     */
+    quotaFeature?: QuotaFeature;
+}
+/**
+ * Context this feature is currently connected to.
+ * Note: Do not confuse with feature scope which is configured in the product catalog
+ * and defines in which context the product can be used
+ */
+export interface FeatureContext {
+    /**
+     * ID of the Wix account that the feature instance belongs to.
+     * Available for both site and account level feature instances.
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * ID of the meta site that the feature instance is assigned to.
+     * Only available for site level feature instances that are assigned to a Wix
+     * site. Not available for account level and unassigned site level feature
+     * instances.
+     * @format GUID
+     */
+    metaSiteId?: string | null;
+}
+/**
+ * A feature that can be either "enabled" or "disabled". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).
+ * A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
+ */
+export interface BooleanFeature {
+}
+/** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */
+export interface QuotaFeature {
+    /** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
+    limit?: string | null;
+    /** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
+    period?: FeaturePeriod;
+    /** Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit. */
+    units?: string | null;
+}
+/** Determines the reset cycle of the feature usage. */
+export declare enum FeaturePeriod {
+    NO_PERIOD = "NO_PERIOD",
+    MILLISECOND = "MILLISECOND",
+    SECOND = "SECOND",
+    MINUTE = "MINUTE",
+    HOUR = "HOUR",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+export interface QuotaInfo {
+    /**
+     * How often the customer is allowed to use the feature during the specified
+     * period. `null` means that the customer has unlimited access to the feature.
+     */
+    limit?: string | null;
+    /**
+     * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`
+     * isn't automatically reset to the feature's `limit` after a specific period.
+     * You may still manually call
+     * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).
+     */
+    period?: FeaturePeriod;
+    /**
+     * How often the customer has used the feature during the current
+     * period.
+     */
+    currentUsage?: string;
+    /**
+     * How often the customer can still use the feature during the current
+     * period. `null` means that the customer has unlimited access to the feature.
+     */
+    remainingUsage?: string | null;
+}
+/** Subscription transferred from another account, features on the current account were enabled. */
+export interface TransferredFromAnotherAccountReason {
+    /**
+     * Information about a transfer from another account.
+     * @format GUID
+     */
+    transferredFromAccount?: string;
+}
+/** Subscription moved from one site to another in the same account, features enabled on the target site */
+export interface ReassignedFromSiteReason {
+    /**
+     * Information about a transfer from another site.
+     * @format GUID
+     */
+    reassignedFromMetasite?: string;
+}
+/** Subscription was floating and assigned to site, features enabled on the target site */
+export interface AssignedFromFloatingReason {
+}
+/** New subscription created and features created as enabled */
+export interface NewFeatureReason {
+}
+/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
+export interface ContractSwitchedReason {
+}
+/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
+export interface ManualFeatureCreationReason {
+}
+/** Subscription created due to migration from old premium model */
+export interface MigratedFromLegacyReason {
+}
+/** Feature disabled and can be enabled in the future */
+export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
+    /** Information about a feature that's no longer assigned to a site. */
+    unassingedToFloating?: UnAssingedToFloatingReason;
+    /**
+     * Information about a feature that's been replaced by a feature from a
+     * different subscription.
+     */
+    replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
+    /**
+     * Information about a feature that's been reassigned to a different
+     * site.
+     */
+    reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
+    /**
+     * Disabled feature. Includes information about the feature's new state,
+     * possibly its new context.
+     */
+    feature?: Feature;
+    /**
+     * ID of the meta site for which the feature has been disabled.
+     * @format GUID
+     */
+    metaSiteId?: string | null;
+}
+/** @oneof */
+export interface FeatureDisabledReasonOneOf {
+    /** Information about a feature that's no longer assigned to a site. */
+    unassingedToFloating?: UnAssingedToFloatingReason;
+    /**
+     * Information about a feature that's been replaced by a feature from a
+     * different subscription.
+     */
+    replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
+    /**
+     * Information about a feature that's been reassigned to a different
+     * site.
+     */
+    reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
+}
+/** Subscription was unassigned from the site and moved into floating state */
+export interface UnAssingedToFloatingReason {
+}
+/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
+export interface ReplacedByAnotherSubscriptionReason {
+}
+/** Subscription was assigned to another site, causing  features on the origin  site to be disabled. */
+export interface ReassignedToAnotherSiteReason {
+    /**
+     * Information about a transfer to the site.
+     * @format GUID
+     */
+    reassignedToMetasite?: string;
+}
+/** Feature updated, for example Quota was increased due to upgrade */
+export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
+    /** Information about a feature that doesn't have a usage quota. */
+    booleanFeature?: BooleanFeature;
+    /** Information about a feature that has a usage quota. */
+    quotaFeature?: QuotaFeature;
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+    /**
+     * Updated feature. Includes information about the feature's new state and
+     * possibly its new context.
+     */
+    feature?: Feature;
+}
+/** @oneof */
+export interface FeatureUpdatedPreviousQuantityInfoOneOf {
+    /** Information about a feature that doesn't have a usage quota. */
+    booleanFeature?: BooleanFeature;
+    /** Information about a feature that has a usage quota. */
+    quotaFeature?: QuotaFeature;
+}
+/** @oneof */
+export interface FeatureUpdatedReasonOneOf {
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+}
+/** Feature was permanently cancelled */
+export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
+    /** Information about a transfer to the account. */
+    transferredToAnotherAccount?: TransferredToAnotherAccountReason;
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+    /** Information about the feature cancellation. */
+    cancelRequest?: CancelRequestedReason;
+    /** Canceled feature. */
+    feature?: Feature;
+    /**
+     * Information about a transfer to the account.
+     * __Deprecated__. Use `reason.transferred_to_account` instead.
+     * @format GUID
+     */
+    transferredToAccount?: string | null;
+}
+/** @oneof */
+export interface FeatureCancelledReasonOneOf {
+    /** Information about a transfer to the account. */
+    transferredToAnotherAccount?: TransferredToAnotherAccountReason;
+    /** Information about the contract switch. */
+    contractSwitched?: ContractSwitchedReason;
+    /** Information about the feature cancellation. */
+    cancelRequest?: CancelRequestedReason;
+}
+/** Subscription was transferred to another account, features in the origin account were cancelled */
+export interface TransferredToAnotherAccountReason {
+    /**
+     * Information about a transfer to the account.
+     * @format GUID
+     */
+    transferredToAccount?: string;
+}
+/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
+export interface CancelRequestedReason {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export 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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * 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;
+}
+export interface ProgramUpdatedEnvelope {
+    entity: LoyaltyProgram;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a loyalty program is updated.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_PROGRAM
+ * @webhook
+ * @eventType wix.loyalty.v1.program_updated
+ * @serviceIdentifier com.wixpress.loyalty.program.LoyaltyPrograms
+ * @slug updated
+ */
+export declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
+type ProgramNonNullablePaths = `status` | `pointsExpiration.status` | `pointsExpiration.monthsOfInactivity` | `pointsExpiration.expiringPointsPercentage` | `premiumFeatures.loyaltyProgram` | `premiumFeatures.tiers` | `premiumFeatures.pointsExpiration`;
+/**
+ * Retrieves the site's loyalty program.
+ *
+ * The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.
+ * @public
+ * @permissionId LOYALTY.READ_PROGRAM
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.GetLoyaltyProgram
+ */
+export declare function getLoyaltyProgram(): Promise<NonNullablePaths<GetLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves loyalty programs for all metasites that the caller is a member of.
+ *
+ * Must be called with user identity.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId LOYALTY.PROGRAM_BULK_READ
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.BulkGetLoyaltyProgram
+ */
+export declare function bulkGetLoyaltyProgram(): Promise<NonNullablePaths<BulkGetLoyaltyProgramResponse, `programInSites` | `programInSites.${number}.metaSiteId` | {
+    [P in ProgramNonNullablePaths]: `programInSites.${number}.loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Updates the site's loyalty program.
+ *
+ * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
+ *
+ * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
+ *
+ * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
+ * @param loyaltyProgram - Loyalty program fields to update.
+ * @public
+ * @requiredField loyaltyProgram
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.UpdateLoyaltyProgram
+ */
+export declare function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Promise<NonNullablePaths<UpdateLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Activates a loyalty program.
+ *
+ * The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `"ACTIVE"`.
+ *
+ * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
+ *
+ * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
+ *
+ * To temporarily pause your loyalty program you must follow three steps:
+ * 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
+ * 1. Hide the loyalty page from your site.
+ * 1. Delete the My Rewards page from the Member pages.
+ * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
+ *
+ * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can activate a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.ActivateLoyaltyProgram
+ */
+export declare function activateLoyaltyProgram(): Promise<NonNullablePaths<ActivateLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Changes the program status to `PAUSED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.PauseLoyaltyProgram
+ */
+export declare function pauseLoyaltyProgram(): Promise<NonNullablePaths<PauseLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves information about the available loyalty program premium features.
+ * @public
+ * @permissionId LOYALTY.READ_PROGRAM
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.GetLoyaltyProgramPremiumFeatures
+ */
+export declare function getLoyaltyProgramPremiumFeatures(): Promise<NonNullablePaths<GetLoyaltyProgramPremiumFeaturesResponse, `loyaltyProgram` | `tiers` | `pointsExpiration`>>;
+/**
+ * Updates the `pointsExpiration` status to `ENABLED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.EnablePointsExpiration
+ */
+export declare function enablePointsExpiration(): Promise<NonNullablePaths<EnablePointsExpirationResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Updates the `pointsExpiration` status to `DISABLED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.DisablePointsExpiration
+ */
+export declare function disablePointsExpiration(): Promise<NonNullablePaths<DisablePointsExpirationResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+export {};