@wix/auto_sdk_events_orders 1.0.16 → 1.0.18

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 (133) hide show
  1. package/build/{internal/cjs/src/events-v1-order-orders.universal.d.ts → events-v1-order-orders.universal-C56YAmFe.d.mts} +393 -759
  2. package/build/{internal/es/src/events-v1-order-orders.universal.d.ts → events-v1-order-orders.universal-C56YAmFe.d.ts} +393 -759
  3. package/build/index.d.mts +234 -0
  4. package/build/index.d.ts +234 -0
  5. package/build/index.js +2769 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2706 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/events-v1-order-orders.universal.d.ts → internal/events-v1-order-orders.universal-C56YAmFe.d.mts} +393 -759
  10. package/build/{es/src/events-v1-order-orders.universal.d.ts → internal/events-v1-order-orders.universal-C56YAmFe.d.ts} +393 -759
  11. package/build/internal/index.d.mts +234 -0
  12. package/build/internal/index.d.ts +234 -0
  13. package/build/internal/index.js +2769 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2706 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +1372 -0
  18. package/build/internal/meta.d.ts +1372 -0
  19. package/build/internal/meta.js +1907 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1864 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +1372 -0
  24. package/build/meta.d.ts +1372 -0
  25. package/build/meta.js +1907 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1864 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/events-v1-order-orders.context.d.ts +0 -42
  40. package/build/cjs/src/events-v1-order-orders.context.js +0 -62
  41. package/build/cjs/src/events-v1-order-orders.context.js.map +0 -1
  42. package/build/cjs/src/events-v1-order-orders.http.d.ts +0 -97
  43. package/build/cjs/src/events-v1-order-orders.http.js +0 -1635
  44. package/build/cjs/src/events-v1-order-orders.http.js.map +0 -1
  45. package/build/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
  46. package/build/cjs/src/events-v1-order-orders.meta.js +0 -351
  47. package/build/cjs/src/events-v1-order-orders.meta.js.map +0 -1
  48. package/build/cjs/src/events-v1-order-orders.public.d.ts +0 -202
  49. package/build/cjs/src/events-v1-order-orders.public.js +0 -248
  50. package/build/cjs/src/events-v1-order-orders.public.js.map +0 -1
  51. package/build/cjs/src/events-v1-order-orders.types.d.ts +0 -2078
  52. package/build/cjs/src/events-v1-order-orders.types.js +0 -178
  53. package/build/cjs/src/events-v1-order-orders.types.js.map +0 -1
  54. package/build/cjs/src/events-v1-order-orders.universal.js +0 -1180
  55. package/build/cjs/src/events-v1-order-orders.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/src/events-v1-order-orders.context.d.ts +0 -42
  66. package/build/es/src/events-v1-order-orders.context.js +0 -42
  67. package/build/es/src/events-v1-order-orders.context.js.map +0 -1
  68. package/build/es/src/events-v1-order-orders.http.d.ts +0 -97
  69. package/build/es/src/events-v1-order-orders.http.js +0 -1615
  70. package/build/es/src/events-v1-order-orders.http.js.map +0 -1
  71. package/build/es/src/events-v1-order-orders.meta.d.ts +0 -49
  72. package/build/es/src/events-v1-order-orders.meta.js +0 -308
  73. package/build/es/src/events-v1-order-orders.meta.js.map +0 -1
  74. package/build/es/src/events-v1-order-orders.public.d.ts +0 -202
  75. package/build/es/src/events-v1-order-orders.public.js +0 -211
  76. package/build/es/src/events-v1-order-orders.public.js.map +0 -1
  77. package/build/es/src/events-v1-order-orders.types.d.ts +0 -2078
  78. package/build/es/src/events-v1-order-orders.types.js +0 -175
  79. package/build/es/src/events-v1-order-orders.types.js.map +0 -1
  80. package/build/es/src/events-v1-order-orders.universal.js +0 -1137
  81. package/build/es/src/events-v1-order-orders.universal.js.map +0 -1
  82. package/build/internal/cjs/index.d.ts +0 -1
  83. package/build/internal/cjs/index.js +0 -18
  84. package/build/internal/cjs/index.js.map +0 -1
  85. package/build/internal/cjs/index.typings.d.ts +0 -1
  86. package/build/internal/cjs/index.typings.js +0 -18
  87. package/build/internal/cjs/index.typings.js.map +0 -1
  88. package/build/internal/cjs/meta.d.ts +0 -1
  89. package/build/internal/cjs/meta.js +0 -18
  90. package/build/internal/cjs/meta.js.map +0 -1
  91. package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +0 -42
  92. package/build/internal/cjs/src/events-v1-order-orders.context.js +0 -62
  93. package/build/internal/cjs/src/events-v1-order-orders.context.js.map +0 -1
  94. package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +0 -97
  95. package/build/internal/cjs/src/events-v1-order-orders.http.js +0 -1635
  96. package/build/internal/cjs/src/events-v1-order-orders.http.js.map +0 -1
  97. package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
  98. package/build/internal/cjs/src/events-v1-order-orders.meta.js +0 -351
  99. package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +0 -1
  100. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +0 -202
  101. package/build/internal/cjs/src/events-v1-order-orders.public.js +0 -248
  102. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +0 -1
  103. package/build/internal/cjs/src/events-v1-order-orders.types.d.ts +0 -2078
  104. package/build/internal/cjs/src/events-v1-order-orders.types.js +0 -178
  105. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +0 -1
  106. package/build/internal/cjs/src/events-v1-order-orders.universal.js +0 -1180
  107. package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +0 -1
  108. package/build/internal/es/index.d.ts +0 -1
  109. package/build/internal/es/index.js +0 -2
  110. package/build/internal/es/index.js.map +0 -1
  111. package/build/internal/es/index.typings.d.ts +0 -1
  112. package/build/internal/es/index.typings.js +0 -2
  113. package/build/internal/es/index.typings.js.map +0 -1
  114. package/build/internal/es/meta.d.ts +0 -1
  115. package/build/internal/es/meta.js +0 -2
  116. package/build/internal/es/meta.js.map +0 -1
  117. package/build/internal/es/src/events-v1-order-orders.context.d.ts +0 -42
  118. package/build/internal/es/src/events-v1-order-orders.context.js +0 -42
  119. package/build/internal/es/src/events-v1-order-orders.context.js.map +0 -1
  120. package/build/internal/es/src/events-v1-order-orders.http.d.ts +0 -97
  121. package/build/internal/es/src/events-v1-order-orders.http.js +0 -1615
  122. package/build/internal/es/src/events-v1-order-orders.http.js.map +0 -1
  123. package/build/internal/es/src/events-v1-order-orders.meta.d.ts +0 -49
  124. package/build/internal/es/src/events-v1-order-orders.meta.js +0 -308
  125. package/build/internal/es/src/events-v1-order-orders.meta.js.map +0 -1
  126. package/build/internal/es/src/events-v1-order-orders.public.d.ts +0 -202
  127. package/build/internal/es/src/events-v1-order-orders.public.js +0 -211
  128. package/build/internal/es/src/events-v1-order-orders.public.js.map +0 -1
  129. package/build/internal/es/src/events-v1-order-orders.types.d.ts +0 -2078
  130. package/build/internal/es/src/events-v1-order-orders.types.js +0 -175
  131. package/build/internal/es/src/events-v1-order-orders.types.js.map +0 -1
  132. package/build/internal/es/src/events-v1-order-orders.universal.js +0 -1137
  133. package/build/internal/es/src/events-v1-order-orders.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface Order {
1
+ interface Order {
3
2
  /** Unique order number. */
4
3
  orderNumber?: string;
5
4
  /**
@@ -19,7 +18,7 @@ export interface Order {
19
18
  */
20
19
  eventId?: string;
21
20
  /**
22
- * Contact ID of buyer (resolved using email address).
21
+ * Contact ID of buyer, resolved using the email address provided. See the Contacts API for additional information.
23
22
  * @format GUID
24
23
  */
25
24
  contactId?: string;
@@ -29,7 +28,7 @@ export interface Order {
29
28
  */
30
29
  memberId?: string;
31
30
  /**
32
- * RSVP created timestamp.
31
+ * Date and time the RSVP was created.
33
32
  * @readonly
34
33
  */
35
34
  created?: Date | null;
@@ -44,7 +43,7 @@ export interface Order {
44
43
  email?: string;
45
44
  /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
46
45
  checkoutForm?: FormResponse;
47
- /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
46
+ /** Whether the order is confirmed. Triggered once the payment gateway processes the payment and funds reach the merchant's account. */
48
47
  confirmed?: boolean;
49
48
  /**
50
49
  * Order status. Possible values:
@@ -75,28 +74,28 @@ export interface Order {
75
74
  fullName?: string;
76
75
  /** Order invoice. */
77
76
  invoice?: Invoice;
78
- /** Whether all tickets in order are checked-in. */
77
+ /** Whether all tickets in an order are checked-in. */
79
78
  fullyCheckedIn?: boolean;
80
79
  /** Internal order payment details */
81
80
  paymentDetails?: PaymentDetails;
82
- /** Checkout channel type */
81
+ /** Checkout channel type. */
83
82
  channel?: ChannelTypeWithLiterals;
84
83
  /**
85
- * Order updated timestamp.
84
+ * Date and time the order was updated.
86
85
  * @readonly
87
86
  */
88
87
  updated?: Date | null;
89
- /** Whether marketing consent was given */
88
+ /** Whether marketing consent was given. */
90
89
  marketingConsent?: boolean | null;
91
90
  }
92
- export interface FormResponse {
91
+ interface FormResponse {
93
92
  /**
94
93
  * Input fields for a checkout form.
95
94
  * @maxSize 200
96
95
  */
97
96
  inputValues?: InputValue[];
98
97
  }
99
- export interface InputValue {
98
+ interface InputValue {
100
99
  /**
101
100
  * Input field name.
102
101
  * @maxLength 100
@@ -114,7 +113,7 @@ export interface InputValue {
114
113
  */
115
114
  values?: string[];
116
115
  }
117
- export interface FormattedAddress {
116
+ interface FormattedAddress {
118
117
  /**
119
118
  * One line address representation.
120
119
  * @maxLength 200
@@ -124,7 +123,7 @@ export interface FormattedAddress {
124
123
  address?: Address;
125
124
  }
126
125
  /** Physical address */
127
- export interface Address extends AddressStreetOneOf {
126
+ interface Address extends AddressStreetOneOf {
128
127
  /** Street name and number. */
129
128
  streetAddress?: StreetAddress;
130
129
  /** Main address line, usually street and number as free text. */
@@ -144,31 +143,31 @@ export interface Address extends AddressStreetOneOf {
144
143
  addressLine2?: string | null;
145
144
  }
146
145
  /** @oneof */
147
- export interface AddressStreetOneOf {
146
+ interface AddressStreetOneOf {
148
147
  /** Street name and number. */
149
148
  streetAddress?: StreetAddress;
150
149
  /** Main address line, usually street and number as free text. */
151
150
  addressLine?: string | null;
152
151
  }
153
- export interface StreetAddress {
152
+ interface StreetAddress {
154
153
  /** Street number. */
155
154
  number?: string;
156
155
  /** Street name. */
157
156
  name?: string;
158
157
  }
159
- export interface AddressLocation {
158
+ interface AddressLocation {
160
159
  /** Address latitude. */
161
160
  latitude?: number | null;
162
161
  /** Address longitude. */
163
162
  longitude?: number | null;
164
163
  }
165
- export interface Subdivision {
164
+ interface Subdivision {
166
165
  /** Short subdivision code. */
167
166
  code?: string;
168
167
  /** Subdivision full name. */
169
168
  name?: string;
170
169
  }
171
- export declare enum SubdivisionType {
170
+ declare enum SubdivisionType {
172
171
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
173
172
  /** State */
174
173
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -183,28 +182,26 @@ export declare enum SubdivisionType {
183
182
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
184
183
  COUNTRY = "COUNTRY"
185
184
  }
186
- /** @enumType */
187
- export 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';
188
185
  /** Subdivision Concordance values */
189
- export interface StandardDetails {
186
+ interface StandardDetails {
190
187
  /**
191
188
  * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
192
189
  * @maxLength 20
193
190
  */
194
191
  iso31662?: string | null;
195
192
  }
196
- export declare enum OrderStatus {
197
- /** Order status not available for this request fieldset. */
193
+ declare enum OrderStatus {
194
+ /** Order status is not available for this request fieldset. */
198
195
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
199
- /** Order is confirmed and payment isn't required. */
196
+ /** Order is confirmed, no payment is required. */
200
197
  FREE = "FREE",
201
- /** Order is paid for but the payment gateway has suspended the payment. */
198
+ /** Order was paid, but the payment gateway suspended the payment. */
202
199
  PENDING = "PENDING",
203
- /** Order is paid via a payment gateway. */
200
+ /** Order is paid. */
204
201
  PAID = "PAID",
205
- /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
202
+ /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
206
203
  OFFLINE_PENDING = "OFFLINE_PENDING",
207
- /** Order is awaiting payment at the cashier. */
204
+ /** Order is awaiting for payment at the cashier. */
208
205
  INITIATED = "INITIATED",
209
206
  /** Order is canceled. */
210
207
  CANCELED = "CANCELED",
@@ -218,8 +215,8 @@ export declare enum OrderStatus {
218
215
  PARTIALLY_PAID = "PARTIALLY_PAID"
219
216
  }
220
217
  /** @enumType */
221
- export type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
222
- export interface Money {
218
+ type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
219
+ interface Money {
223
220
  /**
224
221
  * *Deprecated:** Use `value` instead.
225
222
  * @format DECIMAL_VALUE
@@ -237,13 +234,13 @@ export interface Money {
237
234
  */
238
235
  value?: string | null;
239
236
  }
240
- export interface TicketingTicket {
237
+ interface TicketingTicket {
241
238
  /** Unique ticket number (issued automatically). */
242
239
  ticketNumber?: string;
243
240
  /** Associated order number. */
244
241
  orderNumber?: string;
245
242
  /**
246
- * Ticket definition ID.
243
+ * Ticket definition ID. See the Ticket Definition API for additional information.
247
244
  * @format GUID
248
245
  */
249
246
  ticketDefinitionId?: string;
@@ -259,7 +256,7 @@ export interface TicketingTicket {
259
256
  /** Event and ticket policies. */
260
257
  policy?: string;
261
258
  /**
262
- * Deprecated, use `check_in_url`.
259
+ * *Deprecated:** Use `tickets.checkInUrl` instead.
263
260
  * @deprecated
264
261
  */
265
262
  qrCode?: string;
@@ -267,7 +264,10 @@ export interface TicketingTicket {
267
264
  checkIn?: CheckIn;
268
265
  /** Associated order status. */
269
266
  orderStatus?: OrderStatusWithLiterals;
270
- /** Whether order and ticket are visible in order list. */
267
+ /**
268
+ * Whether the order and ticket are archived.
269
+ * If set to `true`, they are not visible in the order list.
270
+ */
271
271
  orderArchived?: boolean;
272
272
  /** Buyer full name. */
273
273
  orderFullName?: string;
@@ -278,7 +278,7 @@ export interface TicketingTicket {
278
278
  /** Whether ticket is visible in guest list. */
279
279
  archived?: boolean;
280
280
  /**
281
- * Deprecated, use `ticket_pdf_url`.
281
+ * *Deprecated:** Use `tickets.ticketPdfUrl` instead.
282
282
  * @deprecated
283
283
  */
284
284
  ticketPdf?: string;
@@ -301,7 +301,7 @@ export interface TicketingTicket {
301
301
  checkInUrl?: string;
302
302
  /** URL for ticket PDF download. */
303
303
  ticketPdfUrl?: string;
304
- /** Associated order checkout channel type */
304
+ /** Associated order checkout channel type. */
305
305
  channel?: ChannelTypeWithLiterals;
306
306
  /**
307
307
  * URL to download ticket in the `.pkpass` format for Apple Wallet
@@ -315,11 +315,11 @@ export interface TicketingTicket {
315
315
  */
316
316
  canceled?: boolean | null;
317
317
  }
318
- export interface CheckIn {
319
- /** Time of check-in */
318
+ interface CheckIn {
319
+ /** Time of check-in. */
320
320
  created?: Date | null;
321
321
  }
322
- export interface GuestDetails {
322
+ interface GuestDetails {
323
323
  /** Whether ticket belongs to assigned guest. */
324
324
  guestAssigned?: boolean;
325
325
  /** Guest first name. */
@@ -344,23 +344,23 @@ export interface GuestDetails {
344
344
  */
345
345
  phone?: string | null;
346
346
  }
347
- export declare enum ChannelType {
348
- /** Buyer created the order via an online channel such as a website or mobile app. */
347
+ declare enum ChannelType {
348
+ /** Buyer created the order via an online channel, such as a website or a mobile app. */
349
349
  ONLINE = "ONLINE",
350
350
  /** Sales person created the order and collected the money. */
351
351
  OFFLINE_POS = "OFFLINE_POS"
352
352
  }
353
353
  /** @enumType */
354
- export type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
355
- export interface TicketDetails {
354
+ type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
355
+ interface TicketDetails {
356
356
  /**
357
- * Unique seat id in the event venue.
357
+ * Unique seat ID in the event venue.
358
358
  * @minLength 1
359
359
  * @maxLength 36
360
360
  */
361
361
  seatId?: string | null;
362
362
  /**
363
- * Optional sector label.
363
+ * Section label.
364
364
  * @readonly
365
365
  */
366
366
  sectionLabel?: string | null;
@@ -385,18 +385,20 @@ export interface TicketDetails {
385
385
  */
386
386
  seatLabel?: string | null;
387
387
  /**
388
- * Number of places in the spot. If not provided - defaults to 1.
388
+ * Number of places in the spot.
389
+ *
390
+ * Default: `1`.
389
391
  * @min 1
390
392
  * @max 50
391
393
  */
392
394
  capacity?: number | null;
393
395
  /**
394
- * Custom pricing of ticket.
396
+ * Custom price of a ticket.
395
397
  * @format DECIMAL_VALUE
396
398
  */
397
399
  priceOverride?: string | null;
398
400
  /**
399
- * Pricing option id.
401
+ * Pricing option ID.
400
402
  * @format GUID
401
403
  */
402
404
  pricingOptionId?: string | null;
@@ -406,7 +408,7 @@ export interface TicketDetails {
406
408
  */
407
409
  pricingOptionName?: string | null;
408
410
  }
409
- export interface Invoice {
411
+ interface Invoice {
410
412
  /** Items listed in the invoice. */
411
413
  items?: Item[];
412
414
  /**
@@ -416,12 +418,12 @@ export interface Invoice {
416
418
  total?: Money;
417
419
  /** Discount applied to a cart. */
418
420
  discount?: Discount;
419
- /** Tax applied to cart. */
421
+ /** Tax applied to a cart. */
420
422
  tax?: Tax;
421
423
  /** Total cart amount before discount, tax, and fees. */
422
424
  subTotal?: Money;
423
425
  /**
424
- * Total amount of cart after discount, tax, and fees.
426
+ * Total amount of a cart after discount, tax, and fees.
425
427
  * Grand total is calculated in the following order:
426
428
  * 1. Total prices of all items in the cart are calculated.
427
429
  * 2. Discount is subtracted from the cart (if applicable).
@@ -439,7 +441,7 @@ export interface Invoice {
439
441
  /** Invoice preview URL. This value is only returned when the order is paid. */
440
442
  previewUrl?: string | null;
441
443
  }
442
- export interface Item {
444
+ interface Item {
443
445
  /**
444
446
  * Unique line item ID.
445
447
  * @format GUID
@@ -467,7 +469,7 @@ export interface Item {
467
469
  */
468
470
  fees?: Fee[];
469
471
  }
470
- export interface Discount {
472
+ interface Discount {
471
473
  /** Total discount amount. */
472
474
  amount?: Money;
473
475
  /** Total sum after the discount. */
@@ -490,7 +492,7 @@ export interface Discount {
490
492
  /** Discount items. */
491
493
  discounts?: DiscountItem[];
492
494
  }
493
- export interface DiscountItem extends DiscountItemDiscountOneOf {
495
+ interface DiscountItem extends DiscountItemDiscountOneOf {
494
496
  /** Coupon discount. */
495
497
  coupon?: CouponDiscount;
496
498
  /** Pricing plan discount. */
@@ -499,32 +501,32 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
499
501
  amount?: Money;
500
502
  }
501
503
  /** @oneof */
502
- export interface DiscountItemDiscountOneOf {
504
+ interface DiscountItemDiscountOneOf {
503
505
  /** Coupon discount. */
504
506
  coupon?: CouponDiscount;
505
507
  /** Pricing plan discount. */
506
508
  paidPlan?: PaidPlanDiscount;
507
509
  }
508
- export interface CouponDiscount {
509
- /** Discount coupon name. */
510
+ interface CouponDiscount {
511
+ /** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
510
512
  name?: string;
511
- /** Discount coupon code. */
513
+ /** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
512
514
  code?: string;
513
- /** Discount coupon ID. */
515
+ /** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
514
516
  couponId?: string;
515
517
  }
516
- export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
518
+ interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
517
519
  /** Discount by percentage applied to tickets. */
518
520
  percentDiscount?: PercentDiscount;
519
521
  /** Name of pricing plan. */
520
522
  name?: string;
521
523
  }
522
524
  /** @oneof */
523
- export interface PaidPlanDiscountDiscountOneOf {
525
+ interface PaidPlanDiscountDiscountOneOf {
524
526
  /** Discount by percentage applied to tickets. */
525
527
  percentDiscount?: PercentDiscount;
526
528
  }
527
- export interface PercentDiscount {
529
+ interface PercentDiscount {
528
530
  /**
529
531
  * Percent rate.
530
532
  * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
@@ -533,7 +535,7 @@ export interface PercentDiscount {
533
535
  /** Number of discounted tickets. */
534
536
  quantityDiscounted?: number;
535
537
  }
536
- export interface Tax {
538
+ interface Tax {
537
539
  /** Tax type. */
538
540
  type?: TaxTypeWithLiterals;
539
541
  /**
@@ -551,7 +553,7 @@ export interface Tax {
551
553
  /** Total tax amount. */
552
554
  amount?: Money;
553
555
  }
554
- export declare enum TaxType {
556
+ declare enum TaxType {
555
557
  /** Tax is included in the ticket price. */
556
558
  INCLUDED = "INCLUDED",
557
559
  /** Tax is added to the order at the checkout. */
@@ -560,8 +562,8 @@ export declare enum TaxType {
560
562
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
561
563
  }
562
564
  /** @enumType */
563
- export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
564
- export interface Fee {
565
+ type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
566
+ interface Fee {
565
567
  /** Fee identifier. */
566
568
  name?: FeeNameWithLiterals;
567
569
  /** How fee is calculated. */
@@ -575,29 +577,29 @@ export interface Fee {
575
577
  /** Total amount of fee charges. */
576
578
  amount?: Money;
577
579
  }
578
- export declare enum FeeName {
580
+ declare enum FeeName {
579
581
  /** Wix ticket service fee charges applied to the line item. */
580
582
  WIX_FEE = "WIX_FEE"
581
583
  }
582
584
  /** @enumType */
583
- export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
584
- export declare enum FeeType {
585
+ type FeeNameWithLiterals = FeeName | 'WIX_FEE';
586
+ declare enum FeeType {
585
587
  /** Fee is added to the ticket price at checkout. */
586
588
  FEE_ADDED = "FEE_ADDED",
587
- /** Seller absorbs the fee. It is deducted from the ticket price. */
589
+ /** Seller absorbs the fee. It's deducted from the ticket price. */
588
590
  FEE_INCLUDED = "FEE_INCLUDED",
589
591
  /** Fee is added to the ticket price at checkout. */
590
592
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
591
593
  }
592
594
  /** @enumType */
593
- export type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
594
- export interface PaymentDetails {
595
+ type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
596
+ interface PaymentDetails {
595
597
  /** Wix Payments transaction */
596
598
  transaction?: PaymentTransaction;
597
599
  }
598
- export interface PaymentTransaction {
600
+ interface PaymentTransaction {
599
601
  /**
600
- * Wix Payments transaction id
602
+ * Wix Payments transaction ID.
601
603
  * @format GUID
602
604
  * @readonly
603
605
  */
@@ -608,7 +610,7 @@ export interface PaymentTransaction {
608
610
  */
609
611
  method?: string;
610
612
  }
611
- export declare enum ScheduledActionEnumAction {
613
+ declare enum ScheduledActionEnumAction {
612
614
  /** Action not scheduled. */
613
615
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
614
616
  /** Captured after the delay. */
@@ -616,9 +618,7 @@ export declare enum ScheduledActionEnumAction {
616
618
  /** Void after the delay. */
617
619
  VOID = "VOID"
618
620
  }
619
- /** @enumType */
620
- export type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
621
- export declare enum Action {
621
+ declare enum Action {
622
622
  /** Order can be archived. */
623
623
  ARCHIVE = "ARCHIVE",
624
624
  /** Order can be unarchived. */
@@ -630,9 +630,7 @@ export declare enum Action {
630
630
  /** Order can be voided. */
631
631
  VOID = "VOID"
632
632
  }
633
- /** @enumType */
634
- export type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
635
- export interface GiftCardPaymentDetails {
633
+ interface GiftCardPaymentDetails {
636
634
  /**
637
635
  * Gift card payment id.
638
636
  * @format GUID
@@ -653,12 +651,13 @@ export interface GiftCardPaymentDetails {
653
651
  */
654
652
  obfuscatedCode?: string | null;
655
653
  }
656
- export interface BalanceSummary {
654
+ interface BalanceSummary {
657
655
  /** Amount left to pay. */
658
656
  balance?: Money;
659
657
  }
660
- export interface OrderDeleted {
661
- /** Order deleted timestamp in ISO UTC format. */
658
+ /** Triggered when an order is deleted. */
659
+ interface OrderDeleted {
660
+ /** Date and time the order was deleted. */
662
661
  timestamp?: Date | null;
663
662
  /**
664
663
  * Event ID to which the order belongs.
@@ -667,41 +666,41 @@ export interface OrderDeleted {
667
666
  eventId?: string;
668
667
  /** Unique order number. */
669
668
  orderNumber?: string;
670
- /** Contact ID associated with this order */
669
+ /** Contact ID associated with the order. */
671
670
  contactId?: string;
672
671
  /**
673
- * Member ID associated with this order.
672
+ * Member ID associated with the order.
674
673
  * @format GUID
675
674
  */
676
675
  memberId?: string | null;
677
676
  /**
678
- * Order created timestamp.
677
+ * Date and time the order was created.
679
678
  * @readonly
680
679
  */
681
680
  created?: Date | null;
682
681
  /**
683
- * Order updated timestamp.
682
+ * Date and time the order was updated.
684
683
  * @readonly
685
684
  */
686
685
  updated?: Date | null;
687
- /** Whether order was anonymized by GDPR delete. */
686
+ /** Whether the order was anonymized by GDPR delete. */
688
687
  anonymized?: boolean;
689
688
  /** Order type. */
690
689
  orderType?: OrderTypeWithLiterals;
691
- /** Whether event was triggered by GDPR delete request. */
690
+ /** Whether the event was triggered by GDPR delete request. */
692
691
  triggeredByAnonymizeRequest?: boolean;
693
692
  /** Tickets generated after payment. */
694
693
  tickets?: Ticket[];
695
694
  }
696
- export declare enum OrderType {
695
+ declare enum OrderType {
697
696
  /** Buyer form is used for all tickets. */
698
697
  UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
699
698
  /** Each order ticket has its own form. */
700
699
  ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
701
700
  }
702
701
  /** @enumType */
703
- export type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
704
- export interface Ticket {
702
+ type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
703
+ interface Ticket {
705
704
  /** Unique issued ticket number. */
706
705
  ticketNumber?: string;
707
706
  /**
@@ -749,7 +748,7 @@ export interface Ticket {
749
748
  /** Whether ticket is canceled. */
750
749
  canceled?: boolean | null;
751
750
  }
752
- export interface OnlineConferencingLogin {
751
+ interface OnlineConferencingLogin {
753
752
  /**
754
753
  * Link URL to the online conference.
755
754
  * @format WEB_URL
@@ -762,7 +761,7 @@ export interface OnlineConferencingLogin {
762
761
  */
763
762
  password?: string | null;
764
763
  }
765
- export interface ListOrdersRequest {
764
+ interface ListOrdersRequest {
766
765
  /** Offset. */
767
766
  offset?: number;
768
767
  /**
@@ -843,19 +842,23 @@ export interface ListOrdersRequest {
843
842
  */
844
843
  contactId?: string[];
845
844
  }
846
- export declare enum OrderFieldset {
847
- /** Include tickets in response. */
845
+ declare enum OrderFieldset {
846
+ /** Returns `tickets`. */
848
847
  TICKETS = "TICKETS",
849
- /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
848
+ /**
849
+ * Returns `archived`, `confirmed`, `created`, `firstName`, `fullName`,
850
+ * `lastName`, `method`, `reservationId`, `snapshotId`,
851
+ * `status`, `ticketsPdf`, `ticketsQuantity`, `totalPrice`.
852
+ */
850
853
  DETAILS = "DETAILS",
851
- /** Include `checkoutForm` in the response. */
854
+ /** Returns `checkoutForm`. */
852
855
  FORM = "FORM",
853
- /** Include `invoice` in the response. */
856
+ /** Returns `invoice`. */
854
857
  INVOICE = "INVOICE"
855
858
  }
856
859
  /** @enumType */
857
- export type OrderFieldsetWithLiterals = OrderFieldset | 'TICKETS' | 'DETAILS' | 'FORM' | 'INVOICE';
858
- export declare enum OrderTag {
860
+ type OrderFieldsetWithLiterals = OrderFieldset | 'TICKETS' | 'DETAILS' | 'FORM' | 'INVOICE';
861
+ declare enum OrderTag {
859
862
  /** Return only confirmed orders. */
860
863
  CONFIRMED = "CONFIRMED",
861
864
  /** Return only unconfirmed orders. */
@@ -872,8 +875,8 @@ export declare enum OrderTag {
872
875
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
873
876
  }
874
877
  /** @enumType */
875
- export type OrderTagWithLiterals = OrderTag | 'CONFIRMED' | 'UNCONFIRMED' | 'MEMBER' | 'ARCHIVED' | 'NON_ARCHIVED' | 'FULLY_CHECKED_IN' | 'NOT_FULLY_CHECKED_IN';
876
- export interface ListOrdersResponse {
878
+ type OrderTagWithLiterals = OrderTag | 'CONFIRMED' | 'UNCONFIRMED' | 'MEMBER' | 'ARCHIVED' | 'NON_ARCHIVED' | 'FULLY_CHECKED_IN' | 'NOT_FULLY_CHECKED_IN';
879
+ interface ListOrdersResponse {
877
880
  /** Total orders matching the given filters. */
878
881
  total?: number;
879
882
  /** Offset. */
@@ -890,19 +893,19 @@ export interface ListOrdersResponse {
890
893
  /** Order data enriched facets. */
891
894
  orderFacets?: OrderFacets;
892
895
  }
893
- export interface FacetCounts {
896
+ interface FacetCounts {
894
897
  /** Facet counts aggregated per value. */
895
898
  counts?: Record<string, number>;
896
899
  }
897
- export interface OrderFacets {
900
+ interface OrderFacets {
898
901
  /** Filter facets. */
899
902
  facets?: Record<string, OrderFacetCounts>;
900
903
  }
901
- export interface OrderFacetCounts {
904
+ interface OrderFacetCounts {
902
905
  /** Facet counts aggregated per value */
903
906
  counts?: Record<string, Counts>;
904
907
  }
905
- export interface Counts {
908
+ interface Counts {
906
909
  /** Number or orders */
907
910
  count?: number;
908
911
  /** Number of tickets within orders */
@@ -910,7 +913,7 @@ export interface Counts {
910
913
  /** Number of tickets with check-in */
911
914
  ticketsCheckIn?: number;
912
915
  }
913
- export interface GetOrderRequest {
916
+ interface GetOrderRequest {
914
917
  /**
915
918
  * Event ID to which the order belongs.
916
919
  * @format GUID
@@ -934,19 +937,19 @@ export interface GetOrderRequest {
934
937
  */
935
938
  fieldset?: OrderFieldsetWithLiterals[];
936
939
  }
937
- export interface GetOrderResponse {
940
+ interface GetOrderResponse {
938
941
  /** Requested order. */
939
942
  order?: Order;
940
943
  /** "Add to calendar" links. */
941
944
  calendarLinks?: CalendarLinks;
942
945
  }
943
- export interface CalendarLinks {
946
+ interface CalendarLinks {
944
947
  /** "Add to Google calendar" URL. */
945
948
  google?: string;
946
949
  /** "Download ICS calendar file" URL. */
947
950
  ics?: string;
948
951
  }
949
- export interface UpdateOrderRequest {
952
+ interface UpdateOrderRequest {
950
953
  /**
951
954
  * Event ID to which the order belongs.
952
955
  * @format GUID
@@ -961,23 +964,24 @@ export interface UpdateOrderRequest {
961
964
  fields?: string[];
962
965
  /** Checkout form. */
963
966
  checkoutForm?: FormResponse;
964
- /** Whether order is archived. */
967
+ /** Whether to archive the order. */
965
968
  archived?: boolean;
966
969
  }
967
- export interface UpdateOrderResponse {
970
+ interface UpdateOrderResponse {
968
971
  /** Updated order. */
969
972
  order?: Order;
970
973
  }
971
- export interface OrderUpdated {
972
- /** Order updated timestamp in ISO UTC format. */
974
+ /** Triggered when an order is updated. */
975
+ interface OrderUpdated {
976
+ /** Date and time the order was updated. */
973
977
  timestamp?: Date | null;
974
978
  /**
975
- * Site language when Order initiated
979
+ * Site language when the order was initiated.
976
980
  * @format LANGUAGE
977
981
  */
978
982
  language?: string | null;
979
983
  /**
980
- * Locale in which Order was created.
984
+ * Locale in which the order was created.
981
985
  * @format LANGUAGE_TAG
982
986
  */
983
987
  locale?: string | null;
@@ -988,20 +992,20 @@ export interface OrderUpdated {
988
992
  eventId?: string;
989
993
  /** Unique order number. */
990
994
  orderNumber?: string;
991
- /** Contact ID associated with this order. */
995
+ /** Contact ID associated with the order. */
992
996
  contactId?: string;
993
997
  /**
994
- * Member ID associated with this order.
998
+ * Member ID associated with the order.
995
999
  * @format GUID
996
1000
  */
997
1001
  memberId?: string | null;
998
1002
  /**
999
- * Order created timestamp.
1003
+ * Date and time the order was created.
1000
1004
  * @readonly
1001
1005
  */
1002
1006
  created?: Date | null;
1003
1007
  /**
1004
- * Order updated timestamp.
1008
+ * Date and time the order was updated.
1005
1009
  * @readonly
1006
1010
  */
1007
1011
  updated?: Date | null;
@@ -1035,13 +1039,14 @@ export interface OrderUpdated {
1035
1039
  /** Whether event was triggered by GDPR delete request. */
1036
1040
  triggeredByAnonymizeRequest?: boolean;
1037
1041
  }
1038
- export interface BulkUpdateOrdersRequest {
1042
+ interface BulkUpdateOrdersRequest {
1039
1043
  /**
1040
1044
  * Event ID to which the order belongs.
1041
1045
  * @format GUID
1042
1046
  */
1043
1047
  eventId: string;
1044
1048
  /**
1049
+ * Unique order number.
1045
1050
  * @minLength 1
1046
1051
  * @maxLength 36
1047
1052
  * @minSize 1
@@ -1053,11 +1058,11 @@ export interface BulkUpdateOrdersRequest {
1053
1058
  /** Whether to archive the order. */
1054
1059
  archived?: boolean;
1055
1060
  }
1056
- export interface BulkUpdateOrdersResponse {
1061
+ interface BulkUpdateOrdersResponse {
1057
1062
  /** Updated orders. */
1058
1063
  orders?: Order[];
1059
1064
  }
1060
- export interface ConfirmOrderRequest {
1065
+ interface ConfirmOrderRequest {
1061
1066
  /**
1062
1067
  * Event ID to which the order belongs.
1063
1068
  * @format GUID
@@ -1071,22 +1076,22 @@ export interface ConfirmOrderRequest {
1071
1076
  */
1072
1077
  orderNumber?: string[];
1073
1078
  }
1074
- export interface ConfirmOrderResponse {
1079
+ interface ConfirmOrderResponse {
1075
1080
  /** Confirmed orders. */
1076
1081
  orders?: Order[];
1077
1082
  }
1078
- export interface GetSummaryRequest {
1083
+ interface GetSummaryRequest {
1079
1084
  /**
1080
- * Event ID.
1085
+ * Event ID to which the order belongs.
1081
1086
  * @format GUID
1082
1087
  */
1083
1088
  eventId?: string | null;
1084
1089
  }
1085
- export interface GetSummaryResponse {
1090
+ interface GetSummaryResponse {
1086
1091
  /** Ticket sales grouped by currency. */
1087
1092
  sales?: TicketSales[];
1088
1093
  }
1089
- export interface TicketSales {
1094
+ interface TicketSales {
1090
1095
  /** Total balance of confirmed transactions. */
1091
1096
  total?: Money;
1092
1097
  /** Total number of confirmed orders. */
@@ -1096,7 +1101,7 @@ export interface TicketSales {
1096
1101
  /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
1097
1102
  revenue?: Money;
1098
1103
  }
1099
- export interface GetInvoicePreviewRequest {
1104
+ interface GetInvoicePreviewRequest {
1100
1105
  /**
1101
1106
  * Event ID to which the invoice belongs.
1102
1107
  * @format GUID
@@ -1105,16 +1110,16 @@ export interface GetInvoicePreviewRequest {
1105
1110
  /** Order number. */
1106
1111
  orderNumber?: string;
1107
1112
  }
1108
- export interface RawHttpResponse {
1113
+ interface RawHttpResponse {
1109
1114
  body?: Uint8Array;
1110
1115
  statusCode?: number | null;
1111
1116
  headers?: HeadersEntry[];
1112
1117
  }
1113
- export interface HeadersEntry {
1118
+ interface HeadersEntry {
1114
1119
  key?: string;
1115
1120
  value?: string;
1116
1121
  }
1117
- export interface GetPaymentInfoRequest {
1122
+ interface GetPaymentInfoRequest {
1118
1123
  /**
1119
1124
  * Event ID.
1120
1125
  * @format GUID
@@ -1123,7 +1128,7 @@ export interface GetPaymentInfoRequest {
1123
1128
  /** Order number. */
1124
1129
  orderNumber?: string;
1125
1130
  }
1126
- export interface GetPaymentInfoResponse {
1131
+ interface GetPaymentInfoResponse {
1127
1132
  transactions?: PaymentTransactionSummary[];
1128
1133
  status?: string | null;
1129
1134
  /**
@@ -1132,24 +1137,24 @@ export interface GetPaymentInfoResponse {
1132
1137
  */
1133
1138
  transactionId?: string | null;
1134
1139
  }
1135
- export interface PaymentTransactionSummary {
1140
+ interface PaymentTransactionSummary {
1136
1141
  /**
1137
- * Wix Payments transaction id
1142
+ * Wix Payments transaction ID.
1138
1143
  * @format GUID
1139
1144
  * @readonly
1140
1145
  */
1141
1146
  transactionId?: string;
1142
1147
  /**
1143
- * Final transaction status
1148
+ * Final transaction status.
1144
1149
  * @readonly
1145
1150
  */
1146
1151
  finalTransactionStatus?: string;
1147
- /** Transaction events */
1152
+ /** Transaction events. */
1148
1153
  events?: PaymentTransactionEvent[];
1149
1154
  }
1150
- export interface PaymentTransactionEvent {
1155
+ interface PaymentTransactionEvent {
1151
1156
  /**
1152
- * Order snapshot id
1157
+ * Order snapshot ID.
1153
1158
  * @format GUID
1154
1159
  * @readonly
1155
1160
  */
@@ -1185,7 +1190,7 @@ export interface PaymentTransactionEvent {
1185
1190
  */
1186
1191
  refundedAmount?: Money;
1187
1192
  }
1188
- export interface CaptureAuthorizedPaymentRequest {
1193
+ interface CaptureAuthorizedPaymentRequest {
1189
1194
  /**
1190
1195
  * Event ID.
1191
1196
  * @format GUID
@@ -1198,9 +1203,9 @@ export interface CaptureAuthorizedPaymentRequest {
1198
1203
  */
1199
1204
  orderNumber: string;
1200
1205
  }
1201
- export interface CaptureAuthorizedPaymentResponse {
1206
+ interface CaptureAuthorizedPaymentResponse {
1202
1207
  }
1203
- export interface VoidAuthorizedPaymentRequest {
1208
+ interface VoidAuthorizedPaymentRequest {
1204
1209
  /**
1205
1210
  * Event ID.
1206
1211
  * @format GUID
@@ -1213,9 +1218,25 @@ export interface VoidAuthorizedPaymentRequest {
1213
1218
  */
1214
1219
  orderNumber: string;
1215
1220
  }
1216
- export interface VoidAuthorizedPaymentResponse {
1221
+ interface VoidAuthorizedPaymentResponse {
1222
+ }
1223
+ interface FindOrderByReservationIdRequest {
1224
+ /**
1225
+ * Event ID
1226
+ * @format GUID
1227
+ */
1228
+ eventId?: string;
1229
+ /**
1230
+ * Reservation ID.
1231
+ * @format GUID
1232
+ */
1233
+ reservationId?: string;
1234
+ }
1235
+ interface FindOrderByReservationIdResponse {
1236
+ /** Order. */
1237
+ order?: Order;
1217
1238
  }
1218
- export interface MessageEnvelope {
1239
+ interface MessageEnvelope {
1219
1240
  /**
1220
1241
  * App instance ID.
1221
1242
  * @format GUID
@@ -1231,7 +1252,7 @@ export interface MessageEnvelope {
1231
1252
  /** Stringify payload. */
1232
1253
  data?: string;
1233
1254
  }
1234
- export interface IdentificationData extends IdentificationDataIdOneOf {
1255
+ interface IdentificationData extends IdentificationDataIdOneOf {
1235
1256
  /**
1236
1257
  * ID of a site visitor that has not logged in to the site.
1237
1258
  * @format GUID
@@ -1256,7 +1277,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1256
1277
  identityType?: WebhookIdentityTypeWithLiterals;
1257
1278
  }
1258
1279
  /** @oneof */
1259
- export interface IdentificationDataIdOneOf {
1280
+ interface IdentificationDataIdOneOf {
1260
1281
  /**
1261
1282
  * ID of a site visitor that has not logged in to the site.
1262
1283
  * @format GUID
@@ -1278,7 +1299,7 @@ export interface IdentificationDataIdOneOf {
1278
1299
  */
1279
1300
  appId?: string;
1280
1301
  }
1281
- export declare enum WebhookIdentityType {
1302
+ declare enum WebhookIdentityType {
1282
1303
  UNKNOWN = "UNKNOWN",
1283
1304
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1284
1305
  MEMBER = "MEMBER",
@@ -1286,19 +1307,20 @@ export declare enum WebhookIdentityType {
1286
1307
  APP = "APP"
1287
1308
  }
1288
1309
  /** @enumType */
1289
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1290
- export interface OrderConfirmed {
1291
- /** Order confirmation timestamp in ISO UTC. */
1310
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1311
+ /** Triggered when an order is confirmed. */
1312
+ interface OrderConfirmed {
1313
+ /** Date and time the order was confirmed. */
1292
1314
  timestamp?: Date | null;
1293
1315
  /**
1294
- * Site language when Order initiated
1316
+ * Site language when the order was initiated.
1295
1317
  * @format LANGUAGE
1296
1318
  */
1297
1319
  language?: string | null;
1298
1320
  /** Notifications silenced for this domain event. */
1299
1321
  silent?: boolean | null;
1300
1322
  /**
1301
- * Locale in which Order was created.
1323
+ * Locale in which the order was created.
1302
1324
  * @format LANGUAGE_TAG
1303
1325
  */
1304
1326
  locale?: string | null;
@@ -1309,15 +1331,15 @@ export interface OrderConfirmed {
1309
1331
  eventId?: string;
1310
1332
  /** Unique order number. */
1311
1333
  orderNumber?: string;
1312
- /** Contact ID associated with this order. */
1334
+ /** Contact ID associated with the order. */
1313
1335
  contactId?: string;
1314
1336
  /**
1315
- * Member ID associated with this order.
1337
+ * Member ID associated with the order.
1316
1338
  * @format GUID
1317
1339
  */
1318
1340
  memberId?: string | null;
1319
1341
  /**
1320
- * Order created timestamp
1342
+ * Date and time the order was created.
1321
1343
  * @readonly
1322
1344
  */
1323
1345
  created?: Date | null;
@@ -1346,21 +1368,22 @@ export interface OrderConfirmed {
1346
1368
  tickets?: Ticket[];
1347
1369
  /** Invoice. */
1348
1370
  invoice?: Invoice;
1349
- /** Reservation ID associated with this order. */
1371
+ /** Reservation ID associated with the order. */
1350
1372
  reservationId?: string;
1351
1373
  }
1352
- export interface OrderPaid {
1353
- /** Order paid timestamp in ISO UTC. */
1374
+ /** Triggered when an order is paid. */
1375
+ interface OrderPaid {
1376
+ /** Date and time the order was paid. */
1354
1377
  timestamp?: Date | null;
1355
1378
  /**
1356
- * Site language when Order initiated
1379
+ * Site language when the order was initiated.
1357
1380
  * @format LANGUAGE
1358
1381
  */
1359
1382
  language?: string | null;
1360
1383
  /** Notifications silenced for this domain event. */
1361
1384
  silent?: boolean | null;
1362
1385
  /**
1363
- * Locale in which Order was created.
1386
+ * Locale in which the order was created.
1364
1387
  * @format LANGUAGE_TAG
1365
1388
  */
1366
1389
  locale?: string | null;
@@ -1384,7 +1407,7 @@ export interface OrderPaid {
1384
1407
  */
1385
1408
  memberId?: string | null;
1386
1409
  /**
1387
- * Order created timestamp
1410
+ * Date and time the order was created.
1388
1411
  * @readonly
1389
1412
  */
1390
1413
  created?: Date | null;
@@ -1420,8 +1443,9 @@ export interface OrderPaid {
1420
1443
  /** Invoice. */
1421
1444
  invoice?: Invoice;
1422
1445
  }
1423
- export interface ReservationCreated {
1424
- /** Reservation created timestamp in ISO UTC format. */
1446
+ /** Triggered when a reservation is created. */
1447
+ interface ReservationCreated {
1448
+ /** Date and time the reservation was created. */
1425
1449
  timestamp?: Date | null;
1426
1450
  /**
1427
1451
  * Event ID to which the reservation belongs.
@@ -1434,38 +1458,38 @@ export interface ReservationCreated {
1434
1458
  * @format GUID
1435
1459
  */
1436
1460
  reservationId?: string;
1437
- /** Reservation expiration timestamp. */
1461
+ /** Date and time the reservation expires. */
1438
1462
  expires?: Date | null;
1439
1463
  /** Reservation status. */
1440
1464
  status?: ReservationStatusWithLiterals;
1441
1465
  /**
1442
- * Reservation ticket quantities.
1466
+ * Amount of tickets in the reservation.
1443
1467
  * @maxSize 50
1444
1468
  */
1445
1469
  quantities?: TicketQuantity[];
1446
- /** Reservation update timestamp. */
1470
+ /** Date and time the reservation was updated. */
1447
1471
  _updatedDate?: Date | null;
1448
1472
  /**
1449
- * Reservation counts.
1473
+ * Number of reservations.
1450
1474
  * @maxSize 50
1451
1475
  */
1452
1476
  counts?: ReservationCount[];
1453
1477
  }
1454
- export declare enum ReservationStatus {
1455
- /** The Reservation is pending confirmation and will expire after the expiration due time. */
1478
+ declare enum ReservationStatus {
1479
+ /** The Reservation is pending confirmation. It will expire after a certain amount of time. */
1456
1480
  RESERVATION_PENDING = "RESERVATION_PENDING",
1457
1481
  /** The reservation is confirmed and will not expire. */
1458
1482
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
1459
- /** The reservation is canceled because of non payment. */
1483
+ /** The reservation is canceled because it's not paid. */
1460
1484
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
1461
1485
  /** The reservation is canceled manually by the buyer. */
1462
1486
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
1463
- /** The reservation is expired. */
1487
+ /** The reservation has expired. */
1464
1488
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1465
1489
  }
1466
1490
  /** @enumType */
1467
- export type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
1468
- export interface TicketQuantity {
1491
+ type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
1492
+ interface TicketQuantity {
1469
1493
  /**
1470
1494
  * Ticket definition ID.
1471
1495
  * @format GUID
@@ -1476,7 +1500,7 @@ export interface TicketQuantity {
1476
1500
  /** Quantity update timestamp. */
1477
1501
  _updatedDate?: Date | null;
1478
1502
  }
1479
- export interface ReservationCount {
1503
+ interface ReservationCount {
1480
1504
  /** Reservation Count snapshot timestamp. */
1481
1505
  timestamp?: Date | null;
1482
1506
  /**
@@ -1491,8 +1515,9 @@ export interface ReservationCount {
1491
1515
  /** True if paid ticket reservation exist. */
1492
1516
  paidExists?: boolean;
1493
1517
  }
1494
- export interface ReservationUpdated {
1495
- /** Reservation updated timestamp. */
1518
+ /** Triggered when a reservation is updated. */
1519
+ interface ReservationUpdated {
1520
+ /** Date and time the reservation was updated. */
1496
1521
  timestamp?: Date | null;
1497
1522
  /**
1498
1523
  * Event ID to which the reservation belongs.
@@ -1507,38 +1532,38 @@ export interface ReservationUpdated {
1507
1532
  reservationId?: string;
1508
1533
  /** Reservation status. */
1509
1534
  status?: ReservationStatusWithLiterals;
1510
- /** Reservation expiration timestamp. */
1535
+ /** Date and time the reservation expires. */
1511
1536
  expires?: Date | null;
1512
1537
  /**
1513
- * Reservation ticket quantities.
1538
+ * Amount of tickets in the reservation.
1514
1539
  * @maxSize 50
1515
1540
  */
1516
1541
  quantities?: TicketQuantity[];
1517
- /** Reservation update timestamp. */
1542
+ /** Date and time the reservation was updated. */
1518
1543
  _updatedDate?: Date | null;
1519
1544
  /**
1520
- * Reservation counts.
1545
+ * Number of reservations.
1521
1546
  * @maxSize 50
1522
1547
  */
1523
1548
  counts?: ReservationCount[];
1524
1549
  }
1525
- export interface GetCheckoutOptionsRequest {
1550
+ interface GetCheckoutOptionsRequest {
1526
1551
  }
1527
- export interface GetCheckoutOptionsResponse {
1552
+ interface GetCheckoutOptionsResponse {
1528
1553
  /** Whether any payment method is configured and available for payment. */
1529
1554
  paymentMethodConfigured?: boolean;
1530
1555
  /** Whether coupons are accepted at checkout. */
1531
1556
  acceptCoupons?: boolean;
1532
- /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
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"`. */
1533
1558
  premiumServices?: boolean;
1534
1559
  /** Whether there are any paid tickets available for sale. */
1535
1560
  paidTickets?: boolean;
1536
1561
  /** Whether gift cards are accepted at checkout. */
1537
1562
  acceptGiftCards?: boolean;
1538
1563
  }
1539
- export interface ListAvailableTicketsRequest {
1564
+ interface ListAvailableTicketsRequest {
1540
1565
  /**
1541
- * Event ID. If not provided, available tickets for all events in the site will be returned.
1566
+ * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
1542
1567
  * @format GUID
1543
1568
  */
1544
1569
  eventId?: string;
@@ -1557,18 +1582,18 @@ export interface ListAvailableTicketsRequest {
1557
1582
  sort?: string;
1558
1583
  state?: StateWithLiterals[];
1559
1584
  }
1560
- export declare enum State {
1585
+ declare enum State {
1561
1586
  INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
1562
1587
  }
1563
1588
  /** @enumType */
1564
- export type StateWithLiterals = State | 'INCLUDE_HIDDEN_NOT_ON_SALE';
1565
- export interface ListAvailableTicketsResponse {
1589
+ type StateWithLiterals = State | 'INCLUDE_HIDDEN_NOT_ON_SALE';
1590
+ interface ListAvailableTicketsResponse {
1566
1591
  /** Ticket definitions meta data. */
1567
1592
  metaData?: ResponseMetaData;
1568
1593
  /** Ticket definitions. */
1569
1594
  definitions?: TicketDefinition[];
1570
1595
  }
1571
- export interface ResponseMetaData {
1596
+ interface ResponseMetaData {
1572
1597
  /** Number of items in the response. */
1573
1598
  count?: number;
1574
1599
  /** Offset of items. */
@@ -1576,7 +1601,7 @@ export interface ResponseMetaData {
1576
1601
  /** Total number of matching items. */
1577
1602
  total?: number;
1578
1603
  }
1579
- export interface TicketDefinition {
1604
+ interface TicketDefinition {
1580
1605
  /**
1581
1606
  * Ticket definition ID.
1582
1607
  * @format GUID
@@ -1623,7 +1648,7 @@ export interface TicketDefinition {
1623
1648
  /** Ticket pricing. */
1624
1649
  pricing?: TicketPricing;
1625
1650
  }
1626
- export interface Dashboard {
1651
+ interface Dashboard {
1627
1652
  /** Whether ticket is hidden and cannot be sold. */
1628
1653
  hidden?: boolean;
1629
1654
  /**
@@ -1642,11 +1667,11 @@ export interface Dashboard {
1642
1667
  /** Number of tickets reserved. */
1643
1668
  ticketsReserved?: number;
1644
1669
  }
1645
- export interface WixFeeConfig {
1670
+ interface WixFeeConfig {
1646
1671
  /** Fee calculation method. */
1647
1672
  type?: FeeTypeWithLiterals;
1648
1673
  }
1649
- export interface TicketSalePeriod {
1674
+ interface TicketSalePeriod {
1650
1675
  /** Ticket sale start timestamp. */
1651
1676
  startDate?: Date | null;
1652
1677
  /** Ticket sale end timestamp. */
@@ -1654,7 +1679,7 @@ export interface TicketSalePeriod {
1654
1679
  /** Whether to hide this ticket if it's not on sale */
1655
1680
  hideNotOnSale?: boolean;
1656
1681
  }
1657
- export declare enum TicketSaleStatus {
1682
+ declare enum TicketSaleStatus {
1658
1683
  /** Ticket sale is scheduled to start. */
1659
1684
  SALE_SCHEDULED = "SALE_SCHEDULED",
1660
1685
  /** Ticket sale has started. */
@@ -1663,8 +1688,8 @@ export declare enum TicketSaleStatus {
1663
1688
  SALE_ENDED = "SALE_ENDED"
1664
1689
  }
1665
1690
  /** @enumType */
1666
- export type TicketSaleStatusWithLiterals = TicketSaleStatus | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
1667
- export interface TicketPricing extends TicketPricingPriceOneOf {
1691
+ type TicketSaleStatusWithLiterals = TicketSaleStatus | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
1692
+ interface TicketPricing extends TicketPricingPriceOneOf {
1668
1693
  /** Ticket price which is read only. */
1669
1694
  fixedPrice?: Money;
1670
1695
  /** Min price per ticket, customizable. */
@@ -1678,7 +1703,7 @@ export interface TicketPricing extends TicketPricingPriceOneOf {
1678
1703
  pricingType?: TypeWithLiterals;
1679
1704
  }
1680
1705
  /** @oneof */
1681
- export interface TicketPricingPriceOneOf {
1706
+ interface TicketPricingPriceOneOf {
1682
1707
  /** Ticket price which is read only. */
1683
1708
  fixedPrice?: Money;
1684
1709
  /** Min price per ticket, customizable. */
@@ -1686,11 +1711,11 @@ export interface TicketPricingPriceOneOf {
1686
1711
  /** Ticket pricing options. */
1687
1712
  pricingOptions?: PricingOptions;
1688
1713
  }
1689
- export interface PricingOptions {
1714
+ interface PricingOptions {
1690
1715
  /** Multiple ticket pricing options. */
1691
1716
  options?: PricingOption[];
1692
1717
  }
1693
- export interface PricingOption {
1718
+ interface PricingOption {
1694
1719
  /**
1695
1720
  * Ticket pricing option ID.
1696
1721
  * @format GUID
@@ -1705,13 +1730,13 @@ export interface PricingOption {
1705
1730
  /** Ticket pricing option price. */
1706
1731
  price?: Money;
1707
1732
  }
1708
- export declare enum Type {
1733
+ declare enum Type {
1709
1734
  STANDARD = "STANDARD",
1710
1735
  DONATION = "DONATION"
1711
1736
  }
1712
1737
  /** @enumType */
1713
- export type TypeWithLiterals = Type | 'STANDARD' | 'DONATION';
1714
- export interface QueryAvailableTicketsRequest {
1738
+ type TypeWithLiterals = Type | 'STANDARD' | 'DONATION';
1739
+ interface QueryAvailableTicketsRequest {
1715
1740
  /** Offset. */
1716
1741
  offset?: number;
1717
1742
  /**
@@ -1721,7 +1746,10 @@ export interface QueryAvailableTicketsRequest {
1721
1746
  limit?: number;
1722
1747
  /** Ticket definition. */
1723
1748
  filter?: Record<string, any> | null;
1724
- /** @maxSize 20 */
1749
+ /**
1750
+ * Which fields to return.
1751
+ * @maxSize 20
1752
+ */
1725
1753
  fieldset?: TicketDefinitionFieldsetWithLiterals[];
1726
1754
  /**
1727
1755
  * Sort order.
@@ -1730,21 +1758,21 @@ export interface QueryAvailableTicketsRequest {
1730
1758
  */
1731
1759
  sort?: string;
1732
1760
  }
1733
- export declare enum TicketDefinitionFieldset {
1761
+ declare enum TicketDefinitionFieldset {
1734
1762
  /** Include `policy` in the response. */
1735
1763
  POLICY = "POLICY",
1736
1764
  /** Include `dashboard` in the response. */
1737
1765
  DASHBOARD = "DASHBOARD"
1738
1766
  }
1739
1767
  /** @enumType */
1740
- export type TicketDefinitionFieldsetWithLiterals = TicketDefinitionFieldset | 'POLICY' | 'DASHBOARD';
1741
- export interface QueryAvailableTicketsResponse {
1768
+ type TicketDefinitionFieldsetWithLiterals = TicketDefinitionFieldset | 'POLICY' | 'DASHBOARD';
1769
+ interface QueryAvailableTicketsResponse {
1742
1770
  /** Ticket definitions meta data. */
1743
1771
  metaData?: ResponseMetaData;
1744
1772
  /** Ticket definitions. */
1745
1773
  definitions?: TicketDefinition[];
1746
1774
  }
1747
- export interface CreateReservationRequest {
1775
+ interface CreateReservationRequest {
1748
1776
  /**
1749
1777
  * Event ID to which the reservation belongs.
1750
1778
  * @format GUID
@@ -1756,12 +1784,12 @@ export interface CreateReservationRequest {
1756
1784
  * @maxSize 50
1757
1785
  */
1758
1786
  ticketQuantities?: TicketReservationQuantity[];
1759
- /** Whether to ignore the available ticket limits upon reservation. */
1787
+ /** Whether to ignore the available ticket limits upon a reservation. */
1760
1788
  ignoreLimits?: boolean;
1761
- /** Whether to allow reservation for hidden tickets. */
1789
+ /** Whether to allow reservations for hidden tickets. */
1762
1790
  allowHiddenTickets?: boolean;
1763
1791
  }
1764
- export interface TicketReservationQuantity {
1792
+ interface TicketReservationQuantity {
1765
1793
  /**
1766
1794
  * Ticket definition ID.
1767
1795
  * @format GUID
@@ -1782,13 +1810,13 @@ export interface TicketReservationQuantity {
1782
1810
  /** Optional ticket details */
1783
1811
  ticketDetails?: TicketDetails[];
1784
1812
  }
1785
- export interface CreateReservationResponse {
1813
+ interface CreateReservationResponse {
1786
1814
  /**
1787
1815
  * Reservation ID.
1788
1816
  * @format GUID
1789
1817
  */
1790
1818
  _id?: string;
1791
- /** Reservation expiration timestamp. */
1819
+ /** Date and time the reservation expires. */
1792
1820
  expires?: Date | null;
1793
1821
  /** Ticket reservations. */
1794
1822
  reservations?: TicketReservation[];
@@ -1797,9 +1825,9 @@ export interface CreateReservationResponse {
1797
1825
  /** Reservation status. */
1798
1826
  reservationStatus?: ReservationStatusWithLiterals;
1799
1827
  }
1800
- export interface TicketReservation {
1828
+ interface TicketReservation {
1801
1829
  /**
1802
- * Quantity of reserved tickets.
1830
+ * Amount of reserved tickets.
1803
1831
  * @min 1
1804
1832
  * @max 20
1805
1833
  */
@@ -1809,7 +1837,7 @@ export interface TicketReservation {
1809
1837
  /** Optional ticket details. */
1810
1838
  ticketDetails?: TicketDetails[];
1811
1839
  }
1812
- export interface CancelReservationRequest {
1840
+ interface CancelReservationRequest {
1813
1841
  /**
1814
1842
  * Event ID to which the reservation belongs.
1815
1843
  * @format GUID
@@ -1821,9 +1849,9 @@ export interface CancelReservationRequest {
1821
1849
  */
1822
1850
  _id: string;
1823
1851
  }
1824
- export interface CancelReservationResponse {
1852
+ interface CancelReservationResponse {
1825
1853
  }
1826
- export interface GetInvoiceRequest {
1854
+ interface GetInvoiceRequest {
1827
1855
  /**
1828
1856
  * Event ID to which the invoice belongs.
1829
1857
  * @format GUID
@@ -1839,14 +1867,14 @@ export interface GetInvoiceRequest {
1839
1867
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1840
1868
  paidPlanBenefit?: PaidPlanBenefit;
1841
1869
  }
1842
- export interface DiscountRequest {
1870
+ interface DiscountRequest {
1843
1871
  /**
1844
1872
  * Discount coupon code.
1845
1873
  * @maxLength 20
1846
1874
  */
1847
1875
  couponCode?: string;
1848
1876
  }
1849
- export interface PaidPlanBenefit {
1877
+ interface PaidPlanBenefit {
1850
1878
  /**
1851
1879
  * Pricing plan ID.
1852
1880
  * @format GUID
@@ -1858,7 +1886,7 @@ export interface PaidPlanBenefit {
1858
1886
  */
1859
1887
  benefitId?: string;
1860
1888
  }
1861
- export interface GetInvoiceResponse {
1889
+ interface GetInvoiceResponse {
1862
1890
  /** Invoice with applied discount. */
1863
1891
  invoice?: Invoice;
1864
1892
  /** Discount errors, if relevant. */
@@ -1874,31 +1902,31 @@ export interface GetInvoiceResponse {
1874
1902
  * - `RESERVATION_EXPIRED`: The reservation has expired.
1875
1903
  */
1876
1904
  reservationStatus?: ReservationStatusWithLiterals;
1877
- /** Whether this reservation is already used in checkout. */
1905
+ /** Whether this reservation is already used in a checkout. */
1878
1906
  reservationOccupied?: boolean;
1879
1907
  /** Ticket reservations. */
1880
1908
  reservations?: TicketReservation[];
1881
1909
  }
1882
- export interface DiscountErrors {
1910
+ interface DiscountErrors {
1883
1911
  /** Object containing error information. */
1884
1912
  error?: Error[];
1885
1913
  }
1886
- export interface Error {
1914
+ interface Error {
1887
1915
  /** A code identifying the error type. */
1888
1916
  code?: string;
1889
1917
  }
1890
- export interface GiftCardErrors {
1918
+ interface GiftCardErrors {
1891
1919
  /**
1892
1920
  * Error.
1893
1921
  * @maxSize 10
1894
1922
  */
1895
1923
  error?: GiftCardErrorsError[];
1896
1924
  }
1897
- export interface GiftCardErrorsError {
1925
+ interface GiftCardErrorsError {
1898
1926
  /** @maxLength 100 */
1899
1927
  code?: string;
1900
1928
  }
1901
- export interface CheckoutRequest {
1929
+ interface CheckoutRequest {
1902
1930
  /**
1903
1931
  * Event ID to which the checkout belongs.
1904
1932
  * @format GUID
@@ -1928,7 +1956,7 @@ export interface CheckoutRequest {
1928
1956
  /** Whether marketing consent was given */
1929
1957
  marketingConsent?: boolean | null;
1930
1958
  }
1931
- export interface Buyer {
1959
+ interface Buyer {
1932
1960
  /**
1933
1961
  * Buyer first name.
1934
1962
  * @minLength 1
@@ -1949,12 +1977,12 @@ export interface Buyer {
1949
1977
  */
1950
1978
  email?: string;
1951
1979
  }
1952
- export interface Guest {
1980
+ interface Guest {
1953
1981
  /** Specific guest info. */
1954
1982
  form?: FormResponse;
1955
1983
  }
1956
- export interface CheckoutOptions {
1957
- /** Whether to ignore settings to notify contacts or users. */
1984
+ interface CheckoutOptions {
1985
+ /** Whether to ignore settings to notify contacts. */
1958
1986
  silent?: boolean;
1959
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. */
1960
1988
  payInPerson?: boolean;
@@ -1963,7 +1991,7 @@ export interface CheckoutOptions {
1963
1991
  /** Marks payment as already paid */
1964
1992
  markAsPaid?: boolean | null;
1965
1993
  }
1966
- export interface CheckoutResponse {
1994
+ interface CheckoutResponse {
1967
1995
  /** Created order. */
1968
1996
  order?: Order;
1969
1997
  /**
@@ -1976,16 +2004,17 @@ export interface CheckoutResponse {
1976
2004
  /** Order page URL. */
1977
2005
  orderPageUrl?: string | null;
1978
2006
  }
1979
- export interface OrderInitiated {
1980
- /** Order initiated timestamp in ISO UTC format. */
2007
+ /** Triggered when an order is initiated. */
2008
+ interface OrderInitiated {
2009
+ /** Date and time the order was initiated. */
1981
2010
  timestamp?: Date | null;
1982
2011
  /**
1983
- * Site language when Order initiated
2012
+ * Site language when the order was initiated.
1984
2013
  * @format LANGUAGE
1985
2014
  */
1986
2015
  language?: string | null;
1987
2016
  /**
1988
- * Locale in which Order was created.
2017
+ * Locale in which the order was created.
1989
2018
  * @format LANGUAGE_TAG
1990
2019
  */
1991
2020
  locale?: string | null;
@@ -1996,20 +2025,20 @@ export interface OrderInitiated {
1996
2025
  eventId?: string;
1997
2026
  /** Unique order number. */
1998
2027
  orderNumber?: string;
1999
- /** Contact ID associated with this order. */
2028
+ /** Contact ID associated with the order. */
2000
2029
  contactId?: string;
2001
2030
  /**
2002
- * Member ID associated with this order.
2031
+ * Member ID associated with the order.
2003
2032
  * @format GUID
2004
2033
  */
2005
2034
  memberId?: string | null;
2006
2035
  /**
2007
- * Order created timestamp.
2036
+ * Date and time the order was created.
2008
2037
  * @readonly
2009
2038
  */
2010
2039
  created?: Date | null;
2011
2040
  /**
2012
- * Order updated timestamp.
2041
+ * Date and time the order was updated.
2013
2042
  * @readonly
2014
2043
  */
2015
2044
  updated?: Date | null;
@@ -2034,12 +2063,12 @@ export interface OrderInitiated {
2034
2063
  status?: OrderStatusWithLiterals;
2035
2064
  /** Invoice. */
2036
2065
  invoice?: Invoice;
2037
- /** Reservation ID associated with this order. */
2066
+ /** Reservation ID associated with the order. */
2038
2067
  reservationId?: string;
2039
2068
  /** Order was marked as paid. */
2040
2069
  markedAsPaid?: boolean | null;
2041
2070
  }
2042
- export interface UpdateCheckoutRequest {
2071
+ interface UpdateCheckoutRequest {
2043
2072
  /**
2044
2073
  * Event ID to which the checkout belongs.
2045
2074
  * @format GUID
@@ -2058,20 +2087,24 @@ export interface UpdateCheckoutRequest {
2058
2087
  * @maxSize 20
2059
2088
  */
2060
2089
  guests?: Guest[];
2061
- /** Member ID (if empty - no site member is associated to this order). */
2090
+ /**
2091
+ * Member ID.
2092
+ *
2093
+ * If empty, no site member is associated to this order.
2094
+ */
2062
2095
  memberId?: string | null;
2063
2096
  /** Discount to apply on the invoice. */
2064
2097
  discount?: DiscountRequest;
2065
2098
  /** Benefit granted by the pricing plan. */
2066
2099
  paidPlanBenefit?: PaidPlanBenefit;
2067
2100
  }
2068
- export interface UpdateCheckoutResponse {
2101
+ interface UpdateCheckoutResponse {
2069
2102
  /** Updated order. */
2070
2103
  order?: Order;
2071
2104
  /** Order page URL. */
2072
2105
  orderPageUrl?: string | null;
2073
2106
  }
2074
- export interface OrderPageUrls {
2107
+ interface OrderPageUrls {
2075
2108
  /**
2076
2109
  * Success order page URL.
2077
2110
  * @format WEB_URL
@@ -2093,7 +2126,7 @@ export interface OrderPageUrls {
2093
2126
  */
2094
2127
  error?: string | null;
2095
2128
  }
2096
- export interface PosCheckoutRequest {
2129
+ interface PosCheckoutRequest {
2097
2130
  /**
2098
2131
  * Event ID to which the checkout belongs.
2099
2132
  * @format GUID
@@ -2111,7 +2144,7 @@ export interface PosCheckoutRequest {
2111
2144
  */
2112
2145
  paymentDetailsId?: string | null;
2113
2146
  }
2114
- export interface PosCheckoutResponse {
2147
+ interface PosCheckoutResponse {
2115
2148
  /** Created order. */
2116
2149
  order?: Order;
2117
2150
  /** Time when the order expires, applies to orders with status = INITIATED. */
@@ -2119,7 +2152,7 @@ export interface PosCheckoutResponse {
2119
2152
  /** Ticket reservations. */
2120
2153
  reservations?: TicketReservation[];
2121
2154
  }
2122
- export interface GetReservationRequest {
2155
+ interface GetReservationRequest {
2123
2156
  /**
2124
2157
  * Event ID.
2125
2158
  * @format GUID
@@ -2131,19 +2164,86 @@ export interface GetReservationRequest {
2131
2164
  */
2132
2165
  reservationId?: string | null;
2133
2166
  }
2134
- export interface GetReservationResponse {
2167
+ interface GetReservationResponse {
2168
+ /** Reservation. */
2169
+ reservation?: Reservation;
2170
+ }
2171
+ interface Reservation {
2135
2172
  /** Date and time the Ticket Reservation was created. */
2136
2173
  _createdDate?: Date | null;
2137
2174
  /** Date and time the Ticket Reservation was last updated. */
2138
2175
  _updatedDate?: Date | null;
2139
- /** Date and time the Pending TicketReservation will expire. */
2176
+ /** Date and time the pending ticket reservation will expire. */
2140
2177
  expirationDate?: Date | null;
2141
2178
  /** Reservation status. */
2142
2179
  reservationStatus?: ReservationStatusWithLiterals;
2143
- /** Ticket reservations. */
2180
+ /**
2181
+ * Ticket reservations.
2182
+ * @maxSize 50
2183
+ */
2144
2184
  reservations?: TicketReservation[];
2145
2185
  }
2146
- export interface BaseEventMetadata {
2186
+ interface ConfirmReservationRequest {
2187
+ /**
2188
+ * Event ID.
2189
+ * @format GUID
2190
+ */
2191
+ eventId?: string | null;
2192
+ /**
2193
+ * Ticket reservation ID.
2194
+ * @format GUID
2195
+ */
2196
+ reservationId?: string | null;
2197
+ }
2198
+ interface ConfirmReservationResponse {
2199
+ /** Reservation. */
2200
+ reservation?: Reservation;
2201
+ }
2202
+ interface ExpireReservationRequest {
2203
+ /**
2204
+ * Event ID.
2205
+ * @format GUID
2206
+ */
2207
+ eventId?: string | null;
2208
+ /**
2209
+ * Ticket reservation ID.
2210
+ * @format GUID
2211
+ */
2212
+ reservationId?: string | null;
2213
+ }
2214
+ interface ExpireReservationResponse {
2215
+ /** Reservation. */
2216
+ reservation?: Reservation;
2217
+ }
2218
+ interface QueryEventsWithPaidReservationsRequest {
2219
+ /**
2220
+ * Event Keys.
2221
+ * @minSize 1
2222
+ * @maxSize 100
2223
+ */
2224
+ eventKeys?: EventKey[];
2225
+ }
2226
+ interface EventKey {
2227
+ /**
2228
+ * Instance ID.
2229
+ * @format GUID
2230
+ */
2231
+ instanceId?: string | null;
2232
+ /**
2233
+ * Event ID.
2234
+ * @format GUID
2235
+ */
2236
+ eventId?: string | null;
2237
+ }
2238
+ interface QueryEventsWithPaidReservationsResponse {
2239
+ /**
2240
+ * Event IDs.
2241
+ * @format GUID
2242
+ * @maxSize 100
2243
+ */
2244
+ eventIds?: string[] | null;
2245
+ }
2246
+ interface BaseEventMetadata {
2147
2247
  /**
2148
2248
  * App instance ID.
2149
2249
  * @format GUID
@@ -2157,157 +2257,31 @@ export interface BaseEventMetadata {
2157
2257
  /** The identification type and identity data. */
2158
2258
  identity?: IdentificationData;
2159
2259
  }
2160
- export interface OrderDeletedEnvelope {
2260
+ interface OrderDeletedEnvelope {
2161
2261
  data: OrderDeleted;
2162
2262
  metadata: BaseEventMetadata;
2163
2263
  }
2164
- /**
2165
- * This event is triggered when an order is deleted via GDPR request.
2166
- * @permissionScope Read Events - all read permissions
2167
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2168
- * @permissionScope Manage Events - all permissions
2169
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2170
- * @permissionScope Manage Events
2171
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2172
- * @permissionScope Read Basic Events Order Info
2173
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2174
- * @permissionScope Manage Orders
2175
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2176
- * @permissionId WIX_EVENTS.READ_ORDERS
2177
- * @webhook
2178
- * @eventType wix.events.ticketing.events.OrderDeleted
2179
- * @serviceIdentifier wix.events.ticketing.OrderManagement
2180
- * @slug order_deleted
2181
- */
2182
- export declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
2183
- export interface OrderUpdatedEnvelope {
2264
+ interface OrderUpdatedEnvelope {
2184
2265
  data: OrderUpdated;
2185
2266
  metadata: BaseEventMetadata;
2186
2267
  }
2187
- /** @permissionScope Read Events - all read permissions
2188
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2189
- * @permissionScope Manage Events - all permissions
2190
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2191
- * @permissionScope Manage Events
2192
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2193
- * @permissionScope Read Basic Events Order Info
2194
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2195
- * @permissionScope Manage Orders
2196
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2197
- * @permissionId WIX_EVENTS.READ_ORDERS
2198
- * @webhook
2199
- * @eventType wix.events.ticketing.events.OrderUpdated
2200
- * @serviceIdentifier wix.events.ticketing.OrderManagement
2201
- * @slug order_updated
2202
- */
2203
- export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2204
- export interface OrderConfirmedEnvelope {
2268
+ interface OrderConfirmedEnvelope {
2205
2269
  data: OrderConfirmed;
2206
2270
  metadata: BaseEventMetadata;
2207
2271
  }
2208
- /** @permissionScope Read Events - all read permissions
2209
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2210
- * @permissionScope Manage Events - all permissions
2211
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2212
- * @permissionScope Manage Events
2213
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2214
- * @permissionScope Read Basic Events Order Info
2215
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2216
- * @permissionScope Manage Orders
2217
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2218
- * @permissionId WIX_EVENTS.READ_ORDERS
2219
- * @webhook
2220
- * @eventType wix.events.ticketing.events.OrderConfirmed
2221
- * @serviceIdentifier wix.events.ticketing.CheckoutService
2222
- * @slug order_confirmed
2223
- */
2224
- export declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
2225
- export interface OrderInitiatedEnvelope {
2272
+ interface OrderInitiatedEnvelope {
2226
2273
  data: OrderInitiated;
2227
2274
  metadata: BaseEventMetadata;
2228
2275
  }
2229
- /** @permissionScope Read Events - all read permissions
2230
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2231
- * @permissionScope Manage Events - all permissions
2232
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2233
- * @permissionScope Manage Events
2234
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2235
- * @permissionScope Read Basic Events Order Info
2236
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2237
- * @permissionScope Manage Orders
2238
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2239
- * @permissionId WIX_EVENTS.READ_ORDERS
2240
- * @webhook
2241
- * @eventType wix.events.ticketing.events.OrderInitiated
2242
- * @serviceIdentifier wix.events.ticketing.CheckoutService
2243
- * @slug order_initiated
2244
- */
2245
- export declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
2246
- export interface OrderReservationCreatedEnvelope {
2276
+ interface OrderReservationCreatedEnvelope {
2247
2277
  data: ReservationCreated;
2248
2278
  metadata: BaseEventMetadata;
2249
2279
  }
2250
- /** @permissionScope Read Events - all read permissions
2251
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2252
- * @permissionScope Manage Events - all permissions
2253
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2254
- * @permissionScope Manage Events
2255
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2256
- * @permissionScope Read Basic Events Order Info
2257
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2258
- * @permissionScope Manage Orders
2259
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2260
- * @permissionId WIX_EVENTS.READ_INVOICE
2261
- * @webhook
2262
- * @eventType wix.events.ticketing.events.ReservationCreated
2263
- * @serviceIdentifier wix.events.ticketing.CheckoutService
2264
- * @slug reservation_created
2265
- */
2266
- export declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
2267
- export interface OrderReservationUpdatedEnvelope {
2280
+ interface OrderReservationUpdatedEnvelope {
2268
2281
  data: ReservationUpdated;
2269
2282
  metadata: BaseEventMetadata;
2270
2283
  }
2271
- /** @permissionScope Read Events - all read permissions
2272
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2273
- * @permissionScope Manage Events - all permissions
2274
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2275
- * @permissionScope Manage Events
2276
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2277
- * @permissionScope Read Basic Events Order Info
2278
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2279
- * @permissionScope Manage Orders
2280
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2281
- * @permissionId WIX_EVENTS.READ_INVOICE
2282
- * @webhook
2283
- * @eventType wix.events.ticketing.events.ReservationUpdated
2284
- * @serviceIdentifier wix.events.ticketing.CheckoutService
2285
- * @slug reservation_updated
2286
- */
2287
- export declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
2288
- 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}.qrCode` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.ticketPdf` | `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`;
2289
- /**
2290
- * Retrieves a list of orders, including ticket data.
2291
- * @public
2292
- * @param options - An object representing the available options for retrieving a list of orders.
2293
- * @permissionId WIX_EVENTS.READ_ORDERS
2294
- * @permissionScope Read Events - all read permissions
2295
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2296
- * @permissionScope Manage Events - all permissions
2297
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2298
- * @permissionScope Manage Events
2299
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2300
- * @permissionScope Read Basic Events Order Info
2301
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2302
- * @permissionScope Manage Orders
2303
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2304
- * @applicableIdentity APP
2305
- * @fqn wix.events.ticketing.OrderManagement.ListOrders
2306
- */
2307
- export declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
2308
- [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2309
- }[OrderNonNullablePaths]>>;
2310
- export interface ListOrdersOptions {
2284
+ interface ListOrdersOptions {
2311
2285
  /** Offset. */
2312
2286
  offset?: number;
2313
2287
  /**
@@ -2387,34 +2361,7 @@ export interface ListOrdersOptions {
2387
2361
  */
2388
2362
  contactId?: string[];
2389
2363
  }
2390
- /**
2391
- * Retrieves an order, including ticket data.
2392
- * <!--
2393
- * >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.
2394
- * -->
2395
- * @public
2396
- * @requiredField identifiers
2397
- * @requiredField identifiers.eventId
2398
- * @requiredField identifiers.orderNumber
2399
- * @param options - An object representing the available options for getting an order.
2400
- * @param identifiers - An object containing identifiers for the order to be retrieved.
2401
- * @permissionId WIX_EVENTS.READ_ORDERS
2402
- * @permissionScope Read Events - all read permissions
2403
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2404
- * @permissionScope Manage Events - all permissions
2405
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2406
- * @permissionScope Manage Events
2407
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2408
- * @permissionScope Read Basic Events Order Info
2409
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2410
- * @permissionScope Manage Orders
2411
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2412
- * @applicableIdentity APP
2413
- * @returns Requested order.
2414
- * @fqn wix.events.ticketing.OrderManagement.GetOrder
2415
- */
2416
- export declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
2417
- export interface GetOrderIdentifiers {
2364
+ interface GetOrderIdentifiers {
2418
2365
  /**
2419
2366
  * Event ID to which the order belongs.
2420
2367
  * @format GUID
@@ -2426,7 +2373,7 @@ export interface GetOrderIdentifiers {
2426
2373
  */
2427
2374
  orderNumber: string;
2428
2375
  }
2429
- export interface GetOrderOptions {
2376
+ interface GetOrderOptions {
2430
2377
  /**
2431
2378
  * Predefined sets of fields to return.
2432
2379
  * - `TICKETS`: Returns `tickets`.
@@ -2439,28 +2386,7 @@ export interface GetOrderOptions {
2439
2386
  */
2440
2387
  fieldset?: OrderFieldsetWithLiterals[];
2441
2388
  }
2442
- /**
2443
- * Updates an order.
2444
- * @public
2445
- * @requiredField identifiers
2446
- * @requiredField identifiers.eventId
2447
- * @requiredField identifiers.orderNumber
2448
- * @param options - An object representing the available options for updating an order.
2449
- * @param identifiers - An object containing identifiers for the order to be updated.
2450
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2451
- * @permissionScope Manage Events - all permissions
2452
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2453
- * @permissionScope Manage Events
2454
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2455
- * @permissionScope Manage Orders
2456
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2457
- * @applicableIdentity APP
2458
- * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
2459
- */
2460
- export declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
2461
- [P in OrderNonNullablePaths]: `order.${P}`;
2462
- }[OrderNonNullablePaths]>>;
2463
- export interface UpdateOrderIdentifiers {
2389
+ interface UpdateOrderIdentifiers {
2464
2390
  /**
2465
2391
  * Event ID to which the order belongs.
2466
2392
  * @format GUID
@@ -2472,34 +2398,15 @@ export interface UpdateOrderIdentifiers {
2472
2398
  */
2473
2399
  orderNumber: string;
2474
2400
  }
2475
- export interface UpdateOrderOptions {
2401
+ interface UpdateOrderOptions {
2476
2402
  /** Set of field paths to update. */
2477
2403
  fields?: string[];
2478
2404
  /** Checkout form. */
2479
2405
  checkoutForm?: FormResponse;
2480
- /** Whether order is archived. */
2406
+ /** Whether to archive the order. */
2481
2407
  archived?: boolean;
2482
2408
  }
2483
- /**
2484
- * Archives multiple orders.
2485
- * @public
2486
- * @requiredField eventId
2487
- * @param options - An object representing the available options for confirming an order.
2488
- * @param eventId - Event ID to which the order belongs.
2489
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2490
- * @permissionScope Manage Events - all permissions
2491
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2492
- * @permissionScope Manage Events
2493
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2494
- * @permissionScope Manage Orders
2495
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2496
- * @applicableIdentity APP
2497
- * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
2498
- */
2499
- export declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
2500
- [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2501
- }[OrderNonNullablePaths]>>;
2502
- export interface BulkUpdateOrdersOptions {
2409
+ interface BulkUpdateOrdersOptions {
2503
2410
  /**
2504
2411
  * Unique order number.
2505
2412
  * @minLength 1
@@ -2513,30 +2420,7 @@ export interface BulkUpdateOrdersOptions {
2513
2420
  /** Whether to archive the order. */
2514
2421
  archived?: boolean;
2515
2422
  }
2516
- /**
2517
- * Confirms an order.
2518
- *
2519
- *
2520
- * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
2521
- * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
2522
- * @public
2523
- * @requiredField eventId
2524
- * @param options - An object representing the available options for confirming an order.
2525
- * @param eventId - Event ID to which the order belongs.
2526
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2527
- * @permissionScope Manage Events - all permissions
2528
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2529
- * @permissionScope Manage Events
2530
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2531
- * @permissionScope Manage Orders
2532
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2533
- * @applicableIdentity APP
2534
- * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
2535
- */
2536
- export declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
2537
- [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2538
- }[OrderNonNullablePaths]>>;
2539
- export interface ConfirmOrderOptions {
2423
+ interface ConfirmOrderOptions {
2540
2424
  /**
2541
2425
  * Order numbers.
2542
2426
  * @minLength 1
@@ -2545,122 +2429,30 @@ export interface ConfirmOrderOptions {
2545
2429
  */
2546
2430
  orderNumber?: string[];
2547
2431
  }
2548
- /**
2549
- * Retrieves a summary of total ticket sales.
2550
- * <!--
2551
- * > 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.
2552
- * -->
2553
- * @public
2554
- * @param options - An object representing the available options for retrieving a summary of total ticket sales.
2555
- * @permissionId WIX_EVENTS.READ_ORDERS
2556
- * @permissionScope Read Events - all read permissions
2557
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2558
- * @permissionScope Manage Events - all permissions
2559
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2560
- * @permissionScope Manage Events
2561
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2562
- * @permissionScope Read Basic Events Order Info
2563
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2564
- * @permissionScope Manage Orders
2565
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2566
- * @applicableIdentity APP
2567
- * @fqn wix.events.ticketing.OrderManagement.GetSummary
2568
- */
2569
- export declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
2570
- export interface GetSummaryOptions {
2432
+ interface GetSummaryOptions {
2571
2433
  /**
2572
- * Event ID.
2434
+ * Event ID to which the order belongs.
2573
2435
  * @format GUID
2574
2436
  */
2575
2437
  eventId?: string | null;
2576
2438
  }
2577
- /**
2578
- * Captures authorized payment asynchronously.
2579
- * Eventually order will become paid.
2580
- * For orders with non-authorized payments request will fail.
2581
- * @param orderNumber - Order number.
2582
- * @public
2583
- * @requiredField orderNumber
2584
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2585
- * @permissionScope Manage Events - all permissions
2586
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2587
- * @permissionScope Manage Events
2588
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2589
- * @permissionScope Manage Orders
2590
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2591
- * @applicableIdentity APP
2592
- * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
2593
- */
2594
- export declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void>;
2595
- export interface CaptureAuthorizedPaymentOptions {
2439
+ interface CaptureAuthorizedPaymentOptions {
2596
2440
  /**
2597
2441
  * Event ID.
2598
2442
  * @format GUID
2599
2443
  */
2600
2444
  eventId?: string;
2601
2445
  }
2602
- /**
2603
- * Voids authorized payment asynchronously.
2604
- * Eventually order will become voided.
2605
- * For orders with non-authorized payments request will fail.
2606
- * @param orderNumber - Order number.
2607
- * @public
2608
- * @requiredField orderNumber
2609
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2610
- * @permissionScope Manage Events - all permissions
2611
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2612
- * @permissionScope Manage Events
2613
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2614
- * @permissionScope Manage Orders
2615
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2616
- * @applicableIdentity APP
2617
- * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
2618
- */
2619
- export declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void>;
2620
- export interface VoidAuthorizedPaymentOptions {
2446
+ interface VoidAuthorizedPaymentOptions {
2621
2447
  /**
2622
2448
  * Event ID.
2623
2449
  * @format GUID
2624
2450
  */
2625
2451
  eventId?: string;
2626
2452
  }
2627
- /**
2628
- * Retrieves checkout details.
2629
- * @public
2630
- * @permissionId WIX_EVENTS.READ_CHECKOUT
2631
- * @permissionScope Manage Events - all permissions
2632
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2633
- * @permissionScope Manage Events
2634
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2635
- * @permissionScope Manage Orders
2636
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2637
- * @applicableIdentity APP
2638
- * @applicableIdentity VISITOR
2639
- * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
2640
- */
2641
- export declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
2642
- /**
2643
- * Returns tickets available to reserve.
2644
- * <!--
2645
- * > 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.
2646
- * -->
2647
- * @public
2648
- * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2649
- * @permissionId WIX_EVENTS.READ_CHECKOUT
2650
- * @permissionScope Manage Events - all permissions
2651
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2652
- * @permissionScope Manage Events
2653
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2654
- * @permissionScope Manage Orders
2655
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2656
- * @applicableIdentity APP
2657
- * @applicableIdentity VISITOR
2658
- * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
2659
- */
2660
- export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<NonNullablePaths<ListAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
2661
- export interface ListAvailableTicketsOptions {
2662
- /**
2663
- * Event ID. If not provided, available tickets for all events in the site will be returned.
2453
+ interface ListAvailableTicketsOptions {
2454
+ /**
2455
+ * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
2664
2456
  * @format GUID
2665
2457
  */
2666
2458
  eventId?: string;
@@ -2679,26 +2471,7 @@ export interface ListAvailableTicketsOptions {
2679
2471
  sort?: string;
2680
2472
  state?: StateWithLiterals[];
2681
2473
  }
2682
- /**
2683
- * Returns tickets available to reserve.
2684
- * <!--
2685
- * > 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.
2686
- * -->
2687
- * @public
2688
- * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2689
- * @permissionId WIX_EVENTS.READ_CHECKOUT
2690
- * @permissionScope Manage Events - all permissions
2691
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2692
- * @permissionScope Manage Events
2693
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2694
- * @permissionScope Manage Orders
2695
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2696
- * @applicableIdentity APP
2697
- * @applicableIdentity VISITOR
2698
- * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
2699
- */
2700
- export 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`>>;
2701
- export interface QueryAvailableTicketsOptions {
2474
+ interface QueryAvailableTicketsOptions {
2702
2475
  /** Offset. */
2703
2476
  offset?: number;
2704
2477
  /**
@@ -2708,7 +2481,10 @@ export interface QueryAvailableTicketsOptions {
2708
2481
  limit?: number;
2709
2482
  /** Ticket definition. */
2710
2483
  filter?: Record<string, any> | null;
2711
- /** @maxSize 20 */
2484
+ /**
2485
+ * Which fields to return.
2486
+ * @maxSize 20
2487
+ */
2712
2488
  fieldset?: TicketDefinitionFieldsetWithLiterals[];
2713
2489
  /**
2714
2490
  * Sort order.
@@ -2717,126 +2493,25 @@ export interface QueryAvailableTicketsOptions {
2717
2493
  */
2718
2494
  sort?: string;
2719
2495
  }
2720
- /**
2721
- * Reserves tickets for 20 minutes.
2722
- *
2723
- *
2724
- * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
2725
- * When the reservation expires, the tickets are added back to the stock.
2726
- * @public
2727
- * @requiredField eventId
2728
- * @param options - An object representing the available options for creating a reservation.
2729
- * @param eventId - Event ID to which the reservation belongs.
2730
- * @permissionId WIX_EVENTS.CHECKOUT
2731
- * @permissionScope Manage Events - all permissions
2732
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2733
- * @permissionScope Manage Events
2734
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2735
- * @permissionScope Manage Orders
2736
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2737
- * @applicableIdentity APP
2738
- * @applicableIdentity VISITOR
2739
- * @fqn wix.events.ticketing.CheckoutService.CreateReservation
2740
- */
2741
- export 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`>>;
2742
- export interface CreateReservationOptions {
2496
+ interface CreateReservationOptions {
2743
2497
  /**
2744
2498
  * Tickets to reserve.
2745
2499
  * @minSize 1
2746
2500
  * @maxSize 50
2747
2501
  */
2748
2502
  ticketQuantities?: TicketReservationQuantity[];
2749
- /** Whether to ignore the available ticket limits upon reservation. */
2503
+ /** Whether to ignore the available ticket limits upon a reservation. */
2750
2504
  ignoreLimits?: boolean;
2751
- /** Whether to allow reservation for hidden tickets. */
2505
+ /** Whether to allow reservations for hidden tickets. */
2752
2506
  allowHiddenTickets?: boolean;
2753
2507
  }
2754
- /**
2755
- * Cancels ticket reservation and returns tickets to stock.
2756
- * <!--
2757
- * > 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.
2758
- * -->
2759
- * @param _id - Reservation ID.
2760
- * @public
2761
- * @requiredField _id
2762
- * @requiredField eventId
2763
- * @param identifiers - An object containing identifiers for the reservation to be cancelled.
2764
- * @param eventId - Event ID to which the reservation belongs.
2765
- * @permissionId WIX_EVENTS.CHECKOUT
2766
- * @permissionScope Manage Events - all permissions
2767
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2768
- * @permissionScope Manage Events
2769
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2770
- * @permissionScope Manage Orders
2771
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2772
- * @applicableIdentity APP
2773
- * @applicableIdentity VISITOR
2774
- * @fqn wix.events.ticketing.CheckoutService.CancelReservation
2775
- */
2776
- export declare function cancelReservation(_id: string, eventId: string): Promise<void>;
2777
- /**
2778
- * Generates a preview of an invoice, including the given coupon or pricing plan.
2779
- * @param reservationId - Reservation ID.
2780
- * @public
2781
- * @requiredField eventId
2782
- * @requiredField reservationId
2783
- * @param options - An object representing the available options for generating a preview of a reservation invoice.
2784
- * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
2785
- * @param eventId - Event ID to which the invoice belongs.
2786
- * @permissionId WIX_EVENTS.READ_INVOICE
2787
- * @permissionScope Read Events - all read permissions
2788
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2789
- * @permissionScope Manage Events - all permissions
2790
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2791
- * @permissionScope Manage Events
2792
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2793
- * @permissionScope Read Basic Events Order Info
2794
- * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2795
- * @permissionScope Manage Orders
2796
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2797
- * @applicableIdentity APP
2798
- * @applicableIdentity VISITOR
2799
- * @fqn wix.events.ticketing.CheckoutService.GetInvoice
2800
- */
2801
- export 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`>>;
2802
- export interface GetInvoiceOptions {
2508
+ interface GetInvoiceOptions {
2803
2509
  /** Optional discount to be applied on the returned invoice. */
2804
2510
  withDiscount?: DiscountRequest;
2805
2511
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
2806
2512
  paidPlanBenefit?: PaidPlanBenefit;
2807
2513
  }
2808
- /**
2809
- * Checkouts the reserved tickets.
2810
- *
2811
- *
2812
- * Creates an order and associates it with a site visitor contact.
2813
- * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
2814
- *
2815
- * 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.
2816
- * 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:
2817
- * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
2818
- *
2819
- * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
2820
- * @public
2821
- * @requiredField eventId
2822
- * @requiredField options.guests.form
2823
- * @param options - An object representing the available options for checking out a reserved ticket.
2824
- * @param eventId - Event ID to which the checkout belongs.
2825
- * @permissionId WIX_EVENTS.CHECKOUT
2826
- * @permissionScope Manage Events - all permissions
2827
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2828
- * @permissionScope Manage Events
2829
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2830
- * @permissionScope Manage Orders
2831
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2832
- * @applicableIdentity APP
2833
- * @applicableIdentity VISITOR
2834
- * @fqn wix.events.ticketing.CheckoutService.Checkout
2835
- */
2836
- export declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
2837
- [P in OrderNonNullablePaths]: `order.${P}`;
2838
- }[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`>>;
2839
- export interface CheckoutOptionsForRequest {
2514
+ interface CheckoutOptionsForRequest {
2840
2515
  /**
2841
2516
  * Ticket reservation ID.
2842
2517
  * @format GUID
@@ -2861,33 +2536,7 @@ export interface CheckoutOptionsForRequest {
2861
2536
  /** Whether marketing consent was given */
2862
2537
  marketingConsent?: boolean | null;
2863
2538
  }
2864
- /**
2865
- * Updates order and tickets.
2866
- *
2867
- *
2868
- * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
2869
- * @param orderNumber - Unique order number.
2870
- * @public
2871
- * @requiredField eventId
2872
- * @requiredField orderNumber
2873
- * @param options - An object representing the available options for updating an order and tickets.
2874
- * @param identifiers - An object containing identifiers for the order and tickets to be updated.
2875
- * @param eventId - Event ID to which the checkout belongs.
2876
- * @permissionId WIX_EVENTS.CHECKOUT
2877
- * @permissionScope Manage Events - all permissions
2878
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2879
- * @permissionScope Manage Events
2880
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2881
- * @permissionScope Manage Orders
2882
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2883
- * @applicableIdentity APP
2884
- * @applicableIdentity VISITOR
2885
- * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
2886
- */
2887
- export declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
2888
- [P in OrderNonNullablePaths]: `order.${P}`;
2889
- }[OrderNonNullablePaths]>>;
2890
- export interface UpdateCheckoutOptions {
2539
+ interface UpdateCheckoutOptions {
2891
2540
  /** Buyer details. */
2892
2541
  buyer?: Buyer;
2893
2542
  /**
@@ -2896,34 +2545,18 @@ export interface UpdateCheckoutOptions {
2896
2545
  * @maxSize 20
2897
2546
  */
2898
2547
  guests?: Guest[];
2899
- /** Member ID (if empty - no site member is associated to this order). */
2548
+ /**
2549
+ * Member ID.
2550
+ *
2551
+ * If empty, no site member is associated to this order.
2552
+ */
2900
2553
  memberId?: string | null;
2901
2554
  /** Discount to apply on the invoice. */
2902
2555
  discount?: DiscountRequest;
2903
2556
  /** Benefit granted by the pricing plan. */
2904
2557
  paidPlanBenefit?: PaidPlanBenefit;
2905
2558
  }
2906
- /**
2907
- * Creates order with payment details already initiated via Cashier Pay API.
2908
- * @public
2909
- * @documentationMaturity preview
2910
- * @requiredField eventId
2911
- * @requiredField options.reservationId
2912
- * @param eventId - Event ID to which the checkout belongs.
2913
- * @permissionId WIX_EVENTS.MANAGE_ORDERS
2914
- * @permissionScope Manage Events - all permissions
2915
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2916
- * @permissionScope Manage Events
2917
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2918
- * @permissionScope Manage Orders
2919
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2920
- * @applicableIdentity APP
2921
- * @fqn wix.events.ticketing.CheckoutService.PosCheckout
2922
- */
2923
- export declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
2924
- [P in OrderNonNullablePaths]: `order.${P}`;
2925
- }[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`>>;
2926
- export interface PosCheckoutOptions {
2559
+ interface PosCheckoutOptions {
2927
2560
  /**
2928
2561
  * Ticket reservation ID.
2929
2562
  * @format GUID
@@ -2936,4 +2569,5 @@ export interface PosCheckoutOptions {
2936
2569
  */
2937
2570
  paymentDetailsId?: string | null;
2938
2571
  }
2939
- export {};
2572
+
2573
+ 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 };