@wix/auto_sdk_events_orders 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/build/{internal/cjs/src/events-v1-order-orders.universal.d.ts → events-v1-order-orders.universal-C56YAmFe.d.mts} +393 -759
  2. package/build/{internal/es/src/events-v1-order-orders.universal.d.ts → events-v1-order-orders.universal-C56YAmFe.d.ts} +393 -759
  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/{cjs/src/events-v1-order-orders.universal.d.ts → internal/events-v1-order-orders.universal-C56YAmFe.d.mts} +393 -759
  10. package/build/{es/src/events-v1-order-orders.universal.d.ts → internal/events-v1-order-orders.universal-C56YAmFe.d.ts} +393 -759
  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.d.ts +0 -2078
  52. package/build/cjs/src/events-v1-order-orders.types.js +0 -178
  53. package/build/cjs/src/events-v1-order-orders.types.js.map +0 -1
  54. package/build/cjs/src/events-v1-order-orders.universal.js +0 -1180
  55. package/build/cjs/src/events-v1-order-orders.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/src/events-v1-order-orders.context.d.ts +0 -42
  66. package/build/es/src/events-v1-order-orders.context.js +0 -42
  67. package/build/es/src/events-v1-order-orders.context.js.map +0 -1
  68. package/build/es/src/events-v1-order-orders.http.d.ts +0 -97
  69. package/build/es/src/events-v1-order-orders.http.js +0 -1615
  70. package/build/es/src/events-v1-order-orders.http.js.map +0 -1
  71. package/build/es/src/events-v1-order-orders.meta.d.ts +0 -49
  72. package/build/es/src/events-v1-order-orders.meta.js +0 -308
  73. package/build/es/src/events-v1-order-orders.meta.js.map +0 -1
  74. package/build/es/src/events-v1-order-orders.public.d.ts +0 -202
  75. package/build/es/src/events-v1-order-orders.public.js +0 -211
  76. package/build/es/src/events-v1-order-orders.public.js.map +0 -1
  77. package/build/es/src/events-v1-order-orders.types.d.ts +0 -2078
  78. package/build/es/src/events-v1-order-orders.types.js +0 -175
  79. package/build/es/src/events-v1-order-orders.types.js.map +0 -1
  80. package/build/es/src/events-v1-order-orders.universal.js +0 -1137
  81. package/build/es/src/events-v1-order-orders.universal.js.map +0 -1
  82. package/build/internal/cjs/index.d.ts +0 -1
  83. package/build/internal/cjs/index.js +0 -18
  84. package/build/internal/cjs/index.js.map +0 -1
  85. package/build/internal/cjs/index.typings.d.ts +0 -1
  86. package/build/internal/cjs/index.typings.js +0 -18
  87. package/build/internal/cjs/index.typings.js.map +0 -1
  88. package/build/internal/cjs/meta.d.ts +0 -1
  89. package/build/internal/cjs/meta.js +0 -18
  90. package/build/internal/cjs/meta.js.map +0 -1
  91. package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +0 -42
  92. package/build/internal/cjs/src/events-v1-order-orders.context.js +0 -62
  93. package/build/internal/cjs/src/events-v1-order-orders.context.js.map +0 -1
  94. package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +0 -97
  95. package/build/internal/cjs/src/events-v1-order-orders.http.js +0 -1635
  96. package/build/internal/cjs/src/events-v1-order-orders.http.js.map +0 -1
  97. package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
  98. package/build/internal/cjs/src/events-v1-order-orders.meta.js +0 -351
  99. package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +0 -1
  100. package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +0 -202
  101. package/build/internal/cjs/src/events-v1-order-orders.public.js +0 -248
  102. package/build/internal/cjs/src/events-v1-order-orders.public.js.map +0 -1
  103. package/build/internal/cjs/src/events-v1-order-orders.types.d.ts +0 -2078
  104. package/build/internal/cjs/src/events-v1-order-orders.types.js +0 -178
  105. package/build/internal/cjs/src/events-v1-order-orders.types.js.map +0 -1
  106. package/build/internal/cjs/src/events-v1-order-orders.universal.js +0 -1180
  107. package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +0 -1
  108. package/build/internal/es/index.d.ts +0 -1
  109. package/build/internal/es/index.js +0 -2
  110. package/build/internal/es/index.js.map +0 -1
  111. package/build/internal/es/index.typings.d.ts +0 -1
  112. package/build/internal/es/index.typings.js +0 -2
  113. package/build/internal/es/index.typings.js.map +0 -1
  114. package/build/internal/es/meta.d.ts +0 -1
  115. package/build/internal/es/meta.js +0 -2
  116. package/build/internal/es/meta.js.map +0 -1
  117. package/build/internal/es/src/events-v1-order-orders.context.d.ts +0 -42
  118. package/build/internal/es/src/events-v1-order-orders.context.js +0 -42
  119. package/build/internal/es/src/events-v1-order-orders.context.js.map +0 -1
  120. package/build/internal/es/src/events-v1-order-orders.http.d.ts +0 -97
  121. package/build/internal/es/src/events-v1-order-orders.http.js +0 -1615
  122. package/build/internal/es/src/events-v1-order-orders.http.js.map +0 -1
  123. package/build/internal/es/src/events-v1-order-orders.meta.d.ts +0 -49
  124. package/build/internal/es/src/events-v1-order-orders.meta.js +0 -308
  125. package/build/internal/es/src/events-v1-order-orders.meta.js.map +0 -1
  126. package/build/internal/es/src/events-v1-order-orders.public.d.ts +0 -202
  127. package/build/internal/es/src/events-v1-order-orders.public.js +0 -211
  128. package/build/internal/es/src/events-v1-order-orders.public.js.map +0 -1
  129. package/build/internal/es/src/events-v1-order-orders.types.d.ts +0 -2078
  130. package/build/internal/es/src/events-v1-order-orders.types.js +0 -175
  131. package/build/internal/es/src/events-v1-order-orders.types.js.map +0 -1
  132. package/build/internal/es/src/events-v1-order-orders.universal.js +0 -1137
  133. package/build/internal/es/src/events-v1-order-orders.universal.js.map +0 -1
