@wix/auto_sdk_events_wix-events-v-2 1.0.29 → 1.0.31
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/events-v3-event-wix-events-v-2.http.js +12 -0
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +22 -48
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.http.js +12 -0
- package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
- package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js +22 -48
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +12 -0
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +22 -48
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +12 -0
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +22 -48
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -57,7 +57,7 @@ export interface V3Event {
|
|
|
57
57
|
* Event status.
|
|
58
58
|
* @readonly
|
|
59
59
|
*/
|
|
60
|
-
status?:
|
|
60
|
+
status?: StatusWithLiterals;
|
|
61
61
|
/**
|
|
62
62
|
* RSVP or ticketing registration details. <br>
|
|
63
63
|
* **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
|
|
@@ -134,7 +134,7 @@ export interface Location {
|
|
|
134
134
|
*/
|
|
135
135
|
name?: string | null;
|
|
136
136
|
/** Location type. */
|
|
137
|
-
type?:
|
|
137
|
+
type?: LocationTypeWithLiterals;
|
|
138
138
|
/** Exact location address. */
|
|
139
139
|
address?: CommonAddress;
|
|
140
140
|
/** Whether the event location is TBD. */
|
|
@@ -148,6 +148,8 @@ export declare enum LocationType {
|
|
|
148
148
|
/** Event is online, such as a virtual video conference. */
|
|
149
149
|
ONLINE = "ONLINE"
|
|
150
150
|
}
|
|
151
|
+
/** @enumType */
|
|
152
|
+
export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
151
153
|
/** Physical address */
|
|
152
154
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
153
155
|
/** Street address. */
|
|
@@ -246,6 +248,8 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
246
248
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
247
249
|
COUNTRY = "COUNTRY"
|
|
248
250
|
}
|
|
251
|
+
/** @enumType */
|
|
252
|
+
export type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
249
253
|
export interface DateAndTimeSettings {
|
|
250
254
|
/** Whether the event date and time are TBD. */
|
|
251
255
|
dateAndTimeTbd?: boolean | null;
|
|
@@ -283,7 +287,7 @@ export interface DateAndTimeSettings {
|
|
|
283
287
|
* Repeating event status.
|
|
284
288
|
* @readonly
|
|
285
289
|
*/
|
|
286
|
-
recurrenceStatus?:
|
|
290
|
+
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
|
|
287
291
|
/** Event repetitions. */
|
|
288
292
|
recurringEvents?: Recurrences;
|
|
289
293
|
/** Formatted date and time settings. */
|
|
@@ -303,6 +307,8 @@ export declare enum RecurrenceStatusStatus {
|
|
|
303
307
|
/** Latest canceled event in a schedule of recurring events */
|
|
304
308
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
305
309
|
}
|
|
310
|
+
/** @enumType */
|
|
311
|
+
export type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
306
312
|
export interface Recurrences {
|
|
307
313
|
/**
|
|
308
314
|
* Individual event dates.
|
|
@@ -395,6 +401,8 @@ export declare enum Status {
|
|
|
395
401
|
/** Event is not public. */
|
|
396
402
|
DRAFT = "DRAFT"
|
|
397
403
|
}
|
|
404
|
+
/** @enumType */
|
|
405
|
+
export type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
398
406
|
export interface PageUrl {
|
|
399
407
|
/**
|
|
400
408
|
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
|
|
@@ -412,12 +420,12 @@ export interface Registration {
|
|
|
412
420
|
* Current registration type.
|
|
413
421
|
* @readonly
|
|
414
422
|
*/
|
|
415
|
-
type?:
|
|
423
|
+
type?: RegistrationTypeTypeWithLiterals;
|
|
416
424
|
/**
|
|
417
425
|
* Registration status.
|
|
418
426
|
* @readonly
|
|
419
427
|
*/
|
|
420
|
-
status?:
|
|
428
|
+
status?: RegistrationStatusStatusWithLiterals;
|
|
421
429
|
/** RSVP registration details. */
|
|
422
430
|
rsvp?: RsvpRegistration;
|
|
423
431
|
/** Ticket registration details. */
|
|
@@ -425,12 +433,12 @@ export interface Registration {
|
|
|
425
433
|
/** External registration details. */
|
|
426
434
|
external?: ExternalRegistration;
|
|
427
435
|
/** Types of guests allowed to register. */
|
|
428
|
-
allowedGuestTypes?:
|
|
436
|
+
allowedGuestTypes?: GuestTypeTypeWithLiterals;
|
|
429
437
|
/**
|
|
430
438
|
* Initial event type which is set when creating an event.
|
|
431
439
|
* @immutable
|
|
432
440
|
*/
|
|
433
|
-
initialType?:
|
|
441
|
+
initialType?: InitialRegistrationTypeTypeWithLiterals;
|
|
434
442
|
/** Whether the registration is paused. */
|
|
435
443
|
registrationPaused?: boolean;
|
|
436
444
|
/** Whether the registration is disabled. */
|
|
@@ -448,6 +456,8 @@ export declare enum RegistrationTypeType {
|
|
|
448
456
|
/** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
|
|
449
457
|
NONE = "NONE"
|
|
450
458
|
}
|
|
459
|
+
/** @enumType */
|
|
460
|
+
export type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
|
|
451
461
|
export declare enum RegistrationStatusStatus {
|
|
452
462
|
/** Registration status is not applicable */
|
|
453
463
|
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
@@ -466,9 +476,11 @@ export declare enum RegistrationStatusStatus {
|
|
|
466
476
|
/** Registration via RSVP is scheduled for the future. */
|
|
467
477
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
468
478
|
}
|
|
479
|
+
/** @enumType */
|
|
480
|
+
export type RegistrationStatusStatusWithLiterals = RegistrationStatusStatus | 'UNKNOWN_REGISTRATION_STATUS' | 'CLOSED_AUTOMATICALLY' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST_ONLY' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
469
481
|
export interface RsvpRegistration {
|
|
470
482
|
/** Available answers for registration to an event. */
|
|
471
|
-
responseType?:
|
|
483
|
+
responseType?: ResponseTypeWithLiterals;
|
|
472
484
|
/** How many guests can RSVP to an event. */
|
|
473
485
|
limit?: number | null;
|
|
474
486
|
/** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
|
|
@@ -486,6 +498,8 @@ export declare enum ResponseType {
|
|
|
486
498
|
/** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
|
|
487
499
|
YES_AND_NO = "YES_AND_NO"
|
|
488
500
|
}
|
|
501
|
+
/** @enumType */
|
|
502
|
+
export type ResponseTypeWithLiterals = ResponseType | 'UNKNOWN_RESPONSE_TYPE' | 'YES_ONLY' | 'YES_AND_NO';
|
|
489
503
|
export interface TicketsRegistration {
|
|
490
504
|
/** Whether the registration form must be filled out separately for each ticket. */
|
|
491
505
|
guestsAssignedSeparately?: boolean;
|
|
@@ -544,7 +558,7 @@ export interface Money {
|
|
|
544
558
|
}
|
|
545
559
|
export interface TaxSettings {
|
|
546
560
|
/** Tax application settings. */
|
|
547
|
-
type?:
|
|
561
|
+
type?: TaxTypeWithLiterals;
|
|
548
562
|
/**
|
|
549
563
|
* Tax name.
|
|
550
564
|
* @minLength 1
|
|
@@ -568,6 +582,8 @@ export declare enum TaxType {
|
|
|
568
582
|
/** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket ticket service fee of $0.25 and pays $10.25 in total. */
|
|
569
583
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
570
584
|
}
|
|
585
|
+
/** @enumType */
|
|
586
|
+
export type TaxTypeWithLiterals = TaxType | 'UNKNOWN_TAX_TYPE' | 'INCLUDED_IN_PRICE' | 'ADDED_AT_CHECKOUT';
|
|
571
587
|
export interface ExternalRegistration {
|
|
572
588
|
/**
|
|
573
589
|
* External event registration URL.
|
|
@@ -583,6 +599,8 @@ export declare enum GuestTypeType {
|
|
|
583
599
|
/** Only people who have signed up as members of your site are able to RSVP to the event. */
|
|
584
600
|
MEMBER = "MEMBER"
|
|
585
601
|
}
|
|
602
|
+
/** @enumType */
|
|
603
|
+
export type GuestTypeTypeWithLiterals = GuestTypeType | 'UNKNOWN_GUEST_TYPE' | 'VISITOR_OR_MEMBER' | 'MEMBER';
|
|
586
604
|
export declare enum InitialRegistrationTypeType {
|
|
587
605
|
/** Unknown initial registration type. */
|
|
588
606
|
UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
|
|
@@ -591,6 +609,8 @@ export declare enum InitialRegistrationTypeType {
|
|
|
591
609
|
/** Guests register by buying tickets. This property value never changes. */
|
|
592
610
|
TICKETING = "TICKETING"
|
|
593
611
|
}
|
|
612
|
+
/** @enumType */
|
|
613
|
+
export type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
|
|
594
614
|
export interface CommonImage {
|
|
595
615
|
/**
|
|
596
616
|
* WixMedia image ID.
|
|
@@ -655,7 +675,7 @@ export interface Form {
|
|
|
655
675
|
*/
|
|
656
676
|
export interface InputControl {
|
|
657
677
|
/** Field control type. */
|
|
658
|
-
type?:
|
|
678
|
+
type?: InputControlTypeWithLiterals;
|
|
659
679
|
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
660
680
|
system?: boolean;
|
|
661
681
|
/**
|
|
@@ -702,6 +722,8 @@ export declare enum InputControlType {
|
|
|
702
722
|
/** Fields for entering year, month, and day. */
|
|
703
723
|
DATE = "DATE"
|
|
704
724
|
}
|
|
725
|
+
/** @enumType */
|
|
726
|
+
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
705
727
|
/** Child inputs. */
|
|
706
728
|
export interface Input {
|
|
707
729
|
/** Field name. */
|
|
@@ -725,7 +747,7 @@ export interface Input {
|
|
|
725
747
|
* Type which determines field format.
|
|
726
748
|
* Used to validate submitted response.
|
|
727
749
|
*/
|
|
728
|
-
type?:
|
|
750
|
+
type?: ValueTypeWithLiterals;
|
|
729
751
|
/**
|
|
730
752
|
* The maximum number of accepted values for array input.
|
|
731
753
|
*
|
|
@@ -752,6 +774,8 @@ export declare enum ValueType {
|
|
|
752
774
|
DATE_TIME = "DATE_TIME",
|
|
753
775
|
ADDRESS = "ADDRESS"
|
|
754
776
|
}
|
|
777
|
+
/** @enumType */
|
|
778
|
+
export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
755
779
|
/**
|
|
756
780
|
* Describes initially selected option when an input has multiple choices.
|
|
757
781
|
* Defaults to first (0th) option if not configured.
|
|
@@ -972,7 +996,7 @@ export interface OnlineConferencing {
|
|
|
972
996
|
*/
|
|
973
997
|
providerId?: string | null;
|
|
974
998
|
/** Conference type. */
|
|
975
|
-
type?:
|
|
999
|
+
type?: ConferenceTypeTypeWithLiterals;
|
|
976
1000
|
/** Online conferencing session information. */
|
|
977
1001
|
session?: OnlineConferencingSession;
|
|
978
1002
|
}
|
|
@@ -984,6 +1008,8 @@ export declare enum ConferenceTypeType {
|
|
|
984
1008
|
/** Guests can only watch the conference. */
|
|
985
1009
|
WEBINAR = "WEBINAR"
|
|
986
1010
|
}
|
|
1011
|
+
/** @enumType */
|
|
1012
|
+
export type ConferenceTypeTypeWithLiterals = ConferenceTypeType | 'UNKNOWN_CONFERENCE_TYPE' | 'MEETING' | 'WEBINAR';
|
|
987
1013
|
export interface OnlineConferencingSession {
|
|
988
1014
|
/**
|
|
989
1015
|
* Link for the event host to start the online conference session.
|
|
@@ -1126,7 +1152,7 @@ export interface EventCategory {
|
|
|
1126
1152
|
* Category type.
|
|
1127
1153
|
* @readonly
|
|
1128
1154
|
*/
|
|
1129
|
-
type?:
|
|
1155
|
+
type?: CategoryTypeTypeWithLiterals;
|
|
1130
1156
|
}
|
|
1131
1157
|
export declare enum CategoryTypeType {
|
|
1132
1158
|
/** Created manually by the user. */
|
|
@@ -1134,6 +1160,8 @@ export declare enum CategoryTypeType {
|
|
|
1134
1160
|
/** Created automatically when publishing recurring events. */
|
|
1135
1161
|
RECURRING_EVENT = "RECURRING_EVENT"
|
|
1136
1162
|
}
|
|
1163
|
+
/** @enumType */
|
|
1164
|
+
export type CategoryTypeTypeWithLiterals = CategoryTypeType | 'MANUAL' | 'RECURRING_EVENT';
|
|
1137
1165
|
export interface V3EventDisplaySettings {
|
|
1138
1166
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1139
1167
|
hideEventDetailsButton?: boolean | null;
|
|
@@ -1206,7 +1234,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1206
1234
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1207
1235
|
layoutCellData?: LayoutCellData;
|
|
1208
1236
|
/** 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. */
|
|
1209
|
-
type?:
|
|
1237
|
+
type?: NodeTypeWithLiterals;
|
|
1210
1238
|
/** Node ID. */
|
|
1211
1239
|
id?: string;
|
|
1212
1240
|
/** A list of child nodes. */
|
|
@@ -1307,6 +1335,8 @@ export declare enum NodeType {
|
|
|
1307
1335
|
LAYOUT = "LAYOUT",
|
|
1308
1336
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1309
1337
|
}
|
|
1338
|
+
/** @enumType */
|
|
1339
|
+
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';
|
|
1310
1340
|
export interface NodeStyle {
|
|
1311
1341
|
/** The top padding value in pixels. */
|
|
1312
1342
|
paddingTop?: string | null;
|
|
@@ -1319,7 +1349,7 @@ export interface ButtonData {
|
|
|
1319
1349
|
/** Styling for the button's container. */
|
|
1320
1350
|
containerData?: PluginContainerData;
|
|
1321
1351
|
/** The button type. */
|
|
1322
|
-
type?:
|
|
1352
|
+
type?: ButtonDataTypeWithLiterals;
|
|
1323
1353
|
/** Styling for the button. */
|
|
1324
1354
|
styles?: Styles;
|
|
1325
1355
|
/** The text to display on the button. */
|
|
@@ -1360,7 +1390,7 @@ export interface PluginContainerData {
|
|
|
1360
1390
|
/** The width of the node when it's displayed. */
|
|
1361
1391
|
width?: PluginContainerDataWidth;
|
|
1362
1392
|
/** The node's alignment within its container. */
|
|
1363
|
-
alignment?:
|
|
1393
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
1364
1394
|
/** Spoiler cover settings for the node. */
|
|
1365
1395
|
spoiler?: Spoiler;
|
|
1366
1396
|
/** The height of the node when it's displayed. */
|
|
@@ -1378,6 +1408,8 @@ export declare enum WidthType {
|
|
|
1378
1408
|
/** coast-to-coast display */
|
|
1379
1409
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1380
1410
|
}
|
|
1411
|
+
/** @enumType */
|
|
1412
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1381
1413
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1382
1414
|
/**
|
|
1383
1415
|
* One of the following predefined width options:
|
|
@@ -1386,7 +1418,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1386
1418
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1387
1419
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1388
1420
|
*/
|
|
1389
|
-
size?:
|
|
1421
|
+
size?: WidthTypeWithLiterals;
|
|
1390
1422
|
/** A custom width value in pixels. */
|
|
1391
1423
|
custom?: string | null;
|
|
1392
1424
|
}
|
|
@@ -1399,7 +1431,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1399
1431
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1400
1432
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1401
1433
|
*/
|
|
1402
|
-
size?:
|
|
1434
|
+
size?: WidthTypeWithLiterals;
|
|
1403
1435
|
/** A custom width value in pixels. */
|
|
1404
1436
|
custom?: string | null;
|
|
1405
1437
|
}
|
|
@@ -1411,6 +1443,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1411
1443
|
/** Right Alignment */
|
|
1412
1444
|
RIGHT = "RIGHT"
|
|
1413
1445
|
}
|
|
1446
|
+
/** @enumType */
|
|
1447
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1414
1448
|
export interface Spoiler {
|
|
1415
1449
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1416
1450
|
enabled?: boolean | null;
|
|
@@ -1429,6 +1463,8 @@ export declare enum ButtonDataType {
|
|
|
1429
1463
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1430
1464
|
ACTION = "ACTION"
|
|
1431
1465
|
}
|
|
1466
|
+
/** @enumType */
|
|
1467
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1432
1468
|
export interface Styles {
|
|
1433
1469
|
/**
|
|
1434
1470
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -1494,7 +1530,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
1494
1530
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
1495
1531
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
1496
1532
|
*/
|
|
1497
|
-
target?:
|
|
1533
|
+
target?: TargetWithLiterals;
|
|
1498
1534
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
1499
1535
|
rel?: Rel;
|
|
1500
1536
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -1517,6 +1553,8 @@ export declare enum Target {
|
|
|
1517
1553
|
/** Opens the linked document in the full body of the window */
|
|
1518
1554
|
TOP = "TOP"
|
|
1519
1555
|
}
|
|
1556
|
+
/** @enumType */
|
|
1557
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1520
1558
|
export interface Rel {
|
|
1521
1559
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1522
1560
|
nofollow?: boolean | null;
|
|
@@ -1533,7 +1571,7 @@ export interface CodeBlockData {
|
|
|
1533
1571
|
}
|
|
1534
1572
|
export interface TextStyle {
|
|
1535
1573
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1536
|
-
textAlignment?:
|
|
1574
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
1537
1575
|
/** 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. */
|
|
1538
1576
|
lineHeight?: string | null;
|
|
1539
1577
|
}
|
|
@@ -1549,15 +1587,17 @@ export declare enum TextAlignment {
|
|
|
1549
1587
|
/** 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 */
|
|
1550
1588
|
JUSTIFY = "JUSTIFY"
|
|
1551
1589
|
}
|
|
1590
|
+
/** @enumType */
|
|
1591
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1552
1592
|
export interface DividerData {
|
|
1553
1593
|
/** Styling for the divider's container. */
|
|
1554
1594
|
containerData?: PluginContainerData;
|
|
1555
1595
|
/** Divider line style. */
|
|
1556
|
-
lineStyle?:
|
|
1596
|
+
lineStyle?: LineStyleWithLiterals;
|
|
1557
1597
|
/** Divider width. */
|
|
1558
|
-
width?:
|
|
1598
|
+
width?: WidthWithLiterals;
|
|
1559
1599
|
/** Divider alignment. */
|
|
1560
|
-
alignment?:
|
|
1600
|
+
alignment?: AlignmentWithLiterals;
|
|
1561
1601
|
}
|
|
1562
1602
|
export declare enum LineStyle {
|
|
1563
1603
|
/** Single Line */
|
|
@@ -1569,6 +1609,8 @@ export declare enum LineStyle {
|
|
|
1569
1609
|
/** Dotted Line */
|
|
1570
1610
|
DOTTED = "DOTTED"
|
|
1571
1611
|
}
|
|
1612
|
+
/** @enumType */
|
|
1613
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1572
1614
|
export declare enum Width {
|
|
1573
1615
|
/** Large line */
|
|
1574
1616
|
LARGE = "LARGE",
|
|
@@ -1577,6 +1619,8 @@ export declare enum Width {
|
|
|
1577
1619
|
/** Small line */
|
|
1578
1620
|
SMALL = "SMALL"
|
|
1579
1621
|
}
|
|
1622
|
+
/** @enumType */
|
|
1623
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1580
1624
|
export declare enum Alignment {
|
|
1581
1625
|
/** Center alignment */
|
|
1582
1626
|
CENTER = "CENTER",
|
|
@@ -1585,6 +1629,8 @@ export declare enum Alignment {
|
|
|
1585
1629
|
/** Right alignment */
|
|
1586
1630
|
RIGHT = "RIGHT"
|
|
1587
1631
|
}
|
|
1632
|
+
/** @enumType */
|
|
1633
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1588
1634
|
export interface FileData {
|
|
1589
1635
|
/** Styling for the file's container. */
|
|
1590
1636
|
containerData?: PluginContainerData;
|
|
@@ -1616,6 +1662,8 @@ export declare enum ViewMode {
|
|
|
1616
1662
|
/** Mini PDF view */
|
|
1617
1663
|
MINI = "MINI"
|
|
1618
1664
|
}
|
|
1665
|
+
/** @enumType */
|
|
1666
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1619
1667
|
export interface FileSource extends FileSourceDataOneOf {
|
|
1620
1668
|
/** The absolute URL for the file's source. */
|
|
1621
1669
|
url?: string | null;
|
|
@@ -1648,7 +1696,7 @@ export interface PDFSettings {
|
|
|
1648
1696
|
* `FULL` : A full page view of the PDF is displayed.
|
|
1649
1697
|
* `MINI` : A mini view of the PDF is displayed.
|
|
1650
1698
|
*/
|
|
1651
|
-
viewMode?:
|
|
1699
|
+
viewMode?: ViewModeWithLiterals;
|
|
1652
1700
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1653
1701
|
disableDownload?: boolean | null;
|
|
1654
1702
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -1735,18 +1783,24 @@ export declare enum LayoutType {
|
|
|
1735
1783
|
/** Fullsize images type */
|
|
1736
1784
|
FULLSIZE = "FULLSIZE"
|
|
1737
1785
|
}
|
|
1786
|
+
/** @enumType */
|
|
1787
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1738
1788
|
export declare enum Orientation {
|
|
1739
1789
|
/** Rows Orientation */
|
|
1740
1790
|
ROWS = "ROWS",
|
|
1741
1791
|
/** Columns Orientation */
|
|
1742
1792
|
COLUMNS = "COLUMNS"
|
|
1743
1793
|
}
|
|
1794
|
+
/** @enumType */
|
|
1795
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1744
1796
|
export declare enum Crop {
|
|
1745
1797
|
/** Crop to fill */
|
|
1746
1798
|
FILL = "FILL",
|
|
1747
1799
|
/** Crop to fit */
|
|
1748
1800
|
FIT = "FIT"
|
|
1749
1801
|
}
|
|
1802
|
+
/** @enumType */
|
|
1803
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1750
1804
|
export declare enum ThumbnailsAlignment {
|
|
1751
1805
|
/** Top alignment */
|
|
1752
1806
|
TOP = "TOP",
|
|
@@ -1759,13 +1813,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
1759
1813
|
/** No thumbnail */
|
|
1760
1814
|
NONE = "NONE"
|
|
1761
1815
|
}
|
|
1816
|
+
/** @enumType */
|
|
1817
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1762
1818
|
export interface Layout {
|
|
1763
1819
|
/** Gallery layout type. */
|
|
1764
|
-
type?:
|
|
1820
|
+
type?: LayoutTypeWithLiterals;
|
|
1765
1821
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1766
1822
|
horizontalScroll?: boolean | null;
|
|
1767
1823
|
/** Gallery orientation. */
|
|
1768
|
-
orientation?:
|
|
1824
|
+
orientation?: OrientationWithLiterals;
|
|
1769
1825
|
/** The number of columns to display on full size screens. */
|
|
1770
1826
|
numberOfColumns?: number | null;
|
|
1771
1827
|
/** The number of columns to display on mobile screens. */
|
|
@@ -1777,13 +1833,13 @@ export interface ItemStyle {
|
|
|
1777
1833
|
/** Item ratio */
|
|
1778
1834
|
ratio?: number | null;
|
|
1779
1835
|
/** Sets how item images are cropped. */
|
|
1780
|
-
crop?:
|
|
1836
|
+
crop?: CropWithLiterals;
|
|
1781
1837
|
/** The spacing between items in pixels. */
|
|
1782
1838
|
spacing?: number | null;
|
|
1783
1839
|
}
|
|
1784
1840
|
export interface Thumbnails {
|
|
1785
1841
|
/** Thumbnail alignment. */
|
|
1786
|
-
placement?:
|
|
1842
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1787
1843
|
/** Spacing between thumbnails in pixels. */
|
|
1788
1844
|
spacing?: number | null;
|
|
1789
1845
|
}
|
|
@@ -1799,7 +1855,7 @@ export interface GIFData {
|
|
|
1799
1855
|
/** Width in pixels. */
|
|
1800
1856
|
width?: number;
|
|
1801
1857
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1802
|
-
gifType?:
|
|
1858
|
+
gifType?: GIFTypeWithLiterals;
|
|
1803
1859
|
}
|
|
1804
1860
|
export interface GIF {
|
|
1805
1861
|
/**
|
|
@@ -1822,6 +1878,8 @@ export declare enum GIFType {
|
|
|
1822
1878
|
NORMAL = "NORMAL",
|
|
1823
1879
|
STICKER = "STICKER"
|
|
1824
1880
|
}
|
|
1881
|
+
/** @enumType */
|
|
1882
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1825
1883
|
export interface HeadingData {
|
|
1826
1884
|
/** Heading level from 1-6. */
|
|
1827
1885
|
level?: number;
|
|
@@ -1843,7 +1901,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1843
1901
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1844
1902
|
containerData?: PluginContainerData;
|
|
1845
1903
|
/** The type of HTML code. */
|
|
1846
|
-
source?:
|
|
1904
|
+
source?: SourceWithLiterals;
|
|
1847
1905
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1848
1906
|
autoHeight?: boolean | null;
|
|
1849
1907
|
}
|
|
@@ -1863,6 +1921,8 @@ export declare enum Source {
|
|
|
1863
1921
|
HTML = "HTML",
|
|
1864
1922
|
ADSENSE = "ADSENSE"
|
|
1865
1923
|
}
|
|
1924
|
+
/** @enumType */
|
|
1925
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1866
1926
|
export interface ImageData {
|
|
1867
1927
|
/** Styling for the image's container. */
|
|
1868
1928
|
containerData?: PluginContainerData;
|
|
@@ -1927,6 +1987,8 @@ export declare enum Position {
|
|
|
1927
1987
|
/** Thumbnail hidden and not displayed */
|
|
1928
1988
|
HIDDEN = "HIDDEN"
|
|
1929
1989
|
}
|
|
1990
|
+
/** @enumType */
|
|
1991
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1930
1992
|
export interface LinkPreviewDataStyles {
|
|
1931
1993
|
/**
|
|
1932
1994
|
* Background color as a hexadecimal value.
|
|
@@ -1958,7 +2020,7 @@ export interface LinkPreviewDataStyles {
|
|
|
1958
2020
|
*/
|
|
1959
2021
|
borderColor?: string | null;
|
|
1960
2022
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1961
|
-
thumbnailPosition?:
|
|
2023
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
1962
2024
|
}
|
|
1963
2025
|
export interface MapData {
|
|
1964
2026
|
/** Styling for the map's container. */
|
|
@@ -1988,7 +2050,7 @@ export interface MapSettings {
|
|
|
1988
2050
|
/** Initial zoom value. */
|
|
1989
2051
|
initialZoom?: number | null;
|
|
1990
2052
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1991
|
-
mapType?:
|
|
2053
|
+
mapType?: MapTypeWithLiterals;
|
|
1992
2054
|
}
|
|
1993
2055
|
export declare enum MapType {
|
|
1994
2056
|
/** Roadmap map type */
|
|
@@ -2000,6 +2062,8 @@ export declare enum MapType {
|
|
|
2000
2062
|
/** Terrain map type */
|
|
2001
2063
|
TERRAIN = "TERRAIN"
|
|
2002
2064
|
}
|
|
2065
|
+
/** @enumType */
|
|
2066
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2003
2067
|
export interface ParagraphData {
|
|
2004
2068
|
/** Styling for the paragraph text. */
|
|
2005
2069
|
textStyle?: TextStyle;
|
|
@@ -2026,17 +2090,21 @@ export declare enum ViewRole {
|
|
|
2026
2090
|
/** Anyone can see the results, even if one didn't vote */
|
|
2027
2091
|
EVERYONE = "EVERYONE"
|
|
2028
2092
|
}
|
|
2093
|
+
/** @enumType */
|
|
2094
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2029
2095
|
export declare enum VoteRole {
|
|
2030
2096
|
/** Logged in member */
|
|
2031
2097
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2032
2098
|
/** Anyone */
|
|
2033
2099
|
ALL = "ALL"
|
|
2034
2100
|
}
|
|
2101
|
+
/** @enumType */
|
|
2102
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2035
2103
|
export interface Permissions {
|
|
2036
2104
|
/** Sets who can view the poll results. */
|
|
2037
|
-
view?:
|
|
2105
|
+
view?: ViewRoleWithLiterals;
|
|
2038
2106
|
/** Sets who can vote. */
|
|
2039
|
-
vote?:
|
|
2107
|
+
vote?: VoteRoleWithLiterals;
|
|
2040
2108
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2041
2109
|
allowMultipleVotes?: boolean | null;
|
|
2042
2110
|
}
|
|
@@ -2062,17 +2130,21 @@ export declare enum PollLayoutType {
|
|
|
2062
2130
|
/** Grid */
|
|
2063
2131
|
GRID = "GRID"
|
|
2064
2132
|
}
|
|
2133
|
+
/** @enumType */
|
|
2134
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2065
2135
|
export declare enum PollLayoutDirection {
|
|
2066
2136
|
/** Left-to-right */
|
|
2067
2137
|
LTR = "LTR",
|
|
2068
2138
|
/** Right-to-left */
|
|
2069
2139
|
RTL = "RTL"
|
|
2070
2140
|
}
|
|
2141
|
+
/** @enumType */
|
|
2142
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2071
2143
|
export interface PollLayout {
|
|
2072
2144
|
/** The layout for displaying the voting options. */
|
|
2073
|
-
type?:
|
|
2145
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2074
2146
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2075
|
-
direction?:
|
|
2147
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2076
2148
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2077
2149
|
enableImage?: boolean | null;
|
|
2078
2150
|
}
|
|
@@ -2088,6 +2160,8 @@ export declare enum BackgroundType {
|
|
|
2088
2160
|
/** Gradiant background type */
|
|
2089
2161
|
GRADIENT = "GRADIENT"
|
|
2090
2162
|
}
|
|
2163
|
+
/** @enumType */
|
|
2164
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2091
2165
|
export interface Gradient {
|
|
2092
2166
|
/** The gradient angle in degrees. */
|
|
2093
2167
|
angle?: number | null;
|
|
@@ -2113,7 +2187,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2113
2187
|
/** Details for a gradient background. */
|
|
2114
2188
|
gradient?: Gradient;
|
|
2115
2189
|
/** Background type. For each option, include the relevant details. */
|
|
2116
|
-
type?:
|
|
2190
|
+
type?: BackgroundTypeWithLiterals;
|
|
2117
2191
|
}
|
|
2118
2192
|
/** @oneof */
|
|
2119
2193
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -2192,7 +2266,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2192
2266
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2193
2267
|
strikethroughData?: boolean | null;
|
|
2194
2268
|
/** The type of decoration to apply. */
|
|
2195
|
-
type?:
|
|
2269
|
+
type?: DecorationTypeWithLiterals;
|
|
2196
2270
|
}
|
|
2197
2271
|
/** @oneof */
|
|
2198
2272
|
export interface DecorationDataOneOf {
|
|
@@ -2230,6 +2304,8 @@ export declare enum DecorationType {
|
|
|
2230
2304
|
EXTERNAL = "EXTERNAL",
|
|
2231
2305
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2232
2306
|
}
|
|
2307
|
+
/** @enumType */
|
|
2308
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2233
2309
|
export interface AnchorData {
|
|
2234
2310
|
/** The target node's ID. */
|
|
2235
2311
|
anchor?: string;
|
|
@@ -2254,7 +2330,7 @@ export interface MentionData {
|
|
|
2254
2330
|
}
|
|
2255
2331
|
export interface FontSizeData {
|
|
2256
2332
|
/** The units used for the font size. */
|
|
2257
|
-
unit?:
|
|
2333
|
+
unit?: FontTypeWithLiterals;
|
|
2258
2334
|
/** Font size value. */
|
|
2259
2335
|
value?: number | null;
|
|
2260
2336
|
}
|
|
@@ -2262,6 +2338,8 @@ export declare enum FontType {
|
|
|
2262
2338
|
PX = "PX",
|
|
2263
2339
|
EM = "EM"
|
|
2264
2340
|
}
|
|
2341
|
+
/** @enumType */
|
|
2342
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2265
2343
|
export interface SpoilerData {
|
|
2266
2344
|
/** Spoiler ID. */
|
|
2267
2345
|
id?: string | null;
|
|
@@ -2272,7 +2350,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2272
2350
|
/** Data for embedded Wix Events content. */
|
|
2273
2351
|
eventData?: EventData;
|
|
2274
2352
|
/** The type of Wix App content being embedded. */
|
|
2275
|
-
type?:
|
|
2353
|
+
type?: AppTypeWithLiterals;
|
|
2276
2354
|
/** The ID of the embedded content. */
|
|
2277
2355
|
itemId?: string | null;
|
|
2278
2356
|
/** The name of the embedded content. */
|
|
@@ -2299,6 +2377,8 @@ export declare enum AppType {
|
|
|
2299
2377
|
EVENT = "EVENT",
|
|
2300
2378
|
BOOKING = "BOOKING"
|
|
2301
2379
|
}
|
|
2380
|
+
/** @enumType */
|
|
2381
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2302
2382
|
export interface BookingData {
|
|
2303
2383
|
/** Booking duration in minutes. */
|
|
2304
2384
|
durations?: string | null;
|
|
@@ -2377,9 +2457,9 @@ export interface CollapsibleListData {
|
|
|
2377
2457
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2378
2458
|
expandOnlyOne?: boolean | null;
|
|
2379
2459
|
/** Sets which items are expanded when the page loads. */
|
|
2380
|
-
initialExpandedItems?:
|
|
2460
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2381
2461
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2382
|
-
direction?:
|
|
2462
|
+
direction?: DirectionWithLiterals;
|
|
2383
2463
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2384
2464
|
isQapageData?: boolean | null;
|
|
2385
2465
|
}
|
|
@@ -2391,12 +2471,16 @@ export declare enum InitialExpandedItems {
|
|
|
2391
2471
|
/** All items collapsed initally */
|
|
2392
2472
|
NONE = "NONE"
|
|
2393
2473
|
}
|
|
2474
|
+
/** @enumType */
|
|
2475
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2394
2476
|
export declare enum Direction {
|
|
2395
2477
|
/** Left-to-right */
|
|
2396
2478
|
LTR = "LTR",
|
|
2397
2479
|
/** Right-to-left */
|
|
2398
2480
|
RTL = "RTL"
|
|
2399
2481
|
}
|
|
2482
|
+
/** @enumType */
|
|
2483
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2400
2484
|
export interface TableData {
|
|
2401
2485
|
/** Styling for the table's container. */
|
|
2402
2486
|
containerData?: PluginContainerData;
|
|
@@ -2434,9 +2518,11 @@ export declare enum VerticalAlignment {
|
|
|
2434
2518
|
/** Bottom alignment */
|
|
2435
2519
|
BOTTOM = "BOTTOM"
|
|
2436
2520
|
}
|
|
2521
|
+
/** @enumType */
|
|
2522
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2437
2523
|
export interface CellStyle {
|
|
2438
2524
|
/** Vertical alignment for the cell's text. */
|
|
2439
|
-
verticalAlignment?:
|
|
2525
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2440
2526
|
/**
|
|
2441
2527
|
* Cell background color as a hexadecimal value.
|
|
2442
2528
|
* @format COLOR_HEX
|
|
@@ -2475,6 +2561,8 @@ export declare enum NullValue {
|
|
|
2475
2561
|
/** Null value. */
|
|
2476
2562
|
NULL_VALUE = "NULL_VALUE"
|
|
2477
2563
|
}
|
|
2564
|
+
/** @enumType */
|
|
2565
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2478
2566
|
/**
|
|
2479
2567
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2480
2568
|
*
|
|
@@ -2579,7 +2667,7 @@ export interface BadgeList {
|
|
|
2579
2667
|
}
|
|
2580
2668
|
export interface V3Badge {
|
|
2581
2669
|
/** Badge type. */
|
|
2582
|
-
type?:
|
|
2670
|
+
type?: BadgeTypeTypeWithLiterals;
|
|
2583
2671
|
/**
|
|
2584
2672
|
* Badge text.
|
|
2585
2673
|
* @maxLength 50
|
|
@@ -2596,6 +2684,8 @@ export declare enum BadgeTypeType {
|
|
|
2596
2684
|
/** 3rd priority badge type. */
|
|
2597
2685
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2598
2686
|
}
|
|
2687
|
+
/** @enumType */
|
|
2688
|
+
export type BadgeTypeTypeWithLiterals = BadgeTypeType | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2599
2689
|
export interface EventEventStarted {
|
|
2600
2690
|
/** Event schedule configuration. */
|
|
2601
2691
|
timestamp?: Date | null;
|
|
@@ -2655,7 +2745,7 @@ export interface EventEventPublished {
|
|
|
2655
2745
|
*/
|
|
2656
2746
|
eventId?: string;
|
|
2657
2747
|
/** Event status. */
|
|
2658
|
-
status?:
|
|
2748
|
+
status?: StatusWithLiterals;
|
|
2659
2749
|
/**
|
|
2660
2750
|
* Event ID. Indicates the original event from which the current event was derived from.
|
|
2661
2751
|
* Can be used to track the original event and add missing information.
|
|
@@ -2706,7 +2796,7 @@ export interface EventCloned {
|
|
|
2706
2796
|
*/
|
|
2707
2797
|
userId?: string | null;
|
|
2708
2798
|
/** Event status. */
|
|
2709
|
-
status?:
|
|
2799
|
+
status?: StatusWithLiterals;
|
|
2710
2800
|
/**
|
|
2711
2801
|
* Instance ID. Indicates the original app instance from which current event was derived from.
|
|
2712
2802
|
* @format GUID
|
|
@@ -2755,7 +2845,7 @@ export interface CreateEventRequest {
|
|
|
2755
2845
|
* Predefined sets of fields to return.
|
|
2756
2846
|
* @maxSize 20
|
|
2757
2847
|
*/
|
|
2758
|
-
fields?:
|
|
2848
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2759
2849
|
}
|
|
2760
2850
|
export declare enum RequestedFields {
|
|
2761
2851
|
/** Unknown requested field. */
|
|
@@ -2783,6 +2873,8 @@ export declare enum RequestedFields {
|
|
|
2783
2873
|
/** Returns `categories`. */
|
|
2784
2874
|
CATEGORIES = "CATEGORIES"
|
|
2785
2875
|
}
|
|
2876
|
+
/** @enumType */
|
|
2877
|
+
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DETAILS' | 'TEXTS' | 'REGISTRATION' | 'URLS' | 'FORM' | 'DASHBOARD' | 'FEED' | 'ONLINE_CONFERENCING_SESSION' | 'SEO_SETTINGS' | 'AGENDA' | 'CATEGORIES';
|
|
2786
2878
|
export interface CreateEventResponse {
|
|
2787
2879
|
/** Created event. */
|
|
2788
2880
|
event?: V3Event;
|
|
@@ -2801,7 +2893,7 @@ export interface CloneEventRequest {
|
|
|
2801
2893
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2802
2894
|
* @maxSize 20
|
|
2803
2895
|
*/
|
|
2804
|
-
fields?:
|
|
2896
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2805
2897
|
}
|
|
2806
2898
|
export interface CloneEventResponse {
|
|
2807
2899
|
/** Cloned event. */
|
|
@@ -2822,7 +2914,7 @@ export interface CloneEventFromOtherSiteRequest {
|
|
|
2822
2914
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2823
2915
|
* @maxSize 20
|
|
2824
2916
|
*/
|
|
2825
|
-
fields?:
|
|
2917
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2826
2918
|
}
|
|
2827
2919
|
export interface CloneEventFromOtherSiteResponse {
|
|
2828
2920
|
/** Cloned event. */
|
|
@@ -2835,7 +2927,7 @@ export interface UpdateEventRequest {
|
|
|
2835
2927
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2836
2928
|
* @maxSize 20
|
|
2837
2929
|
*/
|
|
2838
|
-
fields?:
|
|
2930
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2839
2931
|
}
|
|
2840
2932
|
export interface UpdateEventResponse {
|
|
2841
2933
|
/** Updated event. */
|
|
@@ -2851,7 +2943,7 @@ export interface PublishDraftEventRequest {
|
|
|
2851
2943
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2852
2944
|
* @maxSize 20
|
|
2853
2945
|
*/
|
|
2854
|
-
fields?:
|
|
2946
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2855
2947
|
}
|
|
2856
2948
|
export interface PublishDraftEventResponse {
|
|
2857
2949
|
/** Published event. */
|
|
@@ -2867,7 +2959,7 @@ export interface CancelEventRequest {
|
|
|
2867
2959
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2868
2960
|
* @maxSize 20
|
|
2869
2961
|
*/
|
|
2870
|
-
fields?:
|
|
2962
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2871
2963
|
}
|
|
2872
2964
|
export interface CancelEventResponse {
|
|
2873
2965
|
/** Canceled event. */
|
|
@@ -2912,12 +3004,14 @@ export interface CommonSorting {
|
|
|
2912
3004
|
*
|
|
2913
3005
|
* Default: `ASC`.
|
|
2914
3006
|
*/
|
|
2915
|
-
order?:
|
|
3007
|
+
order?: CommonSortOrderWithLiterals;
|
|
2916
3008
|
}
|
|
2917
3009
|
export declare enum CommonSortOrder {
|
|
2918
3010
|
ASC = "ASC",
|
|
2919
3011
|
DESC = "DESC"
|
|
2920
3012
|
}
|
|
3013
|
+
/** @enumType */
|
|
3014
|
+
export type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
2921
3015
|
export interface CommonPaging {
|
|
2922
3016
|
/**
|
|
2923
3017
|
* Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
|
|
@@ -2956,7 +3050,7 @@ export interface QueryEventsRequest {
|
|
|
2956
3050
|
* Predefined sets of fields to return.
|
|
2957
3051
|
* @maxSize 20
|
|
2958
3052
|
*/
|
|
2959
|
-
fields?:
|
|
3053
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2960
3054
|
/**
|
|
2961
3055
|
* Whether draft events should be returned in the response. <br>
|
|
2962
3056
|
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
@@ -3027,12 +3121,14 @@ export interface Sorting {
|
|
|
3027
3121
|
*/
|
|
3028
3122
|
fieldName?: string;
|
|
3029
3123
|
/** Sort order. */
|
|
3030
|
-
order?:
|
|
3124
|
+
order?: SortOrderWithLiterals;
|
|
3031
3125
|
}
|
|
3032
3126
|
export declare enum SortOrder {
|
|
3033
3127
|
ASC = "ASC",
|
|
3034
3128
|
DESC = "DESC"
|
|
3035
3129
|
}
|
|
3130
|
+
/** @enumType */
|
|
3131
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3036
3132
|
export interface Paging {
|
|
3037
3133
|
/** Number of items to load. */
|
|
3038
3134
|
limit?: number | null;
|
|
@@ -3122,7 +3218,7 @@ export interface ListUserEventsRequest {
|
|
|
3122
3218
|
* Event status.
|
|
3123
3219
|
* @maxSize 20
|
|
3124
3220
|
*/
|
|
3125
|
-
status?:
|
|
3221
|
+
status?: StatusWithLiterals[];
|
|
3126
3222
|
/** Allows to filter events by user relation to the event among all wix sites. */
|
|
3127
3223
|
userFilter?: UserFilter;
|
|
3128
3224
|
/**
|
|
@@ -3144,12 +3240,14 @@ export interface UserFilter {
|
|
|
3144
3240
|
* @minSize 1
|
|
3145
3241
|
* @maxSize 20
|
|
3146
3242
|
*/
|
|
3147
|
-
relation?:
|
|
3243
|
+
relation?: RelationWithLiterals[];
|
|
3148
3244
|
}
|
|
3149
3245
|
export declare enum Relation {
|
|
3150
3246
|
/** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */
|
|
3151
3247
|
ATTENDING = "ATTENDING"
|
|
3152
3248
|
}
|
|
3249
|
+
/** @enumType */
|
|
3250
|
+
export type RelationWithLiterals = Relation | 'ATTENDING';
|
|
3153
3251
|
export interface ListUserEventsResponse {
|
|
3154
3252
|
/** Metadata for the paginated results. */
|
|
3155
3253
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
@@ -3170,7 +3268,7 @@ export interface ListEventsByCategoryRequest {
|
|
|
3170
3268
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3171
3269
|
* @maxSize 20
|
|
3172
3270
|
*/
|
|
3173
|
-
fields?:
|
|
3271
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
3174
3272
|
}
|
|
3175
3273
|
export interface ListEventsByCategoryResponse {
|
|
3176
3274
|
/** Metadata for the paginated results. */
|
|
@@ -3188,7 +3286,7 @@ export interface GetEventRequest {
|
|
|
3188
3286
|
* Predefined sets of fields to return.
|
|
3189
3287
|
* @maxSize 20
|
|
3190
3288
|
*/
|
|
3191
|
-
fields?:
|
|
3289
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
3192
3290
|
}
|
|
3193
3291
|
export interface GetEventResponse {
|
|
3194
3292
|
/** Event. */
|
|
@@ -3202,7 +3300,7 @@ export interface GetEventBySlugRequest {
|
|
|
3202
3300
|
*/
|
|
3203
3301
|
slug: string | null;
|
|
3204
3302
|
/** @maxSize 20 */
|
|
3205
|
-
fields?:
|
|
3303
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
3206
3304
|
}
|
|
3207
3305
|
export interface GetEventBySlugResponse {
|
|
3208
3306
|
/** Event. */
|
|
@@ -3224,7 +3322,7 @@ export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
|
3224
3322
|
* Predefined sets of fields to return.
|
|
3225
3323
|
* @maxSize 20
|
|
3226
3324
|
*/
|
|
3227
|
-
fields?:
|
|
3325
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
3228
3326
|
}
|
|
3229
3327
|
/** @oneof */
|
|
3230
3328
|
export interface FindEventRequestFindByOneOf {
|
|
@@ -3264,7 +3362,7 @@ export interface EventCreated {
|
|
|
3264
3362
|
*/
|
|
3265
3363
|
userId?: string | null;
|
|
3266
3364
|
/** Event status. */
|
|
3267
|
-
status?:
|
|
3365
|
+
status?: EventStatusWithLiterals;
|
|
3268
3366
|
/**
|
|
3269
3367
|
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3270
3368
|
* @format GUID
|
|
@@ -3292,7 +3390,7 @@ export interface EventsLocation {
|
|
|
3292
3390
|
*/
|
|
3293
3391
|
address?: string | null;
|
|
3294
3392
|
/** Location type. */
|
|
3295
|
-
type?:
|
|
3393
|
+
type?: LocationLocationTypeWithLiterals;
|
|
3296
3394
|
/**
|
|
3297
3395
|
* Full address derived from formatted single line `address`.
|
|
3298
3396
|
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
@@ -3328,6 +3426,8 @@ export declare enum LocationLocationType {
|
|
|
3328
3426
|
VENUE = "VENUE",
|
|
3329
3427
|
ONLINE = "ONLINE"
|
|
3330
3428
|
}
|
|
3429
|
+
/** @enumType */
|
|
3430
|
+
export type LocationLocationTypeWithLiterals = LocationLocationType | 'VENUE' | 'ONLINE';
|
|
3331
3431
|
/** Physical address */
|
|
3332
3432
|
export interface Address extends AddressStreetOneOf {
|
|
3333
3433
|
/** a break down of the street to number and street name */
|
|
@@ -3409,6 +3509,8 @@ export declare enum SubdivisionType {
|
|
|
3409
3509
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3410
3510
|
COUNTRY = "COUNTRY"
|
|
3411
3511
|
}
|
|
3512
|
+
/** @enumType */
|
|
3513
|
+
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
3412
3514
|
export interface ScheduleConfig {
|
|
3413
3515
|
/**
|
|
3414
3516
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -3452,7 +3554,7 @@ export interface EventsRecurrences {
|
|
|
3452
3554
|
* Recurrence status.
|
|
3453
3555
|
* @readonly
|
|
3454
3556
|
*/
|
|
3455
|
-
status?:
|
|
3557
|
+
status?: EventsRecurrenceStatusStatusWithLiterals;
|
|
3456
3558
|
}
|
|
3457
3559
|
export interface EventsOccurrence {
|
|
3458
3560
|
/** Event start timestamp. */
|
|
@@ -3479,6 +3581,8 @@ export declare enum EventsRecurrenceStatusStatus {
|
|
|
3479
3581
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
3480
3582
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
3481
3583
|
}
|
|
3584
|
+
/** @enumType */
|
|
3585
|
+
export type EventsRecurrenceStatusStatusWithLiterals = EventsRecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
3482
3586
|
export declare enum EventStatus {
|
|
3483
3587
|
/** Event is public and scheduled to start */
|
|
3484
3588
|
SCHEDULED = "SCHEDULED",
|
|
@@ -3489,6 +3593,8 @@ export declare enum EventStatus {
|
|
|
3489
3593
|
/** Event was canceled */
|
|
3490
3594
|
CANCELED = "CANCELED"
|
|
3491
3595
|
}
|
|
3596
|
+
/** @enumType */
|
|
3597
|
+
export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
3492
3598
|
export interface Event {
|
|
3493
3599
|
/**
|
|
3494
3600
|
* Event ID.
|
|
@@ -3517,7 +3623,7 @@ export interface Event {
|
|
|
3517
3623
|
/** Event modified timestamp. */
|
|
3518
3624
|
modified?: Date | null;
|
|
3519
3625
|
/** Event status. */
|
|
3520
|
-
status?:
|
|
3626
|
+
status?: EventStatusWithLiterals;
|
|
3521
3627
|
/** RSVP or ticketing registration details. */
|
|
3522
3628
|
registration?: EventsRegistration;
|
|
3523
3629
|
/** "Add to calendar" URLs. */
|
|
@@ -3591,9 +3697,9 @@ export interface Image {
|
|
|
3591
3697
|
}
|
|
3592
3698
|
export interface EventsRegistration {
|
|
3593
3699
|
/** Event type. */
|
|
3594
|
-
type?:
|
|
3700
|
+
type?: EventTypeWithLiterals;
|
|
3595
3701
|
/** Event registration status. */
|
|
3596
|
-
status?:
|
|
3702
|
+
status?: RegistrationStatusWithLiterals;
|
|
3597
3703
|
/** RSVP collection details. */
|
|
3598
3704
|
rsvpCollection?: RsvpCollection;
|
|
3599
3705
|
/** Ticketing details. */
|
|
@@ -3601,9 +3707,9 @@ export interface EventsRegistration {
|
|
|
3601
3707
|
/** External registration details. */
|
|
3602
3708
|
external?: ExternalEvent;
|
|
3603
3709
|
/** Types of users allowed to register. */
|
|
3604
|
-
restrictedTo?:
|
|
3710
|
+
restrictedTo?: VisitorTypeWithLiterals;
|
|
3605
3711
|
/** Initial event type which was set when creating an event. */
|
|
3606
|
-
initialType?:
|
|
3712
|
+
initialType?: EventTypeWithLiterals;
|
|
3607
3713
|
}
|
|
3608
3714
|
export declare enum EventType {
|
|
3609
3715
|
/** Type not available for this request fieldset */
|
|
@@ -3617,6 +3723,8 @@ export declare enum EventType {
|
|
|
3617
3723
|
/** Registration not available */
|
|
3618
3724
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
3619
3725
|
}
|
|
3726
|
+
/** @enumType */
|
|
3727
|
+
export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
3620
3728
|
export declare enum RegistrationStatus {
|
|
3621
3729
|
/** Registration status is not applicable */
|
|
3622
3730
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
@@ -3635,13 +3743,15 @@ export declare enum RegistrationStatus {
|
|
|
3635
3743
|
/** Registration will be open via RSVP */
|
|
3636
3744
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
3637
3745
|
}
|
|
3746
|
+
/** @enumType */
|
|
3747
|
+
export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
3638
3748
|
export interface RsvpCollection {
|
|
3639
3749
|
/** RSVP collection configuration. */
|
|
3640
3750
|
config?: RsvpCollectionConfig;
|
|
3641
3751
|
}
|
|
3642
3752
|
export interface RsvpCollectionConfig {
|
|
3643
3753
|
/** Defines the supported RSVP statuses. */
|
|
3644
|
-
rsvpStatusOptions?:
|
|
3754
|
+
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
3645
3755
|
/**
|
|
3646
3756
|
* Total guest limit available to register to the event.
|
|
3647
3757
|
* Additional guests per RSVP are counted towards total guests.
|
|
@@ -3660,6 +3770,8 @@ export declare enum RsvpStatusOptions {
|
|
|
3660
3770
|
/** YES and NO RSVP status options are available for the registration */
|
|
3661
3771
|
YES_AND_NO = "YES_AND_NO"
|
|
3662
3772
|
}
|
|
3773
|
+
/** @enumType */
|
|
3774
|
+
export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
3663
3775
|
export interface Ticketing {
|
|
3664
3776
|
/**
|
|
3665
3777
|
* Deprecated.
|
|
@@ -3720,7 +3832,7 @@ export interface TicketingConfig {
|
|
|
3720
3832
|
}
|
|
3721
3833
|
export interface TaxConfig {
|
|
3722
3834
|
/** Tax application settings. */
|
|
3723
|
-
type?:
|
|
3835
|
+
type?: EventsTaxTypeWithLiterals;
|
|
3724
3836
|
/**
|
|
3725
3837
|
* Tax name.
|
|
3726
3838
|
* @minLength 1
|
|
@@ -3743,6 +3855,8 @@ export declare enum EventsTaxType {
|
|
|
3743
3855
|
/** Tax is added to the final total at the checkout. */
|
|
3744
3856
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
3745
3857
|
}
|
|
3858
|
+
/** @enumType */
|
|
3859
|
+
export type EventsTaxTypeWithLiterals = EventsTaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
3746
3860
|
export interface ExternalEvent {
|
|
3747
3861
|
/** External event registration URL. */
|
|
3748
3862
|
registration?: string;
|
|
@@ -3755,6 +3869,8 @@ export declare enum VisitorType {
|
|
|
3755
3869
|
/** Site visitor or member */
|
|
3756
3870
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
3757
3871
|
}
|
|
3872
|
+
/** @enumType */
|
|
3873
|
+
export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
3758
3874
|
export interface CalendarLinks {
|
|
3759
3875
|
/** "Add to Google calendar" URL. */
|
|
3760
3876
|
google?: string;
|
|
@@ -3829,7 +3945,7 @@ export interface OnlineConferencingConfig {
|
|
|
3829
3945
|
*/
|
|
3830
3946
|
providerId?: string | null;
|
|
3831
3947
|
/** Conference type */
|
|
3832
|
-
conferenceType?:
|
|
3948
|
+
conferenceType?: ConferenceTypeWithLiterals;
|
|
3833
3949
|
}
|
|
3834
3950
|
export declare enum ConferenceType {
|
|
3835
3951
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
@@ -3837,6 +3953,8 @@ export declare enum ConferenceType {
|
|
|
3837
3953
|
/** Guests can only subscribe to video and audio. */
|
|
3838
3954
|
WEBINAR = "WEBINAR"
|
|
3839
3955
|
}
|
|
3956
|
+
/** @enumType */
|
|
3957
|
+
export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
3840
3958
|
export interface EventsOnlineConferencingSession {
|
|
3841
3959
|
/**
|
|
3842
3960
|
* Link for event host to start the online conference session.
|
|
@@ -3923,7 +4041,7 @@ export interface Category {
|
|
|
3923
4041
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
3924
4042
|
* @maxSize 3
|
|
3925
4043
|
*/
|
|
3926
|
-
states?:
|
|
4044
|
+
states?: StateWithLiterals[];
|
|
3927
4045
|
}
|
|
3928
4046
|
export interface CategoryCounts {
|
|
3929
4047
|
/** Total number of draft events assigned to the category. */
|
|
@@ -3941,6 +4059,8 @@ export declare enum State {
|
|
|
3941
4059
|
/** Category is hidden. */
|
|
3942
4060
|
HIDDEN = "HIDDEN"
|
|
3943
4061
|
}
|
|
4062
|
+
/** @enumType */
|
|
4063
|
+
export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
3944
4064
|
export interface EventDisplaySettings {
|
|
3945
4065
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
3946
4066
|
hideEventDetailsButton?: boolean | null;
|
|
@@ -3951,7 +4071,7 @@ export interface EventsLabellingSettings {
|
|
|
3951
4071
|
}
|
|
3952
4072
|
export interface Badge {
|
|
3953
4073
|
/** Badge type. */
|
|
3954
|
-
type?:
|
|
4074
|
+
type?: TypeWithLiterals;
|
|
3955
4075
|
/**
|
|
3956
4076
|
* Badge text.
|
|
3957
4077
|
* @maxLength 50
|
|
@@ -3968,6 +4088,8 @@ export declare enum Type {
|
|
|
3968
4088
|
/** 3rd priority badge type. */
|
|
3969
4089
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
3970
4090
|
}
|
|
4091
|
+
/** @enumType */
|
|
4092
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
3971
4093
|
export interface Empty {
|
|
3972
4094
|
}
|
|
3973
4095
|
export interface EventUpdated {
|
|
@@ -4028,7 +4150,7 @@ export interface EventCopied {
|
|
|
4028
4150
|
*/
|
|
4029
4151
|
userId?: string | null;
|
|
4030
4152
|
/** Event status. */
|
|
4031
|
-
status?:
|
|
4153
|
+
status?: EventStatusWithLiterals;
|
|
4032
4154
|
/**
|
|
4033
4155
|
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
4034
4156
|
* @format GUID
|
|
@@ -4055,7 +4177,7 @@ export interface EventPublished {
|
|
|
4055
4177
|
*/
|
|
4056
4178
|
eventId?: string;
|
|
4057
4179
|
/** Event status. */
|
|
4058
|
-
status?:
|
|
4180
|
+
status?: EventStatusWithLiterals;
|
|
4059
4181
|
/**
|
|
4060
4182
|
* Event ID. Indicates the original event which current event was derived from.
|
|
4061
4183
|
* Can be used to track the original event and add missing information.
|
|
@@ -4143,25 +4265,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4143
4265
|
updatedEvent?: EntityUpdatedEvent;
|
|
4144
4266
|
deletedEvent?: EntityDeletedEvent;
|
|
4145
4267
|
actionEvent?: ActionEvent;
|
|
4146
|
-
/**
|
|
4147
|
-
* Unique event ID.
|
|
4148
|
-
* Allows clients to ignore duplicate webhooks.
|
|
4149
|
-
*/
|
|
4268
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4150
4269
|
id?: string;
|
|
4151
4270
|
/**
|
|
4152
|
-
*
|
|
4153
|
-
*
|
|
4271
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4272
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4154
4273
|
*/
|
|
4155
4274
|
entityFqdn?: string;
|
|
4156
4275
|
/**
|
|
4157
|
-
*
|
|
4158
|
-
*
|
|
4159
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
4276
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4277
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4160
4278
|
*/
|
|
4161
4279
|
slug?: string;
|
|
4162
4280
|
/** ID of the entity associated with the event. */
|
|
4163
4281
|
entityId?: string;
|
|
4164
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
4282
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4165
4283
|
eventTime?: Date | null;
|
|
4166
4284
|
/**
|
|
4167
4285
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -4171,12 +4289,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4171
4289
|
/** If present, indicates the action that triggered the event. */
|
|
4172
4290
|
originatedFrom?: string | null;
|
|
4173
4291
|
/**
|
|
4174
|
-
* A sequence number
|
|
4175
|
-
*
|
|
4176
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
4177
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
4178
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
4179
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
4292
|
+
* 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.
|
|
4293
|
+
* 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.
|
|
4180
4294
|
*/
|
|
4181
4295
|
entityEventSequence?: string | null;
|
|
4182
4296
|
}
|
|
@@ -4204,7 +4318,7 @@ export interface EntityUpdatedEvent {
|
|
|
4204
4318
|
currentEntityAsJson?: string;
|
|
4205
4319
|
}
|
|
4206
4320
|
export interface EntityDeletedEvent {
|
|
4207
|
-
/** Entity that was deleted */
|
|
4321
|
+
/** Entity that was deleted. */
|
|
4208
4322
|
deletedEntityAsJson?: string | null;
|
|
4209
4323
|
}
|
|
4210
4324
|
export interface ActionEvent {
|
|
@@ -4248,7 +4362,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4248
4362
|
*/
|
|
4249
4363
|
appId?: string;
|
|
4250
4364
|
/** @readonly */
|
|
4251
|
-
identityType?:
|
|
4365
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4252
4366
|
}
|
|
4253
4367
|
/** @oneof */
|
|
4254
4368
|
export interface IdentificationDataIdOneOf {
|
|
@@ -4280,3 +4394,5 @@ export declare enum WebhookIdentityType {
|
|
|
4280
4394
|
WIX_USER = "WIX_USER",
|
|
4281
4395
|
APP = "APP"
|
|
4282
4396
|
}
|
|
4397
|
+
/** @enumType */
|
|
4398
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|