@wix/auto_sdk_events_orders 1.0.6 → 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 +14 -13
  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
@@ -0,0 +1,1331 @@
1
+ import { aq as ListOrdersRequest$1, a as ListOrdersResponse$1, av as GetOrderRequest$1, aw as GetOrderResponse$1, ay as UpdateOrderRequest$1, d as UpdateOrderResponse$1, aA as BulkUpdateOrdersRequest$1, e as BulkUpdateOrdersResponse$1, aB as ConfirmOrderRequest$1, f as ConfirmOrderResponse$1, aC as GetSummaryRequest$1, h as GetSummaryResponse$1, aL as CaptureAuthorizedPaymentRequest$1, aM as CaptureAuthorizedPaymentResponse$1, aN as VoidAuthorizedPaymentRequest$1, aO as VoidAuthorizedPaymentResponse$1, aY as GetCheckoutOptionsRequest$1, j as GetCheckoutOptionsResponse$1, aZ as ListAvailableTicketsRequest$1, l as ListAvailableTicketsResponse$1, b7 as QueryAvailableTicketsRequest$1, m as QueryAvailableTicketsResponse$1, b8 as CreateReservationRequest$1, o as CreateReservationResponse$1, bb as CancelReservationRequest$1, bc as CancelReservationResponse$1, bd as GetInvoiceRequest$1, q as GetInvoiceResponse$1, bk as CheckoutRequest$1, s as CheckoutResponse$1, bp as UpdateCheckoutRequest$1, u as UpdateCheckoutResponse$1, br as PosCheckoutRequest$1, v as PosCheckoutResponse$1 } from './events-v1-order-orders.universal-CceUcOMM.js';
2
+
3
+ interface Order {
4
+ /** Unique order number. */
5
+ orderNumber?: string;
6
+ /**
7
+ * Reservation ID.
8
+ * @format GUID
9
+ */
10
+ reservationId?: string;
11
+ /**
12
+ * Payment snapshot ID.
13
+ * Empty for FREE order.
14
+ * @format GUID
15
+ * @readonly
16
+ */
17
+ snapshotId?: string;
18
+ /**
19
+ * Event ID.
20
+ * @format GUID
21
+ */
22
+ eventId?: string;
23
+ /**
24
+ * Contact ID of buyer (resolved using email address).
25
+ * @format GUID
26
+ */
27
+ contactId?: string;
28
+ /**
29
+ * Member ID of buyer (if relevant).
30
+ * @format GUID
31
+ */
32
+ memberId?: string;
33
+ /**
34
+ * RSVP created timestamp.
35
+ * @readonly
36
+ */
37
+ created?: Date | null;
38
+ /** Guest first name. */
39
+ firstName?: string;
40
+ /** Guest last name. */
41
+ lastName?: string;
42
+ /**
43
+ * Guest email.
44
+ * @format EMAIL
45
+ */
46
+ email?: string;
47
+ /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
48
+ checkoutForm?: FormResponse;
49
+ /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
50
+ confirmed?: boolean;
51
+ /** Order status. */
52
+ status?: OrderStatus;
53
+ /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
54
+ method?: string;
55
+ /** Tickets ordered. */
56
+ ticketsQuantity?: number;
57
+ /** Total order price. */
58
+ totalPrice?: Money;
59
+ /** URL to ticket PDF. */
60
+ ticketsPdf?: string;
61
+ /** Tickets (generated after payment). */
62
+ tickets?: TicketingTicket[];
63
+ /** Whether the order is archived. */
64
+ archived?: boolean;
65
+ /** Whether the order is anonymized by GDPR delete. */
66
+ anonymized?: boolean;
67
+ /** Guest full name. */
68
+ fullName?: string;
69
+ /** Order invoice. */
70
+ invoice?: Invoice;
71
+ /** Whether all tickets in order are checked-in. */
72
+ fullyCheckedIn?: boolean;
73
+ /** Internal order payment details */
74
+ paymentDetails?: PaymentDetails;
75
+ /** Checkout channel type */
76
+ channel?: ChannelType;
77
+ /**
78
+ * Order updated timestamp.
79
+ * @readonly
80
+ */
81
+ updated?: Date | null;
82
+ /** Whether marketing consent was given */
83
+ marketingConsent?: boolean | null;
84
+ }
85
+ interface FormResponse {
86
+ /**
87
+ * Input values entered when filling the form.
88
+ * @maxSize 200
89
+ */
90
+ inputValues?: InputValue[];
91
+ }
92
+ interface InputValue {
93
+ /**
94
+ * Input field name.
95
+ * @maxLength 100
96
+ */
97
+ inputName?: string;
98
+ /**
99
+ * Text entered into the input field.
100
+ * @maxLength 5000
101
+ */
102
+ value?: string;
103
+ /**
104
+ * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
105
+ * @maxSize 100
106
+ * @maxLength 5000
107
+ */
108
+ values?: string[];
109
+ }
110
+ declare enum OrderStatus {
111
+ /** Order status not available for this request fieldset. */
112
+ NA_ORDER_STATUS = "NA_ORDER_STATUS",
113
+ /** Order is confirmed and payment isn't required. */
114
+ FREE = "FREE",
115
+ /** Order is paid for but the payment gateway has suspended the payment. */
116
+ PENDING = "PENDING",
117
+ /** Order is paid via a payment gateway. */
118
+ PAID = "PAID",
119
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
120
+ OFFLINE_PENDING = "OFFLINE_PENDING",
121
+ /** Order is awaiting payment at the cashier. */
122
+ INITIATED = "INITIATED",
123
+ /** Order is canceled. */
124
+ CANCELED = "CANCELED",
125
+ /** Order payment is declined. */
126
+ DECLINED = "DECLINED",
127
+ /** Order payment is authorized. */
128
+ AUTHORIZED = "AUTHORIZED",
129
+ /** Order payment is voided. */
130
+ VOIDED = "VOIDED",
131
+ /** Order is partially paid with less than the total amount. */
132
+ PARTIALLY_PAID = "PARTIALLY_PAID"
133
+ }
134
+ interface Money {
135
+ /**
136
+ * *Deprecated:** Use `value` instead.
137
+ * @format DECIMAL_VALUE
138
+ * @deprecated
139
+ */
140
+ amount?: string;
141
+ /**
142
+ * ISO 4217 format of the currency e.g., `USD`.
143
+ * @format CURRENCY
144
+ */
145
+ currency?: string;
146
+ /**
147
+ * 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.
148
+ * @format DECIMAL_VALUE
149
+ */
150
+ value?: string | null;
151
+ }
152
+ interface TicketingTicket {
153
+ /** Unique ticket number (issued automatically). */
154
+ ticketNumber?: string;
155
+ /** Associated order number. */
156
+ orderNumber?: string;
157
+ /**
158
+ * Ticket definition ID.
159
+ * @format GUID
160
+ */
161
+ ticketDefinitionId?: string;
162
+ /** Ticket name. */
163
+ name?: string;
164
+ /** Ticket price. */
165
+ price?: Money;
166
+ /**
167
+ * Whether ticket requires payment.
168
+ * @readonly
169
+ */
170
+ free?: boolean;
171
+ /** Ticket policy (as displayed in PDF). */
172
+ policy?: string;
173
+ /**
174
+ * Deprecated, use `check_in_url`.
175
+ * @deprecated
176
+ */
177
+ qrCode?: string;
178
+ /** Ticket check-in. */
179
+ checkIn?: CheckIn;
180
+ /** Associated order status. */
181
+ orderStatus?: OrderStatus;
182
+ /** Whether order and ticket are visible in order list. */
183
+ orderArchived?: boolean;
184
+ /** Buyer full name. */
185
+ orderFullName?: string;
186
+ /** Guest full name. */
187
+ guestFullName?: string | null;
188
+ /** Guest personal details. */
189
+ guestDetails?: GuestDetails;
190
+ /** Whether ticket is visible in guest list. */
191
+ archived?: boolean;
192
+ /**
193
+ * Deprecated, use `ticket_pdf_url`.
194
+ * @deprecated
195
+ */
196
+ ticketPdf?: string;
197
+ /**
198
+ * Ticket owner member ID.
199
+ * @format GUID
200
+ */
201
+ memberId?: string | null;
202
+ /**
203
+ * Whether ticket was anonymized by GDPR delete.
204
+ * Anonymized tickets no longer contain personally identifiable information (PII).
205
+ */
206
+ anonymized?: boolean;
207
+ /**
208
+ * Ticket check-in URL.
209
+ * Shown as QR code image in PDF.
210
+ * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
211
+ * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
212
+ */
213
+ checkInUrl?: string;
214
+ /** URL for ticket PDF download. */
215
+ ticketPdfUrl?: string;
216
+ /** Associated order checkout channel type */
217
+ channel?: ChannelType;
218
+ /**
219
+ * URL to download ticket in .pkpass format for Apple Wallet
220
+ * @format WEB_URL
221
+ * @readonly
222
+ */
223
+ walletPassUrl?: string;
224
+ /**
225
+ * Whether ticket is canceled.
226
+ * @readonly
227
+ */
228
+ canceled?: boolean | null;
229
+ }
230
+ interface CheckIn {
231
+ /** Time of check-in */
232
+ created?: Date | null;
233
+ }
234
+ interface GuestDetails {
235
+ /** Whether ticket belongs to assigned guest. */
236
+ guestAssigned?: boolean;
237
+ /** Guest first name. */
238
+ firstName?: string | null;
239
+ /** Guest last name. */
240
+ lastName?: string | null;
241
+ /**
242
+ * Guest email.
243
+ * @format EMAIL
244
+ */
245
+ email?: string | null;
246
+ /** Full form response. */
247
+ form?: FormResponse;
248
+ /**
249
+ * Contact ID associated with this guest.
250
+ * @format GUID
251
+ */
252
+ contactId?: string | null;
253
+ /**
254
+ * Guest phone number.
255
+ * @format PHONE
256
+ */
257
+ phone?: string | null;
258
+ }
259
+ declare enum ChannelType {
260
+ /** Buyer created the order via an online channel such as a website or mobile app. */
261
+ ONLINE = "ONLINE",
262
+ /** Sales person created the order and collected the money. */
263
+ OFFLINE_POS = "OFFLINE_POS"
264
+ }
265
+ interface TicketDetails {
266
+ /**
267
+ * Unique seat id in the event venue.
268
+ * @minLength 1
269
+ * @maxLength 36
270
+ */
271
+ seatId?: string | null;
272
+ /**
273
+ * Optional sector label.
274
+ * @readonly
275
+ */
276
+ sectionLabel?: string | null;
277
+ /**
278
+ * Area label.
279
+ * @readonly
280
+ */
281
+ areaLabel?: string | null;
282
+ /**
283
+ * Table label.
284
+ * @readonly
285
+ */
286
+ tableLabel?: string | null;
287
+ /**
288
+ * Row label.
289
+ * @readonly
290
+ */
291
+ rowLabel?: string | null;
292
+ /**
293
+ * Seat label in a row or table.
294
+ * @readonly
295
+ */
296
+ seatLabel?: string | null;
297
+ /**
298
+ * Number of places in the spot. If not provided - defaults to 1.
299
+ * @min 1
300
+ * @max 50
301
+ */
302
+ capacity?: number | null;
303
+ /**
304
+ * Custom pricing of ticket.
305
+ * @format DECIMAL_VALUE
306
+ */
307
+ priceOverride?: string | null;
308
+ /**
309
+ * Pricing option id.
310
+ * @format GUID
311
+ */
312
+ pricingOptionId?: string | null;
313
+ /**
314
+ * Pricing option name.
315
+ * @readonly
316
+ */
317
+ pricingOptionName?: string | null;
318
+ }
319
+ interface Invoice {
320
+ items?: Item[];
321
+ /**
322
+ * Total cart amount.
323
+ * @deprecated
324
+ */
325
+ total?: Money;
326
+ /** Discount applied to cart. */
327
+ discount?: Discount;
328
+ /** Tax applied to cart. */
329
+ tax?: Tax;
330
+ /** Total cart amount before discount, tax, and fees. */
331
+ subTotal?: Money;
332
+ /**
333
+ * Total amount of cart after discount, tax, and fees.
334
+ * Grand total is calculated in the following order:
335
+ * 1. Total prices of all items in the cart are calculated.
336
+ * 2. Discount is subtracted from the cart (if applicable).
337
+ * 3. Tax is added (if applicable).
338
+ * 4. Wix ticket service fee is added.
339
+ */
340
+ grandTotal?: Money;
341
+ /**
342
+ * Fees applied to the cart.
343
+ * @readonly
344
+ */
345
+ fees?: Fee[];
346
+ /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
347
+ revenue?: Money;
348
+ /** URL to invoice preview. Returned only if order is paid. */
349
+ previewUrl?: string | null;
350
+ }
351
+ interface Item {
352
+ /**
353
+ * Unique line item ID.
354
+ * @format GUID
355
+ */
356
+ id?: string;
357
+ /**
358
+ * Line item quantity.
359
+ * @min 1
360
+ * @max 50
361
+ */
362
+ quantity?: number;
363
+ /** Line item name. */
364
+ name?: string;
365
+ /** Line item price. */
366
+ price?: Money;
367
+ /** Total price for line items. Always equal to price * quantity. */
368
+ total?: Money;
369
+ /** Discount applied to the line item. */
370
+ discount?: Discount;
371
+ /** Tax applied to the item. */
372
+ tax?: Tax;
373
+ /**
374
+ * Fees applied to the item.
375
+ * @readonly
376
+ */
377
+ fees?: Fee[];
378
+ }
379
+ interface Discount {
380
+ /** Total discount amount. */
381
+ amount?: Money;
382
+ /** Total charge after applied discount. */
383
+ afterDiscount?: Money;
384
+ /**
385
+ * Discount coupon code.
386
+ * @deprecated
387
+ */
388
+ code?: string;
389
+ /**
390
+ * Discount coupon name.
391
+ * @deprecated
392
+ */
393
+ name?: string;
394
+ /**
395
+ * Discount coupon ID.
396
+ * @deprecated
397
+ */
398
+ couponId?: string;
399
+ /** Discount items. */
400
+ discounts?: DiscountItem[];
401
+ }
402
+ interface DiscountItem extends DiscountItemDiscountOneOf {
403
+ /** Coupon discount. */
404
+ coupon?: CouponDiscount;
405
+ /** Pricing plan discount. */
406
+ paidPlan?: PaidPlanDiscount;
407
+ /** Total discount amount. */
408
+ amount?: Money;
409
+ }
410
+ /** @oneof */
411
+ interface DiscountItemDiscountOneOf {
412
+ /** Coupon discount. */
413
+ coupon?: CouponDiscount;
414
+ /** Pricing plan discount. */
415
+ paidPlan?: PaidPlanDiscount;
416
+ }
417
+ interface CouponDiscount {
418
+ /** Discount coupon name. */
419
+ name?: string;
420
+ /** Discount coupon code. */
421
+ code?: string;
422
+ /** Discount coupon ID. */
423
+ couponId?: string;
424
+ }
425
+ interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
426
+ /** Discount by percentage applied to tickets. */
427
+ percentDiscount?: PercentDiscount;
428
+ /** Name of pricing plan. */
429
+ name?: string;
430
+ }
431
+ /** @oneof */
432
+ interface PaidPlanDiscountDiscountOneOf {
433
+ /** Discount by percentage applied to tickets. */
434
+ percentDiscount?: PercentDiscount;
435
+ }
436
+ interface PercentDiscount {
437
+ /**
438
+ * Percent rate.
439
+ * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
440
+ */
441
+ rate?: string;
442
+ /** Number of discounted tickets. */
443
+ quantityDiscounted?: number;
444
+ }
445
+ interface Tax {
446
+ /** Tax type. */
447
+ type?: TaxType;
448
+ /**
449
+ * Tax name.
450
+ * @readonly
451
+ */
452
+ name?: string;
453
+ /**
454
+ * Tax rate.
455
+ * @format DECIMAL_VALUE
456
+ */
457
+ rate?: string;
458
+ /** Taxable amount. */
459
+ taxable?: Money;
460
+ /** Total tax amount. */
461
+ amount?: Money;
462
+ }
463
+ declare enum TaxType {
464
+ /** Tax is included in the ticket price. */
465
+ INCLUDED = "INCLUDED",
466
+ /** Tax is added to the order at the checkout. */
467
+ ADDED = "ADDED",
468
+ /** Tax is added to the final total at the checkout. */
469
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
470
+ }
471
+ interface Fee {
472
+ /** Fee identifier. */
473
+ name?: FeeName;
474
+ /** How fee is calculated. */
475
+ type?: FeeType;
476
+ /**
477
+ * Fee rate.
478
+ * @format DECIMAL_VALUE
479
+ * @readonly
480
+ */
481
+ rate?: string;
482
+ /** Total amount of fee charges. */
483
+ amount?: Money;
484
+ }
485
+ declare enum FeeName {
486
+ /** Wix ticket service fee charges applied to the line item. */
487
+ WIX_FEE = "WIX_FEE"
488
+ }
489
+ declare enum FeeType {
490
+ /** Fee is added to the ticket price at checkout. */
491
+ FEE_ADDED = "FEE_ADDED",
492
+ /** Seller absorbs the fee. It is deducted from the ticket price. */
493
+ FEE_INCLUDED = "FEE_INCLUDED",
494
+ /** Fee is added to the ticket price at checkout. */
495
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
496
+ }
497
+ interface PaymentDetails {
498
+ /** Wix Payments transaction */
499
+ transaction?: PaymentTransaction;
500
+ }
501
+ interface PaymentTransaction {
502
+ /**
503
+ * Wix Payments transaction id
504
+ * @format GUID
505
+ * @readonly
506
+ */
507
+ transactionId?: string;
508
+ /**
509
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
510
+ * @readonly
511
+ */
512
+ method?: string;
513
+ }
514
+ interface ListOrdersRequest {
515
+ /** Offset. */
516
+ offset?: number;
517
+ /**
518
+ * Limit.
519
+ * @max 400
520
+ */
521
+ limit?: number;
522
+ /**
523
+ * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
524
+ * @maxSize 20
525
+ */
526
+ fieldset?: OrderFieldset[];
527
+ /** Status. */
528
+ status?: OrderStatus[];
529
+ /**
530
+ * Event ID.
531
+ * @format GUID
532
+ * @maxSize 100
533
+ */
534
+ eventId?: string[];
535
+ /**
536
+ * Order number.
537
+ * @maxLength 36
538
+ * @maxSize 500
539
+ */
540
+ orderNumber?: string[];
541
+ /**
542
+ * Site member ID.
543
+ * @format GUID
544
+ * @maxSize 500
545
+ */
546
+ memberId?: string[];
547
+ /**
548
+ * Field facets.
549
+ * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
550
+ * @maxLength 100
551
+ * @maxSize 20
552
+ */
553
+ facet?: string[];
554
+ /**
555
+ * Textual search filter - search is performed on "full_name", "email" and "order_number".
556
+ * @maxLength 200
557
+ */
558
+ searchPhrase?: string;
559
+ /**
560
+ * Event creator ID.
561
+ * @format GUID
562
+ * @maxSize 50
563
+ */
564
+ eventCreatorId?: string[];
565
+ /**
566
+ * Sort order. Defaults to "created:asc".
567
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
568
+ * @maxLength 100
569
+ */
570
+ sort?: string;
571
+ /** Order tag. */
572
+ tag?: OrderTag[];
573
+ /**
574
+ * Guest contact IDs.
575
+ * @format GUID
576
+ * @maxSize 100
577
+ */
578
+ contactId?: string[];
579
+ }
580
+ declare enum OrderFieldset {
581
+ /** Include tickets in response. */
582
+ TICKETS = "TICKETS",
583
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
584
+ DETAILS = "DETAILS",
585
+ /** Include `checkoutForm` in the response. */
586
+ FORM = "FORM",
587
+ /** Include `invoice` in the response. */
588
+ INVOICE = "INVOICE"
589
+ }
590
+ declare enum OrderTag {
591
+ /** Return only confirmed orders. */
592
+ CONFIRMED = "CONFIRMED",
593
+ /** Return only unconfirmed orders. */
594
+ UNCONFIRMED = "UNCONFIRMED",
595
+ /** Return only member orders. */
596
+ MEMBER = "MEMBER",
597
+ /** Return only archived orders. */
598
+ ARCHIVED = "ARCHIVED",
599
+ /** Return only non archived orders. */
600
+ NON_ARCHIVED = "NON_ARCHIVED",
601
+ /** Return only orders with all guests checked-in. */
602
+ FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
603
+ /** Return only orders with no guests checked-in. */
604
+ NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
605
+ }
606
+ interface ListOrdersResponse {
607
+ /** Total orders matching the given filters. */
608
+ total?: number;
609
+ /** Offset. */
610
+ offset?: number;
611
+ /**
612
+ * Limit.
613
+ * @max 100
614
+ */
615
+ limit?: number;
616
+ /** Orders. */
617
+ orders?: Order[];
618
+ /** Filter facets. */
619
+ facets?: Record<string, FacetCounts>;
620
+ /** Order data enriched facets. */
621
+ orderFacets?: OrderFacets;
622
+ }
623
+ interface FacetCounts {
624
+ /** Facet counts aggregated per value. */
625
+ counts?: Record<string, number>;
626
+ }
627
+ interface OrderFacets {
628
+ /** Filter facets. */
629
+ facets?: Record<string, OrderFacetCounts>;
630
+ }
631
+ interface OrderFacetCounts {
632
+ /** Facet counts aggregated per value */
633
+ counts?: Record<string, Counts>;
634
+ }
635
+ interface Counts {
636
+ /** Number or orders */
637
+ count?: number;
638
+ /** Number of tickets within orders */
639
+ tickets?: number;
640
+ /** Number of tickets with check-in */
641
+ ticketsCheckIn?: number;
642
+ }
643
+ interface GetOrderRequest {
644
+ /**
645
+ * Event ID.
646
+ * @format GUID
647
+ */
648
+ eventId: string;
649
+ /**
650
+ * Unique order number.
651
+ * @maxLength 36
652
+ */
653
+ orderNumber: string;
654
+ /**
655
+ * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
656
+ * @maxSize 20
657
+ */
658
+ fieldset?: OrderFieldset[];
659
+ }
660
+ interface GetOrderResponse {
661
+ /** Requested order. */
662
+ order?: Order;
663
+ /** "Add to calendar" links. */
664
+ calendarLinks?: CalendarLinks;
665
+ }
666
+ interface CalendarLinks {
667
+ /** "Add to Google calendar" URL. */
668
+ google?: string;
669
+ /** "Download ICS calendar file" URL. */
670
+ ics?: string;
671
+ }
672
+ interface UpdateOrderRequest {
673
+ /**
674
+ * Event ID.
675
+ * @format GUID
676
+ */
677
+ eventId: string;
678
+ /**
679
+ * Unique order number.
680
+ * @maxLength 36
681
+ */
682
+ orderNumber: string;
683
+ /** Set of field paths to update. */
684
+ fields?: string[];
685
+ /** Checkout form. */
686
+ checkoutForm?: FormResponse;
687
+ /** Whether order is archived. */
688
+ archived?: boolean;
689
+ }
690
+ interface UpdateOrderResponse {
691
+ /** Updated order. */
692
+ order?: Order;
693
+ }
694
+ interface BulkUpdateOrdersRequest {
695
+ /**
696
+ * Event ID.
697
+ * @format GUID
698
+ */
699
+ eventId: string;
700
+ /**
701
+ * @minLength 1
702
+ * @maxLength 36
703
+ * @minSize 1
704
+ * @maxSize 100
705
+ */
706
+ orderNumber?: string[];
707
+ /** Set of fields to update. */
708
+ fields?: string[];
709
+ /** Whether to archive the order. */
710
+ archived?: boolean;
711
+ }
712
+ interface BulkUpdateOrdersResponse {
713
+ /** Updated orders. */
714
+ orders?: Order[];
715
+ }
716
+ interface ConfirmOrderRequest {
717
+ /**
718
+ * Event ID.
719
+ * @format GUID
720
+ */
721
+ eventId: string;
722
+ /**
723
+ * Order numbers.
724
+ * @minLength 1
725
+ * @maxLength 36
726
+ * @maxSize 100
727
+ */
728
+ orderNumber?: string[];
729
+ }
730
+ interface ConfirmOrderResponse {
731
+ /** Confirmed orders. */
732
+ orders?: Order[];
733
+ }
734
+ interface GetSummaryRequest {
735
+ /**
736
+ * Event ID.
737
+ * @format GUID
738
+ */
739
+ eventId?: string | null;
740
+ }
741
+ interface GetSummaryResponse {
742
+ /** Ticket sales grouped by currency. */
743
+ sales?: TicketSales[];
744
+ }
745
+ interface TicketSales {
746
+ /** Total balance of confirmed transactions. */
747
+ total?: Money;
748
+ /** Total number of confirmed orders. */
749
+ totalOrders?: number;
750
+ /** Total number of tickets purchased. */
751
+ totalTickets?: number;
752
+ /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
753
+ revenue?: Money;
754
+ }
755
+ interface CaptureAuthorizedPaymentRequest {
756
+ /**
757
+ * Event ID.
758
+ * @format GUID
759
+ */
760
+ eventId?: string;
761
+ /**
762
+ * Order number.
763
+ * @minLength 1
764
+ * @maxLength 36
765
+ */
766
+ orderNumber: string;
767
+ }
768
+ interface CaptureAuthorizedPaymentResponse {
769
+ }
770
+ interface VoidAuthorizedPaymentRequest {
771
+ /**
772
+ * Event ID.
773
+ * @format GUID
774
+ */
775
+ eventId?: string;
776
+ /**
777
+ * Order number.
778
+ * @minLength 1
779
+ * @maxLength 36
780
+ */
781
+ orderNumber: string;
782
+ }
783
+ interface VoidAuthorizedPaymentResponse {
784
+ }
785
+ declare enum ReservationStatus {
786
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
787
+ RESERVATION_PENDING = "RESERVATION_PENDING",
788
+ /** The reservation is confirmed and will not expire. */
789
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
790
+ /** The reservation is canceled because of non payment. */
791
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
792
+ /** The reservation is canceled manually by the buyer. */
793
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
794
+ /** The reservation is expired. */
795
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
796
+ }
797
+ interface GetCheckoutOptionsRequest {
798
+ }
799
+ interface GetCheckoutOptionsResponse {
800
+ /** Whether any payment method is configured and available for payment. */
801
+ paymentMethodConfigured?: boolean;
802
+ /** Whether coupons are accepted at checkout. */
803
+ acceptCoupons?: boolean;
804
+ /** 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". */
805
+ premiumServices?: boolean;
806
+ /** Whether there are any paid tickets available for sale. */
807
+ paidTickets?: boolean;
808
+ /** Whether gift cards are accepted at checkout. */
809
+ acceptGiftCards?: boolean;
810
+ }
811
+ interface ListAvailableTicketsRequest {
812
+ /**
813
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
814
+ * @format GUID
815
+ */
816
+ eventId?: string;
817
+ /** Offset. */
818
+ offset?: number;
819
+ /**
820
+ * Limit.
821
+ * @max 100
822
+ */
823
+ limit?: number;
824
+ /**
825
+ * Sort order, defaults to "created:asc".
826
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
827
+ * @maxLength 100
828
+ */
829
+ sort?: string;
830
+ state?: State[];
831
+ }
832
+ declare enum State {
833
+ INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
834
+ }
835
+ interface ListAvailableTicketsResponse {
836
+ /** Ticket definitions meta data. */
837
+ metaData?: ResponseMetaData;
838
+ /** Ticket definitions. */
839
+ definitions?: TicketDefinition[];
840
+ }
841
+ interface ResponseMetaData {
842
+ /** Number of items in the response. */
843
+ count?: number;
844
+ /** Offset of items. */
845
+ offset?: number;
846
+ /** Total number of matching items. */
847
+ total?: number;
848
+ }
849
+ interface TicketDefinition {
850
+ /**
851
+ * Ticket definition ID.
852
+ * @format GUID
853
+ */
854
+ id?: string;
855
+ /** Ticket price. */
856
+ price?: Money;
857
+ /** Whether the ticket is free (read only). */
858
+ free?: boolean;
859
+ /** Ticket name. */
860
+ name?: string;
861
+ /** Ticket description. */
862
+ description?: string;
863
+ /**
864
+ * Limit of tickets that can be purchased per checkout.
865
+ * Set to 20 for unlimited ticket definition.
866
+ * @max 20
867
+ */
868
+ limitPerCheckout?: number;
869
+ /** Custom sort index. */
870
+ orderIndex?: number;
871
+ /** Policy information plain text block, as printed on the ticket. */
872
+ policy?: string;
873
+ /** Sensitive dashboard data. */
874
+ dashboard?: Dashboard;
875
+ /**
876
+ * Event ID associated with the ticket.
877
+ * @format GUID
878
+ */
879
+ eventId?: string;
880
+ /**
881
+ * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
882
+ * @readonly
883
+ */
884
+ wixFeeConfig?: WixFeeConfig;
885
+ /** Ticket sale period. */
886
+ salePeriod?: TicketSalePeriod;
887
+ /**
888
+ * Ticket sale status.
889
+ * @readonly
890
+ */
891
+ saleStatus?: TicketSaleStatus;
892
+ /** Ticket state. */
893
+ state?: State[];
894
+ /** Ticket pricing. */
895
+ pricing?: TicketPricing;
896
+ }
897
+ interface Dashboard {
898
+ /** Whether ticket is hidden and cannot be sold. */
899
+ hidden?: boolean;
900
+ /**
901
+ * Number of tickets sold and reserved.
902
+ * @deprecated
903
+ */
904
+ sold?: number;
905
+ /** Whether the ticket has limited quantity. */
906
+ limited?: boolean;
907
+ /** Ticket limit. `NULL` for unlimited ticket definitions. */
908
+ quantity?: number | null;
909
+ /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
910
+ unsold?: number | null;
911
+ /** Number of tickets sold. */
912
+ ticketsSold?: number;
913
+ /** Number of tickets reserved. */
914
+ ticketsReserved?: number;
915
+ }
916
+ interface WixFeeConfig {
917
+ /** Fee calculation method. */
918
+ type?: FeeType;
919
+ }
920
+ interface TicketSalePeriod {
921
+ /** Ticket sale start timestamp. */
922
+ startDate?: Date | null;
923
+ /** Ticket sale end timestamp. */
924
+ endDate?: Date | null;
925
+ /** Whether to hide this ticket if it's not on sale */
926
+ hideNotOnSale?: boolean;
927
+ }
928
+ declare enum TicketSaleStatus {
929
+ /** Ticket sale is scheduled to start. */
930
+ SALE_SCHEDULED = "SALE_SCHEDULED",
931
+ /** Ticket sale has started. */
932
+ SALE_STARTED = "SALE_STARTED",
933
+ /** Ticket sale has ended. */
934
+ SALE_ENDED = "SALE_ENDED"
935
+ }
936
+ interface TicketPricing extends TicketPricingPriceOneOf {
937
+ /** Ticket price which is read only. */
938
+ fixedPrice?: Money;
939
+ /** Min price per ticket, customizable. */
940
+ minPrice?: Money;
941
+ /** Ticket pricing options. */
942
+ pricingOptions?: PricingOptions;
943
+ /**
944
+ * Ticket pricing type.
945
+ * @readonly
946
+ */
947
+ pricingType?: Type;
948
+ }
949
+ /** @oneof */
950
+ interface TicketPricingPriceOneOf {
951
+ /** Ticket price which is read only. */
952
+ fixedPrice?: Money;
953
+ /** Min price per ticket, customizable. */
954
+ minPrice?: Money;
955
+ /** Ticket pricing options. */
956
+ pricingOptions?: PricingOptions;
957
+ }
958
+ interface PricingOptions {
959
+ /** Multiple ticket pricing options. */
960
+ options?: PricingOption[];
961
+ }
962
+ interface PricingOption {
963
+ /**
964
+ * Ticket pricing option ID.
965
+ * @format GUID
966
+ */
967
+ id?: string | null;
968
+ /**
969
+ * Ticket pricing option name.
970
+ * @minLength 1
971
+ * @maxLength 200
972
+ */
973
+ name?: string | null;
974
+ /** Ticket pricing option price. */
975
+ price?: Money;
976
+ }
977
+ declare enum Type {
978
+ STANDARD = "STANDARD",
979
+ DONATION = "DONATION"
980
+ }
981
+ interface QueryAvailableTicketsRequest {
982
+ /** Offset. */
983
+ offset?: number;
984
+ /**
985
+ * Limit.
986
+ * @max 1000
987
+ */
988
+ limit?: number;
989
+ /**
990
+ * Ticket definition.
991
+ * See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
992
+ */
993
+ filter?: Record<string, any> | null;
994
+ /** @maxSize 20 */
995
+ fieldset?: TicketDefinitionFieldset[];
996
+ /**
997
+ * Sort order, defaults to "created:asc".
998
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
999
+ * @maxLength 100
1000
+ */
1001
+ sort?: string;
1002
+ }
1003
+ declare enum TicketDefinitionFieldset {
1004
+ /** Include `policy` in the response. */
1005
+ POLICY = "POLICY",
1006
+ /** Include `dashboard` in the response. */
1007
+ DASHBOARD = "DASHBOARD"
1008
+ }
1009
+ interface QueryAvailableTicketsResponse {
1010
+ /** Ticket definitions meta data. */
1011
+ metaData?: ResponseMetaData;
1012
+ /** Ticket definitions. */
1013
+ definitions?: TicketDefinition[];
1014
+ }
1015
+ interface CreateReservationRequest {
1016
+ /**
1017
+ * Event ID.
1018
+ * @format GUID
1019
+ */
1020
+ eventId: string;
1021
+ /**
1022
+ * Tickets to reserve.
1023
+ * @minSize 1
1024
+ * @maxSize 50
1025
+ */
1026
+ ticketQuantities?: TicketReservationQuantity[];
1027
+ /** Whether to ignore the available ticket limits upon reservation. */
1028
+ ignoreLimits?: boolean;
1029
+ /** Whether to allow reservation for hidden tickets. */
1030
+ allowHiddenTickets?: boolean;
1031
+ }
1032
+ interface TicketReservationQuantity {
1033
+ /**
1034
+ * Ticket definition ID.
1035
+ * @format GUID
1036
+ */
1037
+ ticketDefinitionId?: string;
1038
+ /**
1039
+ * Quantity of tickets to reserve.
1040
+ * @min 1
1041
+ * @max 50
1042
+ */
1043
+ quantity?: number;
1044
+ /**
1045
+ * Ticket price to charge - overriding the ticket price.
1046
+ * @maxLength 13
1047
+ * @format DECIMAL_VALUE
1048
+ */
1049
+ priceOverride?: string | null;
1050
+ /** Optional ticket details */
1051
+ ticketDetails?: TicketDetails[];
1052
+ }
1053
+ interface CreateReservationResponse {
1054
+ /**
1055
+ * Reservation ID.
1056
+ * @format GUID
1057
+ */
1058
+ id?: string;
1059
+ /** Reservation expiration timestamp. */
1060
+ expires?: Date | null;
1061
+ /** Ticket reservations. */
1062
+ reservations?: TicketReservation[];
1063
+ /** Reservation invoice. */
1064
+ invoice?: Invoice;
1065
+ /** Reservation status. */
1066
+ reservationStatus?: ReservationStatus;
1067
+ }
1068
+ interface TicketReservation {
1069
+ /**
1070
+ * Quantity of reserved tickets.
1071
+ * @min 1
1072
+ * @max 20
1073
+ */
1074
+ quantity?: number;
1075
+ ticket?: TicketDefinition;
1076
+ /** Optional ticket details. */
1077
+ ticketDetails?: TicketDetails[];
1078
+ }
1079
+ interface CancelReservationRequest {
1080
+ /**
1081
+ * Event ID.
1082
+ * @format GUID
1083
+ */
1084
+ eventId: string;
1085
+ /**
1086
+ * Reservation ID.
1087
+ * @format GUID
1088
+ */
1089
+ id: string;
1090
+ }
1091
+ interface CancelReservationResponse {
1092
+ }
1093
+ interface GetInvoiceRequest {
1094
+ /**
1095
+ * Event ID.
1096
+ * @format GUID
1097
+ */
1098
+ eventId: string;
1099
+ /**
1100
+ * Reservation ID.
1101
+ * @format GUID
1102
+ */
1103
+ reservationId: string;
1104
+ /** Optional discount to be applied on the returned invoice. */
1105
+ withDiscount?: DiscountRequest;
1106
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1107
+ paidPlanBenefit?: PaidPlanBenefit;
1108
+ }
1109
+ interface DiscountRequest {
1110
+ /**
1111
+ * Discount coupon code.
1112
+ * @maxLength 20
1113
+ */
1114
+ couponCode?: string;
1115
+ }
1116
+ interface PaidPlanBenefit {
1117
+ /**
1118
+ * Pricing plan ID.
1119
+ * @format GUID
1120
+ */
1121
+ planOrderId?: string;
1122
+ /**
1123
+ * Pricing plan benefit ID.
1124
+ * @format GUID
1125
+ */
1126
+ benefitId?: string;
1127
+ }
1128
+ interface GetInvoiceResponse {
1129
+ /** Invoice with applied discount. */
1130
+ invoice?: Invoice;
1131
+ /** Discount errors, if relevant. */
1132
+ discountErrors?: DiscountErrors;
1133
+ /** Time when the reservation expires. */
1134
+ expires?: Date | null;
1135
+ /** Reservation status. */
1136
+ reservationStatus?: ReservationStatus;
1137
+ /** Whether this reservation is already used in checkout. */
1138
+ reservationOccupied?: boolean;
1139
+ /** Ticket reservations. */
1140
+ reservations?: TicketReservation[];
1141
+ }
1142
+ interface DiscountErrors {
1143
+ /** Error. */
1144
+ error?: Error[];
1145
+ }
1146
+ interface Error {
1147
+ code?: string;
1148
+ }
1149
+ interface CheckoutRequest {
1150
+ /**
1151
+ * Event ID.
1152
+ * @format GUID
1153
+ */
1154
+ eventId: string;
1155
+ /**
1156
+ * Ticket reservation ID.
1157
+ * @format GUID
1158
+ */
1159
+ reservationId?: string;
1160
+ /** Member ID (if empty - no site member is associated to this order). */
1161
+ memberId?: string;
1162
+ /** Discount to apply on the invoice. */
1163
+ discount?: DiscountRequest;
1164
+ /** Buyer details. */
1165
+ buyer?: Buyer;
1166
+ /**
1167
+ * Guest details.
1168
+ * @minSize 1
1169
+ * @maxSize 50
1170
+ */
1171
+ guests?: Guest[];
1172
+ /** Benefit granted by the pricing plan. */
1173
+ paidPlanBenefit?: PaidPlanBenefit;
1174
+ /** Options controlling the checkout process. */
1175
+ options?: CheckoutOptions;
1176
+ /** Whether marketing consent was given */
1177
+ marketingConsent?: boolean | null;
1178
+ }
1179
+ interface Buyer {
1180
+ /**
1181
+ * Buyer first name.
1182
+ * @minLength 1
1183
+ * @maxLength 50
1184
+ */
1185
+ firstName?: string;
1186
+ /**
1187
+ * Buyer last name.
1188
+ * @minLength 1
1189
+ * @maxLength 50
1190
+ */
1191
+ lastName?: string;
1192
+ /**
1193
+ * Buyer email.
1194
+ * @format EMAIL
1195
+ * @minLength 5
1196
+ * @maxLength 255
1197
+ */
1198
+ email?: string;
1199
+ }
1200
+ interface Guest {
1201
+ /** Specific guest info. */
1202
+ form?: FormResponse;
1203
+ }
1204
+ interface CheckoutOptions {
1205
+ /** Whether to ignore settings to notify contacts or users. */
1206
+ silent?: boolean;
1207
+ /** 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. */
1208
+ payInPerson?: boolean;
1209
+ /** Whether to ignore form validation. */
1210
+ ignoreFormValidation?: boolean;
1211
+ /** Marks payment as already paid */
1212
+ markAsPaid?: boolean | null;
1213
+ }
1214
+ interface CheckoutResponse {
1215
+ /** Created order. */
1216
+ order?: Order;
1217
+ /** Time when the order expires, applies to orders with status = INITIATED. */
1218
+ expires?: Date | null;
1219
+ /** Ticket reservations. */
1220
+ reservations?: TicketReservation[];
1221
+ /** Order page url. */
1222
+ orderPageUrl?: string | null;
1223
+ }
1224
+ interface UpdateCheckoutRequest {
1225
+ /**
1226
+ * Event ID.
1227
+ * @format GUID
1228
+ */
1229
+ eventId: string;
1230
+ /**
1231
+ * Unique order number.
1232
+ * @maxLength 36
1233
+ */
1234
+ orderNumber: string;
1235
+ /** Buyer details. */
1236
+ buyer?: Buyer;
1237
+ /**
1238
+ * Guest details.
1239
+ * @minSize 1
1240
+ * @maxSize 20
1241
+ */
1242
+ guests?: Guest[];
1243
+ /** Member ID (if empty - no site member is associated to this order). */
1244
+ memberId?: string | null;
1245
+ /** Discount to apply on the invoice. */
1246
+ discount?: DiscountRequest;
1247
+ /** Benefit granted by the pricing plan. */
1248
+ paidPlanBenefit?: PaidPlanBenefit;
1249
+ }
1250
+ interface UpdateCheckoutResponse {
1251
+ /** Updated order. */
1252
+ order?: Order;
1253
+ /** Order page url. */
1254
+ orderPageUrl?: string | null;
1255
+ }
1256
+ interface PosCheckoutRequest {
1257
+ /**
1258
+ * Event ID.
1259
+ * @format GUID
1260
+ */
1261
+ eventId: string;
1262
+ /**
1263
+ * Ticket reservation ID.
1264
+ * @format GUID
1265
+ */
1266
+ reservationId: string;
1267
+ /**
1268
+ * Payment details ID.
1269
+ * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
1270
+ * @format GUID
1271
+ */
1272
+ paymentDetailsId?: string | null;
1273
+ }
1274
+ interface PosCheckoutResponse {
1275
+ /** Created order. */
1276
+ order?: Order;
1277
+ /** Time when the order expires, applies to orders with status = INITIATED. */
1278
+ expires?: Date | null;
1279
+ /** Ticket reservations. */
1280
+ reservations?: TicketReservation[];
1281
+ }
1282
+
1283
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1284
+ getUrl: (context: any) => string;
1285
+ httpMethod: K;
1286
+ path: string;
1287
+ pathParams: M;
1288
+ __requestType: T;
1289
+ __originalRequestType: S;
1290
+ __responseType: Q;
1291
+ __originalResponseType: R;
1292
+ };
1293
+ declare function listOrders(): __PublicMethodMetaInfo<'GET', {}, ListOrdersRequest$1, ListOrdersRequest, ListOrdersResponse$1, ListOrdersResponse>;
1294
+ declare function getOrder(): __PublicMethodMetaInfo<'GET', {
1295
+ eventId: string;
1296
+ orderNumber: string;
1297
+ }, GetOrderRequest$1, GetOrderRequest, GetOrderResponse$1, GetOrderResponse>;
1298
+ declare function updateOrder(): __PublicMethodMetaInfo<'PATCH', {
1299
+ eventId: string;
1300
+ orderNumber: string;
1301
+ }, UpdateOrderRequest$1, UpdateOrderRequest, UpdateOrderResponse$1, UpdateOrderResponse>;
1302
+ declare function bulkUpdateOrders(): __PublicMethodMetaInfo<'PATCH', {
1303
+ eventId: string;
1304
+ }, BulkUpdateOrdersRequest$1, BulkUpdateOrdersRequest, BulkUpdateOrdersResponse$1, BulkUpdateOrdersResponse>;
1305
+ declare function confirmOrder(): __PublicMethodMetaInfo<'POST', {
1306
+ eventId: string;
1307
+ }, ConfirmOrderRequest$1, ConfirmOrderRequest, ConfirmOrderResponse$1, ConfirmOrderResponse>;
1308
+ declare function getSummary(): __PublicMethodMetaInfo<'GET', {}, GetSummaryRequest$1, GetSummaryRequest, GetSummaryResponse$1, GetSummaryResponse>;
1309
+ declare function captureAuthorizedPayment(): __PublicMethodMetaInfo<'POST', {
1310
+ orderNumber: string;
1311
+ }, CaptureAuthorizedPaymentRequest$1, CaptureAuthorizedPaymentRequest, CaptureAuthorizedPaymentResponse$1, CaptureAuthorizedPaymentResponse>;
1312
+ declare function voidAuthorizedPayment(): __PublicMethodMetaInfo<'POST', {
1313
+ orderNumber: string;
1314
+ }, VoidAuthorizedPaymentRequest$1, VoidAuthorizedPaymentRequest, VoidAuthorizedPaymentResponse$1, VoidAuthorizedPaymentResponse>;
1315
+ declare function getCheckoutOptions(): __PublicMethodMetaInfo<'GET', {}, GetCheckoutOptionsRequest$1, GetCheckoutOptionsRequest, GetCheckoutOptionsResponse$1, GetCheckoutOptionsResponse>;
1316
+ declare function listAvailableTickets(): __PublicMethodMetaInfo<'GET', {}, ListAvailableTicketsRequest$1, ListAvailableTicketsRequest, ListAvailableTicketsResponse$1, ListAvailableTicketsResponse>;
1317
+ declare function queryAvailableTickets(): __PublicMethodMetaInfo<'POST', {}, QueryAvailableTicketsRequest$1, QueryAvailableTicketsRequest, QueryAvailableTicketsResponse$1, QueryAvailableTicketsResponse>;
1318
+ declare function createReservation(): __PublicMethodMetaInfo<'POST', {}, CreateReservationRequest$1, CreateReservationRequest, CreateReservationResponse$1, CreateReservationResponse>;
1319
+ declare function cancelReservation(): __PublicMethodMetaInfo<'DELETE', {
1320
+ id: string;
1321
+ }, CancelReservationRequest$1, CancelReservationRequest, CancelReservationResponse$1, CancelReservationResponse>;
1322
+ declare function getInvoice(): __PublicMethodMetaInfo<'POST', {
1323
+ reservationId: string;
1324
+ }, GetInvoiceRequest$1, GetInvoiceRequest, GetInvoiceResponse$1, GetInvoiceResponse>;
1325
+ declare function checkout(): __PublicMethodMetaInfo<'POST', {}, CheckoutRequest$1, CheckoutRequest, CheckoutResponse$1, CheckoutResponse>;
1326
+ declare function updateCheckout(): __PublicMethodMetaInfo<'PATCH', {
1327
+ orderNumber: string;
1328
+ }, UpdateCheckoutRequest$1, UpdateCheckoutRequest, UpdateCheckoutResponse$1, UpdateCheckoutResponse>;
1329
+ declare function posCheckout(): __PublicMethodMetaInfo<'POST', {}, PosCheckoutRequest$1, PosCheckoutRequest, PosCheckoutResponse$1, PosCheckoutResponse>;
1330
+
1331
+ export { type __PublicMethodMetaInfo, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };