@wix/auto_sdk_events_notifications 1.0.3 → 1.0.4
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 +575 -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 +606 -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 +575 -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 +606 -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 +575 -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 +606 -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 +575 -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 +606 -138
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/package.json +2 -2
package/build/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts
CHANGED
|
@@ -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 {
|
|
@@ -249,7 +293,10 @@ export interface Empty {
|
|
|
249
293
|
export interface EventUpdated {
|
|
250
294
|
/** Event update timestamp in ISO UTC format. */
|
|
251
295
|
timestamp?: Date | null;
|
|
252
|
-
/**
|
|
296
|
+
/**
|
|
297
|
+
* Event ID.
|
|
298
|
+
* @format GUID
|
|
299
|
+
*/
|
|
253
300
|
eventId?: string;
|
|
254
301
|
/** Event location. */
|
|
255
302
|
location?: Location;
|
|
@@ -266,11 +313,17 @@ export interface EventUpdated {
|
|
|
266
313
|
event?: Event;
|
|
267
314
|
}
|
|
268
315
|
export interface Location {
|
|
269
|
-
/**
|
|
316
|
+
/**
|
|
317
|
+
* Location name.
|
|
318
|
+
* @maxLength 50
|
|
319
|
+
*/
|
|
270
320
|
name?: string | null;
|
|
271
321
|
/** Location map coordinates. */
|
|
272
322
|
coordinates?: MapCoordinates;
|
|
273
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* Single line address representation.
|
|
325
|
+
* @maxLength 300
|
|
326
|
+
*/
|
|
274
327
|
address?: string | null;
|
|
275
328
|
/** Location type. */
|
|
276
329
|
type?: LocationType;
|
|
@@ -292,9 +345,17 @@ export interface Location {
|
|
|
292
345
|
tbd?: boolean | null;
|
|
293
346
|
}
|
|
294
347
|
export interface MapCoordinates {
|
|
295
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* Latitude.
|
|
350
|
+
* @min -90
|
|
351
|
+
* @max 90
|
|
352
|
+
*/
|
|
296
353
|
lat?: number;
|
|
297
|
-
/**
|
|
354
|
+
/**
|
|
355
|
+
* Longitude.
|
|
356
|
+
* @min -180
|
|
357
|
+
* @max 180
|
|
358
|
+
*/
|
|
298
359
|
lng?: number;
|
|
299
360
|
}
|
|
300
361
|
export declare enum LocationType {
|
|
@@ -307,7 +368,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
307
368
|
streetAddress?: StreetAddress;
|
|
308
369
|
/** Main address line (usually street and number) as free text */
|
|
309
370
|
addressLine1?: string | null;
|
|
310
|
-
/**
|
|
371
|
+
/**
|
|
372
|
+
* country code
|
|
373
|
+
* @format COUNTRY
|
|
374
|
+
*/
|
|
311
375
|
country?: string | null;
|
|
312
376
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
313
377
|
subdivision?: string | null;
|
|
@@ -323,7 +387,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
323
387
|
location?: AddressLocation;
|
|
324
388
|
/** country full-name */
|
|
325
389
|
countryFullname?: string | null;
|
|
326
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* multi-level subdivisions from top to bottom
|
|
392
|
+
* @maxSize 6
|
|
393
|
+
*/
|
|
327
394
|
subdivisions?: Subdivision[];
|
|
328
395
|
}
|
|
329
396
|
/** @oneof */
|
|
@@ -340,9 +407,17 @@ export interface StreetAddress {
|
|
|
340
407
|
name?: string;
|
|
341
408
|
}
|
|
342
409
|
export interface AddressLocation {
|
|
343
|
-
/**
|
|
410
|
+
/**
|
|
411
|
+
* address latitude coordinates
|
|
412
|
+
* @min -90
|
|
413
|
+
* @max 90
|
|
414
|
+
*/
|
|
344
415
|
latitude?: number | null;
|
|
345
|
-
/**
|
|
416
|
+
/**
|
|
417
|
+
* address longitude coordinates
|
|
418
|
+
* @min -180
|
|
419
|
+
* @max 180
|
|
420
|
+
*/
|
|
346
421
|
longitude?: number | null;
|
|
347
422
|
}
|
|
348
423
|
export interface Subdivision {
|
|
@@ -373,13 +448,19 @@ export interface ScheduleConfig {
|
|
|
373
448
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
374
449
|
*/
|
|
375
450
|
scheduleTbd?: boolean;
|
|
376
|
-
/**
|
|
451
|
+
/**
|
|
452
|
+
* TBD message.
|
|
453
|
+
* @maxLength 100
|
|
454
|
+
*/
|
|
377
455
|
scheduleTbdMessage?: string | null;
|
|
378
456
|
/** Event start timestamp. */
|
|
379
457
|
startDate?: Date | null;
|
|
380
458
|
/** Event end timestamp. */
|
|
381
459
|
endDate?: Date | null;
|
|
382
|
-
/**
|
|
460
|
+
/**
|
|
461
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
462
|
+
* @maxLength 100
|
|
463
|
+
*/
|
|
383
464
|
timeZoneId?: string | null;
|
|
384
465
|
/** Whether end date is hidden in the formatted schedule. */
|
|
385
466
|
endDateHidden?: boolean;
|
|
@@ -389,7 +470,10 @@ export interface ScheduleConfig {
|
|
|
389
470
|
recurrences?: Recurrences;
|
|
390
471
|
}
|
|
391
472
|
export interface Recurrences {
|
|
392
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* Event occurrences.
|
|
475
|
+
* @maxSize 1000
|
|
476
|
+
*/
|
|
393
477
|
occurrences?: Occurrence[];
|
|
394
478
|
/**
|
|
395
479
|
* Recurring event category ID.
|
|
@@ -407,7 +491,10 @@ export interface Occurrence {
|
|
|
407
491
|
startDate?: Date | null;
|
|
408
492
|
/** Event end timestamp. */
|
|
409
493
|
endDate?: Date | null;
|
|
410
|
-
/**
|
|
494
|
+
/**
|
|
495
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
496
|
+
* @maxLength 100
|
|
497
|
+
*/
|
|
411
498
|
timeZoneId?: string | null;
|
|
412
499
|
/** Whether time zone is displayed in formatted schedule. */
|
|
413
500
|
showTimeZone?: boolean;
|
|
@@ -427,6 +514,7 @@ export declare enum Status {
|
|
|
427
514
|
export interface Event {
|
|
428
515
|
/**
|
|
429
516
|
* Event ID.
|
|
517
|
+
* @format GUID
|
|
430
518
|
* @readonly
|
|
431
519
|
*/
|
|
432
520
|
_id?: string;
|
|
@@ -466,7 +554,10 @@ export interface Event {
|
|
|
466
554
|
instanceId?: string;
|
|
467
555
|
/** Guest list configuration. */
|
|
468
556
|
guestListConfig?: GuestListConfig;
|
|
469
|
-
/**
|
|
557
|
+
/**
|
|
558
|
+
* Event creator user ID.
|
|
559
|
+
* @maxLength 36
|
|
560
|
+
*/
|
|
470
561
|
userId?: string;
|
|
471
562
|
/** Event discussion feed. For internal use. */
|
|
472
563
|
feed?: Feed;
|
|
@@ -631,17 +722,31 @@ export interface TicketingConfig {
|
|
|
631
722
|
guestAssignedTickets?: boolean;
|
|
632
723
|
/** Tax configuration. */
|
|
633
724
|
taxConfig?: TaxConfig;
|
|
634
|
-
/**
|
|
725
|
+
/**
|
|
726
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
727
|
+
* @max 50
|
|
728
|
+
*/
|
|
635
729
|
ticketLimitPerOrder?: number;
|
|
636
|
-
/**
|
|
730
|
+
/**
|
|
731
|
+
* Duration for which the tickets being bought are reserved.
|
|
732
|
+
* @min 5
|
|
733
|
+
* @max 30
|
|
734
|
+
*/
|
|
637
735
|
reservationDurationInMinutes?: number | null;
|
|
638
736
|
}
|
|
639
737
|
export interface TaxConfig {
|
|
640
738
|
/** Tax application settings. */
|
|
641
739
|
type?: TaxType;
|
|
642
|
-
/**
|
|
740
|
+
/**
|
|
741
|
+
* Tax name.
|
|
742
|
+
* @minLength 1
|
|
743
|
+
* @maxLength 10
|
|
744
|
+
*/
|
|
643
745
|
name?: string | null;
|
|
644
|
-
/**
|
|
746
|
+
/**
|
|
747
|
+
* Tax rate (e.g.,`21.55`).
|
|
748
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
749
|
+
*/
|
|
645
750
|
rate?: string | null;
|
|
646
751
|
/** Applies taxes for donations, default true. */
|
|
647
752
|
appliesToDonations?: boolean | null;
|
|
@@ -657,12 +762,19 @@ export declare enum TaxType {
|
|
|
657
762
|
export interface Money {
|
|
658
763
|
/**
|
|
659
764
|
* *Deprecated:** Use `value` instead.
|
|
765
|
+
* @format DECIMAL_VALUE
|
|
660
766
|
* @deprecated
|
|
661
767
|
*/
|
|
662
768
|
amount?: string;
|
|
663
|
-
/**
|
|
769
|
+
/**
|
|
770
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
771
|
+
* @format CURRENCY
|
|
772
|
+
*/
|
|
664
773
|
currency?: string;
|
|
665
|
-
/**
|
|
774
|
+
/**
|
|
775
|
+
* 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.
|
|
776
|
+
* @format DECIMAL_VALUE
|
|
777
|
+
*/
|
|
666
778
|
value?: string | null;
|
|
667
779
|
}
|
|
668
780
|
export interface ExternalEvent {
|
|
@@ -817,21 +929,29 @@ export declare enum ValueType {
|
|
|
817
929
|
* Defaults to first (0th) option if not configured.
|
|
818
930
|
*/
|
|
819
931
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
820
|
-
/**
|
|
932
|
+
/**
|
|
933
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
934
|
+
* @max 199
|
|
935
|
+
*/
|
|
821
936
|
optionIndex?: number;
|
|
822
937
|
/**
|
|
823
938
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
824
939
|
* Considered an empty choice.
|
|
940
|
+
* @maxLength 200
|
|
825
941
|
*/
|
|
826
942
|
placeholderText?: string;
|
|
827
943
|
}
|
|
828
944
|
/** @oneof */
|
|
829
945
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
830
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
948
|
+
* @max 199
|
|
949
|
+
*/
|
|
831
950
|
optionIndex?: number;
|
|
832
951
|
/**
|
|
833
952
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
834
953
|
* Considered an empty choice.
|
|
954
|
+
* @maxLength 200
|
|
835
955
|
*/
|
|
836
956
|
placeholderText?: string;
|
|
837
957
|
}
|
|
@@ -986,7 +1106,10 @@ export interface OnlineConferencingConfig {
|
|
|
986
1106
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
987
1107
|
*/
|
|
988
1108
|
enabled?: boolean;
|
|
989
|
-
/**
|
|
1109
|
+
/**
|
|
1110
|
+
* Conferencing provider ID.
|
|
1111
|
+
* @format GUID
|
|
1112
|
+
*/
|
|
990
1113
|
providerId?: string | null;
|
|
991
1114
|
/** Conference type */
|
|
992
1115
|
conferenceType?: ConferenceType;
|
|
@@ -1025,7 +1148,10 @@ export interface OnlineConferencingSession {
|
|
|
1025
1148
|
sessionId?: string | null;
|
|
1026
1149
|
}
|
|
1027
1150
|
export interface SeoSettings {
|
|
1028
|
-
/**
|
|
1151
|
+
/**
|
|
1152
|
+
* URL slug
|
|
1153
|
+
* @maxLength 130
|
|
1154
|
+
*/
|
|
1029
1155
|
slug?: string;
|
|
1030
1156
|
/** Advanced SEO data */
|
|
1031
1157
|
advancedSeoData?: SeoSchema;
|
|
@@ -1051,7 +1177,10 @@ export interface Keyword {
|
|
|
1051
1177
|
term?: string;
|
|
1052
1178
|
/** Whether the keyword is the main focus keyword. */
|
|
1053
1179
|
isMain?: boolean;
|
|
1054
|
-
/**
|
|
1180
|
+
/**
|
|
1181
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1182
|
+
* @maxLength 1000
|
|
1183
|
+
*/
|
|
1055
1184
|
origin?: string | null;
|
|
1056
1185
|
}
|
|
1057
1186
|
export interface Tag {
|
|
@@ -1084,7 +1213,10 @@ export interface Settings {
|
|
|
1084
1213
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1085
1214
|
*/
|
|
1086
1215
|
preventAutoRedirect?: boolean;
|
|
1087
|
-
/**
|
|
1216
|
+
/**
|
|
1217
|
+
* User-selected keyword terms for a specific page.
|
|
1218
|
+
* @maxSize 5
|
|
1219
|
+
*/
|
|
1088
1220
|
keywords?: Keyword[];
|
|
1089
1221
|
}
|
|
1090
1222
|
export interface Agenda {
|
|
@@ -1099,10 +1231,15 @@ export interface Agenda {
|
|
|
1099
1231
|
export interface Category {
|
|
1100
1232
|
/**
|
|
1101
1233
|
* Category ID.
|
|
1234
|
+
* @format GUID
|
|
1102
1235
|
* @readonly
|
|
1103
1236
|
*/
|
|
1104
1237
|
_id?: string;
|
|
1105
|
-
/**
|
|
1238
|
+
/**
|
|
1239
|
+
* Category name.
|
|
1240
|
+
* @minLength 1
|
|
1241
|
+
* @maxLength 30
|
|
1242
|
+
*/
|
|
1106
1243
|
name?: string;
|
|
1107
1244
|
/**
|
|
1108
1245
|
* Date and time when category was created.
|
|
@@ -1125,6 +1262,7 @@ export interface Category {
|
|
|
1125
1262
|
* Default: `MANUAL`.
|
|
1126
1263
|
*
|
|
1127
1264
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1265
|
+
* @maxSize 3
|
|
1128
1266
|
*/
|
|
1129
1267
|
states?: State[];
|
|
1130
1268
|
}
|
|
@@ -1750,11 +1888,20 @@ export interface GIFData {
|
|
|
1750
1888
|
gifType?: GIFType;
|
|
1751
1889
|
}
|
|
1752
1890
|
export interface GIF {
|
|
1753
|
-
/**
|
|
1891
|
+
/**
|
|
1892
|
+
* GIF format URL.
|
|
1893
|
+
* @format WEB_URL
|
|
1894
|
+
*/
|
|
1754
1895
|
gif?: string | null;
|
|
1755
|
-
/**
|
|
1896
|
+
/**
|
|
1897
|
+
* MP4 format URL.
|
|
1898
|
+
* @format WEB_URL
|
|
1899
|
+
*/
|
|
1756
1900
|
mp4?: string | null;
|
|
1757
|
-
/**
|
|
1901
|
+
/**
|
|
1902
|
+
* Thumbnail URL.
|
|
1903
|
+
* @format WEB_URL
|
|
1904
|
+
*/
|
|
1758
1905
|
still?: string | null;
|
|
1759
1906
|
}
|
|
1760
1907
|
export declare enum GIFType {
|
|
@@ -1820,6 +1967,22 @@ export interface ImageData {
|
|
|
1820
1967
|
caption?: string | null;
|
|
1821
1968
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1822
1969
|
disableDownload?: boolean | null;
|
|
1970
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1971
|
+
decorative?: boolean | null;
|
|
1972
|
+
/** Styling for the image. */
|
|
1973
|
+
styles?: ImageDataStyles;
|
|
1974
|
+
}
|
|
1975
|
+
export interface StylesBorder {
|
|
1976
|
+
/** Border width in pixels. */
|
|
1977
|
+
width?: number | null;
|
|
1978
|
+
/** Border color. */
|
|
1979
|
+
color?: string | null;
|
|
1980
|
+
/** Border radius in pixels. */
|
|
1981
|
+
radius?: number | null;
|
|
1982
|
+
}
|
|
1983
|
+
export interface ImageDataStyles {
|
|
1984
|
+
/** Border attributes. */
|
|
1985
|
+
border?: StylesBorder;
|
|
1823
1986
|
}
|
|
1824
1987
|
export interface LinkPreviewData {
|
|
1825
1988
|
/** Styling for the link preview's container. */
|
|
@@ -1966,13 +2129,22 @@ export declare enum BackgroundType {
|
|
|
1966
2129
|
export interface Gradient {
|
|
1967
2130
|
/** The gradient angle in degrees. */
|
|
1968
2131
|
angle?: number | null;
|
|
1969
|
-
/**
|
|
2132
|
+
/**
|
|
2133
|
+
* The start color as a hexademical value.
|
|
2134
|
+
* @format COLOR_HEX
|
|
2135
|
+
*/
|
|
1970
2136
|
startColor?: string | null;
|
|
1971
|
-
/**
|
|
2137
|
+
/**
|
|
2138
|
+
* The end color as a hexademical value.
|
|
2139
|
+
* @format COLOR_HEX
|
|
2140
|
+
*/
|
|
1972
2141
|
lastColor?: string | null;
|
|
1973
2142
|
}
|
|
1974
2143
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1975
|
-
/**
|
|
2144
|
+
/**
|
|
2145
|
+
* The background color as a hexademical value.
|
|
2146
|
+
* @format COLOR_HEX
|
|
2147
|
+
*/
|
|
1976
2148
|
color?: string | null;
|
|
1977
2149
|
/** An image to use for the background. */
|
|
1978
2150
|
image?: Media;
|
|
@@ -1983,7 +2155,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1983
2155
|
}
|
|
1984
2156
|
/** @oneof */
|
|
1985
2157
|
export interface BackgroundBackgroundOneOf {
|
|
1986
|
-
/**
|
|
2158
|
+
/**
|
|
2159
|
+
* The background color as a hexademical value.
|
|
2160
|
+
* @format COLOR_HEX
|
|
2161
|
+
*/
|
|
1987
2162
|
color?: string | null;
|
|
1988
2163
|
/** An image to use for the background. */
|
|
1989
2164
|
image?: Media;
|
|
@@ -2295,17 +2470,32 @@ export declare enum VerticalAlignment {
|
|
|
2295
2470
|
export interface CellStyle {
|
|
2296
2471
|
/** Vertical alignment for the cell's text. */
|
|
2297
2472
|
verticalAlignment?: VerticalAlignment;
|
|
2298
|
-
/**
|
|
2473
|
+
/**
|
|
2474
|
+
* Cell background color as a hexadecimal value.
|
|
2475
|
+
* @format COLOR_HEX
|
|
2476
|
+
*/
|
|
2299
2477
|
backgroundColor?: string | null;
|
|
2300
2478
|
}
|
|
2301
2479
|
export interface BorderColors {
|
|
2302
|
-
/**
|
|
2480
|
+
/**
|
|
2481
|
+
* Left border color as a hexadecimal value.
|
|
2482
|
+
* @format COLOR_HEX
|
|
2483
|
+
*/
|
|
2303
2484
|
left?: string | null;
|
|
2304
|
-
/**
|
|
2485
|
+
/**
|
|
2486
|
+
* Right border color as a hexadecimal value.
|
|
2487
|
+
* @format COLOR_HEX
|
|
2488
|
+
*/
|
|
2305
2489
|
right?: string | null;
|
|
2306
|
-
/**
|
|
2490
|
+
/**
|
|
2491
|
+
* Top border color as a hexadecimal value.
|
|
2492
|
+
* @format COLOR_HEX
|
|
2493
|
+
*/
|
|
2307
2494
|
top?: string | null;
|
|
2308
|
-
/**
|
|
2495
|
+
/**
|
|
2496
|
+
* Bottom border color as a hexadecimal value.
|
|
2497
|
+
* @format COLOR_HEX
|
|
2498
|
+
*/
|
|
2309
2499
|
bottom?: string | null;
|
|
2310
2500
|
}
|
|
2311
2501
|
/**
|
|
@@ -2416,19 +2606,31 @@ export interface TextNodeStyle {
|
|
|
2416
2606
|
export interface OrderConfirmed {
|
|
2417
2607
|
/** Order confirmation timestamp in ISO UTC. */
|
|
2418
2608
|
timestamp?: Date | null;
|
|
2419
|
-
/**
|
|
2609
|
+
/**
|
|
2610
|
+
* Site language when Order initiated
|
|
2611
|
+
* @format LANGUAGE
|
|
2612
|
+
*/
|
|
2420
2613
|
language?: string | null;
|
|
2421
2614
|
/** Notifications silenced for this domain event. */
|
|
2422
2615
|
silent?: boolean | null;
|
|
2423
|
-
/**
|
|
2616
|
+
/**
|
|
2617
|
+
* Locale in which Order was created.
|
|
2618
|
+
* @format LANGUAGE_TAG
|
|
2619
|
+
*/
|
|
2424
2620
|
locale?: string | null;
|
|
2425
|
-
/**
|
|
2621
|
+
/**
|
|
2622
|
+
* Event ID.
|
|
2623
|
+
* @format GUID
|
|
2624
|
+
*/
|
|
2426
2625
|
eventId?: string;
|
|
2427
2626
|
/** Unique order number. */
|
|
2428
2627
|
orderNumber?: string;
|
|
2429
2628
|
/** Contact ID associated with this order. */
|
|
2430
2629
|
contactId?: string;
|
|
2431
|
-
/**
|
|
2630
|
+
/**
|
|
2631
|
+
* Member ID associated with this order.
|
|
2632
|
+
* @format GUID
|
|
2633
|
+
*/
|
|
2432
2634
|
memberId?: string | null;
|
|
2433
2635
|
/**
|
|
2434
2636
|
* Order created timestamp
|
|
@@ -2455,19 +2657,35 @@ export interface OrderConfirmed {
|
|
|
2455
2657
|
reservationId?: string;
|
|
2456
2658
|
}
|
|
2457
2659
|
export interface FormResponse {
|
|
2458
|
-
/**
|
|
2660
|
+
/**
|
|
2661
|
+
* Input values entered when filling the form.
|
|
2662
|
+
* @maxSize 200
|
|
2663
|
+
*/
|
|
2459
2664
|
inputValues?: InputValue[];
|
|
2460
2665
|
}
|
|
2461
2666
|
export interface InputValue {
|
|
2462
|
-
/**
|
|
2667
|
+
/**
|
|
2668
|
+
* Input field name.
|
|
2669
|
+
* @maxLength 100
|
|
2670
|
+
*/
|
|
2463
2671
|
inputName?: string;
|
|
2464
|
-
/**
|
|
2672
|
+
/**
|
|
2673
|
+
* Text entered into the input field.
|
|
2674
|
+
* @maxLength 5000
|
|
2675
|
+
*/
|
|
2465
2676
|
value?: string;
|
|
2466
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
2679
|
+
* @maxSize 100
|
|
2680
|
+
* @maxLength 5000
|
|
2681
|
+
*/
|
|
2467
2682
|
values?: string[];
|
|
2468
2683
|
}
|
|
2469
2684
|
export interface FormattedAddress {
|
|
2470
|
-
/**
|
|
2685
|
+
/**
|
|
2686
|
+
* One line address representation.
|
|
2687
|
+
* @maxLength 200
|
|
2688
|
+
*/
|
|
2471
2689
|
formatted?: string;
|
|
2472
2690
|
/** Address components (optional). */
|
|
2473
2691
|
address?: CommonAddress;
|
|
@@ -2478,7 +2696,10 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
2478
2696
|
streetAddress?: CommonStreetAddress;
|
|
2479
2697
|
/** Main address line, usually street and number as free text. */
|
|
2480
2698
|
addressLine1?: string | null;
|
|
2481
|
-
/**
|
|
2699
|
+
/**
|
|
2700
|
+
* Country code.
|
|
2701
|
+
* @format COUNTRY
|
|
2702
|
+
*/
|
|
2482
2703
|
country?: string | null;
|
|
2483
2704
|
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
2484
2705
|
subdivision?: string | null;
|
|
@@ -2516,7 +2737,10 @@ export interface CommonSubdivision {
|
|
|
2516
2737
|
}
|
|
2517
2738
|
/** Subdivision Concordance values */
|
|
2518
2739
|
export interface StandardDetails {
|
|
2519
|
-
/**
|
|
2740
|
+
/**
|
|
2741
|
+
* 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
|
|
2742
|
+
* @maxLength 20
|
|
2743
|
+
*/
|
|
2520
2744
|
iso31662?: string | null;
|
|
2521
2745
|
}
|
|
2522
2746
|
export declare enum OrderStatus {
|
|
@@ -2546,7 +2770,10 @@ export declare enum OrderStatus {
|
|
|
2546
2770
|
export interface Ticket {
|
|
2547
2771
|
/** Unique issued ticket number. */
|
|
2548
2772
|
ticketNumber?: string;
|
|
2549
|
-
/**
|
|
2773
|
+
/**
|
|
2774
|
+
* Ticket definition ID.
|
|
2775
|
+
* @format GUID
|
|
2776
|
+
*/
|
|
2550
2777
|
ticketDefinitionId?: string;
|
|
2551
2778
|
/** Ticket check-in. */
|
|
2552
2779
|
checkIn?: CheckIn;
|
|
@@ -2560,11 +2787,17 @@ export interface Ticket {
|
|
|
2560
2787
|
lastName?: string | null;
|
|
2561
2788
|
/** Guest email. */
|
|
2562
2789
|
email?: string | null;
|
|
2563
|
-
/**
|
|
2790
|
+
/**
|
|
2791
|
+
* Contact ID associated with this ticket.
|
|
2792
|
+
* @format GUID
|
|
2793
|
+
*/
|
|
2564
2794
|
contactId?: string | null;
|
|
2565
2795
|
/** Whether ticket is confirmed */
|
|
2566
2796
|
confirmed?: boolean;
|
|
2567
|
-
/**
|
|
2797
|
+
/**
|
|
2798
|
+
* Member ID associated with this ticket.
|
|
2799
|
+
* @format GUID
|
|
2800
|
+
*/
|
|
2568
2801
|
memberId?: string | null;
|
|
2569
2802
|
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
2570
2803
|
form?: FormResponse;
|
|
@@ -2574,7 +2807,10 @@ export interface Ticket {
|
|
|
2574
2807
|
anonymized?: boolean;
|
|
2575
2808
|
/** URL and password to online conference */
|
|
2576
2809
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
2577
|
-
/**
|
|
2810
|
+
/**
|
|
2811
|
+
* Seat ID associated with this ticket.
|
|
2812
|
+
* @maxLength 36
|
|
2813
|
+
*/
|
|
2578
2814
|
seatId?: string | null;
|
|
2579
2815
|
/** Whether ticket is canceled. */
|
|
2580
2816
|
canceled?: boolean | null;
|
|
@@ -2586,6 +2822,7 @@ export interface CheckIn {
|
|
|
2586
2822
|
export interface OnlineConferencingLogin {
|
|
2587
2823
|
/**
|
|
2588
2824
|
* Link URL to the online conference.
|
|
2825
|
+
* @format WEB_URL
|
|
2589
2826
|
* @readonly
|
|
2590
2827
|
*/
|
|
2591
2828
|
link?: string;
|
|
@@ -2628,9 +2865,16 @@ export interface Invoice {
|
|
|
2628
2865
|
previewUrl?: string | null;
|
|
2629
2866
|
}
|
|
2630
2867
|
export interface Item {
|
|
2631
|
-
/**
|
|
2868
|
+
/**
|
|
2869
|
+
* Unique line item ID.
|
|
2870
|
+
* @format GUID
|
|
2871
|
+
*/
|
|
2632
2872
|
_id?: string;
|
|
2633
|
-
/**
|
|
2873
|
+
/**
|
|
2874
|
+
* Line item quantity.
|
|
2875
|
+
* @min 1
|
|
2876
|
+
* @max 50
|
|
2877
|
+
*/
|
|
2634
2878
|
quantity?: number;
|
|
2635
2879
|
/** Line item name. */
|
|
2636
2880
|
name?: string;
|
|
@@ -2706,7 +2950,10 @@ export interface PaidPlanDiscountDiscountOneOf {
|
|
|
2706
2950
|
percentDiscount?: PercentDiscount;
|
|
2707
2951
|
}
|
|
2708
2952
|
export interface PercentDiscount {
|
|
2709
|
-
/**
|
|
2953
|
+
/**
|
|
2954
|
+
* Percent rate.
|
|
2955
|
+
* @decimalValue options - {gte:0.01,lte:100,maxScale:2}
|
|
2956
|
+
*/
|
|
2710
2957
|
rate?: string;
|
|
2711
2958
|
/** Number of discounted tickets. */
|
|
2712
2959
|
quantityDiscounted?: number;
|
|
@@ -2719,7 +2966,10 @@ export interface Tax {
|
|
|
2719
2966
|
* @readonly
|
|
2720
2967
|
*/
|
|
2721
2968
|
name?: string;
|
|
2722
|
-
/**
|
|
2969
|
+
/**
|
|
2970
|
+
* Tax rate.
|
|
2971
|
+
* @format DECIMAL_VALUE
|
|
2972
|
+
*/
|
|
2723
2973
|
rate?: string;
|
|
2724
2974
|
/** Taxable amount. */
|
|
2725
2975
|
taxable?: Money;
|
|
@@ -2733,6 +2983,7 @@ export interface Fee {
|
|
|
2733
2983
|
type?: FeeType;
|
|
2734
2984
|
/**
|
|
2735
2985
|
* Fee rate.
|
|
2986
|
+
* @format DECIMAL_VALUE
|
|
2736
2987
|
* @readonly
|
|
2737
2988
|
*/
|
|
2738
2989
|
rate?: string;
|
|
@@ -2755,19 +3006,37 @@ export declare enum FeeType {
|
|
|
2755
3006
|
export interface OrderEmailAdded {
|
|
2756
3007
|
/** Order updated timestamp in ISO UTC format. */
|
|
2757
3008
|
timestamp?: Date | null;
|
|
2758
|
-
/**
|
|
3009
|
+
/**
|
|
3010
|
+
* Site language when Order initiated
|
|
3011
|
+
* @format LANGUAGE
|
|
3012
|
+
*/
|
|
2759
3013
|
language?: string | null;
|
|
2760
|
-
/**
|
|
3014
|
+
/**
|
|
3015
|
+
* Locale in which Order was created.
|
|
3016
|
+
* @format LANGUAGE_TAG
|
|
3017
|
+
*/
|
|
2761
3018
|
locale?: string | null;
|
|
2762
3019
|
/** Notifications silenced for this domain event. */
|
|
2763
3020
|
silent?: boolean | null;
|
|
2764
|
-
/**
|
|
3021
|
+
/**
|
|
3022
|
+
* Event ID.
|
|
3023
|
+
* @format GUID
|
|
3024
|
+
*/
|
|
2765
3025
|
eventId?: string;
|
|
2766
|
-
/**
|
|
3026
|
+
/**
|
|
3027
|
+
* Unique order number.
|
|
3028
|
+
* @maxLength 36
|
|
3029
|
+
*/
|
|
2767
3030
|
orderNumber?: string;
|
|
2768
|
-
/**
|
|
3031
|
+
/**
|
|
3032
|
+
* Contact ID associated with this order.
|
|
3033
|
+
* @format GUID
|
|
3034
|
+
*/
|
|
2769
3035
|
contactId?: string | null;
|
|
2770
|
-
/**
|
|
3036
|
+
/**
|
|
3037
|
+
* Member ID associated with this order.
|
|
3038
|
+
* @format GUID
|
|
3039
|
+
*/
|
|
2771
3040
|
memberId?: string | null;
|
|
2772
3041
|
/**
|
|
2773
3042
|
* Order created timestamp.
|
|
@@ -2779,11 +3048,20 @@ export interface OrderEmailAdded {
|
|
|
2779
3048
|
* @readonly
|
|
2780
3049
|
*/
|
|
2781
3050
|
updated?: Date | null;
|
|
2782
|
-
/**
|
|
3051
|
+
/**
|
|
3052
|
+
* Buyer first name.
|
|
3053
|
+
* @maxLength 255
|
|
3054
|
+
*/
|
|
2783
3055
|
firstName?: string | null;
|
|
2784
|
-
/**
|
|
3056
|
+
/**
|
|
3057
|
+
* Buyer last name.
|
|
3058
|
+
* @maxLength 255
|
|
3059
|
+
*/
|
|
2785
3060
|
lastName?: string | null;
|
|
2786
|
-
/**
|
|
3061
|
+
/**
|
|
3062
|
+
* Buyer email.
|
|
3063
|
+
* @format EMAIL
|
|
3064
|
+
*/
|
|
2787
3065
|
email?: string | null;
|
|
2788
3066
|
/** Checkout form response. */
|
|
2789
3067
|
checkoutForm?: FormResponse;
|
|
@@ -2791,29 +3069,47 @@ export interface OrderEmailAdded {
|
|
|
2791
3069
|
confirmed?: boolean;
|
|
2792
3070
|
/** Order status. */
|
|
2793
3071
|
status?: OrderStatus;
|
|
2794
|
-
/**
|
|
3072
|
+
/**
|
|
3073
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3074
|
+
* @maxLength 100
|
|
3075
|
+
*/
|
|
2795
3076
|
method?: string | null;
|
|
2796
|
-
/**
|
|
3077
|
+
/**
|
|
3078
|
+
* Tickets generated after payment.
|
|
3079
|
+
* @maxSize 50
|
|
3080
|
+
*/
|
|
2797
3081
|
tickets?: Ticket[];
|
|
2798
3082
|
/** Whether order was archived and excluded from results. */
|
|
2799
3083
|
archived?: boolean;
|
|
2800
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Reservation ID associated with this order.
|
|
3086
|
+
* @format GUID
|
|
3087
|
+
*/
|
|
2801
3088
|
reservationId?: string;
|
|
2802
3089
|
}
|
|
2803
3090
|
export interface EventCanceled {
|
|
2804
3091
|
/** Event canceled timestamp in ISO UTC format. */
|
|
2805
3092
|
timestamp?: Date | null;
|
|
2806
|
-
/**
|
|
3093
|
+
/**
|
|
3094
|
+
* Event ID.
|
|
3095
|
+
* @format GUID
|
|
3096
|
+
*/
|
|
2807
3097
|
eventId?: string;
|
|
2808
3098
|
/** Event title */
|
|
2809
3099
|
title?: string;
|
|
2810
|
-
/**
|
|
3100
|
+
/**
|
|
3101
|
+
* Event creator user ID.
|
|
3102
|
+
* @format GUID
|
|
3103
|
+
*/
|
|
2811
3104
|
userId?: string | null;
|
|
2812
3105
|
}
|
|
2813
3106
|
export interface EventReminder {
|
|
2814
3107
|
/** Reminder timestamp in ISO UTC format. */
|
|
2815
3108
|
timestamp?: Date | null;
|
|
2816
|
-
/**
|
|
3109
|
+
/**
|
|
3110
|
+
* Event ID.
|
|
3111
|
+
* @format GUID
|
|
3112
|
+
*/
|
|
2817
3113
|
eventId?: string;
|
|
2818
3114
|
/** Event location. */
|
|
2819
3115
|
location?: Location;
|
|
@@ -2821,7 +3117,10 @@ export interface EventReminder {
|
|
|
2821
3117
|
scheduleConfig?: ScheduleConfig;
|
|
2822
3118
|
/** Event title. */
|
|
2823
3119
|
title?: string;
|
|
2824
|
-
/**
|
|
3120
|
+
/**
|
|
3121
|
+
* Event creator user ID.
|
|
3122
|
+
* @format GUID
|
|
3123
|
+
*/
|
|
2825
3124
|
userId?: string | null;
|
|
2826
3125
|
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
2827
3126
|
startsIn?: TimeDuration;
|
|
@@ -2833,86 +3132,164 @@ export interface EventReminder {
|
|
|
2833
3132
|
export interface TimeDuration {
|
|
2834
3133
|
/** Number of days. */
|
|
2835
3134
|
days?: number;
|
|
2836
|
-
/**
|
|
3135
|
+
/**
|
|
3136
|
+
* Number of hours.
|
|
3137
|
+
* @max 24
|
|
3138
|
+
*/
|
|
2837
3139
|
hours?: number;
|
|
2838
|
-
/**
|
|
3140
|
+
/**
|
|
3141
|
+
* Number of minutes.
|
|
3142
|
+
* @max 60
|
|
3143
|
+
*/
|
|
2839
3144
|
minutes?: number;
|
|
2840
3145
|
}
|
|
2841
3146
|
export interface OrderPaid {
|
|
2842
3147
|
/** Order paid timestamp in ISO UTC. */
|
|
2843
3148
|
timestamp?: Date | null;
|
|
2844
|
-
/**
|
|
3149
|
+
/**
|
|
3150
|
+
* Site language when Order initiated
|
|
3151
|
+
* @format LANGUAGE
|
|
3152
|
+
*/
|
|
2845
3153
|
language?: string | null;
|
|
2846
3154
|
/** Notifications silenced for this domain event. */
|
|
2847
3155
|
silent?: boolean | null;
|
|
2848
|
-
/**
|
|
3156
|
+
/**
|
|
3157
|
+
* Locale in which Order was created.
|
|
3158
|
+
* @format LANGUAGE_TAG
|
|
3159
|
+
*/
|
|
2849
3160
|
locale?: string | null;
|
|
2850
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* Event ID.
|
|
3163
|
+
* @format GUID
|
|
3164
|
+
*/
|
|
2851
3165
|
eventId?: string;
|
|
2852
3166
|
/** Unique order number. */
|
|
2853
3167
|
orderNumber?: string;
|
|
2854
3168
|
/** Reservation ID associated with this order. */
|
|
2855
3169
|
reservationId?: string;
|
|
2856
|
-
/**
|
|
3170
|
+
/**
|
|
3171
|
+
* Contact ID associated with this order.
|
|
3172
|
+
* @maxLength 36
|
|
3173
|
+
*/
|
|
2857
3174
|
contactId?: string;
|
|
2858
|
-
/**
|
|
3175
|
+
/**
|
|
3176
|
+
* Member ID associated with this order.
|
|
3177
|
+
* @format GUID
|
|
3178
|
+
*/
|
|
2859
3179
|
memberId?: string | null;
|
|
2860
3180
|
/**
|
|
2861
3181
|
* Order created timestamp
|
|
2862
3182
|
* @readonly
|
|
2863
3183
|
*/
|
|
2864
3184
|
created?: Date | null;
|
|
2865
|
-
/**
|
|
3185
|
+
/**
|
|
3186
|
+
* Buyer first name.
|
|
3187
|
+
* @maxLength 255
|
|
3188
|
+
*/
|
|
2866
3189
|
firstName?: string;
|
|
2867
|
-
/**
|
|
3190
|
+
/**
|
|
3191
|
+
* Buyer last name.
|
|
3192
|
+
* @maxLength 255
|
|
3193
|
+
*/
|
|
2868
3194
|
lastName?: string;
|
|
2869
|
-
/**
|
|
3195
|
+
/**
|
|
3196
|
+
* Buyer email address.
|
|
3197
|
+
* @maxLength 255
|
|
3198
|
+
*/
|
|
2870
3199
|
email?: string;
|
|
2871
3200
|
/** Checkout form response. */
|
|
2872
3201
|
checkoutForm?: FormResponse;
|
|
2873
3202
|
/** Order status. */
|
|
2874
3203
|
status?: OrderStatus;
|
|
2875
|
-
/**
|
|
3204
|
+
/**
|
|
3205
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3206
|
+
* @maxLength 255
|
|
3207
|
+
*/
|
|
2876
3208
|
method?: string | null;
|
|
2877
|
-
/**
|
|
3209
|
+
/**
|
|
3210
|
+
* Tickets (generated after payment).
|
|
3211
|
+
* @maxSize 50
|
|
3212
|
+
*/
|
|
2878
3213
|
tickets?: Ticket[];
|
|
2879
3214
|
/** Invoice. */
|
|
2880
3215
|
invoice?: Invoice;
|
|
2881
3216
|
}
|
|
2882
3217
|
export interface TicketPdfResolved {
|
|
2883
|
-
/**
|
|
3218
|
+
/**
|
|
3219
|
+
* Optional order number
|
|
3220
|
+
* @maxLength 36
|
|
3221
|
+
*/
|
|
2884
3222
|
orderNumber?: string | null;
|
|
2885
|
-
/**
|
|
3223
|
+
/**
|
|
3224
|
+
* Optional ticket number
|
|
3225
|
+
* @maxLength 36
|
|
3226
|
+
*/
|
|
2886
3227
|
ticketNumber?: string | null;
|
|
2887
|
-
/**
|
|
3228
|
+
/**
|
|
3229
|
+
* Resolved download url
|
|
3230
|
+
* @format WEB_URL
|
|
3231
|
+
*/
|
|
2888
3232
|
downloadUrl?: string | null;
|
|
2889
3233
|
/** Resolve status */
|
|
2890
3234
|
resolveFailed?: boolean | null;
|
|
2891
|
-
/**
|
|
3235
|
+
/**
|
|
3236
|
+
* Papyrus document id
|
|
3237
|
+
* @format GUID
|
|
3238
|
+
*/
|
|
2892
3239
|
documentId?: string | null;
|
|
2893
3240
|
}
|
|
2894
3241
|
export interface TicketPdfResolveDelayed {
|
|
2895
|
-
/**
|
|
3242
|
+
/**
|
|
3243
|
+
* Optional order number
|
|
3244
|
+
* @maxLength 36
|
|
3245
|
+
*/
|
|
2896
3246
|
orderNumber?: string | null;
|
|
2897
|
-
/**
|
|
3247
|
+
/**
|
|
3248
|
+
* Optional ticket number
|
|
3249
|
+
* @maxLength 36
|
|
3250
|
+
*/
|
|
2898
3251
|
ticketNumber?: string | null;
|
|
2899
|
-
/**
|
|
3252
|
+
/**
|
|
3253
|
+
* Papyrus document id
|
|
3254
|
+
* @format GUID
|
|
3255
|
+
*/
|
|
2900
3256
|
documentId?: string | null;
|
|
2901
3257
|
}
|
|
2902
3258
|
export interface OrderCanceled {
|
|
2903
|
-
/**
|
|
3259
|
+
/**
|
|
3260
|
+
* Event ID.
|
|
3261
|
+
* @format GUID
|
|
3262
|
+
*/
|
|
2904
3263
|
eventId?: string;
|
|
2905
|
-
/**
|
|
3264
|
+
/**
|
|
3265
|
+
* Unique order number.
|
|
3266
|
+
* @maxLength 36
|
|
3267
|
+
*/
|
|
2906
3268
|
orderNumber?: string;
|
|
2907
|
-
/**
|
|
3269
|
+
/**
|
|
3270
|
+
* Reservation ID associated with this order.
|
|
3271
|
+
* @format GUID
|
|
3272
|
+
*/
|
|
2908
3273
|
reservationId?: string;
|
|
2909
|
-
/**
|
|
3274
|
+
/**
|
|
3275
|
+
* Contact ID associated with this order.
|
|
3276
|
+
* @maxLength 36
|
|
3277
|
+
*/
|
|
2910
3278
|
contactId?: string;
|
|
2911
|
-
/**
|
|
3279
|
+
/**
|
|
3280
|
+
* Buyer first name.
|
|
3281
|
+
* @maxLength 50
|
|
3282
|
+
*/
|
|
2912
3283
|
firstName?: string | null;
|
|
2913
|
-
/**
|
|
3284
|
+
/**
|
|
3285
|
+
* Buyer last name.
|
|
3286
|
+
* @maxLength 50
|
|
3287
|
+
*/
|
|
2914
3288
|
lastName?: string | null;
|
|
2915
|
-
/**
|
|
3289
|
+
/**
|
|
3290
|
+
* Buyer email address.
|
|
3291
|
+
* @maxLength 255
|
|
3292
|
+
*/
|
|
2916
3293
|
email?: string | null;
|
|
2917
3294
|
/** Checkout form response. */
|
|
2918
3295
|
checkoutForm?: FormResponse;
|
|
@@ -2922,17 +3299,26 @@ export interface OrderCanceled {
|
|
|
2922
3299
|
export interface EventEnded {
|
|
2923
3300
|
/** Event end timestamp in ISO UTC format. */
|
|
2924
3301
|
timestamp?: Date | null;
|
|
2925
|
-
/**
|
|
3302
|
+
/**
|
|
3303
|
+
* Event ID.
|
|
3304
|
+
* @format GUID
|
|
3305
|
+
*/
|
|
2926
3306
|
eventId?: string;
|
|
2927
3307
|
}
|
|
2928
3308
|
export interface EventStarted {
|
|
2929
3309
|
/** Event start timestamp in ISO UTC format. */
|
|
2930
3310
|
timestamp?: Date | null;
|
|
2931
|
-
/**
|
|
3311
|
+
/**
|
|
3312
|
+
* Event ID.
|
|
3313
|
+
* @format GUID
|
|
3314
|
+
*/
|
|
2932
3315
|
eventId?: string;
|
|
2933
3316
|
}
|
|
2934
3317
|
export interface ResolveNotificationConfigRequest {
|
|
2935
|
-
/**
|
|
3318
|
+
/**
|
|
3319
|
+
* Id of the NotificationConfig to retrieve
|
|
3320
|
+
* @format GUID
|
|
3321
|
+
*/
|
|
2936
3322
|
notificationConfigId: string;
|
|
2937
3323
|
}
|
|
2938
3324
|
export interface ResolveNotificationConfigResponse {
|
|
@@ -2948,7 +3334,10 @@ export interface UpsertNotificationConfigResponse {
|
|
|
2948
3334
|
notificationConfig?: NotificationConfig;
|
|
2949
3335
|
}
|
|
2950
3336
|
export interface ResolveEmailNotificationConfigRequest {
|
|
2951
|
-
/**
|
|
3337
|
+
/**
|
|
3338
|
+
* Id of the NotificationConfig to retrieve
|
|
3339
|
+
* @format GUID
|
|
3340
|
+
*/
|
|
2952
3341
|
notificationConfigId?: string;
|
|
2953
3342
|
/** Notification type */
|
|
2954
3343
|
notificationType?: EmailNotificationType;
|
|
@@ -2960,17 +3349,26 @@ export interface ResolveEmailNotificationConfigResponse {
|
|
|
2960
3349
|
export interface EventDeleted {
|
|
2961
3350
|
/** Event deleted timestamp in ISO UTC format. */
|
|
2962
3351
|
timestamp?: Date | null;
|
|
2963
|
-
/**
|
|
3352
|
+
/**
|
|
3353
|
+
* Event ID.
|
|
3354
|
+
* @format GUID
|
|
3355
|
+
*/
|
|
2964
3356
|
eventId?: string;
|
|
2965
3357
|
/** Event title. */
|
|
2966
3358
|
title?: string;
|
|
2967
|
-
/**
|
|
3359
|
+
/**
|
|
3360
|
+
* Event creator user ID.
|
|
3361
|
+
* @format GUID
|
|
3362
|
+
*/
|
|
2968
3363
|
userId?: string | null;
|
|
2969
3364
|
}
|
|
2970
3365
|
export interface EventCopied {
|
|
2971
3366
|
/** Event created timestamp in ISO UTC format. */
|
|
2972
3367
|
timestamp?: Date | null;
|
|
2973
|
-
/**
|
|
3368
|
+
/**
|
|
3369
|
+
* Event ID.
|
|
3370
|
+
* @format GUID
|
|
3371
|
+
*/
|
|
2974
3372
|
eventId?: string;
|
|
2975
3373
|
/** Event location. */
|
|
2976
3374
|
location?: Location;
|
|
@@ -2978,13 +3376,22 @@ export interface EventCopied {
|
|
|
2978
3376
|
scheduleConfig?: ScheduleConfig;
|
|
2979
3377
|
/** Event title. */
|
|
2980
3378
|
title?: string;
|
|
2981
|
-
/**
|
|
3379
|
+
/**
|
|
3380
|
+
* Event creator user ID.
|
|
3381
|
+
* @format GUID
|
|
3382
|
+
*/
|
|
2982
3383
|
userId?: string | null;
|
|
2983
3384
|
/** Event status. */
|
|
2984
3385
|
status?: EventStatus;
|
|
2985
|
-
/**
|
|
3386
|
+
/**
|
|
3387
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3388
|
+
* @format GUID
|
|
3389
|
+
*/
|
|
2986
3390
|
derivedFromInstanceId?: string | null;
|
|
2987
|
-
/**
|
|
3391
|
+
/**
|
|
3392
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3393
|
+
* @format GUID
|
|
3394
|
+
*/
|
|
2988
3395
|
derivedFromEventId?: string | null;
|
|
2989
3396
|
/**
|
|
2990
3397
|
* Map of copied ticket definitions from original event.
|
|
@@ -2994,9 +3401,15 @@ export interface EventCopied {
|
|
|
2994
3401
|
ticketDefinitions?: Record<string, string>;
|
|
2995
3402
|
}
|
|
2996
3403
|
export interface MessageEnvelope {
|
|
2997
|
-
/**
|
|
3404
|
+
/**
|
|
3405
|
+
* App instance ID.
|
|
3406
|
+
* @format GUID
|
|
3407
|
+
*/
|
|
2998
3408
|
instanceId?: string | null;
|
|
2999
|
-
/**
|
|
3409
|
+
/**
|
|
3410
|
+
* Event type.
|
|
3411
|
+
* @maxLength 150
|
|
3412
|
+
*/
|
|
3000
3413
|
eventType?: string;
|
|
3001
3414
|
/** The identification type and identity data. */
|
|
3002
3415
|
identity?: IdentificationData;
|
|
@@ -3004,26 +3417,50 @@ export interface MessageEnvelope {
|
|
|
3004
3417
|
data?: string;
|
|
3005
3418
|
}
|
|
3006
3419
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3007
|
-
/**
|
|
3420
|
+
/**
|
|
3421
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3422
|
+
* @format GUID
|
|
3423
|
+
*/
|
|
3008
3424
|
anonymousVisitorId?: string;
|
|
3009
|
-
/**
|
|
3425
|
+
/**
|
|
3426
|
+
* ID of a site visitor that has logged in to the site.
|
|
3427
|
+
* @format GUID
|
|
3428
|
+
*/
|
|
3010
3429
|
memberId?: string;
|
|
3011
|
-
/**
|
|
3430
|
+
/**
|
|
3431
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3432
|
+
* @format GUID
|
|
3433
|
+
*/
|
|
3012
3434
|
wixUserId?: string;
|
|
3013
|
-
/**
|
|
3435
|
+
/**
|
|
3436
|
+
* ID of an app.
|
|
3437
|
+
* @format GUID
|
|
3438
|
+
*/
|
|
3014
3439
|
appId?: string;
|
|
3015
3440
|
/** @readonly */
|
|
3016
3441
|
identityType?: WebhookIdentityType;
|
|
3017
3442
|
}
|
|
3018
3443
|
/** @oneof */
|
|
3019
3444
|
export interface IdentificationDataIdOneOf {
|
|
3020
|
-
/**
|
|
3445
|
+
/**
|
|
3446
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3447
|
+
* @format GUID
|
|
3448
|
+
*/
|
|
3021
3449
|
anonymousVisitorId?: string;
|
|
3022
|
-
/**
|
|
3450
|
+
/**
|
|
3451
|
+
* ID of a site visitor that has logged in to the site.
|
|
3452
|
+
* @format GUID
|
|
3453
|
+
*/
|
|
3023
3454
|
memberId?: string;
|
|
3024
|
-
/**
|
|
3455
|
+
/**
|
|
3456
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3457
|
+
* @format GUID
|
|
3458
|
+
*/
|
|
3025
3459
|
wixUserId?: string;
|
|
3026
|
-
/**
|
|
3460
|
+
/**
|
|
3461
|
+
* ID of an app.
|
|
3462
|
+
* @format GUID
|
|
3463
|
+
*/
|
|
3027
3464
|
appId?: string;
|
|
3028
3465
|
}
|
|
3029
3466
|
export declare enum WebhookIdentityType {
|
|
@@ -3054,9 +3491,15 @@ export interface UpsertNotificationConfigResponseNonNullableFields {
|
|
|
3054
3491
|
notificationConfig?: NotificationConfigNonNullableFields;
|
|
3055
3492
|
}
|
|
3056
3493
|
export interface BaseEventMetadata {
|
|
3057
|
-
/**
|
|
3494
|
+
/**
|
|
3495
|
+
* App instance ID.
|
|
3496
|
+
* @format GUID
|
|
3497
|
+
*/
|
|
3058
3498
|
instanceId?: string | null;
|
|
3059
|
-
/**
|
|
3499
|
+
/**
|
|
3500
|
+
* Event type.
|
|
3501
|
+
* @maxLength 150
|
|
3502
|
+
*/
|
|
3060
3503
|
eventType?: string;
|
|
3061
3504
|
/** The identification type and identity data. */
|
|
3062
3505
|
identity?: IdentificationData;
|
|
@@ -3160,7 +3603,7 @@ export declare function onNotificationConfigUpdated(handler: (event: Notificatio
|
|
|
3160
3603
|
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
3161
3604
|
*/
|
|
3162
3605
|
export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
|
|
3163
|
-
export interface TriggerNotificationOptions extends
|
|
3606
|
+
export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
3164
3607
|
/** Email notification type */
|
|
3165
3608
|
emailNotificationType?: EmailNotificationType;
|
|
3166
3609
|
/** Push notification type */
|
|
@@ -3174,6 +3617,24 @@ export interface TriggerNotificationOptions extends TriggerNotificationRequestNo
|
|
|
3174
3617
|
/** Ticket guests info */
|
|
3175
3618
|
ticketGuest?: TicketGuest;
|
|
3176
3619
|
}
|
|
3620
|
+
/** @oneof */
|
|
3621
|
+
interface TriggerNotificationOptionsNotificationOneOf {
|
|
3622
|
+
/** Email notification type */
|
|
3623
|
+
emailNotificationType?: EmailNotificationType;
|
|
3624
|
+
/** Push notification type */
|
|
3625
|
+
pushNotificationType?: PushNotificationType;
|
|
3626
|
+
}
|
|
3627
|
+
/** @oneof */
|
|
3628
|
+
interface TriggerNotificationOptionsGuestsOneOf {
|
|
3629
|
+
/** Rsvp guest info */
|
|
3630
|
+
rsvpGuest?: RsvpGuest;
|
|
3631
|
+
/** Order guest info */
|
|
3632
|
+
orderGuest?: OrderGuest;
|
|
3633
|
+
/** Event guests info */
|
|
3634
|
+
eventGuests?: EventGuests;
|
|
3635
|
+
/** Ticket guests info */
|
|
3636
|
+
ticketGuest?: TicketGuest;
|
|
3637
|
+
}
|
|
3177
3638
|
/**
|
|
3178
3639
|
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
3179
3640
|
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
@@ -3216,9 +3677,16 @@ export declare function resolveNotificationConfig(notificationConfigId: string):
|
|
|
3216
3677
|
*/
|
|
3217
3678
|
export declare function upsertNotificationConfig(_id: string | null, notificationConfig: UpsertNotificationConfig): Promise<UpsertNotificationConfigResponse & UpsertNotificationConfigResponseNonNullableFields>;
|
|
3218
3679
|
export interface UpsertNotificationConfig {
|
|
3219
|
-
/**
|
|
3680
|
+
/**
|
|
3681
|
+
* Event ID.
|
|
3682
|
+
* @format GUID
|
|
3683
|
+
* @immutable
|
|
3684
|
+
*/
|
|
3220
3685
|
_id?: string | null;
|
|
3221
|
-
/**
|
|
3686
|
+
/**
|
|
3687
|
+
* 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.
|
|
3688
|
+
* @immutable
|
|
3689
|
+
*/
|
|
3222
3690
|
revision?: string | null;
|
|
3223
3691
|
/**
|
|
3224
3692
|
* Represents the time this NotificationConfig was created.
|