@wix/auto_sdk_events_notifications 1.0.71 → 1.0.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +9 -9
  2. package/build/cjs/index.js +98 -101
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +973 -979
  5. package/build/cjs/index.typings.js +90 -93
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +938 -944
  8. package/build/cjs/meta.js +76 -79
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +9 -9
  11. package/build/es/index.mjs +98 -101
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +973 -979
  14. package/build/es/index.typings.mjs +90 -93
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +938 -944
  17. package/build/es/meta.mjs +76 -79
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +9 -9
  20. package/build/internal/cjs/index.js +98 -101
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +973 -979
  23. package/build/internal/cjs/index.typings.js +90 -93
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +938 -944
  26. package/build/internal/cjs/meta.js +76 -79
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +9 -9
  29. package/build/internal/es/index.mjs +98 -101
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +973 -979
  32. package/build/internal/es/index.typings.mjs +90 -93
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +938 -944
  35. package/build/internal/es/meta.mjs +76 -79
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -1,4 +1,4 @@
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.mjs';
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.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  interface NotificationConfig {
@@ -57,8 +57,6 @@ interface EmailNotificationConfig {
57
57
  sendingEnabled?: boolean | null;
58
58
  }
59
59
  declare enum EmailNotificationType {
60
- /** Default value. This value is unused. */
61
- UNKNOWN_NOTIFICATION_TYPE = "UNKNOWN_NOTIFICATION_TYPE",
62
60
  /** Triggered when site user RSVP to the event. */
63
61
  EMAIL_RSVP_CONFIRMATION = "EMAIL_RSVP_CONFIRMATION",
64
62
  /** Triggered for waiting guests when additional RSVP spots appears in the fully booked event. */
@@ -75,7 +73,7 @@ declare enum EmailNotificationType {
75
73
  EMAIL_INVOICE = "EMAIL_INVOICE"
76
74
  }
77
75
  /** @enumType */
78
- type EmailNotificationTypeWithLiterals = EmailNotificationType | 'UNKNOWN_NOTIFICATION_TYPE' | 'EMAIL_RSVP_CONFIRMATION' | 'EMAIL_NEW_SPOTS_AVAILABLE' | 'EMAIL_EVENT_CANCELATION' | 'EMAIL_UPCOMING_EVENT_REMINDER' | 'EMAIL_ORDER_CONFIRMATION' | 'EMAIL_TICKET_CONFIRMATION' | 'EMAIL_INVOICE';
76
+ type EmailNotificationTypeWithLiterals = EmailNotificationType | 'EMAIL_RSVP_CONFIRMATION' | 'EMAIL_NEW_SPOTS_AVAILABLE' | 'EMAIL_EVENT_CANCELATION' | 'EMAIL_UPCOMING_EVENT_REMINDER' | 'EMAIL_ORDER_CONFIRMATION' | 'EMAIL_TICKET_CONFIRMATION' | 'EMAIL_INVOICE';
79
77
  interface EmailTemplate {
80
78
  /**
81
79
  * Email subject.
@@ -108,8 +106,6 @@ interface Link {
108
106
  linkText?: string | null;
109
107
  }
110
108
  declare enum EmailNotificationReminderTime {
111
- /** Default value. This value is unused. */
112
- UNKNOWN_REMINDER_TIME = "UNKNOWN_REMINDER_TIME",
113
109
  /** Notification is sent instantly */
114
110
  INSTANT = "INSTANT",
115
111
  /** 24 hours prior */
@@ -124,229 +120,304 @@ declare enum EmailNotificationReminderTime {
124
120
  BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
125
121
  }
126
122
  /** @enumType */
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 ResolveNotificationConfigRequest {
129
- /**
130
- * Id of the NotificationConfig to retrieve
131
- * @format GUID
132
- */
133
- notificationConfigId: string;
134
- }
135
- interface ResolveNotificationConfigResponse {
136
- /** The retrieved NotificationConfig */
137
- notificationConfig?: NotificationConfig;
138
- }
139
- interface UpsertNotificationConfigRequest {
140
- /** NotificationConfig to be upserted */
141
- notificationConfig: NotificationConfig;
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;
142
137
  }
143
- interface UpsertNotificationConfigResponse {
144
- /** The upserted NotificationConfig */
145
- notificationConfig?: NotificationConfig;
138
+ /** @oneof */
139
+ interface TriggerNotificationRequestNotificationOneOf {
140
+ /** Email notification type */
141
+ emailNotificationType?: EmailNotificationTypeWithLiterals;
142
+ /** Push notification type */
143
+ pushNotificationType?: PushNotificationTypeWithLiterals;
146
144
  }
147
- interface ResolveEmailNotificationConfigRequest {
148
- /**
149
- * Id of the NotificationConfig to retrieve
150
- * @format GUID
151
- */
152
- notificationConfigId?: string;
153
- /** Notification type */
154
- notificationType?: EmailNotificationTypeWithLiterals;
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;
155
155
  }
156
- interface ResolveEmailNotificationConfigResponse {
157
- /** The retrieved EmailNotificationConfig */
158
- emailNotificationConfig?: EmailNotificationConfig;
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"
159
165
  }
160
- interface EventCanceled {
161
- /** Event canceled timestamp in ISO UTC format. */
162
- timestamp?: Date | null;
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 {
163
170
  /**
164
- * Event ID.
171
+ * Event id
165
172
  * @format GUID
166
173
  */
167
174
  eventId?: string;
168
- /** Event title */
169
- title?: string;
170
175
  /**
171
- * Event creator user ID.
176
+ * Rsvp id
172
177
  * @format GUID
173
178
  */
174
- userId?: string | null;
175
- /** True if at least one guest is registered to the event with any attendance status. */
176
- hasGuests?: boolean | null;
177
- }
178
- interface Empty {
179
+ rsvpId?: string;
179
180
  }
180
- interface EventDeleted {
181
- /** Event deleted timestamp in ISO UTC format. */
182
- timestamp?: Date | null;
181
+ /** Single guest associated to the Order */
182
+ interface OrderGuest {
183
183
  /**
184
- * Event ID.
184
+ * Event id
185
185
  * @format GUID
186
186
  */
187
187
  eventId?: string;
188
- /** Event title. */
189
- title?: string;
190
188
  /**
191
- * Event creator user ID.
192
- * @format GUID
189
+ * Order number
190
+ * @maxLength 36
193
191
  */
194
- userId?: string | null;
192
+ orderNumber?: string;
195
193
  }
196
- interface EventCopied {
197
- /** Event created timestamp in ISO UTC format. */
198
- timestamp?: Date | null;
194
+ /** All event guest from RSVPs and Orders */
195
+ interface EventGuests {
199
196
  /**
200
- * Event ID.
197
+ * Event id
201
198
  * @format GUID
202
199
  */
203
200
  eventId?: string;
204
- /** Event location. */
205
- location?: Location;
206
- /** Event schedule configuration. */
207
- scheduleConfig?: ScheduleConfig;
208
- /** Event title. */
209
- title?: string;
210
- /**
211
- * Event creator user ID.
212
- * @format GUID
213
- */
214
- userId?: string | null;
215
- /** Event status. */
216
- status?: EventStatusWithLiterals;
201
+ }
202
+ /** Multiple guests associated to Tickets */
203
+ interface TicketGuest {
217
204
  /**
218
- * Instance ID. Indicates the original app instance which current event was derived from.
205
+ * Event id
219
206
  * @format GUID
220
207
  */
221
- derivedFromInstanceId?: string | null;
208
+ eventId?: string;
222
209
  /**
223
- * Event ID. Indicates the original event which current event was derived from.
224
- * @format GUID
210
+ * Order number
211
+ * @maxLength 36
225
212
  */
226
- derivedFromEventId?: string | null;
213
+ orderNumber?: string | null;
227
214
  /**
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.
215
+ * Ticket numbers must be from the same order only.
216
+ * @minSize 1
217
+ * @maxSize 100
218
+ * @maxLength 36
231
219
  */
232
- ticketDefinitions?: Record<string, string>;
220
+ ticketNumber?: string[];
233
221
  }
234
- interface Location {
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;
235
231
  /**
236
- * Location name.
237
- * @maxLength 50
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`.
238
234
  */
239
- name?: string | null;
240
- /** Location map coordinates. */
241
- coordinates?: MapCoordinates;
235
+ entityFqdn?: string;
242
236
  /**
243
- * Single line address representation.
244
- * @maxLength 300
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`.
245
239
  */
246
- address?: string | null;
247
- /** Location type. */
248
- type?: LocationTypeWithLiterals;
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;
249
245
  /**
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`.
246
+ * Whether the event was triggered as a result of a privacy regulation application
247
+ * (for example, GDPR).
257
248
  */
258
- fullAddress?: Address;
249
+ triggeredByAnonymizeRequest?: boolean | null;
250
+ /** If present, indicates the action that triggered the event. */
251
+ originatedFrom?: string | null;
259
252
  /**
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.
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.
263
255
  */
264
- tbd?: boolean | null;
256
+ entityEventSequence?: string | null;
265
257
  }
266
- interface MapCoordinates {
267
- /**
268
- * Latitude.
269
- * @min -90
270
- * @max 90
271
- */
272
- lat?: number;
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 {
273
274
  /**
274
- * Longitude.
275
- * @min -180
276
- * @max 180
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.
277
278
  */
278
- lng?: number;
279
+ currentEntityAsJson?: string;
279
280
  }
280
- declare enum LocationType {
281
- VENUE = "VENUE",
282
- ONLINE = "ONLINE"
281
+ interface EntityDeletedEvent {
282
+ /** Entity that was deleted. */
283
+ deletedEntityAsJson?: string | null;
283
284
  }
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;
285
+ interface ActionEvent {
286
+ bodyAsJson?: string;
287
+ }
288
+ interface Empty {
289
+ }
290
+ /** Triggered when an order is confirmed. */
291
+ interface OrderConfirmed {
292
+ /** Date and time the order was confirmed. */
293
+ timestamp?: Date | null;
292
294
  /**
293
- * country code
294
- * @format COUNTRY
295
+ * Site language when the order was initiated.
296
+ * @format LANGUAGE
295
297
  */
296
- country?: string | null;
297
- /** subdivision (usually state or region) code according to ISO 3166-2 */
298
- subdivision?: string | null;
299
- /** city name */
300
- city?: string | null;
301
- /** zip/postal code */
302
- postalCode?: string | null;
303
- /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
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;
298
+ language?: string | null;
299
+ /** Notifications silenced for this domain event. */
300
+ silent?: boolean | null;
313
301
  /**
314
- * multi-level subdivisions from top to bottom
315
- * @maxSize 6
302
+ * Locale in which the order was created.
303
+ * @format LANGUAGE_TAG
316
304
  */
317
- subdivisions?: Subdivision[];
305
+ locale?: string | null;
306
+ /**
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.
386
+ * @format COUNTRY
387
+ */
388
+ 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 */
390
+ subdivision?: string | null;
391
+ /** City name. */
392
+ city?: string | null;
393
+ /** Zip/postal code. */
394
+ postalCode?: string | null;
395
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
396
+ addressLine2?: string | null;
318
397
  }
319
398
  /** @oneof */
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 */
399
+ interface CommonAddressStreetOneOf {
400
+ /** Street name and number. */
401
+ streetAddress?: CommonStreetAddress;
402
+ /** Main address line, usually street and number as free text. */
324
403
  addressLine?: string | null;
325
404
  }
326
- interface StreetAddress {
327
- /** street number */
405
+ interface CommonStreetAddress {
406
+ /** Street number. */
328
407
  number?: string;
329
- /** street name */
408
+ /** Street name. */
330
409
  name?: string;
331
410
  }
332
- interface AddressLocation {
333
- /**
334
- * address latitude coordinates
335
- * @min -90
336
- * @max 90
337
- */
411
+ interface CommonAddressLocation {
412
+ /** Address latitude. */
338
413
  latitude?: number | null;
339
- /**
340
- * address longitude coordinates
341
- * @min -180
342
- * @max 180
343
- */
414
+ /** Address longitude. */
344
415
  longitude?: number | null;
345
416
  }
346
- interface Subdivision {
347
- /** subdivision short code */
417
+ interface CommonSubdivision {
418
+ /** Short subdivision code. */
348
419
  code?: string;
349
- /** subdivision full-name */
420
+ /** Subdivision full name. */
350
421
  name?: string;
351
422
  }
352
423
  declare enum SubdivisionType {
@@ -366,1022 +437,945 @@ declare enum SubdivisionType {
366
437
  }
367
438
  /** @enumType */
368
439
  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';
369
- interface ScheduleConfig {
440
+ /** Subdivision Concordance values */
441
+ interface StandardDetails {
370
442
  /**
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.
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
374
445
  */
375
- scheduleTbd?: boolean;
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;
376
477
  /**
377
- * TBD message.
378
- * @maxLength 100
478
+ * Ticket definition ID.
479
+ * @format GUID
379
480
  */
380
- scheduleTbdMessage?: string | null;
381
- /** Event start timestamp. */
382
- startDate?: Date | null;
383
- /** Event end timestamp. */
384
- endDate?: Date | null;
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;
385
494
  /**
386
- * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
387
- * @maxLength 100
495
+ * Contact ID associated with this ticket.
496
+ * @format GUID
388
497
  */
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;
396
- }
397
- interface Recurrences {
498
+ contactId?: string | null;
499
+ /** Whether ticket is confirmed */
500
+ confirmed?: boolean;
398
501
  /**
399
- * Event occurrences.
400
- * @maxSize 1000
502
+ * Member ID associated with this ticket.
503
+ * @format GUID
401
504
  */
402
- occurrences?: Occurrence[];
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;
403
514
  /**
404
- * Recurring event category ID.
405
- * @readonly
515
+ * Seat ID associated with this ticket.
516
+ * @maxLength 36
406
517
  */
407
- categoryId?: string | null;
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;
525
+ }
526
+ interface Money {
408
527
  /**
409
- * Recurrence status.
410
- * @readonly
528
+ * *Deprecated:** Use `value` instead.
529
+ * @format DECIMAL_VALUE
530
+ * @deprecated
411
531
  */
412
- status?: StatusWithLiterals;
413
- }
414
- interface Occurrence {
415
- /** Event start timestamp. */
416
- startDate?: Date | null;
417
- /** Event end timestamp. */
418
- endDate?: Date | null;
419
- /**
420
- * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
421
- * @maxLength 100
422
- */
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;
460
- /**
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`.
463
- */
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;
532
+ amount?: string;
481
533
  /**
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.
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
484
536
  */
485
- entityEventSequence?: string | null;
486
- }
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 {
537
+ currency?: string;
503
538
  /**
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.
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
507
541
  */
508
- currentEntityAsJson?: string;
509
- }
510
- interface EntityDeletedEvent {
511
- /** Entity that was deleted. */
512
- deletedEntityAsJson?: string | null;
513
- }
514
- interface ActionEvent {
515
- bodyAsJson?: string;
542
+ value?: string | null;
516
543
  }
517
- interface MessageEnvelope {
544
+ interface OnlineConferencingLogin {
518
545
  /**
519
- * App instance ID.
520
- * @format GUID
546
+ * Link URL to the online conference.
547
+ * @format WEB_URL
548
+ * @readonly
521
549
  */
522
- instanceId?: string | null;
550
+ link?: string;
523
551
  /**
524
- * Event type.
525
- * @maxLength 150
552
+ * Password for the online conference.
553
+ * @readonly
526
554
  */
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;
555
+ password?: string | null;
534
556
  }
535
- interface IdentificationData extends IdentificationDataIdOneOf {
536
- /**
537
- * ID of a site visitor that has not logged in to the site.
538
- * @format GUID
539
- */
540
- anonymousVisitorId?: string;
557
+ interface Invoice {
558
+ items?: Item[];
541
559
  /**
542
- * ID of a site visitor that has logged in to the site.
543
- * @format GUID
560
+ * Total cart amount.
561
+ * @deprecated
544
562
  */
545
- memberId?: string;
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;
546
570
  /**
547
- * ID of a Wix user (site owner, contributor, etc.).
548
- * @format GUID
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.
549
577
  */
550
- wixUserId?: string;
578
+ grandTotal?: Money;
551
579
  /**
552
- * ID of an app.
553
- * @format GUID
580
+ * Fees applied to the cart.
581
+ * @readonly
554
582
  */
555
- appId?: string;
556
- /** @readonly */
557
- identityType?: WebhookIdentityTypeWithLiterals;
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;
558
588
  }
559
- /** @oneof */
560
- interface IdentificationDataIdOneOf {
561
- /**
562
- * ID of a site visitor that has not logged in to the site.
563
- * @format GUID
564
- */
565
- anonymousVisitorId?: string;
589
+ interface Item {
566
590
  /**
567
- * ID of a site visitor that has logged in to the site.
591
+ * Unique line item ID.
568
592
  * @format GUID
569
593
  */
570
- memberId?: string;
594
+ id?: string;
571
595
  /**
572
- * ID of a Wix user (site owner, contributor, etc.).
573
- * @format GUID
596
+ * Line item quantity.
597
+ * @min 1
598
+ * @max 50
574
599
  */
575
- wixUserId?: string;
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;
576
611
  /**
577
- * ID of an app.
578
- * @format GUID
612
+ * Fees applied to the item.
613
+ * @readonly
579
614
  */
580
- appId?: string;
581
- }
582
- declare enum WebhookIdentityType {
583
- UNKNOWN = "UNKNOWN",
584
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
585
- MEMBER = "MEMBER",
586
- WIX_USER = "WIX_USER",
587
- APP = "APP"
615
+ fees?: Fee[];
588
616
  }
589
- /** @enumType */
590
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
591
- interface AccountInfo {
617
+ interface Discount {
618
+ /** Total discount amount. */
619
+ amount?: Money;
620
+ /** Total sum after the discount. */
621
+ afterDiscount?: Money;
592
622
  /**
593
- * ID of the Wix account associated with the event.
594
- * @format GUID
623
+ * Discount coupon code.
624
+ * @deprecated
595
625
  */
596
- accountId?: string | null;
626
+ code?: string;
597
627
  /**
598
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
599
- * @format GUID
628
+ * Discount coupon name.
629
+ * @deprecated
600
630
  */
601
- parentAccountId?: string | null;
631
+ name?: string;
602
632
  /**
603
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
604
- * @format GUID
633
+ * Discount coupon ID.
634
+ * @deprecated
605
635
  */
606
- siteId?: string | null;
607
- }
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;
636
+ couponId?: string;
637
+ /** Discount items. */
638
+ discounts?: DiscountItem[];
621
639
  }
622
- /** @oneof */
623
- interface TriggerNotificationRequestNotificationOneOf {
624
- /** Email notification type */
625
- emailNotificationType?: EmailNotificationTypeWithLiterals;
626
- /** Push notification type */
627
- pushNotificationType?: PushNotificationTypeWithLiterals;
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;
628
647
  }
629
648
  /** @oneof */
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;
649
+ interface DiscountItemDiscountOneOf {
650
+ /** Coupon discount. */
651
+ coupon?: CouponDiscount;
652
+ /** Pricing plan discount. */
653
+ paidPlan?: PaidPlanDiscount;
639
654
  }
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"
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;
651
662
  }
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;
663
+ interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
664
+ /** Discount by percentage applied to tickets. */
665
+ percentDiscount?: PercentDiscount;
666
+ /** Name of pricing plan. */
667
+ name?: string;
666
668
  }
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;
669
+ /** @oneof */
670
+ interface PaidPlanDiscountDiscountOneOf {
671
+ /** Discount by percentage applied to tickets. */
672
+ percentDiscount?: PercentDiscount;
679
673
  }
680
- /** All event guest from RSVPs and Orders */
681
- interface EventGuests {
674
+ interface PercentDiscount {
682
675
  /**
683
- * Event id
684
- * @format GUID
676
+ * Percent rate.
677
+ * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
685
678
  */
686
- eventId?: string;
679
+ rate?: string;
680
+ /** Number of discounted tickets. */
681
+ quantityDiscounted?: number;
687
682
  }
688
- /** Multiple guests associated to Tickets */
689
- interface TicketGuest {
683
+ interface Tax {
684
+ /** Tax type. */
685
+ type?: TaxTypeWithLiterals;
690
686
  /**
691
- * Event id
692
- * @format GUID
687
+ * Tax name.
688
+ * @readonly
693
689
  */
694
- eventId?: string;
690
+ name?: string;
695
691
  /**
696
- * Order number
697
- * @maxLength 36
692
+ * Tax rate.
693
+ * @format DECIMAL_VALUE
698
694
  */
699
- orderNumber?: string | null;
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;
700
716
  /**
701
- * Ticket numbers must be from the same order only.
702
- * @minSize 1
703
- * @maxSize 100
704
- * @maxLength 36
717
+ * Fee rate.
718
+ * @format DECIMAL_VALUE
719
+ * @readonly
705
720
  */
706
- ticketNumber?: string[];
721
+ rate?: string;
722
+ /** Total amount of fee charges. */
723
+ amount?: Money;
707
724
  }
708
- interface TriggerNotificationResponse {
725
+ declare enum FeeName {
726
+ /** Wix ticket service fee charges applied to the line item. */
727
+ WIX_FEE = "WIX_FEE"
709
728
  }
710
- /** Triggered when an order is confirmed. */
711
- interface OrderConfirmed {
712
- /** Date and time the order was confirmed. */
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"
738
+ }
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. */
713
744
  timestamp?: Date | null;
714
745
  /**
715
- * Site language when the order was initiated.
746
+ * Site language when Order initiated
716
747
  * @format LANGUAGE
717
748
  */
718
749
  language?: string | null;
719
- /** Notifications silenced for this domain event. */
720
- silent?: boolean | null;
721
750
  /**
722
- * Locale in which the order was created.
751
+ * Locale in which Order was created.
723
752
  * @format LANGUAGE_TAG
724
753
  */
725
754
  locale?: string | null;
755
+ /** Notifications silenced for this domain event. */
756
+ silent?: boolean | null;
726
757
  /**
727
- * Event ID to which the order belongs.
758
+ * Event ID.
728
759
  * @format GUID
729
760
  */
730
761
  eventId?: string;
731
- /** Unique order number. */
762
+ /**
763
+ * Unique order number.
764
+ * @maxLength 36
765
+ */
732
766
  orderNumber?: string;
733
- /** Contact ID associated with the order. */
734
- contactId?: string;
735
767
  /**
736
- * Member ID associated with the order.
768
+ * Contact ID associated with this order.
769
+ * @format GUID
770
+ */
771
+ contactId?: string | null;
772
+ /**
773
+ * Member ID associated with this order.
737
774
  * @format GUID
738
775
  */
739
776
  memberId?: string | null;
740
777
  /**
741
- * Date and time the order was created.
778
+ * Order created timestamp.
742
779
  * @readonly
743
780
  */
744
781
  created?: Date | null;
745
- /** Buyer first name. */
746
- firstName?: string;
747
- /** Buyer last name. */
748
- lastName?: string;
749
- /** Buyer email address. */
750
- email?: string;
751
- /** Checkout form response. */
752
- checkoutForm?: FormResponse;
753
- /** Order status. */
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 {
765
782
  /**
766
- * Form field inputs.
767
- * @maxSize 200
783
+ * Order updated timestamp.
784
+ * @readonly
768
785
  */
769
- inputValues?: InputValue[];
770
- }
771
- interface InputValue {
786
+ updated?: Date | null;
772
787
  /**
773
- * Form field input name.
774
- * @maxLength 100
788
+ * Buyer first name.
789
+ * @maxLength 255
775
790
  */
776
- inputName?: string;
791
+ firstName?: string | null;
777
792
  /**
778
- * Form field value.
779
- * @maxLength 5000
793
+ * Buyer last name.
794
+ * @maxLength 255
780
795
  */
781
- value?: string;
796
+ lastName?: string | null;
782
797
  /**
783
- * Form field values.
784
- * @maxSize 100
785
- * @maxLength 5000
798
+ * Buyer email.
799
+ * @format EMAIL
786
800
  */
787
- values?: string[];
788
- }
789
- interface FormattedAddress {
801
+ email?: string | null;
802
+ /** Checkout form response. */
803
+ checkoutForm?: FormResponse;
804
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
805
+ confirmed?: boolean;
806
+ /** Order status. */
807
+ status?: OrderStatusWithLiterals;
790
808
  /**
791
- * 1-line address representation.
792
- * @maxLength 200
809
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
810
+ * @maxLength 100
793
811
  */
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;
812
+ method?: string | null;
804
813
  /**
805
- * Country code.
806
- * @format COUNTRY
814
+ * Tickets generated after payment.
815
+ * @maxSize 50
807
816
  */
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 {
817
+ tickets?: Ticket[];
818
+ /** Whether order was archived and excluded from results. */
819
+ archived?: boolean;
845
820
  /**
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
821
+ * Reservation ID associated with this order.
822
+ * @format GUID
848
823
  */
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"
824
+ reservationId?: string;
825
+ /** Whether marketing consent was given. */
826
+ marketingConsent?: boolean | null;
874
827
  }
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;
828
+ /** Triggered when an order is paid. */
829
+ interface OrderPaid {
830
+ /** Date and time the order was paid. */
831
+ timestamp?: Date | null;
880
832
  /**
881
- * Ticket definition ID.
882
- * @format GUID
833
+ * Site language when the order was initiated.
834
+ * @format LANGUAGE
883
835
  */
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;
836
+ language?: string | null;
837
+ /** Notifications silenced for this domain event. */
838
+ silent?: boolean | null;
897
839
  /**
898
- * Contact ID associated with this ticket.
840
+ * Locale in which the order was created.
841
+ * @format LANGUAGE_TAG
842
+ */
843
+ locale?: string | null;
844
+ /**
845
+ * Event ID to which the order belongs.
899
846
  * @format GUID
900
847
  */
901
- contactId?: string | null;
902
- /** Whether ticket is confirmed */
903
- confirmed?: boolean;
848
+ eventId?: string;
849
+ /** Unique order number. */
850
+ orderNumber?: string;
851
+ /** Reservation ID associated with this order. */
852
+ reservationId?: string;
904
853
  /**
905
- * Member ID associated with this ticket.
854
+ * Contact ID associated with this order.
855
+ * @maxLength 36
856
+ */
857
+ contactId?: string;
858
+ /**
859
+ * Member ID associated with this order.
906
860
  * @format GUID
907
861
  */
908
862
  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;
917
863
  /**
918
- * Seat ID associated with this ticket.
919
- * @maxLength 36
864
+ * Date and time the order was created.
865
+ * @readonly
920
866
  */
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. */
927
867
  created?: Date | null;
928
- }
929
- interface Money {
930
868
  /**
931
- * *Deprecated:** Use `value` instead.
932
- * @format DECIMAL_VALUE
933
- * @deprecated
869
+ * Buyer first name.
870
+ * @maxLength 255
934
871
  */
935
- amount?: string;
872
+ firstName?: string;
936
873
  /**
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
874
+ * Buyer last name.
875
+ * @maxLength 255
939
876
  */
940
- currency?: string;
877
+ lastName?: string;
941
878
  /**
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
879
+ * Buyer email address.
880
+ * @maxLength 255
944
881
  */
945
- value?: string | null;
946
- }
947
- interface OnlineConferencingLogin {
882
+ email?: string;
883
+ /** Checkout form response. */
884
+ checkoutForm?: FormResponse;
885
+ /** Order status. */
886
+ status?: OrderStatusWithLiterals;
948
887
  /**
949
- * Link URL to the online conference.
950
- * @format WEB_URL
951
- * @readonly
888
+ * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
889
+ * @maxLength 255
952
890
  */
953
- link?: string;
891
+ method?: string | null;
954
892
  /**
955
- * Password for the online conference.
956
- * @readonly
893
+ * Tickets (generated after payment).
894
+ * @maxSize 50
957
895
  */
958
- password?: string | null;
896
+ tickets?: Ticket[];
897
+ /** Invoice. */
898
+ invoice?: Invoice;
959
899
  }
960
- interface Invoice {
961
- items?: Item[];
900
+ interface TicketPdfResolved {
962
901
  /**
963
- * Total cart amount.
964
- * @deprecated
902
+ * Optional order number
903
+ * @maxLength 36
965
904
  */
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;
905
+ orderNumber?: string | null;
973
906
  /**
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.
907
+ * Optional ticket number
908
+ * @maxLength 36
980
909
  */
981
- grandTotal?: Money;
910
+ ticketNumber?: string | null;
982
911
  /**
983
- * Fees applied to the cart.
984
- * @readonly
912
+ * Resolved download url
913
+ * @format WEB_URL
985
914
  */
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;
991
- }
992
- interface Item {
915
+ downloadUrl?: string | null;
916
+ /** Resolve status */
917
+ resolveFailed?: boolean | null;
993
918
  /**
994
- * Unique line item ID.
919
+ * Papyrus document id
995
920
  * @format GUID
996
921
  */
997
- id?: string;
922
+ documentId?: string | null;
923
+ }
924
+ interface TicketPdfResolveDelayed {
998
925
  /**
999
- * Line item quantity.
1000
- * @min 1
1001
- * @max 50
926
+ * Optional order number
927
+ * @maxLength 36
1002
928
  */
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;
929
+ orderNumber?: string | null;
1014
930
  /**
1015
- * Fees applied to the item.
1016
- * @readonly
931
+ * Optional ticket number
932
+ * @maxLength 36
1017
933
  */
1018
- fees?: Fee[];
934
+ ticketNumber?: string | null;
935
+ /**
936
+ * Papyrus document id
937
+ * @format GUID
938
+ */
939
+ documentId?: string | null;
1019
940
  }
1020
- interface Discount {
1021
- /** Total discount amount. */
1022
- amount?: Money;
1023
- /** Total sum after the discount. */
1024
- afterDiscount?: Money;
941
+ /** Triggered when an order is canceled. */
942
+ interface OrderCanceled {
1025
943
  /**
1026
- * Discount coupon code.
1027
- * @deprecated
944
+ * Event ID to which the order belongs.
945
+ * @format GUID
1028
946
  */
1029
- code?: string;
947
+ eventId?: string;
1030
948
  /**
1031
- * Discount coupon name.
1032
- * @deprecated
949
+ * Unique order number.
950
+ * @maxLength 36
1033
951
  */
1034
- name?: string;
952
+ orderNumber?: string;
1035
953
  /**
1036
- * Discount coupon ID.
1037
- * @deprecated
954
+ * Reservation ID associated with the order.
955
+ * @format GUID
1038
956
  */
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;
1076
- }
1077
- interface PercentDiscount {
957
+ reservationId?: string;
1078
958
  /**
1079
- * Percent rate.
1080
- * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
959
+ * Contact ID associated with the order.
960
+ * @maxLength 36
961
+ */
962
+ contactId?: string;
963
+ /**
964
+ * Buyer first name.
965
+ * @maxLength 50
966
+ */
967
+ firstName?: string | null;
968
+ /**
969
+ * Buyer last name.
970
+ * @maxLength 50
1081
971
  */
1082
- rate?: string;
1083
- /** Number of discounted tickets. */
1084
- quantityDiscounted?: number;
1085
- }
1086
- interface Tax {
1087
- /** Tax type. */
1088
- type?: TaxTypeWithLiterals;
972
+ lastName?: string | null;
1089
973
  /**
1090
- * Tax name.
1091
- * @readonly
974
+ * Buyer email address.
975
+ * @maxLength 255
1092
976
  */
1093
- name?: string;
977
+ email?: string | null;
978
+ /** Checkout form response. */
979
+ checkoutForm?: FormResponse;
980
+ /** Invoice. */
981
+ invoice?: Invoice;
982
+ }
983
+ interface ResolveNotificationConfigRequest {
1094
984
  /**
1095
- * Tax rate.
1096
- * @format DECIMAL_VALUE
985
+ * Id of the NotificationConfig to retrieve
986
+ * @format GUID
1097
987
  */
1098
- rate?: string;
1099
- /** Taxable amount. */
1100
- taxable?: Money;
1101
- /** Total tax amount. */
1102
- amount?: Money;
988
+ notificationConfigId: string;
1103
989
  }
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"
990
+ interface ResolveNotificationConfigResponse {
991
+ /** The retrieved NotificationConfig */
992
+ notificationConfig?: NotificationConfig;
1111
993
  }
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;
994
+ interface UpsertNotificationConfigRequest {
995
+ /** NotificationConfig to be upserted */
996
+ notificationConfig: NotificationConfig;
997
+ }
998
+ interface UpsertNotificationConfigResponse {
999
+ /** The upserted NotificationConfig */
1000
+ notificationConfig?: NotificationConfig;
1001
+ }
1002
+ interface ResolveEmailNotificationConfigRequest {
1119
1003
  /**
1120
- * Fee rate.
1121
- * @format DECIMAL_VALUE
1122
- * @readonly
1004
+ * Id of the NotificationConfig to retrieve
1005
+ * @format GUID
1123
1006
  */
1124
- rate?: string;
1125
- /** Total amount of fee charges. */
1126
- amount?: Money;
1127
- }
1128
- declare enum FeeName {
1129
- /** Wix ticket service fee charges applied to the line item. */
1130
- WIX_FEE = "WIX_FEE"
1007
+ notificationConfigId?: string;
1008
+ /** Notification type */
1009
+ notificationType?: EmailNotificationTypeWithLiterals;
1131
1010
  }
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"
1011
+ interface ResolveEmailNotificationConfigResponse {
1012
+ /** The retrieved EmailNotificationConfig */
1013
+ emailNotificationConfig?: EmailNotificationConfig;
1141
1014
  }
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. */
1015
+ interface EventCanceled {
1016
+ /** Event canceled timestamp in ISO UTC format. */
1147
1017
  timestamp?: Date | null;
1148
1018
  /**
1149
- * Site language when Order initiated
1150
- * @format LANGUAGE
1019
+ * Event ID.
1020
+ * @format GUID
1151
1021
  */
1152
- language?: string | null;
1022
+ eventId?: string;
1023
+ /** Event title */
1024
+ title?: string;
1153
1025
  /**
1154
- * Locale in which Order was created.
1155
- * @format LANGUAGE_TAG
1026
+ * Event creator user ID.
1027
+ * @format GUID
1156
1028
  */
1157
- locale?: string | null;
1158
- /** Notifications silenced for this domain event. */
1159
- silent?: boolean | null;
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;
1160
1036
  /**
1161
1037
  * Event ID.
1162
1038
  * @format GUID
1163
1039
  */
1164
1040
  eventId?: string;
1041
+ /** Event title. */
1042
+ title?: string;
1165
1043
  /**
1166
- * Unique order number.
1167
- * @maxLength 36
1044
+ * Event creator user ID.
1045
+ * @format GUID
1168
1046
  */
1169
- orderNumber?: string;
1047
+ userId?: string | null;
1048
+ }
1049
+ interface EventCopied {
1050
+ /** Event created timestamp in ISO UTC format. */
1051
+ timestamp?: Date | null;
1170
1052
  /**
1171
- * Contact ID associated with this order.
1053
+ * Event ID.
1172
1054
  * @format GUID
1173
1055
  */
1174
- contactId?: string | null;
1056
+ eventId?: string;
1057
+ /** Event location. */
1058
+ location?: Location;
1059
+ /** Event schedule configuration. */
1060
+ scheduleConfig?: ScheduleConfig;
1061
+ /** Event title. */
1062
+ title?: string;
1175
1063
  /**
1176
- * Member ID associated with this order.
1064
+ * Event creator user ID.
1177
1065
  * @format GUID
1178
1066
  */
1179
- memberId?: string | null;
1067
+ userId?: string | null;
1068
+ /** Event status. */
1069
+ status?: EventStatusWithLiterals;
1180
1070
  /**
1181
- * Order created timestamp.
1182
- * @readonly
1071
+ * Instance ID. Indicates the original app instance which current event was derived from.
1072
+ * @format GUID
1183
1073
  */
1184
- created?: Date | null;
1074
+ derivedFromInstanceId?: string | null;
1185
1075
  /**
1186
- * Order updated timestamp.
1187
- * @readonly
1076
+ * Event ID. Indicates the original event which current event was derived from.
1077
+ * @format GUID
1188
1078
  */
1189
- updated?: Date | null;
1079
+ derivedFromEventId?: string | null;
1190
1080
  /**
1191
- * Buyer first name.
1192
- * @maxLength 255
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.
1193
1084
  */
1194
- firstName?: string | null;
1085
+ ticketDefinitions?: Record<string, string>;
1086
+ }
1087
+ interface Location {
1195
1088
  /**
1196
- * Buyer last name.
1197
- * @maxLength 255
1089
+ * Location name.
1090
+ * @maxLength 50
1198
1091
  */
1199
- lastName?: string | null;
1092
+ name?: string | null;
1093
+ /** Location map coordinates. */
1094
+ coordinates?: MapCoordinates;
1200
1095
  /**
1201
- * Buyer email.
1202
- * @format EMAIL
1096
+ * Single line address representation.
1097
+ * @maxLength 300
1203
1098
  */
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;
1099
+ address?: string | null;
1100
+ /** Location type. */
1101
+ type?: LocationTypeWithLiterals;
1211
1102
  /**
1212
- * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1213
- * @maxLength 100
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`.
1214
1110
  */
1215
- method?: string | null;
1111
+ fullAddress?: Address;
1216
1112
  /**
1217
- * Tickets generated after payment.
1218
- * @maxSize 50
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.
1219
1116
  */
1220
- tickets?: Ticket[];
1221
- /** Whether order was archived and excluded from results. */
1222
- archived?: boolean;
1117
+ tbd?: boolean | null;
1118
+ }
1119
+ interface MapCoordinates {
1223
1120
  /**
1224
- * Reservation ID associated with this order.
1225
- * @format GUID
1121
+ * Latitude.
1122
+ * @min -90
1123
+ * @max 90
1226
1124
  */
1227
- reservationId?: string;
1228
- /** Whether marketing consent was given. */
1229
- marketingConsent?: boolean | null;
1230
- }
1231
- /** Triggered when an order is paid. */
1232
- interface OrderPaid {
1233
- /** Date and time the order was paid. */
1234
- timestamp?: Date | null;
1125
+ lat?: number;
1235
1126
  /**
1236
- * Site language when the order was initiated.
1237
- * @format LANGUAGE
1127
+ * Longitude.
1128
+ * @min -180
1129
+ * @max 180
1238
1130
  */
1239
- language?: string | null;
1240
- /** Notifications silenced for this domain event. */
1241
- silent?: boolean | null;
1131
+ lng?: number;
1132
+ }
1133
+ declare enum LocationType {
1134
+ VENUE = "VENUE",
1135
+ ONLINE = "ONLINE"
1136
+ }
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;
1242
1145
  /**
1243
- * Locale in which the order was created.
1244
- * @format LANGUAGE_TAG
1146
+ * country code
1147
+ * @format COUNTRY
1245
1148
  */
1246
- locale?: string | null;
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;
1247
1166
  /**
1248
- * Event ID to which the order belongs.
1249
- * @format GUID
1167
+ * multi-level subdivisions from top to bottom
1168
+ * @maxSize 6
1250
1169
  */
1251
- eventId?: string;
1252
- /** Unique order number. */
1253
- orderNumber?: string;
1254
- /** Reservation ID associated with this order. */
1255
- reservationId?: string;
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 {
1256
1186
  /**
1257
- * Contact ID associated with this order.
1258
- * @maxLength 36
1187
+ * address latitude coordinates
1188
+ * @min -90
1189
+ * @max 90
1259
1190
  */
1260
- contactId?: string;
1191
+ latitude?: number | null;
1261
1192
  /**
1262
- * Member ID associated with this order.
1263
- * @format GUID
1193
+ * address longitude coordinates
1194
+ * @min -180
1195
+ * @max 180
1264
1196
  */
1265
- memberId?: string | null;
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 {
1266
1206
  /**
1267
- * Date and time the order was created.
1268
- * @readonly
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.
1269
1210
  */
1270
- created?: Date | null;
1211
+ scheduleTbd?: boolean;
1271
1212
  /**
1272
- * Buyer first name.
1273
- * @maxLength 255
1213
+ * TBD message.
1214
+ * @maxLength 100
1274
1215
  */
1275
- firstName?: string;
1216
+ scheduleTbdMessage?: string | null;
1217
+ /** Event start timestamp. */
1218
+ startDate?: Date | null;
1219
+ /** Event end timestamp. */
1220
+ endDate?: Date | null;
1276
1221
  /**
1277
- * Buyer last name.
1278
- * @maxLength 255
1222
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
1223
+ * @maxLength 100
1279
1224
  */
1280
- lastName?: string;
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 {
1281
1234
  /**
1282
- * Buyer email address.
1283
- * @maxLength 255
1235
+ * Event occurrences.
1236
+ * @maxSize 1000
1284
1237
  */
1285
- email?: string;
1286
- /** Checkout form response. */
1287
- checkoutForm?: FormResponse;
1288
- /** Order status. */
1289
- status?: OrderStatusWithLiterals;
1238
+ occurrences?: Occurrence[];
1290
1239
  /**
1291
- * Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
1292
- * @maxLength 255
1240
+ * Recurring event category ID.
1241
+ * @readonly
1293
1242
  */
1294
- method?: string | null;
1243
+ categoryId?: string | null;
1295
1244
  /**
1296
- * Tickets (generated after payment).
1297
- * @maxSize 50
1245
+ * Recurrence status.
1246
+ * @readonly
1298
1247
  */
1299
- tickets?: Ticket[];
1300
- /** Invoice. */
1301
- invoice?: Invoice;
1248
+ status?: StatusWithLiterals;
1302
1249
  }
1303
- interface TicketPdfResolved {
1250
+ interface Occurrence {
1251
+ /** Event start timestamp. */
1252
+ startDate?: Date | null;
1253
+ /** Event end timestamp. */
1254
+ endDate?: Date | null;
1304
1255
  /**
1305
- * Optional order number
1306
- * @maxLength 36
1256
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
1257
+ * @maxLength 100
1307
1258
  */
1308
- orderNumber?: string | null;
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"
1286
+ }
1287
+ /** @enumType */
1288
+ type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
1289
+ interface MessageEnvelope {
1309
1290
  /**
1310
- * Optional ticket number
1311
- * @maxLength 36
1291
+ * App instance ID.
1292
+ * @format GUID
1312
1293
  */
1313
- ticketNumber?: string | null;
1294
+ instanceId?: string | null;
1314
1295
  /**
1315
- * Resolved download url
1316
- * @format WEB_URL
1296
+ * Event type.
1297
+ * @maxLength 150
1317
1298
  */
1318
- downloadUrl?: string | null;
1319
- /** Resolve status */
1320
- resolveFailed?: boolean | null;
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 {
1321
1308
  /**
1322
- * Papyrus document id
1309
+ * ID of a site visitor that has not logged in to the site.
1323
1310
  * @format GUID
1324
1311
  */
1325
- documentId?: string | null;
1326
- }
1327
- interface TicketPdfResolveDelayed {
1312
+ anonymousVisitorId?: string;
1328
1313
  /**
1329
- * Optional order number
1330
- * @maxLength 36
1314
+ * ID of a site visitor that has logged in to the site.
1315
+ * @format GUID
1331
1316
  */
1332
- orderNumber?: string | null;
1317
+ memberId?: string;
1333
1318
  /**
1334
- * Optional ticket number
1335
- * @maxLength 36
1319
+ * ID of a Wix user (site owner, contributor, etc.).
1320
+ * @format GUID
1336
1321
  */
1337
- ticketNumber?: string | null;
1322
+ wixUserId?: string;
1338
1323
  /**
1339
- * Papyrus document id
1324
+ * ID of an app.
1340
1325
  * @format GUID
1341
1326
  */
1342
- documentId?: string | null;
1327
+ appId?: string;
1328
+ /** @readonly */
1329
+ identityType?: WebhookIdentityTypeWithLiterals;
1343
1330
  }
1344
- /** Triggered when an order is canceled. */
1345
- interface OrderCanceled {
1331
+ /** @oneof */
1332
+ interface IdentificationDataIdOneOf {
1346
1333
  /**
1347
- * Event ID to which the order belongs.
1334
+ * ID of a site visitor that has not logged in to the site.
1348
1335
  * @format GUID
1349
1336
  */
1350
- eventId?: string;
1337
+ anonymousVisitorId?: string;
1351
1338
  /**
1352
- * Unique order number.
1353
- * @maxLength 36
1339
+ * ID of a site visitor that has logged in to the site.
1340
+ * @format GUID
1354
1341
  */
1355
- orderNumber?: string;
1342
+ memberId?: string;
1356
1343
  /**
1357
- * Reservation ID associated with the order.
1344
+ * ID of a Wix user (site owner, contributor, etc.).
1358
1345
  * @format GUID
1359
1346
  */
1360
- reservationId?: string;
1347
+ wixUserId?: string;
1361
1348
  /**
1362
- * Contact ID associated with the order.
1363
- * @maxLength 36
1349
+ * ID of an app.
1350
+ * @format GUID
1364
1351
  */
1365
- contactId?: string;
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 {
1366
1364
  /**
1367
- * Buyer first name.
1368
- * @maxLength 50
1365
+ * ID of the Wix account associated with the event.
1366
+ * @format GUID
1369
1367
  */
1370
- firstName?: string | null;
1368
+ accountId?: string | null;
1371
1369
  /**
1372
- * Buyer last name.
1373
- * @maxLength 50
1370
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
1371
+ * @format GUID
1374
1372
  */
1375
- lastName?: string | null;
1373
+ parentAccountId?: string | null;
1376
1374
  /**
1377
- * Buyer email address.
1378
- * @maxLength 255
1375
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1376
+ * @format GUID
1379
1377
  */
1380
- email?: string | null;
1381
- /** Checkout form response. */
1382
- checkoutForm?: FormResponse;
1383
- /** Invoice. */
1384
- invoice?: Invoice;
1378
+ siteId?: string | null;
1385
1379
  }
1386
1380
 
1387
1381
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
@@ -1394,12 +1388,12 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1394
1388
  __responseType: Q;
1395
1389
  __originalResponseType: R;
1396
1390
  };
1391
+ declare function triggerNotification(): __PublicMethodMetaInfo<'POST', {}, TriggerNotificationRequest$1, TriggerNotificationRequest, TriggerNotificationResponse$1, TriggerNotificationResponse>;
1397
1392
  declare function resolveNotificationConfig(): __PublicMethodMetaInfo<'GET', {
1398
1393
  notificationConfigId: string;
1399
1394
  }, ResolveNotificationConfigRequest$1, ResolveNotificationConfigRequest, ResolveNotificationConfigResponse$1, ResolveNotificationConfigResponse>;
1400
1395
  declare function upsertNotificationConfig(): __PublicMethodMetaInfo<'POST', {
1401
1396
  notificationConfigId: string;
1402
1397
  }, UpsertNotificationConfigRequest$1, UpsertNotificationConfigRequest, UpsertNotificationConfigResponse$1, UpsertNotificationConfigResponse>;
1403
- declare function triggerNotification(): __PublicMethodMetaInfo<'POST', {}, TriggerNotificationRequest$1, TriggerNotificationRequest, TriggerNotificationResponse$1, TriggerNotificationResponse>;
1404
1398
 
1405
1399
  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 };