@wix/auto_sdk_events_notifications 1.0.20 → 1.0.22
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/{internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.mts} +501 -544
- package/build/{cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.ts} +501 -544
- package/build/index.d.mts +39 -0
- package/build/index.d.ts +39 -0
- package/build/index.js +858 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +779 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.mts} +501 -544
- package/build/{es/src/events-notifications-v2-notification-config-notifications.universal.d.ts → internal/events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.ts} +501 -544
- package/build/internal/index.d.mts +39 -0
- package/build/internal/index.d.ts +39 -0
- package/build/internal/index.js +858 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +779 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +267 -0
- package/build/internal/meta.d.ts +267 -0
- package/build/internal/meta.js +258 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +229 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +267 -0
- package/build/meta.d.ts +267 -0
- package/build/meta.js +258 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +229 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.js +0 -69
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.js +0 -168
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.js +0 -87
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js +0 -101
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3669
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js +0 -570
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +0 -730
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.js +0 -14
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.js +0 -162
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.js +0 -58
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js +0 -43
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3669
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js +0 -566
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js +0 -700
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.context.js +0 -69
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.http.js +0 -168
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.meta.js +0 -87
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.js +0 -101
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3669
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js +0 -570
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +0 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +0 -730
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.context.js +0 -14
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.http.js +0 -162
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.meta.js +0 -58
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.js +0 -43
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3669
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js +0 -566
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js.map +0 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js +0 -700
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface NotificationConfig {
|
|
1
|
+
interface NotificationConfig {
|
|
3
2
|
/**
|
|
4
3
|
* Event ID.
|
|
5
4
|
* @format GUID
|
|
@@ -38,7 +37,7 @@ export interface NotificationConfig {
|
|
|
38
37
|
/** Order confirmation with tickets link. */
|
|
39
38
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
40
39
|
}
|
|
41
|
-
|
|
40
|
+
interface EmailNotificationConfig {
|
|
42
41
|
/**
|
|
43
42
|
* Predefined id of the notification type.
|
|
44
43
|
* @readonly
|
|
@@ -54,7 +53,7 @@ export interface EmailNotificationConfig {
|
|
|
54
53
|
/** When true the notification will be sent when certain trigger occurs. */
|
|
55
54
|
sendingEnabled?: boolean | null;
|
|
56
55
|
}
|
|
57
|
-
|
|
56
|
+
declare enum EmailNotificationType {
|
|
58
57
|
/** Default value. This value is unused. */
|
|
59
58
|
UNKNOWN_NOTIFICATION_TYPE = "UNKNOWN_NOTIFICATION_TYPE",
|
|
60
59
|
/** Triggered when site user RSVP to the event. */
|
|
@@ -73,8 +72,8 @@ export declare enum EmailNotificationType {
|
|
|
73
72
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
74
73
|
}
|
|
75
74
|
/** @enumType */
|
|
76
|
-
|
|
77
|
-
|
|
75
|
+
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';
|
|
76
|
+
interface EmailTemplate {
|
|
78
77
|
/**
|
|
79
78
|
* Email subject.
|
|
80
79
|
* @minLength 1
|
|
@@ -96,7 +95,7 @@ export interface EmailTemplate {
|
|
|
96
95
|
/** When true the tickets are attached to the order confirmation email. */
|
|
97
96
|
includeTickets?: boolean | null;
|
|
98
97
|
}
|
|
99
|
-
|
|
98
|
+
interface Link {
|
|
100
99
|
/** When true the link is added to the email. */
|
|
101
100
|
display?: boolean | null;
|
|
102
101
|
/**
|
|
@@ -105,7 +104,7 @@ export interface Link {
|
|
|
105
104
|
*/
|
|
106
105
|
linkText?: string | null;
|
|
107
106
|
}
|
|
108
|
-
|
|
107
|
+
declare enum EmailNotificationReminderTime {
|
|
109
108
|
/** Default value. This value is unused. */
|
|
110
109
|
UNKNOWN_REMINDER_TIME = "UNKNOWN_REMINDER_TIME",
|
|
111
110
|
/** Notification is sent instantly */
|
|
@@ -122,8 +121,8 @@ export declare enum EmailNotificationReminderTime {
|
|
|
122
121
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
123
122
|
}
|
|
124
123
|
/** @enumType */
|
|
125
|
-
|
|
126
|
-
|
|
124
|
+
type EmailNotificationReminderTimeWithLiterals = EmailNotificationReminderTime | 'UNKNOWN_REMINDER_TIME' | 'INSTANT' | 'BEFORE_1_DAY' | 'BEFORE_3_DAYS' | 'BEFORE_1_WEEK' | 'BEFORE_1_HOUR' | 'BEFORE_30_MINUTES';
|
|
125
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
127
126
|
/** Email notification type */
|
|
128
127
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
129
128
|
/** Push notification type */
|
|
@@ -138,14 +137,14 @@ export interface TriggerNotificationRequest extends TriggerNotificationRequestNo
|
|
|
138
137
|
ticketGuest?: TicketGuest;
|
|
139
138
|
}
|
|
140
139
|
/** @oneof */
|
|
141
|
-
|
|
140
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
142
141
|
/** Email notification type */
|
|
143
142
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
144
143
|
/** Push notification type */
|
|
145
144
|
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
146
145
|
}
|
|
147
146
|
/** @oneof */
|
|
148
|
-
|
|
147
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
149
148
|
/** Rsvp guest info */
|
|
150
149
|
rsvpGuest?: RsvpGuest;
|
|
151
150
|
/** Order guest info */
|
|
@@ -155,7 +154,7 @@ export interface TriggerNotificationRequestGuestsOneOf {
|
|
|
155
154
|
/** Ticket guests info */
|
|
156
155
|
ticketGuest?: TicketGuest;
|
|
157
156
|
}
|
|
158
|
-
|
|
157
|
+
declare enum PushNotificationType {
|
|
159
158
|
/** This is default value. This value is unused. */
|
|
160
159
|
UNKNOWN_PUSH_TYPE = "UNKNOWN_PUSH_TYPE",
|
|
161
160
|
/** Triggered when event is updated. */
|
|
@@ -168,9 +167,9 @@ export declare enum PushNotificationType {
|
|
|
168
167
|
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
169
168
|
}
|
|
170
169
|
/** @enumType */
|
|
171
|
-
|
|
170
|
+
type PushNotificationTypeWithLiterals = PushNotificationType | 'UNKNOWN_PUSH_TYPE' | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
172
171
|
/** Single guest associated to the RSVP */
|
|
173
|
-
|
|
172
|
+
interface RsvpGuest {
|
|
174
173
|
/**
|
|
175
174
|
* Event id
|
|
176
175
|
* @format GUID
|
|
@@ -183,7 +182,7 @@ export interface RsvpGuest {
|
|
|
183
182
|
rsvpId?: string;
|
|
184
183
|
}
|
|
185
184
|
/** Single guest associated to the Order */
|
|
186
|
-
|
|
185
|
+
interface OrderGuest {
|
|
187
186
|
/**
|
|
188
187
|
* Event id
|
|
189
188
|
* @format GUID
|
|
@@ -196,7 +195,7 @@ export interface OrderGuest {
|
|
|
196
195
|
orderNumber?: string;
|
|
197
196
|
}
|
|
198
197
|
/** All event guest from RSVPs and Orders */
|
|
199
|
-
|
|
198
|
+
interface EventGuests {
|
|
200
199
|
/**
|
|
201
200
|
* Event id
|
|
202
201
|
* @format GUID
|
|
@@ -204,7 +203,7 @@ export interface EventGuests {
|
|
|
204
203
|
eventId?: string;
|
|
205
204
|
}
|
|
206
205
|
/** Multiple guests associated to Tickets */
|
|
207
|
-
|
|
206
|
+
interface TicketGuest {
|
|
208
207
|
/**
|
|
209
208
|
* Event id
|
|
210
209
|
* @format GUID
|
|
@@ -223,32 +222,28 @@ export interface TicketGuest {
|
|
|
223
222
|
*/
|
|
224
223
|
ticketNumber?: string[];
|
|
225
224
|
}
|
|
226
|
-
|
|
225
|
+
interface TriggerNotificationResponse {
|
|
227
226
|
}
|
|
228
|
-
|
|
227
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
229
228
|
createdEvent?: EntityCreatedEvent;
|
|
230
229
|
updatedEvent?: EntityUpdatedEvent;
|
|
231
230
|
deletedEvent?: EntityDeletedEvent;
|
|
232
231
|
actionEvent?: ActionEvent;
|
|
233
|
-
/**
|
|
234
|
-
* Unique event ID.
|
|
235
|
-
* Allows clients to ignore duplicate webhooks.
|
|
236
|
-
*/
|
|
232
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
237
233
|
_id?: string;
|
|
238
234
|
/**
|
|
239
|
-
*
|
|
240
|
-
*
|
|
235
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
236
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
241
237
|
*/
|
|
242
238
|
entityFqdn?: string;
|
|
243
239
|
/**
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
240
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
241
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
247
242
|
*/
|
|
248
243
|
slug?: string;
|
|
249
244
|
/** ID of the entity associated with the event. */
|
|
250
245
|
entityId?: string;
|
|
251
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
246
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
252
247
|
eventTime?: Date | null;
|
|
253
248
|
/**
|
|
254
249
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -258,29 +253,25 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
258
253
|
/** If present, indicates the action that triggered the event. */
|
|
259
254
|
originatedFrom?: string | null;
|
|
260
255
|
/**
|
|
261
|
-
* A sequence number
|
|
262
|
-
*
|
|
263
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
264
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
265
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
266
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
256
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
257
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
267
258
|
*/
|
|
268
259
|
entityEventSequence?: string | null;
|
|
269
260
|
}
|
|
270
261
|
/** @oneof */
|
|
271
|
-
|
|
262
|
+
interface DomainEventBodyOneOf {
|
|
272
263
|
createdEvent?: EntityCreatedEvent;
|
|
273
264
|
updatedEvent?: EntityUpdatedEvent;
|
|
274
265
|
deletedEvent?: EntityDeletedEvent;
|
|
275
266
|
actionEvent?: ActionEvent;
|
|
276
267
|
}
|
|
277
|
-
|
|
268
|
+
interface EntityCreatedEvent {
|
|
278
269
|
entity?: string;
|
|
279
270
|
}
|
|
280
|
-
|
|
271
|
+
interface RestoreInfo {
|
|
281
272
|
deletedDate?: Date | null;
|
|
282
273
|
}
|
|
283
|
-
|
|
274
|
+
interface EntityUpdatedEvent {
|
|
284
275
|
/**
|
|
285
276
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
286
277
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -288,16 +279,16 @@ export interface EntityUpdatedEvent {
|
|
|
288
279
|
*/
|
|
289
280
|
currentEntity?: string;
|
|
290
281
|
}
|
|
291
|
-
|
|
292
|
-
/** Entity that was deleted */
|
|
282
|
+
interface EntityDeletedEvent {
|
|
283
|
+
/** Entity that was deleted. */
|
|
293
284
|
deletedEntity?: string | null;
|
|
294
285
|
}
|
|
295
|
-
|
|
286
|
+
interface ActionEvent {
|
|
296
287
|
body?: string;
|
|
297
288
|
}
|
|
298
|
-
|
|
289
|
+
interface Empty {
|
|
299
290
|
}
|
|
300
|
-
|
|
291
|
+
interface EventUpdated {
|
|
301
292
|
/** Event update timestamp in ISO UTC format. */
|
|
302
293
|
timestamp?: Date | null;
|
|
303
294
|
/**
|
|
@@ -319,7 +310,7 @@ export interface EventUpdated {
|
|
|
319
310
|
/** Updated event */
|
|
320
311
|
event?: Event;
|
|
321
312
|
}
|
|
322
|
-
|
|
313
|
+
interface Location {
|
|
323
314
|
/**
|
|
324
315
|
* Location name.
|
|
325
316
|
* @maxLength 50
|
|
@@ -351,7 +342,7 @@ export interface Location {
|
|
|
351
342
|
*/
|
|
352
343
|
tbd?: boolean | null;
|
|
353
344
|
}
|
|
354
|
-
|
|
345
|
+
interface MapCoordinates {
|
|
355
346
|
/**
|
|
356
347
|
* Latitude.
|
|
357
348
|
* @min -90
|
|
@@ -365,14 +356,14 @@ export interface MapCoordinates {
|
|
|
365
356
|
*/
|
|
366
357
|
lng?: number;
|
|
367
358
|
}
|
|
368
|
-
|
|
359
|
+
declare enum LocationType {
|
|
369
360
|
VENUE = "VENUE",
|
|
370
361
|
ONLINE = "ONLINE"
|
|
371
362
|
}
|
|
372
363
|
/** @enumType */
|
|
373
|
-
|
|
364
|
+
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
374
365
|
/** Physical address */
|
|
375
|
-
|
|
366
|
+
interface Address extends AddressStreetOneOf {
|
|
376
367
|
/** a break down of the street to number and street name */
|
|
377
368
|
streetAddress?: StreetAddress;
|
|
378
369
|
/** Main address line (usually street and number) as free text */
|
|
@@ -403,19 +394,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
403
394
|
subdivisions?: Subdivision[];
|
|
404
395
|
}
|
|
405
396
|
/** @oneof */
|
|
406
|
-
|
|
397
|
+
interface AddressStreetOneOf {
|
|
407
398
|
/** a break down of the street to number and street name */
|
|
408
399
|
streetAddress?: StreetAddress;
|
|
409
400
|
/** Main address line (usually street and number) as free text */
|
|
410
401
|
addressLine?: string | null;
|
|
411
402
|
}
|
|
412
|
-
|
|
403
|
+
interface StreetAddress {
|
|
413
404
|
/** street number */
|
|
414
405
|
number?: string;
|
|
415
406
|
/** street name */
|
|
416
407
|
name?: string;
|
|
417
408
|
}
|
|
418
|
-
|
|
409
|
+
interface AddressLocation {
|
|
419
410
|
/**
|
|
420
411
|
* address latitude coordinates
|
|
421
412
|
* @min -90
|
|
@@ -429,13 +420,13 @@ export interface AddressLocation {
|
|
|
429
420
|
*/
|
|
430
421
|
longitude?: number | null;
|
|
431
422
|
}
|
|
432
|
-
|
|
423
|
+
interface Subdivision {
|
|
433
424
|
/** subdivision short code */
|
|
434
425
|
code?: string;
|
|
435
426
|
/** subdivision full-name */
|
|
436
427
|
name?: string;
|
|
437
428
|
}
|
|
438
|
-
|
|
429
|
+
declare enum SubdivisionType {
|
|
439
430
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
440
431
|
/** State */
|
|
441
432
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -450,9 +441,7 @@ export declare enum SubdivisionType {
|
|
|
450
441
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
451
442
|
COUNTRY = "COUNTRY"
|
|
452
443
|
}
|
|
453
|
-
|
|
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';
|
|
455
|
-
export interface ScheduleConfig {
|
|
444
|
+
interface ScheduleConfig {
|
|
456
445
|
/**
|
|
457
446
|
* Defines event as TBD (To Be Determined) schedule.
|
|
458
447
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -480,7 +469,7 @@ export interface ScheduleConfig {
|
|
|
480
469
|
/** Event recurrences. */
|
|
481
470
|
recurrences?: Recurrences;
|
|
482
471
|
}
|
|
483
|
-
|
|
472
|
+
interface Recurrences {
|
|
484
473
|
/**
|
|
485
474
|
* Event occurrences.
|
|
486
475
|
* @maxSize 1000
|
|
@@ -497,7 +486,7 @@ export interface Recurrences {
|
|
|
497
486
|
*/
|
|
498
487
|
status?: StatusWithLiterals;
|
|
499
488
|
}
|
|
500
|
-
|
|
489
|
+
interface Occurrence {
|
|
501
490
|
/** Event start timestamp. */
|
|
502
491
|
startDate?: Date | null;
|
|
503
492
|
/** Event end timestamp. */
|
|
@@ -510,7 +499,7 @@ export interface Occurrence {
|
|
|
510
499
|
/** Whether time zone is displayed in formatted schedule. */
|
|
511
500
|
showTimeZone?: boolean;
|
|
512
501
|
}
|
|
513
|
-
|
|
502
|
+
declare enum Status {
|
|
514
503
|
/** Event occurs only once. */
|
|
515
504
|
ONE_TIME = "ONE_TIME",
|
|
516
505
|
/** Event is recurring. */
|
|
@@ -523,8 +512,8 @@ export declare enum Status {
|
|
|
523
512
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
524
513
|
}
|
|
525
514
|
/** @enumType */
|
|
526
|
-
|
|
527
|
-
|
|
515
|
+
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
516
|
+
interface Event {
|
|
528
517
|
/**
|
|
529
518
|
* Event ID.
|
|
530
519
|
* @format GUID
|
|
@@ -539,7 +528,7 @@ export interface Event {
|
|
|
539
528
|
title?: string;
|
|
540
529
|
/** Event description. */
|
|
541
530
|
description?: string;
|
|
542
|
-
/** Rich-text content displayed in
|
|
531
|
+
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
543
532
|
about?: string;
|
|
544
533
|
/** Main event image. */
|
|
545
534
|
mainImage?: string;
|
|
@@ -586,7 +575,7 @@ export interface Event {
|
|
|
586
575
|
categories?: Category[];
|
|
587
576
|
/** Visual settings for event. */
|
|
588
577
|
eventDisplaySettings?: EventDisplaySettings;
|
|
589
|
-
/** Rich content displayed in
|
|
578
|
+
/** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
|
|
590
579
|
longDescription?: RichContent;
|
|
591
580
|
/**
|
|
592
581
|
* Event publish timestamp.
|
|
@@ -594,7 +583,7 @@ export interface Event {
|
|
|
594
583
|
*/
|
|
595
584
|
publishedDate?: Date | null;
|
|
596
585
|
}
|
|
597
|
-
|
|
586
|
+
interface Scheduling {
|
|
598
587
|
/** Schedule configuration. */
|
|
599
588
|
config?: ScheduleConfig;
|
|
600
589
|
/** Formatted schedule representation. */
|
|
@@ -608,7 +597,7 @@ export interface Scheduling {
|
|
|
608
597
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
609
598
|
endTimeFormatted?: string;
|
|
610
599
|
}
|
|
611
|
-
|
|
600
|
+
declare enum EventStatus {
|
|
612
601
|
/** Event is public and scheduled to start */
|
|
613
602
|
SCHEDULED = "SCHEDULED",
|
|
614
603
|
/** Event has started */
|
|
@@ -619,8 +608,8 @@ export declare enum EventStatus {
|
|
|
619
608
|
CANCELED = "CANCELED"
|
|
620
609
|
}
|
|
621
610
|
/** @enumType */
|
|
622
|
-
|
|
623
|
-
|
|
611
|
+
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
612
|
+
interface Registration {
|
|
624
613
|
/** Event type. */
|
|
625
614
|
type?: EventTypeWithLiterals;
|
|
626
615
|
/** Event registration status. */
|
|
@@ -636,7 +625,7 @@ export interface Registration {
|
|
|
636
625
|
/** Initial event type which was set when creating an event. */
|
|
637
626
|
initialType?: EventTypeWithLiterals;
|
|
638
627
|
}
|
|
639
|
-
|
|
628
|
+
declare enum EventType {
|
|
640
629
|
/** Type not available for this request fieldset */
|
|
641
630
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
642
631
|
/** Registration via RSVP */
|
|
@@ -649,8 +638,8 @@ export declare enum EventType {
|
|
|
649
638
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
650
639
|
}
|
|
651
640
|
/** @enumType */
|
|
652
|
-
|
|
653
|
-
|
|
641
|
+
type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
642
|
+
declare enum RegistrationStatus {
|
|
654
643
|
/** Registration status is not applicable */
|
|
655
644
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
656
645
|
/** Registration to event is closed */
|
|
@@ -669,12 +658,12 @@ export declare enum RegistrationStatus {
|
|
|
669
658
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
670
659
|
}
|
|
671
660
|
/** @enumType */
|
|
672
|
-
|
|
673
|
-
|
|
661
|
+
type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
662
|
+
interface RsvpCollection {
|
|
674
663
|
/** RSVP collection configuration. */
|
|
675
664
|
config?: RsvpCollectionConfig;
|
|
676
665
|
}
|
|
677
|
-
|
|
666
|
+
interface RsvpCollectionConfig {
|
|
678
667
|
/** Defines the supported RSVP statuses. */
|
|
679
668
|
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
680
669
|
/**
|
|
@@ -689,15 +678,15 @@ export interface RsvpCollectionConfig {
|
|
|
689
678
|
/** Registration end timestamp. */
|
|
690
679
|
endDate?: Date | null;
|
|
691
680
|
}
|
|
692
|
-
|
|
681
|
+
declare enum RsvpStatusOptions {
|
|
693
682
|
/** Only YES RSVP status is available for RSVP registration */
|
|
694
683
|
YES_ONLY = "YES_ONLY",
|
|
695
684
|
/** YES and NO RSVP status options are available for the registration */
|
|
696
685
|
YES_AND_NO = "YES_AND_NO"
|
|
697
686
|
}
|
|
698
687
|
/** @enumType */
|
|
699
|
-
|
|
700
|
-
|
|
688
|
+
type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
689
|
+
interface Ticketing {
|
|
701
690
|
/**
|
|
702
691
|
* Deprecated.
|
|
703
692
|
* @deprecated
|
|
@@ -738,7 +727,7 @@ export interface Ticketing {
|
|
|
738
727
|
*/
|
|
739
728
|
soldOut?: boolean | null;
|
|
740
729
|
}
|
|
741
|
-
|
|
730
|
+
interface TicketingConfig {
|
|
742
731
|
/** Whether the form must be filled out separately for each ticket. */
|
|
743
732
|
guestAssignedTickets?: boolean;
|
|
744
733
|
/** Tax configuration. */
|
|
@@ -755,7 +744,7 @@ export interface TicketingConfig {
|
|
|
755
744
|
*/
|
|
756
745
|
reservationDurationInMinutes?: number | null;
|
|
757
746
|
}
|
|
758
|
-
|
|
747
|
+
interface TaxConfig {
|
|
759
748
|
/** Tax application settings. */
|
|
760
749
|
type?: TaxTypeWithLiterals;
|
|
761
750
|
/**
|
|
@@ -772,7 +761,7 @@ export interface TaxConfig {
|
|
|
772
761
|
/** Applies taxes for donations, default true. */
|
|
773
762
|
appliesToDonations?: boolean | null;
|
|
774
763
|
}
|
|
775
|
-
|
|
764
|
+
declare enum TaxType {
|
|
776
765
|
/** Tax is included in the ticket price. */
|
|
777
766
|
INCLUDED = "INCLUDED",
|
|
778
767
|
/** Tax is added to the order at the checkout. */
|
|
@@ -781,8 +770,8 @@ export declare enum TaxType {
|
|
|
781
770
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
782
771
|
}
|
|
783
772
|
/** @enumType */
|
|
784
|
-
|
|
785
|
-
|
|
773
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
774
|
+
interface Money {
|
|
786
775
|
/**
|
|
787
776
|
* *Deprecated:** Use `value` instead.
|
|
788
777
|
* @format DECIMAL_VALUE
|
|
@@ -790,7 +779,7 @@ export interface Money {
|
|
|
790
779
|
*/
|
|
791
780
|
amount?: string;
|
|
792
781
|
/**
|
|
793
|
-
*
|
|
782
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
794
783
|
* @format CURRENCY
|
|
795
784
|
*/
|
|
796
785
|
currency?: string;
|
|
@@ -800,11 +789,11 @@ export interface Money {
|
|
|
800
789
|
*/
|
|
801
790
|
value?: string | null;
|
|
802
791
|
}
|
|
803
|
-
|
|
792
|
+
interface ExternalEvent {
|
|
804
793
|
/** External event registration URL. */
|
|
805
794
|
registration?: string;
|
|
806
795
|
}
|
|
807
|
-
|
|
796
|
+
declare enum VisitorType {
|
|
808
797
|
/** Site visitor (including member) */
|
|
809
798
|
VISITOR = "VISITOR",
|
|
810
799
|
/** Site member */
|
|
@@ -813,15 +802,15 @@ export declare enum VisitorType {
|
|
|
813
802
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
814
803
|
}
|
|
815
804
|
/** @enumType */
|
|
816
|
-
|
|
817
|
-
|
|
805
|
+
type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
806
|
+
interface CalendarLinks {
|
|
818
807
|
/** "Add to Google calendar" URL. */
|
|
819
808
|
google?: string;
|
|
820
809
|
/** "Download ICS calendar file" URL. */
|
|
821
810
|
ics?: string;
|
|
822
811
|
}
|
|
823
812
|
/** Site URL components */
|
|
824
|
-
|
|
813
|
+
interface SiteUrl {
|
|
825
814
|
/**
|
|
826
815
|
* Base URL. For premium sites, this will be the domain.
|
|
827
816
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -831,7 +820,7 @@ export interface SiteUrl {
|
|
|
831
820
|
path?: string;
|
|
832
821
|
}
|
|
833
822
|
/**
|
|
834
|
-
* The form defines which elements are
|
|
823
|
+
* The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
|
|
835
824
|
* It also contains customizable messages and labels.
|
|
836
825
|
*
|
|
837
826
|
*
|
|
@@ -843,30 +832,33 @@ export interface SiteUrl {
|
|
|
843
832
|
*
|
|
844
833
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
845
834
|
*/
|
|
846
|
-
|
|
835
|
+
interface Form {
|
|
847
836
|
/** Nested fields as an ordered list. */
|
|
848
837
|
controls?: InputControl[];
|
|
849
|
-
/**
|
|
838
|
+
/**
|
|
839
|
+
* Set of defined form messages displayed in the UI before, during, and after a registration flow.
|
|
840
|
+
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
841
|
+
*/
|
|
850
842
|
messages?: FormMessages;
|
|
851
843
|
}
|
|
852
844
|
/**
|
|
853
845
|
* A block of nested fields.
|
|
854
846
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
855
847
|
*/
|
|
856
|
-
|
|
848
|
+
interface InputControl {
|
|
857
849
|
/** Field control type. */
|
|
858
850
|
type?: InputControlTypeWithLiterals;
|
|
859
|
-
/** Whether control is mandatory (such as name & email). When true
|
|
851
|
+
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
860
852
|
system?: boolean;
|
|
861
853
|
/**
|
|
862
|
-
* Deprecated: Use `id`.
|
|
854
|
+
* Deprecated: Use `id` or `_id`.
|
|
863
855
|
* @deprecated
|
|
864
856
|
*/
|
|
865
857
|
name?: string;
|
|
866
858
|
/** Child inputs. */
|
|
867
859
|
inputs?: Input[];
|
|
868
860
|
/**
|
|
869
|
-
* Deprecated
|
|
861
|
+
* *Deprecated:** Use `controls.inputs.label`.
|
|
870
862
|
* @deprecated
|
|
871
863
|
*/
|
|
872
864
|
label?: string;
|
|
@@ -875,45 +867,45 @@ export interface InputControl {
|
|
|
875
867
|
/** Unique control ID. */
|
|
876
868
|
_id?: string;
|
|
877
869
|
/**
|
|
878
|
-
* Whether input control is deleted.
|
|
870
|
+
* Whether the input control is deleted.
|
|
879
871
|
* @readonly
|
|
880
872
|
*/
|
|
881
873
|
deleted?: boolean | null;
|
|
882
874
|
}
|
|
883
|
-
|
|
875
|
+
declare enum InputControlType {
|
|
884
876
|
/** Single text value field. */
|
|
885
877
|
INPUT = "INPUT",
|
|
886
|
-
/** Single text value field. */
|
|
878
|
+
/** Single text value field with multiple lines. */
|
|
887
879
|
TEXTAREA = "TEXTAREA",
|
|
888
|
-
/** Single-choice field
|
|
880
|
+
/** Single-choice field with predefined values. */
|
|
889
881
|
DROPDOWN = "DROPDOWN",
|
|
890
|
-
/** Single-choice field
|
|
882
|
+
/** Single-choice field with predefined values. */
|
|
891
883
|
RADIO = "RADIO",
|
|
892
|
-
/** Multiple-choice field
|
|
884
|
+
/** Multiple-choice field with predefined values. */
|
|
893
885
|
CHECKBOX = "CHECKBOX",
|
|
894
|
-
/**
|
|
886
|
+
/** Fields for entering first and last names. */
|
|
895
887
|
NAME = "NAME",
|
|
896
|
-
/**
|
|
888
|
+
/** Fields for additional guests and their respective names. */
|
|
897
889
|
GUEST_CONTROL = "GUEST_CONTROL",
|
|
898
890
|
/** Single-line address field. */
|
|
899
891
|
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
900
|
-
/** Full address field. */
|
|
892
|
+
/** Full address field with multiple lines. */
|
|
901
893
|
ADDRESS_FULL = "ADDRESS_FULL",
|
|
902
|
-
/**
|
|
894
|
+
/** Fields for entering year, month, and day. */
|
|
903
895
|
DATE = "DATE"
|
|
904
896
|
}
|
|
905
897
|
/** @enumType */
|
|
906
|
-
|
|
907
|
-
/**
|
|
908
|
-
|
|
898
|
+
type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
899
|
+
/** Child inputs. */
|
|
900
|
+
interface Input {
|
|
909
901
|
/** Field name. */
|
|
910
902
|
name?: string;
|
|
911
903
|
/**
|
|
912
|
-
* Deprecated
|
|
904
|
+
* *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
|
|
913
905
|
* @deprecated
|
|
914
906
|
*/
|
|
915
907
|
array?: boolean;
|
|
916
|
-
/** Main field label */
|
|
908
|
+
/** Main field label. */
|
|
917
909
|
label?: string;
|
|
918
910
|
/** Additional labels for multi-valued fields such as address. */
|
|
919
911
|
additionalLabels?: Record<string, string>;
|
|
@@ -929,22 +921,25 @@ export interface Input {
|
|
|
929
921
|
*/
|
|
930
922
|
type?: ValueTypeWithLiterals;
|
|
931
923
|
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
924
|
+
* The maximum number of accepted values for array input.
|
|
925
|
+
*
|
|
926
|
+
* **Note:** Only applicable for `TEXT_ARRAY` input fields.
|
|
934
927
|
*/
|
|
935
928
|
maxSize?: number | null;
|
|
936
929
|
/**
|
|
937
|
-
*
|
|
938
|
-
*
|
|
930
|
+
* Default option initially selected when an input has multiple choices.
|
|
931
|
+
*
|
|
932
|
+
* Defaults to first (0th) option, if not configured.
|
|
933
|
+
* Currently only applicable for `type.dropdown`.
|
|
939
934
|
*/
|
|
940
935
|
defaultOptionSelection?: OptionSelection;
|
|
941
936
|
/**
|
|
942
|
-
* Additional labels for multi-valued fields such as address.
|
|
937
|
+
* Additional labels for multi-valued fields, such as address.
|
|
943
938
|
* @readonly
|
|
944
939
|
*/
|
|
945
940
|
labels?: Label[];
|
|
946
941
|
}
|
|
947
|
-
|
|
942
|
+
declare enum ValueType {
|
|
948
943
|
TEXT = "TEXT",
|
|
949
944
|
NUMBER = "NUMBER",
|
|
950
945
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -952,39 +947,39 @@ export declare enum ValueType {
|
|
|
952
947
|
ADDRESS = "ADDRESS"
|
|
953
948
|
}
|
|
954
949
|
/** @enumType */
|
|
955
|
-
|
|
950
|
+
type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
956
951
|
/**
|
|
957
952
|
* Describes initially selected option when an input has multiple choices.
|
|
958
953
|
* Defaults to first (0th) option if not configured.
|
|
959
954
|
*/
|
|
960
|
-
|
|
955
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
961
956
|
/**
|
|
962
|
-
* 0-based index from predefined `
|
|
957
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
963
958
|
* @max 199
|
|
964
959
|
*/
|
|
965
960
|
optionIndex?: number;
|
|
966
961
|
/**
|
|
967
|
-
* Placeholder hint describing expected choices
|
|
962
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
968
963
|
* Considered an empty choice.
|
|
969
964
|
* @maxLength 200
|
|
970
965
|
*/
|
|
971
966
|
placeholderText?: string;
|
|
972
967
|
}
|
|
973
968
|
/** @oneof */
|
|
974
|
-
|
|
969
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
975
970
|
/**
|
|
976
|
-
* 0-based index from predefined `
|
|
971
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
977
972
|
* @max 199
|
|
978
973
|
*/
|
|
979
974
|
optionIndex?: number;
|
|
980
975
|
/**
|
|
981
|
-
* Placeholder hint describing expected choices
|
|
976
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
982
977
|
* Considered an empty choice.
|
|
983
978
|
* @maxLength 200
|
|
984
979
|
*/
|
|
985
980
|
placeholderText?: string;
|
|
986
981
|
}
|
|
987
|
-
|
|
982
|
+
interface Label {
|
|
988
983
|
/** Field name. */
|
|
989
984
|
name?: string;
|
|
990
985
|
/** Field label. */
|
|
@@ -994,8 +989,8 @@ export interface Label {
|
|
|
994
989
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
995
990
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
996
991
|
*/
|
|
997
|
-
|
|
998
|
-
/** RSVP form messages. */
|
|
992
|
+
interface FormMessages {
|
|
993
|
+
/** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
|
|
999
994
|
rsvp?: RsvpFormMessages;
|
|
1000
995
|
/** Checkout form messages. */
|
|
1001
996
|
checkout?: CheckoutFormMessages;
|
|
@@ -1004,22 +999,22 @@ export interface FormMessages {
|
|
|
1004
999
|
/** Messages shown when event tickets are unavailable. */
|
|
1005
1000
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1006
1001
|
}
|
|
1007
|
-
|
|
1008
|
-
/** Label text indicating RSVP `
|
|
1002
|
+
interface RsvpFormMessages {
|
|
1003
|
+
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
1009
1004
|
rsvpYesOption?: string;
|
|
1010
|
-
/** Label text indicating RSVP `
|
|
1005
|
+
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
1011
1006
|
rsvpNoOption?: string;
|
|
1012
|
-
/** Messages
|
|
1007
|
+
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
1013
1008
|
positiveMessages?: Positive;
|
|
1014
|
-
/** Messages
|
|
1009
|
+
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
1015
1010
|
waitlistMessages?: Positive;
|
|
1016
|
-
/** Messages
|
|
1011
|
+
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
1017
1012
|
negativeMessages?: Negative;
|
|
1018
1013
|
/** "Submit form" call-to-action label text. */
|
|
1019
1014
|
submitActionLabel?: string;
|
|
1020
1015
|
}
|
|
1021
1016
|
/** Confirmation messages shown after registration. */
|
|
1022
|
-
|
|
1017
|
+
interface PositiveResponseConfirmation {
|
|
1023
1018
|
/** Confirmation message title. */
|
|
1024
1019
|
title?: string;
|
|
1025
1020
|
/** Confirmation message text. */
|
|
@@ -1030,27 +1025,27 @@ export interface PositiveResponseConfirmation {
|
|
|
1030
1025
|
shareActionLabel?: string;
|
|
1031
1026
|
}
|
|
1032
1027
|
/** Confirmation messages shown after registration. */
|
|
1033
|
-
|
|
1028
|
+
interface NegativeResponseConfirmation {
|
|
1034
1029
|
/** Confirmation message title. */
|
|
1035
1030
|
title?: string;
|
|
1036
1031
|
/** "Share event" call-to-action label text. */
|
|
1037
1032
|
shareActionLabel?: string;
|
|
1038
1033
|
}
|
|
1039
1034
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
1040
|
-
|
|
1035
|
+
interface Positive {
|
|
1041
1036
|
/** Main form title for positive response. */
|
|
1042
1037
|
title?: string;
|
|
1043
1038
|
/** Confirmation messages shown after registration. */
|
|
1044
1039
|
confirmation?: PositiveResponseConfirmation;
|
|
1045
1040
|
}
|
|
1046
1041
|
/** A set of messages shown during registration with negative response */
|
|
1047
|
-
|
|
1042
|
+
interface Negative {
|
|
1048
1043
|
/** Main form title for negative response. */
|
|
1049
1044
|
title?: string;
|
|
1050
1045
|
/** Confirmation messages shown after registration. */
|
|
1051
1046
|
confirmation?: NegativeResponseConfirmation;
|
|
1052
1047
|
}
|
|
1053
|
-
|
|
1048
|
+
interface CheckoutFormMessages {
|
|
1054
1049
|
/** Main form title for response. */
|
|
1055
1050
|
title?: string;
|
|
1056
1051
|
/** Submit form call-to-action label text. */
|
|
@@ -1059,7 +1054,7 @@ export interface CheckoutFormMessages {
|
|
|
1059
1054
|
confirmation?: ResponseConfirmation;
|
|
1060
1055
|
}
|
|
1061
1056
|
/** Confirmation messages shown after checkout. */
|
|
1062
|
-
|
|
1057
|
+
interface ResponseConfirmation {
|
|
1063
1058
|
/** Confirmation message title. */
|
|
1064
1059
|
title?: string;
|
|
1065
1060
|
/** Confirmation message text. */
|
|
@@ -1071,19 +1066,19 @@ export interface ResponseConfirmation {
|
|
|
1071
1066
|
/** "Share event" call-to-action label text. */
|
|
1072
1067
|
shareEventLabel?: string;
|
|
1073
1068
|
}
|
|
1074
|
-
|
|
1069
|
+
interface RegistrationClosedMessages {
|
|
1075
1070
|
/** Message shown when event registration is closed. */
|
|
1076
1071
|
message?: string;
|
|
1077
1072
|
/** "Explore other events" call-to-action label text. */
|
|
1078
1073
|
exploreEventsActionLabel?: string;
|
|
1079
1074
|
}
|
|
1080
|
-
|
|
1075
|
+
interface TicketsUnavailableMessages {
|
|
1081
1076
|
/** Message shown when event tickets are unavailable. */
|
|
1082
1077
|
message?: string;
|
|
1083
1078
|
/** "Explore other events" call-to-action label text. */
|
|
1084
1079
|
exploreEventsActionLabel?: string;
|
|
1085
1080
|
}
|
|
1086
|
-
|
|
1081
|
+
interface Dashboard {
|
|
1087
1082
|
/** Guest RSVP summary. */
|
|
1088
1083
|
rsvpSummary?: RsvpSummary;
|
|
1089
1084
|
/**
|
|
@@ -1092,7 +1087,7 @@ export interface Dashboard {
|
|
|
1092
1087
|
*/
|
|
1093
1088
|
ticketingSummary?: TicketingSummary;
|
|
1094
1089
|
}
|
|
1095
|
-
|
|
1090
|
+
interface RsvpSummary {
|
|
1096
1091
|
/** Total number of RSVPs. */
|
|
1097
1092
|
total?: number;
|
|
1098
1093
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -1102,7 +1097,7 @@ export interface RsvpSummary {
|
|
|
1102
1097
|
/** Number of RSVPs in waitlist. */
|
|
1103
1098
|
waitlist?: number;
|
|
1104
1099
|
}
|
|
1105
|
-
|
|
1100
|
+
interface TicketingSummary {
|
|
1106
1101
|
/** Number of tickets sold. */
|
|
1107
1102
|
tickets?: number;
|
|
1108
1103
|
/**
|
|
@@ -1117,19 +1112,19 @@ export interface TicketingSummary {
|
|
|
1117
1112
|
/** Total balance of confirmed transactions. */
|
|
1118
1113
|
totalSales?: Money;
|
|
1119
1114
|
}
|
|
1120
|
-
|
|
1115
|
+
interface GuestListConfig {
|
|
1121
1116
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
1122
1117
|
publicGuestList?: boolean;
|
|
1123
1118
|
}
|
|
1124
|
-
|
|
1119
|
+
interface Feed {
|
|
1125
1120
|
/** Event discussion feed token. */
|
|
1126
1121
|
token?: string;
|
|
1127
1122
|
}
|
|
1128
|
-
|
|
1123
|
+
interface OnlineConferencing {
|
|
1129
1124
|
config?: OnlineConferencingConfig;
|
|
1130
1125
|
session?: OnlineConferencingSession;
|
|
1131
1126
|
}
|
|
1132
|
-
|
|
1127
|
+
interface OnlineConferencingConfig {
|
|
1133
1128
|
/**
|
|
1134
1129
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1135
1130
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -1143,15 +1138,15 @@ export interface OnlineConferencingConfig {
|
|
|
1143
1138
|
/** Conference type */
|
|
1144
1139
|
conferenceType?: ConferenceTypeWithLiterals;
|
|
1145
1140
|
}
|
|
1146
|
-
|
|
1141
|
+
declare enum ConferenceType {
|
|
1147
1142
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1148
1143
|
MEETING = "MEETING",
|
|
1149
1144
|
/** Guests can only subscribe to video and audio. */
|
|
1150
1145
|
WEBINAR = "WEBINAR"
|
|
1151
1146
|
}
|
|
1152
1147
|
/** @enumType */
|
|
1153
|
-
|
|
1154
|
-
|
|
1148
|
+
type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1149
|
+
interface OnlineConferencingSession {
|
|
1155
1150
|
/**
|
|
1156
1151
|
* Link for event host to start the online conference session.
|
|
1157
1152
|
* @readonly
|
|
@@ -1178,7 +1173,7 @@ export interface OnlineConferencingSession {
|
|
|
1178
1173
|
*/
|
|
1179
1174
|
sessionId?: string | null;
|
|
1180
1175
|
}
|
|
1181
|
-
|
|
1176
|
+
interface SeoSettings {
|
|
1182
1177
|
/**
|
|
1183
1178
|
* URL slug
|
|
1184
1179
|
* @maxLength 130
|
|
@@ -1197,13 +1192,13 @@ export interface SeoSettings {
|
|
|
1197
1192
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1198
1193
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1199
1194
|
*/
|
|
1200
|
-
|
|
1195
|
+
interface SeoSchema {
|
|
1201
1196
|
/** SEO tag information. */
|
|
1202
1197
|
tags?: Tag[];
|
|
1203
1198
|
/** SEO general settings. */
|
|
1204
1199
|
settings?: Settings;
|
|
1205
1200
|
}
|
|
1206
|
-
|
|
1201
|
+
interface Keyword {
|
|
1207
1202
|
/** Keyword value. */
|
|
1208
1203
|
term?: string;
|
|
1209
1204
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1214,7 +1209,7 @@ export interface Keyword {
|
|
|
1214
1209
|
*/
|
|
1215
1210
|
origin?: string | null;
|
|
1216
1211
|
}
|
|
1217
|
-
|
|
1212
|
+
interface Tag {
|
|
1218
1213
|
/**
|
|
1219
1214
|
* SEO tag type.
|
|
1220
1215
|
*
|
|
@@ -1236,7 +1231,7 @@ export interface Tag {
|
|
|
1236
1231
|
/** Whether the tag is disabled. */
|
|
1237
1232
|
disabled?: boolean;
|
|
1238
1233
|
}
|
|
1239
|
-
|
|
1234
|
+
interface Settings {
|
|
1240
1235
|
/**
|
|
1241
1236
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1242
1237
|
*
|
|
@@ -1250,7 +1245,7 @@ export interface Settings {
|
|
|
1250
1245
|
*/
|
|
1251
1246
|
keywords?: Keyword[];
|
|
1252
1247
|
}
|
|
1253
|
-
|
|
1248
|
+
interface Agenda {
|
|
1254
1249
|
/** Whether the schedule is enabled for the event. */
|
|
1255
1250
|
enabled?: boolean;
|
|
1256
1251
|
/**
|
|
@@ -1259,7 +1254,7 @@ export interface Agenda {
|
|
|
1259
1254
|
*/
|
|
1260
1255
|
pageUrl?: SiteUrl;
|
|
1261
1256
|
}
|
|
1262
|
-
|
|
1257
|
+
interface Category {
|
|
1263
1258
|
/**
|
|
1264
1259
|
* Category ID.
|
|
1265
1260
|
* @format GUID
|
|
@@ -1297,13 +1292,13 @@ export interface Category {
|
|
|
1297
1292
|
*/
|
|
1298
1293
|
states?: StateWithLiterals[];
|
|
1299
1294
|
}
|
|
1300
|
-
|
|
1295
|
+
interface CategoryCounts {
|
|
1301
1296
|
/** Total number of draft events assigned to the category. */
|
|
1302
1297
|
assignedEventsCount?: number | null;
|
|
1303
1298
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1304
1299
|
assignedDraftEventsCount?: number | null;
|
|
1305
1300
|
}
|
|
1306
|
-
|
|
1301
|
+
declare enum State {
|
|
1307
1302
|
/** Created manually by the user. */
|
|
1308
1303
|
MANUAL = "MANUAL",
|
|
1309
1304
|
/** Created automatically. */
|
|
@@ -1314,16 +1309,16 @@ export declare enum State {
|
|
|
1314
1309
|
HIDDEN = "HIDDEN"
|
|
1315
1310
|
}
|
|
1316
1311
|
/** @enumType */
|
|
1317
|
-
|
|
1318
|
-
|
|
1312
|
+
type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1313
|
+
interface EventDisplaySettings {
|
|
1319
1314
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1320
1315
|
hideEventDetailsButton?: boolean | null;
|
|
1321
1316
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1322
1317
|
hideEventDetailsPage?: boolean | null;
|
|
1323
1318
|
}
|
|
1324
|
-
|
|
1319
|
+
interface LabellingSettings {
|
|
1325
1320
|
}
|
|
1326
|
-
|
|
1321
|
+
interface RichContent {
|
|
1327
1322
|
/** Node objects representing a rich content document. */
|
|
1328
1323
|
nodes?: Node[];
|
|
1329
1324
|
/** Object metadata. */
|
|
@@ -1331,7 +1326,7 @@ export interface RichContent {
|
|
|
1331
1326
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1332
1327
|
documentStyle?: DocumentStyle;
|
|
1333
1328
|
}
|
|
1334
|
-
|
|
1329
|
+
interface Node extends NodeDataOneOf {
|
|
1335
1330
|
/** Data for a button node. */
|
|
1336
1331
|
buttonData?: ButtonData;
|
|
1337
1332
|
/** Data for a code block node. */
|
|
@@ -1396,7 +1391,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1396
1391
|
style?: NodeStyle;
|
|
1397
1392
|
}
|
|
1398
1393
|
/** @oneof */
|
|
1399
|
-
|
|
1394
|
+
interface NodeDataOneOf {
|
|
1400
1395
|
/** Data for a button node. */
|
|
1401
1396
|
buttonData?: ButtonData;
|
|
1402
1397
|
/** Data for a code block node. */
|
|
@@ -1452,7 +1447,7 @@ export interface NodeDataOneOf {
|
|
|
1452
1447
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1453
1448
|
layoutCellData?: LayoutCellData;
|
|
1454
1449
|
}
|
|
1455
|
-
|
|
1450
|
+
declare enum NodeType {
|
|
1456
1451
|
PARAGRAPH = "PARAGRAPH",
|
|
1457
1452
|
TEXT = "TEXT",
|
|
1458
1453
|
HEADING = "HEADING",
|
|
@@ -1489,8 +1484,8 @@ export declare enum NodeType {
|
|
|
1489
1484
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1490
1485
|
}
|
|
1491
1486
|
/** @enumType */
|
|
1492
|
-
|
|
1493
|
-
|
|
1487
|
+
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';
|
|
1488
|
+
interface NodeStyle {
|
|
1494
1489
|
/** The top padding value in pixels. */
|
|
1495
1490
|
paddingTop?: string | null;
|
|
1496
1491
|
/** The bottom padding value in pixels. */
|
|
@@ -1498,7 +1493,7 @@ export interface NodeStyle {
|
|
|
1498
1493
|
/** The background color as a hexadecimal value. */
|
|
1499
1494
|
backgroundColor?: string | null;
|
|
1500
1495
|
}
|
|
1501
|
-
|
|
1496
|
+
interface ButtonData {
|
|
1502
1497
|
/** Styling for the button's container. */
|
|
1503
1498
|
containerData?: PluginContainerData;
|
|
1504
1499
|
/** The button type. */
|
|
@@ -1510,21 +1505,36 @@ export interface ButtonData {
|
|
|
1510
1505
|
/** Button link details. */
|
|
1511
1506
|
link?: V1Link;
|
|
1512
1507
|
}
|
|
1513
|
-
|
|
1514
|
-
/**
|
|
1508
|
+
interface Border {
|
|
1509
|
+
/**
|
|
1510
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1511
|
+
* @deprecated
|
|
1512
|
+
*/
|
|
1515
1513
|
width?: number | null;
|
|
1516
|
-
/**
|
|
1514
|
+
/**
|
|
1515
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
1516
|
+
* @deprecated
|
|
1517
|
+
*/
|
|
1517
1518
|
radius?: number | null;
|
|
1518
1519
|
}
|
|
1519
|
-
|
|
1520
|
-
/**
|
|
1520
|
+
interface Colors {
|
|
1521
|
+
/**
|
|
1522
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
1523
|
+
* @deprecated
|
|
1524
|
+
*/
|
|
1521
1525
|
text?: string | null;
|
|
1522
|
-
/**
|
|
1526
|
+
/**
|
|
1527
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
1528
|
+
* @deprecated
|
|
1529
|
+
*/
|
|
1523
1530
|
border?: string | null;
|
|
1524
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
1533
|
+
* @deprecated
|
|
1534
|
+
*/
|
|
1525
1535
|
background?: string | null;
|
|
1526
1536
|
}
|
|
1527
|
-
|
|
1537
|
+
interface PluginContainerData {
|
|
1528
1538
|
/** The width of the node when it's displayed. */
|
|
1529
1539
|
width?: PluginContainerDataWidth;
|
|
1530
1540
|
/** The node's alignment within its container. */
|
|
@@ -1536,7 +1546,7 @@ export interface PluginContainerData {
|
|
|
1536
1546
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
1537
1547
|
textWrap?: boolean | null;
|
|
1538
1548
|
}
|
|
1539
|
-
|
|
1549
|
+
declare enum WidthType {
|
|
1540
1550
|
/** Width matches the content width */
|
|
1541
1551
|
CONTENT = "CONTENT",
|
|
1542
1552
|
/** Small Width */
|
|
@@ -1547,8 +1557,8 @@ export declare enum WidthType {
|
|
|
1547
1557
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1548
1558
|
}
|
|
1549
1559
|
/** @enumType */
|
|
1550
|
-
|
|
1551
|
-
|
|
1560
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1561
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1552
1562
|
/**
|
|
1553
1563
|
* One of the following predefined width options:
|
|
1554
1564
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1561,7 +1571,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1561
1571
|
custom?: string | null;
|
|
1562
1572
|
}
|
|
1563
1573
|
/** @oneof */
|
|
1564
|
-
|
|
1574
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1565
1575
|
/**
|
|
1566
1576
|
* One of the following predefined width options:
|
|
1567
1577
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1573,7 +1583,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1573
1583
|
/** A custom width value in pixels. */
|
|
1574
1584
|
custom?: string | null;
|
|
1575
1585
|
}
|
|
1576
|
-
|
|
1586
|
+
declare enum PluginContainerDataAlignment {
|
|
1577
1587
|
/** Center Alignment */
|
|
1578
1588
|
CENTER = "CENTER",
|
|
1579
1589
|
/** Left Alignment */
|
|
@@ -1582,8 +1592,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1582
1592
|
RIGHT = "RIGHT"
|
|
1583
1593
|
}
|
|
1584
1594
|
/** @enumType */
|
|
1585
|
-
|
|
1586
|
-
|
|
1595
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1596
|
+
interface Spoiler {
|
|
1587
1597
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1588
1598
|
enabled?: boolean | null;
|
|
1589
1599
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1591,25 +1601,72 @@ export interface Spoiler {
|
|
|
1591
1601
|
/** The text for the button used to remove the spoiler cover. */
|
|
1592
1602
|
buttonText?: string | null;
|
|
1593
1603
|
}
|
|
1594
|
-
|
|
1604
|
+
interface Height {
|
|
1595
1605
|
/** A custom height value in pixels. */
|
|
1596
1606
|
custom?: string | null;
|
|
1597
1607
|
}
|
|
1598
|
-
|
|
1608
|
+
declare enum ButtonDataType {
|
|
1599
1609
|
/** Regular link button */
|
|
1600
1610
|
LINK = "LINK",
|
|
1601
1611
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1602
1612
|
ACTION = "ACTION"
|
|
1603
1613
|
}
|
|
1604
1614
|
/** @enumType */
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
/**
|
|
1615
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1616
|
+
interface Styles {
|
|
1617
|
+
/**
|
|
1618
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1619
|
+
* @deprecated
|
|
1620
|
+
*/
|
|
1608
1621
|
border?: Border;
|
|
1609
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
1624
|
+
* @deprecated
|
|
1625
|
+
*/
|
|
1610
1626
|
colors?: Colors;
|
|
1627
|
+
/** Border width in pixels. */
|
|
1628
|
+
borderWidth?: number | null;
|
|
1629
|
+
/**
|
|
1630
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
1631
|
+
* @deprecated
|
|
1632
|
+
*/
|
|
1633
|
+
borderWidthHover?: number | null;
|
|
1634
|
+
/** Border radius in pixels. */
|
|
1635
|
+
borderRadius?: number | null;
|
|
1636
|
+
/**
|
|
1637
|
+
* Border color as a hexadecimal value.
|
|
1638
|
+
* @format COLOR_HEX
|
|
1639
|
+
*/
|
|
1640
|
+
borderColor?: string | null;
|
|
1641
|
+
/**
|
|
1642
|
+
* Border color as a hexadecimal value (hover state).
|
|
1643
|
+
* @format COLOR_HEX
|
|
1644
|
+
*/
|
|
1645
|
+
borderColorHover?: string | null;
|
|
1646
|
+
/**
|
|
1647
|
+
* Text color as a hexadecimal value.
|
|
1648
|
+
* @format COLOR_HEX
|
|
1649
|
+
*/
|
|
1650
|
+
textColor?: string | null;
|
|
1651
|
+
/**
|
|
1652
|
+
* Text color as a hexadecimal value (hover state).
|
|
1653
|
+
* @format COLOR_HEX
|
|
1654
|
+
*/
|
|
1655
|
+
textColorHover?: string | null;
|
|
1656
|
+
/**
|
|
1657
|
+
* Background color as a hexadecimal value.
|
|
1658
|
+
* @format COLOR_HEX
|
|
1659
|
+
*/
|
|
1660
|
+
backgroundColor?: string | null;
|
|
1661
|
+
/**
|
|
1662
|
+
* Background color as a hexadecimal value (hover state).
|
|
1663
|
+
* @format COLOR_HEX
|
|
1664
|
+
*/
|
|
1665
|
+
backgroundColorHover?: string | null;
|
|
1666
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1667
|
+
buttonSize?: string | null;
|
|
1611
1668
|
}
|
|
1612
|
-
|
|
1669
|
+
interface V1Link extends V1LinkDataOneOf {
|
|
1613
1670
|
/** The absolute URL for the linked document. */
|
|
1614
1671
|
url?: string;
|
|
1615
1672
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1628,13 +1685,13 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
1628
1685
|
customData?: string | null;
|
|
1629
1686
|
}
|
|
1630
1687
|
/** @oneof */
|
|
1631
|
-
|
|
1688
|
+
interface V1LinkDataOneOf {
|
|
1632
1689
|
/** The absolute URL for the linked document. */
|
|
1633
1690
|
url?: string;
|
|
1634
1691
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1635
1692
|
anchor?: string;
|
|
1636
1693
|
}
|
|
1637
|
-
|
|
1694
|
+
declare enum Target {
|
|
1638
1695
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1639
1696
|
SELF = "SELF",
|
|
1640
1697
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1645,8 +1702,8 @@ export declare enum Target {
|
|
|
1645
1702
|
TOP = "TOP"
|
|
1646
1703
|
}
|
|
1647
1704
|
/** @enumType */
|
|
1648
|
-
|
|
1649
|
-
|
|
1705
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1706
|
+
interface Rel {
|
|
1650
1707
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1651
1708
|
nofollow?: boolean | null;
|
|
1652
1709
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1656,17 +1713,17 @@ export interface Rel {
|
|
|
1656
1713
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1657
1714
|
noreferrer?: boolean | null;
|
|
1658
1715
|
}
|
|
1659
|
-
|
|
1716
|
+
interface CodeBlockData {
|
|
1660
1717
|
/** Styling for the code block's text. */
|
|
1661
1718
|
textStyle?: TextStyle;
|
|
1662
1719
|
}
|
|
1663
|
-
|
|
1720
|
+
interface TextStyle {
|
|
1664
1721
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1665
1722
|
textAlignment?: TextAlignmentWithLiterals;
|
|
1666
1723
|
/** 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. */
|
|
1667
1724
|
lineHeight?: string | null;
|
|
1668
1725
|
}
|
|
1669
|
-
|
|
1726
|
+
declare enum TextAlignment {
|
|
1670
1727
|
/** browser default, eqivalent to `initial` */
|
|
1671
1728
|
AUTO = "AUTO",
|
|
1672
1729
|
/** Left align */
|
|
@@ -1679,8 +1736,8 @@ export declare enum TextAlignment {
|
|
|
1679
1736
|
JUSTIFY = "JUSTIFY"
|
|
1680
1737
|
}
|
|
1681
1738
|
/** @enumType */
|
|
1682
|
-
|
|
1683
|
-
|
|
1739
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1740
|
+
interface DividerData {
|
|
1684
1741
|
/** Styling for the divider's container. */
|
|
1685
1742
|
containerData?: PluginContainerData;
|
|
1686
1743
|
/** Divider line style. */
|
|
@@ -1690,7 +1747,7 @@ export interface DividerData {
|
|
|
1690
1747
|
/** Divider alignment. */
|
|
1691
1748
|
alignment?: AlignmentWithLiterals;
|
|
1692
1749
|
}
|
|
1693
|
-
|
|
1750
|
+
declare enum LineStyle {
|
|
1694
1751
|
/** Single Line */
|
|
1695
1752
|
SINGLE = "SINGLE",
|
|
1696
1753
|
/** Double Line */
|
|
@@ -1701,8 +1758,8 @@ export declare enum LineStyle {
|
|
|
1701
1758
|
DOTTED = "DOTTED"
|
|
1702
1759
|
}
|
|
1703
1760
|
/** @enumType */
|
|
1704
|
-
|
|
1705
|
-
|
|
1761
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1762
|
+
declare enum Width {
|
|
1706
1763
|
/** Large line */
|
|
1707
1764
|
LARGE = "LARGE",
|
|
1708
1765
|
/** Medium line */
|
|
@@ -1711,8 +1768,8 @@ export declare enum Width {
|
|
|
1711
1768
|
SMALL = "SMALL"
|
|
1712
1769
|
}
|
|
1713
1770
|
/** @enumType */
|
|
1714
|
-
|
|
1715
|
-
|
|
1771
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1772
|
+
declare enum Alignment {
|
|
1716
1773
|
/** Center alignment */
|
|
1717
1774
|
CENTER = "CENTER",
|
|
1718
1775
|
/** Left alignment */
|
|
@@ -1721,8 +1778,8 @@ export declare enum Alignment {
|
|
|
1721
1778
|
RIGHT = "RIGHT"
|
|
1722
1779
|
}
|
|
1723
1780
|
/** @enumType */
|
|
1724
|
-
|
|
1725
|
-
|
|
1781
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1782
|
+
interface FileData {
|
|
1726
1783
|
/** Styling for the file's container. */
|
|
1727
1784
|
containerData?: PluginContainerData;
|
|
1728
1785
|
/** The source for the file's data. */
|
|
@@ -1745,7 +1802,7 @@ export interface FileData {
|
|
|
1745
1802
|
/** File size in KB. */
|
|
1746
1803
|
sizeInKb?: string | null;
|
|
1747
1804
|
}
|
|
1748
|
-
|
|
1805
|
+
declare enum ViewMode {
|
|
1749
1806
|
/** No PDF view */
|
|
1750
1807
|
NONE = "NONE",
|
|
1751
1808
|
/** Full PDF view */
|
|
@@ -1754,8 +1811,8 @@ export declare enum ViewMode {
|
|
|
1754
1811
|
MINI = "MINI"
|
|
1755
1812
|
}
|
|
1756
1813
|
/** @enumType */
|
|
1757
|
-
|
|
1758
|
-
|
|
1814
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1815
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1759
1816
|
/** The absolute URL for the file's source. */
|
|
1760
1817
|
url?: string | null;
|
|
1761
1818
|
/**
|
|
@@ -1769,7 +1826,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1769
1826
|
private?: boolean | null;
|
|
1770
1827
|
}
|
|
1771
1828
|
/** @oneof */
|
|
1772
|
-
|
|
1829
|
+
interface FileSourceDataOneOf {
|
|
1773
1830
|
/** The absolute URL for the file's source. */
|
|
1774
1831
|
url?: string | null;
|
|
1775
1832
|
/**
|
|
@@ -1780,7 +1837,7 @@ export interface FileSourceDataOneOf {
|
|
|
1780
1837
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1781
1838
|
id?: string | null;
|
|
1782
1839
|
}
|
|
1783
|
-
|
|
1840
|
+
interface PDFSettings {
|
|
1784
1841
|
/**
|
|
1785
1842
|
* PDF view mode. One of the following:
|
|
1786
1843
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1793,7 +1850,7 @@ export interface PDFSettings {
|
|
|
1793
1850
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1794
1851
|
disablePrint?: boolean | null;
|
|
1795
1852
|
}
|
|
1796
|
-
|
|
1853
|
+
interface GalleryData {
|
|
1797
1854
|
/** Styling for the gallery's container. */
|
|
1798
1855
|
containerData?: PluginContainerData;
|
|
1799
1856
|
/** The items in the gallery. */
|
|
@@ -1805,7 +1862,7 @@ export interface GalleryData {
|
|
|
1805
1862
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1806
1863
|
disableDownload?: boolean | null;
|
|
1807
1864
|
}
|
|
1808
|
-
|
|
1865
|
+
interface Media {
|
|
1809
1866
|
/** The source for the media's data. */
|
|
1810
1867
|
src?: FileSource;
|
|
1811
1868
|
/** Media width in pixels. */
|
|
@@ -1815,19 +1872,19 @@ export interface Media {
|
|
|
1815
1872
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1816
1873
|
duration?: number | null;
|
|
1817
1874
|
}
|
|
1818
|
-
|
|
1875
|
+
interface Image {
|
|
1819
1876
|
/** Image file details. */
|
|
1820
1877
|
media?: Media;
|
|
1821
1878
|
/** Link details for images that are links. */
|
|
1822
1879
|
link?: V1Link;
|
|
1823
1880
|
}
|
|
1824
|
-
|
|
1881
|
+
interface Video {
|
|
1825
1882
|
/** Video file details. */
|
|
1826
1883
|
media?: Media;
|
|
1827
1884
|
/** Video thumbnail file details. */
|
|
1828
1885
|
thumbnail?: Media;
|
|
1829
1886
|
}
|
|
1830
|
-
|
|
1887
|
+
interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
1831
1888
|
/** An image item. */
|
|
1832
1889
|
image?: Image;
|
|
1833
1890
|
/** A video item. */
|
|
@@ -1838,13 +1895,13 @@ export interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
|
1838
1895
|
altText?: string | null;
|
|
1839
1896
|
}
|
|
1840
1897
|
/** @oneof */
|
|
1841
|
-
|
|
1898
|
+
interface GalleryDataItemDataOneOf {
|
|
1842
1899
|
/** An image item. */
|
|
1843
1900
|
image?: Image;
|
|
1844
1901
|
/** A video item. */
|
|
1845
1902
|
video?: Video;
|
|
1846
1903
|
}
|
|
1847
|
-
|
|
1904
|
+
interface GalleryOptions {
|
|
1848
1905
|
/** Gallery layout. */
|
|
1849
1906
|
layout?: Layout;
|
|
1850
1907
|
/** Styling for gallery items. */
|
|
@@ -1852,7 +1909,7 @@ export interface GalleryOptions {
|
|
|
1852
1909
|
/** Styling for gallery thumbnail images. */
|
|
1853
1910
|
thumbnails?: Thumbnails;
|
|
1854
1911
|
}
|
|
1855
|
-
|
|
1912
|
+
declare enum LayoutType {
|
|
1856
1913
|
/** Collage type */
|
|
1857
1914
|
COLLAGE = "COLLAGE",
|
|
1858
1915
|
/** Masonry type */
|
|
@@ -1875,24 +1932,24 @@ export declare enum LayoutType {
|
|
|
1875
1932
|
FULLSIZE = "FULLSIZE"
|
|
1876
1933
|
}
|
|
1877
1934
|
/** @enumType */
|
|
1878
|
-
|
|
1879
|
-
|
|
1935
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1936
|
+
declare enum Orientation {
|
|
1880
1937
|
/** Rows Orientation */
|
|
1881
1938
|
ROWS = "ROWS",
|
|
1882
1939
|
/** Columns Orientation */
|
|
1883
1940
|
COLUMNS = "COLUMNS"
|
|
1884
1941
|
}
|
|
1885
1942
|
/** @enumType */
|
|
1886
|
-
|
|
1887
|
-
|
|
1943
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1944
|
+
declare enum Crop {
|
|
1888
1945
|
/** Crop to fill */
|
|
1889
1946
|
FILL = "FILL",
|
|
1890
1947
|
/** Crop to fit */
|
|
1891
1948
|
FIT = "FIT"
|
|
1892
1949
|
}
|
|
1893
1950
|
/** @enumType */
|
|
1894
|
-
|
|
1895
|
-
|
|
1951
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1952
|
+
declare enum ThumbnailsAlignment {
|
|
1896
1953
|
/** Top alignment */
|
|
1897
1954
|
TOP = "TOP",
|
|
1898
1955
|
/** Right alignment */
|
|
@@ -1905,8 +1962,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
1905
1962
|
NONE = "NONE"
|
|
1906
1963
|
}
|
|
1907
1964
|
/** @enumType */
|
|
1908
|
-
|
|
1909
|
-
|
|
1965
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1966
|
+
interface Layout {
|
|
1910
1967
|
/** Gallery layout type. */
|
|
1911
1968
|
type?: LayoutTypeWithLiterals;
|
|
1912
1969
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -1918,7 +1975,7 @@ export interface Layout {
|
|
|
1918
1975
|
/** The number of columns to display on mobile screens. */
|
|
1919
1976
|
mobileNumberOfColumns?: number | null;
|
|
1920
1977
|
}
|
|
1921
|
-
|
|
1978
|
+
interface ItemStyle {
|
|
1922
1979
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1923
1980
|
targetSize?: number | null;
|
|
1924
1981
|
/** Item ratio */
|
|
@@ -1928,13 +1985,13 @@ export interface ItemStyle {
|
|
|
1928
1985
|
/** The spacing between items in pixels. */
|
|
1929
1986
|
spacing?: number | null;
|
|
1930
1987
|
}
|
|
1931
|
-
|
|
1988
|
+
interface Thumbnails {
|
|
1932
1989
|
/** Thumbnail alignment. */
|
|
1933
1990
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1934
1991
|
/** Spacing between thumbnails in pixels. */
|
|
1935
1992
|
spacing?: number | null;
|
|
1936
1993
|
}
|
|
1937
|
-
|
|
1994
|
+
interface GIFData {
|
|
1938
1995
|
/** Styling for the GIF's container. */
|
|
1939
1996
|
containerData?: PluginContainerData;
|
|
1940
1997
|
/** The source of the full size GIF. */
|
|
@@ -1948,7 +2005,7 @@ export interface GIFData {
|
|
|
1948
2005
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1949
2006
|
gifType?: GIFTypeWithLiterals;
|
|
1950
2007
|
}
|
|
1951
|
-
|
|
2008
|
+
interface GIF {
|
|
1952
2009
|
/**
|
|
1953
2010
|
* GIF format URL.
|
|
1954
2011
|
* @format WEB_URL
|
|
@@ -1965,13 +2022,13 @@ export interface GIF {
|
|
|
1965
2022
|
*/
|
|
1966
2023
|
still?: string | null;
|
|
1967
2024
|
}
|
|
1968
|
-
|
|
2025
|
+
declare enum GIFType {
|
|
1969
2026
|
NORMAL = "NORMAL",
|
|
1970
2027
|
STICKER = "STICKER"
|
|
1971
2028
|
}
|
|
1972
2029
|
/** @enumType */
|
|
1973
|
-
|
|
1974
|
-
|
|
2030
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2031
|
+
interface HeadingData {
|
|
1975
2032
|
/** Heading level from 1-6. */
|
|
1976
2033
|
level?: number;
|
|
1977
2034
|
/** Styling for the heading text. */
|
|
@@ -1979,7 +2036,7 @@ export interface HeadingData {
|
|
|
1979
2036
|
/** Indentation level from 1-4. */
|
|
1980
2037
|
indentation?: number | null;
|
|
1981
2038
|
}
|
|
1982
|
-
|
|
2039
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1983
2040
|
/** The URL for the HTML code for the node. */
|
|
1984
2041
|
url?: string;
|
|
1985
2042
|
/** The HTML code for the node. */
|
|
@@ -1997,7 +2054,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1997
2054
|
autoHeight?: boolean | null;
|
|
1998
2055
|
}
|
|
1999
2056
|
/** @oneof */
|
|
2000
|
-
|
|
2057
|
+
interface HTMLDataDataOneOf {
|
|
2001
2058
|
/** The URL for the HTML code for the node. */
|
|
2002
2059
|
url?: string;
|
|
2003
2060
|
/** The HTML code for the node. */
|
|
@@ -2008,13 +2065,13 @@ export interface HTMLDataDataOneOf {
|
|
|
2008
2065
|
*/
|
|
2009
2066
|
isAdsense?: boolean | null;
|
|
2010
2067
|
}
|
|
2011
|
-
|
|
2068
|
+
declare enum Source {
|
|
2012
2069
|
HTML = "HTML",
|
|
2013
2070
|
ADSENSE = "ADSENSE"
|
|
2014
2071
|
}
|
|
2015
2072
|
/** @enumType */
|
|
2016
|
-
|
|
2017
|
-
|
|
2073
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2074
|
+
interface ImageData {
|
|
2018
2075
|
/** Styling for the image's container. */
|
|
2019
2076
|
containerData?: PluginContainerData;
|
|
2020
2077
|
/** Image file details. */
|
|
@@ -2037,7 +2094,7 @@ export interface ImageData {
|
|
|
2037
2094
|
/** Styling for the image. */
|
|
2038
2095
|
styles?: ImageDataStyles;
|
|
2039
2096
|
}
|
|
2040
|
-
|
|
2097
|
+
interface StylesBorder {
|
|
2041
2098
|
/** Border width in pixels. */
|
|
2042
2099
|
width?: number | null;
|
|
2043
2100
|
/**
|
|
@@ -2048,11 +2105,11 @@ export interface StylesBorder {
|
|
|
2048
2105
|
/** Border radius in pixels. */
|
|
2049
2106
|
radius?: number | null;
|
|
2050
2107
|
}
|
|
2051
|
-
|
|
2108
|
+
interface ImageDataStyles {
|
|
2052
2109
|
/** Border attributes. */
|
|
2053
2110
|
border?: StylesBorder;
|
|
2054
2111
|
}
|
|
2055
|
-
|
|
2112
|
+
interface LinkPreviewData {
|
|
2056
2113
|
/** Styling for the link preview's container. */
|
|
2057
2114
|
containerData?: PluginContainerData;
|
|
2058
2115
|
/** Link details. */
|
|
@@ -2068,7 +2125,7 @@ export interface LinkPreviewData {
|
|
|
2068
2125
|
/** Styling for the link preview. */
|
|
2069
2126
|
styles?: LinkPreviewDataStyles;
|
|
2070
2127
|
}
|
|
2071
|
-
|
|
2128
|
+
declare enum Position {
|
|
2072
2129
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2073
2130
|
START = "START",
|
|
2074
2131
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2079,8 +2136,8 @@ export declare enum Position {
|
|
|
2079
2136
|
HIDDEN = "HIDDEN"
|
|
2080
2137
|
}
|
|
2081
2138
|
/** @enumType */
|
|
2082
|
-
|
|
2083
|
-
|
|
2139
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2140
|
+
interface LinkPreviewDataStyles {
|
|
2084
2141
|
/**
|
|
2085
2142
|
* Background color as a hexadecimal value.
|
|
2086
2143
|
* @format COLOR_HEX
|
|
@@ -2113,13 +2170,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2113
2170
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2114
2171
|
thumbnailPosition?: PositionWithLiterals;
|
|
2115
2172
|
}
|
|
2116
|
-
|
|
2173
|
+
interface MapData {
|
|
2117
2174
|
/** Styling for the map's container. */
|
|
2118
2175
|
containerData?: PluginContainerData;
|
|
2119
2176
|
/** Map settings. */
|
|
2120
2177
|
mapSettings?: MapSettings;
|
|
2121
2178
|
}
|
|
2122
|
-
|
|
2179
|
+
interface MapSettings {
|
|
2123
2180
|
/** The address to display on the map. */
|
|
2124
2181
|
address?: string | null;
|
|
2125
2182
|
/** Sets whether the map is draggable. */
|
|
@@ -2143,7 +2200,7 @@ export interface MapSettings {
|
|
|
2143
2200
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2144
2201
|
mapType?: MapTypeWithLiterals;
|
|
2145
2202
|
}
|
|
2146
|
-
|
|
2203
|
+
declare enum MapType {
|
|
2147
2204
|
/** Roadmap map type */
|
|
2148
2205
|
ROADMAP = "ROADMAP",
|
|
2149
2206
|
/** Satellite map type */
|
|
@@ -2154,8 +2211,8 @@ export declare enum MapType {
|
|
|
2154
2211
|
TERRAIN = "TERRAIN"
|
|
2155
2212
|
}
|
|
2156
2213
|
/** @enumType */
|
|
2157
|
-
|
|
2158
|
-
|
|
2214
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2215
|
+
interface ParagraphData {
|
|
2159
2216
|
/** Styling for the paragraph text. */
|
|
2160
2217
|
textStyle?: TextStyle;
|
|
2161
2218
|
/** Indentation level from 1-4. */
|
|
@@ -2163,7 +2220,7 @@ export interface ParagraphData {
|
|
|
2163
2220
|
/** Paragraph level */
|
|
2164
2221
|
level?: number | null;
|
|
2165
2222
|
}
|
|
2166
|
-
|
|
2223
|
+
interface PollData {
|
|
2167
2224
|
/** Styling for the poll's container. */
|
|
2168
2225
|
containerData?: PluginContainerData;
|
|
2169
2226
|
/** Poll data. */
|
|
@@ -2173,7 +2230,7 @@ export interface PollData {
|
|
|
2173
2230
|
/** Styling for the poll and voting options. */
|
|
2174
2231
|
design?: Design;
|
|
2175
2232
|
}
|
|
2176
|
-
|
|
2233
|
+
declare enum ViewRole {
|
|
2177
2234
|
/** Only Poll creator can view the results */
|
|
2178
2235
|
CREATOR = "CREATOR",
|
|
2179
2236
|
/** Anyone who voted can see the results */
|
|
@@ -2182,16 +2239,16 @@ export declare enum ViewRole {
|
|
|
2182
2239
|
EVERYONE = "EVERYONE"
|
|
2183
2240
|
}
|
|
2184
2241
|
/** @enumType */
|
|
2185
|
-
|
|
2186
|
-
|
|
2242
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2243
|
+
declare enum VoteRole {
|
|
2187
2244
|
/** Logged in member */
|
|
2188
2245
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2189
2246
|
/** Anyone */
|
|
2190
2247
|
ALL = "ALL"
|
|
2191
2248
|
}
|
|
2192
2249
|
/** @enumType */
|
|
2193
|
-
|
|
2194
|
-
|
|
2250
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2251
|
+
interface Permissions {
|
|
2195
2252
|
/** Sets who can view the poll results. */
|
|
2196
2253
|
view?: ViewRoleWithLiterals;
|
|
2197
2254
|
/** Sets who can vote. */
|
|
@@ -2199,7 +2256,7 @@ export interface Permissions {
|
|
|
2199
2256
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2200
2257
|
allowMultipleVotes?: boolean | null;
|
|
2201
2258
|
}
|
|
2202
|
-
|
|
2259
|
+
interface Option {
|
|
2203
2260
|
/** Option ID. */
|
|
2204
2261
|
id?: string | null;
|
|
2205
2262
|
/** Option title. */
|
|
@@ -2207,7 +2264,7 @@ export interface Option {
|
|
|
2207
2264
|
/** The image displayed with the option. */
|
|
2208
2265
|
image?: Media;
|
|
2209
2266
|
}
|
|
2210
|
-
|
|
2267
|
+
interface PollSettings {
|
|
2211
2268
|
/** Permissions settings for voting. */
|
|
2212
2269
|
permissions?: Permissions;
|
|
2213
2270
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2215,23 +2272,23 @@ export interface PollSettings {
|
|
|
2215
2272
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2216
2273
|
showVotesCount?: boolean | null;
|
|
2217
2274
|
}
|
|
2218
|
-
|
|
2275
|
+
declare enum PollLayoutType {
|
|
2219
2276
|
/** List */
|
|
2220
2277
|
LIST = "LIST",
|
|
2221
2278
|
/** Grid */
|
|
2222
2279
|
GRID = "GRID"
|
|
2223
2280
|
}
|
|
2224
2281
|
/** @enumType */
|
|
2225
|
-
|
|
2226
|
-
|
|
2282
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2283
|
+
declare enum PollLayoutDirection {
|
|
2227
2284
|
/** Left-to-right */
|
|
2228
2285
|
LTR = "LTR",
|
|
2229
2286
|
/** Right-to-left */
|
|
2230
2287
|
RTL = "RTL"
|
|
2231
2288
|
}
|
|
2232
2289
|
/** @enumType */
|
|
2233
|
-
|
|
2234
|
-
|
|
2290
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2291
|
+
interface PollLayout {
|
|
2235
2292
|
/** The layout for displaying the voting options. */
|
|
2236
2293
|
type?: PollLayoutTypeWithLiterals;
|
|
2237
2294
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2239,11 +2296,11 @@ export interface PollLayout {
|
|
|
2239
2296
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2240
2297
|
enableImage?: boolean | null;
|
|
2241
2298
|
}
|
|
2242
|
-
|
|
2299
|
+
interface OptionLayout {
|
|
2243
2300
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2244
2301
|
enableImage?: boolean | null;
|
|
2245
2302
|
}
|
|
2246
|
-
|
|
2303
|
+
declare enum BackgroundType {
|
|
2247
2304
|
/** Color background type */
|
|
2248
2305
|
COLOR = "COLOR",
|
|
2249
2306
|
/** Image background type */
|
|
@@ -2252,8 +2309,8 @@ export declare enum BackgroundType {
|
|
|
2252
2309
|
GRADIENT = "GRADIENT"
|
|
2253
2310
|
}
|
|
2254
2311
|
/** @enumType */
|
|
2255
|
-
|
|
2256
|
-
|
|
2312
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2313
|
+
interface Gradient {
|
|
2257
2314
|
/** The gradient angle in degrees. */
|
|
2258
2315
|
angle?: number | null;
|
|
2259
2316
|
/**
|
|
@@ -2267,7 +2324,7 @@ export interface Gradient {
|
|
|
2267
2324
|
*/
|
|
2268
2325
|
lastColor?: string | null;
|
|
2269
2326
|
}
|
|
2270
|
-
|
|
2327
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2271
2328
|
/**
|
|
2272
2329
|
* The background color as a hexademical value.
|
|
2273
2330
|
* @format COLOR_HEX
|
|
@@ -2281,7 +2338,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2281
2338
|
type?: BackgroundTypeWithLiterals;
|
|
2282
2339
|
}
|
|
2283
2340
|
/** @oneof */
|
|
2284
|
-
|
|
2341
|
+
interface BackgroundBackgroundOneOf {
|
|
2285
2342
|
/**
|
|
2286
2343
|
* The background color as a hexademical value.
|
|
2287
2344
|
* @format COLOR_HEX
|
|
@@ -2292,17 +2349,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2292
2349
|
/** Details for a gradient background. */
|
|
2293
2350
|
gradient?: Gradient;
|
|
2294
2351
|
}
|
|
2295
|
-
|
|
2352
|
+
interface PollDesign {
|
|
2296
2353
|
/** Background styling. */
|
|
2297
2354
|
background?: Background;
|
|
2298
2355
|
/** Border radius in pixels. */
|
|
2299
2356
|
borderRadius?: number | null;
|
|
2300
2357
|
}
|
|
2301
|
-
|
|
2358
|
+
interface OptionDesign {
|
|
2302
2359
|
/** Border radius in pixels. */
|
|
2303
2360
|
borderRadius?: number | null;
|
|
2304
2361
|
}
|
|
2305
|
-
|
|
2362
|
+
interface Poll {
|
|
2306
2363
|
/** Poll ID. */
|
|
2307
2364
|
id?: string | null;
|
|
2308
2365
|
/** Poll title. */
|
|
@@ -2316,26 +2373,26 @@ export interface Poll {
|
|
|
2316
2373
|
/** The poll's permissions and display settings. */
|
|
2317
2374
|
settings?: PollSettings;
|
|
2318
2375
|
}
|
|
2319
|
-
|
|
2376
|
+
interface PollDataLayout {
|
|
2320
2377
|
/** Poll layout settings. */
|
|
2321
2378
|
poll?: PollLayout;
|
|
2322
2379
|
/** Voting otpions layout settings. */
|
|
2323
2380
|
options?: OptionLayout;
|
|
2324
2381
|
}
|
|
2325
|
-
|
|
2382
|
+
interface Design {
|
|
2326
2383
|
/** Styling for the poll. */
|
|
2327
2384
|
poll?: PollDesign;
|
|
2328
2385
|
/** Styling for voting options. */
|
|
2329
2386
|
options?: OptionDesign;
|
|
2330
2387
|
}
|
|
2331
|
-
|
|
2388
|
+
interface TextData {
|
|
2332
2389
|
/** The text to apply decorations to. */
|
|
2333
2390
|
text?: string;
|
|
2334
2391
|
/** The decorations to apply. */
|
|
2335
2392
|
decorations?: Decoration[];
|
|
2336
2393
|
}
|
|
2337
2394
|
/** Adds appearence changes to text */
|
|
2338
|
-
|
|
2395
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2339
2396
|
/** Data for an anchor link decoration. */
|
|
2340
2397
|
anchorData?: AnchorData;
|
|
2341
2398
|
/** Data for a color decoration. */
|
|
@@ -2354,11 +2411,13 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2354
2411
|
underlineData?: boolean | null;
|
|
2355
2412
|
/** Data for a spoiler decoration. */
|
|
2356
2413
|
spoilerData?: SpoilerData;
|
|
2414
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2415
|
+
strikethroughData?: boolean | null;
|
|
2357
2416
|
/** The type of decoration to apply. */
|
|
2358
2417
|
type?: DecorationTypeWithLiterals;
|
|
2359
2418
|
}
|
|
2360
2419
|
/** @oneof */
|
|
2361
|
-
|
|
2420
|
+
interface DecorationDataOneOf {
|
|
2362
2421
|
/** Data for an anchor link decoration. */
|
|
2363
2422
|
anchorData?: AnchorData;
|
|
2364
2423
|
/** Data for a color decoration. */
|
|
@@ -2377,8 +2436,10 @@ export interface DecorationDataOneOf {
|
|
|
2377
2436
|
underlineData?: boolean | null;
|
|
2378
2437
|
/** Data for a spoiler decoration. */
|
|
2379
2438
|
spoilerData?: SpoilerData;
|
|
2439
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2440
|
+
strikethroughData?: boolean | null;
|
|
2380
2441
|
}
|
|
2381
|
-
|
|
2442
|
+
declare enum DecorationType {
|
|
2382
2443
|
BOLD = "BOLD",
|
|
2383
2444
|
ITALIC = "ITALIC",
|
|
2384
2445
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2388,25 +2449,26 @@ export declare enum DecorationType {
|
|
|
2388
2449
|
LINK = "LINK",
|
|
2389
2450
|
COLOR = "COLOR",
|
|
2390
2451
|
FONT_SIZE = "FONT_SIZE",
|
|
2391
|
-
EXTERNAL = "EXTERNAL"
|
|
2452
|
+
EXTERNAL = "EXTERNAL",
|
|
2453
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2392
2454
|
}
|
|
2393
2455
|
/** @enumType */
|
|
2394
|
-
|
|
2395
|
-
|
|
2456
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2457
|
+
interface AnchorData {
|
|
2396
2458
|
/** The target node's ID. */
|
|
2397
2459
|
anchor?: string;
|
|
2398
2460
|
}
|
|
2399
|
-
|
|
2461
|
+
interface ColorData {
|
|
2400
2462
|
/** The text's background color as a hexadecimal value. */
|
|
2401
2463
|
background?: string | null;
|
|
2402
2464
|
/** The text's foreground color as a hexadecimal value. */
|
|
2403
2465
|
foreground?: string | null;
|
|
2404
2466
|
}
|
|
2405
|
-
|
|
2467
|
+
interface LinkData {
|
|
2406
2468
|
/** Link details. */
|
|
2407
2469
|
link?: V1Link;
|
|
2408
2470
|
}
|
|
2409
|
-
|
|
2471
|
+
interface MentionData {
|
|
2410
2472
|
/** The mentioned user's name. */
|
|
2411
2473
|
name?: string;
|
|
2412
2474
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2414,23 +2476,23 @@ export interface MentionData {
|
|
|
2414
2476
|
/** Mentioned user's ID. */
|
|
2415
2477
|
id?: string | null;
|
|
2416
2478
|
}
|
|
2417
|
-
|
|
2479
|
+
interface FontSizeData {
|
|
2418
2480
|
/** The units used for the font size. */
|
|
2419
2481
|
unit?: FontTypeWithLiterals;
|
|
2420
2482
|
/** Font size value. */
|
|
2421
2483
|
value?: number | null;
|
|
2422
2484
|
}
|
|
2423
|
-
|
|
2485
|
+
declare enum FontType {
|
|
2424
2486
|
PX = "PX",
|
|
2425
2487
|
EM = "EM"
|
|
2426
2488
|
}
|
|
2427
2489
|
/** @enumType */
|
|
2428
|
-
|
|
2429
|
-
|
|
2490
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2491
|
+
interface SpoilerData {
|
|
2430
2492
|
/** Spoiler ID. */
|
|
2431
2493
|
id?: string | null;
|
|
2432
2494
|
}
|
|
2433
|
-
|
|
2495
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2434
2496
|
/** Data for embedded Wix Bookings content. */
|
|
2435
2497
|
bookingData?: BookingData;
|
|
2436
2498
|
/** Data for embedded Wix Events content. */
|
|
@@ -2452,30 +2514,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2452
2514
|
image?: Media;
|
|
2453
2515
|
}
|
|
2454
2516
|
/** @oneof */
|
|
2455
|
-
|
|
2517
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2456
2518
|
/** Data for embedded Wix Bookings content. */
|
|
2457
2519
|
bookingData?: BookingData;
|
|
2458
2520
|
/** Data for embedded Wix Events content. */
|
|
2459
2521
|
eventData?: EventData;
|
|
2460
2522
|
}
|
|
2461
|
-
|
|
2523
|
+
declare enum AppType {
|
|
2462
2524
|
PRODUCT = "PRODUCT",
|
|
2463
2525
|
EVENT = "EVENT",
|
|
2464
2526
|
BOOKING = "BOOKING"
|
|
2465
2527
|
}
|
|
2466
2528
|
/** @enumType */
|
|
2467
|
-
|
|
2468
|
-
|
|
2529
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2530
|
+
interface BookingData {
|
|
2469
2531
|
/** Booking duration in minutes. */
|
|
2470
2532
|
durations?: string | null;
|
|
2471
2533
|
}
|
|
2472
|
-
|
|
2534
|
+
interface EventData {
|
|
2473
2535
|
/** Event schedule. */
|
|
2474
2536
|
scheduling?: string | null;
|
|
2475
2537
|
/** Event location. */
|
|
2476
2538
|
location?: string | null;
|
|
2477
2539
|
}
|
|
2478
|
-
|
|
2540
|
+
interface VideoData {
|
|
2479
2541
|
/** Styling for the video's container. */
|
|
2480
2542
|
containerData?: PluginContainerData;
|
|
2481
2543
|
/** Video details. */
|
|
@@ -2489,7 +2551,7 @@ export interface VideoData {
|
|
|
2489
2551
|
/** Video options. */
|
|
2490
2552
|
options?: PlaybackOptions;
|
|
2491
2553
|
}
|
|
2492
|
-
|
|
2554
|
+
interface PlaybackOptions {
|
|
2493
2555
|
/** Sets whether the media will automatically start playing. */
|
|
2494
2556
|
autoPlay?: boolean | null;
|
|
2495
2557
|
/** Sets whether media's will be looped. */
|
|
@@ -2497,7 +2559,7 @@ export interface PlaybackOptions {
|
|
|
2497
2559
|
/** Sets whether media's controls will be shown. */
|
|
2498
2560
|
showControls?: boolean | null;
|
|
2499
2561
|
}
|
|
2500
|
-
|
|
2562
|
+
interface EmbedData {
|
|
2501
2563
|
/** Styling for the oEmbed node's container. */
|
|
2502
2564
|
containerData?: PluginContainerData;
|
|
2503
2565
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2505,7 +2567,7 @@ export interface EmbedData {
|
|
|
2505
2567
|
/** Origin asset source. */
|
|
2506
2568
|
src?: string | null;
|
|
2507
2569
|
}
|
|
2508
|
-
|
|
2570
|
+
interface Oembed {
|
|
2509
2571
|
/** The resource type. */
|
|
2510
2572
|
type?: string | null;
|
|
2511
2573
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2537,7 +2599,7 @@ export interface Oembed {
|
|
|
2537
2599
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2538
2600
|
version?: string | null;
|
|
2539
2601
|
}
|
|
2540
|
-
|
|
2602
|
+
interface CollapsibleListData {
|
|
2541
2603
|
/** Styling for the collapsible list's container. */
|
|
2542
2604
|
containerData?: PluginContainerData;
|
|
2543
2605
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2549,7 +2611,7 @@ export interface CollapsibleListData {
|
|
|
2549
2611
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2550
2612
|
isQapageData?: boolean | null;
|
|
2551
2613
|
}
|
|
2552
|
-
|
|
2614
|
+
declare enum InitialExpandedItems {
|
|
2553
2615
|
/** First item will be expended initally */
|
|
2554
2616
|
FIRST = "FIRST",
|
|
2555
2617
|
/** All items will expended initally */
|
|
@@ -2558,16 +2620,16 @@ export declare enum InitialExpandedItems {
|
|
|
2558
2620
|
NONE = "NONE"
|
|
2559
2621
|
}
|
|
2560
2622
|
/** @enumType */
|
|
2561
|
-
|
|
2562
|
-
|
|
2623
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2624
|
+
declare enum Direction {
|
|
2563
2625
|
/** Left-to-right */
|
|
2564
2626
|
LTR = "LTR",
|
|
2565
2627
|
/** Right-to-left */
|
|
2566
2628
|
RTL = "RTL"
|
|
2567
2629
|
}
|
|
2568
2630
|
/** @enumType */
|
|
2569
|
-
|
|
2570
|
-
|
|
2631
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2632
|
+
interface TableData {
|
|
2571
2633
|
/** Styling for the table's container. */
|
|
2572
2634
|
containerData?: PluginContainerData;
|
|
2573
2635
|
/** The table's dimensions. */
|
|
@@ -2582,7 +2644,7 @@ export interface TableData {
|
|
|
2582
2644
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2583
2645
|
columnHeader?: boolean | null;
|
|
2584
2646
|
}
|
|
2585
|
-
|
|
2647
|
+
interface Dimensions {
|
|
2586
2648
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2587
2649
|
colsWidthRatio?: number[];
|
|
2588
2650
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2590,13 +2652,13 @@ export interface Dimensions {
|
|
|
2590
2652
|
/** An array representing the minimum width of each column in pixels. */
|
|
2591
2653
|
colsMinWidth?: number[];
|
|
2592
2654
|
}
|
|
2593
|
-
|
|
2655
|
+
interface TableCellData {
|
|
2594
2656
|
/** Styling for the cell's background color and text alignment. */
|
|
2595
2657
|
cellStyle?: CellStyle;
|
|
2596
2658
|
/** The cell's border colors. */
|
|
2597
2659
|
borderColors?: BorderColors;
|
|
2598
2660
|
}
|
|
2599
|
-
|
|
2661
|
+
declare enum VerticalAlignment {
|
|
2600
2662
|
/** Top alignment */
|
|
2601
2663
|
TOP = "TOP",
|
|
2602
2664
|
/** Middle alignment */
|
|
@@ -2605,8 +2667,8 @@ export declare enum VerticalAlignment {
|
|
|
2605
2667
|
BOTTOM = "BOTTOM"
|
|
2606
2668
|
}
|
|
2607
2669
|
/** @enumType */
|
|
2608
|
-
|
|
2609
|
-
|
|
2670
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2671
|
+
interface CellStyle {
|
|
2610
2672
|
/** Vertical alignment for the cell's text. */
|
|
2611
2673
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2612
2674
|
/**
|
|
@@ -2615,7 +2677,7 @@ export interface CellStyle {
|
|
|
2615
2677
|
*/
|
|
2616
2678
|
backgroundColor?: string | null;
|
|
2617
2679
|
}
|
|
2618
|
-
|
|
2680
|
+
interface BorderColors {
|
|
2619
2681
|
/**
|
|
2620
2682
|
* Left border color as a hexadecimal value.
|
|
2621
2683
|
* @format COLOR_HEX
|
|
@@ -2643,22 +2705,20 @@ export interface BorderColors {
|
|
|
2643
2705
|
*
|
|
2644
2706
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2645
2707
|
*/
|
|
2646
|
-
|
|
2708
|
+
declare enum NullValue {
|
|
2647
2709
|
/** Null value. */
|
|
2648
2710
|
NULL_VALUE = "NULL_VALUE"
|
|
2649
2711
|
}
|
|
2650
|
-
/** @enumType */
|
|
2651
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2652
2712
|
/**
|
|
2653
2713
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2654
2714
|
*
|
|
2655
2715
|
* The JSON representation for `ListValue` is JSON array.
|
|
2656
2716
|
*/
|
|
2657
|
-
|
|
2717
|
+
interface ListValue {
|
|
2658
2718
|
/** Repeated field of dynamically typed values. */
|
|
2659
2719
|
values?: any[];
|
|
2660
2720
|
}
|
|
2661
|
-
|
|
2721
|
+
interface AudioData {
|
|
2662
2722
|
/** Styling for the audio node's container. */
|
|
2663
2723
|
containerData?: PluginContainerData;
|
|
2664
2724
|
/** Audio file details. */
|
|
@@ -2674,7 +2734,7 @@ export interface AudioData {
|
|
|
2674
2734
|
/** An HTML version of the audio node. */
|
|
2675
2735
|
html?: string | null;
|
|
2676
2736
|
}
|
|
2677
|
-
|
|
2737
|
+
interface OrderedListData {
|
|
2678
2738
|
/** Indentation level from 0-4. */
|
|
2679
2739
|
indentation?: number;
|
|
2680
2740
|
/** Offset level from 0-4. */
|
|
@@ -2682,24 +2742,24 @@ export interface OrderedListData {
|
|
|
2682
2742
|
/** List start number. */
|
|
2683
2743
|
start?: number | null;
|
|
2684
2744
|
}
|
|
2685
|
-
|
|
2745
|
+
interface BulletedListData {
|
|
2686
2746
|
/** Indentation level from 0-4. */
|
|
2687
2747
|
indentation?: number;
|
|
2688
2748
|
/** Offset level from 0-4. */
|
|
2689
2749
|
offset?: number | null;
|
|
2690
2750
|
}
|
|
2691
|
-
|
|
2751
|
+
interface BlockquoteData {
|
|
2692
2752
|
/** Indentation level from 1-4. */
|
|
2693
2753
|
indentation?: number;
|
|
2694
2754
|
}
|
|
2695
|
-
|
|
2755
|
+
interface CaptionData {
|
|
2696
2756
|
textStyle?: TextStyle;
|
|
2697
2757
|
}
|
|
2698
|
-
|
|
2758
|
+
interface LayoutCellData {
|
|
2699
2759
|
/** Size of the cell in 12 columns grid. */
|
|
2700
2760
|
colSpan?: number | null;
|
|
2701
2761
|
}
|
|
2702
|
-
|
|
2762
|
+
interface Metadata {
|
|
2703
2763
|
/** Schema version. */
|
|
2704
2764
|
version?: number;
|
|
2705
2765
|
/**
|
|
@@ -2716,7 +2776,7 @@ export interface Metadata {
|
|
|
2716
2776
|
/** Object ID. */
|
|
2717
2777
|
_id?: string | null;
|
|
2718
2778
|
}
|
|
2719
|
-
|
|
2779
|
+
interface DocumentStyle {
|
|
2720
2780
|
/** Styling for H1 nodes. */
|
|
2721
2781
|
headerOne?: TextNodeStyle;
|
|
2722
2782
|
/** Styling for H2 nodes. */
|
|
@@ -2736,7 +2796,7 @@ export interface DocumentStyle {
|
|
|
2736
2796
|
/** Styling for code block nodes. */
|
|
2737
2797
|
codeBlock?: TextNodeStyle;
|
|
2738
2798
|
}
|
|
2739
|
-
|
|
2799
|
+
interface TextNodeStyle {
|
|
2740
2800
|
/** The decorations to apply to the node. */
|
|
2741
2801
|
decorations?: Decoration[];
|
|
2742
2802
|
/** Padding and background color for the node. */
|
|
@@ -2744,7 +2804,7 @@ export interface TextNodeStyle {
|
|
|
2744
2804
|
/** Line height for text in the node. */
|
|
2745
2805
|
lineHeight?: string | null;
|
|
2746
2806
|
}
|
|
2747
|
-
|
|
2807
|
+
interface Badge {
|
|
2748
2808
|
/** Badge type. */
|
|
2749
2809
|
type?: TypeWithLiterals;
|
|
2750
2810
|
/**
|
|
@@ -2753,49 +2813,50 @@ export interface Badge {
|
|
|
2753
2813
|
*/
|
|
2754
2814
|
text?: string | null;
|
|
2755
2815
|
}
|
|
2756
|
-
|
|
2816
|
+
declare enum Type {
|
|
2757
2817
|
/** Unknown badge type. */
|
|
2758
2818
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2759
|
-
/**
|
|
2760
|
-
|
|
2761
|
-
/**
|
|
2762
|
-
|
|
2763
|
-
/**
|
|
2764
|
-
|
|
2819
|
+
/** 1st priority badge type. */
|
|
2820
|
+
FIRST_PRIORITY = "FIRST_PRIORITY",
|
|
2821
|
+
/** 2nd priority badge type. */
|
|
2822
|
+
SECOND_PRIORITY = "SECOND_PRIORITY",
|
|
2823
|
+
/** 3rd priority badge type. */
|
|
2824
|
+
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2765
2825
|
}
|
|
2766
2826
|
/** @enumType */
|
|
2767
|
-
|
|
2768
|
-
|
|
2769
|
-
|
|
2827
|
+
type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2828
|
+
/** Triggered when an order is confirmed. */
|
|
2829
|
+
interface OrderConfirmed {
|
|
2830
|
+
/** Date and time the order was confirmed. */
|
|
2770
2831
|
timestamp?: Date | null;
|
|
2771
2832
|
/**
|
|
2772
|
-
* Site language when
|
|
2833
|
+
* Site language when the order was initiated.
|
|
2773
2834
|
* @format LANGUAGE
|
|
2774
2835
|
*/
|
|
2775
2836
|
language?: string | null;
|
|
2776
2837
|
/** Notifications silenced for this domain event. */
|
|
2777
2838
|
silent?: boolean | null;
|
|
2778
2839
|
/**
|
|
2779
|
-
* Locale in which
|
|
2840
|
+
* Locale in which the order was created.
|
|
2780
2841
|
* @format LANGUAGE_TAG
|
|
2781
2842
|
*/
|
|
2782
2843
|
locale?: string | null;
|
|
2783
2844
|
/**
|
|
2784
|
-
* Event ID.
|
|
2845
|
+
* Event ID to which the order belongs.
|
|
2785
2846
|
* @format GUID
|
|
2786
2847
|
*/
|
|
2787
2848
|
eventId?: string;
|
|
2788
2849
|
/** Unique order number. */
|
|
2789
2850
|
orderNumber?: string;
|
|
2790
|
-
/** Contact ID associated with
|
|
2851
|
+
/** Contact ID associated with the order. */
|
|
2791
2852
|
contactId?: string;
|
|
2792
2853
|
/**
|
|
2793
|
-
* Member ID associated with
|
|
2854
|
+
* Member ID associated with the order.
|
|
2794
2855
|
* @format GUID
|
|
2795
2856
|
*/
|
|
2796
2857
|
memberId?: string | null;
|
|
2797
2858
|
/**
|
|
2798
|
-
*
|
|
2859
|
+
* Date and time the order was created.
|
|
2799
2860
|
* @readonly
|
|
2800
2861
|
*/
|
|
2801
2862
|
created?: Date | null;
|
|
@@ -2815,17 +2876,17 @@ export interface OrderConfirmed {
|
|
|
2815
2876
|
tickets?: Ticket[];
|
|
2816
2877
|
/** Invoice. */
|
|
2817
2878
|
invoice?: Invoice;
|
|
2818
|
-
/** Reservation ID associated with
|
|
2879
|
+
/** Reservation ID associated with the order. */
|
|
2819
2880
|
reservationId?: string;
|
|
2820
2881
|
}
|
|
2821
|
-
|
|
2882
|
+
interface FormResponse {
|
|
2822
2883
|
/**
|
|
2823
2884
|
* Input values entered when filling the form.
|
|
2824
2885
|
* @maxSize 200
|
|
2825
2886
|
*/
|
|
2826
2887
|
inputValues?: InputValue[];
|
|
2827
2888
|
}
|
|
2828
|
-
|
|
2889
|
+
interface InputValue {
|
|
2829
2890
|
/**
|
|
2830
2891
|
* Input field name.
|
|
2831
2892
|
* @maxLength 100
|
|
@@ -2837,13 +2898,13 @@ export interface InputValue {
|
|
|
2837
2898
|
*/
|
|
2838
2899
|
value?: string;
|
|
2839
2900
|
/**
|
|
2840
|
-
* Multiple
|
|
2901
|
+
* Multiple input values. For example, the array is filled if several checkboxes are ticked.
|
|
2841
2902
|
* @maxSize 100
|
|
2842
2903
|
* @maxLength 5000
|
|
2843
2904
|
*/
|
|
2844
2905
|
values?: string[];
|
|
2845
2906
|
}
|
|
2846
|
-
|
|
2907
|
+
interface FormattedAddress {
|
|
2847
2908
|
/**
|
|
2848
2909
|
* One line address representation.
|
|
2849
2910
|
* @maxLength 200
|
|
@@ -2853,7 +2914,7 @@ export interface FormattedAddress {
|
|
|
2853
2914
|
address?: CommonAddress;
|
|
2854
2915
|
}
|
|
2855
2916
|
/** Physical address */
|
|
2856
|
-
|
|
2917
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
2857
2918
|
/** Street name and number. */
|
|
2858
2919
|
streetAddress?: CommonStreetAddress;
|
|
2859
2920
|
/** Main address line, usually street and number as free text. */
|
|
@@ -2873,50 +2934,50 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
2873
2934
|
addressLine2?: string | null;
|
|
2874
2935
|
}
|
|
2875
2936
|
/** @oneof */
|
|
2876
|
-
|
|
2937
|
+
interface CommonAddressStreetOneOf {
|
|
2877
2938
|
/** Street name and number. */
|
|
2878
2939
|
streetAddress?: CommonStreetAddress;
|
|
2879
2940
|
/** Main address line, usually street and number as free text. */
|
|
2880
2941
|
addressLine?: string | null;
|
|
2881
2942
|
}
|
|
2882
|
-
|
|
2943
|
+
interface CommonStreetAddress {
|
|
2883
2944
|
/** Street number. */
|
|
2884
2945
|
number?: string;
|
|
2885
2946
|
/** Street name. */
|
|
2886
2947
|
name?: string;
|
|
2887
2948
|
}
|
|
2888
|
-
|
|
2949
|
+
interface CommonAddressLocation {
|
|
2889
2950
|
/** Address latitude. */
|
|
2890
2951
|
latitude?: number | null;
|
|
2891
2952
|
/** Address longitude. */
|
|
2892
2953
|
longitude?: number | null;
|
|
2893
2954
|
}
|
|
2894
|
-
|
|
2955
|
+
interface CommonSubdivision {
|
|
2895
2956
|
/** Short subdivision code. */
|
|
2896
2957
|
code?: string;
|
|
2897
2958
|
/** Subdivision full name. */
|
|
2898
2959
|
name?: string;
|
|
2899
2960
|
}
|
|
2900
2961
|
/** Subdivision Concordance values */
|
|
2901
|
-
|
|
2962
|
+
interface StandardDetails {
|
|
2902
2963
|
/**
|
|
2903
2964
|
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
2904
2965
|
* @maxLength 20
|
|
2905
2966
|
*/
|
|
2906
2967
|
iso31662?: string | null;
|
|
2907
2968
|
}
|
|
2908
|
-
|
|
2909
|
-
/** Order status not available for this request fieldset. */
|
|
2969
|
+
declare enum OrderStatus {
|
|
2970
|
+
/** Order status is not available for this request fieldset. */
|
|
2910
2971
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
2911
|
-
/** Order is confirmed
|
|
2972
|
+
/** Order is confirmed, no payment is required. */
|
|
2912
2973
|
FREE = "FREE",
|
|
2913
|
-
/** Order
|
|
2974
|
+
/** Order was paid, but the payment gateway suspended the payment. */
|
|
2914
2975
|
PENDING = "PENDING",
|
|
2915
|
-
/** Order is paid
|
|
2976
|
+
/** Order is paid. */
|
|
2916
2977
|
PAID = "PAID",
|
|
2917
|
-
/** Order is confirmed but
|
|
2978
|
+
/** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
2918
2979
|
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
2919
|
-
/** Order is awaiting payment at the cashier. */
|
|
2980
|
+
/** Order is awaiting for payment at the cashier. */
|
|
2920
2981
|
INITIATED = "INITIATED",
|
|
2921
2982
|
/** Order is canceled. */
|
|
2922
2983
|
CANCELED = "CANCELED",
|
|
@@ -2930,8 +2991,8 @@ export declare enum OrderStatus {
|
|
|
2930
2991
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
2931
2992
|
}
|
|
2932
2993
|
/** @enumType */
|
|
2933
|
-
|
|
2934
|
-
|
|
2994
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
2995
|
+
interface Ticket {
|
|
2935
2996
|
/** Unique issued ticket number. */
|
|
2936
2997
|
ticketNumber?: string;
|
|
2937
2998
|
/**
|
|
@@ -2979,11 +3040,11 @@ export interface Ticket {
|
|
|
2979
3040
|
/** Whether ticket is canceled. */
|
|
2980
3041
|
canceled?: boolean | null;
|
|
2981
3042
|
}
|
|
2982
|
-
|
|
2983
|
-
/** Time of check-in */
|
|
3043
|
+
interface CheckIn {
|
|
3044
|
+
/** Time of check-in. */
|
|
2984
3045
|
created?: Date | null;
|
|
2985
3046
|
}
|
|
2986
|
-
|
|
3047
|
+
interface OnlineConferencingLogin {
|
|
2987
3048
|
/**
|
|
2988
3049
|
* Link URL to the online conference.
|
|
2989
3050
|
* @format WEB_URL
|
|
@@ -2996,21 +3057,21 @@ export interface OnlineConferencingLogin {
|
|
|
2996
3057
|
*/
|
|
2997
3058
|
password?: string | null;
|
|
2998
3059
|
}
|
|
2999
|
-
|
|
3060
|
+
interface Invoice {
|
|
3000
3061
|
items?: Item[];
|
|
3001
3062
|
/**
|
|
3002
3063
|
* Total cart amount.
|
|
3003
3064
|
* @deprecated
|
|
3004
3065
|
*/
|
|
3005
3066
|
total?: Money;
|
|
3006
|
-
/** Discount applied to cart. */
|
|
3067
|
+
/** Discount applied to a cart. */
|
|
3007
3068
|
discount?: Discount;
|
|
3008
|
-
/** Tax applied to cart. */
|
|
3069
|
+
/** Tax applied to a cart. */
|
|
3009
3070
|
tax?: Tax;
|
|
3010
3071
|
/** Total cart amount before discount, tax, and fees. */
|
|
3011
3072
|
subTotal?: Money;
|
|
3012
3073
|
/**
|
|
3013
|
-
* Total amount of cart after discount, tax, and fees.
|
|
3074
|
+
* Total amount of a cart after discount, tax, and fees.
|
|
3014
3075
|
* Grand total is calculated in the following order:
|
|
3015
3076
|
* 1. Total prices of all items in the cart are calculated.
|
|
3016
3077
|
* 2. Discount is subtracted from the cart (if applicable).
|
|
@@ -3025,10 +3086,10 @@ export interface Invoice {
|
|
|
3025
3086
|
fees?: Fee[];
|
|
3026
3087
|
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
3027
3088
|
revenue?: Money;
|
|
3028
|
-
/**
|
|
3089
|
+
/** Invoice preview URL. Only returned if the order is paid. */
|
|
3029
3090
|
previewUrl?: string | null;
|
|
3030
3091
|
}
|
|
3031
|
-
|
|
3092
|
+
interface Item {
|
|
3032
3093
|
/**
|
|
3033
3094
|
* Unique line item ID.
|
|
3034
3095
|
* @format GUID
|
|
@@ -3056,10 +3117,10 @@ export interface Item {
|
|
|
3056
3117
|
*/
|
|
3057
3118
|
fees?: Fee[];
|
|
3058
3119
|
}
|
|
3059
|
-
|
|
3120
|
+
interface Discount {
|
|
3060
3121
|
/** Total discount amount. */
|
|
3061
3122
|
amount?: Money;
|
|
3062
|
-
/** Total
|
|
3123
|
+
/** Total sum after the discount. */
|
|
3063
3124
|
afterDiscount?: Money;
|
|
3064
3125
|
/**
|
|
3065
3126
|
* Discount coupon code.
|
|
@@ -3079,7 +3140,7 @@ export interface Discount {
|
|
|
3079
3140
|
/** Discount items. */
|
|
3080
3141
|
discounts?: DiscountItem[];
|
|
3081
3142
|
}
|
|
3082
|
-
|
|
3143
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
3083
3144
|
/** Coupon discount. */
|
|
3084
3145
|
coupon?: CouponDiscount;
|
|
3085
3146
|
/** Pricing plan discount. */
|
|
@@ -3088,32 +3149,32 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
3088
3149
|
amount?: Money;
|
|
3089
3150
|
}
|
|
3090
3151
|
/** @oneof */
|
|
3091
|
-
|
|
3152
|
+
interface DiscountItemDiscountOneOf {
|
|
3092
3153
|
/** Coupon discount. */
|
|
3093
3154
|
coupon?: CouponDiscount;
|
|
3094
3155
|
/** Pricing plan discount. */
|
|
3095
3156
|
paidPlan?: PaidPlanDiscount;
|
|
3096
3157
|
}
|
|
3097
|
-
|
|
3098
|
-
/** Discount coupon name. */
|
|
3158
|
+
interface CouponDiscount {
|
|
3159
|
+
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
3099
3160
|
name?: string;
|
|
3100
|
-
/** Discount coupon code. */
|
|
3161
|
+
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
3101
3162
|
code?: string;
|
|
3102
|
-
/** Discount coupon ID. */
|
|
3163
|
+
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
3103
3164
|
couponId?: string;
|
|
3104
3165
|
}
|
|
3105
|
-
|
|
3166
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
3106
3167
|
/** Discount by percentage applied to tickets. */
|
|
3107
3168
|
percentDiscount?: PercentDiscount;
|
|
3108
3169
|
/** Name of pricing plan. */
|
|
3109
3170
|
name?: string;
|
|
3110
3171
|
}
|
|
3111
3172
|
/** @oneof */
|
|
3112
|
-
|
|
3173
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
3113
3174
|
/** Discount by percentage applied to tickets. */
|
|
3114
3175
|
percentDiscount?: PercentDiscount;
|
|
3115
3176
|
}
|
|
3116
|
-
|
|
3177
|
+
interface PercentDiscount {
|
|
3117
3178
|
/**
|
|
3118
3179
|
* Percent rate.
|
|
3119
3180
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -3122,7 +3183,7 @@ export interface PercentDiscount {
|
|
|
3122
3183
|
/** Number of discounted tickets. */
|
|
3123
3184
|
quantityDiscounted?: number;
|
|
3124
3185
|
}
|
|
3125
|
-
|
|
3186
|
+
interface Tax {
|
|
3126
3187
|
/** Tax type. */
|
|
3127
3188
|
type?: TaxTypeWithLiterals;
|
|
3128
3189
|
/**
|
|
@@ -3140,7 +3201,7 @@ export interface Tax {
|
|
|
3140
3201
|
/** Total tax amount. */
|
|
3141
3202
|
amount?: Money;
|
|
3142
3203
|
}
|
|
3143
|
-
|
|
3204
|
+
interface Fee {
|
|
3144
3205
|
/** Fee identifier. */
|
|
3145
3206
|
name?: FeeNameWithLiterals;
|
|
3146
3207
|
/** How fee is calculated. */
|
|
@@ -3154,24 +3215,24 @@ export interface Fee {
|
|
|
3154
3215
|
/** Total amount of fee charges. */
|
|
3155
3216
|
amount?: Money;
|
|
3156
3217
|
}
|
|
3157
|
-
|
|
3218
|
+
declare enum FeeName {
|
|
3158
3219
|
/** Wix ticket service fee charges applied to the line item. */
|
|
3159
3220
|
WIX_FEE = "WIX_FEE"
|
|
3160
3221
|
}
|
|
3161
3222
|
/** @enumType */
|
|
3162
|
-
|
|
3163
|
-
|
|
3223
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
3224
|
+
declare enum FeeType {
|
|
3164
3225
|
/** Fee is added to the ticket price at checkout. */
|
|
3165
3226
|
FEE_ADDED = "FEE_ADDED",
|
|
3166
|
-
/** Seller absorbs the fee. It
|
|
3227
|
+
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
3167
3228
|
FEE_INCLUDED = "FEE_INCLUDED",
|
|
3168
3229
|
/** Fee is added to the ticket price at checkout. */
|
|
3169
3230
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3170
3231
|
}
|
|
3171
3232
|
/** @enumType */
|
|
3172
|
-
|
|
3233
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
3173
3234
|
/** Produced if a buyer email was added to the existing order */
|
|
3174
|
-
|
|
3235
|
+
interface OrderEmailAdded {
|
|
3175
3236
|
/** Order updated timestamp in ISO UTC format. */
|
|
3176
3237
|
timestamp?: Date | null;
|
|
3177
3238
|
/**
|
|
@@ -3255,7 +3316,7 @@ export interface OrderEmailAdded {
|
|
|
3255
3316
|
*/
|
|
3256
3317
|
reservationId?: string;
|
|
3257
3318
|
}
|
|
3258
|
-
|
|
3319
|
+
interface EventCanceled {
|
|
3259
3320
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3260
3321
|
timestamp?: Date | null;
|
|
3261
3322
|
/**
|
|
@@ -3273,7 +3334,7 @@ export interface EventCanceled {
|
|
|
3273
3334
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3274
3335
|
hasGuests?: boolean | null;
|
|
3275
3336
|
}
|
|
3276
|
-
|
|
3337
|
+
interface EventReminder {
|
|
3277
3338
|
/** Reminder timestamp in ISO UTC format. */
|
|
3278
3339
|
timestamp?: Date | null;
|
|
3279
3340
|
/**
|
|
@@ -3301,7 +3362,7 @@ export interface EventReminder {
|
|
|
3301
3362
|
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
3302
3363
|
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
3303
3364
|
*/
|
|
3304
|
-
|
|
3365
|
+
interface TimeDuration {
|
|
3305
3366
|
/** Number of days. */
|
|
3306
3367
|
days?: number;
|
|
3307
3368
|
/**
|
|
@@ -3315,23 +3376,24 @@ export interface TimeDuration {
|
|
|
3315
3376
|
*/
|
|
3316
3377
|
minutes?: number;
|
|
3317
3378
|
}
|
|
3318
|
-
|
|
3319
|
-
|
|
3379
|
+
/** Triggered when an order is paid. */
|
|
3380
|
+
interface OrderPaid {
|
|
3381
|
+
/** Date and time the order was paid. */
|
|
3320
3382
|
timestamp?: Date | null;
|
|
3321
3383
|
/**
|
|
3322
|
-
* Site language when
|
|
3384
|
+
* Site language when the order was initiated.
|
|
3323
3385
|
* @format LANGUAGE
|
|
3324
3386
|
*/
|
|
3325
3387
|
language?: string | null;
|
|
3326
3388
|
/** Notifications silenced for this domain event. */
|
|
3327
3389
|
silent?: boolean | null;
|
|
3328
3390
|
/**
|
|
3329
|
-
* Locale in which
|
|
3391
|
+
* Locale in which the order was created.
|
|
3330
3392
|
* @format LANGUAGE_TAG
|
|
3331
3393
|
*/
|
|
3332
3394
|
locale?: string | null;
|
|
3333
3395
|
/**
|
|
3334
|
-
* Event ID.
|
|
3396
|
+
* Event ID to which the order belongs.
|
|
3335
3397
|
* @format GUID
|
|
3336
3398
|
*/
|
|
3337
3399
|
eventId?: string;
|
|
@@ -3350,7 +3412,7 @@ export interface OrderPaid {
|
|
|
3350
3412
|
*/
|
|
3351
3413
|
memberId?: string | null;
|
|
3352
3414
|
/**
|
|
3353
|
-
*
|
|
3415
|
+
* Date and time the order was created.
|
|
3354
3416
|
* @readonly
|
|
3355
3417
|
*/
|
|
3356
3418
|
created?: Date | null;
|
|
@@ -3386,7 +3448,7 @@ export interface OrderPaid {
|
|
|
3386
3448
|
/** Invoice. */
|
|
3387
3449
|
invoice?: Invoice;
|
|
3388
3450
|
}
|
|
3389
|
-
|
|
3451
|
+
interface TicketPdfResolved {
|
|
3390
3452
|
/**
|
|
3391
3453
|
* Optional order number
|
|
3392
3454
|
* @maxLength 36
|
|
@@ -3410,7 +3472,7 @@ export interface TicketPdfResolved {
|
|
|
3410
3472
|
*/
|
|
3411
3473
|
documentId?: string | null;
|
|
3412
3474
|
}
|
|
3413
|
-
|
|
3475
|
+
interface TicketPdfResolveDelayed {
|
|
3414
3476
|
/**
|
|
3415
3477
|
* Optional order number
|
|
3416
3478
|
* @maxLength 36
|
|
@@ -3427,9 +3489,10 @@ export interface TicketPdfResolveDelayed {
|
|
|
3427
3489
|
*/
|
|
3428
3490
|
documentId?: string | null;
|
|
3429
3491
|
}
|
|
3430
|
-
|
|
3492
|
+
/** Triggered when an order is canceled. */
|
|
3493
|
+
interface OrderCanceled {
|
|
3431
3494
|
/**
|
|
3432
|
-
* Event ID.
|
|
3495
|
+
* Event ID to which the order belongs.
|
|
3433
3496
|
* @format GUID
|
|
3434
3497
|
*/
|
|
3435
3498
|
eventId?: string;
|
|
@@ -3439,12 +3502,12 @@ export interface OrderCanceled {
|
|
|
3439
3502
|
*/
|
|
3440
3503
|
orderNumber?: string;
|
|
3441
3504
|
/**
|
|
3442
|
-
* Reservation ID associated with
|
|
3505
|
+
* Reservation ID associated with the order.
|
|
3443
3506
|
* @format GUID
|
|
3444
3507
|
*/
|
|
3445
3508
|
reservationId?: string;
|
|
3446
3509
|
/**
|
|
3447
|
-
* Contact ID associated with
|
|
3510
|
+
* Contact ID associated with the order.
|
|
3448
3511
|
* @maxLength 36
|
|
3449
3512
|
*/
|
|
3450
3513
|
contactId?: string;
|
|
@@ -3468,7 +3531,7 @@ export interface OrderCanceled {
|
|
|
3468
3531
|
/** Invoice. */
|
|
3469
3532
|
invoice?: Invoice;
|
|
3470
3533
|
}
|
|
3471
|
-
|
|
3534
|
+
interface EventEnded {
|
|
3472
3535
|
/** Event end timestamp in ISO UTC format. */
|
|
3473
3536
|
timestamp?: Date | null;
|
|
3474
3537
|
/**
|
|
@@ -3479,7 +3542,7 @@ export interface EventEnded {
|
|
|
3479
3542
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3480
3543
|
hasGuests?: boolean | null;
|
|
3481
3544
|
}
|
|
3482
|
-
|
|
3545
|
+
interface EventStarted {
|
|
3483
3546
|
/** Event start timestamp in ISO UTC format. */
|
|
3484
3547
|
timestamp?: Date | null;
|
|
3485
3548
|
/**
|
|
@@ -3490,26 +3553,26 @@ export interface EventStarted {
|
|
|
3490
3553
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3491
3554
|
hasGuests?: boolean | null;
|
|
3492
3555
|
}
|
|
3493
|
-
|
|
3556
|
+
interface ResolveNotificationConfigRequest {
|
|
3494
3557
|
/**
|
|
3495
3558
|
* Id of the NotificationConfig to retrieve
|
|
3496
3559
|
* @format GUID
|
|
3497
3560
|
*/
|
|
3498
3561
|
notificationConfigId: string;
|
|
3499
3562
|
}
|
|
3500
|
-
|
|
3563
|
+
interface ResolveNotificationConfigResponse {
|
|
3501
3564
|
/** The retrieved NotificationConfig */
|
|
3502
3565
|
notificationConfig?: NotificationConfig;
|
|
3503
3566
|
}
|
|
3504
|
-
|
|
3567
|
+
interface UpsertNotificationConfigRequest {
|
|
3505
3568
|
/** NotificationConfig to be upserted */
|
|
3506
3569
|
notificationConfig: NotificationConfig;
|
|
3507
3570
|
}
|
|
3508
|
-
|
|
3571
|
+
interface UpsertNotificationConfigResponse {
|
|
3509
3572
|
/** The upserted NotificationConfig */
|
|
3510
3573
|
notificationConfig?: NotificationConfig;
|
|
3511
3574
|
}
|
|
3512
|
-
|
|
3575
|
+
interface ResolveEmailNotificationConfigRequest {
|
|
3513
3576
|
/**
|
|
3514
3577
|
* Id of the NotificationConfig to retrieve
|
|
3515
3578
|
* @format GUID
|
|
@@ -3518,11 +3581,11 @@ export interface ResolveEmailNotificationConfigRequest {
|
|
|
3518
3581
|
/** Notification type */
|
|
3519
3582
|
notificationType?: EmailNotificationTypeWithLiterals;
|
|
3520
3583
|
}
|
|
3521
|
-
|
|
3584
|
+
interface ResolveEmailNotificationConfigResponse {
|
|
3522
3585
|
/** The retrieved EmailNotificationConfig */
|
|
3523
3586
|
emailNotificationConfig?: EmailNotificationConfig;
|
|
3524
3587
|
}
|
|
3525
|
-
|
|
3588
|
+
interface EventDeleted {
|
|
3526
3589
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3527
3590
|
timestamp?: Date | null;
|
|
3528
3591
|
/**
|
|
@@ -3538,7 +3601,7 @@ export interface EventDeleted {
|
|
|
3538
3601
|
*/
|
|
3539
3602
|
userId?: string | null;
|
|
3540
3603
|
}
|
|
3541
|
-
|
|
3604
|
+
interface EventCopied {
|
|
3542
3605
|
/** Event created timestamp in ISO UTC format. */
|
|
3543
3606
|
timestamp?: Date | null;
|
|
3544
3607
|
/**
|
|
@@ -3576,7 +3639,7 @@ export interface EventCopied {
|
|
|
3576
3639
|
*/
|
|
3577
3640
|
ticketDefinitions?: Record<string, string>;
|
|
3578
3641
|
}
|
|
3579
|
-
|
|
3642
|
+
interface MessageEnvelope {
|
|
3580
3643
|
/**
|
|
3581
3644
|
* App instance ID.
|
|
3582
3645
|
* @format GUID
|
|
@@ -3592,7 +3655,7 @@ export interface MessageEnvelope {
|
|
|
3592
3655
|
/** Stringify payload. */
|
|
3593
3656
|
data?: string;
|
|
3594
3657
|
}
|
|
3595
|
-
|
|
3658
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3596
3659
|
/**
|
|
3597
3660
|
* ID of a site visitor that has not logged in to the site.
|
|
3598
3661
|
* @format GUID
|
|
@@ -3617,7 +3680,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3617
3680
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3618
3681
|
}
|
|
3619
3682
|
/** @oneof */
|
|
3620
|
-
|
|
3683
|
+
interface IdentificationDataIdOneOf {
|
|
3621
3684
|
/**
|
|
3622
3685
|
* ID of a site visitor that has not logged in to the site.
|
|
3623
3686
|
* @format GUID
|
|
@@ -3639,7 +3702,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3639
3702
|
*/
|
|
3640
3703
|
appId?: string;
|
|
3641
3704
|
}
|
|
3642
|
-
|
|
3705
|
+
declare enum WebhookIdentityType {
|
|
3643
3706
|
UNKNOWN = "UNKNOWN",
|
|
3644
3707
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3645
3708
|
MEMBER = "MEMBER",
|
|
@@ -3647,8 +3710,8 @@ export declare enum WebhookIdentityType {
|
|
|
3647
3710
|
APP = "APP"
|
|
3648
3711
|
}
|
|
3649
3712
|
/** @enumType */
|
|
3650
|
-
|
|
3651
|
-
|
|
3713
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3714
|
+
interface BaseEventMetadata {
|
|
3652
3715
|
/**
|
|
3653
3716
|
* App instance ID.
|
|
3654
3717
|
* @format GUID
|
|
@@ -3662,26 +3725,22 @@ export interface BaseEventMetadata {
|
|
|
3662
3725
|
/** The identification type and identity data. */
|
|
3663
3726
|
identity?: IdentificationData;
|
|
3664
3727
|
}
|
|
3665
|
-
|
|
3666
|
-
/**
|
|
3667
|
-
* Unique event ID.
|
|
3668
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3669
|
-
*/
|
|
3728
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3729
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3670
3730
|
_id?: string;
|
|
3671
3731
|
/**
|
|
3672
|
-
*
|
|
3673
|
-
*
|
|
3732
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3733
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3674
3734
|
*/
|
|
3675
3735
|
entityFqdn?: string;
|
|
3676
3736
|
/**
|
|
3677
|
-
*
|
|
3678
|
-
*
|
|
3679
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3737
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3738
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3680
3739
|
*/
|
|
3681
3740
|
slug?: string;
|
|
3682
3741
|
/** ID of the entity associated with the event. */
|
|
3683
3742
|
entityId?: string;
|
|
3684
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
3743
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3685
3744
|
eventTime?: Date | null;
|
|
3686
3745
|
/**
|
|
3687
3746
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -3691,78 +3750,20 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
3691
3750
|
/** If present, indicates the action that triggered the event. */
|
|
3692
3751
|
originatedFrom?: string | null;
|
|
3693
3752
|
/**
|
|
3694
|
-
* A sequence number
|
|
3695
|
-
*
|
|
3696
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3697
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3698
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3699
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3753
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3754
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3700
3755
|
*/
|
|
3701
3756
|
entityEventSequence?: string | null;
|
|
3702
3757
|
}
|
|
3703
|
-
|
|
3758
|
+
interface NotificationConfigCreatedEnvelope {
|
|
3704
3759
|
entity: NotificationConfig;
|
|
3705
3760
|
metadata: EventMetadata;
|
|
3706
3761
|
}
|
|
3707
|
-
|
|
3708
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3709
|
-
* @permissionScope Manage Events - all permissions
|
|
3710
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3711
|
-
* @permissionScope Manage Events
|
|
3712
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3713
|
-
* @permissionScope Read Events
|
|
3714
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3715
|
-
* @permissionScope Manage Guest List
|
|
3716
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3717
|
-
* @permissionScope Manage Events
|
|
3718
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3719
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3720
|
-
* @webhook
|
|
3721
|
-
* @eventType wix.events.notifications.v2.notification_config_created
|
|
3722
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3723
|
-
* @slug created
|
|
3724
|
-
* @documentationMaturity preview
|
|
3725
|
-
*/
|
|
3726
|
-
export declare function onNotificationConfigCreated(handler: (event: NotificationConfigCreatedEnvelope) => void | Promise<void>): void;
|
|
3727
|
-
export interface NotificationConfigUpdatedEnvelope {
|
|
3762
|
+
interface NotificationConfigUpdatedEnvelope {
|
|
3728
3763
|
entity: NotificationConfig;
|
|
3729
3764
|
metadata: EventMetadata;
|
|
3730
3765
|
}
|
|
3731
|
-
|
|
3732
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3733
|
-
* @permissionScope Manage Events - all permissions
|
|
3734
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3735
|
-
* @permissionScope Manage Events
|
|
3736
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3737
|
-
* @permissionScope Read Events
|
|
3738
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3739
|
-
* @permissionScope Manage Guest List
|
|
3740
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3741
|
-
* @permissionScope Manage Events
|
|
3742
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3743
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3744
|
-
* @webhook
|
|
3745
|
-
* @eventType wix.events.notifications.v2.notification_config_updated
|
|
3746
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3747
|
-
* @slug updated
|
|
3748
|
-
* @documentationMaturity preview
|
|
3749
|
-
*/
|
|
3750
|
-
export declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
|
|
3751
|
-
type NotificationConfigNonNullablePaths = `rsvpConfirmation.notificationType` | `rsvpConfirmation.reminderTime` | `newSpotsAvailable.notificationType` | `newSpotsAvailable.reminderTime` | `eventCancelation.notificationType` | `eventCancelation.reminderTime` | `upcomingEventReminder.notificationType` | `upcomingEventReminder.reminderTime` | `orderConfirmation.notificationType` | `orderConfirmation.reminderTime` | `ticketConfirmation.notificationType` | `ticketConfirmation.reminderTime` | `invoice.notificationType` | `invoice.reminderTime` | `orderConfirmationWithTicketsLink.notificationType` | `orderConfirmationWithTicketsLink.reminderTime`;
|
|
3752
|
-
/**
|
|
3753
|
-
* Triggers notification
|
|
3754
|
-
* @public
|
|
3755
|
-
* @documentationMaturity preview
|
|
3756
|
-
* @requiredField guests
|
|
3757
|
-
* @requiredField notification
|
|
3758
|
-
* @permissionId WIX_EVENTS.MANAGE
|
|
3759
|
-
* @permissionScope Manage Events
|
|
3760
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3761
|
-
* @applicableIdentity APP
|
|
3762
|
-
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
3763
|
-
*/
|
|
3764
|
-
export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
|
|
3765
|
-
export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3766
|
+
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3766
3767
|
/** Email notification type */
|
|
3767
3768
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3768
3769
|
/** Push notification type */
|
|
@@ -3777,14 +3778,14 @@ export interface TriggerNotificationOptions extends TriggerNotificationOptionsNo
|
|
|
3777
3778
|
ticketGuest?: TicketGuest;
|
|
3778
3779
|
}
|
|
3779
3780
|
/** @oneof */
|
|
3780
|
-
|
|
3781
|
+
interface TriggerNotificationOptionsNotificationOneOf {
|
|
3781
3782
|
/** Email notification type */
|
|
3782
3783
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3783
3784
|
/** Push notification type */
|
|
3784
3785
|
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
3785
3786
|
}
|
|
3786
3787
|
/** @oneof */
|
|
3787
|
-
|
|
3788
|
+
interface TriggerNotificationOptionsGuestsOneOf {
|
|
3788
3789
|
/** Rsvp guest info */
|
|
3789
3790
|
rsvpGuest?: RsvpGuest;
|
|
3790
3791
|
/** Order guest info */
|
|
@@ -3794,52 +3795,7 @@ export interface TriggerNotificationOptionsGuestsOneOf {
|
|
|
3794
3795
|
/** Ticket guests info */
|
|
3795
3796
|
ticketGuest?: TicketGuest;
|
|
3796
3797
|
}
|
|
3797
|
-
|
|
3798
|
-
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
3799
|
-
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
3800
|
-
* @public
|
|
3801
|
-
* @documentationMaturity preview
|
|
3802
|
-
* @requiredField notificationConfigId
|
|
3803
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3804
|
-
* @permissionScope Read Events - all read permissions
|
|
3805
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3806
|
-
* @permissionScope Manage Events - all permissions
|
|
3807
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3808
|
-
* @permissionScope Manage Events
|
|
3809
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3810
|
-
* @permissionScope Read Events
|
|
3811
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3812
|
-
* @permissionScope Manage Guest List
|
|
3813
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3814
|
-
* @permissionScope Manage Events
|
|
3815
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3816
|
-
* @applicableIdentity APP
|
|
3817
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.ResolveNotificationConfig
|
|
3818
|
-
*/
|
|
3819
|
-
export declare function resolveNotificationConfig(notificationConfigId: string): Promise<NonNullablePaths<ResolveNotificationConfigResponse, {
|
|
3820
|
-
[P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
|
|
3821
|
-
}[NotificationConfigNonNullablePaths]>>;
|
|
3822
|
-
/**
|
|
3823
|
-
* Upsert a NotificationConfig
|
|
3824
|
-
* @param _id - Event ID.
|
|
3825
|
-
* @public
|
|
3826
|
-
* @documentationMaturity preview
|
|
3827
|
-
* @requiredField _id
|
|
3828
|
-
* @requiredField notificationConfig
|
|
3829
|
-
* @permissionId WIX_EVENTS.UPDATE_NOTIFICATION_CONFIG
|
|
3830
|
-
* @permissionScope Manage Events - all permissions
|
|
3831
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3832
|
-
* @permissionScope Manage Events
|
|
3833
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3834
|
-
* @permissionScope Manage Events
|
|
3835
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3836
|
-
* @applicableIdentity APP
|
|
3837
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.UpsertNotificationConfig
|
|
3838
|
-
*/
|
|
3839
|
-
export declare function upsertNotificationConfig(_id: string, notificationConfig: UpsertNotificationConfig): Promise<NonNullablePaths<UpsertNotificationConfigResponse, {
|
|
3840
|
-
[P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
|
|
3841
|
-
}[NotificationConfigNonNullablePaths]>>;
|
|
3842
|
-
export interface UpsertNotificationConfig {
|
|
3798
|
+
interface UpsertNotificationConfig {
|
|
3843
3799
|
/**
|
|
3844
3800
|
* Event ID.
|
|
3845
3801
|
* @format GUID
|
|
@@ -3878,4 +3834,5 @@ export interface UpsertNotificationConfig {
|
|
|
3878
3834
|
/** Order confirmation with tickets link. */
|
|
3879
3835
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
3880
3836
|
}
|
|
3881
|
-
|
|
3837
|
+
|
|
3838
|
+
export { OrderStatus as $, Alignment as A, ButtonDataType as B, ConferenceType as C, PollLayoutDirection as D, EmailNotificationType as E, BackgroundType as F, GIFType as G, DecorationType as H, InputControlType as I, FontType as J, AppType as K, LocationType as L, MapType as M, type NotificationConfigCreatedEnvelope as N, Orientation as O, PushNotificationType as P, InitialExpandedItems as Q, type ResolveNotificationConfigResponse as R, SubdivisionType as S, type TriggerNotificationOptions as T, type UpsertNotificationConfig as U, VisitorType as V, WidthType as W, Direction as X, VerticalAlignment as Y, NullValue as Z, Type as _, type UpsertNotificationConfigResponse as a, type RsvpSummary as a$, FeeName as a0, FeeType as a1, WebhookIdentityType as a2, type NotificationConfig as a3, type EmailNotificationConfig as a4, type EmailTemplate as a5, type Link as a6, type TriggerNotificationRequest as a7, type TriggerNotificationRequestNotificationOneOf as a8, type TriggerNotificationRequestGuestsOneOf as a9, type Registration as aA, type RsvpCollection as aB, type RsvpCollectionConfig as aC, type Ticketing as aD, type TicketingConfig as aE, type TaxConfig as aF, type Money as aG, type ExternalEvent as aH, type CalendarLinks as aI, type SiteUrl as aJ, type Form as aK, type InputControl as aL, type Input as aM, type OptionSelection as aN, type OptionSelectionSelectedOptionOneOf as aO, type Label as aP, type FormMessages as aQ, type RsvpFormMessages as aR, type PositiveResponseConfirmation as aS, type NegativeResponseConfirmation as aT, type Positive as aU, type Negative as aV, type CheckoutFormMessages as aW, type ResponseConfirmation as aX, type RegistrationClosedMessages as aY, type TicketsUnavailableMessages as aZ, type Dashboard as a_, type RsvpGuest as aa, type OrderGuest as ab, type EventGuests as ac, type TicketGuest as ad, type TriggerNotificationResponse as ae, type DomainEvent as af, type DomainEventBodyOneOf as ag, type EntityCreatedEvent as ah, type RestoreInfo as ai, type EntityUpdatedEvent as aj, type EntityDeletedEvent as ak, type ActionEvent as al, type Empty as am, type EventUpdated as an, type Location as ao, type MapCoordinates as ap, type Address as aq, type AddressStreetOneOf as ar, type StreetAddress as as, type AddressLocation as at, type Subdivision as au, type ScheduleConfig as av, type Recurrences as aw, type Occurrence as ax, type Event as ay, type Scheduling as az, type NotificationConfigUpdatedEnvelope as b, type Permissions as b$, type TicketingSummary as b0, type GuestListConfig as b1, type Feed as b2, type OnlineConferencing as b3, type OnlineConferencingConfig as b4, type OnlineConferencingSession as b5, type SeoSettings as b6, type SeoSchema as b7, type Keyword as b8, type Tag as b9, type FileSource as bA, type FileSourceDataOneOf as bB, type PDFSettings as bC, type GalleryData as bD, type Media as bE, type Image as bF, type Video as bG, type GalleryDataItem as bH, type GalleryDataItemDataOneOf as bI, type GalleryOptions as bJ, type Layout as bK, type ItemStyle as bL, type Thumbnails as bM, type GIFData as bN, type GIF as bO, type HeadingData as bP, type HTMLData as bQ, type HTMLDataDataOneOf as bR, type ImageData as bS, type StylesBorder as bT, type ImageDataStyles as bU, type LinkPreviewData as bV, type LinkPreviewDataStyles as bW, type MapData as bX, type MapSettings as bY, type ParagraphData as bZ, type PollData as b_, type Settings as ba, type Agenda as bb, type Category as bc, type CategoryCounts as bd, type EventDisplaySettings as be, type LabellingSettings as bf, type RichContent as bg, type Node as bh, type NodeDataOneOf as bi, type NodeStyle as bj, type ButtonData as bk, type Border as bl, type Colors as bm, type PluginContainerData as bn, type PluginContainerDataWidth as bo, type PluginContainerDataWidthDataOneOf as bp, type Spoiler as bq, type Height as br, type Styles as bs, type V1Link as bt, type V1LinkDataOneOf as bu, type Rel as bv, type CodeBlockData as bw, type TextStyle as bx, type DividerData as by, type FileData as bz, EmailNotificationReminderTime as c, type DiscountItemDiscountOneOf as c$, type Option as c0, type PollSettings as c1, type PollLayout as c2, type OptionLayout as c3, type Gradient as c4, type Background as c5, type BackgroundBackgroundOneOf as c6, type PollDesign as c7, type OptionDesign as c8, type Poll as c9, type AudioData as cA, type OrderedListData as cB, type BulletedListData as cC, type BlockquoteData as cD, type CaptionData as cE, type LayoutCellData as cF, type Metadata as cG, type DocumentStyle as cH, type TextNodeStyle as cI, type Badge as cJ, type OrderConfirmed as cK, type FormResponse as cL, type InputValue as cM, type FormattedAddress as cN, type CommonAddress as cO, type CommonAddressStreetOneOf as cP, type CommonStreetAddress as cQ, type CommonAddressLocation as cR, type CommonSubdivision as cS, type StandardDetails as cT, type Ticket as cU, type CheckIn as cV, type OnlineConferencingLogin as cW, type Invoice as cX, type Item as cY, type Discount as cZ, type DiscountItem as c_, type PollDataLayout as ca, type Design as cb, type TextData as cc, type Decoration as cd, type DecorationDataOneOf as ce, type AnchorData as cf, type ColorData as cg, type LinkData as ch, type MentionData as ci, type FontSizeData as cj, type SpoilerData as ck, type AppEmbedData as cl, type AppEmbedDataAppDataOneOf as cm, type BookingData as cn, type EventData as co, type VideoData as cp, type PlaybackOptions as cq, type EmbedData as cr, type Oembed as cs, type CollapsibleListData as ct, type TableData as cu, type Dimensions as cv, type TableCellData as cw, type CellStyle as cx, type BorderColors as cy, type ListValue as cz, Status as d, type CouponDiscount as d0, type PaidPlanDiscount as d1, type PaidPlanDiscountDiscountOneOf as d2, type PercentDiscount as d3, type Tax as d4, type Fee as d5, type OrderEmailAdded as d6, type EventCanceled as d7, type EventReminder as d8, type TimeDuration as d9, type OrderPaid as da, type TicketPdfResolved as db, type TicketPdfResolveDelayed as dc, type OrderCanceled as dd, type EventEnded as de, type EventStarted as df, type ResolveNotificationConfigRequest as dg, type UpsertNotificationConfigRequest as dh, type ResolveEmailNotificationConfigRequest as di, type ResolveEmailNotificationConfigResponse as dj, type EventDeleted as dk, type EventCopied as dl, type MessageEnvelope as dm, type IdentificationData as dn, type IdentificationDataIdOneOf as dp, type BaseEventMetadata as dq, type EventMetadata as dr, type TriggerNotificationOptionsNotificationOneOf as ds, type TriggerNotificationOptionsGuestsOneOf as dt, EventStatus as e, EventType as f, RegistrationStatus as g, RsvpStatusOptions as h, TaxType as i, ValueType as j, State as k, NodeType as l, PluginContainerDataAlignment as m, Target as n, TextAlignment as o, LineStyle as p, Width as q, ViewMode as r, LayoutType as s, Crop as t, ThumbnailsAlignment as u, Source as v, Position as w, ViewRole as x, VoteRole as y, PollLayoutType as z };
|