@wix/auto_sdk_events_notifications 1.0.74 → 1.0.76
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 +973 -973
- package/build/cjs/index.typings.js +90 -90
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +935 -935
- 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 +973 -973
- package/build/es/index.typings.mjs +90 -90
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +935 -935
- 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 +973 -973
- 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 -935
- 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 +973 -973
- 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 -935
- 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 +12 -5
- package/schemas/package.json +3 -0
|
@@ -120,306 +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
|
-
/**
|
|
323
|
-
* Date and time the order was updated.
|
|
324
|
-
* @readonly
|
|
325
|
-
*/
|
|
326
|
-
updated?: Date | null;
|
|
327
|
-
/** Buyer first name. */
|
|
328
|
-
firstName?: string;
|
|
329
|
-
/** Buyer last name. */
|
|
330
|
-
lastName?: string;
|
|
331
|
-
/** Buyer email address. */
|
|
332
|
-
email?: string;
|
|
333
|
-
/** Checkout form response. */
|
|
334
|
-
checkoutForm?: FormResponse;
|
|
335
|
-
/** Order status. */
|
|
336
|
-
status?: OrderStatusWithLiterals;
|
|
337
|
-
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
338
|
-
method?: string | null;
|
|
339
|
-
/** Tickets (generated after payment). */
|
|
340
|
-
tickets?: Ticket[];
|
|
341
|
-
/** Invoice. */
|
|
342
|
-
invoice?: Invoice;
|
|
343
|
-
/** Reservation ID associated with the order. */
|
|
344
|
-
reservationId?: string;
|
|
345
|
-
}
|
|
346
|
-
interface FormResponse {
|
|
347
|
-
/**
|
|
348
|
-
* Form field inputs.
|
|
349
|
-
* @maxSize 200
|
|
350
|
-
*/
|
|
351
|
-
inputValues?: InputValue[];
|
|
352
|
-
}
|
|
353
|
-
interface InputValue {
|
|
354
|
-
/**
|
|
355
|
-
* Form field input name.
|
|
356
|
-
* @maxLength 100
|
|
357
|
-
*/
|
|
358
|
-
inputName?: string;
|
|
359
|
-
/**
|
|
360
|
-
* Form field value.
|
|
361
|
-
* @maxLength 5000
|
|
362
|
-
*/
|
|
363
|
-
value?: string;
|
|
364
|
-
/**
|
|
365
|
-
* Form field values.
|
|
366
|
-
* @maxSize 100
|
|
367
|
-
* @maxLength 5000
|
|
368
|
-
*/
|
|
369
|
-
values?: string[];
|
|
370
|
-
}
|
|
371
|
-
interface FormattedAddress {
|
|
372
|
-
/**
|
|
373
|
-
* 1-line address representation.
|
|
374
|
-
* @maxLength 200
|
|
375
|
-
*/
|
|
376
|
-
formatted?: string;
|
|
377
|
-
/** Address components. */
|
|
378
|
-
address?: CommonAddress;
|
|
379
|
-
}
|
|
380
|
-
/** Physical address */
|
|
381
|
-
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
382
|
-
/** Street name and number. */
|
|
383
|
-
streetAddress?: CommonStreetAddress;
|
|
384
|
-
/** Main address line, usually street and number as free text. */
|
|
385
|
-
addressLine1?: string | null;
|
|
386
|
-
/**
|
|
387
|
-
* Country code.
|
|
288
|
+
* country code
|
|
388
289
|
* @format COUNTRY
|
|
389
290
|
*/
|
|
390
291
|
country?: string | null;
|
|
391
|
-
/**
|
|
292
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
392
293
|
subdivision?: string | null;
|
|
393
|
-
/**
|
|
294
|
+
/** city name */
|
|
394
295
|
city?: string | null;
|
|
395
|
-
/**
|
|
296
|
+
/** zip/postal code */
|
|
396
297
|
postalCode?: string | null;
|
|
397
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite,
|
|
298
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
398
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[];
|
|
399
313
|
}
|
|
400
314
|
/** @oneof */
|
|
401
|
-
interface
|
|
402
|
-
/**
|
|
403
|
-
streetAddress?:
|
|
404
|
-
/** 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 */
|
|
405
319
|
addressLine?: string | null;
|
|
406
320
|
}
|
|
407
|
-
interface
|
|
408
|
-
/**
|
|
321
|
+
interface StreetAddress {
|
|
322
|
+
/** street number */
|
|
409
323
|
number?: string;
|
|
410
|
-
/**
|
|
324
|
+
/** street name */
|
|
411
325
|
name?: string;
|
|
412
326
|
}
|
|
413
|
-
interface
|
|
414
|
-
/**
|
|
327
|
+
interface AddressLocation {
|
|
328
|
+
/**
|
|
329
|
+
* address latitude coordinates
|
|
330
|
+
* @min -90
|
|
331
|
+
* @max 90
|
|
332
|
+
*/
|
|
415
333
|
latitude?: number | null;
|
|
416
|
-
/**
|
|
334
|
+
/**
|
|
335
|
+
* address longitude coordinates
|
|
336
|
+
* @min -180
|
|
337
|
+
* @max 180
|
|
338
|
+
*/
|
|
417
339
|
longitude?: number | null;
|
|
418
340
|
}
|
|
419
|
-
interface
|
|
420
|
-
/**
|
|
341
|
+
interface Subdivision {
|
|
342
|
+
/** subdivision short code */
|
|
421
343
|
code?: string;
|
|
422
|
-
/**
|
|
344
|
+
/** subdivision full-name */
|
|
423
345
|
name?: string;
|
|
424
346
|
}
|
|
425
347
|
declare enum SubdivisionType {
|
|
@@ -439,945 +361,1023 @@ declare enum SubdivisionType {
|
|
|
439
361
|
}
|
|
440
362
|
/** @enumType */
|
|
441
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';
|
|
442
|
-
|
|
443
|
-
interface StandardDetails {
|
|
444
|
-
/**
|
|
445
|
-
* 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
|
|
446
|
-
* @maxLength 20
|
|
447
|
-
*/
|
|
448
|
-
iso31662?: string | null;
|
|
449
|
-
}
|
|
450
|
-
declare enum OrderStatus {
|
|
451
|
-
/** Order status isn't available for this request fieldset. */
|
|
452
|
-
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
453
|
-
/** Order is confirmed, no payment is required. */
|
|
454
|
-
FREE = "FREE",
|
|
455
|
-
/** Order was paid, but the payment gateway suspended the payment. */
|
|
456
|
-
PENDING = "PENDING",
|
|
457
|
-
/** Order is paid. */
|
|
458
|
-
PAID = "PAID",
|
|
459
|
-
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
460
|
-
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
461
|
-
/** Order is waiting for payment at the cashier. */
|
|
462
|
-
INITIATED = "INITIATED",
|
|
463
|
-
/** Order is canceled. */
|
|
464
|
-
CANCELED = "CANCELED",
|
|
465
|
-
/** Order payment is declined. */
|
|
466
|
-
DECLINED = "DECLINED",
|
|
467
|
-
/** Order payment is authorized. */
|
|
468
|
-
AUTHORIZED = "AUTHORIZED",
|
|
469
|
-
/** Order payment is voided. */
|
|
470
|
-
VOIDED = "VOIDED",
|
|
471
|
-
/** Order is partially paid with less than the total amount. */
|
|
472
|
-
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
473
|
-
}
|
|
474
|
-
/** @enumType */
|
|
475
|
-
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
476
|
-
interface Ticket {
|
|
477
|
-
/** Unique issued ticket number. */
|
|
478
|
-
ticketNumber?: string;
|
|
479
|
-
/**
|
|
480
|
-
* Ticket definition ID.
|
|
481
|
-
* @format GUID
|
|
482
|
-
*/
|
|
483
|
-
ticketDefinitionId?: string;
|
|
484
|
-
/** Ticket check-in. */
|
|
485
|
-
checkIn?: CheckIn;
|
|
486
|
-
/** Ticket price. */
|
|
487
|
-
price?: Money;
|
|
488
|
-
/** Whether ticket is archived. */
|
|
489
|
-
archived?: boolean;
|
|
490
|
-
/** Guest first name. */
|
|
491
|
-
firstName?: string | null;
|
|
492
|
-
/** Guest last name. */
|
|
493
|
-
lastName?: string | null;
|
|
494
|
-
/** Guest email. */
|
|
495
|
-
email?: string | null;
|
|
364
|
+
interface ScheduleConfig {
|
|
496
365
|
/**
|
|
497
|
-
*
|
|
498
|
-
*
|
|
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.
|
|
499
369
|
*/
|
|
500
|
-
|
|
501
|
-
/** Whether ticket is confirmed */
|
|
502
|
-
confirmed?: boolean;
|
|
370
|
+
scheduleTbd?: boolean;
|
|
503
371
|
/**
|
|
504
|
-
*
|
|
505
|
-
* @
|
|
372
|
+
* TBD message.
|
|
373
|
+
* @maxLength 100
|
|
506
374
|
*/
|
|
507
|
-
|
|
508
|
-
/**
|
|
509
|
-
|
|
510
|
-
/**
|
|
511
|
-
|
|
512
|
-
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
513
|
-
anonymized?: boolean;
|
|
514
|
-
/** URL and password to online conference */
|
|
515
|
-
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
375
|
+
scheduleTbdMessage?: string | null;
|
|
376
|
+
/** Event start timestamp. */
|
|
377
|
+
startDate?: Date | null;
|
|
378
|
+
/** Event end timestamp. */
|
|
379
|
+
endDate?: Date | null;
|
|
516
380
|
/**
|
|
517
|
-
*
|
|
518
|
-
* @maxLength
|
|
381
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
382
|
+
* @maxLength 100
|
|
519
383
|
*/
|
|
520
|
-
|
|
521
|
-
/** Whether
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
/**
|
|
526
|
-
|
|
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;
|
|
527
391
|
}
|
|
528
|
-
interface
|
|
392
|
+
interface Recurrences {
|
|
529
393
|
/**
|
|
530
|
-
*
|
|
531
|
-
* @
|
|
532
|
-
* @deprecated
|
|
394
|
+
* Event occurrences.
|
|
395
|
+
* @maxSize 1000
|
|
533
396
|
*/
|
|
534
|
-
|
|
397
|
+
occurrences?: Occurrence[];
|
|
535
398
|
/**
|
|
536
|
-
*
|
|
537
|
-
* @
|
|
399
|
+
* Recurring event category ID.
|
|
400
|
+
* @readonly
|
|
538
401
|
*/
|
|
539
|
-
|
|
402
|
+
categoryId?: string | null;
|
|
540
403
|
/**
|
|
541
|
-
*
|
|
542
|
-
* @
|
|
543
|
-
*/
|
|
544
|
-
|
|
404
|
+
* Recurrence status.
|
|
405
|
+
* @readonly
|
|
406
|
+
*/
|
|
407
|
+
status?: StatusWithLiterals;
|
|
545
408
|
}
|
|
546
|
-
interface
|
|
409
|
+
interface Occurrence {
|
|
410
|
+
/** Event start timestamp. */
|
|
411
|
+
startDate?: Date | null;
|
|
412
|
+
/** Event end timestamp. */
|
|
413
|
+
endDate?: Date | null;
|
|
547
414
|
/**
|
|
548
|
-
*
|
|
549
|
-
* @
|
|
550
|
-
* @readonly
|
|
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;
|
|
421
|
+
}
|
|
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;
|
|
553
455
|
/**
|
|
554
|
-
*
|
|
555
|
-
*
|
|
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`.
|
|
556
458
|
*/
|
|
557
|
-
|
|
459
|
+
entityFqdn?: string;
|
|
460
|
+
/**
|
|
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`.
|
|
463
|
+
*/
|
|
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;
|
|
469
|
+
/**
|
|
470
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
471
|
+
* (for example, GDPR).
|
|
472
|
+
*/
|
|
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;
|
|
558
481
|
}
|
|
559
|
-
|
|
560
|
-
|
|
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 {
|
|
561
496
|
/**
|
|
562
|
-
*
|
|
563
|
-
*
|
|
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.
|
|
564
500
|
*/
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
/**
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
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 {
|
|
572
511
|
/**
|
|
573
|
-
*
|
|
574
|
-
*
|
|
575
|
-
* 1. Total prices of all items in the cart are calculated.
|
|
576
|
-
* 2. Discount is subtracted from the cart, if applicable.
|
|
577
|
-
* 3. Tax is added, if applicable.
|
|
578
|
-
* 4. Wix ticket service fee is added.
|
|
512
|
+
* App instance ID.
|
|
513
|
+
* @format GUID
|
|
579
514
|
*/
|
|
580
|
-
|
|
515
|
+
instanceId?: string | null;
|
|
581
516
|
/**
|
|
582
|
-
*
|
|
583
|
-
* @
|
|
517
|
+
* Event type.
|
|
518
|
+
* @maxLength 150
|
|
584
519
|
*/
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
|
|
588
|
-
/**
|
|
589
|
-
|
|
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;
|
|
590
527
|
}
|
|
591
|
-
interface
|
|
528
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
592
529
|
/**
|
|
593
|
-
*
|
|
530
|
+
* ID of a site visitor that has not logged in to the site.
|
|
594
531
|
* @format GUID
|
|
595
532
|
*/
|
|
596
|
-
|
|
533
|
+
anonymousVisitorId?: string;
|
|
597
534
|
/**
|
|
598
|
-
*
|
|
599
|
-
* @
|
|
600
|
-
* @max 50
|
|
535
|
+
* ID of a site visitor that has logged in to the site.
|
|
536
|
+
* @format GUID
|
|
601
537
|
*/
|
|
602
|
-
|
|
603
|
-
/** Line item name. */
|
|
604
|
-
name?: string;
|
|
605
|
-
/** Line item price. */
|
|
606
|
-
price?: Money;
|
|
607
|
-
/** Total price for line items. Always equal to price * quantity. */
|
|
608
|
-
total?: Money;
|
|
609
|
-
/** Discount applied to the line item. */
|
|
610
|
-
discount?: Discount;
|
|
611
|
-
/** Tax applied to the item. */
|
|
612
|
-
tax?: Tax;
|
|
538
|
+
memberId?: string;
|
|
613
539
|
/**
|
|
614
|
-
*
|
|
615
|
-
* @
|
|
540
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
541
|
+
* @format GUID
|
|
616
542
|
*/
|
|
617
|
-
|
|
543
|
+
wixUserId?: string;
|
|
544
|
+
/**
|
|
545
|
+
* ID of an app.
|
|
546
|
+
* @format GUID
|
|
547
|
+
*/
|
|
548
|
+
appId?: string;
|
|
549
|
+
/** @readonly */
|
|
550
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
618
551
|
}
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
amount?: Money;
|
|
622
|
-
/** Total sum after the discount. */
|
|
623
|
-
afterDiscount?: Money;
|
|
552
|
+
/** @oneof */
|
|
553
|
+
interface IdentificationDataIdOneOf {
|
|
624
554
|
/**
|
|
625
|
-
*
|
|
626
|
-
* @
|
|
555
|
+
* ID of a site visitor that has not logged in to the site.
|
|
556
|
+
* @format GUID
|
|
627
557
|
*/
|
|
628
|
-
|
|
558
|
+
anonymousVisitorId?: string;
|
|
629
559
|
/**
|
|
630
|
-
*
|
|
631
|
-
* @
|
|
560
|
+
* ID of a site visitor that has logged in to the site.
|
|
561
|
+
* @format GUID
|
|
632
562
|
*/
|
|
633
|
-
|
|
563
|
+
memberId?: string;
|
|
634
564
|
/**
|
|
635
|
-
*
|
|
636
|
-
* @
|
|
565
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
566
|
+
* @format GUID
|
|
637
567
|
*/
|
|
638
|
-
|
|
639
|
-
/**
|
|
640
|
-
|
|
568
|
+
wixUserId?: string;
|
|
569
|
+
/**
|
|
570
|
+
* ID of an app.
|
|
571
|
+
* @format GUID
|
|
572
|
+
*/
|
|
573
|
+
appId?: string;
|
|
641
574
|
}
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
amount?: Money;
|
|
575
|
+
declare enum WebhookIdentityType {
|
|
576
|
+
UNKNOWN = "UNKNOWN",
|
|
577
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
578
|
+
MEMBER = "MEMBER",
|
|
579
|
+
WIX_USER = "WIX_USER",
|
|
580
|
+
APP = "APP"
|
|
649
581
|
}
|
|
650
|
-
/** @
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
582
|
+
/** @enumType */
|
|
583
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
584
|
+
interface AccountInfo {
|
|
585
|
+
/**
|
|
586
|
+
* ID of the Wix account associated with the event.
|
|
587
|
+
* @format GUID
|
|
588
|
+
*/
|
|
589
|
+
accountId?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
592
|
+
* @format GUID
|
|
593
|
+
*/
|
|
594
|
+
parentAccountId?: string | null;
|
|
595
|
+
/**
|
|
596
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
597
|
+
* @format GUID
|
|
598
|
+
*/
|
|
599
|
+
siteId?: string | null;
|
|
656
600
|
}
|
|
657
|
-
interface
|
|
658
|
-
/**
|
|
659
|
-
|
|
660
|
-
/**
|
|
661
|
-
|
|
662
|
-
/**
|
|
663
|
-
|
|
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;
|
|
664
614
|
}
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
615
|
+
/** @oneof */
|
|
616
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
617
|
+
/** Email notification type */
|
|
618
|
+
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
619
|
+
/** Push notification type */
|
|
620
|
+
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
670
621
|
}
|
|
671
622
|
/** @oneof */
|
|
672
|
-
interface
|
|
673
|
-
/**
|
|
674
|
-
|
|
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;
|
|
675
632
|
}
|
|
676
|
-
|
|
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 {
|
|
677
647
|
/**
|
|
678
|
-
*
|
|
679
|
-
* @
|
|
648
|
+
* Event id
|
|
649
|
+
* @format GUID
|
|
680
650
|
*/
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
|
|
651
|
+
eventId?: string;
|
|
652
|
+
/**
|
|
653
|
+
* Rsvp id
|
|
654
|
+
* @format GUID
|
|
655
|
+
*/
|
|
656
|
+
rsvpId?: string;
|
|
684
657
|
}
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
type?: TaxTypeWithLiterals;
|
|
658
|
+
/** Single guest associated to the Order */
|
|
659
|
+
interface OrderGuest {
|
|
688
660
|
/**
|
|
689
|
-
*
|
|
690
|
-
* @
|
|
661
|
+
* Event id
|
|
662
|
+
* @format GUID
|
|
691
663
|
*/
|
|
692
|
-
|
|
664
|
+
eventId?: string;
|
|
693
665
|
/**
|
|
694
|
-
*
|
|
695
|
-
* @
|
|
666
|
+
* Order number
|
|
667
|
+
* @maxLength 36
|
|
696
668
|
*/
|
|
697
|
-
|
|
698
|
-
/** Taxable amount. */
|
|
699
|
-
taxable?: Money;
|
|
700
|
-
/** Total tax amount. */
|
|
701
|
-
amount?: Money;
|
|
702
|
-
}
|
|
703
|
-
declare enum TaxType {
|
|
704
|
-
/** Tax is included in the ticket price. */
|
|
705
|
-
INCLUDED = "INCLUDED",
|
|
706
|
-
/** Tax is added to the order at the checkout. */
|
|
707
|
-
ADDED = "ADDED",
|
|
708
|
-
/** Tax is added to the final total at the checkout. */
|
|
709
|
-
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
669
|
+
orderNumber?: string;
|
|
710
670
|
}
|
|
711
|
-
/**
|
|
712
|
-
|
|
713
|
-
interface Fee {
|
|
714
|
-
/** Fee identifier. */
|
|
715
|
-
name?: FeeNameWithLiterals;
|
|
716
|
-
/** How fee is calculated. */
|
|
717
|
-
type?: FeeTypeWithLiterals;
|
|
671
|
+
/** All event guest from RSVPs and Orders */
|
|
672
|
+
interface EventGuests {
|
|
718
673
|
/**
|
|
719
|
-
*
|
|
720
|
-
* @format
|
|
721
|
-
* @readonly
|
|
674
|
+
* Event id
|
|
675
|
+
* @format GUID
|
|
722
676
|
*/
|
|
723
|
-
|
|
724
|
-
/** Total amount of fee charges. */
|
|
725
|
-
amount?: Money;
|
|
677
|
+
eventId?: string;
|
|
726
678
|
}
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
679
|
+
/** Multiple guests associated to Tickets */
|
|
680
|
+
interface TicketGuest {
|
|
681
|
+
/**
|
|
682
|
+
* Event id
|
|
683
|
+
* @format GUID
|
|
684
|
+
*/
|
|
685
|
+
eventId?: string;
|
|
686
|
+
/**
|
|
687
|
+
* Order number
|
|
688
|
+
* @maxLength 36
|
|
689
|
+
*/
|
|
690
|
+
orderNumber?: string | null;
|
|
691
|
+
/**
|
|
692
|
+
* Ticket numbers must be from the same order only.
|
|
693
|
+
* @minSize 1
|
|
694
|
+
* @maxSize 100
|
|
695
|
+
* @maxLength 36
|
|
696
|
+
*/
|
|
697
|
+
ticketNumber?: string[];
|
|
730
698
|
}
|
|
731
|
-
|
|
732
|
-
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
733
|
-
declare enum FeeType {
|
|
734
|
-
/** Fee is added to the ticket price at checkout. */
|
|
735
|
-
FEE_ADDED = "FEE_ADDED",
|
|
736
|
-
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
737
|
-
FEE_INCLUDED = "FEE_INCLUDED",
|
|
738
|
-
/** Fee is added to the ticket price at checkout. */
|
|
739
|
-
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
699
|
+
interface TriggerNotificationResponse {
|
|
740
700
|
}
|
|
741
|
-
/**
|
|
742
|
-
|
|
743
|
-
/**
|
|
744
|
-
interface OrderEmailAdded {
|
|
745
|
-
/** Order updated timestamp in ISO UTC format. */
|
|
701
|
+
/** Triggered when an order is confirmed. */
|
|
702
|
+
interface OrderConfirmed {
|
|
703
|
+
/** Date and time the order was confirmed. */
|
|
746
704
|
timestamp?: Date | null;
|
|
747
705
|
/**
|
|
748
|
-
* Site language when
|
|
706
|
+
* Site language when the order was initiated.
|
|
749
707
|
* @format LANGUAGE
|
|
750
708
|
*/
|
|
751
709
|
language?: string | null;
|
|
710
|
+
/** Notifications silenced for this domain event. */
|
|
711
|
+
silent?: boolean | null;
|
|
752
712
|
/**
|
|
753
|
-
* Locale in which
|
|
713
|
+
* Locale in which the order was created.
|
|
754
714
|
* @format LANGUAGE_TAG
|
|
755
715
|
*/
|
|
756
716
|
locale?: string | null;
|
|
757
|
-
/** Notifications silenced for this domain event. */
|
|
758
|
-
silent?: boolean | null;
|
|
759
717
|
/**
|
|
760
|
-
* Event ID.
|
|
718
|
+
* Event ID to which the order belongs.
|
|
761
719
|
* @format GUID
|
|
762
720
|
*/
|
|
763
721
|
eventId?: string;
|
|
764
|
-
/**
|
|
765
|
-
* Unique order number.
|
|
766
|
-
* @maxLength 36
|
|
767
|
-
*/
|
|
722
|
+
/** Unique order number. */
|
|
768
723
|
orderNumber?: string;
|
|
724
|
+
/** Contact ID associated with the order. */
|
|
725
|
+
contactId?: string;
|
|
769
726
|
/**
|
|
770
|
-
*
|
|
771
|
-
* @format GUID
|
|
772
|
-
*/
|
|
773
|
-
contactId?: string | null;
|
|
774
|
-
/**
|
|
775
|
-
* Member ID associated with this order.
|
|
727
|
+
* Member ID associated with the order.
|
|
776
728
|
* @format GUID
|
|
777
729
|
*/
|
|
778
730
|
memberId?: string | null;
|
|
779
731
|
/**
|
|
780
|
-
*
|
|
732
|
+
* Date and time the order was created.
|
|
781
733
|
* @readonly
|
|
782
734
|
*/
|
|
783
735
|
created?: Date | null;
|
|
784
736
|
/**
|
|
785
|
-
*
|
|
737
|
+
* Date and time the order was updated.
|
|
786
738
|
* @readonly
|
|
787
739
|
*/
|
|
788
740
|
updated?: Date | null;
|
|
789
|
-
/**
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
* Buyer last name.
|
|
796
|
-
* @maxLength 255
|
|
797
|
-
*/
|
|
798
|
-
lastName?: string | null;
|
|
799
|
-
/**
|
|
800
|
-
* Buyer email.
|
|
801
|
-
* @format EMAIL
|
|
802
|
-
*/
|
|
803
|
-
email?: string | null;
|
|
741
|
+
/** Buyer first name. */
|
|
742
|
+
firstName?: string;
|
|
743
|
+
/** Buyer last name. */
|
|
744
|
+
lastName?: string;
|
|
745
|
+
/** Buyer email address. */
|
|
746
|
+
email?: string;
|
|
804
747
|
/** Checkout form response. */
|
|
805
748
|
checkoutForm?: FormResponse;
|
|
806
|
-
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
807
|
-
confirmed?: boolean;
|
|
808
749
|
/** Order status. */
|
|
809
750
|
status?: OrderStatusWithLiterals;
|
|
810
|
-
/**
|
|
811
|
-
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
812
|
-
* @maxLength 100
|
|
813
|
-
*/
|
|
751
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
814
752
|
method?: string | null;
|
|
815
|
-
/**
|
|
816
|
-
* Tickets generated after payment.
|
|
817
|
-
* @maxSize 50
|
|
818
|
-
*/
|
|
753
|
+
/** Tickets (generated after payment). */
|
|
819
754
|
tickets?: Ticket[];
|
|
820
|
-
/**
|
|
821
|
-
|
|
755
|
+
/** Invoice. */
|
|
756
|
+
invoice?: Invoice;
|
|
757
|
+
/** Reservation ID associated with the order. */
|
|
758
|
+
reservationId?: string;
|
|
759
|
+
}
|
|
760
|
+
interface FormResponse {
|
|
822
761
|
/**
|
|
823
|
-
*
|
|
824
|
-
* @
|
|
762
|
+
* Form field inputs.
|
|
763
|
+
* @maxSize 200
|
|
825
764
|
*/
|
|
826
|
-
|
|
827
|
-
/** Whether marketing consent was given. */
|
|
828
|
-
marketingConsent?: boolean | null;
|
|
765
|
+
inputValues?: InputValue[];
|
|
829
766
|
}
|
|
830
|
-
|
|
831
|
-
interface OrderPaid {
|
|
832
|
-
/** Date and time the order was paid. */
|
|
833
|
-
timestamp?: Date | null;
|
|
767
|
+
interface InputValue {
|
|
834
768
|
/**
|
|
835
|
-
*
|
|
836
|
-
* @
|
|
769
|
+
* Form field input name.
|
|
770
|
+
* @maxLength 100
|
|
837
771
|
*/
|
|
838
|
-
|
|
839
|
-
/** Notifications silenced for this domain event. */
|
|
840
|
-
silent?: boolean | null;
|
|
772
|
+
inputName?: string;
|
|
841
773
|
/**
|
|
842
|
-
*
|
|
843
|
-
* @
|
|
774
|
+
* Form field value.
|
|
775
|
+
* @maxLength 5000
|
|
844
776
|
*/
|
|
845
|
-
|
|
777
|
+
value?: string;
|
|
846
778
|
/**
|
|
847
|
-
*
|
|
848
|
-
* @
|
|
779
|
+
* Form field values.
|
|
780
|
+
* @maxSize 100
|
|
781
|
+
* @maxLength 5000
|
|
849
782
|
*/
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
/** Reservation ID associated with this order. */
|
|
854
|
-
reservationId?: string;
|
|
783
|
+
values?: string[];
|
|
784
|
+
}
|
|
785
|
+
interface FormattedAddress {
|
|
855
786
|
/**
|
|
856
|
-
*
|
|
857
|
-
* @maxLength
|
|
787
|
+
* 1-line address representation.
|
|
788
|
+
* @maxLength 200
|
|
858
789
|
*/
|
|
859
|
-
|
|
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;
|
|
860
800
|
/**
|
|
861
|
-
*
|
|
862
|
-
* @format
|
|
801
|
+
* Country code.
|
|
802
|
+
* @format COUNTRY
|
|
863
803
|
*/
|
|
864
|
-
|
|
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 {
|
|
865
841
|
/**
|
|
866
|
-
*
|
|
867
|
-
* @
|
|
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
|
|
868
844
|
*/
|
|
869
|
-
|
|
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;
|
|
870
876
|
/**
|
|
871
|
-
*
|
|
872
|
-
* @
|
|
877
|
+
* Ticket definition ID.
|
|
878
|
+
* @format GUID
|
|
873
879
|
*/
|
|
874
|
-
|
|
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;
|
|
875
893
|
/**
|
|
876
|
-
*
|
|
877
|
-
* @
|
|
894
|
+
* Contact ID associated with this ticket.
|
|
895
|
+
* @format GUID
|
|
878
896
|
*/
|
|
879
|
-
|
|
897
|
+
contactId?: string | null;
|
|
898
|
+
/** Whether ticket is confirmed */
|
|
899
|
+
confirmed?: boolean;
|
|
880
900
|
/**
|
|
881
|
-
*
|
|
882
|
-
* @
|
|
901
|
+
* Member ID associated with this ticket.
|
|
902
|
+
* @format GUID
|
|
883
903
|
*/
|
|
884
|
-
|
|
885
|
-
/**
|
|
886
|
-
|
|
887
|
-
/**
|
|
888
|
-
|
|
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;
|
|
889
913
|
/**
|
|
890
|
-
*
|
|
891
|
-
* @maxLength
|
|
914
|
+
* Seat ID associated with this ticket.
|
|
915
|
+
* @maxLength 36
|
|
892
916
|
*/
|
|
893
|
-
|
|
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 {
|
|
894
926
|
/**
|
|
895
|
-
*
|
|
896
|
-
* @
|
|
927
|
+
* *Deprecated:** Use `value` instead.
|
|
928
|
+
* @format DECIMAL_VALUE
|
|
929
|
+
* @deprecated
|
|
897
930
|
*/
|
|
898
|
-
|
|
899
|
-
/** Invoice. */
|
|
900
|
-
invoice?: Invoice;
|
|
901
|
-
}
|
|
902
|
-
interface TicketPdfResolved {
|
|
931
|
+
amount?: string;
|
|
903
932
|
/**
|
|
904
|
-
*
|
|
905
|
-
* @
|
|
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
|
|
906
935
|
*/
|
|
907
|
-
|
|
936
|
+
currency?: string;
|
|
908
937
|
/**
|
|
909
|
-
*
|
|
910
|
-
* @
|
|
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
|
|
911
940
|
*/
|
|
912
|
-
|
|
941
|
+
value?: string | null;
|
|
942
|
+
}
|
|
943
|
+
interface OnlineConferencingLogin {
|
|
913
944
|
/**
|
|
914
|
-
*
|
|
945
|
+
* Link URL to the online conference.
|
|
915
946
|
* @format WEB_URL
|
|
947
|
+
* @readonly
|
|
916
948
|
*/
|
|
917
|
-
|
|
918
|
-
/** Resolve status */
|
|
919
|
-
resolveFailed?: boolean | null;
|
|
949
|
+
link?: string;
|
|
920
950
|
/**
|
|
921
|
-
*
|
|
922
|
-
* @
|
|
951
|
+
* Password for the online conference.
|
|
952
|
+
* @readonly
|
|
923
953
|
*/
|
|
924
|
-
|
|
954
|
+
password?: string | null;
|
|
925
955
|
}
|
|
926
|
-
interface
|
|
956
|
+
interface Invoice {
|
|
957
|
+
items?: Item[];
|
|
927
958
|
/**
|
|
928
|
-
*
|
|
929
|
-
* @
|
|
959
|
+
* Total cart amount.
|
|
960
|
+
* @deprecated
|
|
930
961
|
*/
|
|
931
|
-
|
|
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;
|
|
932
969
|
/**
|
|
933
|
-
*
|
|
934
|
-
*
|
|
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.
|
|
935
976
|
*/
|
|
936
|
-
|
|
977
|
+
grandTotal?: Money;
|
|
937
978
|
/**
|
|
938
|
-
*
|
|
939
|
-
* @
|
|
979
|
+
* Fees applied to the cart.
|
|
980
|
+
* @readonly
|
|
940
981
|
*/
|
|
941
|
-
|
|
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;
|
|
942
987
|
}
|
|
943
|
-
|
|
944
|
-
interface OrderCanceled {
|
|
988
|
+
interface Item {
|
|
945
989
|
/**
|
|
946
|
-
*
|
|
990
|
+
* Unique line item ID.
|
|
947
991
|
* @format GUID
|
|
948
992
|
*/
|
|
949
|
-
|
|
993
|
+
_id?: string;
|
|
950
994
|
/**
|
|
951
|
-
*
|
|
952
|
-
* @
|
|
995
|
+
* Line item quantity.
|
|
996
|
+
* @min 1
|
|
997
|
+
* @max 50
|
|
953
998
|
*/
|
|
954
|
-
|
|
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;
|
|
955
1010
|
/**
|
|
956
|
-
*
|
|
957
|
-
* @
|
|
1011
|
+
* Fees applied to the item.
|
|
1012
|
+
* @readonly
|
|
958
1013
|
*/
|
|
959
|
-
|
|
1014
|
+
fees?: Fee[];
|
|
1015
|
+
}
|
|
1016
|
+
interface Discount {
|
|
1017
|
+
/** Total discount amount. */
|
|
1018
|
+
amount?: Money;
|
|
1019
|
+
/** Total sum after the discount. */
|
|
1020
|
+
afterDiscount?: Money;
|
|
960
1021
|
/**
|
|
961
|
-
*
|
|
962
|
-
* @
|
|
1022
|
+
* Discount coupon code.
|
|
1023
|
+
* @deprecated
|
|
963
1024
|
*/
|
|
964
|
-
|
|
1025
|
+
code?: string;
|
|
965
1026
|
/**
|
|
966
|
-
*
|
|
967
|
-
* @
|
|
1027
|
+
* Discount coupon name.
|
|
1028
|
+
* @deprecated
|
|
968
1029
|
*/
|
|
969
|
-
|
|
1030
|
+
name?: string;
|
|
970
1031
|
/**
|
|
971
|
-
*
|
|
972
|
-
* @
|
|
1032
|
+
* Discount coupon ID.
|
|
1033
|
+
* @deprecated
|
|
973
1034
|
*/
|
|
974
|
-
|
|
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 {
|
|
975
1074
|
/**
|
|
976
|
-
*
|
|
977
|
-
* @
|
|
1075
|
+
* Percent rate.
|
|
1076
|
+
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
978
1077
|
*/
|
|
979
|
-
|
|
980
|
-
/**
|
|
981
|
-
|
|
982
|
-
/** Invoice. */
|
|
983
|
-
invoice?: Invoice;
|
|
1078
|
+
rate?: string;
|
|
1079
|
+
/** Number of discounted tickets. */
|
|
1080
|
+
quantityDiscounted?: number;
|
|
984
1081
|
}
|
|
985
|
-
interface
|
|
1082
|
+
interface Tax {
|
|
1083
|
+
/** Tax type. */
|
|
1084
|
+
type?: TaxTypeWithLiterals;
|
|
986
1085
|
/**
|
|
987
|
-
*
|
|
988
|
-
* @
|
|
1086
|
+
* Tax name.
|
|
1087
|
+
* @readonly
|
|
989
1088
|
*/
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
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;
|
|
999
1099
|
}
|
|
1000
|
-
|
|
1001
|
-
/**
|
|
1002
|
-
|
|
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"
|
|
1003
1107
|
}
|
|
1004
|
-
|
|
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;
|
|
1005
1115
|
/**
|
|
1006
|
-
*
|
|
1007
|
-
* @format
|
|
1116
|
+
* Fee rate.
|
|
1117
|
+
* @format DECIMAL_VALUE
|
|
1118
|
+
* @readonly
|
|
1008
1119
|
*/
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
|
|
1120
|
+
rate?: string;
|
|
1121
|
+
/** Total amount of fee charges. */
|
|
1122
|
+
amount?: Money;
|
|
1012
1123
|
}
|
|
1013
|
-
|
|
1014
|
-
/**
|
|
1015
|
-
|
|
1124
|
+
declare enum FeeName {
|
|
1125
|
+
/** Wix ticket service fee charges applied to the line item. */
|
|
1126
|
+
WIX_FEE = "WIX_FEE"
|
|
1016
1127
|
}
|
|
1017
|
-
|
|
1018
|
-
|
|
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. */
|
|
1019
1143
|
timestamp?: Date | null;
|
|
1020
1144
|
/**
|
|
1021
|
-
*
|
|
1022
|
-
* @format
|
|
1145
|
+
* Site language when Order initiated
|
|
1146
|
+
* @format LANGUAGE
|
|
1023
1147
|
*/
|
|
1024
|
-
|
|
1025
|
-
/** Event title */
|
|
1026
|
-
title?: string;
|
|
1148
|
+
language?: string | null;
|
|
1027
1149
|
/**
|
|
1028
|
-
*
|
|
1029
|
-
* @format
|
|
1150
|
+
* Locale in which Order was created.
|
|
1151
|
+
* @format LANGUAGE_TAG
|
|
1030
1152
|
*/
|
|
1031
|
-
|
|
1032
|
-
/**
|
|
1033
|
-
|
|
1034
|
-
}
|
|
1035
|
-
interface EventDeleted {
|
|
1036
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
1037
|
-
timestamp?: Date | null;
|
|
1153
|
+
locale?: string | null;
|
|
1154
|
+
/** Notifications silenced for this domain event. */
|
|
1155
|
+
silent?: boolean | null;
|
|
1038
1156
|
/**
|
|
1039
1157
|
* Event ID.
|
|
1040
1158
|
* @format GUID
|
|
1041
1159
|
*/
|
|
1042
1160
|
eventId?: string;
|
|
1043
|
-
/** Event title. */
|
|
1044
|
-
title?: string;
|
|
1045
|
-
/**
|
|
1046
|
-
* Event creator user ID.
|
|
1047
|
-
* @format GUID
|
|
1048
|
-
*/
|
|
1049
|
-
userId?: string | null;
|
|
1050
|
-
}
|
|
1051
|
-
interface EventCopied {
|
|
1052
|
-
/** Event created timestamp in ISO UTC format. */
|
|
1053
|
-
timestamp?: Date | null;
|
|
1054
1161
|
/**
|
|
1055
|
-
*
|
|
1056
|
-
* @
|
|
1162
|
+
* Unique order number.
|
|
1163
|
+
* @maxLength 36
|
|
1057
1164
|
*/
|
|
1058
|
-
|
|
1059
|
-
/** Event location. */
|
|
1060
|
-
location?: Location;
|
|
1061
|
-
/** Event schedule configuration. */
|
|
1062
|
-
scheduleConfig?: ScheduleConfig;
|
|
1063
|
-
/** Event title. */
|
|
1064
|
-
title?: string;
|
|
1165
|
+
orderNumber?: string;
|
|
1065
1166
|
/**
|
|
1066
|
-
*
|
|
1167
|
+
* Contact ID associated with this order.
|
|
1067
1168
|
* @format GUID
|
|
1068
1169
|
*/
|
|
1069
|
-
|
|
1070
|
-
/** Event status. */
|
|
1071
|
-
status?: EventStatusWithLiterals;
|
|
1170
|
+
contactId?: string | null;
|
|
1072
1171
|
/**
|
|
1073
|
-
*
|
|
1172
|
+
* Member ID associated with this order.
|
|
1074
1173
|
* @format GUID
|
|
1075
1174
|
*/
|
|
1076
|
-
|
|
1175
|
+
memberId?: string | null;
|
|
1077
1176
|
/**
|
|
1078
|
-
*
|
|
1079
|
-
* @
|
|
1177
|
+
* Order created timestamp.
|
|
1178
|
+
* @readonly
|
|
1080
1179
|
*/
|
|
1081
|
-
|
|
1180
|
+
created?: Date | null;
|
|
1082
1181
|
/**
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
* Value represents ticket def id in the newly created event.
|
|
1182
|
+
* Order updated timestamp.
|
|
1183
|
+
* @readonly
|
|
1086
1184
|
*/
|
|
1087
|
-
|
|
1088
|
-
}
|
|
1089
|
-
interface Location {
|
|
1185
|
+
updated?: Date | null;
|
|
1090
1186
|
/**
|
|
1091
|
-
*
|
|
1092
|
-
* @maxLength
|
|
1187
|
+
* Buyer first name.
|
|
1188
|
+
* @maxLength 255
|
|
1093
1189
|
*/
|
|
1094
|
-
|
|
1095
|
-
/** Location map coordinates. */
|
|
1096
|
-
coordinates?: MapCoordinates;
|
|
1190
|
+
firstName?: string | null;
|
|
1097
1191
|
/**
|
|
1098
|
-
*
|
|
1099
|
-
* @maxLength
|
|
1192
|
+
* Buyer last name.
|
|
1193
|
+
* @maxLength 255
|
|
1100
1194
|
*/
|
|
1101
|
-
|
|
1102
|
-
/** Location type. */
|
|
1103
|
-
type?: LocationTypeWithLiterals;
|
|
1195
|
+
lastName?: string | null;
|
|
1104
1196
|
/**
|
|
1105
|
-
*
|
|
1106
|
-
*
|
|
1107
|
-
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1108
|
-
*
|
|
1109
|
-
* Migration notes:
|
|
1110
|
-
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1111
|
-
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1197
|
+
* Buyer email.
|
|
1198
|
+
* @format EMAIL
|
|
1112
1199
|
*/
|
|
1113
|
-
|
|
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;
|
|
1114
1207
|
/**
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1117
|
-
* `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
|
|
1118
1210
|
*/
|
|
1119
|
-
|
|
1120
|
-
}
|
|
1121
|
-
interface MapCoordinates {
|
|
1211
|
+
method?: string | null;
|
|
1122
1212
|
/**
|
|
1123
|
-
*
|
|
1124
|
-
* @
|
|
1125
|
-
* @max 90
|
|
1213
|
+
* Tickets generated after payment.
|
|
1214
|
+
* @maxSize 50
|
|
1126
1215
|
*/
|
|
1127
|
-
|
|
1216
|
+
tickets?: Ticket[];
|
|
1217
|
+
/** Whether order was archived and excluded from results. */
|
|
1218
|
+
archived?: boolean;
|
|
1128
1219
|
/**
|
|
1129
|
-
*
|
|
1130
|
-
* @
|
|
1131
|
-
* @max 180
|
|
1220
|
+
* Reservation ID associated with this order.
|
|
1221
|
+
* @format GUID
|
|
1132
1222
|
*/
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
VENUE = "VENUE",
|
|
1137
|
-
ONLINE = "ONLINE"
|
|
1223
|
+
reservationId?: string;
|
|
1224
|
+
/** Whether marketing consent was given. */
|
|
1225
|
+
marketingConsent?: boolean | null;
|
|
1138
1226
|
}
|
|
1139
|
-
/**
|
|
1140
|
-
|
|
1141
|
-
/**
|
|
1142
|
-
|
|
1143
|
-
/** a break down of the street to number and street name */
|
|
1144
|
-
streetAddress?: StreetAddress;
|
|
1145
|
-
/** Main address line (usually street and number) as free text */
|
|
1146
|
-
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;
|
|
1147
1231
|
/**
|
|
1148
|
-
*
|
|
1149
|
-
* @format
|
|
1232
|
+
* Site language when the order was initiated.
|
|
1233
|
+
* @format LANGUAGE
|
|
1150
1234
|
*/
|
|
1151
|
-
|
|
1152
|
-
/**
|
|
1153
|
-
|
|
1154
|
-
/** city name */
|
|
1155
|
-
city?: string | null;
|
|
1156
|
-
/** zip/postal code */
|
|
1157
|
-
postalCode?: string | null;
|
|
1158
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1159
|
-
addressLine2?: string | null;
|
|
1160
|
-
/** A string containing the human-readable address of this location */
|
|
1161
|
-
formatted?: string | null;
|
|
1162
|
-
/** Free text for human-to-human textual orientation aid purposes */
|
|
1163
|
-
hint?: string | null;
|
|
1164
|
-
/** coordinates of the physical address */
|
|
1165
|
-
location?: AddressLocation;
|
|
1166
|
-
/** country full-name */
|
|
1167
|
-
countryFullname?: string | null;
|
|
1235
|
+
language?: string | null;
|
|
1236
|
+
/** Notifications silenced for this domain event. */
|
|
1237
|
+
silent?: boolean | null;
|
|
1168
1238
|
/**
|
|
1169
|
-
*
|
|
1170
|
-
* @
|
|
1239
|
+
* Locale in which the order was created.
|
|
1240
|
+
* @format LANGUAGE_TAG
|
|
1171
1241
|
*/
|
|
1172
|
-
|
|
1173
|
-
}
|
|
1174
|
-
/** @oneof */
|
|
1175
|
-
interface AddressStreetOneOf {
|
|
1176
|
-
/** a break down of the street to number and street name */
|
|
1177
|
-
streetAddress?: StreetAddress;
|
|
1178
|
-
/** Main address line (usually street and number) as free text */
|
|
1179
|
-
addressLine?: string | null;
|
|
1180
|
-
}
|
|
1181
|
-
interface StreetAddress {
|
|
1182
|
-
/** street number */
|
|
1183
|
-
number?: string;
|
|
1184
|
-
/** street name */
|
|
1185
|
-
name?: string;
|
|
1186
|
-
}
|
|
1187
|
-
interface AddressLocation {
|
|
1242
|
+
locale?: string | null;
|
|
1188
1243
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @
|
|
1191
|
-
* @max 90
|
|
1244
|
+
* Event ID to which the order belongs.
|
|
1245
|
+
* @format GUID
|
|
1192
1246
|
*/
|
|
1193
|
-
|
|
1247
|
+
eventId?: string;
|
|
1248
|
+
/** Unique order number. */
|
|
1249
|
+
orderNumber?: string;
|
|
1250
|
+
/** Reservation ID associated with this order. */
|
|
1251
|
+
reservationId?: string;
|
|
1194
1252
|
/**
|
|
1195
|
-
*
|
|
1196
|
-
* @
|
|
1197
|
-
* @max 180
|
|
1253
|
+
* Contact ID associated with this order.
|
|
1254
|
+
* @maxLength 36
|
|
1198
1255
|
*/
|
|
1199
|
-
|
|
1200
|
-
}
|
|
1201
|
-
interface Subdivision {
|
|
1202
|
-
/** subdivision short code */
|
|
1203
|
-
code?: string;
|
|
1204
|
-
/** subdivision full-name */
|
|
1205
|
-
name?: string;
|
|
1206
|
-
}
|
|
1207
|
-
interface ScheduleConfig {
|
|
1256
|
+
contactId?: string;
|
|
1208
1257
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
*
|
|
1211
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1258
|
+
* Member ID associated with this order.
|
|
1259
|
+
* @format GUID
|
|
1212
1260
|
*/
|
|
1213
|
-
|
|
1261
|
+
memberId?: string | null;
|
|
1214
1262
|
/**
|
|
1215
|
-
*
|
|
1216
|
-
* @
|
|
1263
|
+
* Date and time the order was created.
|
|
1264
|
+
* @readonly
|
|
1217
1265
|
*/
|
|
1218
|
-
|
|
1219
|
-
/** Event start timestamp. */
|
|
1220
|
-
startDate?: Date | null;
|
|
1221
|
-
/** Event end timestamp. */
|
|
1222
|
-
endDate?: Date | null;
|
|
1266
|
+
created?: Date | null;
|
|
1223
1267
|
/**
|
|
1224
|
-
*
|
|
1225
|
-
* @maxLength
|
|
1268
|
+
* Buyer first name.
|
|
1269
|
+
* @maxLength 255
|
|
1226
1270
|
*/
|
|
1227
|
-
|
|
1228
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
1229
|
-
endDateHidden?: boolean;
|
|
1230
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
1231
|
-
showTimeZone?: boolean;
|
|
1232
|
-
/** Event recurrences. */
|
|
1233
|
-
recurrences?: Recurrences;
|
|
1234
|
-
}
|
|
1235
|
-
interface Recurrences {
|
|
1271
|
+
firstName?: string;
|
|
1236
1272
|
/**
|
|
1237
|
-
*
|
|
1238
|
-
* @
|
|
1273
|
+
* Buyer last name.
|
|
1274
|
+
* @maxLength 255
|
|
1275
|
+
*/
|
|
1276
|
+
lastName?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Buyer email address.
|
|
1279
|
+
* @maxLength 255
|
|
1239
1280
|
*/
|
|
1240
|
-
|
|
1281
|
+
email?: string;
|
|
1282
|
+
/** Checkout form response. */
|
|
1283
|
+
checkoutForm?: FormResponse;
|
|
1284
|
+
/** Order status. */
|
|
1285
|
+
status?: OrderStatusWithLiterals;
|
|
1241
1286
|
/**
|
|
1242
|
-
*
|
|
1243
|
-
* @
|
|
1287
|
+
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
1288
|
+
* @maxLength 255
|
|
1244
1289
|
*/
|
|
1245
|
-
|
|
1290
|
+
method?: string | null;
|
|
1246
1291
|
/**
|
|
1247
|
-
*
|
|
1248
|
-
* @
|
|
1292
|
+
* Tickets (generated after payment).
|
|
1293
|
+
* @maxSize 50
|
|
1249
1294
|
*/
|
|
1250
|
-
|
|
1295
|
+
tickets?: Ticket[];
|
|
1296
|
+
/** Invoice. */
|
|
1297
|
+
invoice?: Invoice;
|
|
1251
1298
|
}
|
|
1252
|
-
interface
|
|
1253
|
-
/** Event start timestamp. */
|
|
1254
|
-
startDate?: Date | null;
|
|
1255
|
-
/** Event end timestamp. */
|
|
1256
|
-
endDate?: Date | null;
|
|
1299
|
+
interface TicketPdfResolved {
|
|
1257
1300
|
/**
|
|
1258
|
-
*
|
|
1259
|
-
* @maxLength
|
|
1301
|
+
* Optional order number
|
|
1302
|
+
* @maxLength 36
|
|
1260
1303
|
*/
|
|
1261
|
-
|
|
1262
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
1263
|
-
showTimeZone?: boolean;
|
|
1264
|
-
}
|
|
1265
|
-
declare enum Status {
|
|
1266
|
-
/** Event occurs only once. */
|
|
1267
|
-
ONE_TIME = "ONE_TIME",
|
|
1268
|
-
/** Event is recurring. */
|
|
1269
|
-
RECURRING = "RECURRING",
|
|
1270
|
-
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1271
|
-
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1272
|
-
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1273
|
-
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1274
|
-
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1275
|
-
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1276
|
-
}
|
|
1277
|
-
/** @enumType */
|
|
1278
|
-
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
1279
|
-
declare enum EventStatus {
|
|
1280
|
-
/** Event is public and scheduled to start */
|
|
1281
|
-
SCHEDULED = "SCHEDULED",
|
|
1282
|
-
/** Event has started */
|
|
1283
|
-
STARTED = "STARTED",
|
|
1284
|
-
/** Event has ended */
|
|
1285
|
-
ENDED = "ENDED",
|
|
1286
|
-
/** Event was canceled */
|
|
1287
|
-
CANCELED = "CANCELED"
|
|
1288
|
-
}
|
|
1289
|
-
/** @enumType */
|
|
1290
|
-
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
1291
|
-
interface MessageEnvelope {
|
|
1304
|
+
orderNumber?: string | null;
|
|
1292
1305
|
/**
|
|
1293
|
-
*
|
|
1294
|
-
* @
|
|
1306
|
+
* Optional ticket number
|
|
1307
|
+
* @maxLength 36
|
|
1295
1308
|
*/
|
|
1296
|
-
|
|
1309
|
+
ticketNumber?: string | null;
|
|
1297
1310
|
/**
|
|
1298
|
-
*
|
|
1299
|
-
* @
|
|
1311
|
+
* Resolved download url
|
|
1312
|
+
* @format WEB_URL
|
|
1300
1313
|
*/
|
|
1301
|
-
|
|
1302
|
-
/**
|
|
1303
|
-
|
|
1304
|
-
/** Stringify payload. */
|
|
1305
|
-
data?: string;
|
|
1306
|
-
/** Details related to the account */
|
|
1307
|
-
accountInfo?: AccountInfo;
|
|
1308
|
-
}
|
|
1309
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1314
|
+
downloadUrl?: string | null;
|
|
1315
|
+
/** Resolve status */
|
|
1316
|
+
resolveFailed?: boolean | null;
|
|
1310
1317
|
/**
|
|
1311
|
-
*
|
|
1318
|
+
* Papyrus document id
|
|
1312
1319
|
* @format GUID
|
|
1313
1320
|
*/
|
|
1314
|
-
|
|
1321
|
+
documentId?: string | null;
|
|
1322
|
+
}
|
|
1323
|
+
interface TicketPdfResolveDelayed {
|
|
1315
1324
|
/**
|
|
1316
|
-
*
|
|
1317
|
-
* @
|
|
1325
|
+
* Optional order number
|
|
1326
|
+
* @maxLength 36
|
|
1318
1327
|
*/
|
|
1319
|
-
|
|
1328
|
+
orderNumber?: string | null;
|
|
1320
1329
|
/**
|
|
1321
|
-
*
|
|
1322
|
-
* @
|
|
1330
|
+
* Optional ticket number
|
|
1331
|
+
* @maxLength 36
|
|
1323
1332
|
*/
|
|
1324
|
-
|
|
1333
|
+
ticketNumber?: string | null;
|
|
1325
1334
|
/**
|
|
1326
|
-
*
|
|
1335
|
+
* Papyrus document id
|
|
1327
1336
|
* @format GUID
|
|
1328
1337
|
*/
|
|
1329
|
-
|
|
1330
|
-
/** @readonly */
|
|
1331
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1338
|
+
documentId?: string | null;
|
|
1332
1339
|
}
|
|
1333
|
-
/**
|
|
1334
|
-
interface
|
|
1340
|
+
/** Triggered when an order is canceled. */
|
|
1341
|
+
interface OrderCanceled {
|
|
1335
1342
|
/**
|
|
1336
|
-
* ID
|
|
1343
|
+
* Event ID to which the order belongs.
|
|
1337
1344
|
* @format GUID
|
|
1338
1345
|
*/
|
|
1339
|
-
|
|
1346
|
+
eventId?: string;
|
|
1340
1347
|
/**
|
|
1341
|
-
*
|
|
1342
|
-
* @
|
|
1348
|
+
* Unique order number.
|
|
1349
|
+
* @maxLength 36
|
|
1343
1350
|
*/
|
|
1344
|
-
|
|
1351
|
+
orderNumber?: string;
|
|
1345
1352
|
/**
|
|
1346
|
-
* ID
|
|
1353
|
+
* Reservation ID associated with the order.
|
|
1347
1354
|
* @format GUID
|
|
1348
1355
|
*/
|
|
1349
|
-
|
|
1356
|
+
reservationId?: string;
|
|
1350
1357
|
/**
|
|
1351
|
-
* ID
|
|
1352
|
-
* @
|
|
1358
|
+
* Contact ID associated with the order.
|
|
1359
|
+
* @maxLength 36
|
|
1353
1360
|
*/
|
|
1354
|
-
|
|
1355
|
-
}
|
|
1356
|
-
declare enum WebhookIdentityType {
|
|
1357
|
-
UNKNOWN = "UNKNOWN",
|
|
1358
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1359
|
-
MEMBER = "MEMBER",
|
|
1360
|
-
WIX_USER = "WIX_USER",
|
|
1361
|
-
APP = "APP"
|
|
1362
|
-
}
|
|
1363
|
-
/** @enumType */
|
|
1364
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1365
|
-
interface AccountInfo {
|
|
1361
|
+
contactId?: string;
|
|
1366
1362
|
/**
|
|
1367
|
-
*
|
|
1368
|
-
* @
|
|
1363
|
+
* Buyer first name.
|
|
1364
|
+
* @maxLength 50
|
|
1369
1365
|
*/
|
|
1370
|
-
|
|
1366
|
+
firstName?: string | null;
|
|
1371
1367
|
/**
|
|
1372
|
-
*
|
|
1373
|
-
* @
|
|
1368
|
+
* Buyer last name.
|
|
1369
|
+
* @maxLength 50
|
|
1374
1370
|
*/
|
|
1375
|
-
|
|
1371
|
+
lastName?: string | null;
|
|
1376
1372
|
/**
|
|
1377
|
-
*
|
|
1378
|
-
* @
|
|
1373
|
+
* Buyer email address.
|
|
1374
|
+
* @maxLength 255
|
|
1379
1375
|
*/
|
|
1380
|
-
|
|
1376
|
+
email?: string | null;
|
|
1377
|
+
/** Checkout form response. */
|
|
1378
|
+
checkoutForm?: FormResponse;
|
|
1379
|
+
/** Invoice. */
|
|
1380
|
+
invoice?: Invoice;
|
|
1381
1381
|
}
|
|
1382
1382
|
interface BaseEventMetadata {
|
|
1383
1383
|
/**
|
|
@@ -1484,50 +1484,6 @@ interface NotificationConfigUpdatedEnvelope {
|
|
|
1484
1484
|
* @documentationMaturity preview
|
|
1485
1485
|
*/
|
|
1486
1486
|
declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
|
|
1487
|
-
/**
|
|
1488
|
-
* Triggers notification
|
|
1489
|
-
* @public
|
|
1490
|
-
* @documentationMaturity preview
|
|
1491
|
-
* @requiredField options
|
|
1492
|
-
* @requiredField options.guests
|
|
1493
|
-
* @requiredField options.notification
|
|
1494
|
-
* @permissionId WIX_EVENTS.MANAGE
|
|
1495
|
-
* @applicableIdentity APP
|
|
1496
|
-
* @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
|
|
1497
|
-
*/
|
|
1498
|
-
declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
|
|
1499
|
-
interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
|
|
1500
|
-
/** Email notification type */
|
|
1501
|
-
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1502
|
-
/** Push notification type */
|
|
1503
|
-
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1504
|
-
/** Rsvp guest info */
|
|
1505
|
-
rsvpGuest?: RsvpGuest;
|
|
1506
|
-
/** Order guest info */
|
|
1507
|
-
orderGuest?: OrderGuest;
|
|
1508
|
-
/** Event guests info */
|
|
1509
|
-
eventGuests?: EventGuests;
|
|
1510
|
-
/** Ticket guests info */
|
|
1511
|
-
ticketGuest?: TicketGuest;
|
|
1512
|
-
}
|
|
1513
|
-
/** @oneof */
|
|
1514
|
-
interface TriggerNotificationOptionsNotificationOneOf {
|
|
1515
|
-
/** Email notification type */
|
|
1516
|
-
emailNotificationType?: EmailNotificationTypeWithLiterals;
|
|
1517
|
-
/** Push notification type */
|
|
1518
|
-
pushNotificationType?: PushNotificationTypeWithLiterals;
|
|
1519
|
-
}
|
|
1520
|
-
/** @oneof */
|
|
1521
|
-
interface TriggerNotificationOptionsGuestsOneOf {
|
|
1522
|
-
/** Rsvp guest info */
|
|
1523
|
-
rsvpGuest?: RsvpGuest;
|
|
1524
|
-
/** Order guest info */
|
|
1525
|
-
orderGuest?: OrderGuest;
|
|
1526
|
-
/** Event guests info */
|
|
1527
|
-
eventGuests?: EventGuests;
|
|
1528
|
-
/** Ticket guests info */
|
|
1529
|
-
ticketGuest?: TicketGuest;
|
|
1530
|
-
}
|
|
1531
1487
|
/**
|
|
1532
1488
|
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
1533
1489
|
* @param notificationConfigId - Id of the NotificationConfig to retrieve
|
|
@@ -1590,5 +1546,49 @@ interface UpsertNotificationConfig {
|
|
|
1590
1546
|
/** Order confirmation with tickets link. */
|
|
1591
1547
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
1592
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
|
+
}
|
|
1593
1593
|
|
|
1594
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 };
|