@wix/auto_sdk_events_notifications 1.0.21 → 1.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.mts} +326 -430
- package/build/{cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.ts} +326 -430
- package/build/index.d.mts +39 -0
- package/build/index.d.ts +39 -0
- package/build/index.js +858 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +779 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/events-notifications-v2-notification-config-notifications.universal.d.ts → events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.mts} +326 -430
- package/build/{es/src/events-notifications-v2-notification-config-notifications.universal.d.ts → internal/events-notifications-v2-notification-config-notifications.universal-D-36kOt1.d.ts} +326 -430
- package/build/internal/index.d.mts +39 -0
- package/build/internal/index.d.ts +39 -0
- package/build/internal/index.js +858 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +779 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +267 -0
- package/build/internal/meta.d.ts +267 -0
- package/build/internal/meta.js +258 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +229 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +267 -0
- package/build/meta.d.ts +267 -0
- package/build/meta.js +258 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +229 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.js +0 -69
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.js +0 -168
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.js +0 -87
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js +0 -101
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3737
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js +0 -571
- 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 -732
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +0 -14
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.js +0 -14
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.d.ts +0 -7
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.js +0 -162
- package/build/es/src/events-notifications-v2-notification-config-notifications.http.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.d.ts +0 -19
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.js +0 -58
- package/build/es/src/events-notifications-v2-notification-config-notifications.meta.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +0 -31
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js +0 -43
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js.map +0 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +0 -3737
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js +0 -567
- 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 -702
- 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 -3737
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js +0 -571
- 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 -732
- 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 -3737
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js +0 -567
- 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 -702
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface NotificationConfig {
|
|
1
|
+
interface NotificationConfig {
|
|
3
2
|
/**
|
|
4
3
|
* Event ID.
|
|
5
4
|
* @format GUID
|
|
@@ -38,7 +37,7 @@ export interface NotificationConfig {
|
|
|
38
37
|
/** Order confirmation with tickets link. */
|
|
39
38
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
40
39
|
}
|
|
41
|
-
|
|
40
|
+
interface EmailNotificationConfig {
|
|
42
41
|
/**
|
|
43
42
|
* Predefined id of the notification type.
|
|
44
43
|
* @readonly
|
|
@@ -54,7 +53,7 @@ export interface EmailNotificationConfig {
|
|
|
54
53
|
/** When true the notification will be sent when certain trigger occurs. */
|
|
55
54
|
sendingEnabled?: boolean | null;
|
|
56
55
|
}
|
|
57
|
-
|
|
56
|
+
declare enum EmailNotificationType {
|
|
58
57
|
/** Default value. This value is unused. */
|
|
59
58
|
UNKNOWN_NOTIFICATION_TYPE = "UNKNOWN_NOTIFICATION_TYPE",
|
|
60
59
|
/** Triggered when site user RSVP to the event. */
|
|
@@ -73,8 +72,8 @@ export declare enum EmailNotificationType {
|
|
|
73
72
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
74
73
|
}
|
|
75
74
|
/** @enumType */
|
|
76
|
-
|
|
77
|
-
|
|
75
|
+
type EmailNotificationTypeWithLiterals = EmailNotificationType | 'UNKNOWN_NOTIFICATION_TYPE' | 'EMAIL_RSVP_CONFIRMATION' | 'EMAIL_NEW_SPOTS_AVAILABLE' | 'EMAIL_EVENT_CANCELATION' | 'EMAIL_UPCOMING_EVENT_REMINDER' | 'EMAIL_ORDER_CONFIRMATION' | 'EMAIL_TICKET_CONFIRMATION' | 'EMAIL_INVOICE';
|
|
76
|
+
interface EmailTemplate {
|
|
78
77
|
/**
|
|
79
78
|
* Email subject.
|
|
80
79
|
* @minLength 1
|
|
@@ -96,7 +95,7 @@ export interface EmailTemplate {
|
|
|
96
95
|
/** When true the tickets are attached to the order confirmation email. */
|
|
97
96
|
includeTickets?: boolean | null;
|
|
98
97
|
}
|
|
99
|
-
|
|
98
|
+
interface Link {
|
|
100
99
|
/** When true the link is added to the email. */
|
|
101
100
|
display?: boolean | null;
|
|
102
101
|
/**
|
|
@@ -105,7 +104,7 @@ export interface Link {
|
|
|
105
104
|
*/
|
|
106
105
|
linkText?: string | null;
|
|
107
106
|
}
|
|
108
|
-
|
|
107
|
+
declare enum EmailNotificationReminderTime {
|
|
109
108
|
/** Default value. This value is unused. */
|
|
110
109
|
UNKNOWN_REMINDER_TIME = "UNKNOWN_REMINDER_TIME",
|
|
111
110
|
/** Notification is sent instantly */
|
|
@@ -122,8 +121,8 @@ export declare enum EmailNotificationReminderTime {
|
|
|
122
121
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
123
122
|
}
|
|
124
123
|
/** @enumType */
|
|
125
|
-
|
|
126
|
-
|
|
124
|
+
type EmailNotificationReminderTimeWithLiterals = EmailNotificationReminderTime | 'UNKNOWN_REMINDER_TIME' | 'INSTANT' | 'BEFORE_1_DAY' | 'BEFORE_3_DAYS' | 'BEFORE_1_WEEK' | 'BEFORE_1_HOUR' | 'BEFORE_30_MINUTES';
|
|
125
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
127
126
|
/** Email notification type */
|
|
128
127
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
129
128
|
/** Push notification type */
|
|
@@ -138,14 +137,14 @@ export interface TriggerNotificationRequest extends TriggerNotificationRequestNo
|
|
|
138
137
|
ticketGuest?: TicketGuest;
|
|
139
138
|
}
|
|
140
139
|
/** @oneof */
|
|
141
|
-
|
|
140
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
142
141
|
/** Email notification type */
|
|
143
142
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
144
143
|
/** Push notification type */
|
|
145
144
|
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
146
145
|
}
|
|
147
146
|
/** @oneof */
|
|
148
|
-
|
|
147
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
149
148
|
/** Rsvp guest info */
|
|
150
149
|
rsvpGuest?: RsvpGuest;
|
|
151
150
|
/** Order guest info */
|
|
@@ -155,7 +154,7 @@ export interface TriggerNotificationRequestGuestsOneOf {
|
|
|
155
154
|
/** Ticket guests info */
|
|
156
155
|
ticketGuest?: TicketGuest;
|
|
157
156
|
}
|
|
158
|
-
|
|
157
|
+
declare enum PushNotificationType {
|
|
159
158
|
/** This is default value. This value is unused. */
|
|
160
159
|
UNKNOWN_PUSH_TYPE = "UNKNOWN_PUSH_TYPE",
|
|
161
160
|
/** Triggered when event is updated. */
|
|
@@ -168,9 +167,9 @@ export declare enum PushNotificationType {
|
|
|
168
167
|
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
169
168
|
}
|
|
170
169
|
/** @enumType */
|
|
171
|
-
|
|
170
|
+
type PushNotificationTypeWithLiterals = PushNotificationType | 'UNKNOWN_PUSH_TYPE' | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
172
171
|
/** Single guest associated to the RSVP */
|
|
173
|
-
|
|
172
|
+
interface RsvpGuest {
|
|
174
173
|
/**
|
|
175
174
|
* Event id
|
|
176
175
|
* @format GUID
|
|
@@ -183,7 +182,7 @@ export interface RsvpGuest {
|
|
|
183
182
|
rsvpId?: string;
|
|
184
183
|
}
|
|
185
184
|
/** Single guest associated to the Order */
|
|
186
|
-
|
|
185
|
+
interface OrderGuest {
|
|
187
186
|
/**
|
|
188
187
|
* Event id
|
|
189
188
|
* @format GUID
|
|
@@ -196,7 +195,7 @@ export interface OrderGuest {
|
|
|
196
195
|
orderNumber?: string;
|
|
197
196
|
}
|
|
198
197
|
/** All event guest from RSVPs and Orders */
|
|
199
|
-
|
|
198
|
+
interface EventGuests {
|
|
200
199
|
/**
|
|
201
200
|
* Event id
|
|
202
201
|
* @format GUID
|
|
@@ -204,7 +203,7 @@ export interface EventGuests {
|
|
|
204
203
|
eventId?: string;
|
|
205
204
|
}
|
|
206
205
|
/** Multiple guests associated to Tickets */
|
|
207
|
-
|
|
206
|
+
interface TicketGuest {
|
|
208
207
|
/**
|
|
209
208
|
* Event id
|
|
210
209
|
* @format GUID
|
|
@@ -223,9 +222,9 @@ export interface TicketGuest {
|
|
|
223
222
|
*/
|
|
224
223
|
ticketNumber?: string[];
|
|
225
224
|
}
|
|
226
|
-
|
|
225
|
+
interface TriggerNotificationResponse {
|
|
227
226
|
}
|
|
228
|
-
|
|
227
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
229
228
|
createdEvent?: EntityCreatedEvent;
|
|
230
229
|
updatedEvent?: EntityUpdatedEvent;
|
|
231
230
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -260,19 +259,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
260
259
|
entityEventSequence?: string | null;
|
|
261
260
|
}
|
|
262
261
|
/** @oneof */
|
|
263
|
-
|
|
262
|
+
interface DomainEventBodyOneOf {
|
|
264
263
|
createdEvent?: EntityCreatedEvent;
|
|
265
264
|
updatedEvent?: EntityUpdatedEvent;
|
|
266
265
|
deletedEvent?: EntityDeletedEvent;
|
|
267
266
|
actionEvent?: ActionEvent;
|
|
268
267
|
}
|
|
269
|
-
|
|
268
|
+
interface EntityCreatedEvent {
|
|
270
269
|
entity?: string;
|
|
271
270
|
}
|
|
272
|
-
|
|
271
|
+
interface RestoreInfo {
|
|
273
272
|
deletedDate?: Date | null;
|
|
274
273
|
}
|
|
275
|
-
|
|
274
|
+
interface EntityUpdatedEvent {
|
|
276
275
|
/**
|
|
277
276
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
278
277
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -280,16 +279,16 @@ export interface EntityUpdatedEvent {
|
|
|
280
279
|
*/
|
|
281
280
|
currentEntity?: string;
|
|
282
281
|
}
|
|
283
|
-
|
|
282
|
+
interface EntityDeletedEvent {
|
|
284
283
|
/** Entity that was deleted. */
|
|
285
284
|
deletedEntity?: string | null;
|
|
286
285
|
}
|
|
287
|
-
|
|
286
|
+
interface ActionEvent {
|
|
288
287
|
body?: string;
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface Empty {
|
|
291
290
|
}
|
|
292
|
-
|
|
291
|
+
interface EventUpdated {
|
|
293
292
|
/** Event update timestamp in ISO UTC format. */
|
|
294
293
|
timestamp?: Date | null;
|
|
295
294
|
/**
|
|
@@ -311,7 +310,7 @@ export interface EventUpdated {
|
|
|
311
310
|
/** Updated event */
|
|
312
311
|
event?: Event;
|
|
313
312
|
}
|
|
314
|
-
|
|
313
|
+
interface Location {
|
|
315
314
|
/**
|
|
316
315
|
* Location name.
|
|
317
316
|
* @maxLength 50
|
|
@@ -343,7 +342,7 @@ export interface Location {
|
|
|
343
342
|
*/
|
|
344
343
|
tbd?: boolean | null;
|
|
345
344
|
}
|
|
346
|
-
|
|
345
|
+
interface MapCoordinates {
|
|
347
346
|
/**
|
|
348
347
|
* Latitude.
|
|
349
348
|
* @min -90
|
|
@@ -357,14 +356,14 @@ export interface MapCoordinates {
|
|
|
357
356
|
*/
|
|
358
357
|
lng?: number;
|
|
359
358
|
}
|
|
360
|
-
|
|
359
|
+
declare enum LocationType {
|
|
361
360
|
VENUE = "VENUE",
|
|
362
361
|
ONLINE = "ONLINE"
|
|
363
362
|
}
|
|
364
363
|
/** @enumType */
|
|
365
|
-
|
|
364
|
+
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
366
365
|
/** Physical address */
|
|
367
|
-
|
|
366
|
+
interface Address extends AddressStreetOneOf {
|
|
368
367
|
/** a break down of the street to number and street name */
|
|
369
368
|
streetAddress?: StreetAddress;
|
|
370
369
|
/** Main address line (usually street and number) as free text */
|
|
@@ -395,19 +394,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
395
394
|
subdivisions?: Subdivision[];
|
|
396
395
|
}
|
|
397
396
|
/** @oneof */
|
|
398
|
-
|
|
397
|
+
interface AddressStreetOneOf {
|
|
399
398
|
/** a break down of the street to number and street name */
|
|
400
399
|
streetAddress?: StreetAddress;
|
|
401
400
|
/** Main address line (usually street and number) as free text */
|
|
402
401
|
addressLine?: string | null;
|
|
403
402
|
}
|
|
404
|
-
|
|
403
|
+
interface StreetAddress {
|
|
405
404
|
/** street number */
|
|
406
405
|
number?: string;
|
|
407
406
|
/** street name */
|
|
408
407
|
name?: string;
|
|
409
408
|
}
|
|
410
|
-
|
|
409
|
+
interface AddressLocation {
|
|
411
410
|
/**
|
|
412
411
|
* address latitude coordinates
|
|
413
412
|
* @min -90
|
|
@@ -421,13 +420,13 @@ export interface AddressLocation {
|
|
|
421
420
|
*/
|
|
422
421
|
longitude?: number | null;
|
|
423
422
|
}
|
|
424
|
-
|
|
423
|
+
interface Subdivision {
|
|
425
424
|
/** subdivision short code */
|
|
426
425
|
code?: string;
|
|
427
426
|
/** subdivision full-name */
|
|
428
427
|
name?: string;
|
|
429
428
|
}
|
|
430
|
-
|
|
429
|
+
declare enum SubdivisionType {
|
|
431
430
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
432
431
|
/** State */
|
|
433
432
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -442,9 +441,7 @@ export declare enum SubdivisionType {
|
|
|
442
441
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
443
442
|
COUNTRY = "COUNTRY"
|
|
444
443
|
}
|
|
445
|
-
|
|
446
|
-
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
447
|
-
export interface ScheduleConfig {
|
|
444
|
+
interface ScheduleConfig {
|
|
448
445
|
/**
|
|
449
446
|
* Defines event as TBD (To Be Determined) schedule.
|
|
450
447
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -472,7 +469,7 @@ export interface ScheduleConfig {
|
|
|
472
469
|
/** Event recurrences. */
|
|
473
470
|
recurrences?: Recurrences;
|
|
474
471
|
}
|
|
475
|
-
|
|
472
|
+
interface Recurrences {
|
|
476
473
|
/**
|
|
477
474
|
* Event occurrences.
|
|
478
475
|
* @maxSize 1000
|
|
@@ -489,7 +486,7 @@ export interface Recurrences {
|
|
|
489
486
|
*/
|
|
490
487
|
status?: StatusWithLiterals;
|
|
491
488
|
}
|
|
492
|
-
|
|
489
|
+
interface Occurrence {
|
|
493
490
|
/** Event start timestamp. */
|
|
494
491
|
startDate?: Date | null;
|
|
495
492
|
/** Event end timestamp. */
|
|
@@ -502,7 +499,7 @@ export interface Occurrence {
|
|
|
502
499
|
/** Whether time zone is displayed in formatted schedule. */
|
|
503
500
|
showTimeZone?: boolean;
|
|
504
501
|
}
|
|
505
|
-
|
|
502
|
+
declare enum Status {
|
|
506
503
|
/** Event occurs only once. */
|
|
507
504
|
ONE_TIME = "ONE_TIME",
|
|
508
505
|
/** Event is recurring. */
|
|
@@ -515,8 +512,8 @@ export declare enum Status {
|
|
|
515
512
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
516
513
|
}
|
|
517
514
|
/** @enumType */
|
|
518
|
-
|
|
519
|
-
|
|
515
|
+
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
516
|
+
interface Event {
|
|
520
517
|
/**
|
|
521
518
|
* Event ID.
|
|
522
519
|
* @format GUID
|
|
@@ -586,7 +583,7 @@ export interface Event {
|
|
|
586
583
|
*/
|
|
587
584
|
publishedDate?: Date | null;
|
|
588
585
|
}
|
|
589
|
-
|
|
586
|
+
interface Scheduling {
|
|
590
587
|
/** Schedule configuration. */
|
|
591
588
|
config?: ScheduleConfig;
|
|
592
589
|
/** Formatted schedule representation. */
|
|
@@ -600,7 +597,7 @@ export interface Scheduling {
|
|
|
600
597
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
601
598
|
endTimeFormatted?: string;
|
|
602
599
|
}
|
|
603
|
-
|
|
600
|
+
declare enum EventStatus {
|
|
604
601
|
/** Event is public and scheduled to start */
|
|
605
602
|
SCHEDULED = "SCHEDULED",
|
|
606
603
|
/** Event has started */
|
|
@@ -611,8 +608,8 @@ export declare enum EventStatus {
|
|
|
611
608
|
CANCELED = "CANCELED"
|
|
612
609
|
}
|
|
613
610
|
/** @enumType */
|
|
614
|
-
|
|
615
|
-
|
|
611
|
+
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
612
|
+
interface Registration {
|
|
616
613
|
/** Event type. */
|
|
617
614
|
type?: EventTypeWithLiterals;
|
|
618
615
|
/** Event registration status. */
|
|
@@ -628,7 +625,7 @@ export interface Registration {
|
|
|
628
625
|
/** Initial event type which was set when creating an event. */
|
|
629
626
|
initialType?: EventTypeWithLiterals;
|
|
630
627
|
}
|
|
631
|
-
|
|
628
|
+
declare enum EventType {
|
|
632
629
|
/** Type not available for this request fieldset */
|
|
633
630
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
634
631
|
/** Registration via RSVP */
|
|
@@ -641,8 +638,8 @@ export declare enum EventType {
|
|
|
641
638
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
642
639
|
}
|
|
643
640
|
/** @enumType */
|
|
644
|
-
|
|
645
|
-
|
|
641
|
+
type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
642
|
+
declare enum RegistrationStatus {
|
|
646
643
|
/** Registration status is not applicable */
|
|
647
644
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
648
645
|
/** Registration to event is closed */
|
|
@@ -661,12 +658,12 @@ export declare enum RegistrationStatus {
|
|
|
661
658
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
662
659
|
}
|
|
663
660
|
/** @enumType */
|
|
664
|
-
|
|
665
|
-
|
|
661
|
+
type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
662
|
+
interface RsvpCollection {
|
|
666
663
|
/** RSVP collection configuration. */
|
|
667
664
|
config?: RsvpCollectionConfig;
|
|
668
665
|
}
|
|
669
|
-
|
|
666
|
+
interface RsvpCollectionConfig {
|
|
670
667
|
/** Defines the supported RSVP statuses. */
|
|
671
668
|
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
672
669
|
/**
|
|
@@ -681,15 +678,15 @@ export interface RsvpCollectionConfig {
|
|
|
681
678
|
/** Registration end timestamp. */
|
|
682
679
|
endDate?: Date | null;
|
|
683
680
|
}
|
|
684
|
-
|
|
681
|
+
declare enum RsvpStatusOptions {
|
|
685
682
|
/** Only YES RSVP status is available for RSVP registration */
|
|
686
683
|
YES_ONLY = "YES_ONLY",
|
|
687
684
|
/** YES and NO RSVP status options are available for the registration */
|
|
688
685
|
YES_AND_NO = "YES_AND_NO"
|
|
689
686
|
}
|
|
690
687
|
/** @enumType */
|
|
691
|
-
|
|
692
|
-
|
|
688
|
+
type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
689
|
+
interface Ticketing {
|
|
693
690
|
/**
|
|
694
691
|
* Deprecated.
|
|
695
692
|
* @deprecated
|
|
@@ -730,7 +727,7 @@ export interface Ticketing {
|
|
|
730
727
|
*/
|
|
731
728
|
soldOut?: boolean | null;
|
|
732
729
|
}
|
|
733
|
-
|
|
730
|
+
interface TicketingConfig {
|
|
734
731
|
/** Whether the form must be filled out separately for each ticket. */
|
|
735
732
|
guestAssignedTickets?: boolean;
|
|
736
733
|
/** Tax configuration. */
|
|
@@ -747,7 +744,7 @@ export interface TicketingConfig {
|
|
|
747
744
|
*/
|
|
748
745
|
reservationDurationInMinutes?: number | null;
|
|
749
746
|
}
|
|
750
|
-
|
|
747
|
+
interface TaxConfig {
|
|
751
748
|
/** Tax application settings. */
|
|
752
749
|
type?: TaxTypeWithLiterals;
|
|
753
750
|
/**
|
|
@@ -764,7 +761,7 @@ export interface TaxConfig {
|
|
|
764
761
|
/** Applies taxes for donations, default true. */
|
|
765
762
|
appliesToDonations?: boolean | null;
|
|
766
763
|
}
|
|
767
|
-
|
|
764
|
+
declare enum TaxType {
|
|
768
765
|
/** Tax is included in the ticket price. */
|
|
769
766
|
INCLUDED = "INCLUDED",
|
|
770
767
|
/** Tax is added to the order at the checkout. */
|
|
@@ -773,8 +770,8 @@ export declare enum TaxType {
|
|
|
773
770
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
774
771
|
}
|
|
775
772
|
/** @enumType */
|
|
776
|
-
|
|
777
|
-
|
|
773
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
774
|
+
interface Money {
|
|
778
775
|
/**
|
|
779
776
|
* *Deprecated:** Use `value` instead.
|
|
780
777
|
* @format DECIMAL_VALUE
|
|
@@ -792,11 +789,11 @@ export interface Money {
|
|
|
792
789
|
*/
|
|
793
790
|
value?: string | null;
|
|
794
791
|
}
|
|
795
|
-
|
|
792
|
+
interface ExternalEvent {
|
|
796
793
|
/** External event registration URL. */
|
|
797
794
|
registration?: string;
|
|
798
795
|
}
|
|
799
|
-
|
|
796
|
+
declare enum VisitorType {
|
|
800
797
|
/** Site visitor (including member) */
|
|
801
798
|
VISITOR = "VISITOR",
|
|
802
799
|
/** Site member */
|
|
@@ -805,15 +802,15 @@ export declare enum VisitorType {
|
|
|
805
802
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
806
803
|
}
|
|
807
804
|
/** @enumType */
|
|
808
|
-
|
|
809
|
-
|
|
805
|
+
type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
806
|
+
interface CalendarLinks {
|
|
810
807
|
/** "Add to Google calendar" URL. */
|
|
811
808
|
google?: string;
|
|
812
809
|
/** "Download ICS calendar file" URL. */
|
|
813
810
|
ics?: string;
|
|
814
811
|
}
|
|
815
812
|
/** Site URL components */
|
|
816
|
-
|
|
813
|
+
interface SiteUrl {
|
|
817
814
|
/**
|
|
818
815
|
* Base URL. For premium sites, this will be the domain.
|
|
819
816
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -835,7 +832,7 @@ export interface SiteUrl {
|
|
|
835
832
|
*
|
|
836
833
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
837
834
|
*/
|
|
838
|
-
|
|
835
|
+
interface Form {
|
|
839
836
|
/** Nested fields as an ordered list. */
|
|
840
837
|
controls?: InputControl[];
|
|
841
838
|
/**
|
|
@@ -848,7 +845,7 @@ export interface Form {
|
|
|
848
845
|
* A block of nested fields.
|
|
849
846
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
850
847
|
*/
|
|
851
|
-
|
|
848
|
+
interface InputControl {
|
|
852
849
|
/** Field control type. */
|
|
853
850
|
type?: InputControlTypeWithLiterals;
|
|
854
851
|
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
@@ -875,7 +872,7 @@ export interface InputControl {
|
|
|
875
872
|
*/
|
|
876
873
|
deleted?: boolean | null;
|
|
877
874
|
}
|
|
878
|
-
|
|
875
|
+
declare enum InputControlType {
|
|
879
876
|
/** Single text value field. */
|
|
880
877
|
INPUT = "INPUT",
|
|
881
878
|
/** Single text value field with multiple lines. */
|
|
@@ -898,9 +895,9 @@ export declare enum InputControlType {
|
|
|
898
895
|
DATE = "DATE"
|
|
899
896
|
}
|
|
900
897
|
/** @enumType */
|
|
901
|
-
|
|
898
|
+
type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
902
899
|
/** Child inputs. */
|
|
903
|
-
|
|
900
|
+
interface Input {
|
|
904
901
|
/** Field name. */
|
|
905
902
|
name?: string;
|
|
906
903
|
/**
|
|
@@ -942,7 +939,7 @@ export interface Input {
|
|
|
942
939
|
*/
|
|
943
940
|
labels?: Label[];
|
|
944
941
|
}
|
|
945
|
-
|
|
942
|
+
declare enum ValueType {
|
|
946
943
|
TEXT = "TEXT",
|
|
947
944
|
NUMBER = "NUMBER",
|
|
948
945
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -950,12 +947,12 @@ export declare enum ValueType {
|
|
|
950
947
|
ADDRESS = "ADDRESS"
|
|
951
948
|
}
|
|
952
949
|
/** @enumType */
|
|
953
|
-
|
|
950
|
+
type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
954
951
|
/**
|
|
955
952
|
* Describes initially selected option when an input has multiple choices.
|
|
956
953
|
* Defaults to first (0th) option if not configured.
|
|
957
954
|
*/
|
|
958
|
-
|
|
955
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
959
956
|
/**
|
|
960
957
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
961
958
|
* @max 199
|
|
@@ -969,7 +966,7 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
969
966
|
placeholderText?: string;
|
|
970
967
|
}
|
|
971
968
|
/** @oneof */
|
|
972
|
-
|
|
969
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
973
970
|
/**
|
|
974
971
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
975
972
|
* @max 199
|
|
@@ -982,7 +979,7 @@ export interface OptionSelectionSelectedOptionOneOf {
|
|
|
982
979
|
*/
|
|
983
980
|
placeholderText?: string;
|
|
984
981
|
}
|
|
985
|
-
|
|
982
|
+
interface Label {
|
|
986
983
|
/** Field name. */
|
|
987
984
|
name?: string;
|
|
988
985
|
/** Field label. */
|
|
@@ -992,7 +989,7 @@ export interface Label {
|
|
|
992
989
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
993
990
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
994
991
|
*/
|
|
995
|
-
|
|
992
|
+
interface FormMessages {
|
|
996
993
|
/** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
|
|
997
994
|
rsvp?: RsvpFormMessages;
|
|
998
995
|
/** Checkout form messages. */
|
|
@@ -1002,7 +999,7 @@ export interface FormMessages {
|
|
|
1002
999
|
/** Messages shown when event tickets are unavailable. */
|
|
1003
1000
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1004
1001
|
}
|
|
1005
|
-
|
|
1002
|
+
interface RsvpFormMessages {
|
|
1006
1003
|
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
1007
1004
|
rsvpYesOption?: string;
|
|
1008
1005
|
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
@@ -1017,7 +1014,7 @@ export interface RsvpFormMessages {
|
|
|
1017
1014
|
submitActionLabel?: string;
|
|
1018
1015
|
}
|
|
1019
1016
|
/** Confirmation messages shown after registration. */
|
|
1020
|
-
|
|
1017
|
+
interface PositiveResponseConfirmation {
|
|
1021
1018
|
/** Confirmation message title. */
|
|
1022
1019
|
title?: string;
|
|
1023
1020
|
/** Confirmation message text. */
|
|
@@ -1028,27 +1025,27 @@ export interface PositiveResponseConfirmation {
|
|
|
1028
1025
|
shareActionLabel?: string;
|
|
1029
1026
|
}
|
|
1030
1027
|
/** Confirmation messages shown after registration. */
|
|
1031
|
-
|
|
1028
|
+
interface NegativeResponseConfirmation {
|
|
1032
1029
|
/** Confirmation message title. */
|
|
1033
1030
|
title?: string;
|
|
1034
1031
|
/** "Share event" call-to-action label text. */
|
|
1035
1032
|
shareActionLabel?: string;
|
|
1036
1033
|
}
|
|
1037
1034
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
1038
|
-
|
|
1035
|
+
interface Positive {
|
|
1039
1036
|
/** Main form title for positive response. */
|
|
1040
1037
|
title?: string;
|
|
1041
1038
|
/** Confirmation messages shown after registration. */
|
|
1042
1039
|
confirmation?: PositiveResponseConfirmation;
|
|
1043
1040
|
}
|
|
1044
1041
|
/** A set of messages shown during registration with negative response */
|
|
1045
|
-
|
|
1042
|
+
interface Negative {
|
|
1046
1043
|
/** Main form title for negative response. */
|
|
1047
1044
|
title?: string;
|
|
1048
1045
|
/** Confirmation messages shown after registration. */
|
|
1049
1046
|
confirmation?: NegativeResponseConfirmation;
|
|
1050
1047
|
}
|
|
1051
|
-
|
|
1048
|
+
interface CheckoutFormMessages {
|
|
1052
1049
|
/** Main form title for response. */
|
|
1053
1050
|
title?: string;
|
|
1054
1051
|
/** Submit form call-to-action label text. */
|
|
@@ -1057,7 +1054,7 @@ export interface CheckoutFormMessages {
|
|
|
1057
1054
|
confirmation?: ResponseConfirmation;
|
|
1058
1055
|
}
|
|
1059
1056
|
/** Confirmation messages shown after checkout. */
|
|
1060
|
-
|
|
1057
|
+
interface ResponseConfirmation {
|
|
1061
1058
|
/** Confirmation message title. */
|
|
1062
1059
|
title?: string;
|
|
1063
1060
|
/** Confirmation message text. */
|
|
@@ -1069,19 +1066,19 @@ export interface ResponseConfirmation {
|
|
|
1069
1066
|
/** "Share event" call-to-action label text. */
|
|
1070
1067
|
shareEventLabel?: string;
|
|
1071
1068
|
}
|
|
1072
|
-
|
|
1069
|
+
interface RegistrationClosedMessages {
|
|
1073
1070
|
/** Message shown when event registration is closed. */
|
|
1074
1071
|
message?: string;
|
|
1075
1072
|
/** "Explore other events" call-to-action label text. */
|
|
1076
1073
|
exploreEventsActionLabel?: string;
|
|
1077
1074
|
}
|
|
1078
|
-
|
|
1075
|
+
interface TicketsUnavailableMessages {
|
|
1079
1076
|
/** Message shown when event tickets are unavailable. */
|
|
1080
1077
|
message?: string;
|
|
1081
1078
|
/** "Explore other events" call-to-action label text. */
|
|
1082
1079
|
exploreEventsActionLabel?: string;
|
|
1083
1080
|
}
|
|
1084
|
-
|
|
1081
|
+
interface Dashboard {
|
|
1085
1082
|
/** Guest RSVP summary. */
|
|
1086
1083
|
rsvpSummary?: RsvpSummary;
|
|
1087
1084
|
/**
|
|
@@ -1090,7 +1087,7 @@ export interface Dashboard {
|
|
|
1090
1087
|
*/
|
|
1091
1088
|
ticketingSummary?: TicketingSummary;
|
|
1092
1089
|
}
|
|
1093
|
-
|
|
1090
|
+
interface RsvpSummary {
|
|
1094
1091
|
/** Total number of RSVPs. */
|
|
1095
1092
|
total?: number;
|
|
1096
1093
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -1100,7 +1097,7 @@ export interface RsvpSummary {
|
|
|
1100
1097
|
/** Number of RSVPs in waitlist. */
|
|
1101
1098
|
waitlist?: number;
|
|
1102
1099
|
}
|
|
1103
|
-
|
|
1100
|
+
interface TicketingSummary {
|
|
1104
1101
|
/** Number of tickets sold. */
|
|
1105
1102
|
tickets?: number;
|
|
1106
1103
|
/**
|
|
@@ -1115,19 +1112,19 @@ export interface TicketingSummary {
|
|
|
1115
1112
|
/** Total balance of confirmed transactions. */
|
|
1116
1113
|
totalSales?: Money;
|
|
1117
1114
|
}
|
|
1118
|
-
|
|
1115
|
+
interface GuestListConfig {
|
|
1119
1116
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
1120
1117
|
publicGuestList?: boolean;
|
|
1121
1118
|
}
|
|
1122
|
-
|
|
1119
|
+
interface Feed {
|
|
1123
1120
|
/** Event discussion feed token. */
|
|
1124
1121
|
token?: string;
|
|
1125
1122
|
}
|
|
1126
|
-
|
|
1123
|
+
interface OnlineConferencing {
|
|
1127
1124
|
config?: OnlineConferencingConfig;
|
|
1128
1125
|
session?: OnlineConferencingSession;
|
|
1129
1126
|
}
|
|
1130
|
-
|
|
1127
|
+
interface OnlineConferencingConfig {
|
|
1131
1128
|
/**
|
|
1132
1129
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1133
1130
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -1141,15 +1138,15 @@ export interface OnlineConferencingConfig {
|
|
|
1141
1138
|
/** Conference type */
|
|
1142
1139
|
conferenceType?: ConferenceTypeWithLiterals;
|
|
1143
1140
|
}
|
|
1144
|
-
|
|
1141
|
+
declare enum ConferenceType {
|
|
1145
1142
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1146
1143
|
MEETING = "MEETING",
|
|
1147
1144
|
/** Guests can only subscribe to video and audio. */
|
|
1148
1145
|
WEBINAR = "WEBINAR"
|
|
1149
1146
|
}
|
|
1150
1147
|
/** @enumType */
|
|
1151
|
-
|
|
1152
|
-
|
|
1148
|
+
type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1149
|
+
interface OnlineConferencingSession {
|
|
1153
1150
|
/**
|
|
1154
1151
|
* Link for event host to start the online conference session.
|
|
1155
1152
|
* @readonly
|
|
@@ -1176,7 +1173,7 @@ export interface OnlineConferencingSession {
|
|
|
1176
1173
|
*/
|
|
1177
1174
|
sessionId?: string | null;
|
|
1178
1175
|
}
|
|
1179
|
-
|
|
1176
|
+
interface SeoSettings {
|
|
1180
1177
|
/**
|
|
1181
1178
|
* URL slug
|
|
1182
1179
|
* @maxLength 130
|
|
@@ -1195,13 +1192,13 @@ export interface SeoSettings {
|
|
|
1195
1192
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1196
1193
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1197
1194
|
*/
|
|
1198
|
-
|
|
1195
|
+
interface SeoSchema {
|
|
1199
1196
|
/** SEO tag information. */
|
|
1200
1197
|
tags?: Tag[];
|
|
1201
1198
|
/** SEO general settings. */
|
|
1202
1199
|
settings?: Settings;
|
|
1203
1200
|
}
|
|
1204
|
-
|
|
1201
|
+
interface Keyword {
|
|
1205
1202
|
/** Keyword value. */
|
|
1206
1203
|
term?: string;
|
|
1207
1204
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1212,7 +1209,7 @@ export interface Keyword {
|
|
|
1212
1209
|
*/
|
|
1213
1210
|
origin?: string | null;
|
|
1214
1211
|
}
|
|
1215
|
-
|
|
1212
|
+
interface Tag {
|
|
1216
1213
|
/**
|
|
1217
1214
|
* SEO tag type.
|
|
1218
1215
|
*
|
|
@@ -1234,7 +1231,7 @@ export interface Tag {
|
|
|
1234
1231
|
/** Whether the tag is disabled. */
|
|
1235
1232
|
disabled?: boolean;
|
|
1236
1233
|
}
|
|
1237
|
-
|
|
1234
|
+
interface Settings {
|
|
1238
1235
|
/**
|
|
1239
1236
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1240
1237
|
*
|
|
@@ -1248,7 +1245,7 @@ export interface Settings {
|
|
|
1248
1245
|
*/
|
|
1249
1246
|
keywords?: Keyword[];
|
|
1250
1247
|
}
|
|
1251
|
-
|
|
1248
|
+
interface Agenda {
|
|
1252
1249
|
/** Whether the schedule is enabled for the event. */
|
|
1253
1250
|
enabled?: boolean;
|
|
1254
1251
|
/**
|
|
@@ -1257,7 +1254,7 @@ export interface Agenda {
|
|
|
1257
1254
|
*/
|
|
1258
1255
|
pageUrl?: SiteUrl;
|
|
1259
1256
|
}
|
|
1260
|
-
|
|
1257
|
+
interface Category {
|
|
1261
1258
|
/**
|
|
1262
1259
|
* Category ID.
|
|
1263
1260
|
* @format GUID
|
|
@@ -1295,13 +1292,13 @@ export interface Category {
|
|
|
1295
1292
|
*/
|
|
1296
1293
|
states?: StateWithLiterals[];
|
|
1297
1294
|
}
|
|
1298
|
-
|
|
1295
|
+
interface CategoryCounts {
|
|
1299
1296
|
/** Total number of draft events assigned to the category. */
|
|
1300
1297
|
assignedEventsCount?: number | null;
|
|
1301
1298
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1302
1299
|
assignedDraftEventsCount?: number | null;
|
|
1303
1300
|
}
|
|
1304
|
-
|
|
1301
|
+
declare enum State {
|
|
1305
1302
|
/** Created manually by the user. */
|
|
1306
1303
|
MANUAL = "MANUAL",
|
|
1307
1304
|
/** Created automatically. */
|
|
@@ -1312,16 +1309,16 @@ export declare enum State {
|
|
|
1312
1309
|
HIDDEN = "HIDDEN"
|
|
1313
1310
|
}
|
|
1314
1311
|
/** @enumType */
|
|
1315
|
-
|
|
1316
|
-
|
|
1312
|
+
type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1313
|
+
interface EventDisplaySettings {
|
|
1317
1314
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1318
1315
|
hideEventDetailsButton?: boolean | null;
|
|
1319
1316
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1320
1317
|
hideEventDetailsPage?: boolean | null;
|
|
1321
1318
|
}
|
|
1322
|
-
|
|
1319
|
+
interface LabellingSettings {
|
|
1323
1320
|
}
|
|
1324
|
-
|
|
1321
|
+
interface RichContent {
|
|
1325
1322
|
/** Node objects representing a rich content document. */
|
|
1326
1323
|
nodes?: Node[];
|
|
1327
1324
|
/** Object metadata. */
|
|
@@ -1329,7 +1326,7 @@ export interface RichContent {
|
|
|
1329
1326
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1330
1327
|
documentStyle?: DocumentStyle;
|
|
1331
1328
|
}
|
|
1332
|
-
|
|
1329
|
+
interface Node extends NodeDataOneOf {
|
|
1333
1330
|
/** Data for a button node. */
|
|
1334
1331
|
buttonData?: ButtonData;
|
|
1335
1332
|
/** Data for a code block node. */
|
|
@@ -1394,7 +1391,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1394
1391
|
style?: NodeStyle;
|
|
1395
1392
|
}
|
|
1396
1393
|
/** @oneof */
|
|
1397
|
-
|
|
1394
|
+
interface NodeDataOneOf {
|
|
1398
1395
|
/** Data for a button node. */
|
|
1399
1396
|
buttonData?: ButtonData;
|
|
1400
1397
|
/** Data for a code block node. */
|
|
@@ -1450,7 +1447,7 @@ export interface NodeDataOneOf {
|
|
|
1450
1447
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1451
1448
|
layoutCellData?: LayoutCellData;
|
|
1452
1449
|
}
|
|
1453
|
-
|
|
1450
|
+
declare enum NodeType {
|
|
1454
1451
|
PARAGRAPH = "PARAGRAPH",
|
|
1455
1452
|
TEXT = "TEXT",
|
|
1456
1453
|
HEADING = "HEADING",
|
|
@@ -1487,8 +1484,8 @@ export declare enum NodeType {
|
|
|
1487
1484
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1488
1485
|
}
|
|
1489
1486
|
/** @enumType */
|
|
1490
|
-
|
|
1491
|
-
|
|
1487
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
1488
|
+
interface NodeStyle {
|
|
1492
1489
|
/** The top padding value in pixels. */
|
|
1493
1490
|
paddingTop?: string | null;
|
|
1494
1491
|
/** The bottom padding value in pixels. */
|
|
@@ -1496,7 +1493,7 @@ export interface NodeStyle {
|
|
|
1496
1493
|
/** The background color as a hexadecimal value. */
|
|
1497
1494
|
backgroundColor?: string | null;
|
|
1498
1495
|
}
|
|
1499
|
-
|
|
1496
|
+
interface ButtonData {
|
|
1500
1497
|
/** Styling for the button's container. */
|
|
1501
1498
|
containerData?: PluginContainerData;
|
|
1502
1499
|
/** The button type. */
|
|
@@ -1508,7 +1505,7 @@ export interface ButtonData {
|
|
|
1508
1505
|
/** Button link details. */
|
|
1509
1506
|
link?: V1Link;
|
|
1510
1507
|
}
|
|
1511
|
-
|
|
1508
|
+
interface Border {
|
|
1512
1509
|
/**
|
|
1513
1510
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1514
1511
|
* @deprecated
|
|
@@ -1520,7 +1517,7 @@ export interface Border {
|
|
|
1520
1517
|
*/
|
|
1521
1518
|
radius?: number | null;
|
|
1522
1519
|
}
|
|
1523
|
-
|
|
1520
|
+
interface Colors {
|
|
1524
1521
|
/**
|
|
1525
1522
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1526
1523
|
* @deprecated
|
|
@@ -1537,7 +1534,7 @@ export interface Colors {
|
|
|
1537
1534
|
*/
|
|
1538
1535
|
background?: string | null;
|
|
1539
1536
|
}
|
|
1540
|
-
|
|
1537
|
+
interface PluginContainerData {
|
|
1541
1538
|
/** The width of the node when it's displayed. */
|
|
1542
1539
|
width?: PluginContainerDataWidth;
|
|
1543
1540
|
/** The node's alignment within its container. */
|
|
@@ -1549,7 +1546,7 @@ export interface PluginContainerData {
|
|
|
1549
1546
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
1550
1547
|
textWrap?: boolean | null;
|
|
1551
1548
|
}
|
|
1552
|
-
|
|
1549
|
+
declare enum WidthType {
|
|
1553
1550
|
/** Width matches the content width */
|
|
1554
1551
|
CONTENT = "CONTENT",
|
|
1555
1552
|
/** Small Width */
|
|
@@ -1560,8 +1557,8 @@ export declare enum WidthType {
|
|
|
1560
1557
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1561
1558
|
}
|
|
1562
1559
|
/** @enumType */
|
|
1563
|
-
|
|
1564
|
-
|
|
1560
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1561
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1565
1562
|
/**
|
|
1566
1563
|
* One of the following predefined width options:
|
|
1567
1564
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1574,7 +1571,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1574
1571
|
custom?: string | null;
|
|
1575
1572
|
}
|
|
1576
1573
|
/** @oneof */
|
|
1577
|
-
|
|
1574
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1578
1575
|
/**
|
|
1579
1576
|
* One of the following predefined width options:
|
|
1580
1577
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1586,7 +1583,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1586
1583
|
/** A custom width value in pixels. */
|
|
1587
1584
|
custom?: string | null;
|
|
1588
1585
|
}
|
|
1589
|
-
|
|
1586
|
+
declare enum PluginContainerDataAlignment {
|
|
1590
1587
|
/** Center Alignment */
|
|
1591
1588
|
CENTER = "CENTER",
|
|
1592
1589
|
/** Left Alignment */
|
|
@@ -1595,8 +1592,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1595
1592
|
RIGHT = "RIGHT"
|
|
1596
1593
|
}
|
|
1597
1594
|
/** @enumType */
|
|
1598
|
-
|
|
1599
|
-
|
|
1595
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1596
|
+
interface Spoiler {
|
|
1600
1597
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1601
1598
|
enabled?: boolean | null;
|
|
1602
1599
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1604,19 +1601,19 @@ export interface Spoiler {
|
|
|
1604
1601
|
/** The text for the button used to remove the spoiler cover. */
|
|
1605
1602
|
buttonText?: string | null;
|
|
1606
1603
|
}
|
|
1607
|
-
|
|
1604
|
+
interface Height {
|
|
1608
1605
|
/** A custom height value in pixels. */
|
|
1609
1606
|
custom?: string | null;
|
|
1610
1607
|
}
|
|
1611
|
-
|
|
1608
|
+
declare enum ButtonDataType {
|
|
1612
1609
|
/** Regular link button */
|
|
1613
1610
|
LINK = "LINK",
|
|
1614
1611
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1615
1612
|
ACTION = "ACTION"
|
|
1616
1613
|
}
|
|
1617
1614
|
/** @enumType */
|
|
1618
|
-
|
|
1619
|
-
|
|
1615
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1616
|
+
interface Styles {
|
|
1620
1617
|
/**
|
|
1621
1618
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1622
1619
|
* @deprecated
|
|
@@ -1669,7 +1666,7 @@ export interface Styles {
|
|
|
1669
1666
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1670
1667
|
buttonSize?: string | null;
|
|
1671
1668
|
}
|
|
1672
|
-
|
|
1669
|
+
interface V1Link extends V1LinkDataOneOf {
|
|
1673
1670
|
/** The absolute URL for the linked document. */
|
|
1674
1671
|
url?: string;
|
|
1675
1672
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1688,13 +1685,13 @@ export interface V1Link extends V1LinkDataOneOf {
|
|
|
1688
1685
|
customData?: string | null;
|
|
1689
1686
|
}
|
|
1690
1687
|
/** @oneof */
|
|
1691
|
-
|
|
1688
|
+
interface V1LinkDataOneOf {
|
|
1692
1689
|
/** The absolute URL for the linked document. */
|
|
1693
1690
|
url?: string;
|
|
1694
1691
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1695
1692
|
anchor?: string;
|
|
1696
1693
|
}
|
|
1697
|
-
|
|
1694
|
+
declare enum Target {
|
|
1698
1695
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1699
1696
|
SELF = "SELF",
|
|
1700
1697
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1705,8 +1702,8 @@ export declare enum Target {
|
|
|
1705
1702
|
TOP = "TOP"
|
|
1706
1703
|
}
|
|
1707
1704
|
/** @enumType */
|
|
1708
|
-
|
|
1709
|
-
|
|
1705
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1706
|
+
interface Rel {
|
|
1710
1707
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1711
1708
|
nofollow?: boolean | null;
|
|
1712
1709
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1716,17 +1713,17 @@ export interface Rel {
|
|
|
1716
1713
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1717
1714
|
noreferrer?: boolean | null;
|
|
1718
1715
|
}
|
|
1719
|
-
|
|
1716
|
+
interface CodeBlockData {
|
|
1720
1717
|
/** Styling for the code block's text. */
|
|
1721
1718
|
textStyle?: TextStyle;
|
|
1722
1719
|
}
|
|
1723
|
-
|
|
1720
|
+
interface TextStyle {
|
|
1724
1721
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1725
1722
|
textAlignment?: TextAlignmentWithLiterals;
|
|
1726
1723
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
1727
1724
|
lineHeight?: string | null;
|
|
1728
1725
|
}
|
|
1729
|
-
|
|
1726
|
+
declare enum TextAlignment {
|
|
1730
1727
|
/** browser default, eqivalent to `initial` */
|
|
1731
1728
|
AUTO = "AUTO",
|
|
1732
1729
|
/** Left align */
|
|
@@ -1739,8 +1736,8 @@ export declare enum TextAlignment {
|
|
|
1739
1736
|
JUSTIFY = "JUSTIFY"
|
|
1740
1737
|
}
|
|
1741
1738
|
/** @enumType */
|
|
1742
|
-
|
|
1743
|
-
|
|
1739
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1740
|
+
interface DividerData {
|
|
1744
1741
|
/** Styling for the divider's container. */
|
|
1745
1742
|
containerData?: PluginContainerData;
|
|
1746
1743
|
/** Divider line style. */
|
|
@@ -1750,7 +1747,7 @@ export interface DividerData {
|
|
|
1750
1747
|
/** Divider alignment. */
|
|
1751
1748
|
alignment?: AlignmentWithLiterals;
|
|
1752
1749
|
}
|
|
1753
|
-
|
|
1750
|
+
declare enum LineStyle {
|
|
1754
1751
|
/** Single Line */
|
|
1755
1752
|
SINGLE = "SINGLE",
|
|
1756
1753
|
/** Double Line */
|
|
@@ -1761,8 +1758,8 @@ export declare enum LineStyle {
|
|
|
1761
1758
|
DOTTED = "DOTTED"
|
|
1762
1759
|
}
|
|
1763
1760
|
/** @enumType */
|
|
1764
|
-
|
|
1765
|
-
|
|
1761
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1762
|
+
declare enum Width {
|
|
1766
1763
|
/** Large line */
|
|
1767
1764
|
LARGE = "LARGE",
|
|
1768
1765
|
/** Medium line */
|
|
@@ -1771,8 +1768,8 @@ export declare enum Width {
|
|
|
1771
1768
|
SMALL = "SMALL"
|
|
1772
1769
|
}
|
|
1773
1770
|
/** @enumType */
|
|
1774
|
-
|
|
1775
|
-
|
|
1771
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1772
|
+
declare enum Alignment {
|
|
1776
1773
|
/** Center alignment */
|
|
1777
1774
|
CENTER = "CENTER",
|
|
1778
1775
|
/** Left alignment */
|
|
@@ -1781,8 +1778,8 @@ export declare enum Alignment {
|
|
|
1781
1778
|
RIGHT = "RIGHT"
|
|
1782
1779
|
}
|
|
1783
1780
|
/** @enumType */
|
|
1784
|
-
|
|
1785
|
-
|
|
1781
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1782
|
+
interface FileData {
|
|
1786
1783
|
/** Styling for the file's container. */
|
|
1787
1784
|
containerData?: PluginContainerData;
|
|
1788
1785
|
/** The source for the file's data. */
|
|
@@ -1805,7 +1802,7 @@ export interface FileData {
|
|
|
1805
1802
|
/** File size in KB. */
|
|
1806
1803
|
sizeInKb?: string | null;
|
|
1807
1804
|
}
|
|
1808
|
-
|
|
1805
|
+
declare enum ViewMode {
|
|
1809
1806
|
/** No PDF view */
|
|
1810
1807
|
NONE = "NONE",
|
|
1811
1808
|
/** Full PDF view */
|
|
@@ -1814,8 +1811,8 @@ export declare enum ViewMode {
|
|
|
1814
1811
|
MINI = "MINI"
|
|
1815
1812
|
}
|
|
1816
1813
|
/** @enumType */
|
|
1817
|
-
|
|
1818
|
-
|
|
1814
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1815
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1819
1816
|
/** The absolute URL for the file's source. */
|
|
1820
1817
|
url?: string | null;
|
|
1821
1818
|
/**
|
|
@@ -1829,7 +1826,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1829
1826
|
private?: boolean | null;
|
|
1830
1827
|
}
|
|
1831
1828
|
/** @oneof */
|
|
1832
|
-
|
|
1829
|
+
interface FileSourceDataOneOf {
|
|
1833
1830
|
/** The absolute URL for the file's source. */
|
|
1834
1831
|
url?: string | null;
|
|
1835
1832
|
/**
|
|
@@ -1840,7 +1837,7 @@ export interface FileSourceDataOneOf {
|
|
|
1840
1837
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1841
1838
|
id?: string | null;
|
|
1842
1839
|
}
|
|
1843
|
-
|
|
1840
|
+
interface PDFSettings {
|
|
1844
1841
|
/**
|
|
1845
1842
|
* PDF view mode. One of the following:
|
|
1846
1843
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1853,7 +1850,7 @@ export interface PDFSettings {
|
|
|
1853
1850
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1854
1851
|
disablePrint?: boolean | null;
|
|
1855
1852
|
}
|
|
1856
|
-
|
|
1853
|
+
interface GalleryData {
|
|
1857
1854
|
/** Styling for the gallery's container. */
|
|
1858
1855
|
containerData?: PluginContainerData;
|
|
1859
1856
|
/** The items in the gallery. */
|
|
@@ -1865,7 +1862,7 @@ export interface GalleryData {
|
|
|
1865
1862
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1866
1863
|
disableDownload?: boolean | null;
|
|
1867
1864
|
}
|
|
1868
|
-
|
|
1865
|
+
interface Media {
|
|
1869
1866
|
/** The source for the media's data. */
|
|
1870
1867
|
src?: FileSource;
|
|
1871
1868
|
/** Media width in pixels. */
|
|
@@ -1875,19 +1872,19 @@ export interface Media {
|
|
|
1875
1872
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1876
1873
|
duration?: number | null;
|
|
1877
1874
|
}
|
|
1878
|
-
|
|
1875
|
+
interface Image {
|
|
1879
1876
|
/** Image file details. */
|
|
1880
1877
|
media?: Media;
|
|
1881
1878
|
/** Link details for images that are links. */
|
|
1882
1879
|
link?: V1Link;
|
|
1883
1880
|
}
|
|
1884
|
-
|
|
1881
|
+
interface Video {
|
|
1885
1882
|
/** Video file details. */
|
|
1886
1883
|
media?: Media;
|
|
1887
1884
|
/** Video thumbnail file details. */
|
|
1888
1885
|
thumbnail?: Media;
|
|
1889
1886
|
}
|
|
1890
|
-
|
|
1887
|
+
interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
1891
1888
|
/** An image item. */
|
|
1892
1889
|
image?: Image;
|
|
1893
1890
|
/** A video item. */
|
|
@@ -1898,13 +1895,13 @@ export interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
|
1898
1895
|
altText?: string | null;
|
|
1899
1896
|
}
|
|
1900
1897
|
/** @oneof */
|
|
1901
|
-
|
|
1898
|
+
interface GalleryDataItemDataOneOf {
|
|
1902
1899
|
/** An image item. */
|
|
1903
1900
|
image?: Image;
|
|
1904
1901
|
/** A video item. */
|
|
1905
1902
|
video?: Video;
|
|
1906
1903
|
}
|
|
1907
|
-
|
|
1904
|
+
interface GalleryOptions {
|
|
1908
1905
|
/** Gallery layout. */
|
|
1909
1906
|
layout?: Layout;
|
|
1910
1907
|
/** Styling for gallery items. */
|
|
@@ -1912,7 +1909,7 @@ export interface GalleryOptions {
|
|
|
1912
1909
|
/** Styling for gallery thumbnail images. */
|
|
1913
1910
|
thumbnails?: Thumbnails;
|
|
1914
1911
|
}
|
|
1915
|
-
|
|
1912
|
+
declare enum LayoutType {
|
|
1916
1913
|
/** Collage type */
|
|
1917
1914
|
COLLAGE = "COLLAGE",
|
|
1918
1915
|
/** Masonry type */
|
|
@@ -1935,24 +1932,24 @@ export declare enum LayoutType {
|
|
|
1935
1932
|
FULLSIZE = "FULLSIZE"
|
|
1936
1933
|
}
|
|
1937
1934
|
/** @enumType */
|
|
1938
|
-
|
|
1939
|
-
|
|
1935
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1936
|
+
declare enum Orientation {
|
|
1940
1937
|
/** Rows Orientation */
|
|
1941
1938
|
ROWS = "ROWS",
|
|
1942
1939
|
/** Columns Orientation */
|
|
1943
1940
|
COLUMNS = "COLUMNS"
|
|
1944
1941
|
}
|
|
1945
1942
|
/** @enumType */
|
|
1946
|
-
|
|
1947
|
-
|
|
1943
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1944
|
+
declare enum Crop {
|
|
1948
1945
|
/** Crop to fill */
|
|
1949
1946
|
FILL = "FILL",
|
|
1950
1947
|
/** Crop to fit */
|
|
1951
1948
|
FIT = "FIT"
|
|
1952
1949
|
}
|
|
1953
1950
|
/** @enumType */
|
|
1954
|
-
|
|
1955
|
-
|
|
1951
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1952
|
+
declare enum ThumbnailsAlignment {
|
|
1956
1953
|
/** Top alignment */
|
|
1957
1954
|
TOP = "TOP",
|
|
1958
1955
|
/** Right alignment */
|
|
@@ -1965,8 +1962,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
1965
1962
|
NONE = "NONE"
|
|
1966
1963
|
}
|
|
1967
1964
|
/** @enumType */
|
|
1968
|
-
|
|
1969
|
-
|
|
1965
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1966
|
+
interface Layout {
|
|
1970
1967
|
/** Gallery layout type. */
|
|
1971
1968
|
type?: LayoutTypeWithLiterals;
|
|
1972
1969
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -1978,7 +1975,7 @@ export interface Layout {
|
|
|
1978
1975
|
/** The number of columns to display on mobile screens. */
|
|
1979
1976
|
mobileNumberOfColumns?: number | null;
|
|
1980
1977
|
}
|
|
1981
|
-
|
|
1978
|
+
interface ItemStyle {
|
|
1982
1979
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1983
1980
|
targetSize?: number | null;
|
|
1984
1981
|
/** Item ratio */
|
|
@@ -1988,13 +1985,13 @@ export interface ItemStyle {
|
|
|
1988
1985
|
/** The spacing between items in pixels. */
|
|
1989
1986
|
spacing?: number | null;
|
|
1990
1987
|
}
|
|
1991
|
-
|
|
1988
|
+
interface Thumbnails {
|
|
1992
1989
|
/** Thumbnail alignment. */
|
|
1993
1990
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1994
1991
|
/** Spacing between thumbnails in pixels. */
|
|
1995
1992
|
spacing?: number | null;
|
|
1996
1993
|
}
|
|
1997
|
-
|
|
1994
|
+
interface GIFData {
|
|
1998
1995
|
/** Styling for the GIF's container. */
|
|
1999
1996
|
containerData?: PluginContainerData;
|
|
2000
1997
|
/** The source of the full size GIF. */
|
|
@@ -2008,7 +2005,7 @@ export interface GIFData {
|
|
|
2008
2005
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2009
2006
|
gifType?: GIFTypeWithLiterals;
|
|
2010
2007
|
}
|
|
2011
|
-
|
|
2008
|
+
interface GIF {
|
|
2012
2009
|
/**
|
|
2013
2010
|
* GIF format URL.
|
|
2014
2011
|
* @format WEB_URL
|
|
@@ -2025,13 +2022,13 @@ export interface GIF {
|
|
|
2025
2022
|
*/
|
|
2026
2023
|
still?: string | null;
|
|
2027
2024
|
}
|
|
2028
|
-
|
|
2025
|
+
declare enum GIFType {
|
|
2029
2026
|
NORMAL = "NORMAL",
|
|
2030
2027
|
STICKER = "STICKER"
|
|
2031
2028
|
}
|
|
2032
2029
|
/** @enumType */
|
|
2033
|
-
|
|
2034
|
-
|
|
2030
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2031
|
+
interface HeadingData {
|
|
2035
2032
|
/** Heading level from 1-6. */
|
|
2036
2033
|
level?: number;
|
|
2037
2034
|
/** Styling for the heading text. */
|
|
@@ -2039,7 +2036,7 @@ export interface HeadingData {
|
|
|
2039
2036
|
/** Indentation level from 1-4. */
|
|
2040
2037
|
indentation?: number | null;
|
|
2041
2038
|
}
|
|
2042
|
-
|
|
2039
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
2043
2040
|
/** The URL for the HTML code for the node. */
|
|
2044
2041
|
url?: string;
|
|
2045
2042
|
/** The HTML code for the node. */
|
|
@@ -2057,7 +2054,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2057
2054
|
autoHeight?: boolean | null;
|
|
2058
2055
|
}
|
|
2059
2056
|
/** @oneof */
|
|
2060
|
-
|
|
2057
|
+
interface HTMLDataDataOneOf {
|
|
2061
2058
|
/** The URL for the HTML code for the node. */
|
|
2062
2059
|
url?: string;
|
|
2063
2060
|
/** The HTML code for the node. */
|
|
@@ -2068,13 +2065,13 @@ export interface HTMLDataDataOneOf {
|
|
|
2068
2065
|
*/
|
|
2069
2066
|
isAdsense?: boolean | null;
|
|
2070
2067
|
}
|
|
2071
|
-
|
|
2068
|
+
declare enum Source {
|
|
2072
2069
|
HTML = "HTML",
|
|
2073
2070
|
ADSENSE = "ADSENSE"
|
|
2074
2071
|
}
|
|
2075
2072
|
/** @enumType */
|
|
2076
|
-
|
|
2077
|
-
|
|
2073
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2074
|
+
interface ImageData {
|
|
2078
2075
|
/** Styling for the image's container. */
|
|
2079
2076
|
containerData?: PluginContainerData;
|
|
2080
2077
|
/** Image file details. */
|
|
@@ -2097,7 +2094,7 @@ export interface ImageData {
|
|
|
2097
2094
|
/** Styling for the image. */
|
|
2098
2095
|
styles?: ImageDataStyles;
|
|
2099
2096
|
}
|
|
2100
|
-
|
|
2097
|
+
interface StylesBorder {
|
|
2101
2098
|
/** Border width in pixels. */
|
|
2102
2099
|
width?: number | null;
|
|
2103
2100
|
/**
|
|
@@ -2108,11 +2105,11 @@ export interface StylesBorder {
|
|
|
2108
2105
|
/** Border radius in pixels. */
|
|
2109
2106
|
radius?: number | null;
|
|
2110
2107
|
}
|
|
2111
|
-
|
|
2108
|
+
interface ImageDataStyles {
|
|
2112
2109
|
/** Border attributes. */
|
|
2113
2110
|
border?: StylesBorder;
|
|
2114
2111
|
}
|
|
2115
|
-
|
|
2112
|
+
interface LinkPreviewData {
|
|
2116
2113
|
/** Styling for the link preview's container. */
|
|
2117
2114
|
containerData?: PluginContainerData;
|
|
2118
2115
|
/** Link details. */
|
|
@@ -2128,7 +2125,7 @@ export interface LinkPreviewData {
|
|
|
2128
2125
|
/** Styling for the link preview. */
|
|
2129
2126
|
styles?: LinkPreviewDataStyles;
|
|
2130
2127
|
}
|
|
2131
|
-
|
|
2128
|
+
declare enum Position {
|
|
2132
2129
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2133
2130
|
START = "START",
|
|
2134
2131
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2139,8 +2136,8 @@ export declare enum Position {
|
|
|
2139
2136
|
HIDDEN = "HIDDEN"
|
|
2140
2137
|
}
|
|
2141
2138
|
/** @enumType */
|
|
2142
|
-
|
|
2143
|
-
|
|
2139
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2140
|
+
interface LinkPreviewDataStyles {
|
|
2144
2141
|
/**
|
|
2145
2142
|
* Background color as a hexadecimal value.
|
|
2146
2143
|
* @format COLOR_HEX
|
|
@@ -2173,13 +2170,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2173
2170
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2174
2171
|
thumbnailPosition?: PositionWithLiterals;
|
|
2175
2172
|
}
|
|
2176
|
-
|
|
2173
|
+
interface MapData {
|
|
2177
2174
|
/** Styling for the map's container. */
|
|
2178
2175
|
containerData?: PluginContainerData;
|
|
2179
2176
|
/** Map settings. */
|
|
2180
2177
|
mapSettings?: MapSettings;
|
|
2181
2178
|
}
|
|
2182
|
-
|
|
2179
|
+
interface MapSettings {
|
|
2183
2180
|
/** The address to display on the map. */
|
|
2184
2181
|
address?: string | null;
|
|
2185
2182
|
/** Sets whether the map is draggable. */
|
|
@@ -2203,7 +2200,7 @@ export interface MapSettings {
|
|
|
2203
2200
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2204
2201
|
mapType?: MapTypeWithLiterals;
|
|
2205
2202
|
}
|
|
2206
|
-
|
|
2203
|
+
declare enum MapType {
|
|
2207
2204
|
/** Roadmap map type */
|
|
2208
2205
|
ROADMAP = "ROADMAP",
|
|
2209
2206
|
/** Satellite map type */
|
|
@@ -2214,8 +2211,8 @@ export declare enum MapType {
|
|
|
2214
2211
|
TERRAIN = "TERRAIN"
|
|
2215
2212
|
}
|
|
2216
2213
|
/** @enumType */
|
|
2217
|
-
|
|
2218
|
-
|
|
2214
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2215
|
+
interface ParagraphData {
|
|
2219
2216
|
/** Styling for the paragraph text. */
|
|
2220
2217
|
textStyle?: TextStyle;
|
|
2221
2218
|
/** Indentation level from 1-4. */
|
|
@@ -2223,7 +2220,7 @@ export interface ParagraphData {
|
|
|
2223
2220
|
/** Paragraph level */
|
|
2224
2221
|
level?: number | null;
|
|
2225
2222
|
}
|
|
2226
|
-
|
|
2223
|
+
interface PollData {
|
|
2227
2224
|
/** Styling for the poll's container. */
|
|
2228
2225
|
containerData?: PluginContainerData;
|
|
2229
2226
|
/** Poll data. */
|
|
@@ -2233,7 +2230,7 @@ export interface PollData {
|
|
|
2233
2230
|
/** Styling for the poll and voting options. */
|
|
2234
2231
|
design?: Design;
|
|
2235
2232
|
}
|
|
2236
|
-
|
|
2233
|
+
declare enum ViewRole {
|
|
2237
2234
|
/** Only Poll creator can view the results */
|
|
2238
2235
|
CREATOR = "CREATOR",
|
|
2239
2236
|
/** Anyone who voted can see the results */
|
|
@@ -2242,16 +2239,16 @@ export declare enum ViewRole {
|
|
|
2242
2239
|
EVERYONE = "EVERYONE"
|
|
2243
2240
|
}
|
|
2244
2241
|
/** @enumType */
|
|
2245
|
-
|
|
2246
|
-
|
|
2242
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2243
|
+
declare enum VoteRole {
|
|
2247
2244
|
/** Logged in member */
|
|
2248
2245
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2249
2246
|
/** Anyone */
|
|
2250
2247
|
ALL = "ALL"
|
|
2251
2248
|
}
|
|
2252
2249
|
/** @enumType */
|
|
2253
|
-
|
|
2254
|
-
|
|
2250
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2251
|
+
interface Permissions {
|
|
2255
2252
|
/** Sets who can view the poll results. */
|
|
2256
2253
|
view?: ViewRoleWithLiterals;
|
|
2257
2254
|
/** Sets who can vote. */
|
|
@@ -2259,7 +2256,7 @@ export interface Permissions {
|
|
|
2259
2256
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2260
2257
|
allowMultipleVotes?: boolean | null;
|
|
2261
2258
|
}
|
|
2262
|
-
|
|
2259
|
+
interface Option {
|
|
2263
2260
|
/** Option ID. */
|
|
2264
2261
|
id?: string | null;
|
|
2265
2262
|
/** Option title. */
|
|
@@ -2267,7 +2264,7 @@ export interface Option {
|
|
|
2267
2264
|
/** The image displayed with the option. */
|
|
2268
2265
|
image?: Media;
|
|
2269
2266
|
}
|
|
2270
|
-
|
|
2267
|
+
interface PollSettings {
|
|
2271
2268
|
/** Permissions settings for voting. */
|
|
2272
2269
|
permissions?: Permissions;
|
|
2273
2270
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2275,23 +2272,23 @@ export interface PollSettings {
|
|
|
2275
2272
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2276
2273
|
showVotesCount?: boolean | null;
|
|
2277
2274
|
}
|
|
2278
|
-
|
|
2275
|
+
declare enum PollLayoutType {
|
|
2279
2276
|
/** List */
|
|
2280
2277
|
LIST = "LIST",
|
|
2281
2278
|
/** Grid */
|
|
2282
2279
|
GRID = "GRID"
|
|
2283
2280
|
}
|
|
2284
2281
|
/** @enumType */
|
|
2285
|
-
|
|
2286
|
-
|
|
2282
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2283
|
+
declare enum PollLayoutDirection {
|
|
2287
2284
|
/** Left-to-right */
|
|
2288
2285
|
LTR = "LTR",
|
|
2289
2286
|
/** Right-to-left */
|
|
2290
2287
|
RTL = "RTL"
|
|
2291
2288
|
}
|
|
2292
2289
|
/** @enumType */
|
|
2293
|
-
|
|
2294
|
-
|
|
2290
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2291
|
+
interface PollLayout {
|
|
2295
2292
|
/** The layout for displaying the voting options. */
|
|
2296
2293
|
type?: PollLayoutTypeWithLiterals;
|
|
2297
2294
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2299,11 +2296,11 @@ export interface PollLayout {
|
|
|
2299
2296
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2300
2297
|
enableImage?: boolean | null;
|
|
2301
2298
|
}
|
|
2302
|
-
|
|
2299
|
+
interface OptionLayout {
|
|
2303
2300
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2304
2301
|
enableImage?: boolean | null;
|
|
2305
2302
|
}
|
|
2306
|
-
|
|
2303
|
+
declare enum BackgroundType {
|
|
2307
2304
|
/** Color background type */
|
|
2308
2305
|
COLOR = "COLOR",
|
|
2309
2306
|
/** Image background type */
|
|
@@ -2312,8 +2309,8 @@ export declare enum BackgroundType {
|
|
|
2312
2309
|
GRADIENT = "GRADIENT"
|
|
2313
2310
|
}
|
|
2314
2311
|
/** @enumType */
|
|
2315
|
-
|
|
2316
|
-
|
|
2312
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2313
|
+
interface Gradient {
|
|
2317
2314
|
/** The gradient angle in degrees. */
|
|
2318
2315
|
angle?: number | null;
|
|
2319
2316
|
/**
|
|
@@ -2327,7 +2324,7 @@ export interface Gradient {
|
|
|
2327
2324
|
*/
|
|
2328
2325
|
lastColor?: string | null;
|
|
2329
2326
|
}
|
|
2330
|
-
|
|
2327
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2331
2328
|
/**
|
|
2332
2329
|
* The background color as a hexademical value.
|
|
2333
2330
|
* @format COLOR_HEX
|
|
@@ -2341,7 +2338,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2341
2338
|
type?: BackgroundTypeWithLiterals;
|
|
2342
2339
|
}
|
|
2343
2340
|
/** @oneof */
|
|
2344
|
-
|
|
2341
|
+
interface BackgroundBackgroundOneOf {
|
|
2345
2342
|
/**
|
|
2346
2343
|
* The background color as a hexademical value.
|
|
2347
2344
|
* @format COLOR_HEX
|
|
@@ -2352,17 +2349,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2352
2349
|
/** Details for a gradient background. */
|
|
2353
2350
|
gradient?: Gradient;
|
|
2354
2351
|
}
|
|
2355
|
-
|
|
2352
|
+
interface PollDesign {
|
|
2356
2353
|
/** Background styling. */
|
|
2357
2354
|
background?: Background;
|
|
2358
2355
|
/** Border radius in pixels. */
|
|
2359
2356
|
borderRadius?: number | null;
|
|
2360
2357
|
}
|
|
2361
|
-
|
|
2358
|
+
interface OptionDesign {
|
|
2362
2359
|
/** Border radius in pixels. */
|
|
2363
2360
|
borderRadius?: number | null;
|
|
2364
2361
|
}
|
|
2365
|
-
|
|
2362
|
+
interface Poll {
|
|
2366
2363
|
/** Poll ID. */
|
|
2367
2364
|
id?: string | null;
|
|
2368
2365
|
/** Poll title. */
|
|
@@ -2376,26 +2373,26 @@ export interface Poll {
|
|
|
2376
2373
|
/** The poll's permissions and display settings. */
|
|
2377
2374
|
settings?: PollSettings;
|
|
2378
2375
|
}
|
|
2379
|
-
|
|
2376
|
+
interface PollDataLayout {
|
|
2380
2377
|
/** Poll layout settings. */
|
|
2381
2378
|
poll?: PollLayout;
|
|
2382
2379
|
/** Voting otpions layout settings. */
|
|
2383
2380
|
options?: OptionLayout;
|
|
2384
2381
|
}
|
|
2385
|
-
|
|
2382
|
+
interface Design {
|
|
2386
2383
|
/** Styling for the poll. */
|
|
2387
2384
|
poll?: PollDesign;
|
|
2388
2385
|
/** Styling for voting options. */
|
|
2389
2386
|
options?: OptionDesign;
|
|
2390
2387
|
}
|
|
2391
|
-
|
|
2388
|
+
interface TextData {
|
|
2392
2389
|
/** The text to apply decorations to. */
|
|
2393
2390
|
text?: string;
|
|
2394
2391
|
/** The decorations to apply. */
|
|
2395
2392
|
decorations?: Decoration[];
|
|
2396
2393
|
}
|
|
2397
2394
|
/** Adds appearence changes to text */
|
|
2398
|
-
|
|
2395
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2399
2396
|
/** Data for an anchor link decoration. */
|
|
2400
2397
|
anchorData?: AnchorData;
|
|
2401
2398
|
/** Data for a color decoration. */
|
|
@@ -2420,7 +2417,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2420
2417
|
type?: DecorationTypeWithLiterals;
|
|
2421
2418
|
}
|
|
2422
2419
|
/** @oneof */
|
|
2423
|
-
|
|
2420
|
+
interface DecorationDataOneOf {
|
|
2424
2421
|
/** Data for an anchor link decoration. */
|
|
2425
2422
|
anchorData?: AnchorData;
|
|
2426
2423
|
/** Data for a color decoration. */
|
|
@@ -2442,7 +2439,7 @@ export interface DecorationDataOneOf {
|
|
|
2442
2439
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2443
2440
|
strikethroughData?: boolean | null;
|
|
2444
2441
|
}
|
|
2445
|
-
|
|
2442
|
+
declare enum DecorationType {
|
|
2446
2443
|
BOLD = "BOLD",
|
|
2447
2444
|
ITALIC = "ITALIC",
|
|
2448
2445
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2456,22 +2453,22 @@ export declare enum DecorationType {
|
|
|
2456
2453
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2457
2454
|
}
|
|
2458
2455
|
/** @enumType */
|
|
2459
|
-
|
|
2460
|
-
|
|
2456
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2457
|
+
interface AnchorData {
|
|
2461
2458
|
/** The target node's ID. */
|
|
2462
2459
|
anchor?: string;
|
|
2463
2460
|
}
|
|
2464
|
-
|
|
2461
|
+
interface ColorData {
|
|
2465
2462
|
/** The text's background color as a hexadecimal value. */
|
|
2466
2463
|
background?: string | null;
|
|
2467
2464
|
/** The text's foreground color as a hexadecimal value. */
|
|
2468
2465
|
foreground?: string | null;
|
|
2469
2466
|
}
|
|
2470
|
-
|
|
2467
|
+
interface LinkData {
|
|
2471
2468
|
/** Link details. */
|
|
2472
2469
|
link?: V1Link;
|
|
2473
2470
|
}
|
|
2474
|
-
|
|
2471
|
+
interface MentionData {
|
|
2475
2472
|
/** The mentioned user's name. */
|
|
2476
2473
|
name?: string;
|
|
2477
2474
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2479,23 +2476,23 @@ export interface MentionData {
|
|
|
2479
2476
|
/** Mentioned user's ID. */
|
|
2480
2477
|
id?: string | null;
|
|
2481
2478
|
}
|
|
2482
|
-
|
|
2479
|
+
interface FontSizeData {
|
|
2483
2480
|
/** The units used for the font size. */
|
|
2484
2481
|
unit?: FontTypeWithLiterals;
|
|
2485
2482
|
/** Font size value. */
|
|
2486
2483
|
value?: number | null;
|
|
2487
2484
|
}
|
|
2488
|
-
|
|
2485
|
+
declare enum FontType {
|
|
2489
2486
|
PX = "PX",
|
|
2490
2487
|
EM = "EM"
|
|
2491
2488
|
}
|
|
2492
2489
|
/** @enumType */
|
|
2493
|
-
|
|
2494
|
-
|
|
2490
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2491
|
+
interface SpoilerData {
|
|
2495
2492
|
/** Spoiler ID. */
|
|
2496
2493
|
id?: string | null;
|
|
2497
2494
|
}
|
|
2498
|
-
|
|
2495
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2499
2496
|
/** Data for embedded Wix Bookings content. */
|
|
2500
2497
|
bookingData?: BookingData;
|
|
2501
2498
|
/** Data for embedded Wix Events content. */
|
|
@@ -2517,30 +2514,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2517
2514
|
image?: Media;
|
|
2518
2515
|
}
|
|
2519
2516
|
/** @oneof */
|
|
2520
|
-
|
|
2517
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2521
2518
|
/** Data for embedded Wix Bookings content. */
|
|
2522
2519
|
bookingData?: BookingData;
|
|
2523
2520
|
/** Data for embedded Wix Events content. */
|
|
2524
2521
|
eventData?: EventData;
|
|
2525
2522
|
}
|
|
2526
|
-
|
|
2523
|
+
declare enum AppType {
|
|
2527
2524
|
PRODUCT = "PRODUCT",
|
|
2528
2525
|
EVENT = "EVENT",
|
|
2529
2526
|
BOOKING = "BOOKING"
|
|
2530
2527
|
}
|
|
2531
2528
|
/** @enumType */
|
|
2532
|
-
|
|
2533
|
-
|
|
2529
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2530
|
+
interface BookingData {
|
|
2534
2531
|
/** Booking duration in minutes. */
|
|
2535
2532
|
durations?: string | null;
|
|
2536
2533
|
}
|
|
2537
|
-
|
|
2534
|
+
interface EventData {
|
|
2538
2535
|
/** Event schedule. */
|
|
2539
2536
|
scheduling?: string | null;
|
|
2540
2537
|
/** Event location. */
|
|
2541
2538
|
location?: string | null;
|
|
2542
2539
|
}
|
|
2543
|
-
|
|
2540
|
+
interface VideoData {
|
|
2544
2541
|
/** Styling for the video's container. */
|
|
2545
2542
|
containerData?: PluginContainerData;
|
|
2546
2543
|
/** Video details. */
|
|
@@ -2554,7 +2551,7 @@ export interface VideoData {
|
|
|
2554
2551
|
/** Video options. */
|
|
2555
2552
|
options?: PlaybackOptions;
|
|
2556
2553
|
}
|
|
2557
|
-
|
|
2554
|
+
interface PlaybackOptions {
|
|
2558
2555
|
/** Sets whether the media will automatically start playing. */
|
|
2559
2556
|
autoPlay?: boolean | null;
|
|
2560
2557
|
/** Sets whether media's will be looped. */
|
|
@@ -2562,7 +2559,7 @@ export interface PlaybackOptions {
|
|
|
2562
2559
|
/** Sets whether media's controls will be shown. */
|
|
2563
2560
|
showControls?: boolean | null;
|
|
2564
2561
|
}
|
|
2565
|
-
|
|
2562
|
+
interface EmbedData {
|
|
2566
2563
|
/** Styling for the oEmbed node's container. */
|
|
2567
2564
|
containerData?: PluginContainerData;
|
|
2568
2565
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2570,7 +2567,7 @@ export interface EmbedData {
|
|
|
2570
2567
|
/** Origin asset source. */
|
|
2571
2568
|
src?: string | null;
|
|
2572
2569
|
}
|
|
2573
|
-
|
|
2570
|
+
interface Oembed {
|
|
2574
2571
|
/** The resource type. */
|
|
2575
2572
|
type?: string | null;
|
|
2576
2573
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2602,7 +2599,7 @@ export interface Oembed {
|
|
|
2602
2599
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2603
2600
|
version?: string | null;
|
|
2604
2601
|
}
|
|
2605
|
-
|
|
2602
|
+
interface CollapsibleListData {
|
|
2606
2603
|
/** Styling for the collapsible list's container. */
|
|
2607
2604
|
containerData?: PluginContainerData;
|
|
2608
2605
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2614,7 +2611,7 @@ export interface CollapsibleListData {
|
|
|
2614
2611
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2615
2612
|
isQapageData?: boolean | null;
|
|
2616
2613
|
}
|
|
2617
|
-
|
|
2614
|
+
declare enum InitialExpandedItems {
|
|
2618
2615
|
/** First item will be expended initally */
|
|
2619
2616
|
FIRST = "FIRST",
|
|
2620
2617
|
/** All items will expended initally */
|
|
@@ -2623,16 +2620,16 @@ export declare enum InitialExpandedItems {
|
|
|
2623
2620
|
NONE = "NONE"
|
|
2624
2621
|
}
|
|
2625
2622
|
/** @enumType */
|
|
2626
|
-
|
|
2627
|
-
|
|
2623
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2624
|
+
declare enum Direction {
|
|
2628
2625
|
/** Left-to-right */
|
|
2629
2626
|
LTR = "LTR",
|
|
2630
2627
|
/** Right-to-left */
|
|
2631
2628
|
RTL = "RTL"
|
|
2632
2629
|
}
|
|
2633
2630
|
/** @enumType */
|
|
2634
|
-
|
|
2635
|
-
|
|
2631
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2632
|
+
interface TableData {
|
|
2636
2633
|
/** Styling for the table's container. */
|
|
2637
2634
|
containerData?: PluginContainerData;
|
|
2638
2635
|
/** The table's dimensions. */
|
|
@@ -2647,7 +2644,7 @@ export interface TableData {
|
|
|
2647
2644
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2648
2645
|
columnHeader?: boolean | null;
|
|
2649
2646
|
}
|
|
2650
|
-
|
|
2647
|
+
interface Dimensions {
|
|
2651
2648
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2652
2649
|
colsWidthRatio?: number[];
|
|
2653
2650
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2655,13 +2652,13 @@ export interface Dimensions {
|
|
|
2655
2652
|
/** An array representing the minimum width of each column in pixels. */
|
|
2656
2653
|
colsMinWidth?: number[];
|
|
2657
2654
|
}
|
|
2658
|
-
|
|
2655
|
+
interface TableCellData {
|
|
2659
2656
|
/** Styling for the cell's background color and text alignment. */
|
|
2660
2657
|
cellStyle?: CellStyle;
|
|
2661
2658
|
/** The cell's border colors. */
|
|
2662
2659
|
borderColors?: BorderColors;
|
|
2663
2660
|
}
|
|
2664
|
-
|
|
2661
|
+
declare enum VerticalAlignment {
|
|
2665
2662
|
/** Top alignment */
|
|
2666
2663
|
TOP = "TOP",
|
|
2667
2664
|
/** Middle alignment */
|
|
@@ -2670,8 +2667,8 @@ export declare enum VerticalAlignment {
|
|
|
2670
2667
|
BOTTOM = "BOTTOM"
|
|
2671
2668
|
}
|
|
2672
2669
|
/** @enumType */
|
|
2673
|
-
|
|
2674
|
-
|
|
2670
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2671
|
+
interface CellStyle {
|
|
2675
2672
|
/** Vertical alignment for the cell's text. */
|
|
2676
2673
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2677
2674
|
/**
|
|
@@ -2680,7 +2677,7 @@ export interface CellStyle {
|
|
|
2680
2677
|
*/
|
|
2681
2678
|
backgroundColor?: string | null;
|
|
2682
2679
|
}
|
|
2683
|
-
|
|
2680
|
+
interface BorderColors {
|
|
2684
2681
|
/**
|
|
2685
2682
|
* Left border color as a hexadecimal value.
|
|
2686
2683
|
* @format COLOR_HEX
|
|
@@ -2708,22 +2705,20 @@ export interface BorderColors {
|
|
|
2708
2705
|
*
|
|
2709
2706
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2710
2707
|
*/
|
|
2711
|
-
|
|
2708
|
+
declare enum NullValue {
|
|
2712
2709
|
/** Null value. */
|
|
2713
2710
|
NULL_VALUE = "NULL_VALUE"
|
|
2714
2711
|
}
|
|
2715
|
-
/** @enumType */
|
|
2716
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2717
2712
|
/**
|
|
2718
2713
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2719
2714
|
*
|
|
2720
2715
|
* The JSON representation for `ListValue` is JSON array.
|
|
2721
2716
|
*/
|
|
2722
|
-
|
|
2717
|
+
interface ListValue {
|
|
2723
2718
|
/** Repeated field of dynamically typed values. */
|
|
2724
2719
|
values?: any[];
|
|
2725
2720
|
}
|
|
2726
|
-
|
|
2721
|
+
interface AudioData {
|
|
2727
2722
|
/** Styling for the audio node's container. */
|
|
2728
2723
|
containerData?: PluginContainerData;
|
|
2729
2724
|
/** Audio file details. */
|
|
@@ -2739,7 +2734,7 @@ export interface AudioData {
|
|
|
2739
2734
|
/** An HTML version of the audio node. */
|
|
2740
2735
|
html?: string | null;
|
|
2741
2736
|
}
|
|
2742
|
-
|
|
2737
|
+
interface OrderedListData {
|
|
2743
2738
|
/** Indentation level from 0-4. */
|
|
2744
2739
|
indentation?: number;
|
|
2745
2740
|
/** Offset level from 0-4. */
|
|
@@ -2747,24 +2742,24 @@ export interface OrderedListData {
|
|
|
2747
2742
|
/** List start number. */
|
|
2748
2743
|
start?: number | null;
|
|
2749
2744
|
}
|
|
2750
|
-
|
|
2745
|
+
interface BulletedListData {
|
|
2751
2746
|
/** Indentation level from 0-4. */
|
|
2752
2747
|
indentation?: number;
|
|
2753
2748
|
/** Offset level from 0-4. */
|
|
2754
2749
|
offset?: number | null;
|
|
2755
2750
|
}
|
|
2756
|
-
|
|
2751
|
+
interface BlockquoteData {
|
|
2757
2752
|
/** Indentation level from 1-4. */
|
|
2758
2753
|
indentation?: number;
|
|
2759
2754
|
}
|
|
2760
|
-
|
|
2755
|
+
interface CaptionData {
|
|
2761
2756
|
textStyle?: TextStyle;
|
|
2762
2757
|
}
|
|
2763
|
-
|
|
2758
|
+
interface LayoutCellData {
|
|
2764
2759
|
/** Size of the cell in 12 columns grid. */
|
|
2765
2760
|
colSpan?: number | null;
|
|
2766
2761
|
}
|
|
2767
|
-
|
|
2762
|
+
interface Metadata {
|
|
2768
2763
|
/** Schema version. */
|
|
2769
2764
|
version?: number;
|
|
2770
2765
|
/**
|
|
@@ -2781,7 +2776,7 @@ export interface Metadata {
|
|
|
2781
2776
|
/** Object ID. */
|
|
2782
2777
|
_id?: string | null;
|
|
2783
2778
|
}
|
|
2784
|
-
|
|
2779
|
+
interface DocumentStyle {
|
|
2785
2780
|
/** Styling for H1 nodes. */
|
|
2786
2781
|
headerOne?: TextNodeStyle;
|
|
2787
2782
|
/** Styling for H2 nodes. */
|
|
@@ -2801,7 +2796,7 @@ export interface DocumentStyle {
|
|
|
2801
2796
|
/** Styling for code block nodes. */
|
|
2802
2797
|
codeBlock?: TextNodeStyle;
|
|
2803
2798
|
}
|
|
2804
|
-
|
|
2799
|
+
interface TextNodeStyle {
|
|
2805
2800
|
/** The decorations to apply to the node. */
|
|
2806
2801
|
decorations?: Decoration[];
|
|
2807
2802
|
/** Padding and background color for the node. */
|
|
@@ -2809,7 +2804,7 @@ export interface TextNodeStyle {
|
|
|
2809
2804
|
/** Line height for text in the node. */
|
|
2810
2805
|
lineHeight?: string | null;
|
|
2811
2806
|
}
|
|
2812
|
-
|
|
2807
|
+
interface Badge {
|
|
2813
2808
|
/** Badge type. */
|
|
2814
2809
|
type?: TypeWithLiterals;
|
|
2815
2810
|
/**
|
|
@@ -2818,7 +2813,7 @@ export interface Badge {
|
|
|
2818
2813
|
*/
|
|
2819
2814
|
text?: string | null;
|
|
2820
2815
|
}
|
|
2821
|
-
|
|
2816
|
+
declare enum Type {
|
|
2822
2817
|
/** Unknown badge type. */
|
|
2823
2818
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2824
2819
|
/** 1st priority badge type. */
|
|
@@ -2829,9 +2824,9 @@ export declare enum Type {
|
|
|
2829
2824
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2830
2825
|
}
|
|
2831
2826
|
/** @enumType */
|
|
2832
|
-
|
|
2827
|
+
type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2833
2828
|
/** Triggered when an order is confirmed. */
|
|
2834
|
-
|
|
2829
|
+
interface OrderConfirmed {
|
|
2835
2830
|
/** Date and time the order was confirmed. */
|
|
2836
2831
|
timestamp?: Date | null;
|
|
2837
2832
|
/**
|
|
@@ -2884,14 +2879,14 @@ export interface OrderConfirmed {
|
|
|
2884
2879
|
/** Reservation ID associated with the order. */
|
|
2885
2880
|
reservationId?: string;
|
|
2886
2881
|
}
|
|
2887
|
-
|
|
2882
|
+
interface FormResponse {
|
|
2888
2883
|
/**
|
|
2889
2884
|
* Input values entered when filling the form.
|
|
2890
2885
|
* @maxSize 200
|
|
2891
2886
|
*/
|
|
2892
2887
|
inputValues?: InputValue[];
|
|
2893
2888
|
}
|
|
2894
|
-
|
|
2889
|
+
interface InputValue {
|
|
2895
2890
|
/**
|
|
2896
2891
|
* Input field name.
|
|
2897
2892
|
* @maxLength 100
|
|
@@ -2909,7 +2904,7 @@ export interface InputValue {
|
|
|
2909
2904
|
*/
|
|
2910
2905
|
values?: string[];
|
|
2911
2906
|
}
|
|
2912
|
-
|
|
2907
|
+
interface FormattedAddress {
|
|
2913
2908
|
/**
|
|
2914
2909
|
* One line address representation.
|
|
2915
2910
|
* @maxLength 200
|
|
@@ -2919,7 +2914,7 @@ export interface FormattedAddress {
|
|
|
2919
2914
|
address?: CommonAddress;
|
|
2920
2915
|
}
|
|
2921
2916
|
/** Physical address */
|
|
2922
|
-
|
|
2917
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
2923
2918
|
/** Street name and number. */
|
|
2924
2919
|
streetAddress?: CommonStreetAddress;
|
|
2925
2920
|
/** Main address line, usually street and number as free text. */
|
|
@@ -2939,39 +2934,39 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
2939
2934
|
addressLine2?: string | null;
|
|
2940
2935
|
}
|
|
2941
2936
|
/** @oneof */
|
|
2942
|
-
|
|
2937
|
+
interface CommonAddressStreetOneOf {
|
|
2943
2938
|
/** Street name and number. */
|
|
2944
2939
|
streetAddress?: CommonStreetAddress;
|
|
2945
2940
|
/** Main address line, usually street and number as free text. */
|
|
2946
2941
|
addressLine?: string | null;
|
|
2947
2942
|
}
|
|
2948
|
-
|
|
2943
|
+
interface CommonStreetAddress {
|
|
2949
2944
|
/** Street number. */
|
|
2950
2945
|
number?: string;
|
|
2951
2946
|
/** Street name. */
|
|
2952
2947
|
name?: string;
|
|
2953
2948
|
}
|
|
2954
|
-
|
|
2949
|
+
interface CommonAddressLocation {
|
|
2955
2950
|
/** Address latitude. */
|
|
2956
2951
|
latitude?: number | null;
|
|
2957
2952
|
/** Address longitude. */
|
|
2958
2953
|
longitude?: number | null;
|
|
2959
2954
|
}
|
|
2960
|
-
|
|
2955
|
+
interface CommonSubdivision {
|
|
2961
2956
|
/** Short subdivision code. */
|
|
2962
2957
|
code?: string;
|
|
2963
2958
|
/** Subdivision full name. */
|
|
2964
2959
|
name?: string;
|
|
2965
2960
|
}
|
|
2966
2961
|
/** Subdivision Concordance values */
|
|
2967
|
-
|
|
2962
|
+
interface StandardDetails {
|
|
2968
2963
|
/**
|
|
2969
2964
|
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
2970
2965
|
* @maxLength 20
|
|
2971
2966
|
*/
|
|
2972
2967
|
iso31662?: string | null;
|
|
2973
2968
|
}
|
|
2974
|
-
|
|
2969
|
+
declare enum OrderStatus {
|
|
2975
2970
|
/** Order status is not available for this request fieldset. */
|
|
2976
2971
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
2977
2972
|
/** Order is confirmed, no payment is required. */
|
|
@@ -2996,8 +2991,8 @@ export declare enum OrderStatus {
|
|
|
2996
2991
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
2997
2992
|
}
|
|
2998
2993
|
/** @enumType */
|
|
2999
|
-
|
|
3000
|
-
|
|
2994
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
2995
|
+
interface Ticket {
|
|
3001
2996
|
/** Unique issued ticket number. */
|
|
3002
2997
|
ticketNumber?: string;
|
|
3003
2998
|
/**
|
|
@@ -3045,11 +3040,11 @@ export interface Ticket {
|
|
|
3045
3040
|
/** Whether ticket is canceled. */
|
|
3046
3041
|
canceled?: boolean | null;
|
|
3047
3042
|
}
|
|
3048
|
-
|
|
3043
|
+
interface CheckIn {
|
|
3049
3044
|
/** Time of check-in. */
|
|
3050
3045
|
created?: Date | null;
|
|
3051
3046
|
}
|
|
3052
|
-
|
|
3047
|
+
interface OnlineConferencingLogin {
|
|
3053
3048
|
/**
|
|
3054
3049
|
* Link URL to the online conference.
|
|
3055
3050
|
* @format WEB_URL
|
|
@@ -3062,7 +3057,7 @@ export interface OnlineConferencingLogin {
|
|
|
3062
3057
|
*/
|
|
3063
3058
|
password?: string | null;
|
|
3064
3059
|
}
|
|
3065
|
-
|
|
3060
|
+
interface Invoice {
|
|
3066
3061
|
items?: Item[];
|
|
3067
3062
|
/**
|
|
3068
3063
|
* Total cart amount.
|
|
@@ -3094,7 +3089,7 @@ export interface Invoice {
|
|
|
3094
3089
|
/** Invoice preview URL. Only returned if the order is paid. */
|
|
3095
3090
|
previewUrl?: string | null;
|
|
3096
3091
|
}
|
|
3097
|
-
|
|
3092
|
+
interface Item {
|
|
3098
3093
|
/**
|
|
3099
3094
|
* Unique line item ID.
|
|
3100
3095
|
* @format GUID
|
|
@@ -3122,7 +3117,7 @@ export interface Item {
|
|
|
3122
3117
|
*/
|
|
3123
3118
|
fees?: Fee[];
|
|
3124
3119
|
}
|
|
3125
|
-
|
|
3120
|
+
interface Discount {
|
|
3126
3121
|
/** Total discount amount. */
|
|
3127
3122
|
amount?: Money;
|
|
3128
3123
|
/** Total sum after the discount. */
|
|
@@ -3145,7 +3140,7 @@ export interface Discount {
|
|
|
3145
3140
|
/** Discount items. */
|
|
3146
3141
|
discounts?: DiscountItem[];
|
|
3147
3142
|
}
|
|
3148
|
-
|
|
3143
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
3149
3144
|
/** Coupon discount. */
|
|
3150
3145
|
coupon?: CouponDiscount;
|
|
3151
3146
|
/** Pricing plan discount. */
|
|
@@ -3154,13 +3149,13 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
3154
3149
|
amount?: Money;
|
|
3155
3150
|
}
|
|
3156
3151
|
/** @oneof */
|
|
3157
|
-
|
|
3152
|
+
interface DiscountItemDiscountOneOf {
|
|
3158
3153
|
/** Coupon discount. */
|
|
3159
3154
|
coupon?: CouponDiscount;
|
|
3160
3155
|
/** Pricing plan discount. */
|
|
3161
3156
|
paidPlan?: PaidPlanDiscount;
|
|
3162
3157
|
}
|
|
3163
|
-
|
|
3158
|
+
interface CouponDiscount {
|
|
3164
3159
|
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
3165
3160
|
name?: string;
|
|
3166
3161
|
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
@@ -3168,18 +3163,18 @@ export interface CouponDiscount {
|
|
|
3168
3163
|
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
3169
3164
|
couponId?: string;
|
|
3170
3165
|
}
|
|
3171
|
-
|
|
3166
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
3172
3167
|
/** Discount by percentage applied to tickets. */
|
|
3173
3168
|
percentDiscount?: PercentDiscount;
|
|
3174
3169
|
/** Name of pricing plan. */
|
|
3175
3170
|
name?: string;
|
|
3176
3171
|
}
|
|
3177
3172
|
/** @oneof */
|
|
3178
|
-
|
|
3173
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
3179
3174
|
/** Discount by percentage applied to tickets. */
|
|
3180
3175
|
percentDiscount?: PercentDiscount;
|
|
3181
3176
|
}
|
|
3182
|
-
|
|
3177
|
+
interface PercentDiscount {
|
|
3183
3178
|
/**
|
|
3184
3179
|
* Percent rate.
|
|
3185
3180
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -3188,7 +3183,7 @@ export interface PercentDiscount {
|
|
|
3188
3183
|
/** Number of discounted tickets. */
|
|
3189
3184
|
quantityDiscounted?: number;
|
|
3190
3185
|
}
|
|
3191
|
-
|
|
3186
|
+
interface Tax {
|
|
3192
3187
|
/** Tax type. */
|
|
3193
3188
|
type?: TaxTypeWithLiterals;
|
|
3194
3189
|
/**
|
|
@@ -3206,7 +3201,7 @@ export interface Tax {
|
|
|
3206
3201
|
/** Total tax amount. */
|
|
3207
3202
|
amount?: Money;
|
|
3208
3203
|
}
|
|
3209
|
-
|
|
3204
|
+
interface Fee {
|
|
3210
3205
|
/** Fee identifier. */
|
|
3211
3206
|
name?: FeeNameWithLiterals;
|
|
3212
3207
|
/** How fee is calculated. */
|
|
@@ -3220,13 +3215,13 @@ export interface Fee {
|
|
|
3220
3215
|
/** Total amount of fee charges. */
|
|
3221
3216
|
amount?: Money;
|
|
3222
3217
|
}
|
|
3223
|
-
|
|
3218
|
+
declare enum FeeName {
|
|
3224
3219
|
/** Wix ticket service fee charges applied to the line item. */
|
|
3225
3220
|
WIX_FEE = "WIX_FEE"
|
|
3226
3221
|
}
|
|
3227
3222
|
/** @enumType */
|
|
3228
|
-
|
|
3229
|
-
|
|
3223
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
3224
|
+
declare enum FeeType {
|
|
3230
3225
|
/** Fee is added to the ticket price at checkout. */
|
|
3231
3226
|
FEE_ADDED = "FEE_ADDED",
|
|
3232
3227
|
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
@@ -3235,9 +3230,9 @@ export declare enum FeeType {
|
|
|
3235
3230
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3236
3231
|
}
|
|
3237
3232
|
/** @enumType */
|
|
3238
|
-
|
|
3233
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
3239
3234
|
/** Produced if a buyer email was added to the existing order */
|
|
3240
|
-
|
|
3235
|
+
interface OrderEmailAdded {
|
|
3241
3236
|
/** Order updated timestamp in ISO UTC format. */
|
|
3242
3237
|
timestamp?: Date | null;
|
|
3243
3238
|
/**
|
|
@@ -3321,7 +3316,7 @@ export interface OrderEmailAdded {
|
|
|
3321
3316
|
*/
|
|
3322
3317
|
reservationId?: string;
|
|
3323
3318
|
}
|
|
3324
|
-
|
|
3319
|
+
interface EventCanceled {
|
|
3325
3320
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3326
3321
|
timestamp?: Date | null;
|
|
3327
3322
|
/**
|
|
@@ -3339,7 +3334,7 @@ export interface EventCanceled {
|
|
|
3339
3334
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3340
3335
|
hasGuests?: boolean | null;
|
|
3341
3336
|
}
|
|
3342
|
-
|
|
3337
|
+
interface EventReminder {
|
|
3343
3338
|
/** Reminder timestamp in ISO UTC format. */
|
|
3344
3339
|
timestamp?: Date | null;
|
|
3345
3340
|
/**
|
|
@@ -3367,7 +3362,7 @@ export interface EventReminder {
|
|
|
3367
3362
|
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
3368
3363
|
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
3369
3364
|
*/
|
|
3370
|
-
|
|
3365
|
+
interface TimeDuration {
|
|
3371
3366
|
/** Number of days. */
|
|
3372
3367
|
days?: number;
|
|
3373
3368
|
/**
|
|
@@ -3382,7 +3377,7 @@ export interface TimeDuration {
|
|
|
3382
3377
|
minutes?: number;
|
|
3383
3378
|
}
|
|
3384
3379
|
/** Triggered when an order is paid. */
|
|
3385
|
-
|
|
3380
|
+
interface OrderPaid {
|
|
3386
3381
|
/** Date and time the order was paid. */
|
|
3387
3382
|
timestamp?: Date | null;
|
|
3388
3383
|
/**
|
|
@@ -3453,7 +3448,7 @@ export interface OrderPaid {
|
|
|
3453
3448
|
/** Invoice. */
|
|
3454
3449
|
invoice?: Invoice;
|
|
3455
3450
|
}
|
|
3456
|
-
|
|
3451
|
+
interface TicketPdfResolved {
|
|
3457
3452
|
/**
|
|
3458
3453
|
* Optional order number
|
|
3459
3454
|
* @maxLength 36
|
|
@@ -3477,7 +3472,7 @@ export interface TicketPdfResolved {
|
|
|
3477
3472
|
*/
|
|
3478
3473
|
documentId?: string | null;
|
|
3479
3474
|
}
|
|
3480
|
-
|
|
3475
|
+
interface TicketPdfResolveDelayed {
|
|
3481
3476
|
/**
|
|
3482
3477
|
* Optional order number
|
|
3483
3478
|
* @maxLength 36
|
|
@@ -3495,7 +3490,7 @@ export interface TicketPdfResolveDelayed {
|
|
|
3495
3490
|
documentId?: string | null;
|
|
3496
3491
|
}
|
|
3497
3492
|
/** Triggered when an order is canceled. */
|
|
3498
|
-
|
|
3493
|
+
interface OrderCanceled {
|
|
3499
3494
|
/**
|
|
3500
3495
|
* Event ID to which the order belongs.
|
|
3501
3496
|
* @format GUID
|
|
@@ -3536,7 +3531,7 @@ export interface OrderCanceled {
|
|
|
3536
3531
|
/** Invoice. */
|
|
3537
3532
|
invoice?: Invoice;
|
|
3538
3533
|
}
|
|
3539
|
-
|
|
3534
|
+
interface EventEnded {
|
|
3540
3535
|
/** Event end timestamp in ISO UTC format. */
|
|
3541
3536
|
timestamp?: Date | null;
|
|
3542
3537
|
/**
|
|
@@ -3547,7 +3542,7 @@ export interface EventEnded {
|
|
|
3547
3542
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3548
3543
|
hasGuests?: boolean | null;
|
|
3549
3544
|
}
|
|
3550
|
-
|
|
3545
|
+
interface EventStarted {
|
|
3551
3546
|
/** Event start timestamp in ISO UTC format. */
|
|
3552
3547
|
timestamp?: Date | null;
|
|
3553
3548
|
/**
|
|
@@ -3558,26 +3553,26 @@ export interface EventStarted {
|
|
|
3558
3553
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3559
3554
|
hasGuests?: boolean | null;
|
|
3560
3555
|
}
|
|
3561
|
-
|
|
3556
|
+
interface ResolveNotificationConfigRequest {
|
|
3562
3557
|
/**
|
|
3563
3558
|
* Id of the NotificationConfig to retrieve
|
|
3564
3559
|
* @format GUID
|
|
3565
3560
|
*/
|
|
3566
3561
|
notificationConfigId: string;
|
|
3567
3562
|
}
|
|
3568
|
-
|
|
3563
|
+
interface ResolveNotificationConfigResponse {
|
|
3569
3564
|
/** The retrieved NotificationConfig */
|
|
3570
3565
|
notificationConfig?: NotificationConfig;
|
|
3571
3566
|
}
|
|
3572
|
-
|
|
3567
|
+
interface UpsertNotificationConfigRequest {
|
|
3573
3568
|
/** NotificationConfig to be upserted */
|
|
3574
3569
|
notificationConfig: NotificationConfig;
|
|
3575
3570
|
}
|
|
3576
|
-
|
|
3571
|
+
interface UpsertNotificationConfigResponse {
|
|
3577
3572
|
/** The upserted NotificationConfig */
|
|
3578
3573
|
notificationConfig?: NotificationConfig;
|
|
3579
3574
|
}
|
|
3580
|
-
|
|
3575
|
+
interface ResolveEmailNotificationConfigRequest {
|
|
3581
3576
|
/**
|
|
3582
3577
|
* Id of the NotificationConfig to retrieve
|
|
3583
3578
|
* @format GUID
|
|
@@ -3586,11 +3581,11 @@ export interface ResolveEmailNotificationConfigRequest {
|
|
|
3586
3581
|
/** Notification type */
|
|
3587
3582
|
notificationType?: EmailNotificationTypeWithLiterals;
|
|
3588
3583
|
}
|
|
3589
|
-
|
|
3584
|
+
interface ResolveEmailNotificationConfigResponse {
|
|
3590
3585
|
/** The retrieved EmailNotificationConfig */
|
|
3591
3586
|
emailNotificationConfig?: EmailNotificationConfig;
|
|
3592
3587
|
}
|
|
3593
|
-
|
|
3588
|
+
interface EventDeleted {
|
|
3594
3589
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3595
3590
|
timestamp?: Date | null;
|
|
3596
3591
|
/**
|
|
@@ -3606,7 +3601,7 @@ export interface EventDeleted {
|
|
|
3606
3601
|
*/
|
|
3607
3602
|
userId?: string | null;
|
|
3608
3603
|
}
|
|
3609
|
-
|
|
3604
|
+
interface EventCopied {
|
|
3610
3605
|
/** Event created timestamp in ISO UTC format. */
|
|
3611
3606
|
timestamp?: Date | null;
|
|
3612
3607
|
/**
|
|
@@ -3644,7 +3639,7 @@ export interface EventCopied {
|
|
|
3644
3639
|
*/
|
|
3645
3640
|
ticketDefinitions?: Record<string, string>;
|
|
3646
3641
|
}
|
|
3647
|
-
|
|
3642
|
+
interface MessageEnvelope {
|
|
3648
3643
|
/**
|
|
3649
3644
|
* App instance ID.
|
|
3650
3645
|
* @format GUID
|
|
@@ -3660,7 +3655,7 @@ export interface MessageEnvelope {
|
|
|
3660
3655
|
/** Stringify payload. */
|
|
3661
3656
|
data?: string;
|
|
3662
3657
|
}
|
|
3663
|
-
|
|
3658
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3664
3659
|
/**
|
|
3665
3660
|
* ID of a site visitor that has not logged in to the site.
|
|
3666
3661
|
* @format GUID
|
|
@@ -3685,7 +3680,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3685
3680
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3686
3681
|
}
|
|
3687
3682
|
/** @oneof */
|
|
3688
|
-
|
|
3683
|
+
interface IdentificationDataIdOneOf {
|
|
3689
3684
|
/**
|
|
3690
3685
|
* ID of a site visitor that has not logged in to the site.
|
|
3691
3686
|
* @format GUID
|
|
@@ -3707,7 +3702,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3707
3702
|
*/
|
|
3708
3703
|
appId?: string;
|
|
3709
3704
|
}
|
|
3710
|
-
|
|
3705
|
+
declare enum WebhookIdentityType {
|
|
3711
3706
|
UNKNOWN = "UNKNOWN",
|
|
3712
3707
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3713
3708
|
MEMBER = "MEMBER",
|
|
@@ -3715,8 +3710,8 @@ export declare enum WebhookIdentityType {
|
|
|
3715
3710
|
APP = "APP"
|
|
3716
3711
|
}
|
|
3717
3712
|
/** @enumType */
|
|
3718
|
-
|
|
3719
|
-
|
|
3713
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3714
|
+
interface BaseEventMetadata {
|
|
3720
3715
|
/**
|
|
3721
3716
|
* App instance ID.
|
|
3722
3717
|
* @format GUID
|
|
@@ -3730,7 +3725,7 @@ export interface BaseEventMetadata {
|
|
|
3730
3725
|
/** The identification type and identity data. */
|
|
3731
3726
|
identity?: IdentificationData;
|
|
3732
3727
|
}
|
|
3733
|
-
|
|
3728
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3734
3729
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3735
3730
|
_id?: string;
|
|
3736
3731
|
/**
|
|
@@ -3760,70 +3755,15 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
3760
3755
|
*/
|
|
3761
3756
|
entityEventSequence?: string | null;
|
|
3762
3757
|
}
|
|
3763
|
-
|
|
3758
|
+
interface NotificationConfigCreatedEnvelope {
|
|
3764
3759
|
entity: NotificationConfig;
|
|
3765
3760
|
metadata: EventMetadata;
|
|
3766
3761
|
}
|
|
3767
|
-
|
|
3768
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3769
|
-
* @permissionScope Manage Events - all permissions
|
|
3770
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3771
|
-
* @permissionScope Manage Events
|
|
3772
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3773
|
-
* @permissionScope Read Events
|
|
3774
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3775
|
-
* @permissionScope Manage Guest List
|
|
3776
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3777
|
-
* @permissionScope Manage Events
|
|
3778
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3779
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3780
|
-
* @webhook
|
|
3781
|
-
* @eventType wix.events.notifications.v2.notification_config_created
|
|
3782
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3783
|
-
* @slug created
|
|
3784
|
-
* @documentationMaturity preview
|
|
3785
|
-
*/
|
|
3786
|
-
export declare function onNotificationConfigCreated(handler: (event: NotificationConfigCreatedEnvelope) => void | Promise<void>): void;
|
|
3787
|
-
export interface NotificationConfigUpdatedEnvelope {
|
|
3762
|
+
interface NotificationConfigUpdatedEnvelope {
|
|
3788
3763
|
entity: NotificationConfig;
|
|
3789
3764
|
metadata: EventMetadata;
|
|
3790
3765
|
}
|
|
3791
|
-
|
|
3792
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3793
|
-
* @permissionScope Manage Events - all permissions
|
|
3794
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3795
|
-
* @permissionScope Manage Events
|
|
3796
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3797
|
-
* @permissionScope Read Events
|
|
3798
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3799
|
-
* @permissionScope Manage Guest List
|
|
3800
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3801
|
-
* @permissionScope Manage Events
|
|
3802
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3803
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3804
|
-
* @webhook
|
|
3805
|
-
* @eventType wix.events.notifications.v2.notification_config_updated
|
|
3806
|
-
* @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
|
|
3807
|
-
* @slug updated
|
|
3808
|
-
* @documentationMaturity preview
|
|
3809
|
-
*/
|
|
3810
|
-
export declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
|
|
3811
|
-
type NotificationConfigNonNullablePaths = `rsvpConfirmation.notificationType` | `rsvpConfirmation.reminderTime` | `newSpotsAvailable.notificationType` | `newSpotsAvailable.reminderTime` | `eventCancelation.notificationType` | `eventCancelation.reminderTime` | `upcomingEventReminder.notificationType` | `upcomingEventReminder.reminderTime` | `orderConfirmation.notificationType` | `orderConfirmation.reminderTime` | `ticketConfirmation.notificationType` | `ticketConfirmation.reminderTime` | `invoice.notificationType` | `invoice.reminderTime` | `orderConfirmationWithTicketsLink.notificationType` | `orderConfirmationWithTicketsLink.reminderTime`;
|
|
3812
|
-
/**
|
|
3813
|
-
* Triggers notification
|
|
3814
|
-
* @public
|
|
3815
|
-
* @documentationMaturity preview
|
|
3816
|
-
* @requiredField options
|
|
3817
|
-
* @requiredField options.guests
|
|
3818
|
-
* @requiredField options.notification
|
|
3819
|
-
* @permissionId WIX_EVENTS.MANAGE
|
|
3820
|
-
* @permissionScope Manage Events
|
|
3821
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3822
|
-
* @applicableIdentity APP
|
|
3823
|
-
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
3824
|
-
*/
|
|
3825
|
-
export declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
|
|
3826
|
-
export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3766
|
+
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3827
3767
|
/** Email notification type */
|
|
3828
3768
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3829
3769
|
/** Push notification type */
|
|
@@ -3838,14 +3778,14 @@ export interface TriggerNotificationOptions extends TriggerNotificationOptionsNo
|
|
|
3838
3778
|
ticketGuest?: TicketGuest;
|
|
3839
3779
|
}
|
|
3840
3780
|
/** @oneof */
|
|
3841
|
-
|
|
3781
|
+
interface TriggerNotificationOptionsNotificationOneOf {
|
|
3842
3782
|
/** Email notification type */
|
|
3843
3783
|
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
3844
3784
|
/** Push notification type */
|
|
3845
3785
|
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
3846
3786
|
}
|
|
3847
3787
|
/** @oneof */
|
|
3848
|
-
|
|
3788
|
+
interface TriggerNotificationOptionsGuestsOneOf {
|
|
3849
3789
|
/** Rsvp guest info */
|
|
3850
3790
|
rsvpGuest?: RsvpGuest;
|
|
3851
3791
|
/** Order guest info */
|
|
@@ -3855,52 +3795,7 @@ export interface TriggerNotificationOptionsGuestsOneOf {
|
|
|
3855
3795
|
/** Ticket guests info */
|
|
3856
3796
|
ticketGuest?: TicketGuest;
|
|
3857
3797
|
}
|
|
3858
|
-
|
|
3859
|
-
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
3860
|
-
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
3861
|
-
* @public
|
|
3862
|
-
* @documentationMaturity preview
|
|
3863
|
-
* @requiredField notificationConfigId
|
|
3864
|
-
* @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
|
|
3865
|
-
* @permissionScope Read Events - all read permissions
|
|
3866
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3867
|
-
* @permissionScope Manage Events - all permissions
|
|
3868
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3869
|
-
* @permissionScope Manage Events
|
|
3870
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3871
|
-
* @permissionScope Read Events
|
|
3872
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3873
|
-
* @permissionScope Manage Guest List
|
|
3874
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3875
|
-
* @permissionScope Manage Events
|
|
3876
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3877
|
-
* @applicableIdentity APP
|
|
3878
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.ResolveNotificationConfig
|
|
3879
|
-
*/
|
|
3880
|
-
export declare function resolveNotificationConfig(notificationConfigId: string): Promise<NonNullablePaths<ResolveNotificationConfigResponse, {
|
|
3881
|
-
[P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
|
|
3882
|
-
}[NotificationConfigNonNullablePaths]>>;
|
|
3883
|
-
/**
|
|
3884
|
-
* Upsert a NotificationConfig
|
|
3885
|
-
* @param _id - Event ID.
|
|
3886
|
-
* @public
|
|
3887
|
-
* @documentationMaturity preview
|
|
3888
|
-
* @requiredField _id
|
|
3889
|
-
* @requiredField notificationConfig
|
|
3890
|
-
* @permissionId WIX_EVENTS.UPDATE_NOTIFICATION_CONFIG
|
|
3891
|
-
* @permissionScope Manage Events - all permissions
|
|
3892
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3893
|
-
* @permissionScope Manage Events
|
|
3894
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3895
|
-
* @permissionScope Manage Events
|
|
3896
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3897
|
-
* @applicableIdentity APP
|
|
3898
|
-
* @fqn wix.events.notifications.v2.NotificationConfigManagement.UpsertNotificationConfig
|
|
3899
|
-
*/
|
|
3900
|
-
export declare function upsertNotificationConfig(_id: string, notificationConfig: UpsertNotificationConfig): Promise<NonNullablePaths<UpsertNotificationConfigResponse, {
|
|
3901
|
-
[P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
|
|
3902
|
-
}[NotificationConfigNonNullablePaths]>>;
|
|
3903
|
-
export interface UpsertNotificationConfig {
|
|
3798
|
+
interface UpsertNotificationConfig {
|
|
3904
3799
|
/**
|
|
3905
3800
|
* Event ID.
|
|
3906
3801
|
* @format GUID
|
|
@@ -3939,4 +3834,5 @@ export interface UpsertNotificationConfig {
|
|
|
3939
3834
|
/** Order confirmation with tickets link. */
|
|
3940
3835
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
3941
3836
|
}
|
|
3942
|
-
|
|
3837
|
+
|
|
3838
|
+
export { OrderStatus as $, Alignment as A, ButtonDataType as B, ConferenceType as C, PollLayoutDirection as D, EmailNotificationType as E, BackgroundType as F, GIFType as G, DecorationType as H, InputControlType as I, FontType as J, AppType as K, LocationType as L, MapType as M, type NotificationConfigCreatedEnvelope as N, Orientation as O, PushNotificationType as P, InitialExpandedItems as Q, type ResolveNotificationConfigResponse as R, SubdivisionType as S, type TriggerNotificationOptions as T, type UpsertNotificationConfig as U, VisitorType as V, WidthType as W, Direction as X, VerticalAlignment as Y, NullValue as Z, Type as _, type UpsertNotificationConfigResponse as a, type RsvpSummary as a$, FeeName as a0, FeeType as a1, WebhookIdentityType as a2, type NotificationConfig as a3, type EmailNotificationConfig as a4, type EmailTemplate as a5, type Link as a6, type TriggerNotificationRequest as a7, type TriggerNotificationRequestNotificationOneOf as a8, type TriggerNotificationRequestGuestsOneOf as a9, type Registration as aA, type RsvpCollection as aB, type RsvpCollectionConfig as aC, type Ticketing as aD, type TicketingConfig as aE, type TaxConfig as aF, type Money as aG, type ExternalEvent as aH, type CalendarLinks as aI, type SiteUrl as aJ, type Form as aK, type InputControl as aL, type Input as aM, type OptionSelection as aN, type OptionSelectionSelectedOptionOneOf as aO, type Label as aP, type FormMessages as aQ, type RsvpFormMessages as aR, type PositiveResponseConfirmation as aS, type NegativeResponseConfirmation as aT, type Positive as aU, type Negative as aV, type CheckoutFormMessages as aW, type ResponseConfirmation as aX, type RegistrationClosedMessages as aY, type TicketsUnavailableMessages as aZ, type Dashboard as a_, type RsvpGuest as aa, type OrderGuest as ab, type EventGuests as ac, type TicketGuest as ad, type TriggerNotificationResponse as ae, type DomainEvent as af, type DomainEventBodyOneOf as ag, type EntityCreatedEvent as ah, type RestoreInfo as ai, type EntityUpdatedEvent as aj, type EntityDeletedEvent as ak, type ActionEvent as al, type Empty as am, type EventUpdated as an, type Location as ao, type MapCoordinates as ap, type Address as aq, type AddressStreetOneOf as ar, type StreetAddress as as, type AddressLocation as at, type Subdivision as au, type ScheduleConfig as av, type Recurrences as aw, type Occurrence as ax, type Event as ay, type Scheduling as az, type NotificationConfigUpdatedEnvelope as b, type Permissions as b$, type TicketingSummary as b0, type GuestListConfig as b1, type Feed as b2, type OnlineConferencing as b3, type OnlineConferencingConfig as b4, type OnlineConferencingSession as b5, type SeoSettings as b6, type SeoSchema as b7, type Keyword as b8, type Tag as b9, type FileSource as bA, type FileSourceDataOneOf as bB, type PDFSettings as bC, type GalleryData as bD, type Media as bE, type Image as bF, type Video as bG, type GalleryDataItem as bH, type GalleryDataItemDataOneOf as bI, type GalleryOptions as bJ, type Layout as bK, type ItemStyle as bL, type Thumbnails as bM, type GIFData as bN, type GIF as bO, type HeadingData as bP, type HTMLData as bQ, type HTMLDataDataOneOf as bR, type ImageData as bS, type StylesBorder as bT, type ImageDataStyles as bU, type LinkPreviewData as bV, type LinkPreviewDataStyles as bW, type MapData as bX, type MapSettings as bY, type ParagraphData as bZ, type PollData as b_, type Settings as ba, type Agenda as bb, type Category as bc, type CategoryCounts as bd, type EventDisplaySettings as be, type LabellingSettings as bf, type RichContent as bg, type Node as bh, type NodeDataOneOf as bi, type NodeStyle as bj, type ButtonData as bk, type Border as bl, type Colors as bm, type PluginContainerData as bn, type PluginContainerDataWidth as bo, type PluginContainerDataWidthDataOneOf as bp, type Spoiler as bq, type Height as br, type Styles as bs, type V1Link as bt, type V1LinkDataOneOf as bu, type Rel as bv, type CodeBlockData as bw, type TextStyle as bx, type DividerData as by, type FileData as bz, EmailNotificationReminderTime as c, type DiscountItemDiscountOneOf as c$, type Option as c0, type PollSettings as c1, type PollLayout as c2, type OptionLayout as c3, type Gradient as c4, type Background as c5, type BackgroundBackgroundOneOf as c6, type PollDesign as c7, type OptionDesign as c8, type Poll as c9, type AudioData as cA, type OrderedListData as cB, type BulletedListData as cC, type BlockquoteData as cD, type CaptionData as cE, type LayoutCellData as cF, type Metadata as cG, type DocumentStyle as cH, type TextNodeStyle as cI, type Badge as cJ, type OrderConfirmed as cK, type FormResponse as cL, type InputValue as cM, type FormattedAddress as cN, type CommonAddress as cO, type CommonAddressStreetOneOf as cP, type CommonStreetAddress as cQ, type CommonAddressLocation as cR, type CommonSubdivision as cS, type StandardDetails as cT, type Ticket as cU, type CheckIn as cV, type OnlineConferencingLogin as cW, type Invoice as cX, type Item as cY, type Discount as cZ, type DiscountItem as c_, type PollDataLayout as ca, type Design as cb, type TextData as cc, type Decoration as cd, type DecorationDataOneOf as ce, type AnchorData as cf, type ColorData as cg, type LinkData as ch, type MentionData as ci, type FontSizeData as cj, type SpoilerData as ck, type AppEmbedData as cl, type AppEmbedDataAppDataOneOf as cm, type BookingData as cn, type EventData as co, type VideoData as cp, type PlaybackOptions as cq, type EmbedData as cr, type Oembed as cs, type CollapsibleListData as ct, type TableData as cu, type Dimensions as cv, type TableCellData as cw, type CellStyle as cx, type BorderColors as cy, type ListValue as cz, Status as d, type CouponDiscount as d0, type PaidPlanDiscount as d1, type PaidPlanDiscountDiscountOneOf as d2, type PercentDiscount as d3, type Tax as d4, type Fee as d5, type OrderEmailAdded as d6, type EventCanceled as d7, type EventReminder as d8, type TimeDuration as d9, type OrderPaid as da, type TicketPdfResolved as db, type TicketPdfResolveDelayed as dc, type OrderCanceled as dd, type EventEnded as de, type EventStarted as df, type ResolveNotificationConfigRequest as dg, type UpsertNotificationConfigRequest as dh, type ResolveEmailNotificationConfigRequest as di, type ResolveEmailNotificationConfigResponse as dj, type EventDeleted as dk, type EventCopied as dl, type MessageEnvelope as dm, type IdentificationData as dn, type IdentificationDataIdOneOf as dp, type BaseEventMetadata as dq, type EventMetadata as dr, type TriggerNotificationOptionsNotificationOneOf as ds, type TriggerNotificationOptionsGuestsOneOf as dt, EventStatus as e, EventType as f, RegistrationStatus as g, RsvpStatusOptions as h, TaxType as i, ValueType as j, State as k, NodeType as l, PluginContainerDataAlignment as m, Target as n, TextAlignment as o, LineStyle as p, Width as q, ViewMode as r, LayoutType as s, Crop as t, ThumbnailsAlignment as u, Source as v, Position as w, ViewRole as x, VoteRole as y, PollLayoutType as z };
|