@wix/auto_sdk_events_orders 1.0.7 → 1.0.8

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