@wix/auto_sdk_events_notifications 1.0.73 → 1.0.75

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