@wix/auto_sdk_events_orders 1.0.17 → 1.0.19

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