@wix/auto_sdk_events_notifications 1.0.70 → 1.0.71
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 +968 -968
- package/build/cjs/index.typings.js +91 -91
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +938 -938
- 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 +968 -968
- package/build/es/index.typings.mjs +91 -91
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +938 -938
- 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 +968 -968
- 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 +938 -938
- 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 +968 -968
- 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 +938 -938
- 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,348 @@ 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
|
|
413
|
+
interface Occurrence {
|
|
414
|
+
/** Event start timestamp. */
|
|
415
|
+
startDate?: Date | null;
|
|
416
|
+
/** Event end timestamp. */
|
|
417
|
+
endDate?: Date | null;
|
|
548
418
|
/**
|
|
549
|
-
*
|
|
550
|
-
* @
|
|
551
|
-
* @readonly
|
|
419
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
420
|
+
* @maxLength 100
|
|
552
421
|
*/
|
|
553
|
-
|
|
422
|
+
timeZoneId?: string | null;
|
|
423
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
424
|
+
showTimeZone?: boolean;
|
|
425
|
+
}
|
|
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"
|
|
437
|
+
}
|
|
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. */
|
|
458
|
+
_id?: string;
|
|
554
459
|
/**
|
|
555
|
-
*
|
|
556
|
-
*
|
|
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`.
|
|
557
462
|
*/
|
|
558
|
-
|
|
559
|
-
}
|
|
560
|
-
interface Invoice {
|
|
561
|
-
items?: Item[];
|
|
463
|
+
entityFqdn?: string;
|
|
562
464
|
/**
|
|
563
|
-
*
|
|
564
|
-
*
|
|
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`.
|
|
565
467
|
*/
|
|
566
|
-
|
|
567
|
-
/**
|
|
568
|
-
|
|
569
|
-
/**
|
|
570
|
-
|
|
571
|
-
/** Total cart amount before discount, tax, and fees. */
|
|
572
|
-
subTotal?: Money;
|
|
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;
|
|
573
473
|
/**
|
|
574
|
-
*
|
|
575
|
-
*
|
|
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.
|
|
474
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
475
|
+
* (for example, GDPR).
|
|
580
476
|
*/
|
|
581
|
-
|
|
477
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
478
|
+
/** If present, indicates the action that triggered the event. */
|
|
479
|
+
originatedFrom?: string | null;
|
|
582
480
|
/**
|
|
583
|
-
*
|
|
584
|
-
*
|
|
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.
|
|
585
483
|
*/
|
|
586
|
-
|
|
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;
|
|
484
|
+
entityEventSequence?: string | null;
|
|
591
485
|
}
|
|
592
|
-
|
|
486
|
+
/** @oneof */
|
|
487
|
+
interface DomainEventBodyOneOf {
|
|
488
|
+
createdEvent?: EntityCreatedEvent;
|
|
489
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
490
|
+
deletedEvent?: EntityDeletedEvent;
|
|
491
|
+
actionEvent?: ActionEvent;
|
|
492
|
+
}
|
|
493
|
+
interface EntityCreatedEvent {
|
|
494
|
+
entity?: string;
|
|
495
|
+
}
|
|
496
|
+
interface RestoreInfo {
|
|
497
|
+
deletedDate?: Date | null;
|
|
498
|
+
}
|
|
499
|
+
interface EntityUpdatedEvent {
|
|
593
500
|
/**
|
|
594
|
-
*
|
|
595
|
-
*
|
|
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.
|
|
596
504
|
*/
|
|
597
|
-
|
|
505
|
+
currentEntity?: string;
|
|
506
|
+
}
|
|
507
|
+
interface EntityDeletedEvent {
|
|
508
|
+
/** Entity that was deleted. */
|
|
509
|
+
deletedEntity?: string | null;
|
|
510
|
+
}
|
|
511
|
+
interface ActionEvent {
|
|
512
|
+
body?: string;
|
|
513
|
+
}
|
|
514
|
+
interface MessageEnvelope {
|
|
598
515
|
/**
|
|
599
|
-
*
|
|
600
|
-
* @
|
|
601
|
-
* @max 50
|
|
516
|
+
* App instance ID.
|
|
517
|
+
* @format GUID
|
|
602
518
|
*/
|
|
603
|
-
|
|
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;
|
|
519
|
+
instanceId?: string | null;
|
|
614
520
|
/**
|
|
615
|
-
*
|
|
616
|
-
* @
|
|
521
|
+
* Event type.
|
|
522
|
+
* @maxLength 150
|
|
617
523
|
*/
|
|
618
|
-
|
|
524
|
+
eventType?: string;
|
|
525
|
+
/** The identification type and identity data. */
|
|
526
|
+
identity?: IdentificationData;
|
|
527
|
+
/** Stringify payload. */
|
|
528
|
+
data?: string;
|
|
529
|
+
/** Details related to the account */
|
|
530
|
+
accountInfo?: AccountInfo;
|
|
619
531
|
}
|
|
620
|
-
interface
|
|
621
|
-
/** Total discount amount. */
|
|
622
|
-
amount?: Money;
|
|
623
|
-
/** Total sum after the discount. */
|
|
624
|
-
afterDiscount?: Money;
|
|
532
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
625
533
|
/**
|
|
626
|
-
*
|
|
627
|
-
* @
|
|
534
|
+
* ID of a site visitor that has not logged in to the site.
|
|
535
|
+
* @format GUID
|
|
628
536
|
*/
|
|
629
|
-
|
|
537
|
+
anonymousVisitorId?: string;
|
|
630
538
|
/**
|
|
631
|
-
*
|
|
632
|
-
* @
|
|
539
|
+
* ID of a site visitor that has logged in to the site.
|
|
540
|
+
* @format GUID
|
|
633
541
|
*/
|
|
634
|
-
|
|
542
|
+
memberId?: string;
|
|
635
543
|
/**
|
|
636
|
-
*
|
|
637
|
-
* @
|
|
544
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
545
|
+
* @format GUID
|
|
638
546
|
*/
|
|
639
|
-
|
|
640
|
-
/**
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
paidPlan?: PaidPlanDiscount;
|
|
648
|
-
/** Total discount amount. */
|
|
649
|
-
amount?: Money;
|
|
650
|
-
}
|
|
651
|
-
/** @oneof */
|
|
652
|
-
interface DiscountItemDiscountOneOf {
|
|
653
|
-
/** Coupon discount. */
|
|
654
|
-
coupon?: CouponDiscount;
|
|
655
|
-
/** Pricing plan discount. */
|
|
656
|
-
paidPlan?: PaidPlanDiscount;
|
|
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;
|
|
665
|
-
}
|
|
666
|
-
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
667
|
-
/** Discount by percentage applied to tickets. */
|
|
668
|
-
percentDiscount?: PercentDiscount;
|
|
669
|
-
/** Name of pricing plan. */
|
|
670
|
-
name?: string;
|
|
547
|
+
wixUserId?: string;
|
|
548
|
+
/**
|
|
549
|
+
* ID of an app.
|
|
550
|
+
* @format GUID
|
|
551
|
+
*/
|
|
552
|
+
appId?: string;
|
|
553
|
+
/** @readonly */
|
|
554
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
671
555
|
}
|
|
672
556
|
/** @oneof */
|
|
673
|
-
interface
|
|
674
|
-
/** Discount by percentage applied to tickets. */
|
|
675
|
-
percentDiscount?: PercentDiscount;
|
|
676
|
-
}
|
|
677
|
-
interface PercentDiscount {
|
|
557
|
+
interface IdentificationDataIdOneOf {
|
|
678
558
|
/**
|
|
679
|
-
*
|
|
680
|
-
* @
|
|
559
|
+
* ID of a site visitor that has not logged in to the site.
|
|
560
|
+
* @format GUID
|
|
681
561
|
*/
|
|
682
|
-
|
|
683
|
-
/** Number of discounted tickets. */
|
|
684
|
-
quantityDiscounted?: number;
|
|
685
|
-
}
|
|
686
|
-
interface Tax {
|
|
687
|
-
/** Tax type. */
|
|
688
|
-
type?: TaxTypeWithLiterals;
|
|
562
|
+
anonymousVisitorId?: string;
|
|
689
563
|
/**
|
|
690
|
-
*
|
|
691
|
-
* @
|
|
564
|
+
* ID of a site visitor that has logged in to the site.
|
|
565
|
+
* @format GUID
|
|
692
566
|
*/
|
|
693
|
-
|
|
567
|
+
memberId?: string;
|
|
694
568
|
/**
|
|
695
|
-
*
|
|
696
|
-
* @format
|
|
569
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
570
|
+
* @format GUID
|
|
697
571
|
*/
|
|
698
|
-
|
|
699
|
-
/** Taxable amount. */
|
|
700
|
-
taxable?: Money;
|
|
701
|
-
/** Total tax amount. */
|
|
702
|
-
amount?: Money;
|
|
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"
|
|
711
|
-
}
|
|
712
|
-
/** @enumType */
|
|
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;
|
|
572
|
+
wixUserId?: string;
|
|
719
573
|
/**
|
|
720
|
-
*
|
|
721
|
-
* @format
|
|
722
|
-
* @readonly
|
|
574
|
+
* ID of an app.
|
|
575
|
+
* @format GUID
|
|
723
576
|
*/
|
|
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"
|
|
577
|
+
appId?: string;
|
|
731
578
|
}
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
FEE_INCLUDED = "FEE_INCLUDED",
|
|
739
|
-
/** Fee is added to the ticket price at checkout. */
|
|
740
|
-
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
579
|
+
declare enum WebhookIdentityType {
|
|
580
|
+
UNKNOWN = "UNKNOWN",
|
|
581
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
582
|
+
MEMBER = "MEMBER",
|
|
583
|
+
WIX_USER = "WIX_USER",
|
|
584
|
+
APP = "APP"
|
|
741
585
|
}
|
|
742
586
|
/** @enumType */
|
|
743
|
-
type
|
|
744
|
-
|
|
745
|
-
interface OrderEmailAdded {
|
|
746
|
-
/** Order updated timestamp in ISO UTC format. */
|
|
747
|
-
timestamp?: Date | null;
|
|
748
|
-
/**
|
|
749
|
-
* Site language when Order initiated
|
|
750
|
-
* @format LANGUAGE
|
|
751
|
-
*/
|
|
752
|
-
language?: string | null;
|
|
753
|
-
/**
|
|
754
|
-
* Locale in which Order was created.
|
|
755
|
-
* @format LANGUAGE_TAG
|
|
756
|
-
*/
|
|
757
|
-
locale?: string | null;
|
|
758
|
-
/** Notifications silenced for this domain event. */
|
|
759
|
-
silent?: boolean | null;
|
|
587
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
588
|
+
interface AccountInfo {
|
|
760
589
|
/**
|
|
761
|
-
*
|
|
590
|
+
* ID of the Wix account associated with the event.
|
|
762
591
|
* @format GUID
|
|
763
592
|
*/
|
|
764
|
-
|
|
765
|
-
/**
|
|
766
|
-
* Unique order number.
|
|
767
|
-
* @maxLength 36
|
|
768
|
-
*/
|
|
769
|
-
orderNumber?: string;
|
|
593
|
+
accountId?: string | null;
|
|
770
594
|
/**
|
|
771
|
-
*
|
|
595
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
772
596
|
* @format GUID
|
|
773
597
|
*/
|
|
774
|
-
|
|
598
|
+
parentAccountId?: string | null;
|
|
775
599
|
/**
|
|
776
|
-
*
|
|
600
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
777
601
|
* @format GUID
|
|
778
602
|
*/
|
|
779
|
-
|
|
603
|
+
siteId?: string | null;
|
|
604
|
+
}
|
|
605
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
606
|
+
/** Email notification type */
|
|
607
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
608
|
+
/** Push notification type */
|
|
609
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
610
|
+
/** Rsvp guest info */
|
|
611
|
+
rsvpGuest?: RsvpGuest;
|
|
612
|
+
/** Order guest info */
|
|
613
|
+
orderGuest?: OrderGuest;
|
|
614
|
+
/** Event guests info */
|
|
615
|
+
eventGuests?: EventGuests;
|
|
616
|
+
/** Ticket guests info */
|
|
617
|
+
ticketGuest?: TicketGuest;
|
|
618
|
+
}
|
|
619
|
+
/** @oneof */
|
|
620
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
621
|
+
/** Email notification type */
|
|
622
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
623
|
+
/** Push notification type */
|
|
624
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
625
|
+
}
|
|
626
|
+
/** @oneof */
|
|
627
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
628
|
+
/** Rsvp guest info */
|
|
629
|
+
rsvpGuest?: RsvpGuest;
|
|
630
|
+
/** Order guest info */
|
|
631
|
+
orderGuest?: OrderGuest;
|
|
632
|
+
/** Event guests info */
|
|
633
|
+
eventGuests?: EventGuests;
|
|
634
|
+
/** Ticket guests info */
|
|
635
|
+
ticketGuest?: TicketGuest;
|
|
636
|
+
}
|
|
637
|
+
declare enum PushNotificationType {
|
|
638
|
+
/** This is default value. This value is unused. */
|
|
639
|
+
UNKNOWN_PUSH_TYPE = "UNKNOWN_PUSH_TYPE",
|
|
640
|
+
/** Triggered when event is updated. */
|
|
641
|
+
PUSH_EVENT_UPDATED = "PUSH_EVENT_UPDATED",
|
|
642
|
+
/** Triggered when event is canceled. */
|
|
643
|
+
PUSH_EVENT_CANCELATION = "PUSH_EVENT_CANCELATION",
|
|
644
|
+
/** Triggered before the event start time. */
|
|
645
|
+
PUSH_UPCOMING_EVENT_REMINDER = "PUSH_UPCOMING_EVENT_REMINDER",
|
|
646
|
+
/** Triggered when event is created. */
|
|
647
|
+
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
648
|
+
}
|
|
649
|
+
/** @enumType */
|
|
650
|
+
type PushNotificationTypeWithLiterals = PushNotificationType | 'UNKNOWN_PUSH_TYPE' | 'PUSH_EVENT_UPDATED' | 'PUSH_EVENT_CANCELATION' | 'PUSH_UPCOMING_EVENT_REMINDER' | 'PUSH_EVENT_CREATED';
|
|
651
|
+
/** Single guest associated to the RSVP */
|
|
652
|
+
interface RsvpGuest {
|
|
780
653
|
/**
|
|
781
|
-
*
|
|
782
|
-
* @
|
|
654
|
+
* Event id
|
|
655
|
+
* @format GUID
|
|
783
656
|
*/
|
|
784
|
-
|
|
657
|
+
eventId?: string;
|
|
785
658
|
/**
|
|
786
|
-
*
|
|
787
|
-
* @
|
|
659
|
+
* Rsvp id
|
|
660
|
+
* @format GUID
|
|
788
661
|
*/
|
|
789
|
-
|
|
662
|
+
rsvpId?: string;
|
|
663
|
+
}
|
|
664
|
+
/** Single guest associated to the Order */
|
|
665
|
+
interface OrderGuest {
|
|
790
666
|
/**
|
|
791
|
-
*
|
|
792
|
-
* @
|
|
667
|
+
* Event id
|
|
668
|
+
* @format GUID
|
|
793
669
|
*/
|
|
794
|
-
|
|
670
|
+
eventId?: string;
|
|
795
671
|
/**
|
|
796
|
-
*
|
|
797
|
-
* @maxLength
|
|
672
|
+
* Order number
|
|
673
|
+
* @maxLength 36
|
|
798
674
|
*/
|
|
799
|
-
|
|
675
|
+
orderNumber?: string;
|
|
676
|
+
}
|
|
677
|
+
/** All event guest from RSVPs and Orders */
|
|
678
|
+
interface EventGuests {
|
|
800
679
|
/**
|
|
801
|
-
*
|
|
802
|
-
* @format
|
|
680
|
+
* Event id
|
|
681
|
+
* @format GUID
|
|
803
682
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
confirmed?: boolean;
|
|
809
|
-
/** Order status. */
|
|
810
|
-
status?: OrderStatusWithLiterals;
|
|
683
|
+
eventId?: string;
|
|
684
|
+
}
|
|
685
|
+
/** Multiple guests associated to Tickets */
|
|
686
|
+
interface TicketGuest {
|
|
811
687
|
/**
|
|
812
|
-
*
|
|
813
|
-
* @
|
|
688
|
+
* Event id
|
|
689
|
+
* @format GUID
|
|
814
690
|
*/
|
|
815
|
-
|
|
691
|
+
eventId?: string;
|
|
816
692
|
/**
|
|
817
|
-
*
|
|
818
|
-
* @
|
|
693
|
+
* Order number
|
|
694
|
+
* @maxLength 36
|
|
819
695
|
*/
|
|
820
|
-
|
|
821
|
-
/** Whether order was archived and excluded from results. */
|
|
822
|
-
archived?: boolean;
|
|
696
|
+
orderNumber?: string | null;
|
|
823
697
|
/**
|
|
824
|
-
*
|
|
825
|
-
* @
|
|
698
|
+
* Ticket numbers must be from the same order only.
|
|
699
|
+
* @minSize 1
|
|
700
|
+
* @maxSize 100
|
|
701
|
+
* @maxLength 36
|
|
826
702
|
*/
|
|
827
|
-
|
|
828
|
-
/** Whether marketing consent was given. */
|
|
829
|
-
marketingConsent?: boolean | null;
|
|
703
|
+
ticketNumber?: string[];
|
|
830
704
|
}
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
705
|
+
interface TriggerNotificationResponse {
|
|
706
|
+
}
|
|
707
|
+
/** Triggered when an order is confirmed. */
|
|
708
|
+
interface OrderConfirmed {
|
|
709
|
+
/** Date and time the order was confirmed. */
|
|
834
710
|
timestamp?: Date | null;
|
|
835
711
|
/**
|
|
836
712
|
* Site language when the order was initiated.
|
|
@@ -851,15 +727,10 @@ interface OrderPaid {
|
|
|
851
727
|
eventId?: string;
|
|
852
728
|
/** Unique order number. */
|
|
853
729
|
orderNumber?: string;
|
|
854
|
-
/**
|
|
855
|
-
reservationId?: string;
|
|
856
|
-
/**
|
|
857
|
-
* Contact ID associated with this order.
|
|
858
|
-
* @maxLength 36
|
|
859
|
-
*/
|
|
730
|
+
/** Contact ID associated with the order. */
|
|
860
731
|
contactId?: string;
|
|
861
732
|
/**
|
|
862
|
-
* Member ID associated with
|
|
733
|
+
* Member ID associated with the order.
|
|
863
734
|
* @format GUID
|
|
864
735
|
*/
|
|
865
736
|
memberId?: string | null;
|
|
@@ -868,517 +739,646 @@ interface OrderPaid {
|
|
|
868
739
|
* @readonly
|
|
869
740
|
*/
|
|
870
741
|
created?: Date | null;
|
|
871
|
-
/**
|
|
872
|
-
* Buyer first name.
|
|
873
|
-
* @maxLength 255
|
|
874
|
-
*/
|
|
742
|
+
/** Buyer first name. */
|
|
875
743
|
firstName?: string;
|
|
876
|
-
/**
|
|
877
|
-
* Buyer last name.
|
|
878
|
-
* @maxLength 255
|
|
879
|
-
*/
|
|
744
|
+
/** Buyer last name. */
|
|
880
745
|
lastName?: string;
|
|
881
|
-
/**
|
|
882
|
-
* Buyer email address.
|
|
883
|
-
* @maxLength 255
|
|
884
|
-
*/
|
|
746
|
+
/** Buyer email address. */
|
|
885
747
|
email?: string;
|
|
886
748
|
/** Checkout form response. */
|
|
887
749
|
checkoutForm?: FormResponse;
|
|
888
750
|
/** Order status. */
|
|
889
751
|
status?: OrderStatusWithLiterals;
|
|
752
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
753
|
+
method?: string | null;
|
|
754
|
+
/** Tickets (generated after payment). */
|
|
755
|
+
tickets?: Ticket[];
|
|
756
|
+
/** Invoice. */
|
|
757
|
+
invoice?: Invoice;
|
|
758
|
+
/** Reservation ID associated with the order. */
|
|
759
|
+
reservationId?: string;
|
|
760
|
+
}
|
|
761
|
+
interface FormResponse {
|
|
890
762
|
/**
|
|
891
|
-
*
|
|
892
|
-
* @
|
|
763
|
+
* Form field inputs.
|
|
764
|
+
* @maxSize 200
|
|
893
765
|
*/
|
|
894
|
-
|
|
766
|
+
inputValues?: InputValue[];
|
|
767
|
+
}
|
|
768
|
+
interface InputValue {
|
|
769
|
+
/**
|
|
770
|
+
* Form field input name.
|
|
771
|
+
* @maxLength 100
|
|
772
|
+
*/
|
|
773
|
+
inputName?: string;
|
|
774
|
+
/**
|
|
775
|
+
* Form field value.
|
|
776
|
+
* @maxLength 5000
|
|
777
|
+
*/
|
|
778
|
+
value?: string;
|
|
779
|
+
/**
|
|
780
|
+
* Form field values.
|
|
781
|
+
* @maxSize 100
|
|
782
|
+
* @maxLength 5000
|
|
783
|
+
*/
|
|
784
|
+
values?: string[];
|
|
785
|
+
}
|
|
786
|
+
interface FormattedAddress {
|
|
787
|
+
/**
|
|
788
|
+
* 1-line address representation.
|
|
789
|
+
* @maxLength 200
|
|
790
|
+
*/
|
|
791
|
+
formatted?: string;
|
|
792
|
+
/** Address components. */
|
|
793
|
+
address?: CommonAddress;
|
|
794
|
+
}
|
|
795
|
+
/** Physical address */
|
|
796
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
797
|
+
/** Street name and number. */
|
|
798
|
+
streetAddress?: CommonStreetAddress;
|
|
799
|
+
/** Main address line, usually street and number as free text. */
|
|
800
|
+
addressLine1?: string | null;
|
|
801
|
+
/**
|
|
802
|
+
* Country code.
|
|
803
|
+
* @format COUNTRY
|
|
804
|
+
*/
|
|
805
|
+
country?: string | null;
|
|
806
|
+
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
807
|
+
subdivision?: string | null;
|
|
808
|
+
/** City name. */
|
|
809
|
+
city?: string | null;
|
|
810
|
+
/** Zip/postal code. */
|
|
811
|
+
postalCode?: string | null;
|
|
812
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
813
|
+
addressLine2?: string | null;
|
|
814
|
+
}
|
|
815
|
+
/** @oneof */
|
|
816
|
+
interface CommonAddressStreetOneOf {
|
|
817
|
+
/** Street name and number. */
|
|
818
|
+
streetAddress?: CommonStreetAddress;
|
|
819
|
+
/** Main address line, usually street and number as free text. */
|
|
820
|
+
addressLine?: string | null;
|
|
821
|
+
}
|
|
822
|
+
interface CommonStreetAddress {
|
|
823
|
+
/** Street number. */
|
|
824
|
+
number?: string;
|
|
825
|
+
/** Street name. */
|
|
826
|
+
name?: string;
|
|
827
|
+
}
|
|
828
|
+
interface CommonAddressLocation {
|
|
829
|
+
/** Address latitude. */
|
|
830
|
+
latitude?: number | null;
|
|
831
|
+
/** Address longitude. */
|
|
832
|
+
longitude?: number | null;
|
|
833
|
+
}
|
|
834
|
+
interface CommonSubdivision {
|
|
835
|
+
/** Short subdivision code. */
|
|
836
|
+
code?: string;
|
|
837
|
+
/** Subdivision full name. */
|
|
838
|
+
name?: string;
|
|
839
|
+
}
|
|
840
|
+
/** Subdivision Concordance values */
|
|
841
|
+
interface StandardDetails {
|
|
842
|
+
/**
|
|
843
|
+
* 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
|
|
844
|
+
* @maxLength 20
|
|
845
|
+
*/
|
|
846
|
+
iso31662?: string | null;
|
|
847
|
+
}
|
|
848
|
+
declare enum OrderStatus {
|
|
849
|
+
/** Order status isn't available for this request fieldset. */
|
|
850
|
+
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
851
|
+
/** Order is confirmed, no payment is required. */
|
|
852
|
+
FREE = "FREE",
|
|
853
|
+
/** Order was paid, but the payment gateway suspended the payment. */
|
|
854
|
+
PENDING = "PENDING",
|
|
855
|
+
/** Order is paid. */
|
|
856
|
+
PAID = "PAID",
|
|
857
|
+
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
858
|
+
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
859
|
+
/** Order is waiting for payment at the cashier. */
|
|
860
|
+
INITIATED = "INITIATED",
|
|
861
|
+
/** Order is canceled. */
|
|
862
|
+
CANCELED = "CANCELED",
|
|
863
|
+
/** Order payment is declined. */
|
|
864
|
+
DECLINED = "DECLINED",
|
|
865
|
+
/** Order payment is authorized. */
|
|
866
|
+
AUTHORIZED = "AUTHORIZED",
|
|
867
|
+
/** Order payment is voided. */
|
|
868
|
+
VOIDED = "VOIDED",
|
|
869
|
+
/** Order is partially paid with less than the total amount. */
|
|
870
|
+
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
871
|
+
}
|
|
872
|
+
/** @enumType */
|
|
873
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
874
|
+
interface Ticket {
|
|
875
|
+
/** Unique issued ticket number. */
|
|
876
|
+
ticketNumber?: string;
|
|
877
|
+
/**
|
|
878
|
+
* Ticket definition ID.
|
|
879
|
+
* @format GUID
|
|
880
|
+
*/
|
|
881
|
+
ticketDefinitionId?: string;
|
|
882
|
+
/** Ticket check-in. */
|
|
883
|
+
checkIn?: CheckIn;
|
|
884
|
+
/** Ticket price. */
|
|
885
|
+
price?: Money;
|
|
886
|
+
/** Whether ticket is archived. */
|
|
887
|
+
archived?: boolean;
|
|
888
|
+
/** Guest first name. */
|
|
889
|
+
firstName?: string | null;
|
|
890
|
+
/** Guest last name. */
|
|
891
|
+
lastName?: string | null;
|
|
892
|
+
/** Guest email. */
|
|
893
|
+
email?: string | null;
|
|
894
|
+
/**
|
|
895
|
+
* Contact ID associated with this ticket.
|
|
896
|
+
* @format GUID
|
|
897
|
+
*/
|
|
898
|
+
contactId?: string | null;
|
|
899
|
+
/** Whether ticket is confirmed */
|
|
900
|
+
confirmed?: boolean;
|
|
901
|
+
/**
|
|
902
|
+
* Member ID associated with this ticket.
|
|
903
|
+
* @format GUID
|
|
904
|
+
*/
|
|
905
|
+
memberId?: string | null;
|
|
906
|
+
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
907
|
+
form?: FormResponse;
|
|
908
|
+
/** Ticket name. */
|
|
909
|
+
ticketName?: string;
|
|
910
|
+
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
911
|
+
anonymized?: boolean;
|
|
912
|
+
/** URL and password to online conference */
|
|
913
|
+
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
914
|
+
/**
|
|
915
|
+
* Seat ID associated with this ticket.
|
|
916
|
+
* @maxLength 36
|
|
917
|
+
*/
|
|
918
|
+
seatId?: string | null;
|
|
919
|
+
/** Whether ticket is canceled. */
|
|
920
|
+
canceled?: boolean | null;
|
|
921
|
+
}
|
|
922
|
+
interface CheckIn {
|
|
923
|
+
/** Time of a ticket's check-in. */
|
|
924
|
+
created?: Date | null;
|
|
925
|
+
}
|
|
926
|
+
interface Money {
|
|
895
927
|
/**
|
|
896
|
-
*
|
|
897
|
-
* @
|
|
928
|
+
* *Deprecated:** Use `value` instead.
|
|
929
|
+
* @format DECIMAL_VALUE
|
|
930
|
+
* @deprecated
|
|
898
931
|
*/
|
|
899
|
-
|
|
900
|
-
/** Invoice. */
|
|
901
|
-
invoice?: Invoice;
|
|
902
|
-
}
|
|
903
|
-
interface TicketPdfResolved {
|
|
932
|
+
amount?: string;
|
|
904
933
|
/**
|
|
905
|
-
*
|
|
906
|
-
* @
|
|
934
|
+
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
935
|
+
* @format CURRENCY
|
|
907
936
|
*/
|
|
908
|
-
|
|
937
|
+
currency?: string;
|
|
909
938
|
/**
|
|
910
|
-
*
|
|
911
|
-
* @
|
|
939
|
+
* 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.
|
|
940
|
+
* @format DECIMAL_VALUE
|
|
912
941
|
*/
|
|
913
|
-
|
|
942
|
+
value?: string | null;
|
|
943
|
+
}
|
|
944
|
+
interface OnlineConferencingLogin {
|
|
914
945
|
/**
|
|
915
|
-
*
|
|
946
|
+
* Link URL to the online conference.
|
|
916
947
|
* @format WEB_URL
|
|
948
|
+
* @readonly
|
|
917
949
|
*/
|
|
918
|
-
|
|
919
|
-
/** Resolve status */
|
|
920
|
-
resolveFailed?: boolean | null;
|
|
950
|
+
link?: string;
|
|
921
951
|
/**
|
|
922
|
-
*
|
|
923
|
-
* @
|
|
952
|
+
* Password for the online conference.
|
|
953
|
+
* @readonly
|
|
924
954
|
*/
|
|
925
|
-
|
|
955
|
+
password?: string | null;
|
|
926
956
|
}
|
|
927
|
-
interface
|
|
957
|
+
interface Invoice {
|
|
958
|
+
items?: Item[];
|
|
928
959
|
/**
|
|
929
|
-
*
|
|
930
|
-
* @
|
|
960
|
+
* Total cart amount.
|
|
961
|
+
* @deprecated
|
|
931
962
|
*/
|
|
932
|
-
|
|
963
|
+
total?: Money;
|
|
964
|
+
/** Discount applied to a cart. */
|
|
965
|
+
discount?: Discount;
|
|
966
|
+
/** Tax applied to a cart. */
|
|
967
|
+
tax?: Tax;
|
|
968
|
+
/** Total cart amount before discount, tax, and fees. */
|
|
969
|
+
subTotal?: Money;
|
|
933
970
|
/**
|
|
934
|
-
*
|
|
935
|
-
*
|
|
971
|
+
* Total amount of a cart after discount, tax, and fees.
|
|
972
|
+
* Grand total is calculated in the following order:
|
|
973
|
+
* 1. Total prices of all items in the cart are calculated.
|
|
974
|
+
* 2. Discount is subtracted from the cart, if applicable.
|
|
975
|
+
* 3. Tax is added, if applicable.
|
|
976
|
+
* 4. Wix ticket service fee is added.
|
|
936
977
|
*/
|
|
937
|
-
|
|
978
|
+
grandTotal?: Money;
|
|
938
979
|
/**
|
|
939
|
-
*
|
|
940
|
-
* @
|
|
980
|
+
* Fees applied to the cart.
|
|
981
|
+
* @readonly
|
|
941
982
|
*/
|
|
942
|
-
|
|
983
|
+
fees?: Fee[];
|
|
984
|
+
/** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
|
|
985
|
+
revenue?: Money;
|
|
986
|
+
/** Invoice preview URL. Only returned if the order is paid. */
|
|
987
|
+
previewUrl?: string | null;
|
|
943
988
|
}
|
|
944
|
-
|
|
945
|
-
interface OrderCanceled {
|
|
989
|
+
interface Item {
|
|
946
990
|
/**
|
|
947
|
-
*
|
|
991
|
+
* Unique line item ID.
|
|
948
992
|
* @format GUID
|
|
949
993
|
*/
|
|
950
|
-
|
|
994
|
+
_id?: string;
|
|
951
995
|
/**
|
|
952
|
-
*
|
|
953
|
-
* @
|
|
996
|
+
* Line item quantity.
|
|
997
|
+
* @min 1
|
|
998
|
+
* @max 50
|
|
954
999
|
*/
|
|
955
|
-
|
|
1000
|
+
quantity?: number;
|
|
1001
|
+
/** Line item name. */
|
|
1002
|
+
name?: string;
|
|
1003
|
+
/** Line item price. */
|
|
1004
|
+
price?: Money;
|
|
1005
|
+
/** Total price for line items. Always equal to price * quantity. */
|
|
1006
|
+
total?: Money;
|
|
1007
|
+
/** Discount applied to the line item. */
|
|
1008
|
+
discount?: Discount;
|
|
1009
|
+
/** Tax applied to the item. */
|
|
1010
|
+
tax?: Tax;
|
|
956
1011
|
/**
|
|
957
|
-
*
|
|
958
|
-
* @
|
|
1012
|
+
* Fees applied to the item.
|
|
1013
|
+
* @readonly
|
|
959
1014
|
*/
|
|
960
|
-
|
|
1015
|
+
fees?: Fee[];
|
|
1016
|
+
}
|
|
1017
|
+
interface Discount {
|
|
1018
|
+
/** Total discount amount. */
|
|
1019
|
+
amount?: Money;
|
|
1020
|
+
/** Total sum after the discount. */
|
|
1021
|
+
afterDiscount?: Money;
|
|
961
1022
|
/**
|
|
962
|
-
*
|
|
963
|
-
* @
|
|
1023
|
+
* Discount coupon code.
|
|
1024
|
+
* @deprecated
|
|
964
1025
|
*/
|
|
965
|
-
|
|
1026
|
+
code?: string;
|
|
966
1027
|
/**
|
|
967
|
-
*
|
|
968
|
-
* @
|
|
1028
|
+
* Discount coupon name.
|
|
1029
|
+
* @deprecated
|
|
969
1030
|
*/
|
|
970
|
-
|
|
1031
|
+
name?: string;
|
|
971
1032
|
/**
|
|
972
|
-
*
|
|
973
|
-
* @
|
|
1033
|
+
* Discount coupon ID.
|
|
1034
|
+
* @deprecated
|
|
974
1035
|
*/
|
|
975
|
-
|
|
1036
|
+
couponId?: string;
|
|
1037
|
+
/** Discount items. */
|
|
1038
|
+
discounts?: DiscountItem[];
|
|
1039
|
+
}
|
|
1040
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
1041
|
+
/** Coupon discount. */
|
|
1042
|
+
coupon?: CouponDiscount;
|
|
1043
|
+
/** Pricing plan discount. */
|
|
1044
|
+
paidPlan?: PaidPlanDiscount;
|
|
1045
|
+
/** Total discount amount. */
|
|
1046
|
+
amount?: Money;
|
|
1047
|
+
}
|
|
1048
|
+
/** @oneof */
|
|
1049
|
+
interface DiscountItemDiscountOneOf {
|
|
1050
|
+
/** Coupon discount. */
|
|
1051
|
+
coupon?: CouponDiscount;
|
|
1052
|
+
/** Pricing plan discount. */
|
|
1053
|
+
paidPlan?: PaidPlanDiscount;
|
|
1054
|
+
}
|
|
1055
|
+
interface CouponDiscount {
|
|
1056
|
+
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
1057
|
+
name?: string;
|
|
1058
|
+
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
1059
|
+
code?: string;
|
|
1060
|
+
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
1061
|
+
couponId?: string;
|
|
1062
|
+
}
|
|
1063
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
1064
|
+
/** Discount by percentage applied to tickets. */
|
|
1065
|
+
percentDiscount?: PercentDiscount;
|
|
1066
|
+
/** Name of pricing plan. */
|
|
1067
|
+
name?: string;
|
|
1068
|
+
}
|
|
1069
|
+
/** @oneof */
|
|
1070
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
1071
|
+
/** Discount by percentage applied to tickets. */
|
|
1072
|
+
percentDiscount?: PercentDiscount;
|
|
1073
|
+
}
|
|
1074
|
+
interface PercentDiscount {
|
|
976
1075
|
/**
|
|
977
|
-
*
|
|
978
|
-
* @
|
|
1076
|
+
* Percent rate.
|
|
1077
|
+
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
979
1078
|
*/
|
|
980
|
-
|
|
981
|
-
/**
|
|
982
|
-
|
|
983
|
-
/** Invoice. */
|
|
984
|
-
invoice?: Invoice;
|
|
1079
|
+
rate?: string;
|
|
1080
|
+
/** Number of discounted tickets. */
|
|
1081
|
+
quantityDiscounted?: number;
|
|
985
1082
|
}
|
|
986
|
-
interface
|
|
1083
|
+
interface Tax {
|
|
1084
|
+
/** Tax type. */
|
|
1085
|
+
type?: TaxTypeWithLiterals;
|
|
987
1086
|
/**
|
|
988
|
-
*
|
|
989
|
-
* @
|
|
1087
|
+
* Tax name.
|
|
1088
|
+
* @readonly
|
|
990
1089
|
*/
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1090
|
+
name?: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* Tax rate.
|
|
1093
|
+
* @format DECIMAL_VALUE
|
|
1094
|
+
*/
|
|
1095
|
+
rate?: string;
|
|
1096
|
+
/** Taxable amount. */
|
|
1097
|
+
taxable?: Money;
|
|
1098
|
+
/** Total tax amount. */
|
|
1099
|
+
amount?: Money;
|
|
1000
1100
|
}
|
|
1001
|
-
|
|
1002
|
-
/**
|
|
1003
|
-
|
|
1101
|
+
declare enum TaxType {
|
|
1102
|
+
/** Tax is included in the ticket price. */
|
|
1103
|
+
INCLUDED = "INCLUDED",
|
|
1104
|
+
/** Tax is added to the order at the checkout. */
|
|
1105
|
+
ADDED = "ADDED",
|
|
1106
|
+
/** Tax is added to the final total at the checkout. */
|
|
1107
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1004
1108
|
}
|
|
1005
|
-
|
|
1109
|
+
/** @enumType */
|
|
1110
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
1111
|
+
interface Fee {
|
|
1112
|
+
/** Fee identifier. */
|
|
1113
|
+
name?: FeeNameWithLiterals;
|
|
1114
|
+
/** How fee is calculated. */
|
|
1115
|
+
type?: FeeTypeWithLiterals;
|
|
1006
1116
|
/**
|
|
1007
|
-
*
|
|
1008
|
-
* @format
|
|
1117
|
+
* Fee rate.
|
|
1118
|
+
* @format DECIMAL_VALUE
|
|
1119
|
+
* @readonly
|
|
1009
1120
|
*/
|
|
1010
|
-
|
|
1011
|
-
/**
|
|
1012
|
-
|
|
1121
|
+
rate?: string;
|
|
1122
|
+
/** Total amount of fee charges. */
|
|
1123
|
+
amount?: Money;
|
|
1013
1124
|
}
|
|
1014
|
-
|
|
1015
|
-
/**
|
|
1016
|
-
|
|
1125
|
+
declare enum FeeName {
|
|
1126
|
+
/** Wix ticket service fee charges applied to the line item. */
|
|
1127
|
+
WIX_FEE = "WIX_FEE"
|
|
1017
1128
|
}
|
|
1018
|
-
|
|
1019
|
-
|
|
1129
|
+
/** @enumType */
|
|
1130
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
1131
|
+
declare enum FeeType {
|
|
1132
|
+
/** Fee is added to the ticket price at checkout. */
|
|
1133
|
+
FEE_ADDED = "FEE_ADDED",
|
|
1134
|
+
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
1135
|
+
FEE_INCLUDED = "FEE_INCLUDED",
|
|
1136
|
+
/** Fee is added to the ticket price at checkout. */
|
|
1137
|
+
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
1138
|
+
}
|
|
1139
|
+
/** @enumType */
|
|
1140
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
1141
|
+
/** Produced if a buyer email was added to the existing order */
|
|
1142
|
+
interface OrderEmailAdded {
|
|
1143
|
+
/** Order updated timestamp in ISO UTC format. */
|
|
1020
1144
|
timestamp?: Date | null;
|
|
1021
1145
|
/**
|
|
1022
|
-
*
|
|
1023
|
-
* @format
|
|
1146
|
+
* Site language when Order initiated
|
|
1147
|
+
* @format LANGUAGE
|
|
1024
1148
|
*/
|
|
1025
|
-
|
|
1026
|
-
/** Event title */
|
|
1027
|
-
title?: string;
|
|
1149
|
+
language?: string | null;
|
|
1028
1150
|
/**
|
|
1029
|
-
*
|
|
1030
|
-
* @format
|
|
1151
|
+
* Locale in which Order was created.
|
|
1152
|
+
* @format LANGUAGE_TAG
|
|
1031
1153
|
*/
|
|
1032
|
-
|
|
1033
|
-
/**
|
|
1034
|
-
|
|
1035
|
-
}
|
|
1036
|
-
interface EventDeleted {
|
|
1037
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
1038
|
-
timestamp?: Date | null;
|
|
1154
|
+
locale?: string | null;
|
|
1155
|
+
/** Notifications silenced for this domain event. */
|
|
1156
|
+
silent?: boolean | null;
|
|
1039
1157
|
/**
|
|
1040
1158
|
* Event ID.
|
|
1041
1159
|
* @format GUID
|
|
1042
1160
|
*/
|
|
1043
1161
|
eventId?: string;
|
|
1044
|
-
/** Event title. */
|
|
1045
|
-
title?: string;
|
|
1046
|
-
/**
|
|
1047
|
-
* Event creator user ID.
|
|
1048
|
-
* @format GUID
|
|
1049
|
-
*/
|
|
1050
|
-
userId?: string | null;
|
|
1051
|
-
}
|
|
1052
|
-
interface EventCopied {
|
|
1053
|
-
/** Event created timestamp in ISO UTC format. */
|
|
1054
|
-
timestamp?: Date | null;
|
|
1055
1162
|
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @
|
|
1163
|
+
* Unique order number.
|
|
1164
|
+
* @maxLength 36
|
|
1058
1165
|
*/
|
|
1059
|
-
|
|
1060
|
-
/** Event location. */
|
|
1061
|
-
location?: Location;
|
|
1062
|
-
/** Event schedule configuration. */
|
|
1063
|
-
scheduleConfig?: ScheduleConfig;
|
|
1064
|
-
/** Event title. */
|
|
1065
|
-
title?: string;
|
|
1166
|
+
orderNumber?: string;
|
|
1066
1167
|
/**
|
|
1067
|
-
*
|
|
1168
|
+
* Contact ID associated with this order.
|
|
1068
1169
|
* @format GUID
|
|
1069
1170
|
*/
|
|
1070
|
-
|
|
1071
|
-
/** Event status. */
|
|
1072
|
-
status?: EventStatusWithLiterals;
|
|
1171
|
+
contactId?: string | null;
|
|
1073
1172
|
/**
|
|
1074
|
-
*
|
|
1173
|
+
* Member ID associated with this order.
|
|
1075
1174
|
* @format GUID
|
|
1076
1175
|
*/
|
|
1077
|
-
|
|
1176
|
+
memberId?: string | null;
|
|
1078
1177
|
/**
|
|
1079
|
-
*
|
|
1080
|
-
* @
|
|
1178
|
+
* Order created timestamp.
|
|
1179
|
+
* @readonly
|
|
1081
1180
|
*/
|
|
1082
|
-
|
|
1181
|
+
created?: Date | null;
|
|
1083
1182
|
/**
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1086
|
-
* Value represents ticket def id in the newly created event.
|
|
1183
|
+
* Order updated timestamp.
|
|
1184
|
+
* @readonly
|
|
1087
1185
|
*/
|
|
1088
|
-
|
|
1089
|
-
}
|
|
1090
|
-
interface Location {
|
|
1186
|
+
updated?: Date | null;
|
|
1091
1187
|
/**
|
|
1092
|
-
*
|
|
1093
|
-
* @maxLength
|
|
1188
|
+
* Buyer first name.
|
|
1189
|
+
* @maxLength 255
|
|
1094
1190
|
*/
|
|
1095
|
-
|
|
1096
|
-
/** Location map coordinates. */
|
|
1097
|
-
coordinates?: MapCoordinates;
|
|
1191
|
+
firstName?: string | null;
|
|
1098
1192
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* @maxLength
|
|
1193
|
+
* Buyer last name.
|
|
1194
|
+
* @maxLength 255
|
|
1101
1195
|
*/
|
|
1102
|
-
|
|
1103
|
-
/** Location type. */
|
|
1104
|
-
type?: LocationTypeWithLiterals;
|
|
1196
|
+
lastName?: string | null;
|
|
1105
1197
|
/**
|
|
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`.
|
|
1198
|
+
* Buyer email.
|
|
1199
|
+
* @format EMAIL
|
|
1113
1200
|
*/
|
|
1114
|
-
|
|
1201
|
+
email?: string | null;
|
|
1202
|
+
/** Checkout form response. */
|
|
1203
|
+
checkoutForm?: FormResponse;
|
|
1204
|
+
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
1205
|
+
confirmed?: boolean;
|
|
1206
|
+
/** Order status. */
|
|
1207
|
+
status?: OrderStatusWithLiterals;
|
|
1115
1208
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1209
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
1210
|
+
* @maxLength 100
|
|
1119
1211
|
*/
|
|
1120
|
-
|
|
1121
|
-
}
|
|
1122
|
-
interface MapCoordinates {
|
|
1212
|
+
method?: string | null;
|
|
1123
1213
|
/**
|
|
1124
|
-
*
|
|
1125
|
-
* @
|
|
1126
|
-
* @max 90
|
|
1214
|
+
* Tickets generated after payment.
|
|
1215
|
+
* @maxSize 50
|
|
1127
1216
|
*/
|
|
1128
|
-
|
|
1217
|
+
tickets?: Ticket[];
|
|
1218
|
+
/** Whether order was archived and excluded from results. */
|
|
1219
|
+
archived?: boolean;
|
|
1129
1220
|
/**
|
|
1130
|
-
*
|
|
1131
|
-
* @
|
|
1132
|
-
* @max 180
|
|
1221
|
+
* Reservation ID associated with this order.
|
|
1222
|
+
* @format GUID
|
|
1133
1223
|
*/
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
VENUE = "VENUE",
|
|
1138
|
-
ONLINE = "ONLINE"
|
|
1224
|
+
reservationId?: string;
|
|
1225
|
+
/** Whether marketing consent was given. */
|
|
1226
|
+
marketingConsent?: boolean | null;
|
|
1139
1227
|
}
|
|
1140
|
-
/**
|
|
1141
|
-
|
|
1142
|
-
/**
|
|
1143
|
-
|
|
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;
|
|
1228
|
+
/** Triggered when an order is paid. */
|
|
1229
|
+
interface OrderPaid {
|
|
1230
|
+
/** Date and time the order was paid. */
|
|
1231
|
+
timestamp?: Date | null;
|
|
1148
1232
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
* @format
|
|
1233
|
+
* Site language when the order was initiated.
|
|
1234
|
+
* @format LANGUAGE
|
|
1151
1235
|
*/
|
|
1152
|
-
|
|
1153
|
-
/**
|
|
1154
|
-
|
|
1155
|
-
/** city name */
|
|
1156
|
-
city?: string | null;
|
|
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;
|
|
1236
|
+
language?: string | null;
|
|
1237
|
+
/** Notifications silenced for this domain event. */
|
|
1238
|
+
silent?: boolean | null;
|
|
1169
1239
|
/**
|
|
1170
|
-
*
|
|
1171
|
-
* @
|
|
1240
|
+
* Locale in which the order was created.
|
|
1241
|
+
* @format LANGUAGE_TAG
|
|
1172
1242
|
*/
|
|
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 {
|
|
1243
|
+
locale?: string | null;
|
|
1189
1244
|
/**
|
|
1190
|
-
*
|
|
1191
|
-
* @
|
|
1192
|
-
* @max 90
|
|
1245
|
+
* Event ID to which the order belongs.
|
|
1246
|
+
* @format GUID
|
|
1193
1247
|
*/
|
|
1194
|
-
|
|
1248
|
+
eventId?: string;
|
|
1249
|
+
/** Unique order number. */
|
|
1250
|
+
orderNumber?: string;
|
|
1251
|
+
/** Reservation ID associated with this order. */
|
|
1252
|
+
reservationId?: string;
|
|
1195
1253
|
/**
|
|
1196
|
-
*
|
|
1197
|
-
* @
|
|
1198
|
-
* @max 180
|
|
1254
|
+
* Contact ID associated with this order.
|
|
1255
|
+
* @maxLength 36
|
|
1199
1256
|
*/
|
|
1200
|
-
|
|
1201
|
-
}
|
|
1202
|
-
interface Subdivision {
|
|
1203
|
-
/** subdivision short code */
|
|
1204
|
-
code?: string;
|
|
1205
|
-
/** subdivision full-name */
|
|
1206
|
-
name?: string;
|
|
1207
|
-
}
|
|
1208
|
-
interface ScheduleConfig {
|
|
1257
|
+
contactId?: string;
|
|
1209
1258
|
/**
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1259
|
+
* Member ID associated with this order.
|
|
1260
|
+
* @format GUID
|
|
1213
1261
|
*/
|
|
1214
|
-
|
|
1262
|
+
memberId?: string | null;
|
|
1215
1263
|
/**
|
|
1216
|
-
*
|
|
1217
|
-
* @
|
|
1264
|
+
* Date and time the order was created.
|
|
1265
|
+
* @readonly
|
|
1218
1266
|
*/
|
|
1219
|
-
|
|
1220
|
-
/** Event start timestamp. */
|
|
1221
|
-
startDate?: Date | null;
|
|
1222
|
-
/** Event end timestamp. */
|
|
1223
|
-
endDate?: Date | null;
|
|
1267
|
+
created?: Date | null;
|
|
1224
1268
|
/**
|
|
1225
|
-
*
|
|
1226
|
-
* @maxLength
|
|
1269
|
+
* Buyer first name.
|
|
1270
|
+
* @maxLength 255
|
|
1227
1271
|
*/
|
|
1228
|
-
|
|
1229
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
1230
|
-
endDateHidden?: boolean;
|
|
1231
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
1232
|
-
showTimeZone?: boolean;
|
|
1233
|
-
/** Event recurrences. */
|
|
1234
|
-
recurrences?: Recurrences;
|
|
1235
|
-
}
|
|
1236
|
-
interface Recurrences {
|
|
1272
|
+
firstName?: string;
|
|
1237
1273
|
/**
|
|
1238
|
-
*
|
|
1239
|
-
* @
|
|
1274
|
+
* Buyer last name.
|
|
1275
|
+
* @maxLength 255
|
|
1276
|
+
*/
|
|
1277
|
+
lastName?: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* Buyer email address.
|
|
1280
|
+
* @maxLength 255
|
|
1240
1281
|
*/
|
|
1241
|
-
|
|
1282
|
+
email?: string;
|
|
1283
|
+
/** Checkout form response. */
|
|
1284
|
+
checkoutForm?: FormResponse;
|
|
1285
|
+
/** Order status. */
|
|
1286
|
+
status?: OrderStatusWithLiterals;
|
|
1242
1287
|
/**
|
|
1243
|
-
*
|
|
1244
|
-
* @
|
|
1288
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
1289
|
+
* @maxLength 255
|
|
1245
1290
|
*/
|
|
1246
|
-
|
|
1291
|
+
method?: string | null;
|
|
1247
1292
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
* @
|
|
1293
|
+
* Tickets (generated after payment).
|
|
1294
|
+
* @maxSize 50
|
|
1250
1295
|
*/
|
|
1251
|
-
|
|
1296
|
+
tickets?: Ticket[];
|
|
1297
|
+
/** Invoice. */
|
|
1298
|
+
invoice?: Invoice;
|
|
1252
1299
|
}
|
|
1253
|
-
interface
|
|
1254
|
-
/** Event start timestamp. */
|
|
1255
|
-
startDate?: Date | null;
|
|
1256
|
-
/** Event end timestamp. */
|
|
1257
|
-
endDate?: Date | null;
|
|
1300
|
+
interface TicketPdfResolved {
|
|
1258
1301
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
* @maxLength
|
|
1302
|
+
* Optional order number
|
|
1303
|
+
* @maxLength 36
|
|
1261
1304
|
*/
|
|
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"
|
|
1289
|
-
}
|
|
1290
|
-
/** @enumType */
|
|
1291
|
-
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
1292
|
-
interface MessageEnvelope {
|
|
1305
|
+
orderNumber?: string | null;
|
|
1293
1306
|
/**
|
|
1294
|
-
*
|
|
1295
|
-
* @
|
|
1307
|
+
* Optional ticket number
|
|
1308
|
+
* @maxLength 36
|
|
1296
1309
|
*/
|
|
1297
|
-
|
|
1310
|
+
ticketNumber?: string | null;
|
|
1298
1311
|
/**
|
|
1299
|
-
*
|
|
1300
|
-
* @
|
|
1312
|
+
* Resolved download url
|
|
1313
|
+
* @format WEB_URL
|
|
1301
1314
|
*/
|
|
1302
|
-
|
|
1303
|
-
/**
|
|
1304
|
-
|
|
1305
|
-
/** Stringify payload. */
|
|
1306
|
-
data?: string;
|
|
1307
|
-
/** Details related to the account */
|
|
1308
|
-
accountInfo?: AccountInfo;
|
|
1309
|
-
}
|
|
1310
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1315
|
+
downloadUrl?: string | null;
|
|
1316
|
+
/** Resolve status */
|
|
1317
|
+
resolveFailed?: boolean | null;
|
|
1311
1318
|
/**
|
|
1312
|
-
*
|
|
1319
|
+
* Papyrus document id
|
|
1313
1320
|
* @format GUID
|
|
1314
1321
|
*/
|
|
1315
|
-
|
|
1322
|
+
documentId?: string | null;
|
|
1323
|
+
}
|
|
1324
|
+
interface TicketPdfResolveDelayed {
|
|
1316
1325
|
/**
|
|
1317
|
-
*
|
|
1318
|
-
* @
|
|
1326
|
+
* Optional order number
|
|
1327
|
+
* @maxLength 36
|
|
1319
1328
|
*/
|
|
1320
|
-
|
|
1329
|
+
orderNumber?: string | null;
|
|
1321
1330
|
/**
|
|
1322
|
-
*
|
|
1323
|
-
* @
|
|
1331
|
+
* Optional ticket number
|
|
1332
|
+
* @maxLength 36
|
|
1324
1333
|
*/
|
|
1325
|
-
|
|
1334
|
+
ticketNumber?: string | null;
|
|
1326
1335
|
/**
|
|
1327
|
-
*
|
|
1336
|
+
* Papyrus document id
|
|
1328
1337
|
* @format GUID
|
|
1329
1338
|
*/
|
|
1330
|
-
|
|
1331
|
-
/** @readonly */
|
|
1332
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1339
|
+
documentId?: string | null;
|
|
1333
1340
|
}
|
|
1334
|
-
/**
|
|
1335
|
-
interface
|
|
1341
|
+
/** Triggered when an order is canceled. */
|
|
1342
|
+
interface OrderCanceled {
|
|
1336
1343
|
/**
|
|
1337
|
-
* ID
|
|
1344
|
+
* Event ID to which the order belongs.
|
|
1338
1345
|
* @format GUID
|
|
1339
1346
|
*/
|
|
1340
|
-
|
|
1347
|
+
eventId?: string;
|
|
1341
1348
|
/**
|
|
1342
|
-
*
|
|
1343
|
-
* @
|
|
1349
|
+
* Unique order number.
|
|
1350
|
+
* @maxLength 36
|
|
1344
1351
|
*/
|
|
1345
|
-
|
|
1352
|
+
orderNumber?: string;
|
|
1346
1353
|
/**
|
|
1347
|
-
* ID
|
|
1354
|
+
* Reservation ID associated with the order.
|
|
1348
1355
|
* @format GUID
|
|
1349
1356
|
*/
|
|
1350
|
-
|
|
1357
|
+
reservationId?: string;
|
|
1351
1358
|
/**
|
|
1352
|
-
* ID
|
|
1353
|
-
* @
|
|
1359
|
+
* Contact ID associated with the order.
|
|
1360
|
+
* @maxLength 36
|
|
1354
1361
|
*/
|
|
1355
|
-
|
|
1356
|
-
}
|
|
1357
|
-
declare enum WebhookIdentityType {
|
|
1358
|
-
UNKNOWN = "UNKNOWN",
|
|
1359
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1360
|
-
MEMBER = "MEMBER",
|
|
1361
|
-
WIX_USER = "WIX_USER",
|
|
1362
|
-
APP = "APP"
|
|
1363
|
-
}
|
|
1364
|
-
/** @enumType */
|
|
1365
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1366
|
-
interface AccountInfo {
|
|
1362
|
+
contactId?: string;
|
|
1367
1363
|
/**
|
|
1368
|
-
*
|
|
1369
|
-
* @
|
|
1364
|
+
* Buyer first name.
|
|
1365
|
+
* @maxLength 50
|
|
1370
1366
|
*/
|
|
1371
|
-
|
|
1367
|
+
firstName?: string | null;
|
|
1372
1368
|
/**
|
|
1373
|
-
*
|
|
1374
|
-
* @
|
|
1369
|
+
* Buyer last name.
|
|
1370
|
+
* @maxLength 50
|
|
1375
1371
|
*/
|
|
1376
|
-
|
|
1372
|
+
lastName?: string | null;
|
|
1377
1373
|
/**
|
|
1378
|
-
*
|
|
1379
|
-
* @
|
|
1374
|
+
* Buyer email address.
|
|
1375
|
+
* @maxLength 255
|
|
1380
1376
|
*/
|
|
1381
|
-
|
|
1377
|
+
email?: string | null;
|
|
1378
|
+
/** Checkout form response. */
|
|
1379
|
+
checkoutForm?: FormResponse;
|
|
1380
|
+
/** Invoice. */
|
|
1381
|
+
invoice?: Invoice;
|
|
1382
1382
|
}
|
|
1383
1383
|
interface BaseEventMetadata {
|
|
1384
1384
|
/**
|
|
@@ -1485,50 +1485,6 @@ interface NotificationConfigUpdatedEnvelope {
|
|
|
1485
1485
|
* @documentationMaturity preview
|
|
1486
1486
|
*/
|
|
1487
1487
|
declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
|
|
1488
|
-
/**
|
|
1489
|
-
* Triggers notification
|
|
1490
|
-
* @public
|
|
1491
|
-
* @documentationMaturity preview
|
|
1492
|
-
* @requiredField options
|
|
1493
|
-
* @requiredField options.guests
|
|
1494
|
-
* @requiredField options.notification
|
|
1495
|
-
* @permissionId WIX_EVENTS.MANAGE
|
|
1496
|
-
* @applicableIdentity APP
|
|
1497
|
-
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
1498
|
-
*/
|
|
1499
|
-
declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
|
|
1500
|
-
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
1501
|
-
/** Email notification type */
|
|
1502
|
-
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1503
|
-
/** Push notification type */
|
|
1504
|
-
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1505
|
-
/** Rsvp guest info */
|
|
1506
|
-
rsvpGuest?: RsvpGuest;
|
|
1507
|
-
/** Order guest info */
|
|
1508
|
-
orderGuest?: OrderGuest;
|
|
1509
|
-
/** Event guests info */
|
|
1510
|
-
eventGuests?: EventGuests;
|
|
1511
|
-
/** Ticket guests info */
|
|
1512
|
-
ticketGuest?: TicketGuest;
|
|
1513
|
-
}
|
|
1514
|
-
/** @oneof */
|
|
1515
|
-
interface TriggerNotificationOptionsNotificationOneOf {
|
|
1516
|
-
/** Email notification type */
|
|
1517
|
-
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1518
|
-
/** Push notification type */
|
|
1519
|
-
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1520
|
-
}
|
|
1521
|
-
/** @oneof */
|
|
1522
|
-
interface TriggerNotificationOptionsGuestsOneOf {
|
|
1523
|
-
/** Rsvp guest info */
|
|
1524
|
-
rsvpGuest?: RsvpGuest;
|
|
1525
|
-
/** Order guest info */
|
|
1526
|
-
orderGuest?: OrderGuest;
|
|
1527
|
-
/** Event guests info */
|
|
1528
|
-
eventGuests?: EventGuests;
|
|
1529
|
-
/** Ticket guests info */
|
|
1530
|
-
ticketGuest?: TicketGuest;
|
|
1531
|
-
}
|
|
1532
1488
|
/**
|
|
1533
1489
|
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
1534
1490
|
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
@@ -1591,5 +1547,49 @@ interface UpsertNotificationConfig {
|
|
|
1591
1547
|
/** Order confirmation with tickets link. */
|
|
1592
1548
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
1593
1549
|
}
|
|
1550
|
+
/**
|
|
1551
|
+
* Triggers notification
|
|
1552
|
+
* @public
|
|
1553
|
+
* @documentationMaturity preview
|
|
1554
|
+
* @requiredField options
|
|
1555
|
+
* @requiredField options.guests
|
|
1556
|
+
* @requiredField options.notification
|
|
1557
|
+
* @permissionId WIX_EVENTS.MANAGE
|
|
1558
|
+
* @applicableIdentity APP
|
|
1559
|
+
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
1560
|
+
*/
|
|
1561
|
+
declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
|
|
1562
|
+
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
1563
|
+
/** Email notification type */
|
|
1564
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1565
|
+
/** Push notification type */
|
|
1566
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1567
|
+
/** Rsvp guest info */
|
|
1568
|
+
rsvpGuest?: RsvpGuest;
|
|
1569
|
+
/** Order guest info */
|
|
1570
|
+
orderGuest?: OrderGuest;
|
|
1571
|
+
/** Event guests info */
|
|
1572
|
+
eventGuests?: EventGuests;
|
|
1573
|
+
/** Ticket guests info */
|
|
1574
|
+
ticketGuest?: TicketGuest;
|
|
1575
|
+
}
|
|
1576
|
+
/** @oneof */
|
|
1577
|
+
interface TriggerNotificationOptionsNotificationOneOf {
|
|
1578
|
+
/** Email notification type */
|
|
1579
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1580
|
+
/** Push notification type */
|
|
1581
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1582
|
+
}
|
|
1583
|
+
/** @oneof */
|
|
1584
|
+
interface TriggerNotificationOptionsGuestsOneOf {
|
|
1585
|
+
/** Rsvp guest info */
|
|
1586
|
+
rsvpGuest?: RsvpGuest;
|
|
1587
|
+
/** Order guest info */
|
|
1588
|
+
orderGuest?: OrderGuest;
|
|
1589
|
+
/** Event guests info */
|
|
1590
|
+
eventGuests?: EventGuests;
|
|
1591
|
+
/** Ticket guests info */
|
|
1592
|
+
ticketGuest?: TicketGuest;
|
|
1593
|
+
}
|
|
1594
1594
|
|
|
1595
1595
|
export { type AccountInfo, type AccountInfoMetadata, 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 };
|