@wix/auto_sdk_events_notifications 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +578 -134
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +609 -138
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +578 -134
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +609 -138
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +578 -134
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +609 -138
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +578 -134
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +609 -138
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
export interface NotificationConfig {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Event ID.
|
|
4
|
+
* @format GUID
|
|
5
|
+
* @immutable
|
|
6
|
+
*/
|
|
3
7
|
id?: string | null;
|
|
4
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
|
|
10
|
+
* @immutable
|
|
11
|
+
*/
|
|
5
12
|
revision?: string | null;
|
|
6
13
|
/**
|
|
7
14
|
* Represents the time this NotificationConfig was created.
|
|
@@ -65,9 +72,17 @@ export declare enum EmailNotificationType {
|
|
|
65
72
|
EMAIL_INVOICE = "EMAIL_INVOICE"
|
|
66
73
|
}
|
|
67
74
|
export interface EmailTemplate {
|
|
68
|
-
/**
|
|
75
|
+
/**
|
|
76
|
+
* Email subject.
|
|
77
|
+
* @minLength 1
|
|
78
|
+
* @maxLength 100
|
|
79
|
+
*/
|
|
69
80
|
subject?: string | null;
|
|
70
|
-
/**
|
|
81
|
+
/**
|
|
82
|
+
* Plain text message body.
|
|
83
|
+
* @minLength 1
|
|
84
|
+
* @maxLength 1000
|
|
85
|
+
*/
|
|
71
86
|
body?: string | null;
|
|
72
87
|
/** Description link visibility and display text */
|
|
73
88
|
descriptionLink?: Link;
|
|
@@ -81,7 +96,10 @@ export interface EmailTemplate {
|
|
|
81
96
|
export interface Link {
|
|
82
97
|
/** When true the link is added to the email. */
|
|
83
98
|
display?: boolean | null;
|
|
84
|
-
/**
|
|
99
|
+
/**
|
|
100
|
+
* Text of the link.
|
|
101
|
+
* @maxLength 60
|
|
102
|
+
*/
|
|
85
103
|
linkText?: string | null;
|
|
86
104
|
}
|
|
87
105
|
export declare enum EmailNotificationReminderTime {
|
|
@@ -146,30 +164,56 @@ export declare enum PushNotificationType {
|
|
|
146
164
|
}
|
|
147
165
|
/** Single guest associated to the RSVP */
|
|
148
166
|
export interface RsvpGuest {
|
|
149
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* Event id
|
|
169
|
+
* @format GUID
|
|
170
|
+
*/
|
|
150
171
|
eventId?: string;
|
|
151
|
-
/**
|
|
172
|
+
/**
|
|
173
|
+
* Rsvp id
|
|
174
|
+
* @format GUID
|
|
175
|
+
*/
|
|
152
176
|
rsvpId?: string;
|
|
153
177
|
}
|
|
154
178
|
/** Single guest associated to the Order */
|
|
155
179
|
export interface OrderGuest {
|
|
156
|
-
/**
|
|
180
|
+
/**
|
|
181
|
+
* Event id
|
|
182
|
+
* @format GUID
|
|
183
|
+
*/
|
|
157
184
|
eventId?: string;
|
|
158
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Order number
|
|
187
|
+
* @maxLength 36
|
|
188
|
+
*/
|
|
159
189
|
orderNumber?: string;
|
|
160
190
|
}
|
|
161
191
|
/** All event guest from RSVPs and Orders */
|
|
162
192
|
export interface EventGuests {
|
|
163
|
-
/**
|
|
193
|
+
/**
|
|
194
|
+
* Event id
|
|
195
|
+
* @format GUID
|
|
196
|
+
*/
|
|
164
197
|
eventId?: string;
|
|
165
198
|
}
|
|
166
199
|
/** Multiple guests associated to Tickets */
|
|
167
200
|
export interface TicketGuest {
|
|
168
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Event id
|
|
203
|
+
* @format GUID
|
|
204
|
+
*/
|
|
169
205
|
eventId?: string;
|
|
170
|
-
/**
|
|
206
|
+
/**
|
|
207
|
+
* Order number
|
|
208
|
+
* @maxLength 36
|
|
209
|
+
*/
|
|
171
210
|
orderNumber?: string | null;
|
|
172
|
-
/**
|
|
211
|
+
/**
|
|
212
|
+
* Ticket numbers must be from the same order only.
|
|
213
|
+
* @minSize 1
|
|
214
|
+
* @maxSize 100
|
|
215
|
+
* @maxLength 36
|
|
216
|
+
*/
|
|
173
217
|
ticketNumber?: string[];
|
|
174
218
|
}
|
|
175
219
|
export interface TriggerNotificationResponse {
|
|
@@ -251,7 +295,10 @@ export interface Empty {
|
|
|
251
295
|
export interface EventUpdated {
|
|
252
296
|
/** Event update timestamp in ISO UTC format. */
|
|
253
297
|
timestamp?: Date | null;
|
|
254
|
-
/**
|
|
298
|
+
/**
|
|
299
|
+
* Event ID.
|
|
300
|
+
* @format GUID
|
|
301
|
+
*/
|
|
255
302
|
eventId?: string;
|
|
256
303
|
/** Event location. */
|
|
257
304
|
location?: Location;
|
|
@@ -268,11 +315,17 @@ export interface EventUpdated {
|
|
|
268
315
|
event?: Event;
|
|
269
316
|
}
|
|
270
317
|
export interface Location {
|
|
271
|
-
/**
|
|
318
|
+
/**
|
|
319
|
+
* Location name.
|
|
320
|
+
* @maxLength 50
|
|
321
|
+
*/
|
|
272
322
|
name?: string | null;
|
|
273
323
|
/** Location map coordinates. */
|
|
274
324
|
coordinates?: MapCoordinates;
|
|
275
|
-
/**
|
|
325
|
+
/**
|
|
326
|
+
* Single line address representation.
|
|
327
|
+
* @maxLength 300
|
|
328
|
+
*/
|
|
276
329
|
address?: string | null;
|
|
277
330
|
/** Location type. */
|
|
278
331
|
type?: LocationType;
|
|
@@ -294,9 +347,17 @@ export interface Location {
|
|
|
294
347
|
tbd?: boolean | null;
|
|
295
348
|
}
|
|
296
349
|
export interface MapCoordinates {
|
|
297
|
-
/**
|
|
350
|
+
/**
|
|
351
|
+
* Latitude.
|
|
352
|
+
* @min -90
|
|
353
|
+
* @max 90
|
|
354
|
+
*/
|
|
298
355
|
lat?: number;
|
|
299
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* Longitude.
|
|
358
|
+
* @min -180
|
|
359
|
+
* @max 180
|
|
360
|
+
*/
|
|
300
361
|
lng?: number;
|
|
301
362
|
}
|
|
302
363
|
export declare enum LocationType {
|
|
@@ -309,7 +370,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
309
370
|
streetAddress?: StreetAddress;
|
|
310
371
|
/** Main address line (usually street and number) as free text */
|
|
311
372
|
addressLine?: string | null;
|
|
312
|
-
/**
|
|
373
|
+
/**
|
|
374
|
+
* country code
|
|
375
|
+
* @format COUNTRY
|
|
376
|
+
*/
|
|
313
377
|
country?: string | null;
|
|
314
378
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
315
379
|
subdivision?: string | null;
|
|
@@ -327,7 +391,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
327
391
|
geocode?: AddressLocation;
|
|
328
392
|
/** country full-name */
|
|
329
393
|
countryFullname?: string | null;
|
|
330
|
-
/**
|
|
394
|
+
/**
|
|
395
|
+
* multi-level subdivisions from top to bottom
|
|
396
|
+
* @maxSize 6
|
|
397
|
+
*/
|
|
331
398
|
subdivisions?: Subdivision[];
|
|
332
399
|
}
|
|
333
400
|
/** @oneof */
|
|
@@ -344,9 +411,17 @@ export interface StreetAddress {
|
|
|
344
411
|
name?: string;
|
|
345
412
|
}
|
|
346
413
|
export interface AddressLocation {
|
|
347
|
-
/**
|
|
414
|
+
/**
|
|
415
|
+
* address latitude coordinates
|
|
416
|
+
* @min -90
|
|
417
|
+
* @max 90
|
|
418
|
+
*/
|
|
348
419
|
latitude?: number | null;
|
|
349
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* address longitude coordinates
|
|
422
|
+
* @min -180
|
|
423
|
+
* @max 180
|
|
424
|
+
*/
|
|
350
425
|
longitude?: number | null;
|
|
351
426
|
}
|
|
352
427
|
export interface Subdivision {
|
|
@@ -377,13 +452,19 @@ export interface ScheduleConfig {
|
|
|
377
452
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
378
453
|
*/
|
|
379
454
|
scheduleTbd?: boolean;
|
|
380
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* TBD message.
|
|
457
|
+
* @maxLength 100
|
|
458
|
+
*/
|
|
381
459
|
scheduleTbdMessage?: string | null;
|
|
382
460
|
/** Event start timestamp. */
|
|
383
461
|
startDate?: Date | null;
|
|
384
462
|
/** Event end timestamp. */
|
|
385
463
|
endDate?: Date | null;
|
|
386
|
-
/**
|
|
464
|
+
/**
|
|
465
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
466
|
+
* @maxLength 100
|
|
467
|
+
*/
|
|
387
468
|
timeZoneId?: string | null;
|
|
388
469
|
/** Whether end date is hidden in the formatted schedule. */
|
|
389
470
|
endDateHidden?: boolean;
|
|
@@ -393,7 +474,10 @@ export interface ScheduleConfig {
|
|
|
393
474
|
recurrences?: Recurrences;
|
|
394
475
|
}
|
|
395
476
|
export interface Recurrences {
|
|
396
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Event occurrences.
|
|
479
|
+
* @maxSize 1000
|
|
480
|
+
*/
|
|
397
481
|
occurrences?: Occurrence[];
|
|
398
482
|
/**
|
|
399
483
|
* Recurring event category ID.
|
|
@@ -411,7 +495,10 @@ export interface Occurrence {
|
|
|
411
495
|
startDate?: Date | null;
|
|
412
496
|
/** Event end timestamp. */
|
|
413
497
|
endDate?: Date | null;
|
|
414
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
500
|
+
* @maxLength 100
|
|
501
|
+
*/
|
|
415
502
|
timeZoneId?: string | null;
|
|
416
503
|
/** Whether time zone is displayed in formatted schedule. */
|
|
417
504
|
showTimeZone?: boolean;
|
|
@@ -431,6 +518,7 @@ export declare enum Status {
|
|
|
431
518
|
export interface Event {
|
|
432
519
|
/**
|
|
433
520
|
* Event ID.
|
|
521
|
+
* @format GUID
|
|
434
522
|
* @readonly
|
|
435
523
|
*/
|
|
436
524
|
id?: string;
|
|
@@ -470,7 +558,10 @@ export interface Event {
|
|
|
470
558
|
instanceId?: string;
|
|
471
559
|
/** Guest list configuration. */
|
|
472
560
|
guestListConfig?: GuestListConfig;
|
|
473
|
-
/**
|
|
561
|
+
/**
|
|
562
|
+
* Event creator user ID.
|
|
563
|
+
* @maxLength 36
|
|
564
|
+
*/
|
|
474
565
|
userId?: string;
|
|
475
566
|
/** Event discussion feed. For internal use. */
|
|
476
567
|
feed?: Feed;
|
|
@@ -509,7 +600,11 @@ export interface Scheduling {
|
|
|
509
600
|
endTimeFormatted?: string;
|
|
510
601
|
}
|
|
511
602
|
export interface Image {
|
|
512
|
-
/**
|
|
603
|
+
/**
|
|
604
|
+
* WixMedia image ID.
|
|
605
|
+
* @minLength 1
|
|
606
|
+
* @maxLength 200
|
|
607
|
+
*/
|
|
513
608
|
id?: string | null;
|
|
514
609
|
/** Image URL. */
|
|
515
610
|
url?: string;
|
|
@@ -647,17 +742,31 @@ export interface TicketingConfig {
|
|
|
647
742
|
guestAssignedTickets?: boolean;
|
|
648
743
|
/** Tax configuration. */
|
|
649
744
|
taxConfig?: TaxConfig;
|
|
650
|
-
/**
|
|
745
|
+
/**
|
|
746
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
747
|
+
* @max 50
|
|
748
|
+
*/
|
|
651
749
|
ticketLimitPerOrder?: number;
|
|
652
|
-
/**
|
|
750
|
+
/**
|
|
751
|
+
* Duration for which the tickets being bought are reserved.
|
|
752
|
+
* @min 5
|
|
753
|
+
* @max 30
|
|
754
|
+
*/
|
|
653
755
|
reservationDurationInMinutes?: number | null;
|
|
654
756
|
}
|
|
655
757
|
export interface TaxConfig {
|
|
656
758
|
/** Tax application settings. */
|
|
657
759
|
type?: TaxType;
|
|
658
|
-
/**
|
|
760
|
+
/**
|
|
761
|
+
* Tax name.
|
|
762
|
+
* @minLength 1
|
|
763
|
+
* @maxLength 10
|
|
764
|
+
*/
|
|
659
765
|
name?: string | null;
|
|
660
|
-
/**
|
|
766
|
+
/**
|
|
767
|
+
* Tax rate (e.g.,`21.55`).
|
|
768
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
769
|
+
*/
|
|
661
770
|
rate?: string | null;
|
|
662
771
|
/** Applies taxes for donations, default true. */
|
|
663
772
|
appliesToDonations?: boolean | null;
|
|
@@ -673,12 +782,19 @@ export declare enum TaxType {
|
|
|
673
782
|
export interface Money {
|
|
674
783
|
/**
|
|
675
784
|
* *Deprecated:** Use `value` instead.
|
|
785
|
+
* @format DECIMAL_VALUE
|
|
676
786
|
* @deprecated
|
|
677
787
|
*/
|
|
678
788
|
amount?: string;
|
|
679
|
-
/**
|
|
789
|
+
/**
|
|
790
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
791
|
+
* @format CURRENCY
|
|
792
|
+
*/
|
|
680
793
|
currency?: string;
|
|
681
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
796
|
+
* @format DECIMAL_VALUE
|
|
797
|
+
*/
|
|
682
798
|
value?: string | null;
|
|
683
799
|
}
|
|
684
800
|
export interface ExternalEvent {
|
|
@@ -833,21 +949,29 @@ export declare enum ValueType {
|
|
|
833
949
|
* Defaults to first (0th) option if not configured.
|
|
834
950
|
*/
|
|
835
951
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
836
|
-
/**
|
|
952
|
+
/**
|
|
953
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
954
|
+
* @max 199
|
|
955
|
+
*/
|
|
837
956
|
optionIndex?: number;
|
|
838
957
|
/**
|
|
839
958
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
840
959
|
* Considered an empty choice.
|
|
960
|
+
* @maxLength 200
|
|
841
961
|
*/
|
|
842
962
|
placeholderText?: string;
|
|
843
963
|
}
|
|
844
964
|
/** @oneof */
|
|
845
965
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
846
|
-
/**
|
|
966
|
+
/**
|
|
967
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
968
|
+
* @max 199
|
|
969
|
+
*/
|
|
847
970
|
optionIndex?: number;
|
|
848
971
|
/**
|
|
849
972
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
850
973
|
* Considered an empty choice.
|
|
974
|
+
* @maxLength 200
|
|
851
975
|
*/
|
|
852
976
|
placeholderText?: string;
|
|
853
977
|
}
|
|
@@ -1002,7 +1126,10 @@ export interface OnlineConferencingConfig {
|
|
|
1002
1126
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1003
1127
|
*/
|
|
1004
1128
|
enabled?: boolean;
|
|
1005
|
-
/**
|
|
1129
|
+
/**
|
|
1130
|
+
* Conferencing provider ID.
|
|
1131
|
+
* @format GUID
|
|
1132
|
+
*/
|
|
1006
1133
|
providerId?: string | null;
|
|
1007
1134
|
/** Conference type */
|
|
1008
1135
|
conferenceType?: ConferenceType;
|
|
@@ -1041,7 +1168,10 @@ export interface OnlineConferencingSession {
|
|
|
1041
1168
|
sessionId?: string | null;
|
|
1042
1169
|
}
|
|
1043
1170
|
export interface SeoSettings {
|
|
1044
|
-
/**
|
|
1171
|
+
/**
|
|
1172
|
+
* URL slug
|
|
1173
|
+
* @maxLength 130
|
|
1174
|
+
*/
|
|
1045
1175
|
slug?: string;
|
|
1046
1176
|
/** Advanced SEO data */
|
|
1047
1177
|
advancedSeoData?: SeoSchema;
|
|
@@ -1067,7 +1197,10 @@ export interface Keyword {
|
|
|
1067
1197
|
term?: string;
|
|
1068
1198
|
/** Whether the keyword is the main focus keyword. */
|
|
1069
1199
|
isMain?: boolean;
|
|
1070
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1202
|
+
* @maxLength 1000
|
|
1203
|
+
*/
|
|
1071
1204
|
origin?: string | null;
|
|
1072
1205
|
}
|
|
1073
1206
|
export interface Tag {
|
|
@@ -1100,7 +1233,10 @@ export interface Settings {
|
|
|
1100
1233
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1101
1234
|
*/
|
|
1102
1235
|
preventAutoRedirect?: boolean;
|
|
1103
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* User-selected keyword terms for a specific page.
|
|
1238
|
+
* @maxSize 5
|
|
1239
|
+
*/
|
|
1104
1240
|
keywords?: Keyword[];
|
|
1105
1241
|
}
|
|
1106
1242
|
export interface Agenda {
|
|
@@ -1115,10 +1251,15 @@ export interface Agenda {
|
|
|
1115
1251
|
export interface Category {
|
|
1116
1252
|
/**
|
|
1117
1253
|
* Category ID.
|
|
1254
|
+
* @format GUID
|
|
1118
1255
|
* @readonly
|
|
1119
1256
|
*/
|
|
1120
1257
|
id?: string;
|
|
1121
|
-
/**
|
|
1258
|
+
/**
|
|
1259
|
+
* Category name.
|
|
1260
|
+
* @minLength 1
|
|
1261
|
+
* @maxLength 30
|
|
1262
|
+
*/
|
|
1122
1263
|
name?: string;
|
|
1123
1264
|
/**
|
|
1124
1265
|
* Date and time when category was created.
|
|
@@ -1141,6 +1282,7 @@ export interface Category {
|
|
|
1141
1282
|
* Default: `MANUAL`.
|
|
1142
1283
|
*
|
|
1143
1284
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1285
|
+
* @maxSize 3
|
|
1144
1286
|
*/
|
|
1145
1287
|
states?: State[];
|
|
1146
1288
|
}
|
|
@@ -1766,11 +1908,20 @@ export interface GIFData {
|
|
|
1766
1908
|
gifType?: GIFType;
|
|
1767
1909
|
}
|
|
1768
1910
|
export interface GIF {
|
|
1769
|
-
/**
|
|
1911
|
+
/**
|
|
1912
|
+
* GIF format URL.
|
|
1913
|
+
* @format WEB_URL
|
|
1914
|
+
*/
|
|
1770
1915
|
gif?: string | null;
|
|
1771
|
-
/**
|
|
1916
|
+
/**
|
|
1917
|
+
* MP4 format URL.
|
|
1918
|
+
* @format WEB_URL
|
|
1919
|
+
*/
|
|
1772
1920
|
mp4?: string | null;
|
|
1773
|
-
/**
|
|
1921
|
+
/**
|
|
1922
|
+
* Thumbnail URL.
|
|
1923
|
+
* @format WEB_URL
|
|
1924
|
+
*/
|
|
1774
1925
|
still?: string | null;
|
|
1775
1926
|
}
|
|
1776
1927
|
export declare enum GIFType {
|
|
@@ -1836,6 +1987,25 @@ export interface ImageData {
|
|
|
1836
1987
|
caption?: string | null;
|
|
1837
1988
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1838
1989
|
disableDownload?: boolean | null;
|
|
1990
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1991
|
+
decorative?: boolean | null;
|
|
1992
|
+
/** Styling for the image. */
|
|
1993
|
+
styles?: ImageDataStyles;
|
|
1994
|
+
}
|
|
1995
|
+
export interface StylesBorder {
|
|
1996
|
+
/** Border width in pixels. */
|
|
1997
|
+
width?: number | null;
|
|
1998
|
+
/**
|
|
1999
|
+
* Border color as a hexadecimal value.
|
|
2000
|
+
* @format COLOR_HEX
|
|
2001
|
+
*/
|
|
2002
|
+
color?: string | null;
|
|
2003
|
+
/** Border radius in pixels. */
|
|
2004
|
+
radius?: number | null;
|
|
2005
|
+
}
|
|
2006
|
+
export interface ImageDataStyles {
|
|
2007
|
+
/** Border attributes. */
|
|
2008
|
+
border?: StylesBorder;
|
|
1839
2009
|
}
|
|
1840
2010
|
export interface LinkPreviewData {
|
|
1841
2011
|
/** Styling for the link preview's container. */
|
|
@@ -1982,13 +2152,22 @@ export declare enum BackgroundType {
|
|
|
1982
2152
|
export interface Gradient {
|
|
1983
2153
|
/** The gradient angle in degrees. */
|
|
1984
2154
|
angle?: number | null;
|
|
1985
|
-
/**
|
|
2155
|
+
/**
|
|
2156
|
+
* The start color as a hexademical value.
|
|
2157
|
+
* @format COLOR_HEX
|
|
2158
|
+
*/
|
|
1986
2159
|
startColor?: string | null;
|
|
1987
|
-
/**
|
|
2160
|
+
/**
|
|
2161
|
+
* The end color as a hexademical value.
|
|
2162
|
+
* @format COLOR_HEX
|
|
2163
|
+
*/
|
|
1988
2164
|
lastColor?: string | null;
|
|
1989
2165
|
}
|
|
1990
2166
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1991
|
-
/**
|
|
2167
|
+
/**
|
|
2168
|
+
* The background color as a hexademical value.
|
|
2169
|
+
* @format COLOR_HEX
|
|
2170
|
+
*/
|
|
1992
2171
|
color?: string | null;
|
|
1993
2172
|
/** An image to use for the background. */
|
|
1994
2173
|
image?: Media;
|
|
@@ -1999,7 +2178,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1999
2178
|
}
|
|
2000
2179
|
/** @oneof */
|
|
2001
2180
|
export interface BackgroundBackgroundOneOf {
|
|
2002
|
-
/**
|
|
2181
|
+
/**
|
|
2182
|
+
* The background color as a hexademical value.
|
|
2183
|
+
* @format COLOR_HEX
|
|
2184
|
+
*/
|
|
2003
2185
|
color?: string | null;
|
|
2004
2186
|
/** An image to use for the background. */
|
|
2005
2187
|
image?: Media;
|
|
@@ -2311,17 +2493,32 @@ export declare enum VerticalAlignment {
|
|
|
2311
2493
|
export interface CellStyle {
|
|
2312
2494
|
/** Vertical alignment for the cell's text. */
|
|
2313
2495
|
verticalAlignment?: VerticalAlignment;
|
|
2314
|
-
/**
|
|
2496
|
+
/**
|
|
2497
|
+
* Cell background color as a hexadecimal value.
|
|
2498
|
+
* @format COLOR_HEX
|
|
2499
|
+
*/
|
|
2315
2500
|
backgroundColor?: string | null;
|
|
2316
2501
|
}
|
|
2317
2502
|
export interface BorderColors {
|
|
2318
|
-
/**
|
|
2503
|
+
/**
|
|
2504
|
+
* Left border color as a hexadecimal value.
|
|
2505
|
+
* @format COLOR_HEX
|
|
2506
|
+
*/
|
|
2319
2507
|
left?: string | null;
|
|
2320
|
-
/**
|
|
2508
|
+
/**
|
|
2509
|
+
* Right border color as a hexadecimal value.
|
|
2510
|
+
* @format COLOR_HEX
|
|
2511
|
+
*/
|
|
2321
2512
|
right?: string | null;
|
|
2322
|
-
/**
|
|
2513
|
+
/**
|
|
2514
|
+
* Top border color as a hexadecimal value.
|
|
2515
|
+
* @format COLOR_HEX
|
|
2516
|
+
*/
|
|
2323
2517
|
top?: string | null;
|
|
2324
|
-
/**
|
|
2518
|
+
/**
|
|
2519
|
+
* Bottom border color as a hexadecimal value.
|
|
2520
|
+
* @format COLOR_HEX
|
|
2521
|
+
*/
|
|
2325
2522
|
bottom?: string | null;
|
|
2326
2523
|
}
|
|
2327
2524
|
/**
|
|
@@ -2432,19 +2629,31 @@ export interface TextNodeStyle {
|
|
|
2432
2629
|
export interface OrderConfirmed {
|
|
2433
2630
|
/** Order confirmation timestamp in ISO UTC. */
|
|
2434
2631
|
timestamp?: Date | null;
|
|
2435
|
-
/**
|
|
2632
|
+
/**
|
|
2633
|
+
* Site language when Order initiated
|
|
2634
|
+
* @format LANGUAGE
|
|
2635
|
+
*/
|
|
2436
2636
|
language?: string | null;
|
|
2437
2637
|
/** Notifications silenced for this domain event. */
|
|
2438
2638
|
silent?: boolean | null;
|
|
2439
|
-
/**
|
|
2639
|
+
/**
|
|
2640
|
+
* Locale in which Order was created.
|
|
2641
|
+
* @format LANGUAGE_TAG
|
|
2642
|
+
*/
|
|
2440
2643
|
locale?: string | null;
|
|
2441
|
-
/**
|
|
2644
|
+
/**
|
|
2645
|
+
* Event ID.
|
|
2646
|
+
* @format GUID
|
|
2647
|
+
*/
|
|
2442
2648
|
eventId?: string;
|
|
2443
2649
|
/** Unique order number. */
|
|
2444
2650
|
orderNumber?: string;
|
|
2445
2651
|
/** Contact ID associated with this order. */
|
|
2446
2652
|
contactId?: string;
|
|
2447
|
-
/**
|
|
2653
|
+
/**
|
|
2654
|
+
* Member ID associated with this order.
|
|
2655
|
+
* @format GUID
|
|
2656
|
+
*/
|
|
2448
2657
|
memberId?: string | null;
|
|
2449
2658
|
/**
|
|
2450
2659
|
* Order created timestamp
|
|
@@ -2471,19 +2680,35 @@ export interface OrderConfirmed {
|
|
|
2471
2680
|
reservationId?: string;
|
|
2472
2681
|
}
|
|
2473
2682
|
export interface FormResponse {
|
|
2474
|
-
/**
|
|
2683
|
+
/**
|
|
2684
|
+
* Input values entered when filling the form.
|
|
2685
|
+
* @maxSize 200
|
|
2686
|
+
*/
|
|
2475
2687
|
inputValues?: InputValue[];
|
|
2476
2688
|
}
|
|
2477
2689
|
export interface InputValue {
|
|
2478
|
-
/**
|
|
2690
|
+
/**
|
|
2691
|
+
* Input field name.
|
|
2692
|
+
* @maxLength 100
|
|
2693
|
+
*/
|
|
2479
2694
|
inputName?: string;
|
|
2480
|
-
/**
|
|
2695
|
+
/**
|
|
2696
|
+
* Text entered into the input field.
|
|
2697
|
+
* @maxLength 5000
|
|
2698
|
+
*/
|
|
2481
2699
|
value?: string;
|
|
2482
|
-
/**
|
|
2700
|
+
/**
|
|
2701
|
+
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
2702
|
+
* @maxSize 100
|
|
2703
|
+
* @maxLength 5000
|
|
2704
|
+
*/
|
|
2483
2705
|
values?: string[];
|
|
2484
2706
|
}
|
|
2485
2707
|
export interface FormattedAddress {
|
|
2486
|
-
/**
|
|
2708
|
+
/**
|
|
2709
|
+
* One line address representation.
|
|
2710
|
+
* @maxLength 200
|
|
2711
|
+
*/
|
|
2487
2712
|
formatted?: string;
|
|
2488
2713
|
/** Address components (optional). */
|
|
2489
2714
|
address?: CommonAddress;
|
|
@@ -2494,7 +2719,10 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
2494
2719
|
streetAddress?: CommonStreetAddress;
|
|
2495
2720
|
/** Main address line, usually street and number as free text. */
|
|
2496
2721
|
addressLine?: string | null;
|
|
2497
|
-
/**
|
|
2722
|
+
/**
|
|
2723
|
+
* Country code.
|
|
2724
|
+
* @format COUNTRY
|
|
2725
|
+
*/
|
|
2498
2726
|
country?: string | null;
|
|
2499
2727
|
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
2500
2728
|
subdivision?: string | null;
|
|
@@ -2532,7 +2760,10 @@ export interface CommonSubdivision {
|
|
|
2532
2760
|
}
|
|
2533
2761
|
/** Subdivision Concordance values */
|
|
2534
2762
|
export interface StandardDetails {
|
|
2535
|
-
/**
|
|
2763
|
+
/**
|
|
2764
|
+
* 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
|
|
2765
|
+
* @maxLength 20
|
|
2766
|
+
*/
|
|
2536
2767
|
iso31662?: string | null;
|
|
2537
2768
|
}
|
|
2538
2769
|
export declare enum OrderStatus {
|
|
@@ -2562,7 +2793,10 @@ export declare enum OrderStatus {
|
|
|
2562
2793
|
export interface Ticket {
|
|
2563
2794
|
/** Unique issued ticket number. */
|
|
2564
2795
|
ticketNumber?: string;
|
|
2565
|
-
/**
|
|
2796
|
+
/**
|
|
2797
|
+
* Ticket definition ID.
|
|
2798
|
+
* @format GUID
|
|
2799
|
+
*/
|
|
2566
2800
|
ticketDefinitionId?: string;
|
|
2567
2801
|
/** Ticket check-in. */
|
|
2568
2802
|
checkIn?: CheckIn;
|
|
@@ -2576,11 +2810,17 @@ export interface Ticket {
|
|
|
2576
2810
|
lastName?: string | null;
|
|
2577
2811
|
/** Guest email. */
|
|
2578
2812
|
email?: string | null;
|
|
2579
|
-
/**
|
|
2813
|
+
/**
|
|
2814
|
+
* Contact ID associated with this ticket.
|
|
2815
|
+
* @format GUID
|
|
2816
|
+
*/
|
|
2580
2817
|
contactId?: string | null;
|
|
2581
2818
|
/** Whether ticket is confirmed */
|
|
2582
2819
|
confirmed?: boolean;
|
|
2583
|
-
/**
|
|
2820
|
+
/**
|
|
2821
|
+
* Member ID associated with this ticket.
|
|
2822
|
+
* @format GUID
|
|
2823
|
+
*/
|
|
2584
2824
|
memberId?: string | null;
|
|
2585
2825
|
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
2586
2826
|
form?: FormResponse;
|
|
@@ -2590,7 +2830,10 @@ export interface Ticket {
|
|
|
2590
2830
|
anonymized?: boolean;
|
|
2591
2831
|
/** URL and password to online conference */
|
|
2592
2832
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
2593
|
-
/**
|
|
2833
|
+
/**
|
|
2834
|
+
* Seat ID associated with this ticket.
|
|
2835
|
+
* @maxLength 36
|
|
2836
|
+
*/
|
|
2594
2837
|
seatId?: string | null;
|
|
2595
2838
|
/** Whether ticket is canceled. */
|
|
2596
2839
|
canceled?: boolean | null;
|
|
@@ -2602,6 +2845,7 @@ export interface CheckIn {
|
|
|
2602
2845
|
export interface OnlineConferencingLogin {
|
|
2603
2846
|
/**
|
|
2604
2847
|
* Link URL to the online conference.
|
|
2848
|
+
* @format WEB_URL
|
|
2605
2849
|
* @readonly
|
|
2606
2850
|
*/
|
|
2607
2851
|
link?: string;
|
|
@@ -2644,9 +2888,16 @@ export interface Invoice {
|
|
|
2644
2888
|
previewUrl?: string | null;
|
|
2645
2889
|
}
|
|
2646
2890
|
export interface Item {
|
|
2647
|
-
/**
|
|
2891
|
+
/**
|
|
2892
|
+
* Unique line item ID.
|
|
2893
|
+
* @format GUID
|
|
2894
|
+
*/
|
|
2648
2895
|
id?: string;
|
|
2649
|
-
/**
|
|
2896
|
+
/**
|
|
2897
|
+
* Line item quantity.
|
|
2898
|
+
* @min 1
|
|
2899
|
+
* @max 50
|
|
2900
|
+
*/
|
|
2650
2901
|
quantity?: number;
|
|
2651
2902
|
/** Line item name. */
|
|
2652
2903
|
name?: string;
|
|
@@ -2722,7 +2973,10 @@ export interface PaidPlanDiscountDiscountOneOf {
|
|
|
2722
2973
|
percentDiscount?: PercentDiscount;
|
|
2723
2974
|
}
|
|
2724
2975
|
export interface PercentDiscount {
|
|
2725
|
-
/**
|
|
2976
|
+
/**
|
|
2977
|
+
* Percent rate.
|
|
2978
|
+
* @decimalValue options - {gte:0.01,lte:100,maxScale:2}
|
|
2979
|
+
*/
|
|
2726
2980
|
rate?: string;
|
|
2727
2981
|
/** Number of discounted tickets. */
|
|
2728
2982
|
quantityDiscounted?: number;
|
|
@@ -2735,7 +2989,10 @@ export interface Tax {
|
|
|
2735
2989
|
* @readonly
|
|
2736
2990
|
*/
|
|
2737
2991
|
name?: string;
|
|
2738
|
-
/**
|
|
2992
|
+
/**
|
|
2993
|
+
* Tax rate.
|
|
2994
|
+
* @format DECIMAL_VALUE
|
|
2995
|
+
*/
|
|
2739
2996
|
rate?: string;
|
|
2740
2997
|
/** Taxable amount. */
|
|
2741
2998
|
taxable?: Money;
|
|
@@ -2749,6 +3006,7 @@ export interface Fee {
|
|
|
2749
3006
|
type?: FeeType;
|
|
2750
3007
|
/**
|
|
2751
3008
|
* Fee rate.
|
|
3009
|
+
* @format DECIMAL_VALUE
|
|
2752
3010
|
* @readonly
|
|
2753
3011
|
*/
|
|
2754
3012
|
rate?: string;
|
|
@@ -2771,19 +3029,37 @@ export declare enum FeeType {
|
|
|
2771
3029
|
export interface OrderEmailAdded {
|
|
2772
3030
|
/** Order updated timestamp in ISO UTC format. */
|
|
2773
3031
|
timestamp?: Date | null;
|
|
2774
|
-
/**
|
|
3032
|
+
/**
|
|
3033
|
+
* Site language when Order initiated
|
|
3034
|
+
* @format LANGUAGE
|
|
3035
|
+
*/
|
|
2775
3036
|
language?: string | null;
|
|
2776
|
-
/**
|
|
3037
|
+
/**
|
|
3038
|
+
* Locale in which Order was created.
|
|
3039
|
+
* @format LANGUAGE_TAG
|
|
3040
|
+
*/
|
|
2777
3041
|
locale?: string | null;
|
|
2778
3042
|
/** Notifications silenced for this domain event. */
|
|
2779
3043
|
silent?: boolean | null;
|
|
2780
|
-
/**
|
|
3044
|
+
/**
|
|
3045
|
+
* Event ID.
|
|
3046
|
+
* @format GUID
|
|
3047
|
+
*/
|
|
2781
3048
|
eventId?: string;
|
|
2782
|
-
/**
|
|
3049
|
+
/**
|
|
3050
|
+
* Unique order number.
|
|
3051
|
+
* @maxLength 36
|
|
3052
|
+
*/
|
|
2783
3053
|
orderNumber?: string;
|
|
2784
|
-
/**
|
|
3054
|
+
/**
|
|
3055
|
+
* Contact ID associated with this order.
|
|
3056
|
+
* @format GUID
|
|
3057
|
+
*/
|
|
2785
3058
|
contactId?: string | null;
|
|
2786
|
-
/**
|
|
3059
|
+
/**
|
|
3060
|
+
* Member ID associated with this order.
|
|
3061
|
+
* @format GUID
|
|
3062
|
+
*/
|
|
2787
3063
|
memberId?: string | null;
|
|
2788
3064
|
/**
|
|
2789
3065
|
* Order created timestamp.
|
|
@@ -2795,11 +3071,20 @@ export interface OrderEmailAdded {
|
|
|
2795
3071
|
* @readonly
|
|
2796
3072
|
*/
|
|
2797
3073
|
updated?: Date | null;
|
|
2798
|
-
/**
|
|
3074
|
+
/**
|
|
3075
|
+
* Buyer first name.
|
|
3076
|
+
* @maxLength 255
|
|
3077
|
+
*/
|
|
2799
3078
|
firstName?: string | null;
|
|
2800
|
-
/**
|
|
3079
|
+
/**
|
|
3080
|
+
* Buyer last name.
|
|
3081
|
+
* @maxLength 255
|
|
3082
|
+
*/
|
|
2801
3083
|
lastName?: string | null;
|
|
2802
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Buyer email.
|
|
3086
|
+
* @format EMAIL
|
|
3087
|
+
*/
|
|
2803
3088
|
email?: string | null;
|
|
2804
3089
|
/** Checkout form response. */
|
|
2805
3090
|
checkoutForm?: FormResponse;
|
|
@@ -2807,29 +3092,47 @@ export interface OrderEmailAdded {
|
|
|
2807
3092
|
confirmed?: boolean;
|
|
2808
3093
|
/** Order status. */
|
|
2809
3094
|
status?: OrderStatus;
|
|
2810
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3097
|
+
* @maxLength 100
|
|
3098
|
+
*/
|
|
2811
3099
|
method?: string | null;
|
|
2812
|
-
/**
|
|
3100
|
+
/**
|
|
3101
|
+
* Tickets generated after payment.
|
|
3102
|
+
* @maxSize 50
|
|
3103
|
+
*/
|
|
2813
3104
|
tickets?: Ticket[];
|
|
2814
3105
|
/** Whether order was archived and excluded from results. */
|
|
2815
3106
|
archived?: boolean;
|
|
2816
|
-
/**
|
|
3107
|
+
/**
|
|
3108
|
+
* Reservation ID associated with this order.
|
|
3109
|
+
* @format GUID
|
|
3110
|
+
*/
|
|
2817
3111
|
reservationId?: string;
|
|
2818
3112
|
}
|
|
2819
3113
|
export interface EventCanceled {
|
|
2820
3114
|
/** Event canceled timestamp in ISO UTC format. */
|
|
2821
3115
|
timestamp?: Date | null;
|
|
2822
|
-
/**
|
|
3116
|
+
/**
|
|
3117
|
+
* Event ID.
|
|
3118
|
+
* @format GUID
|
|
3119
|
+
*/
|
|
2823
3120
|
eventId?: string;
|
|
2824
3121
|
/** Event title */
|
|
2825
3122
|
title?: string;
|
|
2826
|
-
/**
|
|
3123
|
+
/**
|
|
3124
|
+
* Event creator user ID.
|
|
3125
|
+
* @format GUID
|
|
3126
|
+
*/
|
|
2827
3127
|
userId?: string | null;
|
|
2828
3128
|
}
|
|
2829
3129
|
export interface EventReminder {
|
|
2830
3130
|
/** Reminder timestamp in ISO UTC format. */
|
|
2831
3131
|
timestamp?: Date | null;
|
|
2832
|
-
/**
|
|
3132
|
+
/**
|
|
3133
|
+
* Event ID.
|
|
3134
|
+
* @format GUID
|
|
3135
|
+
*/
|
|
2833
3136
|
eventId?: string;
|
|
2834
3137
|
/** Event location. */
|
|
2835
3138
|
location?: Location;
|
|
@@ -2837,7 +3140,10 @@ export interface EventReminder {
|
|
|
2837
3140
|
scheduleConfig?: ScheduleConfig;
|
|
2838
3141
|
/** Event title. */
|
|
2839
3142
|
title?: string;
|
|
2840
|
-
/**
|
|
3143
|
+
/**
|
|
3144
|
+
* Event creator user ID.
|
|
3145
|
+
* @format GUID
|
|
3146
|
+
*/
|
|
2841
3147
|
userId?: string | null;
|
|
2842
3148
|
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
2843
3149
|
startsIn?: TimeDuration;
|
|
@@ -2849,86 +3155,164 @@ export interface EventReminder {
|
|
|
2849
3155
|
export interface TimeDuration {
|
|
2850
3156
|
/** Number of days. */
|
|
2851
3157
|
days?: number;
|
|
2852
|
-
/**
|
|
3158
|
+
/**
|
|
3159
|
+
* Number of hours.
|
|
3160
|
+
* @max 24
|
|
3161
|
+
*/
|
|
2853
3162
|
hours?: number;
|
|
2854
|
-
/**
|
|
3163
|
+
/**
|
|
3164
|
+
* Number of minutes.
|
|
3165
|
+
* @max 60
|
|
3166
|
+
*/
|
|
2855
3167
|
minutes?: number;
|
|
2856
3168
|
}
|
|
2857
3169
|
export interface OrderPaid {
|
|
2858
3170
|
/** Order paid timestamp in ISO UTC. */
|
|
2859
3171
|
timestamp?: Date | null;
|
|
2860
|
-
/**
|
|
3172
|
+
/**
|
|
3173
|
+
* Site language when Order initiated
|
|
3174
|
+
* @format LANGUAGE
|
|
3175
|
+
*/
|
|
2861
3176
|
language?: string | null;
|
|
2862
3177
|
/** Notifications silenced for this domain event. */
|
|
2863
3178
|
silent?: boolean | null;
|
|
2864
|
-
/**
|
|
3179
|
+
/**
|
|
3180
|
+
* Locale in which Order was created.
|
|
3181
|
+
* @format LANGUAGE_TAG
|
|
3182
|
+
*/
|
|
2865
3183
|
locale?: string | null;
|
|
2866
|
-
/**
|
|
3184
|
+
/**
|
|
3185
|
+
* Event ID.
|
|
3186
|
+
* @format GUID
|
|
3187
|
+
*/
|
|
2867
3188
|
eventId?: string;
|
|
2868
3189
|
/** Unique order number. */
|
|
2869
3190
|
orderNumber?: string;
|
|
2870
3191
|
/** Reservation ID associated with this order. */
|
|
2871
3192
|
reservationId?: string;
|
|
2872
|
-
/**
|
|
3193
|
+
/**
|
|
3194
|
+
* Contact ID associated with this order.
|
|
3195
|
+
* @maxLength 36
|
|
3196
|
+
*/
|
|
2873
3197
|
contactId?: string;
|
|
2874
|
-
/**
|
|
3198
|
+
/**
|
|
3199
|
+
* Member ID associated with this order.
|
|
3200
|
+
* @format GUID
|
|
3201
|
+
*/
|
|
2875
3202
|
memberId?: string | null;
|
|
2876
3203
|
/**
|
|
2877
3204
|
* Order created timestamp
|
|
2878
3205
|
* @readonly
|
|
2879
3206
|
*/
|
|
2880
3207
|
created?: Date | null;
|
|
2881
|
-
/**
|
|
3208
|
+
/**
|
|
3209
|
+
* Buyer first name.
|
|
3210
|
+
* @maxLength 255
|
|
3211
|
+
*/
|
|
2882
3212
|
firstName?: string;
|
|
2883
|
-
/**
|
|
3213
|
+
/**
|
|
3214
|
+
* Buyer last name.
|
|
3215
|
+
* @maxLength 255
|
|
3216
|
+
*/
|
|
2884
3217
|
lastName?: string;
|
|
2885
|
-
/**
|
|
3218
|
+
/**
|
|
3219
|
+
* Buyer email address.
|
|
3220
|
+
* @maxLength 255
|
|
3221
|
+
*/
|
|
2886
3222
|
email?: string;
|
|
2887
3223
|
/** Checkout form response. */
|
|
2888
3224
|
checkoutForm?: FormResponse;
|
|
2889
3225
|
/** Order status. */
|
|
2890
3226
|
status?: OrderStatus;
|
|
2891
|
-
/**
|
|
3227
|
+
/**
|
|
3228
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3229
|
+
* @maxLength 255
|
|
3230
|
+
*/
|
|
2892
3231
|
method?: string | null;
|
|
2893
|
-
/**
|
|
3232
|
+
/**
|
|
3233
|
+
* Tickets (generated after payment).
|
|
3234
|
+
* @maxSize 50
|
|
3235
|
+
*/
|
|
2894
3236
|
tickets?: Ticket[];
|
|
2895
3237
|
/** Invoice. */
|
|
2896
3238
|
invoice?: Invoice;
|
|
2897
3239
|
}
|
|
2898
3240
|
export interface TicketPdfResolved {
|
|
2899
|
-
/**
|
|
3241
|
+
/**
|
|
3242
|
+
* Optional order number
|
|
3243
|
+
* @maxLength 36
|
|
3244
|
+
*/
|
|
2900
3245
|
orderNumber?: string | null;
|
|
2901
|
-
/**
|
|
3246
|
+
/**
|
|
3247
|
+
* Optional ticket number
|
|
3248
|
+
* @maxLength 36
|
|
3249
|
+
*/
|
|
2902
3250
|
ticketNumber?: string | null;
|
|
2903
|
-
/**
|
|
3251
|
+
/**
|
|
3252
|
+
* Resolved download url
|
|
3253
|
+
* @format WEB_URL
|
|
3254
|
+
*/
|
|
2904
3255
|
downloadUrl?: string | null;
|
|
2905
3256
|
/** Resolve status */
|
|
2906
3257
|
resolveFailed?: boolean | null;
|
|
2907
|
-
/**
|
|
3258
|
+
/**
|
|
3259
|
+
* Papyrus document id
|
|
3260
|
+
* @format GUID
|
|
3261
|
+
*/
|
|
2908
3262
|
documentId?: string | null;
|
|
2909
3263
|
}
|
|
2910
3264
|
export interface TicketPdfResolveDelayed {
|
|
2911
|
-
/**
|
|
3265
|
+
/**
|
|
3266
|
+
* Optional order number
|
|
3267
|
+
* @maxLength 36
|
|
3268
|
+
*/
|
|
2912
3269
|
orderNumber?: string | null;
|
|
2913
|
-
/**
|
|
3270
|
+
/**
|
|
3271
|
+
* Optional ticket number
|
|
3272
|
+
* @maxLength 36
|
|
3273
|
+
*/
|
|
2914
3274
|
ticketNumber?: string | null;
|
|
2915
|
-
/**
|
|
3275
|
+
/**
|
|
3276
|
+
* Papyrus document id
|
|
3277
|
+
* @format GUID
|
|
3278
|
+
*/
|
|
2916
3279
|
documentId?: string | null;
|
|
2917
3280
|
}
|
|
2918
3281
|
export interface OrderCanceled {
|
|
2919
|
-
/**
|
|
3282
|
+
/**
|
|
3283
|
+
* Event ID.
|
|
3284
|
+
* @format GUID
|
|
3285
|
+
*/
|
|
2920
3286
|
eventId?: string;
|
|
2921
|
-
/**
|
|
3287
|
+
/**
|
|
3288
|
+
* Unique order number.
|
|
3289
|
+
* @maxLength 36
|
|
3290
|
+
*/
|
|
2922
3291
|
orderNumber?: string;
|
|
2923
|
-
/**
|
|
3292
|
+
/**
|
|
3293
|
+
* Reservation ID associated with this order.
|
|
3294
|
+
* @format GUID
|
|
3295
|
+
*/
|
|
2924
3296
|
reservationId?: string;
|
|
2925
|
-
/**
|
|
3297
|
+
/**
|
|
3298
|
+
* Contact ID associated with this order.
|
|
3299
|
+
* @maxLength 36
|
|
3300
|
+
*/
|
|
2926
3301
|
contactId?: string;
|
|
2927
|
-
/**
|
|
3302
|
+
/**
|
|
3303
|
+
* Buyer first name.
|
|
3304
|
+
* @maxLength 50
|
|
3305
|
+
*/
|
|
2928
3306
|
firstName?: string | null;
|
|
2929
|
-
/**
|
|
3307
|
+
/**
|
|
3308
|
+
* Buyer last name.
|
|
3309
|
+
* @maxLength 50
|
|
3310
|
+
*/
|
|
2930
3311
|
lastName?: string | null;
|
|
2931
|
-
/**
|
|
3312
|
+
/**
|
|
3313
|
+
* Buyer email address.
|
|
3314
|
+
* @maxLength 255
|
|
3315
|
+
*/
|
|
2932
3316
|
email?: string | null;
|
|
2933
3317
|
/** Checkout form response. */
|
|
2934
3318
|
checkoutForm?: FormResponse;
|
|
@@ -2938,17 +3322,26 @@ export interface OrderCanceled {
|
|
|
2938
3322
|
export interface EventEnded {
|
|
2939
3323
|
/** Event end timestamp in ISO UTC format. */
|
|
2940
3324
|
timestamp?: Date | null;
|
|
2941
|
-
/**
|
|
3325
|
+
/**
|
|
3326
|
+
* Event ID.
|
|
3327
|
+
* @format GUID
|
|
3328
|
+
*/
|
|
2942
3329
|
eventId?: string;
|
|
2943
3330
|
}
|
|
2944
3331
|
export interface EventStarted {
|
|
2945
3332
|
/** Event start timestamp in ISO UTC format. */
|
|
2946
3333
|
timestamp?: Date | null;
|
|
2947
|
-
/**
|
|
3334
|
+
/**
|
|
3335
|
+
* Event ID.
|
|
3336
|
+
* @format GUID
|
|
3337
|
+
*/
|
|
2948
3338
|
eventId?: string;
|
|
2949
3339
|
}
|
|
2950
3340
|
export interface ResolveNotificationConfigRequest {
|
|
2951
|
-
/**
|
|
3341
|
+
/**
|
|
3342
|
+
* Id of the NotificationConfig to retrieve
|
|
3343
|
+
* @format GUID
|
|
3344
|
+
*/
|
|
2952
3345
|
notificationConfigId: string;
|
|
2953
3346
|
}
|
|
2954
3347
|
export interface ResolveNotificationConfigResponse {
|
|
@@ -2964,7 +3357,10 @@ export interface UpsertNotificationConfigResponse {
|
|
|
2964
3357
|
notificationConfig?: NotificationConfig;
|
|
2965
3358
|
}
|
|
2966
3359
|
export interface ResolveEmailNotificationConfigRequest {
|
|
2967
|
-
/**
|
|
3360
|
+
/**
|
|
3361
|
+
* Id of the NotificationConfig to retrieve
|
|
3362
|
+
* @format GUID
|
|
3363
|
+
*/
|
|
2968
3364
|
notificationConfigId?: string;
|
|
2969
3365
|
/** Notification type */
|
|
2970
3366
|
notificationType?: EmailNotificationType;
|
|
@@ -2976,17 +3372,26 @@ export interface ResolveEmailNotificationConfigResponse {
|
|
|
2976
3372
|
export interface EventDeleted {
|
|
2977
3373
|
/** Event deleted timestamp in ISO UTC format. */
|
|
2978
3374
|
timestamp?: Date | null;
|
|
2979
|
-
/**
|
|
3375
|
+
/**
|
|
3376
|
+
* Event ID.
|
|
3377
|
+
* @format GUID
|
|
3378
|
+
*/
|
|
2980
3379
|
eventId?: string;
|
|
2981
3380
|
/** Event title. */
|
|
2982
3381
|
title?: string;
|
|
2983
|
-
/**
|
|
3382
|
+
/**
|
|
3383
|
+
* Event creator user ID.
|
|
3384
|
+
* @format GUID
|
|
3385
|
+
*/
|
|
2984
3386
|
userId?: string | null;
|
|
2985
3387
|
}
|
|
2986
3388
|
export interface EventCopied {
|
|
2987
3389
|
/** Event created timestamp in ISO UTC format. */
|
|
2988
3390
|
timestamp?: Date | null;
|
|
2989
|
-
/**
|
|
3391
|
+
/**
|
|
3392
|
+
* Event ID.
|
|
3393
|
+
* @format GUID
|
|
3394
|
+
*/
|
|
2990
3395
|
eventId?: string;
|
|
2991
3396
|
/** Event location. */
|
|
2992
3397
|
location?: Location;
|
|
@@ -2994,13 +3399,22 @@ export interface EventCopied {
|
|
|
2994
3399
|
scheduleConfig?: ScheduleConfig;
|
|
2995
3400
|
/** Event title. */
|
|
2996
3401
|
title?: string;
|
|
2997
|
-
/**
|
|
3402
|
+
/**
|
|
3403
|
+
* Event creator user ID.
|
|
3404
|
+
* @format GUID
|
|
3405
|
+
*/
|
|
2998
3406
|
userId?: string | null;
|
|
2999
3407
|
/** Event status. */
|
|
3000
3408
|
status?: EventStatus;
|
|
3001
|
-
/**
|
|
3409
|
+
/**
|
|
3410
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3411
|
+
* @format GUID
|
|
3412
|
+
*/
|
|
3002
3413
|
derivedFromInstanceId?: string | null;
|
|
3003
|
-
/**
|
|
3414
|
+
/**
|
|
3415
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3416
|
+
* @format GUID
|
|
3417
|
+
*/
|
|
3004
3418
|
derivedFromEventId?: string | null;
|
|
3005
3419
|
/**
|
|
3006
3420
|
* Map of copied ticket definitions from original event.
|
|
@@ -3010,9 +3424,15 @@ export interface EventCopied {
|
|
|
3010
3424
|
ticketDefinitions?: Record<string, string>;
|
|
3011
3425
|
}
|
|
3012
3426
|
export interface MessageEnvelope {
|
|
3013
|
-
/**
|
|
3427
|
+
/**
|
|
3428
|
+
* App instance ID.
|
|
3429
|
+
* @format GUID
|
|
3430
|
+
*/
|
|
3014
3431
|
instanceId?: string | null;
|
|
3015
|
-
/**
|
|
3432
|
+
/**
|
|
3433
|
+
* Event type.
|
|
3434
|
+
* @maxLength 150
|
|
3435
|
+
*/
|
|
3016
3436
|
eventType?: string;
|
|
3017
3437
|
/** The identification type and identity data. */
|
|
3018
3438
|
identity?: IdentificationData;
|
|
@@ -3020,26 +3440,50 @@ export interface MessageEnvelope {
|
|
|
3020
3440
|
data?: string;
|
|
3021
3441
|
}
|
|
3022
3442
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3023
|
-
/**
|
|
3443
|
+
/**
|
|
3444
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3445
|
+
* @format GUID
|
|
3446
|
+
*/
|
|
3024
3447
|
anonymousVisitorId?: string;
|
|
3025
|
-
/**
|
|
3448
|
+
/**
|
|
3449
|
+
* ID of a site visitor that has logged in to the site.
|
|
3450
|
+
* @format GUID
|
|
3451
|
+
*/
|
|
3026
3452
|
memberId?: string;
|
|
3027
|
-
/**
|
|
3453
|
+
/**
|
|
3454
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3455
|
+
* @format GUID
|
|
3456
|
+
*/
|
|
3028
3457
|
wixUserId?: string;
|
|
3029
|
-
/**
|
|
3458
|
+
/**
|
|
3459
|
+
* ID of an app.
|
|
3460
|
+
* @format GUID
|
|
3461
|
+
*/
|
|
3030
3462
|
appId?: string;
|
|
3031
3463
|
/** @readonly */
|
|
3032
3464
|
identityType?: WebhookIdentityType;
|
|
3033
3465
|
}
|
|
3034
3466
|
/** @oneof */
|
|
3035
3467
|
export interface IdentificationDataIdOneOf {
|
|
3036
|
-
/**
|
|
3468
|
+
/**
|
|
3469
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3470
|
+
* @format GUID
|
|
3471
|
+
*/
|
|
3037
3472
|
anonymousVisitorId?: string;
|
|
3038
|
-
/**
|
|
3473
|
+
/**
|
|
3474
|
+
* ID of a site visitor that has logged in to the site.
|
|
3475
|
+
* @format GUID
|
|
3476
|
+
*/
|
|
3039
3477
|
memberId?: string;
|
|
3040
|
-
/**
|
|
3478
|
+
/**
|
|
3479
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3480
|
+
* @format GUID
|
|
3481
|
+
*/
|
|
3041
3482
|
wixUserId?: string;
|
|
3042
|
-
/**
|
|
3483
|
+
/**
|
|
3484
|
+
* ID of an app.
|
|
3485
|
+
* @format GUID
|
|
3486
|
+
*/
|
|
3043
3487
|
appId?: string;
|
|
3044
3488
|
}
|
|
3045
3489
|
export declare enum WebhookIdentityType {
|