@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
|
@@ -122,6 +122,8 @@ export interface DataExtensionSchema {
|
|
|
122
122
|
}
|
|
123
123
|
export declare enum DataExtensionSchemaState {
|
|
124
124
|
}
|
|
125
|
+
/** @enumType */
|
|
126
|
+
export type DataExtensionSchemaStateWithLiterals = DataExtensionSchemaState;
|
|
125
127
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
126
128
|
createdEvent?: EntityCreatedEvent;
|
|
127
129
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -224,7 +226,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
224
226
|
*/
|
|
225
227
|
appId?: string;
|
|
226
228
|
/** @readonly */
|
|
227
|
-
identityType?:
|
|
229
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
228
230
|
}
|
|
229
231
|
/** @oneof */
|
|
230
232
|
export interface IdentificationDataIdOneOf {
|
|
@@ -256,6 +258,8 @@ export declare enum WebhookIdentityType {
|
|
|
256
258
|
WIX_USER = "WIX_USER",
|
|
257
259
|
APP = "APP"
|
|
258
260
|
}
|
|
261
|
+
/** @enumType */
|
|
262
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
259
263
|
export interface ReindexEvent {
|
|
260
264
|
/**
|
|
261
265
|
* fqdn of the dext schema that needs reindexing
|
|
@@ -309,7 +313,7 @@ export interface ListDataExtensionSchemasRequest {
|
|
|
309
313
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
310
314
|
* @maxSize 5
|
|
311
315
|
*/
|
|
312
|
-
fields?:
|
|
316
|
+
fields?: RequestedFieldWithLiterals[];
|
|
313
317
|
/**
|
|
314
318
|
* Extension points within the given entity.
|
|
315
319
|
* @maxSize 20
|
|
@@ -323,6 +327,8 @@ export declare enum RequestedField {
|
|
|
323
327
|
/** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
|
|
324
328
|
ARCHIVED = "ARCHIVED"
|
|
325
329
|
}
|
|
330
|
+
/** @enumType */
|
|
331
|
+
export type RequestedFieldWithLiterals = RequestedField | 'UNKNOWN_REQUESTED_FIELD' | 'ARCHIVED';
|
|
326
332
|
export interface ListDataExtensionSchemasResponse {
|
|
327
333
|
/** Requested schemas. */
|
|
328
334
|
dataExtensionSchemas?: DataExtensionSchema[];
|
|
@@ -353,7 +359,7 @@ export interface DeleteGlobalExtensionSchemaRequest {
|
|
|
353
359
|
*/
|
|
354
360
|
extensionPoint?: string;
|
|
355
361
|
/** state */
|
|
356
|
-
state?:
|
|
362
|
+
state?: DataExtensionSchemaStateWithLiterals;
|
|
357
363
|
}
|
|
358
364
|
export interface DeleteGlobalExtensionSchemaResponse {
|
|
359
365
|
}
|
|
@@ -401,7 +407,7 @@ export interface RuntimeComponentCacheEntityComponent {
|
|
|
401
407
|
*/
|
|
402
408
|
name?: string | null;
|
|
403
409
|
/** the type of the component */
|
|
404
|
-
type?:
|
|
410
|
+
type?: ComponentTypeWithLiterals;
|
|
405
411
|
/** the data of the component */
|
|
406
412
|
data?: ComponentData;
|
|
407
413
|
/** The external id of the component */
|
|
@@ -599,8 +605,11 @@ export declare enum ComponentType {
|
|
|
599
605
|
LEGENDS_PERSONA_CONFIGURATION = "LEGENDS_PERSONA_CONFIGURATION",
|
|
600
606
|
WIX_HOSTING_APP_DEPLOYMENT_PROVIDER = "WIX_HOSTING_APP_DEPLOYMENT_PROVIDER",
|
|
601
607
|
BACKEND_WORKER = "BACKEND_WORKER",
|
|
602
|
-
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER"
|
|
608
|
+
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER",
|
|
609
|
+
WIX_HOSTING_APP_ENVIRONMENT_PROVIDER = "WIX_HOSTING_APP_ENVIRONMENT_PROVIDER"
|
|
603
610
|
}
|
|
611
|
+
/** @enumType */
|
|
612
|
+
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';
|
|
604
613
|
/** Component data */
|
|
605
614
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
606
615
|
/**
|
|
@@ -804,7 +813,7 @@ export interface WidgetComponentData {
|
|
|
804
813
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
805
814
|
fixedPositionOption?: FixedPositionOptions;
|
|
806
815
|
/** Widget will automatically be stretched to this width after installing it */
|
|
807
|
-
widgetWidthType?:
|
|
816
|
+
widgetWidthType?: WidgetWidthTypeWithLiterals;
|
|
808
817
|
/**
|
|
809
818
|
* Widget width size
|
|
810
819
|
* @max 9999
|
|
@@ -887,9 +896,9 @@ export interface WidgetComponentData {
|
|
|
887
896
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
888
897
|
export interface FixedPositionOptions {
|
|
889
898
|
/** Vertical widget position in the browser window */
|
|
890
|
-
widgetVertical?:
|
|
899
|
+
widgetVertical?: WidgetVerticalWithLiterals;
|
|
891
900
|
/** Horizontal widget position in the browser window */
|
|
892
|
-
widgetHorizontal?:
|
|
901
|
+
widgetHorizontal?: WidgetHorizontalWithLiterals;
|
|
893
902
|
}
|
|
894
903
|
/** Vertical widget position in the browser window */
|
|
895
904
|
export declare enum WidgetVertical {
|
|
@@ -898,6 +907,8 @@ export declare enum WidgetVertical {
|
|
|
898
907
|
CENTER_VERTICAL = "CENTER_VERTICAL",
|
|
899
908
|
BOTTOM = "BOTTOM"
|
|
900
909
|
}
|
|
910
|
+
/** @enumType */
|
|
911
|
+
export type WidgetVerticalWithLiterals = WidgetVertical | 'NONE_VERTICAL' | 'TOP' | 'CENTER_VERTICAL' | 'BOTTOM';
|
|
901
912
|
/** Horizontal widget position in the browser window */
|
|
902
913
|
export declare enum WidgetHorizontal {
|
|
903
914
|
NONE_HORIZONTAL = "NONE_HORIZONTAL",
|
|
@@ -905,6 +916,8 @@ export declare enum WidgetHorizontal {
|
|
|
905
916
|
CENTER_HORIZONTAL = "CENTER_HORIZONTAL",
|
|
906
917
|
RIGHT = "RIGHT"
|
|
907
918
|
}
|
|
919
|
+
/** @enumType */
|
|
920
|
+
export type WidgetHorizontalWithLiterals = WidgetHorizontal | 'NONE_HORIZONTAL' | 'LEFT' | 'CENTER_HORIZONTAL' | 'RIGHT';
|
|
908
921
|
/** Widget will automatically be stretched to this width after installing it */
|
|
909
922
|
export declare enum WidgetWidthType {
|
|
910
923
|
NONE_TYPE = "NONE_TYPE",
|
|
@@ -913,6 +926,8 @@ export declare enum WidgetWidthType {
|
|
|
913
926
|
/** Full width of the browser window */
|
|
914
927
|
FULL = "FULL"
|
|
915
928
|
}
|
|
929
|
+
/** @enumType */
|
|
930
|
+
export type WidgetWidthTypeWithLiterals = WidgetWidthType | 'NONE_TYPE' | 'CUSTOM' | 'FULL';
|
|
916
931
|
export interface WidgetDisplay {
|
|
917
932
|
name?: string;
|
|
918
933
|
/**
|
|
@@ -928,7 +943,7 @@ export interface WidgetDisplay {
|
|
|
928
943
|
variationId?: string | null;
|
|
929
944
|
}
|
|
930
945
|
export interface Position {
|
|
931
|
-
region?:
|
|
946
|
+
region?: RegionWithLiterals;
|
|
932
947
|
}
|
|
933
948
|
export declare enum Region {
|
|
934
949
|
no_region = "no_region",
|
|
@@ -936,6 +951,8 @@ export declare enum Region {
|
|
|
936
951
|
pageContainer = "pageContainer",
|
|
937
952
|
footer = "footer"
|
|
938
953
|
}
|
|
954
|
+
/** @enumType */
|
|
955
|
+
export type RegionWithLiterals = Region | 'no_region' | 'header' | 'pageContainer' | 'footer';
|
|
939
956
|
export interface SubPage {
|
|
940
957
|
/** The path of the subpage */
|
|
941
958
|
key?: string;
|
|
@@ -963,7 +980,7 @@ export interface DisplayProperties {
|
|
|
963
980
|
left?: DisplayValue;
|
|
964
981
|
}
|
|
965
982
|
export interface DisplayValue {
|
|
966
|
-
type?:
|
|
983
|
+
type?: UnitTypeWithLiterals;
|
|
967
984
|
value?: number | null;
|
|
968
985
|
}
|
|
969
986
|
export declare enum UnitType {
|
|
@@ -974,14 +991,16 @@ export declare enum UnitType {
|
|
|
974
991
|
VW = "VW",
|
|
975
992
|
PERCENTAGE = "PERCENTAGE"
|
|
976
993
|
}
|
|
994
|
+
/** @enumType */
|
|
995
|
+
export type UnitTypeWithLiterals = UnitType | 'NO_UNIT' | 'AUTO' | 'PX' | 'VH' | 'VW' | 'PERCENTAGE';
|
|
977
996
|
export interface Docking {
|
|
978
997
|
desktop?: DockingProperties;
|
|
979
998
|
tablet?: DockingProperties;
|
|
980
999
|
mobile?: DockingProperties;
|
|
981
1000
|
}
|
|
982
1001
|
export interface DockingProperties {
|
|
983
|
-
horizontal?:
|
|
984
|
-
vertical?:
|
|
1002
|
+
horizontal?: HorizontalDockingWithLiterals;
|
|
1003
|
+
vertical?: VerticalDockingWithLiterals;
|
|
985
1004
|
}
|
|
986
1005
|
export declare enum HorizontalDocking {
|
|
987
1006
|
NO_HDOCKING = "NO_HDOCKING",
|
|
@@ -989,12 +1008,16 @@ export declare enum HorizontalDocking {
|
|
|
989
1008
|
HCENTER = "HCENTER",
|
|
990
1009
|
RIGHT_DOCKING = "RIGHT_DOCKING"
|
|
991
1010
|
}
|
|
1011
|
+
/** @enumType */
|
|
1012
|
+
export type HorizontalDockingWithLiterals = HorizontalDocking | 'NO_HDOCKING' | 'LEFT_DOCKING' | 'HCENTER' | 'RIGHT_DOCKING';
|
|
992
1013
|
export declare enum VerticalDocking {
|
|
993
1014
|
NO_VDOCKING = "NO_VDOCKING",
|
|
994
1015
|
TOP_DOCKING = "TOP_DOCKING",
|
|
995
1016
|
VCENTER = "VCENTER",
|
|
996
1017
|
BOTTOM_DOCKING = "BOTTOM_DOCKING"
|
|
997
1018
|
}
|
|
1019
|
+
/** @enumType */
|
|
1020
|
+
export type VerticalDockingWithLiterals = VerticalDocking | 'NO_VDOCKING' | 'TOP_DOCKING' | 'VCENTER' | 'BOTTOM_DOCKING';
|
|
998
1021
|
export interface Height {
|
|
999
1022
|
desktop?: DisplayValue;
|
|
1000
1023
|
tablet?: DisplayValue;
|
|
@@ -1086,7 +1109,7 @@ export interface Padding {
|
|
|
1086
1109
|
export interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {
|
|
1087
1110
|
replacingOptions?: ReplacingOptions;
|
|
1088
1111
|
replaceableOptions?: ReplaceableOptions;
|
|
1089
|
-
type?:
|
|
1112
|
+
type?: ReplacementTypeWithLiterals;
|
|
1090
1113
|
}
|
|
1091
1114
|
/** @oneof */
|
|
1092
1115
|
export interface PageReplaceOptionsOptionsOneOf {
|
|
@@ -1110,6 +1133,8 @@ export declare enum ReplacementType {
|
|
|
1110
1133
|
REPLACING = "REPLACING",
|
|
1111
1134
|
REPLACEABLE = "REPLACEABLE"
|
|
1112
1135
|
}
|
|
1136
|
+
/** @enumType */
|
|
1137
|
+
export type ReplacementTypeWithLiterals = ReplacementType | 'UNKNOWN_REPLACEMENT' | 'REPLACING' | 'REPLACEABLE';
|
|
1113
1138
|
export interface ReplacingOptions {
|
|
1114
1139
|
/** describe the page and application id that this page will replace. */
|
|
1115
1140
|
pageReplace?: PageReplace;
|
|
@@ -1214,7 +1239,7 @@ export interface ApiSlot {
|
|
|
1214
1239
|
/** Role of the slot component (uniquely identifies slot within parent comp; used by Velo) - former "slotName" */
|
|
1215
1240
|
slotRole?: string;
|
|
1216
1241
|
/** The list of interfaces that should be implemented by a plugin in order to fit the slot */
|
|
1217
|
-
pluginInterfaces?:
|
|
1242
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
1218
1243
|
/** Id of the slot component (a.k.a. Velo role) */
|
|
1219
1244
|
slotId?: string;
|
|
1220
1245
|
}
|
|
@@ -1247,9 +1272,11 @@ export declare enum PluginInterface {
|
|
|
1247
1272
|
/** The slot requires the CART interface to be implemented by the plugin. The plugin specifies the implementation of the CART interface */
|
|
1248
1273
|
CART = "CART"
|
|
1249
1274
|
}
|
|
1275
|
+
/** @enumType */
|
|
1276
|
+
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';
|
|
1250
1277
|
export interface ExtensionExposure {
|
|
1251
1278
|
/** Determines if the component is production ready */
|
|
1252
|
-
maturity?:
|
|
1279
|
+
maturity?: MaturityWithLiterals;
|
|
1253
1280
|
}
|
|
1254
1281
|
export declare enum Exposure {
|
|
1255
1282
|
/** Unexposed. to be used by dev team only */
|
|
@@ -1259,6 +1286,8 @@ export declare enum Exposure {
|
|
|
1259
1286
|
/** Exposed to the world */
|
|
1260
1287
|
PUBLIC = "PUBLIC"
|
|
1261
1288
|
}
|
|
1289
|
+
/** @enumType */
|
|
1290
|
+
export type ExposureWithLiterals = Exposure | 'PRIVATE' | 'INTERNAL' | 'PUBLIC';
|
|
1262
1291
|
export declare enum Maturity {
|
|
1263
1292
|
/** Immature. subject to breaking changes */
|
|
1264
1293
|
ALPHA = "ALPHA",
|
|
@@ -1269,6 +1298,8 @@ export declare enum Maturity {
|
|
|
1269
1298
|
/** Not yet implemented */
|
|
1270
1299
|
NOT_IMPLEMENTED = "NOT_IMPLEMENTED"
|
|
1271
1300
|
}
|
|
1301
|
+
/** @enumType */
|
|
1302
|
+
export type MaturityWithLiterals = Maturity | 'ALPHA' | 'BETA' | 'GA' | 'NOT_IMPLEMENTED';
|
|
1272
1303
|
/** A page out of iframe component that loads directly in the Editor DOM */
|
|
1273
1304
|
export interface PageOutOfIframeComponentData {
|
|
1274
1305
|
/**
|
|
@@ -1378,7 +1409,7 @@ export interface PlatfromComponentData {
|
|
|
1378
1409
|
/** dictates if the app has migrated to the new platform API */
|
|
1379
1410
|
migratedToNewPlatformApi?: boolean;
|
|
1380
1411
|
/** The HTTP Verb used to call the router, if not set will be POST */
|
|
1381
|
-
routerHttpMethod?:
|
|
1412
|
+
routerHttpMethod?: HTTPMethodWithLiterals;
|
|
1382
1413
|
}
|
|
1383
1414
|
/** Add interim support for HTTP methods before a bigger rewrite for Routers as a component */
|
|
1384
1415
|
export declare enum HTTPMethod {
|
|
@@ -1386,6 +1417,8 @@ export declare enum HTTPMethod {
|
|
|
1386
1417
|
GET = "GET",
|
|
1387
1418
|
POST = "POST"
|
|
1388
1419
|
}
|
|
1420
|
+
/** @enumType */
|
|
1421
|
+
export type HTTPMethodWithLiterals = HTTPMethod | 'UNKNOWN_METHOD' | 'GET' | 'POST';
|
|
1389
1422
|
/**
|
|
1390
1423
|
* An iframe that opens in the user’s Wix Dashboard,
|
|
1391
1424
|
* or add a link to open the page directly in your platform.
|
|
@@ -1563,7 +1596,7 @@ export interface InstallationSettings extends InstallationSettingsOptionsOneOf {
|
|
|
1563
1596
|
/** Extra options needed when `install_page` is set to `LIGHTBOX`. */
|
|
1564
1597
|
lightboxOptions?: LightboxOptions;
|
|
1565
1598
|
/** How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`. */
|
|
1566
|
-
installPage?:
|
|
1599
|
+
installPage?: InstallPageWithLiterals;
|
|
1567
1600
|
/** Controls whether to show or hide the widget in the add panel. */
|
|
1568
1601
|
showInAddPanel?: boolean | null;
|
|
1569
1602
|
/** Defines the main preset per breakpoint for the widget. */
|
|
@@ -1587,6 +1620,8 @@ export declare enum InstallPage {
|
|
|
1587
1620
|
/** Add widget to a new lightbox in the editor */
|
|
1588
1621
|
LIGHTBOX = "LIGHTBOX"
|
|
1589
1622
|
}
|
|
1623
|
+
/** @enumType */
|
|
1624
|
+
export type InstallPageWithLiterals = InstallPage | 'NO_PAGE' | 'CURRENT' | 'PAGE' | 'LIGHTBOX';
|
|
1590
1625
|
/** Defines the main preset per breakpoint for the widget. */
|
|
1591
1626
|
export interface MainPresets {
|
|
1592
1627
|
/** The main desktop preset. */
|
|
@@ -1684,7 +1719,7 @@ export interface HelpResources {
|
|
|
1684
1719
|
}
|
|
1685
1720
|
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1686
1721
|
/** Which static container should the widget be installed at */
|
|
1687
|
-
staticContainer?:
|
|
1722
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1688
1723
|
/**
|
|
1689
1724
|
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1690
1725
|
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
@@ -1705,7 +1740,7 @@ export interface WidgetInstallationSettings extends WidgetInstallationSettingsTa
|
|
|
1705
1740
|
/** @oneof */
|
|
1706
1741
|
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1707
1742
|
/** Which static container should the widget be installed at */
|
|
1708
|
-
staticContainer?:
|
|
1743
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1709
1744
|
}
|
|
1710
1745
|
export interface BaseInstallation {
|
|
1711
1746
|
/** Auto add component to stage */
|
|
@@ -1719,13 +1754,15 @@ export interface WidgetInstallation {
|
|
|
1719
1754
|
/** Preset should be selected defaultly with installation */
|
|
1720
1755
|
defaultPreset?: MainPresets;
|
|
1721
1756
|
/** Region of widget */
|
|
1722
|
-
region?:
|
|
1757
|
+
region?: RegionTypeWithLiterals;
|
|
1723
1758
|
}
|
|
1724
1759
|
export declare enum RegionType {
|
|
1725
1760
|
HEADER = "HEADER",
|
|
1726
1761
|
BODY = "BODY",
|
|
1727
1762
|
FOOTER = "FOOTER"
|
|
1728
1763
|
}
|
|
1764
|
+
/** @enumType */
|
|
1765
|
+
export type RegionTypeWithLiterals = RegionType | 'HEADER' | 'BODY' | 'FOOTER';
|
|
1729
1766
|
export interface DefaultPresets {
|
|
1730
1767
|
/**
|
|
1731
1768
|
* Default preset ID in small (mobile) breakpoint
|
|
@@ -1745,6 +1782,8 @@ export declare enum StaticContainer {
|
|
|
1745
1782
|
/** Widget should be installed in the homepage */
|
|
1746
1783
|
HOMEPAGE = "HOMEPAGE"
|
|
1747
1784
|
}
|
|
1785
|
+
/** @enumType */
|
|
1786
|
+
export type StaticContainerWithLiterals = StaticContainer | 'UNKNOWN_CONTAINER' | 'HOMEPAGE';
|
|
1748
1787
|
export interface ComponentModel {
|
|
1749
1788
|
/** The component type of the builder component. */
|
|
1750
1789
|
componentType?: string;
|
|
@@ -1783,13 +1822,13 @@ export interface EmbeddedScriptComponentData {
|
|
|
1783
1822
|
/** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */
|
|
1784
1823
|
name?: string;
|
|
1785
1824
|
/** What category of pages this will be embedded on (single, many, none) */
|
|
1786
|
-
pages?:
|
|
1825
|
+
pages?: EmbeddedScriptPagesWithLiterals;
|
|
1787
1826
|
/** Where in the HTML this should be embedded */
|
|
1788
|
-
placement?:
|
|
1827
|
+
placement?: EmbeddedScriptPlacementWithLiterals;
|
|
1789
1828
|
/** An article explaining how to activate the script */
|
|
1790
1829
|
connectArticleUrl?: string;
|
|
1791
1830
|
/** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */
|
|
1792
|
-
embedCategory?:
|
|
1831
|
+
embedCategory?: EmbedCategoryWithLiterals;
|
|
1793
1832
|
/**
|
|
1794
1833
|
* if the script should be loaded once - default and only supported value is true
|
|
1795
1834
|
* @readonly
|
|
@@ -1812,6 +1851,8 @@ export declare enum EmbeddedScriptPages {
|
|
|
1812
1851
|
/** It will be embedded multiple times on specific pages */
|
|
1813
1852
|
SPECIFIC_PAGES = "SPECIFIC_PAGES"
|
|
1814
1853
|
}
|
|
1854
|
+
/** @enumType */
|
|
1855
|
+
export type EmbeddedScriptPagesWithLiterals = EmbeddedScriptPages | 'NONE_PAGES' | 'ONCE' | 'SPECIFIC_PAGES';
|
|
1815
1856
|
/** Where that embed will be rendered */
|
|
1816
1857
|
export declare enum EmbeddedScriptPlacement {
|
|
1817
1858
|
/** It will not be rendered */
|
|
@@ -1823,6 +1864,8 @@ export declare enum EmbeddedScriptPlacement {
|
|
|
1823
1864
|
/** Appended after the last child already rendered in the body tag */
|
|
1824
1865
|
BODY_END = "BODY_END"
|
|
1825
1866
|
}
|
|
1867
|
+
/** @enumType */
|
|
1868
|
+
export type EmbeddedScriptPlacementWithLiterals = EmbeddedScriptPlacement | 'NONE_PLACEMENT' | 'HEAD' | 'BODY_START' | 'BODY_END';
|
|
1826
1869
|
/** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */
|
|
1827
1870
|
export declare enum EmbedCategory {
|
|
1828
1871
|
/** Not categorized yet */
|
|
@@ -1836,6 +1879,8 @@ export declare enum EmbedCategory {
|
|
|
1836
1879
|
/** Adds advertising content or advertising tracking to the site */
|
|
1837
1880
|
ADVERTISING = "ADVERTISING"
|
|
1838
1881
|
}
|
|
1882
|
+
/** @enumType */
|
|
1883
|
+
export type EmbedCategoryWithLiterals = EmbedCategory | 'UNKNOWN' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING';
|
|
1839
1884
|
export interface WixDependency {
|
|
1840
1885
|
/**
|
|
1841
1886
|
* The fully qualified package name from npm, example: @wix/frontend-location
|
|
@@ -1871,7 +1916,7 @@ export interface WebComponentData {
|
|
|
1871
1916
|
/** Dynamic settings(Graphic Floating Properties Panel settings) */
|
|
1872
1917
|
gfppSettings?: Settings;
|
|
1873
1918
|
/** Custom element type PAGE / WIDGET */
|
|
1874
|
-
type?:
|
|
1919
|
+
type?: WebComponentDataElementTypeWithLiterals;
|
|
1875
1920
|
/** Boolean to make this component be available for free sites */
|
|
1876
1921
|
allowedForFreeSite?: boolean;
|
|
1877
1922
|
/**
|
|
@@ -1886,7 +1931,7 @@ export interface WebComponentData {
|
|
|
1886
1931
|
/** The details of the selected widget to add */
|
|
1887
1932
|
widget?: WidgetDetails;
|
|
1888
1933
|
/** Give the option to change the script type */
|
|
1889
|
-
scriptType?:
|
|
1934
|
+
scriptType?: ScriptTypeWithLiterals;
|
|
1890
1935
|
/** Web component default mobile height */
|
|
1891
1936
|
defaultMobileHeight?: number | null;
|
|
1892
1937
|
/** Prevent the deletion of the widget when set to true. */
|
|
@@ -2043,7 +2088,7 @@ export interface SingleKeyCondition {
|
|
|
2043
2088
|
/** ColorSelectLabeled 13 */
|
|
2044
2089
|
export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
2045
2090
|
customColor?: ColorDefinition;
|
|
2046
|
-
templateColor?:
|
|
2091
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2047
2092
|
title?: string;
|
|
2048
2093
|
key?: string;
|
|
2049
2094
|
/** @deprecated */
|
|
@@ -2054,7 +2099,7 @@ export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
|
2054
2099
|
/** @oneof */
|
|
2055
2100
|
export interface ColorSelectLabeledDataOneOf {
|
|
2056
2101
|
customColor?: ColorDefinition;
|
|
2057
|
-
templateColor?:
|
|
2102
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2058
2103
|
}
|
|
2059
2104
|
export interface ColorDefinition {
|
|
2060
2105
|
value?: string;
|
|
@@ -2067,13 +2112,15 @@ export declare enum TemplateDefaultColor {
|
|
|
2067
2112
|
BORDERS_AND_DIVIDERS = "BORDERS_AND_DIVIDERS",
|
|
2068
2113
|
BUTTONS_AND_LINKS = "BUTTONS_AND_LINKS"
|
|
2069
2114
|
}
|
|
2115
|
+
/** @enumType */
|
|
2116
|
+
export type TemplateDefaultColorWithLiterals = TemplateDefaultColor | 'BACKGROUND' | 'SECONDARY_TEXTS' | 'MAIN_TEXT_AND_ICONS' | 'BORDERS_AND_DIVIDERS' | 'BUTTONS_AND_LINKS';
|
|
2070
2117
|
/** Thumbnails 4 */
|
|
2071
2118
|
export interface Thumbnails {
|
|
2072
2119
|
key?: string;
|
|
2073
2120
|
title?: string;
|
|
2074
2121
|
value?: string;
|
|
2075
2122
|
options?: ThumbnailData[];
|
|
2076
|
-
size?:
|
|
2123
|
+
size?: ThumbnailsSizeWithLiterals;
|
|
2077
2124
|
description?: string;
|
|
2078
2125
|
conditions?: Condition[];
|
|
2079
2126
|
}
|
|
@@ -2094,6 +2141,8 @@ export declare enum ThumbnailsSize {
|
|
|
2094
2141
|
LARGE = "LARGE",
|
|
2095
2142
|
XLARGE = "XLARGE"
|
|
2096
2143
|
}
|
|
2144
|
+
/** @enumType */
|
|
2145
|
+
export type ThumbnailsSizeWithLiterals = ThumbnailsSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE';
|
|
2097
2146
|
/** SliderLabeled 5 */
|
|
2098
2147
|
export interface SliderLabeled {
|
|
2099
2148
|
key?: string;
|
|
@@ -2127,11 +2176,11 @@ export interface ToggleLabeled {
|
|
|
2127
2176
|
*/
|
|
2128
2177
|
export interface BarAlignment {
|
|
2129
2178
|
/** @deprecated */
|
|
2130
|
-
selected?:
|
|
2179
|
+
selected?: BarAlignmentSelectedWithLiterals;
|
|
2131
2180
|
key?: string;
|
|
2132
2181
|
title?: string;
|
|
2133
2182
|
description?: string;
|
|
2134
|
-
value?:
|
|
2183
|
+
value?: BarAlignmentSelectedWithLiterals;
|
|
2135
2184
|
conditions?: Condition[];
|
|
2136
2185
|
}
|
|
2137
2186
|
/** Bar alignment selected value */
|
|
@@ -2140,6 +2189,8 @@ export declare enum BarAlignmentSelected {
|
|
|
2140
2189
|
ALIGN_CENTER = "ALIGN_CENTER",
|
|
2141
2190
|
ALIGN_RIGHT = "ALIGN_RIGHT"
|
|
2142
2191
|
}
|
|
2192
|
+
/** @enumType */
|
|
2193
|
+
export type BarAlignmentSelectedWithLiterals = BarAlignmentSelected | 'ALIGN_LEFT' | 'ALIGN_CENTER' | 'ALIGN_RIGHT';
|
|
2143
2194
|
/** TextInputLabeled 9 */
|
|
2144
2195
|
export interface TextInputLabeled {
|
|
2145
2196
|
key?: string;
|
|
@@ -2164,22 +2215,24 @@ export interface FontDefinition {
|
|
|
2164
2215
|
/** TextStyle 14 */
|
|
2165
2216
|
export interface TextStyle extends TextStyleDefaultColorOneOf {
|
|
2166
2217
|
customColor?: ColorDefinition;
|
|
2167
|
-
templateColor?:
|
|
2218
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2168
2219
|
key?: string;
|
|
2169
2220
|
title?: string;
|
|
2170
2221
|
description?: string;
|
|
2171
|
-
defaultTextStyle?:
|
|
2222
|
+
defaultTextStyle?: DefaultTextStyleWithLiterals;
|
|
2172
2223
|
}
|
|
2173
2224
|
/** @oneof */
|
|
2174
2225
|
export interface TextStyleDefaultColorOneOf {
|
|
2175
2226
|
customColor?: ColorDefinition;
|
|
2176
|
-
templateColor?:
|
|
2227
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2177
2228
|
}
|
|
2178
2229
|
export declare enum DefaultTextStyle {
|
|
2179
2230
|
TITLE = "TITLE",
|
|
2180
2231
|
PARAGRAPH = "PARAGRAPH",
|
|
2181
2232
|
LOWER_HIERARCHY_TEXTS = "LOWER_HIERARCHY_TEXTS"
|
|
2182
2233
|
}
|
|
2234
|
+
/** @enumType */
|
|
2235
|
+
export type DefaultTextStyleWithLiterals = DefaultTextStyle | 'TITLE' | 'PARAGRAPH' | 'LOWER_HIERARCHY_TEXTS';
|
|
2183
2236
|
/** 10 */
|
|
2184
2237
|
export interface ResetButton {
|
|
2185
2238
|
label?: string;
|
|
@@ -2188,6 +2241,8 @@ export declare enum WebComponentDataElementType {
|
|
|
2188
2241
|
WIDGET = "WIDGET",
|
|
2189
2242
|
PAGE = "PAGE"
|
|
2190
2243
|
}
|
|
2244
|
+
/** @enumType */
|
|
2245
|
+
export type WebComponentDataElementTypeWithLiterals = WebComponentDataElementType | 'WIDGET' | 'PAGE';
|
|
2191
2246
|
export interface WidgetDetails {
|
|
2192
2247
|
name?: string | null;
|
|
2193
2248
|
icon?: string | null;
|
|
@@ -2197,6 +2252,8 @@ export declare enum ScriptType {
|
|
|
2197
2252
|
NO_SCRIPT_TYPE = "NO_SCRIPT_TYPE",
|
|
2198
2253
|
MODULE = "MODULE"
|
|
2199
2254
|
}
|
|
2255
|
+
/** @enumType */
|
|
2256
|
+
export type ScriptTypeWithLiterals = ScriptType | 'NO_SCRIPT_TYPE' | 'MODULE';
|
|
2200
2257
|
export interface WidgetBehavior {
|
|
2201
2258
|
/** Toggle whether the widget is removable from the page. */
|
|
2202
2259
|
removable?: boolean;
|
|
@@ -2205,7 +2262,7 @@ export interface WidgetBehavior {
|
|
|
2205
2262
|
}
|
|
2206
2263
|
export interface ExtensionData {
|
|
2207
2264
|
data?: string;
|
|
2208
|
-
extensionType?:
|
|
2265
|
+
extensionType?: ExtensionTypeWithLiterals;
|
|
2209
2266
|
}
|
|
2210
2267
|
export declare enum ExtensionType {
|
|
2211
2268
|
NONE_EXTENSION = "NONE_EXTENSION",
|
|
@@ -2220,6 +2277,8 @@ export declare enum ExtensionType {
|
|
|
2220
2277
|
ASCEND_AUTOMATION_EXTENSION = "ASCEND_AUTOMATION_EXTENSION",
|
|
2221
2278
|
CONTACT_LABELS_EXTENSION = "CONTACT_LABELS_EXTENSION"
|
|
2222
2279
|
}
|
|
2280
|
+
/** @enumType */
|
|
2281
|
+
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';
|
|
2223
2282
|
export interface SnippetSolutionData {
|
|
2224
2283
|
code?: string;
|
|
2225
2284
|
instructions?: string;
|
|
@@ -2310,7 +2369,7 @@ export interface SchemaField {
|
|
|
2310
2369
|
/** Sample values, values that could show up in the payload of a trigger. */
|
|
2311
2370
|
sampleValues?: string[];
|
|
2312
2371
|
/** The field exposure */
|
|
2313
|
-
exposure?:
|
|
2372
|
+
exposure?: SchemaFieldExposureWithLiterals;
|
|
2314
2373
|
}
|
|
2315
2374
|
export declare enum PrimitiveType {
|
|
2316
2375
|
UNKNOWN_PRIMITIVE_TYPE = "UNKNOWN_PRIMITIVE_TYPE",
|
|
@@ -2318,6 +2377,8 @@ export declare enum PrimitiveType {
|
|
|
2318
2377
|
BOOLEAN = "BOOLEAN",
|
|
2319
2378
|
NUMBER = "NUMBER"
|
|
2320
2379
|
}
|
|
2380
|
+
/** @enumType */
|
|
2381
|
+
export type PrimitiveTypeWithLiterals = PrimitiveType | 'UNKNOWN_PRIMITIVE_TYPE' | 'TEXT' | 'BOOLEAN' | 'NUMBER';
|
|
2321
2382
|
export declare enum SimpleType {
|
|
2322
2383
|
UNKNOWN_SIMPLE_TYPE = "UNKNOWN_SIMPLE_TYPE",
|
|
2323
2384
|
MONEY = "MONEY",
|
|
@@ -2331,11 +2392,13 @@ export declare enum SimpleType {
|
|
|
2331
2392
|
PHONE = "PHONE",
|
|
2332
2393
|
CONTACT_ID = "CONTACT_ID"
|
|
2333
2394
|
}
|
|
2395
|
+
/** @enumType */
|
|
2396
|
+
export type SimpleTypeWithLiterals = SimpleType | 'UNKNOWN_SIMPLE_TYPE' | 'MONEY' | 'LINK' | 'BACKOFFICE_LINK' | 'LIVESITE_LINK' | 'MULTILINGUAL' | 'IMAGE_LINK' | 'GUID' | 'EMAIL' | 'PHONE' | 'CONTACT_ID';
|
|
2334
2397
|
export interface Primitive {
|
|
2335
|
-
primitiveType?:
|
|
2398
|
+
primitiveType?: PrimitiveTypeWithLiterals;
|
|
2336
2399
|
}
|
|
2337
2400
|
export interface Simple {
|
|
2338
|
-
simpleType?:
|
|
2401
|
+
simpleType?: SimpleTypeWithLiterals;
|
|
2339
2402
|
}
|
|
2340
2403
|
export interface _Date {
|
|
2341
2404
|
/** Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date */
|
|
@@ -2369,10 +2432,12 @@ export declare enum SchemaFieldExposure {
|
|
|
2369
2432
|
/** Sent to the action provider and usually shown to user */
|
|
2370
2433
|
EXPOSED = "EXPOSED"
|
|
2371
2434
|
}
|
|
2435
|
+
/** @enumType */
|
|
2436
|
+
export type SchemaFieldExposureWithLiterals = SchemaFieldExposure | 'UNKNOWN_EXPOSURE' | 'SETUP' | 'HIDDEN' | 'EXPOSED';
|
|
2372
2437
|
/** represents Invoices integration policies */
|
|
2373
2438
|
export interface InvoicesActionsComponentData {
|
|
2374
2439
|
/** partial payment restriction on invoice */
|
|
2375
|
-
partialPayment?:
|
|
2440
|
+
partialPayment?: PartialPaymentRestrictionWithLiterals;
|
|
2376
2441
|
}
|
|
2377
2442
|
/** Possible Partial Payment Policy Values */
|
|
2378
2443
|
export declare enum PartialPaymentRestriction {
|
|
@@ -2382,6 +2447,8 @@ export declare enum PartialPaymentRestriction {
|
|
|
2382
2447
|
/** Disallow Partial Payment */
|
|
2383
2448
|
DISALLOW = "DISALLOW"
|
|
2384
2449
|
}
|
|
2450
|
+
/** @enumType */
|
|
2451
|
+
export type PartialPaymentRestrictionWithLiterals = PartialPaymentRestriction | 'UNDEFINED' | 'ALLOW' | 'DISALLOW';
|
|
2385
2452
|
/** Experimental-WIP: Specifies the app module configuration of business manager module */
|
|
2386
2453
|
export interface DashboardApplicationData {
|
|
2387
2454
|
/**
|
|
@@ -2477,7 +2544,7 @@ export interface HostedComponent {
|
|
|
2477
2544
|
/** Permissions required for the component, this is not strictly enforced */
|
|
2478
2545
|
requiredPermission?: string;
|
|
2479
2546
|
/** Represents the collection of components where the component will be hosted, get this value from the host provider. */
|
|
2480
|
-
hostContainerId?:
|
|
2547
|
+
hostContainerId?: HostContainerIdWithLiterals;
|
|
2481
2548
|
/** 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 */
|
|
2482
2549
|
enabledByExperiments?: ExperimentGroupWrapper[];
|
|
2483
2550
|
/** A URI used to send component error events */
|
|
@@ -2488,6 +2555,8 @@ export declare enum HostContainerId {
|
|
|
2488
2555
|
BUSINESS_DASHBOARD_HOST = "BUSINESS_DASHBOARD_HOST",
|
|
2489
2556
|
SIDEBAR_FOOTER = "SIDEBAR_FOOTER"
|
|
2490
2557
|
}
|
|
2558
|
+
/** @enumType */
|
|
2559
|
+
export type HostContainerIdWithLiterals = HostContainerId | 'BUSINESS_MANAGER' | 'BUSINESS_DASHBOARD_HOST' | 'SIDEBAR_FOOTER';
|
|
2491
2560
|
/** Contact Labels Extensions */
|
|
2492
2561
|
export interface ContactLabelsComponentData {
|
|
2493
2562
|
/** Whether apps can create labels in this namespace. */
|
|
@@ -2525,7 +2594,7 @@ export interface WidgetPluginComponentData {
|
|
|
2525
2594
|
*/
|
|
2526
2595
|
referenceComponentId?: string;
|
|
2527
2596
|
/** APIs implemented by the Plugin's widget. */
|
|
2528
|
-
pluginInterfaces?:
|
|
2597
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
2529
2598
|
/** Marketing information about the plugin. */
|
|
2530
2599
|
marketData?: PluginMarketData;
|
|
2531
2600
|
/** List of placements where the plugin is allowed to be installed. */
|
|
@@ -2625,7 +2694,7 @@ export interface HostedPage {
|
|
|
2625
2694
|
/** Url to images in different formats and colors */
|
|
2626
2695
|
logos?: Logos;
|
|
2627
2696
|
/** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */
|
|
2628
|
-
billingAddressMandatoryFields?:
|
|
2697
|
+
billingAddressMandatoryFields?: MandatoryFieldWithLiterals[];
|
|
2629
2698
|
}
|
|
2630
2699
|
export interface Logos {
|
|
2631
2700
|
/** white theme logos */
|
|
@@ -2659,6 +2728,8 @@ export declare enum MandatoryField {
|
|
|
2659
2728
|
HOUSE_NUMBER = "HOUSE_NUMBER",
|
|
2660
2729
|
TAX_IDENTIFIER = "TAX_IDENTIFIER"
|
|
2661
2730
|
}
|
|
2731
|
+
/** @enumType */
|
|
2732
|
+
export type MandatoryFieldWithLiterals = MandatoryField | 'ZIPCODE' | 'CITY' | 'STATE' | 'ADDRESS' | 'COUNTRY_CODE' | 'EMAIL' | 'PHONE' | 'FIRST_NAME' | 'LAST_NAME' | 'STREET' | 'HOUSE_NUMBER' | 'TAX_IDENTIFIER';
|
|
2662
2733
|
export interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {
|
|
2663
2734
|
/** text field */
|
|
2664
2735
|
simpleField?: SimpleField;
|
|
@@ -2805,7 +2876,7 @@ export interface ShippingLabelCarrierSpiConfig {
|
|
|
2805
2876
|
*/
|
|
2806
2877
|
currency?: string;
|
|
2807
2878
|
/** the measurement system of he labels (Metric or Imperial) */
|
|
2808
|
-
measurementSystem?:
|
|
2879
|
+
measurementSystem?: MeasurementSystemWithLiterals;
|
|
2809
2880
|
/** does carrier support insurance */
|
|
2810
2881
|
isInsuranceSupported?: boolean;
|
|
2811
2882
|
/**
|
|
@@ -2819,6 +2890,8 @@ export declare enum MeasurementSystem {
|
|
|
2819
2890
|
Metric = "Metric",
|
|
2820
2891
|
Imperial = "Imperial"
|
|
2821
2892
|
}
|
|
2893
|
+
/** @enumType */
|
|
2894
|
+
export type MeasurementSystemWithLiterals = MeasurementSystem | 'Metric' | 'Imperial';
|
|
2822
2895
|
export interface PackageType {
|
|
2823
2896
|
/**
|
|
2824
2897
|
* carrier id that can be used to get quotes and purchase
|
|
@@ -2893,24 +2966,26 @@ export interface RestaurantsPOSComponentData {
|
|
|
2893
2966
|
}
|
|
2894
2967
|
export interface CatalogSyncConfiguration {
|
|
2895
2968
|
/** 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). */
|
|
2896
|
-
entityAvailabilityUpdated?:
|
|
2969
|
+
entityAvailabilityUpdated?: DefaultWithLiterals;
|
|
2897
2970
|
/** 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). */
|
|
2898
|
-
fulfillmentMethodsDefinition?:
|
|
2971
|
+
fulfillmentMethodsDefinition?: DefaultWithLiterals;
|
|
2899
2972
|
/** 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). */
|
|
2900
|
-
dishImagesUpdated?:
|
|
2973
|
+
dishImagesUpdated?: DefaultWithLiterals;
|
|
2901
2974
|
/** 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). */
|
|
2902
|
-
entitySortingControl?:
|
|
2975
|
+
entitySortingControl?: DefaultWithLiterals;
|
|
2903
2976
|
/** 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). */
|
|
2904
|
-
dishLabelsUpdated?:
|
|
2977
|
+
dishLabelsUpdated?: DefaultWithLiterals;
|
|
2905
2978
|
/** 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). */
|
|
2906
|
-
dishOptionsMinMaxUpdated?:
|
|
2979
|
+
dishOptionsMinMaxUpdated?: DefaultWithLiterals;
|
|
2907
2980
|
/** 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). */
|
|
2908
|
-
dishInStockUpdated?:
|
|
2981
|
+
dishInStockUpdated?: DefaultWithLiterals;
|
|
2909
2982
|
}
|
|
2910
2983
|
export declare enum Default {
|
|
2911
2984
|
WIX = "WIX",
|
|
2912
2985
|
POS = "POS"
|
|
2913
2986
|
}
|
|
2987
|
+
/** @enumType */
|
|
2988
|
+
export type DefaultWithLiterals = Default | 'WIX' | 'POS';
|
|
2914
2989
|
export interface ShippingProviderConfig {
|
|
2915
2990
|
/** URI configuration of the deployment */
|
|
2916
2991
|
deploymentUri?: SpiBaseUri;
|
|
@@ -2976,6 +3051,8 @@ export declare enum HookType {
|
|
|
2976
3051
|
BEFORE = "BEFORE",
|
|
2977
3052
|
AFTER = "AFTER"
|
|
2978
3053
|
}
|
|
3054
|
+
/** @enumType */
|
|
3055
|
+
export type HookTypeWithLiterals = HookType | 'UNDEFINED' | 'BEFORE_BLOCKING' | 'BEFORE' | 'AFTER';
|
|
2979
3056
|
export interface GenericHookConfig {
|
|
2980
3057
|
/** FQN of proto service */
|
|
2981
3058
|
serviceFqn?: string;
|
|
@@ -2987,7 +3064,7 @@ export interface GenericHookConfig {
|
|
|
2987
3064
|
*/
|
|
2988
3065
|
uri?: string;
|
|
2989
3066
|
/** Type of hook */
|
|
2990
|
-
hookType?:
|
|
3067
|
+
hookType?: HookTypeWithLiterals;
|
|
2991
3068
|
}
|
|
2992
3069
|
export interface ActionProviderSPIConfig {
|
|
2993
3070
|
/** URL to action provider service for this action */
|
|
@@ -3090,7 +3167,7 @@ export interface ActionSPIConfig {
|
|
|
3090
3167
|
* Indicates whether we should wait for the action to complete before executing the next actions or finish and
|
|
3091
3168
|
* expect a callback in the actionCompleted method
|
|
3092
3169
|
*/
|
|
3093
|
-
executionType?:
|
|
3170
|
+
executionType?: ExecutionTypeWithLiterals;
|
|
3094
3171
|
/** Chosen interface for action */
|
|
3095
3172
|
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
3096
3173
|
/** Icon representing the action in the UI */
|
|
@@ -3108,6 +3185,8 @@ export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
|
3108
3185
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
3109
3186
|
GENERIC = "GENERIC"
|
|
3110
3187
|
}
|
|
3188
|
+
/** @enumType */
|
|
3189
|
+
export type ActionSPIConfigInterfaceConfigurationTypeWithLiterals = ActionSPIConfigInterfaceConfigurationType | 'UNKNOWN_TYPE' | 'WIDGET_COMPONENT' | 'GENERIC';
|
|
3111
3190
|
export interface WidgetComponentOptions {
|
|
3112
3191
|
/**
|
|
3113
3192
|
* Name of provided component
|
|
@@ -3127,6 +3206,8 @@ export declare enum SourceType {
|
|
|
3127
3206
|
/** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
|
|
3128
3207
|
WIX_API = "WIX_API"
|
|
3129
3208
|
}
|
|
3209
|
+
/** @enumType */
|
|
3210
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
|
|
3130
3211
|
export interface WixApiOptions {
|
|
3131
3212
|
/**
|
|
3132
3213
|
* Service entity fqdn
|
|
@@ -3176,6 +3257,8 @@ export declare enum ExecutionType {
|
|
|
3176
3257
|
SYNC = "SYNC",
|
|
3177
3258
|
ASYNC = "ASYNC"
|
|
3178
3259
|
}
|
|
3260
|
+
/** @enumType */
|
|
3261
|
+
export type ExecutionTypeWithLiterals = ExecutionType | 'UNKNOWN_EXECUTION_TYPE' | 'SYNC' | 'ASYNC';
|
|
3179
3262
|
export interface Metadata {
|
|
3180
3263
|
/** Show action only to advanced mode users (Wix staff) */
|
|
3181
3264
|
hidden?: boolean;
|
|
@@ -3184,7 +3267,7 @@ export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigIn
|
|
|
3184
3267
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
3185
3268
|
genericOptions?: GenericOptions;
|
|
3186
3269
|
/** Type of chosen interface */
|
|
3187
|
-
type?:
|
|
3270
|
+
type?: ActionSPIConfigInterfaceConfigurationTypeWithLiterals;
|
|
3188
3271
|
}
|
|
3189
3272
|
/** @oneof */
|
|
3190
3273
|
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
@@ -3195,7 +3278,7 @@ export interface Source extends SourceOptionsOneOf {
|
|
|
3195
3278
|
/** Wix API options */
|
|
3196
3279
|
wixApiOptions?: WixApiOptions;
|
|
3197
3280
|
/** the source type */
|
|
3198
|
-
type?:
|
|
3281
|
+
type?: SourceTypeWithLiterals;
|
|
3199
3282
|
}
|
|
3200
3283
|
/** @oneof */
|
|
3201
3284
|
export interface SourceOptionsOneOf {
|
|
@@ -3239,7 +3322,7 @@ export interface BackOfficeExtensionContainer {
|
|
|
3239
3322
|
/** Extensibility properties used by containers (slots) */
|
|
3240
3323
|
export interface Extendable {
|
|
3241
3324
|
/** Type of component that this slot accepts. */
|
|
3242
|
-
extendedBy?:
|
|
3325
|
+
extendedBy?: ExtendingComponentTypeWithLiterals;
|
|
3243
3326
|
}
|
|
3244
3327
|
/** Which component types can be extended in containers */
|
|
3245
3328
|
export declare enum ExtendingComponentType {
|
|
@@ -3247,6 +3330,8 @@ export declare enum ExtendingComponentType {
|
|
|
3247
3330
|
BACK_OFFICE_MENU_ITEM = "BACK_OFFICE_MENU_ITEM",
|
|
3248
3331
|
BACK_OFFICE_EXTENSION_WIDGET = "BACK_OFFICE_EXTENSION_WIDGET"
|
|
3249
3332
|
}
|
|
3333
|
+
/** @enumType */
|
|
3334
|
+
export type ExtendingComponentTypeWithLiterals = ExtendingComponentType | 'INVALID' | 'BACK_OFFICE_MENU_ITEM' | 'BACK_OFFICE_EXTENSION_WIDGET';
|
|
3250
3335
|
/** List of back-office hosting platforms */
|
|
3251
3336
|
export declare enum BackOfficeHostingPlatforms {
|
|
3252
3337
|
NO_HOSTING_PLATFORM = "NO_HOSTING_PLATFORM",
|
|
@@ -3287,6 +3372,8 @@ export declare enum BackOfficeHostingPlatforms {
|
|
|
3287
3372
|
/** Picasso AI application POC */
|
|
3288
3373
|
PICASSO_EDITOR = "PICASSO_EDITOR"
|
|
3289
3374
|
}
|
|
3375
|
+
/** @enumType */
|
|
3376
|
+
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';
|
|
3290
3377
|
/** Definitions of common slots properties */
|
|
3291
3378
|
export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
3292
3379
|
/** Widget-specific slot. */
|
|
@@ -3311,7 +3398,7 @@ export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
|
3311
3398
|
* @format WEB_URL
|
|
3312
3399
|
*/
|
|
3313
3400
|
mdHttpLinks?: string[];
|
|
3314
|
-
type?:
|
|
3401
|
+
type?: SlotDataTypeWithLiterals;
|
|
3315
3402
|
}
|
|
3316
3403
|
/** @oneof */
|
|
3317
3404
|
export interface SlotDataSlotTypeOneOf {
|
|
@@ -3323,7 +3410,7 @@ export interface SlotDataSlotTypeOneOf {
|
|
|
3323
3410
|
export interface DtsDefinitionReference extends DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
3324
3411
|
dtsHttpLinkOptions?: DtsHttpLink;
|
|
3325
3412
|
dtsContentOptions?: DtsContent;
|
|
3326
|
-
type?:
|
|
3413
|
+
type?: DtsDefinitionTypeWithLiterals;
|
|
3327
3414
|
}
|
|
3328
3415
|
/** @oneof */
|
|
3329
3416
|
export interface DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
@@ -3335,6 +3422,8 @@ export declare enum DtsDefinitionType {
|
|
|
3335
3422
|
DTS_HTTP_LINK = "DTS_HTTP_LINK",
|
|
3336
3423
|
DTS_CONTENT = "DTS_CONTENT"
|
|
3337
3424
|
}
|
|
3425
|
+
/** @enumType */
|
|
3426
|
+
export type DtsDefinitionTypeWithLiterals = DtsDefinitionType | 'UNKNOWN' | 'DTS_HTTP_LINK' | 'DTS_CONTENT';
|
|
3338
3427
|
export interface DtsHttpLink {
|
|
3339
3428
|
/**
|
|
3340
3429
|
* HTTP link to the bundled d.ts file.
|
|
@@ -3386,6 +3475,8 @@ export declare enum SlotDataType {
|
|
|
3386
3475
|
WIDGET = "WIDGET",
|
|
3387
3476
|
MENU = "MENU"
|
|
3388
3477
|
}
|
|
3478
|
+
/** @enumType */
|
|
3479
|
+
export type SlotDataTypeWithLiterals = SlotDataType | 'UNKNOWN' | 'WIDGET' | 'MENU';
|
|
3389
3480
|
export interface WidgetSlot {
|
|
3390
3481
|
/** Blocks specific data. */
|
|
3391
3482
|
blocksData?: BlocksData;
|
|
@@ -3411,13 +3502,13 @@ export interface BackOfficeExtension extends BackOfficeExtensionExtensionOneOf {
|
|
|
3411
3502
|
/** Extension description. This is how the extension is described in the Wix Dev Center. */
|
|
3412
3503
|
description?: string | null;
|
|
3413
3504
|
/** Type of extension. */
|
|
3414
|
-
extensionType?:
|
|
3505
|
+
extensionType?: ExtendingComponentTypeWithLiterals;
|
|
3415
3506
|
/**
|
|
3416
3507
|
* Platform that hosts the extension.
|
|
3417
3508
|
*
|
|
3418
3509
|
* Must be `"BUSINESS_MANAGER"`.
|
|
3419
3510
|
*/
|
|
3420
|
-
hostingPlatform?:
|
|
3511
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
3421
3512
|
}
|
|
3422
3513
|
/** @oneof */
|
|
3423
3514
|
export interface BackOfficeExtensionExtensionOneOf {
|
|
@@ -3472,7 +3563,7 @@ export interface BackOfficeScriptAsset {
|
|
|
3472
3563
|
*/
|
|
3473
3564
|
exportedName?: string;
|
|
3474
3565
|
/** Optional: What type should by used on <script> tag. */
|
|
3475
|
-
scriptType?:
|
|
3566
|
+
scriptType?: BackOfficeScriptAssetTypeWithLiterals;
|
|
3476
3567
|
}
|
|
3477
3568
|
/** Type attribute for the script tag */
|
|
3478
3569
|
export declare enum BackOfficeScriptAssetType {
|
|
@@ -3481,6 +3572,8 @@ export declare enum BackOfficeScriptAssetType {
|
|
|
3481
3572
|
/** Use "module" as the script type */
|
|
3482
3573
|
MODULE = "MODULE"
|
|
3483
3574
|
}
|
|
3575
|
+
/** @enumType */
|
|
3576
|
+
export type BackOfficeScriptAssetTypeWithLiterals = BackOfficeScriptAssetType | 'UNKNOWN_TYPE' | 'MODULE';
|
|
3484
3577
|
/** The schema of a menu extension of a slot exposed in a page in the Wix Dashboard */
|
|
3485
3578
|
export interface LegacyBackOfficeMenuItem {
|
|
3486
3579
|
/**
|
|
@@ -3505,6 +3598,8 @@ export declare enum ViewMode {
|
|
|
3505
3598
|
/** Opens as a modal on the current page. */
|
|
3506
3599
|
MODAL = "MODAL"
|
|
3507
3600
|
}
|
|
3601
|
+
/** @enumType */
|
|
3602
|
+
export type ViewModeWithLiterals = ViewMode | 'PAGE' | 'MODAL';
|
|
3508
3603
|
/** the schema of the data needed to open a component from menu extensions */
|
|
3509
3604
|
export interface OpenComponent {
|
|
3510
3605
|
/**
|
|
@@ -3513,7 +3608,7 @@ export interface OpenComponent {
|
|
|
3513
3608
|
*/
|
|
3514
3609
|
componentId?: string;
|
|
3515
3610
|
/** How the component is opened. */
|
|
3516
|
-
viewMode?:
|
|
3611
|
+
viewMode?: ViewModeWithLiterals;
|
|
3517
3612
|
/** Parameters to navigate to a page or as props for a modal. */
|
|
3518
3613
|
componentParams?: Record<string, string>;
|
|
3519
3614
|
}
|
|
@@ -3652,7 +3747,7 @@ export interface AlgorithmConfig {
|
|
|
3652
3747
|
* * `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.
|
|
3653
3748
|
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
3654
3749
|
*/
|
|
3655
|
-
algorithmType?:
|
|
3750
|
+
algorithmType?: AlgorithmTypeWithLiterals;
|
|
3656
3751
|
/**
|
|
3657
3752
|
* 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.
|
|
3658
3753
|
* @format GUID
|
|
@@ -3664,6 +3759,8 @@ export declare enum AlgorithmType {
|
|
|
3664
3759
|
RELATED_ITEMS = "RELATED_ITEMS",
|
|
3665
3760
|
GLOBAL = "GLOBAL"
|
|
3666
3761
|
}
|
|
3762
|
+
/** @enumType */
|
|
3763
|
+
export type AlgorithmTypeWithLiterals = AlgorithmType | 'UNSPECIFIED' | 'RELATED_ITEMS' | 'GLOBAL';
|
|
3667
3764
|
export interface DropshippingProviderSPIConfig {
|
|
3668
3765
|
/** name of the dropshipping provider was it appears in relevant screens/mails in eComm Platform */
|
|
3669
3766
|
name?: string;
|
|
@@ -3680,13 +3777,13 @@ export interface DropshippingProviderSPIConfig {
|
|
|
3680
3777
|
*/
|
|
3681
3778
|
dashboardUri?: string;
|
|
3682
3779
|
/** if duplication operation for product is locked */
|
|
3683
|
-
duplicateProduct?:
|
|
3780
|
+
duplicateProduct?: LockableOperationWithLiterals;
|
|
3684
3781
|
/** whether there is a warning or not when price is changed */
|
|
3685
|
-
changePrice?:
|
|
3782
|
+
changePrice?: RestrictedOperationWithLiterals;
|
|
3686
3783
|
/** whether the chagne inventory operations are locked */
|
|
3687
|
-
changeInventory?:
|
|
3784
|
+
changeInventory?: LockableOperationWithLiterals;
|
|
3688
3785
|
/** where there is a warning of not when changing options */
|
|
3689
|
-
manageOptions?:
|
|
3786
|
+
manageOptions?: RestrictedOperationWithLiterals;
|
|
3690
3787
|
}
|
|
3691
3788
|
export declare enum LockableOperation {
|
|
3692
3789
|
/** When operation lockability is not specified */
|
|
@@ -3696,11 +3793,15 @@ export declare enum LockableOperation {
|
|
|
3696
3793
|
/** Operation is unlocked */
|
|
3697
3794
|
UNLOCKED = "UNLOCKED"
|
|
3698
3795
|
}
|
|
3796
|
+
/** @enumType */
|
|
3797
|
+
export type LockableOperationWithLiterals = LockableOperation | 'UNSPECIFIED_LOCKABLE' | 'LOCKED' | 'UNLOCKED';
|
|
3699
3798
|
export declare enum RestrictedOperation {
|
|
3700
3799
|
UNSPECIFIED_RESTRICTED = "UNSPECIFIED_RESTRICTED",
|
|
3701
3800
|
ALLOW = "ALLOW",
|
|
3702
3801
|
WARN = "WARN"
|
|
3703
3802
|
}
|
|
3803
|
+
/** @enumType */
|
|
3804
|
+
export type RestrictedOperationWithLiterals = RestrictedOperation | 'UNSPECIFIED_RESTRICTED' | 'ALLOW' | 'WARN';
|
|
3704
3805
|
export interface InvoicesConfig {
|
|
3705
3806
|
/** Base URI of spi provider */
|
|
3706
3807
|
baseUri?: string;
|
|
@@ -3767,7 +3868,7 @@ export interface ApplicationAutomationComponent {
|
|
|
3767
3868
|
/** Automation metadata */
|
|
3768
3869
|
metadata?: AutomationMetadata;
|
|
3769
3870
|
/** Automation status */
|
|
3770
|
-
status?:
|
|
3871
|
+
status?: StatusWithLiterals;
|
|
3771
3872
|
/** Optional origin that indicates the source of the automation */
|
|
3772
3873
|
origin?: OriginInfo;
|
|
3773
3874
|
/**
|
|
@@ -3910,8 +4011,10 @@ export declare enum BlockType {
|
|
|
3910
4011
|
OR = "OR",
|
|
3911
4012
|
AND = "AND"
|
|
3912
4013
|
}
|
|
4014
|
+
/** @enumType */
|
|
4015
|
+
export type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND';
|
|
3913
4016
|
export interface ConditionBlock {
|
|
3914
|
-
type?:
|
|
4017
|
+
type?: BlockTypeWithLiterals;
|
|
3915
4018
|
/**
|
|
3916
4019
|
* @minSize 1
|
|
3917
4020
|
* @maxSize 20
|
|
@@ -4004,10 +4107,14 @@ export declare enum Domain {
|
|
|
4004
4107
|
/** Wix domain */
|
|
4005
4108
|
WIX = "WIX"
|
|
4006
4109
|
}
|
|
4110
|
+
/** @enumType */
|
|
4111
|
+
export type DomainWithLiterals = Domain | 'USER' | 'WIX';
|
|
4007
4112
|
export declare enum Status {
|
|
4008
4113
|
ACTIVE = "ACTIVE",
|
|
4009
4114
|
INACTIVE = "INACTIVE"
|
|
4010
4115
|
}
|
|
4116
|
+
/** @enumType */
|
|
4117
|
+
export type StatusWithLiterals = Status | 'ACTIVE' | 'INACTIVE';
|
|
4011
4118
|
export interface OriginInfo {
|
|
4012
4119
|
/**
|
|
4013
4120
|
* The id of the original automation used to create the preinstalled automation (v3/Builder only)
|
|
@@ -4234,7 +4341,7 @@ export interface TextInputSettings {
|
|
|
4234
4341
|
/** A regex that the text entered by the user must match */
|
|
4235
4342
|
regex?: string | null;
|
|
4236
4343
|
/** How should the field be displayed to the end user */
|
|
4237
|
-
displayType?:
|
|
4344
|
+
displayType?: TextInputDisplayTypeWithLiterals;
|
|
4238
4345
|
}
|
|
4239
4346
|
export declare enum TextInputDisplayType {
|
|
4240
4347
|
/** A regular text field */
|
|
@@ -4244,6 +4351,8 @@ export declare enum TextInputDisplayType {
|
|
|
4244
4351
|
/** A field optimized for one time codes */
|
|
4245
4352
|
CODE = "CODE"
|
|
4246
4353
|
}
|
|
4354
|
+
/** @enumType */
|
|
4355
|
+
export type TextInputDisplayTypeWithLiterals = TextInputDisplayType | 'TEXT' | 'PASSWORD' | 'CODE';
|
|
4247
4356
|
export interface IDPConnectionConfig {
|
|
4248
4357
|
/** the base URI where all the methods are deployed. */
|
|
4249
4358
|
baseUri?: string;
|
|
@@ -4270,11 +4379,11 @@ export interface ItemsSelectionProviderConfig {
|
|
|
4270
4379
|
* 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.
|
|
4271
4380
|
* @maxSize 50
|
|
4272
4381
|
*/
|
|
4273
|
-
supportedTags?:
|
|
4382
|
+
supportedTags?: TagWithLiterals[];
|
|
4274
4383
|
/** Configuration settings for how the thumbnail is displayed. */
|
|
4275
4384
|
itemThumbnail?: ItemThumbnail;
|
|
4276
4385
|
/** Pagination Mode */
|
|
4277
|
-
paginationMode?:
|
|
4386
|
+
paginationMode?: PaginationModeWithLiterals;
|
|
4278
4387
|
}
|
|
4279
4388
|
export interface LearnMore {
|
|
4280
4389
|
/**
|
|
@@ -4293,8 +4402,10 @@ export declare enum ThumbnailType {
|
|
|
4293
4402
|
IMAGE = "IMAGE",
|
|
4294
4403
|
AVATAR = "AVATAR"
|
|
4295
4404
|
}
|
|
4405
|
+
/** @enumType */
|
|
4406
|
+
export type ThumbnailTypeWithLiterals = ThumbnailType | 'UNKNOWN_THUMBNAIL_TYPE' | 'IMAGE' | 'AVATAR';
|
|
4296
4407
|
export interface ImageConfig {
|
|
4297
|
-
shape?:
|
|
4408
|
+
shape?: ImageShapeWithLiterals;
|
|
4298
4409
|
}
|
|
4299
4410
|
export declare enum ImageShape {
|
|
4300
4411
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4305,8 +4416,10 @@ export declare enum ImageShape {
|
|
|
4305
4416
|
/** Rectangle */
|
|
4306
4417
|
RECTANGLE = "RECTANGLE"
|
|
4307
4418
|
}
|
|
4419
|
+
/** @enumType */
|
|
4420
|
+
export type ImageShapeWithLiterals = ImageShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE' | 'RECTANGLE';
|
|
4308
4421
|
export interface AvatarConfig {
|
|
4309
|
-
shape?:
|
|
4422
|
+
shape?: AvatarShapeWithLiterals;
|
|
4310
4423
|
}
|
|
4311
4424
|
export declare enum AvatarShape {
|
|
4312
4425
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4315,6 +4428,8 @@ export declare enum AvatarShape {
|
|
|
4315
4428
|
/** Square */
|
|
4316
4429
|
SQUARE = "SQUARE"
|
|
4317
4430
|
}
|
|
4431
|
+
/** @enumType */
|
|
4432
|
+
export type AvatarShapeWithLiterals = AvatarShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE';
|
|
4318
4433
|
export interface SearchField {
|
|
4319
4434
|
/** Supported searchable fields. */
|
|
4320
4435
|
key?: string;
|
|
@@ -4337,11 +4452,11 @@ export interface FilterInfo extends FilterInfoOptionsOneOf {
|
|
|
4337
4452
|
*/
|
|
4338
4453
|
key?: string;
|
|
4339
4454
|
/** Optional filter will be shown only for consumers with this tag. Only one filter is allowed per tag. */
|
|
4340
|
-
tag?:
|
|
4455
|
+
tag?: TagWithLiterals;
|
|
4341
4456
|
/** The filter selection type. */
|
|
4342
|
-
selectionType?:
|
|
4457
|
+
selectionType?: FilterSelectionTypeWithLiterals;
|
|
4343
4458
|
/** Filter options type. For now only static options are supported */
|
|
4344
|
-
optionsType?:
|
|
4459
|
+
optionsType?: FilterOptionsTypeWithLiterals;
|
|
4345
4460
|
/**
|
|
4346
4461
|
* Optional placeholder text to display on the filter
|
|
4347
4462
|
* @maxLength 500
|
|
@@ -4365,6 +4480,8 @@ export declare enum Tag {
|
|
|
4365
4480
|
ECOM_DELIVERY_PROFILES = "ECOM_DELIVERY_PROFILES",
|
|
4366
4481
|
ADD_TO_CATEGORY = "ADD_TO_CATEGORY"
|
|
4367
4482
|
}
|
|
4483
|
+
/** @enumType */
|
|
4484
|
+
export type TagWithLiterals = Tag | 'UNKNOWN_TAG' | 'EMBEDDABLE' | 'ECOM_EDIT_ORDER' | 'ECOM_CREATE_ORDER' | 'INBOX' | 'ECOM_CREATE_PAY_LINK' | 'ECOM_DELIVERY_PROFILES' | 'ADD_TO_CATEGORY';
|
|
4368
4485
|
export declare enum FilterSelectionType {
|
|
4369
4486
|
UNKNOWN_SELECTION = "UNKNOWN_SELECTION",
|
|
4370
4487
|
/** Allow to select only a single item */
|
|
@@ -4372,12 +4489,16 @@ export declare enum FilterSelectionType {
|
|
|
4372
4489
|
/** Allow to select multiple items */
|
|
4373
4490
|
MULTIPLE_SELECTION = "MULTIPLE_SELECTION"
|
|
4374
4491
|
}
|
|
4492
|
+
/** @enumType */
|
|
4493
|
+
export type FilterSelectionTypeWithLiterals = FilterSelectionType | 'UNKNOWN_SELECTION' | 'SINGLE_SELECTION' | 'MULTIPLE_SELECTION';
|
|
4375
4494
|
export declare enum FilterOptionsType {
|
|
4376
4495
|
UNKNOWN_FILTER_OPTIONS = "UNKNOWN_FILTER_OPTIONS",
|
|
4377
4496
|
/** Static hardcoded options */
|
|
4378
4497
|
STATIC = "STATIC",
|
|
4379
4498
|
PROVIDER = "PROVIDER"
|
|
4380
4499
|
}
|
|
4500
|
+
/** @enumType */
|
|
4501
|
+
export type FilterOptionsTypeWithLiterals = FilterOptionsType | 'UNKNOWN_FILTER_OPTIONS' | 'STATIC' | 'PROVIDER';
|
|
4381
4502
|
export interface StaticFilterOptions {
|
|
4382
4503
|
/**
|
|
4383
4504
|
* List of hardcoded options for a filter
|
|
@@ -4486,7 +4607,7 @@ export interface ItemThumbnail extends ItemThumbnailOptionsOneOf {
|
|
|
4486
4607
|
/** Configuration specific to avatars. */
|
|
4487
4608
|
avatarConfig?: AvatarConfig;
|
|
4488
4609
|
/** Thumbnail type */
|
|
4489
|
-
type?:
|
|
4610
|
+
type?: ThumbnailTypeWithLiterals;
|
|
4490
4611
|
/** Whether the thumbnail is hidden from the UI. */
|
|
4491
4612
|
hidden?: boolean | null;
|
|
4492
4613
|
}
|
|
@@ -4502,6 +4623,8 @@ export declare enum PaginationMode {
|
|
|
4502
4623
|
CURSOR = "CURSOR",
|
|
4503
4624
|
OFFSET = "OFFSET"
|
|
4504
4625
|
}
|
|
4626
|
+
/** @enumType */
|
|
4627
|
+
export type PaginationModeWithLiterals = PaginationMode | 'UNKNOWN_PAGINATION_MODE' | 'CURSOR' | 'OFFSET';
|
|
4505
4628
|
export interface SyncedProjectsProviderConfig {
|
|
4506
4629
|
/** URI where the SPI Implementer is deployed */
|
|
4507
4630
|
baseUri?: string;
|
|
@@ -4522,7 +4645,7 @@ export interface ChannelConfiguration extends ChannelConfigurationMessagingConfi
|
|
|
4522
4645
|
emailMessageConfig?: EmailMessageConfig;
|
|
4523
4646
|
smsMessageConfig?: SmsMessageConfig;
|
|
4524
4647
|
/** The type of the communication channel */
|
|
4525
|
-
type?:
|
|
4648
|
+
type?: ChannelTypeWithLiterals;
|
|
4526
4649
|
/** Specific provider branding parameters for the channel */
|
|
4527
4650
|
branding?: ChannelBranding;
|
|
4528
4651
|
/** Conversation initiation definition */
|
|
@@ -4541,6 +4664,8 @@ export declare enum ChannelType {
|
|
|
4541
4664
|
EMAIL = "EMAIL",
|
|
4542
4665
|
SMS = "SMS"
|
|
4543
4666
|
}
|
|
4667
|
+
/** @enumType */
|
|
4668
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
4544
4669
|
export interface DirectMessageConfig {
|
|
4545
4670
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4546
4671
|
acceptAllMessageTypes?: boolean;
|
|
@@ -4548,7 +4673,7 @@ export interface DirectMessageConfig {
|
|
|
4548
4673
|
* Direct message types accepted by the provider. only those types will be sent from Wix
|
|
4549
4674
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4550
4675
|
*/
|
|
4551
|
-
acceptedMessageTypes?:
|
|
4676
|
+
acceptedMessageTypes?: AcceptedDirectMessageTypeWithLiterals[];
|
|
4552
4677
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4553
4678
|
mediaCapabilities?: MediaCapabilities;
|
|
4554
4679
|
}
|
|
@@ -4559,6 +4684,8 @@ export declare enum AcceptedDirectMessageType {
|
|
|
4559
4684
|
ANNOUNCEMENT = "ANNOUNCEMENT",
|
|
4560
4685
|
FORM = "FORM"
|
|
4561
4686
|
}
|
|
4687
|
+
/** @enumType */
|
|
4688
|
+
export type AcceptedDirectMessageTypeWithLiterals = AcceptedDirectMessageType | 'TEXT' | 'MEDIA' | 'CARD' | 'ANNOUNCEMENT' | 'FORM';
|
|
4562
4689
|
export interface MediaCapabilities {
|
|
4563
4690
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4564
4691
|
allMediaTypes?: boolean;
|
|
@@ -4567,7 +4694,7 @@ export interface MediaCapabilities {
|
|
|
4567
4694
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4568
4695
|
* @maxSize 50
|
|
4569
4696
|
*/
|
|
4570
|
-
supportedMediaTypes?:
|
|
4697
|
+
supportedMediaTypes?: MediaMimeTypeWithLiterals[];
|
|
4571
4698
|
/** Maximum file size in bytes of a single file in a message */
|
|
4572
4699
|
maxFileSizeInBytes?: number | null;
|
|
4573
4700
|
}
|
|
@@ -4588,6 +4715,8 @@ export declare enum MediaMimeType {
|
|
|
4588
4715
|
APPLICATION_PDF = "APPLICATION_PDF",
|
|
4589
4716
|
APPLICATION_OCTET_STREAM = "APPLICATION_OCTET_STREAM"
|
|
4590
4717
|
}
|
|
4718
|
+
/** @enumType */
|
|
4719
|
+
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';
|
|
4591
4720
|
export interface EmailMessageConfig {
|
|
4592
4721
|
/** Media (Attachment) types accepted by the provider */
|
|
4593
4722
|
mediaCapabilities?: MediaCapabilities;
|
|
@@ -4598,7 +4727,7 @@ export interface SmsMessageConfig {
|
|
|
4598
4727
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4599
4728
|
acceptAllMessageTypes?: boolean;
|
|
4600
4729
|
/** SMS message types accepted by the provider. only those types will be sent from Wix */
|
|
4601
|
-
acceptedMessageTypes?:
|
|
4730
|
+
acceptedMessageTypes?: AcceptedSmsMessageTypeWithLiterals[];
|
|
4602
4731
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4603
4732
|
mediaCapabilities?: MediaCapabilities;
|
|
4604
4733
|
}
|
|
@@ -4606,6 +4735,8 @@ export declare enum AcceptedSmsMessageType {
|
|
|
4606
4735
|
SMS = "SMS",
|
|
4607
4736
|
MMS = "MMS"
|
|
4608
4737
|
}
|
|
4738
|
+
/** @enumType */
|
|
4739
|
+
export type AcceptedSmsMessageTypeWithLiterals = AcceptedSmsMessageType | 'SMS' | 'MMS';
|
|
4609
4740
|
export interface ChannelBranding {
|
|
4610
4741
|
/** The name of the channel, e.g. `Facebook` / `SMS` */
|
|
4611
4742
|
displayName?: string;
|
|
@@ -4634,7 +4765,7 @@ export interface ConversationLimitations {
|
|
|
4634
4765
|
* If, `CUSTOMER` is selected, this means that only inbound
|
|
4635
4766
|
* messages can start a conversation (aka business can only reply and not initiate the first communication).
|
|
4636
4767
|
*/
|
|
4637
|
-
initDirection?:
|
|
4768
|
+
initDirection?: InitDirectionWithLiterals;
|
|
4638
4769
|
}
|
|
4639
4770
|
export declare enum InitDirection {
|
|
4640
4771
|
UNKNOWN_INIT_DIRECTION = "UNKNOWN_INIT_DIRECTION",
|
|
@@ -4642,6 +4773,8 @@ export declare enum InitDirection {
|
|
|
4642
4773
|
CUSTOMER = "CUSTOMER",
|
|
4643
4774
|
BOTH = "BOTH"
|
|
4644
4775
|
}
|
|
4776
|
+
/** @enumType */
|
|
4777
|
+
export type InitDirectionWithLiterals = InitDirection | 'UNKNOWN_INIT_DIRECTION' | 'BUSINESS' | 'CUSTOMER' | 'BOTH';
|
|
4645
4778
|
export interface PostLoginConfig {
|
|
4646
4779
|
/** the base URI where all the methods are deployed. */
|
|
4647
4780
|
baseUri?: string;
|
|
@@ -4902,7 +5035,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
4902
5035
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
4903
5036
|
layoutCellData?: LayoutCellData;
|
|
4904
5037
|
/** 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. */
|
|
4905
|
-
type?:
|
|
5038
|
+
type?: NodeTypeWithLiterals;
|
|
4906
5039
|
/** Node ID. */
|
|
4907
5040
|
id?: string;
|
|
4908
5041
|
/** A list of child nodes. */
|
|
@@ -5003,6 +5136,8 @@ export declare enum NodeType {
|
|
|
5003
5136
|
LAYOUT = "LAYOUT",
|
|
5004
5137
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
5005
5138
|
}
|
|
5139
|
+
/** @enumType */
|
|
5140
|
+
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';
|
|
5006
5141
|
export interface NodeStyle {
|
|
5007
5142
|
/** The top padding value in pixels. */
|
|
5008
5143
|
paddingTop?: string | null;
|
|
@@ -5015,7 +5150,7 @@ export interface ButtonData {
|
|
|
5015
5150
|
/** Styling for the button's container. */
|
|
5016
5151
|
containerData?: PluginContainerData;
|
|
5017
5152
|
/** The button type. */
|
|
5018
|
-
type?:
|
|
5153
|
+
type?: ButtonDataTypeWithLiterals;
|
|
5019
5154
|
/** Styling for the button. */
|
|
5020
5155
|
styles?: Styles;
|
|
5021
5156
|
/** The text to display on the button. */
|
|
@@ -5056,7 +5191,7 @@ export interface PluginContainerData {
|
|
|
5056
5191
|
/** The width of the node when it's displayed. */
|
|
5057
5192
|
width?: PluginContainerDataWidth;
|
|
5058
5193
|
/** The node's alignment within its container. */
|
|
5059
|
-
alignment?:
|
|
5194
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
5060
5195
|
/** Spoiler cover settings for the node. */
|
|
5061
5196
|
spoiler?: Spoiler;
|
|
5062
5197
|
/** The height of the node when it's displayed. */
|
|
@@ -5074,6 +5209,8 @@ export declare enum WidthType {
|
|
|
5074
5209
|
/** coast-to-coast display */
|
|
5075
5210
|
FULL_WIDTH = "FULL_WIDTH"
|
|
5076
5211
|
}
|
|
5212
|
+
/** @enumType */
|
|
5213
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
5077
5214
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
5078
5215
|
/**
|
|
5079
5216
|
* One of the following predefined width options:
|
|
@@ -5082,7 +5219,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
5082
5219
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5083
5220
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5084
5221
|
*/
|
|
5085
|
-
size?:
|
|
5222
|
+
size?: WidthTypeWithLiterals;
|
|
5086
5223
|
/** A custom width value in pixels. */
|
|
5087
5224
|
custom?: string | null;
|
|
5088
5225
|
}
|
|
@@ -5095,7 +5232,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
5095
5232
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5096
5233
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5097
5234
|
*/
|
|
5098
|
-
size?:
|
|
5235
|
+
size?: WidthTypeWithLiterals;
|
|
5099
5236
|
/** A custom width value in pixels. */
|
|
5100
5237
|
custom?: string | null;
|
|
5101
5238
|
}
|
|
@@ -5107,6 +5244,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
5107
5244
|
/** Right Alignment */
|
|
5108
5245
|
RIGHT = "RIGHT"
|
|
5109
5246
|
}
|
|
5247
|
+
/** @enumType */
|
|
5248
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5110
5249
|
export interface Spoiler {
|
|
5111
5250
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
5112
5251
|
enabled?: boolean | null;
|
|
@@ -5125,6 +5264,8 @@ export declare enum ButtonDataType {
|
|
|
5125
5264
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
5126
5265
|
ACTION = "ACTION"
|
|
5127
5266
|
}
|
|
5267
|
+
/** @enumType */
|
|
5268
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
5128
5269
|
export interface Styles {
|
|
5129
5270
|
/**
|
|
5130
5271
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -5190,7 +5331,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
5190
5331
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
5191
5332
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
5192
5333
|
*/
|
|
5193
|
-
target?:
|
|
5334
|
+
target?: LinkTargetWithLiterals;
|
|
5194
5335
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
5195
5336
|
rel?: Rel;
|
|
5196
5337
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -5213,6 +5354,8 @@ export declare enum LinkTarget {
|
|
|
5213
5354
|
/** Opens the linked document in the full body of the window */
|
|
5214
5355
|
TOP = "TOP"
|
|
5215
5356
|
}
|
|
5357
|
+
/** @enumType */
|
|
5358
|
+
export type LinkTargetWithLiterals = LinkTarget | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
5216
5359
|
export interface Rel {
|
|
5217
5360
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
5218
5361
|
nofollow?: boolean | null;
|
|
@@ -5229,7 +5372,7 @@ export interface CodeBlockData {
|
|
|
5229
5372
|
}
|
|
5230
5373
|
export interface V1TextStyle {
|
|
5231
5374
|
/** Text alignment. Defaults to `AUTO`. */
|
|
5232
|
-
textAlignment?:
|
|
5375
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
5233
5376
|
/** 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. */
|
|
5234
5377
|
lineHeight?: string | null;
|
|
5235
5378
|
}
|
|
@@ -5245,15 +5388,17 @@ export declare enum TextAlignment {
|
|
|
5245
5388
|
/** 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 */
|
|
5246
5389
|
JUSTIFY = "JUSTIFY"
|
|
5247
5390
|
}
|
|
5391
|
+
/** @enumType */
|
|
5392
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
5248
5393
|
export interface DividerData {
|
|
5249
5394
|
/** Styling for the divider's container. */
|
|
5250
5395
|
containerData?: PluginContainerData;
|
|
5251
5396
|
/** Divider line style. */
|
|
5252
|
-
lineStyle?:
|
|
5397
|
+
lineStyle?: LineStyleWithLiterals;
|
|
5253
5398
|
/** Divider width. */
|
|
5254
|
-
width?:
|
|
5399
|
+
width?: DividerDataWidthWithLiterals;
|
|
5255
5400
|
/** Divider alignment. */
|
|
5256
|
-
alignment?:
|
|
5401
|
+
alignment?: AlignmentWithLiterals;
|
|
5257
5402
|
}
|
|
5258
5403
|
export declare enum LineStyle {
|
|
5259
5404
|
/** Single Line */
|
|
@@ -5265,6 +5410,8 @@ export declare enum LineStyle {
|
|
|
5265
5410
|
/** Dotted Line */
|
|
5266
5411
|
DOTTED = "DOTTED"
|
|
5267
5412
|
}
|
|
5413
|
+
/** @enumType */
|
|
5414
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
5268
5415
|
export declare enum DividerDataWidth {
|
|
5269
5416
|
/** Large line */
|
|
5270
5417
|
LARGE = "LARGE",
|
|
@@ -5273,6 +5420,8 @@ export declare enum DividerDataWidth {
|
|
|
5273
5420
|
/** Small line */
|
|
5274
5421
|
SMALL = "SMALL"
|
|
5275
5422
|
}
|
|
5423
|
+
/** @enumType */
|
|
5424
|
+
export type DividerDataWidthWithLiterals = DividerDataWidth | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
5276
5425
|
export declare enum Alignment {
|
|
5277
5426
|
/** Center alignment */
|
|
5278
5427
|
CENTER = "CENTER",
|
|
@@ -5281,6 +5430,8 @@ export declare enum Alignment {
|
|
|
5281
5430
|
/** Right alignment */
|
|
5282
5431
|
RIGHT = "RIGHT"
|
|
5283
5432
|
}
|
|
5433
|
+
/** @enumType */
|
|
5434
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5284
5435
|
export interface FileData {
|
|
5285
5436
|
/** Styling for the file's container. */
|
|
5286
5437
|
containerData?: PluginContainerData;
|
|
@@ -5312,6 +5463,8 @@ export declare enum PDFSettingsViewMode {
|
|
|
5312
5463
|
/** Mini PDF view */
|
|
5313
5464
|
MINI = "MINI"
|
|
5314
5465
|
}
|
|
5466
|
+
/** @enumType */
|
|
5467
|
+
export type PDFSettingsViewModeWithLiterals = PDFSettingsViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
5315
5468
|
export interface FileSource extends FileSourceDataOneOf {
|
|
5316
5469
|
/** The absolute URL for the file's source. */
|
|
5317
5470
|
url?: string | null;
|
|
@@ -5344,7 +5497,7 @@ export interface PDFSettings {
|
|
|
5344
5497
|
* `FULL` : A full page view of the PDF is displayed.
|
|
5345
5498
|
* `MINI` : A mini view of the PDF is displayed.
|
|
5346
5499
|
*/
|
|
5347
|
-
viewMode?:
|
|
5500
|
+
viewMode?: PDFSettingsViewModeWithLiterals;
|
|
5348
5501
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
5349
5502
|
disableDownload?: boolean | null;
|
|
5350
5503
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -5431,18 +5584,24 @@ export declare enum LayoutType {
|
|
|
5431
5584
|
/** Fullsize images type */
|
|
5432
5585
|
FULLSIZE = "FULLSIZE"
|
|
5433
5586
|
}
|
|
5587
|
+
/** @enumType */
|
|
5588
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
5434
5589
|
export declare enum Orientation {
|
|
5435
5590
|
/** Rows Orientation */
|
|
5436
5591
|
ROWS = "ROWS",
|
|
5437
5592
|
/** Columns Orientation */
|
|
5438
5593
|
COLUMNS = "COLUMNS"
|
|
5439
5594
|
}
|
|
5595
|
+
/** @enumType */
|
|
5596
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
5440
5597
|
export declare enum Crop {
|
|
5441
5598
|
/** Crop to fill */
|
|
5442
5599
|
FILL = "FILL",
|
|
5443
5600
|
/** Crop to fit */
|
|
5444
5601
|
FIT = "FIT"
|
|
5445
5602
|
}
|
|
5603
|
+
/** @enumType */
|
|
5604
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
5446
5605
|
export declare enum ThumbnailsAlignment {
|
|
5447
5606
|
/** Top alignment */
|
|
5448
5607
|
TOP = "TOP",
|
|
@@ -5455,13 +5614,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
5455
5614
|
/** No thumbnail */
|
|
5456
5615
|
NONE = "NONE"
|
|
5457
5616
|
}
|
|
5617
|
+
/** @enumType */
|
|
5618
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
5458
5619
|
export interface Layout {
|
|
5459
5620
|
/** Gallery layout type. */
|
|
5460
|
-
type?:
|
|
5621
|
+
type?: LayoutTypeWithLiterals;
|
|
5461
5622
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
5462
5623
|
horizontalScroll?: boolean | null;
|
|
5463
5624
|
/** Gallery orientation. */
|
|
5464
|
-
orientation?:
|
|
5625
|
+
orientation?: OrientationWithLiterals;
|
|
5465
5626
|
/** The number of columns to display on full size screens. */
|
|
5466
5627
|
numberOfColumns?: number | null;
|
|
5467
5628
|
/** The number of columns to display on mobile screens. */
|
|
@@ -5473,13 +5634,13 @@ export interface ItemStyle {
|
|
|
5473
5634
|
/** Item ratio */
|
|
5474
5635
|
ratio?: number | null;
|
|
5475
5636
|
/** Sets how item images are cropped. */
|
|
5476
|
-
crop?:
|
|
5637
|
+
crop?: CropWithLiterals;
|
|
5477
5638
|
/** The spacing between items in pixels. */
|
|
5478
5639
|
spacing?: number | null;
|
|
5479
5640
|
}
|
|
5480
5641
|
export interface GalleryOptionsThumbnails {
|
|
5481
5642
|
/** Thumbnail alignment. */
|
|
5482
|
-
placement?:
|
|
5643
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
5483
5644
|
/** Spacing between thumbnails in pixels. */
|
|
5484
5645
|
spacing?: number | null;
|
|
5485
5646
|
}
|
|
@@ -5495,7 +5656,7 @@ export interface GIFData {
|
|
|
5495
5656
|
/** Width in pixels. */
|
|
5496
5657
|
width?: number;
|
|
5497
5658
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
5498
|
-
gifType?:
|
|
5659
|
+
gifType?: GIFTypeWithLiterals;
|
|
5499
5660
|
}
|
|
5500
5661
|
export interface GIF {
|
|
5501
5662
|
/**
|
|
@@ -5518,6 +5679,8 @@ export declare enum GIFType {
|
|
|
5518
5679
|
NORMAL = "NORMAL",
|
|
5519
5680
|
STICKER = "STICKER"
|
|
5520
5681
|
}
|
|
5682
|
+
/** @enumType */
|
|
5683
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
5521
5684
|
export interface HeadingData {
|
|
5522
5685
|
/** Heading level from 1-6. */
|
|
5523
5686
|
level?: number;
|
|
@@ -5539,7 +5702,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
5539
5702
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
5540
5703
|
containerData?: PluginContainerData;
|
|
5541
5704
|
/** The type of HTML code. */
|
|
5542
|
-
source?:
|
|
5705
|
+
source?: HTMLDataSourceWithLiterals;
|
|
5543
5706
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
5544
5707
|
autoHeight?: boolean | null;
|
|
5545
5708
|
}
|
|
@@ -5559,6 +5722,8 @@ export declare enum HTMLDataSource {
|
|
|
5559
5722
|
HTML = "HTML",
|
|
5560
5723
|
ADSENSE = "ADSENSE"
|
|
5561
5724
|
}
|
|
5725
|
+
/** @enumType */
|
|
5726
|
+
export type HTMLDataSourceWithLiterals = HTMLDataSource | 'HTML' | 'ADSENSE';
|
|
5562
5727
|
export interface ImageData {
|
|
5563
5728
|
/** Styling for the image's container. */
|
|
5564
5729
|
containerData?: PluginContainerData;
|
|
@@ -5623,6 +5788,8 @@ export declare enum StylesPosition {
|
|
|
5623
5788
|
/** Thumbnail hidden and not displayed */
|
|
5624
5789
|
HIDDEN = "HIDDEN"
|
|
5625
5790
|
}
|
|
5791
|
+
/** @enumType */
|
|
5792
|
+
export type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
5626
5793
|
export interface LinkPreviewDataStyles {
|
|
5627
5794
|
/**
|
|
5628
5795
|
* Background color as a hexadecimal value.
|
|
@@ -5654,7 +5821,7 @@ export interface LinkPreviewDataStyles {
|
|
|
5654
5821
|
*/
|
|
5655
5822
|
borderColor?: string | null;
|
|
5656
5823
|
/** Position of thumbnail. Defaults to `START`. */
|
|
5657
|
-
thumbnailPosition?:
|
|
5824
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
5658
5825
|
}
|
|
5659
5826
|
export interface MapData {
|
|
5660
5827
|
/** Styling for the map's container. */
|
|
@@ -5684,7 +5851,7 @@ export interface MapSettings {
|
|
|
5684
5851
|
/** Initial zoom value. */
|
|
5685
5852
|
initialZoom?: number | null;
|
|
5686
5853
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
5687
|
-
mapType?:
|
|
5854
|
+
mapType?: MapTypeWithLiterals;
|
|
5688
5855
|
}
|
|
5689
5856
|
export declare enum MapType {
|
|
5690
5857
|
/** Roadmap map type */
|
|
@@ -5696,6 +5863,8 @@ export declare enum MapType {
|
|
|
5696
5863
|
/** Terrain map type */
|
|
5697
5864
|
TERRAIN = "TERRAIN"
|
|
5698
5865
|
}
|
|
5866
|
+
/** @enumType */
|
|
5867
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
5699
5868
|
export interface ParagraphData {
|
|
5700
5869
|
/** Styling for the paragraph text. */
|
|
5701
5870
|
textStyle?: V1TextStyle;
|
|
@@ -5722,17 +5891,21 @@ export declare enum ViewRole {
|
|
|
5722
5891
|
/** Anyone can see the results, even if one didn't vote */
|
|
5723
5892
|
EVERYONE = "EVERYONE"
|
|
5724
5893
|
}
|
|
5894
|
+
/** @enumType */
|
|
5895
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
5725
5896
|
export declare enum VoteRole {
|
|
5726
5897
|
/** Logged in member */
|
|
5727
5898
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
5728
5899
|
/** Anyone */
|
|
5729
5900
|
ALL = "ALL"
|
|
5730
5901
|
}
|
|
5902
|
+
/** @enumType */
|
|
5903
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
5731
5904
|
export interface SettingsPermissions {
|
|
5732
5905
|
/** Sets who can view the poll results. */
|
|
5733
|
-
view?:
|
|
5906
|
+
view?: ViewRoleWithLiterals;
|
|
5734
5907
|
/** Sets who can vote. */
|
|
5735
|
-
vote?:
|
|
5908
|
+
vote?: VoteRoleWithLiterals;
|
|
5736
5909
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
5737
5910
|
allowMultipleVotes?: boolean | null;
|
|
5738
5911
|
}
|
|
@@ -5758,17 +5931,21 @@ export declare enum PollLayoutType {
|
|
|
5758
5931
|
/** Grid */
|
|
5759
5932
|
GRID = "GRID"
|
|
5760
5933
|
}
|
|
5934
|
+
/** @enumType */
|
|
5935
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
5761
5936
|
export declare enum PollLayoutDirection {
|
|
5762
5937
|
/** Left-to-right */
|
|
5763
5938
|
LTR = "LTR",
|
|
5764
5939
|
/** Right-to-left */
|
|
5765
5940
|
RTL = "RTL"
|
|
5766
5941
|
}
|
|
5942
|
+
/** @enumType */
|
|
5943
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
5767
5944
|
export interface PollLayout {
|
|
5768
5945
|
/** The layout for displaying the voting options. */
|
|
5769
|
-
type?:
|
|
5946
|
+
type?: PollLayoutTypeWithLiterals;
|
|
5770
5947
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
5771
|
-
direction?:
|
|
5948
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
5772
5949
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
5773
5950
|
enableImage?: boolean | null;
|
|
5774
5951
|
}
|
|
@@ -5784,6 +5961,8 @@ export declare enum BackgroundType {
|
|
|
5784
5961
|
/** Gradiant background type */
|
|
5785
5962
|
GRADIENT = "GRADIENT"
|
|
5786
5963
|
}
|
|
5964
|
+
/** @enumType */
|
|
5965
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
5787
5966
|
export interface Gradient {
|
|
5788
5967
|
/** The gradient angle in degrees. */
|
|
5789
5968
|
angle?: number | null;
|
|
@@ -5809,7 +5988,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
5809
5988
|
/** Details for a gradient background. */
|
|
5810
5989
|
gradient?: Gradient;
|
|
5811
5990
|
/** Background type. For each option, include the relevant details. */
|
|
5812
|
-
type?:
|
|
5991
|
+
type?: BackgroundTypeWithLiterals;
|
|
5813
5992
|
}
|
|
5814
5993
|
/** @oneof */
|
|
5815
5994
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -5888,7 +6067,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
5888
6067
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
5889
6068
|
strikethroughData?: boolean | null;
|
|
5890
6069
|
/** The type of decoration to apply. */
|
|
5891
|
-
type?:
|
|
6070
|
+
type?: DecorationTypeWithLiterals;
|
|
5892
6071
|
}
|
|
5893
6072
|
/** @oneof */
|
|
5894
6073
|
export interface DecorationDataOneOf {
|
|
@@ -5926,6 +6105,8 @@ export declare enum DecorationType {
|
|
|
5926
6105
|
EXTERNAL = "EXTERNAL",
|
|
5927
6106
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
5928
6107
|
}
|
|
6108
|
+
/** @enumType */
|
|
6109
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
5929
6110
|
export interface AnchorData {
|
|
5930
6111
|
/** The target node's ID. */
|
|
5931
6112
|
anchor?: string;
|
|
@@ -5950,7 +6131,7 @@ export interface MentionData {
|
|
|
5950
6131
|
}
|
|
5951
6132
|
export interface FontSizeData {
|
|
5952
6133
|
/** The units used for the font size. */
|
|
5953
|
-
unit?:
|
|
6134
|
+
unit?: FontTypeWithLiterals;
|
|
5954
6135
|
/** Font size value. */
|
|
5955
6136
|
value?: number | null;
|
|
5956
6137
|
}
|
|
@@ -5958,6 +6139,8 @@ export declare enum FontType {
|
|
|
5958
6139
|
PX = "PX",
|
|
5959
6140
|
EM = "EM"
|
|
5960
6141
|
}
|
|
6142
|
+
/** @enumType */
|
|
6143
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
5961
6144
|
export interface SpoilerData {
|
|
5962
6145
|
/** Spoiler ID. */
|
|
5963
6146
|
id?: string | null;
|
|
@@ -5968,7 +6151,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
5968
6151
|
/** Data for embedded Wix Events content. */
|
|
5969
6152
|
eventData?: EventData;
|
|
5970
6153
|
/** The type of Wix App content being embedded. */
|
|
5971
|
-
type?:
|
|
6154
|
+
type?: AppTypeWithLiterals;
|
|
5972
6155
|
/** The ID of the embedded content. */
|
|
5973
6156
|
itemId?: string | null;
|
|
5974
6157
|
/** The name of the embedded content. */
|
|
@@ -5995,6 +6178,8 @@ export declare enum AppType {
|
|
|
5995
6178
|
EVENT = "EVENT",
|
|
5996
6179
|
BOOKING = "BOOKING"
|
|
5997
6180
|
}
|
|
6181
|
+
/** @enumType */
|
|
6182
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
5998
6183
|
export interface BookingData {
|
|
5999
6184
|
/** Booking duration in minutes. */
|
|
6000
6185
|
durations?: string | null;
|
|
@@ -6073,9 +6258,9 @@ export interface CollapsibleListData {
|
|
|
6073
6258
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
6074
6259
|
expandOnlyOne?: boolean | null;
|
|
6075
6260
|
/** Sets which items are expanded when the page loads. */
|
|
6076
|
-
initialExpandedItems?:
|
|
6261
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
6077
6262
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
6078
|
-
direction?:
|
|
6263
|
+
direction?: DirectionWithLiterals;
|
|
6079
6264
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
6080
6265
|
isQapageData?: boolean | null;
|
|
6081
6266
|
}
|
|
@@ -6087,12 +6272,16 @@ export declare enum InitialExpandedItems {
|
|
|
6087
6272
|
/** All items collapsed initally */
|
|
6088
6273
|
NONE = "NONE"
|
|
6089
6274
|
}
|
|
6275
|
+
/** @enumType */
|
|
6276
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
6090
6277
|
export declare enum Direction {
|
|
6091
6278
|
/** Left-to-right */
|
|
6092
6279
|
LTR = "LTR",
|
|
6093
6280
|
/** Right-to-left */
|
|
6094
6281
|
RTL = "RTL"
|
|
6095
6282
|
}
|
|
6283
|
+
/** @enumType */
|
|
6284
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
6096
6285
|
export interface TableData {
|
|
6097
6286
|
/** Styling for the table's container. */
|
|
6098
6287
|
containerData?: PluginContainerData;
|
|
@@ -6130,9 +6319,11 @@ export declare enum VerticalAlignment {
|
|
|
6130
6319
|
/** Bottom alignment */
|
|
6131
6320
|
BOTTOM = "BOTTOM"
|
|
6132
6321
|
}
|
|
6322
|
+
/** @enumType */
|
|
6323
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
6133
6324
|
export interface CellStyle {
|
|
6134
6325
|
/** Vertical alignment for the cell's text. */
|
|
6135
|
-
verticalAlignment?:
|
|
6326
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
6136
6327
|
/**
|
|
6137
6328
|
* Cell background color as a hexadecimal value.
|
|
6138
6329
|
* @format COLOR_HEX
|
|
@@ -6171,6 +6362,8 @@ export declare enum NullValue {
|
|
|
6171
6362
|
/** Null value. */
|
|
6172
6363
|
NULL_VALUE = "NULL_VALUE"
|
|
6173
6364
|
}
|
|
6365
|
+
/** @enumType */
|
|
6366
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
6174
6367
|
/**
|
|
6175
6368
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
6176
6369
|
*
|
|
@@ -6311,7 +6504,7 @@ export interface ComponentsValidatorConfig {
|
|
|
6311
6504
|
* @minSize 1
|
|
6312
6505
|
* @maxSize 100
|
|
6313
6506
|
*/
|
|
6314
|
-
componentValidationTypes?:
|
|
6507
|
+
componentValidationTypes?: ComponentTypeWithLiterals[];
|
|
6315
6508
|
/** Indicates whether the validation should affect real production */
|
|
6316
6509
|
testMode?: boolean;
|
|
6317
6510
|
}
|
|
@@ -6366,18 +6559,18 @@ export interface ProviderConfig {
|
|
|
6366
6559
|
/** The base URI in which all methods are deployed. */
|
|
6367
6560
|
baseUri?: string;
|
|
6368
6561
|
/** The provided calendar type. */
|
|
6369
|
-
calendarType?:
|
|
6562
|
+
calendarType?: CalendarTypeWithLiterals;
|
|
6370
6563
|
/**
|
|
6371
6564
|
* Connect methods used to connect to the calendar.
|
|
6372
6565
|
* @minSize 1
|
|
6373
6566
|
*/
|
|
6374
|
-
connectMethods?:
|
|
6567
|
+
connectMethods?: ConnectMethodWithLiterals[];
|
|
6375
6568
|
/** Whether the sync configuration can be updated. */
|
|
6376
6569
|
canUpdateSyncConfig?: boolean;
|
|
6377
6570
|
/** Whether events can be listed from the external calendar to the Wix calendar. */
|
|
6378
|
-
listEventFromCalendars?:
|
|
6571
|
+
listEventFromCalendars?: ListEventFromCalendarsWithLiterals;
|
|
6379
6572
|
/** Whether Wix calendar sessions can be synced to the external calendar. */
|
|
6380
|
-
syncToCalendar?:
|
|
6573
|
+
syncToCalendar?: SyncToCalendarWithLiterals;
|
|
6381
6574
|
}
|
|
6382
6575
|
export declare enum CalendarType {
|
|
6383
6576
|
UNDEFINED = "UNDEFINED",
|
|
@@ -6386,10 +6579,14 @@ export declare enum CalendarType {
|
|
|
6386
6579
|
MICROSOFT = "MICROSOFT",
|
|
6387
6580
|
OTHER = "OTHER"
|
|
6388
6581
|
}
|
|
6582
|
+
/** @enumType */
|
|
6583
|
+
export type CalendarTypeWithLiterals = CalendarType | 'UNDEFINED' | 'GOOGLE' | 'I_CAL' | 'MICROSOFT' | 'OTHER';
|
|
6389
6584
|
export declare enum ConnectMethod {
|
|
6390
6585
|
OAUTH = "OAUTH",
|
|
6391
6586
|
CREDENTIALS = "CREDENTIALS"
|
|
6392
6587
|
}
|
|
6588
|
+
/** @enumType */
|
|
6589
|
+
export type ConnectMethodWithLiterals = ConnectMethod | 'OAUTH' | 'CREDENTIALS';
|
|
6393
6590
|
export declare enum ListEventFromCalendars {
|
|
6394
6591
|
/** Listing events from the external calendar is not supported. */
|
|
6395
6592
|
LIST_NOT_SUPPORTED = "LIST_NOT_SUPPORTED",
|
|
@@ -6401,6 +6598,8 @@ export declare enum ListEventFromCalendars {
|
|
|
6401
6598
|
*/
|
|
6402
6599
|
LIST_FROM_SPECIFIC_CALENDARS = "LIST_FROM_SPECIFIC_CALENDARS"
|
|
6403
6600
|
}
|
|
6601
|
+
/** @enumType */
|
|
6602
|
+
export type ListEventFromCalendarsWithLiterals = ListEventFromCalendars | 'LIST_NOT_SUPPORTED' | 'LIST_FROM_PRIMARY_CALENDAR_ONLY' | 'LIST_FROM_SPECIFIC_CALENDARS';
|
|
6404
6603
|
export declare enum SyncToCalendar {
|
|
6405
6604
|
/** Syncing Wix calendar sessions to the external calendar is not supported. */
|
|
6406
6605
|
SYNC_NOT_SUPPORTED = "SYNC_NOT_SUPPORTED",
|
|
@@ -6409,6 +6608,8 @@ export declare enum SyncToCalendar {
|
|
|
6409
6608
|
/** Syncing Wix calendar sessions to a new external calendar. */
|
|
6410
6609
|
SYNC_TO_DEDICATED_CALENDAR = "SYNC_TO_DEDICATED_CALENDAR"
|
|
6411
6610
|
}
|
|
6611
|
+
/** @enumType */
|
|
6612
|
+
export type SyncToCalendarWithLiterals = SyncToCalendar | 'SYNC_NOT_SUPPORTED' | 'SYNC_TO_PRIMARY_CALENDAR_ONLY' | 'SYNC_TO_DEDICATED_CALENDAR';
|
|
6412
6613
|
export interface DefaultTaxGroupProviderConfig {
|
|
6413
6614
|
/** URI where the SPI Implementer is deployed */
|
|
6414
6615
|
deploymentUri?: string;
|
|
@@ -6456,9 +6657,9 @@ export interface HeadlessOAuth {
|
|
|
6456
6657
|
*/
|
|
6457
6658
|
logoutUrl?: string | null;
|
|
6458
6659
|
/** OAuth application type. */
|
|
6459
|
-
applicationType?:
|
|
6660
|
+
applicationType?: OAuthAppTypeWithLiterals;
|
|
6460
6661
|
/** OAuth technology used by the application. */
|
|
6461
|
-
technology?:
|
|
6662
|
+
technology?: OAuthTechnologiesWithLiterals;
|
|
6462
6663
|
}
|
|
6463
6664
|
/** Types of OAuth application. */
|
|
6464
6665
|
export declare enum OAuthAppType {
|
|
@@ -6471,6 +6672,8 @@ export declare enum OAuthAppType {
|
|
|
6471
6672
|
/** OAuth app type is some other type of application. */
|
|
6472
6673
|
OTHER = "OTHER"
|
|
6473
6674
|
}
|
|
6675
|
+
/** @enumType */
|
|
6676
|
+
export type OAuthAppTypeWithLiterals = OAuthAppType | 'OAUTH_APP_TYPE_UNSPECIFIED' | 'WEB_APP' | 'MOBILE' | 'OTHER';
|
|
6474
6677
|
/** OAuth technology used by the oauth application. */
|
|
6475
6678
|
export declare enum OAuthTechnologies {
|
|
6476
6679
|
/** The OAuth technology is not specified. */
|
|
@@ -6492,6 +6695,8 @@ export declare enum OAuthTechnologies {
|
|
|
6492
6695
|
/** OAuth technology using some other kind of technology. */
|
|
6493
6696
|
OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
|
|
6494
6697
|
}
|
|
6698
|
+
/** @enumType */
|
|
6699
|
+
export type OAuthTechnologiesWithLiterals = OAuthTechnologies | 'OAUTH_TECHNOLOGY_UNSPECIFIED' | 'JAVASCRIPT' | 'ANGULAR' | 'VUE' | 'REACT' | 'REACT_NATIVE' | 'IOS' | 'ANDROID' | 'OTHER_TECHNOLOGY';
|
|
6495
6700
|
export interface TaxCalculatorSpiConfig {
|
|
6496
6701
|
/** URI where the SPI Implementer is deployed */
|
|
6497
6702
|
deploymentUri?: string;
|
|
@@ -6566,7 +6771,7 @@ export interface ComponentReferenceDataConfig {
|
|
|
6566
6771
|
* @minSize 1
|
|
6567
6772
|
* @maxSize 100
|
|
6568
6773
|
*/
|
|
6569
|
-
supportedComponentTypes?:
|
|
6774
|
+
supportedComponentTypes?: ComponentTypeWithLiterals[];
|
|
6570
6775
|
}
|
|
6571
6776
|
/** Configuration for ReviewsProductCatalogProvider */
|
|
6572
6777
|
export interface ReviewsProductCatalogProviderConfig {
|
|
@@ -6601,7 +6806,7 @@ export interface SocialMarketingDesignsProviderConfig {
|
|
|
6601
6806
|
*/
|
|
6602
6807
|
iconUrl?: string;
|
|
6603
6808
|
/** How the Prover should be opened */
|
|
6604
|
-
navigationType?:
|
|
6809
|
+
navigationType?: NavigationTypeWithLiterals;
|
|
6605
6810
|
/** Is delete design implemented by the provider */
|
|
6606
6811
|
deleteDesignEnabled?: boolean;
|
|
6607
6812
|
/** If the provider manages designs */
|
|
@@ -6611,6 +6816,8 @@ export declare enum NavigationType {
|
|
|
6611
6816
|
NAVIGATE = "NAVIGATE",
|
|
6612
6817
|
MODAL = "MODAL"
|
|
6613
6818
|
}
|
|
6819
|
+
/** @enumType */
|
|
6820
|
+
export type NavigationTypeWithLiterals = NavigationType | 'NAVIGATE' | 'MODAL';
|
|
6614
6821
|
export interface GbpFeatureConfig {
|
|
6615
6822
|
baseUri?: SpiBaseUri;
|
|
6616
6823
|
}
|
|
@@ -6638,13 +6845,15 @@ export interface PingSettingsGroupComponentData {
|
|
|
6638
6845
|
/** the description of the setting group */
|
|
6639
6846
|
description?: string | null;
|
|
6640
6847
|
/** the default state of the setting group */
|
|
6641
|
-
state?:
|
|
6848
|
+
state?: PingSettingsGroupComponentDataStateWithLiterals;
|
|
6642
6849
|
}
|
|
6643
6850
|
export declare enum PingSettingsGroupComponentDataState {
|
|
6644
6851
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6645
6852
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6646
6853
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6647
6854
|
}
|
|
6855
|
+
/** @enumType */
|
|
6856
|
+
export type PingSettingsGroupComponentDataStateWithLiterals = PingSettingsGroupComponentDataState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6648
6857
|
export interface FormSpamSubmissionSpiConfig {
|
|
6649
6858
|
/** URI where the SPI Implementer is deployed */
|
|
6650
6859
|
baseUri?: SpiBaseUri;
|
|
@@ -6792,25 +7001,29 @@ export interface NotificationTopic {
|
|
|
6792
7001
|
/** the description of the topic */
|
|
6793
7002
|
description?: string | null;
|
|
6794
7003
|
/** the default state of the topic */
|
|
6795
|
-
state?:
|
|
7004
|
+
state?: NotificationTopicStateWithLiterals;
|
|
6796
7005
|
/** the type of the topic */
|
|
6797
|
-
type?:
|
|
7006
|
+
type?: NotificationTopicTypeWithLiterals;
|
|
6798
7007
|
/**
|
|
6799
7008
|
* The recipients' types indicate that this topic is relevant.
|
|
6800
7009
|
* @maxSize 10
|
|
6801
7010
|
*/
|
|
6802
|
-
supportedRecipientTypes?:
|
|
7011
|
+
supportedRecipientTypes?: RecipientTypeWithLiterals[];
|
|
6803
7012
|
}
|
|
6804
7013
|
export declare enum NotificationTopicState {
|
|
6805
7014
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6806
7015
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6807
7016
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6808
7017
|
}
|
|
7018
|
+
/** @enumType */
|
|
7019
|
+
export type NotificationTopicStateWithLiterals = NotificationTopicState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6809
7020
|
export declare enum NotificationTopicType {
|
|
6810
7021
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
6811
7022
|
PROMOTIONAL = "PROMOTIONAL",
|
|
6812
7023
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
6813
7024
|
}
|
|
7025
|
+
/** @enumType */
|
|
7026
|
+
export type NotificationTopicTypeWithLiterals = NotificationTopicType | 'UNKNOWN_TYPE' | 'PROMOTIONAL' | 'TRANSACTIONAL';
|
|
6814
7027
|
/** Recipient type */
|
|
6815
7028
|
export declare enum RecipientType {
|
|
6816
7029
|
/** Wix User */
|
|
@@ -6818,6 +7031,8 @@ export declare enum RecipientType {
|
|
|
6818
7031
|
/** Contact */
|
|
6819
7032
|
CONTACT = "CONTACT"
|
|
6820
7033
|
}
|
|
7034
|
+
/** @enumType */
|
|
7035
|
+
export type RecipientTypeWithLiterals = RecipientType | 'WIX_USER' | 'CONTACT';
|
|
6821
7036
|
export interface NotificationPreferencesFilterConfig {
|
|
6822
7037
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
6823
7038
|
baseUri?: SpiBaseUri;
|
|
@@ -7140,6 +7355,8 @@ export declare enum PlanFormPricingOption {
|
|
|
7140
7355
|
ONE_TIME = "ONE_TIME",
|
|
7141
7356
|
RECURRING = "RECURRING"
|
|
7142
7357
|
}
|
|
7358
|
+
/** @enumType */
|
|
7359
|
+
export type PlanFormPricingOptionWithLiterals = PlanFormPricingOption | 'FREE' | 'ONE_TIME' | 'RECURRING';
|
|
7143
7360
|
export declare enum PlanFormDefaultSection {
|
|
7144
7361
|
INFO = "INFO",
|
|
7145
7362
|
BENEFITS = "BENEFITS",
|
|
@@ -7147,6 +7364,8 @@ export declare enum PlanFormDefaultSection {
|
|
|
7147
7364
|
PRICING_AND_DURATION = "PRICING_AND_DURATION",
|
|
7148
7365
|
ADVANCED_SETTINGS = "ADVANCED_SETTINGS"
|
|
7149
7366
|
}
|
|
7367
|
+
/** @enumType */
|
|
7368
|
+
export type PlanFormDefaultSectionWithLiterals = PlanFormDefaultSection | 'INFO' | 'BENEFITS' | 'PAGE_PERMISSIONS' | 'PRICING_AND_DURATION' | 'ADVANCED_SETTINGS';
|
|
7150
7369
|
export interface Illustration extends IllustrationIllustrationOneOf {
|
|
7151
7370
|
/**
|
|
7152
7371
|
* Custom exported component ID to be rendered as an illustration.
|
|
@@ -7170,7 +7389,7 @@ export interface PlanDuration {
|
|
|
7170
7389
|
/** Amount of a duration `unit` in a single payment cycle. */
|
|
7171
7390
|
count?: number;
|
|
7172
7391
|
/** Unit of time for the cycle duration. */
|
|
7173
|
-
unit?:
|
|
7392
|
+
unit?: PlanPeriodUnitWithLiterals;
|
|
7174
7393
|
}
|
|
7175
7394
|
/** Pedefined basic time unit. */
|
|
7176
7395
|
export declare enum PlanPeriodUnit {
|
|
@@ -7179,6 +7398,8 @@ export declare enum PlanPeriodUnit {
|
|
|
7179
7398
|
MONTH = "MONTH",
|
|
7180
7399
|
YEAR = "YEAR"
|
|
7181
7400
|
}
|
|
7401
|
+
/** @enumType */
|
|
7402
|
+
export type PlanPeriodUnitWithLiterals = PlanPeriodUnit | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
7182
7403
|
export interface PlanPriceData {
|
|
7183
7404
|
/** Monetary amount. Decimal string with a period as a decimal separator. For example, `3.99`. */
|
|
7184
7405
|
value?: string;
|
|
@@ -7301,7 +7522,7 @@ export interface PlanFormPricingAndDurationSection {
|
|
|
7301
7522
|
* Order in which pricing options should be displayed.
|
|
7302
7523
|
* @maxSize 99
|
|
7303
7524
|
*/
|
|
7304
|
-
pricingOptionOrder?:
|
|
7525
|
+
pricingOptionOrder?: PlanFormPricingOptionWithLiterals[];
|
|
7305
7526
|
}
|
|
7306
7527
|
export interface PlanFormCustomSection {
|
|
7307
7528
|
/**
|
|
@@ -7315,14 +7536,14 @@ export interface PlanFormSection extends PlanFormSectionSectionOneOf {
|
|
|
7315
7536
|
/** Extension component ID. */
|
|
7316
7537
|
componentId?: string;
|
|
7317
7538
|
/** Default section name. */
|
|
7318
|
-
sectionName?:
|
|
7539
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7319
7540
|
}
|
|
7320
7541
|
/** @oneof */
|
|
7321
7542
|
export interface PlanFormSectionSectionOneOf {
|
|
7322
7543
|
/** Extension component ID. */
|
|
7323
7544
|
componentId?: string;
|
|
7324
7545
|
/** Default section name. */
|
|
7325
|
-
sectionName?:
|
|
7546
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7326
7547
|
}
|
|
7327
7548
|
export interface PlanFormTypeMetadata {
|
|
7328
7549
|
/** Configuration name. */
|
|
@@ -7389,7 +7610,7 @@ export interface UserNotificationData {
|
|
|
7389
7610
|
/** icon */
|
|
7390
7611
|
icon?: Icon;
|
|
7391
7612
|
/** intent */
|
|
7392
|
-
intent?:
|
|
7613
|
+
intent?: IntentWithLiterals;
|
|
7393
7614
|
/** limiter field */
|
|
7394
7615
|
limiterField?: LimiterField;
|
|
7395
7616
|
/** recipient filter */
|
|
@@ -7403,7 +7624,7 @@ export interface UserNotificationData {
|
|
|
7403
7624
|
/** context */
|
|
7404
7625
|
context?: UserNotificationDataContext;
|
|
7405
7626
|
/** type */
|
|
7406
|
-
type?:
|
|
7627
|
+
type?: UserNotificationDataTypeWithLiterals;
|
|
7407
7628
|
}
|
|
7408
7629
|
export interface TypedDynamicParam {
|
|
7409
7630
|
/**
|
|
@@ -7412,16 +7633,20 @@ export interface TypedDynamicParam {
|
|
|
7412
7633
|
*/
|
|
7413
7634
|
name?: string;
|
|
7414
7635
|
/** dynamic param type */
|
|
7415
|
-
dynamicParamType?:
|
|
7636
|
+
dynamicParamType?: TypedDynamicParamTypeWithLiterals;
|
|
7416
7637
|
}
|
|
7417
7638
|
export declare enum TypedDynamicParamType {
|
|
7418
7639
|
STRING = "STRING",
|
|
7419
7640
|
ARRAY = "ARRAY"
|
|
7420
7641
|
}
|
|
7642
|
+
/** @enumType */
|
|
7643
|
+
export type TypedDynamicParamTypeWithLiterals = TypedDynamicParamType | 'STRING' | 'ARRAY';
|
|
7421
7644
|
export declare enum UserNotificationDataRecipientFilterType {
|
|
7422
7645
|
WIX_USERS = "WIX_USERS",
|
|
7423
7646
|
SITE_CONTRIBUTORS = "SITE_CONTRIBUTORS"
|
|
7424
7647
|
}
|
|
7648
|
+
/** @enumType */
|
|
7649
|
+
export type UserNotificationDataRecipientFilterTypeWithLiterals = UserNotificationDataRecipientFilterType | 'WIX_USERS' | 'SITE_CONTRIBUTORS';
|
|
7425
7650
|
export interface WixUsersData {
|
|
7426
7651
|
/** id */
|
|
7427
7652
|
id?: TypedDynamicParam;
|
|
@@ -7434,6 +7659,8 @@ export declare enum InitiatorType {
|
|
|
7434
7659
|
WIX_USER = "WIX_USER",
|
|
7435
7660
|
WIX_APP = "WIX_APP"
|
|
7436
7661
|
}
|
|
7662
|
+
/** @enumType */
|
|
7663
|
+
export type InitiatorTypeWithLiterals = InitiatorType | 'WIX_USER' | 'WIX_APP';
|
|
7437
7664
|
export interface WixUserData {
|
|
7438
7665
|
/**
|
|
7439
7666
|
* dynamic param name
|
|
@@ -7482,6 +7709,8 @@ export declare enum Level {
|
|
|
7482
7709
|
ACCOUNT = "ACCOUNT",
|
|
7483
7710
|
SITE = "SITE"
|
|
7484
7711
|
}
|
|
7712
|
+
/** @enumType */
|
|
7713
|
+
export type LevelWithLiterals = Level | 'ACCOUNT' | 'SITE';
|
|
7485
7714
|
export interface OrderValue {
|
|
7486
7715
|
/** can be const/dynamicParamName */
|
|
7487
7716
|
value?: ConstOrDynamicParam;
|
|
@@ -7597,7 +7826,7 @@ export interface Icon extends IconDataOneOf {
|
|
|
7597
7826
|
/** url data */
|
|
7598
7827
|
urlData?: UrlData;
|
|
7599
7828
|
/** icon type */
|
|
7600
|
-
type?:
|
|
7829
|
+
type?: IconTypeWithLiterals;
|
|
7601
7830
|
}
|
|
7602
7831
|
/** @oneof */
|
|
7603
7832
|
export interface IconDataOneOf {
|
|
@@ -7609,6 +7838,8 @@ export declare enum IconType {
|
|
|
7609
7838
|
SPOUT = "SPOUT",
|
|
7610
7839
|
INITIATOR = "INITIATOR"
|
|
7611
7840
|
}
|
|
7841
|
+
/** @enumType */
|
|
7842
|
+
export type IconTypeWithLiterals = IconType | 'URL' | 'SPOUT' | 'INITIATOR';
|
|
7612
7843
|
export interface UrlData {
|
|
7613
7844
|
/**
|
|
7614
7845
|
* actual url
|
|
@@ -7636,7 +7867,7 @@ export interface SharedPlatformMobilePushConfig {
|
|
|
7636
7867
|
/** ttl */
|
|
7637
7868
|
ttl?: number | null;
|
|
7638
7869
|
/** target application */
|
|
7639
|
-
targetApplication?:
|
|
7870
|
+
targetApplication?: MobileApplicationWithLiterals;
|
|
7640
7871
|
}
|
|
7641
7872
|
export declare enum MobileApplication {
|
|
7642
7873
|
UNKNOWN_MOBILE_APPLICATION = "UNKNOWN_MOBILE_APPLICATION",
|
|
@@ -7650,11 +7881,13 @@ export declare enum MobileApplication {
|
|
|
7650
7881
|
WIX_STUDIO = "WIX_STUDIO",
|
|
7651
7882
|
NO_SPECIFIC_TARGET_APP = "NO_SPECIFIC_TARGET_APP"
|
|
7652
7883
|
}
|
|
7884
|
+
/** @enumType */
|
|
7885
|
+
export type MobileApplicationWithLiterals = MobileApplication | 'UNKNOWN_MOBILE_APPLICATION' | 'OWNER' | 'SPACES' | 'DINE' | 'FITNESS' | 'WIX_LIFE' | 'WIX_PARTNERS' | 'BRANDED' | 'WIX_STUDIO' | 'NO_SPECIFIC_TARGET_APP';
|
|
7653
7886
|
export interface AndroidMobilePushConfig {
|
|
7654
7887
|
/** sub group key */
|
|
7655
7888
|
subGroupKey?: string | null;
|
|
7656
7889
|
/** style */
|
|
7657
|
-
style?:
|
|
7890
|
+
style?: AndroidStyleWithLiterals;
|
|
7658
7891
|
/** grouped deeplink pattern */
|
|
7659
7892
|
groupedDeeplinkPattern?: string | null;
|
|
7660
7893
|
}
|
|
@@ -7663,6 +7896,8 @@ export declare enum AndroidStyle {
|
|
|
7663
7896
|
MESSAGING = "MESSAGING",
|
|
7664
7897
|
INBOX = "INBOX"
|
|
7665
7898
|
}
|
|
7899
|
+
/** @enumType */
|
|
7900
|
+
export type AndroidStyleWithLiterals = AndroidStyle | 'BIG_TEXT' | 'MESSAGING' | 'INBOX';
|
|
7666
7901
|
export interface MobilePushChannelConfig {
|
|
7667
7902
|
/** shared */
|
|
7668
7903
|
shared?: SharedPlatformMobilePushConfig;
|
|
@@ -7687,7 +7922,7 @@ export interface ExposureRule extends ExposureRuleRuleOneOf {
|
|
|
7687
7922
|
/** custom experiment exposure rule */
|
|
7688
7923
|
customExperimentExposureRule?: CustomExperimentExposureRule;
|
|
7689
7924
|
/** type */
|
|
7690
|
-
type?:
|
|
7925
|
+
type?: ExposureRuleTypeWithLiterals;
|
|
7691
7926
|
}
|
|
7692
7927
|
/** @oneof */
|
|
7693
7928
|
export interface ExposureRuleRuleOneOf {
|
|
@@ -7702,6 +7937,8 @@ export declare enum ExposureRuleType {
|
|
|
7702
7937
|
BOOLEAN_EXPERIMENT = "BOOLEAN_EXPERIMENT",
|
|
7703
7938
|
CUSTOM_EXPERIMENT = "CUSTOM_EXPERIMENT"
|
|
7704
7939
|
}
|
|
7940
|
+
/** @enumType */
|
|
7941
|
+
export type ExposureRuleTypeWithLiterals = ExposureRuleType | 'OPEN_TO_ALL' | 'OPEN_TO_NONE' | 'BOOLEAN_EXPERIMENT' | 'CUSTOM_EXPERIMENT';
|
|
7705
7942
|
export interface BooleanExperimentExposureRule {
|
|
7706
7943
|
/** spec */
|
|
7707
7944
|
spec?: string;
|
|
@@ -7762,6 +7999,8 @@ export declare enum Intent {
|
|
|
7762
7999
|
MARKETING = "MARKETING",
|
|
7763
8000
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
7764
8001
|
}
|
|
8002
|
+
/** @enumType */
|
|
8003
|
+
export type IntentWithLiterals = Intent | 'MARKETING' | 'TRANSACTIONAL';
|
|
7765
8004
|
export interface LimiterField {
|
|
7766
8005
|
/** dynamic param name */
|
|
7767
8006
|
dynamicParamName?: string;
|
|
@@ -7772,7 +8011,7 @@ export interface UserNotificationDataRecipientFilter extends UserNotificationDat
|
|
|
7772
8011
|
/** site contributors data */
|
|
7773
8012
|
siteContributorsData?: SiteContributorsData;
|
|
7774
8013
|
/** recipient filter type */
|
|
7775
|
-
type?:
|
|
8014
|
+
type?: UserNotificationDataRecipientFilterTypeWithLiterals;
|
|
7776
8015
|
}
|
|
7777
8016
|
/** @oneof */
|
|
7778
8017
|
export interface UserNotificationDataRecipientFilterDataOneOf {
|
|
@@ -7785,7 +8024,7 @@ export interface UserNotificationDataInitiator extends UserNotificationDataIniti
|
|
|
7785
8024
|
/** wix user data */
|
|
7786
8025
|
wixUserData?: WixUserData;
|
|
7787
8026
|
/** initiator type */
|
|
7788
|
-
type?:
|
|
8027
|
+
type?: InitiatorTypeWithLiterals;
|
|
7789
8028
|
}
|
|
7790
8029
|
/** @oneof */
|
|
7791
8030
|
export interface UserNotificationDataInitiatorDataOneOf {
|
|
@@ -7802,7 +8041,7 @@ export interface UserNotificationDataDeeplinkOfOneOf {
|
|
|
7802
8041
|
url?: Url;
|
|
7803
8042
|
}
|
|
7804
8043
|
export interface UserNotificationDataContext {
|
|
7805
|
-
level?:
|
|
8044
|
+
level?: LevelWithLiterals;
|
|
7806
8045
|
/** params */
|
|
7807
8046
|
params?: Record<string, OrderValue>;
|
|
7808
8047
|
}
|
|
@@ -7811,6 +8050,8 @@ export declare enum UserNotificationDataType {
|
|
|
7811
8050
|
ALERT_WARNING = "ALERT_WARNING",
|
|
7812
8051
|
ALERT_INFO = "ALERT_INFO"
|
|
7813
8052
|
}
|
|
8053
|
+
/** @enumType */
|
|
8054
|
+
export type UserNotificationDataTypeWithLiterals = UserNotificationDataType | 'REGULAR' | 'ALERT_WARNING' | 'ALERT_INFO';
|
|
7814
8055
|
/** Describes contact notifications */
|
|
7815
8056
|
export interface ContactNotification {
|
|
7816
8057
|
/** @format GUID */
|
|
@@ -7851,6 +8092,8 @@ export declare enum RecipientFilterType {
|
|
|
7851
8092
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
7852
8093
|
CONTACTS = "CONTACTS"
|
|
7853
8094
|
}
|
|
8095
|
+
/** @enumType */
|
|
8096
|
+
export type RecipientFilterTypeWithLiterals = RecipientFilterType | 'UNKNOWN_TYPE' | 'CONTACTS';
|
|
7854
8097
|
export interface ContactsData {
|
|
7855
8098
|
/** id */
|
|
7856
8099
|
id?: TypedDynamicParam;
|
|
@@ -7860,6 +8103,8 @@ export declare enum Type {
|
|
|
7860
8103
|
CONTACT = "CONTACT",
|
|
7861
8104
|
SITE_MEMBER = "SITE_MEMBER"
|
|
7862
8105
|
}
|
|
8106
|
+
/** @enumType */
|
|
8107
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'CONTACT' | 'SITE_MEMBER';
|
|
7863
8108
|
export interface ContactData {
|
|
7864
8109
|
/**
|
|
7865
8110
|
* dynamic param name
|
|
@@ -7890,7 +8135,7 @@ export interface RecipientFilter extends RecipientFilterDataOneOf {
|
|
|
7890
8135
|
/** contacts data */
|
|
7891
8136
|
contactsData?: ContactsData;
|
|
7892
8137
|
/** recipient filter type */
|
|
7893
|
-
type?:
|
|
8138
|
+
type?: RecipientFilterTypeWithLiterals;
|
|
7894
8139
|
}
|
|
7895
8140
|
/** @oneof */
|
|
7896
8141
|
export interface RecipientFilterDataOneOf {
|
|
@@ -7903,7 +8148,7 @@ export interface Initiator extends InitiatorDataOneOf {
|
|
|
7903
8148
|
/** site member data */
|
|
7904
8149
|
siteMemberData?: SiteMemberData;
|
|
7905
8150
|
/** initiator type */
|
|
7906
|
-
type?:
|
|
8151
|
+
type?: TypeWithLiterals;
|
|
7907
8152
|
}
|
|
7908
8153
|
/** @oneof */
|
|
7909
8154
|
export interface InitiatorDataOneOf {
|
|
@@ -8021,7 +8266,7 @@ export interface CommentsContextProviderConfig {
|
|
|
8021
8266
|
/** URI where the SPI Implementer is deployed */
|
|
8022
8267
|
baseUri?: SpiBaseUri;
|
|
8023
8268
|
/** Comments Environment */
|
|
8024
|
-
environment?:
|
|
8269
|
+
environment?: EnvironmentWithLiterals;
|
|
8025
8270
|
/** Feature toggle to indicate if method GetCommentContextResources is implemented */
|
|
8026
8271
|
toggleResourceProviderEnabled?: boolean;
|
|
8027
8272
|
}
|
|
@@ -8029,6 +8274,8 @@ export declare enum Environment {
|
|
|
8029
8274
|
LIVE_SITE = "LIVE_SITE",
|
|
8030
8275
|
BUSINESS_MANAGER = "BUSINESS_MANAGER"
|
|
8031
8276
|
}
|
|
8277
|
+
/** @enumType */
|
|
8278
|
+
export type EnvironmentWithLiterals = Environment | 'LIVE_SITE' | 'BUSINESS_MANAGER';
|
|
8032
8279
|
export interface FormSpamSubmissionReportSpiConfig {
|
|
8033
8280
|
/** URI where the SPI Implementer is deployed */
|
|
8034
8281
|
baseUri?: SpiBaseUri;
|
|
@@ -8250,7 +8497,7 @@ export interface SchemaKey {
|
|
|
8250
8497
|
* + `SITE`: A custom schema for a specific site.
|
|
8251
8498
|
* @immutable
|
|
8252
8499
|
*/
|
|
8253
|
-
scope?:
|
|
8500
|
+
scope?: SchemaScopeWithLiterals;
|
|
8254
8501
|
}
|
|
8255
8502
|
export declare enum SchemaScope {
|
|
8256
8503
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
@@ -8259,6 +8506,8 @@ export declare enum SchemaScope {
|
|
|
8259
8506
|
/** Custom schema for a specific site. */
|
|
8260
8507
|
SITE = "SITE"
|
|
8261
8508
|
}
|
|
8509
|
+
/** @enumType */
|
|
8510
|
+
export type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
|
|
8262
8511
|
export interface V1SchemaField {
|
|
8263
8512
|
/**
|
|
8264
8513
|
* 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 `^[^)(\\]\\[\\.]+$`.
|
|
@@ -8268,7 +8517,7 @@ export interface V1SchemaField {
|
|
|
8268
8517
|
*/
|
|
8269
8518
|
id?: string;
|
|
8270
8519
|
/** **Required.** Field type. */
|
|
8271
|
-
type?:
|
|
8520
|
+
type?: SchemaFieldFieldTypeWithLiterals;
|
|
8272
8521
|
/**
|
|
8273
8522
|
* Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager).
|
|
8274
8523
|
* @maxLength 1000
|
|
@@ -8322,6 +8571,8 @@ export declare enum SchemaFieldFieldType {
|
|
|
8322
8571
|
/** Wix Media Manager document. */
|
|
8323
8572
|
DOCUMENT = "DOCUMENT"
|
|
8324
8573
|
}
|
|
8574
|
+
/** @enumType */
|
|
8575
|
+
export type SchemaFieldFieldTypeWithLiterals = SchemaFieldFieldType | 'UNDEFINED_TYPE' | 'SHORT_TEXT' | 'LONG_TEXT' | 'HTML' | 'RICH_CONTENT' | 'IMAGE' | 'IMAGE_LINK' | 'VIDEO' | 'DOCUMENT';
|
|
8325
8576
|
export interface PreviewFields {
|
|
8326
8577
|
/**
|
|
8327
8578
|
* ID of the field representing the schema's title.
|
|
@@ -8393,7 +8644,7 @@ export interface BackOfficeModal extends BackOfficeModalContentOneOf {
|
|
|
8393
8644
|
*
|
|
8394
8645
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8395
8646
|
*/
|
|
8396
|
-
hostingPlatform?:
|
|
8647
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8397
8648
|
/**
|
|
8398
8649
|
* Modal title.
|
|
8399
8650
|
* @minLength 1
|
|
@@ -8480,7 +8731,7 @@ export interface WidgetData {
|
|
|
8480
8731
|
*/
|
|
8481
8732
|
tagName?: string;
|
|
8482
8733
|
/** Type of JavaScript modularization approach used in the custom element */
|
|
8483
|
-
scriptType?:
|
|
8734
|
+
scriptType?: CustomElementScriptTypeWithLiterals;
|
|
8484
8735
|
}
|
|
8485
8736
|
export declare enum CustomElementScriptType {
|
|
8486
8737
|
NONE = "NONE",
|
|
@@ -8489,6 +8740,8 @@ export declare enum CustomElementScriptType {
|
|
|
8489
8740
|
/** ES Module modularization approach */
|
|
8490
8741
|
ES_MODULE = "ES_MODULE"
|
|
8491
8742
|
}
|
|
8743
|
+
/** @enumType */
|
|
8744
|
+
export type CustomElementScriptTypeWithLiterals = CustomElementScriptType | 'NONE' | 'COMMON_JS' | 'ES_MODULE';
|
|
8492
8745
|
export interface EditorBehaviors {
|
|
8493
8746
|
/** The settings behavior definition for the widget */
|
|
8494
8747
|
settings?: SettingsPanel;
|
|
@@ -8522,9 +8775,11 @@ export declare enum HeightMode {
|
|
|
8522
8775
|
/** Height is fixed require size in px */
|
|
8523
8776
|
FIXED = "FIXED"
|
|
8524
8777
|
}
|
|
8778
|
+
/** @enumType */
|
|
8779
|
+
export type HeightModeWithLiterals = HeightMode | 'UNKNOWN' | 'AUTO' | 'FIXED';
|
|
8525
8780
|
export interface WidgetSizeHeight {
|
|
8526
8781
|
/** Height calculation mode */
|
|
8527
|
-
heightMode?:
|
|
8782
|
+
heightMode?: HeightModeWithLiterals;
|
|
8528
8783
|
/**
|
|
8529
8784
|
* Default height in pixels
|
|
8530
8785
|
* @max 9999
|
|
@@ -8592,7 +8847,7 @@ export interface BackOfficeExtensionWidget extends BackOfficeExtensionWidgetAsse
|
|
|
8592
8847
|
*
|
|
8593
8848
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8594
8849
|
*/
|
|
8595
|
-
hostingPlatform?:
|
|
8850
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8596
8851
|
/**
|
|
8597
8852
|
* Slot ID for the plugin's container.
|
|
8598
8853
|
* @format GUID
|
|
@@ -8624,7 +8879,7 @@ export interface BackOfficeExtensionMenuItem {
|
|
|
8624
8879
|
*
|
|
8625
8880
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8626
8881
|
*/
|
|
8627
|
-
hostingPlatform?:
|
|
8882
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8628
8883
|
/**
|
|
8629
8884
|
* Slot ID for the plugin's container.
|
|
8630
8885
|
* @format GUID
|
|
@@ -8728,7 +8983,7 @@ export interface FormTemplate extends FormTemplateTemplateTypeOptionsOneOf {
|
|
|
8728
8983
|
* Specifies the template purpose
|
|
8729
8984
|
* @immutable
|
|
8730
8985
|
*/
|
|
8731
|
-
templateType?:
|
|
8986
|
+
templateType?: TemplateTypeWithLiterals;
|
|
8732
8987
|
/**
|
|
8733
8988
|
* Date of creation.
|
|
8734
8989
|
* @readonly
|
|
@@ -8777,7 +9032,7 @@ export interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
8777
9032
|
* Type of the field
|
|
8778
9033
|
* @readonly
|
|
8779
9034
|
*/
|
|
8780
|
-
fieldType?:
|
|
9035
|
+
fieldType?: FieldTypeWithLiterals;
|
|
8781
9036
|
}
|
|
8782
9037
|
/** @oneof */
|
|
8783
9038
|
export interface FieldFieldTypeOptionsOneOf {
|
|
@@ -8791,6 +9046,8 @@ export declare enum FieldType {
|
|
|
8791
9046
|
INPUT = "INPUT",
|
|
8792
9047
|
DISPLAY = "DISPLAY"
|
|
8793
9048
|
}
|
|
9049
|
+
/** @enumType */
|
|
9050
|
+
export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
|
|
8794
9051
|
export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
8795
9052
|
/** Input return string as value */
|
|
8796
9053
|
stringOptions?: _String;
|
|
@@ -8829,7 +9086,7 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
8829
9086
|
* Type of the input field
|
|
8830
9087
|
* @readonly
|
|
8831
9088
|
*/
|
|
8832
|
-
inputType?:
|
|
9089
|
+
inputType?: InputTypeWithLiterals;
|
|
8833
9090
|
/** Mapping to contacts, telling to what contact property field input value should be saved. */
|
|
8834
9091
|
contactMapping?: FormFieldContactInfo;
|
|
8835
9092
|
/**
|
|
@@ -8884,7 +9141,7 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
8884
9141
|
*/
|
|
8885
9142
|
pattern?: string | null;
|
|
8886
9143
|
/** Format of a string. */
|
|
8887
|
-
format?:
|
|
9144
|
+
format?: FormatWithLiterals;
|
|
8888
9145
|
/**
|
|
8889
9146
|
* List of allowed values.
|
|
8890
9147
|
* @maxSize 500
|
|
@@ -8921,6 +9178,8 @@ export declare enum Format {
|
|
|
8921
9178
|
LANGUAGE = "LANGUAGE",
|
|
8922
9179
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
8923
9180
|
}
|
|
9181
|
+
/** @enumType */
|
|
9182
|
+
export type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
|
|
8924
9183
|
export interface DateTimeConstraints {
|
|
8925
9184
|
/**
|
|
8926
9185
|
* Support static constrains defined as ISO date/time format, as well as
|
|
@@ -8958,6 +9217,8 @@ export declare enum StringComponentType {
|
|
|
8958
9217
|
TIME_INPUT = "TIME_INPUT",
|
|
8959
9218
|
DATE_PICKER = "DATE_PICKER"
|
|
8960
9219
|
}
|
|
9220
|
+
/** @enumType */
|
|
9221
|
+
export type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER';
|
|
8961
9222
|
export interface TextInput {
|
|
8962
9223
|
/**
|
|
8963
9224
|
* Label of the field
|
|
@@ -9007,7 +9268,7 @@ export interface RadioGroup {
|
|
|
9007
9268
|
* Specifies the number of columns used to display the selections within the component.
|
|
9008
9269
|
* Default: ONE
|
|
9009
9270
|
*/
|
|
9010
|
-
numberOfColumns?:
|
|
9271
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9011
9272
|
}
|
|
9012
9273
|
export interface RadioGroupOption {
|
|
9013
9274
|
/**
|
|
@@ -9053,6 +9314,8 @@ export declare enum NumberOfColumns {
|
|
|
9053
9314
|
/** Three columns. */
|
|
9054
9315
|
THREE = "THREE"
|
|
9055
9316
|
}
|
|
9317
|
+
/** @enumType */
|
|
9318
|
+
export type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
|
|
9056
9319
|
export interface Dropdown {
|
|
9057
9320
|
/**
|
|
9058
9321
|
* Label of the field
|
|
@@ -9242,7 +9505,7 @@ export interface DatePicker {
|
|
|
9242
9505
|
*/
|
|
9243
9506
|
placeholder?: string | null;
|
|
9244
9507
|
/** First day of the week displayed on date picker. */
|
|
9245
|
-
firstDayOfWeek?:
|
|
9508
|
+
firstDayOfWeek?: FirstDayOfWeekWithLiterals;
|
|
9246
9509
|
/**
|
|
9247
9510
|
* Default value for the date picker.
|
|
9248
9511
|
* @format LOCAL_DATE
|
|
@@ -9255,6 +9518,8 @@ export declare enum FirstDayOfWeek {
|
|
|
9255
9518
|
/** First day of the week is Sunday. */
|
|
9256
9519
|
SUNDAY = "SUNDAY"
|
|
9257
9520
|
}
|
|
9521
|
+
/** @enumType */
|
|
9522
|
+
export type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
|
|
9258
9523
|
export interface NumberType {
|
|
9259
9524
|
/** Inclusive maximum value. */
|
|
9260
9525
|
maximum?: number | null;
|
|
@@ -9273,6 +9538,8 @@ export declare enum NumberComponentType {
|
|
|
9273
9538
|
NUMBER_INPUT = "NUMBER_INPUT",
|
|
9274
9539
|
RATING_INPUT = "RATING_INPUT"
|
|
9275
9540
|
}
|
|
9541
|
+
/** @enumType */
|
|
9542
|
+
export type NumberComponentTypeWithLiterals = NumberComponentType | 'UNKNOWN' | 'NUMBER_INPUT' | 'RATING_INPUT';
|
|
9276
9543
|
export interface NumberInput {
|
|
9277
9544
|
/**
|
|
9278
9545
|
* Label of the field
|
|
@@ -9325,6 +9592,8 @@ export declare enum BooleanComponentType {
|
|
|
9325
9592
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9326
9593
|
CHECKBOX = "CHECKBOX"
|
|
9327
9594
|
}
|
|
9595
|
+
/** @enumType */
|
|
9596
|
+
export type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
|
|
9328
9597
|
export interface Checkbox {
|
|
9329
9598
|
/** Label of the field */
|
|
9330
9599
|
label?: RichContent;
|
|
@@ -9356,6 +9625,8 @@ export declare enum ItemType {
|
|
|
9356
9625
|
INTEGER = "INTEGER",
|
|
9357
9626
|
OBJECT = "OBJECT"
|
|
9358
9627
|
}
|
|
9628
|
+
/** @enumType */
|
|
9629
|
+
export type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'OBJECT';
|
|
9359
9630
|
export interface IntegerType {
|
|
9360
9631
|
/** Maximum value. */
|
|
9361
9632
|
maximum?: number | null;
|
|
@@ -9381,6 +9652,8 @@ export declare enum PropertiesTypeEnum {
|
|
|
9381
9652
|
INTEGER = "INTEGER",
|
|
9382
9653
|
ARRAY = "ARRAY"
|
|
9383
9654
|
}
|
|
9655
|
+
/** @enumType */
|
|
9656
|
+
export type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'ARRAY';
|
|
9384
9657
|
export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
|
|
9385
9658
|
/** String type validation for property. */
|
|
9386
9659
|
stringOptions?: StringType;
|
|
@@ -9396,7 +9669,7 @@ export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf
|
|
|
9396
9669
|
* Type of object properties
|
|
9397
9670
|
* @readonly
|
|
9398
9671
|
*/
|
|
9399
|
-
propertiesType?:
|
|
9672
|
+
propertiesType?: PropertiesTypeEnumWithLiterals;
|
|
9400
9673
|
/** Whether the property is required. */
|
|
9401
9674
|
required?: boolean;
|
|
9402
9675
|
}
|
|
@@ -9428,7 +9701,7 @@ export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsO
|
|
|
9428
9701
|
* Type of array items
|
|
9429
9702
|
* @readonly
|
|
9430
9703
|
*/
|
|
9431
|
-
itemType?:
|
|
9704
|
+
itemType?: ItemTypeWithLiterals;
|
|
9432
9705
|
}
|
|
9433
9706
|
/** @oneof */
|
|
9434
9707
|
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -9447,6 +9720,8 @@ export declare enum ArrayComponentType {
|
|
|
9447
9720
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9448
9721
|
CHECKBOX_GROUP = "CHECKBOX_GROUP"
|
|
9449
9722
|
}
|
|
9723
|
+
/** @enumType */
|
|
9724
|
+
export type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP';
|
|
9450
9725
|
export interface CheckboxGroup {
|
|
9451
9726
|
/**
|
|
9452
9727
|
* Label of the field
|
|
@@ -9471,7 +9746,7 @@ export interface CheckboxGroup {
|
|
|
9471
9746
|
* Specifies the number of columns used to display the selections within the component.
|
|
9472
9747
|
* Default: ONE
|
|
9473
9748
|
*/
|
|
9474
|
-
numberOfColumns?:
|
|
9749
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9475
9750
|
}
|
|
9476
9751
|
export interface MediaItem extends MediaItemMediaOneOf {
|
|
9477
9752
|
/** WixMedia image. */
|
|
@@ -9551,6 +9826,8 @@ export declare enum WixFileComponentType {
|
|
|
9551
9826
|
FILE_UPLOAD = "FILE_UPLOAD",
|
|
9552
9827
|
SIGNATURE = "SIGNATURE"
|
|
9553
9828
|
}
|
|
9829
|
+
/** @enumType */
|
|
9830
|
+
export type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
|
|
9554
9831
|
export interface FileUpload {
|
|
9555
9832
|
/**
|
|
9556
9833
|
* Selectable option label
|
|
@@ -9579,7 +9856,7 @@ export interface FileUpload {
|
|
|
9579
9856
|
* Supported file formats for upload
|
|
9580
9857
|
* @maxSize 5
|
|
9581
9858
|
*/
|
|
9582
|
-
uploadFileFormats?:
|
|
9859
|
+
uploadFileFormats?: UploadFileFormatWithLiterals[];
|
|
9583
9860
|
/**
|
|
9584
9861
|
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
9585
9862
|
* @maxLength 255
|
|
@@ -9600,6 +9877,8 @@ export declare enum UploadFileFormat {
|
|
|
9600
9877
|
/** Archive files. */
|
|
9601
9878
|
ARCHIVE = "ARCHIVE"
|
|
9602
9879
|
}
|
|
9880
|
+
/** @enumType */
|
|
9881
|
+
export type UploadFileFormatWithLiterals = UploadFileFormat | 'UNDEFINED' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
|
|
9603
9882
|
export interface Signature {
|
|
9604
9883
|
/**
|
|
9605
9884
|
* Selectable option label
|
|
@@ -9621,6 +9900,8 @@ export declare enum PaymentComponentType {
|
|
|
9621
9900
|
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
9622
9901
|
DONATION_INPUT = "DONATION_INPUT"
|
|
9623
9902
|
}
|
|
9903
|
+
/** @enumType */
|
|
9904
|
+
export type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT';
|
|
9624
9905
|
export interface PaymentType {
|
|
9625
9906
|
/**
|
|
9626
9907
|
* Field mapped to products.
|
|
@@ -9646,6 +9927,8 @@ export declare enum ProductType {
|
|
|
9646
9927
|
/** Digital. */
|
|
9647
9928
|
DIGITAL = "DIGITAL"
|
|
9648
9929
|
}
|
|
9930
|
+
/** @enumType */
|
|
9931
|
+
export type ProductTypeWithLiterals = ProductType | 'UNKNOWN' | 'SHIPPABLE' | 'DIGITAL';
|
|
9649
9932
|
export declare enum PriceType {
|
|
9650
9933
|
UNKNOWN = "UNKNOWN",
|
|
9651
9934
|
/** Fixed price. */
|
|
@@ -9653,6 +9936,8 @@ export declare enum PriceType {
|
|
|
9653
9936
|
/** Dynamic price from price range. */
|
|
9654
9937
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
9655
9938
|
}
|
|
9939
|
+
/** @enumType */
|
|
9940
|
+
export type PriceTypeWithLiterals = PriceType | 'UNKNOWN' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
|
|
9656
9941
|
export interface QuantityLimit {
|
|
9657
9942
|
/**
|
|
9658
9943
|
* Minimum quantity.
|
|
@@ -9698,9 +9983,9 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
9698
9983
|
*/
|
|
9699
9984
|
id?: string;
|
|
9700
9985
|
/** Product type. */
|
|
9701
|
-
productType?:
|
|
9986
|
+
productType?: ProductTypeWithLiterals;
|
|
9702
9987
|
/** Price type. */
|
|
9703
|
-
priceType?:
|
|
9988
|
+
priceType?: PriceTypeWithLiterals;
|
|
9704
9989
|
/** Quantity limit. */
|
|
9705
9990
|
quantityLimit?: QuantityLimit;
|
|
9706
9991
|
}
|
|
@@ -9733,7 +10018,7 @@ export interface ProductCheckboxGroup {
|
|
|
9733
10018
|
* Defines how an image should be resized to fit within its option.
|
|
9734
10019
|
* Default: COVER
|
|
9735
10020
|
*/
|
|
9736
|
-
imageFit?:
|
|
10021
|
+
imageFit?: ImageFitWithLiterals;
|
|
9737
10022
|
}
|
|
9738
10023
|
export interface ProductCheckboxGroupOption {
|
|
9739
10024
|
/**
|
|
@@ -9761,6 +10046,8 @@ export declare enum ImageFit {
|
|
|
9761
10046
|
/** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
|
|
9762
10047
|
CONTAIN = "CONTAIN"
|
|
9763
10048
|
}
|
|
10049
|
+
/** @enumType */
|
|
10050
|
+
export type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
|
|
9764
10051
|
export interface DonationInput {
|
|
9765
10052
|
/**
|
|
9766
10053
|
* Label of the field.
|
|
@@ -9780,7 +10067,7 @@ export interface DonationInput {
|
|
|
9780
10067
|
* Specifies the number of columns used to display the selections within the component.
|
|
9781
10068
|
* Default: ONE
|
|
9782
10069
|
*/
|
|
9783
|
-
numberOfColumns?:
|
|
10070
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9784
10071
|
/**
|
|
9785
10072
|
* Flag identifying to hide or not label
|
|
9786
10073
|
* Default: true
|
|
@@ -9812,6 +10099,8 @@ export declare enum MultilineAddressComponentType {
|
|
|
9812
10099
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9813
10100
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9814
10101
|
}
|
|
10102
|
+
/** @enumType */
|
|
10103
|
+
export type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
|
|
9815
10104
|
export interface MultilineAddressValidation {
|
|
9816
10105
|
/**
|
|
9817
10106
|
* Allowed countries. No countries treated as all.
|
|
@@ -9869,6 +10158,8 @@ export declare enum DefaultCountryConfigType {
|
|
|
9869
10158
|
/** Pre-selected default country. */
|
|
9870
10159
|
COUNTRY = "COUNTRY"
|
|
9871
10160
|
}
|
|
10161
|
+
/** @enumType */
|
|
10162
|
+
export type DefaultCountryConfigTypeWithLiterals = DefaultCountryConfigType | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
|
|
9872
10163
|
export interface AddressLine2 {
|
|
9873
10164
|
/** Show address line 2 field. */
|
|
9874
10165
|
show?: boolean;
|
|
@@ -9880,7 +10171,7 @@ export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
|
9880
10171
|
*/
|
|
9881
10172
|
countryOptions?: string;
|
|
9882
10173
|
/** Default country type. */
|
|
9883
|
-
type?:
|
|
10174
|
+
type?: DefaultCountryConfigTypeWithLiterals;
|
|
9884
10175
|
}
|
|
9885
10176
|
/** @oneof */
|
|
9886
10177
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
@@ -9905,6 +10196,8 @@ export declare enum InputType {
|
|
|
9905
10196
|
PAYMENT = "PAYMENT",
|
|
9906
10197
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9907
10198
|
}
|
|
10199
|
+
/** @enumType */
|
|
10200
|
+
export type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS';
|
|
9908
10201
|
export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
|
|
9909
10202
|
/** Email info. */
|
|
9910
10203
|
emailInfo?: EmailInfo;
|
|
@@ -9917,7 +10210,7 @@ export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfo
|
|
|
9917
10210
|
/** Subscription info */
|
|
9918
10211
|
subscriptionInfo?: SubscriptionInfo;
|
|
9919
10212
|
/** Field mapped to contacts. */
|
|
9920
|
-
contactField?:
|
|
10213
|
+
contactField?: ContactFieldWithLiterals;
|
|
9921
10214
|
}
|
|
9922
10215
|
/** @oneof */
|
|
9923
10216
|
export interface FormFieldContactInfoAdditionalInfoOneOf {
|
|
@@ -9936,19 +10229,27 @@ export declare enum EmailInfoTag {
|
|
|
9936
10229
|
UNTAGGED = "UNTAGGED",
|
|
9937
10230
|
MAIN = "MAIN"
|
|
9938
10231
|
}
|
|
10232
|
+
/** @enumType */
|
|
10233
|
+
export type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9939
10234
|
export declare enum PhoneInfoTag {
|
|
9940
10235
|
UNTAGGED = "UNTAGGED",
|
|
9941
10236
|
MAIN = "MAIN"
|
|
9942
10237
|
}
|
|
10238
|
+
/** @enumType */
|
|
10239
|
+
export type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9943
10240
|
export declare enum AddressInfoTag {
|
|
9944
10241
|
UNTAGGED = "UNTAGGED",
|
|
9945
10242
|
HOME = "HOME"
|
|
9946
10243
|
}
|
|
10244
|
+
/** @enumType */
|
|
10245
|
+
export type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
|
|
9947
10246
|
export declare enum ConfirmationLevel {
|
|
9948
10247
|
UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
|
|
9949
10248
|
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
9950
10249
|
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
9951
10250
|
}
|
|
10251
|
+
/** @enumType */
|
|
10252
|
+
export type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
|
|
9952
10253
|
export declare enum ContactField {
|
|
9953
10254
|
UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
|
|
9954
10255
|
FIRST_NAME = "FIRST_NAME",
|
|
@@ -9963,17 +10264,19 @@ export declare enum ContactField {
|
|
|
9963
10264
|
SUBSCRIPTION = "SUBSCRIPTION",
|
|
9964
10265
|
VAT_ID = "VAT_ID"
|
|
9965
10266
|
}
|
|
10267
|
+
/** @enumType */
|
|
10268
|
+
export type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
|
|
9966
10269
|
export interface EmailInfo {
|
|
9967
10270
|
/** Email tag. */
|
|
9968
|
-
tag?:
|
|
10271
|
+
tag?: EmailInfoTagWithLiterals;
|
|
9969
10272
|
}
|
|
9970
10273
|
export interface PhoneInfo {
|
|
9971
10274
|
/** Phone tag. */
|
|
9972
|
-
tag?:
|
|
10275
|
+
tag?: PhoneInfoTagWithLiterals;
|
|
9973
10276
|
}
|
|
9974
10277
|
export interface AddressInfo {
|
|
9975
10278
|
/** Address tag. */
|
|
9976
|
-
tag?:
|
|
10279
|
+
tag?: AddressInfoTagWithLiterals;
|
|
9977
10280
|
}
|
|
9978
10281
|
export interface CustomFieldInfo {
|
|
9979
10282
|
/**
|
|
@@ -9988,7 +10291,7 @@ export interface SubscriptionInfo {
|
|
|
9988
10291
|
* Subscription consent opt in level, either single or double confirmation.
|
|
9989
10292
|
* Default: SINGLE_CONFIRMATION
|
|
9990
10293
|
*/
|
|
9991
|
-
confirmationLevel?:
|
|
10294
|
+
confirmationLevel?: ConfirmationLevelWithLiterals;
|
|
9992
10295
|
}
|
|
9993
10296
|
export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
9994
10297
|
/** Text input field */
|
|
@@ -10013,7 +10316,7 @@ export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
|
10013
10316
|
* Component type of the string input field
|
|
10014
10317
|
* @readonly
|
|
10015
10318
|
*/
|
|
10016
|
-
componentType?:
|
|
10319
|
+
componentType?: StringComponentTypeWithLiterals;
|
|
10017
10320
|
}
|
|
10018
10321
|
/** @oneof */
|
|
10019
10322
|
export interface _StringComponentTypeOptionsOneOf {
|
|
@@ -10045,7 +10348,7 @@ export interface InputField_Number extends InputField_NumberComponentTypeOptions
|
|
|
10045
10348
|
* Component type of the number input field
|
|
10046
10349
|
* @readonly
|
|
10047
10350
|
*/
|
|
10048
|
-
componentType?:
|
|
10351
|
+
componentType?: NumberComponentTypeWithLiterals;
|
|
10049
10352
|
}
|
|
10050
10353
|
/** @oneof */
|
|
10051
10354
|
export interface InputField_NumberComponentTypeOptionsOneOf {
|
|
@@ -10063,7 +10366,7 @@ export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
|
|
|
10063
10366
|
* Component type of the boolean input field
|
|
10064
10367
|
* @readonly
|
|
10065
10368
|
*/
|
|
10066
|
-
componentType?:
|
|
10369
|
+
componentType?: BooleanComponentTypeWithLiterals;
|
|
10067
10370
|
}
|
|
10068
10371
|
/** @oneof */
|
|
10069
10372
|
export interface _BooleanComponentTypeOptionsOneOf {
|
|
@@ -10079,7 +10382,7 @@ export interface _Array extends _ArrayComponentTypeOptionsOneOf {
|
|
|
10079
10382
|
* Component type of the array input field
|
|
10080
10383
|
* @readonly
|
|
10081
10384
|
*/
|
|
10082
|
-
componentType?:
|
|
10385
|
+
componentType?: ArrayComponentTypeWithLiterals;
|
|
10083
10386
|
}
|
|
10084
10387
|
/** @oneof */
|
|
10085
10388
|
export interface _ArrayComponentTypeOptionsOneOf {
|
|
@@ -10099,7 +10402,7 @@ export interface WixFile extends WixFileComponentTypeOptionsOneOf {
|
|
|
10099
10402
|
* Component type of the array input field
|
|
10100
10403
|
* @readonly
|
|
10101
10404
|
*/
|
|
10102
|
-
componentType?:
|
|
10405
|
+
componentType?: WixFileComponentTypeWithLiterals;
|
|
10103
10406
|
}
|
|
10104
10407
|
/** @oneof */
|
|
10105
10408
|
export interface WixFileComponentTypeOptionsOneOf {
|
|
@@ -10117,7 +10420,7 @@ export interface Payment extends PaymentComponentTypeOptionsOneOf {
|
|
|
10117
10420
|
* Component type of the payment input field.
|
|
10118
10421
|
* @readonly
|
|
10119
10422
|
*/
|
|
10120
|
-
componentType?:
|
|
10423
|
+
componentType?: PaymentComponentTypeWithLiterals;
|
|
10121
10424
|
/** Validation of payment type. */
|
|
10122
10425
|
validation?: PaymentType;
|
|
10123
10426
|
}
|
|
@@ -10135,7 +10438,7 @@ export interface MultilineAddress extends MultilineAddressComponentTypeOptionsOn
|
|
|
10135
10438
|
* Component type of the multiline address field.
|
|
10136
10439
|
* @readonly
|
|
10137
10440
|
*/
|
|
10138
|
-
componentType?:
|
|
10441
|
+
componentType?: MultilineAddressComponentTypeWithLiterals;
|
|
10139
10442
|
/** Validation of multiline address field output value. */
|
|
10140
10443
|
validation?: MultilineAddressValidation;
|
|
10141
10444
|
}
|
|
@@ -10149,7 +10452,7 @@ export interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
|
10149
10452
|
richContentOptions?: RichContentOptions;
|
|
10150
10453
|
/** Page navigation component resolving as navigation or submit buttons */
|
|
10151
10454
|
pageNavigationOptions?: PageNavigationOptions;
|
|
10152
|
-
displayFieldType?:
|
|
10455
|
+
displayFieldType?: DisplayFieldTypeWithLiterals;
|
|
10153
10456
|
}
|
|
10154
10457
|
/** @oneof */
|
|
10155
10458
|
export interface DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
@@ -10164,6 +10467,8 @@ export declare enum DisplayFieldType {
|
|
|
10164
10467
|
PAGE_NAVIGATION = "PAGE_NAVIGATION",
|
|
10165
10468
|
LOGIN_BAR = "LOGIN_BAR"
|
|
10166
10469
|
}
|
|
10470
|
+
/** @enumType */
|
|
10471
|
+
export type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
|
|
10167
10472
|
export interface RichContentOptions {
|
|
10168
10473
|
/** Content of the header */
|
|
10169
10474
|
richContent?: RichContent;
|
|
@@ -10305,6 +10610,8 @@ export declare enum ChangeableProperty {
|
|
|
10305
10610
|
/** Allowed values property type. */
|
|
10306
10611
|
ALLOWED_VALUES = "ALLOWED_VALUES"
|
|
10307
10612
|
}
|
|
10613
|
+
/** @enumType */
|
|
10614
|
+
export type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
|
|
10308
10615
|
export interface RequiredOptions {
|
|
10309
10616
|
/** Value of required property */
|
|
10310
10617
|
value?: boolean;
|
|
@@ -10325,6 +10632,8 @@ export declare enum OverrideEntityType {
|
|
|
10325
10632
|
UNKNOWN = "UNKNOWN",
|
|
10326
10633
|
FIELD = "FIELD"
|
|
10327
10634
|
}
|
|
10635
|
+
/** @enumType */
|
|
10636
|
+
export type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
|
|
10328
10637
|
export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
10329
10638
|
/** Required property overrides */
|
|
10330
10639
|
requiredOptions?: RequiredOptions;
|
|
@@ -10339,7 +10648,7 @@ export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
|
10339
10648
|
*/
|
|
10340
10649
|
fieldId?: string;
|
|
10341
10650
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
10342
|
-
propertyType?:
|
|
10651
|
+
propertyType?: ChangeablePropertyWithLiterals;
|
|
10343
10652
|
}
|
|
10344
10653
|
/** @oneof */
|
|
10345
10654
|
export interface FieldOverridePropertyTypeOptionsOneOf {
|
|
@@ -10390,7 +10699,7 @@ export interface V2Condition {
|
|
|
10390
10699
|
*/
|
|
10391
10700
|
fact?: string;
|
|
10392
10701
|
/** The operator to use for comparison. */
|
|
10393
|
-
operator?:
|
|
10702
|
+
operator?: OperatorWithLiterals;
|
|
10394
10703
|
/**
|
|
10395
10704
|
* The value to compare against.
|
|
10396
10705
|
* @maxLength 500
|
|
@@ -10426,6 +10735,8 @@ export declare enum Operator {
|
|
|
10426
10735
|
IS_DATE_NEWER_THAN = "IS_DATE_NEWER_THAN",
|
|
10427
10736
|
IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
|
|
10428
10737
|
}
|
|
10738
|
+
/** @enumType */
|
|
10739
|
+
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';
|
|
10429
10740
|
export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
10430
10741
|
/** Field override properties. */
|
|
10431
10742
|
fieldOptions?: FieldOverride;
|
|
@@ -10433,7 +10744,7 @@ export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
|
10433
10744
|
* Override entity type.
|
|
10434
10745
|
* @immutable
|
|
10435
10746
|
*/
|
|
10436
|
-
entityType?:
|
|
10747
|
+
entityType?: OverrideEntityTypeWithLiterals;
|
|
10437
10748
|
}
|
|
10438
10749
|
/** @oneof */
|
|
10439
10750
|
export interface FormOverrideEntityTypeOptionsOneOf {
|
|
@@ -10446,7 +10757,7 @@ export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptions
|
|
|
10446
10757
|
/** Options for redirecting to a URL after submission. */
|
|
10447
10758
|
redirectOptions?: RedirectOptions;
|
|
10448
10759
|
/** Action that is triggered after a successful form submission. */
|
|
10449
|
-
submitSuccessAction?:
|
|
10760
|
+
submitSuccessAction?: SubmitSuccessActionWithLiterals;
|
|
10450
10761
|
}
|
|
10451
10762
|
/** @oneof */
|
|
10452
10763
|
export interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
@@ -10462,6 +10773,8 @@ export declare enum Target {
|
|
|
10462
10773
|
/** Open in a new browser tab. */
|
|
10463
10774
|
BLANK = "BLANK"
|
|
10464
10775
|
}
|
|
10776
|
+
/** @enumType */
|
|
10777
|
+
export type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
|
|
10465
10778
|
export declare enum SubmitSuccessAction {
|
|
10466
10779
|
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
10467
10780
|
/** No action will be taken after submission. */
|
|
@@ -10471,6 +10784,8 @@ export declare enum SubmitSuccessAction {
|
|
|
10471
10784
|
/** The user will be redirected to a URL after submission. */
|
|
10472
10785
|
REDIRECT = "REDIRECT"
|
|
10473
10786
|
}
|
|
10787
|
+
/** @enumType */
|
|
10788
|
+
export type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
|
|
10474
10789
|
export interface ThankYouMessageOptions {
|
|
10475
10790
|
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
10476
10791
|
durationInSeconds?: number | null;
|
|
@@ -10484,7 +10799,7 @@ export interface RedirectOptions {
|
|
|
10484
10799
|
*/
|
|
10485
10800
|
redirectUrl?: string | null;
|
|
10486
10801
|
/** How the URL should be opened. */
|
|
10487
|
-
target?:
|
|
10802
|
+
target?: TargetWithLiterals;
|
|
10488
10803
|
}
|
|
10489
10804
|
export declare enum TemplateType {
|
|
10490
10805
|
UNKNOWN = "UNKNOWN",
|
|
@@ -10498,6 +10813,8 @@ export declare enum TemplateType {
|
|
|
10498
10813
|
*/
|
|
10499
10814
|
FORM_INPUT = "FORM_INPUT"
|
|
10500
10815
|
}
|
|
10816
|
+
/** @enumType */
|
|
10817
|
+
export type TemplateTypeWithLiterals = TemplateType | 'UNKNOWN' | 'EXTENDABLE' | 'DEMO' | 'FORM_INPUT';
|
|
10501
10818
|
export interface ExtensionDetails {
|
|
10502
10819
|
/** Allow user to add/remove custom field, not present in template */
|
|
10503
10820
|
addCustomFields?: AddCustomFields;
|
|
@@ -10510,6 +10827,8 @@ export declare enum CustomFieldsType {
|
|
|
10510
10827
|
/** Allow user to add/remove any custom field, not present in template */
|
|
10511
10828
|
ANY = "ANY"
|
|
10512
10829
|
}
|
|
10830
|
+
/** @enumType */
|
|
10831
|
+
export type CustomFieldsTypeWithLiterals = CustomFieldsType | 'ANY';
|
|
10513
10832
|
export declare enum EditableProperties {
|
|
10514
10833
|
UNKNOWN = "UNKNOWN",
|
|
10515
10834
|
/** Change property responsible for field requirement */
|
|
@@ -10530,16 +10849,18 @@ export declare enum EditableProperties {
|
|
|
10530
10849
|
/** Change property responsible for field default value */
|
|
10531
10850
|
DEFAULT_VALUE = "DEFAULT_VALUE"
|
|
10532
10851
|
}
|
|
10852
|
+
/** @enumType */
|
|
10853
|
+
export type EditablePropertiesWithLiterals = EditableProperties | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'LABEL' | 'PLACEHOLDER' | 'DESCRIPTION' | 'INPUT_VALUE_LIMITS' | 'DEFAULT_VALUE';
|
|
10533
10854
|
export interface EditableFields {
|
|
10534
10855
|
/**
|
|
10535
10856
|
* List of editable properties for field
|
|
10536
10857
|
* @maxSize 10
|
|
10537
10858
|
*/
|
|
10538
|
-
properties?:
|
|
10859
|
+
properties?: EditablePropertiesWithLiterals[];
|
|
10539
10860
|
}
|
|
10540
10861
|
export interface AddCustomFields {
|
|
10541
10862
|
/** Field types which can be added */
|
|
10542
|
-
fieldType?:
|
|
10863
|
+
fieldType?: CustomFieldsTypeWithLiterals;
|
|
10543
10864
|
}
|
|
10544
10865
|
export interface OverrideTemplateFields {
|
|
10545
10866
|
/** Editable properties by field id. */
|
|
@@ -10567,9 +10888,9 @@ export interface FieldGroup {
|
|
|
10567
10888
|
}
|
|
10568
10889
|
export interface RequiredIndicatorProperties {
|
|
10569
10890
|
/** Required indicator. */
|
|
10570
|
-
requiredIndicator?:
|
|
10891
|
+
requiredIndicator?: RequiredIndicatorWithLiterals;
|
|
10571
10892
|
/** Required indicator placement. */
|
|
10572
|
-
requiredIndicatorPlacement?:
|
|
10893
|
+
requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
|
|
10573
10894
|
}
|
|
10574
10895
|
export declare enum RequiredIndicator {
|
|
10575
10896
|
/** Unknown required indicator. */
|
|
@@ -10581,6 +10902,8 @@ export declare enum RequiredIndicator {
|
|
|
10581
10902
|
/** None. */
|
|
10582
10903
|
NONE = "NONE"
|
|
10583
10904
|
}
|
|
10905
|
+
/** @enumType */
|
|
10906
|
+
export type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | 'ASTERISK' | 'TEXT' | 'NONE';
|
|
10584
10907
|
export declare enum RequiredIndicatorPlacement {
|
|
10585
10908
|
/** Unknown required indicator placement. */
|
|
10586
10909
|
UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
|
|
@@ -10589,6 +10912,8 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
10589
10912
|
/** Before field title. */
|
|
10590
10913
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
10591
10914
|
}
|
|
10915
|
+
/** @enumType */
|
|
10916
|
+
export type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
|
|
10592
10917
|
/** Describes a setting group of a notification */
|
|
10593
10918
|
export interface NotificationContent {
|
|
10594
10919
|
single?: SingleContent;
|
|
@@ -10644,7 +10969,7 @@ export interface VeloPublishPipelineTaskProviderConfig {
|
|
|
10644
10969
|
* The Velo Task name
|
|
10645
10970
|
* @maxSize 100
|
|
10646
10971
|
*/
|
|
10647
|
-
implementerTasksNames?:
|
|
10972
|
+
implementerTasksNames?: WixCodePublishTaskNameWithLiterals[];
|
|
10648
10973
|
}
|
|
10649
10974
|
export declare enum WixCodePublishTaskName {
|
|
10650
10975
|
/** unknown */
|
|
@@ -10662,6 +10987,8 @@ export declare enum WixCodePublishTaskName {
|
|
|
10662
10987
|
/** code packages dependencies registration */
|
|
10663
10988
|
CODE_PACKAGES_REGISTRATION = "CODE_PACKAGES_REGISTRATION"
|
|
10664
10989
|
}
|
|
10990
|
+
/** @enumType */
|
|
10991
|
+
export type WixCodePublishTaskNameWithLiterals = WixCodePublishTaskName | 'UNKNOWN' | 'USER_CODE_BUNDLE' | 'EXPORTED_FUNCTIONS_ANALYSIS' | 'IMPORTED_NAMESPACES_ANALYSIS' | 'PAGE_DETAILS_ANALYSIS' | 'USER_CODE_VALIDATION' | 'CODE_PACKAGES_REGISTRATION';
|
|
10665
10992
|
export interface FunctionsShopPriceSpiConfig {
|
|
10666
10993
|
/** Uri config */
|
|
10667
10994
|
uriConfig?: SpiBaseUri;
|
|
@@ -10893,7 +11220,7 @@ export interface ChannelChannelConfiguration extends ChannelChannelConfiguration
|
|
|
10893
11220
|
*/
|
|
10894
11221
|
channelKey?: string;
|
|
10895
11222
|
/** The type of the communication channel */
|
|
10896
|
-
type?:
|
|
11223
|
+
type?: ChannelConfigurationChannelTypeWithLiterals;
|
|
10897
11224
|
/** Specific provider branding parameters for the channel */
|
|
10898
11225
|
branding?: ChannelChannelBranding;
|
|
10899
11226
|
}
|
|
@@ -10913,6 +11240,8 @@ export declare enum ChannelConfigurationChannelType {
|
|
|
10913
11240
|
EMAIL = "EMAIL",
|
|
10914
11241
|
SMS = "SMS"
|
|
10915
11242
|
}
|
|
11243
|
+
/** @enumType */
|
|
11244
|
+
export type ChannelConfigurationChannelTypeWithLiterals = ChannelConfigurationChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
10916
11245
|
export interface DmDirectMessageConfig {
|
|
10917
11246
|
/**
|
|
10918
11247
|
* Direct message types accepted by the provider.
|
|
@@ -10920,7 +11249,7 @@ export interface DmDirectMessageConfig {
|
|
|
10920
11249
|
* If the provider supports all message types, this field can be empty.
|
|
10921
11250
|
* @maxSize 100
|
|
10922
11251
|
*/
|
|
10923
|
-
acceptedMessageTypes?:
|
|
11252
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals[];
|
|
10924
11253
|
/** Supported media types (mime types) and sizes */
|
|
10925
11254
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10926
11255
|
/** Defines whether or not sending messages will be available for recipients without contact Id */
|
|
@@ -10941,6 +11270,8 @@ export declare enum AcceptedMessageTypesAcceptedDirectMessageType {
|
|
|
10941
11270
|
FORM = "FORM",
|
|
10942
11271
|
SYSTEM = "SYSTEM"
|
|
10943
11272
|
}
|
|
11273
|
+
/** @enumType */
|
|
11274
|
+
export type AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals = AcceptedMessageTypesAcceptedDirectMessageType | 'UNKNOWN_DIRECT_MESSAGE_TYPE' | 'MEDIA' | 'CARD' | 'MINIMAL' | 'FORM' | 'SYSTEM';
|
|
10944
11275
|
export interface ChannelMediaCapabilities {
|
|
10945
11276
|
/** When marked as true, 'supported_media_types' will be ignored. */
|
|
10946
11277
|
allMediaTypes?: boolean;
|
|
@@ -10967,7 +11298,7 @@ export interface SmsSmsMessageConfig {
|
|
|
10967
11298
|
* @minSize 1
|
|
10968
11299
|
* @maxSize 100
|
|
10969
11300
|
*/
|
|
10970
|
-
acceptedMessageTypes?:
|
|
11301
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals[];
|
|
10971
11302
|
/** Supported media types (mime types) and sizes */
|
|
10972
11303
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10973
11304
|
/** Optional - maximum sms message length in characters, if not given, will be unlimited */
|
|
@@ -10978,6 +11309,8 @@ export declare enum AcceptedMessageTypesAcceptedSmsMessageType {
|
|
|
10978
11309
|
SMS = "SMS",
|
|
10979
11310
|
MMS = "MMS"
|
|
10980
11311
|
}
|
|
11312
|
+
/** @enumType */
|
|
11313
|
+
export type AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals = AcceptedMessageTypesAcceptedSmsMessageType | 'UNKNOWN_SMS_MESSAGE_TYPE' | 'SMS' | 'MMS';
|
|
10981
11314
|
export interface ChannelChannelBranding {
|
|
10982
11315
|
/**
|
|
10983
11316
|
* The name of the channel, e.g. `Facebook` / `SMS`
|
|
@@ -11117,7 +11450,7 @@ export interface FactorConfig {
|
|
|
11117
11450
|
/** the base URI where all the methods are deployed. */
|
|
11118
11451
|
uriConfig?: SpiBaseUri;
|
|
11119
11452
|
/** the type of the factor */
|
|
11120
|
-
factorType?:
|
|
11453
|
+
factorType?: FactorTypeWithLiterals;
|
|
11121
11454
|
/** whether the factor supports verify without enrolling first */
|
|
11122
11455
|
supportsVerifyWithoutEnroll?: boolean;
|
|
11123
11456
|
}
|
|
@@ -11130,6 +11463,8 @@ export declare enum FactorType {
|
|
|
11130
11463
|
TOTP = "TOTP",
|
|
11131
11464
|
PUSH = "PUSH"
|
|
11132
11465
|
}
|
|
11466
|
+
/** @enumType */
|
|
11467
|
+
export type FactorTypeWithLiterals = FactorType | 'UNKNOWN_FACTOR_TYPE' | 'PASSWORD' | 'SMS' | 'CALL' | 'EMAIL' | 'TOTP' | 'PUSH';
|
|
11133
11468
|
export interface DiscountsSPIConfig {
|
|
11134
11469
|
/**
|
|
11135
11470
|
* Base URI where the endpoints are called.
|
|
@@ -11189,7 +11524,7 @@ export interface Monitoring extends MonitoringOptionsOneOf {
|
|
|
11189
11524
|
/** Panorama provider options */
|
|
11190
11525
|
panoramaOptions?: PanoramaOptions;
|
|
11191
11526
|
/** Provider type */
|
|
11192
|
-
type?:
|
|
11527
|
+
type?: MonitoringTypeWithLiterals;
|
|
11193
11528
|
}
|
|
11194
11529
|
/** @oneof */
|
|
11195
11530
|
export interface MonitoringOptionsOneOf {
|
|
@@ -11231,6 +11566,8 @@ export declare enum MonitoringType {
|
|
|
11231
11566
|
SENTRY = "SENTRY",
|
|
11232
11567
|
PANORAMA = "PANORAMA"
|
|
11233
11568
|
}
|
|
11569
|
+
/** @enumType */
|
|
11570
|
+
export type MonitoringTypeWithLiterals = MonitoringType | 'UNKNOWN_PROVIDER' | 'SENTRY' | 'PANORAMA';
|
|
11234
11571
|
export interface PanoramaOptions {
|
|
11235
11572
|
/** Sentry config */
|
|
11236
11573
|
sentry?: SentryOptions;
|
|
@@ -11251,12 +11588,12 @@ export interface PluginConfig {
|
|
|
11251
11588
|
*/
|
|
11252
11589
|
pluginDisplayName?: string;
|
|
11253
11590
|
startingEnforcementDate?: Date | null;
|
|
11254
|
-
importanceLevel?:
|
|
11591
|
+
importanceLevel?: ImportanceLevelWithLiterals;
|
|
11255
11592
|
/** @maxSize 100 */
|
|
11256
11593
|
constraints?: Constraint[];
|
|
11257
11594
|
}
|
|
11258
11595
|
export interface Consequence {
|
|
11259
|
-
escalation?:
|
|
11596
|
+
escalation?: EscalationWithLiterals;
|
|
11260
11597
|
/** days to resolve the violation */
|
|
11261
11598
|
daysToResolve?: number | null;
|
|
11262
11599
|
}
|
|
@@ -11268,11 +11605,15 @@ export declare enum Escalation {
|
|
|
11268
11605
|
/** only shows violation in papi-dashboard */
|
|
11269
11606
|
VISIBILITY = "VISIBILITY"
|
|
11270
11607
|
}
|
|
11608
|
+
/** @enumType */
|
|
11609
|
+
export type EscalationWithLiterals = Escalation | 'BREAK_BUILD' | 'BLOCK_ROLLOUT' | 'BLOCK_FUTURE_ROLLOUT' | 'OPEN_BUG_SLA' | 'VISIBILITY';
|
|
11271
11610
|
export declare enum ImportanceLevel {
|
|
11272
11611
|
LOW = "LOW",
|
|
11273
11612
|
MEDIUM = "MEDIUM",
|
|
11274
11613
|
HIGH = "HIGH"
|
|
11275
11614
|
}
|
|
11615
|
+
/** @enumType */
|
|
11616
|
+
export type ImportanceLevelWithLiterals = ImportanceLevel | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
11276
11617
|
export interface Constraint {
|
|
11277
11618
|
/** @maxLength 1024 */
|
|
11278
11619
|
id?: string;
|
|
@@ -11397,7 +11738,7 @@ export interface Panel extends PanelSelectedContentTypeOneOf {
|
|
|
11397
11738
|
/** Optional: The size of the panel */
|
|
11398
11739
|
size?: PanelSize;
|
|
11399
11740
|
/** The selected panel content type */
|
|
11400
|
-
contentType?:
|
|
11741
|
+
contentType?: PanelContentTypeWithLiterals;
|
|
11401
11742
|
}
|
|
11402
11743
|
/** @oneof */
|
|
11403
11744
|
export interface PanelSelectedContentTypeOneOf {
|
|
@@ -11414,18 +11755,22 @@ export interface PanelSize {
|
|
|
11414
11755
|
*/
|
|
11415
11756
|
height?: number | null;
|
|
11416
11757
|
/** width of the panel */
|
|
11417
|
-
width?:
|
|
11758
|
+
width?: WidthWithLiterals;
|
|
11418
11759
|
}
|
|
11419
11760
|
export declare enum Width {
|
|
11420
11761
|
SMALL = "SMALL",
|
|
11421
11762
|
MEDIUM = "MEDIUM",
|
|
11422
11763
|
LARGE = "LARGE"
|
|
11423
11764
|
}
|
|
11765
|
+
/** @enumType */
|
|
11766
|
+
export type WidthWithLiterals = Width | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
11424
11767
|
/** Represents the options for panel content types */
|
|
11425
11768
|
export declare enum PanelContentType {
|
|
11426
11769
|
UNKNOWN_PanelContentType = "UNKNOWN_PanelContentType",
|
|
11427
11770
|
url = "url"
|
|
11428
11771
|
}
|
|
11772
|
+
/** @enumType */
|
|
11773
|
+
export type PanelContentTypeWithLiterals = PanelContentType | 'UNKNOWN_PanelContentType' | 'url';
|
|
11429
11774
|
/** Represents the information needed for code panels */
|
|
11430
11775
|
export interface CodePanel {
|
|
11431
11776
|
/**
|
|
@@ -11445,7 +11790,7 @@ export interface PurchaseValidationsConfig {
|
|
|
11445
11790
|
}
|
|
11446
11791
|
export interface BrowserStorage {
|
|
11447
11792
|
/** The type of browser storage used */
|
|
11448
|
-
type?:
|
|
11793
|
+
type?: StorageTypeWithLiterals;
|
|
11449
11794
|
/**
|
|
11450
11795
|
* The name of the storage item in the browser (as can be seen in DEV Console)
|
|
11451
11796
|
* @maxLength 100
|
|
@@ -11463,9 +11808,9 @@ export interface BrowserStorage {
|
|
|
11463
11808
|
* This defines when this storage item is allowed to be used in a visitor session.
|
|
11464
11809
|
* > This is legally important for complying with EU privacy law, so make sure to define this carefully.
|
|
11465
11810
|
*/
|
|
11466
|
-
consentCategory?:
|
|
11811
|
+
consentCategory?: ConsentCategoryWithLiterals;
|
|
11467
11812
|
/** Where this storage item will be set in the browser (User domain or the App domain) */
|
|
11468
|
-
domain?:
|
|
11813
|
+
domain?: StorageDomainWithLiterals;
|
|
11469
11814
|
}
|
|
11470
11815
|
/** The type of storage we are declaring */
|
|
11471
11816
|
export declare enum StorageType {
|
|
@@ -11479,6 +11824,8 @@ export declare enum StorageType {
|
|
|
11479
11824
|
/** An item in [IndexDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) */
|
|
11480
11825
|
INDEXDB = "INDEXDB"
|
|
11481
11826
|
}
|
|
11827
|
+
/** @enumType */
|
|
11828
|
+
export type StorageTypeWithLiterals = StorageType | 'UNKNOWN_STORAGE_TYPE' | 'COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE' | 'INDEXDB';
|
|
11482
11829
|
/** The category for EU and US Privacy Law classification */
|
|
11483
11830
|
export declare enum ConsentCategory {
|
|
11484
11831
|
/** This is an invalid value, you must classify your storage item. */
|
|
@@ -11492,6 +11839,8 @@ export declare enum ConsentCategory {
|
|
|
11492
11839
|
/** Related to advertising, upselling and marketing data collected to be used. */
|
|
11493
11840
|
advertising = "advertising"
|
|
11494
11841
|
}
|
|
11842
|
+
/** @enumType */
|
|
11843
|
+
export type ConsentCategoryWithLiterals = ConsentCategory | 'UNKNOWN_CATEGORY' | 'essential' | 'functional' | 'analytics' | 'advertising';
|
|
11495
11844
|
export declare enum StorageDomain {
|
|
11496
11845
|
UNKNOWN_STORAGE_DOMAIN = "UNKNOWN_STORAGE_DOMAIN",
|
|
11497
11846
|
/** Storing the values in the domain of the website the app is installed on */
|
|
@@ -11501,6 +11850,8 @@ export declare enum StorageDomain {
|
|
|
11501
11850
|
/** Storing the values as 3rd party in the application domain */
|
|
11502
11851
|
APP_DOMAIN = "APP_DOMAIN"
|
|
11503
11852
|
}
|
|
11853
|
+
/** @enumType */
|
|
11854
|
+
export type StorageDomainWithLiterals = StorageDomain | 'UNKNOWN_STORAGE_DOMAIN' | 'SITE_DOMAIN' | 'WIX_DOMAIN' | 'APP_DOMAIN';
|
|
11504
11855
|
/** Describe SDK module definition for an app */
|
|
11505
11856
|
export interface SdkDefinition {
|
|
11506
11857
|
/**
|
|
@@ -11532,7 +11883,7 @@ export interface EventValidationProviderConfig {
|
|
|
11532
11883
|
}
|
|
11533
11884
|
export interface ValidationTarget {
|
|
11534
11885
|
/** The method to validate. */
|
|
11535
|
-
method?:
|
|
11886
|
+
method?: MethodWithLiterals;
|
|
11536
11887
|
/**
|
|
11537
11888
|
* Optional WQL filter applied to the events for validation.
|
|
11538
11889
|
* Only events matching this filter will be validated.
|
|
@@ -11549,6 +11900,8 @@ export declare enum Method {
|
|
|
11549
11900
|
/** Validate an event before cancel. */
|
|
11550
11901
|
CANCEL = "CANCEL"
|
|
11551
11902
|
}
|
|
11903
|
+
/** @enumType */
|
|
11904
|
+
export type MethodWithLiterals = Method | 'CREATE' | 'UPDATE' | 'CANCEL';
|
|
11552
11905
|
/** 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. */
|
|
11553
11906
|
export interface ClientSideService {
|
|
11554
11907
|
/**
|
|
@@ -11699,7 +12052,7 @@ export interface AudienceProviderConfig {
|
|
|
11699
12052
|
*/
|
|
11700
12053
|
displayName?: string;
|
|
11701
12054
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
11702
|
-
participantType?:
|
|
12055
|
+
participantType?: ParticipantTypeWithLiterals;
|
|
11703
12056
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
11704
12057
|
inputSchema?: Record<string, any> | null;
|
|
11705
12058
|
/**
|
|
@@ -11713,7 +12066,7 @@ export interface AudienceProviderConfig {
|
|
|
11713
12066
|
* Define the scopes which the provider audience is relevant
|
|
11714
12067
|
* @maxSize 10
|
|
11715
12068
|
*/
|
|
11716
|
-
scopes?:
|
|
12069
|
+
scopes?: ScopeWithLiterals[];
|
|
11717
12070
|
}
|
|
11718
12071
|
export declare enum ParticipantType {
|
|
11719
12072
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
@@ -11721,11 +12074,13 @@ export declare enum ParticipantType {
|
|
|
11721
12074
|
CONTACT = "CONTACT",
|
|
11722
12075
|
ANONYMOUS = "ANONYMOUS"
|
|
11723
12076
|
}
|
|
12077
|
+
/** @enumType */
|
|
12078
|
+
export type ParticipantTypeWithLiterals = ParticipantType | 'UNKNOWN_TYPE' | 'WIX_USER' | 'CONTACT' | 'ANONYMOUS';
|
|
11724
12079
|
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
11725
12080
|
/** Should be filled if the provider implements its own custom UI */
|
|
11726
12081
|
widgetComponentConfiguration?: WidgetComponent;
|
|
11727
12082
|
/** Type of interface configuration */
|
|
11728
|
-
type?:
|
|
12083
|
+
type?: InterfaceConfigurationTypeWithLiterals;
|
|
11729
12084
|
}
|
|
11730
12085
|
/** @oneof */
|
|
11731
12086
|
export interface InterfaceConfigurationOfTypeOneOf {
|
|
@@ -11738,6 +12093,8 @@ export declare enum InterfaceConfigurationType {
|
|
|
11738
12093
|
/** Item Selection, in case the provider implemented item selection component */
|
|
11739
12094
|
ITEM_SELECTION = "ITEM_SELECTION"
|
|
11740
12095
|
}
|
|
12096
|
+
/** @enumType */
|
|
12097
|
+
export type InterfaceConfigurationTypeWithLiterals = InterfaceConfigurationType | 'WIDGET_COMPONENT' | 'ITEM_SELECTION';
|
|
11741
12098
|
export interface WidgetComponent {
|
|
11742
12099
|
/**
|
|
11743
12100
|
* widget component id
|
|
@@ -11769,6 +12126,8 @@ export declare enum Scope {
|
|
|
11769
12126
|
/** Provider audience is available only in scope of non specific site */
|
|
11770
12127
|
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
11771
12128
|
}
|
|
12129
|
+
/** @enumType */
|
|
12130
|
+
export type ScopeWithLiterals = Scope | 'SPECIFIC_SITE' | 'NON_SPECIFIC_SITE';
|
|
11772
12131
|
/** Config for the Price SPI */
|
|
11773
12132
|
export interface PriceSPIConfig {
|
|
11774
12133
|
/**
|
|
@@ -11845,7 +12204,7 @@ export interface EditorReactComponent {
|
|
|
11845
12204
|
* @replacedBy editor_element.archetype
|
|
11846
12205
|
* @targetRemovalDate 2026-06-30
|
|
11847
12206
|
*/
|
|
11848
|
-
archetype?:
|
|
12207
|
+
archetype?: ArchetypeWithLiterals;
|
|
11849
12208
|
}
|
|
11850
12209
|
export interface Resources {
|
|
11851
12210
|
/** The bundle we will load and render in the browser */
|
|
@@ -11921,13 +12280,13 @@ export interface EditorElement {
|
|
|
11921
12280
|
/** Layout capabilities of the component */
|
|
11922
12281
|
layout?: EditorElementLayout;
|
|
11923
12282
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
11924
|
-
archetype?:
|
|
12283
|
+
archetype?: ArchetypeWithLiterals;
|
|
11925
12284
|
}
|
|
11926
12285
|
export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSelectedCssPropertyTypeOneOf, StyleItemSelectedCssVariableTypeOneOf {
|
|
11927
12286
|
/** type selection key for css-properties */
|
|
11928
|
-
cssPropertyType?:
|
|
12287
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11929
12288
|
/** type selection key for css-data-types */
|
|
11930
|
-
cssVariableType?:
|
|
12289
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11931
12290
|
/** Additional options to refine the filter variable */
|
|
11932
12291
|
filter?: Filter;
|
|
11933
12292
|
/** Additional options to refine the backdropFilter variable */
|
|
@@ -11951,9 +12310,9 @@ export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSele
|
|
|
11951
12310
|
/** @oneof */
|
|
11952
12311
|
export interface StyleItemSelectedItemTypeOneOf {
|
|
11953
12312
|
/** type selection key for css-properties */
|
|
11954
|
-
cssPropertyType?:
|
|
12313
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11955
12314
|
/** type selection key for css-data-types */
|
|
11956
|
-
cssVariableType?:
|
|
12315
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11957
12316
|
}
|
|
11958
12317
|
/** @oneof */
|
|
11959
12318
|
export interface StyleItemSelectedCssPropertyTypeOneOf {
|
|
@@ -12087,6 +12446,8 @@ export declare enum CssPropertyType {
|
|
|
12087
12446
|
mixBlendMode = "mixBlendMode",
|
|
12088
12447
|
isolation = "isolation"
|
|
12089
12448
|
}
|
|
12449
|
+
/** @enumType */
|
|
12450
|
+
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';
|
|
12090
12451
|
/** The supported [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Types) in Javascript naming format */
|
|
12091
12452
|
export declare enum CssDataType {
|
|
12092
12453
|
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
@@ -12100,12 +12461,14 @@ export declare enum CssDataType {
|
|
|
12100
12461
|
customEnum = "customEnum",
|
|
12101
12462
|
string = "string"
|
|
12102
12463
|
}
|
|
12464
|
+
/** @enumType */
|
|
12465
|
+
export type CssDataTypeWithLiterals = CssDataType | 'UNKNOWN_CssDataType' | 'number' | 'length' | 'color' | 'angle' | 'percentage' | 'lengthPercentage' | 'blendMode' | 'customEnum' | 'string';
|
|
12103
12466
|
export interface Filter {
|
|
12104
12467
|
/**
|
|
12105
12468
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12106
12469
|
* @maxSize 100
|
|
12107
12470
|
*/
|
|
12108
|
-
filterFunctions?:
|
|
12471
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12109
12472
|
}
|
|
12110
12473
|
export declare enum FilterFunction {
|
|
12111
12474
|
UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
|
|
@@ -12130,19 +12493,21 @@ export declare enum FilterFunction {
|
|
|
12130
12493
|
/** The value used for saturate filter */
|
|
12131
12494
|
saturate = "saturate"
|
|
12132
12495
|
}
|
|
12496
|
+
/** @enumType */
|
|
12497
|
+
export type FilterFunctionWithLiterals = FilterFunction | 'UNKNOWN_FilterFunctions' | 'blur' | 'brightness' | 'contrast' | 'drop_shadow' | 'grayscale' | 'hue_rotate' | 'invert' | 'opacity' | 'sepia' | 'saturate';
|
|
12133
12498
|
export interface BackdropFilter {
|
|
12134
12499
|
/**
|
|
12135
12500
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12136
12501
|
* @maxSize 100
|
|
12137
12502
|
*/
|
|
12138
|
-
filterFunctions?:
|
|
12503
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12139
12504
|
}
|
|
12140
12505
|
export interface Display {
|
|
12141
12506
|
/**
|
|
12142
12507
|
* list of display values in case we want to reduce the abilities exposed to the User
|
|
12143
12508
|
* @maxSize 20
|
|
12144
12509
|
*/
|
|
12145
|
-
displayValues?:
|
|
12510
|
+
displayValues?: DisplayValueEnumDisplayValueWithLiterals[];
|
|
12146
12511
|
}
|
|
12147
12512
|
export declare enum DisplayValueEnumDisplayValue {
|
|
12148
12513
|
UNKNOWN_DisplayValue = "UNKNOWN_DisplayValue",
|
|
@@ -12161,12 +12526,14 @@ export declare enum DisplayValueEnumDisplayValue {
|
|
|
12161
12526
|
inline_flex = "inline_flex",
|
|
12162
12527
|
inline_grid = "inline_grid"
|
|
12163
12528
|
}
|
|
12529
|
+
/** @enumType */
|
|
12530
|
+
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';
|
|
12164
12531
|
export interface WritingMode {
|
|
12165
12532
|
/**
|
|
12166
12533
|
* list of writing-mode values in case we want to reduce the abilities exposed to the User
|
|
12167
12534
|
* @maxSize 20
|
|
12168
12535
|
*/
|
|
12169
|
-
writingModeValues?:
|
|
12536
|
+
writingModeValues?: WritingModeValueWithLiterals[];
|
|
12170
12537
|
}
|
|
12171
12538
|
export declare enum WritingModeValue {
|
|
12172
12539
|
UNKNOWN_WritingModeValue = "UNKNOWN_WritingModeValue",
|
|
@@ -12176,9 +12543,11 @@ export declare enum WritingModeValue {
|
|
|
12176
12543
|
sidewaysRl = "sidewaysRl",
|
|
12177
12544
|
sidewaysLr = "sidewaysLr"
|
|
12178
12545
|
}
|
|
12546
|
+
/** @enumType */
|
|
12547
|
+
export type WritingModeValueWithLiterals = WritingModeValue | 'UNKNOWN_WritingModeValue' | 'horizontalTb' | 'verticalRl' | 'verticalLr' | 'sidewaysRl' | 'sidewaysLr';
|
|
12179
12548
|
export interface CustomEnum {
|
|
12180
12549
|
/** the type of enum values */
|
|
12181
|
-
cssVariableType?:
|
|
12550
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
12182
12551
|
/**
|
|
12183
12552
|
* Editor-only: defines allowed values
|
|
12184
12553
|
* @maxSize 100
|
|
@@ -12232,7 +12601,7 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
12232
12601
|
/** A container in which to render another component */
|
|
12233
12602
|
container?: ReactElementContainer;
|
|
12234
12603
|
/** Defines the type of data we are configuring */
|
|
12235
|
-
dataType?:
|
|
12604
|
+
dataType?: DataTypeWithLiterals;
|
|
12236
12605
|
/**
|
|
12237
12606
|
* Display name of this data item
|
|
12238
12607
|
* @maxLength 100
|
|
@@ -12311,16 +12680,25 @@ export declare enum DataType {
|
|
|
12311
12680
|
/** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
|
|
12312
12681
|
direction = "direction"
|
|
12313
12682
|
}
|
|
12683
|
+
/** @enumType */
|
|
12684
|
+
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';
|
|
12314
12685
|
export interface Text {
|
|
12315
12686
|
/** Indicates maximum length allowed for the text */
|
|
12316
12687
|
maxLength?: number | null;
|
|
12317
12688
|
/** Indicates minimum length required for the text */
|
|
12318
12689
|
minLength?: number | null;
|
|
12319
12690
|
/**
|
|
12320
|
-
* A regex pattern that the text must comply with
|
|
12321
12691
|
* @maxLength 100
|
|
12692
|
+
* @deprecated
|
|
12693
|
+
* @replacedBy pattern
|
|
12694
|
+
* @targetRemovalDate 2026-06-30
|
|
12322
12695
|
*/
|
|
12323
12696
|
regexPattern?: string | null;
|
|
12697
|
+
/**
|
|
12698
|
+
* A regex pattern that the text must comply with
|
|
12699
|
+
* @maxLength 100
|
|
12700
|
+
*/
|
|
12701
|
+
pattern?: string | null;
|
|
12324
12702
|
}
|
|
12325
12703
|
export interface TextEnum {
|
|
12326
12704
|
/**
|
|
@@ -12354,7 +12732,7 @@ export interface A11y {
|
|
|
12354
12732
|
* A collection of attributes that will be stated in the manifest
|
|
12355
12733
|
* @maxSize 100
|
|
12356
12734
|
*/
|
|
12357
|
-
attributes?:
|
|
12735
|
+
attributes?: A11yAttributesWithLiterals[];
|
|
12358
12736
|
}
|
|
12359
12737
|
export declare enum A11yAttributes {
|
|
12360
12738
|
Unknown_AriaAttributes = "Unknown_AriaAttributes",
|
|
@@ -12409,12 +12787,14 @@ export declare enum A11yAttributes {
|
|
|
12409
12787
|
/** The value used for aria-invalid */
|
|
12410
12788
|
ariaInvalid = "ariaInvalid"
|
|
12411
12789
|
}
|
|
12790
|
+
/** @enumType */
|
|
12791
|
+
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';
|
|
12412
12792
|
export interface Link {
|
|
12413
12793
|
/**
|
|
12414
12794
|
* A collection of possible link types that the component supports. Only one of the types will make it to the component after input.
|
|
12415
12795
|
* @maxSize 12
|
|
12416
12796
|
*/
|
|
12417
|
-
linkTypes?:
|
|
12797
|
+
linkTypes?: LinkTypeWithLiterals[];
|
|
12418
12798
|
}
|
|
12419
12799
|
export declare enum LinkType {
|
|
12420
12800
|
UNKNOWN_LinkType = "UNKNOWN_LinkType",
|
|
@@ -12443,6 +12823,8 @@ export declare enum LinkType {
|
|
|
12443
12823
|
/** A link that directs the user to wix login dialog */
|
|
12444
12824
|
loginToWixLink = "loginToWixLink"
|
|
12445
12825
|
}
|
|
12826
|
+
/** @enumType */
|
|
12827
|
+
export type LinkTypeWithLiterals = LinkType | 'UNKNOWN_LinkType' | 'externalLink' | 'anchorLink' | 'emailLink' | 'phoneLink' | 'dynamicPageLink' | 'pageLink' | 'whatsAppLink' | 'documentLink' | 'popupLink' | 'addressLink' | 'edgeAnchorLinks' | 'loginToWixLink';
|
|
12446
12828
|
/** An array of data items or complex data types */
|
|
12447
12829
|
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
12448
12830
|
/** The definition of multiple data items in each item of the Array */
|
|
@@ -12484,7 +12866,7 @@ export interface ReactElementContainer extends ReactElementContainerSelectedCont
|
|
|
12484
12866
|
*/
|
|
12485
12867
|
selector?: string;
|
|
12486
12868
|
/** The type of Container to be rendered */
|
|
12487
|
-
containerType?:
|
|
12869
|
+
containerType?: ContainerTypeWithLiterals;
|
|
12488
12870
|
}
|
|
12489
12871
|
/** @oneof */
|
|
12490
12872
|
export interface ReactElementContainerSelectedContainerTypeOneOf {
|
|
@@ -12505,6 +12887,8 @@ export declare enum ContainerType {
|
|
|
12505
12887
|
/** A container to add elements targeting a specific product use case, exposed in DEV Center */
|
|
12506
12888
|
placeholder = "placeholder"
|
|
12507
12889
|
}
|
|
12890
|
+
/** @enumType */
|
|
12891
|
+
export type ContainerTypeWithLiterals = ContainerType | 'UNKNOWN_CONTAINER_TYPE' | 'simple' | 'slot' | 'placeholder';
|
|
12508
12892
|
/** Currently doesn't have any properties defined */
|
|
12509
12893
|
export interface SimpleContainer {
|
|
12510
12894
|
}
|
|
@@ -12528,7 +12912,7 @@ export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
|
12528
12912
|
/** A reference to the used element with overrides */
|
|
12529
12913
|
refElement?: RefElement;
|
|
12530
12914
|
/** Defines the type of element we are configuring */
|
|
12531
|
-
elementType?:
|
|
12915
|
+
elementType?: ElementTypeWithLiterals;
|
|
12532
12916
|
}
|
|
12533
12917
|
/** @oneof */
|
|
12534
12918
|
export interface ElementItemSelectedElementTypeOneOf {
|
|
@@ -12544,6 +12928,8 @@ export declare enum ElementType {
|
|
|
12544
12928
|
/** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
|
|
12545
12929
|
refElement = "refElement"
|
|
12546
12930
|
}
|
|
12931
|
+
/** @enumType */
|
|
12932
|
+
export type ElementTypeWithLiterals = ElementType | 'UNKNOWN_ElementType' | 'inlineElement' | 'refElement';
|
|
12547
12933
|
export interface InlineElement {
|
|
12548
12934
|
/**
|
|
12549
12935
|
* Relative DOM Query selector for this element. We assume nesting by it's parent elements for CSS Vars scoping.
|
|
@@ -12574,7 +12960,7 @@ export interface InlineElement {
|
|
|
12574
12960
|
/** The default preset, styles and data of inner elements */
|
|
12575
12961
|
elementsDefaults?: Record<string, ElementDefaults>;
|
|
12576
12962
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
12577
|
-
archetype?:
|
|
12963
|
+
archetype?: ArchetypeWithLiterals;
|
|
12578
12964
|
}
|
|
12579
12965
|
export interface Behaviors {
|
|
12580
12966
|
/** Determines if the inner-element can be selectable in the editor */
|
|
@@ -12619,7 +13005,7 @@ export interface Execution extends ExecutionActionExecuteOneOf {
|
|
|
12619
13005
|
/** Executes an action on a target element (based on path) */
|
|
12620
13006
|
forward?: ForwardAction;
|
|
12621
13007
|
/** The action type allows to determine the return type of the execution function */
|
|
12622
|
-
actionType?:
|
|
13008
|
+
actionType?: ActionTypeWithLiterals;
|
|
12623
13009
|
}
|
|
12624
13010
|
/** @oneof */
|
|
12625
13011
|
export interface ExecutionActionExecuteOneOf {
|
|
@@ -12642,6 +13028,8 @@ export declare enum ActionType {
|
|
|
12642
13028
|
forward = "forward",
|
|
12643
13029
|
style = "style"
|
|
12644
13030
|
}
|
|
13031
|
+
/** @enumType */
|
|
13032
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ActionType' | 'data' | 'event' | 'panel' | 'forward' | 'style';
|
|
12645
13033
|
/** Represents an action that interacts with a specific data item */
|
|
12646
13034
|
export interface DataAction {
|
|
12647
13035
|
/**
|
|
@@ -12677,7 +13065,7 @@ export interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
|
|
|
12677
13065
|
*/
|
|
12678
13066
|
panelId?: string;
|
|
12679
13067
|
/** The selected panel reference type */
|
|
12680
|
-
panelType?:
|
|
13068
|
+
panelType?: PanelTypeWithLiterals;
|
|
12681
13069
|
}
|
|
12682
13070
|
/** @oneof */
|
|
12683
13071
|
export interface PanelActionSelectedPanelTypeOneOf {
|
|
@@ -12692,6 +13080,8 @@ export declare enum PanelType {
|
|
|
12692
13080
|
UNKNOWN_PanelType = "UNKNOWN_PanelType",
|
|
12693
13081
|
panelId = "panelId"
|
|
12694
13082
|
}
|
|
13083
|
+
/** @enumType */
|
|
13084
|
+
export type PanelTypeWithLiterals = PanelType | 'UNKNOWN_PanelType' | 'panelId';
|
|
12695
13085
|
/** Represents an action that targets another element within the component */
|
|
12696
13086
|
export interface ForwardAction extends ForwardActionActionOneOf {
|
|
12697
13087
|
/**
|
|
@@ -12701,7 +13091,7 @@ export interface ForwardAction extends ForwardActionActionOneOf {
|
|
|
12701
13091
|
*/
|
|
12702
13092
|
custom?: string;
|
|
12703
13093
|
/** Specifies the action names (one of the natives or custom) */
|
|
12704
|
-
actionName?:
|
|
13094
|
+
actionName?: ActionNameWithLiterals;
|
|
12705
13095
|
/**
|
|
12706
13096
|
* Path to the target element
|
|
12707
13097
|
* @minLength 1
|
|
@@ -12733,6 +13123,8 @@ export declare enum ActionName {
|
|
|
12733
13123
|
/** actionName to be triggered from the defined custom actions */
|
|
12734
13124
|
custom = "custom"
|
|
12735
13125
|
}
|
|
13126
|
+
/** @enumType */
|
|
13127
|
+
export type ActionNameWithLiterals = ActionName | 'UNKNOWN_ActionName' | 'settings' | 'design' | 'media' | 'manageItems' | 'dashboard' | 'custom';
|
|
12736
13128
|
export interface DashboardAction {
|
|
12737
13129
|
/** Defines whether the action is being displayed */
|
|
12738
13130
|
hidden?: boolean | null;
|
|
@@ -12802,7 +13194,7 @@ export interface InitialSizeSetting extends InitialSizeSettingSelectedSizingType
|
|
|
12802
13194
|
*/
|
|
12803
13195
|
pixels?: number;
|
|
12804
13196
|
/** The initial size type */
|
|
12805
|
-
sizingType?:
|
|
13197
|
+
sizingType?: SizingTypeWithLiterals;
|
|
12806
13198
|
}
|
|
12807
13199
|
/** @oneof */
|
|
12808
13200
|
export interface InitialSizeSettingSelectedSizingTypeOneOf {
|
|
@@ -12821,6 +13213,8 @@ export declare enum SizingType {
|
|
|
12821
13213
|
/** Initial size should be set in pixels */
|
|
12822
13214
|
pixels = "pixels"
|
|
12823
13215
|
}
|
|
13216
|
+
/** @enumType */
|
|
13217
|
+
export type SizingTypeWithLiterals = SizingType | 'UNKNOWN_SizingType' | 'content' | 'stretched' | 'pixels';
|
|
12824
13218
|
export interface ElementDefaults {
|
|
12825
13219
|
/**
|
|
12826
13220
|
* The default preset for an element
|
|
@@ -12874,6 +13268,8 @@ export declare enum Archetype {
|
|
|
12874
13268
|
VectorArt = "VectorArt",
|
|
12875
13269
|
AnimatedGraphic = "AnimatedGraphic"
|
|
12876
13270
|
}
|
|
13271
|
+
/** @enumType */
|
|
13272
|
+
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';
|
|
12877
13273
|
export interface RefElement {
|
|
12878
13274
|
/**
|
|
12879
13275
|
* The type of the referenced element. Must exist in the Wix Dev Center and be fullly typed (`appSlug.componentType`).
|
|
@@ -12925,9 +13321,9 @@ export interface DataItemOverrides {
|
|
|
12925
13321
|
/** Top-level message containing all layout capabilities */
|
|
12926
13322
|
export interface EditorElementLayout {
|
|
12927
13323
|
/** The resizing capabilities this component can supports */
|
|
12928
|
-
resizeDirection?:
|
|
13324
|
+
resizeDirection?: ResizeDirectionWithLiterals;
|
|
12929
13325
|
/** Describes the ability of content to impact on the size of this component */
|
|
12930
|
-
contentResizeDirection?:
|
|
13326
|
+
contentResizeDirection?: ContentResizeDirectionWithLiterals;
|
|
12931
13327
|
/** Will control the availability of the stretch capability for this component */
|
|
12932
13328
|
disableStretching?: boolean | null;
|
|
12933
13329
|
/** Will control the availability of freely positioning this component */
|
|
@@ -12947,6 +13343,8 @@ export declare enum ResizeDirection {
|
|
|
12947
13343
|
/** Component cannot be resized in any direction */
|
|
12948
13344
|
none = "none"
|
|
12949
13345
|
}
|
|
13346
|
+
/** @enumType */
|
|
13347
|
+
export type ResizeDirectionWithLiterals = ResizeDirection | 'UNKNOWN_ResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'aspectRatio' | 'none';
|
|
12950
13348
|
export declare enum ContentResizeDirection {
|
|
12951
13349
|
/** Default value when content resize behavior is not specified */
|
|
12952
13350
|
UNKNOWN_ContentResizeDirection = "UNKNOWN_ContentResizeDirection",
|
|
@@ -12959,9 +13357,11 @@ export declare enum ContentResizeDirection {
|
|
|
12959
13357
|
/** Component's size will not be affected by its content */
|
|
12960
13358
|
none = "none"
|
|
12961
13359
|
}
|
|
13360
|
+
/** @enumType */
|
|
13361
|
+
export type ContentResizeDirectionWithLiterals = ContentResizeDirection | 'UNKNOWN_ContentResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'none';
|
|
12962
13362
|
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
12963
13363
|
/** Which static container should the component be installed at */
|
|
12964
|
-
staticContainer?:
|
|
13364
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12965
13365
|
/** Default presets per breakpoint with which the component should be installed */
|
|
12966
13366
|
presets?: DefaultPresets;
|
|
12967
13367
|
/** Initial size with which the component should be added to the stage */
|
|
@@ -12970,7 +13370,7 @@ export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
|
12970
13370
|
/** @oneof */
|
|
12971
13371
|
export interface InstallationInfoTargetContainerOneOf {
|
|
12972
13372
|
/** Which static container should the component be installed at */
|
|
12973
|
-
staticContainer?:
|
|
13373
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12974
13374
|
}
|
|
12975
13375
|
export interface MarketplaceSPIConfig {
|
|
12976
13376
|
/** URI where the SPI implementer is deployed */
|
|
@@ -13012,32 +13412,62 @@ export interface RewardProviderConfig {
|
|
|
13012
13412
|
export interface ProductRestrictionsConfig {
|
|
13013
13413
|
/** URI where the SPI Implementer is deployed */
|
|
13014
13414
|
deploymentUri?: SpiBaseUri;
|
|
13015
|
-
/**
|
|
13415
|
+
/** Product restrictions configuration. */
|
|
13016
13416
|
productRestrictionsConfig?: RestrictionsConfig;
|
|
13017
13417
|
}
|
|
13018
13418
|
export interface RestrictionsConfig {
|
|
13019
|
-
/**
|
|
13419
|
+
/**
|
|
13420
|
+
* Prices restrictions.
|
|
13421
|
+
*
|
|
13422
|
+
* Affected fields:
|
|
13423
|
+
* * `variantsInfo.variants.price.actualPrice.amount`
|
|
13424
|
+
* * `variantsInfo.variants.price.compareAtPrice.amount`
|
|
13425
|
+
* * `inventory.trackingMethod.quantity`
|
|
13426
|
+
*/
|
|
13020
13427
|
prices?: Restriction;
|
|
13021
|
-
/**
|
|
13428
|
+
/**
|
|
13429
|
+
* Options restrictions.
|
|
13430
|
+
*
|
|
13431
|
+
* Affected field: `options` (all nested fields except `linkedMedia`)
|
|
13432
|
+
*/
|
|
13022
13433
|
options?: Restriction;
|
|
13023
|
-
/**
|
|
13434
|
+
/**
|
|
13435
|
+
* Modifier restrictions.
|
|
13436
|
+
*
|
|
13437
|
+
* Affected field: `modifiers` (all nested fields except `linkedMedia`)
|
|
13438
|
+
*/
|
|
13024
13439
|
modifiers?: Restriction;
|
|
13025
|
-
/**
|
|
13440
|
+
/**
|
|
13441
|
+
* Inventory restrictions.
|
|
13442
|
+
*
|
|
13443
|
+
* Affected fields:
|
|
13444
|
+
* * `variantsInfo.variants.sku`
|
|
13445
|
+
* * `variantsInfo.variants.barcode`
|
|
13446
|
+
* * `inventory.trackingMethod.quantity`
|
|
13447
|
+
*/
|
|
13026
13448
|
inventory?: Restriction;
|
|
13027
|
-
/**
|
|
13449
|
+
/**
|
|
13450
|
+
* Pre order restrictions.
|
|
13451
|
+
*
|
|
13452
|
+
* Affected field: `inventory.preorderInfo`
|
|
13453
|
+
*/
|
|
13028
13454
|
preOrder?: Restriction;
|
|
13029
|
-
/**
|
|
13455
|
+
/** Whether to disallow product duplication or display a warning when duplicating a product. */
|
|
13030
13456
|
duplicateProduct?: Restriction;
|
|
13031
13457
|
}
|
|
13032
13458
|
export interface Restriction {
|
|
13033
|
-
/**
|
|
13034
|
-
restrictionLevel?:
|
|
13459
|
+
/** Restriction level. */
|
|
13460
|
+
restrictionLevel?: RestrictionLevelWithLiterals;
|
|
13035
13461
|
}
|
|
13036
13462
|
export declare enum RestrictionLevel {
|
|
13037
13463
|
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
13464
|
+
/** Users can edit the product field after acknowledging a warning modal. */
|
|
13038
13465
|
WARNING = "WARNING",
|
|
13466
|
+
/** Users **cannot** edit the product field. */
|
|
13039
13467
|
LOCKED = "LOCKED"
|
|
13040
13468
|
}
|
|
13469
|
+
/** @enumType */
|
|
13470
|
+
export type RestrictionLevelWithLiterals = RestrictionLevel | 'UNKNOWN_RESTRICTION_TYPE' | 'WARNING' | 'LOCKED';
|
|
13041
13471
|
export interface FormSubmissionModerationSpiConfig {
|
|
13042
13472
|
/** URI where the SPI Implementer is deployed */
|
|
13043
13473
|
deploymentUri?: SpiBaseUri;
|
|
@@ -13089,7 +13519,7 @@ export interface BackOfficeCustomization {
|
|
|
13089
13519
|
export interface Header extends HeaderConfigOneOf {
|
|
13090
13520
|
/** Only set if option == CUSTOMIZED */
|
|
13091
13521
|
customized?: HeaderConfig;
|
|
13092
|
-
displayOption?:
|
|
13522
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13093
13523
|
}
|
|
13094
13524
|
/** @oneof */
|
|
13095
13525
|
export interface HeaderConfigOneOf {
|
|
@@ -13101,6 +13531,8 @@ export declare enum ElementDisplayOption {
|
|
|
13101
13531
|
REMOVE = "REMOVE",
|
|
13102
13532
|
CUSTOMIZED = "CUSTOMIZED"
|
|
13103
13533
|
}
|
|
13534
|
+
/** @enumType */
|
|
13535
|
+
export type ElementDisplayOptionWithLiterals = ElementDisplayOption | 'UNKNOWN_OPTION' | 'REMOVE' | 'CUSTOMIZED';
|
|
13104
13536
|
/** Header configuration, you can provide extensionId or using our platform header */
|
|
13105
13537
|
export interface HeaderConfig extends HeaderConfigHeaderConfigOneOf {
|
|
13106
13538
|
platform?: PlatformHeaderConfig;
|
|
@@ -13181,7 +13613,7 @@ export interface HeaderWidgetConfig {
|
|
|
13181
13613
|
export interface Sidebar extends SidebarConfigOneOf {
|
|
13182
13614
|
/** Only set if option == CUSTOMIZED */
|
|
13183
13615
|
customized?: SidebarConfig;
|
|
13184
|
-
displayOption?:
|
|
13616
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13185
13617
|
}
|
|
13186
13618
|
/** @oneof */
|
|
13187
13619
|
export interface SidebarConfigOneOf {
|
|
@@ -13222,7 +13654,7 @@ export interface SidebarConfig {
|
|
|
13222
13654
|
export interface SidebarChildItem extends SidebarChildItemItemOneOf {
|
|
13223
13655
|
category?: SecondLevelCategory;
|
|
13224
13656
|
page?: Page;
|
|
13225
|
-
type?:
|
|
13657
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13226
13658
|
}
|
|
13227
13659
|
/** @oneof */
|
|
13228
13660
|
export interface SidebarChildItemItemOneOf {
|
|
@@ -13235,6 +13667,8 @@ export declare enum SidebarDataType {
|
|
|
13235
13667
|
PAGE = "PAGE",
|
|
13236
13668
|
SEPARATOR = "SEPARATOR"
|
|
13237
13669
|
}
|
|
13670
|
+
/** @enumType */
|
|
13671
|
+
export type SidebarDataTypeWithLiterals = SidebarDataType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'SEPARATOR';
|
|
13238
13672
|
/** Represents sidebar category of second level */
|
|
13239
13673
|
export interface SecondLevelCategory {
|
|
13240
13674
|
/**
|
|
@@ -13260,7 +13694,7 @@ export interface SecondLevelCategory {
|
|
|
13260
13694
|
*/
|
|
13261
13695
|
export interface SidebarSecondLevelChildItem extends SidebarSecondLevelChildItemItemOneOf {
|
|
13262
13696
|
page?: Page;
|
|
13263
|
-
type?:
|
|
13697
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13264
13698
|
}
|
|
13265
13699
|
/** @oneof */
|
|
13266
13700
|
export interface SidebarSecondLevelChildItemItemOneOf {
|
|
@@ -13306,7 +13740,7 @@ export interface SidebarWidgetConfig {
|
|
|
13306
13740
|
/** Root level sidebar item, can be category or separator (when not setting category) */
|
|
13307
13741
|
export interface SidebarRootItem extends SidebarRootItemItemOneOf {
|
|
13308
13742
|
category?: FirstLevelCategory;
|
|
13309
|
-
type?:
|
|
13743
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13310
13744
|
}
|
|
13311
13745
|
/** @oneof */
|
|
13312
13746
|
export interface SidebarRootItemItemOneOf {
|
|
@@ -13317,7 +13751,7 @@ export interface SidebarWidget extends SidebarWidgetConfigOneOf {
|
|
|
13317
13751
|
/** Only set if option == CUSTOMIZED */
|
|
13318
13752
|
customized?: SidebarWidgetConfig;
|
|
13319
13753
|
/** Widget display option */
|
|
13320
|
-
displayOption?:
|
|
13754
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13321
13755
|
}
|
|
13322
13756
|
/** @oneof */
|
|
13323
13757
|
export interface SidebarWidgetConfigOneOf {
|
|
@@ -13343,7 +13777,7 @@ export interface BackOfficeCustomizationSidebarEntity extends BackOfficeCustomiz
|
|
|
13343
13777
|
*/
|
|
13344
13778
|
appId?: string | null;
|
|
13345
13779
|
/** Sidebar entity type */
|
|
13346
|
-
type?:
|
|
13780
|
+
type?: SidebarEntityTypeWithLiterals;
|
|
13347
13781
|
}
|
|
13348
13782
|
/** @oneof */
|
|
13349
13783
|
export interface BackOfficeCustomizationSidebarEntityItemOneOf {
|
|
@@ -13371,6 +13805,8 @@ export declare enum SidebarEntityType {
|
|
|
13371
13805
|
PAGE = "PAGE",
|
|
13372
13806
|
APP = "APP"
|
|
13373
13807
|
}
|
|
13808
|
+
/** @enumType */
|
|
13809
|
+
export type SidebarEntityTypeWithLiterals = SidebarEntityType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'APP';
|
|
13374
13810
|
export interface CoreApps {
|
|
13375
13811
|
/**
|
|
13376
13812
|
* List of core appIds to include in the dashboard. Only appIds present in the host's coreAppId list are allowed.
|
|
@@ -13391,7 +13827,7 @@ export interface ComponentEnricherConfig {
|
|
|
13391
13827
|
* @minSize 1
|
|
13392
13828
|
* @maxSize 100
|
|
13393
13829
|
*/
|
|
13394
|
-
componentEnrichmentTypes?:
|
|
13830
|
+
componentEnrichmentTypes?: ComponentTypeWithLiterals[];
|
|
13395
13831
|
}
|
|
13396
13832
|
/** Back-office Restricted Customization */
|
|
13397
13833
|
export interface BackOfficeRestrictedCustomization {
|
|
@@ -13498,6 +13934,16 @@ export interface EventTimeSlotsProviderConfig {
|
|
|
13498
13934
|
*/
|
|
13499
13935
|
eventServiceIdField?: string | null;
|
|
13500
13936
|
}
|
|
13937
|
+
export interface AppEnvironmentProviderConfig {
|
|
13938
|
+
/** URI where the SPI implementer is deployed */
|
|
13939
|
+
deploymentUri?: SpiBaseUri;
|
|
13940
|
+
/**
|
|
13941
|
+
* `true` if SPI implementer provides custom permission checks API calls
|
|
13942
|
+
*
|
|
13943
|
+
* Default: `false`
|
|
13944
|
+
*/
|
|
13945
|
+
toggleIsAppEnvironmentPermitted?: boolean;
|
|
13946
|
+
}
|
|
13501
13947
|
export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
|
|
13502
13948
|
gradualRollout?: GradualRolloutCacheEntity;
|
|
13503
13949
|
gradualUpdate?: GradualUpdateCacheEntity;
|