@wix/auto_sdk_events_notifications 1.0.17 → 1.0.19
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-notifications-v2-notification-config-notifications.types.d.ts +161 -59
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +172 -70
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +161 -59
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +172 -70
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +161 -59
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +172 -70
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +161 -59
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +172 -70
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -42,14 +42,14 @@ export interface EmailNotificationConfig {
|
|
|
42
42
|
* Predefined id of the notification type.
|
|
43
43
|
* @readonly
|
|
44
44
|
*/
|
|
45
|
-
notificationType?:
|
|
45
|
+
notificationType?: EmailNotificationTypeWithLiterals;
|
|
46
46
|
/** Email template values. */
|
|
47
47
|
template?: EmailTemplate;
|
|
48
48
|
/**
|
|
49
49
|
* Desired timing of the notification in hours respectfully to event start time.
|
|
50
50
|
* For example if value is 0 then notification is sent at the start of the event.
|
|
51
51
|
*/
|
|
52
|
-
reminderTime?:
|
|
52
|
+
reminderTime?: EmailNotificationReminderTimeWithLiterals;
|
|
53
53
|
/** When true the notification will be sent when certain trigger occurs. */
|
|
54
54
|
sendingEnabled?: boolean | null;
|
|
55
55
|
}
|
|
@@ -71,6 +71,8 @@ export declare enum EmailNotificationType {
|
|
|
71
71
|
/** Triggered when sending invoice. Currently only `enabled` flag update is supported. */
|
|
72
72
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
73
73
|
}
|
|
74
|
+
/** @enumType */
|
|
75
|
+
export type EmailNotificationTypeWithLiterals = EmailNotificationType | 'UNKNOWN_NOTIFICATION_TYPE' | 'EMAIL_RSVP_CONFIRMATION' | 'EMAIL_NEW_SPOTS_AVAILABLE' | 'EMAIL_EVENT_CANCELATION' | 'EMAIL_UPCOMING_EVENT_REMINDER' | 'EMAIL_ORDER_CONFIRMATION' | 'EMAIL_TICKET_CONFIRMATION' | 'EMAIL_INVOICE';
|
|
74
76
|
export interface EmailTemplate {
|
|
75
77
|
/**
|
|
76
78
|
* Email subject.
|
|
@@ -118,11 +120,13 @@ export declare enum EmailNotificationReminderTime {
|
|
|
118
120
|
/** 30 minutes prior */
|
|
119
121
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
120
122
|
}
|
|
123
|
+
/** @enumType */
|
|
124
|
+
export type EmailNotificationReminderTimeWithLiterals = EmailNotificationReminderTime | 'UNKNOWN_REMINDER_TIME' | 'INSTANT' | 'BEFORE_1_DAY' | 'BEFORE_3_DAYS' | 'BEFORE_1_WEEK' | 'BEFORE_1_HOUR' | 'BEFORE_30_MINUTES';
|
|
121
125
|
export interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
122
126
|
/** Email notification type */
|
|
123
|
-
emailNotificationType?:
|
|
127
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
124
128
|
/** Push notification type */
|
|
125
|
-
pushNotificationType?:
|
|
129
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
126
130
|
/** Rsvp guest info */
|
|
127
131
|
rsvpGuest?: RsvpGuest;
|
|
128
132
|
/** Order guest info */
|
|
@@ -135,9 +139,9 @@ export interface TriggerNotificationRequest extends TriggerNotificationRequestNo
|
|
|
135
139
|
/** @oneof */
|
|
136
140
|
export interface TriggerNotificationRequestNotificationOneOf {
|
|
137
141
|
/** Email notification type */
|
|
138
|
-
emailNotificationType?:
|
|
142
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
139
143
|
/** Push notification type */
|
|
140
|
-
pushNotificationType?:
|
|
144
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
141
145
|
}
|
|
142
146
|
/** @oneof */
|
|
143
147
|
export interface TriggerNotificationRequestGuestsOneOf {
|
|
@@ -162,6 +166,8 @@ export declare enum PushNotificationType {
|
|
|
162
166
|
/** Triggered when event is created. */
|
|
163
167
|
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
164
168
|
}
|
|
169
|
+
/** @enumType */
|
|
170
|
+
export type PushNotificationTypeWithLiterals = PushNotificationType | 'UNKNOWN_PUSH_TYPE' | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
165
171
|
/** Single guest associated to the RSVP */
|
|
166
172
|
export interface RsvpGuest {
|
|
167
173
|
/**
|
|
@@ -328,7 +334,7 @@ export interface Location {
|
|
|
328
334
|
*/
|
|
329
335
|
address?: string | null;
|
|
330
336
|
/** Location type. */
|
|
331
|
-
type?:
|
|
337
|
+
type?: LocationTypeWithLiterals;
|
|
332
338
|
/**
|
|
333
339
|
* Full address derived from formatted single line `address`.
|
|
334
340
|
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
@@ -364,6 +370,8 @@ export declare enum LocationType {
|
|
|
364
370
|
VENUE = "VENUE",
|
|
365
371
|
ONLINE = "ONLINE"
|
|
366
372
|
}
|
|
373
|
+
/** @enumType */
|
|
374
|
+
export type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
367
375
|
/** Physical address */
|
|
368
376
|
export interface Address extends AddressStreetOneOf {
|
|
369
377
|
/** a break down of the street to number and street name */
|
|
@@ -445,6 +453,8 @@ export declare enum SubdivisionType {
|
|
|
445
453
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
446
454
|
COUNTRY = "COUNTRY"
|
|
447
455
|
}
|
|
456
|
+
/** @enumType */
|
|
457
|
+
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';
|
|
448
458
|
export interface ScheduleConfig {
|
|
449
459
|
/**
|
|
450
460
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -488,7 +498,7 @@ export interface Recurrences {
|
|
|
488
498
|
* Recurrence status.
|
|
489
499
|
* @readonly
|
|
490
500
|
*/
|
|
491
|
-
status?:
|
|
501
|
+
status?: StatusWithLiterals;
|
|
492
502
|
}
|
|
493
503
|
export interface Occurrence {
|
|
494
504
|
/** Event start timestamp. */
|
|
@@ -515,6 +525,8 @@ export declare enum Status {
|
|
|
515
525
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
516
526
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
517
527
|
}
|
|
528
|
+
/** @enumType */
|
|
529
|
+
export type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
518
530
|
export interface Event {
|
|
519
531
|
/**
|
|
520
532
|
* Event ID.
|
|
@@ -543,7 +555,7 @@ export interface Event {
|
|
|
543
555
|
/** Event modified timestamp. */
|
|
544
556
|
modified?: Date | null;
|
|
545
557
|
/** Event status. */
|
|
546
|
-
status?:
|
|
558
|
+
status?: EventStatusWithLiterals;
|
|
547
559
|
/** RSVP or ticketing registration details. */
|
|
548
560
|
registration?: Registration;
|
|
549
561
|
/** "Add to calendar" URLs. */
|
|
@@ -625,11 +637,13 @@ export declare enum EventStatus {
|
|
|
625
637
|
/** Event was canceled */
|
|
626
638
|
CANCELED = "CANCELED"
|
|
627
639
|
}
|
|
640
|
+
/** @enumType */
|
|
641
|
+
export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
628
642
|
export interface Registration {
|
|
629
643
|
/** Event type. */
|
|
630
|
-
type?:
|
|
644
|
+
type?: EventTypeWithLiterals;
|
|
631
645
|
/** Event registration status. */
|
|
632
|
-
status?:
|
|
646
|
+
status?: RegistrationStatusWithLiterals;
|
|
633
647
|
/** RSVP collection details. */
|
|
634
648
|
rsvpCollection?: RsvpCollection;
|
|
635
649
|
/** Ticketing details. */
|
|
@@ -637,9 +651,9 @@ export interface Registration {
|
|
|
637
651
|
/** External registration details. */
|
|
638
652
|
external?: ExternalEvent;
|
|
639
653
|
/** Types of users allowed to register. */
|
|
640
|
-
restrictedTo?:
|
|
654
|
+
restrictedTo?: VisitorTypeWithLiterals;
|
|
641
655
|
/** Initial event type which was set when creating an event. */
|
|
642
|
-
initialType?:
|
|
656
|
+
initialType?: EventTypeWithLiterals;
|
|
643
657
|
}
|
|
644
658
|
export declare enum EventType {
|
|
645
659
|
/** Type not available for this request fieldset */
|
|
@@ -653,6 +667,8 @@ export declare enum EventType {
|
|
|
653
667
|
/** Registration not available */
|
|
654
668
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
655
669
|
}
|
|
670
|
+
/** @enumType */
|
|
671
|
+
export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
656
672
|
export declare enum RegistrationStatus {
|
|
657
673
|
/** Registration status is not applicable */
|
|
658
674
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
@@ -671,13 +687,15 @@ export declare enum RegistrationStatus {
|
|
|
671
687
|
/** Registration will be open via RSVP */
|
|
672
688
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
673
689
|
}
|
|
690
|
+
/** @enumType */
|
|
691
|
+
export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
674
692
|
export interface RsvpCollection {
|
|
675
693
|
/** RSVP collection configuration. */
|
|
676
694
|
config?: RsvpCollectionConfig;
|
|
677
695
|
}
|
|
678
696
|
export interface RsvpCollectionConfig {
|
|
679
697
|
/** Defines the supported RSVP statuses. */
|
|
680
|
-
rsvpStatusOptions?:
|
|
698
|
+
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
681
699
|
/**
|
|
682
700
|
* Total guest limit available to register to the event.
|
|
683
701
|
* Additional guests per RSVP are counted towards total guests.
|
|
@@ -696,6 +714,8 @@ export declare enum RsvpStatusOptions {
|
|
|
696
714
|
/** YES and NO RSVP status options are available for the registration */
|
|
697
715
|
YES_AND_NO = "YES_AND_NO"
|
|
698
716
|
}
|
|
717
|
+
/** @enumType */
|
|
718
|
+
export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
699
719
|
export interface Ticketing {
|
|
700
720
|
/**
|
|
701
721
|
* Deprecated.
|
|
@@ -756,7 +776,7 @@ export interface TicketingConfig {
|
|
|
756
776
|
}
|
|
757
777
|
export interface TaxConfig {
|
|
758
778
|
/** Tax application settings. */
|
|
759
|
-
type?:
|
|
779
|
+
type?: TaxTypeWithLiterals;
|
|
760
780
|
/**
|
|
761
781
|
* Tax name.
|
|
762
782
|
* @minLength 1
|
|
@@ -779,6 +799,8 @@ export declare enum TaxType {
|
|
|
779
799
|
/** Tax is added to the final total at the checkout. */
|
|
780
800
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
781
801
|
}
|
|
802
|
+
/** @enumType */
|
|
803
|
+
export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
782
804
|
export interface Money {
|
|
783
805
|
/**
|
|
784
806
|
* *Deprecated:** Use `value` instead.
|
|
@@ -809,6 +831,8 @@ export declare enum VisitorType {
|
|
|
809
831
|
/** Site visitor or member */
|
|
810
832
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
811
833
|
}
|
|
834
|
+
/** @enumType */
|
|
835
|
+
export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
812
836
|
export interface CalendarLinks {
|
|
813
837
|
/** "Add to Google calendar" URL. */
|
|
814
838
|
google?: string;
|
|
@@ -850,7 +874,7 @@ export interface Form {
|
|
|
850
874
|
*/
|
|
851
875
|
export interface InputControl {
|
|
852
876
|
/** Field control type. */
|
|
853
|
-
type?:
|
|
877
|
+
type?: InputControlTypeWithLiterals;
|
|
854
878
|
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
855
879
|
system?: boolean;
|
|
856
880
|
/**
|
|
@@ -897,6 +921,8 @@ export declare enum InputControlType {
|
|
|
897
921
|
/** Year, month and day fields. */
|
|
898
922
|
DATE = "DATE"
|
|
899
923
|
}
|
|
924
|
+
/** @enumType */
|
|
925
|
+
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
900
926
|
/** An input of one or multiple text values */
|
|
901
927
|
export interface Input {
|
|
902
928
|
/** Field name. */
|
|
@@ -920,7 +946,7 @@ export interface Input {
|
|
|
920
946
|
* Type which determines field format.
|
|
921
947
|
* Used to validate submitted response.
|
|
922
948
|
*/
|
|
923
|
-
type?:
|
|
949
|
+
type?: ValueTypeWithLiterals;
|
|
924
950
|
/**
|
|
925
951
|
* A maximum accepted values for array input.
|
|
926
952
|
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
@@ -944,6 +970,8 @@ export declare enum ValueType {
|
|
|
944
970
|
DATE_TIME = "DATE_TIME",
|
|
945
971
|
ADDRESS = "ADDRESS"
|
|
946
972
|
}
|
|
973
|
+
/** @enumType */
|
|
974
|
+
export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
947
975
|
/**
|
|
948
976
|
* Describes initially selected option when an input has multiple choices.
|
|
949
977
|
* Defaults to first (0th) option if not configured.
|
|
@@ -1132,7 +1160,7 @@ export interface OnlineConferencingConfig {
|
|
|
1132
1160
|
*/
|
|
1133
1161
|
providerId?: string | null;
|
|
1134
1162
|
/** Conference type */
|
|
1135
|
-
conferenceType?:
|
|
1163
|
+
conferenceType?: ConferenceTypeWithLiterals;
|
|
1136
1164
|
}
|
|
1137
1165
|
export declare enum ConferenceType {
|
|
1138
1166
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
@@ -1140,6 +1168,8 @@ export declare enum ConferenceType {
|
|
|
1140
1168
|
/** Guests can only subscribe to video and audio. */
|
|
1141
1169
|
WEBINAR = "WEBINAR"
|
|
1142
1170
|
}
|
|
1171
|
+
/** @enumType */
|
|
1172
|
+
export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1143
1173
|
export interface OnlineConferencingSession {
|
|
1144
1174
|
/**
|
|
1145
1175
|
* Link for event host to start the online conference session.
|
|
@@ -1284,7 +1314,7 @@ export interface Category {
|
|
|
1284
1314
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1285
1315
|
* @maxSize 3
|
|
1286
1316
|
*/
|
|
1287
|
-
states?:
|
|
1317
|
+
states?: StateWithLiterals[];
|
|
1288
1318
|
}
|
|
1289
1319
|
export interface CategoryCounts {
|
|
1290
1320
|
/** Total number of draft events assigned to the category. */
|
|
@@ -1302,6 +1332,8 @@ export declare enum State {
|
|
|
1302
1332
|
/** Category is hidden. */
|
|
1303
1333
|
HIDDEN = "HIDDEN"
|
|
1304
1334
|
}
|
|
1335
|
+
/** @enumType */
|
|
1336
|
+
export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1305
1337
|
export interface EventDisplaySettings {
|
|
1306
1338
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1307
1339
|
hideEventDetailsButton?: boolean | null;
|
|
@@ -1374,7 +1406,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1374
1406
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1375
1407
|
layoutCellData?: LayoutCellData;
|
|
1376
1408
|
/** 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. */
|
|
1377
|
-
type?:
|
|
1409
|
+
type?: NodeTypeWithLiterals;
|
|
1378
1410
|
/** Node ID. */
|
|
1379
1411
|
id?: string;
|
|
1380
1412
|
/** A list of child nodes. */
|
|
@@ -1475,6 +1507,8 @@ export declare enum NodeType {
|
|
|
1475
1507
|
LAYOUT = "LAYOUT",
|
|
1476
1508
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1477
1509
|
}
|
|
1510
|
+
/** @enumType */
|
|
1511
|
+
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';
|
|
1478
1512
|
export interface NodeStyle {
|
|
1479
1513
|
/** The top padding value in pixels. */
|
|
1480
1514
|
paddingTop?: string | null;
|
|
@@ -1487,7 +1521,7 @@ export interface ButtonData {
|
|
|
1487
1521
|
/** Styling for the button's container. */
|
|
1488
1522
|
containerData?: PluginContainerData;
|
|
1489
1523
|
/** The button type. */
|
|
1490
|
-
type?:
|
|
1524
|
+
type?: ButtonDataTypeWithLiterals;
|
|
1491
1525
|
/** Styling for the button. */
|
|
1492
1526
|
styles?: Styles;
|
|
1493
1527
|
/** The text to display on the button. */
|
|
@@ -1513,7 +1547,7 @@ export interface PluginContainerData {
|
|
|
1513
1547
|
/** The width of the node when it's displayed. */
|
|
1514
1548
|
width?: PluginContainerDataWidth;
|
|
1515
1549
|
/** The node's alignment within its container. */
|
|
1516
|
-
alignment?:
|
|
1550
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
1517
1551
|
/** Spoiler cover settings for the node. */
|
|
1518
1552
|
spoiler?: Spoiler;
|
|
1519
1553
|
/** The height of the node when it's displayed. */
|
|
@@ -1531,6 +1565,8 @@ export declare enum WidthType {
|
|
|
1531
1565
|
/** coast-to-coast display */
|
|
1532
1566
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1533
1567
|
}
|
|
1568
|
+
/** @enumType */
|
|
1569
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1534
1570
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1535
1571
|
/**
|
|
1536
1572
|
* One of the following predefined width options:
|
|
@@ -1539,7 +1575,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1539
1575
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1540
1576
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1541
1577
|
*/
|
|
1542
|
-
size?:
|
|
1578
|
+
size?: WidthTypeWithLiterals;
|
|
1543
1579
|
/** A custom width value in pixels. */
|
|
1544
1580
|
custom?: string | null;
|
|
1545
1581
|
}
|
|
@@ -1552,7 +1588,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1552
1588
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1553
1589
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1554
1590
|
*/
|
|
1555
|
-
size?:
|
|
1591
|
+
size?: WidthTypeWithLiterals;
|
|
1556
1592
|
/** A custom width value in pixels. */
|
|
1557
1593
|
custom?: string | null;
|
|
1558
1594
|
}
|
|
@@ -1564,6 +1600,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1564
1600
|
/** Right Alignment */
|
|
1565
1601
|
RIGHT = "RIGHT"
|
|
1566
1602
|
}
|
|
1603
|
+
/** @enumType */
|
|
1604
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1567
1605
|
export interface Spoiler {
|
|
1568
1606
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1569
1607
|
enabled?: boolean | null;
|
|
@@ -1582,6 +1620,8 @@ export declare enum ButtonDataType {
|
|
|
1582
1620
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1583
1621
|
ACTION = "ACTION"
|
|
1584
1622
|
}
|
|
1623
|
+
/** @enumType */
|
|
1624
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1585
1625
|
export interface Styles {
|
|
1586
1626
|
/** Border attributes. */
|
|
1587
1627
|
border?: Border;
|
|
@@ -1600,7 +1640,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
1600
1640
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
1601
1641
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
1602
1642
|
*/
|
|
1603
|
-
target?:
|
|
1643
|
+
target?: TargetWithLiterals;
|
|
1604
1644
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
1605
1645
|
rel?: Rel;
|
|
1606
1646
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -1623,6 +1663,8 @@ export declare enum Target {
|
|
|
1623
1663
|
/** Opens the linked document in the full body of the window */
|
|
1624
1664
|
TOP = "TOP"
|
|
1625
1665
|
}
|
|
1666
|
+
/** @enumType */
|
|
1667
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1626
1668
|
export interface Rel {
|
|
1627
1669
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1628
1670
|
nofollow?: boolean | null;
|
|
@@ -1639,7 +1681,7 @@ export interface CodeBlockData {
|
|
|
1639
1681
|
}
|
|
1640
1682
|
export interface TextStyle {
|
|
1641
1683
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1642
|
-
textAlignment?:
|
|
1684
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
1643
1685
|
/** 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. */
|
|
1644
1686
|
lineHeight?: string | null;
|
|
1645
1687
|
}
|
|
@@ -1655,15 +1697,17 @@ export declare enum TextAlignment {
|
|
|
1655
1697
|
/** 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 */
|
|
1656
1698
|
JUSTIFY = "JUSTIFY"
|
|
1657
1699
|
}
|
|
1700
|
+
/** @enumType */
|
|
1701
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1658
1702
|
export interface DividerData {
|
|
1659
1703
|
/** Styling for the divider's container. */
|
|
1660
1704
|
containerData?: PluginContainerData;
|
|
1661
1705
|
/** Divider line style. */
|
|
1662
|
-
lineStyle?:
|
|
1706
|
+
lineStyle?: LineStyleWithLiterals;
|
|
1663
1707
|
/** Divider width. */
|
|
1664
|
-
width?:
|
|
1708
|
+
width?: WidthWithLiterals;
|
|
1665
1709
|
/** Divider alignment. */
|
|
1666
|
-
alignment?:
|
|
1710
|
+
alignment?: AlignmentWithLiterals;
|
|
1667
1711
|
}
|
|
1668
1712
|
export declare enum LineStyle {
|
|
1669
1713
|
/** Single Line */
|
|
@@ -1675,6 +1719,8 @@ export declare enum LineStyle {
|
|
|
1675
1719
|
/** Dotted Line */
|
|
1676
1720
|
DOTTED = "DOTTED"
|
|
1677
1721
|
}
|
|
1722
|
+
/** @enumType */
|
|
1723
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1678
1724
|
export declare enum Width {
|
|
1679
1725
|
/** Large line */
|
|
1680
1726
|
LARGE = "LARGE",
|
|
@@ -1683,6 +1729,8 @@ export declare enum Width {
|
|
|
1683
1729
|
/** Small line */
|
|
1684
1730
|
SMALL = "SMALL"
|
|
1685
1731
|
}
|
|
1732
|
+
/** @enumType */
|
|
1733
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1686
1734
|
export declare enum Alignment {
|
|
1687
1735
|
/** Center alignment */
|
|
1688
1736
|
CENTER = "CENTER",
|
|
@@ -1691,6 +1739,8 @@ export declare enum Alignment {
|
|
|
1691
1739
|
/** Right alignment */
|
|
1692
1740
|
RIGHT = "RIGHT"
|
|
1693
1741
|
}
|
|
1742
|
+
/** @enumType */
|
|
1743
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1694
1744
|
export interface FileData {
|
|
1695
1745
|
/** Styling for the file's container. */
|
|
1696
1746
|
containerData?: PluginContainerData;
|
|
@@ -1722,6 +1772,8 @@ export declare enum ViewMode {
|
|
|
1722
1772
|
/** Mini PDF view */
|
|
1723
1773
|
MINI = "MINI"
|
|
1724
1774
|
}
|
|
1775
|
+
/** @enumType */
|
|
1776
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1725
1777
|
export interface FileSource extends FileSourceDataOneOf {
|
|
1726
1778
|
/** The absolute URL for the file's source. */
|
|
1727
1779
|
url?: string | null;
|
|
@@ -1754,7 +1806,7 @@ export interface PDFSettings {
|
|
|
1754
1806
|
* `FULL` : A full page view of the PDF is displayed.
|
|
1755
1807
|
* `MINI` : A mini view of the PDF is displayed.
|
|
1756
1808
|
*/
|
|
1757
|
-
viewMode?:
|
|
1809
|
+
viewMode?: ViewModeWithLiterals;
|
|
1758
1810
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1759
1811
|
disableDownload?: boolean | null;
|
|
1760
1812
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -1841,18 +1893,24 @@ export declare enum LayoutType {
|
|
|
1841
1893
|
/** Fullsize images type */
|
|
1842
1894
|
FULLSIZE = "FULLSIZE"
|
|
1843
1895
|
}
|
|
1896
|
+
/** @enumType */
|
|
1897
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1844
1898
|
export declare enum Orientation {
|
|
1845
1899
|
/** Rows Orientation */
|
|
1846
1900
|
ROWS = "ROWS",
|
|
1847
1901
|
/** Columns Orientation */
|
|
1848
1902
|
COLUMNS = "COLUMNS"
|
|
1849
1903
|
}
|
|
1904
|
+
/** @enumType */
|
|
1905
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1850
1906
|
export declare enum Crop {
|
|
1851
1907
|
/** Crop to fill */
|
|
1852
1908
|
FILL = "FILL",
|
|
1853
1909
|
/** Crop to fit */
|
|
1854
1910
|
FIT = "FIT"
|
|
1855
1911
|
}
|
|
1912
|
+
/** @enumType */
|
|
1913
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1856
1914
|
export declare enum ThumbnailsAlignment {
|
|
1857
1915
|
/** Top alignment */
|
|
1858
1916
|
TOP = "TOP",
|
|
@@ -1865,13 +1923,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
1865
1923
|
/** No thumbnail */
|
|
1866
1924
|
NONE = "NONE"
|
|
1867
1925
|
}
|
|
1926
|
+
/** @enumType */
|
|
1927
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1868
1928
|
export interface Layout {
|
|
1869
1929
|
/** Gallery layout type. */
|
|
1870
|
-
type?:
|
|
1930
|
+
type?: LayoutTypeWithLiterals;
|
|
1871
1931
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1872
1932
|
horizontalScroll?: boolean | null;
|
|
1873
1933
|
/** Gallery orientation. */
|
|
1874
|
-
orientation?:
|
|
1934
|
+
orientation?: OrientationWithLiterals;
|
|
1875
1935
|
/** The number of columns to display on full size screens. */
|
|
1876
1936
|
numberOfColumns?: number | null;
|
|
1877
1937
|
/** The number of columns to display on mobile screens. */
|
|
@@ -1883,13 +1943,13 @@ export interface ItemStyle {
|
|
|
1883
1943
|
/** Item ratio */
|
|
1884
1944
|
ratio?: number | null;
|
|
1885
1945
|
/** Sets how item images are cropped. */
|
|
1886
|
-
crop?:
|
|
1946
|
+
crop?: CropWithLiterals;
|
|
1887
1947
|
/** The spacing between items in pixels. */
|
|
1888
1948
|
spacing?: number | null;
|
|
1889
1949
|
}
|
|
1890
1950
|
export interface Thumbnails {
|
|
1891
1951
|
/** Thumbnail alignment. */
|
|
1892
|
-
placement?:
|
|
1952
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1893
1953
|
/** Spacing between thumbnails in pixels. */
|
|
1894
1954
|
spacing?: number | null;
|
|
1895
1955
|
}
|
|
@@ -1905,7 +1965,7 @@ export interface GIFData {
|
|
|
1905
1965
|
/** Width in pixels. */
|
|
1906
1966
|
width?: number;
|
|
1907
1967
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1908
|
-
gifType?:
|
|
1968
|
+
gifType?: GIFTypeWithLiterals;
|
|
1909
1969
|
}
|
|
1910
1970
|
export interface GIF {
|
|
1911
1971
|
/**
|
|
@@ -1928,6 +1988,8 @@ export declare enum GIFType {
|
|
|
1928
1988
|
NORMAL = "NORMAL",
|
|
1929
1989
|
STICKER = "STICKER"
|
|
1930
1990
|
}
|
|
1991
|
+
/** @enumType */
|
|
1992
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1931
1993
|
export interface HeadingData {
|
|
1932
1994
|
/** Heading level from 1-6. */
|
|
1933
1995
|
level?: number;
|
|
@@ -1949,7 +2011,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1949
2011
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1950
2012
|
containerData?: PluginContainerData;
|
|
1951
2013
|
/** The type of HTML code. */
|
|
1952
|
-
source?:
|
|
2014
|
+
source?: SourceWithLiterals;
|
|
1953
2015
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1954
2016
|
autoHeight?: boolean | null;
|
|
1955
2017
|
}
|
|
@@ -1969,6 +2031,8 @@ export declare enum Source {
|
|
|
1969
2031
|
HTML = "HTML",
|
|
1970
2032
|
ADSENSE = "ADSENSE"
|
|
1971
2033
|
}
|
|
2034
|
+
/** @enumType */
|
|
2035
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1972
2036
|
export interface ImageData {
|
|
1973
2037
|
/** Styling for the image's container. */
|
|
1974
2038
|
containerData?: PluginContainerData;
|
|
@@ -2033,6 +2097,8 @@ export declare enum Position {
|
|
|
2033
2097
|
/** Thumbnail hidden and not displayed */
|
|
2034
2098
|
HIDDEN = "HIDDEN"
|
|
2035
2099
|
}
|
|
2100
|
+
/** @enumType */
|
|
2101
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2036
2102
|
export interface LinkPreviewDataStyles {
|
|
2037
2103
|
/**
|
|
2038
2104
|
* Background color as a hexadecimal value.
|
|
@@ -2064,7 +2130,7 @@ export interface LinkPreviewDataStyles {
|
|
|
2064
2130
|
*/
|
|
2065
2131
|
borderColor?: string | null;
|
|
2066
2132
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2067
|
-
thumbnailPosition?:
|
|
2133
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
2068
2134
|
}
|
|
2069
2135
|
export interface MapData {
|
|
2070
2136
|
/** Styling for the map's container. */
|
|
@@ -2094,7 +2160,7 @@ export interface MapSettings {
|
|
|
2094
2160
|
/** Initial zoom value. */
|
|
2095
2161
|
initialZoom?: number | null;
|
|
2096
2162
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2097
|
-
mapType?:
|
|
2163
|
+
mapType?: MapTypeWithLiterals;
|
|
2098
2164
|
}
|
|
2099
2165
|
export declare enum MapType {
|
|
2100
2166
|
/** Roadmap map type */
|
|
@@ -2106,6 +2172,8 @@ export declare enum MapType {
|
|
|
2106
2172
|
/** Terrain map type */
|
|
2107
2173
|
TERRAIN = "TERRAIN"
|
|
2108
2174
|
}
|
|
2175
|
+
/** @enumType */
|
|
2176
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2109
2177
|
export interface ParagraphData {
|
|
2110
2178
|
/** Styling for the paragraph text. */
|
|
2111
2179
|
textStyle?: TextStyle;
|
|
@@ -2132,17 +2200,21 @@ export declare enum ViewRole {
|
|
|
2132
2200
|
/** Anyone can see the results, even if one didn't vote */
|
|
2133
2201
|
EVERYONE = "EVERYONE"
|
|
2134
2202
|
}
|
|
2203
|
+
/** @enumType */
|
|
2204
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2135
2205
|
export declare enum VoteRole {
|
|
2136
2206
|
/** Logged in member */
|
|
2137
2207
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2138
2208
|
/** Anyone */
|
|
2139
2209
|
ALL = "ALL"
|
|
2140
2210
|
}
|
|
2211
|
+
/** @enumType */
|
|
2212
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2141
2213
|
export interface Permissions {
|
|
2142
2214
|
/** Sets who can view the poll results. */
|
|
2143
|
-
view?:
|
|
2215
|
+
view?: ViewRoleWithLiterals;
|
|
2144
2216
|
/** Sets who can vote. */
|
|
2145
|
-
vote?:
|
|
2217
|
+
vote?: VoteRoleWithLiterals;
|
|
2146
2218
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2147
2219
|
allowMultipleVotes?: boolean | null;
|
|
2148
2220
|
}
|
|
@@ -2168,17 +2240,21 @@ export declare enum PollLayoutType {
|
|
|
2168
2240
|
/** Grid */
|
|
2169
2241
|
GRID = "GRID"
|
|
2170
2242
|
}
|
|
2243
|
+
/** @enumType */
|
|
2244
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2171
2245
|
export declare enum PollLayoutDirection {
|
|
2172
2246
|
/** Left-to-right */
|
|
2173
2247
|
LTR = "LTR",
|
|
2174
2248
|
/** Right-to-left */
|
|
2175
2249
|
RTL = "RTL"
|
|
2176
2250
|
}
|
|
2251
|
+
/** @enumType */
|
|
2252
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2177
2253
|
export interface PollLayout {
|
|
2178
2254
|
/** The layout for displaying the voting options. */
|
|
2179
|
-
type?:
|
|
2255
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2180
2256
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2181
|
-
direction?:
|
|
2257
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2182
2258
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2183
2259
|
enableImage?: boolean | null;
|
|
2184
2260
|
}
|
|
@@ -2194,6 +2270,8 @@ export declare enum BackgroundType {
|
|
|
2194
2270
|
/** Gradiant background type */
|
|
2195
2271
|
GRADIENT = "GRADIENT"
|
|
2196
2272
|
}
|
|
2273
|
+
/** @enumType */
|
|
2274
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2197
2275
|
export interface Gradient {
|
|
2198
2276
|
/** The gradient angle in degrees. */
|
|
2199
2277
|
angle?: number | null;
|
|
@@ -2219,7 +2297,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2219
2297
|
/** Details for a gradient background. */
|
|
2220
2298
|
gradient?: Gradient;
|
|
2221
2299
|
/** Background type. For each option, include the relevant details. */
|
|
2222
|
-
type?:
|
|
2300
|
+
type?: BackgroundTypeWithLiterals;
|
|
2223
2301
|
}
|
|
2224
2302
|
/** @oneof */
|
|
2225
2303
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -2296,7 +2374,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2296
2374
|
/** Data for a spoiler decoration. */
|
|
2297
2375
|
spoilerData?: SpoilerData;
|
|
2298
2376
|
/** The type of decoration to apply. */
|
|
2299
|
-
type?:
|
|
2377
|
+
type?: DecorationTypeWithLiterals;
|
|
2300
2378
|
}
|
|
2301
2379
|
/** @oneof */
|
|
2302
2380
|
export interface DecorationDataOneOf {
|
|
@@ -2331,6 +2409,8 @@ export declare enum DecorationType {
|
|
|
2331
2409
|
FONT_SIZE = "FONT_SIZE",
|
|
2332
2410
|
EXTERNAL = "EXTERNAL"
|
|
2333
2411
|
}
|
|
2412
|
+
/** @enumType */
|
|
2413
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
2334
2414
|
export interface AnchorData {
|
|
2335
2415
|
/** The target node's ID. */
|
|
2336
2416
|
anchor?: string;
|
|
@@ -2355,7 +2435,7 @@ export interface MentionData {
|
|
|
2355
2435
|
}
|
|
2356
2436
|
export interface FontSizeData {
|
|
2357
2437
|
/** The units used for the font size. */
|
|
2358
|
-
unit?:
|
|
2438
|
+
unit?: FontTypeWithLiterals;
|
|
2359
2439
|
/** Font size value. */
|
|
2360
2440
|
value?: number | null;
|
|
2361
2441
|
}
|
|
@@ -2363,6 +2443,8 @@ export declare enum FontType {
|
|
|
2363
2443
|
PX = "PX",
|
|
2364
2444
|
EM = "EM"
|
|
2365
2445
|
}
|
|
2446
|
+
/** @enumType */
|
|
2447
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2366
2448
|
export interface SpoilerData {
|
|
2367
2449
|
/** Spoiler ID. */
|
|
2368
2450
|
id?: string | null;
|
|
@@ -2373,7 +2455,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2373
2455
|
/** Data for embedded Wix Events content. */
|
|
2374
2456
|
eventData?: EventData;
|
|
2375
2457
|
/** The type of Wix App content being embedded. */
|
|
2376
|
-
type?:
|
|
2458
|
+
type?: AppTypeWithLiterals;
|
|
2377
2459
|
/** The ID of the embedded content. */
|
|
2378
2460
|
itemId?: string | null;
|
|
2379
2461
|
/** The name of the embedded content. */
|
|
@@ -2400,6 +2482,8 @@ export declare enum AppType {
|
|
|
2400
2482
|
EVENT = "EVENT",
|
|
2401
2483
|
BOOKING = "BOOKING"
|
|
2402
2484
|
}
|
|
2485
|
+
/** @enumType */
|
|
2486
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2403
2487
|
export interface BookingData {
|
|
2404
2488
|
/** Booking duration in minutes. */
|
|
2405
2489
|
durations?: string | null;
|
|
@@ -2478,9 +2562,9 @@ export interface CollapsibleListData {
|
|
|
2478
2562
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2479
2563
|
expandOnlyOne?: boolean | null;
|
|
2480
2564
|
/** Sets which items are expanded when the page loads. */
|
|
2481
|
-
initialExpandedItems?:
|
|
2565
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2482
2566
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2483
|
-
direction?:
|
|
2567
|
+
direction?: DirectionWithLiterals;
|
|
2484
2568
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2485
2569
|
isQapageData?: boolean | null;
|
|
2486
2570
|
}
|
|
@@ -2492,12 +2576,16 @@ export declare enum InitialExpandedItems {
|
|
|
2492
2576
|
/** All items collapsed initally */
|
|
2493
2577
|
NONE = "NONE"
|
|
2494
2578
|
}
|
|
2579
|
+
/** @enumType */
|
|
2580
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2495
2581
|
export declare enum Direction {
|
|
2496
2582
|
/** Left-to-right */
|
|
2497
2583
|
LTR = "LTR",
|
|
2498
2584
|
/** Right-to-left */
|
|
2499
2585
|
RTL = "RTL"
|
|
2500
2586
|
}
|
|
2587
|
+
/** @enumType */
|
|
2588
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2501
2589
|
export interface TableData {
|
|
2502
2590
|
/** Styling for the table's container. */
|
|
2503
2591
|
containerData?: PluginContainerData;
|
|
@@ -2535,9 +2623,11 @@ export declare enum VerticalAlignment {
|
|
|
2535
2623
|
/** Bottom alignment */
|
|
2536
2624
|
BOTTOM = "BOTTOM"
|
|
2537
2625
|
}
|
|
2626
|
+
/** @enumType */
|
|
2627
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2538
2628
|
export interface CellStyle {
|
|
2539
2629
|
/** Vertical alignment for the cell's text. */
|
|
2540
|
-
verticalAlignment?:
|
|
2630
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2541
2631
|
/**
|
|
2542
2632
|
* Cell background color as a hexadecimal value.
|
|
2543
2633
|
* @format COLOR_HEX
|
|
@@ -2576,6 +2666,8 @@ export declare enum NullValue {
|
|
|
2576
2666
|
/** Null value. */
|
|
2577
2667
|
NULL_VALUE = "NULL_VALUE"
|
|
2578
2668
|
}
|
|
2669
|
+
/** @enumType */
|
|
2670
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2579
2671
|
/**
|
|
2580
2672
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2581
2673
|
*
|
|
@@ -2673,7 +2765,7 @@ export interface TextNodeStyle {
|
|
|
2673
2765
|
}
|
|
2674
2766
|
export interface Badge {
|
|
2675
2767
|
/** Badge type. */
|
|
2676
|
-
type?:
|
|
2768
|
+
type?: TypeWithLiterals;
|
|
2677
2769
|
/**
|
|
2678
2770
|
* Badge text.
|
|
2679
2771
|
* @maxLength 50
|
|
@@ -2690,6 +2782,8 @@ export declare enum Type {
|
|
|
2690
2782
|
/** General badge type. */
|
|
2691
2783
|
GENERAL = "GENERAL"
|
|
2692
2784
|
}
|
|
2785
|
+
/** @enumType */
|
|
2786
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'URGENT' | 'INFO' | 'GENERAL';
|
|
2693
2787
|
export interface OrderConfirmed {
|
|
2694
2788
|
/** Order confirmation timestamp in ISO UTC. */
|
|
2695
2789
|
timestamp?: Date | null;
|
|
@@ -2733,7 +2827,7 @@ export interface OrderConfirmed {
|
|
|
2733
2827
|
/** Checkout form response. */
|
|
2734
2828
|
checkoutForm?: FormResponse;
|
|
2735
2829
|
/** Order status. */
|
|
2736
|
-
status?:
|
|
2830
|
+
status?: OrderStatusWithLiterals;
|
|
2737
2831
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
2738
2832
|
method?: string | null;
|
|
2739
2833
|
/** Tickets (generated after payment). */
|
|
@@ -2854,6 +2948,8 @@ export declare enum OrderStatus {
|
|
|
2854
2948
|
/** Order is partially paid with less than the total amount. */
|
|
2855
2949
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
2856
2950
|
}
|
|
2951
|
+
/** @enumType */
|
|
2952
|
+
export type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
2857
2953
|
export interface Ticket {
|
|
2858
2954
|
/** Unique issued ticket number. */
|
|
2859
2955
|
ticketNumber?: string;
|
|
@@ -3047,7 +3143,7 @@ export interface PercentDiscount {
|
|
|
3047
3143
|
}
|
|
3048
3144
|
export interface Tax {
|
|
3049
3145
|
/** Tax type. */
|
|
3050
|
-
type?:
|
|
3146
|
+
type?: TaxTypeWithLiterals;
|
|
3051
3147
|
/**
|
|
3052
3148
|
* Tax name.
|
|
3053
3149
|
* @readonly
|
|
@@ -3065,9 +3161,9 @@ export interface Tax {
|
|
|
3065
3161
|
}
|
|
3066
3162
|
export interface Fee {
|
|
3067
3163
|
/** Fee identifier. */
|
|
3068
|
-
name?:
|
|
3164
|
+
name?: FeeNameWithLiterals;
|
|
3069
3165
|
/** How fee is calculated. */
|
|
3070
|
-
type?:
|
|
3166
|
+
type?: FeeTypeWithLiterals;
|
|
3071
3167
|
/**
|
|
3072
3168
|
* Fee rate.
|
|
3073
3169
|
* @format DECIMAL_VALUE
|
|
@@ -3081,6 +3177,8 @@ export declare enum FeeName {
|
|
|
3081
3177
|
/** Wix ticket service fee charges applied to the line item. */
|
|
3082
3178
|
WIX_FEE = "WIX_FEE"
|
|
3083
3179
|
}
|
|
3180
|
+
/** @enumType */
|
|
3181
|
+
export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
3084
3182
|
export declare enum FeeType {
|
|
3085
3183
|
/** Fee is added to the ticket price at checkout. */
|
|
3086
3184
|
FEE_ADDED = "FEE_ADDED",
|
|
@@ -3089,6 +3187,8 @@ export declare enum FeeType {
|
|
|
3089
3187
|
/** Fee is added to the ticket price at checkout. */
|
|
3090
3188
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3091
3189
|
}
|
|
3190
|
+
/** @enumType */
|
|
3191
|
+
export type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
3092
3192
|
/** Produced if a buyer email was added to the existing order */
|
|
3093
3193
|
export interface OrderEmailAdded {
|
|
3094
3194
|
/** Order updated timestamp in ISO UTC format. */
|
|
@@ -3155,7 +3255,7 @@ export interface OrderEmailAdded {
|
|
|
3155
3255
|
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
3156
3256
|
confirmed?: boolean;
|
|
3157
3257
|
/** Order status. */
|
|
3158
|
-
status?:
|
|
3258
|
+
status?: OrderStatusWithLiterals;
|
|
3159
3259
|
/**
|
|
3160
3260
|
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3161
3261
|
* @maxLength 100
|
|
@@ -3291,7 +3391,7 @@ export interface OrderPaid {
|
|
|
3291
3391
|
/** Checkout form response. */
|
|
3292
3392
|
checkoutForm?: FormResponse;
|
|
3293
3393
|
/** Order status. */
|
|
3294
|
-
status?:
|
|
3394
|
+
status?: OrderStatusWithLiterals;
|
|
3295
3395
|
/**
|
|
3296
3396
|
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3297
3397
|
* @maxLength 255
|
|
@@ -3435,7 +3535,7 @@ export interface ResolveEmailNotificationConfigRequest {
|
|
|
3435
3535
|
*/
|
|
3436
3536
|
notificationConfigId?: string;
|
|
3437
3537
|
/** Notification type */
|
|
3438
|
-
notificationType?:
|
|
3538
|
+
notificationType?: EmailNotificationTypeWithLiterals;
|
|
3439
3539
|
}
|
|
3440
3540
|
export interface ResolveEmailNotificationConfigResponse {
|
|
3441
3541
|
/** The retrieved EmailNotificationConfig */
|
|
@@ -3477,7 +3577,7 @@ export interface EventCopied {
|
|
|
3477
3577
|
*/
|
|
3478
3578
|
userId?: string | null;
|
|
3479
3579
|
/** Event status. */
|
|
3480
|
-
status?:
|
|
3580
|
+
status?: EventStatusWithLiterals;
|
|
3481
3581
|
/**
|
|
3482
3582
|
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3483
3583
|
* @format GUID
|
|
@@ -3533,7 +3633,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3533
3633
|
*/
|
|
3534
3634
|
appId?: string;
|
|
3535
3635
|
/** @readonly */
|
|
3536
|
-
identityType?:
|
|
3636
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3537
3637
|
}
|
|
3538
3638
|
/** @oneof */
|
|
3539
3639
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3565,3 +3665,5 @@ export declare enum WebhookIdentityType {
|
|
|
3565
3665
|
WIX_USER = "WIX_USER",
|
|
3566
3666
|
APP = "APP"
|
|
3567
3667
|
}
|
|
3668
|
+
/** @enumType */
|
|
3669
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|