@@ -1,2078 +0,0 @@
1
- export interface Order {
2
- /** Unique order number. */
3
- orderNumber?: string;
4
- /**
5
- * Reservation ID.
6
- * @format GUID
7
- */
8
- reservationId?: string;
9
- /**
10
- * Payment snapshot ID.
11
- * Empty for FREE order.
12
- * @format GUID
13
- * @readonly
14
- */
15
- snapshotId?: string;
16
- /**
17
- * Event ID.
18
- * @format GUID
19
- */
20
- eventId?: string;
21
- /**
22
- * Contact ID of buyer (resolved using email address).
23
- * @format GUID
24
- */
25
- contactId?: string;
26
- /**
27
- * Member ID of buyer (if relevant).
28
- * @format GUID
29
- */
30
- memberId?: string;
31
- /**
32
- * RSVP created timestamp.
33
- * @readonly
34
- */
35
- created?: Date | null;
36
- /** Guest first name. */
37
- firstName?: string;
38
- /** Guest last name. */
39
- lastName?: string;
40
- /**
41
- * Guest email.
42
- * @format EMAIL
43
- */
44
- email?: string;
45
- /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
46
- checkoutForm?: FormResponse;
47
- /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
48
- confirmed?: boolean;
49
- /** Order status. */
50
- status?: OrderStatusWithLiterals;
51
- /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
52
- method?: string;
53
- /** Tickets ordered. */
54
- ticketsQuantity?: number;
55
- /** Total order price. */
56
- totalPrice?: Money;
57
- /** URL to ticket PDF. */
58
- ticketsPdf?: string;
59
- /** Tickets (generated after payment). */
60
- tickets?: TicketingTicket[];
61
- /** Whether the order is archived. */
62
- archived?: boolean;
63
- /** Whether the order is anonymized by GDPR delete. */
64
- anonymized?: boolean;
65
- /** Guest full name. */
66
- fullName?: string;
67
- /** Order invoice. */
68
- invoice?: Invoice;
69
- /** Whether all tickets in order are checked-in. */
70
- fullyCheckedIn?: boolean;
71
- /** Internal order payment details */
72
- paymentDetails?: PaymentDetails;
73
- /** Checkout channel type */
74
- channel?: ChannelTypeWithLiterals;
75
- /**
76
- * Order updated timestamp.
77
- * @readonly
78
- */
79
- updated?: Date | null;
80
- /** Whether marketing consent was given */
81
- marketingConsent?: boolean | null;
82
- }
83
- export interface FormResponse {
84
- /**
85
- * Input values entered when filling the form.
86
- * @maxSize 200
87
- */
88
- inputValues?: InputValue[];
89
- }
90
- export interface InputValue {
91
- /**
92
- * Input field name.
93
- * @maxLength 100
94
- */
95
- inputName?: string;
96
- /**
97
- * Text entered into the input field.
98
- * @maxLength 5000
99
- */
100
- value?: string;
101
- /**
102
- * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
103
- * @maxSize 100
104
- * @maxLength 5000
105
- */
106
- values?: string[];
107
- }
108
- export interface FormattedAddress {
109
- /**
110
- * One line address representation.
111
- * @maxLength 200
112
- */
113
- formatted?: string;
114
- /** Address components (optional). */
115
- address?: Address;
116
- }
117
- /** Physical address */
118
- export interface Address extends AddressStreetOneOf {
119
- /** Street name and number. */
120
- streetAddress?: StreetAddress;
121
- /** Main address line, usually street and number as free text. */
122
- addressLine?: string | null;
123
- /**
124
- * Country code.
125
- * @format COUNTRY
126
- */
127
- country?: string | null;
128
- /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
129
- subdivision?: string | null;
130
- /** City name. */
131
- city?: string | null;
132
- /** Zip/postal code. */
133
- postalCode?: string | null;
134
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
135
- addressLine2?: string | null;
136
- }
137
- /** @oneof */
138
- export interface AddressStreetOneOf {
139
- /** Street name and number. */
140
- streetAddress?: StreetAddress;
141
- /** Main address line, usually street and number as free text. */
142
- addressLine?: string | null;
143
- }
144
- export interface StreetAddress {
145
- /** Street number. */
146
- number?: string;
147
- /** Street name. */
148
- name?: string;
149
- }
150
- export interface AddressLocation {
151
- /** Address latitude. */
152
- latitude?: number | null;
153
- /** Address longitude. */
154
- longitude?: number | null;
155
- }
156
- export interface Subdivision {
157
- /** Short subdivision code. */
158
- code?: string;
159
- /** Subdivision full name. */
160
- name?: string;
161
- }
162
- export declare enum SubdivisionType {
163
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
164
- /** State */
165
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
166
- /** County */
167
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
168
- /** City/town */
169
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
170
- /** Neighborhood/quarter */
171
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
172
- /** Street/block */
173
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
174
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
175
- COUNTRY = "COUNTRY"
176
- }
177
- /** @enumType */
178
- 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';
179
- /** Subdivision Concordance values */
180
- export interface StandardDetails {
181
- /**
182
- * 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
183
- * @maxLength 20
184
- */
185
- iso31662?: string | null;
186
- }
187
- export declare enum OrderStatus {
188
- /** Order status not available for this request fieldset. */
189
- NA_ORDER_STATUS = "NA_ORDER_STATUS",
190
- /** Order is confirmed and payment isn't required. */
191
- FREE = "FREE",
192
- /** Order is paid for but the payment gateway has suspended the payment. */
193
- PENDING = "PENDING",
194
- /** Order is paid via a payment gateway. */
195
- PAID = "PAID",
196
- /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
197
- OFFLINE_PENDING = "OFFLINE_PENDING",
198
- /** Order is awaiting payment at the cashier. */
199
- INITIATED = "INITIATED",
200
- /** Order is canceled. */
201
- CANCELED = "CANCELED",
202
- /** Order payment is declined. */
203
- DECLINED = "DECLINED",
204
- /** Order payment is authorized. */
205
- AUTHORIZED = "AUTHORIZED",
206
- /** Order payment is voided. */
207
- VOIDED = "VOIDED",
208
- /** Order is partially paid with less than the total amount. */
209
- PARTIALLY_PAID = "PARTIALLY_PAID"
210
- }
211
- /** @enumType */
212
- export type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
213
- export interface Money {
214
- /**
215
- * *Deprecated:** Use `value` instead.
216
- * @format DECIMAL_VALUE
217
- * @deprecated
218
- */
219
- amount?: string;
220
- /**
221
- * ISO 4217 format of the currency e.g., `USD`.
222
- * @format CURRENCY
223
- */
224
- currency?: string;
225
- /**
226
- * 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.
227
- * @format DECIMAL_VALUE
228
- */
229
- value?: string | null;
230
- }
231
- export interface TicketingTicket {
232
- /** Unique ticket number (issued automatically). */
233
- ticketNumber?: string;
234
- /** Associated order number. */
235
- orderNumber?: string;
236
- /**
237
- * Ticket definition ID.
238
- * @format GUID
239
- */
240
- ticketDefinitionId?: string;
241
- /** Ticket name. */
242
- name?: string;
243
- /** Ticket price. */
244
- price?: Money;
245
- /**
246
- * Whether ticket requires payment.
247
- * @readonly
248
- */
249
- free?: boolean;
250
- /** Ticket policy (as displayed in PDF). */
251
- policy?: string;
252
- /**
253
- * Deprecated, use `check_in_url`.
254
- * @deprecated
255
- */
256
- qrCode?: string;
257
- /** Ticket check-in. */
258
- checkIn?: CheckIn;
259
- /** Associated order status. */
260
- orderStatus?: OrderStatusWithLiterals;
261
- /** Whether order and ticket are visible in order list. */
262
- orderArchived?: boolean;
263
- /** Buyer full name. */
264
- orderFullName?: string;
265
- /** Guest full name. */
266
- guestFullName?: string | null;
267
- /** Guest personal details. */
268
- guestDetails?: GuestDetails;
269
- /** Whether ticket is visible in guest list. */
270
- archived?: boolean;
271
- /**
272
- * Deprecated, use `ticket_pdf_url`.
273
- * @deprecated
274
- */
275
- ticketPdf?: string;
276
- /**
277
- * Ticket owner member ID.
278
- * @format GUID
279
- */
280
- memberId?: string | null;
281
- /**
282
- * Whether ticket was anonymized by GDPR delete.
283
- * Anonymized tickets no longer contain personally identifiable information (PII).
284
- */
285
- anonymized?: boolean;
286
- /**
287
- * Ticket check-in URL.
288
- * Shown as QR code image in PDF.
289
- * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
290
- * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
291
- */
292
- checkInUrl?: string;
293
- /** URL for ticket PDF download. */
294
- ticketPdfUrl?: string;
295
- /** Associated order checkout channel type */
296
- channel?: ChannelTypeWithLiterals;
297
- /**
298
- * URL to download ticket in .pkpass format for Apple Wallet
299
- * @format WEB_URL
300
- * @readonly
301
- */
302
- walletPassUrl?: string;
303
- /**
304
- * Whether ticket is canceled.
305
- * @readonly
306
- */
307
- canceled?: boolean | null;
308
- }
309
- export interface CheckIn {
310
- /** Time of check-in */
311
- created?: Date | null;
312
- }
313
- export interface GuestDetails {
314
- /** Whether ticket belongs to assigned guest. */
315
- guestAssigned?: boolean;
316
- /** Guest first name. */
317
- firstName?: string | null;
318
- /** Guest last name. */
319
- lastName?: string | null;
320
- /**
321
- * Guest email.
322
- * @format EMAIL
323
- */
324
- email?: string | null;
325
- /** Full form response. */
326
- form?: FormResponse;
327
- /**
328
- * Contact ID associated with this guest.
329
- * @format GUID
330
- */
331
- contactId?: string | null;
332
- /**
333
- * Guest phone number.
334
- * @format PHONE
335
- */
336
- phone?: string | null;
337
- }
338
- export declare enum ChannelType {
339
- /** Buyer created the order via an online channel such as a website or mobile app. */
340
- ONLINE = "ONLINE",
341
- /** Sales person created the order and collected the money. */
342
- OFFLINE_POS = "OFFLINE_POS"
343
- }
344
- /** @enumType */
345
- export type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
346
- export interface TicketDetails {
347
- /**
348
- * Unique seat id in the event venue.
349
- * @minLength 1
350
- * @maxLength 36
351
- */
352
- seatId?: string | null;
353
- /**
354
- * Optional sector label.
355
- * @readonly
356
- */
357
- sectionLabel?: string | null;
358
- /**
359
- * Area label.
360
- * @readonly
361
- */
362
- areaLabel?: string | null;
363
- /**
364
- * Table label.
365
- * @readonly
366
- */
367
- tableLabel?: string | null;
368
- /**
369
- * Row label.
370
- * @readonly
371
- */
372
- rowLabel?: string | null;
373
- /**
374
- * Seat label in a row or table.
375
- * @readonly
376
- */
377
- seatLabel?: string | null;
378
- /**
379
- * Number of places in the spot. If not provided - defaults to 1.
380
- * @min 1
381
- * @max 50
382
- */
383
- capacity?: number | null;
384
- /**
385
- * Custom pricing of ticket.
386
- * @format DECIMAL_VALUE
387
- */
388
- priceOverride?: string | null;
389
- /**
390
- * Pricing option id.
391
- * @format GUID
392
- */
393
- pricingOptionId?: string | null;
394
- /**
395
- * Pricing option name.
396
- * @readonly
397
- */
398
- pricingOptionName?: string | null;
399
- }
400
- export interface Invoice {
401
- items?: Item[];
402
- /**
403
- * Total cart amount.
404
- * @deprecated
405
- */
406
- total?: Money;
407
- /** Discount applied to cart. */
408
- discount?: Discount;
409
- /** Tax applied to cart. */
410
- tax?: Tax;
411
- /** Total cart amount before discount, tax, and fees. */
412
- subTotal?: Money;
413
- /**
414
- * Total amount of cart after discount, tax, and fees.
415
- * Grand total is calculated in the following order:
416
- * 1. Total prices of all items in the cart are calculated.
417
- * 2. Discount is subtracted from the cart (if applicable).
418
- * 3. Tax is added (if applicable).
419
- * 4. Wix ticket service fee is added.
420
- */
421
- grandTotal?: Money;
422
- /**
423
- * Fees applied to the cart.
424
- * @readonly
425
- */
426
- fees?: Fee[];
427
- /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
428
- revenue?: Money;
429
- /** URL to invoice preview. Returned only if order is paid. */
430
- previewUrl?: string | null;
431
- }
432
- export interface Item {
433
- /**
434
- * Unique line item ID.
435
- * @format GUID
436
- */
437
- id?: string;
438
- /**
439
- * Line item quantity.
440
- * @min 1
441
- * @max 50
442
- */
443
- quantity?: number;
444
- /** Line item name. */
445
- name?: string;
446
- /** Line item price. */
447
- price?: Money;
448
- /** Total price for line items. Always equal to price * quantity. */
449
- total?: Money;
450
- /** Discount applied to the line item. */
451
- discount?: Discount;
452
- /** Tax applied to the item. */
453
- tax?: Tax;
454
- /**
455
- * Fees applied to the item.
456
- * @readonly
457
- */
458
- fees?: Fee[];
459
- }
460
- export interface Discount {
461
- /** Total discount amount. */
462
- amount?: Money;
463
- /** Total charge after applied discount. */
464
- afterDiscount?: Money;
465
- /**
466
- * Discount coupon code.
467
- * @deprecated
468
- */
469
- code?: string;
470
- /**
471
- * Discount coupon name.
472
- * @deprecated
473
- */
474
- name?: string;
475
- /**
476
- * Discount coupon ID.
477
- * @deprecated
478
- */
479
- couponId?: string;
480
- /** Discount items. */
481
- discounts?: DiscountItem[];
482
- }
483
- export interface DiscountItem extends DiscountItemDiscountOneOf {
484
- /** Coupon discount. */
485
- coupon?: CouponDiscount;
486
- /** Pricing plan discount. */
487
- paidPlan?: PaidPlanDiscount;
488
- /** Total discount amount. */
489
- amount?: Money;
490
- }
491
- /** @oneof */
492
- export interface DiscountItemDiscountOneOf {
493
- /** Coupon discount. */
494
- coupon?: CouponDiscount;
495
- /** Pricing plan discount. */
496
- paidPlan?: PaidPlanDiscount;
497
- }
498
- export interface CouponDiscount {
499
- /** Discount coupon name. */
500
- name?: string;
501
- /** Discount coupon code. */
502
- code?: string;
503
- /** Discount coupon ID. */
504
- couponId?: string;
505
- }
506
- export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
507
- /** Discount by percentage applied to tickets. */
508
- percentDiscount?: PercentDiscount;
509
- /** Name of pricing plan. */
510
- name?: string;
511
- }
512
- /** @oneof */
513
- export interface PaidPlanDiscountDiscountOneOf {
514
- /** Discount by percentage applied to tickets. */
515
- percentDiscount?: PercentDiscount;
516
- }
517
- export interface PercentDiscount {
518
- /**
519
- * Percent rate.
520
- * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
521
- */
522
- rate?: string;
523
- /** Number of discounted tickets. */
524
- quantityDiscounted?: number;
525
- }
526
- export interface Tax {
527
- /** Tax type. */
528
- type?: TaxTypeWithLiterals;
529
- /**
530
- * Tax name.
531
- * @readonly
532
- */
533
- name?: string;
534
- /**
535
- * Tax rate.
536
- * @format DECIMAL_VALUE
537
- */
538
- rate?: string;
539
- /** Taxable amount. */
540
- taxable?: Money;
541
- /** Total tax amount. */
542
- amount?: Money;
543
- }
544
- export declare enum TaxType {
545
- /** Tax is included in the ticket price. */
546
- INCLUDED = "INCLUDED",
547
- /** Tax is added to the order at the checkout. */
548
- ADDED = "ADDED",
549
- /** Tax is added to the final total at the checkout. */
550
- ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
551
- }
552
- /** @enumType */
553
- export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
554
- export interface Fee {
555
- /** Fee identifier. */
556
- name?: FeeNameWithLiterals;
557
- /** How fee is calculated. */
558
- type?: FeeTypeWithLiterals;
559
- /**
560
- * Fee rate.
561
- * @format DECIMAL_VALUE
562
- * @readonly
563
- */
564
- rate?: string;
565
- /** Total amount of fee charges. */
566
- amount?: Money;
567
- }
568
- export declare enum FeeName {
569
- /** Wix ticket service fee charges applied to the line item. */
570
- WIX_FEE = "WIX_FEE"
571
- }
572
- /** @enumType */
573
- export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
574
- export declare enum FeeType {
575
- /** Fee is added to the ticket price at checkout. */
576
- FEE_ADDED = "FEE_ADDED",
577
- /** Seller absorbs the fee. It is deducted from the ticket price. */
578
- FEE_INCLUDED = "FEE_INCLUDED",
579
- /** Fee is added to the ticket price at checkout. */
580
- FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
581
- }
582
- /** @enumType */
583
- export type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
584
- export interface PaymentDetails {
585
- /** Wix Payments transaction */
586
- transaction?: PaymentTransaction;
587
- }
588
- export interface PaymentTransaction {
589
- /**
590
- * Wix Payments transaction id
591
- * @format GUID
592
- * @readonly
593
- */
594
- transactionId?: string;
595
- /**
596
- * Transaction Payment method e.g., "payPal", "creditCard", etc.
597
- * @readonly
598
- */
599
- method?: string;
600
- }
601
- export declare enum ScheduledActionEnumAction {
602
- /** Action not scheduled. */
603
- UNKNOWN_ACTION = "UNKNOWN_ACTION",
604
- /** Captured after the delay. */
605
- CAPTURE = "CAPTURE",
606
- /** Void after the delay. */
607
- VOID = "VOID"
608
- }
609
- /** @enumType */
610
- export type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
611
- export declare enum Action {
612
- /** Order can be archived. */
613
- ARCHIVE = "ARCHIVE",
614
- /** Order can be unarchived. */
615
- UNARCHIVE = "UNARCHIVE",
616
- /** Order can be confirmed. */
617
- CONFIRM = "CONFIRM",
618
- /** Order can be captured. */
619
- CAPTURE = "CAPTURE",
620
- /** Order can be voided. */
621
- VOID = "VOID"
622
- }
623
- /** @enumType */
624
- export type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
625
- export interface GiftCardPaymentDetails {
626
- /**
627
- * Gift card payment id.
628
- * @format GUID
629
- */
630
- giftCardPaymentId?: string | null;
631
- /**
632
- * ID of the app that created the gift card.
633
- * @format GUID
634
- */
635
- appId?: string | null;
636
- /** Whether the gift card payment is voided. */
637
- voided?: boolean | null;
638
- /** Amount */
639
- amount?: Money;
640
- /**
641
- * Obfuscated gift card code.
642
- * @maxLength 30
643
- */
644
- obfuscatedCode?: string | null;
645
- }
646
- export interface BalanceSummary {
647
- /** Amount left to pay. */
648
- balance?: Money;
649
- }
650
- export interface OrderDeleted {
651
- /** Order deleted timestamp in ISO UTC format. */
652
- timestamp?: Date | null;
653
- /**
654
- * Event ID.
655
- * @format GUID
656
- */
657
- eventId?: string;
658
- /** Unique order number. */
659
- orderNumber?: string;
660
- /** Contact ID associated with this order */
661
- contactId?: string;
662
- /**
663
- * Member ID associated with this order.
664
- * @format GUID
665
- */
666
- memberId?: string | null;
667
- /**
668
- * Order created timestamp.
669
- * @readonly
670
- */
671
- created?: Date | null;
672
- /**
673
- * Order updated timestamp.
674
- * @readonly
675
- */
676
- updated?: Date | null;
677
- /** Whether order was anonymized by GDPR delete. */
678
- anonymized?: boolean;
679
- /** Order type. */
680
- orderType?: OrderTypeWithLiterals;
681
- /** Whether event was triggered by GDPR delete request. */
682
- triggeredByAnonymizeRequest?: boolean;
683
- /** Tickets generated after payment. */
684
- tickets?: Ticket[];
685
- }
686
- export declare enum OrderType {
687
- /** Buyer form is used for all tickets. */
688
- UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
689
- /** Each order ticket has its own form. */
690
- ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
691
- }
692
- /** @enumType */
693
- export type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
694
- export interface Ticket {
695
- /** Unique issued ticket number. */
696
- ticketNumber?: string;
697
- /**
698
- * Ticket definition ID.
699
- * @format GUID
700
- */
701
- ticketDefinitionId?: string;
702
- /** Ticket check-in. */
703
- checkIn?: CheckIn;
704
- /** Ticket price. */
705
- price?: Money;
706
- /** Whether ticket is archived. */
707
- archived?: boolean;
708
- /** Guest first name. */
709
- firstName?: string | null;
710
- /** Guest last name. */
711
- lastName?: string | null;
712
- /** Guest email. */
713
- email?: string | null;
714
- /**
715
- * Contact ID associated with this ticket.
716
- * @format GUID
717
- */
718
- contactId?: string | null;
719
- /** Whether ticket is confirmed */
720
- confirmed?: boolean;
721
- /**
722
- * Member ID associated with this ticket.
723
- * @format GUID
724
- */
725
- memberId?: string | null;
726
- /** Ticket form response (only assigned tickets contain separate forms). */
727
- form?: FormResponse;
728
- /** Ticket name. */
729
- ticketName?: string;
730
- /** Anonymized tickets no longer contain personally identifiable information (PII). */
731
- anonymized?: boolean;
732
- /** URL and password to online conference */
733
- onlineConferencingLogin?: OnlineConferencingLogin;
734
- /**
735
- * Seat ID associated with this ticket.
736
- * @maxLength 36
737
- */
738
- seatId?: string | null;
739
- /** Whether ticket is canceled. */
740
- canceled?: boolean | null;
741
- }
742
- export interface OnlineConferencingLogin {
743
- /**
744
- * Link URL to the online conference.
745
- * @format WEB_URL
746
- * @readonly
747
- */
748
- link?: string;
749
- /**
750
- * Password for the online conference.
751
- * @readonly
752
- */
753
- password?: string | null;
754
- }
755
- export interface ListOrdersRequest {
756
- /** Offset. */
757
- offset?: number;
758
- /**
759
- * Limit.
760
- * @max 400
761
- */
762
- limit?: number;
763
- /**
764
- * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
765
- * @maxSize 20
766
- */
767
- fieldset?: OrderFieldsetWithLiterals[];
768
- /** Status. */
769
- status?: OrderStatusWithLiterals[];
770
- /**
771
- * Event ID.
772
- * @format GUID
773
- * @maxSize 100
774
- */
775
- eventId?: string[];
776
- /**
777
- * Order number.
778
- * @maxLength 36
779
- * @maxSize 500
780
- */
781
- orderNumber?: string[];
782
- /**
783
- * Site member ID.
784
- * @format GUID
785
- * @maxSize 500
786
- */
787
- memberId?: string[];
788
- /**
789
- * Field facets.
790
- * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
791
- * @maxLength 100
792
- * @maxSize 20
793
- */
794
- facet?: string[];
795
- /**
796
- * Textual search filter - search is performed on "full_name", "email" and "order_number".
797
- * @maxLength 200
798
- */
799
- searchPhrase?: string;
800
- /**
801
- * Event creator ID.
802
- * @format GUID
803
- * @maxSize 50
804
- */
805
- eventCreatorId?: string[];
806
- /**
807
- * Sort order. Defaults to "created:asc".
808
- * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
809
- * @maxLength 100
810
- */
811
- sort?: string;
812
- /** Order tag. */
813
- tag?: OrderTagWithLiterals[];
814
- /**
815
- * Guest contact IDs.
816
- * @format GUID
817
- * @maxSize 100
818
- */
819
- contactId?: string[];
820
- }
821
- export declare enum OrderFieldset {
822
- /** Include tickets in response. */
823
- TICKETS = "TICKETS",
824
- /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
825
- DETAILS = "DETAILS",
826
- /** Include `checkoutForm` in the response. */
827
- FORM = "FORM",
828
- /** Include `invoice` in the response. */
829
- INVOICE = "INVOICE"
830
- }
831
- /** @enumType */
832
- export type OrderFieldsetWithLiterals = OrderFieldset | 'TICKETS' | 'DETAILS' | 'FORM' | 'INVOICE';
833
- export declare enum OrderTag {
834
- /** Return only confirmed orders. */
835
- CONFIRMED = "CONFIRMED",
836
- /** Return only unconfirmed orders. */
837
- UNCONFIRMED = "UNCONFIRMED",
838
- /** Return only member orders. */
839
- MEMBER = "MEMBER",
840
- /** Return only archived orders. */
841
- ARCHIVED = "ARCHIVED",
842
- /** Return only non archived orders. */
843
- NON_ARCHIVED = "NON_ARCHIVED",
844
- /** Return only orders with all guests checked-in. */
845
- FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
846
- /** Return only orders with no guests checked-in. */
847
- NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
848
- }
849
- /** @enumType */
850
- export type OrderTagWithLiterals = OrderTag | 'CONFIRMED' | 'UNCONFIRMED' | 'MEMBER' | 'ARCHIVED' | 'NON_ARCHIVED' | 'FULLY_CHECKED_IN' | 'NOT_FULLY_CHECKED_IN';
851
- export interface ListOrdersResponse {
852
- /** Total orders matching the given filters. */
853
- total?: number;
854
- /** Offset. */
855
- offset?: number;
856
- /**
857
- * Limit.
858
- * @max 100
859
- */
860
- limit?: number;
861
- /** Orders. */
862
- orders?: Order[];
863
- /** Filter facets. */
864
- facets?: Record<string, FacetCounts>;
865
- /** Order data enriched facets. */
866
- orderFacets?: OrderFacets;
867
- }
868
- export interface FacetCounts {
869
- /** Facet counts aggregated per value. */
870
- counts?: Record<string, number>;
871
- }
872
- export interface OrderFacets {
873
- /** Filter facets. */
874
- facets?: Record<string, OrderFacetCounts>;
875
- }
876
- export interface OrderFacetCounts {
877
- /** Facet counts aggregated per value */
878
- counts?: Record<string, Counts>;
879
- }
880
- export interface Counts {
881
- /** Number or orders */
882
- count?: number;
883
- /** Number of tickets within orders */
884
- tickets?: number;
885
- /** Number of tickets with check-in */
886
- ticketsCheckIn?: number;
887
- }
888
- export interface GetOrderRequest {
889
- /**
890
- * Event ID.
891
- * @format GUID
892
- */
893
- eventId: string;
894
- /**
895
- * Unique order number.
896
- * @maxLength 36
897
- */
898
- orderNumber: string;
899
- /**
900
- * Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
901
- * @maxSize 20
902
- */
903
- fieldset?: OrderFieldsetWithLiterals[];
904
- }
905
- export interface GetOrderResponse {
906
- /** Requested order. */
907
- order?: Order;
908
- /** "Add to calendar" links. */
909
- calendarLinks?: CalendarLinks;
910
- }
911
- export interface CalendarLinks {
912
- /** "Add to Google calendar" URL. */
913
- google?: string;
914
- /** "Download ICS calendar file" URL. */
915
- ics?: string;
916
- }
917
- export interface UpdateOrderRequest {
918
- /**
919
- * Event ID.
920
- * @format GUID
921
- */
922
- eventId: string;
923
- /**
924
- * Unique order number.
925
- * @maxLength 36
926
- */
927
- orderNumber: string;
928
- /** Set of field paths to update. */
929
- fields?: string[];
930
- /** Checkout form. */
931
- checkoutForm?: FormResponse;
932
- /** Whether order is archived. */
933
- archived?: boolean;
934
- }
935
- export interface UpdateOrderResponse {
936
- /** Updated order. */
937
- order?: Order;
938
- }
939
- export interface OrderUpdated {
940
- /** Order updated timestamp in ISO UTC format. */
941
- timestamp?: Date | null;
942
- /**
943
- * Site language when Order initiated
944
- * @format LANGUAGE
945
- */
946
- language?: string | null;
947
- /**
948
- * Locale in which Order was created.
949
- * @format LANGUAGE_TAG
950
- */
951
- locale?: string | null;
952
- /**
953
- * Event ID.
954
- * @format GUID
955
- */
956
- eventId?: string;
957
- /** Unique order number. */
958
- orderNumber?: string;
959
- /** Contact ID associated with this order. */
960
- contactId?: string;
961
- /**
962
- * Member ID associated with this order.
963
- * @format GUID
964
- */
965
- memberId?: string | null;
966
- /**
967
- * Order created timestamp.
968
- * @readonly
969
- */
970
- created?: Date | null;
971
- /**
972
- * Order updated timestamp.
973
- * @readonly
974
- */
975
- updated?: Date | null;
976
- /** Buyer first name. */
977
- firstName?: string;
978
- /** Buyer last name. */
979
- lastName?: string;
980
- /** Buyer email. */
981
- email?: string;
982
- /** Checkout form response. */
983
- checkoutForm?: FormResponse;
984
- /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
985
- confirmed?: boolean;
986
- /** Order status. */
987
- status?: OrderStatusWithLiterals;
988
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
989
- method?: string | null;
990
- /** Tickets generated after payment. */
991
- tickets?: Ticket[];
992
- /** Whether order was archived and excluded from results. */
993
- archived?: boolean;
994
- /** Whether event was triggered by GDPR delete request. */
995
- triggeredByAnonymizeRequest?: boolean;
996
- }
997
- export interface BulkUpdateOrdersRequest {
998
- /**
999
- * Event ID.
1000
- * @format GUID
1001
- */
1002
- eventId: string;
1003
- /**
1004
- * @minLength 1
1005
- * @maxLength 36
1006
- * @minSize 1
1007
- * @maxSize 100
1008
- */
1009
- orderNumber?: string[];
1010
- /** Set of fields to update. */
1011
- fields?: string[];
1012
- /** Whether to archive the order. */
1013
- archived?: boolean;
1014
- }
1015
- export interface BulkUpdateOrdersResponse {
1016
- /** Updated orders. */
1017
- orders?: Order[];
1018
- }
1019
- export interface ConfirmOrderRequest {
1020
- /**
1021
- * Event ID.
1022
- * @format GUID
1023
- */
1024
- eventId: string;
1025
- /**
1026
- * Order numbers.
1027
- * @minLength 1
1028
- * @maxLength 36
1029
- * @maxSize 100
1030
- */
1031
- orderNumber?: string[];
1032
- }
1033
- export interface ConfirmOrderResponse {
1034
- /** Confirmed orders. */
1035
- orders?: Order[];
1036
- }
1037
- export interface GetSummaryRequest {
1038
- /**
1039
- * Event ID.
1040
- * @format GUID
1041
- */
1042
- eventId?: string | null;
1043
- }
1044
- export interface GetSummaryResponse {
1045
- /** Ticket sales grouped by currency. */
1046
- sales?: TicketSales[];
1047
- }
1048
- export interface TicketSales {
1049
- /** Total balance of confirmed transactions. */
1050
- total?: Money;
1051
- /** Total number of confirmed orders. */
1052
- totalOrders?: number;
1053
- /** Total number of tickets purchased. */
1054
- totalTickets?: number;
1055
- /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
1056
- revenue?: Money;
1057
- }
1058
- export interface GetInvoicePreviewRequest {
1059
- /**
1060
- * Event ID.
1061
- * @format GUID
1062
- */
1063
- eventId?: string;
1064
- /** Order number. */
1065
- orderNumber?: string;
1066
- }
1067
- export interface RawHttpResponse {
1068
- body?: Uint8Array;
1069
- statusCode?: number | null;
1070
- headers?: HeadersEntry[];
1071
- }
1072
- export interface HeadersEntry {
1073
- key?: string;
1074
- value?: string;
1075
- }
1076
- export interface GetPaymentInfoRequest {
1077
- /**
1078
- * Event ID.
1079
- * @format GUID
1080
- */
1081
- eventId?: string;
1082
- /** Order number. */
1083
- orderNumber?: string;
1084
- }
1085
- export interface GetPaymentInfoResponse {
1086
- transactions?: PaymentTransactionSummary[];
1087
- status?: string | null;
1088
- /**
1089
- * @format GUID
1090
- * @readonly
1091
- */
1092
- transactionId?: string | null;
1093
- }
1094
- export interface PaymentTransactionSummary {
1095
- /**
1096
- * Wix Payments transaction id
1097
- * @format GUID
1098
- * @readonly
1099
- */
1100
- transactionId?: string;
1101
- /**
1102
- * Final transaction status
1103
- * @readonly
1104
- */
1105
- finalTransactionStatus?: string;
1106
- /** Transaction events */
1107
- events?: PaymentTransactionEvent[];
1108
- }
1109
- export interface PaymentTransactionEvent {
1110
- /**
1111
- * Order snapshot id
1112
- * @format GUID
1113
- * @readonly
1114
- */
1115
- snapshotId?: string;
1116
- /**
1117
- * Transaction status
1118
- * @readonly
1119
- */
1120
- transactionStatus?: string;
1121
- /**
1122
- * Transaction Payment method e.g., "payPal", "creditCard", etc.
1123
- * @readonly
1124
- */
1125
- paymentMethod?: string;
1126
- /**
1127
- * Transaction payment amount
1128
- * @readonly
1129
- */
1130
- paymentAmount?: Money;
1131
- /**
1132
- * Crated date
1133
- * @readonly
1134
- */
1135
- createdDate?: Date | null;
1136
- /**
1137
- * Reason code
1138
- * @readonly
1139
- */
1140
- reasonCode?: string | null;
1141
- /**
1142
- * Refunded amount
1143
- * @readonly
1144
- */
1145
- refundedAmount?: Money;
1146
- }
1147
- export interface CaptureAuthorizedPaymentRequest {
1148
- /**
1149
- * Event ID.
1150
- * @format GUID
1151
- */
1152
- eventId?: string;
1153
- /**
1154
- * Order number.
1155
- * @minLength 1
1156
- * @maxLength 36
1157
- */
1158
- orderNumber: string;
1159
- }
1160
- export interface CaptureAuthorizedPaymentResponse {
1161
- }
1162
- export interface VoidAuthorizedPaymentRequest {
1163
- /**
1164
- * Event ID.
1165
- * @format GUID
1166
- */
1167
- eventId?: string;
1168
- /**
1169
- * Order number.
1170
- * @minLength 1
1171
- * @maxLength 36
1172
- */
1173
- orderNumber: string;
1174
- }
1175
- export interface VoidAuthorizedPaymentResponse {
1176
- }
1177
- export interface MessageEnvelope {
1178
- /**
1179
- * App instance ID.
1180
- * @format GUID
1181
- */
1182
- instanceId?: string | null;
1183
- /**
1184
- * Event type.
1185
- * @maxLength 150
1186
- */
1187
- eventType?: string;
1188
- /** The identification type and identity data. */
1189
- identity?: IdentificationData;
1190
- /** Stringify payload. */
1191
- data?: string;
1192
- }
1193
- export interface IdentificationData extends IdentificationDataIdOneOf {
1194
- /**
1195
- * ID of a site visitor that has not logged in to the site.
1196
- * @format GUID
1197
- */
1198
- anonymousVisitorId?: string;
1199
- /**
1200
- * ID of a site visitor that has logged in to the site.
1201
- * @format GUID
1202
- */
1203
- memberId?: string;
1204
- /**
1205
- * ID of a Wix user (site owner, contributor, etc.).
1206
- * @format GUID
1207
- */
1208
- wixUserId?: string;
1209
- /**
1210
- * ID of an app.
1211
- * @format GUID
1212
- */
1213
- appId?: string;
1214
- /** @readonly */
1215
- identityType?: WebhookIdentityTypeWithLiterals;
1216
- }
1217
- /** @oneof */
1218
- export interface IdentificationDataIdOneOf {
1219
- /**
1220
- * ID of a site visitor that has not logged in to the site.
1221
- * @format GUID
1222
- */
1223
- anonymousVisitorId?: string;
1224
- /**
1225
- * ID of a site visitor that has logged in to the site.
1226
- * @format GUID
1227
- */
1228
- memberId?: string;
1229
- /**
1230
- * ID of a Wix user (site owner, contributor, etc.).
1231
- * @format GUID
1232
- */
1233
- wixUserId?: string;
1234
- /**
1235
- * ID of an app.
1236
- * @format GUID
1237
- */
1238
- appId?: string;
1239
- }
1240
- export declare enum WebhookIdentityType {
1241
- UNKNOWN = "UNKNOWN",
1242
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1243
- MEMBER = "MEMBER",
1244
- WIX_USER = "WIX_USER",
1245
- APP = "APP"
1246
- }
1247
- /** @enumType */
1248
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1249
- export interface OrderConfirmed {
1250
- /** Order confirmation timestamp in ISO UTC. */
1251
- timestamp?: Date | null;
1252
- /**
1253
- * Site language when Order initiated
1254
- * @format LANGUAGE
1255
- */
1256
- language?: string | null;
1257
- /** Notifications silenced for this domain event. */
1258
- silent?: boolean | null;
1259
- /**
1260
- * Locale in which Order was created.
1261
- * @format LANGUAGE_TAG
1262
- */
1263
- locale?: string | null;
1264
- /**
1265
- * Event ID.
1266
- * @format GUID
1267
- */
1268
- eventId?: string;
1269
- /** Unique order number. */
1270
- orderNumber?: string;
1271
- /** Contact ID associated with this order. */
1272
- contactId?: string;
1273
- /**
1274
- * Member ID associated with this order.
1275
- * @format GUID
1276
- */
1277
- memberId?: string | null;
1278
- /**
1279
- * Order created timestamp
1280
- * @readonly
1281
- */
1282
- created?: Date | null;
1283
- /** Buyer first name. */
1284
- firstName?: string;
1285
- /** Buyer last name. */
1286
- lastName?: string;
1287
- /** Buyer email address. */
1288
- email?: string;
1289
- /** Checkout form response. */
1290
- checkoutForm?: FormResponse;
1291
- /** Order status. */
1292
- status?: OrderStatusWithLiterals;
1293
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1294
- method?: string | null;
1295
- /** Tickets (generated after payment). */
1296
- tickets?: Ticket[];
1297
- /** Invoice. */
1298
- invoice?: Invoice;
1299
- /** Reservation ID associated with this order. */
1300
- reservationId?: string;
1301
- }
1302
- export interface OrderPaid {
1303
- /** Order paid timestamp in ISO UTC. */
1304
- timestamp?: Date | null;
1305
- /**
1306
- * Site language when Order initiated
1307
- * @format LANGUAGE
1308
- */
1309
- language?: string | null;
1310
- /** Notifications silenced for this domain event. */
1311
- silent?: boolean | null;
1312
- /**
1313
- * Locale in which Order was created.
1314
- * @format LANGUAGE_TAG
1315
- */
1316
- locale?: string | null;
1317
- /**
1318
- * Event ID.
1319
- * @format GUID
1320
- */
1321
- eventId?: string;
1322
- /** Unique order number. */
1323
- orderNumber?: string;
1324
- /** Reservation ID associated with this order. */
1325
- reservationId?: string;
1326
- /**
1327
- * Contact ID associated with this order.
1328
- * @maxLength 36
1329
- */
1330
- contactId?: string;
1331
- /**
1332
- * Member ID associated with this order.
1333
- * @format GUID
1334
- */
1335
- memberId?: string | null;
1336
- /**
1337
- * Order created timestamp
1338
- * @readonly
1339
- */
1340
- created?: Date | null;
1341
- /**
1342
- * Buyer first name.
1343
- * @maxLength 255
1344
- */
1345
- firstName?: string;
1346
- /**
1347
- * Buyer last name.
1348
- * @maxLength 255
1349
- */
1350
- lastName?: string;
1351
- /**
1352
- * Buyer email address.
1353
- * @maxLength 255
1354
- */
1355
- email?: string;
1356
- /** Checkout form response. */
1357
- checkoutForm?: FormResponse;
1358
- /** Order status. */
1359
- status?: OrderStatusWithLiterals;
1360
- /**
1361
- * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1362
- * @maxLength 255
1363
- */
1364
- method?: string | null;
1365
- /**
1366
- * Tickets (generated after payment).
1367
- * @maxSize 50
1368
- */
1369
- tickets?: Ticket[];
1370
- /** Invoice. */
1371
- invoice?: Invoice;
1372
- }
1373
- export interface ReservationCreated {
1374
- /** Reservation created timestamp in ISO UTC format. */
1375
- timestamp?: Date | null;
1376
- /**
1377
- * Event ID.
1378
- * @format GUID
1379
- */
1380
- eventId?: string;
1381
- /**
1382
- * Reservation ID.
1383
- * Can be used to retrieve a reservation invoice.
1384
- * @format GUID
1385
- */
1386
- reservationId?: string;
1387
- /** Reservation expiration timestamp. */
1388
- expires?: Date | null;
1389
- /** Reservation status. */
1390
- status?: ReservationStatusWithLiterals;
1391
- /**
1392
- * Reservation ticket quantities.
1393
- * @maxSize 50
1394
- */
1395
- quantities?: TicketQuantity[];
1396
- /** Reservation update timestamp. */
1397
- updatedDate?: Date | null;
1398
- /**
1399
- * Reservation counts.
1400
- * @maxSize 50
1401
- */
1402
- counts?: ReservationCount[];
1403
- }
1404
- export declare enum ReservationStatus {
1405
- /** The Reservation is pending confirmation and will expire after the expiration due time. */
1406
- RESERVATION_PENDING = "RESERVATION_PENDING",
1407
- /** The reservation is confirmed and will not expire. */
1408
- RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
1409
- /** The reservation is canceled because of non payment. */
1410
- RESERVATION_CANCELED = "RESERVATION_CANCELED",
1411
- /** The reservation is canceled manually by the buyer. */
1412
- RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
1413
- /** The reservation is expired. */
1414
- RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
1415
- }
1416
- /** @enumType */
1417
- export type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
1418
- export interface TicketQuantity {
1419
- /**
1420
- * Ticket definition ID.
1421
- * @format GUID
1422
- */
1423
- ticketDefinitionId?: string | null;
1424
- /** Quantity. */
1425
- quantity?: number | null;
1426
- /** Quantity update timestamp. */
1427
- updatedDate?: Date | null;
1428
- }
1429
- export interface ReservationCount {
1430
- /** Reservation Count snapshot timestamp. */
1431
- timestamp?: Date | null;
1432
- /**
1433
- * Ticket Definition ID.
1434
- * @format GUID
1435
- */
1436
- ticketDefinitionId?: string;
1437
- /** Confirmed reservation count. */
1438
- confirmedCount?: number;
1439
- /** Pending reservation count. */
1440
- pendingCount?: number;
1441
- /** True if paid ticket reservation exist. */
1442
- paidExists?: boolean;
1443
- }
1444
- export interface ReservationUpdated {
1445
- /** Reservation updated timestamp. */
1446
- timestamp?: Date | null;
1447
- /**
1448
- * Event ID.
1449
- * @format GUID
1450
- */
1451
- eventId?: string;
1452
- /**
1453
- * Reservation ID.
1454
- * Can be used to retrieve a reservation invoice.
1455
- * @format GUID
1456
- */
1457
- reservationId?: string;
1458
- /** Reservation status. */
1459
- status?: ReservationStatusWithLiterals;
1460
- /** Reservation expiration timestamp. */
1461
- expires?: Date | null;
1462
- /**
1463
- * Reservation ticket quantities.
1464
- * @maxSize 50
1465
- */
1466
- quantities?: TicketQuantity[];
1467
- /** Reservation update timestamp. */
1468
- updatedDate?: Date | null;
1469
- /**
1470
- * Reservation counts.
1471
- * @maxSize 50
1472
- */
1473
- counts?: ReservationCount[];
1474
- }
1475
- export interface GetCheckoutOptionsRequest {
1476
- }
1477
- export interface GetCheckoutOptionsResponse {
1478
- /** Whether any payment method is configured and available for payment. */
1479
- paymentMethodConfigured?: boolean;
1480
- /** Whether coupons are accepted at checkout. */
1481
- acceptCoupons?: boolean;
1482
- /** 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". */
1483
- premiumServices?: boolean;
1484
- /** Whether there are any paid tickets available for sale. */
1485
- paidTickets?: boolean;
1486
- /** Whether gift cards are accepted at checkout. */
1487
- acceptGiftCards?: boolean;
1488
- }
1489
- export interface ListAvailableTicketsRequest {
1490
- /**
1491
- * Event ID. If not provided, available tickets for all events in the site will be returned.
1492
- * @format GUID
1493
- */
1494
- eventId?: string;
1495
- /** Offset. */
1496
- offset?: number;
1497
- /**
1498
- * Limit.
1499
- * @max 100
1500
- */
1501
- limit?: number;
1502
- /**
1503
- * Sort order, defaults to "created:asc".
1504
- * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1505
- * @maxLength 100
1506
- */
1507
- sort?: string;
1508
- state?: StateWithLiterals[];
1509
- }
1510
- export declare enum State {
1511
- INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
1512
- }
1513
- /** @enumType */
1514
- export type StateWithLiterals = State | 'INCLUDE_HIDDEN_NOT_ON_SALE';
1515
- export interface ListAvailableTicketsResponse {
1516
- /** Ticket definitions meta data. */
1517
- metaData?: ResponseMetaData;
1518
- /** Ticket definitions. */
1519
- definitions?: TicketDefinition[];
1520
- }
1521
- export interface ResponseMetaData {
1522
- /** Number of items in the response. */
1523
- count?: number;
1524
- /** Offset of items. */
1525
- offset?: number;
1526
- /** Total number of matching items. */
1527
- total?: number;
1528
- }
1529
- export interface TicketDefinition {
1530
- /**
1531
- * Ticket definition ID.
1532
- * @format GUID
1533
- */
1534
- id?: string;
1535
- /** Ticket price. */
1536
- price?: Money;
1537
- /** Whether the ticket is free (read only). */
1538
- free?: boolean;
1539
- /** Ticket name. */
1540
- name?: string;
1541
- /** Ticket description. */
1542
- description?: string;
1543
- /**
1544
- * Limit of tickets that can be purchased per checkout.
1545
- * Set to 20 for unlimited ticket definition.
1546
- * @max 20
1547
- */
1548
- limitPerCheckout?: number;
1549
- /** Custom sort index. */
1550
- orderIndex?: number;
1551
- /** Policy information plain text block, as printed on the ticket. */
1552
- policy?: string;
1553
- /** Sensitive dashboard data. */
1554
- dashboard?: Dashboard;
1555
- /**
1556
- * Event ID associated with the ticket.
1557
- * @format GUID
1558
- */
1559
- eventId?: string;
1560
- /**
1561
- * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
1562
- * @readonly
1563
- */
1564
- wixFeeConfig?: WixFeeConfig;
1565
- /** Ticket sale period. */
1566
- salePeriod?: TicketSalePeriod;
1567
- /**
1568
- * Ticket sale status.
1569
- * @readonly
1570
- */
1571
- saleStatus?: TicketSaleStatusWithLiterals;
1572
- /** Ticket state. */
1573
- state?: StateWithLiterals[];
1574
- /** Ticket pricing. */
1575
- pricing?: TicketPricing;
1576
- }
1577
- export interface Dashboard {
1578
- /** Whether ticket is hidden and cannot be sold. */
1579
- hidden?: boolean;
1580
- /**
1581
- * Number of tickets sold and reserved.
1582
- * @deprecated
1583
- */
1584
- sold?: number;
1585
- /** Whether the ticket has limited quantity. */
1586
- limited?: boolean;
1587
- /** Ticket limit. `NULL` for unlimited ticket definitions. */
1588
- quantity?: number | null;
1589
- /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
1590
- unsold?: number | null;
1591
- /** Number of tickets sold. */
1592
- ticketsSold?: number;
1593
- /** Number of tickets reserved. */
1594
- ticketsReserved?: number;
1595
- }
1596
- export interface WixFeeConfig {
1597
- /** Fee calculation method. */
1598
- type?: FeeTypeWithLiterals;
1599
- }
1600
- export interface TicketSalePeriod {
1601
- /** Ticket sale start timestamp. */
1602
- startDate?: Date | null;
1603
- /** Ticket sale end timestamp. */
1604
- endDate?: Date | null;
1605
- /** Whether to hide this ticket if it's not on sale */
1606
- hideNotOnSale?: boolean;
1607
- }
1608
- export declare enum TicketSaleStatus {
1609
- /** Ticket sale is scheduled to start. */
1610
- SALE_SCHEDULED = "SALE_SCHEDULED",
1611
- /** Ticket sale has started. */
1612
- SALE_STARTED = "SALE_STARTED",
1613
- /** Ticket sale has ended. */
1614
- SALE_ENDED = "SALE_ENDED"
1615
- }
1616
- /** @enumType */
1617
- export type TicketSaleStatusWithLiterals = TicketSaleStatus | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
1618
- export interface TicketPricing extends TicketPricingPriceOneOf {
1619
- /** Ticket price which is read only. */
1620
- fixedPrice?: Money;
1621
- /** Min price per ticket, customizable. */
1622
- minPrice?: Money;
1623
- /** Ticket pricing options. */
1624
- pricingOptions?: PricingOptions;
1625
- /**
1626
- * Ticket pricing type.
1627
- * @readonly
1628
- */
1629
- pricingType?: TypeWithLiterals;
1630
- }
1631
- /** @oneof */
1632
- export interface TicketPricingPriceOneOf {
1633
- /** Ticket price which is read only. */
1634
- fixedPrice?: Money;
1635
- /** Min price per ticket, customizable. */
1636
- minPrice?: Money;
1637
- /** Ticket pricing options. */
1638
- pricingOptions?: PricingOptions;
1639
- }
1640
- export interface PricingOptions {
1641
- /** Multiple ticket pricing options. */
1642
- options?: PricingOption[];
1643
- }
1644
- export interface PricingOption {
1645
- /**
1646
- * Ticket pricing option ID.
1647
- * @format GUID
1648
- */
1649
- id?: string | null;
1650
- /**
1651
- * Ticket pricing option name.
1652
- * @minLength 1
1653
- * @maxLength 200
1654
- */
1655
- name?: string | null;
1656
- /** Ticket pricing option price. */
1657
- price?: Money;
1658
- }
1659
- export declare enum Type {
1660
- STANDARD = "STANDARD",
1661
- DONATION = "DONATION"
1662
- }
1663
- /** @enumType */
1664
- export type TypeWithLiterals = Type | 'STANDARD' | 'DONATION';
1665
- export interface QueryAvailableTicketsRequest {
1666
- /** Offset. */
1667
- offset?: number;
1668
- /**
1669
- * Limit.
1670
- * @max 1000
1671
- */
1672
- limit?: number;
1673
- /**
1674
- * Ticket definition.
1675
- * See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1676
- */
1677
- filter?: Record<string, any> | null;
1678
- /** @maxSize 20 */
1679
- fieldset?: TicketDefinitionFieldsetWithLiterals[];
1680
- /**
1681
- * Sort order, defaults to "created:asc".
1682
- * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
1683
- * @maxLength 100
1684
- */
1685
- sort?: string;
1686
- }
1687
- export declare enum TicketDefinitionFieldset {
1688
- /** Include `policy` in the response. */
1689
- POLICY = "POLICY",
1690
- /** Include `dashboard` in the response. */
1691
- DASHBOARD = "DASHBOARD"
1692
- }
1693
- /** @enumType */
1694
- export type TicketDefinitionFieldsetWithLiterals = TicketDefinitionFieldset | 'POLICY' | 'DASHBOARD';
1695
- export interface QueryAvailableTicketsResponse {
1696
- /** Ticket definitions meta data. */
1697
- metaData?: ResponseMetaData;
1698
- /** Ticket definitions. */
1699
- definitions?: TicketDefinition[];
1700
- }
1701
- export interface CreateReservationRequest {
1702
- /**
1703
- * Event ID.
1704
- * @format GUID
1705
- */
1706
- eventId: string;
1707
- /**
1708
- * Tickets to reserve.
1709
- * @minSize 1
1710
- * @maxSize 50
1711
- */
1712
- ticketQuantities?: TicketReservationQuantity[];
1713
- /** Whether to ignore the available ticket limits upon reservation. */
1714
- ignoreLimits?: boolean;
1715
- /** Whether to allow reservation for hidden tickets. */
1716
- allowHiddenTickets?: boolean;
1717
- }
1718
- export interface TicketReservationQuantity {
1719
- /**
1720
- * Ticket definition ID.
1721
- * @format GUID
1722
- */
1723
- ticketDefinitionId?: string;
1724
- /**
1725
- * Quantity of tickets to reserve.
1726
- * @min 1
1727
- * @max 50
1728
- */
1729
- quantity?: number;
1730
- /**
1731
- * Ticket price to charge - overriding the ticket price.
1732
- * @maxLength 13
1733
- * @format DECIMAL_VALUE
1734
- */
1735
- priceOverride?: string | null;
1736
- /** Optional ticket details */
1737
- ticketDetails?: TicketDetails[];
1738
- }
1739
- export interface CreateReservationResponse {
1740
- /**
1741
- * Reservation ID.
1742
- * @format GUID
1743
- */
1744
- id?: string;
1745
- /** Reservation expiration timestamp. */
1746
- expires?: Date | null;
1747
- /** Ticket reservations. */
1748
- reservations?: TicketReservation[];
1749
- /** Reservation invoice. */
1750
- invoice?: Invoice;
1751
- /** Reservation status. */
1752
- reservationStatus?: ReservationStatusWithLiterals;
1753
- }
1754
- export interface TicketReservation {
1755
- /**
1756
- * Quantity of reserved tickets.
1757
- * @min 1
1758
- * @max 20
1759
- */
1760
- quantity?: number;
1761
- ticket?: TicketDefinition;
1762
- /** Optional ticket details. */
1763
- ticketDetails?: TicketDetails[];
1764
- }
1765
- export interface CancelReservationRequest {
1766
- /**
1767
- * Event ID.
1768
- * @format GUID
1769
- */
1770
- eventId: string;
1771
- /**
1772
- * Reservation ID.
1773
- * @format GUID
1774
- */
1775
- id: string;
1776
- }
1777
- export interface CancelReservationResponse {
1778
- }
1779
- export interface GetInvoiceRequest {
1780
- /**
1781
- * Event ID.
1782
- * @format GUID
1783
- */
1784
- eventId: string;
1785
- /**
1786
- * Reservation ID.
1787
- * @format GUID
1788
- */
1789
- reservationId: string;
1790
- /** Optional discount to be applied on the returned invoice. */
1791
- withDiscount?: DiscountRequest;
1792
- /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1793
- paidPlanBenefit?: PaidPlanBenefit;
1794
- }
1795
- export interface DiscountRequest {
1796
- /**
1797
- * Discount coupon code.
1798
- * @maxLength 20
1799
- */
1800
- couponCode?: string;
1801
- }
1802
- export interface PaidPlanBenefit {
1803
- /**
1804
- * Pricing plan ID.
1805
- * @format GUID
1806
- */
1807
- planOrderId?: string;
1808
- /**
1809
- * Pricing plan benefit ID.
1810
- * @format GUID
1811
- */
1812
- benefitId?: string;
1813
- }
1814
- export interface GetInvoiceResponse {
1815
- /** Invoice with applied discount. */
1816
- invoice?: Invoice;
1817
- /** Discount errors, if relevant. */
1818
- discountErrors?: DiscountErrors;
1819
- /** Time when the reservation expires. */
1820
- expires?: Date | null;
1821
- /** Reservation status. */
1822
- reservationStatus?: ReservationStatusWithLiterals;
1823
- /** Whether this reservation is already used in checkout. */
1824
- reservationOccupied?: boolean;
1825
- /** Ticket reservations. */
1826
- reservations?: TicketReservation[];
1827
- }
1828
- export interface DiscountErrors {
1829
- /** Error. */
1830
- error?: Error[];
1831
- }
1832
- export interface Error {
1833
- code?: string;
1834
- }
1835
- export interface GiftCardErrors {
1836
- /**
1837
- * Error.
1838
- * @maxSize 10
1839
- */
1840
- error?: GiftCardErrorsError[];
1841
- }
1842
- export interface GiftCardErrorsError {
1843
- /** @maxLength 100 */
1844
- code?: string;
1845
- }
1846
- export interface CheckoutRequest {
1847
- /**
1848
- * Event ID.
1849
- * @format GUID
1850
- */
1851
- eventId: string;
1852
- /**
1853
- * Ticket reservation ID.
1854
- * @format GUID
1855
- */
1856
- reservationId?: string;
1857
- /** Member ID (if empty - no site member is associated to this order). */
1858
- memberId?: string;
1859
- /** Discount to apply on the invoice. */
1860
- discount?: DiscountRequest;
1861
- /** Buyer details. */
1862
- buyer?: Buyer;
1863
- /**
1864
- * Guest details.
1865
- * @minSize 1
1866
- * @maxSize 50
1867
- */
1868
- guests?: Guest[];
1869
- /** Benefit granted by the pricing plan. */
1870
- paidPlanBenefit?: PaidPlanBenefit;
1871
- /** Options controlling the checkout process. */
1872
- options?: CheckoutOptions;
1873
- /** Whether marketing consent was given */
1874
- marketingConsent?: boolean | null;
1875
- }
1876
- export interface Buyer {
1877
- /**
1878
- * Buyer first name.
1879
- * @minLength 1
1880
- * @maxLength 50
1881
- */
1882
- firstName?: string;
1883
- /**
1884
- * Buyer last name.
1885
- * @minLength 1
1886
- * @maxLength 50
1887
- */
1888
- lastName?: string;
1889
- /**
1890
- * Buyer email.
1891
- * @format EMAIL
1892
- * @minLength 5
1893
- * @maxLength 255
1894
- */
1895
- email?: string;
1896
- }
1897
- export interface Guest {
1898
- /** Specific guest info. */
1899
- form?: FormResponse;
1900
- }
1901
- export interface CheckoutOptions {
1902
- /** Whether to ignore settings to notify contacts or users. */
1903
- silent?: boolean;
1904
- /** 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. */
1905
- payInPerson?: boolean;
1906
- /** Whether to ignore form validation. */
1907
- ignoreFormValidation?: boolean;
1908
- /** Marks payment as already paid */
1909
- markAsPaid?: boolean | null;
1910
- }
1911
- export interface CheckoutResponse {
1912
- /** Created order. */
1913
- order?: Order;
1914
- /** Time when the order expires, applies to orders with status = INITIATED. */
1915
- expires?: Date | null;
1916
- /** Ticket reservations. */
1917
- reservations?: TicketReservation[];
1918
- /** Order page url. */
1919
- orderPageUrl?: string | null;
1920
- }
1921
- export interface OrderInitiated {
1922
- /** Order initiated timestamp in ISO UTC format. */
1923
- timestamp?: Date | null;
1924
- /**
1925
- * Site language when Order initiated
1926
- * @format LANGUAGE
1927
- */
1928
- language?: string | null;
1929
- /**
1930
- * Locale in which Order was created.
1931
- * @format LANGUAGE_TAG
1932
- */
1933
- locale?: string | null;
1934
- /**
1935
- * Event ID.
1936
- * @format GUID
1937
- */
1938
- eventId?: string;
1939
- /** Unique order number. */
1940
- orderNumber?: string;
1941
- /** Contact ID associated with this order. */
1942
- contactId?: string;
1943
- /**
1944
- * Member ID associated with this order.
1945
- * @format GUID
1946
- */
1947
- memberId?: string | null;
1948
- /**
1949
- * Order created timestamp.
1950
- * @readonly
1951
- */
1952
- created?: Date | null;
1953
- /**
1954
- * Order updated timestamp.
1955
- * @readonly
1956
- */
1957
- updated?: Date | null;
1958
- /** Guest first name. */
1959
- firstName?: string;
1960
- /** Guest last name. */
1961
- lastName?: string;
1962
- /** Guest email address. */
1963
- email?: string;
1964
- /** Checkout form response. */
1965
- checkoutForm?: FormResponse;
1966
- /** Order status. */
1967
- status?: OrderStatusWithLiterals;
1968
- /** Invoice. */
1969
- invoice?: Invoice;
1970
- /** Reservation ID associated with this order. */
1971
- reservationId?: string;
1972
- /** Order was marked as paid. */
1973
- markedAsPaid?: boolean | null;
1974
- }
1975
- export interface UpdateCheckoutRequest {
1976
- /**
1977
- * Event ID.
1978
- * @format GUID
1979
- */
1980
- eventId: string;
1981
- /**
1982
- * Unique order number.
1983
- * @maxLength 36
1984
- */
1985
- orderNumber: string;
1986
- /** Buyer details. */
1987
- buyer?: Buyer;
1988
- /**
1989
- * Guest details.
1990
- * @minSize 1
1991
- * @maxSize 20
1992
- */
1993
- guests?: Guest[];
1994
- /** Member ID (if empty - no site member is associated to this order). */
1995
- memberId?: string | null;
1996
- /** Discount to apply on the invoice. */
1997
- discount?: DiscountRequest;
1998
- /** Benefit granted by the pricing plan. */
1999
- paidPlanBenefit?: PaidPlanBenefit;
2000
- }
2001
- export interface UpdateCheckoutResponse {
2002
- /** Updated order. */
2003
- order?: Order;
2004
- /** Order page url. */
2005
- orderPageUrl?: string | null;
2006
- }
2007
- export interface OrderPageUrls {
2008
- /**
2009
- * Success order page url.
2010
- * @format WEB_URL
2011
- */
2012
- success?: string | null;
2013
- /**
2014
- * Pending order page url.
2015
- * @format WEB_URL
2016
- */
2017
- pending?: string | null;
2018
- /**
2019
- * Canceled order page url.
2020
- * @format WEB_URL
2021
- */
2022
- canceled?: string | null;
2023
- /**
2024
- * Error order page url.
2025
- * @format WEB_URL
2026
- */
2027
- error?: string | null;
2028
- }
2029
- export interface PosCheckoutRequest {
2030
- /**
2031
- * Event ID.
2032
- * @format GUID
2033
- */
2034
- eventId: string;
2035
- /**
2036
- * Ticket reservation ID.
2037
- * @format GUID
2038
- */
2039
- reservationId: string;
2040
- /**
2041
- * Payment details ID.
2042
- * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
2043
- * @format GUID
2044
- */
2045
- paymentDetailsId?: string | null;
2046
- }
2047
- export interface PosCheckoutResponse {
2048
- /** Created order. */
2049
- order?: Order;
2050
- /** Time when the order expires, applies to orders with status = INITIATED. */
2051
- expires?: Date | null;
2052
- /** Ticket reservations. */
2053
- reservations?: TicketReservation[];
2054
- }
2055
- export interface GetReservationRequest {
2056
- /**
2057
- * Event ID.
2058
- * @format GUID
2059
- */
2060
- eventId?: string | null;
2061
- /**
2062
- * Ticket reservation ID.
2063
- * @format GUID
2064
- */
2065
- reservationId?: string | null;
2066
- }
2067
- export interface GetReservationResponse {
2068
- /** Date and time the Ticket Reservation was created. */
2069
- createdDate?: Date | null;
2070
- /** Date and time the Ticket Reservation was last updated. */
2071
- updatedDate?: Date | null;
2072
- /** Date and time the Pending TicketReservation will expire. */
2073
- expirationDate?: Date | null;
2074
- /** Reservation status. */
2075
- reservationStatus?: ReservationStatusWithLiterals;
2076
- /** Ticket reservations. */
2077
- reservations?: TicketReservation[];
2078
- }