@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 {
@@ -251,7 +295,10 @@ export interface Empty {
251
295
  export interface EventUpdated {
252
296
  /** Event update timestamp in ISO UTC format. */
253
297
  timestamp?: Date | null;
254
- /** Event ID. */
298
+ /**
299
+ * Event ID.
300
+ * @format GUID
301
+ */
255
302
  eventId?: string;
256
303
  /** Event location. */
257
304
  location?: Location;
@@ -268,11 +315,17 @@ export interface EventUpdated {
268
315
  event?: Event;
269
316
  }
270
317
  export interface Location {
271
- /** Location name. */
318
+ /**
319
+ * Location name.
320
+ * @maxLength 50
321
+ */
272
322
  name?: string | null;
273
323
  /** Location map coordinates. */
274
324
  coordinates?: MapCoordinates;
275
- /** Single line address representation. */
325
+ /**
326
+ * Single line address representation.
327
+ * @maxLength 300
328
+ */
276
329
  address?: string | null;
277
330
  /** Location type. */
278
331
  type?: LocationType;
@@ -294,9 +347,17 @@ export interface Location {
294
347
  tbd?: boolean | null;
295
348
  }
296
349
  export interface MapCoordinates {
297
- /** Latitude. */
350
+ /**
351
+ * Latitude.
352
+ * @min -90
353
+ * @max 90
354
+ */
298
355
  lat?: number;
299
- /** Longitude. */
356
+ /**
357
+ * Longitude.
358
+ * @min -180
359
+ * @max 180
360
+ */
300
361
  lng?: number;
301
362
  }
302
363
  export declare enum LocationType {
@@ -309,7 +370,10 @@ export interface Address extends AddressStreetOneOf {
309
370
  streetAddress?: StreetAddress;
310
371
  /** Main address line (usually street and number) as free text */
311
372
  addressLine?: string | null;
312
- /** country code */
373
+ /**
374
+ * country code
375
+ * @format COUNTRY
376
+ */
313
377
  country?: string | null;
314
378
  /** subdivision (usually state or region) code according to ISO 3166-2 */
315
379
  subdivision?: string | null;
@@ -327,7 +391,10 @@ export interface Address extends AddressStreetOneOf {
327
391
  geocode?: AddressLocation;
328
392
  /** country full-name */
329
393
  countryFullname?: string | null;
330
- /** multi-level subdivisions from top to bottom */
394
+ /**
395
+ * multi-level subdivisions from top to bottom
396
+ * @maxSize 6
397
+ */
331
398
  subdivisions?: Subdivision[];
332
399
  }
333
400
  /** @oneof */
@@ -344,9 +411,17 @@ export interface StreetAddress {
344
411
  name?: string;
345
412
  }
346
413
  export interface AddressLocation {
347
- /** address latitude coordinates */
414
+ /**
415
+ * address latitude coordinates
416
+ * @min -90
417
+ * @max 90
418
+ */
348
419
  latitude?: number | null;
349
- /** address longitude coordinates */
420
+ /**
421
+ * address longitude coordinates
422
+ * @min -180
423
+ * @max 180
424
+ */
350
425
  longitude?: number | null;
351
426
  }
352
427
  export interface Subdivision {
@@ -377,13 +452,19 @@ export interface ScheduleConfig {
377
452
  * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
378
453
  */
379
454
  scheduleTbd?: boolean;
380
- /** TBD message. */
455
+ /**
456
+ * TBD message.
457
+ * @maxLength 100
458
+ */
381
459
  scheduleTbdMessage?: string | null;
382
460
  /** Event start timestamp. */
383
461
  startDate?: Date | null;
384
462
  /** Event end timestamp. */
385
463
  endDate?: Date | null;
386
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
464
+ /**
465
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
466
+ * @maxLength 100
467
+ */
387
468
  timeZoneId?: string | null;
388
469
  /** Whether end date is hidden in the formatted schedule. */
389
470
  endDateHidden?: boolean;
@@ -393,7 +474,10 @@ export interface ScheduleConfig {
393
474
  recurrences?: Recurrences;
394
475
  }
395
476
  export interface Recurrences {
396
- /** Event occurrences. */
477
+ /**
478
+ * Event occurrences.
479
+ * @maxSize 1000
480
+ */
397
481
  occurrences?: Occurrence[];
398
482
  /**
399
483
  * Recurring event category ID.
@@ -411,7 +495,10 @@ export interface Occurrence {
411
495
  startDate?: Date | null;
412
496
  /** Event end timestamp. */
413
497
  endDate?: Date | null;
414
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
498
+ /**
499
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
500
+ * @maxLength 100
501
+ */
415
502
  timeZoneId?: string | null;
416
503
  /** Whether time zone is displayed in formatted schedule. */
417
504
  showTimeZone?: boolean;
@@ -431,6 +518,7 @@ export declare enum Status {
431
518
  export interface Event {
432
519
  /**
433
520
  * Event ID.
521
+ * @format GUID
434
522
  * @readonly
435
523
  */
436
524
  id?: string;
@@ -470,7 +558,10 @@ export interface Event {
470
558
  instanceId?: string;
471
559
  /** Guest list configuration. */
472
560
  guestListConfig?: GuestListConfig;
473
- /** Event creator user ID. */
561
+ /**
562
+ * Event creator user ID.
563
+ * @maxLength 36
564
+ */
474
565
  userId?: string;
475
566
  /** Event discussion feed. For internal use. */
476
567
  feed?: Feed;
@@ -488,6 +579,11 @@ export interface Event {
488
579
  eventDisplaySettings?: EventDisplaySettings;
489
580
  /** Rich content displayed in Wix UI - "About Event" section. Successor to `about` field. */
490
581
  longDescription?: RichContent;
582
+ /**
583
+ * Event publish timestamp.
584
+ * @readonly
585
+ */
586
+ publishedDate?: Date | null;
491
587
  }
492
588
  export interface Scheduling {
493
589
  /** Schedule configuration. */
@@ -504,7 +600,11 @@ export interface Scheduling {
504
600
  endTimeFormatted?: string;
505
601
  }
506
602
  export interface Image {
507
- /** WixMedia image ID. */
603
+ /**
604
+ * WixMedia image ID.
605
+ * @minLength 1
606
+ * @maxLength 200
607
+ */
508
608
  id?: string | null;
509
609
  /** Image URL. */
510
610
  url?: string;
@@ -642,17 +742,31 @@ export interface TicketingConfig {
642
742
  guestAssignedTickets?: boolean;
643
743
  /** Tax configuration. */
644
744
  taxConfig?: TaxConfig;
645
- /** Limit of tickets that can be purchased per order, default 20. */
745
+ /**
746
+ * Limit of tickets that can be purchased per order, default 20.
747
+ * @max 50
748
+ */
646
749
  ticketLimitPerOrder?: number;
647
- /** Duration for which the tickets being bought are reserved. */
750
+ /**
751
+ * Duration for which the tickets being bought are reserved.
752
+ * @min 5
753
+ * @max 30
754
+ */
648
755
  reservationDurationInMinutes?: number | null;
649
756
  }
650
757
  export interface TaxConfig {
651
758
  /** Tax application settings. */
652
759
  type?: TaxType;
653
- /** Tax name. */
760
+ /**
761
+ * Tax name.
762
+ * @minLength 1
763
+ * @maxLength 10
764
+ */
654
765
  name?: string | null;
655
- /** Tax rate (e.g.,`21.55`). */
766
+ /**
767
+ * Tax rate (e.g.,`21.55`).
768
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
769
+ */
656
770
  rate?: string | null;
657
771
  /** Applies taxes for donations, default true. */
658
772
  appliesToDonations?: boolean | null;
@@ -668,12 +782,19 @@ export declare enum TaxType {
668
782
  export interface Money {
669
783
  /**
670
784
  * *Deprecated:** Use `value` instead.
785
+ * @format DECIMAL_VALUE
671
786
  * @deprecated
672
787
  */
673
788
  amount?: string;
674
- /** ISO 4217 format of the currency e.g., `USD`. */
789
+ /**
790
+ * ISO 4217 format of the currency e.g., `USD`.
791
+ * @format CURRENCY
792
+ */
675
793
  currency?: string;
676
- /** 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. */
794
+ /**
795
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
796
+ * @format DECIMAL_VALUE
797
+ */
677
798
  value?: string | null;
678
799
  }
679
800
  export interface ExternalEvent {
@@ -828,21 +949,29 @@ export declare enum ValueType {
828
949
  * Defaults to first (0th) option if not configured.
829
950
  */
830
951
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
831
- /** 0-based index from predefined `input.options` which is selected initially. */
952
+ /**
953
+ * 0-based index from predefined `input.options` which is selected initially.
954
+ * @max 199
955
+ */
832
956
  optionIndex?: number;
833
957
  /**
834
958
  * Placeholder hint describing expected choices (such as "Please select").
835
959
  * Considered an empty choice.
960
+ * @maxLength 200
836
961
  */
837
962
  placeholderText?: string;
838
963
  }
839
964
  /** @oneof */
840
965
  export interface OptionSelectionSelectedOptionOneOf {
841
- /** 0-based index from predefined `input.options` which is selected initially. */
966
+ /**
967
+ * 0-based index from predefined `input.options` which is selected initially.
968
+ * @max 199
969
+ */
842
970
  optionIndex?: number;
843
971
  /**
844
972
  * Placeholder hint describing expected choices (such as "Please select").
845
973
  * Considered an empty choice.
974
+ * @maxLength 200
846
975
  */
847
976
  placeholderText?: string;
848
977
  }
@@ -997,7 +1126,10 @@ export interface OnlineConferencingConfig {
997
1126
  * When enabled, links to join conferencing are generated and provided to guests.
998
1127
  */
999
1128
  enabled?: boolean;
1000
- /** Conferencing provider ID. */
1129
+ /**
1130
+ * Conferencing provider ID.
1131
+ * @format GUID
1132
+ */
1001
1133
  providerId?: string | null;
1002
1134
  /** Conference type */
1003
1135
  conferenceType?: ConferenceType;
@@ -1036,7 +1168,10 @@ export interface OnlineConferencingSession {
1036
1168
  sessionId?: string | null;
1037
1169
  }
1038
1170
  export interface SeoSettings {
1039
- /** URL slug */
1171
+ /**
1172
+ * URL slug
1173
+ * @maxLength 130
1174
+ */
1040
1175
  slug?: string;
1041
1176
  /** Advanced SEO data */
1042
1177
  advancedSeoData?: SeoSchema;
@@ -1062,7 +1197,10 @@ export interface Keyword {
1062
1197
  term?: string;
1063
1198
  /** Whether the keyword is the main focus keyword. */
1064
1199
  isMain?: boolean;
1065
- /** The source that added the keyword terms to the SEO settings. */
1200
+ /**
1201
+ * The source that added the keyword terms to the SEO settings.
1202
+ * @maxLength 1000
1203
+ */
1066
1204
  origin?: string | null;
1067
1205
  }
1068
1206
  export interface Tag {
@@ -1095,7 +1233,10 @@ export interface Settings {
1095
1233
  * Default: `false` (Auto Redirect is enabled.)
1096
1234
  */
1097
1235
  preventAutoRedirect?: boolean;
1098
- /** User-selected keyword terms for a specific page. */
1236
+ /**
1237
+ * User-selected keyword terms for a specific page.
1238
+ * @maxSize 5
1239
+ */
1099
1240
  keywords?: Keyword[];
1100
1241
  }
1101
1242
  export interface Agenda {
@@ -1110,10 +1251,15 @@ export interface Agenda {
1110
1251
  export interface Category {
1111
1252
  /**
1112
1253
  * Category ID.
1254
+ * @format GUID
1113
1255
  * @readonly
1114
1256
  */
1115
1257
  id?: string;
1116
- /** Category name. */
1258
+ /**
1259
+ * Category name.
1260
+ * @minLength 1
1261
+ * @maxLength 30
1262
+ */
1117
1263
  name?: string;
1118
1264
  /**
1119
1265
  * Date and time when category was created.
@@ -1136,6 +1282,7 @@ export interface Category {
1136
1282
  * Default: `MANUAL`.
1137
1283
  *
1138
1284
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1285
+ * @maxSize 3
1139
1286
  */
1140
1287
  states?: State[];
1141
1288
  }
@@ -1757,19 +1904,28 @@ export interface GIFData {
1757
1904
  height?: number;
1758
1905
  /** Width in pixels. */
1759
1906
  width?: number;
1760
- /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
1907
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
1761
1908
  gifType?: GIFType;
1762
1909
  }
1763
1910
  export interface GIF {
1764
- /** GIF format URL. */
1911
+ /**
1912
+ * GIF format URL.
1913
+ * @format WEB_URL
1914
+ */
1765
1915
  gif?: string | null;
1766
- /** MP4 format URL. */
1916
+ /**
1917
+ * MP4 format URL.
1918
+ * @format WEB_URL
1919
+ */
1767
1920
  mp4?: string | null;
1768
- /** Thumbnail URL. */
1921
+ /**
1922
+ * Thumbnail URL.
1923
+ * @format WEB_URL
1924
+ */
1769
1925
  still?: string | null;
1770
1926
  }
1771
1927
  export declare enum GIFType {
1772
- GIF = "GIF",
1928
+ NORMAL = "NORMAL",
1773
1929
  STICKER = "STICKER"
1774
1930
  }
1775
1931
  export interface HeadingData {
@@ -1831,6 +1987,22 @@ export interface ImageData {
1831
1987
  caption?: string | null;
1832
1988
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1833
1989
  disableDownload?: boolean | null;
1990
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
1991
+ decorative?: boolean | null;
1992
+ /** Styling for the image. */
1993
+ styles?: ImageDataStyles;
1994
+ }
1995
+ export interface StylesBorder {
1996
+ /** Border width in pixels. */
1997
+ width?: number | null;
1998
+ /** Border color. */
1999
+ color?: string | null;
2000
+ /** Border radius in pixels. */
2001
+ radius?: number | null;
2002
+ }
2003
+ export interface ImageDataStyles {
2004
+ /** Border attributes. */
2005
+ border?: StylesBorder;
1834
2006
  }
1835
2007
  export interface LinkPreviewData {
1836
2008
  /** Styling for the link preview's container. */
@@ -1977,13 +2149,22 @@ export declare enum BackgroundType {
1977
2149
  export interface Gradient {
1978
2150
  /** The gradient angle in degrees. */
1979
2151
  angle?: number | null;
1980
- /** The start color as a hexademical value. */
2152
+ /**
2153
+ * The start color as a hexademical value.
2154
+ * @format COLOR_HEX
2155
+ */
1981
2156
  startColor?: string | null;
1982
- /** The end color as a hexademical value. */
2157
+ /**
2158
+ * The end color as a hexademical value.
2159
+ * @format COLOR_HEX
2160
+ */
1983
2161
  lastColor?: string | null;
1984
2162
  }
1985
2163
  export interface Background extends BackgroundBackgroundOneOf {
1986
- /** The background color as a hexademical value. */
2164
+ /**
2165
+ * The background color as a hexademical value.
2166
+ * @format COLOR_HEX
2167
+ */
1987
2168
  color?: string | null;
1988
2169
  /** An image to use for the background. */
1989
2170
  image?: Media;
@@ -1994,7 +2175,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1994
2175
  }
1995
2176
  /** @oneof */
1996
2177
  export interface BackgroundBackgroundOneOf {
1997
- /** The background color as a hexademical value. */
2178
+ /**
2179
+ * The background color as a hexademical value.
2180
+ * @format COLOR_HEX
2181
+ */
1998
2182
  color?: string | null;
1999
2183
  /** An image to use for the background. */
2000
2184
  image?: Media;
@@ -2306,17 +2490,32 @@ export declare enum VerticalAlignment {
2306
2490
  export interface CellStyle {
2307
2491
  /** Vertical alignment for the cell's text. */
2308
2492
  verticalAlignment?: VerticalAlignment;
2309
- /** Cell background color as a hexadecimal value. */
2493
+ /**
2494
+ * Cell background color as a hexadecimal value.
2495
+ * @format COLOR_HEX
2496
+ */
2310
2497
  backgroundColor?: string | null;
2311
2498
  }
2312
2499
  export interface BorderColors {
2313
- /** Left border color as a hexadecimal value. */
2500
+ /**
2501
+ * Left border color as a hexadecimal value.
2502
+ * @format COLOR_HEX
2503
+ */
2314
2504
  left?: string | null;
2315
- /** Right border color as a hexadecimal value. */
2505
+ /**
2506
+ * Right border color as a hexadecimal value.
2507
+ * @format COLOR_HEX
2508
+ */
2316
2509
  right?: string | null;
2317
- /** Top border color as a hexadecimal value. */
2510
+ /**
2511
+ * Top border color as a hexadecimal value.
2512
+ * @format COLOR_HEX
2513
+ */
2318
2514
  top?: string | null;
2319
- /** Bottom border color as a hexadecimal value. */
2515
+ /**
2516
+ * Bottom border color as a hexadecimal value.
2517
+ * @format COLOR_HEX
2518
+ */
2320
2519
  bottom?: string | null;
2321
2520
  }
2322
2521
  /**
@@ -2427,19 +2626,31 @@ export interface TextNodeStyle {
2427
2626
  export interface OrderConfirmed {
2428
2627
  /** Order confirmation timestamp in ISO UTC. */
2429
2628
  timestamp?: Date | null;
2430
- /** Site language when Order initiated */
2629
+ /**
2630
+ * Site language when Order initiated
2631
+ * @format LANGUAGE
2632
+ */
2431
2633
  language?: string | null;
2432
2634
  /** Notifications silenced for this domain event. */
2433
2635
  silent?: boolean | null;
2434
- /** Locale in which Order was created. */
2636
+ /**
2637
+ * Locale in which Order was created.
2638
+ * @format LANGUAGE_TAG
2639
+ */
2435
2640
  locale?: string | null;
2436
- /** Event ID. */
2641
+ /**
2642
+ * Event ID.
2643
+ * @format GUID
2644
+ */
2437
2645
  eventId?: string;
2438
2646
  /** Unique order number. */
2439
2647
  orderNumber?: string;
2440
2648
  /** Contact ID associated with this order. */
2441
2649
  contactId?: string;
2442
- /** Member ID associated with this order. */
2650
+ /**
2651
+ * Member ID associated with this order.
2652
+ * @format GUID
2653
+ */
2443
2654
  memberId?: string | null;
2444
2655
  /**
2445
2656
  * Order created timestamp
@@ -2466,19 +2677,35 @@ export interface OrderConfirmed {
2466
2677
  reservationId?: string;
2467
2678
  }
2468
2679
  export interface FormResponse {
2469
- /** Input values entered when filling the form. */
2680
+ /**
2681
+ * Input values entered when filling the form.
2682
+ * @maxSize 200
2683
+ */
2470
2684
  inputValues?: InputValue[];
2471
2685
  }
2472
2686
  export interface InputValue {
2473
- /** Input field name. */
2687
+ /**
2688
+ * Input field name.
2689
+ * @maxLength 100
2690
+ */
2474
2691
  inputName?: string;
2475
- /** Text entered into the input field. */
2692
+ /**
2693
+ * Text entered into the input field.
2694
+ * @maxLength 5000
2695
+ */
2476
2696
  value?: string;
2477
- /** Multiple selection values. For example, the array is filled if several checkboxes are ticked. */
2697
+ /**
2698
+ * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
2699
+ * @maxSize 100
2700
+ * @maxLength 5000
2701
+ */
2478
2702
  values?: string[];
2479
2703
  }
2480
2704
  export interface FormattedAddress {
2481
- /** One line address representation. */
2705
+ /**
2706
+ * One line address representation.
2707
+ * @maxLength 200
2708
+ */
2482
2709
  formatted?: string;
2483
2710
  /** Address components (optional). */
2484
2711
  address?: CommonAddress;
@@ -2489,7 +2716,10 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
2489
2716
  streetAddress?: CommonStreetAddress;
2490
2717
  /** Main address line, usually street and number as free text. */
2491
2718
  addressLine?: string | null;
2492
- /** Country code. */
2719
+ /**
2720
+ * Country code.
2721
+ * @format COUNTRY
2722
+ */
2493
2723
  country?: string | null;
2494
2724
  /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
2495
2725
  subdivision?: string | null;
@@ -2527,7 +2757,10 @@ export interface CommonSubdivision {
2527
2757
  }
2528
2758
  /** Subdivision Concordance values */
2529
2759
  export interface StandardDetails {
2530
- /** 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 */
2760
+ /**
2761
+ * 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
2762
+ * @maxLength 20
2763
+ */
2531
2764
  iso31662?: string | null;
2532
2765
  }
2533
2766
  export declare enum OrderStatus {
@@ -2557,7 +2790,10 @@ export declare enum OrderStatus {
2557
2790
  export interface Ticket {
2558
2791
  /** Unique issued ticket number. */
2559
2792
  ticketNumber?: string;
2560
- /** Ticket definition ID. */
2793
+ /**
2794
+ * Ticket definition ID.
2795
+ * @format GUID
2796
+ */
2561
2797
  ticketDefinitionId?: string;
2562
2798
  /** Ticket check-in. */
2563
2799
  checkIn?: CheckIn;
@@ -2571,11 +2807,17 @@ export interface Ticket {
2571
2807
  lastName?: string | null;
2572
2808
  /** Guest email. */
2573
2809
  email?: string | null;
2574
- /** Contact ID associated with this ticket. */
2810
+ /**
2811
+ * Contact ID associated with this ticket.
2812
+ * @format GUID
2813
+ */
2575
2814
  contactId?: string | null;
2576
2815
  /** Whether ticket is confirmed */
2577
2816
  confirmed?: boolean;
2578
- /** Member ID associated with this ticket. */
2817
+ /**
2818
+ * Member ID associated with this ticket.
2819
+ * @format GUID
2820
+ */
2579
2821
  memberId?: string | null;
2580
2822
  /** Ticket form response (only assigned tickets contain separate forms). */
2581
2823
  form?: FormResponse;
@@ -2585,7 +2827,10 @@ export interface Ticket {
2585
2827
  anonymized?: boolean;
2586
2828
  /** URL and password to online conference */
2587
2829
  onlineConferencingLogin?: OnlineConferencingLogin;
2588
- /** Seat ID associated with this ticket. */
2830
+ /**
2831
+ * Seat ID associated with this ticket.
2832
+ * @maxLength 36
2833
+ */
2589
2834
  seatId?: string | null;
2590
2835
  /** Whether ticket is canceled. */
2591
2836
  canceled?: boolean | null;
@@ -2597,6 +2842,7 @@ export interface CheckIn {
2597
2842
  export interface OnlineConferencingLogin {
2598
2843
  /**
2599
2844
  * Link URL to the online conference.
2845
+ * @format WEB_URL
2600
2846
  * @readonly
2601
2847
  */
2602
2848
  link?: string;
@@ -2639,9 +2885,16 @@ export interface Invoice {
2639
2885
  previewUrl?: string | null;
2640
2886
  }
2641
2887
  export interface Item {
2642
- /** Unique line item ID. */
2888
+ /**
2889
+ * Unique line item ID.
2890
+ * @format GUID
2891
+ */
2643
2892
  id?: string;
2644
- /** Line item quantity. */
2893
+ /**
2894
+ * Line item quantity.
2895
+ * @min 1
2896
+ * @max 50
2897
+ */
2645
2898
  quantity?: number;
2646
2899
  /** Line item name. */
2647
2900
  name?: string;
@@ -2717,7 +2970,10 @@ export interface PaidPlanDiscountDiscountOneOf {
2717
2970
  percentDiscount?: PercentDiscount;
2718
2971
  }
2719
2972
  export interface PercentDiscount {
2720
- /** Percent rate. */
2973
+ /**
2974
+ * Percent rate.
2975
+ * @decimalValue options - {gte:0.01,lte:100,maxScale:2}
2976
+ */
2721
2977
  rate?: string;
2722
2978
  /** Number of discounted tickets. */
2723
2979
  quantityDiscounted?: number;
@@ -2730,7 +2986,10 @@ export interface Tax {
2730
2986
  * @readonly
2731
2987
  */
2732
2988
  name?: string;
2733
- /** Tax rate. */
2989
+ /**
2990
+ * Tax rate.
2991
+ * @format DECIMAL_VALUE
2992
+ */
2734
2993
  rate?: string;
2735
2994
  /** Taxable amount. */
2736
2995
  taxable?: Money;
@@ -2744,6 +3003,7 @@ export interface Fee {
2744
3003
  type?: FeeType;
2745
3004
  /**
2746
3005
  * Fee rate.
3006
+ * @format DECIMAL_VALUE
2747
3007
  * @readonly
2748
3008
  */
2749
3009
  rate?: string;
@@ -2766,19 +3026,37 @@ export declare enum FeeType {
2766
3026
  export interface OrderEmailAdded {
2767
3027
  /** Order updated timestamp in ISO UTC format. */
2768
3028
  timestamp?: Date | null;
2769
- /** Site language when Order initiated */
3029
+ /**
3030
+ * Site language when Order initiated
3031
+ * @format LANGUAGE
3032
+ */
2770
3033
  language?: string | null;
2771
- /** Locale in which Order was created. */
3034
+ /**
3035
+ * Locale in which Order was created.
3036
+ * @format LANGUAGE_TAG
3037
+ */
2772
3038
  locale?: string | null;
2773
3039
  /** Notifications silenced for this domain event. */
2774
3040
  silent?: boolean | null;
2775
- /** Event ID. */
3041
+ /**
3042
+ * Event ID.
3043
+ * @format GUID
3044
+ */
2776
3045
  eventId?: string;
2777
- /** Unique order number. */
3046
+ /**
3047
+ * Unique order number.
3048
+ * @maxLength 36
3049
+ */
2778
3050
  orderNumber?: string;
2779
- /** Contact ID associated with this order. */
3051
+ /**
3052
+ * Contact ID associated with this order.
3053
+ * @format GUID
3054
+ */
2780
3055
  contactId?: string | null;
2781
- /** Member ID associated with this order. */
3056
+ /**
3057
+ * Member ID associated with this order.
3058
+ * @format GUID
3059
+ */
2782
3060
  memberId?: string | null;
2783
3061
  /**
2784
3062
  * Order created timestamp.
@@ -2790,11 +3068,20 @@ export interface OrderEmailAdded {
2790
3068
  * @readonly
2791
3069
  */
2792
3070
  updated?: Date | null;
2793
- /** Buyer first name. */
3071
+ /**
3072
+ * Buyer first name.
3073
+ * @maxLength 255
3074
+ */
2794
3075
  firstName?: string | null;
2795
- /** Buyer last name. */
3076
+ /**
3077
+ * Buyer last name.
3078
+ * @maxLength 255
3079
+ */
2796
3080
  lastName?: string | null;
2797
- /** Buyer email. */
3081
+ /**
3082
+ * Buyer email.
3083
+ * @format EMAIL
3084
+ */
2798
3085
  email?: string | null;
2799
3086
  /** Checkout form response. */
2800
3087
  checkoutForm?: FormResponse;
@@ -2802,29 +3089,47 @@ export interface OrderEmailAdded {
2802
3089
  confirmed?: boolean;
2803
3090
  /** Order status. */
2804
3091
  status?: OrderStatus;
2805
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
3092
+ /**
3093
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
3094
+ * @maxLength 100
3095
+ */
2806
3096
  method?: string | null;
2807
- /** Tickets generated after payment. */
3097
+ /**
3098
+ * Tickets generated after payment.
3099
+ * @maxSize 50
3100
+ */
2808
3101
  tickets?: Ticket[];
2809
3102
  /** Whether order was archived and excluded from results. */
2810
3103
  archived?: boolean;
2811
- /** Reservation ID associated with this order. */
3104
+ /**
3105
+ * Reservation ID associated with this order.
3106
+ * @format GUID
3107
+ */
2812
3108
  reservationId?: string;
2813
3109
  }
2814
3110
  export interface EventCanceled {
2815
3111
  /** Event canceled timestamp in ISO UTC format. */
2816
3112
  timestamp?: Date | null;
2817
- /** Event ID. */
3113
+ /**
3114
+ * Event ID.
3115
+ * @format GUID
3116
+ */
2818
3117
  eventId?: string;
2819
3118
  /** Event title */
2820
3119
  title?: string;
2821
- /** Event creator user ID. */
3120
+ /**
3121
+ * Event creator user ID.
3122
+ * @format GUID
3123
+ */
2822
3124
  userId?: string | null;
2823
3125
  }
2824
3126
  export interface EventReminder {
2825
3127
  /** Reminder timestamp in ISO UTC format. */
2826
3128
  timestamp?: Date | null;
2827
- /** Event ID. */
3129
+ /**
3130
+ * Event ID.
3131
+ * @format GUID
3132
+ */
2828
3133
  eventId?: string;
2829
3134
  /** Event location. */
2830
3135
  location?: Location;
@@ -2832,7 +3137,10 @@ export interface EventReminder {
2832
3137
  scheduleConfig?: ScheduleConfig;
2833
3138
  /** Event title. */
2834
3139
  title?: string;
2835
- /** Event creator user ID. */
3140
+ /**
3141
+ * Event creator user ID.
3142
+ * @format GUID
3143
+ */
2836
3144
  userId?: string | null;
2837
3145
  /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
2838
3146
  startsIn?: TimeDuration;
@@ -2844,86 +3152,164 @@ export interface EventReminder {
2844
3152
  export interface TimeDuration {
2845
3153
  /** Number of days. */
2846
3154
  days?: number;
2847
- /** Number of hours. */
3155
+ /**
3156
+ * Number of hours.
3157
+ * @max 24
3158
+ */
2848
3159
  hours?: number;
2849
- /** Number of minutes. */
3160
+ /**
3161
+ * Number of minutes.
3162
+ * @max 60
3163
+ */
2850
3164
  minutes?: number;
2851
3165
  }
2852
3166
  export interface OrderPaid {
2853
3167
  /** Order paid timestamp in ISO UTC. */
2854
3168
  timestamp?: Date | null;
2855
- /** Site language when Order initiated */
3169
+ /**
3170
+ * Site language when Order initiated
3171
+ * @format LANGUAGE
3172
+ */
2856
3173
  language?: string | null;
2857
3174
  /** Notifications silenced for this domain event. */
2858
3175
  silent?: boolean | null;
2859
- /** Locale in which Order was created. */
3176
+ /**
3177
+ * Locale in which Order was created.
3178
+ * @format LANGUAGE_TAG
3179
+ */
2860
3180
  locale?: string | null;
2861
- /** Event ID. */
3181
+ /**
3182
+ * Event ID.
3183
+ * @format GUID
3184
+ */
2862
3185
  eventId?: string;
2863
3186
  /** Unique order number. */
2864
3187
  orderNumber?: string;
2865
3188
  /** Reservation ID associated with this order. */
2866
3189
  reservationId?: string;
2867
- /** Contact ID associated with this order. */
3190
+ /**
3191
+ * Contact ID associated with this order.
3192
+ * @maxLength 36
3193
+ */
2868
3194
  contactId?: string;
2869
- /** Member ID associated with this order. */
3195
+ /**
3196
+ * Member ID associated with this order.
3197
+ * @format GUID
3198
+ */
2870
3199
  memberId?: string | null;
2871
3200
  /**
2872
3201
  * Order created timestamp
2873
3202
  * @readonly
2874
3203
  */
2875
3204
  created?: Date | null;
2876
- /** Buyer first name. */
3205
+ /**
3206
+ * Buyer first name.
3207
+ * @maxLength 255
3208
+ */
2877
3209
  firstName?: string;
2878
- /** Buyer last name. */
3210
+ /**
3211
+ * Buyer last name.
3212
+ * @maxLength 255
3213
+ */
2879
3214
  lastName?: string;
2880
- /** Buyer email address. */
3215
+ /**
3216
+ * Buyer email address.
3217
+ * @maxLength 255
3218
+ */
2881
3219
  email?: string;
2882
3220
  /** Checkout form response. */
2883
3221
  checkoutForm?: FormResponse;
2884
3222
  /** Order status. */
2885
3223
  status?: OrderStatus;
2886
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
3224
+ /**
3225
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
3226
+ * @maxLength 255
3227
+ */
2887
3228
  method?: string | null;
2888
- /** Tickets (generated after payment). */
3229
+ /**
3230
+ * Tickets (generated after payment).
3231
+ * @maxSize 50
3232
+ */
2889
3233
  tickets?: Ticket[];
2890
3234
  /** Invoice. */
2891
3235
  invoice?: Invoice;
2892
3236
  }
2893
3237
  export interface TicketPdfResolved {
2894
- /** Optional order number */
3238
+ /**
3239
+ * Optional order number
3240
+ * @maxLength 36
3241
+ */
2895
3242
  orderNumber?: string | null;
2896
- /** Optional ticket number */
3243
+ /**
3244
+ * Optional ticket number
3245
+ * @maxLength 36
3246
+ */
2897
3247
  ticketNumber?: string | null;
2898
- /** Resolved download url */
3248
+ /**
3249
+ * Resolved download url
3250
+ * @format WEB_URL
3251
+ */
2899
3252
  downloadUrl?: string | null;
2900
3253
  /** Resolve status */
2901
3254
  resolveFailed?: boolean | null;
2902
- /** Papyrus document id */
3255
+ /**
3256
+ * Papyrus document id
3257
+ * @format GUID
3258
+ */
2903
3259
  documentId?: string | null;
2904
3260
  }
2905
3261
  export interface TicketPdfResolveDelayed {
2906
- /** Optional order number */
3262
+ /**
3263
+ * Optional order number
3264
+ * @maxLength 36
3265
+ */
2907
3266
  orderNumber?: string | null;
2908
- /** Optional ticket number */
3267
+ /**
3268
+ * Optional ticket number
3269
+ * @maxLength 36
3270
+ */
2909
3271
  ticketNumber?: string | null;
2910
- /** Papyrus document id */
3272
+ /**
3273
+ * Papyrus document id
3274
+ * @format GUID
3275
+ */
2911
3276
  documentId?: string | null;
2912
3277
  }
2913
3278
  export interface OrderCanceled {
2914
- /** Event ID. */
3279
+ /**
3280
+ * Event ID.
3281
+ * @format GUID
3282
+ */
2915
3283
  eventId?: string;
2916
- /** Unique order number. */
3284
+ /**
3285
+ * Unique order number.
3286
+ * @maxLength 36
3287
+ */
2917
3288
  orderNumber?: string;
2918
- /** Reservation ID associated with this order. */
3289
+ /**
3290
+ * Reservation ID associated with this order.
3291
+ * @format GUID
3292
+ */
2919
3293
  reservationId?: string;
2920
- /** Contact ID associated with this order. */
3294
+ /**
3295
+ * Contact ID associated with this order.
3296
+ * @maxLength 36
3297
+ */
2921
3298
  contactId?: string;
2922
- /** Buyer first name. */
3299
+ /**
3300
+ * Buyer first name.
3301
+ * @maxLength 50
3302
+ */
2923
3303
  firstName?: string | null;
2924
- /** Buyer last name. */
3304
+ /**
3305
+ * Buyer last name.
3306
+ * @maxLength 50
3307
+ */
2925
3308
  lastName?: string | null;
2926
- /** Buyer email address. */
3309
+ /**
3310
+ * Buyer email address.
3311
+ * @maxLength 255
3312
+ */
2927
3313
  email?: string | null;
2928
3314
  /** Checkout form response. */
2929
3315
  checkoutForm?: FormResponse;
@@ -2933,17 +3319,26 @@ export interface OrderCanceled {
2933
3319
  export interface EventEnded {
2934
3320
  /** Event end timestamp in ISO UTC format. */
2935
3321
  timestamp?: Date | null;
2936
- /** Event ID. */
3322
+ /**
3323
+ * Event ID.
3324
+ * @format GUID
3325
+ */
2937
3326
  eventId?: string;
2938
3327
  }
2939
3328
  export interface EventStarted {
2940
3329
  /** Event start timestamp in ISO UTC format. */
2941
3330
  timestamp?: Date | null;
2942
- /** Event ID. */
3331
+ /**
3332
+ * Event ID.
3333
+ * @format GUID
3334
+ */
2943
3335
  eventId?: string;
2944
3336
  }
2945
3337
  export interface ResolveNotificationConfigRequest {
2946
- /** Id of the NotificationConfig to retrieve */
3338
+ /**
3339
+ * Id of the NotificationConfig to retrieve
3340
+ * @format GUID
3341
+ */
2947
3342
  notificationConfigId: string;
2948
3343
  }
2949
3344
  export interface ResolveNotificationConfigResponse {
@@ -2959,7 +3354,10 @@ export interface UpsertNotificationConfigResponse {
2959
3354
  notificationConfig?: NotificationConfig;
2960
3355
  }
2961
3356
  export interface ResolveEmailNotificationConfigRequest {
2962
- /** Id of the NotificationConfig to retrieve */
3357
+ /**
3358
+ * Id of the NotificationConfig to retrieve
3359
+ * @format GUID
3360
+ */
2963
3361
  notificationConfigId?: string;
2964
3362
  /** Notification type */
2965
3363
  notificationType?: EmailNotificationType;
@@ -2971,17 +3369,26 @@ export interface ResolveEmailNotificationConfigResponse {
2971
3369
  export interface EventDeleted {
2972
3370
  /** Event deleted timestamp in ISO UTC format. */
2973
3371
  timestamp?: Date | null;
2974
- /** Event ID. */
3372
+ /**
3373
+ * Event ID.
3374
+ * @format GUID
3375
+ */
2975
3376
  eventId?: string;
2976
3377
  /** Event title. */
2977
3378
  title?: string;
2978
- /** Event creator user ID. */
3379
+ /**
3380
+ * Event creator user ID.
3381
+ * @format GUID
3382
+ */
2979
3383
  userId?: string | null;
2980
3384
  }
2981
3385
  export interface EventCopied {
2982
3386
  /** Event created timestamp in ISO UTC format. */
2983
3387
  timestamp?: Date | null;
2984
- /** Event ID. */
3388
+ /**
3389
+ * Event ID.
3390
+ * @format GUID
3391
+ */
2985
3392
  eventId?: string;
2986
3393
  /** Event location. */
2987
3394
  location?: Location;
@@ -2989,13 +3396,22 @@ export interface EventCopied {
2989
3396
  scheduleConfig?: ScheduleConfig;
2990
3397
  /** Event title. */
2991
3398
  title?: string;
2992
- /** Event creator user ID. */
3399
+ /**
3400
+ * Event creator user ID.
3401
+ * @format GUID
3402
+ */
2993
3403
  userId?: string | null;
2994
3404
  /** Event status. */
2995
3405
  status?: EventStatus;
2996
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3406
+ /**
3407
+ * Instance ID. Indicates the original app instance which current event was derived from.
3408
+ * @format GUID
3409
+ */
2997
3410
  derivedFromInstanceId?: string | null;
2998
- /** Event ID. Indicates the original event which current event was derived from. */
3411
+ /**
3412
+ * Event ID. Indicates the original event which current event was derived from.
3413
+ * @format GUID
3414
+ */
2999
3415
  derivedFromEventId?: string | null;
3000
3416
  /**
3001
3417
  * Map of copied ticket definitions from original event.
@@ -3005,9 +3421,15 @@ export interface EventCopied {
3005
3421
  ticketDefinitions?: Record<string, string>;
3006
3422
  }
3007
3423
  export interface MessageEnvelope {
3008
- /** App instance ID. */
3424
+ /**
3425
+ * App instance ID.
3426
+ * @format GUID
3427
+ */
3009
3428
  instanceId?: string | null;
3010
- /** Event type. */
3429
+ /**
3430
+ * Event type.
3431
+ * @maxLength 150
3432
+ */
3011
3433
  eventType?: string;
3012
3434
  /** The identification type and identity data. */
3013
3435
  identity?: IdentificationData;
@@ -3015,26 +3437,50 @@ export interface MessageEnvelope {
3015
3437
  data?: string;
3016
3438
  }
3017
3439
  export interface IdentificationData extends IdentificationDataIdOneOf {
3018
- /** ID of a site visitor that has not logged in to the site. */
3440
+ /**
3441
+ * ID of a site visitor that has not logged in to the site.
3442
+ * @format GUID
3443
+ */
3019
3444
  anonymousVisitorId?: string;
3020
- /** ID of a site visitor that has logged in to the site. */
3445
+ /**
3446
+ * ID of a site visitor that has logged in to the site.
3447
+ * @format GUID
3448
+ */
3021
3449
  memberId?: string;
3022
- /** ID of a Wix user (site owner, contributor, etc.). */
3450
+ /**
3451
+ * ID of a Wix user (site owner, contributor, etc.).
3452
+ * @format GUID
3453
+ */
3023
3454
  wixUserId?: string;
3024
- /** ID of an app. */
3455
+ /**
3456
+ * ID of an app.
3457
+ * @format GUID
3458
+ */
3025
3459
  appId?: string;
3026
3460
  /** @readonly */
3027
3461
  identityType?: WebhookIdentityType;
3028
3462
  }
3029
3463
  /** @oneof */
3030
3464
  export interface IdentificationDataIdOneOf {
3031
- /** ID of a site visitor that has not logged in to the site. */
3465
+ /**
3466
+ * ID of a site visitor that has not logged in to the site.
3467
+ * @format GUID
3468
+ */
3032
3469
  anonymousVisitorId?: string;
3033
- /** ID of a site visitor that has logged in to the site. */
3470
+ /**
3471
+ * ID of a site visitor that has logged in to the site.
3472
+ * @format GUID
3473
+ */
3034
3474
  memberId?: string;
3035
- /** ID of a Wix user (site owner, contributor, etc.). */
3475
+ /**
3476
+ * ID of a Wix user (site owner, contributor, etc.).
3477
+ * @format GUID
3478
+ */
3036
3479
  wixUserId?: string;
3037
- /** ID of an app. */
3480
+ /**
3481
+ * ID of an app.
3482
+ * @format GUID
3483
+ */
3038
3484
  appId?: string;
3039
3485
  }
3040
3486
  export declare enum WebhookIdentityType {