@wix/auto_sdk_events_orders 1.0.9 → 1.0.11

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/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/events-v1-order-orders.context.d.ts +42 -0
  11. package/build/cjs/src/events-v1-order-orders.context.js +62 -0
  12. package/build/cjs/src/events-v1-order-orders.context.js.map +1 -0
  13. package/build/cjs/src/events-v1-order-orders.http.d.ts +97 -0
  14. package/build/cjs/src/events-v1-order-orders.http.js +1635 -0
  15. package/build/cjs/src/events-v1-order-orders.http.js.map +1 -0
  16. package/build/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
  17. package/build/cjs/src/events-v1-order-orders.meta.js +351 -0
  18. package/build/cjs/src/events-v1-order-orders.meta.js.map +1 -0
  19. package/build/cjs/src/events-v1-order-orders.public.d.ts +202 -0
  20. package/build/cjs/src/events-v1-order-orders.public.js +248 -0
  21. package/build/cjs/src/events-v1-order-orders.public.js.map +1 -0
  22. package/build/{events-v1-order-orders.universal-CceUcOMM.d.mts → cjs/src/events-v1-order-orders.types.d.ts} +217 -604
  23. package/build/cjs/src/events-v1-order-orders.types.js +178 -0
  24. package/build/cjs/src/events-v1-order-orders.types.js.map +1 -0
  25. package/build/cjs/src/events-v1-order-orders.universal.d.ts +2905 -0
  26. package/build/cjs/src/events-v1-order-orders.universal.js +1180 -0
  27. package/build/cjs/src/events-v1-order-orders.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/src/events-v1-order-orders.context.d.ts +42 -0
  38. package/build/es/src/events-v1-order-orders.context.js +42 -0
  39. package/build/es/src/events-v1-order-orders.context.js.map +1 -0
  40. package/build/es/src/events-v1-order-orders.http.d.ts +97 -0
  41. package/build/es/src/events-v1-order-orders.http.js +1615 -0
  42. package/build/es/src/events-v1-order-orders.http.js.map +1 -0
  43. package/build/es/src/events-v1-order-orders.meta.d.ts +49 -0
  44. package/build/es/src/events-v1-order-orders.meta.js +308 -0
  45. package/build/es/src/events-v1-order-orders.meta.js.map +1 -0
  46. package/build/es/src/events-v1-order-orders.public.d.ts +202 -0
  47. package/build/es/src/events-v1-order-orders.public.js +211 -0
  48. package/build/es/src/events-v1-order-orders.public.js.map +1 -0
  49. package/build/{events-v1-order-orders.universal-CceUcOMM.d.ts → es/src/events-v1-order-orders.types.d.ts} +217 -604
  50. package/build/es/src/events-v1-order-orders.types.js +175 -0
  51. package/build/es/src/events-v1-order-orders.types.js.map +1 -0
  52. package/build/es/src/events-v1-order-orders.universal.d.ts +2905 -0
  53. package/build/es/src/events-v1-order-orders.universal.js +1137 -0
  54. package/build/es/src/events-v1-order-orders.universal.js.map +1 -0
  55. package/build/internal/cjs/index.d.ts +1 -0
  56. package/build/internal/cjs/index.js +18 -0
  57. package/build/internal/cjs/index.js.map +1 -0
  58. package/build/internal/cjs/index.typings.d.ts +1 -0
  59. package/build/internal/cjs/index.typings.js +18 -0
  60. package/build/internal/cjs/index.typings.js.map +1 -0
  61. package/build/internal/cjs/meta.d.ts +1 -0
  62. package/build/internal/cjs/meta.js +18 -0
  63. package/build/internal/cjs/meta.js.map +1 -0
  64. package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +42 -0
  65. package/build/internal/cjs/src/events-v1-order-orders.context.js +62 -0
  66. package/build/internal/cjs/src/events-v1-order-orders.context.js.map +1 -0
  67. package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +97 -0
  68. package/build/internal/cjs/src/events-v1-order-orders.http.js +1635 -0
  69. package/build/internal/cjs/src/events-v1-order-orders.http.js.map +1 -0
  70. package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
  71. package/build/internal/cjs/src/events-v1-order-orders.meta.js +351 -0
  72. package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +1 -0
  73. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +202 -0
  74. package/build/internal/cjs/src/events-v1-order-orders.public.js +248 -0
  75. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +1 -0
  76. package/build/internal/{events-v1-order-orders.universal-CceUcOMM.d.ts → cjs/src/events-v1-order-orders.types.d.ts} +217 -604
  77. package/build/internal/cjs/src/events-v1-order-orders.types.js +178 -0
  78. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +1 -0
  79. package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +2905 -0
  80. package/build/internal/cjs/src/events-v1-order-orders.universal.js +1180 -0
  81. package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +1 -0
  82. package/build/internal/es/index.d.ts +1 -0
  83. package/build/internal/es/index.js +2 -0
  84. package/build/internal/es/index.js.map +1 -0
  85. package/build/internal/es/index.typings.d.ts +1 -0
  86. package/build/internal/es/index.typings.js +2 -0
  87. package/build/internal/es/index.typings.js.map +1 -0
  88. package/build/internal/es/meta.d.ts +1 -0
  89. package/build/internal/es/meta.js +2 -0
  90. package/build/internal/es/meta.js.map +1 -0
  91. package/build/internal/es/src/events-v1-order-orders.context.d.ts +42 -0
  92. package/build/internal/es/src/events-v1-order-orders.context.js +42 -0
  93. package/build/internal/es/src/events-v1-order-orders.context.js.map +1 -0
  94. package/build/internal/es/src/events-v1-order-orders.http.d.ts +97 -0
  95. package/build/internal/es/src/events-v1-order-orders.http.js +1615 -0
  96. package/build/internal/es/src/events-v1-order-orders.http.js.map +1 -0
  97. package/build/internal/es/src/events-v1-order-orders.meta.d.ts +49 -0
  98. package/build/internal/es/src/events-v1-order-orders.meta.js +308 -0
  99. package/build/internal/es/src/events-v1-order-orders.meta.js.map +1 -0
  100. package/build/internal/es/src/events-v1-order-orders.public.d.ts +202 -0
  101. package/build/internal/es/src/events-v1-order-orders.public.js +211 -0
  102. package/build/internal/es/src/events-v1-order-orders.public.js.map +1 -0
  103. package/build/internal/{events-v1-order-orders.universal-CceUcOMM.d.mts → es/src/events-v1-order-orders.types.d.ts} +217 -604
  104. package/build/internal/es/src/events-v1-order-orders.types.js +175 -0
  105. package/build/internal/es/src/events-v1-order-orders.types.js.map +1 -0
  106. package/build/internal/es/src/events-v1-order-orders.universal.d.ts +2905 -0
  107. package/build/internal/es/src/events-v1-order-orders.universal.js +1137 -0
  108. package/build/internal/es/src/events-v1-order-orders.universal.js.map +1 -0
  109. package/package.json +11 -12
  110. package/build/index.d.mts +0 -229
  111. package/build/index.d.ts +0 -229
  112. package/build/index.js +0 -2769
  113. package/build/index.js.map +0 -1
  114. package/build/index.mjs +0 -2706
  115. package/build/index.mjs.map +0 -1
  116. package/build/internal/index.d.mts +0 -229
  117. package/build/internal/index.d.ts +0 -229
  118. package/build/internal/index.js +0 -2769
  119. package/build/internal/index.js.map +0 -1
  120. package/build/internal/index.mjs +0 -2706
  121. package/build/internal/index.mjs.map +0 -1
  122. package/build/internal/meta.d.mts +0 -1331
  123. package/build/internal/meta.d.ts +0 -1331
  124. package/build/internal/meta.js +0 -1907
  125. package/build/internal/meta.js.map +0 -1
  126. package/build/internal/meta.mjs +0 -1864
  127. package/build/internal/meta.mjs.map +0 -1
  128. package/build/meta.d.mts +0 -1331
  129. package/build/meta.d.ts +0 -1331
  130. package/build/meta.js +0 -1907
  131. package/build/meta.js.map +0 -1
  132. package/build/meta.mjs +0 -1864
  133. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,2905 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+ export interface Order {
3
+ /** Unique order number. */
4
+ orderNumber?: string;
5
+ /**
6
+ * Reservation ID.
7
+ * @format GUID
8
+ */
9
+ reservationId?: string;
10
+ /**
11
+ * Payment snapshot ID. Empty for the `FREE` order.
12
+ * @format GUID
13
+ * @readonly
14
+ */
15
+ snapshotId?: string;
16
+ /**
17
+ * Event ID to which the order belongs.
18
+ * @format GUID
19
+ */
20
+ eventId?: string;
21
+ /**
22
+ * Contact ID of buyer (resolved using email address).
23
+ * @format GUID
24
+ */
25
+ contactId?: string;
26
+ /**
27
+ * Buyer member ID, if applicable.
28
+ * @format GUID
29
+ */
30
+ memberId?: string;
31
+ /**
32
+ * RSVP created timestamp.
33
+ * @readonly
34
+ */
35
+ created?: Date | null;
36
+ /** Guest first name. */
37
+ firstName?: string;
38
+ /** Guest last name. */
39
+ lastName?: string;
40
+ /**
41
+ * Guest email.
42
+ * @format EMAIL
43
+ */
44
+ email?: string;
45
+ /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
46
+ checkoutForm?: FormResponse;
47
+ /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
48
+ confirmed?: boolean;
49
+ /**
50
+ * Order status. Possible values:
51
+ * - `FREE`: The order is confirmed, no payment is required.
52
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
53
+ * - `PAID`: The order is paid.
54
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
55
+ * - `INITIATED`: The order is awaiting for payment.
56
+ * - `CANCELED`: The order is canceled.
57
+ * - `DECLINED`: The order is payment is declined.
58
+ */
59
+ status?: OrderStatus;
60
+ /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
61
+ method?: string;
62
+ /** Quantity of ordered tickets. */
63
+ ticketsQuantity?: number;
64
+ /** Total order price. */
65
+ totalPrice?: Money;
66
+ /** Ticket PDF URL. */
67
+ ticketsPdf?: string;
68
+ /** Tickets (generated after payment). */
69
+ tickets?: TicketingTicket[];
70
+ /** Whether the order is archived. */
71
+ archived?: boolean;
72
+ /** Whether the order is anonymized by GDPR delete. */
73
+ anonymized?: boolean;
74
+ /** Guest full name. */
75
+ fullName?: string;
76
+ /** Order invoice. */
77
+ invoice?: Invoice;
78
+ /** Whether all tickets in order are checked-in. */
79
+ fullyCheckedIn?: boolean;
80
+ /** Internal order payment details */
81
+ paymentDetails?: PaymentDetails;
82
+ /** Checkout channel type */
83
+ channel?: ChannelType;
84
+ /**
85
+ * Order updated timestamp.
86
+ * @readonly
87
+ */
88
+ updated?: Date | null;
89
+ /** Whether marketing consent was given */
90
+ marketingConsent?: boolean | null;
91
+ }
92
+ export interface FormResponse {
93
+ /**
94
+ * Input fields for a checkout form.
95
+ * @maxSize 200
96
+ */
97
+ inputValues?: InputValue[];
98
+ }
99
+ export interface InputValue {
100
+ /**
101
+ * Input field name.
102
+ * @maxLength 100
103
+ */
104
+ inputName?: string;
105
+ /**
106
+ * Input field value.
107
+ * @maxLength 5000
108
+ */
109
+ value?: string;
110
+ /**
111
+ * Multiple input field values.
112
+ * @maxSize 100
113
+ * @maxLength 5000
114
+ */
115
+ values?: string[];
116
+ }
117
+ export interface FormattedAddress {
118
+ /**
119
+ * One line address representation.
120
+ * @maxLength 200
121
+ */
122
+ formatted?: string;
123
+ /** Address components (optional). */
124
+ address?: Address;
125
+ }
126
+ /** Physical address */
127
+ export interface Address extends AddressStreetOneOf {
128
+ /** Street name and number. */
129
+ streetAddress?: StreetAddress;
130
+ /** Main address line, usually street and number as free text. */
131
+ addressLine1?: string | null;
132
+ /**
133
+ * Country code.
134
+ * @format COUNTRY
135
+ */
136
+ country?: string | null;
137
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
138
+ subdivision?: string | null;
139
+ /** City name. */
140
+ city?: string | null;
141
+ /** Zip/postal code. */
142
+ postalCode?: string | null;
143
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
144
+ addressLine2?: string | null;
145
+ }
146
+ /** @oneof */
147
+ export interface AddressStreetOneOf {
148
+ /** Street name and number. */
149
+ streetAddress?: StreetAddress;
150
+ /** Main address line, usually street and number as free text. */
151
+ addressLine?: string | null;
152
+ }
153
+ export interface StreetAddress {
154
+ /** Street number. */
155
+ number?: string;
156
+ /** Street name. */
157
+ name?: string;
158
+ }
159
+ export interface AddressLocation {
160
+ /** Address latitude. */
161
+ latitude?: number | null;
162
+ /** Address longitude. */
163
+ longitude?: number | null;
164
+ }
165
+ export interface Subdivision {
166
+ /** Short subdivision code. */
167
+ code?: string;
168
+ /** Subdivision full name. */
169
+ name?: string;
170
+ }
171
+ export declare enum SubdivisionType {
172
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
173
+ /** State */
174
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
175
+ /** County */
176
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
177
+ /** City/town */
178
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
179
+ /** Neighborhood/quarter */
180
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
181
+ /** Street/block */
182
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
183
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
184
+ COUNTRY = "COUNTRY"
185
+ }
186
+ /** Subdivision Concordance values */
187
+ export interface StandardDetails {
188
+ /**
189
+ * 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
190
+ * @maxLength 20
191
+ */
192
+ iso31662?: string | null;
193
+ }
194
+ export declare enum OrderStatus {
195
+ /** Order status not available for this request fieldset. */
196
+ NA_ORDER_STATUS = "NA_ORDER_STATUS",
197
+ /** Order is confirmed and payment isn't required. */
198
+ FREE = "FREE",
199
+ /** Order is paid for but the payment gateway has suspended the payment. */
200
+ PENDING = "PENDING",
201
+ /** Order is paid via a payment gateway. */
202
+ PAID = "PAID",
203
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
204
+ OFFLINE_PENDING = "OFFLINE_PENDING",
205
+ /** Order is awaiting payment at the cashier. */
206
+ INITIATED = "INITIATED",
207
+ /** Order is canceled. */
208
+ CANCELED = "CANCELED",
209
+ /** Order payment is declined. */
210
+ DECLINED = "DECLINED",
211
+ /** Order payment is authorized. */
212
+ AUTHORIZED = "AUTHORIZED",
213
+ /** Order payment is voided. */
214
+ VOIDED = "VOIDED",
215
+ /** Order is partially paid with less than the total amount. */
216
+ PARTIALLY_PAID = "PARTIALLY_PAID"
217
+ }
218
+ export interface Money {
219
+ /**
220
+ * *Deprecated:** Use `value` instead.
221
+ * @format DECIMAL_VALUE
222
+ * @deprecated
223
+ */
224
+ amount?: string;
225
+ /**
226
+ * Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
227
+ * @format CURRENCY
228
+ */
229
+ currency?: string;
230
+ /**
231
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
232
+ * @format DECIMAL_VALUE
233
+ */
234
+ value?: string | null;
235
+ }
236
+ export interface TicketingTicket {
237
+ /** Unique ticket number (issued automatically). */
238
+ ticketNumber?: string;
239
+ /** Associated order number. */
240
+ orderNumber?: string;
241
+ /**
242
+ * Ticket definition ID.
243
+ * @format GUID
244
+ */
245
+ ticketDefinitionId?: string;
246
+ /** Ticket name. */
247
+ name?: string;
248
+ /** Ticket price. */
249
+ price?: Money;
250
+ /**
251
+ * Whether the ticket requires payment.
252
+ * @readonly
253
+ */
254
+ free?: boolean;
255
+ /** Event and ticket policies. */
256
+ policy?: string;
257
+ /**
258
+ * Deprecated, use `check_in_url`.
259
+ * @deprecated
260
+ */
261
+ qrCode?: string;
262
+ /** Ticket check-in. */
263
+ checkIn?: CheckIn;
264
+ /** Associated order status. */
265
+ orderStatus?: OrderStatus;
266
+ /** Whether order and ticket are visible in order list. */
267
+ orderArchived?: boolean;
268
+ /** Buyer full name. */
269
+ orderFullName?: string;
270
+ /** Guest full name. */
271
+ guestFullName?: string | null;
272
+ /** Guest personal details. */
273
+ guestDetails?: GuestDetails;
274
+ /** Whether ticket is visible in guest list. */
275
+ archived?: boolean;
276
+ /**
277
+ * Deprecated, use `ticket_pdf_url`.
278
+ * @deprecated
279
+ */
280
+ ticketPdf?: string;
281
+ /**
282
+ * Ticket owner member ID.
283
+ * @format GUID
284
+ */
285
+ memberId?: string | null;
286
+ /**
287
+ * Whether ticket was anonymized by GDPR delete.
288
+ * Anonymized tickets no longer contain personally identifiable information (PII).
289
+ */
290
+ anonymized?: boolean;
291
+ /**
292
+ * Ticket check-in URL.
293
+ * Shown as a QR code image in PDF.
294
+ * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`.
295
+ * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
296
+ */
297
+ checkInUrl?: string;
298
+ /** URL for ticket PDF download. */
299
+ ticketPdfUrl?: string;
300
+ /** Associated order checkout channel type */
301
+ channel?: ChannelType;
302
+ /**
303
+ * URL to download ticket in the `.pkpass` format for Apple Wallet
304
+ * @format WEB_URL
305
+ * @readonly
306
+ */
307
+ walletPassUrl?: string;
308
+ /**
309
+ * Whether ticket is canceled.
310
+ * @readonly
311
+ */
312
+ canceled?: boolean | null;
313
+ }
314
+ export interface CheckIn {
315
+ /** Time of check-in */
316
+ created?: Date | null;
317
+ }
318
+ export interface GuestDetails {
319
+ /** Whether ticket belongs to assigned guest. */
320
+ guestAssigned?: boolean;
321
+ /** Guest first name. */
322
+ firstName?: string | null;
323
+ /** Guest last name. */
324
+ lastName?: string | null;
325
+ /**
326
+ * Guest email.
327
+ * @format EMAIL
328
+ */
329
+ email?: string | null;
330
+ /** Full form response. */
331
+ form?: FormResponse;
332
+ /**
333
+ * Contact ID associated with this guest.
334
+ * @format GUID
335
+ */
336
+ contactId?: string | null;
337
+ /**
338
+ * Guest phone number.
339
+ * @format PHONE
340
+ */
341
+ phone?: string | null;
342
+ }
343
+ export declare enum ChannelType {
344
+ /** Buyer created the order via an online channel such as a website or mobile app. */
345
+ ONLINE = "ONLINE",
346
+ /** Sales person created the order and collected the money. */
347
+ OFFLINE_POS = "OFFLINE_POS"
348
+ }
349
+ export interface TicketDetails {
350
+ /**
351
+ * Unique seat id in the event venue.
352
+ * @minLength 1
353
+ * @maxLength 36
354
+ */
355
+ seatId?: string | null;
356
+ /**
357
+ * Optional sector label.
358
+ * @readonly
359
+ */
360
+ sectionLabel?: string | null;
361
+ /**
362
+ * Area label.
363
+ * @readonly
364
+ */
365
+ areaLabel?: string | null;
366
+ /**
367
+ * Table label.
368
+ * @readonly
369
+ */
370
+ tableLabel?: string | null;
371
+ /**
372
+ * Row label.
373
+ * @readonly
374
+ */
375
+ rowLabel?: string | null;
376
+ /**
377
+ * Seat label in a row or table.
378
+ * @readonly
379
+ */
380
+ seatLabel?: string | null;
381
+ /**
382
+ * Number of places in the spot. If not provided - defaults to 1.
383
+ * @min 1
384
+ * @max 50
385
+ */
386
+ capacity?: number | null;
387
+ /**
388
+ * Custom pricing of ticket.
389
+ * @format DECIMAL_VALUE
390
+ */
391
+ priceOverride?: string | null;
392
+ /**
393
+ * Pricing option id.
394
+ * @format GUID
395
+ */
396
+ pricingOptionId?: string | null;
397
+ /**
398
+ * Pricing option name.
399
+ * @readonly
400
+ */
401
+ pricingOptionName?: string | null;
402
+ }
403
+ export interface Invoice {
404
+ /** Items listed in the invoice. */
405
+ items?: Item[];
406
+ /**
407
+ * Total cart amount.
408
+ * @deprecated
409
+ */
410
+ total?: Money;
411
+ /** Discount applied to a cart. */
412
+ discount?: Discount;
413
+ /** Tax applied to cart. */
414
+ tax?: Tax;
415
+ /** Total cart amount before discount, tax, and fees. */
416
+ subTotal?: Money;
417
+ /**
418
+ * Total amount of cart after discount, tax, and fees.
419
+ * Grand total is calculated in the following order:
420
+ * 1. Total prices of all items in the cart are calculated.
421
+ * 2. Discount is subtracted from the cart (if applicable).
422
+ * 3. Tax is added (if applicable).
423
+ * 4. Wix ticket service fee is added.
424
+ */
425
+ grandTotal?: Money;
426
+ /**
427
+ * Fees applied to the cart.
428
+ * @readonly
429
+ */
430
+ fees?: Fee[];
431
+ /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
432
+ revenue?: Money;
433
+ /** Invoice preview URL. This value is only returned when the order is paid. */
434
+ previewUrl?: string | null;
435
+ }
436
+ export interface Item {
437
+ /**
438
+ * Unique line item ID.
439
+ * @format GUID
440
+ */
441
+ _id?: string;
442
+ /**
443
+ * Line item quantity.
444
+ * @min 1
445
+ * @max 50
446
+ */
447
+ quantity?: number;
448
+ /** Line item name. */
449
+ name?: string;
450
+ /** Line item price. */
451
+ price?: Money;
452
+ /** Total price for line items. It's calculated by multiplying price and item quantity. */
453
+ total?: Money;
454
+ /** Discount applied to the line item. */
455
+ discount?: Discount;
456
+ /** Tax applied to the item. */
457
+ tax?: Tax;
458
+ /**
459
+ * Fees applied to the item.
460
+ * @readonly
461
+ */
462
+ fees?: Fee[];
463
+ }
464
+ export interface Discount {
465
+ /** Total discount amount. */
466
+ amount?: Money;
467
+ /** Total sum after the discount. */
468
+ afterDiscount?: Money;
469
+ /**
470
+ * Discount coupon code.
471
+ * @deprecated
472
+ */
473
+ code?: string;
474
+ /**
475
+ * Discount coupon name.
476
+ * @deprecated
477
+ */
478
+ name?: string;
479
+ /**
480
+ * Discount coupon ID.
481
+ * @deprecated
482
+ */
483
+ couponId?: string;
484
+ /** Discount items. */
485
+ discounts?: DiscountItem[];
486
+ }
487
+ export interface DiscountItem extends DiscountItemDiscountOneOf {
488
+ /** Coupon discount. */
489
+ coupon?: CouponDiscount;
490
+ /** Pricing plan discount. */
491
+ paidPlan?: PaidPlanDiscount;
492
+ /** Total discount amount. */
493
+ amount?: Money;
494
+ }
495
+ /** @oneof */
496
+ export interface DiscountItemDiscountOneOf {
497
+ /** Coupon discount. */
498
+ coupon?: CouponDiscount;
499
+ /** Pricing plan discount. */
500
+ paidPlan?: PaidPlanDiscount;
501
+ }
502
+ export interface CouponDiscount {
503
+ /** Discount coupon name. */
504
+ name?: string;
505
+ /** Discount coupon code. */
506
+ code?: string;
507
+ /** Discount coupon ID. */
508
+ couponId?: string;
509
+ }
510
+ export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
511
+ /** Discount by percentage applied to tickets. */
512
+ percentDiscount?: PercentDiscount;
513
+ /** Name of pricing plan. */
514
+ name?: string;
515
+ }
516
+ /** @oneof */
517
+ export interface PaidPlanDiscountDiscountOneOf {
518
+ /** Discount by percentage applied to tickets. */
519
+ percentDiscount?: PercentDiscount;
520
+ }
521
+ export interface PercentDiscount {
522
+ /**
523
+ * Percent rate.
524
+ * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
525
+ */
526
+ rate?: string;
527
+ /** Number of discounted tickets. */
528
+ quantityDiscounted?: number;
529
+ }
530
+ export interface Tax {
531
+ /** Tax type. */
532
+ type?: TaxType;
533
+ /**
534
+ * Tax name.
535
+ * @readonly
536
+ */
537
+ name?: string;
538
+ /**
539
+ * Tax rate.
540
+ * @format DECIMAL_VALUE
541
+ */
542
+ rate?: string;
543
+ /** Taxable amount. */
544
+ taxable?: Money;
545
+ /** Total tax amount. */
546
+ amount?: Money;
547
+ }
548
+ export declare enum TaxType {
549
+ /** Tax is included in the ticket price. */
550
+ INCLUDED = "INCLUDED",
551
+ /** Tax is added to the order at the checkout. */
552
+ ADDED = "ADDED",
553
+ /** Tax is added to the final total at the checkout. */
554
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
555
+ }
556
+ export interface Fee {
557
+ /** Fee identifier. */
558
+ name?: FeeName;
559
+ /** How fee is calculated. */
560
+ type?: FeeType;
561
+ /**
562
+ * Fee rate.
563
+ * @format DECIMAL_VALUE
564
+ * @readonly
565
+ */
566
+ rate?: string;
567
+ /** Total amount of fee charges. */
568
+ amount?: Money;
569
+ }
570
+ export declare enum FeeName {
571
+ /** Wix ticket service fee charges applied to the line item. */
572
+ WIX_FEE = "WIX_FEE"
573
+ }
574
+ export declare enum FeeType {
575
+ /** Fee is added to the ticket price at checkout. */
576
+ FEE_ADDED = "FEE_ADDED",
577
+ /** Seller absorbs the fee. It is deducted from the ticket price. */
578
+ FEE_INCLUDED = "FEE_INCLUDED",
579
+ /** Fee is added to the ticket price at checkout. */
580
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
581
+ }
582
+ export interface PaymentDetails {
583
+ /** Wix Payments transaction */
584
+ transaction?: PaymentTransaction;
585
+ }
586
+ export interface PaymentTransaction {
587
+ /**
588
+ * Wix Payments transaction id
589
+ * @format GUID
590
+ * @readonly
591
+ */
592
+ transactionId?: string;
593
+ /**
594
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
595
+ * @readonly
596
+ */
597
+ method?: string;
598
+ }
599
+ export declare enum ScheduledActionEnumAction {
600
+ /** Action not scheduled. */
601
+ UNKNOWN_ACTION = "UNKNOWN_ACTION",
602
+ /** Captured after the delay. */
603
+ CAPTURE = "CAPTURE",
604
+ /** Void after the delay. */
605
+ VOID = "VOID"
606
+ }
607
+ export declare enum Action {
608
+ /** Order can be archived. */
609
+ ARCHIVE = "ARCHIVE",
610
+ /** Order can be unarchived. */
611
+ UNARCHIVE = "UNARCHIVE",
612
+ /** Order can be confirmed. */
613
+ CONFIRM = "CONFIRM",
614
+ /** Order can be captured. */
615
+ CAPTURE = "CAPTURE",
616
+ /** Order can be voided. */
617
+ VOID = "VOID"
618
+ }
619
+ export interface GiftCardPaymentDetails {
620
+ /**
621
+ * Gift card payment id.
622
+ * @format GUID
623
+ */
624
+ giftCardPaymentId?: string | null;
625
+ /**
626
+ * ID of the app that created the gift card.
627
+ * @format GUID
628
+ */
629
+ appId?: string | null;
630
+ /** Whether the gift card payment is voided. */
631
+ voided?: boolean | null;
632
+ /** Amount */
633
+ amount?: Money;
634
+ /**
635
+ * Obfuscated gift card code.
636
+ * @maxLength 30
637
+ */
638
+ obfuscatedCode?: string | null;
639
+ }
640
+ export interface BalanceSummary {
641
+ /** Amount left to pay. */
642
+ balance?: Money;
643
+ }
644
+ export interface OrderDeleted {
645
+ /** Order deleted timestamp in ISO UTC format. */
646
+ timestamp?: Date | null;
647
+ /**
648
+ * Event ID to which the order belongs.
649
+ * @format GUID
650
+ */
651
+ eventId?: string;
652
+ /** Unique order number. */
653
+ orderNumber?: string;
654
+ /** Contact ID associated with this order */
655
+ contactId?: string;
656
+ /**
657
+ * Member ID associated with this order.
658
+ * @format GUID
659
+ */
660
+ memberId?: string | null;
661
+ /**
662
+ * Order created timestamp.
663
+ * @readonly
664
+ */
665
+ created?: Date | null;
666
+ /**
667
+ * Order updated timestamp.
668
+ * @readonly
669
+ */
670
+ updated?: Date | null;
671
+ /** Whether order was anonymized by GDPR delete. */
672
+ anonymized?: boolean;
673
+ /** Order type. */
674
+ orderType?: OrderType;
675
+ /** Whether event was triggered by GDPR delete request. */
676
+ triggeredByAnonymizeRequest?: boolean;
677
+ /** Tickets generated after payment. */
678
+ tickets?: Ticket[];
679
+ }
680
+ export declare enum OrderType {
681
+ /** Buyer form is used for all tickets. */
682
+ UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
683
+ /** Each order ticket has its own form. */
684
+ ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
685
+ }
686
+ export interface Ticket {
687
+ /** Unique issued ticket number. */
688
+ ticketNumber?: string;
689
+ /**
690
+ * Ticket definition ID.
691
+ * @format GUID
692
+ */
693
+ ticketDefinitionId?: string;
694
+ /** Ticket check-in. */
695
+ checkIn?: CheckIn;
696
+ /** Ticket price. */
697
+ price?: Money;
698
+ /** Whether ticket is archived. */
699
+ archived?: boolean;
700
+ /** Guest first name. */
701
+ firstName?: string | null;
702
+ /** Guest last name. */
703
+ lastName?: string | null;
704
+ /** Guest email. */
705
+ email?: string | null;
706
+ /**
707
+ * Contact ID associated with this ticket.
708
+ * @format GUID
709
+ */
710
+ contactId?: string | null;
711
+ /** Whether ticket is confirmed */
712
+ confirmed?: boolean;
713
+ /**
714
+ * Member ID associated with this ticket.
715
+ * @format GUID
716
+ */
717
+ memberId?: string | null;
718
+ /** Ticket form response (only assigned tickets contain separate forms). */
719
+ form?: FormResponse;
720
+ /** Ticket name. */
721
+ ticketName?: string;
722
+ /** Anonymized tickets no longer contain personally identifiable information (PII). */
723
+ anonymized?: boolean;
724
+ /** URL and password to online conference */
725
+ onlineConferencingLogin?: OnlineConferencingLogin;
726
+ /**
727
+ * Seat ID associated with this ticket.
728
+ * @maxLength 36
729
+ */
730
+ seatId?: string | null;
731
+ /** Whether ticket is canceled. */
732
+ canceled?: boolean | null;
733
+ }
734
+ export interface OnlineConferencingLogin {
735
+ /**
736
+ * Link URL to the online conference.
737
+ * @format WEB_URL
738
+ * @readonly
739
+ */
740
+ link?: string;
741
+ /**
742
+ * Password for the online conference.
743
+ * @readonly
744
+ */
745
+ password?: string | null;
746
+ }
747
+ export interface ListOrdersRequest {
748
+ /** Offset. */
749
+ offset?: number;
750
+ /**
751
+ * Limit.
752
+ * @max 400
753
+ */
754
+ limit?: number;
755
+ /**
756
+ * Predefined sets of fields to return.
757
+ * - `TICKETS`: Returns `tickets`.
758
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
759
+ * - `FORM` : Returns `checkoutForm`.
760
+ * - `INVOICE`: Returns `invoice`.
761
+ *
762
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
763
+ *
764
+ * @maxSize 20
765
+ */
766
+ fieldset?: OrderFieldset[];
767
+ /**
768
+ * Order status. Possible values:
769
+ * - `FREE`: The order is confirmed, no payment is required.
770
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
771
+ * - `PAID`: The order is paid.
772
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
773
+ * - `INITIATED`: The order is awaiting for payment.
774
+ * - `CANCELED`: The order is canceled.
775
+ * - `DECLINED`: The order is payment is declined.
776
+ */
777
+ status?: OrderStatus[];
778
+ /**
779
+ * Event ID to which the order belongs.
780
+ * @format GUID
781
+ * @maxSize 100
782
+ */
783
+ eventId?: string[];
784
+ /**
785
+ * Order number.
786
+ * @maxLength 36
787
+ * @maxSize 500
788
+ */
789
+ orderNumber?: string[];
790
+ /**
791
+ * Site member ID.
792
+ * @format GUID
793
+ * @maxSize 500
794
+ */
795
+ memberId?: string[];
796
+ /**
797
+ * Field facets,
798
+ * @maxLength 100
799
+ * @maxSize 20
800
+ */
801
+ facet?: string[];
802
+ /**
803
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
804
+ * @maxLength 200
805
+ */
806
+ searchPhrase?: string;
807
+ /**
808
+ * Event creator ID.
809
+ * @format GUID
810
+ * @maxSize 50
811
+ */
812
+ eventCreatorId?: string[];
813
+ /**
814
+ * Sort order.
815
+ * Default: `created:asc`.
816
+ * @maxLength 100
817
+ */
818
+ sort?: string;
819
+ /** Order tag. */
820
+ tag?: OrderTag[];
821
+ /**
822
+ * Guest contact IDs.
823
+ * @format GUID
824
+ * @maxSize 100
825
+ */
826
+ contactId?: string[];
827
+ }
828
+ export declare enum OrderFieldset {
829
+ /** Include tickets in response. */
830
+ TICKETS = "TICKETS",
831
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
832
+ DETAILS = "DETAILS",
833
+ /** Include `checkoutForm` in the response. */
834
+ FORM = "FORM",
835
+ /** Include `invoice` in the response. */
836
+ INVOICE = "INVOICE"
837
+ }
838
+ export declare enum OrderTag {
839
+ /** Return only confirmed orders. */
840
+ CONFIRMED = "CONFIRMED",
841
+ /** Return only unconfirmed orders. */
842
+ UNCONFIRMED = "UNCONFIRMED",
843
+ /** Return only member orders. */
844
+ MEMBER = "MEMBER",
845
+ /** Return only archived orders. */
846
+ ARCHIVED = "ARCHIVED",
847
+ /** Return only non archived orders. */
848
+ NON_ARCHIVED = "NON_ARCHIVED",
849
+ /** Return only orders with all guests checked-in. */
850
+ FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
851
+ /** Return only orders with no guests checked-in. */
852
+ NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
853
+ }
854
+ export interface ListOrdersResponse {
855
+ /** Total orders matching the given filters. */
856
+ total?: number;
857
+ /** Offset. */
858
+ offset?: number;
859
+ /**
860
+ * Limit.
861
+ * @max 100
862
+ */
863
+ limit?: number;
864
+ /** Orders. */
865
+ orders?: Order[];
866
+ /** Filter facets. */
867
+ facets?: Record<string, FacetCounts>;
868
+ /** Order data enriched facets. */
869
+ orderFacets?: OrderFacets;
870
+ }
871
+ export interface FacetCounts {
872
+ /** Facet counts aggregated per value. */
873
+ counts?: Record<string, number>;
874
+ }
875
+ export interface OrderFacets {
876
+ /** Filter facets. */
877
+ facets?: Record<string, OrderFacetCounts>;
878
+ }
879
+ export interface OrderFacetCounts {
880
+ /** Facet counts aggregated per value */
881
+ counts?: Record<string, Counts>;
882
+ }
883
+ export interface Counts {
884
+ /** Number or orders */
885
+ count?: number;
886
+ /** Number of tickets within orders */
887
+ tickets?: number;
888
+ /** Number of tickets with check-in */
889
+ ticketsCheckIn?: number;
890
+ }
891
+ export interface GetOrderRequest {
892
+ /**
893
+ * Event ID to which the order belongs.
894
+ * @format GUID
895
+ */
896
+ eventId: string;
897
+ /**
898
+ * Unique order number.
899
+ * @maxLength 36
900
+ */
901
+ orderNumber: string;
902
+ /**
903
+ * Predefined sets of fields to return.
904
+ * - `TICKETS`: Returns `tickets`.
905
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
906
+ * - `FORM` : Returns `checkoutForm`.
907
+ * - `INVOICE`: Returns `invoice`.
908
+ *
909
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
910
+ *
911
+ * @maxSize 20
912
+ */
913
+ fieldset?: OrderFieldset[];
914
+ }
915
+ export interface GetOrderResponse {
916
+ /** Requested order. */
917
+ order?: Order;
918
+ /** "Add to calendar" links. */
919
+ calendarLinks?: CalendarLinks;
920
+ }
921
+ export interface CalendarLinks {
922
+ /** "Add to Google calendar" URL. */
923
+ google?: string;
924
+ /** "Download ICS calendar file" URL. */
925
+ ics?: string;
926
+ }
927
+ export interface UpdateOrderRequest {
928
+ /**
929
+ * Event ID to which the order belongs.
930
+ * @format GUID
931
+ */
932
+ eventId: string;
933
+ /**
934
+ * Unique order number.
935
+ * @maxLength 36
936
+ */
937
+ orderNumber: string;
938
+ /** Set of field paths to update. */
939
+ fields?: string[];
940
+ /** Checkout form. */
941
+ checkoutForm?: FormResponse;
942
+ /** Whether order is archived. */
943
+ archived?: boolean;
944
+ }
945
+ export interface UpdateOrderResponse {
946
+ /** Updated order. */
947
+ order?: Order;
948
+ }
949
+ export interface OrderUpdated {
950
+ /** Order updated timestamp in ISO UTC format. */
951
+ timestamp?: Date | null;
952
+ /**
953
+ * Site language when Order initiated
954
+ * @format LANGUAGE
955
+ */
956
+ language?: string | null;
957
+ /**
958
+ * Locale in which Order was created.
959
+ * @format LANGUAGE_TAG
960
+ */
961
+ locale?: string | null;
962
+ /**
963
+ * Event ID to which the order belongs.
964
+ * @format GUID
965
+ */
966
+ eventId?: string;
967
+ /** Unique order number. */
968
+ orderNumber?: string;
969
+ /** Contact ID associated with this order. */
970
+ contactId?: string;
971
+ /**
972
+ * Member ID associated with this order.
973
+ * @format GUID
974
+ */
975
+ memberId?: string | null;
976
+ /**
977
+ * Order created timestamp.
978
+ * @readonly
979
+ */
980
+ created?: Date | null;
981
+ /**
982
+ * Order updated timestamp.
983
+ * @readonly
984
+ */
985
+ updated?: Date | null;
986
+ /** Buyer first name. */
987
+ firstName?: string;
988
+ /** Buyer last name. */
989
+ lastName?: string;
990
+ /** Buyer email. */
991
+ email?: string;
992
+ /** Checkout form response. */
993
+ checkoutForm?: FormResponse;
994
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
995
+ confirmed?: boolean;
996
+ /**
997
+ * Order status. Possible values:
998
+ * - `FREE`: The order is confirmed, no payment is required.
999
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
1000
+ * - `PAID`: The order is paid.
1001
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
1002
+ * - `INITIATED`: The order is awaiting for payment.
1003
+ * - `CANCELED`: The order is canceled.
1004
+ * - `DECLINED`: The order is payment is declined.
1005
+ */
1006
+ status?: OrderStatus;
1007
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1008
+ method?: string | null;
1009
+ /** Tickets generated after payment. */
1010
+ tickets?: Ticket[];
1011
+ /** Whether order was archived and excluded from results. */
1012
+ archived?: boolean;
1013
+ /** Whether event was triggered by GDPR delete request. */
1014
+ triggeredByAnonymizeRequest?: boolean;
1015
+ }
1016
+ export interface BulkUpdateOrdersRequest {
1017
+ /**
1018
+ * Event ID to which the order belongs.
1019
+ * @format GUID
1020
+ */
1021
+ eventId: string;
1022
+ /**
1023
+ * @minLength 1
1024
+ * @maxLength 36
1025
+ * @minSize 1
1026
+ * @maxSize 100
1027
+ */
1028
+ orderNumber?: string[];
1029
+ /** Set of fields to update. */
1030
+ fields?: string[];
1031
+ /** Whether to archive the order. */
1032
+ archived?: boolean;
1033
+ }
1034
+ export interface BulkUpdateOrdersResponse {
1035
+ /** Updated orders. */
1036
+ orders?: Order[];
1037
+ }
1038
+ export interface ConfirmOrderRequest {
1039
+ /**
1040
+ * Event ID to which the order belongs.
1041
+ * @format GUID
1042
+ */
1043
+ eventId: string;
1044
+ /**
1045
+ * Order numbers.
1046
+ * @minLength 1
1047
+ * @maxLength 36
1048
+ * @maxSize 100
1049
+ */
1050
+ orderNumber?: string[];
1051
+ }
1052
+ export interface ConfirmOrderResponse {
1053
+ /** Confirmed orders. */
1054
+ orders?: Order[];
1055
+ }
1056
+ export interface GetSummaryRequest {
1057
+ /**
1058
+ * Event ID.
1059
+ * @format GUID
1060
+ */
1061
+ eventId?: string | null;
1062
+ }
1063
+ export interface GetSummaryResponse {
1064
+ /** Ticket sales grouped by currency. */
1065
+ sales?: TicketSales[];
1066
+ }
1067
+ export interface TicketSales {
1068
+ /** Total balance of confirmed transactions. */
1069
+ total?: Money;
1070
+ /** Total number of confirmed orders. */
1071
+ totalOrders?: number;
1072
+ /** Total number of tickets purchased. */
1073
+ totalTickets?: number;
1074
+ /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
1075
+ revenue?: Money;
1076
+ }
1077
+ export interface GetInvoicePreviewRequest {
1078
+ /**
1079
+ * Event ID to which the invoice belongs.
1080
+ * @format GUID
1081
+ */
1082
+ eventId?: string;
1083
+ /** Order number. */
1084
+ orderNumber?: string;
1085
+ }
1086
+ export interface RawHttpResponse {
1087
+ body?: Uint8Array;
1088
+ statusCode?: number | null;
1089
+ headers?: HeadersEntry[];
1090
+ }
1091
+ export interface HeadersEntry {
1092
+ key?: string;
1093
+ value?: string;
1094
+ }
1095
+ export interface GetPaymentInfoRequest {
1096
+ /**
1097
+ * Event ID.
1098
+ * @format GUID
1099
+ */
1100
+ eventId?: string;
1101
+ /** Order number. */
1102
+ orderNumber?: string;
1103
+ }
1104
+ export interface GetPaymentInfoResponse {
1105
+ transactions?: PaymentTransactionSummary[];
1106
+ status?: string | null;
1107
+ /**
1108
+ * @format GUID
1109
+ * @readonly
1110
+ */
1111
+ transactionId?: string | null;
1112
+ }
1113
+ export interface PaymentTransactionSummary {
1114
+ /**
1115
+ * Wix Payments transaction id
1116
+ * @format GUID
1117
+ * @readonly
1118
+ */
1119
+ transactionId?: string;
1120
+ /**
1121
+ * Final transaction status
1122
+ * @readonly
1123
+ */
1124
+ finalTransactionStatus?: string;
1125
+ /** Transaction events */
1126
+ events?: PaymentTransactionEvent[];
1127
+ }
1128
+ export interface PaymentTransactionEvent {
1129
+ /**
1130
+ * Order snapshot id
1131
+ * @format GUID
1132
+ * @readonly
1133
+ */
1134
+ snapshotId?: string;
1135
+ /**
1136
+ * Transaction status
1137
+ * @readonly
1138
+ */
1139
+ transactionStatus?: string;
1140
+ /**
1141
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
1142
+ * @readonly
1143
+ */
1144
+ paymentMethod?: string;
1145
+ /**
1146
+ * Transaction payment amount
1147
+ * @readonly
1148
+ */
1149
+ paymentAmount?: Money;
1150
+ /**
1151
+ * Crated date
1152
+ * @readonly
1153
+ */
1154
+ _createdDate?: Date | null;
1155
+ /**
1156
+ * Reason code
1157
+ * @readonly
1158
+ */
1159
+ reasonCode?: string | null;
1160
+ /**
1161
+ * Refunded amount
1162
+ * @readonly
1163
+ */
1164
+ refundedAmount?: Money;
1165
+ }
1166
+ export interface CaptureAuthorizedPaymentRequest {
1167
+ /**
1168
+ * Event ID.
1169
+ * @format GUID
1170
+ */
1171
+ eventId?: string;
1172
+ /**
1173
+ * Order number.
1174
+ * @minLength 1
1175
+ * @maxLength 36
1176
+ */
1177
+ orderNumber: string;
1178
+ }
1179
+ export interface CaptureAuthorizedPaymentResponse {
1180
+ }
1181
+ export interface VoidAuthorizedPaymentRequest {
1182
+ /**
1183
+ * Event ID.
1184
+ * @format GUID
1185
+ */
1186
+ eventId?: string;
1187
+ /**
1188
+ * Order number.
1189
+ * @minLength 1
1190
+ * @maxLength 36
1191
+ */
1192
+ orderNumber: string;
1193
+ }
1194
+ export interface VoidAuthorizedPaymentResponse {
1195
+ }
1196
+ export interface MessageEnvelope {
1197
+ /**
1198
+ * App instance ID.
1199
+ * @format GUID
1200
+ */
1201
+ instanceId?: string | null;
1202
+ /**
1203
+ * Event type.
1204
+ * @maxLength 150
1205
+ */
1206
+ eventType?: string;
1207
+ /** The identification type and identity data. */
1208
+ identity?: IdentificationData;
1209
+ /** Stringify payload. */
1210
+ data?: string;
1211
+ }
1212
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1213
+ /**
1214
+ * ID of a site visitor that has not logged in to the site.
1215
+ * @format GUID
1216
+ */
1217
+ anonymousVisitorId?: string;
1218
+ /**
1219
+ * ID of a site visitor that has logged in to the site.
1220
+ * @format GUID
1221
+ */
1222
+ memberId?: string;
1223
+ /**
1224
+ * ID of a Wix user (site owner, contributor, etc.).
1225
+ * @format GUID
1226
+ */
1227
+ wixUserId?: string;
1228
+ /**
1229
+ * ID of an app.
1230
+ * @format GUID
1231
+ */
1232
+ appId?: string;
1233
+ /** @readonly */
1234
+ identityType?: WebhookIdentityType;
1235
+ }
1236
+ /** @oneof */
1237
+ export interface IdentificationDataIdOneOf {
1238
+ /**
1239
+ * ID of a site visitor that has not logged in to the site.
1240
+ * @format GUID
1241
+ */
1242
+ anonymousVisitorId?: string;
1243
+ /**
1244
+ * ID of a site visitor that has logged in to the site.
1245
+ * @format GUID
1246
+ */
1247
+ memberId?: string;
1248
+ /**
1249
+ * ID of a Wix user (site owner, contributor, etc.).
1250
+ * @format GUID
1251
+ */
1252
+ wixUserId?: string;
1253
+ /**
1254
+ * ID of an app.
1255
+ * @format GUID
1256
+ */
1257
+ appId?: string;
1258
+ }
1259
+ export declare enum WebhookIdentityType {
1260
+ UNKNOWN = "UNKNOWN",
1261
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1262
+ MEMBER = "MEMBER",
1263
+ WIX_USER = "WIX_USER",
1264
+ APP = "APP"
1265
+ }
1266
+ export interface OrderConfirmed {
1267
+ /** Order confirmation timestamp in ISO UTC. */
1268
+ timestamp?: Date | null;
1269
+ /**
1270
+ * Site language when Order initiated
1271
+ * @format LANGUAGE
1272
+ */
1273
+ language?: string | null;
1274
+ /** Notifications silenced for this domain event. */
1275
+ silent?: boolean | null;
1276
+ /**
1277
+ * Locale in which Order was created.
1278
+ * @format LANGUAGE_TAG
1279
+ */
1280
+ locale?: string | null;
1281
+ /**
1282
+ * Event ID to which the order belongs.
1283
+ * @format GUID
1284
+ */
1285
+ eventId?: string;
1286
+ /** Unique order number. */
1287
+ orderNumber?: string;
1288
+ /** Contact ID associated with this order. */
1289
+ contactId?: string;
1290
+ /**
1291
+ * Member ID associated with this order.
1292
+ * @format GUID
1293
+ */
1294
+ memberId?: string | null;
1295
+ /**
1296
+ * Order created timestamp
1297
+ * @readonly
1298
+ */
1299
+ created?: Date | null;
1300
+ /** Buyer first name. */
1301
+ firstName?: string;
1302
+ /** Buyer last name. */
1303
+ lastName?: string;
1304
+ /** Buyer email address. */
1305
+ email?: string;
1306
+ /** Checkout form response. */
1307
+ checkoutForm?: FormResponse;
1308
+ /**
1309
+ * Order status. Possible values:
1310
+ * - `FREE`: The order is confirmed, no payment is required.
1311
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
1312
+ * - `PAID`: The order is paid.
1313
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
1314
+ * - `INITIATED`: The order is awaiting for payment.
1315
+ * - `CANCELED`: The order is canceled.
1316
+ * - `DECLINED`: The order is payment is declined.
1317
+ */
1318
+ status?: OrderStatus;
1319
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1320
+ method?: string | null;
1321
+ /** Tickets (generated after payment). */
1322
+ tickets?: Ticket[];
1323
+ /** Invoice. */
1324
+ invoice?: Invoice;
1325
+ /** Reservation ID associated with this order. */
1326
+ reservationId?: string;
1327
+ }
1328
+ export interface OrderPaid {
1329
+ /** Order paid timestamp in ISO UTC. */
1330
+ timestamp?: Date | null;
1331
+ /**
1332
+ * Site language when Order initiated
1333
+ * @format LANGUAGE
1334
+ */
1335
+ language?: string | null;
1336
+ /** Notifications silenced for this domain event. */
1337
+ silent?: boolean | null;
1338
+ /**
1339
+ * Locale in which Order was created.
1340
+ * @format LANGUAGE_TAG
1341
+ */
1342
+ locale?: string | null;
1343
+ /**
1344
+ * Event ID to which the order belongs.
1345
+ * @format GUID
1346
+ */
1347
+ eventId?: string;
1348
+ /** Unique order number. */
1349
+ orderNumber?: string;
1350
+ /** Reservation ID associated with this order. */
1351
+ reservationId?: string;
1352
+ /**
1353
+ * Contact ID associated with this order.
1354
+ * @maxLength 36
1355
+ */
1356
+ contactId?: string;
1357
+ /**
1358
+ * Member ID associated with this order.
1359
+ * @format GUID
1360
+ */
1361
+ memberId?: string | null;
1362
+ /**
1363
+ * Order created timestamp
1364
+ * @readonly
1365
+ */
1366
+ created?: Date | null;
1367
+ /**
1368
+ * Buyer first name.
1369
+ * @maxLength 255
1370
+ */
1371
+ firstName?: string;
1372
+ /**
1373
+ * Buyer last name.
1374
+ * @maxLength 255
1375
+ */
1376
+ lastName?: string;
1377
+ /**
1378
+ * Buyer email address.
1379
+ * @maxLength 255
1380
+ */
1381
+ email?: string;
1382
+ /** Checkout form response. */
1383
+ checkoutForm?: FormResponse;
1384
+ /** Order status. */
1385
+ status?: OrderStatus;
1386
+ /**
1387
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1388
+ * @maxLength 255
1389
+ */
1390
+ method?: string | null;
1391
+ /**
1392
+ * Tickets (generated after payment).
1393
+ * @maxSize 50
1394
+ */
1395
+ tickets?: Ticket[];
1396
+ /** Invoice. */
1397
+ invoice?: Invoice;
1398
+ }
1399
+ export interface ReservationCreated {
1400
+ /** Reservation created timestamp in ISO UTC format. */
1401
+ timestamp?: Date | null;
1402
+ /**
1403
+ * Event ID to which the reservation belongs.
1404
+ * @format GUID
1405
+ */
1406
+ eventId?: string;
1407
+ /**
1408
+ * Reservation ID.
1409
+ * Can be used to retrieve a reservation invoice.
1410
+ * @format GUID
1411
+ */
1412
+ reservationId?: string;
1413
+ /** Reservation expiration timestamp. */
1414
+ expires?: Date | null;
1415
+ /** Reservation status. */
1416
+ status?: ReservationStatus;
1417
+ /**
1418
+ * Reservation ticket quantities.
1419
+ * @maxSize 50
1420
+ */
1421
+ quantities?: TicketQuantity[];
1422
+ /** Reservation update timestamp. */
1423
+ _updatedDate?: Date | null;
1424
+ /**
1425
+ * Reservation counts.
1426
+ * @maxSize 50
1427
+ */
1428
+ counts?: ReservationCount[];
1429
+ }
1430
+ export declare enum ReservationStatus {
1431
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
1432
+ RESERVATION_PENDING = "RESERVATION_PENDING",
1433
+ /** The reservation is confirmed and will not expire. */
1434
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
1435
+ /** The reservation is canceled because of non payment. */
1436
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
1437
+ /** The reservation is canceled manually by the buyer. */
1438
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
1439
+ /** The reservation is expired. */
1440
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1441
+ }
1442
+ export interface TicketQuantity {
1443
+ /**
1444
+ * Ticket definition ID.
1445
+ * @format GUID
1446
+ */
1447
+ ticketDefinitionId?: string | null;
1448
+ /** Quantity. */
1449
+ quantity?: number | null;
1450
+ /** Quantity update timestamp. */
1451
+ _updatedDate?: Date | null;
1452
+ }
1453
+ export interface ReservationCount {
1454
+ /** Reservation Count snapshot timestamp. */
1455
+ timestamp?: Date | null;
1456
+ /**
1457
+ * Ticket Definition ID.
1458
+ * @format GUID
1459
+ */
1460
+ ticketDefinitionId?: string;
1461
+ /** Confirmed reservation count. */
1462
+ confirmedCount?: number;
1463
+ /** Pending reservation count. */
1464
+ pendingCount?: number;
1465
+ /** True if paid ticket reservation exist. */
1466
+ paidExists?: boolean;
1467
+ }
1468
+ export interface ReservationUpdated {
1469
+ /** Reservation updated timestamp. */
1470
+ timestamp?: Date | null;
1471
+ /**
1472
+ * Event ID to which the reservation belongs.
1473
+ * @format GUID
1474
+ */
1475
+ eventId?: string;
1476
+ /**
1477
+ * Reservation ID.
1478
+ * Can be used to retrieve a reservation invoice.
1479
+ * @format GUID
1480
+ */
1481
+ reservationId?: string;
1482
+ /** Reservation status. */
1483
+ status?: ReservationStatus;
1484
+ /** Reservation expiration timestamp. */
1485
+ expires?: Date | null;
1486
+ /**
1487
+ * Reservation ticket quantities.
1488
+ * @maxSize 50
1489
+ */
1490
+ quantities?: TicketQuantity[];
1491
+ /** Reservation update timestamp. */
1492
+ _updatedDate?: Date | null;
1493
+ /**
1494
+ * Reservation counts.
1495
+ * @maxSize 50
1496
+ */
1497
+ counts?: ReservationCount[];
1498
+ }
1499
+ export interface GetCheckoutOptionsRequest {
1500
+ }
1501
+ export interface GetCheckoutOptionsResponse {
1502
+ /** Whether any payment method is configured and available for payment. */
1503
+ paymentMethodConfigured?: boolean;
1504
+ /** Whether coupons are accepted at checkout. */
1505
+ acceptCoupons?: boolean;
1506
+ /** 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". */
1507
+ premiumServices?: boolean;
1508
+ /** Whether there are any paid tickets available for sale. */
1509
+ paidTickets?: boolean;
1510
+ /** Whether gift cards are accepted at checkout. */
1511
+ acceptGiftCards?: boolean;
1512
+ }
1513
+ export interface ListAvailableTicketsRequest {
1514
+ /**
1515
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
1516
+ * @format GUID
1517
+ */
1518
+ eventId?: string;
1519
+ /** Offset. */
1520
+ offset?: number;
1521
+ /**
1522
+ * Limit.
1523
+ * @max 100
1524
+ */
1525
+ limit?: number;
1526
+ /**
1527
+ * Sort order.
1528
+ * Default: `created:asc`.
1529
+ * @maxLength 100
1530
+ */
1531
+ sort?: string;
1532
+ state?: State[];
1533
+ }
1534
+ export declare enum State {
1535
+ INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
1536
+ }
1537
+ export interface ListAvailableTicketsResponse {
1538
+ /** Ticket definitions meta data. */
1539
+ metaData?: ResponseMetaData;
1540
+ /** Ticket definitions. */
1541
+ definitions?: TicketDefinition[];
1542
+ }
1543
+ export interface ResponseMetaData {
1544
+ /** Number of items in the response. */
1545
+ count?: number;
1546
+ /** Offset of items. */
1547
+ offset?: number;
1548
+ /** Total number of matching items. */
1549
+ total?: number;
1550
+ }
1551
+ export interface TicketDefinition {
1552
+ /**
1553
+ * Ticket definition ID.
1554
+ * @format GUID
1555
+ */
1556
+ _id?: string;
1557
+ /** Ticket price. */
1558
+ price?: Money;
1559
+ /** Whether the ticket is free (read only). */
1560
+ free?: boolean;
1561
+ /** Ticket name. */
1562
+ name?: string;
1563
+ /** Ticket description. */
1564
+ description?: string;
1565
+ /**
1566
+ * Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets.
1567
+ * @max 20
1568
+ */
1569
+ limitPerCheckout?: number;
1570
+ /** Custom sort index. */
1571
+ orderIndex?: number;
1572
+ /** Event and ticket policies. */
1573
+ policy?: string;
1574
+ /** Sensitive dashboard data. */
1575
+ dashboard?: Dashboard;
1576
+ /**
1577
+ * Event ID associated with the ticket.
1578
+ * @format GUID
1579
+ */
1580
+ eventId?: string;
1581
+ /**
1582
+ * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
1583
+ * @readonly
1584
+ */
1585
+ wixFeeConfig?: WixFeeConfig;
1586
+ /** Ticket sale period. */
1587
+ salePeriod?: TicketSalePeriod;
1588
+ /**
1589
+ * Ticket sale status.
1590
+ * @readonly
1591
+ */
1592
+ saleStatus?: TicketSaleStatus;
1593
+ /** Ticket state. */
1594
+ state?: State[];
1595
+ /** Ticket pricing. */
1596
+ pricing?: TicketPricing;
1597
+ }
1598
+ export interface Dashboard {
1599
+ /** Whether ticket is hidden and cannot be sold. */
1600
+ hidden?: boolean;
1601
+ /**
1602
+ * Number of tickets sold and reserved.
1603
+ * @deprecated
1604
+ */
1605
+ sold?: number;
1606
+ /** Whether the ticket has limited quantity. */
1607
+ limited?: boolean;
1608
+ /** Ticket limit. `NULL` if the tickets are unlimited. */
1609
+ quantity?: number | null;
1610
+ /** Number of unsold tickets. `NULL` if the tickets are unlimited. */
1611
+ unsold?: number | null;
1612
+ /** Number of tickets sold. */
1613
+ ticketsSold?: number;
1614
+ /** Number of tickets reserved. */
1615
+ ticketsReserved?: number;
1616
+ }
1617
+ export interface WixFeeConfig {
1618
+ /** Fee calculation method. */
1619
+ type?: FeeType;
1620
+ }
1621
+ export interface TicketSalePeriod {
1622
+ /** Ticket sale start timestamp. */
1623
+ startDate?: Date | null;
1624
+ /** Ticket sale end timestamp. */
1625
+ endDate?: Date | null;
1626
+ /** Whether to hide this ticket if it's not on sale */
1627
+ hideNotOnSale?: boolean;
1628
+ }
1629
+ export declare enum TicketSaleStatus {
1630
+ /** Ticket sale is scheduled to start. */
1631
+ SALE_SCHEDULED = "SALE_SCHEDULED",
1632
+ /** Ticket sale has started. */
1633
+ SALE_STARTED = "SALE_STARTED",
1634
+ /** Ticket sale has ended. */
1635
+ SALE_ENDED = "SALE_ENDED"
1636
+ }
1637
+ export interface TicketPricing extends TicketPricingPriceOneOf {
1638
+ /** Ticket price which is read only. */
1639
+ fixedPrice?: Money;
1640
+ /** Min price per ticket, customizable. */
1641
+ minPrice?: Money;
1642
+ /** Ticket pricing options. */
1643
+ pricingOptions?: PricingOptions;
1644
+ /**
1645
+ * Ticket pricing type.
1646
+ * @readonly
1647
+ */
1648
+ pricingType?: Type;
1649
+ }
1650
+ /** @oneof */
1651
+ export interface TicketPricingPriceOneOf {
1652
+ /** Ticket price which is read only. */
1653
+ fixedPrice?: Money;
1654
+ /** Min price per ticket, customizable. */
1655
+ minPrice?: Money;
1656
+ /** Ticket pricing options. */
1657
+ pricingOptions?: PricingOptions;
1658
+ }
1659
+ export interface PricingOptions {
1660
+ /** Multiple ticket pricing options. */
1661
+ options?: PricingOption[];
1662
+ }
1663
+ export interface PricingOption {
1664
+ /**
1665
+ * Ticket pricing option ID.
1666
+ * @format GUID
1667
+ */
1668
+ _id?: string | null;
1669
+ /**
1670
+ * Ticket pricing option name.
1671
+ * @minLength 1
1672
+ * @maxLength 200
1673
+ */
1674
+ name?: string | null;
1675
+ /** Ticket pricing option price. */
1676
+ price?: Money;
1677
+ }
1678
+ export declare enum Type {
1679
+ STANDARD = "STANDARD",
1680
+ DONATION = "DONATION"
1681
+ }
1682
+ export interface QueryAvailableTicketsRequest {
1683
+ /** Offset. */
1684
+ offset?: number;
1685
+ /**
1686
+ * Limit.
1687
+ * @max 1000
1688
+ */
1689
+ limit?: number;
1690
+ /** Ticket definition. */
1691
+ filter?: Record<string, any> | null;
1692
+ /** @maxSize 20 */
1693
+ fieldset?: TicketDefinitionFieldset[];
1694
+ /**
1695
+ * Sort order.
1696
+ * Default: `created:asc`.
1697
+ * @maxLength 100
1698
+ */
1699
+ sort?: string;
1700
+ }
1701
+ export declare enum TicketDefinitionFieldset {
1702
+ /** Include `policy` in the response. */
1703
+ POLICY = "POLICY",
1704
+ /** Include `dashboard` in the response. */
1705
+ DASHBOARD = "DASHBOARD"
1706
+ }
1707
+ export interface QueryAvailableTicketsResponse {
1708
+ /** Ticket definitions meta data. */
1709
+ metaData?: ResponseMetaData;
1710
+ /** Ticket definitions. */
1711
+ definitions?: TicketDefinition[];
1712
+ }
1713
+ export interface CreateReservationRequest {
1714
+ /**
1715
+ * Event ID to which the reservation belongs.
1716
+ * @format GUID
1717
+ */
1718
+ eventId: string;
1719
+ /**
1720
+ * Tickets to reserve.
1721
+ * @minSize 1
1722
+ * @maxSize 50
1723
+ */
1724
+ ticketQuantities?: TicketReservationQuantity[];
1725
+ /** Whether to ignore the available ticket limits upon reservation. */
1726
+ ignoreLimits?: boolean;
1727
+ /** Whether to allow reservation for hidden tickets. */
1728
+ allowHiddenTickets?: boolean;
1729
+ }
1730
+ export interface TicketReservationQuantity {
1731
+ /**
1732
+ * Ticket definition ID.
1733
+ * @format GUID
1734
+ */
1735
+ ticketDefinitionId?: string;
1736
+ /**
1737
+ * Quantity of tickets to reserve.
1738
+ * @min 1
1739
+ * @max 50
1740
+ */
1741
+ quantity?: number;
1742
+ /**
1743
+ * Override the predefined ticket price.
1744
+ * @maxLength 13
1745
+ * @format DECIMAL_VALUE
1746
+ */
1747
+ priceOverride?: string | null;
1748
+ /** Optional ticket details */
1749
+ ticketDetails?: TicketDetails[];
1750
+ }
1751
+ export interface CreateReservationResponse {
1752
+ /**
1753
+ * Reservation ID.
1754
+ * @format GUID
1755
+ */
1756
+ _id?: string;
1757
+ /** Reservation expiration timestamp. */
1758
+ expires?: Date | null;
1759
+ /** Ticket reservations. */
1760
+ reservations?: TicketReservation[];
1761
+ /** Reservation invoice. */
1762
+ invoice?: Invoice;
1763
+ /** Reservation status. */
1764
+ reservationStatus?: ReservationStatus;
1765
+ }
1766
+ export interface TicketReservation {
1767
+ /**
1768
+ * Quantity of reserved tickets.
1769
+ * @min 1
1770
+ * @max 20
1771
+ */
1772
+ quantity?: number;
1773
+ /** An object containing ticket information. */
1774
+ ticket?: TicketDefinition;
1775
+ /** Optional ticket details. */
1776
+ ticketDetails?: TicketDetails[];
1777
+ }
1778
+ export interface CancelReservationRequest {
1779
+ /**
1780
+ * Event ID to which the reservation belongs.
1781
+ * @format GUID
1782
+ */
1783
+ eventId: string;
1784
+ /**
1785
+ * Reservation ID.
1786
+ * @format GUID
1787
+ */
1788
+ _id: string;
1789
+ }
1790
+ export interface CancelReservationResponse {
1791
+ }
1792
+ export interface GetInvoiceRequest {
1793
+ /**
1794
+ * Event ID to which the invoice belongs.
1795
+ * @format GUID
1796
+ */
1797
+ eventId: string;
1798
+ /**
1799
+ * Reservation ID.
1800
+ * @format GUID
1801
+ */
1802
+ reservationId: string;
1803
+ /** Optional discount to be applied on the returned invoice. */
1804
+ withDiscount?: DiscountRequest;
1805
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1806
+ paidPlanBenefit?: PaidPlanBenefit;
1807
+ }
1808
+ export interface DiscountRequest {
1809
+ /**
1810
+ * Discount coupon code.
1811
+ * @maxLength 20
1812
+ */
1813
+ couponCode?: string;
1814
+ }
1815
+ export interface PaidPlanBenefit {
1816
+ /**
1817
+ * Pricing plan ID.
1818
+ * @format GUID
1819
+ */
1820
+ planOrderId?: string;
1821
+ /**
1822
+ * Pricing plan benefit ID.
1823
+ * @format GUID
1824
+ */
1825
+ benefitId?: string;
1826
+ }
1827
+ export interface GetInvoiceResponse {
1828
+ /** Invoice with applied discount. */
1829
+ invoice?: Invoice;
1830
+ /** Discount errors, if relevant. */
1831
+ discountErrors?: DiscountErrors;
1832
+ /** Reservation expiration time. */
1833
+ expires?: Date | null;
1834
+ /**
1835
+ * Reservation status. Possible values:
1836
+ * - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.
1837
+ * - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.
1838
+ * - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.
1839
+ * - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.
1840
+ * - `RESERVATION_EXPIRED`: The reservation has expired.
1841
+ */
1842
+ reservationStatus?: ReservationStatus;
1843
+ /** Whether this reservation is already used in checkout. */
1844
+ reservationOccupied?: boolean;
1845
+ /** Ticket reservations. */
1846
+ reservations?: TicketReservation[];
1847
+ }
1848
+ export interface DiscountErrors {
1849
+ /** Object containing error information. */
1850
+ error?: Error[];
1851
+ }
1852
+ export interface Error {
1853
+ /** A code identifying the error type. */
1854
+ code?: string;
1855
+ }
1856
+ export interface GiftCardErrors {
1857
+ /**
1858
+ * Error.
1859
+ * @maxSize 10
1860
+ */
1861
+ error?: GiftCardErrorsError[];
1862
+ }
1863
+ export interface GiftCardErrorsError {
1864
+ /** @maxLength 100 */
1865
+ code?: string;
1866
+ }
1867
+ export interface CheckoutRequest {
1868
+ /**
1869
+ * Event ID to which the checkout belongs.
1870
+ * @format GUID
1871
+ */
1872
+ eventId: string;
1873
+ /**
1874
+ * Ticket reservation ID.
1875
+ * @format GUID
1876
+ */
1877
+ reservationId?: string;
1878
+ /** Member ID (if empty - no site member is associated to this order). */
1879
+ memberId?: string;
1880
+ /** Discount to apply on the invoice. */
1881
+ discount?: DiscountRequest;
1882
+ /** Buyer details. */
1883
+ buyer?: Buyer;
1884
+ /**
1885
+ * Guest details.
1886
+ * @minSize 1
1887
+ * @maxSize 50
1888
+ */
1889
+ guests?: Guest[];
1890
+ /** Benefit granted by the pricing plan. */
1891
+ paidPlanBenefit?: PaidPlanBenefit;
1892
+ /** Options controlling the checkout process. */
1893
+ options?: CheckoutOptions;
1894
+ /** Whether marketing consent was given */
1895
+ marketingConsent?: boolean | null;
1896
+ }
1897
+ export interface Buyer {
1898
+ /**
1899
+ * Buyer first name.
1900
+ * @minLength 1
1901
+ * @maxLength 50
1902
+ */
1903
+ firstName?: string;
1904
+ /**
1905
+ * Buyer last name.
1906
+ * @minLength 1
1907
+ * @maxLength 50
1908
+ */
1909
+ lastName?: string;
1910
+ /**
1911
+ * Buyer email.
1912
+ * @format EMAIL
1913
+ * @minLength 5
1914
+ * @maxLength 255
1915
+ */
1916
+ email?: string;
1917
+ }
1918
+ export interface Guest {
1919
+ /** Specific guest info. */
1920
+ form?: FormResponse;
1921
+ }
1922
+ export interface CheckoutOptions {
1923
+ /** Whether to ignore settings to notify contacts or users. */
1924
+ silent?: boolean;
1925
+ /** 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. */
1926
+ payInPerson?: boolean;
1927
+ /** Whether to ignore form validation. */
1928
+ ignoreFormValidation?: boolean;
1929
+ /** Marks payment as already paid */
1930
+ markAsPaid?: boolean | null;
1931
+ }
1932
+ export interface CheckoutResponse {
1933
+ /** Created order. */
1934
+ order?: Order;
1935
+ /**
1936
+ * Order expiration time.
1937
+ * **Note:** Only applicable to orders with the `INITIATED` status.
1938
+ */
1939
+ expires?: Date | null;
1940
+ /** Ticket reservations. */
1941
+ reservations?: TicketReservation[];
1942
+ /** Order page URL. */
1943
+ orderPageUrl?: string | null;
1944
+ }
1945
+ export interface OrderInitiated {
1946
+ /** Order initiated timestamp in ISO UTC format. */
1947
+ timestamp?: Date | null;
1948
+ /**
1949
+ * Site language when Order initiated
1950
+ * @format LANGUAGE
1951
+ */
1952
+ language?: string | null;
1953
+ /**
1954
+ * Locale in which Order was created.
1955
+ * @format LANGUAGE_TAG
1956
+ */
1957
+ locale?: string | null;
1958
+ /**
1959
+ * Event ID to which the order belongs.
1960
+ * @format GUID
1961
+ */
1962
+ eventId?: string;
1963
+ /** Unique order number. */
1964
+ orderNumber?: string;
1965
+ /** Contact ID associated with this order. */
1966
+ contactId?: string;
1967
+ /**
1968
+ * Member ID associated with this order.
1969
+ * @format GUID
1970
+ */
1971
+ memberId?: string | null;
1972
+ /**
1973
+ * Order created timestamp.
1974
+ * @readonly
1975
+ */
1976
+ created?: Date | null;
1977
+ /**
1978
+ * Order updated timestamp.
1979
+ * @readonly
1980
+ */
1981
+ updated?: Date | null;
1982
+ /** Guest first name. */
1983
+ firstName?: string;
1984
+ /** Guest last name. */
1985
+ lastName?: string;
1986
+ /** Guest email address. */
1987
+ email?: string;
1988
+ /** Checkout form response. */
1989
+ checkoutForm?: FormResponse;
1990
+ /**
1991
+ * Order status. Possible values:
1992
+ * - `FREE`: The order is confirmed, no payment is required.
1993
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
1994
+ * - `PAID`: The order is paid.
1995
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
1996
+ * - `INITIATED`: The order is awaiting for payment.
1997
+ * - `CANCELED`: The order is canceled.
1998
+ * - `DECLINED`: The order is payment is declined.
1999
+ */
2000
+ status?: OrderStatus;
2001
+ /** Invoice. */
2002
+ invoice?: Invoice;
2003
+ /** Reservation ID associated with this order. */
2004
+ reservationId?: string;
2005
+ /** Order was marked as paid. */
2006
+ markedAsPaid?: boolean | null;
2007
+ }
2008
+ export interface UpdateCheckoutRequest {
2009
+ /**
2010
+ * Event ID to which the checkout belongs.
2011
+ * @format GUID
2012
+ */
2013
+ eventId: string;
2014
+ /**
2015
+ * Unique order number.
2016
+ * @maxLength 36
2017
+ */
2018
+ orderNumber: string;
2019
+ /** Buyer details. */
2020
+ buyer?: Buyer;
2021
+ /**
2022
+ * Guest details.
2023
+ * @minSize 1
2024
+ * @maxSize 20
2025
+ */
2026
+ guests?: Guest[];
2027
+ /** Member ID (if empty - no site member is associated to this order). */
2028
+ memberId?: string | null;
2029
+ /** Discount to apply on the invoice. */
2030
+ discount?: DiscountRequest;
2031
+ /** Benefit granted by the pricing plan. */
2032
+ paidPlanBenefit?: PaidPlanBenefit;
2033
+ }
2034
+ export interface UpdateCheckoutResponse {
2035
+ /** Updated order. */
2036
+ order?: Order;
2037
+ /** Order page URL. */
2038
+ orderPageUrl?: string | null;
2039
+ }
2040
+ export interface OrderPageUrls {
2041
+ /**
2042
+ * Success order page URL.
2043
+ * @format WEB_URL
2044
+ */
2045
+ success?: string | null;
2046
+ /**
2047
+ * Pending order page URL.
2048
+ * @format WEB_URL
2049
+ */
2050
+ pending?: string | null;
2051
+ /**
2052
+ * Canceled order page URL.
2053
+ * @format WEB_URL
2054
+ */
2055
+ canceled?: string | null;
2056
+ /**
2057
+ * Error order page URL.
2058
+ * @format WEB_URL
2059
+ */
2060
+ error?: string | null;
2061
+ }
2062
+ export interface PosCheckoutRequest {
2063
+ /**
2064
+ * Event ID to which the checkout belongs.
2065
+ * @format GUID
2066
+ */
2067
+ eventId: string;
2068
+ /**
2069
+ * Ticket reservation ID.
2070
+ * @format GUID
2071
+ */
2072
+ reservationId: string;
2073
+ /**
2074
+ * Payment details ID.
2075
+ * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2076
+ * @format GUID
2077
+ */
2078
+ paymentDetailsId?: string | null;
2079
+ }
2080
+ export interface PosCheckoutResponse {
2081
+ /** Created order. */
2082
+ order?: Order;
2083
+ /** Time when the order expires, applies to orders with status = INITIATED. */
2084
+ expires?: Date | null;
2085
+ /** Ticket reservations. */
2086
+ reservations?: TicketReservation[];
2087
+ }
2088
+ export interface GetReservationRequest {
2089
+ /**
2090
+ * Event ID.
2091
+ * @format GUID
2092
+ */
2093
+ eventId?: string | null;
2094
+ /**
2095
+ * Ticket reservation ID.
2096
+ * @format GUID
2097
+ */
2098
+ reservationId?: string | null;
2099
+ }
2100
+ export interface GetReservationResponse {
2101
+ /** Date and time the Ticket Reservation was created. */
2102
+ _createdDate?: Date | null;
2103
+ /** Date and time the Ticket Reservation was last updated. */
2104
+ _updatedDate?: Date | null;
2105
+ /** Date and time the Pending TicketReservation will expire. */
2106
+ expirationDate?: Date | null;
2107
+ /** Reservation status. */
2108
+ reservationStatus?: ReservationStatus;
2109
+ /** Ticket reservations. */
2110
+ reservations?: TicketReservation[];
2111
+ }
2112
+ export interface BaseEventMetadata {
2113
+ /**
2114
+ * App instance ID.
2115
+ * @format GUID
2116
+ */
2117
+ instanceId?: string | null;
2118
+ /**
2119
+ * Event type.
2120
+ * @maxLength 150
2121
+ */
2122
+ eventType?: string;
2123
+ /** The identification type and identity data. */
2124
+ identity?: IdentificationData;
2125
+ }
2126
+ export interface OrderDeletedEnvelope {
2127
+ data: OrderDeleted;
2128
+ metadata: BaseEventMetadata;
2129
+ }
2130
+ /**
2131
+ * This event is triggered when an order is deleted via GDPR request.
2132
+ * @permissionScope Read Events - all read permissions
2133
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2134
+ * @permissionScope Manage Events - all permissions
2135
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2136
+ * @permissionScope Manage Events
2137
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2138
+ * @permissionScope Read Basic Events Order Info
2139
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2140
+ * @permissionScope Manage Orders
2141
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2142
+ * @permissionId WIX_EVENTS.READ_ORDERS
2143
+ * @webhook
2144
+ * @eventType wix.events.ticketing.events.OrderDeleted
2145
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
2146
+ * @slug order_deleted
2147
+ */
2148
+ export declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
2149
+ export interface OrderUpdatedEnvelope {
2150
+ data: OrderUpdated;
2151
+ metadata: BaseEventMetadata;
2152
+ }
2153
+ /** @permissionScope Read Events - all read permissions
2154
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2155
+ * @permissionScope Manage Events - all permissions
2156
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2157
+ * @permissionScope Manage Events
2158
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2159
+ * @permissionScope Read Basic Events Order Info
2160
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2161
+ * @permissionScope Manage Orders
2162
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2163
+ * @permissionId WIX_EVENTS.READ_ORDERS
2164
+ * @webhook
2165
+ * @eventType wix.events.ticketing.events.OrderUpdated
2166
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
2167
+ * @slug order_updated
2168
+ */
2169
+ export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
2170
+ export interface OrderConfirmedEnvelope {
2171
+ data: OrderConfirmed;
2172
+ metadata: BaseEventMetadata;
2173
+ }
2174
+ /** @permissionScope Read Events - all read permissions
2175
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2176
+ * @permissionScope Manage Events - all permissions
2177
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2178
+ * @permissionScope Manage Events
2179
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2180
+ * @permissionScope Read Basic Events Order Info
2181
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2182
+ * @permissionScope Manage Orders
2183
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2184
+ * @permissionId WIX_EVENTS.READ_ORDERS
2185
+ * @webhook
2186
+ * @eventType wix.events.ticketing.events.OrderConfirmed
2187
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2188
+ * @slug order_confirmed
2189
+ */
2190
+ export declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
2191
+ export interface OrderInitiatedEnvelope {
2192
+ data: OrderInitiated;
2193
+ metadata: BaseEventMetadata;
2194
+ }
2195
+ /** @permissionScope Read Events - all read permissions
2196
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2197
+ * @permissionScope Manage Events - all permissions
2198
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2199
+ * @permissionScope Manage Events
2200
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2201
+ * @permissionScope Read Basic Events Order Info
2202
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2203
+ * @permissionScope Manage Orders
2204
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2205
+ * @permissionId WIX_EVENTS.READ_ORDERS
2206
+ * @webhook
2207
+ * @eventType wix.events.ticketing.events.OrderInitiated
2208
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2209
+ * @slug order_initiated
2210
+ */
2211
+ export declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
2212
+ export interface OrderReservationCreatedEnvelope {
2213
+ data: ReservationCreated;
2214
+ metadata: BaseEventMetadata;
2215
+ }
2216
+ /** @permissionScope Read Events - all read permissions
2217
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2218
+ * @permissionScope Manage Events - all permissions
2219
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2220
+ * @permissionScope Manage Events
2221
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2222
+ * @permissionScope Read Basic Events Order Info
2223
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2224
+ * @permissionScope Manage Orders
2225
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2226
+ * @permissionId WIX_EVENTS.READ_INVOICE
2227
+ * @webhook
2228
+ * @eventType wix.events.ticketing.events.ReservationCreated
2229
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2230
+ * @slug reservation_created
2231
+ */
2232
+ export declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
2233
+ export interface OrderReservationUpdatedEnvelope {
2234
+ data: ReservationUpdated;
2235
+ metadata: BaseEventMetadata;
2236
+ }
2237
+ /** @permissionScope Read Events - all read permissions
2238
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2239
+ * @permissionScope Manage Events - all permissions
2240
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2241
+ * @permissionScope Manage Events
2242
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2243
+ * @permissionScope Read Basic Events Order Info
2244
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2245
+ * @permissionScope Manage Orders
2246
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2247
+ * @permissionId WIX_EVENTS.READ_INVOICE
2248
+ * @webhook
2249
+ * @eventType wix.events.ticketing.events.ReservationUpdated
2250
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
2251
+ * @slug reservation_updated
2252
+ */
2253
+ export declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
2254
+ type OrderNonNullablePaths = `orderNumber` | `reservationId` | `snapshotId` | `eventId` | `contactId` | `memberId` | `firstName` | `lastName` | `email` | `checkoutForm.inputValues` | `checkoutForm.inputValues.${number}.inputName` | `checkoutForm.inputValues.${number}.value` | `checkoutForm.inputValues.${number}.values` | `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}.guestDetails.form.inputValues` | `tickets.${number}.guestDetails.form.inputValues.${number}.inputName` | `tickets.${number}.guestDetails.form.inputValues.${number}.value` | `tickets.${number}.guestDetails.form.inputValues.${number}.values` | `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}.discount.discounts` | `invoice.items.${number}.discount.discounts.${number}.coupon.name` | `invoice.items.${number}.discount.discounts.${number}.coupon.code` | `invoice.items.${number}.discount.discounts.${number}.coupon.couponId` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.rate` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.quantityDiscounted` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.name` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.items.${number}.fees` | `invoice.items.${number}.fees.${number}.name` | `invoice.items.${number}.fees.${number}.type` | `invoice.items.${number}.fees.${number}.rate` | `invoice.fees` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
2255
+ /**
2256
+ * Retrieves a list of orders, including ticket data.
2257
+ * @public
2258
+ * @param options - An object representing the available options for retrieving a list of orders.
2259
+ * @permissionId WIX_EVENTS.READ_ORDERS
2260
+ * @permissionScope Read Events - all read permissions
2261
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2262
+ * @permissionScope Manage Events - all permissions
2263
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2264
+ * @permissionScope Manage Events
2265
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2266
+ * @permissionScope Read Basic Events Order Info
2267
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2268
+ * @permissionScope Manage Orders
2269
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2270
+ * @applicableIdentity APP
2271
+ * @fqn wix.events.ticketing.OrderManagement.ListOrders
2272
+ */
2273
+ export declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
2274
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2275
+ }[OrderNonNullablePaths]>>;
2276
+ export interface ListOrdersOptions {
2277
+ /** Offset. */
2278
+ offset?: number;
2279
+ /**
2280
+ * Limit.
2281
+ * @max 400
2282
+ */
2283
+ limit?: number;
2284
+ /**
2285
+ * Predefined sets of fields to return.
2286
+ * - `TICKETS`: Returns `tickets`.
2287
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
2288
+ * - `FORM` : Returns `checkoutForm`.
2289
+ * - `INVOICE`: Returns `invoice`.
2290
+ *
2291
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2292
+ * @maxSize 20
2293
+ */
2294
+ fieldset?: OrderFieldset[];
2295
+ /**
2296
+ * Order status. Possible values:
2297
+ * - `FREE`: The order is confirmed, no payment is required.
2298
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
2299
+ * - `PAID`: The order is paid.
2300
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
2301
+ * - `INITIATED`: The order is awaiting for payment.
2302
+ * - `CANCELED`: The order is canceled.
2303
+ * - `DECLINED`: The order is payment is declined.
2304
+ */
2305
+ status?: OrderStatus[];
2306
+ /**
2307
+ * Event ID to which the order belongs.
2308
+ * @format GUID
2309
+ * @maxSize 100
2310
+ */
2311
+ eventId?: string[];
2312
+ /**
2313
+ * Order number.
2314
+ * @maxLength 36
2315
+ * @maxSize 500
2316
+ */
2317
+ orderNumber?: string[];
2318
+ /**
2319
+ * Site member ID.
2320
+ * @format GUID
2321
+ * @maxSize 500
2322
+ */
2323
+ memberId?: string[];
2324
+ /**
2325
+ * Field facets.
2326
+ * @maxLength 100
2327
+ * @maxSize 20
2328
+ */
2329
+ facet?: string[];
2330
+ /**
2331
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
2332
+ * @maxLength 200
2333
+ */
2334
+ searchPhrase?: string;
2335
+ /**
2336
+ * Event creator ID.
2337
+ * @format GUID
2338
+ * @maxSize 50
2339
+ */
2340
+ eventCreatorId?: string[];
2341
+ /**
2342
+ * Sort order.
2343
+ * Default: `created:asc`.
2344
+ * @maxLength 100
2345
+ */
2346
+ sort?: string;
2347
+ /** Order tag. */
2348
+ tag?: OrderTag[];
2349
+ /**
2350
+ * Guest contact IDs.
2351
+ * @format GUID
2352
+ * @maxSize 100
2353
+ */
2354
+ contactId?: string[];
2355
+ }
2356
+ /**
2357
+ * Retrieves an order, including ticket data.
2358
+ * <!--
2359
+ * >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.
2360
+ * -->
2361
+ * @public
2362
+ * @requiredField identifiers
2363
+ * @requiredField identifiers.eventId
2364
+ * @requiredField identifiers.orderNumber
2365
+ * @param options - An object representing the available options for getting an order.
2366
+ * @param identifiers - An object containing identifiers for the order to be retrieved.
2367
+ * @permissionId WIX_EVENTS.READ_ORDERS
2368
+ * @permissionScope Read Events - all read permissions
2369
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2370
+ * @permissionScope Manage Events - all permissions
2371
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2372
+ * @permissionScope Manage Events
2373
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2374
+ * @permissionScope Read Basic Events Order Info
2375
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2376
+ * @permissionScope Manage Orders
2377
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2378
+ * @applicableIdentity APP
2379
+ * @returns Requested order.
2380
+ * @fqn wix.events.ticketing.OrderManagement.GetOrder
2381
+ */
2382
+ export declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
2383
+ export interface GetOrderIdentifiers {
2384
+ /**
2385
+ * Event ID to which the order belongs.
2386
+ * @format GUID
2387
+ */
2388
+ eventId: string;
2389
+ /**
2390
+ * Unique order number.
2391
+ * @maxLength 36
2392
+ */
2393
+ orderNumber: string;
2394
+ }
2395
+ export interface GetOrderOptions {
2396
+ /**
2397
+ * Predefined sets of fields to return.
2398
+ * - `TICKETS`: Returns `tickets`.
2399
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
2400
+ * - `FORM` : Returns `checkoutForm`.
2401
+ * - `INVOICE`: Returns `invoice`.
2402
+ *
2403
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2404
+ * @maxSize 20
2405
+ */
2406
+ fieldset?: OrderFieldset[];
2407
+ }
2408
+ /**
2409
+ * Updates an order.
2410
+ * @public
2411
+ * @requiredField identifiers
2412
+ * @requiredField identifiers.eventId
2413
+ * @requiredField identifiers.orderNumber
2414
+ * @param options - An object representing the available options for updating an order.
2415
+ * @param identifiers - An object containing identifiers for the order to be updated.
2416
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2417
+ * @permissionScope Manage Events - all permissions
2418
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2419
+ * @permissionScope Manage Events
2420
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2421
+ * @permissionScope Manage Orders
2422
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2423
+ * @applicableIdentity APP
2424
+ * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
2425
+ */
2426
+ export declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
2427
+ [P in OrderNonNullablePaths]: `order.${P}`;
2428
+ }[OrderNonNullablePaths]>>;
2429
+ export interface UpdateOrderIdentifiers {
2430
+ /**
2431
+ * Event ID to which the order belongs.
2432
+ * @format GUID
2433
+ */
2434
+ eventId: string;
2435
+ /**
2436
+ * Unique order number.
2437
+ * @maxLength 36
2438
+ */
2439
+ orderNumber: string;
2440
+ }
2441
+ export interface UpdateOrderOptions {
2442
+ /** Set of field paths to update. */
2443
+ fields?: string[];
2444
+ /** Checkout form. */
2445
+ checkoutForm?: FormResponse;
2446
+ /** Whether order is archived. */
2447
+ archived?: boolean;
2448
+ }
2449
+ /**
2450
+ * Archives multiple orders.
2451
+ * @public
2452
+ * @requiredField eventId
2453
+ * @param options - An object representing the available options for confirming an order.
2454
+ * @param eventId - Event ID to which the order belongs.
2455
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2456
+ * @permissionScope Manage Events - all permissions
2457
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2458
+ * @permissionScope Manage Events
2459
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2460
+ * @permissionScope Manage Orders
2461
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2462
+ * @applicableIdentity APP
2463
+ * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
2464
+ */
2465
+ export declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
2466
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2467
+ }[OrderNonNullablePaths]>>;
2468
+ export interface BulkUpdateOrdersOptions {
2469
+ /**
2470
+ * Unique order number.
2471
+ * @minLength 1
2472
+ * @maxLength 36
2473
+ * @minSize 1
2474
+ * @maxSize 100
2475
+ */
2476
+ orderNumber?: string[];
2477
+ /** Set of fields to update. */
2478
+ fields?: string[];
2479
+ /** Whether to archive the order. */
2480
+ archived?: boolean;
2481
+ }
2482
+ /**
2483
+ * Confirms an order.
2484
+ *
2485
+ *
2486
+ * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
2487
+ * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
2488
+ * @public
2489
+ * @requiredField eventId
2490
+ * @param options - An object representing the available options for confirming an order.
2491
+ * @param eventId - Event ID to which the order belongs.
2492
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2493
+ * @permissionScope Manage Events - all permissions
2494
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2495
+ * @permissionScope Manage Events
2496
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2497
+ * @permissionScope Manage Orders
2498
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2499
+ * @applicableIdentity APP
2500
+ * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
2501
+ */
2502
+ export declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
2503
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
2504
+ }[OrderNonNullablePaths]>>;
2505
+ export interface ConfirmOrderOptions {
2506
+ /**
2507
+ * Order numbers.
2508
+ * @minLength 1
2509
+ * @maxLength 36
2510
+ * @maxSize 100
2511
+ */
2512
+ orderNumber?: string[];
2513
+ }
2514
+ /**
2515
+ * Retrieves a summary of total ticket sales.
2516
+ * <!--
2517
+ * > 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.
2518
+ * -->
2519
+ * @public
2520
+ * @param options - An object representing the available options for retrieving a summary of total ticket sales.
2521
+ * @permissionId WIX_EVENTS.READ_ORDERS
2522
+ * @permissionScope Read Events - all read permissions
2523
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2524
+ * @permissionScope Manage Events - all permissions
2525
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2526
+ * @permissionScope Manage Events
2527
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2528
+ * @permissionScope Read Basic Events Order Info
2529
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2530
+ * @permissionScope Manage Orders
2531
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2532
+ * @applicableIdentity APP
2533
+ * @fqn wix.events.ticketing.OrderManagement.GetSummary
2534
+ */
2535
+ export declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
2536
+ export interface GetSummaryOptions {
2537
+ /**
2538
+ * Event ID.
2539
+ * @format GUID
2540
+ */
2541
+ eventId?: string | null;
2542
+ }
2543
+ /**
2544
+ * Captures authorized payment asynchronously.
2545
+ * Eventually order will become paid.
2546
+ * For orders with non-authorized payments request will fail.
2547
+ * @param orderNumber - Order number.
2548
+ * @public
2549
+ * @requiredField orderNumber
2550
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2551
+ * @permissionScope Manage Events - all permissions
2552
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2553
+ * @permissionScope Manage Events
2554
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2555
+ * @permissionScope Manage Orders
2556
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2557
+ * @applicableIdentity APP
2558
+ * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
2559
+ */
2560
+ export declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void>;
2561
+ export interface CaptureAuthorizedPaymentOptions {
2562
+ /**
2563
+ * Event ID.
2564
+ * @format GUID
2565
+ */
2566
+ eventId?: string;
2567
+ }
2568
+ /**
2569
+ * Voids authorized payment asynchronously.
2570
+ * Eventually order will become voided.
2571
+ * For orders with non-authorized payments request will fail.
2572
+ * @param orderNumber - Order number.
2573
+ * @public
2574
+ * @requiredField orderNumber
2575
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2576
+ * @permissionScope Manage Events - all permissions
2577
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2578
+ * @permissionScope Manage Events
2579
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2580
+ * @permissionScope Manage Orders
2581
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2582
+ * @applicableIdentity APP
2583
+ * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
2584
+ */
2585
+ export declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void>;
2586
+ export interface VoidAuthorizedPaymentOptions {
2587
+ /**
2588
+ * Event ID.
2589
+ * @format GUID
2590
+ */
2591
+ eventId?: string;
2592
+ }
2593
+ /**
2594
+ * Retrieves checkout details.
2595
+ * @public
2596
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2597
+ * @permissionScope Manage Events - all permissions
2598
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2599
+ * @permissionScope Manage Events
2600
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2601
+ * @permissionScope Manage Orders
2602
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2603
+ * @applicableIdentity APP
2604
+ * @applicableIdentity VISITOR
2605
+ * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
2606
+ */
2607
+ export declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
2608
+ /**
2609
+ * Returns tickets available to reserve.
2610
+ * <!--
2611
+ * > 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.
2612
+ * -->
2613
+ * @public
2614
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2615
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2616
+ * @permissionScope Manage Events - all permissions
2617
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2618
+ * @permissionScope Manage Events
2619
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2620
+ * @permissionScope Manage Orders
2621
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2622
+ * @applicableIdentity APP
2623
+ * @applicableIdentity VISITOR
2624
+ * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
2625
+ */
2626
+ 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}.state` | `definitions.${number}.pricing.pricingOptions.options` | `definitions.${number}.pricing.pricingType`>>;
2627
+ export interface ListAvailableTicketsOptions {
2628
+ /**
2629
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
2630
+ * @format GUID
2631
+ */
2632
+ eventId?: string;
2633
+ /** Offset. */
2634
+ offset?: number;
2635
+ /**
2636
+ * Limit.
2637
+ * @max 100
2638
+ */
2639
+ limit?: number;
2640
+ /**
2641
+ * Sort order.
2642
+ * Default: `created:asc`.
2643
+ * @maxLength 100
2644
+ */
2645
+ sort?: string;
2646
+ state?: State[];
2647
+ }
2648
+ /**
2649
+ * Returns tickets available to reserve.
2650
+ * <!--
2651
+ * > 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.
2652
+ * -->
2653
+ * @public
2654
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
2655
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
2656
+ * @permissionScope Manage Events - all permissions
2657
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2658
+ * @permissionScope Manage Events
2659
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2660
+ * @permissionScope Manage Orders
2661
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2662
+ * @applicableIdentity APP
2663
+ * @applicableIdentity VISITOR
2664
+ * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
2665
+ */
2666
+ 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}.state` | `definitions.${number}.pricing.pricingOptions.options` | `definitions.${number}.pricing.pricingType`>>;
2667
+ export interface QueryAvailableTicketsOptions {
2668
+ /** Offset. */
2669
+ offset?: number;
2670
+ /**
2671
+ * Limit.
2672
+ * @max 1000
2673
+ */
2674
+ limit?: number;
2675
+ /** Ticket definition. */
2676
+ filter?: Record<string, any> | null;
2677
+ /** @maxSize 20 */
2678
+ fieldset?: TicketDefinitionFieldset[];
2679
+ /**
2680
+ * Sort order.
2681
+ * Default: `created:asc`.
2682
+ * @maxLength 100
2683
+ */
2684
+ sort?: string;
2685
+ }
2686
+ /**
2687
+ * Reserves tickets for 20 minutes.
2688
+ *
2689
+ *
2690
+ * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
2691
+ * When the reservation expires, the tickets are added back to the stock.
2692
+ * @public
2693
+ * @requiredField eventId
2694
+ * @param options - An object representing the available options for creating a reservation.
2695
+ * @param eventId - Event ID to which the reservation belongs.
2696
+ * @permissionId WIX_EVENTS.CHECKOUT
2697
+ * @permissionScope Manage Events - all permissions
2698
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2699
+ * @permissionScope Manage Events
2700
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2701
+ * @permissionScope Manage Orders
2702
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2703
+ * @applicableIdentity APP
2704
+ * @applicableIdentity VISITOR
2705
+ * @fqn wix.events.ticketing.CheckoutService.CreateReservation
2706
+ */
2707
+ 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.state` | `reservations.${number}.ticket.pricing.pricingOptions.options` | `reservations.${number}.ticket.pricing.pricingType` | `reservations.${number}.ticketDetails` | `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}.discount.discounts` | `invoice.items.${number}.discount.discounts.${number}.coupon.name` | `invoice.items.${number}.discount.discounts.${number}.coupon.code` | `invoice.items.${number}.discount.discounts.${number}.coupon.couponId` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.rate` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.quantityDiscounted` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.name` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.items.${number}.fees` | `invoice.items.${number}.fees.${number}.name` | `invoice.items.${number}.fees.${number}.type` | `invoice.items.${number}.fees.${number}.rate` | `invoice.fees` | `reservationStatus`>>;
2708
+ export interface CreateReservationOptions {
2709
+ /**
2710
+ * Tickets to reserve.
2711
+ * @minSize 1
2712
+ * @maxSize 50
2713
+ */
2714
+ ticketQuantities?: TicketReservationQuantity[];
2715
+ /** Whether to ignore the available ticket limits upon reservation. */
2716
+ ignoreLimits?: boolean;
2717
+ /** Whether to allow reservation for hidden tickets. */
2718
+ allowHiddenTickets?: boolean;
2719
+ }
2720
+ /**
2721
+ * Cancels ticket reservation and returns tickets to stock.
2722
+ * <!--
2723
+ * > 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.
2724
+ * -->
2725
+ * @param _id - Reservation ID.
2726
+ * @public
2727
+ * @requiredField _id
2728
+ * @requiredField eventId
2729
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
2730
+ * @param eventId - Event ID to which the reservation belongs.
2731
+ * @permissionId WIX_EVENTS.CHECKOUT
2732
+ * @permissionScope Manage Events - all permissions
2733
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2734
+ * @permissionScope Manage Events
2735
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2736
+ * @permissionScope Manage Orders
2737
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2738
+ * @applicableIdentity APP
2739
+ * @applicableIdentity VISITOR
2740
+ * @fqn wix.events.ticketing.CheckoutService.CancelReservation
2741
+ */
2742
+ export declare function cancelReservation(_id: string, eventId: string): Promise<void>;
2743
+ /**
2744
+ * Generates a preview of an invoice, including the given coupon or pricing plan.
2745
+ * @param reservationId - Reservation ID.
2746
+ * @public
2747
+ * @requiredField eventId
2748
+ * @requiredField reservationId
2749
+ * @param options - An object representing the available options for generating a preview of a reservation invoice.
2750
+ * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
2751
+ * @param eventId - Event ID to which the invoice belongs.
2752
+ * @permissionId WIX_EVENTS.READ_INVOICE
2753
+ * @permissionScope Read Events - all read permissions
2754
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2755
+ * @permissionScope Manage Events - all permissions
2756
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2757
+ * @permissionScope Manage Events
2758
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2759
+ * @permissionScope Read Basic Events Order Info
2760
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
2761
+ * @permissionScope Manage Orders
2762
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2763
+ * @applicableIdentity APP
2764
+ * @applicableIdentity VISITOR
2765
+ * @fqn wix.events.ticketing.CheckoutService.GetInvoice
2766
+ */
2767
+ 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}.discount.discounts` | `invoice.items.${number}.discount.discounts.${number}.coupon.name` | `invoice.items.${number}.discount.discounts.${number}.coupon.code` | `invoice.items.${number}.discount.discounts.${number}.coupon.couponId` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.rate` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.percentDiscount.quantityDiscounted` | `invoice.items.${number}.discount.discounts.${number}.paidPlan.name` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.items.${number}.fees` | `invoice.items.${number}.fees.${number}.name` | `invoice.items.${number}.fees.${number}.type` | `invoice.items.${number}.fees.${number}.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.state` | `reservations.${number}.ticket.pricing.pricingOptions.options` | `reservations.${number}.ticket.pricing.pricingType` | `reservations.${number}.ticketDetails`>>;
2768
+ export interface GetInvoiceOptions {
2769
+ /** Optional discount to be applied on the returned invoice. */
2770
+ withDiscount?: DiscountRequest;
2771
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
2772
+ paidPlanBenefit?: PaidPlanBenefit;
2773
+ }
2774
+ /**
2775
+ * Checkouts the reserved tickets.
2776
+ *
2777
+ *
2778
+ * Creates an order and associates it with a site visitor contact.
2779
+ * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
2780
+ *
2781
+ * 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.
2782
+ * 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:
2783
+ * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
2784
+ *
2785
+ * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
2786
+ * @public
2787
+ * @requiredField eventId
2788
+ * @requiredField options.guests.form
2789
+ * @param options - An object representing the available options for checking out a reserved ticket.
2790
+ * @param eventId - Event ID to which the checkout belongs.
2791
+ * @permissionId WIX_EVENTS.CHECKOUT
2792
+ * @permissionScope Manage Events - all permissions
2793
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2794
+ * @permissionScope Manage Events
2795
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2796
+ * @permissionScope Manage Orders
2797
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2798
+ * @applicableIdentity APP
2799
+ * @applicableIdentity VISITOR
2800
+ * @fqn wix.events.ticketing.CheckoutService.Checkout
2801
+ */
2802
+ export declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
2803
+ [P in OrderNonNullablePaths]: `order.${P}`;
2804
+ }[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.state` | `reservations.${number}.ticket.pricing.pricingOptions.options` | `reservations.${number}.ticket.pricing.pricingType` | `reservations.${number}.ticketDetails`>>;
2805
+ export interface CheckoutOptionsForRequest {
2806
+ /**
2807
+ * Ticket reservation ID.
2808
+ * @format GUID
2809
+ */
2810
+ reservationId?: string;
2811
+ /** Member ID (if empty - no site member is associated to this order). */
2812
+ memberId?: string;
2813
+ /** Discount to apply on the invoice. */
2814
+ discount?: DiscountRequest;
2815
+ /** Buyer details. */
2816
+ buyer?: Buyer;
2817
+ /**
2818
+ * Guest details.
2819
+ * @minSize 1
2820
+ * @maxSize 50
2821
+ */
2822
+ guests?: Guest[];
2823
+ /** Benefit granted by the pricing plan. */
2824
+ paidPlanBenefit?: PaidPlanBenefit;
2825
+ /** Options controlling the checkout process. */
2826
+ options?: CheckoutOptions;
2827
+ /** Whether marketing consent was given */
2828
+ marketingConsent?: boolean | null;
2829
+ }
2830
+ /**
2831
+ * Updates order and tickets.
2832
+ *
2833
+ *
2834
+ * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
2835
+ * @param orderNumber - Unique order number.
2836
+ * @public
2837
+ * @requiredField eventId
2838
+ * @requiredField orderNumber
2839
+ * @param options - An object representing the available options for updating an order and tickets.
2840
+ * @param identifiers - An object containing identifiers for the order and tickets to be updated.
2841
+ * @param eventId - Event ID to which the checkout belongs.
2842
+ * @permissionId WIX_EVENTS.CHECKOUT
2843
+ * @permissionScope Manage Events - all permissions
2844
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2845
+ * @permissionScope Manage Events
2846
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2847
+ * @permissionScope Manage Orders
2848
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2849
+ * @applicableIdentity APP
2850
+ * @applicableIdentity VISITOR
2851
+ * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
2852
+ */
2853
+ export declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
2854
+ [P in OrderNonNullablePaths]: `order.${P}`;
2855
+ }[OrderNonNullablePaths]>>;
2856
+ export interface UpdateCheckoutOptions {
2857
+ /** Buyer details. */
2858
+ buyer?: Buyer;
2859
+ /**
2860
+ * Guest details.
2861
+ * @minSize 1
2862
+ * @maxSize 20
2863
+ */
2864
+ guests?: Guest[];
2865
+ /** Member ID (if empty - no site member is associated to this order). */
2866
+ memberId?: string | null;
2867
+ /** Discount to apply on the invoice. */
2868
+ discount?: DiscountRequest;
2869
+ /** Benefit granted by the pricing plan. */
2870
+ paidPlanBenefit?: PaidPlanBenefit;
2871
+ }
2872
+ /**
2873
+ * Creates order with payment details already initiated via Cashier Pay API.
2874
+ * @public
2875
+ * @documentationMaturity preview
2876
+ * @requiredField eventId
2877
+ * @requiredField options.reservationId
2878
+ * @param eventId - Event ID to which the checkout belongs.
2879
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
2880
+ * @permissionScope Manage Events - all permissions
2881
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2882
+ * @permissionScope Manage Events
2883
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2884
+ * @permissionScope Manage Orders
2885
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
2886
+ * @applicableIdentity APP
2887
+ * @fqn wix.events.ticketing.CheckoutService.PosCheckout
2888
+ */
2889
+ export declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
2890
+ [P in OrderNonNullablePaths]: `order.${P}`;
2891
+ }[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.state` | `reservations.${number}.ticket.pricing.pricingOptions.options` | `reservations.${number}.ticket.pricing.pricingType` | `reservations.${number}.ticketDetails`>>;
2892
+ export interface PosCheckoutOptions {
2893
+ /**
2894
+ * Ticket reservation ID.
2895
+ * @format GUID
2896
+ */
2897
+ reservationId: string;
2898
+ /**
2899
+ * Payment details ID.
2900
+ * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2901
+ * @format GUID
2902
+ */
2903
+ paymentDetailsId?: string | null;
2904
+ }
2905
+ export {};