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