@wix/auto_sdk_seatings_seating-reservation 1.0.12 → 1.0.14

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 (37) hide show
  1. package/build/cjs/index.d.ts +18 -10
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +321 -179
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +712 -131
  8. package/build/cjs/meta.js +109 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +18 -10
  11. package/build/es/index.mjs +18 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +321 -179
  14. package/build/es/index.typings.mjs +18 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +712 -131
  17. package/build/es/meta.mjs +101 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +18 -10
  20. package/build/internal/cjs/index.js +18 -0
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +321 -179
  23. package/build/internal/cjs/index.typings.js +18 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +712 -131
  26. package/build/internal/cjs/meta.js +109 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +18 -10
  29. package/build/internal/es/index.mjs +18 -0
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +321 -179
  32. package/build/internal/es/index.typings.mjs +18 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +712 -131
  35. package/build/internal/es/meta.mjs +101 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -1,139 +1,318 @@
1
1
  import { CreateSeatingReservationRequest as CreateSeatingReservationRequest$1, CreateSeatingReservationResponse as CreateSeatingReservationResponse$1, GetReservationRequest as GetReservationRequest$1, GetReservationResponse as GetReservationResponse$1, QuerySeatingReservationRequest as QuerySeatingReservationRequest$1, QuerySeatingReservationResponse as QuerySeatingReservationResponse$1, DeleteSeatingReservationRequest as DeleteSeatingReservationRequest$1, DeleteSeatingReservationResponse as DeleteSeatingReservationResponse$1, GetSeatingCategorySummaryRequest as GetSeatingCategorySummaryRequest$1, GetSeatingCategorySummaryResponse as GetSeatingCategorySummaryResponse$1, GetSeatingReservationSummaryRequest as GetSeatingReservationSummaryRequest$1, GetSeatingReservationSummaryResponse as GetSeatingReservationSummaryResponse$1 } from './index.typings.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
+ /**
5
+ * A seating reservation represents a booking for one or more places within a seating plan.
6
+ *
7
+ * Seating reservations track specific seat assignments or area capacity allocations for events. Each reservation can include multiple places across different sections of a venue, with individual capacity requirements for each place. The system maintains referential integrity through both internal Wix identifiers and external system references, enabling seamless integration with third-party ticketing platforms.
8
+ */
4
9
  interface SeatingReservation {
5
10
  /**
6
- * The id of the reservation
11
+ * Reservation ID.
7
12
  * @format GUID
8
13
  * @readonly
9
14
  */
10
15
  id?: string | null;
11
16
  /**
12
- * The seating plan id
17
+ * Seating plan ID.
13
18
  * @format GUID
14
19
  * @readonly
15
20
  */
16
21
  seatingPlanId?: string | null;
17
22
  /**
18
- * The external seating plan id
23
+ * External seating plan ID used for integration with third-party venue systems.
19
24
  * @minLength 1
20
25
  * @maxLength 100
21
26
  * @readonly
22
27
  */
23
28
  externalSeatingPlanId?: string | null;
24
29
  /**
25
- * Reserved places
30
+ * Places reserved in this reservation. Each place can have its own capacity requirements.
26
31
  * @minSize 1
27
32
  * @maxSize 100
28
33
  */
29
34
  reservedPlaces?: PlaceReservation[];
30
35
  /**
31
- * A client defined external id for cross referencing.
32
- * Can reference external entities.
33
- * Format: "{fqdn}:{entity guid}"
36
+ * External reference ID for cross-system integration. Format: `{fqdn}:{entity guid}`. For example, `wix.events.v1.ticket:12345678-1234-1234-1234-123456789012`.
34
37
  * @minLength 1
35
38
  * @maxLength 100
36
39
  */
37
40
  externalId?: string | null;
38
41
  /**
39
- * Revision number, which increments by 1 each time the reservation is updated.
42
+ * Revision number, which increments by 1 each time the reservation is updated. To prevent conflicting changes, the current revision must be passed when updating the reservation. Ignored when creating a reservation.
40
43
  * @readonly
41
44
  */
42
45
  revision?: string | null;
43
46
  }
47
+ /** Individual place reservation within a seating arrangement. */
44
48
  interface PlaceReservation {
45
49
  /**
46
- * The place id.
50
+ * Place ID. For example, `A1-1-5` for section A, row 1, seat 5.
47
51
  * @minLength 5
48
52
  * @maxLength 11
49
53
  */
50
54
  id?: string;
51
55
  /**
52
- * Number of places in the spot. If not provided - defaults to 1.
53
- * Used to reserve for more that one place in areas.
56
+ * Number of people to be seated at this place. Used for area seating where multiple guests can occupy a single reservable location.
57
+ *
58
+ * Default: `1`
54
59
  * @min 1
55
60
  * @max 50
56
61
  */
57
62
  capacity?: number | null;
58
63
  /**
59
- * Optional section label.
64
+ * Section name within the venue. For example, `Orchestra` or `Balcony`.
60
65
  * @readonly
61
66
  */
62
67
  sectionLabel?: string | null;
63
68
  /**
64
- * Area label.
69
+ * Area name within a section. Used for general admission or standing areas.
65
70
  * @readonly
66
71
  */
67
72
  areaLabel?: string | null;
68
73
  /**
69
- * Table label.
74
+ * Table identifier for table-based seating arrangements.
70
75
  * @readonly
71
76
  */
72
77
  tableLabel?: string | null;
73
78
  /**
74
- * Row label.
79
+ * Row identifier within a section or area.
75
80
  * @readonly
76
81
  */
77
82
  rowLabel?: string | null;
78
83
  /**
79
- * Seat label in a row or table.
84
+ * Individual seat identifier within a row or at a table.
80
85
  * @readonly
81
86
  */
82
87
  seatLabel?: string | null;
83
88
  }
89
+ /** Triggers when seating plan category summaries are updated. */
90
+ interface SeatingPlanCategoriesSummaryUpdated {
91
+ /**
92
+ * Seating plan ID.
93
+ * @format GUID
94
+ */
95
+ seatingPlanId?: string;
96
+ /** External seating plan ID. */
97
+ externalSeatingPlanId?: string | null;
98
+ /**
99
+ * Updated category capacity and reservation counts.
100
+ * @maxSize 100
101
+ */
102
+ categories?: CategoryDetails[];
103
+ /**
104
+ * Summary revision number for cache invalidation.
105
+ * @readonly
106
+ */
107
+ revision?: string | null;
108
+ }
109
+ /** Category capacity and reservation summary. */
84
110
  interface CategoryDetails {
85
111
  /**
86
- * Seating plan id
112
+ * Seating Plan ID.
87
113
  * @format GUID
88
114
  * @readonly
89
115
  */
90
116
  seatingPlanId?: string | null;
91
117
  /**
92
- * External seating plan id
118
+ * External Seating Plan ID used for integration with third-party systems.
93
119
  * @minLength 1
94
120
  * @maxLength 100
95
121
  * @readonly
96
122
  */
97
123
  externalSeatingPlanId?: string | null;
98
124
  /**
99
- * External category id
125
+ * External Category ID used for mapping to venue-specific category names. For example, `VIP` or `ORCHESTRA`.
100
126
  * @minLength 1
101
127
  * @maxLength 100
102
128
  * @readonly
103
129
  */
104
130
  externalCategoryId?: string | null;
105
131
  /**
106
- * Total capacity in the category
132
+ * Total seating capacity available in category.
107
133
  * @readonly
108
134
  */
109
135
  totalCapacity?: number | null;
110
136
  /**
111
- * Already reserved capacity
137
+ * Number of seats currently reserved in category.
112
138
  * @readonly
113
139
  */
114
140
  reserved?: number | null;
115
141
  }
