@wix/auto_sdk_events_guests 1.0.2 → 1.0.3

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.
@@ -1,23 +1,47 @@
1
1
  export interface EventGuest {
2
- /** Guest ID. */
2
+ /**
3
+ * Guest ID.
4
+ * @format GUID
5
+ */
3
6
  _id?: string | null;
4
- /** Event ID. */
7
+ /**
8
+ * Event ID.
9
+ * @format GUID
10
+ */
5
11
  eventId?: string | null;
6
- /** RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`. */
12
+ /**
13
+ * RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
14
+ * @format GUID
15
+ */
7
16
  rsvpId?: string | null;
8
- /** Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`. */
17
+ /**
18
+ * Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
19
+ * @maxLength 36
20
+ */
9
21
  orderNumber?: string | null;
10
- /** Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`. */
22
+ /**
23
+ * Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
24
+ * @maxLength 36
25
+ */
11
26
  ticketNumber?: string | null;
12
- /** List of names, numbers, and definition IDs for each ticket. */
27
+ /**
28
+ * List of names, numbers, and definition IDs for each ticket.
29
+ * @maxSize 50
30
+ */
13
31
  tickets?: TicketDetails[];
14
- /** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
32
+ /**
33
+ * Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.
34
+ * @format GUID
35
+ */
15
36
  contactId?: string | null;
16
37
  /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
17
38
  guestDetails?: GuestDetails;
18
39
  /** Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
19
40
  attendanceStatus?: AttendanceStatus;
20
- /** Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. */
41
+ /**
42
+ * Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language.
43
+ * @format LANGUAGE
44
+ */
21
45
  secondaryLanguageCode?: string | null;
22
46
  /** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
23
47
  _createdDate?: Date | null;
@@ -25,11 +49,17 @@ export interface EventGuest {
25
49
  _updatedDate?: Date | null;
26
50
  /** Date and time of guest's latest attendance status update. */
27
51
  attendanceStatusUpdatedDate?: Date | null;
28
- /** Site member ID. */
52
+ /**
53
+ * Site member ID.
54
+ * @format GUID
55
+ */
29
56
  memberId?: string | null;
30
57
  /** Guest type. */
31
58
  guestType?: GuestType;
32
- /** Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. */
59
+ /**
60
+ * Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale.
61
+ * @format LANGUAGE_TAG
62
+ */
33
63
  locale?: string | null;
34
64
  /**
35
65
  * Number of total guests in an event (registered guests + additional ones).
@@ -43,24 +73,41 @@ export interface EventGuest {
43
73
  revision?: string | null;
44
74
  }
45
75
  export interface TicketDetails {
46
- /** Ticket number. */
76
+ /**
77
+ * Ticket number.
78
+ * @maxLength 36
79
+ */
47
80
  number?: string;
48
- /** Ticket definition ID. */
81
+ /**
82
+ * Ticket definition ID.
83
+ * @format GUID
84
+ */
49
85
  definitionId?: string | null;
50
- /** Ticket name. */
86
+ /**
87
+ * Ticket name.
88
+ * @minLength 1
89
+ * @maxLength 30
90
+ */
51
91
  name?: string | null;
52
92
  }
53
93
  export interface TicketGuestDetails {
54
94
  /** The login details for the guest to access the online conference event. */
55
95
  onlineConferencingLogin?: OnlineConferencingLogin;
56
- /** First name. */
96
+ /**
97
+ * First name.
98
+ * @maxLength 255
99
+ */
57
100
  firstName?: string | null;
58
- /** Last name. */
101
+ /**
102
+ * Last name.
103
+ * @maxLength 255
104
+ */
59
105
  lastName?: string | null;
60
106
  }
