@wix/auto_sdk_events_orders 1.0.1 → 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,19 +1,32 @@
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.
8
11
  * Empty for FREE order.
12
+ * @format GUID
9
13
  * @readonly
10
14
  */
11
15
  snapshotId?: string;
12
- /** Event ID. */
16
+ /**
17
+ * Event ID.
18
+ * @format GUID
19
+ */
13
20
  eventId?: string;
14
- /** Contact ID of buyer (resolved using email address). */
21
+ /**
22
+ * Contact ID of buyer (resolved using email address).
23
+ * @format GUID
24
+ */
15
25
  contactId?: string;
16
- /** Member ID of buyer (if relevant). */
26
+ /**
27
+ * Member ID of buyer (if relevant).
28
+ * @format GUID
29
+ */
17
30
  memberId?: string;
18
31
  /**
19
32
  * RSVP created timestamp.
@@ -24,7 +37,10 @@ export interface Order {
24
37
  firstName?: string;
25
38
  /** Guest last name. */
26
39
  lastName?: string;
27
- /** Guest email. */
40
+ /**
41
+ * Guest email.
42
+ * @format EMAIL
43
+ */
28
44
  email?: string;
29
45
  /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
30
46
  checkoutForm?: FormResponse;
@@ -65,19 +81,35 @@ export interface Order {
65
81
  marketingConsent?: boolean | null;
66
82
  }
67
83
  export interface FormResponse {
68
- /** Input values entered when filling the form. */
84
+ /**
85
+ * Input values entered when filling the form.
86
+ * @maxSize 200
87
+ */
69
88
  inputValues?: InputValue[];
70
89
  }
71
90
  export interface InputValue {
72
- /** Input field name. */
91
+ /**
92
+ * Input field name.
93
+ * @maxLength 100
94
+ */
73
95
  inputName?: string;
74
- /** Text entered into the input field. */
96
+ /**
97
+ * Text entered into the input field.
98
+ * @maxLength 5000
99
+ */
75
100
  value?: string;
76
- /** Multiple selection values. For example, the array is filled if several checkboxes are ticked. */
101
+ /**
102
+ * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
103
+ * @maxSize 100
104
+ * @maxLength 5000
105
+ */
77
106
  values?: string[];
78
107
  }
