@wix/auto_sdk_events_orders 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/build/{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/src/events-v1-order-orders.context.d.ts +0 -42
  66. package/build/es/src/events-v1-order-orders.context.js +0 -42
  67. package/build/es/src/events-v1-order-orders.context.js.map +0 -1
  68. package/build/es/src/events-v1-order-orders.http.d.ts +0 -97
  69. package/build/es/src/events-v1-order-orders.http.js +0 -1615
  70. package/build/es/src/events-v1-order-orders.http.js.map +0 -1
  71. package/build/es/src/events-v1-order-orders.meta.d.ts +0 -49
  72. package/build/es/src/events-v1-order-orders.meta.js +0 -308
  73. package/build/es/src/events-v1-order-orders.meta.js.map +0 -1
  74. package/build/es/src/events-v1-order-orders.public.d.ts +0 -202
  75. package/build/es/src/events-v1-order-orders.public.js +0 -211
  76. package/build/es/src/events-v1-order-orders.public.js.map +0 -1
  77. package/build/es/src/events-v1-order-orders.types.js +0 -175
  78. package/build/es/src/events-v1-order-orders.types.js.map +0 -1
  79. package/build/es/src/events-v1-order-orders.universal.d.ts +0 -3183
  80. package/build/es/src/events-v1-order-orders.universal.js +0 -1137
  81. package/build/es/src/events-v1-order-orders.universal.js.map +0 -1
  82. package/build/internal/cjs/index.d.ts +0 -1
  83. package/build/internal/cjs/index.js +0 -18
  84. package/build/internal/cjs/index.js.map +0 -1
  85. package/build/internal/cjs/index.typings.d.ts +0 -1
  86. package/build/internal/cjs/index.typings.js +0 -18
  87. package/build/internal/cjs/index.typings.js.map +0 -1
  88. package/build/internal/cjs/meta.d.ts +0 -1
  89. package/build/internal/cjs/meta.js +0 -18
  90. package/build/internal/cjs/meta.js.map +0 -1
  91. package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +0 -42
  92. package/build/internal/cjs/src/events-v1-order-orders.context.js +0 -62
  93. package/build/internal/cjs/src/events-v1-order-orders.context.js.map +0 -1
  94. package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +0 -97
  95. package/build/internal/cjs/src/events-v1-order-orders.http.js +0 -1635
  96. package/build/internal/cjs/src/events-v1-order-orders.http.js.map +0 -1
  97. package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
  98. package/build/internal/cjs/src/events-v1-order-orders.meta.js +0 -351
  99. package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +0 -1
  100. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +0 -202
  101. package/build/internal/cjs/src/events-v1-order-orders.public.js +0 -248
  102. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +0 -1
  103. package/build/internal/cjs/src/events-v1-order-orders.types.js +0 -178
  104. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +0 -1
  105. package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +0 -3183
  106. package/build/internal/cjs/src/events-v1-order-orders.universal.js +0 -1180
  107. package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +0 -1
  108. package/build/internal/es/index.d.ts +0 -1
  109. package/build/internal/es/index.js +0 -2
  110. package/build/internal/es/index.js.map +0 -1
  111. package/build/internal/es/index.typings.d.ts +0 -1
  112. package/build/internal/es/index.typings.js +0 -2
  113. package/build/internal/es/index.typings.js.map +0 -1
  114. package/build/internal/es/meta.d.ts +0 -1
  115. package/build/internal/es/meta.js +0 -2
  116. package/build/internal/es/meta.js.map +0 -1
  117. package/build/internal/es/src/events-v1-order-orders.context.d.ts +0 -42
  118. package/build/internal/es/src/events-v1-order-orders.context.js +0 -42
  119. package/build/internal/es/src/events-v1-order-orders.context.js.map +0 -1
  120. package/build/internal/es/src/events-v1-order-orders.http.d.ts +0 -97
  121. package/build/internal/es/src/events-v1-order-orders.http.js +0 -1615
  122. package/build/internal/es/src/events-v1-order-orders.http.js.map +0 -1
  123. package/build/internal/es/src/events-v1-order-orders.meta.d.ts +0 -49
  124. package/build/internal/es/src/events-v1-order-orders.meta.js +0 -308
  125. package/build/internal/es/src/events-v1-order-orders.meta.js.map +0 -1
  126. package/build/internal/es/src/events-v1-order-orders.public.d.ts +0 -202
  127. package/build/internal/es/src/events-v1-order-orders.public.js +0 -211
  128. package/build/internal/es/src/events-v1-order-orders.public.js.map +0 -1
  129. package/build/internal/es/src/events-v1-order-orders.types.js +0 -175
  130. package/build/internal/es/src/events-v1-order-orders.types.js.map +0 -1
  131. package/build/internal/es/src/events-v1-order-orders.universal.d.ts +0 -3183
  132. package/build/internal/es/src/events-v1-order-orders.universal.js +0 -1137
  133. package/build/internal/es/src/events-v1-order-orders.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface Order {
1
+ interface Order {
2
2
  /** Unique order number. */
3
3
  orderNumber?: string;
4
4
  /**
@@ -7,14 +7,13 @@ export interface Order {
7
7
  */
8
8
  reservationId?: string;
9
9
  /**
10
- * Payment snapshot ID.
11
- * Empty for FREE order.
10
+ * Payment snapshot ID. Empty for the `FREE` order.
12
11
  * @format GUID
13
12
  * @readonly
14
13
  */
15
14
  snapshotId?: string;
16
15
  /**
17
- * Event ID.
16
+ * Event ID to which the order belongs.
18
17
  * @format GUID
19
18
  */
20
19
  eventId?: string;
@@ -24,7 +23,7 @@ export interface Order {
24
23
  */
25
24
  contactId?: string;
26
25
  /**
27
- * Member ID of buyer (if relevant).
26
+ * Buyer member ID, if applicable.
28
27
  * @format GUID
29
28
  */
30
29
  memberId?: string;
@@ -46,15 +45,24 @@ export interface Order {
46
45
  checkoutForm?: FormResponse;
47
46
  /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
48
47
  confirmed?: boolean;
49
- /** Order status. */
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
+ */
50
58
  status?: OrderStatus;
51
59
  /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
52
60
  method?: string;
53
- /** Tickets ordered. */
61
+ /** Quantity of ordered tickets. */
54
62
  ticketsQuantity?: number;
55
63
  /** Total order price. */
56
64
  totalPrice?: Money;
57
- /** URL to ticket PDF. */
65
+ /** Ticket PDF URL. */
58
66
  ticketsPdf?: string;
59
67
  /** Tickets (generated after payment). */
60
68
  tickets?: TicketingTicket[];
@@ -80,32 +88,32 @@ export interface Order {
80
88
  /** Whether marketing consent was given */
81
89
  marketingConsent?: boolean | null;
82
90
  }
83
- export interface FormResponse {
91
+ interface FormResponse {
84
92
  /**
85
- * Input values entered when filling the form.
93
+ * Input fields for a checkout form.
86
94
  * @maxSize 200
87
95
  */
88
96
  inputValues?: InputValue[];
89
97
  }
90
- export interface InputValue {
98
+ interface InputValue {
91
99
  /**
92
100
  * Input field name.
93
101
  * @maxLength 100
94
102
  */
95
103
  inputName?: string;
96
104
  /**
97
- * Text entered into the input field.
105
+ * Input field value.
98
106
  * @maxLength 5000
99
107
  */
100
108
  value?: string;
101
109
  /**
102
- * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
110
+ * Multiple input field values.
103
111
  * @maxSize 100
104
112
  * @maxLength 5000
105
113
  */
106
114
  values?: string[];
107
115
  }
108
- export interface FormattedAddress {
116
+ interface FormattedAddress {
109
117
  /**
110
118
  * One line address representation.
111
119
  * @maxLength 200
@@ -115,11 +123,11 @@ export interface FormattedAddress {
115
123
  address?: Address;
116
124
  }
117
125
  /** Physical address */
118
- export interface Address extends AddressStreetOneOf {
126
+ interface Address extends AddressStreetOneOf {
119
127
  /** Street name and number. */
120
128
  streetAddress?: StreetAddress;
121
129
  /** Main address line, usually street and number as free text. */
122
- addressLine?: string | null;
130
+ addressLine1?: string | null;
123
131
  /**
124
132
  * Country code.
125
133
  * @format COUNTRY
@@ -135,31 +143,31 @@ export interface Address extends AddressStreetOneOf {
135
143
  addressLine2?: string | null;
136
144
  }
137
145
  /** @oneof */
138
- export interface AddressStreetOneOf {
146
+ interface AddressStreetOneOf {
139
147
  /** Street name and number. */
140
148
  streetAddress?: StreetAddress;
141
149
  /** Main address line, usually street and number as free text. */
142
150
  addressLine?: string | null;
143
151
  }
144
- export interface StreetAddress {
152
+ interface StreetAddress {
145
153
  /** Street number. */
146
154
  number?: string;
147
155
  /** Street name. */
148
156
  name?: string;
149
157
  }
150
- export interface AddressLocation {
158
+ interface AddressLocation {
151
159
  /** Address latitude. */
152
160
  latitude?: number | null;
153
161
  /** Address longitude. */
154
162
  longitude?: number | null;
155
163
  }
156
- export interface Subdivision {
164
+ interface Subdivision {
157
165
  /** Short subdivision code. */
158
166
  code?: string;
159
167
  /** Subdivision full name. */
160
168
  name?: string;
161
169
  }
162
- export declare enum SubdivisionType {
170
+ declare enum SubdivisionType {
163
171
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
164
172
  /** State */
165
173
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -175,14 +183,14 @@ export declare enum SubdivisionType {
175
183
  COUNTRY = "COUNTRY"
176
184
  }
177
185
  /** Subdivision Concordance values */
178
- export interface StandardDetails {
186
+ interface StandardDetails {
179
187
  /**
180
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
181
189
  * @maxLength 20
182
190
  */
183
191
  iso31662?: string | null;
184
192
  }
185
- export declare enum OrderStatus {
193
+ declare enum OrderStatus {
186
194
  /** Order status not available for this request fieldset. */
187
195
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
188
196
  /** Order is confirmed and payment isn't required. */
@@ -206,7 +214,7 @@ export declare enum OrderStatus {
206
214
  /** Order is partially paid with less than the total amount. */
207
215
  PARTIALLY_PAID = "PARTIALLY_PAID"
208
216
  }
209
- export interface Money {
217
+ interface Money {
210
218
  /**
211
219
  * *Deprecated:** Use `value` instead.
212
220
  * @format DECIMAL_VALUE
@@ -214,7 +222,7 @@ export interface Money {
214
222
  */
215
223
  amount?: string;
216
224
  /**
217
- * ISO 4217 format of the currency e.g., `USD`.
225
+ * Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
218
226
  * @format CURRENCY
219
227
  */
220
228
  currency?: string;
@@ -224,7 +232,7 @@ export interface Money {
224
232
  */
225
233
  value?: string | null;
226
234
  }
227
- export interface TicketingTicket {
235
+ interface TicketingTicket {
228
236
  /** Unique ticket number (issued automatically). */
229
237
  ticketNumber?: string;
230
238
  /** Associated order number. */
@@ -239,11 +247,11 @@ export interface TicketingTicket {
239
247
  /** Ticket price. */
240
248
  price?: Money;
241
249
  /**
242
- * Whether ticket requires payment.
250
+ * Whether the ticket requires payment.
243
251
  * @readonly
244
252
  */
245
253
  free?: boolean;
246
- /** Ticket policy (as displayed in PDF). */
254
+ /** Event and ticket policies. */
247
255
  policy?: string;
248
256
  /**
249
257
  * Deprecated, use `check_in_url`.
@@ -281,8 +289,8 @@ export interface TicketingTicket {
281
289
  anonymized?: boolean;
282
290
  /**
283
291
  * Ticket check-in URL.
284
- * Shown as QR code image in PDF.
285
- * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
292
+ * Shown as a QR code image in PDF.
293
+ * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`.
286
294
  * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
287
295
  */
288
296
  checkInUrl?: string;
@@ -291,7 +299,7 @@ export interface TicketingTicket {
291
299
  /** Associated order checkout channel type */
292
300
  channel?: ChannelType;
293
301
  /**
294
- * URL to download ticket in .pkpass format for Apple Wallet
302
+ * URL to download ticket in the `.pkpass` format for Apple Wallet
295
303
  * @format WEB_URL
296
304
  * @readonly
297
305
  */
@@ -302,11 +310,11 @@ export interface TicketingTicket {
302
310
  */
303
311
  canceled?: boolean | null;
304
312
  }
305
- export interface CheckIn {
313
+ interface CheckIn {
306
314
  /** Time of check-in */
307
315
  created?: Date | null;
308
316
  }
309
- export interface GuestDetails {
317
+ interface GuestDetails {
310
318
  /** Whether ticket belongs to assigned guest. */
311
319
  guestAssigned?: boolean;
312
320
  /** Guest first name. */
@@ -331,13 +339,13 @@ export interface GuestDetails {
331
339
  */
332
340
  phone?: string | null;
333
341
  }
334
- export declare enum ChannelType {
342
+ declare enum ChannelType {
335
343
  /** Buyer created the order via an online channel such as a website or mobile app. */
336
344
  ONLINE = "ONLINE",
337
345
  /** Sales person created the order and collected the money. */
338
346
  OFFLINE_POS = "OFFLINE_POS"
339
347
  }
340
- export interface TicketDetails {
348
+ interface TicketDetails {
341
349
  /**
342
350
  * Unique seat id in the event venue.
343
351
  * @minLength 1
@@ -391,14 +399,15 @@ export interface TicketDetails {
391
399
  */
392
400
  pricingOptionName?: string | null;
393
401
  }
394
- export interface Invoice {
402
+ interface Invoice {
403
+ /** Items listed in the invoice. */
395
404
  items?: Item[];
396
405
  /**
397
406
  * Total cart amount.
398
407
  * @deprecated
399
408
  */
400
409
  total?: Money;
401
- /** Discount applied to cart. */
410
+ /** Discount applied to a cart. */
402
411
  discount?: Discount;
403
412
  /** Tax applied to cart. */
404
413
  tax?: Tax;
@@ -420,15 +429,15 @@ export interface Invoice {
420
429
  fees?: Fee[];
421
430
  /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
422
431
  revenue?: Money;
423
- /** URL to invoice preview. Returned only if order is paid. */
432
+ /** Invoice preview URL. This value is only returned when the order is paid. */
424
433
  previewUrl?: string | null;
425
434
  }
426
- export interface Item {
435
+ interface Item {
427
436
  /**
428
437
  * Unique line item ID.
429
438
  * @format GUID
430
439
  */
431
- id?: string;
440
+ _id?: string;
432
441
  /**
433
442
  * Line item quantity.
434
443
  * @min 1
@@ -439,7 +448,7 @@ export interface Item {
439
448
  name?: string;
440
449
  /** Line item price. */
441
450
  price?: Money;
442
- /** Total price for line items. Always equal to price * quantity. */
451
+ /** Total price for line items. It's calculated by multiplying price and item quantity. */
443
452
  total?: Money;
444
453
  /** Discount applied to the line item. */
445
454
  discount?: Discount;
@@ -451,10 +460,10 @@ export interface Item {
451
460
  */
452
461
  fees?: Fee[];
453
462
  }
454
- export interface Discount {
463
+ interface Discount {
455
464
  /** Total discount amount. */
456
465
  amount?: Money;
457
- /** Total charge after applied discount. */
466
+ /** Total sum after the discount. */
458
467
  afterDiscount?: Money;
459
468
  /**
460
469
  * Discount coupon code.
@@ -474,7 +483,7 @@ export interface Discount {
474
483
  /** Discount items. */
475
484
  discounts?: DiscountItem[];
476
485
  }
477
- export interface DiscountItem extends DiscountItemDiscountOneOf {
486
+ interface DiscountItem extends DiscountItemDiscountOneOf {
478
487
  /** Coupon discount. */
479
488
  coupon?: CouponDiscount;
480
489
  /** Pricing plan discount. */
@@ -483,13 +492,13 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
483
492
  amount?: Money;
484
493
  }
485
494
  /** @oneof */
486
- export interface DiscountItemDiscountOneOf {
495
+ interface DiscountItemDiscountOneOf {
487
496
  /** Coupon discount. */
488
497
  coupon?: CouponDiscount;
489
498
  /** Pricing plan discount. */
490
499
  paidPlan?: PaidPlanDiscount;
491
500
  }
492
- export interface CouponDiscount {
501
+ interface CouponDiscount {
493
502
  /** Discount coupon name. */
494
503
  name?: string;
495
504
  /** Discount coupon code. */
@@ -497,18 +506,18 @@ export interface CouponDiscount {
497
506
  /** Discount coupon ID. */
498
507
  couponId?: string;
499
508
  }
500
- export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
509
+ interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
501
510
  /** Discount by percentage applied to tickets. */
502
511
  percentDiscount?: PercentDiscount;
503
512
  /** Name of pricing plan. */
504
513
  name?: string;
505
514
  }
506
515
  /** @oneof */
507
- export interface PaidPlanDiscountDiscountOneOf {
516
+ interface PaidPlanDiscountDiscountOneOf {
508
517
  /** Discount by percentage applied to tickets. */
509
518
  percentDiscount?: PercentDiscount;
510
519
  }
511
- export interface PercentDiscount {
520
+ interface PercentDiscount {
512
521
  /**
513
522
  * Percent rate.
514
523
  * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
@@ -517,7 +526,7 @@ export interface PercentDiscount {
517
526
  /** Number of discounted tickets. */
518
527
  quantityDiscounted?: number;
519
528
  }
520
- export interface Tax {
529
+ interface Tax {
521
530
  /** Tax type. */
522
531
  type?: TaxType;
523
532
  /**
@@ -535,7 +544,7 @@ export interface Tax {
535
544
  /** Total tax amount. */
536
545
  amount?: Money;
537
546
  }
538
- export declare enum TaxType {
547
+ declare enum TaxType {
539
548
  /** Tax is included in the ticket price. */
540
549
  INCLUDED = "INCLUDED",
541
550
  /** Tax is added to the order at the checkout. */
@@ -543,7 +552,7 @@ export declare enum TaxType {
543
552
  /** Tax is added to the final total at the checkout. */
544
553
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
545
554
  }
546
- export interface Fee {
555
+ interface Fee {
547
556
  /** Fee identifier. */
548
557
  name?: FeeName;
549
558
  /** How fee is calculated. */
@@ -557,11 +566,11 @@ export interface Fee {
557
566
  /** Total amount of fee charges. */
558
567
  amount?: Money;
559
568
  }
560
- export declare enum FeeName {
569
+ declare enum FeeName {
561
570
  /** Wix ticket service fee charges applied to the line item. */
562
571
  WIX_FEE = "WIX_FEE"
563
572
  }
564
- export declare enum FeeType {
573
+ declare enum FeeType {
565
574
  /** Fee is added to the ticket price at checkout. */
566
575
  FEE_ADDED = "FEE_ADDED",
567
576
  /** Seller absorbs the fee. It is deducted from the ticket price. */
@@ -569,11 +578,11 @@ export declare enum FeeType {
569
578
  /** Fee is added to the ticket price at checkout. */
570
579
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
571
580
  }
572
- export interface PaymentDetails {
581
+ interface PaymentDetails {
573
582
  /** Wix Payments transaction */
574
583
  transaction?: PaymentTransaction;
575
584
  }
576
- export interface PaymentTransaction {
585
+ interface PaymentTransaction {
577
586
  /**
578
587
  * Wix Payments transaction id
579
588
  * @format GUID
@@ -586,7 +595,7 @@ export interface PaymentTransaction {
586
595
  */
587
596
  method?: string;
588
597
  }
589
- export declare enum ScheduledActionEnumAction {
598
+ declare enum ScheduledActionEnumAction {
590
599
  /** Action not scheduled. */
591
600
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
592
601
  /** Captured after the delay. */
@@ -594,7 +603,7 @@ export declare enum ScheduledActionEnumAction {
594
603
  /** Void after the delay. */
595
604
  VOID = "VOID"
596
605
  }
597
- export declare enum Action {
606
+ declare enum Action {
598
607
  /** Order can be archived. */
599
608
  ARCHIVE = "ARCHIVE",
600
609
  /** Order can be unarchived. */
@@ -606,7 +615,7 @@ export declare enum Action {
606
615
  /** Order can be voided. */
607
616
  VOID = "VOID"
608
617
  }
609
- export interface GiftCardPaymentDetails {
618
+ interface GiftCardPaymentDetails {
610
619
  /**
611
620
  * Gift card payment id.
612
621
  * @format GUID
@@ -627,15 +636,15 @@ export interface GiftCardPaymentDetails {
627
636
  */
628
637
  obfuscatedCode?: string | null;
629
638
  }
630
- export interface BalanceSummary {
639
+ interface BalanceSummary {
631
640
  /** Amount left to pay. */
632
641
  balance?: Money;
633
642
  }
634
- export interface OrderDeleted {
643
+ interface OrderDeleted {
635
644
  /** Order deleted timestamp in ISO UTC format. */
636
645
  timestamp?: Date | null;
637
646
  /**
638
- * Event ID.
647
+ * Event ID to which the order belongs.
639
648
  * @format GUID
640
649
  */
641
650
  eventId?: string;
@@ -667,13 +676,13 @@ export interface OrderDeleted {
667
676
  /** Tickets generated after payment. */
668
677
  tickets?: Ticket[];
669
678
  }
670
- export declare enum OrderType {
679
+ declare enum OrderType {
671
680
  /** Buyer form is used for all tickets. */
672
681
  UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
673
682
  /** Each order ticket has its own form. */
674
683
  ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
675
684
  }
676
- export interface Ticket {
685
+ interface Ticket {
677
686
  /** Unique issued ticket number. */
678
687
  ticketNumber?: string;
679
688
  /**
@@ -721,7 +730,7 @@ export interface Ticket {
721
730
  /** Whether ticket is canceled. */
722
731
  canceled?: boolean | null;
723
732
  }
724
- export interface OnlineConferencingLogin {
733
+ interface OnlineConferencingLogin {
725
734
  /**
726
735
  * Link URL to the online conference.
727
736
  * @format WEB_URL
@@ -734,7 +743,7 @@ export interface OnlineConferencingLogin {
734
743
  */
735
744
  password?: string | null;
736
745
  }
737
- export interface ListOrdersRequest {
746
+ interface ListOrdersRequest {
738
747
  /** Offset. */
739
748
  offset?: number;
740
749
  /**
@@ -743,14 +752,30 @@ export interface ListOrdersRequest {
743
752
  */
744
753
  limit?: number;
745
754
  /**
746
- * 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).
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
+ *
747
763
  * @maxSize 20
748
764
  */
749
765
  fieldset?: OrderFieldset[];
750
- /** Status. */
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
+ */
751
776
  status?: OrderStatus[];
752
777
  /**
753
- * Event ID.
778
+ * Event ID to which the order belongs.
754
779
  * @format GUID
755
780
  * @maxSize 100
756
781
  */
@@ -768,14 +793,13 @@ export interface ListOrdersRequest {
768
793
  */
769
794
  memberId?: string[];
770
795
  /**
771
- * Field facets.
772
- * 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).
796
+ * Field facets,
773
797
  * @maxLength 100
774
798
  * @maxSize 20
775
799
  */
776
800
  facet?: string[];
777
801
  /**
778
- * Textual search filter - search is performed on "full_name", "email" and "order_number".
802
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
779
803
  * @maxLength 200
780
804
  */
781
805
  searchPhrase?: string;
@@ -786,8 +810,8 @@ export interface ListOrdersRequest {
786
810
  */
787
811
  eventCreatorId?: string[];
788
812
  /**
789
- * Sort order. Defaults to "created:asc".
790
- * 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).
813
+ * Sort order.
814
+ * Default: `created:asc`.
791
815
  * @maxLength 100
792
816
  */
793
817
  sort?: string;
@@ -800,7 +824,7 @@ export interface ListOrdersRequest {
800
824
  */
801
825
  contactId?: string[];
802
826
  }
803
- export declare enum OrderFieldset {
827
+ declare enum OrderFieldset {
804
828
  /** Include tickets in response. */
805
829
  TICKETS = "TICKETS",
806
830
  /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
@@ -810,7 +834,7 @@ export declare enum OrderFieldset {
810
834
  /** Include `invoice` in the response. */
811
835
  INVOICE = "INVOICE"
812
836
  }
813
- export declare enum OrderTag {
837
+ declare enum OrderTag {
814
838
  /** Return only confirmed orders. */
815
839
  CONFIRMED = "CONFIRMED",
816
840
  /** Return only unconfirmed orders. */
@@ -826,7 +850,7 @@ export declare enum OrderTag {
826
850
  /** Return only orders with no guests checked-in. */
827
851
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
828
852
  }
829
- export interface ListOrdersResponse {
853
+ interface ListOrdersResponse {
830
854
  /** Total orders matching the given filters. */
831
855
  total?: number;
832
856
  /** Offset. */
@@ -843,19 +867,19 @@ export interface ListOrdersResponse {
843
867
  /** Order data enriched facets. */
844
868
  orderFacets?: OrderFacets;
845
869
  }
846
- export interface FacetCounts {
870
+ interface FacetCounts {
847
871
  /** Facet counts aggregated per value. */
848
872
  counts?: Record<string, number>;
849
873
  }
850
- export interface OrderFacets {
874
+ interface OrderFacets {
851
875
  /** Filter facets. */
852
876
  facets?: Record<string, OrderFacetCounts>;
853
877
  }
854
- export interface OrderFacetCounts {
878
+ interface OrderFacetCounts {
855
879
  /** Facet counts aggregated per value */
856
880
  counts?: Record<string, Counts>;
857
881
  }
858
- export interface Counts {
882
+ interface Counts {
859
883
  /** Number or orders */
860
884
  count?: number;
861
885
  /** Number of tickets within orders */
@@ -863,9 +887,9 @@ export interface Counts {
863
887
  /** Number of tickets with check-in */
864
888
  ticketsCheckIn?: number;
865
889
  }
866
- export interface GetOrderRequest {
890
+ interface GetOrderRequest {
867
891
  /**
868
- * Event ID.
892
+ * Event ID to which the order belongs.
869
893
  * @format GUID
870
894
  */
871
895
  eventId: string;
@@ -875,26 +899,33 @@ export interface GetOrderRequest {
875
899
  */
876
900
  orderNumber: string;
877
901
  /**
878
- * 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).
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
+ *
879
910
  * @maxSize 20
880
911
  */
881
912
  fieldset?: OrderFieldset[];
882
913
  }
883
- export interface GetOrderResponse {
914
+ interface GetOrderResponse {
884
915
  /** Requested order. */
885
916
  order?: Order;
886
917
  /** "Add to calendar" links. */
887
918
  calendarLinks?: CalendarLinks;
888
919
  }
889
- export interface CalendarLinks {
920
+ interface CalendarLinks {
890
921
  /** "Add to Google calendar" URL. */
891
922
  google?: string;
892
923
  /** "Download ICS calendar file" URL. */
893
924
  ics?: string;
894
925
  }
895
- export interface UpdateOrderRequest {
926
+ interface UpdateOrderRequest {
896
927
  /**
897
- * Event ID.
928
+ * Event ID to which the order belongs.
898
929
  * @format GUID
899
930
  */
900
931
  eventId: string;
@@ -910,11 +941,11 @@ export interface UpdateOrderRequest {
910
941
  /** Whether order is archived. */
911
942
  archived?: boolean;
912
943
  }
913
- export interface UpdateOrderResponse {
944
+ interface UpdateOrderResponse {
914
945
  /** Updated order. */
915
946
  order?: Order;
916
947
  }
917
- export interface OrderUpdated {
948
+ interface OrderUpdated {
918
949
  /** Order updated timestamp in ISO UTC format. */
919
950
  timestamp?: Date | null;
920
951
  /**
@@ -928,7 +959,7 @@ export interface OrderUpdated {
928
959
  */
929
960
  locale?: string | null;
930
961
  /**
931
- * Event ID.
962
+ * Event ID to which the order belongs.
932
963
  * @format GUID
933
964
  */
934
965
  eventId?: string;
@@ -961,7 +992,16 @@ export interface OrderUpdated {
961
992
  checkoutForm?: FormResponse;
962
993
  /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
963
994
  confirmed?: boolean;
964
- /** Order status. */
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
+ */
965
1005
  status?: OrderStatus;
966
1006
  /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
967
1007
  method?: string | null;
@@ -972,9 +1012,9 @@ export interface OrderUpdated {
972
1012
  /** Whether event was triggered by GDPR delete request. */
973
1013
  triggeredByAnonymizeRequest?: boolean;
974
1014
  }
975
- export interface BulkUpdateOrdersRequest {
1015
+ interface BulkUpdateOrdersRequest {
976
1016
  /**
977
- * Event ID.
1017
+ * Event ID to which the order belongs.
978
1018
  * @format GUID
979
1019
  */
980
1020
  eventId: string;
@@ -990,13 +1030,13 @@ export interface BulkUpdateOrdersRequest {
990
1030
  /** Whether to archive the order. */
991
1031
  archived?: boolean;
992
1032
  }
993
- export interface BulkUpdateOrdersResponse {
1033
+ interface BulkUpdateOrdersResponse {
994
1034
  /** Updated orders. */
995
1035
  orders?: Order[];
996
1036
  }
997
- export interface ConfirmOrderRequest {
1037
+ interface ConfirmOrderRequest {
998
1038
  /**
999
- * Event ID.
1039
+ * Event ID to which the order belongs.
1000
1040
  * @format GUID
1001
1041
  */
1002
1042
  eventId: string;
@@ -1008,22 +1048,22 @@ export interface ConfirmOrderRequest {
1008
1048
  */
1009
1049
  orderNumber?: string[];
1010
1050
  }
1011
- export interface ConfirmOrderResponse {
1051
+ interface ConfirmOrderResponse {
1012
1052
  /** Confirmed orders. */
1013
1053
  orders?: Order[];
1014
1054
  }
1015
- export interface GetSummaryRequest {
1055
+ interface GetSummaryRequest {
1016
1056
  /**
1017
1057
  * Event ID.
1018
1058
  * @format GUID
1019
1059
  */
1020
1060
  eventId?: string | null;
1021
1061
  }
1022
- export interface GetSummaryResponse {
1062
+ interface GetSummaryResponse {
1023
1063
  /** Ticket sales grouped by currency. */
1024
1064
  sales?: TicketSales[];
1025
1065
  }
1026
- export interface TicketSales {
1066
+ interface TicketSales {
1027
1067
  /** Total balance of confirmed transactions. */
1028
1068
  total?: Money;
1029
1069
  /** Total number of confirmed orders. */
@@ -1033,25 +1073,25 @@ export interface TicketSales {
1033
1073
  /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
1034
1074
  revenue?: Money;
1035
1075
  }
1036
- export interface GetInvoicePreviewRequest {
1076
+ interface GetInvoicePreviewRequest {
1037
1077
  /**
1038
- * Event ID.
1078
+ * Event ID to which the invoice belongs.
1039
1079
  * @format GUID
1040
1080
  */
1041
1081
  eventId?: string;
1042
1082
  /** Order number. */
1043
1083
  orderNumber?: string;
1044
1084
  }
1045
- export interface RawHttpResponse {
1085
+ interface RawHttpResponse {
1046
1086
  body?: Uint8Array;
1047
1087
  statusCode?: number | null;
1048
1088
  headers?: HeadersEntry[];
1049
1089
  }
1050
- export interface HeadersEntry {
1090
+ interface HeadersEntry {
1051
1091
  key?: string;
1052
1092
  value?: string;
1053
1093
  }
1054
- export interface GetPaymentInfoRequest {
1094
+ interface GetPaymentInfoRequest {
1055
1095
  /**
1056
1096
  * Event ID.
1057
1097
  * @format GUID
@@ -1060,7 +1100,7 @@ export interface GetPaymentInfoRequest {
1060
1100
  /** Order number. */
1061
1101
  orderNumber?: string;
1062
1102
  }
1063
- export interface GetPaymentInfoResponse {
1103
+ interface GetPaymentInfoResponse {
1064
1104
  transactions?: PaymentTransactionSummary[];
1065
1105
  status?: string | null;
1066
1106
  /**
@@ -1069,7 +1109,7 @@ export interface GetPaymentInfoResponse {
1069
1109
  */
1070
1110
  transactionId?: string | null;
1071
1111
  }
1072
- export interface PaymentTransactionSummary {
1112
+ interface PaymentTransactionSummary {
1073
1113
  /**
1074
1114
  * Wix Payments transaction id
1075
1115
  * @format GUID
@@ -1084,7 +1124,7 @@ export interface PaymentTransactionSummary {
1084
1124
  /** Transaction events */
1085
1125
  events?: PaymentTransactionEvent[];
1086
1126
  }
1087
- export interface PaymentTransactionEvent {
1127
+ interface PaymentTransactionEvent {
1088
1128
  /**
1089
1129
  * Order snapshot id
1090
1130
  * @format GUID
@@ -1110,7 +1150,7 @@ export interface PaymentTransactionEvent {
1110
1150
  * Crated date
1111
1151
  * @readonly
1112
1152
  */
1113
- createdDate?: Date | null;
1153
+ _createdDate?: Date | null;
1114
1154
  /**
1115
1155
  * Reason code
1116
1156
  * @readonly
@@ -1122,7 +1162,7 @@ export interface PaymentTransactionEvent {
1122
1162
  */
1123
1163
  refundedAmount?: Money;
1124
1164
  }
1125
- export interface CaptureAuthorizedPaymentRequest {
1165
+ interface CaptureAuthorizedPaymentRequest {
1126
1166
  /**
1127
1167
  * Event ID.
1128
1168
  * @format GUID
@@ -1135,9 +1175,9 @@ export interface CaptureAuthorizedPaymentRequest {
1135
1175
  */
1136
1176
  orderNumber: string;
1137
1177
  }
1138
- export interface CaptureAuthorizedPaymentResponse {
1178
+ interface CaptureAuthorizedPaymentResponse {
1139
1179
  }
1140
- export interface VoidAuthorizedPaymentRequest {
1180
+ interface VoidAuthorizedPaymentRequest {
1141
1181
  /**
1142
1182
  * Event ID.
1143
1183
  * @format GUID
@@ -1150,9 +1190,9 @@ export interface VoidAuthorizedPaymentRequest {
1150
1190
  */
1151
1191
  orderNumber: string;
1152
1192
  }
1153
- export interface VoidAuthorizedPaymentResponse {
1193
+ interface VoidAuthorizedPaymentResponse {
1154
1194
  }
1155
- export interface MessageEnvelope {
1195
+ interface MessageEnvelope {
1156
1196
  /**
1157
1197
  * App instance ID.
1158
1198
  * @format GUID
@@ -1168,7 +1208,7 @@ export interface MessageEnvelope {
1168
1208
  /** Stringify payload. */
1169
1209
  data?: string;
1170
1210
  }
1171
- export interface IdentificationData extends IdentificationDataIdOneOf {
1211
+ interface IdentificationData extends IdentificationDataIdOneOf {
1172
1212
  /**
1173
1213
  * ID of a site visitor that has not logged in to the site.
1174
1214
  * @format GUID
@@ -1193,7 +1233,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1193
1233
  identityType?: WebhookIdentityType;
1194
1234
  }
1195
1235
  /** @oneof */
1196
- export interface IdentificationDataIdOneOf {
1236
+ interface IdentificationDataIdOneOf {
1197
1237
  /**
1198
1238
  * ID of a site visitor that has not logged in to the site.
1199
1239
  * @format GUID
@@ -1215,14 +1255,14 @@ export interface IdentificationDataIdOneOf {
1215
1255
  */
1216
1256
  appId?: string;
1217
1257
  }
1218
- export declare enum WebhookIdentityType {
1258
+ declare enum WebhookIdentityType {
1219
1259
  UNKNOWN = "UNKNOWN",
1220
1260
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1221
1261
  MEMBER = "MEMBER",
1222
1262
  WIX_USER = "WIX_USER",
1223
1263
  APP = "APP"
1224
1264
  }
1225
- export interface OrderConfirmed {
1265
+ interface OrderConfirmed {
1226
1266
  /** Order confirmation timestamp in ISO UTC. */
1227
1267
  timestamp?: Date | null;
1228
1268
  /**
@@ -1238,7 +1278,7 @@ export interface OrderConfirmed {
1238
1278
  */
1239
1279
  locale?: string | null;
1240
1280
  /**
1241
- * Event ID.
1281
+ * Event ID to which the order belongs.
1242
1282
  * @format GUID
1243
1283
  */
1244
1284
  eventId?: string;
@@ -1264,7 +1304,16 @@ export interface OrderConfirmed {
1264
1304
  email?: string;
1265
1305
  /** Checkout form response. */
1266
1306
  checkoutForm?: FormResponse;
1267
- /** Order status. */
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
+ */
1268
1317
  status?: OrderStatus;
1269
1318
  /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1270
1319
  method?: string | null;
@@ -1275,7 +1324,7 @@ export interface OrderConfirmed {
1275
1324
  /** Reservation ID associated with this order. */
1276
1325
  reservationId?: string;
1277
1326
  }
1278
- export interface OrderPaid {
1327
+ interface OrderPaid {
1279
1328
  /** Order paid timestamp in ISO UTC. */
1280
1329
  timestamp?: Date | null;
1281
1330
  /**
@@ -1291,7 +1340,7 @@ export interface OrderPaid {
1291
1340
  */
1292
1341
  locale?: string | null;
1293
1342
  /**
1294
- * Event ID.
1343
+ * Event ID to which the order belongs.
1295
1344
  * @format GUID
1296
1345
  */
1297
1346
  eventId?: string;
@@ -1346,11 +1395,11 @@ export interface OrderPaid {
1346
1395
  /** Invoice. */
1347
1396
  invoice?: Invoice;
1348
1397
  }
1349
- export interface ReservationCreated {
1398
+ interface ReservationCreated {
1350
1399
  /** Reservation created timestamp in ISO UTC format. */
1351
1400
  timestamp?: Date | null;
1352
1401
  /**
1353
- * Event ID.
1402
+ * Event ID to which the reservation belongs.
1354
1403
  * @format GUID
1355
1404
  */
1356
1405
  eventId?: string;
@@ -1370,14 +1419,14 @@ export interface ReservationCreated {
1370
1419
  */
1371
1420
  quantities?: TicketQuantity[];
1372
1421
  /** Reservation update timestamp. */
1373
- updatedDate?: Date | null;
1422
+ _updatedDate?: Date | null;
1374
1423
  /**
1375
1424
  * Reservation counts.
1376
1425
  * @maxSize 50
1377
1426
  */
1378
1427
  counts?: ReservationCount[];
1379
1428
  }
1380
- export declare enum ReservationStatus {
1429
+ declare enum ReservationStatus {
1381
1430
  /** The Reservation is pending confirmation and will expire after the expiration due time. */
1382
1431
  RESERVATION_PENDING = "RESERVATION_PENDING",
1383
1432
  /** The reservation is confirmed and will not expire. */
@@ -1389,7 +1438,7 @@ export declare enum ReservationStatus {
1389
1438
  /** The reservation is expired. */
1390
1439
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1391
1440
  }
1392
- export interface TicketQuantity {
1441
+ interface TicketQuantity {
1393
1442
  /**
1394
1443
  * Ticket definition ID.
1395
1444
  * @format GUID
@@ -1398,9 +1447,9 @@ export interface TicketQuantity {
1398
1447
  /** Quantity. */
1399
1448
  quantity?: number | null;
1400
1449
  /** Quantity update timestamp. */
1401
- updatedDate?: Date | null;
1450
+ _updatedDate?: Date | null;
1402
1451
  }
1403
- export interface ReservationCount {
1452
+ interface ReservationCount {
1404
1453
  /** Reservation Count snapshot timestamp. */
1405
1454
  timestamp?: Date | null;
1406
1455
  /**
@@ -1415,11 +1464,11 @@ export interface ReservationCount {
1415
1464
  /** True if paid ticket reservation exist. */
1416
1465
  paidExists?: boolean;
1417
1466
  }
1418
- export interface ReservationUpdated {
1467
+ interface ReservationUpdated {
1419
1468
  /** Reservation updated timestamp. */
1420
1469
  timestamp?: Date | null;
1421
1470
  /**
1422
- * Event ID.
1471
+ * Event ID to which the reservation belongs.
1423
1472
  * @format GUID
1424
1473
  */
1425
1474
  eventId?: string;
@@ -1439,16 +1488,16 @@ export interface ReservationUpdated {
1439
1488
  */
1440
1489
  quantities?: TicketQuantity[];
1441
1490
  /** Reservation update timestamp. */
1442
- updatedDate?: Date | null;
1491
+ _updatedDate?: Date | null;
1443
1492
  /**
1444
1493
  * Reservation counts.
1445
1494
  * @maxSize 50
1446
1495
  */
1447
1496
  counts?: ReservationCount[];
1448
1497
  }
1449
- export interface GetCheckoutOptionsRequest {
1498
+ interface GetCheckoutOptionsRequest {
1450
1499
  }
1451
- export interface GetCheckoutOptionsResponse {
1500
+ interface GetCheckoutOptionsResponse {
1452
1501
  /** Whether any payment method is configured and available for payment. */
1453
1502
  paymentMethodConfigured?: boolean;
1454
1503
  /** Whether coupons are accepted at checkout. */
@@ -1460,7 +1509,7 @@ export interface GetCheckoutOptionsResponse {
1460
1509
  /** Whether gift cards are accepted at checkout. */
1461
1510
  acceptGiftCards?: boolean;
1462
1511
  }
1463
- export interface ListAvailableTicketsRequest {
1512
+ interface ListAvailableTicketsRequest {
1464
1513
  /**
1465
1514
  * Event ID. If not provided, available tickets for all events in the site will be returned.
1466
1515
  * @format GUID
@@ -1474,23 +1523,23 @@ export interface ListAvailableTicketsRequest {
1474
1523
  */
1475
1524
  limit?: number;
1476
1525
  /**
1477
- * Sort order, defaults to "created:asc".
1478
- * 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).
1526
+ * Sort order.
1527
+ * Default: `created:asc`.
1479
1528
  * @maxLength 100
1480
1529
  */
1481
1530
  sort?: string;
1482
1531
  state?: State[];
1483
1532
  }
1484
- export declare enum State {
1533
+ declare enum State {
1485
1534
  INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
1486
1535
  }
1487
- export interface ListAvailableTicketsResponse {
1536
+ interface ListAvailableTicketsResponse {
1488
1537
  /** Ticket definitions meta data. */
1489
1538
  metaData?: ResponseMetaData;
1490
1539
  /** Ticket definitions. */
1491
1540
  definitions?: TicketDefinition[];
1492
1541
  }
1493
- export interface ResponseMetaData {
1542
+ interface ResponseMetaData {
1494
1543
  /** Number of items in the response. */
1495
1544
  count?: number;
1496
1545
  /** Offset of items. */
@@ -1498,12 +1547,12 @@ export interface ResponseMetaData {
1498
1547
  /** Total number of matching items. */
1499
1548
  total?: number;
1500
1549
  }
1501
- export interface TicketDefinition {
1550
+ interface TicketDefinition {
1502
1551
  /**
1503
1552
  * Ticket definition ID.
1504
1553
  * @format GUID
1505
1554
  */
1506
- id?: string;
1555
+ _id?: string;
1507
1556
  /** Ticket price. */
1508
1557
  price?: Money;
1509
1558
  /** Whether the ticket is free (read only). */
@@ -1513,14 +1562,13 @@ export interface TicketDefinition {
1513
1562
  /** Ticket description. */
1514
1563
  description?: string;
1515
1564
  /**
1516
- * Limit of tickets that can be purchased per checkout.
1517
- * Set to 20 for unlimited ticket definition.
1565
+ * Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets.
1518
1566
  * @max 20
1519
1567
  */
1520
1568
  limitPerCheckout?: number;
1521
1569
  /** Custom sort index. */
1522
1570
  orderIndex?: number;
1523
- /** Policy information plain text block, as printed on the ticket. */
1571
+ /** Event and ticket policies. */
1524
1572
  policy?: string;
1525
1573
  /** Sensitive dashboard data. */
1526
1574
  dashboard?: Dashboard;
@@ -1546,7 +1594,7 @@ export interface TicketDefinition {
1546
1594
  /** Ticket pricing. */
1547
1595
  pricing?: TicketPricing;
1548
1596
  }
1549
- export interface Dashboard {
1597
+ interface Dashboard {
1550
1598
  /** Whether ticket is hidden and cannot be sold. */
1551
1599
  hidden?: boolean;
1552
1600
  /**
@@ -1556,20 +1604,20 @@ export interface Dashboard {
1556
1604
  sold?: number;
1557
1605
  /** Whether the ticket has limited quantity. */
1558
1606
  limited?: boolean;
1559
- /** Ticket limit. `NULL` for unlimited ticket definitions. */
1607
+ /** Ticket limit. `NULL` if the tickets are unlimited. */
1560
1608
  quantity?: number | null;
1561
- /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
1609
+ /** Number of unsold tickets. `NULL` if the tickets are unlimited. */
1562
1610
  unsold?: number | null;
1563
1611
  /** Number of tickets sold. */
1564
1612
  ticketsSold?: number;
1565
1613
  /** Number of tickets reserved. */
1566
1614
  ticketsReserved?: number;
1567
1615
  }
1568
- export interface WixFeeConfig {
1616
+ interface WixFeeConfig {
1569
1617
  /** Fee calculation method. */
1570
1618
  type?: FeeType;
1571
1619
  }
1572
- export interface TicketSalePeriod {
1620
+ interface TicketSalePeriod {
1573
1621
  /** Ticket sale start timestamp. */
1574
1622
  startDate?: Date | null;
1575
1623
  /** Ticket sale end timestamp. */
@@ -1577,7 +1625,7 @@ export interface TicketSalePeriod {
1577
1625
  /** Whether to hide this ticket if it's not on sale */
1578
1626
  hideNotOnSale?: boolean;
1579
1627
  }
1580
- export declare enum TicketSaleStatus {
1628
+ declare enum TicketSaleStatus {
1581
1629
  /** Ticket sale is scheduled to start. */
1582
1630
  SALE_SCHEDULED = "SALE_SCHEDULED",
1583
1631
  /** Ticket sale has started. */
@@ -1585,7 +1633,7 @@ export declare enum TicketSaleStatus {
1585
1633
  /** Ticket sale has ended. */
1586
1634
  SALE_ENDED = "SALE_ENDED"
1587
1635
  }
1588
- export interface TicketPricing extends TicketPricingPriceOneOf {
1636
+ interface TicketPricing extends TicketPricingPriceOneOf {
1589
1637
  /** Ticket price which is read only. */
1590
1638
  fixedPrice?: Money;
1591
1639
  /** Min price per ticket, customizable. */
@@ -1599,7 +1647,7 @@ export interface TicketPricing extends TicketPricingPriceOneOf {
1599
1647
  pricingType?: Type;
1600
1648
  }
1601
1649
  /** @oneof */
1602
- export interface TicketPricingPriceOneOf {
1650
+ interface TicketPricingPriceOneOf {
1603
1651
  /** Ticket price which is read only. */
1604
1652
  fixedPrice?: Money;
1605
1653
  /** Min price per ticket, customizable. */
@@ -1607,16 +1655,16 @@ export interface TicketPricingPriceOneOf {
1607
1655
  /** Ticket pricing options. */
1608
1656
  pricingOptions?: PricingOptions;
1609
1657
  }
1610
- export interface PricingOptions {
1658
+ interface PricingOptions {
1611
1659
  /** Multiple ticket pricing options. */
1612
1660
  options?: PricingOption[];
1613
1661
  }
1614
- export interface PricingOption {
1662
+ interface PricingOption {
1615
1663
  /**
1616
1664
  * Ticket pricing option ID.
1617
1665
  * @format GUID
1618
1666
  */
1619
- id?: string | null;
1667
+ _id?: string | null;
1620
1668
  /**
1621
1669
  * Ticket pricing option name.
1622
1670
  * @minLength 1
@@ -1626,11 +1674,11 @@ export interface PricingOption {
1626
1674
  /** Ticket pricing option price. */
1627
1675
  price?: Money;
1628
1676
  }
1629
- export declare enum Type {
1677
+ declare enum Type {
1630
1678
  STANDARD = "STANDARD",
1631
1679
  DONATION = "DONATION"
1632
1680
  }
1633
- export interface QueryAvailableTicketsRequest {
1681
+ interface QueryAvailableTicketsRequest {
1634
1682
  /** Offset. */
1635
1683
  offset?: number;
1636
1684
  /**
@@ -1638,35 +1686,32 @@ export interface QueryAvailableTicketsRequest {
1638
1686
  * @max 1000
1639
1687
  */
1640
1688
  limit?: number;
1641
- /**
1642
- * Ticket definition.
1643
- * 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).
1644
- */
1689
+ /** Ticket definition. */
1645
1690
  filter?: Record<string, any> | null;
1646
1691
  /** @maxSize 20 */
1647
1692
  fieldset?: TicketDefinitionFieldset[];
1648
1693
  /**
1649
- * Sort order, defaults to "created:asc".
1650
- * 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).
1694
+ * Sort order.
1695
+ * Default: `created:asc`.
1651
1696
  * @maxLength 100
1652
1697
  */
1653
1698
  sort?: string;
1654
1699
  }
1655
- export declare enum TicketDefinitionFieldset {
1700
+ declare enum TicketDefinitionFieldset {
1656
1701
  /** Include `policy` in the response. */
1657
1702
  POLICY = "POLICY",
1658
1703
  /** Include `dashboard` in the response. */
1659
1704
  DASHBOARD = "DASHBOARD"
1660
1705
  }
1661
- export interface QueryAvailableTicketsResponse {
1706
+ interface QueryAvailableTicketsResponse {
1662
1707
  /** Ticket definitions meta data. */
1663
1708
  metaData?: ResponseMetaData;
1664
1709
  /** Ticket definitions. */
1665
1710
  definitions?: TicketDefinition[];
1666
1711
  }
1667
- export interface CreateReservationRequest {
1712
+ interface CreateReservationRequest {
1668
1713
  /**
1669
- * Event ID.
1714
+ * Event ID to which the reservation belongs.
1670
1715
  * @format GUID
1671
1716
  */
1672
1717
  eventId: string;
@@ -1681,7 +1726,7 @@ export interface CreateReservationRequest {
1681
1726
  /** Whether to allow reservation for hidden tickets. */
1682
1727
  allowHiddenTickets?: boolean;
1683
1728
  }
1684
- export interface TicketReservationQuantity {
1729
+ interface TicketReservationQuantity {
1685
1730
  /**
1686
1731
  * Ticket definition ID.
1687
1732
  * @format GUID
@@ -1694,7 +1739,7 @@ export interface TicketReservationQuantity {
1694
1739
  */
1695
1740
  quantity?: number;
1696
1741
  /**
1697
- * Ticket price to charge - overriding the ticket price.
1742
+ * Override the predefined ticket price.
1698
1743
  * @maxLength 13
1699
1744
  * @format DECIMAL_VALUE
1700
1745
  */
@@ -1702,12 +1747,12 @@ export interface TicketReservationQuantity {
1702
1747
  /** Optional ticket details */
1703
1748
  ticketDetails?: TicketDetails[];
1704
1749
  }
1705
- export interface CreateReservationResponse {
1750
+ interface CreateReservationResponse {
1706
1751
  /**
1707
1752
  * Reservation ID.
1708
1753
  * @format GUID
1709
1754
  */
1710
- id?: string;
1755
+ _id?: string;
1711
1756
  /** Reservation expiration timestamp. */
1712
1757
  expires?: Date | null;
1713
1758
  /** Ticket reservations. */
@@ -1717,20 +1762,21 @@ export interface CreateReservationResponse {
1717
1762
  /** Reservation status. */
1718
1763
  reservationStatus?: ReservationStatus;
1719
1764
  }
1720
- export interface TicketReservation {
1765
+ interface TicketReservation {
1721
1766
  /**
1722
1767
  * Quantity of reserved tickets.
1723
1768
  * @min 1
1724
1769
  * @max 20
1725
1770
  */
1726
1771
  quantity?: number;
1772
+ /** An object containing ticket information. */
1727
1773
  ticket?: TicketDefinition;
1728
1774
  /** Optional ticket details. */
1729
1775
  ticketDetails?: TicketDetails[];
1730
1776
  }
1731
- export interface CancelReservationRequest {
1777
+ interface CancelReservationRequest {
1732
1778
  /**
1733
- * Event ID.
1779
+ * Event ID to which the reservation belongs.
1734
1780
  * @format GUID
1735
1781
  */
1736
1782
  eventId: string;
@@ -1738,13 +1784,13 @@ export interface CancelReservationRequest {
1738
1784
  * Reservation ID.
1739
1785
  * @format GUID
1740
1786
  */
1741
- id: string;
1787
+ _id: string;
1742
1788
  }
1743
- export interface CancelReservationResponse {
1789
+ interface CancelReservationResponse {
1744
1790
  }
1745
- export interface GetInvoiceRequest {
1791
+ interface GetInvoiceRequest {
1746
1792
  /**
1747
- * Event ID.
1793
+ * Event ID to which the invoice belongs.
1748
1794
  * @format GUID
1749
1795
  */
1750
1796
  eventId: string;
@@ -1758,14 +1804,14 @@ export interface GetInvoiceRequest {
1758
1804
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1759
1805
  paidPlanBenefit?: PaidPlanBenefit;
1760
1806
  }
1761
- export interface DiscountRequest {
1807
+ interface DiscountRequest {
1762
1808
  /**
1763
1809
  * Discount coupon code.
1764
1810
  * @maxLength 20
1765
1811
  */
1766
1812
  couponCode?: string;
1767
1813
  }
1768
- export interface PaidPlanBenefit {
1814
+ interface PaidPlanBenefit {
1769
1815
  /**
1770
1816
  * Pricing plan ID.
1771
1817
  * @format GUID
@@ -1777,41 +1823,49 @@ export interface PaidPlanBenefit {
1777
1823
  */
1778
1824
  benefitId?: string;
1779
1825
  }
1780
- export interface GetInvoiceResponse {
1826
+ interface GetInvoiceResponse {
1781
1827
  /** Invoice with applied discount. */
1782
1828
  invoice?: Invoice;
1783
1829
  /** Discount errors, if relevant. */
1784
1830
  discountErrors?: DiscountErrors;
1785
- /** Time when the reservation expires. */
1831
+ /** Reservation expiration time. */
1786
1832
  expires?: Date | null;
1787
- /** Reservation status. */
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
+ */
1788
1841
  reservationStatus?: ReservationStatus;
1789
1842
  /** Whether this reservation is already used in checkout. */
1790
1843
  reservationOccupied?: boolean;
1791
1844
  /** Ticket reservations. */
1792
1845
  reservations?: TicketReservation[];
1793
1846
  }
1794
- export interface DiscountErrors {
1795
- /** Error. */
1847
+ interface DiscountErrors {
1848
+ /** Object containing error information. */
1796
1849
  error?: Error[];
1797
1850
  }
1798
- export interface Error {
1851
+ interface Error {
1852
+ /** A code identifying the error type. */
1799
1853
  code?: string;
1800
1854
  }
1801
- export interface GiftCardErrors {
1855
+ interface GiftCardErrors {
1802
1856
  /**
1803
1857
  * Error.
1804
1858
  * @maxSize 10
1805
1859
  */
1806
1860
  error?: GiftCardErrorsError[];
1807
1861
  }
1808
- export interface GiftCardErrorsError {
1862
+ interface GiftCardErrorsError {
1809
1863
  /** @maxLength 100 */
1810
1864
  code?: string;
1811
1865
  }
1812
- export interface CheckoutRequest {
1866
+ interface CheckoutRequest {
1813
1867
  /**
1814
- * Event ID.
1868
+ * Event ID to which the checkout belongs.
1815
1869
  * @format GUID
1816
1870
  */
1817
1871
  eventId: string;
@@ -1839,7 +1893,7 @@ export interface CheckoutRequest {
1839
1893
  /** Whether marketing consent was given */
1840
1894
  marketingConsent?: boolean | null;
1841
1895
  }
1842
- export interface Buyer {
1896
+ interface Buyer {
1843
1897
  /**
1844
1898
  * Buyer first name.
1845
1899
  * @minLength 1
@@ -1860,11 +1914,11 @@ export interface Buyer {
1860
1914
  */
1861
1915
  email?: string;
1862
1916
  }
1863
- export interface Guest {
1917
+ interface Guest {
1864
1918
  /** Specific guest info. */
1865
1919
  form?: FormResponse;
1866
1920
  }
1867
- export interface CheckoutOptions {
1921
+ interface CheckoutOptions {
1868
1922
  /** Whether to ignore settings to notify contacts or users. */
1869
1923
  silent?: boolean;
1870
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. */
@@ -1874,17 +1928,20 @@ export interface CheckoutOptions {
1874
1928
  /** Marks payment as already paid */
1875
1929
  markAsPaid?: boolean | null;
1876
1930
  }
1877
- export interface CheckoutResponse {
1931
+ interface CheckoutResponse {
1878
1932
  /** Created order. */
1879
1933
  order?: Order;
1880
- /** Time when the order expires, applies to orders with status = INITIATED. */
1934
+ /**
1935
+ * Order expiration time.
1936
+ * **Note:** Only applicable to orders with the `INITIATED` status.
1937
+ */
1881
1938
  expires?: Date | null;
1882
1939
  /** Ticket reservations. */
1883
1940
  reservations?: TicketReservation[];
1884
- /** Order page url. */
1941
+ /** Order page URL. */
1885
1942
  orderPageUrl?: string | null;
1886
1943
  }
1887
- export interface OrderInitiated {
1944
+ interface OrderInitiated {
1888
1945
  /** Order initiated timestamp in ISO UTC format. */
1889
1946
  timestamp?: Date | null;
1890
1947
  /**
@@ -1898,7 +1955,7 @@ export interface OrderInitiated {
1898
1955
  */
1899
1956
  locale?: string | null;
1900
1957
  /**
1901
- * Event ID.
1958
+ * Event ID to which the order belongs.
1902
1959
  * @format GUID
1903
1960
  */
1904
1961
  eventId?: string;
@@ -1929,7 +1986,16 @@ export interface OrderInitiated {
1929
1986
  email?: string;
1930
1987
  /** Checkout form response. */
1931
1988
  checkoutForm?: FormResponse;
1932
- /** Order status. */
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
+ */
1933
1999
  status?: OrderStatus;
1934
2000
  /** Invoice. */
1935
2001
  invoice?: Invoice;
@@ -1938,9 +2004,9 @@ export interface OrderInitiated {
1938
2004
  /** Order was marked as paid. */
1939
2005
  markedAsPaid?: boolean | null;
1940
2006
  }
1941
- export interface UpdateCheckoutRequest {
2007
+ interface UpdateCheckoutRequest {
1942
2008
  /**
1943
- * Event ID.
2009
+ * Event ID to which the checkout belongs.
1944
2010
  * @format GUID
1945
2011
  */
1946
2012
  eventId: string;
@@ -1964,37 +2030,37 @@ export interface UpdateCheckoutRequest {
1964
2030
  /** Benefit granted by the pricing plan. */
1965
2031
  paidPlanBenefit?: PaidPlanBenefit;
1966
2032
  }
1967
- export interface UpdateCheckoutResponse {
2033
+ interface UpdateCheckoutResponse {
1968
2034
  /** Updated order. */
1969
2035
  order?: Order;
1970
- /** Order page url. */
2036
+ /** Order page URL. */
1971
2037
  orderPageUrl?: string | null;
1972
2038
  }
1973
- export interface OrderPageUrls {
2039
+ interface OrderPageUrls {
1974
2040
  /**
1975
- * Success order page url.
2041
+ * Success order page URL.
1976
2042
  * @format WEB_URL
1977
2043
  */
1978
2044
  success?: string | null;
1979
2045
  /**
1980
- * Pending order page url.
2046
+ * Pending order page URL.
1981
2047
  * @format WEB_URL
1982
2048
  */
1983
2049
  pending?: string | null;
1984
2050
  /**
1985
- * Canceled order page url.
2051
+ * Canceled order page URL.
1986
2052
  * @format WEB_URL
1987
2053
  */
1988
2054
  canceled?: string | null;
1989
2055
  /**
1990
- * Error order page url.
2056
+ * Error order page URL.
1991
2057
  * @format WEB_URL
1992
2058
  */
1993
2059
  error?: string | null;
1994
2060
  }
1995
- export interface PosCheckoutRequest {
2061
+ interface PosCheckoutRequest {
1996
2062
  /**
1997
- * Event ID.
2063
+ * Event ID to which the checkout belongs.
1998
2064
  * @format GUID
1999
2065
  */
2000
2066
  eventId: string;
@@ -2010,7 +2076,7 @@ export interface PosCheckoutRequest {
2010
2076
  */
2011
2077
  paymentDetailsId?: string | null;
2012
2078
  }
2013
- export interface PosCheckoutResponse {
2079
+ interface PosCheckoutResponse {
2014
2080
  /** Created order. */
2015
2081
  order?: Order;
2016
2082
  /** Time when the order expires, applies to orders with status = INITIATED. */
@@ -2018,7 +2084,7 @@ export interface PosCheckoutResponse {
2018
2084
  /** Ticket reservations. */
2019
2085
  reservations?: TicketReservation[];
2020
2086
  }
2021
- export interface GetReservationRequest {
2087
+ interface GetReservationRequest {
2022
2088
  /**
2023
2089
  * Event ID.
2024
2090
  * @format GUID
@@ -2030,11 +2096,11 @@ export interface GetReservationRequest {
2030
2096
  */
2031
2097
  reservationId?: string | null;
2032
2098
  }
2033
- export interface GetReservationResponse {
2099
+ interface GetReservationResponse {
2034
2100
  /** Date and time the Ticket Reservation was created. */
2035
- createdDate?: Date | null;
2101
+ _createdDate?: Date | null;
2036
2102
  /** Date and time the Ticket Reservation was last updated. */
2037
- updatedDate?: Date | null;
2103
+ _updatedDate?: Date | null;
2038
2104
  /** Date and time the Pending TicketReservation will expire. */
2039
2105
  expirationDate?: Date | null;
2040
2106
  /** Reservation status. */
@@ -2042,300 +2108,324 @@ export interface GetReservationResponse {
2042
2108
  /** Ticket reservations. */
2043
2109
  reservations?: TicketReservation[];
2044
2110
  }
2045
- interface StreetAddressNonNullableFields {
2046
- number: string;
2047
- name: string;
2048
- apt: string;
2111
+ interface BaseEventMetadata {
2112
+ /**
2113
+ * App instance ID.
2114
+ * @format GUID
2115
+ */
2116
+ instanceId?: string | null;
2117
+ /**
2118
+ * Event type.
2119
+ * @maxLength 150
2120
+ */
2121
+ eventType?: string;
2122
+ /** The identification type and identity data. */
2123
+ identity?: IdentificationData;
2049
2124
  }
2050
- interface SubdivisionNonNullableFields {
2051
- code: string;
2052
- name: string;
2053
- type: SubdivisionType;
2125
+ interface OrderDeletedEnvelope {
2126
+ data: OrderDeleted;
2127
+ metadata: BaseEventMetadata;
2054
2128
  }
2055
- interface AddressNonNullableFields {
2056
- streetAddress?: StreetAddressNonNullableFields;
2057
- subdivisions: SubdivisionNonNullableFields[];
2129
+ interface OrderUpdatedEnvelope {
2130
+ data: OrderUpdated;
2131
+ metadata: BaseEventMetadata;
2058
2132
  }
2059
- interface FormattedAddressNonNullableFields {
2060
- formatted: string;
2061
- address?: AddressNonNullableFields;
2133
+ interface OrderConfirmedEnvelope {
2134
+ data: OrderConfirmed;
2135
+ metadata: BaseEventMetadata;
2062
2136
  }
2063
- interface InputValueNonNullableFields {
2064
- inputName: string;
2065
- value: string;
2066
- values: string[];
2067
- address?: FormattedAddressNonNullableFields;
2137
+ interface OrderInitiatedEnvelope {
2138
+ data: OrderInitiated;
2139
+ metadata: BaseEventMetadata;
2068
2140
  }
2069
- interface FormResponseNonNullableFields {
2070
- inputValues: InputValueNonNullableFields[];
2141
+ interface OrderReservationCreatedEnvelope {
2142
+ data: ReservationCreated;
2143
+ metadata: BaseEventMetadata;
2071
2144
  }
2072
- interface MoneyNonNullableFields {
2073
- amount: string;
2074
- currency: string;
2145
+ interface OrderReservationUpdatedEnvelope {
2146
+ data: ReservationUpdated;
2147
+ metadata: BaseEventMetadata;
2075
2148
  }
2076
- interface GuestDetailsNonNullableFields {
2077
- guestAssigned: boolean;
2078
- form?: FormResponseNonNullableFields;
2149
+ interface ListOrdersOptions {
2150
+ /** Offset. */
2151
+ offset?: number;
2152
+ /**
2153
+ * Limit.
2154
+ * @max 400
2155
+ */
2156
+ limit?: number;
2157
+ /**
2158
+ * Predefined sets of fields to return.
2159
+ * - `TICKETS`: Returns `tickets`.
2160
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
2161
+ * - `FORM` : Returns `checkoutForm`.
2162
+ * - `INVOICE`: Returns `invoice`.
2163
+ *
2164
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2165
+ * @maxSize 20
2166
+ */
2167
+ fieldset?: OrderFieldset[];
2168
+ /**
2169
+ * Order status. Possible values:
2170
+ * - `FREE`: The order is confirmed, no payment is required.
2171
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
2172
+ * - `PAID`: The order is paid.
2173
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
2174
+ * - `INITIATED`: The order is awaiting for payment.
2175
+ * - `CANCELED`: The order is canceled.
2176
+ * - `DECLINED`: The order is payment is declined.
2177
+ */
2178
+ status?: OrderStatus[];
2179
+ /**
2180
+ * Event ID to which the order belongs.
2181
+ * @format GUID
2182
+ * @maxSize 100
2183
+ */
2184
+ eventId?: string[];
2185
+ /**
2186
+ * Order number.
2187
+ * @maxLength 36
2188
+ * @maxSize 500
2189
+ */
2190
+ orderNumber?: string[];
2191
+ /**
2192
+ * Site member ID.
2193
+ * @format GUID
2194
+ * @maxSize 500
2195
+ */
2196
+ memberId?: string[];
2197
+ /**
2198
+ * Field facets.
2199
+ * @maxLength 100
2200
+ * @maxSize 20
2201
+ */
2202
+ facet?: string[];
2203
+ /**
2204
+ * Search filter. You can search `fullName`, `email` and `orderNumber`.
2205
+ * @maxLength 200
2206
+ */
2207
+ searchPhrase?: string;
2208
+ /**
2209
+ * Event creator ID.
2210
+ * @format GUID
2211
+ * @maxSize 50
2212
+ */
2213
+ eventCreatorId?: string[];
2214
+ /**
2215
+ * Sort order.
2216
+ * Default: `created:asc`.
2217
+ * @maxLength 100
2218
+ */
2219
+ sort?: string;
2220
+ /** Order tag. */
2221
+ tag?: OrderTag[];
2222
+ /**
2223
+ * Guest contact IDs.
2224
+ * @format GUID
2225
+ * @maxSize 100
2226
+ */
2227
+ contactId?: string[];
2079
2228
  }
2080
- interface TicketingTicketNonNullableFields {
2081
- ticketNumber: string;
2229
+ interface GetOrderIdentifiers {
2230
+ /**
2231
+ * Event ID to which the order belongs.
2232
+ * @format GUID
2233
+ */
2234
+ eventId: string;
2235
+ /**
2236
+ * Unique order number.
2237
+ * @maxLength 36
2238
+ */
2082
2239
  orderNumber: string;
2083
- ticketDefinitionId: string;
2084
- name: string;
2085
- price?: MoneyNonNullableFields;
2086
- free: boolean;
2087
- policy: string;
2088
- qrCode: string;
2089
- orderStatus: OrderStatus;
2090
- orderArchived: boolean;
2091
- orderFullName: string;
2092
- guestDetails?: GuestDetailsNonNullableFields;
2093
- archived: boolean;
2094
- ticketPdf: string;
2095
- anonymized: boolean;
2096
- checkInUrl: string;
2097
- ticketPdfUrl: string;
2098
- channel: ChannelType;
2099
- walletPassUrl: string;
2100
- }
2101
- interface CouponDiscountNonNullableFields {
2102
- name: string;
2103
- code: string;
2104
- couponId: string;
2105
- }
2106
- interface PercentDiscountNonNullableFields {
2107
- rate: string;
2108
- quantityDiscounted: number;
2109
- }
2110
- interface PaidPlanDiscountNonNullableFields {
2111
- percentDiscount?: PercentDiscountNonNullableFields;
2112
- name: string;
2113
- }
2114
- interface DiscountItemNonNullableFields {
2115
- coupon?: CouponDiscountNonNullableFields;
2116
- paidPlan?: PaidPlanDiscountNonNullableFields;
2117
- amount?: MoneyNonNullableFields;
2118
- }
2119
- interface DiscountNonNullableFields {
2120
- amount?: MoneyNonNullableFields;
2121
- afterDiscount?: MoneyNonNullableFields;
2122
- code: string;
2123
- name: string;
2124
- couponId: string;
2125
- discounts: DiscountItemNonNullableFields[];
2126
- }
2127
- interface TaxNonNullableFields {
2128
- type: TaxType;
2129
- name: string;
2130
- rate: string;
2131
- taxable?: MoneyNonNullableFields;
2132
- amount?: MoneyNonNullableFields;
2133
- }
2134
- interface FeeNonNullableFields {
2135
- name: FeeName;
2136
- type: FeeType;
2137
- rate: string;
2138
- amount?: MoneyNonNullableFields;
2139
- }
2140
- interface ItemNonNullableFields {
2141
- id: string;
2142
- quantity: number;
2143
- name: string;
2144
- price?: MoneyNonNullableFields;
2145
- total?: MoneyNonNullableFields;
2146
- discount?: DiscountNonNullableFields;
2147
- tax?: TaxNonNullableFields;
2148
- fees: FeeNonNullableFields[];
2149
- }
2150
- interface InvoiceNonNullableFields {
2151
- items: ItemNonNullableFields[];
2152
- total?: MoneyNonNullableFields;
2153
- discount?: DiscountNonNullableFields;
2154
- tax?: TaxNonNullableFields;
2155
- subTotal?: MoneyNonNullableFields;
2156
- grandTotal?: MoneyNonNullableFields;
2157
- fees: FeeNonNullableFields[];
2158
- revenue?: MoneyNonNullableFields;
2159
- }
2160
- interface PaymentTransactionNonNullableFields {
2161
- transactionId: string;
2162
- method: string;
2163
- scheduledAction: ScheduledActionEnumAction;
2164
- }
2165
- interface PaymentDetailsNonNullableFields {
2166
- transaction?: PaymentTransactionNonNullableFields;
2167
- }
2168
- interface GiftCardPaymentDetailsNonNullableFields {
2169
- amount?: MoneyNonNullableFields;
2170
- }
2171
- interface BalanceSummaryNonNullableFields {
2172
- balance?: MoneyNonNullableFields;
2173
- }
2174
- interface OrderNonNullableFields {
2240
+ }
2241
+ interface GetOrderOptions {
2242
+ /**
2243
+ * Predefined sets of fields to return.
2244
+ * - `TICKETS`: Returns `tickets`.
2245
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
2246
+ * - `FORM` : Returns `checkoutForm`.
2247
+ * - `INVOICE`: Returns `invoice`.
2248
+ *
2249
+ * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
2250
+ * @maxSize 20
2251
+ */
2252
+ fieldset?: OrderFieldset[];
2253
+ }
2254
+ interface UpdateOrderIdentifiers {
2255
+ /**
2256
+ * Event ID to which the order belongs.
2257
+ * @format GUID
2258
+ */
2259
+ eventId: string;
2260
+ /**
2261
+ * Unique order number.
2262
+ * @maxLength 36
2263
+ */
2175
2264
  orderNumber: string;
2265
+ }
2266
+ interface UpdateOrderOptions {
2267
+ /** Set of field paths to update. */
2268
+ fields?: string[];
2269
+ /** Checkout form. */
2270
+ checkoutForm?: FormResponse;
2271
+ /** Whether order is archived. */
2272
+ archived?: boolean;
2273
+ }
2274
+ interface BulkUpdateOrdersOptions {
2275
+ /**
2276
+ * Unique order number.
2277
+ * @minLength 1
2278
+ * @maxLength 36
2279
+ * @minSize 1
2280
+ * @maxSize 100
2281
+ */
2282
+ orderNumber?: string[];
2283
+ /** Set of fields to update. */
2284
+ fields?: string[];
2285
+ /** Whether to archive the order. */
2286
+ archived?: boolean;
2287
+ }
2288
+ interface ConfirmOrderOptions {
2289
+ /**
2290
+ * Order numbers.
2291
+ * @minLength 1
2292
+ * @maxLength 36
2293
+ * @maxSize 100
2294
+ */
2295
+ orderNumber?: string[];
2296
+ }
2297
+ interface GetSummaryOptions {
2298
+ /**
2299
+ * Event ID.
2300
+ * @format GUID
2301
+ */
2302
+ eventId?: string | null;
2303
+ }
2304
+ interface CaptureAuthorizedPaymentOptions {
2305
+ /**
2306
+ * Event ID.
2307
+ * @format GUID
2308
+ */
2309
+ eventId?: string;
2310
+ }
2311
+ interface VoidAuthorizedPaymentOptions {
2312
+ /**
2313
+ * Event ID.
2314
+ * @format GUID
2315
+ */
2316
+ eventId?: string;
2317
+ }
2318
+ interface ListAvailableTicketsOptions {
2319
+ /**
2320
+ * Event ID. If not provided, available tickets for all events in the site will be returned.
2321
+ * @format GUID
2322
+ */
2323
+ eventId?: string;
2324
+ /** Offset. */
2325
+ offset?: number;
2326
+ /**
2327
+ * Limit.
2328
+ * @max 100
2329
+ */
2330
+ limit?: number;
2331
+ /**
2332
+ * Sort order.
2333
+ * Default: `created:asc`.
2334
+ * @maxLength 100
2335
+ */
2336
+ sort?: string;
2337
+ state?: State[];
2338
+ }
2339
+ interface QueryAvailableTicketsOptions {
2340
+ /** Offset. */
2341
+ offset?: number;
2342
+ /**
2343
+ * Limit.
2344
+ * @max 1000
2345
+ */
2346
+ limit?: number;
2347
+ /** Ticket definition. */
2348
+ filter?: Record<string, any> | null;
2349
+ /** @maxSize 20 */
2350
+ fieldset?: TicketDefinitionFieldset[];
2351
+ /**
2352
+ * Sort order.
2353
+ * Default: `created:asc`.
2354
+ * @maxLength 100
2355
+ */
2356
+ sort?: string;
2357
+ }
2358
+ interface CreateReservationOptions {
2359
+ /**
2360
+ * Tickets to reserve.
2361
+ * @minSize 1
2362
+ * @maxSize 50
2363
+ */
2364
+ ticketQuantities?: TicketReservationQuantity[];
2365
+ /** Whether to ignore the available ticket limits upon reservation. */
2366
+ ignoreLimits?: boolean;
2367
+ /** Whether to allow reservation for hidden tickets. */
2368
+ allowHiddenTickets?: boolean;
2369
+ }
2370
+ interface GetInvoiceOptions {
2371
+ /** Optional discount to be applied on the returned invoice. */
2372
+ withDiscount?: DiscountRequest;
2373
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
2374
+ paidPlanBenefit?: PaidPlanBenefit;
2375
+ }
2376
+ interface CheckoutOptionsForRequest {
2377
+ /**
2378
+ * Ticket reservation ID.
2379
+ * @format GUID
2380
+ */
2381
+ reservationId?: string;
2382
+ /** Member ID (if empty - no site member is associated to this order). */
2383
+ memberId?: string;
2384
+ /** Discount to apply on the invoice. */
2385
+ discount?: DiscountRequest;
2386
+ /** Buyer details. */
2387
+ buyer?: Buyer;
2388
+ /**
2389
+ * Guest details.
2390
+ * @minSize 1
2391
+ * @maxSize 50
2392
+ */
2393
+ guests?: Guest[];
2394
+ /** Benefit granted by the pricing plan. */
2395
+ paidPlanBenefit?: PaidPlanBenefit;
2396
+ /** Options controlling the checkout process. */
2397
+ options?: CheckoutOptions;
2398
+ /** Whether marketing consent was given */
2399
+ marketingConsent?: boolean | null;
2400
+ }
2401
+ interface UpdateCheckoutOptions {
2402
+ /** Buyer details. */
2403
+ buyer?: Buyer;
2404
+ /**
2405
+ * Guest details.
2406
+ * @minSize 1
2407
+ * @maxSize 20
2408
+ */
2409
+ guests?: Guest[];
2410
+ /** Member ID (if empty - no site member is associated to this order). */
2411
+ memberId?: string | null;
2412
+ /** Discount to apply on the invoice. */
2413
+ discount?: DiscountRequest;
2414
+ /** Benefit granted by the pricing plan. */
2415
+ paidPlanBenefit?: PaidPlanBenefit;
2416
+ }
2417
+ interface PosCheckoutOptions {
2418
+ /**
2419
+ * Ticket reservation ID.
2420
+ * @format GUID
2421
+ */
2176
2422
  reservationId: string;
2177
- snapshotId: string;
2178
- eventId: string;
2179
- contactId: string;
2180
- memberId: string;
2181
- firstName: string;
2182
- lastName: string;
2183
- email: string;
2184
- checkoutForm?: FormResponseNonNullableFields;
2185
- confirmed: boolean;
2186
- status: OrderStatus;
2187
- method: string;
2188
- ticketsQuantity: number;
2189
- totalPrice?: MoneyNonNullableFields;
2190
- ticketsPdf: string;
2191
- tickets: TicketingTicketNonNullableFields[];
2192
- archived: boolean;
2193
- anonymized: boolean;
2194
- fullName: string;
2195
- invoice?: InvoiceNonNullableFields;
2196
- fullyCheckedIn: boolean;
2197
- transactionId: string;
2198
- paymentDetails?: PaymentDetailsNonNullableFields;
2199
- channel: ChannelType;
2200
- availableActions: Action[];
2201
- giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[];
2202
- balanceSummary?: BalanceSummaryNonNullableFields;
2203
- }
2204
- export interface ListOrdersResponseNonNullableFields {
2205
- total: number;
2206
- offset: number;
2207
- limit: number;
2208
- orders: OrderNonNullableFields[];
2209
- }
2210
- interface CalendarLinksNonNullableFields {
2211
- google: string;
2212
- ics: string;
2213
- }
2214
- export interface GetOrderResponseNonNullableFields {
2215
- order?: OrderNonNullableFields;
2216
- calendarLinks?: CalendarLinksNonNullableFields;
2217
- }
2218
- export interface UpdateOrderResponseNonNullableFields {
2219
- order?: OrderNonNullableFields;
2220
- }
2221
- export interface BulkUpdateOrdersResponseNonNullableFields {
2222
- orders: OrderNonNullableFields[];
2223
- }
2224
- export interface ConfirmOrderResponseNonNullableFields {
2225
- orders: OrderNonNullableFields[];
2226
- }
2227
- interface TicketSalesNonNullableFields {
2228
- total?: MoneyNonNullableFields;
2229
- totalOrders: number;
2230
- totalTickets: number;
2231
- revenue?: MoneyNonNullableFields;
2232
- }
2233
- export interface GetSummaryResponseNonNullableFields {
2234
- sales: TicketSalesNonNullableFields[];
2235
- }
2236
- export interface GetCheckoutOptionsResponseNonNullableFields {
2237
- paymentMethodConfigured: boolean;
2238
- acceptCoupons: boolean;
2239
- premiumServices: boolean;
2240
- paidTickets: boolean;
2241
- acceptGiftCards: boolean;
2242
- }
2243
- interface ResponseMetaDataNonNullableFields {
2244
- count: number;
2245
- offset: number;
2246
- total: number;
2247
- }
2248
- interface DashboardNonNullableFields {
2249
- hidden: boolean;
2250
- sold: number;
2251
- limited: boolean;
2252
- ticketsSold: number;
2253
- ticketsReserved: number;
2254
- }
2255
- interface WixFeeConfigNonNullableFields {
2256
- type: FeeType;
2257
- }
2258
- interface TicketSalePeriodNonNullableFields {
2259
- hideNotOnSale: boolean;
2260
- }
2261
- interface PricingOptionNonNullableFields {
2262
- price?: MoneyNonNullableFields;
2263
- }
2264
- interface PricingOptionsNonNullableFields {
2265
- options: PricingOptionNonNullableFields[];
2266
- }
2267
- interface TicketPricingNonNullableFields {
2268
- fixedPrice?: MoneyNonNullableFields;
2269
- minPrice?: MoneyNonNullableFields;
2270
- pricingOptions?: PricingOptionsNonNullableFields;
2271
- pricingType: Type;
2272
- }
2273
- interface TicketDefinitionNonNullableFields {
2274
- id: string;
2275
- price?: MoneyNonNullableFields;
2276
- free: boolean;
2277
- name: string;
2278
- description: string;
2279
- limitPerCheckout: number;
2280
- orderIndex: number;
2281
- policy: string;
2282
- dashboard?: DashboardNonNullableFields;
2283
- eventId: string;
2284
- wixFeeConfig?: WixFeeConfigNonNullableFields;
2285
- salePeriod?: TicketSalePeriodNonNullableFields;
2286
- saleStatus: TicketSaleStatus;
2287
- state: State[];
2288
- pricing?: TicketPricingNonNullableFields;
2289
- }
2290
- export interface ListAvailableTicketsResponseNonNullableFields {
2291
- metaData?: ResponseMetaDataNonNullableFields;
2292
- definitions: TicketDefinitionNonNullableFields[];
2293
- }
2294
- export interface QueryAvailableTicketsResponseNonNullableFields {
2295
- metaData?: ResponseMetaDataNonNullableFields;
2296
- definitions: TicketDefinitionNonNullableFields[];
2297
- }
2298
- interface TicketReservationNonNullableFields {
2299
- quantity: number;
2300
- ticket?: TicketDefinitionNonNullableFields;
2301
- }
2302
- export interface CreateReservationResponseNonNullableFields {
2303
- id: string;
2304
- reservations: TicketReservationNonNullableFields[];
2305
- invoice?: InvoiceNonNullableFields;
2306
- reservationStatus: ReservationStatus;
2307
- }
2308
- interface ErrorNonNullableFields {
2309
- code: string;
2310
- }
2311
- interface DiscountErrorsNonNullableFields {
2312
- error: ErrorNonNullableFields[];
2313
- }
2314
- interface GiftCardErrorsErrorNonNullableFields {
2315
- code: string;
2316
- }
2317
- interface GiftCardErrorsNonNullableFields {
2318
- error: GiftCardErrorsErrorNonNullableFields[];
2319
- }
2320
- export interface GetInvoiceResponseNonNullableFields {
2321
- invoice?: InvoiceNonNullableFields;
2322
- discountErrors?: DiscountErrorsNonNullableFields;
2323
- reservationStatus: ReservationStatus;
2324
- reservationOccupied: boolean;
2325
- reservations: TicketReservationNonNullableFields[];
2326
- giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[];
2327
- balanceSummary?: BalanceSummaryNonNullableFields;
2328
- giftCardErrors?: GiftCardErrorsNonNullableFields;
2329
- }
2330
- export interface CheckoutResponseNonNullableFields {
2331
- order?: OrderNonNullableFields;
2332
- reservations: TicketReservationNonNullableFields[];
2333
- }
2334
- export interface UpdateCheckoutResponseNonNullableFields {
2335
- order?: OrderNonNullableFields;
2336
- }
2337
- export interface PosCheckoutResponseNonNullableFields {
2338
- order?: OrderNonNullableFields;
2339
- reservations: TicketReservationNonNullableFields[];
2340
- }
2341
- export {};
2423
+ /**
2424
+ * Payment details ID.
2425
+ * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2426
+ * @format GUID
2427
+ */
2428
+ paymentDetailsId?: string | null;
2429
+ }
2430
+
2431
+ export { type StreetAddress as $, Action as A, type BulkUpdateOrdersOptions as B, type ConfirmOrderOptions as C, OrderType as D, OrderFieldset as E, FeeName as F, type GetOrderIdentifiers as G, OrderTag as H, State as I, TicketSaleStatus as J, Type as K, type ListOrdersOptions as L, TicketDefinitionFieldset as M, type FormResponse as N, type Order as O, type PosCheckoutOptions as P, type QueryAvailableTicketsOptions as Q, ReservationStatus as R, SubdivisionType as S, TaxType as T, type UpdateOrderIdentifiers as U, type VoidAuthorizedPaymentOptions as V, WebhookIdentityType as W, type InputValue as X, type FormattedAddress as Y, type Address as Z, type AddressStreetOneOf as _, type ListOrdersResponse as a, type TicketDefinition as a$, type AddressLocation as a0, type Subdivision as a1, type StandardDetails as a2, type Money as a3, type TicketingTicket as a4, type CheckIn as a5, type GuestDetails as a6, type TicketDetails as a7, type Invoice as a8, type Item as a9, type BulkUpdateOrdersRequest as aA, type ConfirmOrderRequest as aB, type GetSummaryRequest as aC, type TicketSales as aD, type GetInvoicePreviewRequest as aE, type RawHttpResponse as aF, type HeadersEntry as aG, type GetPaymentInfoRequest as aH, type GetPaymentInfoResponse as aI, type PaymentTransactionSummary as aJ, type PaymentTransactionEvent as aK, type CaptureAuthorizedPaymentRequest as aL, type CaptureAuthorizedPaymentResponse as aM, type VoidAuthorizedPaymentRequest as aN, type VoidAuthorizedPaymentResponse as aO, type MessageEnvelope as aP, type IdentificationData as aQ, type IdentificationDataIdOneOf as aR, type OrderConfirmed as aS, type OrderPaid as aT, type ReservationCreated as aU, type TicketQuantity as aV, type ReservationCount as aW, type ReservationUpdated as aX, type GetCheckoutOptionsRequest as aY, type ListAvailableTicketsRequest as aZ, type ResponseMetaData as a_, type Discount as aa, type DiscountItem as ab, type DiscountItemDiscountOneOf as ac, type CouponDiscount as ad, type PaidPlanDiscount as ae, type PaidPlanDiscountDiscountOneOf as af, type PercentDiscount as ag, type Tax as ah, type Fee as ai, type PaymentDetails as aj, type PaymentTransaction as ak, type GiftCardPaymentDetails as al, type BalanceSummary as am, type OrderDeleted as an, type Ticket as ao, type OnlineConferencingLogin as ap, type ListOrdersRequest as aq, type FacetCounts as ar, type OrderFacets as as, type OrderFacetCounts as at, type Counts as au, type GetOrderRequest as av, type GetOrderResponse as aw, type CalendarLinks as ax, type UpdateOrderRequest as ay, type OrderUpdated as az, type GetOrderOptions as b, type Dashboard as b0, type WixFeeConfig as b1, type TicketSalePeriod as b2, type TicketPricing as b3, type TicketPricingPriceOneOf as b4, type PricingOptions as b5, type PricingOption as b6, type QueryAvailableTicketsRequest as b7, type CreateReservationRequest as b8, type TicketReservationQuantity as b9, type OrderReservationUpdatedEnvelope as bA, type TicketReservation as ba, type CancelReservationRequest as bb, type CancelReservationResponse as bc, type GetInvoiceRequest as bd, type DiscountRequest as be, type PaidPlanBenefit as bf, type DiscountErrors as bg, type Error as bh, type GiftCardErrors as bi, type GiftCardErrorsError as bj, type CheckoutRequest as bk, type Buyer as bl, type Guest as bm, type CheckoutOptions as bn, type OrderInitiated as bo, type UpdateCheckoutRequest as bp, type OrderPageUrls as bq, type PosCheckoutRequest as br, type GetReservationRequest as bs, type GetReservationResponse as bt, type BaseEventMetadata as bu, type OrderDeletedEnvelope as bv, type OrderUpdatedEnvelope as bw, type OrderConfirmedEnvelope as bx, type OrderInitiatedEnvelope as by, type OrderReservationCreatedEnvelope as bz, type UpdateOrderOptions as c, type UpdateOrderResponse as d, type BulkUpdateOrdersResponse as e, type ConfirmOrderResponse as f, type GetSummaryOptions as g, type GetSummaryResponse as h, type CaptureAuthorizedPaymentOptions as i, type GetCheckoutOptionsResponse as j, type ListAvailableTicketsOptions as k, type ListAvailableTicketsResponse as l, type QueryAvailableTicketsResponse as m, type CreateReservationOptions as n, type CreateReservationResponse as o, type GetInvoiceOptions as p, type GetInvoiceResponse as q, type CheckoutOptionsForRequest as r, type CheckoutResponse as s, type UpdateCheckoutOptions as t, type UpdateCheckoutResponse as u, type PosCheckoutResponse as v, OrderStatus as w, ChannelType as x, FeeType as y, ScheduledActionEnumAction as z };