/** Component data */ interface ComponentData extends ComponentDataDataOneOf { /** * Create a widget iframe that users can display on their site. We recommend submitting a proposal before using iframes in your app. * Learn More: https://devforum.wix.com/en/article/widget-components */ widgetComponentData?: WidgetComponentData; /** * Display an iframe as a page on a user's site. * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/iframes/guide-to-page-extensions */ pageComponentData?: PageComponentData; /** * Open an iframe in the Dashboard, or add a link to a page on your platform. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/external-links/about-external-link-extensions */ dashboardComponentData?: DashboardComponentData; /** * Use an invisible iframe to track activity. It’s added to every page on the site (max. 1). * Learn More: https://devforum.wix.com/en/article/worker-components */ workerComponentData?: WorkerComponentData; /** * Inject a script into a site’s HTML code. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/embedded-scripts/about-embedded-scripts */ embeddedScriptComponentData?: EmbeddedScriptComponentData; /** * Extend a site’s CMS to store and manage custom data. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/data-collections/about-data-collections-extensions */ dataComponent?: DataComponent; /** * Display a widget that fits into a predefined slot in a Wix app. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/about-site-plugin-extensions */ widgetPlugin?: WidgetPluginComponentData; /** * Provide custom shipping rates to a site's cart and checkout. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/shipping-rates-integration-service-plugin/introduction */ ecomShippingRates?: ShippingRatesConfig; /** Extend a Wix entity with custom fields for your app */ dataExtensions?: DataExtensionsComponentData; /** * Become a Wix catalog provider and integrate any external repository of sellable items with the Wix eCommerce platform. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalog-service-plugin/introduction */ ecomCatalog?: CatalogSPIConfig; /** * Implement gift card benefits such as balance retrieval, redemption, and voiding transactions. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/gift-cards-service-plugin/introduction */ giftCardsProvider?: GiftCardProviderConfig; /** * Provide SEO keyword suggestions to site collaborators, report quota usage, and provide a page where users can upgrade their plan. * Learn More: https://dev.wix.com/docs/rest/api-reference/marketing/seo-keywords-suggestions-v-1/introduction */ seoKeywordsSuggestions?: SeoKeywordsSuggestionsSPIConfig; /** * Configure a page for your app that will be embedded in the Wix Dashboard. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions */ backOfficePage?: BackOfficePage; /** * Provide custom additional fees that are added to a site's cart and checkout. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/additional-fees-service-plugin/introduction */ ecomAdditionalFees?: AdditionalFeesSPIConfig; /** Bookings Pricing Provider SPI */ bookingsPricingProvider?: BookingsPricingProviderConfig; /** * Apply custom charges to a site based on usage of your app's services. * Learn More: https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/introduction */ premiumCustomCharges?: CustomChargesConfig; /** * Validate items in a site's cart and checkout based on custom logic. * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/validations-integration-spi/introduction */ ecomValidations?: ValidationsSPIConfig; /** * Build a tool that adds functionality to the Wix editors. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/editor-extensions/about-editor-extensions */ editorAddon?: EditorAddon; /** External Database component */ externalDatabaseProvider?: ExternalDatabaseSpiConfig; /** * Integrate your service with Wix's payment process to allow merchants to request and use your services on their Wix sites. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/payment-settings-integration-service-plugin/introduction */ ecomPaymentSettings?: PaymentSettingsSPIConfig; /** * Add a site page that displays selected widgets. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-pages/about-site-page-extensions */ unifiedPage?: UnifiedPage; /** * Multilingual translation schema * Learn More: https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/translation-schema/schema-object */ multilingualTranslationSchema?: MultilingualTranslationSchema; /** Create a reusable modal that can be utilized across multiple pages within your app and in other applications. */ backOfficeModal?: BackOfficeModal; /** * Display a draggable widget on a site using a self-hosted custom element. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-widgets/about-site-widget-extensions */ customElementWidget?: CustomElementWidget; /** * Integrate any external inventory with the Wix eCommerce platform. * Learn More: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/inventory-service-plugin/introduction */ ecomInventory?: InventorySpiConfig; /** Multilingual translation schema group */ multilingualTranslationSchemaGroup?: SchemaGroup; /** * Restriction service plugin for editing products managed by third-party fulfillment apps, such as dropshipping or print-on-demand services * Learn More: https://dev.wix.com/docs/rest/business-solutions/stores/service-plugins/product-restrictions-v3/introduction */ storesProductRestrictions?: ProductRestrictionsConfig; /** Bookings Staff Sorting Provider SPI */ staffSortingProvider?: StaffSortingProviderConfig; /** * Realtime Permissions Provider SPI - integrate with Wix to control who can receive messages on your Wix Realtime channels, by providing a custom permissions check that authorizes whether a subscriber is allowed to subscribe to your app's channels. * Learn More: https://dev.wix.com/docs/sdk/core-modules/realtime/extensions/realtime-permissions-provider/check-subscriber-permissions */ realtimePermissionsProvider?: RealtimePermissionsProviderConfig; } /** An iframe to be displayed on the user’s site */ interface WidgetComponentData { /** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */ fixedPositionOption?: FixedPositionOptions; /** Widget will automatically be stretched to this width after installing it */ widgetWidthType?: WidgetWidthTypeWithLiterals; /** * Widget width size * @max 9999 */ width?: number | null; /** * Widget width height * @max 9999 */ height?: number | null; /** * A public link to the widget endpoint * @format WEB_URL */ widgetEndpointUrl?: string | null; /** A public link to the mobile endpoint */ widgetMobileEndpointUrl?: string | null; /** A public link to the settings endpoint */ settingsEndpointUrl?: string | null; /** A public link to the SEO endpoint */ seoEndpointUrl?: string | null; /** Product display data for this component */ widgetDisplay?: WidgetDisplay; /** When true, this is the default component */ default?: boolean; /** When this is turned on, this page will be added to the site when installing the app, regardless of whether it's the default component or not */ essential?: boolean; /** Published state for this widget */ published?: boolean; /** When true, allow this widget to be added only once */ addOnlyOnce?: boolean; /** * This ID is used to identify your widget endpoint in a Wix site. You can use this ID when using methods of the Wix SDK * @readonly */ tpaWidgetId?: string; /** Where this should be rendered */ position?: Position; /** Article id in settings panel */ helpId?: string | null; /** Default Mobile Height */ defaultMobileHeight?: number | null; /** Min Mobile Height */ minMobileHeight?: number | null; /** Mobile Settings Enabled */ mobileSettingsEnabled?: boolean; /** Mobile article id in settings panel */ mobileHelpId?: string | null; /** * Editor setting version. optional values: 1 (old - deprecated) or 2 (new). default value is 2 * @min 1 * @max 2 */ settingsVersion?: number | null; /** If setting version is 1, this will be the public link to the settings endpoint */ settingsEndpointUrlV1?: string | null; /** A public link to the settings endpoint on ADI editor */ onBoardingSettingsEndpointUrl?: string | null; /** The sub pages list for this component to be rendered in */ subPages?: SubPage[]; /** If this component should be stretched in relation to a form factor (desktop, tablet, mobile) */ isStretched?: IsStretched; /** Any margins this page should have in relation to a form factor (desktop, tablet, mobile) */ margins?: Margins; /** Any docking this page (horizontal / vertical) should have in relation to a form factor (desktop, tablet, mobile) */ docking?: Docking; /** The height of this page in relation to a form factor (desktop, tablet, mobile) */ heightBreakPoints?: Height; /** The width of this page in relation to a form factor (desktop, tablet, mobile) */ widthBreakPoints?: ApiWidth; /** Keep default and let users stretch widget to full width (GFPP) */ addStretchButton?: boolean; /** toggle to mark whether the editor should revoke an app that contains this component. */ excludeFromAutoRevoke?: boolean; /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */ settingsEndpointUrlTemplate?: string | null; /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */ settingsEndpointUrlV1Template?: string | null; /** Add widget to site home page (supported only in server installation currently) */ addToHomePage?: boolean; } /** An iframe to be displayed as a full page on the user’s site */ interface PageComponentData { /** Hide this page from the user’s site menu */ isHidden?: boolean; /** Show in pages menu */ showInPanel?: boolean | null; /** Set page to full width */ isFullWidth?: boolean; /** Keep default and let users stretch page to full width (GFPP) */ addStrechButton?: boolean; /** * A public link to the page endpoint * @format WEB_URL */ pageEndpointUrl?: string | null; /** A public link to the mobile endpoint */ pageMobileEndpointUrl?: string | null; /** A public link to the settings endpoint */ settingsEndpointUrl?: string | null; /** A public link to the SEO endpoint */ seoEndpointUrl?: string | null; /** * When true, this is the default component * Main visual component. One components must be default (no more than 1 component) */ default?: boolean; /** * Second visual component * When this is turned on, this page will be added to the site when installing the app, regardless of whether it's the default component or not */ essential?: boolean; /** Published state for this page */ published?: boolean; /** * This ID is used to identify your page endpoint in a Wix site. You can use this ID when using methods of the Wix SDK * @readonly */ tpaWidgetId?: string; /** Article id in settings panel */ helpId?: string | null; /** Default Mobile Height */ defaultMobileHeight?: number | null; /** Min Mobile Height */ minMobileHeight?: number | null; /** Mobile Settings Enabled */ mobileSettingsEnabled?: boolean; /** Mobile article id in settings panel */ mobileHelpId?: string | null; /** * Editor setting version. optional values: 1 (old - deprecated) or 2 (new). default value is 2 * @min 1 * @max 2 */ settingsVersion?: number | null; /** If setting version is 1, this will be the public link to the settings endpoint */ settingsEndpointUrlV1?: string | null; /** A public link to the settings endpoint on ADI editor */ onBoardingSettingsEndpointUrl?: string | null; /** The padding to use in different views */ padding?: Padding; /** The sub pages list for this component to be rendered in */ subPages?: SubPage[]; /** toggle to mark whether the editor should revoke an app that contains this component. */ excludeFromAutoRevoke?: boolean; /** Options to mark whether this page is replacing other page or is replaced by other page. */ pageReplaceOptions?: PageReplaceOptions; /** Elements in the editor can be linked to this page (a button for example) */ linkable?: boolean | null; /** Should add the page to site menu. defaults to true (will add the page to site menu) */ addToSiteMenu?: boolean | null; /** Should allow multiple instances of the page (allow duplicate the page). defaults to false (will not allow multiple instances of the page) */ multiInstanceEnabled?: boolean; /** * short description about the page * @maxLength 300 */ shortDescription?: string | null; /** When true, this page is displayed as full page on desktop only */ fullPageDesktopOnly?: boolean | null; /** When true, this page is used as a landing page on mobile */ landingPageInMobile?: boolean | null; } /** * An iframe that opens in the user’s Wix Dashboard, * or add a link to open the page directly in your platform. */ interface DashboardComponentData { /** * The dashboard url. * @format WEB_URL */ url?: string; /** * External or Internal dashboard. * The user’s Wix Dashboard (recommended) or your platform or site */ embedded?: boolean; /** * A settings page for users to customize your dashboard * @maxLength 300 */ settingsPageUrl?: string | null; /** @maxLength 300 */ checkStatusUrl?: string | null; published?: boolean | null; hideWixSideMenu?: boolean | null; } /** An invisible iframe to track site activity. It’ll be added to every page on the user’s site */ interface WorkerComponentData { /** * A public link to the worker endpoint * @format WEB_URL */ workerEndpointUrl?: string; } /** Inject third party scripts into the user’s site */ interface EmbeddedScriptComponentData { /** The script */ template?: string; /** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */ name?: string; /** What category of pages this will be embedded on (single, many, none) */ pages?: EmbeddedScriptPagesWithLiterals; /** Where in the HTML this should be embedded */ placement?: EmbeddedScriptPlacementWithLiterals; /** An article explaining how to activate the script */ connectArticleUrl?: string; /** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */ embedCategory?: EmbedCategoryWithLiterals; /** * if the script should be loaded once - default and only supported value is true * @readonly */ loadOnce?: boolean; /** allow developers to decide if their app script can be install on free sites */ allowedForFreeSite?: boolean; /** * The runtime dependencies array to declare the widget packages. * @maxSize 50 */ dependencies?: WixDependency[]; } /** An extension for adding data collections to a site when the app is installed. */ interface DataComponent { /** * Data collections automatically added to a site when the app is installed. * @maxSize 100 */ collections?: Collection[]; } /** A component to be rendered within Widget Slots */ interface WidgetPluginComponentData { /** * ID of the widget used for the plugin component. * @format GUID */ referenceComponentId?: string; /** APIs implemented by the Plugin's widget. */ pluginInterfaces?: PluginInterfaceWithLiterals[]; /** Marketing information about the plugin. */ marketData?: PluginMarketData; /** List of placements where the plugin is allowed to be installed. */ placements?: PluginPlacement[]; /** Widget plugin installation settings. */ installation?: PluginInstallationSettings; } interface ShippingRatesConfig { /** * Base URI where the endpoints are called. * Wix eCommerce appends the endpoint path to the base URI. * For example, to call the Get Shipping Rates endpoint at `https://my-shipping-provider.com/v1/getRates`, * the base URI you provide here is `https://my-shipping-provider.com/`. * @minLength 1 */ deploymentUri?: string; /** * Human-readable name of the shipping provider. * @minLength 1 * @maxLength 64 */ name?: string; /** * Description of the shipping provider. * @maxLength 200 */ description?: string | null; /** * URL to more info about the shipping provider. * @maxLength 200 */ learnMoreUrl?: string | null; /** * URL to reach the shipping provider app's dashboard. * @minLength 1 * @maxLength 2048 * @format WEB_URL */ dashboardUrl?: string | null; /** Whether to require the site owner to define a fallback/default rate. Set to `true` if you do not provide rates as part of the integration. */ fallbackDefinitionMandatory?: boolean; /** * Thumbnail image of the shipping rates provider. Displayed in the shipping settings section in the Dashboard. * The URL must be of an image uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager). * @format WEB_URL */ thumbnailUrl?: string | null; } /** A component holding schema of Data Extensions */ interface DataExtensionsComponentData { /** FQDN of the entity that the application extends */ fqdn?: string; /** Schema of the extended fields in JSON Schema compatible format */ schema?: Record | null; /** * Extension point for this schema. empty string or "ROOT" means regular top level schema * @maxLength 20 */ extensionPoint?: string; } interface CatalogSPIConfig { /** Base URI which Wix eCommerce will call to access Catalog service plugin endpoints. For example, to call the Get Catalog Items endpoint at `https://my-external-catalog.com/get-catalog-items`, the base URI you provide here is `https://my-external-catalog.com`. */ deploymentUri?: string; /** Configuration details for discounts applied to all items in the catalog. */ allItemsDiscount?: DiscountConfig; /** Configuration details for discounts applied to specific items in the catalog. */ specificItemsDiscount?: DiscountConfig; } interface GiftCardProviderConfig { /** The URL of the SPI implementation */ deploymentUri?: string; } interface SeoKeywordsSuggestionsSPIConfig { /** * Base URL of your SEO implementation. Wix sends API requests to endpoints implemented using this URL. * @minLength 1 */ baseUri?: string; /** * URL of the page where users can purchase a paid plan. Wix offers a link to this page when you respond with a value of `false` in quota's `paidPlan` property. * @format WEB_URL */ upgradeUrl?: string | null; /** * List of countries you support for SEO analysis. * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. * @format COUNTRY * @minSize 1 * @maxSize 250 */ supportedCountryCodes?: string[]; /** Whether there is a quota limit in the service. When `true`, the response includes the quota object. */ quotaEnabled?: boolean | null; /** * Your website's landing page. * @format WEB_URL */ landingPageUrl?: string; } /** A page in one of the back-office platforms */ interface BackOfficePage extends BackOfficePageAssetOneOf { /** @format WEB_URL */ iframeUrl?: string; /** The route of the page, must be a valid URL path, relative to the app namespace or app id */ routePath?: string; /** Routes that redirect to this page, these paths should include the original path including the namespace or app id */ previousRoutePaths?: string[]; /** * Page title, also used as sidebar entry label * @minLength 1 */ title?: string; /** False by default, if true, sidebar will be hidden when loading the page */ fullPage?: boolean; /** * Optional: category this page belongs to * @format GUID */ pageCategoryId?: string | null; /** Should the page be shown or hidden in the sidebar, by default a link to the page will be shown */ hideInSidebar?: boolean; /** Sidebar order within the category and app, lower priority means the page is earlier, by default priority is 0, meaning newer pages will appear first */ priority?: number; /** * Which page is active in sidebar when this page is loaded * @format GUID */ activeSidebarPageId?: string | null; /** general component data */ metaData?: ComponentMetaData; /** * [Wix Design System icon](https://www.wix-pages.com/wix-design-system-employees/?path=/story/foundations-icons--icons). * Use the full size key. The icon will be rendered in an appropriate size. * @minLength 3 * @maxLength 50 */ iconKey?: string | null; /** * Anchors for direct navigation to specific sections of the page * @maxSize 50 */ pageAnchors?: PageAnchor[]; /** * Determines how the page layout is rendered. * Allowed values: "standard_view", "builder_view", "expanded_view", default: "standard_view". */ layoutMode?: LayoutModeWithLiterals; /** whether the page supports mobile devices, default is false, meaning the page is redirected to native app */ mobileCompatible?: boolean; } interface AdditionalFeesSPIConfig { /** * Base URI where the endpoints are called. * Wix eCommerce appends the endpoint path to the base URI. * For example, to call the Calculate Additional Fees endpoint at `https://my-additional-fees.com/v1/calculateAdditionalFees`, * the base URI you provide here is `https://my-additional-fees.com/`. */ deploymentUri?: string; } interface BookingsPricingProviderConfig { /** URI where the SPI Implementer is deployed */ deploymentUri?: string; /** User-friendly name of the pricing provider */ pricingProviderName?: string; } /** Component type */ declare enum ComponentType { NONE = "NONE", STUDIO = "STUDIO", PLATFORM = "PLATFORM", WORKER = "WORKER", DASHBOARD = "DASHBOARD", WIDGET = "WIDGET", PAGE = "PAGE", DASHBOARD_PLATFORM = "DASHBOARD_PLATFORM", STUDIO_WIDGET = "STUDIO_WIDGET", EMBEDDED_SCRIPT = "EMBEDDED_SCRIPT", EXTENSION = "EXTENSION", SNIPPET_SOLUTION = "SNIPPET_SOLUTION", DATA_COMPONENT = "DATA_COMPONENT", WEB = "WEB", DC_CONFIG = "DC_CONFIG", WIDGET_OUT_OF_IFRAME = "WIDGET_OUT_OF_IFRAME", PAGE_OUT_OF_IFRAME = "PAGE_OUT_OF_IFRAME", STATIC_FILE = "STATIC_FILE", APP_CONFIG = "APP_CONFIG", MULTIPLE_DASHBOARDS = "MULTIPLE_DASHBOARDS", PAYMENTS_GATEWAY = "PAYMENTS_GATEWAY", CODE_PACKAGE = "CODE_PACKAGE", AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER", INVOICES_ACTIONS = "INVOICES_ACTIONS", DASHBOARD_APPLICATION = "DASHBOARD_APPLICATION", CONTACT_LABELS = "CONTACT_LABELS", WIDGET_PLUGIN = "WIDGET_PLUGIN", CROSS_SELL = "CROSS_SELL", LOCAL_DELIVERY = "LOCAL_DELIVERY", PAYMENT_PROVIDER = "PAYMENT_PROVIDER", ECOM_MEMBERSHIPS = "ECOM_MEMBERSHIPS", ECOM_LINE_ITEMS_ENRICHER = "ECOM_LINE_ITEMS_ENRICHER", ECOM_SHIPPING_RATES = "ECOM_SHIPPING_RATES", SHIPPING_LABEL_CARRIER = "SHIPPING_LABEL_CARRIER", RESTAURANTS_POS = "RESTAURANTS_POS", FICTIONAL_SHIPPING_PROVIDER = "FICTIONAL_SHIPPING_PROVIDER", ALERT_ENRICHER = "ALERT_ENRICHER", DATA_EXTENSIONS = "DATA_EXTENSIONS", GENERIC_HOOKS = "GENERIC_HOOKS", AUTOMATIONS_ACTION_PROVIDER = "AUTOMATIONS_ACTION_PROVIDER", ECOM_CATALOG = "ECOM_CATALOG", BACK_OFFICE_EXTENSION_CONTAINER = "BACK_OFFICE_EXTENSION_CONTAINER", BACK_OFFICE_EXTENSION = "BACK_OFFICE_EXTENSION", AUTOMATIONS_TRIGGER_PROVIDER = "AUTOMATIONS_TRIGGER_PROVIDER", IDENTITY_PRE_REGISTRATION = "IDENTITY_PRE_REGISTRATION", PREMIUM_PRODUCTS_PATHS = "PREMIUM_PRODUCTS_PATHS", ECOM_CUSTOM_SCOPE = "ECOM_CUSTOM_SCOPE", GIFT_CARDS_PROVIDER = "GIFT_CARDS_PROVIDER", DEALER_EXTERNAL_FILTER_PROVIDER = "DEALER_EXTERNAL_FILTER_PROVIDER", ECOM_DROPSHIPPING_PROVIDER = "ECOM_DROPSHIPPING_PROVIDER", INVOICES_PROVIDER = "INVOICES_PROVIDER", SEO_KEYWORDS_SUGGESTIONS = "SEO_KEYWORDS_SUGGESTIONS", ECOM_DISCOUNTS_TRIGGER = "ECOM_DISCOUNTS_TRIGGER", MULTILINGUAL_CONTENT_PROVIDER = "MULTILINGUAL_CONTENT_PROVIDER", APPLICATION_AUTOMATION = "APPLICATION_AUTOMATION", BACK_OFFICE_SIDEBAR_CATEGORY = "BACK_OFFICE_SIDEBAR_CATEGORY", BACK_OFFICE_PAGE = "BACK_OFFICE_PAGE", ECOM_ADDITIONAL_FEES = "ECOM_ADDITIONAL_FEES", PING_USER_NOTIFICATION = "PING_USER_NOTIFICATION", ECOM_RECOMMENDATIONS_PROVIDER = "ECOM_RECOMMENDATIONS_PROVIDER", BOOKINGS_PRICING_PROVIDER = "BOOKINGS_PRICING_PROVIDER", IDENTITY_AUTHENTICATOR = "IDENTITY_AUTHENTICATOR", IDENTITY_IDP_CONNECTOR = "IDENTITY_IDP_CONNECTOR", ITEMS_SELECTION_PROVIDER = "ITEMS_SELECTION_PROVIDER", PORTFOLIO_SYNCED_PROJECTS_PROVIDER = "PORTFOLIO_SYNCED_PROJECTS_PROVIDER", COMMUNICATION_CHANNEL = "COMMUNICATION_CHANNEL", IDENTITY_POST_LOGIN = "IDENTITY_POST_LOGIN", BACK_OFFICE_WIDGET = "BACK_OFFICE_WIDGET", SOCIAL_MARKETING_DESIGN = "SOCIAL_MARKETING_DESIGN", FORMS_SUBMISSIONS_PROVIDER = "FORMS_SUBMISSIONS_PROVIDER", WIX_OFFERING = "WIX_OFFERING", DEV_CENTER_TESTING_COMPONENT = "DEV_CENTER_TESTING_COMPONENT", COMPONENTS_VALIDATOR_PROVIDER = "COMPONENTS_VALIDATOR_PROVIDER", COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER = "COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER", FORMS_SCHEMA_PROVIDER = "FORMS_SCHEMA_PROVIDER", BOOKINGS_EXTERNAL_CALENDAR_PROVIDER = "BOOKINGS_EXTERNAL_CALENDAR_PROVIDER", ECOM_DEFAULT_TAXATION_CATEGORY = "ECOM_DEFAULT_TAXATION_CATEGORY", VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER = "VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER", PING_UOU_NOTIFICATION = "PING_UOU_NOTIFICATION", HEADLESS_OAUTH = "HEADLESS_OAUTH", ECOM_TAX_CALCULATOR_SPI = "ECOM_TAX_CALCULATOR_SPI", COMMENTS_MODERATION_PROVIDER = "COMMENTS_MODERATION_PROVIDER", GRID_APP_FILES_TRANSFORMER = "GRID_APP_FILES_TRANSFORMER", BENEFIT_PROGRAMS_POLICY_PROVIDER = "BENEFIT_PROGRAMS_POLICY_PROVIDER", PREMIUM_CUSTOM_CHARGES = "PREMIUM_CUSTOM_CHARGES", ECOM_VALIDATIONS = "ECOM_VALIDATIONS", COMPONENT_REFERENCE_DATA_PROVIDER = "COMPONENT_REFERENCE_DATA_PROVIDER", WIX_REVIEWS_PRODUCT_CATALOG = "WIX_REVIEWS_PRODUCT_CATALOG", SOCIAL_MARKETING_DESIGNS_PROVIDER = "SOCIAL_MARKETING_DESIGNS_PROVIDER", GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER = "GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER", COMMENTS_FILTER_PROVIDER = "COMMENTS_FILTER_PROVIDER", BILLING_TAX_ID_VALIDATOR = "BILLING_TAX_ID_VALIDATOR", PING_SETTINGS_GROUP = "PING_SETTINGS_GROUP", FORMS_SPAM_SUBMISSIONS_PROVIDER = "FORMS_SPAM_SUBMISSIONS_PROVIDER", EDITOR_ADDON = "EDITOR_ADDON", EXTERNAL_DATABASE_PROVIDER = "EXTERNAL_DATABASE_PROVIDER", ECOM_PAYMENT_SETTINGS = "ECOM_PAYMENT_SETTINGS", NOTIFICATION_TOPIC = "NOTIFICATION_TOPIC", NOTIFICATION_PREFERENCES_FILTER_PROVIDER = "NOTIFICATION_PREFERENCES_FILTER_PROVIDER", BOOKINGS_RESOURCE_TYPES_PROVIDER = "BOOKINGS_RESOURCE_TYPES_PROVIDER", PRICING_PLANS_FORM_CONFIGURATION = "PRICING_PLANS_FORM_CONFIGURATION", USER_NOTIFICATION = "USER_NOTIFICATION", CONTACT_NOTIFICATION = "CONTACT_NOTIFICATION", UNIFIED_PAGE = "UNIFIED_PAGE", AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER = "AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER", PROPOSAL_EDITOR_PROVIDER = "PROPOSAL_EDITOR_PROVIDER", CUSTOM_TABLE_RESERVATIONS_PROVIDER = "CUSTOM_TABLE_RESERVATIONS_PROVIDER", COMMENTS_CONTEXT_PROVIDER = "COMMENTS_CONTEXT_PROVIDER", FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER = "FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER", AUTOMATIONS_VELO_ACTION_PROVIDER = "AUTOMATIONS_VELO_ACTION_PROVIDER", CALENDAR_EVENT_TYPE_PROVIDER = "CALENDAR_EVENT_TYPE_PROVIDER", /** Reserved - previously was `SERVICE_AVAILABILITY_POLICY_PROVIDER` */ RESERVED = "RESERVED", SMS_ACTION_MESSAGE = "SMS_ACTION_MESSAGE", BOOKING_POLICY_PROVIDER = "BOOKING_POLICY_PROVIDER", MULTI_SERVICE_BOOKING_POLICY_PROVIDER = "MULTI_SERVICE_BOOKING_POLICY_PROVIDER", AI_ASSISTANT = "AI_ASSISTANT", FORMS_SUBMISSIONS_EXTENSION_PROVIDER = "FORMS_SUBMISSIONS_EXTENSION_PROVIDER", MULTILINGUAL_TRANSLATION_SCHEMA = "MULTILINGUAL_TRANSLATION_SCHEMA", TAX_CALCULATION_PROVIDER = "TAX_CALCULATION_PROVIDER", TAX_GROUPS_PROVIDER = "TAX_GROUPS_PROVIDER", BACK_OFFICE_MODAL = "BACK_OFFICE_MODAL", DEPLOYMENT_PIPELINE_PROVIDER = "DEPLOYMENT_PIPELINE_PROVIDER", CUSTOM_ELEMENT_WIDGET = "CUSTOM_ELEMENT_WIDGET", BACK_OFFICE_EXTENSION_WIDGET = "BACK_OFFICE_EXTENSION_WIDGET", BACK_OFFICE_EXTENSION_MENU_ITEM = "BACK_OFFICE_EXTENSION_MENU_ITEM", FORM_TEMPLATE = "FORM_TEMPLATE", NOTIFICATION_CONTENT = "NOTIFICATION_CONTENT", BROADCAST_LIST = "BROADCAST_LIST", PARTNERS_PAYOUTS = "PARTNERS_PAYOUTS", WIX_REVIEWS_ENTITY_CATALOG = "WIX_REVIEWS_ENTITY_CATALOG", VELO_PUBLISH_PIPELINE_TASK_PROVIDER = "VELO_PUBLISH_PIPELINE_TASK_PROVIDER", FUNCTIONS_SHOP_PRICE_PROVIDER = "FUNCTIONS_SHOP_PRICE_PROVIDER", FUNCTION = "FUNCTION", ECOM_CHECKOUT_CONTENT = "ECOM_CHECKOUT_CONTENT", COMMUNICATION_CHANNEL_PROVIDER = "COMMUNICATION_CHANNEL_PROVIDER", WEBHOOK = "WEBHOOK", TOPOLOGY = "TOPOLOGY", LOYALTY_CUSTOM_REWARDS = "LOYALTY_CUSTOM_REWARDS", FUNCTION_RECIPE = "FUNCTION_RECIPE", BACK_OFFICE_EXTERNAL_URL = "BACK_OFFICE_EXTERNAL_URL", IDENTITY_FACTOR = "IDENTITY_FACTOR", ECOM_DISCOUNTS = "ECOM_DISCOUNTS", VELO_CUSTOM_CSS = "VELO_CUSTOM_CSS", DEALER_ADAPTIVE_COMPONENT_PROVIDER = "DEALER_ADAPTIVE_COMPONENT_PROVIDER", AI_ASSISTANT_ACTION = "AI_ASSISTANT_ACTION", ECOM_INVENTORY = "ECOM_INVENTORY", MONITORING = "MONITORING", PAPI_PROVIDER = "PAPI_PROVIDER", UNIFIED_LIGHTBOX = "UNIFIED_LIGHTBOX", FORMS_EXTENSION_PROVIDER = "FORMS_EXTENSION_PROVIDER", MULTILINGUAL_TRANSLATION_SCHEMA_GROUP = "MULTILINGUAL_TRANSLATION_SCHEMA_GROUP", PANEL = "PANEL", PREMIUM_PURCHASE_VALIDATIONS = "PREMIUM_PURCHASE_VALIDATIONS", BROWSER_STORAGE = "BROWSER_STORAGE", SDK_DEFINITION = "SDK_DEFINITION", SITE_WIDGET_SLOT = "SITE_WIDGET_SLOT", CALENDAR_EVENT_VALIDATION_PROVIDER = "CALENDAR_EVENT_VALIDATION_PROVIDER", CLIENT_SIDE_SERVICE = "CLIENT_SIDE_SERVICE", BILLING_SETTINGS = "BILLING_SETTINGS", PATTERNS_WIZARD = "PATTERNS_WIZARD", APPLICATION_PROFILE = "APPLICATION_PROFILE", TEXT_TO_SPEECH_ACTION_MESSAGE = "TEXT_TO_SPEECH_ACTION_MESSAGE", AUDIENCE_PROVIDER = "AUDIENCE_PROVIDER", PRICING_PLANS_PRICE = "PRICING_PLANS_PRICE", PRICING_PLAN_START_DATE_LIMITS = "PRICING_PLAN_START_DATE_LIMITS", PRICING_PLAN_START_DATE_RULES = "PRICING_PLAN_START_DATE_RULES", EVENTS_TICKET_RESERVATIONS = "EVENTS_TICKET_RESERVATIONS", PAYMENTS_DISPUTE_SERVICE_PLUGIN = "PAYMENTS_DISPUTE_SERVICE_PLUGIN", PRICING_PLANS_FEES = "PRICING_PLANS_FEES", EDITOR_REACT_COMPONENT = "EDITOR_REACT_COMPONENT", SUPPLIERS_HUB_MARKETPLACE = "SUPPLIERS_HUB_MARKETPLACE", FORM_SCHEMA_DYNAMIC_VALUES = "FORM_SCHEMA_DYNAMIC_VALUES", BLOG_PAYWALL_PROVIDER = "BLOG_PAYWALL_PROVIDER", LOYALTY_CUSTOM_REWARDS_V2 = "LOYALTY_CUSTOM_REWARDS_V2", STORES_PRODUCT_RESTRICTIONS = "STORES_PRODUCT_RESTRICTIONS", FORM_SUBMISSION_MODERATION = "FORM_SUBMISSION_MODERATION", EVENTS_EVENT_BADGES = "EVENTS_EVENT_BADGES", BILLING_OPERATION = "BILLING_OPERATION", BACK_OFFICE_CUSTOMIZATION = "BACK_OFFICE_CUSTOMIZATION", COMPONENT_ENRICHER_PROVIDER = "COMPONENT_ENRICHER_PROVIDER", BACK_OFFICE_RESTRICTED_CUSTOMIZATION = "BACK_OFFICE_RESTRICTED_CUSTOMIZATION", EDITOR_APP_PREVIEWS_POC = "EDITOR_APP_PREVIEWS_POC", LEGENDS_PERSONA_CONFIGURATION = "LEGENDS_PERSONA_CONFIGURATION", WIX_HOSTING_APP_DEPLOYMENT_PROVIDER = "WIX_HOSTING_APP_DEPLOYMENT_PROVIDER", BACKEND_WORKER = "BACKEND_WORKER", EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER", WIX_HOSTING_APP_ENVIRONMENT_PROVIDER = "WIX_HOSTING_APP_ENVIRONMENT_PROVIDER", SDK_EXPORTS = "SDK_EXPORTS", VIEWER_SERVICE = "VIEWER_SERVICE", WIX_PAYMENTS_PROVIDER_ACCOUNT_SERVICE_PLUGIN = "WIX_PAYMENTS_PROVIDER_ACCOUNT_SERVICE_PLUGIN", CONTACTS_SEGMENTS_V2_FILTER_PROVIDER = "CONTACTS_SEGMENTS_V2_FILTER_PROVIDER", ANALYTICS_PRODUCT_CATALOG = "ANALYTICS_PRODUCT_CATALOG", SITE_MIGRATION = "SITE_MIGRATION", RESTAURANTS_POS_PROVIDER_SETTINGS_SERVICE_PLUGIN = "RESTAURANTS_POS_PROVIDER_SETTINGS_SERVICE_PLUGIN", WIX_VIBE_CODING_INSTRUCTIONS = "WIX_VIBE_CODING_INSTRUCTIONS", TAX_EXEMPT_GROUPS_PROVIDER = "TAX_EXEMPT_GROUPS_PROVIDER", BOOKING_AUTOMATIONS_CONFIGURATION = "BOOKING_AUTOMATIONS_CONFIGURATION", WIX_VIBE_COMPONENT = "WIX_VIBE_COMPONENT", WIXEL = "WIXEL", STAFF_SORTING_PROVIDER = "STAFF_SORTING_PROVIDER", FUNCTION_ECOM_DISCOUNT_TRIGGER_ELIGIBILITY_PROVIDER = "FUNCTION_ECOM_DISCOUNT_TRIGGER_ELIGIBILITY_PROVIDER", FUNCTIONS_ASSISTANT_TOOLS = "FUNCTIONS_ASSISTANT_TOOLS", SITE_MAP_INFO_PROVIDER = "SITE_MAP_INFO_PROVIDER", WIX_AI_GATEWAY_CALLBACK = "WIX_AI_GATEWAY_CALLBACK", URL_MAPPER_PROVIDER = "URL_MAPPER_PROVIDER", PROVIDER_SUPPRESSION_SERVICE_PLUGIN = "PROVIDER_SUPPRESSION_SERVICE_PLUGIN", ECOM_FORMS = "ECOM_FORMS", EDITOR_CONTEXT_PROVIDER = "EDITOR_CONTEXT_PROVIDER", EDITOR_FUNCTION_LIBRARY = "EDITOR_FUNCTION_LIBRARY", BOOKINGS_PLATFORM_CONFIGURATION = "BOOKINGS_PLATFORM_CONFIGURATION", BOOKINGS_VALIDATION_PROVIDER = "BOOKINGS_VALIDATION_PROVIDER", APP_ROUTER = "APP_ROUTER", WIXEL_BINDING = "WIXEL_BINDING", SHUB_MARKETPLACE_PROVIDER = "SHUB_MARKETPLACE_PROVIDER", BOOKING_ACTION_URLS_PROVIDER = "BOOKING_ACTION_URLS_PROVIDER", CALENDAR_CONFERENCING_PROVIDER = "CALENDAR_CONFERENCING_PROVIDER", BASS_VALIDATE_CANCEL_ACTION = "BASS_VALIDATE_CANCEL_ACTION", WIXEL_VIEWER_ROUTER_PROVIDER = "WIXEL_VIEWER_ROUTER_PROVIDER", PREMIUM_ACTION = "PREMIUM_ACTION", AUTOMATION_TEMPLATE = "AUTOMATION_TEMPLATE", AGENT_MAKER_APPROVAL_PROVIDER = "AGENT_MAKER_APPROVAL_PROVIDER", SERVICE_TAGS_CONFIGURATION = "SERVICE_TAGS_CONFIGURATION", LOYALTY_POINTS_ADJUSTMENT = "LOYALTY_POINTS_ADJUSTMENT", LOYALTY_EARN_POINTS_LIMIT = "LOYALTY_EARN_POINTS_LIMIT", REALTIME_PERMISSIONS_PROVIDER = "REALTIME_PERMISSIONS_PROVIDER", CALENDAR_SEARCH_PROVIDER = "CALENDAR_SEARCH_PROVIDER", EDITOR_INSTALLATION = "EDITOR_INSTALLATION", APP_ACTIONS = "APP_ACTIONS", ROLLOUT_STEP_EXECUTOR = "ROLLOUT_STEP_EXECUTOR", BOOKINGS_PLATFORM_PREMIUM_VALIDATION = "BOOKINGS_PLATFORM_PREMIUM_VALIDATION", GLOBAL_CSS = "GLOBAL_CSS", CONNECTOR_CONFIG = "CONNECTOR_CONFIG", CHANNEL_DATA_PROVIDER = "CHANNEL_DATA_PROVIDER" } /** @enumType */ type ComponentTypeWithLiterals = ComponentType | 'NONE' | 'STUDIO' | 'PLATFORM' | 'WORKER' | 'DASHBOARD' | 'WIDGET' | 'PAGE' | 'DASHBOARD_PLATFORM' | 'STUDIO_WIDGET' | 'EMBEDDED_SCRIPT' | 'EXTENSION' | 'SNIPPET_SOLUTION' | 'DATA_COMPONENT' | 'WEB' | 'DC_CONFIG' | 'WIDGET_OUT_OF_IFRAME' | 'PAGE_OUT_OF_IFRAME' | 'STATIC_FILE' | 'APP_CONFIG' | 'MULTIPLE_DASHBOARDS' | 'PAYMENTS_GATEWAY' | 'CODE_PACKAGE' | 'AUTOMATION_TRIGGER' | 'INVOICES_ACTIONS' | 'DASHBOARD_APPLICATION' | 'CONTACT_LABELS' | 'WIDGET_PLUGIN' | 'CROSS_SELL' | 'LOCAL_DELIVERY' | 'PAYMENT_PROVIDER' | 'ECOM_MEMBERSHIPS' | 'ECOM_LINE_ITEMS_ENRICHER' | 'ECOM_SHIPPING_RATES' | 'SHIPPING_LABEL_CARRIER' | 'RESTAURANTS_POS' | 'FICTIONAL_SHIPPING_PROVIDER' | 'ALERT_ENRICHER' | 'DATA_EXTENSIONS' | 'GENERIC_HOOKS' | 'AUTOMATIONS_ACTION_PROVIDER' | 'ECOM_CATALOG' | 'BACK_OFFICE_EXTENSION_CONTAINER' | 'BACK_OFFICE_EXTENSION' | 'AUTOMATIONS_TRIGGER_PROVIDER' | 'IDENTITY_PRE_REGISTRATION' | 'PREMIUM_PRODUCTS_PATHS' | 'ECOM_CUSTOM_SCOPE' | 'GIFT_CARDS_PROVIDER' | 'DEALER_EXTERNAL_FILTER_PROVIDER' | 'ECOM_DROPSHIPPING_PROVIDER' | 'INVOICES_PROVIDER' | 'SEO_KEYWORDS_SUGGESTIONS' | 'ECOM_DISCOUNTS_TRIGGER' | 'MULTILINGUAL_CONTENT_PROVIDER' | 'APPLICATION_AUTOMATION' | 'BACK_OFFICE_SIDEBAR_CATEGORY' | 'BACK_OFFICE_PAGE' | 'ECOM_ADDITIONAL_FEES' | 'PING_USER_NOTIFICATION' | 'ECOM_RECOMMENDATIONS_PROVIDER' | 'BOOKINGS_PRICING_PROVIDER' | 'IDENTITY_AUTHENTICATOR' | 'IDENTITY_IDP_CONNECTOR' | 'ITEMS_SELECTION_PROVIDER' | 'PORTFOLIO_SYNCED_PROJECTS_PROVIDER' | 'COMMUNICATION_CHANNEL' | 'IDENTITY_POST_LOGIN' | 'BACK_OFFICE_WIDGET' | 'SOCIAL_MARKETING_DESIGN' | 'FORMS_SUBMISSIONS_PROVIDER' | 'WIX_OFFERING' | 'DEV_CENTER_TESTING_COMPONENT' | 'COMPONENTS_VALIDATOR_PROVIDER' | 'COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER' | 'FORMS_SCHEMA_PROVIDER' | 'BOOKINGS_EXTERNAL_CALENDAR_PROVIDER' | 'ECOM_DEFAULT_TAXATION_CATEGORY' | 'VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER' | 'PING_UOU_NOTIFICATION' | 'HEADLESS_OAUTH' | 'ECOM_TAX_CALCULATOR_SPI' | 'COMMENTS_MODERATION_PROVIDER' | 'GRID_APP_FILES_TRANSFORMER' | 'BENEFIT_PROGRAMS_POLICY_PROVIDER' | 'PREMIUM_CUSTOM_CHARGES' | 'ECOM_VALIDATIONS' | 'COMPONENT_REFERENCE_DATA_PROVIDER' | 'WIX_REVIEWS_PRODUCT_CATALOG' | 'SOCIAL_MARKETING_DESIGNS_PROVIDER' | 'GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER' | 'COMMENTS_FILTER_PROVIDER' | 'BILLING_TAX_ID_VALIDATOR' | 'PING_SETTINGS_GROUP' | 'FORMS_SPAM_SUBMISSIONS_PROVIDER' | 'EDITOR_ADDON' | 'EXTERNAL_DATABASE_PROVIDER' | 'ECOM_PAYMENT_SETTINGS' | 'NOTIFICATION_TOPIC' | 'NOTIFICATION_PREFERENCES_FILTER_PROVIDER' | 'BOOKINGS_RESOURCE_TYPES_PROVIDER' | 'PRICING_PLANS_FORM_CONFIGURATION' | 'USER_NOTIFICATION' | 'CONTACT_NOTIFICATION' | 'UNIFIED_PAGE' | 'AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'PROPOSAL_EDITOR_PROVIDER' | 'CUSTOM_TABLE_RESERVATIONS_PROVIDER' | 'COMMENTS_CONTEXT_PROVIDER' | 'FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER' | 'AUTOMATIONS_VELO_ACTION_PROVIDER' | 'CALENDAR_EVENT_TYPE_PROVIDER' | 'RESERVED' | 'SMS_ACTION_MESSAGE' | 'BOOKING_POLICY_PROVIDER' | 'MULTI_SERVICE_BOOKING_POLICY_PROVIDER' | 'AI_ASSISTANT' | 'FORMS_SUBMISSIONS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA' | 'TAX_CALCULATION_PROVIDER' | 'TAX_GROUPS_PROVIDER' | 'BACK_OFFICE_MODAL' | 'DEPLOYMENT_PIPELINE_PROVIDER' | 'CUSTOM_ELEMENT_WIDGET' | 'BACK_OFFICE_EXTENSION_WIDGET' | 'BACK_OFFICE_EXTENSION_MENU_ITEM' | 'FORM_TEMPLATE' | 'NOTIFICATION_CONTENT' | 'BROADCAST_LIST' | 'PARTNERS_PAYOUTS' | 'WIX_REVIEWS_ENTITY_CATALOG' | 'VELO_PUBLISH_PIPELINE_TASK_PROVIDER' | 'FUNCTIONS_SHOP_PRICE_PROVIDER' | 'FUNCTION' | 'ECOM_CHECKOUT_CONTENT' | 'COMMUNICATION_CHANNEL_PROVIDER' | 'WEBHOOK' | 'TOPOLOGY' | 'LOYALTY_CUSTOM_REWARDS' | 'FUNCTION_RECIPE' | 'BACK_OFFICE_EXTERNAL_URL' | 'IDENTITY_FACTOR' | 'ECOM_DISCOUNTS' | 'VELO_CUSTOM_CSS' | 'DEALER_ADAPTIVE_COMPONENT_PROVIDER' | 'AI_ASSISTANT_ACTION' | 'ECOM_INVENTORY' | 'MONITORING' | 'PAPI_PROVIDER' | 'UNIFIED_LIGHTBOX' | 'FORMS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA_GROUP' | 'PANEL' | 'PREMIUM_PURCHASE_VALIDATIONS' | 'BROWSER_STORAGE' | 'SDK_DEFINITION' | 'SITE_WIDGET_SLOT' | 'CALENDAR_EVENT_VALIDATION_PROVIDER' | 'CLIENT_SIDE_SERVICE' | 'BILLING_SETTINGS' | 'PATTERNS_WIZARD' | 'APPLICATION_PROFILE' | 'TEXT_TO_SPEECH_ACTION_MESSAGE' | 'AUDIENCE_PROVIDER' | 'PRICING_PLANS_PRICE' | 'PRICING_PLAN_START_DATE_LIMITS' | 'PRICING_PLAN_START_DATE_RULES' | 'EVENTS_TICKET_RESERVATIONS' | 'PAYMENTS_DISPUTE_SERVICE_PLUGIN' | 'PRICING_PLANS_FEES' | 'EDITOR_REACT_COMPONENT' | 'SUPPLIERS_HUB_MARKETPLACE' | 'FORM_SCHEMA_DYNAMIC_VALUES' | 'BLOG_PAYWALL_PROVIDER' | 'LOYALTY_CUSTOM_REWARDS_V2' | 'STORES_PRODUCT_RESTRICTIONS' | 'FORM_SUBMISSION_MODERATION' | 'EVENTS_EVENT_BADGES' | 'BILLING_OPERATION' | 'BACK_OFFICE_CUSTOMIZATION' | 'COMPONENT_ENRICHER_PROVIDER' | 'BACK_OFFICE_RESTRICTED_CUSTOMIZATION' | 'EDITOR_APP_PREVIEWS_POC' | 'LEGENDS_PERSONA_CONFIGURATION' | 'WIX_HOSTING_APP_DEPLOYMENT_PROVIDER' | 'BACKEND_WORKER' | 'EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'WIX_HOSTING_APP_ENVIRONMENT_PROVIDER' | 'SDK_EXPORTS' | 'VIEWER_SERVICE' | 'WIX_PAYMENTS_PROVIDER_ACCOUNT_SERVICE_PLUGIN' | 'CONTACTS_SEGMENTS_V2_FILTER_PROVIDER' | 'ANALYTICS_PRODUCT_CATALOG' | 'SITE_MIGRATION' | 'RESTAURANTS_POS_PROVIDER_SETTINGS_SERVICE_PLUGIN' | 'WIX_VIBE_CODING_INSTRUCTIONS' | 'TAX_EXEMPT_GROUPS_PROVIDER' | 'BOOKING_AUTOMATIONS_CONFIGURATION' | 'WIX_VIBE_COMPONENT' | 'WIXEL' | 'STAFF_SORTING_PROVIDER' | 'FUNCTION_ECOM_DISCOUNT_TRIGGER_ELIGIBILITY_PROVIDER' | 'FUNCTIONS_ASSISTANT_TOOLS' | 'SITE_MAP_INFO_PROVIDER' | 'WIX_AI_GATEWAY_CALLBACK' | 'URL_MAPPER_PROVIDER' | 'PROVIDER_SUPPRESSION_SERVICE_PLUGIN' | 'ECOM_FORMS' | 'EDITOR_CONTEXT_PROVIDER' | 'EDITOR_FUNCTION_LIBRARY' | 'BOOKINGS_PLATFORM_CONFIGURATION' | 'BOOKINGS_VALIDATION_PROVIDER' | 'APP_ROUTER' | 'WIXEL_BINDING' | 'SHUB_MARKETPLACE_PROVIDER' | 'BOOKING_ACTION_URLS_PROVIDER' | 'CALENDAR_CONFERENCING_PROVIDER' | 'BASS_VALIDATE_CANCEL_ACTION' | 'WIXEL_VIEWER_ROUTER_PROVIDER' | 'PREMIUM_ACTION' | 'AUTOMATION_TEMPLATE' | 'AGENT_MAKER_APPROVAL_PROVIDER' | 'SERVICE_TAGS_CONFIGURATION' | 'LOYALTY_POINTS_ADJUSTMENT' | 'LOYALTY_EARN_POINTS_LIMIT' | 'REALTIME_PERMISSIONS_PROVIDER' | 'CALENDAR_SEARCH_PROVIDER' | 'EDITOR_INSTALLATION' | 'APP_ACTIONS' | 'ROLLOUT_STEP_EXECUTOR' | 'BOOKINGS_PLATFORM_PREMIUM_VALIDATION' | 'GLOBAL_CSS' | 'CONNECTOR_CONFIG' | 'CHANNEL_DATA_PROVIDER'; interface CustomChargesConfig { /** * Base URI where the endpoints are called. Wix appends the endpoint path to the base URI. * * For example, to call the Premium Custom Charges endpoint at `https://custom-charges.com/v1/premium-custom-charges`, the base URI you provide here is `https://custom-charges.com/`. */ baseUri?: SpiBaseUri; } interface ValidationsSPIConfig { /** Whether to validate the cart page in addition to the checkout page. Default: `false` */ validateInCart?: boolean; /** * Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI. * For example, to call the Get Validation Violations endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`. * @minLength 1 */ deploymentUri?: string; } /** Editor Add-on component */ interface EditorAddon { /** * Deprecated, use editor_script * @format WEB_URL * @deprecated Deprecated, use editor_script * @replacedBy editor_script * @targetRemovalDate 2025-06-01 */ editorScriptUrl?: string; /** Tool panel configuration. */ toolPanelConfig?: ToolPanelConfig; /** Information to display in the addons market. */ marketData?: AddonMarketData; /** * Optional, path to a Javascript file that will run in Editor environment * @format WEB_URL */ editorScript?: string | null; /** Toggle to mark whether the editor should revoke an app that contains this component. */ excludeFromAutoRevoke?: boolean; } interface ExternalDatabaseSpiConfig { /** The URI where the service provider is deployed. */ uriConfig?: SpiBaseUri; /** The namespace of the external database. This can be used to access collections within the database, for example `namespace/collectionId`. */ namespace?: string; } interface PaymentSettingsSPIConfig { /** * Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. * For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`, the base URI you provide here is `https://my-payment-settings.com/`. */ deploymentUri?: string; /** * The fallback value that is used for [`requires3dSecure`](https://support.wix.com/en/article/about-3d-secure-3ds-payments-with-third-party-payment-providers) if the service plugin call fails. * * Default: `false` */ fallbackValueForRequires3dSecure?: boolean; } interface UnifiedPage { /** Base info of component by shared logic of unified components */ base?: BaseInfo; /** * Page installation settings * @deprecated Page installation settings * @replacedBy editor_settings * @targetRemovalDate 2026-02-26 */ installation?: PageInstallationSettings; /** Page replacing options (replacer \ replacing \ none) */ pageReplace?: PageReplaceOptions; /** Content of page */ content?: PageContent; /** Settings for how the page integrates with the editor */ editorSettings?: UnifiedPageEditorSettings; } interface MultilingualTranslationSchema { referenceData?: Schema; } /** A modal in one of the back-office platforms */ interface BackOfficeModal extends BackOfficeModalContentOneOf { /** * Iframe URL that hosts the modal's content. * @format WEB_URL */ iframeUrl?: string; /** * Platform that hosts the modal. * * Must be `"BUSINESS_MANAGER"`. */ hostingPlatform?: BackOfficeHostingPlatformsWithLiterals; /** * Modal title. * @minLength 1 */ title?: string; /** * Initial width of the modal while loading, in pixels. * Width may be adjusted dynamically based on the content of the modal or limited by the size of the modal's container. * @max 9999 */ width?: number | null; /** * Initial height of the modal while loading, in pixels. * Height may be adjusted dynamically based on the content of the modal or limited by the size of the modal's container. * @max 9999 */ height?: number | null; /** general component data */ metaData?: ComponentMetaData; /** * [Wix Design System icon](https://www.wix-pages.com/wix-design-system-employees/?path=/story/foundations-icons--icons). * Use the full size key. The icon will be rendered in an appropriate size. * @minLength 3 * @maxLength 50 */ iconKey?: string | null; } interface CustomElementWidget { /** Base info of component by shared logic of unified components */ base?: BaseInfo; /** Unified widget installation settings */ installation?: WidgetInstallationSettings; /** The extension data for this component */ widgetData?: WidgetData; /** The widget's editor behaviors */ behaviors?: EditorBehaviors; /** The size of the widget */ size?: WidgetSize; /** * The runtime dependencies array to declare the widget packages. * @maxSize 50 */ dependencies?: WixDependency[]; /** * The array of this widget's presets * @maxSize 50 */ presets?: Preset[]; } interface InventorySpiConfig { /** * Base URI where the endpoints are called. * Wix eCommerce appends the endpoint path to the base URI. * @minLength 1 * @maxLength 200 */ deploymentUri?: string; } interface SchemaGroup { /** * SchemaGroup ID. Field is read only. * @format GUID * @readonly */ id?: string | null; /** * Date and time the SchemaGroup was created. Field is read only. * @readonly */ createdDate?: Date | null; /** * Date and time the SchemaGroup was last updated. Field is read only. * @readonly */ updatedDate?: Date | null; /** * Name of the SchemaGroup. Max symbol length is 100. Field is translatable. * @maxLength 100 */ name?: string | null; /** * List of Schemas. * @maxSize 50 */ groupElements?: SchemaGroupElement[]; } interface ProductRestrictionsConfig { /** URI where the SPI Implementer is deployed */ deploymentUri?: SpiBaseUri; /** Product restrictions configuration. */ productRestrictionsConfig?: RestrictionsConfig; } interface StaffSortingProviderConfig { /** URI where the SPI Implementer is deployed */ deploymentUri?: SpiBaseUri; /** * User-friendly name for the sorting method * @maxLength 100 */ methodName?: string; /** * User-friendly explanation about the sorting method. * @maxLength 100 */ methodDescription?: string; /** * Optional. An unique identifier for a component that will create a configuration for the method. * @format GUID */ dashboardPluginId?: string | null; } interface RealtimePermissionsProviderConfig { /** The URI where the SPI Implementer is deployed */ deploymentUri?: SpiBaseUri; /** * A user-friendly name of the permissions provider * @maxLength 100 */ providerName?: string; } interface ExtensionData { compId: string; compType: ComponentType; compData: ComponentData; compName?: string; } /** * Create a widget iframe that users can display on their site. We recommend submitting a proposal before using iframes in your app. * Learn More: https://devforum.wix.com/en/article/widget-components * @param id - A unique identifier for the extension * @param data - An iframe to be displayed on the user’s site * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function widget({ id, data, name, }: { id: string; data: WidgetComponentData; name?: string; }): ExtensionData; /** * Display an iframe as a page on a user's site. * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/iframes/guide-to-page-extensions * @param id - A unique identifier for the extension * @param data - An iframe to be displayed as a full page on the user’s site * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function page({ id, data, name, }: { id: string; data: PageComponentData; name?: string; }): ExtensionData; /** * Open an iframe in the Dashboard, or add a link to a page on your platform. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/external-links/about-external-link-extensions * @param id - A unique identifier for the extension * @param data - An iframe that opens in the user’s Wix Dashboard, * or add a link to open the page directly in your platform. * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function dashboard({ id, data, name, }: { id: string; data: DashboardComponentData; name?: string; }): ExtensionData; /** * Use an invisible iframe to track activity. It’s added to every page on the site (max. 1). * Learn More: https://devforum.wix.com/en/article/worker-components * @param id - A unique identifier for the extension * @param data - An invisible iframe to track site activity. It’ll be added to every page on the user’s site * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function worker({ id, data, name, }: { id: string; data: WorkerComponentData; name?: string; }): ExtensionData; /** * Inject a script into a site’s HTML code. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/embedded-scripts/about-embedded-scripts * @param id - A unique identifier for the extension * @param data - Inject third party scripts into the user’s site * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function embeddedScript({ id, data, name, }: { id: string; data: EmbeddedScriptComponentData; name?: string; }): ExtensionData; /** * Extend a site’s CMS to store and manage custom data. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/data-collections/about-data-collections-extensions * @param id - A unique identifier for the extension * @param data - An extension for adding data collections to a site when the app is installed. * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function dataComponent({ id, data, name, }: { id: string; data: DataComponent; name?: string; }): ExtensionData; /** * Display a widget that fits into a predefined slot in a Wix app. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/about-site-plugin-extensions * @param id - A unique identifier for the extension * @param data - A component to be rendered within Widget Slots * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function widgetPlugin({ id, data, name, }: { id: string; data: WidgetPluginComponentData; name?: string; }): ExtensionData; /** * Provide custom shipping rates to a site's cart and checkout. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/shipping-rates-integration-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomShippingRates({ id, data, name, }: { id: string; data: ShippingRatesConfig; name?: string; }): ExtensionData; /** * Extend a Wix entity with custom fields for your app * @param id - A unique identifier for the extension * @param data - A component holding schema of Data Extensions * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function dataExtensions({ id, data, name, }: { id: string; data: DataExtensionsComponentData; name?: string; }): ExtensionData; /** * Become a Wix catalog provider and integrate any external repository of sellable items with the Wix eCommerce platform. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalog-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomCatalog({ id, data, name, }: { id: string; data: CatalogSPIConfig; name?: string; }): ExtensionData; /** * Implement gift card benefits such as balance retrieval, redemption, and voiding transactions. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/gift-cards-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function giftCardsProvider({ id, data, name, }: { id: string; data: GiftCardProviderConfig; name?: string; }): ExtensionData; /** * Provide SEO keyword suggestions to site collaborators, report quota usage, and provide a page where users can upgrade their plan. * Learn More: https://dev.wix.com/docs/rest/api-reference/marketing/seo-keywords-suggestions-v-1/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function seoKeywordsSuggestions({ id, data, name, }: { id: string; data: SeoKeywordsSuggestionsSPIConfig; name?: string; }): ExtensionData; /** * Configure a page for your app that will be embedded in the Wix Dashboard. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions * @param id - A unique identifier for the extension * @param data - A page in one of the back-office platforms * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function backOfficePage({ id, data, name, }: { id: string; data: BackOfficePage; name?: string; }): ExtensionData; /** * Provide custom additional fees that are added to a site's cart and checkout. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/additional-fees-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomAdditionalFees({ id, data, name, }: { id: string; data: AdditionalFeesSPIConfig; name?: string; }): ExtensionData; /** * Bookings Pricing Provider SPI * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function bookingsPricingProvider({ id, data, name, }: { id: string; data: BookingsPricingProviderConfig; name?: string; }): ExtensionData; /** * Apply custom charges to a site based on usage of your app's services. * Learn More: https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function premiumCustomCharges({ id, data, name, }: { id: string; data: CustomChargesConfig; name?: string; }): ExtensionData; /** * Validate items in a site's cart and checkout based on custom logic. * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/validations-integration-spi/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomValidations({ id, data, name, }: { id: string; data: ValidationsSPIConfig; name?: string; }): ExtensionData; /** * Build a tool that adds functionality to the Wix editors. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/editor-extensions/about-editor-extensions * @param id - A unique identifier for the extension * @param data - Editor Add-on component * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function editorAddon({ id, data, name, }: { id: string; data: EditorAddon; name?: string; }): ExtensionData; /** * External Database component * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function externalDatabaseProvider({ id, data, name, }: { id: string; data: ExternalDatabaseSpiConfig; name?: string; }): ExtensionData; /** * Integrate your service with Wix's payment process to allow merchants to request and use your services on their Wix sites. * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/payment-settings-integration-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomPaymentSettings({ id, data, name, }: { id: string; data: PaymentSettingsSPIConfig; name?: string; }): ExtensionData; /** * Add a site page that displays selected widgets. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-pages/about-site-page-extensions * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function unifiedPage({ id, data, name, }: { id: string; data: UnifiedPage; name?: string; }): ExtensionData; /** * Multilingual translation schema * Learn More: https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/translation-schema/schema-object * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function multilingualTranslationSchema({ id, data, name, }: { id: string; data: MultilingualTranslationSchema; name?: string; }): ExtensionData; /** * Create a reusable modal that can be utilized across multiple pages within your app and in other applications. * @param id - A unique identifier for the extension * @param data - A modal in one of the back-office platforms * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function backOfficeModal({ id, data, name, }: { id: string; data: BackOfficeModal; name?: string; }): ExtensionData; /** * Display a draggable widget on a site using a self-hosted custom element. * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-widgets/about-site-widget-extensions * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function customElementWidget({ id, data, name, }: { id: string; data: CustomElementWidget; name?: string; }): ExtensionData; /** * Integrate any external inventory with the Wix eCommerce platform. * Learn More: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/inventory-service-plugin/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function ecomInventory({ id, data, name, }: { id: string; data: InventorySpiConfig; name?: string; }): ExtensionData; /** * Multilingual translation schema group * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function multilingualTranslationSchemaGroup({ id, data, name, }: { id: string; data: SchemaGroup; name?: string; }): ExtensionData; /** * Restriction service plugin for editing products managed by third-party fulfillment apps, such as dropshipping or print-on-demand services * Learn More: https://dev.wix.com/docs/rest/business-solutions/stores/service-plugins/product-restrictions-v3/introduction * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function storesProductRestrictions({ id, data, name, }: { id: string; data: ProductRestrictionsConfig; name?: string; }): ExtensionData; /** * Bookings Staff Sorting Provider SPI * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function staffSortingProvider({ id, data, name, }: { id: string; data: StaffSortingProviderConfig; name?: string; }): ExtensionData; /** * Realtime Permissions Provider SPI - integrate with Wix to control who can receive messages on your Wix Realtime channels, by providing a custom permissions check that authorizes whether a subscriber is allowed to subscribe to your app's channels. * Learn More: https://dev.wix.com/docs/sdk/core-modules/realtime/extensions/realtime-permissions-provider/check-subscriber-permissions * @param id - A unique identifier for the extension * @param name - Optional - A human readable name for the extension * @returns A general form of extensions */ declare function realtimePermissionsProvider({ id, data, name, }: { id: string; data: RealtimePermissionsProviderConfig; name?: string; }): ExtensionData; export { type AdditionalFeesSPIConfig, type BackOfficeModal, type BackOfficePage, type BookingsPricingProviderConfig, type CatalogSPIConfig, type ComponentData, ComponentType, type ComponentTypeWithLiterals, type CustomChargesConfig, type CustomElementWidget, type DashboardComponentData, type DataComponent, type DataExtensionsComponentData, type EditorAddon, type EmbeddedScriptComponentData, type ExtensionData, type ExternalDatabaseSpiConfig, type GiftCardProviderConfig, type InventorySpiConfig, type MultilingualTranslationSchema, type PageComponentData, type PaymentSettingsSPIConfig, type ProductRestrictionsConfig, type RealtimePermissionsProviderConfig, type SchemaGroup, type SeoKeywordsSuggestionsSPIConfig, type ShippingRatesConfig, type StaffSortingProviderConfig, type UnifiedPage, type ValidationsSPIConfig, type WidgetComponentData, type WidgetPluginComponentData, type WorkerComponentData, backOfficeModal, backOfficePage, bookingsPricingProvider, customElementWidget, dashboard, dataComponent, dataExtensions, ecomAdditionalFees, ecomCatalog, ecomInventory, ecomPaymentSettings, ecomShippingRates, ecomValidations, editorAddon, embeddedScript, externalDatabaseProvider, giftCardsProvider, multilingualTranslationSchema, multilingualTranslationSchemaGroup, page, premiumCustomCharges, realtimePermissionsProvider, seoKeywordsSuggestions, staffSortingProvider, storesProductRestrictions, unifiedPage, widget, widgetPlugin, worker };