@wix/auto_sdk_events_ticket-definitions-v-2 1.0.5 → 1.0.6
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 +1004 -458
- 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 +1237 -624
- 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 +1004 -458
- 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 +1237 -624
- 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 +1004 -458
- 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 +1237 -624
- 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 +1004 -458
- 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 +1237 -624
- 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
|
@@ -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
|
addressLine1?: 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,26 +452,31 @@ 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
|
}
|
|
@@ -397,132 +494,16 @@ export declare enum Status {
|
|
|
397
494
|
/** Event is not public. */
|
|
398
495
|
DRAFT = "DRAFT"
|
|
399
496
|
}
|
|
400
|
-
export interface
|
|
401
|
-
/** Ticket definition sale period after update. */
|
|
402
|
-
afterUpdate?: SalePeriod;
|
|
403
|
-
}
|
|
404
|
-
export interface TicketDefinitionSaleStarted {
|
|
405
|
-
/** Ticket definition. */
|
|
406
|
-
ticketDefinition?: TicketDefinition;
|
|
407
|
-
}
|
|
408
|
-
export interface TicketDefinitionSaleEnded {
|
|
409
|
-
/** Ticket definition. */
|
|
410
|
-
ticketDefinition?: TicketDefinition;
|
|
411
|
-
}
|
|
412
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
413
|
-
createdEvent?: EntityCreatedEvent;
|
|
414
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
415
|
-
deletedEvent?: EntityDeletedEvent;
|
|
416
|
-
actionEvent?: ActionEvent;
|
|
417
|
-
/**
|
|
418
|
-
* Unique event ID.
|
|
419
|
-
* Allows clients to ignore duplicate webhooks.
|
|
420
|
-
*/
|
|
421
|
-
_id?: string;
|
|
422
|
-
/**
|
|
423
|
-
* Assumes actions are also always typed to an entity_type
|
|
424
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
425
|
-
*/
|
|
426
|
-
entityFqdn?: string;
|
|
427
|
-
/**
|
|
428
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
429
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
430
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
431
|
-
*/
|
|
432
|
-
slug?: string;
|
|
433
|
-
/** ID of the entity associated with the event. */
|
|
434
|
-
entityId?: string;
|
|
435
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
436
|
-
eventTime?: Date | null;
|
|
437
|
-
/**
|
|
438
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
439
|
-
* (for example, GDPR).
|
|
440
|
-
*/
|
|
441
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
442
|
-
/** If present, indicates the action that triggered the event. */
|
|
443
|
-
originatedFrom?: string | null;
|
|
497
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
444
498
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
448
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
449
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
450
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
499
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
500
|
+
* @format GUID
|
|
451
501
|
*/
|
|
452
|
-
|
|
453
|
-
}
|
|
454
|
-
/** @oneof */
|
|
455
|
-
export interface DomainEventBodyOneOf {
|
|
456
|
-
createdEvent?: EntityCreatedEvent;
|
|
457
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
458
|
-
deletedEvent?: EntityDeletedEvent;
|
|
459
|
-
actionEvent?: ActionEvent;
|
|
460
|
-
}
|
|
461
|
-
export interface EntityCreatedEvent {
|
|
462
|
-
entity?: string;
|
|
463
|
-
}
|
|
464
|
-
export interface RestoreInfo {
|
|
465
|
-
deletedDate?: Date | null;
|
|
466
|
-
}
|
|
467
|
-
export interface EntityUpdatedEvent {
|
|
502
|
+
metaSiteId?: string;
|
|
468
503
|
/**
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
504
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
505
|
+
* @format GUID
|
|
472
506
|
*/
|
|
473
|
-
currentEntity?: string;
|
|
474
|
-
}
|
|
475
|
-
export interface EntityDeletedEvent {
|
|
476
|
-
/** Entity that was deleted */
|
|
477
|
-
deletedEntity?: string | null;
|
|
478
|
-
}
|
|
479
|
-
export interface ActionEvent {
|
|
480
|
-
body?: string;
|
|
481
|
-
}
|
|
482
|
-
export interface MessageEnvelope {
|
|
483
|
-
/** App instance ID. */
|
|
484
|
-
instanceId?: string | null;
|
|
485
|
-
/** Event type. */
|
|
486
|
-
eventType?: string;
|
|
487
|
-
/** The identification type and identity data. */
|
|
488
|
-
identity?: IdentificationData;
|
|
489
|
-
/** Stringify payload. */
|
|
490
|
-
data?: string;
|
|
491
|
-
}
|
|
492
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
493
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
494
|
-
anonymousVisitorId?: string;
|
|
495
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
496
|
-
memberId?: string;
|
|
497
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
498
|
-
wixUserId?: string;
|
|
499
|
-
/** ID of an app. */
|
|
500
|
-
appId?: string;
|
|
501
|
-
/** @readonly */
|
|
502
|
-
identityType?: WebhookIdentityType;
|
|
503
|
-
}
|
|
504
|
-
/** @oneof */
|
|
505
|
-
export interface IdentificationDataIdOneOf {
|
|
506
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
507
|
-
anonymousVisitorId?: string;
|
|
508
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
509
|
-
memberId?: string;
|
|
510
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
511
|
-
wixUserId?: string;
|
|
512
|
-
/** ID of an app. */
|
|
513
|
-
appId?: string;
|
|
514
|
-
}
|
|
515
|
-
export declare enum WebhookIdentityType {
|
|
516
|
-
UNKNOWN = "UNKNOWN",
|
|
517
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
518
|
-
MEMBER = "MEMBER",
|
|
519
|
-
WIX_USER = "WIX_USER",
|
|
520
|
-
APP = "APP"
|
|
521
|
-
}
|
|
522
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
523
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
524
|
-
metaSiteId?: string;
|
|
525
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
526
507
|
siteId?: string;
|
|
527
508
|
/** Invalidate by App */
|
|
528
509
|
app?: App;
|
|
@@ -532,7 +513,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
532
513
|
uri?: URI;
|
|
533
514
|
/** Invalidate by file (for media files such as PDFs) */
|
|
534
515
|
file?: File;
|
|
535
|
-
/**
|
|
516
|
+
/**
|
|
517
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
518
|
+
* @maxLength 256
|
|
519
|
+
*/
|
|
536
520
|
reason?: string | null;
|
|
537
521
|
/** Is local DS */
|
|
538
522
|
localDc?: boolean;
|
|
@@ -540,9 +524,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
540
524
|
}
|
|
541
525
|
/** @oneof */
|
|
542
526
|
export interface InvalidateCacheGetByOneOf {
|
|
543
|
-
/**
|
|
527
|
+
/**
|
|
528
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
529
|
+
* @format GUID
|
|
530
|
+
*/
|
|
544
531
|
metaSiteId?: string;
|
|
545
|
-
/**
|
|
532
|
+
/**
|
|
533
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
534
|
+
* @format GUID
|
|
535
|
+
*/
|
|
546
536
|
siteId?: string;
|
|
547
537
|
/** Invalidate by App */
|
|
548
538
|
app?: App;
|
|
@@ -554,276 +544,176 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
554
544
|
file?: File;
|
|
555
545
|
}
|
|
556
546
|
export interface App {
|
|
557
|
-
/**
|
|
547
|
+
/**
|
|
548
|
+
* The AppDefId
|
|
549
|
+
* @minLength 1
|
|
550
|
+
*/
|
|
558
551
|
appDefId?: string;
|
|
559
|
-
/**
|
|
552
|
+
/**
|
|
553
|
+
* The instance Id
|
|
554
|
+
* @format GUID
|
|
555
|
+
*/
|
|
560
556
|
instanceId?: string;
|
|
561
557
|
}
|
|
562
558
|
export interface Page {
|
|
563
|
-
/**
|
|
559
|
+
/**
|
|
560
|
+
* the msid the page is on
|
|
561
|
+
* @format GUID
|
|
562
|
+
*/
|
|
564
563
|
metaSiteId?: string;
|
|
565
|
-
/**
|
|
564
|
+
/**
|
|
565
|
+
* Invalidate by Page ID
|
|
566
|
+
* @minLength 1
|
|
567
|
+
*/
|
|
566
568
|
pageId?: string;
|
|
567
569
|
}
|
|
568
570
|
export interface URI {
|
|
569
|
-
/**
|
|
571
|
+
/**
|
|
572
|
+
* the msid the URI is on
|
|
573
|
+
* @format GUID
|
|
574
|
+
*/
|
|
570
575
|
metaSiteId?: string;
|
|
571
|
-
/**
|
|
576
|
+
/**
|
|
577
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
578
|
+
* @minLength 1
|
|
579
|
+
*/
|
|
572
580
|
uriPath?: string;
|
|
573
581
|
}
|
|
574
582
|
export interface File {
|
|
575
|
-
/**
|
|
583
|
+
/**
|
|
584
|
+
* the msid the file is related to
|
|
585
|
+
* @format GUID
|
|
586
|
+
*/
|
|
576
587
|
metaSiteId?: string;
|
|
577
|
-
/**
|
|
588
|
+
/**
|
|
589
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
590
|
+
* @minLength 1
|
|
591
|
+
* @maxLength 256
|
|
592
|
+
*/
|
|
578
593
|
fileName?: string;
|
|
579
594
|
}
|
|
580
|
-
export interface
|
|
581
|
-
/** Ticket definition
|
|
582
|
-
|
|
595
|
+
export interface SalePeriodUpdated {
|
|
596
|
+
/** Ticket definition sale period after update. */
|
|
597
|
+
afterUpdate?: SalePeriod;
|
|
583
598
|
}
|
|
584
|
-
export interface
|
|
585
|
-
/**
|
|
586
|
-
|
|
599
|
+
export interface TicketDefinitionSaleStarted {
|
|
600
|
+
/** Ticket definition. */
|
|
601
|
+
ticketDefinition?: TicketDefinition;
|
|
587
602
|
}
|
|
588
|
-
export interface
|
|
603
|
+
export interface TicketDefinitionSaleEnded {
|
|
604
|
+
/** Ticket definition. */
|
|
605
|
+
ticketDefinition?: TicketDefinition;
|
|
606
|
+
}
|
|
607
|
+
export interface CreateTicketDefinitionRequest {
|
|
608
|
+
/** Ticket definition info. */
|
|
609
|
+
ticketDefinition: TicketDefinition;
|
|
589
610
|
/**
|
|
590
|
-
*
|
|
591
|
-
* @
|
|
611
|
+
* Predefined sets of fields to return.
|
|
612
|
+
* @maxSize 5
|
|
592
613
|
*/
|
|
593
|
-
|
|
614
|
+
fields?: Field[];
|
|
615
|
+
}
|
|
616
|
+
export declare enum Field {
|
|
617
|
+
/** Unknown requested field. */
|
|
618
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
619
|
+
/** Returns `salesDetails` in the response. */
|
|
620
|
+
SALES_DETAILS = "SALES_DETAILS",
|
|
621
|
+
/** Returns `eventDetails` in the response. */
|
|
622
|
+
EVENT_DETAILS = "EVENT_DETAILS"
|
|
623
|
+
}
|
|
624
|
+
export interface CreateTicketDefinitionResponse {
|
|
625
|
+
/** Created ticket definition. */
|
|
626
|
+
ticketDefinition?: TicketDefinition;
|
|
627
|
+
}
|
|
628
|
+
export interface UpdateTicketDefinitionRequest {
|
|
629
|
+
/** Ticket definition to update. */
|
|
630
|
+
ticketDefinition: TicketDefinition;
|
|
594
631
|
/**
|
|
595
|
-
*
|
|
596
|
-
* @
|
|
632
|
+
* Predefined sets of fields to return.
|
|
633
|
+
* @maxSize 5
|
|
597
634
|
*/
|
|
598
|
-
|
|
635
|
+
fields?: Field[];
|
|
636
|
+
}
|
|
637
|
+
export interface UpdateTicketDefinitionResponse {
|
|
638
|
+
/** The updated ticket definition. */
|
|
639
|
+
ticketDefinition?: TicketDefinition;
|
|
640
|
+
}
|
|
641
|
+
export interface GetTicketDefinitionRequest {
|
|
599
642
|
/**
|
|
600
|
-
*
|
|
601
|
-
* @
|
|
643
|
+
* Ticket definition ID.
|
|
644
|
+
* @format GUID
|
|
602
645
|
*/
|
|
603
|
-
|
|
646
|
+
ticketDefinitionId: string;
|
|
604
647
|
/**
|
|
605
|
-
*
|
|
606
|
-
* @
|
|
648
|
+
* Predefined sets of fields to return.
|
|
649
|
+
* @maxSize 5
|
|
607
650
|
*/
|
|
608
|
-
|
|
651
|
+
fields?: Field[];
|
|
652
|
+
}
|
|
653
|
+
export interface GetTicketDefinitionResponse {
|
|
654
|
+
/** The requested ticket definition. */
|
|
655
|
+
ticketDefinition?: TicketDefinition;
|
|
656
|
+
}
|
|
657
|
+
export interface DeleteTicketDefinitionRequest {
|
|
609
658
|
/**
|
|
610
|
-
*
|
|
611
|
-
* @
|
|
659
|
+
* ID of the ticket definition to delete.
|
|
660
|
+
* @format GUID
|
|
612
661
|
*/
|
|
613
|
-
|
|
614
|
-
/**
|
|
615
|
-
* Paid exists.
|
|
616
|
-
* @readonly
|
|
617
|
-
*/
|
|
618
|
-
paidExists?: boolean;
|
|
619
|
-
}
|
|
620
|
-
export interface ListEventTicketingSummaryRequest {
|
|
621
|
-
/** Event ID. */
|
|
622
|
-
eventId?: string[];
|
|
662
|
+
ticketDefinitionId: string;
|
|
623
663
|
}
|
|
624
|
-
export interface
|
|
625
|
-
/** Ticketing summaries. */
|
|
626
|
-
summaries?: EventTicketingSummary[];
|
|
664
|
+
export interface DeleteTicketDefinitionResponse {
|
|
627
665
|
}
|
|
628
|
-
export interface
|
|
629
|
-
/**
|
|
630
|
-
* Event ID to which the ticketing summary belongs.
|
|
631
|
-
* @readonly
|
|
632
|
-
*/
|
|
633
|
-
eventId?: string | null;
|
|
634
|
-
/**
|
|
635
|
-
* Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
636
|
-
* @readonly
|
|
637
|
-
*/
|
|
638
|
-
_updatedDate?: Date | null;
|
|
639
|
-
/**
|
|
640
|
-
* Whether all tickets are sold for this event.
|
|
641
|
-
* @readonly
|
|
642
|
-
*/
|
|
643
|
-
soldOut?: boolean | null;
|
|
644
|
-
/**
|
|
645
|
-
* Price of lowest priced ticket.
|
|
646
|
-
* @readonly
|
|
647
|
-
*/
|
|
648
|
-
lowestTicketPrice?: CommonMoney;
|
|
649
|
-
/**
|
|
650
|
-
* Price of highest priced ticket.
|
|
651
|
-
* @readonly
|
|
652
|
-
*/
|
|
653
|
-
highestTicketPrice?: CommonMoney;
|
|
654
|
-
/**
|
|
655
|
-
* Currency used in event transactions.
|
|
656
|
-
* @readonly
|
|
657
|
-
*/
|
|
658
|
-
currency?: string | null;
|
|
666
|
+
export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
659
667
|
/**
|
|
660
|
-
*
|
|
661
|
-
* @
|
|
668
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
669
|
+
* @format GUID
|
|
662
670
|
*/
|
|
663
|
-
|
|
671
|
+
beforeDefinitionId?: string;
|
|
664
672
|
/**
|
|
665
|
-
*
|
|
666
|
-
* @
|
|
673
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
674
|
+
* @format GUID
|
|
667
675
|
*/
|
|
668
|
-
|
|
669
|
-
}
|
|
670
|
-
export interface Empty {
|
|
671
|
-
}
|
|
672
|
-
export interface ReservationCreated {
|
|
673
|
-
/** Reservation created timestamp in ISO UTC format. */
|
|
674
|
-
timestamp?: Date | null;
|
|
675
|
-
/** Event ID. */
|
|
676
|
-
eventId?: string;
|
|
676
|
+
afterDefinitionId?: string;
|
|
677
677
|
/**
|
|
678
|
-
*
|
|
679
|
-
*
|
|
678
|
+
* Event ID.
|
|
679
|
+
* @format GUID
|
|
680
680
|
*/
|
|
681
|
-
|
|
682
|
-
/** Reservation expiration timestamp. */
|
|
683
|
-
expires?: Date | null;
|
|
684
|
-
/** Reservation status. */
|
|
685
|
-
status?: ReservationStatus;
|
|
686
|
-
/** Reservation ticket quantities. */
|
|
687
|
-
quantities?: TicketQuantity[];
|
|
688
|
-
/** Reservation update timestamp. */
|
|
689
|
-
_updatedDate?: Date | null;
|
|
690
|
-
/** Reservation counts. */
|
|
691
|
-
counts?: ReservationCount[];
|
|
692
|
-
}
|
|
693
|
-
export declare enum ReservationStatus {
|
|
694
|
-
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
695
|
-
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
696
|
-
/** The reservation is confirmed and will not expire. */
|
|
697
|
-
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
698
|
-
/** The reservation is canceled because of non payment. */
|
|
699
|
-
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
700
|
-
/** The reservation is canceled manually by the buyer. */
|
|
701
|
-
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
702
|
-
/** The reservation is expired. */
|
|
703
|
-
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
704
|
-
}
|
|
705
|
-
export interface TicketQuantity {
|
|
706
|
-
/** Ticket definition ID. */
|
|
707
|
-
ticketDefinitionId?: string | null;
|
|
708
|
-
/** Quantity. */
|
|
709
|
-
quantity?: number | null;
|
|
710
|
-
/** Quantity update timestamp. */
|
|
711
|
-
_updatedDate?: Date | null;
|
|
712
|
-
}
|
|
713
|
-
export interface ReservationCount {
|
|
714
|
-
/** Reservation Count snapshot timestamp. */
|
|
715
|
-
timestamp?: Date | null;
|
|
716
|
-
/** Ticket Definition ID. */
|
|
717
|
-
ticketDefinitionId?: string;
|
|
718
|
-
/** Confirmed reservation count. */
|
|
719
|
-
confirmedCount?: number;
|
|
720
|
-
/** Pending reservation count. */
|
|
721
|
-
pendingCount?: number;
|
|
722
|
-
/** True if paid ticket reservation exist. */
|
|
723
|
-
paidExists?: boolean;
|
|
724
|
-
}
|
|
725
|
-
export interface ReservationUpdated {
|
|
726
|
-
/** Reservation updated timestamp. */
|
|
727
|
-
timestamp?: Date | null;
|
|
728
|
-
/** Event ID. */
|
|
729
|
-
eventId?: string;
|
|
681
|
+
eventId: string;
|
|
730
682
|
/**
|
|
731
|
-
*
|
|
732
|
-
*
|
|
683
|
+
* Ticket definition ID.
|
|
684
|
+
* @format GUID
|
|
733
685
|
*/
|
|
734
|
-
reservationId?: string;
|
|
735
|
-
/** Reservation status. */
|
|
736
|
-
status?: ReservationStatus;
|
|
737
|
-
/** Reservation expiration timestamp. */
|
|
738
|
-
expires?: Date | null;
|
|
739
|
-
/** Reservation ticket quantities. */
|
|
740
|
-
quantities?: TicketQuantity[];
|
|
741
|
-
/** Reservation update timestamp. */
|
|
742
|
-
_updatedDate?: Date | null;
|
|
743
|
-
/** Reservation counts. */
|
|
744
|
-
counts?: ReservationCount[];
|
|
745
|
-
}
|
|
746
|
-
export interface EventDeleted {
|
|
747
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
748
|
-
timestamp?: Date | null;
|
|
749
|
-
/** Event ID. */
|
|
750
|
-
eventId?: string;
|
|
751
|
-
/** Event title. */
|
|
752
|
-
title?: string;
|
|
753
|
-
/** Event creator user ID. */
|
|
754
|
-
userId?: string | null;
|
|
755
|
-
}
|
|
756
|
-
export interface CreateTicketDefinitionRequest {
|
|
757
|
-
/** Ticket definition info. */
|
|
758
|
-
ticketDefinition: TicketDefinition;
|
|
759
|
-
/** Predefined sets of fields to return. */
|
|
760
|
-
fields?: Field[];
|
|
761
|
-
}
|
|
762
|
-
export declare enum Field {
|
|
763
|
-
/** Unknown requested field. */
|
|
764
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
765
|
-
/** Returns `salesDetails` in the response. */
|
|
766
|
-
SALES_DETAILS = "SALES_DETAILS",
|
|
767
|
-
/** Returns `eventDetails` in the response. */
|
|
768
|
-
EVENT_DETAILS = "EVENT_DETAILS"
|
|
769
|
-
}
|
|
770
|
-
export interface CreateTicketDefinitionResponse {
|
|
771
|
-
/** Created ticket definition. */
|
|
772
|
-
ticketDefinition?: TicketDefinition;
|
|
773
|
-
}
|
|
774
|
-
export interface UpdateTicketDefinitionRequest {
|
|
775
|
-
/** Ticket definition to update. */
|
|
776
|
-
ticketDefinition: TicketDefinition;
|
|
777
|
-
/** Predefined sets of fields to return. */
|
|
778
|
-
fields?: Field[];
|
|
779
|
-
}
|
|
780
|
-
export interface UpdateTicketDefinitionResponse {
|
|
781
|
-
/** The updated ticket definition. */
|
|
782
|
-
ticketDefinition?: TicketDefinition;
|
|
783
|
-
}
|
|
784
|
-
export interface GetTicketDefinitionRequest {
|
|
785
|
-
/** Ticket definition ID. */
|
|
786
|
-
ticketDefinitionId: string;
|
|
787
|
-
/** Predefined sets of fields to return. */
|
|
788
|
-
fields?: Field[];
|
|
789
|
-
}
|
|
790
|
-
export interface GetTicketDefinitionResponse {
|
|
791
|
-
/** The requested ticket definition. */
|
|
792
|
-
ticketDefinition?: TicketDefinition;
|
|
793
|
-
}
|
|
794
|
-
export interface DeleteTicketDefinitionRequest {
|
|
795
|
-
/** ID of the ticket definition to delete. */
|
|
796
|
-
ticketDefinitionId: string;
|
|
797
|
-
}
|
|
798
|
-
export interface DeleteTicketDefinitionResponse {
|
|
799
|
-
}
|
|
800
|
-
export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
801
|
-
/** Move the given `definitionId` before the referenced ticket definition. */
|
|
802
|
-
beforeDefinitionId?: string;
|
|
803
|
-
/** Move the given `definitionId` after the referenced ticket definition. */
|
|
804
|
-
afterDefinitionId?: string;
|
|
805
|
-
/** Event ID. */
|
|
806
|
-
eventId: string;
|
|
807
|
-
/** Ticket definition ID. */
|
|
808
686
|
ticketDefinitionId: string;
|
|
809
687
|
}
|
|
810
688
|
/** @oneof */
|
|
811
689
|
export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
812
|
-
/**
|
|
690
|
+
/**
|
|
691
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
692
|
+
* @format GUID
|
|
693
|
+
*/
|
|
813
694
|
beforeDefinitionId?: string;
|
|
814
|
-
/**
|
|
695
|
+
/**
|
|
696
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
697
|
+
* @format GUID
|
|
698
|
+
*/
|
|
815
699
|
afterDefinitionId?: string;
|
|
816
700
|
}
|
|
817
701
|
export interface ReorderTicketDefinitionsResponse {
|
|
818
702
|
}
|
|
819
703
|
export interface UpdateTicketDefinitionSortIndexRequest {
|
|
820
|
-
/**
|
|
704
|
+
/**
|
|
705
|
+
* Ticket definition ID
|
|
706
|
+
* @format GUID
|
|
707
|
+
*/
|
|
821
708
|
ticketDefinitionId?: string;
|
|
822
709
|
/** The revision of the ticket definition */
|
|
823
710
|
revision?: string;
|
|
824
711
|
/** the sort index of a ticket definition to set */
|
|
825
712
|
sortIndex?: number;
|
|
826
|
-
/**
|
|
713
|
+
/**
|
|
714
|
+
* Requested fields.
|
|
715
|
+
* @maxSize 5
|
|
716
|
+
*/
|
|
827
717
|
fields?: Field[];
|
|
828
718
|
}
|
|
829
719
|
export interface UpdateTicketDefinitionSortIndexResponse {
|
|
@@ -833,7 +723,10 @@ export interface UpdateTicketDefinitionSortIndexResponse {
|
|
|
833
723
|
export interface QueryTicketDefinitionsRequest {
|
|
834
724
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
835
725
|
query: QueryV2;
|
|
836
|
-
/**
|
|
726
|
+
/**
|
|
727
|
+
* Predefined sets of fields to return.
|
|
728
|
+
* @maxSize 5
|
|
729
|
+
*/
|
|
837
730
|
fields?: Field[];
|
|
838
731
|
}
|
|
839
732
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -843,7 +736,10 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
843
736
|
cursorPaging?: CursorPaging;
|
|
844
737
|
/** 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"} }` */
|
|
845
738
|
filter?: Record<string, any> | null;
|
|
846
|
-
/**
|
|
739
|
+
/**
|
|
740
|
+
* 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.
|
|
741
|
+
* @maxSize 10
|
|
742
|
+
*/
|
|
847
743
|
sort?: Sorting[];
|
|
848
744
|
}
|
|
849
745
|
/** @oneof */
|
|
@@ -854,7 +750,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
854
750
|
cursorPaging?: CursorPaging;
|
|
855
751
|
}
|
|
856
752
|
export interface Sorting {
|
|
857
|
-
/**
|
|
753
|
+
/**
|
|
754
|
+
* Name of the field to sort by.
|
|
755
|
+
* @maxLength 100
|
|
756
|
+
*/
|
|
858
757
|
fieldName?: string;
|
|
859
758
|
/** Defaults to `ASC` */
|
|
860
759
|
order?: SortOrder;
|
|
@@ -870,13 +769,17 @@ export interface Paging {
|
|
|
870
769
|
offset?: number | null;
|
|
871
770
|
}
|
|
872
771
|
export interface CursorPaging {
|
|
873
|
-
/**
|
|
772
|
+
/**
|
|
773
|
+
* Number of items to load per page.
|
|
774
|
+
* @max 100
|
|
775
|
+
*/
|
|
874
776
|
limit?: number | null;
|
|
875
777
|
/**
|
|
876
778
|
* Pointer to the next or previous page in the list of results.
|
|
877
779
|
* You can get the relevant cursor token
|
|
878
780
|
* from the `pagingMetadata` object in the previous call's response.
|
|
879
781
|
* Not relevant for the first request.
|
|
782
|
+
* @maxLength 16000
|
|
880
783
|
*/
|
|
881
784
|
cursor?: string | null;
|
|
882
785
|
}
|
|
@@ -899,15 +802,24 @@ export interface PagingMetadataV2 {
|
|
|
899
802
|
cursors?: Cursors;
|
|
900
803
|
}
|
|
901
804
|
export interface Cursors {
|
|
902
|
-
/**
|
|
805
|
+
/**
|
|
806
|
+
* Cursor pointing to next page in the list of results.
|
|
807
|
+
* @maxLength 36
|
|
808
|
+
*/
|
|
903
809
|
next?: string | null;
|
|
904
|
-
/**
|
|
810
|
+
/**
|
|
811
|
+
* Cursor pointing to previous page in the list of results.
|
|
812
|
+
* @maxLength 36
|
|
813
|
+
*/
|
|
905
814
|
prev?: string | null;
|
|
906
815
|
}
|
|
907
816
|
export interface QueryAvailableTicketDefinitionsRequest {
|
|
908
817
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
909
818
|
query: QueryV2;
|
|
910
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* Predefined sets of fields to return.
|
|
821
|
+
* @maxSize 5
|
|
822
|
+
*/
|
|
911
823
|
fields?: Field[];
|
|
912
824
|
}
|
|
913
825
|
export interface QueryAvailableTicketDefinitionsResponse {
|
|
@@ -923,6 +835,8 @@ export interface CountTicketDefinitionsRequest {
|
|
|
923
835
|
* Parameters to count ticket definitions by.
|
|
924
836
|
*
|
|
925
837
|
* - Max: 20 facets.
|
|
838
|
+
* @maxLength 100
|
|
839
|
+
* @maxSize 20
|
|
926
840
|
*/
|
|
927
841
|
facet?: string[];
|
|
928
842
|
}
|
|
@@ -951,19 +865,35 @@ export interface BulkDeleteTicketDefinitionsByFilterRequest {
|
|
|
951
865
|
export interface BulkDeleteTicketDefinitionsByFilterResponse {
|
|
952
866
|
}
|
|
953
867
|
export interface ChangeCurrencyRequest {
|
|
954
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* Event ID.
|
|
870
|
+
* @format GUID
|
|
871
|
+
*/
|
|
955
872
|
eventId: string;
|
|
956
|
-
/**
|
|
873
|
+
/**
|
|
874
|
+
* Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
875
|
+
* @minLength 3
|
|
876
|
+
* @maxLength 3
|
|
877
|
+
*/
|
|
957
878
|
currency: string;
|
|
958
879
|
}
|
|
959
880
|
export interface ChangeCurrencyResponse {
|
|
960
881
|
}
|
|
961
882
|
export interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
962
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* Origin instance ID.
|
|
885
|
+
* @format GUID
|
|
886
|
+
*/
|
|
963
887
|
originInstanceId?: string | null;
|
|
964
|
-
/**
|
|
888
|
+
/**
|
|
889
|
+
* Origin Event ID.
|
|
890
|
+
* @format GUID
|
|
891
|
+
*/
|
|
965
892
|
originEventId?: string;
|
|
966
|
-
/**
|
|
893
|
+
/**
|
|
894
|
+
* Target Event ID.
|
|
895
|
+
* @format GUID
|
|
896
|
+
*/
|
|
967
897
|
targetEventId?: string;
|
|
968
898
|
}
|
|
969
899
|
export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
@@ -971,9 +901,15 @@ export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
|
971
901
|
definitions?: CopiedTicketDefinition[];
|
|
972
902
|
}
|
|
973
903
|
export interface CopiedTicketDefinition {
|
|
974
|
-
/**
|
|
904
|
+
/**
|
|
905
|
+
* Origin Ticket definition ID.
|
|
906
|
+
* @format GUID
|
|
907
|
+
*/
|
|
975
908
|
originTicketDefinitionId?: string;
|
|
976
|
-
/**
|
|
909
|
+
/**
|
|
910
|
+
* Ticket definition ID.
|
|
911
|
+
* @format GUID
|
|
912
|
+
*/
|
|
977
913
|
ticketDefinitionId?: string;
|
|
978
914
|
}
|
|
979
915
|
export interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
@@ -982,26 +918,56 @@ export interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
|
982
918
|
}
|
|
983
919
|
export interface UpdateFeeTypesBasedOnSettingsResponse {
|
|
984
920
|
}
|
|
921
|
+
export interface EventDeleted {
|
|
922
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
923
|
+
timestamp?: Date | null;
|
|
924
|
+
/**
|
|
925
|
+
* Event ID.
|
|
926
|
+
* @format GUID
|
|
927
|
+
*/
|
|
928
|
+
eventId?: string;
|
|
929
|
+
/** Event title. */
|
|
930
|
+
title?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Event creator user ID.
|
|
933
|
+
* @format GUID
|
|
934
|
+
*/
|
|
935
|
+
userId?: string | null;
|
|
936
|
+
}
|
|
937
|
+
export interface Empty {
|
|
938
|
+
}
|
|
985
939
|
export interface EventCanceled {
|
|
986
940
|
/** Event canceled timestamp in ISO UTC format. */
|
|
987
941
|
timestamp?: Date | null;
|
|
988
|
-
/**
|
|
942
|
+
/**
|
|
943
|
+
* Event ID.
|
|
944
|
+
* @format GUID
|
|
945
|
+
*/
|
|
989
946
|
eventId?: string;
|
|
990
947
|
/** Event title */
|
|
991
948
|
title?: string;
|
|
992
|
-
/**
|
|
949
|
+
/**
|
|
950
|
+
* Event creator user ID.
|
|
951
|
+
* @format GUID
|
|
952
|
+
*/
|
|
993
953
|
userId?: string | null;
|
|
994
954
|
}
|
|
995
955
|
export interface EventEnded {
|
|
996
956
|
/** Event end timestamp in ISO UTC format. */
|
|
997
957
|
timestamp?: Date | null;
|
|
998
|
-
/**
|
|
958
|
+
/**
|
|
959
|
+
* Event ID.
|
|
960
|
+
* @format GUID
|
|
961
|
+
*/
|
|
999
962
|
eventId?: string;
|
|
1000
963
|
}
|
|
1001
964
|
export interface EventCreated {
|
|
1002
965
|
/** Event created timestamp in ISO UTC format. */
|
|
1003
966
|
timestamp?: Date | null;
|
|
1004
|
-
/**
|
|
967
|
+
/**
|
|
968
|
+
* Event ID.
|
|
969
|
+
* @format GUID
|
|
970
|
+
*/
|
|
1005
971
|
eventId?: string;
|
|
1006
972
|
/** Event location. */
|
|
1007
973
|
location?: EventsLocation;
|
|
@@ -1009,23 +975,38 @@ export interface EventCreated {
|
|
|
1009
975
|
scheduleConfig?: ScheduleConfig;
|
|
1010
976
|
/** Event title. */
|
|
1011
977
|
title?: string;
|
|
1012
|
-
/**
|
|
978
|
+
/**
|
|
979
|
+
* Event creator user ID.
|
|
980
|
+
* @maxLength 36
|
|
981
|
+
*/
|
|
1013
982
|
userId?: string | null;
|
|
1014
983
|
/** Event status. */
|
|
1015
984
|
status?: EventStatus;
|
|
1016
|
-
/**
|
|
985
|
+
/**
|
|
986
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
987
|
+
* @format GUID
|
|
988
|
+
*/
|
|
1017
989
|
derivedFromInstanceId?: string | null;
|
|
1018
|
-
/**
|
|
990
|
+
/**
|
|
991
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
992
|
+
* @format GUID
|
|
993
|
+
*/
|
|
1019
994
|
derivedFromEventId?: string | null;
|
|
1020
995
|
/** Event that was created. */
|
|
1021
996
|
event?: Event;
|
|
1022
997
|
}
|
|
1023
998
|
export interface EventsLocation {
|
|
1024
|
-
/**
|
|
999
|
+
/**
|
|
1000
|
+
* Location name.
|
|
1001
|
+
* @maxLength 50
|
|
1002
|
+
*/
|
|
1025
1003
|
name?: string | null;
|
|
1026
1004
|
/** Location map coordinates. */
|
|
1027
1005
|
coordinates?: MapCoordinates;
|
|
1028
|
-
/**
|
|
1006
|
+
/**
|
|
1007
|
+
* Single line address representation.
|
|
1008
|
+
* @maxLength 300
|
|
1009
|
+
*/
|
|
1029
1010
|
address?: string | null;
|
|
1030
1011
|
/** Location type. */
|
|
1031
1012
|
type?: LocationLocationType;
|
|
@@ -1047,9 +1028,17 @@ export interface EventsLocation {
|
|
|
1047
1028
|
tbd?: boolean | null;
|
|
1048
1029
|
}
|
|
1049
1030
|
export interface MapCoordinates {
|
|
1050
|
-
/**
|
|
1031
|
+
/**
|
|
1032
|
+
* Latitude.
|
|
1033
|
+
* @min -90
|
|
1034
|
+
* @max 90
|
|
1035
|
+
*/
|
|
1051
1036
|
lat?: number;
|
|
1052
|
-
/**
|
|
1037
|
+
/**
|
|
1038
|
+
* Longitude.
|
|
1039
|
+
* @min -180
|
|
1040
|
+
* @max 180
|
|
1041
|
+
*/
|
|
1053
1042
|
lng?: number;
|
|
1054
1043
|
}
|
|
1055
1044
|
export declare enum LocationLocationType {
|
|
@@ -1062,7 +1051,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
1062
1051
|
streetAddress?: StreetAddress;
|
|
1063
1052
|
/** Main address line (usually street and number) as free text */
|
|
1064
1053
|
addressLine1?: string | null;
|
|
1065
|
-
/**
|
|
1054
|
+
/**
|
|
1055
|
+
* country code
|
|
1056
|
+
* @format COUNTRY
|
|
1057
|
+
*/
|
|
1066
1058
|
country?: string | null;
|
|
1067
1059
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1068
1060
|
subdivision?: string | null;
|
|
@@ -1078,7 +1070,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
1078
1070
|
location?: AddressLocation;
|
|
1079
1071
|
/** country full-name */
|
|
1080
1072
|
countryFullname?: string | null;
|
|
1081
|
-
/**
|
|
1073
|
+
/**
|
|
1074
|
+
* multi-level subdivisions from top to bottom
|
|
1075
|
+
* @maxSize 6
|
|
1076
|
+
*/
|
|
1082
1077
|
subdivisions?: Subdivision[];
|
|
1083
1078
|
}
|
|
1084
1079
|
/** @oneof */
|
|
@@ -1095,9 +1090,17 @@ export interface StreetAddress {
|
|
|
1095
1090
|
name?: string;
|
|
1096
1091
|
}
|
|
1097
1092
|
export interface AddressLocation {
|
|
1098
|
-
/**
|
|
1093
|
+
/**
|
|
1094
|
+
* address latitude coordinates
|
|
1095
|
+
* @min -90
|
|
1096
|
+
* @max 90
|
|
1097
|
+
*/
|
|
1099
1098
|
latitude?: number | null;
|
|
1100
|
-
/**
|
|
1099
|
+
/**
|
|
1100
|
+
* address longitude coordinates
|
|
1101
|
+
* @min -180
|
|
1102
|
+
* @max 180
|
|
1103
|
+
*/
|
|
1101
1104
|
longitude?: number | null;
|
|
1102
1105
|
}
|
|
1103
1106
|
export interface Subdivision {
|
|
@@ -1128,13 +1131,19 @@ export interface ScheduleConfig {
|
|
|
1128
1131
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1129
1132
|
*/
|
|
1130
1133
|
scheduleTbd?: boolean;
|
|
1131
|
-
/**
|
|
1134
|
+
/**
|
|
1135
|
+
* TBD message.
|
|
1136
|
+
* @maxLength 100
|
|
1137
|
+
*/
|
|
1132
1138
|
scheduleTbdMessage?: string | null;
|
|
1133
1139
|
/** Event start timestamp. */
|
|
1134
1140
|
startDate?: Date | null;
|
|
1135
1141
|
/** Event end timestamp. */
|
|
1136
1142
|
endDate?: Date | null;
|
|
1137
|
-
/**
|
|
1143
|
+
/**
|
|
1144
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1145
|
+
* @maxLength 100
|
|
1146
|
+
*/
|
|
1138
1147
|
timeZoneId?: string | null;
|
|
1139
1148
|
/** Whether end date is hidden in the formatted schedule. */
|
|
1140
1149
|
endDateHidden?: boolean;
|
|
@@ -1144,7 +1153,10 @@ export interface ScheduleConfig {
|
|
|
1144
1153
|
recurrences?: EventsRecurrences;
|
|
1145
1154
|
}
|
|
1146
1155
|
export interface EventsRecurrences {
|
|
1147
|
-
/**
|
|
1156
|
+
/**
|
|
1157
|
+
* Event occurrences.
|
|
1158
|
+
* @maxSize 1000
|
|
1159
|
+
*/
|
|
1148
1160
|
occurrences?: EventsOccurrence[];
|
|
1149
1161
|
/**
|
|
1150
1162
|
* Recurring event category ID.
|
|
@@ -1162,7 +1174,10 @@ export interface EventsOccurrence {
|
|
|
1162
1174
|
startDate?: Date | null;
|
|
1163
1175
|
/** Event end timestamp. */
|
|
1164
1176
|
endDate?: Date | null;
|
|
1165
|
-
/**
|
|
1177
|
+
/**
|
|
1178
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1179
|
+
* @maxLength 100
|
|
1180
|
+
*/
|
|
1166
1181
|
timeZoneId?: string | null;
|
|
1167
1182
|
/** Whether time zone is displayed in formatted schedule. */
|
|
1168
1183
|
showTimeZone?: boolean;
|
|
@@ -1192,6 +1207,7 @@ export declare enum EventStatus {
|
|
|
1192
1207
|
export interface Event {
|
|
1193
1208
|
/**
|
|
1194
1209
|
* Event ID.
|
|
1210
|
+
* @format GUID
|
|
1195
1211
|
* @readonly
|
|
1196
1212
|
*/
|
|
1197
1213
|
_id?: string;
|
|
@@ -1231,7 +1247,10 @@ export interface Event {
|
|
|
1231
1247
|
instanceId?: string;
|
|
1232
1248
|
/** Guest list configuration. */
|
|
1233
1249
|
guestListConfig?: GuestListConfig;
|
|
1234
|
-
/**
|
|
1250
|
+
/**
|
|
1251
|
+
* Event creator user ID.
|
|
1252
|
+
* @maxLength 36
|
|
1253
|
+
*/
|
|
1235
1254
|
userId?: string;
|
|
1236
1255
|
/** Event discussion feed. For internal use. */
|
|
1237
1256
|
feed?: Feed;
|
|
@@ -1386,17 +1405,31 @@ export interface TicketingConfig {
|
|
|
1386
1405
|
guestAssignedTickets?: boolean;
|
|
1387
1406
|
/** Tax configuration. */
|
|
1388
1407
|
taxConfig?: TaxConfig;
|
|
1389
|
-
/**
|
|
1408
|
+
/**
|
|
1409
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
1410
|
+
* @max 50
|
|
1411
|
+
*/
|
|
1390
1412
|
ticketLimitPerOrder?: number;
|
|
1391
|
-
/**
|
|
1413
|
+
/**
|
|
1414
|
+
* Duration for which the tickets being bought are reserved.
|
|
1415
|
+
* @min 5
|
|
1416
|
+
* @max 30
|
|
1417
|
+
*/
|
|
1392
1418
|
reservationDurationInMinutes?: number | null;
|
|
1393
1419
|
}
|
|
1394
1420
|
export interface TaxConfig {
|
|
1395
1421
|
/** Tax application settings. */
|
|
1396
1422
|
type?: TaxType;
|
|
1397
|
-
/**
|
|
1423
|
+
/**
|
|
1424
|
+
* Tax name.
|
|
1425
|
+
* @minLength 1
|
|
1426
|
+
* @maxLength 10
|
|
1427
|
+
*/
|
|
1398
1428
|
name?: string | null;
|
|
1399
|
-
/**
|
|
1429
|
+
/**
|
|
1430
|
+
* Tax rate (e.g.,`21.55`).
|
|
1431
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
1432
|
+
*/
|
|
1400
1433
|
rate?: string | null;
|
|
1401
1434
|
/** Applies taxes for donations, default true. */
|
|
1402
1435
|
appliesToDonations?: boolean | null;
|
|
@@ -1412,12 +1445,19 @@ export declare enum TaxType {
|
|
|
1412
1445
|
export interface Money {
|
|
1413
1446
|
/**
|
|
1414
1447
|
* *Deprecated:** Use `value` instead.
|
|
1448
|
+
* @format DECIMAL_VALUE
|
|
1415
1449
|
* @deprecated
|
|
1416
1450
|
*/
|
|
1417
1451
|
amount?: string;
|
|
1418
|
-
/**
|
|
1452
|
+
/**
|
|
1453
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
1454
|
+
* @format CURRENCY
|
|
1455
|
+
*/
|
|
1419
1456
|
currency?: string;
|
|
1420
|
-
/**
|
|
1457
|
+
/**
|
|
1458
|
+
* 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.
|
|
1459
|
+
* @format DECIMAL_VALUE
|
|
1460
|
+
*/
|
|
1421
1461
|
value?: string | null;
|
|
1422
1462
|
}
|
|
1423
1463
|
export interface ExternalEvent {
|
|
@@ -1572,21 +1612,29 @@ export declare enum ValueType {
|
|
|
1572
1612
|
* Defaults to first (0th) option if not configured.
|
|
1573
1613
|
*/
|
|
1574
1614
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1575
|
-
/**
|
|
1615
|
+
/**
|
|
1616
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
1617
|
+
* @max 199
|
|
1618
|
+
*/
|
|
1576
1619
|
optionIndex?: number;
|
|
1577
1620
|
/**
|
|
1578
1621
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
1579
1622
|
* Considered an empty choice.
|
|
1623
|
+
* @maxLength 200
|
|
1580
1624
|
*/
|
|
1581
1625
|
placeholderText?: string;
|
|
1582
1626
|
}
|
|
1583
1627
|
/** @oneof */
|
|
1584
1628
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
1585
|
-
/**
|
|
1629
|
+
/**
|
|
1630
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
1631
|
+
* @max 199
|
|
1632
|
+
*/
|
|
1586
1633
|
optionIndex?: number;
|
|
1587
1634
|
/**
|
|
1588
1635
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
1589
1636
|
* Considered an empty choice.
|
|
1637
|
+
* @maxLength 200
|
|
1590
1638
|
*/
|
|
1591
1639
|
placeholderText?: string;
|
|
1592
1640
|
}
|
|
@@ -1741,7 +1789,10 @@ export interface OnlineConferencingConfig {
|
|
|
1741
1789
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1742
1790
|
*/
|
|
1743
1791
|
enabled?: boolean;
|
|
1744
|
-
/**
|
|
1792
|
+
/**
|
|
1793
|
+
* Conferencing provider ID.
|
|
1794
|
+
* @format GUID
|
|
1795
|
+
*/
|
|
1745
1796
|
providerId?: string | null;
|
|
1746
1797
|
/** Conference type */
|
|
1747
1798
|
conferenceType?: ConferenceType;
|
|
@@ -1780,7 +1831,10 @@ export interface OnlineConferencingSession {
|
|
|
1780
1831
|
sessionId?: string | null;
|
|
1781
1832
|
}
|
|
1782
1833
|
export interface SeoSettings {
|
|
1783
|
-
/**
|
|
1834
|
+
/**
|
|
1835
|
+
* URL slug
|
|
1836
|
+
* @maxLength 130
|
|
1837
|
+
*/
|
|
1784
1838
|
slug?: string;
|
|
1785
1839
|
/** Advanced SEO data */
|
|
1786
1840
|
advancedSeoData?: SeoSchema;
|
|
@@ -1806,7 +1860,10 @@ export interface Keyword {
|
|
|
1806
1860
|
term?: string;
|
|
1807
1861
|
/** Whether the keyword is the main focus keyword. */
|
|
1808
1862
|
isMain?: boolean;
|
|
1809
|
-
/**
|
|
1863
|
+
/**
|
|
1864
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1865
|
+
* @maxLength 1000
|
|
1866
|
+
*/
|
|
1810
1867
|
origin?: string | null;
|
|
1811
1868
|
}
|
|
1812
1869
|
export interface Tag {
|
|
@@ -1839,7 +1896,10 @@ export interface Settings {
|
|
|
1839
1896
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1840
1897
|
*/
|
|
1841
1898
|
preventAutoRedirect?: boolean;
|
|
1842
|
-
/**
|
|
1899
|
+
/**
|
|
1900
|
+
* User-selected keyword terms for a specific page.
|
|
1901
|
+
* @maxSize 5
|
|
1902
|
+
*/
|
|
1843
1903
|
keywords?: Keyword[];
|
|
1844
1904
|
}
|
|
1845
1905
|
export interface Agenda {
|
|
@@ -1854,10 +1914,15 @@ export interface Agenda {
|
|
|
1854
1914
|
export interface Category {
|
|
1855
1915
|
/**
|
|
1856
1916
|
* Category ID.
|
|
1917
|
+
* @format GUID
|
|
1857
1918
|
* @readonly
|
|
1858
1919
|
*/
|
|
1859
1920
|
_id?: string;
|
|
1860
|
-
/**
|
|
1921
|
+
/**
|
|
1922
|
+
* Category name.
|
|
1923
|
+
* @minLength 1
|
|
1924
|
+
* @maxLength 30
|
|
1925
|
+
*/
|
|
1861
1926
|
name?: string;
|
|
1862
1927
|
/**
|
|
1863
1928
|
* Date and time when category was created.
|
|
@@ -1880,6 +1945,7 @@ export interface Category {
|
|
|
1880
1945
|
* Default: `MANUAL`.
|
|
1881
1946
|
*
|
|
1882
1947
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1948
|
+
* @maxSize 3
|
|
1883
1949
|
*/
|
|
1884
1950
|
states?: CategoryStateState[];
|
|
1885
1951
|
}
|
|
@@ -2505,11 +2571,20 @@ export interface GIFData {
|
|
|
2505
2571
|
gifType?: GIFType;
|
|
2506
2572
|
}
|
|
2507
2573
|
export interface GIF {
|
|
2508
|
-
/**
|
|
2574
|
+
/**
|
|
2575
|
+
* GIF format URL.
|
|
2576
|
+
* @format WEB_URL
|
|
2577
|
+
*/
|
|
2509
2578
|
gif?: string | null;
|
|
2510
|
-
/**
|
|
2579
|
+
/**
|
|
2580
|
+
* MP4 format URL.
|
|
2581
|
+
* @format WEB_URL
|
|
2582
|
+
*/
|
|
2511
2583
|
mp4?: string | null;
|
|
2512
|
-
/**
|
|
2584
|
+
/**
|
|
2585
|
+
* Thumbnail URL.
|
|
2586
|
+
* @format WEB_URL
|
|
2587
|
+
*/
|
|
2513
2588
|
still?: string | null;
|
|
2514
2589
|
}
|
|
2515
2590
|
export declare enum GIFType {
|
|
@@ -2737,13 +2812,22 @@ export declare enum BackgroundType {
|
|
|
2737
2812
|
export interface Gradient {
|
|
2738
2813
|
/** The gradient angle in degrees. */
|
|
2739
2814
|
angle?: number | null;
|
|
2740
|
-
/**
|
|
2815
|
+
/**
|
|
2816
|
+
* The start color as a hexademical value.
|
|
2817
|
+
* @format COLOR_HEX
|
|
2818
|
+
*/
|
|
2741
2819
|
startColor?: string | null;
|
|
2742
|
-
/**
|
|
2820
|
+
/**
|
|
2821
|
+
* The end color as a hexademical value.
|
|
2822
|
+
* @format COLOR_HEX
|
|
2823
|
+
*/
|
|
2743
2824
|
lastColor?: string | null;
|
|
2744
2825
|
}
|
|
2745
2826
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
2746
|
-
/**
|
|
2827
|
+
/**
|
|
2828
|
+
* The background color as a hexademical value.
|
|
2829
|
+
* @format COLOR_HEX
|
|
2830
|
+
*/
|
|
2747
2831
|
color?: string | null;
|
|
2748
2832
|
/** An image to use for the background. */
|
|
2749
2833
|
image?: Media;
|
|
@@ -2754,7 +2838,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2754
2838
|
}
|
|
2755
2839
|
/** @oneof */
|
|
2756
2840
|
export interface BackgroundBackgroundOneOf {
|
|
2757
|
-
/**
|
|
2841
|
+
/**
|
|
2842
|
+
* The background color as a hexademical value.
|
|
2843
|
+
* @format COLOR_HEX
|
|
2844
|
+
*/
|
|
2758
2845
|
color?: string | null;
|
|
2759
2846
|
/** An image to use for the background. */
|
|
2760
2847
|
image?: Media;
|
|
@@ -3066,17 +3153,32 @@ export declare enum VerticalAlignment {
|
|
|
3066
3153
|
export interface CellStyle {
|
|
3067
3154
|
/** Vertical alignment for the cell's text. */
|
|
3068
3155
|
verticalAlignment?: VerticalAlignment;
|
|
3069
|
-
/**
|
|
3156
|
+
/**
|
|
3157
|
+
* Cell background color as a hexadecimal value.
|
|
3158
|
+
* @format COLOR_HEX
|
|
3159
|
+
*/
|
|
3070
3160
|
backgroundColor?: string | null;
|
|
3071
3161
|
}
|
|
3072
3162
|
export interface BorderColors {
|
|
3073
|
-
/**
|
|
3163
|
+
/**
|
|
3164
|
+
* Left border color as a hexadecimal value.
|
|
3165
|
+
* @format COLOR_HEX
|
|
3166
|
+
*/
|
|
3074
3167
|
left?: string | null;
|
|
3075
|
-
/**
|
|
3168
|
+
/**
|
|
3169
|
+
* Right border color as a hexadecimal value.
|
|
3170
|
+
* @format COLOR_HEX
|
|
3171
|
+
*/
|
|
3076
3172
|
right?: string | null;
|
|
3077
|
-
/**
|
|
3173
|
+
/**
|
|
3174
|
+
* Top border color as a hexadecimal value.
|
|
3175
|
+
* @format COLOR_HEX
|
|
3176
|
+
*/
|
|
3078
3177
|
top?: string | null;
|
|
3079
|
-
/**
|
|
3178
|
+
/**
|
|
3179
|
+
* Bottom border color as a hexadecimal value.
|
|
3180
|
+
* @format COLOR_HEX
|
|
3181
|
+
*/
|
|
3080
3182
|
bottom?: string | null;
|
|
3081
3183
|
}
|
|
3082
3184
|
/**
|
|
@@ -3187,7 +3289,10 @@ export interface TextNodeStyle {
|
|
|
3187
3289
|
export interface EventUpdated {
|
|
3188
3290
|
/** Event update timestamp in ISO UTC format. */
|
|
3189
3291
|
timestamp?: Date | null;
|
|
3190
|
-
/**
|
|
3292
|
+
/**
|
|
3293
|
+
* Event ID.
|
|
3294
|
+
* @format GUID
|
|
3295
|
+
*/
|
|
3191
3296
|
eventId?: string;
|
|
3192
3297
|
/** Event location. */
|
|
3193
3298
|
location?: EventsLocation;
|
|
@@ -3204,11 +3309,17 @@ export interface EventUpdated {
|
|
|
3204
3309
|
event?: Event;
|
|
3205
3310
|
}
|
|
3206
3311
|
export interface SeatingPlanCategoriesSummaryUpdated {
|
|
3207
|
-
/**
|
|
3312
|
+
/**
|
|
3313
|
+
* Seating plan id
|
|
3314
|
+
* @format GUID
|
|
3315
|
+
*/
|
|
3208
3316
|
seatingPlanId?: string;
|
|
3209
3317
|
/** External seating plan id */
|
|
3210
3318
|
externalSeatingPlanId?: string | null;
|
|
3211
|
-
/**
|
|
3319
|
+
/**
|
|
3320
|
+
* Ticket counts by category
|
|
3321
|
+
* @maxSize 100
|
|
3322
|
+
*/
|
|
3212
3323
|
categories?: CategoryDetails[];
|
|
3213
3324
|
/**
|
|
3214
3325
|
* Summary revision.
|
|
@@ -3219,16 +3330,21 @@ export interface SeatingPlanCategoriesSummaryUpdated {
|
|
|
3219
3330
|
export interface CategoryDetails {
|
|
3220
3331
|
/**
|
|
3221
3332
|
* Seating plan id
|
|
3333
|
+
* @format GUID
|
|
3222
3334
|
* @readonly
|
|
3223
3335
|
*/
|
|
3224
3336
|
seatingPlanId?: string | null;
|
|
3225
3337
|
/**
|
|
3226
3338
|
* External seating plan id
|
|
3339
|
+
* @minLength 1
|
|
3340
|
+
* @maxLength 100
|
|
3227
3341
|
* @readonly
|
|
3228
3342
|
*/
|
|
3229
3343
|
externalSeatingPlanId?: string | null;
|
|
3230
3344
|
/**
|
|
3231
3345
|
* External category id
|
|
3346
|
+
* @minLength 1
|
|
3347
|
+
* @maxLength 100
|
|
3232
3348
|
* @readonly
|
|
3233
3349
|
*/
|
|
3234
3350
|
externalCategoryId?: string | null;
|
|
@@ -3243,6 +3359,76 @@ export interface CategoryDetails {
|
|
|
3243
3359
|
*/
|
|
3244
3360
|
reserved?: number | null;
|
|
3245
3361
|
}
|
|
3362
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3363
|
+
createdEvent?: EntityCreatedEvent;
|
|
3364
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3365
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3366
|
+
actionEvent?: ActionEvent;
|
|
3367
|
+
/**
|
|
3368
|
+
* Unique event ID.
|
|
3369
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3370
|
+
*/
|
|
3371
|
+
_id?: string;
|
|
3372
|
+
/**
|
|
3373
|
+
* Assumes actions are also always typed to an entity_type
|
|
3374
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3375
|
+
*/
|
|
3376
|
+
entityFqdn?: string;
|
|
3377
|
+
/**
|
|
3378
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3379
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3380
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3381
|
+
*/
|
|
3382
|
+
slug?: string;
|
|
3383
|
+
/** ID of the entity associated with the event. */
|
|
3384
|
+
entityId?: string;
|
|
3385
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3386
|
+
eventTime?: Date | null;
|
|
3387
|
+
/**
|
|
3388
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3389
|
+
* (for example, GDPR).
|
|
3390
|
+
*/
|
|
3391
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3392
|
+
/** If present, indicates the action that triggered the event. */
|
|
3393
|
+
originatedFrom?: string | null;
|
|
3394
|
+
/**
|
|
3395
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3396
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3397
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3398
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3399
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3400
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3401
|
+
*/
|
|
3402
|
+
entityEventSequence?: string | null;
|
|
3403
|
+
}
|
|
3404
|
+
/** @oneof */
|
|
3405
|
+
export interface DomainEventBodyOneOf {
|
|
3406
|
+
createdEvent?: EntityCreatedEvent;
|
|
3407
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3408
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3409
|
+
actionEvent?: ActionEvent;
|
|
3410
|
+
}
|
|
3411
|
+
export interface EntityCreatedEvent {
|
|
3412
|
+
entity?: string;
|
|
3413
|
+
}
|
|
3414
|
+
export interface RestoreInfo {
|
|
3415
|
+
deletedDate?: Date | null;
|
|
3416
|
+
}
|
|
3417
|
+
export interface EntityUpdatedEvent {
|
|
3418
|
+
/**
|
|
3419
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3420
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3421
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3422
|
+
*/
|
|
3423
|
+
currentEntity?: string;
|
|
3424
|
+
}
|
|
3425
|
+
export interface EntityDeletedEvent {
|
|
3426
|
+
/** Entity that was deleted */
|
|
3427
|
+
deletedEntity?: string | null;
|
|
3428
|
+
}
|
|
3429
|
+
export interface ActionEvent {
|
|
3430
|
+
body?: string;
|
|
3431
|
+
}
|
|
3246
3432
|
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
3247
3433
|
/** Emitted on a meta site creation. */
|
|
3248
3434
|
siteCreated?: SiteCreated;
|
|
@@ -3274,7 +3460,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3274
3460
|
studioAssigned?: StudioAssigned;
|
|
3275
3461
|
/** Emitted when Studio is detached. */
|
|
3276
3462
|
studioUnassigned?: StudioUnassigned;
|
|
3277
|
-
/**
|
|
3463
|
+
/**
|
|
3464
|
+
* A meta site id.
|
|
3465
|
+
* @format GUID
|
|
3466
|
+
*/
|
|
3278
3467
|
metaSiteId?: string;
|
|
3279
3468
|
/** A meta site version. Monotonically increasing. */
|
|
3280
3469
|
version?: string;
|
|
@@ -3283,6 +3472,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3283
3472
|
/**
|
|
3284
3473
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
3285
3474
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
3475
|
+
* @maxSize 4000
|
|
3286
3476
|
*/
|
|
3287
3477
|
assets?: Asset[];
|
|
3288
3478
|
}
|
|
@@ -3320,9 +3510,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
3320
3510
|
studioUnassigned?: StudioUnassigned;
|
|
3321
3511
|
}
|
|
3322
3512
|
export interface Asset {
|
|
3323
|
-
/**
|
|
3513
|
+
/**
|
|
3514
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
3515
|
+
* @maxLength 36
|
|
3516
|
+
*/
|
|
3324
3517
|
appDefId?: string;
|
|
3325
|
-
/**
|
|
3518
|
+
/**
|
|
3519
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
3520
|
+
* @maxLength 200
|
|
3521
|
+
*/
|
|
3326
3522
|
instanceId?: string;
|
|
3327
3523
|
/** An application state. */
|
|
3328
3524
|
state?: State;
|
|
@@ -3335,9 +3531,15 @@ export declare enum State {
|
|
|
3335
3531
|
DEMO = "DEMO"
|
|
3336
3532
|
}
|
|
3337
3533
|
export interface SiteCreated {
|
|
3338
|
-
/**
|
|
3534
|
+
/**
|
|
3535
|
+
* A template identifier (empty if not created from a template).
|
|
3536
|
+
* @maxLength 36
|
|
3537
|
+
*/
|
|
3339
3538
|
originTemplateId?: string;
|
|
3340
|
-
/**
|
|
3539
|
+
/**
|
|
3540
|
+
* An account id of the owner.
|
|
3541
|
+
* @format GUID
|
|
3542
|
+
*/
|
|
3341
3543
|
ownerId?: string;
|
|
3342
3544
|
/** A context in which meta site was created. */
|
|
3343
3545
|
context?: SiteCreatedContext;
|
|
@@ -3346,9 +3548,13 @@ export interface SiteCreated {
|
|
|
3346
3548
|
*
|
|
3347
3549
|
* In case of a creation from a template it's a template id.
|
|
3348
3550
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
3551
|
+
* @format GUID
|
|
3349
3552
|
*/
|
|
3350
3553
|
originMetaSiteId?: string | null;
|
|
3351
|
-
/**
|
|
3554
|
+
/**
|
|
3555
|
+
* A meta site name (URL slug).
|
|
3556
|
+
* @maxLength 20
|
|
3557
|
+
*/
|
|
3352
3558
|
siteName?: string;
|
|
3353
3559
|
/** A namespace. */
|
|
3354
3560
|
namespace?: Namespace;
|
|
@@ -3398,169 +3604,499 @@ export declare enum Namespace {
|
|
|
3398
3604
|
*
|
|
3399
3605
|
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
3400
3606
|
*/
|
|
3401
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
3607
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
3608
|
+
/**
|
|
3609
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
3610
|
+
* Will be accessible from Site List and will not have a website app.
|
|
3611
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
3612
|
+
*/
|
|
3613
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
3614
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
3615
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
3616
|
+
/** It is to be used in the Business First efforts. */
|
|
3617
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
3618
|
+
/** Bookings business flow with no site. */
|
|
3619
|
+
ANYWHERE = "ANYWHERE",
|
|
3620
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
3621
|
+
HEADLESS = "HEADLESS",
|
|
3622
|
+
/**
|
|
3623
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
3624
|
+
* The site will be used for account level CSM feature for enterprise
|
|
3625
|
+
*/
|
|
3626
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
3627
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
3628
|
+
RISE = "RISE",
|
|
3629
|
+
/**
|
|
3630
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
3631
|
+
* There's a blank site behind the scene but it's blank).
|
|
3632
|
+
* The Mobile company will be the owner of this namespace.
|
|
3633
|
+
*/
|
|
3634
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
3635
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
3636
|
+
NOWNIA = "NOWNIA",
|
|
3637
|
+
/**
|
|
3638
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
3639
|
+
* The Partners company owns this namespace.
|
|
3640
|
+
*/
|
|
3641
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
3642
|
+
/** Codux Headless Sites */
|
|
3643
|
+
CODUX = "CODUX",
|
|
3644
|
+
/** Bobb - AI Design Creator. */
|
|
3645
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
3646
|
+
/**
|
|
3647
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
3648
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
3649
|
+
*/
|
|
3650
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
|
|
3651
|
+
}
|
|
3652
|
+
/** Site transferred to another user. */
|
|
3653
|
+
export interface SiteTransferred {
|
|
3654
|
+
/**
|
|
3655
|
+
* A previous owner id (user that transfers meta site).
|
|
3656
|
+
* @format GUID
|
|
3657
|
+
*/
|
|
3658
|
+
oldOwnerId?: string;
|
|
3659
|
+
/**
|
|
3660
|
+
* A new owner id (user that accepts meta site).
|
|
3661
|
+
* @format GUID
|
|
3662
|
+
*/
|
|
3663
|
+
newOwnerId?: string;
|
|
3664
|
+
}
|
|
3665
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
3666
|
+
export interface SiteDeleted {
|
|
3667
|
+
/** A deletion context. */
|
|
3668
|
+
deleteContext?: DeleteContext;
|
|
3669
|
+
}
|
|
3670
|
+
export interface DeleteContext {
|
|
3671
|
+
/** When the meta site was deleted. */
|
|
3672
|
+
dateDeleted?: Date | null;
|
|
3673
|
+
/** A status. */
|
|
3674
|
+
deleteStatus?: DeleteStatus;
|
|
3675
|
+
/**
|
|
3676
|
+
* A reason (flow).
|
|
3677
|
+
* @maxLength 255
|
|
3678
|
+
*/
|
|
3679
|
+
deleteOrigin?: string;
|
|
3680
|
+
/**
|
|
3681
|
+
* A service that deleted it.
|
|
3682
|
+
* @maxLength 255
|
|
3683
|
+
*/
|
|
3684
|
+
initiatorId?: string | null;
|
|
3685
|
+
}
|
|
3686
|
+
export declare enum DeleteStatus {
|
|
3687
|
+
UNKNOWN = "UNKNOWN",
|
|
3688
|
+
TRASH = "TRASH",
|
|
3689
|
+
DELETED = "DELETED",
|
|
3690
|
+
PENDING_PURGE = "PENDING_PURGE"
|
|
3691
|
+
}
|
|
3692
|
+
/** Restoration of the meta site. */
|
|
3693
|
+
export interface SiteUndeleted {
|
|
3694
|
+
}
|
|
3695
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
3696
|
+
export interface SitePublished {
|
|
3697
|
+
}
|
|
3698
|
+
export interface SiteUnpublished {
|
|
3699
|
+
/**
|
|
3700
|
+
* A list of URLs previously associated with the meta site.
|
|
3701
|
+
* @maxLength 4000
|
|
3702
|
+
* @maxSize 10000
|
|
3703
|
+
*/
|
|
3704
|
+
urls?: string[];
|
|
3705
|
+
}
|
|
3706
|
+
export interface SiteMarkedAsTemplate {
|
|
3707
|
+
}
|
|
3708
|
+
export interface SiteMarkedAsWixSite {
|
|
3709
|
+
}
|
|
3710
|
+
/**
|
|
3711
|
+
* Represents a service provisioned a site.
|
|
3712
|
+
*
|
|
3713
|
+
* Note on `origin_instance_id`:
|
|
3714
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
3715
|
+
* This is because of the following scenario:
|
|
3716
|
+
*
|
|
3717
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
3718
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
3719
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
3720
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
3721
|
+
* your site remains consistent with what you initially received and does not include any
|
|
3722
|
+
* changes made to the original template afterward.
|
|
3723
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
3724
|
+
*/
|
|
3725
|
+
export interface ServiceProvisioned {
|
|
3726
|
+
/**
|
|
3727
|
+
* Either UUID or EmbeddedServiceType.
|
|
3728
|
+
* @maxLength 36
|
|
3729
|
+
*/
|
|
3730
|
+
appDefId?: string;
|
|
3731
|
+
/**
|
|
3732
|
+
* Not only UUID. Something here could be something weird.
|
|
3733
|
+
* @maxLength 36
|
|
3734
|
+
*/
|
|
3735
|
+
instanceId?: string;
|
|
3736
|
+
/**
|
|
3737
|
+
* An instance id from which this instance is originated.
|
|
3738
|
+
* @maxLength 36
|
|
3739
|
+
*/
|
|
3740
|
+
originInstanceId?: string;
|
|
3741
|
+
/**
|
|
3742
|
+
* A version.
|
|
3743
|
+
* @maxLength 500
|
|
3744
|
+
*/
|
|
3745
|
+
version?: string | null;
|
|
3746
|
+
/**
|
|
3747
|
+
* The origin meta site id
|
|
3748
|
+
* @format GUID
|
|
3749
|
+
*/
|
|
3750
|
+
originMetaSiteId?: string | null;
|
|
3751
|
+
}
|
|
3752
|
+
export interface ServiceRemoved {
|
|
3753
|
+
/**
|
|
3754
|
+
* Either UUID or EmbeddedServiceType.
|
|
3755
|
+
* @maxLength 36
|
|
3756
|
+
*/
|
|
3757
|
+
appDefId?: string;
|
|
3758
|
+
/**
|
|
3759
|
+
* Not only UUID. Something here could be something weird.
|
|
3760
|
+
* @maxLength 36
|
|
3761
|
+
*/
|
|
3762
|
+
instanceId?: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* A version.
|
|
3765
|
+
* @maxLength 500
|
|
3766
|
+
*/
|
|
3767
|
+
version?: string | null;
|
|
3768
|
+
}
|
|
3769
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
3770
|
+
export interface SiteRenamed {
|
|
3771
|
+
/**
|
|
3772
|
+
* A new meta site name (URL slug).
|
|
3773
|
+
* @maxLength 20
|
|
3774
|
+
*/
|
|
3775
|
+
newSiteName?: string;
|
|
3776
|
+
/**
|
|
3777
|
+
* A previous meta site name (URL slug).
|
|
3778
|
+
* @maxLength 255
|
|
3779
|
+
*/
|
|
3780
|
+
oldSiteName?: string;
|
|
3781
|
+
}
|
|
3782
|
+
/**
|
|
3783
|
+
* Hard deletion of the meta site.
|
|
3784
|
+
*
|
|
3785
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
3786
|
+
*/
|
|
3787
|
+
export interface SiteHardDeleted {
|
|
3788
|
+
/** A deletion context. */
|
|
3789
|
+
deleteContext?: DeleteContext;
|
|
3790
|
+
}
|
|
3791
|
+
export interface NamespaceChanged {
|
|
3792
|
+
/** A previous namespace. */
|
|
3793
|
+
oldNamespace?: Namespace;
|
|
3794
|
+
/** A new namespace. */
|
|
3795
|
+
newNamespace?: Namespace;
|
|
3796
|
+
}
|
|
3797
|
+
/** Assigned Studio editor */
|
|
3798
|
+
export interface StudioAssigned {
|
|
3799
|
+
}
|
|
3800
|
+
/** Unassigned Studio editor */
|
|
3801
|
+
export interface StudioUnassigned {
|
|
3802
|
+
}
|
|
3803
|
+
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
3804
|
+
/**
|
|
3805
|
+
* Ticket definition ID.
|
|
3806
|
+
* @format GUID
|
|
3807
|
+
*/
|
|
3808
|
+
ticketDefinitionId?: string;
|
|
3809
|
+
/**
|
|
3810
|
+
* Requested fields. Not implemented.
|
|
3811
|
+
* @maxSize 5
|
|
3812
|
+
*/
|
|
3813
|
+
fields?: Field[];
|
|
3814
|
+
}
|
|
3815
|
+
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
3816
|
+
/** The requested ticket definition. */
|
|
3817
|
+
ticketDefinition?: TicketDefinition;
|
|
3818
|
+
}
|
|
3819
|
+
export interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3820
|
+
/**
|
|
3821
|
+
* Definition ID.
|
|
3822
|
+
* @format GUID
|
|
3823
|
+
*/
|
|
3824
|
+
ticketDefinitionId?: string;
|
|
3825
|
+
}
|
|
3826
|
+
export interface MessageEnvelope {
|
|
3827
|
+
/**
|
|
3828
|
+
* App instance ID.
|
|
3829
|
+
* @format GUID
|
|
3830
|
+
*/
|
|
3831
|
+
instanceId?: string | null;
|
|
3832
|
+
/**
|
|
3833
|
+
* Event type.
|
|
3834
|
+
* @maxLength 150
|
|
3835
|
+
*/
|
|
3836
|
+
eventType?: string;
|
|
3837
|
+
/** The identification type and identity data. */
|
|
3838
|
+
identity?: IdentificationData;
|
|
3839
|
+
/** Stringify payload. */
|
|
3840
|
+
data?: string;
|
|
3841
|
+
}
|
|
3842
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3843
|
+
/**
|
|
3844
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3845
|
+
* @format GUID
|
|
3846
|
+
*/
|
|
3847
|
+
anonymousVisitorId?: string;
|
|
3848
|
+
/**
|
|
3849
|
+
* ID of a site visitor that has logged in to the site.
|
|
3850
|
+
* @format GUID
|
|
3851
|
+
*/
|
|
3852
|
+
memberId?: string;
|
|
3853
|
+
/**
|
|
3854
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3855
|
+
* @format GUID
|
|
3856
|
+
*/
|
|
3857
|
+
wixUserId?: string;
|
|
3858
|
+
/**
|
|
3859
|
+
* ID of an app.
|
|
3860
|
+
* @format GUID
|
|
3861
|
+
*/
|
|
3862
|
+
appId?: string;
|
|
3863
|
+
/** @readonly */
|
|
3864
|
+
identityType?: WebhookIdentityType;
|
|
3865
|
+
}
|
|
3866
|
+
/** @oneof */
|
|
3867
|
+
export interface IdentificationDataIdOneOf {
|
|
3868
|
+
/**
|
|
3869
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3870
|
+
* @format GUID
|
|
3871
|
+
*/
|
|
3872
|
+
anonymousVisitorId?: string;
|
|
3873
|
+
/**
|
|
3874
|
+
* ID of a site visitor that has logged in to the site.
|
|
3875
|
+
* @format GUID
|
|
3876
|
+
*/
|
|
3877
|
+
memberId?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3880
|
+
* @format GUID
|
|
3881
|
+
*/
|
|
3882
|
+
wixUserId?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* ID of an app.
|
|
3885
|
+
* @format GUID
|
|
3886
|
+
*/
|
|
3887
|
+
appId?: string;
|
|
3888
|
+
}
|
|
3889
|
+
export declare enum WebhookIdentityType {
|
|
3890
|
+
UNKNOWN = "UNKNOWN",
|
|
3891
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3892
|
+
MEMBER = "MEMBER",
|
|
3893
|
+
WIX_USER = "WIX_USER",
|
|
3894
|
+
APP = "APP"
|
|
3895
|
+
}
|
|
3896
|
+
export interface GetTicketDefinitionSummaryRequest {
|
|
3897
|
+
/**
|
|
3898
|
+
* Ticket definition id.
|
|
3899
|
+
* @format GUID
|
|
3900
|
+
*/
|
|
3901
|
+
ticketDefinitionId?: string | null;
|
|
3902
|
+
}
|
|
3903
|
+
export interface GetTicketDefinitionSummaryResponse {
|
|
3904
|
+
/** Summary. */
|
|
3905
|
+
summary?: TicketDefinitionSummary;
|
|
3906
|
+
}
|
|
3907
|
+
export interface TicketDefinitionSummary {
|
|
3908
|
+
/**
|
|
3909
|
+
* Ticket definition ID.
|
|
3910
|
+
* @format GUID
|
|
3911
|
+
* @readonly
|
|
3912
|
+
*/
|
|
3913
|
+
definitionId?: string | null;
|
|
3914
|
+
/**
|
|
3915
|
+
* Event ID to which the ticket definition summary belongs.
|
|
3916
|
+
* @format GUID
|
|
3917
|
+
* @readonly
|
|
3918
|
+
*/
|
|
3919
|
+
eventId?: string | null;
|
|
3920
|
+
/**
|
|
3921
|
+
* Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3922
|
+
* @readonly
|
|
3923
|
+
*/
|
|
3924
|
+
_updatedDate?: Date | null;
|
|
3925
|
+
/**
|
|
3926
|
+
* Reserved count.
|
|
3927
|
+
* @readonly
|
|
3928
|
+
*/
|
|
3929
|
+
reservedCount?: number;
|
|
3930
|
+
/**
|
|
3931
|
+
* Sold count.
|
|
3932
|
+
* @readonly
|
|
3933
|
+
*/
|
|
3934
|
+
soldCount?: number;
|
|
3935
|
+
/**
|
|
3936
|
+
* Paid exists.
|
|
3937
|
+
* @readonly
|
|
3938
|
+
*/
|
|
3939
|
+
paidExists?: boolean;
|
|
3940
|
+
}
|
|
3941
|
+
export interface ListEventTicketingSummaryRequest {
|
|
3942
|
+
/**
|
|
3943
|
+
* Event ID.
|
|
3944
|
+
* @format GUID
|
|
3945
|
+
* @minSize 1
|
|
3946
|
+
* @maxSize 1000
|
|
3947
|
+
*/
|
|
3948
|
+
eventId?: string[];
|
|
3949
|
+
}
|
|
3950
|
+
export interface ListEventTicketingSummaryResponse {
|
|
3951
|
+
/** Ticketing summaries. */
|
|
3952
|
+
summaries?: EventTicketingSummary[];
|
|
3953
|
+
}
|
|
3954
|
+
export interface EventTicketingSummary {
|
|
3955
|
+
/**
|
|
3956
|
+
* Event ID to which the ticketing summary belongs.
|
|
3957
|
+
* @format GUID
|
|
3958
|
+
* @readonly
|
|
3959
|
+
*/
|
|
3960
|
+
eventId?: string | null;
|
|
3961
|
+
/**
|
|
3962
|
+
* Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3963
|
+
* @readonly
|
|
3964
|
+
*/
|
|
3965
|
+
_updatedDate?: Date | null;
|
|
3966
|
+
/**
|
|
3967
|
+
* Whether all tickets are sold for this event.
|
|
3968
|
+
* @readonly
|
|
3969
|
+
*/
|
|
3970
|
+
soldOut?: boolean | null;
|
|
3971
|
+
/**
|
|
3972
|
+
* Price of lowest priced ticket.
|
|
3973
|
+
* @readonly
|
|
3974
|
+
*/
|
|
3975
|
+
lowestTicketPrice?: CommonMoney;
|
|
3976
|
+
/**
|
|
3977
|
+
* Price of highest priced ticket.
|
|
3978
|
+
* @readonly
|
|
3979
|
+
*/
|
|
3980
|
+
highestTicketPrice?: CommonMoney;
|
|
3981
|
+
/**
|
|
3982
|
+
* Currency used in event transactions.
|
|
3983
|
+
* @minLength 3
|
|
3984
|
+
* @maxLength 3
|
|
3985
|
+
* @readonly
|
|
3986
|
+
*/
|
|
3987
|
+
currency?: string | null;
|
|
3988
|
+
/**
|
|
3989
|
+
* Formatted price of lowest priced ticket.
|
|
3990
|
+
* @maxLength 50
|
|
3991
|
+
* @readonly
|
|
3992
|
+
*/
|
|
3993
|
+
lowestTicketPriceFormatted?: string | null;
|
|
3994
|
+
/**
|
|
3995
|
+
* Formatted price of highest priced ticket.
|
|
3996
|
+
* @maxLength 50
|
|
3997
|
+
* @readonly
|
|
3998
|
+
*/
|
|
3999
|
+
highestTicketPriceFormatted?: string | null;
|
|
4000
|
+
}
|
|
4001
|
+
export interface ReservationCreated {
|
|
4002
|
+
/** Reservation created timestamp in ISO UTC format. */
|
|
4003
|
+
timestamp?: Date | null;
|
|
4004
|
+
/**
|
|
4005
|
+
* Event ID.
|
|
4006
|
+
* @format GUID
|
|
4007
|
+
*/
|
|
4008
|
+
eventId?: string;
|
|
4009
|
+
/**
|
|
4010
|
+
* Reservation ID.
|
|
4011
|
+
* Can be used to retrieve a reservation invoice.
|
|
4012
|
+
* @format GUID
|
|
4013
|
+
*/
|
|
4014
|
+
reservationId?: string;
|
|
4015
|
+
/** Reservation expiration timestamp. */
|
|
4016
|
+
expires?: Date | null;
|
|
4017
|
+
/** Reservation status. */
|
|
4018
|
+
status?: ReservationStatus;
|
|
4019
|
+
/**
|
|
4020
|
+
* Reservation ticket quantities.
|
|
4021
|
+
* @maxSize 50
|
|
4022
|
+
*/
|
|
4023
|
+
quantities?: TicketQuantity[];
|
|
4024
|
+
/** Reservation update timestamp. */
|
|
4025
|
+
_updatedDate?: Date | null;
|
|
4026
|
+
/**
|
|
4027
|
+
* Reservation counts.
|
|
4028
|
+
* @maxSize 50
|
|
4029
|
+
*/
|
|
4030
|
+
counts?: ReservationCount[];
|
|
4031
|
+
}
|
|
4032
|
+
export declare enum ReservationStatus {
|
|
4033
|
+
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
4034
|
+
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
4035
|
+
/** The reservation is confirmed and will not expire. */
|
|
4036
|
+
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
4037
|
+
/** The reservation is canceled because of non payment. */
|
|
4038
|
+
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
4039
|
+
/** The reservation is canceled manually by the buyer. */
|
|
4040
|
+
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
4041
|
+
/** The reservation is expired. */
|
|
4042
|
+
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4043
|
+
}
|
|
4044
|
+
export interface TicketQuantity {
|
|
4045
|
+
/**
|
|
4046
|
+
* Ticket definition ID.
|
|
4047
|
+
* @format GUID
|
|
4048
|
+
*/
|
|
4049
|
+
ticketDefinitionId?: string | null;
|
|
4050
|
+
/** Quantity. */
|
|
4051
|
+
quantity?: number | null;
|
|
4052
|
+
/** Quantity update timestamp. */
|
|
4053
|
+
_updatedDate?: Date | null;
|
|
4054
|
+
}
|
|
4055
|
+
export interface ReservationCount {
|
|
4056
|
+
/** Reservation Count snapshot timestamp. */
|
|
4057
|
+
timestamp?: Date | null;
|
|
3402
4058
|
/**
|
|
3403
|
-
*
|
|
3404
|
-
*
|
|
3405
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4059
|
+
* Ticket Definition ID.
|
|
4060
|
+
* @format GUID
|
|
3406
4061
|
*/
|
|
3407
|
-
|
|
3408
|
-
/**
|
|
3409
|
-
|
|
3410
|
-
/**
|
|
3411
|
-
|
|
3412
|
-
/**
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
4062
|
+
ticketDefinitionId?: string;
|
|
4063
|
+
/** Confirmed reservation count. */
|
|
4064
|
+
confirmedCount?: number;
|
|
4065
|
+
/** Pending reservation count. */
|
|
4066
|
+
pendingCount?: number;
|
|
4067
|
+
/** True if paid ticket reservation exist. */
|
|
4068
|
+
paidExists?: boolean;
|
|
4069
|
+
}
|
|
4070
|
+
export interface ReservationUpdated {
|
|
4071
|
+
/** Reservation updated timestamp. */
|
|
4072
|
+
timestamp?: Date | null;
|
|
3416
4073
|
/**
|
|
3417
|
-
*
|
|
3418
|
-
*
|
|
4074
|
+
* Event ID.
|
|
4075
|
+
* @format GUID
|
|
3419
4076
|
*/
|
|
3420
|
-
|
|
3421
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
3422
|
-
RISE = "RISE",
|
|
4077
|
+
eventId?: string;
|
|
3423
4078
|
/**
|
|
3424
|
-
*
|
|
3425
|
-
*
|
|
3426
|
-
*
|
|
4079
|
+
* Reservation ID.
|
|
4080
|
+
* Can be used to retrieve a reservation invoice.
|
|
4081
|
+
* @format GUID
|
|
3427
4082
|
*/
|
|
3428
|
-
|
|
3429
|
-
/**
|
|
3430
|
-
|
|
4083
|
+
reservationId?: string;
|
|
4084
|
+
/** Reservation status. */
|
|
4085
|
+
status?: ReservationStatus;
|
|
4086
|
+
/** Reservation expiration timestamp. */
|
|
4087
|
+
expires?: Date | null;
|
|
3431
4088
|
/**
|
|
3432
|
-
*
|
|
3433
|
-
*
|
|
4089
|
+
* Reservation ticket quantities.
|
|
4090
|
+
* @maxSize 50
|
|
3434
4091
|
*/
|
|
3435
|
-
|
|
3436
|
-
/**
|
|
3437
|
-
|
|
3438
|
-
/** Bobb - AI Design Creator. */
|
|
3439
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4092
|
+
quantities?: TicketQuantity[];
|
|
4093
|
+
/** Reservation update timestamp. */
|
|
4094
|
+
_updatedDate?: Date | null;
|
|
3440
4095
|
/**
|
|
3441
|
-
*
|
|
3442
|
-
*
|
|
4096
|
+
* Reservation counts.
|
|
4097
|
+
* @maxSize 50
|
|
3443
4098
|
*/
|
|
3444
|
-
|
|
3445
|
-
}
|
|
3446
|
-
/** Site transferred to another user. */
|
|
3447
|
-
export interface SiteTransferred {
|
|
3448
|
-
/** A previous owner id (user that transfers meta site). */
|
|
3449
|
-
oldOwnerId?: string;
|
|
3450
|
-
/** A new owner id (user that accepts meta site). */
|
|
3451
|
-
newOwnerId?: string;
|
|
3452
|
-
}
|
|
3453
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
3454
|
-
export interface SiteDeleted {
|
|
3455
|
-
/** A deletion context. */
|
|
3456
|
-
deleteContext?: DeleteContext;
|
|
3457
|
-
}
|
|
3458
|
-
export interface DeleteContext {
|
|
3459
|
-
/** When the meta site was deleted. */
|
|
3460
|
-
dateDeleted?: Date | null;
|
|
3461
|
-
/** A status. */
|
|
3462
|
-
deleteStatus?: DeleteStatus;
|
|
3463
|
-
/** A reason (flow). */
|
|
3464
|
-
deleteOrigin?: string;
|
|
3465
|
-
/** A service that deleted it. */
|
|
3466
|
-
initiatorId?: string | null;
|
|
3467
|
-
}
|
|
3468
|
-
export declare enum DeleteStatus {
|
|
3469
|
-
UNKNOWN = "UNKNOWN",
|
|
3470
|
-
TRASH = "TRASH",
|
|
3471
|
-
DELETED = "DELETED",
|
|
3472
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
3473
|
-
}
|
|
3474
|
-
/** Restoration of the meta site. */
|
|
3475
|
-
export interface SiteUndeleted {
|
|
3476
|
-
}
|
|
3477
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
3478
|
-
export interface SitePublished {
|
|
3479
|
-
}
|
|
3480
|
-
export interface SiteUnpublished {
|
|
3481
|
-
/** A list of URLs previously associated with the meta site. */
|
|
3482
|
-
urls?: string[];
|
|
3483
|
-
}
|
|
3484
|
-
export interface SiteMarkedAsTemplate {
|
|
3485
|
-
}
|
|
3486
|
-
export interface SiteMarkedAsWixSite {
|
|
3487
|
-
}
|
|
3488
|
-
/**
|
|
3489
|
-
* Represents a service provisioned a site.
|
|
3490
|
-
*
|
|
3491
|
-
* Note on `origin_instance_id`:
|
|
3492
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
3493
|
-
* This is because of the following scenario:
|
|
3494
|
-
*
|
|
3495
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
3496
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
3497
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
3498
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
3499
|
-
* your site remains consistent with what you initially received and does not include any
|
|
3500
|
-
* changes made to the original template afterward.
|
|
3501
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
3502
|
-
*/
|
|
3503
|
-
export interface ServiceProvisioned {
|
|
3504
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
3505
|
-
appDefId?: string;
|
|
3506
|
-
/** Not only UUID. Something here could be something weird. */
|
|
3507
|
-
instanceId?: string;
|
|
3508
|
-
/** An instance id from which this instance is originated. */
|
|
3509
|
-
originInstanceId?: string;
|
|
3510
|
-
/** A version. */
|
|
3511
|
-
version?: string | null;
|
|
3512
|
-
/** The origin meta site id */
|
|
3513
|
-
originMetaSiteId?: string | null;
|
|
3514
|
-
}
|
|
3515
|
-
export interface ServiceRemoved {
|
|
3516
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
3517
|
-
appDefId?: string;
|
|
3518
|
-
/** Not only UUID. Something here could be something weird. */
|
|
3519
|
-
instanceId?: string;
|
|
3520
|
-
/** A version. */
|
|
3521
|
-
version?: string | null;
|
|
3522
|
-
}
|
|
3523
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
3524
|
-
export interface SiteRenamed {
|
|
3525
|
-
/** A new meta site name (URL slug). */
|
|
3526
|
-
newSiteName?: string;
|
|
3527
|
-
/** A previous meta site name (URL slug). */
|
|
3528
|
-
oldSiteName?: string;
|
|
3529
|
-
}
|
|
3530
|
-
/**
|
|
3531
|
-
* Hard deletion of the meta site.
|
|
3532
|
-
*
|
|
3533
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
3534
|
-
*/
|
|
3535
|
-
export interface SiteHardDeleted {
|
|
3536
|
-
/** A deletion context. */
|
|
3537
|
-
deleteContext?: DeleteContext;
|
|
3538
|
-
}
|
|
3539
|
-
export interface NamespaceChanged {
|
|
3540
|
-
/** A previous namespace. */
|
|
3541
|
-
oldNamespace?: Namespace;
|
|
3542
|
-
/** A new namespace. */
|
|
3543
|
-
newNamespace?: Namespace;
|
|
3544
|
-
}
|
|
3545
|
-
/** Assigned Studio editor */
|
|
3546
|
-
export interface StudioAssigned {
|
|
3547
|
-
}
|
|
3548
|
-
/** Unassigned Studio editor */
|
|
3549
|
-
export interface StudioUnassigned {
|
|
3550
|
-
}
|
|
3551
|
-
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
3552
|
-
/** Ticket definition ID. */
|
|
3553
|
-
ticketDefinitionId?: string;
|
|
3554
|
-
/** Requested fields. Not implemented. */
|
|
3555
|
-
fields?: Field[];
|
|
3556
|
-
}
|
|
3557
|
-
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
3558
|
-
/** The requested ticket definition. */
|
|
3559
|
-
ticketDefinition?: TicketDefinition;
|
|
3560
|
-
}
|
|
3561
|
-
export interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3562
|
-
/** Definition ID. */
|
|
3563
|
-
ticketDefinitionId?: string;
|
|
4099
|
+
counts?: ReservationCount[];
|
|
3564
4100
|
}
|
|
3565
4101
|
interface CommonMoneyNonNullableFields {
|
|
3566
4102
|
value: string;
|
|
@@ -3640,9 +4176,15 @@ export interface QueryAvailableTicketDefinitionsResponseNonNullableFields {
|
|
|
3640
4176
|
ticketDefinitions: TicketDefinitionNonNullableFields[];
|
|
3641
4177
|
}
|
|
3642
4178
|
export interface BaseEventMetadata {
|
|
3643
|
-
/**
|
|
4179
|
+
/**
|
|
4180
|
+
* App instance ID.
|
|
4181
|
+
* @format GUID
|
|
4182
|
+
*/
|
|
3644
4183
|
instanceId?: string | null;
|
|
3645
|
-
/**
|
|
4184
|
+
/**
|
|
4185
|
+
* Event type.
|
|
4186
|
+
* @maxLength 150
|
|
4187
|
+
*/
|
|
3646
4188
|
eventType?: string;
|
|
3647
4189
|
/** The identification type and identity data. */
|
|
3648
4190
|
identity?: IdentificationData;
|
|
@@ -3693,6 +4235,8 @@ export interface TicketDefinitionCreatedEnvelope {
|
|
|
3693
4235
|
* Triggered when a ticket definition is created.
|
|
3694
4236
|
* @permissionScope Manage Events - all permissions
|
|
3695
4237
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4238
|
+
* @permissionScope Manage Events
|
|
4239
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3696
4240
|
* @permissionScope Manage Orders
|
|
3697
4241
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3698
4242
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3703,41 +4247,45 @@ export interface TicketDefinitionCreatedEnvelope {
|
|
|
3703
4247
|
* @slug created
|
|
3704
4248
|
*/
|
|
3705
4249
|
export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
3706
|
-
export interface
|
|
3707
|
-
entity: TicketDefinition;
|
|
4250
|
+
export interface TicketDefinitionDeletedEnvelope {
|
|
3708
4251
|
metadata: EventMetadata;
|
|
3709
4252
|
}
|
|
3710
4253
|
/**
|
|
3711
|
-
* Triggered when a ticket definition is
|
|
4254
|
+
* Triggered when a ticket definition is deleted.
|
|
3712
4255
|
* @permissionScope Manage Events - all permissions
|
|
3713
4256
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4257
|
+
* @permissionScope Manage Events
|
|
4258
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3714
4259
|
* @permissionScope Manage Orders
|
|
3715
4260
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3716
4261
|
* @permissionScope Manage Ticket Definitions
|
|
3717
4262
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3718
4263
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3719
4264
|
* @webhook
|
|
3720
|
-
* @eventType wix.events.v3.
|
|
3721
|
-
* @slug
|
|
4265
|
+
* @eventType wix.events.v3.ticket_definition_deleted
|
|
4266
|
+
* @slug deleted
|
|
3722
4267
|
*/
|
|
3723
|
-
export declare function
|
|
3724
|
-
export interface
|
|
4268
|
+
export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
4269
|
+
export interface TicketDefinitionSaleEndedEnvelope {
|
|
4270
|
+
data: TicketDefinitionSaleEnded;
|
|
3725
4271
|
metadata: EventMetadata;
|
|
3726
4272
|
}
|
|
3727
4273
|
/**
|
|
3728
|
-
* Triggered when a ticket
|
|
4274
|
+
* Triggered when a ticket sale ends. Sales details are not included in the payload.
|
|
3729
4275
|
* @permissionScope Manage Events - all permissions
|
|
3730
4276
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4277
|
+
* @permissionScope Manage Events
|
|
4278
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3731
4279
|
* @permissionScope Manage Orders
|
|
3732
4280
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3733
4281
|
* @permissionScope Manage Ticket Definitions
|
|
3734
4282
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3735
4283
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3736
4284
|
* @webhook
|
|
3737
|
-
* @eventType wix.events.v3.
|
|
3738
|
-
* @slug
|
|
4285
|
+
* @eventType wix.events.v3.ticket_definition_sale_ended
|
|
4286
|
+
* @slug sale_ended
|
|
3739
4287
|
*/
|
|
3740
|
-
export declare function
|
|
4288
|
+
export declare function onTicketDefinitionSaleEnded(handler: (event: TicketDefinitionSaleEndedEnvelope) => void | Promise<void>): void;
|
|
3741
4289
|
export interface TicketDefinitionSalePeriodUpdatedEnvelope {
|
|
3742
4290
|
data: SalePeriodUpdated;
|
|
3743
4291
|
metadata: EventMetadata;
|
|
@@ -3746,6 +4294,8 @@ export interface TicketDefinitionSalePeriodUpdatedEnvelope {
|
|
|
3746
4294
|
* Triggered when a sale period is updated.
|
|
3747
4295
|
* @permissionScope Manage Events - all permissions
|
|
3748
4296
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4297
|
+
* @permissionScope Manage Events
|
|
4298
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3749
4299
|
* @permissionScope Manage Orders
|
|
3750
4300
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3751
4301
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3764,6 +4314,8 @@ export interface TicketDefinitionSaleStartedEnvelope {
|
|
|
3764
4314
|
* Triggered when a ticket sale starts. Sales details are not included in the payload.
|
|
3765
4315
|
* @permissionScope Manage Events - all permissions
|
|
3766
4316
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4317
|
+
* @permissionScope Manage Events
|
|
4318
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3767
4319
|
* @permissionScope Manage Orders
|
|
3768
4320
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3769
4321
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3774,24 +4326,26 @@ export interface TicketDefinitionSaleStartedEnvelope {
|
|
|
3774
4326
|
* @slug sale_started
|
|
3775
4327
|
*/
|
|
3776
4328
|
export declare function onTicketDefinitionSaleStarted(handler: (event: TicketDefinitionSaleStartedEnvelope) => void | Promise<void>): void;
|
|
3777
|
-
export interface
|
|
3778
|
-
|
|
4329
|
+
export interface TicketDefinitionUpdatedEnvelope {
|
|
4330
|
+
entity: TicketDefinition;
|
|
3779
4331
|
metadata: EventMetadata;
|
|
3780
4332
|
}
|
|
3781
4333
|
/**
|
|
3782
|
-
* Triggered when a ticket
|
|
4334
|
+
* Triggered when a ticket definition is updated.
|
|
3783
4335
|
* @permissionScope Manage Events - all permissions
|
|
3784
4336
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4337
|
+
* @permissionScope Manage Events
|
|
4338
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3785
4339
|
* @permissionScope Manage Orders
|
|
3786
4340
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3787
4341
|
* @permissionScope Manage Ticket Definitions
|
|
3788
4342
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3789
4343
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3790
4344
|
* @webhook
|
|
3791
|
-
* @eventType wix.events.v3.
|
|
3792
|
-
* @slug
|
|
4345
|
+
* @eventType wix.events.v3.ticket_definition_updated
|
|
4346
|
+
* @slug updated
|
|
3793
4347
|
*/
|
|
3794
|
-
export declare function
|
|
4348
|
+
export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
3795
4349
|
/**
|
|
3796
4350
|
* > **Note:** This function replaces the deprecated `createTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/createticketdefinition).
|
|
3797
4351
|
*
|
|
@@ -3822,7 +4376,10 @@ export declare function onTicketDefinitionSaleEnded(handler: (event: TicketDefin
|
|
|
3822
4376
|
*/
|
|
3823
4377
|
export declare function createTicketDefinition(ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
3824
4378
|
export interface CreateTicketDefinitionOptions {
|
|
3825
|
-
/**
|
|
4379
|
+
/**
|
|
4380
|
+
* Predefined sets of fields to return.
|
|
4381
|
+
* @maxSize 5
|
|
4382
|
+
*/
|
|
3826
4383
|
fields?: Field[];
|
|
3827
4384
|
}
|
|
3828
4385
|
/**
|
|
@@ -3854,10 +4411,15 @@ export declare function updateTicketDefinition(_id: string | null, ticketDefinit
|
|
|
3854
4411
|
export interface UpdateTicketDefinition {
|
|
3855
4412
|
/**
|
|
3856
4413
|
* Ticket definition ID.
|
|
4414
|
+
* @format GUID
|
|
3857
4415
|
* @readonly
|
|
3858
4416
|
*/
|
|
3859
4417
|
_id?: string | null;
|
|
3860
|
-
/**
|
|
4418
|
+
/**
|
|
4419
|
+
* Event ID to which the ticket definition belongs.
|
|
4420
|
+
* @format GUID
|
|
4421
|
+
* @immutable
|
|
4422
|
+
*/
|
|
3861
4423
|
eventId?: string | null;
|
|
3862
4424
|
/**
|
|
3863
4425
|
* 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.
|
|
@@ -3874,11 +4436,21 @@ export interface UpdateTicketDefinition {
|
|
|
3874
4436
|
* @readonly
|
|
3875
4437
|
*/
|
|
3876
4438
|
_updatedDate?: Date | null;
|
|
3877
|
-
/**
|
|
4439
|
+
/**
|
|
4440
|
+
* Ticket definition name.
|
|
4441
|
+
* @minLength 1
|
|
4442
|
+
* @maxLength 30
|
|
4443
|
+
*/
|
|
3878
4444
|
name?: string | null;
|
|
3879
|
-
/**
|
|
4445
|
+
/**
|
|
4446
|
+
* Ticket definition description.
|
|
4447
|
+
* @maxLength 500
|
|
4448
|
+
*/
|
|
3880
4449
|
description?: string | null;
|
|
3881
|
-
/**
|
|
4450
|
+
/**
|
|
4451
|
+
* Ticket definition policy.
|
|
4452
|
+
* @maxLength 1000
|
|
4453
|
+
*/
|
|
3882
4454
|
policyText?: string | null;
|
|
3883
4455
|
/** Whether this ticket definition is hidden to site visitors and can't be purchased. */
|
|
3884
4456
|
hidden?: boolean;
|
|
@@ -3914,6 +4486,7 @@ export interface UpdateTicketDefinition {
|
|
|
3914
4486
|
* Number of tickets that can be purchased per checkout. <br>
|
|
3915
4487
|
* **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
|
|
3916
4488
|
* @readonly
|
|
4489
|
+
* @max 50
|
|
3917
4490
|
*/
|
|
3918
4491
|
limitPerCheckout?: number | null;
|
|
3919
4492
|
/** Data extensions. */
|
|
@@ -3925,7 +4498,10 @@ export interface UpdateTicketDefinition {
|
|
|
3925
4498
|
eventDetails?: EventDetails;
|
|
3926
4499
|
}
|
|
3927
4500
|
export interface UpdateTicketDefinitionOptions {
|
|
3928
|
-
/**
|
|
4501
|
+
/**
|
|
4502
|
+
* Predefined sets of fields to return.
|
|
4503
|
+
* @maxSize 5
|
|
4504
|
+
*/
|
|
3929
4505
|
fields?: Field[];
|
|
3930
4506
|
}
|
|
3931
4507
|
/**
|
|
@@ -3951,7 +4527,10 @@ export interface UpdateTicketDefinitionOptions {
|
|
|
3951
4527
|
*/
|
|
3952
4528
|
export declare function getTicketDefinition(ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
3953
4529
|
export interface GetTicketDefinitionOptions {
|
|
3954
|
-
/**
|
|
4530
|
+
/**
|
|
4531
|
+
* Predefined sets of fields to return.
|
|
4532
|
+
* @maxSize 5
|
|
4533
|
+
*/
|
|
3955
4534
|
fields?: Field[];
|
|
3956
4535
|
}
|
|
3957
4536
|
/**
|
|
@@ -3991,12 +4570,34 @@ export declare function deleteTicketDefinition(ticketDefinitionId: string): Prom
|
|
|
3991
4570
|
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.ReorderTicketDefinitions
|
|
3992
4571
|
*/
|
|
3993
4572
|
export declare function reorderTicketDefinitions(eventId: string, options?: ReorderTicketDefinitionsOptions): Promise<void>;
|
|
3994
|
-
export interface ReorderTicketDefinitionsOptions extends
|
|
3995
|
-
/**
|
|
4573
|
+
export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4574
|
+
/**
|
|
4575
|
+
* Ticket definition ID.
|
|
4576
|
+
* @format GUID
|
|
4577
|
+
*/
|
|
3996
4578
|
ticketDefinitionId: string;
|
|
3997
|
-
/**
|
|
4579
|
+
/**
|
|
4580
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
4581
|
+
* @format GUID
|
|
4582
|
+
*/
|
|
3998
4583
|
beforeDefinitionId?: string;
|
|
3999
|
-
/**
|
|
4584
|
+
/**
|
|
4585
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
4586
|
+
* @format GUID
|
|
4587
|
+
*/
|
|
4588
|
+
afterDefinitionId?: string;
|
|
4589
|
+
}
|
|
4590
|
+
/** @oneof */
|
|
4591
|
+
interface ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4592
|
+
/**
|
|
4593
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
4594
|
+
* @format GUID
|
|
4595
|
+
*/
|
|
4596
|
+
beforeDefinitionId?: string;
|
|
4597
|
+
/**
|
|
4598
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
4599
|
+
* @format GUID
|
|
4600
|
+
*/
|
|
4000
4601
|
afterDefinitionId?: string;
|
|
4001
4602
|
}
|
|
4002
4603
|
/**
|
|
@@ -4023,7 +4624,10 @@ export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinition
|
|
|
4023
4624
|
*/
|
|
4024
4625
|
export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;
|
|
4025
4626
|
export interface QueryTicketDefinitionsOptions {
|
|
4026
|
-
/**
|
|
4627
|
+
/**
|
|
4628
|
+
* Predefined sets of fields to return.
|
|
4629
|
+
* @maxSize 5
|
|
4630
|
+
*/
|
|
4027
4631
|
fields?: Field[] | undefined;
|
|
4028
4632
|
}
|
|
4029
4633
|
interface QueryCursorResult {
|
|
@@ -4107,7 +4711,10 @@ export interface TicketDefinitionsQueryBuilder {
|
|
|
4107
4711
|
*/
|
|
4108
4712
|
export declare function queryAvailableTicketDefinitions(query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions): Promise<QueryAvailableTicketDefinitionsResponse & QueryAvailableTicketDefinitionsResponseNonNullableFields>;
|
|
4109
4713
|
export interface QueryAvailableTicketDefinitionsOptions {
|
|
4110
|
-
/**
|
|
4714
|
+
/**
|
|
4715
|
+
* Predefined sets of fields to return.
|
|
4716
|
+
* @maxSize 5
|
|
4717
|
+
*/
|
|
4111
4718
|
fields?: Field[];
|
|
4112
4719
|
}
|
|
4113
4720
|
/**
|
|
@@ -4134,6 +4741,8 @@ export interface CountTicketDefinitionsOptions {
|
|
|
4134
4741
|
* Parameters to count ticket definitions by.
|
|
4135
4742
|
*
|
|
4136
4743
|
* - Max: 20 facets.
|
|
4744
|
+
* @maxLength 100
|
|
4745
|
+
* @maxSize 20
|
|
4137
4746
|
*/
|
|
4138
4747
|
facet?: string[];
|
|
4139
4748
|
}
|
|
@@ -4197,7 +4806,11 @@ export declare function bulkDeleteTicketDefinitionsByFilter(filter: Record<strin
|
|
|
4197
4806
|
*/
|
|
4198
4807
|
export declare function changeCurrency(eventId: string, options: ChangeCurrencyOptions): Promise<void>;
|
|
4199
4808
|
export interface ChangeCurrencyOptions {
|
|
4200
|
-
/**
|
|
4809
|
+
/**
|
|
4810
|
+
* Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
4811
|
+
* @minLength 3
|
|
4812
|
+
* @maxLength 3
|
|
4813
|
+
*/
|
|
4201
4814
|
currency: string;
|
|
4202
4815
|
}
|
|
4203
4816
|
export {};
|