@wix/auto_sdk_events_notifications 1.0.3 → 1.0.5

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