@wix/auto_sdk_events_orders 1.0.16 → 1.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/src/events-v1-order-orders.context.d.ts +1 -1
  2. package/build/cjs/src/events-v1-order-orders.public.d.ts +1 -1
  3. package/build/cjs/src/events-v1-order-orders.public.js.map +1 -1
  4. package/build/cjs/src/events-v1-order-orders.types.d.ts +253 -146
  5. package/build/cjs/src/events-v1-order-orders.types.js +19 -15
  6. package/build/cjs/src/events-v1-order-orders.types.js.map +1 -1
  7. package/build/cjs/src/events-v1-order-orders.universal.d.ts +221 -107
  8. package/build/cjs/src/events-v1-order-orders.universal.js +19 -15
  9. package/build/cjs/src/events-v1-order-orders.universal.js.map +1 -1
  10. package/build/es/src/events-v1-order-orders.context.d.ts +1 -1
  11. package/build/es/src/events-v1-order-orders.public.d.ts +1 -1
  12. package/build/es/src/events-v1-order-orders.public.js.map +1 -1
  13. package/build/es/src/events-v1-order-orders.types.d.ts +253 -146
  14. package/build/es/src/events-v1-order-orders.types.js +19 -15
  15. package/build/es/src/events-v1-order-orders.types.js.map +1 -1
  16. package/build/es/src/events-v1-order-orders.universal.d.ts +221 -107
  17. package/build/es/src/events-v1-order-orders.universal.js +19 -15
  18. package/build/es/src/events-v1-order-orders.universal.js.map +1 -1
  19. package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +1 -1
  20. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +1 -1
  21. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +1 -1
  22. package/build/internal/cjs/src/events-v1-order-orders.types.d.ts +253 -146
  23. package/build/internal/cjs/src/events-v1-order-orders.types.js +19 -15
  24. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +1 -1
  25. package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +221 -107
  26. package/build/internal/cjs/src/events-v1-order-orders.universal.js +19 -15
  27. package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +1 -1
  28. package/build/internal/es/src/events-v1-order-orders.context.d.ts +1 -1
  29. package/build/internal/es/src/events-v1-order-orders.public.d.ts +1 -1
  30. package/build/internal/es/src/events-v1-order-orders.public.js.map +1 -1
  31. package/build/internal/es/src/events-v1-order-orders.types.d.ts +253 -146
  32. package/build/internal/es/src/events-v1-order-orders.types.js +19 -15
  33. package/build/internal/es/src/events-v1-order-orders.types.js.map +1 -1
  34. package/build/internal/es/src/events-v1-order-orders.universal.d.ts +221 -107
  35. package/build/internal/es/src/events-v1-order-orders.universal.js +19 -15
  36. package/build/internal/es/src/events-v1-order-orders.universal.js.map +1 -1
  37. package/package.json +2 -2
