@wix/auto_sdk_events_ticket-definitions-v-2 1.0.5 → 1.0.7
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/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +10 -10
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +42 -42
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +23 -23
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +23 -23
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +9 -9
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +41 -41
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +21 -21
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +21 -21
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +10 -10
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +42 -42
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +23 -23
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +23 -23
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +9 -9
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +41 -41
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +21 -21
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +21 -21
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
export interface TicketDefinition {
|
|
2
2
|
/**
|
|
3
3
|
* Ticket definition ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
id?: string | null;
|
|
7
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Event ID to which the ticket definition belongs.
|
|
10
|
+
* @format GUID
|
|
11
|
+
* @immutable
|
|
12
|
+
*/
|
|
8
13
|
eventId?: string | null;
|
|
9
14
|
/**
|
|
10
15
|
* Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
|
|
@@ -21,11 +26,21 @@ export interface TicketDefinition {
|
|
|
21
26
|
* @readonly
|
|
22
27
|
*/
|
|
23
28
|
updatedDate?: Date | null;
|
|
24
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Ticket definition name.
|
|
31
|
+
* @minLength 1
|
|
32
|
+
* @maxLength 30
|
|
33
|
+
*/
|
|
25
34
|
name?: string | null;
|
|
26
|
-
/**
|
|
35
|
+
/**
|
|
36
|
+
* Ticket definition description.
|
|
37
|
+
* @maxLength 500
|
|
38
|
+
*/
|
|
27
39
|
description?: string | null;
|
|
28
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Ticket definition policy.
|
|
42
|
+
* @maxLength 1000
|
|
43
|
+
*/
|
|
29
44
|
policyText?: string | null;
|
|
30
45
|
/** Whether this ticket definition is hidden to site visitors and can't be purchased. */
|
|
31
46
|
hidden?: boolean;
|
|
@@ -61,6 +76,7 @@ export interface TicketDefinition {
|
|
|
61
76
|
* Number of tickets that can be purchased per checkout. <br>
|
|
62
77
|
* **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
|
|
63
78
|
* @readonly
|
|
79
|
+
* @max 50
|
|
64
80
|
*/
|
|
65
81
|
limitPerCheckout?: number | null;
|
|
66
82
|
/** Data extensions. */
|
|
@@ -111,19 +127,35 @@ export interface PricingMethodPriceOneOf {
|
|
|
111
127
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
112
128
|
*/
|
|
113
129
|
export interface CommonMoney {
|
|
114
|
-
/**
|
|
130
|
+
/**
|
|
131
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
132
|
+
* @format DECIMAL_VALUE
|
|
133
|
+
*/
|
|
115
134
|
value?: string;
|
|
116
|
-
/**
|
|
135
|
+
/**
|
|
136
|
+
* Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
|
|
137
|
+
* @format CURRENCY
|
|
138
|
+
*/
|
|
117
139
|
currency?: string;
|
|
118
140
|
}
|
|
119
141
|
export interface PricingOptions {
|
|
120
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* Ticket price option details.
|
|
144
|
+
* @maxSize 100
|
|
145
|
+
*/
|
|
121
146
|
optionDetails?: OptionDetails[];
|
|
122
147
|
}
|
|
123
148
|
export interface OptionDetails {
|
|
124
|
-
/**
|
|
149
|
+
/**
|
|
150
|
+
* Ticket price option ID.
|
|
151
|
+
* @format GUID
|
|
152
|
+
*/
|
|
125
153
|
optionId?: string | null;
|
|
126
|
-
/**
|
|
154
|
+
/**
|
|
155
|
+
* Ticket price option name, such as "Child Ticket".
|
|
156
|
+
* @minLength 1
|
|
157
|
+
* @maxLength 200
|
|
158
|
+
*/
|
|
127
159
|
name?: string | null;
|
|
128
160
|
/** Ticket price. */
|
|
129
161
|
price?: CommonMoney;
|
|
@@ -192,11 +224,14 @@ export interface ExtendedFields {
|
|
|
192
224
|
export interface EventDetails {
|
|
193
225
|
/**
|
|
194
226
|
* Event title.
|
|
227
|
+
* @minLength 1
|
|
228
|
+
* @maxLength 120
|
|
195
229
|
* @readonly
|
|
196
230
|
*/
|
|
197
231
|
title?: string | null;
|
|
198
232
|
/**
|
|
199
233
|
* Event short description.
|
|
234
|
+
* @maxLength 500
|
|
200
235
|
* @readonly
|
|
201
236
|
*/
|
|
202
237
|
shortDescription?: string | null;
|
|
@@ -222,7 +257,10 @@ export interface EventDetails {
|
|
|
222
257
|
status?: Status;
|
|
223
258
|
}
|
|
224
259
|
export interface Location {
|
|
225
|
-
/**
|
|
260
|
+
/**
|
|
261
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
262
|
+
* @maxLength 50
|
|
263
|
+
*/
|
|
226
264
|
name?: string | null;
|
|
227
265
|
/** Location type. */
|
|
228
266
|
type?: LocationType;
|
|
@@ -243,42 +281,83 @@ export declare enum LocationType {
|
|
|
243
281
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
244
282
|
/** Street address. */
|
|
245
283
|
streetAddress?: CommonStreetAddress;
|
|
246
|
-
/**
|
|
284
|
+
/**
|
|
285
|
+
* Primary address information (street and building number).
|
|
286
|
+
* @maxLength 250
|
|
287
|
+
*/
|
|
247
288
|
addressLine?: string | null;
|
|
248
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
291
|
+
* @format COUNTRY
|
|
292
|
+
*/
|
|
249
293
|
country?: string | null;
|
|
250
|
-
/**
|
|
294
|
+
/**
|
|
295
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
|
|
296
|
+
* @maxLength 20
|
|
297
|
+
*/
|
|
251
298
|
subdivision?: string | null;
|
|
252
|
-
/**
|
|
299
|
+
/**
|
|
300
|
+
* City name.
|
|
301
|
+
* @maxLength 100
|
|
302
|
+
*/
|
|
253
303
|
city?: string | null;
|
|
254
|
-
/**
|
|
304
|
+
/**
|
|
305
|
+
* Zip or postal code.
|
|
306
|
+
* @maxLength 100
|
|
307
|
+
*/
|
|
255
308
|
postalCode?: string | null;
|
|
256
|
-
/**
|
|
309
|
+
/**
|
|
310
|
+
* Secondary address information (suite or apartment number and room number).
|
|
311
|
+
* @maxLength 250
|
|
312
|
+
*/
|
|
257
313
|
addressLine2?: string | null;
|
|
258
314
|
}
|
|
259
315
|
/** @oneof */
|
|
260
316
|
export interface CommonAddressStreetOneOf {
|
|
261
317
|
/** Street address. */
|
|
262
318
|
streetAddress?: CommonStreetAddress;
|
|
263
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* Primary address information (street and building number).
|
|
321
|
+
* @maxLength 250
|
|
322
|
+
*/
|
|
264
323
|
addressLine?: string | null;
|
|
265
324
|
}
|
|
266
325
|
export interface CommonStreetAddress {
|
|
267
|
-
/**
|
|
326
|
+
/**
|
|
327
|
+
* Street number.
|
|
328
|
+
* @maxLength 100
|
|
329
|
+
*/
|
|
268
330
|
number?: string;
|
|
269
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* Street name.
|
|
333
|
+
* @maxLength 250
|
|
334
|
+
*/
|
|
270
335
|
name?: string;
|
|
271
336
|
}
|
|
272
337
|
export interface CommonAddressLocation {
|
|
273
|
-
/**
|
|
338
|
+
/**
|
|
339
|
+
* Address latitude coordinates.
|
|
340
|
+
* @min -90
|
|
341
|
+
* @max 90
|
|
342
|
+
*/
|
|
274
343
|
latitude?: number | null;
|
|
275
|
-
/**
|
|
344
|
+
/**
|
|
345
|
+
* Address longitude coordinates.
|
|
346
|
+
* @min -180
|
|
347
|
+
* @max 180
|
|
348
|
+
*/
|
|
276
349
|
longitude?: number | null;
|
|
277
350
|
}
|
|
278
351
|
export interface CommonSubdivision {
|
|
279
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* Short subdivision code.
|
|
354
|
+
* @maxLength 100
|
|
355
|
+
*/
|
|
280
356
|
code?: string;
|
|
281
|
-
/**
|
|
357
|
+
/**
|
|
358
|
+
* Subdivision full name.
|
|
359
|
+
* @maxLength 250
|
|
360
|
+
*/
|
|
282
361
|
name?: string;
|
|
283
362
|
}
|
|
284
363
|
export declare enum SubdivisionSubdivisionType {
|
|
@@ -299,13 +378,19 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
299
378
|
export interface DateAndTimeSettings {
|
|
300
379
|
/** Whether the event date and time are TBD. */
|
|
301
380
|
dateAndTimeTbd?: boolean | null;
|
|
302
|
-
/**
|
|
381
|
+
/**
|
|
382
|
+
* Message that is displayed when time and date is TBD.
|
|
383
|
+
* @maxLength 100
|
|
384
|
+
*/
|
|
303
385
|
dateAndTimeTbdMessage?: string | null;
|
|
304
386
|
/** Event start date. */
|
|
305
387
|
startDate?: Date | null;
|
|
306
388
|
/** Event end date. */
|
|
307
389
|
endDate?: Date | null;
|
|
308
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
392
|
+
* @maxLength 100
|
|
393
|
+
*/
|
|
309
394
|
timeZoneId?: string | null;
|
|
310
395
|
/** Whether the end date is hidden in the formatted date and time. */
|
|
311
396
|
hideEndDate?: boolean | null;
|
|
@@ -336,11 +421,15 @@ export declare enum RecurrenceStatusStatus {
|
|
|
336
421
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
337
422
|
}
|
|
338
423
|
export interface Recurrences {
|
|
339
|
-
/**
|
|
424
|
+
/**
|
|
425
|
+
* Individual event dates.
|
|
426
|
+
* @maxSize 1000
|
|
427
|
+
*/
|
|
340
428
|
individualEventDates?: Occurrence[];
|
|
341
429
|
/**
|
|
342
430
|
* Recurring event category ID.
|
|
343
431
|
* @readonly
|
|
432
|
+
* @maxLength 100
|
|
344
433
|
*/
|
|
345
434
|
categoryId?: string | null;
|
|
346
435
|
}
|
|
@@ -349,7 +438,10 @@ export interface Occurrence {
|
|
|
349
438
|
startDate?: Date | null;
|
|
350
439
|
/** Event end date. */
|
|
351
440
|
endDate?: Date | null;
|
|
352
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
443
|
+
* @maxLength 100
|
|
444
|
+
*/
|
|
353
445
|
timeZoneId?: string | null;
|
|
354
446
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
355
447
|
showTimeZone?: boolean;
|
|
@@ -360,33 +452,44 @@ export interface Formatted {
|
|
|
360
452
|
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
|
|
361
453
|
* Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
|
|
362
454
|
* @readonly
|
|
455
|
+
* @maxLength 500
|
|
363
456
|
*/
|
|
364
457
|
dateAndTime?: string | null;
|
|
365
458
|
/**
|
|
366
459
|
* Formatted start date of the event. Empty for TBD schedules.
|
|
367
460
|
* @readonly
|
|
461
|
+
* @maxLength 500
|
|
368
462
|
*/
|
|
369
463
|
startDate?: string | null;
|
|
370
464
|
/**
|
|
371
465
|
* Formatted start time of the event. Empty for TBD schedules.
|
|
372
466
|
* @readonly
|
|
467
|
+
* @maxLength 500
|
|
373
468
|
*/
|
|
374
469
|
startTime?: string | null;
|
|
375
470
|
/**
|
|
376
471
|
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
377
472
|
* @readonly
|
|
473
|
+
* @maxLength 500
|
|
378
474
|
*/
|
|
379
475
|
endDate?: string | null;
|
|
380
476
|
/**
|
|
381
477
|
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
382
478
|
* @readonly
|
|
479
|
+
* @maxLength 500
|
|
383
480
|
*/
|
|
384
481
|
endTime?: string | null;
|
|
385
482
|
}
|
|
386
483
|
export interface PageUrl {
|
|
387
|
-
/**
|
|
484
|
+
/**
|
|
485
|
+
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
|
|
486
|
+
* @maxLength 500
|
|
487
|
+
*/
|
|
388
488
|
base?: string;
|
|
389
|
-
/**
|
|
489
|
+
/**
|
|
490
|
+
* The path to the page. For example, `/product-page/a-product`.
|
|
491
|
+
* @maxLength 500
|
|
492
|
+
*/
|
|
390
493
|
path?: string;
|
|
391
494
|
}
|
|
392
495
|
export declare enum Status {
|
|
@@ -403,134 +506,16 @@ export declare enum Status {
|
|
|
403
506
|
/** Event is not public. */
|
|
404
507
|
DRAFT = "DRAFT"
|
|
405
508
|
}
|
|
406
|
-
export interface
|
|
407
|
-
/** Ticket definition sale period after update. */
|
|
408
|
-
afterUpdate?: SalePeriod;
|
|
409
|
-
}
|
|
410
|
-
export interface TicketDefinitionSaleStarted {
|
|
411
|
-
/** Ticket definition. */
|
|
412
|
-
ticketDefinition?: TicketDefinition;
|
|
413
|
-
}
|
|
414
|
-
export interface TicketDefinitionSaleEnded {
|
|
415
|
-
/** Ticket definition. */
|
|
416
|
-
ticketDefinition?: TicketDefinition;
|
|
417
|
-
}
|
|
418
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
419
|
-
createdEvent?: EntityCreatedEvent;
|
|
420
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
421
|
-
deletedEvent?: EntityDeletedEvent;
|
|
422
|
-
actionEvent?: ActionEvent;
|
|
423
|
-
/**
|
|
424
|
-
* Unique event ID.
|
|
425
|
-
* Allows clients to ignore duplicate webhooks.
|
|
426
|
-
*/
|
|
427
|
-
id?: string;
|
|
428
|
-
/**
|
|
429
|
-
* Assumes actions are also always typed to an entity_type
|
|
430
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
431
|
-
*/
|
|
432
|
-
entityFqdn?: string;
|
|
433
|
-
/**
|
|
434
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
435
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
436
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
437
|
-
*/
|
|
438
|
-
slug?: string;
|
|
439
|
-
/** ID of the entity associated with the event. */
|
|
440
|
-
entityId?: string;
|
|
441
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
442
|
-
eventTime?: Date | null;
|
|
443
|
-
/**
|
|
444
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
445
|
-
* (for example, GDPR).
|
|
446
|
-
*/
|
|
447
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
448
|
-
/** If present, indicates the action that triggered the event. */
|
|
449
|
-
originatedFrom?: string | null;
|
|
509
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
450
510
|
/**
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
454
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
455
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
456
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
511
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
512
|
+
* @format GUID
|
|
457
513
|
*/
|
|
458
|
-
|
|
459
|
-
}
|
|
460
|
-
/** @oneof */
|
|
461
|
-
export interface DomainEventBodyOneOf {
|
|
462
|
-
createdEvent?: EntityCreatedEvent;
|
|
463
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
464
|
-
deletedEvent?: EntityDeletedEvent;
|
|
465
|
-
actionEvent?: ActionEvent;
|
|
466
|
-
}
|
|
467
|
-
export interface EntityCreatedEvent {
|
|
468
|
-
entityAsJson?: string;
|
|
469
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
470
|
-
restoreInfo?: RestoreInfo;
|
|
471
|
-
}
|
|
472
|
-
export interface RestoreInfo {
|
|
473
|
-
deletedDate?: Date | null;
|
|
474
|
-
}
|
|
475
|
-
export interface EntityUpdatedEvent {
|
|
514
|
+
metaSiteId?: string;
|
|
476
515
|
/**
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
516
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
517
|
+
* @format GUID
|
|
480
518
|
*/
|
|
481
|
-
currentEntityAsJson?: string;
|
|
482
|
-
}
|
|
483
|
-
export interface EntityDeletedEvent {
|
|
484
|
-
/** Entity that was deleted */
|
|
485
|
-
deletedEntityAsJson?: string | null;
|
|
486
|
-
}
|
|
487
|
-
export interface ActionEvent {
|
|
488
|
-
bodyAsJson?: string;
|
|
489
|
-
}
|
|
490
|
-
export interface MessageEnvelope {
|
|
491
|
-
/** App instance ID. */
|
|
492
|
-
instanceId?: string | null;
|
|
493
|
-
/** Event type. */
|
|
494
|
-
eventType?: string;
|
|
495
|
-
/** The identification type and identity data. */
|
|
496
|
-
identity?: IdentificationData;
|
|
497
|
-
/** Stringify payload. */
|
|
498
|
-
data?: string;
|
|
499
|
-
}
|
|
500
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
501
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
502
|
-
anonymousVisitorId?: string;
|
|
503
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
504
|
-
memberId?: string;
|
|
505
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
506
|
-
wixUserId?: string;
|
|
507
|
-
/** ID of an app. */
|
|
508
|
-
appId?: string;
|
|
509
|
-
/** @readonly */
|
|
510
|
-
identityType?: WebhookIdentityType;
|
|
511
|
-
}
|
|
512
|
-
/** @oneof */
|
|
513
|
-
export interface IdentificationDataIdOneOf {
|
|
514
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
515
|
-
anonymousVisitorId?: string;
|
|
516
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
517
|
-
memberId?: string;
|
|
518
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
519
|
-
wixUserId?: string;
|
|
520
|
-
/** ID of an app. */
|
|
521
|
-
appId?: string;
|
|
522
|
-
}
|
|
523
|
-
export declare enum WebhookIdentityType {
|
|
524
|
-
UNKNOWN = "UNKNOWN",
|
|
525
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
526
|
-
MEMBER = "MEMBER",
|
|
527
|
-
WIX_USER = "WIX_USER",
|
|
528
|
-
APP = "APP"
|
|
529
|
-
}
|
|
530
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
531
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
532
|
-
metaSiteId?: string;
|
|
533
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
534
519
|
siteId?: string;
|
|
535
520
|
/** Invalidate by App */
|
|
536
521
|
app?: App;
|
|
@@ -540,7 +525,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
540
525
|
uri?: URI;
|
|
541
526
|
/** Invalidate by file (for media files such as PDFs) */
|
|
542
527
|
file?: File;
|
|
543
|
-
/**
|
|
528
|
+
/**
|
|
529
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
530
|
+
* @maxLength 256
|
|
531
|
+
*/
|
|
544
532
|
reason?: string | null;
|
|
545
533
|
/** Is local DS */
|
|
546
534
|
localDc?: boolean;
|
|
@@ -548,9 +536,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
548
536
|
}
|
|
549
537
|
/** @oneof */
|
|
550
538
|
export interface InvalidateCacheGetByOneOf {
|
|
551
|
-
/**
|
|
539
|
+
/**
|
|
540
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
541
|
+
* @format GUID
|
|
542
|
+
*/
|
|
552
543
|
metaSiteId?: string;
|
|
553
|
-
/**
|
|
544
|
+
/**
|
|
545
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
546
|
+
* @format GUID
|
|
547
|
+
*/
|
|
554
548
|
siteId?: string;
|
|
555
549
|
/** Invalidate by App */
|
|
556
550
|
app?: App;
|
|
@@ -562,237 +556,110 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
562
556
|
file?: File;
|
|
563
557
|
}
|
|
564
558
|
export interface App {
|
|
565
|
-
/**
|
|
559
|
+
/**
|
|
560
|
+
* The AppDefId
|
|
561
|
+
* @minLength 1
|
|
562
|
+
*/
|
|
566
563
|
appDefId?: string;
|
|
567
|
-
/**
|
|
564
|
+
/**
|
|
565
|
+
* The instance Id
|
|
566
|
+
* @format GUID
|
|
567
|
+
*/
|
|
568
568
|
instanceId?: string;
|
|
569
569
|
}
|
|
570
570
|
export interface Page {
|
|
571
|
-
/**
|
|
571
|
+
/**
|
|
572
|
+
* the msid the page is on
|
|
573
|
+
* @format GUID
|
|
574
|
+
*/
|
|
572
575
|
metaSiteId?: string;
|
|
573
|
-
/**
|
|
576
|
+
/**
|
|
577
|
+
* Invalidate by Page ID
|
|
578
|
+
* @minLength 1
|
|
579
|
+
*/
|
|
574
580
|
pageId?: string;
|
|
575
581
|
}
|
|
576
582
|
export interface URI {
|
|
577
|
-
/**
|
|
583
|
+
/**
|
|
584
|
+
* the msid the URI is on
|
|
585
|
+
* @format GUID
|
|
586
|
+
*/
|
|
578
587
|
metaSiteId?: string;
|
|
579
|
-
/**
|
|
588
|
+
/**
|
|
589
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
590
|
+
* @minLength 1
|
|
591
|
+
*/
|
|
580
592
|
uriPath?: string;
|
|
581
593
|
}
|
|
582
594
|
export interface File {
|
|
583
|
-
/**
|
|
595
|
+
/**
|
|
596
|
+
* the msid the file is related to
|
|
597
|
+
* @format GUID
|
|
598
|
+
*/
|
|
584
599
|
metaSiteId?: string;
|
|
585
|
-
/**
|
|
600
|
+
/**
|
|
601
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
602
|
+
* @minLength 1
|
|
603
|
+
* @maxLength 256
|
|
604
|
+
*/
|
|
586
605
|
fileName?: string;
|
|
587
606
|
}
|
|
588
|
-
export interface
|
|
589
|
-
/** Ticket definition
|
|
590
|
-
|
|
607
|
+
export interface SalePeriodUpdated {
|
|
608
|
+
/** Ticket definition sale period after update. */
|
|
609
|
+
afterUpdate?: SalePeriod;
|
|
591
610
|
}
|
|
592
|
-
export interface
|
|
593
|
-
/**
|
|
594
|
-
|
|
611
|
+
export interface TicketDefinitionSaleStarted {
|
|
612
|
+
/** Ticket definition. */
|
|
613
|
+
ticketDefinition?: TicketDefinition;
|
|
595
614
|
}
|
|
596
|
-
export interface
|
|
597
|
-
/**
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
615
|
+
export interface TicketDefinitionSaleEnded {
|
|
616
|
+
/** Ticket definition. */
|
|
617
|
+
ticketDefinition?: TicketDefinition;
|
|
618
|
+
}
|
|
619
|
+
export interface CreateTicketDefinitionRequest {
|
|
620
|
+
/** Ticket definition info. */
|
|
621
|
+
ticketDefinition: TicketDefinition;
|
|
602
622
|
/**
|
|
603
|
-
*
|
|
604
|
-
* @
|
|
623
|
+
* Predefined sets of fields to return.
|
|
624
|
+
* @maxSize 5
|
|
605
625
|
*/
|
|
606
|
-
|
|
626
|
+
fields?: Field[];
|
|
627
|
+
}
|
|
628
|
+
export declare enum Field {
|
|
629
|
+
/** Unknown requested field. */
|
|
630
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
631
|
+
/** Returns `salesDetails` in the response. */
|
|
632
|
+
SALES_DETAILS = "SALES_DETAILS",
|
|
633
|
+
/** Returns `eventDetails` in the response. */
|
|
634
|
+
EVENT_DETAILS = "EVENT_DETAILS"
|
|
635
|
+
}
|
|
636
|
+
export interface CreateTicketDefinitionResponse {
|
|
637
|
+
/** Created ticket definition. */
|
|
638
|
+
ticketDefinition?: TicketDefinition;
|
|
639
|
+
}
|
|
640
|
+
export interface UpdateTicketDefinitionRequest {
|
|
641
|
+
/** Ticket definition to update. */
|
|
642
|
+
ticketDefinition: TicketDefinition;
|
|
607
643
|
/**
|
|
608
|
-
*
|
|
609
|
-
* @
|
|
644
|
+
* Predefined sets of fields to return.
|
|
645
|
+
* @maxSize 5
|
|
610
646
|
*/
|
|
611
|
-
|
|
647
|
+
fields?: Field[];
|
|
648
|
+
}
|
|
649
|
+
export interface UpdateTicketDefinitionResponse {
|
|
650
|
+
/** The updated ticket definition. */
|
|
651
|
+
ticketDefinition?: TicketDefinition;
|
|
652
|
+
}
|
|
653
|
+
export interface GetTicketDefinitionRequest {
|
|
612
654
|
/**
|
|
613
|
-
*
|
|
614
|
-
* @
|
|
655
|
+
* Ticket definition ID.
|
|
656
|
+
* @format GUID
|
|
615
657
|
*/
|
|
616
|
-
|
|
658
|
+
ticketDefinitionId: string;
|
|
617
659
|
/**
|
|
618
|
-
*
|
|
619
|
-
* @
|
|
660
|
+
* Predefined sets of fields to return.
|
|
661
|
+
* @maxSize 5
|
|
620
662
|
*/
|
|
621
|
-
soldCount?: number;
|
|
622
|
-
/**
|
|
623
|
-
* Paid exists.
|
|
624
|
-
* @readonly
|
|
625
|
-
*/
|
|
626
|
-
paidExists?: boolean;
|
|
627
|
-
}
|
|
628
|
-
export interface ListEventTicketingSummaryRequest {
|
|
629
|
-
/** Event ID. */
|
|
630
|
-
eventId?: string[];
|
|
631
|
-
}
|
|
632
|
-
export interface ListEventTicketingSummaryResponse {
|
|
633
|
-
/** Ticketing summaries. */
|
|
634
|
-
summaries?: EventTicketingSummary[];
|
|
635
|
-
}
|
|
636
|
-
export interface EventTicketingSummary {
|
|
637
|
-
/**
|
|
638
|
-
* Event ID to which the ticketing summary belongs.
|
|
639
|
-
* @readonly
|
|
640
|
-
*/
|
|
641
|
-
eventId?: string | null;
|
|
642
|
-
/**
|
|
643
|
-
* Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
644
|
-
* @readonly
|
|
645
|
-
*/
|
|
646
|
-
updatedDate?: Date | null;
|
|
647
|
-
/**
|
|
648
|
-
* Whether all tickets are sold for this event.
|
|
649
|
-
* @readonly
|
|
650
|
-
*/
|
|
651
|
-
soldOut?: boolean | null;
|
|
652
|
-
/**
|
|
653
|
-
* Price of lowest priced ticket.
|
|
654
|
-
* @readonly
|
|
655
|
-
*/
|
|
656
|
-
lowestTicketPrice?: CommonMoney;
|
|
657
|
-
/**
|
|
658
|
-
* Price of highest priced ticket.
|
|
659
|
-
* @readonly
|
|
660
|
-
*/
|
|
661
|
-
highestTicketPrice?: CommonMoney;
|
|
662
|
-
/**
|
|
663
|
-
* Currency used in event transactions.
|
|
664
|
-
* @readonly
|
|
665
|
-
*/
|
|
666
|
-
currency?: string | null;
|
|
667
|
-
/**
|
|
668
|
-
* Formatted price of lowest priced ticket.
|
|
669
|
-
* @readonly
|
|
670
|
-
*/
|
|
671
|
-
lowestTicketPriceFormatted?: string | null;
|
|
672
|
-
/**
|
|
673
|
-
* Formatted price of highest priced ticket.
|
|
674
|
-
* @readonly
|
|
675
|
-
*/
|
|
676
|
-
highestTicketPriceFormatted?: string | null;
|
|
677
|
-
}
|
|
678
|
-
export interface Empty {
|
|
679
|
-
}
|
|
680
|
-
export interface ReservationCreated {
|
|
681
|
-
/** Reservation created timestamp in ISO UTC format. */
|
|
682
|
-
timestamp?: Date | null;
|
|
683
|
-
/** Event ID. */
|
|
684
|
-
eventId?: string;
|
|
685
|
-
/**
|
|
686
|
-
* Reservation ID.
|
|
687
|
-
* Can be used to retrieve a reservation invoice.
|
|
688
|
-
*/
|
|
689
|
-
reservationId?: string;
|
|
690
|
-
/** Reservation expiration timestamp. */
|
|
691
|
-
expires?: Date | null;
|
|
692
|
-
/** Reservation status. */
|
|
693
|
-
status?: ReservationStatus;
|
|
694
|
-
/** Reservation ticket quantities. */
|
|
695
|
-
quantities?: TicketQuantity[];
|
|
696
|
-
/** Reservation update timestamp. */
|
|
697
|
-
updatedDate?: Date | null;
|
|
698
|
-
/** Reservation counts. */
|
|
699
|
-
counts?: ReservationCount[];
|
|
700
|
-
}
|
|
701
|
-
export declare enum ReservationStatus {
|
|
702
|
-
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
703
|
-
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
704
|
-
/** The reservation is confirmed and will not expire. */
|
|
705
|
-
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
706
|
-
/** The reservation is canceled because of non payment. */
|
|
707
|
-
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
708
|
-
/** The reservation is canceled manually by the buyer. */
|
|
709
|
-
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
710
|
-
/** The reservation is expired. */
|
|
711
|
-
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
712
|
-
}
|
|
713
|
-
export interface TicketQuantity {
|
|
714
|
-
/** Ticket definition ID. */
|
|
715
|
-
ticketDefinitionId?: string | null;
|
|
716
|
-
/** Quantity. */
|
|
717
|
-
quantity?: number | null;
|
|
718
|
-
/** Quantity update timestamp. */
|
|
719
|
-
updatedDate?: Date | null;
|
|
720
|
-
}
|
|
721
|
-
export interface ReservationCount {
|
|
722
|
-
/** Reservation Count snapshot timestamp. */
|
|
723
|
-
timestamp?: Date | null;
|
|
724
|
-
/** Ticket Definition ID. */
|
|
725
|
-
ticketDefinitionId?: string;
|
|
726
|
-
/** Confirmed reservation count. */
|
|
727
|
-
confirmedCount?: number;
|
|
728
|
-
/** Pending reservation count. */
|
|
729
|
-
pendingCount?: number;
|
|
730
|
-
/** True if paid ticket reservation exist. */
|
|
731
|
-
paidExists?: boolean;
|
|
732
|
-
}
|
|
733
|
-
export interface ReservationUpdated {
|
|
734
|
-
/** Reservation updated timestamp. */
|
|
735
|
-
timestamp?: Date | null;
|
|
736
|
-
/** Event ID. */
|
|
737
|
-
eventId?: string;
|
|
738
|
-
/**
|
|
739
|
-
* Reservation ID.
|
|
740
|
-
* Can be used to retrieve a reservation invoice.
|
|
741
|
-
*/
|
|
742
|
-
reservationId?: string;
|
|
743
|
-
/** Reservation status. */
|
|
744
|
-
status?: ReservationStatus;
|
|
745
|
-
/** Reservation expiration timestamp. */
|
|
746
|
-
expires?: Date | null;
|
|
747
|
-
/** Reservation ticket quantities. */
|
|
748
|
-
quantities?: TicketQuantity[];
|
|
749
|
-
/** Reservation update timestamp. */
|
|
750
|
-
updatedDate?: Date | null;
|
|
751
|
-
/** Reservation counts. */
|
|
752
|
-
counts?: ReservationCount[];
|
|
753
|
-
}
|
|
754
|
-
export interface EventDeleted {
|
|
755
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
756
|
-
timestamp?: Date | null;
|
|
757
|
-
/** Event ID. */
|
|
758
|
-
eventId?: string;
|
|
759
|
-
/** Event title. */
|
|
760
|
-
title?: string;
|
|
761
|
-
/** Event creator user ID. */
|
|
762
|
-
userId?: string | null;
|
|
763
|
-
}
|
|
764
|
-
export interface CreateTicketDefinitionRequest {
|
|
765
|
-
/** Ticket definition info. */
|
|
766
|
-
ticketDefinition: TicketDefinition;
|
|
767
|
-
/** Predefined sets of fields to return. */
|
|
768
|
-
fields?: Field[];
|
|
769
|
-
}
|
|
770
|
-
export declare enum Field {
|
|
771
|
-
/** Unknown requested field. */
|
|
772
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
773
|
-
/** Returns `salesDetails` in the response. */
|
|
774
|
-
SALES_DETAILS = "SALES_DETAILS",
|
|
775
|
-
/** Returns `eventDetails` in the response. */
|
|
776
|
-
EVENT_DETAILS = "EVENT_DETAILS"
|
|
777
|
-
}
|
|
778
|
-
export interface CreateTicketDefinitionResponse {
|
|
779
|
-
/** Created ticket definition. */
|
|
780
|
-
ticketDefinition?: TicketDefinition;
|
|
781
|
-
}
|
|
782
|
-
export interface UpdateTicketDefinitionRequest {
|
|
783
|
-
/** Ticket definition to update. */
|
|
784
|
-
ticketDefinition: TicketDefinition;
|
|
785
|
-
/** Predefined sets of fields to return. */
|
|
786
|
-
fields?: Field[];
|
|
787
|
-
}
|
|
788
|
-
export interface UpdateTicketDefinitionResponse {
|
|
789
|
-
/** The updated ticket definition. */
|
|
790
|
-
ticketDefinition?: TicketDefinition;
|
|
791
|
-
}
|
|
792
|
-
export interface GetTicketDefinitionRequest {
|
|
793
|
-
/** Ticket definition ID. */
|
|
794
|
-
ticketDefinitionId: string;
|
|
795
|
-
/** Predefined sets of fields to return. */
|
|
796
663
|
fields?: Field[];
|
|
797
664
|
}
|
|
798
665
|
export interface GetTicketDefinitionResponse {
|
|
@@ -800,38 +667,65 @@ export interface GetTicketDefinitionResponse {
|
|
|
800
667
|
ticketDefinition?: TicketDefinition;
|
|
801
668
|
}
|
|
802
669
|
export interface DeleteTicketDefinitionRequest {
|
|
803
|
-
/**
|
|
670
|
+
/**
|
|
671
|
+
* ID of the ticket definition to delete.
|
|
672
|
+
* @format GUID
|
|
673
|
+
*/
|
|
804
674
|
ticketDefinitionId: string;
|
|
805
675
|
}
|
|
806
676
|
export interface DeleteTicketDefinitionResponse {
|
|
807
677
|
}
|
|
808
678
|
export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
809
|
-
/**
|
|
679
|
+
/**
|
|
680
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
681
|
+
* @format GUID
|
|
682
|
+
*/
|
|
810
683
|
beforeDefinitionId?: string;
|
|
811
|
-
/**
|
|
684
|
+
/**
|
|
685
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
686
|
+
* @format GUID
|
|
687
|
+
*/
|
|
812
688
|
afterDefinitionId?: string;
|
|
813
|
-
/**
|
|
689
|
+
/**
|
|
690
|
+
* Event ID.
|
|
691
|
+
* @format GUID
|
|
692
|
+
*/
|
|
814
693
|
eventId: string;
|
|
815
|
-
/**
|
|
694
|
+
/**
|
|
695
|
+
* Ticket definition ID.
|
|
696
|
+
* @format GUID
|
|
697
|
+
*/
|
|
816
698
|
ticketDefinitionId: string;
|
|
817
699
|
}
|
|
818
700
|
/** @oneof */
|
|
819
701
|
export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
820
|
-
/**
|
|
702
|
+
/**
|
|
703
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
704
|
+
* @format GUID
|
|
705
|
+
*/
|
|
821
706
|
beforeDefinitionId?: string;
|
|
822
|
-
/**
|
|
707
|
+
/**
|
|
708
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
709
|
+
* @format GUID
|
|
710
|
+
*/
|
|
823
711
|
afterDefinitionId?: string;
|
|
824
712
|
}
|
|
825
713
|
export interface ReorderTicketDefinitionsResponse {
|
|
826
714
|
}
|
|
827
715
|
export interface UpdateTicketDefinitionSortIndexRequest {
|
|
828
|
-
/**
|
|
716
|
+
/**
|
|
717
|
+
* Ticket definition ID
|
|
718
|
+
* @format GUID
|
|
719
|
+
*/
|
|
829
720
|
ticketDefinitionId?: string;
|
|
830
721
|
/** The revision of the ticket definition */
|
|
831
722
|
revision?: string;
|
|
832
723
|
/** the sort index of a ticket definition to set */
|
|
833
724
|
sortIndex?: number;
|
|
834
|
-
/**
|
|
725
|
+
/**
|
|
726
|
+
* Requested fields.
|
|
727
|
+
* @maxSize 5
|
|
728
|
+
*/
|
|
835
729
|
fields?: Field[];
|
|
836
730
|
}
|
|
837
731
|
export interface UpdateTicketDefinitionSortIndexResponse {
|
|
@@ -841,7 +735,10 @@ export interface UpdateTicketDefinitionSortIndexResponse {
|
|
|
841
735
|
export interface QueryTicketDefinitionsRequest {
|
|
842
736
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
843
737
|
query: QueryV2;
|
|
844
|
-
/**
|
|
738
|
+
/**
|
|
739
|
+
* Predefined sets of fields to return.
|
|
740
|
+
* @maxSize 5
|
|
741
|
+
*/
|
|
845
742
|
fields?: Field[];
|
|
846
743
|
}
|
|
847
744
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -851,7 +748,10 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
851
748
|
cursorPaging?: CursorPaging;
|
|
852
749
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "id": "2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5", "revision": {"$ne":"1"} }` */
|
|
853
750
|
filter?: Record<string, any> | null;
|
|
854
|
-
/**
|
|
751
|
+
/**
|
|
752
|
+
* Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information.
|
|
753
|
+
* @maxSize 10
|
|
754
|
+
*/
|
|
855
755
|
sort?: Sorting[];
|
|
856
756
|
}
|
|
857
757
|
/** @oneof */
|
|
@@ -862,7 +762,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
862
762
|
cursorPaging?: CursorPaging;
|
|
863
763
|
}
|
|
864
764
|
export interface Sorting {
|
|
865
|
-
/**
|
|
765
|
+
/**
|
|
766
|
+
* Name of the field to sort by.
|
|
767
|
+
* @maxLength 100
|
|
768
|
+
*/
|
|
866
769
|
fieldName?: string;
|
|
867
770
|
/** Defaults to `ASC` */
|
|
868
771
|
order?: SortOrder;
|
|
@@ -878,13 +781,17 @@ export interface Paging {
|
|
|
878
781
|
offset?: number | null;
|
|
879
782
|
}
|
|
880
783
|
export interface CursorPaging {
|
|
881
|
-
/**
|
|
784
|
+
/**
|
|
785
|
+
* Number of items to load per page.
|
|
786
|
+
* @max 100
|
|
787
|
+
*/
|
|
882
788
|
limit?: number | null;
|
|
883
789
|
/**
|
|
884
790
|
* Pointer to the next or previous page in the list of results.
|
|
885
791
|
* You can get the relevant cursor token
|
|
886
792
|
* from the `pagingMetadata` object in the previous call's response.
|
|
887
793
|
* Not relevant for the first request.
|
|
794
|
+
* @maxLength 16000
|
|
888
795
|
*/
|
|
889
796
|
cursor?: string | null;
|
|
890
797
|
}
|
|
@@ -907,15 +814,24 @@ export interface PagingMetadataV2 {
|
|
|
907
814
|
cursors?: Cursors;
|
|
908
815
|
}
|
|
909
816
|
export interface Cursors {
|
|
910
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* Cursor pointing to next page in the list of results.
|
|
819
|
+
* @maxLength 36
|
|
820
|
+
*/
|
|
911
821
|
next?: string | null;
|
|
912
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* Cursor pointing to previous page in the list of results.
|
|
824
|
+
* @maxLength 36
|
|
825
|
+
*/
|
|
913
826
|
prev?: string | null;
|
|
914
827
|
}
|
|
915
828
|
export interface QueryAvailableTicketDefinitionsRequest {
|
|
916
829
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
917
830
|
query: QueryV2;
|
|
918
|
-
/**
|
|
831
|
+
/**
|
|
832
|
+
* Predefined sets of fields to return.
|
|
833
|
+
* @maxSize 5
|
|
834
|
+
*/
|
|
919
835
|
fields?: Field[];
|
|
920
836
|
}
|
|
921
837
|
export interface QueryAvailableTicketDefinitionsResponse {
|
|
@@ -931,6 +847,8 @@ export interface CountTicketDefinitionsRequest {
|
|
|
931
847
|
* Parameters to count ticket definitions by.
|
|
932
848
|
*
|
|
933
849
|
* - Max: 20 facets.
|
|
850
|
+
* @maxLength 100
|
|
851
|
+
* @maxSize 20
|
|
934
852
|
*/
|
|
935
853
|
facet?: string[];
|
|
936
854
|
}
|
|
@@ -959,19 +877,35 @@ export interface BulkDeleteTicketDefinitionsByFilterRequest {
|
|
|
959
877
|
export interface BulkDeleteTicketDefinitionsByFilterResponse {
|
|
960
878
|
}
|
|
961
879
|
export interface ChangeCurrencyRequest {
|
|
962
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* Event ID.
|
|
882
|
+
* @format GUID
|
|
883
|
+
*/
|
|
963
884
|
eventId: string;
|
|
964
|
-
/**
|
|
885
|
+
/**
|
|
886
|
+
* Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
887
|
+
* @minLength 3
|
|
888
|
+
* @maxLength 3
|
|
889
|
+
*/
|
|
965
890
|
currency: string;
|
|
966
891
|
}
|
|
967
892
|
export interface ChangeCurrencyResponse {
|
|
968
893
|
}
|
|
969
894
|
export interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
970
|
-
/**
|
|
895
|
+
/**
|
|
896
|
+
* Origin instance ID.
|
|
897
|
+
* @format GUID
|
|
898
|
+
*/
|
|
971
899
|
originInstanceId?: string | null;
|
|
972
|
-
/**
|
|
900
|
+
/**
|
|
901
|
+
* Origin Event ID.
|
|
902
|
+
* @format GUID
|
|
903
|
+
*/
|
|
973
904
|
originEventId?: string;
|
|
974
|
-
/**
|
|
905
|
+
/**
|
|
906
|
+
* Target Event ID.
|
|
907
|
+
* @format GUID
|
|
908
|
+
*/
|
|
975
909
|
targetEventId?: string;
|
|
976
910
|
}
|
|
977
911
|
export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
@@ -979,9 +913,15 @@ export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
|
979
913
|
definitions?: CopiedTicketDefinition[];
|
|
980
914
|
}
|
|
981
915
|
export interface CopiedTicketDefinition {
|
|
982
|
-
/**
|
|
916
|
+
/**
|
|
917
|
+
* Origin Ticket definition ID.
|
|
918
|
+
* @format GUID
|
|
919
|
+
*/
|
|
983
920
|
originTicketDefinitionId?: string;
|
|
984
|
-
/**
|
|
921
|
+
/**
|
|
922
|
+
* Ticket definition ID.
|
|
923
|
+
* @format GUID
|
|
924
|
+
*/
|
|
985
925
|
ticketDefinitionId?: string;
|
|
986
926
|
}
|
|
987
927
|
export interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
@@ -990,26 +930,56 @@ export interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
|
990
930
|
}
|
|
991
931
|
export interface UpdateFeeTypesBasedOnSettingsResponse {
|
|
992
932
|
}
|
|
933
|
+
export interface EventDeleted {
|
|
934
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
935
|
+
timestamp?: Date | null;
|
|
936
|
+
/**
|
|
937
|
+
* Event ID.
|
|
938
|
+
* @format GUID
|
|
939
|
+
*/
|
|
940
|
+
eventId?: string;
|
|
941
|
+
/** Event title. */
|
|
942
|
+
title?: string;
|
|
943
|
+
/**
|
|
944
|
+
* Event creator user ID.
|
|
945
|
+
* @format GUID
|
|
946
|
+
*/
|
|
947
|
+
userId?: string | null;
|
|
948
|
+
}
|
|
949
|
+
export interface Empty {
|
|
950
|
+
}
|
|
993
951
|
export interface EventCanceled {
|
|
994
952
|
/** Event canceled timestamp in ISO UTC format. */
|
|
995
953
|
timestamp?: Date | null;
|
|
996
|
-
/**
|
|
954
|
+
/**
|
|
955
|
+
* Event ID.
|
|
956
|
+
* @format GUID
|
|
957
|
+
*/
|
|
997
958
|
eventId?: string;
|
|
998
959
|
/** Event title */
|
|
999
960
|
title?: string;
|
|
1000
|
-
/**
|
|
961
|
+
/**
|
|
962
|
+
* Event creator user ID.
|
|
963
|
+
* @format GUID
|
|
964
|
+
*/
|
|
1001
965
|
userId?: string | null;
|
|
1002
966
|
}
|
|
1003
967
|
export interface EventEnded {
|
|
1004
968
|
/** Event end timestamp in ISO UTC format. */
|
|
1005
969
|
timestamp?: Date | null;
|
|
1006
|
-
/**
|
|
970
|
+
/**
|
|
971
|
+
* Event ID.
|
|
972
|
+
* @format GUID
|
|
973
|
+
*/
|
|
1007
974
|
eventId?: string;
|
|
1008
975
|
}
|
|
1009
976
|
export interface EventCreated {
|
|
1010
977
|
/** Event created timestamp in ISO UTC format. */
|
|
1011
978
|
timestamp?: Date | null;
|
|
1012
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Event ID.
|
|
981
|
+
* @format GUID
|
|
982
|
+
*/
|
|
1013
983
|
eventId?: string;
|
|
1014
984
|
/** Event location. */
|
|
1015
985
|
location?: EventsLocation;
|
|
@@ -1017,23 +987,38 @@ export interface EventCreated {
|
|
|
1017
987
|
scheduleConfig?: ScheduleConfig;
|
|
1018
988
|
/** Event title. */
|
|
1019
989
|
title?: string;
|
|
1020
|
-
/**
|
|
990
|
+
/**
|
|
991
|
+
* Event creator user ID.
|
|
992
|
+
* @maxLength 36
|
|
993
|
+
*/
|
|
1021
994
|
userId?: string | null;
|
|
1022
995
|
/** Event status. */
|
|
1023
996
|
status?: EventStatus;
|
|
1024
|
-
/**
|
|
997
|
+
/**
|
|
998
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
999
|
+
* @format GUID
|
|
1000
|
+
*/
|
|
1025
1001
|
derivedFromInstanceId?: string | null;
|
|
1026
|
-
/**
|
|
1002
|
+
/**
|
|
1003
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
1004
|
+
* @format GUID
|
|
1005
|
+
*/
|
|
1027
1006
|
derivedFromEventId?: string | null;
|
|
1028
1007
|
/** Event that was created. */
|
|
1029
1008
|
event?: Event;
|
|
1030
1009
|
}
|
|
1031
1010
|
export interface EventsLocation {
|
|
1032
|
-
/**
|
|
1011
|
+
/**
|
|
1012
|
+
* Location name.
|
|
1013
|
+
* @maxLength 50
|
|
1014
|
+
*/
|
|
1033
1015
|
name?: string | null;
|
|
1034
1016
|
/** Location map coordinates. */
|
|
1035
1017
|
coordinates?: MapCoordinates;
|
|
1036
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* Single line address representation.
|
|
1020
|
+
* @maxLength 300
|
|
1021
|
+
*/
|
|
1037
1022
|
address?: string | null;
|
|
1038
1023
|
/** Location type. */
|
|
1039
1024
|
type?: LocationLocationType;
|
|
@@ -1055,9 +1040,17 @@ export interface EventsLocation {
|
|
|
1055
1040
|
tbd?: boolean | null;
|
|
1056
1041
|
}
|
|
1057
1042
|
export interface MapCoordinates {
|
|
1058
|
-
/**
|
|
1043
|
+
/**
|
|
1044
|
+
* Latitude.
|
|
1045
|
+
* @min -90
|
|
1046
|
+
* @max 90
|
|
1047
|
+
*/
|
|
1059
1048
|
lat?: number;
|
|
1060
|
-
/**
|
|
1049
|
+
/**
|
|
1050
|
+
* Longitude.
|
|
1051
|
+
* @min -180
|
|
1052
|
+
* @max 180
|
|
1053
|
+
*/
|
|
1061
1054
|
lng?: number;
|
|
1062
1055
|
}
|
|
1063
1056
|
export declare enum LocationLocationType {
|
|
@@ -1070,7 +1063,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
1070
1063
|
streetAddress?: StreetAddress;
|
|
1071
1064
|
/** Main address line (usually street and number) as free text */
|
|
1072
1065
|
addressLine?: string | null;
|
|
1073
|
-
/**
|
|
1066
|
+
/**
|
|
1067
|
+
* country code
|
|
1068
|
+
* @format COUNTRY
|
|
1069
|
+
*/
|
|
1074
1070
|
country?: string | null;
|
|
1075
1071
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1076
1072
|
subdivision?: string | null;
|
|
@@ -1088,7 +1084,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
1088
1084
|
geocode?: AddressLocation;
|
|
1089
1085
|
/** country full-name */
|
|
1090
1086
|
countryFullname?: string | null;
|
|
1091
|
-
/**
|
|
1087
|
+
/**
|
|
1088
|
+
* multi-level subdivisions from top to bottom
|
|
1089
|
+
* @maxSize 6
|
|
1090
|
+
*/
|
|
1092
1091
|
subdivisions?: Subdivision[];
|
|
1093
1092
|
}
|
|
1094
1093
|
/** @oneof */
|
|
@@ -1105,9 +1104,17 @@ export interface StreetAddress {
|
|
|
1105
1104
|
name?: string;
|
|
1106
1105
|
}
|
|
1107
1106
|
export interface AddressLocation {
|
|
1108
|
-
/**
|
|
1107
|
+
/**
|
|
1108
|
+
* address latitude coordinates
|
|
1109
|
+
* @min -90
|
|
1110
|
+
* @max 90
|
|
1111
|
+
*/
|
|
1109
1112
|
latitude?: number | null;
|
|
1110
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* address longitude coordinates
|
|
1115
|
+
* @min -180
|
|
1116
|
+
* @max 180
|
|
1117
|
+
*/
|
|
1111
1118
|
longitude?: number | null;
|
|
1112
1119
|
}
|
|
1113
1120
|
export interface Subdivision {
|
|
@@ -1138,13 +1145,19 @@ export interface ScheduleConfig {
|
|
|
1138
1145
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1139
1146
|
*/
|
|
1140
1147
|
scheduleTbd?: boolean;
|
|
1141
|
-
/**
|
|
1148
|
+
/**
|
|
1149
|
+
* TBD message.
|
|
1150
|
+
* @maxLength 100
|
|
1151
|
+
*/
|
|
1142
1152
|
scheduleTbdMessage?: string | null;
|
|
1143
1153
|
/** Event start timestamp. */
|
|
1144
1154
|
startDate?: Date | null;
|
|
1145
1155
|
/** Event end timestamp. */
|
|
1146
1156
|
endDate?: Date | null;
|
|
1147
|
-
/**
|
|
1157
|
+
/**
|
|
1158
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1159
|
+
* @maxLength 100
|
|
1160
|
+
*/
|
|
1148
1161
|
timeZoneId?: string | null;
|
|
1149
1162
|
/** Whether end date is hidden in the formatted schedule. */
|
|
1150
1163
|
endDateHidden?: boolean;
|
|
@@ -1154,7 +1167,10 @@ export interface ScheduleConfig {
|
|
|
1154
1167
|
recurrences?: EventsRecurrences;
|
|
1155
1168
|
}
|
|
1156
1169
|
export interface EventsRecurrences {
|
|
1157
|
-
/**
|
|
1170
|
+
/**
|
|
1171
|
+
* Event occurrences.
|
|
1172
|
+
* @maxSize 1000
|
|
1173
|
+
*/
|
|
1158
1174
|
occurrences?: EventsOccurrence[];
|
|
1159
1175
|
/**
|
|
1160
1176
|
* Recurring event category ID.
|
|
@@ -1172,7 +1188,10 @@ export interface EventsOccurrence {
|
|
|
1172
1188
|
startDate?: Date | null;
|
|
1173
1189
|
/** Event end timestamp. */
|
|
1174
1190
|
endDate?: Date | null;
|
|
1175
|
-
/**
|
|
1191
|
+
/**
|
|
1192
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1193
|
+
* @maxLength 100
|
|
1194
|
+
*/
|
|
1176
1195
|
timeZoneId?: string | null;
|
|
1177
1196
|
/** Whether time zone is displayed in formatted schedule. */
|
|
1178
1197
|
showTimeZone?: boolean;
|
|
@@ -1202,6 +1221,7 @@ export declare enum EventStatus {
|
|
|
1202
1221
|
export interface Event {
|
|
1203
1222
|
/**
|
|
1204
1223
|
* Event ID.
|
|
1224
|
+
* @format GUID
|
|
1205
1225
|
* @readonly
|
|
1206
1226
|
*/
|
|
1207
1227
|
id?: string;
|
|
@@ -1241,7 +1261,10 @@ export interface Event {
|
|
|
1241
1261
|
instanceId?: string;
|
|
1242
1262
|
/** Guest list configuration. */
|
|
1243
1263
|
guestListConfig?: GuestListConfig;
|
|
1244
|
-
/**
|
|
1264
|
+
/**
|
|
1265
|
+
* Event creator user ID.
|
|
1266
|
+
* @maxLength 36
|
|
1267
|
+
*/
|
|
1245
1268
|
userId?: string;
|
|
1246
1269
|
/** Event discussion feed. For internal use. */
|
|
1247
1270
|
feed?: Feed;
|
|
@@ -1280,7 +1303,11 @@ export interface Scheduling {
|
|
|
1280
1303
|
endTimeFormatted?: string;
|
|
1281
1304
|
}
|
|
1282
1305
|
export interface Image {
|
|
1283
|
-
/**
|
|
1306
|
+
/**
|
|
1307
|
+
* WixMedia image ID.
|
|
1308
|
+
* @minLength 1
|
|
1309
|
+
* @maxLength 200
|
|
1310
|
+
*/
|
|
1284
1311
|
id?: string | null;
|
|
1285
1312
|
/** Image URL. */
|
|
1286
1313
|
url?: string;
|
|
@@ -1408,17 +1435,31 @@ export interface TicketingConfig {
|
|
|
1408
1435
|
guestAssignedTickets?: boolean;
|
|
1409
1436
|
/** Tax configuration. */
|
|
1410
1437
|
taxConfig?: TaxConfig;
|
|
1411
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
1440
|
+
* @max 50
|
|
1441
|
+
*/
|
|
1412
1442
|
ticketLimitPerOrder?: number;
|
|
1413
|
-
/**
|
|
1443
|
+
/**
|
|
1444
|
+
* Duration for which the tickets being bought are reserved.
|
|
1445
|
+
* @min 5
|
|
1446
|
+
* @max 30
|
|
1447
|
+
*/
|
|
1414
1448
|
reservationDurationInMinutes?: number | null;
|
|
1415
1449
|
}
|
|
1416
1450
|
export interface TaxConfig {
|
|
1417
1451
|
/** Tax application settings. */
|
|
1418
1452
|
type?: TaxType;
|
|
1419
|
-
/**
|
|
1453
|
+
/**
|
|
1454
|
+
* Tax name.
|
|
1455
|
+
* @minLength 1
|
|
1456
|
+
* @maxLength 10
|
|
1457
|
+
*/
|
|
1420
1458
|
name?: string | null;
|
|
1421
|
-
/**
|
|
1459
|
+
/**
|
|
1460
|
+
* Tax rate (e.g.,`21.55`).
|
|
1461
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
1462
|
+
*/
|
|
1422
1463
|
rate?: string | null;
|
|
1423
1464
|
/** Applies taxes for donations, default true. */
|
|
1424
1465
|
appliesToDonations?: boolean | null;
|
|
@@ -1434,12 +1475,19 @@ export declare enum TaxType {
|
|
|
1434
1475
|
export interface Money {
|
|
1435
1476
|
/**
|
|
1436
1477
|
* *Deprecated:** Use `value` instead.
|
|
1478
|
+
* @format DECIMAL_VALUE
|
|
1437
1479
|
* @deprecated
|
|
1438
1480
|
*/
|
|
1439
1481
|
amount?: string;
|
|
1440
|
-
/**
|
|
1482
|
+
/**
|
|
1483
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
1484
|
+
* @format CURRENCY
|
|
1485
|
+
*/
|
|
1441
1486
|
currency?: string;
|
|
1442
|
-
/**
|
|
1487
|
+
/**
|
|
1488
|
+
* 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.
|
|
1489
|
+
* @format DECIMAL_VALUE
|
|
1490
|
+
*/
|
|
1443
1491
|
value?: string | null;
|
|
1444
1492
|
}
|
|
1445
1493
|
export interface ExternalEvent {
|
|
@@ -1594,21 +1642,29 @@ export declare enum ValueType {
|
|
|
1594
1642
|
* Defaults to first (0th) option if not configured.
|
|
1595
1643
|
*/
|
|
1596
1644
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1597
|
-
/**
|
|
1645
|
+
/**
|
|
1646
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
1647
|
+
* @max 199
|
|
1648
|
+
*/
|
|
1598
1649
|
optionIndex?: number;
|
|
1599
1650
|
/**
|
|
1600
1651
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
1601
1652
|
* Considered an empty choice.
|
|
1653
|
+
* @maxLength 200
|
|
1602
1654
|
*/
|
|
1603
1655
|
placeholderText?: string;
|
|
1604
1656
|
}
|
|
1605
1657
|
/** @oneof */
|
|
1606
1658
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
1607
|
-
/**
|
|
1659
|
+
/**
|
|
1660
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
1661
|
+
* @max 199
|
|
1662
|
+
*/
|
|
1608
1663
|
optionIndex?: number;
|
|
1609
1664
|
/**
|
|
1610
1665
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
1611
1666
|
* Considered an empty choice.
|
|
1667
|
+
* @maxLength 200
|
|
1612
1668
|
*/
|
|
1613
1669
|
placeholderText?: string;
|
|
1614
1670
|
}
|
|
@@ -1763,7 +1819,10 @@ export interface OnlineConferencingConfig {
|
|
|
1763
1819
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1764
1820
|
*/
|
|
1765
1821
|
enabled?: boolean;
|
|
1766
|
-
/**
|
|
1822
|
+
/**
|
|
1823
|
+
* Conferencing provider ID.
|
|
1824
|
+
* @format GUID
|
|
1825
|
+
*/
|
|
1767
1826
|
providerId?: string | null;
|
|
1768
1827
|
/** Conference type */
|
|
1769
1828
|
conferenceType?: ConferenceType;
|
|
@@ -1802,7 +1861,10 @@ export interface OnlineConferencingSession {
|
|
|
1802
1861
|
sessionId?: string | null;
|
|
1803
1862
|
}
|
|
1804
1863
|
export interface SeoSettings {
|
|
1805
|
-
/**
|
|
1864
|
+
/**
|
|
1865
|
+
* URL slug
|
|
1866
|
+
* @maxLength 130
|
|
1867
|
+
*/
|
|
1806
1868
|
slug?: string;
|
|
1807
1869
|
/** Advanced SEO data */
|
|
1808
1870
|
advancedSeoData?: SeoSchema;
|
|
@@ -1828,7 +1890,10 @@ export interface Keyword {
|
|
|
1828
1890
|
term?: string;
|
|
1829
1891
|
/** Whether the keyword is the main focus keyword. */
|
|
1830
1892
|
isMain?: boolean;
|
|
1831
|
-
/**
|
|
1893
|
+
/**
|
|
1894
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1895
|
+
* @maxLength 1000
|
|
1896
|
+
*/
|
|
1832
1897
|
origin?: string | null;
|
|
1833
1898
|
}
|
|
1834
1899
|
export interface Tag {
|
|
@@ -1861,7 +1926,10 @@ export interface Settings {
|
|
|
1861
1926
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1862
1927
|
*/
|
|
1863
1928
|
preventAutoRedirect?: boolean;
|
|
1864
|
-
/**
|
|
1929
|
+
/**
|
|
1930
|
+
* User-selected keyword terms for a specific page.
|
|
1931
|
+
* @maxSize 5
|
|
1932
|
+
*/
|
|
1865
1933
|
keywords?: Keyword[];
|
|
1866
1934
|
}
|
|
1867
1935
|
export interface Agenda {
|
|
@@ -1876,10 +1944,15 @@ export interface Agenda {
|
|
|
1876
1944
|
export interface Category {
|
|
1877
1945
|
/**
|
|
1878
1946
|
* Category ID.
|
|
1947
|
+
* @format GUID
|
|
1879
1948
|
* @readonly
|
|
1880
1949
|
*/
|
|
1881
1950
|
id?: string;
|
|
1882
|
-
/**
|
|
1951
|
+
/**
|
|
1952
|
+
* Category name.
|
|
1953
|
+
* @minLength 1
|
|
1954
|
+
* @maxLength 30
|
|
1955
|
+
*/
|
|
1883
1956
|
name?: string;
|
|
1884
1957
|
/**
|
|
1885
1958
|
* Date and time when category was created.
|
|
@@ -1902,6 +1975,7 @@ export interface Category {
|
|
|
1902
1975
|
* Default: `MANUAL`.
|
|
1903
1976
|
*
|
|
1904
1977
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1978
|
+
* @maxSize 3
|
|
1905
1979
|
*/
|
|
1906
1980
|
states?: CategoryStateState[];
|
|
1907
1981
|
}
|
|
@@ -2527,11 +2601,20 @@ export interface GIFData {
|
|
|
2527
2601
|
gifType?: GIFType;
|
|
2528
2602
|
}
|
|
2529
2603
|
export interface GIF {
|
|
2530
|
-
/**
|
|
2604
|
+
/**
|
|
2605
|
+
* GIF format URL.
|
|
2606
|
+
* @format WEB_URL
|
|
2607
|
+
*/
|
|
2531
2608
|
gif?: string | null;
|
|
2532
|
-
/**
|
|
2609
|
+
/**
|
|
2610
|
+
* MP4 format URL.
|
|
2611
|
+
* @format WEB_URL
|
|
2612
|
+
*/
|
|
2533
2613
|
mp4?: string | null;
|
|
2534
|
-
/**
|
|
2614
|
+
/**
|
|
2615
|
+
* Thumbnail URL.
|
|
2616
|
+
* @format WEB_URL
|
|
2617
|
+
*/
|
|
2535
2618
|
still?: string | null;
|
|
2536
2619
|
}
|
|
2537
2620
|
export declare enum GIFType {
|
|
@@ -2605,7 +2688,10 @@ export interface ImageData {
|
|
|
2605
2688
|
export interface StylesBorder {
|
|
2606
2689
|
/** Border width in pixels. */
|
|
2607
2690
|
width?: number | null;
|
|
2608
|
-
/**
|
|
2691
|
+
/**
|
|
2692
|
+
* Border color as a hexadecimal value.
|
|
2693
|
+
* @format COLOR_HEX
|
|
2694
|
+
*/
|
|
2609
2695
|
color?: string | null;
|
|
2610
2696
|
/** Border radius in pixels. */
|
|
2611
2697
|
radius?: number | null;
|
|
@@ -2759,13 +2845,22 @@ export declare enum BackgroundType {
|
|
|
2759
2845
|
export interface Gradient {
|
|
2760
2846
|
/** The gradient angle in degrees. */
|
|
2761
2847
|
angle?: number | null;
|
|
2762
|
-
/**
|
|
2848
|
+
/**
|
|
2849
|
+
* The start color as a hexademical value.
|
|
2850
|
+
* @format COLOR_HEX
|
|
2851
|
+
*/
|
|
2763
2852
|
startColor?: string | null;
|
|
2764
|
-
/**
|
|
2853
|
+
/**
|
|
2854
|
+
* The end color as a hexademical value.
|
|
2855
|
+
* @format COLOR_HEX
|
|
2856
|
+
*/
|
|
2765
2857
|
lastColor?: string | null;
|
|
2766
2858
|
}
|
|
2767
2859
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
2768
|
-
/**
|
|
2860
|
+
/**
|
|
2861
|
+
* The background color as a hexademical value.
|
|
2862
|
+
* @format COLOR_HEX
|
|
2863
|
+
*/
|
|
2769
2864
|
color?: string | null;
|
|
2770
2865
|
/** An image to use for the background. */
|
|
2771
2866
|
image?: Media;
|
|
@@ -2776,7 +2871,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2776
2871
|
}
|
|
2777
2872
|
/** @oneof */
|
|
2778
2873
|
export interface BackgroundBackgroundOneOf {
|
|
2779
|
-
/**
|
|
2874
|
+
/**
|
|
2875
|
+
* The background color as a hexademical value.
|
|
2876
|
+
* @format COLOR_HEX
|
|
2877
|
+
*/
|
|
2780
2878
|
color?: string | null;
|
|
2781
2879
|
/** An image to use for the background. */
|
|
2782
2880
|
image?: Media;
|
|
@@ -3088,17 +3186,32 @@ export declare enum VerticalAlignment {
|
|
|
3088
3186
|
export interface CellStyle {
|
|
3089
3187
|
/** Vertical alignment for the cell's text. */
|
|
3090
3188
|
verticalAlignment?: VerticalAlignment;
|
|
3091
|
-
/**
|
|
3189
|
+
/**
|
|
3190
|
+
* Cell background color as a hexadecimal value.
|
|
3191
|
+
* @format COLOR_HEX
|
|
3192
|
+
*/
|
|
3092
3193
|
backgroundColor?: string | null;
|
|
3093
3194
|
}
|
|
3094
3195
|
export interface BorderColors {
|
|
3095
|
-
/**
|
|
3196
|
+
/**
|
|
3197
|
+
* Left border color as a hexadecimal value.
|
|
3198
|
+
* @format COLOR_HEX
|
|
3199
|
+
*/
|
|
3096
3200
|
left?: string | null;
|
|
3097
|
-
/**
|
|
3201
|
+
/**
|
|
3202
|
+
* Right border color as a hexadecimal value.
|
|
3203
|
+
* @format COLOR_HEX
|
|
3204
|
+
*/
|
|
3098
3205
|
right?: string | null;
|
|
3099
|
-
/**
|
|
3206
|
+
/**
|
|
3207
|
+
* Top border color as a hexadecimal value.
|
|
3208
|
+
* @format COLOR_HEX
|
|
3209
|
+
*/
|
|
3100
3210
|
top?: string | null;
|
|
3101
|
-
/**
|
|
3211
|
+
/**
|
|
3212
|
+
* Bottom border color as a hexadecimal value.
|
|
3213
|
+
* @format COLOR_HEX
|
|
3214
|
+
*/
|
|
3102
3215
|
bottom?: string | null;
|
|
3103
3216
|
}
|
|
3104
3217
|
/**
|
|
@@ -3209,7 +3322,10 @@ export interface TextNodeStyle {
|
|
|
3209
3322
|
export interface EventUpdated {
|
|
3210
3323
|
/** Event update timestamp in ISO UTC format. */
|
|
3211
3324
|
timestamp?: Date | null;
|
|
3212
|
-
/**
|
|
3325
|
+
/**
|
|
3326
|
+
* Event ID.
|
|
3327
|
+
* @format GUID
|
|
3328
|
+
*/
|
|
3213
3329
|
eventId?: string;
|
|
3214
3330
|
/** Event location. */
|
|
3215
3331
|
location?: EventsLocation;
|
|
@@ -3226,11 +3342,17 @@ export interface EventUpdated {
|
|
|
3226
3342
|
event?: Event;
|
|
3227
3343
|
}
|
|
3228
3344
|
export interface SeatingPlanCategoriesSummaryUpdated {
|
|
3229
|
-
/**
|
|
3345
|
+
/**
|
|
3346
|
+
* Seating plan id
|
|
3347
|
+
* @format GUID
|
|
3348
|
+
*/
|
|
3230
3349
|
seatingPlanId?: string;
|
|
3231
3350
|
/** External seating plan id */
|
|
3232
3351
|
externalSeatingPlanId?: string | null;
|
|
3233
|
-
/**
|
|
3352
|
+
/**
|
|
3353
|
+
* Ticket counts by category
|
|
3354
|
+
* @maxSize 100
|
|
3355
|
+
*/
|
|
3234
3356
|
categories?: CategoryDetails[];
|
|
3235
3357
|
/**
|
|
3236
3358
|
* Summary revision.
|
|
@@ -3241,16 +3363,21 @@ export interface SeatingPlanCategoriesSummaryUpdated {
|
|
|
3241
3363
|
export interface CategoryDetails {
|
|
3242
3364
|
/**
|
|
3243
3365
|
* Seating plan id
|
|
3366
|
+
* @format GUID
|
|
3244
3367
|
* @readonly
|
|
3245
3368
|
*/
|
|
3246
3369
|
seatingPlanId?: string | null;
|
|
3247
3370
|
/**
|
|
3248
3371
|
* External seating plan id
|
|
3372
|
+
* @minLength 1
|
|
3373
|
+
* @maxLength 100
|
|
3249
3374
|
* @readonly
|
|
3250
3375
|
*/
|
|
3251
3376
|
externalSeatingPlanId?: string | null;
|
|
3252
3377
|
/**
|
|
3253
3378
|
* External category id
|
|
3379
|
+
* @minLength 1
|
|
3380
|
+
* @maxLength 100
|
|
3254
3381
|
* @readonly
|
|
3255
3382
|
*/
|
|
3256
3383
|
externalCategoryId?: string | null;
|
|
@@ -3265,6 +3392,78 @@ export interface CategoryDetails {
|
|
|
3265
3392
|
*/
|
|
3266
3393
|
reserved?: number | null;
|
|
3267
3394
|
}
|
|
3395
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3396
|
+
createdEvent?: EntityCreatedEvent;
|
|
3397
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3398
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3399
|
+
actionEvent?: ActionEvent;
|
|
3400
|
+
/**
|
|
3401
|
+
* Unique event ID.
|
|
3402
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3403
|
+
*/
|
|
3404
|
+
id?: string;
|
|
3405
|
+
/**
|
|
3406
|
+
* Assumes actions are also always typed to an entity_type
|
|
3407
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3408
|
+
*/
|
|
3409
|
+
entityFqdn?: string;
|
|
3410
|
+
/**
|
|
3411
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3412
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3413
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3414
|
+
*/
|
|
3415
|
+
slug?: string;
|
|
3416
|
+
/** ID of the entity associated with the event. */
|
|
3417
|
+
entityId?: string;
|
|
3418
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3419
|
+
eventTime?: Date | null;
|
|
3420
|
+
/**
|
|
3421
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3422
|
+
* (for example, GDPR).
|
|
3423
|
+
*/
|
|
3424
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3425
|
+
/** If present, indicates the action that triggered the event. */
|
|
3426
|
+
originatedFrom?: string | null;
|
|
3427
|
+
/**
|
|
3428
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3429
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3430
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3431
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3432
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3433
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3434
|
+
*/
|
|
3435
|
+
entityEventSequence?: string | null;
|
|
3436
|
+
}
|
|
3437
|
+
/** @oneof */
|
|
3438
|
+
export interface DomainEventBodyOneOf {
|
|
3439
|
+
createdEvent?: EntityCreatedEvent;
|
|
3440
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3441
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3442
|
+
actionEvent?: ActionEvent;
|
|
3443
|
+
}
|
|
3444
|
+
export interface EntityCreatedEvent {
|
|
3445
|
+
entityAsJson?: string;
|
|
3446
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3447
|
+
restoreInfo?: RestoreInfo;
|
|
3448
|
+
}
|
|
3449
|
+
export interface RestoreInfo {
|
|
3450
|
+
deletedDate?: Date | null;
|
|
3451
|
+
}
|
|
3452
|
+
export interface EntityUpdatedEvent {
|
|
3453
|
+
/**
|
|
3454
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3455
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3456
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3457
|
+
*/
|
|
3458
|
+
currentEntityAsJson?: string;
|
|
3459
|
+
}
|
|
3460
|
+
export interface EntityDeletedEvent {
|
|
3461
|
+
/** Entity that was deleted */
|
|
3462
|
+
deletedEntityAsJson?: string | null;
|
|
3463
|
+
}
|
|
3464
|
+
export interface ActionEvent {
|
|
3465
|
+
bodyAsJson?: string;
|
|
3466
|
+
}
|
|
3268
3467
|
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
3269
3468
|
/** Emitted on a meta site creation. */
|
|
3270
3469
|
siteCreated?: SiteCreated;
|
|
@@ -3296,7 +3495,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3296
3495
|
studioAssigned?: StudioAssigned;
|
|
3297
3496
|
/** Emitted when Studio is detached. */
|
|
3298
3497
|
studioUnassigned?: StudioUnassigned;
|
|
3299
|
-
/**
|
|
3498
|
+
/**
|
|
3499
|
+
* A meta site id.
|
|
3500
|
+
* @format GUID
|
|
3501
|
+
*/
|
|
3300
3502
|
metaSiteId?: string;
|
|
3301
3503
|
/** A meta site version. Monotonically increasing. */
|
|
3302
3504
|
version?: string;
|
|
@@ -3305,6 +3507,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3305
3507
|
/**
|
|
3306
3508
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
3307
3509
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
3510
|
+
* @maxSize 4000
|
|
3308
3511
|
*/
|
|
3309
3512
|
assets?: Asset[];
|
|
3310
3513
|
}
|
|
@@ -3342,9 +3545,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
3342
3545
|
studioUnassigned?: StudioUnassigned;
|
|
3343
3546
|
}
|
|
3344
3547
|
export interface Asset {
|
|
3345
|
-
/**
|
|
3548
|
+
/**
|
|
3549
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
3550
|
+
* @maxLength 36
|
|
3551
|
+
*/
|
|
3346
3552
|
appDefId?: string;
|
|
3347
|
-
/**
|
|
3553
|
+
/**
|
|
3554
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
3555
|
+
* @maxLength 200
|
|
3556
|
+
*/
|
|
3348
3557
|
instanceId?: string;
|
|
3349
3558
|
/** An application state. */
|
|
3350
3559
|
state?: State;
|
|
@@ -3357,9 +3566,15 @@ export declare enum State {
|
|
|
3357
3566
|
DEMO = "DEMO"
|
|
3358
3567
|
}
|
|
3359
3568
|
export interface SiteCreated {
|
|
3360
|
-
/**
|
|
3569
|
+
/**
|
|
3570
|
+
* A template identifier (empty if not created from a template).
|
|
3571
|
+
* @maxLength 36
|
|
3572
|
+
*/
|
|
3361
3573
|
originTemplateId?: string;
|
|
3362
|
-
/**
|
|
3574
|
+
/**
|
|
3575
|
+
* An account id of the owner.
|
|
3576
|
+
* @format GUID
|
|
3577
|
+
*/
|
|
3363
3578
|
ownerId?: string;
|
|
3364
3579
|
/** A context in which meta site was created. */
|
|
3365
3580
|
context?: SiteCreatedContext;
|
|
@@ -3368,9 +3583,13 @@ export interface SiteCreated {
|
|
|
3368
3583
|
*
|
|
3369
3584
|
* In case of a creation from a template it's a template id.
|
|
3370
3585
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
3586
|
+
* @format GUID
|
|
3371
3587
|
*/
|
|
3372
3588
|
originMetaSiteId?: string | null;
|
|
3373
|
-
/**
|
|
3589
|
+
/**
|
|
3590
|
+
* A meta site name (URL slug).
|
|
3591
|
+
* @maxLength 20
|
|
3592
|
+
*/
|
|
3374
3593
|
siteName?: string;
|
|
3375
3594
|
/** A namespace. */
|
|
3376
3595
|
namespace?: Namespace;
|
|
@@ -3467,9 +3686,15 @@ export declare enum Namespace {
|
|
|
3467
3686
|
}
|
|
3468
3687
|
/** Site transferred to another user. */
|
|
3469
3688
|
export interface SiteTransferred {
|
|
3470
|
-
/**
|
|
3689
|
+
/**
|
|
3690
|
+
* A previous owner id (user that transfers meta site).
|
|
3691
|
+
* @format GUID
|
|
3692
|
+
*/
|
|
3471
3693
|
oldOwnerId?: string;
|
|
3472
|
-
/**
|
|
3694
|
+
/**
|
|
3695
|
+
* A new owner id (user that accepts meta site).
|
|
3696
|
+
* @format GUID
|
|
3697
|
+
*/
|
|
3473
3698
|
newOwnerId?: string;
|
|
3474
3699
|
}
|
|
3475
3700
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -3482,9 +3707,15 @@ export interface DeleteContext {
|
|
|
3482
3707
|
dateDeleted?: Date | null;
|
|
3483
3708
|
/** A status. */
|
|
3484
3709
|
deleteStatus?: DeleteStatus;
|
|
3485
|
-
/**
|
|
3710
|
+
/**
|
|
3711
|
+
* A reason (flow).
|
|
3712
|
+
* @maxLength 255
|
|
3713
|
+
*/
|
|
3486
3714
|
deleteOrigin?: string;
|
|
3487
|
-
/**
|
|
3715
|
+
/**
|
|
3716
|
+
* A service that deleted it.
|
|
3717
|
+
* @maxLength 255
|
|
3718
|
+
*/
|
|
3488
3719
|
initiatorId?: string | null;
|
|
3489
3720
|
}
|
|
3490
3721
|
export declare enum DeleteStatus {
|
|
@@ -3500,7 +3731,11 @@ export interface SiteUndeleted {
|
|
|
3500
3731
|
export interface SitePublished {
|
|
3501
3732
|
}
|
|
3502
3733
|
export interface SiteUnpublished {
|
|
3503
|
-
/**
|
|
3734
|
+
/**
|
|
3735
|
+
* A list of URLs previously associated with the meta site.
|
|
3736
|
+
* @maxLength 4000
|
|
3737
|
+
* @maxSize 10000
|
|
3738
|
+
*/
|
|
3504
3739
|
urls?: string[];
|
|
3505
3740
|
}
|
|
3506
3741
|
export interface SiteMarkedAsTemplate {
|
|
@@ -3523,30 +3758,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
3523
3758
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
3524
3759
|
*/
|
|
3525
3760
|
export interface ServiceProvisioned {
|
|
3526
|
-
/**
|
|
3761
|
+
/**
|
|
3762
|
+
* Either UUID or EmbeddedServiceType.
|
|
3763
|
+
* @maxLength 36
|
|
3764
|
+
*/
|
|
3527
3765
|
appDefId?: string;
|
|
3528
|
-
/**
|
|
3766
|
+
/**
|
|
3767
|
+
* Not only UUID. Something here could be something weird.
|
|
3768
|
+
* @maxLength 36
|
|
3769
|
+
*/
|
|
3529
3770
|
instanceId?: string;
|
|
3530
|
-
/**
|
|
3771
|
+
/**
|
|
3772
|
+
* An instance id from which this instance is originated.
|
|
3773
|
+
* @maxLength 36
|
|
3774
|
+
*/
|
|
3531
3775
|
originInstanceId?: string;
|
|
3532
|
-
/**
|
|
3776
|
+
/**
|
|
3777
|
+
* A version.
|
|
3778
|
+
* @maxLength 500
|
|
3779
|
+
*/
|
|
3533
3780
|
version?: string | null;
|
|
3534
|
-
/**
|
|
3781
|
+
/**
|
|
3782
|
+
* The origin meta site id
|
|
3783
|
+
* @format GUID
|
|
3784
|
+
*/
|
|
3535
3785
|
originMetaSiteId?: string | null;
|
|
3536
3786
|
}
|
|
3537
3787
|
export interface ServiceRemoved {
|
|
3538
|
-
/**
|
|
3788
|
+
/**
|
|
3789
|
+
* Either UUID or EmbeddedServiceType.
|
|
3790
|
+
* @maxLength 36
|
|
3791
|
+
*/
|
|
3539
3792
|
appDefId?: string;
|
|
3540
|
-
/**
|
|
3793
|
+
/**
|
|
3794
|
+
* Not only UUID. Something here could be something weird.
|
|
3795
|
+
* @maxLength 36
|
|
3796
|
+
*/
|
|
3541
3797
|
instanceId?: string;
|
|
3542
|
-
/**
|
|
3798
|
+
/**
|
|
3799
|
+
* A version.
|
|
3800
|
+
* @maxLength 500
|
|
3801
|
+
*/
|
|
3543
3802
|
version?: string | null;
|
|
3544
3803
|
}
|
|
3545
3804
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
3546
3805
|
export interface SiteRenamed {
|
|
3547
|
-
/**
|
|
3806
|
+
/**
|
|
3807
|
+
* A new meta site name (URL slug).
|
|
3808
|
+
* @maxLength 20
|
|
3809
|
+
*/
|
|
3548
3810
|
newSiteName?: string;
|
|
3549
|
-
/**
|
|
3811
|
+
/**
|
|
3812
|
+
* A previous meta site name (URL slug).
|
|
3813
|
+
* @maxLength 255
|
|
3814
|
+
*/
|
|
3550
3815
|
oldSiteName?: string;
|
|
3551
3816
|
}
|
|
3552
3817
|
/**
|
|
@@ -3571,9 +3836,15 @@ export interface StudioAssigned {
|
|
|
3571
3836
|
export interface StudioUnassigned {
|
|
3572
3837
|
}
|
|
3573
3838
|
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
3574
|
-
/**
|
|
3839
|
+
/**
|
|
3840
|
+
* Ticket definition ID.
|
|
3841
|
+
* @format GUID
|
|
3842
|
+
*/
|
|
3575
3843
|
ticketDefinitionId?: string;
|
|
3576
|
-
/**
|
|
3844
|
+
/**
|
|
3845
|
+
* Requested fields. Not implemented.
|
|
3846
|
+
* @maxSize 5
|
|
3847
|
+
*/
|
|
3577
3848
|
fields?: Field[];
|
|
3578
3849
|
}
|
|
3579
3850
|
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
@@ -3581,9 +3852,287 @@ export interface GetTicketDefinitionFromTrashBinResponse {
|
|
|
3581
3852
|
ticketDefinition?: TicketDefinition;
|
|
3582
3853
|
}
|
|
3583
3854
|
export interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3584
|
-
/**
|
|
3855
|
+
/**
|
|
3856
|
+
* Definition ID.
|
|
3857
|
+
* @format GUID
|
|
3858
|
+
*/
|
|
3585
3859
|
ticketDefinitionId?: string;
|
|
3586
3860
|
}
|
|
3861
|
+
export interface MessageEnvelope {
|
|
3862
|
+
/**
|
|
3863
|
+
* App instance ID.
|
|
3864
|
+
* @format GUID
|
|
3865
|
+
*/
|
|
3866
|
+
instanceId?: string | null;
|
|
3867
|
+
/**
|
|
3868
|
+
* Event type.
|
|
3869
|
+
* @maxLength 150
|
|
3870
|
+
*/
|
|
3871
|
+
eventType?: string;
|
|
3872
|
+
/** The identification type and identity data. */
|
|
3873
|
+
identity?: IdentificationData;
|
|
3874
|
+
/** Stringify payload. */
|
|
3875
|
+
data?: string;
|
|
3876
|
+
}
|
|
3877
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3878
|
+
/**
|
|
3879
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3880
|
+
* @format GUID
|
|
3881
|
+
*/
|
|
3882
|
+
anonymousVisitorId?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* ID of a site visitor that has logged in to the site.
|
|
3885
|
+
* @format GUID
|
|
3886
|
+
*/
|
|
3887
|
+
memberId?: string;
|
|
3888
|
+
/**
|
|
3889
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3890
|
+
* @format GUID
|
|
3891
|
+
*/
|
|
3892
|
+
wixUserId?: string;
|
|
3893
|
+
/**
|
|
3894
|
+
* ID of an app.
|
|
3895
|
+
* @format GUID
|
|
3896
|
+
*/
|
|
3897
|
+
appId?: string;
|
|
3898
|
+
/** @readonly */
|
|
3899
|
+
identityType?: WebhookIdentityType;
|
|
3900
|
+
}
|
|
3901
|
+
/** @oneof */
|
|
3902
|
+
export interface IdentificationDataIdOneOf {
|
|
3903
|
+
/**
|
|
3904
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3905
|
+
* @format GUID
|
|
3906
|
+
*/
|
|
3907
|
+
anonymousVisitorId?: string;
|
|
3908
|
+
/**
|
|
3909
|
+
* ID of a site visitor that has logged in to the site.
|
|
3910
|
+
* @format GUID
|
|
3911
|
+
*/
|
|
3912
|
+
memberId?: string;
|
|
3913
|
+
/**
|
|
3914
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3915
|
+
* @format GUID
|
|
3916
|
+
*/
|
|
3917
|
+
wixUserId?: string;
|
|
3918
|
+
/**
|
|
3919
|
+
* ID of an app.
|
|
3920
|
+
* @format GUID
|
|
3921
|
+
*/
|
|
3922
|
+
appId?: string;
|
|
3923
|
+
}
|
|
3924
|
+
export declare enum WebhookIdentityType {
|
|
3925
|
+
UNKNOWN = "UNKNOWN",
|
|
3926
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3927
|
+
MEMBER = "MEMBER",
|
|
3928
|
+
WIX_USER = "WIX_USER",
|
|
3929
|
+
APP = "APP"
|
|
3930
|
+
}
|
|
3931
|
+
export interface GetTicketDefinitionSummaryRequest {
|
|
3932
|
+
/**
|
|
3933
|
+
* Ticket definition id.
|
|
3934
|
+
* @format GUID
|
|
3935
|
+
*/
|
|
3936
|
+
ticketDefinitionId?: string | null;
|
|
3937
|
+
}
|
|
3938
|
+
export interface GetTicketDefinitionSummaryResponse {
|
|
3939
|
+
/** Summary. */
|
|
3940
|
+
summary?: TicketDefinitionSummary;
|
|
3941
|
+
}
|
|
3942
|
+
export interface TicketDefinitionSummary {
|
|
3943
|
+
/**
|
|
3944
|
+
* Ticket definition ID.
|
|
3945
|
+
* @format GUID
|
|
3946
|
+
* @readonly
|
|
3947
|
+
*/
|
|
3948
|
+
definitionId?: string | null;
|
|
3949
|
+
/**
|
|
3950
|
+
* Event ID to which the ticket definition summary belongs.
|
|
3951
|
+
* @format GUID
|
|
3952
|
+
* @readonly
|
|
3953
|
+
*/
|
|
3954
|
+
eventId?: string | null;
|
|
3955
|
+
/**
|
|
3956
|
+
* Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3957
|
+
* @readonly
|
|
3958
|
+
*/
|
|
3959
|
+
updatedDate?: Date | null;
|
|
3960
|
+
/**
|
|
3961
|
+
* Reserved count.
|
|
3962
|
+
* @readonly
|
|
3963
|
+
*/
|
|
3964
|
+
reservedCount?: number;
|
|
3965
|
+
/**
|
|
3966
|
+
* Sold count.
|
|
3967
|
+
* @readonly
|
|
3968
|
+
*/
|
|
3969
|
+
soldCount?: number;
|
|
3970
|
+
/**
|
|
3971
|
+
* Paid exists.
|
|
3972
|
+
* @readonly
|
|
3973
|
+
*/
|
|
3974
|
+
paidExists?: boolean;
|
|
3975
|
+
}
|
|
3976
|
+
export interface ListEventTicketingSummaryRequest {
|
|
3977
|
+
/**
|
|
3978
|
+
* Event ID.
|
|
3979
|
+
* @format GUID
|
|
3980
|
+
* @minSize 1
|
|
3981
|
+
* @maxSize 1000
|
|
3982
|
+
*/
|
|
3983
|
+
eventId?: string[];
|
|
3984
|
+
}
|
|
3985
|
+
export interface ListEventTicketingSummaryResponse {
|
|
3986
|
+
/** Ticketing summaries. */
|
|
3987
|
+
summaries?: EventTicketingSummary[];
|
|
3988
|
+
}
|
|
3989
|
+
export interface EventTicketingSummary {
|
|
3990
|
+
/**
|
|
3991
|
+
* Event ID to which the ticketing summary belongs.
|
|
3992
|
+
* @format GUID
|
|
3993
|
+
* @readonly
|
|
3994
|
+
*/
|
|
3995
|
+
eventId?: string | null;
|
|
3996
|
+
/**
|
|
3997
|
+
* Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3998
|
+
* @readonly
|
|
3999
|
+
*/
|
|
4000
|
+
updatedDate?: Date | null;
|
|
4001
|
+
/**
|
|
4002
|
+
* Whether all tickets are sold for this event.
|
|
4003
|
+
* @readonly
|
|
4004
|
+
*/
|
|
4005
|
+
soldOut?: boolean | null;
|
|
4006
|
+
/**
|
|
4007
|
+
* Price of lowest priced ticket.
|
|
4008
|
+
* @readonly
|
|
4009
|
+
*/
|
|
4010
|
+
lowestTicketPrice?: CommonMoney;
|
|
4011
|
+
/**
|
|
4012
|
+
* Price of highest priced ticket.
|
|
4013
|
+
* @readonly
|
|
4014
|
+
*/
|
|
4015
|
+
highestTicketPrice?: CommonMoney;
|
|
4016
|
+
/**
|
|
4017
|
+
* Currency used in event transactions.
|
|
4018
|
+
* @minLength 3
|
|
4019
|
+
* @maxLength 3
|
|
4020
|
+
* @readonly
|
|
4021
|
+
*/
|
|
4022
|
+
currency?: string | null;
|
|
4023
|
+
/**
|
|
4024
|
+
* Formatted price of lowest priced ticket.
|
|
4025
|
+
* @maxLength 50
|
|
4026
|
+
* @readonly
|
|
4027
|
+
*/
|
|
4028
|
+
lowestTicketPriceFormatted?: string | null;
|
|
4029
|
+
/**
|
|
4030
|
+
* Formatted price of highest priced ticket.
|
|
4031
|
+
* @maxLength 50
|
|
4032
|
+
* @readonly
|
|
4033
|
+
*/
|
|
4034
|
+
highestTicketPriceFormatted?: string | null;
|
|
4035
|
+
}
|
|
4036
|
+
export interface ReservationCreated {
|
|
4037
|
+
/** Reservation created timestamp in ISO UTC format. */
|
|
4038
|
+
timestamp?: Date | null;
|
|
4039
|
+
/**
|
|
4040
|
+
* Event ID.
|
|
4041
|
+
* @format GUID
|
|
4042
|
+
*/
|
|
4043
|
+
eventId?: string;
|
|
4044
|
+
/**
|
|
4045
|
+
* Reservation ID.
|
|
4046
|
+
* Can be used to retrieve a reservation invoice.
|
|
4047
|
+
* @format GUID
|
|
4048
|
+
*/
|
|
4049
|
+
reservationId?: string;
|
|
4050
|
+
/** Reservation expiration timestamp. */
|
|
4051
|
+
expires?: Date | null;
|
|
4052
|
+
/** Reservation status. */
|
|
4053
|
+
status?: ReservationStatus;
|
|
4054
|
+
/**
|
|
4055
|
+
* Reservation ticket quantities.
|
|
4056
|
+
* @maxSize 50
|
|
4057
|
+
*/
|
|
4058
|
+
quantities?: TicketQuantity[];
|
|
4059
|
+
/** Reservation update timestamp. */
|
|
4060
|
+
updatedDate?: Date | null;
|
|
4061
|
+
/**
|
|
4062
|
+
* Reservation counts.
|
|
4063
|
+
* @maxSize 50
|
|
4064
|
+
*/
|
|
4065
|
+
counts?: ReservationCount[];
|
|
4066
|
+
}
|
|
4067
|
+
export declare enum ReservationStatus {
|
|
4068
|
+
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
4069
|
+
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
4070
|
+
/** The reservation is confirmed and will not expire. */
|
|
4071
|
+
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
4072
|
+
/** The reservation is canceled because of non payment. */
|
|
4073
|
+
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
4074
|
+
/** The reservation is canceled manually by the buyer. */
|
|
4075
|
+
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
4076
|
+
/** The reservation is expired. */
|
|
4077
|
+
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4078
|
+
}
|
|
4079
|
+
export interface TicketQuantity {
|
|
4080
|
+
/**
|
|
4081
|
+
* Ticket definition ID.
|
|
4082
|
+
* @format GUID
|
|
4083
|
+
*/
|
|
4084
|
+
ticketDefinitionId?: string | null;
|
|
4085
|
+
/** Quantity. */
|
|
4086
|
+
quantity?: number | null;
|
|
4087
|
+
/** Quantity update timestamp. */
|
|
4088
|
+
updatedDate?: Date | null;
|
|
4089
|
+
}
|
|
4090
|
+
export interface ReservationCount {
|
|
4091
|
+
/** Reservation Count snapshot timestamp. */
|
|
4092
|
+
timestamp?: Date | null;
|
|
4093
|
+
/**
|
|
4094
|
+
* Ticket Definition ID.
|
|
4095
|
+
* @format GUID
|
|
4096
|
+
*/
|
|
4097
|
+
ticketDefinitionId?: string;
|
|
4098
|
+
/** Confirmed reservation count. */
|
|
4099
|
+
confirmedCount?: number;
|
|
4100
|
+
/** Pending reservation count. */
|
|
4101
|
+
pendingCount?: number;
|
|
4102
|
+
/** True if paid ticket reservation exist. */
|
|
4103
|
+
paidExists?: boolean;
|
|
4104
|
+
}
|
|
4105
|
+
export interface ReservationUpdated {
|
|
4106
|
+
/** Reservation updated timestamp. */
|
|
4107
|
+
timestamp?: Date | null;
|
|
4108
|
+
/**
|
|
4109
|
+
* Event ID.
|
|
4110
|
+
* @format GUID
|
|
4111
|
+
*/
|
|
4112
|
+
eventId?: string;
|
|
4113
|
+
/**
|
|
4114
|
+
* Reservation ID.
|
|
4115
|
+
* Can be used to retrieve a reservation invoice.
|
|
4116
|
+
* @format GUID
|
|
4117
|
+
*/
|
|
4118
|
+
reservationId?: string;
|
|
4119
|
+
/** Reservation status. */
|
|
4120
|
+
status?: ReservationStatus;
|
|
4121
|
+
/** Reservation expiration timestamp. */
|
|
4122
|
+
expires?: Date | null;
|
|
4123
|
+
/**
|
|
4124
|
+
* Reservation ticket quantities.
|
|
4125
|
+
* @maxSize 50
|
|
4126
|
+
*/
|
|
4127
|
+
quantities?: TicketQuantity[];
|
|
4128
|
+
/** Reservation update timestamp. */
|
|
4129
|
+
updatedDate?: Date | null;
|
|
4130
|
+
/**
|
|
4131
|
+
* Reservation counts.
|
|
4132
|
+
* @maxSize 50
|
|
4133
|
+
*/
|
|
4134
|
+
counts?: ReservationCount[];
|
|
4135
|
+
}
|
|
3587
4136
|
interface CommonMoneyNonNullableFields {
|
|
3588
4137
|
value: string;
|
|
3589
4138
|
currency: string;
|