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