@wix/auto_sdk_events_ticket-definitions-v-2 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +10 -10
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +42 -42
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +23 -23
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +23 -23
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +9 -9
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +41 -41
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +21 -21
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +21 -21
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +10 -10
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +42 -42
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +23 -23
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +23 -23
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +10 -10
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +9 -9
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +2 -2
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +41 -41
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +1008 -459
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +21 -21
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +1241 -625
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +21 -21
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
export interface TicketDefinition {
|
|
2
2
|
/**
|
|
3
3
|
* Ticket definition ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
7
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Event ID to which the ticket definition belongs.
|
|
10
|
+
* @format GUID
|
|
11
|
+
* @immutable
|
|
12
|
+
*/
|
|
8
13
|
eventId?: string | null;
|
|
9
14
|
/**
|
|
10
15
|
* Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
|
|
@@ -21,11 +26,21 @@ export interface TicketDefinition {
|
|
|
21
26
|
* @readonly
|
|
22
27
|
*/
|
|
23
28
|
_updatedDate?: Date | null;
|
|
24
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Ticket definition name.
|
|
31
|
+
* @minLength 1
|
|
32
|
+
* @maxLength 30
|
|
33
|
+
*/
|
|
25
34
|
name?: string | null;
|
|
26
|
-
/**
|
|
35
|
+
/**
|
|
36
|
+
* Ticket definition description.
|
|
37
|
+
* @maxLength 500
|
|
38
|
+
*/
|
|
27
39
|
description?: string | null;
|
|
28
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Ticket definition policy.
|
|
42
|
+
* @maxLength 1000
|
|
43
|
+
*/
|
|
29
44
|
policyText?: string | null;
|
|
30
45
|
/** Whether this ticket definition is hidden to site visitors and can't be purchased. */
|
|
31
46
|
hidden?: boolean;
|
|
@@ -61,6 +76,7 @@ export interface TicketDefinition {
|
|
|
61
76
|
* Number of tickets that can be purchased per checkout. <br>
|
|
62
77
|
* **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
|
|
63
78
|
* @readonly
|
|
79
|
+
* @max 50
|
|
64
80
|
*/
|
|
65
81
|
limitPerCheckout?: number | null;
|
|
66
82
|
/** Data extensions. */
|
|
@@ -111,19 +127,35 @@ export interface PricingMethodPriceOneOf {
|
|
|
111
127
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
112
128
|
*/
|
|
113
129
|
export interface CommonMoney {
|
|
114
|
-
/**
|
|
130
|
+
/**
|
|
131
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
132
|
+
* @format DECIMAL_VALUE
|
|
133
|
+
*/
|
|
115
134
|
value?: string;
|
|
116
|
-
/**
|
|
135
|
+
/**
|
|
136
|
+
* Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
|
|
137
|
+
* @format CURRENCY
|
|
138
|
+
*/
|
|
117
139
|
currency?: string;
|
|
118
140
|
}
|
|
119
141
|
export interface PricingOptions {
|
|
120
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* Ticket price option details.
|
|
144
|
+
* @maxSize 100
|
|
145
|
+
*/
|
|
121
146
|
optionDetails?: OptionDetails[];
|
|
122
147
|
}
|
|
123
148
|
export interface OptionDetails {
|
|
124
|
-
/**
|
|
149
|
+
/**
|
|
150
|
+
* Ticket price option ID.
|
|
151
|
+
* @format GUID
|
|
152
|
+
*/
|
|
125
153
|
optionId?: string | null;
|
|
126
|
-
/**
|
|
154
|
+
/**
|
|
155
|
+
* Ticket price option name, such as "Child Ticket".
|
|
156
|
+
* @minLength 1
|
|
157
|
+
* @maxLength 200
|
|
158
|
+
*/
|
|
127
159
|
name?: string | null;
|
|
128
160
|
/** Ticket price. */
|
|
129
161
|
price?: CommonMoney;
|
|
@@ -192,11 +224,14 @@ export interface ExtendedFields {
|
|
|
192
224
|
export interface EventDetails {
|
|
193
225
|
/**
|
|
194
226
|
* Event title.
|
|
227
|
+
* @minLength 1
|
|
228
|
+
* @maxLength 120
|
|
195
229
|
* @readonly
|
|
196
230
|
*/
|
|
197
231
|
title?: string | null;
|
|
198
232
|
/**
|
|
199
233
|
* Event short description.
|
|
234
|
+
* @maxLength 500
|
|
200
235
|
* @readonly
|
|
201
236
|
*/
|
|
202
237
|
shortDescription?: string | null;
|
|
@@ -222,7 +257,10 @@ export interface EventDetails {
|
|
|
222
257
|
status?: Status;
|
|
223
258
|
}
|
|
224
259
|
export interface Location {
|
|
225
|
-
/**
|
|
260
|
+
/**
|
|
261
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
262
|
+
* @maxLength 50
|
|
263
|
+
*/
|
|
226
264
|
name?: string | null;
|
|
227
265
|
/** Location type. */
|
|
228
266
|
type?: LocationType;
|
|
@@ -243,42 +281,83 @@ export declare enum LocationType {
|
|
|
243
281
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
244
282
|
/** Street address. */
|
|
245
283
|
streetAddress?: CommonStreetAddress;
|
|
246
|
-
/**
|
|
284
|
+
/**
|
|
285
|
+
* Primary address information (street and building number).
|
|
286
|
+
* @maxLength 250
|
|
287
|
+
*/
|
|
247
288
|
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 {
|
|
@@ -2583,7 +2658,10 @@ export interface ImageData {
|
|
|
2583
2658
|
export interface StylesBorder {
|
|
2584
2659
|
/** Border width in pixels. */
|
|
2585
2660
|
width?: number | null;
|
|
2586
|
-
/**
|
|
2661
|
+
/**
|
|
2662
|
+
* Border color as a hexadecimal value.
|
|
2663
|
+
* @format COLOR_HEX
|
|
2664
|
+
*/
|
|
2587
2665
|
color?: string | null;
|
|
2588
2666
|
/** Border radius in pixels. */
|
|
2589
2667
|
radius?: number | null;
|
|
@@ -2737,13 +2815,22 @@ export declare enum BackgroundType {
|
|
|
2737
2815
|
export interface Gradient {
|
|
2738
2816
|
/** The gradient angle in degrees. */
|
|
2739
2817
|
angle?: number | null;
|
|
2740
|
-
/**
|
|
2818
|
+
/**
|
|
2819
|
+
* The start color as a hexademical value.
|
|
2820
|
+
* @format COLOR_HEX
|
|
2821
|
+
*/
|
|
2741
2822
|
startColor?: string | null;
|
|
2742
|
-
/**
|
|
2823
|
+
/**
|
|
2824
|
+
* The end color as a hexademical value.
|
|
2825
|
+
* @format COLOR_HEX
|
|
2826
|
+
*/
|
|
2743
2827
|
lastColor?: string | null;
|
|
2744
2828
|
}
|
|
2745
2829
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
2746
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* The background color as a hexademical value.
|
|
2832
|
+
* @format COLOR_HEX
|
|
2833
|
+
*/
|
|
2747
2834
|
color?: string | null;
|
|
2748
2835
|
/** An image to use for the background. */
|
|
2749
2836
|
image?: Media;
|
|
@@ -2754,7 +2841,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2754
2841
|
}
|
|
2755
2842
|
/** @oneof */
|
|
2756
2843
|
export interface BackgroundBackgroundOneOf {
|
|
2757
|
-
/**
|
|
2844
|
+
/**
|
|
2845
|
+
* The background color as a hexademical value.
|
|
2846
|
+
* @format COLOR_HEX
|
|
2847
|
+
*/
|
|
2758
2848
|
color?: string | null;
|
|
2759
2849
|
/** An image to use for the background. */
|
|
2760
2850
|
image?: Media;
|
|
@@ -3066,17 +3156,32 @@ export declare enum VerticalAlignment {
|
|
|
3066
3156
|
export interface CellStyle {
|
|
3067
3157
|
/** Vertical alignment for the cell's text. */
|
|
3068
3158
|
verticalAlignment?: VerticalAlignment;
|
|
3069
|
-
/**
|
|
3159
|
+
/**
|
|
3160
|
+
* Cell background color as a hexadecimal value.
|
|
3161
|
+
* @format COLOR_HEX
|
|
3162
|
+
*/
|
|
3070
3163
|
backgroundColor?: string | null;
|
|
3071
3164
|
}
|
|
3072
3165
|
export interface BorderColors {
|
|
3073
|
-
/**
|
|
3166
|
+
/**
|
|
3167
|
+
* Left border color as a hexadecimal value.
|
|
3168
|
+
* @format COLOR_HEX
|
|
3169
|
+
*/
|
|
3074
3170
|
left?: string | null;
|
|
3075
|
-
/**
|
|
3171
|
+
/**
|
|
3172
|
+
* Right border color as a hexadecimal value.
|
|
3173
|
+
* @format COLOR_HEX
|
|
3174
|
+
*/
|
|
3076
3175
|
right?: string | null;
|
|
3077
|
-
/**
|
|
3176
|
+
/**
|
|
3177
|
+
* Top border color as a hexadecimal value.
|
|
3178
|
+
* @format COLOR_HEX
|
|
3179
|
+
*/
|
|
3078
3180
|
top?: string | null;
|
|
3079
|
-
/**
|
|
3181
|
+
/**
|
|
3182
|
+
* Bottom border color as a hexadecimal value.
|
|
3183
|
+
* @format COLOR_HEX
|
|
3184
|
+
*/
|
|
3080
3185
|
bottom?: string | null;
|
|
3081
3186
|
}
|
|
3082
3187
|
/**
|
|
@@ -3187,7 +3292,10 @@ export interface TextNodeStyle {
|
|
|
3187
3292
|
export interface EventUpdated {
|
|
3188
3293
|
/** Event update timestamp in ISO UTC format. */
|
|
3189
3294
|
timestamp?: Date | null;
|
|
3190
|
-
/**
|
|
3295
|
+
/**
|
|
3296
|
+
* Event ID.
|
|
3297
|
+
* @format GUID
|
|
3298
|
+
*/
|
|
3191
3299
|
eventId?: string;
|
|
3192
3300
|
/** Event location. */
|
|
3193
3301
|
location?: EventsLocation;
|
|
@@ -3204,11 +3312,17 @@ export interface EventUpdated {
|
|
|
3204
3312
|
event?: Event;
|
|
3205
3313
|
}
|
|
3206
3314
|
export interface SeatingPlanCategoriesSummaryUpdated {
|
|
3207
|
-
/**
|
|
3315
|
+
/**
|
|
3316
|
+
* Seating plan id
|
|
3317
|
+
* @format GUID
|
|
3318
|
+
*/
|
|
3208
3319
|
seatingPlanId?: string;
|
|
3209
3320
|
/** External seating plan id */
|
|
3210
3321
|
externalSeatingPlanId?: string | null;
|
|
3211
|
-
/**
|
|
3322
|
+
/**
|
|
3323
|
+
* Ticket counts by category
|
|
3324
|
+
* @maxSize 100
|
|
3325
|
+
*/
|
|
3212
3326
|
categories?: CategoryDetails[];
|
|
3213
3327
|
/**
|
|
3214
3328
|
* Summary revision.
|
|
@@ -3219,16 +3333,21 @@ export interface SeatingPlanCategoriesSummaryUpdated {
|
|
|
3219
3333
|
export interface CategoryDetails {
|
|
3220
3334
|
/**
|
|
3221
3335
|
* Seating plan id
|
|
3336
|
+
* @format GUID
|
|
3222
3337
|
* @readonly
|
|
3223
3338
|
*/
|
|
3224
3339
|
seatingPlanId?: string | null;
|
|
3225
3340
|
/**
|
|
3226
3341
|
* External seating plan id
|
|
3342
|
+
* @minLength 1
|
|
3343
|
+
* @maxLength 100
|
|
3227
3344
|
* @readonly
|
|
3228
3345
|
*/
|
|
3229
3346
|
externalSeatingPlanId?: string | null;
|
|
3230
3347
|
/**
|
|
3231
3348
|
* External category id
|
|
3349
|
+
* @minLength 1
|
|
3350
|
+
* @maxLength 100
|
|
3232
3351
|
* @readonly
|
|
3233
3352
|
*/
|
|
3234
3353
|
externalCategoryId?: string | null;
|
|
@@ -3243,6 +3362,76 @@ export interface CategoryDetails {
|
|
|
3243
3362
|
*/
|
|
3244
3363
|
reserved?: number | null;
|
|
3245
3364
|
}
|
|
3365
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3366
|
+
createdEvent?: EntityCreatedEvent;
|
|
3367
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3368
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3369
|
+
actionEvent?: ActionEvent;
|
|
3370
|
+
/**
|
|
3371
|
+
* Unique event ID.
|
|
3372
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3373
|
+
*/
|
|
3374
|
+
_id?: string;
|
|
3375
|
+
/**
|
|
3376
|
+
* Assumes actions are also always typed to an entity_type
|
|
3377
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3378
|
+
*/
|
|
3379
|
+
entityFqdn?: string;
|
|
3380
|
+
/**
|
|
3381
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3382
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3383
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3384
|
+
*/
|
|
3385
|
+
slug?: string;
|
|
3386
|
+
/** ID of the entity associated with the event. */
|
|
3387
|
+
entityId?: string;
|
|
3388
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3389
|
+
eventTime?: Date | null;
|
|
3390
|
+
/**
|
|
3391
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3392
|
+
* (for example, GDPR).
|
|
3393
|
+
*/
|
|
3394
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3395
|
+
/** If present, indicates the action that triggered the event. */
|
|
3396
|
+
originatedFrom?: string | null;
|
|
3397
|
+
/**
|
|
3398
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3399
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3400
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3401
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3402
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3403
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3404
|
+
*/
|
|
3405
|
+
entityEventSequence?: string | null;
|
|
3406
|
+
}
|
|
3407
|
+
/** @oneof */
|
|
3408
|
+
export interface DomainEventBodyOneOf {
|
|
3409
|
+
createdEvent?: EntityCreatedEvent;
|
|
3410
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3411
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3412
|
+
actionEvent?: ActionEvent;
|
|
3413
|
+
}
|
|
3414
|
+
export interface EntityCreatedEvent {
|
|
3415
|
+
entity?: string;
|
|
3416
|
+
}
|
|
3417
|
+
export interface RestoreInfo {
|
|
3418
|
+
deletedDate?: Date | null;
|
|
3419
|
+
}
|
|
3420
|
+
export interface EntityUpdatedEvent {
|
|
3421
|
+
/**
|
|
3422
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3423
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3424
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3425
|
+
*/
|
|
3426
|
+
currentEntity?: string;
|
|
3427
|
+
}
|
|
3428
|
+
export interface EntityDeletedEvent {
|
|
3429
|
+
/** Entity that was deleted */
|
|
3430
|
+
deletedEntity?: string | null;
|
|
3431
|
+
}
|
|
3432
|
+
export interface ActionEvent {
|
|
3433
|
+
body?: string;
|
|
3434
|
+
}
|
|
3246
3435
|
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
3247
3436
|
/** Emitted on a meta site creation. */
|
|
3248
3437
|
siteCreated?: SiteCreated;
|
|
@@ -3274,7 +3463,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3274
3463
|
studioAssigned?: StudioAssigned;
|
|
3275
3464
|
/** Emitted when Studio is detached. */
|
|
3276
3465
|
studioUnassigned?: StudioUnassigned;
|
|
3277
|
-
/**
|
|
3466
|
+
/**
|
|
3467
|
+
* A meta site id.
|
|
3468
|
+
* @format GUID
|
|
3469
|
+
*/
|
|
3278
3470
|
metaSiteId?: string;
|
|
3279
3471
|
/** A meta site version. Monotonically increasing. */
|
|
3280
3472
|
version?: string;
|
|
@@ -3283,6 +3475,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3283
3475
|
/**
|
|
3284
3476
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
3285
3477
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
3478
|
+
* @maxSize 4000
|
|
3286
3479
|
*/
|
|
3287
3480
|
assets?: Asset[];
|
|
3288
3481
|
}
|
|
@@ -3320,9 +3513,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
3320
3513
|
studioUnassigned?: StudioUnassigned;
|
|
3321
3514
|
}
|
|
3322
3515
|
export interface Asset {
|
|
3323
|
-
/**
|
|
3516
|
+
/**
|
|
3517
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
3518
|
+
* @maxLength 36
|
|
3519
|
+
*/
|
|
3324
3520
|
appDefId?: string;
|
|
3325
|
-
/**
|
|
3521
|
+
/**
|
|
3522
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
3523
|
+
* @maxLength 200
|
|
3524
|
+
*/
|
|
3326
3525
|
instanceId?: string;
|
|
3327
3526
|
/** An application state. */
|
|
3328
3527
|
state?: State;
|
|
@@ -3335,9 +3534,15 @@ export declare enum State {
|
|
|
3335
3534
|
DEMO = "DEMO"
|
|
3336
3535
|
}
|
|
3337
3536
|
export interface SiteCreated {
|
|
3338
|
-
/**
|
|
3537
|
+
/**
|
|
3538
|
+
* A template identifier (empty if not created from a template).
|
|
3539
|
+
* @maxLength 36
|
|
3540
|
+
*/
|
|
3339
3541
|
originTemplateId?: string;
|
|
3340
|
-
/**
|
|
3542
|
+
/**
|
|
3543
|
+
* An account id of the owner.
|
|
3544
|
+
* @format GUID
|
|
3545
|
+
*/
|
|
3341
3546
|
ownerId?: string;
|
|
3342
3547
|
/** A context in which meta site was created. */
|
|
3343
3548
|
context?: SiteCreatedContext;
|
|
@@ -3346,9 +3551,13 @@ export interface SiteCreated {
|
|
|
3346
3551
|
*
|
|
3347
3552
|
* In case of a creation from a template it's a template id.
|
|
3348
3553
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
3554
|
+
* @format GUID
|
|
3349
3555
|
*/
|
|
3350
3556
|
originMetaSiteId?: string | null;
|
|
3351
|
-
/**
|
|
3557
|
+
/**
|
|
3558
|
+
* A meta site name (URL slug).
|
|
3559
|
+
* @maxLength 20
|
|
3560
|
+
*/
|
|
3352
3561
|
siteName?: string;
|
|
3353
3562
|
/** A namespace. */
|
|
3354
3563
|
namespace?: Namespace;
|
|
@@ -3398,169 +3607,499 @@ export declare enum Namespace {
|
|
|
3398
3607
|
*
|
|
3399
3608
|
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
3400
3609
|
*/
|
|
3401
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
3610
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
3611
|
+
/**
|
|
3612
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
3613
|
+
* Will be accessible from Site List and will not have a website app.
|
|
3614
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
3615
|
+
*/
|
|
3616
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
3617
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
3618
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
3619
|
+
/** It is to be used in the Business First efforts. */
|
|
3620
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
3621
|
+
/** Bookings business flow with no site. */
|
|
3622
|
+
ANYWHERE = "ANYWHERE",
|
|
3623
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
3624
|
+
HEADLESS = "HEADLESS",
|
|
3625
|
+
/**
|
|
3626
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
3627
|
+
* The site will be used for account level CSM feature for enterprise
|
|
3628
|
+
*/
|
|
3629
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
3630
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
3631
|
+
RISE = "RISE",
|
|
3632
|
+
/**
|
|
3633
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
3634
|
+
* There's a blank site behind the scene but it's blank).
|
|
3635
|
+
* The Mobile company will be the owner of this namespace.
|
|
3636
|
+
*/
|
|
3637
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
3638
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
3639
|
+
NOWNIA = "NOWNIA",
|
|
3640
|
+
/**
|
|
3641
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
3642
|
+
* The Partners company owns this namespace.
|
|
3643
|
+
*/
|
|
3644
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
3645
|
+
/** Codux Headless Sites */
|
|
3646
|
+
CODUX = "CODUX",
|
|
3647
|
+
/** Bobb - AI Design Creator. */
|
|
3648
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
3649
|
+
/**
|
|
3650
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
3651
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
3652
|
+
*/
|
|
3653
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
|
|
3654
|
+
}
|
|
3655
|
+
/** Site transferred to another user. */
|
|
3656
|
+
export interface SiteTransferred {
|
|
3657
|
+
/**
|
|
3658
|
+
* A previous owner id (user that transfers meta site).
|
|
3659
|
+
* @format GUID
|
|
3660
|
+
*/
|
|
3661
|
+
oldOwnerId?: string;
|
|
3662
|
+
/**
|
|
3663
|
+
* A new owner id (user that accepts meta site).
|
|
3664
|
+
* @format GUID
|
|
3665
|
+
*/
|
|
3666
|
+
newOwnerId?: string;
|
|
3667
|
+
}
|
|
3668
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
3669
|
+
export interface SiteDeleted {
|
|
3670
|
+
/** A deletion context. */
|
|
3671
|
+
deleteContext?: DeleteContext;
|
|
3672
|
+
}
|
|
3673
|
+
export interface DeleteContext {
|
|
3674
|
+
/** When the meta site was deleted. */
|
|
3675
|
+
dateDeleted?: Date | null;
|
|
3676
|
+
/** A status. */
|
|
3677
|
+
deleteStatus?: DeleteStatus;
|
|
3678
|
+
/**
|
|
3679
|
+
* A reason (flow).
|
|
3680
|
+
* @maxLength 255
|
|
3681
|
+
*/
|
|
3682
|
+
deleteOrigin?: string;
|
|
3683
|
+
/**
|
|
3684
|
+
* A service that deleted it.
|
|
3685
|
+
* @maxLength 255
|
|
3686
|
+
*/
|
|
3687
|
+
initiatorId?: string | null;
|
|
3688
|
+
}
|
|
3689
|
+
export declare enum DeleteStatus {
|
|
3690
|
+
UNKNOWN = "UNKNOWN",
|
|
3691
|
+
TRASH = "TRASH",
|
|
3692
|
+
DELETED = "DELETED",
|
|
3693
|
+
PENDING_PURGE = "PENDING_PURGE"
|
|
3694
|
+
}
|
|
3695
|
+
/** Restoration of the meta site. */
|
|
3696
|
+
export interface SiteUndeleted {
|
|
3697
|
+
}
|
|
3698
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
3699
|
+
export interface SitePublished {
|
|
3700
|
+
}
|
|
3701
|
+
export interface SiteUnpublished {
|
|
3702
|
+
/**
|
|
3703
|
+
* A list of URLs previously associated with the meta site.
|
|
3704
|
+
* @maxLength 4000
|
|
3705
|
+
* @maxSize 10000
|
|
3706
|
+
*/
|
|
3707
|
+
urls?: string[];
|
|
3708
|
+
}
|
|
3709
|
+
export interface SiteMarkedAsTemplate {
|
|
3710
|
+
}
|
|
3711
|
+
export interface SiteMarkedAsWixSite {
|
|
3712
|
+
}
|
|
3713
|
+
/**
|
|
3714
|
+
* Represents a service provisioned a site.
|
|
3715
|
+
*
|
|
3716
|
+
* Note on `origin_instance_id`:
|
|
3717
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
3718
|
+
* This is because of the following scenario:
|
|
3719
|
+
*
|
|
3720
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
3721
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
3722
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
3723
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
3724
|
+
* your site remains consistent with what you initially received and does not include any
|
|
3725
|
+
* changes made to the original template afterward.
|
|
3726
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
3727
|
+
*/
|
|
3728
|
+
export interface ServiceProvisioned {
|
|
3729
|
+
/**
|
|
3730
|
+
* Either UUID or EmbeddedServiceType.
|
|
3731
|
+
* @maxLength 36
|
|
3732
|
+
*/
|
|
3733
|
+
appDefId?: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* Not only UUID. Something here could be something weird.
|
|
3736
|
+
* @maxLength 36
|
|
3737
|
+
*/
|
|
3738
|
+
instanceId?: string;
|
|
3739
|
+
/**
|
|
3740
|
+
* An instance id from which this instance is originated.
|
|
3741
|
+
* @maxLength 36
|
|
3742
|
+
*/
|
|
3743
|
+
originInstanceId?: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* A version.
|
|
3746
|
+
* @maxLength 500
|
|
3747
|
+
*/
|
|
3748
|
+
version?: string | null;
|
|
3749
|
+
/**
|
|
3750
|
+
* The origin meta site id
|
|
3751
|
+
* @format GUID
|
|
3752
|
+
*/
|
|
3753
|
+
originMetaSiteId?: string | null;
|
|
3754
|
+
}
|
|
3755
|
+
export interface ServiceRemoved {
|
|
3756
|
+
/**
|
|
3757
|
+
* Either UUID or EmbeddedServiceType.
|
|
3758
|
+
* @maxLength 36
|
|
3759
|
+
*/
|
|
3760
|
+
appDefId?: string;
|
|
3761
|
+
/**
|
|
3762
|
+
* Not only UUID. Something here could be something weird.
|
|
3763
|
+
* @maxLength 36
|
|
3764
|
+
*/
|
|
3765
|
+
instanceId?: string;
|
|
3766
|
+
/**
|
|
3767
|
+
* A version.
|
|
3768
|
+
* @maxLength 500
|
|
3769
|
+
*/
|
|
3770
|
+
version?: string | null;
|
|
3771
|
+
}
|
|
3772
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
3773
|
+
export interface SiteRenamed {
|
|
3774
|
+
/**
|
|
3775
|
+
* A new meta site name (URL slug).
|
|
3776
|
+
* @maxLength 20
|
|
3777
|
+
*/
|
|
3778
|
+
newSiteName?: string;
|
|
3779
|
+
/**
|
|
3780
|
+
* A previous meta site name (URL slug).
|
|
3781
|
+
* @maxLength 255
|
|
3782
|
+
*/
|
|
3783
|
+
oldSiteName?: string;
|
|
3784
|
+
}
|
|
3785
|
+
/**
|
|
3786
|
+
* Hard deletion of the meta site.
|
|
3787
|
+
*
|
|
3788
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
3789
|
+
*/
|
|
3790
|
+
export interface SiteHardDeleted {
|
|
3791
|
+
/** A deletion context. */
|
|
3792
|
+
deleteContext?: DeleteContext;
|
|
3793
|
+
}
|
|
3794
|
+
export interface NamespaceChanged {
|
|
3795
|
+
/** A previous namespace. */
|
|
3796
|
+
oldNamespace?: Namespace;
|
|
3797
|
+
/** A new namespace. */
|
|
3798
|
+
newNamespace?: Namespace;
|
|
3799
|
+
}
|
|
3800
|
+
/** Assigned Studio editor */
|
|
3801
|
+
export interface StudioAssigned {
|
|
3802
|
+
}
|
|
3803
|
+
/** Unassigned Studio editor */
|
|
3804
|
+
export interface StudioUnassigned {
|
|
3805
|
+
}
|
|
3806
|
+
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
3807
|
+
/**
|
|
3808
|
+
* Ticket definition ID.
|
|
3809
|
+
* @format GUID
|
|
3810
|
+
*/
|
|
3811
|
+
ticketDefinitionId?: string;
|
|
3812
|
+
/**
|
|
3813
|
+
* Requested fields. Not implemented.
|
|
3814
|
+
* @maxSize 5
|
|
3815
|
+
*/
|
|
3816
|
+
fields?: Field[];
|
|
3817
|
+
}
|
|
3818
|
+
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
3819
|
+
/** The requested ticket definition. */
|
|
3820
|
+
ticketDefinition?: TicketDefinition;
|
|
3821
|
+
}
|
|
3822
|
+
export interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3823
|
+
/**
|
|
3824
|
+
* Definition ID.
|
|
3825
|
+
* @format GUID
|
|
3826
|
+
*/
|
|
3827
|
+
ticketDefinitionId?: string;
|
|
3828
|
+
}
|
|
3829
|
+
export interface MessageEnvelope {
|
|
3830
|
+
/**
|
|
3831
|
+
* App instance ID.
|
|
3832
|
+
* @format GUID
|
|
3833
|
+
*/
|
|
3834
|
+
instanceId?: string | null;
|
|
3835
|
+
/**
|
|
3836
|
+
* Event type.
|
|
3837
|
+
* @maxLength 150
|
|
3838
|
+
*/
|
|
3839
|
+
eventType?: string;
|
|
3840
|
+
/** The identification type and identity data. */
|
|
3841
|
+
identity?: IdentificationData;
|
|
3842
|
+
/** Stringify payload. */
|
|
3843
|
+
data?: string;
|
|
3844
|
+
}
|
|
3845
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3846
|
+
/**
|
|
3847
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3848
|
+
* @format GUID
|
|
3849
|
+
*/
|
|
3850
|
+
anonymousVisitorId?: string;
|
|
3851
|
+
/**
|
|
3852
|
+
* ID of a site visitor that has logged in to the site.
|
|
3853
|
+
* @format GUID
|
|
3854
|
+
*/
|
|
3855
|
+
memberId?: string;
|
|
3856
|
+
/**
|
|
3857
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3858
|
+
* @format GUID
|
|
3859
|
+
*/
|
|
3860
|
+
wixUserId?: string;
|
|
3861
|
+
/**
|
|
3862
|
+
* ID of an app.
|
|
3863
|
+
* @format GUID
|
|
3864
|
+
*/
|
|
3865
|
+
appId?: string;
|
|
3866
|
+
/** @readonly */
|
|
3867
|
+
identityType?: WebhookIdentityType;
|
|
3868
|
+
}
|
|
3869
|
+
/** @oneof */
|
|
3870
|
+
export interface IdentificationDataIdOneOf {
|
|
3871
|
+
/**
|
|
3872
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3873
|
+
* @format GUID
|
|
3874
|
+
*/
|
|
3875
|
+
anonymousVisitorId?: string;
|
|
3876
|
+
/**
|
|
3877
|
+
* ID of a site visitor that has logged in to the site.
|
|
3878
|
+
* @format GUID
|
|
3879
|
+
*/
|
|
3880
|
+
memberId?: string;
|
|
3881
|
+
/**
|
|
3882
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3883
|
+
* @format GUID
|
|
3884
|
+
*/
|
|
3885
|
+
wixUserId?: string;
|
|
3886
|
+
/**
|
|
3887
|
+
* ID of an app.
|
|
3888
|
+
* @format GUID
|
|
3889
|
+
*/
|
|
3890
|
+
appId?: string;
|
|
3891
|
+
}
|
|
3892
|
+
export declare enum WebhookIdentityType {
|
|
3893
|
+
UNKNOWN = "UNKNOWN",
|
|
3894
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3895
|
+
MEMBER = "MEMBER",
|
|
3896
|
+
WIX_USER = "WIX_USER",
|
|
3897
|
+
APP = "APP"
|
|
3898
|
+
}
|
|
3899
|
+
export interface GetTicketDefinitionSummaryRequest {
|
|
3900
|
+
/**
|
|
3901
|
+
* Ticket definition id.
|
|
3902
|
+
* @format GUID
|
|
3903
|
+
*/
|
|
3904
|
+
ticketDefinitionId?: string | null;
|
|
3905
|
+
}
|
|
3906
|
+
export interface GetTicketDefinitionSummaryResponse {
|
|
3907
|
+
/** Summary. */
|
|
3908
|
+
summary?: TicketDefinitionSummary;
|
|
3909
|
+
}
|
|
3910
|
+
export interface TicketDefinitionSummary {
|
|
3911
|
+
/**
|
|
3912
|
+
* Ticket definition ID.
|
|
3913
|
+
* @format GUID
|
|
3914
|
+
* @readonly
|
|
3915
|
+
*/
|
|
3916
|
+
definitionId?: string | null;
|
|
3917
|
+
/**
|
|
3918
|
+
* Event ID to which the ticket definition summary belongs.
|
|
3919
|
+
* @format GUID
|
|
3920
|
+
* @readonly
|
|
3921
|
+
*/
|
|
3922
|
+
eventId?: string | null;
|
|
3923
|
+
/**
|
|
3924
|
+
* Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3925
|
+
* @readonly
|
|
3926
|
+
*/
|
|
3927
|
+
_updatedDate?: Date | null;
|
|
3928
|
+
/**
|
|
3929
|
+
* Reserved count.
|
|
3930
|
+
* @readonly
|
|
3931
|
+
*/
|
|
3932
|
+
reservedCount?: number;
|
|
3933
|
+
/**
|
|
3934
|
+
* Sold count.
|
|
3935
|
+
* @readonly
|
|
3936
|
+
*/
|
|
3937
|
+
soldCount?: number;
|
|
3938
|
+
/**
|
|
3939
|
+
* Paid exists.
|
|
3940
|
+
* @readonly
|
|
3941
|
+
*/
|
|
3942
|
+
paidExists?: boolean;
|
|
3943
|
+
}
|
|
3944
|
+
export interface ListEventTicketingSummaryRequest {
|
|
3945
|
+
/**
|
|
3946
|
+
* Event ID.
|
|
3947
|
+
* @format GUID
|
|
3948
|
+
* @minSize 1
|
|
3949
|
+
* @maxSize 1000
|
|
3950
|
+
*/
|
|
3951
|
+
eventId?: string[];
|
|
3952
|
+
}
|
|
3953
|
+
export interface ListEventTicketingSummaryResponse {
|
|
3954
|
+
/** Ticketing summaries. */
|
|
3955
|
+
summaries?: EventTicketingSummary[];
|
|
3956
|
+
}
|
|
3957
|
+
export interface EventTicketingSummary {
|
|
3958
|
+
/**
|
|
3959
|
+
* Event ID to which the ticketing summary belongs.
|
|
3960
|
+
* @format GUID
|
|
3961
|
+
* @readonly
|
|
3962
|
+
*/
|
|
3963
|
+
eventId?: string | null;
|
|
3964
|
+
/**
|
|
3965
|
+
* Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3966
|
+
* @readonly
|
|
3967
|
+
*/
|
|
3968
|
+
_updatedDate?: Date | null;
|
|
3969
|
+
/**
|
|
3970
|
+
* Whether all tickets are sold for this event.
|
|
3971
|
+
* @readonly
|
|
3972
|
+
*/
|
|
3973
|
+
soldOut?: boolean | null;
|
|
3974
|
+
/**
|
|
3975
|
+
* Price of lowest priced ticket.
|
|
3976
|
+
* @readonly
|
|
3977
|
+
*/
|
|
3978
|
+
lowestTicketPrice?: CommonMoney;
|
|
3979
|
+
/**
|
|
3980
|
+
* Price of highest priced ticket.
|
|
3981
|
+
* @readonly
|
|
3982
|
+
*/
|
|
3983
|
+
highestTicketPrice?: CommonMoney;
|
|
3984
|
+
/**
|
|
3985
|
+
* Currency used in event transactions.
|
|
3986
|
+
* @minLength 3
|
|
3987
|
+
* @maxLength 3
|
|
3988
|
+
* @readonly
|
|
3989
|
+
*/
|
|
3990
|
+
currency?: string | null;
|
|
3991
|
+
/**
|
|
3992
|
+
* Formatted price of lowest priced ticket.
|
|
3993
|
+
* @maxLength 50
|
|
3994
|
+
* @readonly
|
|
3995
|
+
*/
|
|
3996
|
+
lowestTicketPriceFormatted?: string | null;
|
|
3997
|
+
/**
|
|
3998
|
+
* Formatted price of highest priced ticket.
|
|
3999
|
+
* @maxLength 50
|
|
4000
|
+
* @readonly
|
|
4001
|
+
*/
|
|
4002
|
+
highestTicketPriceFormatted?: string | null;
|
|
4003
|
+
}
|
|
4004
|
+
export interface ReservationCreated {
|
|
4005
|
+
/** Reservation created timestamp in ISO UTC format. */
|
|
4006
|
+
timestamp?: Date | null;
|
|
4007
|
+
/**
|
|
4008
|
+
* Event ID.
|
|
4009
|
+
* @format GUID
|
|
4010
|
+
*/
|
|
4011
|
+
eventId?: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Reservation ID.
|
|
4014
|
+
* Can be used to retrieve a reservation invoice.
|
|
4015
|
+
* @format GUID
|
|
4016
|
+
*/
|
|
4017
|
+
reservationId?: string;
|
|
4018
|
+
/** Reservation expiration timestamp. */
|
|
4019
|
+
expires?: Date | null;
|
|
4020
|
+
/** Reservation status. */
|
|
4021
|
+
status?: ReservationStatus;
|
|
4022
|
+
/**
|
|
4023
|
+
* Reservation ticket quantities.
|
|
4024
|
+
* @maxSize 50
|
|
4025
|
+
*/
|
|
4026
|
+
quantities?: TicketQuantity[];
|
|
4027
|
+
/** Reservation update timestamp. */
|
|
4028
|
+
_updatedDate?: Date | null;
|
|
4029
|
+
/**
|
|
4030
|
+
* Reservation counts.
|
|
4031
|
+
* @maxSize 50
|
|
4032
|
+
*/
|
|
4033
|
+
counts?: ReservationCount[];
|
|
4034
|
+
}
|
|
4035
|
+
export declare enum ReservationStatus {
|
|
4036
|
+
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
4037
|
+
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
4038
|
+
/** The reservation is confirmed and will not expire. */
|
|
4039
|
+
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
4040
|
+
/** The reservation is canceled because of non payment. */
|
|
4041
|
+
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
4042
|
+
/** The reservation is canceled manually by the buyer. */
|
|
4043
|
+
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
4044
|
+
/** The reservation is expired. */
|
|
4045
|
+
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4046
|
+
}
|
|
4047
|
+
export interface TicketQuantity {
|
|
4048
|
+
/**
|
|
4049
|
+
* Ticket definition ID.
|
|
4050
|
+
* @format GUID
|
|
4051
|
+
*/
|
|
4052
|
+
ticketDefinitionId?: string | null;
|
|
4053
|
+
/** Quantity. */
|
|
4054
|
+
quantity?: number | null;
|
|
4055
|
+
/** Quantity update timestamp. */
|
|
4056
|
+
_updatedDate?: Date | null;
|
|
4057
|
+
}
|
|
4058
|
+
export interface ReservationCount {
|
|
4059
|
+
/** Reservation Count snapshot timestamp. */
|
|
4060
|
+
timestamp?: Date | null;
|
|
3402
4061
|
/**
|
|
3403
|
-
*
|
|
3404
|
-
*
|
|
3405
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4062
|
+
* Ticket Definition ID.
|
|
4063
|
+
* @format GUID
|
|
3406
4064
|
*/
|
|
3407
|
-
|
|
3408
|
-
/**
|
|
3409
|
-
|
|
3410
|
-
/**
|
|
3411
|
-
|
|
3412
|
-
/**
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
4065
|
+
ticketDefinitionId?: string;
|
|
4066
|
+
/** Confirmed reservation count. */
|
|
4067
|
+
confirmedCount?: number;
|
|
4068
|
+
/** Pending reservation count. */
|
|
4069
|
+
pendingCount?: number;
|
|
4070
|
+
/** True if paid ticket reservation exist. */
|
|
4071
|
+
paidExists?: boolean;
|
|
4072
|
+
}
|
|
4073
|
+
export interface ReservationUpdated {
|
|
4074
|
+
/** Reservation updated timestamp. */
|
|
4075
|
+
timestamp?: Date | null;
|
|
3416
4076
|
/**
|
|
3417
|
-
*
|
|
3418
|
-
*
|
|
4077
|
+
* Event ID.
|
|
4078
|
+
* @format GUID
|
|
3419
4079
|
*/
|
|
3420
|
-
|
|
3421
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
3422
|
-
RISE = "RISE",
|
|
4080
|
+
eventId?: string;
|
|
3423
4081
|
/**
|
|
3424
|
-
*
|
|
3425
|
-
*
|
|
3426
|
-
*
|
|
4082
|
+
* Reservation ID.
|
|
4083
|
+
* Can be used to retrieve a reservation invoice.
|
|
4084
|
+
* @format GUID
|
|
3427
4085
|
*/
|
|
3428
|
-
|
|
3429
|
-
/**
|
|
3430
|
-
|
|
4086
|
+
reservationId?: string;
|
|
4087
|
+
/** Reservation status. */
|
|
4088
|
+
status?: ReservationStatus;
|
|
4089
|
+
/** Reservation expiration timestamp. */
|
|
4090
|
+
expires?: Date | null;
|
|
3431
4091
|
/**
|
|
3432
|
-
*
|
|
3433
|
-
*
|
|
4092
|
+
* Reservation ticket quantities.
|
|
4093
|
+
* @maxSize 50
|
|
3434
4094
|
*/
|
|
3435
|
-
|
|
3436
|
-
/**
|
|
3437
|
-
|
|
3438
|
-
/** Bobb - AI Design Creator. */
|
|
3439
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4095
|
+
quantities?: TicketQuantity[];
|
|
4096
|
+
/** Reservation update timestamp. */
|
|
4097
|
+
_updatedDate?: Date | null;
|
|
3440
4098
|
/**
|
|
3441
|
-
*
|
|
3442
|
-
*
|
|
4099
|
+
* Reservation counts.
|
|
4100
|
+
* @maxSize 50
|
|
3443
4101
|
*/
|
|
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;
|
|
4102
|
+
counts?: ReservationCount[];
|
|
3564
4103
|
}
|
|
3565
4104
|
interface CommonMoneyNonNullableFields {
|
|
3566
4105
|
value: string;
|
|
@@ -3640,9 +4179,15 @@ export interface QueryAvailableTicketDefinitionsResponseNonNullableFields {
|
|
|
3640
4179
|
ticketDefinitions: TicketDefinitionNonNullableFields[];
|
|
3641
4180
|
}
|
|
3642
4181
|
export interface BaseEventMetadata {
|
|
3643
|
-
/**
|
|
4182
|
+
/**
|
|
4183
|
+
* App instance ID.
|
|
4184
|
+
* @format GUID
|
|
4185
|
+
*/
|
|
3644
4186
|
instanceId?: string | null;
|
|
3645
|
-
/**
|
|
4187
|
+
/**
|
|
4188
|
+
* Event type.
|
|
4189
|
+
* @maxLength 150
|
|
4190
|
+
*/
|
|
3646
4191
|
eventType?: string;
|
|
3647
4192
|
/** The identification type and identity data. */
|
|
3648
4193
|
identity?: IdentificationData;
|
|
@@ -3693,6 +4238,8 @@ export interface TicketDefinitionCreatedEnvelope {
|
|
|
3693
4238
|
* Triggered when a ticket definition is created.
|
|
3694
4239
|
* @permissionScope Manage Events - all permissions
|
|
3695
4240
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4241
|
+
* @permissionScope Manage Events
|
|
4242
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3696
4243
|
* @permissionScope Manage Orders
|
|
3697
4244
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3698
4245
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3703,41 +4250,45 @@ export interface TicketDefinitionCreatedEnvelope {
|
|
|
3703
4250
|
* @slug created
|
|
3704
4251
|
*/
|
|
3705
4252
|
export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
3706
|
-
export interface
|
|
3707
|
-
entity: TicketDefinition;
|
|
4253
|
+
export interface TicketDefinitionDeletedEnvelope {
|
|
3708
4254
|
metadata: EventMetadata;
|
|
3709
4255
|
}
|
|
3710
4256
|
/**
|
|
3711
|
-
* Triggered when a ticket definition is
|
|
4257
|
+
* Triggered when a ticket definition is deleted.
|
|
3712
4258
|
* @permissionScope Manage Events - all permissions
|
|
3713
4259
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4260
|
+
* @permissionScope Manage Events
|
|
4261
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3714
4262
|
* @permissionScope Manage Orders
|
|
3715
4263
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3716
4264
|
* @permissionScope Manage Ticket Definitions
|
|
3717
4265
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3718
4266
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3719
4267
|
* @webhook
|
|
3720
|
-
* @eventType wix.events.v3.
|
|
3721
|
-
* @slug
|
|
4268
|
+
* @eventType wix.events.v3.ticket_definition_deleted
|
|
4269
|
+
* @slug deleted
|
|
3722
4270
|
*/
|
|
3723
|
-
export declare function
|
|
3724
|
-
export interface
|
|
4271
|
+
export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
4272
|
+
export interface TicketDefinitionSaleEndedEnvelope {
|
|
4273
|
+
data: TicketDefinitionSaleEnded;
|
|
3725
4274
|
metadata: EventMetadata;
|
|
3726
4275
|
}
|
|
3727
4276
|
/**
|
|
3728
|
-
* Triggered when a ticket
|
|
4277
|
+
* Triggered when a ticket sale ends. Sales details are not included in the payload.
|
|
3729
4278
|
* @permissionScope Manage Events - all permissions
|
|
3730
4279
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4280
|
+
* @permissionScope Manage Events
|
|
4281
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3731
4282
|
* @permissionScope Manage Orders
|
|
3732
4283
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3733
4284
|
* @permissionScope Manage Ticket Definitions
|
|
3734
4285
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3735
4286
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3736
4287
|
* @webhook
|
|
3737
|
-
* @eventType wix.events.v3.
|
|
3738
|
-
* @slug
|
|
4288
|
+
* @eventType wix.events.v3.ticket_definition_sale_ended
|
|
4289
|
+
* @slug sale_ended
|
|
3739
4290
|
*/
|
|
3740
|
-
export declare function
|
|
4291
|
+
export declare function onTicketDefinitionSaleEnded(handler: (event: TicketDefinitionSaleEndedEnvelope) => void | Promise<void>): void;
|
|
3741
4292
|
export interface TicketDefinitionSalePeriodUpdatedEnvelope {
|
|
3742
4293
|
data: SalePeriodUpdated;
|
|
3743
4294
|
metadata: EventMetadata;
|
|
@@ -3746,6 +4297,8 @@ export interface TicketDefinitionSalePeriodUpdatedEnvelope {
|
|
|
3746
4297
|
* Triggered when a sale period is updated.
|
|
3747
4298
|
* @permissionScope Manage Events - all permissions
|
|
3748
4299
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4300
|
+
* @permissionScope Manage Events
|
|
4301
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3749
4302
|
* @permissionScope Manage Orders
|
|
3750
4303
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3751
4304
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3764,6 +4317,8 @@ export interface TicketDefinitionSaleStartedEnvelope {
|
|
|
3764
4317
|
* Triggered when a ticket sale starts. Sales details are not included in the payload.
|
|
3765
4318
|
* @permissionScope Manage Events - all permissions
|
|
3766
4319
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4320
|
+
* @permissionScope Manage Events
|
|
4321
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3767
4322
|
* @permissionScope Manage Orders
|
|
3768
4323
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3769
4324
|
* @permissionScope Manage Ticket Definitions
|
|
@@ -3774,24 +4329,26 @@ export interface TicketDefinitionSaleStartedEnvelope {
|
|
|
3774
4329
|
* @slug sale_started
|
|
3775
4330
|
*/
|
|
3776
4331
|
export declare function onTicketDefinitionSaleStarted(handler: (event: TicketDefinitionSaleStartedEnvelope) => void | Promise<void>): void;
|
|
3777
|
-
export interface
|
|
3778
|
-
|
|
4332
|
+
export interface TicketDefinitionUpdatedEnvelope {
|
|
4333
|
+
entity: TicketDefinition;
|
|
3779
4334
|
metadata: EventMetadata;
|
|
3780
4335
|
}
|
|
3781
4336
|
/**
|
|
3782
|
-
* Triggered when a ticket
|
|
4337
|
+
* Triggered when a ticket definition is updated.
|
|
3783
4338
|
* @permissionScope Manage Events - all permissions
|
|
3784
4339
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4340
|
+
* @permissionScope Manage Events
|
|
4341
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3785
4342
|
* @permissionScope Manage Orders
|
|
3786
4343
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
3787
4344
|
* @permissionScope Manage Ticket Definitions
|
|
3788
4345
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
3789
4346
|
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
3790
4347
|
* @webhook
|
|
3791
|
-
* @eventType wix.events.v3.
|
|
3792
|
-
* @slug
|
|
4348
|
+
* @eventType wix.events.v3.ticket_definition_updated
|
|
4349
|
+
* @slug updated
|
|
3793
4350
|
*/
|
|
3794
|
-
export declare function
|
|
4351
|
+
export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
3795
4352
|
/**
|
|
3796
4353
|
* > **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
4354
|
*
|
|
@@ -3822,7 +4379,10 @@ export declare function onTicketDefinitionSaleEnded(handler: (event: TicketDefin
|
|
|
3822
4379
|
*/
|
|
3823
4380
|
export declare function createTicketDefinition(ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
3824
4381
|
export interface CreateTicketDefinitionOptions {
|
|
3825
|
-
/**
|
|
4382
|
+
/**
|
|
4383
|
+
* Predefined sets of fields to return.
|
|
4384
|
+
* @maxSize 5
|
|
4385
|
+
*/
|
|
3826
4386
|
fields?: Field[];
|
|
3827
4387
|
}
|
|
3828
4388
|
/**
|
|
@@ -3854,10 +4414,15 @@ export declare function updateTicketDefinition(_id: string | null, ticketDefinit
|
|
|
3854
4414
|
export interface UpdateTicketDefinition {
|
|
3855
4415
|
/**
|
|
3856
4416
|
* Ticket definition ID.
|
|
4417
|
+
* @format GUID
|
|
3857
4418
|
* @readonly
|
|
3858
4419
|
*/
|
|
3859
4420
|
_id?: string | null;
|
|
3860
|
-
/**
|
|
4421
|
+
/**
|
|
4422
|
+
* Event ID to which the ticket definition belongs.
|
|
4423
|
+
* @format GUID
|
|
4424
|
+
* @immutable
|
|
4425
|
+
*/
|
|
3861
4426
|
eventId?: string | null;
|
|
3862
4427
|
/**
|
|
3863
4428
|
* 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 +4439,21 @@ export interface UpdateTicketDefinition {
|
|
|
3874
4439
|
* @readonly
|
|
3875
4440
|
*/
|
|
3876
4441
|
_updatedDate?: Date | null;
|
|
3877
|
-
/**
|
|
4442
|
+
/**
|
|
4443
|
+
* Ticket definition name.
|
|
4444
|
+
* @minLength 1
|
|
4445
|
+
* @maxLength 30
|
|
4446
|
+
*/
|
|
3878
4447
|
name?: string | null;
|
|
3879
|
-
/**
|
|
4448
|
+
/**
|
|
4449
|
+
* Ticket definition description.
|
|
4450
|
+
* @maxLength 500
|
|
4451
|
+
*/
|
|
3880
4452
|
description?: string | null;
|
|
3881
|
-
/**
|
|
4453
|
+
/**
|
|
4454
|
+
* Ticket definition policy.
|
|
4455
|
+
* @maxLength 1000
|
|
4456
|
+
*/
|
|
3882
4457
|
policyText?: string | null;
|
|
3883
4458
|
/** Whether this ticket definition is hidden to site visitors and can't be purchased. */
|
|
3884
4459
|
hidden?: boolean;
|
|
@@ -3914,6 +4489,7 @@ export interface UpdateTicketDefinition {
|
|
|
3914
4489
|
* Number of tickets that can be purchased per checkout. <br>
|
|
3915
4490
|
* **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
|
|
3916
4491
|
* @readonly
|
|
4492
|
+
* @max 50
|
|
3917
4493
|
*/
|
|
3918
4494
|
limitPerCheckout?: number | null;
|
|
3919
4495
|
/** Data extensions. */
|
|
@@ -3925,7 +4501,10 @@ export interface UpdateTicketDefinition {
|
|
|
3925
4501
|
eventDetails?: EventDetails;
|
|
3926
4502
|
}
|
|
3927
4503
|
export interface UpdateTicketDefinitionOptions {
|
|
3928
|
-
/**
|
|
4504
|
+
/**
|
|
4505
|
+
* Predefined sets of fields to return.
|
|
4506
|
+
* @maxSize 5
|
|
4507
|
+
*/
|
|
3929
4508
|
fields?: Field[];
|
|
3930
4509
|
}
|
|
3931
4510
|
/**
|
|
@@ -3951,7 +4530,10 @@ export interface UpdateTicketDefinitionOptions {
|
|
|
3951
4530
|
*/
|
|
3952
4531
|
export declare function getTicketDefinition(ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
3953
4532
|
export interface GetTicketDefinitionOptions {
|
|
3954
|
-
/**
|
|
4533
|
+
/**
|
|
4534
|
+
* Predefined sets of fields to return.
|
|
4535
|
+
* @maxSize 5
|
|
4536
|
+
*/
|
|
3955
4537
|
fields?: Field[];
|
|
3956
4538
|
}
|
|
3957
4539
|
/**
|
|
@@ -3991,12 +4573,34 @@ export declare function deleteTicketDefinition(ticketDefinitionId: string): Prom
|
|
|
3991
4573
|
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.ReorderTicketDefinitions
|
|
3992
4574
|
*/
|
|
3993
4575
|
export declare function reorderTicketDefinitions(eventId: string, options?: ReorderTicketDefinitionsOptions): Promise<void>;
|
|
3994
|
-
export interface ReorderTicketDefinitionsOptions extends
|
|
3995
|
-
/**
|
|
4576
|
+
export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4577
|
+
/**
|
|
4578
|
+
* Ticket definition ID.
|
|
4579
|
+
* @format GUID
|
|
4580
|
+
*/
|
|
3996
4581
|
ticketDefinitionId: string;
|
|
3997
|
-
/**
|
|
4582
|
+
/**
|
|
4583
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
4584
|
+
* @format GUID
|
|
4585
|
+
*/
|
|
3998
4586
|
beforeDefinitionId?: string;
|
|
3999
|
-
/**
|
|
4587
|
+
/**
|
|
4588
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
4589
|
+
* @format GUID
|
|
4590
|
+
*/
|
|
4591
|
+
afterDefinitionId?: string;
|
|
4592
|
+
}
|
|
4593
|
+
/** @oneof */
|
|
4594
|
+
interface ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4595
|
+
/**
|
|
4596
|
+
* Move the given `definitionId` before the referenced ticket definition.
|
|
4597
|
+
* @format GUID
|
|
4598
|
+
*/
|
|
4599
|
+
beforeDefinitionId?: string;
|
|
4600
|
+
/**
|
|
4601
|
+
* Move the given `definitionId` after the referenced ticket definition.
|
|
4602
|
+
* @format GUID
|
|
4603
|
+
*/
|
|
4000
4604
|
afterDefinitionId?: string;
|
|
4001
4605
|
}
|
|
4002
4606
|
/**
|
|
@@ -4023,7 +4627,10 @@ export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinition
|
|
|
4023
4627
|
*/
|
|
4024
4628
|
export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;
|
|
4025
4629
|
export interface QueryTicketDefinitionsOptions {
|
|
4026
|
-
/**
|
|
4630
|
+
/**
|
|
4631
|
+
* Predefined sets of fields to return.
|
|
4632
|
+
* @maxSize 5
|
|
4633
|
+
*/
|
|
4027
4634
|
fields?: Field[] | undefined;
|
|
4028
4635
|
}
|
|
4029
4636
|
interface QueryCursorResult {
|
|
@@ -4107,7 +4714,10 @@ export interface TicketDefinitionsQueryBuilder {
|
|
|
4107
4714
|
*/
|
|
4108
4715
|
export declare function queryAvailableTicketDefinitions(query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions): Promise<QueryAvailableTicketDefinitionsResponse & QueryAvailableTicketDefinitionsResponseNonNullableFields>;
|
|
4109
4716
|
export interface QueryAvailableTicketDefinitionsOptions {
|
|
4110
|
-
/**
|
|
4717
|
+
/**
|
|
4718
|
+
* Predefined sets of fields to return.
|
|
4719
|
+
* @maxSize 5
|
|
4720
|
+
*/
|
|
4111
4721
|
fields?: Field[];
|
|
4112
4722
|
}
|
|
4113
4723
|
/**
|
|
@@ -4134,6 +4744,8 @@ export interface CountTicketDefinitionsOptions {
|
|
|
4134
4744
|
* Parameters to count ticket definitions by.
|
|
4135
4745
|
*
|
|
4136
4746
|
* - Max: 20 facets.
|
|
4747
|
+
* @maxLength 100
|
|
4748
|
+
* @maxSize 20
|
|
4137
4749
|
*/
|
|
4138
4750
|
facet?: string[];
|
|
4139
4751
|
}
|
|
@@ -4197,7 +4809,11 @@ export declare function bulkDeleteTicketDefinitionsByFilter(filter: Record<strin
|
|
|
4197
4809
|
*/
|
|
4198
4810
|
export declare function changeCurrency(eventId: string, options: ChangeCurrencyOptions): Promise<void>;
|
|
4199
4811
|
export interface ChangeCurrencyOptions {
|
|
4200
|
-
/**
|
|
4812
|
+
/**
|
|
4813
|
+
* Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
4814
|
+
* @minLength 3
|
|
4815
|
+
* @maxLength 3
|
|
4816
|
+
*/
|
|
4201
4817
|
currency: string;
|
|
4202
4818
|
}
|
|
4203
4819
|
export {};
|