@wix/auto_sdk_data-extension-schema_schemas 1.0.0 → 1.0.1

package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts

@@ -508,7 +508,10 @@ export declare enum ComponentType {
     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"
+    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"
 }
 /** Component data */
 export interface ComponentData extends ComponentDataDataOneOf {
@@ -1452,11 +1455,30 @@ export interface HelpResources {
     /** The Wix Answers' article related to the component (chosen by own app) */
     articleId?: string;
 }
-export interface WidgetInstallationSettings {
-    /** Shared installation settings for unified components */
+export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
+    /** Which static container should the widget be installed at */
+    staticContainer?: StaticContainer;
+    /**
+     * Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
+     * @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
+     * @replacedBy static_container
+     * @targetRemovalDate 2026-02-26
+     */
     base?: BaseInstallation;
-    /** Widget installation settings for unified components */
+    /**
+     * Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
+     * @deprecated Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
+     * @replacedBy presets
+     * @targetRemovalDate 2026-02-26
+     */
     widget?: WidgetInstallation;
+    /** Default presets per breakpoint with which the widget should be installed */
+    presets?: DefaultPresets;
+}
+/** @oneof */
+export interface WidgetInstallationSettingsTargetContainerOneOf {
+    /** Which static container should the widget be installed at */
+    staticContainer?: StaticContainer;
 }
 export interface BaseInstallation {
     /** Auto add component to stage */
@@ -1477,6 +1499,17 @@ export declare enum RegionType {
     BODY = "BODY",
     FOOTER = "FOOTER"
 }
+export interface DefaultPresets {
+    /** Default preset ID in small (mobile) breakpoint */
+    small?: string | null;
+    /** Default preset ID in large (desktop) breakpoint */
+    large?: string | null;
+}
+export declare enum StaticContainer {
+    UNKNOWN_CONTAINER = "UNKNOWN_CONTAINER",
+    /** Widget should be installed in the homepage */
+    HOMEPAGE = "HOMEPAGE"
+}
 export interface ComponentModel {
     /** The component type of the builder component. */
     componentType?: string;
@@ -2601,13 +2634,13 @@ export interface ActionSPIConfig {
      */
     executionType?: ExecutionType;
     /** Chosen interface for action */
-    interfaceConfiguration?: InterfaceConfiguration;
+    interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
     /** Icon representing the action in the UI */
     icon?: string;
     /** The action configuration source information */
     source?: Source;
 }
-export declare enum InterfaceConfigurationType {
+export declare enum ActionSPIConfigInterfaceConfigurationType {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
     WIDGET_COMPONENT = "WIDGET_COMPONENT",
     GENERIC = "GENERIC"
@@ -2668,14 +2701,14 @@ export interface Metadata {
     /** Show action only to advanced mode users (Wix staff) */
     hidden?: boolean;
 }
-export interface InterfaceConfiguration extends InterfaceConfigurationOptionsOneOf {
+export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigInterfaceConfigurationOptionsOneOf {
     widgetComponentOptions?: WidgetComponentOptions;
     genericOptions?: GenericOptions;
     /** Type of chosen interface */
-    type?: InterfaceConfigurationType;
+    type?: ActionSPIConfigInterfaceConfigurationType;
 }
 /** @oneof */
-export interface InterfaceConfigurationOptionsOneOf {
+export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
     widgetComponentOptions?: WidgetComponentOptions;
     genericOptions?: GenericOptions;
 }
@@ -4511,7 +4544,7 @@ export interface GIFData {
     height?: number;
     /** Width in pixels. */
     width?: number;
-    /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
+    /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
     gifType?: GIFType;
 }
 export interface GIF {
@@ -4523,7 +4556,7 @@ export interface GIF {
     still?: string | null;
 }
 export declare enum GIFType {
-    GIF = "GIF",
+    NORMAL = "NORMAL",
     STICKER = "STICKER"
 }
 export interface HeadingData {
@@ -5401,15 +5434,11 @@ export interface CustomChargesConfig {
     baseUri?: SpiBaseUri;
 }
 export interface ValidationsSPIConfig {
-    /**
-     * Whether to validate the cart page in addition to the checkout page.
-     *
-     * Default: `false`.
-     */
+    /** 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 Eligible Triggers endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.
+     * 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`.
      */
     deploymentUri?: string;
 }
@@ -5593,6 +5622,8 @@ export interface NotificationTopic {
     state?: NotificationTopicState;
     /** the type of the topic */
     type?: NotificationTopicType;
+    /** The recipients' types indicate that this topic is relevant. */
+    supportedRecipientTypes?: RecipientType[];
 }
 export declare enum NotificationTopicState {
     UNKNOWN_STATE = "UNKNOWN_STATE",
@@ -5604,6 +5635,13 @@ export declare enum NotificationTopicType {
     PROMOTIONAL = "PROMOTIONAL",
     TRANSACTIONAL = "TRANSACTIONAL"
 }
+/** Recipient type */
+export declare enum RecipientType {
+    /** Wix User */
+    WIX_USER = "WIX_USER",
+    /** Contact */
+    CONTACT = "CONTACT"
+}
 export interface NotificationPreferencesFilterConfig {
     /** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
     baseUri?: SpiBaseUri;
@@ -6608,12 +6646,19 @@ export interface Context {
 export interface UnifiedPage {
     /** Base info of component by shared logic of unified components */
     base?: BaseInfo;
-    /** Page installation settings; */
+    /**
+     * 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;
 }
 export interface PageInstallationSettings {
     /** Shared installation settings for unified components */
@@ -6638,6 +6683,22 @@ export interface WidgetAsContent {
     widgetGuid?: string;
     /** The preset should be used */
     preset?: MainPresets;
+    /** Mark widget as essential for the existence of the app (force to delete the whole app) */
+    essential?: boolean | null;
+}
+export interface UnifiedPageEditorSettings {
+    /** Basic editor settings that are relevant to all page types */
+    base?: PageEditorSettings;
+    /** slug of the page (last part of url that point to the page) */
+    slug?: string | null;
+}
+export interface PageEditorSettings {
+    /** Add the page to the site menu */
+    addToSiteMenu?: boolean | null;
+    /** Can a page be linked through the link panel */
+    linkable?: boolean | null;
+    /** Can a page be duplicated in the editor (if no essential widget is added in the container) */
+    duplicatable?: boolean | null;
 }
 export interface AvailabilityTimeSlotsProviderConfig {
     /** URI where the SPI Implementer is deployed. */
@@ -7357,6 +7418,8 @@ export interface TextInput {
      * Default: true
      */
     showLabel?: boolean | null;
+    /** Default value for the text input */
+    default?: string | null;
 }
 export interface RadioGroup {
     /** Label of the field */
@@ -7398,9 +7461,15 @@ export interface RadioGroupCustomOption {
     placeholder?: string | null;
 }
 export declare enum NumberOfColumns {
+    /** Undefined number of columns. */
     UNKNOWN = "UNKNOWN",
+    /** Zero columns. */
+    ZERO = "ZERO",
+    /** One column. */
     ONE = "ONE",
+    /** Two columns. */
     TWO = "TWO",
+    /** Three columns. */
     THREE = "THREE"
 }
 export interface Dropdown {
@@ -7456,6 +7525,8 @@ export interface DateTimeInput {
      * Default: false.
      */
     use24HourFormat?: boolean;
+    /** Default value for the date time input. */
+    default?: string | null;
 }
 export interface PhoneInput {
     /** Label of the field */
@@ -7492,6 +7563,8 @@ export interface DateInput {
      * Default: true
      */
     showPlaceholder?: boolean | null;
+    /** Default value for the date input. */
+    default?: string | null;
 }
 export interface TimeInput {
     /** Label of the field. Displayed text for the date/time input. */
@@ -7513,6 +7586,8 @@ export interface TimeInput {
      * Default: false.
      */
     use24HourFormat?: boolean;
+    /** Default value for the time input. */
+    default?: string | null;
 }
 export interface DatePicker {
     /** Label of the field. Displayed text for the date/time input. */
@@ -7528,9 +7603,13 @@ export interface DatePicker {
     placeholder?: string | null;
     /** First day of the week displayed on date picker. */
     firstDayOfWeek?: FirstDayOfWeek;
+    /** Default value for the date picker. */
+    default?: string | null;
 }
 export declare enum FirstDayOfWeek {
+    /** First day of the week is Monday. */
     MONDAY = "MONDAY",
+    /** First day of the week is Sunday. */
     SUNDAY = "SUNDAY"
 }
 export interface NumberType {
@@ -7560,6 +7639,8 @@ export interface NumberInput {
      * Default: true
      */
     showLabel?: boolean | null;
+    /** Default value for the number input */
+    default?: number | null;
 }
 export interface RatingInput {
     /** Label of the field */
@@ -7790,16 +7871,17 @@ export interface FileUpload {
     explanationText?: string | null;
 }
 export declare enum UploadFileFormat {
+    /** Undefined upload file format. */
     UNDEFINED = "UNDEFINED",
-    /** Video files */
+    /** Video files. */
     VIDEO = "VIDEO",
-    /** Image files */
+    /** Image files. */
     IMAGE = "IMAGE",
-    /** Audio files */
+    /** Audio files. */
     AUDIO = "AUDIO",
-    /** Document files */
+    /** Document files. */
     DOCUMENT = "DOCUMENT",
-    /** Archive files */
+    /** Archive files. */
     ARCHIVE = "ARCHIVE"
 }
 export interface Signature {
@@ -7909,6 +7991,8 @@ export interface ProductCheckboxGroupOption {
     _id?: string;
     /** Media item. Media, associated with option, like image. */
     media?: MediaItem;
+    /** Flag identifying that option should be selected by default */
+    default?: boolean;
 }
 export declare enum ImageFit {
     UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
@@ -7996,8 +8080,9 @@ export interface ComponentsMultilineAddress {
     autocompleteEnabled?: boolean;
 }
 export declare enum DefaultCountryConfigType {
+    /** Unknown default country config type. */
     UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
-    /** Country will be determined by customer's IP address. */
+    /** Country is determined by customer's IP address. */
     BY_IP = "BY_IP",
     /** Pre-selected default country. */
     COUNTRY = "COUNTRY"
@@ -8979,6 +9064,8 @@ export interface FactorConfig {
     uriConfig?: SpiBaseUri;
     /** the type of the factor */
     factorType?: FactorType;
+    /** whether the factor supports verify without enrolling first */
+    supportsVerifyWithoutEnroll?: boolean;
 }
 export declare enum FactorType {
     UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
@@ -9083,14 +9170,6 @@ export interface LightboxEditorSettings {
     /** Basic editor settings that are relevant to all page types */
     base?: PageEditorSettings;
 }
-export interface PageEditorSettings {
-    /** Add the page to the site menu */
-    addToSiteMenu?: boolean | null;
-    /** Can a page be linked through the link panel */
-    linkable?: boolean | null;
-    /** Can a page be duplicated in the editor (if no essential widget is added in the container) */
-    duplicatable?: boolean | null;
-}
 export interface LightboxCloseOptions {
     /** If true or unset, the lightbox will be closed when overlay is clicked */
     closeOnOverlayClick?: boolean | null;
@@ -9387,23 +9466,50 @@ export interface TextToSpeechActionMessage {
 export interface AudienceProviderConfig {
     /** notification preference filter SPI configuration */
     baseUri?: SpiBaseUri;
+    /** Provider key */
+    key?: string;
+    /** The name of the audience provider, e.g. `Blog Post Subscribers` / `Contacts Labels` */
+    displayName?: string;
     /** Type of participant. Each audience provider can support only one type of recipient */
-    supportedParticipantType?: ParticipantType;
+    participantType?: ParticipantType;
     /** Standard json schema which describe the json the provider should get in the Resolve end point */
     inputSchema?: Record<string, any> | null;
-    /** Optional. Should be filled if the provider implements Item Selection UI Component */
-    itemSelection?: ItemSelection;
-    /** The name of the audience provider, e.g. `Blog Post Subscribers` / `Contacts Labels` */
-    displayName?: string;
+    /**
+     * Interface configuration
+     * If empty default interface configuration will be auto generated based on the input schema
+     */
+    interfaceConfiguration?: InterfaceConfiguration;
     /** Specifying which optional methods are implemented. */
     implementedMethods?: ImplementedMethods;
-    /** Provider key */
-    key?: string;
+    /** Define the scopes which the provider audience is relevant */
+    scopes?: Scope[];
 }
 export declare enum ParticipantType {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
     WIX_USER = "WIX_USER",
-    CONTACT = "CONTACT"
+    CONTACT = "CONTACT",
+    ANONYMOUS = "ANONYMOUS"
+}
+export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
+    /** Should be filled if the provider implements its own custom UI */
+    widgetComponentConfiguration?: WidgetComponent;
+    /** Type of interface configuration */
+    type?: InterfaceConfigurationType;
+}
+/** @oneof */
+export interface InterfaceConfigurationOfTypeOneOf {
+    /** Should be filled if the provider implements its own custom UI */
+    widgetComponentConfiguration?: WidgetComponent;
+}
+export declare enum InterfaceConfigurationType {
+    /** Widget component built by the provider */
+    WIDGET_COMPONENT = "WIDGET_COMPONENT",
+    /** Item Selection, in case the provider implemented item selection component */
+    ITEM_SELECTION = "ITEM_SELECTION"
+}
+export interface WidgetComponent {
+    /** widget component id */
+    componentId?: string;
 }
 export interface ItemSelection {
     /** Item selection provider key */
@@ -9415,6 +9521,12 @@ export interface ImplementedMethods {
     /** Implements countParticipants */
     countParticipants?: boolean;
 }
+export declare enum Scope {
+    /** Provider audience is available only in scope of specific site */
+    SPECIFIC_SITE = "SPECIFIC_SITE",
+    /** Provider audience is available only in scope of non specific site */
+    NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
+}
 /** Config for the Price SPI */
 export interface PriceSPIConfig {
     /** Pricing plan for which the SPI method should optionally apply */
@@ -9459,10 +9571,12 @@ export interface EditorReactComponent {
     type?: string;
     /** The public description of the component do display */
     description?: string;
-    /** list of component resources. This comprises any runtime code we need to load and execute for the component. */
+    /** List of component resources. This comprises any runtime code we need to load and execute for the component. */
     resources?: Resources;
     /** The configuration describing the component abilities and behaviors on the Editor stage */
     editorElement?: EditorElement;
+    /** The installation settings of the component */
+    installation?: InstallationInfo;
 }
 export interface Resources {
     /** The bundle we will load and render in the browser */
@@ -9969,10 +10083,41 @@ export interface RefElement {
     /** The override of the used element custom actions */
     customActions?: Record<string, Action>;
 }
+export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
+    /** Which static container should the widget be installed at */
+    staticContainer?: StaticContainer;
+    /** Default presets per breakpoint with which the widget should be installed */
+    presets?: DefaultPresets;
+}
+/** @oneof */
+export interface InstallationInfoTargetContainerOneOf {
+    /** Which static container should the widget be installed at */
+    staticContainer?: StaticContainer;
+}
 export interface MarketplaceSPIConfig {
     /** URI where the SPI implementer is deployed */
     deploymentUri?: SpiBaseUri;
 }
+export interface FormSchemaDynamicValuesSpiConfig {
+    /** URI where the SPI Implementer is deployed. */
+    uriConfig?: SpiBaseUri;
+    /** Form ID which contains dynamic fields. */
+    formId?: string;
+    /** Field IDs which trigger loading of dynamic values. */
+    fieldsIds?: string[];
+}
+export interface BlogPaywallProviderConfig {
+    /** Uri config */
+    uriConfig?: SpiBaseUri;
+}
+export interface RewardProviderConfig {
+    /** URI where the SPI Implementer is deployed */
+    deploymentUri?: SpiBaseUri;
+    /** Name of the reward that will be visible to the end users */
+    rewardName?: string;
+    /** Description of the reward that will be visible to the end users, describing how the reward works */
+    rewardDescription?: string;
+}
 export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
     gradualRollout?: GradualRolloutCacheEntity;
     gradualUpdate?: GradualUpdateCacheEntity;
@@ -10133,6 +10278,7 @@ export interface DataExtensionSchemaCreatedEnvelope {
  * @permissionId DATA_EXTENSION_SCHEMA.READ
  * @webhook
  * @eventType wix.data_extensions.v1.data_extension_schema_created
+ * @slug created
  * @documentationMaturity preview
  */
 export declare function onDataExtensionSchemaCreated(handler: (event: DataExtensionSchemaCreatedEnvelope) => void | Promise<void>): void;
@@ -10154,6 +10300,7 @@ export interface DataExtensionSchemaDeletedEnvelope {
  * @permissionId DATA_EXTENSION_SCHEMA.READ
  * @webhook
  * @eventType wix.data_extensions.v1.data_extension_schema_deleted
+ * @slug deleted
  * @documentationMaturity preview
  */
 export declare function onDataExtensionSchemaDeleted(handler: (event: DataExtensionSchemaDeletedEnvelope) => void | Promise<void>): void;
@@ -10176,6 +10323,7 @@ export interface DataExtensionSchemaUpdatedEnvelope {
  * @permissionId DATA_EXTENSION_SCHEMA.READ
  * @webhook
  * @eventType wix.data_extensions.v1.data_extension_schema_updated
+ * @slug updated
  * @documentationMaturity preview
  */
 export declare function onDataExtensionSchemaUpdated(handler: (event: DataExtensionSchemaUpdatedEnvelope) => void | Promise<void>): void;
@@ -10234,10 +10382,14 @@ export declare function updateDataExtensionSchema(dataExtensionSchema: DataExten
  * @permissionId DATA_EXTENSION_SCHEMA.READ
  * @permissionScope Manage Bookings Services and Settings
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @permissionScope Manage Data Extensions Schemas
  * @permissionScopeId SCOPE.DATAEXTENSIONS.MANAGE-SCHEMAS
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Read Data Extensions Schemas
  * @permissionScopeId SCOPE.DATAEXTENSIONS.READ-SCHEMAS
  * @permissionScope Manage Restaurants - all permissions