@wix/events 1.0.161 → 1.0.162

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.
Files changed (61) hide show
  1. package/build/cjs/context.d.ts +1 -0
  2. package/build/cjs/context.js +2 -1
  3. package/build/cjs/context.js.map +1 -1
  4. package/build/cjs/index.d.ts +1 -0
  5. package/build/cjs/index.js +2 -1
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/index.typings.d.ts +1 -0
  8. package/build/cjs/index.typings.js +2 -1
  9. package/build/cjs/index.typings.js.map +1 -1
  10. package/build/cjs/meta.d.ts +1 -0
  11. package/build/cjs/meta.js +2 -1
  12. package/build/cjs/meta.js.map +1 -1
  13. package/build/cjs/src/events-v3-ticket-definition.context.d.ts +9 -0
  14. package/build/cjs/src/events-v3-ticket-definition.context.js +82 -0
  15. package/build/cjs/src/events-v3-ticket-definition.context.js.map +1 -0
  16. package/build/cjs/src/events-v3-ticket-definition.http.d.ts +33 -0
  17. package/build/cjs/src/events-v3-ticket-definition.http.js +283 -0
  18. package/build/cjs/src/events-v3-ticket-definition.http.js.map +1 -0
  19. package/build/cjs/src/events-v3-ticket-definition.meta.d.ts +25 -0
  20. package/build/cjs/src/events-v3-ticket-definition.meta.js +161 -0
  21. package/build/cjs/src/events-v3-ticket-definition.meta.js.map +1 -0
  22. package/build/cjs/src/events-v3-ticket-definition.public.d.ts +99 -0
  23. package/build/cjs/src/events-v3-ticket-definition.public.js +76 -0
  24. package/build/cjs/src/events-v3-ticket-definition.public.js.map +1 -0
  25. package/build/cjs/src/events-v3-ticket-definition.types.d.ts +2072 -0
  26. package/build/cjs/src/events-v3-ticket-definition.types.js +303 -0
  27. package/build/cjs/src/events-v3-ticket-definition.types.js.map +1 -0
  28. package/build/cjs/src/events-v3-ticket-definition.universal.d.ts +2266 -0
  29. package/build/cjs/src/events-v3-ticket-definition.universal.js +806 -0
  30. package/build/cjs/src/events-v3-ticket-definition.universal.js.map +1 -0
  31. package/build/es/context.d.ts +1 -0
  32. package/build/es/context.js +1 -0
  33. package/build/es/context.js.map +1 -1
  34. package/build/es/index.d.ts +1 -0
  35. package/build/es/index.js +1 -0
  36. package/build/es/index.js.map +1 -1
  37. package/build/es/index.typings.d.ts +1 -0
  38. package/build/es/index.typings.js +1 -0
  39. package/build/es/index.typings.js.map +1 -1
  40. package/build/es/meta.d.ts +1 -0
  41. package/build/es/meta.js +1 -0
  42. package/build/es/meta.js.map +1 -1
  43. package/build/es/src/events-v3-ticket-definition.context.d.ts +9 -0
  44. package/build/es/src/events-v3-ticket-definition.context.js +72 -0
  45. package/build/es/src/events-v3-ticket-definition.context.js.map +1 -0
  46. package/build/es/src/events-v3-ticket-definition.http.d.ts +33 -0
  47. package/build/es/src/events-v3-ticket-definition.http.js +273 -0
  48. package/build/es/src/events-v3-ticket-definition.http.js.map +1 -0
  49. package/build/es/src/events-v3-ticket-definition.meta.d.ts +25 -0
  50. package/build/es/src/events-v3-ticket-definition.meta.js +128 -0
  51. package/build/es/src/events-v3-ticket-definition.meta.js.map +1 -0
  52. package/build/es/src/events-v3-ticket-definition.public.d.ts +99 -0
  53. package/build/es/src/events-v3-ticket-definition.public.js +40 -0
  54. package/build/es/src/events-v3-ticket-definition.public.js.map +1 -0
  55. package/build/es/src/events-v3-ticket-definition.types.d.ts +2072 -0
  56. package/build/es/src/events-v3-ticket-definition.types.js +300 -0
  57. package/build/es/src/events-v3-ticket-definition.types.js.map +1 -0
  58. package/build/es/src/events-v3-ticket-definition.universal.d.ts +2266 -0
  59. package/build/es/src/events-v3-ticket-definition.universal.js +773 -0
  60. package/build/es/src/events-v3-ticket-definition.universal.js.map +1 -0
  61. package/package.json +2 -2
