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