@wix/auto_sdk_events_notifications 1.0.13 → 1.0.14
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-DIjek3EA.d.mts} +277 -390
- package/build/{cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-DIjek3EA.d.ts} +277 -390
- package/build/index.d.mts +38 -0
- package/build/index.d.ts +38 -0
- package/build/index.js +857 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +778 -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-DIjek3EA.d.mts} +277 -390
- package/build/{es/src/events-notifications-v2-notification-config-notifications.universal.d.ts → internal/events-notifications-v2-notification-config-notifications.universal-DIjek3EA.d.ts} +277 -390
- package/build/internal/index.d.mts +38 -0
- package/build/internal/index.d.ts +38 -0
- package/build/internal/index.js +857 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +778 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +261 -0
- package/build/internal/meta.d.ts +261 -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 +261 -0
- package/build/meta.d.ts +261 -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 +13 -12
- 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 -3588
- 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/package.json +0 -3
- 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 -3588
- 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 -3588
- 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 -3588
- 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,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface NotificationConfig {
|
|
2
2
|
/**
|
|
3
3
|
* Event ID.
|
|
4
4
|
* @format GUID
|
|
@@ -37,7 +37,7 @@ export interface NotificationConfig {
|
|
|
37
37
|
/** Order confirmation with tickets link. */
|
|
38
38
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
39
39
|
}
|
|
40
|
-
|
|
40
|
+
interface EmailNotificationConfig {
|
|
41
41
|
/**
|
|
42
42
|
* Predefined id of the notification type.
|
|
43
43
|
* @readonly
|
|
@@ -53,7 +53,7 @@ export interface EmailNotificationConfig {
|
|
|
53
53
|
/** When true the notification will be sent when certain trigger occurs. */
|
|
54
54
|
sendingEnabled?: boolean | null;
|
|
55
55
|
}
|
|
56
|
-
|
|
56
|
+
declare enum EmailNotificationType {
|
|
57
57
|
/** Default value. This value is unused. */
|
|
58
58
|
UNKNOWN_NOTIFICATION_TYPE = "UNKNOWN_NOTIFICATION_TYPE",
|
|
59
59
|
/** Triggered when site user RSVP to the event. */
|
|
@@ -71,7 +71,7 @@ export declare enum EmailNotificationType {
|
|
|
71
71
|
/** Triggered when sending invoice. Currently only `enabled` flag update is supported. */
|
|
72
72
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
73
73
|
}
|
|
74
|
-
|
|
74
|
+
interface EmailTemplate {
|
|
75
75
|
/**
|
|
76
76
|
* Email subject.
|
|
77
77
|
* @minLength 1
|
|
@@ -93,7 +93,7 @@ export interface EmailTemplate {
|
|
|
93
93
|
/** When true the tickets are attached to the order confirmation email. */
|
|
94
94
|
includeTickets?: boolean | null;
|
|
95
95
|
}
|
|
96
|
-
|
|
96
|
+
interface Link {
|
|
97
97
|
/** When true the link is added to the email. */
|
|
98
98
|
display?: boolean | null;
|
|
99
99
|
/**
|
|
@@ -102,7 +102,7 @@ export interface Link {
|
|
|
102
102
|
*/
|
|
103
103
|
linkText?: string | null;
|
|
104
104
|
}
|
|
105
|
-
|
|
105
|
+
declare enum EmailNotificationReminderTime {
|
|
106
106
|
/** Default value. This value is unused. */
|
|
107
107
|
UNKNOWN_REMINDER_TIME = "UNKNOWN_REMINDER_TIME",
|
|
108
108
|
/** Notification is sent instantly */
|
|
@@ -118,7 +118,7 @@ export declare enum EmailNotificationReminderTime {
|
|
|
118
118
|
/** 30 minutes prior */
|
|
119
119
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
120
120
|
}
|
|
121
|
-
|
|
121
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
122
122
|
/** Email notification type */
|
|
123
123
|
emailNotificationType?: EmailNotificationType;
|
|
124
124
|
/** Push notification type */
|
|
@@ -133,14 +133,14 @@ export interface TriggerNotificationRequest extends TriggerNotificationRequestNo
|
|
|
133
133
|
ticketGuest?: TicketGuest;
|
|
134
134
|
}
|
|
135
135
|
/** @oneof */
|
|
136
|
-
|
|
136
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
137
137
|
/** Email notification type */
|
|
138
138
|
emailNotificationType?: EmailNotificationType;
|
|
139
139
|
/** Push notification type */
|
|
140
140
|
pushNotificationType?: PushNotificationType;
|
|
141
141
|
}
|
|
142
142
|
/** @oneof */
|
|
143
|
-
|
|
143
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
144
144
|
/** Rsvp guest info */
|
|
145
145
|
rsvpGuest?: RsvpGuest;
|
|
146
146
|
/** Order guest info */
|
|
@@ -150,7 +150,7 @@ export interface TriggerNotificationRequestGuestsOneOf {
|
|
|
150
150
|
/** Ticket guests info */
|
|
151
151
|
ticketGuest?: TicketGuest;
|
|
152
152
|
}
|
|
153
|
-
|
|
153
|
+
declare enum PushNotificationType {
|
|
154
154
|
/** This is default value. This value is unused. */
|
|
155
155
|
UNKNOWN_PUSH_TYPE = "UNKNOWN_PUSH_TYPE",
|
|
156
156
|
/** Triggered when event is updated. */
|
|
@@ -163,7 +163,7 @@ export declare enum PushNotificationType {
|
|
|
163
163
|
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
164
164
|
}
|
|
165
165
|
/** Single guest associated to the RSVP */
|
|
166
|
-
|
|
166
|
+
interface RsvpGuest {
|
|
167
167
|
/**
|
|
168
168
|
* Event id
|
|
169
169
|
* @format GUID
|
|
@@ -176,7 +176,7 @@ export interface RsvpGuest {
|
|
|
176
176
|
rsvpId?: string;
|
|
177
177
|
}
|
|
178
178
|
/** Single guest associated to the Order */
|
|
179
|
-
|
|
179
|
+
interface OrderGuest {
|
|
180
180
|
/**
|
|
181
181
|
* Event id
|
|
182
182
|
* @format GUID
|
|
@@ -189,7 +189,7 @@ export interface OrderGuest {
|
|
|
189
189
|
orderNumber?: string;
|
|
190
190
|
}
|
|
191
191
|
/** All event guest from RSVPs and Orders */
|
|
192
|
-
|
|
192
|
+
interface EventGuests {
|
|
193
193
|
/**
|
|
194
194
|
* Event id
|
|
195
195
|
* @format GUID
|
|
@@ -197,7 +197,7 @@ export interface EventGuests {
|
|
|
197
197
|
eventId?: string;
|
|
198
198
|
}
|
|
199
199
|
/** Multiple guests associated to Tickets */
|
|
200
|
-
|
|
200
|
+
interface TicketGuest {
|
|
201
201
|
/**
|
|
202
202
|
* Event id
|
|
203
203
|
* @format GUID
|
|
@@ -216,9 +216,9 @@ export interface TicketGuest {
|
|
|
216
216
|
*/
|
|
217
217
|
ticketNumber?: string[];
|
|
218
218
|
}
|
|
219
|
-
|
|
219
|
+
interface TriggerNotificationResponse {
|
|
220
220
|
}
|
|
221
|
-
|
|
221
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
222
222
|
createdEvent?: EntityCreatedEvent;
|
|
223
223
|
updatedEvent?: EntityUpdatedEvent;
|
|
224
224
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -261,19 +261,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
261
261
|
entityEventSequence?: string | null;
|
|
262
262
|
}
|
|
263
263
|
/** @oneof */
|
|
264
|
-
|
|
264
|
+
interface DomainEventBodyOneOf {
|
|
265
265
|
createdEvent?: EntityCreatedEvent;
|
|
266
266
|
updatedEvent?: EntityUpdatedEvent;
|
|
267
267
|
deletedEvent?: EntityDeletedEvent;
|
|
268
268
|
actionEvent?: ActionEvent;
|
|
269
269
|
}
|
|
270
|
-
|
|
270
|
+
interface EntityCreatedEvent {
|
|
271
271
|
entity?: string;
|
|
272
272
|
}
|
|
273
|
-
|
|
273
|
+
interface RestoreInfo {
|
|
274
274
|
deletedDate?: Date | null;
|
|
275
275
|
}
|
|
276
|
-
|
|
276
|
+
interface EntityUpdatedEvent {
|
|
277
277
|
/**
|
|
278
278
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
279
279
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -281,16 +281,16 @@ export interface EntityUpdatedEvent {
|
|
|
281
281
|
*/
|
|
282
282
|
currentEntity?: string;
|
|
283
283
|
}
|
|
284
|
-
|
|
284
|
+
interface EntityDeletedEvent {
|
|
285
285
|
/** Entity that was deleted */
|
|
286
286
|
deletedEntity?: string | null;
|
|
287
287
|
}
|
|
288
|
-
|
|
288
|
+
interface ActionEvent {
|
|
289
289
|
body?: string;
|
|
290
290
|
}
|
|
291
|
-
|
|
291
|
+
interface Empty {
|
|
292
292
|
}
|
|
293
|
-
|
|
293
|
+
interface EventUpdated {
|
|
294
294
|
/** Event update timestamp in ISO UTC format. */
|
|
295
295
|
timestamp?: Date | null;
|
|
296
296
|
/**
|
|
@@ -312,7 +312,7 @@ export interface EventUpdated {
|
|
|
312
312
|
/** Updated event */
|
|
313
313
|
event?: Event;
|
|
314
314
|
}
|
|
315
|
-
|
|
315
|
+
interface Location {
|
|
316
316
|
/**
|
|
317
317
|
* Location name.
|
|
318
318
|
* @maxLength 50
|
|
@@ -344,7 +344,7 @@ export interface Location {
|
|
|
344
344
|
*/
|
|
345
345
|
tbd?: boolean | null;
|
|
346
346
|
}
|
|
347
|
-
|
|
347
|
+
interface MapCoordinates {
|
|
348
348
|
/**
|
|
349
349
|
* Latitude.
|
|
350
350
|
* @min -90
|
|
@@ -358,12 +358,12 @@ export interface MapCoordinates {
|
|
|
358
358
|
*/
|
|
359
359
|
lng?: number;
|
|
360
360
|
}
|
|
361
|
-
|
|
361
|
+
declare enum LocationType {
|
|
362
362
|
VENUE = "VENUE",
|
|
363
363
|
ONLINE = "ONLINE"
|
|
364
364
|
}
|
|
365
365
|
/** Physical address */
|
|
366
|
-
|
|
366
|
+
interface Address extends AddressStreetOneOf {
|
|
367
367
|
/** a break down of the street to number and street name */
|
|
368
368
|
streetAddress?: StreetAddress;
|
|
369
369
|
/** Main address line (usually street and number) as free text */
|
|
@@ -394,19 +394,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
394
394
|
subdivisions?: Subdivision[];
|
|
395
395
|
}
|
|
396
396
|
/** @oneof */
|
|
397
|
-
|
|
397
|
+
interface AddressStreetOneOf {
|
|
398
398
|
/** a break down of the street to number and street name */
|
|
399
399
|
streetAddress?: StreetAddress;
|
|
400
400
|
/** Main address line (usually street and number) as free text */
|
|
401
401
|
addressLine?: string | null;
|
|
402
402
|
}
|
|
403
|
-
|
|
403
|
+
interface StreetAddress {
|
|
404
404
|
/** street number */
|
|
405
405
|
number?: string;
|
|
406
406
|
/** street name */
|
|
407
407
|
name?: string;
|
|
408
408
|
}
|
|
409
|
-
|
|
409
|
+
interface AddressLocation {
|
|
410
410
|
/**
|
|
411
411
|
* address latitude coordinates
|
|
412
412
|
* @min -90
|
|
@@ -420,13 +420,13 @@ export interface AddressLocation {
|
|
|
420
420
|
*/
|
|
421
421
|
longitude?: number | null;
|
|
422
422
|
}
|
|
423
|
-
|
|
423
|
+
interface Subdivision {
|
|
424
424
|
/** subdivision short code */
|
|
425
425
|
code?: string;
|
|
426
426
|
/** subdivision full-name */
|
|
427
427
|
name?: string;
|
|
428
428
|
}
|
|
429
|
-
|
|
429
|
+
declare enum SubdivisionType {
|
|
430
430
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
431
431
|
/** State */
|
|
432
432
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -441,7 +441,7 @@ export declare enum SubdivisionType {
|
|
|
441
441
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
442
442
|
COUNTRY = "COUNTRY"
|
|
443
443
|
}
|
|
444
|
-
|
|
444
|
+
interface ScheduleConfig {
|
|
445
445
|
/**
|
|
446
446
|
* Defines event as TBD (To Be Determined) schedule.
|
|
447
447
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -469,7 +469,7 @@ export interface ScheduleConfig {
|
|
|
469
469
|
/** Event recurrences. */
|
|
470
470
|
recurrences?: Recurrences;
|
|
471
471
|
}
|
|
472
|
-
|
|
472
|
+
interface Recurrences {
|
|
473
473
|
/**
|
|
474
474
|
* Event occurrences.
|
|
475
475
|
* @maxSize 1000
|
|
@@ -486,7 +486,7 @@ export interface Recurrences {
|
|
|
486
486
|
*/
|
|
487
487
|
status?: Status;
|
|
488
488
|
}
|
|
489
|
-
|
|
489
|
+
interface Occurrence {
|
|
490
490
|
/** Event start timestamp. */
|
|
491
491
|
startDate?: Date | null;
|
|
492
492
|
/** Event end timestamp. */
|
|
@@ -499,7 +499,7 @@ export interface Occurrence {
|
|
|
499
499
|
/** Whether time zone is displayed in formatted schedule. */
|
|
500
500
|
showTimeZone?: boolean;
|
|
501
501
|
}
|
|
502
|
-
|
|
502
|
+
declare enum Status {
|
|
503
503
|
/** Event occurs only once. */
|
|
504
504
|
ONE_TIME = "ONE_TIME",
|
|
505
505
|
/** Event is recurring. */
|
|
@@ -511,7 +511,7 @@ export declare enum Status {
|
|
|
511
511
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
512
512
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
513
513
|
}
|
|
514
|
-
|
|
514
|
+
interface Event {
|
|
515
515
|
/**
|
|
516
516
|
* Event ID.
|
|
517
517
|
* @format GUID
|
|
@@ -581,7 +581,7 @@ export interface Event {
|
|
|
581
581
|
*/
|
|
582
582
|
publishedDate?: Date | null;
|
|
583
583
|
}
|
|
584
|
-
|
|
584
|
+
interface Scheduling {
|
|
585
585
|
/** Schedule configuration. */
|
|
586
586
|
config?: ScheduleConfig;
|
|
587
587
|
/** Formatted schedule representation. */
|
|
@@ -595,7 +595,7 @@ export interface Scheduling {
|
|
|
595
595
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
596
596
|
endTimeFormatted?: string;
|
|
597
597
|
}
|
|
598
|
-
|
|
598
|
+
declare enum EventStatus {
|
|
599
599
|
/** Event is public and scheduled to start */
|
|
600
600
|
SCHEDULED = "SCHEDULED",
|
|
601
601
|
/** Event has started */
|
|
@@ -605,7 +605,7 @@ export declare enum EventStatus {
|
|
|
605
605
|
/** Event was canceled */
|
|
606
606
|
CANCELED = "CANCELED"
|
|
607
607
|
}
|
|
608
|
-
|
|
608
|
+
interface Registration {
|
|
609
609
|
/** Event type. */
|
|
610
610
|
type?: EventType;
|
|
611
611
|
/** Event registration status. */
|
|
@@ -621,7 +621,7 @@ export interface Registration {
|
|
|
621
621
|
/** Initial event type which was set when creating an event. */
|
|
622
622
|
initialType?: EventType;
|
|
623
623
|
}
|
|
624
|
-
|
|
624
|
+
declare enum EventType {
|
|
625
625
|
/** Type not available for this request fieldset */
|
|
626
626
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
627
627
|
/** Registration via RSVP */
|
|
@@ -633,7 +633,7 @@ export declare enum EventType {
|
|
|
633
633
|
/** Registration not available */
|
|
634
634
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
635
635
|
}
|
|
636
|
-
|
|
636
|
+
declare enum RegistrationStatus {
|
|
637
637
|
/** Registration status is not applicable */
|
|
638
638
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
639
639
|
/** Registration to event is closed */
|
|
@@ -651,11 +651,11 @@ export declare enum RegistrationStatus {
|
|
|
651
651
|
/** Registration will be open via RSVP */
|
|
652
652
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
653
653
|
}
|
|
654
|
-
|
|
654
|
+
interface RsvpCollection {
|
|
655
655
|
/** RSVP collection configuration. */
|
|
656
656
|
config?: RsvpCollectionConfig;
|
|
657
657
|
}
|
|
658
|
-
|
|
658
|
+
interface RsvpCollectionConfig {
|
|
659
659
|
/** Defines the supported RSVP statuses. */
|
|
660
660
|
rsvpStatusOptions?: RsvpStatusOptions;
|
|
661
661
|
/**
|
|
@@ -670,13 +670,13 @@ export interface RsvpCollectionConfig {
|
|
|
670
670
|
/** Registration end timestamp. */
|
|
671
671
|
endDate?: Date | null;
|
|
672
672
|
}
|
|
673
|
-
|
|
673
|
+
declare enum RsvpStatusOptions {
|
|
674
674
|
/** Only YES RSVP status is available for RSVP registration */
|
|
675
675
|
YES_ONLY = "YES_ONLY",
|
|
676
676
|
/** YES and NO RSVP status options are available for the registration */
|
|
677
677
|
YES_AND_NO = "YES_AND_NO"
|
|
678
678
|
}
|
|
679
|
-
|
|
679
|
+
interface Ticketing {
|
|
680
680
|
/**
|
|
681
681
|
* Deprecated.
|
|
682
682
|
* @deprecated
|
|
@@ -717,7 +717,7 @@ export interface Ticketing {
|
|
|
717
717
|
*/
|
|
718
718
|
soldOut?: boolean | null;
|
|
719
719
|
}
|
|
720
|
-
|
|
720
|
+
interface TicketingConfig {
|
|
721
721
|
/** Whether the form must be filled out separately for each ticket. */
|
|
722
722
|
guestAssignedTickets?: boolean;
|
|
723
723
|
/** Tax configuration. */
|
|
@@ -734,7 +734,7 @@ export interface TicketingConfig {
|
|
|
734
734
|
*/
|
|
735
735
|
reservationDurationInMinutes?: number | null;
|
|
736
736
|
}
|
|
737
|
-
|
|
737
|
+
interface TaxConfig {
|
|
738
738
|
/** Tax application settings. */
|
|
739
739
|
type?: TaxType;
|
|
740
740
|
/**
|
|
@@ -751,7 +751,7 @@ export interface TaxConfig {
|
|
|
751
751
|
/** Applies taxes for donations, default true. */
|
|
752
752
|
appliesToDonations?: boolean | null;
|
|
753
753
|
}
|
|
754
|
-
|
|
754
|
+
declare enum TaxType {
|
|
755
755
|
/** Tax is included in the ticket price. */
|
|
756
756
|
INCLUDED = "INCLUDED",
|
|
757
757
|
/** Tax is added to the order at the checkout. */
|
|
@@ -759,7 +759,7 @@ export declare enum TaxType {
|
|
|
759
759
|
/** Tax is added to the final total at the checkout. */
|
|
760
760
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
761
761
|
}
|
|
762
|
-
|
|
762
|
+
interface Money {
|
|
763
763
|
/**
|
|
764
764
|
* *Deprecated:** Use `value` instead.
|
|
765
765
|
* @format DECIMAL_VALUE
|
|
@@ -777,11 +777,11 @@ export interface Money {
|
|
|
777
777
|
*/
|
|
778
778
|
value?: string | null;
|
|
779
779
|
}
|
|
780
|
-
|
|
780
|
+
interface ExternalEvent {
|
|
781
781
|
/** External event registration URL. */
|
|
782
782
|
registration?: string;
|
|
783
783
|
}
|
|
784
|
-
|
|
784
|
+
declare enum VisitorType {
|
|
785
785
|
/** Site visitor (including member) */
|
|
786
786
|
VISITOR = "VISITOR",
|
|
787
787
|
/** Site member */
|
|
@@ -789,14 +789,14 @@ export declare enum VisitorType {
|
|
|
789
789
|
/** Site visitor or member */
|
|
790
790
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
791
791
|
}
|
|
792
|
-
|
|
792
|
+
interface CalendarLinks {
|
|
793
793
|
/** "Add to Google calendar" URL. */
|
|
794
794
|
google?: string;
|
|
795
795
|
/** "Download ICS calendar file" URL. */
|
|
796
796
|
ics?: string;
|
|
797
797
|
}
|
|
798
798
|
/** Site URL components */
|
|
799
|
-
|
|
799
|
+
interface SiteUrl {
|
|
800
800
|
/**
|
|
801
801
|
* Base URL. For premium sites, this will be the domain.
|
|
802
802
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -818,7 +818,7 @@ export interface SiteUrl {
|
|
|
818
818
|
*
|
|
819
819
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
820
820
|
*/
|
|
821
|
-
|
|
821
|
+
interface Form {
|
|
822
822
|
/** Nested fields as an ordered list. */
|
|
823
823
|
controls?: InputControl[];
|
|
824
824
|
/** Set of configured form messages. */
|
|
@@ -828,7 +828,7 @@ export interface Form {
|
|
|
828
828
|
* A block of nested fields.
|
|
829
829
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
830
830
|
*/
|
|
831
|
-
|
|
831
|
+
interface InputControl {
|
|
832
832
|
/** Field control type. */
|
|
833
833
|
type?: InputControlType;
|
|
834
834
|
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
@@ -855,7 +855,7 @@ export interface InputControl {
|
|
|
855
855
|
*/
|
|
856
856
|
deleted?: boolean | null;
|
|
857
857
|
}
|
|
858
|
-
|
|
858
|
+
declare enum InputControlType {
|
|
859
859
|
/** Single text value field. */
|
|
860
860
|
INPUT = "INPUT",
|
|
861
861
|
/** Single text value field. */
|
|
@@ -878,7 +878,7 @@ export declare enum InputControlType {
|
|
|
878
878
|
DATE = "DATE"
|
|
879
879
|
}
|
|
880
880
|
/** An input of one or multiple text values */
|
|
881
|
-
|
|
881
|
+
interface Input {
|
|
882
882
|
/** Field name. */
|
|
883
883
|
name?: string;
|
|
884
884
|
/**
|
|
@@ -917,7 +917,7 @@ export interface Input {
|
|
|
917
917
|
*/
|
|
918
918
|
labels?: Label[];
|
|
919
919
|
}
|
|
920
|
-
|
|
920
|
+
declare enum ValueType {
|
|
921
921
|
TEXT = "TEXT",
|
|
922
922
|
NUMBER = "NUMBER",
|
|
923
923
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -928,7 +928,7 @@ export declare enum ValueType {
|
|
|
928
928
|
* Describes initially selected option when an input has multiple choices.
|
|
929
929
|
* Defaults to first (0th) option if not configured.
|
|
930
930
|
*/
|
|
931
|
-
|
|
931
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
932
932
|
/**
|
|
933
933
|
* 0-based index from predefined `input.options` which is selected initially.
|
|
934
934
|
* @max 199
|
|
@@ -942,7 +942,7 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
942
942
|
placeholderText?: string;
|
|
943
943
|
}
|
|
944
944
|
/** @oneof */
|
|
945
|
-
|
|
945
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
946
946
|
/**
|
|
947
947
|
* 0-based index from predefined `input.options` which is selected initially.
|
|
948
948
|
* @max 199
|
|
@@ -955,7 +955,7 @@ export interface OptionSelectionSelectedOptionOneOf {
|
|
|
955
955
|
*/
|
|
956
956
|
placeholderText?: string;
|
|
957
957
|
}
|
|
958
|
-
|
|
958
|
+
interface Label {
|
|
959
959
|
/** Field name. */
|
|
960
960
|
name?: string;
|
|
961
961
|
/** Field label. */
|
|
@@ -965,7 +965,7 @@ export interface Label {
|
|
|
965
965
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
966
966
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
967
967
|
*/
|
|
968
|
-
|
|
968
|
+
interface FormMessages {
|
|
969
969
|
/** RSVP form messages. */
|
|
970
970
|
rsvp?: RsvpFormMessages;
|
|
971
971
|
/** Checkout form messages. */
|
|
@@ -975,7 +975,7 @@ export interface FormMessages {
|
|
|
975
975
|
/** Messages shown when event tickets are unavailable. */
|
|
976
976
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
977
977
|
}
|
|
978
|
-
|
|
978
|
+
interface RsvpFormMessages {
|
|
979
979
|
/** Label text indicating RSVP `YES` response. */
|
|
980
980
|
rsvpYesOption?: string;
|
|
981
981
|
/** Label text indicating RSVP `NO` response. */
|
|
@@ -990,7 +990,7 @@ export interface RsvpFormMessages {
|
|
|
990
990
|
submitActionLabel?: string;
|
|
991
991
|
}
|
|
992
992
|
/** Confirmation messages shown after registration. */
|
|
993
|
-
|
|
993
|
+
interface PositiveResponseConfirmation {
|
|
994
994
|
/** Confirmation message title. */
|
|
995
995
|
title?: string;
|
|
996
996
|
/** Confirmation message text. */
|
|
@@ -1001,27 +1001,27 @@ export interface PositiveResponseConfirmation {
|
|
|
1001
1001
|
shareActionLabel?: string;
|
|
1002
1002
|
}
|
|
1003
1003
|
/** Confirmation messages shown after registration. */
|
|
1004
|
-
|
|
1004
|
+
interface NegativeResponseConfirmation {
|
|
1005
1005
|
/** Confirmation message title. */
|
|
1006
1006
|
title?: string;
|
|
1007
1007
|
/** "Share event" call-to-action label text. */
|
|
1008
1008
|
shareActionLabel?: string;
|
|
1009
1009
|
}
|
|
1010
1010
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
1011
|
-
|
|
1011
|
+
interface Positive {
|
|
1012
1012
|
/** Main form title for positive response. */
|
|
1013
1013
|
title?: string;
|
|
1014
1014
|
/** Confirmation messages shown after registration. */
|
|
1015
1015
|
confirmation?: PositiveResponseConfirmation;
|
|
1016
1016
|
}
|
|
1017
1017
|
/** A set of messages shown during registration with negative response */
|
|
1018
|
-
|
|
1018
|
+
interface Negative {
|
|
1019
1019
|
/** Main form title for negative response. */
|
|
1020
1020
|
title?: string;
|
|
1021
1021
|
/** Confirmation messages shown after registration. */
|
|
1022
1022
|
confirmation?: NegativeResponseConfirmation;
|
|
1023
1023
|
}
|
|
1024
|
-
|
|
1024
|
+
interface CheckoutFormMessages {
|
|
1025
1025
|
/** Main form title for response. */
|
|
1026
1026
|
title?: string;
|
|
1027
1027
|
/** Submit form call-to-action label text. */
|
|
@@ -1030,7 +1030,7 @@ export interface CheckoutFormMessages {
|
|
|
1030
1030
|
confirmation?: ResponseConfirmation;
|
|
1031
1031
|
}
|
|
1032
1032
|
/** Confirmation messages shown after checkout. */
|
|
1033
|
-
|
|
1033
|
+
interface ResponseConfirmation {
|
|
1034
1034
|
/** Confirmation message title. */
|
|
1035
1035
|
title?: string;
|
|
1036
1036
|
/** Confirmation message text. */
|
|
@@ -1042,19 +1042,19 @@ export interface ResponseConfirmation {
|
|
|
1042
1042
|
/** "Share event" call-to-action label text. */
|
|
1043
1043
|
shareEventLabel?: string;
|
|
1044
1044
|
}
|
|
1045
|
-
|
|
1045
|
+
interface RegistrationClosedMessages {
|
|
1046
1046
|
/** Message shown when event registration is closed. */
|
|
1047
1047
|
message?: string;
|
|
1048
1048
|
/** "Explore other events" call-to-action label text. */
|
|
1049
1049
|
exploreEventsActionLabel?: string;
|
|
1050
1050
|
}
|
|
1051
|
-
|
|
1051
|
+
interface TicketsUnavailableMessages {
|
|
1052
1052
|
/** Message shown when event tickets are unavailable. */
|
|
1053
1053
|
message?: string;
|
|
1054
1054
|
/** "Explore other events" call-to-action label text. */
|
|
1055
1055
|
exploreEventsActionLabel?: string;
|
|
1056
1056
|
}
|
|
1057
|
-
|
|
1057
|
+
interface Dashboard {
|
|
1058
1058
|
/** Guest RSVP summary. */
|
|
1059
1059
|
rsvpSummary?: RsvpSummary;
|
|
1060
1060
|
/**
|
|
@@ -1063,7 +1063,7 @@ export interface Dashboard {
|
|
|
1063
1063
|
*/
|
|
1064
1064
|
ticketingSummary?: TicketingSummary;
|
|
1065
1065
|
}
|
|
1066
|
-
|
|
1066
|
+
interface RsvpSummary {
|
|
1067
1067
|
/** Total number of RSVPs. */
|
|
1068
1068
|
total?: number;
|
|
1069
1069
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -1073,7 +1073,7 @@ export interface RsvpSummary {
|
|
|
1073
1073
|
/** Number of RSVPs in waitlist. */
|
|
1074
1074
|
waitlist?: number;
|
|
1075
1075
|
}
|
|
1076
|
-
|
|
1076
|
+
interface TicketingSummary {
|
|
1077
1077
|
/** Number of tickets sold. */
|
|
1078
1078
|
tickets?: number;
|
|
1079
1079
|
/**
|
|
@@ -1088,19 +1088,19 @@ export interface TicketingSummary {
|
|
|
1088
1088
|
/** Total balance of confirmed transactions. */
|
|
1089
1089
|
totalSales?: Money;
|
|
1090
1090
|
}
|
|
1091
|
-
|
|
1091
|
+
interface GuestListConfig {
|
|
1092
1092
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
1093
1093
|
publicGuestList?: boolean;
|
|
1094
1094
|
}
|
|
1095
|
-
|
|
1095
|
+
interface Feed {
|
|
1096
1096
|
/** Event discussion feed token. */
|
|
1097
1097
|
token?: string;
|
|
1098
1098
|
}
|
|
1099
|
-
|
|
1099
|
+
interface OnlineConferencing {
|
|
1100
1100
|
config?: OnlineConferencingConfig;
|
|
1101
1101
|
session?: OnlineConferencingSession;
|
|
1102
1102
|
}
|
|
1103
|
-
|
|
1103
|
+
interface OnlineConferencingConfig {
|
|
1104
1104
|
/**
|
|
1105
1105
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1106
1106
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -1114,13 +1114,13 @@ export interface OnlineConferencingConfig {
|
|
|
1114
1114
|
/** Conference type */
|
|
1115
1115
|
conferenceType?: ConferenceType;
|
|
1116
1116
|
}
|
|
1117
|
-
|
|
1117
|
+
declare enum ConferenceType {
|
|
1118
1118
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1119
1119
|
MEETING = "MEETING",
|
|
1120
1120
|
/** Guests can only subscribe to video and audio. */
|
|
1121
1121
|
WEBINAR = "WEBINAR"
|
|
1122
1122
|
}
|
|
1123
|
-
|
|
1123
|
+
interface OnlineConferencingSession {
|
|
1124
1124
|
/**
|
|
1125
1125
|
* Link for event host to start the online conference session.
|
|
1126
1126
|
* @readonly
|
|
@@ -1147,7 +1147,7 @@ export interface OnlineConferencingSession {
|
|
|
1147
1147
|
*/
|
|
1148
1148
|
sessionId?: string | null;
|
|
1149
1149
|
}
|
|
1150
|
-
|
|
1150
|
+
interface SeoSettings {
|
|
1151
1151
|
/**
|
|
1152
1152
|
* URL slug
|
|
1153
1153
|
* @maxLength 130
|
|
@@ -1166,13 +1166,13 @@ export interface SeoSettings {
|
|
|
1166
1166
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1167
1167
|
* 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.
|
|
1168
1168
|
*/
|
|
1169
|
-
|
|
1169
|
+
interface SeoSchema {
|
|
1170
1170
|
/** SEO tag information. */
|
|
1171
1171
|
tags?: Tag[];
|
|
1172
1172
|
/** SEO general settings. */
|
|
1173
1173
|
settings?: Settings;
|
|
1174
1174
|
}
|
|
1175
|
-
|
|
1175
|
+
interface Keyword {
|
|
1176
1176
|
/** Keyword value. */
|
|
1177
1177
|
term?: string;
|
|
1178
1178
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1183,7 +1183,7 @@ export interface Keyword {
|
|
|
1183
1183
|
*/
|
|
1184
1184
|
origin?: string | null;
|
|
1185
1185
|
}
|
|
1186
|
-
|
|
1186
|
+
interface Tag {
|
|
1187
1187
|
/**
|
|
1188
1188
|
* SEO tag type.
|
|
1189
1189
|
*
|
|
@@ -1205,7 +1205,7 @@ export interface Tag {
|
|
|
1205
1205
|
/** Whether the tag is disabled. */
|
|
1206
1206
|
disabled?: boolean;
|
|
1207
1207
|
}
|
|
1208
|
-
|
|
1208
|
+
interface Settings {
|
|
1209
1209
|
/**
|
|
1210
1210
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1211
1211
|
*
|
|
@@ -1219,7 +1219,7 @@ export interface Settings {
|
|
|
1219
1219
|
*/
|
|
1220
1220
|
keywords?: Keyword[];
|
|
1221
1221
|
}
|
|
1222
|
-
|
|
1222
|
+
interface Agenda {
|
|
1223
1223
|
/** Whether the schedule is enabled for the event. */
|
|
1224
1224
|
enabled?: boolean;
|
|
1225
1225
|
/**
|
|
@@ -1228,7 +1228,7 @@ export interface Agenda {
|
|
|
1228
1228
|
*/
|
|
1229
1229
|
pageUrl?: SiteUrl;
|
|
1230
1230
|
}
|
|
1231
|
-
|
|
1231
|
+
interface Category {
|
|
1232
1232
|
/**
|
|
1233
1233
|
* Category ID.
|
|
1234
1234
|
* @format GUID
|
|
@@ -1266,13 +1266,13 @@ export interface Category {
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
states?: State[];
|
|
1268
1268
|
}
|
|
1269
|
-
|
|
1269
|
+
interface CategoryCounts {
|
|
1270
1270
|
/** Total number of draft events assigned to the category. */
|
|
1271
1271
|
assignedEventsCount?: number | null;
|
|
1272
1272
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1273
1273
|
assignedDraftEventsCount?: number | null;
|
|
1274
1274
|
}
|
|
1275
|
-
|
|
1275
|
+
declare enum State {
|
|
1276
1276
|
/** Created manually by the user. */
|
|
1277
1277
|
MANUAL = "MANUAL",
|
|
1278
1278
|
/** Created automatically. */
|
|
@@ -1282,15 +1282,15 @@ export declare enum State {
|
|
|
1282
1282
|
/** Category is hidden. */
|
|
1283
1283
|
HIDDEN = "HIDDEN"
|
|
1284
1284
|
}
|
|
1285
|
-
|
|
1285
|
+
interface EventDisplaySettings {
|
|
1286
1286
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1287
1287
|
hideEventDetailsButton?: boolean | null;
|
|
1288
1288
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1289
1289
|
hideEventDetailsPage?: boolean | null;
|
|
1290
1290
|
}
|
|
1291
|
-
|
|
1291
|
+
interface LabellingSettings {
|
|
1292
1292
|
}
|
|
1293
|
-
|
|
1293
|
+
interface RichContent {
|
|
1294
1294
|
/** Node objects representing a rich content document. */
|
|
1295
1295
|
nodes?: Node[];
|
|
1296
1296
|
/** Object metadata. */
|
|
@@ -1298,7 +1298,7 @@ export interface RichContent {
|
|
|
1298
1298
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1299
1299
|
documentStyle?: DocumentStyle;
|
|
1300
1300
|
}
|
|
1301
|
-
|
|
1301
|
+
interface Node extends NodeDataOneOf {
|
|
1302
1302
|
/** Data for a button node. */
|
|
1303
1303
|
buttonData?: ButtonData;
|
|
1304
1304
|
/** Data for a code block node. */
|
|
@@ -1363,7 +1363,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1363
1363
|
style?: NodeStyle;
|
|
1364
1364
|
}
|
|
1365
1365
|
/** @oneof */
|
|
1366
|
-
|
|
1366
|
+
interface NodeDataOneOf {
|
|
1367
1367
|
/** Data for a button node. */
|
|
1368
1368
|
buttonData?: ButtonData;
|
|
1369
1369
|
/** Data for a code block node. */
|
|
@@ -1419,7 +1419,7 @@ export interface NodeDataOneOf {
|
|
|
1419
1419
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1420
1420
|
layoutCellData?: LayoutCellData;
|
|
1421
1421
|
}
|
|
1422
|
-
|
|
1422
|
+
declare enum NodeType {
|
|
1423
1423
|
PARAGRAPH = "PARAGRAPH",
|
|
1424
1424
|
TEXT = "TEXT",
|
|
1425
1425
|
HEADING = "HEADING",
|
|
@@ -1455,7 +1455,7 @@ export declare enum NodeType {
|
|
|
1455
1455
|
LAYOUT = "LAYOUT",
|
|
1456
1456
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1457
1457
|
}
|
|
1458
|
-
|
|
1458
|
+
interface NodeStyle {
|
|
1459
1459
|
/** The top padding value in pixels. */
|
|
1460
1460
|
paddingTop?: string | null;
|
|
1461
1461
|
/** The bottom padding value in pixels. */
|
|
@@ -1463,7 +1463,7 @@ export interface NodeStyle {
|
|
|
1463
1463
|
/** The background color as a hexadecimal value. */
|
|
1464
1464
|
backgroundColor?: string | null;
|
|
1465
1465
|
}
|
|
1466
|
-
|
|
1466
|
+
interface ButtonData {
|
|
1467
1467
|
/** Styling for the button's container. */
|
|
1468
1468
|
containerData?: PluginContainerData;
|
|
1469
1469
|
/** The button type. */
|
|
@@ -1475,13 +1475,13 @@ export interface ButtonData {
|
|
|
1475
1475
|
/** Button link details. */
|
|
1476
1476
|
link?: V1Link;
|
|
1477
1477
|
}
|
|
1478
|
-
|
|
1478
|
+
interface Border {
|
|
1479
1479
|
/** Border width in pixels. */
|
|
1480
1480
|
width?: number | null;
|
|
1481
1481
|
/** Border radius in pixels. */
|
|
1482
1482
|
radius?: number | null;
|
|
1483
1483
|
}
|
|
1484
|
-
|
|
1484
|
+
interface Colors {
|
|
1485
1485
|
/** The text color as a hexadecimal value. */
|
|
1486
1486
|
text?: string | null;
|
|
1487
1487
|
/** The border color as a hexadecimal value. */
|
|
@@ -1489,7 +1489,7 @@ export interface Colors {
|
|
|
1489
1489
|
/** The background color as a hexadecimal value. */
|
|
1490
1490
|
background?: string | null;
|
|
1491
1491
|
}
|
|
1492
|
-
|
|
1492
|
+
interface PluginContainerData {
|
|
1493
1493
|
/** The width of the node when it's displayed. */
|
|
1494
1494
|
width?: PluginContainerDataWidth;
|
|
1495
1495
|
/** The node's alignment within its container. */
|
|
@@ -1501,7 +1501,7 @@ export interface PluginContainerData {
|
|
|
1501
1501
|
/** 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`. */
|
|
1502
1502
|
textWrap?: boolean | null;
|
|
1503
1503
|
}
|
|
1504
|
-
|
|
1504
|
+
declare enum WidthType {
|
|
1505
1505
|
/** Width matches the content width */
|
|
1506
1506
|
CONTENT = "CONTENT",
|
|
1507
1507
|
/** Small Width */
|
|
@@ -1511,7 +1511,7 @@ export declare enum WidthType {
|
|
|
1511
1511
|
/** coast-to-coast display */
|
|
1512
1512
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1513
1513
|
}
|
|
1514
|
-
|
|
1514
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1515
1515
|
/**
|
|
1516
1516
|
* One of the following predefined width options:
|
|
1517
1517
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1524,7 +1524,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1524
1524
|
custom?: string | null;
|
|
1525
1525
|
}
|
|
1526
1526
|
/** @oneof */
|
|
1527
|
-
|
|
1527
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1528
1528
|
/**
|
|
1529
1529
|
* One of the following predefined width options:
|
|
1530
1530
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1536,7 +1536,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1536
1536
|
/** A custom width value in pixels. */
|
|
1537
1537
|
custom?: string | null;
|
|
1538
1538
|
}
|
|
1539
|
-
|
|
1539
|
+
declare enum PluginContainerDataAlignment {
|
|
1540
1540
|
/** Center Alignment */
|
|
1541
1541
|
CENTER = "CENTER",
|
|
1542
1542
|
/** Left Alignment */
|
|
@@ -1544,7 +1544,7 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1544
1544
|
/** Right Alignment */
|
|
1545
1545
|
RIGHT = "RIGHT"
|
|
1546
1546
|
}
|
|
1547
|
-
|
|
1547
|
+
interface Spoiler {
|
|
1548
1548
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1549
1549
|
enabled?: boolean | null;
|
|
1550
1550
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1552,23 +1552,23 @@ export interface Spoiler {
|
|
|
1552
1552
|
/** The text for the button used to remove the spoiler cover. */
|
|
1553
1553
|
buttonText?: string | null;
|
|
1554
1554
|
}
|
|
1555
|
-
|
|
1555
|
+
interface Height {
|
|
1556
1556
|
/** A custom height value in pixels. */
|
|
1557
1557
|
custom?: string | null;
|
|
1558
1558
|
}
|
|
1559
|
-
|
|
1559
|
+
declare enum ButtonDataType {
|
|
1560
1560
|
/** Regular link button */
|
|
1561
1561
|
LINK = "LINK",
|
|
1562
1562
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1563
1563
|
ACTION = "ACTION"
|
|
1564
1564
|
}
|
|
1565
|
-
|
|
1565
|
+
interface Styles {
|
|
1566
1566
|
/** Border attributes. */
|
|
1567
1567
|
border?: Border;
|
|
1568
1568
|
/** Color attributes. */
|
|
1569
1569
|
colors?: Colors;
|
|
1570
1570
|
}
|
|
1571
|
-
|
|
1571
|
+
interface V1Link extends V1LinkDataOneOf {
|
|
1572
1572
|
/** The absolute URL for the linked document. */
|
|
1573
1573
|
url?: string;
|
|
1574
1574
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1587,13 +1587,13 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
1587
1587
|
customData?: string | null;
|
|
1588
1588
|
}
|
|
1589
1589
|
/** @oneof */
|
|
1590
|
-
|
|
1590
|
+
interface V1LinkDataOneOf {
|
|
1591
1591
|
/** The absolute URL for the linked document. */
|
|
1592
1592
|
url?: string;
|
|
1593
1593
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1594
1594
|
anchor?: string;
|
|
1595
1595
|
}
|
|
1596
|
-
|
|
1596
|
+
declare enum Target {
|
|
1597
1597
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1598
1598
|
SELF = "SELF",
|
|
1599
1599
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1603,7 +1603,7 @@ export declare enum Target {
|
|
|
1603
1603
|
/** Opens the linked document in the full body of the window */
|
|
1604
1604
|
TOP = "TOP"
|
|
1605
1605
|
}
|
|
1606
|
-
|
|
1606
|
+
interface Rel {
|
|
1607
1607
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1608
1608
|
nofollow?: boolean | null;
|
|
1609
1609
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1613,17 +1613,17 @@ export interface Rel {
|
|
|
1613
1613
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1614
1614
|
noreferrer?: boolean | null;
|
|
1615
1615
|
}
|
|
1616
|
-
|
|
1616
|
+
interface CodeBlockData {
|
|
1617
1617
|
/** Styling for the code block's text. */
|
|
1618
1618
|
textStyle?: TextStyle;
|
|
1619
1619
|
}
|
|
1620
|
-
|
|
1620
|
+
interface TextStyle {
|
|
1621
1621
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1622
1622
|
textAlignment?: TextAlignment;
|
|
1623
1623
|
/** 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. */
|
|
1624
1624
|
lineHeight?: string | null;
|
|
1625
1625
|
}
|
|
1626
|
-
|
|
1626
|
+
declare enum TextAlignment {
|
|
1627
1627
|
/** browser default, eqivalent to `initial` */
|
|
1628
1628
|
AUTO = "AUTO",
|
|
1629
1629
|
/** Left align */
|
|
@@ -1635,7 +1635,7 @@ export declare enum TextAlignment {
|
|
|
1635
1635
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
1636
1636
|
JUSTIFY = "JUSTIFY"
|
|
1637
1637
|
}
|
|
1638
|
-
|
|
1638
|
+
interface DividerData {
|
|
1639
1639
|
/** Styling for the divider's container. */
|
|
1640
1640
|
containerData?: PluginContainerData;
|
|
1641
1641
|
/** Divider line style. */
|
|
@@ -1645,7 +1645,7 @@ export interface DividerData {
|
|
|
1645
1645
|
/** Divider alignment. */
|
|
1646
1646
|
alignment?: Alignment;
|
|
1647
1647
|
}
|
|
1648
|
-
|
|
1648
|
+
declare enum LineStyle {
|
|
1649
1649
|
/** Single Line */
|
|
1650
1650
|
SINGLE = "SINGLE",
|
|
1651
1651
|
/** Double Line */
|
|
@@ -1655,7 +1655,7 @@ export declare enum LineStyle {
|
|
|
1655
1655
|
/** Dotted Line */
|
|
1656
1656
|
DOTTED = "DOTTED"
|
|
1657
1657
|
}
|
|
1658
|
-
|
|
1658
|
+
declare enum Width {
|
|
1659
1659
|
/** Large line */
|
|
1660
1660
|
LARGE = "LARGE",
|
|
1661
1661
|
/** Medium line */
|
|
@@ -1663,7 +1663,7 @@ export declare enum Width {
|
|
|
1663
1663
|
/** Small line */
|
|
1664
1664
|
SMALL = "SMALL"
|
|
1665
1665
|
}
|
|
1666
|
-
|
|
1666
|
+
declare enum Alignment {
|
|
1667
1667
|
/** Center alignment */
|
|
1668
1668
|
CENTER = "CENTER",
|
|
1669
1669
|
/** Left alignment */
|
|
@@ -1671,7 +1671,7 @@ export declare enum Alignment {
|
|
|
1671
1671
|
/** Right alignment */
|
|
1672
1672
|
RIGHT = "RIGHT"
|
|
1673
1673
|
}
|
|
1674
|
-
|
|
1674
|
+
interface FileData {
|
|
1675
1675
|
/** Styling for the file's container. */
|
|
1676
1676
|
containerData?: PluginContainerData;
|
|
1677
1677
|
/** The source for the file's data. */
|
|
@@ -1694,7 +1694,7 @@ export interface FileData {
|
|
|
1694
1694
|
/** File size in KB. */
|
|
1695
1695
|
sizeInKb?: string | null;
|
|
1696
1696
|
}
|
|
1697
|
-
|
|
1697
|
+
declare enum ViewMode {
|
|
1698
1698
|
/** No PDF view */
|
|
1699
1699
|
NONE = "NONE",
|
|
1700
1700
|
/** Full PDF view */
|
|
@@ -1702,7 +1702,7 @@ export declare enum ViewMode {
|
|
|
1702
1702
|
/** Mini PDF view */
|
|
1703
1703
|
MINI = "MINI"
|
|
1704
1704
|
}
|
|
1705
|
-
|
|
1705
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1706
1706
|
/** The absolute URL for the file's source. */
|
|
1707
1707
|
url?: string | null;
|
|
1708
1708
|
/**
|
|
@@ -1716,7 +1716,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1716
1716
|
private?: boolean | null;
|
|
1717
1717
|
}
|
|
1718
1718
|
/** @oneof */
|
|
1719
|
-
|
|
1719
|
+
interface FileSourceDataOneOf {
|
|
1720
1720
|
/** The absolute URL for the file's source. */
|
|
1721
1721
|
url?: string | null;
|
|
1722
1722
|
/**
|
|
@@ -1727,7 +1727,7 @@ export interface FileSourceDataOneOf {
|
|
|
1727
1727
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1728
1728
|
_id?: string | null;
|
|
1729
1729
|
}
|
|
1730
|
-
|
|
1730
|
+
interface PDFSettings {
|
|
1731
1731
|
/**
|
|
1732
1732
|
* PDF view mode. One of the following:
|
|
1733
1733
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1740,7 +1740,7 @@ export interface PDFSettings {
|
|
|
1740
1740
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1741
1741
|
disablePrint?: boolean | null;
|
|
1742
1742
|
}
|
|
1743
|
-
|
|
1743
|
+
interface GalleryData {
|
|
1744
1744
|
/** Styling for the gallery's container. */
|
|
1745
1745
|
containerData?: PluginContainerData;
|
|
1746
1746
|
/** The items in the gallery. */
|
|
@@ -1752,7 +1752,7 @@ export interface GalleryData {
|
|
|
1752
1752
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1753
1753
|
disableDownload?: boolean | null;
|
|
1754
1754
|
}
|
|
1755
|
-
|
|
1755
|
+
interface Media {
|
|
1756
1756
|
/** The source for the media's data. */
|
|
1757
1757
|
src?: FileSource;
|
|
1758
1758
|
/** Media width in pixels. */
|
|
@@ -1762,19 +1762,19 @@ export interface Media {
|
|
|
1762
1762
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1763
1763
|
duration?: number | null;
|
|
1764
1764
|
}
|
|
1765
|
-
|
|
1765
|
+
interface Image {
|
|
1766
1766
|
/** Image file details. */
|
|
1767
1767
|
media?: Media;
|
|
1768
1768
|
/** Link details for images that are links. */
|
|
1769
1769
|
link?: V1Link;
|
|
1770
1770
|
}
|
|
1771
|
-
|
|
1771
|
+
interface Video {
|
|
1772
1772
|
/** Video file details. */
|
|
1773
1773
|
media?: Media;
|
|
1774
1774
|
/** Video thumbnail file details. */
|
|
1775
1775
|
thumbnail?: Media;
|
|
1776
1776
|
}
|
|
1777
|
-
|
|
1777
|
+
interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
1778
1778
|
/** An image item. */
|
|
1779
1779
|
image?: Image;
|
|
1780
1780
|
/** A video item. */
|
|
@@ -1785,13 +1785,13 @@ export interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
|
1785
1785
|
altText?: string | null;
|
|
1786
1786
|
}
|
|
1787
1787
|
/** @oneof */
|
|
1788
|
-
|
|
1788
|
+
interface GalleryDataItemDataOneOf {
|
|
1789
1789
|
/** An image item. */
|
|
1790
1790
|
image?: Image;
|
|
1791
1791
|
/** A video item. */
|
|
1792
1792
|
video?: Video;
|
|
1793
1793
|
}
|
|
1794
|
-
|
|
1794
|
+
interface GalleryOptions {
|
|
1795
1795
|
/** Gallery layout. */
|
|
1796
1796
|
layout?: Layout;
|
|
1797
1797
|
/** Styling for gallery items. */
|
|
@@ -1799,7 +1799,7 @@ export interface GalleryOptions {
|
|
|
1799
1799
|
/** Styling for gallery thumbnail images. */
|
|
1800
1800
|
thumbnails?: Thumbnails;
|
|
1801
1801
|
}
|
|
1802
|
-
|
|
1802
|
+
declare enum LayoutType {
|
|
1803
1803
|
/** Collage type */
|
|
1804
1804
|
COLLAGE = "COLLAGE",
|
|
1805
1805
|
/** Masonry type */
|
|
@@ -1821,19 +1821,19 @@ export declare enum LayoutType {
|
|
|
1821
1821
|
/** Fullsize images type */
|
|
1822
1822
|
FULLSIZE = "FULLSIZE"
|
|
1823
1823
|
}
|
|
1824
|
-
|
|
1824
|
+
declare enum Orientation {
|
|
1825
1825
|
/** Rows Orientation */
|
|
1826
1826
|
ROWS = "ROWS",
|
|
1827
1827
|
/** Columns Orientation */
|
|
1828
1828
|
COLUMNS = "COLUMNS"
|
|
1829
1829
|
}
|
|
1830
|
-
|
|
1830
|
+
declare enum Crop {
|
|
1831
1831
|
/** Crop to fill */
|
|
1832
1832
|
FILL = "FILL",
|
|
1833
1833
|
/** Crop to fit */
|
|
1834
1834
|
FIT = "FIT"
|
|
1835
1835
|
}
|
|
1836
|
-
|
|
1836
|
+
declare enum ThumbnailsAlignment {
|
|
1837
1837
|
/** Top alignment */
|
|
1838
1838
|
TOP = "TOP",
|
|
1839
1839
|
/** Right alignment */
|
|
@@ -1845,7 +1845,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
1845
1845
|
/** No thumbnail */
|
|
1846
1846
|
NONE = "NONE"
|
|
1847
1847
|
}
|
|
1848
|
-
|
|
1848
|
+
interface Layout {
|
|
1849
1849
|
/** Gallery layout type. */
|
|
1850
1850
|
type?: LayoutType;
|
|
1851
1851
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -1857,7 +1857,7 @@ export interface Layout {
|
|
|
1857
1857
|
/** The number of columns to display on mobile screens. */
|
|
1858
1858
|
mobileNumberOfColumns?: number | null;
|
|
1859
1859
|
}
|
|
1860
|
-
|
|
1860
|
+
interface ItemStyle {
|
|
1861
1861
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1862
1862
|
targetSize?: number | null;
|
|
1863
1863
|
/** Item ratio */
|
|
@@ -1867,13 +1867,13 @@ export interface ItemStyle {
|
|
|
1867
1867
|
/** The spacing between items in pixels. */
|
|
1868
1868
|
spacing?: number | null;
|
|
1869
1869
|
}
|
|
1870
|
-
|
|
1870
|
+
interface Thumbnails {
|
|
1871
1871
|
/** Thumbnail alignment. */
|
|
1872
1872
|
placement?: ThumbnailsAlignment;
|
|
1873
1873
|
/** Spacing between thumbnails in pixels. */
|
|
1874
1874
|
spacing?: number | null;
|
|
1875
1875
|
}
|
|
1876
|
-
|
|
1876
|
+
interface GIFData {
|
|
1877
1877
|
/** Styling for the GIF's container. */
|
|
1878
1878
|
containerData?: PluginContainerData;
|
|
1879
1879
|
/** The source of the full size GIF. */
|
|
@@ -1887,7 +1887,7 @@ export interface GIFData {
|
|
|
1887
1887
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1888
1888
|
gifType?: GIFType;
|
|
1889
1889
|
}
|
|
1890
|
-
|
|
1890
|
+
interface GIF {
|
|
1891
1891
|
/**
|
|
1892
1892
|
* GIF format URL.
|
|
1893
1893
|
* @format WEB_URL
|
|
@@ -1904,11 +1904,11 @@ export interface GIF {
|
|
|
1904
1904
|
*/
|
|
1905
1905
|
still?: string | null;
|
|
1906
1906
|
}
|
|
1907
|
-
|
|
1907
|
+
declare enum GIFType {
|
|
1908
1908
|
NORMAL = "NORMAL",
|
|
1909
1909
|
STICKER = "STICKER"
|
|
1910
1910
|
}
|
|
1911
|
-
|
|
1911
|
+
interface HeadingData {
|
|
1912
1912
|
/** Heading level from 1-6. */
|
|
1913
1913
|
level?: number;
|
|
1914
1914
|
/** Styling for the heading text. */
|
|
@@ -1916,7 +1916,7 @@ export interface HeadingData {
|
|
|
1916
1916
|
/** Indentation level from 1-4. */
|
|
1917
1917
|
indentation?: number | null;
|
|
1918
1918
|
}
|
|
1919
|
-
|
|
1919
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1920
1920
|
/** The URL for the HTML code for the node. */
|
|
1921
1921
|
url?: string;
|
|
1922
1922
|
/** The HTML code for the node. */
|
|
@@ -1934,7 +1934,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1934
1934
|
autoHeight?: boolean | null;
|
|
1935
1935
|
}
|
|
1936
1936
|
/** @oneof */
|
|
1937
|
-
|
|
1937
|
+
interface HTMLDataDataOneOf {
|
|
1938
1938
|
/** The URL for the HTML code for the node. */
|
|
1939
1939
|
url?: string;
|
|
1940
1940
|
/** The HTML code for the node. */
|
|
@@ -1945,11 +1945,11 @@ export interface HTMLDataDataOneOf {
|
|
|
1945
1945
|
*/
|
|
1946
1946
|
isAdsense?: boolean | null;
|
|
1947
1947
|
}
|
|
1948
|
-
|
|
1948
|
+
declare enum Source {
|
|
1949
1949
|
HTML = "HTML",
|
|
1950
1950
|
ADSENSE = "ADSENSE"
|
|
1951
1951
|
}
|
|
1952
|
-
|
|
1952
|
+
interface ImageData {
|
|
1953
1953
|
/** Styling for the image's container. */
|
|
1954
1954
|
containerData?: PluginContainerData;
|
|
1955
1955
|
/** Image file details. */
|
|
@@ -1972,7 +1972,7 @@ export interface ImageData {
|
|
|
1972
1972
|
/** Styling for the image. */
|
|
1973
1973
|
styles?: ImageDataStyles;
|
|
1974
1974
|
}
|
|
1975
|
-
|
|
1975
|
+
interface StylesBorder {
|
|
1976
1976
|
/** Border width in pixels. */
|
|
1977
1977
|
width?: number | null;
|
|
1978
1978
|
/**
|
|
@@ -1983,11 +1983,11 @@ export interface StylesBorder {
|
|
|
1983
1983
|
/** Border radius in pixels. */
|
|
1984
1984
|
radius?: number | null;
|
|
1985
1985
|
}
|
|
1986
|
-
|
|
1986
|
+
interface ImageDataStyles {
|
|
1987
1987
|
/** Border attributes. */
|
|
1988
1988
|
border?: StylesBorder;
|
|
1989
1989
|
}
|
|
1990
|
-
|
|
1990
|
+
interface LinkPreviewData {
|
|
1991
1991
|
/** Styling for the link preview's container. */
|
|
1992
1992
|
containerData?: PluginContainerData;
|
|
1993
1993
|
/** Link details. */
|
|
@@ -2003,7 +2003,7 @@ export interface LinkPreviewData {
|
|
|
2003
2003
|
/** Styling for the link preview. */
|
|
2004
2004
|
styles?: LinkPreviewDataStyles;
|
|
2005
2005
|
}
|
|
2006
|
-
|
|
2006
|
+
declare enum Position {
|
|
2007
2007
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2008
2008
|
START = "START",
|
|
2009
2009
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2013,7 +2013,7 @@ export declare enum Position {
|
|
|
2013
2013
|
/** Thumbnail hidden and not displayed */
|
|
2014
2014
|
HIDDEN = "HIDDEN"
|
|
2015
2015
|
}
|
|
2016
|
-
|
|
2016
|
+
interface LinkPreviewDataStyles {
|
|
2017
2017
|
/**
|
|
2018
2018
|
* Background color as a hexadecimal value.
|
|
2019
2019
|
* @format COLOR_HEX
|
|
@@ -2046,13 +2046,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2046
2046
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2047
2047
|
thumbnailPosition?: Position;
|
|
2048
2048
|
}
|
|
2049
|
-
|
|
2049
|
+
interface MapData {
|
|
2050
2050
|
/** Styling for the map's container. */
|
|
2051
2051
|
containerData?: PluginContainerData;
|
|
2052
2052
|
/** Map settings. */
|
|
2053
2053
|
mapSettings?: MapSettings;
|
|
2054
2054
|
}
|
|
2055
|
-
|
|
2055
|
+
interface MapSettings {
|
|
2056
2056
|
/** The address to display on the map. */
|
|
2057
2057
|
address?: string | null;
|
|
2058
2058
|
/** Sets whether the map is draggable. */
|
|
@@ -2076,7 +2076,7 @@ export interface MapSettings {
|
|
|
2076
2076
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2077
2077
|
mapType?: MapType;
|
|
2078
2078
|
}
|
|
2079
|
-
|
|
2079
|
+
declare enum MapType {
|
|
2080
2080
|
/** Roadmap map type */
|
|
2081
2081
|
ROADMAP = "ROADMAP",
|
|
2082
2082
|
/** Satellite map type */
|
|
@@ -2086,7 +2086,7 @@ export declare enum MapType {
|
|
|
2086
2086
|
/** Terrain map type */
|
|
2087
2087
|
TERRAIN = "TERRAIN"
|
|
2088
2088
|
}
|
|
2089
|
-
|
|
2089
|
+
interface ParagraphData {
|
|
2090
2090
|
/** Styling for the paragraph text. */
|
|
2091
2091
|
textStyle?: TextStyle;
|
|
2092
2092
|
/** Indentation level from 1-4. */
|
|
@@ -2094,7 +2094,7 @@ export interface ParagraphData {
|
|
|
2094
2094
|
/** Paragraph level */
|
|
2095
2095
|
level?: number | null;
|
|
2096
2096
|
}
|
|
2097
|
-
|
|
2097
|
+
interface PollData {
|
|
2098
2098
|
/** Styling for the poll's container. */
|
|
2099
2099
|
containerData?: PluginContainerData;
|
|
2100
2100
|
/** Poll data. */
|
|
@@ -2104,7 +2104,7 @@ export interface PollData {
|
|
|
2104
2104
|
/** Styling for the poll and voting options. */
|
|
2105
2105
|
design?: Design;
|
|
2106
2106
|
}
|
|
2107
|
-
|
|
2107
|
+
declare enum ViewRole {
|
|
2108
2108
|
/** Only Poll creator can view the results */
|
|
2109
2109
|
CREATOR = "CREATOR",
|
|
2110
2110
|
/** Anyone who voted can see the results */
|
|
@@ -2112,13 +2112,13 @@ export declare enum ViewRole {
|
|
|
2112
2112
|
/** Anyone can see the results, even if one didn't vote */
|
|
2113
2113
|
EVERYONE = "EVERYONE"
|
|
2114
2114
|
}
|
|
2115
|
-
|
|
2115
|
+
declare enum VoteRole {
|
|
2116
2116
|
/** Logged in member */
|
|
2117
2117
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2118
2118
|
/** Anyone */
|
|
2119
2119
|
ALL = "ALL"
|
|
2120
2120
|
}
|
|
2121
|
-
|
|
2121
|
+
interface Permissions {
|
|
2122
2122
|
/** Sets who can view the poll results. */
|
|
2123
2123
|
view?: ViewRole;
|
|
2124
2124
|
/** Sets who can vote. */
|
|
@@ -2126,7 +2126,7 @@ export interface Permissions {
|
|
|
2126
2126
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2127
2127
|
allowMultipleVotes?: boolean | null;
|
|
2128
2128
|
}
|
|
2129
|
-
|
|
2129
|
+
interface Option {
|
|
2130
2130
|
/** Option ID. */
|
|
2131
2131
|
_id?: string | null;
|
|
2132
2132
|
/** Option title. */
|
|
@@ -2134,7 +2134,7 @@ export interface Option {
|
|
|
2134
2134
|
/** The image displayed with the option. */
|
|
2135
2135
|
image?: Media;
|
|
2136
2136
|
}
|
|
2137
|
-
|
|
2137
|
+
interface PollSettings {
|
|
2138
2138
|
/** Permissions settings for voting. */
|
|
2139
2139
|
permissions?: Permissions;
|
|
2140
2140
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2142,19 +2142,19 @@ export interface PollSettings {
|
|
|
2142
2142
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2143
2143
|
showVotesCount?: boolean | null;
|
|
2144
2144
|
}
|
|
2145
|
-
|
|
2145
|
+
declare enum PollLayoutType {
|
|
2146
2146
|
/** List */
|
|
2147
2147
|
LIST = "LIST",
|
|
2148
2148
|
/** Grid */
|
|
2149
2149
|
GRID = "GRID"
|
|
2150
2150
|
}
|
|
2151
|
-
|
|
2151
|
+
declare enum PollLayoutDirection {
|
|
2152
2152
|
/** Left-to-right */
|
|
2153
2153
|
LTR = "LTR",
|
|
2154
2154
|
/** Right-to-left */
|
|
2155
2155
|
RTL = "RTL"
|
|
2156
2156
|
}
|
|
2157
|
-
|
|
2157
|
+
interface PollLayout {
|
|
2158
2158
|
/** The layout for displaying the voting options. */
|
|
2159
2159
|
type?: PollLayoutType;
|
|
2160
2160
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2162,11 +2162,11 @@ export interface PollLayout {
|
|
|
2162
2162
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2163
2163
|
enableImage?: boolean | null;
|
|
2164
2164
|
}
|
|
2165
|
-
|
|
2165
|
+
interface OptionLayout {
|
|
2166
2166
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2167
2167
|
enableImage?: boolean | null;
|
|
2168
2168
|
}
|
|
2169
|
-
|
|
2169
|
+
declare enum BackgroundType {
|
|
2170
2170
|
/** Color background type */
|
|
2171
2171
|
COLOR = "COLOR",
|
|
2172
2172
|
/** Image background type */
|
|
@@ -2174,7 +2174,7 @@ export declare enum BackgroundType {
|
|
|
2174
2174
|
/** Gradiant background type */
|
|
2175
2175
|
GRADIENT = "GRADIENT"
|
|
2176
2176
|
}
|
|
2177
|
-
|
|
2177
|
+
interface Gradient {
|
|
2178
2178
|
/** The gradient angle in degrees. */
|
|
2179
2179
|
angle?: number | null;
|
|
2180
2180
|
/**
|
|
@@ -2188,7 +2188,7 @@ export interface Gradient {
|
|
|
2188
2188
|
*/
|
|
2189
2189
|
lastColor?: string | null;
|
|
2190
2190
|
}
|
|
2191
|
-
|
|
2191
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2192
2192
|
/**
|
|
2193
2193
|
* The background color as a hexademical value.
|
|
2194
2194
|
* @format COLOR_HEX
|
|
@@ -2202,7 +2202,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2202
2202
|
type?: BackgroundType;
|
|
2203
2203
|
}
|
|
2204
2204
|
/** @oneof */
|
|
2205
|
-
|
|
2205
|
+
interface BackgroundBackgroundOneOf {
|
|
2206
2206
|
/**
|
|
2207
2207
|
* The background color as a hexademical value.
|
|
2208
2208
|
* @format COLOR_HEX
|
|
@@ -2213,17 +2213,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2213
2213
|
/** Details for a gradient background. */
|
|
2214
2214
|
gradient?: Gradient;
|
|
2215
2215
|
}
|
|
2216
|
-
|
|
2216
|
+
interface PollDesign {
|
|
2217
2217
|
/** Background styling. */
|
|
2218
2218
|
background?: Background;
|
|
2219
2219
|
/** Border radius in pixels. */
|
|
2220
2220
|
borderRadius?: number | null;
|
|
2221
2221
|
}
|
|
2222
|
-
|
|
2222
|
+
interface OptionDesign {
|
|
2223
2223
|
/** Border radius in pixels. */
|
|
2224
2224
|
borderRadius?: number | null;
|
|
2225
2225
|
}
|
|
2226
|
-
|
|
2226
|
+
interface Poll {
|
|
2227
2227
|
/** Poll ID. */
|
|
2228
2228
|
_id?: string | null;
|
|
2229
2229
|
/** Poll title. */
|
|
@@ -2237,26 +2237,26 @@ export interface Poll {
|
|
|
2237
2237
|
/** The poll's permissions and display settings. */
|
|
2238
2238
|
settings?: PollSettings;
|
|
2239
2239
|
}
|
|
2240
|
-
|
|
2240
|
+
interface PollDataLayout {
|
|
2241
2241
|
/** Poll layout settings. */
|
|
2242
2242
|
poll?: PollLayout;
|
|
2243
2243
|
/** Voting otpions layout settings. */
|
|
2244
2244
|
options?: OptionLayout;
|
|
2245
2245
|
}
|
|
2246
|
-
|
|
2246
|
+
interface Design {
|
|
2247
2247
|
/** Styling for the poll. */
|
|
2248
2248
|
poll?: PollDesign;
|
|
2249
2249
|
/** Styling for voting options. */
|
|
2250
2250
|
options?: OptionDesign;
|
|
2251
2251
|
}
|
|
2252
|
-
|
|
2252
|
+
interface TextData {
|
|
2253
2253
|
/** The text to apply decorations to. */
|
|
2254
2254
|
text?: string;
|
|
2255
2255
|
/** The decorations to apply. */
|
|
2256
2256
|
decorations?: Decoration[];
|
|
2257
2257
|
}
|
|
2258
2258
|
/** Adds appearence changes to text */
|
|
2259
|
-
|
|
2259
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2260
2260
|
/** Data for an anchor link decoration. */
|
|
2261
2261
|
anchorData?: AnchorData;
|
|
2262
2262
|
/** Data for a color decoration. */
|
|
@@ -2279,7 +2279,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2279
2279
|
type?: DecorationType;
|
|
2280
2280
|
}
|
|
2281
2281
|
/** @oneof */
|
|
2282
|
-
|
|
2282
|
+
interface DecorationDataOneOf {
|
|
2283
2283
|
/** Data for an anchor link decoration. */
|
|
2284
2284
|
anchorData?: AnchorData;
|
|
2285
2285
|
/** Data for a color decoration. */
|
|
@@ -2299,7 +2299,7 @@ export interface DecorationDataOneOf {
|
|
|
2299
2299
|
/** Data for a spoiler decoration. */
|
|
2300
2300
|
spoilerData?: SpoilerData;
|
|
2301
2301
|
}
|
|
2302
|
-
|
|
2302
|
+
declare enum DecorationType {
|
|
2303
2303
|
BOLD = "BOLD",
|
|
2304
2304
|
ITALIC = "ITALIC",
|
|
2305
2305
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2311,21 +2311,21 @@ export declare enum DecorationType {
|
|
|
2311
2311
|
FONT_SIZE = "FONT_SIZE",
|
|
2312
2312
|
EXTERNAL = "EXTERNAL"
|
|
2313
2313
|
}
|
|
2314
|
-
|
|
2314
|
+
interface AnchorData {
|
|
2315
2315
|
/** The target node's ID. */
|
|
2316
2316
|
anchor?: string;
|
|
2317
2317
|
}
|
|
2318
|
-
|
|
2318
|
+
interface ColorData {
|
|
2319
2319
|
/** The text's background color as a hexadecimal value. */
|
|
2320
2320
|
background?: string | null;
|
|
2321
2321
|
/** The text's foreground color as a hexadecimal value. */
|
|
2322
2322
|
foreground?: string | null;
|
|
2323
2323
|
}
|
|
2324
|
-
|
|
2324
|
+
interface LinkData {
|
|
2325
2325
|
/** Link details. */
|
|
2326
2326
|
link?: V1Link;
|
|
2327
2327
|
}
|
|
2328
|
-
|
|
2328
|
+
interface MentionData {
|
|
2329
2329
|
/** The mentioned user's name. */
|
|
2330
2330
|
name?: string;
|
|
2331
2331
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2333,21 +2333,21 @@ export interface MentionData {
|
|
|
2333
2333
|
/** Mentioned user's ID. */
|
|
2334
2334
|
_id?: string | null;
|
|
2335
2335
|
}
|
|
2336
|
-
|
|
2336
|
+
interface FontSizeData {
|
|
2337
2337
|
/** The units used for the font size. */
|
|
2338
2338
|
unit?: FontType;
|
|
2339
2339
|
/** Font size value. */
|
|
2340
2340
|
value?: number | null;
|
|
2341
2341
|
}
|
|
2342
|
-
|
|
2342
|
+
declare enum FontType {
|
|
2343
2343
|
PX = "PX",
|
|
2344
2344
|
EM = "EM"
|
|
2345
2345
|
}
|
|
2346
|
-
|
|
2346
|
+
interface SpoilerData {
|
|
2347
2347
|
/** Spoiler ID. */
|
|
2348
2348
|
_id?: string | null;
|
|
2349
2349
|
}
|
|
2350
|
-
|
|
2350
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2351
2351
|
/** Data for embedded Wix Bookings content. */
|
|
2352
2352
|
bookingData?: BookingData;
|
|
2353
2353
|
/** Data for embedded Wix Events content. */
|
|
@@ -2369,28 +2369,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2369
2369
|
image?: Media;
|
|
2370
2370
|
}
|
|
2371
2371
|
/** @oneof */
|
|
2372
|
-
|
|
2372
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2373
2373
|
/** Data for embedded Wix Bookings content. */
|
|
2374
2374
|
bookingData?: BookingData;
|
|
2375
2375
|
/** Data for embedded Wix Events content. */
|
|
2376
2376
|
eventData?: EventData;
|
|
2377
2377
|
}
|
|
2378
|
-
|
|
2378
|
+
declare enum AppType {
|
|
2379
2379
|
PRODUCT = "PRODUCT",
|
|
2380
2380
|
EVENT = "EVENT",
|
|
2381
2381
|
BOOKING = "BOOKING"
|
|
2382
2382
|
}
|
|
2383
|
-
|
|
2383
|
+
interface BookingData {
|
|
2384
2384
|
/** Booking duration in minutes. */
|
|
2385
2385
|
durations?: string | null;
|
|
2386
2386
|
}
|
|
2387
|
-
|
|
2387
|
+
interface EventData {
|
|
2388
2388
|
/** Event schedule. */
|
|
2389
2389
|
scheduling?: string | null;
|
|
2390
2390
|
/** Event location. */
|
|
2391
2391
|
location?: string | null;
|
|
2392
2392
|
}
|
|
2393
|
-
|
|
2393
|
+
interface VideoData {
|
|
2394
2394
|
/** Styling for the video's container. */
|
|
2395
2395
|
containerData?: PluginContainerData;
|
|
2396
2396
|
/** Video details. */
|
|
@@ -2404,7 +2404,7 @@ export interface VideoData {
|
|
|
2404
2404
|
/** Video options. */
|
|
2405
2405
|
options?: PlaybackOptions;
|
|
2406
2406
|
}
|
|
2407
|
-
|
|
2407
|
+
interface PlaybackOptions {
|
|
2408
2408
|
/** Sets whether the media will automatically start playing. */
|
|
2409
2409
|
autoPlay?: boolean | null;
|
|
2410
2410
|
/** Sets whether media's will be looped. */
|
|
@@ -2412,7 +2412,7 @@ export interface PlaybackOptions {
|
|
|
2412
2412
|
/** Sets whether media's controls will be shown. */
|
|
2413
2413
|
showControls?: boolean | null;
|
|
2414
2414
|
}
|
|
2415
|
-
|
|
2415
|
+
interface EmbedData {
|
|
2416
2416
|
/** Styling for the oEmbed node's container. */
|
|
2417
2417
|
containerData?: PluginContainerData;
|
|
2418
2418
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2420,7 +2420,7 @@ export interface EmbedData {
|
|
|
2420
2420
|
/** Origin asset source. */
|
|
2421
2421
|
src?: string | null;
|
|
2422
2422
|
}
|
|
2423
|
-
|
|
2423
|
+
interface Oembed {
|
|
2424
2424
|
/** The resource type. */
|
|
2425
2425
|
type?: string | null;
|
|
2426
2426
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2452,7 +2452,7 @@ export interface Oembed {
|
|
|
2452
2452
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2453
2453
|
version?: string | null;
|
|
2454
2454
|
}
|
|
2455
|
-
|
|
2455
|
+
interface CollapsibleListData {
|
|
2456
2456
|
/** Styling for the collapsible list's container. */
|
|
2457
2457
|
containerData?: PluginContainerData;
|
|
2458
2458
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2464,7 +2464,7 @@ export interface CollapsibleListData {
|
|
|
2464
2464
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2465
2465
|
isQapageData?: boolean | null;
|
|
2466
2466
|
}
|
|
2467
|
-
|
|
2467
|
+
declare enum InitialExpandedItems {
|
|
2468
2468
|
/** First item will be expended initally */
|
|
2469
2469
|
FIRST = "FIRST",
|
|
2470
2470
|
/** All items will expended initally */
|
|
@@ -2472,13 +2472,13 @@ export declare enum InitialExpandedItems {
|
|
|
2472
2472
|
/** All items collapsed initally */
|
|
2473
2473
|
NONE = "NONE"
|
|
2474
2474
|
}
|
|
2475
|
-
|
|
2475
|
+
declare enum Direction {
|
|
2476
2476
|
/** Left-to-right */
|
|
2477
2477
|
LTR = "LTR",
|
|
2478
2478
|
/** Right-to-left */
|
|
2479
2479
|
RTL = "RTL"
|
|
2480
2480
|
}
|
|
2481
|
-
|
|
2481
|
+
interface TableData {
|
|
2482
2482
|
/** Styling for the table's container. */
|
|
2483
2483
|
containerData?: PluginContainerData;
|
|
2484
2484
|
/** The table's dimensions. */
|
|
@@ -2493,7 +2493,7 @@ export interface TableData {
|
|
|
2493
2493
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2494
2494
|
columnHeader?: boolean | null;
|
|
2495
2495
|
}
|
|
2496
|
-
|
|
2496
|
+
interface Dimensions {
|
|
2497
2497
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2498
2498
|
colsWidthRatio?: number[];
|
|
2499
2499
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2501,13 +2501,13 @@ export interface Dimensions {
|
|
|
2501
2501
|
/** An array representing the minimum width of each column in pixels. */
|
|
2502
2502
|
colsMinWidth?: number[];
|
|
2503
2503
|
}
|
|
2504
|
-
|
|
2504
|
+
interface TableCellData {
|
|
2505
2505
|
/** Styling for the cell's background color and text alignment. */
|
|
2506
2506
|
cellStyle?: CellStyle;
|
|
2507
2507
|
/** The cell's border colors. */
|
|
2508
2508
|
borderColors?: BorderColors;
|
|
2509
2509
|
}
|
|
2510
|
-
|
|
2510
|
+
declare enum VerticalAlignment {
|
|
2511
2511
|
/** Top alignment */
|
|
2512
2512
|
TOP = "TOP",
|
|
2513
2513
|
/** Middle alignment */
|
|
@@ -2515,7 +2515,7 @@ export declare enum VerticalAlignment {
|
|
|
2515
2515
|
/** Bottom alignment */
|
|
2516
2516
|
BOTTOM = "BOTTOM"
|
|
2517
2517
|
}
|
|
2518
|
-
|
|
2518
|
+
interface CellStyle {
|
|
2519
2519
|
/** Vertical alignment for the cell's text. */
|
|
2520
2520
|
verticalAlignment?: VerticalAlignment;
|
|
2521
2521
|
/**
|
|
@@ -2524,7 +2524,7 @@ export interface CellStyle {
|
|
|
2524
2524
|
*/
|
|
2525
2525
|
backgroundColor?: string | null;
|
|
2526
2526
|
}
|
|
2527
|
-
|
|
2527
|
+
interface BorderColors {
|
|
2528
2528
|
/**
|
|
2529
2529
|
* Left border color as a hexadecimal value.
|
|
2530
2530
|
* @format COLOR_HEX
|
|
@@ -2552,7 +2552,7 @@ export interface BorderColors {
|
|
|
2552
2552
|
*
|
|
2553
2553
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2554
2554
|
*/
|
|
2555
|
-
|
|
2555
|
+
declare enum NullValue {
|
|
2556
2556
|
/** Null value. */
|
|
2557
2557
|
NULL_VALUE = "NULL_VALUE"
|
|
2558
2558
|
}
|
|
@@ -2561,11 +2561,11 @@ export declare enum NullValue {
|
|
|
2561
2561
|
*
|
|
2562
2562
|
* The JSON representation for `ListValue` is JSON array.
|
|
2563
2563
|
*/
|
|
2564
|
-
|
|
2564
|
+
interface ListValue {
|
|
2565
2565
|
/** Repeated field of dynamically typed values. */
|
|
2566
2566
|
values?: any[];
|
|
2567
2567
|
}
|
|
2568
|
-
|
|
2568
|
+
interface AudioData {
|
|
2569
2569
|
/** Styling for the audio node's container. */
|
|
2570
2570
|
containerData?: PluginContainerData;
|
|
2571
2571
|
/** Audio file details. */
|
|
@@ -2581,7 +2581,7 @@ export interface AudioData {
|
|
|
2581
2581
|
/** An HTML version of the audio node. */
|
|
2582
2582
|
html?: string | null;
|
|
2583
2583
|
}
|
|
2584
|
-
|
|
2584
|
+
interface OrderedListData {
|
|
2585
2585
|
/** Indentation level from 0-4. */
|
|
2586
2586
|
indentation?: number;
|
|
2587
2587
|
/** Offset level from 0-4. */
|
|
@@ -2589,24 +2589,24 @@ export interface OrderedListData {
|
|
|
2589
2589
|
/** List start number. */
|
|
2590
2590
|
start?: number | null;
|
|
2591
2591
|
}
|
|
2592
|
-
|
|
2592
|
+
interface BulletedListData {
|
|
2593
2593
|
/** Indentation level from 0-4. */
|
|
2594
2594
|
indentation?: number;
|
|
2595
2595
|
/** Offset level from 0-4. */
|
|
2596
2596
|
offset?: number | null;
|
|
2597
2597
|
}
|
|
2598
|
-
|
|
2598
|
+
interface BlockquoteData {
|
|
2599
2599
|
/** Indentation level from 1-4. */
|
|
2600
2600
|
indentation?: number;
|
|
2601
2601
|
}
|
|
2602
|
-
|
|
2602
|
+
interface CaptionData {
|
|
2603
2603
|
textStyle?: TextStyle;
|
|
2604
2604
|
}
|
|
2605
|
-
|
|
2605
|
+
interface LayoutCellData {
|
|
2606
2606
|
/** Size of the cell in 12 columns grid. */
|
|
2607
2607
|
colSpan?: number | null;
|
|
2608
2608
|
}
|
|
2609
|
-
|
|
2609
|
+
interface Metadata {
|
|
2610
2610
|
/** Schema version. */
|
|
2611
2611
|
version?: number;
|
|
2612
2612
|
/**
|
|
@@ -2623,7 +2623,7 @@ export interface Metadata {
|
|
|
2623
2623
|
/** Object ID. */
|
|
2624
2624
|
_id?: string | null;
|
|
2625
2625
|
}
|
|
2626
|
-
|
|
2626
|
+
interface DocumentStyle {
|
|
2627
2627
|
/** Styling for H1 nodes. */
|
|
2628
2628
|
headerOne?: TextNodeStyle;
|
|
2629
2629
|
/** Styling for H2 nodes. */
|
|
@@ -2643,7 +2643,7 @@ export interface DocumentStyle {
|
|
|
2643
2643
|
/** Styling for code block nodes. */
|
|
2644
2644
|
codeBlock?: TextNodeStyle;
|
|
2645
2645
|
}
|
|
2646
|
-
|
|
2646
|
+
interface TextNodeStyle {
|
|
2647
2647
|
/** The decorations to apply to the node. */
|
|
2648
2648
|
decorations?: Decoration[];
|
|
2649
2649
|
/** Padding and background color for the node. */
|
|
@@ -2651,7 +2651,7 @@ export interface TextNodeStyle {
|
|
|
2651
2651
|
/** Line height for text in the node. */
|
|
2652
2652
|
lineHeight?: string | null;
|
|
2653
2653
|
}
|
|
2654
|
-
|
|
2654
|
+
interface Badge {
|
|
2655
2655
|
/** Badge type. */
|
|
2656
2656
|
type?: Type;
|
|
2657
2657
|
/**
|
|
@@ -2660,7 +2660,7 @@ export interface Badge {
|
|
|
2660
2660
|
*/
|
|
2661
2661
|
text?: string | null;
|
|
2662
2662
|
}
|
|
2663
|
-
|
|
2663
|
+
declare enum Type {
|
|
2664
2664
|
/** Unknown badge type. */
|
|
2665
2665
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2666
2666
|
/** Urgent badge type. */
|
|
@@ -2670,7 +2670,7 @@ export declare enum Type {
|
|
|
2670
2670
|
/** General badge type. */
|
|
2671
2671
|
GENERAL = "GENERAL"
|
|
2672
2672
|
}
|
|
2673
|
-
|
|
2673
|
+
interface OrderConfirmed {
|
|
2674
2674
|
/** Order confirmation timestamp in ISO UTC. */
|
|
2675
2675
|
timestamp?: Date | null;
|
|
2676
2676
|
/**
|
|
@@ -2723,14 +2723,14 @@ export interface OrderConfirmed {
|
|
|
2723
2723
|
/** Reservation ID associated with this order. */
|
|
2724
2724
|
reservationId?: string;
|
|
2725
2725
|
}
|
|
2726
|
-
|
|
2726
|
+
interface FormResponse {
|
|
2727
2727
|
/**
|
|
2728
2728
|
* Input values entered when filling the form.
|
|
2729
2729
|
* @maxSize 200
|
|
2730
2730
|
*/
|
|
2731
2731
|
inputValues?: InputValue[];
|
|
2732
2732
|
}
|
|
2733
|
-
|
|
2733
|
+
interface InputValue {
|
|
2734
2734
|
/**
|
|
2735
2735
|
* Input field name.
|
|
2736
2736
|
* @maxLength 100
|
|
@@ -2748,7 +2748,7 @@ export interface InputValue {
|
|
|
2748
2748
|
*/
|
|
2749
2749
|
values?: string[];
|
|
2750
2750
|
}
|
|
2751
|
-
|
|
2751
|
+
interface FormattedAddress {
|
|
2752
2752
|
/**
|
|
2753
2753
|
* One line address representation.
|
|
2754
2754
|
* @maxLength 200
|
|
@@ -2758,7 +2758,7 @@ export interface FormattedAddress {
|
|
|
2758
2758
|
address?: CommonAddress;
|
|
2759
2759
|
}
|
|
2760
2760
|
/** Physical address */
|
|
2761
|
-
|
|
2761
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
2762
2762
|
/** Street name and number. */
|
|
2763
2763
|
streetAddress?: CommonStreetAddress;
|
|
2764
2764
|
/** Main address line, usually street and number as free text. */
|
|
@@ -2778,39 +2778,39 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
2778
2778
|
addressLine2?: string | null;
|
|
2779
2779
|
}
|
|
2780
2780
|
/** @oneof */
|
|
2781
|
-
|
|
2781
|
+
interface CommonAddressStreetOneOf {
|
|
2782
2782
|
/** Street name and number. */
|
|
2783
2783
|
streetAddress?: CommonStreetAddress;
|
|
2784
2784
|
/** Main address line, usually street and number as free text. */
|
|
2785
2785
|
addressLine?: string | null;
|
|
2786
2786
|
}
|
|
2787
|
-
|
|
2787
|
+
interface CommonStreetAddress {
|
|
2788
2788
|
/** Street number. */
|
|
2789
2789
|
number?: string;
|
|
2790
2790
|
/** Street name. */
|
|
2791
2791
|
name?: string;
|
|
2792
2792
|
}
|
|
2793
|
-
|
|
2793
|
+
interface CommonAddressLocation {
|
|
2794
2794
|
/** Address latitude. */
|
|
2795
2795
|
latitude?: number | null;
|
|
2796
2796
|
/** Address longitude. */
|
|
2797
2797
|
longitude?: number | null;
|
|
2798
2798
|
}
|
|
2799
|
-
|
|
2799
|
+
interface CommonSubdivision {
|
|
2800
2800
|
/** Short subdivision code. */
|
|
2801
2801
|
code?: string;
|
|
2802
2802
|
/** Subdivision full name. */
|
|
2803
2803
|
name?: string;
|
|
2804
2804
|
}
|
|
2805
2805
|
/** Subdivision Concordance values */
|
|
2806
|
-
|
|
2806
|
+
interface StandardDetails {
|
|
2807
2807
|
/**
|
|
2808
2808
|
* 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
|
|
2809
2809
|
* @maxLength 20
|
|
2810
2810
|
*/
|
|
2811
2811
|
iso31662?: string | null;
|
|
2812
2812
|
}
|
|
2813
|
-
|
|
2813
|
+
declare enum OrderStatus {
|
|
2814
2814
|
/** Order status not available for this request fieldset. */
|
|
2815
2815
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
2816
2816
|
/** Order is confirmed and payment isn't required. */
|
|
@@ -2834,7 +2834,7 @@ export declare enum OrderStatus {
|
|
|
2834
2834
|
/** Order is partially paid with less than the total amount. */
|
|
2835
2835
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
2836
2836
|
}
|
|
2837
|
-
|
|
2837
|
+
interface Ticket {
|
|
2838
2838
|
/** Unique issued ticket number. */
|
|
2839
2839
|
ticketNumber?: string;
|
|
2840
2840
|
/**
|
|
@@ -2882,11 +2882,11 @@ export interface Ticket {
|
|
|
2882
2882
|
/** Whether ticket is canceled. */
|
|
2883
2883
|
canceled?: boolean | null;
|
|
2884
2884
|
}
|
|
2885
|
-
|
|
2885
|
+
interface CheckIn {
|
|
2886
2886
|
/** Time of check-in */
|
|
2887
2887
|
created?: Date | null;
|
|
2888
2888
|
}
|
|
2889
|
-
|
|
2889
|
+
interface OnlineConferencingLogin {
|
|
2890
2890
|
/**
|
|
2891
2891
|
* Link URL to the online conference.
|
|
2892
2892
|
* @format WEB_URL
|
|
@@ -2899,7 +2899,7 @@ export interface OnlineConferencingLogin {
|
|
|
2899
2899
|
*/
|
|
2900
2900
|
password?: string | null;
|
|
2901
2901
|
}
|
|
2902
|
-
|
|
2902
|
+
interface Invoice {
|
|
2903
2903
|
items?: Item[];
|
|
2904
2904
|
/**
|
|
2905
2905
|
* Total cart amount.
|
|
@@ -2931,7 +2931,7 @@ export interface Invoice {
|
|
|
2931
2931
|
/** URL to invoice preview. Returned only if order is paid. */
|
|
2932
2932
|
previewUrl?: string | null;
|
|
2933
2933
|
}
|
|
2934
|
-
|
|
2934
|
+
interface Item {
|
|
2935
2935
|
/**
|
|
2936
2936
|
* Unique line item ID.
|
|
2937
2937
|
* @format GUID
|
|
@@ -2959,7 +2959,7 @@ export interface Item {
|
|
|
2959
2959
|
*/
|
|
2960
2960
|
fees?: Fee[];
|
|
2961
2961
|
}
|
|
2962
|
-
|
|
2962
|
+
interface Discount {
|
|
2963
2963
|
/** Total discount amount. */
|
|
2964
2964
|
amount?: Money;
|
|
2965
2965
|
/** Total charge after applied discount. */
|
|
@@ -2982,7 +2982,7 @@ export interface Discount {
|
|
|
2982
2982
|
/** Discount items. */
|
|
2983
2983
|
discounts?: DiscountItem[];
|
|
2984
2984
|
}
|
|
2985
|
-
|
|
2985
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
2986
2986
|
/** Coupon discount. */
|
|
2987
2987
|
coupon?: CouponDiscount;
|
|
2988
2988
|
/** Pricing plan discount. */
|
|
@@ -2991,13 +2991,13 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
2991
2991
|
amount?: Money;
|
|
2992
2992
|
}
|
|
2993
2993
|
/** @oneof */
|
|
2994
|
-
|
|
2994
|
+
interface DiscountItemDiscountOneOf {
|
|
2995
2995
|
/** Coupon discount. */
|
|
2996
2996
|
coupon?: CouponDiscount;
|
|
2997
2997
|
/** Pricing plan discount. */
|
|
2998
2998
|
paidPlan?: PaidPlanDiscount;
|
|
2999
2999
|
}
|
|
3000
|
-
|
|
3000
|
+
interface CouponDiscount {
|
|
3001
3001
|
/** Discount coupon name. */
|
|
3002
3002
|
name?: string;
|
|
3003
3003
|
/** Discount coupon code. */
|
|
@@ -3005,18 +3005,18 @@ export interface CouponDiscount {
|
|
|
3005
3005
|
/** Discount coupon ID. */
|
|
3006
3006
|
couponId?: string;
|
|
3007
3007
|
}
|
|
3008
|
-
|
|
3008
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
3009
3009
|
/** Discount by percentage applied to tickets. */
|
|
3010
3010
|
percentDiscount?: PercentDiscount;
|
|
3011
3011
|
/** Name of pricing plan. */
|
|
3012
3012
|
name?: string;
|
|
3013
3013
|
}
|
|
3014
3014
|
/** @oneof */
|
|
3015
|
-
|
|
3015
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
3016
3016
|
/** Discount by percentage applied to tickets. */
|
|
3017
3017
|
percentDiscount?: PercentDiscount;
|
|
3018
3018
|
}
|
|
3019
|
-
|
|
3019
|
+
interface PercentDiscount {
|
|
3020
3020
|
/**
|
|
3021
3021
|
* Percent rate.
|
|
3022
3022
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -3025,7 +3025,7 @@ export interface PercentDiscount {
|
|
|
3025
3025
|
/** Number of discounted tickets. */
|
|
3026
3026
|
quantityDiscounted?: number;
|
|
3027
3027
|
}
|
|
3028
|
-
|
|
3028
|
+
interface Tax {
|
|
3029
3029
|
/** Tax type. */
|
|
3030
3030
|
type?: TaxType;
|
|
3031
3031
|
/**
|
|
@@ -3043,7 +3043,7 @@ export interface Tax {
|
|
|
3043
3043
|
/** Total tax amount. */
|
|
3044
3044
|
amount?: Money;
|
|
3045
3045
|
}
|
|
3046
|
-
|
|
3046
|
+
interface Fee {
|
|
3047
3047
|
/** Fee identifier. */
|
|
3048
3048
|
name?: FeeName;
|
|
3049
3049
|
/** How fee is calculated. */
|
|
@@ -3057,11 +3057,11 @@ export interface Fee {
|
|
|
3057
3057
|
/** Total amount of fee charges. */
|
|
3058
3058
|
amount?: Money;
|
|
3059
3059
|
}
|
|
3060
|
-
|
|
3060
|
+
declare enum FeeName {
|
|
3061
3061
|
/** Wix ticket service fee charges applied to the line item. */
|
|
3062
3062
|
WIX_FEE = "WIX_FEE"
|
|
3063
3063
|
}
|
|
3064
|
-
|
|
3064
|
+
declare enum FeeType {
|
|
3065
3065
|
/** Fee is added to the ticket price at checkout. */
|
|
3066
3066
|
FEE_ADDED = "FEE_ADDED",
|
|
3067
3067
|
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
@@ -3070,7 +3070,7 @@ export declare enum FeeType {
|
|
|
3070
3070
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3071
3071
|
}
|
|
3072
3072
|
/** Produced if a buyer email was added to the existing order */
|
|
3073
|
-
|
|
3073
|
+
interface OrderEmailAdded {
|
|
3074
3074
|
/** Order updated timestamp in ISO UTC format. */
|
|
3075
3075
|
timestamp?: Date | null;
|
|
3076
3076
|
/**
|
|
@@ -3154,7 +3154,7 @@ export interface OrderEmailAdded {
|
|
|
3154
3154
|
*/
|
|
3155
3155
|
reservationId?: string;
|
|
3156
3156
|
}
|
|
3157
|
-
|
|
3157
|
+
interface EventCanceled {
|
|
3158
3158
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3159
3159
|
timestamp?: Date | null;
|
|
3160
3160
|
/**
|
|
@@ -3172,7 +3172,7 @@ export interface EventCanceled {
|
|
|
3172
3172
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3173
3173
|
hasGuests?: boolean | null;
|
|
3174
3174
|
}
|
|
3175
|
-
|
|
3175
|
+
interface EventReminder {
|
|
3176
3176
|
/** Reminder timestamp in ISO UTC format. */
|
|
3177
3177
|
timestamp?: Date | null;
|
|
3178
3178
|
/**
|
|
@@ -3200,7 +3200,7 @@ export interface EventReminder {
|
|
|
3200
3200
|
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
3201
3201
|
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
3202
3202
|
*/
|
|
3203
|
-
|
|
3203
|
+
interface TimeDuration {
|
|
3204
3204
|
/** Number of days. */
|
|
3205
3205
|
days?: number;
|
|
3206
3206
|
/**
|
|
@@ -3214,7 +3214,7 @@ export interface TimeDuration {
|
|
|
3214
3214
|
*/
|
|
3215
3215
|
minutes?: number;
|
|
3216
3216
|
}
|
|
3217
|
-
|
|
3217
|
+
interface OrderPaid {
|
|
3218
3218
|
/** Order paid timestamp in ISO UTC. */
|
|
3219
3219
|
timestamp?: Date | null;
|
|
3220
3220
|
/**
|
|
@@ -3285,7 +3285,7 @@ export interface OrderPaid {
|
|
|
3285
3285
|
/** Invoice. */
|
|
3286
3286
|
invoice?: Invoice;
|
|
3287
3287
|
}
|
|
3288
|
-
|
|
3288
|
+
interface TicketPdfResolved {
|
|
3289
3289
|
/**
|
|
3290
3290
|
* Optional order number
|
|
3291
3291
|
* @maxLength 36
|
|
@@ -3309,7 +3309,7 @@ export interface TicketPdfResolved {
|
|
|
3309
3309
|
*/
|
|
3310
3310
|
documentId?: string | null;
|
|
3311
3311
|
}
|
|
3312
|
-
|
|
3312
|
+
interface TicketPdfResolveDelayed {
|
|
3313
3313
|
/**
|
|
3314
3314
|
* Optional order number
|
|
3315
3315
|
* @maxLength 36
|
|
@@ -3326,7 +3326,7 @@ export interface TicketPdfResolveDelayed {
|
|
|
3326
3326
|
*/
|
|
3327
3327
|
documentId?: string | null;
|
|
3328
3328
|
}
|
|
3329
|
-
|
|
3329
|
+
interface OrderCanceled {
|
|
3330
3330
|
/**
|
|
3331
3331
|
* Event ID.
|
|
3332
3332
|
* @format GUID
|
|
@@ -3367,7 +3367,7 @@ export interface OrderCanceled {
|
|
|
3367
3367
|
/** Invoice. */
|
|
3368
3368
|
invoice?: Invoice;
|
|
3369
3369
|
}
|
|
3370
|
-
|
|
3370
|
+
interface EventEnded {
|
|
3371
3371
|
/** Event end timestamp in ISO UTC format. */
|
|
3372
3372
|
timestamp?: Date | null;
|
|
3373
3373
|
/**
|
|
@@ -3378,7 +3378,7 @@ export interface EventEnded {
|
|
|
3378
3378
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3379
3379
|
hasGuests?: boolean | null;
|
|
3380
3380
|
}
|
|
3381
|
-
|
|
3381
|
+
interface EventStarted {
|
|
3382
3382
|
/** Event start timestamp in ISO UTC format. */
|
|
3383
3383
|
timestamp?: Date | null;
|
|
3384
3384
|
/**
|
|
@@ -3389,26 +3389,26 @@ export interface EventStarted {
|
|
|
3389
3389
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3390
3390
|
hasGuests?: boolean | null;
|
|
3391
3391
|
}
|
|
3392
|
-
|
|
3392
|
+
interface ResolveNotificationConfigRequest {
|
|
3393
3393
|
/**
|
|
3394
3394
|
* Id of the NotificationConfig to retrieve
|
|
3395
3395
|
* @format GUID
|
|
3396
3396
|
*/
|
|
3397
3397
|
notificationConfigId: string;
|
|
3398
3398
|
}
|
|
3399
|
-
|
|
3399
|
+
interface ResolveNotificationConfigResponse {
|
|
3400
3400
|
/** The retrieved NotificationConfig */
|
|
3401
3401
|
notificationConfig?: NotificationConfig;
|
|
3402
3402
|
}
|
|
3403
|
-
|
|
3403
|
+
interface UpsertNotificationConfigRequest {
|
|
3404
3404
|
/** NotificationConfig to be upserted */
|
|
3405
3405
|
notificationConfig: NotificationConfig;
|
|
3406
3406
|
}
|
|
3407
|
-
|
|
3407
|
+
interface UpsertNotificationConfigResponse {
|
|
3408
3408
|
/** The upserted NotificationConfig */
|
|
3409
3409
|
notificationConfig?: NotificationConfig;
|
|
3410
3410
|
}
|
|
3411
|
-
|
|
3411
|
+
interface ResolveEmailNotificationConfigRequest {
|
|
3412
3412
|
/**
|
|
3413
3413
|
* Id of the NotificationConfig to retrieve
|
|
3414
3414
|
* @format GUID
|
|
@@ -3417,11 +3417,11 @@ export interface ResolveEmailNotificationConfigRequest {
|
|
|
3417
3417
|
/** Notification type */
|
|
3418
3418
|
notificationType?: EmailNotificationType;
|
|
3419
3419
|
}
|
|
3420
|
-
|
|
3420
|
+
interface ResolveEmailNotificationConfigResponse {
|
|
3421
3421
|
/** The retrieved EmailNotificationConfig */
|
|
3422
3422
|
emailNotificationConfig?: EmailNotificationConfig;
|
|
3423
3423
|
}
|
|
3424
|
-
|
|
3424
|
+
interface EventDeleted {
|
|
3425
3425
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3426
3426
|
timestamp?: Date | null;
|
|
3427
3427
|
/**
|
|
@@ -3437,7 +3437,7 @@ export interface EventDeleted {
|
|
|
3437
3437
|
*/
|
|
3438
3438
|
userId?: string | null;
|
|
3439
3439
|
}
|
|
3440
|
-
|
|
3440
|
+
interface EventCopied {
|
|
3441
3441
|
/** Event created timestamp in ISO UTC format. */
|
|
3442
3442
|
timestamp?: Date | null;
|
|
3443
3443
|
/**
|
|
@@ -3475,7 +3475,7 @@ export interface EventCopied {
|
|
|
3475
3475
|
*/
|
|
3476
3476
|
ticketDefinitions?: Record<string, string>;
|
|
3477
3477
|
}
|
|
3478
|
-
|
|
3478
|
+
interface MessageEnvelope {
|
|
3479
3479
|
/**
|
|
3480
3480
|
* App instance ID.
|
|
3481
3481
|
* @format GUID
|
|
@@ -3491,7 +3491,7 @@ export interface MessageEnvelope {
|
|
|
3491
3491
|
/** Stringify payload. */
|
|
3492
3492
|
data?: string;
|
|
3493
3493
|
}
|
|
3494
|
-
|
|
3494
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3495
3495
|
/**
|
|
3496
3496
|
* ID of a site visitor that has not logged in to the site.
|
|
3497
3497
|
* @format GUID
|
|
@@ -3516,7 +3516,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3516
3516
|
identityType?: WebhookIdentityType;
|
|
3517
3517
|
}
|
|
3518
3518
|
/** @oneof */
|
|
3519
|
-
|
|
3519
|
+
interface IdentificationDataIdOneOf {
|
|
3520
3520
|
/**
|
|
3521
3521
|
* ID of a site visitor that has not logged in to the site.
|
|
3522
3522
|
* @format GUID
|
|
@@ -3538,34 +3538,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
3538
3538
|
*/
|
|
3539
3539
|
appId?: string;
|
|
3540
3540
|
}
|
|
3541
|
-
|
|
3541
|
+
declare enum WebhookIdentityType {
|
|
3542
3542
|
UNKNOWN = "UNKNOWN",
|
|
3543
3543
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3544
3544
|
MEMBER = "MEMBER",
|
|
3545
3545
|
WIX_USER = "WIX_USER",
|
|
3546
3546
|
APP = "APP"
|
|
3547
3547
|
}
|
|
3548
|
-
interface
|
|
3549
|
-
notificationType: EmailNotificationType;
|
|
3550
|
-
reminderTime: EmailNotificationReminderTime;
|
|
3551
|
-
}
|
|
3552
|
-
interface NotificationConfigNonNullableFields {
|
|
3553
|
-
rsvpConfirmation?: EmailNotificationConfigNonNullableFields;
|
|
3554
|
-
newSpotsAvailable?: EmailNotificationConfigNonNullableFields;
|
|
3555
|
-
eventCancelation?: EmailNotificationConfigNonNullableFields;
|
|
3556
|
-
upcomingEventReminder?: EmailNotificationConfigNonNullableFields;
|
|
3557
|
-
orderConfirmation?: EmailNotificationConfigNonNullableFields;
|
|
3558
|
-
ticketConfirmation?: EmailNotificationConfigNonNullableFields;
|
|
3559
|
-
invoice?: EmailNotificationConfigNonNullableFields;
|
|
3560
|
-
orderConfirmationWithTicketsLink?: EmailNotificationConfigNonNullableFields;
|
|
3561
|
-
}
|
|
3562
|
-
export interface ResolveNotificationConfigResponseNonNullableFields {
|
|
3563
|
-
notificationConfig?: NotificationConfigNonNullableFields;
|
|
3564
|
-
}
|
|
3565
|
-
export interface UpsertNotificationConfigResponseNonNullableFields {
|
|
3566
|
-
notificationConfig?: NotificationConfigNonNullableFields;
|
|
3567
|
-
}
|
|
3568
|
-
export interface BaseEventMetadata {
|
|
3548
|
+
interface BaseEventMetadata {
|
|
3569
3549
|
/**
|
|
3570
3550
|
* App instance ID.
|
|
3571
3551
|
* @format GUID
|
|
@@ -3579,7 +3559,7 @@ export interface BaseEventMetadata {
|
|
|
3579
3559
|
/** The identification type and identity data. */
|
|
3580
3560
|
identity?: IdentificationData;
|
|
3581
3561
|
}
|
|
3582
|
-
|
|
3562
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3583
3563
|
/**
|
|
3584
3564
|
* Unique event ID.
|
|
3585
3565
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -3617,68 +3597,15 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
3617
3597
|
*/
|
|
3618
3598
|
entityEventSequence?: string | null;
|
|
3619
3599
|
}
|
|
3620
|
-
|
|
3600
|
+
interface NotificationConfigCreatedEnvelope {
|
|
3621
3601
|
entity: NotificationConfig;
|
|
3622
3602
|
metadata: EventMetadata;
|
|
3623
3603
|
}
|
|
3624
|
-
|
|
3625
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3626
|
-
* @permissionScope Manage Events - all permissions
|
|
3627
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3628
|
-
* @permissionScope Manage Events
|
|
3629
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3630
|
-
* @permissionScope Read Events
|
|
3631
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3632
|
-
* @permissionScope Manage Guest List
|
|
3633
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3634
|
-
* @permissionScope Manage Events
|
|
3635
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3636
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3637
|
-
* @webhook
|
|
3638
|
-
* @eventType wix.events.notifications.v2.notification_config_created
|
|
3639
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3640
|
-
* @slug created
|
|
3641
|
-
* @documentationMaturity preview
|
|
3642
|
-
*/
|
|
3643
|
-
export declare function onNotificationConfigCreated(handler: (event: NotificationConfigCreatedEnvelope) => void | Promise<void>): void;
|
|
3644
|
-
export interface NotificationConfigUpdatedEnvelope {
|
|
3604
|
+
interface NotificationConfigUpdatedEnvelope {
|
|
3645
3605
|
entity: NotificationConfig;
|
|
3646
3606
|
metadata: EventMetadata;
|
|
3647
3607
|
}
|
|
3648
|
-
|
|
3649
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3650
|
-
* @permissionScope Manage Events - all permissions
|
|
3651
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3652
|
-
* @permissionScope Manage Events
|
|
3653
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3654
|
-
* @permissionScope Read Events
|
|
3655
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3656
|
-
* @permissionScope Manage Guest List
|
|
3657
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3658
|
-
* @permissionScope Manage Events
|
|
3659
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3660
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3661
|
-
* @webhook
|
|
3662
|
-
* @eventType wix.events.notifications.v2.notification_config_updated
|
|
3663
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3664
|
-
* @slug updated
|
|
3665
|
-
* @documentationMaturity preview
|
|
3666
|
-
*/
|
|
3667
|
-
export declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
|
|
3668
|
-
/**
|
|
3669
|
-
* Triggers notification
|
|
3670
|
-
* @public
|
|
3671
|
-
* @documentationMaturity preview
|
|
3672
|
-
* @requiredField guests
|
|
3673
|
-
* @requiredField notification
|
|
3674
|
-
* @permissionId WIX_EVENTS.MANAGE
|
|
3675
|
-
* @permissionScope Manage Events
|
|
3676
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3677
|
-
* @applicableIdentity APP
|
|
3678
|
-
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
3679
|
-
*/
|
|
3680
|
-
export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
|
|
3681
|
-
export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3608
|
+
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3682
3609
|
/** Email notification type */
|
|
3683
3610
|
emailNotificationType?: EmailNotificationType;
|
|
3684
3611
|
/** Push notification type */
|
|
@@ -3693,14 +3620,14 @@ export interface TriggerNotificationOptions extends TriggerNotificationOptionsNo
|
|
|
3693
3620
|
ticketGuest?: TicketGuest;
|
|
3694
3621
|
}
|
|
3695
3622
|
/** @oneof */
|
|
3696
|
-
|
|
3623
|
+
interface TriggerNotificationOptionsNotificationOneOf {
|
|
3697
3624
|
/** Email notification type */
|
|
3698
3625
|
emailNotificationType?: EmailNotificationType;
|
|
3699
3626
|
/** Push notification type */
|
|
3700
3627
|
pushNotificationType?: PushNotificationType;
|
|
3701
3628
|
}
|
|
3702
3629
|
/** @oneof */
|
|
3703
|
-
|
|
3630
|
+
interface TriggerNotificationOptionsGuestsOneOf {
|
|
3704
3631
|
/** Rsvp guest info */
|
|
3705
3632
|
rsvpGuest?: RsvpGuest;
|
|
3706
3633
|
/** Order guest info */
|
|
@@ -3710,48 +3637,7 @@ export interface TriggerNotificationOptionsGuestsOneOf {
|
|
|
3710
3637
|
/** Ticket guests info */
|
|
3711
3638
|
ticketGuest?: TicketGuest;
|
|
3712
3639
|
}
|
|
3713
|
-
|
|
3714
|
-
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
3715
|
-
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
3716
|
-
* @public
|
|
3717
|
-
* @documentationMaturity preview
|
|
3718
|
-
* @requiredField notificationConfigId
|
|
3719
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3720
|
-
* @permissionScope Read Events - all read permissions
|
|
3721
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3722
|
-
* @permissionScope Manage Events - all permissions
|
|
3723
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3724
|
-
* @permissionScope Manage Events
|
|
3725
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3726
|
-
* @permissionScope Read Events
|
|
3727
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3728
|
-
* @permissionScope Manage Guest List
|
|
3729
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3730
|
-
* @permissionScope Manage Events
|
|
3731
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3732
|
-
* @applicableIdentity APP
|
|
3733
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.ResolveNotificationConfig
|
|
3734
|
-
*/
|
|
3735
|
-
export declare function resolveNotificationConfig(notificationConfigId: string): Promise<ResolveNotificationConfigResponse & ResolveNotificationConfigResponseNonNullableFields>;
|
|
3736
|
-
/**
|
|
3737
|
-
* Upsert a NotificationConfig
|
|
3738
|
-
* @param _id - Event ID.
|
|
3739
|
-
* @public
|
|
3740
|
-
* @documentationMaturity preview
|
|
3741
|
-
* @requiredField _id
|
|
3742
|
-
* @requiredField notificationConfig
|
|
3743
|
-
* @permissionId WIX_EVENTS.UPDATE_NOTIFICATION_CONFIG
|
|
3744
|
-
* @permissionScope Manage Events - all permissions
|
|
3745
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3746
|
-
* @permissionScope Manage Events
|
|
3747
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3748
|
-
* @permissionScope Manage Events
|
|
3749
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3750
|
-
* @applicableIdentity APP
|
|
3751
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.UpsertNotificationConfig
|
|
3752
|
-
*/
|
|
3753
|
-
export declare function upsertNotificationConfig(_id: string | null, notificationConfig: UpsertNotificationConfig): Promise<UpsertNotificationConfigResponse & UpsertNotificationConfigResponseNonNullableFields>;
|
|
3754
|
-
export interface UpsertNotificationConfig {
|
|
3640
|
+
interface UpsertNotificationConfig {
|
|
3755
3641
|
/**
|
|
3756
3642
|
* Event ID.
|
|
3757
3643
|
* @format GUID
|
|
@@ -3790,4 +3676,5 @@ export interface UpsertNotificationConfig {
|
|
|
3790
3676
|
/** Order confirmation with tickets link. */
|
|
3791
3677
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
3792
3678
|
}
|
|
3793
|
-
|
|
3679
|
+
|
|
3680
|
+
export { FeeType as $, Alignment as A, ButtonDataType as B, ConferenceType as C, DecorationType as D, EmailNotificationType as E, FontType as F, GIFType as G, AppType as H, InputControlType as I, InitialExpandedItems as J, Direction as K, LocationType as L, MapType as M, NodeType as N, Orientation as O, PushNotificationType as P, VerticalAlignment as Q, type ResolveNotificationConfigResponse as R, SubdivisionType as S, type TriggerNotificationOptions as T, type UpsertNotificationConfig as U, VisitorType as V, WidthType as W, NullValue as X, Type as Y, OrderStatus as Z, FeeName as _, type UpsertNotificationConfigResponse as a, type GuestListConfig as a$, WebhookIdentityType as a0, type NotificationConfig as a1, type EmailNotificationConfig as a2, type EmailTemplate as a3, type Link as a4, type TriggerNotificationRequest as a5, type TriggerNotificationRequestNotificationOneOf as a6, type TriggerNotificationRequestGuestsOneOf as a7, type RsvpGuest as a8, type OrderGuest as a9, type RsvpCollectionConfig as aA, type Ticketing as aB, type TicketingConfig as aC, type TaxConfig as aD, type Money as aE, type ExternalEvent as aF, type CalendarLinks as aG, type SiteUrl as aH, type Form as aI, type InputControl as aJ, type Input as aK, type OptionSelection as aL, type OptionSelectionSelectedOptionOneOf as aM, type Label as aN, type FormMessages as aO, type RsvpFormMessages as aP, type PositiveResponseConfirmation as aQ, type NegativeResponseConfirmation as aR, type Positive as aS, type Negative as aT, type CheckoutFormMessages as aU, type ResponseConfirmation as aV, type RegistrationClosedMessages as aW, type TicketsUnavailableMessages as aX, type Dashboard as aY, type RsvpSummary as aZ, type TicketingSummary as a_, type EventGuests as aa, type TicketGuest as ab, type TriggerNotificationResponse as ac, type DomainEvent as ad, type DomainEventBodyOneOf as ae, type EntityCreatedEvent as af, type RestoreInfo as ag, type EntityUpdatedEvent as ah, type EntityDeletedEvent as ai, type ActionEvent as aj, type Empty as ak, type EventUpdated as al, type Location as am, type MapCoordinates as an, type Address as ao, type AddressStreetOneOf as ap, type StreetAddress as aq, type AddressLocation as ar, type Subdivision as as, type ScheduleConfig as at, type Recurrences as au, type Occurrence as av, type Event as aw, type Scheduling as ax, type Registration as ay, type RsvpCollection as az, EmailNotificationReminderTime as b, type PollSettings as b$, type Feed as b0, type OnlineConferencing as b1, type OnlineConferencingConfig as b2, type OnlineConferencingSession as b3, type SeoSettings as b4, type SeoSchema as b5, type Keyword as b6, type Tag as b7, type Settings as b8, type Agenda as b9, type PDFSettings as bA, type GalleryData as bB, type Media as bC, type Image as bD, type Video as bE, type GalleryDataItem as bF, type GalleryDataItemDataOneOf as bG, type GalleryOptions as bH, type Layout as bI, type ItemStyle as bJ, type Thumbnails as bK, type GIFData as bL, type GIF as bM, type HeadingData as bN, type HTMLData as bO, type HTMLDataDataOneOf as bP, type ImageData as bQ, type StylesBorder as bR, type ImageDataStyles as bS, type LinkPreviewData as bT, type LinkPreviewDataStyles as bU, type MapData as bV, type MapSettings as bW, type ParagraphData as bX, type PollData as bY, type Permissions as bZ, type Option as b_, type Category as ba, type CategoryCounts as bb, type EventDisplaySettings as bc, type LabellingSettings as bd, type RichContent as be, type Node as bf, type NodeDataOneOf as bg, type NodeStyle as bh, type ButtonData as bi, type Border as bj, type Colors as bk, type PluginContainerData as bl, type PluginContainerDataWidth as bm, type PluginContainerDataWidthDataOneOf as bn, type Spoiler as bo, type Height as bp, type Styles as bq, type V1Link as br, type V1LinkDataOneOf as bs, type Rel as bt, type CodeBlockData as bu, type TextStyle as bv, type DividerData as bw, type FileData as bx, type FileSource as by, type FileSourceDataOneOf as bz, Status as c, type PaidPlanDiscount as c$, type PollLayout as c0, type OptionLayout as c1, type Gradient as c2, type Background as c3, type BackgroundBackgroundOneOf as c4, type PollDesign as c5, type OptionDesign as c6, type Poll as c7, type PollDataLayout as c8, type Design as c9, type BulletedListData as cA, type BlockquoteData as cB, type CaptionData as cC, type LayoutCellData as cD, type Metadata as cE, type DocumentStyle as cF, type TextNodeStyle as cG, type Badge as cH, type OrderConfirmed as cI, type FormResponse as cJ, type InputValue as cK, type FormattedAddress as cL, type CommonAddress as cM, type CommonAddressStreetOneOf as cN, type CommonStreetAddress as cO, type CommonAddressLocation as cP, type CommonSubdivision as cQ, type StandardDetails as cR, type Ticket as cS, type CheckIn as cT, type OnlineConferencingLogin as cU, type Invoice as cV, type Item as cW, type Discount as cX, type DiscountItem as cY, type DiscountItemDiscountOneOf as cZ, type CouponDiscount as c_, type TextData as ca, type Decoration as cb, type DecorationDataOneOf as cc, type AnchorData as cd, type ColorData as ce, type LinkData as cf, type MentionData as cg, type FontSizeData as ch, type SpoilerData as ci, type AppEmbedData as cj, type AppEmbedDataAppDataOneOf as ck, type BookingData as cl, type EventData as cm, type VideoData as cn, type PlaybackOptions as co, type EmbedData as cp, type Oembed as cq, type CollapsibleListData as cr, type TableData as cs, type Dimensions as ct, type TableCellData as cu, type CellStyle as cv, type BorderColors as cw, type ListValue as cx, type AudioData as cy, type OrderedListData as cz, EventStatus as d, type PaidPlanDiscountDiscountOneOf as d0, type PercentDiscount as d1, type Tax as d2, type Fee as d3, type OrderEmailAdded as d4, type EventCanceled as d5, type EventReminder as d6, type TimeDuration as d7, type OrderPaid as d8, type TicketPdfResolved as d9, type TicketPdfResolveDelayed as da, type OrderCanceled as db, type EventEnded as dc, type EventStarted as dd, type ResolveNotificationConfigRequest as de, type UpsertNotificationConfigRequest as df, type ResolveEmailNotificationConfigRequest as dg, type ResolveEmailNotificationConfigResponse as dh, type EventDeleted as di, type EventCopied as dj, type MessageEnvelope as dk, type IdentificationData as dl, type IdentificationDataIdOneOf as dm, type BaseEventMetadata as dn, type EventMetadata as dp, type NotificationConfigCreatedEnvelope as dq, type NotificationConfigUpdatedEnvelope as dr, type TriggerNotificationOptionsNotificationOneOf as ds, type TriggerNotificationOptionsGuestsOneOf as dt, EventType as e, RegistrationStatus as f, RsvpStatusOptions as g, TaxType as h, ValueType as i, State as j, PluginContainerDataAlignment as k, Target as l, TextAlignment as m, LineStyle as n, Width as o, ViewMode as p, LayoutType as q, Crop as r, ThumbnailsAlignment as s, Source as t, Position as u, ViewRole as v, VoteRole as w, PollLayoutType as x, PollLayoutDirection as y, BackgroundType as z };
|