142
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
143
+ /**
144
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
145
+ * @format GUID
146
+ */
147
+ metaSiteId?: string;
148
+ /**
149
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
150
+ * @format GUID
151
+ */
152
+ siteId?: string;
153
+ /** Invalidate by App */
154
+ app?: App;
155
+ /** Invalidate by page id */
156
+ page?: Page;
157
+ /** Invalidate by URI path */
158
+ uri?: URI;
159
+ /** Invalidate by file (for media files such as PDFs) */
160
+ file?: File;
161
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
162
+ customTag?: CustomTag;
163
+ /**
164
+ * tell us why you're invalidating the cache. You don't need to add your app name
165
+ * @maxLength 256
166
+ */
167
+ reason?: string | null;
168
+ /** Is local DS */
169
+ localDc?: boolean;
170
+ hardPurge?: boolean;
171
+ }
172
+ /** @oneof */
173
+ interface InvalidateCacheGetByOneOf {
174
+ /**
175
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
176
+ * @format GUID
177
+ */
178
+ metaSiteId?: string;
179
+ /**
180
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
181
+ * @format GUID
182
+ */
183
+ siteId?: string;
184
+ /** Invalidate by App */
185
+ app?: App;
186
+ /** Invalidate by page id */
187
+ page?: Page;
188
+ /** Invalidate by URI path */
189
+ uri?: URI;
190
+ /** Invalidate by file (for media files such as PDFs) */
191
+ file?: File;
192
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
193
+ customTag?: CustomTag;
194
+ }
195
+ interface App {
196
+ /**
197
+ * The AppDefId
198
+ * @minLength 1
199
+ */
200
+ appDefId?: string;
201
+ /**
202
+ * The instance Id
203
+ * @format GUID
204
+ */
205
+ instanceId?: string;
206
+ }
207
+ interface Page {
208
+ /**
209
+ * the msid the page is on
210
+ * @format GUID
211
+ */
212
+ metaSiteId?: string;
213
+ /**
214
+ * Invalidate by Page ID
215
+ * @minLength 1
216
+ */
217
+ pageId?: string;
218
+ }
219
+ interface URI {
220
+ /**
221
+ * the msid the URI is on
222
+ * @format GUID
223
+ */
224
+ metaSiteId?: string;
225
+ /**
226
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
227
+ * @minLength 1
228
+ */
229
+ uriPath?: string;
230
+ }
231
+ interface File {
232
+ /**
233
+ * the msid the file is related to
234
+ * @format GUID
235
+ */
236
+ metaSiteId?: string;
237
+ /**
238
+ * Invalidate by filename (for media files such as PDFs)
239
+ * @minLength 1
240
+ * @maxLength 256
241
+ */
242
+ fileName?: string;
243
+ }
244
+ interface CustomTag {
245
+ /**
246
+ * the msid the tag is related to
247
+ * @format GUID
248
+ */
249
+ metaSiteId?: string;
250
+ /**
251
+ * Tag to invalidate by
252
+ * @minLength 1
253
+ * @maxLength 256
254
+ */
255
+ tag?: string;
256
+ }
257
+ /** Request to create a seating reservation. */
116
258
  interface CreateSeatingReservationRequest {
117
- /** A reservation to create */
259
+ /** Reservation to create. */
118
260
  reservation?: SeatingReservation;
119
261
  }
262
+ /** Response after creating a seating reservation. */
120
263
  interface CreateSeatingReservationResponse {
121
- /** Created reservation */
264
+ /** Created reservation. */
122
265
  reservation?: SeatingReservation;
123
266
  }
267
+ /** Details about specific places, used for error reporting. */
268
+ interface Places {
269
+ /**
270
+ * List of place identifiers. For example, `A1-1-5` or `VIP-12`.
271
+ * @minSize 1
272
+ * @maxSize 100
273
+ */
274
+ places?: string[];
275
+ }
276
+ /** Details about places that are unavailable, including capacity conflicts. */
277
+ interface UnavailablePlaces {
278
+ /**
279
+ * List of place identifiers that are unavailable. For example, `A1-1-5` or `VIP-12`.
280
+ * @minSize 1
281
+ * @maxSize 100
282
+ */
283
+ unavailablePlaces?: string[];
284
+ /**
285
+ * Detailed capacity information for each unavailable place.
286
+ * @minSize 1
287
+ * @maxSize 100
288
+ */
289
+ reservationErrorDetails?: ReservationErrorDetails[];
290
+ }
291
+ /** Capacity conflict details for a given place. */
292
+ interface ReservationErrorDetails {
293
+ /** ID of the place with a capacity conflict. */
294
+ id?: string;
295
+ /** Currently available capacity at this place. */
296
+ available?: number;
297
+ /** Requested capacity that exceeds the available capacity. */
298
+ requested?: number;
299
+ }
300
+ /** Request to retrieve a specific seating reservation. */
124
301
  interface GetReservationRequest {
125
302
  /**
126
- * The id of the reservation to return
303
+ * Reservation ID.
127
304
  * @format GUID
128
305
  */
129
306
  id: string | null;
130
307
  }
308
+ /** Response containing the requested seating reservation. */
131
309
  interface GetReservationResponse {
132
- /** Created reservation */
310
+ /** Retrieved reservation. */
133
311
  reservation?: SeatingReservation;
134
312
  }
313
+ /** Request to query seating reservations. */
135
314
  interface QuerySeatingReservationRequest {
136
- /** A query object */
315
+ /** Query object with filter criteria and pagination settings. */
137
316
  query: QueryV2;
138
317
  }
139
318
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -201,10 +380,11 @@ interface CursorPaging {
201
380
  */
202
381
  cursor?: string | null;
203
382
  }
383
+ /** Response containing matching seating reservations. */
204
384
  interface QuerySeatingReservationResponse {
205
- /** Found reservations */
385
+ /** Found reservations matching the query criteria. */
206
386
  reservations?: SeatingReservation[];
207
- /** Paging meta data */
387
+ /** Paging metadata for result navigation. */
208
388
  metadata?: PagingMetadataV2;
209
389
  }
