@wix/auto_sdk_events_notifications 1.0.2 → 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.
Files changed (37) hide show
  1. package/build/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
  2. package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
  3. package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
  4. package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +582 -136
  5. package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js +1 -1
  6. package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
  7. package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +624 -140
  8. package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +8 -1
  9. package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
  10. package/build/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
  11. package/build/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
  12. package/build/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
  13. package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +582 -136
  14. package/build/es/src/events-notifications-v2-notification-config-notifications.types.js +1 -1
  15. package/build/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
  16. package/build/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +624 -140
  17. package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js +8 -1
  18. package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
  19. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
  20. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
  21. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
  22. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +582 -136
  23. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js +1 -1
  24. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
  25. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +624 -140
  26. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +8 -1
  27. package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
  28. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.context.d.ts +1 -1
  29. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
  30. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
  31. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +582 -136
  32. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js +1 -1
  33. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
  34. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +624 -140
  35. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js +8 -1
  36. package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
  37. package/package.json +2 -2
@@ -1,7 +1,14 @@
1
1
  export interface NotificationConfig {
2
- /** Event ID. */
2
+ /**
3
+ * Event ID.
4
+ * @format GUID
5
+ * @immutable
6
+ */
3
7
  _id?: string | null;
4
- /** 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. */
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
- /** Email subject. */
75
+ /**
76
+ * Email subject.
77
+ * @minLength 1
78
+ * @maxLength 100
79
+ */
69
80
  subject?: string | null;
70
- /** Plain text message body. */
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
- /** Text of the link. */
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
- /** Event id */
167
+ /**
168
+ * Event id
169
+ * @format GUID
170
+ */
150
171
  eventId?: string;
151
- /** Rsvp id */
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
- /** Event id */
180
+ /**
181
+ * Event id
182
+ * @format GUID
183
+ */
157
184
  eventId?: string;
158
- /** Order number */
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
- /** Event id */
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
- /** Event id */
201
+ /**
202
+ * Event id
203
+ * @format GUID
204
+ */
169
205
  eventId?: string;
170
- /** Order number */
206
+ /**
207
+ * Order number
208
+ * @maxLength 36
209
+ */
171
210
  orderNumber?: string | null;
172
- /** Ticket numbers must be from the same order only. */
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
- /** Event ID. */
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
- /** Location name. */
316
+ /**
317
+ * Location name.
318
+ * @maxLength 50
319
+ */
270
320
  name?: string | null;
271
321
  /** Location map coordinates. */
272
322
  coordinates?: MapCoordinates;
273
- /** Single line address representation. */
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
- /** Latitude. */
348
+ /**
349
+ * Latitude.
350
+ * @min -90
351
+ * @max 90
352
+ */
296
353
  lat?: number;
297
- /** Longitude. */
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
- /** country code */
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
- /** multi-level subdivisions from top to bottom */
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
- /** address latitude coordinates */
410
+ /**
411
+ * address latitude coordinates
412
+ * @min -90
413
+ * @max 90
414
+ */
344
415
  latitude?: number | null;
345
- /** address longitude coordinates */
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
- /** TBD message. */
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
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
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
- /** Event occurrences. */
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
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
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
- /** Event creator user ID. */
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;
@@ -484,6 +575,11 @@ export interface Event {
484
575
  eventDisplaySettings?: EventDisplaySettings;
485
576
  /** Rich content displayed in Wix UI - "About Event" section. Successor to `about` field. */
486
577
  longDescription?: RichContent;
578
+ /**
579
+ * Event publish timestamp.
580
+ * @readonly
581
+ */
582
+ publishedDate?: Date | null;
487
583
  }
488
584
  export interface Scheduling {
489
585
  /** Schedule configuration. */
@@ -626,17 +722,31 @@ export interface TicketingConfig {
626
722
  guestAssignedTickets?: boolean;
627
723
  /** Tax configuration. */
628
724
  taxConfig?: TaxConfig;
629
- /** Limit of tickets that can be purchased per order, default 20. */
725
+ /**
726
+ * Limit of tickets that can be purchased per order, default 20.
727
+ * @max 50
728
+ */
630
729
  ticketLimitPerOrder?: number;
631
- /** Duration for which the tickets being bought are reserved. */
730
+ /**
731
+ * Duration for which the tickets being bought are reserved.
732
+ * @min 5
733
+ * @max 30
734
+ */
632
735
  reservationDurationInMinutes?: number | null;
633
736
  }
634
737
  export interface TaxConfig {
635
738
  /** Tax application settings. */
636
739
  type?: TaxType;
637
- /** Tax name. */
740
+ /**
741
+ * Tax name.
742
+ * @minLength 1
743
+ * @maxLength 10
744
+ */
638
745
  name?: string | null;
639
- /** Tax rate (e.g.,`21.55`). */
746
+ /**
747
+ * Tax rate (e.g.,`21.55`).
748
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
749
+ */
640
750
  rate?: string | null;
641
751
  /** Applies taxes for donations, default true. */
642
752
  appliesToDonations?: boolean | null;
@@ -652,12 +762,19 @@ export declare enum TaxType {
652
762
  export interface Money {
653
763
  /**
654
764
  * *Deprecated:** Use `value` instead.
765
+ * @format DECIMAL_VALUE
655
766
  * @deprecated
656
767
  */
657
768
  amount?: string;
658
- /** ISO 4217 format of the currency e.g., `USD`. */
769
+ /**
770
+ * ISO 4217 format of the currency e.g., `USD`.
771
+ * @format CURRENCY
772
+ */
659
773
  currency?: string;
660
- /** 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. */
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
+ */
661
778
  value?: string | null;
662
779
  }
663
780
  export interface ExternalEvent {
@@ -812,21 +929,29 @@ export declare enum ValueType {
812
929
  * Defaults to first (0th) option if not configured.
813
930
  */
814
931
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
815
- /** 0-based index from predefined `input.options` which is selected initially. */
932
+ /**
933
+ * 0-based index from predefined `input.options` which is selected initially.
934
+ * @max 199
935
+ */
816
936
  optionIndex?: number;
817
937
  /**
818
938
  * Placeholder hint describing expected choices (such as "Please select").
819
939
  * Considered an empty choice.
940
+ * @maxLength 200
820
941
  */
821
942
  placeholderText?: string;
822
943
  }
823
944
  /** @oneof */
824
945
  export interface OptionSelectionSelectedOptionOneOf {
825
- /** 0-based index from predefined `input.options` which is selected initially. */
946
+ /**
947
+ * 0-based index from predefined `input.options` which is selected initially.
948
+ * @max 199
949
+ */
826
950
  optionIndex?: number;
827
951
  /**
828
952
  * Placeholder hint describing expected choices (such as "Please select").
829
953
  * Considered an empty choice.
954
+ * @maxLength 200
830
955
  */
831
956
  placeholderText?: string;
832
957
  }
@@ -981,7 +1106,10 @@ export interface OnlineConferencingConfig {
981
1106
  * When enabled, links to join conferencing are generated and provided to guests.
982
1107
  */
983
1108
  enabled?: boolean;
984
- /** Conferencing provider ID. */
1109
+ /**
1110
+ * Conferencing provider ID.
1111
+ * @format GUID
1112
+ */
985
1113
  providerId?: string | null;
986
1114
  /** Conference type */
987
1115
  conferenceType?: ConferenceType;
@@ -1020,7 +1148,10 @@ export interface OnlineConferencingSession {
1020
1148
  sessionId?: string | null;
1021
1149
  }
1022
1150
  export interface SeoSettings {
1023
- /** URL slug */
1151
+ /**
1152
+ * URL slug
1153
+ * @maxLength 130
1154
+ */
1024
1155
  slug?: string;
1025
1156
  /** Advanced SEO data */
1026
1157
  advancedSeoData?: SeoSchema;
@@ -1046,7 +1177,10 @@ export interface Keyword {
1046
1177
  term?: string;
1047
1178
  /** Whether the keyword is the main focus keyword. */
1048
1179
  isMain?: boolean;
1049
- /** The source that added the keyword terms to the SEO settings. */
1180
+ /**
1181
+ * The source that added the keyword terms to the SEO settings.
1182
+ * @maxLength 1000
1183
+ */
1050
1184
  origin?: string | null;
1051
1185
  }
1052
1186
  export interface Tag {
@@ -1079,7 +1213,10 @@ export interface Settings {
1079
1213
  * Default: `false` (Auto Redirect is enabled.)
1080
1214
  */
1081
1215
  preventAutoRedirect?: boolean;
1082
- /** User-selected keyword terms for a specific page. */
1216
+ /**
1217
+ * User-selected keyword terms for a specific page.
1218
+ * @maxSize 5
1219
+ */
1083
1220
  keywords?: Keyword[];
1084
1221
  }
1085
1222
  export interface Agenda {
@@ -1094,10 +1231,15 @@ export interface Agenda {
1094
1231
  export interface Category {
1095
1232
  /**
1096
1233
  * Category ID.
1234
+ * @format GUID
1097
1235
  * @readonly
1098
1236
  */
1099
1237
  _id?: string;
1100
- /** Category name. */
1238
+ /**
1239
+ * Category name.
1240
+ * @minLength 1
1241
+ * @maxLength 30
1242
+ */
1101
1243
  name?: string;
1102
1244
  /**
1103
1245
  * Date and time when category was created.
@@ -1120,6 +1262,7 @@ export interface Category {
1120
1262
  * Default: `MANUAL`.
1121
1263
  *
1122
1264
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1265
+ * @maxSize 3
1123
1266
  */
1124
1267
  states?: State[];
1125
1268
  }
@@ -1741,19 +1884,28 @@ export interface GIFData {
1741
1884
  height?: number;
1742
1885
  /** Width in pixels. */
1743
1886
  width?: number;
1744
- /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
1887
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
1745
1888
  gifType?: GIFType;
1746
1889
  }
1747
1890
  export interface GIF {
1748
- /** GIF format URL. */
1891
+ /**
1892
+ * GIF format URL.
1893
+ * @format WEB_URL
1894
+ */
1749
1895
  gif?: string | null;
1750
- /** MP4 format URL. */
1896
+ /**
1897
+ * MP4 format URL.
1898
+ * @format WEB_URL
1899
+ */
1751
1900
  mp4?: string | null;
1752
- /** Thumbnail URL. */
1901
+ /**
1902
+ * Thumbnail URL.
1903
+ * @format WEB_URL
1904
+ */
1753
1905
  still?: string | null;
1754
1906
  }
1755
1907
  export declare enum GIFType {
1756
- GIF = "GIF",
1908
+ NORMAL = "NORMAL",
1757
1909
  STICKER = "STICKER"
1758
1910
  }
1759
1911
  export interface HeadingData {
@@ -1815,6 +1967,22 @@ export interface ImageData {
1815
1967
  caption?: string | null;
1816
1968
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1817
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;
1818
1986
  }
1819
1987
  export interface LinkPreviewData {
1820
1988
  /** Styling for the link preview's container. */
@@ -1961,13 +2129,22 @@ export declare enum BackgroundType {
1961
2129
  export interface Gradient {
1962
2130
  /** The gradient angle in degrees. */
1963
2131
  angle?: number | null;
1964
- /** The start color as a hexademical value. */
2132
+ /**
2133
+ * The start color as a hexademical value.
2134
+ * @format COLOR_HEX
2135
+ */
1965
2136
  startColor?: string | null;
1966
- /** The end color as a hexademical value. */
2137
+ /**
2138
+ * The end color as a hexademical value.
2139
+ * @format COLOR_HEX
2140
+ */
1967
2141
  lastColor?: string | null;
1968
2142
  }
1969
2143
  export interface Background extends BackgroundBackgroundOneOf {
1970
- /** The background color as a hexademical value. */
2144
+ /**
2145
+ * The background color as a hexademical value.
2146
+ * @format COLOR_HEX
2147
+ */
1971
2148
  color?: string | null;
1972
2149
  /** An image to use for the background. */
1973
2150
  image?: Media;
@@ -1978,7 +2155,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1978
2155
  }
1979
2156
  /** @oneof */
1980
2157
  export interface BackgroundBackgroundOneOf {
1981
- /** The background color as a hexademical value. */
2158
+ /**
2159
+ * The background color as a hexademical value.
2160
+ * @format COLOR_HEX
2161
+ */
1982
2162
  color?: string | null;
1983
2163
  /** An image to use for the background. */
1984
2164
  image?: Media;
@@ -2290,17 +2470,32 @@ export declare enum VerticalAlignment {
2290
2470
  export interface CellStyle {
2291
2471
  /** Vertical alignment for the cell's text. */
2292
2472
  verticalAlignment?: VerticalAlignment;
2293
- /** Cell background color as a hexadecimal value. */
2473
+ /**
2474
+ * Cell background color as a hexadecimal value.
2475
+ * @format COLOR_HEX
2476
+ */
2294
2477
  backgroundColor?: string | null;
2295
2478
  }
2296
2479
  export interface BorderColors {
2297
- /** Left border color as a hexadecimal value. */
2480
+ /**
2481
+ * Left border color as a hexadecimal value.
2482
+ * @format COLOR_HEX
2483
+ */
2298
2484
  left?: string | null;
2299
- /** Right border color as a hexadecimal value. */
2485
+ /**
2486
+ * Right border color as a hexadecimal value.
2487
+ * @format COLOR_HEX
2488
+ */
2300
2489
  right?: string | null;
2301
- /** Top border color as a hexadecimal value. */
2490
+ /**
2491
+ * Top border color as a hexadecimal value.
2492
+ * @format COLOR_HEX
2493
+ */
2302
2494
  top?: string | null;
2303
- /** Bottom border color as a hexadecimal value. */
2495
+ /**
2496
+ * Bottom border color as a hexadecimal value.
2497
+ * @format COLOR_HEX
2498
+ */
2304
2499
  bottom?: string | null;
2305
2500
  }
2306
2501
  /**
@@ -2411,19 +2606,31 @@ export interface TextNodeStyle {
2411
2606
  export interface OrderConfirmed {
2412
2607
  /** Order confirmation timestamp in ISO UTC. */
2413
2608
  timestamp?: Date | null;
2414
- /** Site language when Order initiated */
2609
+ /**
2610
+ * Site language when Order initiated
2611
+ * @format LANGUAGE
2612
+ */
2415
2613
  language?: string | null;
2416
2614
  /** Notifications silenced for this domain event. */
2417
2615
  silent?: boolean | null;
2418
- /** Locale in which Order was created. */
2616
+ /**
2617
+ * Locale in which Order was created.
2618
+ * @format LANGUAGE_TAG
2619
+ */
2419
2620
  locale?: string | null;
2420
- /** Event ID. */
2621
+ /**
2622
+ * Event ID.
2623
+ * @format GUID
2624
+ */
2421
2625
  eventId?: string;
2422
2626
  /** Unique order number. */
2423
2627
  orderNumber?: string;
2424
2628
  /** Contact ID associated with this order. */
2425
2629
  contactId?: string;
2426
- /** Member ID associated with this order. */
2630
+ /**
2631
+ * Member ID associated with this order.
2632
+ * @format GUID
2633
+ */
2427
2634
  memberId?: string | null;
2428
2635
  /**
2429
2636
  * Order created timestamp
@@ -2450,19 +2657,35 @@ export interface OrderConfirmed {
2450
2657
  reservationId?: string;
2451
2658
  }
2452
2659
  export interface FormResponse {
2453
- /** Input values entered when filling the form. */
2660
+ /**
2661
+ * Input values entered when filling the form.
2662
+ * @maxSize 200
2663
+ */
2454
2664
  inputValues?: InputValue[];
2455
2665
  }
2456
2666
  export interface InputValue {
2457
- /** Input field name. */
2667
+ /**
2668
+ * Input field name.
2669
+ * @maxLength 100
2670
+ */
2458
2671
  inputName?: string;
2459
- /** Text entered into the input field. */
2672
+ /**
2673
+ * Text entered into the input field.
2674
+ * @maxLength 5000
2675
+ */
2460
2676
  value?: string;
2461
- /** Multiple selection values. For example, the array is filled if several checkboxes are ticked. */
2677
+ /**
2678
+ * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
2679
+ * @maxSize 100
2680
+ * @maxLength 5000
2681
+ */
2462
2682
  values?: string[];
2463
2683
  }
2464
2684
  export interface FormattedAddress {
2465
- /** One line address representation. */
2685
+ /**
2686
+ * One line address representation.
2687
+ * @maxLength 200
2688
+ */
2466
2689
  formatted?: string;
2467
2690
  /** Address components (optional). */
2468
2691
  address?: CommonAddress;
@@ -2473,7 +2696,10 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
2473
2696
  streetAddress?: CommonStreetAddress;
2474
2697
  /** Main address line, usually street and number as free text. */
2475
2698
  addressLine1?: string | null;
2476
- /** Country code. */
2699
+ /**
2700
+ * Country code.
2701
+ * @format COUNTRY
2702
+ */
2477
2703
  country?: string | null;
2478
2704
  /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
2479
2705
  subdivision?: string | null;
@@ -2511,7 +2737,10 @@ export interface CommonSubdivision {
2511
2737
  }
2512
2738
  /** Subdivision Concordance values */
2513
2739
  export interface StandardDetails {
2514
- /** 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 */
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
+ */
2515
2744
  iso31662?: string | null;
2516
2745
  }
2517
2746
  export declare enum OrderStatus {
@@ -2541,7 +2770,10 @@ export declare enum OrderStatus {
2541
2770
  export interface Ticket {
2542
2771
  /** Unique issued ticket number. */
2543
2772
  ticketNumber?: string;
2544
- /** Ticket definition ID. */
2773
+ /**
2774
+ * Ticket definition ID.
2775
+ * @format GUID
2776
+ */
2545
2777
  ticketDefinitionId?: string;
2546
2778
  /** Ticket check-in. */
2547
2779
  checkIn?: CheckIn;
@@ -2555,11 +2787,17 @@ export interface Ticket {
2555
2787
  lastName?: string | null;
2556
2788
  /** Guest email. */
2557
2789
  email?: string | null;
2558
- /** Contact ID associated with this ticket. */
2790
+ /**
2791
+ * Contact ID associated with this ticket.
2792
+ * @format GUID
2793
+ */
2559
2794
  contactId?: string | null;
2560
2795
  /** Whether ticket is confirmed */
2561
2796
  confirmed?: boolean;
2562
- /** Member ID associated with this ticket. */
2797
+ /**
2798
+ * Member ID associated with this ticket.
2799
+ * @format GUID
2800
+ */
2563
2801
  memberId?: string | null;
2564
2802
  /** Ticket form response (only assigned tickets contain separate forms). */
2565
2803
  form?: FormResponse;
@@ -2569,7 +2807,10 @@ export interface Ticket {
2569
2807
  anonymized?: boolean;
2570
2808
  /** URL and password to online conference */
2571
2809
  onlineConferencingLogin?: OnlineConferencingLogin;
2572
- /** Seat ID associated with this ticket. */
2810
+ /**
2811
+ * Seat ID associated with this ticket.
2812
+ * @maxLength 36
2813
+ */
2573
2814
  seatId?: string | null;
2574
2815
  /** Whether ticket is canceled. */
2575
2816
  canceled?: boolean | null;
@@ -2581,6 +2822,7 @@ export interface CheckIn {
2581
2822
  export interface OnlineConferencingLogin {
2582
2823
  /**
2583
2824
  * Link URL to the online conference.
2825
+ * @format WEB_URL
2584
2826
  * @readonly
2585
2827
  */
2586
2828
  link?: string;
@@ -2623,9 +2865,16 @@ export interface Invoice {
2623
2865
  previewUrl?: string | null;
2624
2866
  }
2625
2867
  export interface Item {
2626
- /** Unique line item ID. */
2868
+ /**
2869
+ * Unique line item ID.
2870
+ * @format GUID
2871
+ */
2627
2872
  _id?: string;
2628
- /** Line item quantity. */
2873
+ /**
2874
+ * Line item quantity.
2875
+ * @min 1
2876
+ * @max 50
2877
+ */
2629
2878
  quantity?: number;
2630
2879
  /** Line item name. */
2631
2880
  name?: string;
@@ -2701,7 +2950,10 @@ export interface PaidPlanDiscountDiscountOneOf {
2701
2950
  percentDiscount?: PercentDiscount;
2702
2951
  }
2703
2952
  export interface PercentDiscount {
2704
- /** Percent rate. */
2953
+ /**
2954
+ * Percent rate.
2955
+ * @decimalValue options - {gte:0.01,lte:100,maxScale:2}
2956
+ */
2705
2957
  rate?: string;
2706
2958
  /** Number of discounted tickets. */
2707
2959
  quantityDiscounted?: number;
@@ -2714,7 +2966,10 @@ export interface Tax {
2714
2966
  * @readonly
2715
2967
  */
2716
2968
  name?: string;
2717
- /** Tax rate. */
2969
+ /**
2970
+ * Tax rate.
2971
+ * @format DECIMAL_VALUE
2972
+ */
2718
2973
  rate?: string;
2719
2974
  /** Taxable amount. */
2720
2975
  taxable?: Money;
@@ -2728,6 +2983,7 @@ export interface Fee {
2728
2983
  type?: FeeType;
2729
2984
  /**
2730
2985
  * Fee rate.
2986
+ * @format DECIMAL_VALUE
2731
2987
  * @readonly
2732
2988
  */
2733
2989
  rate?: string;
@@ -2750,19 +3006,37 @@ export declare enum FeeType {
2750
3006
  export interface OrderEmailAdded {
2751
3007
  /** Order updated timestamp in ISO UTC format. */
2752
3008
  timestamp?: Date | null;
2753
- /** Site language when Order initiated */
3009
+ /**
3010
+ * Site language when Order initiated
3011
+ * @format LANGUAGE
3012
+ */
2754
3013
  language?: string | null;
2755
- /** Locale in which Order was created. */
3014
+ /**
3015
+ * Locale in which Order was created.
3016
+ * @format LANGUAGE_TAG
3017
+ */
2756
3018
  locale?: string | null;
2757
3019
  /** Notifications silenced for this domain event. */
2758
3020
  silent?: boolean | null;
2759
- /** Event ID. */
3021
+ /**
3022
+ * Event ID.
3023
+ * @format GUID
3024
+ */
2760
3025
  eventId?: string;
2761
- /** Unique order number. */
3026
+ /**
3027
+ * Unique order number.
3028
+ * @maxLength 36
3029
+ */
2762
3030
  orderNumber?: string;
2763
- /** Contact ID associated with this order. */
3031
+ /**
3032
+ * Contact ID associated with this order.
3033
+ * @format GUID
3034
+ */
2764
3035
  contactId?: string | null;
2765
- /** Member ID associated with this order. */
3036
+ /**
3037
+ * Member ID associated with this order.
3038
+ * @format GUID
3039
+ */
2766
3040
  memberId?: string | null;
2767
3041
  /**
2768
3042
  * Order created timestamp.
@@ -2774,11 +3048,20 @@ export interface OrderEmailAdded {
2774
3048
  * @readonly
2775
3049
  */
2776
3050
  updated?: Date | null;
2777
- /** Buyer first name. */
3051
+ /**
3052
+ * Buyer first name.
3053
+ * @maxLength 255
3054
+ */
2778
3055
  firstName?: string | null;
2779
- /** Buyer last name. */
3056
+ /**
3057
+ * Buyer last name.
3058
+ * @maxLength 255
3059
+ */
2780
3060
  lastName?: string | null;
2781
- /** Buyer email. */
3061
+ /**
3062
+ * Buyer email.
3063
+ * @format EMAIL
3064
+ */
2782
3065
  email?: string | null;
2783
3066
  /** Checkout form response. */
2784
3067
  checkoutForm?: FormResponse;
@@ -2786,29 +3069,47 @@ export interface OrderEmailAdded {
2786
3069
  confirmed?: boolean;
2787
3070
  /** Order status. */
2788
3071
  status?: OrderStatus;
2789
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
3072
+ /**
3073
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
3074
+ * @maxLength 100
3075
+ */
2790
3076
  method?: string | null;
2791
- /** Tickets generated after payment. */
3077
+ /**
3078
+ * Tickets generated after payment.
3079
+ * @maxSize 50
3080
+ */
2792
3081
  tickets?: Ticket[];
2793
3082
  /** Whether order was archived and excluded from results. */
2794
3083
  archived?: boolean;
2795
- /** Reservation ID associated with this order. */
3084
+ /**
3085
+ * Reservation ID associated with this order.
3086
+ * @format GUID
3087
+ */
2796
3088
  reservationId?: string;
2797
3089
  }
2798
3090
  export interface EventCanceled {
2799
3091
  /** Event canceled timestamp in ISO UTC format. */
2800
3092
  timestamp?: Date | null;
2801
- /** Event ID. */
3093
+ /**
3094
+ * Event ID.
3095
+ * @format GUID
3096
+ */
2802
3097
  eventId?: string;
2803
3098
  /** Event title */
2804
3099
  title?: string;
2805
- /** Event creator user ID. */
3100
+ /**
3101
+ * Event creator user ID.
3102
+ * @format GUID
3103
+ */
2806
3104
  userId?: string | null;
2807
3105
  }
2808
3106
  export interface EventReminder {
2809
3107
  /** Reminder timestamp in ISO UTC format. */
2810
3108
  timestamp?: Date | null;
2811
- /** Event ID. */
3109
+ /**
3110
+ * Event ID.
3111
+ * @format GUID
3112
+ */
2812
3113
  eventId?: string;
2813
3114
  /** Event location. */
2814
3115
  location?: Location;
@@ -2816,7 +3117,10 @@ export interface EventReminder {
2816
3117
  scheduleConfig?: ScheduleConfig;
2817
3118
  /** Event title. */
2818
3119
  title?: string;
2819
- /** Event creator user ID. */
3120
+ /**
3121
+ * Event creator user ID.
3122
+ * @format GUID
3123
+ */
2820
3124
  userId?: string | null;
2821
3125
  /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
2822
3126
  startsIn?: TimeDuration;
@@ -2828,86 +3132,164 @@ export interface EventReminder {
2828
3132
  export interface TimeDuration {
2829
3133
  /** Number of days. */
2830
3134
  days?: number;
2831
- /** Number of hours. */
3135
+ /**
3136
+ * Number of hours.
3137
+ * @max 24
3138
+ */
2832
3139
  hours?: number;
2833
- /** Number of minutes. */
3140
+ /**
3141
+ * Number of minutes.
3142
+ * @max 60
3143
+ */
2834
3144
  minutes?: number;
2835
3145
  }
2836
3146
  export interface OrderPaid {
2837
3147
  /** Order paid timestamp in ISO UTC. */
2838
3148
  timestamp?: Date | null;
2839
- /** Site language when Order initiated */
3149
+ /**
3150
+ * Site language when Order initiated
3151
+ * @format LANGUAGE
3152
+ */
2840
3153
  language?: string | null;
2841
3154
  /** Notifications silenced for this domain event. */
2842
3155
  silent?: boolean | null;
2843
- /** Locale in which Order was created. */
3156
+ /**
3157
+ * Locale in which Order was created.
3158
+ * @format LANGUAGE_TAG
3159
+ */
2844
3160
  locale?: string | null;
2845
- /** Event ID. */
3161
+ /**
3162
+ * Event ID.
3163
+ * @format GUID
3164
+ */
2846
3165
  eventId?: string;
2847
3166
  /** Unique order number. */
2848
3167
  orderNumber?: string;
2849
3168
  /** Reservation ID associated with this order. */
2850
3169
  reservationId?: string;
2851
- /** Contact ID associated with this order. */
3170
+ /**
3171
+ * Contact ID associated with this order.
3172
+ * @maxLength 36
3173
+ */
2852
3174
  contactId?: string;
2853
- /** Member ID associated with this order. */
3175
+ /**
3176
+ * Member ID associated with this order.
3177
+ * @format GUID
3178
+ */
2854
3179
  memberId?: string | null;
2855
3180
  /**
2856
3181
  * Order created timestamp
2857
3182
  * @readonly
2858
3183
  */
2859
3184
  created?: Date | null;
2860
- /** Buyer first name. */
3185
+ /**
3186
+ * Buyer first name.
3187
+ * @maxLength 255
3188
+ */
2861
3189
  firstName?: string;
2862
- /** Buyer last name. */
3190
+ /**
3191
+ * Buyer last name.
3192
+ * @maxLength 255
3193
+ */
2863
3194
  lastName?: string;
2864
- /** Buyer email address. */
3195
+ /**
3196
+ * Buyer email address.
3197
+ * @maxLength 255
3198
+ */
2865
3199
  email?: string;
2866
3200
  /** Checkout form response. */
2867
3201
  checkoutForm?: FormResponse;
2868
3202
  /** Order status. */
2869
3203
  status?: OrderStatus;
2870
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
3204
+ /**
3205
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
3206
+ * @maxLength 255
3207
+ */
2871
3208
  method?: string | null;
2872
- /** Tickets (generated after payment). */
3209
+ /**
3210
+ * Tickets (generated after payment).
3211
+ * @maxSize 50
3212
+ */
2873
3213
  tickets?: Ticket[];
2874
3214
  /** Invoice. */
2875
3215
  invoice?: Invoice;
2876
3216
  }
2877
3217
  export interface TicketPdfResolved {
2878
- /** Optional order number */
3218
+ /**
3219
+ * Optional order number
3220
+ * @maxLength 36
3221
+ */
2879
3222
  orderNumber?: string | null;
2880
- /** Optional ticket number */
3223
+ /**
3224
+ * Optional ticket number
3225
+ * @maxLength 36
3226
+ */
2881
3227
  ticketNumber?: string | null;
2882
- /** Resolved download url */
3228
+ /**
3229
+ * Resolved download url
3230
+ * @format WEB_URL
3231
+ */
2883
3232
  downloadUrl?: string | null;
2884
3233
  /** Resolve status */
2885
3234
  resolveFailed?: boolean | null;
2886
- /** Papyrus document id */
3235
+ /**
3236
+ * Papyrus document id
3237
+ * @format GUID
3238
+ */
2887
3239
  documentId?: string | null;
2888
3240
  }
2889
3241
  export interface TicketPdfResolveDelayed {
2890
- /** Optional order number */
3242
+ /**
3243
+ * Optional order number
3244
+ * @maxLength 36
3245
+ */
2891
3246
  orderNumber?: string | null;
2892
- /** Optional ticket number */
3247
+ /**
3248
+ * Optional ticket number
3249
+ * @maxLength 36
3250
+ */
2893
3251
  ticketNumber?: string | null;
2894
- /** Papyrus document id */
3252
+ /**
3253
+ * Papyrus document id
3254
+ * @format GUID
3255
+ */
2895
3256
  documentId?: string | null;
2896
3257
  }
2897
3258
  export interface OrderCanceled {
2898
- /** Event ID. */
3259
+ /**
3260
+ * Event ID.
3261
+ * @format GUID
3262
+ */
2899
3263
  eventId?: string;
2900
- /** Unique order number. */
3264
+ /**
3265
+ * Unique order number.
3266
+ * @maxLength 36
3267
+ */
2901
3268
  orderNumber?: string;
2902
- /** Reservation ID associated with this order. */
3269
+ /**
3270
+ * Reservation ID associated with this order.
3271
+ * @format GUID
3272
+ */
2903
3273
  reservationId?: string;
2904
- /** Contact ID associated with this order. */
3274
+ /**
3275
+ * Contact ID associated with this order.
3276
+ * @maxLength 36
3277
+ */
2905
3278
  contactId?: string;
2906
- /** Buyer first name. */
3279
+ /**
3280
+ * Buyer first name.
3281
+ * @maxLength 50
3282
+ */
2907
3283
  firstName?: string | null;
2908
- /** Buyer last name. */
3284
+ /**
3285
+ * Buyer last name.
3286
+ * @maxLength 50
3287
+ */
2909
3288
  lastName?: string | null;
2910
- /** Buyer email address. */
3289
+ /**
3290
+ * Buyer email address.
3291
+ * @maxLength 255
3292
+ */
2911
3293
  email?: string | null;
2912
3294
  /** Checkout form response. */
2913
3295
  checkoutForm?: FormResponse;
@@ -2917,17 +3299,26 @@ export interface OrderCanceled {
2917
3299
  export interface EventEnded {
2918
3300
  /** Event end timestamp in ISO UTC format. */
2919
3301
  timestamp?: Date | null;
2920
- /** Event ID. */
3302
+ /**
3303
+ * Event ID.
3304
+ * @format GUID
3305
+ */
2921
3306
  eventId?: string;
2922
3307
  }
2923
3308
  export interface EventStarted {
2924
3309
  /** Event start timestamp in ISO UTC format. */
2925
3310
  timestamp?: Date | null;
2926
- /** Event ID. */
3311
+ /**
3312
+ * Event ID.
3313
+ * @format GUID
3314
+ */
2927
3315
  eventId?: string;
2928
3316
  }
2929
3317
  export interface ResolveNotificationConfigRequest {
2930
- /** Id of the NotificationConfig to retrieve */
3318
+ /**
3319
+ * Id of the NotificationConfig to retrieve
3320
+ * @format GUID
3321
+ */
2931
3322
  notificationConfigId: string;
2932
3323
  }
2933
3324
  export interface ResolveNotificationConfigResponse {
@@ -2943,7 +3334,10 @@ export interface UpsertNotificationConfigResponse {
2943
3334
  notificationConfig?: NotificationConfig;
2944
3335
  }
2945
3336
  export interface ResolveEmailNotificationConfigRequest {
2946
- /** Id of the NotificationConfig to retrieve */
3337
+ /**
3338
+ * Id of the NotificationConfig to retrieve
3339
+ * @format GUID
3340
+ */
2947
3341
  notificationConfigId?: string;
2948
3342
  /** Notification type */
2949
3343
  notificationType?: EmailNotificationType;
@@ -2955,17 +3349,26 @@ export interface ResolveEmailNotificationConfigResponse {
2955
3349
  export interface EventDeleted {
2956
3350
  /** Event deleted timestamp in ISO UTC format. */
2957
3351
  timestamp?: Date | null;
2958
- /** Event ID. */
3352
+ /**
3353
+ * Event ID.
3354
+ * @format GUID
3355
+ */
2959
3356
  eventId?: string;
2960
3357
  /** Event title. */
2961
3358
  title?: string;
2962
- /** Event creator user ID. */
3359
+ /**
3360
+ * Event creator user ID.
3361
+ * @format GUID
3362
+ */
2963
3363
  userId?: string | null;
2964
3364
  }
2965
3365
  export interface EventCopied {
2966
3366
  /** Event created timestamp in ISO UTC format. */
2967
3367
  timestamp?: Date | null;
2968
- /** Event ID. */
3368
+ /**
3369
+ * Event ID.
3370
+ * @format GUID
3371
+ */
2969
3372
  eventId?: string;
2970
3373
  /** Event location. */
2971
3374
  location?: Location;
@@ -2973,13 +3376,22 @@ export interface EventCopied {
2973
3376
  scheduleConfig?: ScheduleConfig;
2974
3377
  /** Event title. */
2975
3378
  title?: string;
2976
- /** Event creator user ID. */
3379
+ /**
3380
+ * Event creator user ID.
3381
+ * @format GUID
3382
+ */
2977
3383
  userId?: string | null;
2978
3384
  /** Event status. */
2979
3385
  status?: EventStatus;
2980
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3386
+ /**
3387
+ * Instance ID. Indicates the original app instance which current event was derived from.
3388
+ * @format GUID
3389
+ */
2981
3390
  derivedFromInstanceId?: string | null;
2982
- /** Event ID. Indicates the original event which current event was derived from. */
3391
+ /**
3392
+ * Event ID. Indicates the original event which current event was derived from.
3393
+ * @format GUID
3394
+ */
2983
3395
  derivedFromEventId?: string | null;
2984
3396
  /**
2985
3397
  * Map of copied ticket definitions from original event.
@@ -2989,9 +3401,15 @@ export interface EventCopied {
2989
3401
  ticketDefinitions?: Record<string, string>;
2990
3402
  }
2991
3403
  export interface MessageEnvelope {
2992
- /** App instance ID. */
3404
+ /**
3405
+ * App instance ID.
3406
+ * @format GUID
3407
+ */
2993
3408
  instanceId?: string | null;
2994
- /** Event type. */
3409
+ /**
3410
+ * Event type.
3411
+ * @maxLength 150
3412
+ */
2995
3413
  eventType?: string;
2996
3414
  /** The identification type and identity data. */
2997
3415
  identity?: IdentificationData;
@@ -2999,26 +3417,50 @@ export interface MessageEnvelope {
2999
3417
  data?: string;
3000
3418
  }
3001
3419
  export interface IdentificationData extends IdentificationDataIdOneOf {
3002
- /** ID of a site visitor that has not logged in to the site. */
3420
+ /**
3421
+ * ID of a site visitor that has not logged in to the site.
3422
+ * @format GUID
3423
+ */
3003
3424
  anonymousVisitorId?: string;
3004
- /** ID of a site visitor that has logged in to the site. */
3425
+ /**
3426
+ * ID of a site visitor that has logged in to the site.
3427
+ * @format GUID
3428
+ */
3005
3429
  memberId?: string;
3006
- /** ID of a Wix user (site owner, contributor, etc.). */
3430
+ /**
3431
+ * ID of a Wix user (site owner, contributor, etc.).
3432
+ * @format GUID
3433
+ */
3007
3434
  wixUserId?: string;
3008
- /** ID of an app. */
3435
+ /**
3436
+ * ID of an app.
3437
+ * @format GUID
3438
+ */
3009
3439
  appId?: string;
3010
3440
  /** @readonly */
3011
3441
  identityType?: WebhookIdentityType;
3012
3442
  }
3013
3443
  /** @oneof */
3014
3444
  export interface IdentificationDataIdOneOf {
3015
- /** ID of a site visitor that has not logged in to the site. */
3445
+ /**
3446
+ * ID of a site visitor that has not logged in to the site.
3447
+ * @format GUID
3448
+ */
3016
3449
  anonymousVisitorId?: string;
3017
- /** ID of a site visitor that has logged in to the site. */
3450
+ /**
3451
+ * ID of a site visitor that has logged in to the site.
3452
+ * @format GUID
3453
+ */
3018
3454
  memberId?: string;
3019
- /** ID of a Wix user (site owner, contributor, etc.). */
3455
+ /**
3456
+ * ID of a Wix user (site owner, contributor, etc.).
3457
+ * @format GUID
3458
+ */
3020
3459
  wixUserId?: string;
3021
- /** ID of an app. */
3460
+ /**
3461
+ * ID of an app.
3462
+ * @format GUID
3463
+ */
3022
3464
  appId?: string;
3023
3465
  }
3024
3466
  export declare enum WebhookIdentityType {
@@ -3049,9 +3491,15 @@ export interface UpsertNotificationConfigResponseNonNullableFields {
3049
3491
  notificationConfig?: NotificationConfigNonNullableFields;
3050
3492
  }
3051
3493
  export interface BaseEventMetadata {
3052
- /** App instance ID. */
3494
+ /**
3495
+ * App instance ID.
3496
+ * @format GUID
3497
+ */
3053
3498
  instanceId?: string | null;
3054
- /** Event type. */
3499
+ /**
3500
+ * Event type.
3501
+ * @maxLength 150
3502
+ */
3055
3503
  eventType?: string;
3056
3504
  /** The identification type and identity data. */
3057
3505
  identity?: IdentificationData;
@@ -3102,6 +3550,8 @@ export interface NotificationConfigCreatedEnvelope {
3102
3550
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
3103
3551
  * @permissionScope Manage Events - all permissions
3104
3552
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3553
+ * @permissionScope Manage Events
3554
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3105
3555
  * @permissionScope Read Events
3106
3556
  * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3107
3557
  * @permissionScope Manage Guest List
@@ -3124,6 +3574,8 @@ export interface NotificationConfigUpdatedEnvelope {
3124
3574
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
3125
3575
  * @permissionScope Manage Events - all permissions
3126
3576
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3577
+ * @permissionScope Manage Events
3578
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3127
3579
  * @permissionScope Read Events
3128
3580
  * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3129
3581
  * @permissionScope Manage Guest List
@@ -3145,14 +3597,35 @@ export declare function onNotificationConfigUpdated(handler: (event: Notificatio
3145
3597
  * @requiredField guests
3146
3598
  * @requiredField notification
3147
3599
  * @permissionId WIX_EVENTS.MANAGE
3600
+ * @permissionScope Manage Events
3601
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3602
+ * @applicableIdentity APP
3148
3603
  * @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
3149
3604
  */
3150
3605
  export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
3151
- export interface TriggerNotificationOptions extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
3606
+ export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
3607
+ /** Email notification type */
3608
+ emailNotificationType?: EmailNotificationType;
3609
+ /** Push notification type */
3610
+ pushNotificationType?: PushNotificationType;
3611
+ /** Rsvp guest info */
3612
+ rsvpGuest?: RsvpGuest;
3613
+ /** Order guest info */
3614
+ orderGuest?: OrderGuest;
3615
+ /** Event guests info */
3616
+ eventGuests?: EventGuests;
3617
+ /** Ticket guests info */
3618
+ ticketGuest?: TicketGuest;
3619
+ }
3620
+ /** @oneof */
3621
+ interface TriggerNotificationOptionsNotificationOneOf {
3152
3622
  /** Email notification type */
3153
3623
  emailNotificationType?: EmailNotificationType;
3154
3624
  /** Push notification type */
3155
3625
  pushNotificationType?: PushNotificationType;
3626
+ }
3627
+ /** @oneof */
3628
+ interface TriggerNotificationOptionsGuestsOneOf {
3156
3629
  /** Rsvp guest info */
3157
3630
  rsvpGuest?: RsvpGuest;
3158
3631
  /** Order guest info */
@@ -3173,6 +3646,8 @@ export interface TriggerNotificationOptions extends TriggerNotificationRequestNo
3173
3646
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
3174
3647
  * @permissionScope Manage Events - all permissions
3175
3648
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3649
+ * @permissionScope Manage Events
3650
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3176
3651
  * @permissionScope Read Events
3177
3652
  * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3178
3653
  * @permissionScope Manage Guest List
@@ -3194,15 +3669,24 @@ export declare function resolveNotificationConfig(notificationConfigId: string):
3194
3669
  * @permissionScope Manage Events - all permissions
3195
3670
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3196
3671
  * @permissionScope Manage Events
3672
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3673
+ * @permissionScope Manage Events
3197
3674
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3198
3675
  * @applicableIdentity APP
3199
3676
  * @fqn wix.events.notifications.v2.NotificationConfigManagement.UpsertNotificationConfig
3200
3677
  */
3201
3678
  export declare function upsertNotificationConfig(_id: string | null, notificationConfig: UpsertNotificationConfig): Promise<UpsertNotificationConfigResponse & UpsertNotificationConfigResponseNonNullableFields>;
3202
3679
  export interface UpsertNotificationConfig {
3203
- /** Event ID. */
3680
+ /**
3681
+ * Event ID.
3682
+ * @format GUID
3683
+ * @immutable
3684
+ */
3204
3685
  _id?: string | null;
3205
- /** 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. */
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
+ */
3206
3690
  revision?: string | null;
3207
3691
  /**
3208
3692
  * Represents the time this NotificationConfig was created.