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