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