@wix/auto_sdk_events_orders 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.
@@ -1,18 +1,31 @@
1
1
  export interface Order {
2
2
  /** Unique order number. */
3
3
  orderNumber?: string;
4
- /** Reservation ID. */
4
+ /**
5
+ * Reservation ID.
6
+ * @format GUID
7
+ */
5
8
  reservationId?: string;
6
9
  /**
7
10
  * Payment snapshot ID. Empty for the `FREE` order.
11
+ * @format GUID
8
12
  * @readonly
9
13
  */
10
14
  snapshotId?: string;
11
- /** Event ID to which the order belongs. */
15
+ /**
16
+ * Event ID to which the order belongs.
17
+ * @format GUID
18
+ */
12
19
  eventId?: string;
13
- /** Contact ID of buyer (resolved using email address). */
20
+ /**
21
+ * Contact ID of buyer (resolved using email address).
22
+ * @format GUID
23
+ */
14
24
  contactId?: string;
15
- /** Buyer member ID, if applicable. */
25
+ /**
26
+ * Buyer member ID, if applicable.
27
+ * @format GUID
28
+ */
16
29
  memberId?: string;
17
30
  /**
18
31
  * RSVP created timestamp.
@@ -23,7 +36,10 @@ export interface Order {
23
36
  firstName?: string;
24
37
  /** Guest last name. */
25
38
  lastName?: string;
26
- /** Guest email. */
39
+ /**
40
+ * Guest email.
41
+ * @format EMAIL
42
+ */
27
43
  email?: string;
28
44
  /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
29
45
  checkoutForm?: FormResponse;
@@ -73,19 +89,35 @@ export interface Order {
73
89
  marketingConsent?: boolean | null;
74
90
  }
75
91
  export interface FormResponse {
76
- /** Input fields for a checkout form. */
92
+ /**
93
+ * Input fields for a checkout form.
94
+ * @maxSize 200
95
+ */
77
96
  inputValues?: InputValue[];
78
97
  }
79
98
  export interface InputValue {
80
- /** Input field name. */
99
+ /**
100
+ * Input field name.
101
+ * @maxLength 100
102
+ */
81
103
  inputName?: string;
82
- /** Input field value. */
104
+ /**
105
+ * Input field value.
106
+ * @maxLength 5000
107
+ */
83
108
  value?: string;
84
- /** Multiple input field values. */
109
+ /**
110
+ * Multiple input field values.
111
+ * @maxSize 100
112
+ * @maxLength 5000
113
+ */
85
114
  values?: string[];
86
115
  }
87
116
  export interface FormattedAddress {
88
- /** One line address representation. */
117
+ /**
118
+ * One line address representation.
119
+ * @maxLength 200
120
+ */
89
121
  formatted?: string;
90
122
  /** Address components (optional). */
91
123
  address?: Address;
@@ -96,7 +128,10 @@ export interface Address extends AddressStreetOneOf {
96
128
  streetAddress?: StreetAddress;
97
129
  /** Main address line, usually street and number as free text. */
98
130
  addressLine1?: string | null;
99
- /** Country code. */
131
+ /**
132
+ * Country code.
133
+ * @format COUNTRY
134
+ */
100
135
  country?: string | null;
101
136
  /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
102
137
  subdivision?: string | null;
@@ -149,7 +184,10 @@ export declare enum SubdivisionType {
149
184
  }
150
185
  /** Subdivision Concordance values */
151
186
  export interface StandardDetails {
152
- /** 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 */
187
+ /**
188
+ * 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
189
+ * @maxLength 20
190
+ */
153
191
  iso31662?: string | null;
154
192
  }
155
193
  export declare enum OrderStatus {
@@ -179,12 +217,19 @@ export declare enum OrderStatus {
179
217
  export interface Money {
180
218
  /**
181
219
  * *Deprecated:** Use `value` instead.
220
+ * @format DECIMAL_VALUE
182
221
  * @deprecated
183
222
  */
184
223
  amount?: string;
185
- /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */
224
+ /**
225
+ * Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
226
+ * @format CURRENCY
227
+ */
186
228
  currency?: string;
187
- /** 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. */
229
+ /**
230
+ * 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.
231
+ * @format DECIMAL_VALUE
232
+ */
188
233
  value?: string | null;
189
234
  }
190
235
  export interface TicketingTicket {
@@ -192,7 +237,10 @@ export interface TicketingTicket {
192
237
  ticketNumber?: string;
193
238
  /** Associated order number. */
194
239
  orderNumber?: string;
195
- /** Ticket definition ID. */
240
+ /**
241
+ * Ticket definition ID.
242
+ * @format GUID
243
+ */
196
244
  ticketDefinitionId?: string;
197
245
  /** Ticket name. */
198
246
  name?: string;
@@ -229,7 +277,10 @@ export interface TicketingTicket {
229
277
  * @deprecated
230
278
  */
231
279
  ticketPdf?: string;
232
- /** Ticket owner member ID. */
280
+ /**
281
+ * Ticket owner member ID.
282
+ * @format GUID
283
+ */
233
284
  memberId?: string | null;
234
285
  /**
235
286
  * Whether ticket was anonymized by GDPR delete.
@@ -249,6 +300,7 @@ export interface TicketingTicket {
249
300
  channel?: ChannelType;
250
301
  /**
251
302
  * URL to download ticket in the `.pkpass` format for Apple Wallet
303
+ * @format WEB_URL
252
304
  * @readonly
253
305
  */
254
306
  walletPassUrl?: string;
@@ -269,13 +321,22 @@ export interface GuestDetails {
269
321
  firstName?: string | null;
270
322
  /** Guest last name. */
271
323
  lastName?: string | null;
272
- /** Guest email. */
324
+ /**
325
+ * Guest email.
326
+ * @format EMAIL
327
+ */
273
328
  email?: string | null;
274
329
  /** Full form response. */
275
330
  form?: FormResponse;
276
- /** Contact ID associated with this guest. */
331
+ /**
332
+ * Contact ID associated with this guest.
333
+ * @format GUID
334
+ */
277
335
  contactId?: string | null;
278
- /** Guest phone number. */
336
+ /**
337
+ * Guest phone number.
338
+ * @format PHONE
339
+ */
279
340
  phone?: string | null;
280
341
  }
281
342
  export declare enum ChannelType {
@@ -285,7 +346,11 @@ export declare enum ChannelType {
285
346
  OFFLINE_POS = "OFFLINE_POS"
286
347
  }
287
348
  export interface TicketDetails {
288
- /** Unique seat id in the event venue. */
349
+ /**
350
+ * Unique seat id in the event venue.
351
+ * @minLength 1
352
+ * @maxLength 36
353
+ */
289
354
  seatId?: string | null;
290
355
  /**
291
356
  * Optional sector label.
@@ -312,11 +377,21 @@ export interface TicketDetails {
312
377
  * @readonly
313
378
  */
314
379
  seatLabel?: string | null;
315
- /** Number of places in the spot. If not provided - defaults to 1. */
380
+ /**
381
+ * Number of places in the spot. If not provided - defaults to 1.
382
+ * @min 1
383
+ * @max 50
384
+ */
316
385
  capacity?: number | null;
317
- /** Custom pricing of ticket. */
386
+ /**
387
+ * Custom pricing of ticket.
388
+ * @format DECIMAL_VALUE
389
+ */
318
390
  priceOverride?: string | null;
319
- /** Pricing option id. */
391
+ /**
392
+ * Pricing option id.
393
+ * @format GUID
394
+ */
320
395
  pricingOptionId?: string | null;
321
396
  /**
322
397
  * Pricing option name.
@@ -358,9 +433,16 @@ export interface Invoice {
358
433
  previewUrl?: string | null;
359
434
  }
360
435
  export interface Item {
361
- /** Unique line item ID. */
436
+ /**
437
+ * Unique line item ID.
438
+ * @format GUID
439
+ */
362
440
  _id?: string;
363
- /** Line item quantity. */
441
+ /**
442
+ * Line item quantity.
443
+ * @min 1
444
+ * @max 50
445
+ */
364
446
  quantity?: number;
365
447
  /** Line item name. */
366
448
  name?: string;
@@ -436,7 +518,10 @@ export interface PaidPlanDiscountDiscountOneOf {
436
518
  percentDiscount?: PercentDiscount;
437
519
  }
438
520
  export interface PercentDiscount {
439
- /** Percent rate. */
521
+ /**
522
+ * Percent rate.
523
+ * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
524
+ */
440
525
  rate?: string;
441
526
  /** Number of discounted tickets. */
442
527
  quantityDiscounted?: number;
@@ -449,7 +534,10 @@ export interface Tax {
449
534
  * @readonly
450
535
  */
451
536
  name?: string;
452
- /** Tax rate. */
537
+ /**
538
+ * Tax rate.
539
+ * @format DECIMAL_VALUE
540
+ */
453
541
  rate?: string;
454
542
  /** Taxable amount. */
455
543
  taxable?: Money;
@@ -471,6 +559,7 @@ export interface Fee {
471
559
  type?: FeeType;
472
560
  /**
473
561
  * Fee rate.
562
+ * @format DECIMAL_VALUE
474
563
  * @readonly
475
564
  */
476
565
  rate?: string;
@@ -496,6 +585,7 @@ export interface PaymentDetails {
496
585
  export interface PaymentTransaction {
497
586
  /**
498
587
  * Wix Payments transaction id
588
+ * @format GUID
499
589
  * @readonly
500
590
  */
501
591
  transactionId?: string;
@@ -526,15 +616,24 @@ export declare enum Action {
526
616
  VOID = "VOID"
527
617
  }
528
618
  export interface GiftCardPaymentDetails {
529
- /** Gift card payment id. */
619
+ /**
620
+ * Gift card payment id.
621
+ * @format GUID
622
+ */
530
623
  giftCardPaymentId?: string | null;
531
- /** ID of the app that created the gift card. */
624
+ /**
625
+ * ID of the app that created the gift card.
626
+ * @format GUID
627
+ */
532
628
  appId?: string | null;
533
629
  /** Whether the gift card payment is voided. */
534
630
  voided?: boolean | null;
535
631
  /** Amount */
536
632
  amount?: Money;
537
- /** Obfuscated gift card code. */
633
+ /**
634
+ * Obfuscated gift card code.
635
+ * @maxLength 30
636
+ */
538
637
  obfuscatedCode?: string | null;
539
638
  }
540
639
  export interface BalanceSummary {
@@ -544,13 +643,19 @@ export interface BalanceSummary {
544
643
  export interface OrderDeleted {
545
644
  /** Order deleted timestamp in ISO UTC format. */
546
645
  timestamp?: Date | null;
547
- /** Event ID to which the order belongs. */
646
+ /**
647
+ * Event ID to which the order belongs.
648
+ * @format GUID
649
+ */
548
650
  eventId?: string;
549
651
  /** Unique order number. */
550
652
  orderNumber?: string;
551
653
  /** Contact ID associated with this order */
552
654
  contactId?: string;
553
- /** Member ID associated with this order. */
655
+ /**
656
+ * Member ID associated with this order.
657
+ * @format GUID
658
+ */
554
659
  memberId?: string | null;
555
660
  /**
556
661
  * Order created timestamp.
@@ -580,7 +685,10 @@ export declare enum OrderType {
580
685
  export interface Ticket {
581
686
  /** Unique issued ticket number. */
582
687
  ticketNumber?: string;
583
- /** Ticket definition ID. */
688
+ /**
689
+ * Ticket definition ID.
690
+ * @format GUID
691
+ */
584
692
  ticketDefinitionId?: string;
585
693
  /** Ticket check-in. */
586
694
  checkIn?: CheckIn;
@@ -594,11 +702,17 @@ export interface Ticket {
594
702
  lastName?: string | null;
595
703
  /** Guest email. */
596
704
  email?: string | null;
597
- /** Contact ID associated with this ticket. */
705
+ /**
706
+ * Contact ID associated with this ticket.
707
+ * @format GUID
708
+ */
598
709
  contactId?: string | null;
599
710
  /** Whether ticket is confirmed */
600
711
  confirmed?: boolean;
601
- /** Member ID associated with this ticket. */
712
+ /**
713
+ * Member ID associated with this ticket.
714
+ * @format GUID
715
+ */
602
716
  memberId?: string | null;
603
717
  /** Ticket form response (only assigned tickets contain separate forms). */
604
718
  form?: FormResponse;
@@ -608,7 +722,10 @@ export interface Ticket {
608
722
  anonymized?: boolean;
609
723
  /** URL and password to online conference */
610
724
  onlineConferencingLogin?: OnlineConferencingLogin;
611
- /** Seat ID associated with this ticket. */
725
+ /**
726
+ * Seat ID associated with this ticket.
727
+ * @maxLength 36
728
+ */
612
729
  seatId?: string | null;
613
730
  /** Whether ticket is canceled. */
614
731
  canceled?: boolean | null;
@@ -616,6 +733,7 @@ export interface Ticket {
616
733
  export interface OnlineConferencingLogin {
617
734
  /**
618
735
  * Link URL to the online conference.
736
+ * @format WEB_URL
619
737
  * @readonly
620
738
  */
621
739
  link?: string;
@@ -628,7 +746,10 @@ export interface OnlineConferencingLogin {
628
746
  export interface ListOrdersRequest {
629
747
  /** Offset. */
630
748
  offset?: number;
631
- /** Limit. */
749
+ /**
750
+ * Limit.
751
+ * @max 400
752
+ */
632
753
  limit?: number;
633
754
  /**
634
755
  * Predefined sets of fields to return.
@@ -639,6 +760,7 @@ export interface ListOrdersRequest {
639
760
  *
640
761
  * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
641
762
  *
763
+ * @maxSize 20
642
764
  */
643
765
  fieldset?: OrderFieldset[];
644
766
  /**
@@ -652,26 +774,54 @@ export interface ListOrdersRequest {
652
774
  * - `DECLINED`: The order is payment is declined.
653
775
  */
654
776
  status?: OrderStatus[];
655
- /** Event ID to which the order belongs. */
777
+ /**
778
+ * Event ID to which the order belongs.
779
+ * @format GUID
780
+ * @maxSize 100
781
+ */
656
782
  eventId?: string[];
657
- /** Order number. */
783
+ /**
784
+ * Order number.
785
+ * @maxLength 36
786
+ * @maxSize 500
787
+ */
658
788
  orderNumber?: string[];
659
- /** Site member ID. */
789
+ /**
790
+ * Site member ID.
791
+ * @format GUID
792
+ * @maxSize 500
793
+ */
660
794
  memberId?: string[];
661
- /** Field facets, */
795
+ /**
796
+ * Field facets,
797
+ * @maxLength 100
798
+ * @maxSize 20
799
+ */
662
800
  facet?: string[];
663
- /** Search filter. You can search `fullName`, `email` and `orderNumber`. */
801
+ /**
802
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
803
+ * @maxLength 200
804
+ */
664
805
  searchPhrase?: string;
665
- /** Event creator ID. */
806
+ /**
807
+ * Event creator ID.
808
+ * @format GUID
809
+ * @maxSize 50
810
+ */
666
811
  eventCreatorId?: string[];
667
812
  /**
668
813
  * Sort order.
669
814
  * Default: `created:asc`.
815
+ * @maxLength 100
670
816
  */
671
817
  sort?: string;
672
818
  /** Order tag. */
673
819
  tag?: OrderTag[];
674
- /** Guest contact IDs. */
820
+ /**
821
+ * Guest contact IDs.
822
+ * @format GUID
823
+ * @maxSize 100
824
+ */
675
825
  contactId?: string[];
676
826
  }
677
827
  export declare enum OrderFieldset {
@@ -705,7 +855,10 @@ export interface ListOrdersResponse {
705
855
  total?: number;
706
856
  /** Offset. */
707
857
  offset?: number;
708
- /** Limit. */
858
+ /**
859
+ * Limit.
860
+ * @max 100
861
+ */
709
862
  limit?: number;
710
863
  /** Orders. */
711
864
  orders?: Order[];
@@ -735,9 +888,15 @@ export interface Counts {
735
888
  ticketsCheckIn?: number;
736
889
  }
737
890
  export interface GetOrderRequest {
738
- /** Event ID to which the order belongs. */
891
+ /**
892
+ * Event ID to which the order belongs.
893
+ * @format GUID
894
+ */
739
895
  eventId: string;
740
- /** Unique order number. */
896
+ /**
897
+ * Unique order number.
898
+ * @maxLength 36
899
+ */
741
900
  orderNumber: string;
742
901
  /**
743
902
  * Predefined sets of fields to return.
@@ -748,6 +907,7 @@ export interface GetOrderRequest {
748
907
  *
749
908
  * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
750
909
  *
910
+ * @maxSize 20
751
911
  */
752
912
  fieldset?: OrderFieldset[];
753
913
  }
@@ -764,9 +924,15 @@ export interface CalendarLinks {
764
924
  ics?: string;
765
925
  }
766
926
  export interface UpdateOrderRequest {
767
- /** Event ID to which the order belongs. */
927
+ /**
928
+ * Event ID to which the order belongs.
929
+ * @format GUID
930
+ */
768
931
  eventId: string;
769
- /** Unique order number. */
932
+ /**
933
+ * Unique order number.
934
+ * @maxLength 36
935
+ */
770
936
  orderNumber: string;
771
937
  /** Set of field paths to update. */
772
938
  fields?: string[];
@@ -782,17 +948,29 @@ export interface UpdateOrderResponse {
782
948
  export interface OrderUpdated {
783
949
  /** Order updated timestamp in ISO UTC format. */
784
950
  timestamp?: Date | null;
785
- /** Site language when Order initiated */
951
+ /**
952
+ * Site language when Order initiated
953
+ * @format LANGUAGE
954
+ */
786
955
  language?: string | null;
787
- /** Locale in which Order was created. */
956
+ /**
957
+ * Locale in which Order was created.
958
+ * @format LANGUAGE_TAG
959
+ */
788
960
  locale?: string | null;
789
- /** Event ID to which the order belongs. */
961
+ /**
962
+ * Event ID to which the order belongs.
963
+ * @format GUID
964
+ */
790
965
  eventId?: string;
791
966
  /** Unique order number. */
792
967
  orderNumber?: string;
793
968
  /** Contact ID associated with this order. */
794
969
  contactId?: string;
795
- /** Member ID associated with this order. */
970
+ /**
971
+ * Member ID associated with this order.
972
+ * @format GUID
973
+ */
796
974
  memberId?: string | null;
797
975
  /**
798
976
  * Order created timestamp.
@@ -835,8 +1013,17 @@ export interface OrderUpdated {
835
1013
  triggeredByAnonymizeRequest?: boolean;
836
1014
  }
837
1015
  export interface BulkUpdateOrdersRequest {
838
- /** Event ID to which the order belongs. */
1016
+ /**
1017
+ * Event ID to which the order belongs.
1018
+ * @format GUID
1019
+ */
839
1020
  eventId: string;
1021
+ /**
1022
+ * @minLength 1
1023
+ * @maxLength 36
1024
+ * @minSize 1
1025
+ * @maxSize 100
1026
+ */
840
1027
  orderNumber?: string[];
841
1028
  /** Set of fields to update. */
842
1029
  fields?: string[];
@@ -848,9 +1035,17 @@ export interface BulkUpdateOrdersResponse {
848
1035
  orders?: Order[];
849
1036
  }
850
1037
  export interface ConfirmOrderRequest {
851
- /** Event ID to which the order belongs. */
1038
+ /**
1039
+ * Event ID to which the order belongs.
1040
+ * @format GUID
1041
+ */
852
1042
  eventId: string;
853
- /** Order numbers. */
1043
+ /**
1044
+ * Order numbers.
1045
+ * @minLength 1
1046
+ * @maxLength 36
1047
+ * @maxSize 100
1048
+ */
854
1049
  orderNumber?: string[];
855
1050
  }
856
1051
  export interface ConfirmOrderResponse {
@@ -858,7 +1053,10 @@ export interface ConfirmOrderResponse {
858
1053
  orders?: Order[];
859
1054
  }
860
1055
  export interface GetSummaryRequest {
861
- /** Event ID. */
1056
+ /**
1057
+ * Event ID.
1058
+ * @format GUID
1059
+ */
862
1060
  eventId?: string | null;
863
1061
  }
864
1062
  export interface GetSummaryResponse {
@@ -876,7 +1074,10 @@ export interface TicketSales {
876
1074
  revenue?: Money;
877
1075
  }
878
1076
  export interface GetInvoicePreviewRequest {
879
- /** Event ID to which the invoice belongs. */
1077
+ /**
1078
+ * Event ID to which the invoice belongs.
1079
+ * @format GUID
1080
+ */
880
1081
  eventId?: string;
881
1082
  /** Order number. */
882
1083
  orderNumber?: string;
@@ -891,7 +1092,10 @@ export interface HeadersEntry {
891
1092
  value?: string;
892
1093
  }
893
1094
  export interface GetPaymentInfoRequest {
894
- /** Event ID. */
1095
+ /**
1096
+ * Event ID.
1097
+ * @format GUID
1098
+ */
895
1099
  eventId?: string;
896
1100
  /** Order number. */
897
1101
  orderNumber?: string;
@@ -899,12 +1103,16 @@ export interface GetPaymentInfoRequest {
899
1103
  export interface GetPaymentInfoResponse {
900
1104
  transactions?: PaymentTransactionSummary[];
901
1105
  status?: string | null;
902
- /** @readonly */
1106
+ /**
1107
+ * @format GUID
1108
+ * @readonly
1109
+ */
903
1110
  transactionId?: string | null;
904
1111
  }
905
1112
  export interface PaymentTransactionSummary {
906
1113
  /**
907
1114
  * Wix Payments transaction id
1115
+ * @format GUID
908
1116
  * @readonly
909
1117
  */
910
1118
  transactionId?: string;
@@ -919,6 +1127,7 @@ export interface PaymentTransactionSummary {
919
1127
  export interface PaymentTransactionEvent {
920
1128
  /**
921
1129
  * Order snapshot id
1130
+ * @format GUID
922
1131
  * @readonly
923
1132
  */
924
1133
  snapshotId?: string;
@@ -954,25 +1163,45 @@ export interface PaymentTransactionEvent {
954
1163
  refundedAmount?: Money;
955
1164
  }
956
1165
  export interface CaptureAuthorizedPaymentRequest {
957
- /** Event ID. */
1166
+ /**
1167
+ * Event ID.
1168
+ * @format GUID
1169
+ */
958
1170
  eventId?: string;
959
- /** Order number. */
1171
+ /**
1172
+ * Order number.
1173
+ * @minLength 1
1174
+ * @maxLength 36
1175
+ */
960
1176
  orderNumber: string;
961
1177
  }
962
1178
  export interface CaptureAuthorizedPaymentResponse {
963
1179
  }
964
1180
  export interface VoidAuthorizedPaymentRequest {
965
- /** Event ID. */
1181
+ /**
1182
+ * Event ID.
1183
+ * @format GUID
1184
+ */
966
1185
  eventId?: string;
967
- /** Order number. */
1186
+ /**
1187
+ * Order number.
1188
+ * @minLength 1
1189
+ * @maxLength 36
1190
+ */
968
1191
  orderNumber: string;
969
1192
  }
970
1193
  export interface VoidAuthorizedPaymentResponse {
971
1194
  }
972
1195
  export interface MessageEnvelope {
973
- /** App instance ID. */
1196
+ /**
1197
+ * App instance ID.
1198
+ * @format GUID
1199
+ */
974
1200
  instanceId?: string | null;
975
- /** Event type. */
1201
+ /**
1202
+ * Event type.
1203
+ * @maxLength 150
1204
+ */
976
1205
  eventType?: string;
977
1206
  /** The identification type and identity data. */
978
1207
  identity?: IdentificationData;
@@ -980,26 +1209,50 @@ export interface MessageEnvelope {
980
1209
  data?: string;
981
1210
  }
982
1211
  export interface IdentificationData extends IdentificationDataIdOneOf {
983
- /** ID of a site visitor that has not logged in to the site. */
1212
+ /**
1213
+ * ID of a site visitor that has not logged in to the site.
1214
+ * @format GUID
1215
+ */
984
1216
  anonymousVisitorId?: string;
985
- /** ID of a site visitor that has logged in to the site. */
1217
+ /**
1218
+ * ID of a site visitor that has logged in to the site.
1219
+ * @format GUID
1220
+ */
986
1221
  memberId?: string;
987
- /** ID of a Wix user (site owner, contributor, etc.). */
1222
+ /**
1223
+ * ID of a Wix user (site owner, contributor, etc.).
1224
+ * @format GUID
1225
+ */
988
1226
  wixUserId?: string;
989
- /** ID of an app. */
1227
+ /**
1228
+ * ID of an app.
1229
+ * @format GUID
1230
+ */
990
1231
  appId?: string;
991
1232
  /** @readonly */
992
1233
  identityType?: WebhookIdentityType;
993
1234
  }
994
1235
  /** @oneof */
995
1236
  export interface IdentificationDataIdOneOf {
996
- /** ID of a site visitor that has not logged in to the site. */
1237
+ /**
1238
+ * ID of a site visitor that has not logged in to the site.
1239
+ * @format GUID
1240
+ */
997
1241
  anonymousVisitorId?: string;
998
- /** ID of a site visitor that has logged in to the site. */
1242
+ /**
1243
+ * ID of a site visitor that has logged in to the site.
1244
+ * @format GUID
1245
+ */
999
1246
  memberId?: string;
1000
- /** ID of a Wix user (site owner, contributor, etc.). */
1247
+ /**
1248
+ * ID of a Wix user (site owner, contributor, etc.).
1249
+ * @format GUID
1250
+ */
1001
1251
  wixUserId?: string;
1002
- /** ID of an app. */
1252
+ /**
1253
+ * ID of an app.
1254
+ * @format GUID
1255
+ */
1003
1256
  appId?: string;
1004
1257
  }
1005
1258
  export declare enum WebhookIdentityType {
@@ -1012,19 +1265,31 @@ export declare enum WebhookIdentityType {
1012
1265
  export interface OrderConfirmed {
1013
1266
  /** Order confirmation timestamp in ISO UTC. */
1014
1267
  timestamp?: Date | null;
1015
- /** Site language when Order initiated */
1268
+ /**
1269
+ * Site language when Order initiated
1270
+ * @format LANGUAGE
1271
+ */
1016
1272
  language?: string | null;
1017
1273
  /** Notifications silenced for this domain event. */
1018
1274
  silent?: boolean | null;
1019
- /** Locale in which Order was created. */
1275
+ /**
1276
+ * Locale in which Order was created.
1277
+ * @format LANGUAGE_TAG
1278
+ */
1020
1279
  locale?: string | null;
1021
- /** Event ID to which the order belongs. */
1280
+ /**
1281
+ * Event ID to which the order belongs.
1282
+ * @format GUID
1283
+ */
1022
1284
  eventId?: string;
1023
1285
  /** Unique order number. */
1024
1286
  orderNumber?: string;
1025
1287
  /** Contact ID associated with this order. */
1026
1288
  contactId?: string;
1027
- /** Member ID associated with this order. */
1289
+ /**
1290
+ * Member ID associated with this order.
1291
+ * @format GUID
1292
+ */
1028
1293
  memberId?: string | null;
1029
1294
  /**
1030
1295
  * Order created timestamp
@@ -1062,40 +1327,70 @@ export interface OrderConfirmed {
1062
1327
  export interface OrderPaid {
1063
1328
  /** Order paid timestamp in ISO UTC. */
1064
1329
  timestamp?: Date | null;
1065
- /** Site language when Order initiated */
1330
+ /**
1331
+ * Site language when Order initiated
1332
+ * @format LANGUAGE
1333
+ */
1066
1334
  language?: string | null;
1067
1335
  /** Notifications silenced for this domain event. */
1068
1336
  silent?: boolean | null;
1069
- /** Locale in which Order was created. */
1337
+ /**
1338
+ * Locale in which Order was created.
1339
+ * @format LANGUAGE_TAG
1340
+ */
1070
1341
  locale?: string | null;
1071
- /** Event ID to which the order belongs. */
1342
+ /**
1343
+ * Event ID to which the order belongs.
1344
+ * @format GUID
1345
+ */
1072
1346
  eventId?: string;
1073
1347
  /** Unique order number. */
1074
1348
  orderNumber?: string;
1075
1349
  /** Reservation ID associated with this order. */
1076
1350
  reservationId?: string;
1077
- /** Contact ID associated with this order. */
1351
+ /**
1352
+ * Contact ID associated with this order.
1353
+ * @maxLength 36
1354
+ */
1078
1355
  contactId?: string;
1079
- /** Member ID associated with this order. */
1356
+ /**
1357
+ * Member ID associated with this order.
1358
+ * @format GUID
1359
+ */
1080
1360
  memberId?: string | null;
1081
1361
  /**
1082
1362
  * Order created timestamp
1083
1363
  * @readonly
1084
1364
  */
1085
1365
  created?: Date | null;
1086
- /** Buyer first name. */
1366
+ /**
1367
+ * Buyer first name.
1368
+ * @maxLength 255
1369
+ */
1087
1370
  firstName?: string;
1088
- /** Buyer last name. */
1371
+ /**
1372
+ * Buyer last name.
1373
+ * @maxLength 255
1374
+ */
1089
1375
  lastName?: string;
1090
- /** Buyer email address. */
1376
+ /**
1377
+ * Buyer email address.
1378
+ * @maxLength 255
1379
+ */
1091
1380
  email?: string;
1092
1381
  /** Checkout form response. */
1093
1382
  checkoutForm?: FormResponse;
1094
1383
  /** Order status. */
1095
1384
  status?: OrderStatus;
1096
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1385
+ /**
1386
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1387
+ * @maxLength 255
1388
+ */
1097
1389
  method?: string | null;
1098
- /** Tickets (generated after payment). */
1390
+ /**
1391
+ * Tickets (generated after payment).
1392
+ * @maxSize 50
1393
+ */
1099
1394
  tickets?: Ticket[];
1100
1395
  /** Invoice. */
1101
1396
  invoice?: Invoice;
@@ -1103,22 +1398,32 @@ export interface OrderPaid {
1103
1398
  export interface ReservationCreated {
1104
1399
  /** Reservation created timestamp in ISO UTC format. */
1105
1400
  timestamp?: Date | null;
1106
- /** Event ID to which the reservation belongs. */
1401
+ /**
1402
+ * Event ID to which the reservation belongs.
1403
+ * @format GUID
1404
+ */
1107
1405
  eventId?: string;
1108
1406
  /**
1109
1407
  * Reservation ID.
1110
1408
  * Can be used to retrieve a reservation invoice.
1409
+ * @format GUID
1111
1410
  */
1112
1411
  reservationId?: string;
1113
1412
  /** Reservation expiration timestamp. */
1114
1413
  expires?: Date | null;
1115
1414
  /** Reservation status. */
1116
1415
  status?: ReservationStatus;
1117
- /** Reservation ticket quantities. */
1416
+ /**
1417
+ * Reservation ticket quantities.
1418
+ * @maxSize 50
1419
+ */
1118
1420
  quantities?: TicketQuantity[];
1119
1421
  /** Reservation update timestamp. */
1120
1422
  _updatedDate?: Date | null;
1121
- /** Reservation counts. */
1423
+ /**
1424
+ * Reservation counts.
1425
+ * @maxSize 50
1426
+ */
1122
1427
  counts?: ReservationCount[];
1123
1428
  }
1124
1429
  export declare enum ReservationStatus {
@@ -1134,7 +1439,10 @@ export declare enum ReservationStatus {
1134
1439
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1135
1440
  }
1136
1441
  export interface TicketQuantity {
1137
- /** Ticket definition ID. */
1442
+ /**
1443
+ * Ticket definition ID.
1444
+ * @format GUID
1445
+ */
1138
1446
  ticketDefinitionId?: string | null;
1139
1447
  /** Quantity. */
1140
1448
  quantity?: number | null;
@@ -1144,7 +1452,10 @@ export interface TicketQuantity {
1144
1452
  export interface ReservationCount {
1145
1453
  /** Reservation Count snapshot timestamp. */
1146
1454
  timestamp?: Date | null;
1147
- /** Ticket Definition ID. */
1455
+ /**
1456
+ * Ticket Definition ID.
1457
+ * @format GUID
1458
+ */
1148
1459
  ticketDefinitionId?: string;
1149
1460
  /** Confirmed reservation count. */
1150
1461
  confirmedCount?: number;
@@ -1156,22 +1467,32 @@ export interface ReservationCount {
1156
1467
  export interface ReservationUpdated {
1157
1468
  /** Reservation updated timestamp. */
1158
1469
  timestamp?: Date | null;
1159
- /** Event ID to which the reservation belongs. */
1470
+ /**
1471
+ * Event ID to which the reservation belongs.
1472
+ * @format GUID
1473
+ */
1160
1474
  eventId?: string;
1161
1475
  /**
1162
1476
  * Reservation ID.
1163
1477
  * Can be used to retrieve a reservation invoice.
1478
+ * @format GUID
1164
1479
  */
1165
1480
  reservationId?: string;
1166
1481
  /** Reservation status. */
1167
1482
  status?: ReservationStatus;
1168
1483
  /** Reservation expiration timestamp. */
1169
1484
  expires?: Date | null;
1170
- /** Reservation ticket quantities. */
1485
+ /**
1486
+ * Reservation ticket quantities.
1487
+ * @maxSize 50
1488
+ */
1171
1489
  quantities?: TicketQuantity[];
1172
1490
  /** Reservation update timestamp. */
1173
1491
  _updatedDate?: Date | null;
1174
- /** Reservation counts. */
1492
+ /**
1493
+ * Reservation counts.
1494
+ * @maxSize 50
1495
+ */
1175
1496
  counts?: ReservationCount[];
1176
1497
  }
1177
1498
  export interface GetCheckoutOptionsRequest {
@@ -1189,15 +1510,22 @@ export interface GetCheckoutOptionsResponse {
1189
1510
  acceptGiftCards?: boolean;
1190
1511
  }
1191
1512
  export interface ListAvailableTicketsRequest {
1192
- /** Event ID. If not provided, available tickets for all events in the site will be returned. */
1513
+ /**
1514
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
1515
+ * @format GUID
1516
+ */
1193
1517
  eventId?: string;
1194
1518
  /** Offset. */
1195
1519
  offset?: number;
1196
- /** Limit. */
1520
+ /**
1521
+ * Limit.
1522
+ * @max 100
1523
+ */
1197
1524
  limit?: number;
1198
1525
  /**
1199
1526
  * Sort order.
1200
1527
  * Default: `created:asc`.
1528
+ * @maxLength 100
1201
1529
  */
1202
1530
  sort?: string;
1203
1531
  state?: State[];
@@ -1220,7 +1548,10 @@ export interface ResponseMetaData {
1220
1548
  total?: number;
1221
1549
  }
1222
1550
  export interface TicketDefinition {
1223
- /** Ticket definition ID. */
1551
+ /**
1552
+ * Ticket definition ID.
1553
+ * @format GUID
1554
+ */
1224
1555
  _id?: string;
1225
1556
  /** Ticket price. */
1226
1557
  price?: Money;
@@ -1230,7 +1561,10 @@ export interface TicketDefinition {
1230
1561
  name?: string;
1231
1562
  /** Ticket description. */
1232
1563
  description?: string;
1233
- /** Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets. */
1564
+ /**
1565
+ * Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets.
1566
+ * @max 20
1567
+ */
1234
1568
  limitPerCheckout?: number;
1235
1569
  /** Custom sort index. */
1236
1570
  orderIndex?: number;
@@ -1238,7 +1572,10 @@ export interface TicketDefinition {
1238
1572
  policy?: string;
1239
1573
  /** Sensitive dashboard data. */
1240
1574
  dashboard?: Dashboard;
1241
- /** Event ID associated with the ticket. */
1575
+ /**
1576
+ * Event ID associated with the ticket.
1577
+ * @format GUID
1578
+ */
1242
1579
  eventId?: string;
1243
1580
  /**
1244
1581
  * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
@@ -1323,9 +1660,16 @@ export interface PricingOptions {
1323
1660
  options?: PricingOption[];
1324
1661
  }
1325
1662
  export interface PricingOption {
1326
- /** Ticket pricing option ID. */
1663
+ /**
1664
+ * Ticket pricing option ID.
1665
+ * @format GUID
1666
+ */
1327
1667
  _id?: string | null;
1328
- /** Ticket pricing option name. */
1668
+ /**
1669
+ * Ticket pricing option name.
1670
+ * @minLength 1
1671
+ * @maxLength 200
1672
+ */
1329
1673
  name?: string | null;
1330
1674
  /** Ticket pricing option price. */
1331
1675
  price?: Money;
@@ -1337,14 +1681,19 @@ export declare enum Type {
1337
1681
  export interface QueryAvailableTicketsRequest {
1338
1682
  /** Offset. */
1339
1683
  offset?: number;
1340
- /** Limit. */
1684
+ /**
1685
+ * Limit.
1686
+ * @max 1000
1687
+ */
1341
1688
  limit?: number;
1342
1689
  /** Ticket definition. */
1343
1690
  filter?: Record<string, any> | null;
1691
+ /** @maxSize 20 */
1344
1692
  fieldset?: TicketDefinitionFieldset[];
1345
1693
  /**
1346
1694
  * Sort order.
1347
1695
  * Default: `created:asc`.
1696
+ * @maxLength 100
1348
1697
  */
1349
1698
  sort?: string;
1350
1699
  }
@@ -1361,9 +1710,16 @@ export interface QueryAvailableTicketsResponse {
1361
1710
  definitions?: TicketDefinition[];
1362
1711
  }
1363
1712
  export interface CreateReservationRequest {
1364
- /** Event ID to which the reservation belongs. */
1713
+ /**
1714
+ * Event ID to which the reservation belongs.
1715
+ * @format GUID
1716
+ */
1365
1717
  eventId: string;
1366
- /** Tickets to reserve. */
1718
+ /**
1719
+ * Tickets to reserve.
1720
+ * @minSize 1
1721
+ * @maxSize 50
1722
+ */
1367
1723
  ticketQuantities?: TicketReservationQuantity[];
1368
1724
  /** Whether to ignore the available ticket limits upon reservation. */
1369
1725
  ignoreLimits?: boolean;
@@ -1371,17 +1727,31 @@ export interface CreateReservationRequest {
1371
1727
  allowHiddenTickets?: boolean;
1372
1728
  }
1373
1729
  export interface TicketReservationQuantity {
1374
- /** Ticket definition ID. */
1730
+ /**
1731
+ * Ticket definition ID.
1732
+ * @format GUID
1733
+ */
1375
1734
  ticketDefinitionId?: string;
1376
- /** Quantity of tickets to reserve. */
1735
+ /**
1736
+ * Quantity of tickets to reserve.
1737
+ * @min 1
1738
+ * @max 50
1739
+ */
1377
1740
  quantity?: number;
1378
- /** Override the predefined ticket price. */
1741
+ /**
1742
+ * Override the predefined ticket price.
1743
+ * @maxLength 13
1744
+ * @format DECIMAL_VALUE
1745
+ */
1379
1746
  priceOverride?: string | null;
1380
1747
  /** Optional ticket details */
1381
1748
  ticketDetails?: TicketDetails[];
1382
1749
  }
1383
1750
  export interface CreateReservationResponse {
1384
- /** Reservation ID. */
1751
+ /**
1752
+ * Reservation ID.
1753
+ * @format GUID
1754
+ */
1385
1755
  _id?: string;
1386
1756
  /** Reservation expiration timestamp. */
1387
1757
  expires?: Date | null;
@@ -1393,7 +1763,11 @@ export interface CreateReservationResponse {
1393
1763
  reservationStatus?: ReservationStatus;
1394
1764
  }
1395
1765
  export interface TicketReservation {
1396
- /** Quantity of reserved tickets. */
1766
+ /**
1767
+ * Quantity of reserved tickets.
1768
+ * @min 1
1769
+ * @max 20
1770
+ */
1397
1771
  quantity?: number;
1398
1772
  /** An object containing ticket information. */
1399
1773
  ticket?: TicketDefinition;
@@ -1401,17 +1775,29 @@ export interface TicketReservation {
1401
1775
  ticketDetails?: TicketDetails[];
1402
1776
  }
1403
1777
  export interface CancelReservationRequest {
1404
- /** Event ID to which the reservation belongs. */
1778
+ /**
1779
+ * Event ID to which the reservation belongs.
1780
+ * @format GUID
1781
+ */
1405
1782
  eventId: string;
1406
- /** Reservation ID. */
1783
+ /**
1784
+ * Reservation ID.
1785
+ * @format GUID
1786
+ */
1407
1787
  _id: string;
1408
1788
  }
1409
1789
  export interface CancelReservationResponse {
1410
1790
  }
1411
1791
  export interface GetInvoiceRequest {
1412
- /** Event ID to which the invoice belongs. */
1792
+ /**
1793
+ * Event ID to which the invoice belongs.
1794
+ * @format GUID
1795
+ */
1413
1796
  eventId: string;
1414
- /** Reservation ID. */
1797
+ /**
1798
+ * Reservation ID.
1799
+ * @format GUID
1800
+ */
1415
1801
  reservationId: string;
1416
1802
  /** Optional discount to be applied on the returned invoice. */
1417
1803
  withDiscount?: DiscountRequest;
@@ -1419,13 +1805,22 @@ export interface GetInvoiceRequest {
1419
1805
  paidPlanBenefit?: PaidPlanBenefit;
1420
1806
  }
1421
1807
  export interface DiscountRequest {
1422
- /** Discount coupon code. */
1808
+ /**
1809
+ * Discount coupon code.
1810
+ * @maxLength 20
1811
+ */
1423
1812
  couponCode?: string;
1424
1813
  }
1425
1814
  export interface PaidPlanBenefit {
1426
- /** Pricing plan ID. */
1815
+ /**
1816
+ * Pricing plan ID.
1817
+ * @format GUID
1818
+ */
1427
1819
  planOrderId?: string;
1428
- /** Pricing plan benefit ID. */
1820
+ /**
1821
+ * Pricing plan benefit ID.
1822
+ * @format GUID
1823
+ */
1429
1824
  benefitId?: string;
1430
1825
  }
1431
1826
  export interface GetInvoiceResponse {
@@ -1458,16 +1853,26 @@ export interface Error {
1458
1853
  code?: string;
1459
1854
  }
1460
1855
  export interface GiftCardErrors {
1461
- /** Error. */
1856
+ /**
1857
+ * Error.
1858
+ * @maxSize 10
1859
+ */
1462
1860
  error?: GiftCardErrorsError[];
1463
1861
  }
1464
1862
  export interface GiftCardErrorsError {
1863
+ /** @maxLength 100 */
1465
1864
  code?: string;
1466
1865
  }
1467
1866
  export interface CheckoutRequest {
1468
- /** Event ID to which the checkout belongs. */
1867
+ /**
1868
+ * Event ID to which the checkout belongs.
1869
+ * @format GUID
1870
+ */
1469
1871
  eventId: string;
1470
- /** Ticket reservation ID. */
1872
+ /**
1873
+ * Ticket reservation ID.
1874
+ * @format GUID
1875
+ */
1471
1876
  reservationId?: string;
1472
1877
  /** Member ID (if empty - no site member is associated to this order). */
1473
1878
  memberId?: string;
@@ -1475,7 +1880,11 @@ export interface CheckoutRequest {
1475
1880
  discount?: DiscountRequest;
1476
1881
  /** Buyer details. */
1477
1882
  buyer?: Buyer;
1478
- /** Guest details. */
1883
+ /**
1884
+ * Guest details.
1885
+ * @minSize 1
1886
+ * @maxSize 50
1887
+ */
1479
1888
  guests?: Guest[];
1480
1889
  /** Benefit granted by the pricing plan. */
1481
1890
  paidPlanBenefit?: PaidPlanBenefit;
@@ -1485,11 +1894,24 @@ export interface CheckoutRequest {
1485
1894
  marketingConsent?: boolean | null;
1486
1895
  }
1487
1896
  export interface Buyer {
1488
- /** Buyer first name. */
1897
+ /**
1898
+ * Buyer first name.
1899
+ * @minLength 1
1900
+ * @maxLength 50
1901
+ */
1489
1902
  firstName?: string;
1490
- /** Buyer last name. */
1903
+ /**
1904
+ * Buyer last name.
1905
+ * @minLength 1
1906
+ * @maxLength 50
1907
+ */
1491
1908
  lastName?: string;
1492
- /** Buyer email. */
1909
+ /**
1910
+ * Buyer email.
1911
+ * @format EMAIL
1912
+ * @minLength 5
1913
+ * @maxLength 255
1914
+ */
1493
1915
  email?: string;
1494
1916
  }
1495
1917
  export interface Guest {
@@ -1522,17 +1944,29 @@ export interface CheckoutResponse {
1522
1944
  export interface OrderInitiated {
1523
1945
  /** Order initiated timestamp in ISO UTC format. */
1524
1946
  timestamp?: Date | null;
1525
- /** Site language when Order initiated */
1947
+ /**
1948
+ * Site language when Order initiated
1949
+ * @format LANGUAGE
1950
+ */
1526
1951
  language?: string | null;
1527
- /** Locale in which Order was created. */
1952
+ /**
1953
+ * Locale in which Order was created.
1954
+ * @format LANGUAGE_TAG
1955
+ */
1528
1956
  locale?: string | null;
1529
- /** Event ID to which the order belongs. */
1957
+ /**
1958
+ * Event ID to which the order belongs.
1959
+ * @format GUID
1960
+ */
1530
1961
  eventId?: string;
1531
1962
  /** Unique order number. */
1532
1963
  orderNumber?: string;
1533
1964
  /** Contact ID associated with this order. */
1534
1965
  contactId?: string;
1535
- /** Member ID associated with this order. */
1966
+ /**
1967
+ * Member ID associated with this order.
1968
+ * @format GUID
1969
+ */
1536
1970
  memberId?: string | null;
1537
1971
  /**
1538
1972
  * Order created timestamp.
@@ -1571,13 +2005,23 @@ export interface OrderInitiated {
1571
2005
  markedAsPaid?: boolean | null;
1572
2006
  }
1573
2007
  export interface UpdateCheckoutRequest {
1574
- /** Event ID to which the checkout belongs. */
2008
+ /**
2009
+ * Event ID to which the checkout belongs.
2010
+ * @format GUID
2011
+ */
1575
2012
  eventId: string;
1576
- /** Unique order number. */
2013
+ /**
2014
+ * Unique order number.
2015
+ * @maxLength 36
2016
+ */
1577
2017
  orderNumber: string;
1578
2018
  /** Buyer details. */
1579
2019
  buyer?: Buyer;
1580
- /** Guest details. */
2020
+ /**
2021
+ * Guest details.
2022
+ * @minSize 1
2023
+ * @maxSize 20
2024
+ */
1581
2025
  guests?: Guest[];
1582
2026
  /** Member ID (if empty - no site member is associated to this order). */
1583
2027
  memberId?: string | null;
@@ -1593,23 +2037,42 @@ export interface UpdateCheckoutResponse {
1593
2037
  orderPageUrl?: string | null;
1594
2038
  }
1595
2039
  export interface OrderPageUrls {
1596
- /** Success order page URL. */
2040
+ /**
2041
+ * Success order page URL.
2042
+ * @format WEB_URL
2043
+ */
1597
2044
  success?: string | null;
1598
- /** Pending order page URL. */
2045
+ /**
2046
+ * Pending order page URL.
2047
+ * @format WEB_URL
2048
+ */
1599
2049
  pending?: string | null;
1600
- /** Canceled order page URL. */
2050
+ /**
2051
+ * Canceled order page URL.
2052
+ * @format WEB_URL
2053
+ */
1601
2054
  canceled?: string | null;
1602
- /** Error order page URL. */
2055
+ /**
2056
+ * Error order page URL.
2057
+ * @format WEB_URL
2058
+ */
1603
2059
  error?: string | null;
1604
2060
  }
1605
2061
  export interface PosCheckoutRequest {
1606
- /** Event ID to which the checkout belongs. */
2062
+ /**
2063
+ * Event ID to which the checkout belongs.
2064
+ * @format GUID
2065
+ */
1607
2066
  eventId: string;
1608
- /** Ticket reservation ID. */
2067
+ /**
2068
+ * Ticket reservation ID.
2069
+ * @format GUID
2070
+ */
1609
2071
  reservationId: string;
1610
2072
  /**
1611
2073
  * Payment details ID.
1612
2074
  * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2075
+ * @format GUID
1613
2076
  */
1614
2077
  paymentDetailsId?: string | null;
1615
2078
  }
@@ -1916,9 +2379,15 @@ export interface PosCheckoutResponseNonNullableFields {
1916
2379
  reservations: TicketReservationNonNullableFields[];
1917
2380
  }
1918
2381
  export interface BaseEventMetadata {
1919
- /** App instance ID. */
2382
+ /**
2383
+ * App instance ID.
2384
+ * @format GUID
2385
+ */
1920
2386
  instanceId?: string | null;
1921
- /** Event type. */
2387
+ /**
2388
+ * Event type.
2389
+ * @maxLength 150
2390
+ */
1922
2391
  eventType?: string;
1923
2392
  /** The identification type and identity data. */
1924
2393
  identity?: IdentificationData;
@@ -2073,7 +2542,10 @@ export declare function listOrders(options?: ListOrdersOptions): Promise<ListOrd
2073
2542
  export interface ListOrdersOptions {
2074
2543
  /** Offset. */
2075
2544
  offset?: number;
2076
- /** Limit. */
2545
+ /**
2546
+ * Limit.
2547
+ * @max 400
2548
+ */
2077
2549
  limit?: number;
2078
2550
  /**
2079
2551
  * Predefined sets of fields to return.
@@ -2083,6 +2555,7 @@ export interface ListOrdersOptions {
2083
2555
  * - `INVOICE`: Returns `invoice`.
2084
2556
  *
2085
2557
  * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2558
+ * @maxSize 20
2086
2559
  */
2087
2560
  fieldset?: OrderFieldset[];
2088
2561
  /**
@@ -2096,26 +2569,54 @@ export interface ListOrdersOptions {
2096
2569
  * - `DECLINED`: The order is payment is declined.
2097
2570
  */
2098
2571
  status?: OrderStatus[];
2099
- /** Event ID to which the order belongs. */
2572
+ /**
2573
+ * Event ID to which the order belongs.
2574
+ * @format GUID
2575
+ * @maxSize 100
2576
+ */
2100
2577
  eventId?: string[];
2101
- /** Order number. */
2578
+ /**
2579
+ * Order number.
2580
+ * @maxLength 36
2581
+ * @maxSize 500
2582
+ */
2102
2583
  orderNumber?: string[];
2103
- /** Site member ID. */
2584
+ /**
2585
+ * Site member ID.
2586
+ * @format GUID
2587
+ * @maxSize 500
2588
+ */
2104
2589
  memberId?: string[];
2105
- /** Field facets. */
2590
+ /**
2591
+ * Field facets.
2592
+ * @maxLength 100
2593
+ * @maxSize 20
2594
+ */
2106
2595
  facet?: string[];
2107
- /** Search filter. You can search `fullName`, `email` and `orderNumber`. */
2596
+ /**
2597
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
2598
+ * @maxLength 200
2599
+ */
2108
2600
  searchPhrase?: string;
2109
- /** Event creator ID. */
2601
+ /**
2602
+ * Event creator ID.
2603
+ * @format GUID
2604
+ * @maxSize 50
2605
+ */
2110
2606
  eventCreatorId?: string[];
2111
2607
  /**
2112
2608
  * Sort order.
2113
2609
  * Default: `created:asc`.
2610
+ * @maxLength 100
2114
2611
  */
2115
2612
  sort?: string;
2116
2613
  /** Order tag. */
2117
2614
  tag?: OrderTag[];
2118
- /** Guest contact IDs. */
2615
+ /**
2616
+ * Guest contact IDs.
2617
+ * @format GUID
2618
+ * @maxSize 100
2619
+ */
2119
2620
  contactId?: string[];
2120
2621
  }
2121
2622
  /**
@@ -2146,9 +2647,15 @@ export interface ListOrdersOptions {
2146
2647
  */
2147
2648
  export declare function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise<Order & OrderNonNullableFields>;
2148
2649
  export interface GetOrderIdentifiers {
2149
- /** Event ID to which the order belongs. */
2650
+ /**
2651
+ * Event ID to which the order belongs.
2652
+ * @format GUID
2653
+ */
2150
2654
  eventId: string;
2151
- /** Unique order number. */
2655
+ /**
2656
+ * Unique order number.
2657
+ * @maxLength 36
2658
+ */
2152
2659
  orderNumber: string;
2153
2660
  }
2154
2661
  export interface GetOrderOptions {
@@ -2160,6 +2667,7 @@ export interface GetOrderOptions {
2160
2667
  * - `INVOICE`: Returns `invoice`.
2161
2668
  *
2162
2669
  * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2670
+ * @maxSize 20
2163
2671
  */
2164
2672
  fieldset?: OrderFieldset[];
2165
2673
  }
@@ -2183,9 +2691,15 @@ export interface GetOrderOptions {
2183
2691
  */
2184
2692
  export declare function updateOrder(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions): Promise<UpdateOrderResponse & UpdateOrderResponseNonNullableFields>;
2185
2693
  export interface UpdateOrderIdentifiers {
2186
- /** Event ID to which the order belongs. */
2694
+ /**
2695
+ * Event ID to which the order belongs.
2696
+ * @format GUID
2697
+ */
2187
2698
  eventId: string;
2188
- /** Unique order number. */
2699
+ /**
2700
+ * Unique order number.
2701
+ * @maxLength 36
2702
+ */
2189
2703
  orderNumber: string;
2190
2704
  }
2191
2705
  export interface UpdateOrderOptions {
@@ -2214,7 +2728,13 @@ export interface UpdateOrderOptions {
2214
2728
  */
2215
2729
  export declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<BulkUpdateOrdersResponse & BulkUpdateOrdersResponseNonNullableFields>;
2216
2730
  export interface BulkUpdateOrdersOptions {
2217
- /** Unique order number. */
2731
+ /**
2732
+ * Unique order number.
2733
+ * @minLength 1
2734
+ * @maxLength 36
2735
+ * @minSize 1
2736
+ * @maxSize 100
2737
+ */
2218
2738
  orderNumber?: string[];
2219
2739
  /** Set of fields to update. */
2220
2740
  fields?: string[];
@@ -2243,7 +2763,12 @@ export interface BulkUpdateOrdersOptions {
2243
2763
  */
2244
2764
  export declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<ConfirmOrderResponse & ConfirmOrderResponseNonNullableFields>;
2245
2765
  export interface ConfirmOrderOptions {
2246
- /** Order numbers. */
2766
+ /**
2767
+ * Order numbers.
2768
+ * @minLength 1
2769
+ * @maxLength 36
2770
+ * @maxSize 100
2771
+ */
2247
2772
  orderNumber?: string[];
2248
2773
  }
2249
2774
  /**
@@ -2269,7 +2794,10 @@ export interface ConfirmOrderOptions {
2269
2794
  */
2270
2795
  export declare function getSummary(options?: GetSummaryOptions): Promise<GetSummaryResponse & GetSummaryResponseNonNullableFields>;
2271
2796
  export interface GetSummaryOptions {
2272
- /** Event ID. */
2797
+ /**
2798
+ * Event ID.
2799
+ * @format GUID
2800
+ */
2273
2801
  eventId?: string | null;
2274
2802
  }
2275
2803
  /**
@@ -2291,7 +2819,10 @@ export interface GetSummaryOptions {
2291
2819
  */
2292
2820
  export declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void>;
2293
2821
  export interface CaptureAuthorizedPaymentOptions {
2294
- /** Event ID. */
2822
+ /**
2823
+ * Event ID.
2824
+ * @format GUID
2825
+ */
2295
2826
  eventId?: string;
2296
2827
  }
2297
2828
  /**
@@ -2313,7 +2844,10 @@ export interface CaptureAuthorizedPaymentOptions {
2313
2844
  */
2314
2845
  export declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void>;
2315
2846
  export interface VoidAuthorizedPaymentOptions {
2316
- /** Event ID. */
2847
+ /**
2848
+ * Event ID.
2849
+ * @format GUID
2850
+ */
2317
2851
  eventId?: string;
2318
2852
  }
2319
2853
  /**
@@ -2351,15 +2885,22 @@ export declare function getCheckoutOptions(): Promise<GetCheckoutOptionsResponse
2351
2885
  */
2352
2886
  export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<ListAvailableTicketsResponse & ListAvailableTicketsResponseNonNullableFields>;
2353
2887
  export interface ListAvailableTicketsOptions {
2354
- /** Event ID. If not provided, available tickets for all events in the site will be returned. */
2888
+ /**
2889
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
2890
+ * @format GUID
2891
+ */
2355
2892
  eventId?: string;
2356
2893
  /** Offset. */
2357
2894
  offset?: number;
2358
- /** Limit. */
2895
+ /**
2896
+ * Limit.
2897
+ * @max 100
2898
+ */
2359
2899
  limit?: number;
2360
2900
  /**
2361
2901
  * Sort order.
2362
2902
  * Default: `created:asc`.
2903
+ * @maxLength 100
2363
2904
  */
2364
2905
  sort?: string;
2365
2906
  state?: State[];
@@ -2386,14 +2927,19 @@ export declare function queryAvailableTickets(options?: QueryAvailableTicketsOpt
2386
2927
  export interface QueryAvailableTicketsOptions {
2387
2928
  /** Offset. */
2388
2929
  offset?: number;
2389
- /** Limit. */
2930
+ /**
2931
+ * Limit.
2932
+ * @max 1000
2933
+ */
2390
2934
  limit?: number;
2391
2935
  /** Ticket definition. */
2392
2936
  filter?: Record<string, any> | null;
2937
+ /** @maxSize 20 */
2393
2938
  fieldset?: TicketDefinitionFieldset[];
2394
2939
  /**
2395
2940
  * Sort order.
2396
2941
  * Default: `created:asc`.
2942
+ * @maxLength 100
2397
2943
  */
2398
2944
  sort?: string;
2399
2945
  }
@@ -2420,7 +2966,11 @@ export interface QueryAvailableTicketsOptions {
2420
2966
  */
2421
2967
  export declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
2422
2968
  export interface CreateReservationOptions {
2423
- /** Tickets to reserve. */
2969
+ /**
2970
+ * Tickets to reserve.
2971
+ * @minSize 1
2972
+ * @maxSize 50
2973
+ */
2424
2974
  ticketQuantities?: TicketReservationQuantity[];
2425
2975
  /** Whether to ignore the available ticket limits upon reservation. */
2426
2976
  ignoreLimits?: boolean;
@@ -2511,7 +3061,10 @@ export interface GetInvoiceOptions {
2511
3061
  */
2512
3062
  export declare function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise<CheckoutResponse & CheckoutResponseNonNullableFields>;
2513
3063
  export interface CheckoutOptionsForRequest {
2514
- /** Ticket reservation ID. */
3064
+ /**
3065
+ * Ticket reservation ID.
3066
+ * @format GUID
3067
+ */
2515
3068
  reservationId?: string;
2516
3069
  /** Member ID (if empty - no site member is associated to this order). */
2517
3070
  memberId?: string;
@@ -2519,7 +3072,11 @@ export interface CheckoutOptionsForRequest {
2519
3072
  discount?: DiscountRequest;
2520
3073
  /** Buyer details. */
2521
3074
  buyer?: Buyer;
2522
- /** Guest details. */
3075
+ /**
3076
+ * Guest details.
3077
+ * @minSize 1
3078
+ * @maxSize 50
3079
+ */
2523
3080
  guests?: Guest[];
2524
3081
  /** Benefit granted by the pricing plan. */
2525
3082
  paidPlanBenefit?: PaidPlanBenefit;
@@ -2555,7 +3112,11 @@ export declare function updateCheckout(orderNumber: string, eventId: string, opt
2555
3112
  export interface UpdateCheckoutOptions {
2556
3113
  /** Buyer details. */
2557
3114
  buyer?: Buyer;
2558
- /** Guest details. */
3115
+ /**
3116
+ * Guest details.
3117
+ * @minSize 1
3118
+ * @maxSize 20
3119
+ */
2559
3120
  guests?: Guest[];
2560
3121
  /** Member ID (if empty - no site member is associated to this order). */
2561
3122
  memberId?: string | null;
@@ -2583,11 +3144,15 @@ export interface UpdateCheckoutOptions {
2583
3144
  */
2584
3145
  export declare function posCheckout(eventId: string, options?: PosCheckoutOptions): Promise<PosCheckoutResponse & PosCheckoutResponseNonNullableFields>;
2585
3146
  export interface PosCheckoutOptions {
2586
- /** Ticket reservation ID. */
3147
+ /**
3148
+ * Ticket reservation ID.
3149
+ * @format GUID
3150
+ */
2587
3151
  reservationId: string;
2588
3152
  /**
2589
3153
  * Payment details ID.
2590
3154
  * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
3155
+ * @format GUID
2591
3156
  */
2592
3157
  paymentDetailsId?: string | null;
2593
3158
  }