@@ -19,7 +19,7 @@ export interface Order {
19
19
  */
20
20
  eventId?: string;
21
21
  /**
22
- * Contact ID of buyer (resolved using email address).
22
+ * Contact ID of buyer, resolved using the email address provided. See the Contacts API for additional information.
23
23
  * @format GUID
24
24
  */
25
25
  contactId?: string;
@@ -29,7 +29,7 @@ export interface Order {
29
29
  */
30
30
  memberId?: string;
31
31
  /**
32
- * RSVP created timestamp.
32
+ * Date and time the RSVP was created.
33
33
  * @readonly
34
34
  */
35
35
  created?: Date | null;
@@ -44,7 +44,7 @@ export interface Order {
44
44
  email?: string;
45
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. */
46
46
  checkoutForm?: FormResponse;
47
- /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
47
+ /** Whether the order is confirmed. Triggered once the payment gateway processes the payment and funds reach the merchant's account. */
48
48
  confirmed?: boolean;
49
49
  /**
50
50
  * Order status. Possible values:
@@ -75,18 +75,18 @@ export interface Order {
75
75
  fullName?: string;
76
76
  /** Order invoice. */
77
77
  invoice?: Invoice;
78
- /** Whether all tickets in order are checked-in. */
78
+ /** Whether all tickets in an order are checked-in. */
79
79
  fullyCheckedIn?: boolean;
80
80
  /** Internal order payment details */
81
81
  paymentDetails?: PaymentDetails;
82
- /** Checkout channel type */
82
+ /** Checkout channel type. */
83
83
  channel?: ChannelTypeWithLiterals;
84
84
  /**
85
- * Order updated timestamp.
85
+ * Date and time the order was updated.
86
86
  * @readonly
87
87
  */
88
88
  updated?: Date | null;
89
- /** Whether marketing consent was given */
89
+ /** Whether marketing consent was given. */
90
90
  marketingConsent?: boolean | null;
91
91
  }
92
92
  export interface FormResponse {
@@ -194,17 +194,17 @@ export interface StandardDetails {
194
194
  iso31662?: string | null;
195
195
  }
196
196
  export declare enum OrderStatus {
197
- /** Order status not available for this request fieldset. */
197
+ /** Order status is not available for this request fieldset. */
198
198
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
199
- /** Order is confirmed and payment isn't required. */
199
+ /** Order is confirmed, no payment is required. */
200
200
  FREE = "FREE",
201
- /** Order is paid for but the payment gateway has suspended the payment. */
201
+ /** Order was paid, but the payment gateway suspended the payment. */
202
202
  PENDING = "PENDING",
203
- /** Order is paid via a payment gateway. */
203
+ /** Order is paid. */
204
204
  PAID = "PAID",
205
- /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
205
+ /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
206
206
  OFFLINE_PENDING = "OFFLINE_PENDING",
207
- /** Order is awaiting payment at the cashier. */
207
+ /** Order is awaiting for payment at the cashier. */
208
208
  INITIATED = "INITIATED",
209
209
  /** Order is canceled. */
210
210
  CANCELED = "CANCELED",
@@ -243,7 +243,7 @@ export interface TicketingTicket {
243
243
  /** Associated order number. */
244
244
  orderNumber?: string;
245
245
  /**
246
- * Ticket definition ID.
246
+ * Ticket definition ID. See the Ticket Definition API for additional information.
247
247
  * @format GUID
248
248
  */
249
249
  ticketDefinitionId?: string;
@@ -259,7 +259,7 @@ export interface TicketingTicket {
259
259
  /** Event and ticket policies. */
260
260
  policy?: string;
261
261
  /**
262
- * Deprecated, use `check_in_url`.
262
+ * *Deprecated:** Use `tickets.checkInUrl` instead.
263
263
  * @deprecated
264
264
  */
265
265
  qrCode?: string;
@@ -267,7 +267,10 @@ export interface TicketingTicket {
267
267
  checkIn?: CheckIn;
268
268
  /** Associated order status. */
269
269
  orderStatus?: OrderStatusWithLiterals;
270
- /** Whether order and ticket are visible in order list. */
270
+ /**
271
+ * Whether the order and ticket are archived.
272
+ * If set to `true`, they are not visible in the order list.
273
+ */
271
274
  orderArchived?: boolean;
272
275
  /** Buyer full name. */
273
276
  orderFullName?: string;
@@ -278,7 +281,7 @@ export interface TicketingTicket {
278
281
  /** Whether ticket is visible in guest list. */
279
282
  archived?: boolean;
280
283
  /**
281
- * Deprecated, use `ticket_pdf_url`.
284
+ * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
282
285
  * @deprecated
283
286
  */
284
287
  ticketPdf?: string;
@@ -301,7 +304,7 @@ export interface TicketingTicket {
301
304
  checkInUrl?: string;
302
305
  /** URL for ticket PDF download. */
303
306
  ticketPdfUrl?: string;
304
- /** Associated order checkout channel type */
307
+ /** Associated order checkout channel type. */
305
308
  channel?: ChannelTypeWithLiterals;
306
309
  /**
307
310
  * URL to download ticket in the `.pkpass` format for Apple Wallet
@@ -316,7 +319,7 @@ export interface TicketingTicket {
316
319
  canceled?: boolean | null;
317
320
  }
318
321
  export interface CheckIn {
319
- /** Time of check-in */
322
+ /** Time of check-in. */
320
323
  created?: Date | null;
321
324
  }
322
325
  export interface GuestDetails {
@@ -345,7 +348,7 @@ export interface GuestDetails {
345
348
  phone?: string | null;
346
349
  }
347
350
  export declare enum ChannelType {
348
- /** Buyer created the order via an online channel such as a website or mobile app. */
351
+ /** Buyer created the order via an online channel, such as a website or a mobile app. */
349
352
  ONLINE = "ONLINE",
350
353
  /** Sales person created the order and collected the money. */
351
354
  OFFLINE_POS = "OFFLINE_POS"
@@ -354,13 +357,13 @@ export declare enum ChannelType {
354
357
  export type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
355
358
  export interface TicketDetails {
356
359
  /**
357
- * Unique seat id in the event venue.
360
+ * Unique seat ID in the event venue.
358
361
  * @minLength 1
359
362
  * @maxLength 36
360
363
  */
361
364
  seatId?: string | null;
362
365
  /**
363
- * Optional sector label.
366
+ * Section label.
364
367
  * @readonly
365
368
  */
366
369
  sectionLabel?: string | null;
@@ -385,18 +388,20 @@ export interface TicketDetails {
385
388
  */
386
389
  seatLabel?: string | null;
387
390
  /**
388
- * Number of places in the spot. If not provided - defaults to 1.
391
+ * Number of places in the spot.
392
+ *
393
+ * Default: `1`.
389
394
  * @min 1
390
395
  * @max 50
391
396
  */
392
397
  capacity?: number | null;
393
398
  /**
394
- * Custom pricing of ticket.
399
+ * Custom price of a ticket.
395
400
  * @format DECIMAL_VALUE
396
401
  */
397
402
  priceOverride?: string | null;
398
403
  /**
399
- * Pricing option id.
404
+ * Pricing option ID.
400
405
  * @format GUID
401
406
  */
402
407
  pricingOptionId?: string | null;
@@ -416,12 +421,12 @@ export interface Invoice {
416
421
  total?: Money;
417
422
  /** Discount applied to a cart. */
418
423
  discount?: Discount;
419
- /** Tax applied to cart. */
424
+ /** Tax applied to a cart. */
420
425
  tax?: Tax;
421
426
  /** Total cart amount before discount, tax, and fees. */
422
427
  subTotal?: Money;
423
428
  /**
424
- * Total amount of cart after discount, tax, and fees.
429
+ * Total amount of a cart after discount, tax, and fees.
425
430
  * Grand total is calculated in the following order:
426
431
  * 1. Total prices of all items in the cart are calculated.
427
432
  * 2. Discount is subtracted from the cart (if applicable).
@@ -506,11 +511,11 @@ export interface DiscountItemDiscountOneOf {
506
511
  paidPlan?: PaidPlanDiscount;
507
512
  }
508
513
  export interface CouponDiscount {
509
- /** Discount coupon name. */
514
+ /** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
510
515
  name?: string;
511
- /** Discount coupon code. */
516
+ /** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
512
517
  code?: string;
513
- /** Discount coupon ID. */
518
+ /** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
514
519
  couponId?: string;
515
520
  }
516
521
  export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
@@ -584,7 +589,7 @@ export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
584
589
  export declare enum FeeType {
585
590
  /** Fee is added to the ticket price at checkout. */
586
591
  FEE_ADDED = "FEE_ADDED",
587
- /** Seller absorbs the fee. It is deducted from the ticket price. */
592
+ /** Seller absorbs the fee. It's deducted from the ticket price. */
588
593
  FEE_INCLUDED = "FEE_INCLUDED",
589
594
  /** Fee is added to the ticket price at checkout. */
590
595
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
@@ -597,7 +602,7 @@ export interface PaymentDetails {
597
602
  }
598
603
  export interface PaymentTransaction {
599
604
  /**
600
- * Wix Payments transaction id
605
+ * Wix Payments transaction ID.
601
606
  * @format GUID
602
607
  * @readonly
603
608
  */
@@ -657,8 +662,9 @@ export interface BalanceSummary {
657
662
  /** Amount left to pay. */
658
663
  balance?: Money;
659
664
  }
665
+ /** Triggered when an order is deleted. */
660
666
  export interface OrderDeleted {
661
- /** Order deleted timestamp in ISO UTC format. */
667
+ /** Date and time the order was deleted. */
662
668
  timestamp?: Date | null;
663
669
  /**
664
670
  * Event ID to which the order belongs.
@@ -667,28 +673,28 @@ export interface OrderDeleted {
667
673
  eventId?: string;
668
674
  /** Unique order number. */
669
675
  orderNumber?: string;
670
- /** Contact ID associated with this order */
676
+ /** Contact ID associated with the order. */
671
677
  contactId?: string;
672
678
  /**
673
- * Member ID associated with this order.
679
+ * Member ID associated with the order.
674
680
  * @format GUID
675
681
  */
676
682
  memberId?: string | null;
677
683
  /**
678
- * Order created timestamp.
684
+ * Date and time the order was created.
679
685
  * @readonly
680
686
  */
681
687
  created?: Date | null;
682
688
  /**
683
- * Order updated timestamp.
689
+ * Date and time the order was updated.
684
690
  * @readonly
685
691
  */
686
692
  updated?: Date | null;
687
- /** Whether order was anonymized by GDPR delete. */
693
+ /** Whether the order was anonymized by GDPR delete. */
688
694
  anonymized?: boolean;
689
695
  /** Order type. */
690
696
  orderType?: OrderTypeWithLiterals;
691
- /** Whether event was triggered by GDPR delete request. */
697
+ /** Whether the event was triggered by GDPR delete request. */
692
698
  triggeredByAnonymizeRequest?: boolean;
693
699
  /** Tickets generated after payment. */
694
700
  tickets?: Ticket[];
@@ -844,13 +850,17 @@ export interface ListOrdersRequest {
844
850
  contactId?: string[];
845
851
  }
846
852
  export declare enum OrderFieldset {
847
- /** Include tickets in response. */
853
+ /** Returns `tickets`. */
848
854
  TICKETS = "TICKETS",
849
- /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
855
+ /**
856
+ * Returns `archived`, `confirmed`, `created`, `firstName`, `fullName`,
857
+ * `lastName`, `method`, `reservationId`, `snapshotId`,
858
+ * `status`, `ticketsPdf`, `ticketsQuantity`, `totalPrice`.
859
+ */
850
860
  DETAILS = "DETAILS",
851
- /** Include `checkoutForm` in the response. */
861
+ /** Returns `checkoutForm`. */
852
862
  FORM = "FORM",
853
- /** Include `invoice` in the response. */
863
+ /** Returns `invoice`. */
854
864
  INVOICE = "INVOICE"
855
865
  }
856
866
  /** @enumType */
@@ -961,23 +971,24 @@ export interface UpdateOrderRequest {
961
971
  fields?: string[];
962
972
  /** Checkout form. */
963
973
  checkoutForm?: FormResponse;
964
- /** Whether order is archived. */
974
+ /** Whether to archive the order. */
965
975
  archived?: boolean;
966
976
  }
967
977
  export interface UpdateOrderResponse {
968
978
  /** Updated order. */
969
979
  order?: Order;
970
980
  }
981
+ /** Triggered when an order is updated. */
971
982
  export interface OrderUpdated {
972
- /** Order updated timestamp in ISO UTC format. */
983
+ /** Date and time the order was updated. */
973
984
  timestamp?: Date | null;
974
985
  /**
975
- * Site language when Order initiated
986
+ * Site language when the order was initiated.
976
987
  * @format LANGUAGE
977
988
  */
978
989
  language?: string | null;
979
990
  /**
980
- * Locale in which Order was created.
991
+ * Locale in which the order was created.
981
992
  * @format LANGUAGE_TAG
982
993
  */
983
994
  locale?: string | null;
@@ -988,20 +999,20 @@ export interface OrderUpdated {
988
999
  eventId?: string;
989
1000
  /** Unique order number. */
990
1001
  orderNumber?: string;
991
- /** Contact ID associated with this order. */
1002
+ /** Contact ID associated with the order. */
992
1003
  contactId?: string;
993
1004
  /**
994
- * Member ID associated with this order.
1005
+ * Member ID associated with the order.
995
1006
  * @format GUID
996
1007
  */
997
1008
  memberId?: string | null;
998
1009
  /**
999
- * Order created timestamp.
1010
+ * Date and time the order was created.
1000
1011
  * @readonly
1001
1012
  */
1002
1013
  created?: Date | null;
1003
1014
  /**
1004
- * Order updated timestamp.
1015
+ * Date and time the order was updated.
1005
1016
  * @readonly
1006
1017
  */
1007
1018
  updated?: Date | null;
@@ -1042,6 +1053,7 @@ export interface BulkUpdateOrdersRequest {
1042
1053
  */
1043
1054
  eventId: string;
1044
1055
  /**
1056
+ * Unique order number.
1045
1057
  * @minLength 1
1046
1058
  * @maxLength 36
1047
1059
  * @minSize 1
@@ -1077,7 +1089,7 @@ export interface ConfirmOrderResponse {
1077
1089
  }
1078
1090
  export interface GetSummaryRequest {
1079
1091
  /**
1080
- * Event ID.
1092
+ * Event ID to which the order belongs.
1081
1093
  * @format GUID
1082
1094
  */
1083
1095
  eventId?: string | null;
@@ -1134,22 +1146,22 @@ export interface GetPaymentInfoResponse {
1134
1146
  }
1135
1147
  export interface PaymentTransactionSummary {
1136
1148
  /**
1137
- * Wix Payments transaction id
1149
+ * Wix Payments transaction ID.
1138
1150
  * @format GUID
1139
1151
  * @readonly
1140
1152
  */
1141
1153
  transactionId?: string;
1142
1154
  /**
1143
- * Final transaction status
1155
+ * Final transaction status.
1144
1156
  * @readonly
1145
1157
  */
1146
1158
  finalTransactionStatus?: string;
1147
- /** Transaction events */
1159
+ /** Transaction events. */
1148
1160
  events?: PaymentTransactionEvent[];
1149
1161
  }
1150
1162
  export interface PaymentTransactionEvent {
1151
1163
  /**
1152
- * Order snapshot id
1164
+ * Order snapshot ID.
1153
1165
  * @format GUID
1154
1166
  * @readonly
1155
1167
  */
@@ -1215,6 +1227,22 @@ export interface VoidAuthorizedPaymentRequest {
1215
1227
  }
1216
1228
  export interface VoidAuthorizedPaymentResponse {
1217
1229
  }
1230
+ export interface FindOrderByReservationIdRequest {
1231
+ /**
1232
+ * Event ID
1233
+ * @format GUID
1234
+ */
1235
+ eventId?: string;
1236
+ /**
1237
+ * Reservation ID.
1238
+ * @format GUID
1239
+ */
1240
+ reservationId?: string;
1241
+ }
1242
+ export interface FindOrderByReservationIdResponse {
1243
+ /** Order. */
1244
+ order?: Order;
1245
+ }
1218
1246
  export interface MessageEnvelope {
1219
1247
  /**
1220
1248
  * App instance ID.
@@ -1287,18 +1315,19 @@ export declare enum WebhookIdentityType {
1287
1315
  }
1288
1316
  /** @enumType */
1289
1317
  export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1318
+ /** Triggered when an order is confirmed. */
1290
1319
  export interface OrderConfirmed {
1291
- /** Order confirmation timestamp in ISO UTC. */
1320
+ /** Date and time the order was confirmed. */
1292
1321
  timestamp?: Date | null;
1293
1322
  /**
1294
- * Site language when Order initiated
1323
+ * Site language when the order was initiated.
1295
1324
  * @format LANGUAGE
1296
1325
  */
1297
1326
  language?: string | null;
1298
1327
  /** Notifications silenced for this domain event. */
1299
1328
  silent?: boolean | null;
1300
1329
  /**
1301
- * Locale in which Order was created.
1330
+ * Locale in which the order was created.
1302
1331
  * @format LANGUAGE_TAG
1303
1332
  */
1304
1333
  locale?: string | null;
@@ -1309,15 +1338,15 @@ export interface OrderConfirmed {
1309
1338
  eventId?: string;
1310
1339
  /** Unique order number. */
1311
1340
  orderNumber?: string;
1312
- /** Contact ID associated with this order. */
1341
+ /** Contact ID associated with the order. */
1313
1342
  contactId?: string;
1314
1343
  /**
1315
- * Member ID associated with this order.
1344
+ * Member ID associated with the order.
1316
1345
  * @format GUID
1317
1346
  */
1318
1347
  memberId?: string | null;
1319
1348
  /**
1320
- * Order created timestamp
1349
+ * Date and time the order was created.
1321
1350
  * @readonly
1322
1351
  */
1323
1352
  created?: Date | null;
@@ -1346,21 +1375,22 @@ export interface OrderConfirmed {
1346
1375
  tickets?: Ticket[];
1347
1376
  /** Invoice. */
1348
1377
  invoice?: Invoice;
1349
- /** Reservation ID associated with this order. */
1378
+ /** Reservation ID associated with the order. */
1350
1379
  reservationId?: string;
1351
1380
  }
1381
+ /** Triggered when an order is paid. */
1352
1382
  export interface OrderPaid {
1353
- /** Order paid timestamp in ISO UTC. */
1383
+ /** Date and time the order was paid. */
1354
1384
  timestamp?: Date | null;
1355
1385
  /**
1356
- * Site language when Order initiated
1386
+ * Site language when the order was initiated.
1357
1387
  * @format LANGUAGE
1358
1388
  */
1359
1389
  language?: string | null;
1360
1390
  /** Notifications silenced for this domain event. */
1361
1391
  silent?: boolean | null;
1362
1392
  /**
1363
- * Locale in which Order was created.
1393
+ * Locale in which the order was created.
1364
1394
  * @format LANGUAGE_TAG
1365
1395
  */
1366
1396
  locale?: string | null;
@@ -1384,7 +1414,7 @@ export interface OrderPaid {
1384
1414
  */
1385
1415
  memberId?: string | null;
1386
1416
  /**
1387
- * Order created timestamp
1417
+ * Date and time the order was created.
1388
1418
  * @readonly
1389
1419
  */
1390
1420
  created?: Date | null;
@@ -1420,8 +1450,9 @@ export interface OrderPaid {
1420
1450
  /** Invoice. */
1421
1451
  invoice?: Invoice;
1422
1452
  }
1453
+ /** Triggered when a reservation is created. */
1423
1454
  export interface ReservationCreated {
1424
- /** Reservation created timestamp in ISO UTC format. */
1455
+ /** Date and time the reservation was created. */
1425
1456
  timestamp?: Date | null;
1426
1457
  /**
1427
1458
  * Event ID to which the reservation belongs.
@@ -1434,33 +1465,33 @@ export interface ReservationCreated {
1434
1465
  * @format GUID
1435
1466
  */
1436
1467
  reservationId?: string;
1437
- /** Reservation expiration timestamp. */
1468
+ /** Date and time the reservation expires. */
1438
1469
  expires?: Date | null;
1439
1470
  /** Reservation status. */
1440
1471
  status?: ReservationStatusWithLiterals;
1441
1472
  /**
1442
- * Reservation ticket quantities.
1473
+ * Amount of tickets in the reservation.
1443
1474
  * @maxSize 50
1444
1475
  */
1445
1476
  quantities?: TicketQuantity[];
1446
- /** Reservation update timestamp. */
1477
+ /** Date and time the reservation was updated. */
1447
1478
  _updatedDate?: Date | null;
1448
1479
  /**
1449
- * Reservation counts.
1480
+ * Number of reservations.
1450
1481
  * @maxSize 50
1451
1482
  */
1452
1483
  counts?: ReservationCount[];
1453
1484
  }
1454
1485
  export declare enum ReservationStatus {
1455
- /** The Reservation is pending confirmation and will expire after the expiration due time. */
1486
+ /** The Reservation is pending confirmation. It will expire after a certain amount of time. */
1456
1487
  RESERVATION_PENDING = "RESERVATION_PENDING",
1457
1488
  /** The reservation is confirmed and will not expire. */
1458
1489
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
1459
- /** The reservation is canceled because of non payment. */
1490
+ /** The reservation is canceled because it's not paid. */
1460
1491
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
1461
1492
  /** The reservation is canceled manually by the buyer. */
1462
1493
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
1463
- /** The reservation is expired. */
1494
+ /** The reservation has expired. */
1464
1495
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1465
1496
  }
1466
1497
  /** @enumType */
@@ -1491,8 +1522,9 @@ export interface ReservationCount {
1491
1522
  /** True if paid ticket reservation exist. */
1492
1523
  paidExists?: boolean;
1493
1524
  }
1525
+ /** Triggered when a reservation is updated. */
1494
1526
  export interface ReservationUpdated {
1495
- /** Reservation updated timestamp. */
1527
+ /** Date and time the reservation was updated. */
1496
1528
  timestamp?: Date | null;
1497
1529
  /**
1498
1530
  * Event ID to which the reservation belongs.
@@ -1507,17 +1539,17 @@ export interface ReservationUpdated {
1507
1539
  reservationId?: string;
1508
1540
  /** Reservation status. */
1509
1541
  status?: ReservationStatusWithLiterals;
1510
- /** Reservation expiration timestamp. */
1542
+ /** Date and time the reservation expires. */
1511
1543
  expires?: Date | null;
1512
1544
  /**
1513
- * Reservation ticket quantities.
1545
+ * Amount of tickets in the reservation.
1514
1546
  * @maxSize 50
1515
1547
  */
1516
1548
  quantities?: TicketQuantity[];
1517
- /** Reservation update timestamp. */
1549
+ /** Date and time the reservation was updated. */
1518
1550
  _updatedDate?: Date | null;
1519
1551
  /**
1520
- * Reservation counts.
1552
+ * Number of reservations.
1521
1553
  * @maxSize 50
1522
1554
  */
1523
1555
  counts?: ReservationCount[];
@@ -1529,7 +1561,7 @@ export interface GetCheckoutOptionsResponse {
1529
1561
  paymentMethodConfigured?: boolean;
1530
1562
  /** Whether coupons are accepted at checkout. */
1531
1563
  acceptCoupons?: boolean;
1532
- /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
1564
+ /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature `"events_sell_tickets"`. */
1533
1565
  premiumServices?: boolean;
1534
1566
  /** Whether there are any paid tickets available for sale. */
1535
1567
  paidTickets?: boolean;
@@ -1538,7 +1570,7 @@ export interface GetCheckoutOptionsResponse {
1538
1570
  }
1539
1571
  export interface ListAvailableTicketsRequest {
1540
1572
  /**
1541
- * Event ID. If not provided, available tickets for all events in the site will be returned.
1573
+ * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
1542
1574
  * @format GUID
1543
1575
  */
1544
1576
  eventId?: string;
@@ -1721,7 +1753,10 @@ export interface QueryAvailableTicketsRequest {
1721
1753
  limit?: number;
1722
1754
  /** Ticket definition. */
1723
1755
  filter?: Record<string, any> | null;
1724
- /** @maxSize 20 */
1756
+ /**
1757
+ * Which fields to return.
1758
+ * @maxSize 20
1759
+ */
1725
1760
  fieldset?: TicketDefinitionFieldsetWithLiterals[];
1726
1761
  /**
1727
1762
  * Sort order.
@@ -1756,9 +1791,9 @@ export interface CreateReservationRequest {
1756
1791
  * @maxSize 50
1757
1792
  */
1758
1793
  ticketQuantities?: TicketReservationQuantity[];
1759
- /** Whether to ignore the available ticket limits upon reservation. */
1794
+ /** Whether to ignore the available ticket limits upon a reservation. */
1760
1795
  ignoreLimits?: boolean;
1761
- /** Whether to allow reservation for hidden tickets. */
1796
+ /** Whether to allow reservations for hidden tickets. */
1762
1797
  allowHiddenTickets?: boolean;
1763
1798
  }
1764
1799
  export interface TicketReservationQuantity {
@@ -1788,7 +1823,7 @@ export interface CreateReservationResponse {
1788
1823
  * @format GUID
1789
1824
  */
1790
1825
  _id?: string;
1791
- /** Reservation expiration timestamp. */
1826
+ /** Date and time the reservation expires. */
1792
1827
  expires?: Date | null;
1793
1828
  /** Ticket reservations. */
1794
1829
  reservations?: TicketReservation[];
@@ -1799,7 +1834,7 @@ export interface CreateReservationResponse {
1799
1834
  }
1800
1835
  export interface TicketReservation {
1801
1836
  /**
1802
- * Quantity of reserved tickets.
1837
+ * Amount of reserved tickets.
1803
1838
  * @min 1
1804
1839
  * @max 20
1805
1840
  */
@@ -1874,7 +1909,7 @@ export interface GetInvoiceResponse {
1874
1909
  * - `RESERVATION_EXPIRED`: The reservation has expired.
1875
1910
  */
1876
1911
  reservationStatus?: ReservationStatusWithLiterals;
1877
- /** Whether this reservation is already used in checkout. */
1912
+ /** Whether this reservation is already used in a checkout. */
1878
1913
  reservationOccupied?: boolean;
1879
1914
  /** Ticket reservations. */
1880
1915
  reservations?: TicketReservation[];
@@ -1954,7 +1989,7 @@ export interface Guest {
1954
1989
  form?: FormResponse;
1955
1990
  }
1956
1991
  export interface CheckoutOptions {
1957
- /** Whether to ignore settings to notify contacts or users. */
1992
+ /** Whether to ignore settings to notify contacts. */
1958
1993
  silent?: boolean;
1959
1994
  /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */
1960
1995
  payInPerson?: boolean;
@@ -1976,16 +2011,17 @@ export interface CheckoutResponse {
1976
2011
  /** Order page URL. */
1977
2012
  orderPageUrl?: string | null;
1978
2013
  }
2014
+ /** Triggered when an order is initiated. */
1979
2015
  export interface OrderInitiated {
1980
- /** Order initiated timestamp in ISO UTC format. */
2016
+ /** Date and time the order was initiated. */
1981
2017
  timestamp?: Date | null;
1982
2018
  /**
1983
- * Site language when Order initiated
2019
+ * Site language when the order was initiated.
1984
2020
  * @format LANGUAGE
1985
2021
  */
1986
2022
  language?: string | null;
1987
2023
  /**
1988
- * Locale in which Order was created.
2024
+ * Locale in which the order was created.
1989
2025
  * @format LANGUAGE_TAG
1990
2026
  */
1991
2027
  locale?: string | null;
@@ -1996,20 +2032,20 @@ export interface OrderInitiated {
1996
2032
  eventId?: string;
1997
2033
  /** Unique order number. */
1998
2034
  orderNumber?: string;
1999
- /** Contact ID associated with this order. */
2035
+ /** Contact ID associated with the order. */
2000
2036
  contactId?: string;
2001
2037
  /**
2002
- * Member ID associated with this order.
2038
+ * Member ID associated with the order.
2003
2039
  * @format GUID
2004
2040
  */
2005
2041
  memberId?: string | null;
2006
2042
  /**
2007
- * Order created timestamp.
2043
+ * Date and time the order was created.
2008
2044
  * @readonly
2009
2045
  */
2010
2046
  created?: Date | null;
2011
2047
  /**
2012
- * Order updated timestamp.
2048
+ * Date and time the order was updated.
2013
2049
  * @readonly
2014
2050
  */
2015
2051
  updated?: Date | null;
@@ -2034,7 +2070,7 @@ export interface OrderInitiated {
2034
2070
  status?: OrderStatusWithLiterals;
2035
2071
  /** Invoice. */
2036
2072
  invoice?: Invoice;
2037
- /** Reservation ID associated with this order. */
2073
+ /** Reservation ID associated with the order. */
2038
2074
  reservationId?: string;
2039
2075
  /** Order was marked as paid. */
2040
2076
  markedAsPaid?: boolean | null;
@@ -2058,7 +2094,11 @@ export interface UpdateCheckoutRequest {
2058
2094
  * @maxSize 20
2059
2095
  */
2060
2096
  guests?: Guest[];
2061
- /** Member ID (if empty - no site member is associated to this order). */
2097
+ /**
2098
+ * Member ID.
2099
+ *
2100
+ * If empty, no site member is associated to this order.
2101
+ */
2062
2102
  memberId?: string | null;
2063
2103
  /** Discount to apply on the invoice. */
2064
2104
  discount?: DiscountRequest;
@@ -2132,17 +2172,84 @@ export interface GetReservationRequest {
2132
2172
  reservationId?: string | null;
2133
2173
  }
2134
2174
  export interface GetReservationResponse {
2175
+ /** Reservation. */
2176
+ reservation?: Reservation;
2177
+ }
2178
+ export interface Reservation {
2135
2179
  /** Date and time the Ticket Reservation was created. */
2136
2180
  _createdDate?: Date | null;
2137
2181
  /** Date and time the Ticket Reservation was last updated. */
2138
2182
  _updatedDate?: Date | null;
2139
- /** Date and time the Pending TicketReservation will expire. */
2183
+ /** Date and time the pending ticket reservation will expire. */
2140
2184
  expirationDate?: Date | null;
2141
2185
  /** Reservation status. */
2142
2186
  reservationStatus?: ReservationStatusWithLiterals;
2143
- /** Ticket reservations. */
2187
+ /**
2188
+ * Ticket reservations.
2189
+ * @maxSize 50
2190
+ */
2144
2191
  reservations?: TicketReservation[];
2145
2192
  }
2193
+ export interface ConfirmReservationRequest {
2194
+ /**
2195
+ * Event ID.
2196
+ * @format GUID
2197
+ */
2198
+ eventId?: string | null;
2199
+ /**
2200
+ * Ticket reservation ID.
2201
+ * @format GUID
2202
+ */
2203
+ reservationId?: string | null;
2204
+ }
2205
+ export interface ConfirmReservationResponse {
2206
+ /** Reservation. */
2207
+ reservation?: Reservation;
2208
+ }
2209
+ export interface ExpireReservationRequest {
2210
+ /**
2211
+ * Event ID.
2212
+ * @format GUID
2213
+ */
2214
+ eventId?: string | null;
2215
+ /**
2216
+ * Ticket reservation ID.
2217
+ * @format GUID
2218
+ */
2219
+ reservationId?: string | null;
2220
+ }
2221
+ export interface ExpireReservationResponse {
2222
+ /** Reservation. */
2223
+ reservation?: Reservation;
2224
+ }
2225
+ export interface QueryEventsWithPaidReservationsRequest {
2226
+ /**
2227
+ * Event Keys.
2228
+ * @minSize 1
2229
+ * @maxSize 100
2230
+ */
2231
+ eventKeys?: EventKey[];
2232
+ }
2233
+ export interface EventKey {
2234
+ /**
2235
+ * Instance ID.
2236
+ * @format GUID
2237
+ */
2238
+ instanceId?: string | null;
2239
+ /**
2240
+ * Event ID.
2241
+ * @format GUID
2242
+ */
2243
+ eventId?: string | null;
2244
+ }
2245
+ export interface QueryEventsWithPaidReservationsResponse {
2246
+ /**
2247
+ * Event IDs.
2248
+ * @format GUID
2249
+ * @maxSize 100
2250
+ */
2251
+ eventIds?: string[] | null;
2252
+ }
2146
2253
  export interface BaseEventMetadata {
2147
2254
  /**
2148
2255
  * App instance ID.
@@ -2477,7 +2584,7 @@ export interface UpdateOrderOptions {
2477
2584
  fields?: string[];
2478
2585
  /** Checkout form. */
2479
2586
  checkoutForm?: FormResponse;
2480
- /** Whether order is archived. */
2587
+ /** Whether to archive the order. */
2481
2588
  archived?: boolean;
2482
2589
  }
2483
2590
  /**
@@ -2569,7 +2676,7 @@ export interface ConfirmOrderOptions {
2569
2676
  export declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
2570
2677
  export interface GetSummaryOptions {
2571
2678
  /**
2572
- * Event ID.
2679
+ * Event ID to which the order belongs.
2573
2680
  * @format GUID
2574
2681
  */
2575
2682
  eventId?: string | null;
@@ -2660,7 +2767,7 @@ export declare function getCheckoutOptions(): Promise<NonNullablePaths<GetChecko
2660
2767
  export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<NonNullablePaths<ListAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
2661
2768
  export interface ListAvailableTicketsOptions {
2662
2769
  /**
2663
- * Event ID. If not provided, available tickets for all events in the site will be returned.
2770
+ * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
2664
2771
  * @format GUID
2665
2772
  */
2666
2773
  eventId?: string;
@@ -2708,7 +2815,10 @@ export interface QueryAvailableTicketsOptions {
2708
2815
  limit?: number;
2709
2816
  /** Ticket definition. */
2710
2817
  filter?: Record<string, any> | null;
2711
- /** @maxSize 20 */
2818
+ /**
2819
+ * Which fields to return.
2820
+ * @maxSize 20
2821
+ */
2712
2822
  fieldset?: TicketDefinitionFieldsetWithLiterals[];
2713
2823
  /**
2714
2824
  * Sort order.
@@ -2746,9 +2856,9 @@ export interface CreateReservationOptions {
2746
2856
  * @maxSize 50
2747
2857
  */
2748
2858
  ticketQuantities?: TicketReservationQuantity[];
2749
- /** Whether to ignore the available ticket limits upon reservation. */
2859
+ /** Whether to ignore the available ticket limits upon a reservation. */
2750
2860
  ignoreLimits?: boolean;
2751
- /** Whether to allow reservation for hidden tickets. */
2861
+ /** Whether to allow reservations for hidden tickets. */
2752
2862
  allowHiddenTickets?: boolean;
2753
2863
  }
2754
2864
  /**
@@ -2896,7 +3006,11 @@ export interface UpdateCheckoutOptions {
2896
3006
  * @maxSize 20
2897
3007
  */
2898
3008
  guests?: Guest[];
2899
- /** Member ID (if empty - no site member is associated to this order). */
3009
+ /**
3010
+ * Member ID.
3011
+ *
3012
+ * If empty, no site member is associated to this order.
3013
+ */
2900
3014
  memberId?: string | null;
2901
3015
  /** Discount to apply on the invoice. */
2902
3016
  discount?: DiscountRequest;