61
107
  export interface OnlineConferencingLogin {
62
108
  /**
63
109
  * Link URL to the online conference.
110
+ * @format WEB_URL
64
111
  * @readonly
65
112
  */
66
113
  link?: string;
@@ -71,11 +118,20 @@ export interface OnlineConferencingLogin {
71
118
  password?: string | null;
72
119
  }
73
120
  export interface GuestDetails {
74
- /** Email. */
121
+ /**
122
+ * Email.
123
+ * @format EMAIL
124
+ */
75
125
  email?: string | null;
76
- /** First name. */
126
+ /**
127
+ * First name.
128
+ * @maxLength 255
129
+ */
77
130
  firstName?: string | null;
78
- /** Last name. */
131
+ /**
132
+ * Last name.
133
+ * @maxLength 255
134
+ */
79
135
  lastName?: string | null;
80
136
  /** Form response. */
81
137
  formResponse?: FormResponse;
@@ -83,25 +139,47 @@ export interface GuestDetails {
83
139
  checkedIn?: boolean;
84
140
  /** The login details for the guest to access the online conference event. */
85
141
  onlineConferencingLogin?: OnlineConferencingLogin;
86
- /** Phone extracted from form response. If multiples phone inputs are present, first one is returned. */
142
+ /**
143
+ * Phone extracted from form response. If multiples phone inputs are present, first one is returned.
144
+ * @maxLength 200
145
+ */
87
146
  phone?: string | null;
88
- /** Address extracted from form response. If multiples address inputs are present, first one is returned. */
147
+ /**
148
+ * Address extracted from form response. If multiples address inputs are present, first one is returned.
149
+ * @maxLength 200
150
+ */
89
151
  address?: string | null;
90
152
  }
91
153
  export interface FormResponse {
92
- /** Input values entered when filling the form. */
154
+ /**
155
+ * Input values entered when filling the form.
156
+ * @maxSize 200
157
+ */
93
158
  inputValues?: InputValue[];
94
159
  }
95
160
  export interface InputValue {
96
- /** Input field name. */
161
+ /**
162
+ * Input field name.
163
+ * @maxLength 100
164
+ */
97
165
  inputName?: string;
98
- /** Text entered into the input field. */
166
+ /**
167
+ * Text entered into the input field.
168
+ * @maxLength 5000
169
+ */
99
170
  value?: string;
100
- /** Multiple selection values. For example, the array is filled if several checkboxes are ticked. */
171
+ /**
172
+ * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
173
+ * @maxSize 100
174
+ * @maxLength 5000
175
+ */
101
176
  values?: string[];
102
177
  }
103
178
  export interface FormattedAddress {
104
- /** One line address representation. */
179
+ /**
180
+ * One line address representation.
181
+ * @maxLength 200
182
+ */
105
183
  formatted?: string;
106
184
  /** Address components (optional). */
107
185
  address?: Address;
@@ -112,7 +190,10 @@ export interface Address extends AddressStreetOneOf {
112
190
  streetAddress?: StreetAddress;
113
191
  /** Main address line, usually street and number as free text. */
114
192
  addressLine1?: string | null;
115
- /** Country code. */
193
+ /**
194
+ * Country code.
195
+ * @format COUNTRY
196
+ */
116
197
  country?: string | null;
117
198
  /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
118
199
  subdivision?: string | null;
@@ -165,7 +246,10 @@ export declare enum SubdivisionType {
165
246
  }
166
247
  /** Subdivision Concordance values */
167
248
  export interface StandardDetails {
168
- /** 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 */
249
+ /**
250
+ * 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
251
+ * @maxLength 20
252
+ */
169
253
  iso31662?: string | null;
170
254
  }
171
255
  export declare enum AttendanceStatus {
@@ -187,7 +271,10 @@ export declare enum GuestType {
187
271
  export interface GuestCountUpdated {
188
272
  /** Guest. */
189
273
  guest?: EventGuest;
190
- /** Guest count updates. */
274
+ /**
275
+ * Guest count updates.
276
+ * @maxSize 2
277
+ */
191
278
  guestCountUpdates?: GuestCountUpdate[];
192
279
  }
193
280
  export interface GuestCountUpdate {
@@ -199,9 +286,15 @@ export interface GuestCountUpdate {
199
286
  countDelta?: number;
200
287
  }
201
288
  export interface MemberEventStatusUpdated {
202
- /** Event id. */
289
+ /**
290
+ * Event id.
291
+ * @format GUID
292
+ */
203
293
  eventId?: string | null;
204
- /** Member id. */
294
+ /**
295
+ * Member id.
296
+ * @format GUID
297
+ */
205
298
  memberId?: string | null;
206
299
  /** Member event status. */
207
300
  status?: MemberEventStatusUpdatedEventType;
@@ -230,9 +323,15 @@ export declare enum MemberEventStatusUpdatedEventType {
230
323
  LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
231
324
  }
232
325
  export interface ContactEventStatusUpdated {
233
- /** Event id. */
326
+ /**
327
+ * Event id.
328
+ * @format GUID
329
+ */
234
330
  eventId?: string | null;
235
- /** Contact id. */
331
+ /**
332
+ * Contact id.
333
+ * @format GUID
334
+ */
236
335
  contactId?: string | null;
237
336
  /** Contact event status. */
238
337
  status?: EventType;
@@ -264,11 +363,14 @@ export interface GuestCheckedIn {
264
363
  export interface EventDetails {
265
364
  /**
266
365
  * Event title.
366
+ * @minLength 1
367
+ * @maxLength 120
267
368
  * @readonly
268
369
  */
269
370
  title?: string | null;
270
371
  /**
271
372
  * Event short description.
373
+ * @maxLength 500
272
374
  * @readonly
273
375
  */
274
376
  shortDescription?: string | null;
@@ -294,7 +396,10 @@ export interface EventDetails {
294
396
  status?: Status;
295
397
  }
296
398
  export interface Location {
297
- /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
399
+ /**
400
+ * Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
401
+ * @maxLength 50
402
+ */
298
403
  name?: string | null;
299
404
  /** Location type. */
300
405
  type?: LocationType;
@@ -315,42 +420,83 @@ export declare enum LocationType {
315
420
  export interface CommonAddress extends CommonAddressStreetOneOf {
316
421
  /** Street address. */
317
422
  streetAddress?: CommonStreetAddress;
318
- /** Primary address information (street and building number). */
423
+ /**
424
+ * Primary address information (street and building number).
425
+ * @maxLength 250
426
+ */
319
427
  addressLine1?: string | null;
320
- /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
428
+ /**
429
+ * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
430
+ * @format COUNTRY
431
+ */
321
432
  country?: string | null;
322
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
433
+ /**
434
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
435
+ * @maxLength 20
436
+ */
323
437
  subdivision?: string | null;
324
- /** City name. */
438
+ /**
439
+ * City name.
440
+ * @maxLength 100
441
+ */
325
442
  city?: string | null;
326
- /** Zip or postal code. */
443
+ /**
444
+ * Zip or postal code.
445
+ * @maxLength 100
446
+ */
327
447
  postalCode?: string | null;
328
- /** Secondary address information (suite or apartment number and room number). */
448
+ /**
449
+ * Secondary address information (suite or apartment number and room number).
450
+ * @maxLength 250
451
+ */
329
452
  addressLine2?: string | null;
330
453
  }
331
454
  /** @oneof */
332
455
  export interface CommonAddressStreetOneOf {
333
456
  /** Street address. */
334
457
  streetAddress?: CommonStreetAddress;
335
- /** Primary address information (street and building number). */
458
+ /**
459
+ * Primary address information (street and building number).
460
+ * @maxLength 250
461
+ */
336
462
  addressLine?: string | null;
337
463
  }
338
464
  export interface CommonStreetAddress {
339
- /** Street number. */
465
+ /**
466
+ * Street number.
467
+ * @maxLength 100
468
+ */
340
469
  number?: string;
341
- /** Street name. */
470
+ /**
471
+ * Street name.
472
+ * @maxLength 250
473
+ */
342
474
  name?: string;
343
475
  }
344
476
  export interface CommonAddressLocation {
345
- /** Address latitude coordinates. */
477
+ /**
478
+ * Address latitude coordinates.
479
+ * @min -90
480
+ * @max 90
481
+ */
346
482
  latitude?: number | null;
347
- /** Address longitude coordinates. */
483
+ /**
484
+ * Address longitude coordinates.
485
+ * @min -180
486
+ * @max 180
487
+ */
348
488
  longitude?: number | null;
349
489
  }
350
490
  export interface CommonSubdivision {
351
- /** Short subdivision code. */
491
+ /**
492
+ * Short subdivision code.
493
+ * @maxLength 100
494
+ */
352
495
  code?: string;
353
- /** Subdivision full name. */
496
+ /**
497
+ * Subdivision full name.
498
+ * @maxLength 250
499
+ */
354
500
  name?: string;
355
501
  }
356
502
  export declare enum SubdivisionSubdivisionType {
@@ -371,13 +517,19 @@ export declare enum SubdivisionSubdivisionType {
371
517
  export interface DateAndTimeSettings {
372
518
  /** Whether the event date and time are TBD. */
373
519
  dateAndTimeTbd?: boolean | null;
374
- /** Message that is displayed when time and date is TBD. */
520
+ /**
521
+ * Message that is displayed when time and date is TBD.
522
+ * @maxLength 100
523
+ */
375
524
  dateAndTimeTbdMessage?: string | null;
376
525
  /** Event start date. */
377
526
  startDate?: Date | null;
378
527
  /** Event end date. */
379
528
  endDate?: Date | null;
380
- /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
529
+ /**
530
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
531
+ * @maxLength 100
532
+ */
381
533
  timeZoneId?: string | null;
382
534
  /** Whether the end date is hidden in the formatted date and time. */
383
535
  hideEndDate?: boolean | null;
@@ -408,11 +560,15 @@ export declare enum RecurrenceStatusStatus {
408
560
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
409
561
  }
410
562
  export interface Recurrences {
411
- /** Individual event dates. */
563
+ /**
564
+ * Individual event dates.
565
+ * @maxSize 1000
566
+ */
412
567
  individualEventDates?: Occurrence[];
413
568
  /**
414
569
  * Recurring event category ID.
415
570
  * @readonly
571
+ * @maxLength 100
416
572
  */
417
573
  categoryId?: string | null;
418
574
  }
@@ -421,7 +577,10 @@ export interface Occurrence {
421
577
  startDate?: Date | null;
422
578
  /** Event end date. */
423
579
  endDate?: Date | null;
424
- /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
580
+ /**
581
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
582
+ * @maxLength 100
583
+ */
425
584
  timeZoneId?: string | null;
426
585
  /** Whether the time zone is displayed in a formatted schedule. */
427
586
  showTimeZone?: boolean;
@@ -432,26 +591,31 @@ export interface Formatted {
432
591
  * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
433
592
  * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
434
593
  * @readonly
594
+ * @maxLength 500
435
595
  */
436
596
  dateAndTime?: string | null;
437
597
  /**
438
598
  * Formatted start date of the event. Empty for TBD schedules.
439
599
  * @readonly
600
+ * @maxLength 500
440
601
  */
441
602
  startDate?: string | null;
442
603
  /**
443
604
  * Formatted start time of the event. Empty for TBD schedules.
444
605
  * @readonly
606
+ * @maxLength 500
445
607
  */
446
608
  startTime?: string | null;
447
609
  /**
448
610
  * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
449
611
  * @readonly
612
+ * @maxLength 500
450
613
  */
451
614
  endDate?: string | null;
452
615
  /**
453
616
  * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
454
617
  * @readonly
618
+ * @maxLength 500
455
619
  */
456
620
  endTime?: string | null;
457
621
  }
@@ -577,9 +741,16 @@ export interface Invoice {
577
741
  previewUrl?: string | null;
578
742
  }
579
743
  export interface Item {
580
- /** Unique line item ID. */
744
+ /**
745
+ * Unique line item ID.
746
+ * @format GUID
747
+ */
581
748
  _id?: string;
582
- /** Line item quantity. */
749
+ /**
750
+ * Line item quantity.
751
+ * @min 1
752
+ * @max 50
753
+ */
583
754
  quantity?: number;
584
755
  /** Line item name. */
585
756
  name?: string;
@@ -600,12 +771,19 @@ export interface Item {
600
771
  export interface Money {
601
772
  /**
602
773
  * *Deprecated:** Use `value` instead.
774
+ * @format DECIMAL_VALUE
603
775
  * @deprecated
604
776
  */
605
777
  amount?: string;
606
- /** ISO 4217 format of the currency e.g., `USD`. */
778
+ /**
779
+ * ISO 4217 format of the currency e.g., `USD`.
780
+ * @format CURRENCY
781
+ */
607
782
  currency?: string;
608
- /** 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. */
783
+ /**
784
+ * 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.
785
+ * @format DECIMAL_VALUE
786
+ */
609
787
  value?: string | null;
610
788
  }
611
789
  export interface Discount {
@@ -666,7 +844,10 @@ export interface PaidPlanDiscountDiscountOneOf {
666
844
  percentDiscount?: PercentDiscount;
667
845
  }
668
846
  export interface PercentDiscount {
669
- /** Percent rate. */
847
+ /**
848
+ * Percent rate.
849
+ * @decimalValue options - {gte:0.01,lte:100,maxScale:2}
850
+ */
670
851
  rate?: string;
671
852
  /** Number of discounted tickets. */
672
853
  quantityDiscounted?: number;
@@ -679,7 +860,10 @@ export interface Tax {
679
860
  * @readonly
680
861
  */
681
862
  name?: string;
682
- /** Tax rate. */
863
+ /**
864
+ * Tax rate.
865
+ * @format DECIMAL_VALUE
866
+ */
683
867
  rate?: string;
684
868
  /** Taxable amount. */
685
869
  taxable?: Money;
@@ -701,6 +885,7 @@ export interface Fee {
701
885
  type?: FeeType;
702
886
  /**
703
887
  * Fee rate.
888
+ * @format DECIMAL_VALUE
704
889
  * @readonly
705
890
  */
706
891
  rate?: string;
@@ -812,9 +997,15 @@ export interface ActionEvent {
812
997
  body?: string;
813
998
  }
814
999
  export interface MessageEnvelope {
815
- /** App instance ID. */
1000
+ /**
1001
+ * App instance ID.
1002
+ * @format GUID
1003
+ */
816
1004
  instanceId?: string | null;
817
- /** Event type. */
1005
+ /**
1006
+ * Event type.
1007
+ * @maxLength 150
1008
+ */
818
1009
  eventType?: string;
819
1010
  /** The identification type and identity data. */
820
1011
  identity?: IdentificationData;
@@ -822,26 +1013,50 @@ export interface MessageEnvelope {
822
1013
  data?: string;
823
1014
  }
824
1015
  export interface IdentificationData extends IdentificationDataIdOneOf {
825
- /** ID of a site visitor that has not logged in to the site. */
1016
+ /**
1017
+ * ID of a site visitor that has not logged in to the site.
1018
+ * @format GUID
1019
+ */
826
1020
  anonymousVisitorId?: string;
827
- /** ID of a site visitor that has logged in to the site. */
1021
+ /**
1022
+ * ID of a site visitor that has logged in to the site.
1023
+ * @format GUID
1024
+ */
828
1025
  memberId?: string;
829
- /** ID of a Wix user (site owner, contributor, etc.). */
1026
+ /**
1027
+ * ID of a Wix user (site owner, contributor, etc.).
1028
+ * @format GUID
1029
+ */
830
1030
  wixUserId?: string;
831
- /** ID of an app. */
1031
+ /**
1032
+ * ID of an app.
1033
+ * @format GUID
1034
+ */
832
1035
  appId?: string;
833
1036
  /** @readonly */
834
1037
  identityType?: WebhookIdentityType;
835
1038
  }
836
1039
  /** @oneof */
837
1040
  export interface IdentificationDataIdOneOf {
838
- /** ID of a site visitor that has not logged in to the site. */
1041
+ /**
1042
+ * ID of a site visitor that has not logged in to the site.
1043
+ * @format GUID
1044
+ */
839
1045
  anonymousVisitorId?: string;
840
- /** ID of a site visitor that has logged in to the site. */
1046
+ /**
1047
+ * ID of a site visitor that has logged in to the site.
1048
+ * @format GUID
1049
+ */
841
1050
  memberId?: string;
842
- /** ID of a Wix user (site owner, contributor, etc.). */
1051
+ /**
1052
+ * ID of a Wix user (site owner, contributor, etc.).
1053
+ * @format GUID
1054
+ */
843
1055
  wixUserId?: string;
844
- /** ID of an app. */
1056
+ /**
1057
+ * ID of an app.
1058
+ * @format GUID
1059
+ */
845
1060
  appId?: string;
846
1061
  }
847
1062
  export declare enum WebhookIdentityType {
@@ -854,7 +1069,10 @@ export declare enum WebhookIdentityType {
854
1069
  export interface QueryEventGuestsRequest {
855
1070
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
856
1071
  query: QueryV2;
857
- /** Predefined sets of fields to return. */
1072
+ /**
1073
+ * Predefined sets of fields to return.
1074
+ * @maxSize 3
1075
+ */
858
1076
  fields?: RequestedFieldsEnumRequestedFields[];
859
1077
  }
860
1078
  export interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -882,7 +1100,10 @@ export interface QueryV2PagingMethodOneOf {
882
1100
  cursorPaging?: CursorPaging;
883
1101
  }
884
1102
  export interface Sorting {
885
- /** Name of the field to sort by. */
1103
+ /**
1104
+ * Name of the field to sort by.
1105
+ * @maxLength 512
1106
+ */
886
1107
  fieldName?: string;
887
1108
  /** Sort order. */
888
1109
  order?: SortOrder;
@@ -892,19 +1113,26 @@ export declare enum SortOrder {
892
1113
  DESC = "DESC"
893
1114
  }
894
1115
  export interface Paging {
895
- /** Number of items to load. */
1116
+ /**
1117
+ * Number of items to load.
1118
+ * @max 1000
1119
+ */
896
1120
  limit?: number | null;
897
1121
  /** Number of items to skip in the current sort order. */
898
1122
  offset?: number | null;
899
1123
  }
900
1124
  export interface CursorPaging {
901
- /** Maximum number of items to return in the results. */
1125
+ /**
1126
+ * Maximum number of items to return in the results.
1127
+ * @max 1000
1128
+ */
902
1129
  limit?: number | null;
903
1130
  /**
904
1131
  * Pointer to the next or previous page in the list of results.
905
1132
  *
906
1133
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
907
1134
  * Not relevant for the first request.
1135
+ * @maxLength 16000
908
1136
  */
909
1137
  cursor?: string | null;
910
1138
  }
@@ -935,9 +1163,15 @@ export interface PagingMetadataV2 {
935
1163
  cursors?: Cursors;
936
1164
  }
937
1165
  export interface Cursors {
938
- /** Cursor string pointing to the next page in the list of results. */
1166
+ /**
1167
+ * Cursor string pointing to the next page in the list of results.
1168
+ * @maxLength 16000
1169
+ */
939
1170
  next?: string | null;
940
- /** Cursor pointing to the previous page in the list of results. */
1171
+ /**
1172
+ * Cursor pointing to the previous page in the list of results.
1173
+ * @maxLength 16000
1174
+ */
941
1175
  prev?: string | null;
942
1176
  }
943
1177
  export interface StreamEventGuestsRequest {
@@ -949,37 +1183,61 @@ export interface StreamEventGuestsRequest {
949
1183
  export interface Empty {
950
1184
  }
951
1185
  export interface SecondaryLanguagesRequest {
952
- /** Guest event id. */
1186
+ /**
1187
+ * Guest event id.
1188
+ * @format GUID
1189
+ */
953
1190
  eventId?: string;
954
1191
  }
955
1192
  export interface SecondaryLanguagesResponse {
956
- /** Aggregated guests secondary languages. */
1193
+ /**
1194
+ * Aggregated guests secondary languages.
1195
+ * @format LANGUAGE
1196
+ */
957
1197
  secondaryLanguages?: string[];
958
1198
  /** Aggregated guests languages. */
959
1199
  languages?: Language[];
960
1200
  }
961
1201
  export interface Language {
962
- /** Guest language. */
1202
+ /**
1203
+ * Guest language.
1204
+ * @format LANGUAGE
1205
+ */
963
1206
  language?: string | null;
964
- /** Guest locale. */
1207
+ /**
1208
+ * Guest locale.
1209
+ * @format LANGUAGE_TAG
1210
+ */
965
1211
  locale?: string | null;
966
1212
  }
967
1213
  export interface OrderConfirmed {
968
1214
  /** Order confirmation timestamp in ISO UTC. */
969
1215
  timestamp?: Date | null;
970
- /** Site language when Order initiated */
1216
+ /**
1217
+ * Site language when Order initiated
1218
+ * @format LANGUAGE
1219
+ */
971
1220
  language?: string | null;
972
1221
  /** Notifications silenced for this domain event. */
973
1222
  silent?: boolean | null;
974
- /** Locale in which Order was created. */
1223
+ /**
1224
+ * Locale in which Order was created.
1225
+ * @format LANGUAGE_TAG
1226
+ */
975
1227
  locale?: string | null;
976
- /** Event ID. */
1228
+ /**
1229
+ * Event ID.
1230
+ * @format GUID
1231
+ */
977
1232
  eventId?: string;
978
1233
  /** Unique order number. */
979
1234
  orderNumber?: string;
980
1235
  /** Contact ID associated with this order. */
981
1236
  contactId?: string;
982
- /** Member ID associated with this order. */
1237
+ /**
1238
+ * Member ID associated with this order.
1239
+ * @format GUID
1240
+ */
983
1241
  memberId?: string | null;
984
1242
  /**
985
1243
  * Order created timestamp
@@ -1008,7 +1266,10 @@ export interface OrderConfirmed {
1008
1266
  export interface Ticket {
1009
1267
  /** Unique issued ticket number. */
1010
1268
  ticketNumber?: string;
1011
- /** Ticket definition ID. */
1269
+ /**
1270
+ * Ticket definition ID.
1271
+ * @format GUID
1272
+ */
1012
1273
  ticketDefinitionId?: string;
1013
1274
  /** Ticket check-in. */
1014
1275
  checkIn?: CheckIn;
@@ -1022,11 +1283,17 @@ export interface Ticket {
1022
1283
  lastName?: string | null;
1023
1284
  /** Guest email. */
1024
1285
  email?: string | null;
1025
- /** Contact ID associated with this ticket. */
1286
+ /**
1287
+ * Contact ID associated with this ticket.
1288
+ * @format GUID
1289
+ */
1026
1290
  contactId?: string | null;
1027
1291
  /** Whether ticket is confirmed */
1028
1292
  confirmed?: boolean;
1029
- /** Member ID associated with this ticket. */
1293
+ /**
1294
+ * Member ID associated with this ticket.
1295
+ * @format GUID
1296
+ */
1030
1297
  memberId?: string | null;
1031
1298
  /** Ticket form response (only assigned tickets contain separate forms). */
1032
1299
  form?: FormResponse;
@@ -1036,7 +1303,10 @@ export interface Ticket {
1036
1303
  anonymized?: boolean;
1037
1304
  /** URL and password to online conference */
1038
1305
  onlineConferencingLogin?: OnlineConferencingLogin;
1039
- /** Seat ID associated with this ticket. */
1306
+ /**
1307
+ * Seat ID associated with this ticket.
1308
+ * @maxLength 36
1309
+ */
1040
1310
  seatId?: string | null;
1041
1311
  /** Whether ticket is canceled. */
1042
1312
  canceled?: boolean | null;
@@ -1048,17 +1318,29 @@ export interface CheckIn {
1048
1318
  export interface OrderUpdated {
1049
1319
  /** Order updated timestamp in ISO UTC format. */
1050
1320
  timestamp?: Date | null;
1051
- /** Site language when Order initiated */
1321
+ /**
1322
+ * Site language when Order initiated
1323
+ * @format LANGUAGE
1324
+ */
1052
1325
  language?: string | null;
1053
- /** Locale in which Order was created. */
1326
+ /**
1327
+ * Locale in which Order was created.
1328
+ * @format LANGUAGE_TAG
1329
+ */
1054
1330
  locale?: string | null;
1055
- /** Event ID. */
1331
+ /**
1332
+ * Event ID.
1333
+ * @format GUID
1334
+ */
1056
1335
  eventId?: string;
1057
1336
  /** Unique order number. */
1058
1337
  orderNumber?: string;
1059
1338
  /** Contact ID associated with this order. */
1060
1339
  contactId?: string;
1061
- /** Member ID associated with this order. */
1340
+ /**
1341
+ * Member ID associated with this order.
1342
+ * @format GUID
1343
+ */
1062
1344
  memberId?: string | null;
1063
1345
  /**
1064
1346
  * Order created timestamp.
@@ -1094,13 +1376,19 @@ export interface OrderUpdated {
1094
1376
  export interface OrderDeleted {
1095
1377
  /** Order deleted timestamp in ISO UTC format. */
1096
1378
  timestamp?: Date | null;
1097
- /** Event ID. */
1379
+ /**
1380
+ * Event ID.
1381
+ * @format GUID
1382
+ */
1098
1383
  eventId?: string;
1099
1384
  /** Unique order number. */
1100
1385
  orderNumber?: string;
1101
1386
  /** Contact ID associated with this order */
1102
1387
  contactId?: string;
1103
- /** Member ID associated with this order. */
1388
+ /**
1389
+ * Member ID associated with this order.
1390
+ * @format GUID
1391
+ */
1104
1392
  memberId?: string | null;
1105
1393
  /**
1106
1394
  * Order created timestamp.
@@ -1130,11 +1418,17 @@ export declare enum OrderType {
1130
1418
  export interface EventDeleted {
1131
1419
  /** Event deleted timestamp in ISO UTC format. */
1132
1420
  timestamp?: Date | null;
1133
- /** Event ID. */
1421
+ /**
1422
+ * Event ID.
1423
+ * @format GUID
1424
+ */
1134
1425
  eventId?: string;
1135
1426
  /** Event title. */
1136
1427
  title?: string;
1137
- /** Event creator user ID. */
1428
+ /**
1429
+ * Event creator user ID.
1430
+ * @format GUID
1431
+ */
1138
1432
  userId?: string | null;
1139
1433
  }
1140
1434
  export interface Task {
@@ -1148,11 +1442,18 @@ export interface TaskKey {
1148
1442
  subjectId?: string | null;
1149
1443
  }
1150
1444
  export interface ListGuestListPreviewsRequest {
1151
- /** Event ids. */
1445
+ /**
1446
+ * Event ids.
1447
+ * @format GUID
1448
+ * @maxSize 50
1449
+ */
1152
1450
  eventIds?: string[];
1153
1451
  /** Cursor paging. */
1154
1452
  cursorPaging?: CursorPaging;
1155
- /** Requested fields. */
1453
+ /**
1454
+ * Requested fields.
1455
+ * @maxSize 5
1456
+ */
1156
1457
  fields?: RequestedFields[];
1157
1458
  }
1158
1459
  export declare enum RequestedFields {
@@ -1164,13 +1465,19 @@ export declare enum RequestedFields {
1164
1465
  WAITLIST_COUNT = "WAITLIST_COUNT"
1165
1466
  }
1166
1467
  export interface ListGuestListPreviewsResponse {
1167
- /** List of guests. */
1468
+ /**
1469
+ * List of guests.
1470
+ * @maxSize 50
1471
+ */
1168
1472
  previews?: GuestListPreview[];
1169
1473
  /** Metadata for the paginated results. */
1170
1474
  pagingMetadata?: PagingMetadataV2;
1171
1475
  }
1172
1476
  export interface GuestListPreview {
1173
- /** Event id. */
1477
+ /**
1478
+ * Event id.
1479
+ * @format GUID
1480
+ */
1174
1481
  eventId?: string;
1175
1482
  /** Latest attending members. */
1176
1483
  latestAttendingMembers?: EventGuests;
@@ -1182,6 +1489,7 @@ export interface GuestListPreview {
1182
1489
  notAttending?: GuestCount;
1183
1490
  }
1184
1491
  export interface EventGuests {
1492
+ /** @maxSize 8 */
1185
1493
  guests?: EventGuest[];
1186
1494
  }
1187
1495
  export interface GuestCount {
@@ -1250,9 +1558,15 @@ export interface QueryEventGuestsResponseNonNullableFields {
1250
1558
  guests: EventGuestNonNullableFields[];
1251
1559
  }
1252
1560
  export interface BaseEventMetadata {
1253
- /** App instance ID. */
1561
+ /**
1562
+ * App instance ID.
1563
+ * @format GUID
1564
+ */
1254
1565
  instanceId?: string | null;
1255
- /** Event type. */
1566
+ /**
1567
+ * Event type.
1568
+ * @maxLength 150
1569
+ */
1256
1570
  eventType?: string;
1257
1571
  /** The identification type and identity data. */
1258
1572
  identity?: IdentificationData;
@@ -1305,6 +1619,8 @@ export interface GuestCreatedEnvelope {
1305
1619
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1306
1620
  * @permissionScope Manage Events - all permissions
1307
1621
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1622
+ * @permissionScope Manage Events
1623
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1308
1624
  * @permissionScope Manage Guest List
1309
1625
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1310
1626
  * @permissionScope Read Event Tickets and Guest List
@@ -1325,6 +1641,8 @@ export interface GuestDeletedEnvelope {
1325
1641
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1326
1642
  * @permissionScope Manage Events - all permissions
1327
1643
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1644
+ * @permissionScope Manage Events
1645
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1328
1646
  * @permissionScope Manage Guest List
1329
1647
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1330
1648
  * @permissionScope Read Event Tickets and Guest List
@@ -1345,6 +1663,8 @@ export interface GuestCheckedInEnvelope {
1345
1663
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1346
1664
  * @permissionScope Manage Events - all permissions
1347
1665
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1666
+ * @permissionScope Manage Events
1667
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1348
1668
  * @permissionScope Manage Guest List
1349
1669
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1350
1670
  * @permissionScope Read Event Tickets and Guest List
@@ -1365,6 +1685,8 @@ export interface GuestEventCanceledEnvelope {
1365
1685
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1366
1686
  * @permissionScope Manage Events - all permissions
1367
1687
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1688
+ * @permissionScope Manage Events
1689
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1368
1690
  * @permissionScope Manage Guest List
1369
1691
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1370
1692
  * @permissionScope Read Event Tickets and Guest List
@@ -1385,6 +1707,8 @@ export interface GuestEventStartsEnvelope {
1385
1707
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1386
1708
  * @permissionScope Manage Events - all permissions
1387
1709
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1710
+ * @permissionScope Manage Events
1711
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1388
1712
  * @permissionScope Manage Guest List
1389
1713
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1390
1714
  * @permissionScope Read Event Tickets and Guest List
@@ -1405,6 +1729,8 @@ export interface GuestOrderCanceledEnvelope {
1405
1729
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1406
1730
  * @permissionScope Manage Events - all permissions
1407
1731
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1732
+ * @permissionScope Manage Events
1733
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1408
1734
  * @permissionScope Manage Guest List
1409
1735
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1410
1736
  * @permissionScope Read Event Tickets and Guest List
@@ -1425,6 +1751,8 @@ export interface GuestUpdatedEnvelope {
1425
1751
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1426
1752
  * @permissionScope Manage Events - all permissions
1427
1753
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1754
+ * @permissionScope Manage Events
1755
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1428
1756
  * @permissionScope Manage Guest List
1429
1757
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1430
1758
  * @permissionScope Read Event Tickets and Guest List
@@ -1471,7 +1799,10 @@ export declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) =>
1471
1799
  */
1472
1800
  export declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
1473
1801
  export interface QueryEventGuestsOptions {
1474
- /** Predefined sets of fields to return. */
1802
+ /**
1803
+ * Predefined sets of fields to return.
1804
+ * @maxSize 3
1805
+ */
1475
1806
  fields?: RequestedFieldsEnumRequestedFields[] | undefined;
1476
1807
  }
1477
1808
  interface QueryCursorResult {