@@ -0,0 +1,2072 @@
1
+ export interface TicketDefinition {
2
+ /**
3
+ * Ticket definition ID.
4
+ * @readonly
5
+ */
6
+ id?: string | null;
7
+ /** Event ID to which the ticket definition belongs. */
8
+ eventId?: string | null;
9
+ /**
10
+ * 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.
11
+ * @readonly
12
+ */
13
+ revision?: string | null;
14
+ /**
15
+ * Date and time when the ticket definition was created in `yyyy-mm-ddThh:mm:sssZ` format.
16
+ * @readonly
17
+ */
18
+ createdDate?: Date;
19
+ /**
20
+ * Date and time of the ticket definition's latest update in `yyyy-mm-ddThh:mm:sssZ` format.
21
+ * @readonly
22
+ */
23
+ updatedDate?: Date;
24
+ name?: string | null;
25
+ description?: string | null;
26
+ policyText?: string | null;
27
+ /** Whether this ticket definition is hidden to customers and cannot be purchased. */
28
+ hidden?: boolean;
29
+ /**
30
+ * Whether the ticket has a limited maximum quantity.
31
+ * @readonly
32
+ */
33
+ limited?: boolean;
34
+ /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */
35
+ initialLimit?: number | null;
36
+ /**
37
+ * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.
38
+ * @readonly
39
+ */
40
+ actualLimit?: number | null;
41
+ /** Ticket pricing method. */
42
+ pricingMethod?: PricingMethod;
43
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. <br> <br> `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75 <br> <br> `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total. */
44
+ feeType?: Type;
45
+ /** Ticket sale period. */
46
+ salePeriod?: SalePeriod;
47
+ /**
48
+ * Ticket sale status. <br> <br> `SALE_SCHEDULED`: Tickets are not on sale yet. <br> <br> `SALE_STARTED`: Tickets are on sale. <br> <br> `SALE_ENDED`: Tickets are not on sale.
49
+ * @readonly
50
+ */
51
+ saleStatus?: SaleStatusEnumStatus;
52
+ /** Ticket sales information. */
53
+ salesDetails?: SalesDetails;
54
+ /**
55
+ * Limit of tickets that can be purchased per checkout.
56
+ * Takes the smaller value between event ticket_limit_per_order, actual_limit and sales_details.unsold_count values.
57
+ * @readonly
58
+ */
59
+ limitPerCheckout?: number | null;
60
+ }
61
+ export interface PricingMethod extends PricingMethodPriceOneOf {
62
+ /** Same ticket price for everyone. */
63
+ fixedPrice?: CommonMoney;
64
+ /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */
65
+ guestPrice?: CommonMoney;
66
+ /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
67
+ pricingOptions?: PricingOptions;
68
+ /**
69
+ * Ticket price type. <br> <br> `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. <br> <br> `DONATION`: All collected money is a donation. This pricing type is automatically assigned when the `guestPrice` pricing method is selected.
70
+ * @readonly
71
+ */
72
+ pricingType?: PricingTypeEnumType;
73
+ /**
74
+ * Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.
75
+ * @readonly
76
+ */
77
+ free?: boolean;
78
+ }
79
+ /** @oneof */
80
+ export interface PricingMethodPriceOneOf {
81
+ /** Same ticket price for everyone. */
82
+ fixedPrice?: CommonMoney;
83
+ /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */
84
+ guestPrice?: CommonMoney;
85
+ /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
86
+ pricingOptions?: PricingOptions;
87
+ }
88
+ /**
89
+ * Money.
90
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
91
+ */
92
+ export interface CommonMoney {
93
+ /** 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. */
94
+ value?: string;
95
+ /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */
96
+ currency?: string;
97
+ }
98
+ export interface PricingOptions {
99
+ /** Ticket price option details. */
100
+ optionDetails?: OptionDetails[];
101
+ }
102
+ export interface OptionDetails {
103
+ /** Ticket price option ID. */
104
+ optionId?: string | null;
105
+ /** Ticket price option name, such as "Child Ticket". */
106
+ name?: string | null;
107
+ /** Ticket price. */
108
+ price?: CommonMoney;
109
+ }
110
+ export declare enum PricingTypeEnumType {
111
+ UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
112
+ STANDARD = "STANDARD",
113
+ DONATION = "DONATION"
114
+ }
115
+ export declare enum Type {
116
+ UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
117
+ /** Seller absorbs the fee. It is deducted from the ticket price. */
118
+ FEE_INCLUDED = "FEE_INCLUDED",
119
+ /** Fee is added to the ticket price at checkout. */
120
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
121
+ /** Service fee is not collected - available only for free tickets and legacy users. */
122
+ NO_FEE = "NO_FEE"
123
+ }
124
+ export interface SalePeriod {
125
+ /** Ticket sale start timestamp in `yyyy-mm-ddThh:mm:sssZ` format. */
126
+ startDate?: Date;
127
+ /** Ticket sale end timestamp in `yyyy-mm-ddThh:mm:sssZ` format. */
128
+ endDate?: Date;
129
+ /** Whether to display the ticket if it's not available to buy. */
130
+ displayNotOnSale?: boolean;
131
+ }
132
+ export declare enum SaleStatusEnumStatus {
133
+ UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
134
+ /** Ticket sale is scheduled to start */
135
+ SALE_SCHEDULED = "SALE_SCHEDULED",
136
+ /** Ticket sale has started */
137
+ SALE_STARTED = "SALE_STARTED",
138
+ /** Ticket sale has ended */
139
+ SALE_ENDED = "SALE_ENDED"
140
+ }
141
+ export interface SalesDetails {
142
+ /**
143
+ * Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
144
+ * @readonly
145
+ */
146
+ unsoldCount?: number | null;
147
+ /**
148
+ * Number of purchased tickets.
149
+ * @readonly
150
+ */
151
+ soldCount?: number | null;
152
+ /**
153
+ * Number of reserved tickets.
154
+ * @readonly
155
+ */
156
+ reservedCount?: number | null;
157
+ /**
158
+ * Whether the tickets are sold out.
159
+ * @readonly
160
+ */
161
+ soldOut?: boolean | null;
162
+ }
163
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
164
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
165
+ metaSiteId?: string;
166
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
167
+ siteId?: string;
168
+ /** Invalidate by App */
169
+ app?: App;
170
+ /** Invalidate by page id */
171
+ page?: Page;
172
+ /** Invalidate by URI path */
173
+ uri?: URI;
174
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
175
+ reason?: string | null;
176
+ /** Is local DS */
177
+ localDc?: boolean;
178
+ }
179
+ /** @oneof */
180
+ export interface InvalidateCacheGetByOneOf {
181
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
182
+ metaSiteId?: string;
183
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
184
+ siteId?: string;
185
+ /** Invalidate by App */
186
+ app?: App;
187
+ /** Invalidate by page id */
188
+ page?: Page;
189
+ /** Invalidate by URI path */
190
+ uri?: URI;
191
+ }
192
+ export interface App {
193
+ /** The AppDefId */
194
+ appDefId?: string;
195
+ /** The instance Id */
196
+ instanceId?: string;
197
+ }
198
+ export interface Page {
199
+ /** the msid the page is on */
200
+ metaSiteId?: string;
201
+ /** Invalidate by Page ID */
202
+ pageId?: string;
203
+ }
204
+ export interface URI {
205
+ /** the msid the URI is on */
206
+ metaSiteId?: string;
207
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
208
+ uriPath?: string;
209
+ }
210
+ export interface GetTicketDefinitionSummaryRequest {
211
+ /** Ticket definition id. */
212
+ ticketDefinitionId?: string | null;
213
+ }
214
+ export interface GetTicketDefinitionSummaryResponse {
215
+ /** Summary. */
216
+ summary?: TicketDefinitionSummary;
217
+ }
218
+ export interface TicketDefinitionSummary {
219
+ /**
220
+ * Ticket definition ID.
221
+ * @readonly
222
+ */
223
+ definitionId?: string | null;
224
+ /**
225
+ * Event ID to which the ticket definition summary belongs.
226
+ * @readonly
227
+ */
228
+ eventId?: string | null;
229
+ /**
230
+ * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
231
+ * @readonly
232
+ */
233
+ updatedDate?: Date;
234
+ /**
235
+ * Reserved count.
236
+ * @readonly
237
+ */
238
+ reservedCount?: number;
239
+ /**
240
+ * Sold count.
241
+ * @readonly
242
+ */
243
+ soldCount?: number;
244
+ /**
245
+ * Paid exists.
246
+ * @readonly
247
+ */
248
+ paidExists?: boolean;
249
+ }
250
+ export interface ListEventTicketingSummaryRequest {
251
+ /** Event ID. */
252
+ eventId?: string[];
253
+ }
254
+ export interface ListEventTicketingSummaryResponse {
255
+ /** Ticketing summaries. */
256
+ summaries?: EventTicketingSummary[];
257
+ }
258
+ export interface EventTicketingSummary {
259
+ /**
260
+ * Event ID to which the ticketing summary belongs.
261
+ * @readonly
262
+ */
263
+ eventId?: string | null;
264
+ /**
265
+ * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
266
+ * @readonly
267
+ */
268
+ updatedDate?: Date;
269
+ /**
270
+ * Whether all tickets are sold for this event.
271
+ * @readonly
272
+ */
273
+ soldOut?: boolean | null;
274
+ /**
275
+ * Price of lowest priced ticket.
276
+ * @readonly
277
+ */
278
+ lowestTicketPrice?: CommonMoney;
279
+ /**
280
+ * Price of highest priced ticket.
281
+ * @readonly
282
+ */
283
+ highestTicketPrice?: CommonMoney;
284
+ /** Currency used in event transactions. */
285
+ currency?: string | null;
286
+ /**
287
+ * Formatted price of lowest priced ticket.
288
+ * @readonly
289
+ */
290
+ lowestTicketPriceFormatted?: string | null;
291
+ /**
292
+ * Formatted price of highest priced ticket.
293
+ * @readonly
294
+ */
295
+ highestTicketPriceFormatted?: string | null;
296
+ }
297
+ export interface DomainEvent extends DomainEventBodyOneOf {
298
+ createdEvent?: EntityCreatedEvent;
299
+ updatedEvent?: EntityUpdatedEvent;
300
+ deletedEvent?: EntityDeletedEvent;
301
+ actionEvent?: ActionEvent;
302
+ /**
303
+ * Unique event ID.
304
+ * Allows clients to ignore duplicate webhooks.
305
+ */
306
+ id?: string;
307
+ /**
308
+ * Assumes actions are also always typed to an entity_type
309
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
310
+ */
311
+ entityFqdn?: string;
312
+ /**
313
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
314
+ * This is although the created/updated/deleted notion is duplication of the oneof types
315
+ * Example: created/updated/deleted/started/completed/email_opened
316
+ */
317
+ slug?: string;
318
+ /** ID of the entity associated with the event. */
319
+ entityId?: string;
320
+ /** Event timestamp. */
321
+ eventTime?: Date;
322
+ /**
323
+ * Whether the event was triggered as a result of a privacy regulation application
324
+ * (for example, GDPR).
325
+ */
326
+ triggeredByAnonymizeRequest?: boolean | null;
327
+ /** If present, indicates the action that triggered the event. */
328
+ originatedFrom?: string | null;
329
+ /**
330
+ * A sequence number defining the order of updates to the underlying entity.
331
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
332
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
333
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
334
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
335
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
336
+ */
337
+ entityEventSequence?: string | null;
338
+ }
339
+ /** @oneof */
340
+ export interface DomainEventBodyOneOf {
341
+ createdEvent?: EntityCreatedEvent;
342
+ updatedEvent?: EntityUpdatedEvent;
343
+ deletedEvent?: EntityDeletedEvent;
344
+ actionEvent?: ActionEvent;
345
+ }
346
+ export interface EntityCreatedEvent {
347
+ entityAsJson?: string;
348
+ }
349
+ export interface EntityUpdatedEvent {
350
+ /**
351
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
352
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
353
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
354
+ */
355
+ currentEntityAsJson?: string;
356
+ }
357
+ export interface EntityDeletedEvent {
358
+ /** Entity that was deleted */
359
+ deletedEntityAsJson?: string | null;
360
+ }
361
+ export interface ActionEvent {
362
+ bodyAsJson?: string;
363
+ }
364
+ export interface Empty {
365
+ }
366
+ export interface ReservationCreated {
367
+ /** Reservation created timestamp in ISO UTC format. */
368
+ timestamp?: Date;
369
+ /** Event ID. */
370
+ eventId?: string;
371
+ /**
372
+ * Reservation ID.
373
+ * Can be used to retrieve a reservation invoice.
374
+ */
375
+ reservationId?: string;
376
+ /** Reservation expiration timestamp. */
377
+ expires?: Date;
378
+ /** Reservation status. */
379
+ status?: ReservationStatus;
380
+ /** Reservation ticket quantities. */
381
+ quantities?: TicketQuantity[];
382
+ /** Reservation update timestamp. */
383
+ updatedDate?: Date;
384
+ /** Reservation counts. */
385
+ counts?: ReservationCount[];
386
+ }
387
+ export declare enum ReservationStatus {
388
+ /**
389
+ * Reservation is pending confirmation.
390
+ * The reservation will expire after the expiration due time.
391
+ */
392
+ RESERVATION_PENDING = "RESERVATION_PENDING",
393
+ /** The reservation was confirmed and will not expire. */
394
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
395
+ /** The reservation was canceled because of non payment. */
396
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
397
+ /** The reservation was canceled manually by the buyer. */
398
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
399
+ /** The reservation has expired. */
400
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
401
+ }
402
+ export interface TicketQuantity {
403
+ /** Ticket definition ID. */
404
+ ticketDefinitionId?: string | null;
405
+ /** Quantity. */
406
+ quantity?: number | null;
407
+ /** Quantity update timestamp. */
408
+ updatedDate?: Date;
409
+ }
410
+ export interface ReservationCount {
411
+ /** Reservation Count snapshot timestamp. */
412
+ timestamp?: Date;
413
+ /** Ticket Definition ID. */
414
+ ticketDefinitionId?: string;
415
+ /** Confirmed reservation count. */
416
+ confirmedCount?: number;
417
+ /** Pending reservation count. */
418
+ pendingCount?: number;
419
+ /** True if paid ticket reservation exist. */
420
+ paidExists?: boolean;
421
+ }
422
+ export interface ReservationUpdated {
423
+ /** Reservation updated timestamp. */
424
+ timestamp?: Date;
425
+ /** Event ID. */
426
+ eventId?: string;
427
+ /**
428
+ * Reservation ID.
429
+ * Can be used to retrieve a reservation invoice.
430
+ */
431
+ reservationId?: string;
432
+ /** Reservation status. */
433
+ status?: ReservationStatus;
434
+ /** Reservation expiration timestamp. */
435
+ expires?: Date;
436
+ /** Reservation ticket quantities. */
437
+ quantities?: TicketQuantity[];
438
+ /** Reservation update timestamp. */
439
+ updatedDate?: Date;
440
+ /** Reservation counts. */
441
+ counts?: ReservationCount[];
442
+ }
443
+ export interface EventDeleted {
444
+ /** Event deleted timestamp in ISO UTC format. */
445
+ timestamp?: Date;
446
+ /** Event ID. */
447
+ eventId?: string;
448
+ /** Event title. */
449
+ title?: string;
450
+ /** Event creator user ID. */
451
+ userId?: string | null;
452
+ }
453
+ export interface UpdateEventTicketingSummaryRequest {
454
+ /** Event ID. */
455
+ eventId?: string;
456
+ }
457
+ export interface CreateTicketDefinitionRequest {
458
+ /** Ticket definition info. */
459
+ ticketDefinition: TicketDefinition;
460
+ /** Requested fields. */
461
+ fields?: Field[];
462
+ }
463
+ export declare enum Field {
464
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
465
+ /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
466
+ SALES_DETAILS = "SALES_DETAILS"
467
+ }
468
+ export interface CreateTicketDefinitionResponse {
469
+ /** Created ticket definition. */
470
+ ticketDefinition?: TicketDefinition;
471
+ }
472
+ export interface UpdateTicketDefinitionRequest {
473
+ /** Ticket definition to update. */
474
+ ticketDefinition: TicketDefinition;
475
+ /** Requested fields. */
476
+ fields?: Field[];
477
+ }
478
+ export interface UpdateTicketDefinitionResponse {
479
+ /** The updated ticket definition. */
480
+ ticketDefinition?: TicketDefinition;
481
+ }
482
+ export interface SalePeriodUpdated {
483
+ /** Ticket definition sale period after update. */
484
+ afterUpdate?: SalePeriod;
485
+ }
486
+ export interface GetTicketDefinitionRequest {
487
+ /** Ticket definition ID. */
488
+ ticketDefinitionId: string;
489
+ /**
490
+ * Predefined sets of fields to return.
491
+ * - `SALES_DETAILS`: Returns `salesDetails`.
492
+ */
493
+ fields?: Field[];
494
+ }
495
+ export interface GetTicketDefinitionResponse {
496
+ /** The requested ticket definition. */
497
+ ticketDefinition?: TicketDefinition;
498
+ }
499
+ export interface DeleteTicketDefinitionRequest {
500
+ /** ID of the ticket definition to delete. */
501
+ ticketDefinitionId: string;
502
+ }
503
+ export interface DeleteTicketDefinitionResponse {
504
+ }
505
+ export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
506
+ /** Move the given `definitionId` before the referenced ticket definition. */
507
+ beforeDefinitionId?: string;
508
+ /** Move the given `definitionId` after the referenced ticket definition. */
509
+ afterDefinitionId?: string;
510
+ /** Event ID. */
511
+ eventId: string;
512
+ /** Ticket definition ID. */
513
+ ticketDefinitionId: string;
514
+ }
515
+ /** @oneof */
516
+ export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
517
+ /** Move the given `definitionId` before the referenced ticket definition. */
518
+ beforeDefinitionId?: string;
519
+ /** Move the given `definitionId` after the referenced ticket definition. */
520
+ afterDefinitionId?: string;
521
+ }
522
+ export interface ReorderTicketDefinitionsResponse {
523
+ }
524
+ export interface UpdateTicketDefinitionSortIndexRequest {
525
+ /** Ticket definition ID */
526
+ ticketDefinitionId?: string;
527
+ /** The revision of the ticket definition */
528
+ revision?: string;
529
+ /** the sort index of a ticket definition to set */
530
+ sortIndex?: number;
531
+ /** Requested fields. */
532
+ fields?: Field[];
533
+ }
534
+ export interface UpdateTicketDefinitionSortIndexResponse {
535
+ /** the updated ticket definition */
536
+ ticketDefinition?: TicketDefinition;
537
+ }
538
+ export interface QueryTicketDefinitionsRequest {
539
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
540
+ query: QueryV2;
541
+ /**
542
+ * Predefined sets of fields to return.
543
+ * - `SALES_DETAILS`: Returns `salesDetails`.
544
+ */
545
+ fields?: Field[];
546
+ }
547
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
548
+ /** Paging options to limit and skip the number of items. */
549
+ paging?: Paging;
550
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
551
+ cursorPaging?: CursorPaging;
552
+ /** 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"} }` */
553
+ filter?: Record<string, any> | null;
554
+ /** 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. */
555
+ sort?: Sorting[];
556
+ }
557
+ /** @oneof */
558
+ export interface QueryV2PagingMethodOneOf {
559
+ /** Paging options to limit and skip the number of items. */
560
+ paging?: Paging;
561
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
562
+ cursorPaging?: CursorPaging;
563
+ }
564
+ export interface Sorting {
565
+ /** Name of the field to sort by. */
566
+ fieldName?: string;
567
+ /** Defaults to `ASC` */
568
+ order?: SortOrder;
569
+ }
570
+ export declare enum SortOrder {
571
+ ASC = "ASC",
572
+ DESC = "DESC"
573
+ }
574
+ export interface Paging {
575
+ /** Number of items to load per page. */
576
+ limit?: number | null;
577
+ /** Number of items to skip in the current sort order. */
578
+ offset?: number | null;
579
+ }
580
+ export interface CursorPaging {
581
+ /** Number of items to load per page. */
582
+ limit?: number | null;
583
+ /**
584
+ * Pointer to the next or previous page in the list of results.
585
+ * You can get the relevant cursor token
586
+ * from the `pagingMetadata` object in the previous call's response.
587
+ * Not relevant for the first request.
588
+ */
589
+ cursor?: string | null;
590
+ }
591
+ export interface QueryTicketDefinitionsResponse {
592
+ /** List of ticket definitions. */
593
+ ticketDefinitions?: TicketDefinition[];
594
+ /** Metadata for the paginated results. */
595
+ metadata?: PagingMetadataV2;
596
+ }
597
+ export interface PagingMetadataV2 {
598
+ /** Number of items returned in the response. */
599
+ count?: number | null;
600
+ /** Offset that was requested. */
601
+ offset?: number | null;
602
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
603
+ total?: number | null;
604
+ /** Flag that indicates the server failed to calculate the `total` field. */
605
+ tooManyToCount?: boolean | null;
606
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
607
+ cursors?: Cursors;
608
+ }
609
+ export interface Cursors {
610
+ /** Cursor pointing to next page in the list of results. */
611
+ next?: string | null;
612
+ /** Cursor pointing to previous page in the list of results. */
613
+ prev?: string | null;
614
+ }
615
+ export interface QueryAvailableTicketDefinitionsRequest {
616
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
617
+ query?: QueryV2;
618
+ /** Requested fields. */
619
+ fields?: Field[];
620
+ }
621
+ export interface QueryAvailableTicketDefinitionsResponse {
622
+ /** List of ticket definitions. */
623
+ ticketDefinitions?: TicketDefinition[];
624
+ /** Metadata for the paginated results. */
625
+ metadata?: PagingMetadataV2;
626
+ }
627
+ export interface CountTicketDefinitionsRequest {
628
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
629
+ filter?: Record<string, any> | null;
630
+ /**
631
+ * Parameters to count ticket definitions by.
632
+ *
633
+ * - Max: 20 facets.
634
+ */
635
+ facet?: string[];
636
+ }
637
+ export interface CountTicketDefinitionsResponse {
638
+ /** Metadata for the paginated results. */
639
+ metadata?: PagingMetadataV2;
640
+ /** Filter facets. */
641
+ facets?: Record<string, FacetCounts>;
642
+ }
643
+ export interface FacetCounts {
644
+ /** Facet counts aggregated per value */
645
+ counts?: Record<string, number>;
646
+ }
647
+ export interface CountAvailableTicketDefinitionsRequest {
648
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
649
+ filter?: Record<string, any> | null;
650
+ }
651
+ export interface CountAvailableTicketDefinitionsResponse {
652
+ /** Metadata for the paginated results. */
653
+ metadata?: PagingMetadataV2;
654
+ /** Filter facets. */
655
+ facets?: Record<string, FacetCounts>;
656
+ }
657
+ export interface BulkDeleteTicketDefinitionsByFilterRequest {
658
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }` */
659
+ filter: Record<string, any> | null;
660
+ }
661
+ export interface BulkDeleteTicketDefinitionsByFilterResponse {
662
+ }
663
+ export interface ChangeCurrencyRequest {
664
+ /** Event ID. */
665
+ eventId?: string;
666
+ /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
667
+ currency?: string;
668
+ }
669
+ export interface ChangeCurrencyResponse {
670
+ }
671
+ export interface BulkCopyTicketDefinitionsByEventIdRequest {
672
+ /** Origin instance ID. */
673
+ originInstanceId?: string | null;
674
+ /** Origin Event ID. */
675
+ originEventId?: string;
676
+ /** Target Event ID. */
677
+ targetEventId?: string;
678
+ }
679
+ export interface BulkCopyTicketDefinitionsByEventIdResponse {
680
+ /** Copied ticket definitions. */
681
+ definitions?: CopiedTicketDefinition[];
682
+ }
683
+ export interface CopiedTicketDefinition {
684
+ /** Origin Ticket definition ID. */
685
+ originTicketDefinitionId?: string;
686
+ /** Ticket definition ID. */
687
+ ticketDefinitionId?: string;
688
+ }
689
+ export interface EventCanceled {
690
+ /** Event canceled timestamp in ISO UTC format. */
691
+ timestamp?: Date;
692
+ /** Event ID. */
693
+ eventId?: string;
694
+ /** Event title */
695
+ title?: string;
696
+ /** Event creator user ID. */
697
+ userId?: string | null;
698
+ }
699
+ export interface EventEnded {
700
+ /** Event end timestamp in ISO UTC format. */
701
+ timestamp?: Date;
702
+ /** Event ID. */
703
+ eventId?: string;
704
+ }
705
+ export interface EventCreated {
706
+ /** Event created timestamp in ISO UTC format. */
707
+ timestamp?: Date;
708
+ /** Event ID. */
709
+ eventId?: string;
710
+ /** Event location. */
711
+ location?: Location;
712
+ /** Event schedule configuration. */
713
+ scheduleConfig?: ScheduleConfig;
714
+ /** Event title. */
715
+ title?: string;
716
+ /** Event creator user ID. */
717
+ userId?: string | null;
718
+ /** Event status. */
719
+ status?: EventStatus;
720
+ /** Instance ID. Indicates the original app instance which current event was derived from. */
721
+ derivedFromInstanceId?: string | null;
722
+ /** Event ID. Indicates the original event which current event was derived from. */
723
+ derivedFromEventId?: string | null;
724
+ /** Event that was created. */
725
+ event?: Event;
726
+ }
727
+ export interface Location {
728
+ /** Location name. */
729
+ name?: string | null;
730
+ /** Location map coordinates. */
731
+ coordinates?: MapCoordinates;
732
+ /** Single line address representation. */
733
+ address?: string | null;
734
+ /** Location type. */
735
+ type?: LocationType;
736
+ /**
737
+ * Full address derived from formatted single line `address`.
738
+ * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
739
+ * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
740
+ *
741
+ * Migration notes:
742
+ * - `full_address.formatted_address` is equivalent to `address`.
743
+ * - `full_address.geocode` is equivalent to `coordinates`.
744
+ */
745
+ fullAddress?: Address;
746
+ /**
747
+ * Defines event location as TBD (To Be Determined).
748
+ * When event location is not yet defined, `name` is displayed instead of location address.
749
+ * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
750
+ */
751
+ tbd?: boolean | null;
752
+ }
753
+ export interface MapCoordinates {
754
+ /** Latitude. */
755
+ lat?: number;
756
+ /** Longitude. */
757
+ lng?: number;
758
+ }
759
+ export declare enum LocationType {
760
+ VENUE = "VENUE",
761
+ ONLINE = "ONLINE"
762
+ }
763
+ /** Physical address */
764
+ export interface Address extends AddressStreetOneOf {
765
+ /** a break down of the street to number and street name */
766
+ streetAddress?: StreetAddress;
767
+ /** Main address line (usually street and number) as free text */
768
+ addressLine?: string | null;
769
+ /** country code */
770
+ country?: string | null;
771
+ /** subdivision (usually state or region) code according to ISO 3166-2 */
772
+ subdivision?: string | null;
773
+ /** city name */
774
+ city?: string | null;
775
+ /** zip/postal code */
776
+ postalCode?: string | null;
777
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
778
+ addressLine2?: string | null;
779
+ /** A string containing the human-readable address of this location */
780
+ formattedAddress?: string | null;
781
+ /** Free text for human-to-human textual orientation aid purposes */
782
+ hint?: string | null;
783
+ /** coordinates of the physical address */
784
+ geocode?: AddressLocation;
785
+ /** country full-name */
786
+ countryFullname?: string | null;
787
+ /** multi-level subdivisions from top to bottom */
788
+ subdivisions?: Subdivision[];
789
+ }
790
+ /** @oneof */
791
+ export interface AddressStreetOneOf {
792
+ /** a break down of the street to number and street name */
793
+ streetAddress?: StreetAddress;
794
+ /** Main address line (usually street and number) as free text */
795
+ addressLine?: string | null;
796
+ }
797
+ export interface StreetAddress {
798
+ /** street number */
799
+ number?: string;
800
+ /** street name */
801
+ name?: string;
802
+ }
803
+ export interface AddressLocation {
804
+ /** address latitude coordinates */
805
+ latitude?: number | null;
806
+ /** address longitude coordinates */
807
+ longitude?: number | null;
808
+ }
809
+ export interface Subdivision {
810
+ /** subdivision short code */
811
+ code?: string;
812
+ /** subdivision full-name */
813
+ name?: string;
814
+ }
815
+ export declare enum SubdivisionType {
816
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
817
+ /** State */
818
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
819
+ /** County */
820
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
821
+ /** City/town */
822
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
823
+ /** Neighborhood/quarter */
824
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
825
+ /** Street/block */
826
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
827
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
828
+ COUNTRY = "COUNTRY"
829
+ }
830
+ export interface ScheduleConfig {
831
+ /**
832
+ * Defines event as TBD (To Be Determined) schedule.
833
+ * When event time is not yet defined, TBD message is displayed instead of event start and end times.
834
+ * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
835
+ */
836
+ scheduleTbd?: boolean;
837
+ /** TBD message. */
838
+ scheduleTbdMessage?: string | null;
839
+ /** Event start timestamp. */
840
+ startDate?: Date;
841
+ /** Event end timestamp. */
842
+ endDate?: Date;
843
+ /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
844
+ timeZoneId?: string | null;
845
+ /** Whether end date is hidden in the formatted schedule. */
846
+ endDateHidden?: boolean;
847
+ /** Whether time zone is displayed in formatted schedule. */
848
+ showTimeZone?: boolean;
849
+ /** Event recurrences. */
850
+ recurrences?: Recurrences;
851
+ }
852
+ export interface Recurrences {
853
+ /** Event occurrences. */
854
+ occurrences?: Occurrence[];
855
+ /**
856
+ * Recurring event category ID.
857
+ * @readonly
858
+ */
859
+ categoryId?: string | null;
860
+ /**
861
+ * Recurrence status.
862
+ * @readonly
863
+ */
864
+ status?: Status;
865
+ }
866
+ export interface Occurrence {
867
+ /** Event start timestamp. */
868
+ startDate?: Date;
869
+ /** Event end timestamp. */
870
+ endDate?: Date;
871
+ /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
872
+ timeZoneId?: string | null;
873
+ /** Whether time zone is displayed in formatted schedule. */
874
+ showTimeZone?: boolean;
875
+ }
876
+ export declare enum Status {
877
+ /** Event occurs only once. */
878
+ ONE_TIME = "ONE_TIME",
879
+ /** Event is recurring. */
880
+ RECURRING = "RECURRING",
881
+ /** Marks the next upcoming occurrence of the recurring event. */
882
+ RECURRING_NEXT = "RECURRING_NEXT",
883
+ /** Marks the most recent ended occurrence of the recurring event. */
884
+ RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
885
+ /** Marks the most recent canceled occurrence of the recurring event. */
886
+ RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
887
+ }
888
+ export declare enum EventStatus {
889
+ /** Event is public and scheduled to start */
890
+ SCHEDULED = "SCHEDULED",
891
+ /** Event has started */
892
+ STARTED = "STARTED",
893
+ /** Event has ended */
894
+ ENDED = "ENDED",
895
+ /** Event was canceled */
896
+ CANCELED = "CANCELED",
897
+ /** Event is not public and needs to be published */
898
+ DRAFT = "DRAFT"
899
+ }
900
+ export interface Event {
901
+ /**
902
+ * Event ID.
903
+ * @readonly
904
+ */
905
+ id?: string;
906
+ /** Event location. */
907
+ location?: Location;
908
+ /** Event scheduling. */
909
+ scheduling?: Scheduling;
910
+ /** Event title. */
911
+ title?: string;
912
+ /** Event description. */
913
+ description?: string;
914
+ /** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
915
+ about?: string;
916
+ /** Main event image. */
917
+ mainImage?: Image;
918
+ /** Event slug URL (generated from event title). */
919
+ slug?: string;
920
+ /** ISO 639-1 language code of the event (used in content translations). */
921
+ language?: string;
922
+ /** Event creation timestamp. */
923
+ created?: Date;
924
+ /** Event modified timestamp. */
925
+ modified?: Date;
926
+ /** Event status. */
927
+ status?: EventStatus;
928
+ /** RSVP or ticketing registration details. */
929
+ registration?: Registration;
930
+ /** "Add to calendar" URLs. */
931
+ calendarLinks?: CalendarLinks;
932
+ /** Event page URL components. */
933
+ eventPageUrl?: SiteUrl;
934
+ /** Event registration form. */
935
+ form?: Form;
936
+ /** Event dashboard summary of RSVP / ticket sales. */
937
+ dashboard?: Dashboard;
938
+ /** Instance ID of the site where event is hosted. */
939
+ instanceId?: string;
940
+ /** Guest list configuration. */
941
+ guestListConfig?: GuestListConfig;
942
+ /** Event creator user ID. */
943
+ userId?: string;
944
+ /** Event discussion feed. For internal use. */
945
+ feed?: Feed;
946
+ /** Online conferencing details. */
947
+ onlineConferencing?: OnlineConferencing;
948
+ /** SEO settings. */
949
+ seoSettings?: SeoSettings;
950
+ /** Assigned contacts label key. */
951
+ assignedContactsLabel?: string | null;
952
+ /** Agenda details. */
953
+ agenda?: Agenda;
954
+ /** Categories this event is assigned to. */
955
+ categories?: Category[];
956
+ /** Visual settings for event. */
957
+ eventDisplaySettings?: EventDisplaySettings;
958
+ }
959
+ export interface Scheduling {
960
+ /** Schedule configuration. */
961
+ config?: ScheduleConfig;
962
+ /** Formatted schedule representation. */
963
+ formatted?: string;
964
+ /** Formatted start date of the event (empty for TBD schedules). */
965
+ startDateFormatted?: string;
966
+ /** Formatted start time of the event (empty for TBD schedules). */
967
+ startTimeFormatted?: string;
968
+ /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
969
+ endDateFormatted?: string;
970
+ /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
971
+ endTimeFormatted?: string;
972
+ }
973
+ export interface Image {
974
+ /** WixMedia image ID. */
975
+ id?: string | null;
976
+ /** Image URL. */
977
+ url?: string;
978
+ /** Original image height. */
979
+ height?: number | null;
980
+ /** Original image width. */
981
+ width?: number | null;
982
+ /** Image alt text. Optional. */
983
+ altText?: string | null;
984
+ }
985
+ export interface Registration {
986
+ /** Event type. */
987
+ type?: EventType;
988
+ /** Event registration status. */
989
+ status?: RegistrationStatus;
990
+ /** RSVP collection details. */
991
+ rsvpCollection?: RsvpCollection;
992
+ /** Ticketing details. */
993
+ ticketing?: Ticketing;
994
+ /** External registration details. */
995
+ external?: ExternalEvent;
996
+ /** Types of users allowed to register. */
997
+ restrictedTo?: VisitorType;
998
+ /** Initial event type which was set when creating an event. */
999
+ initialType?: EventType;
1000
+ }
1001
+ export declare enum EventType {
1002
+ /** Type not available for this request fieldset */
1003
+ NA_EVENT_TYPE = "NA_EVENT_TYPE",
1004
+ /** Registration via RSVP */
1005
+ RSVP = "RSVP",
1006
+ /** Registration via ticket purchase */
1007
+ TICKETS = "TICKETS",
1008
+ /** External registration */
1009
+ EXTERNAL = "EXTERNAL",
1010
+ /** Registration not available */
1011
+ NO_REGISTRATION = "NO_REGISTRATION"
1012
+ }
1013
+ export declare enum RegistrationStatus {
1014
+ /** Registration status is not applicable */
1015
+ NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
1016
+ /** Registration to event is closed */
1017
+ CLOSED = "CLOSED",
1018
+ /** Registration to event is closed manually */
1019
+ CLOSED_MANUALLY = "CLOSED_MANUALLY",
1020
+ /** Registration is open via RSVP */
1021
+ OPEN_RSVP = "OPEN_RSVP",
1022
+ /** Registration to event waitlist is open via RSVP */
1023
+ OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
1024
+ /** Registration is open via ticket purchase */
1025
+ OPEN_TICKETS = "OPEN_TICKETS",
1026
+ /** Registration is open via external URL */
1027
+ OPEN_EXTERNAL = "OPEN_EXTERNAL",
1028
+ /** Registration will be open via RSVP */
1029
+ SCHEDULED_RSVP = "SCHEDULED_RSVP"
1030
+ }
1031
+ export interface RsvpCollection {
1032
+ /** RSVP collection configuration. */
1033
+ config?: RsvpCollectionConfig;
1034
+ }
1035
+ export interface RsvpCollectionConfig {
1036
+ /** Defines the supported RSVP statuses. */
1037
+ rsvpStatusOptions?: RsvpStatusOptions;
1038
+ /**
1039
+ * Total guest limit available to register to the event.
1040
+ * Additional guests per RSVP are counted towards total guests.
1041
+ */
1042
+ limit?: number | null;
1043
+ /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
1044
+ waitlist?: boolean;
1045
+ /** Registration start timestamp. */
1046
+ startDate?: Date;
1047
+ /** Registration end timestamp. */
1048
+ endDate?: Date;
1049
+ }
1050
+ export declare enum RsvpStatusOptions {
1051
+ /** Only YES RSVP status is available for RSVP registration */
1052
+ YES_ONLY = "YES_ONLY",
1053
+ /** YES and NO RSVP status options are available for the registration */
1054
+ YES_AND_NO = "YES_AND_NO"
1055
+ }
1056
+ export interface Ticketing {
1057
+ /** Deprecated. */
1058
+ lowestPrice?: string | null;
1059
+ /** Deprecated. */
1060
+ highestPrice?: string | null;
1061
+ /** Currency used in event transactions. */
1062
+ currency?: string | null;
1063
+ /** Ticketing configuration. */
1064
+ config?: TicketingConfig;
1065
+ /**
1066
+ * Price of lowest priced ticket.
1067
+ * @readonly
1068
+ */
1069
+ lowestTicketPrice?: Money;
1070
+ /**
1071
+ * Price of highest priced ticket.
1072
+ * @readonly
1073
+ */
1074
+ highestTicketPrice?: Money;
1075
+ /**
1076
+ * Formatted price of lowest priced ticket.
1077
+ * @readonly
1078
+ */
1079
+ lowestTicketPriceFormatted?: string | null;
1080
+ /**
1081
+ * Formatted price of highest priced ticket.
1082
+ * @readonly
1083
+ */
1084
+ highestTicketPriceFormatted?: string | null;
1085
+ /**
1086
+ * Whether all tickets are sold for this event.
1087
+ * @readonly
1088
+ */
1089
+ soldOut?: boolean | null;
1090
+ }
1091
+ export interface TicketingConfig {
1092
+ /** Whether the form must be filled out separately for each ticket. */
1093
+ guestAssignedTickets?: boolean;
1094
+ /** Tax configuration. */
1095
+ taxConfig?: TaxConfig;
1096
+ /** Limit of tickets that can be purchased per order, default 20. */
1097
+ ticketLimitPerOrder?: number;
1098
+ /** Duration for which the tickets being bought are reserved. */
1099
+ reservationDurationInMinutes?: number | null;
1100
+ }
1101
+ export interface TaxConfig {
1102
+ /** Tax application settings. */
1103
+ type?: TaxType;
1104
+ /** Tax name. */
1105
+ name?: string | null;
1106
+ /** Tax rate (e.g.,`21.55`). */
1107
+ rate?: string | null;
1108
+ /** Applies taxes for donations, default true. */
1109
+ appliesToDonations?: boolean | null;
1110
+ }
1111
+ export declare enum TaxType {
1112
+ /** Tax is included in the ticket price */
1113
+ INCLUDED = "INCLUDED",
1114
+ /** Tax is added to the order at the checkout */
1115
+ ADDED = "ADDED",
1116
+ /** Tax is added to the final total at the checkout */
1117
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1118
+ }
1119
+ export interface Money {
1120
+ /** *Deprecated:** Use `value` instead. */
1121
+ amount?: string;
1122
+ /** ISO 4217 format of the currency i.e. `USD`. */
1123
+ currency?: string;
1124
+ /** 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. */
1125
+ value?: string | null;
1126
+ }
1127
+ export interface ExternalEvent {
1128
+ /** External event registration URL. */
1129
+ registration?: string;
1130
+ }
1131
+ export declare enum VisitorType {
1132
+ /** Site visitor (including member) */
1133
+ VISITOR = "VISITOR",
1134
+ /** Site member */
1135
+ MEMBER = "MEMBER",
1136
+ /** Site visitor or member */
1137
+ VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1138
+ }
1139
+ export interface CalendarLinks {
1140
+ /** "Add to Google calendar" URL. */
1141
+ google?: string;
1142
+ /** "Download ICS calendar file" URL. */
1143
+ ics?: string;
1144
+ }
1145
+ /** Site URL components */
1146
+ export interface SiteUrl {
1147
+ /**
1148
+ * Base URL. For premium sites, this will be the domain.
1149
+ * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
1150
+ */
1151
+ base?: string;
1152
+ /** The path to that page - e.g `/my-events/weekly-meetup-2` */
1153
+ path?: string;
1154
+ }
1155
+ /**
1156
+ * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
1157
+ * It also contains customizable messages and labels.
1158
+ *
1159
+ *
1160
+ * A form is an ordered list of controls (blocks), which accept guest information into a field input.
1161
+ *
1162
+ * Each control contains one or more nested inputs. For example, `Name` control has two inputs:
1163
+ * - First Name
1164
+ * - Last Name
1165
+ *
1166
+ * By default, name and email controls are always required and are pinned to the top of the form.
1167
+ */
1168
+ export interface Form {
1169
+ /** Nested fields as an ordered list. */
1170
+ controls?: InputControl[];
1171
+ /** Set of configured form messages. */
1172
+ messages?: FormMessages;
1173
+ }
1174
+ /**
1175
+ * A block of nested fields.
1176
+ * Used to aggregate similar inputs like First Name and Last Name.
1177
+ */
1178
+ export interface InputControl {
1179
+ /** Field control type. */
1180
+ type?: InputControlType;
1181
+ /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
1182
+ system?: boolean;
1183
+ /** Deprecated: Use `id`. */
1184
+ name?: string;
1185
+ /** Child inputs. */
1186
+ inputs?: Input[];
1187
+ /** Deprecated: use `inputs.label`. */
1188
+ label?: string;
1189
+ /** Field controls are sorted by this value in ascending order. */
1190
+ orderIndex?: number;
1191
+ /** Unique control ID. */
1192
+ id?: string;
1193
+ /**
1194
+ * Whether input control is deleted.
1195
+ * @readonly
1196
+ */
1197
+ deleted?: boolean | null;
1198
+ }
1199
+ export declare enum InputControlType {
1200
+ /** Single text value field. */
1201
+ INPUT = "INPUT",
1202
+ /** Single text value field. */
1203
+ TEXTAREA = "TEXTAREA",
1204
+ /** Single-choice field of predefined values. */
1205
+ DROPDOWN = "DROPDOWN",
1206
+ /** Single-choice field of predefined values. */
1207
+ RADIO = "RADIO",
1208
+ /** Multiple-choice field of predefined values. */
1209
+ CHECKBOX = "CHECKBOX",
1210
+ /** First and last name fields. */
1211
+ NAME = "NAME",
1212
+ /** Additional guests and respective guest names fields. */
1213
+ GUEST_CONTROL = "GUEST_CONTROL",
1214
+ /** Single-line address field. */
1215
+ ADDRESS_SHORT = "ADDRESS_SHORT",
1216
+ /** Full address field. */
1217
+ ADDRESS_FULL = "ADDRESS_FULL",
1218
+ /** Year, month and day fields. */
1219
+ DATE = "DATE"
1220
+ }
1221
+ /** An input of one or multiple text values */
1222
+ export interface Input {
1223
+ /** Field name. */
1224
+ name?: string;
1225
+ /** Deprecated: use `ValueType.TEXT_ARRAY`. */
1226
+ array?: boolean;
1227
+ /** Main field label */
1228
+ label?: string;
1229
+ /** Additional labels for multi-valued fields such as address. */
1230
+ additionalLabels?: Record<string, string>;
1231
+ /** Predefined choice options for fields, such as dropdown. */
1232
+ options?: string[];
1233
+ /** Whether field is mandatory. */
1234
+ mandatory?: boolean;
1235
+ /** Maximum number of accepted characters (relevant for text fields). */
1236
+ maxLength?: number;
1237
+ /**
1238
+ * Type which determines field format.
1239
+ * Used to validate submitted response.
1240
+ */
1241
+ type?: ValueType;
1242
+ /**
1243
+ * A maximum accepted values for array input.
1244
+ * Only applicable for inputs of valueType: TEXT_ARRAY.
1245
+ */
1246
+ maxSize?: number | null;
1247
+ /**
1248
+ * Preselected option.
1249
+ * Currently only applicable for dropdown.
1250
+ */
1251
+ defaultOptionSelection?: OptionSelection;
1252
+ /**
1253
+ * Additional labels for multi-valued fields such as address.
1254
+ * @readonly
1255
+ */
1256
+ labels?: Label[];
1257
+ }
1258
+ export declare enum ValueType {
1259
+ TEXT = "TEXT",
1260
+ NUMBER = "NUMBER",
1261
+ TEXT_ARRAY = "TEXT_ARRAY",
1262
+ DATE_TIME = "DATE_TIME",
1263
+ ADDRESS = "ADDRESS"
1264
+ }
1265
+ /**
1266
+ * Describes initially selected option when an input has multiple choices.
1267
+ * Defaults to first (0th) option if not configured.
1268
+ */
1269
+ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
1270
+ /** 0-based index from predefined `input.options` which is selected initially. */
1271
+ optionIndex?: number;
1272
+ /**
1273
+ * Placeholder hint describing expected choices (such as "Please select").
1274
+ * Considered an empty choice.
1275
+ */
1276
+ placeholderText?: string;
1277
+ }
1278
+ /** @oneof */
1279
+ export interface OptionSelectionSelectedOptionOneOf {
1280
+ /** 0-based index from predefined `input.options` which is selected initially. */
1281
+ optionIndex?: number;
1282
+ /**
1283
+ * Placeholder hint describing expected choices (such as "Please select").
1284
+ * Considered an empty choice.
1285
+ */
1286
+ placeholderText?: string;
1287
+ }
1288
+ export interface Label {
1289
+ /** Field name. */
1290
+ name?: string;
1291
+ /** Field label. */
1292
+ label?: string;
1293
+ }
1294
+ /**
1295
+ * Defines form messages shown in UI before, during, and after registration flow.
1296
+ * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
1297
+ */
1298
+ export interface FormMessages {
1299
+ /** RSVP form messages. */
1300
+ rsvp?: RsvpFormMessages;
1301
+ /** Checkout form messages. */
1302
+ checkout?: CheckoutFormMessages;
1303
+ /** Messages shown when event registration is closed. */
1304
+ registrationClosed?: RegistrationClosedMessages;
1305
+ /** Messages shown when event tickets are unavailable. */
1306
+ ticketsUnavailable?: TicketsUnavailableMessages;
1307
+ }
1308
+ export interface RsvpFormMessages {
1309
+ /** Label text indicating RSVP `YES` response. */
1310
+ rsvpYesOption?: string;
1311
+ /** Label text indicating RSVP `NO` response. */
1312
+ rsvpNoOption?: string;
1313
+ /** Messages shown for RSVP = `YES`. */
1314
+ positiveMessages?: Positive;
1315
+ /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
1316
+ waitlistMessages?: Positive;
1317
+ /** Messages shown for RSVP = `NO`. */
1318
+ negativeMessages?: Negative;
1319
+ /** "Submit form" call-to-action label text. */
1320
+ submitActionLabel?: string;
1321
+ }
1322
+ /** Confirmation messages shown after registration. */
1323
+ export interface PositiveResponseConfirmation {
1324
+ /** Confirmation message title. */
1325
+ title?: string;
1326
+ /** Confirmation message text. */
1327
+ message?: string;
1328
+ /** "Add to calendar" call-to-action label text. */
1329
+ addToCalendarActionLabel?: string;
1330
+ /** "Share event" call-to-action label text. */
1331
+ shareActionLabel?: string;
1332
+ }
1333
+ /** Confirmation messages shown after registration. */
1334
+ export interface NegativeResponseConfirmation {
1335
+ /** Confirmation message title. */
1336
+ title?: string;
1337
+ /** "Share event" call-to-action label text. */
1338
+ shareActionLabel?: string;
1339
+ }
1340
+ /** Set of messages shown during registration when RSVP response is positive. */
1341
+ export interface Positive {
1342
+ /** Main form title for positive response. */
1343
+ title?: string;
1344
+ /** Confirmation messages shown after registration. */
1345
+ confirmation?: PositiveResponseConfirmation;
1346
+ }
1347
+ /** A set of messages shown during registration with negative response */
1348
+ export interface Negative {
1349
+ /** Main form title for negative response. */
1350
+ title?: string;
1351
+ /** Confirmation messages shown after registration. */
1352
+ confirmation?: NegativeResponseConfirmation;
1353
+ }
1354
+ export interface CheckoutFormMessages {
1355
+ /** Main form title for response. */
1356
+ title?: string;
1357
+ /** Submit form call-to-action label text. */
1358
+ submitActionLabel?: string;
1359
+ /** Confirmation messages shown after checkout. */
1360
+ confirmation?: ResponseConfirmation;
1361
+ }
1362
+ /** Confirmation messages shown after checkout. */
1363
+ export interface ResponseConfirmation {
1364
+ /** Confirmation message title. */
1365
+ title?: string;
1366
+ /** Confirmation message text. */
1367
+ message?: string;
1368
+ /** "Download tickets" call-to-action label text. */
1369
+ downloadTicketsLabel?: string;
1370
+ /** "Add to calendar" call-to-action label text. */
1371
+ addToCalendarLabel?: string;
1372
+ /** "Share event" call-to-action label text. */
1373
+ shareEventLabel?: string;
1374
+ }
1375
+ export interface RegistrationClosedMessages {
1376
+ /** Message shown when event registration is closed. */
1377
+ message?: string;
1378
+ /** "Explore other events" call-to-action label text. */
1379
+ exploreEventsActionLabel?: string;
1380
+ }
1381
+ export interface TicketsUnavailableMessages {
1382
+ /** Message shown when event tickets are unavailable. */
1383
+ message?: string;
1384
+ /** "Explore other events" call-to-action label text. */
1385
+ exploreEventsActionLabel?: string;
1386
+ }
1387
+ export interface Dashboard {
1388
+ /** Guest RSVP summary. */
1389
+ rsvpSummary?: RsvpSummary;
1390
+ /**
1391
+ * Summary of revenue and tickets sold.
1392
+ * (Archived orders are not included).
1393
+ */
1394
+ ticketingSummary?: TicketingSummary;
1395
+ }
1396
+ export interface RsvpSummary {
1397
+ /** Total number of RSVPs. */
1398
+ total?: number;
1399
+ /** Number of RSVPs with status `YES`. */
1400
+ yes?: number;
1401
+ /** Number of RSVPs with status `NO`. */
1402
+ no?: number;
1403
+ /** Number of RSVPs in waitlist. */
1404
+ waitlist?: number;
1405
+ }
1406
+ export interface TicketingSummary {
1407
+ /** Number of tickets sold. */
1408
+ tickets?: number;
1409
+ /**
1410
+ * Total revenue, excluding fees.
1411
+ * (taxes and payment provider fees are not deducted.)
1412
+ */
1413
+ revenue?: Money;
1414
+ /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
1415
+ currencyLocked?: boolean;
1416
+ /** Number of orders placed. */
1417
+ orders?: number;
1418
+ /** Total balance of confirmed transactions. */
1419
+ totalSales?: Money;
1420
+ }
1421
+ export interface GuestListConfig {
1422
+ /** Whether members can see other members attending the event (defaults to true). */
1423
+ publicGuestList?: boolean;
1424
+ }
1425
+ export interface Feed {
1426
+ /** Event discussion feed token. */
1427
+ token?: string;
1428
+ }
1429
+ export interface OnlineConferencing {
1430
+ config?: OnlineConferencingConfig;
1431
+ session?: OnlineConferencingSession;
1432
+ }
1433
+ export interface OnlineConferencingConfig {
1434
+ /**
1435
+ * Whether online conferencing is enabled (not supported for TBD schedules).
1436
+ * When enabled, links to join conferencing are generated and provided to guests.
1437
+ */
1438
+ enabled?: boolean;
1439
+ /** Conferencing provider ID. */
1440
+ providerId?: string | null;
1441
+ /** Conference type */
1442
+ conferenceType?: ConferenceType;
1443
+ }
1444
+ export declare enum ConferenceType {
1445
+ /** Everyone in the meeting can publish and subscribe video and audio. */
1446
+ MEETING = "MEETING",
1447
+ /** Guests can only subscribe to video and audio. */
1448
+ WEBINAR = "WEBINAR"
1449
+ }
1450
+ export interface OnlineConferencingSession {
1451
+ /**
1452
+ * Link for event host to start the online conference session.
1453
+ * @readonly
1454
+ */
1455
+ hostLink?: string;
1456
+ /**
1457
+ * Link for guests to join the online conference session.
1458
+ * @readonly
1459
+ */
1460
+ guestLink?: string;
1461
+ /**
1462
+ * The password required to join online conferencing session (when relevant).
1463
+ * @readonly
1464
+ */
1465
+ password?: string | null;
1466
+ /**
1467
+ * Indicates that session was created successfully on providers side.
1468
+ * @readonly
1469
+ */
1470
+ sessionCreated?: boolean | null;
1471
+ /**
1472
+ * Unique session id
1473
+ * @readonly
1474
+ */
1475
+ sessionId?: string | null;
1476
+ }
1477
+ export interface SeoSettings {
1478
+ /** URL slug */
1479
+ slug?: string;
1480
+ /** Advanced SEO data */
1481
+ advancedSeoData?: SeoSchema;
1482
+ /**
1483
+ * Hidden from SEO Site Map
1484
+ * @readonly
1485
+ */
1486
+ hidden?: boolean | null;
1487
+ }
1488
+ /**
1489
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
1490
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
1491
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
1492
+ */
1493
+ export interface SeoSchema {
1494
+ /** SEO tag information. */
1495
+ tags?: Tag[];
1496
+ /** SEO general settings. */
1497
+ settings?: Settings;
1498
+ }
1499
+ export interface Keyword {
1500
+ /** Keyword value. */
1501
+ term?: string;
1502
+ /** Whether the keyword is the main focus keyword. */
1503
+ isMain?: boolean;
1504
+ }
1505
+ export interface Tag {
1506
+ /**
1507
+ * SEO tag type.
1508
+ *
1509
+ *
1510
+ * Supported values: `title`, `meta`, `script`, `link`.
1511
+ */
1512
+ type?: string;
1513
+ /**
1514
+ * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
1515
+ * For example: `{'name': 'description', 'content': 'the description itself'}`.
1516
+ */
1517
+ props?: Record<string, any> | null;
1518
+ /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
1519
+ meta?: Record<string, any> | null;
1520
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
1521
+ children?: string;
1522
+ /** Whether the tag is a custom tag. */
1523
+ custom?: boolean;
1524
+ /** Whether the tag is disabled. */
1525
+ disabled?: boolean;
1526
+ }
1527
+ export interface Settings {
1528
+ /**
1529
+ * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
1530
+ *
1531
+ *
1532
+ * Default: `false` (Auto Redirect is enabled.)
1533
+ */
1534
+ preventAutoRedirect?: boolean;
1535
+ /** User-selected keyword terms for a specific page. */
1536
+ keywords?: Keyword[];
1537
+ }
1538
+ export interface Agenda {
1539
+ /** Whether the schedule is enabled for the event. */
1540
+ enabled?: boolean;
1541
+ /**
1542
+ * Agenda page URL.
1543
+ * @readonly
1544
+ */
1545
+ pageUrl?: SiteUrl;
1546
+ }
1547
+ export interface Category {
1548
+ /**
1549
+ * Category ID.
1550
+ * @readonly
1551
+ */
1552
+ id?: string;
1553
+ /** Category name. */
1554
+ name?: string;
1555
+ /**
1556
+ * Category creation timestamp.
1557
+ * @readonly
1558
+ */
1559
+ createdDate?: Date;
1560
+ /**
1561
+ * Assigned events count. Deleted events are excluded.
1562
+ * @readonly
1563
+ */
1564
+ assignedEventsCount?: number | null;
1565
+ /**
1566
+ * Assigned and assigned draft event counts.
1567
+ * @readonly
1568
+ */
1569
+ counts?: CategoryCounts;
1570
+ /**
1571
+ * Category state. Default - MANUAL.
1572
+ * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
1573
+ * Field will be ignored on update requests.
1574
+ */
1575
+ states?: CategoryStateState[];
1576
+ }
1577
+ export interface CategoryCounts {
1578
+ /** Assigned events count. Deleted events are excluded. */
1579
+ assignedEventsCount?: number | null;
1580
+ /** Assigned draft events count. */
1581
+ assignedDraftEventsCount?: number | null;
1582
+ }
1583
+ export declare enum CategoryStateState {
1584
+ /** Created manually by the user. */
1585
+ MANUAL = "MANUAL",
1586
+ /** Created automatically. */
1587
+ AUTO = "AUTO",
1588
+ /** Created when publishing recurring events. */
1589
+ RECURRING_EVENT = "RECURRING_EVENT",
1590
+ /** Category is hidden. */
1591
+ HIDDEN = "HIDDEN",
1592
+ /** Category is used to store component events. */
1593
+ COMPONENT = "COMPONENT"
1594
+ }
1595
+ export interface EventDisplaySettings {
1596
+ /** Whether event details button is hidden. Only available for events with no registration. */
1597
+ hideEventDetailsButton?: boolean | null;
1598
+ }
1599
+ export interface EventUpdated {
1600
+ /** Event update timestamp in ISO UTC format. */
1601
+ timestamp?: Date;
1602
+ /** Event ID. */
1603
+ eventId?: string;
1604
+ /** Event location. */
1605
+ location?: Location;
1606
+ /** Event schedule configuration. */
1607
+ scheduleConfig?: ScheduleConfig;
1608
+ /** Event title. */
1609
+ title?: string;
1610
+ /** Whether schedule configuration was updated. */
1611
+ scheduleConfigUpdated?: boolean;
1612
+ /** Updated event */
1613
+ event?: Event;
1614
+ }
1615
+ export interface SeatingPlanCategoriesSummaryUpdated {
1616
+ /** Seating plan id */
1617
+ seatingPlanId?: string;
1618
+ /** External seating plan id */
1619
+ externalSeatingPlanId?: string | null;
1620
+ /** Ticket counts by category */
1621
+ categories?: CategoryDetails[];
1622
+ }
1623
+ export interface CategoryDetails {
1624
+ /**
1625
+ * Seating plan id
1626
+ * @readonly
1627
+ */
1628
+ seatingPlanId?: string | null;
1629
+ /**
1630
+ * External seating plan id
1631
+ * @readonly
1632
+ */
1633
+ externalSeatingPlanId?: string | null;
1634
+ /**
1635
+ * External category id
1636
+ * @readonly
1637
+ */
1638
+ externalCategoryId?: string | null;
1639
+ /**
1640
+ * Total capacity in the category
1641
+ * @readonly
1642
+ */
1643
+ totalCapacity?: number | null;
1644
+ /**
1645
+ * Already reserved capacity
1646
+ * @readonly
1647
+ */
1648
+ reserved?: number | null;
1649
+ }
1650
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1651
+ /** Emitted on a meta site creation. */
1652
+ siteCreated?: SiteCreated;
1653
+ /** Emitted on a meta site transfer completion. */
1654
+ siteTransferred?: SiteTransferred;
1655
+ /** Emitted on a meta site deletion. */
1656
+ siteDeleted?: SiteDeleted;
1657
+ /** Emitted on a meta site restoration. */
1658
+ siteUndeleted?: SiteUndeleted;
1659
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1660
+ sitePublished?: SitePublished;
1661
+ /** Emitted on a meta site unpublish. */
1662
+ siteUnpublished?: SiteUnpublished;
1663
+ /** Emitted when meta site is marked as template. */
1664
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1665
+ /** Emitted when meta site is marked as a WixSite. */
1666
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1667
+ /** Emitted when an application is provisioned (installed). */
1668
+ serviceProvisioned?: ServiceProvisioned;
1669
+ /** Emitted when an application is removed (uninstalled). */
1670
+ serviceRemoved?: ServiceRemoved;
1671
+ /** Emitted when meta site name (URL slug) is changed. */
1672
+ siteRenamedPayload?: SiteRenamed;
1673
+ /** Emitted when meta site was permanently deleted. */
1674
+ hardDeleted?: SiteHardDeleted;
1675
+ /** Emitted on a namespace change. */
1676
+ namespaceChanged?: NamespaceChanged;
1677
+ /** Emitted when Studio is attached. */
1678
+ studioAssigned?: StudioAssigned;
1679
+ /** Emitted when Studio is detached. */
1680
+ studioUnassigned?: StudioUnassigned;
1681
+ /** A meta site id. */
1682
+ metaSiteId?: string;
1683
+ /** A meta site version. Monotonically increasing. */
1684
+ version?: string;
1685
+ /** A timestamp of the event. */
1686
+ timestamp?: string;
1687
+ /** A list of "assets" (applications). The same as MetaSiteContext. */
1688
+ assets?: Asset[];
1689
+ }
1690
+ /** @oneof */
1691
+ export interface MetaSiteSpecialEventPayloadOneOf {
1692
+ /** Emitted on a meta site creation. */
1693
+ siteCreated?: SiteCreated;
1694
+ /** Emitted on a meta site transfer completion. */
1695
+ siteTransferred?: SiteTransferred;
1696
+ /** Emitted on a meta site deletion. */
1697
+ siteDeleted?: SiteDeleted;
1698
+ /** Emitted on a meta site restoration. */
1699
+ siteUndeleted?: SiteUndeleted;
1700
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1701
+ sitePublished?: SitePublished;
1702
+ /** Emitted on a meta site unpublish. */
1703
+ siteUnpublished?: SiteUnpublished;
1704
+ /** Emitted when meta site is marked as template. */
1705
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1706
+ /** Emitted when meta site is marked as a WixSite. */
1707
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1708
+ /** Emitted when an application is provisioned (installed). */
1709
+ serviceProvisioned?: ServiceProvisioned;
1710
+ /** Emitted when an application is removed (uninstalled). */
1711
+ serviceRemoved?: ServiceRemoved;
1712
+ /** Emitted when meta site name (URL slug) is changed. */
1713
+ siteRenamedPayload?: SiteRenamed;
1714
+ /** Emitted when meta site was permanently deleted. */
1715
+ hardDeleted?: SiteHardDeleted;
1716
+ /** Emitted on a namespace change. */
1717
+ namespaceChanged?: NamespaceChanged;
1718
+ /** Emitted when Studio is attached. */
1719
+ studioAssigned?: StudioAssigned;
1720
+ /** Emitted when Studio is detached. */
1721
+ studioUnassigned?: StudioUnassigned;
1722
+ }
1723
+ export interface Asset {
1724
+ /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
1725
+ appDefId?: string;
1726
+ /** An instance id. For legacy reasons may be UUID or a string. */
1727
+ instanceId?: string;
1728
+ /** An application state. */
1729
+ state?: State;
1730
+ }
1731
+ export declare enum State {
1732
+ UNKNOWN = "UNKNOWN",
1733
+ ENABLED = "ENABLED",
1734
+ DISABLED = "DISABLED",
1735
+ PENDING = "PENDING",
1736
+ DEMO = "DEMO"
1737
+ }
1738
+ export interface SiteCreated {
1739
+ /** A template identifier (empty if not created from a template). */
1740
+ originTemplateId?: string;
1741
+ /** An account id of the owner. */
1742
+ ownerId?: string;
1743
+ /** A context in which meta site was created. */
1744
+ context?: SiteCreatedContext;
1745
+ /**
1746
+ * A meta site id from which this site was created.
1747
+ *
1748
+ * In case of a creation from a template it's a template id.
1749
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1750
+ */
1751
+ originMetaSiteId?: string | null;
1752
+ /** A meta site name (URL slug). */
1753
+ siteName?: string;
1754
+ /** A namespace. */
1755
+ namespace?: Namespace;
1756
+ }
1757
+ export declare enum SiteCreatedContext {
1758
+ /** A valid option, we don't expose all reasons why site might be created. */
1759
+ OTHER = "OTHER",
1760
+ /** A meta site was created from template. */
1761
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1762
+ /** A meta site was created by copying of the transfferred meta site. */
1763
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1764
+ /** A copy of existing meta site. */
1765
+ DUPLICATE = "DUPLICATE",
1766
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1767
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1768
+ /** deprecated A meta site was created for Flash editor. */
1769
+ FLASH = "FLASH"
1770
+ }
1771
+ export declare enum Namespace {
1772
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1773
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1774
+ WIX = "WIX",
1775
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1776
+ SHOUT_OUT = "SHOUT_OUT",
1777
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1778
+ ALBUMS = "ALBUMS",
1779
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1780
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1781
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1782
+ HOTELS = "HOTELS",
1783
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1784
+ CLUBS = "CLUBS",
1785
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1786
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1787
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1788
+ DEV_SITE = "DEV_SITE",
1789
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1790
+ LOGOS = "LOGOS",
1791
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1792
+ VIDEO_MAKER = "VIDEO_MAKER",
1793
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1794
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1795
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1796
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1797
+ /**
1798
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1799
+ *
1800
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1801
+ */
1802
+ HTML_DRAFT = "HTML_DRAFT",
1803
+ /**
1804
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1805
+ * Will be accessible from Site List and will not have a website app.
1806
+ * Once the user attaches a site, the site will become a regular wixsite.
1807
+ */
1808
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1809
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1810
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1811
+ /** It is to be used in the Business First efforts. */
1812
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1813
+ /** Bookings business flow with no site. */
1814
+ ANYWHERE = "ANYWHERE",
1815
+ /** Namespace for Headless Backoffice with no editor */
1816
+ HEADLESS = "HEADLESS",
1817
+ /**
1818
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1819
+ * The site will be used for account level CSM feature for enterprise
1820
+ */
1821
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1822
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1823
+ RISE = "RISE",
1824
+ /**
1825
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1826
+ * There's a blank site behind the scene but it's blank).
1827
+ * The Mobile company will be the owner of this namespace.
1828
+ */
1829
+ BRANDED_FIRST = "BRANDED_FIRST"
1830
+ }
1831
+ /** Site transferred to another user. */
1832
+ export interface SiteTransferred {
1833
+ /** A previous owner id (user that transfers meta site). */
1834
+ oldOwnerId?: string;
1835
+ /** A new owner id (user that accepts meta site). */
1836
+ newOwnerId?: string;
1837
+ }
1838
+ /** Soft deletion of the meta site. Could be restored. */
1839
+ export interface SiteDeleted {
1840
+ /** A deletion context. */
1841
+ deleteContext?: DeleteContext;
1842
+ }
1843
+ export interface DeleteContext {
1844
+ /** When the meta site was deleted. */
1845
+ dateDeleted?: Date;
1846
+ /** A status. */
1847
+ deleteStatus?: DeleteStatus;
1848
+ /** A reason (flow). */
1849
+ deleteOrigin?: string;
1850
+ /** A service that deleted it. */
1851
+ initiatorId?: string | null;
1852
+ }
1853
+ export declare enum DeleteStatus {
1854
+ UNKNOWN = "UNKNOWN",
1855
+ TRASH = "TRASH",
1856
+ DELETED = "DELETED",
1857
+ PENDING_PURGE = "PENDING_PURGE"
1858
+ }
1859
+ /** Restoration of the meta site. */
1860
+ export interface SiteUndeleted {
1861
+ }
1862
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1863
+ export interface SitePublished {
1864
+ }
1865
+ export interface SiteUnpublished {
1866
+ /** A list of URLs previously associated with the meta site. */
1867
+ urls?: string[];
1868
+ }
1869
+ export interface SiteMarkedAsTemplate {
1870
+ }
1871
+ export interface SiteMarkedAsWixSite {
1872
+ }
1873
+ export interface ServiceProvisioned {
1874
+ /** Either UUID or EmbeddedServiceType. */
1875
+ appDefId?: string;
1876
+ /** Not only UUID. Something here could be something weird. */
1877
+ instanceId?: string;
1878
+ /** An instance id from which this instance is originated. */
1879
+ originInstanceId?: string;
1880
+ /** A version. */
1881
+ version?: string | null;
1882
+ }
1883
+ export interface ServiceRemoved {
1884
+ /** Either UUID or EmbeddedServiceType. */
1885
+ appDefId?: string;
1886
+ /** Not only UUID. Something here could be something weird. */
1887
+ instanceId?: string;
1888
+ /** A version. */
1889
+ version?: string | null;
1890
+ }
1891
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1892
+ export interface SiteRenamed {
1893
+ /** A new meta site name (URL slug). */
1894
+ newSiteName?: string;
1895
+ /** A previous meta site name (URL slug). */
1896
+ oldSiteName?: string;
1897
+ }
1898
+ /**
1899
+ * Hard deletion of the meta site.
1900
+ *
1901
+ * Could not be restored. Therefore it's desirable to cleanup data.
1902
+ */
1903
+ export interface SiteHardDeleted {
1904
+ /** A deletion context. */
1905
+ deleteContext?: DeleteContext;
1906
+ }
1907
+ export interface NamespaceChanged {
1908
+ /** A previous namespace. */
1909
+ oldNamespace?: Namespace;
1910
+ /** A new namespace. */
1911
+ newNamespace?: Namespace;
1912
+ }
1913
+ /** Assigned Studio editor */
1914
+ export interface StudioAssigned {
1915
+ }
1916
+ /** Unassigned Studio editor */
1917
+ export interface StudioUnassigned {
1918
+ }
1919
+ export interface GetTicketDefinitionFromTrashBinRequest {
1920
+ /** Ticket definition ID. */
1921
+ ticketDefinitionId?: string;
1922
+ /** Requested fields. Not implemented. */
1923
+ fields?: Field[];
1924
+ }
1925
+ export interface GetTicketDefinitionFromTrashBinResponse {
1926
+ /** The requested ticket definition. */
1927
+ ticketDefinition?: TicketDefinition;
1928
+ }
1929
+ export interface ScheduleTimecapsuleTaskRequest {
1930
+ /** Definition ID. */
1931
+ id?: string;
1932
+ /** Sale period. */
1933
+ salePeriod?: SalePeriod;
1934
+ }
1935
+ export interface RescheduleTimecapsuleTaskRequest {
1936
+ /** Definition ID. */
1937
+ id?: string;
1938
+ /** Sale period. */
1939
+ salePeriod?: SalePeriod;
1940
+ }
1941
+ export interface CancelTimecapsuleTaskRequest {
1942
+ /** Definition ID. */
1943
+ id?: string;
1944
+ }
1945
+ export interface CreateTicketDefinitionResponseNonNullableFields {
1946
+ ticketDefinition?: {
1947
+ hidden: boolean;
1948
+ limited: boolean;
1949
+ pricingMethod?: {
1950
+ fixedPrice?: {
1951
+ value: string;
1952
+ currency: string;
1953
+ };
1954
+ guestPrice?: {
1955
+ value: string;
1956
+ currency: string;
1957
+ };
1958
+ pricingOptions?: {
1959
+ optionDetails: {
1960
+ price?: {
1961
+ value: string;
1962
+ currency: string;
1963
+ };
1964
+ }[];
1965
+ };
1966
+ pricingType: PricingTypeEnumType;
1967
+ free: boolean;
1968
+ };
1969
+ feeType: Type;
1970
+ salePeriod?: {
1971
+ displayNotOnSale: boolean;
1972
+ };
1973
+ saleStatus: SaleStatusEnumStatus;
1974
+ sortIndex: number;
1975
+ };
1976
+ }
1977
+ export interface UpdateTicketDefinitionResponseNonNullableFields {
1978
+ ticketDefinition?: {
1979
+ hidden: boolean;
1980
+ limited: boolean;
1981
+ pricingMethod?: {
1982
+ fixedPrice?: {
1983
+ value: string;
1984
+ currency: string;
1985
+ };
1986
+ guestPrice?: {
1987
+ value: string;
1988
+ currency: string;
1989
+ };
1990
+ pricingOptions?: {
1991
+ optionDetails: {
1992
+ price?: {
1993
+ value: string;
1994
+ currency: string;
1995
+ };
1996
+ }[];
1997
+ };
1998
+ pricingType: PricingTypeEnumType;
1999
+ free: boolean;
2000
+ };
2001
+ feeType: Type;
2002
+ salePeriod?: {
2003
+ displayNotOnSale: boolean;
2004
+ };
2005
+ saleStatus: SaleStatusEnumStatus;
2006
+ sortIndex: number;
2007
+ };
2008
+ }
2009
+ export interface GetTicketDefinitionResponseNonNullableFields {
2010
+ ticketDefinition?: {
2011
+ hidden: boolean;
2012
+ limited: boolean;
2013
+ pricingMethod?: {
2014
+ fixedPrice?: {
2015
+ value: string;
2016
+ currency: string;
2017
+ };
2018
+ guestPrice?: {
2019
+ value: string;
2020
+ currency: string;
2021
+ };
2022
+ pricingOptions?: {
2023
+ optionDetails: {
2024
+ price?: {
2025
+ value: string;
2026
+ currency: string;
2027
+ };
2028
+ }[];
2029
+ };
2030
+ pricingType: PricingTypeEnumType;
2031
+ free: boolean;
2032
+ };
2033
+ feeType: Type;
2034
+ salePeriod?: {
2035
+ displayNotOnSale: boolean;
2036
+ };
2037
+ saleStatus: SaleStatusEnumStatus;
2038
+ sortIndex: number;
2039
+ };
2040
+ }
2041
+ export interface QueryTicketDefinitionsResponseNonNullableFields {
2042
+ ticketDefinitions: {
2043
+ hidden: boolean;
2044
+ limited: boolean;
2045
+ pricingMethod?: {
2046
+ fixedPrice?: {
2047
+ value: string;
2048
+ currency: string;
2049
+ };
2050
+ guestPrice?: {
2051
+ value: string;
2052
+ currency: string;
2053
+ };
2054
+ pricingOptions?: {
2055
+ optionDetails: {
2056
+ price?: {
2057
+ value: string;
2058
+ currency: string;
2059
+ };
2060
+ }[];
2061
+ };
2062
+ pricingType: PricingTypeEnumType;
2063
+ free: boolean;
2064
+ };
2065
+ feeType: Type;
2066
+ salePeriod?: {
2067
+ displayNotOnSale: boolean;
2068
+ };
2069
+ saleStatus: SaleStatusEnumStatus;
2070
+ sortIndex: number;
2071
+ }[];
2072
+ }