@wix/auto_sdk_events_orders 1.0.23 → 1.0.25

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 (29) hide show
  1. package/build/cjs/index.d.ts +45 -20
  2. package/build/cjs/index.js +2 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/{events-v1-order-orders.universal-BK8XPFRp.d.ts → index.typings.d.ts} +442 -53
  5. package/build/cjs/index.typings.js +2438 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +41 -50
  8. package/build/es/index.d.mts +45 -20
  9. package/build/es/index.mjs +2 -0
  10. package/build/es/index.mjs.map +1 -1
  11. package/build/es/{events-v1-order-orders.universal-BK8XPFRp.d.mts → index.typings.d.mts} +442 -53
  12. package/build/es/index.typings.mjs +2381 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/es/meta.d.mts +41 -50
  15. package/build/internal/cjs/index.d.ts +45 -20
  16. package/build/internal/cjs/index.js +2 -0
  17. package/build/internal/cjs/index.js.map +1 -1
  18. package/build/internal/cjs/{events-v1-order-orders.universal-BK8XPFRp.d.ts → index.typings.d.ts} +442 -53
  19. package/build/internal/cjs/index.typings.js +2438 -0
  20. package/build/internal/cjs/index.typings.js.map +1 -0
  21. package/build/internal/cjs/meta.d.ts +41 -50
  22. package/build/internal/es/index.d.mts +45 -20
  23. package/build/internal/es/index.mjs +2 -0
  24. package/build/internal/es/index.mjs.map +1 -1
  25. package/build/internal/es/{events-v1-order-orders.universal-BK8XPFRp.d.mts → index.typings.d.mts} +442 -53
  26. package/build/internal/es/index.typings.mjs +2381 -0
  27. package/build/internal/es/index.typings.mjs.map +1 -0
  28. package/build/internal/es/meta.d.mts +41 -50
  29. package/package.json +3 -3
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  interface Order {
2
4
  /** Unique order number. */
3
5
  orderNumber?: string;
@@ -18,7 +20,7 @@ interface Order {
18
20
  */
19
21
  eventId?: string;
20
22
  /**
21
- * Contact ID of buyer, resolved using the email address provided. See the Contacts API for additional information.
23
+ * Contact ID of buyer, resolved using the email address specified. See the Contacts API for additional information.
22
24
  * @format GUID
23
25
  */
24
26
  contactId?: string;
@@ -28,7 +30,7 @@ interface Order {
28
30
  */
29
31
  memberId?: string;
30
32
  /**
31
- * Date and time the RSVP was created.
33
+ * Date and time the order was created.
32
34
  * @readonly
33
35
  */
34
36
  created?: Date | null;
@@ -37,7 +39,7 @@ interface Order {
37
39
  /** Guest last name. */
38
40
  lastName?: string;
39
41
  /**
40
- * Guest email.
42
+ * Guest email address.
41
43
  * @format EMAIL
42
44
  */
43
45
  email?: string;
@@ -56,7 +58,7 @@ interface Order {
56
58
  * - `DECLINED`: The order is payment is declined.
57
59
  */
58
60
  status?: OrderStatusWithLiterals;
59
- /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
61
+ /** Payment method used for purchase, for example, "payPal", "creditCard", etc. */
60
62
  method?: string;
61
63
  /** Quantity of ordered tickets. */
62
64
  ticketsQuantity?: number;
@@ -74,14 +76,14 @@ interface Order {
74
76
  fullName?: string;
75
77
  /** Order invoice. */
76
78
  invoice?: Invoice;
77
- /** Whether all tickets in an order are checked-in. */
79
+ /** Whether all tickets in an order are checked in. */
78
80
  fullyCheckedIn?: boolean;
79
- /** Internal order payment details */
81
+ /** Internal order payment details. */
80
82
  paymentDetails?: PaymentDetails;
81
83
  /** Checkout channel type. */
82
84
  channel?: ChannelTypeWithLiterals;
83
85
  /**
84
- * Date and time the order was updated.
86
+ * Date and time the order was last updated.
85
87
  * @readonly
86
88
  */
87
89
  updated?: Date | null;
@@ -115,11 +117,11 @@ interface InputValue {
115
117
  }
116
118
  interface FormattedAddress {
117
119
  /**
118
- * One line address representation.
120
+ * 1-line address representation.
119
121
  * @maxLength 200
120
122
  */
121
123
  formatted?: string;
122
- /** Address components (optional). */
124
+ /** Address components. */
123
125
  address?: Address;
124
126
  }
125
127
  /** Physical address */
@@ -182,6 +184,8 @@ declare enum SubdivisionType {
182
184
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
183
185
  COUNTRY = "COUNTRY"
184
186
  }
187
+ /** @enumType */
188
+ 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';
185
189
  /** Subdivision Concordance values */
186
190
  interface StandardDetails {
187
191
  /**
@@ -191,7 +195,7 @@ interface StandardDetails {
191
195
  iso31662?: string | null;
192
196
  }
193
197
  declare enum OrderStatus {
194
- /** Order status is not available for this request fieldset. */
198
+ /** Order status isn't available for this request fieldset. */
195
199
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
196
200
  /** Order is confirmed, no payment is required. */
197
201
  FREE = "FREE",
@@ -199,9 +203,9 @@ declare enum OrderStatus {
199
203
  PENDING = "PENDING",
200
204
  /** Order is paid. */
201
205
  PAID = "PAID",
202
- /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
206
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
203
207
  OFFLINE_PENDING = "OFFLINE_PENDING",
204
- /** Order is awaiting for payment at the cashier. */
208
+ /** Order is waiting for payment at the cashier. */
205
209
  INITIATED = "INITIATED",
206
210
  /** Order is canceled. */
207
211
  CANCELED = "CANCELED",
@@ -235,7 +239,7 @@ interface Money {
235
239
  value?: string | null;
236
240
  }
237
241
  interface TicketingTicket {
238
- /** Unique ticket number (issued automatically). */
242
+ /** Unique ticket number which is assigned automatically when creating a ticket. */
239
243
  ticketNumber?: string;
240
244
  /** Associated order number. */
241
245
  orderNumber?: string;
@@ -255,18 +259,13 @@ interface TicketingTicket {
255
259
  free?: boolean;
256
260
  /** Event and ticket policies. */
257
261
  policy?: string;
258
- /**
259
- * *Deprecated:** Use `tickets.checkInUrl` instead.
260
- * @deprecated
261
- */
262
- qrCode?: string;
263
262
  /** Ticket check-in. */
264
263
  checkIn?: CheckIn;
265
264
  /** Associated order status. */
266
265
  orderStatus?: OrderStatusWithLiterals;
267
266
  /**
268
267
  * Whether the order and ticket are archived.
269
- * If set to `true`, they are not visible in the order list.
268
+ * If set to `true`, they aren't visible in the order list.
270
269
  */
271
270
  orderArchived?: boolean;
272
271
  /** Buyer full name. */
@@ -275,13 +274,8 @@ interface TicketingTicket {
275
274
  guestFullName?: string | null;
276
275
  /** Guest personal details. */
277
276
  guestDetails?: GuestDetails;
278
- /** Whether ticket is visible in guest list. */
277
+ /** Whether the ticket is visible in an order. */
279
278
  archived?: boolean;
280
- /**
281
- * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
282
- * @deprecated
283
- */
284
- ticketPdf?: string;
285
279
  /**
286
280
  * Ticket owner member ID.
287
281
  * @format GUID
@@ -316,7 +310,7 @@ interface TicketingTicket {
316
310
  canceled?: boolean | null;
317
311
  }
318
312
  interface CheckIn {
319
- /** Time of check-in. */
313
+ /** Time of a ticket's check-in. */
320
314
  created?: Date | null;
321
315
  }
322
316
  interface GuestDetails {
@@ -345,7 +339,7 @@ interface GuestDetails {
345
339
  phone?: string | null;
346
340
  }
347
341
  declare enum ChannelType {
348
- /** Buyer created the order via an online channel, such as a website or a mobile app. */
342
+ /** Buyer created the order via an online channel, such as a website or mobile app. */
349
343
  ONLINE = "ONLINE",
350
344
  /** Sales person created the order and collected the money. */
351
345
  OFFLINE_POS = "OFFLINE_POS"
@@ -426,8 +420,8 @@ interface Invoice {
426
420
  * Total amount of a cart after discount, tax, and fees.
427
421
  * Grand total is calculated in the following order:
428
422
  * 1. Total prices of all items in the cart are calculated.
429
- * 2. Discount is subtracted from the cart (if applicable).
430
- * 3. Tax is added (if applicable).
423
+ * 2. Discount is subtracted from the cart, if applicable.
424
+ * 3. Tax is added, if applicable.
431
425
  * 4. Wix ticket service fee is added.
432
426
  */
433
427
  grandTotal?: Money;
@@ -436,7 +430,7 @@ interface Invoice {
436
430
  * @readonly
437
431
  */
438
432
  fees?: Fee[];
439
- /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
433
+ /** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
440
434
  revenue?: Money;
441
435
  /** Invoice preview URL. This value is only returned when the order is paid. */
442
436
  previewUrl?: string | null;
@@ -594,7 +588,7 @@ declare enum FeeType {
594
588
  /** @enumType */
595
589
  type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
596
590
  interface PaymentDetails {
597
- /** Wix Payments transaction */
591
+ /** Wix Payments transaction. */
598
592
  transaction?: PaymentTransaction;
599
593
  }
600
594
  interface PaymentTransaction {
@@ -605,7 +599,7 @@ interface PaymentTransaction {
605
599
  */
606
600
  transactionId?: string;
607
601
  /**
608
- * Transaction Payment method e.g., "payPal", "creditCard", etc.
602
+ * Transaction payment method, for example, "payPal", "creditCard", etc.
609
603
  * @readonly
610
604
  */
611
605
  method?: string;
@@ -618,6 +612,8 @@ declare enum ScheduledActionEnumAction {
618
612
  /** Void after the delay. */
619
613
  VOID = "VOID"
620
614
  }
615
+ /** @enumType */
616
+ type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
621
617
  declare enum Action {
622
618
  /** Order can be archived. */
623
619
  ARCHIVE = "ARCHIVE",
@@ -630,9 +626,11 @@ declare enum Action {
630
626
  /** Order can be voided. */
631
627
  VOID = "VOID"
632
628
  }
629
+ /** @enumType */
630
+ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
633
631
  interface GiftCardPaymentDetails {
634
632
  /**
635
- * Gift card payment id.
633
+ * Gift card payment ID.
636
634
  * @format GUID
637
635
  */
638
636
  giftCardPaymentId?: string | null;
@@ -1476,9 +1474,9 @@ interface ReservationCreated {
1476
1474
  counts?: ReservationCount[];
1477
1475
  }
1478
1476
  declare enum ReservationStatus {
1479
- /** The Reservation is pending confirmation. It will expire after a certain amount of time. */
1477
+ /** The reservation is pending confirmation. It will expire after a certain amount of time. */
1480
1478
  RESERVATION_PENDING = "RESERVATION_PENDING",
1481
- /** The reservation is confirmed and will not expire. */
1479
+ /** The reservation is confirmed and won't expire. */
1482
1480
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
1483
1481
  /** The reservation is canceled because it's not paid. */
1484
1482
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
@@ -1554,7 +1552,7 @@ interface GetCheckoutOptionsResponse {
1554
1552
  paymentMethodConfigured?: boolean;
1555
1553
  /** Whether coupons are accepted at checkout. */
1556
1554
  acceptCoupons?: boolean;
1557
- /** 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"`. */
1555
+ /** Whether premium services are enabled. Enabled for free if site doesn't sell any paid tickets. Selling tickets for a fee requires a premium feature `"events_sell_tickets"`. */
1558
1556
  premiumServices?: boolean;
1559
1557
  /** Whether there are any paid tickets available for sale. */
1560
1558
  paidTickets?: boolean;
@@ -1563,7 +1561,7 @@ interface GetCheckoutOptionsResponse {
1563
1561
  }
1564
1562
  interface ListAvailableTicketsRequest {
1565
1563
  /**
1566
- * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
1564
+ * Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
1567
1565
  * @format GUID
1568
1566
  */
1569
1567
  eventId?: string;
@@ -1676,7 +1674,7 @@ interface TicketSalePeriod {
1676
1674
  startDate?: Date | null;
1677
1675
  /** Ticket sale end timestamp. */
1678
1676
  endDate?: Date | null;
1679
- /** Whether to hide this ticket if it's not on sale */
1677
+ /** Whether to hide this ticket if it isn't on sale. */
1680
1678
  hideNotOnSale?: boolean;
1681
1679
  }
1682
1680
  declare enum TicketSaleStatus {
@@ -1807,7 +1805,7 @@ interface TicketReservationQuantity {
1807
1805
  * @format DECIMAL_VALUE
1808
1806
  */
1809
1807
  priceOverride?: string | null;
1810
- /** Optional ticket details */
1808
+ /** Optional ticket details. */
1811
1809
  ticketDetails?: TicketDetails[];
1812
1810
  }
1813
1811
  interface CreateReservationResponse {
@@ -1937,7 +1935,7 @@ interface CheckoutRequest {
1937
1935
  * @format GUID
1938
1936
  */
1939
1937
  reservationId?: string;
1940
- /** Member ID (if empty - no site member is associated to this order). */
1938
+ /** Member ID. If empty, no site member is associated with this order. */
1941
1939
  memberId?: string;
1942
1940
  /** Discount to apply on the invoice. */
1943
1941
  discount?: DiscountRequest;
@@ -1953,7 +1951,7 @@ interface CheckoutRequest {
1953
1951
  paidPlanBenefit?: PaidPlanBenefit;
1954
1952
  /** Options controlling the checkout process. */
1955
1953
  options?: CheckoutOptions;
1956
- /** Whether marketing consent was given */
1954
+ /** Whether marketing consent was given. */
1957
1955
  marketingConsent?: boolean | null;
1958
1956
  }
1959
1957
  interface Buyer {
@@ -1984,7 +1982,7 @@ interface Guest {
1984
1982
  interface CheckoutOptions {
1985
1983
  /** Whether to ignore settings to notify contacts. */
1986
1984
  silent?: boolean;
1987
- /** 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. */
1985
+ /** 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. */
1988
1986
  payInPerson?: boolean;
1989
1987
  /** Whether to ignore form validation. */
1990
1988
  ignoreFormValidation?: boolean;
@@ -2092,7 +2090,7 @@ interface UpdateCheckoutRequest {
2092
2090
  /**
2093
2091
  * Member ID.
2094
2092
  *
2095
- * If empty, no site member is associated to this order.
2093
+ * If empty, no site member is associated with this order.
2096
2094
  */
2097
2095
  memberId?: string | null;
2098
2096
  /** Discount to apply on the invoice. */
@@ -2141,7 +2139,7 @@ interface PosCheckoutRequest {
2141
2139
  reservationId: string;
2142
2140
  /**
2143
2141
  * Payment details ID.
2144
- * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2142
+ * Not required if reservation total is 0. In this case the order will be created with status `FREE` and no payment.
2145
2143
  * @format GUID
2146
2144
  */
2147
2145
  paymentDetailsId?: string | null;
@@ -2149,7 +2147,7 @@ interface PosCheckoutRequest {
2149
2147
  interface PosCheckoutResponse {
2150
2148
  /** Created order. */
2151
2149
  order?: Order;
2152
- /** Time when the order expires, applies to orders with status = INITIATED. */
2150
+ /** Time when the order expires, applies to orders with status is `INITIATED`. */
2153
2151
  expires?: Date | null;
2154
2152
  /** Ticket reservations. */
2155
2153
  reservations?: TicketReservation[];
@@ -2171,9 +2169,9 @@ interface GetReservationResponse {
2171
2169
  reservation?: Reservation;
2172
2170
  }
2173
2171
  interface Reservation {
2174
- /** Date and time the Ticket Reservation was created. */
2172
+ /** Date and time the ticket reservation was created. */
2175
2173
  _createdDate?: Date | null;
2176
- /** Date and time the Ticket Reservation was last updated. */
2174
+ /** Date and time the ticket reservation was last updated. */
2177
2175
  _updatedDate?: Date | null;
2178
2176
  /** Date and time the pending ticket reservation will expire. */
2179
2177
  expirationDate?: Date | null;
@@ -2245,6 +2243,31 @@ interface QueryEventsWithPaidReservationsResponse {
2245
2243
  */
2246
2244
  eventIds?: string[] | null;
2247
2245
  }
2246
+ type UpdateOrderApplicationErrors = {
2247
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2248
+ description?: string;
2249
+ data?: Record<string, any>;
2250
+ };
2251
+ type BulkUpdateOrdersApplicationErrors = {
2252
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2253
+ description?: string;
2254
+ data?: Record<string, any>;
2255
+ };
2256
+ type ConfirmOrderApplicationErrors = {
2257
+ code?: 'ORDER_ACTION_NOT_AVAILABLE';
2258
+ description?: string;
2259
+ data?: Record<string, any>;
2260
+ };
2261
+ type CaptureAuthorizedPaymentApplicationErrors = {
2262
+ code?: 'ORDER_STATUS_NOT_AUTHORIZED';
2263
+ description?: string;
2264
+ data?: Record<string, any>;
2265
+ };
2266
+ type VoidAuthorizedPaymentApplicationErrors = {
2267
+ code?: 'ORDER_STATUS_NOT_AUTHORIZED';
2268
+ description?: string;
2269
+ data?: Record<string, any>;
2270
+ };
2248
2271
  interface BaseEventMetadata {
2249
2272
  /**
2250
2273
  * App instance ID.
@@ -2263,26 +2286,142 @@ interface OrderDeletedEnvelope {
2263
2286
  data: OrderDeleted;
2264
2287
  metadata: BaseEventMetadata;
2265
2288
  }
2289
+ /**
2290
+ * This event is triggered when an order is deleted via a GDPR request.
2291
+ * @permissionScope Read Events - all read permissions
2292
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2293
+ * @permissionScope Manage Events - all permissions
2294
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2295
+ * @permissionScope Manage Events
2296
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2297
+ * @permissionScope Read Basic Events Order Info
2298
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2299
+ * @permissionScope Manage Orders
2300
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2301
+ * @permissionId WIX_EVENTS.READ_ORDERS
2302
+ * @webhook
2303
+ * @eventType wix.events.ticketing.events.OrderDeleted
2304
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
2305
+ * @slug order_deleted
2306
+ */
2307
+ declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
2266
2308
  interface OrderUpdatedEnvelope {
2267
2309
  data: OrderUpdated;
2268
2310
  metadata: BaseEventMetadata;
2269
2311
  }
2312
+ /** @permissionScope Read Events - all read permissions
2313
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2314
+ * @permissionScope Manage Events - all permissions
2315
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2316
+ * @permissionScope Manage Events
2317
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2318
+ * @permissionScope Read Basic Events Order Info
2319
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2320
+ * @permissionScope Manage Orders
2321
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2322
+ * @permissionId WIX_EVENTS.READ_ORDERS
2323
+ * @webhook
2324
+ * @eventType wix.events.ticketing.events.OrderUpdated
2325
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
2326
+ * @slug order_updated
2327
+ */
2328
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2270
2329
  interface OrderConfirmedEnvelope {
2271
2330
  data: OrderConfirmed;
2272
2331
  metadata: BaseEventMetadata;
2273
2332
  }
2333
+ /** @permissionScope Read Events - all read permissions
2334
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2335
+ * @permissionScope Manage Events - all permissions
2336
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2337
+ * @permissionScope Manage Events
2338
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2339
+ * @permissionScope Read Basic Events Order Info
2340
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2341
+ * @permissionScope Manage Orders
2342
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2343
+ * @permissionId WIX_EVENTS.READ_ORDERS
2344
+ * @webhook
2345
+ * @eventType wix.events.ticketing.events.OrderConfirmed
2346
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2347
+ * @slug order_confirmed
2348
+ */
2349
+ declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
2274
2350
  interface OrderInitiatedEnvelope {
2275
2351
  data: OrderInitiated;
2276
2352
  metadata: BaseEventMetadata;
2277
2353
  }
2354
+ /** @permissionScope Read Events - all read permissions
2355
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2356
+ * @permissionScope Manage Events - all permissions
2357
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2358
+ * @permissionScope Manage Events
2359
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2360
+ * @permissionScope Read Basic Events Order Info
2361
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2362
+ * @permissionScope Manage Orders
2363
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2364
+ * @permissionId WIX_EVENTS.READ_ORDERS
2365
+ * @webhook
2366
+ * @eventType wix.events.ticketing.events.OrderInitiated
2367
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2368
+ * @slug order_initiated
2369
+ */
2370
+ declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
2278
2371
  interface OrderReservationCreatedEnvelope {
2279
2372
  data: ReservationCreated;
2280
2373
  metadata: BaseEventMetadata;
2281
2374
  }
2375
+ /** @permissionScope Read Events - all read permissions
2376
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2377
+ * @permissionScope Manage Events - all permissions
2378
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2379
+ * @permissionScope Manage Events
2380
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2381
+ * @permissionScope Read Basic Events Order Info
2382
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2383
+ * @permissionScope Manage Orders
2384
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2385
+ * @permissionId WIX_EVENTS.READ_INVOICE
2386
+ * @webhook
2387
+ * @eventType wix.events.ticketing.events.ReservationCreated
2388
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2389
+ * @slug reservation_created
2390
+ */
2391
+ declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
2282
2392
  interface OrderReservationUpdatedEnvelope {
2283
2393
  data: ReservationUpdated;
2284
2394
  metadata: BaseEventMetadata;
2285
2395
  }
2396
+ /** @permissionScope Read Events - all read permissions
2397
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2398
+ * @permissionScope Manage Events - all permissions
2399
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2400
+ * @permissionScope Manage Events
2401
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2402
+ * @permissionScope Read Basic Events Order Info
2403
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2404
+ * @permissionScope Manage Orders
2405
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2406
+ * @permissionId WIX_EVENTS.READ_INVOICE
2407
+ * @webhook
2408
+ * @eventType wix.events.ticketing.events.ReservationUpdated
2409
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2410
+ * @slug reservation_updated
2411
+ */
2412
+ declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
2413
+ type OrderNonNullablePaths = `orderNumber` | `reservationId` | `snapshotId` | `eventId` | `contactId` | `memberId` | `firstName` | `lastName` | `email` | `checkoutForm.inputValues` | `checkoutForm.inputValues.${number}.inputName` | `checkoutForm.inputValues.${number}.value` | `confirmed` | `status` | `method` | `ticketsQuantity` | `totalPrice.amount` | `totalPrice.currency` | `ticketsPdf` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl` | `archived` | `anonymized` | `fullName` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
2414
+ /**
2415
+ * Retrieves a list of orders, including ticket data.
2416
+ * @public
2417
+ * @param options - An object representing the available options for retrieving a list of orders.
2418
+ * @permissionId WIX_EVENTS.READ_ORDERS
2419
+ * @applicableIdentity APP
2420
+ * @fqn wix.events.ticketing.OrderManagement.ListOrders
2421
+ */
2422
+ declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
2423
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2424
+ }[OrderNonNullablePaths]>>;
2286
2425
  interface ListOrdersOptions {
2287
2426
  /** Offset. */
2288
2427
  offset?: number;
@@ -2363,6 +2502,23 @@ interface ListOrdersOptions {
2363
2502
  */
2364
2503
  contactId?: string[];
2365
2504
  }
2505
+ /**
2506
+ * Retrieves an order, including ticket data.
2507
+ * <!--
2508
+ * >The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
2509
+ * -->
2510
+ * @public
2511
+ * @requiredField identifiers
2512
+ * @requiredField identifiers.eventId
2513
+ * @requiredField identifiers.orderNumber
2514
+ * @param options - An object representing the available options for getting an order.
2515
+ * @param identifiers - An object containing identifiers for the order to be retrieved.
2516
+ * @permissionId WIX_EVENTS.READ_ORDERS
2517
+ * @applicableIdentity APP
2518
+ * @returns Requested order.
2519
+ * @fqn wix.events.ticketing.OrderManagement.GetOrder
2520
+ */
2521
+ declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
2366
2522
  interface GetOrderIdentifiers {
2367
2523
  /**
2368
2524
  * Event ID to which the order belongs.
@@ -2388,6 +2544,23 @@ interface GetOrderOptions {
2388
2544
  */
2389
2545
  fieldset?: OrderFieldsetWithLiterals[];
2390
2546
  }
2547
+ /**
2548
+ * Updates an order.
2549
+ * @public
2550
+ * @requiredField identifiers
2551
+ * @requiredField identifiers.eventId
2552
+ * @requiredField identifiers.orderNumber
2553
+ * @param options - An object representing the available options for updating an order.
2554
+ * @param identifiers - An object containing identifiers for the order to be updated.
2555
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2556
+ * @applicableIdentity APP
2557
+ * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
2558
+ */
2559
+ declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
2560
+ [P in OrderNonNullablePaths]: `order.${P}`;
2561
+ }[OrderNonNullablePaths]> & {
2562
+ __applicationErrorsType?: UpdateOrderApplicationErrors;
2563
+ }>;
2391
2564
  interface UpdateOrderIdentifiers {
2392
2565
  /**
2393
2566
  * Event ID to which the order belongs.
@@ -2408,6 +2581,21 @@ interface UpdateOrderOptions {
2408
2581
  /** Whether to archive the order. */
2409
2582
  archived?: boolean;
2410
2583
  }
2584
+ /**
2585
+ * Archives multiple orders.
2586
+ * @public
2587
+ * @requiredField eventId
2588
+ * @param options - An object representing the available options for confirming an order.
2589
+ * @param eventId - Event ID to which the order belongs.
2590
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2591
+ * @applicableIdentity APP
2592
+ * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
2593
+ */
2594
+ declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
2595
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2596
+ }[OrderNonNullablePaths]> & {
2597
+ __applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
2598
+ }>;
2411
2599
  interface BulkUpdateOrdersOptions {
2412
2600
  /**
2413
2601
  * Unique order number.
@@ -2422,6 +2610,25 @@ interface BulkUpdateOrdersOptions {
2422
2610
  /** Whether to archive the order. */
2423
2611
  archived?: boolean;
2424
2612
  }
2613
+ /**
2614
+ * Confirms an order.
2615
+ *
2616
+ *
2617
+ * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
2618
+ * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
2619
+ * @public
2620
+ * @requiredField eventId
2621
+ * @param options - An object representing the available options for confirming an order.
2622
+ * @param eventId - Event ID to which the order belongs.
2623
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2624
+ * @applicableIdentity APP
2625
+ * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
2626
+ */
2627
+ declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
2628
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2629
+ }[OrderNonNullablePaths]> & {
2630
+ __applicationErrorsType?: ConfirmOrderApplicationErrors;
2631
+ }>;
2425
2632
  interface ConfirmOrderOptions {
2426
2633
  /**
2427
2634
  * Order numbers.
@@ -2431,6 +2638,18 @@ interface ConfirmOrderOptions {
2431
2638
  */
2432
2639
  orderNumber?: string[];
2433
2640
  }
2641
+ /**
2642
+ * Retrieves a summary of total ticket sales.
2643
+ * <!--
2644
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
2645
+ * -->
2646
+ * @public
2647
+ * @param options - An object representing the available options for retrieving a summary of total ticket sales.
2648
+ * @permissionId WIX_EVENTS.READ_ORDERS
2649
+ * @applicableIdentity APP
2650
+ * @fqn wix.events.ticketing.OrderManagement.GetSummary
2651
+ */
2652
+ declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
2434
2653
  interface GetSummaryOptions {
2435
2654
  /**
2436
2655
  * Event ID to which the order belongs.
@@ -2438,6 +2657,20 @@ interface GetSummaryOptions {
2438
2657
  */
2439
2658
  eventId?: string | null;
2440
2659
  }
2660
+ /**
2661
+ * Captures authorized payment asynchronously.
2662
+ * Eventually order will become paid.
2663
+ * For orders with non-authorized payments request will fail.
2664
+ * @param orderNumber - Order number.
2665
+ * @public
2666
+ * @requiredField orderNumber
2667
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2668
+ * @applicableIdentity APP
2669
+ * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
2670
+ */
2671
+ declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void & {
2672
+ __applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors;
2673
+ }>;
2441
2674
  interface CaptureAuthorizedPaymentOptions {
2442
2675
  /**
2443
2676
  * Event ID.
@@ -2445,6 +2678,20 @@ interface CaptureAuthorizedPaymentOptions {
2445
2678
  */
2446
2679
  eventId?: string;
2447
2680
  }
2681
+ /**
2682
+ * Voids authorized payment asynchronously.
2683
+ * Eventually order will become voided.
2684
+ * For orders with non-authorized payments request will fail.
2685
+ * @param orderNumber - Order number.
2686
+ * @public
2687
+ * @requiredField orderNumber
2688
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2689
+ * @applicableIdentity APP
2690
+ * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
2691
+ */
2692
+ declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void & {
2693
+ __applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors;
2694
+ }>;
2448
2695
  interface VoidAuthorizedPaymentOptions {
2449
2696
  /**
2450
2697
  * Event ID.
@@ -2452,9 +2699,31 @@ interface VoidAuthorizedPaymentOptions {
2452
2699
  */
2453
2700
  eventId?: string;
2454
2701
  }
2702
+ /**
2703
+ * Retrieves checkout details.
2704
+ * @public
2705
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2706
+ * @applicableIdentity APP
2707
+ * @applicableIdentity VISITOR
2708
+ * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
2709
+ */
2710
+ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
2711
+ /**
2712
+ * Returns tickets available to reserve.
2713
+ * <!--
2714
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
2715
+ * -->
2716
+ * @public
2717
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2718
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2719
+ * @applicableIdentity APP
2720
+ * @applicableIdentity VISITOR
2721
+ * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
2722
+ */
2723
+ 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`>>;
2455
2724
  interface ListAvailableTicketsOptions {
2456
2725
  /**
2457
- * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
2726
+ * Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
2458
2727
  * @format GUID
2459
2728
  */
2460
2729
  eventId?: string;
@@ -2473,6 +2742,19 @@ interface ListAvailableTicketsOptions {
2473
2742
  sort?: string;
2474
2743
  state?: StateWithLiterals[];
2475
2744
  }
2745
+ /**
2746
+ * Returns tickets available to reserve.
2747
+ * <!--
2748
+ * > Note: The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
2749
+ * -->
2750
+ * @public
2751
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2752
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2753
+ * @applicableIdentity APP
2754
+ * @applicableIdentity VISITOR
2755
+ * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
2756
+ */
2757
+ declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<NonNullablePaths<QueryAvailableTicketsResponse, `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`>>;
2476
2758
  interface QueryAvailableTicketsOptions {
2477
2759
  /** Offset. */
2478
2760
  offset?: number;
@@ -2495,6 +2777,22 @@ interface QueryAvailableTicketsOptions {
2495
2777
  */
2496
2778
  sort?: string;
2497
2779
  }
2780
+ /**
2781
+ * Reserves tickets for 20 minutes.
2782
+ *
2783
+ *
2784
+ * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
2785
+ * When the reservation expires, the tickets are added back to the stock.
2786
+ * @public
2787
+ * @requiredField eventId
2788
+ * @param options - An object representing the available options for creating a reservation.
2789
+ * @param eventId - Event ID to which the reservation belongs.
2790
+ * @permissionId WIX_EVENTS.CHECKOUT
2791
+ * @applicableIdentity APP
2792
+ * @applicableIdentity VISITOR
2793
+ * @fqn wix.events.ticketing.CheckoutService.CreateReservation
2794
+ */
2795
+ declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<NonNullablePaths<CreateReservationResponse, `_id` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `reservationStatus`>>;
2498
2796
  interface CreateReservationOptions {
2499
2797
  /**
2500
2798
  * Tickets to reserve.
@@ -2507,19 +2805,76 @@ interface CreateReservationOptions {
2507
2805
  /** Whether to allow reservations for hidden tickets. */
2508
2806
  allowHiddenTickets?: boolean;
2509
2807
  }
2808
+ /**
2809
+ * Cancels ticket reservation and returns tickets to stock.
2810
+ * <!--
2811
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
2812
+ * -->
2813
+ * @param _id - Reservation ID.
2814
+ * @public
2815
+ * @requiredField _id
2816
+ * @requiredField eventId
2817
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
2818
+ * @param eventId - Event ID to which the reservation belongs.
2819
+ * @permissionId WIX_EVENTS.CHECKOUT
2820
+ * @applicableIdentity APP
2821
+ * @applicableIdentity VISITOR
2822
+ * @fqn wix.events.ticketing.CheckoutService.CancelReservation
2823
+ */
2824
+ declare function cancelReservation(_id: string, eventId: string): Promise<void>;
2825
+ /**
2826
+ * Generates a preview of an invoice, including the given coupon or pricing plan.
2827
+ * @param reservationId - Reservation ID.
2828
+ * @public
2829
+ * @requiredField eventId
2830
+ * @requiredField reservationId
2831
+ * @param options - An object representing the available options for generating a preview of a reservation invoice.
2832
+ * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
2833
+ * @param eventId - Event ID to which the invoice belongs.
2834
+ * @permissionId WIX_EVENTS.READ_INVOICE
2835
+ * @applicableIdentity APP
2836
+ * @applicableIdentity VISITOR
2837
+ * @fqn wix.events.ticketing.CheckoutService.GetInvoice
2838
+ */
2839
+ declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<NonNullablePaths<GetInvoiceResponse, `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `discountErrors.error` | `discountErrors.error.${number}.code` | `reservationStatus` | `reservationOccupied` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
2510
2840
  interface GetInvoiceOptions {
2511
2841
  /** Optional discount to be applied on the returned invoice. */
2512
2842
  withDiscount?: DiscountRequest;
2513
2843
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
2514
2844
  paidPlanBenefit?: PaidPlanBenefit;
2515
2845
  }
2846
+ /**
2847
+ * Checkouts the reserved tickets.
2848
+ *
2849
+ *
2850
+ * Creates an order and associates it with a site visitor contact.
2851
+ * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
2852
+ *
2853
+ * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
2854
+ * To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
2855
+ * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
2856
+ *
2857
+ * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
2858
+ * @public
2859
+ * @requiredField eventId
2860
+ * @requiredField options.guests.form
2861
+ * @param options - An object representing the available options for checking out a reserved ticket.
2862
+ * @param eventId - Event ID to which the checkout belongs.
2863
+ * @permissionId WIX_EVENTS.CHECKOUT
2864
+ * @applicableIdentity APP
2865
+ * @applicableIdentity VISITOR
2866
+ * @fqn wix.events.ticketing.CheckoutService.Checkout
2867
+ */
2868
+ declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
2869
+ [P in OrderNonNullablePaths]: `order.${P}`;
2870
+ }[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
2516
2871
  interface CheckoutOptionsForRequest {
2517
2872
  /**
2518
2873
  * Ticket reservation ID.
2519
2874
  * @format GUID
2520
2875
  */
2521
2876
  reservationId?: string;
2522
- /** Member ID (if empty - no site member is associated to this order). */
2877
+ /** Member ID. If empty, no site member is associated with this order. */
2523
2878
  memberId?: string;
2524
2879
  /** Discount to apply on the invoice. */
2525
2880
  discount?: DiscountRequest;
@@ -2535,9 +2890,29 @@ interface CheckoutOptionsForRequest {
2535
2890
  paidPlanBenefit?: PaidPlanBenefit;
2536
2891
  /** Options controlling the checkout process. */
2537
2892
  options?: CheckoutOptions;
2538
- /** Whether marketing consent was given */
2893
+ /** Whether marketing consent was given. */
2539
2894
  marketingConsent?: boolean | null;
2540
2895
  }
2896
+ /**
2897
+ * Updates order and tickets.
2898
+ *
2899
+ *
2900
+ * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
2901
+ * @param orderNumber - Unique order number.
2902
+ * @public
2903
+ * @requiredField eventId
2904
+ * @requiredField orderNumber
2905
+ * @param options - An object representing the available options for updating an order and tickets.
2906
+ * @param identifiers - An object containing identifiers for the order and tickets to be updated.
2907
+ * @param eventId - Event ID to which the checkout belongs.
2908
+ * @permissionId WIX_EVENTS.CHECKOUT
2909
+ * @applicableIdentity APP
2910
+ * @applicableIdentity VISITOR
2911
+ * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
2912
+ */
2913
+ declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
2914
+ [P in OrderNonNullablePaths]: `order.${P}`;
2915
+ }[OrderNonNullablePaths]>>;
2541
2916
  interface UpdateCheckoutOptions {
2542
2917
  /** Buyer details. */
2543
2918
  buyer?: Buyer;
@@ -2550,7 +2925,7 @@ interface UpdateCheckoutOptions {
2550
2925
  /**
2551
2926
  * Member ID.
2552
2927
  *
2553
- * If empty, no site member is associated to this order.
2928
+ * If empty, no site member is associated with this order.
2554
2929
  */
2555
2930
  memberId?: string | null;
2556
2931
  /** Discount to apply on the invoice. */
@@ -2558,6 +2933,20 @@ interface UpdateCheckoutOptions {
2558
2933
  /** Benefit granted by the pricing plan. */
2559
2934
  paidPlanBenefit?: PaidPlanBenefit;
2560
2935
  }
2936
+ /**
2937
+ * Creates order with payment details already initiated via Cashier Pay API.
2938
+ * @public
2939
+ * @documentationMaturity preview
2940
+ * @requiredField eventId
2941
+ * @requiredField options.reservationId
2942
+ * @param eventId - Event ID to which the checkout belongs.
2943
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2944
+ * @applicableIdentity APP
2945
+ * @fqn wix.events.ticketing.CheckoutService.PosCheckout
2946
+ */
2947
+ declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
2948
+ [P in OrderNonNullablePaths]: `order.${P}`;
2949
+ }[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
2561
2950
  interface PosCheckoutOptions {
2562
2951
  /**
2563
2952
  * Ticket reservation ID.
@@ -2566,10 +2955,10 @@ interface PosCheckoutOptions {
2566
2955
  reservationId: string;
2567
2956
  /**
2568
2957
  * Payment details ID.
2569
- * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2958
+ * Not required if reservation total is 0. In this case the order will be created with status `FREE` and no payment.
2570
2959
  * @format GUID
2571
2960
  */
2572
2961
  paymentDetailsId?: string | null;
2573
2962
  }
2574
2963
 
2575
- export { TicketDefinitionFieldset as $, type OrderReservationCreatedEnvelope as A, type BulkUpdateOrdersOptions as B, type ConfirmOrderOptions as C, type OrderReservationUpdatedEnvelope as D, OrderStatus as E, ChannelType as F, type GetOrderIdentifiers as G, FeeName as H, FeeType as I, ScheduledActionEnumAction as J, Action as K, type ListOrdersOptions as L, OrderType as M, OrderFieldset as N, type Order as O, type PosCheckoutOptions as P, type QueryAvailableTicketsOptions as Q, OrderTag as R, SubdivisionType as S, TaxType as T, type UpdateOrderIdentifiers as U, type VoidAuthorizedPaymentOptions as V, WebhookIdentityType as W, ReservationStatus as X, State as Y, TicketSaleStatus as Z, Type as _, type ListOrdersResponse as a, type OrderPaid as a$, type FormResponse as a0, type InputValue as a1, type FormattedAddress as a2, type Address as a3, type AddressStreetOneOf as a4, type StreetAddress as a5, type AddressLocation as a6, type Subdivision as a7, type StandardDetails as a8, type Money as a9, type Counts as aA, type GetOrderRequest as aB, type GetOrderResponse as aC, type CalendarLinks as aD, type UpdateOrderRequest as aE, type OrderUpdated as aF, type BulkUpdateOrdersRequest as aG, type ConfirmOrderRequest as aH, type GetSummaryRequest as aI, type TicketSales as aJ, type GetInvoicePreviewRequest as aK, type RawHttpResponse as aL, type HeadersEntry as aM, type GetPaymentInfoRequest as aN, type GetPaymentInfoResponse as aO, type PaymentTransactionSummary as aP, type PaymentTransactionEvent as aQ, type CaptureAuthorizedPaymentRequest as aR, type CaptureAuthorizedPaymentResponse as aS, type VoidAuthorizedPaymentRequest as aT, type VoidAuthorizedPaymentResponse as aU, type FindOrderByReservationIdRequest as aV, type FindOrderByReservationIdResponse as aW, type MessageEnvelope as aX, type IdentificationData as aY, type IdentificationDataIdOneOf as aZ, type OrderConfirmed as a_, type TicketingTicket as aa, type CheckIn as ab, type GuestDetails as ac, type TicketDetails as ad, type Invoice as ae, type Item as af, type Discount as ag, type DiscountItem as ah, type DiscountItemDiscountOneOf as ai, type CouponDiscount as aj, type PaidPlanDiscount as ak, type PaidPlanDiscountDiscountOneOf as al, type PercentDiscount as am, type Tax as an, type Fee as ao, type PaymentDetails as ap, type PaymentTransaction as aq, type GiftCardPaymentDetails as ar, type BalanceSummary as as, type OrderDeleted as at, type Ticket as au, type OnlineConferencingLogin as av, type ListOrdersRequest as aw, type FacetCounts as ax, type OrderFacets as ay, type OrderFacetCounts as az, type GetOrderOptions as b, type ReservationCreated as b0, type TicketQuantity as b1, type ReservationCount as b2, type ReservationUpdated as b3, type GetCheckoutOptionsRequest as b4, type ListAvailableTicketsRequest as b5, type ResponseMetaData as b6, type TicketDefinition as b7, type Dashboard as b8, type WixFeeConfig as b9, type GetReservationRequest as bA, type GetReservationResponse as bB, type Reservation as bC, type ConfirmReservationRequest as bD, type ConfirmReservationResponse as bE, type ExpireReservationRequest as bF, type ExpireReservationResponse as bG, type QueryEventsWithPaidReservationsRequest as bH, type EventKey as bI, type QueryEventsWithPaidReservationsResponse as bJ, type BaseEventMetadata as bK, type TicketSalePeriod as ba, type TicketPricing as bb, type TicketPricingPriceOneOf as bc, type PricingOptions as bd, type PricingOption as be, type QueryAvailableTicketsRequest as bf, type CreateReservationRequest as bg, type TicketReservationQuantity as bh, type TicketReservation as bi, type CancelReservationRequest as bj, type CancelReservationResponse as bk, type GetInvoiceRequest as bl, type DiscountRequest as bm, type PaidPlanBenefit as bn, type DiscountErrors as bo, type Error as bp, type GiftCardErrors as bq, type GiftCardErrorsError as br, type CheckoutRequest as bs, type Buyer as bt, type Guest as bu, type CheckoutOptions as bv, type OrderInitiated as bw, type UpdateCheckoutRequest as bx, type OrderPageUrls as by, type PosCheckoutRequest as bz, type UpdateOrderOptions as c, type UpdateOrderResponse as d, type BulkUpdateOrdersResponse as e, type ConfirmOrderResponse as f, type GetSummaryOptions as g, type GetSummaryResponse as h, type CaptureAuthorizedPaymentOptions as i, type GetCheckoutOptionsResponse as j, type ListAvailableTicketsOptions as k, type ListAvailableTicketsResponse as l, type QueryAvailableTicketsResponse as m, type CreateReservationOptions as n, type CreateReservationResponse as o, type GetInvoiceOptions as p, type GetInvoiceResponse as q, type CheckoutOptionsForRequest as r, type CheckoutResponse as s, type UpdateCheckoutOptions as t, type UpdateCheckoutResponse as u, type PosCheckoutResponse as v, type OrderDeletedEnvelope as w, type OrderUpdatedEnvelope as x, type OrderConfirmedEnvelope as y, type OrderInitiatedEnvelope as z };
2964
+ export { Action, type ActionWithLiterals, type Address, type AddressLocation, type AddressStreetOneOf, type BalanceSummary, type BaseEventMetadata, type BulkUpdateOrdersApplicationErrors, type BulkUpdateOrdersOptions, type BulkUpdateOrdersRequest, type BulkUpdateOrdersResponse, type Buyer, type CalendarLinks, type CancelReservationRequest, type CancelReservationResponse, type CaptureAuthorizedPaymentApplicationErrors, type CaptureAuthorizedPaymentOptions, type CaptureAuthorizedPaymentRequest, type CaptureAuthorizedPaymentResponse, ChannelType, type ChannelTypeWithLiterals, type CheckIn, type CheckoutOptions, type CheckoutOptionsForRequest, type CheckoutRequest, type CheckoutResponse, type ConfirmOrderApplicationErrors, type ConfirmOrderOptions, type ConfirmOrderRequest, type ConfirmOrderResponse, type ConfirmReservationRequest, type ConfirmReservationResponse, type Counts, type CouponDiscount, type CreateReservationOptions, type CreateReservationRequest, type CreateReservationResponse, type Dashboard, type Discount, type DiscountErrors, type DiscountItem, type DiscountItemDiscountOneOf, type DiscountRequest, type Error, type EventKey, type ExpireReservationRequest, type ExpireReservationResponse, type FacetCounts, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type FindOrderByReservationIdRequest, type FindOrderByReservationIdResponse, type FormResponse, type FormattedAddress, type GetCheckoutOptionsRequest, type GetCheckoutOptionsResponse, type GetInvoiceOptions, type GetInvoicePreviewRequest, type GetInvoiceRequest, type GetInvoiceResponse, type GetOrderIdentifiers, type GetOrderOptions, type GetOrderRequest, type GetOrderResponse, type GetPaymentInfoRequest, type GetPaymentInfoResponse, type GetReservationRequest, type GetReservationResponse, type GetSummaryOptions, type GetSummaryRequest, type GetSummaryResponse, type GiftCardErrors, type GiftCardErrorsError, type GiftCardPaymentDetails, type Guest, type GuestDetails, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type Invoice, type Item, type ListAvailableTicketsOptions, type ListAvailableTicketsRequest, type ListAvailableTicketsResponse, type ListOrdersOptions, type ListOrdersRequest, type ListOrdersResponse, type MessageEnvelope, type Money, type OnlineConferencingLogin, type Order, type OrderConfirmed, type OrderConfirmedEnvelope, type OrderDeleted, type OrderDeletedEnvelope, type OrderFacetCounts, type OrderFacets, OrderFieldset, type OrderFieldsetWithLiterals, type OrderInitiated, type OrderInitiatedEnvelope, type OrderPageUrls, type OrderPaid, type OrderReservationCreatedEnvelope, type OrderReservationUpdatedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderTag, type OrderTagWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdated, type OrderUpdatedEnvelope, type PaidPlanBenefit, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type PaymentDetails, type PaymentTransaction, type PaymentTransactionEvent, type PaymentTransactionSummary, type PercentDiscount, type PosCheckoutOptions, type PosCheckoutRequest, type PosCheckoutResponse, type PricingOption, type PricingOptions, type QueryAvailableTicketsOptions, type QueryAvailableTicketsRequest, type QueryAvailableTicketsResponse, type QueryEventsWithPaidReservationsRequest, type QueryEventsWithPaidReservationsResponse, type RawHttpResponse, type Reservation, type ReservationCount, type ReservationCreated, ReservationStatus, type ReservationStatusWithLiterals, type ReservationUpdated, type ResponseMetaData, ScheduledActionEnumAction, type ScheduledActionEnumActionWithLiterals, type StandardDetails, State, type StateWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Tax, TaxType, type TaxTypeWithLiterals, type Ticket, type TicketDefinition, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, type TicketDetails, type TicketPricing, type TicketPricingPriceOneOf, type TicketQuantity, type TicketReservation, type TicketReservationQuantity, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, type TicketSales, type TicketingTicket, Type, type TypeWithLiterals, type UpdateCheckoutOptions, type UpdateCheckoutRequest, type UpdateCheckoutResponse, type UpdateOrderApplicationErrors, type UpdateOrderIdentifiers, type UpdateOrderOptions, type UpdateOrderRequest, type UpdateOrderResponse, type VoidAuthorizedPaymentApplicationErrors, type VoidAuthorizedPaymentOptions, type VoidAuthorizedPaymentRequest, type VoidAuthorizedPaymentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, onOrderConfirmed, onOrderDeleted, onOrderInitiated, onOrderReservationCreated, onOrderReservationUpdated, onOrderUpdated, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };