@wix/auto_sdk_data-extension-schema_schemas 1.0.24 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +692 -246
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +692 -246
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +692 -246
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.context.d.ts +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.public.d.ts +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.public.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +691 -245
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.js +3 -0
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts +692 -246
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js +3 -0
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.d.ts
CHANGED
|
@@ -130,6 +130,8 @@ export interface DataExtensionSchema {
|
|
|
130
130
|
}
|
|
131
131
|
export declare enum DataExtensionSchemaState {
|
|
132
132
|
}
|
|
133
|
+
/** @enumType */
|
|
134
|
+
export type DataExtensionSchemaStateWithLiterals = DataExtensionSchemaState;
|
|
133
135
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
134
136
|
createdEvent?: EntityCreatedEvent;
|
|
135
137
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -230,7 +232,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
230
232
|
*/
|
|
231
233
|
appId?: string;
|
|
232
234
|
/** @readonly */
|
|
233
|
-
identityType?:
|
|
235
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
234
236
|
}
|
|
235
237
|
/** @oneof */
|
|
236
238
|
export interface IdentificationDataIdOneOf {
|
|
@@ -262,6 +264,8 @@ export declare enum WebhookIdentityType {
|
|
|
262
264
|
WIX_USER = "WIX_USER",
|
|
263
265
|
APP = "APP"
|
|
264
266
|
}
|
|
267
|
+
/** @enumType */
|
|
268
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
265
269
|
export interface ReindexEvent {
|
|
266
270
|
/**
|
|
267
271
|
* fqdn of the dext schema that needs reindexing
|
|
@@ -315,7 +319,7 @@ export interface ListDataExtensionSchemasRequest {
|
|
|
315
319
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
316
320
|
* @maxSize 5
|
|
317
321
|
*/
|
|
318
|
-
fields?:
|
|
322
|
+
fields?: RequestedFieldWithLiterals[];
|
|
319
323
|
/**
|
|
320
324
|
* Extension points within the given entity.
|
|
321
325
|
* @maxSize 20
|
|
@@ -329,6 +333,8 @@ export declare enum RequestedField {
|
|
|
329
333
|
/** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
|
|
330
334
|
ARCHIVED = "ARCHIVED"
|
|
331
335
|
}
|
|
336
|
+
/** @enumType */
|
|
337
|
+
export type RequestedFieldWithLiterals = RequestedField | 'UNKNOWN_REQUESTED_FIELD' | 'ARCHIVED';
|
|
332
338
|
export interface ListDataExtensionSchemasResponse {
|
|
333
339
|
/** Requested schemas. */
|
|
334
340
|
dataExtensionSchemas?: DataExtensionSchema[];
|
|
@@ -359,7 +365,7 @@ export interface DeleteGlobalExtensionSchemaRequest {
|
|
|
359
365
|
*/
|
|
360
366
|
extensionPoint?: string;
|
|
361
367
|
/** state */
|
|
362
|
-
state?:
|
|
368
|
+
state?: DataExtensionSchemaStateWithLiterals;
|
|
363
369
|
}
|
|
364
370
|
export interface DeleteGlobalExtensionSchemaResponse {
|
|
365
371
|
}
|
|
@@ -407,7 +413,7 @@ export interface RuntimeComponentCacheEntityComponent {
|
|
|
407
413
|
*/
|
|
408
414
|
name?: string | null;
|
|
409
415
|
/** the type of the component */
|
|
410
|
-
type?:
|
|
416
|
+
type?: ComponentTypeWithLiterals;
|
|
411
417
|
/** the data of the component */
|
|
412
418
|
data?: ComponentData;
|
|
413
419
|
/** The external id of the component */
|
|
@@ -605,8 +611,11 @@ export declare enum ComponentType {
|
|
|
605
611
|
LEGENDS_PERSONA_CONFIGURATION = "LEGENDS_PERSONA_CONFIGURATION",
|
|
606
612
|
WIX_HOSTING_APP_DEPLOYMENT_PROVIDER = "WIX_HOSTING_APP_DEPLOYMENT_PROVIDER",
|
|
607
613
|
BACKEND_WORKER = "BACKEND_WORKER",
|
|
608
|
-
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER"
|
|
614
|
+
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER",
|
|
615
|
+
WIX_HOSTING_APP_ENVIRONMENT_PROVIDER = "WIX_HOSTING_APP_ENVIRONMENT_PROVIDER"
|
|
609
616
|
}
|
|
617
|
+
/** @enumType */
|
|
618
|
+
export type ComponentTypeWithLiterals = ComponentType | 'NONE' | 'STUDIO' | 'PLATFORM' | 'WORKER' | 'DASHBOARD' | 'WIDGET' | 'PAGE' | 'DASHBOARD_PLATFORM' | 'STUDIO_WIDGET' | 'EMBEDDED_SCRIPT' | 'EXTENSION' | 'SNIPPET_SOLUTION' | 'DATA_COMPONENT' | 'WEB' | 'DC_CONFIG' | 'WIDGET_OUT_OF_IFRAME' | 'PAGE_OUT_OF_IFRAME' | 'STATIC_FILE' | 'APP_CONFIG' | 'MULTIPLE_DASHBOARDS' | 'PAYMENTS_GATEWAY' | 'CODE_PACKAGE' | 'AUTOMATION_TRIGGER' | 'INVOICES_ACTIONS' | 'DASHBOARD_APPLICATION' | 'CONTACT_LABELS' | 'WIDGET_PLUGIN' | 'CROSS_SELL' | 'LOCAL_DELIVERY' | 'PAYMENT_PROVIDER' | 'ECOM_MEMBERSHIPS' | 'ECOM_LINE_ITEMS_ENRICHER' | 'ECOM_SHIPPING_RATES' | 'SHIPPING_LABEL_CARRIER' | 'RESTAURANTS_POS' | 'FICTIONAL_SHIPPING_PROVIDER' | 'ALERT_ENRICHER' | 'DATA_EXTENSIONS' | 'GENERIC_HOOKS' | 'AUTOMATIONS_ACTION_PROVIDER' | 'ECOM_CATALOG' | 'BACK_OFFICE_EXTENSION_CONTAINER' | 'BACK_OFFICE_EXTENSION' | 'AUTOMATIONS_TRIGGER_PROVIDER' | 'IDENTITY_PRE_REGISTRATION' | 'PREMIUM_PRODUCTS_PATHS' | 'ECOM_CUSTOM_SCOPE' | 'GIFT_CARDS_PROVIDER' | 'DEALER_EXTERNAL_FILTER_PROVIDER' | 'ECOM_DROPSHIPPING_PROVIDER' | 'INVOICES_PROVIDER' | 'SEO_KEYWORDS_SUGGESTIONS' | 'ECOM_DISCOUNTS_TRIGGER' | 'MULTILINGUAL_CONTENT_PROVIDER' | 'APPLICATION_AUTOMATION' | 'BACK_OFFICE_SIDEBAR_CATEGORY' | 'BACK_OFFICE_PAGE' | 'ECOM_ADDITIONAL_FEES' | 'PING_USER_NOTIFICATION' | 'ECOM_RECOMMENDATIONS_PROVIDER' | 'BOOKINGS_PRICING_PROVIDER' | 'IDENTITY_AUTHENTICATOR' | 'IDENTITY_IDP_CONNECTOR' | 'ITEMS_SELECTION_PROVIDER' | 'PORTFOLIO_SYNCED_PROJECTS_PROVIDER' | 'COMMUNICATION_CHANNEL' | 'IDENTITY_POST_LOGIN' | 'BACK_OFFICE_WIDGET' | 'SOCIAL_MARKETING_DESIGN' | 'FORMS_SUBMISSIONS_PROVIDER' | 'WIX_OFFERING' | 'DEV_CENTER_TESTING_COMPONENT' | 'COMPONENTS_VALIDATOR_PROVIDER' | 'COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER' | 'FORMS_SCHEMA_PROVIDER' | 'BOOKINGS_EXTERNAL_CALENDAR_PROVIDER' | 'ECOM_DEFAULT_TAXATION_CATEGORY' | 'VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER' | 'PING_UOU_NOTIFICATION' | 'HEADLESS_OAUTH' | 'ECOM_TAX_CALCULATOR_SPI' | 'COMMENTS_MODERATION_PROVIDER' | 'GRID_APP_FILES_TRANSFORMER' | 'BENEFIT_PROGRAMS_POLICY_PROVIDER' | 'PREMIUM_CUSTOM_CHARGES' | 'ECOM_VALIDATIONS' | 'COMPONENT_REFERENCE_DATA_PROVIDER' | 'WIX_REVIEWS_PRODUCT_CATALOG' | 'SOCIAL_MARKETING_DESIGNS_PROVIDER' | 'GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER' | 'COMMENTS_FILTER_PROVIDER' | 'BILLING_TAX_ID_VALIDATOR' | 'PING_SETTINGS_GROUP' | 'FORMS_SPAM_SUBMISSIONS_PROVIDER' | 'EDITOR_ADDON' | 'EXTERNAL_DATABASE_PROVIDER' | 'ECOM_PAYMENT_SETTINGS' | 'NOTIFICATION_TOPIC' | 'NOTIFICATION_PREFERENCES_FILTER_PROVIDER' | 'BOOKINGS_RESOURCE_TYPES_PROVIDER' | 'PRICING_PLANS_FORM_CONFIGURATION' | 'USER_NOTIFICATION' | 'CONTACT_NOTIFICATION' | 'UNIFIED_PAGE' | 'AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'PROPOSAL_EDITOR_PROVIDER' | 'CUSTOM_TABLE_RESERVATIONS_PROVIDER' | 'COMMENTS_CONTEXT_PROVIDER' | 'FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER' | 'AUTOMATIONS_VELO_ACTION_PROVIDER' | 'CALENDAR_EVENT_TYPE_PROVIDER' | 'RESERVED' | 'SMS_ACTION_MESSAGE' | 'BOOKING_POLICY_PROVIDER' | 'MULTI_SERVICE_BOOKING_POLICY_PROVIDER' | 'AI_ASSISTANT' | 'FORMS_SUBMISSIONS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA' | 'TAX_CALCULATION_PROVIDER' | 'TAX_GROUPS_PROVIDER' | 'BACK_OFFICE_MODAL' | 'DEPLOYMENT_PIPELINE_PROVIDER' | 'CUSTOM_ELEMENT_WIDGET' | 'BACK_OFFICE_EXTENSION_WIDGET' | 'BACK_OFFICE_EXTENSION_MENU_ITEM' | 'FORM_TEMPLATE' | 'NOTIFICATION_CONTENT' | 'BROADCAST_LIST' | 'PARTNERS_PAYOUTS' | 'WIX_REVIEWS_ENTITY_CATALOG' | 'VELO_PUBLISH_PIPELINE_TASK_PROVIDER' | 'FUNCTIONS_SHOP_PRICE_PROVIDER' | 'FUNCTION' | 'ECOM_CHECKOUT_CONTENT' | 'COMMUNICATION_CHANNEL_PROVIDER' | 'WEBHOOK' | 'TOPOLOGY' | 'LOYALTY_CUSTOM_REWARDS' | 'FUNCTION_RECIPE' | 'BACK_OFFICE_EXTERNAL_URL' | 'IDENTITY_FACTOR' | 'ECOM_DISCOUNTS' | 'VELO_CUSTOM_CSS' | 'DEALER_ADAPTIVE_COMPONENT_PROVIDER' | 'AI_ASSISTANT_ACTION' | 'ECOM_INVENTORY' | 'MONITORING' | 'PAPI_PROVIDER' | 'UNIFIED_LIGHTBOX' | 'FORMS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA_GROUP' | 'PANEL' | 'PREMIUM_PURCHASE_VALIDATIONS' | 'BROWSER_STORAGE' | 'SDK_DEFINITION' | 'SITE_WIDGET_SLOT' | 'CALENDAR_EVENT_VALIDATION_PROVIDER' | 'CLIENT_SIDE_SERVICE' | 'BILLING_SETTINGS' | 'PATTERNS_WIZARD' | 'APPLICATION_PROFILE' | 'TEXT_TO_SPEECH_ACTION_MESSAGE' | 'AUDIENCE_PROVIDER' | 'PRICING_PLANS_PRICE' | 'PRICING_PLAN_START_DATE_LIMITS' | 'PRICING_PLAN_START_DATE_RULES' | 'EVENTS_TICKET_RESERVATIONS' | 'PAYMENTS_DISPUTE_SERVICE_PLUGIN' | 'PRICING_PLANS_FEES' | 'EDITOR_REACT_COMPONENT' | 'SUPPLIERS_HUB_MARKETPLACE' | 'FORM_SCHEMA_DYNAMIC_VALUES' | 'BLOG_PAYWALL_PROVIDER' | 'LOYALTY_CUSTOM_REWARDS_V2' | 'STORES_PRODUCT_RESTRICTIONS' | 'FORM_SUBMISSION_MODERATION' | 'EVENTS_EVENT_BADGES' | 'BILLING_OPERATION' | 'BACK_OFFICE_CUSTOMIZATION' | 'COMPONENT_ENRICHER_PROVIDER' | 'BACK_OFFICE_RESTRICTED_CUSTOMIZATION' | 'EDITOR_APP_PREVIEWS_POC' | 'LEGENDS_PERSONA_CONFIGURATION' | 'WIX_HOSTING_APP_DEPLOYMENT_PROVIDER' | 'BACKEND_WORKER' | 'EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'WIX_HOSTING_APP_ENVIRONMENT_PROVIDER';
|
|
610
619
|
/** Component data */
|
|
611
620
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
612
621
|
/**
|
|
@@ -810,7 +819,7 @@ export interface WidgetComponentData {
|
|
|
810
819
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
811
820
|
fixedPositionOption?: FixedPositionOptions;
|
|
812
821
|
/** Widget will automatically be stretched to this width after installing it */
|
|
813
|
-
widgetWidthType?:
|
|
822
|
+
widgetWidthType?: WidgetWidthTypeWithLiterals;
|
|
814
823
|
/**
|
|
815
824
|
* Widget width size
|
|
816
825
|
* @max 9999
|
|
@@ -893,9 +902,9 @@ export interface WidgetComponentData {
|
|
|
893
902
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
894
903
|
export interface FixedPositionOptions {
|
|
895
904
|
/** Vertical widget position in the browser window */
|
|
896
|
-
widgetVertical?:
|
|
905
|
+
widgetVertical?: WidgetVerticalWithLiterals;
|
|
897
906
|
/** Horizontal widget position in the browser window */
|
|
898
|
-
widgetHorizontal?:
|
|
907
|
+
widgetHorizontal?: WidgetHorizontalWithLiterals;
|
|
899
908
|
}
|
|
900
909
|
/** Vertical widget position in the browser window */
|
|
901
910
|
export declare enum WidgetVertical {
|
|
@@ -904,6 +913,8 @@ export declare enum WidgetVertical {
|
|
|
904
913
|
CENTER_VERTICAL = "CENTER_VERTICAL",
|
|
905
914
|
BOTTOM = "BOTTOM"
|
|
906
915
|
}
|
|
916
|
+
/** @enumType */
|
|
917
|
+
export type WidgetVerticalWithLiterals = WidgetVertical | 'NONE_VERTICAL' | 'TOP' | 'CENTER_VERTICAL' | 'BOTTOM';
|
|
907
918
|
/** Horizontal widget position in the browser window */
|
|
908
919
|
export declare enum WidgetHorizontal {
|
|
909
920
|
NONE_HORIZONTAL = "NONE_HORIZONTAL",
|
|
@@ -911,6 +922,8 @@ export declare enum WidgetHorizontal {
|
|
|
911
922
|
CENTER_HORIZONTAL = "CENTER_HORIZONTAL",
|
|
912
923
|
RIGHT = "RIGHT"
|
|
913
924
|
}
|
|
925
|
+
/** @enumType */
|
|
926
|
+
export type WidgetHorizontalWithLiterals = WidgetHorizontal | 'NONE_HORIZONTAL' | 'LEFT' | 'CENTER_HORIZONTAL' | 'RIGHT';
|
|
914
927
|
/** Widget will automatically be stretched to this width after installing it */
|
|
915
928
|
export declare enum WidgetWidthType {
|
|
916
929
|
NONE_TYPE = "NONE_TYPE",
|
|
@@ -919,6 +932,8 @@ export declare enum WidgetWidthType {
|
|
|
919
932
|
/** Full width of the browser window */
|
|
920
933
|
FULL = "FULL"
|
|
921
934
|
}
|
|
935
|
+
/** @enumType */
|
|
936
|
+
export type WidgetWidthTypeWithLiterals = WidgetWidthType | 'NONE_TYPE' | 'CUSTOM' | 'FULL';
|
|
922
937
|
export interface WidgetDisplay {
|
|
923
938
|
name?: string;
|
|
924
939
|
/**
|
|
@@ -934,7 +949,7 @@ export interface WidgetDisplay {
|
|
|
934
949
|
variationId?: string | null;
|
|
935
950
|
}
|
|
936
951
|
export interface Position {
|
|
937
|
-
region?:
|
|
952
|
+
region?: RegionWithLiterals;
|
|
938
953
|
}
|
|
939
954
|
export declare enum Region {
|
|
940
955
|
no_region = "no_region",
|
|
@@ -942,6 +957,8 @@ export declare enum Region {
|
|
|
942
957
|
pageContainer = "pageContainer",
|
|
943
958
|
footer = "footer"
|
|
944
959
|
}
|
|
960
|
+
/** @enumType */
|
|
961
|
+
export type RegionWithLiterals = Region | 'no_region' | 'header' | 'pageContainer' | 'footer';
|
|
945
962
|
export interface SubPage {
|
|
946
963
|
/** The path of the subpage */
|
|
947
964
|
key?: string;
|
|
@@ -969,7 +986,7 @@ export interface DisplayProperties {
|
|
|
969
986
|
left?: DisplayValue;
|
|
970
987
|
}
|
|
971
988
|
export interface DisplayValue {
|
|
972
|
-
type?:
|
|
989
|
+
type?: UnitTypeWithLiterals;
|
|
973
990
|
value?: number | null;
|
|
974
991
|
}
|
|
975
992
|
export declare enum UnitType {
|
|
@@ -980,14 +997,16 @@ export declare enum UnitType {
|
|
|
980
997
|
VW = "VW",
|
|
981
998
|
PERCENTAGE = "PERCENTAGE"
|
|
982
999
|
}
|
|
1000
|
+
/** @enumType */
|
|
1001
|
+
export type UnitTypeWithLiterals = UnitType | 'NO_UNIT' | 'AUTO' | 'PX' | 'VH' | 'VW' | 'PERCENTAGE';
|
|
983
1002
|
export interface Docking {
|
|
984
1003
|
desktop?: DockingProperties;
|
|
985
1004
|
tablet?: DockingProperties;
|
|
986
1005
|
mobile?: DockingProperties;
|
|
987
1006
|
}
|
|
988
1007
|
export interface DockingProperties {
|
|
989
|
-
horizontal?:
|
|
990
|
-
vertical?:
|
|
1008
|
+
horizontal?: HorizontalDockingWithLiterals;
|
|
1009
|
+
vertical?: VerticalDockingWithLiterals;
|
|
991
1010
|
}
|
|
992
1011
|
export declare enum HorizontalDocking {
|
|
993
1012
|
NO_HDOCKING = "NO_HDOCKING",
|
|
@@ -995,12 +1014,16 @@ export declare enum HorizontalDocking {
|
|
|
995
1014
|
HCENTER = "HCENTER",
|
|
996
1015
|
RIGHT_DOCKING = "RIGHT_DOCKING"
|
|
997
1016
|
}
|
|
1017
|
+
/** @enumType */
|
|
1018
|
+
export type HorizontalDockingWithLiterals = HorizontalDocking | 'NO_HDOCKING' | 'LEFT_DOCKING' | 'HCENTER' | 'RIGHT_DOCKING';
|
|
998
1019
|
export declare enum VerticalDocking {
|
|
999
1020
|
NO_VDOCKING = "NO_VDOCKING",
|
|
1000
1021
|
TOP_DOCKING = "TOP_DOCKING",
|
|
1001
1022
|
VCENTER = "VCENTER",
|
|
1002
1023
|
BOTTOM_DOCKING = "BOTTOM_DOCKING"
|
|
1003
1024
|
}
|
|
1025
|
+
/** @enumType */
|
|
1026
|
+
export type VerticalDockingWithLiterals = VerticalDocking | 'NO_VDOCKING' | 'TOP_DOCKING' | 'VCENTER' | 'BOTTOM_DOCKING';
|
|
1004
1027
|
export interface Height {
|
|
1005
1028
|
desktop?: DisplayValue;
|
|
1006
1029
|
tablet?: DisplayValue;
|
|
@@ -1092,7 +1115,7 @@ export interface Padding {
|
|
|
1092
1115
|
export interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {
|
|
1093
1116
|
replacingOptions?: ReplacingOptions;
|
|
1094
1117
|
replaceableOptions?: ReplaceableOptions;
|
|
1095
|
-
type?:
|
|
1118
|
+
type?: ReplacementTypeWithLiterals;
|
|
1096
1119
|
}
|
|
1097
1120
|
/** @oneof */
|
|
1098
1121
|
export interface PageReplaceOptionsOptionsOneOf {
|
|
@@ -1116,6 +1139,8 @@ export declare enum ReplacementType {
|
|
|
1116
1139
|
REPLACING = "REPLACING",
|
|
1117
1140
|
REPLACEABLE = "REPLACEABLE"
|
|
1118
1141
|
}
|
|
1142
|
+
/** @enumType */
|
|
1143
|
+
export type ReplacementTypeWithLiterals = ReplacementType | 'UNKNOWN_REPLACEMENT' | 'REPLACING' | 'REPLACEABLE';
|
|
1119
1144
|
export interface ReplacingOptions {
|
|
1120
1145
|
/** describe the page and application id that this page will replace. */
|
|
1121
1146
|
pageReplace?: PageReplace;
|
|
@@ -1220,7 +1245,7 @@ export interface ApiSlot {
|
|
|
1220
1245
|
/** Role of the slot component (uniquely identifies slot within parent comp; used by Velo) - former "slotName" */
|
|
1221
1246
|
slotRole?: string;
|
|
1222
1247
|
/** The list of interfaces that should be implemented by a plugin in order to fit the slot */
|
|
1223
|
-
pluginInterfaces?:
|
|
1248
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
1224
1249
|
/** Id of the slot component (a.k.a. Velo role) */
|
|
1225
1250
|
slotId?: string;
|
|
1226
1251
|
}
|
|
@@ -1253,9 +1278,11 @@ export declare enum PluginInterface {
|
|
|
1253
1278
|
/** The slot requires the CART interface to be implemented by the plugin. The plugin specifies the implementation of the CART interface */
|
|
1254
1279
|
CART = "CART"
|
|
1255
1280
|
}
|
|
1281
|
+
/** @enumType */
|
|
1282
|
+
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';
|
|
1256
1283
|
export interface ExtensionExposure {
|
|
1257
1284
|
/** Determines if the component is production ready */
|
|
1258
|
-
maturity?:
|
|
1285
|
+
maturity?: MaturityWithLiterals;
|
|
1259
1286
|
}
|
|
1260
1287
|
export declare enum Exposure {
|
|
1261
1288
|
/** Unexposed. to be used by dev team only */
|
|
@@ -1265,6 +1292,8 @@ export declare enum Exposure {
|
|
|
1265
1292
|
/** Exposed to the world */
|
|
1266
1293
|
PUBLIC = "PUBLIC"
|
|
1267
1294
|
}
|
|
1295
|
+
/** @enumType */
|
|
1296
|
+
export type ExposureWithLiterals = Exposure | 'PRIVATE' | 'INTERNAL' | 'PUBLIC';
|
|
1268
1297
|
export declare enum Maturity {
|
|
1269
1298
|
/** Immature. subject to breaking changes */
|
|
1270
1299
|
ALPHA = "ALPHA",
|
|
@@ -1275,6 +1304,8 @@ export declare enum Maturity {
|
|
|
1275
1304
|
/** Not yet implemented */
|
|
1276
1305
|
NOT_IMPLEMENTED = "NOT_IMPLEMENTED"
|
|
1277
1306
|
}
|
|
1307
|
+
/** @enumType */
|
|
1308
|
+
export type MaturityWithLiterals = Maturity | 'ALPHA' | 'BETA' | 'GA' | 'NOT_IMPLEMENTED';
|
|
1278
1309
|
/** A page out of iframe component that loads directly in the Editor DOM */
|
|
1279
1310
|
export interface PageOutOfIframeComponentData {
|
|
1280
1311
|
/**
|
|
@@ -1384,7 +1415,7 @@ export interface PlatfromComponentData {
|
|
|
1384
1415
|
/** dictates if the app has migrated to the new platform API */
|
|
1385
1416
|
migratedToNewPlatformApi?: boolean;
|
|
1386
1417
|
/** The HTTP Verb used to call the router, if not set will be POST */
|
|
1387
|
-
routerHttpMethod?:
|
|
1418
|
+
routerHttpMethod?: HTTPMethodWithLiterals;
|
|
1388
1419
|
}
|
|
1389
1420
|
/** Add interim support for HTTP methods before a bigger rewrite for Routers as a component */
|
|
1390
1421
|
export declare enum HTTPMethod {
|
|
@@ -1392,6 +1423,8 @@ export declare enum HTTPMethod {
|
|
|
1392
1423
|
GET = "GET",
|
|
1393
1424
|
POST = "POST"
|
|
1394
1425
|
}
|
|
1426
|
+
/** @enumType */
|
|
1427
|
+
export type HTTPMethodWithLiterals = HTTPMethod | 'UNKNOWN_METHOD' | 'GET' | 'POST';
|
|
1395
1428
|
/**
|
|
1396
1429
|
* An iframe that opens in the user’s Wix Dashboard,
|
|
1397
1430
|
* or add a link to open the page directly in your platform.
|
|
@@ -1569,7 +1602,7 @@ export interface InstallationSettings extends InstallationSettingsOptionsOneOf {
|
|
|
1569
1602
|
/** Extra options needed when `install_page` is set to `LIGHTBOX`. */
|
|
1570
1603
|
lightboxOptions?: LightboxOptions;
|
|
1571
1604
|
/** How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`. */
|
|
1572
|
-
installPage?:
|
|
1605
|
+
installPage?: InstallPageWithLiterals;
|
|
1573
1606
|
/** Controls whether to show or hide the widget in the add panel. */
|
|
1574
1607
|
showInAddPanel?: boolean | null;
|
|
1575
1608
|
/** Defines the main preset per breakpoint for the widget. */
|
|
@@ -1593,6 +1626,8 @@ export declare enum InstallPage {
|
|
|
1593
1626
|
/** Add widget to a new lightbox in the editor */
|
|
1594
1627
|
LIGHTBOX = "LIGHTBOX"
|
|
1595
1628
|
}
|
|
1629
|
+
/** @enumType */
|
|
1630
|
+
export type InstallPageWithLiterals = InstallPage | 'NO_PAGE' | 'CURRENT' | 'PAGE' | 'LIGHTBOX';
|
|
1596
1631
|
/** Defines the main preset per breakpoint for the widget. */
|
|
1597
1632
|
export interface MainPresets {
|
|
1598
1633
|
/** The main desktop preset. */
|
|
@@ -1667,7 +1702,7 @@ export interface HelpResources {
|
|
|
1667
1702
|
}
|
|
1668
1703
|
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1669
1704
|
/** Which static container should the widget be installed at */
|
|
1670
|
-
staticContainer?:
|
|
1705
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1671
1706
|
/**
|
|
1672
1707
|
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1673
1708
|
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
@@ -1688,7 +1723,7 @@ export interface WidgetInstallationSettings extends WidgetInstallationSettingsTa
|
|
|
1688
1723
|
/** @oneof */
|
|
1689
1724
|
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1690
1725
|
/** Which static container should the widget be installed at */
|
|
1691
|
-
staticContainer?:
|
|
1726
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1692
1727
|
}
|
|
1693
1728
|
export interface BaseInstallation {
|
|
1694
1729
|
/** Auto add component to stage */
|
|
@@ -1702,13 +1737,15 @@ export interface WidgetInstallation {
|
|
|
1702
1737
|
/** Preset should be selected defaultly with installation */
|
|
1703
1738
|
defaultPreset?: MainPresets;
|
|
1704
1739
|
/** Region of widget */
|
|
1705
|
-
region?:
|
|
1740
|
+
region?: RegionTypeWithLiterals;
|
|
1706
1741
|
}
|
|
1707
1742
|
export declare enum RegionType {
|
|
1708
1743
|
HEADER = "HEADER",
|
|
1709
1744
|
BODY = "BODY",
|
|
1710
1745
|
FOOTER = "FOOTER"
|
|
1711
1746
|
}
|
|
1747
|
+
/** @enumType */
|
|
1748
|
+
export type RegionTypeWithLiterals = RegionType | 'HEADER' | 'BODY' | 'FOOTER';
|
|
1712
1749
|
export interface DefaultPresets {
|
|
1713
1750
|
/**
|
|
1714
1751
|
* Default preset ID in small (mobile) breakpoint
|
|
@@ -1728,6 +1765,8 @@ export declare enum StaticContainer {
|
|
|
1728
1765
|
/** Widget should be installed in the homepage */
|
|
1729
1766
|
HOMEPAGE = "HOMEPAGE"
|
|
1730
1767
|
}
|
|
1768
|
+
/** @enumType */
|
|
1769
|
+
export type StaticContainerWithLiterals = StaticContainer | 'UNKNOWN_CONTAINER' | 'HOMEPAGE';
|
|
1731
1770
|
export interface ComponentModel {
|
|
1732
1771
|
/** The component type of the builder component. */
|
|
1733
1772
|
componentType?: string;
|
|
@@ -1766,13 +1805,13 @@ export interface EmbeddedScriptComponentData {
|
|
|
1766
1805
|
/** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */
|
|
1767
1806
|
name?: string;
|
|
1768
1807
|
/** What category of pages this will be embedded on (single, many, none) */
|
|
1769
|
-
pages?:
|
|
1808
|
+
pages?: EmbeddedScriptPagesWithLiterals;
|
|
1770
1809
|
/** Where in the HTML this should be embedded */
|
|
1771
|
-
placement?:
|
|
1810
|
+
placement?: EmbeddedScriptPlacementWithLiterals;
|
|
1772
1811
|
/** An article explaining how to activate the script */
|
|
1773
1812
|
connectArticleUrl?: string;
|
|
1774
1813
|
/** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */
|
|
1775
|
-
embedCategory?:
|
|
1814
|
+
embedCategory?: EmbedCategoryWithLiterals;
|
|
1776
1815
|
/**
|
|
1777
1816
|
* if the script should be loaded once - default and only supported value is true
|
|
1778
1817
|
* @readonly
|
|
@@ -1795,6 +1834,8 @@ export declare enum EmbeddedScriptPages {
|
|
|
1795
1834
|
/** It will be embedded multiple times on specific pages */
|
|
1796
1835
|
SPECIFIC_PAGES = "SPECIFIC_PAGES"
|
|
1797
1836
|
}
|
|
1837
|
+
/** @enumType */
|
|
1838
|
+
export type EmbeddedScriptPagesWithLiterals = EmbeddedScriptPages | 'NONE_PAGES' | 'ONCE' | 'SPECIFIC_PAGES';
|
|
1798
1839
|
/** Where that embed will be rendered */
|
|
1799
1840
|
export declare enum EmbeddedScriptPlacement {
|
|
1800
1841
|
/** It will not be rendered */
|
|
@@ -1806,6 +1847,8 @@ export declare enum EmbeddedScriptPlacement {
|
|
|
1806
1847
|
/** Appended after the last child already rendered in the body tag */
|
|
1807
1848
|
BODY_END = "BODY_END"
|
|
1808
1849
|
}
|
|
1850
|
+
/** @enumType */
|
|
1851
|
+
export type EmbeddedScriptPlacementWithLiterals = EmbeddedScriptPlacement | 'NONE_PLACEMENT' | 'HEAD' | 'BODY_START' | 'BODY_END';
|
|
1809
1852
|
/** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */
|
|
1810
1853
|
export declare enum EmbedCategory {
|
|
1811
1854
|
/** Not categorized yet */
|
|
@@ -1819,6 +1862,8 @@ export declare enum EmbedCategory {
|
|
|
1819
1862
|
/** Adds advertising content or advertising tracking to the site */
|
|
1820
1863
|
ADVERTISING = "ADVERTISING"
|
|
1821
1864
|
}
|
|
1865
|
+
/** @enumType */
|
|
1866
|
+
export type EmbedCategoryWithLiterals = EmbedCategory | 'UNKNOWN' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING';
|
|
1822
1867
|
export interface WixDependency {
|
|
1823
1868
|
/**
|
|
1824
1869
|
* The fully qualified package name from npm, example: @wix/frontend-location
|
|
@@ -1854,7 +1899,7 @@ export interface WebComponentData {
|
|
|
1854
1899
|
/** Dynamic settings(Graphic Floating Properties Panel settings) */
|
|
1855
1900
|
gfppSettings?: Settings;
|
|
1856
1901
|
/** Custom element type PAGE / WIDGET */
|
|
1857
|
-
type?:
|
|
1902
|
+
type?: WebComponentDataElementTypeWithLiterals;
|
|
1858
1903
|
/** Boolean to make this component be available for free sites */
|
|
1859
1904
|
allowedForFreeSite?: boolean;
|
|
1860
1905
|
/**
|
|
@@ -1869,7 +1914,7 @@ export interface WebComponentData {
|
|
|
1869
1914
|
/** The details of the selected widget to add */
|
|
1870
1915
|
widget?: WidgetDetails;
|
|
1871
1916
|
/** Give the option to change the script type */
|
|
1872
|
-
scriptType?:
|
|
1917
|
+
scriptType?: ScriptTypeWithLiterals;
|
|
1873
1918
|
/** Web component default mobile height */
|
|
1874
1919
|
defaultMobileHeight?: number | null;
|
|
1875
1920
|
/** Prevent the deletion of the widget when set to true. */
|
|
@@ -2026,7 +2071,7 @@ export interface SingleKeyCondition {
|
|
|
2026
2071
|
/** ColorSelectLabeled 13 */
|
|
2027
2072
|
export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
2028
2073
|
customColor?: ColorDefinition;
|
|
2029
|
-
templateColor?:
|
|
2074
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2030
2075
|
title?: string;
|
|
2031
2076
|
key?: string;
|
|
2032
2077
|
/** @deprecated */
|
|
@@ -2037,7 +2082,7 @@ export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
|
2037
2082
|
/** @oneof */
|
|
2038
2083
|
export interface ColorSelectLabeledDataOneOf {
|
|
2039
2084
|
customColor?: ColorDefinition;
|
|
2040
|
-
templateColor?:
|
|
2085
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2041
2086
|
}
|
|
2042
2087
|
export interface ColorDefinition {
|
|
2043
2088
|
value?: string;
|
|
@@ -2050,13 +2095,15 @@ export declare enum TemplateDefaultColor {
|
|
|
2050
2095
|
BORDERS_AND_DIVIDERS = "BORDERS_AND_DIVIDERS",
|
|
2051
2096
|
BUTTONS_AND_LINKS = "BUTTONS_AND_LINKS"
|
|
2052
2097
|
}
|
|
2098
|
+
/** @enumType */
|
|
2099
|
+
export type TemplateDefaultColorWithLiterals = TemplateDefaultColor | 'BACKGROUND' | 'SECONDARY_TEXTS' | 'MAIN_TEXT_AND_ICONS' | 'BORDERS_AND_DIVIDERS' | 'BUTTONS_AND_LINKS';
|
|
2053
2100
|
/** Thumbnails 4 */
|
|
2054
2101
|
export interface Thumbnails {
|
|
2055
2102
|
key?: string;
|
|
2056
2103
|
title?: string;
|
|
2057
2104
|
value?: string;
|
|
2058
2105
|
options?: ThumbnailData[];
|
|
2059
|
-
size?:
|
|
2106
|
+
size?: ThumbnailsSizeWithLiterals;
|
|
2060
2107
|
description?: string;
|
|
2061
2108
|
conditions?: Condition[];
|
|
2062
2109
|
}
|
|
@@ -2077,6 +2124,8 @@ export declare enum ThumbnailsSize {
|
|
|
2077
2124
|
LARGE = "LARGE",
|
|
2078
2125
|
XLARGE = "XLARGE"
|
|
2079
2126
|
}
|
|
2127
|
+
/** @enumType */
|
|
2128
|
+
export type ThumbnailsSizeWithLiterals = ThumbnailsSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE';
|
|
2080
2129
|
/** SliderLabeled 5 */
|
|
2081
2130
|
export interface SliderLabeled {
|
|
2082
2131
|
key?: string;
|
|
@@ -2110,11 +2159,11 @@ export interface ToggleLabeled {
|
|
|
2110
2159
|
*/
|
|
2111
2160
|
export interface BarAlignment {
|
|
2112
2161
|
/** @deprecated */
|
|
2113
|
-
selected?:
|
|
2162
|
+
selected?: BarAlignmentSelectedWithLiterals;
|
|
2114
2163
|
key?: string;
|
|
2115
2164
|
title?: string;
|
|
2116
2165
|
description?: string;
|
|
2117
|
-
value?:
|
|
2166
|
+
value?: BarAlignmentSelectedWithLiterals;
|
|
2118
2167
|
conditions?: Condition[];
|
|
2119
2168
|
}
|
|
2120
2169
|
/** Bar alignment selected value */
|
|
@@ -2123,6 +2172,8 @@ export declare enum BarAlignmentSelected {
|
|
|
2123
2172
|
ALIGN_CENTER = "ALIGN_CENTER",
|
|
2124
2173
|
ALIGN_RIGHT = "ALIGN_RIGHT"
|
|
2125
2174
|
}
|
|
2175
|
+
/** @enumType */
|
|
2176
|
+
export type BarAlignmentSelectedWithLiterals = BarAlignmentSelected | 'ALIGN_LEFT' | 'ALIGN_CENTER' | 'ALIGN_RIGHT';
|
|
2126
2177
|
/** TextInputLabeled 9 */
|
|
2127
2178
|
export interface TextInputLabeled {
|
|
2128
2179
|
key?: string;
|
|
@@ -2147,22 +2198,24 @@ export interface FontDefinition {
|
|
|
2147
2198
|
/** TextStyle 14 */
|
|
2148
2199
|
export interface TextStyle extends TextStyleDefaultColorOneOf {
|
|
2149
2200
|
customColor?: ColorDefinition;
|
|
2150
|
-
templateColor?:
|
|
2201
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2151
2202
|
key?: string;
|
|
2152
2203
|
title?: string;
|
|
2153
2204
|
description?: string;
|
|
2154
|
-
defaultTextStyle?:
|
|
2205
|
+
defaultTextStyle?: DefaultTextStyleWithLiterals;
|
|
2155
2206
|
}
|
|
2156
2207
|
/** @oneof */
|
|
2157
2208
|
export interface TextStyleDefaultColorOneOf {
|
|
2158
2209
|
customColor?: ColorDefinition;
|
|
2159
|
-
templateColor?:
|
|
2210
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2160
2211
|
}
|
|
2161
2212
|
export declare enum DefaultTextStyle {
|
|
2162
2213
|
TITLE = "TITLE",
|
|
2163
2214
|
PARAGRAPH = "PARAGRAPH",
|
|
2164
2215
|
LOWER_HIERARCHY_TEXTS = "LOWER_HIERARCHY_TEXTS"
|
|
2165
2216
|
}
|
|
2217
|
+
/** @enumType */
|
|
2218
|
+
export type DefaultTextStyleWithLiterals = DefaultTextStyle | 'TITLE' | 'PARAGRAPH' | 'LOWER_HIERARCHY_TEXTS';
|
|
2166
2219
|
/** 10 */
|
|
2167
2220
|
export interface ResetButton {
|
|
2168
2221
|
label?: string;
|
|
@@ -2171,6 +2224,8 @@ export declare enum WebComponentDataElementType {
|
|
|
2171
2224
|
WIDGET = "WIDGET",
|
|
2172
2225
|
PAGE = "PAGE"
|
|
2173
2226
|
}
|
|
2227
|
+
/** @enumType */
|
|
2228
|
+
export type WebComponentDataElementTypeWithLiterals = WebComponentDataElementType | 'WIDGET' | 'PAGE';
|
|
2174
2229
|
export interface WidgetDetails {
|
|
2175
2230
|
name?: string | null;
|
|
2176
2231
|
icon?: string | null;
|
|
@@ -2180,6 +2235,8 @@ export declare enum ScriptType {
|
|
|
2180
2235
|
NO_SCRIPT_TYPE = "NO_SCRIPT_TYPE",
|
|
2181
2236
|
MODULE = "MODULE"
|
|
2182
2237
|
}
|
|
2238
|
+
/** @enumType */
|
|
2239
|
+
export type ScriptTypeWithLiterals = ScriptType | 'NO_SCRIPT_TYPE' | 'MODULE';
|
|
2183
2240
|
export interface WidgetBehavior {
|
|
2184
2241
|
/** Toggle whether the widget is removable from the page. */
|
|
2185
2242
|
removable?: boolean;
|
|
@@ -2188,7 +2245,7 @@ export interface WidgetBehavior {
|
|
|
2188
2245
|
}
|
|
2189
2246
|
export interface ExtensionData {
|
|
2190
2247
|
data?: string;
|
|
2191
|
-
extensionType?:
|
|
2248
|
+
extensionType?: ExtensionTypeWithLiterals;
|
|
2192
2249
|
}
|
|
2193
2250
|
export declare enum ExtensionType {
|
|
2194
2251
|
NONE_EXTENSION = "NONE_EXTENSION",
|
|
@@ -2203,6 +2260,8 @@ export declare enum ExtensionType {
|
|
|
2203
2260
|
ASCEND_AUTOMATION_EXTENSION = "ASCEND_AUTOMATION_EXTENSION",
|
|
2204
2261
|
CONTACT_LABELS_EXTENSION = "CONTACT_LABELS_EXTENSION"
|
|
2205
2262
|
}
|
|
2263
|
+
/** @enumType */
|
|
2264
|
+
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';
|
|
2206
2265
|
export interface SnippetSolutionData {
|
|
2207
2266
|
code?: string;
|
|
2208
2267
|
instructions?: string;
|
|
@@ -2293,7 +2352,7 @@ export interface SchemaField {
|
|
|
2293
2352
|
/** Sample values, values that could show up in the payload of a trigger. */
|
|
2294
2353
|
sampleValues?: string[];
|
|
2295
2354
|
/** The field exposure */
|
|
2296
|
-
exposure?:
|
|
2355
|
+
exposure?: SchemaFieldExposureWithLiterals;
|
|
2297
2356
|
}
|
|
2298
2357
|
export declare enum PrimitiveType {
|
|
2299
2358
|
UNKNOWN_PRIMITIVE_TYPE = "UNKNOWN_PRIMITIVE_TYPE",
|
|
@@ -2301,6 +2360,8 @@ export declare enum PrimitiveType {
|
|
|
2301
2360
|
BOOLEAN = "BOOLEAN",
|
|
2302
2361
|
NUMBER = "NUMBER"
|
|
2303
2362
|
}
|
|
2363
|
+
/** @enumType */
|
|
2364
|
+
export type PrimitiveTypeWithLiterals = PrimitiveType | 'UNKNOWN_PRIMITIVE_TYPE' | 'TEXT' | 'BOOLEAN' | 'NUMBER';
|
|
2304
2365
|
export declare enum SimpleType {
|
|
2305
2366
|
UNKNOWN_SIMPLE_TYPE = "UNKNOWN_SIMPLE_TYPE",
|
|
2306
2367
|
MONEY = "MONEY",
|
|
@@ -2314,11 +2375,13 @@ export declare enum SimpleType {
|
|
|
2314
2375
|
PHONE = "PHONE",
|
|
2315
2376
|
CONTACT_ID = "CONTACT_ID"
|
|
2316
2377
|
}
|
|
2378
|
+
/** @enumType */
|
|
2379
|
+
export type SimpleTypeWithLiterals = SimpleType | 'UNKNOWN_SIMPLE_TYPE' | 'MONEY' | 'LINK' | 'BACKOFFICE_LINK' | 'LIVESITE_LINK' | 'MULTILINGUAL' | 'IMAGE_LINK' | 'GUID' | 'EMAIL' | 'PHONE' | 'CONTACT_ID';
|
|
2317
2380
|
export interface Primitive {
|
|
2318
|
-
primitiveType?:
|
|
2381
|
+
primitiveType?: PrimitiveTypeWithLiterals;
|
|
2319
2382
|
}
|
|
2320
2383
|
export interface Simple {
|
|
2321
|
-
simpleType?:
|
|
2384
|
+
simpleType?: SimpleTypeWithLiterals;
|
|
2322
2385
|
}
|
|
2323
2386
|
export interface _Date {
|
|
2324
2387
|
/** Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date */
|
|
@@ -2352,10 +2415,12 @@ export declare enum SchemaFieldExposure {
|
|
|
2352
2415
|
/** Sent to the action provider and usually shown to user */
|
|
2353
2416
|
EXPOSED = "EXPOSED"
|
|
2354
2417
|
}
|
|
2418
|
+
/** @enumType */
|
|
2419
|
+
export type SchemaFieldExposureWithLiterals = SchemaFieldExposure | 'UNKNOWN_EXPOSURE' | 'SETUP' | 'HIDDEN' | 'EXPOSED';
|
|
2355
2420
|
/** represents Invoices integration policies */
|
|
2356
2421
|
export interface InvoicesActionsComponentData {
|
|
2357
2422
|
/** partial payment restriction on invoice */
|
|
2358
|
-
partialPayment?:
|
|
2423
|
+
partialPayment?: PartialPaymentRestrictionWithLiterals;
|
|
2359
2424
|
}
|
|
2360
2425
|
/** Possible Partial Payment Policy Values */
|
|
2361
2426
|
export declare enum PartialPaymentRestriction {
|
|
@@ -2365,6 +2430,8 @@ export declare enum PartialPaymentRestriction {
|
|
|
2365
2430
|
/** Disallow Partial Payment */
|
|
2366
2431
|
DISALLOW = "DISALLOW"
|
|
2367
2432
|
}
|
|
2433
|
+
/** @enumType */
|
|
2434
|
+
export type PartialPaymentRestrictionWithLiterals = PartialPaymentRestriction | 'UNDEFINED' | 'ALLOW' | 'DISALLOW';
|
|
2368
2435
|
/** Experimental-WIP: Specifies the app module configuration of business manager module */
|
|
2369
2436
|
export interface DashboardApplicationData {
|
|
2370
2437
|
/**
|
|
@@ -2460,7 +2527,7 @@ export interface HostedComponent {
|
|
|
2460
2527
|
/** Permissions required for the component, this is not strictly enforced */
|
|
2461
2528
|
requiredPermission?: string;
|
|
2462
2529
|
/** Represents the collection of components where the component will be hosted, get this value from the host provider. */
|
|
2463
|
-
hostContainerId?:
|
|
2530
|
+
hostContainerId?: HostContainerIdWithLiterals;
|
|
2464
2531
|
/** 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 */
|
|
2465
2532
|
enabledByExperiments?: ExperimentGroupWrapper[];
|
|
2466
2533
|
/** A URI used to send component error events */
|
|
@@ -2471,6 +2538,8 @@ export declare enum HostContainerId {
|
|
|
2471
2538
|
BUSINESS_DASHBOARD_HOST = "BUSINESS_DASHBOARD_HOST",
|
|
2472
2539
|
SIDEBAR_FOOTER = "SIDEBAR_FOOTER"
|
|
2473
2540
|
}
|
|
2541
|
+
/** @enumType */
|
|
2542
|
+
export type HostContainerIdWithLiterals = HostContainerId | 'BUSINESS_MANAGER' | 'BUSINESS_DASHBOARD_HOST' | 'SIDEBAR_FOOTER';
|
|
2474
2543
|
/** Contact Labels Extensions */
|
|
2475
2544
|
export interface ContactLabelsComponentData {
|
|
2476
2545
|
/** Whether apps can create labels in this namespace. */
|
|
@@ -2508,7 +2577,7 @@ export interface WidgetPluginComponentData {
|
|
|
2508
2577
|
*/
|
|
2509
2578
|
referenceComponentId?: string;
|
|
2510
2579
|
/** APIs implemented by the Plugin's widget. */
|
|
2511
|
-
pluginInterfaces?:
|
|
2580
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
2512
2581
|
/** Marketing information about the plugin. */
|
|
2513
2582
|
marketData?: PluginMarketData;
|
|
2514
2583
|
/** List of placements where the plugin is allowed to be installed. */
|
|
@@ -2608,7 +2677,7 @@ export interface HostedPage {
|
|
|
2608
2677
|
/** Url to images in different formats and colors */
|
|
2609
2678
|
logos?: Logos;
|
|
2610
2679
|
/** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */
|
|
2611
|
-
billingAddressMandatoryFields?:
|
|
2680
|
+
billingAddressMandatoryFields?: MandatoryFieldWithLiterals[];
|
|
2612
2681
|
}
|
|
2613
2682
|
export interface Logos {
|
|
2614
2683
|
/** white theme logos */
|
|
@@ -2642,6 +2711,8 @@ export declare enum MandatoryField {
|
|
|
2642
2711
|
HOUSE_NUMBER = "HOUSE_NUMBER",
|
|
2643
2712
|
TAX_IDENTIFIER = "TAX_IDENTIFIER"
|
|
2644
2713
|
}
|
|
2714
|
+
/** @enumType */
|
|
2715
|
+
export type MandatoryFieldWithLiterals = MandatoryField | 'ZIPCODE' | 'CITY' | 'STATE' | 'ADDRESS' | 'COUNTRY_CODE' | 'EMAIL' | 'PHONE' | 'FIRST_NAME' | 'LAST_NAME' | 'STREET' | 'HOUSE_NUMBER' | 'TAX_IDENTIFIER';
|
|
2645
2716
|
export interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {
|
|
2646
2717
|
/** text field */
|
|
2647
2718
|
simpleField?: SimpleField;
|
|
@@ -2788,7 +2859,7 @@ export interface ShippingLabelCarrierSpiConfig {
|
|
|
2788
2859
|
*/
|
|
2789
2860
|
currency?: string;
|
|
2790
2861
|
/** the measurement system of he labels (Metric or Imperial) */
|
|
2791
|
-
measurementSystem?:
|
|
2862
|
+
measurementSystem?: MeasurementSystemWithLiterals;
|
|
2792
2863
|
/** does carrier support insurance */
|
|
2793
2864
|
isInsuranceSupported?: boolean;
|
|
2794
2865
|
/**
|
|
@@ -2802,6 +2873,8 @@ export declare enum MeasurementSystem {
|
|
|
2802
2873
|
Metric = "Metric",
|
|
2803
2874
|
Imperial = "Imperial"
|
|
2804
2875
|
}
|
|
2876
|
+
/** @enumType */
|
|
2877
|
+
export type MeasurementSystemWithLiterals = MeasurementSystem | 'Metric' | 'Imperial';
|
|
2805
2878
|
export interface PackageType {
|
|
2806
2879
|
/**
|
|
2807
2880
|
* carrier id that can be used to get quotes and purchase
|
|
@@ -2876,24 +2949,26 @@ export interface RestaurantsPOSComponentData {
|
|
|
2876
2949
|
}
|
|
2877
2950
|
export interface CatalogSyncConfiguration {
|
|
2878
2951
|
/** 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). */
|
|
2879
|
-
entityAvailabilityUpdated?:
|
|
2952
|
+
entityAvailabilityUpdated?: DefaultWithLiterals;
|
|
2880
2953
|
/** 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). */
|
|
2881
|
-
fulfillmentMethodsDefinition?:
|
|
2954
|
+
fulfillmentMethodsDefinition?: DefaultWithLiterals;
|
|
2882
2955
|
/** 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). */
|
|
2883
|
-
dishImagesUpdated?:
|
|
2956
|
+
dishImagesUpdated?: DefaultWithLiterals;
|
|
2884
2957
|
/** 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). */
|
|
2885
|
-
entitySortingControl?:
|
|
2958
|
+
entitySortingControl?: DefaultWithLiterals;
|
|
2886
2959
|
/** 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). */
|
|
2887
|
-
dishLabelsUpdated?:
|
|
2960
|
+
dishLabelsUpdated?: DefaultWithLiterals;
|
|
2888
2961
|
/** 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). */
|
|
2889
|
-
dishOptionsMinMaxUpdated?:
|
|
2962
|
+
dishOptionsMinMaxUpdated?: DefaultWithLiterals;
|
|
2890
2963
|
/** 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). */
|
|
2891
|
-
dishInStockUpdated?:
|
|
2964
|
+
dishInStockUpdated?: DefaultWithLiterals;
|
|
2892
2965
|
}
|
|
2893
2966
|
export declare enum Default {
|
|
2894
2967
|
WIX = "WIX",
|
|
2895
2968
|
POS = "POS"
|
|
2896
2969
|
}
|
|
2970
|
+
/** @enumType */
|
|
2971
|
+
export type DefaultWithLiterals = Default | 'WIX' | 'POS';
|
|
2897
2972
|
export interface ShippingProviderConfig {
|
|
2898
2973
|
/** URI configuration of the deployment */
|
|
2899
2974
|
deploymentUri?: SpiBaseUri;
|
|
@@ -2959,6 +3034,8 @@ export declare enum HookType {
|
|
|
2959
3034
|
BEFORE = "BEFORE",
|
|
2960
3035
|
AFTER = "AFTER"
|
|
2961
3036
|
}
|
|
3037
|
+
/** @enumType */
|
|
3038
|
+
export type HookTypeWithLiterals = HookType | 'UNDEFINED' | 'BEFORE_BLOCKING' | 'BEFORE' | 'AFTER';
|
|
2962
3039
|
export interface GenericHookConfig {
|
|
2963
3040
|
/** FQN of proto service */
|
|
2964
3041
|
serviceFqn?: string;
|
|
@@ -2970,7 +3047,7 @@ export interface GenericHookConfig {
|
|
|
2970
3047
|
*/
|
|
2971
3048
|
uri?: string;
|
|
2972
3049
|
/** Type of hook */
|
|
2973
|
-
hookType?:
|
|
3050
|
+
hookType?: HookTypeWithLiterals;
|
|
2974
3051
|
}
|
|
2975
3052
|
export interface ActionProviderSPIConfig {
|
|
2976
3053
|
/** URL to action provider service for this action */
|
|
@@ -3073,7 +3150,7 @@ export interface ActionSPIConfig {
|
|
|
3073
3150
|
* Indicates whether we should wait for the action to complete before executing the next actions or finish and
|
|
3074
3151
|
* expect a callback in the actionCompleted method
|
|
3075
3152
|
*/
|
|
3076
|
-
executionType?:
|
|
3153
|
+
executionType?: ExecutionTypeWithLiterals;
|
|
3077
3154
|
/** Chosen interface for action */
|
|
3078
3155
|
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
3079
3156
|
/** Icon representing the action in the UI */
|
|
@@ -3091,6 +3168,8 @@ export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
|
3091
3168
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
3092
3169
|
GENERIC = "GENERIC"
|
|
3093
3170
|
}
|
|
3171
|
+
/** @enumType */
|
|
3172
|
+
export type ActionSPIConfigInterfaceConfigurationTypeWithLiterals = ActionSPIConfigInterfaceConfigurationType | 'UNKNOWN_TYPE' | 'WIDGET_COMPONENT' | 'GENERIC';
|
|
3094
3173
|
export interface WidgetComponentOptions {
|
|
3095
3174
|
/**
|
|
3096
3175
|
* Name of provided component
|
|
@@ -3110,6 +3189,8 @@ export declare enum SourceType {
|
|
|
3110
3189
|
/** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
|
|
3111
3190
|
WIX_API = "WIX_API"
|
|
3112
3191
|
}
|
|
3192
|
+
/** @enumType */
|
|
3193
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
|
|
3113
3194
|
export interface WixApiOptions {
|
|
3114
3195
|
/**
|
|
3115
3196
|
* Service entity fqdn
|
|
@@ -3159,6 +3240,8 @@ export declare enum ExecutionType {
|
|
|
3159
3240
|
SYNC = "SYNC",
|
|
3160
3241
|
ASYNC = "ASYNC"
|
|
3161
3242
|
}
|
|
3243
|
+
/** @enumType */
|
|
3244
|
+
export type ExecutionTypeWithLiterals = ExecutionType | 'UNKNOWN_EXECUTION_TYPE' | 'SYNC' | 'ASYNC';
|
|
3162
3245
|
export interface Metadata {
|
|
3163
3246
|
/** Show action only to advanced mode users (Wix staff) */
|
|
3164
3247
|
hidden?: boolean;
|
|
@@ -3167,7 +3250,7 @@ export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigIn
|
|
|
3167
3250
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
3168
3251
|
genericOptions?: GenericOptions;
|
|
3169
3252
|
/** Type of chosen interface */
|
|
3170
|
-
type?:
|
|
3253
|
+
type?: ActionSPIConfigInterfaceConfigurationTypeWithLiterals;
|
|
3171
3254
|
}
|
|
3172
3255
|
/** @oneof */
|
|
3173
3256
|
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
@@ -3178,7 +3261,7 @@ export interface Source extends SourceOptionsOneOf {
|
|
|
3178
3261
|
/** Wix API options */
|
|
3179
3262
|
wixApiOptions?: WixApiOptions;
|
|
3180
3263
|
/** the source type */
|
|
3181
|
-
type?:
|
|
3264
|
+
type?: SourceTypeWithLiterals;
|
|
3182
3265
|
}
|
|
3183
3266
|
/** @oneof */
|
|
3184
3267
|
export interface SourceOptionsOneOf {
|
|
@@ -3222,7 +3305,7 @@ export interface BackOfficeExtensionContainer {
|
|
|
3222
3305
|
/** Extensibility properties used by containers (slots) */
|
|
3223
3306
|
export interface Extendable {
|
|
3224
3307
|
/** Type of component that this slot accepts. */
|
|
3225
|
-
extendedBy?:
|
|
3308
|
+
extendedBy?: ExtendingComponentTypeWithLiterals;
|
|
3226
3309
|
}
|
|
3227
3310
|
/** Which component types can be extended in containers */
|
|
3228
3311
|
export declare enum ExtendingComponentType {
|
|
@@ -3230,6 +3313,8 @@ export declare enum ExtendingComponentType {
|
|
|
3230
3313
|
BACK_OFFICE_MENU_ITEM = "BACK_OFFICE_MENU_ITEM",
|
|
3231
3314
|
BACK_OFFICE_EXTENSION_WIDGET = "BACK_OFFICE_EXTENSION_WIDGET"
|
|
3232
3315
|
}
|
|
3316
|
+
/** @enumType */
|
|
3317
|
+
export type ExtendingComponentTypeWithLiterals = ExtendingComponentType | 'INVALID' | 'BACK_OFFICE_MENU_ITEM' | 'BACK_OFFICE_EXTENSION_WIDGET';
|
|
3233
3318
|
/** List of back-office hosting platforms */
|
|
3234
3319
|
export declare enum BackOfficeHostingPlatforms {
|
|
3235
3320
|
NO_HOSTING_PLATFORM = "NO_HOSTING_PLATFORM",
|
|
@@ -3270,6 +3355,8 @@ export declare enum BackOfficeHostingPlatforms {
|
|
|
3270
3355
|
/** Picasso AI application POC */
|
|
3271
3356
|
PICASSO_EDITOR = "PICASSO_EDITOR"
|
|
3272
3357
|
}
|
|
3358
|
+
/** @enumType */
|
|
3359
|
+
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';
|
|
3273
3360
|
/** Definitions of common slots properties */
|
|
3274
3361
|
export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
3275
3362
|
/** Widget-specific slot. */
|
|
@@ -3294,7 +3381,7 @@ export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
|
3294
3381
|
* @format WEB_URL
|
|
3295
3382
|
*/
|
|
3296
3383
|
mdHttpLinks?: string[];
|
|
3297
|
-
type?:
|
|
3384
|
+
type?: SlotDataTypeWithLiterals;
|
|
3298
3385
|
}
|
|
3299
3386
|
/** @oneof */
|
|
3300
3387
|
export interface SlotDataSlotTypeOneOf {
|
|
@@ -3306,7 +3393,7 @@ export interface SlotDataSlotTypeOneOf {
|
|
|
3306
3393
|
export interface DtsDefinitionReference extends DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
3307
3394
|
dtsHttpLinkOptions?: DtsHttpLink;
|
|
3308
3395
|
dtsContentOptions?: DtsContent;
|
|
3309
|
-
type?:
|
|
3396
|
+
type?: DtsDefinitionTypeWithLiterals;
|
|
3310
3397
|
}
|
|
3311
3398
|
/** @oneof */
|
|
3312
3399
|
export interface DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
@@ -3318,6 +3405,8 @@ export declare enum DtsDefinitionType {
|
|
|
3318
3405
|
DTS_HTTP_LINK = "DTS_HTTP_LINK",
|
|
3319
3406
|
DTS_CONTENT = "DTS_CONTENT"
|
|
3320
3407
|
}
|
|
3408
|
+
/** @enumType */
|
|
3409
|
+
export type DtsDefinitionTypeWithLiterals = DtsDefinitionType | 'UNKNOWN' | 'DTS_HTTP_LINK' | 'DTS_CONTENT';
|
|
3321
3410
|
export interface DtsHttpLink {
|
|
3322
3411
|
/**
|
|
3323
3412
|
* HTTP link to the bundled d.ts file.
|
|
@@ -3369,6 +3458,8 @@ export declare enum SlotDataType {
|
|
|
3369
3458
|
WIDGET = "WIDGET",
|
|
3370
3459
|
MENU = "MENU"
|
|
3371
3460
|
}
|
|
3461
|
+
/** @enumType */
|
|
3462
|
+
export type SlotDataTypeWithLiterals = SlotDataType | 'UNKNOWN' | 'WIDGET' | 'MENU';
|
|
3372
3463
|
export interface WidgetSlot {
|
|
3373
3464
|
/** Blocks specific data. */
|
|
3374
3465
|
blocksData?: BlocksData;
|
|
@@ -3394,13 +3485,13 @@ export interface BackOfficeExtension extends BackOfficeExtensionExtensionOneOf {
|
|
|
3394
3485
|
/** Extension description. This is how the extension is described in the Wix Dev Center. */
|
|
3395
3486
|
description?: string | null;
|
|
3396
3487
|
/** Type of extension. */
|
|
3397
|
-
extensionType?:
|
|
3488
|
+
extensionType?: ExtendingComponentTypeWithLiterals;
|
|
3398
3489
|
/**
|
|
3399
3490
|
* Platform that hosts the extension.
|
|
3400
3491
|
*
|
|
3401
3492
|
* Must be `"BUSINESS_MANAGER"`.
|
|
3402
3493
|
*/
|
|
3403
|
-
hostingPlatform?:
|
|
3494
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
3404
3495
|
}
|
|
3405
3496
|
/** @oneof */
|
|
3406
3497
|
export interface BackOfficeExtensionExtensionOneOf {
|
|
@@ -3455,7 +3546,7 @@ export interface BackOfficeScriptAsset {
|
|
|
3455
3546
|
*/
|
|
3456
3547
|
exportedName?: string;
|
|
3457
3548
|
/** Optional: What type should by used on <script> tag. */
|
|
3458
|
-
scriptType?:
|
|
3549
|
+
scriptType?: BackOfficeScriptAssetTypeWithLiterals;
|
|
3459
3550
|
}
|
|
3460
3551
|
/** Type attribute for the script tag */
|
|
3461
3552
|
export declare enum BackOfficeScriptAssetType {
|
|
@@ -3464,6 +3555,8 @@ export declare enum BackOfficeScriptAssetType {
|
|
|
3464
3555
|
/** Use "module" as the script type */
|
|
3465
3556
|
MODULE = "MODULE"
|
|
3466
3557
|
}
|
|
3558
|
+
/** @enumType */
|
|
3559
|
+
export type BackOfficeScriptAssetTypeWithLiterals = BackOfficeScriptAssetType | 'UNKNOWN_TYPE' | 'MODULE';
|
|
3467
3560
|
/** The schema of a menu extension of a slot exposed in a page in the Wix Dashboard */
|
|
3468
3561
|
export interface LegacyBackOfficeMenuItem {
|
|
3469
3562
|
/**
|
|
@@ -3488,6 +3581,8 @@ export declare enum ViewMode {
|
|
|
3488
3581
|
/** Opens as a modal on the current page. */
|
|
3489
3582
|
MODAL = "MODAL"
|
|
3490
3583
|
}
|
|
3584
|
+
/** @enumType */
|
|
3585
|
+
export type ViewModeWithLiterals = ViewMode | 'PAGE' | 'MODAL';
|
|
3491
3586
|
/** the schema of the data needed to open a component from menu extensions */
|
|
3492
3587
|
export interface OpenComponent {
|
|
3493
3588
|
/**
|
|
@@ -3496,7 +3591,7 @@ export interface OpenComponent {
|
|
|
3496
3591
|
*/
|
|
3497
3592
|
componentId?: string;
|
|
3498
3593
|
/** How the component is opened. */
|
|
3499
|
-
viewMode?:
|
|
3594
|
+
viewMode?: ViewModeWithLiterals;
|
|
3500
3595
|
/** Parameters to navigate to a page or as props for a modal. */
|
|
3501
3596
|
componentParams?: Record<string, string>;
|
|
3502
3597
|
}
|
|
@@ -3635,7 +3730,7 @@ export interface AlgorithmConfig {
|
|
|
3635
3730
|
* * `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.
|
|
3636
3731
|
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
3637
3732
|
*/
|
|
3638
|
-
algorithmType?:
|
|
3733
|
+
algorithmType?: AlgorithmTypeWithLiterals;
|
|
3639
3734
|
/**
|
|
3640
3735
|
* 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.
|
|
3641
3736
|
* @format GUID
|
|
@@ -3647,6 +3742,8 @@ export declare enum AlgorithmType {
|
|
|
3647
3742
|
RELATED_ITEMS = "RELATED_ITEMS",
|
|
3648
3743
|
GLOBAL = "GLOBAL"
|
|
3649
3744
|
}
|
|
3745
|
+
/** @enumType */
|
|
3746
|
+
export type AlgorithmTypeWithLiterals = AlgorithmType | 'UNSPECIFIED' | 'RELATED_ITEMS' | 'GLOBAL';
|
|
3650
3747
|
export interface DropshippingProviderSPIConfig {
|
|
3651
3748
|
/** name of the dropshipping provider was it appears in relevant screens/mails in eComm Platform */
|
|
3652
3749
|
name?: string;
|
|
@@ -3663,13 +3760,13 @@ export interface DropshippingProviderSPIConfig {
|
|
|
3663
3760
|
*/
|
|
3664
3761
|
dashboardUri?: string;
|
|
3665
3762
|
/** if duplication operation for product is locked */
|
|
3666
|
-
duplicateProduct?:
|
|
3763
|
+
duplicateProduct?: LockableOperationWithLiterals;
|
|
3667
3764
|
/** whether there is a warning or not when price is changed */
|
|
3668
|
-
changePrice?:
|
|
3765
|
+
changePrice?: RestrictedOperationWithLiterals;
|
|
3669
3766
|
/** whether the chagne inventory operations are locked */
|
|
3670
|
-
changeInventory?:
|
|
3767
|
+
changeInventory?: LockableOperationWithLiterals;
|
|
3671
3768
|
/** where there is a warning of not when changing options */
|
|
3672
|
-
manageOptions?:
|
|
3769
|
+
manageOptions?: RestrictedOperationWithLiterals;
|
|
3673
3770
|
}
|
|
3674
3771
|
export declare enum LockableOperation {
|
|
3675
3772
|
/** When operation lockability is not specified */
|
|
@@ -3679,11 +3776,15 @@ export declare enum LockableOperation {
|
|
|
3679
3776
|
/** Operation is unlocked */
|
|
3680
3777
|
UNLOCKED = "UNLOCKED"
|
|
3681
3778
|
}
|
|
3779
|
+
/** @enumType */
|
|
3780
|
+
export type LockableOperationWithLiterals = LockableOperation | 'UNSPECIFIED_LOCKABLE' | 'LOCKED' | 'UNLOCKED';
|
|
3682
3781
|
export declare enum RestrictedOperation {
|
|
3683
3782
|
UNSPECIFIED_RESTRICTED = "UNSPECIFIED_RESTRICTED",
|
|
3684
3783
|
ALLOW = "ALLOW",
|
|
3685
3784
|
WARN = "WARN"
|
|
3686
3785
|
}
|
|
3786
|
+
/** @enumType */
|
|
3787
|
+
export type RestrictedOperationWithLiterals = RestrictedOperation | 'UNSPECIFIED_RESTRICTED' | 'ALLOW' | 'WARN';
|
|
3687
3788
|
export interface InvoicesConfig {
|
|
3688
3789
|
/** Base URI of spi provider */
|
|
3689
3790
|
baseUri?: string;
|
|
@@ -3750,7 +3851,7 @@ export interface ApplicationAutomationComponent {
|
|
|
3750
3851
|
/** Automation metadata */
|
|
3751
3852
|
metadata?: AutomationMetadata;
|
|
3752
3853
|
/** Automation status */
|
|
3753
|
-
status?:
|
|
3854
|
+
status?: StatusWithLiterals;
|
|
3754
3855
|
/** Optional origin that indicates the source of the automation */
|
|
3755
3856
|
origin?: OriginInfo;
|
|
3756
3857
|
/**
|
|
@@ -3893,8 +3994,10 @@ export declare enum BlockType {
|
|
|
3893
3994
|
OR = "OR",
|
|
3894
3995
|
AND = "AND"
|
|
3895
3996
|
}
|
|
3997
|
+
/** @enumType */
|
|
3998
|
+
export type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND';
|
|
3896
3999
|
export interface ConditionBlock {
|
|
3897
|
-
type?:
|
|
4000
|
+
type?: BlockTypeWithLiterals;
|
|
3898
4001
|
/**
|
|
3899
4002
|
* @minSize 1
|
|
3900
4003
|
* @maxSize 20
|
|
@@ -3987,10 +4090,14 @@ export declare enum Domain {
|
|
|
3987
4090
|
/** Wix domain */
|
|
3988
4091
|
WIX = "WIX"
|
|
3989
4092
|
}
|
|
4093
|
+
/** @enumType */
|
|
4094
|
+
export type DomainWithLiterals = Domain | 'USER' | 'WIX';
|
|
3990
4095
|
export declare enum Status {
|
|
3991
4096
|
ACTIVE = "ACTIVE",
|
|
3992
4097
|
INACTIVE = "INACTIVE"
|
|
3993
4098
|
}
|
|
4099
|
+
/** @enumType */
|
|
4100
|
+
export type StatusWithLiterals = Status | 'ACTIVE' | 'INACTIVE';
|
|
3994
4101
|
export interface OriginInfo {
|
|
3995
4102
|
/**
|
|
3996
4103
|
* The id of the original automation used to create the preinstalled automation (v3/Builder only)
|
|
@@ -4217,7 +4324,7 @@ export interface TextInputSettings {
|
|
|
4217
4324
|
/** A regex that the text entered by the user must match */
|
|
4218
4325
|
regex?: string | null;
|
|
4219
4326
|
/** How should the field be displayed to the end user */
|
|
4220
|
-
displayType?:
|
|
4327
|
+
displayType?: TextInputDisplayTypeWithLiterals;
|
|
4221
4328
|
}
|
|
4222
4329
|
export declare enum TextInputDisplayType {
|
|
4223
4330
|
/** A regular text field */
|
|
@@ -4227,6 +4334,8 @@ export declare enum TextInputDisplayType {
|
|
|
4227
4334
|
/** A field optimized for one time codes */
|
|
4228
4335
|
CODE = "CODE"
|
|
4229
4336
|
}
|
|
4337
|
+
/** @enumType */
|
|
4338
|
+
export type TextInputDisplayTypeWithLiterals = TextInputDisplayType | 'TEXT' | 'PASSWORD' | 'CODE';
|
|
4230
4339
|
export interface IDPConnectionConfig {
|
|
4231
4340
|
/** the base URI where all the methods are deployed. */
|
|
4232
4341
|
baseUri?: string;
|
|
@@ -4253,11 +4362,11 @@ export interface ItemsSelectionProviderConfig {
|
|
|
4253
4362
|
* 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.
|
|
4254
4363
|
* @maxSize 50
|
|
4255
4364
|
*/
|
|
4256
|
-
supportedTags?:
|
|
4365
|
+
supportedTags?: TagWithLiterals[];
|
|
4257
4366
|
/** Configuration settings for how the thumbnail is displayed. */
|
|
4258
4367
|
itemThumbnail?: ItemThumbnail;
|
|
4259
4368
|
/** Pagination Mode */
|
|
4260
|
-
paginationMode?:
|
|
4369
|
+
paginationMode?: PaginationModeWithLiterals;
|
|
4261
4370
|
}
|
|
4262
4371
|
export interface LearnMore {
|
|
4263
4372
|
/**
|
|
@@ -4276,8 +4385,10 @@ export declare enum ThumbnailType {
|
|
|
4276
4385
|
IMAGE = "IMAGE",
|
|
4277
4386
|
AVATAR = "AVATAR"
|
|
4278
4387
|
}
|
|
4388
|
+
/** @enumType */
|
|
4389
|
+
export type ThumbnailTypeWithLiterals = ThumbnailType | 'UNKNOWN_THUMBNAIL_TYPE' | 'IMAGE' | 'AVATAR';
|
|
4279
4390
|
export interface ImageConfig {
|
|
4280
|
-
shape?:
|
|
4391
|
+
shape?: ImageShapeWithLiterals;
|
|
4281
4392
|
}
|
|
4282
4393
|
export declare enum ImageShape {
|
|
4283
4394
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4288,8 +4399,10 @@ export declare enum ImageShape {
|
|
|
4288
4399
|
/** Rectangle */
|
|
4289
4400
|
RECTANGLE = "RECTANGLE"
|
|
4290
4401
|
}
|
|
4402
|
+
/** @enumType */
|
|
4403
|
+
export type ImageShapeWithLiterals = ImageShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE' | 'RECTANGLE';
|
|
4291
4404
|
export interface AvatarConfig {
|
|
4292
|
-
shape?:
|
|
4405
|
+
shape?: AvatarShapeWithLiterals;
|
|
4293
4406
|
}
|
|
4294
4407
|
export declare enum AvatarShape {
|
|
4295
4408
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4298,6 +4411,8 @@ export declare enum AvatarShape {
|
|
|
4298
4411
|
/** Square */
|
|
4299
4412
|
SQUARE = "SQUARE"
|
|
4300
4413
|
}
|
|
4414
|
+
/** @enumType */
|
|
4415
|
+
export type AvatarShapeWithLiterals = AvatarShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE';
|
|
4301
4416
|
export interface SearchField {
|
|
4302
4417
|
/** Supported searchable fields. */
|
|
4303
4418
|
key?: string;
|
|
@@ -4320,11 +4435,11 @@ export interface FilterInfo extends FilterInfoOptionsOneOf {
|
|
|
4320
4435
|
*/
|
|
4321
4436
|
key?: string;
|
|
4322
4437
|
/** Optional filter will be shown only for consumers with this tag. Only one filter is allowed per tag. */
|
|
4323
|
-
tag?:
|
|
4438
|
+
tag?: TagWithLiterals;
|
|
4324
4439
|
/** The filter selection type. */
|
|
4325
|
-
selectionType?:
|
|
4440
|
+
selectionType?: FilterSelectionTypeWithLiterals;
|
|
4326
4441
|
/** Filter options type. For now only static options are supported */
|
|
4327
|
-
optionsType?:
|
|
4442
|
+
optionsType?: FilterOptionsTypeWithLiterals;
|
|
4328
4443
|
/**
|
|
4329
4444
|
* Optional placeholder text to display on the filter
|
|
4330
4445
|
* @maxLength 500
|
|
@@ -4348,6 +4463,8 @@ export declare enum Tag {
|
|
|
4348
4463
|
ECOM_DELIVERY_PROFILES = "ECOM_DELIVERY_PROFILES",
|
|
4349
4464
|
ADD_TO_CATEGORY = "ADD_TO_CATEGORY"
|
|
4350
4465
|
}
|
|
4466
|
+
/** @enumType */
|
|
4467
|
+
export type TagWithLiterals = Tag | 'UNKNOWN_TAG' | 'EMBEDDABLE' | 'ECOM_EDIT_ORDER' | 'ECOM_CREATE_ORDER' | 'INBOX' | 'ECOM_CREATE_PAY_LINK' | 'ECOM_DELIVERY_PROFILES' | 'ADD_TO_CATEGORY';
|
|
4351
4468
|
export declare enum FilterSelectionType {
|
|
4352
4469
|
UNKNOWN_SELECTION = "UNKNOWN_SELECTION",
|
|
4353
4470
|
/** Allow to select only a single item */
|
|
@@ -4355,12 +4472,16 @@ export declare enum FilterSelectionType {
|
|
|
4355
4472
|
/** Allow to select multiple items */
|
|
4356
4473
|
MULTIPLE_SELECTION = "MULTIPLE_SELECTION"
|
|
4357
4474
|
}
|
|
4475
|
+
/** @enumType */
|
|
4476
|
+
export type FilterSelectionTypeWithLiterals = FilterSelectionType | 'UNKNOWN_SELECTION' | 'SINGLE_SELECTION' | 'MULTIPLE_SELECTION';
|
|
4358
4477
|
export declare enum FilterOptionsType {
|
|
4359
4478
|
UNKNOWN_FILTER_OPTIONS = "UNKNOWN_FILTER_OPTIONS",
|
|
4360
4479
|
/** Static hardcoded options */
|
|
4361
4480
|
STATIC = "STATIC",
|
|
4362
4481
|
PROVIDER = "PROVIDER"
|
|
4363
4482
|
}
|
|
4483
|
+
/** @enumType */
|
|
4484
|
+
export type FilterOptionsTypeWithLiterals = FilterOptionsType | 'UNKNOWN_FILTER_OPTIONS' | 'STATIC' | 'PROVIDER';
|
|
4364
4485
|
export interface StaticFilterOptions {
|
|
4365
4486
|
/**
|
|
4366
4487
|
* List of hardcoded options for a filter
|
|
@@ -4469,7 +4590,7 @@ export interface ItemThumbnail extends ItemThumbnailOptionsOneOf {
|
|
|
4469
4590
|
/** Configuration specific to avatars. */
|
|
4470
4591
|
avatarConfig?: AvatarConfig;
|
|
4471
4592
|
/** Thumbnail type */
|
|
4472
|
-
type?:
|
|
4593
|
+
type?: ThumbnailTypeWithLiterals;
|
|
4473
4594
|
/** Whether the thumbnail is hidden from the UI. */
|
|
4474
4595
|
hidden?: boolean | null;
|
|
4475
4596
|
}
|
|
@@ -4485,6 +4606,8 @@ export declare enum PaginationMode {
|
|
|
4485
4606
|
CURSOR = "CURSOR",
|
|
4486
4607
|
OFFSET = "OFFSET"
|
|
4487
4608
|
}
|
|
4609
|
+
/** @enumType */
|
|
4610
|
+
export type PaginationModeWithLiterals = PaginationMode | 'UNKNOWN_PAGINATION_MODE' | 'CURSOR' | 'OFFSET';
|
|
4488
4611
|
export interface SyncedProjectsProviderConfig {
|
|
4489
4612
|
/** URI where the SPI Implementer is deployed */
|
|
4490
4613
|
baseUri?: string;
|
|
@@ -4505,7 +4628,7 @@ export interface ChannelConfiguration extends ChannelConfigurationMessagingConfi
|
|
|
4505
4628
|
emailMessageConfig?: EmailMessageConfig;
|
|
4506
4629
|
smsMessageConfig?: SmsMessageConfig;
|
|
4507
4630
|
/** The type of the communication channel */
|
|
4508
|
-
type?:
|
|
4631
|
+
type?: ChannelTypeWithLiterals;
|
|
4509
4632
|
/** Specific provider branding parameters for the channel */
|
|
4510
4633
|
branding?: ChannelBranding;
|
|
4511
4634
|
/** Conversation initiation definition */
|
|
@@ -4524,6 +4647,8 @@ export declare enum ChannelType {
|
|
|
4524
4647
|
EMAIL = "EMAIL",
|
|
4525
4648
|
SMS = "SMS"
|
|
4526
4649
|
}
|
|
4650
|
+
/** @enumType */
|
|
4651
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
4527
4652
|
export interface DirectMessageConfig {
|
|
4528
4653
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4529
4654
|
acceptAllMessageTypes?: boolean;
|
|
@@ -4531,7 +4656,7 @@ export interface DirectMessageConfig {
|
|
|
4531
4656
|
* Direct message types accepted by the provider. only those types will be sent from Wix
|
|
4532
4657
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4533
4658
|
*/
|
|
4534
|
-
acceptedMessageTypes?:
|
|
4659
|
+
acceptedMessageTypes?: AcceptedDirectMessageTypeWithLiterals[];
|
|
4535
4660
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4536
4661
|
mediaCapabilities?: MediaCapabilities;
|
|
4537
4662
|
}
|
|
@@ -4542,6 +4667,8 @@ export declare enum AcceptedDirectMessageType {
|
|
|
4542
4667
|
ANNOUNCEMENT = "ANNOUNCEMENT",
|
|
4543
4668
|
FORM = "FORM"
|
|
4544
4669
|
}
|
|
4670
|
+
/** @enumType */
|
|
4671
|
+
export type AcceptedDirectMessageTypeWithLiterals = AcceptedDirectMessageType | 'TEXT' | 'MEDIA' | 'CARD' | 'ANNOUNCEMENT' | 'FORM';
|
|
4545
4672
|
export interface MediaCapabilities {
|
|
4546
4673
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4547
4674
|
allMediaTypes?: boolean;
|
|
@@ -4550,7 +4677,7 @@ export interface MediaCapabilities {
|
|
|
4550
4677
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4551
4678
|
* @maxSize 50
|
|
4552
4679
|
*/
|
|
4553
|
-
supportedMediaTypes?:
|
|
4680
|
+
supportedMediaTypes?: MediaMimeTypeWithLiterals[];
|
|
4554
4681
|
/** Maximum file size in bytes of a single file in a message */
|
|
4555
4682
|
maxFileSizeInBytes?: number | null;
|
|
4556
4683
|
}
|
|
@@ -4571,6 +4698,8 @@ export declare enum MediaMimeType {
|
|
|
4571
4698
|
APPLICATION_PDF = "APPLICATION_PDF",
|
|
4572
4699
|
APPLICATION_OCTET_STREAM = "APPLICATION_OCTET_STREAM"
|
|
4573
4700
|
}
|
|
4701
|
+
/** @enumType */
|
|
4702
|
+
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';
|
|
4574
4703
|
export interface EmailMessageConfig {
|
|
4575
4704
|
/** Media (Attachment) types accepted by the provider */
|
|
4576
4705
|
mediaCapabilities?: MediaCapabilities;
|
|
@@ -4581,7 +4710,7 @@ export interface SmsMessageConfig {
|
|
|
4581
4710
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4582
4711
|
acceptAllMessageTypes?: boolean;
|
|
4583
4712
|
/** SMS message types accepted by the provider. only those types will be sent from Wix */
|
|
4584
|
-
acceptedMessageTypes?:
|
|
4713
|
+
acceptedMessageTypes?: AcceptedSmsMessageTypeWithLiterals[];
|
|
4585
4714
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4586
4715
|
mediaCapabilities?: MediaCapabilities;
|
|
4587
4716
|
}
|
|
@@ -4589,6 +4718,8 @@ export declare enum AcceptedSmsMessageType {
|
|
|
4589
4718
|
SMS = "SMS",
|
|
4590
4719
|
MMS = "MMS"
|
|
4591
4720
|
}
|
|
4721
|
+
/** @enumType */
|
|
4722
|
+
export type AcceptedSmsMessageTypeWithLiterals = AcceptedSmsMessageType | 'SMS' | 'MMS';
|
|
4592
4723
|
export interface ChannelBranding {
|
|
4593
4724
|
/** The name of the channel, e.g. `Facebook` / `SMS` */
|
|
4594
4725
|
displayName?: string;
|
|
@@ -4617,7 +4748,7 @@ export interface ConversationLimitations {
|
|
|
4617
4748
|
* If, `CUSTOMER` is selected, this means that only inbound
|
|
4618
4749
|
* messages can start a conversation (aka business can only reply and not initiate the first communication).
|
|
4619
4750
|
*/
|
|
4620
|
-
initDirection?:
|
|
4751
|
+
initDirection?: InitDirectionWithLiterals;
|
|
4621
4752
|
}
|
|
4622
4753
|
export declare enum InitDirection {
|
|
4623
4754
|
UNKNOWN_INIT_DIRECTION = "UNKNOWN_INIT_DIRECTION",
|
|
@@ -4625,6 +4756,8 @@ export declare enum InitDirection {
|
|
|
4625
4756
|
CUSTOMER = "CUSTOMER",
|
|
4626
4757
|
BOTH = "BOTH"
|
|
4627
4758
|
}
|
|
4759
|
+
/** @enumType */
|
|
4760
|
+
export type InitDirectionWithLiterals = InitDirection | 'UNKNOWN_INIT_DIRECTION' | 'BUSINESS' | 'CUSTOMER' | 'BOTH';
|
|
4628
4761
|
export interface PostLoginConfig {
|
|
4629
4762
|
/** the base URI where all the methods are deployed. */
|
|
4630
4763
|
baseUri?: string;
|
|
@@ -4885,7 +5018,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
4885
5018
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
4886
5019
|
layoutCellData?: LayoutCellData;
|
|
4887
5020
|
/** 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. */
|
|
4888
|
-
type?:
|
|
5021
|
+
type?: NodeTypeWithLiterals;
|
|
4889
5022
|
/** Node ID. */
|
|
4890
5023
|
id?: string;
|
|
4891
5024
|
/** A list of child nodes. */
|
|
@@ -4986,6 +5119,8 @@ export declare enum NodeType {
|
|
|
4986
5119
|
LAYOUT = "LAYOUT",
|
|
4987
5120
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
4988
5121
|
}
|
|
5122
|
+
/** @enumType */
|
|
5123
|
+
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';
|
|
4989
5124
|
export interface NodeStyle {
|
|
4990
5125
|
/** The top padding value in pixels. */
|
|
4991
5126
|
paddingTop?: string | null;
|
|
@@ -4998,7 +5133,7 @@ export interface ButtonData {
|
|
|
4998
5133
|
/** Styling for the button's container. */
|
|
4999
5134
|
containerData?: PluginContainerData;
|
|
5000
5135
|
/** The button type. */
|
|
5001
|
-
type?:
|
|
5136
|
+
type?: ButtonDataTypeWithLiterals;
|
|
5002
5137
|
/** Styling for the button. */
|
|
5003
5138
|
styles?: Styles;
|
|
5004
5139
|
/** The text to display on the button. */
|
|
@@ -5039,7 +5174,7 @@ export interface PluginContainerData {
|
|
|
5039
5174
|
/** The width of the node when it's displayed. */
|
|
5040
5175
|
width?: PluginContainerDataWidth;
|
|
5041
5176
|
/** The node's alignment within its container. */
|
|
5042
|
-
alignment?:
|
|
5177
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
5043
5178
|
/** Spoiler cover settings for the node. */
|
|
5044
5179
|
spoiler?: Spoiler;
|
|
5045
5180
|
/** The height of the node when it's displayed. */
|
|
@@ -5057,6 +5192,8 @@ export declare enum WidthType {
|
|
|
5057
5192
|
/** coast-to-coast display */
|
|
5058
5193
|
FULL_WIDTH = "FULL_WIDTH"
|
|
5059
5194
|
}
|
|
5195
|
+
/** @enumType */
|
|
5196
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
5060
5197
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
5061
5198
|
/**
|
|
5062
5199
|
* One of the following predefined width options:
|
|
@@ -5065,7 +5202,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
5065
5202
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5066
5203
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5067
5204
|
*/
|
|
5068
|
-
size?:
|
|
5205
|
+
size?: WidthTypeWithLiterals;
|
|
5069
5206
|
/** A custom width value in pixels. */
|
|
5070
5207
|
custom?: string | null;
|
|
5071
5208
|
}
|
|
@@ -5078,7 +5215,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
5078
5215
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5079
5216
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5080
5217
|
*/
|
|
5081
|
-
size?:
|
|
5218
|
+
size?: WidthTypeWithLiterals;
|
|
5082
5219
|
/** A custom width value in pixels. */
|
|
5083
5220
|
custom?: string | null;
|
|
5084
5221
|
}
|
|
@@ -5090,6 +5227,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
5090
5227
|
/** Right Alignment */
|
|
5091
5228
|
RIGHT = "RIGHT"
|
|
5092
5229
|
}
|
|
5230
|
+
/** @enumType */
|
|
5231
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5093
5232
|
export interface Spoiler {
|
|
5094
5233
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
5095
5234
|
enabled?: boolean | null;
|
|
@@ -5108,6 +5247,8 @@ export declare enum ButtonDataType {
|
|
|
5108
5247
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
5109
5248
|
ACTION = "ACTION"
|
|
5110
5249
|
}
|
|
5250
|
+
/** @enumType */
|
|
5251
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
5111
5252
|
export interface Styles {
|
|
5112
5253
|
/**
|
|
5113
5254
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -5173,7 +5314,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
5173
5314
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
5174
5315
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
5175
5316
|
*/
|
|
5176
|
-
target?:
|
|
5317
|
+
target?: LinkTargetWithLiterals;
|
|
5177
5318
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
5178
5319
|
rel?: Rel;
|
|
5179
5320
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -5196,6 +5337,8 @@ export declare enum LinkTarget {
|
|
|
5196
5337
|
/** Opens the linked document in the full body of the window */
|
|
5197
5338
|
TOP = "TOP"
|
|
5198
5339
|
}
|
|
5340
|
+
/** @enumType */
|
|
5341
|
+
export type LinkTargetWithLiterals = LinkTarget | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
5199
5342
|
export interface Rel {
|
|
5200
5343
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
5201
5344
|
nofollow?: boolean | null;
|
|
@@ -5212,7 +5355,7 @@ export interface CodeBlockData {
|
|
|
5212
5355
|
}
|
|
5213
5356
|
export interface V1TextStyle {
|
|
5214
5357
|
/** Text alignment. Defaults to `AUTO`. */
|
|
5215
|
-
textAlignment?:
|
|
5358
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
5216
5359
|
/** 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. */
|
|
5217
5360
|
lineHeight?: string | null;
|
|
5218
5361
|
}
|
|
@@ -5228,15 +5371,17 @@ export declare enum TextAlignment {
|
|
|
5228
5371
|
/** 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 */
|
|
5229
5372
|
JUSTIFY = "JUSTIFY"
|
|
5230
5373
|
}
|
|
5374
|
+
/** @enumType */
|
|
5375
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
5231
5376
|
export interface DividerData {
|
|
5232
5377
|
/** Styling for the divider's container. */
|
|
5233
5378
|
containerData?: PluginContainerData;
|
|
5234
5379
|
/** Divider line style. */
|
|
5235
|
-
lineStyle?:
|
|
5380
|
+
lineStyle?: LineStyleWithLiterals;
|
|
5236
5381
|
/** Divider width. */
|
|
5237
|
-
width?:
|
|
5382
|
+
width?: DividerDataWidthWithLiterals;
|
|
5238
5383
|
/** Divider alignment. */
|
|
5239
|
-
alignment?:
|
|
5384
|
+
alignment?: AlignmentWithLiterals;
|
|
5240
5385
|
}
|
|
5241
5386
|
export declare enum LineStyle {
|
|
5242
5387
|
/** Single Line */
|
|
@@ -5248,6 +5393,8 @@ export declare enum LineStyle {
|
|
|
5248
5393
|
/** Dotted Line */
|
|
5249
5394
|
DOTTED = "DOTTED"
|
|
5250
5395
|
}
|
|
5396
|
+
/** @enumType */
|
|
5397
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
5251
5398
|
export declare enum DividerDataWidth {
|
|
5252
5399
|
/** Large line */
|
|
5253
5400
|
LARGE = "LARGE",
|
|
@@ -5256,6 +5403,8 @@ export declare enum DividerDataWidth {
|
|
|
5256
5403
|
/** Small line */
|
|
5257
5404
|
SMALL = "SMALL"
|
|
5258
5405
|
}
|
|
5406
|
+
/** @enumType */
|
|
5407
|
+
export type DividerDataWidthWithLiterals = DividerDataWidth | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
5259
5408
|
export declare enum Alignment {
|
|
5260
5409
|
/** Center alignment */
|
|
5261
5410
|
CENTER = "CENTER",
|
|
@@ -5264,6 +5413,8 @@ export declare enum Alignment {
|
|
|
5264
5413
|
/** Right alignment */
|
|
5265
5414
|
RIGHT = "RIGHT"
|
|
5266
5415
|
}
|
|
5416
|
+
/** @enumType */
|
|
5417
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5267
5418
|
export interface FileData {
|
|
5268
5419
|
/** Styling for the file's container. */
|
|
5269
5420
|
containerData?: PluginContainerData;
|
|
@@ -5295,6 +5446,8 @@ export declare enum PDFSettingsViewMode {
|
|
|
5295
5446
|
/** Mini PDF view */
|
|
5296
5447
|
MINI = "MINI"
|
|
5297
5448
|
}
|
|
5449
|
+
/** @enumType */
|
|
5450
|
+
export type PDFSettingsViewModeWithLiterals = PDFSettingsViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
5298
5451
|
export interface FileSource extends FileSourceDataOneOf {
|
|
5299
5452
|
/** The absolute URL for the file's source. */
|
|
5300
5453
|
url?: string | null;
|
|
@@ -5327,7 +5480,7 @@ export interface PDFSettings {
|
|
|
5327
5480
|
* `FULL` : A full page view of the PDF is displayed.
|
|
5328
5481
|
* `MINI` : A mini view of the PDF is displayed.
|
|
5329
5482
|
*/
|
|
5330
|
-
viewMode?:
|
|
5483
|
+
viewMode?: PDFSettingsViewModeWithLiterals;
|
|
5331
5484
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
5332
5485
|
disableDownload?: boolean | null;
|
|
5333
5486
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -5414,18 +5567,24 @@ export declare enum LayoutType {
|
|
|
5414
5567
|
/** Fullsize images type */
|
|
5415
5568
|
FULLSIZE = "FULLSIZE"
|
|
5416
5569
|
}
|
|
5570
|
+
/** @enumType */
|
|
5571
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
5417
5572
|
export declare enum Orientation {
|
|
5418
5573
|
/** Rows Orientation */
|
|
5419
5574
|
ROWS = "ROWS",
|
|
5420
5575
|
/** Columns Orientation */
|
|
5421
5576
|
COLUMNS = "COLUMNS"
|
|
5422
5577
|
}
|
|
5578
|
+
/** @enumType */
|
|
5579
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
5423
5580
|
export declare enum Crop {
|
|
5424
5581
|
/** Crop to fill */
|
|
5425
5582
|
FILL = "FILL",
|
|
5426
5583
|
/** Crop to fit */
|
|
5427
5584
|
FIT = "FIT"
|
|
5428
5585
|
}
|
|
5586
|
+
/** @enumType */
|
|
5587
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
5429
5588
|
export declare enum ThumbnailsAlignment {
|
|
5430
5589
|
/** Top alignment */
|
|
5431
5590
|
TOP = "TOP",
|
|
@@ -5438,13 +5597,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
5438
5597
|
/** No thumbnail */
|
|
5439
5598
|
NONE = "NONE"
|
|
5440
5599
|
}
|
|
5600
|
+
/** @enumType */
|
|
5601
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
5441
5602
|
export interface Layout {
|
|
5442
5603
|
/** Gallery layout type. */
|
|
5443
|
-
type?:
|
|
5604
|
+
type?: LayoutTypeWithLiterals;
|
|
5444
5605
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
5445
5606
|
horizontalScroll?: boolean | null;
|
|
5446
5607
|
/** Gallery orientation. */
|
|
5447
|
-
orientation?:
|
|
5608
|
+
orientation?: OrientationWithLiterals;
|
|
5448
5609
|
/** The number of columns to display on full size screens. */
|
|
5449
5610
|
numberOfColumns?: number | null;
|
|
5450
5611
|
/** The number of columns to display on mobile screens. */
|
|
@@ -5456,13 +5617,13 @@ export interface ItemStyle {
|
|
|
5456
5617
|
/** Item ratio */
|
|
5457
5618
|
ratio?: number | null;
|
|
5458
5619
|
/** Sets how item images are cropped. */
|
|
5459
|
-
crop?:
|
|
5620
|
+
crop?: CropWithLiterals;
|
|
5460
5621
|
/** The spacing between items in pixels. */
|
|
5461
5622
|
spacing?: number | null;
|
|
5462
5623
|
}
|
|
5463
5624
|
export interface GalleryOptionsThumbnails {
|
|
5464
5625
|
/** Thumbnail alignment. */
|
|
5465
|
-
placement?:
|
|
5626
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
5466
5627
|
/** Spacing between thumbnails in pixels. */
|
|
5467
5628
|
spacing?: number | null;
|
|
5468
5629
|
}
|
|
@@ -5478,7 +5639,7 @@ export interface GIFData {
|
|
|
5478
5639
|
/** Width in pixels. */
|
|
5479
5640
|
width?: number;
|
|
5480
5641
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
5481
|
-
gifType?:
|
|
5642
|
+
gifType?: GIFTypeWithLiterals;
|
|
5482
5643
|
}
|
|
5483
5644
|
export interface GIF {
|
|
5484
5645
|
/**
|
|
@@ -5501,6 +5662,8 @@ export declare enum GIFType {
|
|
|
5501
5662
|
NORMAL = "NORMAL",
|
|
5502
5663
|
STICKER = "STICKER"
|
|
5503
5664
|
}
|
|
5665
|
+
/** @enumType */
|
|
5666
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
5504
5667
|
export interface HeadingData {
|
|
5505
5668
|
/** Heading level from 1-6. */
|
|
5506
5669
|
level?: number;
|
|
@@ -5522,7 +5685,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
5522
5685
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
5523
5686
|
containerData?: PluginContainerData;
|
|
5524
5687
|
/** The type of HTML code. */
|
|
5525
|
-
source?:
|
|
5688
|
+
source?: HTMLDataSourceWithLiterals;
|
|
5526
5689
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
5527
5690
|
autoHeight?: boolean | null;
|
|
5528
5691
|
}
|
|
@@ -5542,6 +5705,8 @@ export declare enum HTMLDataSource {
|
|
|
5542
5705
|
HTML = "HTML",
|
|
5543
5706
|
ADSENSE = "ADSENSE"
|
|
5544
5707
|
}
|
|
5708
|
+
/** @enumType */
|
|
5709
|
+
export type HTMLDataSourceWithLiterals = HTMLDataSource | 'HTML' | 'ADSENSE';
|
|
5545
5710
|
export interface ImageData {
|
|
5546
5711
|
/** Styling for the image's container. */
|
|
5547
5712
|
containerData?: PluginContainerData;
|
|
@@ -5606,6 +5771,8 @@ export declare enum StylesPosition {
|
|
|
5606
5771
|
/** Thumbnail hidden and not displayed */
|
|
5607
5772
|
HIDDEN = "HIDDEN"
|
|
5608
5773
|
}
|
|
5774
|
+
/** @enumType */
|
|
5775
|
+
export type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
5609
5776
|
export interface LinkPreviewDataStyles {
|
|
5610
5777
|
/**
|
|
5611
5778
|
* Background color as a hexadecimal value.
|
|
@@ -5637,7 +5804,7 @@ export interface LinkPreviewDataStyles {
|
|
|
5637
5804
|
*/
|
|
5638
5805
|
borderColor?: string | null;
|
|
5639
5806
|
/** Position of thumbnail. Defaults to `START`. */
|
|
5640
|
-
thumbnailPosition?:
|
|
5807
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
5641
5808
|
}
|
|
5642
5809
|
export interface MapData {
|
|
5643
5810
|
/** Styling for the map's container. */
|
|
@@ -5667,7 +5834,7 @@ export interface MapSettings {
|
|
|
5667
5834
|
/** Initial zoom value. */
|
|
5668
5835
|
initialZoom?: number | null;
|
|
5669
5836
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
5670
|
-
mapType?:
|
|
5837
|
+
mapType?: MapTypeWithLiterals;
|
|
5671
5838
|
}
|
|
5672
5839
|
export declare enum MapType {
|
|
5673
5840
|
/** Roadmap map type */
|
|
@@ -5679,6 +5846,8 @@ export declare enum MapType {
|
|
|
5679
5846
|
/** Terrain map type */
|
|
5680
5847
|
TERRAIN = "TERRAIN"
|
|
5681
5848
|
}
|
|
5849
|
+
/** @enumType */
|
|
5850
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
5682
5851
|
export interface ParagraphData {
|
|
5683
5852
|
/** Styling for the paragraph text. */
|
|
5684
5853
|
textStyle?: V1TextStyle;
|
|
@@ -5705,17 +5874,21 @@ export declare enum ViewRole {
|
|
|
5705
5874
|
/** Anyone can see the results, even if one didn't vote */
|
|
5706
5875
|
EVERYONE = "EVERYONE"
|
|
5707
5876
|
}
|
|
5877
|
+
/** @enumType */
|
|
5878
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
5708
5879
|
export declare enum VoteRole {
|
|
5709
5880
|
/** Logged in member */
|
|
5710
5881
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
5711
5882
|
/** Anyone */
|
|
5712
5883
|
ALL = "ALL"
|
|
5713
5884
|
}
|
|
5885
|
+
/** @enumType */
|
|
5886
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
5714
5887
|
export interface SettingsPermissions {
|
|
5715
5888
|
/** Sets who can view the poll results. */
|
|
5716
|
-
view?:
|
|
5889
|
+
view?: ViewRoleWithLiterals;
|
|
5717
5890
|
/** Sets who can vote. */
|
|
5718
|
-
vote?:
|
|
5891
|
+
vote?: VoteRoleWithLiterals;
|
|
5719
5892
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
5720
5893
|
allowMultipleVotes?: boolean | null;
|
|
5721
5894
|
}
|
|
@@ -5741,17 +5914,21 @@ export declare enum PollLayoutType {
|
|
|
5741
5914
|
/** Grid */
|
|
5742
5915
|
GRID = "GRID"
|
|
5743
5916
|
}
|
|
5917
|
+
/** @enumType */
|
|
5918
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
5744
5919
|
export declare enum PollLayoutDirection {
|
|
5745
5920
|
/** Left-to-right */
|
|
5746
5921
|
LTR = "LTR",
|
|
5747
5922
|
/** Right-to-left */
|
|
5748
5923
|
RTL = "RTL"
|
|
5749
5924
|
}
|
|
5925
|
+
/** @enumType */
|
|
5926
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
5750
5927
|
export interface PollLayout {
|
|
5751
5928
|
/** The layout for displaying the voting options. */
|
|
5752
|
-
type?:
|
|
5929
|
+
type?: PollLayoutTypeWithLiterals;
|
|
5753
5930
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
5754
|
-
direction?:
|
|
5931
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
5755
5932
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
5756
5933
|
enableImage?: boolean | null;
|
|
5757
5934
|
}
|
|
@@ -5767,6 +5944,8 @@ export declare enum BackgroundType {
|
|
|
5767
5944
|
/** Gradiant background type */
|
|
5768
5945
|
GRADIENT = "GRADIENT"
|
|
5769
5946
|
}
|
|
5947
|
+
/** @enumType */
|
|
5948
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
5770
5949
|
export interface Gradient {
|
|
5771
5950
|
/** The gradient angle in degrees. */
|
|
5772
5951
|
angle?: number | null;
|
|
@@ -5792,7 +5971,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
5792
5971
|
/** Details for a gradient background. */
|
|
5793
5972
|
gradient?: Gradient;
|
|
5794
5973
|
/** Background type. For each option, include the relevant details. */
|
|
5795
|
-
type?:
|
|
5974
|
+
type?: BackgroundTypeWithLiterals;
|
|
5796
5975
|
}
|
|
5797
5976
|
/** @oneof */
|
|
5798
5977
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -5871,7 +6050,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
5871
6050
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
5872
6051
|
strikethroughData?: boolean | null;
|
|
5873
6052
|
/** The type of decoration to apply. */
|
|
5874
|
-
type?:
|
|
6053
|
+
type?: DecorationTypeWithLiterals;
|
|
5875
6054
|
}
|
|
5876
6055
|
/** @oneof */
|
|
5877
6056
|
export interface DecorationDataOneOf {
|
|
@@ -5909,6 +6088,8 @@ export declare enum DecorationType {
|
|
|
5909
6088
|
EXTERNAL = "EXTERNAL",
|
|
5910
6089
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
5911
6090
|
}
|
|
6091
|
+
/** @enumType */
|
|
6092
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
5912
6093
|
export interface AnchorData {
|
|
5913
6094
|
/** The target node's ID. */
|
|
5914
6095
|
anchor?: string;
|
|
@@ -5933,7 +6114,7 @@ export interface MentionData {
|
|
|
5933
6114
|
}
|
|
5934
6115
|
export interface FontSizeData {
|
|
5935
6116
|
/** The units used for the font size. */
|
|
5936
|
-
unit?:
|
|
6117
|
+
unit?: FontTypeWithLiterals;
|
|
5937
6118
|
/** Font size value. */
|
|
5938
6119
|
value?: number | null;
|
|
5939
6120
|
}
|
|
@@ -5941,6 +6122,8 @@ export declare enum FontType {
|
|
|
5941
6122
|
PX = "PX",
|
|
5942
6123
|
EM = "EM"
|
|
5943
6124
|
}
|
|
6125
|
+
/** @enumType */
|
|
6126
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
5944
6127
|
export interface SpoilerData {
|
|
5945
6128
|
/** Spoiler ID. */
|
|
5946
6129
|
id?: string | null;
|
|
@@ -5951,7 +6134,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
5951
6134
|
/** Data for embedded Wix Events content. */
|
|
5952
6135
|
eventData?: EventData;
|
|
5953
6136
|
/** The type of Wix App content being embedded. */
|
|
5954
|
-
type?:
|
|
6137
|
+
type?: AppTypeWithLiterals;
|
|
5955
6138
|
/** The ID of the embedded content. */
|
|
5956
6139
|
itemId?: string | null;
|
|
5957
6140
|
/** The name of the embedded content. */
|
|
@@ -5978,6 +6161,8 @@ export declare enum AppType {
|
|
|
5978
6161
|
EVENT = "EVENT",
|
|
5979
6162
|
BOOKING = "BOOKING"
|
|
5980
6163
|
}
|
|
6164
|
+
/** @enumType */
|
|
6165
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
5981
6166
|
export interface BookingData {
|
|
5982
6167
|
/** Booking duration in minutes. */
|
|
5983
6168
|
durations?: string | null;
|
|
@@ -6056,9 +6241,9 @@ export interface CollapsibleListData {
|
|
|
6056
6241
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
6057
6242
|
expandOnlyOne?: boolean | null;
|
|
6058
6243
|
/** Sets which items are expanded when the page loads. */
|
|
6059
|
-
initialExpandedItems?:
|
|
6244
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
6060
6245
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
6061
|
-
direction?:
|
|
6246
|
+
direction?: DirectionWithLiterals;
|
|
6062
6247
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
6063
6248
|
isQapageData?: boolean | null;
|
|
6064
6249
|
}
|
|
@@ -6070,12 +6255,16 @@ export declare enum InitialExpandedItems {
|
|
|
6070
6255
|
/** All items collapsed initally */
|
|
6071
6256
|
NONE = "NONE"
|
|
6072
6257
|
}
|
|
6258
|
+
/** @enumType */
|
|
6259
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
6073
6260
|
export declare enum Direction {
|
|
6074
6261
|
/** Left-to-right */
|
|
6075
6262
|
LTR = "LTR",
|
|
6076
6263
|
/** Right-to-left */
|
|
6077
6264
|
RTL = "RTL"
|
|
6078
6265
|
}
|
|
6266
|
+
/** @enumType */
|
|
6267
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
6079
6268
|
export interface TableData {
|
|
6080
6269
|
/** Styling for the table's container. */
|
|
6081
6270
|
containerData?: PluginContainerData;
|
|
@@ -6113,9 +6302,11 @@ export declare enum VerticalAlignment {
|
|
|
6113
6302
|
/** Bottom alignment */
|
|
6114
6303
|
BOTTOM = "BOTTOM"
|
|
6115
6304
|
}
|
|
6305
|
+
/** @enumType */
|
|
6306
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
6116
6307
|
export interface CellStyle {
|
|
6117
6308
|
/** Vertical alignment for the cell's text. */
|
|
6118
|
-
verticalAlignment?:
|
|
6309
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
6119
6310
|
/**
|
|
6120
6311
|
* Cell background color as a hexadecimal value.
|
|
6121
6312
|
* @format COLOR_HEX
|
|
@@ -6154,6 +6345,8 @@ export declare enum NullValue {
|
|
|
6154
6345
|
/** Null value. */
|
|
6155
6346
|
NULL_VALUE = "NULL_VALUE"
|
|
6156
6347
|
}
|
|
6348
|
+
/** @enumType */
|
|
6349
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
6157
6350
|
/**
|
|
6158
6351
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
6159
6352
|
*
|
|
@@ -6294,7 +6487,7 @@ export interface ComponentsValidatorConfig {
|
|
|
6294
6487
|
* @minSize 1
|
|
6295
6488
|
* @maxSize 100
|
|
6296
6489
|
*/
|
|
6297
|
-
componentValidationTypes?:
|
|
6490
|
+
componentValidationTypes?: ComponentTypeWithLiterals[];
|
|
6298
6491
|
/** Indicates whether the validation should affect real production */
|
|
6299
6492
|
testMode?: boolean;
|
|
6300
6493
|
}
|
|
@@ -6349,18 +6542,18 @@ export interface ProviderConfig {
|
|
|
6349
6542
|
/** The base URI in which all methods are deployed. */
|
|
6350
6543
|
baseUri?: string;
|
|
6351
6544
|
/** The provided calendar type. */
|
|
6352
|
-
calendarType?:
|
|
6545
|
+
calendarType?: CalendarTypeWithLiterals;
|
|
6353
6546
|
/**
|
|
6354
6547
|
* Connect methods used to connect to the calendar.
|
|
6355
6548
|
* @minSize 1
|
|
6356
6549
|
*/
|
|
6357
|
-
connectMethods?:
|
|
6550
|
+
connectMethods?: ConnectMethodWithLiterals[];
|
|
6358
6551
|
/** Whether the sync configuration can be updated. */
|
|
6359
6552
|
canUpdateSyncConfig?: boolean;
|
|
6360
6553
|
/** Whether events can be listed from the external calendar to the Wix calendar. */
|
|
6361
|
-
listEventFromCalendars?:
|
|
6554
|
+
listEventFromCalendars?: ListEventFromCalendarsWithLiterals;
|
|
6362
6555
|
/** Whether Wix calendar sessions can be synced to the external calendar. */
|
|
6363
|
-
syncToCalendar?:
|
|
6556
|
+
syncToCalendar?: SyncToCalendarWithLiterals;
|
|
6364
6557
|
}
|
|
6365
6558
|
export declare enum CalendarType {
|
|
6366
6559
|
UNDEFINED = "UNDEFINED",
|
|
@@ -6369,10 +6562,14 @@ export declare enum CalendarType {
|
|
|
6369
6562
|
MICROSOFT = "MICROSOFT",
|
|
6370
6563
|
OTHER = "OTHER"
|
|
6371
6564
|
}
|
|
6565
|
+
/** @enumType */
|
|
6566
|
+
export type CalendarTypeWithLiterals = CalendarType | 'UNDEFINED' | 'GOOGLE' | 'I_CAL' | 'MICROSOFT' | 'OTHER';
|
|
6372
6567
|
export declare enum ConnectMethod {
|
|
6373
6568
|
OAUTH = "OAUTH",
|
|
6374
6569
|
CREDENTIALS = "CREDENTIALS"
|
|
6375
6570
|
}
|
|
6571
|
+
/** @enumType */
|
|
6572
|
+
export type ConnectMethodWithLiterals = ConnectMethod | 'OAUTH' | 'CREDENTIALS';
|
|
6376
6573
|
export declare enum ListEventFromCalendars {
|
|
6377
6574
|
/** Listing events from the external calendar is not supported. */
|
|
6378
6575
|
LIST_NOT_SUPPORTED = "LIST_NOT_SUPPORTED",
|
|
@@ -6384,6 +6581,8 @@ export declare enum ListEventFromCalendars {
|
|
|
6384
6581
|
*/
|
|
6385
6582
|
LIST_FROM_SPECIFIC_CALENDARS = "LIST_FROM_SPECIFIC_CALENDARS"
|
|
6386
6583
|
}
|
|
6584
|
+
/** @enumType */
|
|
6585
|
+
export type ListEventFromCalendarsWithLiterals = ListEventFromCalendars | 'LIST_NOT_SUPPORTED' | 'LIST_FROM_PRIMARY_CALENDAR_ONLY' | 'LIST_FROM_SPECIFIC_CALENDARS';
|
|
6387
6586
|
export declare enum SyncToCalendar {
|
|
6388
6587
|
/** Syncing Wix calendar sessions to the external calendar is not supported. */
|
|
6389
6588
|
SYNC_NOT_SUPPORTED = "SYNC_NOT_SUPPORTED",
|
|
@@ -6392,6 +6591,8 @@ export declare enum SyncToCalendar {
|
|
|
6392
6591
|
/** Syncing Wix calendar sessions to a new external calendar. */
|
|
6393
6592
|
SYNC_TO_DEDICATED_CALENDAR = "SYNC_TO_DEDICATED_CALENDAR"
|
|
6394
6593
|
}
|
|
6594
|
+
/** @enumType */
|
|
6595
|
+
export type SyncToCalendarWithLiterals = SyncToCalendar | 'SYNC_NOT_SUPPORTED' | 'SYNC_TO_PRIMARY_CALENDAR_ONLY' | 'SYNC_TO_DEDICATED_CALENDAR';
|
|
6395
6596
|
export interface DefaultTaxGroupProviderConfig {
|
|
6396
6597
|
/** URI where the SPI Implementer is deployed */
|
|
6397
6598
|
deploymentUri?: string;
|
|
@@ -6439,9 +6640,9 @@ export interface HeadlessOAuth {
|
|
|
6439
6640
|
*/
|
|
6440
6641
|
logoutUrl?: string | null;
|
|
6441
6642
|
/** OAuth application type. */
|
|
6442
|
-
applicationType?:
|
|
6643
|
+
applicationType?: OAuthAppTypeWithLiterals;
|
|
6443
6644
|
/** OAuth technology used by the application. */
|
|
6444
|
-
technology?:
|
|
6645
|
+
technology?: OAuthTechnologiesWithLiterals;
|
|
6445
6646
|
}
|
|
6446
6647
|
/** Types of OAuth application. */
|
|
6447
6648
|
export declare enum OAuthAppType {
|
|
@@ -6454,6 +6655,8 @@ export declare enum OAuthAppType {
|
|
|
6454
6655
|
/** OAuth app type is some other type of application. */
|
|
6455
6656
|
OTHER = "OTHER"
|
|
6456
6657
|
}
|
|
6658
|
+
/** @enumType */
|
|
6659
|
+
export type OAuthAppTypeWithLiterals = OAuthAppType | 'OAUTH_APP_TYPE_UNSPECIFIED' | 'WEB_APP' | 'MOBILE' | 'OTHER';
|
|
6457
6660
|
/** OAuth technology used by the oauth application. */
|
|
6458
6661
|
export declare enum OAuthTechnologies {
|
|
6459
6662
|
/** The OAuth technology is not specified. */
|
|
@@ -6475,6 +6678,8 @@ export declare enum OAuthTechnologies {
|
|
|
6475
6678
|
/** OAuth technology using some other kind of technology. */
|
|
6476
6679
|
OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
|
|
6477
6680
|
}
|
|
6681
|
+
/** @enumType */
|
|
6682
|
+
export type OAuthTechnologiesWithLiterals = OAuthTechnologies | 'OAUTH_TECHNOLOGY_UNSPECIFIED' | 'JAVASCRIPT' | 'ANGULAR' | 'VUE' | 'REACT' | 'REACT_NATIVE' | 'IOS' | 'ANDROID' | 'OTHER_TECHNOLOGY';
|
|
6478
6683
|
export interface TaxCalculatorSpiConfig {
|
|
6479
6684
|
/** URI where the SPI Implementer is deployed */
|
|
6480
6685
|
deploymentUri?: string;
|
|
@@ -6549,7 +6754,7 @@ export interface ComponentReferenceDataConfig {
|
|
|
6549
6754
|
* @minSize 1
|
|
6550
6755
|
* @maxSize 100
|
|
6551
6756
|
*/
|
|
6552
|
-
supportedComponentTypes?:
|
|
6757
|
+
supportedComponentTypes?: ComponentTypeWithLiterals[];
|
|
6553
6758
|
}
|
|
6554
6759
|
/** Configuration for ReviewsProductCatalogProvider */
|
|
6555
6760
|
export interface ReviewsProductCatalogProviderConfig {
|
|
@@ -6584,7 +6789,7 @@ export interface SocialMarketingDesignsProviderConfig {
|
|
|
6584
6789
|
*/
|
|
6585
6790
|
iconUrl?: string;
|
|
6586
6791
|
/** How the Prover should be opened */
|
|
6587
|
-
navigationType?:
|
|
6792
|
+
navigationType?: NavigationTypeWithLiterals;
|
|
6588
6793
|
/** Is delete design implemented by the provider */
|
|
6589
6794
|
deleteDesignEnabled?: boolean;
|
|
6590
6795
|
/** If the provider manages designs */
|
|
@@ -6594,6 +6799,8 @@ export declare enum NavigationType {
|
|
|
6594
6799
|
NAVIGATE = "NAVIGATE",
|
|
6595
6800
|
MODAL = "MODAL"
|
|
6596
6801
|
}
|
|
6802
|
+
/** @enumType */
|
|
6803
|
+
export type NavigationTypeWithLiterals = NavigationType | 'NAVIGATE' | 'MODAL';
|
|
6597
6804
|
export interface GbpFeatureConfig {
|
|
6598
6805
|
baseUri?: SpiBaseUri;
|
|
6599
6806
|
}
|
|
@@ -6621,13 +6828,15 @@ export interface PingSettingsGroupComponentData {
|
|
|
6621
6828
|
/** the description of the setting group */
|
|
6622
6829
|
description?: string | null;
|
|
6623
6830
|
/** the default state of the setting group */
|
|
6624
|
-
state?:
|
|
6831
|
+
state?: PingSettingsGroupComponentDataStateWithLiterals;
|
|
6625
6832
|
}
|
|
6626
6833
|
export declare enum PingSettingsGroupComponentDataState {
|
|
6627
6834
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6628
6835
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6629
6836
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6630
6837
|
}
|
|
6838
|
+
/** @enumType */
|
|
6839
|
+
export type PingSettingsGroupComponentDataStateWithLiterals = PingSettingsGroupComponentDataState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6631
6840
|
export interface FormSpamSubmissionSpiConfig {
|
|
6632
6841
|
/** URI where the SPI Implementer is deployed */
|
|
6633
6842
|
baseUri?: SpiBaseUri;
|
|
@@ -6775,25 +6984,29 @@ export interface NotificationTopic {
|
|
|
6775
6984
|
/** the description of the topic */
|
|
6776
6985
|
description?: string | null;
|
|
6777
6986
|
/** the default state of the topic */
|
|
6778
|
-
state?:
|
|
6987
|
+
state?: NotificationTopicStateWithLiterals;
|
|
6779
6988
|
/** the type of the topic */
|
|
6780
|
-
type?:
|
|
6989
|
+
type?: NotificationTopicTypeWithLiterals;
|
|
6781
6990
|
/**
|
|
6782
6991
|
* The recipients' types indicate that this topic is relevant.
|
|
6783
6992
|
* @maxSize 10
|
|
6784
6993
|
*/
|
|
6785
|
-
supportedRecipientTypes?:
|
|
6994
|
+
supportedRecipientTypes?: RecipientTypeWithLiterals[];
|
|
6786
6995
|
}
|
|
6787
6996
|
export declare enum NotificationTopicState {
|
|
6788
6997
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6789
6998
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6790
6999
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6791
7000
|
}
|
|
7001
|
+
/** @enumType */
|
|
7002
|
+
export type NotificationTopicStateWithLiterals = NotificationTopicState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6792
7003
|
export declare enum NotificationTopicType {
|
|
6793
7004
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
6794
7005
|
PROMOTIONAL = "PROMOTIONAL",
|
|
6795
7006
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
6796
7007
|
}
|
|
7008
|
+
/** @enumType */
|
|
7009
|
+
export type NotificationTopicTypeWithLiterals = NotificationTopicType | 'UNKNOWN_TYPE' | 'PROMOTIONAL' | 'TRANSACTIONAL';
|
|
6797
7010
|
/** Recipient type */
|
|
6798
7011
|
export declare enum RecipientType {
|
|
6799
7012
|
/** Wix User */
|
|
@@ -6801,6 +7014,8 @@ export declare enum RecipientType {
|
|
|
6801
7014
|
/** Contact */
|
|
6802
7015
|
CONTACT = "CONTACT"
|
|
6803
7016
|
}
|
|
7017
|
+
/** @enumType */
|
|
7018
|
+
export type RecipientTypeWithLiterals = RecipientType | 'WIX_USER' | 'CONTACT';
|
|
6804
7019
|
export interface NotificationPreferencesFilterConfig {
|
|
6805
7020
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
6806
7021
|
baseUri?: SpiBaseUri;
|
|
@@ -7123,6 +7338,8 @@ export declare enum PlanFormPricingOption {
|
|
|
7123
7338
|
ONE_TIME = "ONE_TIME",
|
|
7124
7339
|
RECURRING = "RECURRING"
|
|
7125
7340
|
}
|
|
7341
|
+
/** @enumType */
|
|
7342
|
+
export type PlanFormPricingOptionWithLiterals = PlanFormPricingOption | 'FREE' | 'ONE_TIME' | 'RECURRING';
|
|
7126
7343
|
export declare enum PlanFormDefaultSection {
|
|
7127
7344
|
INFO = "INFO",
|
|
7128
7345
|
BENEFITS = "BENEFITS",
|
|
@@ -7130,6 +7347,8 @@ export declare enum PlanFormDefaultSection {
|
|
|
7130
7347
|
PRICING_AND_DURATION = "PRICING_AND_DURATION",
|
|
7131
7348
|
ADVANCED_SETTINGS = "ADVANCED_SETTINGS"
|
|
7132
7349
|
}
|
|
7350
|
+
/** @enumType */
|
|
7351
|
+
export type PlanFormDefaultSectionWithLiterals = PlanFormDefaultSection | 'INFO' | 'BENEFITS' | 'PAGE_PERMISSIONS' | 'PRICING_AND_DURATION' | 'ADVANCED_SETTINGS';
|
|
7133
7352
|
export interface Illustration extends IllustrationIllustrationOneOf {
|
|
7134
7353
|
/**
|
|
7135
7354
|
* Custom exported component ID to be rendered as an illustration.
|
|
@@ -7153,7 +7372,7 @@ export interface PlanDuration {
|
|
|
7153
7372
|
/** Amount of a duration `unit` in a single payment cycle. */
|
|
7154
7373
|
count?: number;
|
|
7155
7374
|
/** Unit of time for the cycle duration. */
|
|
7156
|
-
unit?:
|
|
7375
|
+
unit?: PlanPeriodUnitWithLiterals;
|
|
7157
7376
|
}
|
|
7158
7377
|
/** Pedefined basic time unit. */
|
|
7159
7378
|
export declare enum PlanPeriodUnit {
|
|
@@ -7162,6 +7381,8 @@ export declare enum PlanPeriodUnit {
|
|
|
7162
7381
|
MONTH = "MONTH",
|
|
7163
7382
|
YEAR = "YEAR"
|
|
7164
7383
|
}
|
|
7384
|
+
/** @enumType */
|
|
7385
|
+
export type PlanPeriodUnitWithLiterals = PlanPeriodUnit | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
7165
7386
|
export interface PlanPriceData {
|
|
7166
7387
|
/** Monetary amount. Decimal string with a period as a decimal separator. For example, `3.99`. */
|
|
7167
7388
|
value?: string;
|
|
@@ -7284,7 +7505,7 @@ export interface PlanFormPricingAndDurationSection {
|
|
|
7284
7505
|
* Order in which pricing options should be displayed.
|
|
7285
7506
|
* @maxSize 99
|
|
7286
7507
|
*/
|
|
7287
|
-
pricingOptionOrder?:
|
|
7508
|
+
pricingOptionOrder?: PlanFormPricingOptionWithLiterals[];
|
|
7288
7509
|
}
|
|
7289
7510
|
export interface PlanFormCustomSection {
|
|
7290
7511
|
/**
|
|
@@ -7298,14 +7519,14 @@ export interface PlanFormSection extends PlanFormSectionSectionOneOf {
|
|
|
7298
7519
|
/** Extension component ID. */
|
|
7299
7520
|
componentId?: string;
|
|
7300
7521
|
/** Default section name. */
|
|
7301
|
-
sectionName?:
|
|
7522
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7302
7523
|
}
|
|
7303
7524
|
/** @oneof */
|
|
7304
7525
|
export interface PlanFormSectionSectionOneOf {
|
|
7305
7526
|
/** Extension component ID. */
|
|
7306
7527
|
componentId?: string;
|
|
7307
7528
|
/** Default section name. */
|
|
7308
|
-
sectionName?:
|
|
7529
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7309
7530
|
}
|
|
7310
7531
|
export interface PlanFormTypeMetadata {
|
|
7311
7532
|
/** Configuration name. */
|
|
@@ -7372,7 +7593,7 @@ export interface UserNotificationData {
|
|
|
7372
7593
|
/** icon */
|
|
7373
7594
|
icon?: Icon;
|
|
7374
7595
|
/** intent */
|
|
7375
|
-
intent?:
|
|
7596
|
+
intent?: IntentWithLiterals;
|
|
7376
7597
|
/** limiter field */
|
|
7377
7598
|
limiterField?: LimiterField;
|
|
7378
7599
|
/** recipient filter */
|
|
@@ -7386,7 +7607,7 @@ export interface UserNotificationData {
|
|
|
7386
7607
|
/** context */
|
|
7387
7608
|
context?: UserNotificationDataContext;
|
|
7388
7609
|
/** type */
|
|
7389
|
-
type?:
|
|
7610
|
+
type?: UserNotificationDataTypeWithLiterals;
|
|
7390
7611
|
}
|
|
7391
7612
|
export interface TypedDynamicParam {
|
|
7392
7613
|
/**
|
|
@@ -7395,16 +7616,20 @@ export interface TypedDynamicParam {
|
|
|
7395
7616
|
*/
|
|
7396
7617
|
name?: string;
|
|
7397
7618
|
/** dynamic param type */
|
|
7398
|
-
dynamicParamType?:
|
|
7619
|
+
dynamicParamType?: TypedDynamicParamTypeWithLiterals;
|
|
7399
7620
|
}
|
|
7400
7621
|
export declare enum TypedDynamicParamType {
|
|
7401
7622
|
STRING = "STRING",
|
|
7402
7623
|
ARRAY = "ARRAY"
|
|
7403
7624
|
}
|
|
7625
|
+
/** @enumType */
|
|
7626
|
+
export type TypedDynamicParamTypeWithLiterals = TypedDynamicParamType | 'STRING' | 'ARRAY';
|
|
7404
7627
|
export declare enum UserNotificationDataRecipientFilterType {
|
|
7405
7628
|
WIX_USERS = "WIX_USERS",
|
|
7406
7629
|
SITE_CONTRIBUTORS = "SITE_CONTRIBUTORS"
|
|
7407
7630
|
}
|
|
7631
|
+
/** @enumType */
|
|
7632
|
+
export type UserNotificationDataRecipientFilterTypeWithLiterals = UserNotificationDataRecipientFilterType | 'WIX_USERS' | 'SITE_CONTRIBUTORS';
|
|
7408
7633
|
export interface WixUsersData {
|
|
7409
7634
|
/** id */
|
|
7410
7635
|
_id?: TypedDynamicParam;
|
|
@@ -7417,6 +7642,8 @@ export declare enum InitiatorType {
|
|
|
7417
7642
|
WIX_USER = "WIX_USER",
|
|
7418
7643
|
WIX_APP = "WIX_APP"
|
|
7419
7644
|
}
|
|
7645
|
+
/** @enumType */
|
|
7646
|
+
export type InitiatorTypeWithLiterals = InitiatorType | 'WIX_USER' | 'WIX_APP';
|
|
7420
7647
|
export interface WixUserData {
|
|
7421
7648
|
/**
|
|
7422
7649
|
* dynamic param name
|
|
@@ -7465,6 +7692,8 @@ export declare enum Level {
|
|
|
7465
7692
|
ACCOUNT = "ACCOUNT",
|
|
7466
7693
|
SITE = "SITE"
|
|
7467
7694
|
}
|
|
7695
|
+
/** @enumType */
|
|
7696
|
+
export type LevelWithLiterals = Level | 'ACCOUNT' | 'SITE';
|
|
7468
7697
|
export interface OrderValue {
|
|
7469
7698
|
/** can be const/dynamicParamName */
|
|
7470
7699
|
value?: ConstOrDynamicParam;
|
|
@@ -7580,7 +7809,7 @@ export interface Icon extends IconDataOneOf {
|
|
|
7580
7809
|
/** url data */
|
|
7581
7810
|
urlData?: UrlData;
|
|
7582
7811
|
/** icon type */
|
|
7583
|
-
type?:
|
|
7812
|
+
type?: IconTypeWithLiterals;
|
|
7584
7813
|
}
|
|
7585
7814
|
/** @oneof */
|
|
7586
7815
|
export interface IconDataOneOf {
|
|
@@ -7592,6 +7821,8 @@ export declare enum IconType {
|
|
|
7592
7821
|
SPOUT = "SPOUT",
|
|
7593
7822
|
INITIATOR = "INITIATOR"
|
|
7594
7823
|
}
|
|
7824
|
+
/** @enumType */
|
|
7825
|
+
export type IconTypeWithLiterals = IconType | 'URL' | 'SPOUT' | 'INITIATOR';
|
|
7595
7826
|
export interface UrlData {
|
|
7596
7827
|
/**
|
|
7597
7828
|
* actual url
|
|
@@ -7619,7 +7850,7 @@ export interface SharedPlatformMobilePushConfig {
|
|
|
7619
7850
|
/** ttl */
|
|
7620
7851
|
ttl?: number | null;
|
|
7621
7852
|
/** target application */
|
|
7622
|
-
targetApplication?:
|
|
7853
|
+
targetApplication?: MobileApplicationWithLiterals;
|
|
7623
7854
|
}
|
|
7624
7855
|
export declare enum MobileApplication {
|
|
7625
7856
|
UNKNOWN_MOBILE_APPLICATION = "UNKNOWN_MOBILE_APPLICATION",
|
|
@@ -7633,11 +7864,13 @@ export declare enum MobileApplication {
|
|
|
7633
7864
|
WIX_STUDIO = "WIX_STUDIO",
|
|
7634
7865
|
NO_SPECIFIC_TARGET_APP = "NO_SPECIFIC_TARGET_APP"
|
|
7635
7866
|
}
|
|
7867
|
+
/** @enumType */
|
|
7868
|
+
export type MobileApplicationWithLiterals = MobileApplication | 'UNKNOWN_MOBILE_APPLICATION' | 'OWNER' | 'SPACES' | 'DINE' | 'FITNESS' | 'WIX_LIFE' | 'WIX_PARTNERS' | 'BRANDED' | 'WIX_STUDIO' | 'NO_SPECIFIC_TARGET_APP';
|
|
7636
7869
|
export interface AndroidMobilePushConfig {
|
|
7637
7870
|
/** sub group key */
|
|
7638
7871
|
subGroupKey?: string | null;
|
|
7639
7872
|
/** style */
|
|
7640
|
-
style?:
|
|
7873
|
+
style?: AndroidStyleWithLiterals;
|
|
7641
7874
|
/** grouped deeplink pattern */
|
|
7642
7875
|
groupedDeeplinkPattern?: string | null;
|
|
7643
7876
|
}
|
|
@@ -7646,6 +7879,8 @@ export declare enum AndroidStyle {
|
|
|
7646
7879
|
MESSAGING = "MESSAGING",
|
|
7647
7880
|
INBOX = "INBOX"
|
|
7648
7881
|
}
|
|
7882
|
+
/** @enumType */
|
|
7883
|
+
export type AndroidStyleWithLiterals = AndroidStyle | 'BIG_TEXT' | 'MESSAGING' | 'INBOX';
|
|
7649
7884
|
export interface MobilePushChannelConfig {
|
|
7650
7885
|
/** shared */
|
|
7651
7886
|
shared?: SharedPlatformMobilePushConfig;
|
|
@@ -7670,7 +7905,7 @@ export interface ExposureRule extends ExposureRuleRuleOneOf {
|
|
|
7670
7905
|
/** custom experiment exposure rule */
|
|
7671
7906
|
customExperimentExposureRule?: CustomExperimentExposureRule;
|
|
7672
7907
|
/** type */
|
|
7673
|
-
type?:
|
|
7908
|
+
type?: ExposureRuleTypeWithLiterals;
|
|
7674
7909
|
}
|
|
7675
7910
|
/** @oneof */
|
|
7676
7911
|
export interface ExposureRuleRuleOneOf {
|
|
@@ -7685,6 +7920,8 @@ export declare enum ExposureRuleType {
|
|
|
7685
7920
|
BOOLEAN_EXPERIMENT = "BOOLEAN_EXPERIMENT",
|
|
7686
7921
|
CUSTOM_EXPERIMENT = "CUSTOM_EXPERIMENT"
|
|
7687
7922
|
}
|
|
7923
|
+
/** @enumType */
|
|
7924
|
+
export type ExposureRuleTypeWithLiterals = ExposureRuleType | 'OPEN_TO_ALL' | 'OPEN_TO_NONE' | 'BOOLEAN_EXPERIMENT' | 'CUSTOM_EXPERIMENT';
|
|
7688
7925
|
export interface BooleanExperimentExposureRule {
|
|
7689
7926
|
/** spec */
|
|
7690
7927
|
spec?: string;
|
|
@@ -7745,6 +7982,8 @@ export declare enum Intent {
|
|
|
7745
7982
|
MARKETING = "MARKETING",
|
|
7746
7983
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
7747
7984
|
}
|
|
7985
|
+
/** @enumType */
|
|
7986
|
+
export type IntentWithLiterals = Intent | 'MARKETING' | 'TRANSACTIONAL';
|
|
7748
7987
|
export interface LimiterField {
|
|
7749
7988
|
/** dynamic param name */
|
|
7750
7989
|
dynamicParamName?: string;
|
|
@@ -7755,7 +7994,7 @@ export interface UserNotificationDataRecipientFilter extends UserNotificationDat
|
|
|
7755
7994
|
/** site contributors data */
|
|
7756
7995
|
siteContributorsData?: SiteContributorsData;
|
|
7757
7996
|
/** recipient filter type */
|
|
7758
|
-
type?:
|
|
7997
|
+
type?: UserNotificationDataRecipientFilterTypeWithLiterals;
|
|
7759
7998
|
}
|
|
7760
7999
|
/** @oneof */
|
|
7761
8000
|
export interface UserNotificationDataRecipientFilterDataOneOf {
|
|
@@ -7768,7 +8007,7 @@ export interface UserNotificationDataInitiator extends UserNotificationDataIniti
|
|
|
7768
8007
|
/** wix user data */
|
|
7769
8008
|
wixUserData?: WixUserData;
|
|
7770
8009
|
/** initiator type */
|
|
7771
|
-
type?:
|
|
8010
|
+
type?: InitiatorTypeWithLiterals;
|
|
7772
8011
|
}
|
|
7773
8012
|
/** @oneof */
|
|
7774
8013
|
export interface UserNotificationDataInitiatorDataOneOf {
|
|
@@ -7785,7 +8024,7 @@ export interface UserNotificationDataDeeplinkOfOneOf {
|
|
|
7785
8024
|
url?: Url;
|
|
7786
8025
|
}
|
|
7787
8026
|
export interface UserNotificationDataContext {
|
|
7788
|
-
level?:
|
|
8027
|
+
level?: LevelWithLiterals;
|
|
7789
8028
|
/** params */
|
|
7790
8029
|
params?: Record<string, OrderValue>;
|
|
7791
8030
|
}
|
|
@@ -7794,6 +8033,8 @@ export declare enum UserNotificationDataType {
|
|
|
7794
8033
|
ALERT_WARNING = "ALERT_WARNING",
|
|
7795
8034
|
ALERT_INFO = "ALERT_INFO"
|
|
7796
8035
|
}
|
|
8036
|
+
/** @enumType */
|
|
8037
|
+
export type UserNotificationDataTypeWithLiterals = UserNotificationDataType | 'REGULAR' | 'ALERT_WARNING' | 'ALERT_INFO';
|
|
7797
8038
|
/** Describes contact notifications */
|
|
7798
8039
|
export interface ContactNotification {
|
|
7799
8040
|
/** @format GUID */
|
|
@@ -7834,6 +8075,8 @@ export declare enum RecipientFilterType {
|
|
|
7834
8075
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
7835
8076
|
CONTACTS = "CONTACTS"
|
|
7836
8077
|
}
|
|
8078
|
+
/** @enumType */
|
|
8079
|
+
export type RecipientFilterTypeWithLiterals = RecipientFilterType | 'UNKNOWN_TYPE' | 'CONTACTS';
|
|
7837
8080
|
export interface ContactsData {
|
|
7838
8081
|
/** id */
|
|
7839
8082
|
_id?: TypedDynamicParam;
|
|
@@ -7843,6 +8086,8 @@ export declare enum Type {
|
|
|
7843
8086
|
CONTACT = "CONTACT",
|
|
7844
8087
|
SITE_MEMBER = "SITE_MEMBER"
|
|
7845
8088
|
}
|
|
8089
|
+
/** @enumType */
|
|
8090
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'CONTACT' | 'SITE_MEMBER';
|
|
7846
8091
|
export interface ContactData {
|
|
7847
8092
|
/**
|
|
7848
8093
|
* dynamic param name
|
|
@@ -7873,7 +8118,7 @@ export interface RecipientFilter extends RecipientFilterDataOneOf {
|
|
|
7873
8118
|
/** contacts data */
|
|
7874
8119
|
contactsData?: ContactsData;
|
|
7875
8120
|
/** recipient filter type */
|
|
7876
|
-
type?:
|
|
8121
|
+
type?: RecipientFilterTypeWithLiterals;
|
|
7877
8122
|
}
|
|
7878
8123
|
/** @oneof */
|
|
7879
8124
|
export interface RecipientFilterDataOneOf {
|
|
@@ -7886,7 +8131,7 @@ export interface Initiator extends InitiatorDataOneOf {
|
|
|
7886
8131
|
/** site member data */
|
|
7887
8132
|
siteMemberData?: SiteMemberData;
|
|
7888
8133
|
/** initiator type */
|
|
7889
|
-
type?:
|
|
8134
|
+
type?: TypeWithLiterals;
|
|
7890
8135
|
}
|
|
7891
8136
|
/** @oneof */
|
|
7892
8137
|
export interface InitiatorDataOneOf {
|
|
@@ -8004,7 +8249,7 @@ export interface CommentsContextProviderConfig {
|
|
|
8004
8249
|
/** URI where the SPI Implementer is deployed */
|
|
8005
8250
|
baseUri?: SpiBaseUri;
|
|
8006
8251
|
/** Comments Environment */
|
|
8007
|
-
environment?:
|
|
8252
|
+
environment?: EnvironmentWithLiterals;
|
|
8008
8253
|
/** Feature toggle to indicate if method GetCommentContextResources is implemented */
|
|
8009
8254
|
toggleResourceProviderEnabled?: boolean;
|
|
8010
8255
|
}
|
|
@@ -8012,6 +8257,8 @@ export declare enum Environment {
|
|
|
8012
8257
|
LIVE_SITE = "LIVE_SITE",
|
|
8013
8258
|
BUSINESS_MANAGER = "BUSINESS_MANAGER"
|
|
8014
8259
|
}
|
|
8260
|
+
/** @enumType */
|
|
8261
|
+
export type EnvironmentWithLiterals = Environment | 'LIVE_SITE' | 'BUSINESS_MANAGER';
|
|
8015
8262
|
export interface FormSpamSubmissionReportSpiConfig {
|
|
8016
8263
|
/** URI where the SPI Implementer is deployed */
|
|
8017
8264
|
baseUri?: SpiBaseUri;
|
|
@@ -8233,7 +8480,7 @@ export interface SchemaKey {
|
|
|
8233
8480
|
* + `SITE`: A custom schema for a specific site.
|
|
8234
8481
|
* @immutable
|
|
8235
8482
|
*/
|
|
8236
|
-
scope?:
|
|
8483
|
+
scope?: SchemaScopeWithLiterals;
|
|
8237
8484
|
}
|
|
8238
8485
|
export declare enum SchemaScope {
|
|
8239
8486
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
@@ -8242,6 +8489,8 @@ export declare enum SchemaScope {
|
|
|
8242
8489
|
/** Custom schema for a specific site. */
|
|
8243
8490
|
SITE = "SITE"
|
|
8244
8491
|
}
|
|
8492
|
+
/** @enumType */
|
|
8493
|
+
export type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
|
|
8245
8494
|
export interface V1SchemaField {
|
|
8246
8495
|
/**
|
|
8247
8496
|
* 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 `^[^)(\\]\\[\\.]+$`.
|
|
@@ -8251,7 +8500,7 @@ export interface V1SchemaField {
|
|
|
8251
8500
|
*/
|
|
8252
8501
|
_id?: string;
|
|
8253
8502
|
/** **Required.** Field type. */
|
|
8254
|
-
type?:
|
|
8503
|
+
type?: SchemaFieldFieldTypeWithLiterals;
|
|
8255
8504
|
/**
|
|
8256
8505
|
* Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager).
|
|
8257
8506
|
* @maxLength 1000
|
|
@@ -8305,6 +8554,8 @@ export declare enum SchemaFieldFieldType {
|
|
|
8305
8554
|
/** Wix Media Manager document. */
|
|
8306
8555
|
DOCUMENT = "DOCUMENT"
|
|
8307
8556
|
}
|
|
8557
|
+
/** @enumType */
|
|
8558
|
+
export type SchemaFieldFieldTypeWithLiterals = SchemaFieldFieldType | 'UNDEFINED_TYPE' | 'SHORT_TEXT' | 'LONG_TEXT' | 'HTML' | 'RICH_CONTENT' | 'IMAGE' | 'IMAGE_LINK' | 'VIDEO' | 'DOCUMENT';
|
|
8308
8559
|
export interface PreviewFields {
|
|
8309
8560
|
/**
|
|
8310
8561
|
* ID of the field representing the schema's title.
|
|
@@ -8376,7 +8627,7 @@ export interface BackOfficeModal extends BackOfficeModalContentOneOf {
|
|
|
8376
8627
|
*
|
|
8377
8628
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8378
8629
|
*/
|
|
8379
|
-
hostingPlatform?:
|
|
8630
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8380
8631
|
/**
|
|
8381
8632
|
* Modal title.
|
|
8382
8633
|
* @minLength 1
|
|
@@ -8463,7 +8714,7 @@ export interface WidgetData {
|
|
|
8463
8714
|
*/
|
|
8464
8715
|
tagName?: string;
|
|
8465
8716
|
/** Type of JavaScript modularization approach used in the custom element */
|
|
8466
|
-
scriptType?:
|
|
8717
|
+
scriptType?: CustomElementScriptTypeWithLiterals;
|
|
8467
8718
|
}
|
|
8468
8719
|
export declare enum CustomElementScriptType {
|
|
8469
8720
|
NONE = "NONE",
|
|
@@ -8472,6 +8723,8 @@ export declare enum CustomElementScriptType {
|
|
|
8472
8723
|
/** ES Module modularization approach */
|
|
8473
8724
|
ES_MODULE = "ES_MODULE"
|
|
8474
8725
|
}
|
|
8726
|
+
/** @enumType */
|
|
8727
|
+
export type CustomElementScriptTypeWithLiterals = CustomElementScriptType | 'NONE' | 'COMMON_JS' | 'ES_MODULE';
|
|
8475
8728
|
export interface EditorBehaviors {
|
|
8476
8729
|
/** The settings behavior definition for the widget */
|
|
8477
8730
|
settings?: SettingsPanel;
|
|
@@ -8505,9 +8758,11 @@ export declare enum HeightMode {
|
|
|
8505
8758
|
/** Height is fixed require size in px */
|
|
8506
8759
|
FIXED = "FIXED"
|
|
8507
8760
|
}
|
|
8761
|
+
/** @enumType */
|
|
8762
|
+
export type HeightModeWithLiterals = HeightMode | 'UNKNOWN' | 'AUTO' | 'FIXED';
|
|
8508
8763
|
export interface WidgetSizeHeight {
|
|
8509
8764
|
/** Height calculation mode */
|
|
8510
|
-
heightMode?:
|
|
8765
|
+
heightMode?: HeightModeWithLiterals;
|
|
8511
8766
|
/**
|
|
8512
8767
|
* Default height in pixels
|
|
8513
8768
|
* @max 9999
|
|
@@ -8575,7 +8830,7 @@ export interface BackOfficeExtensionWidget extends BackOfficeExtensionWidgetAsse
|
|
|
8575
8830
|
*
|
|
8576
8831
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8577
8832
|
*/
|
|
8578
|
-
hostingPlatform?:
|
|
8833
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8579
8834
|
/**
|
|
8580
8835
|
* Slot ID for the plugin's container.
|
|
8581
8836
|
* @format GUID
|
|
@@ -8607,7 +8862,7 @@ export interface BackOfficeExtensionMenuItem {
|
|
|
8607
8862
|
*
|
|
8608
8863
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8609
8864
|
*/
|
|
8610
|
-
hostingPlatform?:
|
|
8865
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8611
8866
|
/**
|
|
8612
8867
|
* Slot ID for the plugin's container.
|
|
8613
8868
|
* @format GUID
|
|
@@ -8711,7 +8966,7 @@ export interface FormTemplate extends FormTemplateTemplateTypeOptionsOneOf {
|
|
|
8711
8966
|
* Specifies the template purpose
|
|
8712
8967
|
* @immutable
|
|
8713
8968
|
*/
|
|
8714
|
-
templateType?:
|
|
8969
|
+
templateType?: TemplateTypeWithLiterals;
|
|
8715
8970
|
/**
|
|
8716
8971
|
* Date of creation.
|
|
8717
8972
|
* @readonly
|
|
@@ -8760,7 +9015,7 @@ export interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
8760
9015
|
* Type of the field
|
|
8761
9016
|
* @readonly
|
|
8762
9017
|
*/
|
|
8763
|
-
fieldType?:
|
|
9018
|
+
fieldType?: FieldTypeWithLiterals;
|
|
8764
9019
|
}
|
|
8765
9020
|
/** @oneof */
|
|
8766
9021
|
export interface FieldFieldTypeOptionsOneOf {
|
|
@@ -8774,6 +9029,8 @@ export declare enum FieldType {
|
|
|
8774
9029
|
INPUT = "INPUT",
|
|
8775
9030
|
DISPLAY = "DISPLAY"
|
|
8776
9031
|
}
|
|
9032
|
+
/** @enumType */
|
|
9033
|
+
export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
|
|
8777
9034
|
export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
8778
9035
|
/** Input return string as value */
|
|
8779
9036
|
stringOptions?: _String;
|
|
@@ -8812,7 +9069,7 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
8812
9069
|
* Type of the input field
|
|
8813
9070
|
* @readonly
|
|
8814
9071
|
*/
|
|
8815
|
-
inputType?:
|
|
9072
|
+
inputType?: InputTypeWithLiterals;
|
|
8816
9073
|
/** Mapping to contacts, telling to what contact property field input value should be saved. */
|
|
8817
9074
|
contactMapping?: FormFieldContactInfo;
|
|
8818
9075
|
/**
|
|
@@ -8867,7 +9124,7 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
8867
9124
|
*/
|
|
8868
9125
|
pattern?: string | null;
|
|
8869
9126
|
/** Format of a string. */
|
|
8870
|
-
format?:
|
|
9127
|
+
format?: FormatWithLiterals;
|
|
8871
9128
|
/**
|
|
8872
9129
|
* List of allowed values.
|
|
8873
9130
|
* @maxSize 500
|
|
@@ -8904,6 +9161,8 @@ export declare enum Format {
|
|
|
8904
9161
|
LANGUAGE = "LANGUAGE",
|
|
8905
9162
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
8906
9163
|
}
|
|
9164
|
+
/** @enumType */
|
|
9165
|
+
export type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
|
|
8907
9166
|
export interface DateTimeConstraints {
|
|
8908
9167
|
/**
|
|
8909
9168
|
* Support static constrains defined as ISO date/time format, as well as
|
|
@@ -8941,6 +9200,8 @@ export declare enum StringComponentType {
|
|
|
8941
9200
|
TIME_INPUT = "TIME_INPUT",
|
|
8942
9201
|
DATE_PICKER = "DATE_PICKER"
|
|
8943
9202
|
}
|
|
9203
|
+
/** @enumType */
|
|
9204
|
+
export type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER';
|
|
8944
9205
|
export interface TextInput {
|
|
8945
9206
|
/**
|
|
8946
9207
|
* Label of the field
|
|
@@ -8990,7 +9251,7 @@ export interface RadioGroup {
|
|
|
8990
9251
|
* Specifies the number of columns used to display the selections within the component.
|
|
8991
9252
|
* Default: ONE
|
|
8992
9253
|
*/
|
|
8993
|
-
numberOfColumns?:
|
|
9254
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
8994
9255
|
}
|
|
8995
9256
|
export interface RadioGroupOption {
|
|
8996
9257
|
/**
|
|
@@ -9036,6 +9297,8 @@ export declare enum NumberOfColumns {
|
|
|
9036
9297
|
/** Three columns. */
|
|
9037
9298
|
THREE = "THREE"
|
|
9038
9299
|
}
|
|
9300
|
+
/** @enumType */
|
|
9301
|
+
export type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
|
|
9039
9302
|
export interface Dropdown {
|
|
9040
9303
|
/**
|
|
9041
9304
|
* Label of the field
|
|
@@ -9225,7 +9488,7 @@ export interface DatePicker {
|
|
|
9225
9488
|
*/
|
|
9226
9489
|
placeholder?: string | null;
|
|
9227
9490
|
/** First day of the week displayed on date picker. */
|
|
9228
|
-
firstDayOfWeek?:
|
|
9491
|
+
firstDayOfWeek?: FirstDayOfWeekWithLiterals;
|
|
9229
9492
|
/**
|
|
9230
9493
|
* Default value for the date picker.
|
|
9231
9494
|
* @format LOCAL_DATE
|
|
@@ -9238,6 +9501,8 @@ export declare enum FirstDayOfWeek {
|
|
|
9238
9501
|
/** First day of the week is Sunday. */
|
|
9239
9502
|
SUNDAY = "SUNDAY"
|
|
9240
9503
|
}
|
|
9504
|
+
/** @enumType */
|
|
9505
|
+
export type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
|
|
9241
9506
|
export interface NumberType {
|
|
9242
9507
|
/** Inclusive maximum value. */
|
|
9243
9508
|
maximum?: number | null;
|
|
@@ -9256,6 +9521,8 @@ export declare enum NumberComponentType {
|
|
|
9256
9521
|
NUMBER_INPUT = "NUMBER_INPUT",
|
|
9257
9522
|
RATING_INPUT = "RATING_INPUT"
|
|
9258
9523
|
}
|
|
9524
|
+
/** @enumType */
|
|
9525
|
+
export type NumberComponentTypeWithLiterals = NumberComponentType | 'UNKNOWN' | 'NUMBER_INPUT' | 'RATING_INPUT';
|
|
9259
9526
|
export interface NumberInput {
|
|
9260
9527
|
/**
|
|
9261
9528
|
* Label of the field
|
|
@@ -9308,6 +9575,8 @@ export declare enum BooleanComponentType {
|
|
|
9308
9575
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9309
9576
|
CHECKBOX = "CHECKBOX"
|
|
9310
9577
|
}
|
|
9578
|
+
/** @enumType */
|
|
9579
|
+
export type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
|
|
9311
9580
|
export interface Checkbox {
|
|
9312
9581
|
/** Label of the field */
|
|
9313
9582
|
label?: RichContent;
|
|
@@ -9339,6 +9608,8 @@ export declare enum ItemType {
|
|
|
9339
9608
|
INTEGER = "INTEGER",
|
|
9340
9609
|
OBJECT = "OBJECT"
|
|
9341
9610
|
}
|
|
9611
|
+
/** @enumType */
|
|
9612
|
+
export type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'OBJECT';
|
|
9342
9613
|
export interface IntegerType {
|
|
9343
9614
|
/** Maximum value. */
|
|
9344
9615
|
maximum?: number | null;
|
|
@@ -9364,6 +9635,8 @@ export declare enum PropertiesTypeEnum {
|
|
|
9364
9635
|
INTEGER = "INTEGER",
|
|
9365
9636
|
ARRAY = "ARRAY"
|
|
9366
9637
|
}
|
|
9638
|
+
/** @enumType */
|
|
9639
|
+
export type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'ARRAY';
|
|
9367
9640
|
export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
|
|
9368
9641
|
/** String type validation for property. */
|
|
9369
9642
|
stringOptions?: StringType;
|
|
@@ -9379,7 +9652,7 @@ export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf
|
|
|
9379
9652
|
* Type of object properties
|
|
9380
9653
|
* @readonly
|
|
9381
9654
|
*/
|
|
9382
|
-
propertiesType?:
|
|
9655
|
+
propertiesType?: PropertiesTypeEnumWithLiterals;
|
|
9383
9656
|
/** Whether the property is required. */
|
|
9384
9657
|
required?: boolean;
|
|
9385
9658
|
}
|
|
@@ -9411,7 +9684,7 @@ export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsO
|
|
|
9411
9684
|
* Type of array items
|
|
9412
9685
|
* @readonly
|
|
9413
9686
|
*/
|
|
9414
|
-
itemType?:
|
|
9687
|
+
itemType?: ItemTypeWithLiterals;
|
|
9415
9688
|
}
|
|
9416
9689
|
/** @oneof */
|
|
9417
9690
|
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -9430,6 +9703,8 @@ export declare enum ArrayComponentType {
|
|
|
9430
9703
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9431
9704
|
CHECKBOX_GROUP = "CHECKBOX_GROUP"
|
|
9432
9705
|
}
|
|
9706
|
+
/** @enumType */
|
|
9707
|
+
export type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP';
|
|
9433
9708
|
export interface CheckboxGroup {
|
|
9434
9709
|
/**
|
|
9435
9710
|
* Label of the field
|
|
@@ -9454,7 +9729,7 @@ export interface CheckboxGroup {
|
|
|
9454
9729
|
* Specifies the number of columns used to display the selections within the component.
|
|
9455
9730
|
* Default: ONE
|
|
9456
9731
|
*/
|
|
9457
|
-
numberOfColumns?:
|
|
9732
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9458
9733
|
}
|
|
9459
9734
|
export interface MediaItem extends MediaItemMediaOneOf {
|
|
9460
9735
|
/** WixMedia image. */
|
|
@@ -9534,6 +9809,8 @@ export declare enum WixFileComponentType {
|
|
|
9534
9809
|
FILE_UPLOAD = "FILE_UPLOAD",
|
|
9535
9810
|
SIGNATURE = "SIGNATURE"
|
|
9536
9811
|
}
|
|
9812
|
+
/** @enumType */
|
|
9813
|
+
export type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
|
|
9537
9814
|
export interface FileUpload {
|
|
9538
9815
|
/**
|
|
9539
9816
|
* Selectable option label
|
|
@@ -9562,7 +9839,7 @@ export interface FileUpload {
|
|
|
9562
9839
|
* Supported file formats for upload
|
|
9563
9840
|
* @maxSize 5
|
|
9564
9841
|
*/
|
|
9565
|
-
uploadFileFormats?:
|
|
9842
|
+
uploadFileFormats?: UploadFileFormatWithLiterals[];
|
|
9566
9843
|
/**
|
|
9567
9844
|
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
9568
9845
|
* @maxLength 255
|
|
@@ -9583,6 +9860,8 @@ export declare enum UploadFileFormat {
|
|
|
9583
9860
|
/** Archive files. */
|
|
9584
9861
|
ARCHIVE = "ARCHIVE"
|
|
9585
9862
|
}
|
|
9863
|
+
/** @enumType */
|
|
9864
|
+
export type UploadFileFormatWithLiterals = UploadFileFormat | 'UNDEFINED' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
|
|
9586
9865
|
export interface Signature {
|
|
9587
9866
|
/**
|
|
9588
9867
|
* Selectable option label
|
|
@@ -9604,6 +9883,8 @@ export declare enum PaymentComponentType {
|
|
|
9604
9883
|
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
9605
9884
|
DONATION_INPUT = "DONATION_INPUT"
|
|
9606
9885
|
}
|
|
9886
|
+
/** @enumType */
|
|
9887
|
+
export type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT';
|
|
9607
9888
|
export interface PaymentType {
|
|
9608
9889
|
/**
|
|
9609
9890
|
* Field mapped to products.
|
|
@@ -9629,6 +9910,8 @@ export declare enum ProductType {
|
|
|
9629
9910
|
/** Digital. */
|
|
9630
9911
|
DIGITAL = "DIGITAL"
|
|
9631
9912
|
}
|
|
9913
|
+
/** @enumType */
|
|
9914
|
+
export type ProductTypeWithLiterals = ProductType | 'UNKNOWN' | 'SHIPPABLE' | 'DIGITAL';
|
|
9632
9915
|
export declare enum PriceType {
|
|
9633
9916
|
UNKNOWN = "UNKNOWN",
|
|
9634
9917
|
/** Fixed price. */
|
|
@@ -9636,6 +9919,8 @@ export declare enum PriceType {
|
|
|
9636
9919
|
/** Dynamic price from price range. */
|
|
9637
9920
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
9638
9921
|
}
|
|
9922
|
+
/** @enumType */
|
|
9923
|
+
export type PriceTypeWithLiterals = PriceType | 'UNKNOWN' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
|
|
9639
9924
|
export interface QuantityLimit {
|
|
9640
9925
|
/**
|
|
9641
9926
|
* Minimum quantity.
|
|
@@ -9681,9 +9966,9 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
9681
9966
|
*/
|
|
9682
9967
|
_id?: string;
|
|
9683
9968
|
/** Product type. */
|
|
9684
|
-
productType?:
|
|
9969
|
+
productType?: ProductTypeWithLiterals;
|
|
9685
9970
|
/** Price type. */
|
|
9686
|
-
priceType?:
|
|
9971
|
+
priceType?: PriceTypeWithLiterals;
|
|
9687
9972
|
/** Quantity limit. */
|
|
9688
9973
|
quantityLimit?: QuantityLimit;
|
|
9689
9974
|
}
|
|
@@ -9716,7 +10001,7 @@ export interface ProductCheckboxGroup {
|
|
|
9716
10001
|
* Defines how an image should be resized to fit within its option.
|
|
9717
10002
|
* Default: COVER
|
|
9718
10003
|
*/
|
|
9719
|
-
imageFit?:
|
|
10004
|
+
imageFit?: ImageFitWithLiterals;
|
|
9720
10005
|
}
|
|
9721
10006
|
export interface ProductCheckboxGroupOption {
|
|
9722
10007
|
/**
|
|
@@ -9744,6 +10029,8 @@ export declare enum ImageFit {
|
|
|
9744
10029
|
/** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
|
|
9745
10030
|
CONTAIN = "CONTAIN"
|
|
9746
10031
|
}
|
|
10032
|
+
/** @enumType */
|
|
10033
|
+
export type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
|
|
9747
10034
|
export interface DonationInput {
|
|
9748
10035
|
/**
|
|
9749
10036
|
* Label of the field.
|
|
@@ -9763,7 +10050,7 @@ export interface DonationInput {
|
|
|
9763
10050
|
* Specifies the number of columns used to display the selections within the component.
|
|
9764
10051
|
* Default: ONE
|
|
9765
10052
|
*/
|
|
9766
|
-
numberOfColumns?:
|
|
10053
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9767
10054
|
/**
|
|
9768
10055
|
* Flag identifying to hide or not label
|
|
9769
10056
|
* Default: true
|
|
@@ -9795,6 +10082,8 @@ export declare enum MultilineAddressComponentType {
|
|
|
9795
10082
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9796
10083
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9797
10084
|
}
|
|
10085
|
+
/** @enumType */
|
|
10086
|
+
export type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
|
|
9798
10087
|
export interface MultilineAddressValidation {
|
|
9799
10088
|
/**
|
|
9800
10089
|
* Allowed countries. No countries treated as all.
|
|
@@ -9852,6 +10141,8 @@ export declare enum DefaultCountryConfigType {
|
|
|
9852
10141
|
/** Pre-selected default country. */
|
|
9853
10142
|
COUNTRY = "COUNTRY"
|
|
9854
10143
|
}
|
|
10144
|
+
/** @enumType */
|
|
10145
|
+
export type DefaultCountryConfigTypeWithLiterals = DefaultCountryConfigType | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
|
|
9855
10146
|
export interface AddressLine2 {
|
|
9856
10147
|
/** Show address line 2 field. */
|
|
9857
10148
|
show?: boolean;
|
|
@@ -9863,7 +10154,7 @@ export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
|
9863
10154
|
*/
|
|
9864
10155
|
countryOptions?: string;
|
|
9865
10156
|
/** Default country type. */
|
|
9866
|
-
type?:
|
|
10157
|
+
type?: DefaultCountryConfigTypeWithLiterals;
|
|
9867
10158
|
}
|
|
9868
10159
|
/** @oneof */
|
|
9869
10160
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
@@ -9888,6 +10179,8 @@ export declare enum InputType {
|
|
|
9888
10179
|
PAYMENT = "PAYMENT",
|
|
9889
10180
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9890
10181
|
}
|
|
10182
|
+
/** @enumType */
|
|
10183
|
+
export type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS';
|
|
9891
10184
|
export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
|
|
9892
10185
|
/** Email info. */
|
|
9893
10186
|
emailInfo?: EmailInfo;
|
|
@@ -9900,7 +10193,7 @@ export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfo
|
|
|
9900
10193
|
/** Subscription info */
|
|
9901
10194
|
subscriptionInfo?: SubscriptionInfo;
|
|
9902
10195
|
/** Field mapped to contacts. */
|
|
9903
|
-
contactField?:
|
|
10196
|
+
contactField?: ContactFieldWithLiterals;
|
|
9904
10197
|
}
|
|
9905
10198
|
/** @oneof */
|
|
9906
10199
|
export interface FormFieldContactInfoAdditionalInfoOneOf {
|
|
@@ -9919,19 +10212,27 @@ export declare enum EmailInfoTag {
|
|
|
9919
10212
|
UNTAGGED = "UNTAGGED",
|
|
9920
10213
|
MAIN = "MAIN"
|
|
9921
10214
|
}
|
|
10215
|
+
/** @enumType */
|
|
10216
|
+
export type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9922
10217
|
export declare enum PhoneInfoTag {
|
|
9923
10218
|
UNTAGGED = "UNTAGGED",
|
|
9924
10219
|
MAIN = "MAIN"
|
|
9925
10220
|
}
|
|
10221
|
+
/** @enumType */
|
|
10222
|
+
export type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9926
10223
|
export declare enum AddressInfoTag {
|
|
9927
10224
|
UNTAGGED = "UNTAGGED",
|
|
9928
10225
|
HOME = "HOME"
|
|
9929
10226
|
}
|
|
10227
|
+
/** @enumType */
|
|
10228
|
+
export type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
|
|
9930
10229
|
export declare enum ConfirmationLevel {
|
|
9931
10230
|
UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
|
|
9932
10231
|
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
9933
10232
|
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
9934
10233
|
}
|
|
10234
|
+
/** @enumType */
|
|
10235
|
+
export type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
|
|
9935
10236
|
export declare enum ContactField {
|
|
9936
10237
|
UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
|
|
9937
10238
|
FIRST_NAME = "FIRST_NAME",
|
|
@@ -9946,17 +10247,19 @@ export declare enum ContactField {
|
|
|
9946
10247
|
SUBSCRIPTION = "SUBSCRIPTION",
|
|
9947
10248
|
VAT_ID = "VAT_ID"
|
|
9948
10249
|
}
|
|
10250
|
+
/** @enumType */
|
|
10251
|
+
export type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
|
|
9949
10252
|
export interface EmailInfo {
|
|
9950
10253
|
/** Email tag. */
|
|
9951
|
-
tag?:
|
|
10254
|
+
tag?: EmailInfoTagWithLiterals;
|
|
9952
10255
|
}
|
|
9953
10256
|
export interface PhoneInfo {
|
|
9954
10257
|
/** Phone tag. */
|
|
9955
|
-
tag?:
|
|
10258
|
+
tag?: PhoneInfoTagWithLiterals;
|
|
9956
10259
|
}
|
|
9957
10260
|
export interface AddressInfo {
|
|
9958
10261
|
/** Address tag. */
|
|
9959
|
-
tag?:
|
|
10262
|
+
tag?: AddressInfoTagWithLiterals;
|
|
9960
10263
|
}
|
|
9961
10264
|
export interface CustomFieldInfo {
|
|
9962
10265
|
/**
|
|
@@ -9971,7 +10274,7 @@ export interface SubscriptionInfo {
|
|
|
9971
10274
|
* Subscription consent opt in level, either single or double confirmation.
|
|
9972
10275
|
* Default: SINGLE_CONFIRMATION
|
|
9973
10276
|
*/
|
|
9974
|
-
confirmationLevel?:
|
|
10277
|
+
confirmationLevel?: ConfirmationLevelWithLiterals;
|
|
9975
10278
|
}
|
|
9976
10279
|
export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
9977
10280
|
/** Text input field */
|
|
@@ -9996,7 +10299,7 @@ export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
|
9996
10299
|
* Component type of the string input field
|
|
9997
10300
|
* @readonly
|
|
9998
10301
|
*/
|
|
9999
|
-
componentType?:
|
|
10302
|
+
componentType?: StringComponentTypeWithLiterals;
|
|
10000
10303
|
}
|
|
10001
10304
|
/** @oneof */
|
|
10002
10305
|
export interface _StringComponentTypeOptionsOneOf {
|
|
@@ -10028,7 +10331,7 @@ export interface InputField_Number extends InputField_NumberComponentTypeOptions
|
|
|
10028
10331
|
* Component type of the number input field
|
|
10029
10332
|
* @readonly
|
|
10030
10333
|
*/
|
|
10031
|
-
componentType?:
|
|
10334
|
+
componentType?: NumberComponentTypeWithLiterals;
|
|
10032
10335
|
}
|
|
10033
10336
|
/** @oneof */
|
|
10034
10337
|
export interface InputField_NumberComponentTypeOptionsOneOf {
|
|
@@ -10046,7 +10349,7 @@ export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
|
|
|
10046
10349
|
* Component type of the boolean input field
|
|
10047
10350
|
* @readonly
|
|
10048
10351
|
*/
|
|
10049
|
-
componentType?:
|
|
10352
|
+
componentType?: BooleanComponentTypeWithLiterals;
|
|
10050
10353
|
}
|
|
10051
10354
|
/** @oneof */
|
|
10052
10355
|
export interface _BooleanComponentTypeOptionsOneOf {
|
|
@@ -10062,7 +10365,7 @@ export interface _Array extends _ArrayComponentTypeOptionsOneOf {
|
|
|
10062
10365
|
* Component type of the array input field
|
|
10063
10366
|
* @readonly
|
|
10064
10367
|
*/
|
|
10065
|
-
componentType?:
|
|
10368
|
+
componentType?: ArrayComponentTypeWithLiterals;
|
|
10066
10369
|
}
|
|
10067
10370
|
/** @oneof */
|
|
10068
10371
|
export interface _ArrayComponentTypeOptionsOneOf {
|
|
@@ -10082,7 +10385,7 @@ export interface WixFile extends WixFileComponentTypeOptionsOneOf {
|
|
|
10082
10385
|
* Component type of the array input field
|
|
10083
10386
|
* @readonly
|
|
10084
10387
|
*/
|
|
10085
|
-
componentType?:
|
|
10388
|
+
componentType?: WixFileComponentTypeWithLiterals;
|
|
10086
10389
|
}
|
|
10087
10390
|
/** @oneof */
|
|
10088
10391
|
export interface WixFileComponentTypeOptionsOneOf {
|
|
@@ -10100,7 +10403,7 @@ export interface Payment extends PaymentComponentTypeOptionsOneOf {
|
|
|
10100
10403
|
* Component type of the payment input field.
|
|
10101
10404
|
* @readonly
|
|
10102
10405
|
*/
|
|
10103
|
-
componentType?:
|
|
10406
|
+
componentType?: PaymentComponentTypeWithLiterals;
|
|
10104
10407
|
/** Validation of payment type. */
|
|
10105
10408
|
validation?: PaymentType;
|
|
10106
10409
|
}
|
|
@@ -10118,7 +10421,7 @@ export interface MultilineAddress extends MultilineAddressComponentTypeOptionsOn
|
|
|
10118
10421
|
* Component type of the multiline address field.
|
|
10119
10422
|
* @readonly
|
|
10120
10423
|
*/
|
|
10121
|
-
componentType?:
|
|
10424
|
+
componentType?: MultilineAddressComponentTypeWithLiterals;
|
|
10122
10425
|
/** Validation of multiline address field output value. */
|
|
10123
10426
|
validation?: MultilineAddressValidation;
|
|
10124
10427
|
}
|
|
@@ -10132,7 +10435,7 @@ export interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
|
10132
10435
|
richContentOptions?: RichContentOptions;
|
|
10133
10436
|
/** Page navigation component resolving as navigation or submit buttons */
|
|
10134
10437
|
pageNavigationOptions?: PageNavigationOptions;
|
|
10135
|
-
displayFieldType?:
|
|
10438
|
+
displayFieldType?: DisplayFieldTypeWithLiterals;
|
|
10136
10439
|
}
|
|
10137
10440
|
/** @oneof */
|
|
10138
10441
|
export interface DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
@@ -10147,6 +10450,8 @@ export declare enum DisplayFieldType {
|
|
|
10147
10450
|
PAGE_NAVIGATION = "PAGE_NAVIGATION",
|
|
10148
10451
|
LOGIN_BAR = "LOGIN_BAR"
|
|
10149
10452
|
}
|
|
10453
|
+
/** @enumType */
|
|
10454
|
+
export type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
|
|
10150
10455
|
export interface RichContentOptions {
|
|
10151
10456
|
/** Content of the header */
|
|
10152
10457
|
richContent?: RichContent;
|
|
@@ -10288,6 +10593,8 @@ export declare enum ChangeableProperty {
|
|
|
10288
10593
|
/** Allowed values property type. */
|
|
10289
10594
|
ALLOWED_VALUES = "ALLOWED_VALUES"
|
|
10290
10595
|
}
|
|
10596
|
+
/** @enumType */
|
|
10597
|
+
export type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
|
|
10291
10598
|
export interface RequiredOptions {
|
|
10292
10599
|
/** Value of required property */
|
|
10293
10600
|
value?: boolean;
|
|
@@ -10308,6 +10615,8 @@ export declare enum OverrideEntityType {
|
|
|
10308
10615
|
UNKNOWN = "UNKNOWN",
|
|
10309
10616
|
FIELD = "FIELD"
|
|
10310
10617
|
}
|
|
10618
|
+
/** @enumType */
|
|
10619
|
+
export type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
|
|
10311
10620
|
export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
10312
10621
|
/** Required property overrides */
|
|
10313
10622
|
requiredOptions?: RequiredOptions;
|
|
@@ -10322,7 +10631,7 @@ export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
|
10322
10631
|
*/
|
|
10323
10632
|
fieldId?: string;
|
|
10324
10633
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
10325
|
-
propertyType?:
|
|
10634
|
+
propertyType?: ChangeablePropertyWithLiterals;
|
|
10326
10635
|
}
|
|
10327
10636
|
/** @oneof */
|
|
10328
10637
|
export interface FieldOverridePropertyTypeOptionsOneOf {
|
|
@@ -10373,7 +10682,7 @@ export interface V2Condition {
|
|
|
10373
10682
|
*/
|
|
10374
10683
|
fact?: string;
|
|
10375
10684
|
/** The operator to use for comparison. */
|
|
10376
|
-
operator?:
|
|
10685
|
+
operator?: OperatorWithLiterals;
|
|
10377
10686
|
/**
|
|
10378
10687
|
* The value to compare against.
|
|
10379
10688
|
* @maxLength 500
|
|
@@ -10409,6 +10718,8 @@ export declare enum Operator {
|
|
|
10409
10718
|
IS_DATE_NEWER_THAN = "IS_DATE_NEWER_THAN",
|
|
10410
10719
|
IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
|
|
10411
10720
|
}
|
|
10721
|
+
/** @enumType */
|
|
10722
|
+
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';
|
|
10412
10723
|
export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
10413
10724
|
/** Field override properties. */
|
|
10414
10725
|
fieldOptions?: FieldOverride;
|
|
@@ -10416,7 +10727,7 @@ export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
|
10416
10727
|
* Override entity type.
|
|
10417
10728
|
* @immutable
|
|
10418
10729
|
*/
|
|
10419
|
-
entityType?:
|
|
10730
|
+
entityType?: OverrideEntityTypeWithLiterals;
|
|
10420
10731
|
}
|
|
10421
10732
|
/** @oneof */
|
|
10422
10733
|
export interface FormOverrideEntityTypeOptionsOneOf {
|
|
@@ -10429,7 +10740,7 @@ export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptions
|
|
|
10429
10740
|
/** Options for redirecting to a URL after submission. */
|
|
10430
10741
|
redirectOptions?: RedirectOptions;
|
|
10431
10742
|
/** Action that is triggered after a successful form submission. */
|
|
10432
|
-
submitSuccessAction?:
|
|
10743
|
+
submitSuccessAction?: SubmitSuccessActionWithLiterals;
|
|
10433
10744
|
}
|
|
10434
10745
|
/** @oneof */
|
|
10435
10746
|
export interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
@@ -10445,6 +10756,8 @@ export declare enum Target {
|
|
|
10445
10756
|
/** Open in a new browser tab. */
|
|
10446
10757
|
BLANK = "BLANK"
|
|
10447
10758
|
}
|
|
10759
|
+
/** @enumType */
|
|
10760
|
+
export type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
|
|
10448
10761
|
export declare enum SubmitSuccessAction {
|
|
10449
10762
|
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
10450
10763
|
/** No action will be taken after submission. */
|
|
@@ -10454,6 +10767,8 @@ export declare enum SubmitSuccessAction {
|
|
|
10454
10767
|
/** The user will be redirected to a URL after submission. */
|
|
10455
10768
|
REDIRECT = "REDIRECT"
|
|
10456
10769
|
}
|
|
10770
|
+
/** @enumType */
|
|
10771
|
+
export type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
|
|
10457
10772
|
export interface ThankYouMessageOptions {
|
|
10458
10773
|
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
10459
10774
|
durationInSeconds?: number | null;
|
|
@@ -10467,7 +10782,7 @@ export interface RedirectOptions {
|
|
|
10467
10782
|
*/
|
|
10468
10783
|
redirectUrl?: string | null;
|
|
10469
10784
|
/** How the URL should be opened. */
|
|
10470
|
-
target?:
|
|
10785
|
+
target?: TargetWithLiterals;
|
|
10471
10786
|
}
|
|
10472
10787
|
export declare enum TemplateType {
|
|
10473
10788
|
UNKNOWN = "UNKNOWN",
|
|
@@ -10481,6 +10796,8 @@ export declare enum TemplateType {
|
|
|
10481
10796
|
*/
|
|
10482
10797
|
FORM_INPUT = "FORM_INPUT"
|
|
10483
10798
|
}
|
|
10799
|
+
/** @enumType */
|
|
10800
|
+
export type TemplateTypeWithLiterals = TemplateType | 'UNKNOWN' | 'EXTENDABLE' | 'DEMO' | 'FORM_INPUT';
|
|
10484
10801
|
export interface ExtensionDetails {
|
|
10485
10802
|
/** Allow user to add/remove custom field, not present in template */
|
|
10486
10803
|
addCustomFields?: AddCustomFields;
|
|
@@ -10493,6 +10810,8 @@ export declare enum CustomFieldsType {
|
|
|
10493
10810
|
/** Allow user to add/remove any custom field, not present in template */
|
|
10494
10811
|
ANY = "ANY"
|
|
10495
10812
|
}
|
|
10813
|
+
/** @enumType */
|
|
10814
|
+
export type CustomFieldsTypeWithLiterals = CustomFieldsType | 'ANY';
|
|
10496
10815
|
export declare enum EditableProperties {
|
|
10497
10816
|
UNKNOWN = "UNKNOWN",
|
|
10498
10817
|
/** Change property responsible for field requirement */
|
|
@@ -10513,16 +10832,18 @@ export declare enum EditableProperties {
|
|
|
10513
10832
|
/** Change property responsible for field default value */
|
|
10514
10833
|
DEFAULT_VALUE = "DEFAULT_VALUE"
|
|
10515
10834
|
}
|
|
10835
|
+
/** @enumType */
|
|
10836
|
+
export type EditablePropertiesWithLiterals = EditableProperties | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'LABEL' | 'PLACEHOLDER' | 'DESCRIPTION' | 'INPUT_VALUE_LIMITS' | 'DEFAULT_VALUE';
|
|
10516
10837
|
export interface EditableFields {
|
|
10517
10838
|
/**
|
|
10518
10839
|
* List of editable properties for field
|
|
10519
10840
|
* @maxSize 10
|
|
10520
10841
|
*/
|
|
10521
|
-
properties?:
|
|
10842
|
+
properties?: EditablePropertiesWithLiterals[];
|
|
10522
10843
|
}
|
|
10523
10844
|
export interface AddCustomFields {
|
|
10524
10845
|
/** Field types which can be added */
|
|
10525
|
-
fieldType?:
|
|
10846
|
+
fieldType?: CustomFieldsTypeWithLiterals;
|
|
10526
10847
|
}
|
|
10527
10848
|
export interface OverrideTemplateFields {
|
|
10528
10849
|
/** Editable properties by field id. */
|
|
@@ -10550,9 +10871,9 @@ export interface FieldGroup {
|
|
|
10550
10871
|
}
|
|
10551
10872
|
export interface RequiredIndicatorProperties {
|
|
10552
10873
|
/** Required indicator. */
|
|
10553
|
-
requiredIndicator?:
|
|
10874
|
+
requiredIndicator?: RequiredIndicatorWithLiterals;
|
|
10554
10875
|
/** Required indicator placement. */
|
|
10555
|
-
requiredIndicatorPlacement?:
|
|
10876
|
+
requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
|
|
10556
10877
|
}
|
|
10557
10878
|
export declare enum RequiredIndicator {
|
|
10558
10879
|
/** Unknown required indicator. */
|
|
@@ -10564,6 +10885,8 @@ export declare enum RequiredIndicator {
|
|
|
10564
10885
|
/** None. */
|
|
10565
10886
|
NONE = "NONE"
|
|
10566
10887
|
}
|
|
10888
|
+
/** @enumType */
|
|
10889
|
+
export type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | 'ASTERISK' | 'TEXT' | 'NONE';
|
|
10567
10890
|
export declare enum RequiredIndicatorPlacement {
|
|
10568
10891
|
/** Unknown required indicator placement. */
|
|
10569
10892
|
UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
|
|
@@ -10572,6 +10895,8 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
10572
10895
|
/** Before field title. */
|
|
10573
10896
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
10574
10897
|
}
|
|
10898
|
+
/** @enumType */
|
|
10899
|
+
export type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
|
|
10575
10900
|
/** Describes a setting group of a notification */
|
|
10576
10901
|
export interface NotificationContent {
|
|
10577
10902
|
single?: SingleContent;
|
|
@@ -10627,7 +10952,7 @@ export interface VeloPublishPipelineTaskProviderConfig {
|
|
|
10627
10952
|
* The Velo Task name
|
|
10628
10953
|
* @maxSize 100
|
|
10629
10954
|
*/
|
|
10630
|
-
implementerTasksNames?:
|
|
10955
|
+
implementerTasksNames?: WixCodePublishTaskNameWithLiterals[];
|
|
10631
10956
|
}
|
|
10632
10957
|
export declare enum WixCodePublishTaskName {
|
|
10633
10958
|
/** unknown */
|
|
@@ -10645,6 +10970,8 @@ export declare enum WixCodePublishTaskName {
|
|
|
10645
10970
|
/** code packages dependencies registration */
|
|
10646
10971
|
CODE_PACKAGES_REGISTRATION = "CODE_PACKAGES_REGISTRATION"
|
|
10647
10972
|
}
|
|
10973
|
+
/** @enumType */
|
|
10974
|
+
export type WixCodePublishTaskNameWithLiterals = WixCodePublishTaskName | 'UNKNOWN' | 'USER_CODE_BUNDLE' | 'EXPORTED_FUNCTIONS_ANALYSIS' | 'IMPORTED_NAMESPACES_ANALYSIS' | 'PAGE_DETAILS_ANALYSIS' | 'USER_CODE_VALIDATION' | 'CODE_PACKAGES_REGISTRATION';
|
|
10648
10975
|
export interface FunctionsShopPriceSpiConfig {
|
|
10649
10976
|
/** Uri config */
|
|
10650
10977
|
uriConfig?: SpiBaseUri;
|
|
@@ -10876,7 +11203,7 @@ export interface ChannelChannelConfiguration extends ChannelChannelConfiguration
|
|
|
10876
11203
|
*/
|
|
10877
11204
|
channelKey?: string;
|
|
10878
11205
|
/** The type of the communication channel */
|
|
10879
|
-
type?:
|
|
11206
|
+
type?: ChannelConfigurationChannelTypeWithLiterals;
|
|
10880
11207
|
/** Specific provider branding parameters for the channel */
|
|
10881
11208
|
branding?: ChannelChannelBranding;
|
|
10882
11209
|
}
|
|
@@ -10896,6 +11223,8 @@ export declare enum ChannelConfigurationChannelType {
|
|
|
10896
11223
|
EMAIL = "EMAIL",
|
|
10897
11224
|
SMS = "SMS"
|
|
10898
11225
|
}
|
|
11226
|
+
/** @enumType */
|
|
11227
|
+
export type ChannelConfigurationChannelTypeWithLiterals = ChannelConfigurationChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
10899
11228
|
export interface DmDirectMessageConfig {
|
|
10900
11229
|
/**
|
|
10901
11230
|
* Direct message types accepted by the provider.
|
|
@@ -10903,7 +11232,7 @@ export interface DmDirectMessageConfig {
|
|
|
10903
11232
|
* If the provider supports all message types, this field can be empty.
|
|
10904
11233
|
* @maxSize 100
|
|
10905
11234
|
*/
|
|
10906
|
-
acceptedMessageTypes?:
|
|
11235
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals[];
|
|
10907
11236
|
/** Supported media types (mime types) and sizes */
|
|
10908
11237
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10909
11238
|
/** Defines whether or not sending messages will be available for recipients without contact Id */
|
|
@@ -10924,6 +11253,8 @@ export declare enum AcceptedMessageTypesAcceptedDirectMessageType {
|
|
|
10924
11253
|
FORM = "FORM",
|
|
10925
11254
|
SYSTEM = "SYSTEM"
|
|
10926
11255
|
}
|
|
11256
|
+
/** @enumType */
|
|
11257
|
+
export type AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals = AcceptedMessageTypesAcceptedDirectMessageType | 'UNKNOWN_DIRECT_MESSAGE_TYPE' | 'MEDIA' | 'CARD' | 'MINIMAL' | 'FORM' | 'SYSTEM';
|
|
10927
11258
|
export interface ChannelMediaCapabilities {
|
|
10928
11259
|
/** When marked as true, 'supported_media_types' will be ignored. */
|
|
10929
11260
|
allMediaTypes?: boolean;
|
|
@@ -10950,7 +11281,7 @@ export interface SmsSmsMessageConfig {
|
|
|
10950
11281
|
* @minSize 1
|
|
10951
11282
|
* @maxSize 100
|
|
10952
11283
|
*/
|
|
10953
|
-
acceptedMessageTypes?:
|
|
11284
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals[];
|
|
10954
11285
|
/** Supported media types (mime types) and sizes */
|
|
10955
11286
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10956
11287
|
/** Optional - maximum sms message length in characters, if not given, will be unlimited */
|
|
@@ -10961,6 +11292,8 @@ export declare enum AcceptedMessageTypesAcceptedSmsMessageType {
|
|
|
10961
11292
|
SMS = "SMS",
|
|
10962
11293
|
MMS = "MMS"
|
|
10963
11294
|
}
|
|
11295
|
+
/** @enumType */
|
|
11296
|
+
export type AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals = AcceptedMessageTypesAcceptedSmsMessageType | 'UNKNOWN_SMS_MESSAGE_TYPE' | 'SMS' | 'MMS';
|
|
10964
11297
|
export interface ChannelChannelBranding {
|
|
10965
11298
|
/**
|
|
10966
11299
|
* The name of the channel, e.g. `Facebook` / `SMS`
|
|
@@ -11100,7 +11433,7 @@ export interface FactorConfig {
|
|
|
11100
11433
|
/** the base URI where all the methods are deployed. */
|
|
11101
11434
|
uriConfig?: SpiBaseUri;
|
|
11102
11435
|
/** the type of the factor */
|
|
11103
|
-
factorType?:
|
|
11436
|
+
factorType?: FactorTypeWithLiterals;
|
|
11104
11437
|
/** whether the factor supports verify without enrolling first */
|
|
11105
11438
|
supportsVerifyWithoutEnroll?: boolean;
|
|
11106
11439
|
}
|
|
@@ -11113,6 +11446,8 @@ export declare enum FactorType {
|
|
|
11113
11446
|
TOTP = "TOTP",
|
|
11114
11447
|
PUSH = "PUSH"
|
|
11115
11448
|
}
|
|
11449
|
+
/** @enumType */
|
|
11450
|
+
export type FactorTypeWithLiterals = FactorType | 'UNKNOWN_FACTOR_TYPE' | 'PASSWORD' | 'SMS' | 'CALL' | 'EMAIL' | 'TOTP' | 'PUSH';
|
|
11116
11451
|
export interface DiscountsSPIConfig {
|
|
11117
11452
|
/**
|
|
11118
11453
|
* Base URI where the endpoints are called.
|
|
@@ -11172,7 +11507,7 @@ export interface Monitoring extends MonitoringOptionsOneOf {
|
|
|
11172
11507
|
/** Panorama provider options */
|
|
11173
11508
|
panoramaOptions?: PanoramaOptions;
|
|
11174
11509
|
/** Provider type */
|
|
11175
|
-
type?:
|
|
11510
|
+
type?: MonitoringTypeWithLiterals;
|
|
11176
11511
|
}
|
|
11177
11512
|
/** @oneof */
|
|
11178
11513
|
export interface MonitoringOptionsOneOf {
|
|
@@ -11214,6 +11549,8 @@ export declare enum MonitoringType {
|
|
|
11214
11549
|
SENTRY = "SENTRY",
|
|
11215
11550
|
PANORAMA = "PANORAMA"
|
|
11216
11551
|
}
|
|
11552
|
+
/** @enumType */
|
|
11553
|
+
export type MonitoringTypeWithLiterals = MonitoringType | 'UNKNOWN_PROVIDER' | 'SENTRY' | 'PANORAMA';
|
|
11217
11554
|
export interface PanoramaOptions {
|
|
11218
11555
|
/** Sentry config */
|
|
11219
11556
|
sentry?: SentryOptions;
|
|
@@ -11234,12 +11571,12 @@ export interface PluginConfig {
|
|
|
11234
11571
|
*/
|
|
11235
11572
|
pluginDisplayName?: string;
|
|
11236
11573
|
startingEnforcementDate?: Date | null;
|
|
11237
|
-
importanceLevel?:
|
|
11574
|
+
importanceLevel?: ImportanceLevelWithLiterals;
|
|
11238
11575
|
/** @maxSize 100 */
|
|
11239
11576
|
constraints?: Constraint[];
|
|
11240
11577
|
}
|
|
11241
11578
|
export interface Consequence {
|
|
11242
|
-
escalation?:
|
|
11579
|
+
escalation?: EscalationWithLiterals;
|
|
11243
11580
|
/** days to resolve the violation */
|
|
11244
11581
|
daysToResolve?: number | null;
|
|
11245
11582
|
}
|
|
@@ -11251,11 +11588,15 @@ export declare enum Escalation {
|
|
|
11251
11588
|
/** only shows violation in papi-dashboard */
|
|
11252
11589
|
VISIBILITY = "VISIBILITY"
|
|
11253
11590
|
}
|
|
11591
|
+
/** @enumType */
|
|
11592
|
+
export type EscalationWithLiterals = Escalation | 'BREAK_BUILD' | 'BLOCK_ROLLOUT' | 'BLOCK_FUTURE_ROLLOUT' | 'OPEN_BUG_SLA' | 'VISIBILITY';
|
|
11254
11593
|
export declare enum ImportanceLevel {
|
|
11255
11594
|
LOW = "LOW",
|
|
11256
11595
|
MEDIUM = "MEDIUM",
|
|
11257
11596
|
HIGH = "HIGH"
|
|
11258
11597
|
}
|
|
11598
|
+
/** @enumType */
|
|
11599
|
+
export type ImportanceLevelWithLiterals = ImportanceLevel | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
11259
11600
|
export interface Constraint {
|
|
11260
11601
|
/** @maxLength 1024 */
|
|
11261
11602
|
_id?: string;
|
|
@@ -11380,7 +11721,7 @@ export interface Panel extends PanelSelectedContentTypeOneOf {
|
|
|
11380
11721
|
/** Optional: The size of the panel */
|
|
11381
11722
|
size?: PanelSize;
|
|
11382
11723
|
/** The selected panel content type */
|
|
11383
|
-
contentType?:
|
|
11724
|
+
contentType?: PanelContentTypeWithLiterals;
|
|
11384
11725
|
}
|
|
11385
11726
|
/** @oneof */
|
|
11386
11727
|
export interface PanelSelectedContentTypeOneOf {
|
|
@@ -11397,18 +11738,22 @@ export interface PanelSize {
|
|
|
11397
11738
|
*/
|
|
11398
11739
|
height?: number | null;
|
|
11399
11740
|
/** width of the panel */
|
|
11400
|
-
width?:
|
|
11741
|
+
width?: WidthWithLiterals;
|
|
11401
11742
|
}
|
|
11402
11743
|
export declare enum Width {
|
|
11403
11744
|
SMALL = "SMALL",
|
|
11404
11745
|
MEDIUM = "MEDIUM",
|
|
11405
11746
|
LARGE = "LARGE"
|
|
11406
11747
|
}
|
|
11748
|
+
/** @enumType */
|
|
11749
|
+
export type WidthWithLiterals = Width | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
11407
11750
|
/** Represents the options for panel content types */
|
|
11408
11751
|
export declare enum PanelContentType {
|
|
11409
11752
|
UNKNOWN_PanelContentType = "UNKNOWN_PanelContentType",
|
|
11410
11753
|
url = "url"
|
|
11411
11754
|
}
|
|
11755
|
+
/** @enumType */
|
|
11756
|
+
export type PanelContentTypeWithLiterals = PanelContentType | 'UNKNOWN_PanelContentType' | 'url';
|
|
11412
11757
|
/** Represents the information needed for code panels */
|
|
11413
11758
|
export interface CodePanel {
|
|
11414
11759
|
/**
|
|
@@ -11428,7 +11773,7 @@ export interface PurchaseValidationsConfig {
|
|
|
11428
11773
|
}
|
|
11429
11774
|
export interface BrowserStorage {
|
|
11430
11775
|
/** The type of browser storage used */
|
|
11431
|
-
type?:
|
|
11776
|
+
type?: StorageTypeWithLiterals;
|
|
11432
11777
|
/**
|
|
11433
11778
|
* The name of the storage item in the browser (as can be seen in DEV Console)
|
|
11434
11779
|
* @maxLength 100
|
|
@@ -11446,9 +11791,9 @@ export interface BrowserStorage {
|
|
|
11446
11791
|
* This defines when this storage item is allowed to be used in a visitor session.
|
|
11447
11792
|
* > This is legally important for complying with EU privacy law, so make sure to define this carefully.
|
|
11448
11793
|
*/
|
|
11449
|
-
consentCategory?:
|
|
11794
|
+
consentCategory?: ConsentCategoryWithLiterals;
|
|
11450
11795
|
/** Where this storage item will be set in the browser (User domain or the App domain) */
|
|
11451
|
-
domain?:
|
|
11796
|
+
domain?: StorageDomainWithLiterals;
|
|
11452
11797
|
}
|
|
11453
11798
|
/** The type of storage we are declaring */
|
|
11454
11799
|
export declare enum StorageType {
|
|
@@ -11462,6 +11807,8 @@ export declare enum StorageType {
|
|
|
11462
11807
|
/** An item in [IndexDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) */
|
|
11463
11808
|
INDEXDB = "INDEXDB"
|
|
11464
11809
|
}
|
|
11810
|
+
/** @enumType */
|
|
11811
|
+
export type StorageTypeWithLiterals = StorageType | 'UNKNOWN_STORAGE_TYPE' | 'COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE' | 'INDEXDB';
|
|
11465
11812
|
/** The category for EU and US Privacy Law classification */
|
|
11466
11813
|
export declare enum ConsentCategory {
|
|
11467
11814
|
/** This is an invalid value, you must classify your storage item. */
|
|
@@ -11475,6 +11822,8 @@ export declare enum ConsentCategory {
|
|
|
11475
11822
|
/** Related to advertising, upselling and marketing data collected to be used. */
|
|
11476
11823
|
advertising = "advertising"
|
|
11477
11824
|
}
|
|
11825
|
+
/** @enumType */
|
|
11826
|
+
export type ConsentCategoryWithLiterals = ConsentCategory | 'UNKNOWN_CATEGORY' | 'essential' | 'functional' | 'analytics' | 'advertising';
|
|
11478
11827
|
export declare enum StorageDomain {
|
|
11479
11828
|
UNKNOWN_STORAGE_DOMAIN = "UNKNOWN_STORAGE_DOMAIN",
|
|
11480
11829
|
/** Storing the values in the domain of the website the app is installed on */
|
|
@@ -11484,6 +11833,8 @@ export declare enum StorageDomain {
|
|
|
11484
11833
|
/** Storing the values as 3rd party in the application domain */
|
|
11485
11834
|
APP_DOMAIN = "APP_DOMAIN"
|
|
11486
11835
|
}
|
|
11836
|
+
/** @enumType */
|
|
11837
|
+
export type StorageDomainWithLiterals = StorageDomain | 'UNKNOWN_STORAGE_DOMAIN' | 'SITE_DOMAIN' | 'WIX_DOMAIN' | 'APP_DOMAIN';
|
|
11487
11838
|
/** Describe SDK module definition for an app */
|
|
11488
11839
|
export interface SdkDefinition {
|
|
11489
11840
|
/**
|
|
@@ -11515,7 +11866,7 @@ export interface EventValidationProviderConfig {
|
|
|
11515
11866
|
}
|
|
11516
11867
|
export interface ValidationTarget {
|
|
11517
11868
|
/** The method to validate. */
|
|
11518
|
-
method?:
|
|
11869
|
+
method?: MethodWithLiterals;
|
|
11519
11870
|
/**
|
|
11520
11871
|
* Optional WQL filter applied to the events for validation.
|
|
11521
11872
|
* Only events matching this filter will be validated.
|
|
@@ -11532,6 +11883,8 @@ export declare enum Method {
|
|
|
11532
11883
|
/** Validate an event before cancel. */
|
|
11533
11884
|
CANCEL = "CANCEL"
|
|
11534
11885
|
}
|
|
11886
|
+
/** @enumType */
|
|
11887
|
+
export type MethodWithLiterals = Method | 'CREATE' | 'UPDATE' | 'CANCEL';
|
|
11535
11888
|
/** 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. */
|
|
11536
11889
|
export interface ClientSideService {
|
|
11537
11890
|
/**
|
|
@@ -11682,7 +12035,7 @@ export interface AudienceProviderConfig {
|
|
|
11682
12035
|
*/
|
|
11683
12036
|
displayName?: string;
|
|
11684
12037
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
11685
|
-
participantType?:
|
|
12038
|
+
participantType?: ParticipantTypeWithLiterals;
|
|
11686
12039
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
11687
12040
|
inputSchema?: Record<string, any> | null;
|
|
11688
12041
|
/**
|
|
@@ -11696,7 +12049,7 @@ export interface AudienceProviderConfig {
|
|
|
11696
12049
|
* Define the scopes which the provider audience is relevant
|
|
11697
12050
|
* @maxSize 10
|
|
11698
12051
|
*/
|
|
11699
|
-
scopes?:
|
|
12052
|
+
scopes?: ScopeWithLiterals[];
|
|
11700
12053
|
}
|
|
11701
12054
|
export declare enum ParticipantType {
|
|
11702
12055
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
@@ -11704,11 +12057,13 @@ export declare enum ParticipantType {
|
|
|
11704
12057
|
CONTACT = "CONTACT",
|
|
11705
12058
|
ANONYMOUS = "ANONYMOUS"
|
|
11706
12059
|
}
|
|
12060
|
+
/** @enumType */
|
|
12061
|
+
export type ParticipantTypeWithLiterals = ParticipantType | 'UNKNOWN_TYPE' | 'WIX_USER' | 'CONTACT' | 'ANONYMOUS';
|
|
11707
12062
|
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
11708
12063
|
/** Should be filled if the provider implements its own custom UI */
|
|
11709
12064
|
widgetComponentConfiguration?: WidgetComponent;
|
|
11710
12065
|
/** Type of interface configuration */
|
|
11711
|
-
type?:
|
|
12066
|
+
type?: InterfaceConfigurationTypeWithLiterals;
|
|
11712
12067
|
}
|
|
11713
12068
|
/** @oneof */
|
|
11714
12069
|
export interface InterfaceConfigurationOfTypeOneOf {
|
|
@@ -11721,6 +12076,8 @@ export declare enum InterfaceConfigurationType {
|
|
|
11721
12076
|
/** Item Selection, in case the provider implemented item selection component */
|
|
11722
12077
|
ITEM_SELECTION = "ITEM_SELECTION"
|
|
11723
12078
|
}
|
|
12079
|
+
/** @enumType */
|
|
12080
|
+
export type InterfaceConfigurationTypeWithLiterals = InterfaceConfigurationType | 'WIDGET_COMPONENT' | 'ITEM_SELECTION';
|
|
11724
12081
|
export interface WidgetComponent {
|
|
11725
12082
|
/**
|
|
11726
12083
|
* widget component id
|
|
@@ -11752,6 +12109,8 @@ export declare enum Scope {
|
|
|
11752
12109
|
/** Provider audience is available only in scope of non specific site */
|
|
11753
12110
|
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
11754
12111
|
}
|
|
12112
|
+
/** @enumType */
|
|
12113
|
+
export type ScopeWithLiterals = Scope | 'SPECIFIC_SITE' | 'NON_SPECIFIC_SITE';
|
|
11755
12114
|
/** Config for the Price SPI */
|
|
11756
12115
|
export interface PriceSPIConfig {
|
|
11757
12116
|
/**
|
|
@@ -11828,7 +12187,7 @@ export interface EditorReactComponent {
|
|
|
11828
12187
|
* @replacedBy editor_element.archetype
|
|
11829
12188
|
* @targetRemovalDate 2026-06-30
|
|
11830
12189
|
*/
|
|
11831
|
-
archetype?:
|
|
12190
|
+
archetype?: ArchetypeWithLiterals;
|
|
11832
12191
|
}
|
|
11833
12192
|
export interface Resources {
|
|
11834
12193
|
/** The bundle we will load and render in the browser */
|
|
@@ -11904,13 +12263,13 @@ export interface EditorElement {
|
|
|
11904
12263
|
/** Layout capabilities of the component */
|
|
11905
12264
|
layout?: EditorElementLayout;
|
|
11906
12265
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
11907
|
-
archetype?:
|
|
12266
|
+
archetype?: ArchetypeWithLiterals;
|
|
11908
12267
|
}
|
|
11909
12268
|
export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSelectedCssPropertyTypeOneOf, StyleItemSelectedCssVariableTypeOneOf {
|
|
11910
12269
|
/** type selection key for css-properties */
|
|
11911
|
-
cssPropertyType?:
|
|
12270
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11912
12271
|
/** type selection key for css-data-types */
|
|
11913
|
-
cssVariableType?:
|
|
12272
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11914
12273
|
/** Additional options to refine the filter variable */
|
|
11915
12274
|
filter?: Filter;
|
|
11916
12275
|
/** Additional options to refine the backdropFilter variable */
|
|
@@ -11934,9 +12293,9 @@ export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSele
|
|
|
11934
12293
|
/** @oneof */
|
|
11935
12294
|
export interface StyleItemSelectedItemTypeOneOf {
|
|
11936
12295
|
/** type selection key for css-properties */
|
|
11937
|
-
cssPropertyType?:
|
|
12296
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11938
12297
|
/** type selection key for css-data-types */
|
|
11939
|
-
cssVariableType?:
|
|
12298
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11940
12299
|
}
|
|
11941
12300
|
/** @oneof */
|
|
11942
12301
|
export interface StyleItemSelectedCssPropertyTypeOneOf {
|
|
@@ -12070,6 +12429,8 @@ export declare enum CssPropertyType {
|
|
|
12070
12429
|
mixBlendMode = "mixBlendMode",
|
|
12071
12430
|
isolation = "isolation"
|
|
12072
12431
|
}
|
|
12432
|
+
/** @enumType */
|
|
12433
|
+
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';
|
|
12073
12434
|
/** The supported [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Types) in Javascript naming format */
|
|
12074
12435
|
export declare enum CssDataType {
|
|
12075
12436
|
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
@@ -12083,12 +12444,14 @@ export declare enum CssDataType {
|
|
|
12083
12444
|
customEnum = "customEnum",
|
|
12084
12445
|
string = "string"
|
|
12085
12446
|
}
|
|
12447
|
+
/** @enumType */
|
|
12448
|
+
export type CssDataTypeWithLiterals = CssDataType | 'UNKNOWN_CssDataType' | 'number' | 'length' | 'color' | 'angle' | 'percentage' | 'lengthPercentage' | 'blendMode' | 'customEnum' | 'string';
|
|
12086
12449
|
export interface Filter {
|
|
12087
12450
|
/**
|
|
12088
12451
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12089
12452
|
* @maxSize 100
|
|
12090
12453
|
*/
|
|
12091
|
-
filterFunctions?:
|
|
12454
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12092
12455
|
}
|
|
12093
12456
|
export declare enum FilterFunction {
|
|
12094
12457
|
UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
|
|
@@ -12113,19 +12476,21 @@ export declare enum FilterFunction {
|
|
|
12113
12476
|
/** The value used for saturate filter */
|
|
12114
12477
|
saturate = "saturate"
|
|
12115
12478
|
}
|
|
12479
|
+
/** @enumType */
|
|
12480
|
+
export type FilterFunctionWithLiterals = FilterFunction | 'UNKNOWN_FilterFunctions' | 'blur' | 'brightness' | 'contrast' | 'drop_shadow' | 'grayscale' | 'hue_rotate' | 'invert' | 'opacity' | 'sepia' | 'saturate';
|
|
12116
12481
|
export interface BackdropFilter {
|
|
12117
12482
|
/**
|
|
12118
12483
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12119
12484
|
* @maxSize 100
|
|
12120
12485
|
*/
|
|
12121
|
-
filterFunctions?:
|
|
12486
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12122
12487
|
}
|
|
12123
12488
|
export interface Display {
|
|
12124
12489
|
/**
|
|
12125
12490
|
* list of display values in case we want to reduce the abilities exposed to the User
|
|
12126
12491
|
* @maxSize 20
|
|
12127
12492
|
*/
|
|
12128
|
-
displayValues?:
|
|
12493
|
+
displayValues?: DisplayValueEnumDisplayValueWithLiterals[];
|
|
12129
12494
|
}
|
|
12130
12495
|
export declare enum DisplayValueEnumDisplayValue {
|
|
12131
12496
|
UNKNOWN_DisplayValue = "UNKNOWN_DisplayValue",
|
|
@@ -12144,12 +12509,14 @@ export declare enum DisplayValueEnumDisplayValue {
|
|
|
12144
12509
|
inline_flex = "inline_flex",
|
|
12145
12510
|
inline_grid = "inline_grid"
|
|
12146
12511
|
}
|
|
12512
|
+
/** @enumType */
|
|
12513
|
+
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';
|
|
12147
12514
|
export interface WritingMode {
|
|
12148
12515
|
/**
|
|
12149
12516
|
* list of writing-mode values in case we want to reduce the abilities exposed to the User
|
|
12150
12517
|
* @maxSize 20
|
|
12151
12518
|
*/
|
|
12152
|
-
writingModeValues?:
|
|
12519
|
+
writingModeValues?: WritingModeValueWithLiterals[];
|
|
12153
12520
|
}
|
|
12154
12521
|
export declare enum WritingModeValue {
|
|
12155
12522
|
UNKNOWN_WritingModeValue = "UNKNOWN_WritingModeValue",
|
|
@@ -12159,9 +12526,11 @@ export declare enum WritingModeValue {
|
|
|
12159
12526
|
sidewaysRl = "sidewaysRl",
|
|
12160
12527
|
sidewaysLr = "sidewaysLr"
|
|
12161
12528
|
}
|
|
12529
|
+
/** @enumType */
|
|
12530
|
+
export type WritingModeValueWithLiterals = WritingModeValue | 'UNKNOWN_WritingModeValue' | 'horizontalTb' | 'verticalRl' | 'verticalLr' | 'sidewaysRl' | 'sidewaysLr';
|
|
12162
12531
|
export interface CustomEnum {
|
|
12163
12532
|
/** the type of enum values */
|
|
12164
|
-
cssVariableType?:
|
|
12533
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
12165
12534
|
/**
|
|
12166
12535
|
* Editor-only: defines allowed values
|
|
12167
12536
|
* @maxSize 100
|
|
@@ -12215,7 +12584,7 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
12215
12584
|
/** A container in which to render another component */
|
|
12216
12585
|
container?: ReactElementContainer;
|
|
12217
12586
|
/** Defines the type of data we are configuring */
|
|
12218
|
-
dataType?:
|
|
12587
|
+
dataType?: DataTypeWithLiterals;
|
|
12219
12588
|
/**
|
|
12220
12589
|
* Display name of this data item
|
|
12221
12590
|
* @maxLength 100
|
|
@@ -12294,16 +12663,25 @@ export declare enum DataType {
|
|
|
12294
12663
|
/** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
|
|
12295
12664
|
direction = "direction"
|
|
12296
12665
|
}
|
|
12666
|
+
/** @enumType */
|
|
12667
|
+
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';
|
|
12297
12668
|
export interface Text {
|
|
12298
12669
|
/** Indicates maximum length allowed for the text */
|
|
12299
12670
|
maxLength?: number | null;
|
|
12300
12671
|
/** Indicates minimum length required for the text */
|
|
12301
12672
|
minLength?: number | null;
|
|
12302
12673
|
/**
|
|
12303
|
-
* A regex pattern that the text must comply with
|
|
12304
12674
|
* @maxLength 100
|
|
12675
|
+
* @deprecated
|
|
12676
|
+
* @replacedBy pattern
|
|
12677
|
+
* @targetRemovalDate 2026-06-30
|
|
12305
12678
|
*/
|
|
12306
12679
|
regexPattern?: string | null;
|
|
12680
|
+
/**
|
|
12681
|
+
* A regex pattern that the text must comply with
|
|
12682
|
+
* @maxLength 100
|
|
12683
|
+
*/
|
|
12684
|
+
pattern?: string | null;
|
|
12307
12685
|
}
|
|
12308
12686
|
export interface TextEnum {
|
|
12309
12687
|
/**
|
|
@@ -12337,7 +12715,7 @@ export interface A11y {
|
|
|
12337
12715
|
* A collection of attributes that will be stated in the manifest
|
|
12338
12716
|
* @maxSize 100
|
|
12339
12717
|
*/
|
|
12340
|
-
attributes?:
|
|
12718
|
+
attributes?: A11yAttributesWithLiterals[];
|
|
12341
12719
|
}
|
|
12342
12720
|
export declare enum A11yAttributes {
|
|
12343
12721
|
Unknown_AriaAttributes = "Unknown_AriaAttributes",
|
|
@@ -12392,12 +12770,14 @@ export declare enum A11yAttributes {
|
|
|
12392
12770
|
/** The value used for aria-invalid */
|
|
12393
12771
|
ariaInvalid = "ariaInvalid"
|
|
12394
12772
|
}
|
|
12773
|
+
/** @enumType */
|
|
12774
|
+
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';
|
|
12395
12775
|
export interface Link {
|
|
12396
12776
|
/**
|
|
12397
12777
|
* A collection of possible link types that the component supports. Only one of the types will make it to the component after input.
|
|
12398
12778
|
* @maxSize 12
|
|
12399
12779
|
*/
|
|
12400
|
-
linkTypes?:
|
|
12780
|
+
linkTypes?: LinkTypeWithLiterals[];
|
|
12401
12781
|
}
|
|
12402
12782
|
export declare enum LinkType {
|
|
12403
12783
|
UNKNOWN_LinkType = "UNKNOWN_LinkType",
|
|
@@ -12426,6 +12806,8 @@ export declare enum LinkType {
|
|
|
12426
12806
|
/** A link that directs the user to wix login dialog */
|
|
12427
12807
|
loginToWixLink = "loginToWixLink"
|
|
12428
12808
|
}
|
|
12809
|
+
/** @enumType */
|
|
12810
|
+
export type LinkTypeWithLiterals = LinkType | 'UNKNOWN_LinkType' | 'externalLink' | 'anchorLink' | 'emailLink' | 'phoneLink' | 'dynamicPageLink' | 'pageLink' | 'whatsAppLink' | 'documentLink' | 'popupLink' | 'addressLink' | 'edgeAnchorLinks' | 'loginToWixLink';
|
|
12429
12811
|
/** An array of data items or complex data types */
|
|
12430
12812
|
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
12431
12813
|
/** The definition of multiple data items in each item of the Array */
|
|
@@ -12467,7 +12849,7 @@ export interface ReactElementContainer extends ReactElementContainerSelectedCont
|
|
|
12467
12849
|
*/
|
|
12468
12850
|
selector?: string;
|
|
12469
12851
|
/** The type of Container to be rendered */
|
|
12470
|
-
containerType?:
|
|
12852
|
+
containerType?: ContainerTypeWithLiterals;
|
|
12471
12853
|
}
|
|
12472
12854
|
/** @oneof */
|
|
12473
12855
|
export interface ReactElementContainerSelectedContainerTypeOneOf {
|
|
@@ -12488,6 +12870,8 @@ export declare enum ContainerType {
|
|
|
12488
12870
|
/** A container to add elements targeting a specific product use case, exposed in DEV Center */
|
|
12489
12871
|
placeholder = "placeholder"
|
|
12490
12872
|
}
|
|
12873
|
+
/** @enumType */
|
|
12874
|
+
export type ContainerTypeWithLiterals = ContainerType | 'UNKNOWN_CONTAINER_TYPE' | 'simple' | 'slot' | 'placeholder';
|
|
12491
12875
|
/** Currently doesn't have any properties defined */
|
|
12492
12876
|
export interface SimpleContainer {
|
|
12493
12877
|
}
|
|
@@ -12511,7 +12895,7 @@ export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
|
12511
12895
|
/** A reference to the used element with overrides */
|
|
12512
12896
|
refElement?: RefElement;
|
|
12513
12897
|
/** Defines the type of element we are configuring */
|
|
12514
|
-
elementType?:
|
|
12898
|
+
elementType?: ElementTypeWithLiterals;
|
|
12515
12899
|
}
|
|
12516
12900
|
/** @oneof */
|
|
12517
12901
|
export interface ElementItemSelectedElementTypeOneOf {
|
|
@@ -12527,6 +12911,8 @@ export declare enum ElementType {
|
|
|
12527
12911
|
/** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
|
|
12528
12912
|
refElement = "refElement"
|
|
12529
12913
|
}
|
|
12914
|
+
/** @enumType */
|
|
12915
|
+
export type ElementTypeWithLiterals = ElementType | 'UNKNOWN_ElementType' | 'inlineElement' | 'refElement';
|
|
12530
12916
|
export interface InlineElement {
|
|
12531
12917
|
/**
|
|
12532
12918
|
* Relative DOM Query selector for this element. We assume nesting by it's parent elements for CSS Vars scoping.
|
|
@@ -12557,7 +12943,7 @@ export interface InlineElement {
|
|
|
12557
12943
|
/** The default preset, styles and data of inner elements */
|
|
12558
12944
|
elementsDefaults?: Record<string, ElementDefaults>;
|
|
12559
12945
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
12560
|
-
archetype?:
|
|
12946
|
+
archetype?: ArchetypeWithLiterals;
|
|
12561
12947
|
}
|
|
12562
12948
|
export interface Behaviors {
|
|
12563
12949
|
/** Determines if the inner-element can be selectable in the editor */
|
|
@@ -12602,7 +12988,7 @@ export interface Execution extends ExecutionActionExecuteOneOf {
|
|
|
12602
12988
|
/** Executes an action on a target element (based on path) */
|
|
12603
12989
|
forward?: ForwardAction;
|
|
12604
12990
|
/** The action type allows to determine the return type of the execution function */
|
|
12605
|
-
actionType?:
|
|
12991
|
+
actionType?: ActionTypeWithLiterals;
|
|
12606
12992
|
}
|
|
12607
12993
|
/** @oneof */
|
|
12608
12994
|
export interface ExecutionActionExecuteOneOf {
|
|
@@ -12625,6 +13011,8 @@ export declare enum ActionType {
|
|
|
12625
13011
|
forward = "forward",
|
|
12626
13012
|
style = "style"
|
|
12627
13013
|
}
|
|
13014
|
+
/** @enumType */
|
|
13015
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ActionType' | 'data' | 'event' | 'panel' | 'forward' | 'style';
|
|
12628
13016
|
/** Represents an action that interacts with a specific data item */
|
|
12629
13017
|
export interface DataAction {
|
|
12630
13018
|
/**
|
|
@@ -12660,7 +13048,7 @@ export interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
|
|
|
12660
13048
|
*/
|
|
12661
13049
|
panelId?: string;
|
|
12662
13050
|
/** The selected panel reference type */
|
|
12663
|
-
panelType?:
|
|
13051
|
+
panelType?: PanelTypeWithLiterals;
|
|
12664
13052
|
}
|
|
12665
13053
|
/** @oneof */
|
|
12666
13054
|
export interface PanelActionSelectedPanelTypeOneOf {
|
|
@@ -12675,6 +13063,8 @@ export declare enum PanelType {
|
|
|
12675
13063
|
UNKNOWN_PanelType = "UNKNOWN_PanelType",
|
|
12676
13064
|
panelId = "panelId"
|
|
12677
13065
|
}
|
|
13066
|
+
/** @enumType */
|
|
13067
|
+
export type PanelTypeWithLiterals = PanelType | 'UNKNOWN_PanelType' | 'panelId';
|
|
12678
13068
|
/** Represents an action that targets another element within the component */
|
|
12679
13069
|
export interface ForwardAction extends ForwardActionActionOneOf {
|
|
12680
13070
|
/**
|
|
@@ -12684,7 +13074,7 @@ export interface ForwardAction extends ForwardActionActionOneOf {
|
|
|
12684
13074
|
*/
|
|
12685
13075
|
custom?: string;
|
|
12686
13076
|
/** Specifies the action names (one of the natives or custom) */
|
|
12687
|
-
actionName?:
|
|
13077
|
+
actionName?: ActionNameWithLiterals;
|
|
12688
13078
|
/**
|
|
12689
13079
|
* Path to the target element
|
|
12690
13080
|
* @minLength 1
|
|
@@ -12716,6 +13106,8 @@ export declare enum ActionName {
|
|
|
12716
13106
|
/** actionName to be triggered from the defined custom actions */
|
|
12717
13107
|
custom = "custom"
|
|
12718
13108
|
}
|
|
13109
|
+
/** @enumType */
|
|
13110
|
+
export type ActionNameWithLiterals = ActionName | 'UNKNOWN_ActionName' | 'settings' | 'design' | 'media' | 'manageItems' | 'dashboard' | 'custom';
|
|
12719
13111
|
export interface DashboardAction {
|
|
12720
13112
|
/** Defines whether the action is being displayed */
|
|
12721
13113
|
hidden?: boolean | null;
|
|
@@ -12785,7 +13177,7 @@ export interface InitialSizeSetting extends InitialSizeSettingSelectedSizingType
|
|
|
12785
13177
|
*/
|
|
12786
13178
|
pixels?: number;
|
|
12787
13179
|
/** The initial size type */
|
|
12788
|
-
sizingType?:
|
|
13180
|
+
sizingType?: SizingTypeWithLiterals;
|
|
12789
13181
|
}
|
|
12790
13182
|
/** @oneof */
|
|
12791
13183
|
export interface InitialSizeSettingSelectedSizingTypeOneOf {
|
|
@@ -12804,6 +13196,8 @@ export declare enum SizingType {
|
|
|
12804
13196
|
/** Initial size should be set in pixels */
|
|
12805
13197
|
pixels = "pixels"
|
|
12806
13198
|
}
|
|
13199
|
+
/** @enumType */
|
|
13200
|
+
export type SizingTypeWithLiterals = SizingType | 'UNKNOWN_SizingType' | 'content' | 'stretched' | 'pixels';
|
|
12807
13201
|
export interface ElementDefaults {
|
|
12808
13202
|
/**
|
|
12809
13203
|
* The default preset for an element
|
|
@@ -12857,6 +13251,8 @@ export declare enum Archetype {
|
|
|
12857
13251
|
VectorArt = "VectorArt",
|
|
12858
13252
|
AnimatedGraphic = "AnimatedGraphic"
|
|
12859
13253
|
}
|
|
13254
|
+
/** @enumType */
|
|
13255
|
+
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';
|
|
12860
13256
|
export interface RefElement {
|
|
12861
13257
|
/**
|
|
12862
13258
|
* The type of the referenced element. Must exist in the Wix Dev Center and be fullly typed (`appSlug.componentType`).
|
|
@@ -12908,9 +13304,9 @@ export interface DataItemOverrides {
|
|
|
12908
13304
|
/** Top-level message containing all layout capabilities */
|
|
12909
13305
|
export interface EditorElementLayout {
|
|
12910
13306
|
/** The resizing capabilities this component can supports */
|
|
12911
|
-
resizeDirection?:
|
|
13307
|
+
resizeDirection?: ResizeDirectionWithLiterals;
|
|
12912
13308
|
/** Describes the ability of content to impact on the size of this component */
|
|
12913
|
-
contentResizeDirection?:
|
|
13309
|
+
contentResizeDirection?: ContentResizeDirectionWithLiterals;
|
|
12914
13310
|
/** Will control the availability of the stretch capability for this component */
|
|
12915
13311
|
disableStretching?: boolean | null;
|
|
12916
13312
|
/** Will control the availability of freely positioning this component */
|
|
@@ -12930,6 +13326,8 @@ export declare enum ResizeDirection {
|
|
|
12930
13326
|
/** Component cannot be resized in any direction */
|
|
12931
13327
|
none = "none"
|
|
12932
13328
|
}
|
|
13329
|
+
/** @enumType */
|
|
13330
|
+
export type ResizeDirectionWithLiterals = ResizeDirection | 'UNKNOWN_ResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'aspectRatio' | 'none';
|
|
12933
13331
|
export declare enum ContentResizeDirection {
|
|
12934
13332
|
/** Default value when content resize behavior is not specified */
|
|
12935
13333
|
UNKNOWN_ContentResizeDirection = "UNKNOWN_ContentResizeDirection",
|
|
@@ -12942,9 +13340,11 @@ export declare enum ContentResizeDirection {
|
|
|
12942
13340
|
/** Component's size will not be affected by its content */
|
|
12943
13341
|
none = "none"
|
|
12944
13342
|
}
|
|
13343
|
+
/** @enumType */
|
|
13344
|
+
export type ContentResizeDirectionWithLiterals = ContentResizeDirection | 'UNKNOWN_ContentResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'none';
|
|
12945
13345
|
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
12946
13346
|
/** Which static container should the component be installed at */
|
|
12947
|
-
staticContainer?:
|
|
13347
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12948
13348
|
/** Default presets per breakpoint with which the component should be installed */
|
|
12949
13349
|
presets?: DefaultPresets;
|
|
12950
13350
|
/** Initial size with which the component should be added to the stage */
|
|
@@ -12953,7 +13353,7 @@ export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
|
12953
13353
|
/** @oneof */
|
|
12954
13354
|
export interface InstallationInfoTargetContainerOneOf {
|
|
12955
13355
|
/** Which static container should the component be installed at */
|
|
12956
|
-
staticContainer?:
|
|
13356
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12957
13357
|
}
|
|
12958
13358
|
export interface MarketplaceSPIConfig {
|
|
12959
13359
|
/** URI where the SPI implementer is deployed */
|
|
@@ -12995,32 +13395,62 @@ export interface RewardProviderConfig {
|
|
|
12995
13395
|
export interface ProductRestrictionsConfig {
|
|
12996
13396
|
/** URI where the SPI Implementer is deployed */
|
|
12997
13397
|
deploymentUri?: SpiBaseUri;
|
|
12998
|
-
/**
|
|
13398
|
+
/** Product restrictions configuration. */
|
|
12999
13399
|
productRestrictionsConfig?: RestrictionsConfig;
|
|
13000
13400
|
}
|
|
13001
13401
|
export interface RestrictionsConfig {
|
|
13002
|
-
/**
|
|
13402
|
+
/**
|
|
13403
|
+
* Prices restrictions.
|
|
13404
|
+
*
|
|
13405
|
+
* Affected fields:
|
|
13406
|
+
* * `variantsInfo.variants.price.actualPrice.amount`
|
|
13407
|
+
* * `variantsInfo.variants.price.compareAtPrice.amount`
|
|
13408
|
+
* * `inventory.trackingMethod.quantity`
|
|
13409
|
+
*/
|
|
13003
13410
|
prices?: Restriction;
|
|
13004
|
-
/**
|
|
13411
|
+
/**
|
|
13412
|
+
* Options restrictions.
|
|
13413
|
+
*
|
|
13414
|
+
* Affected field: `options` (all nested fields except `linkedMedia`)
|
|
13415
|
+
*/
|
|
13005
13416
|
options?: Restriction;
|
|
13006
|
-
/**
|
|
13417
|
+
/**
|
|
13418
|
+
* Modifier restrictions.
|
|
13419
|
+
*
|
|
13420
|
+
* Affected field: `modifiers` (all nested fields except `linkedMedia`)
|
|
13421
|
+
*/
|
|
13007
13422
|
modifiers?: Restriction;
|
|
13008
|
-
/**
|
|
13423
|
+
/**
|
|
13424
|
+
* Inventory restrictions.
|
|
13425
|
+
*
|
|
13426
|
+
* Affected fields:
|
|
13427
|
+
* * `variantsInfo.variants.sku`
|
|
13428
|
+
* * `variantsInfo.variants.barcode`
|
|
13429
|
+
* * `inventory.trackingMethod.quantity`
|
|
13430
|
+
*/
|
|
13009
13431
|
inventory?: Restriction;
|
|
13010
|
-
/**
|
|
13432
|
+
/**
|
|
13433
|
+
* Pre order restrictions.
|
|
13434
|
+
*
|
|
13435
|
+
* Affected field: `inventory.preorderInfo`
|
|
13436
|
+
*/
|
|
13011
13437
|
preOrder?: Restriction;
|
|
13012
|
-
/**
|
|
13438
|
+
/** Whether to disallow product duplication or display a warning when duplicating a product. */
|
|
13013
13439
|
duplicateProduct?: Restriction;
|
|
13014
13440
|
}
|
|
13015
13441
|
export interface Restriction {
|
|
13016
|
-
/**
|
|
13017
|
-
restrictionLevel?:
|
|
13442
|
+
/** Restriction level. */
|
|
13443
|
+
restrictionLevel?: RestrictionLevelWithLiterals;
|
|
13018
13444
|
}
|
|
13019
13445
|
export declare enum RestrictionLevel {
|
|
13020
13446
|
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
13447
|
+
/** Users can edit the product field after acknowledging a warning modal. */
|
|
13021
13448
|
WARNING = "WARNING",
|
|
13449
|
+
/** Users **cannot** edit the product field. */
|
|
13022
13450
|
LOCKED = "LOCKED"
|
|
13023
13451
|
}
|
|
13452
|
+
/** @enumType */
|
|
13453
|
+
export type RestrictionLevelWithLiterals = RestrictionLevel | 'UNKNOWN_RESTRICTION_TYPE' | 'WARNING' | 'LOCKED';
|
|
13024
13454
|
export interface FormSubmissionModerationSpiConfig {
|
|
13025
13455
|
/** URI where the SPI Implementer is deployed */
|
|
13026
13456
|
deploymentUri?: SpiBaseUri;
|
|
@@ -13072,7 +13502,7 @@ export interface BackOfficeCustomization {
|
|
|
13072
13502
|
export interface Header extends HeaderConfigOneOf {
|
|
13073
13503
|
/** Only set if option == CUSTOMIZED */
|
|
13074
13504
|
customized?: HeaderConfig;
|
|
13075
|
-
displayOption?:
|
|
13505
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13076
13506
|
}
|
|
13077
13507
|
/** @oneof */
|
|
13078
13508
|
export interface HeaderConfigOneOf {
|
|
@@ -13084,6 +13514,8 @@ export declare enum ElementDisplayOption {
|
|
|
13084
13514
|
REMOVE = "REMOVE",
|
|
13085
13515
|
CUSTOMIZED = "CUSTOMIZED"
|
|
13086
13516
|
}
|
|
13517
|
+
/** @enumType */
|
|
13518
|
+
export type ElementDisplayOptionWithLiterals = ElementDisplayOption | 'UNKNOWN_OPTION' | 'REMOVE' | 'CUSTOMIZED';
|
|
13087
13519
|
/** Header configuration, you can provide extensionId or using our platform header */
|
|
13088
13520
|
export interface HeaderConfig extends HeaderConfigHeaderConfigOneOf {
|
|
13089
13521
|
platform?: PlatformHeaderConfig;
|
|
@@ -13164,7 +13596,7 @@ export interface HeaderWidgetConfig {
|
|
|
13164
13596
|
export interface Sidebar extends SidebarConfigOneOf {
|
|
13165
13597
|
/** Only set if option == CUSTOMIZED */
|
|
13166
13598
|
customized?: SidebarConfig;
|
|
13167
|
-
displayOption?:
|
|
13599
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13168
13600
|
}
|
|
13169
13601
|
/** @oneof */
|
|
13170
13602
|
export interface SidebarConfigOneOf {
|
|
@@ -13205,7 +13637,7 @@ export interface SidebarConfig {
|
|
|
13205
13637
|
export interface SidebarChildItem extends SidebarChildItemItemOneOf {
|
|
13206
13638
|
category?: SecondLevelCategory;
|
|
13207
13639
|
page?: Page;
|
|
13208
|
-
type?:
|
|
13640
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13209
13641
|
}
|
|
13210
13642
|
/** @oneof */
|
|
13211
13643
|
export interface SidebarChildItemItemOneOf {
|
|
@@ -13218,6 +13650,8 @@ export declare enum SidebarDataType {
|
|
|
13218
13650
|
PAGE = "PAGE",
|
|
13219
13651
|
SEPARATOR = "SEPARATOR"
|
|
13220
13652
|
}
|
|
13653
|
+
/** @enumType */
|
|
13654
|
+
export type SidebarDataTypeWithLiterals = SidebarDataType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'SEPARATOR';
|
|
13221
13655
|
/** Represents sidebar category of second level */
|
|
13222
13656
|
export interface SecondLevelCategory {
|
|
13223
13657
|
/**
|
|
@@ -13243,7 +13677,7 @@ export interface SecondLevelCategory {
|
|
|
13243
13677
|
*/
|
|
13244
13678
|
export interface SidebarSecondLevelChildItem extends SidebarSecondLevelChildItemItemOneOf {
|
|
13245
13679
|
page?: Page;
|
|
13246
|
-
type?:
|
|
13680
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13247
13681
|
}
|
|
13248
13682
|
/** @oneof */
|
|
13249
13683
|
export interface SidebarSecondLevelChildItemItemOneOf {
|
|
@@ -13289,7 +13723,7 @@ export interface SidebarWidgetConfig {
|
|
|
13289
13723
|
/** Root level sidebar item, can be category or separator (when not setting category) */
|
|
13290
13724
|
export interface SidebarRootItem extends SidebarRootItemItemOneOf {
|
|
13291
13725
|
category?: FirstLevelCategory;
|
|
13292
|
-
type?:
|
|
13726
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13293
13727
|
}
|
|
13294
13728
|
/** @oneof */
|
|
13295
13729
|
export interface SidebarRootItemItemOneOf {
|
|
@@ -13300,7 +13734,7 @@ export interface SidebarWidget extends SidebarWidgetConfigOneOf {
|
|
|
13300
13734
|
/** Only set if option == CUSTOMIZED */
|
|
13301
13735
|
customized?: SidebarWidgetConfig;
|
|
13302
13736
|
/** Widget display option */
|
|
13303
|
-
displayOption?:
|
|
13737
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13304
13738
|
}
|
|
13305
13739
|
/** @oneof */
|
|
13306
13740
|
export interface SidebarWidgetConfigOneOf {
|
|
@@ -13326,7 +13760,7 @@ export interface BackOfficeCustomizationSidebarEntity extends BackOfficeCustomiz
|
|
|
13326
13760
|
*/
|
|
13327
13761
|
appId?: string | null;
|
|
13328
13762
|
/** Sidebar entity type */
|
|
13329
|
-
type?:
|
|
13763
|
+
type?: SidebarEntityTypeWithLiterals;
|
|
13330
13764
|
}
|
|
13331
13765
|
/** @oneof */
|
|
13332
13766
|
export interface BackOfficeCustomizationSidebarEntityItemOneOf {
|
|
@@ -13354,6 +13788,8 @@ export declare enum SidebarEntityType {
|
|
|
13354
13788
|
PAGE = "PAGE",
|
|
13355
13789
|
APP = "APP"
|
|
13356
13790
|
}
|
|
13791
|
+
/** @enumType */
|
|
13792
|
+
export type SidebarEntityTypeWithLiterals = SidebarEntityType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'APP';
|
|
13357
13793
|
export interface CoreApps {
|
|
13358
13794
|
/**
|
|
13359
13795
|
* List of core appIds to include in the dashboard. Only appIds present in the host's coreAppId list are allowed.
|
|
@@ -13374,7 +13810,7 @@ export interface ComponentEnricherConfig {
|
|
|
13374
13810
|
* @minSize 1
|
|
13375
13811
|
* @maxSize 100
|
|
13376
13812
|
*/
|
|
13377
|
-
componentEnrichmentTypes?:
|
|
13813
|
+
componentEnrichmentTypes?: ComponentTypeWithLiterals[];
|
|
13378
13814
|
}
|
|
13379
13815
|
/** Back-office Restricted Customization */
|
|
13380
13816
|
export interface BackOfficeRestrictedCustomization {
|
|
@@ -13481,6 +13917,16 @@ export interface EventTimeSlotsProviderConfig {
|
|
|
13481
13917
|
*/
|
|
13482
13918
|
eventServiceIdField?: string | null;
|
|
13483
13919
|
}
|
|
13920
|
+
export interface AppEnvironmentProviderConfig {
|
|
13921
|
+
/** URI where the SPI implementer is deployed */
|
|
13922
|
+
deploymentUri?: SpiBaseUri;
|
|
13923
|
+
/**
|
|
13924
|
+
* `true` if SPI implementer provides custom permission checks API calls
|
|
13925
|
+
*
|
|
13926
|
+
* Default: `false`
|
|
13927
|
+
*/
|
|
13928
|
+
toggleIsAppEnvironmentPermitted?: boolean;
|
|
13929
|
+
}
|
|
13484
13930
|
export interface RuntimeComponentCacheEntityExperiment extends RuntimeComponentCacheEntityExperimentExperimentOneOf {
|
|
13485
13931
|
gradualRollout?: GradualRolloutCacheEntity;
|
|
13486
13932
|
gradualUpdate?: GradualUpdateCacheEntity;
|
|
@@ -13806,7 +14252,7 @@ export interface ListDataExtensionSchemasOptions {
|
|
|
13806
14252
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
13807
14253
|
* @maxSize 5
|
|
13808
14254
|
*/
|
|
13809
|
-
fields?:
|
|
14255
|
+
fields?: RequestedFieldWithLiterals[];
|
|
13810
14256
|
/**
|
|
13811
14257
|
* Extension points within the given entity.
|
|
13812
14258
|
* @maxSize 20
|