@wix/auto_sdk_data-extension-schema_schemas 1.0.24 → 1.0.26
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 +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.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- 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 +692 -246
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- 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 +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.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- 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 +692 -246
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- 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 +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.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- 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 +692 -246
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- 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 +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.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- 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 +692 -246
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -123,6 +123,8 @@ export interface DataExtensionSchema {
|
|
|
123
123
|
}
|
|
124
124
|
export declare enum DataExtensionSchemaState {
|
|
125
125
|
}
|
|
126
|
+
/** @enumType */
|
|
127
|
+
export type DataExtensionSchemaStateWithLiterals = DataExtensionSchemaState;
|
|
126
128
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
127
129
|
createdEvent?: EntityCreatedEvent;
|
|
128
130
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -223,7 +225,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
223
225
|
*/
|
|
224
226
|
appId?: string;
|
|
225
227
|
/** @readonly */
|
|
226
|
-
identityType?:
|
|
228
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
227
229
|
}
|
|
228
230
|
/** @oneof */
|
|
229
231
|
export interface IdentificationDataIdOneOf {
|
|
@@ -255,6 +257,8 @@ export declare enum WebhookIdentityType {
|
|
|
255
257
|
WIX_USER = "WIX_USER",
|
|
256
258
|
APP = "APP"
|
|
257
259
|
}
|
|
260
|
+
/** @enumType */
|
|
261
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
258
262
|
export interface ReindexEvent {
|
|
259
263
|
/**
|
|
260
264
|
* fqdn of the dext schema that needs reindexing
|
|
@@ -308,7 +312,7 @@ export interface ListDataExtensionSchemasRequest {
|
|
|
308
312
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
309
313
|
* @maxSize 5
|
|
310
314
|
*/
|
|
311
|
-
fields?:
|
|
315
|
+
fields?: RequestedFieldWithLiterals[];
|
|
312
316
|
/**
|
|
313
317
|
* Extension points within the given entity.
|
|
314
318
|
* @maxSize 20
|
|
@@ -322,6 +326,8 @@ export declare enum RequestedField {
|
|
|
322
326
|
/** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
|
|
323
327
|
ARCHIVED = "ARCHIVED"
|
|
324
328
|
}
|
|
329
|
+
/** @enumType */
|
|
330
|
+
export type RequestedFieldWithLiterals = RequestedField | 'UNKNOWN_REQUESTED_FIELD' | 'ARCHIVED';
|
|
325
331
|
export interface ListDataExtensionSchemasResponse {
|
|
326
332
|
/** Requested schemas. */
|
|
327
333
|
dataExtensionSchemas?: DataExtensionSchema[];
|
|
@@ -352,7 +358,7 @@ export interface DeleteGlobalExtensionSchemaRequest {
|
|
|
352
358
|
*/
|
|
353
359
|
extensionPoint?: string;
|
|
354
360
|
/** state */
|
|
355
|
-
state?:
|
|
361
|
+
state?: DataExtensionSchemaStateWithLiterals;
|
|
356
362
|
}
|
|
357
363
|
export interface DeleteGlobalExtensionSchemaResponse {
|
|
358
364
|
}
|
|
@@ -400,7 +406,7 @@ export interface RuntimeComponentCacheEntityComponent {
|
|
|
400
406
|
*/
|
|
401
407
|
name?: string | null;
|
|
402
408
|
/** the type of the component */
|
|
403
|
-
type?:
|
|
409
|
+
type?: ComponentTypeWithLiterals;
|
|
404
410
|
/** the data of the component */
|
|
405
411
|
data?: ComponentData;
|
|
406
412
|
/** The external id of the component */
|
|
@@ -598,8 +604,11 @@ export declare enum ComponentType {
|
|
|
598
604
|
LEGENDS_PERSONA_CONFIGURATION = "LEGENDS_PERSONA_CONFIGURATION",
|
|
599
605
|
WIX_HOSTING_APP_DEPLOYMENT_PROVIDER = "WIX_HOSTING_APP_DEPLOYMENT_PROVIDER",
|
|
600
606
|
BACKEND_WORKER = "BACKEND_WORKER",
|
|
601
|
-
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER"
|
|
607
|
+
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER",
|
|
608
|
+
WIX_HOSTING_APP_ENVIRONMENT_PROVIDER = "WIX_HOSTING_APP_ENVIRONMENT_PROVIDER"
|
|
602
609
|
}
|
|
610
|
+
/** @enumType */
|
|
611
|
+
export type ComponentTypeWithLiterals = ComponentType | 'NONE' | 'STUDIO' | 'PLATFORM' | 'WORKER' | 'DASHBOARD' | 'WIDGET' | 'PAGE' | 'DASHBOARD_PLATFORM' | 'STUDIO_WIDGET' | 'EMBEDDED_SCRIPT' | 'EXTENSION' | 'SNIPPET_SOLUTION' | 'DATA_COMPONENT' | 'WEB' | 'DC_CONFIG' | 'WIDGET_OUT_OF_IFRAME' | 'PAGE_OUT_OF_IFRAME' | 'STATIC_FILE' | 'APP_CONFIG' | 'MULTIPLE_DASHBOARDS' | 'PAYMENTS_GATEWAY' | 'CODE_PACKAGE' | 'AUTOMATION_TRIGGER' | 'INVOICES_ACTIONS' | 'DASHBOARD_APPLICATION' | 'CONTACT_LABELS' | 'WIDGET_PLUGIN' | 'CROSS_SELL' | 'LOCAL_DELIVERY' | 'PAYMENT_PROVIDER' | 'ECOM_MEMBERSHIPS' | 'ECOM_LINE_ITEMS_ENRICHER' | 'ECOM_SHIPPING_RATES' | 'SHIPPING_LABEL_CARRIER' | 'RESTAURANTS_POS' | 'FICTIONAL_SHIPPING_PROVIDER' | 'ALERT_ENRICHER' | 'DATA_EXTENSIONS' | 'GENERIC_HOOKS' | 'AUTOMATIONS_ACTION_PROVIDER' | 'ECOM_CATALOG' | 'BACK_OFFICE_EXTENSION_CONTAINER' | 'BACK_OFFICE_EXTENSION' | 'AUTOMATIONS_TRIGGER_PROVIDER' | 'IDENTITY_PRE_REGISTRATION' | 'PREMIUM_PRODUCTS_PATHS' | 'ECOM_CUSTOM_SCOPE' | 'GIFT_CARDS_PROVIDER' | 'DEALER_EXTERNAL_FILTER_PROVIDER' | 'ECOM_DROPSHIPPING_PROVIDER' | 'INVOICES_PROVIDER' | 'SEO_KEYWORDS_SUGGESTIONS' | 'ECOM_DISCOUNTS_TRIGGER' | 'MULTILINGUAL_CONTENT_PROVIDER' | 'APPLICATION_AUTOMATION' | 'BACK_OFFICE_SIDEBAR_CATEGORY' | 'BACK_OFFICE_PAGE' | 'ECOM_ADDITIONAL_FEES' | 'PING_USER_NOTIFICATION' | 'ECOM_RECOMMENDATIONS_PROVIDER' | 'BOOKINGS_PRICING_PROVIDER' | 'IDENTITY_AUTHENTICATOR' | 'IDENTITY_IDP_CONNECTOR' | 'ITEMS_SELECTION_PROVIDER' | 'PORTFOLIO_SYNCED_PROJECTS_PROVIDER' | 'COMMUNICATION_CHANNEL' | 'IDENTITY_POST_LOGIN' | 'BACK_OFFICE_WIDGET' | 'SOCIAL_MARKETING_DESIGN' | 'FORMS_SUBMISSIONS_PROVIDER' | 'WIX_OFFERING' | 'DEV_CENTER_TESTING_COMPONENT' | 'COMPONENTS_VALIDATOR_PROVIDER' | 'COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER' | 'FORMS_SCHEMA_PROVIDER' | 'BOOKINGS_EXTERNAL_CALENDAR_PROVIDER' | 'ECOM_DEFAULT_TAXATION_CATEGORY' | 'VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER' | 'PING_UOU_NOTIFICATION' | 'HEADLESS_OAUTH' | 'ECOM_TAX_CALCULATOR_SPI' | 'COMMENTS_MODERATION_PROVIDER' | 'GRID_APP_FILES_TRANSFORMER' | 'BENEFIT_PROGRAMS_POLICY_PROVIDER' | 'PREMIUM_CUSTOM_CHARGES' | 'ECOM_VALIDATIONS' | 'COMPONENT_REFERENCE_DATA_PROVIDER' | 'WIX_REVIEWS_PRODUCT_CATALOG' | 'SOCIAL_MARKETING_DESIGNS_PROVIDER' | 'GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER' | 'COMMENTS_FILTER_PROVIDER' | 'BILLING_TAX_ID_VALIDATOR' | 'PING_SETTINGS_GROUP' | 'FORMS_SPAM_SUBMISSIONS_PROVIDER' | 'EDITOR_ADDON' | 'EXTERNAL_DATABASE_PROVIDER' | 'ECOM_PAYMENT_SETTINGS' | 'NOTIFICATION_TOPIC' | 'NOTIFICATION_PREFERENCES_FILTER_PROVIDER' | 'BOOKINGS_RESOURCE_TYPES_PROVIDER' | 'PRICING_PLANS_FORM_CONFIGURATION' | 'USER_NOTIFICATION' | 'CONTACT_NOTIFICATION' | 'UNIFIED_PAGE' | 'AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'PROPOSAL_EDITOR_PROVIDER' | 'CUSTOM_TABLE_RESERVATIONS_PROVIDER' | 'COMMENTS_CONTEXT_PROVIDER' | 'FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER' | 'AUTOMATIONS_VELO_ACTION_PROVIDER' | 'CALENDAR_EVENT_TYPE_PROVIDER' | 'RESERVED' | 'SMS_ACTION_MESSAGE' | 'BOOKING_POLICY_PROVIDER' | 'MULTI_SERVICE_BOOKING_POLICY_PROVIDER' | 'AI_ASSISTANT' | 'FORMS_SUBMISSIONS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA' | 'TAX_CALCULATION_PROVIDER' | 'TAX_GROUPS_PROVIDER' | 'BACK_OFFICE_MODAL' | 'DEPLOYMENT_PIPELINE_PROVIDER' | 'CUSTOM_ELEMENT_WIDGET' | 'BACK_OFFICE_EXTENSION_WIDGET' | 'BACK_OFFICE_EXTENSION_MENU_ITEM' | 'FORM_TEMPLATE' | 'NOTIFICATION_CONTENT' | 'BROADCAST_LIST' | 'PARTNERS_PAYOUTS' | 'WIX_REVIEWS_ENTITY_CATALOG' | 'VELO_PUBLISH_PIPELINE_TASK_PROVIDER' | 'FUNCTIONS_SHOP_PRICE_PROVIDER' | 'FUNCTION' | 'ECOM_CHECKOUT_CONTENT' | 'COMMUNICATION_CHANNEL_PROVIDER' | 'WEBHOOK' | 'TOPOLOGY' | 'LOYALTY_CUSTOM_REWARDS' | 'FUNCTION_RECIPE' | 'BACK_OFFICE_EXTERNAL_URL' | 'IDENTITY_FACTOR' | 'ECOM_DISCOUNTS' | 'VELO_CUSTOM_CSS' | 'DEALER_ADAPTIVE_COMPONENT_PROVIDER' | 'AI_ASSISTANT_ACTION' | 'ECOM_INVENTORY' | 'MONITORING' | 'PAPI_PROVIDER' | 'UNIFIED_LIGHTBOX' | 'FORMS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA_GROUP' | 'PANEL' | 'PREMIUM_PURCHASE_VALIDATIONS' | 'BROWSER_STORAGE' | 'SDK_DEFINITION' | 'SITE_WIDGET_SLOT' | 'CALENDAR_EVENT_VALIDATION_PROVIDER' | 'CLIENT_SIDE_SERVICE' | 'BILLING_SETTINGS' | 'PATTERNS_WIZARD' | 'APPLICATION_PROFILE' | 'TEXT_TO_SPEECH_ACTION_MESSAGE' | 'AUDIENCE_PROVIDER' | 'PRICING_PLANS_PRICE' | 'PRICING_PLAN_START_DATE_LIMITS' | 'PRICING_PLAN_START_DATE_RULES' | 'EVENTS_TICKET_RESERVATIONS' | 'PAYMENTS_DISPUTE_SERVICE_PLUGIN' | 'PRICING_PLANS_FEES' | 'EDITOR_REACT_COMPONENT' | 'SUPPLIERS_HUB_MARKETPLACE' | 'FORM_SCHEMA_DYNAMIC_VALUES' | 'BLOG_PAYWALL_PROVIDER' | 'LOYALTY_CUSTOM_REWARDS_V2' | 'STORES_PRODUCT_RESTRICTIONS' | 'FORM_SUBMISSION_MODERATION' | 'EVENTS_EVENT_BADGES' | 'BILLING_OPERATION' | 'BACK_OFFICE_CUSTOMIZATION' | 'COMPONENT_ENRICHER_PROVIDER' | 'BACK_OFFICE_RESTRICTED_CUSTOMIZATION' | 'EDITOR_APP_PREVIEWS_POC' | 'LEGENDS_PERSONA_CONFIGURATION' | 'WIX_HOSTING_APP_DEPLOYMENT_PROVIDER' | 'BACKEND_WORKER' | 'EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'WIX_HOSTING_APP_ENVIRONMENT_PROVIDER';
|
|
603
612
|
/** Component data */
|
|
604
613
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
605
614
|
/**
|
|
@@ -803,7 +812,7 @@ export interface WidgetComponentData {
|
|
|
803
812
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
804
813
|
fixedPositionOption?: FixedPositionOptions;
|
|
805
814
|
/** Widget will automatically be stretched to this width after installing it */
|
|
806
|
-
widgetWidthType?:
|
|
815
|
+
widgetWidthType?: WidgetWidthTypeWithLiterals;
|
|
807
816
|
/**
|
|
808
817
|
* Widget width size
|
|
809
818
|
* @max 9999
|
|
@@ -886,9 +895,9 @@ export interface WidgetComponentData {
|
|
|
886
895
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
887
896
|
export interface FixedPositionOptions {
|
|
888
897
|
/** Vertical widget position in the browser window */
|
|
889
|
-
widgetVertical?:
|
|
898
|
+
widgetVertical?: WidgetVerticalWithLiterals;
|
|
890
899
|
/** Horizontal widget position in the browser window */
|
|
891
|
-
widgetHorizontal?:
|
|
900
|
+
widgetHorizontal?: WidgetHorizontalWithLiterals;
|
|
892
901
|
}
|
|
893
902
|
/** Vertical widget position in the browser window */
|
|
894
903
|
export declare enum WidgetVertical {
|
|
@@ -897,6 +906,8 @@ export declare enum WidgetVertical {
|
|
|
897
906
|
CENTER_VERTICAL = "CENTER_VERTICAL",
|
|
898
907
|
BOTTOM = "BOTTOM"
|
|
899
908
|
}
|
|
909
|
+
/** @enumType */
|
|
910
|
+
export type WidgetVerticalWithLiterals = WidgetVertical | 'NONE_VERTICAL' | 'TOP' | 'CENTER_VERTICAL' | 'BOTTOM';
|
|
900
911
|
/** Horizontal widget position in the browser window */
|
|
901
912
|
export declare enum WidgetHorizontal {
|
|
902
913
|
NONE_HORIZONTAL = "NONE_HORIZONTAL",
|
|
@@ -904,6 +915,8 @@ export declare enum WidgetHorizontal {
|
|
|
904
915
|
CENTER_HORIZONTAL = "CENTER_HORIZONTAL",
|
|
905
916
|
RIGHT = "RIGHT"
|
|
906
917
|
}
|
|
918
|
+
/** @enumType */
|
|
919
|
+
export type WidgetHorizontalWithLiterals = WidgetHorizontal | 'NONE_HORIZONTAL' | 'LEFT' | 'CENTER_HORIZONTAL' | 'RIGHT';
|
|
907
920
|
/** Widget will automatically be stretched to this width after installing it */
|
|
908
921
|
export declare enum WidgetWidthType {
|
|
909
922
|
NONE_TYPE = "NONE_TYPE",
|
|
@@ -912,6 +925,8 @@ export declare enum WidgetWidthType {
|
|
|
912
925
|
/** Full width of the browser window */
|
|
913
926
|
FULL = "FULL"
|
|
914
927
|
}
|
|
928
|
+
/** @enumType */
|
|
929
|
+
export type WidgetWidthTypeWithLiterals = WidgetWidthType | 'NONE_TYPE' | 'CUSTOM' | 'FULL';
|
|
915
930
|
export interface WidgetDisplay {
|
|
916
931
|
name?: string;
|
|
917
932
|
/**
|
|
@@ -927,7 +942,7 @@ export interface WidgetDisplay {
|
|
|
927
942
|
variationId?: string | null;
|
|
928
943
|
}
|
|
929
944
|
export interface Position {
|
|
930
|
-
region?:
|
|
945
|
+
region?: RegionWithLiterals;
|
|
931
946
|
}
|
|
932
947
|
export declare enum Region {
|
|
933
948
|
no_region = "no_region",
|
|
@@ -935,6 +950,8 @@ export declare enum Region {
|
|
|
935
950
|
pageContainer = "pageContainer",
|
|
936
951
|
footer = "footer"
|
|
937
952
|
}
|
|
953
|
+
/** @enumType */
|
|
954
|
+
export type RegionWithLiterals = Region | 'no_region' | 'header' | 'pageContainer' | 'footer';
|
|
938
955
|
export interface SubPage {
|
|
939
956
|
/** The path of the subpage */
|
|
940
957
|
key?: string;
|
|
@@ -962,7 +979,7 @@ export interface DisplayProperties {
|
|
|
962
979
|
left?: DisplayValue;
|
|
963
980
|
}
|
|
964
981
|
export interface DisplayValue {
|
|
965
|
-
type?:
|
|
982
|
+
type?: UnitTypeWithLiterals;
|
|
966
983
|
value?: number | null;
|
|
967
984
|
}
|
|
968
985
|
export declare enum UnitType {
|
|
@@ -973,14 +990,16 @@ export declare enum UnitType {
|
|
|
973
990
|
VW = "VW",
|
|
974
991
|
PERCENTAGE = "PERCENTAGE"
|
|
975
992
|
}
|
|
993
|
+
/** @enumType */
|
|
994
|
+
export type UnitTypeWithLiterals = UnitType | 'NO_UNIT' | 'AUTO' | 'PX' | 'VH' | 'VW' | 'PERCENTAGE';
|
|
976
995
|
export interface Docking {
|
|
977
996
|
desktop?: DockingProperties;
|
|
978
997
|
tablet?: DockingProperties;
|
|
979
998
|
mobile?: DockingProperties;
|
|
980
999
|
}
|
|
981
1000
|
export interface DockingProperties {
|
|
982
|
-
horizontal?:
|
|
983
|
-
vertical?:
|
|
1001
|
+
horizontal?: HorizontalDockingWithLiterals;
|
|
1002
|
+
vertical?: VerticalDockingWithLiterals;
|
|
984
1003
|
}
|
|
985
1004
|
export declare enum HorizontalDocking {
|
|
986
1005
|
NO_HDOCKING = "NO_HDOCKING",
|
|
@@ -988,12 +1007,16 @@ export declare enum HorizontalDocking {
|
|
|
988
1007
|
HCENTER = "HCENTER",
|
|
989
1008
|
RIGHT_DOCKING = "RIGHT_DOCKING"
|
|
990
1009
|
}
|
|
1010
|
+
/** @enumType */
|
|
1011
|
+
export type HorizontalDockingWithLiterals = HorizontalDocking | 'NO_HDOCKING' | 'LEFT_DOCKING' | 'HCENTER' | 'RIGHT_DOCKING';
|
|
991
1012
|
export declare enum VerticalDocking {
|
|
992
1013
|
NO_VDOCKING = "NO_VDOCKING",
|
|
993
1014
|
TOP_DOCKING = "TOP_DOCKING",
|
|
994
1015
|
VCENTER = "VCENTER",
|
|
995
1016
|
BOTTOM_DOCKING = "BOTTOM_DOCKING"
|
|
996
1017
|
}
|
|
1018
|
+
/** @enumType */
|
|
1019
|
+
export type VerticalDockingWithLiterals = VerticalDocking | 'NO_VDOCKING' | 'TOP_DOCKING' | 'VCENTER' | 'BOTTOM_DOCKING';
|
|
997
1020
|
export interface Height {
|
|
998
1021
|
desktop?: DisplayValue;
|
|
999
1022
|
tablet?: DisplayValue;
|
|
@@ -1085,7 +1108,7 @@ export interface Padding {
|
|
|
1085
1108
|
export interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {
|
|
1086
1109
|
replacingOptions?: ReplacingOptions;
|
|
1087
1110
|
replaceableOptions?: ReplaceableOptions;
|
|
1088
|
-
type?:
|
|
1111
|
+
type?: ReplacementTypeWithLiterals;
|
|
1089
1112
|
}
|
|
1090
1113
|
/** @oneof */
|
|
1091
1114
|
export interface PageReplaceOptionsOptionsOneOf {
|
|
@@ -1109,6 +1132,8 @@ export declare enum ReplacementType {
|
|
|
1109
1132
|
REPLACING = "REPLACING",
|
|
1110
1133
|
REPLACEABLE = "REPLACEABLE"
|
|
1111
1134
|
}
|
|
1135
|
+
/** @enumType */
|
|
1136
|
+
export type ReplacementTypeWithLiterals = ReplacementType | 'UNKNOWN_REPLACEMENT' | 'REPLACING' | 'REPLACEABLE';
|
|
1112
1137
|
export interface ReplacingOptions {
|
|
1113
1138
|
/** describe the page and application id that this page will replace. */
|
|
1114
1139
|
pageReplace?: PageReplace;
|
|
@@ -1213,7 +1238,7 @@ export interface ApiSlot {
|
|
|
1213
1238
|
/** Role of the slot component (uniquely identifies slot within parent comp; used by Velo) - former "slotName" */
|
|
1214
1239
|
slotRole?: string;
|
|
1215
1240
|
/** The list of interfaces that should be implemented by a plugin in order to fit the slot */
|
|
1216
|
-
pluginInterfaces?:
|
|
1241
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
1217
1242
|
/** Id of the slot component (a.k.a. Velo role) */
|
|
1218
1243
|
slotId?: string;
|
|
1219
1244
|
}
|
|
@@ -1246,9 +1271,11 @@ export declare enum PluginInterface {
|
|
|
1246
1271
|
/** The slot requires the CART interface to be implemented by the plugin. The plugin specifies the implementation of the CART interface */
|
|
1247
1272
|
CART = "CART"
|
|
1248
1273
|
}
|
|
1274
|
+
/** @enumType */
|
|
1275
|
+
export type PluginInterfaceWithLiterals = PluginInterface | 'NONE_INTERFACE' | 'REVIEWS' | 'RATINGS_SUMMARY' | 'RATINGS_SUMMARY_OOI_LIST' | 'BOOKINGS_SERVICE' | 'BOOKINGS_FORM' | 'BASE' | 'EVENT' | 'PRODUCT' | 'CHECKOUT' | 'CATEGORY' | 'BOOKINGS_CALENDAR' | 'CART';
|
|
1249
1276
|
export interface ExtensionExposure {
|
|
1250
1277
|
/** Determines if the component is production ready */
|
|
1251
|
-
maturity?:
|
|
1278
|
+
maturity?: MaturityWithLiterals;
|
|
1252
1279
|
}
|
|
1253
1280
|
export declare enum Exposure {
|
|
1254
1281
|
/** Unexposed. to be used by dev team only */
|
|
@@ -1258,6 +1285,8 @@ export declare enum Exposure {
|
|
|
1258
1285
|
/** Exposed to the world */
|
|
1259
1286
|
PUBLIC = "PUBLIC"
|
|
1260
1287
|
}
|
|
1288
|
+
/** @enumType */
|
|
1289
|
+
export type ExposureWithLiterals = Exposure | 'PRIVATE' | 'INTERNAL' | 'PUBLIC';
|
|
1261
1290
|
export declare enum Maturity {
|
|
1262
1291
|
/** Immature. subject to breaking changes */
|
|
1263
1292
|
ALPHA = "ALPHA",
|
|
@@ -1268,6 +1297,8 @@ export declare enum Maturity {
|
|
|
1268
1297
|
/** Not yet implemented */
|
|
1269
1298
|
NOT_IMPLEMENTED = "NOT_IMPLEMENTED"
|
|
1270
1299
|
}
|
|
1300
|
+
/** @enumType */
|
|
1301
|
+
export type MaturityWithLiterals = Maturity | 'ALPHA' | 'BETA' | 'GA' | 'NOT_IMPLEMENTED';
|
|
1271
1302
|
/** A page out of iframe component that loads directly in the Editor DOM */
|
|
1272
1303
|
export interface PageOutOfIframeComponentData {
|
|
1273
1304
|
/**
|
|
@@ -1377,7 +1408,7 @@ export interface PlatfromComponentData {
|
|
|
1377
1408
|
/** dictates if the app has migrated to the new platform API */
|
|
1378
1409
|
migratedToNewPlatformApi?: boolean;
|
|
1379
1410
|
/** The HTTP Verb used to call the router, if not set will be POST */
|
|
1380
|
-
routerHttpMethod?:
|
|
1411
|
+
routerHttpMethod?: HTTPMethodWithLiterals;
|
|
1381
1412
|
}
|
|
1382
1413
|
/** Add interim support for HTTP methods before a bigger rewrite for Routers as a component */
|
|
1383
1414
|
export declare enum HTTPMethod {
|
|
@@ -1385,6 +1416,8 @@ export declare enum HTTPMethod {
|
|
|
1385
1416
|
GET = "GET",
|
|
1386
1417
|
POST = "POST"
|
|
1387
1418
|
}
|
|
1419
|
+
/** @enumType */
|
|
1420
|
+
export type HTTPMethodWithLiterals = HTTPMethod | 'UNKNOWN_METHOD' | 'GET' | 'POST';
|
|
1388
1421
|
/**
|
|
1389
1422
|
* An iframe that opens in the user’s Wix Dashboard,
|
|
1390
1423
|
* or add a link to open the page directly in your platform.
|
|
@@ -1562,7 +1595,7 @@ export interface InstallationSettings extends InstallationSettingsOptionsOneOf {
|
|
|
1562
1595
|
/** Extra options needed when `install_page` is set to `LIGHTBOX`. */
|
|
1563
1596
|
lightboxOptions?: LightboxOptions;
|
|
1564
1597
|
/** How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`. */
|
|
1565
|
-
installPage?:
|
|
1598
|
+
installPage?: InstallPageWithLiterals;
|
|
1566
1599
|
/** Controls whether to show or hide the widget in the add panel. */
|
|
1567
1600
|
showInAddPanel?: boolean | null;
|
|
1568
1601
|
/** Defines the main preset per breakpoint for the widget. */
|
|
@@ -1586,6 +1619,8 @@ export declare enum InstallPage {
|
|
|
1586
1619
|
/** Add widget to a new lightbox in the editor */
|
|
1587
1620
|
LIGHTBOX = "LIGHTBOX"
|
|
1588
1621
|
}
|
|
1622
|
+
/** @enumType */
|
|
1623
|
+
export type InstallPageWithLiterals = InstallPage | 'NO_PAGE' | 'CURRENT' | 'PAGE' | 'LIGHTBOX';
|
|
1589
1624
|
/** Defines the main preset per breakpoint for the widget. */
|
|
1590
1625
|
export interface MainPresets {
|
|
1591
1626
|
/** The main desktop preset. */
|
|
@@ -1660,7 +1695,7 @@ export interface HelpResources {
|
|
|
1660
1695
|
}
|
|
1661
1696
|
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1662
1697
|
/** Which static container should the widget be installed at */
|
|
1663
|
-
staticContainer?:
|
|
1698
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1664
1699
|
/**
|
|
1665
1700
|
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1666
1701
|
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
@@ -1681,7 +1716,7 @@ export interface WidgetInstallationSettings extends WidgetInstallationSettingsTa
|
|
|
1681
1716
|
/** @oneof */
|
|
1682
1717
|
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1683
1718
|
/** Which static container should the widget be installed at */
|
|
1684
|
-
staticContainer?:
|
|
1719
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1685
1720
|
}
|
|
1686
1721
|
export interface BaseInstallation {
|
|
1687
1722
|
/** Auto add component to stage */
|
|
@@ -1695,13 +1730,15 @@ export interface WidgetInstallation {
|
|
|
1695
1730
|
/** Preset should be selected defaultly with installation */
|
|
1696
1731
|
defaultPreset?: MainPresets;
|
|
1697
1732
|
/** Region of widget */
|
|
1698
|
-
region?:
|
|
1733
|
+
region?: RegionTypeWithLiterals;
|
|
1699
1734
|
}
|
|
1700
1735
|
export declare enum RegionType {
|
|
1701
1736
|
HEADER = "HEADER",
|
|
1702
1737
|
BODY = "BODY",
|
|
1703
1738
|
FOOTER = "FOOTER"
|
|
1704
1739
|
}
|
|
1740
|
+
/** @enumType */
|
|
1741
|
+
export type RegionTypeWithLiterals = RegionType | 'HEADER' | 'BODY' | 'FOOTER';
|
|
1705
1742
|
export interface DefaultPresets {
|
|
1706
1743
|
/**
|
|
1707
1744
|
* Default preset ID in small (mobile) breakpoint
|
|
@@ -1721,6 +1758,8 @@ export declare enum StaticContainer {
|
|
|
1721
1758
|
/** Widget should be installed in the homepage */
|
|
1722
1759
|
HOMEPAGE = "HOMEPAGE"
|
|
1723
1760
|
}
|
|
1761
|
+
/** @enumType */
|
|
1762
|
+
export type StaticContainerWithLiterals = StaticContainer | 'UNKNOWN_CONTAINER' | 'HOMEPAGE';
|
|
1724
1763
|
export interface ComponentModel {
|
|
1725
1764
|
/** The component type of the builder component. */
|
|
1726
1765
|
componentType?: string;
|
|
@@ -1759,13 +1798,13 @@ export interface EmbeddedScriptComponentData {
|
|
|
1759
1798
|
/** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */
|
|
1760
1799
|
name?: string;
|
|
1761
1800
|
/** What category of pages this will be embedded on (single, many, none) */
|
|
1762
|
-
pages?:
|
|
1801
|
+
pages?: EmbeddedScriptPagesWithLiterals;
|
|
1763
1802
|
/** Where in the HTML this should be embedded */
|
|
1764
|
-
placement?:
|
|
1803
|
+
placement?: EmbeddedScriptPlacementWithLiterals;
|
|
1765
1804
|
/** An article explaining how to activate the script */
|
|
1766
1805
|
connectArticleUrl?: string;
|
|
1767
1806
|
/** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */
|
|
1768
|
-
embedCategory?:
|
|
1807
|
+
embedCategory?: EmbedCategoryWithLiterals;
|
|
1769
1808
|
/**
|
|
1770
1809
|
* if the script should be loaded once - default and only supported value is true
|
|
1771
1810
|
* @readonly
|
|
@@ -1788,6 +1827,8 @@ export declare enum EmbeddedScriptPages {
|
|
|
1788
1827
|
/** It will be embedded multiple times on specific pages */
|
|
1789
1828
|
SPECIFIC_PAGES = "SPECIFIC_PAGES"
|
|
1790
1829
|
}
|
|
1830
|
+
/** @enumType */
|
|
1831
|
+
export type EmbeddedScriptPagesWithLiterals = EmbeddedScriptPages | 'NONE_PAGES' | 'ONCE' | 'SPECIFIC_PAGES';
|
|
1791
1832
|
/** Where that embed will be rendered */
|
|
1792
1833
|
export declare enum EmbeddedScriptPlacement {
|
|
1793
1834
|
/** It will not be rendered */
|
|
@@ -1799,6 +1840,8 @@ export declare enum EmbeddedScriptPlacement {
|
|
|
1799
1840
|
/** Appended after the last child already rendered in the body tag */
|
|
1800
1841
|
BODY_END = "BODY_END"
|
|
1801
1842
|
}
|
|
1843
|
+
/** @enumType */
|
|
1844
|
+
export type EmbeddedScriptPlacementWithLiterals = EmbeddedScriptPlacement | 'NONE_PLACEMENT' | 'HEAD' | 'BODY_START' | 'BODY_END';
|
|
1802
1845
|
/** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */
|
|
1803
1846
|
export declare enum EmbedCategory {
|
|
1804
1847
|
/** Not categorized yet */
|
|
@@ -1812,6 +1855,8 @@ export declare enum EmbedCategory {
|
|
|
1812
1855
|
/** Adds advertising content or advertising tracking to the site */
|
|
1813
1856
|
ADVERTISING = "ADVERTISING"
|
|
1814
1857
|
}
|
|
1858
|
+
/** @enumType */
|
|
1859
|
+
export type EmbedCategoryWithLiterals = EmbedCategory | 'UNKNOWN' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING';
|
|
1815
1860
|
export interface WixDependency {
|
|
1816
1861
|
/**
|
|
1817
1862
|
* The fully qualified package name from npm, example: @wix/frontend-location
|
|
@@ -1847,7 +1892,7 @@ export interface WebComponentData {
|
|
|
1847
1892
|
/** Dynamic settings(Graphic Floating Properties Panel settings) */
|
|
1848
1893
|
gfppSettings?: Settings;
|
|
1849
1894
|
/** Custom element type PAGE / WIDGET */
|
|
1850
|
-
type?:
|
|
1895
|
+
type?: WebComponentDataElementTypeWithLiterals;
|
|
1851
1896
|
/** Boolean to make this component be available for free sites */
|
|
1852
1897
|
allowedForFreeSite?: boolean;
|
|
1853
1898
|
/**
|
|
@@ -1862,7 +1907,7 @@ export interface WebComponentData {
|
|
|
1862
1907
|
/** The details of the selected widget to add */
|
|
1863
1908
|
widget?: WidgetDetails;
|
|
1864
1909
|
/** Give the option to change the script type */
|
|
1865
|
-
scriptType?:
|
|
1910
|
+
scriptType?: ScriptTypeWithLiterals;
|
|
1866
1911
|
/** Web component default mobile height */
|
|
1867
1912
|
defaultMobileHeight?: number | null;
|
|
1868
1913
|
/** Prevent the deletion of the widget when set to true. */
|
|
@@ -2019,7 +2064,7 @@ export interface SingleKeyCondition {
|
|
|
2019
2064
|
/** ColorSelectLabeled 13 */
|
|
2020
2065
|
export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
2021
2066
|
customColor?: ColorDefinition;
|
|
2022
|
-
templateColor?:
|
|
2067
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2023
2068
|
title?: string;
|
|
2024
2069
|
key?: string;
|
|
2025
2070
|
/** @deprecated */
|
|
@@ -2030,7 +2075,7 @@ export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
|
2030
2075
|
/** @oneof */
|
|
2031
2076
|
export interface ColorSelectLabeledDataOneOf {
|
|
2032
2077
|
customColor?: ColorDefinition;
|
|
2033
|
-
templateColor?:
|
|
2078
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2034
2079
|
}
|
|
2035
2080
|
export interface ColorDefinition {
|
|
2036
2081
|
value?: string;
|
|
@@ -2043,13 +2088,15 @@ export declare enum TemplateDefaultColor {
|
|
|
2043
2088
|
BORDERS_AND_DIVIDERS = "BORDERS_AND_DIVIDERS",
|
|
2044
2089
|
BUTTONS_AND_LINKS = "BUTTONS_AND_LINKS"
|
|
2045
2090
|
}
|
|
2091
|
+
/** @enumType */
|
|
2092
|
+
export type TemplateDefaultColorWithLiterals = TemplateDefaultColor | 'BACKGROUND' | 'SECONDARY_TEXTS' | 'MAIN_TEXT_AND_ICONS' | 'BORDERS_AND_DIVIDERS' | 'BUTTONS_AND_LINKS';
|
|
2046
2093
|
/** Thumbnails 4 */
|
|
2047
2094
|
export interface Thumbnails {
|
|
2048
2095
|
key?: string;
|
|
2049
2096
|
title?: string;
|
|
2050
2097
|
value?: string;
|
|
2051
2098
|
options?: ThumbnailData[];
|
|
2052
|
-
size?:
|
|
2099
|
+
size?: ThumbnailsSizeWithLiterals;
|
|
2053
2100
|
description?: string;
|
|
2054
2101
|
conditions?: Condition[];
|
|
2055
2102
|
}
|
|
@@ -2070,6 +2117,8 @@ export declare enum ThumbnailsSize {
|
|
|
2070
2117
|
LARGE = "LARGE",
|
|
2071
2118
|
XLARGE = "XLARGE"
|
|
2072
2119
|
}
|
|
2120
|
+
/** @enumType */
|
|
2121
|
+
export type ThumbnailsSizeWithLiterals = ThumbnailsSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE';
|
|
2073
2122
|
/** SliderLabeled 5 */
|
|
2074
2123
|
export interface SliderLabeled {
|
|
2075
2124
|
key?: string;
|
|
@@ -2103,11 +2152,11 @@ export interface ToggleLabeled {
|
|
|
2103
2152
|
*/
|
|
2104
2153
|
export interface BarAlignment {
|
|
2105
2154
|
/** @deprecated */
|
|
2106
|
-
selected?:
|
|
2155
|
+
selected?: BarAlignmentSelectedWithLiterals;
|
|
2107
2156
|
key?: string;
|
|
2108
2157
|
title?: string;
|
|
2109
2158
|
description?: string;
|
|
2110
|
-
value?:
|
|
2159
|
+
value?: BarAlignmentSelectedWithLiterals;
|
|
2111
2160
|
conditions?: Condition[];
|
|
2112
2161
|
}
|
|
2113
2162
|
/** Bar alignment selected value */
|
|
@@ -2116,6 +2165,8 @@ export declare enum BarAlignmentSelected {
|
|
|
2116
2165
|
ALIGN_CENTER = "ALIGN_CENTER",
|
|
2117
2166
|
ALIGN_RIGHT = "ALIGN_RIGHT"
|
|
2118
2167
|
}
|
|
2168
|
+
/** @enumType */
|
|
2169
|
+
export type BarAlignmentSelectedWithLiterals = BarAlignmentSelected | 'ALIGN_LEFT' | 'ALIGN_CENTER' | 'ALIGN_RIGHT';
|
|
2119
2170
|
/** TextInputLabeled 9 */
|
|
2120
2171
|
export interface TextInputLabeled {
|
|
2121
2172
|
key?: string;
|
|
@@ -2140,22 +2191,24 @@ export interface FontDefinition {
|
|
|
2140
2191
|
/** TextStyle 14 */
|
|
2141
2192
|
export interface TextStyle extends TextStyleDefaultColorOneOf {
|
|
2142
2193
|
customColor?: ColorDefinition;
|
|
2143
|
-
templateColor?:
|
|
2194
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2144
2195
|
key?: string;
|
|
2145
2196
|
title?: string;
|
|
2146
2197
|
description?: string;
|
|
2147
|
-
defaultTextStyle?:
|
|
2198
|
+
defaultTextStyle?: DefaultTextStyleWithLiterals;
|
|
2148
2199
|
}
|
|
2149
2200
|
/** @oneof */
|
|
2150
2201
|
export interface TextStyleDefaultColorOneOf {
|
|
2151
2202
|
customColor?: ColorDefinition;
|
|
2152
|
-
templateColor?:
|
|
2203
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2153
2204
|
}
|
|
2154
2205
|
export declare enum DefaultTextStyle {
|
|
2155
2206
|
TITLE = "TITLE",
|
|
2156
2207
|
PARAGRAPH = "PARAGRAPH",
|
|
2157
2208
|
LOWER_HIERARCHY_TEXTS = "LOWER_HIERARCHY_TEXTS"
|
|
2158
2209
|
}
|
|
2210
|
+
/** @enumType */
|
|
2211
|
+
export type DefaultTextStyleWithLiterals = DefaultTextStyle | 'TITLE' | 'PARAGRAPH' | 'LOWER_HIERARCHY_TEXTS';
|
|
2159
2212
|
/** 10 */
|
|
2160
2213
|
export interface ResetButton {
|
|
2161
2214
|
label?: string;
|
|
@@ -2164,6 +2217,8 @@ export declare enum WebComponentDataElementType {
|
|
|
2164
2217
|
WIDGET = "WIDGET",
|
|
2165
2218
|
PAGE = "PAGE"
|
|
2166
2219
|
}
|
|
2220
|
+
/** @enumType */
|
|
2221
|
+
export type WebComponentDataElementTypeWithLiterals = WebComponentDataElementType | 'WIDGET' | 'PAGE';
|
|
2167
2222
|
export interface WidgetDetails {
|
|
2168
2223
|
name?: string | null;
|
|
2169
2224
|
icon?: string | null;
|
|
@@ -2173,6 +2228,8 @@ export declare enum ScriptType {
|
|
|
2173
2228
|
NO_SCRIPT_TYPE = "NO_SCRIPT_TYPE",
|
|
2174
2229
|
MODULE = "MODULE"
|
|
2175
2230
|
}
|
|
2231
|
+
/** @enumType */
|
|
2232
|
+
export type ScriptTypeWithLiterals = ScriptType | 'NO_SCRIPT_TYPE' | 'MODULE';
|
|
2176
2233
|
export interface WidgetBehavior {
|
|
2177
2234
|
/** Toggle whether the widget is removable from the page. */
|
|
2178
2235
|
removable?: boolean;
|
|
@@ -2181,7 +2238,7 @@ export interface WidgetBehavior {
|
|
|
2181
2238
|
}
|
|
2182
2239
|
export interface ExtensionData {
|
|
2183
2240
|
data?: string;
|
|
2184
|
-
extensionType?:
|
|
2241
|
+
extensionType?: ExtensionTypeWithLiterals;
|
|
2185
2242
|
}
|
|
2186
2243
|
export declare enum ExtensionType {
|
|
2187
2244
|
NONE_EXTENSION = "NONE_EXTENSION",
|
|
@@ -2196,6 +2253,8 @@ export declare enum ExtensionType {
|
|
|
2196
2253
|
ASCEND_AUTOMATION_EXTENSION = "ASCEND_AUTOMATION_EXTENSION",
|
|
2197
2254
|
CONTACT_LABELS_EXTENSION = "CONTACT_LABELS_EXTENSION"
|
|
2198
2255
|
}
|
|
2256
|
+
/** @enumType */
|
|
2257
|
+
export type ExtensionTypeWithLiterals = ExtensionType | 'NONE_EXTENSION' | 'PAYMENTS_GATEWAY_EXTENSION' | 'COUPONS_EXTENSION' | 'DROPSHIPPING_EXTENSION' | 'FULFILMENT_EXTENSION' | 'DROPSHIPPING_SUPPLIER_EXTENSION' | 'FULFILLMENT_CENTER_EXTENSION' | 'RESTAURANTS_POS_EXTENSION' | 'ART_STORE_EXTENSION' | 'ASCEND_AUTOMATION_EXTENSION' | 'CONTACT_LABELS_EXTENSION';
|
|
2199
2258
|
export interface SnippetSolutionData {
|
|
2200
2259
|
code?: string;
|
|
2201
2260
|
instructions?: string;
|
|
@@ -2286,7 +2345,7 @@ export interface SchemaField {
|
|
|
2286
2345
|
/** Sample values, values that could show up in the payload of a trigger. */
|
|
2287
2346
|
sampleValues?: string[];
|
|
2288
2347
|
/** The field exposure */
|
|
2289
|
-
exposure?:
|
|
2348
|
+
exposure?: SchemaFieldExposureWithLiterals;
|
|
2290
2349
|
}
|
|
2291
2350
|
export declare enum PrimitiveType {
|
|
2292
2351
|
UNKNOWN_PRIMITIVE_TYPE = "UNKNOWN_PRIMITIVE_TYPE",
|
|
@@ -2294,6 +2353,8 @@ export declare enum PrimitiveType {
|
|
|
2294
2353
|
BOOLEAN = "BOOLEAN",
|
|
2295
2354
|
NUMBER = "NUMBER"
|
|
2296
2355
|
}
|
|
2356
|
+
/** @enumType */
|
|
2357
|
+
export type PrimitiveTypeWithLiterals = PrimitiveType | 'UNKNOWN_PRIMITIVE_TYPE' | 'TEXT' | 'BOOLEAN' | 'NUMBER';
|
|
2297
2358
|
export declare enum SimpleType {
|
|
2298
2359
|
UNKNOWN_SIMPLE_TYPE = "UNKNOWN_SIMPLE_TYPE",
|
|
2299
2360
|
MONEY = "MONEY",
|
|
@@ -2307,11 +2368,13 @@ export declare enum SimpleType {
|
|
|
2307
2368
|
PHONE = "PHONE",
|
|
2308
2369
|
CONTACT_ID = "CONTACT_ID"
|
|
2309
2370
|
}
|
|
2371
|
+
/** @enumType */
|
|
2372
|
+
export type SimpleTypeWithLiterals = SimpleType | 'UNKNOWN_SIMPLE_TYPE' | 'MONEY' | 'LINK' | 'BACKOFFICE_LINK' | 'LIVESITE_LINK' | 'MULTILINGUAL' | 'IMAGE_LINK' | 'GUID' | 'EMAIL' | 'PHONE' | 'CONTACT_ID';
|
|
2310
2373
|
export interface Primitive {
|
|
2311
|
-
primitiveType?:
|
|
2374
|
+
primitiveType?: PrimitiveTypeWithLiterals;
|
|
2312
2375
|
}
|
|
2313
2376
|
export interface Simple {
|
|
2314
|
-
simpleType?:
|
|
2377
|
+
simpleType?: SimpleTypeWithLiterals;
|
|
2315
2378
|
}
|
|
2316
2379
|
export interface _Date {
|
|
2317
2380
|
/** Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date */
|
|
@@ -2345,10 +2408,12 @@ export declare enum SchemaFieldExposure {
|
|
|
2345
2408
|
/** Sent to the action provider and usually shown to user */
|
|
2346
2409
|
EXPOSED = "EXPOSED"
|
|
2347
2410
|
}
|
|
2411
|
+
/** @enumType */
|
|
2412
|
+
export type SchemaFieldExposureWithLiterals = SchemaFieldExposure | 'UNKNOWN_EXPOSURE' | 'SETUP' | 'HIDDEN' | 'EXPOSED';
|
|
2348
2413
|
/** represents Invoices integration policies */
|
|
2349
2414
|
export interface InvoicesActionsComponentData {
|
|
2350
2415
|
/** partial payment restriction on invoice */
|
|
2351
|
-
partialPayment?:
|
|
2416
|
+
partialPayment?: PartialPaymentRestrictionWithLiterals;
|
|
2352
2417
|
}
|
|
2353
2418
|
/** Possible Partial Payment Policy Values */
|
|
2354
2419
|
export declare enum PartialPaymentRestriction {
|
|
@@ -2358,6 +2423,8 @@ export declare enum PartialPaymentRestriction {
|
|
|
2358
2423
|
/** Disallow Partial Payment */
|
|
2359
2424
|
DISALLOW = "DISALLOW"
|
|
2360
2425
|
}
|
|
2426
|
+
/** @enumType */
|
|
2427
|
+
export type PartialPaymentRestrictionWithLiterals = PartialPaymentRestriction | 'UNDEFINED' | 'ALLOW' | 'DISALLOW';
|
|
2361
2428
|
/** Experimental-WIP: Specifies the app module configuration of business manager module */
|
|
2362
2429
|
export interface DashboardApplicationData {
|
|
2363
2430
|
/**
|
|
@@ -2453,7 +2520,7 @@ export interface HostedComponent {
|
|
|
2453
2520
|
/** Permissions required for the component, this is not strictly enforced */
|
|
2454
2521
|
requiredPermission?: string;
|
|
2455
2522
|
/** Represents the collection of components where the component will be hosted, get this value from the host provider. */
|
|
2456
|
-
hostContainerId?:
|
|
2523
|
+
hostContainerId?: HostContainerIdWithLiterals;
|
|
2457
2524
|
/** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope */
|
|
2458
2525
|
enabledByExperiments?: ExperimentGroupWrapper[];
|
|
2459
2526
|
/** A URI used to send component error events */
|
|
@@ -2464,6 +2531,8 @@ export declare enum HostContainerId {
|
|
|
2464
2531
|
BUSINESS_DASHBOARD_HOST = "BUSINESS_DASHBOARD_HOST",
|
|
2465
2532
|
SIDEBAR_FOOTER = "SIDEBAR_FOOTER"
|
|
2466
2533
|
}
|
|
2534
|
+
/** @enumType */
|
|
2535
|
+
export type HostContainerIdWithLiterals = HostContainerId | 'BUSINESS_MANAGER' | 'BUSINESS_DASHBOARD_HOST' | 'SIDEBAR_FOOTER';
|
|
2467
2536
|
/** Contact Labels Extensions */
|
|
2468
2537
|
export interface ContactLabelsComponentData {
|
|
2469
2538
|
/** Whether apps can create labels in this namespace. */
|
|
@@ -2501,7 +2570,7 @@ export interface WidgetPluginComponentData {
|
|
|
2501
2570
|
*/
|
|
2502
2571
|
referenceComponentId?: string;
|
|
2503
2572
|
/** APIs implemented by the Plugin's widget. */
|
|
2504
|
-
pluginInterfaces?:
|
|
2573
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
2505
2574
|
/** Marketing information about the plugin. */
|
|
2506
2575
|
marketData?: PluginMarketData;
|
|
2507
2576
|
/** List of placements where the plugin is allowed to be installed. */
|
|
@@ -2601,7 +2670,7 @@ export interface HostedPage {
|
|
|
2601
2670
|
/** Url to images in different formats and colors */
|
|
2602
2671
|
logos?: Logos;
|
|
2603
2672
|
/** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */
|
|
2604
|
-
billingAddressMandatoryFields?:
|
|
2673
|
+
billingAddressMandatoryFields?: MandatoryFieldWithLiterals[];
|
|
2605
2674
|
}
|
|
2606
2675
|
export interface Logos {
|
|
2607
2676
|
/** white theme logos */
|
|
@@ -2635,6 +2704,8 @@ export declare enum MandatoryField {
|
|
|
2635
2704
|
HOUSE_NUMBER = "HOUSE_NUMBER",
|
|
2636
2705
|
TAX_IDENTIFIER = "TAX_IDENTIFIER"
|
|
2637
2706
|
}
|
|
2707
|
+
/** @enumType */
|
|
2708
|
+
export type MandatoryFieldWithLiterals = MandatoryField | 'ZIPCODE' | 'CITY' | 'STATE' | 'ADDRESS' | 'COUNTRY_CODE' | 'EMAIL' | 'PHONE' | 'FIRST_NAME' | 'LAST_NAME' | 'STREET' | 'HOUSE_NUMBER' | 'TAX_IDENTIFIER';
|
|
2638
2709
|
export interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {
|
|
2639
2710
|
/** text field */
|
|
2640
2711
|
simpleField?: SimpleField;
|
|
@@ -2781,7 +2852,7 @@ export interface ShippingLabelCarrierSpiConfig {
|
|
|
2781
2852
|
*/
|
|
2782
2853
|
currency?: string;
|
|
2783
2854
|
/** the measurement system of he labels (Metric or Imperial) */
|
|
2784
|
-
measurementSystem?:
|
|
2855
|
+
measurementSystem?: MeasurementSystemWithLiterals;
|
|
2785
2856
|
/** does carrier support insurance */
|
|
2786
2857
|
isInsuranceSupported?: boolean;
|
|
2787
2858
|
/**
|
|
@@ -2795,6 +2866,8 @@ export declare enum MeasurementSystem {
|
|
|
2795
2866
|
Metric = "Metric",
|
|
2796
2867
|
Imperial = "Imperial"
|
|
2797
2868
|
}
|
|
2869
|
+
/** @enumType */
|
|
2870
|
+
export type MeasurementSystemWithLiterals = MeasurementSystem | 'Metric' | 'Imperial';
|
|
2798
2871
|
export interface PackageType {
|
|
2799
2872
|
/**
|
|
2800
2873
|
* carrier id that can be used to get quotes and purchase
|
|
@@ -2869,24 +2942,26 @@ export interface RestaurantsPOSComponentData {
|
|
|
2869
2942
|
}
|
|
2870
2943
|
export interface CatalogSyncConfiguration {
|
|
2871
2944
|
/** If menu, section, or dish availability will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2872
|
-
entityAvailabilityUpdated?:
|
|
2945
|
+
entityAvailabilityUpdated?: DefaultWithLiterals;
|
|
2873
2946
|
/** Whether fulfillment methods will be defined on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2874
|
-
fulfillmentMethodsDefinition?:
|
|
2947
|
+
fulfillmentMethodsDefinition?: DefaultWithLiterals;
|
|
2875
2948
|
/** If dish images will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2876
|
-
dishImagesUpdated?:
|
|
2949
|
+
dishImagesUpdated?: DefaultWithLiterals;
|
|
2877
2950
|
/** If sorting (Menu/Category/Dish/Options) will be done on the POS side (API order) or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2878
|
-
entitySortingControl?:
|
|
2951
|
+
entitySortingControl?: DefaultWithLiterals;
|
|
2879
2952
|
/** If labels will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2880
|
-
dishLabelsUpdated?:
|
|
2953
|
+
dishLabelsUpdated?: DefaultWithLiterals;
|
|
2881
2954
|
/** If min/max amount of choices is to be set on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2882
|
-
dishOptionsMinMaxUpdated?:
|
|
2955
|
+
dishOptionsMinMaxUpdated?: DefaultWithLiterals;
|
|
2883
2956
|
/** If dish in/out of stock will be retrieved from POS or updated on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2884
|
-
dishInStockUpdated?:
|
|
2957
|
+
dishInStockUpdated?: DefaultWithLiterals;
|
|
2885
2958
|
}
|
|
2886
2959
|
export declare enum Default {
|
|
2887
2960
|
WIX = "WIX",
|
|
2888
2961
|
POS = "POS"
|
|
2889
2962
|
}
|
|
2963
|
+
/** @enumType */
|
|
2964
|
+
export type DefaultWithLiterals = Default | 'WIX' | 'POS';
|
|
2890
2965
|
export interface ShippingProviderConfig {
|
|
2891
2966
|
/** URI configuration of the deployment */
|
|
2892
2967
|
deploymentUri?: SpiBaseUri;
|
|
@@ -2952,6 +3027,8 @@ export declare enum HookType {
|
|
|
2952
3027
|
BEFORE = "BEFORE",
|
|
2953
3028
|
AFTER = "AFTER"
|
|
2954
3029
|
}
|
|
3030
|
+
/** @enumType */
|
|
3031
|
+
export type HookTypeWithLiterals = HookType | 'UNDEFINED' | 'BEFORE_BLOCKING' | 'BEFORE' | 'AFTER';
|
|
2955
3032
|
export interface GenericHookConfig {
|
|
2956
3033
|
/** FQN of proto service */
|
|
2957
3034
|
serviceFqn?: string;
|
|
@@ -2963,7 +3040,7 @@ export interface GenericHookConfig {
|
|
|
2963
3040
|
*/
|
|
2964
3041
|
uri?: string;
|
|
2965
3042
|
/** Type of hook */
|
|
2966
|
-
hookType?:
|
|
3043
|
+
hookType?: HookTypeWithLiterals;
|
|
2967
3044
|
}
|
|
2968
3045
|
export interface ActionProviderSPIConfig {
|
|
2969
3046
|
/** URL to action provider service for this action */
|
|
@@ -3066,7 +3143,7 @@ export interface ActionSPIConfig {
|
|
|
3066
3143
|
* Indicates whether we should wait for the action to complete before executing the next actions or finish and
|
|
3067
3144
|
* expect a callback in the actionCompleted method
|
|
3068
3145
|
*/
|
|
3069
|
-
executionType?:
|
|
3146
|
+
executionType?: ExecutionTypeWithLiterals;
|
|
3070
3147
|
/** Chosen interface for action */
|
|
3071
3148
|
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
3072
3149
|
/** Icon representing the action in the UI */
|
|
@@ -3084,6 +3161,8 @@ export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
|
3084
3161
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
3085
3162
|
GENERIC = "GENERIC"
|
|
3086
3163
|
}
|
|
3164
|
+
/** @enumType */
|
|
3165
|
+
export type ActionSPIConfigInterfaceConfigurationTypeWithLiterals = ActionSPIConfigInterfaceConfigurationType | 'UNKNOWN_TYPE' | 'WIDGET_COMPONENT' | 'GENERIC';
|
|
3087
3166
|
export interface WidgetComponentOptions {
|
|
3088
3167
|
/**
|
|
3089
3168
|
* Name of provided component
|
|
@@ -3103,6 +3182,8 @@ export declare enum SourceType {
|
|
|
3103
3182
|
/** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
|
|
3104
3183
|
WIX_API = "WIX_API"
|
|
3105
3184
|
}
|
|
3185
|
+
/** @enumType */
|
|
3186
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
|
|
3106
3187
|
export interface WixApiOptions {
|
|
3107
3188
|
/**
|
|
3108
3189
|
* Service entity fqdn
|
|
@@ -3152,6 +3233,8 @@ export declare enum ExecutionType {
|
|
|
3152
3233
|
SYNC = "SYNC",
|
|
3153
3234
|
ASYNC = "ASYNC"
|
|
3154
3235
|
}
|
|
3236
|
+
/** @enumType */
|
|
3237
|
+
export type ExecutionTypeWithLiterals = ExecutionType | 'UNKNOWN_EXECUTION_TYPE' | 'SYNC' | 'ASYNC';
|
|
3155
3238
|
export interface Metadata {
|
|
3156
3239
|
/** Show action only to advanced mode users (Wix staff) */
|
|
3157
3240
|
hidden?: boolean;
|
|
@@ -3160,7 +3243,7 @@ export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigIn
|
|
|
3160
3243
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
3161
3244
|
genericOptions?: GenericOptions;
|
|
3162
3245
|
/** Type of chosen interface */
|
|
3163
|
-
type?:
|
|
3246
|
+
type?: ActionSPIConfigInterfaceConfigurationTypeWithLiterals;
|
|
3164
3247
|
}
|
|
3165
3248
|
/** @oneof */
|
|
3166
3249
|
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
@@ -3171,7 +3254,7 @@ export interface Source extends SourceOptionsOneOf {
|
|
|
3171
3254
|
/** Wix API options */
|
|
3172
3255
|
wixApiOptions?: WixApiOptions;
|
|
3173
3256
|
/** the source type */
|
|
3174
|
-
type?:
|
|
3257
|
+
type?: SourceTypeWithLiterals;
|
|
3175
3258
|
}
|
|
3176
3259
|
/** @oneof */
|
|
3177
3260
|
export interface SourceOptionsOneOf {
|
|
@@ -3215,7 +3298,7 @@ export interface BackOfficeExtensionContainer {
|
|
|
3215
3298
|
/** Extensibility properties used by containers (slots) */
|
|
3216
3299
|
export interface Extendable {
|
|
3217
3300
|
/** Type of component that this slot accepts. */
|
|
3218
|
-
extendedBy?:
|
|
3301
|
+
extendedBy?: ExtendingComponentTypeWithLiterals;
|
|
3219
3302
|
}
|
|
3220
3303
|
/** Which component types can be extended in containers */
|
|
3221
3304
|
export declare enum ExtendingComponentType {
|
|
@@ -3223,6 +3306,8 @@ export declare enum ExtendingComponentType {
|
|
|
3223
3306
|
BACK_OFFICE_MENU_ITEM = "BACK_OFFICE_MENU_ITEM",
|
|
3224
3307
|
BACK_OFFICE_EXTENSION_WIDGET = "BACK_OFFICE_EXTENSION_WIDGET"
|
|
3225
3308
|
}
|
|
3309
|
+
/** @enumType */
|
|
3310
|
+
export type ExtendingComponentTypeWithLiterals = ExtendingComponentType | 'INVALID' | 'BACK_OFFICE_MENU_ITEM' | 'BACK_OFFICE_EXTENSION_WIDGET';
|
|
3226
3311
|
/** List of back-office hosting platforms */
|
|
3227
3312
|
export declare enum BackOfficeHostingPlatforms {
|
|
3228
3313
|
NO_HOSTING_PLATFORM = "NO_HOSTING_PLATFORM",
|
|
@@ -3263,6 +3348,8 @@ export declare enum BackOfficeHostingPlatforms {
|
|
|
3263
3348
|
/** Picasso AI application POC */
|
|
3264
3349
|
PICASSO_EDITOR = "PICASSO_EDITOR"
|
|
3265
3350
|
}
|
|
3351
|
+
/** @enumType */
|
|
3352
|
+
export type BackOfficeHostingPlatformsWithLiterals = BackOfficeHostingPlatforms | 'NO_HOSTING_PLATFORM' | 'BUSINESS_MANAGER' | 'ACCOUNT_MANAGER' | 'DEV_CENTER' | 'ENTERPRISE' | 'PARTNERS_DASHBOARD' | 'FINANCIALS_INTERNAL_BO' | 'FED_GUILD_POC' | 'STUDIO_DASHBOARD' | 'CHANNELS' | 'DATA_TOOLS' | 'PSP_BACKOFFICE' | 'RISE_PLATFORM_ACCOUNT_DASHBOARD' | 'DEMO_DASHBOARD_ENTERPRISE' | 'AI_SCHEDULING_ASSISTANT_DASHBOARD' | 'GETTING_PAID' | 'DATA' | 'LITE_DASHBOARD' | 'PICASSO_EDITOR';
|
|
3266
3353
|
/** Definitions of common slots properties */
|
|
3267
3354
|
export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
3268
3355
|
/** Widget-specific slot. */
|
|
@@ -3287,7 +3374,7 @@ export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
|
3287
3374
|
* @format WEB_URL
|
|
3288
3375
|
*/
|
|
3289
3376
|
mdHttpLinks?: string[];
|
|
3290
|
-
type?:
|
|
3377
|
+
type?: SlotDataTypeWithLiterals;
|
|
3291
3378
|
}
|
|
3292
3379
|
/** @oneof */
|
|
3293
3380
|
export interface SlotDataSlotTypeOneOf {
|
|
@@ -3299,7 +3386,7 @@ export interface SlotDataSlotTypeOneOf {
|
|
|
3299
3386
|
export interface DtsDefinitionReference extends DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
3300
3387
|
dtsHttpLinkOptions?: DtsHttpLink;
|
|
3301
3388
|
dtsContentOptions?: DtsContent;
|
|
3302
|
-
type?:
|
|
3389
|
+
type?: DtsDefinitionTypeWithLiterals;
|
|
3303
3390
|
}
|
|
3304
3391
|
/** @oneof */
|
|
3305
3392
|
export interface DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
@@ -3311,6 +3398,8 @@ export declare enum DtsDefinitionType {
|
|
|
3311
3398
|
DTS_HTTP_LINK = "DTS_HTTP_LINK",
|
|
3312
3399
|
DTS_CONTENT = "DTS_CONTENT"
|
|
3313
3400
|
}
|
|
3401
|
+
/** @enumType */
|
|
3402
|
+
export type DtsDefinitionTypeWithLiterals = DtsDefinitionType | 'UNKNOWN' | 'DTS_HTTP_LINK' | 'DTS_CONTENT';
|
|
3314
3403
|
export interface DtsHttpLink {
|
|
3315
3404
|
/**
|
|
3316
3405
|
* HTTP link to the bundled d.ts file.
|
|
@@ -3362,6 +3451,8 @@ export declare enum SlotDataType {
|
|
|
3362
3451
|
WIDGET = "WIDGET",
|
|
3363
3452
|
MENU = "MENU"
|
|
3364
3453
|
}
|
|
3454
|
+
/** @enumType */
|
|
3455
|
+
export type SlotDataTypeWithLiterals = SlotDataType | 'UNKNOWN' | 'WIDGET' | 'MENU';
|
|
3365
3456
|
export interface WidgetSlot {
|
|
3366
3457
|
/** Blocks specific data. */
|
|
3367
3458
|
blocksData?: BlocksData;
|
|
@@ -3387,13 +3478,13 @@ export interface BackOfficeExtension extends BackOfficeExtensionExtensionOneOf {
|
|
|
3387
3478
|
/** Extension description. This is how the extension is described in the Wix Dev Center. */
|
|
3388
3479
|
description?: string | null;
|
|
3389
3480
|
/** Type of extension. */
|
|
3390
|
-
extensionType?:
|
|
3481
|
+
extensionType?: ExtendingComponentTypeWithLiterals;
|
|
3391
3482
|
/**
|
|
3392
3483
|
* Platform that hosts the extension.
|
|
3393
3484
|
*
|
|
3394
3485
|
* Must be `"BUSINESS_MANAGER"`.
|
|
3395
3486
|
*/
|
|
3396
|
-
hostingPlatform?:
|
|
3487
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
3397
3488
|
}
|
|
3398
3489
|
/** @oneof */
|
|
3399
3490
|
export interface BackOfficeExtensionExtensionOneOf {
|
|
@@ -3448,7 +3539,7 @@ export interface BackOfficeScriptAsset {
|
|
|
3448
3539
|
*/
|
|
3449
3540
|
exportedName?: string;
|
|
3450
3541
|
/** Optional: What type should by used on <script> tag. */
|
|
3451
|
-
scriptType?:
|
|
3542
|
+
scriptType?: BackOfficeScriptAssetTypeWithLiterals;
|
|
3452
3543
|
}
|
|
3453
3544
|
/** Type attribute for the script tag */
|
|
3454
3545
|
export declare enum BackOfficeScriptAssetType {
|
|
@@ -3457,6 +3548,8 @@ export declare enum BackOfficeScriptAssetType {
|
|
|
3457
3548
|
/** Use "module" as the script type */
|
|
3458
3549
|
MODULE = "MODULE"
|
|
3459
3550
|
}
|
|
3551
|
+
/** @enumType */
|
|
3552
|
+
export type BackOfficeScriptAssetTypeWithLiterals = BackOfficeScriptAssetType | 'UNKNOWN_TYPE' | 'MODULE';
|
|
3460
3553
|
/** The schema of a menu extension of a slot exposed in a page in the Wix Dashboard */
|
|
3461
3554
|
export interface LegacyBackOfficeMenuItem {
|
|
3462
3555
|
/**
|
|
@@ -3481,6 +3574,8 @@ export declare enum ViewMode {
|
|
|
3481
3574
|
/** Opens as a modal on the current page. */
|
|
3482
3575
|
MODAL = "MODAL"
|
|
3483
3576
|
}
|
|
3577
|
+
/** @enumType */
|
|
3578
|
+
export type ViewModeWithLiterals = ViewMode | 'PAGE' | 'MODAL';
|
|
3484
3579
|
/** the schema of the data needed to open a component from menu extensions */
|
|
3485
3580
|
export interface OpenComponent {
|
|
3486
3581
|
/**
|
|
@@ -3489,7 +3584,7 @@ export interface OpenComponent {
|
|
|
3489
3584
|
*/
|
|
3490
3585
|
componentId?: string;
|
|
3491
3586
|
/** How the component is opened. */
|
|
3492
|
-
viewMode?:
|
|
3587
|
+
viewMode?: ViewModeWithLiterals;
|
|
3493
3588
|
/** Parameters to navigate to a page or as props for a modal. */
|
|
3494
3589
|
componentParams?: Record<string, string>;
|
|
3495
3590
|
}
|
|
@@ -3628,7 +3723,7 @@ export interface AlgorithmConfig {
|
|
|
3628
3723
|
* * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
|
|
3629
3724
|
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
3630
3725
|
*/
|
|
3631
|
-
algorithmType?:
|
|
3726
|
+
algorithmType?: AlgorithmTypeWithLiterals;
|
|
3632
3727
|
/**
|
|
3633
3728
|
* Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project.
|
|
3634
3729
|
* @format GUID
|
|
@@ -3640,6 +3735,8 @@ export declare enum AlgorithmType {
|
|
|
3640
3735
|
RELATED_ITEMS = "RELATED_ITEMS",
|
|
3641
3736
|
GLOBAL = "GLOBAL"
|
|
3642
3737
|
}
|
|
3738
|
+
/** @enumType */
|
|
3739
|
+
export type AlgorithmTypeWithLiterals = AlgorithmType | 'UNSPECIFIED' | 'RELATED_ITEMS' | 'GLOBAL';
|
|
3643
3740
|
export interface DropshippingProviderSPIConfig {
|
|
3644
3741
|
/** name of the dropshipping provider was it appears in relevant screens/mails in eComm Platform */
|
|
3645
3742
|
name?: string;
|
|
@@ -3656,13 +3753,13 @@ export interface DropshippingProviderSPIConfig {
|
|
|
3656
3753
|
*/
|
|
3657
3754
|
dashboardUri?: string;
|
|
3658
3755
|
/** if duplication operation for product is locked */
|
|
3659
|
-
duplicateProduct?:
|
|
3756
|
+
duplicateProduct?: LockableOperationWithLiterals;
|
|
3660
3757
|
/** whether there is a warning or not when price is changed */
|
|
3661
|
-
changePrice?:
|
|
3758
|
+
changePrice?: RestrictedOperationWithLiterals;
|
|
3662
3759
|
/** whether the chagne inventory operations are locked */
|
|
3663
|
-
changeInventory?:
|
|
3760
|
+
changeInventory?: LockableOperationWithLiterals;
|
|
3664
3761
|
/** where there is a warning of not when changing options */
|
|
3665
|
-
manageOptions?:
|
|
3762
|
+
manageOptions?: RestrictedOperationWithLiterals;
|
|
3666
3763
|
}
|
|
3667
3764
|
export declare enum LockableOperation {
|
|
3668
3765
|
/** When operation lockability is not specified */
|
|
@@ -3672,11 +3769,15 @@ export declare enum LockableOperation {
|
|
|
3672
3769
|
/** Operation is unlocked */
|
|
3673
3770
|
UNLOCKED = "UNLOCKED"
|
|
3674
3771
|
}
|
|
3772
|
+
/** @enumType */
|
|
3773
|
+
export type LockableOperationWithLiterals = LockableOperation | 'UNSPECIFIED_LOCKABLE' | 'LOCKED' | 'UNLOCKED';
|
|
3675
3774
|
export declare enum RestrictedOperation {
|
|
3676
3775
|
UNSPECIFIED_RESTRICTED = "UNSPECIFIED_RESTRICTED",
|
|
3677
3776
|
ALLOW = "ALLOW",
|
|
3678
3777
|
WARN = "WARN"
|
|
3679
3778
|
}
|
|
3779
|
+
/** @enumType */
|
|
3780
|
+
export type RestrictedOperationWithLiterals = RestrictedOperation | 'UNSPECIFIED_RESTRICTED' | 'ALLOW' | 'WARN';
|
|
3680
3781
|
export interface InvoicesConfig {
|
|
3681
3782
|
/** Base URI of spi provider */
|
|
3682
3783
|
baseUri?: string;
|
|
@@ -3743,7 +3844,7 @@ export interface ApplicationAutomationComponent {
|
|
|
3743
3844
|
/** Automation metadata */
|
|
3744
3845
|
metadata?: AutomationMetadata;
|
|
3745
3846
|
/** Automation status */
|
|
3746
|
-
status?:
|
|
3847
|
+
status?: StatusWithLiterals;
|
|
3747
3848
|
/** Optional origin that indicates the source of the automation */
|
|
3748
3849
|
origin?: OriginInfo;
|
|
3749
3850
|
/**
|
|
@@ -3886,8 +3987,10 @@ export declare enum BlockType {
|
|
|
3886
3987
|
OR = "OR",
|
|
3887
3988
|
AND = "AND"
|
|
3888
3989
|
}
|
|
3990
|
+
/** @enumType */
|
|
3991
|
+
export type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND';
|
|
3889
3992
|
export interface ConditionBlock {
|
|
3890
|
-
type?:
|
|
3993
|
+
type?: BlockTypeWithLiterals;
|
|
3891
3994
|
/**
|
|
3892
3995
|
* @minSize 1
|
|
3893
3996
|
* @maxSize 20
|
|
@@ -3980,10 +4083,14 @@ export declare enum Domain {
|
|
|
3980
4083
|
/** Wix domain */
|
|
3981
4084
|
WIX = "WIX"
|
|
3982
4085
|
}
|
|
4086
|
+
/** @enumType */
|
|
4087
|
+
export type DomainWithLiterals = Domain | 'USER' | 'WIX';
|
|
3983
4088
|
export declare enum Status {
|
|
3984
4089
|
ACTIVE = "ACTIVE",
|
|
3985
4090
|
INACTIVE = "INACTIVE"
|
|
3986
4091
|
}
|
|
4092
|
+
/** @enumType */
|
|
4093
|
+
export type StatusWithLiterals = Status | 'ACTIVE' | 'INACTIVE';
|
|
3987
4094
|
export interface OriginInfo {
|
|
3988
4095
|
/**
|
|
3989
4096
|
* The id of the original automation used to create the preinstalled automation (v3/Builder only)
|
|
@@ -4210,7 +4317,7 @@ export interface TextInputSettings {
|
|
|
4210
4317
|
/** A regex that the text entered by the user must match */
|
|
4211
4318
|
regex?: string | null;
|
|
4212
4319
|
/** How should the field be displayed to the end user */
|
|
4213
|
-
displayType?:
|
|
4320
|
+
displayType?: TextInputDisplayTypeWithLiterals;
|
|
4214
4321
|
}
|
|
4215
4322
|
export declare enum TextInputDisplayType {
|
|
4216
4323
|
/** A regular text field */
|
|
@@ -4220,6 +4327,8 @@ export declare enum TextInputDisplayType {
|
|
|
4220
4327
|
/** A field optimized for one time codes */
|
|
4221
4328
|
CODE = "CODE"
|
|
4222
4329
|
}
|
|
4330
|
+
/** @enumType */
|
|
4331
|
+
export type TextInputDisplayTypeWithLiterals = TextInputDisplayType | 'TEXT' | 'PASSWORD' | 'CODE';
|
|
4223
4332
|
export interface IDPConnectionConfig {
|
|
4224
4333
|
/** the base URI where all the methods are deployed. */
|
|
4225
4334
|
baseUri?: string;
|
|
@@ -4246,11 +4355,11 @@ export interface ItemsSelectionProviderConfig {
|
|
|
4246
4355
|
* An array of strings representing the Wix UI pages supported by your SPI implementation. If no tags are listed, Wix assumes that the implementation supports all eligible pages.
|
|
4247
4356
|
* @maxSize 50
|
|
4248
4357
|
*/
|
|
4249
|
-
supportedTags?:
|
|
4358
|
+
supportedTags?: TagWithLiterals[];
|
|
4250
4359
|
/** Configuration settings for how the thumbnail is displayed. */
|
|
4251
4360
|
itemThumbnail?: ItemThumbnail;
|
|
4252
4361
|
/** Pagination Mode */
|
|
4253
|
-
paginationMode?:
|
|
4362
|
+
paginationMode?: PaginationModeWithLiterals;
|
|
4254
4363
|
}
|
|
4255
4364
|
export interface LearnMore {
|
|
4256
4365
|
/**
|
|
@@ -4269,8 +4378,10 @@ export declare enum ThumbnailType {
|
|
|
4269
4378
|
IMAGE = "IMAGE",
|
|
4270
4379
|
AVATAR = "AVATAR"
|
|
4271
4380
|
}
|
|
4381
|
+
/** @enumType */
|
|
4382
|
+
export type ThumbnailTypeWithLiterals = ThumbnailType | 'UNKNOWN_THUMBNAIL_TYPE' | 'IMAGE' | 'AVATAR';
|
|
4272
4383
|
export interface ImageConfig {
|
|
4273
|
-
shape?:
|
|
4384
|
+
shape?: ImageShapeWithLiterals;
|
|
4274
4385
|
}
|
|
4275
4386
|
export declare enum ImageShape {
|
|
4276
4387
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4281,8 +4392,10 @@ export declare enum ImageShape {
|
|
|
4281
4392
|
/** Rectangle */
|
|
4282
4393
|
RECTANGLE = "RECTANGLE"
|
|
4283
4394
|
}
|
|
4395
|
+
/** @enumType */
|
|
4396
|
+
export type ImageShapeWithLiterals = ImageShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE' | 'RECTANGLE';
|
|
4284
4397
|
export interface AvatarConfig {
|
|
4285
|
-
shape?:
|
|
4398
|
+
shape?: AvatarShapeWithLiterals;
|
|
4286
4399
|
}
|
|
4287
4400
|
export declare enum AvatarShape {
|
|
4288
4401
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4291,6 +4404,8 @@ export declare enum AvatarShape {
|
|
|
4291
4404
|
/** Square */
|
|
4292
4405
|
SQUARE = "SQUARE"
|
|
4293
4406
|
}
|
|
4407
|
+
/** @enumType */
|
|
4408
|
+
export type AvatarShapeWithLiterals = AvatarShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE';
|
|
4294
4409
|
export interface SearchField {
|
|
4295
4410
|
/** Supported searchable fields. */
|
|
4296
4411
|
key?: string;
|
|
@@ -4313,11 +4428,11 @@ export interface FilterInfo extends FilterInfoOptionsOneOf {
|
|
|
4313
4428
|
*/
|
|
4314
4429
|
key?: string;
|
|
4315
4430
|
/** Optional filter will be shown only for consumers with this tag. Only one filter is allowed per tag. */
|
|
4316
|
-
tag?:
|
|
4431
|
+
tag?: TagWithLiterals;
|
|
4317
4432
|
/** The filter selection type. */
|
|
4318
|
-
selectionType?:
|
|
4433
|
+
selectionType?: FilterSelectionTypeWithLiterals;
|
|
4319
4434
|
/** Filter options type. For now only static options are supported */
|
|
4320
|
-
optionsType?:
|
|
4435
|
+
optionsType?: FilterOptionsTypeWithLiterals;
|
|
4321
4436
|
/**
|
|
4322
4437
|
* Optional placeholder text to display on the filter
|
|
4323
4438
|
* @maxLength 500
|
|
@@ -4341,6 +4456,8 @@ export declare enum Tag {
|
|
|
4341
4456
|
ECOM_DELIVERY_PROFILES = "ECOM_DELIVERY_PROFILES",
|
|
4342
4457
|
ADD_TO_CATEGORY = "ADD_TO_CATEGORY"
|
|
4343
4458
|
}
|
|
4459
|
+
/** @enumType */
|
|
4460
|
+
export type TagWithLiterals = Tag | 'UNKNOWN_TAG' | 'EMBEDDABLE' | 'ECOM_EDIT_ORDER' | 'ECOM_CREATE_ORDER' | 'INBOX' | 'ECOM_CREATE_PAY_LINK' | 'ECOM_DELIVERY_PROFILES' | 'ADD_TO_CATEGORY';
|
|
4344
4461
|
export declare enum FilterSelectionType {
|
|
4345
4462
|
UNKNOWN_SELECTION = "UNKNOWN_SELECTION",
|
|
4346
4463
|
/** Allow to select only a single item */
|
|
@@ -4348,12 +4465,16 @@ export declare enum FilterSelectionType {
|
|
|
4348
4465
|
/** Allow to select multiple items */
|
|
4349
4466
|
MULTIPLE_SELECTION = "MULTIPLE_SELECTION"
|
|
4350
4467
|
}
|
|
4468
|
+
/** @enumType */
|
|
4469
|
+
export type FilterSelectionTypeWithLiterals = FilterSelectionType | 'UNKNOWN_SELECTION' | 'SINGLE_SELECTION' | 'MULTIPLE_SELECTION';
|
|
4351
4470
|
export declare enum FilterOptionsType {
|
|
4352
4471
|
UNKNOWN_FILTER_OPTIONS = "UNKNOWN_FILTER_OPTIONS",
|
|
4353
4472
|
/** Static hardcoded options */
|
|
4354
4473
|
STATIC = "STATIC",
|
|
4355
4474
|
PROVIDER = "PROVIDER"
|
|
4356
4475
|
}
|
|
4476
|
+
/** @enumType */
|
|
4477
|
+
export type FilterOptionsTypeWithLiterals = FilterOptionsType | 'UNKNOWN_FILTER_OPTIONS' | 'STATIC' | 'PROVIDER';
|
|
4357
4478
|
export interface StaticFilterOptions {
|
|
4358
4479
|
/**
|
|
4359
4480
|
* List of hardcoded options for a filter
|
|
@@ -4462,7 +4583,7 @@ export interface ItemThumbnail extends ItemThumbnailOptionsOneOf {
|
|
|
4462
4583
|
/** Configuration specific to avatars. */
|
|
4463
4584
|
avatarConfig?: AvatarConfig;
|
|
4464
4585
|
/** Thumbnail type */
|
|
4465
|
-
type?:
|
|
4586
|
+
type?: ThumbnailTypeWithLiterals;
|
|
4466
4587
|
/** Whether the thumbnail is hidden from the UI. */
|
|
4467
4588
|
hidden?: boolean | null;
|
|
4468
4589
|
}
|
|
@@ -4478,6 +4599,8 @@ export declare enum PaginationMode {
|
|
|
4478
4599
|
CURSOR = "CURSOR",
|
|
4479
4600
|
OFFSET = "OFFSET"
|
|
4480
4601
|
}
|
|
4602
|
+
/** @enumType */
|
|
4603
|
+
export type PaginationModeWithLiterals = PaginationMode | 'UNKNOWN_PAGINATION_MODE' | 'CURSOR' | 'OFFSET';
|
|
4481
4604
|
export interface SyncedProjectsProviderConfig {
|
|
4482
4605
|
/** URI where the SPI Implementer is deployed */
|
|
4483
4606
|
baseUri?: string;
|
|
@@ -4498,7 +4621,7 @@ export interface ChannelConfiguration extends ChannelConfigurationMessagingConfi
|
|
|
4498
4621
|
emailMessageConfig?: EmailMessageConfig;
|
|
4499
4622
|
smsMessageConfig?: SmsMessageConfig;
|
|
4500
4623
|
/** The type of the communication channel */
|
|
4501
|
-
type?:
|
|
4624
|
+
type?: ChannelTypeWithLiterals;
|
|
4502
4625
|
/** Specific provider branding parameters for the channel */
|
|
4503
4626
|
branding?: ChannelBranding;
|
|
4504
4627
|
/** Conversation initiation definition */
|
|
@@ -4517,6 +4640,8 @@ export declare enum ChannelType {
|
|
|
4517
4640
|
EMAIL = "EMAIL",
|
|
4518
4641
|
SMS = "SMS"
|
|
4519
4642
|
}
|
|
4643
|
+
/** @enumType */
|
|
4644
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
4520
4645
|
export interface DirectMessageConfig {
|
|
4521
4646
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4522
4647
|
acceptAllMessageTypes?: boolean;
|
|
@@ -4524,7 +4649,7 @@ export interface DirectMessageConfig {
|
|
|
4524
4649
|
* Direct message types accepted by the provider. only those types will be sent from Wix
|
|
4525
4650
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4526
4651
|
*/
|
|
4527
|
-
acceptedMessageTypes?:
|
|
4652
|
+
acceptedMessageTypes?: AcceptedDirectMessageTypeWithLiterals[];
|
|
4528
4653
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4529
4654
|
mediaCapabilities?: MediaCapabilities;
|
|
4530
4655
|
}
|
|
@@ -4535,6 +4660,8 @@ export declare enum AcceptedDirectMessageType {
|
|
|
4535
4660
|
ANNOUNCEMENT = "ANNOUNCEMENT",
|
|
4536
4661
|
FORM = "FORM"
|
|
4537
4662
|
}
|
|
4663
|
+
/** @enumType */
|
|
4664
|
+
export type AcceptedDirectMessageTypeWithLiterals = AcceptedDirectMessageType | 'TEXT' | 'MEDIA' | 'CARD' | 'ANNOUNCEMENT' | 'FORM';
|
|
4538
4665
|
export interface MediaCapabilities {
|
|
4539
4666
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4540
4667
|
allMediaTypes?: boolean;
|
|
@@ -4543,7 +4670,7 @@ export interface MediaCapabilities {
|
|
|
4543
4670
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4544
4671
|
* @maxSize 50
|
|
4545
4672
|
*/
|
|
4546
|
-
supportedMediaTypes?:
|
|
4673
|
+
supportedMediaTypes?: MediaMimeTypeWithLiterals[];
|
|
4547
4674
|
/** Maximum file size in bytes of a single file in a message */
|
|
4548
4675
|
maxFileSizeInBytes?: number | null;
|
|
4549
4676
|
}
|
|
@@ -4564,6 +4691,8 @@ export declare enum MediaMimeType {
|
|
|
4564
4691
|
APPLICATION_PDF = "APPLICATION_PDF",
|
|
4565
4692
|
APPLICATION_OCTET_STREAM = "APPLICATION_OCTET_STREAM"
|
|
4566
4693
|
}
|
|
4694
|
+
/** @enumType */
|
|
4695
|
+
export type MediaMimeTypeWithLiterals = MediaMimeType | 'UNKNOWN_MIME_TYPE' | 'IMAGE_JPEG' | 'IMAGE_PNG' | 'IMAGE_WEBP' | 'VIDEO_MPEG' | 'VIDEO_MP4' | 'VIDEO_3GP' | 'AUDIO_AAC' | 'AUDIO_MP4' | 'AUDIO_MPEG' | 'AUDIO_OGG' | 'AUDIO_OPUS' | 'APPLICATION_PDF' | 'APPLICATION_OCTET_STREAM';
|
|
4567
4696
|
export interface EmailMessageConfig {
|
|
4568
4697
|
/** Media (Attachment) types accepted by the provider */
|
|
4569
4698
|
mediaCapabilities?: MediaCapabilities;
|
|
@@ -4574,7 +4703,7 @@ export interface SmsMessageConfig {
|
|
|
4574
4703
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4575
4704
|
acceptAllMessageTypes?: boolean;
|
|
4576
4705
|
/** SMS message types accepted by the provider. only those types will be sent from Wix */
|
|
4577
|
-
acceptedMessageTypes?:
|
|
4706
|
+
acceptedMessageTypes?: AcceptedSmsMessageTypeWithLiterals[];
|
|
4578
4707
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4579
4708
|
mediaCapabilities?: MediaCapabilities;
|
|
4580
4709
|
}
|
|
@@ -4582,6 +4711,8 @@ export declare enum AcceptedSmsMessageType {
|
|
|
4582
4711
|
SMS = "SMS",
|
|
4583
4712
|
MMS = "MMS"
|
|
4584
4713
|
}
|
|
4714
|
+
/** @enumType */
|
|
4715
|
+
export type AcceptedSmsMessageTypeWithLiterals = AcceptedSmsMessageType | 'SMS' | 'MMS';
|
|
4585
4716
|
export interface ChannelBranding {
|
|
4586
4717
|
/** The name of the channel, e.g. `Facebook` / `SMS` */
|
|
4587
4718
|
displayName?: string;
|
|
@@ -4610,7 +4741,7 @@ export interface ConversationLimitations {
|
|
|
4610
4741
|
* If, `CUSTOMER` is selected, this means that only inbound
|
|
4611
4742
|
* messages can start a conversation (aka business can only reply and not initiate the first communication).
|
|
4612
4743
|
*/
|
|
4613
|
-
initDirection?:
|
|
4744
|
+
initDirection?: InitDirectionWithLiterals;
|
|
4614
4745
|
}
|
|
4615
4746
|
export declare enum InitDirection {
|
|
4616
4747
|
UNKNOWN_INIT_DIRECTION = "UNKNOWN_INIT_DIRECTION",
|
|
@@ -4618,6 +4749,8 @@ export declare enum InitDirection {
|
|
|
4618
4749
|
CUSTOMER = "CUSTOMER",
|
|
4619
4750
|
BOTH = "BOTH"
|
|
4620
4751
|
}
|
|
4752
|
+
/** @enumType */
|
|
4753
|
+
export type InitDirectionWithLiterals = InitDirection | 'UNKNOWN_INIT_DIRECTION' | 'BUSINESS' | 'CUSTOMER' | 'BOTH';
|
|
4621
4754
|
export interface PostLoginConfig {
|
|
4622
4755
|
/** the base URI where all the methods are deployed. */
|
|
4623
4756
|
baseUri?: string;
|
|
@@ -4878,7 +5011,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
4878
5011
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
4879
5012
|
layoutCellData?: LayoutCellData;
|
|
4880
5013
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
4881
|
-
type?:
|
|
5014
|
+
type?: NodeTypeWithLiterals;
|
|
4882
5015
|
/** Node ID. */
|
|
4883
5016
|
id?: string;
|
|
4884
5017
|
/** A list of child nodes. */
|
|
@@ -4979,6 +5112,8 @@ export declare enum NodeType {
|
|
|
4979
5112
|
LAYOUT = "LAYOUT",
|
|
4980
5113
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
4981
5114
|
}
|
|
5115
|
+
/** @enumType */
|
|
5116
|
+
export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
4982
5117
|
export interface NodeStyle {
|
|
4983
5118
|
/** The top padding value in pixels. */
|
|
4984
5119
|
paddingTop?: string | null;
|
|
@@ -4991,7 +5126,7 @@ export interface ButtonData {
|
|
|
4991
5126
|
/** Styling for the button's container. */
|
|
4992
5127
|
containerData?: PluginContainerData;
|
|
4993
5128
|
/** The button type. */
|
|
4994
|
-
type?:
|
|
5129
|
+
type?: ButtonDataTypeWithLiterals;
|
|
4995
5130
|
/** Styling for the button. */
|
|
4996
5131
|
styles?: Styles;
|
|
4997
5132
|
/** The text to display on the button. */
|
|
@@ -5032,7 +5167,7 @@ export interface PluginContainerData {
|
|
|
5032
5167
|
/** The width of the node when it's displayed. */
|
|
5033
5168
|
width?: PluginContainerDataWidth;
|
|
5034
5169
|
/** The node's alignment within its container. */
|
|
5035
|
-
alignment?:
|
|
5170
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
5036
5171
|
/** Spoiler cover settings for the node. */
|
|
5037
5172
|
spoiler?: Spoiler;
|
|
5038
5173
|
/** The height of the node when it's displayed. */
|
|
@@ -5050,6 +5185,8 @@ export declare enum WidthType {
|
|
|
5050
5185
|
/** coast-to-coast display */
|
|
5051
5186
|
FULL_WIDTH = "FULL_WIDTH"
|
|
5052
5187
|
}
|
|
5188
|
+
/** @enumType */
|
|
5189
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
5053
5190
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
5054
5191
|
/**
|
|
5055
5192
|
* One of the following predefined width options:
|
|
@@ -5058,7 +5195,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
5058
5195
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5059
5196
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5060
5197
|
*/
|
|
5061
|
-
size?:
|
|
5198
|
+
size?: WidthTypeWithLiterals;
|
|
5062
5199
|
/** A custom width value in pixels. */
|
|
5063
5200
|
custom?: string | null;
|
|
5064
5201
|
}
|
|
@@ -5071,7 +5208,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
5071
5208
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5072
5209
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5073
5210
|
*/
|
|
5074
|
-
size?:
|
|
5211
|
+
size?: WidthTypeWithLiterals;
|
|
5075
5212
|
/** A custom width value in pixels. */
|
|
5076
5213
|
custom?: string | null;
|
|
5077
5214
|
}
|
|
@@ -5083,6 +5220,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
5083
5220
|
/** Right Alignment */
|
|
5084
5221
|
RIGHT = "RIGHT"
|
|
5085
5222
|
}
|
|
5223
|
+
/** @enumType */
|
|
5224
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5086
5225
|
export interface Spoiler {
|
|
5087
5226
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
5088
5227
|
enabled?: boolean | null;
|
|
@@ -5101,6 +5240,8 @@ export declare enum ButtonDataType {
|
|
|
5101
5240
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
5102
5241
|
ACTION = "ACTION"
|
|
5103
5242
|
}
|
|
5243
|
+
/** @enumType */
|
|
5244
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
5104
5245
|
export interface Styles {
|
|
5105
5246
|
/**
|
|
5106
5247
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -5166,7 +5307,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
5166
5307
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
5167
5308
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
5168
5309
|
*/
|
|
5169
|
-
target?:
|
|
5310
|
+
target?: LinkTargetWithLiterals;
|
|
5170
5311
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
5171
5312
|
rel?: Rel;
|
|
5172
5313
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -5189,6 +5330,8 @@ export declare enum LinkTarget {
|
|
|
5189
5330
|
/** Opens the linked document in the full body of the window */
|
|
5190
5331
|
TOP = "TOP"
|
|
5191
5332
|
}
|
|
5333
|
+
/** @enumType */
|
|
5334
|
+
export type LinkTargetWithLiterals = LinkTarget | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
5192
5335
|
export interface Rel {
|
|
5193
5336
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
5194
5337
|
nofollow?: boolean | null;
|
|
@@ -5205,7 +5348,7 @@ export interface CodeBlockData {
|
|
|
5205
5348
|
}
|
|
5206
5349
|
export interface V1TextStyle {
|
|
5207
5350
|
/** Text alignment. Defaults to `AUTO`. */
|
|
5208
|
-
textAlignment?:
|
|
5351
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
5209
5352
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
5210
5353
|
lineHeight?: string | null;
|
|
5211
5354
|
}
|
|
@@ -5221,15 +5364,17 @@ export declare enum TextAlignment {
|
|
|
5221
5364
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
5222
5365
|
JUSTIFY = "JUSTIFY"
|
|
5223
5366
|
}
|
|
5367
|
+
/** @enumType */
|
|
5368
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
5224
5369
|
export interface DividerData {
|
|
5225
5370
|
/** Styling for the divider's container. */
|
|
5226
5371
|
containerData?: PluginContainerData;
|
|
5227
5372
|
/** Divider line style. */
|
|
5228
|
-
lineStyle?:
|
|
5373
|
+
lineStyle?: LineStyleWithLiterals;
|
|
5229
5374
|
/** Divider width. */
|
|
5230
|
-
width?:
|
|
5375
|
+
width?: DividerDataWidthWithLiterals;
|
|
5231
5376
|
/** Divider alignment. */
|
|
5232
|
-
alignment?:
|
|
5377
|
+
alignment?: AlignmentWithLiterals;
|
|
5233
5378
|
}
|
|
5234
5379
|
export declare enum LineStyle {
|
|
5235
5380
|
/** Single Line */
|
|
@@ -5241,6 +5386,8 @@ export declare enum LineStyle {
|
|
|
5241
5386
|
/** Dotted Line */
|
|
5242
5387
|
DOTTED = "DOTTED"
|
|
5243
5388
|
}
|
|
5389
|
+
/** @enumType */
|
|
5390
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
5244
5391
|
export declare enum DividerDataWidth {
|
|
5245
5392
|
/** Large line */
|
|
5246
5393
|
LARGE = "LARGE",
|
|
@@ -5249,6 +5396,8 @@ export declare enum DividerDataWidth {
|
|
|
5249
5396
|
/** Small line */
|
|
5250
5397
|
SMALL = "SMALL"
|
|
5251
5398
|
}
|
|
5399
|
+
/** @enumType */
|
|
5400
|
+
export type DividerDataWidthWithLiterals = DividerDataWidth | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
5252
5401
|
export declare enum Alignment {
|
|
5253
5402
|
/** Center alignment */
|
|
5254
5403
|
CENTER = "CENTER",
|
|
@@ -5257,6 +5406,8 @@ export declare enum Alignment {
|
|
|
5257
5406
|
/** Right alignment */
|
|
5258
5407
|
RIGHT = "RIGHT"
|
|
5259
5408
|
}
|
|
5409
|
+
/** @enumType */
|
|
5410
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5260
5411
|
export interface FileData {
|
|
5261
5412
|
/** Styling for the file's container. */
|
|
5262
5413
|
containerData?: PluginContainerData;
|
|
@@ -5288,6 +5439,8 @@ export declare enum PDFSettingsViewMode {
|
|
|
5288
5439
|
/** Mini PDF view */
|
|
5289
5440
|
MINI = "MINI"
|
|
5290
5441
|
}
|
|
5442
|
+
/** @enumType */
|
|
5443
|
+
export type PDFSettingsViewModeWithLiterals = PDFSettingsViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
5291
5444
|
export interface FileSource extends FileSourceDataOneOf {
|
|
5292
5445
|
/** The absolute URL for the file's source. */
|
|
5293
5446
|
url?: string | null;
|
|
@@ -5320,7 +5473,7 @@ export interface PDFSettings {
|
|
|
5320
5473
|
* `FULL` : A full page view of the PDF is displayed.
|
|
5321
5474
|
* `MINI` : A mini view of the PDF is displayed.
|
|
5322
5475
|
*/
|
|
5323
|
-
viewMode?:
|
|
5476
|
+
viewMode?: PDFSettingsViewModeWithLiterals;
|
|
5324
5477
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
5325
5478
|
disableDownload?: boolean | null;
|
|
5326
5479
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -5407,18 +5560,24 @@ export declare enum LayoutType {
|
|
|
5407
5560
|
/** Fullsize images type */
|
|
5408
5561
|
FULLSIZE = "FULLSIZE"
|
|
5409
5562
|
}
|
|
5563
|
+
/** @enumType */
|
|
5564
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
5410
5565
|
export declare enum Orientation {
|
|
5411
5566
|
/** Rows Orientation */
|
|
5412
5567
|
ROWS = "ROWS",
|
|
5413
5568
|
/** Columns Orientation */
|
|
5414
5569
|
COLUMNS = "COLUMNS"
|
|
5415
5570
|
}
|
|
5571
|
+
/** @enumType */
|
|
5572
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
5416
5573
|
export declare enum Crop {
|
|
5417
5574
|
/** Crop to fill */
|
|
5418
5575
|
FILL = "FILL",
|
|
5419
5576
|
/** Crop to fit */
|
|
5420
5577
|
FIT = "FIT"
|
|
5421
5578
|
}
|
|
5579
|
+
/** @enumType */
|
|
5580
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
5422
5581
|
export declare enum ThumbnailsAlignment {
|
|
5423
5582
|
/** Top alignment */
|
|
5424
5583
|
TOP = "TOP",
|
|
@@ -5431,13 +5590,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
5431
5590
|
/** No thumbnail */
|
|
5432
5591
|
NONE = "NONE"
|
|
5433
5592
|
}
|
|
5593
|
+
/** @enumType */
|
|
5594
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
5434
5595
|
export interface Layout {
|
|
5435
5596
|
/** Gallery layout type. */
|
|
5436
|
-
type?:
|
|
5597
|
+
type?: LayoutTypeWithLiterals;
|
|
5437
5598
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
5438
5599
|
horizontalScroll?: boolean | null;
|
|
5439
5600
|
/** Gallery orientation. */
|
|
5440
|
-
orientation?:
|
|
5601
|
+
orientation?: OrientationWithLiterals;
|
|
5441
5602
|
/** The number of columns to display on full size screens. */
|
|
5442
5603
|
numberOfColumns?: number | null;
|
|
5443
5604
|
/** The number of columns to display on mobile screens. */
|
|
@@ -5449,13 +5610,13 @@ export interface ItemStyle {
|
|
|
5449
5610
|
/** Item ratio */
|
|
5450
5611
|
ratio?: number | null;
|
|
5451
5612
|
/** Sets how item images are cropped. */
|
|
5452
|
-
crop?:
|
|
5613
|
+
crop?: CropWithLiterals;
|
|
5453
5614
|
/** The spacing between items in pixels. */
|
|
5454
5615
|
spacing?: number | null;
|
|
5455
5616
|
}
|
|
5456
5617
|
export interface GalleryOptionsThumbnails {
|
|
5457
5618
|
/** Thumbnail alignment. */
|
|
5458
|
-
placement?:
|
|
5619
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
5459
5620
|
/** Spacing between thumbnails in pixels. */
|
|
5460
5621
|
spacing?: number | null;
|
|
5461
5622
|
}
|
|
@@ -5471,7 +5632,7 @@ export interface GIFData {
|
|
|
5471
5632
|
/** Width in pixels. */
|
|
5472
5633
|
width?: number;
|
|
5473
5634
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
5474
|
-
gifType?:
|
|
5635
|
+
gifType?: GIFTypeWithLiterals;
|
|
5475
5636
|
}
|
|
5476
5637
|
export interface GIF {
|
|
5477
5638
|
/**
|
|
@@ -5494,6 +5655,8 @@ export declare enum GIFType {
|
|
|
5494
5655
|
NORMAL = "NORMAL",
|
|
5495
5656
|
STICKER = "STICKER"
|
|
5496
5657
|
}
|
|
5658
|
+
/** @enumType */
|
|
5659
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
5497
5660
|
export interface HeadingData {
|
|
5498
5661
|
/** Heading level from 1-6. */
|
|
5499
5662
|
level?: number;
|
|
@@ -5515,7 +5678,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
5515
5678
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
5516
5679
|
containerData?: PluginContainerData;
|
|
5517
5680
|
/** The type of HTML code. */
|
|
5518
|
-
source?:
|
|
5681
|
+
source?: HTMLDataSourceWithLiterals;
|
|
5519
5682
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
5520
5683
|
autoHeight?: boolean | null;
|
|
5521
5684
|
}
|
|
@@ -5535,6 +5698,8 @@ export declare enum HTMLDataSource {
|
|
|
5535
5698
|
HTML = "HTML",
|
|
5536
5699
|
ADSENSE = "ADSENSE"
|
|
5537
5700
|
}
|
|
5701
|
+
/** @enumType */
|
|
5702
|
+
export type HTMLDataSourceWithLiterals = HTMLDataSource | 'HTML' | 'ADSENSE';
|
|
5538
5703
|
export interface ImageData {
|
|
5539
5704
|
/** Styling for the image's container. */
|
|
5540
5705
|
containerData?: PluginContainerData;
|
|
@@ -5599,6 +5764,8 @@ export declare enum StylesPosition {
|
|
|
5599
5764
|
/** Thumbnail hidden and not displayed */
|
|
5600
5765
|
HIDDEN = "HIDDEN"
|
|
5601
5766
|
}
|
|
5767
|
+
/** @enumType */
|
|
5768
|
+
export type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
5602
5769
|
export interface LinkPreviewDataStyles {
|
|
5603
5770
|
/**
|
|
5604
5771
|
* Background color as a hexadecimal value.
|
|
@@ -5630,7 +5797,7 @@ export interface LinkPreviewDataStyles {
|
|
|
5630
5797
|
*/
|
|
5631
5798
|
borderColor?: string | null;
|
|
5632
5799
|
/** Position of thumbnail. Defaults to `START`. */
|
|
5633
|
-
thumbnailPosition?:
|
|
5800
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
5634
5801
|
}
|
|
5635
5802
|
export interface MapData {
|
|
5636
5803
|
/** Styling for the map's container. */
|
|
@@ -5660,7 +5827,7 @@ export interface MapSettings {
|
|
|
5660
5827
|
/** Initial zoom value. */
|
|
5661
5828
|
initialZoom?: number | null;
|
|
5662
5829
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
5663
|
-
mapType?:
|
|
5830
|
+
mapType?: MapTypeWithLiterals;
|
|
5664
5831
|
}
|
|
5665
5832
|
export declare enum MapType {
|
|
5666
5833
|
/** Roadmap map type */
|
|
@@ -5672,6 +5839,8 @@ export declare enum MapType {
|
|
|
5672
5839
|
/** Terrain map type */
|
|
5673
5840
|
TERRAIN = "TERRAIN"
|
|
5674
5841
|
}
|
|
5842
|
+
/** @enumType */
|
|
5843
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
5675
5844
|
export interface ParagraphData {
|
|
5676
5845
|
/** Styling for the paragraph text. */
|
|
5677
5846
|
textStyle?: V1TextStyle;
|
|
@@ -5698,17 +5867,21 @@ export declare enum ViewRole {
|
|
|
5698
5867
|
/** Anyone can see the results, even if one didn't vote */
|
|
5699
5868
|
EVERYONE = "EVERYONE"
|
|
5700
5869
|
}
|
|
5870
|
+
/** @enumType */
|
|
5871
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
5701
5872
|
export declare enum VoteRole {
|
|
5702
5873
|
/** Logged in member */
|
|
5703
5874
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
5704
5875
|
/** Anyone */
|
|
5705
5876
|
ALL = "ALL"
|
|
5706
5877
|
}
|
|
5878
|
+
/** @enumType */
|
|
5879
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
5707
5880
|
export interface SettingsPermissions {
|
|
5708
5881
|
/** Sets who can view the poll results. */
|
|
5709
|
-
view?:
|
|
5882
|
+
view?: ViewRoleWithLiterals;
|
|
5710
5883
|
/** Sets who can vote. */
|
|
5711
|
-
vote?:
|
|
5884
|
+
vote?: VoteRoleWithLiterals;
|
|
5712
5885
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
5713
5886
|
allowMultipleVotes?: boolean | null;
|
|
5714
5887
|
}
|
|
@@ -5734,17 +5907,21 @@ export declare enum PollLayoutType {
|
|
|
5734
5907
|
/** Grid */
|
|
5735
5908
|
GRID = "GRID"
|
|
5736
5909
|
}
|
|
5910
|
+
/** @enumType */
|
|
5911
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
5737
5912
|
export declare enum PollLayoutDirection {
|
|
5738
5913
|
/** Left-to-right */
|
|
5739
5914
|
LTR = "LTR",
|
|
5740
5915
|
/** Right-to-left */
|
|
5741
5916
|
RTL = "RTL"
|
|
5742
5917
|
}
|
|
5918
|
+
/** @enumType */
|
|
5919
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
5743
5920
|
export interface PollLayout {
|
|
5744
5921
|
/** The layout for displaying the voting options. */
|
|
5745
|
-
type?:
|
|
5922
|
+
type?: PollLayoutTypeWithLiterals;
|
|
5746
5923
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
5747
|
-
direction?:
|
|
5924
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
5748
5925
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
5749
5926
|
enableImage?: boolean | null;
|
|
5750
5927
|
}
|
|
@@ -5760,6 +5937,8 @@ export declare enum BackgroundType {
|
|
|
5760
5937
|
/** Gradiant background type */
|
|
5761
5938
|
GRADIENT = "GRADIENT"
|
|
5762
5939
|
}
|
|
5940
|
+
/** @enumType */
|
|
5941
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
5763
5942
|
export interface Gradient {
|
|
5764
5943
|
/** The gradient angle in degrees. */
|
|
5765
5944
|
angle?: number | null;
|
|
@@ -5785,7 +5964,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
5785
5964
|
/** Details for a gradient background. */
|
|
5786
5965
|
gradient?: Gradient;
|
|
5787
5966
|
/** Background type. For each option, include the relevant details. */
|
|
5788
|
-
type?:
|
|
5967
|
+
type?: BackgroundTypeWithLiterals;
|
|
5789
5968
|
}
|
|
5790
5969
|
/** @oneof */
|
|
5791
5970
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -5864,7 +6043,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
5864
6043
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
5865
6044
|
strikethroughData?: boolean | null;
|
|
5866
6045
|
/** The type of decoration to apply. */
|
|
5867
|
-
type?:
|
|
6046
|
+
type?: DecorationTypeWithLiterals;
|
|
5868
6047
|
}
|
|
5869
6048
|
/** @oneof */
|
|
5870
6049
|
export interface DecorationDataOneOf {
|
|
@@ -5902,6 +6081,8 @@ export declare enum DecorationType {
|
|
|
5902
6081
|
EXTERNAL = "EXTERNAL",
|
|
5903
6082
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
5904
6083
|
}
|
|
6084
|
+
/** @enumType */
|
|
6085
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
5905
6086
|
export interface AnchorData {
|
|
5906
6087
|
/** The target node's ID. */
|
|
5907
6088
|
anchor?: string;
|
|
@@ -5926,7 +6107,7 @@ export interface MentionData {
|
|
|
5926
6107
|
}
|
|
5927
6108
|
export interface FontSizeData {
|
|
5928
6109
|
/** The units used for the font size. */
|
|
5929
|
-
unit?:
|
|
6110
|
+
unit?: FontTypeWithLiterals;
|
|
5930
6111
|
/** Font size value. */
|
|
5931
6112
|
value?: number | null;
|
|
5932
6113
|
}
|
|
@@ -5934,6 +6115,8 @@ export declare enum FontType {
|
|
|
5934
6115
|
PX = "PX",
|
|
5935
6116
|
EM = "EM"
|
|
5936
6117
|
}
|
|
6118
|
+
/** @enumType */
|
|
6119
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
5937
6120
|
export interface SpoilerData {
|
|
5938
6121
|
/** Spoiler ID. */
|
|
5939
6122
|
id?: string | null;
|
|
@@ -5944,7 +6127,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
5944
6127
|
/** Data for embedded Wix Events content. */
|
|
5945
6128
|
eventData?: EventData;
|
|
5946
6129
|
/** The type of Wix App content being embedded. */
|
|
5947
|
-
type?:
|
|
6130
|
+
type?: AppTypeWithLiterals;
|
|
5948
6131
|
/** The ID of the embedded content. */
|
|
5949
6132
|
itemId?: string | null;
|
|
5950
6133
|
/** The name of the embedded content. */
|
|
@@ -5971,6 +6154,8 @@ export declare enum AppType {
|
|
|
5971
6154
|
EVENT = "EVENT",
|
|
5972
6155
|
BOOKING = "BOOKING"
|
|
5973
6156
|
}
|
|
6157
|
+
/** @enumType */
|
|
6158
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
5974
6159
|
export interface BookingData {
|
|
5975
6160
|
/** Booking duration in minutes. */
|
|
5976
6161
|
durations?: string | null;
|
|
@@ -6049,9 +6234,9 @@ export interface CollapsibleListData {
|
|
|
6049
6234
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
6050
6235
|
expandOnlyOne?: boolean | null;
|
|
6051
6236
|
/** Sets which items are expanded when the page loads. */
|
|
6052
|
-
initialExpandedItems?:
|
|
6237
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
6053
6238
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
6054
|
-
direction?:
|
|
6239
|
+
direction?: DirectionWithLiterals;
|
|
6055
6240
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
6056
6241
|
isQapageData?: boolean | null;
|
|
6057
6242
|
}
|
|
@@ -6063,12 +6248,16 @@ export declare enum InitialExpandedItems {
|
|
|
6063
6248
|
/** All items collapsed initally */
|
|
6064
6249
|
NONE = "NONE"
|
|
6065
6250
|
}
|
|
6251
|
+
/** @enumType */
|
|
6252
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
6066
6253
|
export declare enum Direction {
|
|
6067
6254
|
/** Left-to-right */
|
|
6068
6255
|
LTR = "LTR",
|
|
6069
6256
|
/** Right-to-left */
|
|
6070
6257
|
RTL = "RTL"
|
|
6071
6258
|
}
|
|
6259
|
+
/** @enumType */
|
|
6260
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
6072
6261
|
export interface TableData {
|
|
6073
6262
|
/** Styling for the table's container. */
|
|
6074
6263
|
containerData?: PluginContainerData;
|
|
@@ -6106,9 +6295,11 @@ export declare enum VerticalAlignment {
|
|
|
6106
6295
|
/** Bottom alignment */
|
|
6107
6296
|
BOTTOM = "BOTTOM"
|
|
6108
6297
|
}
|
|
6298
|
+
/** @enumType */
|
|
6299
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
6109
6300
|
export interface CellStyle {
|
|
6110
6301
|
/** Vertical alignment for the cell's text. */
|
|
6111
|
-
verticalAlignment?:
|
|
6302
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
6112
6303
|
/**
|
|
6113
6304
|
* Cell background color as a hexadecimal value.
|
|
6114
6305
|
* @format COLOR_HEX
|
|
@@ -6147,6 +6338,8 @@ export declare enum NullValue {
|
|
|
6147
6338
|
/** Null value. */
|
|
6148
6339
|
NULL_VALUE = "NULL_VALUE"
|
|
6149
6340
|
}
|
|
6341
|
+
/** @enumType */
|
|
6342
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
6150
6343
|
/**
|
|
6151
6344
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
6152
6345
|
*
|
|
@@ -6287,7 +6480,7 @@ export interface ComponentsValidatorConfig {
|
|
|
6287
6480
|
* @minSize 1
|
|
6288
6481
|
* @maxSize 100
|
|
6289
6482
|
*/
|
|
6290
|
-
componentValidationTypes?:
|
|
6483
|
+
componentValidationTypes?: ComponentTypeWithLiterals[];
|
|
6291
6484
|
/** Indicates whether the validation should affect real production */
|
|
6292
6485
|
testMode?: boolean;
|
|
6293
6486
|
}
|
|
@@ -6342,18 +6535,18 @@ export interface ProviderConfig {
|
|
|
6342
6535
|
/** The base URI in which all methods are deployed. */
|
|
6343
6536
|
baseUri?: string;
|
|
6344
6537
|
/** The provided calendar type. */
|
|
6345
|
-
calendarType?:
|
|
6538
|
+
calendarType?: CalendarTypeWithLiterals;
|
|
6346
6539
|
/**
|
|
6347
6540
|
* Connect methods used to connect to the calendar.
|
|
6348
6541
|
* @minSize 1
|
|
6349
6542
|
*/
|
|
6350
|
-
connectMethods?:
|
|
6543
|
+
connectMethods?: ConnectMethodWithLiterals[];
|
|
6351
6544
|
/** Whether the sync configuration can be updated. */
|
|
6352
6545
|
canUpdateSyncConfig?: boolean;
|
|
6353
6546
|
/** Whether events can be listed from the external calendar to the Wix calendar. */
|
|
6354
|
-
listEventFromCalendars?:
|
|
6547
|
+
listEventFromCalendars?: ListEventFromCalendarsWithLiterals;
|
|
6355
6548
|
/** Whether Wix calendar sessions can be synced to the external calendar. */
|
|
6356
|
-
syncToCalendar?:
|
|
6549
|
+
syncToCalendar?: SyncToCalendarWithLiterals;
|
|
6357
6550
|
}
|
|
6358
6551
|
export declare enum CalendarType {
|
|
6359
6552
|
UNDEFINED = "UNDEFINED",
|
|
@@ -6362,10 +6555,14 @@ export declare enum CalendarType {
|
|
|
6362
6555
|
MICROSOFT = "MICROSOFT",
|
|
6363
6556
|
OTHER = "OTHER"
|
|
6364
6557
|
}
|
|
6558
|
+
/** @enumType */
|
|
6559
|
+
export type CalendarTypeWithLiterals = CalendarType | 'UNDEFINED' | 'GOOGLE' | 'I_CAL' | 'MICROSOFT' | 'OTHER';
|
|
6365
6560
|
export declare enum ConnectMethod {
|
|
6366
6561
|
OAUTH = "OAUTH",
|
|
6367
6562
|
CREDENTIALS = "CREDENTIALS"
|
|
6368
6563
|
}
|
|
6564
|
+
/** @enumType */
|
|
6565
|
+
export type ConnectMethodWithLiterals = ConnectMethod | 'OAUTH' | 'CREDENTIALS';
|
|
6369
6566
|
export declare enum ListEventFromCalendars {
|
|
6370
6567
|
/** Listing events from the external calendar is not supported. */
|
|
6371
6568
|
LIST_NOT_SUPPORTED = "LIST_NOT_SUPPORTED",
|
|
@@ -6377,6 +6574,8 @@ export declare enum ListEventFromCalendars {
|
|
|
6377
6574
|
*/
|
|
6378
6575
|
LIST_FROM_SPECIFIC_CALENDARS = "LIST_FROM_SPECIFIC_CALENDARS"
|
|
6379
6576
|
}
|
|
6577
|
+
/** @enumType */
|
|
6578
|
+
export type ListEventFromCalendarsWithLiterals = ListEventFromCalendars | 'LIST_NOT_SUPPORTED' | 'LIST_FROM_PRIMARY_CALENDAR_ONLY' | 'LIST_FROM_SPECIFIC_CALENDARS';
|
|
6380
6579
|
export declare enum SyncToCalendar {
|
|
6381
6580
|
/** Syncing Wix calendar sessions to the external calendar is not supported. */
|
|
6382
6581
|
SYNC_NOT_SUPPORTED = "SYNC_NOT_SUPPORTED",
|
|
@@ -6385,6 +6584,8 @@ export declare enum SyncToCalendar {
|
|
|
6385
6584
|
/** Syncing Wix calendar sessions to a new external calendar. */
|
|
6386
6585
|
SYNC_TO_DEDICATED_CALENDAR = "SYNC_TO_DEDICATED_CALENDAR"
|
|
6387
6586
|
}
|
|
6587
|
+
/** @enumType */
|
|
6588
|
+
export type SyncToCalendarWithLiterals = SyncToCalendar | 'SYNC_NOT_SUPPORTED' | 'SYNC_TO_PRIMARY_CALENDAR_ONLY' | 'SYNC_TO_DEDICATED_CALENDAR';
|
|
6388
6589
|
export interface DefaultTaxGroupProviderConfig {
|
|
6389
6590
|
/** URI where the SPI Implementer is deployed */
|
|
6390
6591
|
deploymentUri?: string;
|
|
@@ -6432,9 +6633,9 @@ export interface HeadlessOAuth {
|
|
|
6432
6633
|
*/
|
|
6433
6634
|
logoutUrl?: string | null;
|
|
6434
6635
|
/** OAuth application type. */
|
|
6435
|
-
applicationType?:
|
|
6636
|
+
applicationType?: OAuthAppTypeWithLiterals;
|
|
6436
6637
|
/** OAuth technology used by the application. */
|
|
6437
|
-
technology?:
|
|
6638
|
+
technology?: OAuthTechnologiesWithLiterals;
|
|
6438
6639
|
}
|
|
6439
6640
|
/** Types of OAuth application. */
|
|
6440
6641
|
export declare enum OAuthAppType {
|
|
@@ -6447,6 +6648,8 @@ export declare enum OAuthAppType {
|
|
|
6447
6648
|
/** OAuth app type is some other type of application. */
|
|
6448
6649
|
OTHER = "OTHER"
|
|
6449
6650
|
}
|
|
6651
|
+
/** @enumType */
|
|
6652
|
+
export type OAuthAppTypeWithLiterals = OAuthAppType | 'OAUTH_APP_TYPE_UNSPECIFIED' | 'WEB_APP' | 'MOBILE' | 'OTHER';
|
|
6450
6653
|
/** OAuth technology used by the oauth application. */
|
|
6451
6654
|
export declare enum OAuthTechnologies {
|
|
6452
6655
|
/** The OAuth technology is not specified. */
|
|
@@ -6468,6 +6671,8 @@ export declare enum OAuthTechnologies {
|
|
|
6468
6671
|
/** OAuth technology using some other kind of technology. */
|
|
6469
6672
|
OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
|
|
6470
6673
|
}
|
|
6674
|
+
/** @enumType */
|
|
6675
|
+
export type OAuthTechnologiesWithLiterals = OAuthTechnologies | 'OAUTH_TECHNOLOGY_UNSPECIFIED' | 'JAVASCRIPT' | 'ANGULAR' | 'VUE' | 'REACT' | 'REACT_NATIVE' | 'IOS' | 'ANDROID' | 'OTHER_TECHNOLOGY';
|
|
6471
6676
|
export interface TaxCalculatorSpiConfig {
|
|
6472
6677
|
/** URI where the SPI Implementer is deployed */
|
|
6473
6678
|
deploymentUri?: string;
|
|
@@ -6542,7 +6747,7 @@ export interface ComponentReferenceDataConfig {
|
|
|
6542
6747
|
* @minSize 1
|
|
6543
6748
|
* @maxSize 100
|
|
6544
6749
|
*/
|
|
6545
|
-
supportedComponentTypes?:
|
|
6750
|
+
supportedComponentTypes?: ComponentTypeWithLiterals[];
|
|
6546
6751
|
}
|
|
6547
6752
|
/** Configuration for ReviewsProductCatalogProvider */
|
|
6548
6753
|
export interface ReviewsProductCatalogProviderConfig {
|
|
@@ -6577,7 +6782,7 @@ export interface SocialMarketingDesignsProviderConfig {
|
|
|
6577
6782
|
*/
|
|
6578
6783
|
iconUrl?: string;
|
|
6579
6784
|
/** How the Prover should be opened */
|
|
6580
|
-
navigationType?:
|
|
6785
|
+
navigationType?: NavigationTypeWithLiterals;
|
|
6581
6786
|
/** Is delete design implemented by the provider */
|
|
6582
6787
|
deleteDesignEnabled?: boolean;
|
|
6583
6788
|
/** If the provider manages designs */
|
|
@@ -6587,6 +6792,8 @@ export declare enum NavigationType {
|
|
|
6587
6792
|
NAVIGATE = "NAVIGATE",
|
|
6588
6793
|
MODAL = "MODAL"
|
|
6589
6794
|
}
|
|
6795
|
+
/** @enumType */
|
|
6796
|
+
export type NavigationTypeWithLiterals = NavigationType | 'NAVIGATE' | 'MODAL';
|
|
6590
6797
|
export interface GbpFeatureConfig {
|
|
6591
6798
|
baseUri?: SpiBaseUri;
|
|
6592
6799
|
}
|
|
@@ -6614,13 +6821,15 @@ export interface PingSettingsGroupComponentData {
|
|
|
6614
6821
|
/** the description of the setting group */
|
|
6615
6822
|
description?: string | null;
|
|
6616
6823
|
/** the default state of the setting group */
|
|
6617
|
-
state?:
|
|
6824
|
+
state?: PingSettingsGroupComponentDataStateWithLiterals;
|
|
6618
6825
|
}
|
|
6619
6826
|
export declare enum PingSettingsGroupComponentDataState {
|
|
6620
6827
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6621
6828
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6622
6829
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6623
6830
|
}
|
|
6831
|
+
/** @enumType */
|
|
6832
|
+
export type PingSettingsGroupComponentDataStateWithLiterals = PingSettingsGroupComponentDataState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6624
6833
|
export interface FormSpamSubmissionSpiConfig {
|
|
6625
6834
|
/** URI where the SPI Implementer is deployed */
|
|
6626
6835
|
baseUri?: SpiBaseUri;
|
|
@@ -6768,25 +6977,29 @@ export interface NotificationTopic {
|
|
|
6768
6977
|
/** the description of the topic */
|
|
6769
6978
|
description?: string | null;
|
|
6770
6979
|
/** the default state of the topic */
|
|
6771
|
-
state?:
|
|
6980
|
+
state?: NotificationTopicStateWithLiterals;
|
|
6772
6981
|
/** the type of the topic */
|
|
6773
|
-
type?:
|
|
6982
|
+
type?: NotificationTopicTypeWithLiterals;
|
|
6774
6983
|
/**
|
|
6775
6984
|
* The recipients' types indicate that this topic is relevant.
|
|
6776
6985
|
* @maxSize 10
|
|
6777
6986
|
*/
|
|
6778
|
-
supportedRecipientTypes?:
|
|
6987
|
+
supportedRecipientTypes?: RecipientTypeWithLiterals[];
|
|
6779
6988
|
}
|
|
6780
6989
|
export declare enum NotificationTopicState {
|
|
6781
6990
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6782
6991
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6783
6992
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6784
6993
|
}
|
|
6994
|
+
/** @enumType */
|
|
6995
|
+
export type NotificationTopicStateWithLiterals = NotificationTopicState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6785
6996
|
export declare enum NotificationTopicType {
|
|
6786
6997
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
6787
6998
|
PROMOTIONAL = "PROMOTIONAL",
|
|
6788
6999
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
6789
7000
|
}
|
|
7001
|
+
/** @enumType */
|
|
7002
|
+
export type NotificationTopicTypeWithLiterals = NotificationTopicType | 'UNKNOWN_TYPE' | 'PROMOTIONAL' | 'TRANSACTIONAL';
|
|
6790
7003
|
/** Recipient type */
|
|
6791
7004
|
export declare enum RecipientType {
|
|
6792
7005
|
/** Wix User */
|
|
@@ -6794,6 +7007,8 @@ export declare enum RecipientType {
|
|
|
6794
7007
|
/** Contact */
|
|
6795
7008
|
CONTACT = "CONTACT"
|
|
6796
7009
|
}
|
|
7010
|
+
/** @enumType */
|
|
7011
|
+
export type RecipientTypeWithLiterals = RecipientType | 'WIX_USER' | 'CONTACT';
|
|
6797
7012
|
export interface NotificationPreferencesFilterConfig {
|
|
6798
7013
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
6799
7014
|
baseUri?: SpiBaseUri;
|
|
@@ -7116,6 +7331,8 @@ export declare enum PlanFormPricingOption {
|
|
|
7116
7331
|
ONE_TIME = "ONE_TIME",
|
|
7117
7332
|
RECURRING = "RECURRING"
|
|
7118
7333
|
}
|
|
7334
|
+
/** @enumType */
|
|
7335
|
+
export type PlanFormPricingOptionWithLiterals = PlanFormPricingOption | 'FREE' | 'ONE_TIME' | 'RECURRING';
|
|
7119
7336
|
export declare enum PlanFormDefaultSection {
|
|
7120
7337
|
INFO = "INFO",
|
|
7121
7338
|
BENEFITS = "BENEFITS",
|
|
@@ -7123,6 +7340,8 @@ export declare enum PlanFormDefaultSection {
|
|
|
7123
7340
|
PRICING_AND_DURATION = "PRICING_AND_DURATION",
|
|
7124
7341
|
ADVANCED_SETTINGS = "ADVANCED_SETTINGS"
|
|
7125
7342
|
}
|
|
7343
|
+
/** @enumType */
|
|
7344
|
+
export type PlanFormDefaultSectionWithLiterals = PlanFormDefaultSection | 'INFO' | 'BENEFITS' | 'PAGE_PERMISSIONS' | 'PRICING_AND_DURATION' | 'ADVANCED_SETTINGS';
|
|
7126
7345
|
export interface Illustration extends IllustrationIllustrationOneOf {
|
|
7127
7346
|
/**
|
|
7128
7347
|
* Custom exported component ID to be rendered as an illustration.
|
|
@@ -7146,7 +7365,7 @@ export interface PlanDuration {
|
|
|
7146
7365
|
/** Amount of a duration `unit` in a single payment cycle. */
|
|
7147
7366
|
count?: number;
|
|
7148
7367
|
/** Unit of time for the cycle duration. */
|
|
7149
|
-
unit?:
|
|
7368
|
+
unit?: PlanPeriodUnitWithLiterals;
|
|
7150
7369
|
}
|
|
7151
7370
|
/** Pedefined basic time unit. */
|
|
7152
7371
|
export declare enum PlanPeriodUnit {
|
|
@@ -7155,6 +7374,8 @@ export declare enum PlanPeriodUnit {
|
|
|
7155
7374
|
MONTH = "MONTH",
|
|
7156
7375
|
YEAR = "YEAR"
|
|
7157
7376
|
}
|
|
7377
|
+
/** @enumType */
|
|
7378
|
+
export type PlanPeriodUnitWithLiterals = PlanPeriodUnit | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
7158
7379
|
export interface PlanPriceData {
|
|
7159
7380
|
/** Monetary amount. Decimal string with a period as a decimal separator. For example, `3.99`. */
|
|
7160
7381
|
value?: string;
|
|
@@ -7277,7 +7498,7 @@ export interface PlanFormPricingAndDurationSection {
|
|
|
7277
7498
|
* Order in which pricing options should be displayed.
|
|
7278
7499
|
* @maxSize 99
|
|
7279
7500
|
*/
|
|
7280
|
-
pricingOptionOrder?:
|
|
7501
|
+
pricingOptionOrder?: PlanFormPricingOptionWithLiterals[];
|
|
7281
7502
|
}
|
|
7282
7503
|
export interface PlanFormCustomSection {
|
|
7283
7504
|
/**
|
|
@@ -7291,14 +7512,14 @@ export interface PlanFormSection extends PlanFormSectionSectionOneOf {
|
|
|
7291
7512
|
/** Extension component ID. */
|
|
7292
7513
|
componentId?: string;
|
|
7293
7514
|
/** Default section name. */
|
|
7294
|
-
sectionName?:
|
|
7515
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7295
7516
|
}
|
|
7296
7517
|
/** @oneof */
|
|
7297
7518
|
export interface PlanFormSectionSectionOneOf {
|
|
7298
7519
|
/** Extension component ID. */
|
|
7299
7520
|
componentId?: string;
|
|
7300
7521
|
/** Default section name. */
|
|
7301
|
-
sectionName?:
|
|
7522
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7302
7523
|
}
|
|
7303
7524
|
export interface PlanFormTypeMetadata {
|
|
7304
7525
|
/** Configuration name. */
|
|
@@ -7365,7 +7586,7 @@ export interface UserNotificationData {
|
|
|
7365
7586
|
/** icon */
|
|
7366
7587
|
icon?: Icon;
|
|
7367
7588
|
/** intent */
|
|
7368
|
-
intent?:
|
|
7589
|
+
intent?: IntentWithLiterals;
|
|
7369
7590
|
/** limiter field */
|
|
7370
7591
|
limiterField?: LimiterField;
|
|
7371
7592
|
/** recipient filter */
|
|
@@ -7379,7 +7600,7 @@ export interface UserNotificationData {
|
|
|
7379
7600
|
/** context */
|
|
7380
7601
|
context?: UserNotificationDataContext;
|
|
7381
7602
|
/** type */
|
|
7382
|
-
type?:
|
|
7603
|
+
type?: UserNotificationDataTypeWithLiterals;
|
|
7383
7604
|
}
|
|
7384
7605
|
export interface TypedDynamicParam {
|
|
7385
7606
|
/**
|
|
@@ -7388,16 +7609,20 @@ export interface TypedDynamicParam {
|
|
|
7388
7609
|
*/
|
|
7389
7610
|
name?: string;
|
|
7390
7611
|
/** dynamic param type */
|
|
7391
|
-
dynamicParamType?:
|
|
7612
|
+
dynamicParamType?: TypedDynamicParamTypeWithLiterals;
|
|
7392
7613
|
}
|
|
7393
7614
|
export declare enum TypedDynamicParamType {
|
|
7394
7615
|
STRING = "STRING",
|
|
7395
7616
|
ARRAY = "ARRAY"
|
|
7396
7617
|
}
|
|
7618
|
+
/** @enumType */
|
|
7619
|
+
export type TypedDynamicParamTypeWithLiterals = TypedDynamicParamType | 'STRING' | 'ARRAY';
|
|
7397
7620
|
export declare enum UserNotificationDataRecipientFilterType {
|
|
7398
7621
|
WIX_USERS = "WIX_USERS",
|
|
7399
7622
|
SITE_CONTRIBUTORS = "SITE_CONTRIBUTORS"
|
|
7400
7623
|
}
|
|
7624
|
+
/** @enumType */
|
|
7625
|
+
export type UserNotificationDataRecipientFilterTypeWithLiterals = UserNotificationDataRecipientFilterType | 'WIX_USERS' | 'SITE_CONTRIBUTORS';
|
|
7401
7626
|
export interface WixUsersData {
|
|
7402
7627
|
/** id */
|
|
7403
7628
|
_id?: TypedDynamicParam;
|
|
@@ -7410,6 +7635,8 @@ export declare enum InitiatorType {
|
|
|
7410
7635
|
WIX_USER = "WIX_USER",
|
|
7411
7636
|
WIX_APP = "WIX_APP"
|
|
7412
7637
|
}
|
|
7638
|
+
/** @enumType */
|
|
7639
|
+
export type InitiatorTypeWithLiterals = InitiatorType | 'WIX_USER' | 'WIX_APP';
|
|
7413
7640
|
export interface WixUserData {
|
|
7414
7641
|
/**
|
|
7415
7642
|
* dynamic param name
|
|
@@ -7458,6 +7685,8 @@ export declare enum Level {
|
|
|
7458
7685
|
ACCOUNT = "ACCOUNT",
|
|
7459
7686
|
SITE = "SITE"
|
|
7460
7687
|
}
|
|
7688
|
+
/** @enumType */
|
|
7689
|
+
export type LevelWithLiterals = Level | 'ACCOUNT' | 'SITE';
|
|
7461
7690
|
export interface OrderValue {
|
|
7462
7691
|
/** can be const/dynamicParamName */
|
|
7463
7692
|
value?: ConstOrDynamicParam;
|
|
@@ -7573,7 +7802,7 @@ export interface Icon extends IconDataOneOf {
|
|
|
7573
7802
|
/** url data */
|
|
7574
7803
|
urlData?: UrlData;
|
|
7575
7804
|
/** icon type */
|
|
7576
|
-
type?:
|
|
7805
|
+
type?: IconTypeWithLiterals;
|
|
7577
7806
|
}
|
|
7578
7807
|
/** @oneof */
|
|
7579
7808
|
export interface IconDataOneOf {
|
|
@@ -7585,6 +7814,8 @@ export declare enum IconType {
|
|
|
7585
7814
|
SPOUT = "SPOUT",
|
|
7586
7815
|
INITIATOR = "INITIATOR"
|
|
7587
7816
|
}
|
|
7817
|
+
/** @enumType */
|
|
7818
|
+
export type IconTypeWithLiterals = IconType | 'URL' | 'SPOUT' | 'INITIATOR';
|
|
7588
7819
|
export interface UrlData {
|
|
7589
7820
|
/**
|
|
7590
7821
|
* actual url
|
|
@@ -7612,7 +7843,7 @@ export interface SharedPlatformMobilePushConfig {
|
|
|
7612
7843
|
/** ttl */
|
|
7613
7844
|
ttl?: number | null;
|
|
7614
7845
|
/** target application */
|
|
7615
|
-
targetApplication?:
|
|
7846
|
+
targetApplication?: MobileApplicationWithLiterals;
|
|
7616
7847
|
}
|
|
7617
7848
|
export declare enum MobileApplication {
|
|
7618
7849
|
UNKNOWN_MOBILE_APPLICATION = "UNKNOWN_MOBILE_APPLICATION",
|
|
@@ -7626,11 +7857,13 @@ export declare enum MobileApplication {
|
|
|
7626
7857
|
WIX_STUDIO = "WIX_STUDIO",
|
|
7627
7858
|
NO_SPECIFIC_TARGET_APP = "NO_SPECIFIC_TARGET_APP"
|
|
7628
7859
|
}
|
|
7860
|
+
/** @enumType */
|
|
7861
|
+
export type MobileApplicationWithLiterals = MobileApplication | 'UNKNOWN_MOBILE_APPLICATION' | 'OWNER' | 'SPACES' | 'DINE' | 'FITNESS' | 'WIX_LIFE' | 'WIX_PARTNERS' | 'BRANDED' | 'WIX_STUDIO' | 'NO_SPECIFIC_TARGET_APP';
|
|
7629
7862
|
export interface AndroidMobilePushConfig {
|
|
7630
7863
|
/** sub group key */
|
|
7631
7864
|
subGroupKey?: string | null;
|
|
7632
7865
|
/** style */
|
|
7633
|
-
style?:
|
|
7866
|
+
style?: AndroidStyleWithLiterals;
|
|
7634
7867
|
/** grouped deeplink pattern */
|
|
7635
7868
|
groupedDeeplinkPattern?: string | null;
|
|
7636
7869
|
}
|
|
@@ -7639,6 +7872,8 @@ export declare enum AndroidStyle {
|
|
|
7639
7872
|
MESSAGING = "MESSAGING",
|
|
7640
7873
|
INBOX = "INBOX"
|
|
7641
7874
|
}
|
|
7875
|
+
/** @enumType */
|
|
7876
|
+
export type AndroidStyleWithLiterals = AndroidStyle | 'BIG_TEXT' | 'MESSAGING' | 'INBOX';
|
|
7642
7877
|
export interface MobilePushChannelConfig {
|
|
7643
7878
|
/** shared */
|
|
7644
7879
|
shared?: SharedPlatformMobilePushConfig;
|
|
@@ -7663,7 +7898,7 @@ export interface ExposureRule extends ExposureRuleRuleOneOf {
|
|
|
7663
7898
|
/** custom experiment exposure rule */
|
|
7664
7899
|
customExperimentExposureRule?: CustomExperimentExposureRule;
|
|
7665
7900
|
/** type */
|
|
7666
|
-
type?:
|
|
7901
|
+
type?: ExposureRuleTypeWithLiterals;
|
|
7667
7902
|
}
|
|
7668
7903
|
/** @oneof */
|
|
7669
7904
|
export interface ExposureRuleRuleOneOf {
|
|
@@ -7678,6 +7913,8 @@ export declare enum ExposureRuleType {
|
|
|
7678
7913
|
BOOLEAN_EXPERIMENT = "BOOLEAN_EXPERIMENT",
|
|
7679
7914
|
CUSTOM_EXPERIMENT = "CUSTOM_EXPERIMENT"
|
|
7680
7915
|
}
|
|
7916
|
+
/** @enumType */
|
|
7917
|
+
export type ExposureRuleTypeWithLiterals = ExposureRuleType | 'OPEN_TO_ALL' | 'OPEN_TO_NONE' | 'BOOLEAN_EXPERIMENT' | 'CUSTOM_EXPERIMENT';
|
|
7681
7918
|
export interface BooleanExperimentExposureRule {
|
|
7682
7919
|
/** spec */
|
|
7683
7920
|
spec?: string;
|
|
@@ -7738,6 +7975,8 @@ export declare enum Intent {
|
|
|
7738
7975
|
MARKETING = "MARKETING",
|
|
7739
7976
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
7740
7977
|
}
|
|
7978
|
+
/** @enumType */
|
|
7979
|
+
export type IntentWithLiterals = Intent | 'MARKETING' | 'TRANSACTIONAL';
|
|
7741
7980
|
export interface LimiterField {
|
|
7742
7981
|
/** dynamic param name */
|
|
7743
7982
|
dynamicParamName?: string;
|
|
@@ -7748,7 +7987,7 @@ export interface UserNotificationDataRecipientFilter extends UserNotificationDat
|
|
|
7748
7987
|
/** site contributors data */
|
|
7749
7988
|
siteContributorsData?: SiteContributorsData;
|
|
7750
7989
|
/** recipient filter type */
|
|
7751
|
-
type?:
|
|
7990
|
+
type?: UserNotificationDataRecipientFilterTypeWithLiterals;
|
|
7752
7991
|
}
|
|
7753
7992
|
/** @oneof */
|
|
7754
7993
|
export interface UserNotificationDataRecipientFilterDataOneOf {
|
|
@@ -7761,7 +8000,7 @@ export interface UserNotificationDataInitiator extends UserNotificationDataIniti
|
|
|
7761
8000
|
/** wix user data */
|
|
7762
8001
|
wixUserData?: WixUserData;
|
|
7763
8002
|
/** initiator type */
|
|
7764
|
-
type?:
|
|
8003
|
+
type?: InitiatorTypeWithLiterals;
|
|
7765
8004
|
}
|
|
7766
8005
|
/** @oneof */
|
|
7767
8006
|
export interface UserNotificationDataInitiatorDataOneOf {
|
|
@@ -7778,7 +8017,7 @@ export interface UserNotificationDataDeeplinkOfOneOf {
|
|
|
7778
8017
|
url?: Url;
|
|
7779
8018
|
}
|
|
7780
8019
|
export interface UserNotificationDataContext {
|
|
7781
|
-
level?:
|
|
8020
|
+
level?: LevelWithLiterals;
|
|
7782
8021
|
/** params */
|
|
7783
8022
|
params?: Record<string, OrderValue>;
|
|
7784
8023
|
}
|
|
@@ -7787,6 +8026,8 @@ export declare enum UserNotificationDataType {
|
|
|
7787
8026
|
ALERT_WARNING = "ALERT_WARNING",
|
|
7788
8027
|
ALERT_INFO = "ALERT_INFO"
|
|
7789
8028
|
}
|
|
8029
|
+
/** @enumType */
|
|
8030
|
+
export type UserNotificationDataTypeWithLiterals = UserNotificationDataType | 'REGULAR' | 'ALERT_WARNING' | 'ALERT_INFO';
|
|
7790
8031
|
/** Describes contact notifications */
|
|
7791
8032
|
export interface ContactNotification {
|
|
7792
8033
|
/** @format GUID */
|
|
@@ -7827,6 +8068,8 @@ export declare enum RecipientFilterType {
|
|
|
7827
8068
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
7828
8069
|
CONTACTS = "CONTACTS"
|
|
7829
8070
|
}
|
|
8071
|
+
/** @enumType */
|
|
8072
|
+
export type RecipientFilterTypeWithLiterals = RecipientFilterType | 'UNKNOWN_TYPE' | 'CONTACTS';
|
|
7830
8073
|
export interface ContactsData {
|
|
7831
8074
|
/** id */
|
|
7832
8075
|
_id?: TypedDynamicParam;
|
|
@@ -7836,6 +8079,8 @@ export declare enum Type {
|
|
|
7836
8079
|
CONTACT = "CONTACT",
|
|
7837
8080
|
SITE_MEMBER = "SITE_MEMBER"
|
|
7838
8081
|
}
|
|
8082
|
+
/** @enumType */
|
|
8083
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'CONTACT' | 'SITE_MEMBER';
|
|
7839
8084
|
export interface ContactData {
|
|
7840
8085
|
/**
|
|
7841
8086
|
* dynamic param name
|
|
@@ -7866,7 +8111,7 @@ export interface RecipientFilter extends RecipientFilterDataOneOf {
|
|
|
7866
8111
|
/** contacts data */
|
|
7867
8112
|
contactsData?: ContactsData;
|
|
7868
8113
|
/** recipient filter type */
|
|
7869
|
-
type?:
|
|
8114
|
+
type?: RecipientFilterTypeWithLiterals;
|
|
7870
8115
|
}
|
|
7871
8116
|
/** @oneof */
|
|
7872
8117
|
export interface RecipientFilterDataOneOf {
|
|
@@ -7879,7 +8124,7 @@ export interface Initiator extends InitiatorDataOneOf {
|
|
|
7879
8124
|
/** site member data */
|
|
7880
8125
|
siteMemberData?: SiteMemberData;
|
|
7881
8126
|
/** initiator type */
|
|
7882
|
-
type?:
|
|
8127
|
+
type?: TypeWithLiterals;
|
|
7883
8128
|
}
|
|
7884
8129
|
/** @oneof */
|
|
7885
8130
|
export interface InitiatorDataOneOf {
|
|
@@ -7997,7 +8242,7 @@ export interface CommentsContextProviderConfig {
|
|
|
7997
8242
|
/** URI where the SPI Implementer is deployed */
|
|
7998
8243
|
baseUri?: SpiBaseUri;
|
|
7999
8244
|
/** Comments Environment */
|
|
8000
|
-
environment?:
|
|
8245
|
+
environment?: EnvironmentWithLiterals;
|
|
8001
8246
|
/** Feature toggle to indicate if method GetCommentContextResources is implemented */
|
|
8002
8247
|
toggleResourceProviderEnabled?: boolean;
|
|
8003
8248
|
}
|
|
@@ -8005,6 +8250,8 @@ export declare enum Environment {
|
|
|
8005
8250
|
LIVE_SITE = "LIVE_SITE",
|
|
8006
8251
|
BUSINESS_MANAGER = "BUSINESS_MANAGER"
|
|
8007
8252
|
}
|
|
8253
|
+
/** @enumType */
|
|
8254
|
+
export type EnvironmentWithLiterals = Environment | 'LIVE_SITE' | 'BUSINESS_MANAGER';
|
|
8008
8255
|
export interface FormSpamSubmissionReportSpiConfig {
|
|
8009
8256
|
/** URI where the SPI Implementer is deployed */
|
|
8010
8257
|
baseUri?: SpiBaseUri;
|
|
@@ -8226,7 +8473,7 @@ export interface SchemaKey {
|
|
|
8226
8473
|
* + `SITE`: A custom schema for a specific site.
|
|
8227
8474
|
* @immutable
|
|
8228
8475
|
*/
|
|
8229
|
-
scope?:
|
|
8476
|
+
scope?: SchemaScopeWithLiterals;
|
|
8230
8477
|
}
|
|
8231
8478
|
export declare enum SchemaScope {
|
|
8232
8479
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
@@ -8235,6 +8482,8 @@ export declare enum SchemaScope {
|
|
|
8235
8482
|
/** Custom schema for a specific site. */
|
|
8236
8483
|
SITE = "SITE"
|
|
8237
8484
|
}
|
|
8485
|
+
/** @enumType */
|
|
8486
|
+
export type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
|
|
8238
8487
|
export interface V1SchemaField {
|
|
8239
8488
|
/**
|
|
8240
8489
|
* Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
|
|
@@ -8244,7 +8493,7 @@ export interface V1SchemaField {
|
|
|
8244
8493
|
*/
|
|
8245
8494
|
_id?: string;
|
|
8246
8495
|
/** **Required.** Field type. */
|
|
8247
|
-
type?:
|
|
8496
|
+
type?: SchemaFieldFieldTypeWithLiterals;
|
|
8248
8497
|
/**
|
|
8249
8498
|
* Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager).
|
|
8250
8499
|
* @maxLength 1000
|
|
@@ -8298,6 +8547,8 @@ export declare enum SchemaFieldFieldType {
|
|
|
8298
8547
|
/** Wix Media Manager document. */
|
|
8299
8548
|
DOCUMENT = "DOCUMENT"
|
|
8300
8549
|
}
|
|
8550
|
+
/** @enumType */
|
|
8551
|
+
export type SchemaFieldFieldTypeWithLiterals = SchemaFieldFieldType | 'UNDEFINED_TYPE' | 'SHORT_TEXT' | 'LONG_TEXT' | 'HTML' | 'RICH_CONTENT' | 'IMAGE' | 'IMAGE_LINK' | 'VIDEO' | 'DOCUMENT';
|
|
8301
8552
|
export interface PreviewFields {
|
|
8302
8553
|
/**
|
|
8303
8554
|
* ID of the field representing the schema's title.
|
|
@@ -8369,7 +8620,7 @@ export interface BackOfficeModal extends BackOfficeModalContentOneOf {
|
|
|
8369
8620
|
*
|
|
8370
8621
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8371
8622
|
*/
|
|
8372
|
-
hostingPlatform?:
|
|
8623
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8373
8624
|
/**
|
|
8374
8625
|
* Modal title.
|
|
8375
8626
|
* @minLength 1
|
|
@@ -8456,7 +8707,7 @@ export interface WidgetData {
|
|
|
8456
8707
|
*/
|
|
8457
8708
|
tagName?: string;
|
|
8458
8709
|
/** Type of JavaScript modularization approach used in the custom element */
|
|
8459
|
-
scriptType?:
|
|
8710
|
+
scriptType?: CustomElementScriptTypeWithLiterals;
|
|
8460
8711
|
}
|
|
8461
8712
|
export declare enum CustomElementScriptType {
|
|
8462
8713
|
NONE = "NONE",
|
|
@@ -8465,6 +8716,8 @@ export declare enum CustomElementScriptType {
|
|
|
8465
8716
|
/** ES Module modularization approach */
|
|
8466
8717
|
ES_MODULE = "ES_MODULE"
|
|
8467
8718
|
}
|
|
8719
|
+
/** @enumType */
|
|
8720
|
+
export type CustomElementScriptTypeWithLiterals = CustomElementScriptType | 'NONE' | 'COMMON_JS' | 'ES_MODULE';
|
|
8468
8721
|
export interface EditorBehaviors {
|
|
8469
8722
|
/** The settings behavior definition for the widget */
|
|
8470
8723
|
settings?: SettingsPanel;
|
|
@@ -8498,9 +8751,11 @@ export declare enum HeightMode {
|
|
|
8498
8751
|
/** Height is fixed require size in px */
|
|
8499
8752
|
FIXED = "FIXED"
|
|
8500
8753
|
}
|
|
8754
|
+
/** @enumType */
|
|
8755
|
+
export type HeightModeWithLiterals = HeightMode | 'UNKNOWN' | 'AUTO' | 'FIXED';
|
|
8501
8756
|
export interface WidgetSizeHeight {
|
|
8502
8757
|
/** Height calculation mode */
|
|
8503
|
-
heightMode?:
|
|
8758
|
+
heightMode?: HeightModeWithLiterals;
|
|
8504
8759
|
/**
|
|
8505
8760
|
* Default height in pixels
|
|
8506
8761
|
* @max 9999
|
|
@@ -8568,7 +8823,7 @@ export interface BackOfficeExtensionWidget extends BackOfficeExtensionWidgetAsse
|
|
|
8568
8823
|
*
|
|
8569
8824
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8570
8825
|
*/
|
|
8571
|
-
hostingPlatform?:
|
|
8826
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8572
8827
|
/**
|
|
8573
8828
|
* Slot ID for the plugin's container.
|
|
8574
8829
|
* @format GUID
|
|
@@ -8600,7 +8855,7 @@ export interface BackOfficeExtensionMenuItem {
|
|
|
8600
8855
|
*
|
|
8601
8856
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8602
8857
|
*/
|
|
8603
|
-
hostingPlatform?:
|
|
8858
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8604
8859
|
/**
|
|
8605
8860
|
* Slot ID for the plugin's container.
|
|
8606
8861
|
* @format GUID
|
|
@@ -8704,7 +8959,7 @@ export interface FormTemplate extends FormTemplateTemplateTypeOptionsOneOf {
|
|
|
8704
8959
|
* Specifies the template purpose
|
|
8705
8960
|
* @immutable
|
|
8706
8961
|
*/
|
|
8707
|
-
templateType?:
|
|
8962
|
+
templateType?: TemplateTypeWithLiterals;
|
|
8708
8963
|
/**
|
|
8709
8964
|
* Date of creation.
|
|
8710
8965
|
* @readonly
|
|
@@ -8753,7 +9008,7 @@ export interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
8753
9008
|
* Type of the field
|
|
8754
9009
|
* @readonly
|
|
8755
9010
|
*/
|
|
8756
|
-
fieldType?:
|
|
9011
|
+
fieldType?: FieldTypeWithLiterals;
|
|
8757
9012
|
}
|
|
8758
9013
|
/** @oneof */
|
|
8759
9014
|
export interface FieldFieldTypeOptionsOneOf {
|
|
@@ -8767,6 +9022,8 @@ export declare enum FieldType {
|
|
|
8767
9022
|
INPUT = "INPUT",
|
|
8768
9023
|
DISPLAY = "DISPLAY"
|
|
8769
9024
|
}
|
|
9025
|
+
/** @enumType */
|
|
9026
|
+
export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
|
|
8770
9027
|
export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
8771
9028
|
/** Input return string as value */
|
|
8772
9029
|
stringOptions?: _String;
|
|
@@ -8805,7 +9062,7 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
8805
9062
|
* Type of the input field
|
|
8806
9063
|
* @readonly
|
|
8807
9064
|
*/
|
|
8808
|
-
inputType?:
|
|
9065
|
+
inputType?: InputTypeWithLiterals;
|
|
8809
9066
|
/** Mapping to contacts, telling to what contact property field input value should be saved. */
|
|
8810
9067
|
contactMapping?: FormFieldContactInfo;
|
|
8811
9068
|
/**
|
|
@@ -8860,7 +9117,7 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
8860
9117
|
*/
|
|
8861
9118
|
pattern?: string | null;
|
|
8862
9119
|
/** Format of a string. */
|
|
8863
|
-
format?:
|
|
9120
|
+
format?: FormatWithLiterals;
|
|
8864
9121
|
/**
|
|
8865
9122
|
* List of allowed values.
|
|
8866
9123
|
* @maxSize 500
|
|
@@ -8897,6 +9154,8 @@ export declare enum Format {
|
|
|
8897
9154
|
LANGUAGE = "LANGUAGE",
|
|
8898
9155
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
8899
9156
|
}
|
|
9157
|
+
/** @enumType */
|
|
9158
|
+
export type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
|
|
8900
9159
|
export interface DateTimeConstraints {
|
|
8901
9160
|
/**
|
|
8902
9161
|
* Support static constrains defined as ISO date/time format, as well as
|
|
@@ -8934,6 +9193,8 @@ export declare enum StringComponentType {
|
|
|
8934
9193
|
TIME_INPUT = "TIME_INPUT",
|
|
8935
9194
|
DATE_PICKER = "DATE_PICKER"
|
|
8936
9195
|
}
|
|
9196
|
+
/** @enumType */
|
|
9197
|
+
export type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER';
|
|
8937
9198
|
export interface TextInput {
|
|
8938
9199
|
/**
|
|
8939
9200
|
* Label of the field
|
|
@@ -8983,7 +9244,7 @@ export interface RadioGroup {
|
|
|
8983
9244
|
* Specifies the number of columns used to display the selections within the component.
|
|
8984
9245
|
* Default: ONE
|
|
8985
9246
|
*/
|
|
8986
|
-
numberOfColumns?:
|
|
9247
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
8987
9248
|
}
|
|
8988
9249
|
export interface RadioGroupOption {
|
|
8989
9250
|
/**
|
|
@@ -9029,6 +9290,8 @@ export declare enum NumberOfColumns {
|
|
|
9029
9290
|
/** Three columns. */
|
|
9030
9291
|
THREE = "THREE"
|
|
9031
9292
|
}
|
|
9293
|
+
/** @enumType */
|
|
9294
|
+
export type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
|
|
9032
9295
|
export interface Dropdown {
|
|
9033
9296
|
/**
|
|
9034
9297
|
* Label of the field
|
|
@@ -9218,7 +9481,7 @@ export interface DatePicker {
|
|
|
9218
9481
|
*/
|
|
9219
9482
|
placeholder?: string | null;
|
|
9220
9483
|
/** First day of the week displayed on date picker. */
|
|
9221
|
-
firstDayOfWeek?:
|
|
9484
|
+
firstDayOfWeek?: FirstDayOfWeekWithLiterals;
|
|
9222
9485
|
/**
|
|
9223
9486
|
* Default value for the date picker.
|
|
9224
9487
|
* @format LOCAL_DATE
|
|
@@ -9231,6 +9494,8 @@ export declare enum FirstDayOfWeek {
|
|
|
9231
9494
|
/** First day of the week is Sunday. */
|
|
9232
9495
|
SUNDAY = "SUNDAY"
|
|
9233
9496
|
}
|
|
9497
|
+
/** @enumType */
|
|
9498
|
+
export type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
|
|
9234
9499
|
export interface NumberType {
|
|
9235
9500
|
/** Inclusive maximum value. */
|
|
9236
9501
|
maximum?: number | null;
|
|
@@ -9249,6 +9514,8 @@ export declare enum NumberComponentType {
|
|
|
9249
9514
|
NUMBER_INPUT = "NUMBER_INPUT",
|
|
9250
9515
|
RATING_INPUT = "RATING_INPUT"
|
|
9251
9516
|
}
|
|
9517
|
+
/** @enumType */
|
|
9518
|
+
export type NumberComponentTypeWithLiterals = NumberComponentType | 'UNKNOWN' | 'NUMBER_INPUT' | 'RATING_INPUT';
|
|
9252
9519
|
export interface NumberInput {
|
|
9253
9520
|
/**
|
|
9254
9521
|
* Label of the field
|
|
@@ -9301,6 +9568,8 @@ export declare enum BooleanComponentType {
|
|
|
9301
9568
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9302
9569
|
CHECKBOX = "CHECKBOX"
|
|
9303
9570
|
}
|
|
9571
|
+
/** @enumType */
|
|
9572
|
+
export type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
|
|
9304
9573
|
export interface Checkbox {
|
|
9305
9574
|
/** Label of the field */
|
|
9306
9575
|
label?: RichContent;
|
|
@@ -9332,6 +9601,8 @@ export declare enum ItemType {
|
|
|
9332
9601
|
INTEGER = "INTEGER",
|
|
9333
9602
|
OBJECT = "OBJECT"
|
|
9334
9603
|
}
|
|
9604
|
+
/** @enumType */
|
|
9605
|
+
export type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'OBJECT';
|
|
9335
9606
|
export interface IntegerType {
|
|
9336
9607
|
/** Maximum value. */
|
|
9337
9608
|
maximum?: number | null;
|
|
@@ -9357,6 +9628,8 @@ export declare enum PropertiesTypeEnum {
|
|
|
9357
9628
|
INTEGER = "INTEGER",
|
|
9358
9629
|
ARRAY = "ARRAY"
|
|
9359
9630
|
}
|
|
9631
|
+
/** @enumType */
|
|
9632
|
+
export type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'ARRAY';
|
|
9360
9633
|
export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
|
|
9361
9634
|
/** String type validation for property. */
|
|
9362
9635
|
stringOptions?: StringType;
|
|
@@ -9372,7 +9645,7 @@ export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf
|
|
|
9372
9645
|
* Type of object properties
|
|
9373
9646
|
* @readonly
|
|
9374
9647
|
*/
|
|
9375
|
-
propertiesType?:
|
|
9648
|
+
propertiesType?: PropertiesTypeEnumWithLiterals;
|
|
9376
9649
|
/** Whether the property is required. */
|
|
9377
9650
|
required?: boolean;
|
|
9378
9651
|
}
|
|
@@ -9404,7 +9677,7 @@ export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsO
|
|
|
9404
9677
|
* Type of array items
|
|
9405
9678
|
* @readonly
|
|
9406
9679
|
*/
|
|
9407
|
-
itemType?:
|
|
9680
|
+
itemType?: ItemTypeWithLiterals;
|
|
9408
9681
|
}
|
|
9409
9682
|
/** @oneof */
|
|
9410
9683
|
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -9423,6 +9696,8 @@ export declare enum ArrayComponentType {
|
|
|
9423
9696
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9424
9697
|
CHECKBOX_GROUP = "CHECKBOX_GROUP"
|
|
9425
9698
|
}
|
|
9699
|
+
/** @enumType */
|
|
9700
|
+
export type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP';
|
|
9426
9701
|
export interface CheckboxGroup {
|
|
9427
9702
|
/**
|
|
9428
9703
|
* Label of the field
|
|
@@ -9447,7 +9722,7 @@ export interface CheckboxGroup {
|
|
|
9447
9722
|
* Specifies the number of columns used to display the selections within the component.
|
|
9448
9723
|
* Default: ONE
|
|
9449
9724
|
*/
|
|
9450
|
-
numberOfColumns?:
|
|
9725
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9451
9726
|
}
|
|
9452
9727
|
export interface MediaItem extends MediaItemMediaOneOf {
|
|
9453
9728
|
/** WixMedia image. */
|
|
@@ -9527,6 +9802,8 @@ export declare enum WixFileComponentType {
|
|
|
9527
9802
|
FILE_UPLOAD = "FILE_UPLOAD",
|
|
9528
9803
|
SIGNATURE = "SIGNATURE"
|
|
9529
9804
|
}
|
|
9805
|
+
/** @enumType */
|
|
9806
|
+
export type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
|
|
9530
9807
|
export interface FileUpload {
|
|
9531
9808
|
/**
|
|
9532
9809
|
* Selectable option label
|
|
@@ -9555,7 +9832,7 @@ export interface FileUpload {
|
|
|
9555
9832
|
* Supported file formats for upload
|
|
9556
9833
|
* @maxSize 5
|
|
9557
9834
|
*/
|
|
9558
|
-
uploadFileFormats?:
|
|
9835
|
+
uploadFileFormats?: UploadFileFormatWithLiterals[];
|
|
9559
9836
|
/**
|
|
9560
9837
|
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
9561
9838
|
* @maxLength 255
|
|
@@ -9576,6 +9853,8 @@ export declare enum UploadFileFormat {
|
|
|
9576
9853
|
/** Archive files. */
|
|
9577
9854
|
ARCHIVE = "ARCHIVE"
|
|
9578
9855
|
}
|
|
9856
|
+
/** @enumType */
|
|
9857
|
+
export type UploadFileFormatWithLiterals = UploadFileFormat | 'UNDEFINED' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
|
|
9579
9858
|
export interface Signature {
|
|
9580
9859
|
/**
|
|
9581
9860
|
* Selectable option label
|
|
@@ -9597,6 +9876,8 @@ export declare enum PaymentComponentType {
|
|
|
9597
9876
|
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
9598
9877
|
DONATION_INPUT = "DONATION_INPUT"
|
|
9599
9878
|
}
|
|
9879
|
+
/** @enumType */
|
|
9880
|
+
export type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT';
|
|
9600
9881
|
export interface PaymentType {
|
|
9601
9882
|
/**
|
|
9602
9883
|
* Field mapped to products.
|
|
@@ -9622,6 +9903,8 @@ export declare enum ProductType {
|
|
|
9622
9903
|
/** Digital. */
|
|
9623
9904
|
DIGITAL = "DIGITAL"
|
|
9624
9905
|
}
|
|
9906
|
+
/** @enumType */
|
|
9907
|
+
export type ProductTypeWithLiterals = ProductType | 'UNKNOWN' | 'SHIPPABLE' | 'DIGITAL';
|
|
9625
9908
|
export declare enum PriceType {
|
|
9626
9909
|
UNKNOWN = "UNKNOWN",
|
|
9627
9910
|
/** Fixed price. */
|
|
@@ -9629,6 +9912,8 @@ export declare enum PriceType {
|
|
|
9629
9912
|
/** Dynamic price from price range. */
|
|
9630
9913
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
9631
9914
|
}
|
|
9915
|
+
/** @enumType */
|
|
9916
|
+
export type PriceTypeWithLiterals = PriceType | 'UNKNOWN' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
|
|
9632
9917
|
export interface QuantityLimit {
|
|
9633
9918
|
/**
|
|
9634
9919
|
* Minimum quantity.
|
|
@@ -9674,9 +9959,9 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
9674
9959
|
*/
|
|
9675
9960
|
_id?: string;
|
|
9676
9961
|
/** Product type. */
|
|
9677
|
-
productType?:
|
|
9962
|
+
productType?: ProductTypeWithLiterals;
|
|
9678
9963
|
/** Price type. */
|
|
9679
|
-
priceType?:
|
|
9964
|
+
priceType?: PriceTypeWithLiterals;
|
|
9680
9965
|
/** Quantity limit. */
|
|
9681
9966
|
quantityLimit?: QuantityLimit;
|
|
9682
9967
|
}
|
|
@@ -9709,7 +9994,7 @@ export interface ProductCheckboxGroup {
|
|
|
9709
9994
|
* Defines how an image should be resized to fit within its option.
|
|
9710
9995
|
* Default: COVER
|
|
9711
9996
|
*/
|
|
9712
|
-
imageFit?:
|
|
9997
|
+
imageFit?: ImageFitWithLiterals;
|
|
9713
9998
|
}
|
|
9714
9999
|
export interface ProductCheckboxGroupOption {
|
|
9715
10000
|
/**
|
|
@@ -9737,6 +10022,8 @@ export declare enum ImageFit {
|
|
|
9737
10022
|
/** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
|
|
9738
10023
|
CONTAIN = "CONTAIN"
|
|
9739
10024
|
}
|
|
10025
|
+
/** @enumType */
|
|
10026
|
+
export type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
|
|
9740
10027
|
export interface DonationInput {
|
|
9741
10028
|
/**
|
|
9742
10029
|
* Label of the field.
|
|
@@ -9756,7 +10043,7 @@ export interface DonationInput {
|
|
|
9756
10043
|
* Specifies the number of columns used to display the selections within the component.
|
|
9757
10044
|
* Default: ONE
|
|
9758
10045
|
*/
|
|
9759
|
-
numberOfColumns?:
|
|
10046
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9760
10047
|
/**
|
|
9761
10048
|
* Flag identifying to hide or not label
|
|
9762
10049
|
* Default: true
|
|
@@ -9788,6 +10075,8 @@ export declare enum MultilineAddressComponentType {
|
|
|
9788
10075
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9789
10076
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9790
10077
|
}
|
|
10078
|
+
/** @enumType */
|
|
10079
|
+
export type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
|
|
9791
10080
|
export interface MultilineAddressValidation {
|
|
9792
10081
|
/**
|
|
9793
10082
|
* Allowed countries. No countries treated as all.
|
|
@@ -9845,6 +10134,8 @@ export declare enum DefaultCountryConfigType {
|
|
|
9845
10134
|
/** Pre-selected default country. */
|
|
9846
10135
|
COUNTRY = "COUNTRY"
|
|
9847
10136
|
}
|
|
10137
|
+
/** @enumType */
|
|
10138
|
+
export type DefaultCountryConfigTypeWithLiterals = DefaultCountryConfigType | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
|
|
9848
10139
|
export interface AddressLine2 {
|
|
9849
10140
|
/** Show address line 2 field. */
|
|
9850
10141
|
show?: boolean;
|
|
@@ -9856,7 +10147,7 @@ export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
|
9856
10147
|
*/
|
|
9857
10148
|
countryOptions?: string;
|
|
9858
10149
|
/** Default country type. */
|
|
9859
|
-
type?:
|
|
10150
|
+
type?: DefaultCountryConfigTypeWithLiterals;
|
|
9860
10151
|
}
|
|
9861
10152
|
/** @oneof */
|
|
9862
10153
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
@@ -9881,6 +10172,8 @@ export declare enum InputType {
|
|
|
9881
10172
|
PAYMENT = "PAYMENT",
|
|
9882
10173
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9883
10174
|
}
|
|
10175
|
+
/** @enumType */
|
|
10176
|
+
export type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS';
|
|
9884
10177
|
export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
|
|
9885
10178
|
/** Email info. */
|
|
9886
10179
|
emailInfo?: EmailInfo;
|
|
@@ -9893,7 +10186,7 @@ export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfo
|
|
|
9893
10186
|
/** Subscription info */
|
|
9894
10187
|
subscriptionInfo?: SubscriptionInfo;
|
|
9895
10188
|
/** Field mapped to contacts. */
|
|
9896
|
-
contactField?:
|
|
10189
|
+
contactField?: ContactFieldWithLiterals;
|
|
9897
10190
|
}
|
|
9898
10191
|
/** @oneof */
|
|
9899
10192
|
export interface FormFieldContactInfoAdditionalInfoOneOf {
|
|
@@ -9912,19 +10205,27 @@ export declare enum EmailInfoTag {
|
|
|
9912
10205
|
UNTAGGED = "UNTAGGED",
|
|
9913
10206
|
MAIN = "MAIN"
|
|
9914
10207
|
}
|
|
10208
|
+
/** @enumType */
|
|
10209
|
+
export type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9915
10210
|
export declare enum PhoneInfoTag {
|
|
9916
10211
|
UNTAGGED = "UNTAGGED",
|
|
9917
10212
|
MAIN = "MAIN"
|
|
9918
10213
|
}
|
|
10214
|
+
/** @enumType */
|
|
10215
|
+
export type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9919
10216
|
export declare enum AddressInfoTag {
|
|
9920
10217
|
UNTAGGED = "UNTAGGED",
|
|
9921
10218
|
HOME = "HOME"
|
|
9922
10219
|
}
|
|
10220
|
+
/** @enumType */
|
|
10221
|
+
export type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
|
|
9923
10222
|
export declare enum ConfirmationLevel {
|
|
9924
10223
|
UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
|
|
9925
10224
|
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
9926
10225
|
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
9927
10226
|
}
|
|
10227
|
+
/** @enumType */
|
|
10228
|
+
export type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
|
|
9928
10229
|
export declare enum ContactField {
|
|
9929
10230
|
UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
|
|
9930
10231
|
FIRST_NAME = "FIRST_NAME",
|
|
@@ -9939,17 +10240,19 @@ export declare enum ContactField {
|
|
|
9939
10240
|
SUBSCRIPTION = "SUBSCRIPTION",
|
|
9940
10241
|
VAT_ID = "VAT_ID"
|
|
9941
10242
|
}
|
|
10243
|
+
/** @enumType */
|
|
10244
|
+
export type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
|
|
9942
10245
|
export interface EmailInfo {
|
|
9943
10246
|
/** Email tag. */
|
|
9944
|
-
tag?:
|
|
10247
|
+
tag?: EmailInfoTagWithLiterals;
|
|
9945
10248
|
}
|
|
9946
10249
|
export interface PhoneInfo {
|
|
9947
10250
|
/** Phone tag. */
|
|
9948
|
-
tag?:
|
|
10251
|
+
tag?: PhoneInfoTagWithLiterals;
|
|
9949
10252
|
}
|
|
9950
10253
|
export interface AddressInfo {
|
|
9951
10254
|
/** Address tag. */
|
|
9952
|
-
tag?:
|
|
10255
|
+
tag?: AddressInfoTagWithLiterals;
|
|
9953
10256
|
}
|
|
9954
10257
|
export interface CustomFieldInfo {
|
|
9955
10258
|
/**
|
|
@@ -9964,7 +10267,7 @@ export interface SubscriptionInfo {
|
|
|
9964
10267
|
* Subscription consent opt in level, either single or double confirmation.
|
|
9965
10268
|
* Default: SINGLE_CONFIRMATION
|
|
9966
10269
|
*/
|
|
9967
|
-
confirmationLevel?:
|
|
10270
|
+
confirmationLevel?: ConfirmationLevelWithLiterals;
|
|
9968
10271
|
}
|
|
9969
10272
|
export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
9970
10273
|
/** Text input field */
|
|
@@ -9989,7 +10292,7 @@ export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
|
9989
10292
|
* Component type of the string input field
|
|
9990
10293
|
* @readonly
|
|
9991
10294
|
*/
|
|
9992
|
-
componentType?:
|
|
10295
|
+
componentType?: StringComponentTypeWithLiterals;
|
|
9993
10296
|
}
|
|
9994
10297
|
/** @oneof */
|
|
9995
10298
|
export interface _StringComponentTypeOptionsOneOf {
|
|
@@ -10021,7 +10324,7 @@ export interface InputField_Number extends InputField_NumberComponentTypeOptions
|
|
|
10021
10324
|
* Component type of the number input field
|
|
10022
10325
|
* @readonly
|
|
10023
10326
|
*/
|
|
10024
|
-
componentType?:
|
|
10327
|
+
componentType?: NumberComponentTypeWithLiterals;
|
|
10025
10328
|
}
|
|
10026
10329
|
/** @oneof */
|
|
10027
10330
|
export interface InputField_NumberComponentTypeOptionsOneOf {
|
|
@@ -10039,7 +10342,7 @@ export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
|
|
|
10039
10342
|
* Component type of the boolean input field
|
|
10040
10343
|
* @readonly
|
|
10041
10344
|
*/
|
|
10042
|
-
componentType?:
|
|
10345
|
+
componentType?: BooleanComponentTypeWithLiterals;
|
|
10043
10346
|
}
|
|
10044
10347
|
/** @oneof */
|
|
10045
10348
|
export interface _BooleanComponentTypeOptionsOneOf {
|
|
@@ -10055,7 +10358,7 @@ export interface _Array extends _ArrayComponentTypeOptionsOneOf {
|
|
|
10055
10358
|
* Component type of the array input field
|
|
10056
10359
|
* @readonly
|
|
10057
10360
|
*/
|
|
10058
|
-
componentType?:
|
|
10361
|
+
componentType?: ArrayComponentTypeWithLiterals;
|
|
10059
10362
|
}
|
|
10060
10363
|
/** @oneof */
|
|
10061
10364
|
export interface _ArrayComponentTypeOptionsOneOf {
|
|
@@ -10075,7 +10378,7 @@ export interface WixFile extends WixFileComponentTypeOptionsOneOf {
|
|
|
10075
10378
|
* Component type of the array input field
|
|
10076
10379
|
* @readonly
|
|
10077
10380
|
*/
|
|
10078
|
-
componentType?:
|
|
10381
|
+
componentType?: WixFileComponentTypeWithLiterals;
|
|
10079
10382
|
}
|
|
10080
10383
|
/** @oneof */
|
|
10081
10384
|
export interface WixFileComponentTypeOptionsOneOf {
|
|
@@ -10093,7 +10396,7 @@ export interface Payment extends PaymentComponentTypeOptionsOneOf {
|
|
|
10093
10396
|
* Component type of the payment input field.
|
|
10094
10397
|
* @readonly
|
|
10095
10398
|
*/
|
|
10096
|
-
componentType?:
|
|
10399
|
+
componentType?: PaymentComponentTypeWithLiterals;
|
|
10097
10400
|
/** Validation of payment type. */
|
|
10098
10401
|
validation?: PaymentType;
|
|
10099
10402
|
}
|
|
@@ -10111,7 +10414,7 @@ export interface MultilineAddress extends MultilineAddressComponentTypeOptionsOn
|
|
|
10111
10414
|
* Component type of the multiline address field.
|
|
10112
10415
|
* @readonly
|
|
10113
10416
|
*/
|
|
10114
|
-
componentType?:
|
|
10417
|
+
componentType?: MultilineAddressComponentTypeWithLiterals;
|
|
10115
10418
|
/** Validation of multiline address field output value. */
|
|
10116
10419
|
validation?: MultilineAddressValidation;
|
|
10117
10420
|
}
|
|
@@ -10125,7 +10428,7 @@ export interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
|
10125
10428
|
richContentOptions?: RichContentOptions;
|
|
10126
10429
|
/** Page navigation component resolving as navigation or submit buttons */
|
|
10127
10430
|
pageNavigationOptions?: PageNavigationOptions;
|
|
10128
|
-
displayFieldType?:
|
|
10431
|
+
displayFieldType?: DisplayFieldTypeWithLiterals;
|
|
10129
10432
|
}
|
|
10130
10433
|
/** @oneof */
|
|
10131
10434
|
export interface DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
@@ -10140,6 +10443,8 @@ export declare enum DisplayFieldType {
|
|
|
10140
10443
|
PAGE_NAVIGATION = "PAGE_NAVIGATION",
|
|
10141
10444
|
LOGIN_BAR = "LOGIN_BAR"
|
|
10142
10445
|
}
|
|
10446
|
+
/** @enumType */
|
|
10447
|
+
export type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
|
|
10143
10448
|
export interface RichContentOptions {
|
|
10144
10449
|
/** Content of the header */
|
|
10145
10450
|
richContent?: RichContent;
|
|
@@ -10281,6 +10586,8 @@ export declare enum ChangeableProperty {
|
|
|
10281
10586
|
/** Allowed values property type. */
|
|
10282
10587
|
ALLOWED_VALUES = "ALLOWED_VALUES"
|
|
10283
10588
|
}
|
|
10589
|
+
/** @enumType */
|
|
10590
|
+
export type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
|
|
10284
10591
|
export interface RequiredOptions {
|
|
10285
10592
|
/** Value of required property */
|
|
10286
10593
|
value?: boolean;
|
|
@@ -10301,6 +10608,8 @@ export declare enum OverrideEntityType {
|
|
|
10301
10608
|
UNKNOWN = "UNKNOWN",
|
|
10302
10609
|
FIELD = "FIELD"
|
|
10303
10610
|
}
|
|
10611
|
+
/** @enumType */
|
|
10612
|
+
export type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
|
|
10304
10613
|
export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
10305
10614
|
/** Required property overrides */
|
|
10306
10615
|
requiredOptions?: RequiredOptions;
|
|
@@ -10315,7 +10624,7 @@ export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
|
10315
10624
|
*/
|
|
10316
10625
|
fieldId?: string;
|
|
10317
10626
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
10318
|
-
propertyType?:
|
|
10627
|
+
propertyType?: ChangeablePropertyWithLiterals;
|
|
10319
10628
|
}
|
|
10320
10629
|
/** @oneof */
|
|
10321
10630
|
export interface FieldOverridePropertyTypeOptionsOneOf {
|
|
@@ -10366,7 +10675,7 @@ export interface V2Condition {
|
|
|
10366
10675
|
*/
|
|
10367
10676
|
fact?: string;
|
|
10368
10677
|
/** The operator to use for comparison. */
|
|
10369
|
-
operator?:
|
|
10678
|
+
operator?: OperatorWithLiterals;
|
|
10370
10679
|
/**
|
|
10371
10680
|
* The value to compare against.
|
|
10372
10681
|
* @maxLength 500
|
|
@@ -10402,6 +10711,8 @@ export declare enum Operator {
|
|
|
10402
10711
|
IS_DATE_NEWER_THAN = "IS_DATE_NEWER_THAN",
|
|
10403
10712
|
IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
|
|
10404
10713
|
}
|
|
10714
|
+
/** @enumType */
|
|
10715
|
+
export type OperatorWithLiterals = Operator | 'UNKNOWN' | 'EQUAL' | 'NOT_EQUAL' | 'EMPTY' | 'NOT_EMPTY' | 'CONTAINS' | 'NOT_CONTAINS' | 'LESS_THAN' | 'LESS_THAN_OR_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUALS' | 'BEFORE' | 'BEFORE_OR_EQUAL' | 'AFTER' | 'AFTER_OR_EQUAL' | 'BETWEEN' | 'ANY' | 'ARRAY_EQUAL' | 'ARRAY_NOT_EQUAL' | 'CHECKED' | 'NOT_CHECKED' | 'IN' | 'NOT_IN' | 'IS_DATE_OLDER_THAN' | 'IS_DATE_OLDER_THAN_OR_EQUAL' | 'IS_DATE_NEWER_THAN' | 'IS_DATE_NEWER_THAN_OR_EQUAL';
|
|
10405
10716
|
export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
10406
10717
|
/** Field override properties. */
|
|
10407
10718
|
fieldOptions?: FieldOverride;
|
|
@@ -10409,7 +10720,7 @@ export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
|
10409
10720
|
* Override entity type.
|
|
10410
10721
|
* @immutable
|
|
10411
10722
|
*/
|
|
10412
|
-
entityType?:
|
|
10723
|
+
entityType?: OverrideEntityTypeWithLiterals;
|
|
10413
10724
|
}
|
|
10414
10725
|
/** @oneof */
|
|
10415
10726
|
export interface FormOverrideEntityTypeOptionsOneOf {
|
|
@@ -10422,7 +10733,7 @@ export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptions
|
|
|
10422
10733
|
/** Options for redirecting to a URL after submission. */
|
|
10423
10734
|
redirectOptions?: RedirectOptions;
|
|
10424
10735
|
/** Action that is triggered after a successful form submission. */
|
|
10425
|
-
submitSuccessAction?:
|
|
10736
|
+
submitSuccessAction?: SubmitSuccessActionWithLiterals;
|
|
10426
10737
|
}
|
|
10427
10738
|
/** @oneof */
|
|
10428
10739
|
export interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
@@ -10438,6 +10749,8 @@ export declare enum Target {
|
|
|
10438
10749
|
/** Open in a new browser tab. */
|
|
10439
10750
|
BLANK = "BLANK"
|
|
10440
10751
|
}
|
|
10752
|
+
/** @enumType */
|
|
10753
|
+
export type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
|
|
10441
10754
|
export declare enum SubmitSuccessAction {
|
|
10442
10755
|
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
10443
10756
|
/** No action will be taken after submission. */
|
|
@@ -10447,6 +10760,8 @@ export declare enum SubmitSuccessAction {
|
|
|
10447
10760
|
/** The user will be redirected to a URL after submission. */
|
|
10448
10761
|
REDIRECT = "REDIRECT"
|
|
10449
10762
|
}
|
|
10763
|
+
/** @enumType */
|
|
10764
|
+
export type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
|
|
10450
10765
|
export interface ThankYouMessageOptions {
|
|
10451
10766
|
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
10452
10767
|
durationInSeconds?: number | null;
|
|
@@ -10460,7 +10775,7 @@ export interface RedirectOptions {
|
|
|
10460
10775
|
*/
|
|
10461
10776
|
redirectUrl?: string | null;
|
|
10462
10777
|
/** How the URL should be opened. */
|
|
10463
|
-
target?:
|
|
10778
|
+
target?: TargetWithLiterals;
|
|
10464
10779
|
}
|
|
10465
10780
|
export declare enum TemplateType {
|
|
10466
10781
|
UNKNOWN = "UNKNOWN",
|
|
@@ -10474,6 +10789,8 @@ export declare enum TemplateType {
|
|
|
10474
10789
|
*/
|
|
10475
10790
|
FORM_INPUT = "FORM_INPUT"
|
|
10476
10791
|
}
|
|
10792
|
+
/** @enumType */
|
|
10793
|
+
export type TemplateTypeWithLiterals = TemplateType | 'UNKNOWN' | 'EXTENDABLE' | 'DEMO' | 'FORM_INPUT';
|
|
10477
10794
|
export interface ExtensionDetails {
|
|
10478
10795
|
/** Allow user to add/remove custom field, not present in template */
|
|
10479
10796
|
addCustomFields?: AddCustomFields;
|
|
@@ -10486,6 +10803,8 @@ export declare enum CustomFieldsType {
|
|
|
10486
10803
|
/** Allow user to add/remove any custom field, not present in template */
|
|
10487
10804
|
ANY = "ANY"
|
|
10488
10805
|
}
|
|
10806
|
+
/** @enumType */
|
|
10807
|
+
export type CustomFieldsTypeWithLiterals = CustomFieldsType | 'ANY';
|
|
10489
10808
|
export declare enum EditableProperties {
|
|
10490
10809
|
UNKNOWN = "UNKNOWN",
|
|
10491
10810
|
/** Change property responsible for field requirement */
|
|
@@ -10506,16 +10825,18 @@ export declare enum EditableProperties {
|
|
|
10506
10825
|
/** Change property responsible for field default value */
|
|
10507
10826
|
DEFAULT_VALUE = "DEFAULT_VALUE"
|
|
10508
10827
|
}
|
|
10828
|
+
/** @enumType */
|
|
10829
|
+
export type EditablePropertiesWithLiterals = EditableProperties | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'LABEL' | 'PLACEHOLDER' | 'DESCRIPTION' | 'INPUT_VALUE_LIMITS' | 'DEFAULT_VALUE';
|
|
10509
10830
|
export interface EditableFields {
|
|
10510
10831
|
/**
|
|
10511
10832
|
* List of editable properties for field
|
|
10512
10833
|
* @maxSize 10
|
|
10513
10834
|
*/
|
|
10514
|
-
properties?:
|
|
10835
|
+
properties?: EditablePropertiesWithLiterals[];
|
|
10515
10836
|
}
|
|
10516
10837
|
export interface AddCustomFields {
|
|
10517
10838
|
/** Field types which can be added */
|
|
10518
|
-
fieldType?:
|
|
10839
|
+
fieldType?: CustomFieldsTypeWithLiterals;
|
|
10519
10840
|
}
|
|
10520
10841
|
export interface OverrideTemplateFields {
|
|
10521
10842
|
/** Editable properties by field id. */
|
|
@@ -10543,9 +10864,9 @@ export interface FieldGroup {
|
|
|
10543
10864
|
}
|
|
10544
10865
|
export interface RequiredIndicatorProperties {
|
|
10545
10866
|
/** Required indicator. */
|
|
10546
|
-
requiredIndicator?:
|
|
10867
|
+
requiredIndicator?: RequiredIndicatorWithLiterals;
|
|
10547
10868
|
/** Required indicator placement. */
|
|
10548
|
-
requiredIndicatorPlacement?:
|
|
10869
|
+
requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
|
|
10549
10870
|
}
|
|
10550
10871
|
export declare enum RequiredIndicator {
|
|
10551
10872
|
/** Unknown required indicator. */
|
|
@@ -10557,6 +10878,8 @@ export declare enum RequiredIndicator {
|
|
|
10557
10878
|
/** None. */
|
|
10558
10879
|
NONE = "NONE"
|
|
10559
10880
|
}
|
|
10881
|
+
/** @enumType */
|
|
10882
|
+
export type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | 'ASTERISK' | 'TEXT' | 'NONE';
|
|
10560
10883
|
export declare enum RequiredIndicatorPlacement {
|
|
10561
10884
|
/** Unknown required indicator placement. */
|
|
10562
10885
|
UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
|
|
@@ -10565,6 +10888,8 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
10565
10888
|
/** Before field title. */
|
|
10566
10889
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
10567
10890
|
}
|
|
10891
|
+
/** @enumType */
|
|
10892
|
+
export type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
|
|
10568
10893
|
/** Describes a setting group of a notification */
|
|
10569
10894
|
export interface NotificationContent {
|
|
10570
10895
|
single?: SingleContent;
|
|
@@ -10620,7 +10945,7 @@ export interface VeloPublishPipelineTaskProviderConfig {
|
|
|
10620
10945
|
* The Velo Task name
|
|
10621
10946
|
* @maxSize 100
|
|
10622
10947
|
*/
|
|
10623
|
-
implementerTasksNames?:
|
|
10948
|
+
implementerTasksNames?: WixCodePublishTaskNameWithLiterals[];
|
|
10624
10949
|
}
|
|
10625
10950
|
export declare enum WixCodePublishTaskName {
|
|
10626
10951
|
/** unknown */
|
|
@@ -10638,6 +10963,8 @@ export declare enum WixCodePublishTaskName {
|
|
|
10638
10963
|
/** code packages dependencies registration */
|
|
10639
10964
|
CODE_PACKAGES_REGISTRATION = "CODE_PACKAGES_REGISTRATION"
|
|
10640
10965
|
}
|
|
10966
|
+
/** @enumType */
|
|
10967
|
+
export type WixCodePublishTaskNameWithLiterals = WixCodePublishTaskName | 'UNKNOWN' | 'USER_CODE_BUNDLE' | 'EXPORTED_FUNCTIONS_ANALYSIS' | 'IMPORTED_NAMESPACES_ANALYSIS' | 'PAGE_DETAILS_ANALYSIS' | 'USER_CODE_VALIDATION' | 'CODE_PACKAGES_REGISTRATION';
|
|
10641
10968
|
export interface FunctionsShopPriceSpiConfig {
|
|
10642
10969
|
/** Uri config */
|
|
10643
10970
|
uriConfig?: SpiBaseUri;
|
|
@@ -10869,7 +11196,7 @@ export interface ChannelChannelConfiguration extends ChannelChannelConfiguration
|
|
|
10869
11196
|
*/
|
|
10870
11197
|
channelKey?: string;
|
|
10871
11198
|
/** The type of the communication channel */
|
|
10872
|
-
type?:
|
|
11199
|
+
type?: ChannelConfigurationChannelTypeWithLiterals;
|
|
10873
11200
|
/** Specific provider branding parameters for the channel */
|
|
10874
11201
|
branding?: ChannelChannelBranding;
|
|
10875
11202
|
}
|
|
@@ -10889,6 +11216,8 @@ export declare enum ChannelConfigurationChannelType {
|
|
|
10889
11216
|
EMAIL = "EMAIL",
|
|
10890
11217
|
SMS = "SMS"
|
|
10891
11218
|
}
|
|
11219
|
+
/** @enumType */
|
|
11220
|
+
export type ChannelConfigurationChannelTypeWithLiterals = ChannelConfigurationChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
10892
11221
|
export interface DmDirectMessageConfig {
|
|
10893
11222
|
/**
|
|
10894
11223
|
* Direct message types accepted by the provider.
|
|
@@ -10896,7 +11225,7 @@ export interface DmDirectMessageConfig {
|
|
|
10896
11225
|
* If the provider supports all message types, this field can be empty.
|
|
10897
11226
|
* @maxSize 100
|
|
10898
11227
|
*/
|
|
10899
|
-
acceptedMessageTypes?:
|
|
11228
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals[];
|
|
10900
11229
|
/** Supported media types (mime types) and sizes */
|
|
10901
11230
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10902
11231
|
/** Defines whether or not sending messages will be available for recipients without contact Id */
|
|
@@ -10917,6 +11246,8 @@ export declare enum AcceptedMessageTypesAcceptedDirectMessageType {
|
|
|
10917
11246
|
FORM = "FORM",
|
|
10918
11247
|
SYSTEM = "SYSTEM"
|
|
10919
11248
|
}
|
|
11249
|
+
/** @enumType */
|
|
11250
|
+
export type AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals = AcceptedMessageTypesAcceptedDirectMessageType | 'UNKNOWN_DIRECT_MESSAGE_TYPE' | 'MEDIA' | 'CARD' | 'MINIMAL' | 'FORM' | 'SYSTEM';
|
|
10920
11251
|
export interface ChannelMediaCapabilities {
|
|
10921
11252
|
/** When marked as true, 'supported_media_types' will be ignored. */
|
|
10922
11253
|
allMediaTypes?: boolean;
|
|
@@ -10943,7 +11274,7 @@ export interface SmsSmsMessageConfig {
|
|
|
10943
11274
|
* @minSize 1
|
|
10944
11275
|
* @maxSize 100
|
|
10945
11276
|
*/
|
|
10946
|
-
acceptedMessageTypes?:
|
|
11277
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals[];
|
|
10947
11278
|
/** Supported media types (mime types) and sizes */
|
|
10948
11279
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10949
11280
|
/** Optional - maximum sms message length in characters, if not given, will be unlimited */
|
|
@@ -10954,6 +11285,8 @@ export declare enum AcceptedMessageTypesAcceptedSmsMessageType {
|
|
|
10954
11285
|
SMS = "SMS",
|
|
10955
11286
|
MMS = "MMS"
|
|
10956
11287
|
}
|
|
11288
|
+
/** @enumType */
|
|
11289
|
+
export type AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals = AcceptedMessageTypesAcceptedSmsMessageType | 'UNKNOWN_SMS_MESSAGE_TYPE' | 'SMS' | 'MMS';
|
|
10957
11290
|
export interface ChannelChannelBranding {
|
|
10958
11291
|
/**
|
|
10959
11292
|
* The name of the channel, e.g. `Facebook` / `SMS`
|
|
@@ -11093,7 +11426,7 @@ export interface FactorConfig {
|
|
|
11093
11426
|
/** the base URI where all the methods are deployed. */
|
|
11094
11427
|
uriConfig?: SpiBaseUri;
|
|
11095
11428
|
/** the type of the factor */
|
|
11096
|
-
factorType?:
|
|
11429
|
+
factorType?: FactorTypeWithLiterals;
|
|
11097
11430
|
/** whether the factor supports verify without enrolling first */
|
|
11098
11431
|
supportsVerifyWithoutEnroll?: boolean;
|
|
11099
11432
|
}
|
|
@@ -11106,6 +11439,8 @@ export declare enum FactorType {
|
|
|
11106
11439
|
TOTP = "TOTP",
|
|
11107
11440
|
PUSH = "PUSH"
|
|
11108
11441
|
}
|
|
11442
|
+
/** @enumType */
|
|
11443
|
+
export type FactorTypeWithLiterals = FactorType | 'UNKNOWN_FACTOR_TYPE' | 'PASSWORD' | 'SMS' | 'CALL' | 'EMAIL' | 'TOTP' | 'PUSH';
|
|
11109
11444
|
export interface DiscountsSPIConfig {
|
|
11110
11445
|
/**
|
|
11111
11446
|
* Base URI where the endpoints are called.
|
|
@@ -11165,7 +11500,7 @@ export interface Monitoring extends MonitoringOptionsOneOf {
|
|
|
11165
11500
|
/** Panorama provider options */
|
|
11166
11501
|
panoramaOptions?: PanoramaOptions;
|
|
11167
11502
|
/** Provider type */
|
|
11168
|
-
type?:
|
|
11503
|
+
type?: MonitoringTypeWithLiterals;
|
|
11169
11504
|
}
|
|
11170
11505
|
/** @oneof */
|
|
11171
11506
|
export interface MonitoringOptionsOneOf {
|
|
@@ -11207,6 +11542,8 @@ export declare enum MonitoringType {
|
|
|
11207
11542
|
SENTRY = "SENTRY",
|
|
11208
11543
|
PANORAMA = "PANORAMA"
|
|
11209
11544
|
}
|
|
11545
|
+
/** @enumType */
|
|
11546
|
+
export type MonitoringTypeWithLiterals = MonitoringType | 'UNKNOWN_PROVIDER' | 'SENTRY' | 'PANORAMA';
|
|
11210
11547
|
export interface PanoramaOptions {
|
|
11211
11548
|
/** Sentry config */
|
|
11212
11549
|
sentry?: SentryOptions;
|
|
@@ -11227,12 +11564,12 @@ export interface PluginConfig {
|
|
|
11227
11564
|
*/
|
|
11228
11565
|
pluginDisplayName?: string;
|
|
11229
11566
|
startingEnforcementDate?: Date | null;
|
|
11230
|
-
importanceLevel?:
|
|
11567
|
+
importanceLevel?: ImportanceLevelWithLiterals;
|
|
11231
11568
|
/** @maxSize 100 */
|
|
11232
11569
|
constraints?: Constraint[];
|
|
11233
11570
|
}
|
|
11234
11571
|
export interface Consequence {
|
|
11235
|
-
escalation?:
|
|
11572
|
+
escalation?: EscalationWithLiterals;
|
|
11236
11573
|
/** days to resolve the violation */
|
|
11237
11574
|
daysToResolve?: number | null;
|
|
11238
11575
|
}
|
|
@@ -11244,11 +11581,15 @@ export declare enum Escalation {
|
|
|
11244
11581
|
/** only shows violation in papi-dashboard */
|
|
11245
11582
|
VISIBILITY = "VISIBILITY"
|
|
11246
11583
|
}
|
|
11584
|
+
/** @enumType */
|
|
11585
|
+
export type EscalationWithLiterals = Escalation | 'BREAK_BUILD' | 'BLOCK_ROLLOUT' | 'BLOCK_FUTURE_ROLLOUT' | 'OPEN_BUG_SLA' | 'VISIBILITY';
|
|
11247
11586
|
export declare enum ImportanceLevel {
|
|
11248
11587
|
LOW = "LOW",
|
|
11249
11588
|
MEDIUM = "MEDIUM",
|
|
11250
11589
|
HIGH = "HIGH"
|
|
11251
11590
|
}
|
|
11591
|
+
/** @enumType */
|
|
11592
|
+
export type ImportanceLevelWithLiterals = ImportanceLevel | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
11252
11593
|
export interface Constraint {
|
|
11253
11594
|
/** @maxLength 1024 */
|
|
11254
11595
|
_id?: string;
|
|
@@ -11373,7 +11714,7 @@ export interface Panel extends PanelSelectedContentTypeOneOf {
|
|
|
11373
11714
|
/** Optional: The size of the panel */
|
|
11374
11715
|
size?: PanelSize;
|
|
11375
11716
|
/** The selected panel content type */
|
|
11376
|
-
contentType?:
|
|
11717
|
+
contentType?: PanelContentTypeWithLiterals;
|
|
11377
11718
|
}
|
|
11378
11719
|
/** @oneof */
|
|
11379
11720
|
export interface PanelSelectedContentTypeOneOf {
|
|
@@ -11390,18 +11731,22 @@ export interface PanelSize {
|
|
|
11390
11731
|
*/
|
|
11391
11732
|
height?: number | null;
|
|
11392
11733
|
/** width of the panel */
|
|
11393
|
-
width?:
|
|
11734
|
+
width?: WidthWithLiterals;
|
|
11394
11735
|
}
|
|
11395
11736
|
export declare enum Width {
|
|
11396
11737
|
SMALL = "SMALL",
|
|
11397
11738
|
MEDIUM = "MEDIUM",
|
|
11398
11739
|
LARGE = "LARGE"
|
|
11399
11740
|
}
|
|
11741
|
+
/** @enumType */
|
|
11742
|
+
export type WidthWithLiterals = Width | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
11400
11743
|
/** Represents the options for panel content types */
|
|
11401
11744
|
export declare enum PanelContentType {
|
|
11402
11745
|
UNKNOWN_PanelContentType = "UNKNOWN_PanelContentType",
|
|
11403
11746
|
url = "url"
|
|
11404
11747
|
}
|
|
11748
|
+
/** @enumType */
|
|
11749
|
+
export type PanelContentTypeWithLiterals = PanelContentType | 'UNKNOWN_PanelContentType' | 'url';
|
|
11405
11750
|
/** Represents the information needed for code panels */
|
|
11406
11751
|
export interface CodePanel {
|
|
11407
11752
|
/**
|
|
@@ -11421,7 +11766,7 @@ export interface PurchaseValidationsConfig {
|
|
|
11421
11766
|
}
|
|
11422
11767
|
export interface BrowserStorage {
|
|
11423
11768
|
/** The type of browser storage used */
|
|
11424
|
-
type?:
|
|
11769
|
+
type?: StorageTypeWithLiterals;
|
|
11425
11770
|
/**
|
|
11426
11771
|
* The name of the storage item in the browser (as can be seen in DEV Console)
|
|
11427
11772
|
* @maxLength 100
|
|
@@ -11439,9 +11784,9 @@ export interface BrowserStorage {
|
|
|
11439
11784
|
* This defines when this storage item is allowed to be used in a visitor session.
|
|
11440
11785
|
* > This is legally important for complying with EU privacy law, so make sure to define this carefully.
|
|
11441
11786
|
*/
|
|
11442
|
-
consentCategory?:
|
|
11787
|
+
consentCategory?: ConsentCategoryWithLiterals;
|
|
11443
11788
|
/** Where this storage item will be set in the browser (User domain or the App domain) */
|
|
11444
|
-
domain?:
|
|
11789
|
+
domain?: StorageDomainWithLiterals;
|
|
11445
11790
|
}
|
|
11446
11791
|
/** The type of storage we are declaring */
|
|
11447
11792
|
export declare enum StorageType {
|
|
@@ -11455,6 +11800,8 @@ export declare enum StorageType {
|
|
|
11455
11800
|
/** An item in [IndexDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) */
|
|
11456
11801
|
INDEXDB = "INDEXDB"
|
|
11457
11802
|
}
|
|
11803
|
+
/** @enumType */
|
|
11804
|
+
export type StorageTypeWithLiterals = StorageType | 'UNKNOWN_STORAGE_TYPE' | 'COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE' | 'INDEXDB';
|
|
11458
11805
|
/** The category for EU and US Privacy Law classification */
|
|
11459
11806
|
export declare enum ConsentCategory {
|
|
11460
11807
|
/** This is an invalid value, you must classify your storage item. */
|
|
@@ -11468,6 +11815,8 @@ export declare enum ConsentCategory {
|
|
|
11468
11815
|
/** Related to advertising, upselling and marketing data collected to be used. */
|
|
11469
11816
|
advertising = "advertising"
|
|
11470
11817
|
}
|
|
11818
|
+
/** @enumType */
|
|
11819
|
+
export type ConsentCategoryWithLiterals = ConsentCategory | 'UNKNOWN_CATEGORY' | 'essential' | 'functional' | 'analytics' | 'advertising';
|
|
11471
11820
|
export declare enum StorageDomain {
|
|
11472
11821
|
UNKNOWN_STORAGE_DOMAIN = "UNKNOWN_STORAGE_DOMAIN",
|
|
11473
11822
|
/** Storing the values in the domain of the website the app is installed on */
|
|
@@ -11477,6 +11826,8 @@ export declare enum StorageDomain {
|
|
|
11477
11826
|
/** Storing the values as 3rd party in the application domain */
|
|
11478
11827
|
APP_DOMAIN = "APP_DOMAIN"
|
|
11479
11828
|
}
|
|
11829
|
+
/** @enumType */
|
|
11830
|
+
export type StorageDomainWithLiterals = StorageDomain | 'UNKNOWN_STORAGE_DOMAIN' | 'SITE_DOMAIN' | 'WIX_DOMAIN' | 'APP_DOMAIN';
|
|
11480
11831
|
/** Describe SDK module definition for an app */
|
|
11481
11832
|
export interface SdkDefinition {
|
|
11482
11833
|
/**
|
|
@@ -11508,7 +11859,7 @@ export interface EventValidationProviderConfig {
|
|
|
11508
11859
|
}
|
|
11509
11860
|
export interface ValidationTarget {
|
|
11510
11861
|
/** The method to validate. */
|
|
11511
|
-
method?:
|
|
11862
|
+
method?: MethodWithLiterals;
|
|
11512
11863
|
/**
|
|
11513
11864
|
* Optional WQL filter applied to the events for validation.
|
|
11514
11865
|
* Only events matching this filter will be validated.
|
|
@@ -11525,6 +11876,8 @@ export declare enum Method {
|
|
|
11525
11876
|
/** Validate an event before cancel. */
|
|
11526
11877
|
CANCEL = "CANCEL"
|
|
11527
11878
|
}
|
|
11879
|
+
/** @enumType */
|
|
11880
|
+
export type MethodWithLiterals = Method | 'CREATE' | 'UPDATE' | 'CANCEL';
|
|
11528
11881
|
/** Client Service is a broad category encompassing any value, function, or feature that an application needs. A service is typically a class with a narrow, well-defined purpose. A component is one type of class that can use DI. */
|
|
11529
11882
|
export interface ClientSideService {
|
|
11530
11883
|
/**
|
|
@@ -11675,7 +12028,7 @@ export interface AudienceProviderConfig {
|
|
|
11675
12028
|
*/
|
|
11676
12029
|
displayName?: string;
|
|
11677
12030
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
11678
|
-
participantType?:
|
|
12031
|
+
participantType?: ParticipantTypeWithLiterals;
|
|
11679
12032
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
11680
12033
|
inputSchema?: Record<string, any> | null;
|
|
11681
12034
|
/**
|
|
@@ -11689,7 +12042,7 @@ export interface AudienceProviderConfig {
|
|
|
11689
12042
|
* Define the scopes which the provider audience is relevant
|
|
11690
12043
|
* @maxSize 10
|
|
11691
12044
|
*/
|
|
11692
|
-
scopes?:
|
|
12045
|
+
scopes?: ScopeWithLiterals[];
|
|
11693
12046
|
}
|
|
11694
12047
|
export declare enum ParticipantType {
|
|
11695
12048
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
@@ -11697,11 +12050,13 @@ export declare enum ParticipantType {
|
|
|
11697
12050
|
CONTACT = "CONTACT",
|
|
11698
12051
|
ANONYMOUS = "ANONYMOUS"
|
|
11699
12052
|
}
|
|
12053
|
+
/** @enumType */
|
|
12054
|
+
export type ParticipantTypeWithLiterals = ParticipantType | 'UNKNOWN_TYPE' | 'WIX_USER' | 'CONTACT' | 'ANONYMOUS';
|
|
11700
12055
|
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
11701
12056
|
/** Should be filled if the provider implements its own custom UI */
|
|
11702
12057
|
widgetComponentConfiguration?: WidgetComponent;
|
|
11703
12058
|
/** Type of interface configuration */
|
|
11704
|
-
type?:
|
|
12059
|
+
type?: InterfaceConfigurationTypeWithLiterals;
|
|
11705
12060
|
}
|
|
11706
12061
|
/** @oneof */
|
|
11707
12062
|
export interface InterfaceConfigurationOfTypeOneOf {
|
|
@@ -11714,6 +12069,8 @@ export declare enum InterfaceConfigurationType {
|
|
|
11714
12069
|
/** Item Selection, in case the provider implemented item selection component */
|
|
11715
12070
|
ITEM_SELECTION = "ITEM_SELECTION"
|
|
11716
12071
|
}
|
|
12072
|
+
/** @enumType */
|
|
12073
|
+
export type InterfaceConfigurationTypeWithLiterals = InterfaceConfigurationType | 'WIDGET_COMPONENT' | 'ITEM_SELECTION';
|
|
11717
12074
|
export interface WidgetComponent {
|
|
11718
12075
|
/**
|
|
11719
12076
|
* widget component id
|
|
@@ -11745,6 +12102,8 @@ export declare enum Scope {
|
|
|
11745
12102
|
/** Provider audience is available only in scope of non specific site */
|
|
11746
12103
|
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
11747
12104
|
}
|
|
12105
|
+
/** @enumType */
|
|
12106
|
+
export type ScopeWithLiterals = Scope | 'SPECIFIC_SITE' | 'NON_SPECIFIC_SITE';
|
|
11748
12107
|
/** Config for the Price SPI */
|
|
11749
12108
|
export interface PriceSPIConfig {
|
|
11750
12109
|
/**
|
|
@@ -11821,7 +12180,7 @@ export interface EditorReactComponent {
|
|
|
11821
12180
|
* @replacedBy editor_element.archetype
|
|
11822
12181
|
* @targetRemovalDate 2026-06-30
|
|
11823
12182
|
*/
|
|
11824
|
-
archetype?:
|
|
12183
|
+
archetype?: ArchetypeWithLiterals;
|
|
11825
12184
|
}
|
|
11826
12185
|
export interface Resources {
|
|
11827
12186
|
/** The bundle we will load and render in the browser */
|
|
@@ -11897,13 +12256,13 @@ export interface EditorElement {
|
|
|
11897
12256
|
/** Layout capabilities of the component */
|
|
11898
12257
|
layout?: EditorElementLayout;
|
|
11899
12258
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
11900
|
-
archetype?:
|
|
12259
|
+
archetype?: ArchetypeWithLiterals;
|
|
11901
12260
|
}
|
|
11902
12261
|
export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSelectedCssPropertyTypeOneOf, StyleItemSelectedCssVariableTypeOneOf {
|
|
11903
12262
|
/** type selection key for css-properties */
|
|
11904
|
-
cssPropertyType?:
|
|
12263
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11905
12264
|
/** type selection key for css-data-types */
|
|
11906
|
-
cssVariableType?:
|
|
12265
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11907
12266
|
/** Additional options to refine the filter variable */
|
|
11908
12267
|
filter?: Filter;
|
|
11909
12268
|
/** Additional options to refine the backdropFilter variable */
|
|
@@ -11927,9 +12286,9 @@ export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSele
|
|
|
11927
12286
|
/** @oneof */
|
|
11928
12287
|
export interface StyleItemSelectedItemTypeOneOf {
|
|
11929
12288
|
/** type selection key for css-properties */
|
|
11930
|
-
cssPropertyType?:
|
|
12289
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11931
12290
|
/** type selection key for css-data-types */
|
|
11932
|
-
cssVariableType?:
|
|
12291
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11933
12292
|
}
|
|
11934
12293
|
/** @oneof */
|
|
11935
12294
|
export interface StyleItemSelectedCssPropertyTypeOneOf {
|
|
@@ -12063,6 +12422,8 @@ export declare enum CssPropertyType {
|
|
|
12063
12422
|
mixBlendMode = "mixBlendMode",
|
|
12064
12423
|
isolation = "isolation"
|
|
12065
12424
|
}
|
|
12425
|
+
/** @enumType */
|
|
12426
|
+
export type CssPropertyTypeWithLiterals = CssPropertyType | 'UNKNOWN_CssPropertyType' | 'background' | 'backgroundSize' | 'backgroundColor' | 'backgroundImage' | 'backgroundClip' | 'backgroundOrigin' | 'backgroundPosition' | 'backgroundRepeat' | 'backgroundAttachment' | 'fill' | 'margin' | 'marginTop' | 'marginRight' | 'marginBottom' | 'marginLeft' | 'marginInlineStart' | 'marginInlineEnd' | 'padding' | 'paddingTop' | 'paddingRight' | 'paddingBottom' | 'paddingLeft' | 'paddingInlineStart' | 'paddingInlineEnd' | 'border' | 'borderWidth' | 'borderStyle' | 'borderColor' | 'borderTop' | 'borderTopColor' | 'borderTopWidth' | 'borderTopStyle' | 'borderRight' | 'borderRightColor' | 'borderRightWidth' | 'borderRightStyle' | 'borderBottom' | 'borderBottomColor' | 'borderBottomWidth' | 'borderBottomStyle' | 'borderLeft' | 'borderLeftColor' | 'borderLeftWidth' | 'borderLeftStyle' | 'borderInlineStart' | 'borderInlineStartColor' | 'borderInlineStartWidth' | 'borderInlineStartStyle' | 'borderInlineEnd' | 'borderInlineEndColor' | 'borderInlineEndWidth' | 'borderInlineEndStyle' | 'borderRadius' | 'borderTopLeftRadius' | 'borderTopRightRadius' | 'borderBottomRightRadius' | 'borderBottomLeftRadius' | 'borderStartStartRadius' | 'borderStartEndRadius' | 'borderEndStartRadius' | 'borderEndEndRadius' | 'font' | 'fontFamily' | 'fontSize' | 'fontStretch' | 'fontStyle' | 'fontVariant' | 'fontWeight' | 'lineHeight' | 'color' | 'letterSpacing' | 'writingMode' | 'textAlign' | 'textTransform' | 'textShadow' | 'textOverflow' | 'textDecoration' | 'textDecorationColor' | 'textDecorationLine' | 'textDecorationStyle' | 'textDecorationThickness' | 'boxShadow' | 'opacity' | 'overflow' | 'display' | 'alignSelf' | 'justifyContent' | 'alignItems' | 'flexDirection' | 'gap' | 'height' | 'width' | 'columnGap' | 'rowGap' | 'filter' | 'backdropFilter' | 'objectFit' | 'objectPosition' | 'mixBlendMode' | 'isolation';
|
|
12066
12427
|
/** The supported [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Types) in Javascript naming format */
|
|
12067
12428
|
export declare enum CssDataType {
|
|
12068
12429
|
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
@@ -12076,12 +12437,14 @@ export declare enum CssDataType {
|
|
|
12076
12437
|
customEnum = "customEnum",
|
|
12077
12438
|
string = "string"
|
|
12078
12439
|
}
|
|
12440
|
+
/** @enumType */
|
|
12441
|
+
export type CssDataTypeWithLiterals = CssDataType | 'UNKNOWN_CssDataType' | 'number' | 'length' | 'color' | 'angle' | 'percentage' | 'lengthPercentage' | 'blendMode' | 'customEnum' | 'string';
|
|
12079
12442
|
export interface Filter {
|
|
12080
12443
|
/**
|
|
12081
12444
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12082
12445
|
* @maxSize 100
|
|
12083
12446
|
*/
|
|
12084
|
-
filterFunctions?:
|
|
12447
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12085
12448
|
}
|
|
12086
12449
|
export declare enum FilterFunction {
|
|
12087
12450
|
UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
|
|
@@ -12106,19 +12469,21 @@ export declare enum FilterFunction {
|
|
|
12106
12469
|
/** The value used for saturate filter */
|
|
12107
12470
|
saturate = "saturate"
|
|
12108
12471
|
}
|
|
12472
|
+
/** @enumType */
|
|
12473
|
+
export type FilterFunctionWithLiterals = FilterFunction | 'UNKNOWN_FilterFunctions' | 'blur' | 'brightness' | 'contrast' | 'drop_shadow' | 'grayscale' | 'hue_rotate' | 'invert' | 'opacity' | 'sepia' | 'saturate';
|
|
12109
12474
|
export interface BackdropFilter {
|
|
12110
12475
|
/**
|
|
12111
12476
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12112
12477
|
* @maxSize 100
|
|
12113
12478
|
*/
|
|
12114
|
-
filterFunctions?:
|
|
12479
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12115
12480
|
}
|
|
12116
12481
|
export interface Display {
|
|
12117
12482
|
/**
|
|
12118
12483
|
* list of display values in case we want to reduce the abilities exposed to the User
|
|
12119
12484
|
* @maxSize 20
|
|
12120
12485
|
*/
|
|
12121
|
-
displayValues?:
|
|
12486
|
+
displayValues?: DisplayValueEnumDisplayValueWithLiterals[];
|
|
12122
12487
|
}
|
|
12123
12488
|
export declare enum DisplayValueEnumDisplayValue {
|
|
12124
12489
|
UNKNOWN_DisplayValue = "UNKNOWN_DisplayValue",
|
|
@@ -12137,12 +12502,14 @@ export declare enum DisplayValueEnumDisplayValue {
|
|
|
12137
12502
|
inline_flex = "inline_flex",
|
|
12138
12503
|
inline_grid = "inline_grid"
|
|
12139
12504
|
}
|
|
12505
|
+
/** @enumType */
|
|
12506
|
+
export type DisplayValueEnumDisplayValueWithLiterals = DisplayValueEnumDisplayValue | 'UNKNOWN_DisplayValue' | 'none' | 'block' | 'inline' | 'flow' | 'flowRoot' | 'table' | 'flex' | 'grid' | 'list_item' | 'contents' | 'inline_block' | 'inline_table' | 'inline_flex' | 'inline_grid';
|
|
12140
12507
|
export interface WritingMode {
|
|
12141
12508
|
/**
|
|
12142
12509
|
* list of writing-mode values in case we want to reduce the abilities exposed to the User
|
|
12143
12510
|
* @maxSize 20
|
|
12144
12511
|
*/
|
|
12145
|
-
writingModeValues?:
|
|
12512
|
+
writingModeValues?: WritingModeValueWithLiterals[];
|
|
12146
12513
|
}
|
|
12147
12514
|
export declare enum WritingModeValue {
|
|
12148
12515
|
UNKNOWN_WritingModeValue = "UNKNOWN_WritingModeValue",
|
|
@@ -12152,9 +12519,11 @@ export declare enum WritingModeValue {
|
|
|
12152
12519
|
sidewaysRl = "sidewaysRl",
|
|
12153
12520
|
sidewaysLr = "sidewaysLr"
|
|
12154
12521
|
}
|
|
12522
|
+
/** @enumType */
|
|
12523
|
+
export type WritingModeValueWithLiterals = WritingModeValue | 'UNKNOWN_WritingModeValue' | 'horizontalTb' | 'verticalRl' | 'verticalLr' | 'sidewaysRl' | 'sidewaysLr';
|
|
12155
12524
|
export interface CustomEnum {
|
|
12156
12525
|
/** the type of enum values */
|
|
12157
|
-
cssVariableType?:
|
|
12526
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
12158
12527
|
/**
|
|
12159
12528
|
* Editor-only: defines allowed values
|
|
12160
12529
|
* @maxSize 100
|
|
@@ -12208,7 +12577,7 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
12208
12577
|
/** A container in which to render another component */
|
|
12209
12578
|
container?: ReactElementContainer;
|
|
12210
12579
|
/** Defines the type of data we are configuring */
|
|
12211
|
-
dataType?:
|
|
12580
|
+
dataType?: DataTypeWithLiterals;
|
|
12212
12581
|
/**
|
|
12213
12582
|
* Display name of this data item
|
|
12214
12583
|
* @maxLength 100
|
|
@@ -12287,16 +12656,25 @@ export declare enum DataType {
|
|
|
12287
12656
|
/** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
|
|
12288
12657
|
direction = "direction"
|
|
12289
12658
|
}
|
|
12659
|
+
/** @enumType */
|
|
12660
|
+
export type DataTypeWithLiterals = DataType | 'UNKNOWN_DataType' | 'text' | 'textEnum' | 'number' | 'booleanValue' | 'a11y' | 'link' | 'image' | 'video' | 'vectorArt' | 'audio' | 'schema' | 'localDate' | 'localTime' | 'localDateTime' | 'webUrl' | 'email' | 'phone' | 'hostname' | 'regex' | 'guid' | 'richText' | 'container' | 'arrayItems' | 'direction';
|
|
12290
12661
|
export interface Text {
|
|
12291
12662
|
/** Indicates maximum length allowed for the text */
|
|
12292
12663
|
maxLength?: number | null;
|
|
12293
12664
|
/** Indicates minimum length required for the text */
|
|
12294
12665
|
minLength?: number | null;
|
|
12295
12666
|
/**
|
|
12296
|
-
* A regex pattern that the text must comply with
|
|
12297
12667
|
* @maxLength 100
|
|
12668
|
+
* @deprecated
|
|
12669
|
+
* @replacedBy pattern
|
|
12670
|
+
* @targetRemovalDate 2026-06-30
|
|
12298
12671
|
*/
|
|
12299
12672
|
regexPattern?: string | null;
|
|
12673
|
+
/**
|
|
12674
|
+
* A regex pattern that the text must comply with
|
|
12675
|
+
* @maxLength 100
|
|
12676
|
+
*/
|
|
12677
|
+
pattern?: string | null;
|
|
12300
12678
|
}
|
|
12301
12679
|
export interface TextEnum {
|
|
12302
12680
|
/**
|
|
@@ -12330,7 +12708,7 @@ export interface A11y {
|
|
|
12330
12708
|
* A collection of attributes that will be stated in the manifest
|
|
12331
12709
|
* @maxSize 100
|
|
12332
12710
|
*/
|
|
12333
|
-
attributes?:
|
|
12711
|
+
attributes?: A11yAttributesWithLiterals[];
|
|
12334
12712
|
}
|
|
12335
12713
|
export declare enum A11yAttributes {
|
|
12336
12714
|
Unknown_AriaAttributes = "Unknown_AriaAttributes",
|
|
@@ -12385,12 +12763,14 @@ export declare enum A11yAttributes {
|
|
|
12385
12763
|
/** The value used for aria-invalid */
|
|
12386
12764
|
ariaInvalid = "ariaInvalid"
|
|
12387
12765
|
}
|
|
12766
|
+
/** @enumType */
|
|
12767
|
+
export type A11yAttributesWithLiterals = A11yAttributes | 'Unknown_AriaAttributes' | 'tabIndex' | 'ariaLevel' | 'ariaExpanded' | 'ariaDisabled' | 'ariaAtomic' | 'ariaHidden' | 'ariaBusy' | 'multiline' | 'ariaAutocomplete' | 'ariaPressed' | 'ariaHaspopup' | 'ariaRelevant' | 'role' | 'ariaLive' | 'ariaCurrent' | 'ariaLabel' | 'ariaRoledescription' | 'ariaDescribedby' | 'ariaLabelledby' | 'ariaErrormessage' | 'ariaOwns' | 'ariaControls' | 'tag' | 'ariaMultiline' | 'ariaInvalid';
|
|
12388
12768
|
export interface Link {
|
|
12389
12769
|
/**
|
|
12390
12770
|
* A collection of possible link types that the component supports. Only one of the types will make it to the component after input.
|
|
12391
12771
|
* @maxSize 12
|
|
12392
12772
|
*/
|
|
12393
|
-
linkTypes?:
|
|
12773
|
+
linkTypes?: LinkTypeWithLiterals[];
|
|
12394
12774
|
}
|
|
12395
12775
|
export declare enum LinkType {
|
|
12396
12776
|
UNKNOWN_LinkType = "UNKNOWN_LinkType",
|
|
@@ -12419,6 +12799,8 @@ export declare enum LinkType {
|
|
|
12419
12799
|
/** A link that directs the user to wix login dialog */
|
|
12420
12800
|
loginToWixLink = "loginToWixLink"
|
|
12421
12801
|
}
|
|
12802
|
+
/** @enumType */
|
|
12803
|
+
export type LinkTypeWithLiterals = LinkType | 'UNKNOWN_LinkType' | 'externalLink' | 'anchorLink' | 'emailLink' | 'phoneLink' | 'dynamicPageLink' | 'pageLink' | 'whatsAppLink' | 'documentLink' | 'popupLink' | 'addressLink' | 'edgeAnchorLinks' | 'loginToWixLink';
|
|
12422
12804
|
/** An array of data items or complex data types */
|
|
12423
12805
|
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
12424
12806
|
/** The definition of multiple data items in each item of the Array */
|
|
@@ -12460,7 +12842,7 @@ export interface ReactElementContainer extends ReactElementContainerSelectedCont
|
|
|
12460
12842
|
*/
|
|
12461
12843
|
selector?: string;
|
|
12462
12844
|
/** The type of Container to be rendered */
|
|
12463
|
-
containerType?:
|
|
12845
|
+
containerType?: ContainerTypeWithLiterals;
|
|
12464
12846
|
}
|
|
12465
12847
|
/** @oneof */
|
|
12466
12848
|
export interface ReactElementContainerSelectedContainerTypeOneOf {
|
|
@@ -12481,6 +12863,8 @@ export declare enum ContainerType {
|
|
|
12481
12863
|
/** A container to add elements targeting a specific product use case, exposed in DEV Center */
|
|
12482
12864
|
placeholder = "placeholder"
|
|
12483
12865
|
}
|
|
12866
|
+
/** @enumType */
|
|
12867
|
+
export type ContainerTypeWithLiterals = ContainerType | 'UNKNOWN_CONTAINER_TYPE' | 'simple' | 'slot' | 'placeholder';
|
|
12484
12868
|
/** Currently doesn't have any properties defined */
|
|
12485
12869
|
export interface SimpleContainer {
|
|
12486
12870
|
}
|
|
@@ -12504,7 +12888,7 @@ export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
|
12504
12888
|
/** A reference to the used element with overrides */
|
|
12505
12889
|
refElement?: RefElement;
|
|
12506
12890
|
/** Defines the type of element we are configuring */
|
|
12507
|
-
elementType?:
|
|
12891
|
+
elementType?: ElementTypeWithLiterals;
|
|
12508
12892
|
}
|
|
12509
12893
|
/** @oneof */
|
|
12510
12894
|
export interface ElementItemSelectedElementTypeOneOf {
|
|
@@ -12520,6 +12904,8 @@ export declare enum ElementType {
|
|
|
12520
12904
|
/** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
|
|
12521
12905
|
refElement = "refElement"
|
|
12522
12906
|
}
|
|
12907
|
+
/** @enumType */
|
|
12908
|
+
export type ElementTypeWithLiterals = ElementType | 'UNKNOWN_ElementType' | 'inlineElement' | 'refElement';
|
|
12523
12909
|
export interface InlineElement {
|
|
12524
12910
|
/**
|
|
12525
12911
|
* Relative DOM Query selector for this element. We assume nesting by it's parent elements for CSS Vars scoping.
|
|
@@ -12550,7 +12936,7 @@ export interface InlineElement {
|
|
|
12550
12936
|
/** The default preset, styles and data of inner elements */
|
|
12551
12937
|
elementsDefaults?: Record<string, ElementDefaults>;
|
|
12552
12938
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
12553
|
-
archetype?:
|
|
12939
|
+
archetype?: ArchetypeWithLiterals;
|
|
12554
12940
|
}
|
|
12555
12941
|
export interface Behaviors {
|
|
12556
12942
|
/** Determines if the inner-element can be selectable in the editor */
|
|
@@ -12595,7 +12981,7 @@ export interface Execution extends ExecutionActionExecuteOneOf {
|
|
|
12595
12981
|
/** Executes an action on a target element (based on path) */
|
|
12596
12982
|
forward?: ForwardAction;
|
|
12597
12983
|
/** The action type allows to determine the return type of the execution function */
|
|
12598
|
-
actionType?:
|
|
12984
|
+
actionType?: ActionTypeWithLiterals;
|
|
12599
12985
|
}
|
|
12600
12986
|
/** @oneof */
|
|
12601
12987
|
export interface ExecutionActionExecuteOneOf {
|
|
@@ -12618,6 +13004,8 @@ export declare enum ActionType {
|
|
|
12618
13004
|
forward = "forward",
|
|
12619
13005
|
style = "style"
|
|
12620
13006
|
}
|
|
13007
|
+
/** @enumType */
|
|
13008
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ActionType' | 'data' | 'event' | 'panel' | 'forward' | 'style';
|
|
12621
13009
|
/** Represents an action that interacts with a specific data item */
|
|
12622
13010
|
export interface DataAction {
|
|
12623
13011
|
/**
|
|
@@ -12653,7 +13041,7 @@ export interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
|
|
|
12653
13041
|
*/
|
|
12654
13042
|
panelId?: string;
|
|
12655
13043
|
/** The selected panel reference type */
|
|
12656
|
-
panelType?:
|
|
13044
|
+
panelType?: PanelTypeWithLiterals;
|
|
12657
13045
|
}
|
|
12658
13046
|
/** @oneof */
|
|
12659
13047
|
export interface PanelActionSelectedPanelTypeOneOf {
|
|
@@ -12668,6 +13056,8 @@ export declare enum PanelType {
|
|
|
12668
13056
|
UNKNOWN_PanelType = "UNKNOWN_PanelType",
|
|
12669
13057
|
panelId = "panelId"
|
|
12670
13058
|
}
|
|
13059
|
+
/** @enumType */
|
|
13060
|
+
export type PanelTypeWithLiterals = PanelType | 'UNKNOWN_PanelType' | 'panelId';
|
|
12671
13061
|
/** Represents an action that targets another element within the component */
|
|
12672
13062
|
export interface ForwardAction extends ForwardActionActionOneOf {
|
|
12673
13063
|
/**
|
|
@@ -12677,7 +13067,7 @@ export interface ForwardAction extends ForwardActionActionOneOf {
|
|
|
12677
13067
|
*/
|
|
12678
13068
|
custom?: string;
|
|
12679
13069
|
/** Specifies the action names (one of the natives or custom) */
|
|
12680
|
-
actionName?:
|
|
13070
|
+
actionName?: ActionNameWithLiterals;
|
|
12681
13071
|
/**
|
|
12682
13072
|
* Path to the target element
|
|
12683
13073
|
* @minLength 1
|
|
@@ -12709,6 +13099,8 @@ export declare enum ActionName {
|
|
|
12709
13099
|
/** actionName to be triggered from the defined custom actions */
|
|
12710
13100
|
custom = "custom"
|
|
12711
13101
|
}
|
|
13102
|
+
/** @enumType */
|
|
13103
|
+
export type ActionNameWithLiterals = ActionName | 'UNKNOWN_ActionName' | 'settings' | 'design' | 'media' | 'manageItems' | 'dashboard' | 'custom';
|
|
12712
13104
|
export interface DashboardAction {
|
|
12713
13105
|
/** Defines whether the action is being displayed */
|
|
12714
13106
|
hidden?: boolean | null;
|
|
@@ -12778,7 +13170,7 @@ export interface InitialSizeSetting extends InitialSizeSettingSelectedSizingType
|
|
|
12778
13170
|
*/
|
|
12779
13171
|
pixels?: number;
|
|
12780
13172
|
/** The initial size type */
|
|
12781
|
-
sizingType?:
|
|
13173
|
+
sizingType?: SizingTypeWithLiterals;
|
|
12782
13174
|
}
|
|
12783
13175
|
/** @oneof */
|
|
12784
13176
|
export interface InitialSizeSettingSelectedSizingTypeOneOf {
|
|
@@ -12797,6 +13189,8 @@ export declare enum SizingType {
|
|
|
12797
13189
|
/** Initial size should be set in pixels */
|
|
12798
13190
|
pixels = "pixels"
|
|
12799
13191
|
}
|
|
13192
|
+
/** @enumType */
|
|
13193
|
+
export type SizingTypeWithLiterals = SizingType | 'UNKNOWN_SizingType' | 'content' | 'stretched' | 'pixels';
|
|
12800
13194
|
export interface ElementDefaults {
|
|
12801
13195
|
/**
|
|
12802
13196
|
* The default preset for an element
|
|
@@ -12850,6 +13244,8 @@ export declare enum Archetype {
|
|
|
12850
13244
|
VectorArt = "VectorArt",
|
|
12851
13245
|
AnimatedGraphic = "AnimatedGraphic"
|
|
12852
13246
|
}
|
|
13247
|
+
/** @enumType */
|
|
13248
|
+
export type ArchetypeWithLiterals = Archetype | 'UNKNOWN_Archetype' | 'Button' | 'LoginButton' | 'Image' | 'Gallery' | 'Video' | 'Audio' | 'Text' | 'TextInput' | 'RichTextEditor' | 'SignatureInput' | 'Checkbox' | 'RadioGroup' | 'Switch' | 'Dropdown' | 'DatePicker' | 'TimePicker' | 'Ratings' | 'RatingInput' | 'Menu' | 'Pagination' | 'Slider' | 'Container' | 'Carousel' | 'Accordion' | 'Tabs' | 'ProgressBar' | 'Upload' | 'Social' | 'Breadcrumbs' | 'SearchBox' | 'Map' | 'Line' | 'Logo' | 'Avatar' | 'Captcha' | 'VectorArt' | 'AnimatedGraphic';
|
|
12853
13249
|
export interface RefElement {
|
|
12854
13250
|
/**
|
|
12855
13251
|
* The type of the referenced element. Must exist in the Wix Dev Center and be fullly typed (`appSlug.componentType`).
|
|
@@ -12901,9 +13297,9 @@ export interface DataItemOverrides {
|
|
|
12901
13297
|
/** Top-level message containing all layout capabilities */
|
|
12902
13298
|
export interface EditorElementLayout {
|
|
12903
13299
|
/** The resizing capabilities this component can supports */
|
|
12904
|
-
resizeDirection?:
|
|
13300
|
+
resizeDirection?: ResizeDirectionWithLiterals;
|
|
12905
13301
|
/** Describes the ability of content to impact on the size of this component */
|
|
12906
|
-
contentResizeDirection?:
|
|
13302
|
+
contentResizeDirection?: ContentResizeDirectionWithLiterals;
|
|
12907
13303
|
/** Will control the availability of the stretch capability for this component */
|
|
12908
13304
|
disableStretching?: boolean | null;
|
|
12909
13305
|
/** Will control the availability of freely positioning this component */
|
|
@@ -12923,6 +13319,8 @@ export declare enum ResizeDirection {
|
|
|
12923
13319
|
/** Component cannot be resized in any direction */
|
|
12924
13320
|
none = "none"
|
|
12925
13321
|
}
|
|
13322
|
+
/** @enumType */
|
|
13323
|
+
export type ResizeDirectionWithLiterals = ResizeDirection | 'UNKNOWN_ResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'aspectRatio' | 'none';
|
|
12926
13324
|
export declare enum ContentResizeDirection {
|
|
12927
13325
|
/** Default value when content resize behavior is not specified */
|
|
12928
13326
|
UNKNOWN_ContentResizeDirection = "UNKNOWN_ContentResizeDirection",
|
|
@@ -12935,9 +13333,11 @@ export declare enum ContentResizeDirection {
|
|
|
12935
13333
|
/** Component's size will not be affected by its content */
|
|
12936
13334
|
none = "none"
|
|
12937
13335
|
}
|
|
13336
|
+
/** @enumType */
|
|
13337
|
+
export type ContentResizeDirectionWithLiterals = ContentResizeDirection | 'UNKNOWN_ContentResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'none';
|
|
12938
13338
|
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
12939
13339
|
/** Which static container should the component be installed at */
|
|
12940
|
-
staticContainer?:
|
|
13340
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12941
13341
|
/** Default presets per breakpoint with which the component should be installed */
|
|
12942
13342
|
presets?: DefaultPresets;
|
|
12943
13343
|
/** Initial size with which the component should be added to the stage */
|
|
@@ -12946,7 +13346,7 @@ export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
|
12946
13346
|
/** @oneof */
|
|
12947
13347
|
export interface InstallationInfoTargetContainerOneOf {
|
|
12948
13348
|
/** Which static container should the component be installed at */
|
|
12949
|
-
staticContainer?:
|
|
13349
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12950
13350
|
}
|
|
12951
13351
|
export interface MarketplaceSPIConfig {
|
|
12952
13352
|
/** URI where the SPI implementer is deployed */
|
|
@@ -12988,32 +13388,62 @@ export interface RewardProviderConfig {
|
|
|
12988
13388
|
export interface ProductRestrictionsConfig {
|
|
12989
13389
|
/** URI where the SPI Implementer is deployed */
|
|
12990
13390
|
deploymentUri?: SpiBaseUri;
|
|
12991
|
-
/**
|
|
13391
|
+
/** Product restrictions configuration. */
|
|
12992
13392
|
productRestrictionsConfig?: RestrictionsConfig;
|
|
12993
13393
|
}
|
|
12994
13394
|
export interface RestrictionsConfig {
|
|
12995
|
-
/**
|
|
13395
|
+
/**
|
|
13396
|
+
* Prices restrictions.
|
|
13397
|
+
*
|
|
13398
|
+
* Affected fields:
|
|
13399
|
+
* * `variantsInfo.variants.price.actualPrice.amount`
|
|
13400
|
+
* * `variantsInfo.variants.price.compareAtPrice.amount`
|
|
13401
|
+
* * `inventory.trackingMethod.quantity`
|
|
13402
|
+
*/
|
|
12996
13403
|
prices?: Restriction;
|
|
12997
|
-
/**
|
|
13404
|
+
/**
|
|
13405
|
+
* Options restrictions.
|
|
13406
|
+
*
|
|
13407
|
+
* Affected field: `options` (all nested fields except `linkedMedia`)
|
|
13408
|
+
*/
|
|
12998
13409
|
options?: Restriction;
|
|
12999
|
-
/**
|
|
13410
|
+
/**
|
|
13411
|
+
* Modifier restrictions.
|
|
13412
|
+
*
|
|
13413
|
+
* Affected field: `modifiers` (all nested fields except `linkedMedia`)
|
|
13414
|
+
*/
|
|
13000
13415
|
modifiers?: Restriction;
|
|
13001
|
-
/**
|
|
13416
|
+
/**
|
|
13417
|
+
* Inventory restrictions.
|
|
13418
|
+
*
|
|
13419
|
+
* Affected fields:
|
|
13420
|
+
* * `variantsInfo.variants.sku`
|
|
13421
|
+
* * `variantsInfo.variants.barcode`
|
|
13422
|
+
* * `inventory.trackingMethod.quantity`
|
|
13423
|
+
*/
|
|
13002
13424
|
inventory?: Restriction;
|
|
13003
|
-
/**
|
|
13425
|
+
/**
|
|
13426
|
+
* Pre order restrictions.
|
|
13427
|
+
*
|
|
13428
|
+
* Affected field: `inventory.preorderInfo`
|
|
13429
|
+
*/
|
|
13004
13430
|
preOrder?: Restriction;
|
|
13005
|
-
/**
|
|
13431
|
+
/** Whether to disallow product duplication or display a warning when duplicating a product. */
|
|
13006
13432
|
duplicateProduct?: Restriction;
|
|
13007
13433
|
}
|
|
13008
13434
|
export interface Restriction {
|
|
13009
|
-
/**
|
|
13010
|
-
restrictionLevel?:
|
|
13435
|
+
/** Restriction level. */
|
|
13436
|
+
restrictionLevel?: RestrictionLevelWithLiterals;
|
|
13011
13437
|
}
|
|
13012
13438
|
export declare enum RestrictionLevel {
|
|
13013
13439
|
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
13440
|
+
/** Users can edit the product field after acknowledging a warning modal. */
|
|
13014
13441
|
WARNING = "WARNING",
|
|
13442
|
+
/** Users **cannot** edit the product field. */
|
|
13015
13443
|
LOCKED = "LOCKED"
|
|
13016
13444
|
}
|
|
13445
|
+
/** @enumType */
|
|
13446
|
+
export type RestrictionLevelWithLiterals = RestrictionLevel | 'UNKNOWN_RESTRICTION_TYPE' | 'WARNING' | 'LOCKED';
|
|
13017
13447
|
export interface FormSubmissionModerationSpiConfig {
|
|
13018
13448
|
/** URI where the SPI Implementer is deployed */
|
|
13019
13449
|
deploymentUri?: SpiBaseUri;
|
|
@@ -13065,7 +13495,7 @@ export interface BackOfficeCustomization {
|
|
|
13065
13495
|
export interface Header extends HeaderConfigOneOf {
|
|
13066
13496
|
/** Only set if option == CUSTOMIZED */
|
|
13067
13497
|
customized?: HeaderConfig;
|
|
13068
|
-
displayOption?:
|
|
13498
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13069
13499
|
}
|
|
13070
13500
|
/** @oneof */
|
|
13071
13501
|
export interface HeaderConfigOneOf {
|
|
@@ -13077,6 +13507,8 @@ export declare enum ElementDisplayOption {
|
|
|
13077
13507
|
REMOVE = "REMOVE",
|
|
13078
13508
|
CUSTOMIZED = "CUSTOMIZED"
|
|
13079
13509
|
}
|
|
13510
|
+
/** @enumType */
|
|
13511
|
+
export type ElementDisplayOptionWithLiterals = ElementDisplayOption | 'UNKNOWN_OPTION' | 'REMOVE' | 'CUSTOMIZED';
|
|
13080
13512
|
/** Header configuration, you can provide extensionId or using our platform header */
|
|
13081
13513
|
export interface HeaderConfig extends HeaderConfigHeaderConfigOneOf {
|
|
13082
13514
|
platform?: PlatformHeaderConfig;
|
|
@@ -13157,7 +13589,7 @@ export interface HeaderWidgetConfig {
|
|
|
13157
13589
|
export interface Sidebar extends SidebarConfigOneOf {
|
|
13158
13590
|
/** Only set if option == CUSTOMIZED */
|
|
13159
13591
|
customized?: SidebarConfig;
|
|
13160
|
-
displayOption?:
|
|
13592
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13161
13593
|
}
|
|
13162
13594
|
/** @oneof */
|
|
13163
13595
|
export interface SidebarConfigOneOf {
|
|
@@ -13198,7 +13630,7 @@ export interface SidebarConfig {
|
|
|
13198
13630
|
export interface SidebarChildItem extends SidebarChildItemItemOneOf {
|
|
13199
13631
|
category?: SecondLevelCategory;
|
|
13200
13632
|
page?: Page;
|
|
13201
|
-
type?:
|
|
13633
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13202
13634
|
}
|
|
13203
13635
|
/** @oneof */
|
|
13204
13636
|
export interface SidebarChildItemItemOneOf {
|
|
@@ -13211,6 +13643,8 @@ export declare enum SidebarDataType {
|
|
|
13211
13643
|
PAGE = "PAGE",
|
|
13212
13644
|
SEPARATOR = "SEPARATOR"
|
|
13213
13645
|
}
|
|
13646
|
+
/** @enumType */
|
|
13647
|
+
export type SidebarDataTypeWithLiterals = SidebarDataType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'SEPARATOR';
|
|
13214
13648
|
/** Represents sidebar category of second level */
|
|
13215
13649
|
export interface SecondLevelCategory {
|
|
13216
13650
|
/**
|
|
@@ -13236,7 +13670,7 @@ export interface SecondLevelCategory {
|
|
|
13236
13670
|
*/
|
|
13237
13671
|
export interface SidebarSecondLevelChildItem extends SidebarSecondLevelChildItemItemOneOf {
|
|
13238
13672
|
page?: Page;
|
|
13239
|
-
type?:
|
|
13673
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13240
13674
|
}
|
|
13241
13675
|
/** @oneof */
|
|
13242
13676
|
export interface SidebarSecondLevelChildItemItemOneOf {
|
|
@@ -13282,7 +13716,7 @@ export interface SidebarWidgetConfig {
|
|
|
13282
13716
|
/** Root level sidebar item, can be category or separator (when not setting category) */
|
|
13283
13717
|
export interface SidebarRootItem extends SidebarRootItemItemOneOf {
|
|
13284
13718
|
category?: FirstLevelCategory;
|
|
13285
|
-
type?:
|
|
13719
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13286
13720
|
}
|
|
13287
13721
|
/** @oneof */
|
|
13288
13722
|
export interface SidebarRootItemItemOneOf {
|
|
@@ -13293,7 +13727,7 @@ export interface SidebarWidget extends SidebarWidgetConfigOneOf {
|
|
|
13293
13727
|
/** Only set if option == CUSTOMIZED */
|
|
13294
13728
|
customized?: SidebarWidgetConfig;
|
|
13295
13729
|
/** Widget display option */
|
|
13296
|
-
displayOption?:
|
|
13730
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13297
13731
|
}
|
|
13298
13732
|
/** @oneof */
|
|
13299
13733
|
export interface SidebarWidgetConfigOneOf {
|
|
@@ -13319,7 +13753,7 @@ export interface BackOfficeCustomizationSidebarEntity extends BackOfficeCustomiz
|
|
|
13319
13753
|
*/
|
|
13320
13754
|
appId?: string | null;
|
|
13321
13755
|
/** Sidebar entity type */
|
|
13322
|
-
type?:
|
|
13756
|
+
type?: SidebarEntityTypeWithLiterals;
|
|
13323
13757
|
}
|
|
13324
13758
|
/** @oneof */
|
|
13325
13759
|
export interface BackOfficeCustomizationSidebarEntityItemOneOf {
|
|
@@ -13347,6 +13781,8 @@ export declare enum SidebarEntityType {
|
|
|
13347
13781
|
PAGE = "PAGE",
|
|
13348
13782
|
APP = "APP"
|
|
13349
13783
|
}
|
|
13784
|
+
/** @enumType */
|
|
13785
|
+
export type SidebarEntityTypeWithLiterals = SidebarEntityType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'APP';
|
|
13350
13786
|
export interface CoreApps {
|
|
13351
13787
|
/**
|
|
13352
13788
|
* List of core appIds to include in the dashboard. Only appIds present in the host's coreAppId list are allowed.
|
|
@@ -13367,7 +13803,7 @@ export interface ComponentEnricherConfig {
|
|
|
13367
13803
|
* @minSize 1
|
|
13368
13804
|
* @maxSize 100
|
|
13369
13805
|
*/
|
|
13370
|
-
componentEnrichmentTypes?:
|
|
13806
|
+
componentEnrichmentTypes?: ComponentTypeWithLiterals[];
|
|
13371
13807
|
}
|
|
13372
13808
|
/** Back-office Restricted Customization */
|
|
13373
13809
|
export interface BackOfficeRestrictedCustomization {
|
|
@@ -13474,6 +13910,16 @@ export interface EventTimeSlotsProviderConfig {
|
|
|
13474
13910
|
*/
|
|
13475
13911
|
eventServiceIdField?: string | null;
|
|
13476
13912
|
}
|
|
13913
|
+
export interface AppEnvironmentProviderConfig {
|
|
13914
|
+
/** URI where the SPI implementer is deployed */
|
|
13915
|
+
deploymentUri?: SpiBaseUri;
|
|
13916
|
+
/**
|
|
13917
|
+
* `true` if SPI implementer provides custom permission checks API calls
|
|
13918
|
+
*
|
|
13919
|
+
* Default: `false`
|
|
13920
|
+
*/
|
|
13921
|
+
toggleIsAppEnvironmentPermitted?: boolean;
|
|
13922
|
+
}
|
|
13477
13923
|
export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
|
|
13478
13924
|
gradualRollout?: GradualRolloutCacheEntity;
|
|
13479
13925
|
gradualUpdate?: GradualUpdateCacheEntity;
|
|
@@ -13799,7 +14245,7 @@ export interface ListDataExtensionSchemasOptions {
|
|
|
13799
14245
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
13800
14246
|
* @maxSize 5
|
|
13801
14247
|
*/
|
|
13802
|
-
fields?:
|
|
14248
|
+
fields?: RequestedFieldWithLiterals[];
|
|
13803
14249
|
/**
|
|
13804
14250
|
* Extension points within the given entity.
|
|
13805
14251
|
* @maxSize 20
|