@wix/auto_sdk_events_notifications 1.0.71 → 1.0.72

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