import { GetEventsSettingsRequest as GetEventsSettingsRequest$1, GetEventsSettingsResponse as GetEventsSettingsResponse$1, UpdateEventsSettingsRequest as UpdateEventsSettingsRequest$1, UpdateEventsSettingsResponse as UpdateEventsSettingsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** Events Settings reads the settings and state of a site's [Wix Events & Tickets](https://www.wix.com/app-market/web-solution/events) app. */ interface EventsSettings { /** * Events Settings ID. * @format GUID * @readonly */ id?: string | null; /** * App instance ID of the source site. Present only when the Events & Tickets app was installed from a template or copied from another site during site duplication. * @internal * @format GUID * @readonly */ sourceInstanceId?: string | null; /** * Date and time the Events Settings were created. * @readonly */ createdDate?: Date | null; /** * Date and time the Events Settings were last updated. * @readonly */ updatedDate?: Date | null; /** * Revision number, which increments by 1 each time the Events Settings are updated. To prevent conflicting changes, the current revision must be passed when updating the Events Settings. * @readonly */ revision?: string | null; /** * Current state of the Events & Tickets app, including when it was last enabled or disabled. * @internal * @readonly */ appState?: AppState; /** * Site information including locale, language, and available premium features. * @readonly */ siteInfo?: SiteInfo; /** * Global information about the site's events, including whether any events have been created and current ticket sales status. * @readonly */ eventsInfo?: EventsInfo; /** * Settings for Wix service fees applied to paid ticket sales. * @readonly */ serviceFeeSettings?: ServiceFeeSettings; /** Payment configuration including available payment methods, coupon acceptance, and delayed capture settings. */ paymentSettings?: PaymentSettings; /** * Site-specific settings for Events pages including setup completion status and page paths. * @internal */ siteSettings?: SiteSettings; /** * Whether the site has free premium features enabled. Free premium sites have access to certain advanced features without requiring a paid subscription. * @internal * @readonly */ freePremium?: boolean | null; /** * Configuration for event badges functionality. Event badges allow integration with 3rd-party services that provide digital badges or certificates for event attendance. * @internal * @readonly */ eventBadgesSettings?: EventBadgesSettings; /** * URLs for Events-related pages on the site, including event detail pages and schedule pages. These URLs are automatically generated based on the site's page structure and can be used for navigation or linking. * @internal */ eventPages?: EventPages; /** * Type of checkout flow used for ticket purchases. The checkout type is automatically determined based on the site's configuration and payment provider settings. * @internal * @readonly */ checkoutType?: CheckoutTypeWithLiterals; /** * Whether Wix Forms are enabled for site. * @internal * @readonly */ wixFormsEnabled?: boolean | null; /** * Event App Features * @internal * @readonly */ features?: AppFeatures; /** * ID of the site's buyer form, shared by all ticketed events on the site. Returned only when `BUYER_FORM` is requested and a buyer form exists. * @format GUID * @readonly */ buyerFormId?: string | null; } /** Events settings state */ interface AppState { /** * Current state of the Events app. * @readonly */ state?: AppStateStateWithLiterals; /** * Date and time when the app state was last changed. Updated whenever the Events app is enabled or disabled. * @readonly */ stateUpdatedDate?: Date | null; } /** Events app state options. */ declare enum AppStateState { /** Events app is active and functional. */ ENABLED = "ENABLED", /** Events app is inactive. */ DISABLED = "DISABLED" } /** @enumType */ type AppStateStateWithLiterals = AppStateState | 'ENABLED' | 'DISABLED'; /** Site info */ interface SiteInfo { /** * Site locale in IETF BCP 47 language tag format. For example, `en-US` for U.S. English. * @readonly * @format LANGUAGE_TAG */ locale?: string | null; /** * Site language in ISO 639-1 alpha-2 format. For example, `en`. * @readonly * @format LANGUAGE */ language?: string | null; /** * Premium features available to the site. These features control access to advanced events capabilities. Use this array to determine which functionality to enable in your integration. For example, check for `SELL_TICKETS` before showing payment options. * @readonly * @maxSize 20 */ premiumFeatures?: PremiumFeatureWithLiterals[]; } /** Premium features that can be enabled for Events. */ declare enum PremiumFeature { /** Enables paid ticket sales for events. When present, the site can create paid ticket definitions and process payments through configured payment providers. */ SELL_TICKETS = "SELL_TICKETS", /** Allows including custom URLs in event notification emails sent to attendees. Useful for adding registration links, additional information, or branded content in emails. */ INCLUDE_URL_IN_EMAIL = "INCLUDE_URL_IN_EMAIL", /** Removes Wix branding from event notification emails. Provides a fully customized email without Wix attribution in the footer. */ HIDE_FOOTER_IN_EMAIL = "HIDE_FOOTER_IN_EMAIL" } /** @enumType */ type PremiumFeatureWithLiterals = PremiumFeature | 'SELL_TICKETS' | 'INCLUDE_URL_IN_EMAIL' | 'HIDE_FOOTER_IN_EMAIL'; interface EventsInfo { /** * Whether the site has created its first event. * @readonly */ firstEventCreated?: boolean | null; /** * Whether any events on the site sell tickets, including both free and paid tickets. * @readonly */ sellingTickets?: boolean | null; /** * Whether any events on the site sell paid tickets specifically. Requires both ticket definitions with non-zero prices and the `SELL_TICKETS` premium feature. * @readonly */ sellingPaidTickets?: boolean | null; } interface ServiceFeeSettings { /** * Whether Wix service fees are applied to paid ticket sales. * @readonly */ serviceFeeEnabled?: boolean | null; /** * Date when Wix service fees were activated for the site. Present only if service fees are enabled and the site was created before May 27, 2019. * @internal * @readonly */ serviceFeeActivationDate?: Date | null; /** * Date when the site owner agreed to Wix service fee terms. Present only if agreement was provided and the site was created before May 27, 2019. * @internal * @readonly */ serviceFeeActivationAgreementDate?: Date | null; /** * Negotiated percentage above 0 and up to 100. Unset uses the default 2.5 percent; disable the fee through the ticket definition instead of a zero rate. * @internal * @readonly * @decimalValue options { gt:0, lte:100, maxScale:2 } */ serviceFeeRate?: string | null; } interface PaymentSettings { /** * Whether ticket sales are enabled for the site. Free ticket sales are always available; paid ticket sales require the `SELL_TICKETS` premium feature and configured payment providers. * @readonly */ ticketSalesEnabled?: boolean | null; /** * Payment methods currently available for ticket checkout. Automatically populated based on the site's payment provider configuration. Common methods include credit cards, PayPal, and digital wallets. * @readonly * @maxSize 100 */ activePaymentMethods?: PaymentMethod[]; /** * Whether discount coupons can be used during ticket checkout. Automatically enabled when at least one coupon exists on the site. * @readonly */ couponsAccepted?: boolean | null; /** * Whether gift cards can be used during ticket checkout. Requires gift card functionality to be enabled at the site level. * @readonly */ giftCardsAccepted?: boolean | null; /** Configuration for delayed payment capture, allowing payments to be authorized at purchase but captured later. This setting applies to all events on the site and can be updated through the API. */ delayedPaymentCaptureSettings?: DelayedPaymentCaptureSettings; /** * Whether the site has an active payment method * @internal * @readonly */ hasActivePaymentMethod?: boolean | null; } interface PaymentMethod { /** * Payment method identifier indicating the type of payment accepted. For example, `creditCard`, `payPal`, `applePay`, or `googlePay`. Use this to determine which payment options to display in checkout. * @readonly * @maxLength 20 */ methodId?: string; } interface DelayedPaymentCaptureSettings { /** Whether delayed payment capture is enabled for all ticket sales on the site. When enabled, payments are authorized at purchase but captured later. */ enabled?: boolean | null; /** * Action to take automatically after the delay period expires. Determines whether to complete the payment or release the authorization. * @internal */ action?: ActionWithLiterals; /** * Number of hours to delay payment capture. This allows time for event preparation, capacity adjustments, or manual review before finalizing payments. * * Default: `168` (7 days). * @internal * @max 144 */ delayInHours?: number | null; } /** Actions available for delayed payment processing. */ declare enum Action { /** Capture the authorized payment automatically after the delay period expires. This completes the transaction and charges the customer. */ CAPTURE = "CAPTURE", /** Cancel the authorized payment automatically after the delay period expires, releasing the held funds back to the customer without charge. */ VOID = "VOID" } /** @enumType */ type ActionWithLiterals = Action | 'CAPTURE' | 'VOID'; interface SiteSettings { /** Whether the initial Events setup has been completed. Set to `true` after the site owner completes the app configuration wizard. */ firstTimeCompleted?: boolean | null; /** Configuration for Events pages on the site. Determines whether Events pages are accessible to site visitors. */ pagesType?: TypeWithLiterals; /** * Custom path for the event details page. For example, `/events` or `/my-events`. Used to generate URLs for individual event pages. * @maxLength 100 */ detailsPagePath?: string | null; } declare enum Type { /** Events pages are enabled and accessible to site visitors. */ ENABLED = "ENABLED", /** Events pages are disabled and not accessible to site visitors. */ DISABLED = "DISABLED" } /** @enumType */ type TypeWithLiterals = Type | 'ENABLED' | 'DISABLED'; interface EventBadgesSettings { /** * Whether event badges functionality is available. Returns `true` when at least one event badges service provider integration (SPI) implementer exists on the site. * @readonly */ hasEventBadges?: boolean | null; } interface EventPages { /** * URL for the main Events page where visitors can view and browse all events. Use this for navigation or linking to the Events section. * @readonly */ eventPageUrl?: PageUrlV2; /** * URL for the Events schedule page showing upcoming events in calendar format. Use this for calendar-based event navigation. * @readonly */ schedulePageUrl?: PageUrlV2; /** * URL for standalone event pages that exist independently of the main Events app. * @internal * @readonly */ standalonePageUrl?: PageUrlV2; /** * Base URL used for generating other Events page URLs. * @internal * @readonly */ basePageUrl?: PageUrlV2; /** * Event pages overrides * @internal */ overrides?: EventPagesOverrides; } interface PageUrlV2 { /** * The relative path for the page within the site. For example, `/product-page/a-product`. * Relative path within the site. For example, `/product-page/a-product`. * @maxLength 128 */ relativePath?: string; /** * Complete URL including domain and path. For example, `https://mysite.com/product-page/a-product`. * @maxLength 128 */ url?: string | null; } interface EventPagesOverrides { /** * The relative path for the event page within the site. For example, `/event-page/an-event`. * @internal * @maxLength 128 */ eventPagePath?: string | null; /** * The relative path for the schedule page within the site. For example, `/schedule/my-event`. * @internal * @maxLength 128 */ schedulePagePath?: string | null; } declare enum CheckoutType { /** Checkout using Events App. */ EVENTS_APP = "EVENTS_APP", /** Checkout using Ecomm Platform. */ ECOMM_PLATFORM = "ECOMM_PLATFORM" } /** @enumType */ type CheckoutTypeWithLiterals = CheckoutType | 'EVENTS_APP' | 'ECOMM_PLATFORM'; interface AppFeatures { /** * Whether Wix Forms are enabled for site. * @internal * @readonly */ wixFormsEnabled?: boolean | null; /** * Whether Notification configs enabled. * @internal * @readonly */ notificationsEnabled?: boolean | null; /** * Whether Automation triggers enabled. * @internal * @readonly */ automationTriggersEnabled?: boolean | null; /** * Whether custom URL mapping is enabled for this site. * @internal * @readonly */ customUrlMappingEnabled?: boolean | null; } interface GetEventsSettingsRequest { /** * Settings categories to include in the response. If omitted, returns only basic settings for performance optimization. Use this to request specific information like premium features or payment settings. * @maxSize 11 */ fields?: RequestedFieldsWithLiterals[]; /** * Internal flag to skip payment method retrieval for performance optimization. * @internal */ skipPaymentMethods?: boolean; /** * Branch ID for resolving event page URLs from a specific site branch (e.g. editor/draft branch). * @internal */ branchId?: string | null; } /** Categories of events settings that can be selectively retrieved for performance optimization. */ declare enum RequestedFields { /** * Returns app state information including enabled/disabled status and last state change. * @internal */ APP_STATE = "APP_STATE", /** Returns site information including locale, language, and available premium features that determine Events capabilities. */ SITE_INFO = "SITE_INFO", /** Returns Events-related information like first event creation status and current ticket sales flags. */ EVENTS_INFO = "EVENTS_INFO", /** Returns Wix service fee configuration, activation status, and agreement dates. */ SERVICE_FEE_SETTINGS = "SERVICE_FEE_SETTINGS", /** Returns available payment methods, delayed capture settings, and payment acceptance configuration. */ PAYMENT_SETTINGS = "PAYMENT_SETTINGS", /** * Returns site-specific configuration including setup completion and page paths. * @internal */ SITE_SETTINGS = "SITE_SETTINGS", /** * Returns event badges functionality availability and configuration. * @internal */ EVENT_BADGES_SETTINGS = "EVENT_BADGES_SETTINGS", /** * Returns basic site properties like locale and language only. * @internal */ SITE_PROPERTIES = "SITE_PROPERTIES", /** * Returns URLs for Events-related pages including event listing and schedule pages. * @internal */ EVENT_PAGES = "EVENT_PAGES", /** * Returns Events App Features * @internal */ APP_FEATURES = "APP_FEATURES", /** Returns the site's buyer form ID, if a buyer form exists. */ BUYER_FORM = "BUYER_FORM" } /** @enumType */ type RequestedFieldsWithLiterals = RequestedFields | 'SITE_INFO' | 'EVENTS_INFO' | 'SERVICE_FEE_SETTINGS' | 'PAYMENT_SETTINGS' | 'BUYER_FORM'; interface GetEventsSettingsResponse { /** The Events Settings object containing the requested configuration and status information. */ eventsSettings?: EventsSettings; } interface UpdateEventsSettingsRequest { /** Events Settings object containing the fields to update. Must include the current `revision` number to prevent conflicting changes. */ eventsSettings: EventsSettings; /** * Exact fields to update. * @internal */ fieldMask?: string[]; /** * Settings categories to return in the response. Use this to optimize the response size by requesting only needed information. * @maxSize 6 */ fields?: RequestedFieldsWithLiterals[]; } interface UpdateEventsSettingsResponse { /** The updated Events Settings object reflecting the applied changes. */ eventsSettings?: EventsSettings; } 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; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * 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 */ 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; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } 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?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; 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?: SiteCreatedContextWithLiterals; /** * 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?: NamespaceWithLiterals; } 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" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; 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. * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG). */ 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", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS", /** Nautilus platform. */ NAUTILUS = "NAUTILUS", /** * Symphony — a siteless site representing a project within Symphony (the evolution of Orion). * Holds project data, conversations, assets, and manages collaborators / shared team members for the project. */ SYMPHONY = "SYMPHONY", /** Nautilus platform app. */ NAUTILUS_APPS = "NAUTILUS_APPS", /** * Vibu — a siteless site representing a project built with Vibu (the AI app builder). * Holds the project's generated code, conversations, assets, and manages collaborators for the project. */ VIBU = "VIBU", /** * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit * (an Enterprise account may have several), holding that BrandKit's brand definition * (theme, typography, assets) which is rolled out to the BrandKit's connected sites. * MetaSites with this namespace will *not* be shown in a user's site list by default. */ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT", /** * Dev-center development sites (com.wixpress.devcenter.dsm). * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites. */ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE'; /** Site transferred to another user. */ 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. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } 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. */ 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; } 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. */ 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. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ 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 */ 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. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface Empty { } /** Encapsulates all changes when site properties are updated */ interface SitePropertiesUpdated { /** ID of the Wix site that has been updated. */ metasiteId?: string; /** Update details. */ event?: SitePropertiesEvent; } /** The actual update event for a particular notification. */ interface SitePropertiesEvent { /** Version of the site's properties represented by this update. */ version?: number; /** Set of properties that were updated - corresponds to the fields in "properties". */ fields?: string[]; /** Updated properties. */ properties?: Properties; } interface Properties { /** Site categories. */ categories?: Categories; /** Site locale. */ locale?: Locale; /** * Site language. * * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ language?: string | null; /** * Site currency used to bill customers. * * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */ paymentCurrency?: string | null; /** Site time zone in IANA time zone database format. For example, `America/New_York`. */ timeZone?: string | null; /** Email address. */ email?: string | null; /** Phone number. */ phone?: string | null; /** Fax number. */ fax?: string | null; /** Address. */ address?: Address; /** Site display name. */ siteDisplayName?: string | null; /** Business name. */ businessName?: string | null; /** Path to the site's logo in Wix Media (without Wix Media base URL). */ logo?: string | null; /** Site description. */ description?: string | null; /** * Business schedule. Regular and exceptional time periods when the business is open or the service is available. * * __Note:__ Not supported by Wix Bookings. */ businessSchedule?: BusinessSchedule; /** Supported languages of a site and the primary language. */ multilingual?: Multilingual; /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */ consentPolicy?: ConsentPolicy; /** * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`. * * Site business type. */ businessConfig?: string | null; /** External site URL that uses Wix as its headless business solution. */ externalSiteUrl?: string | null; /** Track clicks analytics. */ trackClicksAnalytics?: boolean; /** * Company ID issued to the business by local authorities. Appears on invoices and price quotes. * @maxLength 50 */ companyId?: string | null; } interface Categories { /** Primary site category. */ primary?: string; /** * Secondary site category. * @maxSize 50 */ secondary?: string[]; /** Business Term Id */ businessTermId?: string | null; } interface Locale { /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ languageCode?: string; /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */ country?: string; } interface Address { /** Street name. */ street?: string; /** City name. */ city?: string; /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */ country?: string; /** State. */ state?: string; /** * Zip or postal code. * @maxLength 20 */ zip?: string; /** Extra information to be displayed in the address. */ hint?: AddressHint; /** Whether this address represents a physical location. */ isPhysical?: boolean; /** Google-formatted version of this address. */ googleFormattedAddress?: string; /** Street number. */ streetNumber?: string; /** Apartment number. */ apartmentNumber?: string; /** Geographic coordinates of location. */ coordinates?: GeoCoordinates; } /** * Extra information on displayed addresses. * This is used for display purposes. Used to add additional data about the address, such as "In the passage". * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string. */ interface AddressHint { /** Extra text displayed next to, or instead of, the actual address. */ text?: string; /** Where the extra text should be displayed. */ placement?: PlacementTypeWithLiterals; } /** Where the extra text should be displayed: before, after or instead of the actual address. */ declare enum PlacementType { BEFORE = "BEFORE", AFTER = "AFTER", REPLACE = "REPLACE" } /** @enumType */ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE'; /** Geocoordinates for a particular address. */ interface GeoCoordinates { /** Latitude of the location. Must be between -90 and 90. */ latitude?: number; /** Longitude of the location. Must be between -180 and 180. */ longitude?: number; } /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */ interface BusinessSchedule { /** * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. * @maxSize 100 */ periods?: TimePeriod[]; /** * Exceptions to the business's regular hours. The business can be open or closed during the exception. * @maxSize 100 */ specialHourPeriod?: SpecialHourPeriod[]; } /** Weekly recurring time periods when the business is regularly open or the service is available. */ interface TimePeriod { /** Day of the week the period starts on. */ openDay?: DayOfWeekWithLiterals; /** * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents * midnight at the end of the specified day. */ openTime?: string; /** Day of the week the period ends on. */ closeDay?: DayOfWeekWithLiterals; /** * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents * midnight at the end of the specified day. * * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`. */ closeTime?: string; } /** Enumerates the days of the week. */ declare enum DayOfWeek { MONDAY = "MONDAY", TUESDAY = "TUESDAY", WEDNESDAY = "WEDNESDAY", THURSDAY = "THURSDAY", FRIDAY = "FRIDAY", SATURDAY = "SATURDAY", SUNDAY = "SUNDAY" } /** @enumType */ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'; /** Exception to the business's regular hours. The business can be open or closed during the exception. */ interface SpecialHourPeriod { /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */ startDate?: string; /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */ endDate?: string; /** * Whether the business is closed (or the service is not available) during the exception. * * Default: `true`. */ isClosed?: boolean; /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */ comment?: string; } interface Multilingual { /** * Supported languages list. * @maxSize 200 */ supportedLanguages?: SupportedLanguage[]; /** Whether to redirect to user language. */ autoRedirect?: boolean; } interface SupportedLanguage { /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ languageCode?: string; /** Locale. */ locale?: Locale; /** Whether the supported language is the primary language for the site. */ isPrimary?: boolean; /** Language icon. */ countryCode?: string; /** How the language will be resolved. For internal use. */ resolutionMethod?: ResolutionMethodWithLiterals; /** Whether the supported language is the primary language for site visitors. */ isVisitorPrimary?: boolean | null; } declare enum ResolutionMethod { QUERY_PARAM = "QUERY_PARAM", SUBDOMAIN = "SUBDOMAIN", SUBDIRECTORY = "SUBDIRECTORY" } /** @enumType */ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY'; interface ConsentPolicy { /** Whether the site uses cookies that are essential to site operation. Always `true`. */ essential?: boolean | null; /** Whether the site uses cookies that affect site performance and other functional measurements. */ functional?: boolean | null; /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */ analytics?: boolean | null; /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */ advertising?: boolean | null; /** CCPA compliance flag. */ dataToThirdParty?: boolean | null; } interface NewNotificationMessage { /** payload */ payload?: NotificationInfo; /** template_topic_params */ templateTopicParams?: Record; } interface NotificationInfo { /** recipient identifier */ recipient?: NotificationRecipient; /** notification id, unique per notification per recipient */ notificationId?: string; /** correlation id. will be the same id for all the notifications that were created from the same notify request */ correlationId?: string; /** the spout who sent this notification */ spout?: NotificationsSpout; /** who initiated this notification */ initiator?: NotificationInitiator; /** identifier of the template that the notification is based on. if you don't know what notification templates are, RTFM */ templateId?: string; /** The context of the notification, used to determine recipient settings, aggregating notifications, etc. Please use the topic builder in order to create topics. */ topic?: string; /** when the notification was sent */ sentAt?: Date | null; /** strings that will be replaced when translating the notification */ translationParams?: Record; /** data that will be sent to the channels */ data?: Record | null; /** the link of the notification */ actionTarget?: ActionTarget; /** the link of the notification */ actionTargetWhenGrouped?: ActionTarget; } /** Notification Recipient represents a user that receives notifications from Ping */ interface NotificationRecipient extends NotificationRecipientRecipientTypeOneOf { /** * test recipient id * @format GUID */ testRecipient?: string; /** * Wix user id * @format GUID */ wixUser?: string; /** contact identifier */ contact?: Contact; /** Incognito (unidentified recipient) */ incognito?: IncognitoDetails; /** DeviantArt user */ deviantArtUser?: string; } /** @oneof */ interface NotificationRecipientRecipientTypeOneOf { /** * test recipient id * @format GUID */ testRecipient?: string; /** * Wix user id * @format GUID */ wixUser?: string; /** contact identifier */ contact?: Contact; /** Incognito (unidentified recipient) */ incognito?: IncognitoDetails; /** DeviantArt user */ deviantArtUser?: string; } interface Contact { /** * meta site id * @format GUID */ metaSiteId?: string; /** * contact id * @format GUID */ contactId?: string; } interface IncognitoDetails { /** * name * @format EMAIL */ name?: string | null; /** * email * @format EMAIL */ email?: string | null; /** * phone * @format PHONE */ phone?: string | null; /** locale */ locale?: string | null; /** language */ language?: string | null; } interface NotificationsSpout extends NotificationsSpoutSpoutTypeOneOf { /** wix app */ wixApp?: string; /** internal service */ internalService?: string; } /** @oneof */ interface NotificationsSpoutSpoutTypeOneOf { /** wix app */ wixApp?: string; /** internal service */ internalService?: string; } interface NotificationInitiator extends NotificationInitiatorInitiatorOneOf { /** * wix user id * @format GUID */ wixUser?: string; /** * wix app def id (for TPAs) * @format GUID */ wixApp?: string; /** contact identifier */ contact?: Contact; /** Site member identifier */ siteMember?: SiteMember; /** Anonymous (free string) */ anonymous?: string; /** Business (as metaSiteId) */ business?: string; } /** @oneof */ interface NotificationInitiatorInitiatorOneOf { /** * wix user id * @format GUID */ wixUser?: string; /** * wix app def id (for TPAs) * @format GUID */ wixApp?: string; /** contact identifier */ contact?: Contact; /** Site member identifier */ siteMember?: SiteMember; /** Anonymous (free string) */ anonymous?: string; /** Business (as metaSiteId) */ business?: string; } interface SiteMember { /** * site member id * @format GUID */ siteMemberId?: string; /** * meta site id * @format GUID */ metaSiteId?: string; } /** DB */ interface ActionTarget extends ActionTargetOfOneOf { /** url */ url?: string; /** backoffice app */ backofficeApp?: BackofficeActionTarget; /** live site */ liveSite?: LiveSiteActionTarget; /** dashboard page */ dashboardPage?: DashboardPageActionTarget; } /** @oneof */ interface ActionTargetOfOneOf { /** url */ url?: string; /** backoffice app */ backofficeApp?: BackofficeActionTarget; /** live site */ liveSite?: LiveSiteActionTarget; /** dashboard page */ dashboardPage?: DashboardPageActionTarget; } interface BackofficeActionTarget { /** app id */ appId?: string; /** * meta site id * @format GUID */ metaSiteId?: string; /** params */ params?: Record; } interface LiveSiteActionTarget { /** * meta site id * @format GUID */ metaSiteId?: string; /** app page id */ appPageId?: string | null; /** params */ params?: Record; } interface DashboardPageActionTarget { /** @format GUID */ pageId?: string; /** @maxLength 300 */ relativeUrl?: string | null; } interface AgreeToServiceFeeRequest { /** * Settings categories to return after recording the service fee agreement. * @maxSize 6 */ fields?: RequestedFieldsWithLiterals[]; } interface AgreeToServiceFeeResponse { /** Events Settings after recording the service fee agreement. */ eventsSettings?: EventsSettings; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo { deletedDate?: Date | null; } 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. */ currentEntityAsJson?: string; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * Map of fully qualified field paths to their previous values for fields that changed. * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format) * @internal */ modifiedFields?: Record; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted. */ deletedEntityAsJson?: string | null; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } 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; /** * Information about a quota usage change for a feature. Triggered when * quota usage is reported via Report Quota Usage endpoint. Includes * before/after usage and remaining values. */ quotaUsageChanged?: FeatureQuotaUsageChanged; /** * Timestamp of the event in * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */ timestamp?: Date | null; } /** @oneof */ 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; /** * Information about a quota usage change for a feature. Triggered when * quota usage is reported via Report Quota Usage endpoint. Includes * before/after usage and remaining values. */ quotaUsageChanged?: FeatureQuotaUsageChanged; } /** Feature created or enabled after disabled state */ 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; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; /** 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 */ 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; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; } 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; /** * Aggregated information about how often customers can use the feature. * 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; } /** @oneof */ 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 */ 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). */ 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. */ 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?: FeaturePeriodWithLiterals; /** 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. */ declare enum FeaturePeriod { NO_PERIOD = "NO_PERIOD", MILLISECOND = "MILLISECOND", SECOND = "SECOND", MINUTE = "MINUTE", HOUR = "HOUR", DAY = "DAY", WEEK = "WEEK", MONTH = "MONTH", YEAR = "YEAR" } /** @enumType */ type FeaturePeriodWithLiterals = FeaturePeriod | 'NO_PERIOD' | 'MILLISECOND' | 'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'; interface QuotaInfo { /** * Aggregation of how often the customer is allowed to use the feature at the time of the request. * `null` means that the customer has unlimited access to the feature. */ limit?: string | null; /** * Deprecated because a feature can have multiple periods defined. Use `period` in `breakdown` entries instead. * 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). * @deprecated * @replacedBy breakdown.period * @targetRemovalDate 2026-03-31 */ period?: FeaturePeriodWithLiterals; /** * Aggregation of how often the customer has used the feature. * This value is retrieved from the Quota Manager/Rate Limiter system. If the * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`, * this field will contain the value `-1`. */ currentUsage?: string; /** * Aggregation of how often the customer can still use the feature. * `null` means that the customer has unlimited access to the feature. * This value is retrieved from the Quota Manager/Rate Limiter system. If the * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`, * this field will not be populated. */ remainingUsage?: string | null; /** * Breakdown of quota information entries, entry per feature instance. * @maxSize 1000 */ breakdown?: QuotaInfoEntry[]; } interface QuotaInfoEntry { /** * If quota is of free feature, the id would be empty (None). * If quota is of premium feature, this is the ID of the feature instance. * @format GUID */ featureInstanceId?: string | null; /** * 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?: FeaturePeriodWithLiterals; /** * How often the customer has used the feature during the current * period. * This value is retrieved from the Quota Manager/Rate Limiter system. If the * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`, * this field will contain the value `-1`. */ 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. * This value is retrieved from the Quota Manager/Rate Limiter system. If the * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`, * this field will not be populated. */ remainingUsage?: string | null; /** * ID of the subscription to which the feature instance belongs. * @format GUID */ subscriptionId?: string | null; /** * Reset date of the quota. * Relevant only for features with a period that is not `NO_PERIOD`, and only for features that are managed by the Quota Manager system. */ resetDate?: Date | null; } /** Subscription transferred from another account, features on the current account were enabled. */ 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 */ 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 */ interface AssignedFromFloatingReason { } /** New subscription created and features created as enabled */ interface NewFeatureReason { } /** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */ interface ContractSwitchedReason { /** Classification of the contract switch (upgrade, downgrade, or price increase) */ classification?: ContractSwitchClassificationWithLiterals; } /** * Classification of contract switch events for quota reset behavior * Needed to determine whether to reset usage and/or reset date for features affected by the contract switch. * For example, for an upgrade we want to reset both usage and date. * For a downgrade we want to keep the usage and date but update the limit, and for a price increase we want to reset the usage but keep the date. */ declare enum ContractSwitchClassification { /** Unknown or unclassified contract switch */ UNKNOWN = "UNKNOWN", /** Upgrade - reset usage, reset date, and update limit */ UPGRADE = "UPGRADE", /** Downgrade - only update limit (no reset) */ DOWNGRADE = "DOWNGRADE", /** Price increase - reset usage only (not reset date), update limit */ PRICE_INCREASE = "PRICE_INCREASE" } /** @enumType */ type ContractSwitchClassificationWithLiterals = ContractSwitchClassification | 'UNKNOWN' | 'UPGRADE' | 'DOWNGRADE' | 'PRICE_INCREASE'; /** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */ interface ManualFeatureCreationReason { } /** Subscription created due to migration from old premium model */ interface MigratedFromLegacyReason { } /** Feature was synced manually, for example by immigrator task */ interface ManualSyncReason { /** * Optional description of the manual sync source (e.g. "immigrator", "quota-sync"). * @maxLength 100 */ source?: string | null; } /** Feature disabled and can be enabled in the future */ 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 */ 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 */ interface UnAssingedToFloatingReason { } /** Another subscription was assigned to the site, causing existing features on this site to be disabled */ interface ReplacedByAnotherSubscriptionReason { } /** Subscription was assigned to another site, causing features on the origin site to be disabled. */ interface ReassignedToAnotherSiteReason { /** * Information about a transfer to the site. * @format GUID */ reassignedToMetasite?: string; } /** Feature updated, for example Quota was increased due to upgrade */ 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; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; /** * Updated feature. Includes information about the feature's new state and * possibly its new context. */ feature?: Feature; } /** @oneof */ 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 */ interface FeatureUpdatedReasonOneOf { /** Information about the contract switch. */ contractSwitched?: ContractSwitchedReason; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; } /** Feature was permanently cancelled */ 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; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; /** Feature was automatically cancelled because its quota was fully consumed. */ quotaExhausted?: QuotaExhaustedReason; /** Canceled feature. */ feature?: Feature; /** * Information about a transfer to the account. * __Deprecated__. Use `reason.transferred_to_account` instead. * @format GUID */ transferredToAccount?: string | null; } /** @oneof */ 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; /** Information about manual sync (e.g. immigrator task). */ manualSync?: ManualSyncReason; /** Feature was automatically cancelled because its quota was fully consumed. */ quotaExhausted?: QuotaExhaustedReason; } /** Subscription was transferred to another account, features in the origin account were cancelled */ 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 */ interface CancelRequestedReason { } /** Feature was automatically cancelled because its quota was fully consumed (e.g. topup feature) */ interface QuotaExhaustedReason { } /** Quota usage changed for a feature. */ interface FeatureQuotaUsageChanged { /** Full feature state before this quota usage report. */ featureBefore?: Feature; /** Full feature state after this quota usage report. */ featureAfter?: Feature; } interface RefreshTicketsFlagsRequest { } interface RefreshTicketsFlagsResponse { /** Whether any events on the site sell tickets (free or paid). */ sellingTickets?: boolean | null; /** Whether any events on the site sell paid tickets. */ sellingPaidTickets?: boolean | null; } interface UpdateEventsFeeSettingsRequest { /** Whether Wix service fees should be applied to paid ticket sales on this site. */ serviceFeeEnabled?: boolean | null; /** Date when service fees should become active. Used for sites that are enabling fees for the first time. */ serviceFeeActivationDate?: Date | null; /** Date when the site owner agreed to service fee terms. Required for fee activation on older sites. */ serviceFeeActivationAgreementDate?: Date | null; /** * Specific fields to update in the service fee settings. Use this to control which fee-related properties are modified. * @maxSize 4 */ patchFields?: PatchFieldWithLiterals[]; /** * Negotiated percentage above 0 and up to 100. Include FEE_RATE without a value to restore the default 2.5 percent. * @decimalValue options { gt:0, lte:100, maxScale:2 } */ serviceFeeRate?: string | null; } /** Fields that can be updated in service fee settings. */ declare enum PatchField { /** Set the negotiated percentage, or clear it when service_fee_rate is absent. */ FEE_RATE = "FEE_RATE", /** Update whether service fees are enabled for paid ticket sales. */ FEE_ENABLED = "FEE_ENABLED", /** Update the date when service fees became active on the site. */ FEE_ACTIVATION_DATE = "FEE_ACTIVATION_DATE", /** Update the date when the site owner agreed to service fee terms. */ FEE_ACTIVATION_AGREEMENT_DATE = "FEE_ACTIVATION_AGREEMENT_DATE" } /** @enumType */ type PatchFieldWithLiterals = PatchField | 'FEE_RATE' | 'FEE_ENABLED' | 'FEE_ACTIVATION_DATE' | 'FEE_ACTIVATION_AGREEMENT_DATE'; interface UpdateEventsFeeSettingsResponse { /** Updated Events Settings. */ eventsSettings?: EventsSettings; } interface UpdateFeatureOverrideRequest { overrides?: AppFeatures; } interface UpdateFeatureOverrideResponse { eventsSettings?: EventsSettings; overrides?: AppFeatures; } interface CreateSiteBuyerFormRequest { } interface CreateSiteBuyerFormResponse { /** * The id of the created site buyer form. * @format GUID */ buyerFormId?: string | null; } 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; /** Details related to the account */ accountInfo?: AccountInfo; } 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?: WebhookIdentityTypeWithLiterals; } /** @oneof */ 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; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function getEventsSettings(): __PublicMethodMetaInfo<'GET', {}, GetEventsSettingsRequest$1, GetEventsSettingsRequest, GetEventsSettingsResponse$1, GetEventsSettingsResponse>; declare function updateEventsSettings(): __PublicMethodMetaInfo<'PATCH', { eventsSettingsId: string; }, UpdateEventsSettingsRequest$1, UpdateEventsSettingsRequest, UpdateEventsSettingsResponse$1, UpdateEventsSettingsResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, Action as ActionOriginal, type ActionTargetOfOneOf as ActionTargetOfOneOfOriginal, type ActionTarget as ActionTargetOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type AgreeToServiceFeeRequest as AgreeToServiceFeeRequestOriginal, type AgreeToServiceFeeResponse as AgreeToServiceFeeResponseOriginal, type AppFeatures as AppFeaturesOriginal, type AppState as AppStateOriginal, AppStateState as AppStateStateOriginal, type AppStateStateWithLiterals as AppStateStateWithLiteralsOriginal, type Asset as AssetOriginal, type AssignedFromFloatingReason as AssignedFromFloatingReasonOriginal, type BackofficeActionTarget as BackofficeActionTargetOriginal, type BooleanFeature as BooleanFeatureOriginal, type BusinessSchedule as BusinessScheduleOriginal, type CancelRequestedReason as CancelRequestedReasonOriginal, type Categories as CategoriesOriginal, CheckoutType as CheckoutTypeOriginal, type CheckoutTypeWithLiterals as CheckoutTypeWithLiteralsOriginal, type ConsentPolicy as ConsentPolicyOriginal, type Contact as ContactOriginal, ContractSwitchClassification as ContractSwitchClassificationOriginal, type ContractSwitchClassificationWithLiterals as ContractSwitchClassificationWithLiteralsOriginal, type ContractSwitchedReason as ContractSwitchedReasonOriginal, type CreateSiteBuyerFormRequest as CreateSiteBuyerFormRequestOriginal, type CreateSiteBuyerFormResponse as CreateSiteBuyerFormResponseOriginal, type DashboardPageActionTarget as DashboardPageActionTargetOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DelayedPaymentCaptureSettings as DelayedPaymentCaptureSettingsOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EventBadgesSettings as EventBadgesSettingsOriginal, type EventPages as EventPagesOriginal, type EventPagesOverrides as EventPagesOverridesOriginal, type EventsInfo as EventsInfoOriginal, type EventsSettings as EventsSettingsOriginal, type FeatureCancelled as FeatureCancelledOriginal, type FeatureCancelledReasonOneOf as FeatureCancelledReasonOneOfOriginal, type FeatureContext as FeatureContextOriginal, type FeatureDisabled as FeatureDisabledOriginal, type FeatureDisabledReasonOneOf as FeatureDisabledReasonOneOfOriginal, type FeatureEnabled as FeatureEnabledOriginal, type FeatureEnabledReasonOneOf as FeatureEnabledReasonOneOfOriginal, type FeatureEventEventOneOf as FeatureEventEventOneOfOriginal, type FeatureEvent as FeatureEventOriginal, type Feature as FeatureOriginal, FeaturePeriod as FeaturePeriodOriginal, type FeaturePeriodWithLiterals as FeaturePeriodWithLiteralsOriginal, type FeatureQuantityInfoOneOf as FeatureQuantityInfoOneOfOriginal, type FeatureQuotaUsageChanged as FeatureQuotaUsageChangedOriginal, type FeatureUpdated as FeatureUpdatedOriginal, type FeatureUpdatedPreviousQuantityInfoOneOf as FeatureUpdatedPreviousQuantityInfoOneOfOriginal, type FeatureUpdatedReasonOneOf as FeatureUpdatedReasonOneOfOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetEventsSettingsRequest as GetEventsSettingsRequestOriginal, type GetEventsSettingsResponse as GetEventsSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncognitoDetails as IncognitoDetailsOriginal, type LiveSiteActionTarget as LiveSiteActionTargetOriginal, type Locale as LocaleOriginal, type ManualFeatureCreationReason as ManualFeatureCreationReasonOriginal, type ManualSyncReason as ManualSyncReasonOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MigratedFromLegacyReason as MigratedFromLegacyReasonOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewFeatureReason as NewFeatureReasonOriginal, type NewNotificationMessage as NewNotificationMessageOriginal, type NotificationInfo as NotificationInfoOriginal, type NotificationInitiatorInitiatorOneOf as NotificationInitiatorInitiatorOneOfOriginal, type NotificationInitiator as NotificationInitiatorOriginal, type NotificationRecipient as NotificationRecipientOriginal, type NotificationRecipientRecipientTypeOneOf as NotificationRecipientRecipientTypeOneOfOriginal, type NotificationsSpout as NotificationsSpoutOriginal, type NotificationsSpoutSpoutTypeOneOf as NotificationsSpoutSpoutTypeOneOfOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PageUrlV2 as PageUrlV2Original, PatchField as PatchFieldOriginal, type PatchFieldWithLiterals as PatchFieldWithLiteralsOriginal, type PaymentMethod as PaymentMethodOriginal, type PaymentSettings as PaymentSettingsOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, PremiumFeature as PremiumFeatureOriginal, type PremiumFeatureWithLiterals as PremiumFeatureWithLiteralsOriginal, type Properties as PropertiesOriginal, type QuotaExhaustedReason as QuotaExhaustedReasonOriginal, type QuotaFeature as QuotaFeatureOriginal, type QuotaInfoEntry as QuotaInfoEntryOriginal, type QuotaInfo as QuotaInfoOriginal, type ReassignedFromSiteReason as ReassignedFromSiteReasonOriginal, type ReassignedToAnotherSiteReason as ReassignedToAnotherSiteReasonOriginal, type RefreshTicketsFlagsRequest as RefreshTicketsFlagsRequestOriginal, type RefreshTicketsFlagsResponse as RefreshTicketsFlagsResponseOriginal, type ReplacedByAnotherSubscriptionReason as ReplacedByAnotherSubscriptionReasonOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type ServiceFeeSettings as ServiceFeeSettingsOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteInfo as SiteInfoOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SiteMember as SiteMemberOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesUpdated as SitePropertiesUpdatedOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteSettings as SiteSettingsOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TimePeriod as TimePeriodOriginal, type TransferredFromAnotherAccountReason as TransferredFromAnotherAccountReasonOriginal, type TransferredToAnotherAccountReason as TransferredToAnotherAccountReasonOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UnAssingedToFloatingReason as UnAssingedToFloatingReasonOriginal, type UpdateEventsFeeSettingsRequest as UpdateEventsFeeSettingsRequestOriginal, type UpdateEventsFeeSettingsResponse as UpdateEventsFeeSettingsResponseOriginal, type UpdateEventsSettingsRequest as UpdateEventsSettingsRequestOriginal, type UpdateEventsSettingsResponse as UpdateEventsSettingsResponseOriginal, type UpdateFeatureOverrideRequest as UpdateFeatureOverrideRequestOriginal, type UpdateFeatureOverrideResponse as UpdateFeatureOverrideResponseOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, getEventsSettings, updateEventsSettings };