210
390
  interface PagingMetadataV2 {
@@ -231,524 +411,747 @@ interface Cursors {
231
411
  */
232
412
  prev?: string | null;
233
413
  }
414
+ /** Request to delete a seating reservation. */
234
415
  interface DeleteSeatingReservationRequest {
235
416
  /**
236
- * The id of the reservation to delete
417
+ * Reservation ID.
237
418
  * @format GUID
238
419
  */
239
420
  id: string | null;
240
421
  }
422
+ /** Response after deleting a seating reservation. */
241
423
  interface DeleteSeatingReservationResponse {
242
- /** The deleted reservation */
424
+ /** Deleted reservation. */
243
425
  reservation?: SeatingReservation;
244
426
  }
427
+ /** Request to delete a specific place reservation. */
428
+ interface DeleteSeatingPlaceReservationRequest {
429
+ /** Place reservation ID. */
430
+ id?: string | null;
431
+ /**
432
+ * Seating reservation ID that contains the place reservation.
433
+ * @format GUID
434
+ */
435
+ reservationId?: string | null;
436
+ }
437
+ interface Empty {
438
+ }
439
+ /** Request to cancel specific place reservations. */
440
+ interface CancelSeatingPlaceReservationsRequest {
441
+ /**
442
+ * Seating reservation ID containing the places to cancel.
443
+ * @format GUID
444
+ */
445
+ reservationId?: string | null;
446
+ /**
447
+ * Place reservations to cancel with their reduced capacity.
448
+ * @minSize 1
449
+ * @maxSize 100
450
+ */
451
+ placeReservations?: PlaceReservationDetails[];
452
+ }
453
+ /** Occupancy details for a specific place in a seating plan. */
245
454
  interface PlaceReservationDetails {
455
+ /** Place ID. */
246
456
  placeId?: string;
457
+ /** Number of occupied seats or capacity units at this place. */
247
458
  occupied?: number;
248
459
  }
460
+ /** Response after canceling place reservations. */
461
+ interface CancelSeatingPlaceReservationsResponse {
462
+ /** Reservation with canceled place reservations. */
463
+ reservation?: SeatingReservation;
464
+ }
465
+ /** Request to update a seating reservation. */
466
+ interface UpdateSeatingReservationRequest {
467
+ /** Reservation to update with modified capacity values. */
468
+ reservation?: SeatingReservation;
469
+ }
470
+ /** Response after updating a seating reservation. */
471
+ interface UpdateSeatingReservationResponse {
472
+ /** Updated reservation. */
473
+ reservation?: SeatingReservation;
474
+ }
475
+ /** Request to retrieve all reserved places for a seating plan. */
476
+ interface GetReservedPlacesRequest {
477
+ /**
478
+ * Seating plan ID.
479
+ * @format GUID
480
+ */
481
+ id?: string | null;
482
+ }
483
+ /** Response containing all reserved places for a seating plan. */
484
+ interface GetReservedPlacesResponse {
485
+ /** Reserved places in the seating plan. */
486
+ placeReservations?: PlaceReservation[];
487
+ }
488
+ /** Request to list reserved places with optional filtering. */
489
+ interface ListReservedPlacesRequest {
490
+ /**
491
+ * Seating plan ID.
492
+ * @format GUID
493
+ */
494
+ planId?: string | null;
495
+ /**
496
+ * Optional filter by reservation ID.
497
+ * @format GUID
498
+ */
499
+ reservationId?: string | null;
500
+ /**
501
+ * Optional filter by specific seat IDs.
502
+ * @maxSize 50
503
+ * @maxLength 20
504
+ */
505
+ seatId?: string[];
506
+ /** Paging configuration. */
507
+ paging?: Paging;
508
+ }
509
+ /** Response containing filtered reserved places. */
510
+ interface ListReservedPlacesResponse {
511
+ /** Reserved places matching the filter criteria. */
512
+ reservedPlaces?: ReservedPlace[];
513
+ /** Paging metadata for result navigation. */
514
+ pagingMetadata?: PagingMetadata;
515
+ }
516
+ /** Internal representation of a place reservation. */
517
+ interface SeatReservation {
518
+ /**
519
+ * Place reservation ID.
520
+ * @maxLength 72
521
+ */
522
+ seatReservationId?: string | null;
523
+ /**
524
+ * Place ID.
525
+ * @maxLength 20
526
+ */
527
+ seatId?: string | null;
528
+ /**
529
+ * Seating plan ID.
530
+ * @format GUID
531
+ */
532
+ planId?: string | null;
533
+ /**
534
+ * Seating reservation ID.
535
+ * @format GUID
536
+ */
537
+ reservationId?: string | null;
538
+ /**
539
+ * Number of occupied spots at this place.
540
+ * @max 50000
541
+ */
542
+ spots?: number | null;
543
+ /** Whether this is an area-based reservation (true) or individual seat (false). */
544
+ area?: boolean | null;
545
+ }
546
+ /** Individual reserved place with full context. */
547
+ interface ReservedPlace {
548
+ /** Place reservation details. */
549
+ seatReservation?: SeatReservation;
550
+ /** Parent reservation (active). */
551
+ reservation?: SeatingReservation;
552
+ /** Parent reservation (deleted, for audit trail). */
553
+ reservationFromTrashBin?: SeatingReservation;
554
+ }
555
+ interface PagingMetadata {
556
+ /** Number of items returned in the response. */
557
+ count?: number | null;
558
+ /** Offset that was requested. */
559
+ offset?: number | null;
560
+ /** Total number of items that match the query. */
561
+ total?: number | null;
562
+ /** Flag that indicates the server failed to calculate the `total` field. */
563
+ tooManyToCount?: boolean | null;
564
+ }
565
+ /** Request to retrieve category-level capacity summary. */
249
566
  interface GetSeatingCategorySummaryRequest {
250
567
  /**
251
- * Seating plan external id
568
+ * External seating plan ID.
252
569
  * @minLength 1
253
570
  * @maxLength 100
254
571
  */
255
572
  externalId?: string;
256
573
  }
574
+ /** Response containing capacity summary by category. */
257
575
  interface GetSeatingCategorySummaryResponse {
258
576
  /**
259
- * Ticket counts by category
577
+ * Capacity and reservation counts by category.
260
578
  * @maxSize 50000
261
579
  */
262
580
  categories?: CategoryDetails[];
263
581
  }
582
+ /** Request to retrieve detailed place-level occupancy data. */
264
583
  interface GetSeatingReservationSummaryRequest {
265
584
  /**
266
- * Seating plan external id
585
+ * External seating plan ID.
267
586
  * @minLength 1
268
587
  * @maxLength 100
269
588
  */
270
589
  externalId: string;
271
590
  }
591
+ /** Response containing complete seating plan and occupancy data. */
272
592
  interface GetSeatingReservationSummaryResponse {
593
+ /** Complete seating plan structure. */
273
594
  plan?: SeatingPlan;
274
- /** @maxSize 50000 */
595
+ /**
596
+ * Occupancy details for each place in the plan.
597
+ * @maxSize 50000
598
+ */
275
599
  places?: PlaceReservationDetails[];
276
600
  }
601
+ /** A seating plan represents the layout and organization of seats within a venue. It defines the physical arrangement of seating areas, pricing categories, and individual places where attendees can be seated or positioned during an event. */
277
602
  interface SeatingPlan {
278
603
  /**
279
- * Auto generated unique plan id
604
+ * Seating plan ID.
280
605
  * @format GUID
281
606
  * @readonly
282
607
  */
283
608
  id?: string | null;
284
609
  /**
285
- * A client defined external id for cross referencing.
286
- * Can reference external entities.
287
- * Format: "{fqdn}:{entity guid}"
610
+ * Client-defined external ID for cross-referencing with external systems. Format: `{fqdn}:{entity_guid}`. For example, `wix.events.v1.event:abc-123-def`.
288
611
  * @minLength 1
289
612
  * @maxLength 100
290
613
  */
291
614
  externalId?: string | null;
292
615
  /**
293
- * Human friendly plan title
616
+ * Human-friendly seating plan title. For example, `Madison Square Garden - Main Floor`.
294
617
  * @minLength 1
295
618
  * @maxLength 120
296
619
  */
297
620
  title?: string | null;
298
621
  /**
299
- * Sections of the plan. Seating plan is divided in high level sections.
622
+ * High-level divisions of the venue, such as "Orchestra", "Balcony", or "VIP Section". A default section with `id = 0` is required and serves as the primary seating area.
300
623
  * @maxSize 100
301
624
  */
302
625
  sections?: Section[];
303
626
  /**
304
- * Categories for plan element grouping.
627
+ * Pricing tiers or groupings for organizing places, such as "VIP", "General Admission", or "Student Discount". Elements and places can be assigned to categories for pricing and availability management.
305
628
  * @maxSize 100
306
629
  */
307
630
  categories?: Category[];
308
631
  /**
309
- * Seating plan created timestamp.
632
+ * Date and time the seating plan was created.
310
633
  * @readonly
311
634
  */
312
635
  createdDate?: Date | null;
313
636
  /**
314
- * Seating plan updated timestamp.
637
+ * Date and time the seating plan was updated.
315
638
  * @readonly
316
639
  */
317
640
  updatedDate?: Date | null;
318
641
  /**
319
- * Total capacity
642
+ * Total number of seats across all sections and elements in the seating plan. Automatically calculated by summing element capacities.
320
643
  * @readonly
321
644
  */
322
645
  totalCapacity?: number | null;
323
646
  /**
324
- * Total categories
647
+ * Total number of categories defined in the seating plan. Automatically calculated.
325
648
  * @readonly
326
649
  */
327
650
  totalCategories?: number | null;
328
651
  /**
329
- * Places not assigned to categories
652
+ * Places that are not assigned to any category. These places require manual category assignment for pricing and organization.
330
653
  * @maxSize 50000
331
654
  * @readonly
332
655
  */
333
656
  uncategorizedPlaces?: Place[];
334
657
  /**
335
- * A version of the seating plan
658
+ * Version number of the seating plan, incremented by 1 each time the plan is updated. Used for version management and tracking changes.
336
659
  * @readonly
337
660
  */
338
661
  version?: string | null;
339
- /** Data extensions */
662
+ /** Additional custom fields for extending the seating plan with app-specific data. Learn more about @extended fields. */
340
663
  extendedFields?: ExtendedFields;
341
- /** Seating Plan UI settings */
664
+ /** Visual settings for the seating plan, such as background color and opacity. Used by seating chart interfaces for rendering. */
342
665
  uiProperties?: SeatingPlanUiProperties;
343
666
  /**
344
- * Element groups
667
+ * Hierarchical groupings of elements for UI organization and bulk operations. Groups can contain multiple elements or nested sub-groups for easier management.
345
668
  * @maxSize 1000
346
669
  */
347
670
  elementGroups?: ElementGroup[];
348
671
  }
672
+ /** A section represents a high-level division within a seating plan, such as "Orchestra", "Balcony", or "VIP Area". Sections contain elements that define the actual seating arrangements. */
349
673
  interface Section {
350
- /** Unique section id */
674
+ /** Section ID. Must be unique within the seating plan. Section with `id = 0` is required as the default section. */
351
675
  id?: number;
352
676
  /**
353
- * Human readable section title
677
+ * Human-readable section title. For example, `Orchestra` or `Balcony`.
354
678
  * @minLength 1
355
679
  * @maxLength 20
356
680
  */
357
681
  title?: string | null;
358
682
  /**
359
- * Client configuration object
683
+ * Client configuration object for storing additional section metadata. Read-only field maintained for backward compatibility.
360
684
  * @readonly
361
685
  */
362
686
  config?: Record<string, any> | null;
363
687
  /**
364
- * Elements of the section.
688
+ * Seating elements within this section, such as rows, tables, or general admission areas. Each element generates individual places based on its type and capacity.
365
689
  * @maxSize 1000
366
690
  */
367
691
  elements?: Element[];
368
692
  /**
369
- * Total capacity
693
+ * Total capacity of all elements within this section. Automatically calculated by summing element capacities.
370
694
  * @readonly
371
695
  */
372
696
  totalCapacity?: number | null;
373
697
  /**
374
- * Is default section
698
+ * Whether this is the default section. Always `true` for section with `id = 0`.
375
699
  * @readonly
376
700
  */
377
701
  default?: boolean;
378
702
  }
703
+ /** An element represents a specific seating configuration within a section, such as a row of seats, a table, or a general admission area. Elements generate individual places based on their type and capacity. */
379
704
  interface Element {
380
705
  /**
381
- * Unique element id
706
+ * Element ID. Must be unique within the seating plan.
382
707
  * @min 1
383
708
  */
384
709
  id?: number;
385
710
  /**
386
- * User friendly title/label of the element.
711
+ * User-friendly title or label for the element. For example, `Row A` or `VIP Table 1`.
387
712
  * @minLength 1
388
713
  * @maxLength 50
389
714
  */
390
715
  title?: string | null;
391
- /** Element type */
716
+ /** Type of seating element, which determines capacity limits and place generation behavior. See ElementTypeEnum for available types. */
392
717
  type?: TypeWithLiterals;
393
718
  /**
394
- * Capacity. None for Shape type Element.
719
+ * Number of seats or spots in this element. Not applicable for SHAPE type elements. Maximum 50,000 per element.
395
720
  * @min 1
396
721
  * @max 50000
397
722
  */
398
723
  capacity?: number | null;
399
- /** Assigned to a category */
724
+ /** ID of the category this element is assigned to for pricing and organization. References a category defined in the seating plan. */
400
725
  categoryId?: number | null;
401
- /** A place numbering meta data */
726
+ /** Configuration for generating place labels and numbering within this element. Defines how seats are labeled (e.g., 1, 2, 3 or A, B, C). */
402
727
  sequencing?: Sequencing;
403
728
  /**
404
- * Place override (by seq_id)
729
+ * Custom place configurations that override the default generated places for specific positions. Used for accessibility seating, obstructed views, or custom labeling.
405
730
  * @maxSize 2000
406
731
  */
407
732
  overrides?: Place[];
408
733
  /**
409
- * Final place sequence with overrides
734
+ * Final sequence of places generated for this element, including any overrides applied. Read-only field populated by the system.
410
735
  * @maxSize 200
411
736
  * @readonly
412
737
  */
413
738
  places?: Place[];
414
- /** Element reservation options */
739
+ /** Constraints on how this element can be reserved or booked. For example, requiring the entire element to be reserved as a unit. */
415
740
  reservationOptions?: ReservationOptions;
416
- /** Element UI settings */
741
+ /** Visual positioning and styling properties for rendering this element in a seating chart. Includes coordinates, dimensions, and styling options. */
417
742
  uiProperties?: ElementUiProperties;
418
- /** Element group id */
743
+ /** ID of the element group this element belongs to for hierarchical organization. References an ElementGroup defined in the seating plan. */
419
744
  elementGroupId?: number | null;
420
- /** Multi row element relevant for MULTI_ROW element type */
745
+ /** Additional properties for MULTI_ROW type elements, defining individual rows and their configurations. Only applicable when type is MULTI_ROW. */
421
746
  multiRowProperties?: MultiRowProperties;
422
747
  }
423
748
  declare enum Type {
749
+ /** General admission area with a single place containing the full capacity. */
424
750
  AREA = "AREA",
751
+ /** Single row of individual seats with sequential labeling. */
425
752
  ROW = "ROW",
753
+ /** Multiple rows treated as one element, each with individual capacity and sequencing. */
426
754
  MULTI_ROW = "MULTI_ROW",
755
+ /** Rectangular table with individual seats around the perimeter. */
427
756
  TABLE = "TABLE",
757
+ /** Circular table with individual seats around the perimeter. */
428
758
  ROUND_TABLE = "ROUND_TABLE",
759
+ /** Visual element with no seating capacity, used for decorative or informational purposes. */
429
760
  SHAPE = "SHAPE"
430
761
  }
431
762
  /** @enumType */
432
763
  type TypeWithLiterals = Type | 'AREA' | 'ROW' | 'MULTI_ROW' | 'TABLE' | 'ROUND_TABLE' | 'SHAPE';
764
+ /** Configuration for generating sequential labels for places within an element. */
433
765
  interface Sequencing {
434
766
  /**
435
- * First seq element
767
+ * Starting value for the sequence. For example, `1` for numeric sequences or `A` for alphabetical sequences.
436
768
  * @minLength 1
437
769
  * @maxLength 4
438
770
  */
439
771
  startAt?: string;
440
772
  /**
441
- * Finite generated seq of labels
773
+ * Complete sequence of labels to be used for places. Must match the element's capacity. When provided, overrides automatic label generation.
442
774
  * @maxSize 2500
443
775
  */
444
776
  labels?: string[];
445
- /** If true - direction right to left. Otherwise left to right. */
777
+ /** Whether to apply labels in reverse order (right-to-left instead of left-to-right). Useful for venue-specific numbering conventions. */
446
778
  reverseOrder?: boolean | null;
447
779
  }
780
+ /** An individual seat or spot within an element where an attendee can be positioned. */
448
781
  interface Place {
449
- /** Local id of the place in the sequence */
782
+ /** Zero-based position of this place within the element's sequence. Used to identify the place's position for overrides. */
450
783
  index?: number;
451
784
  /**
452
- * Generated composite unique id in the seating plan.
785
+ * Unique place ID in the format `{section_id}-{element_id}-{label}`. For example, `0-1-A5` for section 0, element 1, seat A5.
453
786
  * @readonly
454
787
  */
455
788
  id?: string | null;
456
789
  /**
457
- * Unique label of the place
790
+ * Human-readable label for this place, such as `A1`, `12`, or `VIP1`. Generated based on sequencing configuration or custom overrides.
458
791
  * @minLength 1
459
792
  * @maxLength 4
460
793
  */
461
794
  label?: string;
462
795
  /**
463
- * Max capacity per place
796
+ * Maximum number of people that can occupy this place. Typically 1 for individual seats, higher for AREA type places.
464
797
  * @readonly
465
798
  */
466
799
  capacity?: number | null;
467
800
  /**
468
- * Type of the parent element
801
+ * Type of the parent element that contains this place. Inherited from the element's type.
469
802
  * @readonly
470
803
  */
471
804
  elementType?: TypeWithLiterals;
472
805
  /**
473
- * Assigned category id
806
+ * ID of the category this place is assigned to. Inherited from element or row category assignment.
474
807
  * @readonly
475
808
  */
476
809
  categoryId?: number | null;
477
- /** Place type */
810
+ /** Special characteristics or accessibility features of this place (standard, wheelchair, accessible, companion, obstructed, discount). */
478
811
  type?: PlaceTypeEnumTypeWithLiterals;
479
812
  }
480
813
  declare enum PlaceTypeEnumType {
814
+ /** Unknown place type. */
481
815
  UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
816
+ /** Standard seating with no special accommodations. */
482
817
  STANDARD = "STANDARD",
818
+ /** Wheelchair accessible seating space. */
483
819
  WHEELCHAIR = "WHEELCHAIR",
820
+ /** Accessible seating for mobility-impaired guests. */
484
821
  ACCESSIBLE = "ACCESSIBLE",
822
+ /** Companion seat adjacent to accessible seating. */
485
823
  COMPANION = "COMPANION",
824
+ /** Seat with limited or obstructed view. */
486
825
  OBSTRUCTED = "OBSTRUCTED",
826
+ /** Discounted pricing seat. */
487
827
  DISCOUNT = "DISCOUNT"
488
828
  }
489
829
  /** @enumType */
490
830
  type PlaceTypeEnumTypeWithLiterals = PlaceTypeEnumType | 'UNKNOWN_PROPERTY' | 'STANDARD' | 'WHEELCHAIR' | 'ACCESSIBLE' | 'COMPANION' | 'OBSTRUCTED' | 'DISCOUNT';
831
+ /** Configuration options that control how an element can be reserved or booked. */
491
832
  interface ReservationOptions {
492
- /** Indicates whether the entire element must be reserved */
833
+ /** Whether the entire element must be reserved as a single unit. When `true`, individual seats cannot be booked separately. Cannot be used with AREA type elements. */
493
834
  reserveWholeElement?: boolean;
494
835
  }
836
+ /** Visual positioning and styling properties for rendering elements in a seating chart interface. */
495
837
  interface ElementUiProperties {
496
838
  /**
839
+ * Horizontal position coordinate of the element in the seating chart coordinate system.
497
840
  * @min -1000000
498
841
  * @max 1000000
499
842
  */
500
843
  x?: number | null;
501
844
  /**
845
+ * Vertical position coordinate of the element in the seating chart coordinate system.
502
846
  * @min -1000000
503
847
  * @max 1000000
504
848
  */
505
849
  y?: number | null;
506
850
  /**
851
+ * Layering order for overlapping elements. Higher values appear on top of lower values.
507
852
  * @min -1000000
508
853
  * @max 1000000
509
854
  */
510
855
  zIndex?: number | null;
511
- /** @max 1000000 */
856
+ /**
857
+ * Width of the element in the coordinate system units.
858
+ * @max 1000000
859
+ */
512
860
  width?: number | null;
513
- /** @max 1000000 */
861
+ /**
862
+ * Height of the element in the coordinate system units.
863
+ * @max 1000000
864
+ */
514
865
  height?: number | null;
515
866
  /**
867
+ * Rotation angle of the element in degrees. Positive values rotate clockwise.
516
868
  * @min -180
517
869
  * @max 180
518
870
  */
519
871
  rotationAngle?: number | null;
872
+ /** Shape type for SHAPE elements that don't represent seating. Only applicable when element type is SHAPE. */
520
873
  shapeType?: ShapeTypeEnumTypeWithLiterals;
521
874
  /**
875
+ * Font size for text elements in points.
522
876
  * @min 10
523
877
  * @max 176
524
878
  */
525
879
  fontSize?: number | null;
526
- /** @max 1000000 */
880
+ /**
881
+ * Corner radius for rounded rectangular shapes in coordinate system units.
882
+ * @max 1000000
883
+ */
527
884
  cornerRadius?: number | null;
528
885
  /**
886
+ * Horizontal spacing between individual seats within the element.
529
887
  * @min 1
530
888
  * @max 60
531
889
  */
532
890
  seatSpacing?: number | null;
891
+ /** Whether to hide labels on seats within this element. When `true`, seat labels are not displayed in the UI. */
533
892
  hideLabel?: boolean | null;
893
+ /** Position of labels relative to seats (left, right, both sides, or none). */
534
894
  labelPosition?: PositionWithLiterals;
895
+ /** Array defining the arrangement of seats within the element. Each number represents the count of seats in that position. */
535
896
  seatLayout?: number[];
536
- /** @max 50 */
897
+ /**
898
+ * Number of empty spaces at the top of the seating arrangement for visual spacing.
899
+ * @max 50
900
+ */
537
901
  emptyTopSeatSpaces?: number | null;
538
902
  /**
539
- * needs research
903
+ * Text content for TEXT type shape elements. Only applicable when shape_type is TEXT.
540
904
  * @minLength 1
541
905
  * @maxLength 10000
542
906
  */
543
907
  text?: string | null;
544
908
  /**
545
- * #F0F0F0
909
+ * Primary color in hexadecimal format. For example, `#FF0000` for red.
546
910
  * @format COLOR_HEX
547
911
  */
548
912
  color?: string | null;
549
913
  /**
550
- * #F0F0F0
914
+ * Fill color for shapes in hexadecimal format. For example, `#00FF00` for green.
551
915
  * @format COLOR_HEX
552
916
  */
553
917
  fillColor?: string | null;
554
918
  /**
555
- * #F0F0F0
919
+ * Border color in hexadecimal format. For example, `#0000FF` for blue.
556
920
  * @format COLOR_HEX
557
921
  */
558
922
  strokeColor?: string | null;
559
923
  /**
560
- * px
924
+ * Border width in pixels for shape outlines.
561
925
  * @min 1
562
926
  * @max 6
563
927
  */
564
928
  strokeWidth?: number | null;
565
- /** @max 100 */
929
+ /**
930
+ * Opacity level as a percentage from 0 (transparent) to 100 (opaque).
931
+ * @max 100
932
+ */
566
933
  opacity?: number | null;
934
+ /** Icon type for ICON shape elements. Only applicable when shape_type is ICON. */
567
935
  icon?: IconWithLiterals;
936
+ /** Image object for IMAGE shape elements. Only applicable when shape_type is IMAGE. */
568
937
  image?: Image;
938
+ /** Numbering scheme for seats within this element (numeric, alphabetical, or odd/even). */
569
939
  seatNumbering?: NumberingWithLiterals;
570
940
  }
571
941
  declare enum ShapeTypeEnumType {
942
+ /** Unknown shape type. */
572
943
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
944
+ /** Text label or annotation. */
573
945
  TEXT = "TEXT",
946
+ /** Rectangular shape. */
574
947
  RECTANGLE = "RECTANGLE",
948
+ /** Circular or oval shape. */
575
949
  ELLIPSE = "ELLIPSE",
950
+ /** Straight line. */
576
951
  LINE = "LINE",
952
+ /** Predefined icon symbol. */
577
953
  ICON = "ICON",
954
+ /** Custom image. */
578
955
  IMAGE = "IMAGE"
579
956
  }
580
957
  /** @enumType */
581
958
  type ShapeTypeEnumTypeWithLiterals = ShapeTypeEnumType | 'UNKNOWN_TYPE' | 'TEXT' | 'RECTANGLE' | 'ELLIPSE' | 'LINE' | 'ICON' | 'IMAGE';
582
959
  declare enum Position {
960
+ /** Label positioning options for seats and elements. */
583
961
  UNKNOWN_POSITION = "UNKNOWN_POSITION",
962
+ /** Labels appear to the left of seats. */
584
963
  LEFT = "LEFT",
964
+ /** Labels appear to the right of seats. */
585
965
  RIGHT = "RIGHT",
966
+ /** Labels appear on both sides of seats. */
586
967
  BOTH = "BOTH",
968
+ /** No labels are displayed. */
587
969
  NONE = "NONE"
588
970
  }
589
971
  /** @enumType */
590
972
  type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'LEFT' | 'RIGHT' | 'BOTH' | 'NONE';
591
973
  declare enum Icon {
974
+ /** Available icon types for venue wayfinding and information. */
592
975
  UNKNOWN_ICON = "UNKNOWN_ICON",
976
+ /** Entrance icon. */
593
977
  ENTER = "ENTER",
978
+ /** Exit icon. */
594
979
  EXIT = "EXIT",
980
+ /** Beverage service icon. */
595
981
  DRINKS = "DRINKS",
982
+ /** Restroom icon. */
596
983
  WC = "WC",
984
+ /** Men's restroom icon. */
597
985
  WC_MEN = "WC_MEN",
986
+ /** Women's restroom icon. */
598
987
  WC_WOMEN = "WC_WOMEN",
988
+ /** Food service icon. */
599
989
  FOOD = "FOOD",
990
+ /** Stairway icon. */
600
991
  STAIRS = "STAIRS",
992
+ /** Elevator icon. */
601
993
  ELEVATOR = "ELEVATOR",
994
+ /** Smoking area icon. */
602
995
  SMOKING = "SMOKING",
996
+ /** Coat check icon. */
603
997
  CHECKROOM = "CHECKROOM",
998
+ /** Stage or performance area icon. */
604
999
  STAGE = "STAGE"
605
1000
  }
606
1001
  /** @enumType */
607
1002
  type IconWithLiterals = Icon | 'UNKNOWN_ICON' | 'ENTER' | 'EXIT' | 'DRINKS' | 'WC' | 'WC_MEN' | 'WC_WOMEN' | 'FOOD' | 'STAIRS' | 'ELEVATOR' | 'SMOKING' | 'CHECKROOM' | 'STAGE';
1003
+ /** Image reference for use in seating plan visual elements. */
608
1004
  interface Image {
609
- /** WixMedia image ID. */
1005
+ /** Image ID from Wix Media Manager. */
610
1006
  id?: string;
611
1007
  /**
612
- * Original image height.
1008
+ * Original image height in pixels.
613
1009
  * @readonly
614
1010
  */
615
1011
  height?: number;
616
1012
  /**
617
- * Original image width.
1013
+ * Original image width in pixels.
618
1014
  * @readonly
619
1015
  */
620
1016
  width?: number;
621
1017
  /**
622
- * WixMedia image URI.
1018
+ * Deprecated. Use the `id` field instead for referencing images.
623
1019
  * @deprecated
624
1020
  */
625
1021
  uri?: string | null;
626
1022
  }
627
1023
  declare enum Numbering {
1024
+ /** Seat numbering patterns for sequential label generation. */
628
1025
  UNKNOWN_NUMBERING = "UNKNOWN_NUMBERING",
1026
+ /** Sequential numbers (1, 2, 3, ...). */
629
1027
  NUMERIC = "NUMERIC",
1028
+ /** Alternating odd and even numbers. */
630
1029
  ODD_EVEN = "ODD_EVEN",
1030
+ /** Sequential letters (A, B, C, ...). */
631
1031
  ALPHABETICAL = "ALPHABETICAL"
632
1032
  }
633
1033
  /** @enumType */
634
1034
  type NumberingWithLiterals = Numbering | 'UNKNOWN_NUMBERING' | 'NUMERIC' | 'ODD_EVEN' | 'ALPHABETICAL';
1035
+ /** Configuration for multi-row elements that contain multiple individual rows, each with their own capacity and sequencing. */
635
1036
  interface MultiRowProperties {
636
1037
  /**
637
- * Individual rows of the multi row element
1038
+ * Individual rows within the multi-row element. Each row has its own capacity, sequencing, and category assignment.
638
1039
  * @maxSize 1000
639
1040
  */
640
1041
  rows?: RowElement[];
641
- /** Meta data for vertical labeling */
1042
+ /** Configuration for labeling rows vertically (e.g., Row A, Row B, Row C). Defines how row labels are generated. */
642
1043
  verticalSequencing?: VerticalSequencing;
643
1044
  /**
644
- * Row spacing
1045
+ * Vertical spacing between rows in the multi-row element. Measured in coordinate system units.
645
1046
  * @min 1
646
1047
  * @max 60
647
1048
  */
648
1049
  rowSpacing?: number | null;
649
1050
  /**
650
- * Amount of seats in the row
1051
+ * Number of seats per row in the multi-row element.
651
1052
  * @max 50
652
1053
  */
653
1054
  seatAmount?: number | null;
654
1055
  }
1056
+ /** An individual row within a multi-row element, with its own capacity, sequencing, and category assignment. */
655
1057
  interface RowElement {
656
1058
  /**
657
- * Unique row id
1059
+ * Row ID. Must be unique across all multi-row elements in the seating plan.
658
1060
  * @min 1
659
1061
  */
660
1062
  id?: number;
661
1063
  /**
662
- * User friendly title/label of the row
1064
+ * User-friendly title or label for this row. For example, `Row A` or `Front Row`.
663
1065
  * @minLength 1
664
1066
  * @maxLength 50
665
1067
  */
666
1068
  title?: string | null;
667
1069
  /**
668
- * Row capacity
1070
+ * Number of seats in this row. Maximum 50,000 per row.
669
1071
  * @min 1
670
1072
  * @max 50000
671
1073
  */
672
1074
  capacity?: number | null;
673
- /** Assigned to a category */
1075
+ /** Category assignment for this row, which can override the parent element's category. References a category defined in the seating plan. */
674
1076
  categoryId?: number | null;
675
- /** A place numbering meta data for a single row */
1077
+ /** Configuration for generating seat labels within this row. Defines numbering scheme and starting position. */
676
1078
  sequencing?: Sequencing;
677
- /** Row UI settings */
1079
+ /** Visual properties specific to this row within the multi-row element. Includes positioning relative to parent element. */
678
1080
  uiProperties?: RowElementUiProperties;
679
1081
  }
1082
+ /** Visual properties specific to individual rows within multi-row elements. */
680
1083
  interface RowElementUiProperties {
681
1084
  /**
682
- * Relative x position to the parent element
1085
+ * Horizontal position relative to the parent multi-row element's coordinate system.
683
1086
  * @min -1000000
684
1087
  * @max 1000000
685
1088
  */
686
1089
  relativeX?: number | null;
687
1090
  /**
688
- * Width of the row
1091
+ * Width of this row in coordinate system units.
689
1092
  * @max 1000000
690
1093
  */
691
1094
  width?: number | null;
692
1095
  /**
693
- * Amount of seats in the row
1096
+ * Number of seats in this row. Overrides the capacity field when specified.
694
1097
  * @max 50
695
1098
  */
696
1099
  seatAmount?: number | null;
697
1100
  /**
698
- * Seat spacing
1101
+ * Spacing between seats in this row.
699
1102
  * @min 1
700
1103
  * @max 60
701
1104
  */
702
1105
  seatSpacing?: number | null;
703
- /** Label position */
1106
+ /** Position of labels relative to seats in this row (left, right, both sides, or none). // Position of labels relative to seats in this row. */
704
1107
  labelPosition?: PositionWithLiterals;
705
- /** Seat numbering */
1108
+ /** Numbering scheme for seats in this row (numeric, alphabetical, or odd/even). */
706
1109
  seatNumbering?: NumberingWithLiterals;
707
1110
  }
1111
+ /** Configuration for labeling rows vertically in multi-row elements. */
708
1112
  interface VerticalSequencing {
709
1113
  /**
710
- * First seq element
1114
+ * Starting value for row labeling. For example, `A` for alphabetical sequences or `1` for numeric sequences.
711
1115
  * @minLength 1
712
1116
  * @maxLength 4
713
1117
  */
714
1118
  startAt?: string;
715
- /** Row numbering */
1119
+ /** Numbering scheme for row labels (numeric, alphabetical, or odd/even). */
716
1120
  rowNumbering?: NumberingWithLiterals;
717
- /** If true - direction bottom to top. Otherwise top to bottom. */
1121
+ /** Whether to label rows in reverse order (bottom-to-top instead of top-to-bottom). */
718
1122
  reverseOrder?: boolean | null;
719
1123
  }
1124
+ /** A grouping mechanism for organizing places by pricing tier, access level, or other business criteria. */
720
1125
  interface Category {
721
1126
  /**
722
- * Local category id within the seating plan
1127
+ * Category ID. Must be unique within the seating plan.
723
1128
  * @min 1
724
1129
  */
725
1130
  id?: number;
726
1131
  /**
727
- * A client defined external id for cross referencing.
728
- * Can reference external entities.
729
- * Format: "{entity_fqdn}:{entity_id}"
1132
+ * Client-defined external ID for cross-referencing with pricing or ticketing systems. Format: `{entity_fqdn}:{entity_id}`.
730
1133
  * @minLength 1
731
1134
  * @maxLength 100
732
1135
  */
733
1136
  externalId?: string | null;
734
1137
  /**
735
- * Category label
1138
+ * Human-readable category name, such as `VIP`, `General Admission`, or `Student Discount`.
736
1139
  * @minLength 1
737
1140
  * @maxLength 120
738
1141
  */
739
1142
  title?: string;
740
1143
  /**
741
- * Client configuration object
1144
+ * Client configuration object for storing additional category metadata. Read-only field maintained for backward compatibility.
742
1145
  * @readonly
743
1146
  */
744
1147
  config?: Record<string, any> | null;
745
1148
  /**
746
- * Total capacity
1149
+ * Total capacity of all places assigned to this category. Automatically calculated by summing place capacities.
747
1150
  * @readonly
748
1151
  */
749
1152
  totalCapacity?: number | null;
750
1153
  /**
751
- * Possible places
1154
+ * All places that are assigned to this category. Populated when using the CATEGORIES fieldset.
752
1155
  * @maxSize 50000
753
1156
  * @readonly
754
1157
  */
@@ -765,56 +1168,234 @@ interface ExtendedFields {
765
1168
  */
766
1169
  namespaces?: Record<string, Record<string, any>>;
767
1170
  }
1171
+ /** Visual styling properties for the overall seating plan background and appearance. */
768
1172
  interface SeatingPlanUiProperties {
769
1173
  /**
770
- * #F0F0F0
1174
+ * Background color in hexadecimal format. For example, `#F0F0F0` for light gray.
771
1175
  * @format COLOR_HEX
772
1176
  */
773
1177
  backgroundColor?: string | null;
774
- /** @max 100 */
1178
+ /**
1179
+ * Background opacity as a percentage from 0 (transparent) to 100 (opaque).
1180
+ * @max 100
1181
+ */
775
1182
  backgroundOpacity?: number | null;
776
1183
  }
1184
+ /** A hierarchical grouping of elements for UI organization and bulk operations. */
777
1185
  interface ElementGroup {
778
1186
  /**
779
- * Unique element group id
1187
+ * Element group ID. Must be unique within the seating plan.
780
1188
  * @min 1
781
1189
  */
782
1190
  id?: number;
783
- /** Parent group id */
1191
+ /** ID of the parent group for creating nested group hierarchies. References another ElementGroup in the same seating plan. */
784
1192
  parentElementGroupId?: number | null;
785
- /** Element group UI settings */
1193
+ /** Visual properties for rendering this group in the UI. Includes positioning and dimensions for the group container. */
786
1194
  uiProperties?: ElementGroupUiProperties;
787
1195
  }
1196
+ /** Visual positioning and styling properties for element groups. */
788
1197
  interface ElementGroupUiProperties {
789
1198
  /**
790
- * x position of the group
1199
+ * Horizontal position coordinate of the group container.
791
1200
  * @min -1000000
792
1201
  * @max 1000000
793
1202
  */
794
1203
  x?: number | null;
795
1204
  /**
796
- * y position of the group
1205
+ * Vertical position coordinate of the group container.
797
1206
  * @min -1000000
798
1207
  * @max 1000000
799
1208
  */
800
1209
  y?: number | null;
801
1210
  /**
802
- * width of the group
1211
+ * Width of the group bounding box in coordinate system units.
803
1212
  * @max 1000000
804
1213
  */
805
1214
  width?: number | null;
806
1215
  /**
807
- * height of the group
1216
+ * Height of the group bounding box in coordinate system units.
808
1217
  * @max 1000000
809
1218
  */
810
1219
  height?: number | null;
811
1220
  /**
812
- * rotation angle of the group
1221
+ * Rotation angle of the group in degrees. Applied to all elements within the group.
813
1222
  * @min -180
814
1223
  * @max 180
815
1224
  */
816
1225
  rotationAngle?: number | null;
817
1226
  }
1227
+ /** Request to regenerate cached summaries. */
1228
+ interface RegenerateSummariesRequest {
1229
+ /**
1230
+ * Seating plan ID.
1231
+ * @format GUID
1232
+ */
1233
+ planId?: string | null;
1234
+ }
1235
+ /** Response after regenerating summaries. */
1236
+ interface RegenerateSummariesResponse {
1237
+ /** Regenerated place-level occupancy summary. */
1238
+ seatingReservationsSummary?: SeatingReservationsSummary;
1239
+ /**
1240
+ * Regenerated category-level summaries.
1241
+ * @maxSize 50000
1242
+ */
1243
+ categories?: CategoryDetails[];
1244
+ }
1245
+ /** Aggregated occupancy data for all places in a seating plan. */
1246
+ interface SeatingReservationsSummary {
1247
+ /**
1248
+ * Occupancy details for each place.
1249
+ * @maxSize 50000
1250
+ */
1251
+ places?: PlaceReservationDetails[];
1252
+ }
1253
+ interface DomainEvent extends DomainEventBodyOneOf {
1254
+ createdEvent?: EntityCreatedEvent;
1255
+ updatedEvent?: EntityUpdatedEvent;
1256
+ deletedEvent?: EntityDeletedEvent;
1257
+ actionEvent?: ActionEvent;
1258
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1259
+ id?: string;
1260
+ /**
1261
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1262
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1263
+ */
1264
+ entityFqdn?: string;
1265
+ /**
1266
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1267
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1268
+ */
1269
+ slug?: string;
1270
+ /** ID of the entity associated with the event. */
1271
+ entityId?: string;
1272
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1273
+ eventTime?: Date | null;
1274
+ /**
1275
+ * Whether the event was triggered as a result of a privacy regulation application
1276
+ * (for example, GDPR).
1277
+ */
1278
+ triggeredByAnonymizeRequest?: boolean | null;
1279
+ /** If present, indicates the action that triggered the event. */
1280
+ originatedFrom?: string | null;
1281
+ /**
1282
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1283
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1284
+ */
1285
+ entityEventSequence?: string | null;
1286
+ }
1287
+ /** @oneof */
1288
+ interface DomainEventBodyOneOf {
1289
+ createdEvent?: EntityCreatedEvent;
1290
+ updatedEvent?: EntityUpdatedEvent;
1291
+ deletedEvent?: EntityDeletedEvent;
1292
+ actionEvent?: ActionEvent;
1293
+ }
1294
+ interface EntityCreatedEvent {
1295
+ entityAsJson?: string;
1296
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1297
+ restoreInfo?: RestoreInfo;
1298
+ }
1299
+ interface RestoreInfo {
1300
+ deletedDate?: Date | null;
1301
+ }
1302
+ interface EntityUpdatedEvent {
1303
+ /**
1304
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1305
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1306
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1307
+ */
1308
+ currentEntityAsJson?: string;
1309
+ }
1310
+ interface EntityDeletedEvent {
1311
+ /** Entity that was deleted. */
1312
+ deletedEntityAsJson?: string | null;
1313
+ }
1314
+ interface ActionEvent {
1315
+ bodyAsJson?: string;
1316
+ }
1317
+ interface MessageEnvelope {
1318
+ /**
1319
+ * App instance ID.
1320
+ * @format GUID
1321
+ */
1322
+ instanceId?: string | null;
1323
+ /**
1324
+ * Event type.
1325
+ * @maxLength 150
1326
+ */
1327
+ eventType?: string;
1328
+ /** The identification type and identity data. */
1329
+ identity?: IdentificationData;
1330
+ /** Stringify payload. */
1331
+ data?: string;
1332
+ }
1333
+ interface IdentificationData extends IdentificationDataIdOneOf {
1334
+ /**
1335
+ * ID of a site visitor that has not logged in to the site.
1336
+ * @format GUID
1337
+ */
1338
+ anonymousVisitorId?: string;
1339
+ /**
1340
+ * ID of a site visitor that has logged in to the site.
1341
+ * @format GUID
1342
+ */
1343
+ memberId?: string;
1344
+ /**
1345
+ * ID of a Wix user (site owner, contributor, etc.).
1346
+ * @format GUID
1347
+ */
1348
+ wixUserId?: string;
1349
+ /**
1350
+ * ID of an app.
1351
+ * @format GUID
1352
+ */
1353
+ appId?: string;
1354
+ /** @readonly */
1355
+ identityType?: WebhookIdentityTypeWithLiterals;
1356
+ }
1357
+ /** @oneof */
1358
+ interface IdentificationDataIdOneOf {
1359
+ /**
1360
+ * ID of a site visitor that has not logged in to the site.
1361
+ * @format GUID
1362
+ */
1363
+ anonymousVisitorId?: string;
1364
+ /**
1365
+ * ID of a site visitor that has logged in to the site.
1366
+ * @format GUID
1367
+ */
1368
+ memberId?: string;
1369
+ /**
1370
+ * ID of a Wix user (site owner, contributor, etc.).
1371
+ * @format GUID
1372
+ */
1373
+ wixUserId?: string;
1374
+ /**
1375
+ * ID of an app.
1376
+ * @format GUID
1377
+ */
1378
+ appId?: string;
1379
+ }
1380
+ declare enum WebhookIdentityType {
1381
+ UNKNOWN = "UNKNOWN",
1382
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1383
+ MEMBER = "MEMBER",
1384
+ WIX_USER = "WIX_USER",
1385
+ APP = "APP"
1386
+ }
1387
+ /** @enumType */
1388
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1389
+ /** @docsIgnore */
1390
+ type CreateSeatingReservationApplicationErrors = {
1391
+ code?: 'PLACE_NOT_FOUND';
1392
+ description?: string;
1393
+ data?: Places;
1394
+ } | {
1395
+ code?: 'PLACE_RESERVED';
1396
+ description?: string;
1397
+ data?: UnavailablePlaces;
1398
+ };
818
1399
 
819
1400
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
820
1401
  getUrl: (context: any) => string;
@@ -839,4 +1420,4 @@ declare function getSeatingReservationSummary(): __PublicMethodMetaInfo<'GET', {
839
1420
  externalId: string;
840
1421
  }, GetSeatingReservationSummaryRequest$1, GetSeatingReservationSummaryRequest, GetSeatingReservationSummaryResponse$1, GetSeatingReservationSummaryResponse>;
841
1422
 
842
- export { type __PublicMethodMetaInfo, createSeatingReservation, deleteSeatingReservation, getReservation, getSeatingCategorySummary, getSeatingReservationSummary, querySeatingReservation };
1423
+ export { type ActionEvent as ActionEventOriginal, type App as AppOriginal, type CancelSeatingPlaceReservationsRequest as CancelSeatingPlaceReservationsRequestOriginal, type CancelSeatingPlaceReservationsResponse as CancelSeatingPlaceReservationsResponseOriginal, type CategoryDetails as CategoryDetailsOriginal, type Category as CategoryOriginal, type CreateSeatingReservationApplicationErrors as CreateSeatingReservationApplicationErrorsOriginal, type CreateSeatingReservationRequest as CreateSeatingReservationRequestOriginal, type CreateSeatingReservationResponse as CreateSeatingReservationResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteSeatingPlaceReservationRequest as DeleteSeatingPlaceReservationRequestOriginal, type DeleteSeatingReservationRequest as DeleteSeatingReservationRequestOriginal, type DeleteSeatingReservationResponse as DeleteSeatingReservationResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type ElementGroup as ElementGroupOriginal, type ElementGroupUiProperties as ElementGroupUiPropertiesOriginal, type Element as ElementOriginal, type ElementUiProperties as ElementUiPropertiesOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type GetReservationRequest as GetReservationRequestOriginal, type GetReservationResponse as GetReservationResponseOriginal, type GetReservedPlacesRequest as GetReservedPlacesRequestOriginal, type GetReservedPlacesResponse as GetReservedPlacesResponseOriginal, type GetSeatingCategorySummaryRequest as GetSeatingCategorySummaryRequestOriginal, type GetSeatingCategorySummaryResponse as GetSeatingCategorySummaryResponseOriginal, type GetSeatingReservationSummaryRequest as GetSeatingReservationSummaryRequestOriginal, type GetSeatingReservationSummaryResponse as GetSeatingReservationSummaryResponseOriginal, Icon as IconOriginal, type IconWithLiterals as IconWithLiteralsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ListReservedPlacesRequest as ListReservedPlacesRequestOriginal, type ListReservedPlacesResponse as ListReservedPlacesResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiRowProperties as MultiRowPropertiesOriginal, Numbering as NumberingOriginal, type NumberingWithLiterals as NumberingWithLiteralsOriginal, type Page as PageOriginal, type PagingMetadata as PagingMetadataOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type Place as PlaceOriginal, type PlaceReservationDetails as PlaceReservationDetailsOriginal, type PlaceReservation as PlaceReservationOriginal, PlaceTypeEnumType as PlaceTypeEnumTypeOriginal, type PlaceTypeEnumTypeWithLiterals as PlaceTypeEnumTypeWithLiteralsOriginal, type Places as PlacesOriginal, Position as PositionOriginal, type PositionWithLiterals as PositionWithLiteralsOriginal, type QuerySeatingReservationRequest as QuerySeatingReservationRequestOriginal, type QuerySeatingReservationResponse as QuerySeatingReservationResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RegenerateSummariesRequest as RegenerateSummariesRequestOriginal, type RegenerateSummariesResponse as RegenerateSummariesResponseOriginal, type ReservationErrorDetails as ReservationErrorDetailsOriginal, type ReservationOptions as ReservationOptionsOriginal, type ReservedPlace as ReservedPlaceOriginal, type RestoreInfo as RestoreInfoOriginal, type RowElement as RowElementOriginal, type RowElementUiProperties as RowElementUiPropertiesOriginal, type SeatReservation as SeatReservationOriginal, type SeatingPlanCategoriesSummaryUpdated as SeatingPlanCategoriesSummaryUpdatedOriginal, type SeatingPlan as SeatingPlanOriginal, type SeatingPlanUiProperties as SeatingPlanUiPropertiesOriginal, type SeatingReservation as SeatingReservationOriginal, type SeatingReservationsSummary as SeatingReservationsSummaryOriginal, type Section as SectionOriginal, type Sequencing as SequencingOriginal, ShapeTypeEnumType as ShapeTypeEnumTypeOriginal, type ShapeTypeEnumTypeWithLiterals as ShapeTypeEnumTypeWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type URI as URIOriginal, type UnavailablePlaces as UnavailablePlacesOriginal, type UpdateSeatingReservationRequest as UpdateSeatingReservationRequestOriginal, type UpdateSeatingReservationResponse as UpdateSeatingReservationResponseOriginal, type VerticalSequencing as VerticalSequencingOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createSeatingReservation, deleteSeatingReservation, getReservation, getSeatingCategorySummary, getSeatingReservationSummary, querySeatingReservation };