@wix/auto_sdk_events_orders 1.0.43 → 1.0.44

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.
@@ -108,6 +108,85 @@ interface InputValue {
108
108
  */
109
109
  values?: string[];
110
110
  }
111
+ interface FormattedAddress {
112
+ /**
113
+ * 1-line address representation.
114
+ * @maxLength 200
115
+ */
116
+ formatted?: string;
117
+ /** Address components. */
118
+ address?: Address;
119
+ }
120
+ /** Physical address */
121
+ interface Address extends AddressStreetOneOf {
122
+ /** Street name and number. */
123
+ streetAddress?: StreetAddress;
124
+ /** Main address line, usually street and number as free text. */
125
+ addressLine?: string | null;
126
+ /**
127
+ * Country code.
128
+ * @format COUNTRY
129
+ */
130
+ country?: string | null;
131
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
132
+ subdivision?: string | null;
133
+ /** City name. */
134
+ city?: string | null;
135
+ /** Zip/postal code. */
136
+ postalCode?: string | null;
137
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
138
+ addressLine2?: string | null;
139
+ }
140
+ /** @oneof */
141
+ interface AddressStreetOneOf {
142
+ /** Street name and number. */
143
+ streetAddress?: StreetAddress;
144
+ /** Main address line, usually street and number as free text. */
145
+ addressLine?: string | null;
146
+ }
147
+ interface StreetAddress {
148
+ /** Street number. */
149
+ number?: string;
150
+ /** Street name. */
151
+ name?: string;
152
+ }
153
+ interface AddressLocation {
154
+ /** Address latitude. */
155
+ latitude?: number | null;
156
+ /** Address longitude. */
157
+ longitude?: number | null;
158
+ }
159
+ interface Subdivision {
160
+ /** Short subdivision code. */
161
+ code?: string;
162
+ /** Subdivision full name. */
163
+ name?: string;
164
+ }
165
+ declare enum SubdivisionType {
166
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
167
+ /** State */
168
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
169
+ /** County */
170
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
171
+ /** City/town */
172
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
173
+ /** Neighborhood/quarter */
174
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
175
+ /** Street/block */
176
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
177
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
178
+ COUNTRY = "COUNTRY"
179
+ }
180
+ /** @enumType */
181
+ type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
182
+ /** Subdivision Concordance values */
183
+ interface StandardDetails {
184
+ /**
185
+ * 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
186
+ * @maxLength 20
187
+ */
188
+ iso31662?: string | null;
189
+ }
111
190
  declare enum OrderStatus {
112
191
  /** Order status isn't available for this request fieldset. */
113
192
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
@@ -524,6 +603,166 @@ interface PaymentTransaction {
524
603
  */
525
604
  method?: string;
526
605
  }
606
+ declare enum ScheduledActionEnumAction {
607
+ /** Action not scheduled. */
608
+ UNKNOWN_ACTION = "UNKNOWN_ACTION",
609
+ /** Captured after the delay. */
610
+ CAPTURE = "CAPTURE",
611
+ /** Void after the delay. */
612
+ VOID = "VOID"
613
+ }
614
+ /** @enumType */
615
+ type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
616
+ declare enum Action {
617
+ /** Order can be archived. */
618
+ ARCHIVE = "ARCHIVE",
619
+ /** Order can be unarchived. */
620
+ UNARCHIVE = "UNARCHIVE",
621
+ /** Order can be confirmed. */
622
+ CONFIRM = "CONFIRM",
623
+ /** Order can be captured. */
624
+ CAPTURE = "CAPTURE",
625
+ /** Order can be voided. */
626
+ VOID = "VOID"
627
+ }
628
+ /** @enumType */
629
+ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
630
+ interface GiftCardPaymentDetails {
631
+ /**
632
+ * Gift card payment ID.
633
+ * @format GUID
634
+ */
635
+ giftCardPaymentId?: string | null;
636
+ /**
637
+ * ID of the app that created the gift card.
638
+ * @format GUID
639
+ */
640
+ appId?: string | null;
641
+ /** Whether the gift card payment is voided. */
642
+ voided?: boolean | null;
643
+ /** Amount */
644
+ amount?: Money;
645
+ /**
646
+ * Obfuscated gift card code.
647
+ * @maxLength 30
648
+ */
649
+ obfuscatedCode?: string | null;
650
+ /**
651
+ * Gift card code.
652
+ * @maxLength 30
653
+ */
654
+ code?: string | null;
655
+ }
656
+ interface BalanceSummary {
657
+ /** Amount left to pay. */
658
+ balance?: Money;
659
+ }
660
+ /** Triggered when an order is deleted. */
661
+ interface OrderDeleted {
662
+ /** Date and time the order was deleted. */
663
+ timestamp?: Date | null;
664
+ /**
665
+ * Event ID to which the order belongs.
666
+ * @format GUID
667
+ */
668
+ eventId?: string;
669
+ /** Unique order number. */
670
+ orderNumber?: string;
671
+ /** Contact ID associated with the order. */
672
+ contactId?: string;
673
+ /**
674
+ * Member ID associated with the order.
675
+ * @format GUID
676
+ */
677
+ memberId?: string | null;
678
+ /**
679
+ * Date and time the order was created.
680
+ * @readonly
681
+ */
682
+ created?: Date | null;
683
+ /**
684
+ * Date and time the order was updated.
685
+ * @readonly
686
+ */
687
+ updated?: Date | null;
688
+ /** Whether the order was anonymized by GDPR delete. */
689
+ anonymized?: boolean;
690
+ /** Order type. */
691
+ orderType?: OrderTypeWithLiterals;
692
+ /** Whether the event was triggered by GDPR delete request. */
693
+ triggeredByAnonymizeRequest?: boolean;
694
+ /** Tickets generated after payment. */
695
+ tickets?: Ticket[];
696
+ }
697
+ declare enum OrderType {
698
+ /** Buyer form is used for all tickets. */
699
+ UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
700
+ /** Each order ticket has its own form. */
701
+ ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
702
+ }
703
+ /** @enumType */
704
+ type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
705
+ interface Ticket {
706
+ /** Unique issued ticket number. */
707
+ ticketNumber?: string;
708
+ /**
709
+ * Ticket definition ID.
710
+ * @format GUID
711
+ */
712
+ ticketDefinitionId?: string;
713
+ /** Ticket check-in. */
714
+ checkIn?: CheckIn;
715
+ /** Ticket price. */
716
+ price?: Money;
717
+ /** Whether ticket is archived. */
718
+ archived?: boolean;
719
+ /** Guest first name. */
720
+ firstName?: string | null;
721
+ /** Guest last name. */
722
+ lastName?: string | null;
723
+ /** Guest email. */
724
+ email?: string | null;
725
+ /**
726
+ * Contact ID associated with this ticket.
727
+ * @format GUID
728
+ */
729
+ contactId?: string | null;
730
+ /** Whether ticket is confirmed */
731
+ confirmed?: boolean;
732
+ /**
733
+ * Member ID associated with this ticket.
734
+ * @format GUID
735
+ */
736
+ memberId?: string | null;
737
+ /** Ticket form response (only assigned tickets contain separate forms). */
738
+ form?: FormResponse;
739
+ /** Ticket name. */
740
+ ticketName?: string;
741
+ /** Anonymized tickets no longer contain personally identifiable information (PII). */
742
+ anonymized?: boolean;
743
+ /** URL and password to online conference */
744
+ onlineConferencingLogin?: OnlineConferencingLogin;
745
+ /**
746
+ * Seat ID associated with this ticket.
747
+ * @maxLength 36
748
+ */
749
+ seatId?: string | null;
750
+ /** Whether ticket is canceled. */
751
+ canceled?: boolean | null;
752
+ }
753
+ interface OnlineConferencingLogin {
754
+ /**
755
+ * Link URL to the online conference.
756
+ * @format WEB_URL
757
+ * @readonly
758
+ */
759
+ link?: string;
760
+ /**
761
+ * Password for the online conference.
762
+ * @readonly
763
+ */
764
+ password?: string | null;
765
+ }
527
766
  interface ListOrdersRequest {
528
767
  /** Offset. */
529
768
  offset?: number;
@@ -712,6 +951,65 @@ interface UpdateOrderResponse {
712
951
  /** Updated order. */
713
952
  order?: Order;
714
953
  }
954
+ /** Triggered when an order is updated. */
955
+ interface OrderUpdated {
956
+ /** Date and time the order was updated. */
957
+ timestamp?: Date | null;
958
+ /**
959
+ * Site language when the order was initiated.
960
+ * @format LANGUAGE
961
+ */
962
+ language?: string | null;
963
+ /**
964
+ * Locale in which the order was created.
965
+ * @format LANGUAGE_TAG
966
+ */
967
+ locale?: string | null;
968
+ /**
969
+ * Event ID to which the order belongs.
970
+ * @format GUID
971
+ */
972
+ eventId?: string;
973
+ /** Unique order number. */
974
+ orderNumber?: string;
975
+ /** Contact ID associated with the order. */
976
+ contactId?: string;
977
+ /**
978
+ * Member ID associated with the order.
979
+ * @format GUID
980
+ */
981
+ memberId?: string | null;
982
+ /**
983
+ * Date and time the order was created.
984
+ * @readonly
985
+ */
986
+ created?: Date | null;
987
+ /**
988
+ * Date and time the order was updated.
989
+ * @readonly
990
+ */
991
+ updated?: Date | null;
992
+ /** Buyer first name. */
993
+ firstName?: string;
994
+ /** Buyer last name. */
995
+ lastName?: string;
996
+ /** Buyer email. */
997
+ email?: string;
998
+ /** Checkout form response. */
999
+ checkoutForm?: FormResponse;
1000
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
1001
+ confirmed?: boolean;
1002
+ /** Order status. */
1003
+ status?: OrderStatusWithLiterals;
1004
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1005
+ method?: string | null;
1006
+ /** Tickets generated after payment. */
1007
+ tickets?: Ticket[];
1008
+ /** Whether order was archived and excluded from results. */
1009
+ archived?: boolean;
1010
+ /** Whether event was triggered by GDPR delete request. */
1011
+ triggeredByAnonymizeRequest?: boolean;
1012
+ }
715
1013
  interface BulkUpdateOrdersRequest {
716
1014
  /**
717
1015
  * Event ID to which the order belongs.
@@ -774,6 +1072,97 @@ interface TicketSales {
774
1072
  /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
775
1073
  revenue?: Money;
776
1074
  }
1075
+ interface GetInvoicePreviewRequest {
1076
+ /**
1077
+ * Event ID.
1078
+ * @format GUID
1079
+ */
1080
+ eventId?: string;
1081
+ /** Order number. */
1082
+ orderNumber?: string;
1083
+ }
1084
+ interface RawHttpResponse {
1085
+ body?: Uint8Array;
1086
+ statusCode?: number | null;
1087
+ headers?: HeadersEntry[];
1088
+ }
1089
+ interface HeadersEntry {
1090
+ key?: string;
1091
+ value?: string;
1092
+ }
1093
+ interface GetPaymentInfoRequest {
1094
+ /**
1095
+ * Event ID.
1096
+ * @format GUID
1097
+ */
1098
+ eventId?: string;
1099
+ /** Order number. */
1100
+ orderNumber?: string;
1101
+ }
1102
+ interface GetPaymentInfoResponse {
1103
+ transactions?: PaymentTransactionSummary[];
1104
+ status?: string | null;
1105
+ /**
1106
+ * @format GUID
1107
+ * @readonly
1108
+ */
1109
+ transactionId?: string | null;
1110
+ /** Whether at least one transaction that is not in the final status exists. */
1111
+ active?: boolean;
1112
+ }
1113
+ interface PaymentTransactionSummary {
1114
+ /**
1115
+ * Wix Payments transaction ID.
1116
+ * @format GUID
1117
+ * @readonly
1118
+ */
1119
+ transactionId?: string;
1120
+ /**
1121
+ * Final transaction status.
1122
+ * @readonly
1123
+ */
1124
+ finalTransactionStatus?: string;
1125
+ /** Transaction events. */
1126
+ events?: PaymentTransactionEvent[];
1127
+ }
1128
+ interface PaymentTransactionEvent {
1129
+ /**
1130
+ * Order snapshot ID.
1131
+ * @format GUID
1132
+ * @readonly
1133
+ */
1134
+ snapshotId?: string;
1135
+ /**
1136
+ * Transaction status
1137
+ * @readonly
1138
+ */
1139
+ transactionStatus?: string;
1140
+ /**
1141
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
1142
+ * @readonly
1143
+ */
1144
+ paymentMethod?: string;
1145
+ /**
1146
+ * Transaction payment amount
1147
+ * @readonly
1148
+ */
1149
+ paymentAmount?: Money;
1150
+ /**
1151
+ * Crated date
1152
+ * @readonly
1153
+ */
1154
+ createdDate?: Date | null;
1155
+ /**
1156
+ * Reason code
1157
+ * @readonly
1158
+ */
1159
+ reasonCode?: string | null;
1160
+ /**
1161
+ * Refunded amount
1162
+ * @readonly
1163
+ */
1164
+ refundedAmount?: Money;
1165
+ }
777
1166
  interface CaptureAuthorizedPaymentRequest {
778
1167
  /**
779
1168
  * Event ID.
@@ -804,6 +1193,252 @@ interface VoidAuthorizedPaymentRequest {
804
1193
  }
805
1194
  interface VoidAuthorizedPaymentResponse {
806
1195
  }
1196
+ interface FindOrderByReservationIdRequest {
1197
+ /**
1198
+ * Event ID
1199
+ * @format GUID
1200
+ */
1201
+ eventId?: string;
1202
+ /**
1203
+ * Reservation ID.
1204
+ * @format GUID
1205
+ */
1206
+ reservationId?: string;
1207
+ }
1208
+ interface FindOrderByReservationIdResponse {
1209
+ /** Order. */
1210
+ order?: Order;
1211
+ }
1212
+ interface MessageEnvelope {
1213
+ /**
1214
+ * App instance ID.
1215
+ * @format GUID
1216
+ */
1217
+ instanceId?: string | null;
1218
+ /**
1219
+ * Event type.
1220
+ * @maxLength 150
1221
+ */
1222
+ eventType?: string;
1223
+ /** The identification type and identity data. */
1224
+ identity?: IdentificationData;
1225
+ /** Stringify payload. */
1226
+ data?: string;
1227
+ }
1228
+ interface IdentificationData extends IdentificationDataIdOneOf {
1229
+ /**
1230
+ * ID of a site visitor that has not logged in to the site.
1231
+ * @format GUID
1232
+ */
1233
+ anonymousVisitorId?: string;
1234
+ /**
1235
+ * ID of a site visitor that has logged in to the site.
1236
+ * @format GUID
1237
+ */
1238
+ memberId?: string;
1239
+ /**
1240
+ * ID of a Wix user (site owner, contributor, etc.).
1241
+ * @format GUID
1242
+ */
1243
+ wixUserId?: string;
1244
+ /**
1245
+ * ID of an app.
1246
+ * @format GUID
1247
+ */
1248
+ appId?: string;
1249
+ /** @readonly */
1250
+ identityType?: WebhookIdentityTypeWithLiterals;
1251
+ }
1252
+ /** @oneof */
1253
+ interface IdentificationDataIdOneOf {
1254
+ /**
1255
+ * ID of a site visitor that has not logged in to the site.
1256
+ * @format GUID
1257
+ */
1258
+ anonymousVisitorId?: string;
1259
+ /**
1260
+ * ID of a site visitor that has logged in to the site.
1261
+ * @format GUID
1262
+ */
1263
+ memberId?: string;
1264
+ /**
1265
+ * ID of a Wix user (site owner, contributor, etc.).
1266
+ * @format GUID
1267
+ */
1268
+ wixUserId?: string;
1269
+ /**
1270
+ * ID of an app.
1271
+ * @format GUID
1272
+ */
1273
+ appId?: string;
1274
+ }
1275
+ declare enum WebhookIdentityType {
1276
+ UNKNOWN = "UNKNOWN",
1277
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1278
+ MEMBER = "MEMBER",
1279
+ WIX_USER = "WIX_USER",
1280
+ APP = "APP"
1281
+ }
1282
+ /** @enumType */
1283
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1284
+ /** Triggered when an order is confirmed. */
1285
+ interface OrderConfirmed {
1286
+ /** Date and time the order was confirmed. */
1287
+ timestamp?: Date | null;
1288
+ /**
1289
+ * Site language when the order was initiated.
1290
+ * @format LANGUAGE
1291
+ */
1292
+ language?: string | null;
1293
+ /** Notifications silenced for this domain event. */
1294
+ silent?: boolean | null;
1295
+ /**
1296
+ * Locale in which the order was created.
1297
+ * @format LANGUAGE_TAG
1298
+ */
1299
+ locale?: string | null;
1300
+ /**
1301
+ * Event ID to which the order belongs.
1302
+ * @format GUID
1303
+ */
1304
+ eventId?: string;
1305
+ /** Unique order number. */
1306
+ orderNumber?: string;
1307
+ /** Contact ID associated with the order. */
1308
+ contactId?: string;
1309
+ /**
1310
+ * Member ID associated with the order.
1311
+ * @format GUID
1312
+ */
1313
+ memberId?: string | null;
1314
+ /**
1315
+ * Date and time the order was created.
1316
+ * @readonly
1317
+ */
1318
+ created?: Date | null;
1319
+ /** Buyer first name. */
1320
+ firstName?: string;
1321
+ /** Buyer last name. */
1322
+ lastName?: string;
1323
+ /** Buyer email address. */
1324
+ email?: string;
1325
+ /** Checkout form response. */
1326
+ checkoutForm?: FormResponse;
1327
+ /** Order status. */
1328
+ status?: OrderStatusWithLiterals;
1329
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1330
+ method?: string | null;
1331
+ /** Tickets (generated after payment). */
1332
+ tickets?: Ticket[];
1333
+ /** Invoice. */
1334
+ invoice?: Invoice;
1335
+ /** Reservation ID associated with the order. */
1336
+ reservationId?: string;
1337
+ }
1338
+ /** Triggered when an order is paid. */
1339
+ interface OrderPaid {
1340
+ /** Date and time the order was paid. */
1341
+ timestamp?: Date | null;
1342
+ /**
1343
+ * Site language when the order was initiated.
1344
+ * @format LANGUAGE
1345
+ */
1346
+ language?: string | null;
1347
+ /** Notifications silenced for this domain event. */
1348
+ silent?: boolean | null;
1349
+ /**
1350
+ * Locale in which the order was created.
1351
+ * @format LANGUAGE_TAG
1352
+ */
1353
+ locale?: string | null;
1354
+ /**
1355
+ * Event ID to which the order belongs.
1356
+ * @format GUID
1357
+ */
1358
+ eventId?: string;
1359
+ /** Unique order number. */
1360
+ orderNumber?: string;
1361
+ /** Reservation ID associated with this order. */
1362
+ reservationId?: string;
1363
+ /**
1364
+ * Contact ID associated with this order.
1365
+ * @maxLength 36
1366
+ */
1367
+ contactId?: string;
1368
+ /**
1369
+ * Member ID associated with this order.
1370
+ * @format GUID
1371
+ */
1372
+ memberId?: string | null;
1373
+ /**
1374
+ * Date and time the order was created.
1375
+ * @readonly
1376
+ */
1377
+ created?: Date | null;
1378
+ /**
1379
+ * Buyer first name.
1380
+ * @maxLength 255
1381
+ */
1382
+ firstName?: string;
1383
+ /**
1384
+ * Buyer last name.
1385
+ * @maxLength 255
1386
+ */
1387
+ lastName?: string;
1388
+ /**
1389
+ * Buyer email address.
1390
+ * @maxLength 255
1391
+ */
1392
+ email?: string;
1393
+ /** Checkout form response. */
1394
+ checkoutForm?: FormResponse;
1395
+ /** Order status. */
1396
+ status?: OrderStatusWithLiterals;
1397
+ /**
1398
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1399
+ * @maxLength 255
1400
+ */
1401
+ method?: string | null;
1402
+ /**
1403
+ * Tickets (generated after payment).
1404
+ * @maxSize 50
1405
+ */
1406
+ tickets?: Ticket[];
1407
+ /** Invoice. */
1408
+ invoice?: Invoice;
1409
+ }
1410
+ /** Triggered when a reservation is created. */
1411
+ interface ReservationCreated {
1412
+ /** Date and time the reservation was created. */
1413
+ timestamp?: Date | null;
1414
+ /**
1415
+ * Event ID to which the reservation belongs.
1416
+ * @format GUID
1417
+ */
1418
+ eventId?: string;
1419
+ /**
1420
+ * Reservation ID.
1421
+ * Can be used to retrieve a reservation invoice.
1422
+ * @format GUID
1423
+ */
1424
+ reservationId?: string;
1425
+ /** Date and time the reservation expires. */
1426
+ expires?: Date | null;
1427
+ /** Reservation status. */
1428
+ status?: ReservationStatusWithLiterals;
1429
+ /**
1430
+ * Amount of tickets in the reservation.
1431
+ * @maxSize 50
1432
+ */
1433
+ quantities?: TicketQuantity[];
1434
+ /** Date and time the reservation was updated. */
1435
+ updatedDate?: Date | null;
1436
+ /**
1437
+ * Number of reservations.
1438
+ * @maxSize 50
1439
+ */
1440
+ counts?: ReservationCount[];
1441
+ }
807
1442
  declare enum ReservationStatus {
808
1443
  /** The reservation is pending confirmation. It will expire after a certain amount of time. */
809
1444
  RESERVATION_PENDING = "RESERVATION_PENDING",
@@ -818,6 +1453,64 @@ declare enum ReservationStatus {
818
1453
  }
819
1454
  /** @enumType */
820
1455
  type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
1456
+ interface TicketQuantity {
1457
+ /**
1458
+ * Ticket definition ID.
1459
+ * @format GUID
1460
+ */
1461
+ ticketDefinitionId?: string | null;
1462
+ /** Quantity. */
1463
+ quantity?: number | null;
1464
+ /** Quantity update timestamp. */
1465
+ updatedDate?: Date | null;
1466
+ }
1467
+ interface ReservationCount {
1468
+ /** Reservation Count snapshot timestamp. */
1469
+ timestamp?: Date | null;
1470
+ /**
1471
+ * Ticket Definition ID.
1472
+ * @format GUID
1473
+ */
1474
+ ticketDefinitionId?: string;
1475
+ /** Confirmed reservation count. */
1476
+ confirmedCount?: number;
1477
+ /** Pending reservation count. */
1478
+ pendingCount?: number;
1479
+ /** True if paid ticket reservation exist. */
1480
+ paidExists?: boolean;
1481
+ }
1482
+ /** Triggered when a reservation is updated. */
1483
+ interface ReservationUpdated {
1484
+ /** Date and time the reservation was updated. */
1485
+ timestamp?: Date | null;
1486
+ /**
1487
+ * Event ID to which the reservation belongs.
1488
+ * @format GUID
1489
+ */
1490
+ eventId?: string;
1491
+ /**
1492
+ * Reservation ID.
1493
+ * Can be used to retrieve a reservation invoice.
1494
+ * @format GUID
1495
+ */
1496
+ reservationId?: string;
1497
+ /** Reservation status. */
1498
+ status?: ReservationStatusWithLiterals;
1499
+ /** Date and time the reservation expires. */
1500
+ expires?: Date | null;
1501
+ /**
1502
+ * Amount of tickets in the reservation.
1503
+ * @maxSize 50
1504
+ */
1505
+ quantities?: TicketQuantity[];
1506
+ /** Date and time the reservation was updated. */
1507
+ updatedDate?: Date | null;
1508
+ /**
1509
+ * Number of reservations.
1510
+ * @maxSize 50
1511
+ */
1512
+ counts?: ReservationCount[];
1513
+ }
821
1514
  interface GetCheckoutOptionsRequest {
822
1515
  }
823
1516
  interface GetCheckoutOptionsResponse {
@@ -1184,6 +1877,17 @@ interface DiscountErrors {
1184
1877
  interface Error {
1185
1878
  code?: string;
1186
1879
  }
1880
+ interface GiftCardErrors {
1881
+ /**
1882
+ * Error.
1883
+ * @maxSize 10
1884
+ */
1885
+ error?: GiftCardErrorsError[];
1886
+ }
1887
+ interface GiftCardErrorsError {
1888
+ /** @maxLength 100 */
1889
+ code?: string;
1890
+ }
1187
1891
  interface CheckoutRequest {
1188
1892
  /**
1189
1893
  * Event ID.
@@ -1259,6 +1963,63 @@ interface CheckoutResponse {
1259
1963
  /** Order page URL. */
1260
1964
  orderPageUrl?: string | null;
1261
1965
  }
1966
+ /** Triggered when an order is initiated. */
1967
+ interface OrderInitiated {
1968
+ /** Date and time the order was initiated. */
1969
+ timestamp?: Date | null;
1970
+ /**
1971
+ * Site language when the order was initiated.
1972
+ * @format LANGUAGE
1973
+ */
1974
+ language?: string | null;
1975
+ /**
1976
+ * Locale in which the order was created.
1977
+ * @format LANGUAGE_TAG
1978
+ */
1979
+ locale?: string | null;
1980
+ /**
1981
+ * Event ID to which the order belongs.
1982
+ * @format GUID
1983
+ */
1984
+ eventId?: string;
1985
+ /** Unique order number. */
1986
+ orderNumber?: string;
1987
+ /** Contact ID associated with the order. */
1988
+ contactId?: string;
1989
+ /**
1990
+ * Member ID associated with the order.
1991
+ * @format GUID
1992
+ */
1993
+ memberId?: string | null;
1994
+ /**
1995
+ * Date and time the order was created.
1996
+ * @readonly
1997
+ */
1998
+ created?: Date | null;
1999
+ /**
2000
+ * Date and time the order was updated.
2001
+ * @readonly
2002
+ */
2003
+ updated?: Date | null;
2004
+ /** Guest first name. */
2005
+ firstName?: string;
2006
+ /** Guest last name. */
2007
+ lastName?: string;
2008
+ /** Guest email address. */
2009
+ email?: string;
2010
+ /** Checkout form response. */
2011
+ checkoutForm?: FormResponse;
2012
+ /** Order status. */
2013
+ status?: OrderStatusWithLiterals;
2014
+ /** Invoice. */
2015
+ invoice?: Invoice;
2016
+ /** Reservation ID associated with the order. */
2017
+ reservationId?: string;
2018
+ /** Order was marked as paid. */
2019
+ markedAsPaid?: boolean | null;
2020
+ /** Whether marketing consent was given. */
2021
+ marketingConsent?: boolean | null;
2022
+ }
1262
2023
  interface UpdateCheckoutRequest {
1263
2024
  /**
1264
2025
  * Event ID to which the checkout belongs.
@@ -1295,6 +2056,28 @@ interface UpdateCheckoutResponse {
1295
2056
  /** Order page URL. */
1296
2057
  orderPageUrl?: string | null;
1297
2058
  }
2059
+ interface OrderPageUrls {
2060
+ /**
2061
+ * Success order page URL.
2062
+ * @format WEB_URL
2063
+ */
2064
+ success?: string | null;
2065
+ /**
2066
+ * Pending order page URL.
2067
+ * @format WEB_URL
2068
+ */
2069
+ pending?: string | null;
2070
+ /**
2071
+ * Canceled order page URL.
2072
+ * @format WEB_URL
2073
+ */
2074
+ canceled?: string | null;
2075
+ /**
2076
+ * Error order page URL.
2077
+ * @format WEB_URL
2078
+ */
2079
+ error?: string | null;
2080
+ }
1298
2081
  interface PosCheckoutRequest {
1299
2082
  /**
1300
2083
  * Event ID.
@@ -1321,6 +2104,127 @@ interface PosCheckoutResponse {
1321
2104
  /** Ticket reservations. */
1322
2105
  reservations?: TicketReservation[];
1323
2106
  }
2107
+ interface GetReservationRequest {
2108
+ /**
2109
+ * Event ID.
2110
+ * @format GUID
2111
+ */
2112
+ eventId?: string | null;
2113
+ /**
2114
+ * Ticket reservation ID.
2115
+ * @format GUID
2116
+ */
2117
+ reservationId?: string | null;
2118
+ }
2119
+ interface GetReservationResponse {
2120
+ /** Reservation. */
2121
+ reservation?: Reservation;
2122
+ }
2123
+ interface Reservation {
2124
+ /** Date and time the ticket reservation was created. */
2125
+ createdDate?: Date | null;
2126
+ /** Date and time the ticket reservation was last updated. */
2127
+ updatedDate?: Date | null;
2128
+ /** Date and time the pending ticket reservation will expire. */
2129
+ expirationDate?: Date | null;
2130
+ /** Reservation status. */
2131
+ reservationStatus?: ReservationStatusWithLiterals;
2132
+ /**
2133
+ * Ticket reservations.
2134
+ * @maxSize 50
2135
+ */
2136
+ reservations?: TicketReservation[];
2137
+ }
2138
+ interface ConfirmReservationRequest {
2139
+ /**
2140
+ * Event ID.
2141
+ * @format GUID
2142
+ */
2143
+ eventId?: string | null;
2144
+ /**
2145
+ * Ticket reservation ID.
2146
+ * @format GUID
2147
+ */
2148
+ reservationId?: string | null;
2149
+ }
2150
+ interface ConfirmReservationResponse {
2151
+ /** Reservation. */
2152
+ reservation?: Reservation;
2153
+ }
2154
+ interface ExpireReservationRequest {
2155
+ /**
2156
+ * Event ID.
2157
+ * @format GUID
2158
+ */
2159
+ eventId?: string | null;
2160
+ /**
2161
+ * Ticket reservation ID.
2162
+ * @format GUID
2163
+ */
2164
+ reservationId?: string | null;
2165
+ }
2166
+ interface ExpireReservationResponse {
2167
+ /** Reservation. */
2168
+ reservation?: Reservation;
2169
+ }
2170
+ interface QueryEventsWithPaidReservationsRequest {
2171
+ /**
2172
+ * Event Keys.
2173
+ * @minSize 1
2174
+ * @maxSize 100
2175
+ */
2176
+ eventKeys?: EventKey[];
2177
+ }
2178
+ interface EventKey {
2179
+ /**
2180
+ * Instance ID.
2181
+ * @format GUID
2182
+ */
2183
+ instanceId?: string | null;
2184
+ /**
2185
+ * Event ID.
2186
+ * @format GUID
2187
+ */
2188
+ eventId?: string | null;
2189
+ }
2190
+ interface QueryEventsWithPaidReservationsResponse {
2191
+ /**
2192
+ * Event IDs.
2193
+ * @format GUID
2194
+ * @maxSize 100
2195
+ */
2196
+ eventIds?: string[] | null;
2197
+ }
2198
+ /** @docsIgnore */
2199
+ type UpdateOrderApplicationErrors = {
2200
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2201
+ description?: string;
2202
+ data?: Record<string, any>;
2203
+ };
2204
+ /** @docsIgnore */
2205
+ type BulkUpdateOrdersApplicationErrors = {
2206
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2207
+ description?: string;
2208
+ data?: Record<string, any>;
2209
+ };
2210
+ /** @docsIgnore */
2211
+ type ConfirmOrderApplicationErrors = {
2212
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2213
+ description?: string;
2214
+ data?: Record<string, any>;
2215
+ };
2216
+ /** @docsIgnore */
2217
+ type CaptureAuthorizedPaymentApplicationErrors = {
2218
+ code?: 'ORDER_STATUS_NOT_AUTHORIZED';
2219
+ description?: string;
2220
+ data?: Record<string, any>;
2221
+ };
2222
+ /** @docsIgnore */
2223
+ type VoidAuthorizedPaymentApplicationErrors = {
2224
+ code?: 'ORDER_STATUS_NOT_AUTHORIZED';
2225
+ description?: string;
2226
+ data?: Record<string, any>;
2227
+ };
1324
2228
 
1325
2229
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1326
2230
  getUrl: (context: any) => string;
@@ -1370,4 +2274,4 @@ declare function updateCheckout(): __PublicMethodMetaInfo<'PATCH', {
1370
2274
  }, UpdateCheckoutRequest$1, UpdateCheckoutRequest, UpdateCheckoutResponse$1, UpdateCheckoutResponse>;
1371
2275
  declare function posCheckout(): __PublicMethodMetaInfo<'POST', {}, PosCheckoutRequest$1, PosCheckoutRequest, PosCheckoutResponse$1, PosCheckoutResponse>;
1372
2276
 
1373
- export { type __PublicMethodMetaInfo, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };
2277
+ export { Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type BalanceSummary as BalanceSummaryOriginal, type BulkUpdateOrdersApplicationErrors as BulkUpdateOrdersApplicationErrorsOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type Buyer as BuyerOriginal, type CalendarLinks as CalendarLinksOriginal, type CancelReservationRequest as CancelReservationRequestOriginal, type CancelReservationResponse as CancelReservationResponseOriginal, type CaptureAuthorizedPaymentApplicationErrors as CaptureAuthorizedPaymentApplicationErrorsOriginal, type CaptureAuthorizedPaymentRequest as CaptureAuthorizedPaymentRequestOriginal, type CaptureAuthorizedPaymentResponse as CaptureAuthorizedPaymentResponseOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type CheckIn as CheckInOriginal, type CheckoutOptions as CheckoutOptionsOriginal, type CheckoutRequest as CheckoutRequestOriginal, type CheckoutResponse as CheckoutResponseOriginal, type ConfirmOrderApplicationErrors as ConfirmOrderApplicationErrorsOriginal, type ConfirmOrderRequest as ConfirmOrderRequestOriginal, type ConfirmOrderResponse as ConfirmOrderResponseOriginal, type ConfirmReservationRequest as ConfirmReservationRequestOriginal, type ConfirmReservationResponse as ConfirmReservationResponseOriginal, type Counts as CountsOriginal, type CouponDiscount as CouponDiscountOriginal, type CreateReservationRequest as CreateReservationRequestOriginal, type CreateReservationResponse as CreateReservationResponseOriginal, type Dashboard as DashboardOriginal, type DiscountErrors as DiscountErrorsOriginal, type DiscountItemDiscountOneOf as DiscountItemDiscountOneOfOriginal, type DiscountItem as DiscountItemOriginal, type Discount as DiscountOriginal, type DiscountRequest as DiscountRequestOriginal, type Error as ErrorOriginal, type EventKey as EventKeyOriginal, type ExpireReservationRequest as ExpireReservationRequestOriginal, type ExpireReservationResponse as ExpireReservationResponseOriginal, type FacetCounts as FacetCountsOriginal, FeeName as FeeNameOriginal, type FeeNameWithLiterals as FeeNameWithLiteralsOriginal, type Fee as FeeOriginal, FeeType as FeeTypeOriginal, type FeeTypeWithLiterals as FeeTypeWithLiteralsOriginal, type FindOrderByReservationIdRequest as FindOrderByReservationIdRequestOriginal, type FindOrderByReservationIdResponse as FindOrderByReservationIdResponseOriginal, type FormResponse as FormResponseOriginal, type FormattedAddress as FormattedAddressOriginal, type GetCheckoutOptionsRequest as GetCheckoutOptionsRequestOriginal, type GetCheckoutOptionsResponse as GetCheckoutOptionsResponseOriginal, type GetInvoicePreviewRequest as GetInvoicePreviewRequestOriginal, type GetInvoiceRequest as GetInvoiceRequestOriginal, type GetInvoiceResponse as GetInvoiceResponseOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentInfoRequest as GetPaymentInfoRequestOriginal, type GetPaymentInfoResponse as GetPaymentInfoResponseOriginal, type GetReservationRequest as GetReservationRequestOriginal, type GetReservationResponse as GetReservationResponseOriginal, type GetSummaryRequest as GetSummaryRequestOriginal, type GetSummaryResponse as GetSummaryResponseOriginal, type GiftCardErrorsError as GiftCardErrorsErrorOriginal, type GiftCardErrors as GiftCardErrorsOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GuestDetails as GuestDetailsOriginal, type Guest as GuestOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InputValue as InputValueOriginal, type Invoice as InvoiceOriginal, type Item as ItemOriginal, type ListAvailableTicketsRequest as ListAvailableTicketsRequestOriginal, type ListAvailableTicketsResponse as ListAvailableTicketsResponseOriginal, type ListOrdersRequest as ListOrdersRequestOriginal, type ListOrdersResponse as ListOrdersResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type OnlineConferencingLogin as OnlineConferencingLoginOriginal, type OrderConfirmed as OrderConfirmedOriginal, type OrderDeleted as OrderDeletedOriginal, type OrderFacetCounts as OrderFacetCountsOriginal, type OrderFacets as OrderFacetsOriginal, OrderFieldset as OrderFieldsetOriginal, type OrderFieldsetWithLiterals as OrderFieldsetWithLiteralsOriginal, type OrderInitiated as OrderInitiatedOriginal, type Order as OrderOriginal, type OrderPageUrls as OrderPageUrlsOriginal, type OrderPaid as OrderPaidOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, OrderTag as OrderTagOriginal, type OrderTagWithLiterals as OrderTagWithLiteralsOriginal, OrderType as OrderTypeOriginal, type OrderTypeWithLiterals as OrderTypeWithLiteralsOriginal, type OrderUpdated as OrderUpdatedOriginal, type PaidPlanBenefit as PaidPlanBenefitOriginal, type PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOfOriginal, type PaidPlanDiscount as PaidPlanDiscountOriginal, type PaymentDetails as PaymentDetailsOriginal, type PaymentTransactionEvent as PaymentTransactionEventOriginal, type PaymentTransaction as PaymentTransactionOriginal, type PaymentTransactionSummary as PaymentTransactionSummaryOriginal, type PercentDiscount as PercentDiscountOriginal, type PosCheckoutRequest as PosCheckoutRequestOriginal, type PosCheckoutResponse as PosCheckoutResponseOriginal, type PricingOption as PricingOptionOriginal, type PricingOptions as PricingOptionsOriginal, type QueryAvailableTicketsRequest as QueryAvailableTicketsRequestOriginal, type QueryAvailableTicketsResponse as QueryAvailableTicketsResponseOriginal, type QueryEventsWithPaidReservationsRequest as QueryEventsWithPaidReservationsRequestOriginal, type QueryEventsWithPaidReservationsResponse as QueryEventsWithPaidReservationsResponseOriginal, type RawHttpResponse as RawHttpResponseOriginal, type ReservationCount as ReservationCountOriginal, type ReservationCreated as ReservationCreatedOriginal, type Reservation as ReservationOriginal, ReservationStatus as ReservationStatusOriginal, type ReservationStatusWithLiterals as ReservationStatusWithLiteralsOriginal, type ReservationUpdated as ReservationUpdatedOriginal, type ResponseMetaData as ResponseMetaDataOriginal, ScheduledActionEnumAction as ScheduledActionEnumActionOriginal, type ScheduledActionEnumActionWithLiterals as ScheduledActionEnumActionWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type Tax as TaxOriginal, TaxType as TaxTypeOriginal, type TaxTypeWithLiterals as TaxTypeWithLiteralsOriginal, TicketDefinitionFieldset as TicketDefinitionFieldsetOriginal, type TicketDefinitionFieldsetWithLiterals as TicketDefinitionFieldsetWithLiteralsOriginal, type TicketDefinition as TicketDefinitionOriginal, type TicketDetails as TicketDetailsOriginal, type Ticket as TicketOriginal, type TicketPricing as TicketPricingOriginal, type TicketPricingPriceOneOf as TicketPricingPriceOneOfOriginal, type TicketQuantity as TicketQuantityOriginal, type TicketReservation as TicketReservationOriginal, type TicketReservationQuantity as TicketReservationQuantityOriginal, type TicketSalePeriod as TicketSalePeriodOriginal, TicketSaleStatus as TicketSaleStatusOriginal, type TicketSaleStatusWithLiterals as TicketSaleStatusWithLiteralsOriginal, type TicketSales as TicketSalesOriginal, type TicketingTicket as TicketingTicketOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateCheckoutRequest as UpdateCheckoutRequestOriginal, type UpdateCheckoutResponse as UpdateCheckoutResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type VoidAuthorizedPaymentApplicationErrors as VoidAuthorizedPaymentApplicationErrorsOriginal, type VoidAuthorizedPaymentRequest as VoidAuthorizedPaymentRequestOriginal, type VoidAuthorizedPaymentResponse as VoidAuthorizedPaymentResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixFeeConfig as WixFeeConfigOriginal, type __PublicMethodMetaInfo, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };