@wix/auto_sdk_events_notifications 1.0.70 → 1.0.71

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