@wix/auto_sdk_events_notifications 1.0.18 → 1.0.20
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 +165 -63
- 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 +165 -63
- 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 +165 -63
- 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 +165 -63
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/package.json +3 -3
package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts
CHANGED
|
@@ -43,14 +43,14 @@ export interface EmailNotificationConfig {
|
|
|
43
43
|
* Predefined id of the notification type.
|
|
44
44
|
* @readonly
|
|
45
45
|
*/
|
|
46
|
-
notificationType?:
|
|
46
|
+
notificationType?: EmailNotificationTypeWithLiterals;
|
|
47
47
|
/** Email template values. */
|
|
48
48
|
template?: EmailTemplate;
|
|
49
49
|
/**
|
|
50
50
|
* Desired timing of the notification in hours respectfully to event start time.
|
|
51
51
|
* For example if value is 0 then notification is sent at the start of the event.
|
|
52
52
|
*/
|
|
53
|
-
reminderTime?:
|
|
53
|
+
reminderTime?: EmailNotificationReminderTimeWithLiterals;
|
|
54
54
|
/** When true the notification will be sent when certain trigger occurs. */
|
|
55
55
|
sendingEnabled?: boolean | null;
|
|
56
56
|
}
|
|
@@ -72,6 +72,8 @@ export declare enum EmailNotificationType {
|
|
|
72
72
|
/** Triggered when sending invoice. Currently only `enabled` flag update is supported. */
|
|
73
73
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
74
74
|
}
|
|
75
|
+
/** @enumType */
|
|
76
|
+
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';
|
|
75
77
|
export interface EmailTemplate {
|
|
76
78
|
/**
|
|
77
79
|
* Email subject.
|
|
@@ -119,11 +121,13 @@ export declare enum EmailNotificationReminderTime {
|
|
|
119
121
|
/** 30 minutes prior */
|
|
120
122
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
121
123
|
}
|
|
124
|
+
/** @enumType */
|
|
125
|
+
export type EmailNotificationReminderTimeWithLiterals = EmailNotificationReminderTime | 'UNKNOWN_REMINDER_TIME' | 'INSTANT' | 'BEFORE_1_DAY' | 'BEFORE_3_DAYS' | 'BEFORE_1_WEEK' | 'BEFORE_1_HOUR' | 'BEFORE_30_MINUTES';
|
|
122
126
|
export interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
123
127
|
/** Email notification type */
|
|
124
|
-
emailNotificationType?:
|
|
128
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
125
129
|
/** Push notification type */
|
|
126
|
-
pushNotificationType?:
|
|
130
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
127
131
|
/** Rsvp guest info */
|
|
128
132
|
rsvpGuest?: RsvpGuest;
|
|
129
133
|
/** Order guest info */
|
|
@@ -136,9 +140,9 @@ export interface TriggerNotificationRequest extends TriggerNotificationRequestNo
|
|
|
136
140
|
/** @oneof */
|
|
137
141
|
export interface TriggerNotificationRequestNotificationOneOf {
|
|
138
142
|
/** Email notification type */
|
|
139
|
-
emailNotificationType?:
|
|
143
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
140
144
|
/** Push notification type */
|
|
141
|
-
pushNotificationType?:
|
|
145
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
142
146
|
}
|
|
143
147
|
/** @oneof */
|
|
144
148
|
export interface TriggerNotificationRequestGuestsOneOf {
|
|
@@ -163,6 +167,8 @@ export declare enum PushNotificationType {
|
|
|
163
167
|
/** Triggered when event is created. */
|
|
164
168
|
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
165
169
|
}
|
|
170
|
+
/** @enumType */
|
|
171
|
+
export type PushNotificationTypeWithLiterals = PushNotificationType | 'UNKNOWN_PUSH_TYPE' | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
166
172
|
/** Single guest associated to the RSVP */
|
|
167
173
|
export interface RsvpGuest {
|
|
168
174
|
/**
|
|
@@ -327,7 +333,7 @@ export interface Location {
|
|
|
327
333
|
*/
|
|
328
334
|
address?: string | null;
|
|
329
335
|
/** Location type. */
|
|
330
|
-
type?:
|
|
336
|
+
type?: LocationTypeWithLiterals;
|
|
331
337
|
/**
|
|
332
338
|
* Full address derived from formatted single line `address`.
|
|
333
339
|
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
@@ -363,6 +369,8 @@ export declare enum LocationType {
|
|
|
363
369
|
VENUE = "VENUE",
|
|
364
370
|
ONLINE = "ONLINE"
|
|
365
371
|
}
|
|
372
|
+
/** @enumType */
|
|
373
|
+
export type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
366
374
|
/** Physical address */
|
|
367
375
|
export interface Address extends AddressStreetOneOf {
|
|
368
376
|
/** a break down of the street to number and street name */
|
|
@@ -442,6 +450,8 @@ export declare enum SubdivisionType {
|
|
|
442
450
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
443
451
|
COUNTRY = "COUNTRY"
|
|
444
452
|
}
|
|
453
|
+
/** @enumType */
|
|
454
|
+
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';
|
|
445
455
|
export interface ScheduleConfig {
|
|
446
456
|
/**
|
|
447
457
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -485,7 +495,7 @@ export interface Recurrences {
|
|
|
485
495
|
* Recurrence status.
|
|
486
496
|
* @readonly
|
|
487
497
|
*/
|
|
488
|
-
status?:
|
|
498
|
+
status?: StatusWithLiterals;
|
|
489
499
|
}
|
|
490
500
|
export interface Occurrence {
|
|
491
501
|
/** Event start timestamp. */
|
|
@@ -512,6 +522,8 @@ export declare enum Status {
|
|
|
512
522
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
513
523
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
514
524
|
}
|
|
525
|
+
/** @enumType */
|
|
526
|
+
export type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
515
527
|
export interface Event {
|
|
516
528
|
/**
|
|
517
529
|
* Event ID.
|
|
@@ -540,7 +552,7 @@ export interface Event {
|
|
|
540
552
|
/** Event modified timestamp. */
|
|
541
553
|
modified?: Date | null;
|
|
542
554
|
/** Event status. */
|
|
543
|
-
status?:
|
|
555
|
+
status?: EventStatusWithLiterals;
|
|
544
556
|
/** RSVP or ticketing registration details. */
|
|
545
557
|
registration?: Registration;
|
|
546
558
|
/** "Add to calendar" URLs. */
|
|
@@ -606,11 +618,13 @@ export declare enum EventStatus {
|
|
|
606
618
|
/** Event was canceled */
|
|
607
619
|
CANCELED = "CANCELED"
|
|
608
620
|
}
|
|
621
|
+
/** @enumType */
|
|
622
|
+
export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
609
623
|
export interface Registration {
|
|
610
624
|
/** Event type. */
|
|
611
|
-
type?:
|
|
625
|
+
type?: EventTypeWithLiterals;
|
|
612
626
|
/** Event registration status. */
|
|
613
|
-
status?:
|
|
627
|
+
status?: RegistrationStatusWithLiterals;
|
|
614
628
|
/** RSVP collection details. */
|
|
615
629
|
rsvpCollection?: RsvpCollection;
|
|
616
630
|
/** Ticketing details. */
|
|
@@ -618,9 +632,9 @@ export interface Registration {
|
|
|
618
632
|
/** External registration details. */
|
|
619
633
|
external?: ExternalEvent;
|
|
620
634
|
/** Types of users allowed to register. */
|
|
621
|
-
restrictedTo?:
|
|
635
|
+
restrictedTo?: VisitorTypeWithLiterals;
|
|
622
636
|
/** Initial event type which was set when creating an event. */
|
|
623
|
-
initialType?:
|
|
637
|
+
initialType?: EventTypeWithLiterals;
|
|
624
638
|
}
|
|
625
639
|
export declare enum EventType {
|
|
626
640
|
/** Type not available for this request fieldset */
|
|
@@ -634,6 +648,8 @@ export declare enum EventType {
|
|
|
634
648
|
/** Registration not available */
|
|
635
649
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
636
650
|
}
|
|
651
|
+
/** @enumType */
|
|
652
|
+
export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
637
653
|
export declare enum RegistrationStatus {
|
|
638
654
|
/** Registration status is not applicable */
|
|
639
655
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
@@ -652,13 +668,15 @@ export declare enum RegistrationStatus {
|
|
|
652
668
|
/** Registration will be open via RSVP */
|
|
653
669
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
654
670
|
}
|
|
671
|
+
/** @enumType */
|
|
672
|
+
export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
655
673
|
export interface RsvpCollection {
|
|
656
674
|
/** RSVP collection configuration. */
|
|
657
675
|
config?: RsvpCollectionConfig;
|
|
658
676
|
}
|
|
659
677
|
export interface RsvpCollectionConfig {
|
|
660
678
|
/** Defines the supported RSVP statuses. */
|
|
661
|
-
rsvpStatusOptions?:
|
|
679
|
+
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
662
680
|
/**
|
|
663
681
|
* Total guest limit available to register to the event.
|
|
664
682
|
* Additional guests per RSVP are counted towards total guests.
|
|
@@ -677,6 +695,8 @@ export declare enum RsvpStatusOptions {
|
|
|
677
695
|
/** YES and NO RSVP status options are available for the registration */
|
|
678
696
|
YES_AND_NO = "YES_AND_NO"
|
|
679
697
|
}
|
|
698
|
+
/** @enumType */
|
|
699
|
+
export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
680
700
|
export interface Ticketing {
|
|
681
701
|
/**
|
|
682
702
|
* Deprecated.
|
|
@@ -737,7 +757,7 @@ export interface TicketingConfig {
|
|
|
737
757
|
}
|
|
738
758
|
export interface TaxConfig {
|
|
739
759
|
/** Tax application settings. */
|
|
740
|
-
type?:
|
|
760
|
+
type?: TaxTypeWithLiterals;
|
|
741
761
|
/**
|
|
742
762
|
* Tax name.
|
|
743
763
|
* @minLength 1
|
|
@@ -760,6 +780,8 @@ export declare enum TaxType {
|
|
|
760
780
|
/** Tax is added to the final total at the checkout. */
|
|
761
781
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
762
782
|
}
|
|
783
|
+
/** @enumType */
|
|
784
|
+
export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
763
785
|
export interface Money {
|
|
764
786
|
/**
|
|
765
787
|
* *Deprecated:** Use `value` instead.
|
|
@@ -790,6 +812,8 @@ export declare enum VisitorType {
|
|
|
790
812
|
/** Site visitor or member */
|
|
791
813
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
792
814
|
}
|
|
815
|
+
/** @enumType */
|
|
816
|
+
export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
793
817
|
export interface CalendarLinks {
|
|
794
818
|
/** "Add to Google calendar" URL. */
|
|
795
819
|
google?: string;
|
|
@@ -831,7 +855,7 @@ export interface Form {
|
|
|
831
855
|
*/
|
|
832
856
|
export interface InputControl {
|
|
833
857
|
/** Field control type. */
|
|
834
|
-
type?:
|
|
858
|
+
type?: InputControlTypeWithLiterals;
|
|
835
859
|
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
836
860
|
system?: boolean;
|
|
837
861
|
/**
|
|
@@ -878,6 +902,8 @@ export declare enum InputControlType {
|
|
|
878
902
|
/** Year, month and day fields. */
|
|
879
903
|
DATE = "DATE"
|
|
880
904
|
}
|
|
905
|
+
/** @enumType */
|
|
906
|
+
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
881
907
|
/** An input of one or multiple text values */
|
|
882
908
|
export interface Input {
|
|
883
909
|
/** Field name. */
|
|
@@ -901,7 +927,7 @@ export interface Input {
|
|
|
901
927
|
* Type which determines field format.
|
|
902
928
|
* Used to validate submitted response.
|
|
903
929
|
*/
|
|
904
|
-
type?:
|
|
930
|
+
type?: ValueTypeWithLiterals;
|
|
905
931
|
/**
|
|
906
932
|
* A maximum accepted values for array input.
|
|
907
933
|
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
@@ -925,6 +951,8 @@ export declare enum ValueType {
|
|
|
925
951
|
DATE_TIME = "DATE_TIME",
|
|
926
952
|
ADDRESS = "ADDRESS"
|
|
927
953
|
}
|
|
954
|
+
/** @enumType */
|
|
955
|
+
export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
928
956
|
/**
|
|
929
957
|
* Describes initially selected option when an input has multiple choices.
|
|
930
958
|
* Defaults to first (0th) option if not configured.
|
|
@@ -1113,7 +1141,7 @@ export interface OnlineConferencingConfig {
|
|
|
1113
1141
|
*/
|
|
1114
1142
|
providerId?: string | null;
|
|
1115
1143
|
/** Conference type */
|
|
1116
|
-
conferenceType?:
|
|
1144
|
+
conferenceType?: ConferenceTypeWithLiterals;
|
|
1117
1145
|
}
|
|
1118
1146
|
export declare enum ConferenceType {
|
|
1119
1147
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
@@ -1121,6 +1149,8 @@ export declare enum ConferenceType {
|
|
|
1121
1149
|
/** Guests can only subscribe to video and audio. */
|
|
1122
1150
|
WEBINAR = "WEBINAR"
|
|
1123
1151
|
}
|
|
1152
|
+
/** @enumType */
|
|
1153
|
+
export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1124
1154
|
export interface OnlineConferencingSession {
|
|
1125
1155
|
/**
|
|
1126
1156
|
* Link for event host to start the online conference session.
|
|
@@ -1265,7 +1295,7 @@ export interface Category {
|
|
|
1265
1295
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1266
1296
|
* @maxSize 3
|
|
1267
1297
|
*/
|
|
1268
|
-
states?:
|
|
1298
|
+
states?: StateWithLiterals[];
|
|
1269
1299
|
}
|
|
1270
1300
|
export interface CategoryCounts {
|
|
1271
1301
|
/** Total number of draft events assigned to the category. */
|
|
@@ -1283,6 +1313,8 @@ export declare enum State {
|
|
|
1283
1313
|
/** Category is hidden. */
|
|
1284
1314
|
HIDDEN = "HIDDEN"
|
|
1285
1315
|
}
|
|
1316
|
+
/** @enumType */
|
|
1317
|
+
export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1286
1318
|
export interface EventDisplaySettings {
|
|
1287
1319
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1288
1320
|
hideEventDetailsButton?: boolean | null;
|
|
@@ -1355,7 +1387,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1355
1387
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1356
1388
|
layoutCellData?: LayoutCellData;
|
|
1357
1389
|
/** 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. */
|
|
1358
|
-
type?:
|
|
1390
|
+
type?: NodeTypeWithLiterals;
|
|
1359
1391
|
/** Node ID. */
|
|
1360
1392
|
id?: string;
|
|
1361
1393
|
/** A list of child nodes. */
|
|
@@ -1456,6 +1488,8 @@ export declare enum NodeType {
|
|
|
1456
1488
|
LAYOUT = "LAYOUT",
|
|
1457
1489
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1458
1490
|
}
|
|
1491
|
+
/** @enumType */
|
|
1492
|
+
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';
|
|
1459
1493
|
export interface NodeStyle {
|
|
1460
1494
|
/** The top padding value in pixels. */
|
|
1461
1495
|
paddingTop?: string | null;
|
|
@@ -1468,7 +1502,7 @@ export interface ButtonData {
|
|
|
1468
1502
|
/** Styling for the button's container. */
|
|
1469
1503
|
containerData?: PluginContainerData;
|
|
1470
1504
|
/** The button type. */
|
|
1471
|
-
type?:
|
|
1505
|
+
type?: ButtonDataTypeWithLiterals;
|
|
1472
1506
|
/** Styling for the button. */
|
|
1473
1507
|
styles?: Styles;
|
|
1474
1508
|
/** The text to display on the button. */
|
|
@@ -1494,7 +1528,7 @@ export interface PluginContainerData {
|
|
|
1494
1528
|
/** The width of the node when it's displayed. */
|
|
1495
1529
|
width?: PluginContainerDataWidth;
|
|
1496
1530
|
/** The node's alignment within its container. */
|
|
1497
|
-
alignment?:
|
|
1531
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
1498
1532
|
/** Spoiler cover settings for the node. */
|
|
1499
1533
|
spoiler?: Spoiler;
|
|
1500
1534
|
/** The height of the node when it's displayed. */
|
|
@@ -1512,6 +1546,8 @@ export declare enum WidthType {
|
|
|
1512
1546
|
/** coast-to-coast display */
|
|
1513
1547
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1514
1548
|
}
|
|
1549
|
+
/** @enumType */
|
|
1550
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1515
1551
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1516
1552
|
/**
|
|
1517
1553
|
* One of the following predefined width options:
|
|
@@ -1520,7 +1556,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1520
1556
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1521
1557
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1522
1558
|
*/
|
|
1523
|
-
size?:
|
|
1559
|
+
size?: WidthTypeWithLiterals;
|
|
1524
1560
|
/** A custom width value in pixels. */
|
|
1525
1561
|
custom?: string | null;
|
|
1526
1562
|
}
|
|
@@ -1533,7 +1569,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1533
1569
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1534
1570
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1535
1571
|
*/
|
|
1536
|
-
size?:
|
|
1572
|
+
size?: WidthTypeWithLiterals;
|
|
1537
1573
|
/** A custom width value in pixels. */
|
|
1538
1574
|
custom?: string | null;
|
|
1539
1575
|
}
|
|
@@ -1545,6 +1581,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1545
1581
|
/** Right Alignment */
|
|
1546
1582
|
RIGHT = "RIGHT"
|
|
1547
1583
|
}
|
|
1584
|
+
/** @enumType */
|
|
1585
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1548
1586
|
export interface Spoiler {
|
|
1549
1587
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1550
1588
|
enabled?: boolean | null;
|
|
@@ -1563,6 +1601,8 @@ export declare enum ButtonDataType {
|
|
|
1563
1601
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1564
1602
|
ACTION = "ACTION"
|
|
1565
1603
|
}
|
|
1604
|
+
/** @enumType */
|
|
1605
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1566
1606
|
export interface Styles {
|
|
1567
1607
|
/** Border attributes. */
|
|
1568
1608
|
border?: Border;
|
|
@@ -1581,7 +1621,7 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
1581
1621
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
1582
1622
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
1583
1623
|
*/
|
|
1584
|
-
target?:
|
|
1624
|
+
target?: TargetWithLiterals;
|
|
1585
1625
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
1586
1626
|
rel?: Rel;
|
|
1587
1627
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -1604,6 +1644,8 @@ export declare enum Target {
|
|
|
1604
1644
|
/** Opens the linked document in the full body of the window */
|
|
1605
1645
|
TOP = "TOP"
|
|
1606
1646
|
}
|
|
1647
|
+
/** @enumType */
|
|
1648
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1607
1649
|
export interface Rel {
|
|
1608
1650
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1609
1651
|
nofollow?: boolean | null;
|
|
@@ -1620,7 +1662,7 @@ export interface CodeBlockData {
|
|
|
1620
1662
|
}
|
|
1621
1663
|
export interface TextStyle {
|
|
1622
1664
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1623
|
-
textAlignment?:
|
|
1665
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
1624
1666
|
/** 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. */
|
|
1625
1667
|
lineHeight?: string | null;
|
|
1626
1668
|
}
|
|
@@ -1636,15 +1678,17 @@ export declare enum TextAlignment {
|
|
|
1636
1678
|
/** 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 */
|
|
1637
1679
|
JUSTIFY = "JUSTIFY"
|
|
1638
1680
|
}
|
|
1681
|
+
/** @enumType */
|
|
1682
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1639
1683
|
export interface DividerData {
|
|
1640
1684
|
/** Styling for the divider's container. */
|
|
1641
1685
|
containerData?: PluginContainerData;
|
|
1642
1686
|
/** Divider line style. */
|
|
1643
|
-
lineStyle?:
|
|
1687
|
+
lineStyle?: LineStyleWithLiterals;
|
|
1644
1688
|
/** Divider width. */
|
|
1645
|
-
width?:
|
|
1689
|
+
width?: WidthWithLiterals;
|
|
1646
1690
|
/** Divider alignment. */
|
|
1647
|
-
alignment?:
|
|
1691
|
+
alignment?: AlignmentWithLiterals;
|
|
1648
1692
|
}
|
|
1649
1693
|
export declare enum LineStyle {
|
|
1650
1694
|
/** Single Line */
|
|
@@ -1656,6 +1700,8 @@ export declare enum LineStyle {
|
|
|
1656
1700
|
/** Dotted Line */
|
|
1657
1701
|
DOTTED = "DOTTED"
|
|
1658
1702
|
}
|
|
1703
|
+
/** @enumType */
|
|
1704
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1659
1705
|
export declare enum Width {
|
|
1660
1706
|
/** Large line */
|
|
1661
1707
|
LARGE = "LARGE",
|
|
@@ -1664,6 +1710,8 @@ export declare enum Width {
|
|
|
1664
1710
|
/** Small line */
|
|
1665
1711
|
SMALL = "SMALL"
|
|
1666
1712
|
}
|
|
1713
|
+
/** @enumType */
|
|
1714
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1667
1715
|
export declare enum Alignment {
|
|
1668
1716
|
/** Center alignment */
|
|
1669
1717
|
CENTER = "CENTER",
|
|
@@ -1672,6 +1720,8 @@ export declare enum Alignment {
|
|
|
1672
1720
|
/** Right alignment */
|
|
1673
1721
|
RIGHT = "RIGHT"
|
|
1674
1722
|
}
|
|
1723
|
+
/** @enumType */
|
|
1724
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1675
1725
|
export interface FileData {
|
|
1676
1726
|
/** Styling for the file's container. */
|
|
1677
1727
|
containerData?: PluginContainerData;
|
|
@@ -1703,6 +1753,8 @@ export declare enum ViewMode {
|
|
|
1703
1753
|
/** Mini PDF view */
|
|
1704
1754
|
MINI = "MINI"
|
|
1705
1755
|
}
|
|
1756
|
+
/** @enumType */
|
|
1757
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1706
1758
|
export interface FileSource extends FileSourceDataOneOf {
|
|
1707
1759
|
/** The absolute URL for the file's source. */
|
|
1708
1760
|
url?: string | null;
|
|
@@ -1735,7 +1787,7 @@ export interface PDFSettings {
|
|
|
1735
1787
|
* `FULL` : A full page view of the PDF is displayed.
|
|
1736
1788
|
* `MINI` : A mini view of the PDF is displayed.
|
|
1737
1789
|
*/
|
|
1738
|
-
viewMode?:
|
|
1790
|
+
viewMode?: ViewModeWithLiterals;
|
|
1739
1791
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1740
1792
|
disableDownload?: boolean | null;
|
|
1741
1793
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -1822,18 +1874,24 @@ export declare enum LayoutType {
|
|
|
1822
1874
|
/** Fullsize images type */
|
|
1823
1875
|
FULLSIZE = "FULLSIZE"
|
|
1824
1876
|
}
|
|
1877
|
+
/** @enumType */
|
|
1878
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1825
1879
|
export declare enum Orientation {
|
|
1826
1880
|
/** Rows Orientation */
|
|
1827
1881
|
ROWS = "ROWS",
|
|
1828
1882
|
/** Columns Orientation */
|
|
1829
1883
|
COLUMNS = "COLUMNS"
|
|
1830
1884
|
}
|
|
1885
|
+
/** @enumType */
|
|
1886
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1831
1887
|
export declare enum Crop {
|
|
1832
1888
|
/** Crop to fill */
|
|
1833
1889
|
FILL = "FILL",
|
|
1834
1890
|
/** Crop to fit */
|
|
1835
1891
|
FIT = "FIT"
|
|
1836
1892
|
}
|
|
1893
|
+
/** @enumType */
|
|
1894
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1837
1895
|
export declare enum ThumbnailsAlignment {
|
|
1838
1896
|
/** Top alignment */
|
|
1839
1897
|
TOP = "TOP",
|
|
@@ -1846,13 +1904,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
1846
1904
|
/** No thumbnail */
|
|
1847
1905
|
NONE = "NONE"
|
|
1848
1906
|
}
|
|
1907
|
+
/** @enumType */
|
|
1908
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1849
1909
|
export interface Layout {
|
|
1850
1910
|
/** Gallery layout type. */
|
|
1851
|
-
type?:
|
|
1911
|
+
type?: LayoutTypeWithLiterals;
|
|
1852
1912
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1853
1913
|
horizontalScroll?: boolean | null;
|
|
1854
1914
|
/** Gallery orientation. */
|
|
1855
|
-
orientation?:
|
|
1915
|
+
orientation?: OrientationWithLiterals;
|
|
1856
1916
|
/** The number of columns to display on full size screens. */
|
|
1857
1917
|
numberOfColumns?: number | null;
|
|
1858
1918
|
/** The number of columns to display on mobile screens. */
|
|
@@ -1864,13 +1924,13 @@ export interface ItemStyle {
|
|
|
1864
1924
|
/** Item ratio */
|
|
1865
1925
|
ratio?: number | null;
|
|
1866
1926
|
/** Sets how item images are cropped. */
|
|
1867
|
-
crop?:
|
|
1927
|
+
crop?: CropWithLiterals;
|
|
1868
1928
|
/** The spacing between items in pixels. */
|
|
1869
1929
|
spacing?: number | null;
|
|
1870
1930
|
}
|
|
1871
1931
|
export interface Thumbnails {
|
|
1872
1932
|
/** Thumbnail alignment. */
|
|
1873
|
-
placement?:
|
|
1933
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1874
1934
|
/** Spacing between thumbnails in pixels. */
|
|
1875
1935
|
spacing?: number | null;
|
|
1876
1936
|
}
|
|
@@ -1886,7 +1946,7 @@ export interface GIFData {
|
|
|
1886
1946
|
/** Width in pixels. */
|
|
1887
1947
|
width?: number;
|
|
1888
1948
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1889
|
-
gifType?:
|
|
1949
|
+
gifType?: GIFTypeWithLiterals;
|
|
1890
1950
|
}
|
|
1891
1951
|
export interface GIF {
|
|
1892
1952
|
/**
|
|
@@ -1909,6 +1969,8 @@ export declare enum GIFType {
|
|
|
1909
1969
|
NORMAL = "NORMAL",
|
|
1910
1970
|
STICKER = "STICKER"
|
|
1911
1971
|
}
|
|
1972
|
+
/** @enumType */
|
|
1973
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1912
1974
|
export interface HeadingData {
|
|
1913
1975
|
/** Heading level from 1-6. */
|
|
1914
1976
|
level?: number;
|
|
@@ -1930,7 +1992,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1930
1992
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1931
1993
|
containerData?: PluginContainerData;
|
|
1932
1994
|
/** The type of HTML code. */
|
|
1933
|
-
source?:
|
|
1995
|
+
source?: SourceWithLiterals;
|
|
1934
1996
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1935
1997
|
autoHeight?: boolean | null;
|
|
1936
1998
|
}
|
|
@@ -1950,6 +2012,8 @@ export declare enum Source {
|
|
|
1950
2012
|
HTML = "HTML",
|
|
1951
2013
|
ADSENSE = "ADSENSE"
|
|
1952
2014
|
}
|
|
2015
|
+
/** @enumType */
|
|
2016
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1953
2017
|
export interface ImageData {
|
|
1954
2018
|
/** Styling for the image's container. */
|
|
1955
2019
|
containerData?: PluginContainerData;
|
|
@@ -2014,6 +2078,8 @@ export declare enum Position {
|
|
|
2014
2078
|
/** Thumbnail hidden and not displayed */
|
|
2015
2079
|
HIDDEN = "HIDDEN"
|
|
2016
2080
|
}
|
|
2081
|
+
/** @enumType */
|
|
2082
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2017
2083
|
export interface LinkPreviewDataStyles {
|
|
2018
2084
|
/**
|
|
2019
2085
|
* Background color as a hexadecimal value.
|
|
@@ -2045,7 +2111,7 @@ export interface LinkPreviewDataStyles {
|
|
|
2045
2111
|
*/
|
|
2046
2112
|
borderColor?: string | null;
|
|
2047
2113
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2048
|
-
thumbnailPosition?:
|
|
2114
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
2049
2115
|
}
|
|
2050
2116
|
export interface MapData {
|
|
2051
2117
|
/** Styling for the map's container. */
|
|
@@ -2075,7 +2141,7 @@ export interface MapSettings {
|
|
|
2075
2141
|
/** Initial zoom value. */
|
|
2076
2142
|
initialZoom?: number | null;
|
|
2077
2143
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2078
|
-
mapType?:
|
|
2144
|
+
mapType?: MapTypeWithLiterals;
|
|
2079
2145
|
}
|
|
2080
2146
|
export declare enum MapType {
|
|
2081
2147
|
/** Roadmap map type */
|
|
@@ -2087,6 +2153,8 @@ export declare enum MapType {
|
|
|
2087
2153
|
/** Terrain map type */
|
|
2088
2154
|
TERRAIN = "TERRAIN"
|
|
2089
2155
|
}
|
|
2156
|
+
/** @enumType */
|
|
2157
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2090
2158
|
export interface ParagraphData {
|
|
2091
2159
|
/** Styling for the paragraph text. */
|
|
2092
2160
|
textStyle?: TextStyle;
|
|
@@ -2113,17 +2181,21 @@ export declare enum ViewRole {
|
|
|
2113
2181
|
/** Anyone can see the results, even if one didn't vote */
|
|
2114
2182
|
EVERYONE = "EVERYONE"
|
|
2115
2183
|
}
|
|
2184
|
+
/** @enumType */
|
|
2185
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2116
2186
|
export declare enum VoteRole {
|
|
2117
2187
|
/** Logged in member */
|
|
2118
2188
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2119
2189
|
/** Anyone */
|
|
2120
2190
|
ALL = "ALL"
|
|
2121
2191
|
}
|
|
2192
|
+
/** @enumType */
|
|
2193
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2122
2194
|
export interface Permissions {
|
|
2123
2195
|
/** Sets who can view the poll results. */
|
|
2124
|
-
view?:
|
|
2196
|
+
view?: ViewRoleWithLiterals;
|
|
2125
2197
|
/** Sets who can vote. */
|
|
2126
|
-
vote?:
|
|
2198
|
+
vote?: VoteRoleWithLiterals;
|
|
2127
2199
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2128
2200
|
allowMultipleVotes?: boolean | null;
|
|
2129
2201
|
}
|
|
@@ -2149,17 +2221,21 @@ export declare enum PollLayoutType {
|
|
|
2149
2221
|
/** Grid */
|
|
2150
2222
|
GRID = "GRID"
|
|
2151
2223
|
}
|
|
2224
|
+
/** @enumType */
|
|
2225
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2152
2226
|
export declare enum PollLayoutDirection {
|
|
2153
2227
|
/** Left-to-right */
|
|
2154
2228
|
LTR = "LTR",
|
|
2155
2229
|
/** Right-to-left */
|
|
2156
2230
|
RTL = "RTL"
|
|
2157
2231
|
}
|
|
2232
|
+
/** @enumType */
|
|
2233
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2158
2234
|
export interface PollLayout {
|
|
2159
2235
|
/** The layout for displaying the voting options. */
|
|
2160
|
-
type?:
|
|
2236
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2161
2237
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2162
|
-
direction?:
|
|
2238
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2163
2239
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2164
2240
|
enableImage?: boolean | null;
|
|
2165
2241
|
}
|
|
@@ -2175,6 +2251,8 @@ export declare enum BackgroundType {
|
|
|
2175
2251
|
/** Gradiant background type */
|
|
2176
2252
|
GRADIENT = "GRADIENT"
|
|
2177
2253
|
}
|
|
2254
|
+
/** @enumType */
|
|
2255
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2178
2256
|
export interface Gradient {
|
|
2179
2257
|
/** The gradient angle in degrees. */
|
|
2180
2258
|
angle?: number | null;
|
|
@@ -2200,7 +2278,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2200
2278
|
/** Details for a gradient background. */
|
|
2201
2279
|
gradient?: Gradient;
|
|
2202
2280
|
/** Background type. For each option, include the relevant details. */
|
|
2203
|
-
type?:
|
|
2281
|
+
type?: BackgroundTypeWithLiterals;
|
|
2204
2282
|
}
|
|
2205
2283
|
/** @oneof */
|
|
2206
2284
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -2277,7 +2355,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2277
2355
|
/** Data for a spoiler decoration. */
|
|
2278
2356
|
spoilerData?: SpoilerData;
|
|
2279
2357
|
/** The type of decoration to apply. */
|
|
2280
|
-
type?:
|
|
2358
|
+
type?: DecorationTypeWithLiterals;
|
|
2281
2359
|
}
|
|
2282
2360
|
/** @oneof */
|
|
2283
2361
|
export interface DecorationDataOneOf {
|
|
@@ -2312,6 +2390,8 @@ export declare enum DecorationType {
|
|
|
2312
2390
|
FONT_SIZE = "FONT_SIZE",
|
|
2313
2391
|
EXTERNAL = "EXTERNAL"
|
|
2314
2392
|
}
|
|
2393
|
+
/** @enumType */
|
|
2394
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
2315
2395
|
export interface AnchorData {
|
|
2316
2396
|
/** The target node's ID. */
|
|
2317
2397
|
anchor?: string;
|
|
@@ -2336,7 +2416,7 @@ export interface MentionData {
|
|
|
2336
2416
|
}
|
|
2337
2417
|
export interface FontSizeData {
|
|
2338
2418
|
/** The units used for the font size. */
|
|
2339
|
-
unit?:
|
|
2419
|
+
unit?: FontTypeWithLiterals;
|
|
2340
2420
|
/** Font size value. */
|
|
2341
2421
|
value?: number | null;
|
|
2342
2422
|
}
|
|
@@ -2344,6 +2424,8 @@ export declare enum FontType {
|
|
|
2344
2424
|
PX = "PX",
|
|
2345
2425
|
EM = "EM"
|
|
2346
2426
|
}
|
|
2427
|
+
/** @enumType */
|
|
2428
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2347
2429
|
export interface SpoilerData {
|
|
2348
2430
|
/** Spoiler ID. */
|
|
2349
2431
|
id?: string | null;
|
|
@@ -2354,7 +2436,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2354
2436
|
/** Data for embedded Wix Events content. */
|
|
2355
2437
|
eventData?: EventData;
|
|
2356
2438
|
/** The type of Wix App content being embedded. */
|
|
2357
|
-
type?:
|
|
2439
|
+
type?: AppTypeWithLiterals;
|
|
2358
2440
|
/** The ID of the embedded content. */
|
|
2359
2441
|
itemId?: string | null;
|
|
2360
2442
|
/** The name of the embedded content. */
|
|
@@ -2381,6 +2463,8 @@ export declare enum AppType {
|
|
|
2381
2463
|
EVENT = "EVENT",
|
|
2382
2464
|
BOOKING = "BOOKING"
|
|
2383
2465
|
}
|
|
2466
|
+
/** @enumType */
|
|
2467
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2384
2468
|
export interface BookingData {
|
|
2385
2469
|
/** Booking duration in minutes. */
|
|
2386
2470
|
durations?: string | null;
|
|
@@ -2459,9 +2543,9 @@ export interface CollapsibleListData {
|
|
|
2459
2543
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2460
2544
|
expandOnlyOne?: boolean | null;
|
|
2461
2545
|
/** Sets which items are expanded when the page loads. */
|
|
2462
|
-
initialExpandedItems?:
|
|
2546
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2463
2547
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2464
|
-
direction?:
|
|
2548
|
+
direction?: DirectionWithLiterals;
|
|
2465
2549
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2466
2550
|
isQapageData?: boolean | null;
|
|
2467
2551
|
}
|
|
@@ -2473,12 +2557,16 @@ export declare enum InitialExpandedItems {
|
|
|
2473
2557
|
/** All items collapsed initally */
|
|
2474
2558
|
NONE = "NONE"
|
|
2475
2559
|
}
|
|
2560
|
+
/** @enumType */
|
|
2561
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2476
2562
|
export declare enum Direction {
|
|
2477
2563
|
/** Left-to-right */
|
|
2478
2564
|
LTR = "LTR",
|
|
2479
2565
|
/** Right-to-left */
|
|
2480
2566
|
RTL = "RTL"
|
|
2481
2567
|
}
|
|
2568
|
+
/** @enumType */
|
|
2569
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2482
2570
|
export interface TableData {
|
|
2483
2571
|
/** Styling for the table's container. */
|
|
2484
2572
|
containerData?: PluginContainerData;
|
|
@@ -2516,9 +2604,11 @@ export declare enum VerticalAlignment {
|
|
|
2516
2604
|
/** Bottom alignment */
|
|
2517
2605
|
BOTTOM = "BOTTOM"
|
|
2518
2606
|
}
|
|
2607
|
+
/** @enumType */
|
|
2608
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2519
2609
|
export interface CellStyle {
|
|
2520
2610
|
/** Vertical alignment for the cell's text. */
|
|
2521
|
-
verticalAlignment?:
|
|
2611
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2522
2612
|
/**
|
|
2523
2613
|
* Cell background color as a hexadecimal value.
|
|
2524
2614
|
* @format COLOR_HEX
|
|
@@ -2557,6 +2647,8 @@ export declare enum NullValue {
|
|
|
2557
2647
|
/** Null value. */
|
|
2558
2648
|
NULL_VALUE = "NULL_VALUE"
|
|
2559
2649
|
}
|
|
2650
|
+
/** @enumType */
|
|
2651
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2560
2652
|
/**
|
|
2561
2653
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2562
2654
|
*
|
|
@@ -2654,7 +2746,7 @@ export interface TextNodeStyle {
|
|
|
2654
2746
|
}
|
|
2655
2747
|
export interface Badge {
|
|
2656
2748
|
/** Badge type. */
|
|
2657
|
-
type?:
|
|
2749
|
+
type?: TypeWithLiterals;
|
|
2658
2750
|
/**
|
|
2659
2751
|
* Badge text.
|
|
2660
2752
|
* @maxLength 50
|
|
@@ -2671,6 +2763,8 @@ export declare enum Type {
|
|
|
2671
2763
|
/** General badge type. */
|
|
2672
2764
|
GENERAL = "GENERAL"
|
|
2673
2765
|
}
|
|
2766
|
+
/** @enumType */
|
|
2767
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'URGENT' | 'INFO' | 'GENERAL';
|
|
2674
2768
|
export interface OrderConfirmed {
|
|
2675
2769
|
/** Order confirmation timestamp in ISO UTC. */
|
|
2676
2770
|
timestamp?: Date | null;
|
|
@@ -2714,7 +2808,7 @@ export interface OrderConfirmed {
|
|
|
2714
2808
|
/** Checkout form response. */
|
|
2715
2809
|
checkoutForm?: FormResponse;
|
|
2716
2810
|
/** Order status. */
|
|
2717
|
-
status?:
|
|
2811
|
+
status?: OrderStatusWithLiterals;
|
|
2718
2812
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
2719
2813
|
method?: string | null;
|
|
2720
2814
|
/** Tickets (generated after payment). */
|
|
@@ -2835,6 +2929,8 @@ export declare enum OrderStatus {
|
|
|
2835
2929
|
/** Order is partially paid with less than the total amount. */
|
|
2836
2930
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
2837
2931
|
}
|
|
2932
|
+
/** @enumType */
|
|
2933
|
+
export type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
2838
2934
|
export interface Ticket {
|
|
2839
2935
|
/** Unique issued ticket number. */
|
|
2840
2936
|
ticketNumber?: string;
|
|
@@ -3028,7 +3124,7 @@ export interface PercentDiscount {
|
|
|
3028
3124
|
}
|
|
3029
3125
|
export interface Tax {
|
|
3030
3126
|
/** Tax type. */
|
|
3031
|
-
type?:
|
|
3127
|
+
type?: TaxTypeWithLiterals;
|
|
3032
3128
|
/**
|
|
3033
3129
|
* Tax name.
|
|
3034
3130
|
* @readonly
|
|
@@ -3046,9 +3142,9 @@ export interface Tax {
|
|
|
3046
3142
|
}
|
|
3047
3143
|
export interface Fee {
|
|
3048
3144
|
/** Fee identifier. */
|
|
3049
|
-
name?:
|
|
3145
|
+
name?: FeeNameWithLiterals;
|
|
3050
3146
|
/** How fee is calculated. */
|
|
3051
|
-
type?:
|
|
3147
|
+
type?: FeeTypeWithLiterals;
|
|
3052
3148
|
/**
|
|
3053
3149
|
* Fee rate.
|
|
3054
3150
|
* @format DECIMAL_VALUE
|
|
@@ -3062,6 +3158,8 @@ export declare enum FeeName {
|
|
|
3062
3158
|
/** Wix ticket service fee charges applied to the line item. */
|
|
3063
3159
|
WIX_FEE = "WIX_FEE"
|
|
3064
3160
|
}
|
|
3161
|
+
/** @enumType */
|
|
3162
|
+
export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
3065
3163
|
export declare enum FeeType {
|
|
3066
3164
|
/** Fee is added to the ticket price at checkout. */
|
|
3067
3165
|
FEE_ADDED = "FEE_ADDED",
|
|
@@ -3070,6 +3168,8 @@ export declare enum FeeType {
|
|
|
3070
3168
|
/** Fee is added to the ticket price at checkout. */
|
|
3071
3169
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3072
3170
|
}
|
|
3171
|
+
/** @enumType */
|
|
3172
|
+
export type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
3073
3173
|
/** Produced if a buyer email was added to the existing order */
|
|
3074
3174
|
export interface OrderEmailAdded {
|
|
3075
3175
|
/** Order updated timestamp in ISO UTC format. */
|
|
@@ -3136,7 +3236,7 @@ export interface OrderEmailAdded {
|
|
|
3136
3236
|
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
3137
3237
|
confirmed?: boolean;
|
|
3138
3238
|
/** Order status. */
|
|
3139
|
-
status?:
|
|
3239
|
+
status?: OrderStatusWithLiterals;
|
|
3140
3240
|
/**
|
|
3141
3241
|
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3142
3242
|
* @maxLength 100
|
|
@@ -3272,7 +3372,7 @@ export interface OrderPaid {
|
|
|
3272
3372
|
/** Checkout form response. */
|
|
3273
3373
|
checkoutForm?: FormResponse;
|
|
3274
3374
|
/** Order status. */
|
|
3275
|
-
status?:
|
|
3375
|
+
status?: OrderStatusWithLiterals;
|
|
3276
3376
|
/**
|
|
3277
3377
|
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3278
3378
|
* @maxLength 255
|
|
@@ -3416,7 +3516,7 @@ export interface ResolveEmailNotificationConfigRequest {
|
|
|
3416
3516
|
*/
|
|
3417
3517
|
notificationConfigId?: string;
|
|
3418
3518
|
/** Notification type */
|
|
3419
|
-
notificationType?:
|
|
3519
|
+
notificationType?: EmailNotificationTypeWithLiterals;
|
|
3420
3520
|
}
|
|
3421
3521
|
export interface ResolveEmailNotificationConfigResponse {
|
|
3422
3522
|
/** The retrieved EmailNotificationConfig */
|
|
@@ -3458,7 +3558,7 @@ export interface EventCopied {
|
|
|
3458
3558
|
*/
|
|
3459
3559
|
userId?: string | null;
|
|
3460
3560
|
/** Event status. */
|
|
3461
|
-
status?:
|
|
3561
|
+
status?: EventStatusWithLiterals;
|
|
3462
3562
|
/**
|
|
3463
3563
|
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3464
3564
|
* @format GUID
|
|
@@ -3514,7 +3614,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3514
3614
|
*/
|
|
3515
3615
|
appId?: string;
|
|
3516
3616
|
/** @readonly */
|
|
3517
|
-
identityType?:
|
|
3617
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3518
3618
|
}
|
|
3519
3619
|
/** @oneof */
|
|
3520
3620
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3546,6 +3646,8 @@ export declare enum WebhookIdentityType {
|
|
|
3546
3646
|
WIX_USER = "WIX_USER",
|
|
3547
3647
|
APP = "APP"
|
|
3548
3648
|
}
|
|
3649
|
+
/** @enumType */
|
|
3650
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3549
3651
|
export interface BaseEventMetadata {
|
|
3550
3652
|
/**
|
|
3551
3653
|
* App instance ID.
|
|
@@ -3662,9 +3764,9 @@ type NotificationConfigNonNullablePaths = `rsvpConfirmation.notificationType` |
|
|
|
3662
3764
|
export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
|
|
3663
3765
|
export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3664
3766
|
/** Email notification type */
|
|
3665
|
-
emailNotificationType?:
|
|
3767
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3666
3768
|
/** Push notification type */
|
|
3667
|
-
pushNotificationType?:
|
|
3769
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
3668
3770
|
/** Rsvp guest info */
|
|
3669
3771
|
rsvpGuest?: RsvpGuest;
|
|
3670
3772
|
/** Order guest info */
|
|
@@ -3677,9 +3779,9 @@ export interface TriggerNotificationOptions extends TriggerNotificationOptionsNo
|
|
|
3677
3779
|
/** @oneof */
|
|
3678
3780
|
export interface TriggerNotificationOptionsNotificationOneOf {
|
|
3679
3781
|
/** Email notification type */
|
|
3680
|
-
emailNotificationType?:
|
|
3782
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3681
3783
|
/** Push notification type */
|
|
3682
|
-
pushNotificationType?:
|
|
3784
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
3683
3785
|
}
|
|
3684
3786
|
/** @oneof */
|
|
3685
3787
|
export interface TriggerNotificationOptionsGuestsOneOf {
|