@wix/auto_sdk_events_notifications 1.0.74 → 1.0.76
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/cjs/index.d.ts +9 -9
- package/build/cjs/index.js +98 -98
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +973 -973
- package/build/cjs/index.typings.js +90 -90
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +935 -935
- package/build/cjs/meta.js +76 -76
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +975 -0
- package/build/cjs/schemas.js +1256 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.d.mts +9 -9
- package/build/es/index.mjs +98 -98
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +973 -973
- package/build/es/index.typings.mjs +90 -90
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +935 -935
- package/build/es/meta.mjs +76 -76
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +975 -0
- package/build/es/schemas.mjs +1214 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +9 -9
- package/build/internal/cjs/index.js +98 -98
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +973 -973
- package/build/internal/cjs/index.typings.js +90 -90
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +935 -935
- package/build/internal/cjs/meta.js +76 -76
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +975 -0
- package/build/internal/cjs/schemas.js +1256 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.d.mts +9 -9
- package/build/internal/es/index.mjs +98 -98
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +973 -973
- package/build/internal/es/index.typings.mjs +90 -90
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +935 -935
- package/build/internal/es/meta.mjs +76 -76
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +975 -0
- package/build/internal/es/schemas.mjs +1214 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/package.json +12 -5
- package/schemas/package.json +3 -0
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ResolveNotificationConfigRequest as ResolveNotificationConfigRequest$1, ResolveNotificationConfigResponse as ResolveNotificationConfigResponse$1, UpsertNotificationConfigRequest as UpsertNotificationConfigRequest$1, UpsertNotificationConfigResponse as UpsertNotificationConfigResponse$1, TriggerNotificationRequest as TriggerNotificationRequest$1, TriggerNotificationResponse as TriggerNotificationResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface NotificationConfig {
|
|
@@ -121,308 +121,228 @@ declare enum EmailNotificationReminderTime {
|
|
|
121
121
|
}
|
|
122
122
|
/** @enumType */
|
|
123
123
|
type EmailNotificationReminderTimeWithLiterals = EmailNotificationReminderTime | 'INSTANT' | 'BEFORE_1_DAY' | 'BEFORE_3_DAYS' | 'BEFORE_1_WEEK' | 'BEFORE_1_HOUR' | 'BEFORE_30_MINUTES';
|
|
124
|
-
interface
|
|
125
|
-
/**
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
rsvpGuest?: RsvpGuest;
|
|
131
|
-
/** Order guest info */
|
|
132
|
-
orderGuest?: OrderGuest;
|
|
133
|
-
/** Event guests info */
|
|
134
|
-
eventGuests?: EventGuests;
|
|
135
|
-
/** Ticket guests info */
|
|
136
|
-
ticketGuest?: TicketGuest;
|
|
124
|
+
interface ResolveNotificationConfigRequest {
|
|
125
|
+
/**
|
|
126
|
+
* Id of the NotificationConfig to retrieve
|
|
127
|
+
* @format GUID
|
|
128
|
+
*/
|
|
129
|
+
notificationConfigId: string;
|
|
137
130
|
}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
142
|
-
/** Push notification type */
|
|
143
|
-
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
131
|
+
interface ResolveNotificationConfigResponse {
|
|
132
|
+
/** The retrieved NotificationConfig */
|
|
133
|
+
notificationConfig?: NotificationConfig;
|
|
144
134
|
}
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
rsvpGuest?: RsvpGuest;
|
|
149
|
-
/** Order guest info */
|
|
150
|
-
orderGuest?: OrderGuest;
|
|
151
|
-
/** Event guests info */
|
|
152
|
-
eventGuests?: EventGuests;
|
|
153
|
-
/** Ticket guests info */
|
|
154
|
-
ticketGuest?: TicketGuest;
|
|
135
|
+
interface UpsertNotificationConfigRequest {
|
|
136
|
+
/** NotificationConfig to be upserted */
|
|
137
|
+
notificationConfig: NotificationConfig;
|
|
155
138
|
}
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
|
|
159
|
-
/** Triggered when event is canceled. */
|
|
160
|
-
PUSH_EVENT_CANCELATION = "PUSH_EVENT_CANCELATION",
|
|
161
|
-
/** Triggered before the event start time. */
|
|
162
|
-
PUSH_UPCOMING_EVENT_REMINDER = "PUSH_UPCOMING_EVENT_REMINDER",
|
|
163
|
-
/** Triggered when event is created. */
|
|
164
|
-
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
139
|
+
interface UpsertNotificationConfigResponse {
|
|
140
|
+
/** The upserted NotificationConfig */
|
|
141
|
+
notificationConfig?: NotificationConfig;
|
|
165
142
|
}
|
|
166
|
-
|
|
167
|
-
type PushNotificationTypeWithLiterals = PushNotificationType | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
168
|
-
/** Single guest associated to the RSVP */
|
|
169
|
-
interface RsvpGuest {
|
|
143
|
+
interface ResolveEmailNotificationConfigRequest {
|
|
170
144
|
/**
|
|
171
|
-
*
|
|
145
|
+
* Id of the NotificationConfig to retrieve
|
|
146
|
+
* @format GUID
|
|
147
|
+
*/
|
|
148
|
+
notificationConfigId?: string;
|
|
149
|
+
/** Notification type */
|
|
150
|
+
notificationType?: EmailNotificationTypeWithLiterals;
|
|
151
|
+
}
|
|
152
|
+
interface ResolveEmailNotificationConfigResponse {
|
|
153
|
+
/** The retrieved EmailNotificationConfig */
|
|
154
|
+
emailNotificationConfig?: EmailNotificationConfig;
|
|
155
|
+
}
|
|
156
|
+
interface EventCanceled {
|
|
157
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
158
|
+
timestamp?: Date | null;
|
|
159
|
+
/**
|
|
160
|
+
* Event ID.
|
|
172
161
|
* @format GUID
|
|
173
162
|
*/
|
|
174
163
|
eventId?: string;
|
|
164
|
+
/** Event title */
|
|
165
|
+
title?: string;
|
|
175
166
|
/**
|
|
176
|
-
*
|
|
167
|
+
* Event creator user ID.
|
|
177
168
|
* @format GUID
|
|
178
169
|
*/
|
|
179
|
-
|
|
170
|
+
userId?: string | null;
|
|
171
|
+
/** True if at least one guest is registered to the event with any attendance status. */
|
|
172
|
+
hasGuests?: boolean | null;
|
|
180
173
|
}
|
|
181
|
-
|
|
182
|
-
|
|
174
|
+
interface Empty {
|
|
175
|
+
}
|
|
176
|
+
interface EventDeleted {
|
|
177
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
178
|
+
timestamp?: Date | null;
|
|
183
179
|
/**
|
|
184
|
-
* Event
|
|
180
|
+
* Event ID.
|
|
185
181
|
* @format GUID
|
|
186
182
|
*/
|
|
187
183
|
eventId?: string;
|
|
184
|
+
/** Event title. */
|
|
185
|
+
title?: string;
|
|
188
186
|
/**
|
|
189
|
-
*
|
|
190
|
-
* @
|
|
187
|
+
* Event creator user ID.
|
|
188
|
+
* @format GUID
|
|
191
189
|
*/
|
|
192
|
-
|
|
190
|
+
userId?: string | null;
|
|
193
191
|
}
|
|
194
|
-
|
|
195
|
-
|
|
192
|
+
interface EventCopied {
|
|
193
|
+
/** Event created timestamp in ISO UTC format. */
|
|
194
|
+
timestamp?: Date | null;
|
|
196
195
|
/**
|
|
197
|
-
* Event
|
|
196
|
+
* Event ID.
|
|
198
197
|
* @format GUID
|
|
199
198
|
*/
|
|
200
199
|
eventId?: string;
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
200
|
+
/** Event location. */
|
|
201
|
+
location?: Location;
|
|
202
|
+
/** Event schedule configuration. */
|
|
203
|
+
scheduleConfig?: ScheduleConfig;
|
|
204
|
+
/** Event title. */
|
|
205
|
+
title?: string;
|
|
204
206
|
/**
|
|
205
|
-
* Event
|
|
207
|
+
* Event creator user ID.
|
|
206
208
|
* @format GUID
|
|
207
209
|
*/
|
|
208
|
-
|
|
210
|
+
userId?: string | null;
|
|
211
|
+
/** Event status. */
|
|
212
|
+
status?: EventStatusWithLiterals;
|
|
209
213
|
/**
|
|
210
|
-
*
|
|
211
|
-
* @
|
|
214
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
215
|
+
* @format GUID
|
|
212
216
|
*/
|
|
213
|
-
|
|
217
|
+
derivedFromInstanceId?: string | null;
|
|
214
218
|
/**
|
|
215
|
-
*
|
|
216
|
-
* @
|
|
217
|
-
* @maxSize 100
|
|
218
|
-
* @maxLength 36
|
|
219
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
220
|
+
* @format GUID
|
|
219
221
|
*/
|
|
220
|
-
|
|
221
|
-
}
|
|
222
|
-
interface TriggerNotificationResponse {
|
|
223
|
-
}
|
|
224
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
225
|
-
createdEvent?: EntityCreatedEvent;
|
|
226
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
227
|
-
deletedEvent?: EntityDeletedEvent;
|
|
228
|
-
actionEvent?: ActionEvent;
|
|
229
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
230
|
-
id?: string;
|
|
222
|
+
derivedFromEventId?: string | null;
|
|
231
223
|
/**
|
|
232
|
-
*
|
|
233
|
-
*
|
|
224
|
+
* Map of copied ticket definitions from original event.
|
|
225
|
+
* Key represents ticket def id in the original event.
|
|
226
|
+
* Value represents ticket def id in the newly created event.
|
|
234
227
|
*/
|
|
235
|
-
|
|
228
|
+
ticketDefinitions?: Record<string, string>;
|
|
229
|
+
}
|
|
230
|
+
interface Location {
|
|
236
231
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
232
|
+
* Location name.
|
|
233
|
+
* @maxLength 50
|
|
239
234
|
*/
|
|
240
|
-
|
|
241
|
-
/**
|
|
242
|
-
|
|
243
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
244
|
-
eventTime?: Date | null;
|
|
235
|
+
name?: string | null;
|
|
236
|
+
/** Location map coordinates. */
|
|
237
|
+
coordinates?: MapCoordinates;
|
|
245
238
|
/**
|
|
246
|
-
*
|
|
247
|
-
*
|
|
239
|
+
* Single line address representation.
|
|
240
|
+
* @maxLength 300
|
|
248
241
|
*/
|
|
249
|
-
|
|
250
|
-
/**
|
|
251
|
-
|
|
242
|
+
address?: string | null;
|
|
243
|
+
/** Location type. */
|
|
244
|
+
type?: LocationTypeWithLiterals;
|
|
252
245
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
246
|
+
* Full address derived from formatted single line `address`.
|
|
247
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
248
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
249
|
+
*
|
|
250
|
+
* Migration notes:
|
|
251
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
252
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
255
253
|
*/
|
|
256
|
-
|
|
257
|
-
}
|
|
258
|
-
/** @oneof */
|
|
259
|
-
interface DomainEventBodyOneOf {
|
|
260
|
-
createdEvent?: EntityCreatedEvent;
|
|
261
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
262
|
-
deletedEvent?: EntityDeletedEvent;
|
|
263
|
-
actionEvent?: ActionEvent;
|
|
264
|
-
}
|
|
265
|
-
interface EntityCreatedEvent {
|
|
266
|
-
entityAsJson?: string;
|
|
267
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
268
|
-
restoreInfo?: RestoreInfo;
|
|
269
|
-
}
|
|
270
|
-
interface RestoreInfo {
|
|
271
|
-
deletedDate?: Date | null;
|
|
272
|
-
}
|
|
273
|
-
interface EntityUpdatedEvent {
|
|
254
|
+
fullAddress?: Address;
|
|
274
255
|
/**
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
256
|
+
* Defines event location as TBD (To Be Determined).
|
|
257
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
258
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
278
259
|
*/
|
|
279
|
-
|
|
280
|
-
}
|
|
281
|
-
interface EntityDeletedEvent {
|
|
282
|
-
/** Entity that was deleted. */
|
|
283
|
-
deletedEntityAsJson?: string | null;
|
|
284
|
-
}
|
|
285
|
-
interface ActionEvent {
|
|
286
|
-
bodyAsJson?: string;
|
|
287
|
-
}
|
|
288
|
-
interface Empty {
|
|
260
|
+
tbd?: boolean | null;
|
|
289
261
|
}
|
|
290
|
-
|
|
291
|
-
interface OrderConfirmed {
|
|
292
|
-
/** Date and time the order was confirmed. */
|
|
293
|
-
timestamp?: Date | null;
|
|
262
|
+
interface MapCoordinates {
|
|
294
263
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @
|
|
264
|
+
* Latitude.
|
|
265
|
+
* @min -90
|
|
266
|
+
* @max 90
|
|
297
267
|
*/
|
|
298
|
-
|
|
299
|
-
/** Notifications silenced for this domain event. */
|
|
300
|
-
silent?: boolean | null;
|
|
268
|
+
lat?: number;
|
|
301
269
|
/**
|
|
302
|
-
*
|
|
303
|
-
* @
|
|
270
|
+
* Longitude.
|
|
271
|
+
* @min -180
|
|
272
|
+
* @max 180
|
|
304
273
|
*/
|
|
305
|
-
|
|
274
|
+
lng?: number;
|
|
275
|
+
}
|
|
276
|
+
declare enum LocationType {
|
|
277
|
+
VENUE = "VENUE",
|
|
278
|
+
ONLINE = "ONLINE"
|
|
279
|
+
}
|
|
280
|
+
/** @enumType */
|
|
281
|
+
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
282
|
+
/** Physical address */
|
|
283
|
+
interface Address extends AddressStreetOneOf {
|
|
284
|
+
/** a break down of the street to number and street name */
|
|
285
|
+
streetAddress?: StreetAddress;
|
|
286
|
+
/** Main address line (usually street and number) as free text */
|
|
287
|
+
addressLine?: string | null;
|
|
306
288
|
/**
|
|
307
|
-
*
|
|
308
|
-
* @format GUID
|
|
309
|
-
*/
|
|
310
|
-
eventId?: string;
|
|
311
|
-
/** Unique order number. */
|
|
312
|
-
orderNumber?: string;
|
|
313
|
-
/** Contact ID associated with the order. */
|
|
314
|
-
contactId?: string;
|
|
315
|
-
/**
|
|
316
|
-
* Member ID associated with the order.
|
|
317
|
-
* @format GUID
|
|
318
|
-
*/
|
|
319
|
-
memberId?: string | null;
|
|
320
|
-
/**
|
|
321
|
-
* Date and time the order was created.
|
|
322
|
-
* @readonly
|
|
323
|
-
*/
|
|
324
|
-
created?: Date | null;
|
|
325
|
-
/**
|
|
326
|
-
* Date and time the order was updated.
|
|
327
|
-
* @readonly
|
|
328
|
-
*/
|
|
329
|
-
updated?: Date | null;
|
|
330
|
-
/** Buyer first name. */
|
|
331
|
-
firstName?: string;
|
|
332
|
-
/** Buyer last name. */
|
|
333
|
-
lastName?: string;
|
|
334
|
-
/** Buyer email address. */
|
|
335
|
-
email?: string;
|
|
336
|
-
/** Checkout form response. */
|
|
337
|
-
checkoutForm?: FormResponse;
|
|
338
|
-
/** Order status. */
|
|
339
|
-
status?: OrderStatusWithLiterals;
|
|
340
|
-
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
341
|
-
method?: string | null;
|
|
342
|
-
/** Tickets (generated after payment). */
|
|
343
|
-
tickets?: Ticket[];
|
|
344
|
-
/** Invoice. */
|
|
345
|
-
invoice?: Invoice;
|
|
346
|
-
/** Reservation ID associated with the order. */
|
|
347
|
-
reservationId?: string;
|
|
348
|
-
}
|
|
349
|
-
interface FormResponse {
|
|
350
|
-
/**
|
|
351
|
-
* Form field inputs.
|
|
352
|
-
* @maxSize 200
|
|
353
|
-
*/
|
|
354
|
-
inputValues?: InputValue[];
|
|
355
|
-
}
|
|
356
|
-
interface InputValue {
|
|
357
|
-
/**
|
|
358
|
-
* Form field input name.
|
|
359
|
-
* @maxLength 100
|
|
360
|
-
*/
|
|
361
|
-
inputName?: string;
|
|
362
|
-
/**
|
|
363
|
-
* Form field value.
|
|
364
|
-
* @maxLength 5000
|
|
365
|
-
*/
|
|
366
|
-
value?: string;
|
|
367
|
-
/**
|
|
368
|
-
* Form field values.
|
|
369
|
-
* @maxSize 100
|
|
370
|
-
* @maxLength 5000
|
|
371
|
-
*/
|
|
372
|
-
values?: string[];
|
|
373
|
-
}
|
|
374
|
-
interface FormattedAddress {
|
|
375
|
-
/**
|
|
376
|
-
* 1-line address representation.
|
|
377
|
-
* @maxLength 200
|
|
378
|
-
*/
|
|
379
|
-
formatted?: string;
|
|
380
|
-
/** Address components. */
|
|
381
|
-
address?: CommonAddress;
|
|
382
|
-
}
|
|
383
|
-
/** Physical address */
|
|
384
|
-
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
385
|
-
/** Street name and number. */
|
|
386
|
-
streetAddress?: CommonStreetAddress;
|
|
387
|
-
/** Main address line, usually street and number as free text. */
|
|
388
|
-
addressLine?: string | null;
|
|
389
|
-
/**
|
|
390
|
-
* Country code.
|
|
289
|
+
* country code
|
|
391
290
|
* @format COUNTRY
|
|
392
291
|
*/
|
|
393
292
|
country?: string | null;
|
|
394
|
-
/**
|
|
293
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
395
294
|
subdivision?: string | null;
|
|
396
|
-
/**
|
|
295
|
+
/** city name */
|
|
397
296
|
city?: string | null;
|
|
398
|
-
/**
|
|
297
|
+
/** zip/postal code */
|
|
399
298
|
postalCode?: string | null;
|
|
400
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite,
|
|
299
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
401
300
|
addressLine2?: string | null;
|
|
301
|
+
/** A string containing the human-readable address of this location */
|
|
302
|
+
formattedAddress?: string | null;
|
|
303
|
+
/** Free text for human-to-human textual orientation aid purposes */
|
|
304
|
+
hint?: string | null;
|
|
305
|
+
/** coordinates of the physical address */
|
|
306
|
+
geocode?: AddressLocation;
|
|
307
|
+
/** country full-name */
|
|
308
|
+
countryFullname?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* multi-level subdivisions from top to bottom
|
|
311
|
+
* @maxSize 6
|
|
312
|
+
*/
|
|
313
|
+
subdivisions?: Subdivision[];
|
|
402
314
|
}
|
|
403
315
|
/** @oneof */
|
|
404
|
-
interface
|
|
405
|
-
/**
|
|
406
|
-
streetAddress?:
|
|
407
|
-
/** Main address line
|
|
316
|
+
interface AddressStreetOneOf {
|
|
317
|
+
/** a break down of the street to number and street name */
|
|
318
|
+
streetAddress?: StreetAddress;
|
|
319
|
+
/** Main address line (usually street and number) as free text */
|
|
408
320
|
addressLine?: string | null;
|
|
409
321
|
}
|
|
410
|
-
interface
|
|
411
|
-
/**
|
|
322
|
+
interface StreetAddress {
|
|
323
|
+
/** street number */
|
|
412
324
|
number?: string;
|
|
413
|
-
/**
|
|
325
|
+
/** street name */
|
|
414
326
|
name?: string;
|
|
415
327
|
}
|
|
416
|
-
interface
|
|
417
|
-
/**
|
|
328
|
+
interface AddressLocation {
|
|
329
|
+
/**
|
|
330
|
+
* address latitude coordinates
|
|
331
|
+
* @min -90
|
|
332
|
+
* @max 90
|
|
333
|
+
*/
|
|
418
334
|
latitude?: number | null;
|
|
419
|
-
/**
|
|
335
|
+
/**
|
|
336
|
+
* address longitude coordinates
|
|
337
|
+
* @min -180
|
|
338
|
+
* @max 180
|
|
339
|
+
*/
|
|
420
340
|
longitude?: number | null;
|
|
421
341
|
}
|
|
422
|
-
interface
|
|
423
|
-
/**
|
|
342
|
+
interface Subdivision {
|
|
343
|
+
/** subdivision short code */
|
|
424
344
|
code?: string;
|
|
425
|
-
/**
|
|
345
|
+
/** subdivision full-name */
|
|
426
346
|
name?: string;
|
|
427
347
|
}
|
|
428
348
|
declare enum SubdivisionType {
|
|
@@ -442,945 +362,1025 @@ declare enum SubdivisionType {
|
|
|
442
362
|
}
|
|
443
363
|
/** @enumType */
|
|
444
364
|
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';
|
|
445
|
-
|
|
446
|
-
interface StandardDetails {
|
|
447
|
-
/**
|
|
448
|
-
* 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
|
|
449
|
-
* @maxLength 20
|
|
450
|
-
*/
|
|
451
|
-
iso31662?: string | null;
|
|
452
|
-
}
|
|
453
|
-
declare enum OrderStatus {
|
|
454
|
-
/** Order status isn't available for this request fieldset. */
|
|
455
|
-
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
456
|
-
/** Order is confirmed, no payment is required. */
|
|
457
|
-
FREE = "FREE",
|
|
458
|
-
/** Order was paid, but the payment gateway suspended the payment. */
|
|
459
|
-
PENDING = "PENDING",
|
|
460
|
-
/** Order is paid. */
|
|
461
|
-
PAID = "PAID",
|
|
462
|
-
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
463
|
-
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
464
|
-
/** Order is waiting for payment at the cashier. */
|
|
465
|
-
INITIATED = "INITIATED",
|
|
466
|
-
/** Order is canceled. */
|
|
467
|
-
CANCELED = "CANCELED",
|
|
468
|
-
/** Order payment is declined. */
|
|
469
|
-
DECLINED = "DECLINED",
|
|
470
|
-
/** Order payment is authorized. */
|
|
471
|
-
AUTHORIZED = "AUTHORIZED",
|
|
472
|
-
/** Order payment is voided. */
|
|
473
|
-
VOIDED = "VOIDED",
|
|
474
|
-
/** Order is partially paid with less than the total amount. */
|
|
475
|
-
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
476
|
-
}
|
|
477
|
-
/** @enumType */
|
|
478
|
-
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
479
|
-
interface Ticket {
|
|
480
|
-
/** Unique issued ticket number. */
|
|
481
|
-
ticketNumber?: string;
|
|
482
|
-
/**
|
|
483
|
-
* Ticket definition ID.
|
|
484
|
-
* @format GUID
|
|
485
|
-
*/
|
|
486
|
-
ticketDefinitionId?: string;
|
|
487
|
-
/** Ticket check-in. */
|
|
488
|
-
checkIn?: CheckIn;
|
|
489
|
-
/** Ticket price. */
|
|
490
|
-
price?: Money;
|
|
491
|
-
/** Whether ticket is archived. */
|
|
492
|
-
archived?: boolean;
|
|
493
|
-
/** Guest first name. */
|
|
494
|
-
firstName?: string | null;
|
|
495
|
-
/** Guest last name. */
|
|
496
|
-
lastName?: string | null;
|
|
497
|
-
/** Guest email. */
|
|
498
|
-
email?: string | null;
|
|
365
|
+
interface ScheduleConfig {
|
|
499
366
|
/**
|
|
500
|
-
*
|
|
501
|
-
*
|
|
367
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
368
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
369
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
502
370
|
*/
|
|
503
|
-
|
|
504
|
-
/** Whether ticket is confirmed */
|
|
505
|
-
confirmed?: boolean;
|
|
371
|
+
scheduleTbd?: boolean;
|
|
506
372
|
/**
|
|
507
|
-
*
|
|
508
|
-
* @
|
|
373
|
+
* TBD message.
|
|
374
|
+
* @maxLength 100
|
|
509
375
|
*/
|
|
510
|
-
|
|
511
|
-
/**
|
|
512
|
-
|
|
513
|
-
/**
|
|
514
|
-
|
|
515
|
-
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
516
|
-
anonymized?: boolean;
|
|
517
|
-
/** URL and password to online conference */
|
|
518
|
-
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
376
|
+
scheduleTbdMessage?: string | null;
|
|
377
|
+
/** Event start timestamp. */
|
|
378
|
+
startDate?: Date | null;
|
|
379
|
+
/** Event end timestamp. */
|
|
380
|
+
endDate?: Date | null;
|
|
519
381
|
/**
|
|
520
|
-
*
|
|
521
|
-
* @maxLength
|
|
382
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
383
|
+
* @maxLength 100
|
|
522
384
|
*/
|
|
523
|
-
|
|
524
|
-
/** Whether
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
/**
|
|
529
|
-
|
|
385
|
+
timeZoneId?: string | null;
|
|
386
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
387
|
+
endDateHidden?: boolean;
|
|
388
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
389
|
+
showTimeZone?: boolean;
|
|
390
|
+
/** Event recurrences. */
|
|
391
|
+
recurrences?: Recurrences;
|
|
530
392
|
}
|
|
531
|
-
interface
|
|
393
|
+
interface Recurrences {
|
|
532
394
|
/**
|
|
533
|
-
*
|
|
534
|
-
* @
|
|
535
|
-
* @deprecated
|
|
395
|
+
* Event occurrences.
|
|
396
|
+
* @maxSize 1000
|
|
536
397
|
*/
|
|
537
|
-
|
|
398
|
+
occurrences?: Occurrence[];
|
|
538
399
|
/**
|
|
539
|
-
*
|
|
540
|
-
* @
|
|
400
|
+
* Recurring event category ID.
|
|
401
|
+
* @readonly
|
|
541
402
|
*/
|
|
542
|
-
|
|
403
|
+
categoryId?: string | null;
|
|
543
404
|
/**
|
|
544
|
-
*
|
|
545
|
-
* @
|
|
405
|
+
* Recurrence status.
|
|
406
|
+
* @readonly
|
|
546
407
|
*/
|
|
547
|
-
|
|
408
|
+
status?: StatusWithLiterals;
|
|
548
409
|
}
|
|
549
|
-
interface
|
|
410
|
+
interface Occurrence {
|
|
411
|
+
/** Event start timestamp. */
|
|
412
|
+
startDate?: Date | null;
|
|
413
|
+
/** Event end timestamp. */
|
|
414
|
+
endDate?: Date | null;
|
|
550
415
|
/**
|
|
551
|
-
*
|
|
552
|
-
* @
|
|
553
|
-
* @readonly
|
|
416
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
417
|
+
* @maxLength 100
|
|
554
418
|
*/
|
|
555
|
-
|
|
419
|
+
timeZoneId?: string | null;
|
|
420
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
421
|
+
showTimeZone?: boolean;
|
|
422
|
+
}
|
|
423
|
+
declare enum Status {
|
|
424
|
+
/** Event occurs only once. */
|
|
425
|
+
ONE_TIME = "ONE_TIME",
|
|
426
|
+
/** Event is recurring. */
|
|
427
|
+
RECURRING = "RECURRING",
|
|
428
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
429
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
430
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
431
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
432
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
433
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
434
|
+
}
|
|
435
|
+
/** @enumType */
|
|
436
|
+
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
437
|
+
declare enum EventStatus {
|
|
438
|
+
/** Event is public and scheduled to start */
|
|
439
|
+
SCHEDULED = "SCHEDULED",
|
|
440
|
+
/** Event has started */
|
|
441
|
+
STARTED = "STARTED",
|
|
442
|
+
/** Event has ended */
|
|
443
|
+
ENDED = "ENDED",
|
|
444
|
+
/** Event was canceled */
|
|
445
|
+
CANCELED = "CANCELED"
|
|
446
|
+
}
|
|
447
|
+
/** @enumType */
|
|
448
|
+
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
449
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
450
|
+
createdEvent?: EntityCreatedEvent;
|
|
451
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
452
|
+
deletedEvent?: EntityDeletedEvent;
|
|
453
|
+
actionEvent?: ActionEvent;
|
|
454
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
455
|
+
id?: string;
|
|
556
456
|
/**
|
|
557
|
-
*
|
|
558
|
-
*
|
|
457
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
458
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
559
459
|
*/
|
|
560
|
-
|
|
460
|
+
entityFqdn?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
463
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
464
|
+
*/
|
|
465
|
+
slug?: string;
|
|
466
|
+
/** ID of the entity associated with the event. */
|
|
467
|
+
entityId?: string;
|
|
468
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
469
|
+
eventTime?: Date | null;
|
|
470
|
+
/**
|
|
471
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
472
|
+
* (for example, GDPR).
|
|
473
|
+
*/
|
|
474
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
475
|
+
/** If present, indicates the action that triggered the event. */
|
|
476
|
+
originatedFrom?: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
479
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
480
|
+
*/
|
|
481
|
+
entityEventSequence?: string | null;
|
|
561
482
|
}
|
|
562
|
-
|
|
563
|
-
|
|
483
|
+
/** @oneof */
|
|
484
|
+
interface DomainEventBodyOneOf {
|
|
485
|
+
createdEvent?: EntityCreatedEvent;
|
|
486
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
487
|
+
deletedEvent?: EntityDeletedEvent;
|
|
488
|
+
actionEvent?: ActionEvent;
|
|
489
|
+
}
|
|
490
|
+
interface EntityCreatedEvent {
|
|
491
|
+
entityAsJson?: string;
|
|
492
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
493
|
+
restoreInfo?: RestoreInfo;
|
|
494
|
+
}
|
|
495
|
+
interface RestoreInfo {
|
|
496
|
+
deletedDate?: Date | null;
|
|
497
|
+
}
|
|
498
|
+
interface EntityUpdatedEvent {
|
|
564
499
|
/**
|
|
565
|
-
*
|
|
566
|
-
*
|
|
500
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
501
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
502
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
567
503
|
*/
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
504
|
+
currentEntityAsJson?: string;
|
|
505
|
+
}
|
|
506
|
+
interface EntityDeletedEvent {
|
|
507
|
+
/** Entity that was deleted. */
|
|
508
|
+
deletedEntityAsJson?: string | null;
|
|
509
|
+
}
|
|
510
|
+
interface ActionEvent {
|
|
511
|
+
bodyAsJson?: string;
|
|
512
|
+
}
|
|
513
|
+
interface MessageEnvelope {
|
|
575
514
|
/**
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
* 1. Total prices of all items in the cart are calculated.
|
|
579
|
-
* 2. Discount is subtracted from the cart, if applicable.
|
|
580
|
-
* 3. Tax is added, if applicable.
|
|
581
|
-
* 4. Wix ticket service fee is added.
|
|
515
|
+
* App instance ID.
|
|
516
|
+
* @format GUID
|
|
582
517
|
*/
|
|
583
|
-
|
|
518
|
+
instanceId?: string | null;
|
|
584
519
|
/**
|
|
585
|
-
*
|
|
586
|
-
* @
|
|
520
|
+
* Event type.
|
|
521
|
+
* @maxLength 150
|
|
587
522
|
*/
|
|
588
|
-
|
|
589
|
-
/**
|
|
590
|
-
|
|
591
|
-
/**
|
|
592
|
-
|
|
523
|
+
eventType?: string;
|
|
524
|
+
/** The identification type and identity data. */
|
|
525
|
+
identity?: IdentificationData;
|
|
526
|
+
/** Stringify payload. */
|
|
527
|
+
data?: string;
|
|
528
|
+
/** Details related to the account */
|
|
529
|
+
accountInfo?: AccountInfo;
|
|
593
530
|
}
|
|
594
|
-
interface
|
|
531
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
595
532
|
/**
|
|
596
|
-
*
|
|
533
|
+
* ID of a site visitor that has not logged in to the site.
|
|
597
534
|
* @format GUID
|
|
598
535
|
*/
|
|
599
|
-
|
|
536
|
+
anonymousVisitorId?: string;
|
|
600
537
|
/**
|
|
601
|
-
*
|
|
602
|
-
* @
|
|
603
|
-
* @max 50
|
|
538
|
+
* ID of a site visitor that has logged in to the site.
|
|
539
|
+
* @format GUID
|
|
604
540
|
*/
|
|
605
|
-
|
|
606
|
-
/** Line item name. */
|
|
607
|
-
name?: string;
|
|
608
|
-
/** Line item price. */
|
|
609
|
-
price?: Money;
|
|
610
|
-
/** Total price for line items. Always equal to price * quantity. */
|
|
611
|
-
total?: Money;
|
|
612
|
-
/** Discount applied to the line item. */
|
|
613
|
-
discount?: Discount;
|
|
614
|
-
/** Tax applied to the item. */
|
|
615
|
-
tax?: Tax;
|
|
541
|
+
memberId?: string;
|
|
616
542
|
/**
|
|
617
|
-
*
|
|
618
|
-
* @
|
|
543
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
544
|
+
* @format GUID
|
|
619
545
|
*/
|
|
620
|
-
|
|
546
|
+
wixUserId?: string;
|
|
547
|
+
/**
|
|
548
|
+
* ID of an app.
|
|
549
|
+
* @format GUID
|
|
550
|
+
*/
|
|
551
|
+
appId?: string;
|
|
552
|
+
/** @readonly */
|
|
553
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
621
554
|
}
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
amount?: Money;
|
|
625
|
-
/** Total sum after the discount. */
|
|
626
|
-
afterDiscount?: Money;
|
|
555
|
+
/** @oneof */
|
|
556
|
+
interface IdentificationDataIdOneOf {
|
|
627
557
|
/**
|
|
628
|
-
*
|
|
629
|
-
* @
|
|
558
|
+
* ID of a site visitor that has not logged in to the site.
|
|
559
|
+
* @format GUID
|
|
630
560
|
*/
|
|
631
|
-
|
|
561
|
+
anonymousVisitorId?: string;
|
|
632
562
|
/**
|
|
633
|
-
*
|
|
634
|
-
* @
|
|
563
|
+
* ID of a site visitor that has logged in to the site.
|
|
564
|
+
* @format GUID
|
|
635
565
|
*/
|
|
636
|
-
|
|
566
|
+
memberId?: string;
|
|
637
567
|
/**
|
|
638
|
-
*
|
|
639
|
-
* @
|
|
568
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
569
|
+
* @format GUID
|
|
640
570
|
*/
|
|
641
|
-
|
|
642
|
-
/**
|
|
643
|
-
|
|
571
|
+
wixUserId?: string;
|
|
572
|
+
/**
|
|
573
|
+
* ID of an app.
|
|
574
|
+
* @format GUID
|
|
575
|
+
*/
|
|
576
|
+
appId?: string;
|
|
644
577
|
}
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
amount?: Money;
|
|
578
|
+
declare enum WebhookIdentityType {
|
|
579
|
+
UNKNOWN = "UNKNOWN",
|
|
580
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
581
|
+
MEMBER = "MEMBER",
|
|
582
|
+
WIX_USER = "WIX_USER",
|
|
583
|
+
APP = "APP"
|
|
652
584
|
}
|
|
653
|
-
/** @
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
585
|
+
/** @enumType */
|
|
586
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
587
|
+
interface AccountInfo {
|
|
588
|
+
/**
|
|
589
|
+
* ID of the Wix account associated with the event.
|
|
590
|
+
* @format GUID
|
|
591
|
+
*/
|
|
592
|
+
accountId?: string | null;
|
|
593
|
+
/**
|
|
594
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
595
|
+
* @format GUID
|
|
596
|
+
*/
|
|
597
|
+
parentAccountId?: string | null;
|
|
598
|
+
/**
|
|
599
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
600
|
+
* @format GUID
|
|
601
|
+
*/
|
|
602
|
+
siteId?: string | null;
|
|
659
603
|
}
|
|
660
|
-
interface
|
|
661
|
-
/**
|
|
662
|
-
|
|
663
|
-
/**
|
|
664
|
-
|
|
665
|
-
/**
|
|
666
|
-
|
|
604
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
605
|
+
/** Email notification type */
|
|
606
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
607
|
+
/** Push notification type */
|
|
608
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
609
|
+
/** Rsvp guest info */
|
|
610
|
+
rsvpGuest?: RsvpGuest;
|
|
611
|
+
/** Order guest info */
|
|
612
|
+
orderGuest?: OrderGuest;
|
|
613
|
+
/** Event guests info */
|
|
614
|
+
eventGuests?: EventGuests;
|
|
615
|
+
/** Ticket guests info */
|
|
616
|
+
ticketGuest?: TicketGuest;
|
|
667
617
|
}
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
618
|
+
/** @oneof */
|
|
619
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
620
|
+
/** Email notification type */
|
|
621
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
622
|
+
/** Push notification type */
|
|
623
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
673
624
|
}
|
|
674
625
|
/** @oneof */
|
|
675
|
-
interface
|
|
676
|
-
/**
|
|
677
|
-
|
|
626
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
627
|
+
/** Rsvp guest info */
|
|
628
|
+
rsvpGuest?: RsvpGuest;
|
|
629
|
+
/** Order guest info */
|
|
630
|
+
orderGuest?: OrderGuest;
|
|
631
|
+
/** Event guests info */
|
|
632
|
+
eventGuests?: EventGuests;
|
|
633
|
+
/** Ticket guests info */
|
|
634
|
+
ticketGuest?: TicketGuest;
|
|
635
|
+
}
|
|
636
|
+
declare enum PushNotificationType {
|
|
637
|
+
/** Triggered when event is updated. */
|
|
638
|
+
PUSH_EVENT_UPDATED = "PUSH_EVENT_UPDATED",
|
|
639
|
+
/** Triggered when event is canceled. */
|
|
640
|
+
PUSH_EVENT_CANCELATION = "PUSH_EVENT_CANCELATION",
|
|
641
|
+
/** Triggered before the event start time. */
|
|
642
|
+
PUSH_UPCOMING_EVENT_REMINDER = "PUSH_UPCOMING_EVENT_REMINDER",
|
|
643
|
+
/** Triggered when event is created. */
|
|
644
|
+
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
645
|
+
}
|
|
646
|
+
/** @enumType */
|
|
647
|
+
type PushNotificationTypeWithLiterals = PushNotificationType | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
648
|
+
/** Single guest associated to the RSVP */
|
|
649
|
+
interface RsvpGuest {
|
|
650
|
+
/**
|
|
651
|
+
* Event id
|
|
652
|
+
* @format GUID
|
|
653
|
+
*/
|
|
654
|
+
eventId?: string;
|
|
655
|
+
/**
|
|
656
|
+
* Rsvp id
|
|
657
|
+
* @format GUID
|
|
658
|
+
*/
|
|
659
|
+
rsvpId?: string;
|
|
660
|
+
}
|
|
661
|
+
/** Single guest associated to the Order */
|
|
662
|
+
interface OrderGuest {
|
|
663
|
+
/**
|
|
664
|
+
* Event id
|
|
665
|
+
* @format GUID
|
|
666
|
+
*/
|
|
667
|
+
eventId?: string;
|
|
668
|
+
/**
|
|
669
|
+
* Order number
|
|
670
|
+
* @maxLength 36
|
|
671
|
+
*/
|
|
672
|
+
orderNumber?: string;
|
|
678
673
|
}
|
|
679
|
-
|
|
674
|
+
/** All event guest from RSVPs and Orders */
|
|
675
|
+
interface EventGuests {
|
|
680
676
|
/**
|
|
681
|
-
*
|
|
682
|
-
* @
|
|
677
|
+
* Event id
|
|
678
|
+
* @format GUID
|
|
683
679
|
*/
|
|
684
|
-
|
|
685
|
-
/** Number of discounted tickets. */
|
|
686
|
-
quantityDiscounted?: number;
|
|
680
|
+
eventId?: string;
|
|
687
681
|
}
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
type?: TaxTypeWithLiterals;
|
|
682
|
+
/** Multiple guests associated to Tickets */
|
|
683
|
+
interface TicketGuest {
|
|
691
684
|
/**
|
|
692
|
-
*
|
|
693
|
-
* @
|
|
685
|
+
* Event id
|
|
686
|
+
* @format GUID
|
|
694
687
|
*/
|
|
695
|
-
|
|
688
|
+
eventId?: string;
|
|
696
689
|
/**
|
|
697
|
-
*
|
|
698
|
-
* @
|
|
690
|
+
* Order number
|
|
691
|
+
* @maxLength 36
|
|
699
692
|
*/
|
|
700
|
-
|
|
701
|
-
/** Taxable amount. */
|
|
702
|
-
taxable?: Money;
|
|
703
|
-
/** Total tax amount. */
|
|
704
|
-
amount?: Money;
|
|
705
|
-
}
|
|
706
|
-
declare enum TaxType {
|
|
707
|
-
/** Tax is included in the ticket price. */
|
|
708
|
-
INCLUDED = "INCLUDED",
|
|
709
|
-
/** Tax is added to the order at the checkout. */
|
|
710
|
-
ADDED = "ADDED",
|
|
711
|
-
/** Tax is added to the final total at the checkout. */
|
|
712
|
-
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
713
|
-
}
|
|
714
|
-
/** @enumType */
|
|
715
|
-
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
716
|
-
interface Fee {
|
|
717
|
-
/** Fee identifier. */
|
|
718
|
-
name?: FeeNameWithLiterals;
|
|
719
|
-
/** How fee is calculated. */
|
|
720
|
-
type?: FeeTypeWithLiterals;
|
|
693
|
+
orderNumber?: string | null;
|
|
721
694
|
/**
|
|
722
|
-
*
|
|
723
|
-
* @
|
|
724
|
-
* @
|
|
695
|
+
* Ticket numbers must be from the same order only.
|
|
696
|
+
* @minSize 1
|
|
697
|
+
* @maxSize 100
|
|
698
|
+
* @maxLength 36
|
|
725
699
|
*/
|
|
726
|
-
|
|
727
|
-
/** Total amount of fee charges. */
|
|
728
|
-
amount?: Money;
|
|
729
|
-
}
|
|
730
|
-
declare enum FeeName {
|
|
731
|
-
/** Wix ticket service fee charges applied to the line item. */
|
|
732
|
-
WIX_FEE = "WIX_FEE"
|
|
700
|
+
ticketNumber?: string[];
|
|
733
701
|
}
|
|
734
|
-
|
|
735
|
-
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
736
|
-
declare enum FeeType {
|
|
737
|
-
/** Fee is added to the ticket price at checkout. */
|
|
738
|
-
FEE_ADDED = "FEE_ADDED",
|
|
739
|
-
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
740
|
-
FEE_INCLUDED = "FEE_INCLUDED",
|
|
741
|
-
/** Fee is added to the ticket price at checkout. */
|
|
742
|
-
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
702
|
+
interface TriggerNotificationResponse {
|
|
743
703
|
}
|
|
744
|
-
/**
|
|
745
|
-
|
|
746
|
-
/**
|
|
747
|
-
interface OrderEmailAdded {
|
|
748
|
-
/** Order updated timestamp in ISO UTC format. */
|
|
704
|
+
/** Triggered when an order is confirmed. */
|
|
705
|
+
interface OrderConfirmed {
|
|
706
|
+
/** Date and time the order was confirmed. */
|
|
749
707
|
timestamp?: Date | null;
|
|
750
708
|
/**
|
|
751
|
-
* Site language when
|
|
709
|
+
* Site language when the order was initiated.
|
|
752
710
|
* @format LANGUAGE
|
|
753
711
|
*/
|
|
754
712
|
language?: string | null;
|
|
713
|
+
/** Notifications silenced for this domain event. */
|
|
714
|
+
silent?: boolean | null;
|
|
755
715
|
/**
|
|
756
|
-
* Locale in which
|
|
716
|
+
* Locale in which the order was created.
|
|
757
717
|
* @format LANGUAGE_TAG
|
|
758
718
|
*/
|
|
759
719
|
locale?: string | null;
|
|
760
|
-
/** Notifications silenced for this domain event. */
|
|
761
|
-
silent?: boolean | null;
|
|
762
720
|
/**
|
|
763
|
-
* Event ID.
|
|
721
|
+
* Event ID to which the order belongs.
|
|
764
722
|
* @format GUID
|
|
765
723
|
*/
|
|
766
724
|
eventId?: string;
|
|
767
|
-
/**
|
|
768
|
-
* Unique order number.
|
|
769
|
-
* @maxLength 36
|
|
770
|
-
*/
|
|
725
|
+
/** Unique order number. */
|
|
771
726
|
orderNumber?: string;
|
|
727
|
+
/** Contact ID associated with the order. */
|
|
728
|
+
contactId?: string;
|
|
772
729
|
/**
|
|
773
|
-
*
|
|
774
|
-
* @format GUID
|
|
775
|
-
*/
|
|
776
|
-
contactId?: string | null;
|
|
777
|
-
/**
|
|
778
|
-
* Member ID associated with this order.
|
|
730
|
+
* Member ID associated with the order.
|
|
779
731
|
* @format GUID
|
|
780
732
|
*/
|
|
781
733
|
memberId?: string | null;
|
|
782
734
|
/**
|
|
783
|
-
*
|
|
735
|
+
* Date and time the order was created.
|
|
784
736
|
* @readonly
|
|
785
737
|
*/
|
|
786
738
|
created?: Date | null;
|
|
787
739
|
/**
|
|
788
|
-
*
|
|
740
|
+
* Date and time the order was updated.
|
|
789
741
|
* @readonly
|
|
790
742
|
*/
|
|
791
743
|
updated?: Date | null;
|
|
792
|
-
/**
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
* Buyer last name.
|
|
799
|
-
* @maxLength 255
|
|
800
|
-
*/
|
|
801
|
-
lastName?: string | null;
|
|
802
|
-
/**
|
|
803
|
-
* Buyer email.
|
|
804
|
-
* @format EMAIL
|
|
805
|
-
*/
|
|
806
|
-
email?: string | null;
|
|
744
|
+
/** Buyer first name. */
|
|
745
|
+
firstName?: string;
|
|
746
|
+
/** Buyer last name. */
|
|
747
|
+
lastName?: string;
|
|
748
|
+
/** Buyer email address. */
|
|
749
|
+
email?: string;
|
|
807
750
|
/** Checkout form response. */
|
|
808
751
|
checkoutForm?: FormResponse;
|
|
809
|
-
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
810
|
-
confirmed?: boolean;
|
|
811
752
|
/** Order status. */
|
|
812
753
|
status?: OrderStatusWithLiterals;
|
|
754
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
755
|
+
method?: string | null;
|
|
756
|
+
/** Tickets (generated after payment). */
|
|
757
|
+
tickets?: Ticket[];
|
|
758
|
+
/** Invoice. */
|
|
759
|
+
invoice?: Invoice;
|
|
760
|
+
/** Reservation ID associated with the order. */
|
|
761
|
+
reservationId?: string;
|
|
762
|
+
}
|
|
763
|
+
interface FormResponse {
|
|
813
764
|
/**
|
|
814
|
-
*
|
|
765
|
+
* Form field inputs.
|
|
766
|
+
* @maxSize 200
|
|
767
|
+
*/
|
|
768
|
+
inputValues?: InputValue[];
|
|
769
|
+
}
|
|
770
|
+
interface InputValue {
|
|
771
|
+
/**
|
|
772
|
+
* Form field input name.
|
|
815
773
|
* @maxLength 100
|
|
816
774
|
*/
|
|
817
|
-
|
|
775
|
+
inputName?: string;
|
|
818
776
|
/**
|
|
819
|
-
*
|
|
820
|
-
* @
|
|
777
|
+
* Form field value.
|
|
778
|
+
* @maxLength 5000
|
|
821
779
|
*/
|
|
822
|
-
|
|
823
|
-
/** Whether order was archived and excluded from results. */
|
|
824
|
-
archived?: boolean;
|
|
780
|
+
value?: string;
|
|
825
781
|
/**
|
|
826
|
-
*
|
|
827
|
-
* @
|
|
782
|
+
* Form field values.
|
|
783
|
+
* @maxSize 100
|
|
784
|
+
* @maxLength 5000
|
|
828
785
|
*/
|
|
829
|
-
|
|
830
|
-
/** Whether marketing consent was given. */
|
|
831
|
-
marketingConsent?: boolean | null;
|
|
786
|
+
values?: string[];
|
|
832
787
|
}
|
|
833
|
-
|
|
834
|
-
interface OrderPaid {
|
|
835
|
-
/** Date and time the order was paid. */
|
|
836
|
-
timestamp?: Date | null;
|
|
788
|
+
interface FormattedAddress {
|
|
837
789
|
/**
|
|
838
|
-
*
|
|
839
|
-
* @
|
|
790
|
+
* 1-line address representation.
|
|
791
|
+
* @maxLength 200
|
|
840
792
|
*/
|
|
841
|
-
|
|
842
|
-
/**
|
|
843
|
-
|
|
793
|
+
formatted?: string;
|
|
794
|
+
/** Address components. */
|
|
795
|
+
address?: CommonAddress;
|
|
796
|
+
}
|
|
797
|
+
/** Physical address */
|
|
798
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
799
|
+
/** Street name and number. */
|
|
800
|
+
streetAddress?: CommonStreetAddress;
|
|
801
|
+
/** Main address line, usually street and number as free text. */
|
|
802
|
+
addressLine?: string | null;
|
|
844
803
|
/**
|
|
845
|
-
*
|
|
846
|
-
* @format
|
|
804
|
+
* Country code.
|
|
805
|
+
* @format COUNTRY
|
|
847
806
|
*/
|
|
848
|
-
|
|
807
|
+
country?: string | null;
|
|
808
|
+
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
809
|
+
subdivision?: string | null;
|
|
810
|
+
/** City name. */
|
|
811
|
+
city?: string | null;
|
|
812
|
+
/** Zip/postal code. */
|
|
813
|
+
postalCode?: string | null;
|
|
814
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
815
|
+
addressLine2?: string | null;
|
|
816
|
+
}
|
|
817
|
+
/** @oneof */
|
|
818
|
+
interface CommonAddressStreetOneOf {
|
|
819
|
+
/** Street name and number. */
|
|
820
|
+
streetAddress?: CommonStreetAddress;
|
|
821
|
+
/** Main address line, usually street and number as free text. */
|
|
822
|
+
addressLine?: string | null;
|
|
823
|
+
}
|
|
824
|
+
interface CommonStreetAddress {
|
|
825
|
+
/** Street number. */
|
|
826
|
+
number?: string;
|
|
827
|
+
/** Street name. */
|
|
828
|
+
name?: string;
|
|
829
|
+
}
|
|
830
|
+
interface CommonAddressLocation {
|
|
831
|
+
/** Address latitude. */
|
|
832
|
+
latitude?: number | null;
|
|
833
|
+
/** Address longitude. */
|
|
834
|
+
longitude?: number | null;
|
|
835
|
+
}
|
|
836
|
+
interface CommonSubdivision {
|
|
837
|
+
/** Short subdivision code. */
|
|
838
|
+
code?: string;
|
|
839
|
+
/** Subdivision full name. */
|
|
840
|
+
name?: string;
|
|
841
|
+
}
|
|
842
|
+
/** Subdivision Concordance values */
|
|
843
|
+
interface StandardDetails {
|
|
844
|
+
/**
|
|
845
|
+
* 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
|
|
846
|
+
* @maxLength 20
|
|
847
|
+
*/
|
|
848
|
+
iso31662?: string | null;
|
|
849
|
+
}
|
|
850
|
+
declare enum OrderStatus {
|
|
851
|
+
/** Order status isn't available for this request fieldset. */
|
|
852
|
+
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
853
|
+
/** Order is confirmed, no payment is required. */
|
|
854
|
+
FREE = "FREE",
|
|
855
|
+
/** Order was paid, but the payment gateway suspended the payment. */
|
|
856
|
+
PENDING = "PENDING",
|
|
857
|
+
/** Order is paid. */
|
|
858
|
+
PAID = "PAID",
|
|
859
|
+
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
860
|
+
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
861
|
+
/** Order is waiting for payment at the cashier. */
|
|
862
|
+
INITIATED = "INITIATED",
|
|
863
|
+
/** Order is canceled. */
|
|
864
|
+
CANCELED = "CANCELED",
|
|
865
|
+
/** Order payment is declined. */
|
|
866
|
+
DECLINED = "DECLINED",
|
|
867
|
+
/** Order payment is authorized. */
|
|
868
|
+
AUTHORIZED = "AUTHORIZED",
|
|
869
|
+
/** Order payment is voided. */
|
|
870
|
+
VOIDED = "VOIDED",
|
|
871
|
+
/** Order is partially paid with less than the total amount. */
|
|
872
|
+
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
873
|
+
}
|
|
874
|
+
/** @enumType */
|
|
875
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
876
|
+
interface Ticket {
|
|
877
|
+
/** Unique issued ticket number. */
|
|
878
|
+
ticketNumber?: string;
|
|
849
879
|
/**
|
|
850
|
-
*
|
|
880
|
+
* Ticket definition ID.
|
|
851
881
|
* @format GUID
|
|
852
882
|
*/
|
|
853
|
-
|
|
854
|
-
/**
|
|
855
|
-
|
|
856
|
-
/**
|
|
857
|
-
|
|
883
|
+
ticketDefinitionId?: string;
|
|
884
|
+
/** Ticket check-in. */
|
|
885
|
+
checkIn?: CheckIn;
|
|
886
|
+
/** Ticket price. */
|
|
887
|
+
price?: Money;
|
|
888
|
+
/** Whether ticket is archived. */
|
|
889
|
+
archived?: boolean;
|
|
890
|
+
/** Guest first name. */
|
|
891
|
+
firstName?: string | null;
|
|
892
|
+
/** Guest last name. */
|
|
893
|
+
lastName?: string | null;
|
|
894
|
+
/** Guest email. */
|
|
895
|
+
email?: string | null;
|
|
858
896
|
/**
|
|
859
|
-
* Contact ID associated with this
|
|
860
|
-
* @
|
|
897
|
+
* Contact ID associated with this ticket.
|
|
898
|
+
* @format GUID
|
|
861
899
|
*/
|
|
862
|
-
contactId?: string;
|
|
900
|
+
contactId?: string | null;
|
|
901
|
+
/** Whether ticket is confirmed */
|
|
902
|
+
confirmed?: boolean;
|
|
863
903
|
/**
|
|
864
|
-
* Member ID associated with this
|
|
904
|
+
* Member ID associated with this ticket.
|
|
865
905
|
* @format GUID
|
|
866
906
|
*/
|
|
867
907
|
memberId?: string | null;
|
|
908
|
+
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
909
|
+
form?: FormResponse;
|
|
910
|
+
/** Ticket name. */
|
|
911
|
+
ticketName?: string;
|
|
912
|
+
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
913
|
+
anonymized?: boolean;
|
|
914
|
+
/** URL and password to online conference */
|
|
915
|
+
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
868
916
|
/**
|
|
869
|
-
*
|
|
870
|
-
* @
|
|
917
|
+
* Seat ID associated with this ticket.
|
|
918
|
+
* @maxLength 36
|
|
871
919
|
*/
|
|
920
|
+
seatId?: string | null;
|
|
921
|
+
/** Whether ticket is canceled. */
|
|
922
|
+
canceled?: boolean | null;
|
|
923
|
+
}
|
|
924
|
+
interface CheckIn {
|
|
925
|
+
/** Time of a ticket's check-in. */
|
|
872
926
|
created?: Date | null;
|
|
927
|
+
}
|
|
928
|
+
interface Money {
|
|
873
929
|
/**
|
|
874
|
-
*
|
|
875
|
-
* @
|
|
876
|
-
|
|
877
|
-
firstName?: string;
|
|
878
|
-
/**
|
|
879
|
-
* Buyer last name.
|
|
880
|
-
* @maxLength 255
|
|
881
|
-
*/
|
|
882
|
-
lastName?: string;
|
|
883
|
-
/**
|
|
884
|
-
* Buyer email address.
|
|
885
|
-
* @maxLength 255
|
|
930
|
+
* *Deprecated:** Use `value` instead.
|
|
931
|
+
* @format DECIMAL_VALUE
|
|
932
|
+
* @deprecated
|
|
886
933
|
*/
|
|
887
|
-
|
|
888
|
-
/** Checkout form response. */
|
|
889
|
-
checkoutForm?: FormResponse;
|
|
890
|
-
/** Order status. */
|
|
891
|
-
status?: OrderStatusWithLiterals;
|
|
934
|
+
amount?: string;
|
|
892
935
|
/**
|
|
893
|
-
*
|
|
894
|
-
* @
|
|
936
|
+
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
937
|
+
* @format CURRENCY
|
|
895
938
|
*/
|
|
896
|
-
|
|
939
|
+
currency?: string;
|
|
897
940
|
/**
|
|
898
|
-
*
|
|
899
|
-
* @
|
|
941
|
+
* 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.
|
|
942
|
+
* @format DECIMAL_VALUE
|
|
900
943
|
*/
|
|
901
|
-
|
|
902
|
-
/** Invoice. */
|
|
903
|
-
invoice?: Invoice;
|
|
944
|
+
value?: string | null;
|
|
904
945
|
}
|
|
905
|
-
interface
|
|
906
|
-
/**
|
|
907
|
-
* Optional order number
|
|
908
|
-
* @maxLength 36
|
|
909
|
-
*/
|
|
910
|
-
orderNumber?: string | null;
|
|
911
|
-
/**
|
|
912
|
-
* Optional ticket number
|
|
913
|
-
* @maxLength 36
|
|
914
|
-
*/
|
|
915
|
-
ticketNumber?: string | null;
|
|
946
|
+
interface OnlineConferencingLogin {
|
|
916
947
|
/**
|
|
917
|
-
*
|
|
948
|
+
* Link URL to the online conference.
|
|
918
949
|
* @format WEB_URL
|
|
950
|
+
* @readonly
|
|
919
951
|
*/
|
|
920
|
-
|
|
921
|
-
/** Resolve status */
|
|
922
|
-
resolveFailed?: boolean | null;
|
|
952
|
+
link?: string;
|
|
923
953
|
/**
|
|
924
|
-
*
|
|
925
|
-
* @
|
|
954
|
+
* Password for the online conference.
|
|
955
|
+
* @readonly
|
|
926
956
|
*/
|
|
927
|
-
|
|
957
|
+
password?: string | null;
|
|
928
958
|
}
|
|
929
|
-
interface
|
|
959
|
+
interface Invoice {
|
|
960
|
+
items?: Item[];
|
|
930
961
|
/**
|
|
931
|
-
*
|
|
932
|
-
* @
|
|
962
|
+
* Total cart amount.
|
|
963
|
+
* @deprecated
|
|
933
964
|
*/
|
|
934
|
-
|
|
965
|
+
total?: Money;
|
|
966
|
+
/** Discount applied to a cart. */
|
|
967
|
+
discount?: Discount;
|
|
968
|
+
/** Tax applied to a cart. */
|
|
969
|
+
tax?: Tax;
|
|
970
|
+
/** Total cart amount before discount, tax, and fees. */
|
|
971
|
+
subTotal?: Money;
|
|
935
972
|
/**
|
|
936
|
-
*
|
|
937
|
-
*
|
|
973
|
+
* Total amount of a cart after discount, tax, and fees.
|
|
974
|
+
* Grand total is calculated in the following order:
|
|
975
|
+
* 1. Total prices of all items in the cart are calculated.
|
|
976
|
+
* 2. Discount is subtracted from the cart, if applicable.
|
|
977
|
+
* 3. Tax is added, if applicable.
|
|
978
|
+
* 4. Wix ticket service fee is added.
|
|
938
979
|
*/
|
|
939
|
-
|
|
980
|
+
grandTotal?: Money;
|
|
940
981
|
/**
|
|
941
|
-
*
|
|
942
|
-
* @
|
|
982
|
+
* Fees applied to the cart.
|
|
983
|
+
* @readonly
|
|
943
984
|
*/
|
|
944
|
-
|
|
985
|
+
fees?: Fee[];
|
|
986
|
+
/** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
|
|
987
|
+
revenue?: Money;
|
|
988
|
+
/** Invoice preview URL. Only returned if the order is paid. */
|
|
989
|
+
previewUrl?: string | null;
|
|
945
990
|
}
|
|
946
|
-
|
|
947
|
-
interface OrderCanceled {
|
|
991
|
+
interface Item {
|
|
948
992
|
/**
|
|
949
|
-
*
|
|
993
|
+
* Unique line item ID.
|
|
950
994
|
* @format GUID
|
|
951
995
|
*/
|
|
952
|
-
|
|
953
|
-
/**
|
|
954
|
-
* Unique order number.
|
|
955
|
-
* @maxLength 36
|
|
956
|
-
*/
|
|
957
|
-
orderNumber?: string;
|
|
996
|
+
id?: string;
|
|
958
997
|
/**
|
|
959
|
-
*
|
|
960
|
-
* @
|
|
998
|
+
* Line item quantity.
|
|
999
|
+
* @min 1
|
|
1000
|
+
* @max 50
|
|
961
1001
|
*/
|
|
962
|
-
|
|
1002
|
+
quantity?: number;
|
|
1003
|
+
/** Line item name. */
|
|
1004
|
+
name?: string;
|
|
1005
|
+
/** Line item price. */
|
|
1006
|
+
price?: Money;
|
|
1007
|
+
/** Total price for line items. Always equal to price * quantity. */
|
|
1008
|
+
total?: Money;
|
|
1009
|
+
/** Discount applied to the line item. */
|
|
1010
|
+
discount?: Discount;
|
|
1011
|
+
/** Tax applied to the item. */
|
|
1012
|
+
tax?: Tax;
|
|
963
1013
|
/**
|
|
964
|
-
*
|
|
965
|
-
* @
|
|
1014
|
+
* Fees applied to the item.
|
|
1015
|
+
* @readonly
|
|
966
1016
|
*/
|
|
967
|
-
|
|
1017
|
+
fees?: Fee[];
|
|
1018
|
+
}
|
|
1019
|
+
interface Discount {
|
|
1020
|
+
/** Total discount amount. */
|
|
1021
|
+
amount?: Money;
|
|
1022
|
+
/** Total sum after the discount. */
|
|
1023
|
+
afterDiscount?: Money;
|
|
968
1024
|
/**
|
|
969
|
-
*
|
|
970
|
-
* @
|
|
1025
|
+
* Discount coupon code.
|
|
1026
|
+
* @deprecated
|
|
971
1027
|
*/
|
|
972
|
-
|
|
1028
|
+
code?: string;
|
|
973
1029
|
/**
|
|
974
|
-
*
|
|
975
|
-
* @
|
|
1030
|
+
* Discount coupon name.
|
|
1031
|
+
* @deprecated
|
|
976
1032
|
*/
|
|
977
|
-
|
|
1033
|
+
name?: string;
|
|
978
1034
|
/**
|
|
979
|
-
*
|
|
980
|
-
* @
|
|
1035
|
+
* Discount coupon ID.
|
|
1036
|
+
* @deprecated
|
|
981
1037
|
*/
|
|
982
|
-
|
|
983
|
-
/**
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
1038
|
+
couponId?: string;
|
|
1039
|
+
/** Discount items. */
|
|
1040
|
+
discounts?: DiscountItem[];
|
|
1041
|
+
}
|
|
1042
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
1043
|
+
/** Coupon discount. */
|
|
1044
|
+
coupon?: CouponDiscount;
|
|
1045
|
+
/** Pricing plan discount. */
|
|
1046
|
+
paidPlan?: PaidPlanDiscount;
|
|
1047
|
+
/** Total discount amount. */
|
|
1048
|
+
amount?: Money;
|
|
1049
|
+
}
|
|
1050
|
+
/** @oneof */
|
|
1051
|
+
interface DiscountItemDiscountOneOf {
|
|
1052
|
+
/** Coupon discount. */
|
|
1053
|
+
coupon?: CouponDiscount;
|
|
1054
|
+
/** Pricing plan discount. */
|
|
1055
|
+
paidPlan?: PaidPlanDiscount;
|
|
1056
|
+
}
|
|
1057
|
+
interface CouponDiscount {
|
|
1058
|
+
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
1059
|
+
name?: string;
|
|
1060
|
+
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
1061
|
+
code?: string;
|
|
1062
|
+
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
1063
|
+
couponId?: string;
|
|
1064
|
+
}
|
|
1065
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
1066
|
+
/** Discount by percentage applied to tickets. */
|
|
1067
|
+
percentDiscount?: PercentDiscount;
|
|
1068
|
+
/** Name of pricing plan. */
|
|
1069
|
+
name?: string;
|
|
1070
|
+
}
|
|
1071
|
+
/** @oneof */
|
|
1072
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
1073
|
+
/** Discount by percentage applied to tickets. */
|
|
1074
|
+
percentDiscount?: PercentDiscount;
|
|
987
1075
|
}
|
|
988
|
-
interface
|
|
1076
|
+
interface PercentDiscount {
|
|
989
1077
|
/**
|
|
990
|
-
*
|
|
991
|
-
* @
|
|
1078
|
+
* Percent rate.
|
|
1079
|
+
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
992
1080
|
*/
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
/** The retrieved NotificationConfig */
|
|
997
|
-
notificationConfig?: NotificationConfig;
|
|
1081
|
+
rate?: string;
|
|
1082
|
+
/** Number of discounted tickets. */
|
|
1083
|
+
quantityDiscounted?: number;
|
|
998
1084
|
}
|
|
999
|
-
interface
|
|
1000
|
-
/**
|
|
1001
|
-
|
|
1085
|
+
interface Tax {
|
|
1086
|
+
/** Tax type. */
|
|
1087
|
+
type?: TaxTypeWithLiterals;
|
|
1088
|
+
/**
|
|
1089
|
+
* Tax name.
|
|
1090
|
+
* @readonly
|
|
1091
|
+
*/
|
|
1092
|
+
name?: string;
|
|
1093
|
+
/**
|
|
1094
|
+
* Tax rate.
|
|
1095
|
+
* @format DECIMAL_VALUE
|
|
1096
|
+
*/
|
|
1097
|
+
rate?: string;
|
|
1098
|
+
/** Taxable amount. */
|
|
1099
|
+
taxable?: Money;
|
|
1100
|
+
/** Total tax amount. */
|
|
1101
|
+
amount?: Money;
|
|
1002
1102
|
}
|
|
1003
|
-
|
|
1004
|
-
/**
|
|
1005
|
-
|
|
1103
|
+
declare enum TaxType {
|
|
1104
|
+
/** Tax is included in the ticket price. */
|
|
1105
|
+
INCLUDED = "INCLUDED",
|
|
1106
|
+
/** Tax is added to the order at the checkout. */
|
|
1107
|
+
ADDED = "ADDED",
|
|
1108
|
+
/** Tax is added to the final total at the checkout. */
|
|
1109
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1006
1110
|
}
|
|
1007
|
-
|
|
1111
|
+
/** @enumType */
|
|
1112
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
1113
|
+
interface Fee {
|
|
1114
|
+
/** Fee identifier. */
|
|
1115
|
+
name?: FeeNameWithLiterals;
|
|
1116
|
+
/** How fee is calculated. */
|
|
1117
|
+
type?: FeeTypeWithLiterals;
|
|
1008
1118
|
/**
|
|
1009
|
-
*
|
|
1010
|
-
* @format
|
|
1119
|
+
* Fee rate.
|
|
1120
|
+
* @format DECIMAL_VALUE
|
|
1121
|
+
* @readonly
|
|
1011
1122
|
*/
|
|
1012
|
-
|
|
1013
|
-
/**
|
|
1014
|
-
|
|
1123
|
+
rate?: string;
|
|
1124
|
+
/** Total amount of fee charges. */
|
|
1125
|
+
amount?: Money;
|
|
1015
1126
|
}
|
|
1016
|
-
|
|
1017
|
-
/**
|
|
1018
|
-
|
|
1127
|
+
declare enum FeeName {
|
|
1128
|
+
/** Wix ticket service fee charges applied to the line item. */
|
|
1129
|
+
WIX_FEE = "WIX_FEE"
|
|
1019
1130
|
}
|
|
1020
|
-
|
|
1021
|
-
|
|
1131
|
+
/** @enumType */
|
|
1132
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
1133
|
+
declare enum FeeType {
|
|
1134
|
+
/** Fee is added to the ticket price at checkout. */
|
|
1135
|
+
FEE_ADDED = "FEE_ADDED",
|
|
1136
|
+
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
1137
|
+
FEE_INCLUDED = "FEE_INCLUDED",
|
|
1138
|
+
/** Fee is added to the ticket price at checkout. */
|
|
1139
|
+
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
1140
|
+
}
|
|
1141
|
+
/** @enumType */
|
|
1142
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
1143
|
+
/** Produced if a buyer email was added to the existing order */
|
|
1144
|
+
interface OrderEmailAdded {
|
|
1145
|
+
/** Order updated timestamp in ISO UTC format. */
|
|
1022
1146
|
timestamp?: Date | null;
|
|
1023
1147
|
/**
|
|
1024
|
-
*
|
|
1025
|
-
* @format
|
|
1148
|
+
* Site language when Order initiated
|
|
1149
|
+
* @format LANGUAGE
|
|
1026
1150
|
*/
|
|
1027
|
-
|
|
1028
|
-
/** Event title */
|
|
1029
|
-
title?: string;
|
|
1151
|
+
language?: string | null;
|
|
1030
1152
|
/**
|
|
1031
|
-
*
|
|
1032
|
-
* @format
|
|
1153
|
+
* Locale in which Order was created.
|
|
1154
|
+
* @format LANGUAGE_TAG
|
|
1033
1155
|
*/
|
|
1034
|
-
|
|
1035
|
-
/**
|
|
1036
|
-
|
|
1037
|
-
}
|
|
1038
|
-
interface EventDeleted {
|
|
1039
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
1040
|
-
timestamp?: Date | null;
|
|
1156
|
+
locale?: string | null;
|
|
1157
|
+
/** Notifications silenced for this domain event. */
|
|
1158
|
+
silent?: boolean | null;
|
|
1041
1159
|
/**
|
|
1042
1160
|
* Event ID.
|
|
1043
1161
|
* @format GUID
|
|
1044
1162
|
*/
|
|
1045
1163
|
eventId?: string;
|
|
1046
|
-
/** Event title. */
|
|
1047
|
-
title?: string;
|
|
1048
1164
|
/**
|
|
1049
|
-
*
|
|
1050
|
-
* @
|
|
1051
|
-
*/
|
|
1052
|
-
userId?: string | null;
|
|
1053
|
-
}
|
|
1054
|
-
interface EventCopied {
|
|
1055
|
-
/** Event created timestamp in ISO UTC format. */
|
|
1056
|
-
timestamp?: Date | null;
|
|
1057
|
-
/**
|
|
1058
|
-
* Event ID.
|
|
1059
|
-
* @format GUID
|
|
1165
|
+
* Unique order number.
|
|
1166
|
+
* @maxLength 36
|
|
1060
1167
|
*/
|
|
1061
|
-
|
|
1062
|
-
/** Event location. */
|
|
1063
|
-
location?: Location;
|
|
1064
|
-
/** Event schedule configuration. */
|
|
1065
|
-
scheduleConfig?: ScheduleConfig;
|
|
1066
|
-
/** Event title. */
|
|
1067
|
-
title?: string;
|
|
1168
|
+
orderNumber?: string;
|
|
1068
1169
|
/**
|
|
1069
|
-
*
|
|
1170
|
+
* Contact ID associated with this order.
|
|
1070
1171
|
* @format GUID
|
|
1071
1172
|
*/
|
|
1072
|
-
|
|
1073
|
-
/** Event status. */
|
|
1074
|
-
status?: EventStatusWithLiterals;
|
|
1173
|
+
contactId?: string | null;
|
|
1075
1174
|
/**
|
|
1076
|
-
*
|
|
1175
|
+
* Member ID associated with this order.
|
|
1077
1176
|
* @format GUID
|
|
1078
1177
|
*/
|
|
1079
|
-
|
|
1178
|
+
memberId?: string | null;
|
|
1080
1179
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @
|
|
1180
|
+
* Order created timestamp.
|
|
1181
|
+
* @readonly
|
|
1083
1182
|
*/
|
|
1084
|
-
|
|
1183
|
+
created?: Date | null;
|
|
1085
1184
|
/**
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1088
|
-
* Value represents ticket def id in the newly created event.
|
|
1185
|
+
* Order updated timestamp.
|
|
1186
|
+
* @readonly
|
|
1089
1187
|
*/
|
|
1090
|
-
|
|
1091
|
-
}
|
|
1092
|
-
interface Location {
|
|
1188
|
+
updated?: Date | null;
|
|
1093
1189
|
/**
|
|
1094
|
-
*
|
|
1095
|
-
* @maxLength
|
|
1190
|
+
* Buyer first name.
|
|
1191
|
+
* @maxLength 255
|
|
1096
1192
|
*/
|
|
1097
|
-
|
|
1098
|
-
/** Location map coordinates. */
|
|
1099
|
-
coordinates?: MapCoordinates;
|
|
1193
|
+
firstName?: string | null;
|
|
1100
1194
|
/**
|
|
1101
|
-
*
|
|
1102
|
-
* @maxLength
|
|
1195
|
+
* Buyer last name.
|
|
1196
|
+
* @maxLength 255
|
|
1103
1197
|
*/
|
|
1104
|
-
|
|
1105
|
-
/** Location type. */
|
|
1106
|
-
type?: LocationTypeWithLiterals;
|
|
1198
|
+
lastName?: string | null;
|
|
1107
1199
|
/**
|
|
1108
|
-
*
|
|
1109
|
-
*
|
|
1110
|
-
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1111
|
-
*
|
|
1112
|
-
* Migration notes:
|
|
1113
|
-
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1114
|
-
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1200
|
+
* Buyer email.
|
|
1201
|
+
* @format EMAIL
|
|
1115
1202
|
*/
|
|
1116
|
-
|
|
1203
|
+
email?: string | null;
|
|
1204
|
+
/** Checkout form response. */
|
|
1205
|
+
checkoutForm?: FormResponse;
|
|
1206
|
+
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
1207
|
+
confirmed?: boolean;
|
|
1208
|
+
/** Order status. */
|
|
1209
|
+
status?: OrderStatusWithLiterals;
|
|
1117
1210
|
/**
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1211
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
1212
|
+
* @maxLength 100
|
|
1121
1213
|
*/
|
|
1122
|
-
|
|
1123
|
-
}
|
|
1124
|
-
interface MapCoordinates {
|
|
1214
|
+
method?: string | null;
|
|
1125
1215
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
* @
|
|
1128
|
-
* @max 90
|
|
1216
|
+
* Tickets generated after payment.
|
|
1217
|
+
* @maxSize 50
|
|
1129
1218
|
*/
|
|
1130
|
-
|
|
1219
|
+
tickets?: Ticket[];
|
|
1220
|
+
/** Whether order was archived and excluded from results. */
|
|
1221
|
+
archived?: boolean;
|
|
1131
1222
|
/**
|
|
1132
|
-
*
|
|
1133
|
-
* @
|
|
1134
|
-
* @max 180
|
|
1223
|
+
* Reservation ID associated with this order.
|
|
1224
|
+
* @format GUID
|
|
1135
1225
|
*/
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
VENUE = "VENUE",
|
|
1140
|
-
ONLINE = "ONLINE"
|
|
1226
|
+
reservationId?: string;
|
|
1227
|
+
/** Whether marketing consent was given. */
|
|
1228
|
+
marketingConsent?: boolean | null;
|
|
1141
1229
|
}
|
|
1142
|
-
/**
|
|
1143
|
-
|
|
1144
|
-
/**
|
|
1145
|
-
|
|
1146
|
-
/** a break down of the street to number and street name */
|
|
1147
|
-
streetAddress?: StreetAddress;
|
|
1148
|
-
/** Main address line (usually street and number) as free text */
|
|
1149
|
-
addressLine?: string | null;
|
|
1230
|
+
/** Triggered when an order is paid. */
|
|
1231
|
+
interface OrderPaid {
|
|
1232
|
+
/** Date and time the order was paid. */
|
|
1233
|
+
timestamp?: Date | null;
|
|
1150
1234
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
* @format
|
|
1235
|
+
* Site language when the order was initiated.
|
|
1236
|
+
* @format LANGUAGE
|
|
1153
1237
|
*/
|
|
1154
|
-
|
|
1155
|
-
/**
|
|
1156
|
-
|
|
1157
|
-
/** city name */
|
|
1158
|
-
city?: string | null;
|
|
1159
|
-
/** zip/postal code */
|
|
1160
|
-
postalCode?: string | null;
|
|
1161
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1162
|
-
addressLine2?: string | null;
|
|
1163
|
-
/** A string containing the human-readable address of this location */
|
|
1164
|
-
formattedAddress?: string | null;
|
|
1165
|
-
/** Free text for human-to-human textual orientation aid purposes */
|
|
1166
|
-
hint?: string | null;
|
|
1167
|
-
/** coordinates of the physical address */
|
|
1168
|
-
geocode?: AddressLocation;
|
|
1169
|
-
/** country full-name */
|
|
1170
|
-
countryFullname?: string | null;
|
|
1238
|
+
language?: string | null;
|
|
1239
|
+
/** Notifications silenced for this domain event. */
|
|
1240
|
+
silent?: boolean | null;
|
|
1171
1241
|
/**
|
|
1172
|
-
*
|
|
1173
|
-
* @
|
|
1242
|
+
* Locale in which the order was created.
|
|
1243
|
+
* @format LANGUAGE_TAG
|
|
1174
1244
|
*/
|
|
1175
|
-
|
|
1176
|
-
}
|
|
1177
|
-
/** @oneof */
|
|
1178
|
-
interface AddressStreetOneOf {
|
|
1179
|
-
/** a break down of the street to number and street name */
|
|
1180
|
-
streetAddress?: StreetAddress;
|
|
1181
|
-
/** Main address line (usually street and number) as free text */
|
|
1182
|
-
addressLine?: string | null;
|
|
1183
|
-
}
|
|
1184
|
-
interface StreetAddress {
|
|
1185
|
-
/** street number */
|
|
1186
|
-
number?: string;
|
|
1187
|
-
/** street name */
|
|
1188
|
-
name?: string;
|
|
1189
|
-
}
|
|
1190
|
-
interface AddressLocation {
|
|
1245
|
+
locale?: string | null;
|
|
1191
1246
|
/**
|
|
1192
|
-
*
|
|
1193
|
-
* @
|
|
1194
|
-
* @max 90
|
|
1247
|
+
* Event ID to which the order belongs.
|
|
1248
|
+
* @format GUID
|
|
1195
1249
|
*/
|
|
1196
|
-
|
|
1250
|
+
eventId?: string;
|
|
1251
|
+
/** Unique order number. */
|
|
1252
|
+
orderNumber?: string;
|
|
1253
|
+
/** Reservation ID associated with this order. */
|
|
1254
|
+
reservationId?: string;
|
|
1197
1255
|
/**
|
|
1198
|
-
*
|
|
1199
|
-
* @
|
|
1200
|
-
* @max 180
|
|
1256
|
+
* Contact ID associated with this order.
|
|
1257
|
+
* @maxLength 36
|
|
1201
1258
|
*/
|
|
1202
|
-
|
|
1203
|
-
}
|
|
1204
|
-
interface Subdivision {
|
|
1205
|
-
/** subdivision short code */
|
|
1206
|
-
code?: string;
|
|
1207
|
-
/** subdivision full-name */
|
|
1208
|
-
name?: string;
|
|
1209
|
-
}
|
|
1210
|
-
interface ScheduleConfig {
|
|
1259
|
+
contactId?: string;
|
|
1211
1260
|
/**
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
1214
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1261
|
+
* Member ID associated with this order.
|
|
1262
|
+
* @format GUID
|
|
1215
1263
|
*/
|
|
1216
|
-
|
|
1264
|
+
memberId?: string | null;
|
|
1217
1265
|
/**
|
|
1218
|
-
*
|
|
1219
|
-
* @
|
|
1266
|
+
* Date and time the order was created.
|
|
1267
|
+
* @readonly
|
|
1220
1268
|
*/
|
|
1221
|
-
|
|
1222
|
-
/** Event start timestamp. */
|
|
1223
|
-
startDate?: Date | null;
|
|
1224
|
-
/** Event end timestamp. */
|
|
1225
|
-
endDate?: Date | null;
|
|
1269
|
+
created?: Date | null;
|
|
1226
1270
|
/**
|
|
1227
|
-
*
|
|
1228
|
-
* @maxLength
|
|
1271
|
+
* Buyer first name.
|
|
1272
|
+
* @maxLength 255
|
|
1229
1273
|
*/
|
|
1230
|
-
|
|
1231
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
1232
|
-
endDateHidden?: boolean;
|
|
1233
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
1234
|
-
showTimeZone?: boolean;
|
|
1235
|
-
/** Event recurrences. */
|
|
1236
|
-
recurrences?: Recurrences;
|
|
1237
|
-
}
|
|
1238
|
-
interface Recurrences {
|
|
1274
|
+
firstName?: string;
|
|
1239
1275
|
/**
|
|
1240
|
-
*
|
|
1241
|
-
* @
|
|
1276
|
+
* Buyer last name.
|
|
1277
|
+
* @maxLength 255
|
|
1242
1278
|
*/
|
|
1243
|
-
|
|
1279
|
+
lastName?: string;
|
|
1244
1280
|
/**
|
|
1245
|
-
*
|
|
1246
|
-
* @
|
|
1281
|
+
* Buyer email address.
|
|
1282
|
+
* @maxLength 255
|
|
1247
1283
|
*/
|
|
1248
|
-
|
|
1284
|
+
email?: string;
|
|
1285
|
+
/** Checkout form response. */
|
|
1286
|
+
checkoutForm?: FormResponse;
|
|
1287
|
+
/** Order status. */
|
|
1288
|
+
status?: OrderStatusWithLiterals;
|
|
1249
1289
|
/**
|
|
1250
|
-
*
|
|
1251
|
-
* @
|
|
1290
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
1291
|
+
* @maxLength 255
|
|
1252
1292
|
*/
|
|
1253
|
-
|
|
1254
|
-
}
|
|
1255
|
-
interface Occurrence {
|
|
1256
|
-
/** Event start timestamp. */
|
|
1257
|
-
startDate?: Date | null;
|
|
1258
|
-
/** Event end timestamp. */
|
|
1259
|
-
endDate?: Date | null;
|
|
1293
|
+
method?: string | null;
|
|
1260
1294
|
/**
|
|
1261
|
-
*
|
|
1262
|
-
* @
|
|
1295
|
+
* Tickets (generated after payment).
|
|
1296
|
+
* @maxSize 50
|
|
1263
1297
|
*/
|
|
1264
|
-
|
|
1265
|
-
/**
|
|
1266
|
-
|
|
1267
|
-
}
|
|
1268
|
-
declare enum Status {
|
|
1269
|
-
/** Event occurs only once. */
|
|
1270
|
-
ONE_TIME = "ONE_TIME",
|
|
1271
|
-
/** Event is recurring. */
|
|
1272
|
-
RECURRING = "RECURRING",
|
|
1273
|
-
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1274
|
-
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1275
|
-
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1276
|
-
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1277
|
-
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1278
|
-
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1279
|
-
}
|
|
1280
|
-
/** @enumType */
|
|
1281
|
-
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
1282
|
-
declare enum EventStatus {
|
|
1283
|
-
/** Event is public and scheduled to start */
|
|
1284
|
-
SCHEDULED = "SCHEDULED",
|
|
1285
|
-
/** Event has started */
|
|
1286
|
-
STARTED = "STARTED",
|
|
1287
|
-
/** Event has ended */
|
|
1288
|
-
ENDED = "ENDED",
|
|
1289
|
-
/** Event was canceled */
|
|
1290
|
-
CANCELED = "CANCELED"
|
|
1298
|
+
tickets?: Ticket[];
|
|
1299
|
+
/** Invoice. */
|
|
1300
|
+
invoice?: Invoice;
|
|
1291
1301
|
}
|
|
1292
|
-
|
|
1293
|
-
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
1294
|
-
interface MessageEnvelope {
|
|
1302
|
+
interface TicketPdfResolved {
|
|
1295
1303
|
/**
|
|
1296
|
-
*
|
|
1297
|
-
* @
|
|
1304
|
+
* Optional order number
|
|
1305
|
+
* @maxLength 36
|
|
1298
1306
|
*/
|
|
1299
|
-
|
|
1307
|
+
orderNumber?: string | null;
|
|
1300
1308
|
/**
|
|
1301
|
-
*
|
|
1302
|
-
* @maxLength
|
|
1309
|
+
* Optional ticket number
|
|
1310
|
+
* @maxLength 36
|
|
1303
1311
|
*/
|
|
1304
|
-
|
|
1305
|
-
/** The identification type and identity data. */
|
|
1306
|
-
identity?: IdentificationData;
|
|
1307
|
-
/** Stringify payload. */
|
|
1308
|
-
data?: string;
|
|
1309
|
-
/** Details related to the account */
|
|
1310
|
-
accountInfo?: AccountInfo;
|
|
1311
|
-
}
|
|
1312
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1312
|
+
ticketNumber?: string | null;
|
|
1313
1313
|
/**
|
|
1314
|
-
*
|
|
1315
|
-
* @format
|
|
1314
|
+
* Resolved download url
|
|
1315
|
+
* @format WEB_URL
|
|
1316
1316
|
*/
|
|
1317
|
-
|
|
1317
|
+
downloadUrl?: string | null;
|
|
1318
|
+
/** Resolve status */
|
|
1319
|
+
resolveFailed?: boolean | null;
|
|
1318
1320
|
/**
|
|
1319
|
-
*
|
|
1321
|
+
* Papyrus document id
|
|
1320
1322
|
* @format GUID
|
|
1321
1323
|
*/
|
|
1322
|
-
|
|
1324
|
+
documentId?: string | null;
|
|
1325
|
+
}
|
|
1326
|
+
interface TicketPdfResolveDelayed {
|
|
1323
1327
|
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @
|
|
1328
|
+
* Optional order number
|
|
1329
|
+
* @maxLength 36
|
|
1326
1330
|
*/
|
|
1327
|
-
|
|
1331
|
+
orderNumber?: string | null;
|
|
1328
1332
|
/**
|
|
1329
|
-
*
|
|
1333
|
+
* Optional ticket number
|
|
1334
|
+
* @maxLength 36
|
|
1335
|
+
*/
|
|
1336
|
+
ticketNumber?: string | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* Papyrus document id
|
|
1330
1339
|
* @format GUID
|
|
1331
1340
|
*/
|
|
1332
|
-
|
|
1333
|
-
/** @readonly */
|
|
1334
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1341
|
+
documentId?: string | null;
|
|
1335
1342
|
}
|
|
1336
|
-
/**
|
|
1337
|
-
interface
|
|
1343
|
+
/** Triggered when an order is canceled. */
|
|
1344
|
+
interface OrderCanceled {
|
|
1338
1345
|
/**
|
|
1339
|
-
* ID
|
|
1346
|
+
* Event ID to which the order belongs.
|
|
1340
1347
|
* @format GUID
|
|
1341
1348
|
*/
|
|
1342
|
-
|
|
1349
|
+
eventId?: string;
|
|
1343
1350
|
/**
|
|
1344
|
-
*
|
|
1345
|
-
* @
|
|
1351
|
+
* Unique order number.
|
|
1352
|
+
* @maxLength 36
|
|
1346
1353
|
*/
|
|
1347
|
-
|
|
1354
|
+
orderNumber?: string;
|
|
1348
1355
|
/**
|
|
1349
|
-
* ID
|
|
1356
|
+
* Reservation ID associated with the order.
|
|
1350
1357
|
* @format GUID
|
|
1351
1358
|
*/
|
|
1352
|
-
|
|
1359
|
+
reservationId?: string;
|
|
1353
1360
|
/**
|
|
1354
|
-
* ID
|
|
1355
|
-
* @
|
|
1361
|
+
* Contact ID associated with the order.
|
|
1362
|
+
* @maxLength 36
|
|
1356
1363
|
*/
|
|
1357
|
-
|
|
1358
|
-
}
|
|
1359
|
-
declare enum WebhookIdentityType {
|
|
1360
|
-
UNKNOWN = "UNKNOWN",
|
|
1361
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1362
|
-
MEMBER = "MEMBER",
|
|
1363
|
-
WIX_USER = "WIX_USER",
|
|
1364
|
-
APP = "APP"
|
|
1365
|
-
}
|
|
1366
|
-
/** @enumType */
|
|
1367
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1368
|
-
interface AccountInfo {
|
|
1364
|
+
contactId?: string;
|
|
1369
1365
|
/**
|
|
1370
|
-
*
|
|
1371
|
-
* @
|
|
1366
|
+
* Buyer first name.
|
|
1367
|
+
* @maxLength 50
|
|
1372
1368
|
*/
|
|
1373
|
-
|
|
1369
|
+
firstName?: string | null;
|
|
1374
1370
|
/**
|
|
1375
|
-
*
|
|
1376
|
-
* @
|
|
1371
|
+
* Buyer last name.
|
|
1372
|
+
* @maxLength 50
|
|
1377
1373
|
*/
|
|
1378
|
-
|
|
1374
|
+
lastName?: string | null;
|
|
1379
1375
|
/**
|
|
1380
|
-
*
|
|
1381
|
-
* @
|
|
1376
|
+
* Buyer email address.
|
|
1377
|
+
* @maxLength 255
|
|
1382
1378
|
*/
|
|
1383
|
-
|
|
1379
|
+
email?: string | null;
|
|
1380
|
+
/** Checkout form response. */
|
|
1381
|
+
checkoutForm?: FormResponse;
|
|
1382
|
+
/** Invoice. */
|
|
1383
|
+
invoice?: Invoice;
|
|
1384
1384
|
}
|
|
1385
1385
|
|
|
1386
1386
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
@@ -1393,12 +1393,12 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1393
1393
|
__responseType: Q;
|
|
1394
1394
|
__originalResponseType: R;
|
|
1395
1395
|
};
|
|
1396
|
-
declare function triggerNotification(): __PublicMethodMetaInfo<'POST', {}, TriggerNotificationRequest$1, TriggerNotificationRequest, TriggerNotificationResponse$1, TriggerNotificationResponse>;
|
|
1397
1396
|
declare function resolveNotificationConfig(): __PublicMethodMetaInfo<'GET', {
|
|
1398
1397
|
notificationConfigId: string;
|
|
1399
1398
|
}, ResolveNotificationConfigRequest$1, ResolveNotificationConfigRequest, ResolveNotificationConfigResponse$1, ResolveNotificationConfigResponse>;
|
|
1400
1399
|
declare function upsertNotificationConfig(): __PublicMethodMetaInfo<'POST', {
|
|
1401
1400
|
notificationConfigId: string;
|
|
1402
1401
|
}, UpsertNotificationConfigRequest$1, UpsertNotificationConfigRequest, UpsertNotificationConfigResponse$1, UpsertNotificationConfigResponse>;
|
|
1402
|
+
declare function triggerNotification(): __PublicMethodMetaInfo<'POST', {}, TriggerNotificationRequest$1, TriggerNotificationRequest, TriggerNotificationResponse$1, TriggerNotificationResponse>;
|
|
1403
1403
|
|
|
1404
1404
|
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type CheckIn as CheckInOriginal, type CommonAddressLocation as CommonAddressLocationOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type CommonStreetAddress as CommonStreetAddressOriginal, type CommonSubdivision as CommonSubdivisionOriginal, type CouponDiscount as CouponDiscountOriginal, type DiscountItemDiscountOneOf as DiscountItemDiscountOneOfOriginal, type DiscountItem as DiscountItemOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EmailNotificationConfig as EmailNotificationConfigOriginal, EmailNotificationReminderTime as EmailNotificationReminderTimeOriginal, type EmailNotificationReminderTimeWithLiterals as EmailNotificationReminderTimeWithLiteralsOriginal, EmailNotificationType as EmailNotificationTypeOriginal, type EmailNotificationTypeWithLiterals as EmailNotificationTypeWithLiteralsOriginal, type EmailTemplate as EmailTemplateOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EventCanceled as EventCanceledOriginal, type EventCopied as EventCopiedOriginal, type EventDeleted as EventDeletedOriginal, type EventGuests as EventGuestsOriginal, EventStatus as EventStatusOriginal, type EventStatusWithLiterals as EventStatusWithLiteralsOriginal, FeeName as FeeNameOriginal, type FeeNameWithLiterals as FeeNameWithLiteralsOriginal, type Fee as FeeOriginal, FeeType as FeeTypeOriginal, type FeeTypeWithLiterals as FeeTypeWithLiteralsOriginal, type FormResponse as FormResponseOriginal, type FormattedAddress as FormattedAddressOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InputValue as InputValueOriginal, type Invoice as InvoiceOriginal, type Item as ItemOriginal, type Link as LinkOriginal, type Location as LocationOriginal, LocationType as LocationTypeOriginal, type LocationTypeWithLiterals as LocationTypeWithLiteralsOriginal, type MapCoordinates as MapCoordinatesOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type NotificationConfig as NotificationConfigOriginal, type Occurrence as OccurrenceOriginal, type OnlineConferencingLogin as OnlineConferencingLoginOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderConfirmed as OrderConfirmedOriginal, type OrderEmailAdded as OrderEmailAddedOriginal, type OrderGuest as OrderGuestOriginal, type OrderPaid as OrderPaidOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOfOriginal, type PaidPlanDiscount as PaidPlanDiscountOriginal, type PercentDiscount as PercentDiscountOriginal, PushNotificationType as PushNotificationTypeOriginal, type PushNotificationTypeWithLiterals as PushNotificationTypeWithLiteralsOriginal, type Recurrences as RecurrencesOriginal, type ResolveEmailNotificationConfigRequest as ResolveEmailNotificationConfigRequestOriginal, type ResolveEmailNotificationConfigResponse as ResolveEmailNotificationConfigResponseOriginal, type ResolveNotificationConfigRequest as ResolveNotificationConfigRequestOriginal, type ResolveNotificationConfigResponse as ResolveNotificationConfigResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RsvpGuest as RsvpGuestOriginal, type ScheduleConfig as ScheduleConfigOriginal, type StandardDetails as StandardDetailsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type Tax as TaxOriginal, TaxType as TaxTypeOriginal, type TaxTypeWithLiterals as TaxTypeWithLiteralsOriginal, type TicketGuest as TicketGuestOriginal, type Ticket as TicketOriginal, type TicketPdfResolveDelayed as TicketPdfResolveDelayedOriginal, type TicketPdfResolved as TicketPdfResolvedOriginal, type TriggerNotificationRequestGuestsOneOf as TriggerNotificationRequestGuestsOneOfOriginal, type TriggerNotificationRequestNotificationOneOf as TriggerNotificationRequestNotificationOneOfOriginal, type TriggerNotificationRequest as TriggerNotificationRequestOriginal, type TriggerNotificationResponse as TriggerNotificationResponseOriginal, type UpsertNotificationConfigRequest as UpsertNotificationConfigRequestOriginal, type UpsertNotificationConfigResponse as UpsertNotificationConfigResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, resolveNotificationConfig, triggerNotification, upsertNotificationConfig };
|