@wix/auto_sdk_data-extension-schema_schemas 1.0.23 → 1.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +673 -274
- 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 +682 -291
- package/build/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +673 -274
- 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 +682 -291
- package/build/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +673 -274
- 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 +682 -291
- package/build/internal/cjs/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.types.d.ts +673 -274
- 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 +682 -291
- package/build/internal/es/src/data-extensions-v1-data-extension-schema-schemas.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -122,30 +122,28 @@ export interface DataExtensionSchema {
|
|
|
122
122
|
}
|
|
123
123
|
export declare enum DataExtensionSchemaState {
|
|
124
124
|
}
|
|
125
|
+
/** @enumType */
|
|
126
|
+
export type DataExtensionSchemaStateWithLiterals = DataExtensionSchemaState;
|
|
125
127
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
126
128
|
createdEvent?: EntityCreatedEvent;
|
|
127
129
|
updatedEvent?: EntityUpdatedEvent;
|
|
128
130
|
deletedEvent?: EntityDeletedEvent;
|
|
129
131
|
actionEvent?: ActionEvent;
|
|
130
|
-
/**
|
|
131
|
-
* Unique event ID.
|
|
132
|
-
* Allows clients to ignore duplicate webhooks.
|
|
133
|
-
*/
|
|
132
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
134
133
|
id?: string;
|
|
135
134
|
/**
|
|
136
|
-
*
|
|
137
|
-
*
|
|
135
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
136
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
138
137
|
*/
|
|
139
138
|
entityFqdn?: string;
|
|
140
139
|
/**
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
140
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
141
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
144
142
|
*/
|
|
145
143
|
slug?: string;
|
|
146
144
|
/** ID of the entity associated with the event. */
|
|
147
145
|
entityId?: string;
|
|
148
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
146
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
149
147
|
eventTime?: Date | null;
|
|
150
148
|
/**
|
|
151
149
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -155,12 +153,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
155
153
|
/** If present, indicates the action that triggered the event. */
|
|
156
154
|
originatedFrom?: string | null;
|
|
157
155
|
/**
|
|
158
|
-
* A sequence number
|
|
159
|
-
*
|
|
160
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
161
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
162
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
163
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
156
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
157
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
164
158
|
*/
|
|
165
159
|
entityEventSequence?: string | null;
|
|
166
160
|
}
|
|
@@ -188,7 +182,7 @@ export interface EntityUpdatedEvent {
|
|
|
188
182
|
currentEntityAsJson?: string;
|
|
189
183
|
}
|
|
190
184
|
export interface EntityDeletedEvent {
|
|
191
|
-
/** Entity that was deleted */
|
|
185
|
+
/** Entity that was deleted. */
|
|
192
186
|
deletedEntityAsJson?: string | null;
|
|
193
187
|
}
|
|
194
188
|
export interface ActionEvent {
|
|
@@ -232,7 +226,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
232
226
|
*/
|
|
233
227
|
appId?: string;
|
|
234
228
|
/** @readonly */
|
|
235
|
-
identityType?:
|
|
229
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
236
230
|
}
|
|
237
231
|
/** @oneof */
|
|
238
232
|
export interface IdentificationDataIdOneOf {
|
|
@@ -264,6 +258,8 @@ export declare enum WebhookIdentityType {
|
|
|
264
258
|
WIX_USER = "WIX_USER",
|
|
265
259
|
APP = "APP"
|
|
266
260
|
}
|
|
261
|
+
/** @enumType */
|
|
262
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
267
263
|
export interface ReindexEvent {
|
|
268
264
|
/**
|
|
269
265
|
* fqdn of the dext schema that needs reindexing
|
|
@@ -317,7 +313,7 @@ export interface ListDataExtensionSchemasRequest {
|
|
|
317
313
|
* Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`.
|
|
318
314
|
* @maxSize 5
|
|
319
315
|
*/
|
|
320
|
-
fields?:
|
|
316
|
+
fields?: RequestedFieldWithLiterals[];
|
|
321
317
|
/**
|
|
322
318
|
* Extension points within the given entity.
|
|
323
319
|
* @maxSize 20
|
|
@@ -331,6 +327,8 @@ export declare enum RequestedField {
|
|
|
331
327
|
/** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
|
|
332
328
|
ARCHIVED = "ARCHIVED"
|
|
333
329
|
}
|
|
330
|
+
/** @enumType */
|
|
331
|
+
export type RequestedFieldWithLiterals = RequestedField | 'UNKNOWN_REQUESTED_FIELD' | 'ARCHIVED';
|
|
334
332
|
export interface ListDataExtensionSchemasResponse {
|
|
335
333
|
/** Requested schemas. */
|
|
336
334
|
dataExtensionSchemas?: DataExtensionSchema[];
|
|
@@ -361,7 +359,7 @@ export interface DeleteGlobalExtensionSchemaRequest {
|
|
|
361
359
|
*/
|
|
362
360
|
extensionPoint?: string;
|
|
363
361
|
/** state */
|
|
364
|
-
state?:
|
|
362
|
+
state?: DataExtensionSchemaStateWithLiterals;
|
|
365
363
|
}
|
|
366
364
|
export interface DeleteGlobalExtensionSchemaResponse {
|
|
367
365
|
}
|
|
@@ -409,7 +407,7 @@ export interface RuntimeComponentCacheEntityComponent {
|
|
|
409
407
|
*/
|
|
410
408
|
name?: string | null;
|
|
411
409
|
/** the type of the component */
|
|
412
|
-
type?:
|
|
410
|
+
type?: ComponentTypeWithLiterals;
|
|
413
411
|
/** the data of the component */
|
|
414
412
|
data?: ComponentData;
|
|
415
413
|
/** The external id of the component */
|
|
@@ -609,6 +607,8 @@ export declare enum ComponentType {
|
|
|
609
607
|
BACKEND_WORKER = "BACKEND_WORKER",
|
|
610
608
|
EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER = "EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER"
|
|
611
609
|
}
|
|
610
|
+
/** @enumType */
|
|
611
|
+
export type ComponentTypeWithLiterals = ComponentType | 'NONE' | 'STUDIO' | 'PLATFORM' | 'WORKER' | 'DASHBOARD' | 'WIDGET' | 'PAGE' | 'DASHBOARD_PLATFORM' | 'STUDIO_WIDGET' | 'EMBEDDED_SCRIPT' | 'EXTENSION' | 'SNIPPET_SOLUTION' | 'DATA_COMPONENT' | 'WEB' | 'DC_CONFIG' | 'WIDGET_OUT_OF_IFRAME' | 'PAGE_OUT_OF_IFRAME' | 'STATIC_FILE' | 'APP_CONFIG' | 'MULTIPLE_DASHBOARDS' | 'PAYMENTS_GATEWAY' | 'CODE_PACKAGE' | 'AUTOMATION_TRIGGER' | 'INVOICES_ACTIONS' | 'DASHBOARD_APPLICATION' | 'CONTACT_LABELS' | 'WIDGET_PLUGIN' | 'CROSS_SELL' | 'LOCAL_DELIVERY' | 'PAYMENT_PROVIDER' | 'ECOM_MEMBERSHIPS' | 'ECOM_LINE_ITEMS_ENRICHER' | 'ECOM_SHIPPING_RATES' | 'SHIPPING_LABEL_CARRIER' | 'RESTAURANTS_POS' | 'FICTIONAL_SHIPPING_PROVIDER' | 'ALERT_ENRICHER' | 'DATA_EXTENSIONS' | 'GENERIC_HOOKS' | 'AUTOMATIONS_ACTION_PROVIDER' | 'ECOM_CATALOG' | 'BACK_OFFICE_EXTENSION_CONTAINER' | 'BACK_OFFICE_EXTENSION' | 'AUTOMATIONS_TRIGGER_PROVIDER' | 'IDENTITY_PRE_REGISTRATION' | 'PREMIUM_PRODUCTS_PATHS' | 'ECOM_CUSTOM_SCOPE' | 'GIFT_CARDS_PROVIDER' | 'DEALER_EXTERNAL_FILTER_PROVIDER' | 'ECOM_DROPSHIPPING_PROVIDER' | 'INVOICES_PROVIDER' | 'SEO_KEYWORDS_SUGGESTIONS' | 'ECOM_DISCOUNTS_TRIGGER' | 'MULTILINGUAL_CONTENT_PROVIDER' | 'APPLICATION_AUTOMATION' | 'BACK_OFFICE_SIDEBAR_CATEGORY' | 'BACK_OFFICE_PAGE' | 'ECOM_ADDITIONAL_FEES' | 'PING_USER_NOTIFICATION' | 'ECOM_RECOMMENDATIONS_PROVIDER' | 'BOOKINGS_PRICING_PROVIDER' | 'IDENTITY_AUTHENTICATOR' | 'IDENTITY_IDP_CONNECTOR' | 'ITEMS_SELECTION_PROVIDER' | 'PORTFOLIO_SYNCED_PROJECTS_PROVIDER' | 'COMMUNICATION_CHANNEL' | 'IDENTITY_POST_LOGIN' | 'BACK_OFFICE_WIDGET' | 'SOCIAL_MARKETING_DESIGN' | 'FORMS_SUBMISSIONS_PROVIDER' | 'WIX_OFFERING' | 'DEV_CENTER_TESTING_COMPONENT' | 'COMPONENTS_VALIDATOR_PROVIDER' | 'COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER' | 'FORMS_SCHEMA_PROVIDER' | 'BOOKINGS_EXTERNAL_CALENDAR_PROVIDER' | 'ECOM_DEFAULT_TAXATION_CATEGORY' | 'VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER' | 'PING_UOU_NOTIFICATION' | 'HEADLESS_OAUTH' | 'ECOM_TAX_CALCULATOR_SPI' | 'COMMENTS_MODERATION_PROVIDER' | 'GRID_APP_FILES_TRANSFORMER' | 'BENEFIT_PROGRAMS_POLICY_PROVIDER' | 'PREMIUM_CUSTOM_CHARGES' | 'ECOM_VALIDATIONS' | 'COMPONENT_REFERENCE_DATA_PROVIDER' | 'WIX_REVIEWS_PRODUCT_CATALOG' | 'SOCIAL_MARKETING_DESIGNS_PROVIDER' | 'GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER' | 'COMMENTS_FILTER_PROVIDER' | 'BILLING_TAX_ID_VALIDATOR' | 'PING_SETTINGS_GROUP' | 'FORMS_SPAM_SUBMISSIONS_PROVIDER' | 'EDITOR_ADDON' | 'EXTERNAL_DATABASE_PROVIDER' | 'ECOM_PAYMENT_SETTINGS' | 'NOTIFICATION_TOPIC' | 'NOTIFICATION_PREFERENCES_FILTER_PROVIDER' | 'BOOKINGS_RESOURCE_TYPES_PROVIDER' | 'PRICING_PLANS_FORM_CONFIGURATION' | 'USER_NOTIFICATION' | 'CONTACT_NOTIFICATION' | 'UNIFIED_PAGE' | 'AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'PROPOSAL_EDITOR_PROVIDER' | 'CUSTOM_TABLE_RESERVATIONS_PROVIDER' | 'COMMENTS_CONTEXT_PROVIDER' | 'FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER' | 'AUTOMATIONS_VELO_ACTION_PROVIDER' | 'CALENDAR_EVENT_TYPE_PROVIDER' | 'RESERVED' | 'SMS_ACTION_MESSAGE' | 'BOOKING_POLICY_PROVIDER' | 'MULTI_SERVICE_BOOKING_POLICY_PROVIDER' | 'AI_ASSISTANT' | 'FORMS_SUBMISSIONS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA' | 'TAX_CALCULATION_PROVIDER' | 'TAX_GROUPS_PROVIDER' | 'BACK_OFFICE_MODAL' | 'DEPLOYMENT_PIPELINE_PROVIDER' | 'CUSTOM_ELEMENT_WIDGET' | 'BACK_OFFICE_EXTENSION_WIDGET' | 'BACK_OFFICE_EXTENSION_MENU_ITEM' | 'FORM_TEMPLATE' | 'NOTIFICATION_CONTENT' | 'BROADCAST_LIST' | 'PARTNERS_PAYOUTS' | 'WIX_REVIEWS_ENTITY_CATALOG' | 'VELO_PUBLISH_PIPELINE_TASK_PROVIDER' | 'FUNCTIONS_SHOP_PRICE_PROVIDER' | 'FUNCTION' | 'ECOM_CHECKOUT_CONTENT' | 'COMMUNICATION_CHANNEL_PROVIDER' | 'WEBHOOK' | 'TOPOLOGY' | 'LOYALTY_CUSTOM_REWARDS' | 'FUNCTION_RECIPE' | 'BACK_OFFICE_EXTERNAL_URL' | 'IDENTITY_FACTOR' | 'ECOM_DISCOUNTS' | 'VELO_CUSTOM_CSS' | 'DEALER_ADAPTIVE_COMPONENT_PROVIDER' | 'AI_ASSISTANT_ACTION' | 'ECOM_INVENTORY' | 'MONITORING' | 'PAPI_PROVIDER' | 'UNIFIED_LIGHTBOX' | 'FORMS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA_GROUP' | 'PANEL' | 'PREMIUM_PURCHASE_VALIDATIONS' | 'BROWSER_STORAGE' | 'SDK_DEFINITION' | 'SITE_WIDGET_SLOT' | 'CALENDAR_EVENT_VALIDATION_PROVIDER' | 'CLIENT_SIDE_SERVICE' | 'BILLING_SETTINGS' | 'PATTERNS_WIZARD' | 'APPLICATION_PROFILE' | 'TEXT_TO_SPEECH_ACTION_MESSAGE' | 'AUDIENCE_PROVIDER' | 'PRICING_PLANS_PRICE' | 'PRICING_PLAN_START_DATE_LIMITS' | 'PRICING_PLAN_START_DATE_RULES' | 'EVENTS_TICKET_RESERVATIONS' | 'PAYMENTS_DISPUTE_SERVICE_PLUGIN' | 'PRICING_PLANS_FEES' | 'EDITOR_REACT_COMPONENT' | 'SUPPLIERS_HUB_MARKETPLACE' | 'FORM_SCHEMA_DYNAMIC_VALUES' | 'BLOG_PAYWALL_PROVIDER' | 'LOYALTY_CUSTOM_REWARDS_V2' | 'STORES_PRODUCT_RESTRICTIONS' | 'FORM_SUBMISSION_MODERATION' | 'EVENTS_EVENT_BADGES' | 'BILLING_OPERATION' | 'BACK_OFFICE_CUSTOMIZATION' | 'COMPONENT_ENRICHER_PROVIDER' | 'BACK_OFFICE_RESTRICTED_CUSTOMIZATION' | 'EDITOR_APP_PREVIEWS_POC' | 'LEGENDS_PERSONA_CONFIGURATION' | 'WIX_HOSTING_APP_DEPLOYMENT_PROVIDER' | 'BACKEND_WORKER' | 'EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER';
|
|
612
612
|
/** Component data */
|
|
613
613
|
export interface ComponentData extends ComponentDataDataOneOf {
|
|
614
614
|
/**
|
|
@@ -812,7 +812,7 @@ export interface WidgetComponentData {
|
|
|
812
812
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
813
813
|
fixedPositionOption?: FixedPositionOptions;
|
|
814
814
|
/** Widget will automatically be stretched to this width after installing it */
|
|
815
|
-
widgetWidthType?:
|
|
815
|
+
widgetWidthType?: WidgetWidthTypeWithLiterals;
|
|
816
816
|
/**
|
|
817
817
|
* Widget width size
|
|
818
818
|
* @max 9999
|
|
@@ -895,9 +895,9 @@ export interface WidgetComponentData {
|
|
|
895
895
|
/** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
|
|
896
896
|
export interface FixedPositionOptions {
|
|
897
897
|
/** Vertical widget position in the browser window */
|
|
898
|
-
widgetVertical?:
|
|
898
|
+
widgetVertical?: WidgetVerticalWithLiterals;
|
|
899
899
|
/** Horizontal widget position in the browser window */
|
|
900
|
-
widgetHorizontal?:
|
|
900
|
+
widgetHorizontal?: WidgetHorizontalWithLiterals;
|
|
901
901
|
}
|
|
902
902
|
/** Vertical widget position in the browser window */
|
|
903
903
|
export declare enum WidgetVertical {
|
|
@@ -906,6 +906,8 @@ export declare enum WidgetVertical {
|
|
|
906
906
|
CENTER_VERTICAL = "CENTER_VERTICAL",
|
|
907
907
|
BOTTOM = "BOTTOM"
|
|
908
908
|
}
|
|
909
|
+
/** @enumType */
|
|
910
|
+
export type WidgetVerticalWithLiterals = WidgetVertical | 'NONE_VERTICAL' | 'TOP' | 'CENTER_VERTICAL' | 'BOTTOM';
|
|
909
911
|
/** Horizontal widget position in the browser window */
|
|
910
912
|
export declare enum WidgetHorizontal {
|
|
911
913
|
NONE_HORIZONTAL = "NONE_HORIZONTAL",
|
|
@@ -913,6 +915,8 @@ export declare enum WidgetHorizontal {
|
|
|
913
915
|
CENTER_HORIZONTAL = "CENTER_HORIZONTAL",
|
|
914
916
|
RIGHT = "RIGHT"
|
|
915
917
|
}
|
|
918
|
+
/** @enumType */
|
|
919
|
+
export type WidgetHorizontalWithLiterals = WidgetHorizontal | 'NONE_HORIZONTAL' | 'LEFT' | 'CENTER_HORIZONTAL' | 'RIGHT';
|
|
916
920
|
/** Widget will automatically be stretched to this width after installing it */
|
|
917
921
|
export declare enum WidgetWidthType {
|
|
918
922
|
NONE_TYPE = "NONE_TYPE",
|
|
@@ -921,6 +925,8 @@ export declare enum WidgetWidthType {
|
|
|
921
925
|
/** Full width of the browser window */
|
|
922
926
|
FULL = "FULL"
|
|
923
927
|
}
|
|
928
|
+
/** @enumType */
|
|
929
|
+
export type WidgetWidthTypeWithLiterals = WidgetWidthType | 'NONE_TYPE' | 'CUSTOM' | 'FULL';
|
|
924
930
|
export interface WidgetDisplay {
|
|
925
931
|
name?: string;
|
|
926
932
|
/**
|
|
@@ -936,7 +942,7 @@ export interface WidgetDisplay {
|
|
|
936
942
|
variationId?: string | null;
|
|
937
943
|
}
|
|
938
944
|
export interface Position {
|
|
939
|
-
region?:
|
|
945
|
+
region?: RegionWithLiterals;
|
|
940
946
|
}
|
|
941
947
|
export declare enum Region {
|
|
942
948
|
no_region = "no_region",
|
|
@@ -944,6 +950,8 @@ export declare enum Region {
|
|
|
944
950
|
pageContainer = "pageContainer",
|
|
945
951
|
footer = "footer"
|
|
946
952
|
}
|
|
953
|
+
/** @enumType */
|
|
954
|
+
export type RegionWithLiterals = Region | 'no_region' | 'header' | 'pageContainer' | 'footer';
|
|
947
955
|
export interface SubPage {
|
|
948
956
|
/** The path of the subpage */
|
|
949
957
|
key?: string;
|
|
@@ -971,7 +979,7 @@ export interface DisplayProperties {
|
|
|
971
979
|
left?: DisplayValue;
|
|
972
980
|
}
|
|
973
981
|
export interface DisplayValue {
|
|
974
|
-
type?:
|
|
982
|
+
type?: UnitTypeWithLiterals;
|
|
975
983
|
value?: number | null;
|
|
976
984
|
}
|
|
977
985
|
export declare enum UnitType {
|
|
@@ -982,14 +990,16 @@ export declare enum UnitType {
|
|
|
982
990
|
VW = "VW",
|
|
983
991
|
PERCENTAGE = "PERCENTAGE"
|
|
984
992
|
}
|
|
993
|
+
/** @enumType */
|
|
994
|
+
export type UnitTypeWithLiterals = UnitType | 'NO_UNIT' | 'AUTO' | 'PX' | 'VH' | 'VW' | 'PERCENTAGE';
|
|
985
995
|
export interface Docking {
|
|
986
996
|
desktop?: DockingProperties;
|
|
987
997
|
tablet?: DockingProperties;
|
|
988
998
|
mobile?: DockingProperties;
|
|
989
999
|
}
|
|
990
1000
|
export interface DockingProperties {
|
|
991
|
-
horizontal?:
|
|
992
|
-
vertical?:
|
|
1001
|
+
horizontal?: HorizontalDockingWithLiterals;
|
|
1002
|
+
vertical?: VerticalDockingWithLiterals;
|
|
993
1003
|
}
|
|
994
1004
|
export declare enum HorizontalDocking {
|
|
995
1005
|
NO_HDOCKING = "NO_HDOCKING",
|
|
@@ -997,12 +1007,16 @@ export declare enum HorizontalDocking {
|
|
|
997
1007
|
HCENTER = "HCENTER",
|
|
998
1008
|
RIGHT_DOCKING = "RIGHT_DOCKING"
|
|
999
1009
|
}
|
|
1010
|
+
/** @enumType */
|
|
1011
|
+
export type HorizontalDockingWithLiterals = HorizontalDocking | 'NO_HDOCKING' | 'LEFT_DOCKING' | 'HCENTER' | 'RIGHT_DOCKING';
|
|
1000
1012
|
export declare enum VerticalDocking {
|
|
1001
1013
|
NO_VDOCKING = "NO_VDOCKING",
|
|
1002
1014
|
TOP_DOCKING = "TOP_DOCKING",
|
|
1003
1015
|
VCENTER = "VCENTER",
|
|
1004
1016
|
BOTTOM_DOCKING = "BOTTOM_DOCKING"
|
|
1005
1017
|
}
|
|
1018
|
+
/** @enumType */
|
|
1019
|
+
export type VerticalDockingWithLiterals = VerticalDocking | 'NO_VDOCKING' | 'TOP_DOCKING' | 'VCENTER' | 'BOTTOM_DOCKING';
|
|
1006
1020
|
export interface Height {
|
|
1007
1021
|
desktop?: DisplayValue;
|
|
1008
1022
|
tablet?: DisplayValue;
|
|
@@ -1094,7 +1108,7 @@ export interface Padding {
|
|
|
1094
1108
|
export interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {
|
|
1095
1109
|
replacingOptions?: ReplacingOptions;
|
|
1096
1110
|
replaceableOptions?: ReplaceableOptions;
|
|
1097
|
-
type?:
|
|
1111
|
+
type?: ReplacementTypeWithLiterals;
|
|
1098
1112
|
}
|
|
1099
1113
|
/** @oneof */
|
|
1100
1114
|
export interface PageReplaceOptionsOptionsOneOf {
|
|
@@ -1118,6 +1132,8 @@ export declare enum ReplacementType {
|
|
|
1118
1132
|
REPLACING = "REPLACING",
|
|
1119
1133
|
REPLACEABLE = "REPLACEABLE"
|
|
1120
1134
|
}
|
|
1135
|
+
/** @enumType */
|
|
1136
|
+
export type ReplacementTypeWithLiterals = ReplacementType | 'UNKNOWN_REPLACEMENT' | 'REPLACING' | 'REPLACEABLE';
|
|
1121
1137
|
export interface ReplacingOptions {
|
|
1122
1138
|
/** describe the page and application id that this page will replace. */
|
|
1123
1139
|
pageReplace?: PageReplace;
|
|
@@ -1222,7 +1238,7 @@ export interface ApiSlot {
|
|
|
1222
1238
|
/** Role of the slot component (uniquely identifies slot within parent comp; used by Velo) - former "slotName" */
|
|
1223
1239
|
slotRole?: string;
|
|
1224
1240
|
/** The list of interfaces that should be implemented by a plugin in order to fit the slot */
|
|
1225
|
-
pluginInterfaces?:
|
|
1241
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
1226
1242
|
/** Id of the slot component (a.k.a. Velo role) */
|
|
1227
1243
|
slotId?: string;
|
|
1228
1244
|
}
|
|
@@ -1255,9 +1271,11 @@ export declare enum PluginInterface {
|
|
|
1255
1271
|
/** The slot requires the CART interface to be implemented by the plugin. The plugin specifies the implementation of the CART interface */
|
|
1256
1272
|
CART = "CART"
|
|
1257
1273
|
}
|
|
1274
|
+
/** @enumType */
|
|
1275
|
+
export type PluginInterfaceWithLiterals = PluginInterface | 'NONE_INTERFACE' | 'REVIEWS' | 'RATINGS_SUMMARY' | 'RATINGS_SUMMARY_OOI_LIST' | 'BOOKINGS_SERVICE' | 'BOOKINGS_FORM' | 'BASE' | 'EVENT' | 'PRODUCT' | 'CHECKOUT' | 'CATEGORY' | 'BOOKINGS_CALENDAR' | 'CART';
|
|
1258
1276
|
export interface ExtensionExposure {
|
|
1259
1277
|
/** Determines if the component is production ready */
|
|
1260
|
-
maturity?:
|
|
1278
|
+
maturity?: MaturityWithLiterals;
|
|
1261
1279
|
}
|
|
1262
1280
|
export declare enum Exposure {
|
|
1263
1281
|
/** Unexposed. to be used by dev team only */
|
|
@@ -1267,6 +1285,8 @@ export declare enum Exposure {
|
|
|
1267
1285
|
/** Exposed to the world */
|
|
1268
1286
|
PUBLIC = "PUBLIC"
|
|
1269
1287
|
}
|
|
1288
|
+
/** @enumType */
|
|
1289
|
+
export type ExposureWithLiterals = Exposure | 'PRIVATE' | 'INTERNAL' | 'PUBLIC';
|
|
1270
1290
|
export declare enum Maturity {
|
|
1271
1291
|
/** Immature. subject to breaking changes */
|
|
1272
1292
|
ALPHA = "ALPHA",
|
|
@@ -1277,6 +1297,8 @@ export declare enum Maturity {
|
|
|
1277
1297
|
/** Not yet implemented */
|
|
1278
1298
|
NOT_IMPLEMENTED = "NOT_IMPLEMENTED"
|
|
1279
1299
|
}
|
|
1300
|
+
/** @enumType */
|
|
1301
|
+
export type MaturityWithLiterals = Maturity | 'ALPHA' | 'BETA' | 'GA' | 'NOT_IMPLEMENTED';
|
|
1280
1302
|
/** A page out of iframe component that loads directly in the Editor DOM */
|
|
1281
1303
|
export interface PageOutOfIframeComponentData {
|
|
1282
1304
|
/**
|
|
@@ -1386,7 +1408,7 @@ export interface PlatfromComponentData {
|
|
|
1386
1408
|
/** dictates if the app has migrated to the new platform API */
|
|
1387
1409
|
migratedToNewPlatformApi?: boolean;
|
|
1388
1410
|
/** The HTTP Verb used to call the router, if not set will be POST */
|
|
1389
|
-
routerHttpMethod?:
|
|
1411
|
+
routerHttpMethod?: HTTPMethodWithLiterals;
|
|
1390
1412
|
}
|
|
1391
1413
|
/** Add interim support for HTTP methods before a bigger rewrite for Routers as a component */
|
|
1392
1414
|
export declare enum HTTPMethod {
|
|
@@ -1394,6 +1416,8 @@ export declare enum HTTPMethod {
|
|
|
1394
1416
|
GET = "GET",
|
|
1395
1417
|
POST = "POST"
|
|
1396
1418
|
}
|
|
1419
|
+
/** @enumType */
|
|
1420
|
+
export type HTTPMethodWithLiterals = HTTPMethod | 'UNKNOWN_METHOD' | 'GET' | 'POST';
|
|
1397
1421
|
/**
|
|
1398
1422
|
* An iframe that opens in the user’s Wix Dashboard,
|
|
1399
1423
|
* or add a link to open the page directly in your platform.
|
|
@@ -1571,7 +1595,7 @@ export interface InstallationSettings extends InstallationSettingsOptionsOneOf {
|
|
|
1571
1595
|
/** Extra options needed when `install_page` is set to `LIGHTBOX`. */
|
|
1572
1596
|
lightboxOptions?: LightboxOptions;
|
|
1573
1597
|
/** How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`. */
|
|
1574
|
-
installPage?:
|
|
1598
|
+
installPage?: InstallPageWithLiterals;
|
|
1575
1599
|
/** Controls whether to show or hide the widget in the add panel. */
|
|
1576
1600
|
showInAddPanel?: boolean | null;
|
|
1577
1601
|
/** Defines the main preset per breakpoint for the widget. */
|
|
@@ -1595,6 +1619,8 @@ export declare enum InstallPage {
|
|
|
1595
1619
|
/** Add widget to a new lightbox in the editor */
|
|
1596
1620
|
LIGHTBOX = "LIGHTBOX"
|
|
1597
1621
|
}
|
|
1622
|
+
/** @enumType */
|
|
1623
|
+
export type InstallPageWithLiterals = InstallPage | 'NO_PAGE' | 'CURRENT' | 'PAGE' | 'LIGHTBOX';
|
|
1598
1624
|
/** Defines the main preset per breakpoint for the widget. */
|
|
1599
1625
|
export interface MainPresets {
|
|
1600
1626
|
/** The main desktop preset. */
|
|
@@ -1692,7 +1718,7 @@ export interface HelpResources {
|
|
|
1692
1718
|
}
|
|
1693
1719
|
export interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
|
|
1694
1720
|
/** Which static container should the widget be installed at */
|
|
1695
|
-
staticContainer?:
|
|
1721
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1696
1722
|
/**
|
|
1697
1723
|
* Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
1698
1724
|
* @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
|
|
@@ -1713,7 +1739,7 @@ export interface WidgetInstallationSettings extends WidgetInstallationSettingsTa
|
|
|
1713
1739
|
/** @oneof */
|
|
1714
1740
|
export interface WidgetInstallationSettingsTargetContainerOneOf {
|
|
1715
1741
|
/** Which static container should the widget be installed at */
|
|
1716
|
-
staticContainer?:
|
|
1742
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
1717
1743
|
}
|
|
1718
1744
|
export interface BaseInstallation {
|
|
1719
1745
|
/** Auto add component to stage */
|
|
@@ -1727,13 +1753,15 @@ export interface WidgetInstallation {
|
|
|
1727
1753
|
/** Preset should be selected defaultly with installation */
|
|
1728
1754
|
defaultPreset?: MainPresets;
|
|
1729
1755
|
/** Region of widget */
|
|
1730
|
-
region?:
|
|
1756
|
+
region?: RegionTypeWithLiterals;
|
|
1731
1757
|
}
|
|
1732
1758
|
export declare enum RegionType {
|
|
1733
1759
|
HEADER = "HEADER",
|
|
1734
1760
|
BODY = "BODY",
|
|
1735
1761
|
FOOTER = "FOOTER"
|
|
1736
1762
|
}
|
|
1763
|
+
/** @enumType */
|
|
1764
|
+
export type RegionTypeWithLiterals = RegionType | 'HEADER' | 'BODY' | 'FOOTER';
|
|
1737
1765
|
export interface DefaultPresets {
|
|
1738
1766
|
/**
|
|
1739
1767
|
* Default preset ID in small (mobile) breakpoint
|
|
@@ -1753,6 +1781,8 @@ export declare enum StaticContainer {
|
|
|
1753
1781
|
/** Widget should be installed in the homepage */
|
|
1754
1782
|
HOMEPAGE = "HOMEPAGE"
|
|
1755
1783
|
}
|
|
1784
|
+
/** @enumType */
|
|
1785
|
+
export type StaticContainerWithLiterals = StaticContainer | 'UNKNOWN_CONTAINER' | 'HOMEPAGE';
|
|
1756
1786
|
export interface ComponentModel {
|
|
1757
1787
|
/** The component type of the builder component. */
|
|
1758
1788
|
componentType?: string;
|
|
@@ -1791,13 +1821,13 @@ export interface EmbeddedScriptComponentData {
|
|
|
1791
1821
|
/** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */
|
|
1792
1822
|
name?: string;
|
|
1793
1823
|
/** What category of pages this will be embedded on (single, many, none) */
|
|
1794
|
-
pages?:
|
|
1824
|
+
pages?: EmbeddedScriptPagesWithLiterals;
|
|
1795
1825
|
/** Where in the HTML this should be embedded */
|
|
1796
|
-
placement?:
|
|
1826
|
+
placement?: EmbeddedScriptPlacementWithLiterals;
|
|
1797
1827
|
/** An article explaining how to activate the script */
|
|
1798
1828
|
connectArticleUrl?: string;
|
|
1799
1829
|
/** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */
|
|
1800
|
-
embedCategory?:
|
|
1830
|
+
embedCategory?: EmbedCategoryWithLiterals;
|
|
1801
1831
|
/**
|
|
1802
1832
|
* if the script should be loaded once - default and only supported value is true
|
|
1803
1833
|
* @readonly
|
|
@@ -1820,6 +1850,8 @@ export declare enum EmbeddedScriptPages {
|
|
|
1820
1850
|
/** It will be embedded multiple times on specific pages */
|
|
1821
1851
|
SPECIFIC_PAGES = "SPECIFIC_PAGES"
|
|
1822
1852
|
}
|
|
1853
|
+
/** @enumType */
|
|
1854
|
+
export type EmbeddedScriptPagesWithLiterals = EmbeddedScriptPages | 'NONE_PAGES' | 'ONCE' | 'SPECIFIC_PAGES';
|
|
1823
1855
|
/** Where that embed will be rendered */
|
|
1824
1856
|
export declare enum EmbeddedScriptPlacement {
|
|
1825
1857
|
/** It will not be rendered */
|
|
@@ -1831,6 +1863,8 @@ export declare enum EmbeddedScriptPlacement {
|
|
|
1831
1863
|
/** Appended after the last child already rendered in the body tag */
|
|
1832
1864
|
BODY_END = "BODY_END"
|
|
1833
1865
|
}
|
|
1866
|
+
/** @enumType */
|
|
1867
|
+
export type EmbeddedScriptPlacementWithLiterals = EmbeddedScriptPlacement | 'NONE_PLACEMENT' | 'HEAD' | 'BODY_START' | 'BODY_END';
|
|
1834
1868
|
/** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */
|
|
1835
1869
|
export declare enum EmbedCategory {
|
|
1836
1870
|
/** Not categorized yet */
|
|
@@ -1844,6 +1878,8 @@ export declare enum EmbedCategory {
|
|
|
1844
1878
|
/** Adds advertising content or advertising tracking to the site */
|
|
1845
1879
|
ADVERTISING = "ADVERTISING"
|
|
1846
1880
|
}
|
|
1881
|
+
/** @enumType */
|
|
1882
|
+
export type EmbedCategoryWithLiterals = EmbedCategory | 'UNKNOWN' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING';
|
|
1847
1883
|
export interface WixDependency {
|
|
1848
1884
|
/**
|
|
1849
1885
|
* The fully qualified package name from npm, example: @wix/frontend-location
|
|
@@ -1879,7 +1915,7 @@ export interface WebComponentData {
|
|
|
1879
1915
|
/** Dynamic settings(Graphic Floating Properties Panel settings) */
|
|
1880
1916
|
gfppSettings?: Settings;
|
|
1881
1917
|
/** Custom element type PAGE / WIDGET */
|
|
1882
|
-
type?:
|
|
1918
|
+
type?: WebComponentDataElementTypeWithLiterals;
|
|
1883
1919
|
/** Boolean to make this component be available for free sites */
|
|
1884
1920
|
allowedForFreeSite?: boolean;
|
|
1885
1921
|
/**
|
|
@@ -1894,7 +1930,7 @@ export interface WebComponentData {
|
|
|
1894
1930
|
/** The details of the selected widget to add */
|
|
1895
1931
|
widget?: WidgetDetails;
|
|
1896
1932
|
/** Give the option to change the script type */
|
|
1897
|
-
scriptType?:
|
|
1933
|
+
scriptType?: ScriptTypeWithLiterals;
|
|
1898
1934
|
/** Web component default mobile height */
|
|
1899
1935
|
defaultMobileHeight?: number | null;
|
|
1900
1936
|
/** Prevent the deletion of the widget when set to true. */
|
|
@@ -2051,7 +2087,7 @@ export interface SingleKeyCondition {
|
|
|
2051
2087
|
/** ColorSelectLabeled 13 */
|
|
2052
2088
|
export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
2053
2089
|
customColor?: ColorDefinition;
|
|
2054
|
-
templateColor?:
|
|
2090
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2055
2091
|
title?: string;
|
|
2056
2092
|
key?: string;
|
|
2057
2093
|
/** @deprecated */
|
|
@@ -2062,7 +2098,7 @@ export interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {
|
|
|
2062
2098
|
/** @oneof */
|
|
2063
2099
|
export interface ColorSelectLabeledDataOneOf {
|
|
2064
2100
|
customColor?: ColorDefinition;
|
|
2065
|
-
templateColor?:
|
|
2101
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2066
2102
|
}
|
|
2067
2103
|
export interface ColorDefinition {
|
|
2068
2104
|
value?: string;
|
|
@@ -2075,13 +2111,15 @@ export declare enum TemplateDefaultColor {
|
|
|
2075
2111
|
BORDERS_AND_DIVIDERS = "BORDERS_AND_DIVIDERS",
|
|
2076
2112
|
BUTTONS_AND_LINKS = "BUTTONS_AND_LINKS"
|
|
2077
2113
|
}
|
|
2114
|
+
/** @enumType */
|
|
2115
|
+
export type TemplateDefaultColorWithLiterals = TemplateDefaultColor | 'BACKGROUND' | 'SECONDARY_TEXTS' | 'MAIN_TEXT_AND_ICONS' | 'BORDERS_AND_DIVIDERS' | 'BUTTONS_AND_LINKS';
|
|
2078
2116
|
/** Thumbnails 4 */
|
|
2079
2117
|
export interface Thumbnails {
|
|
2080
2118
|
key?: string;
|
|
2081
2119
|
title?: string;
|
|
2082
2120
|
value?: string;
|
|
2083
2121
|
options?: ThumbnailData[];
|
|
2084
|
-
size?:
|
|
2122
|
+
size?: ThumbnailsSizeWithLiterals;
|
|
2085
2123
|
description?: string;
|
|
2086
2124
|
conditions?: Condition[];
|
|
2087
2125
|
}
|
|
@@ -2102,6 +2140,8 @@ export declare enum ThumbnailsSize {
|
|
|
2102
2140
|
LARGE = "LARGE",
|
|
2103
2141
|
XLARGE = "XLARGE"
|
|
2104
2142
|
}
|
|
2143
|
+
/** @enumType */
|
|
2144
|
+
export type ThumbnailsSizeWithLiterals = ThumbnailsSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE';
|
|
2105
2145
|
/** SliderLabeled 5 */
|
|
2106
2146
|
export interface SliderLabeled {
|
|
2107
2147
|
key?: string;
|
|
@@ -2135,11 +2175,11 @@ export interface ToggleLabeled {
|
|
|
2135
2175
|
*/
|
|
2136
2176
|
export interface BarAlignment {
|
|
2137
2177
|
/** @deprecated */
|
|
2138
|
-
selected?:
|
|
2178
|
+
selected?: BarAlignmentSelectedWithLiterals;
|
|
2139
2179
|
key?: string;
|
|
2140
2180
|
title?: string;
|
|
2141
2181
|
description?: string;
|
|
2142
|
-
value?:
|
|
2182
|
+
value?: BarAlignmentSelectedWithLiterals;
|
|
2143
2183
|
conditions?: Condition[];
|
|
2144
2184
|
}
|
|
2145
2185
|
/** Bar alignment selected value */
|
|
@@ -2148,6 +2188,8 @@ export declare enum BarAlignmentSelected {
|
|
|
2148
2188
|
ALIGN_CENTER = "ALIGN_CENTER",
|
|
2149
2189
|
ALIGN_RIGHT = "ALIGN_RIGHT"
|
|
2150
2190
|
}
|
|
2191
|
+
/** @enumType */
|
|
2192
|
+
export type BarAlignmentSelectedWithLiterals = BarAlignmentSelected | 'ALIGN_LEFT' | 'ALIGN_CENTER' | 'ALIGN_RIGHT';
|
|
2151
2193
|
/** TextInputLabeled 9 */
|
|
2152
2194
|
export interface TextInputLabeled {
|
|
2153
2195
|
key?: string;
|
|
@@ -2172,22 +2214,24 @@ export interface FontDefinition {
|
|
|
2172
2214
|
/** TextStyle 14 */
|
|
2173
2215
|
export interface TextStyle extends TextStyleDefaultColorOneOf {
|
|
2174
2216
|
customColor?: ColorDefinition;
|
|
2175
|
-
templateColor?:
|
|
2217
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2176
2218
|
key?: string;
|
|
2177
2219
|
title?: string;
|
|
2178
2220
|
description?: string;
|
|
2179
|
-
defaultTextStyle?:
|
|
2221
|
+
defaultTextStyle?: DefaultTextStyleWithLiterals;
|
|
2180
2222
|
}
|
|
2181
2223
|
/** @oneof */
|
|
2182
2224
|
export interface TextStyleDefaultColorOneOf {
|
|
2183
2225
|
customColor?: ColorDefinition;
|
|
2184
|
-
templateColor?:
|
|
2226
|
+
templateColor?: TemplateDefaultColorWithLiterals;
|
|
2185
2227
|
}
|
|
2186
2228
|
export declare enum DefaultTextStyle {
|
|
2187
2229
|
TITLE = "TITLE",
|
|
2188
2230
|
PARAGRAPH = "PARAGRAPH",
|
|
2189
2231
|
LOWER_HIERARCHY_TEXTS = "LOWER_HIERARCHY_TEXTS"
|
|
2190
2232
|
}
|
|
2233
|
+
/** @enumType */
|
|
2234
|
+
export type DefaultTextStyleWithLiterals = DefaultTextStyle | 'TITLE' | 'PARAGRAPH' | 'LOWER_HIERARCHY_TEXTS';
|
|
2191
2235
|
/** 10 */
|
|
2192
2236
|
export interface ResetButton {
|
|
2193
2237
|
label?: string;
|
|
@@ -2196,6 +2240,8 @@ export declare enum WebComponentDataElementType {
|
|
|
2196
2240
|
WIDGET = "WIDGET",
|
|
2197
2241
|
PAGE = "PAGE"
|
|
2198
2242
|
}
|
|
2243
|
+
/** @enumType */
|
|
2244
|
+
export type WebComponentDataElementTypeWithLiterals = WebComponentDataElementType | 'WIDGET' | 'PAGE';
|
|
2199
2245
|
export interface WidgetDetails {
|
|
2200
2246
|
name?: string | null;
|
|
2201
2247
|
icon?: string | null;
|
|
@@ -2205,6 +2251,8 @@ export declare enum ScriptType {
|
|
|
2205
2251
|
NO_SCRIPT_TYPE = "NO_SCRIPT_TYPE",
|
|
2206
2252
|
MODULE = "MODULE"
|
|
2207
2253
|
}
|
|
2254
|
+
/** @enumType */
|
|
2255
|
+
export type ScriptTypeWithLiterals = ScriptType | 'NO_SCRIPT_TYPE' | 'MODULE';
|
|
2208
2256
|
export interface WidgetBehavior {
|
|
2209
2257
|
/** Toggle whether the widget is removable from the page. */
|
|
2210
2258
|
removable?: boolean;
|
|
@@ -2213,7 +2261,7 @@ export interface WidgetBehavior {
|
|
|
2213
2261
|
}
|
|
2214
2262
|
export interface ExtensionData {
|
|
2215
2263
|
data?: string;
|
|
2216
|
-
extensionType?:
|
|
2264
|
+
extensionType?: ExtensionTypeWithLiterals;
|
|
2217
2265
|
}
|
|
2218
2266
|
export declare enum ExtensionType {
|
|
2219
2267
|
NONE_EXTENSION = "NONE_EXTENSION",
|
|
@@ -2228,6 +2276,8 @@ export declare enum ExtensionType {
|
|
|
2228
2276
|
ASCEND_AUTOMATION_EXTENSION = "ASCEND_AUTOMATION_EXTENSION",
|
|
2229
2277
|
CONTACT_LABELS_EXTENSION = "CONTACT_LABELS_EXTENSION"
|
|
2230
2278
|
}
|
|
2279
|
+
/** @enumType */
|
|
2280
|
+
export type ExtensionTypeWithLiterals = ExtensionType | 'NONE_EXTENSION' | 'PAYMENTS_GATEWAY_EXTENSION' | 'COUPONS_EXTENSION' | 'DROPSHIPPING_EXTENSION' | 'FULFILMENT_EXTENSION' | 'DROPSHIPPING_SUPPLIER_EXTENSION' | 'FULFILLMENT_CENTER_EXTENSION' | 'RESTAURANTS_POS_EXTENSION' | 'ART_STORE_EXTENSION' | 'ASCEND_AUTOMATION_EXTENSION' | 'CONTACT_LABELS_EXTENSION';
|
|
2231
2281
|
export interface SnippetSolutionData {
|
|
2232
2282
|
code?: string;
|
|
2233
2283
|
instructions?: string;
|
|
@@ -2318,7 +2368,7 @@ export interface SchemaField {
|
|
|
2318
2368
|
/** Sample values, values that could show up in the payload of a trigger. */
|
|
2319
2369
|
sampleValues?: string[];
|
|
2320
2370
|
/** The field exposure */
|
|
2321
|
-
exposure?:
|
|
2371
|
+
exposure?: SchemaFieldExposureWithLiterals;
|
|
2322
2372
|
}
|
|
2323
2373
|
export declare enum PrimitiveType {
|
|
2324
2374
|
UNKNOWN_PRIMITIVE_TYPE = "UNKNOWN_PRIMITIVE_TYPE",
|
|
@@ -2326,6 +2376,8 @@ export declare enum PrimitiveType {
|
|
|
2326
2376
|
BOOLEAN = "BOOLEAN",
|
|
2327
2377
|
NUMBER = "NUMBER"
|
|
2328
2378
|
}
|
|
2379
|
+
/** @enumType */
|
|
2380
|
+
export type PrimitiveTypeWithLiterals = PrimitiveType | 'UNKNOWN_PRIMITIVE_TYPE' | 'TEXT' | 'BOOLEAN' | 'NUMBER';
|
|
2329
2381
|
export declare enum SimpleType {
|
|
2330
2382
|
UNKNOWN_SIMPLE_TYPE = "UNKNOWN_SIMPLE_TYPE",
|
|
2331
2383
|
MONEY = "MONEY",
|
|
@@ -2339,11 +2391,13 @@ export declare enum SimpleType {
|
|
|
2339
2391
|
PHONE = "PHONE",
|
|
2340
2392
|
CONTACT_ID = "CONTACT_ID"
|
|
2341
2393
|
}
|
|
2394
|
+
/** @enumType */
|
|
2395
|
+
export type SimpleTypeWithLiterals = SimpleType | 'UNKNOWN_SIMPLE_TYPE' | 'MONEY' | 'LINK' | 'BACKOFFICE_LINK' | 'LIVESITE_LINK' | 'MULTILINGUAL' | 'IMAGE_LINK' | 'GUID' | 'EMAIL' | 'PHONE' | 'CONTACT_ID';
|
|
2342
2396
|
export interface Primitive {
|
|
2343
|
-
primitiveType?:
|
|
2397
|
+
primitiveType?: PrimitiveTypeWithLiterals;
|
|
2344
2398
|
}
|
|
2345
2399
|
export interface Simple {
|
|
2346
|
-
simpleType?:
|
|
2400
|
+
simpleType?: SimpleTypeWithLiterals;
|
|
2347
2401
|
}
|
|
2348
2402
|
export interface _Date {
|
|
2349
2403
|
/** Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date */
|
|
@@ -2377,10 +2431,12 @@ export declare enum SchemaFieldExposure {
|
|
|
2377
2431
|
/** Sent to the action provider and usually shown to user */
|
|
2378
2432
|
EXPOSED = "EXPOSED"
|
|
2379
2433
|
}
|
|
2434
|
+
/** @enumType */
|
|
2435
|
+
export type SchemaFieldExposureWithLiterals = SchemaFieldExposure | 'UNKNOWN_EXPOSURE' | 'SETUP' | 'HIDDEN' | 'EXPOSED';
|
|
2380
2436
|
/** represents Invoices integration policies */
|
|
2381
2437
|
export interface InvoicesActionsComponentData {
|
|
2382
2438
|
/** partial payment restriction on invoice */
|
|
2383
|
-
partialPayment?:
|
|
2439
|
+
partialPayment?: PartialPaymentRestrictionWithLiterals;
|
|
2384
2440
|
}
|
|
2385
2441
|
/** Possible Partial Payment Policy Values */
|
|
2386
2442
|
export declare enum PartialPaymentRestriction {
|
|
@@ -2390,6 +2446,8 @@ export declare enum PartialPaymentRestriction {
|
|
|
2390
2446
|
/** Disallow Partial Payment */
|
|
2391
2447
|
DISALLOW = "DISALLOW"
|
|
2392
2448
|
}
|
|
2449
|
+
/** @enumType */
|
|
2450
|
+
export type PartialPaymentRestrictionWithLiterals = PartialPaymentRestriction | 'UNDEFINED' | 'ALLOW' | 'DISALLOW';
|
|
2393
2451
|
/** Experimental-WIP: Specifies the app module configuration of business manager module */
|
|
2394
2452
|
export interface DashboardApplicationData {
|
|
2395
2453
|
/**
|
|
@@ -2485,7 +2543,7 @@ export interface HostedComponent {
|
|
|
2485
2543
|
/** Permissions required for the component, this is not strictly enforced */
|
|
2486
2544
|
requiredPermission?: string;
|
|
2487
2545
|
/** Represents the collection of components where the component will be hosted, get this value from the host provider. */
|
|
2488
|
-
hostContainerId?:
|
|
2546
|
+
hostContainerId?: HostContainerIdWithLiterals;
|
|
2489
2547
|
/** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope */
|
|
2490
2548
|
enabledByExperiments?: ExperimentGroupWrapper[];
|
|
2491
2549
|
/** A URI used to send component error events */
|
|
@@ -2496,6 +2554,8 @@ export declare enum HostContainerId {
|
|
|
2496
2554
|
BUSINESS_DASHBOARD_HOST = "BUSINESS_DASHBOARD_HOST",
|
|
2497
2555
|
SIDEBAR_FOOTER = "SIDEBAR_FOOTER"
|
|
2498
2556
|
}
|
|
2557
|
+
/** @enumType */
|
|
2558
|
+
export type HostContainerIdWithLiterals = HostContainerId | 'BUSINESS_MANAGER' | 'BUSINESS_DASHBOARD_HOST' | 'SIDEBAR_FOOTER';
|
|
2499
2559
|
/** Contact Labels Extensions */
|
|
2500
2560
|
export interface ContactLabelsComponentData {
|
|
2501
2561
|
/** Whether apps can create labels in this namespace. */
|
|
@@ -2533,7 +2593,7 @@ export interface WidgetPluginComponentData {
|
|
|
2533
2593
|
*/
|
|
2534
2594
|
referenceComponentId?: string;
|
|
2535
2595
|
/** APIs implemented by the Plugin's widget. */
|
|
2536
|
-
pluginInterfaces?:
|
|
2596
|
+
pluginInterfaces?: PluginInterfaceWithLiterals[];
|
|
2537
2597
|
/** Marketing information about the plugin. */
|
|
2538
2598
|
marketData?: PluginMarketData;
|
|
2539
2599
|
/** List of placements where the plugin is allowed to be installed. */
|
|
@@ -2633,7 +2693,7 @@ export interface HostedPage {
|
|
|
2633
2693
|
/** Url to images in different formats and colors */
|
|
2634
2694
|
logos?: Logos;
|
|
2635
2695
|
/** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */
|
|
2636
|
-
billingAddressMandatoryFields?:
|
|
2696
|
+
billingAddressMandatoryFields?: MandatoryFieldWithLiterals[];
|
|
2637
2697
|
}
|
|
2638
2698
|
export interface Logos {
|
|
2639
2699
|
/** white theme logos */
|
|
@@ -2667,6 +2727,8 @@ export declare enum MandatoryField {
|
|
|
2667
2727
|
HOUSE_NUMBER = "HOUSE_NUMBER",
|
|
2668
2728
|
TAX_IDENTIFIER = "TAX_IDENTIFIER"
|
|
2669
2729
|
}
|
|
2730
|
+
/** @enumType */
|
|
2731
|
+
export type MandatoryFieldWithLiterals = MandatoryField | 'ZIPCODE' | 'CITY' | 'STATE' | 'ADDRESS' | 'COUNTRY_CODE' | 'EMAIL' | 'PHONE' | 'FIRST_NAME' | 'LAST_NAME' | 'STREET' | 'HOUSE_NUMBER' | 'TAX_IDENTIFIER';
|
|
2670
2732
|
export interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {
|
|
2671
2733
|
/** text field */
|
|
2672
2734
|
simpleField?: SimpleField;
|
|
@@ -2813,7 +2875,7 @@ export interface ShippingLabelCarrierSpiConfig {
|
|
|
2813
2875
|
*/
|
|
2814
2876
|
currency?: string;
|
|
2815
2877
|
/** the measurement system of he labels (Metric or Imperial) */
|
|
2816
|
-
measurementSystem?:
|
|
2878
|
+
measurementSystem?: MeasurementSystemWithLiterals;
|
|
2817
2879
|
/** does carrier support insurance */
|
|
2818
2880
|
isInsuranceSupported?: boolean;
|
|
2819
2881
|
/**
|
|
@@ -2827,6 +2889,8 @@ export declare enum MeasurementSystem {
|
|
|
2827
2889
|
Metric = "Metric",
|
|
2828
2890
|
Imperial = "Imperial"
|
|
2829
2891
|
}
|
|
2892
|
+
/** @enumType */
|
|
2893
|
+
export type MeasurementSystemWithLiterals = MeasurementSystem | 'Metric' | 'Imperial';
|
|
2830
2894
|
export interface PackageType {
|
|
2831
2895
|
/**
|
|
2832
2896
|
* carrier id that can be used to get quotes and purchase
|
|
@@ -2901,24 +2965,26 @@ export interface RestaurantsPOSComponentData {
|
|
|
2901
2965
|
}
|
|
2902
2966
|
export interface CatalogSyncConfiguration {
|
|
2903
2967
|
/** If menu, section, or dish availability will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2904
|
-
entityAvailabilityUpdated?:
|
|
2968
|
+
entityAvailabilityUpdated?: DefaultWithLiterals;
|
|
2905
2969
|
/** Whether fulfillment methods will be defined on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2906
|
-
fulfillmentMethodsDefinition?:
|
|
2970
|
+
fulfillmentMethodsDefinition?: DefaultWithLiterals;
|
|
2907
2971
|
/** If dish images will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2908
|
-
dishImagesUpdated?:
|
|
2972
|
+
dishImagesUpdated?: DefaultWithLiterals;
|
|
2909
2973
|
/** If sorting (Menu/Category/Dish/Options) will be done on the POS side (API order) or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2910
|
-
entitySortingControl?:
|
|
2974
|
+
entitySortingControl?: DefaultWithLiterals;
|
|
2911
2975
|
/** If labels will be updated on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2912
|
-
dishLabelsUpdated?:
|
|
2976
|
+
dishLabelsUpdated?: DefaultWithLiterals;
|
|
2913
2977
|
/** If min/max amount of choices is to be set on the POS side or on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2914
|
-
dishOptionsMinMaxUpdated?:
|
|
2978
|
+
dishOptionsMinMaxUpdated?: DefaultWithLiterals;
|
|
2915
2979
|
/** If dish in/out of stock will be retrieved from POS or updated on [Wix Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menus/introduction). */
|
|
2916
|
-
dishInStockUpdated?:
|
|
2980
|
+
dishInStockUpdated?: DefaultWithLiterals;
|
|
2917
2981
|
}
|
|
2918
2982
|
export declare enum Default {
|
|
2919
2983
|
WIX = "WIX",
|
|
2920
2984
|
POS = "POS"
|
|
2921
2985
|
}
|
|
2986
|
+
/** @enumType */
|
|
2987
|
+
export type DefaultWithLiterals = Default | 'WIX' | 'POS';
|
|
2922
2988
|
export interface ShippingProviderConfig {
|
|
2923
2989
|
/** URI configuration of the deployment */
|
|
2924
2990
|
deploymentUri?: SpiBaseUri;
|
|
@@ -2984,6 +3050,8 @@ export declare enum HookType {
|
|
|
2984
3050
|
BEFORE = "BEFORE",
|
|
2985
3051
|
AFTER = "AFTER"
|
|
2986
3052
|
}
|
|
3053
|
+
/** @enumType */
|
|
3054
|
+
export type HookTypeWithLiterals = HookType | 'UNDEFINED' | 'BEFORE_BLOCKING' | 'BEFORE' | 'AFTER';
|
|
2987
3055
|
export interface GenericHookConfig {
|
|
2988
3056
|
/** FQN of proto service */
|
|
2989
3057
|
serviceFqn?: string;
|
|
@@ -2995,7 +3063,7 @@ export interface GenericHookConfig {
|
|
|
2995
3063
|
*/
|
|
2996
3064
|
uri?: string;
|
|
2997
3065
|
/** Type of hook */
|
|
2998
|
-
hookType?:
|
|
3066
|
+
hookType?: HookTypeWithLiterals;
|
|
2999
3067
|
}
|
|
3000
3068
|
export interface ActionProviderSPIConfig {
|
|
3001
3069
|
/** URL to action provider service for this action */
|
|
@@ -3098,7 +3166,7 @@ export interface ActionSPIConfig {
|
|
|
3098
3166
|
* Indicates whether we should wait for the action to complete before executing the next actions or finish and
|
|
3099
3167
|
* expect a callback in the actionCompleted method
|
|
3100
3168
|
*/
|
|
3101
|
-
executionType?:
|
|
3169
|
+
executionType?: ExecutionTypeWithLiterals;
|
|
3102
3170
|
/** Chosen interface for action */
|
|
3103
3171
|
interfaceConfiguration?: ActionSPIConfigInterfaceConfiguration;
|
|
3104
3172
|
/** Icon representing the action in the UI */
|
|
@@ -3116,6 +3184,8 @@ export declare enum ActionSPIConfigInterfaceConfigurationType {
|
|
|
3116
3184
|
WIDGET_COMPONENT = "WIDGET_COMPONENT",
|
|
3117
3185
|
GENERIC = "GENERIC"
|
|
3118
3186
|
}
|
|
3187
|
+
/** @enumType */
|
|
3188
|
+
export type ActionSPIConfigInterfaceConfigurationTypeWithLiterals = ActionSPIConfigInterfaceConfigurationType | 'UNKNOWN_TYPE' | 'WIDGET_COMPONENT' | 'GENERIC';
|
|
3119
3189
|
export interface WidgetComponentOptions {
|
|
3120
3190
|
/**
|
|
3121
3191
|
* Name of provided component
|
|
@@ -3135,6 +3205,8 @@ export declare enum SourceType {
|
|
|
3135
3205
|
/** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
|
|
3136
3206
|
WIX_API = "WIX_API"
|
|
3137
3207
|
}
|
|
3208
|
+
/** @enumType */
|
|
3209
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
|
|
3138
3210
|
export interface WixApiOptions {
|
|
3139
3211
|
/**
|
|
3140
3212
|
* Service entity fqdn
|
|
@@ -3184,6 +3256,8 @@ export declare enum ExecutionType {
|
|
|
3184
3256
|
SYNC = "SYNC",
|
|
3185
3257
|
ASYNC = "ASYNC"
|
|
3186
3258
|
}
|
|
3259
|
+
/** @enumType */
|
|
3260
|
+
export type ExecutionTypeWithLiterals = ExecutionType | 'UNKNOWN_EXECUTION_TYPE' | 'SYNC' | 'ASYNC';
|
|
3187
3261
|
export interface Metadata {
|
|
3188
3262
|
/** Show action only to advanced mode users (Wix staff) */
|
|
3189
3263
|
hidden?: boolean;
|
|
@@ -3192,7 +3266,7 @@ export interface ActionSPIConfigInterfaceConfiguration extends ActionSPIConfigIn
|
|
|
3192
3266
|
widgetComponentOptions?: WidgetComponentOptions;
|
|
3193
3267
|
genericOptions?: GenericOptions;
|
|
3194
3268
|
/** Type of chosen interface */
|
|
3195
|
-
type?:
|
|
3269
|
+
type?: ActionSPIConfigInterfaceConfigurationTypeWithLiterals;
|
|
3196
3270
|
}
|
|
3197
3271
|
/** @oneof */
|
|
3198
3272
|
export interface ActionSPIConfigInterfaceConfigurationOptionsOneOf {
|
|
@@ -3203,7 +3277,7 @@ export interface Source extends SourceOptionsOneOf {
|
|
|
3203
3277
|
/** Wix API options */
|
|
3204
3278
|
wixApiOptions?: WixApiOptions;
|
|
3205
3279
|
/** the source type */
|
|
3206
|
-
type?:
|
|
3280
|
+
type?: SourceTypeWithLiterals;
|
|
3207
3281
|
}
|
|
3208
3282
|
/** @oneof */
|
|
3209
3283
|
export interface SourceOptionsOneOf {
|
|
@@ -3247,7 +3321,7 @@ export interface BackOfficeExtensionContainer {
|
|
|
3247
3321
|
/** Extensibility properties used by containers (slots) */
|
|
3248
3322
|
export interface Extendable {
|
|
3249
3323
|
/** Type of component that this slot accepts. */
|
|
3250
|
-
extendedBy?:
|
|
3324
|
+
extendedBy?: ExtendingComponentTypeWithLiterals;
|
|
3251
3325
|
}
|
|
3252
3326
|
/** Which component types can be extended in containers */
|
|
3253
3327
|
export declare enum ExtendingComponentType {
|
|
@@ -3255,6 +3329,8 @@ export declare enum ExtendingComponentType {
|
|
|
3255
3329
|
BACK_OFFICE_MENU_ITEM = "BACK_OFFICE_MENU_ITEM",
|
|
3256
3330
|
BACK_OFFICE_EXTENSION_WIDGET = "BACK_OFFICE_EXTENSION_WIDGET"
|
|
3257
3331
|
}
|
|
3332
|
+
/** @enumType */
|
|
3333
|
+
export type ExtendingComponentTypeWithLiterals = ExtendingComponentType | 'INVALID' | 'BACK_OFFICE_MENU_ITEM' | 'BACK_OFFICE_EXTENSION_WIDGET';
|
|
3258
3334
|
/** List of back-office hosting platforms */
|
|
3259
3335
|
export declare enum BackOfficeHostingPlatforms {
|
|
3260
3336
|
NO_HOSTING_PLATFORM = "NO_HOSTING_PLATFORM",
|
|
@@ -3295,6 +3371,8 @@ export declare enum BackOfficeHostingPlatforms {
|
|
|
3295
3371
|
/** Picasso AI application POC */
|
|
3296
3372
|
PICASSO_EDITOR = "PICASSO_EDITOR"
|
|
3297
3373
|
}
|
|
3374
|
+
/** @enumType */
|
|
3375
|
+
export type BackOfficeHostingPlatformsWithLiterals = BackOfficeHostingPlatforms | 'NO_HOSTING_PLATFORM' | 'BUSINESS_MANAGER' | 'ACCOUNT_MANAGER' | 'DEV_CENTER' | 'ENTERPRISE' | 'PARTNERS_DASHBOARD' | 'FINANCIALS_INTERNAL_BO' | 'FED_GUILD_POC' | 'STUDIO_DASHBOARD' | 'CHANNELS' | 'DATA_TOOLS' | 'PSP_BACKOFFICE' | 'RISE_PLATFORM_ACCOUNT_DASHBOARD' | 'DEMO_DASHBOARD_ENTERPRISE' | 'AI_SCHEDULING_ASSISTANT_DASHBOARD' | 'GETTING_PAID' | 'DATA' | 'LITE_DASHBOARD' | 'PICASSO_EDITOR';
|
|
3298
3376
|
/** Definitions of common slots properties */
|
|
3299
3377
|
export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
3300
3378
|
/** Widget-specific slot. */
|
|
@@ -3319,7 +3397,7 @@ export interface SlotData extends SlotDataSlotTypeOneOf {
|
|
|
3319
3397
|
* @format WEB_URL
|
|
3320
3398
|
*/
|
|
3321
3399
|
mdHttpLinks?: string[];
|
|
3322
|
-
type?:
|
|
3400
|
+
type?: SlotDataTypeWithLiterals;
|
|
3323
3401
|
}
|
|
3324
3402
|
/** @oneof */
|
|
3325
3403
|
export interface SlotDataSlotTypeOneOf {
|
|
@@ -3331,7 +3409,7 @@ export interface SlotDataSlotTypeOneOf {
|
|
|
3331
3409
|
export interface DtsDefinitionReference extends DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
3332
3410
|
dtsHttpLinkOptions?: DtsHttpLink;
|
|
3333
3411
|
dtsContentOptions?: DtsContent;
|
|
3334
|
-
type?:
|
|
3412
|
+
type?: DtsDefinitionTypeWithLiterals;
|
|
3335
3413
|
}
|
|
3336
3414
|
/** @oneof */
|
|
3337
3415
|
export interface DtsDefinitionReferenceDtsDefinitionOneOf {
|
|
@@ -3343,6 +3421,8 @@ export declare enum DtsDefinitionType {
|
|
|
3343
3421
|
DTS_HTTP_LINK = "DTS_HTTP_LINK",
|
|
3344
3422
|
DTS_CONTENT = "DTS_CONTENT"
|
|
3345
3423
|
}
|
|
3424
|
+
/** @enumType */
|
|
3425
|
+
export type DtsDefinitionTypeWithLiterals = DtsDefinitionType | 'UNKNOWN' | 'DTS_HTTP_LINK' | 'DTS_CONTENT';
|
|
3346
3426
|
export interface DtsHttpLink {
|
|
3347
3427
|
/**
|
|
3348
3428
|
* HTTP link to the bundled d.ts file.
|
|
@@ -3394,6 +3474,8 @@ export declare enum SlotDataType {
|
|
|
3394
3474
|
WIDGET = "WIDGET",
|
|
3395
3475
|
MENU = "MENU"
|
|
3396
3476
|
}
|
|
3477
|
+
/** @enumType */
|
|
3478
|
+
export type SlotDataTypeWithLiterals = SlotDataType | 'UNKNOWN' | 'WIDGET' | 'MENU';
|
|
3397
3479
|
export interface WidgetSlot {
|
|
3398
3480
|
/** Blocks specific data. */
|
|
3399
3481
|
blocksData?: BlocksData;
|
|
@@ -3419,13 +3501,13 @@ export interface BackOfficeExtension extends BackOfficeExtensionExtensionOneOf {
|
|
|
3419
3501
|
/** Extension description. This is how the extension is described in the Wix Dev Center. */
|
|
3420
3502
|
description?: string | null;
|
|
3421
3503
|
/** Type of extension. */
|
|
3422
|
-
extensionType?:
|
|
3504
|
+
extensionType?: ExtendingComponentTypeWithLiterals;
|
|
3423
3505
|
/**
|
|
3424
3506
|
* Platform that hosts the extension.
|
|
3425
3507
|
*
|
|
3426
3508
|
* Must be `"BUSINESS_MANAGER"`.
|
|
3427
3509
|
*/
|
|
3428
|
-
hostingPlatform?:
|
|
3510
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
3429
3511
|
}
|
|
3430
3512
|
/** @oneof */
|
|
3431
3513
|
export interface BackOfficeExtensionExtensionOneOf {
|
|
@@ -3480,7 +3562,7 @@ export interface BackOfficeScriptAsset {
|
|
|
3480
3562
|
*/
|
|
3481
3563
|
exportedName?: string;
|
|
3482
3564
|
/** Optional: What type should by used on <script> tag. */
|
|
3483
|
-
scriptType?:
|
|
3565
|
+
scriptType?: BackOfficeScriptAssetTypeWithLiterals;
|
|
3484
3566
|
}
|
|
3485
3567
|
/** Type attribute for the script tag */
|
|
3486
3568
|
export declare enum BackOfficeScriptAssetType {
|
|
@@ -3489,6 +3571,8 @@ export declare enum BackOfficeScriptAssetType {
|
|
|
3489
3571
|
/** Use "module" as the script type */
|
|
3490
3572
|
MODULE = "MODULE"
|
|
3491
3573
|
}
|
|
3574
|
+
/** @enumType */
|
|
3575
|
+
export type BackOfficeScriptAssetTypeWithLiterals = BackOfficeScriptAssetType | 'UNKNOWN_TYPE' | 'MODULE';
|
|
3492
3576
|
/** The schema of a menu extension of a slot exposed in a page in the Wix Dashboard */
|
|
3493
3577
|
export interface LegacyBackOfficeMenuItem {
|
|
3494
3578
|
/**
|
|
@@ -3513,6 +3597,8 @@ export declare enum ViewMode {
|
|
|
3513
3597
|
/** Opens as a modal on the current page. */
|
|
3514
3598
|
MODAL = "MODAL"
|
|
3515
3599
|
}
|
|
3600
|
+
/** @enumType */
|
|
3601
|
+
export type ViewModeWithLiterals = ViewMode | 'PAGE' | 'MODAL';
|
|
3516
3602
|
/** the schema of the data needed to open a component from menu extensions */
|
|
3517
3603
|
export interface OpenComponent {
|
|
3518
3604
|
/**
|
|
@@ -3521,7 +3607,7 @@ export interface OpenComponent {
|
|
|
3521
3607
|
*/
|
|
3522
3608
|
componentId?: string;
|
|
3523
3609
|
/** How the component is opened. */
|
|
3524
|
-
viewMode?:
|
|
3610
|
+
viewMode?: ViewModeWithLiterals;
|
|
3525
3611
|
/** Parameters to navigate to a page or as props for a modal. */
|
|
3526
3612
|
componentParams?: Record<string, string>;
|
|
3527
3613
|
}
|
|
@@ -3660,7 +3746,7 @@ export interface AlgorithmConfig {
|
|
|
3660
3746
|
* * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
|
|
3661
3747
|
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
3662
3748
|
*/
|
|
3663
|
-
algorithmType?:
|
|
3749
|
+
algorithmType?: AlgorithmTypeWithLiterals;
|
|
3664
3750
|
/**
|
|
3665
3751
|
* Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project.
|
|
3666
3752
|
* @format GUID
|
|
@@ -3672,6 +3758,8 @@ export declare enum AlgorithmType {
|
|
|
3672
3758
|
RELATED_ITEMS = "RELATED_ITEMS",
|
|
3673
3759
|
GLOBAL = "GLOBAL"
|
|
3674
3760
|
}
|
|
3761
|
+
/** @enumType */
|
|
3762
|
+
export type AlgorithmTypeWithLiterals = AlgorithmType | 'UNSPECIFIED' | 'RELATED_ITEMS' | 'GLOBAL';
|
|
3675
3763
|
export interface DropshippingProviderSPIConfig {
|
|
3676
3764
|
/** name of the dropshipping provider was it appears in relevant screens/mails in eComm Platform */
|
|
3677
3765
|
name?: string;
|
|
@@ -3688,13 +3776,13 @@ export interface DropshippingProviderSPIConfig {
|
|
|
3688
3776
|
*/
|
|
3689
3777
|
dashboardUri?: string;
|
|
3690
3778
|
/** if duplication operation for product is locked */
|
|
3691
|
-
duplicateProduct?:
|
|
3779
|
+
duplicateProduct?: LockableOperationWithLiterals;
|
|
3692
3780
|
/** whether there is a warning or not when price is changed */
|
|
3693
|
-
changePrice?:
|
|
3781
|
+
changePrice?: RestrictedOperationWithLiterals;
|
|
3694
3782
|
/** whether the chagne inventory operations are locked */
|
|
3695
|
-
changeInventory?:
|
|
3783
|
+
changeInventory?: LockableOperationWithLiterals;
|
|
3696
3784
|
/** where there is a warning of not when changing options */
|
|
3697
|
-
manageOptions?:
|
|
3785
|
+
manageOptions?: RestrictedOperationWithLiterals;
|
|
3698
3786
|
}
|
|
3699
3787
|
export declare enum LockableOperation {
|
|
3700
3788
|
/** When operation lockability is not specified */
|
|
@@ -3704,11 +3792,15 @@ export declare enum LockableOperation {
|
|
|
3704
3792
|
/** Operation is unlocked */
|
|
3705
3793
|
UNLOCKED = "UNLOCKED"
|
|
3706
3794
|
}
|
|
3795
|
+
/** @enumType */
|
|
3796
|
+
export type LockableOperationWithLiterals = LockableOperation | 'UNSPECIFIED_LOCKABLE' | 'LOCKED' | 'UNLOCKED';
|
|
3707
3797
|
export declare enum RestrictedOperation {
|
|
3708
3798
|
UNSPECIFIED_RESTRICTED = "UNSPECIFIED_RESTRICTED",
|
|
3709
3799
|
ALLOW = "ALLOW",
|
|
3710
3800
|
WARN = "WARN"
|
|
3711
3801
|
}
|
|
3802
|
+
/** @enumType */
|
|
3803
|
+
export type RestrictedOperationWithLiterals = RestrictedOperation | 'UNSPECIFIED_RESTRICTED' | 'ALLOW' | 'WARN';
|
|
3712
3804
|
export interface InvoicesConfig {
|
|
3713
3805
|
/** Base URI of spi provider */
|
|
3714
3806
|
baseUri?: string;
|
|
@@ -3775,7 +3867,7 @@ export interface ApplicationAutomationComponent {
|
|
|
3775
3867
|
/** Automation metadata */
|
|
3776
3868
|
metadata?: AutomationMetadata;
|
|
3777
3869
|
/** Automation status */
|
|
3778
|
-
status?:
|
|
3870
|
+
status?: StatusWithLiterals;
|
|
3779
3871
|
/** Optional origin that indicates the source of the automation */
|
|
3780
3872
|
origin?: OriginInfo;
|
|
3781
3873
|
/**
|
|
@@ -3918,8 +4010,10 @@ export declare enum BlockType {
|
|
|
3918
4010
|
OR = "OR",
|
|
3919
4011
|
AND = "AND"
|
|
3920
4012
|
}
|
|
4013
|
+
/** @enumType */
|
|
4014
|
+
export type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND';
|
|
3921
4015
|
export interface ConditionBlock {
|
|
3922
|
-
type?:
|
|
4016
|
+
type?: BlockTypeWithLiterals;
|
|
3923
4017
|
/**
|
|
3924
4018
|
* @minSize 1
|
|
3925
4019
|
* @maxSize 20
|
|
@@ -4012,10 +4106,14 @@ export declare enum Domain {
|
|
|
4012
4106
|
/** Wix domain */
|
|
4013
4107
|
WIX = "WIX"
|
|
4014
4108
|
}
|
|
4109
|
+
/** @enumType */
|
|
4110
|
+
export type DomainWithLiterals = Domain | 'USER' | 'WIX';
|
|
4015
4111
|
export declare enum Status {
|
|
4016
4112
|
ACTIVE = "ACTIVE",
|
|
4017
4113
|
INACTIVE = "INACTIVE"
|
|
4018
4114
|
}
|
|
4115
|
+
/** @enumType */
|
|
4116
|
+
export type StatusWithLiterals = Status | 'ACTIVE' | 'INACTIVE';
|
|
4019
4117
|
export interface OriginInfo {
|
|
4020
4118
|
/**
|
|
4021
4119
|
* The id of the original automation used to create the preinstalled automation (v3/Builder only)
|
|
@@ -4242,7 +4340,7 @@ export interface TextInputSettings {
|
|
|
4242
4340
|
/** A regex that the text entered by the user must match */
|
|
4243
4341
|
regex?: string | null;
|
|
4244
4342
|
/** How should the field be displayed to the end user */
|
|
4245
|
-
displayType?:
|
|
4343
|
+
displayType?: TextInputDisplayTypeWithLiterals;
|
|
4246
4344
|
}
|
|
4247
4345
|
export declare enum TextInputDisplayType {
|
|
4248
4346
|
/** A regular text field */
|
|
@@ -4252,6 +4350,8 @@ export declare enum TextInputDisplayType {
|
|
|
4252
4350
|
/** A field optimized for one time codes */
|
|
4253
4351
|
CODE = "CODE"
|
|
4254
4352
|
}
|
|
4353
|
+
/** @enumType */
|
|
4354
|
+
export type TextInputDisplayTypeWithLiterals = TextInputDisplayType | 'TEXT' | 'PASSWORD' | 'CODE';
|
|
4255
4355
|
export interface IDPConnectionConfig {
|
|
4256
4356
|
/** the base URI where all the methods are deployed. */
|
|
4257
4357
|
baseUri?: string;
|
|
@@ -4278,11 +4378,11 @@ export interface ItemsSelectionProviderConfig {
|
|
|
4278
4378
|
* An array of strings representing the Wix UI pages supported by your SPI implementation. If no tags are listed, Wix assumes that the implementation supports all eligible pages.
|
|
4279
4379
|
* @maxSize 50
|
|
4280
4380
|
*/
|
|
4281
|
-
supportedTags?:
|
|
4381
|
+
supportedTags?: TagWithLiterals[];
|
|
4282
4382
|
/** Configuration settings for how the thumbnail is displayed. */
|
|
4283
4383
|
itemThumbnail?: ItemThumbnail;
|
|
4284
4384
|
/** Pagination Mode */
|
|
4285
|
-
paginationMode?:
|
|
4385
|
+
paginationMode?: PaginationModeWithLiterals;
|
|
4286
4386
|
}
|
|
4287
4387
|
export interface LearnMore {
|
|
4288
4388
|
/**
|
|
@@ -4301,8 +4401,10 @@ export declare enum ThumbnailType {
|
|
|
4301
4401
|
IMAGE = "IMAGE",
|
|
4302
4402
|
AVATAR = "AVATAR"
|
|
4303
4403
|
}
|
|
4404
|
+
/** @enumType */
|
|
4405
|
+
export type ThumbnailTypeWithLiterals = ThumbnailType | 'UNKNOWN_THUMBNAIL_TYPE' | 'IMAGE' | 'AVATAR';
|
|
4304
4406
|
export interface ImageConfig {
|
|
4305
|
-
shape?:
|
|
4407
|
+
shape?: ImageShapeWithLiterals;
|
|
4306
4408
|
}
|
|
4307
4409
|
export declare enum ImageShape {
|
|
4308
4410
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4313,8 +4415,10 @@ export declare enum ImageShape {
|
|
|
4313
4415
|
/** Rectangle */
|
|
4314
4416
|
RECTANGLE = "RECTANGLE"
|
|
4315
4417
|
}
|
|
4418
|
+
/** @enumType */
|
|
4419
|
+
export type ImageShapeWithLiterals = ImageShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE' | 'RECTANGLE';
|
|
4316
4420
|
export interface AvatarConfig {
|
|
4317
|
-
shape?:
|
|
4421
|
+
shape?: AvatarShapeWithLiterals;
|
|
4318
4422
|
}
|
|
4319
4423
|
export declare enum AvatarShape {
|
|
4320
4424
|
UNKNOWN_SHAPE = "UNKNOWN_SHAPE",
|
|
@@ -4323,6 +4427,8 @@ export declare enum AvatarShape {
|
|
|
4323
4427
|
/** Square */
|
|
4324
4428
|
SQUARE = "SQUARE"
|
|
4325
4429
|
}
|
|
4430
|
+
/** @enumType */
|
|
4431
|
+
export type AvatarShapeWithLiterals = AvatarShape | 'UNKNOWN_SHAPE' | 'CIRCLE' | 'SQUARE';
|
|
4326
4432
|
export interface SearchField {
|
|
4327
4433
|
/** Supported searchable fields. */
|
|
4328
4434
|
key?: string;
|
|
@@ -4345,11 +4451,11 @@ export interface FilterInfo extends FilterInfoOptionsOneOf {
|
|
|
4345
4451
|
*/
|
|
4346
4452
|
key?: string;
|
|
4347
4453
|
/** Optional filter will be shown only for consumers with this tag. Only one filter is allowed per tag. */
|
|
4348
|
-
tag?:
|
|
4454
|
+
tag?: TagWithLiterals;
|
|
4349
4455
|
/** The filter selection type. */
|
|
4350
|
-
selectionType?:
|
|
4456
|
+
selectionType?: FilterSelectionTypeWithLiterals;
|
|
4351
4457
|
/** Filter options type. For now only static options are supported */
|
|
4352
|
-
optionsType?:
|
|
4458
|
+
optionsType?: FilterOptionsTypeWithLiterals;
|
|
4353
4459
|
/**
|
|
4354
4460
|
* Optional placeholder text to display on the filter
|
|
4355
4461
|
* @maxLength 500
|
|
@@ -4373,6 +4479,8 @@ export declare enum Tag {
|
|
|
4373
4479
|
ECOM_DELIVERY_PROFILES = "ECOM_DELIVERY_PROFILES",
|
|
4374
4480
|
ADD_TO_CATEGORY = "ADD_TO_CATEGORY"
|
|
4375
4481
|
}
|
|
4482
|
+
/** @enumType */
|
|
4483
|
+
export type TagWithLiterals = Tag | 'UNKNOWN_TAG' | 'EMBEDDABLE' | 'ECOM_EDIT_ORDER' | 'ECOM_CREATE_ORDER' | 'INBOX' | 'ECOM_CREATE_PAY_LINK' | 'ECOM_DELIVERY_PROFILES' | 'ADD_TO_CATEGORY';
|
|
4376
4484
|
export declare enum FilterSelectionType {
|
|
4377
4485
|
UNKNOWN_SELECTION = "UNKNOWN_SELECTION",
|
|
4378
4486
|
/** Allow to select only a single item */
|
|
@@ -4380,12 +4488,16 @@ export declare enum FilterSelectionType {
|
|
|
4380
4488
|
/** Allow to select multiple items */
|
|
4381
4489
|
MULTIPLE_SELECTION = "MULTIPLE_SELECTION"
|
|
4382
4490
|
}
|
|
4491
|
+
/** @enumType */
|
|
4492
|
+
export type FilterSelectionTypeWithLiterals = FilterSelectionType | 'UNKNOWN_SELECTION' | 'SINGLE_SELECTION' | 'MULTIPLE_SELECTION';
|
|
4383
4493
|
export declare enum FilterOptionsType {
|
|
4384
4494
|
UNKNOWN_FILTER_OPTIONS = "UNKNOWN_FILTER_OPTIONS",
|
|
4385
4495
|
/** Static hardcoded options */
|
|
4386
4496
|
STATIC = "STATIC",
|
|
4387
4497
|
PROVIDER = "PROVIDER"
|
|
4388
4498
|
}
|
|
4499
|
+
/** @enumType */
|
|
4500
|
+
export type FilterOptionsTypeWithLiterals = FilterOptionsType | 'UNKNOWN_FILTER_OPTIONS' | 'STATIC' | 'PROVIDER';
|
|
4389
4501
|
export interface StaticFilterOptions {
|
|
4390
4502
|
/**
|
|
4391
4503
|
* List of hardcoded options for a filter
|
|
@@ -4494,7 +4606,7 @@ export interface ItemThumbnail extends ItemThumbnailOptionsOneOf {
|
|
|
4494
4606
|
/** Configuration specific to avatars. */
|
|
4495
4607
|
avatarConfig?: AvatarConfig;
|
|
4496
4608
|
/** Thumbnail type */
|
|
4497
|
-
type?:
|
|
4609
|
+
type?: ThumbnailTypeWithLiterals;
|
|
4498
4610
|
/** Whether the thumbnail is hidden from the UI. */
|
|
4499
4611
|
hidden?: boolean | null;
|
|
4500
4612
|
}
|
|
@@ -4510,6 +4622,8 @@ export declare enum PaginationMode {
|
|
|
4510
4622
|
CURSOR = "CURSOR",
|
|
4511
4623
|
OFFSET = "OFFSET"
|
|
4512
4624
|
}
|
|
4625
|
+
/** @enumType */
|
|
4626
|
+
export type PaginationModeWithLiterals = PaginationMode | 'UNKNOWN_PAGINATION_MODE' | 'CURSOR' | 'OFFSET';
|
|
4513
4627
|
export interface SyncedProjectsProviderConfig {
|
|
4514
4628
|
/** URI where the SPI Implementer is deployed */
|
|
4515
4629
|
baseUri?: string;
|
|
@@ -4530,7 +4644,7 @@ export interface ChannelConfiguration extends ChannelConfigurationMessagingConfi
|
|
|
4530
4644
|
emailMessageConfig?: EmailMessageConfig;
|
|
4531
4645
|
smsMessageConfig?: SmsMessageConfig;
|
|
4532
4646
|
/** The type of the communication channel */
|
|
4533
|
-
type?:
|
|
4647
|
+
type?: ChannelTypeWithLiterals;
|
|
4534
4648
|
/** Specific provider branding parameters for the channel */
|
|
4535
4649
|
branding?: ChannelBranding;
|
|
4536
4650
|
/** Conversation initiation definition */
|
|
@@ -4549,6 +4663,8 @@ export declare enum ChannelType {
|
|
|
4549
4663
|
EMAIL = "EMAIL",
|
|
4550
4664
|
SMS = "SMS"
|
|
4551
4665
|
}
|
|
4666
|
+
/** @enumType */
|
|
4667
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
4552
4668
|
export interface DirectMessageConfig {
|
|
4553
4669
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4554
4670
|
acceptAllMessageTypes?: boolean;
|
|
@@ -4556,7 +4672,7 @@ export interface DirectMessageConfig {
|
|
|
4556
4672
|
* Direct message types accepted by the provider. only those types will be sent from Wix
|
|
4557
4673
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4558
4674
|
*/
|
|
4559
|
-
acceptedMessageTypes?:
|
|
4675
|
+
acceptedMessageTypes?: AcceptedDirectMessageTypeWithLiterals[];
|
|
4560
4676
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4561
4677
|
mediaCapabilities?: MediaCapabilities;
|
|
4562
4678
|
}
|
|
@@ -4567,6 +4683,8 @@ export declare enum AcceptedDirectMessageType {
|
|
|
4567
4683
|
ANNOUNCEMENT = "ANNOUNCEMENT",
|
|
4568
4684
|
FORM = "FORM"
|
|
4569
4685
|
}
|
|
4686
|
+
/** @enumType */
|
|
4687
|
+
export type AcceptedDirectMessageTypeWithLiterals = AcceptedDirectMessageType | 'TEXT' | 'MEDIA' | 'CARD' | 'ANNOUNCEMENT' | 'FORM';
|
|
4570
4688
|
export interface MediaCapabilities {
|
|
4571
4689
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4572
4690
|
allMediaTypes?: boolean;
|
|
@@ -4575,7 +4693,7 @@ export interface MediaCapabilities {
|
|
|
4575
4693
|
* If all are excepted this field can be left empty and there's no need to explicitly state types
|
|
4576
4694
|
* @maxSize 50
|
|
4577
4695
|
*/
|
|
4578
|
-
supportedMediaTypes?:
|
|
4696
|
+
supportedMediaTypes?: MediaMimeTypeWithLiterals[];
|
|
4579
4697
|
/** Maximum file size in bytes of a single file in a message */
|
|
4580
4698
|
maxFileSizeInBytes?: number | null;
|
|
4581
4699
|
}
|
|
@@ -4596,6 +4714,8 @@ export declare enum MediaMimeType {
|
|
|
4596
4714
|
APPLICATION_PDF = "APPLICATION_PDF",
|
|
4597
4715
|
APPLICATION_OCTET_STREAM = "APPLICATION_OCTET_STREAM"
|
|
4598
4716
|
}
|
|
4717
|
+
/** @enumType */
|
|
4718
|
+
export type MediaMimeTypeWithLiterals = MediaMimeType | 'UNKNOWN_MIME_TYPE' | 'IMAGE_JPEG' | 'IMAGE_PNG' | 'IMAGE_WEBP' | 'VIDEO_MPEG' | 'VIDEO_MP4' | 'VIDEO_3GP' | 'AUDIO_AAC' | 'AUDIO_MP4' | 'AUDIO_MPEG' | 'AUDIO_OGG' | 'AUDIO_OPUS' | 'APPLICATION_PDF' | 'APPLICATION_OCTET_STREAM';
|
|
4599
4719
|
export interface EmailMessageConfig {
|
|
4600
4720
|
/** Media (Attachment) types accepted by the provider */
|
|
4601
4721
|
mediaCapabilities?: MediaCapabilities;
|
|
@@ -4606,7 +4726,7 @@ export interface SmsMessageConfig {
|
|
|
4606
4726
|
/** When marked as true, there's no need to list the supported types explicitly */
|
|
4607
4727
|
acceptAllMessageTypes?: boolean;
|
|
4608
4728
|
/** SMS message types accepted by the provider. only those types will be sent from Wix */
|
|
4609
|
-
acceptedMessageTypes?:
|
|
4729
|
+
acceptedMessageTypes?: AcceptedSmsMessageTypeWithLiterals[];
|
|
4610
4730
|
/** Elaborates what media types (mime types) and sizes are supported */
|
|
4611
4731
|
mediaCapabilities?: MediaCapabilities;
|
|
4612
4732
|
}
|
|
@@ -4614,6 +4734,8 @@ export declare enum AcceptedSmsMessageType {
|
|
|
4614
4734
|
SMS = "SMS",
|
|
4615
4735
|
MMS = "MMS"
|
|
4616
4736
|
}
|
|
4737
|
+
/** @enumType */
|
|
4738
|
+
export type AcceptedSmsMessageTypeWithLiterals = AcceptedSmsMessageType | 'SMS' | 'MMS';
|
|
4617
4739
|
export interface ChannelBranding {
|
|
4618
4740
|
/** The name of the channel, e.g. `Facebook` / `SMS` */
|
|
4619
4741
|
displayName?: string;
|
|
@@ -4642,7 +4764,7 @@ export interface ConversationLimitations {
|
|
|
4642
4764
|
* If, `CUSTOMER` is selected, this means that only inbound
|
|
4643
4765
|
* messages can start a conversation (aka business can only reply and not initiate the first communication).
|
|
4644
4766
|
*/
|
|
4645
|
-
initDirection?:
|
|
4767
|
+
initDirection?: InitDirectionWithLiterals;
|
|
4646
4768
|
}
|
|
4647
4769
|
export declare enum InitDirection {
|
|
4648
4770
|
UNKNOWN_INIT_DIRECTION = "UNKNOWN_INIT_DIRECTION",
|
|
@@ -4650,6 +4772,8 @@ export declare enum InitDirection {
|
|
|
4650
4772
|
CUSTOMER = "CUSTOMER",
|
|
4651
4773
|
BOTH = "BOTH"
|
|
4652
4774
|
}
|
|
4775
|
+
/** @enumType */
|
|
4776
|
+
export type InitDirectionWithLiterals = InitDirection | 'UNKNOWN_INIT_DIRECTION' | 'BUSINESS' | 'CUSTOMER' | 'BOTH';
|
|
4653
4777
|
export interface PostLoginConfig {
|
|
4654
4778
|
/** the base URI where all the methods are deployed. */
|
|
4655
4779
|
baseUri?: string;
|
|
@@ -4910,7 +5034,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
4910
5034
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
4911
5035
|
layoutCellData?: LayoutCellData;
|
|
4912
5036
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
4913
|
-
type?:
|
|
5037
|
+
type?: NodeTypeWithLiterals;
|
|
4914
5038
|
/** Node ID. */
|
|
4915
5039
|
id?: string;
|
|
4916
5040
|
/** A list of child nodes. */
|
|
@@ -5011,6 +5135,8 @@ export declare enum NodeType {
|
|
|
5011
5135
|
LAYOUT = "LAYOUT",
|
|
5012
5136
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
5013
5137
|
}
|
|
5138
|
+
/** @enumType */
|
|
5139
|
+
export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
5014
5140
|
export interface NodeStyle {
|
|
5015
5141
|
/** The top padding value in pixels. */
|
|
5016
5142
|
paddingTop?: string | null;
|
|
@@ -5023,7 +5149,7 @@ export interface ButtonData {
|
|
|
5023
5149
|
/** Styling for the button's container. */
|
|
5024
5150
|
containerData?: PluginContainerData;
|
|
5025
5151
|
/** The button type. */
|
|
5026
|
-
type?:
|
|
5152
|
+
type?: ButtonDataTypeWithLiterals;
|
|
5027
5153
|
/** Styling for the button. */
|
|
5028
5154
|
styles?: Styles;
|
|
5029
5155
|
/** The text to display on the button. */
|
|
@@ -5064,7 +5190,7 @@ export interface PluginContainerData {
|
|
|
5064
5190
|
/** The width of the node when it's displayed. */
|
|
5065
5191
|
width?: PluginContainerDataWidth;
|
|
5066
5192
|
/** The node's alignment within its container. */
|
|
5067
|
-
alignment?:
|
|
5193
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
5068
5194
|
/** Spoiler cover settings for the node. */
|
|
5069
5195
|
spoiler?: Spoiler;
|
|
5070
5196
|
/** The height of the node when it's displayed. */
|
|
@@ -5082,6 +5208,8 @@ export declare enum WidthType {
|
|
|
5082
5208
|
/** coast-to-coast display */
|
|
5083
5209
|
FULL_WIDTH = "FULL_WIDTH"
|
|
5084
5210
|
}
|
|
5211
|
+
/** @enumType */
|
|
5212
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
5085
5213
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
5086
5214
|
/**
|
|
5087
5215
|
* One of the following predefined width options:
|
|
@@ -5090,7 +5218,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
5090
5218
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5091
5219
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5092
5220
|
*/
|
|
5093
|
-
size?:
|
|
5221
|
+
size?: WidthTypeWithLiterals;
|
|
5094
5222
|
/** A custom width value in pixels. */
|
|
5095
5223
|
custom?: string | null;
|
|
5096
5224
|
}
|
|
@@ -5103,7 +5231,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
5103
5231
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
5104
5232
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
5105
5233
|
*/
|
|
5106
|
-
size?:
|
|
5234
|
+
size?: WidthTypeWithLiterals;
|
|
5107
5235
|
/** A custom width value in pixels. */
|
|
5108
5236
|
custom?: string | null;
|
|
5109
5237
|
}
|
|
@@ -5115,6 +5243,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
5115
5243
|
/** Right Alignment */
|
|
5116
5244
|
RIGHT = "RIGHT"
|
|
5117
5245
|
}
|
|
5246
|
+
/** @enumType */
|
|
5247
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5118
5248
|
export interface Spoiler {
|
|
5119
5249
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
5120
5250
|
enabled?: boolean | null;
|
|
@@ -5133,6 +5263,8 @@ export declare enum ButtonDataType {
|
|
|
5133
5263
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
5134
5264
|
ACTION = "ACTION"
|
|
5135
5265
|
}
|
|
5266
|
+
/** @enumType */
|
|
5267
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
5136
5268
|
export interface Styles {
|
|
5137
5269
|
/**
|
|
5138
5270
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -5198,7 +5330,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
5198
5330
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
5199
5331
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
5200
5332
|
*/
|
|
5201
|
-
target?:
|
|
5333
|
+
target?: LinkTargetWithLiterals;
|
|
5202
5334
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
5203
5335
|
rel?: Rel;
|
|
5204
5336
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -5221,6 +5353,8 @@ export declare enum LinkTarget {
|
|
|
5221
5353
|
/** Opens the linked document in the full body of the window */
|
|
5222
5354
|
TOP = "TOP"
|
|
5223
5355
|
}
|
|
5356
|
+
/** @enumType */
|
|
5357
|
+
export type LinkTargetWithLiterals = LinkTarget | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
5224
5358
|
export interface Rel {
|
|
5225
5359
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
5226
5360
|
nofollow?: boolean | null;
|
|
@@ -5237,7 +5371,7 @@ export interface CodeBlockData {
|
|
|
5237
5371
|
}
|
|
5238
5372
|
export interface V1TextStyle {
|
|
5239
5373
|
/** Text alignment. Defaults to `AUTO`. */
|
|
5240
|
-
textAlignment?:
|
|
5374
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
5241
5375
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
5242
5376
|
lineHeight?: string | null;
|
|
5243
5377
|
}
|
|
@@ -5253,15 +5387,17 @@ export declare enum TextAlignment {
|
|
|
5253
5387
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
5254
5388
|
JUSTIFY = "JUSTIFY"
|
|
5255
5389
|
}
|
|
5390
|
+
/** @enumType */
|
|
5391
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
5256
5392
|
export interface DividerData {
|
|
5257
5393
|
/** Styling for the divider's container. */
|
|
5258
5394
|
containerData?: PluginContainerData;
|
|
5259
5395
|
/** Divider line style. */
|
|
5260
|
-
lineStyle?:
|
|
5396
|
+
lineStyle?: LineStyleWithLiterals;
|
|
5261
5397
|
/** Divider width. */
|
|
5262
|
-
width?:
|
|
5398
|
+
width?: DividerDataWidthWithLiterals;
|
|
5263
5399
|
/** Divider alignment. */
|
|
5264
|
-
alignment?:
|
|
5400
|
+
alignment?: AlignmentWithLiterals;
|
|
5265
5401
|
}
|
|
5266
5402
|
export declare enum LineStyle {
|
|
5267
5403
|
/** Single Line */
|
|
@@ -5273,6 +5409,8 @@ export declare enum LineStyle {
|
|
|
5273
5409
|
/** Dotted Line */
|
|
5274
5410
|
DOTTED = "DOTTED"
|
|
5275
5411
|
}
|
|
5412
|
+
/** @enumType */
|
|
5413
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
5276
5414
|
export declare enum DividerDataWidth {
|
|
5277
5415
|
/** Large line */
|
|
5278
5416
|
LARGE = "LARGE",
|
|
@@ -5281,6 +5419,8 @@ export declare enum DividerDataWidth {
|
|
|
5281
5419
|
/** Small line */
|
|
5282
5420
|
SMALL = "SMALL"
|
|
5283
5421
|
}
|
|
5422
|
+
/** @enumType */
|
|
5423
|
+
export type DividerDataWidthWithLiterals = DividerDataWidth | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
5284
5424
|
export declare enum Alignment {
|
|
5285
5425
|
/** Center alignment */
|
|
5286
5426
|
CENTER = "CENTER",
|
|
@@ -5289,6 +5429,8 @@ export declare enum Alignment {
|
|
|
5289
5429
|
/** Right alignment */
|
|
5290
5430
|
RIGHT = "RIGHT"
|
|
5291
5431
|
}
|
|
5432
|
+
/** @enumType */
|
|
5433
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
5292
5434
|
export interface FileData {
|
|
5293
5435
|
/** Styling for the file's container. */
|
|
5294
5436
|
containerData?: PluginContainerData;
|
|
@@ -5320,6 +5462,8 @@ export declare enum PDFSettingsViewMode {
|
|
|
5320
5462
|
/** Mini PDF view */
|
|
5321
5463
|
MINI = "MINI"
|
|
5322
5464
|
}
|
|
5465
|
+
/** @enumType */
|
|
5466
|
+
export type PDFSettingsViewModeWithLiterals = PDFSettingsViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
5323
5467
|
export interface FileSource extends FileSourceDataOneOf {
|
|
5324
5468
|
/** The absolute URL for the file's source. */
|
|
5325
5469
|
url?: string | null;
|
|
@@ -5352,7 +5496,7 @@ export interface PDFSettings {
|
|
|
5352
5496
|
* `FULL` : A full page view of the PDF is displayed.
|
|
5353
5497
|
* `MINI` : A mini view of the PDF is displayed.
|
|
5354
5498
|
*/
|
|
5355
|
-
viewMode?:
|
|
5499
|
+
viewMode?: PDFSettingsViewModeWithLiterals;
|
|
5356
5500
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
5357
5501
|
disableDownload?: boolean | null;
|
|
5358
5502
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -5439,18 +5583,24 @@ export declare enum LayoutType {
|
|
|
5439
5583
|
/** Fullsize images type */
|
|
5440
5584
|
FULLSIZE = "FULLSIZE"
|
|
5441
5585
|
}
|
|
5586
|
+
/** @enumType */
|
|
5587
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
5442
5588
|
export declare enum Orientation {
|
|
5443
5589
|
/** Rows Orientation */
|
|
5444
5590
|
ROWS = "ROWS",
|
|
5445
5591
|
/** Columns Orientation */
|
|
5446
5592
|
COLUMNS = "COLUMNS"
|
|
5447
5593
|
}
|
|
5594
|
+
/** @enumType */
|
|
5595
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
5448
5596
|
export declare enum Crop {
|
|
5449
5597
|
/** Crop to fill */
|
|
5450
5598
|
FILL = "FILL",
|
|
5451
5599
|
/** Crop to fit */
|
|
5452
5600
|
FIT = "FIT"
|
|
5453
5601
|
}
|
|
5602
|
+
/** @enumType */
|
|
5603
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
5454
5604
|
export declare enum ThumbnailsAlignment {
|
|
5455
5605
|
/** Top alignment */
|
|
5456
5606
|
TOP = "TOP",
|
|
@@ -5463,13 +5613,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
5463
5613
|
/** No thumbnail */
|
|
5464
5614
|
NONE = "NONE"
|
|
5465
5615
|
}
|
|
5616
|
+
/** @enumType */
|
|
5617
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
5466
5618
|
export interface Layout {
|
|
5467
5619
|
/** Gallery layout type. */
|
|
5468
|
-
type?:
|
|
5620
|
+
type?: LayoutTypeWithLiterals;
|
|
5469
5621
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
5470
5622
|
horizontalScroll?: boolean | null;
|
|
5471
5623
|
/** Gallery orientation. */
|
|
5472
|
-
orientation?:
|
|
5624
|
+
orientation?: OrientationWithLiterals;
|
|
5473
5625
|
/** The number of columns to display on full size screens. */
|
|
5474
5626
|
numberOfColumns?: number | null;
|
|
5475
5627
|
/** The number of columns to display on mobile screens. */
|
|
@@ -5481,13 +5633,13 @@ export interface ItemStyle {
|
|
|
5481
5633
|
/** Item ratio */
|
|
5482
5634
|
ratio?: number | null;
|
|
5483
5635
|
/** Sets how item images are cropped. */
|
|
5484
|
-
crop?:
|
|
5636
|
+
crop?: CropWithLiterals;
|
|
5485
5637
|
/** The spacing between items in pixels. */
|
|
5486
5638
|
spacing?: number | null;
|
|
5487
5639
|
}
|
|
5488
5640
|
export interface GalleryOptionsThumbnails {
|
|
5489
5641
|
/** Thumbnail alignment. */
|
|
5490
|
-
placement?:
|
|
5642
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
5491
5643
|
/** Spacing between thumbnails in pixels. */
|
|
5492
5644
|
spacing?: number | null;
|
|
5493
5645
|
}
|
|
@@ -5503,7 +5655,7 @@ export interface GIFData {
|
|
|
5503
5655
|
/** Width in pixels. */
|
|
5504
5656
|
width?: number;
|
|
5505
5657
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
5506
|
-
gifType?:
|
|
5658
|
+
gifType?: GIFTypeWithLiterals;
|
|
5507
5659
|
}
|
|
5508
5660
|
export interface GIF {
|
|
5509
5661
|
/**
|
|
@@ -5526,6 +5678,8 @@ export declare enum GIFType {
|
|
|
5526
5678
|
NORMAL = "NORMAL",
|
|
5527
5679
|
STICKER = "STICKER"
|
|
5528
5680
|
}
|
|
5681
|
+
/** @enumType */
|
|
5682
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
5529
5683
|
export interface HeadingData {
|
|
5530
5684
|
/** Heading level from 1-6. */
|
|
5531
5685
|
level?: number;
|
|
@@ -5547,7 +5701,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
5547
5701
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
5548
5702
|
containerData?: PluginContainerData;
|
|
5549
5703
|
/** The type of HTML code. */
|
|
5550
|
-
source?:
|
|
5704
|
+
source?: HTMLDataSourceWithLiterals;
|
|
5551
5705
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
5552
5706
|
autoHeight?: boolean | null;
|
|
5553
5707
|
}
|
|
@@ -5567,6 +5721,8 @@ export declare enum HTMLDataSource {
|
|
|
5567
5721
|
HTML = "HTML",
|
|
5568
5722
|
ADSENSE = "ADSENSE"
|
|
5569
5723
|
}
|
|
5724
|
+
/** @enumType */
|
|
5725
|
+
export type HTMLDataSourceWithLiterals = HTMLDataSource | 'HTML' | 'ADSENSE';
|
|
5570
5726
|
export interface ImageData {
|
|
5571
5727
|
/** Styling for the image's container. */
|
|
5572
5728
|
containerData?: PluginContainerData;
|
|
@@ -5631,6 +5787,8 @@ export declare enum StylesPosition {
|
|
|
5631
5787
|
/** Thumbnail hidden and not displayed */
|
|
5632
5788
|
HIDDEN = "HIDDEN"
|
|
5633
5789
|
}
|
|
5790
|
+
/** @enumType */
|
|
5791
|
+
export type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
5634
5792
|
export interface LinkPreviewDataStyles {
|
|
5635
5793
|
/**
|
|
5636
5794
|
* Background color as a hexadecimal value.
|
|
@@ -5662,7 +5820,7 @@ export interface LinkPreviewDataStyles {
|
|
|
5662
5820
|
*/
|
|
5663
5821
|
borderColor?: string | null;
|
|
5664
5822
|
/** Position of thumbnail. Defaults to `START`. */
|
|
5665
|
-
thumbnailPosition?:
|
|
5823
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
5666
5824
|
}
|
|
5667
5825
|
export interface MapData {
|
|
5668
5826
|
/** Styling for the map's container. */
|
|
@@ -5692,7 +5850,7 @@ export interface MapSettings {
|
|
|
5692
5850
|
/** Initial zoom value. */
|
|
5693
5851
|
initialZoom?: number | null;
|
|
5694
5852
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
5695
|
-
mapType?:
|
|
5853
|
+
mapType?: MapTypeWithLiterals;
|
|
5696
5854
|
}
|
|
5697
5855
|
export declare enum MapType {
|
|
5698
5856
|
/** Roadmap map type */
|
|
@@ -5704,6 +5862,8 @@ export declare enum MapType {
|
|
|
5704
5862
|
/** Terrain map type */
|
|
5705
5863
|
TERRAIN = "TERRAIN"
|
|
5706
5864
|
}
|
|
5865
|
+
/** @enumType */
|
|
5866
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
5707
5867
|
export interface ParagraphData {
|
|
5708
5868
|
/** Styling for the paragraph text. */
|
|
5709
5869
|
textStyle?: V1TextStyle;
|
|
@@ -5730,17 +5890,21 @@ export declare enum ViewRole {
|
|
|
5730
5890
|
/** Anyone can see the results, even if one didn't vote */
|
|
5731
5891
|
EVERYONE = "EVERYONE"
|
|
5732
5892
|
}
|
|
5893
|
+
/** @enumType */
|
|
5894
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
5733
5895
|
export declare enum VoteRole {
|
|
5734
5896
|
/** Logged in member */
|
|
5735
5897
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
5736
5898
|
/** Anyone */
|
|
5737
5899
|
ALL = "ALL"
|
|
5738
5900
|
}
|
|
5901
|
+
/** @enumType */
|
|
5902
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
5739
5903
|
export interface SettingsPermissions {
|
|
5740
5904
|
/** Sets who can view the poll results. */
|
|
5741
|
-
view?:
|
|
5905
|
+
view?: ViewRoleWithLiterals;
|
|
5742
5906
|
/** Sets who can vote. */
|
|
5743
|
-
vote?:
|
|
5907
|
+
vote?: VoteRoleWithLiterals;
|
|
5744
5908
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
5745
5909
|
allowMultipleVotes?: boolean | null;
|
|
5746
5910
|
}
|
|
@@ -5766,17 +5930,21 @@ export declare enum PollLayoutType {
|
|
|
5766
5930
|
/** Grid */
|
|
5767
5931
|
GRID = "GRID"
|
|
5768
5932
|
}
|
|
5933
|
+
/** @enumType */
|
|
5934
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
5769
5935
|
export declare enum PollLayoutDirection {
|
|
5770
5936
|
/** Left-to-right */
|
|
5771
5937
|
LTR = "LTR",
|
|
5772
5938
|
/** Right-to-left */
|
|
5773
5939
|
RTL = "RTL"
|
|
5774
5940
|
}
|
|
5941
|
+
/** @enumType */
|
|
5942
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
5775
5943
|
export interface PollLayout {
|
|
5776
5944
|
/** The layout for displaying the voting options. */
|
|
5777
|
-
type?:
|
|
5945
|
+
type?: PollLayoutTypeWithLiterals;
|
|
5778
5946
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
5779
|
-
direction?:
|
|
5947
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
5780
5948
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
5781
5949
|
enableImage?: boolean | null;
|
|
5782
5950
|
}
|
|
@@ -5792,6 +5960,8 @@ export declare enum BackgroundType {
|
|
|
5792
5960
|
/** Gradiant background type */
|
|
5793
5961
|
GRADIENT = "GRADIENT"
|
|
5794
5962
|
}
|
|
5963
|
+
/** @enumType */
|
|
5964
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
5795
5965
|
export interface Gradient {
|
|
5796
5966
|
/** The gradient angle in degrees. */
|
|
5797
5967
|
angle?: number | null;
|
|
@@ -5817,7 +5987,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
5817
5987
|
/** Details for a gradient background. */
|
|
5818
5988
|
gradient?: Gradient;
|
|
5819
5989
|
/** Background type. For each option, include the relevant details. */
|
|
5820
|
-
type?:
|
|
5990
|
+
type?: BackgroundTypeWithLiterals;
|
|
5821
5991
|
}
|
|
5822
5992
|
/** @oneof */
|
|
5823
5993
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -5896,7 +6066,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
5896
6066
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
5897
6067
|
strikethroughData?: boolean | null;
|
|
5898
6068
|
/** The type of decoration to apply. */
|
|
5899
|
-
type?:
|
|
6069
|
+
type?: DecorationTypeWithLiterals;
|
|
5900
6070
|
}
|
|
5901
6071
|
/** @oneof */
|
|
5902
6072
|
export interface DecorationDataOneOf {
|
|
@@ -5934,6 +6104,8 @@ export declare enum DecorationType {
|
|
|
5934
6104
|
EXTERNAL = "EXTERNAL",
|
|
5935
6105
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
5936
6106
|
}
|
|
6107
|
+
/** @enumType */
|
|
6108
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
5937
6109
|
export interface AnchorData {
|
|
5938
6110
|
/** The target node's ID. */
|
|
5939
6111
|
anchor?: string;
|
|
@@ -5958,7 +6130,7 @@ export interface MentionData {
|
|
|
5958
6130
|
}
|
|
5959
6131
|
export interface FontSizeData {
|
|
5960
6132
|
/** The units used for the font size. */
|
|
5961
|
-
unit?:
|
|
6133
|
+
unit?: FontTypeWithLiterals;
|
|
5962
6134
|
/** Font size value. */
|
|
5963
6135
|
value?: number | null;
|
|
5964
6136
|
}
|
|
@@ -5966,6 +6138,8 @@ export declare enum FontType {
|
|
|
5966
6138
|
PX = "PX",
|
|
5967
6139
|
EM = "EM"
|
|
5968
6140
|
}
|
|
6141
|
+
/** @enumType */
|
|
6142
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
5969
6143
|
export interface SpoilerData {
|
|
5970
6144
|
/** Spoiler ID. */
|
|
5971
6145
|
id?: string | null;
|
|
@@ -5976,7 +6150,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
5976
6150
|
/** Data for embedded Wix Events content. */
|
|
5977
6151
|
eventData?: EventData;
|
|
5978
6152
|
/** The type of Wix App content being embedded. */
|
|
5979
|
-
type?:
|
|
6153
|
+
type?: AppTypeWithLiterals;
|
|
5980
6154
|
/** The ID of the embedded content. */
|
|
5981
6155
|
itemId?: string | null;
|
|
5982
6156
|
/** The name of the embedded content. */
|
|
@@ -6003,6 +6177,8 @@ export declare enum AppType {
|
|
|
6003
6177
|
EVENT = "EVENT",
|
|
6004
6178
|
BOOKING = "BOOKING"
|
|
6005
6179
|
}
|
|
6180
|
+
/** @enumType */
|
|
6181
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
6006
6182
|
export interface BookingData {
|
|
6007
6183
|
/** Booking duration in minutes. */
|
|
6008
6184
|
durations?: string | null;
|
|
@@ -6081,9 +6257,9 @@ export interface CollapsibleListData {
|
|
|
6081
6257
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
6082
6258
|
expandOnlyOne?: boolean | null;
|
|
6083
6259
|
/** Sets which items are expanded when the page loads. */
|
|
6084
|
-
initialExpandedItems?:
|
|
6260
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
6085
6261
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
6086
|
-
direction?:
|
|
6262
|
+
direction?: DirectionWithLiterals;
|
|
6087
6263
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
6088
6264
|
isQapageData?: boolean | null;
|
|
6089
6265
|
}
|
|
@@ -6095,12 +6271,16 @@ export declare enum InitialExpandedItems {
|
|
|
6095
6271
|
/** All items collapsed initally */
|
|
6096
6272
|
NONE = "NONE"
|
|
6097
6273
|
}
|
|
6274
|
+
/** @enumType */
|
|
6275
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
6098
6276
|
export declare enum Direction {
|
|
6099
6277
|
/** Left-to-right */
|
|
6100
6278
|
LTR = "LTR",
|
|
6101
6279
|
/** Right-to-left */
|
|
6102
6280
|
RTL = "RTL"
|
|
6103
6281
|
}
|
|
6282
|
+
/** @enumType */
|
|
6283
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
6104
6284
|
export interface TableData {
|
|
6105
6285
|
/** Styling for the table's container. */
|
|
6106
6286
|
containerData?: PluginContainerData;
|
|
@@ -6138,9 +6318,11 @@ export declare enum VerticalAlignment {
|
|
|
6138
6318
|
/** Bottom alignment */
|
|
6139
6319
|
BOTTOM = "BOTTOM"
|
|
6140
6320
|
}
|
|
6321
|
+
/** @enumType */
|
|
6322
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
6141
6323
|
export interface CellStyle {
|
|
6142
6324
|
/** Vertical alignment for the cell's text. */
|
|
6143
|
-
verticalAlignment?:
|
|
6325
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
6144
6326
|
/**
|
|
6145
6327
|
* Cell background color as a hexadecimal value.
|
|
6146
6328
|
* @format COLOR_HEX
|
|
@@ -6179,6 +6361,8 @@ export declare enum NullValue {
|
|
|
6179
6361
|
/** Null value. */
|
|
6180
6362
|
NULL_VALUE = "NULL_VALUE"
|
|
6181
6363
|
}
|
|
6364
|
+
/** @enumType */
|
|
6365
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
6182
6366
|
/**
|
|
6183
6367
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
6184
6368
|
*
|
|
@@ -6319,7 +6503,7 @@ export interface ComponentsValidatorConfig {
|
|
|
6319
6503
|
* @minSize 1
|
|
6320
6504
|
* @maxSize 100
|
|
6321
6505
|
*/
|
|
6322
|
-
componentValidationTypes?:
|
|
6506
|
+
componentValidationTypes?: ComponentTypeWithLiterals[];
|
|
6323
6507
|
/** Indicates whether the validation should affect real production */
|
|
6324
6508
|
testMode?: boolean;
|
|
6325
6509
|
}
|
|
@@ -6374,18 +6558,18 @@ export interface ProviderConfig {
|
|
|
6374
6558
|
/** The base URI in which all methods are deployed. */
|
|
6375
6559
|
baseUri?: string;
|
|
6376
6560
|
/** The provided calendar type. */
|
|
6377
|
-
calendarType?:
|
|
6561
|
+
calendarType?: CalendarTypeWithLiterals;
|
|
6378
6562
|
/**
|
|
6379
6563
|
* Connect methods used to connect to the calendar.
|
|
6380
6564
|
* @minSize 1
|
|
6381
6565
|
*/
|
|
6382
|
-
connectMethods?:
|
|
6566
|
+
connectMethods?: ConnectMethodWithLiterals[];
|
|
6383
6567
|
/** Whether the sync configuration can be updated. */
|
|
6384
6568
|
canUpdateSyncConfig?: boolean;
|
|
6385
6569
|
/** Whether events can be listed from the external calendar to the Wix calendar. */
|
|
6386
|
-
listEventFromCalendars?:
|
|
6570
|
+
listEventFromCalendars?: ListEventFromCalendarsWithLiterals;
|
|
6387
6571
|
/** Whether Wix calendar sessions can be synced to the external calendar. */
|
|
6388
|
-
syncToCalendar?:
|
|
6572
|
+
syncToCalendar?: SyncToCalendarWithLiterals;
|
|
6389
6573
|
}
|
|
6390
6574
|
export declare enum CalendarType {
|
|
6391
6575
|
UNDEFINED = "UNDEFINED",
|
|
@@ -6394,10 +6578,14 @@ export declare enum CalendarType {
|
|
|
6394
6578
|
MICROSOFT = "MICROSOFT",
|
|
6395
6579
|
OTHER = "OTHER"
|
|
6396
6580
|
}
|
|
6581
|
+
/** @enumType */
|
|
6582
|
+
export type CalendarTypeWithLiterals = CalendarType | 'UNDEFINED' | 'GOOGLE' | 'I_CAL' | 'MICROSOFT' | 'OTHER';
|
|
6397
6583
|
export declare enum ConnectMethod {
|
|
6398
6584
|
OAUTH = "OAUTH",
|
|
6399
6585
|
CREDENTIALS = "CREDENTIALS"
|
|
6400
6586
|
}
|
|
6587
|
+
/** @enumType */
|
|
6588
|
+
export type ConnectMethodWithLiterals = ConnectMethod | 'OAUTH' | 'CREDENTIALS';
|
|
6401
6589
|
export declare enum ListEventFromCalendars {
|
|
6402
6590
|
/** Listing events from the external calendar is not supported. */
|
|
6403
6591
|
LIST_NOT_SUPPORTED = "LIST_NOT_SUPPORTED",
|
|
@@ -6409,6 +6597,8 @@ export declare enum ListEventFromCalendars {
|
|
|
6409
6597
|
*/
|
|
6410
6598
|
LIST_FROM_SPECIFIC_CALENDARS = "LIST_FROM_SPECIFIC_CALENDARS"
|
|
6411
6599
|
}
|
|
6600
|
+
/** @enumType */
|
|
6601
|
+
export type ListEventFromCalendarsWithLiterals = ListEventFromCalendars | 'LIST_NOT_SUPPORTED' | 'LIST_FROM_PRIMARY_CALENDAR_ONLY' | 'LIST_FROM_SPECIFIC_CALENDARS';
|
|
6412
6602
|
export declare enum SyncToCalendar {
|
|
6413
6603
|
/** Syncing Wix calendar sessions to the external calendar is not supported. */
|
|
6414
6604
|
SYNC_NOT_SUPPORTED = "SYNC_NOT_SUPPORTED",
|
|
@@ -6417,6 +6607,8 @@ export declare enum SyncToCalendar {
|
|
|
6417
6607
|
/** Syncing Wix calendar sessions to a new external calendar. */
|
|
6418
6608
|
SYNC_TO_DEDICATED_CALENDAR = "SYNC_TO_DEDICATED_CALENDAR"
|
|
6419
6609
|
}
|
|
6610
|
+
/** @enumType */
|
|
6611
|
+
export type SyncToCalendarWithLiterals = SyncToCalendar | 'SYNC_NOT_SUPPORTED' | 'SYNC_TO_PRIMARY_CALENDAR_ONLY' | 'SYNC_TO_DEDICATED_CALENDAR';
|
|
6420
6612
|
export interface DefaultTaxGroupProviderConfig {
|
|
6421
6613
|
/** URI where the SPI Implementer is deployed */
|
|
6422
6614
|
deploymentUri?: string;
|
|
@@ -6464,9 +6656,9 @@ export interface HeadlessOAuth {
|
|
|
6464
6656
|
*/
|
|
6465
6657
|
logoutUrl?: string | null;
|
|
6466
6658
|
/** OAuth application type. */
|
|
6467
|
-
applicationType?:
|
|
6659
|
+
applicationType?: OAuthAppTypeWithLiterals;
|
|
6468
6660
|
/** OAuth technology used by the application. */
|
|
6469
|
-
technology?:
|
|
6661
|
+
technology?: OAuthTechnologiesWithLiterals;
|
|
6470
6662
|
}
|
|
6471
6663
|
/** Types of OAuth application. */
|
|
6472
6664
|
export declare enum OAuthAppType {
|
|
@@ -6479,6 +6671,8 @@ export declare enum OAuthAppType {
|
|
|
6479
6671
|
/** OAuth app type is some other type of application. */
|
|
6480
6672
|
OTHER = "OTHER"
|
|
6481
6673
|
}
|
|
6674
|
+
/** @enumType */
|
|
6675
|
+
export type OAuthAppTypeWithLiterals = OAuthAppType | 'OAUTH_APP_TYPE_UNSPECIFIED' | 'WEB_APP' | 'MOBILE' | 'OTHER';
|
|
6482
6676
|
/** OAuth technology used by the oauth application. */
|
|
6483
6677
|
export declare enum OAuthTechnologies {
|
|
6484
6678
|
/** The OAuth technology is not specified. */
|
|
@@ -6500,6 +6694,8 @@ export declare enum OAuthTechnologies {
|
|
|
6500
6694
|
/** OAuth technology using some other kind of technology. */
|
|
6501
6695
|
OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
|
|
6502
6696
|
}
|
|
6697
|
+
/** @enumType */
|
|
6698
|
+
export type OAuthTechnologiesWithLiterals = OAuthTechnologies | 'OAUTH_TECHNOLOGY_UNSPECIFIED' | 'JAVASCRIPT' | 'ANGULAR' | 'VUE' | 'REACT' | 'REACT_NATIVE' | 'IOS' | 'ANDROID' | 'OTHER_TECHNOLOGY';
|
|
6503
6699
|
export interface TaxCalculatorSpiConfig {
|
|
6504
6700
|
/** URI where the SPI Implementer is deployed */
|
|
6505
6701
|
deploymentUri?: string;
|
|
@@ -6574,7 +6770,7 @@ export interface ComponentReferenceDataConfig {
|
|
|
6574
6770
|
* @minSize 1
|
|
6575
6771
|
* @maxSize 100
|
|
6576
6772
|
*/
|
|
6577
|
-
supportedComponentTypes?:
|
|
6773
|
+
supportedComponentTypes?: ComponentTypeWithLiterals[];
|
|
6578
6774
|
}
|
|
6579
6775
|
/** Configuration for ReviewsProductCatalogProvider */
|
|
6580
6776
|
export interface ReviewsProductCatalogProviderConfig {
|
|
@@ -6609,7 +6805,7 @@ export interface SocialMarketingDesignsProviderConfig {
|
|
|
6609
6805
|
*/
|
|
6610
6806
|
iconUrl?: string;
|
|
6611
6807
|
/** How the Prover should be opened */
|
|
6612
|
-
navigationType?:
|
|
6808
|
+
navigationType?: NavigationTypeWithLiterals;
|
|
6613
6809
|
/** Is delete design implemented by the provider */
|
|
6614
6810
|
deleteDesignEnabled?: boolean;
|
|
6615
6811
|
/** If the provider manages designs */
|
|
@@ -6619,6 +6815,8 @@ export declare enum NavigationType {
|
|
|
6619
6815
|
NAVIGATE = "NAVIGATE",
|
|
6620
6816
|
MODAL = "MODAL"
|
|
6621
6817
|
}
|
|
6818
|
+
/** @enumType */
|
|
6819
|
+
export type NavigationTypeWithLiterals = NavigationType | 'NAVIGATE' | 'MODAL';
|
|
6622
6820
|
export interface GbpFeatureConfig {
|
|
6623
6821
|
baseUri?: SpiBaseUri;
|
|
6624
6822
|
}
|
|
@@ -6646,13 +6844,15 @@ export interface PingSettingsGroupComponentData {
|
|
|
6646
6844
|
/** the description of the setting group */
|
|
6647
6845
|
description?: string | null;
|
|
6648
6846
|
/** the default state of the setting group */
|
|
6649
|
-
state?:
|
|
6847
|
+
state?: PingSettingsGroupComponentDataStateWithLiterals;
|
|
6650
6848
|
}
|
|
6651
6849
|
export declare enum PingSettingsGroupComponentDataState {
|
|
6652
6850
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6653
6851
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6654
6852
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6655
6853
|
}
|
|
6854
|
+
/** @enumType */
|
|
6855
|
+
export type PingSettingsGroupComponentDataStateWithLiterals = PingSettingsGroupComponentDataState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6656
6856
|
export interface FormSpamSubmissionSpiConfig {
|
|
6657
6857
|
/** URI where the SPI Implementer is deployed */
|
|
6658
6858
|
baseUri?: SpiBaseUri;
|
|
@@ -6800,25 +7000,29 @@ export interface NotificationTopic {
|
|
|
6800
7000
|
/** the description of the topic */
|
|
6801
7001
|
description?: string | null;
|
|
6802
7002
|
/** the default state of the topic */
|
|
6803
|
-
state?:
|
|
7003
|
+
state?: NotificationTopicStateWithLiterals;
|
|
6804
7004
|
/** the type of the topic */
|
|
6805
|
-
type?:
|
|
7005
|
+
type?: NotificationTopicTypeWithLiterals;
|
|
6806
7006
|
/**
|
|
6807
7007
|
* The recipients' types indicate that this topic is relevant.
|
|
6808
7008
|
* @maxSize 10
|
|
6809
7009
|
*/
|
|
6810
|
-
supportedRecipientTypes?:
|
|
7010
|
+
supportedRecipientTypes?: RecipientTypeWithLiterals[];
|
|
6811
7011
|
}
|
|
6812
7012
|
export declare enum NotificationTopicState {
|
|
6813
7013
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
6814
7014
|
DEFAULT_ON = "DEFAULT_ON",
|
|
6815
7015
|
DEFAULT_OFF = "DEFAULT_OFF"
|
|
6816
7016
|
}
|
|
7017
|
+
/** @enumType */
|
|
7018
|
+
export type NotificationTopicStateWithLiterals = NotificationTopicState | 'UNKNOWN_STATE' | 'DEFAULT_ON' | 'DEFAULT_OFF';
|
|
6817
7019
|
export declare enum NotificationTopicType {
|
|
6818
7020
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
6819
7021
|
PROMOTIONAL = "PROMOTIONAL",
|
|
6820
7022
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
6821
7023
|
}
|
|
7024
|
+
/** @enumType */
|
|
7025
|
+
export type NotificationTopicTypeWithLiterals = NotificationTopicType | 'UNKNOWN_TYPE' | 'PROMOTIONAL' | 'TRANSACTIONAL';
|
|
6822
7026
|
/** Recipient type */
|
|
6823
7027
|
export declare enum RecipientType {
|
|
6824
7028
|
/** Wix User */
|
|
@@ -6826,6 +7030,8 @@ export declare enum RecipientType {
|
|
|
6826
7030
|
/** Contact */
|
|
6827
7031
|
CONTACT = "CONTACT"
|
|
6828
7032
|
}
|
|
7033
|
+
/** @enumType */
|
|
7034
|
+
export type RecipientTypeWithLiterals = RecipientType | 'WIX_USER' | 'CONTACT';
|
|
6829
7035
|
export interface NotificationPreferencesFilterConfig {
|
|
6830
7036
|
/** the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider" */
|
|
6831
7037
|
baseUri?: SpiBaseUri;
|
|
@@ -7148,6 +7354,8 @@ export declare enum PlanFormPricingOption {
|
|
|
7148
7354
|
ONE_TIME = "ONE_TIME",
|
|
7149
7355
|
RECURRING = "RECURRING"
|
|
7150
7356
|
}
|
|
7357
|
+
/** @enumType */
|
|
7358
|
+
export type PlanFormPricingOptionWithLiterals = PlanFormPricingOption | 'FREE' | 'ONE_TIME' | 'RECURRING';
|
|
7151
7359
|
export declare enum PlanFormDefaultSection {
|
|
7152
7360
|
INFO = "INFO",
|
|
7153
7361
|
BENEFITS = "BENEFITS",
|
|
@@ -7155,6 +7363,8 @@ export declare enum PlanFormDefaultSection {
|
|
|
7155
7363
|
PRICING_AND_DURATION = "PRICING_AND_DURATION",
|
|
7156
7364
|
ADVANCED_SETTINGS = "ADVANCED_SETTINGS"
|
|
7157
7365
|
}
|
|
7366
|
+
/** @enumType */
|
|
7367
|
+
export type PlanFormDefaultSectionWithLiterals = PlanFormDefaultSection | 'INFO' | 'BENEFITS' | 'PAGE_PERMISSIONS' | 'PRICING_AND_DURATION' | 'ADVANCED_SETTINGS';
|
|
7158
7368
|
export interface Illustration extends IllustrationIllustrationOneOf {
|
|
7159
7369
|
/**
|
|
7160
7370
|
* Custom exported component ID to be rendered as an illustration.
|
|
@@ -7178,7 +7388,7 @@ export interface PlanDuration {
|
|
|
7178
7388
|
/** Amount of a duration `unit` in a single payment cycle. */
|
|
7179
7389
|
count?: number;
|
|
7180
7390
|
/** Unit of time for the cycle duration. */
|
|
7181
|
-
unit?:
|
|
7391
|
+
unit?: PlanPeriodUnitWithLiterals;
|
|
7182
7392
|
}
|
|
7183
7393
|
/** Pedefined basic time unit. */
|
|
7184
7394
|
export declare enum PlanPeriodUnit {
|
|
@@ -7187,6 +7397,8 @@ export declare enum PlanPeriodUnit {
|
|
|
7187
7397
|
MONTH = "MONTH",
|
|
7188
7398
|
YEAR = "YEAR"
|
|
7189
7399
|
}
|
|
7400
|
+
/** @enumType */
|
|
7401
|
+
export type PlanPeriodUnitWithLiterals = PlanPeriodUnit | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
7190
7402
|
export interface PlanPriceData {
|
|
7191
7403
|
/** Monetary amount. Decimal string with a period as a decimal separator. For example, `3.99`. */
|
|
7192
7404
|
value?: string;
|
|
@@ -7309,7 +7521,7 @@ export interface PlanFormPricingAndDurationSection {
|
|
|
7309
7521
|
* Order in which pricing options should be displayed.
|
|
7310
7522
|
* @maxSize 99
|
|
7311
7523
|
*/
|
|
7312
|
-
pricingOptionOrder?:
|
|
7524
|
+
pricingOptionOrder?: PlanFormPricingOptionWithLiterals[];
|
|
7313
7525
|
}
|
|
7314
7526
|
export interface PlanFormCustomSection {
|
|
7315
7527
|
/**
|
|
@@ -7323,14 +7535,14 @@ export interface PlanFormSection extends PlanFormSectionSectionOneOf {
|
|
|
7323
7535
|
/** Extension component ID. */
|
|
7324
7536
|
componentId?: string;
|
|
7325
7537
|
/** Default section name. */
|
|
7326
|
-
sectionName?:
|
|
7538
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7327
7539
|
}
|
|
7328
7540
|
/** @oneof */
|
|
7329
7541
|
export interface PlanFormSectionSectionOneOf {
|
|
7330
7542
|
/** Extension component ID. */
|
|
7331
7543
|
componentId?: string;
|
|
7332
7544
|
/** Default section name. */
|
|
7333
|
-
sectionName?:
|
|
7545
|
+
sectionName?: PlanFormDefaultSectionWithLiterals;
|
|
7334
7546
|
}
|
|
7335
7547
|
export interface PlanFormTypeMetadata {
|
|
7336
7548
|
/** Configuration name. */
|
|
@@ -7397,7 +7609,7 @@ export interface UserNotificationData {
|
|
|
7397
7609
|
/** icon */
|
|
7398
7610
|
icon?: Icon;
|
|
7399
7611
|
/** intent */
|
|
7400
|
-
intent?:
|
|
7612
|
+
intent?: IntentWithLiterals;
|
|
7401
7613
|
/** limiter field */
|
|
7402
7614
|
limiterField?: LimiterField;
|
|
7403
7615
|
/** recipient filter */
|
|
@@ -7411,7 +7623,7 @@ export interface UserNotificationData {
|
|
|
7411
7623
|
/** context */
|
|
7412
7624
|
context?: UserNotificationDataContext;
|
|
7413
7625
|
/** type */
|
|
7414
|
-
type?:
|
|
7626
|
+
type?: UserNotificationDataTypeWithLiterals;
|
|
7415
7627
|
}
|
|
7416
7628
|
export interface TypedDynamicParam {
|
|
7417
7629
|
/**
|
|
@@ -7420,16 +7632,20 @@ export interface TypedDynamicParam {
|
|
|
7420
7632
|
*/
|
|
7421
7633
|
name?: string;
|
|
7422
7634
|
/** dynamic param type */
|
|
7423
|
-
dynamicParamType?:
|
|
7635
|
+
dynamicParamType?: TypedDynamicParamTypeWithLiterals;
|
|
7424
7636
|
}
|
|
7425
7637
|
export declare enum TypedDynamicParamType {
|
|
7426
7638
|
STRING = "STRING",
|
|
7427
7639
|
ARRAY = "ARRAY"
|
|
7428
7640
|
}
|
|
7641
|
+
/** @enumType */
|
|
7642
|
+
export type TypedDynamicParamTypeWithLiterals = TypedDynamicParamType | 'STRING' | 'ARRAY';
|
|
7429
7643
|
export declare enum UserNotificationDataRecipientFilterType {
|
|
7430
7644
|
WIX_USERS = "WIX_USERS",
|
|
7431
7645
|
SITE_CONTRIBUTORS = "SITE_CONTRIBUTORS"
|
|
7432
7646
|
}
|
|
7647
|
+
/** @enumType */
|
|
7648
|
+
export type UserNotificationDataRecipientFilterTypeWithLiterals = UserNotificationDataRecipientFilterType | 'WIX_USERS' | 'SITE_CONTRIBUTORS';
|
|
7433
7649
|
export interface WixUsersData {
|
|
7434
7650
|
/** id */
|
|
7435
7651
|
id?: TypedDynamicParam;
|
|
@@ -7442,6 +7658,8 @@ export declare enum InitiatorType {
|
|
|
7442
7658
|
WIX_USER = "WIX_USER",
|
|
7443
7659
|
WIX_APP = "WIX_APP"
|
|
7444
7660
|
}
|
|
7661
|
+
/** @enumType */
|
|
7662
|
+
export type InitiatorTypeWithLiterals = InitiatorType | 'WIX_USER' | 'WIX_APP';
|
|
7445
7663
|
export interface WixUserData {
|
|
7446
7664
|
/**
|
|
7447
7665
|
* dynamic param name
|
|
@@ -7490,6 +7708,8 @@ export declare enum Level {
|
|
|
7490
7708
|
ACCOUNT = "ACCOUNT",
|
|
7491
7709
|
SITE = "SITE"
|
|
7492
7710
|
}
|
|
7711
|
+
/** @enumType */
|
|
7712
|
+
export type LevelWithLiterals = Level | 'ACCOUNT' | 'SITE';
|
|
7493
7713
|
export interface OrderValue {
|
|
7494
7714
|
/** can be const/dynamicParamName */
|
|
7495
7715
|
value?: ConstOrDynamicParam;
|
|
@@ -7605,7 +7825,7 @@ export interface Icon extends IconDataOneOf {
|
|
|
7605
7825
|
/** url data */
|
|
7606
7826
|
urlData?: UrlData;
|
|
7607
7827
|
/** icon type */
|
|
7608
|
-
type?:
|
|
7828
|
+
type?: IconTypeWithLiterals;
|
|
7609
7829
|
}
|
|
7610
7830
|
/** @oneof */
|
|
7611
7831
|
export interface IconDataOneOf {
|
|
@@ -7617,6 +7837,8 @@ export declare enum IconType {
|
|
|
7617
7837
|
SPOUT = "SPOUT",
|
|
7618
7838
|
INITIATOR = "INITIATOR"
|
|
7619
7839
|
}
|
|
7840
|
+
/** @enumType */
|
|
7841
|
+
export type IconTypeWithLiterals = IconType | 'URL' | 'SPOUT' | 'INITIATOR';
|
|
7620
7842
|
export interface UrlData {
|
|
7621
7843
|
/**
|
|
7622
7844
|
* actual url
|
|
@@ -7644,7 +7866,7 @@ export interface SharedPlatformMobilePushConfig {
|
|
|
7644
7866
|
/** ttl */
|
|
7645
7867
|
ttl?: number | null;
|
|
7646
7868
|
/** target application */
|
|
7647
|
-
targetApplication?:
|
|
7869
|
+
targetApplication?: MobileApplicationWithLiterals;
|
|
7648
7870
|
}
|
|
7649
7871
|
export declare enum MobileApplication {
|
|
7650
7872
|
UNKNOWN_MOBILE_APPLICATION = "UNKNOWN_MOBILE_APPLICATION",
|
|
@@ -7658,11 +7880,13 @@ export declare enum MobileApplication {
|
|
|
7658
7880
|
WIX_STUDIO = "WIX_STUDIO",
|
|
7659
7881
|
NO_SPECIFIC_TARGET_APP = "NO_SPECIFIC_TARGET_APP"
|
|
7660
7882
|
}
|
|
7883
|
+
/** @enumType */
|
|
7884
|
+
export type MobileApplicationWithLiterals = MobileApplication | 'UNKNOWN_MOBILE_APPLICATION' | 'OWNER' | 'SPACES' | 'DINE' | 'FITNESS' | 'WIX_LIFE' | 'WIX_PARTNERS' | 'BRANDED' | 'WIX_STUDIO' | 'NO_SPECIFIC_TARGET_APP';
|
|
7661
7885
|
export interface AndroidMobilePushConfig {
|
|
7662
7886
|
/** sub group key */
|
|
7663
7887
|
subGroupKey?: string | null;
|
|
7664
7888
|
/** style */
|
|
7665
|
-
style?:
|
|
7889
|
+
style?: AndroidStyleWithLiterals;
|
|
7666
7890
|
/** grouped deeplink pattern */
|
|
7667
7891
|
groupedDeeplinkPattern?: string | null;
|
|
7668
7892
|
}
|
|
@@ -7671,6 +7895,8 @@ export declare enum AndroidStyle {
|
|
|
7671
7895
|
MESSAGING = "MESSAGING",
|
|
7672
7896
|
INBOX = "INBOX"
|
|
7673
7897
|
}
|
|
7898
|
+
/** @enumType */
|
|
7899
|
+
export type AndroidStyleWithLiterals = AndroidStyle | 'BIG_TEXT' | 'MESSAGING' | 'INBOX';
|
|
7674
7900
|
export interface MobilePushChannelConfig {
|
|
7675
7901
|
/** shared */
|
|
7676
7902
|
shared?: SharedPlatformMobilePushConfig;
|
|
@@ -7695,7 +7921,7 @@ export interface ExposureRule extends ExposureRuleRuleOneOf {
|
|
|
7695
7921
|
/** custom experiment exposure rule */
|
|
7696
7922
|
customExperimentExposureRule?: CustomExperimentExposureRule;
|
|
7697
7923
|
/** type */
|
|
7698
|
-
type?:
|
|
7924
|
+
type?: ExposureRuleTypeWithLiterals;
|
|
7699
7925
|
}
|
|
7700
7926
|
/** @oneof */
|
|
7701
7927
|
export interface ExposureRuleRuleOneOf {
|
|
@@ -7710,6 +7936,8 @@ export declare enum ExposureRuleType {
|
|
|
7710
7936
|
BOOLEAN_EXPERIMENT = "BOOLEAN_EXPERIMENT",
|
|
7711
7937
|
CUSTOM_EXPERIMENT = "CUSTOM_EXPERIMENT"
|
|
7712
7938
|
}
|
|
7939
|
+
/** @enumType */
|
|
7940
|
+
export type ExposureRuleTypeWithLiterals = ExposureRuleType | 'OPEN_TO_ALL' | 'OPEN_TO_NONE' | 'BOOLEAN_EXPERIMENT' | 'CUSTOM_EXPERIMENT';
|
|
7713
7941
|
export interface BooleanExperimentExposureRule {
|
|
7714
7942
|
/** spec */
|
|
7715
7943
|
spec?: string;
|
|
@@ -7770,6 +7998,8 @@ export declare enum Intent {
|
|
|
7770
7998
|
MARKETING = "MARKETING",
|
|
7771
7999
|
TRANSACTIONAL = "TRANSACTIONAL"
|
|
7772
8000
|
}
|
|
8001
|
+
/** @enumType */
|
|
8002
|
+
export type IntentWithLiterals = Intent | 'MARKETING' | 'TRANSACTIONAL';
|
|
7773
8003
|
export interface LimiterField {
|
|
7774
8004
|
/** dynamic param name */
|
|
7775
8005
|
dynamicParamName?: string;
|
|
@@ -7780,7 +8010,7 @@ export interface UserNotificationDataRecipientFilter extends UserNotificationDat
|
|
|
7780
8010
|
/** site contributors data */
|
|
7781
8011
|
siteContributorsData?: SiteContributorsData;
|
|
7782
8012
|
/** recipient filter type */
|
|
7783
|
-
type?:
|
|
8013
|
+
type?: UserNotificationDataRecipientFilterTypeWithLiterals;
|
|
7784
8014
|
}
|
|
7785
8015
|
/** @oneof */
|
|
7786
8016
|
export interface UserNotificationDataRecipientFilterDataOneOf {
|
|
@@ -7793,7 +8023,7 @@ export interface UserNotificationDataInitiator extends UserNotificationDataIniti
|
|
|
7793
8023
|
/** wix user data */
|
|
7794
8024
|
wixUserData?: WixUserData;
|
|
7795
8025
|
/** initiator type */
|
|
7796
|
-
type?:
|
|
8026
|
+
type?: InitiatorTypeWithLiterals;
|
|
7797
8027
|
}
|
|
7798
8028
|
/** @oneof */
|
|
7799
8029
|
export interface UserNotificationDataInitiatorDataOneOf {
|
|
@@ -7810,7 +8040,7 @@ export interface UserNotificationDataDeeplinkOfOneOf {
|
|
|
7810
8040
|
url?: Url;
|
|
7811
8041
|
}
|
|
7812
8042
|
export interface UserNotificationDataContext {
|
|
7813
|
-
level?:
|
|
8043
|
+
level?: LevelWithLiterals;
|
|
7814
8044
|
/** params */
|
|
7815
8045
|
params?: Record<string, OrderValue>;
|
|
7816
8046
|
}
|
|
@@ -7819,6 +8049,8 @@ export declare enum UserNotificationDataType {
|
|
|
7819
8049
|
ALERT_WARNING = "ALERT_WARNING",
|
|
7820
8050
|
ALERT_INFO = "ALERT_INFO"
|
|
7821
8051
|
}
|
|
8052
|
+
/** @enumType */
|
|
8053
|
+
export type UserNotificationDataTypeWithLiterals = UserNotificationDataType | 'REGULAR' | 'ALERT_WARNING' | 'ALERT_INFO';
|
|
7822
8054
|
/** Describes contact notifications */
|
|
7823
8055
|
export interface ContactNotification {
|
|
7824
8056
|
/** @format GUID */
|
|
@@ -7859,6 +8091,8 @@ export declare enum RecipientFilterType {
|
|
|
7859
8091
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
7860
8092
|
CONTACTS = "CONTACTS"
|
|
7861
8093
|
}
|
|
8094
|
+
/** @enumType */
|
|
8095
|
+
export type RecipientFilterTypeWithLiterals = RecipientFilterType | 'UNKNOWN_TYPE' | 'CONTACTS';
|
|
7862
8096
|
export interface ContactsData {
|
|
7863
8097
|
/** id */
|
|
7864
8098
|
id?: TypedDynamicParam;
|
|
@@ -7868,6 +8102,8 @@ export declare enum Type {
|
|
|
7868
8102
|
CONTACT = "CONTACT",
|
|
7869
8103
|
SITE_MEMBER = "SITE_MEMBER"
|
|
7870
8104
|
}
|
|
8105
|
+
/** @enumType */
|
|
8106
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'CONTACT' | 'SITE_MEMBER';
|
|
7871
8107
|
export interface ContactData {
|
|
7872
8108
|
/**
|
|
7873
8109
|
* dynamic param name
|
|
@@ -7898,7 +8134,7 @@ export interface RecipientFilter extends RecipientFilterDataOneOf {
|
|
|
7898
8134
|
/** contacts data */
|
|
7899
8135
|
contactsData?: ContactsData;
|
|
7900
8136
|
/** recipient filter type */
|
|
7901
|
-
type?:
|
|
8137
|
+
type?: RecipientFilterTypeWithLiterals;
|
|
7902
8138
|
}
|
|
7903
8139
|
/** @oneof */
|
|
7904
8140
|
export interface RecipientFilterDataOneOf {
|
|
@@ -7911,7 +8147,7 @@ export interface Initiator extends InitiatorDataOneOf {
|
|
|
7911
8147
|
/** site member data */
|
|
7912
8148
|
siteMemberData?: SiteMemberData;
|
|
7913
8149
|
/** initiator type */
|
|
7914
|
-
type?:
|
|
8150
|
+
type?: TypeWithLiterals;
|
|
7915
8151
|
}
|
|
7916
8152
|
/** @oneof */
|
|
7917
8153
|
export interface InitiatorDataOneOf {
|
|
@@ -8029,7 +8265,7 @@ export interface CommentsContextProviderConfig {
|
|
|
8029
8265
|
/** URI where the SPI Implementer is deployed */
|
|
8030
8266
|
baseUri?: SpiBaseUri;
|
|
8031
8267
|
/** Comments Environment */
|
|
8032
|
-
environment?:
|
|
8268
|
+
environment?: EnvironmentWithLiterals;
|
|
8033
8269
|
/** Feature toggle to indicate if method GetCommentContextResources is implemented */
|
|
8034
8270
|
toggleResourceProviderEnabled?: boolean;
|
|
8035
8271
|
}
|
|
@@ -8037,6 +8273,8 @@ export declare enum Environment {
|
|
|
8037
8273
|
LIVE_SITE = "LIVE_SITE",
|
|
8038
8274
|
BUSINESS_MANAGER = "BUSINESS_MANAGER"
|
|
8039
8275
|
}
|
|
8276
|
+
/** @enumType */
|
|
8277
|
+
export type EnvironmentWithLiterals = Environment | 'LIVE_SITE' | 'BUSINESS_MANAGER';
|
|
8040
8278
|
export interface FormSpamSubmissionReportSpiConfig {
|
|
8041
8279
|
/** URI where the SPI Implementer is deployed */
|
|
8042
8280
|
baseUri?: SpiBaseUri;
|
|
@@ -8258,7 +8496,7 @@ export interface SchemaKey {
|
|
|
8258
8496
|
* + `SITE`: A custom schema for a specific site.
|
|
8259
8497
|
* @immutable
|
|
8260
8498
|
*/
|
|
8261
|
-
scope?:
|
|
8499
|
+
scope?: SchemaScopeWithLiterals;
|
|
8262
8500
|
}
|
|
8263
8501
|
export declare enum SchemaScope {
|
|
8264
8502
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
@@ -8267,6 +8505,8 @@ export declare enum SchemaScope {
|
|
|
8267
8505
|
/** Custom schema for a specific site. */
|
|
8268
8506
|
SITE = "SITE"
|
|
8269
8507
|
}
|
|
8508
|
+
/** @enumType */
|
|
8509
|
+
export type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
|
|
8270
8510
|
export interface V1SchemaField {
|
|
8271
8511
|
/**
|
|
8272
8512
|
* Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
|
|
@@ -8276,7 +8516,7 @@ export interface V1SchemaField {
|
|
|
8276
8516
|
*/
|
|
8277
8517
|
id?: string;
|
|
8278
8518
|
/** **Required.** Field type. */
|
|
8279
|
-
type?:
|
|
8519
|
+
type?: SchemaFieldFieldTypeWithLiterals;
|
|
8280
8520
|
/**
|
|
8281
8521
|
* Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager).
|
|
8282
8522
|
* @maxLength 1000
|
|
@@ -8330,6 +8570,8 @@ export declare enum SchemaFieldFieldType {
|
|
|
8330
8570
|
/** Wix Media Manager document. */
|
|
8331
8571
|
DOCUMENT = "DOCUMENT"
|
|
8332
8572
|
}
|
|
8573
|
+
/** @enumType */
|
|
8574
|
+
export type SchemaFieldFieldTypeWithLiterals = SchemaFieldFieldType | 'UNDEFINED_TYPE' | 'SHORT_TEXT' | 'LONG_TEXT' | 'HTML' | 'RICH_CONTENT' | 'IMAGE' | 'IMAGE_LINK' | 'VIDEO' | 'DOCUMENT';
|
|
8333
8575
|
export interface PreviewFields {
|
|
8334
8576
|
/**
|
|
8335
8577
|
* ID of the field representing the schema's title.
|
|
@@ -8401,7 +8643,7 @@ export interface BackOfficeModal extends BackOfficeModalContentOneOf {
|
|
|
8401
8643
|
*
|
|
8402
8644
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8403
8645
|
*/
|
|
8404
|
-
hostingPlatform?:
|
|
8646
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8405
8647
|
/**
|
|
8406
8648
|
* Modal title.
|
|
8407
8649
|
* @minLength 1
|
|
@@ -8488,7 +8730,7 @@ export interface WidgetData {
|
|
|
8488
8730
|
*/
|
|
8489
8731
|
tagName?: string;
|
|
8490
8732
|
/** Type of JavaScript modularization approach used in the custom element */
|
|
8491
|
-
scriptType?:
|
|
8733
|
+
scriptType?: CustomElementScriptTypeWithLiterals;
|
|
8492
8734
|
}
|
|
8493
8735
|
export declare enum CustomElementScriptType {
|
|
8494
8736
|
NONE = "NONE",
|
|
@@ -8497,6 +8739,8 @@ export declare enum CustomElementScriptType {
|
|
|
8497
8739
|
/** ES Module modularization approach */
|
|
8498
8740
|
ES_MODULE = "ES_MODULE"
|
|
8499
8741
|
}
|
|
8742
|
+
/** @enumType */
|
|
8743
|
+
export type CustomElementScriptTypeWithLiterals = CustomElementScriptType | 'NONE' | 'COMMON_JS' | 'ES_MODULE';
|
|
8500
8744
|
export interface EditorBehaviors {
|
|
8501
8745
|
/** The settings behavior definition for the widget */
|
|
8502
8746
|
settings?: SettingsPanel;
|
|
@@ -8530,9 +8774,11 @@ export declare enum HeightMode {
|
|
|
8530
8774
|
/** Height is fixed require size in px */
|
|
8531
8775
|
FIXED = "FIXED"
|
|
8532
8776
|
}
|
|
8777
|
+
/** @enumType */
|
|
8778
|
+
export type HeightModeWithLiterals = HeightMode | 'UNKNOWN' | 'AUTO' | 'FIXED';
|
|
8533
8779
|
export interface WidgetSizeHeight {
|
|
8534
8780
|
/** Height calculation mode */
|
|
8535
|
-
heightMode?:
|
|
8781
|
+
heightMode?: HeightModeWithLiterals;
|
|
8536
8782
|
/**
|
|
8537
8783
|
* Default height in pixels
|
|
8538
8784
|
* @max 9999
|
|
@@ -8600,7 +8846,7 @@ export interface BackOfficeExtensionWidget extends BackOfficeExtensionWidgetAsse
|
|
|
8600
8846
|
*
|
|
8601
8847
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8602
8848
|
*/
|
|
8603
|
-
hostingPlatform?:
|
|
8849
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8604
8850
|
/**
|
|
8605
8851
|
* Slot ID for the plugin's container.
|
|
8606
8852
|
* @format GUID
|
|
@@ -8632,7 +8878,7 @@ export interface BackOfficeExtensionMenuItem {
|
|
|
8632
8878
|
*
|
|
8633
8879
|
* Must be `"BUSINESS_MANAGER"`.
|
|
8634
8880
|
*/
|
|
8635
|
-
hostingPlatform?:
|
|
8881
|
+
hostingPlatform?: BackOfficeHostingPlatformsWithLiterals;
|
|
8636
8882
|
/**
|
|
8637
8883
|
* Slot ID for the plugin's container.
|
|
8638
8884
|
* @format GUID
|
|
@@ -8736,7 +8982,7 @@ export interface FormTemplate extends FormTemplateTemplateTypeOptionsOneOf {
|
|
|
8736
8982
|
* Specifies the template purpose
|
|
8737
8983
|
* @immutable
|
|
8738
8984
|
*/
|
|
8739
|
-
templateType?:
|
|
8985
|
+
templateType?: TemplateTypeWithLiterals;
|
|
8740
8986
|
/**
|
|
8741
8987
|
* Date of creation.
|
|
8742
8988
|
* @readonly
|
|
@@ -8785,7 +9031,7 @@ export interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
8785
9031
|
* Type of the field
|
|
8786
9032
|
* @readonly
|
|
8787
9033
|
*/
|
|
8788
|
-
fieldType?:
|
|
9034
|
+
fieldType?: FieldTypeWithLiterals;
|
|
8789
9035
|
}
|
|
8790
9036
|
/** @oneof */
|
|
8791
9037
|
export interface FieldFieldTypeOptionsOneOf {
|
|
@@ -8799,6 +9045,8 @@ export declare enum FieldType {
|
|
|
8799
9045
|
INPUT = "INPUT",
|
|
8800
9046
|
DISPLAY = "DISPLAY"
|
|
8801
9047
|
}
|
|
9048
|
+
/** @enumType */
|
|
9049
|
+
export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
|
|
8802
9050
|
export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
8803
9051
|
/** Input return string as value */
|
|
8804
9052
|
stringOptions?: _String;
|
|
@@ -8837,7 +9085,7 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
8837
9085
|
* Type of the input field
|
|
8838
9086
|
* @readonly
|
|
8839
9087
|
*/
|
|
8840
|
-
inputType?:
|
|
9088
|
+
inputType?: InputTypeWithLiterals;
|
|
8841
9089
|
/** Mapping to contacts, telling to what contact property field input value should be saved. */
|
|
8842
9090
|
contactMapping?: FormFieldContactInfo;
|
|
8843
9091
|
/**
|
|
@@ -8892,7 +9140,7 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
8892
9140
|
*/
|
|
8893
9141
|
pattern?: string | null;
|
|
8894
9142
|
/** Format of a string. */
|
|
8895
|
-
format?:
|
|
9143
|
+
format?: FormatWithLiterals;
|
|
8896
9144
|
/**
|
|
8897
9145
|
* List of allowed values.
|
|
8898
9146
|
* @maxSize 500
|
|
@@ -8929,6 +9177,8 @@ export declare enum Format {
|
|
|
8929
9177
|
LANGUAGE = "LANGUAGE",
|
|
8930
9178
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
8931
9179
|
}
|
|
9180
|
+
/** @enumType */
|
|
9181
|
+
export type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
|
|
8932
9182
|
export interface DateTimeConstraints {
|
|
8933
9183
|
/**
|
|
8934
9184
|
* Support static constrains defined as ISO date/time format, as well as
|
|
@@ -8966,6 +9216,8 @@ export declare enum StringComponentType {
|
|
|
8966
9216
|
TIME_INPUT = "TIME_INPUT",
|
|
8967
9217
|
DATE_PICKER = "DATE_PICKER"
|
|
8968
9218
|
}
|
|
9219
|
+
/** @enumType */
|
|
9220
|
+
export type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER';
|
|
8969
9221
|
export interface TextInput {
|
|
8970
9222
|
/**
|
|
8971
9223
|
* Label of the field
|
|
@@ -9015,7 +9267,7 @@ export interface RadioGroup {
|
|
|
9015
9267
|
* Specifies the number of columns used to display the selections within the component.
|
|
9016
9268
|
* Default: ONE
|
|
9017
9269
|
*/
|
|
9018
|
-
numberOfColumns?:
|
|
9270
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9019
9271
|
}
|
|
9020
9272
|
export interface RadioGroupOption {
|
|
9021
9273
|
/**
|
|
@@ -9061,6 +9313,8 @@ export declare enum NumberOfColumns {
|
|
|
9061
9313
|
/** Three columns. */
|
|
9062
9314
|
THREE = "THREE"
|
|
9063
9315
|
}
|
|
9316
|
+
/** @enumType */
|
|
9317
|
+
export type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
|
|
9064
9318
|
export interface Dropdown {
|
|
9065
9319
|
/**
|
|
9066
9320
|
* Label of the field
|
|
@@ -9250,7 +9504,7 @@ export interface DatePicker {
|
|
|
9250
9504
|
*/
|
|
9251
9505
|
placeholder?: string | null;
|
|
9252
9506
|
/** First day of the week displayed on date picker. */
|
|
9253
|
-
firstDayOfWeek?:
|
|
9507
|
+
firstDayOfWeek?: FirstDayOfWeekWithLiterals;
|
|
9254
9508
|
/**
|
|
9255
9509
|
* Default value for the date picker.
|
|
9256
9510
|
* @format LOCAL_DATE
|
|
@@ -9263,6 +9517,8 @@ export declare enum FirstDayOfWeek {
|
|
|
9263
9517
|
/** First day of the week is Sunday. */
|
|
9264
9518
|
SUNDAY = "SUNDAY"
|
|
9265
9519
|
}
|
|
9520
|
+
/** @enumType */
|
|
9521
|
+
export type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
|
|
9266
9522
|
export interface NumberType {
|
|
9267
9523
|
/** Inclusive maximum value. */
|
|
9268
9524
|
maximum?: number | null;
|
|
@@ -9281,6 +9537,8 @@ export declare enum NumberComponentType {
|
|
|
9281
9537
|
NUMBER_INPUT = "NUMBER_INPUT",
|
|
9282
9538
|
RATING_INPUT = "RATING_INPUT"
|
|
9283
9539
|
}
|
|
9540
|
+
/** @enumType */
|
|
9541
|
+
export type NumberComponentTypeWithLiterals = NumberComponentType | 'UNKNOWN' | 'NUMBER_INPUT' | 'RATING_INPUT';
|
|
9284
9542
|
export interface NumberInput {
|
|
9285
9543
|
/**
|
|
9286
9544
|
* Label of the field
|
|
@@ -9333,6 +9591,8 @@ export declare enum BooleanComponentType {
|
|
|
9333
9591
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9334
9592
|
CHECKBOX = "CHECKBOX"
|
|
9335
9593
|
}
|
|
9594
|
+
/** @enumType */
|
|
9595
|
+
export type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
|
|
9336
9596
|
export interface Checkbox {
|
|
9337
9597
|
/** Label of the field */
|
|
9338
9598
|
label?: RichContent;
|
|
@@ -9364,6 +9624,8 @@ export declare enum ItemType {
|
|
|
9364
9624
|
INTEGER = "INTEGER",
|
|
9365
9625
|
OBJECT = "OBJECT"
|
|
9366
9626
|
}
|
|
9627
|
+
/** @enumType */
|
|
9628
|
+
export type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'OBJECT';
|
|
9367
9629
|
export interface IntegerType {
|
|
9368
9630
|
/** Maximum value. */
|
|
9369
9631
|
maximum?: number | null;
|
|
@@ -9389,6 +9651,8 @@ export declare enum PropertiesTypeEnum {
|
|
|
9389
9651
|
INTEGER = "INTEGER",
|
|
9390
9652
|
ARRAY = "ARRAY"
|
|
9391
9653
|
}
|
|
9654
|
+
/** @enumType */
|
|
9655
|
+
export type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'INTEGER' | 'ARRAY';
|
|
9392
9656
|
export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
|
|
9393
9657
|
/** String type validation for property. */
|
|
9394
9658
|
stringOptions?: StringType;
|
|
@@ -9404,7 +9668,7 @@ export interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf
|
|
|
9404
9668
|
* Type of object properties
|
|
9405
9669
|
* @readonly
|
|
9406
9670
|
*/
|
|
9407
|
-
propertiesType?:
|
|
9671
|
+
propertiesType?: PropertiesTypeEnumWithLiterals;
|
|
9408
9672
|
/** Whether the property is required. */
|
|
9409
9673
|
required?: boolean;
|
|
9410
9674
|
}
|
|
@@ -9436,7 +9700,7 @@ export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsO
|
|
|
9436
9700
|
* Type of array items
|
|
9437
9701
|
* @readonly
|
|
9438
9702
|
*/
|
|
9439
|
-
itemType?:
|
|
9703
|
+
itemType?: ItemTypeWithLiterals;
|
|
9440
9704
|
}
|
|
9441
9705
|
/** @oneof */
|
|
9442
9706
|
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -9455,6 +9719,8 @@ export declare enum ArrayComponentType {
|
|
|
9455
9719
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9456
9720
|
CHECKBOX_GROUP = "CHECKBOX_GROUP"
|
|
9457
9721
|
}
|
|
9722
|
+
/** @enumType */
|
|
9723
|
+
export type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP';
|
|
9458
9724
|
export interface CheckboxGroup {
|
|
9459
9725
|
/**
|
|
9460
9726
|
* Label of the field
|
|
@@ -9479,7 +9745,7 @@ export interface CheckboxGroup {
|
|
|
9479
9745
|
* Specifies the number of columns used to display the selections within the component.
|
|
9480
9746
|
* Default: ONE
|
|
9481
9747
|
*/
|
|
9482
|
-
numberOfColumns?:
|
|
9748
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9483
9749
|
}
|
|
9484
9750
|
export interface MediaItem extends MediaItemMediaOneOf {
|
|
9485
9751
|
/** WixMedia image. */
|
|
@@ -9559,6 +9825,8 @@ export declare enum WixFileComponentType {
|
|
|
9559
9825
|
FILE_UPLOAD = "FILE_UPLOAD",
|
|
9560
9826
|
SIGNATURE = "SIGNATURE"
|
|
9561
9827
|
}
|
|
9828
|
+
/** @enumType */
|
|
9829
|
+
export type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
|
|
9562
9830
|
export interface FileUpload {
|
|
9563
9831
|
/**
|
|
9564
9832
|
* Selectable option label
|
|
@@ -9587,7 +9855,7 @@ export interface FileUpload {
|
|
|
9587
9855
|
* Supported file formats for upload
|
|
9588
9856
|
* @maxSize 5
|
|
9589
9857
|
*/
|
|
9590
|
-
uploadFileFormats?:
|
|
9858
|
+
uploadFileFormats?: UploadFileFormatWithLiterals[];
|
|
9591
9859
|
/**
|
|
9592
9860
|
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
9593
9861
|
* @maxLength 255
|
|
@@ -9608,6 +9876,8 @@ export declare enum UploadFileFormat {
|
|
|
9608
9876
|
/** Archive files. */
|
|
9609
9877
|
ARCHIVE = "ARCHIVE"
|
|
9610
9878
|
}
|
|
9879
|
+
/** @enumType */
|
|
9880
|
+
export type UploadFileFormatWithLiterals = UploadFileFormat | 'UNDEFINED' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
|
|
9611
9881
|
export interface Signature {
|
|
9612
9882
|
/**
|
|
9613
9883
|
* Selectable option label
|
|
@@ -9629,6 +9899,8 @@ export declare enum PaymentComponentType {
|
|
|
9629
9899
|
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
9630
9900
|
DONATION_INPUT = "DONATION_INPUT"
|
|
9631
9901
|
}
|
|
9902
|
+
/** @enumType */
|
|
9903
|
+
export type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT';
|
|
9632
9904
|
export interface PaymentType {
|
|
9633
9905
|
/**
|
|
9634
9906
|
* Field mapped to products.
|
|
@@ -9654,6 +9926,8 @@ export declare enum ProductType {
|
|
|
9654
9926
|
/** Digital. */
|
|
9655
9927
|
DIGITAL = "DIGITAL"
|
|
9656
9928
|
}
|
|
9929
|
+
/** @enumType */
|
|
9930
|
+
export type ProductTypeWithLiterals = ProductType | 'UNKNOWN' | 'SHIPPABLE' | 'DIGITAL';
|
|
9657
9931
|
export declare enum PriceType {
|
|
9658
9932
|
UNKNOWN = "UNKNOWN",
|
|
9659
9933
|
/** Fixed price. */
|
|
@@ -9661,6 +9935,8 @@ export declare enum PriceType {
|
|
|
9661
9935
|
/** Dynamic price from price range. */
|
|
9662
9936
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
9663
9937
|
}
|
|
9938
|
+
/** @enumType */
|
|
9939
|
+
export type PriceTypeWithLiterals = PriceType | 'UNKNOWN' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
|
|
9664
9940
|
export interface QuantityLimit {
|
|
9665
9941
|
/**
|
|
9666
9942
|
* Minimum quantity.
|
|
@@ -9706,9 +9982,9 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
9706
9982
|
*/
|
|
9707
9983
|
id?: string;
|
|
9708
9984
|
/** Product type. */
|
|
9709
|
-
productType?:
|
|
9985
|
+
productType?: ProductTypeWithLiterals;
|
|
9710
9986
|
/** Price type. */
|
|
9711
|
-
priceType?:
|
|
9987
|
+
priceType?: PriceTypeWithLiterals;
|
|
9712
9988
|
/** Quantity limit. */
|
|
9713
9989
|
quantityLimit?: QuantityLimit;
|
|
9714
9990
|
}
|
|
@@ -9741,7 +10017,7 @@ export interface ProductCheckboxGroup {
|
|
|
9741
10017
|
* Defines how an image should be resized to fit within its option.
|
|
9742
10018
|
* Default: COVER
|
|
9743
10019
|
*/
|
|
9744
|
-
imageFit?:
|
|
10020
|
+
imageFit?: ImageFitWithLiterals;
|
|
9745
10021
|
}
|
|
9746
10022
|
export interface ProductCheckboxGroupOption {
|
|
9747
10023
|
/**
|
|
@@ -9769,6 +10045,8 @@ export declare enum ImageFit {
|
|
|
9769
10045
|
/** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
|
|
9770
10046
|
CONTAIN = "CONTAIN"
|
|
9771
10047
|
}
|
|
10048
|
+
/** @enumType */
|
|
10049
|
+
export type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
|
|
9772
10050
|
export interface DonationInput {
|
|
9773
10051
|
/**
|
|
9774
10052
|
* Label of the field.
|
|
@@ -9788,7 +10066,7 @@ export interface DonationInput {
|
|
|
9788
10066
|
* Specifies the number of columns used to display the selections within the component.
|
|
9789
10067
|
* Default: ONE
|
|
9790
10068
|
*/
|
|
9791
|
-
numberOfColumns?:
|
|
10069
|
+
numberOfColumns?: NumberOfColumnsWithLiterals;
|
|
9792
10070
|
/**
|
|
9793
10071
|
* Flag identifying to hide or not label
|
|
9794
10072
|
* Default: true
|
|
@@ -9820,6 +10098,8 @@ export declare enum MultilineAddressComponentType {
|
|
|
9820
10098
|
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
9821
10099
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9822
10100
|
}
|
|
10101
|
+
/** @enumType */
|
|
10102
|
+
export type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
|
|
9823
10103
|
export interface MultilineAddressValidation {
|
|
9824
10104
|
/**
|
|
9825
10105
|
* Allowed countries. No countries treated as all.
|
|
@@ -9877,6 +10157,8 @@ export declare enum DefaultCountryConfigType {
|
|
|
9877
10157
|
/** Pre-selected default country. */
|
|
9878
10158
|
COUNTRY = "COUNTRY"
|
|
9879
10159
|
}
|
|
10160
|
+
/** @enumType */
|
|
10161
|
+
export type DefaultCountryConfigTypeWithLiterals = DefaultCountryConfigType | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
|
|
9880
10162
|
export interface AddressLine2 {
|
|
9881
10163
|
/** Show address line 2 field. */
|
|
9882
10164
|
show?: boolean;
|
|
@@ -9888,7 +10170,7 @@ export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
|
9888
10170
|
*/
|
|
9889
10171
|
countryOptions?: string;
|
|
9890
10172
|
/** Default country type. */
|
|
9891
|
-
type?:
|
|
10173
|
+
type?: DefaultCountryConfigTypeWithLiterals;
|
|
9892
10174
|
}
|
|
9893
10175
|
/** @oneof */
|
|
9894
10176
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
@@ -9913,6 +10195,8 @@ export declare enum InputType {
|
|
|
9913
10195
|
PAYMENT = "PAYMENT",
|
|
9914
10196
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
9915
10197
|
}
|
|
10198
|
+
/** @enumType */
|
|
10199
|
+
export type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS';
|
|
9916
10200
|
export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
|
|
9917
10201
|
/** Email info. */
|
|
9918
10202
|
emailInfo?: EmailInfo;
|
|
@@ -9925,7 +10209,7 @@ export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfo
|
|
|
9925
10209
|
/** Subscription info */
|
|
9926
10210
|
subscriptionInfo?: SubscriptionInfo;
|
|
9927
10211
|
/** Field mapped to contacts. */
|
|
9928
|
-
contactField?:
|
|
10212
|
+
contactField?: ContactFieldWithLiterals;
|
|
9929
10213
|
}
|
|
9930
10214
|
/** @oneof */
|
|
9931
10215
|
export interface FormFieldContactInfoAdditionalInfoOneOf {
|
|
@@ -9944,19 +10228,27 @@ export declare enum EmailInfoTag {
|
|
|
9944
10228
|
UNTAGGED = "UNTAGGED",
|
|
9945
10229
|
MAIN = "MAIN"
|
|
9946
10230
|
}
|
|
10231
|
+
/** @enumType */
|
|
10232
|
+
export type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9947
10233
|
export declare enum PhoneInfoTag {
|
|
9948
10234
|
UNTAGGED = "UNTAGGED",
|
|
9949
10235
|
MAIN = "MAIN"
|
|
9950
10236
|
}
|
|
10237
|
+
/** @enumType */
|
|
10238
|
+
export type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
|
|
9951
10239
|
export declare enum AddressInfoTag {
|
|
9952
10240
|
UNTAGGED = "UNTAGGED",
|
|
9953
10241
|
HOME = "HOME"
|
|
9954
10242
|
}
|
|
10243
|
+
/** @enumType */
|
|
10244
|
+
export type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
|
|
9955
10245
|
export declare enum ConfirmationLevel {
|
|
9956
10246
|
UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
|
|
9957
10247
|
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
9958
10248
|
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
9959
10249
|
}
|
|
10250
|
+
/** @enumType */
|
|
10251
|
+
export type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
|
|
9960
10252
|
export declare enum ContactField {
|
|
9961
10253
|
UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
|
|
9962
10254
|
FIRST_NAME = "FIRST_NAME",
|
|
@@ -9971,17 +10263,19 @@ export declare enum ContactField {
|
|
|
9971
10263
|
SUBSCRIPTION = "SUBSCRIPTION",
|
|
9972
10264
|
VAT_ID = "VAT_ID"
|
|
9973
10265
|
}
|
|
10266
|
+
/** @enumType */
|
|
10267
|
+
export type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
|
|
9974
10268
|
export interface EmailInfo {
|
|
9975
10269
|
/** Email tag. */
|
|
9976
|
-
tag?:
|
|
10270
|
+
tag?: EmailInfoTagWithLiterals;
|
|
9977
10271
|
}
|
|
9978
10272
|
export interface PhoneInfo {
|
|
9979
10273
|
/** Phone tag. */
|
|
9980
|
-
tag?:
|
|
10274
|
+
tag?: PhoneInfoTagWithLiterals;
|
|
9981
10275
|
}
|
|
9982
10276
|
export interface AddressInfo {
|
|
9983
10277
|
/** Address tag. */
|
|
9984
|
-
tag?:
|
|
10278
|
+
tag?: AddressInfoTagWithLiterals;
|
|
9985
10279
|
}
|
|
9986
10280
|
export interface CustomFieldInfo {
|
|
9987
10281
|
/**
|
|
@@ -9996,7 +10290,7 @@ export interface SubscriptionInfo {
|
|
|
9996
10290
|
* Subscription consent opt in level, either single or double confirmation.
|
|
9997
10291
|
* Default: SINGLE_CONFIRMATION
|
|
9998
10292
|
*/
|
|
9999
|
-
confirmationLevel?:
|
|
10293
|
+
confirmationLevel?: ConfirmationLevelWithLiterals;
|
|
10000
10294
|
}
|
|
10001
10295
|
export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
10002
10296
|
/** Text input field */
|
|
@@ -10021,7 +10315,7 @@ export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
|
10021
10315
|
* Component type of the string input field
|
|
10022
10316
|
* @readonly
|
|
10023
10317
|
*/
|
|
10024
|
-
componentType?:
|
|
10318
|
+
componentType?: StringComponentTypeWithLiterals;
|
|
10025
10319
|
}
|
|
10026
10320
|
/** @oneof */
|
|
10027
10321
|
export interface _StringComponentTypeOptionsOneOf {
|
|
@@ -10053,7 +10347,7 @@ export interface InputField_Number extends InputField_NumberComponentTypeOptions
|
|
|
10053
10347
|
* Component type of the number input field
|
|
10054
10348
|
* @readonly
|
|
10055
10349
|
*/
|
|
10056
|
-
componentType?:
|
|
10350
|
+
componentType?: NumberComponentTypeWithLiterals;
|
|
10057
10351
|
}
|
|
10058
10352
|
/** @oneof */
|
|
10059
10353
|
export interface InputField_NumberComponentTypeOptionsOneOf {
|
|
@@ -10071,7 +10365,7 @@ export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
|
|
|
10071
10365
|
* Component type of the boolean input field
|
|
10072
10366
|
* @readonly
|
|
10073
10367
|
*/
|
|
10074
|
-
componentType?:
|
|
10368
|
+
componentType?: BooleanComponentTypeWithLiterals;
|
|
10075
10369
|
}
|
|
10076
10370
|
/** @oneof */
|
|
10077
10371
|
export interface _BooleanComponentTypeOptionsOneOf {
|
|
@@ -10087,7 +10381,7 @@ export interface _Array extends _ArrayComponentTypeOptionsOneOf {
|
|
|
10087
10381
|
* Component type of the array input field
|
|
10088
10382
|
* @readonly
|
|
10089
10383
|
*/
|
|
10090
|
-
componentType?:
|
|
10384
|
+
componentType?: ArrayComponentTypeWithLiterals;
|
|
10091
10385
|
}
|
|
10092
10386
|
/** @oneof */
|
|
10093
10387
|
export interface _ArrayComponentTypeOptionsOneOf {
|
|
@@ -10107,7 +10401,7 @@ export interface WixFile extends WixFileComponentTypeOptionsOneOf {
|
|
|
10107
10401
|
* Component type of the array input field
|
|
10108
10402
|
* @readonly
|
|
10109
10403
|
*/
|
|
10110
|
-
componentType?:
|
|
10404
|
+
componentType?: WixFileComponentTypeWithLiterals;
|
|
10111
10405
|
}
|
|
10112
10406
|
/** @oneof */
|
|
10113
10407
|
export interface WixFileComponentTypeOptionsOneOf {
|
|
@@ -10125,7 +10419,7 @@ export interface Payment extends PaymentComponentTypeOptionsOneOf {
|
|
|
10125
10419
|
* Component type of the payment input field.
|
|
10126
10420
|
* @readonly
|
|
10127
10421
|
*/
|
|
10128
|
-
componentType?:
|
|
10422
|
+
componentType?: PaymentComponentTypeWithLiterals;
|
|
10129
10423
|
/** Validation of payment type. */
|
|
10130
10424
|
validation?: PaymentType;
|
|
10131
10425
|
}
|
|
@@ -10143,7 +10437,7 @@ export interface MultilineAddress extends MultilineAddressComponentTypeOptionsOn
|
|
|
10143
10437
|
* Component type of the multiline address field.
|
|
10144
10438
|
* @readonly
|
|
10145
10439
|
*/
|
|
10146
|
-
componentType?:
|
|
10440
|
+
componentType?: MultilineAddressComponentTypeWithLiterals;
|
|
10147
10441
|
/** Validation of multiline address field output value. */
|
|
10148
10442
|
validation?: MultilineAddressValidation;
|
|
10149
10443
|
}
|
|
@@ -10157,7 +10451,7 @@ export interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
|
10157
10451
|
richContentOptions?: RichContentOptions;
|
|
10158
10452
|
/** Page navigation component resolving as navigation or submit buttons */
|
|
10159
10453
|
pageNavigationOptions?: PageNavigationOptions;
|
|
10160
|
-
displayFieldType?:
|
|
10454
|
+
displayFieldType?: DisplayFieldTypeWithLiterals;
|
|
10161
10455
|
}
|
|
10162
10456
|
/** @oneof */
|
|
10163
10457
|
export interface DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
@@ -10172,6 +10466,8 @@ export declare enum DisplayFieldType {
|
|
|
10172
10466
|
PAGE_NAVIGATION = "PAGE_NAVIGATION",
|
|
10173
10467
|
LOGIN_BAR = "LOGIN_BAR"
|
|
10174
10468
|
}
|
|
10469
|
+
/** @enumType */
|
|
10470
|
+
export type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
|
|
10175
10471
|
export interface RichContentOptions {
|
|
10176
10472
|
/** Content of the header */
|
|
10177
10473
|
richContent?: RichContent;
|
|
@@ -10313,6 +10609,8 @@ export declare enum ChangeableProperty {
|
|
|
10313
10609
|
/** Allowed values property type. */
|
|
10314
10610
|
ALLOWED_VALUES = "ALLOWED_VALUES"
|
|
10315
10611
|
}
|
|
10612
|
+
/** @enumType */
|
|
10613
|
+
export type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
|
|
10316
10614
|
export interface RequiredOptions {
|
|
10317
10615
|
/** Value of required property */
|
|
10318
10616
|
value?: boolean;
|
|
@@ -10333,6 +10631,8 @@ export declare enum OverrideEntityType {
|
|
|
10333
10631
|
UNKNOWN = "UNKNOWN",
|
|
10334
10632
|
FIELD = "FIELD"
|
|
10335
10633
|
}
|
|
10634
|
+
/** @enumType */
|
|
10635
|
+
export type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
|
|
10336
10636
|
export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
10337
10637
|
/** Required property overrides */
|
|
10338
10638
|
requiredOptions?: RequiredOptions;
|
|
@@ -10347,7 +10647,7 @@ export interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
|
|
|
10347
10647
|
*/
|
|
10348
10648
|
fieldId?: string;
|
|
10349
10649
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
10350
|
-
propertyType?:
|
|
10650
|
+
propertyType?: ChangeablePropertyWithLiterals;
|
|
10351
10651
|
}
|
|
10352
10652
|
/** @oneof */
|
|
10353
10653
|
export interface FieldOverridePropertyTypeOptionsOneOf {
|
|
@@ -10398,7 +10698,7 @@ export interface V2Condition {
|
|
|
10398
10698
|
*/
|
|
10399
10699
|
fact?: string;
|
|
10400
10700
|
/** The operator to use for comparison. */
|
|
10401
|
-
operator?:
|
|
10701
|
+
operator?: OperatorWithLiterals;
|
|
10402
10702
|
/**
|
|
10403
10703
|
* The value to compare against.
|
|
10404
10704
|
* @maxLength 500
|
|
@@ -10434,6 +10734,8 @@ export declare enum Operator {
|
|
|
10434
10734
|
IS_DATE_NEWER_THAN = "IS_DATE_NEWER_THAN",
|
|
10435
10735
|
IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
|
|
10436
10736
|
}
|
|
10737
|
+
/** @enumType */
|
|
10738
|
+
export type OperatorWithLiterals = Operator | 'UNKNOWN' | 'EQUAL' | 'NOT_EQUAL' | 'EMPTY' | 'NOT_EMPTY' | 'CONTAINS' | 'NOT_CONTAINS' | 'LESS_THAN' | 'LESS_THAN_OR_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUALS' | 'BEFORE' | 'BEFORE_OR_EQUAL' | 'AFTER' | 'AFTER_OR_EQUAL' | 'BETWEEN' | 'ANY' | 'ARRAY_EQUAL' | 'ARRAY_NOT_EQUAL' | 'CHECKED' | 'NOT_CHECKED' | 'IN' | 'NOT_IN' | 'IS_DATE_OLDER_THAN' | 'IS_DATE_OLDER_THAN_OR_EQUAL' | 'IS_DATE_NEWER_THAN' | 'IS_DATE_NEWER_THAN_OR_EQUAL';
|
|
10437
10739
|
export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
10438
10740
|
/** Field override properties. */
|
|
10439
10741
|
fieldOptions?: FieldOverride;
|
|
@@ -10441,7 +10743,7 @@ export interface FormOverride extends FormOverrideEntityTypeOptionsOneOf {
|
|
|
10441
10743
|
* Override entity type.
|
|
10442
10744
|
* @immutable
|
|
10443
10745
|
*/
|
|
10444
|
-
entityType?:
|
|
10746
|
+
entityType?: OverrideEntityTypeWithLiterals;
|
|
10445
10747
|
}
|
|
10446
10748
|
/** @oneof */
|
|
10447
10749
|
export interface FormOverrideEntityTypeOptionsOneOf {
|
|
@@ -10454,7 +10756,7 @@ export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptions
|
|
|
10454
10756
|
/** Options for redirecting to a URL after submission. */
|
|
10455
10757
|
redirectOptions?: RedirectOptions;
|
|
10456
10758
|
/** Action that is triggered after a successful form submission. */
|
|
10457
|
-
submitSuccessAction?:
|
|
10759
|
+
submitSuccessAction?: SubmitSuccessActionWithLiterals;
|
|
10458
10760
|
}
|
|
10459
10761
|
/** @oneof */
|
|
10460
10762
|
export interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
@@ -10470,6 +10772,8 @@ export declare enum Target {
|
|
|
10470
10772
|
/** Open in a new browser tab. */
|
|
10471
10773
|
BLANK = "BLANK"
|
|
10472
10774
|
}
|
|
10775
|
+
/** @enumType */
|
|
10776
|
+
export type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
|
|
10473
10777
|
export declare enum SubmitSuccessAction {
|
|
10474
10778
|
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
10475
10779
|
/** No action will be taken after submission. */
|
|
@@ -10479,6 +10783,8 @@ export declare enum SubmitSuccessAction {
|
|
|
10479
10783
|
/** The user will be redirected to a URL after submission. */
|
|
10480
10784
|
REDIRECT = "REDIRECT"
|
|
10481
10785
|
}
|
|
10786
|
+
/** @enumType */
|
|
10787
|
+
export type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
|
|
10482
10788
|
export interface ThankYouMessageOptions {
|
|
10483
10789
|
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
10484
10790
|
durationInSeconds?: number | null;
|
|
@@ -10492,7 +10798,7 @@ export interface RedirectOptions {
|
|
|
10492
10798
|
*/
|
|
10493
10799
|
redirectUrl?: string | null;
|
|
10494
10800
|
/** How the URL should be opened. */
|
|
10495
|
-
target?:
|
|
10801
|
+
target?: TargetWithLiterals;
|
|
10496
10802
|
}
|
|
10497
10803
|
export declare enum TemplateType {
|
|
10498
10804
|
UNKNOWN = "UNKNOWN",
|
|
@@ -10506,6 +10812,8 @@ export declare enum TemplateType {
|
|
|
10506
10812
|
*/
|
|
10507
10813
|
FORM_INPUT = "FORM_INPUT"
|
|
10508
10814
|
}
|
|
10815
|
+
/** @enumType */
|
|
10816
|
+
export type TemplateTypeWithLiterals = TemplateType | 'UNKNOWN' | 'EXTENDABLE' | 'DEMO' | 'FORM_INPUT';
|
|
10509
10817
|
export interface ExtensionDetails {
|
|
10510
10818
|
/** Allow user to add/remove custom field, not present in template */
|
|
10511
10819
|
addCustomFields?: AddCustomFields;
|
|
@@ -10518,6 +10826,8 @@ export declare enum CustomFieldsType {
|
|
|
10518
10826
|
/** Allow user to add/remove any custom field, not present in template */
|
|
10519
10827
|
ANY = "ANY"
|
|
10520
10828
|
}
|
|
10829
|
+
/** @enumType */
|
|
10830
|
+
export type CustomFieldsTypeWithLiterals = CustomFieldsType | 'ANY';
|
|
10521
10831
|
export declare enum EditableProperties {
|
|
10522
10832
|
UNKNOWN = "UNKNOWN",
|
|
10523
10833
|
/** Change property responsible for field requirement */
|
|
@@ -10538,16 +10848,18 @@ export declare enum EditableProperties {
|
|
|
10538
10848
|
/** Change property responsible for field default value */
|
|
10539
10849
|
DEFAULT_VALUE = "DEFAULT_VALUE"
|
|
10540
10850
|
}
|
|
10851
|
+
/** @enumType */
|
|
10852
|
+
export type EditablePropertiesWithLiterals = EditableProperties | 'UNKNOWN' | 'REQUIRED' | 'HIDDEN' | 'LABEL' | 'PLACEHOLDER' | 'DESCRIPTION' | 'INPUT_VALUE_LIMITS' | 'DEFAULT_VALUE';
|
|
10541
10853
|
export interface EditableFields {
|
|
10542
10854
|
/**
|
|
10543
10855
|
* List of editable properties for field
|
|
10544
10856
|
* @maxSize 10
|
|
10545
10857
|
*/
|
|
10546
|
-
properties?:
|
|
10858
|
+
properties?: EditablePropertiesWithLiterals[];
|
|
10547
10859
|
}
|
|
10548
10860
|
export interface AddCustomFields {
|
|
10549
10861
|
/** Field types which can be added */
|
|
10550
|
-
fieldType?:
|
|
10862
|
+
fieldType?: CustomFieldsTypeWithLiterals;
|
|
10551
10863
|
}
|
|
10552
10864
|
export interface OverrideTemplateFields {
|
|
10553
10865
|
/** Editable properties by field id. */
|
|
@@ -10575,9 +10887,9 @@ export interface FieldGroup {
|
|
|
10575
10887
|
}
|
|
10576
10888
|
export interface RequiredIndicatorProperties {
|
|
10577
10889
|
/** Required indicator. */
|
|
10578
|
-
requiredIndicator?:
|
|
10890
|
+
requiredIndicator?: RequiredIndicatorWithLiterals;
|
|
10579
10891
|
/** Required indicator placement. */
|
|
10580
|
-
requiredIndicatorPlacement?:
|
|
10892
|
+
requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
|
|
10581
10893
|
}
|
|
10582
10894
|
export declare enum RequiredIndicator {
|
|
10583
10895
|
/** Unknown required indicator. */
|
|
@@ -10589,6 +10901,8 @@ export declare enum RequiredIndicator {
|
|
|
10589
10901
|
/** None. */
|
|
10590
10902
|
NONE = "NONE"
|
|
10591
10903
|
}
|
|
10904
|
+
/** @enumType */
|
|
10905
|
+
export type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | 'ASTERISK' | 'TEXT' | 'NONE';
|
|
10592
10906
|
export declare enum RequiredIndicatorPlacement {
|
|
10593
10907
|
/** Unknown required indicator placement. */
|
|
10594
10908
|
UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
|
|
@@ -10597,6 +10911,8 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
10597
10911
|
/** Before field title. */
|
|
10598
10912
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
10599
10913
|
}
|
|
10914
|
+
/** @enumType */
|
|
10915
|
+
export type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
|
|
10600
10916
|
/** Describes a setting group of a notification */
|
|
10601
10917
|
export interface NotificationContent {
|
|
10602
10918
|
single?: SingleContent;
|
|
@@ -10652,7 +10968,7 @@ export interface VeloPublishPipelineTaskProviderConfig {
|
|
|
10652
10968
|
* The Velo Task name
|
|
10653
10969
|
* @maxSize 100
|
|
10654
10970
|
*/
|
|
10655
|
-
implementerTasksNames?:
|
|
10971
|
+
implementerTasksNames?: WixCodePublishTaskNameWithLiterals[];
|
|
10656
10972
|
}
|
|
10657
10973
|
export declare enum WixCodePublishTaskName {
|
|
10658
10974
|
/** unknown */
|
|
@@ -10670,6 +10986,8 @@ export declare enum WixCodePublishTaskName {
|
|
|
10670
10986
|
/** code packages dependencies registration */
|
|
10671
10987
|
CODE_PACKAGES_REGISTRATION = "CODE_PACKAGES_REGISTRATION"
|
|
10672
10988
|
}
|
|
10989
|
+
/** @enumType */
|
|
10990
|
+
export type WixCodePublishTaskNameWithLiterals = WixCodePublishTaskName | 'UNKNOWN' | 'USER_CODE_BUNDLE' | 'EXPORTED_FUNCTIONS_ANALYSIS' | 'IMPORTED_NAMESPACES_ANALYSIS' | 'PAGE_DETAILS_ANALYSIS' | 'USER_CODE_VALIDATION' | 'CODE_PACKAGES_REGISTRATION';
|
|
10673
10991
|
export interface FunctionsShopPriceSpiConfig {
|
|
10674
10992
|
/** Uri config */
|
|
10675
10993
|
uriConfig?: SpiBaseUri;
|
|
@@ -10901,7 +11219,7 @@ export interface ChannelChannelConfiguration extends ChannelChannelConfiguration
|
|
|
10901
11219
|
*/
|
|
10902
11220
|
channelKey?: string;
|
|
10903
11221
|
/** The type of the communication channel */
|
|
10904
|
-
type?:
|
|
11222
|
+
type?: ChannelConfigurationChannelTypeWithLiterals;
|
|
10905
11223
|
/** Specific provider branding parameters for the channel */
|
|
10906
11224
|
branding?: ChannelChannelBranding;
|
|
10907
11225
|
}
|
|
@@ -10921,6 +11239,8 @@ export declare enum ChannelConfigurationChannelType {
|
|
|
10921
11239
|
EMAIL = "EMAIL",
|
|
10922
11240
|
SMS = "SMS"
|
|
10923
11241
|
}
|
|
11242
|
+
/** @enumType */
|
|
11243
|
+
export type ChannelConfigurationChannelTypeWithLiterals = ChannelConfigurationChannelType | 'UNKNOWN_CHANNEL_TYPE' | 'DIRECT_MESSAGING' | 'EMAIL' | 'SMS';
|
|
10924
11244
|
export interface DmDirectMessageConfig {
|
|
10925
11245
|
/**
|
|
10926
11246
|
* Direct message types accepted by the provider.
|
|
@@ -10928,7 +11248,7 @@ export interface DmDirectMessageConfig {
|
|
|
10928
11248
|
* If the provider supports all message types, this field can be empty.
|
|
10929
11249
|
* @maxSize 100
|
|
10930
11250
|
*/
|
|
10931
|
-
acceptedMessageTypes?:
|
|
11251
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals[];
|
|
10932
11252
|
/** Supported media types (mime types) and sizes */
|
|
10933
11253
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10934
11254
|
/** Defines whether or not sending messages will be available for recipients without contact Id */
|
|
@@ -10949,6 +11269,8 @@ export declare enum AcceptedMessageTypesAcceptedDirectMessageType {
|
|
|
10949
11269
|
FORM = "FORM",
|
|
10950
11270
|
SYSTEM = "SYSTEM"
|
|
10951
11271
|
}
|
|
11272
|
+
/** @enumType */
|
|
11273
|
+
export type AcceptedMessageTypesAcceptedDirectMessageTypeWithLiterals = AcceptedMessageTypesAcceptedDirectMessageType | 'UNKNOWN_DIRECT_MESSAGE_TYPE' | 'MEDIA' | 'CARD' | 'MINIMAL' | 'FORM' | 'SYSTEM';
|
|
10952
11274
|
export interface ChannelMediaCapabilities {
|
|
10953
11275
|
/** When marked as true, 'supported_media_types' will be ignored. */
|
|
10954
11276
|
allMediaTypes?: boolean;
|
|
@@ -10975,7 +11297,7 @@ export interface SmsSmsMessageConfig {
|
|
|
10975
11297
|
* @minSize 1
|
|
10976
11298
|
* @maxSize 100
|
|
10977
11299
|
*/
|
|
10978
|
-
acceptedMessageTypes?:
|
|
11300
|
+
acceptedMessageTypes?: AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals[];
|
|
10979
11301
|
/** Supported media types (mime types) and sizes */
|
|
10980
11302
|
mediaCapabilities?: ChannelMediaCapabilities;
|
|
10981
11303
|
/** Optional - maximum sms message length in characters, if not given, will be unlimited */
|
|
@@ -10986,6 +11308,8 @@ export declare enum AcceptedMessageTypesAcceptedSmsMessageType {
|
|
|
10986
11308
|
SMS = "SMS",
|
|
10987
11309
|
MMS = "MMS"
|
|
10988
11310
|
}
|
|
11311
|
+
/** @enumType */
|
|
11312
|
+
export type AcceptedMessageTypesAcceptedSmsMessageTypeWithLiterals = AcceptedMessageTypesAcceptedSmsMessageType | 'UNKNOWN_SMS_MESSAGE_TYPE' | 'SMS' | 'MMS';
|
|
10989
11313
|
export interface ChannelChannelBranding {
|
|
10990
11314
|
/**
|
|
10991
11315
|
* The name of the channel, e.g. `Facebook` / `SMS`
|
|
@@ -11125,7 +11449,7 @@ export interface FactorConfig {
|
|
|
11125
11449
|
/** the base URI where all the methods are deployed. */
|
|
11126
11450
|
uriConfig?: SpiBaseUri;
|
|
11127
11451
|
/** the type of the factor */
|
|
11128
|
-
factorType?:
|
|
11452
|
+
factorType?: FactorTypeWithLiterals;
|
|
11129
11453
|
/** whether the factor supports verify without enrolling first */
|
|
11130
11454
|
supportsVerifyWithoutEnroll?: boolean;
|
|
11131
11455
|
}
|
|
@@ -11138,6 +11462,8 @@ export declare enum FactorType {
|
|
|
11138
11462
|
TOTP = "TOTP",
|
|
11139
11463
|
PUSH = "PUSH"
|
|
11140
11464
|
}
|
|
11465
|
+
/** @enumType */
|
|
11466
|
+
export type FactorTypeWithLiterals = FactorType | 'UNKNOWN_FACTOR_TYPE' | 'PASSWORD' | 'SMS' | 'CALL' | 'EMAIL' | 'TOTP' | 'PUSH';
|
|
11141
11467
|
export interface DiscountsSPIConfig {
|
|
11142
11468
|
/**
|
|
11143
11469
|
* Base URI where the endpoints are called.
|
|
@@ -11197,7 +11523,7 @@ export interface Monitoring extends MonitoringOptionsOneOf {
|
|
|
11197
11523
|
/** Panorama provider options */
|
|
11198
11524
|
panoramaOptions?: PanoramaOptions;
|
|
11199
11525
|
/** Provider type */
|
|
11200
|
-
type?:
|
|
11526
|
+
type?: MonitoringTypeWithLiterals;
|
|
11201
11527
|
}
|
|
11202
11528
|
/** @oneof */
|
|
11203
11529
|
export interface MonitoringOptionsOneOf {
|
|
@@ -11239,6 +11565,8 @@ export declare enum MonitoringType {
|
|
|
11239
11565
|
SENTRY = "SENTRY",
|
|
11240
11566
|
PANORAMA = "PANORAMA"
|
|
11241
11567
|
}
|
|
11568
|
+
/** @enumType */
|
|
11569
|
+
export type MonitoringTypeWithLiterals = MonitoringType | 'UNKNOWN_PROVIDER' | 'SENTRY' | 'PANORAMA';
|
|
11242
11570
|
export interface PanoramaOptions {
|
|
11243
11571
|
/** Sentry config */
|
|
11244
11572
|
sentry?: SentryOptions;
|
|
@@ -11259,12 +11587,12 @@ export interface PluginConfig {
|
|
|
11259
11587
|
*/
|
|
11260
11588
|
pluginDisplayName?: string;
|
|
11261
11589
|
startingEnforcementDate?: Date | null;
|
|
11262
|
-
importanceLevel?:
|
|
11590
|
+
importanceLevel?: ImportanceLevelWithLiterals;
|
|
11263
11591
|
/** @maxSize 100 */
|
|
11264
11592
|
constraints?: Constraint[];
|
|
11265
11593
|
}
|
|
11266
11594
|
export interface Consequence {
|
|
11267
|
-
escalation?:
|
|
11595
|
+
escalation?: EscalationWithLiterals;
|
|
11268
11596
|
/** days to resolve the violation */
|
|
11269
11597
|
daysToResolve?: number | null;
|
|
11270
11598
|
}
|
|
@@ -11276,11 +11604,15 @@ export declare enum Escalation {
|
|
|
11276
11604
|
/** only shows violation in papi-dashboard */
|
|
11277
11605
|
VISIBILITY = "VISIBILITY"
|
|
11278
11606
|
}
|
|
11607
|
+
/** @enumType */
|
|
11608
|
+
export type EscalationWithLiterals = Escalation | 'BREAK_BUILD' | 'BLOCK_ROLLOUT' | 'BLOCK_FUTURE_ROLLOUT' | 'OPEN_BUG_SLA' | 'VISIBILITY';
|
|
11279
11609
|
export declare enum ImportanceLevel {
|
|
11280
11610
|
LOW = "LOW",
|
|
11281
11611
|
MEDIUM = "MEDIUM",
|
|
11282
11612
|
HIGH = "HIGH"
|
|
11283
11613
|
}
|
|
11614
|
+
/** @enumType */
|
|
11615
|
+
export type ImportanceLevelWithLiterals = ImportanceLevel | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
11284
11616
|
export interface Constraint {
|
|
11285
11617
|
/** @maxLength 1024 */
|
|
11286
11618
|
id?: string;
|
|
@@ -11405,7 +11737,7 @@ export interface Panel extends PanelSelectedContentTypeOneOf {
|
|
|
11405
11737
|
/** Optional: The size of the panel */
|
|
11406
11738
|
size?: PanelSize;
|
|
11407
11739
|
/** The selected panel content type */
|
|
11408
|
-
contentType?:
|
|
11740
|
+
contentType?: PanelContentTypeWithLiterals;
|
|
11409
11741
|
}
|
|
11410
11742
|
/** @oneof */
|
|
11411
11743
|
export interface PanelSelectedContentTypeOneOf {
|
|
@@ -11422,18 +11754,22 @@ export interface PanelSize {
|
|
|
11422
11754
|
*/
|
|
11423
11755
|
height?: number | null;
|
|
11424
11756
|
/** width of the panel */
|
|
11425
|
-
width?:
|
|
11757
|
+
width?: WidthWithLiterals;
|
|
11426
11758
|
}
|
|
11427
11759
|
export declare enum Width {
|
|
11428
11760
|
SMALL = "SMALL",
|
|
11429
11761
|
MEDIUM = "MEDIUM",
|
|
11430
11762
|
LARGE = "LARGE"
|
|
11431
11763
|
}
|
|
11764
|
+
/** @enumType */
|
|
11765
|
+
export type WidthWithLiterals = Width | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
11432
11766
|
/** Represents the options for panel content types */
|
|
11433
11767
|
export declare enum PanelContentType {
|
|
11434
11768
|
UNKNOWN_PanelContentType = "UNKNOWN_PanelContentType",
|
|
11435
11769
|
url = "url"
|
|
11436
11770
|
}
|
|
11771
|
+
/** @enumType */
|
|
11772
|
+
export type PanelContentTypeWithLiterals = PanelContentType | 'UNKNOWN_PanelContentType' | 'url';
|
|
11437
11773
|
/** Represents the information needed for code panels */
|
|
11438
11774
|
export interface CodePanel {
|
|
11439
11775
|
/**
|
|
@@ -11453,7 +11789,7 @@ export interface PurchaseValidationsConfig {
|
|
|
11453
11789
|
}
|
|
11454
11790
|
export interface BrowserStorage {
|
|
11455
11791
|
/** The type of browser storage used */
|
|
11456
|
-
type?:
|
|
11792
|
+
type?: StorageTypeWithLiterals;
|
|
11457
11793
|
/**
|
|
11458
11794
|
* The name of the storage item in the browser (as can be seen in DEV Console)
|
|
11459
11795
|
* @maxLength 100
|
|
@@ -11471,9 +11807,9 @@ export interface BrowserStorage {
|
|
|
11471
11807
|
* This defines when this storage item is allowed to be used in a visitor session.
|
|
11472
11808
|
* > This is legally important for complying with EU privacy law, so make sure to define this carefully.
|
|
11473
11809
|
*/
|
|
11474
|
-
consentCategory?:
|
|
11810
|
+
consentCategory?: ConsentCategoryWithLiterals;
|
|
11475
11811
|
/** Where this storage item will be set in the browser (User domain or the App domain) */
|
|
11476
|
-
domain?:
|
|
11812
|
+
domain?: StorageDomainWithLiterals;
|
|
11477
11813
|
}
|
|
11478
11814
|
/** The type of storage we are declaring */
|
|
11479
11815
|
export declare enum StorageType {
|
|
@@ -11487,6 +11823,8 @@ export declare enum StorageType {
|
|
|
11487
11823
|
/** An item in [IndexDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) */
|
|
11488
11824
|
INDEXDB = "INDEXDB"
|
|
11489
11825
|
}
|
|
11826
|
+
/** @enumType */
|
|
11827
|
+
export type StorageTypeWithLiterals = StorageType | 'UNKNOWN_STORAGE_TYPE' | 'COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE' | 'INDEXDB';
|
|
11490
11828
|
/** The category for EU and US Privacy Law classification */
|
|
11491
11829
|
export declare enum ConsentCategory {
|
|
11492
11830
|
/** This is an invalid value, you must classify your storage item. */
|
|
@@ -11500,6 +11838,8 @@ export declare enum ConsentCategory {
|
|
|
11500
11838
|
/** Related to advertising, upselling and marketing data collected to be used. */
|
|
11501
11839
|
advertising = "advertising"
|
|
11502
11840
|
}
|
|
11841
|
+
/** @enumType */
|
|
11842
|
+
export type ConsentCategoryWithLiterals = ConsentCategory | 'UNKNOWN_CATEGORY' | 'essential' | 'functional' | 'analytics' | 'advertising';
|
|
11503
11843
|
export declare enum StorageDomain {
|
|
11504
11844
|
UNKNOWN_STORAGE_DOMAIN = "UNKNOWN_STORAGE_DOMAIN",
|
|
11505
11845
|
/** Storing the values in the domain of the website the app is installed on */
|
|
@@ -11509,6 +11849,8 @@ export declare enum StorageDomain {
|
|
|
11509
11849
|
/** Storing the values as 3rd party in the application domain */
|
|
11510
11850
|
APP_DOMAIN = "APP_DOMAIN"
|
|
11511
11851
|
}
|
|
11852
|
+
/** @enumType */
|
|
11853
|
+
export type StorageDomainWithLiterals = StorageDomain | 'UNKNOWN_STORAGE_DOMAIN' | 'SITE_DOMAIN' | 'WIX_DOMAIN' | 'APP_DOMAIN';
|
|
11512
11854
|
/** Describe SDK module definition for an app */
|
|
11513
11855
|
export interface SdkDefinition {
|
|
11514
11856
|
/**
|
|
@@ -11540,7 +11882,7 @@ export interface EventValidationProviderConfig {
|
|
|
11540
11882
|
}
|
|
11541
11883
|
export interface ValidationTarget {
|
|
11542
11884
|
/** The method to validate. */
|
|
11543
|
-
method?:
|
|
11885
|
+
method?: MethodWithLiterals;
|
|
11544
11886
|
/**
|
|
11545
11887
|
* Optional WQL filter applied to the events for validation.
|
|
11546
11888
|
* Only events matching this filter will be validated.
|
|
@@ -11557,6 +11899,8 @@ export declare enum Method {
|
|
|
11557
11899
|
/** Validate an event before cancel. */
|
|
11558
11900
|
CANCEL = "CANCEL"
|
|
11559
11901
|
}
|
|
11902
|
+
/** @enumType */
|
|
11903
|
+
export type MethodWithLiterals = Method | 'CREATE' | 'UPDATE' | 'CANCEL';
|
|
11560
11904
|
/** Client Service is a broad category encompassing any value, function, or feature that an application needs. A service is typically a class with a narrow, well-defined purpose. A component is one type of class that can use DI. */
|
|
11561
11905
|
export interface ClientSideService {
|
|
11562
11906
|
/**
|
|
@@ -11707,7 +12051,7 @@ export interface AudienceProviderConfig {
|
|
|
11707
12051
|
*/
|
|
11708
12052
|
displayName?: string;
|
|
11709
12053
|
/** Type of participant. Each audience provider can support only one type of recipient */
|
|
11710
|
-
participantType?:
|
|
12054
|
+
participantType?: ParticipantTypeWithLiterals;
|
|
11711
12055
|
/** Standard json schema which describe the json the provider should get in the Resolve end point */
|
|
11712
12056
|
inputSchema?: Record<string, any> | null;
|
|
11713
12057
|
/**
|
|
@@ -11721,7 +12065,7 @@ export interface AudienceProviderConfig {
|
|
|
11721
12065
|
* Define the scopes which the provider audience is relevant
|
|
11722
12066
|
* @maxSize 10
|
|
11723
12067
|
*/
|
|
11724
|
-
scopes?:
|
|
12068
|
+
scopes?: ScopeWithLiterals[];
|
|
11725
12069
|
}
|
|
11726
12070
|
export declare enum ParticipantType {
|
|
11727
12071
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
@@ -11729,11 +12073,13 @@ export declare enum ParticipantType {
|
|
|
11729
12073
|
CONTACT = "CONTACT",
|
|
11730
12074
|
ANONYMOUS = "ANONYMOUS"
|
|
11731
12075
|
}
|
|
12076
|
+
/** @enumType */
|
|
12077
|
+
export type ParticipantTypeWithLiterals = ParticipantType | 'UNKNOWN_TYPE' | 'WIX_USER' | 'CONTACT' | 'ANONYMOUS';
|
|
11732
12078
|
export interface InterfaceConfiguration extends InterfaceConfigurationOfTypeOneOf {
|
|
11733
12079
|
/** Should be filled if the provider implements its own custom UI */
|
|
11734
12080
|
widgetComponentConfiguration?: WidgetComponent;
|
|
11735
12081
|
/** Type of interface configuration */
|
|
11736
|
-
type?:
|
|
12082
|
+
type?: InterfaceConfigurationTypeWithLiterals;
|
|
11737
12083
|
}
|
|
11738
12084
|
/** @oneof */
|
|
11739
12085
|
export interface InterfaceConfigurationOfTypeOneOf {
|
|
@@ -11746,6 +12092,8 @@ export declare enum InterfaceConfigurationType {
|
|
|
11746
12092
|
/** Item Selection, in case the provider implemented item selection component */
|
|
11747
12093
|
ITEM_SELECTION = "ITEM_SELECTION"
|
|
11748
12094
|
}
|
|
12095
|
+
/** @enumType */
|
|
12096
|
+
export type InterfaceConfigurationTypeWithLiterals = InterfaceConfigurationType | 'WIDGET_COMPONENT' | 'ITEM_SELECTION';
|
|
11749
12097
|
export interface WidgetComponent {
|
|
11750
12098
|
/**
|
|
11751
12099
|
* widget component id
|
|
@@ -11777,6 +12125,8 @@ export declare enum Scope {
|
|
|
11777
12125
|
/** Provider audience is available only in scope of non specific site */
|
|
11778
12126
|
NON_SPECIFIC_SITE = "NON_SPECIFIC_SITE"
|
|
11779
12127
|
}
|
|
12128
|
+
/** @enumType */
|
|
12129
|
+
export type ScopeWithLiterals = Scope | 'SPECIFIC_SITE' | 'NON_SPECIFIC_SITE';
|
|
11780
12130
|
/** Config for the Price SPI */
|
|
11781
12131
|
export interface PriceSPIConfig {
|
|
11782
12132
|
/**
|
|
@@ -11853,7 +12203,7 @@ export interface EditorReactComponent {
|
|
|
11853
12203
|
* @replacedBy editor_element.archetype
|
|
11854
12204
|
* @targetRemovalDate 2026-06-30
|
|
11855
12205
|
*/
|
|
11856
|
-
archetype?:
|
|
12206
|
+
archetype?: ArchetypeWithLiterals;
|
|
11857
12207
|
}
|
|
11858
12208
|
export interface Resources {
|
|
11859
12209
|
/** The bundle we will load and render in the browser */
|
|
@@ -11902,15 +12252,16 @@ export interface TranslationResources {
|
|
|
11902
12252
|
export interface EditorElement {
|
|
11903
12253
|
/**
|
|
11904
12254
|
* DOM Query selector for this element that we can use to find it when rendering it (preferably a className)
|
|
11905
|
-
* @minLength
|
|
11906
|
-
* @maxLength
|
|
12255
|
+
* @minLength 4
|
|
12256
|
+
* @maxLength 50
|
|
11907
12257
|
*/
|
|
11908
12258
|
selector?: string;
|
|
11909
12259
|
/**
|
|
11910
12260
|
* Human friendly name on the editor stage when the component is in interaction with the user
|
|
11911
|
-
* @
|
|
12261
|
+
* @minLength 4
|
|
12262
|
+
* @maxLength 20
|
|
11912
12263
|
*/
|
|
11913
|
-
displayName?: string
|
|
12264
|
+
displayName?: string;
|
|
11914
12265
|
/** style-api of this element, a map of style-items where the key is the style-item name and the value is the style-item definition. These will be manifested as CSS vars in the scope of the component and prefixed with `--` */
|
|
11915
12266
|
style?: Record<string, StyleItem>;
|
|
11916
12267
|
/** data-api of this element, a map of data-items where the key is the data-item name and the value is the data-item definition. These will be manifested as `props` for the component */
|
|
@@ -11928,13 +12279,13 @@ export interface EditorElement {
|
|
|
11928
12279
|
/** Layout capabilities of the component */
|
|
11929
12280
|
layout?: EditorElementLayout;
|
|
11930
12281
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
11931
|
-
archetype?:
|
|
12282
|
+
archetype?: ArchetypeWithLiterals;
|
|
11932
12283
|
}
|
|
11933
12284
|
export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSelectedCssPropertyTypeOneOf, StyleItemSelectedCssVariableTypeOneOf {
|
|
11934
12285
|
/** type selection key for css-properties */
|
|
11935
|
-
cssPropertyType?:
|
|
12286
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11936
12287
|
/** type selection key for css-data-types */
|
|
11937
|
-
cssVariableType?:
|
|
12288
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11938
12289
|
/** Additional options to refine the filter variable */
|
|
11939
12290
|
filter?: Filter;
|
|
11940
12291
|
/** Additional options to refine the backdropFilter variable */
|
|
@@ -11958,9 +12309,9 @@ export interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSele
|
|
|
11958
12309
|
/** @oneof */
|
|
11959
12310
|
export interface StyleItemSelectedItemTypeOneOf {
|
|
11960
12311
|
/** type selection key for css-properties */
|
|
11961
|
-
cssPropertyType?:
|
|
12312
|
+
cssPropertyType?: CssPropertyTypeWithLiterals;
|
|
11962
12313
|
/** type selection key for css-data-types */
|
|
11963
|
-
cssVariableType?:
|
|
12314
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
11964
12315
|
}
|
|
11965
12316
|
/** @oneof */
|
|
11966
12317
|
export interface StyleItemSelectedCssPropertyTypeOneOf {
|
|
@@ -12094,6 +12445,8 @@ export declare enum CssPropertyType {
|
|
|
12094
12445
|
mixBlendMode = "mixBlendMode",
|
|
12095
12446
|
isolation = "isolation"
|
|
12096
12447
|
}
|
|
12448
|
+
/** @enumType */
|
|
12449
|
+
export type CssPropertyTypeWithLiterals = CssPropertyType | 'UNKNOWN_CssPropertyType' | 'background' | 'backgroundSize' | 'backgroundColor' | 'backgroundImage' | 'backgroundClip' | 'backgroundOrigin' | 'backgroundPosition' | 'backgroundRepeat' | 'backgroundAttachment' | 'fill' | 'margin' | 'marginTop' | 'marginRight' | 'marginBottom' | 'marginLeft' | 'marginInlineStart' | 'marginInlineEnd' | 'padding' | 'paddingTop' | 'paddingRight' | 'paddingBottom' | 'paddingLeft' | 'paddingInlineStart' | 'paddingInlineEnd' | 'border' | 'borderWidth' | 'borderStyle' | 'borderColor' | 'borderTop' | 'borderTopColor' | 'borderTopWidth' | 'borderTopStyle' | 'borderRight' | 'borderRightColor' | 'borderRightWidth' | 'borderRightStyle' | 'borderBottom' | 'borderBottomColor' | 'borderBottomWidth' | 'borderBottomStyle' | 'borderLeft' | 'borderLeftColor' | 'borderLeftWidth' | 'borderLeftStyle' | 'borderInlineStart' | 'borderInlineStartColor' | 'borderInlineStartWidth' | 'borderInlineStartStyle' | 'borderInlineEnd' | 'borderInlineEndColor' | 'borderInlineEndWidth' | 'borderInlineEndStyle' | 'borderRadius' | 'borderTopLeftRadius' | 'borderTopRightRadius' | 'borderBottomRightRadius' | 'borderBottomLeftRadius' | 'borderStartStartRadius' | 'borderStartEndRadius' | 'borderEndStartRadius' | 'borderEndEndRadius' | 'font' | 'fontFamily' | 'fontSize' | 'fontStretch' | 'fontStyle' | 'fontVariant' | 'fontWeight' | 'lineHeight' | 'color' | 'letterSpacing' | 'writingMode' | 'textAlign' | 'textTransform' | 'textShadow' | 'textOverflow' | 'textDecoration' | 'textDecorationColor' | 'textDecorationLine' | 'textDecorationStyle' | 'textDecorationThickness' | 'boxShadow' | 'opacity' | 'overflow' | 'display' | 'alignSelf' | 'justifyContent' | 'alignItems' | 'flexDirection' | 'gap' | 'height' | 'width' | 'columnGap' | 'rowGap' | 'filter' | 'backdropFilter' | 'objectFit' | 'objectPosition' | 'mixBlendMode' | 'isolation';
|
|
12097
12450
|
/** The supported [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Types) in Javascript naming format */
|
|
12098
12451
|
export declare enum CssDataType {
|
|
12099
12452
|
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
@@ -12107,12 +12460,14 @@ export declare enum CssDataType {
|
|
|
12107
12460
|
customEnum = "customEnum",
|
|
12108
12461
|
string = "string"
|
|
12109
12462
|
}
|
|
12463
|
+
/** @enumType */
|
|
12464
|
+
export type CssDataTypeWithLiterals = CssDataType | 'UNKNOWN_CssDataType' | 'number' | 'length' | 'color' | 'angle' | 'percentage' | 'lengthPercentage' | 'blendMode' | 'customEnum' | 'string';
|
|
12110
12465
|
export interface Filter {
|
|
12111
12466
|
/**
|
|
12112
12467
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12113
12468
|
* @maxSize 100
|
|
12114
12469
|
*/
|
|
12115
|
-
filterFunctions?:
|
|
12470
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12116
12471
|
}
|
|
12117
12472
|
export declare enum FilterFunction {
|
|
12118
12473
|
UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
|
|
@@ -12137,19 +12492,21 @@ export declare enum FilterFunction {
|
|
|
12137
12492
|
/** The value used for saturate filter */
|
|
12138
12493
|
saturate = "saturate"
|
|
12139
12494
|
}
|
|
12495
|
+
/** @enumType */
|
|
12496
|
+
export type FilterFunctionWithLiterals = FilterFunction | 'UNKNOWN_FilterFunctions' | 'blur' | 'brightness' | 'contrast' | 'drop_shadow' | 'grayscale' | 'hue_rotate' | 'invert' | 'opacity' | 'sepia' | 'saturate';
|
|
12140
12497
|
export interface BackdropFilter {
|
|
12141
12498
|
/**
|
|
12142
12499
|
* List of filter functions in case of reducing the abilities exposed to the User
|
|
12143
12500
|
* @maxSize 100
|
|
12144
12501
|
*/
|
|
12145
|
-
filterFunctions?:
|
|
12502
|
+
filterFunctions?: FilterFunctionWithLiterals[];
|
|
12146
12503
|
}
|
|
12147
12504
|
export interface Display {
|
|
12148
12505
|
/**
|
|
12149
12506
|
* list of display values in case we want to reduce the abilities exposed to the User
|
|
12150
12507
|
* @maxSize 20
|
|
12151
12508
|
*/
|
|
12152
|
-
displayValues?:
|
|
12509
|
+
displayValues?: DisplayValueEnumDisplayValueWithLiterals[];
|
|
12153
12510
|
}
|
|
12154
12511
|
export declare enum DisplayValueEnumDisplayValue {
|
|
12155
12512
|
UNKNOWN_DisplayValue = "UNKNOWN_DisplayValue",
|
|
@@ -12168,12 +12525,14 @@ export declare enum DisplayValueEnumDisplayValue {
|
|
|
12168
12525
|
inline_flex = "inline_flex",
|
|
12169
12526
|
inline_grid = "inline_grid"
|
|
12170
12527
|
}
|
|
12528
|
+
/** @enumType */
|
|
12529
|
+
export type DisplayValueEnumDisplayValueWithLiterals = DisplayValueEnumDisplayValue | 'UNKNOWN_DisplayValue' | 'none' | 'block' | 'inline' | 'flow' | 'flowRoot' | 'table' | 'flex' | 'grid' | 'list_item' | 'contents' | 'inline_block' | 'inline_table' | 'inline_flex' | 'inline_grid';
|
|
12171
12530
|
export interface WritingMode {
|
|
12172
12531
|
/**
|
|
12173
12532
|
* list of writing-mode values in case we want to reduce the abilities exposed to the User
|
|
12174
12533
|
* @maxSize 20
|
|
12175
12534
|
*/
|
|
12176
|
-
writingModeValues?:
|
|
12535
|
+
writingModeValues?: WritingModeValueWithLiterals[];
|
|
12177
12536
|
}
|
|
12178
12537
|
export declare enum WritingModeValue {
|
|
12179
12538
|
UNKNOWN_WritingModeValue = "UNKNOWN_WritingModeValue",
|
|
@@ -12183,9 +12542,11 @@ export declare enum WritingModeValue {
|
|
|
12183
12542
|
sidewaysRl = "sidewaysRl",
|
|
12184
12543
|
sidewaysLr = "sidewaysLr"
|
|
12185
12544
|
}
|
|
12545
|
+
/** @enumType */
|
|
12546
|
+
export type WritingModeValueWithLiterals = WritingModeValue | 'UNKNOWN_WritingModeValue' | 'horizontalTb' | 'verticalRl' | 'verticalLr' | 'sidewaysRl' | 'sidewaysLr';
|
|
12186
12547
|
export interface CustomEnum {
|
|
12187
12548
|
/** the type of enum values */
|
|
12188
|
-
cssVariableType?:
|
|
12549
|
+
cssVariableType?: CssDataTypeWithLiterals;
|
|
12189
12550
|
/**
|
|
12190
12551
|
* Editor-only: defines allowed values
|
|
12191
12552
|
* @maxSize 100
|
|
@@ -12199,18 +12560,16 @@ export interface CustomEnumOption {
|
|
|
12199
12560
|
*/
|
|
12200
12561
|
value?: string;
|
|
12201
12562
|
/** @maxLength 100 */
|
|
12202
|
-
displayName?: string
|
|
12563
|
+
displayName?: string;
|
|
12203
12564
|
}
|
|
12204
12565
|
export interface CustomEnumOptionCssProperty {
|
|
12205
12566
|
/**
|
|
12206
12567
|
* the css property
|
|
12207
|
-
* @minLength 1
|
|
12208
12568
|
* @maxLength 100
|
|
12209
12569
|
*/
|
|
12210
12570
|
property?: string;
|
|
12211
12571
|
/**
|
|
12212
12572
|
* the css value
|
|
12213
|
-
* @minLength 1
|
|
12214
12573
|
* @maxLength 100
|
|
12215
12574
|
*/
|
|
12216
12575
|
value?: string;
|
|
@@ -12241,7 +12600,7 @@ export interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
|
12241
12600
|
/** A container in which to render another component */
|
|
12242
12601
|
container?: ReactElementContainer;
|
|
12243
12602
|
/** Defines the type of data we are configuring */
|
|
12244
|
-
dataType?:
|
|
12603
|
+
dataType?: DataTypeWithLiterals;
|
|
12245
12604
|
/**
|
|
12246
12605
|
* Display name of this data item
|
|
12247
12606
|
* @maxLength 100
|
|
@@ -12320,6 +12679,8 @@ export declare enum DataType {
|
|
|
12320
12679
|
/** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
|
|
12321
12680
|
direction = "direction"
|
|
12322
12681
|
}
|
|
12682
|
+
/** @enumType */
|
|
12683
|
+
export type DataTypeWithLiterals = DataType | 'UNKNOWN_DataType' | 'text' | 'textEnum' | 'number' | 'booleanValue' | 'a11y' | 'link' | 'image' | 'video' | 'vectorArt' | 'audio' | 'schema' | 'localDate' | 'localTime' | 'localDateTime' | 'webUrl' | 'email' | 'phone' | 'hostname' | 'regex' | 'guid' | 'richText' | 'container' | 'arrayItems' | 'direction';
|
|
12323
12684
|
export interface Text {
|
|
12324
12685
|
/** Indicates maximum length allowed for the text */
|
|
12325
12686
|
maxLength?: number | null;
|
|
@@ -12348,7 +12709,7 @@ export interface Option {
|
|
|
12348
12709
|
* display name for this text item
|
|
12349
12710
|
* @maxLength 100
|
|
12350
12711
|
*/
|
|
12351
|
-
displayName?: string
|
|
12712
|
+
displayName?: string;
|
|
12352
12713
|
}
|
|
12353
12714
|
export interface _Number {
|
|
12354
12715
|
/** Indicates minimum value required for the number */
|
|
@@ -12363,7 +12724,7 @@ export interface A11y {
|
|
|
12363
12724
|
* A collection of attributes that will be stated in the manifest
|
|
12364
12725
|
* @maxSize 100
|
|
12365
12726
|
*/
|
|
12366
|
-
attributes?:
|
|
12727
|
+
attributes?: A11yAttributesWithLiterals[];
|
|
12367
12728
|
}
|
|
12368
12729
|
export declare enum A11yAttributes {
|
|
12369
12730
|
Unknown_AriaAttributes = "Unknown_AriaAttributes",
|
|
@@ -12418,12 +12779,14 @@ export declare enum A11yAttributes {
|
|
|
12418
12779
|
/** The value used for aria-invalid */
|
|
12419
12780
|
ariaInvalid = "ariaInvalid"
|
|
12420
12781
|
}
|
|
12782
|
+
/** @enumType */
|
|
12783
|
+
export type A11yAttributesWithLiterals = A11yAttributes | 'Unknown_AriaAttributes' | 'tabIndex' | 'ariaLevel' | 'ariaExpanded' | 'ariaDisabled' | 'ariaAtomic' | 'ariaHidden' | 'ariaBusy' | 'multiline' | 'ariaAutocomplete' | 'ariaPressed' | 'ariaHaspopup' | 'ariaRelevant' | 'role' | 'ariaLive' | 'ariaCurrent' | 'ariaLabel' | 'ariaRoledescription' | 'ariaDescribedby' | 'ariaLabelledby' | 'ariaErrormessage' | 'ariaOwns' | 'ariaControls' | 'tag' | 'ariaMultiline' | 'ariaInvalid';
|
|
12421
12784
|
export interface Link {
|
|
12422
12785
|
/**
|
|
12423
12786
|
* A collection of possible link types that the component supports. Only one of the types will make it to the component after input.
|
|
12424
12787
|
* @maxSize 12
|
|
12425
12788
|
*/
|
|
12426
|
-
linkTypes?:
|
|
12789
|
+
linkTypes?: LinkTypeWithLiterals[];
|
|
12427
12790
|
}
|
|
12428
12791
|
export declare enum LinkType {
|
|
12429
12792
|
UNKNOWN_LinkType = "UNKNOWN_LinkType",
|
|
@@ -12452,6 +12815,8 @@ export declare enum LinkType {
|
|
|
12452
12815
|
/** A link that directs the user to wix login dialog */
|
|
12453
12816
|
loginToWixLink = "loginToWixLink"
|
|
12454
12817
|
}
|
|
12818
|
+
/** @enumType */
|
|
12819
|
+
export type LinkTypeWithLiterals = LinkType | 'UNKNOWN_LinkType' | 'externalLink' | 'anchorLink' | 'emailLink' | 'phoneLink' | 'dynamicPageLink' | 'pageLink' | 'whatsAppLink' | 'documentLink' | 'popupLink' | 'addressLink' | 'edgeAnchorLinks' | 'loginToWixLink';
|
|
12455
12820
|
/** An array of data items or complex data types */
|
|
12456
12821
|
export interface ArrayItems extends ArrayItemsArrayDataOneOf {
|
|
12457
12822
|
/** The definition of multiple data items in each item of the Array */
|
|
@@ -12488,11 +12853,12 @@ export interface ReactElementContainer extends ReactElementContainerSelectedCont
|
|
|
12488
12853
|
placeholder?: PlaceHolder;
|
|
12489
12854
|
/**
|
|
12490
12855
|
* A DOM Selector that will allow us to target it in the editor
|
|
12856
|
+
* @minLength 2
|
|
12491
12857
|
* @maxLength 100
|
|
12492
12858
|
*/
|
|
12493
|
-
selector?: string
|
|
12859
|
+
selector?: string;
|
|
12494
12860
|
/** The type of Container to be rendered */
|
|
12495
|
-
containerType?:
|
|
12861
|
+
containerType?: ContainerTypeWithLiterals;
|
|
12496
12862
|
}
|
|
12497
12863
|
/** @oneof */
|
|
12498
12864
|
export interface ReactElementContainerSelectedContainerTypeOneOf {
|
|
@@ -12513,6 +12879,8 @@ export declare enum ContainerType {
|
|
|
12513
12879
|
/** A container to add elements targeting a specific product use case, exposed in DEV Center */
|
|
12514
12880
|
placeholder = "placeholder"
|
|
12515
12881
|
}
|
|
12882
|
+
/** @enumType */
|
|
12883
|
+
export type ContainerTypeWithLiterals = ContainerType | 'UNKNOWN_CONTAINER_TYPE' | 'simple' | 'slot' | 'placeholder';
|
|
12516
12884
|
/** Currently doesn't have any properties defined */
|
|
12517
12885
|
export interface SimpleContainer {
|
|
12518
12886
|
}
|
|
@@ -12536,7 +12904,7 @@ export interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
|
12536
12904
|
/** A reference to the used element with overrides */
|
|
12537
12905
|
refElement?: RefElement;
|
|
12538
12906
|
/** Defines the type of element we are configuring */
|
|
12539
|
-
elementType?:
|
|
12907
|
+
elementType?: ElementTypeWithLiterals;
|
|
12540
12908
|
}
|
|
12541
12909
|
/** @oneof */
|
|
12542
12910
|
export interface ElementItemSelectedElementTypeOneOf {
|
|
@@ -12552,18 +12920,21 @@ export declare enum ElementType {
|
|
|
12552
12920
|
/** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
|
|
12553
12921
|
refElement = "refElement"
|
|
12554
12922
|
}
|
|
12923
|
+
/** @enumType */
|
|
12924
|
+
export type ElementTypeWithLiterals = ElementType | 'UNKNOWN_ElementType' | 'inlineElement' | 'refElement';
|
|
12555
12925
|
export interface InlineElement {
|
|
12556
12926
|
/**
|
|
12557
12927
|
* Relative DOM Query selector for this element. We assume nesting by it's parent elements for CSS Vars scoping.
|
|
12558
|
-
* @minLength
|
|
12559
|
-
* @maxLength
|
|
12928
|
+
* @minLength 4
|
|
12929
|
+
* @maxLength 50
|
|
12560
12930
|
*/
|
|
12561
12931
|
selector?: string;
|
|
12562
12932
|
/**
|
|
12563
12933
|
* Human friendly name on the editor stage when the component is in interaction with the user
|
|
12564
|
-
* @
|
|
12934
|
+
* @minLength 4
|
|
12935
|
+
* @maxLength 20
|
|
12565
12936
|
*/
|
|
12566
|
-
displayName?: string
|
|
12937
|
+
displayName?: string;
|
|
12567
12938
|
/** style-api of this element, a map of style-items where the key is the style-item name and the value is the style-item definition. These will be manifested as CSS vars in the scope of the component and prefixed with `--` */
|
|
12568
12939
|
style?: Record<string, StyleItem>;
|
|
12569
12940
|
/** data-api of this element, a map of data-items where the key is the data-item name and the value is the data-item definition */
|
|
@@ -12581,7 +12952,7 @@ export interface InlineElement {
|
|
|
12581
12952
|
/** The default preset, styles and data of inner elements */
|
|
12582
12953
|
elementsDefaults?: Record<string, ElementDefaults>;
|
|
12583
12954
|
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
12584
|
-
archetype?:
|
|
12955
|
+
archetype?: ArchetypeWithLiterals;
|
|
12585
12956
|
}
|
|
12586
12957
|
export interface Behaviors {
|
|
12587
12958
|
/** Determines if the inner-element can be selectable in the editor */
|
|
@@ -12607,9 +12978,10 @@ export interface Action {
|
|
|
12607
12978
|
hidden?: boolean | null;
|
|
12608
12979
|
/**
|
|
12609
12980
|
* The public human-readable name given to the action by the developer.
|
|
12610
|
-
* @
|
|
12981
|
+
* @minLength 4
|
|
12982
|
+
* @maxLength 20
|
|
12611
12983
|
*/
|
|
12612
|
-
displayName?: string
|
|
12984
|
+
displayName?: string;
|
|
12613
12985
|
/** A model definition for declaring a concrete instructions action will perform */
|
|
12614
12986
|
execution?: Execution;
|
|
12615
12987
|
}
|
|
@@ -12625,7 +12997,7 @@ export interface Execution extends ExecutionActionExecuteOneOf {
|
|
|
12625
12997
|
/** Executes an action on a target element (based on path) */
|
|
12626
12998
|
forward?: ForwardAction;
|
|
12627
12999
|
/** The action type allows to determine the return type of the execution function */
|
|
12628
|
-
actionType?:
|
|
13000
|
+
actionType?: ActionTypeWithLiterals;
|
|
12629
13001
|
}
|
|
12630
13002
|
/** @oneof */
|
|
12631
13003
|
export interface ExecutionActionExecuteOneOf {
|
|
@@ -12648,6 +13020,8 @@ export declare enum ActionType {
|
|
|
12648
13020
|
forward = "forward",
|
|
12649
13021
|
style = "style"
|
|
12650
13022
|
}
|
|
13023
|
+
/** @enumType */
|
|
13024
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ActionType' | 'data' | 'event' | 'panel' | 'forward' | 'style';
|
|
12651
13025
|
/** Represents an action that interacts with a specific data item */
|
|
12652
13026
|
export interface DataAction {
|
|
12653
13027
|
/**
|
|
@@ -12683,7 +13057,7 @@ export interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
|
|
|
12683
13057
|
*/
|
|
12684
13058
|
panelId?: string;
|
|
12685
13059
|
/** The selected panel reference type */
|
|
12686
|
-
panelType?:
|
|
13060
|
+
panelType?: PanelTypeWithLiterals;
|
|
12687
13061
|
}
|
|
12688
13062
|
/** @oneof */
|
|
12689
13063
|
export interface PanelActionSelectedPanelTypeOneOf {
|
|
@@ -12698,6 +13072,8 @@ export declare enum PanelType {
|
|
|
12698
13072
|
UNKNOWN_PanelType = "UNKNOWN_PanelType",
|
|
12699
13073
|
panelId = "panelId"
|
|
12700
13074
|
}
|
|
13075
|
+
/** @enumType */
|
|
13076
|
+
export type PanelTypeWithLiterals = PanelType | 'UNKNOWN_PanelType' | 'panelId';
|
|
12701
13077
|
/** Represents an action that targets another element within the component */
|
|
12702
13078
|
export interface ForwardAction extends ForwardActionActionOneOf {
|
|
12703
13079
|
/**
|
|
@@ -12707,7 +13083,7 @@ export interface ForwardAction extends ForwardActionActionOneOf {
|
|
|
12707
13083
|
*/
|
|
12708
13084
|
custom?: string;
|
|
12709
13085
|
/** Specifies the action names (one of the natives or custom) */
|
|
12710
|
-
actionName?:
|
|
13086
|
+
actionName?: ActionNameWithLiterals;
|
|
12711
13087
|
/**
|
|
12712
13088
|
* Path to the target element
|
|
12713
13089
|
* @minLength 1
|
|
@@ -12739,19 +13115,23 @@ export declare enum ActionName {
|
|
|
12739
13115
|
/** actionName to be triggered from the defined custom actions */
|
|
12740
13116
|
custom = "custom"
|
|
12741
13117
|
}
|
|
13118
|
+
/** @enumType */
|
|
13119
|
+
export type ActionNameWithLiterals = ActionName | 'UNKNOWN_ActionName' | 'settings' | 'design' | 'media' | 'manageItems' | 'dashboard' | 'custom';
|
|
12742
13120
|
export interface DashboardAction {
|
|
12743
13121
|
/** Defines whether the action is being displayed */
|
|
12744
13122
|
hidden?: boolean | null;
|
|
12745
13123
|
/**
|
|
12746
13124
|
* The public human-readable name given to the action by the developer.
|
|
12747
|
-
* @
|
|
13125
|
+
* @minLength 4
|
|
13126
|
+
* @maxLength 20
|
|
12748
13127
|
*/
|
|
12749
|
-
displayName?: string
|
|
13128
|
+
displayName?: string;
|
|
12750
13129
|
/**
|
|
12751
13130
|
* Optional pageId of the dashboard in case there is more than one
|
|
13131
|
+
* @minLength 4
|
|
12752
13132
|
* @maxLength 50
|
|
12753
13133
|
*/
|
|
12754
|
-
dashboardPageId?: string
|
|
13134
|
+
dashboardPageId?: string;
|
|
12755
13135
|
/** A model definition for declaring a concrete instructions action will perform */
|
|
12756
13136
|
execution?: Execution;
|
|
12757
13137
|
}
|
|
@@ -12759,6 +13139,7 @@ export interface PresetItem {
|
|
|
12759
13139
|
/**
|
|
12760
13140
|
* A URL to the CSS file of this preset
|
|
12761
13141
|
* @format WEB_URL
|
|
13142
|
+
* @minLength 13
|
|
12762
13143
|
* @maxLength 500
|
|
12763
13144
|
*/
|
|
12764
13145
|
cssUrl?: string;
|
|
@@ -12766,10 +13147,11 @@ export interface PresetItem {
|
|
|
12766
13147
|
* Preset name for displaying purposes in the editor
|
|
12767
13148
|
* @maxLength 100
|
|
12768
13149
|
*/
|
|
12769
|
-
displayName?: string
|
|
13150
|
+
displayName?: string;
|
|
12770
13151
|
/**
|
|
12771
13152
|
* A URL to the CSS preset thumbnail file
|
|
12772
13153
|
* @format WEB_URL
|
|
13154
|
+
* @minLength 13
|
|
12773
13155
|
* @maxLength 500
|
|
12774
13156
|
*/
|
|
12775
13157
|
thumbnailUrl?: string | null;
|
|
@@ -12785,7 +13167,7 @@ export interface ElementStyleDefaults {
|
|
|
12785
13167
|
* The default preset for an element
|
|
12786
13168
|
* @maxLength 100
|
|
12787
13169
|
*/
|
|
12788
|
-
presetKey?: string
|
|
13170
|
+
presetKey?: string;
|
|
12789
13171
|
/** The default styles for an element */
|
|
12790
13172
|
style?: Record<string, any>;
|
|
12791
13173
|
/** The default preset and styles for inner elements */
|
|
@@ -12804,7 +13186,7 @@ export interface InitialSizeSetting extends InitialSizeSettingSelectedSizingType
|
|
|
12804
13186
|
*/
|
|
12805
13187
|
pixels?: number;
|
|
12806
13188
|
/** The initial size type */
|
|
12807
|
-
sizingType?:
|
|
13189
|
+
sizingType?: SizingTypeWithLiterals;
|
|
12808
13190
|
}
|
|
12809
13191
|
/** @oneof */
|
|
12810
13192
|
export interface InitialSizeSettingSelectedSizingTypeOneOf {
|
|
@@ -12823,6 +13205,8 @@ export declare enum SizingType {
|
|
|
12823
13205
|
/** Initial size should be set in pixels */
|
|
12824
13206
|
pixels = "pixels"
|
|
12825
13207
|
}
|
|
13208
|
+
/** @enumType */
|
|
13209
|
+
export type SizingTypeWithLiterals = SizingType | 'UNKNOWN_SizingType' | 'content' | 'stretched' | 'pixels';
|
|
12826
13210
|
export interface ElementDefaults {
|
|
12827
13211
|
/**
|
|
12828
13212
|
* The default preset for an element
|
|
@@ -12876,6 +13260,8 @@ export declare enum Archetype {
|
|
|
12876
13260
|
VectorArt = "VectorArt",
|
|
12877
13261
|
AnimatedGraphic = "AnimatedGraphic"
|
|
12878
13262
|
}
|
|
13263
|
+
/** @enumType */
|
|
13264
|
+
export type ArchetypeWithLiterals = Archetype | 'UNKNOWN_Archetype' | 'Button' | 'LoginButton' | 'Image' | 'Gallery' | 'Video' | 'Audio' | 'Text' | 'TextInput' | 'RichTextEditor' | 'SignatureInput' | 'Checkbox' | 'RadioGroup' | 'Switch' | 'Dropdown' | 'DatePicker' | 'TimePicker' | 'Ratings' | 'RatingInput' | 'Menu' | 'Pagination' | 'Slider' | 'Container' | 'Carousel' | 'Accordion' | 'Tabs' | 'ProgressBar' | 'Upload' | 'Social' | 'Breadcrumbs' | 'SearchBox' | 'Map' | 'Line' | 'Logo' | 'Avatar' | 'Captcha' | 'VectorArt' | 'AnimatedGraphic';
|
|
12879
13265
|
export interface RefElement {
|
|
12880
13266
|
/**
|
|
12881
13267
|
* The type of the referenced element. Must exist in the Wix Dev Center and be fullly typed (`appSlug.componentType`).
|
|
@@ -12891,9 +13277,10 @@ export interface RefElement {
|
|
|
12891
13277
|
selector?: string;
|
|
12892
13278
|
/**
|
|
12893
13279
|
* The override of the used element displayName
|
|
12894
|
-
* @
|
|
13280
|
+
* @minLength 4
|
|
13281
|
+
* @maxLength 20
|
|
12895
13282
|
*/
|
|
12896
|
-
displayName?: string
|
|
13283
|
+
displayName?: string;
|
|
12897
13284
|
/** The override of the used element style */
|
|
12898
13285
|
style?: Record<string, StyleItemOverrides>;
|
|
12899
13286
|
/** The override of the used element data */
|
|
@@ -12926,9 +13313,9 @@ export interface DataItemOverrides {
|
|
|
12926
13313
|
/** Top-level message containing all layout capabilities */
|
|
12927
13314
|
export interface EditorElementLayout {
|
|
12928
13315
|
/** The resizing capabilities this component can supports */
|
|
12929
|
-
resizeDirection?:
|
|
13316
|
+
resizeDirection?: ResizeDirectionWithLiterals;
|
|
12930
13317
|
/** Describes the ability of content to impact on the size of this component */
|
|
12931
|
-
contentResizeDirection?:
|
|
13318
|
+
contentResizeDirection?: ContentResizeDirectionWithLiterals;
|
|
12932
13319
|
/** Will control the availability of the stretch capability for this component */
|
|
12933
13320
|
disableStretching?: boolean | null;
|
|
12934
13321
|
/** Will control the availability of freely positioning this component */
|
|
@@ -12948,6 +13335,8 @@ export declare enum ResizeDirection {
|
|
|
12948
13335
|
/** Component cannot be resized in any direction */
|
|
12949
13336
|
none = "none"
|
|
12950
13337
|
}
|
|
13338
|
+
/** @enumType */
|
|
13339
|
+
export type ResizeDirectionWithLiterals = ResizeDirection | 'UNKNOWN_ResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'aspectRatio' | 'none';
|
|
12951
13340
|
export declare enum ContentResizeDirection {
|
|
12952
13341
|
/** Default value when content resize behavior is not specified */
|
|
12953
13342
|
UNKNOWN_ContentResizeDirection = "UNKNOWN_ContentResizeDirection",
|
|
@@ -12960,9 +13349,11 @@ export declare enum ContentResizeDirection {
|
|
|
12960
13349
|
/** Component's size will not be affected by its content */
|
|
12961
13350
|
none = "none"
|
|
12962
13351
|
}
|
|
13352
|
+
/** @enumType */
|
|
13353
|
+
export type ContentResizeDirectionWithLiterals = ContentResizeDirection | 'UNKNOWN_ContentResizeDirection' | 'horizontal' | 'vertical' | 'horizontalAndVertical' | 'none';
|
|
12963
13354
|
export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
12964
13355
|
/** Which static container should the component be installed at */
|
|
12965
|
-
staticContainer?:
|
|
13356
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12966
13357
|
/** Default presets per breakpoint with which the component should be installed */
|
|
12967
13358
|
presets?: DefaultPresets;
|
|
12968
13359
|
/** Initial size with which the component should be added to the stage */
|
|
@@ -12971,7 +13362,7 @@ export interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
|
12971
13362
|
/** @oneof */
|
|
12972
13363
|
export interface InstallationInfoTargetContainerOneOf {
|
|
12973
13364
|
/** Which static container should the component be installed at */
|
|
12974
|
-
staticContainer?:
|
|
13365
|
+
staticContainer?: StaticContainerWithLiterals;
|
|
12975
13366
|
}
|
|
12976
13367
|
export interface MarketplaceSPIConfig {
|
|
12977
13368
|
/** URI where the SPI implementer is deployed */
|
|
@@ -13032,13 +13423,15 @@ export interface RestrictionsConfig {
|
|
|
13032
13423
|
}
|
|
13033
13424
|
export interface Restriction {
|
|
13034
13425
|
/** restriction level of WARNING or LOCKED */
|
|
13035
|
-
restrictionLevel?:
|
|
13426
|
+
restrictionLevel?: RestrictionLevelWithLiterals;
|
|
13036
13427
|
}
|
|
13037
13428
|
export declare enum RestrictionLevel {
|
|
13038
13429
|
UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
|
|
13039
13430
|
WARNING = "WARNING",
|
|
13040
13431
|
LOCKED = "LOCKED"
|
|
13041
13432
|
}
|
|
13433
|
+
/** @enumType */
|
|
13434
|
+
export type RestrictionLevelWithLiterals = RestrictionLevel | 'UNKNOWN_RESTRICTION_TYPE' | 'WARNING' | 'LOCKED';
|
|
13042
13435
|
export interface FormSubmissionModerationSpiConfig {
|
|
13043
13436
|
/** URI where the SPI Implementer is deployed */
|
|
13044
13437
|
deploymentUri?: SpiBaseUri;
|
|
@@ -13090,7 +13483,7 @@ export interface BackOfficeCustomization {
|
|
|
13090
13483
|
export interface Header extends HeaderConfigOneOf {
|
|
13091
13484
|
/** Only set if option == CUSTOMIZED */
|
|
13092
13485
|
customized?: HeaderConfig;
|
|
13093
|
-
displayOption?:
|
|
13486
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13094
13487
|
}
|
|
13095
13488
|
/** @oneof */
|
|
13096
13489
|
export interface HeaderConfigOneOf {
|
|
@@ -13102,6 +13495,8 @@ export declare enum ElementDisplayOption {
|
|
|
13102
13495
|
REMOVE = "REMOVE",
|
|
13103
13496
|
CUSTOMIZED = "CUSTOMIZED"
|
|
13104
13497
|
}
|
|
13498
|
+
/** @enumType */
|
|
13499
|
+
export type ElementDisplayOptionWithLiterals = ElementDisplayOption | 'UNKNOWN_OPTION' | 'REMOVE' | 'CUSTOMIZED';
|
|
13105
13500
|
/** Header configuration, you can provide extensionId or using our platform header */
|
|
13106
13501
|
export interface HeaderConfig extends HeaderConfigHeaderConfigOneOf {
|
|
13107
13502
|
platform?: PlatformHeaderConfig;
|
|
@@ -13182,7 +13577,7 @@ export interface HeaderWidgetConfig {
|
|
|
13182
13577
|
export interface Sidebar extends SidebarConfigOneOf {
|
|
13183
13578
|
/** Only set if option == CUSTOMIZED */
|
|
13184
13579
|
customized?: SidebarConfig;
|
|
13185
|
-
displayOption?:
|
|
13580
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13186
13581
|
}
|
|
13187
13582
|
/** @oneof */
|
|
13188
13583
|
export interface SidebarConfigOneOf {
|
|
@@ -13223,7 +13618,7 @@ export interface SidebarConfig {
|
|
|
13223
13618
|
export interface SidebarChildItem extends SidebarChildItemItemOneOf {
|
|
13224
13619
|
category?: SecondLevelCategory;
|
|
13225
13620
|
page?: Page;
|
|
13226
|
-
type?:
|
|
13621
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13227
13622
|
}
|
|
13228
13623
|
/** @oneof */
|
|
13229
13624
|
export interface SidebarChildItemItemOneOf {
|
|
@@ -13236,6 +13631,8 @@ export declare enum SidebarDataType {
|
|
|
13236
13631
|
PAGE = "PAGE",
|
|
13237
13632
|
SEPARATOR = "SEPARATOR"
|
|
13238
13633
|
}
|
|
13634
|
+
/** @enumType */
|
|
13635
|
+
export type SidebarDataTypeWithLiterals = SidebarDataType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'SEPARATOR';
|
|
13239
13636
|
/** Represents sidebar category of second level */
|
|
13240
13637
|
export interface SecondLevelCategory {
|
|
13241
13638
|
/**
|
|
@@ -13261,7 +13658,7 @@ export interface SecondLevelCategory {
|
|
|
13261
13658
|
*/
|
|
13262
13659
|
export interface SidebarSecondLevelChildItem extends SidebarSecondLevelChildItemItemOneOf {
|
|
13263
13660
|
page?: Page;
|
|
13264
|
-
type?:
|
|
13661
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13265
13662
|
}
|
|
13266
13663
|
/** @oneof */
|
|
13267
13664
|
export interface SidebarSecondLevelChildItemItemOneOf {
|
|
@@ -13307,7 +13704,7 @@ export interface SidebarWidgetConfig {
|
|
|
13307
13704
|
/** Root level sidebar item, can be category or separator (when not setting category) */
|
|
13308
13705
|
export interface SidebarRootItem extends SidebarRootItemItemOneOf {
|
|
13309
13706
|
category?: FirstLevelCategory;
|
|
13310
|
-
type?:
|
|
13707
|
+
type?: SidebarDataTypeWithLiterals;
|
|
13311
13708
|
}
|
|
13312
13709
|
/** @oneof */
|
|
13313
13710
|
export interface SidebarRootItemItemOneOf {
|
|
@@ -13318,7 +13715,7 @@ export interface SidebarWidget extends SidebarWidgetConfigOneOf {
|
|
|
13318
13715
|
/** Only set if option == CUSTOMIZED */
|
|
13319
13716
|
customized?: SidebarWidgetConfig;
|
|
13320
13717
|
/** Widget display option */
|
|
13321
|
-
displayOption?:
|
|
13718
|
+
displayOption?: ElementDisplayOptionWithLiterals;
|
|
13322
13719
|
}
|
|
13323
13720
|
/** @oneof */
|
|
13324
13721
|
export interface SidebarWidgetConfigOneOf {
|
|
@@ -13344,7 +13741,7 @@ export interface BackOfficeCustomizationSidebarEntity extends BackOfficeCustomiz
|
|
|
13344
13741
|
*/
|
|
13345
13742
|
appId?: string | null;
|
|
13346
13743
|
/** Sidebar entity type */
|
|
13347
|
-
type?:
|
|
13744
|
+
type?: SidebarEntityTypeWithLiterals;
|
|
13348
13745
|
}
|
|
13349
13746
|
/** @oneof */
|
|
13350
13747
|
export interface BackOfficeCustomizationSidebarEntityItemOneOf {
|
|
@@ -13372,6 +13769,8 @@ export declare enum SidebarEntityType {
|
|
|
13372
13769
|
PAGE = "PAGE",
|
|
13373
13770
|
APP = "APP"
|
|
13374
13771
|
}
|
|
13772
|
+
/** @enumType */
|
|
13773
|
+
export type SidebarEntityTypeWithLiterals = SidebarEntityType | 'UNKNOWN_TYPE' | 'CATEGORY' | 'PAGE' | 'APP';
|
|
13375
13774
|
export interface CoreApps {
|
|
13376
13775
|
/**
|
|
13377
13776
|
* List of core appIds to include in the dashboard. Only appIds present in the host's coreAppId list are allowed.
|
|
@@ -13392,7 +13791,7 @@ export interface ComponentEnricherConfig {
|
|
|
13392
13791
|
* @minSize 1
|
|
13393
13792
|
* @maxSize 100
|
|
13394
13793
|
*/
|
|
13395
|
-
componentEnrichmentTypes?:
|
|
13794
|
+
componentEnrichmentTypes?: ComponentTypeWithLiterals[];
|
|
13396
13795
|
}
|
|
13397
13796
|
/** Back-office Restricted Customization */
|
|
13398
13797
|
export interface BackOfficeRestrictedCustomization {
|