@wix/auto_sdk_data-extension-schema_schemas 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +2 -2
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.js +10 -5
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.js.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js +9 -4
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +278 -45
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +71 -17
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +287 -45
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +77 -17
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +2 -2
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.context.js +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.context.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.public.js +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +278 -45
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +67 -13
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +287 -45
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +73 -13
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +2 -2
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.js +10 -5
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js +9 -4
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +278 -45
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +71 -17
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +287 -45
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +77 -17
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +2 -2
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.context.js +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.context.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.public.js +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +278 -45
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +67 -13
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +287 -45
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +73 -13
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts
CHANGED
|
@@ -513,7 +513,12 @@ export declare enum ComponentType {
|
|
|
513
513
|
PAYMENTS_DISPUTE_SERVICE_PLUGIN = "PAYMENTS_DISPUTE_SERVICE_PLUGIN",
|
|
514
514
|
PRICING_PLANS_FEES = "PRICING_PLANS_FEES",
|
|
515
515
|
EDITOR_REACT_COMPONENT = "EDITOR_REACT_COMPONENT",
|
|
516
|
-
SUPPLIERS_HUB_MARKETPLACE = "SUPPLIERS_HUB_MARKETPLACE"
|
|
516
|
+
SUPPLIERS_HUB_MARKETPLACE = "SUPPLIERS_HUB_MARKETPLACE",
|
|
517
|
+
FORM_SCHEMA_DYNAMIC_VALUES = "FORM_SCHEMA_DYNAMIC_VALUES",
|
|
518
|
+
BLOG_PAYWALL_PROVIDER = "BLOG_PAYWALL_PROVIDER",
|
|
519
|
+
LOYALTY_CUSTOM_REWARDS_V2 = "LOYALTY_CUSTOM_REWARDS_V2",
|
|
520
|
+
STORES_PRODUCT_RESTRICTIONS = "STORES_PRODUCT_RESTRICTIONS",
|
|
521
|
+
FORM_SUBMISSION_MODERATION = "FORM_SUBMISSION_MODERATION"
|
|
517
522
|
}
|
|
518
523
|
/** Component data */
|
|
519
524
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
@@ -1457,11 +1462,30 @@ export interface HelpResources {
|
|
|
1457
1462
|
/** The Wix Answers' article related to the component (chosen by own app) */
|
|
1458
1463
|
articleId?: string;
|
|
1459
1464
|
}
|
|
1460
|
-
export interface WidgetInstallationSettings {
|
|
1461
|
-
/**
|
|
1465
|
+
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1466
|
+
/** Which static container should the widget be installed at */
|
|
1467
|
+
staticContainer?: StaticContainer;
|
|
1468
|
+
/**
|
|
1469
|
+
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1470
|
+
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1471
|
+
* @replacedBy static_container
|
|
1472
|
+
* @targetRemovalDate 2026-02-26
|
|
1473
|
+
*/
|
|
1462
1474
|
base?: BaseInstallation;
|
|
1463
|
-
/**
|
|
1475
|
+
/**
|
|
1476
|
+
* Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
|
|
1477
|
+
* @deprecated Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
|
|
1478
|
+
* @replacedBy presets
|
|
1479
|
+
* @targetRemovalDate 2026-02-26
|
|
1480
|
+
*/
|
|
1464
1481
|
widget?: WidgetInstallation;
|
|
1482
|
+
/** Default presets per breakpoint with which the widget should be installed */
|
|
1483
|
+
presets?: DefaultPresets;
|
|
1484
|
+
}
|
|
1485
|
+
/** @oneof */
|
|
1486
|
+
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1487
|
+
/** Which static container should the widget be installed at */
|
|
1488
|
+
staticContainer?: StaticContainer;
|
|
1465
1489
|
}
|
|
1466
1490
|
export interface BaseInstallation {
|
|
1467
1491
|
/** Auto add component to stage */
|
|
@@ -1482,6 +1506,17 @@ export declare enum RegionType {
|
|
|
1482
1506
|
BODY = "BODY",
|
|
1483
1507
|
FOOTER = "FOOTER"
|
|
1484
1508
|
}
|
|
1509
|
+
export interface DefaultPresets {
|
|
1510
|
+
/** Default preset ID in small (mobile) breakpoint */
|
|
1511
|
+
small?: string | null;
|
|
1512
|
+
/** Default preset ID in large (desktop) breakpoint */
|
|
1513
|
+
large?: string | null;
|
|
1514
|
+
}
|
|
1515
|
+
export declare enum StaticContainer {
|
|
1516
|
+
UNKNOWN_CONTAINER = "UNKNOWN_CONTAINER",
|
|
1517
|
+
/** Widget should be installed in the homepage */
|
|
1518
|
+
HOMEPAGE = "HOMEPAGE"
|
|
1519
|
+
}
|
|
1485
1520
|
export interface ComponentModel {
|
|
1486
1521
|
/** The component type of the builder component. */
|
|
1487
1522
|
componentType?: string;
|
|
@@ -2606,13 +2641,13 @@ export interface ActionSPIConfig {
|
|
|
2606
2641
|
*/
|
|
2607
2642
|
executionType?: ExecutionType;
|
|
2608
2643
|
/** Chosen interface for action */
|
|
2609
|
-
interfaceConfiguration?:
|
|
2644
|
+
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
2610
2645
|
/** Icon representing the action in the UI */
|
|
2611
2646
|
icon?: string;
|
|
2612
2647
|
/** The action configuration source information */
|
|
2613
2648
|
source?: Source;
|
|
2614
2649
|
}
|
|
2615
|
-
export declare enum
|
|
2650
|
+
export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
2616
2651
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2617
2652
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
2618
2653
|
GENERIC = "GENERIC"
|
|
@@ -2673,14 +2708,14 @@ export interface Metadata {
|
|
|
2673
2708
|
/** Show action only to advanced mode users (Wix staff) */
|
|
2674
2709
|
hidden?: boolean;
|
|
2675
2710
|
}
|
|
2676
|
-
export interface
|
|
2711
|
+
export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
2677
2712
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
2678
2713
|
genericOptions?: GenericOptions;
|
|
2679
2714
|
/** Type of chosen interface */
|
|
2680
|
-
type?:
|
|
2715
|
+
type?: ActionSPIConfigInterfaceConfigurationType;
|
|
2681
2716
|
}
|
|
2682
2717
|
/** @oneof */
|
|
2683
|
-
export interface
|
|
2718
|
+
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
2684
2719
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
2685
2720
|
genericOptions?: GenericOptions;
|
|
2686
2721
|
}
|
|
@@ -4516,7 +4551,7 @@ export interface GIFData {
|
|
|
4516
4551
|
height?: number;
|
|
4517
4552
|
/** Width in pixels. */
|
|
4518
4553
|
width?: number;
|
|
4519
|
-
/** Type of GIF (Sticker or
|
|
4554
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
4520
4555
|
gifType?: GIFType;
|
|
4521
4556
|
}
|
|
4522
4557
|
export interface GIF {
|
|
@@ -4528,7 +4563,7 @@ export interface GIF {
|
|
|
4528
4563
|
still?: string | null;
|
|
4529
4564
|
}
|
|
4530
4565
|
export declare enum GIFType {
|
|
4531
|
-
|
|
4566
|
+
NORMAL = "NORMAL",
|
|
4532
4567
|
STICKER = "STICKER"
|
|
4533
4568
|
}
|
|
4534
4569
|
export interface HeadingData {
|
|
@@ -4590,6 +4625,22 @@ export interface ImageData {
|
|
|
4590
4625
|
caption?: string | null;
|
|
4591
4626
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
4592
4627
|
disableDownload?: boolean | null;
|
|
4628
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
4629
|
+
decorative?: boolean | null;
|
|
4630
|
+
/** Styling for the image. */
|
|
4631
|
+
styles?: ImageDataStyles;
|
|
4632
|
+
}
|
|
4633
|
+
export interface StylesBorder {
|
|
4634
|
+
/** Border width in pixels. */
|
|
4635
|
+
width?: number | null;
|
|
4636
|
+
/** Border color. */
|
|
4637
|
+
color?: string | null;
|
|
4638
|
+
/** Border radius in pixels. */
|
|
4639
|
+
radius?: number | null;
|
|
4640
|
+
}
|
|
4641
|
+
export interface ImageDataStyles {
|
|
4642
|
+
/** Border attributes. */
|
|
4643
|
+
border?: StylesBorder;
|
|
4593
4644
|
}
|
|
4594
4645
|
export interface LinkPreviewData {
|
|
4595
4646
|
/** Styling for the link preview's container. */
|
|
@@ -5406,15 +5457,11 @@ export interface CustomChargesConfig {
|
|
|
5406
5457
|
baseUri?: SpiBaseUri;
|
|
5407
5458
|
}
|
|
5408
5459
|
export interface ValidationsSPIConfig {
|
|
5409
|
-
/**
|
|
5410
|
-
* Whether to validate the cart page in addition to the checkout page.
|
|
5411
|
-
*
|
|
5412
|
-
* Default: `false`.
|
|
5413
|
-
*/
|
|
5460
|
+
/** Whether to validate the cart page in addition to the checkout page. Default: `false` */
|
|
5414
5461
|
validateInCart?: boolean;
|
|
5415
5462
|
/**
|
|
5416
5463
|
* Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
|
|
5417
|
-
* For example, to call the Get
|
|
5464
|
+
* 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`.
|
|
5418
5465
|
*/
|
|
5419
5466
|
deploymentUri?: string;
|
|
5420
5467
|
}
|
|
@@ -5598,6 +5645,8 @@ export interface NotificationTopic {
|
|
|
5598
5645
|
state?: NotificationTopicState;
|
|
5599
5646
|
/** the type of the topic */
|
|
5600
5647
|
type?: NotificationTopicType;
|
|
5648
|
+
/** The recipients' types indicate that this topic is relevant. */
|
|
5649
|
+
supportedRecipientTypes?: RecipientType[];
|
|
5601
5650
|
}
|
|
5602
5651
|
export declare enum NotificationTopicState {
|
|
5603
5652
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
@@ -5609,6 +5658,13 @@ export declare enum NotificationTopicType {
|
|
|
5609
5658
|
PROMOTIONAL = "PROMOTIONAL",
|
|
5610
5659
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
5611
5660
|
}
|
|
5661
|
+
/** Recipient type */
|
|
5662
|
+
export declare enum RecipientType {
|
|
5663
|
+
/** Wix User */
|
|
5664
|
+
WIX_USER = "WIX_USER",
|
|
5665
|
+
/** Contact */
|
|
5666
|
+
CONTACT = "CONTACT"
|
|
5667
|
+
}
|
|
5612
5668
|
export interface NotificationPreferencesFilterConfig {
|
|
5613
5669
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
5614
5670
|
baseUri?: SpiBaseUri;
|
|
@@ -6613,12 +6669,19 @@ export interface Context {
|
|
|
6613
6669
|
export interface UnifiedPage {
|
|
6614
6670
|
/** Base info of component by shared logic of unified components */
|
|
6615
6671
|
base?: BaseInfo;
|
|
6616
|
-
/**
|
|
6672
|
+
/**
|
|
6673
|
+
* Page installation settings
|
|
6674
|
+
* @deprecated Page installation settings
|
|
6675
|
+
* @replacedBy editor_settings
|
|
6676
|
+
* @targetRemovalDate 2026-02-26
|
|
6677
|
+
*/
|
|
6617
6678
|
installation?: PageInstallationSettings;
|
|
6618
6679
|
/** Page replacing options (replacer \ replacing \ none) */
|
|
6619
6680
|
pageReplace?: PageReplaceOptions;
|
|
6620
6681
|
/** Content of page */
|
|
6621
6682
|
content?: PageContent;
|
|
6683
|
+
/** Settings for how the page integrates with the editor */
|
|
6684
|
+
editorSettings?: UnifiedPageEditorSettings;
|
|
6622
6685
|
}
|
|
6623
6686
|
export interface PageInstallationSettings {
|
|
6624
6687
|
/** Shared installation settings for unified components */
|
|
@@ -6643,6 +6706,22 @@ export interface WidgetAsContent {
|
|
|
6643
6706
|
widgetGuid?: string;
|
|
6644
6707
|
/** The preset should be used */
|
|
6645
6708
|
preset?: MainPresets;
|
|
6709
|
+
/** Mark widget as essential for the existence of the app (force to delete the whole app) */
|
|
6710
|
+
essential?: boolean | null;
|
|
6711
|
+
}
|
|
6712
|
+
export interface UnifiedPageEditorSettings {
|
|
6713
|
+
/** Basic editor settings that are relevant to all page types */
|
|
6714
|
+
base?: PageEditorSettings;
|
|
6715
|
+
/** slug of the page (last part of url that point to the page) */
|
|
6716
|
+
slug?: string | null;
|
|
6717
|
+
}
|
|
6718
|
+
export interface PageEditorSettings {
|
|
6719
|
+
/** Add the page to the site menu */
|
|
6720
|
+
addToSiteMenu?: boolean | null;
|
|
6721
|
+
/** Can a page be linked through the link panel */
|
|
6722
|
+
linkable?: boolean | null;
|
|
6723
|
+
/** Can a page be duplicated in the editor (if no essential widget is added in the container) */
|
|
6724
|
+
duplicatable?: boolean | null;
|
|
6646
6725
|
}
|
|
6647
6726
|
export interface AvailabilityTimeSlotsProviderConfig {
|
|
6648
6727
|
/** URI where the SPI Implementer is deployed. */
|
|
@@ -7362,6 +7441,8 @@ export interface TextInput {
|
|
|
7362
7441
|
* Default: true
|
|
7363
7442
|
*/
|
|
7364
7443
|
showLabel?: boolean | null;
|
|
7444
|
+
/** Default value for the text input */
|
|
7445
|
+
default?: string | null;
|
|
7365
7446
|
}
|
|
7366
7447
|
export interface RadioGroup {
|
|
7367
7448
|
/** Label of the field */
|
|
@@ -7403,9 +7484,15 @@ export interface RadioGroupCustomOption {
|
|
|
7403
7484
|
placeholder?: string | null;
|
|
7404
7485
|
}
|
|
7405
7486
|
export declare enum NumberOfColumns {
|
|
7487
|
+
/** Undefined number of columns. */
|
|
7406
7488
|
UNKNOWN = "UNKNOWN",
|
|
7489
|
+
/** Zero columns. */
|
|
7490
|
+
ZERO = "ZERO",
|
|
7491
|
+
/** One column. */
|
|
7407
7492
|
ONE = "ONE",
|
|
7493
|
+
/** Two columns. */
|
|
7408
7494
|
TWO = "TWO",
|
|
7495
|
+
/** Three columns. */
|
|
7409
7496
|
THREE = "THREE"
|
|
7410
7497
|
}
|
|
7411
7498
|
export interface Dropdown {
|
|
@@ -7461,6 +7548,8 @@ export interface DateTimeInput {
|
|
|
7461
7548
|
* Default: false.
|
|
7462
7549
|
*/
|
|
7463
7550
|
use24HourFormat?: boolean;
|
|
7551
|
+
/** Default value for the date time input. */
|
|
7552
|
+
default?: string | null;
|
|
7464
7553
|
}
|
|
7465
7554
|
export interface PhoneInput {
|
|
7466
7555
|
/** Label of the field */
|
|
@@ -7497,6 +7586,8 @@ export interface DateInput {
|
|
|
7497
7586
|
* Default: true
|
|
7498
7587
|
*/
|
|
7499
7588
|
showPlaceholder?: boolean | null;
|
|
7589
|
+
/** Default value for the date input. */
|
|
7590
|
+
default?: string | null;
|
|
7500
7591
|
}
|
|
7501
7592
|
export interface TimeInput {
|
|
7502
7593
|
/** Label of the field. Displayed text for the date/time input. */
|
|
@@ -7518,6 +7609,8 @@ export interface TimeInput {
|
|
|
7518
7609
|
* Default: false.
|
|
7519
7610
|
*/
|
|
7520
7611
|
use24HourFormat?: boolean;
|
|
7612
|
+
/** Default value for the time input. */
|
|
7613
|
+
default?: string | null;
|
|
7521
7614
|
}
|
|
7522
7615
|
export interface DatePicker {
|
|
7523
7616
|
/** Label of the field. Displayed text for the date/time input. */
|
|
@@ -7533,9 +7626,13 @@ export interface DatePicker {
|
|
|
7533
7626
|
placeholder?: string | null;
|
|
7534
7627
|
/** First day of the week displayed on date picker. */
|
|
7535
7628
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
7629
|
+
/** Default value for the date picker. */
|
|
7630
|
+
default?: string | null;
|
|
7536
7631
|
}
|
|
7537
7632
|
export declare enum FirstDayOfWeek {
|
|
7633
|
+
/** First day of the week is Monday. */
|
|
7538
7634
|
MONDAY = "MONDAY",
|
|
7635
|
+
/** First day of the week is Sunday. */
|
|
7539
7636
|
SUNDAY = "SUNDAY"
|
|
7540
7637
|
}
|
|
7541
7638
|
export interface NumberType {
|
|
@@ -7565,6 +7662,8 @@ export interface NumberInput {
|
|
|
7565
7662
|
* Default: true
|
|
7566
7663
|
*/
|
|
7567
7664
|
showLabel?: boolean | null;
|
|
7665
|
+
/** Default value for the number input */
|
|
7666
|
+
default?: number | null;
|
|
7568
7667
|
}
|
|
7569
7668
|
export interface RatingInput {
|
|
7570
7669
|
/** Label of the field */
|
|
@@ -7602,7 +7701,7 @@ export interface ArrayType {
|
|
|
7602
7701
|
/** Minimum amount of array elements. */
|
|
7603
7702
|
minItems?: number | null;
|
|
7604
7703
|
/** Type of items allowed in array. */
|
|
7605
|
-
items?:
|
|
7704
|
+
items?: ArrayTypeArrayItems;
|
|
7606
7705
|
}
|
|
7607
7706
|
export declare enum ItemType {
|
|
7608
7707
|
UNKNOWN_ITEM_TYPE = "UNKNOWN_ITEM_TYPE",
|
|
@@ -7666,7 +7765,7 @@ export interface PropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
7666
7765
|
/** Array type validation for property. */
|
|
7667
7766
|
arrayOptions?: ArrayType;
|
|
7668
7767
|
}
|
|
7669
|
-
export interface
|
|
7768
|
+
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
7670
7769
|
/** String type validation for items. */
|
|
7671
7770
|
stringOptions?: StringType;
|
|
7672
7771
|
/** Number type validation for items. */
|
|
@@ -7684,7 +7783,7 @@ export interface ArrayItems extends ArrayItemsItemTypeOptionsOneOf {
|
|
|
7684
7783
|
itemType?: ItemType;
|
|
7685
7784
|
}
|
|
7686
7785
|
/** @oneof */
|
|
7687
|
-
export interface
|
|
7786
|
+
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
7688
7787
|
/** String type validation for items. */
|
|
7689
7788
|
stringOptions?: StringType;
|
|
7690
7789
|
/** Number type validation for items. */
|
|
@@ -7795,16 +7894,17 @@ export interface FileUpload {
|
|
|
7795
7894
|
explanationText?: string | null;
|
|
7796
7895
|
}
|
|
7797
7896
|
export declare enum UploadFileFormat {
|
|
7897
|
+
/** Undefined upload file format. */
|
|
7798
7898
|
UNDEFINED = "UNDEFINED",
|
|
7799
|
-
/** Video files */
|
|
7899
|
+
/** Video files. */
|
|
7800
7900
|
VIDEO = "VIDEO",
|
|
7801
|
-
/** Image files */
|
|
7901
|
+
/** Image files. */
|
|
7802
7902
|
IMAGE = "IMAGE",
|
|
7803
|
-
/** Audio files */
|
|
7903
|
+
/** Audio files. */
|
|
7804
7904
|
AUDIO = "AUDIO",
|
|
7805
|
-
/** Document files */
|
|
7905
|
+
/** Document files. */
|
|
7806
7906
|
DOCUMENT = "DOCUMENT",
|
|
7807
|
-
/** Archive files */
|
|
7907
|
+
/** Archive files. */
|
|
7808
7908
|
ARCHIVE = "ARCHIVE"
|
|
7809
7909
|
}
|
|
7810
7910
|
export interface Signature {
|
|
@@ -7914,6 +8014,8 @@ export interface ProductCheckboxGroupOption {
|
|
|
7914
8014
|
_id?: string;
|
|
7915
8015
|
/** Media item. Media, associated with option, like image. */
|
|
7916
8016
|
media?: MediaItem;
|
|
8017
|
+
/** Flag identifying that option should be selected by default */
|
|
8018
|
+
default?: boolean;
|
|
7917
8019
|
}
|
|
7918
8020
|
export declare enum ImageFit {
|
|
7919
8021
|
UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
|
|
@@ -8001,8 +8103,9 @@ export interface ComponentsMultilineAddress {
|
|
|
8001
8103
|
autocompleteEnabled?: boolean;
|
|
8002
8104
|
}
|
|
8003
8105
|
export declare enum DefaultCountryConfigType {
|
|
8106
|
+
/** Unknown default country config type. */
|
|
8004
8107
|
UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
|
|
8005
|
-
/** Country
|
|
8108
|
+
/** Country is determined by customer's IP address. */
|
|
8006
8109
|
BY_IP = "BY_IP",
|
|
8007
8110
|
/** Pre-selected default country. */
|
|
8008
8111
|
COUNTRY = "COUNTRY"
|
|
@@ -8786,6 +8889,10 @@ export interface Description {
|
|
|
8786
8889
|
outcomeDescription?: string | null;
|
|
8787
8890
|
/** Representative image */
|
|
8788
8891
|
representativeImage?: string;
|
|
8892
|
+
/** Title of the builderless function template selection modal */
|
|
8893
|
+
builderlessTemplateSelectionModalTitle?: string | null;
|
|
8894
|
+
/** Subtitle of the builderless function template selection modal */
|
|
8895
|
+
builderlessTemplateSelectionModalSubtitle?: string | null;
|
|
8789
8896
|
}
|
|
8790
8897
|
export interface CheckoutContentSPIConfig {
|
|
8791
8898
|
/** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. */
|
|
@@ -8984,6 +9091,8 @@ export interface FactorConfig {
|
|
|
8984
9091
|
uriConfig?: SpiBaseUri;
|
|
8985
9092
|
/** the type of the factor */
|
|
8986
9093
|
factorType?: FactorType;
|
|
9094
|
+
/** whether the factor supports verify without enrolling first */
|
|
9095
|
+
supportsVerifyWithoutEnroll?: boolean;
|
|
8987
9096
|
}
|
|
8988
9097
|
export declare enum FactorType {
|
|
8989
9098
|
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
@@ -9088,14 +9197,6 @@ export interface LightboxEditorSettings {
|
|
|
9088
9197
|
/** Basic editor settings that are relevant to all page types */
|
|
9089
9198
|
base?: PageEditorSettings;
|
|
9090
9199
|
}
|
|
9091
|
-
export interface PageEditorSettings {
|
|
9092
|
-
/** Add the page to the site menu */
|
|
9093
|
-
addToSiteMenu?: boolean | null;
|
|
9094
|
-
/** Can a page be linked through the link panel */
|
|
9095
|
-
linkable?: boolean | null;
|
|
9096
|
-
/** Can a page be duplicated in the editor (if no essential widget is added in the container) */
|
|
9097
|
-
duplicatable?: boolean | null;
|
|
9098
|
-
}
|
|
9099
9200
|
export interface LightboxCloseOptions {
|
|
9100
9201
|
/** If true or unset, the lightbox will be closed when overlay is clicked */
|
|
9101
9202
|
closeOnOverlayClick?: boolean | null;
|
|
@@ -9392,23 +9493,50 @@ export interface TextToSpeechActionMessage {
|
|
|
9392
9493
|
export interface AudienceProviderConfig {
|
|
9393
9494
|
/** notification preference filter SPI configuration */
|
|
9394
9495
|
baseUri?: SpiBaseUri;
|
|
9496
|
+
/** Provider key */
|
|
9497
|
+
key?: string;
|
|
9498
|
+
/** The name of the audience provider, e.g. `Blog Post Subscribers` / `Contacts Labels` */
|
|
9499
|
+
displayName?: string;
|
|
9395
9500
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
9396
|
-
|
|
9501
|
+
participantType?: ParticipantType;
|
|
9397
9502
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
9398
9503
|
inputSchema?: Record<string, any> | null;
|
|
9399
|
-
/**
|
|
9400
|
-
|
|
9401
|
-
|
|
9402
|
-
|
|
9504
|
+
/**
|
|
9505
|
+
* Interface configuration
|
|
9506
|
+
* If empty default interface configuration will be auto generated based on the input schema
|
|
9507
|
+
*/
|
|
9508
|
+
interfaceConfiguration?: InterfaceConfiguration;
|
|
9403
9509
|
/** Specifying which optional methods are implemented. */
|
|
9404
9510
|
implementedMethods?: ImplementedMethods;
|
|
9405
|
-
/**
|
|
9406
|
-
|
|
9511
|
+
/** Define the scopes which the provider audience is relevant */
|
|
9512
|
+
scopes?: Scope[];
|
|
9407
9513
|
}
|
|
9408
9514
|
export declare enum ParticipantType {
|
|
9409
9515
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
9410
9516
|
WIX_USER = "WIX_USER",
|
|
9411
|
-
CONTACT = "CONTACT"
|
|
9517
|
+
CONTACT = "CONTACT",
|
|
9518
|
+
ANONYMOUS = "ANONYMOUS"
|
|
9519
|
+
}
|
|
9520
|
+
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
9521
|
+
/** Should be filled if the provider implements its own custom UI */
|
|
9522
|
+
widgetComponentConfiguration?: WidgetComponent;
|
|
9523
|
+
/** Type of interface configuration */
|
|
9524
|
+
type?: InterfaceConfigurationType;
|
|
9525
|
+
}
|
|
9526
|
+
/** @oneof */
|
|
9527
|
+
export interface InterfaceConfigurationOfTypeOneOf {
|
|
9528
|
+
/** Should be filled if the provider implements its own custom UI */
|
|
9529
|
+
widgetComponentConfiguration?: WidgetComponent;
|
|
9530
|
+
}
|
|
9531
|
+
export declare enum InterfaceConfigurationType {
|
|
9532
|
+
/** Widget component built by the provider */
|
|
9533
|
+
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
9534
|
+
/** Item Selection, in case the provider implemented item selection component */
|
|
9535
|
+
ITEM_SELECTION = "ITEM_SELECTION"
|
|
9536
|
+
}
|
|
9537
|
+
export interface WidgetComponent {
|
|
9538
|
+
/** widget component id */
|
|
9539
|
+
componentId?: string;
|
|
9412
9540
|
}
|
|
9413
9541
|
export interface ItemSelection {
|
|
9414
9542
|
/** Item selection provider key */
|
|
@@ -9420,6 +9548,12 @@ export interface ImplementedMethods {
|
|
|
9420
9548
|
/** Implements countParticipants */
|
|
9421
9549
|
countParticipants?: boolean;
|
|
9422
9550
|
}
|
|
9551
|
+
export declare enum Scope {
|
|
9552
|
+
/** Provider audience is available only in scope of specific site */
|
|
9553
|
+
SPECIFIC_SITE = "SPECIFIC_SITE",
|
|
9554
|
+
/** Provider audience is available only in scope of non specific site */
|
|
9555
|
+
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
9556
|
+
}
|
|
9423
9557
|
/** Config for the Price SPI */
|
|
9424
9558
|
export interface PriceSPIConfig {
|
|
9425
9559
|
/** Pricing plan for which the SPI method should optionally apply */
|
|
@@ -9464,10 +9598,12 @@ export interface EditorReactComponent {
|
|
|
9464
9598
|
type?: string;
|
|
9465
9599
|
/** The public description of the component do display */
|
|
9466
9600
|
description?: string;
|
|
9467
|
-
/**
|
|
9601
|
+
/** List of component resources. This comprises any runtime code we need to load and execute for the component. */
|
|
9468
9602
|
resources?: Resources;
|
|
9469
9603
|
/** The configuration describing the component abilities and behaviors on the Editor stage */
|
|
9470
9604
|
editorElement?: EditorElement;
|
|
9605
|
+
/** The installation settings of the component */
|
|
9606
|
+
installation?: InstallationInfo;
|
|
9471
9607
|
}
|
|
9472
9608
|
export interface Resources {
|
|
9473
9609
|
/** The bundle we will load and render in the browser */
|
|
@@ -9610,6 +9746,8 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
9610
9746
|
link?: Link;
|
|
9611
9747
|
/** The [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply */
|
|
9612
9748
|
schema?: Record<string, any> | null;
|
|
9749
|
+
/** An array of a data type */
|
|
9750
|
+
arrayItems?: ArrayItems;
|
|
9613
9751
|
/** Defines the type of data we are configuring */
|
|
9614
9752
|
dataType?: DataType;
|
|
9615
9753
|
/** Display name of this data item */
|
|
@@ -9629,6 +9767,8 @@ export interface DataItemSelectedDataTypeOneOf {
|
|
|
9629
9767
|
link?: Link;
|
|
9630
9768
|
/** The [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply */
|
|
9631
9769
|
schema?: Record<string, any> | null;
|
|
9770
|
+
/** An array of a data type */
|
|
9771
|
+
arrayItems?: ArrayItems;
|
|
9632
9772
|
}
|
|
9633
9773
|
export declare enum DataType {
|
|
9634
9774
|
UNKNOWN_DataType = "UNKNOWN_DataType",
|
|
@@ -9671,7 +9811,11 @@ export declare enum DataType {
|
|
|
9671
9811
|
/** A valid `regex` pattern supplied by the User */
|
|
9672
9812
|
regex = "regex",
|
|
9673
9813
|
/** A unique identifier */
|
|
9674
|
-
guid = "guid"
|
|
9814
|
+
guid = "guid",
|
|
9815
|
+
/** a HTML text with css inline styling */
|
|
9816
|
+
richText = "richText",
|
|
9817
|
+
/** An array type of data */
|
|
9818
|
+
arrayItems = "arrayItems"
|
|
9675
9819
|
}
|
|
9676
9820
|
export interface Text {
|
|
9677
9821
|
/** Indicates maximum length allowed for the text */
|
|
@@ -9787,6 +9931,29 @@ export declare enum LinkType {
|
|
|
9787
9931
|
/** A link that directs the user to wix login dialog */
|
|
9788
9932
|
loginToWixLink = "loginToWixLink"
|
|
9789
9933
|
}
|
|
9934
|
+
/** An array of data items or complex data types */
|
|
9935
|
+
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
9936
|
+
/** The definition of multiple data items in each item of the Array */
|
|
9937
|
+
data?: DataItems;
|
|
9938
|
+
/** For a single data type in the array */
|
|
9939
|
+
dataItem?: DataItem;
|
|
9940
|
+
/** The maximum size of the Array (there will be a size limit in the Storage as well) */
|
|
9941
|
+
maxSize?: number | null;
|
|
9942
|
+
}
|
|
9943
|
+
/** @oneof */
|
|
9944
|
+
export interface ArrayItemsArrayDataOneOf {
|
|
9945
|
+
/** The definition of multiple data items in each item of the Array */
|
|
9946
|
+
data?: DataItems;
|
|
9947
|
+
/** For a single data type in the array */
|
|
9948
|
+
dataItem?: DataItem;
|
|
9949
|
+
}
|
|
9950
|
+
export interface DataItems {
|
|
9951
|
+
/**
|
|
9952
|
+
* For an array of complex object types
|
|
9953
|
+
* Each item in the array, will contain all this data structure
|
|
9954
|
+
*/
|
|
9955
|
+
items?: Record<string, DataItem>;
|
|
9956
|
+
}
|
|
9790
9957
|
export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
9791
9958
|
/** An new element definition */
|
|
9792
9959
|
inlineElement?: InlineElement;
|
|
@@ -9974,10 +10141,76 @@ export interface RefElement {
|
|
|
9974
10141
|
/** The override of the used element custom actions */
|
|
9975
10142
|
customActions?: Record<string, Action>;
|
|
9976
10143
|
}
|
|
10144
|
+
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
10145
|
+
/** Which static container should the widget be installed at */
|
|
10146
|
+
staticContainer?: StaticContainer;
|
|
10147
|
+
/** Default presets per breakpoint with which the widget should be installed */
|
|
10148
|
+
presets?: DefaultPresets;
|
|
10149
|
+
}
|
|
10150
|
+
/** @oneof */
|
|
10151
|
+
export interface InstallationInfoTargetContainerOneOf {
|
|
10152
|
+
/** Which static container should the widget be installed at */
|
|
10153
|
+
staticContainer?: StaticContainer;
|
|
10154
|
+
}
|
|
9977
10155
|
export interface MarketplaceSPIConfig {
|
|
9978
10156
|
/** URI where the SPI implementer is deployed */
|
|
9979
10157
|
deploymentUri?: SpiBaseUri;
|
|
9980
10158
|
}
|
|
10159
|
+
export interface FormSchemaDynamicValuesSpiConfig {
|
|
10160
|
+
/** URI where the SPI Implementer is deployed. */
|
|
10161
|
+
uriConfig?: SpiBaseUri;
|
|
10162
|
+
/** Form ID which contains dynamic fields. */
|
|
10163
|
+
formId?: string;
|
|
10164
|
+
/** Field IDs which trigger loading of dynamic values. */
|
|
10165
|
+
fieldsIds?: string[];
|
|
10166
|
+
}
|
|
10167
|
+
export interface BlogPaywallProviderConfig {
|
|
10168
|
+
/** Uri config */
|
|
10169
|
+
uriConfig?: SpiBaseUri;
|
|
10170
|
+
}
|
|
10171
|
+
export interface RewardProviderConfig {
|
|
10172
|
+
/** URI where the SPI Implementer is deployed */
|
|
10173
|
+
deploymentUri?: SpiBaseUri;
|
|
10174
|
+
/** Name of the reward that will be visible to the end users */
|
|
10175
|
+
rewardName?: string;
|
|
10176
|
+
/** Description of the reward that will be visible to the end users, describing how the reward works */
|
|
10177
|
+
rewardDescription?: string;
|
|
10178
|
+
}
|
|
10179
|
+
export interface ProductRestrictionsConfig {
|
|
10180
|
+
/** URI where the SPI Implementer is deployed */
|
|
10181
|
+
deploymentUri?: SpiBaseUri;
|
|
10182
|
+
/** catalog restrictions configuration */
|
|
10183
|
+
productRestrictionsConfig?: RestrictionsConfig;
|
|
10184
|
+
}
|
|
10185
|
+
export interface RestrictionsConfig {
|
|
10186
|
+
/** prices restrictions that affect fields like full price, compare at price etc */
|
|
10187
|
+
prices?: Restriction;
|
|
10188
|
+
/** options restrictions that affect options edit except images on choices */
|
|
10189
|
+
options?: Restriction;
|
|
10190
|
+
/** modifier restrictions that affect modifiers */
|
|
10191
|
+
modifiers?: Restriction;
|
|
10192
|
+
/** item identifiers affect quantity, sku, barcode on inventory */
|
|
10193
|
+
inventory?: Restriction;
|
|
10194
|
+
/** pre order restrictions that affect fields like pre order */
|
|
10195
|
+
preOrder?: Restriction;
|
|
10196
|
+
/** duplicate product restriction action */
|
|
10197
|
+
duplicateProduct?: Restriction;
|
|
10198
|
+
}
|
|
10199
|
+
export interface Restriction {
|
|
10200
|
+
/** restriction level of WARNING or LOCKED */
|
|
10201
|
+
restrictionLevel?: RestrictionLevel;
|
|
10202
|
+
}
|
|
10203
|
+
export declare enum RestrictionLevel {
|
|
10204
|
+
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
10205
|
+
WARNING = "WARNING",
|
|
10206
|
+
LOCKED = "LOCKED"
|
|
10207
|
+
}
|
|
10208
|
+
export interface FormSubmissionModerationSpiConfig {
|
|
10209
|
+
/** URI where the SPI Implementer is deployed */
|
|
10210
|
+
baseUri?: SpiBaseUri;
|
|
10211
|
+
/** Forms for which the SPI method should apply */
|
|
10212
|
+
formIds?: string[];
|
|
10213
|
+
}
|
|
9981
10214
|
export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
|
|
9982
10215
|
gradualRollout?: GradualRolloutCacheEntity;
|
|
9983
10216
|
gradualUpdate?: GradualUpdateCacheEntity;
|
|
@@ -10140,6 +10373,7 @@ export interface DataExtensionSchemaCreatedEnvelope {
|
|
|
10140
10373
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10141
10374
|
* @webhook
|
|
10142
10375
|
* @eventType wix.data_extensions.v1.data_extension_schema_created
|
|
10376
|
+
* @slug created
|
|
10143
10377
|
* @documentationMaturity preview
|
|
10144
10378
|
*/
|
|
10145
10379
|
export declare function onDataExtensionSchemaCreated(handler: (event: DataExtensionSchemaCreatedEnvelope) => void | Promise<void>): void;
|
|
@@ -10161,6 +10395,7 @@ export interface DataExtensionSchemaDeletedEnvelope {
|
|
|
10161
10395
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10162
10396
|
* @webhook
|
|
10163
10397
|
* @eventType wix.data_extensions.v1.data_extension_schema_deleted
|
|
10398
|
+
* @slug deleted
|
|
10164
10399
|
* @documentationMaturity preview
|
|
10165
10400
|
*/
|
|
10166
10401
|
export declare function onDataExtensionSchemaDeleted(handler: (event: DataExtensionSchemaDeletedEnvelope) => void | Promise<void>): void;
|
|
@@ -10183,6 +10418,7 @@ export interface DataExtensionSchemaUpdatedEnvelope {
|
|
|
10183
10418
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10184
10419
|
* @webhook
|
|
10185
10420
|
* @eventType wix.data_extensions.v1.data_extension_schema_updated
|
|
10421
|
+
* @slug updated
|
|
10186
10422
|
* @documentationMaturity preview
|
|
10187
10423
|
*/
|
|
10188
10424
|
export declare function onDataExtensionSchemaUpdated(handler: (event: DataExtensionSchemaUpdatedEnvelope) => void | Promise<void>): void;
|
|
@@ -10241,14 +10477,20 @@ export declare function updateDataExtensionSchema(dataExtensionSchema: DataExten
|
|
|
10241
10477
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10242
10478
|
* @permissionScope Manage Bookings Services and Settings
|
|
10243
10479
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
10480
|
+
* @permissionScope Manage Events
|
|
10481
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
10244
10482
|
* @permissionScope Manage Data Extensions Schemas
|
|
10245
10483
|
* @permissionScopeId SCOPE.DATAEXTENSIONS.MANAGE-SCHEMAS
|
|
10246
10484
|
* @permissionScope Manage Portfolio
|
|
10247
10485
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
10486
|
+
* @permissionScope Access Verticals by Automations
|
|
10487
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
10248
10488
|
* @permissionScope Read Data Extensions Schemas
|
|
10249
10489
|
* @permissionScopeId SCOPE.DATAEXTENSIONS.READ-SCHEMAS
|
|
10250
10490
|
* @permissionScope Manage Restaurants - all permissions
|
|
10251
10491
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
10492
|
+
* @permissionScope Set Up Automations
|
|
10493
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
10252
10494
|
* @applicableIdentity APP
|
|
10253
10495
|
* @applicableIdentity VISITOR
|
|
10254
10496
|
* @fqn wix.infra.dataextensions.v1.DataExtensionSchemaService.ListDataExtensionSchemas
|