79
108
  export interface FormattedAddress {
80
- /** One line address representation. */
109
+ /**
110
+ * One line address representation.
111
+ * @maxLength 200
112
+ */
81
113
  formatted?: string;
82
114
  /** Address components (optional). */
83
115
  address?: Address;
@@ -88,7 +120,10 @@ export interface Address extends AddressStreetOneOf {
88
120
  streetAddress?: StreetAddress;
89
121
  /** Main address line, usually street and number as free text. */
90
122
  addressLine?: string | null;
91
- /** Country code. */
123
+ /**
124
+ * Country code.
125
+ * @format COUNTRY
126
+ */
92
127
  country?: string | null;
93
128
  /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
94
129
  subdivision?: string | null;
@@ -141,7 +176,10 @@ export declare enum SubdivisionType {
141
176
  }
142
177
  /** Subdivision Concordance values */
143
178
  export interface StandardDetails {
144
- /** 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 */
179
+ /**
180
+ * 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
181
+ * @maxLength 20
182
+ */
145
183
  iso31662?: string | null;
146
184
  }
147
185
  export declare enum OrderStatus {
@@ -171,12 +209,19 @@ export declare enum OrderStatus {
171
209
  export interface Money {
172
210
  /**
173
211
  * *Deprecated:** Use `value` instead.
212
+ * @format DECIMAL_VALUE
174
213
  * @deprecated
175
214
  */
176
215
  amount?: string;
177
- /** ISO 4217 format of the currency e.g., `USD`. */
216
+ /**
217
+ * ISO 4217 format of the currency e.g., `USD`.
218
+ * @format CURRENCY
219
+ */
178
220
  currency?: string;
179
- /** 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. */
221
+ /**
222
+ * 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.
223
+ * @format DECIMAL_VALUE
224
+ */
180
225
  value?: string | null;
181
226
  }
182
227
  export interface TicketingTicket {
@@ -184,7 +229,10 @@ export interface TicketingTicket {
184
229
  ticketNumber?: string;
185
230
  /** Associated order number. */
186
231
  orderNumber?: string;
187
- /** Ticket definition ID. */
232
+ /**
233
+ * Ticket definition ID.
234
+ * @format GUID
235
+ */
188
236
  ticketDefinitionId?: string;
189
237
  /** Ticket name. */
190
238
  name?: string;
@@ -221,7 +269,10 @@ export interface TicketingTicket {
221
269
  * @deprecated
222
270
  */
223
271
  ticketPdf?: string;
224
- /** Ticket owner member ID. */
272
+ /**
273
+ * Ticket owner member ID.
274
+ * @format GUID
275
+ */
225
276
  memberId?: string | null;
226
277
  /**
227
278
  * Whether ticket was anonymized by GDPR delete.
@@ -241,6 +292,7 @@ export interface TicketingTicket {
241
292
  channel?: ChannelType;
242
293
  /**
243
294
  * URL to download ticket in .pkpass format for Apple Wallet
295
+ * @format WEB_URL
244
296
  * @readonly
245
297
  */
246
298
  walletPassUrl?: string;
@@ -261,13 +313,22 @@ export interface GuestDetails {
261
313
  firstName?: string | null;
262
314
  /** Guest last name. */
263
315
  lastName?: string | null;
264
- /** Guest email. */
316
+ /**
317
+ * Guest email.
318
+ * @format EMAIL
319
+ */
265
320
  email?: string | null;
266
321
  /** Full form response. */
267
322
  form?: FormResponse;
268
- /** Contact ID associated with this guest. */
323
+ /**
324
+ * Contact ID associated with this guest.
325
+ * @format GUID
326
+ */
269
327
  contactId?: string | null;
270
- /** Guest phone number. */
328
+ /**
329
+ * Guest phone number.
330
+ * @format PHONE
331
+ */
271
332
  phone?: string | null;
272
333
  }
273
334
  export declare enum ChannelType {
@@ -277,7 +338,11 @@ export declare enum ChannelType {
277
338
  OFFLINE_POS = "OFFLINE_POS"
278
339
  }
279
340
  export interface TicketDetails {
280
- /** Unique seat id in the event venue. */
341
+ /**
342
+ * Unique seat id in the event venue.
343
+ * @minLength 1
344
+ * @maxLength 36
345
+ */
281
346
  seatId?: string | null;
282
347
  /**
283
348
  * Optional sector label.
@@ -304,11 +369,21 @@ export interface TicketDetails {
304
369
  * @readonly
305
370
  */
306
371
  seatLabel?: string | null;
307
- /** Number of places in the spot. If not provided - defaults to 1. */
372
+ /**
373
+ * Number of places in the spot. If not provided - defaults to 1.
374
+ * @min 1
375
+ * @max 50
376
+ */
308
377
  capacity?: number | null;
309
- /** Custom pricing of ticket. */
378
+ /**
379
+ * Custom pricing of ticket.
380
+ * @format DECIMAL_VALUE
381
+ */
310
382
  priceOverride?: string | null;
311
- /** Pricing option id. */
383
+ /**
384
+ * Pricing option id.
385
+ * @format GUID
386
+ */
312
387
  pricingOptionId?: string | null;
313
388
  /**
314
389
  * Pricing option name.
@@ -349,9 +424,16 @@ export interface Invoice {
349
424
  previewUrl?: string | null;
350
425
  }
351
426
  export interface Item {
352
- /** Unique line item ID. */
427
+ /**
428
+ * Unique line item ID.
429
+ * @format GUID
430
+ */
353
431
  id?: string;
354
- /** Line item quantity. */
432
+ /**
433
+ * Line item quantity.
434
+ * @min 1
435
+ * @max 50
436
+ */
355
437
  quantity?: number;
356
438
  /** Line item name. */
357
439
  name?: string;
@@ -427,7 +509,10 @@ export interface PaidPlanDiscountDiscountOneOf {
427
509
  percentDiscount?: PercentDiscount;
428
510
  }
429
511
  export interface PercentDiscount {
430
- /** Percent rate. */
512
+ /**
513
+ * Percent rate.
514
+ * @decimalValue options - {gte:0.01,lte:100,maxScale:2}
515
+ */
431
516
  rate?: string;
432
517
  /** Number of discounted tickets. */
433
518
  quantityDiscounted?: number;
@@ -440,7 +525,10 @@ export interface Tax {
440
525
  * @readonly
441
526
  */
442
527
  name?: string;
443
- /** Tax rate. */
528
+ /**
529
+ * Tax rate.
530
+ * @format DECIMAL_VALUE
531
+ */
444
532
  rate?: string;
445
533
  /** Taxable amount. */
446
534
  taxable?: Money;
@@ -462,6 +550,7 @@ export interface Fee {
462
550
  type?: FeeType;
463
551
  /**
464
552
  * Fee rate.
553
+ * @format DECIMAL_VALUE
465
554
  * @readonly
466
555
  */
467
556
  rate?: string;
@@ -487,6 +576,7 @@ export interface PaymentDetails {
487
576
  export interface PaymentTransaction {
488
577
  /**
489
578
  * Wix Payments transaction id
579
+ * @format GUID
490
580
  * @readonly
491
581
  */
492
582
  transactionId?: string;
@@ -517,15 +607,24 @@ export declare enum Action {
517
607
  VOID = "VOID"
518
608
  }
519
609
  export interface GiftCardPaymentDetails {
520
- /** Gift card payment id. */
610
+ /**
611
+ * Gift card payment id.
612
+ * @format GUID
613
+ */
521
614
  giftCardPaymentId?: string | null;
522
- /** ID of the app that created the gift card. */
615
+ /**
616
+ * ID of the app that created the gift card.
617
+ * @format GUID
618
+ */
523
619
  appId?: string | null;
524
620
  /** Whether the gift card payment is voided. */
525
621
  voided?: boolean | null;
526
622
  /** Amount */
527
623
  amount?: Money;
528
- /** Obfuscated gift card code. */
624
+ /**
625
+ * Obfuscated gift card code.
626
+ * @maxLength 30
627
+ */
529
628
  obfuscatedCode?: string | null;
530
629
  }
531
630
  export interface BalanceSummary {
@@ -535,13 +634,19 @@ export interface BalanceSummary {
535
634
  export interface OrderDeleted {
536
635
  /** Order deleted timestamp in ISO UTC format. */
537
636
  timestamp?: Date | null;
538
- /** Event ID. */
637
+ /**
638
+ * Event ID.
639
+ * @format GUID
640
+ */
539
641
  eventId?: string;
540
642
  /** Unique order number. */
541
643
  orderNumber?: string;
542
644
  /** Contact ID associated with this order */
543
645
  contactId?: string;
544
- /** Member ID associated with this order. */
646
+ /**
647
+ * Member ID associated with this order.
648
+ * @format GUID
649
+ */
545
650
  memberId?: string | null;
546
651
  /**
547
652
  * Order created timestamp.
@@ -571,7 +676,10 @@ export declare enum OrderType {
571
676
  export interface Ticket {
572
677
  /** Unique issued ticket number. */
573
678
  ticketNumber?: string;
574
- /** Ticket definition ID. */
679
+ /**
680
+ * Ticket definition ID.
681
+ * @format GUID
682
+ */
575
683
  ticketDefinitionId?: string;
576
684
  /** Ticket check-in. */
577
685
  checkIn?: CheckIn;
@@ -585,11 +693,17 @@ export interface Ticket {
585
693
  lastName?: string | null;
586
694
  /** Guest email. */
587
695
  email?: string | null;
588
- /** Contact ID associated with this ticket. */
696
+ /**
697
+ * Contact ID associated with this ticket.
698
+ * @format GUID
699
+ */
589
700
  contactId?: string | null;
590
701
  /** Whether ticket is confirmed */
591
702
  confirmed?: boolean;
592
- /** Member ID associated with this ticket. */
703
+ /**
704
+ * Member ID associated with this ticket.
705
+ * @format GUID
706
+ */
593
707
  memberId?: string | null;
594
708
  /** Ticket form response (only assigned tickets contain separate forms). */
595
709
  form?: FormResponse;
@@ -599,7 +713,10 @@ export interface Ticket {
599
713
  anonymized?: boolean;
600
714
  /** URL and password to online conference */
601
715
  onlineConferencingLogin?: OnlineConferencingLogin;
602
- /** Seat ID associated with this ticket. */
716
+ /**
717
+ * Seat ID associated with this ticket.
718
+ * @maxLength 36
719
+ */
603
720
  seatId?: string | null;
604
721
  /** Whether ticket is canceled. */
605
722
  canceled?: boolean | null;
@@ -607,6 +724,7 @@ export interface Ticket {
607
724
  export interface OnlineConferencingLogin {
608
725
  /**
609
726
  * Link URL to the online conference.
727
+ * @format WEB_URL
610
728
  * @readonly
611
729
  */
612
730
  link?: string;
@@ -619,35 +737,67 @@ export interface OnlineConferencingLogin {
619
737
  export interface ListOrdersRequest {
620
738
  /** Offset. */
621
739
  offset?: number;
622
- /** Limit. */
740
+ /**
741
+ * Limit.
742
+ * @max 400
743
+ */
623
744
  limit?: number;
624
- /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */
745
+ /**
746
+ * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
747
+ * @maxSize 20
748
+ */
625
749
  fieldset?: OrderFieldset[];
626
750
  /** Status. */
627
751
  status?: OrderStatus[];
628
- /** Event ID. */
752
+ /**
753
+ * Event ID.
754
+ * @format GUID
755
+ * @maxSize 100
756
+ */
629
757
  eventId?: string[];
630
- /** Order number. */
758
+ /**
759
+ * Order number.
760
+ * @maxLength 36
761
+ * @maxSize 500
762
+ */
631
763
  orderNumber?: string[];
632
- /** Site member ID. */
764
+ /**
765
+ * Site member ID.
766
+ * @format GUID
767
+ * @maxSize 500
768
+ */
633
769
  memberId?: string[];
634
770
  /**
635
771
  * Field facets.
636
772
  * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
773
+ * @maxLength 100
774
+ * @maxSize 20
637
775
  */
638
776
  facet?: string[];
639
- /** Textual search filter - search is performed on "full_name", "email" and "order_number". */
777
+ /**
778
+ * Textual search filter - search is performed on "full_name", "email" and "order_number".
779
+ * @maxLength 200
780
+ */
640
781
  searchPhrase?: string;
641
- /** Event creator ID. */
782
+ /**
783
+ * Event creator ID.
784
+ * @format GUID
785
+ * @maxSize 50
786
+ */
642
787
  eventCreatorId?: string[];
643
788
  /**
644
789
  * Sort order. Defaults to "created:asc".
645
790
  * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
791
+ * @maxLength 100
646
792
  */
647
793
  sort?: string;
648
794
  /** Order tag. */
649
795
  tag?: OrderTag[];
650
- /** Guest contact IDs. */
796
+ /**
797
+ * Guest contact IDs.
798
+ * @format GUID
799
+ * @maxSize 100
800
+ */
651
801
  contactId?: string[];
652
802
  }
653
803
  export declare enum OrderFieldset {
@@ -681,7 +831,10 @@ export interface ListOrdersResponse {
681
831
  total?: number;
682
832
  /** Offset. */
683
833
  offset?: number;
684
- /** Limit. */
834
+ /**
835
+ * Limit.
836
+ * @max 100
837
+ */
685
838
  limit?: number;
686
839
  /** Orders. */
687
840
  orders?: Order[];
@@ -711,11 +864,20 @@ export interface Counts {
711
864
  ticketsCheckIn?: number;
712
865
  }
713
866
  export interface GetOrderRequest {
714
- /** Event ID. */
867
+ /**
868
+ * Event ID.
869
+ * @format GUID
870
+ */
715
871
  eventId: string;
716
- /** Unique order number. */
872
+ /**
873
+ * Unique order number.
874
+ * @maxLength 36
875
+ */
717
876
  orderNumber: string;
718
- /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */
877
+ /**
878
+ * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
879
+ * @maxSize 20
880
+ */
719
881
  fieldset?: OrderFieldset[];
720
882
  }
721
883
  export interface GetOrderResponse {
@@ -731,9 +893,15 @@ export interface CalendarLinks {
731
893
  ics?: string;
732
894
  }
733
895
  export interface UpdateOrderRequest {
734
- /** Event ID. */
896
+ /**
897
+ * Event ID.
898
+ * @format GUID
899
+ */
735
900
  eventId: string;
736
- /** Unique order number. */
901
+ /**
902
+ * Unique order number.
903
+ * @maxLength 36
904
+ */
737
905
  orderNumber: string;
738
906
  /** Set of field paths to update. */
739
907
  fields?: string[];
@@ -749,17 +917,29 @@ export interface UpdateOrderResponse {
749
917
  export interface OrderUpdated {
750
918
  /** Order updated timestamp in ISO UTC format. */
751
919
  timestamp?: Date | null;
752
- /** Site language when Order initiated */
920
+ /**
921
+ * Site language when Order initiated
922
+ * @format LANGUAGE
923
+ */
753
924
  language?: string | null;
754
- /** Locale in which Order was created. */
925
+ /**
926
+ * Locale in which Order was created.
927
+ * @format LANGUAGE_TAG
928
+ */
755
929
  locale?: string | null;
756
- /** Event ID. */
930
+ /**
931
+ * Event ID.
932
+ * @format GUID
933
+ */
757
934
  eventId?: string;
758
935
  /** Unique order number. */
759
936
  orderNumber?: string;
760
937
  /** Contact ID associated with this order. */
761
938
  contactId?: string;
762
- /** Member ID associated with this order. */
939
+ /**
940
+ * Member ID associated with this order.
941
+ * @format GUID
942
+ */
763
943
  memberId?: string | null;
764
944
  /**
765
945
  * Order created timestamp.
@@ -793,8 +973,17 @@ export interface OrderUpdated {
793
973
  triggeredByAnonymizeRequest?: boolean;
794
974
  }
795
975
  export interface BulkUpdateOrdersRequest {
796
- /** Event ID. */
976
+ /**
977
+ * Event ID.
978
+ * @format GUID
979
+ */
797
980
  eventId: string;
981
+ /**
982
+ * @minLength 1
983
+ * @maxLength 36
984
+ * @minSize 1
985
+ * @maxSize 100
986
+ */
798
987
  orderNumber?: string[];
799
988
  /** Set of fields to update. */
800
989
  fields?: string[];
@@ -806,9 +995,17 @@ export interface BulkUpdateOrdersResponse {
806
995
  orders?: Order[];
807
996
  }
808
997
  export interface ConfirmOrderRequest {
809
- /** Event ID. */
998
+ /**
999
+ * Event ID.
1000
+ * @format GUID
1001
+ */
810
1002
  eventId: string;
811
- /** Order numbers. */
1003
+ /**
1004
+ * Order numbers.
1005
+ * @minLength 1
1006
+ * @maxLength 36
1007
+ * @maxSize 100
1008
+ */
812
1009
  orderNumber?: string[];
813
1010
  }
814
1011
  export interface ConfirmOrderResponse {
@@ -816,7 +1013,10 @@ export interface ConfirmOrderResponse {
816
1013
  orders?: Order[];
817
1014
  }
818
1015
  export interface GetSummaryRequest {
819
- /** Event ID. */
1016
+ /**
1017
+ * Event ID.
1018
+ * @format GUID
1019
+ */
820
1020
  eventId?: string | null;
821
1021
  }
822
1022
  export interface GetSummaryResponse {
@@ -834,7 +1034,10 @@ export interface TicketSales {
834
1034
  revenue?: Money;
835
1035
  }
836
1036
  export interface GetInvoicePreviewRequest {
837
- /** Event ID. */
1037
+ /**
1038
+ * Event ID.
1039
+ * @format GUID
1040
+ */
838
1041
  eventId?: string;
839
1042
  /** Order number. */
840
1043
  orderNumber?: string;
@@ -849,7 +1052,10 @@ export interface HeadersEntry {
849
1052
  value?: string;
850
1053
  }
851
1054
  export interface GetPaymentInfoRequest {
852
- /** Event ID. */
1055
+ /**
1056
+ * Event ID.
1057
+ * @format GUID
1058
+ */
853
1059
  eventId?: string;
854
1060
  /** Order number. */
855
1061
  orderNumber?: string;
@@ -857,12 +1063,16 @@ export interface GetPaymentInfoRequest {
857
1063
  export interface GetPaymentInfoResponse {
858
1064
  transactions?: PaymentTransactionSummary[];
859
1065
  status?: string | null;
860
- /** @readonly */
1066
+ /**
1067
+ * @format GUID
1068
+ * @readonly
1069
+ */
861
1070
  transactionId?: string | null;
862
1071
  }
863
1072
  export interface PaymentTransactionSummary {
864
1073
  /**
865
1074
  * Wix Payments transaction id
1075
+ * @format GUID
866
1076
  * @readonly
867
1077
  */
868
1078
  transactionId?: string;
@@ -877,6 +1087,7 @@ export interface PaymentTransactionSummary {
877
1087
  export interface PaymentTransactionEvent {
878
1088
  /**
879
1089
  * Order snapshot id
1090
+ * @format GUID
880
1091
  * @readonly
881
1092
  */
882
1093
  snapshotId?: string;
@@ -912,25 +1123,45 @@ export interface PaymentTransactionEvent {
912
1123
  refundedAmount?: Money;
913
1124
  }
914
1125
  export interface CaptureAuthorizedPaymentRequest {
915
- /** Event ID. */
1126
+ /**
1127
+ * Event ID.
1128
+ * @format GUID
1129
+ */
916
1130
  eventId?: string;
917
- /** Order number. */
1131
+ /**
1132
+ * Order number.
1133
+ * @minLength 1
1134
+ * @maxLength 36
1135
+ */
918
1136
  orderNumber: string;
919
1137
  }
920
1138
  export interface CaptureAuthorizedPaymentResponse {
921
1139
  }
922
1140
  export interface VoidAuthorizedPaymentRequest {
923
- /** Event ID. */
1141
+ /**
1142
+ * Event ID.
1143
+ * @format GUID
1144
+ */
924
1145
  eventId?: string;
925
- /** Order number. */
1146
+ /**
1147
+ * Order number.
1148
+ * @minLength 1
1149
+ * @maxLength 36
1150
+ */
926
1151
  orderNumber: string;
927
1152
  }
928
1153
  export interface VoidAuthorizedPaymentResponse {
929
1154
  }
930
1155
  export interface MessageEnvelope {
931
- /** App instance ID. */
1156
+ /**
1157
+ * App instance ID.
1158
+ * @format GUID
1159
+ */
932
1160
  instanceId?: string | null;
933
- /** Event type. */
1161
+ /**
1162
+ * Event type.
1163
+ * @maxLength 150
1164
+ */
934
1165
  eventType?: string;
935
1166
  /** The identification type and identity data. */
936
1167
  identity?: IdentificationData;
@@ -938,26 +1169,50 @@ export interface MessageEnvelope {
938
1169
  data?: string;
939
1170
  }
940
1171
  export interface IdentificationData extends IdentificationDataIdOneOf {
941
- /** ID of a site visitor that has not logged in to the site. */
1172
+ /**
1173
+ * ID of a site visitor that has not logged in to the site.
1174
+ * @format GUID
1175
+ */
942
1176
  anonymousVisitorId?: string;
943
- /** ID of a site visitor that has logged in to the site. */
1177
+ /**
1178
+ * ID of a site visitor that has logged in to the site.
1179
+ * @format GUID
1180
+ */
944
1181
  memberId?: string;
945
- /** ID of a Wix user (site owner, contributor, etc.). */
1182
+ /**
1183
+ * ID of a Wix user (site owner, contributor, etc.).
1184
+ * @format GUID
1185
+ */
946
1186
  wixUserId?: string;
947
- /** ID of an app. */
1187
+ /**
1188
+ * ID of an app.
1189
+ * @format GUID
1190
+ */
948
1191
  appId?: string;
949
1192
  /** @readonly */
950
1193
  identityType?: WebhookIdentityType;
951
1194
  }
952
1195
  /** @oneof */
953
1196
  export interface IdentificationDataIdOneOf {
954
- /** ID of a site visitor that has not logged in to the site. */
1197
+ /**
1198
+ * ID of a site visitor that has not logged in to the site.
1199
+ * @format GUID
1200
+ */
955
1201
  anonymousVisitorId?: string;
956
- /** ID of a site visitor that has logged in to the site. */
1202
+ /**
1203
+ * ID of a site visitor that has logged in to the site.
1204
+ * @format GUID
1205
+ */
957
1206
  memberId?: string;
958
- /** ID of a Wix user (site owner, contributor, etc.). */
1207
+ /**
1208
+ * ID of a Wix user (site owner, contributor, etc.).
1209
+ * @format GUID
1210
+ */
959
1211
  wixUserId?: string;
960
- /** ID of an app. */
1212
+ /**
1213
+ * ID of an app.
1214
+ * @format GUID
1215
+ */
961
1216
  appId?: string;
962
1217
  }
963
1218
  export declare enum WebhookIdentityType {
@@ -970,19 +1225,31 @@ export declare enum WebhookIdentityType {
970
1225
  export interface OrderConfirmed {
971
1226
  /** Order confirmation timestamp in ISO UTC. */
972
1227
  timestamp?: Date | null;
973
- /** Site language when Order initiated */
1228
+ /**
1229
+ * Site language when Order initiated
1230
+ * @format LANGUAGE
1231
+ */
974
1232
  language?: string | null;
975
1233
  /** Notifications silenced for this domain event. */
976
1234
  silent?: boolean | null;
977
- /** Locale in which Order was created. */
1235
+ /**
1236
+ * Locale in which Order was created.
1237
+ * @format LANGUAGE_TAG
1238
+ */
978
1239
  locale?: string | null;
979
- /** Event ID. */
1240
+ /**
1241
+ * Event ID.
1242
+ * @format GUID
1243
+ */
980
1244
  eventId?: string;
981
1245
  /** Unique order number. */
982
1246
  orderNumber?: string;
983
1247
  /** Contact ID associated with this order. */
984
1248
  contactId?: string;
985
- /** Member ID associated with this order. */
1249
+ /**
1250
+ * Member ID associated with this order.
1251
+ * @format GUID
1252
+ */
986
1253
  memberId?: string | null;
987
1254
  /**
988
1255
  * Order created timestamp
@@ -1011,40 +1278,70 @@ export interface OrderConfirmed {
1011
1278
  export interface OrderPaid {
1012
1279
  /** Order paid timestamp in ISO UTC. */
1013
1280
  timestamp?: Date | null;
1014
- /** Site language when Order initiated */
1281
+ /**
1282
+ * Site language when Order initiated
1283
+ * @format LANGUAGE
1284
+ */
1015
1285
  language?: string | null;
1016
1286
  /** Notifications silenced for this domain event. */
1017
1287
  silent?: boolean | null;
1018
- /** Locale in which Order was created. */
1288
+ /**
1289
+ * Locale in which Order was created.
1290
+ * @format LANGUAGE_TAG
1291
+ */
1019
1292
  locale?: string | null;
1020
- /** Event ID. */
1293
+ /**
1294
+ * Event ID.
1295
+ * @format GUID
1296
+ */
1021
1297
  eventId?: string;
1022
1298
  /** Unique order number. */
1023
1299
  orderNumber?: string;
1024
1300
  /** Reservation ID associated with this order. */
1025
1301
  reservationId?: string;
1026
- /** Contact ID associated with this order. */
1302
+ /**
1303
+ * Contact ID associated with this order.
1304
+ * @maxLength 36
1305
+ */
1027
1306
  contactId?: string;
1028
- /** Member ID associated with this order. */
1307
+ /**
1308
+ * Member ID associated with this order.
1309
+ * @format GUID
1310
+ */
1029
1311
  memberId?: string | null;
1030
1312
  /**
1031
1313
  * Order created timestamp
1032
1314
  * @readonly
1033
1315
  */
1034
1316
  created?: Date | null;
1035
- /** Buyer first name. */
1317
+ /**
1318
+ * Buyer first name.
1319
+ * @maxLength 255
1320
+ */
1036
1321
  firstName?: string;
1037
- /** Buyer last name. */
1322
+ /**
1323
+ * Buyer last name.
1324
+ * @maxLength 255
1325
+ */
1038
1326
  lastName?: string;
1039
- /** Buyer email address. */
1327
+ /**
1328
+ * Buyer email address.
1329
+ * @maxLength 255
1330
+ */
1040
1331
  email?: string;
1041
1332
  /** Checkout form response. */
1042
1333
  checkoutForm?: FormResponse;
1043
1334
  /** Order status. */
1044
1335
  status?: OrderStatus;
1045
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1336
+ /**
1337
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1338
+ * @maxLength 255
1339
+ */
1046
1340
  method?: string | null;
1047
- /** Tickets (generated after payment). */
1341
+ /**
1342
+ * Tickets (generated after payment).
1343
+ * @maxSize 50
1344
+ */
1048
1345
  tickets?: Ticket[];
1049
1346
  /** Invoice. */
1050
1347
  invoice?: Invoice;
@@ -1052,22 +1349,32 @@ export interface OrderPaid {
1052
1349
  export interface ReservationCreated {
1053
1350
  /** Reservation created timestamp in ISO UTC format. */
1054
1351
  timestamp?: Date | null;
1055
- /** Event ID. */
1352
+ /**
1353
+ * Event ID.
1354
+ * @format GUID
1355
+ */
1056
1356
  eventId?: string;
1057
1357
  /**
1058
1358
  * Reservation ID.
1059
1359
  * Can be used to retrieve a reservation invoice.
1360
+ * @format GUID
1060
1361
  */
1061
1362
  reservationId?: string;
1062
1363
  /** Reservation expiration timestamp. */
1063
1364
  expires?: Date | null;
1064
1365
  /** Reservation status. */
1065
1366
  status?: ReservationStatus;
1066
- /** Reservation ticket quantities. */
1367
+ /**
1368
+ * Reservation ticket quantities.
1369
+ * @maxSize 50
1370
+ */
1067
1371
  quantities?: TicketQuantity[];
1068
1372
  /** Reservation update timestamp. */
1069
1373
  updatedDate?: Date | null;
1070
- /** Reservation counts. */
1374
+ /**
1375
+ * Reservation counts.
1376
+ * @maxSize 50
1377
+ */
1071
1378
  counts?: ReservationCount[];
1072
1379
  }
1073
1380
  export declare enum ReservationStatus {
@@ -1083,7 +1390,10 @@ export declare enum ReservationStatus {
1083
1390
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1084
1391
  }
1085
1392
  export interface TicketQuantity {
1086
- /** Ticket definition ID. */
1393
+ /**
1394
+ * Ticket definition ID.
1395
+ * @format GUID
1396
+ */
1087
1397
  ticketDefinitionId?: string | null;
1088
1398
  /** Quantity. */
1089
1399
  quantity?: number | null;
@@ -1093,7 +1403,10 @@ export interface TicketQuantity {
1093
1403
  export interface ReservationCount {
1094
1404
  /** Reservation Count snapshot timestamp. */
1095
1405
  timestamp?: Date | null;
1096
- /** Ticket Definition ID. */
1406
+ /**
1407
+ * Ticket Definition ID.
1408
+ * @format GUID
1409
+ */
1097
1410
  ticketDefinitionId?: string;
1098
1411
  /** Confirmed reservation count. */
1099
1412
  confirmedCount?: number;
@@ -1105,22 +1418,32 @@ export interface ReservationCount {
1105
1418
  export interface ReservationUpdated {
1106
1419
  /** Reservation updated timestamp. */
1107
1420
  timestamp?: Date | null;
1108
- /** Event ID. */
1421
+ /**
1422
+ * Event ID.
1423
+ * @format GUID
1424
+ */
1109
1425
  eventId?: string;
1110
1426
  /**
1111
1427
  * Reservation ID.
1112
1428
  * Can be used to retrieve a reservation invoice.
1429
+ * @format GUID
1113
1430
  */
1114
1431
  reservationId?: string;
1115
1432
  /** Reservation status. */
1116
1433
  status?: ReservationStatus;
1117
1434
  /** Reservation expiration timestamp. */
1118
1435
  expires?: Date | null;
1119
- /** Reservation ticket quantities. */
1436
+ /**
1437
+ * Reservation ticket quantities.
1438
+ * @maxSize 50
1439
+ */
1120
1440
  quantities?: TicketQuantity[];
1121
1441
  /** Reservation update timestamp. */
1122
1442
  updatedDate?: Date | null;
1123
- /** Reservation counts. */
1443
+ /**
1444
+ * Reservation counts.
1445
+ * @maxSize 50
1446
+ */
1124
1447
  counts?: ReservationCount[];
1125
1448
  }
1126
1449
  export interface GetCheckoutOptionsRequest {
@@ -1138,15 +1461,22 @@ export interface GetCheckoutOptionsResponse {
1138
1461
  acceptGiftCards?: boolean;
1139
1462
  }
1140
1463
  export interface ListAvailableTicketsRequest {
1141
- /** Event ID. If not provided, available tickets for all events in the site will be returned. */
1464
+ /**
1465
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
1466
+ * @format GUID
1467
+ */
1142
1468
  eventId?: string;
1143
1469
  /** Offset. */
1144
1470
  offset?: number;
1145
- /** Limit. */
1471
+ /**
1472
+ * Limit.
1473
+ * @max 100
1474
+ */
1146
1475
  limit?: number;
1147
1476
  /**
1148
1477
  * Sort order, defaults to "created:asc".
1149
1478
  * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1479
+ * @maxLength 100
1150
1480
  */
1151
1481
  sort?: string;
1152
1482
  state?: State[];
@@ -1169,7 +1499,10 @@ export interface ResponseMetaData {
1169
1499
  total?: number;
1170
1500
  }
1171
1501
  export interface TicketDefinition {
1172
- /** Ticket definition ID. */
1502
+ /**
1503
+ * Ticket definition ID.
1504
+ * @format GUID
1505
+ */
1173
1506
  id?: string;
1174
1507
  /** Ticket price. */
1175
1508
  price?: Money;
@@ -1182,6 +1515,7 @@ export interface TicketDefinition {
1182
1515
  /**
1183
1516
  * Limit of tickets that can be purchased per checkout.
1184
1517
  * Set to 20 for unlimited ticket definition.
1518
+ * @max 20
1185
1519
  */
1186
1520
  limitPerCheckout?: number;
1187
1521
  /** Custom sort index. */
@@ -1190,7 +1524,10 @@ export interface TicketDefinition {
1190
1524
  policy?: string;
1191
1525
  /** Sensitive dashboard data. */
1192
1526
  dashboard?: Dashboard;
1193
- /** Event ID associated with the ticket. */
1527
+ /**
1528
+ * Event ID associated with the ticket.
1529
+ * @format GUID
1530
+ */
1194
1531
  eventId?: string;
1195
1532
  /**
1196
1533
  * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
@@ -1275,9 +1612,16 @@ export interface PricingOptions {
1275
1612
  options?: PricingOption[];
1276
1613
  }
1277
1614
  export interface PricingOption {
1278
- /** Ticket pricing option ID. */
1615
+ /**
1616
+ * Ticket pricing option ID.
1617
+ * @format GUID
1618
+ */
1279
1619
  id?: string | null;
1280
- /** Ticket pricing option name. */
1620
+ /**
1621
+ * Ticket pricing option name.
1622
+ * @minLength 1
1623
+ * @maxLength 200
1624
+ */
1281
1625
  name?: string | null;
1282
1626
  /** Ticket pricing option price. */
1283
1627
  price?: Money;
@@ -1289,17 +1633,22 @@ export declare enum Type {
1289
1633
  export interface QueryAvailableTicketsRequest {
1290
1634
  /** Offset. */
1291
1635
  offset?: number;
1292
- /** Limit. */
1636
+ /**
1637
+ * Limit.
1638
+ * @max 1000
1639
+ */
1293
1640
  limit?: number;
1294
1641
  /**
1295
1642
  * Ticket definition.
1296
1643
  * See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1297
1644
  */
1298
1645
  filter?: Record<string, any> | null;
1646
+ /** @maxSize 20 */
1299
1647
  fieldset?: TicketDefinitionFieldset[];
1300
1648
  /**
1301
1649
  * Sort order, defaults to "created:asc".
1302
1650
  * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1651
+ * @maxLength 100
1303
1652
  */
1304
1653
  sort?: string;
1305
1654
  }
@@ -1316,9 +1665,16 @@ export interface QueryAvailableTicketsResponse {
1316
1665
  definitions?: TicketDefinition[];
1317
1666
  }
1318
1667
  export interface CreateReservationRequest {
1319
- /** Event ID. */
1668
+ /**
1669
+ * Event ID.
1670
+ * @format GUID
1671
+ */
1320
1672
  eventId: string;
1321
- /** Tickets to reserve. */
1673
+ /**
1674
+ * Tickets to reserve.
1675
+ * @minSize 1
1676
+ * @maxSize 50
1677
+ */
1322
1678
  ticketQuantities?: TicketReservationQuantity[];
1323
1679
  /** Whether to ignore the available ticket limits upon reservation. */
1324
1680
  ignoreLimits?: boolean;
@@ -1326,17 +1682,31 @@ export interface CreateReservationRequest {
1326
1682
  allowHiddenTickets?: boolean;
1327
1683
  }
1328
1684
  export interface TicketReservationQuantity {
1329
- /** Ticket definition ID. */
1685
+ /**
1686
+ * Ticket definition ID.
1687
+ * @format GUID
1688
+ */
1330
1689
  ticketDefinitionId?: string;
1331
- /** Quantity of tickets to reserve. */
1690
+ /**
1691
+ * Quantity of tickets to reserve.
1692
+ * @min 1
1693
+ * @max 50
1694
+ */
1332
1695
  quantity?: number;
1333
- /** Ticket price to charge - overriding the ticket price. */
1696
+ /**
1697
+ * Ticket price to charge - overriding the ticket price.
1698
+ * @maxLength 13
1699
+ * @format DECIMAL_VALUE
1700
+ */
1334
1701
  priceOverride?: string | null;
1335
1702
  /** Optional ticket details */
1336
1703
  ticketDetails?: TicketDetails[];
1337
1704
  }
1338
1705
  export interface CreateReservationResponse {
1339
- /** Reservation ID. */
1706
+ /**
1707
+ * Reservation ID.
1708
+ * @format GUID
1709
+ */
1340
1710
  id?: string;
1341
1711
  /** Reservation expiration timestamp. */
1342
1712
  expires?: Date | null;
@@ -1348,24 +1718,40 @@ export interface CreateReservationResponse {
1348
1718
  reservationStatus?: ReservationStatus;
1349
1719
  }
1350
1720
  export interface TicketReservation {
1351
- /** Quantity of reserved tickets. */
1721
+ /**
1722
+ * Quantity of reserved tickets.
1723
+ * @min 1
1724
+ * @max 20
1725
+ */
1352
1726
  quantity?: number;
1353
1727
  ticket?: TicketDefinition;
1354
1728
  /** Optional ticket details. */
1355
1729
  ticketDetails?: TicketDetails[];
1356
1730
  }
1357
1731
  export interface CancelReservationRequest {
1358
- /** Event ID. */
1732
+ /**
1733
+ * Event ID.
1734
+ * @format GUID
1735
+ */
1359
1736
  eventId: string;
1360
- /** Reservation ID. */
1737
+ /**
1738
+ * Reservation ID.
1739
+ * @format GUID
1740
+ */
1361
1741
  id: string;
1362
1742
  }
1363
1743
  export interface CancelReservationResponse {
1364
1744
  }
1365
1745
  export interface GetInvoiceRequest {
1366
- /** Event ID. */
1746
+ /**
1747
+ * Event ID.
1748
+ * @format GUID
1749
+ */
1367
1750
  eventId: string;
1368
- /** Reservation ID. */
1751
+ /**
1752
+ * Reservation ID.
1753
+ * @format GUID
1754
+ */
1369
1755
  reservationId: string;
1370
1756
  /** Optional discount to be applied on the returned invoice. */
1371
1757
  withDiscount?: DiscountRequest;
@@ -1373,13 +1759,22 @@ export interface GetInvoiceRequest {
1373
1759
  paidPlanBenefit?: PaidPlanBenefit;
1374
1760
  }
1375
1761
  export interface DiscountRequest {
1376
- /** Discount coupon code. */
1762
+ /**
1763
+ * Discount coupon code.
1764
+ * @maxLength 20
1765
+ */
1377
1766
  couponCode?: string;
1378
1767
  }
1379
1768
  export interface PaidPlanBenefit {
1380
- /** Pricing plan ID. */
1769
+ /**
1770
+ * Pricing plan ID.
1771
+ * @format GUID
1772
+ */
1381
1773
  planOrderId?: string;
1382
- /** Pricing plan benefit ID. */
1774
+ /**
1775
+ * Pricing plan benefit ID.
1776
+ * @format GUID
1777
+ */
1383
1778
  benefitId?: string;
1384
1779
  }
1385
1780
  export interface GetInvoiceResponse {
@@ -1404,16 +1799,26 @@ export interface Error {
1404
1799
  code?: string;
1405
1800
  }
1406
1801
  export interface GiftCardErrors {
1407
- /** Error. */
1802
+ /**
1803
+ * Error.
1804
+ * @maxSize 10
1805
+ */
1408
1806
  error?: GiftCardErrorsError[];
1409
1807
  }
1410
1808
  export interface GiftCardErrorsError {
1809
+ /** @maxLength 100 */
1411
1810
  code?: string;
1412
1811
  }
1413
1812
  export interface CheckoutRequest {
1414
- /** Event ID. */
1813
+ /**
1814
+ * Event ID.
1815
+ * @format GUID
1816
+ */
1415
1817
  eventId: string;
1416
- /** Ticket reservation ID. */
1818
+ /**
1819
+ * Ticket reservation ID.
1820
+ * @format GUID
1821
+ */
1417
1822
  reservationId?: string;
1418
1823
  /** Member ID (if empty - no site member is associated to this order). */
1419
1824
  memberId?: string;
@@ -1421,7 +1826,11 @@ export interface CheckoutRequest {
1421
1826
  discount?: DiscountRequest;
1422
1827
  /** Buyer details. */
1423
1828
  buyer?: Buyer;
1424
- /** Guest details. */
1829
+ /**
1830
+ * Guest details.
1831
+ * @minSize 1
1832
+ * @maxSize 50
1833
+ */
1425
1834
  guests?: Guest[];
1426
1835
  /** Benefit granted by the pricing plan. */
1427
1836
  paidPlanBenefit?: PaidPlanBenefit;
@@ -1431,11 +1840,24 @@ export interface CheckoutRequest {
1431
1840
  marketingConsent?: boolean | null;
1432
1841
  }
1433
1842
  export interface Buyer {
1434
- /** Buyer first name. */
1843
+ /**
1844
+ * Buyer first name.
1845
+ * @minLength 1
1846
+ * @maxLength 50
1847
+ */
1435
1848
  firstName?: string;
1436
- /** Buyer last name. */
1849
+ /**
1850
+ * Buyer last name.
1851
+ * @minLength 1
1852
+ * @maxLength 50
1853
+ */
1437
1854
  lastName?: string;
1438
- /** Buyer email. */
1855
+ /**
1856
+ * Buyer email.
1857
+ * @format EMAIL
1858
+ * @minLength 5
1859
+ * @maxLength 255
1860
+ */
1439
1861
  email?: string;
1440
1862
  }
1441
1863
  export interface Guest {
@@ -1465,17 +1887,29 @@ export interface CheckoutResponse {
1465
1887
  export interface OrderInitiated {
1466
1888
  /** Order initiated timestamp in ISO UTC format. */
1467
1889
  timestamp?: Date | null;
1468
- /** Site language when Order initiated */
1890
+ /**
1891
+ * Site language when Order initiated
1892
+ * @format LANGUAGE
1893
+ */
1469
1894
  language?: string | null;
1470
- /** Locale in which Order was created. */
1895
+ /**
1896
+ * Locale in which Order was created.
1897
+ * @format LANGUAGE_TAG
1898
+ */
1471
1899
  locale?: string | null;
1472
- /** Event ID. */
1900
+ /**
1901
+ * Event ID.
1902
+ * @format GUID
1903
+ */
1473
1904
  eventId?: string;
1474
1905
  /** Unique order number. */
1475
1906
  orderNumber?: string;
1476
1907
  /** Contact ID associated with this order. */
1477
1908
  contactId?: string;
1478
- /** Member ID associated with this order. */
1909
+ /**
1910
+ * Member ID associated with this order.
1911
+ * @format GUID
1912
+ */
1479
1913
  memberId?: string | null;
1480
1914
  /**
1481
1915
  * Order created timestamp.
@@ -1505,13 +1939,23 @@ export interface OrderInitiated {
1505
1939
  markedAsPaid?: boolean | null;
1506
1940
  }
1507
1941
  export interface UpdateCheckoutRequest {
1508
- /** Event ID. */
1942
+ /**
1943
+ * Event ID.
1944
+ * @format GUID
1945
+ */
1509
1946
  eventId: string;
1510
- /** Unique order number. */
1947
+ /**
1948
+ * Unique order number.
1949
+ * @maxLength 36
1950
+ */
1511
1951
  orderNumber: string;
1512
1952
  /** Buyer details. */
1513
1953
  buyer?: Buyer;
1514
- /** Guest details. */
1954
+ /**
1955
+ * Guest details.
1956
+ * @minSize 1
1957
+ * @maxSize 20
1958
+ */
1515
1959
  guests?: Guest[];
1516
1960
  /** Member ID (if empty - no site member is associated to this order). */
1517
1961
  memberId?: string | null;
@@ -1527,23 +1971,42 @@ export interface UpdateCheckoutResponse {
1527
1971
  orderPageUrl?: string | null;
1528
1972
  }
1529
1973
  export interface OrderPageUrls {
1530
- /** Success order page url. */
1974
+ /**
1975
+ * Success order page url.
1976
+ * @format WEB_URL
1977
+ */
1531
1978
  success?: string | null;
1532
- /** Pending order page url. */
1979
+ /**
1980
+ * Pending order page url.
1981
+ * @format WEB_URL
1982
+ */
1533
1983
  pending?: string | null;
1534
- /** Canceled order page url. */
1984
+ /**
1985
+ * Canceled order page url.
1986
+ * @format WEB_URL
1987
+ */
1535
1988
  canceled?: string | null;
1536
- /** Error order page url. */
1989
+ /**
1990
+ * Error order page url.
1991
+ * @format WEB_URL
1992
+ */
1537
1993
  error?: string | null;
1538
1994
  }
1539
1995
  export interface PosCheckoutRequest {
1540
- /** Event ID. */
1996
+ /**
1997
+ * Event ID.
1998
+ * @format GUID
1999
+ */
1541
2000
  eventId: string;
1542
- /** Ticket reservation ID. */
2001
+ /**
2002
+ * Ticket reservation ID.
2003
+ * @format GUID
2004
+ */
1543
2005
  reservationId: string;
1544
2006
  /**
1545
2007
  * Payment details ID.
1546
2008
  * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2009
+ * @format GUID
1547
2010
  */
1548
2011
  paymentDetailsId?: string | null;
1549
2012
  }