@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
|
@@ -508,7 +508,12 @@ export declare enum ComponentType {
|
|
|
508
508
|
PAYMENTS_DISPUTE_SERVICE_PLUGIN = "PAYMENTS_DISPUTE_SERVICE_PLUGIN",
|
|
509
509
|
PRICING_PLANS_FEES = "PRICING_PLANS_FEES",
|
|
510
510
|
EDITOR_REACT_COMPONENT = "EDITOR_REACT_COMPONENT",
|
|
511
|
-
SUPPLIERS_HUB_MARKETPLACE = "SUPPLIERS_HUB_MARKETPLACE"
|
|
511
|
+
SUPPLIERS_HUB_MARKETPLACE = "SUPPLIERS_HUB_MARKETPLACE",
|
|
512
|
+
FORM_SCHEMA_DYNAMIC_VALUES = "FORM_SCHEMA_DYNAMIC_VALUES",
|
|
513
|
+
BLOG_PAYWALL_PROVIDER = "BLOG_PAYWALL_PROVIDER",
|
|
514
|
+
LOYALTY_CUSTOM_REWARDS_V2 = "LOYALTY_CUSTOM_REWARDS_V2",
|
|
515
|
+
STORES_PRODUCT_RESTRICTIONS = "STORES_PRODUCT_RESTRICTIONS",
|
|
516
|
+
FORM_SUBMISSION_MODERATION = "FORM_SUBMISSION_MODERATION"
|
|
512
517
|
}
|
|
513
518
|
/** Component data */
|
|
514
519
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
@@ -1452,11 +1457,30 @@ export interface HelpResources {
|
|
|
1452
1457
|
/** The Wix Answers' article related to the component (chosen by own app) */
|
|
1453
1458
|
articleId?: string;
|
|
1454
1459
|
}
|
|
1455
|
-
export interface WidgetInstallationSettings {
|
|
1456
|
-
/**
|
|
1460
|
+
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1461
|
+
/** Which static container should the widget be installed at */
|
|
1462
|
+
staticContainer?: StaticContainer;
|
|
1463
|
+
/**
|
|
1464
|
+
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1465
|
+
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1466
|
+
* @replacedBy static_container
|
|
1467
|
+
* @targetRemovalDate 2026-02-26
|
|
1468
|
+
*/
|
|
1457
1469
|
base?: BaseInstallation;
|
|
1458
|
-
/**
|
|
1470
|
+
/**
|
|
1471
|
+
* Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
|
|
1472
|
+
* @deprecated Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
|
|
1473
|
+
* @replacedBy presets
|
|
1474
|
+
* @targetRemovalDate 2026-02-26
|
|
1475
|
+
*/
|
|
1459
1476
|
widget?: WidgetInstallation;
|
|
1477
|
+
/** Default presets per breakpoint with which the widget should be installed */
|
|
1478
|
+
presets?: DefaultPresets;
|
|
1479
|
+
}
|
|
1480
|
+
/** @oneof */
|
|
1481
|
+
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1482
|
+
/** Which static container should the widget be installed at */
|
|
1483
|
+
staticContainer?: StaticContainer;
|
|
1460
1484
|
}
|
|
1461
1485
|
export interface BaseInstallation {
|
|
1462
1486
|
/** Auto add component to stage */
|
|
@@ -1477,6 +1501,17 @@ export declare enum RegionType {
|
|
|
1477
1501
|
BODY = "BODY",
|
|
1478
1502
|
FOOTER = "FOOTER"
|
|
1479
1503
|
}
|
|
1504
|
+
export interface DefaultPresets {
|
|
1505
|
+
/** Default preset ID in small (mobile) breakpoint */
|
|
1506
|
+
small?: string | null;
|
|
1507
|
+
/** Default preset ID in large (desktop) breakpoint */
|
|
1508
|
+
large?: string | null;
|
|
1509
|
+
}
|
|
1510
|
+
export declare enum StaticContainer {
|
|
1511
|
+
UNKNOWN_CONTAINER = "UNKNOWN_CONTAINER",
|
|
1512
|
+
/** Widget should be installed in the homepage */
|
|
1513
|
+
HOMEPAGE = "HOMEPAGE"
|
|
1514
|
+
}
|
|
1480
1515
|
export interface ComponentModel {
|
|
1481
1516
|
/** The component type of the builder component. */
|
|
1482
1517
|
componentType?: string;
|
|
@@ -2601,13 +2636,13 @@ export interface ActionSPIConfig {
|
|
|
2601
2636
|
*/
|
|
2602
2637
|
executionType?: ExecutionType;
|
|
2603
2638
|
/** Chosen interface for action */
|
|
2604
|
-
interfaceConfiguration?:
|
|
2639
|
+
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
2605
2640
|
/** Icon representing the action in the UI */
|
|
2606
2641
|
icon?: string;
|
|
2607
2642
|
/** The action configuration source information */
|
|
2608
2643
|
source?: Source;
|
|
2609
2644
|
}
|
|
2610
|
-
export declare enum
|
|
2645
|
+
export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
2611
2646
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2612
2647
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
2613
2648
|
GENERIC = "GENERIC"
|
|
@@ -2668,14 +2703,14 @@ export interface Metadata {
|
|
|
2668
2703
|
/** Show action only to advanced mode users (Wix staff) */
|
|
2669
2704
|
hidden?: boolean;
|
|
2670
2705
|
}
|
|
2671
|
-
export interface
|
|
2706
|
+
export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
2672
2707
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
2673
2708
|
genericOptions?: GenericOptions;
|
|
2674
2709
|
/** Type of chosen interface */
|
|
2675
|
-
type?:
|
|
2710
|
+
type?: ActionSPIConfigInterfaceConfigurationType;
|
|
2676
2711
|
}
|
|
2677
2712
|
/** @oneof */
|
|
2678
|
-
export interface
|
|
2713
|
+
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
2679
2714
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
2680
2715
|
genericOptions?: GenericOptions;
|
|
2681
2716
|
}
|
|
@@ -4511,7 +4546,7 @@ export interface GIFData {
|
|
|
4511
4546
|
height?: number;
|
|
4512
4547
|
/** Width in pixels. */
|
|
4513
4548
|
width?: number;
|
|
4514
|
-
/** Type of GIF (Sticker or
|
|
4549
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
4515
4550
|
gifType?: GIFType;
|
|
4516
4551
|
}
|
|
4517
4552
|
export interface GIF {
|
|
@@ -4523,7 +4558,7 @@ export interface GIF {
|
|
|
4523
4558
|
still?: string | null;
|
|
4524
4559
|
}
|
|
4525
4560
|
export declare enum GIFType {
|
|
4526
|
-
|
|
4561
|
+
NORMAL = "NORMAL",
|
|
4527
4562
|
STICKER = "STICKER"
|
|
4528
4563
|
}
|
|
4529
4564
|
export interface HeadingData {
|
|
@@ -4585,6 +4620,22 @@ export interface ImageData {
|
|
|
4585
4620
|
caption?: string | null;
|
|
4586
4621
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
4587
4622
|
disableDownload?: boolean | null;
|
|
4623
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
4624
|
+
decorative?: boolean | null;
|
|
4625
|
+
/** Styling for the image. */
|
|
4626
|
+
styles?: ImageDataStyles;
|
|
4627
|
+
}
|
|
4628
|
+
export interface StylesBorder {
|
|
4629
|
+
/** Border width in pixels. */
|
|
4630
|
+
width?: number | null;
|
|
4631
|
+
/** Border color. */
|
|
4632
|
+
color?: string | null;
|
|
4633
|
+
/** Border radius in pixels. */
|
|
4634
|
+
radius?: number | null;
|
|
4635
|
+
}
|
|
4636
|
+
export interface ImageDataStyles {
|
|
4637
|
+
/** Border attributes. */
|
|
4638
|
+
border?: StylesBorder;
|
|
4588
4639
|
}
|
|
4589
4640
|
export interface LinkPreviewData {
|
|
4590
4641
|
/** Styling for the link preview's container. */
|
|
@@ -5401,15 +5452,11 @@ export interface CustomChargesConfig {
|
|
|
5401
5452
|
baseUri?: SpiBaseUri;
|
|
5402
5453
|
}
|
|
5403
5454
|
export interface ValidationsSPIConfig {
|
|
5404
|
-
/**
|
|
5405
|
-
* Whether to validate the cart page in addition to the checkout page.
|
|
5406
|
-
*
|
|
5407
|
-
* Default: `false`.
|
|
5408
|
-
*/
|
|
5455
|
+
/** Whether to validate the cart page in addition to the checkout page. Default: `false` */
|
|
5409
5456
|
validateInCart?: boolean;
|
|
5410
5457
|
/**
|
|
5411
5458
|
* Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
|
|
5412
|
-
* For example, to call the Get
|
|
5459
|
+
* 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`.
|
|
5413
5460
|
*/
|
|
5414
5461
|
deploymentUri?: string;
|
|
5415
5462
|
}
|
|
@@ -5593,6 +5640,8 @@ export interface NotificationTopic {
|
|
|
5593
5640
|
state?: NotificationTopicState;
|
|
5594
5641
|
/** the type of the topic */
|
|
5595
5642
|
type?: NotificationTopicType;
|
|
5643
|
+
/** The recipients' types indicate that this topic is relevant. */
|
|
5644
|
+
supportedRecipientTypes?: RecipientType[];
|
|
5596
5645
|
}
|
|
5597
5646
|
export declare enum NotificationTopicState {
|
|
5598
5647
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
@@ -5604,6 +5653,13 @@ export declare enum NotificationTopicType {
|
|
|
5604
5653
|
PROMOTIONAL = "PROMOTIONAL",
|
|
5605
5654
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
5606
5655
|
}
|
|
5656
|
+
/** Recipient type */
|
|
5657
|
+
export declare enum RecipientType {
|
|
5658
|
+
/** Wix User */
|
|
5659
|
+
WIX_USER = "WIX_USER",
|
|
5660
|
+
/** Contact */
|
|
5661
|
+
CONTACT = "CONTACT"
|
|
5662
|
+
}
|
|
5607
5663
|
export interface NotificationPreferencesFilterConfig {
|
|
5608
5664
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
5609
5665
|
baseUri?: SpiBaseUri;
|
|
@@ -6608,12 +6664,19 @@ export interface Context {
|
|
|
6608
6664
|
export interface UnifiedPage {
|
|
6609
6665
|
/** Base info of component by shared logic of unified components */
|
|
6610
6666
|
base?: BaseInfo;
|
|
6611
|
-
/**
|
|
6667
|
+
/**
|
|
6668
|
+
* Page installation settings
|
|
6669
|
+
* @deprecated Page installation settings
|
|
6670
|
+
* @replacedBy editor_settings
|
|
6671
|
+
* @targetRemovalDate 2026-02-26
|
|
6672
|
+
*/
|
|
6612
6673
|
installation?: PageInstallationSettings;
|
|
6613
6674
|
/** Page replacing options (replacer \ replacing \ none) */
|
|
6614
6675
|
pageReplace?: PageReplaceOptions;
|
|
6615
6676
|
/** Content of page */
|
|
6616
6677
|
content?: PageContent;
|
|
6678
|
+
/** Settings for how the page integrates with the editor */
|
|
6679
|
+
editorSettings?: UnifiedPageEditorSettings;
|
|
6617
6680
|
}
|
|
6618
6681
|
export interface PageInstallationSettings {
|
|
6619
6682
|
/** Shared installation settings for unified components */
|
|
@@ -6638,6 +6701,22 @@ export interface WidgetAsContent {
|
|
|
6638
6701
|
widgetGuid?: string;
|
|
6639
6702
|
/** The preset should be used */
|
|
6640
6703
|
preset?: MainPresets;
|
|
6704
|
+
/** Mark widget as essential for the existence of the app (force to delete the whole app) */
|
|
6705
|
+
essential?: boolean | null;
|
|
6706
|
+
}
|
|
6707
|
+
export interface UnifiedPageEditorSettings {
|
|
6708
|
+
/** Basic editor settings that are relevant to all page types */
|
|
6709
|
+
base?: PageEditorSettings;
|
|
6710
|
+
/** slug of the page (last part of url that point to the page) */
|
|
6711
|
+
slug?: string | null;
|
|
6712
|
+
}
|
|
6713
|
+
export interface PageEditorSettings {
|
|
6714
|
+
/** Add the page to the site menu */
|
|
6715
|
+
addToSiteMenu?: boolean | null;
|
|
6716
|
+
/** Can a page be linked through the link panel */
|
|
6717
|
+
linkable?: boolean | null;
|
|
6718
|
+
/** Can a page be duplicated in the editor (if no essential widget is added in the container) */
|
|
6719
|
+
duplicatable?: boolean | null;
|
|
6641
6720
|
}
|
|
6642
6721
|
export interface AvailabilityTimeSlotsProviderConfig {
|
|
6643
6722
|
/** URI where the SPI Implementer is deployed. */
|
|
@@ -7357,6 +7436,8 @@ export interface TextInput {
|
|
|
7357
7436
|
* Default: true
|
|
7358
7437
|
*/
|
|
7359
7438
|
showLabel?: boolean | null;
|
|
7439
|
+
/** Default value for the text input */
|
|
7440
|
+
default?: string | null;
|
|
7360
7441
|
}
|
|
7361
7442
|
export interface RadioGroup {
|
|
7362
7443
|
/** Label of the field */
|
|
@@ -7398,9 +7479,15 @@ export interface RadioGroupCustomOption {
|
|
|
7398
7479
|
placeholder?: string | null;
|
|
7399
7480
|
}
|
|
7400
7481
|
export declare enum NumberOfColumns {
|
|
7482
|
+
/** Undefined number of columns. */
|
|
7401
7483
|
UNKNOWN = "UNKNOWN",
|
|
7484
|
+
/** Zero columns. */
|
|
7485
|
+
ZERO = "ZERO",
|
|
7486
|
+
/** One column. */
|
|
7402
7487
|
ONE = "ONE",
|
|
7488
|
+
/** Two columns. */
|
|
7403
7489
|
TWO = "TWO",
|
|
7490
|
+
/** Three columns. */
|
|
7404
7491
|
THREE = "THREE"
|
|
7405
7492
|
}
|
|
7406
7493
|
export interface Dropdown {
|
|
@@ -7456,6 +7543,8 @@ export interface DateTimeInput {
|
|
|
7456
7543
|
* Default: false.
|
|
7457
7544
|
*/
|
|
7458
7545
|
use24HourFormat?: boolean;
|
|
7546
|
+
/** Default value for the date time input. */
|
|
7547
|
+
default?: string | null;
|
|
7459
7548
|
}
|
|
7460
7549
|
export interface PhoneInput {
|
|
7461
7550
|
/** Label of the field */
|
|
@@ -7492,6 +7581,8 @@ export interface DateInput {
|
|
|
7492
7581
|
* Default: true
|
|
7493
7582
|
*/
|
|
7494
7583
|
showPlaceholder?: boolean | null;
|
|
7584
|
+
/** Default value for the date input. */
|
|
7585
|
+
default?: string | null;
|
|
7495
7586
|
}
|
|
7496
7587
|
export interface TimeInput {
|
|
7497
7588
|
/** Label of the field. Displayed text for the date/time input. */
|
|
@@ -7513,6 +7604,8 @@ export interface TimeInput {
|
|
|
7513
7604
|
* Default: false.
|
|
7514
7605
|
*/
|
|
7515
7606
|
use24HourFormat?: boolean;
|
|
7607
|
+
/** Default value for the time input. */
|
|
7608
|
+
default?: string | null;
|
|
7516
7609
|
}
|
|
7517
7610
|
export interface DatePicker {
|
|
7518
7611
|
/** Label of the field. Displayed text for the date/time input. */
|
|
@@ -7528,9 +7621,13 @@ export interface DatePicker {
|
|
|
7528
7621
|
placeholder?: string | null;
|
|
7529
7622
|
/** First day of the week displayed on date picker. */
|
|
7530
7623
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
7624
|
+
/** Default value for the date picker. */
|
|
7625
|
+
default?: string | null;
|
|
7531
7626
|
}
|
|
7532
7627
|
export declare enum FirstDayOfWeek {
|
|
7628
|
+
/** First day of the week is Monday. */
|
|
7533
7629
|
MONDAY = "MONDAY",
|
|
7630
|
+
/** First day of the week is Sunday. */
|
|
7534
7631
|
SUNDAY = "SUNDAY"
|
|
7535
7632
|
}
|
|
7536
7633
|
export interface NumberType {
|
|
@@ -7560,6 +7657,8 @@ export interface NumberInput {
|
|
|
7560
7657
|
* Default: true
|
|
7561
7658
|
*/
|
|
7562
7659
|
showLabel?: boolean | null;
|
|
7660
|
+
/** Default value for the number input */
|
|
7661
|
+
default?: number | null;
|
|
7563
7662
|
}
|
|
7564
7663
|
export interface RatingInput {
|
|
7565
7664
|
/** Label of the field */
|
|
@@ -7597,7 +7696,7 @@ export interface ArrayType {
|
|
|
7597
7696
|
/** Minimum amount of array elements. */
|
|
7598
7697
|
minItems?: number | null;
|
|
7599
7698
|
/** Type of items allowed in array. */
|
|
7600
|
-
items?:
|
|
7699
|
+
items?: ArrayTypeArrayItems;
|
|
7601
7700
|
}
|
|
7602
7701
|
export declare enum ItemType {
|
|
7603
7702
|
UNKNOWN_ITEM_TYPE = "UNKNOWN_ITEM_TYPE",
|
|
@@ -7661,7 +7760,7 @@ export interface PropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
7661
7760
|
/** Array type validation for property. */
|
|
7662
7761
|
arrayOptions?: ArrayType;
|
|
7663
7762
|
}
|
|
7664
|
-
export interface
|
|
7763
|
+
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
7665
7764
|
/** String type validation for items. */
|
|
7666
7765
|
stringOptions?: StringType;
|
|
7667
7766
|
/** Number type validation for items. */
|
|
@@ -7679,7 +7778,7 @@ export interface ArrayItems extends ArrayItemsItemTypeOptionsOneOf {
|
|
|
7679
7778
|
itemType?: ItemType;
|
|
7680
7779
|
}
|
|
7681
7780
|
/** @oneof */
|
|
7682
|
-
export interface
|
|
7781
|
+
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
7683
7782
|
/** String type validation for items. */
|
|
7684
7783
|
stringOptions?: StringType;
|
|
7685
7784
|
/** Number type validation for items. */
|
|
@@ -7790,16 +7889,17 @@ export interface FileUpload {
|
|
|
7790
7889
|
explanationText?: string | null;
|
|
7791
7890
|
}
|
|
7792
7891
|
export declare enum UploadFileFormat {
|
|
7892
|
+
/** Undefined upload file format. */
|
|
7793
7893
|
UNDEFINED = "UNDEFINED",
|
|
7794
|
-
/** Video files */
|
|
7894
|
+
/** Video files. */
|
|
7795
7895
|
VIDEO = "VIDEO",
|
|
7796
|
-
/** Image files */
|
|
7896
|
+
/** Image files. */
|
|
7797
7897
|
IMAGE = "IMAGE",
|
|
7798
|
-
/** Audio files */
|
|
7898
|
+
/** Audio files. */
|
|
7799
7899
|
AUDIO = "AUDIO",
|
|
7800
|
-
/** Document files */
|
|
7900
|
+
/** Document files. */
|
|
7801
7901
|
DOCUMENT = "DOCUMENT",
|
|
7802
|
-
/** Archive files */
|
|
7902
|
+
/** Archive files. */
|
|
7803
7903
|
ARCHIVE = "ARCHIVE"
|
|
7804
7904
|
}
|
|
7805
7905
|
export interface Signature {
|
|
@@ -7909,6 +8009,8 @@ export interface ProductCheckboxGroupOption {
|
|
|
7909
8009
|
_id?: string;
|
|
7910
8010
|
/** Media item. Media, associated with option, like image. */
|
|
7911
8011
|
media?: MediaItem;
|
|
8012
|
+
/** Flag identifying that option should be selected by default */
|
|
8013
|
+
default?: boolean;
|
|
7912
8014
|
}
|
|
7913
8015
|
export declare enum ImageFit {
|
|
7914
8016
|
UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
|
|
@@ -7996,8 +8098,9 @@ export interface ComponentsMultilineAddress {
|
|
|
7996
8098
|
autocompleteEnabled?: boolean;
|
|
7997
8099
|
}
|
|
7998
8100
|
export declare enum DefaultCountryConfigType {
|
|
8101
|
+
/** Unknown default country config type. */
|
|
7999
8102
|
UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
|
|
8000
|
-
/** Country
|
|
8103
|
+
/** Country is determined by customer's IP address. */
|
|
8001
8104
|
BY_IP = "BY_IP",
|
|
8002
8105
|
/** Pre-selected default country. */
|
|
8003
8106
|
COUNTRY = "COUNTRY"
|
|
@@ -8781,6 +8884,10 @@ export interface Description {
|
|
|
8781
8884
|
outcomeDescription?: string | null;
|
|
8782
8885
|
/** Representative image */
|
|
8783
8886
|
representativeImage?: string;
|
|
8887
|
+
/** Title of the builderless function template selection modal */
|
|
8888
|
+
builderlessTemplateSelectionModalTitle?: string | null;
|
|
8889
|
+
/** Subtitle of the builderless function template selection modal */
|
|
8890
|
+
builderlessTemplateSelectionModalSubtitle?: string | null;
|
|
8784
8891
|
}
|
|
8785
8892
|
export interface CheckoutContentSPIConfig {
|
|
8786
8893
|
/** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. */
|
|
@@ -8979,6 +9086,8 @@ export interface FactorConfig {
|
|
|
8979
9086
|
uriConfig?: SpiBaseUri;
|
|
8980
9087
|
/** the type of the factor */
|
|
8981
9088
|
factorType?: FactorType;
|
|
9089
|
+
/** whether the factor supports verify without enrolling first */
|
|
9090
|
+
supportsVerifyWithoutEnroll?: boolean;
|
|
8982
9091
|
}
|
|
8983
9092
|
export declare enum FactorType {
|
|
8984
9093
|
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
@@ -9083,14 +9192,6 @@ export interface LightboxEditorSettings {
|
|
|
9083
9192
|
/** Basic editor settings that are relevant to all page types */
|
|
9084
9193
|
base?: PageEditorSettings;
|
|
9085
9194
|
}
|
|
9086
|
-
export interface PageEditorSettings {
|
|
9087
|
-
/** Add the page to the site menu */
|
|
9088
|
-
addToSiteMenu?: boolean | null;
|
|
9089
|
-
/** Can a page be linked through the link panel */
|
|
9090
|
-
linkable?: boolean | null;
|
|
9091
|
-
/** Can a page be duplicated in the editor (if no essential widget is added in the container) */
|
|
9092
|
-
duplicatable?: boolean | null;
|
|
9093
|
-
}
|
|
9094
9195
|
export interface LightboxCloseOptions {
|
|
9095
9196
|
/** If true or unset, the lightbox will be closed when overlay is clicked */
|
|
9096
9197
|
closeOnOverlayClick?: boolean | null;
|
|
@@ -9387,23 +9488,50 @@ export interface TextToSpeechActionMessage {
|
|
|
9387
9488
|
export interface AudienceProviderConfig {
|
|
9388
9489
|
/** notification preference filter SPI configuration */
|
|
9389
9490
|
baseUri?: SpiBaseUri;
|
|
9491
|
+
/** Provider key */
|
|
9492
|
+
key?: string;
|
|
9493
|
+
/** The name of the audience provider, e.g. `Blog Post Subscribers` / `Contacts Labels` */
|
|
9494
|
+
displayName?: string;
|
|
9390
9495
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
9391
|
-
|
|
9496
|
+
participantType?: ParticipantType;
|
|
9392
9497
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
9393
9498
|
inputSchema?: Record<string, any> | null;
|
|
9394
|
-
/**
|
|
9395
|
-
|
|
9396
|
-
|
|
9397
|
-
|
|
9499
|
+
/**
|
|
9500
|
+
* Interface configuration
|
|
9501
|
+
* If empty default interface configuration will be auto generated based on the input schema
|
|
9502
|
+
*/
|
|
9503
|
+
interfaceConfiguration?: InterfaceConfiguration;
|
|
9398
9504
|
/** Specifying which optional methods are implemented. */
|
|
9399
9505
|
implementedMethods?: ImplementedMethods;
|
|
9400
|
-
/**
|
|
9401
|
-
|
|
9506
|
+
/** Define the scopes which the provider audience is relevant */
|
|
9507
|
+
scopes?: Scope[];
|
|
9402
9508
|
}
|
|
9403
9509
|
export declare enum ParticipantType {
|
|
9404
9510
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
9405
9511
|
WIX_USER = "WIX_USER",
|
|
9406
|
-
CONTACT = "CONTACT"
|
|
9512
|
+
CONTACT = "CONTACT",
|
|
9513
|
+
ANONYMOUS = "ANONYMOUS"
|
|
9514
|
+
}
|
|
9515
|
+
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
9516
|
+
/** Should be filled if the provider implements its own custom UI */
|
|
9517
|
+
widgetComponentConfiguration?: WidgetComponent;
|
|
9518
|
+
/** Type of interface configuration */
|
|
9519
|
+
type?: InterfaceConfigurationType;
|
|
9520
|
+
}
|
|
9521
|
+
/** @oneof */
|
|
9522
|
+
export interface InterfaceConfigurationOfTypeOneOf {
|
|
9523
|
+
/** Should be filled if the provider implements its own custom UI */
|
|
9524
|
+
widgetComponentConfiguration?: WidgetComponent;
|
|
9525
|
+
}
|
|
9526
|
+
export declare enum InterfaceConfigurationType {
|
|
9527
|
+
/** Widget component built by the provider */
|
|
9528
|
+
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
9529
|
+
/** Item Selection, in case the provider implemented item selection component */
|
|
9530
|
+
ITEM_SELECTION = "ITEM_SELECTION"
|
|
9531
|
+
}
|
|
9532
|
+
export interface WidgetComponent {
|
|
9533
|
+
/** widget component id */
|
|
9534
|
+
componentId?: string;
|
|
9407
9535
|
}
|
|
9408
9536
|
export interface ItemSelection {
|
|
9409
9537
|
/** Item selection provider key */
|
|
@@ -9415,6 +9543,12 @@ export interface ImplementedMethods {
|
|
|
9415
9543
|
/** Implements countParticipants */
|
|
9416
9544
|
countParticipants?: boolean;
|
|
9417
9545
|
}
|
|
9546
|
+
export declare enum Scope {
|
|
9547
|
+
/** Provider audience is available only in scope of specific site */
|
|
9548
|
+
SPECIFIC_SITE = "SPECIFIC_SITE",
|
|
9549
|
+
/** Provider audience is available only in scope of non specific site */
|
|
9550
|
+
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
9551
|
+
}
|
|
9418
9552
|
/** Config for the Price SPI */
|
|
9419
9553
|
export interface PriceSPIConfig {
|
|
9420
9554
|
/** Pricing plan for which the SPI method should optionally apply */
|
|
@@ -9459,10 +9593,12 @@ export interface EditorReactComponent {
|
|
|
9459
9593
|
type?: string;
|
|
9460
9594
|
/** The public description of the component do display */
|
|
9461
9595
|
description?: string;
|
|
9462
|
-
/**
|
|
9596
|
+
/** List of component resources. This comprises any runtime code we need to load and execute for the component. */
|
|
9463
9597
|
resources?: Resources;
|
|
9464
9598
|
/** The configuration describing the component abilities and behaviors on the Editor stage */
|
|
9465
9599
|
editorElement?: EditorElement;
|
|
9600
|
+
/** The installation settings of the component */
|
|
9601
|
+
installation?: InstallationInfo;
|
|
9466
9602
|
}
|
|
9467
9603
|
export interface Resources {
|
|
9468
9604
|
/** The bundle we will load and render in the browser */
|
|
@@ -9605,6 +9741,8 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
9605
9741
|
link?: Link;
|
|
9606
9742
|
/** The [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply */
|
|
9607
9743
|
schema?: Record<string, any> | null;
|
|
9744
|
+
/** An array of a data type */
|
|
9745
|
+
arrayItems?: ArrayItems;
|
|
9608
9746
|
/** Defines the type of data we are configuring */
|
|
9609
9747
|
dataType?: DataType;
|
|
9610
9748
|
/** Display name of this data item */
|
|
@@ -9624,6 +9762,8 @@ export interface DataItemSelectedDataTypeOneOf {
|
|
|
9624
9762
|
link?: Link;
|
|
9625
9763
|
/** The [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply */
|
|
9626
9764
|
schema?: Record<string, any> | null;
|
|
9765
|
+
/** An array of a data type */
|
|
9766
|
+
arrayItems?: ArrayItems;
|
|
9627
9767
|
}
|
|
9628
9768
|
export declare enum DataType {
|
|
9629
9769
|
UNKNOWN_DataType = "UNKNOWN_DataType",
|
|
@@ -9666,7 +9806,11 @@ export declare enum DataType {
|
|
|
9666
9806
|
/** A valid `regex` pattern supplied by the User */
|
|
9667
9807
|
regex = "regex",
|
|
9668
9808
|
/** A unique identifier */
|
|
9669
|
-
guid = "guid"
|
|
9809
|
+
guid = "guid",
|
|
9810
|
+
/** a HTML text with css inline styling */
|
|
9811
|
+
richText = "richText",
|
|
9812
|
+
/** An array type of data */
|
|
9813
|
+
arrayItems = "arrayItems"
|
|
9670
9814
|
}
|
|
9671
9815
|
export interface Text {
|
|
9672
9816
|
/** Indicates maximum length allowed for the text */
|
|
@@ -9782,6 +9926,29 @@ export declare enum LinkType {
|
|
|
9782
9926
|
/** A link that directs the user to wix login dialog */
|
|
9783
9927
|
loginToWixLink = "loginToWixLink"
|
|
9784
9928
|
}
|
|
9929
|
+
/** An array of data items or complex data types */
|
|
9930
|
+
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
9931
|
+
/** The definition of multiple data items in each item of the Array */
|
|
9932
|
+
data?: DataItems;
|
|
9933
|
+
/** For a single data type in the array */
|
|
9934
|
+
dataItem?: DataItem;
|
|
9935
|
+
/** The maximum size of the Array (there will be a size limit in the Storage as well) */
|
|
9936
|
+
maxSize?: number | null;
|
|
9937
|
+
}
|
|
9938
|
+
/** @oneof */
|
|
9939
|
+
export interface ArrayItemsArrayDataOneOf {
|
|
9940
|
+
/** The definition of multiple data items in each item of the Array */
|
|
9941
|
+
data?: DataItems;
|
|
9942
|
+
/** For a single data type in the array */
|
|
9943
|
+
dataItem?: DataItem;
|
|
9944
|
+
}
|
|
9945
|
+
export interface DataItems {
|
|
9946
|
+
/**
|
|
9947
|
+
* For an array of complex object types
|
|
9948
|
+
* Each item in the array, will contain all this data structure
|
|
9949
|
+
*/
|
|
9950
|
+
items?: Record<string, DataItem>;
|
|
9951
|
+
}
|
|
9785
9952
|
export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
9786
9953
|
/** An new element definition */
|
|
9787
9954
|
inlineElement?: InlineElement;
|
|
@@ -9969,10 +10136,76 @@ export interface RefElement {
|
|
|
9969
10136
|
/** The override of the used element custom actions */
|
|
9970
10137
|
customActions?: Record<string, Action>;
|
|
9971
10138
|
}
|
|
10139
|
+
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
10140
|
+
/** Which static container should the widget be installed at */
|
|
10141
|
+
staticContainer?: StaticContainer;
|
|
10142
|
+
/** Default presets per breakpoint with which the widget should be installed */
|
|
10143
|
+
presets?: DefaultPresets;
|
|
10144
|
+
}
|
|
10145
|
+
/** @oneof */
|
|
10146
|
+
export interface InstallationInfoTargetContainerOneOf {
|
|
10147
|
+
/** Which static container should the widget be installed at */
|
|
10148
|
+
staticContainer?: StaticContainer;
|
|
10149
|
+
}
|
|
9972
10150
|
export interface MarketplaceSPIConfig {
|
|
9973
10151
|
/** URI where the SPI implementer is deployed */
|
|
9974
10152
|
deploymentUri?: SpiBaseUri;
|
|
9975
10153
|
}
|
|
10154
|
+
export interface FormSchemaDynamicValuesSpiConfig {
|
|
10155
|
+
/** URI where the SPI Implementer is deployed. */
|
|
10156
|
+
uriConfig?: SpiBaseUri;
|
|
10157
|
+
/** Form ID which contains dynamic fields. */
|
|
10158
|
+
formId?: string;
|
|
10159
|
+
/** Field IDs which trigger loading of dynamic values. */
|
|
10160
|
+
fieldsIds?: string[];
|
|
10161
|
+
}
|
|
10162
|
+
export interface BlogPaywallProviderConfig {
|
|
10163
|
+
/** Uri config */
|
|
10164
|
+
uriConfig?: SpiBaseUri;
|
|
10165
|
+
}
|
|
10166
|
+
export interface RewardProviderConfig {
|
|
10167
|
+
/** URI where the SPI Implementer is deployed */
|
|
10168
|
+
deploymentUri?: SpiBaseUri;
|
|
10169
|
+
/** Name of the reward that will be visible to the end users */
|
|
10170
|
+
rewardName?: string;
|
|
10171
|
+
/** Description of the reward that will be visible to the end users, describing how the reward works */
|
|
10172
|
+
rewardDescription?: string;
|
|
10173
|
+
}
|
|
10174
|
+
export interface ProductRestrictionsConfig {
|
|
10175
|
+
/** URI where the SPI Implementer is deployed */
|
|
10176
|
+
deploymentUri?: SpiBaseUri;
|
|
10177
|
+
/** catalog restrictions configuration */
|
|
10178
|
+
productRestrictionsConfig?: RestrictionsConfig;
|
|
10179
|
+
}
|
|
10180
|
+
export interface RestrictionsConfig {
|
|
10181
|
+
/** prices restrictions that affect fields like full price, compare at price etc */
|
|
10182
|
+
prices?: Restriction;
|
|
10183
|
+
/** options restrictions that affect options edit except images on choices */
|
|
10184
|
+
options?: Restriction;
|
|
10185
|
+
/** modifier restrictions that affect modifiers */
|
|
10186
|
+
modifiers?: Restriction;
|
|
10187
|
+
/** item identifiers affect quantity, sku, barcode on inventory */
|
|
10188
|
+
inventory?: Restriction;
|
|
10189
|
+
/** pre order restrictions that affect fields like pre order */
|
|
10190
|
+
preOrder?: Restriction;
|
|
10191
|
+
/** duplicate product restriction action */
|
|
10192
|
+
duplicateProduct?: Restriction;
|
|
10193
|
+
}
|
|
10194
|
+
export interface Restriction {
|
|
10195
|
+
/** restriction level of WARNING or LOCKED */
|
|
10196
|
+
restrictionLevel?: RestrictionLevel;
|
|
10197
|
+
}
|
|
10198
|
+
export declare enum RestrictionLevel {
|
|
10199
|
+
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
10200
|
+
WARNING = "WARNING",
|
|
10201
|
+
LOCKED = "LOCKED"
|
|
10202
|
+
}
|
|
10203
|
+
export interface FormSubmissionModerationSpiConfig {
|
|
10204
|
+
/** URI where the SPI Implementer is deployed */
|
|
10205
|
+
baseUri?: SpiBaseUri;
|
|
10206
|
+
/** Forms for which the SPI method should apply */
|
|
10207
|
+
formIds?: string[];
|
|
10208
|
+
}
|
|
9976
10209
|
export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
|
|
9977
10210
|
gradualRollout?: GradualRolloutCacheEntity;
|
|
9978
10211
|
gradualUpdate?: GradualUpdateCacheEntity;
|
|
@@ -10133,6 +10366,7 @@ export interface DataExtensionSchemaCreatedEnvelope {
|
|
|
10133
10366
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10134
10367
|
* @webhook
|
|
10135
10368
|
* @eventType wix.data_extensions.v1.data_extension_schema_created
|
|
10369
|
+
* @slug created
|
|
10136
10370
|
* @documentationMaturity preview
|
|
10137
10371
|
*/
|
|
10138
10372
|
export declare function onDataExtensionSchemaCreated(handler: (event: DataExtensionSchemaCreatedEnvelope) => void | Promise<void>): void;
|
|
@@ -10154,6 +10388,7 @@ export interface DataExtensionSchemaDeletedEnvelope {
|
|
|
10154
10388
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10155
10389
|
* @webhook
|
|
10156
10390
|
* @eventType wix.data_extensions.v1.data_extension_schema_deleted
|
|
10391
|
+
* @slug deleted
|
|
10157
10392
|
* @documentationMaturity preview
|
|
10158
10393
|
*/
|
|
10159
10394
|
export declare function onDataExtensionSchemaDeleted(handler: (event: DataExtensionSchemaDeletedEnvelope) => void | Promise<void>): void;
|
|
@@ -10176,6 +10411,7 @@ export interface DataExtensionSchemaUpdatedEnvelope {
|
|
|
10176
10411
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10177
10412
|
* @webhook
|
|
10178
10413
|
* @eventType wix.data_extensions.v1.data_extension_schema_updated
|
|
10414
|
+
* @slug updated
|
|
10179
10415
|
* @documentationMaturity preview
|
|
10180
10416
|
*/
|
|
10181
10417
|
export declare function onDataExtensionSchemaUpdated(handler: (event: DataExtensionSchemaUpdatedEnvelope) => void | Promise<void>): void;
|
|
@@ -10234,14 +10470,20 @@ export declare function updateDataExtensionSchema(dataExtensionSchema: DataExten
|
|
|
10234
10470
|
* @permissionId DATA_EXTENSION_SCHEMA.READ
|
|
10235
10471
|
* @permissionScope Manage Bookings Services and Settings
|
|
10236
10472
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
10473
|
+
* @permissionScope Manage Events
|
|
10474
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
10237
10475
|
* @permissionScope Manage Data Extensions Schemas
|
|
10238
10476
|
* @permissionScopeId SCOPE.DATAEXTENSIONS.MANAGE-SCHEMAS
|
|
10239
10477
|
* @permissionScope Manage Portfolio
|
|
10240
10478
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
10479
|
+
* @permissionScope Access Verticals by Automations
|
|
10480
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
10241
10481
|
* @permissionScope Read Data Extensions Schemas
|
|
10242
10482
|
* @permissionScopeId SCOPE.DATAEXTENSIONS.READ-SCHEMAS
|
|
10243
10483
|
* @permissionScope Manage Restaurants - all permissions
|
|
10244
10484
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
10485
|
+
* @permissionScope Set Up Automations
|
|
10486
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
10245
10487
|
* @applicableIdentity APP
|
|
10246
10488
|
* @applicableIdentity VISITOR
|
|
10247
10489
|
* @fqn wix.infra.dataextensions.v1.DataExtensionSchemaService.ListDataExtensionSchemas
|