@wix/auto_sdk_seatings_seating-reservation 1.0.13 → 1.0.15
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.d.ts +19 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +205 -84
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +186 -72
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +19 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +205 -84
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +186 -72
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +19 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +205 -84
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +186 -72
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +19 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +205 -84
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +186 -72
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,132 +1,139 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* A seating reservation represents a booking for one or more places within a seating plan.
|
|
5
|
+
*
|
|
6
|
+
* 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.
|
|
7
|
+
*/
|
|
3
8
|
interface SeatingReservation {
|
|
4
9
|
/**
|
|
5
|
-
*
|
|
10
|
+
* Reservation ID.
|
|
6
11
|
* @format GUID
|
|
7
12
|
* @readonly
|
|
8
13
|
*/
|
|
9
14
|
_id?: string | null;
|
|
10
15
|
/**
|
|
11
|
-
*
|
|
16
|
+
* Seating plan ID.
|
|
12
17
|
* @format GUID
|
|
13
18
|
* @readonly
|
|
14
19
|
*/
|
|
15
20
|
seatingPlanId?: string | null;
|
|
16
21
|
/**
|
|
17
|
-
*
|
|
22
|
+
* External seating plan ID used for integration with third-party venue systems.
|
|
18
23
|
* @minLength 1
|
|
19
24
|
* @maxLength 100
|
|
20
25
|
* @readonly
|
|
21
26
|
*/
|
|
22
27
|
externalSeatingPlanId?: string | null;
|
|
23
28
|
/**
|
|
24
|
-
*
|
|
29
|
+
* Places reserved in this reservation. Each place can have its own capacity requirements.
|
|
25
30
|
* @minSize 1
|
|
26
31
|
* @maxSize 100
|
|
27
32
|
*/
|
|
28
33
|
reservedPlaces?: PlaceReservation[];
|
|
29
34
|
/**
|
|
30
|
-
*
|
|
31
|
-
* Can reference external entities.
|
|
32
|
-
* Format: "{fqdn}:{entity guid}"
|
|
35
|
+
* External reference ID for cross-system integration. Format: `{fqdn}:{entity guid}`. For example, `wix.events.v1.ticket:12345678-1234-1234-1234-123456789012`.
|
|
33
36
|
* @minLength 1
|
|
34
37
|
* @maxLength 100
|
|
35
38
|
*/
|
|
36
39
|
externalId?: string | null;
|
|
37
40
|
/**
|
|
38
|
-
* Revision number, which increments by 1 each time the reservation is updated.
|
|
41
|
+
* 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.
|
|
39
42
|
* @readonly
|
|
40
43
|
*/
|
|
41
44
|
revision?: string | null;
|
|
42
45
|
}
|
|
46
|
+
/** Individual place reservation within a seating arrangement. */
|
|
43
47
|
interface PlaceReservation {
|
|
44
48
|
/**
|
|
45
|
-
*
|
|
49
|
+
* Place ID. For example, `A1-1-5` for section A, row 1, seat 5.
|
|
46
50
|
* @minLength 5
|
|
47
51
|
* @maxLength 11
|
|
48
52
|
*/
|
|
49
53
|
_id?: string;
|
|
50
54
|
/**
|
|
51
|
-
* Number of
|
|
52
|
-
*
|
|
55
|
+
* Number of people to be seated at this place. Used for area seating where multiple guests can occupy a single reservable location.
|
|
56
|
+
*
|
|
57
|
+
* Default: `1`
|
|
53
58
|
* @min 1
|
|
54
59
|
* @max 50
|
|
55
60
|
*/
|
|
56
61
|
capacity?: number | null;
|
|
57
62
|
/**
|
|
58
|
-
*
|
|
63
|
+
* Section name within the venue. For example, `Orchestra` or `Balcony`.
|
|
59
64
|
* @readonly
|
|
60
65
|
*/
|
|
61
66
|
sectionLabel?: string | null;
|
|
62
67
|
/**
|
|
63
|
-
* Area
|
|
68
|
+
* Area name within a section. Used for general admission or standing areas.
|
|
64
69
|
* @readonly
|
|
65
70
|
*/
|
|
66
71
|
areaLabel?: string | null;
|
|
67
72
|
/**
|
|
68
|
-
* Table
|
|
73
|
+
* Table identifier for table-based seating arrangements.
|
|
69
74
|
* @readonly
|
|
70
75
|
*/
|
|
71
76
|
tableLabel?: string | null;
|
|
72
77
|
/**
|
|
73
|
-
* Row
|
|
78
|
+
* Row identifier within a section or area.
|
|
74
79
|
* @readonly
|
|
75
80
|
*/
|
|
76
81
|
rowLabel?: string | null;
|
|
77
82
|
/**
|
|
78
|
-
*
|
|
83
|
+
* Individual seat identifier within a row or at a table.
|
|
79
84
|
* @readonly
|
|
80
85
|
*/
|
|
81
86
|
seatLabel?: string | null;
|
|
82
87
|
}
|
|
88
|
+
/** Triggers when seating plan category summaries are updated. */
|
|
83
89
|
interface SeatingPlanCategoriesSummaryUpdated {
|
|
84
90
|
/**
|
|
85
|
-
* Seating plan
|
|
91
|
+
* Seating plan ID.
|
|
86
92
|
* @format GUID
|
|
87
93
|
*/
|
|
88
94
|
seatingPlanId?: string;
|
|
89
|
-
/** External seating plan
|
|
95
|
+
/** External seating plan ID. */
|
|
90
96
|
externalSeatingPlanId?: string | null;
|
|
91
97
|
/**
|
|
92
|
-
*
|
|
98
|
+
* Updated category capacity and reservation counts.
|
|
93
99
|
* @maxSize 100
|
|
94
100
|
*/
|
|
95
101
|
categories?: CategoryDetails[];
|
|
96
102
|
/**
|
|
97
|
-
* Summary revision.
|
|
103
|
+
* Summary revision number for cache invalidation.
|
|
98
104
|
* @readonly
|
|
99
105
|
*/
|
|
100
106
|
revision?: string | null;
|
|
101
107
|
}
|
|
108
|
+
/** Category capacity and reservation summary. */
|
|
102
109
|
interface CategoryDetails {
|
|
103
110
|
/**
|
|
104
|
-
* Seating
|
|
111
|
+
* Seating Plan ID.
|
|
105
112
|
* @format GUID
|
|
106
113
|
* @readonly
|
|
107
114
|
*/
|
|
108
115
|
seatingPlanId?: string | null;
|
|
109
116
|
/**
|
|
110
|
-
* External
|
|
117
|
+
* External Seating Plan ID used for integration with third-party systems.
|
|
111
118
|
* @minLength 1
|
|
112
119
|
* @maxLength 100
|
|
113
120
|
* @readonly
|
|
114
121
|
*/
|
|
115
122
|
externalSeatingPlanId?: string | null;
|
|
116
123
|
/**
|
|
117
|
-
* External category
|
|
124
|
+
* External Category ID used for mapping to venue-specific category names. For example, `VIP` or `ORCHESTRA`.
|
|
118
125
|
* @minLength 1
|
|
119
126
|
* @maxLength 100
|
|
120
127
|
* @readonly
|
|
121
128
|
*/
|
|
122
129
|
externalCategoryId?: string | null;
|
|
123
130
|
/**
|
|
124
|
-
* Total capacity in
|
|
131
|
+
* Total seating capacity available in category.
|
|
125
132
|
* @readonly
|
|
126
133
|
*/
|
|
127
134
|
totalCapacity?: number | null;
|
|
128
135
|
/**
|
|
129
|
-
*
|
|
136
|
+
* Number of seats currently reserved in category.
|
|
130
137
|
* @readonly
|
|
131
138
|
*/
|
|
132
139
|
reserved?: number | null;
|
|
@@ -246,57 +253,65 @@ interface CustomTag {
|
|
|
246
253
|
*/
|
|
247
254
|
tag?: string;
|
|
248
255
|
}
|
|
256
|
+
/** Request to create a seating reservation. */
|
|
249
257
|
interface CreateSeatingReservationRequest {
|
|
250
|
-
/**
|
|
258
|
+
/** Reservation to create. */
|
|
251
259
|
reservation?: SeatingReservation;
|
|
252
260
|
}
|
|
261
|
+
/** Response after creating a seating reservation. */
|
|
253
262
|
interface CreateSeatingReservationResponse {
|
|
254
|
-
/** Created reservation */
|
|
263
|
+
/** Created reservation. */
|
|
255
264
|
reservation?: SeatingReservation;
|
|
256
265
|
}
|
|
266
|
+
/** Details about specific places, used for error reporting. */
|
|
257
267
|
interface Places {
|
|
258
268
|
/**
|
|
259
|
-
*
|
|
269
|
+
* List of place identifiers. For example, `A1-1-5` or `VIP-12`.
|
|
260
270
|
* @minSize 1
|
|
261
271
|
* @maxSize 100
|
|
262
272
|
*/
|
|
263
273
|
places?: string[];
|
|
264
274
|
}
|
|
275
|
+
/** Details about places that are unavailable, including capacity conflicts. */
|
|
265
276
|
interface UnavailablePlaces {
|
|
266
277
|
/**
|
|
267
|
-
*
|
|
278
|
+
* List of place identifiers that are unavailable. For example, `A1-1-5` or `VIP-12`.
|
|
268
279
|
* @minSize 1
|
|
269
280
|
* @maxSize 100
|
|
270
281
|
*/
|
|
271
282
|
unavailablePlaces?: string[];
|
|
272
283
|
/**
|
|
273
|
-
*
|
|
284
|
+
* Detailed capacity information for each unavailable place.
|
|
274
285
|
* @minSize 1
|
|
275
286
|
* @maxSize 100
|
|
276
287
|
*/
|
|
277
288
|
reservationErrorDetails?: ReservationErrorDetails[];
|
|
278
289
|
}
|
|
290
|
+
/** Capacity conflict details for a given place. */
|
|
279
291
|
interface ReservationErrorDetails {
|
|
280
|
-
/**
|
|
292
|
+
/** ID of the place with a capacity conflict. */
|
|
281
293
|
_id?: string;
|
|
282
|
-
/**
|
|
294
|
+
/** Currently available capacity at this place. */
|
|
283
295
|
available?: number;
|
|
284
|
-
/** Requested capacity */
|
|
296
|
+
/** Requested capacity that exceeds the available capacity. */
|
|
285
297
|
requested?: number;
|
|
286
298
|
}
|
|
299
|
+
/** Request to retrieve a specific seating reservation. */
|
|
287
300
|
interface GetReservationRequest {
|
|
288
301
|
/**
|
|
289
|
-
*
|
|
302
|
+
* Reservation ID.
|
|
290
303
|
* @format GUID
|
|
291
304
|
*/
|
|
292
305
|
_id: string | null;
|
|
293
306
|
}
|
|
307
|
+
/** Response containing the requested seating reservation. */
|
|
294
308
|
interface GetReservationResponse {
|
|
295
|
-
/**
|
|
309
|
+
/** Retrieved reservation. */
|
|
296
310
|
reservation?: SeatingReservation;
|
|
297
311
|
}
|
|
312
|
+
/** Request to query seating reservations. */
|
|
298
313
|
interface QuerySeatingReservationRequest {
|
|
299
|
-
/**
|
|
314
|
+
/** Query object with filter criteria and pagination settings. */
|
|
300
315
|
query: QueryV2;
|
|
301
316
|
}
|
|
302
317
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -364,10 +379,11 @@ interface CursorPaging {
|
|
|
364
379
|
*/
|
|
365
380
|
cursor?: string | null;
|
|
366
381
|
}
|
|
382
|
+
/** Response containing matching seating reservations. */
|
|
367
383
|
interface QuerySeatingReservationResponse {
|
|
368
|
-
/** Found reservations */
|
|
384
|
+
/** Found reservations matching the query criteria. */
|
|
369
385
|
reservations?: SeatingReservation[];
|
|
370
|
-
/** Paging
|
|
386
|
+
/** Paging metadata for result navigation. */
|
|
371
387
|
metadata?: PagingMetadataV2;
|
|
372
388
|
}
|
|
373
389
|
interface PagingMetadataV2 {
|
|
@@ -394,129 +410,145 @@ interface Cursors {
|
|
|
394
410
|
*/
|
|
395
411
|
prev?: string | null;
|
|
396
412
|
}
|
|
413
|
+
/** Request to delete a seating reservation. */
|
|
397
414
|
interface DeleteSeatingReservationRequest {
|
|
398
415
|
/**
|
|
399
|
-
*
|
|
416
|
+
* Reservation ID.
|
|
400
417
|
* @format GUID
|
|
401
418
|
*/
|
|
402
419
|
_id: string | null;
|
|
403
420
|
}
|
|
421
|
+
/** Response after deleting a seating reservation. */
|
|
404
422
|
interface DeleteSeatingReservationResponse {
|
|
405
|
-
/**
|
|
423
|
+
/** Deleted reservation. */
|
|
406
424
|
reservation?: SeatingReservation;
|
|
407
425
|
}
|
|
426
|
+
/** Request to delete a specific place reservation. */
|
|
408
427
|
interface DeleteSeatingPlaceReservationRequest {
|
|
409
|
-
/**
|
|
428
|
+
/** Place reservation ID. */
|
|
410
429
|
_id?: string | null;
|
|
411
430
|
/**
|
|
412
|
-
*
|
|
431
|
+
* Seating reservation ID that contains the place reservation.
|
|
413
432
|
* @format GUID
|
|
414
433
|
*/
|
|
415
434
|
reservationId?: string | null;
|
|
416
435
|
}
|
|
417
436
|
interface Empty {
|
|
418
437
|
}
|
|
438
|
+
/** Request to cancel specific place reservations. */
|
|
419
439
|
interface CancelSeatingPlaceReservationsRequest {
|
|
420
440
|
/**
|
|
421
|
-
*
|
|
441
|
+
* Seating reservation ID containing the places to cancel.
|
|
422
442
|
* @format GUID
|
|
423
443
|
*/
|
|
424
444
|
reservationId?: string | null;
|
|
425
445
|
/**
|
|
426
|
-
*
|
|
446
|
+
* Place reservations to cancel with their reduced capacity.
|
|
427
447
|
* @minSize 1
|
|
428
448
|
* @maxSize 100
|
|
429
449
|
*/
|
|
430
450
|
placeReservations?: PlaceReservationDetails[];
|
|
431
451
|
}
|
|
452
|
+
/** Occupancy details for a specific place in a seating plan. */
|
|
432
453
|
interface PlaceReservationDetails {
|
|
454
|
+
/** Place ID. */
|
|
433
455
|
placeId?: string;
|
|
456
|
+
/** Number of occupied seats or capacity units at this place. */
|
|
434
457
|
occupied?: number;
|
|
435
458
|
}
|
|
459
|
+
/** Response after canceling place reservations. */
|
|
436
460
|
interface CancelSeatingPlaceReservationsResponse {
|
|
437
|
-
/**
|
|
461
|
+
/** Reservation with canceled place reservations. */
|
|
438
462
|
reservation?: SeatingReservation;
|
|
439
463
|
}
|
|
464
|
+
/** Request to update a seating reservation. */
|
|
440
465
|
interface UpdateSeatingReservationRequest {
|
|
441
|
-
/**
|
|
466
|
+
/** Reservation to update with modified capacity values. */
|
|
442
467
|
reservation?: SeatingReservation;
|
|
443
468
|
}
|
|
469
|
+
/** Response after updating a seating reservation. */
|
|
444
470
|
interface UpdateSeatingReservationResponse {
|
|
445
|
-
/**
|
|
471
|
+
/** Updated reservation. */
|
|
446
472
|
reservation?: SeatingReservation;
|
|
447
473
|
}
|
|
474
|
+
/** Request to retrieve all reserved places for a seating plan. */
|
|
448
475
|
interface GetReservedPlacesRequest {
|
|
449
476
|
/**
|
|
450
|
-
* Seating plan
|
|
477
|
+
* Seating plan ID.
|
|
451
478
|
* @format GUID
|
|
452
479
|
*/
|
|
453
480
|
_id?: string | null;
|
|
454
481
|
}
|
|
482
|
+
/** Response containing all reserved places for a seating plan. */
|
|
455
483
|
interface GetReservedPlacesResponse {
|
|
456
|
-
/** Reserved places
|
|
484
|
+
/** Reserved places in the seating plan. */
|
|
457
485
|
placeReservations?: PlaceReservation[];
|
|
458
486
|
}
|
|
487
|
+
/** Request to list reserved places with optional filtering. */
|
|
459
488
|
interface ListReservedPlacesRequest {
|
|
460
489
|
/**
|
|
461
|
-
* Seating plan
|
|
490
|
+
* Seating plan ID.
|
|
462
491
|
* @format GUID
|
|
463
492
|
*/
|
|
464
493
|
planId?: string | null;
|
|
465
494
|
/**
|
|
466
|
-
* Optional filter by reservation
|
|
495
|
+
* Optional filter by reservation ID.
|
|
467
496
|
* @format GUID
|
|
468
497
|
*/
|
|
469
498
|
reservationId?: string | null;
|
|
470
499
|
/**
|
|
471
|
-
* Optional filter by seat
|
|
500
|
+
* Optional filter by specific seat IDs.
|
|
472
501
|
* @maxSize 50
|
|
473
502
|
* @maxLength 20
|
|
474
503
|
*/
|
|
475
504
|
seatId?: string[];
|
|
476
|
-
/** Paging */
|
|
505
|
+
/** Paging configuration. */
|
|
477
506
|
paging?: Paging;
|
|
478
507
|
}
|
|
508
|
+
/** Response containing filtered reserved places. */
|
|
479
509
|
interface ListReservedPlacesResponse {
|
|
480
|
-
/**
|
|
510
|
+
/** Reserved places matching the filter criteria. */
|
|
481
511
|
reservedPlaces?: ReservedPlace[];
|
|
482
|
-
/** Paging */
|
|
512
|
+
/** Paging metadata for result navigation. */
|
|
483
513
|
pagingMetadata?: PagingMetadata;
|
|
484
514
|
}
|
|
515
|
+
/** Internal representation of a place reservation. */
|
|
485
516
|
interface SeatReservation {
|
|
486
517
|
/**
|
|
487
|
-
* Place reservation
|
|
518
|
+
* Place reservation ID.
|
|
488
519
|
* @maxLength 72
|
|
489
520
|
*/
|
|
490
521
|
seatReservationId?: string | null;
|
|
491
522
|
/**
|
|
492
|
-
*
|
|
523
|
+
* Place ID.
|
|
493
524
|
* @maxLength 20
|
|
494
525
|
*/
|
|
495
526
|
seatId?: string | null;
|
|
496
527
|
/**
|
|
497
|
-
* Seating plan
|
|
528
|
+
* Seating plan ID.
|
|
498
529
|
* @format GUID
|
|
499
530
|
*/
|
|
500
531
|
planId?: string | null;
|
|
501
532
|
/**
|
|
502
|
-
* Seating reservation
|
|
533
|
+
* Seating reservation ID.
|
|
503
534
|
* @format GUID
|
|
504
535
|
*/
|
|
505
536
|
reservationId?: string | null;
|
|
506
537
|
/**
|
|
507
|
-
*
|
|
538
|
+
* Number of occupied spots at this place.
|
|
508
539
|
* @max 50000
|
|
509
540
|
*/
|
|
510
541
|
spots?: number | null;
|
|
511
|
-
/**
|
|
542
|
+
/** Whether this is an area-based reservation (true) or individual seat (false). */
|
|
512
543
|
area?: boolean | null;
|
|
513
544
|
}
|
|
545
|
+
/** Individual reserved place with full context. */
|
|
514
546
|
interface ReservedPlace {
|
|
515
|
-
/** Place reservation */
|
|
547
|
+
/** Place reservation details. */
|
|
516
548
|
seatReservation?: SeatReservation;
|
|
517
|
-
/**
|
|
549
|
+
/** Parent reservation (active). */
|
|
518
550
|
reservation?: SeatingReservation;
|
|
519
|
-
/**
|
|
551
|
+
/** Parent reservation (deleted, for audit trail). */
|
|
520
552
|
reservationFromTrashBin?: SeatingReservation;
|
|
521
553
|
}
|
|
522
554
|
interface PagingMetadata {
|
|
@@ -529,32 +561,40 @@ interface PagingMetadata {
|
|
|
529
561
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
530
562
|
tooManyToCount?: boolean | null;
|
|
531
563
|
}
|
|
564
|
+
/** Request to retrieve category-level capacity summary. */
|
|
532
565
|
interface GetSeatingCategorySummaryRequest {
|
|
533
566
|
/**
|
|
534
|
-
*
|
|
567
|
+
* External seating plan ID.
|
|
535
568
|
* @minLength 1
|
|
536
569
|
* @maxLength 100
|
|
537
570
|
*/
|
|
538
571
|
externalId?: string;
|
|
539
572
|
}
|
|
573
|
+
/** Response containing capacity summary by category. */
|
|
540
574
|
interface GetSeatingCategorySummaryResponse {
|
|
541
575
|
/**
|
|
542
|
-
*
|
|
576
|
+
* Capacity and reservation counts by category.
|
|
543
577
|
* @maxSize 50000
|
|
544
578
|
*/
|
|
545
579
|
categories?: CategoryDetails[];
|
|
546
580
|
}
|
|
581
|
+
/** Request to retrieve detailed place-level occupancy data. */
|
|
547
582
|
interface GetSeatingReservationSummaryRequest {
|
|
548
583
|
/**
|
|
549
|
-
*
|
|
584
|
+
* External seating plan ID.
|
|
550
585
|
* @minLength 1
|
|
551
586
|
* @maxLength 100
|
|
552
587
|
*/
|
|
553
588
|
externalId: string;
|
|
554
589
|
}
|
|
590
|
+
/** Response containing complete seating plan and occupancy data. */
|
|
555
591
|
interface GetSeatingReservationSummaryResponse {
|
|
592
|
+
/** Complete seating plan structure. */
|
|
556
593
|
plan?: SeatingPlan;
|
|
557
|
-
/**
|
|
594
|
+
/**
|
|
595
|
+
* Occupancy details for each place in the plan.
|
|
596
|
+
* @maxSize 50000
|
|
597
|
+
*/
|
|
558
598
|
places?: PlaceReservationDetails[];
|
|
559
599
|
}
|
|
560
600
|
/** 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. */
|
|
@@ -1183,20 +1223,30 @@ interface ElementGroupUiProperties {
|
|
|
1183
1223
|
*/
|
|
1184
1224
|
rotationAngle?: number | null;
|
|
1185
1225
|
}
|
|
1226
|
+
/** Request to regenerate cached summaries. */
|
|
1186
1227
|
interface RegenerateSummariesRequest {
|
|
1187
1228
|
/**
|
|
1188
|
-
* Seating plan
|
|
1229
|
+
* Seating plan ID.
|
|
1189
1230
|
* @format GUID
|
|
1190
1231
|
*/
|
|
1191
1232
|
planId?: string | null;
|
|
1192
1233
|
}
|
|
1234
|
+
/** Response after regenerating summaries. */
|
|
1193
1235
|
interface RegenerateSummariesResponse {
|
|
1236
|
+
/** Regenerated place-level occupancy summary. */
|
|
1194
1237
|
seatingReservationsSummary?: SeatingReservationsSummary;
|
|
1195
|
-
/**
|
|
1238
|
+
/**
|
|
1239
|
+
* Regenerated category-level summaries.
|
|
1240
|
+
* @maxSize 50000
|
|
1241
|
+
*/
|
|
1196
1242
|
categories?: CategoryDetails[];
|
|
1197
1243
|
}
|
|
1244
|
+
/** Aggregated occupancy data for all places in a seating plan. */
|
|
1198
1245
|
interface SeatingReservationsSummary {
|
|
1199
|
-
/**
|
|
1246
|
+
/**
|
|
1247
|
+
* Occupancy details for each place.
|
|
1248
|
+
* @maxSize 50000
|
|
1249
|
+
*/
|
|
1200
1250
|
places?: PlaceReservationDetails[];
|
|
1201
1251
|
}
|
|
1202
1252
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -1261,6 +1311,70 @@ interface EntityDeletedEvent {
|
|
|
1261
1311
|
interface ActionEvent {
|
|
1262
1312
|
body?: string;
|
|
1263
1313
|
}
|
|
1314
|
+
/** Request to list all available places in a seating plan. */
|
|
1315
|
+
interface ListAvailablePlacesRequest {
|
|
1316
|
+
/**
|
|
1317
|
+
* External seating plan ID. For example, `wix.events.v1.event:abc-123-def`.
|
|
1318
|
+
* @minLength 1
|
|
1319
|
+
* @maxLength 100
|
|
1320
|
+
*/
|
|
1321
|
+
externalId?: string;
|
|
1322
|
+
}
|
|
1323
|
+
/** Response containing all available places with their details. */
|
|
1324
|
+
interface ListAvailablePlacesResponse {
|
|
1325
|
+
/**
|
|
1326
|
+
* Available places across all categories in the seating plan.
|
|
1327
|
+
* @maxSize 50000
|
|
1328
|
+
*/
|
|
1329
|
+
places?: AvailablePlace[];
|
|
1330
|
+
}
|
|
1331
|
+
/** An individual available place with all relevant details. */
|
|
1332
|
+
interface AvailablePlace {
|
|
1333
|
+
/**
|
|
1334
|
+
* Place ID in the format `{section_id}-{element_id}-{label}`. For example, `0-1-A5`.
|
|
1335
|
+
* @minLength 1
|
|
1336
|
+
* @maxLength 20
|
|
1337
|
+
*/
|
|
1338
|
+
placeId?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Human-readable label for this place, such as `A1`, `12`, or `VIP1`.
|
|
1341
|
+
* @minLength 1
|
|
1342
|
+
* @maxLength 4
|
|
1343
|
+
*/
|
|
1344
|
+
label?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* Section name where this place is located. For example, `Orchestra` or `Balcony`.
|
|
1347
|
+
* @minLength 1
|
|
1348
|
+
* @maxLength 20
|
|
1349
|
+
*/
|
|
1350
|
+
sectionLabel?: string | null;
|
|
1351
|
+
/**
|
|
1352
|
+
* Element label from the seating plan. For example, `Row A`, `Table 5`, or `General Admission`.
|
|
1353
|
+
* @minLength 1
|
|
1354
|
+
* @maxLength 50
|
|
1355
|
+
*/
|
|
1356
|
+
elementLabel?: string | null;
|
|
1357
|
+
/** Numeric category ID this place is assigned to for pricing and organization. */
|
|
1358
|
+
categoryId?: number;
|
|
1359
|
+
/**
|
|
1360
|
+
* External category ID for cross-referencing with ticketing systems. Format: `{entity_fqdn}:{entity_id}`. For example, `wix.events.v1.ticket_definition:xyz-456`.
|
|
1361
|
+
* @minLength 1
|
|
1362
|
+
* @maxLength 100
|
|
1363
|
+
*/
|
|
1364
|
+
externalCategoryId?: string | null;
|
|
1365
|
+
/** Type of seating element (AREA, ROW, MULTI_ROW, TABLE, ROUND_TABLE, SHAPE). */
|
|
1366
|
+
elementType?: TypeWithLiterals;
|
|
1367
|
+
/**
|
|
1368
|
+
* Available capacity at this place. For AREA type: remaining spots; for other types: 0 or 1.
|
|
1369
|
+
* @max 50000
|
|
1370
|
+
*/
|
|
1371
|
+
availableCapacity?: number;
|
|
1372
|
+
/**
|
|
1373
|
+
* Total capacity of this place.
|
|
1374
|
+
* @max 50000
|
|
1375
|
+
*/
|
|
1376
|
+
totalCapacity?: number;
|
|
1377
|
+
}
|
|
1264
1378
|
interface MessageEnvelope {
|
|
1265
1379
|
/**
|
|
1266
1380
|
* App instance ID.
|
|
@@ -1414,35 +1528,35 @@ interface SeatingReservationDeletedEnvelope {
|
|
|
1414
1528
|
*/
|
|
1415
1529
|
declare function onSeatingReservationDeleted(handler: (event: SeatingReservationDeletedEnvelope) => void | Promise<void>): void;
|
|
1416
1530
|
/**
|
|
1417
|
-
* Creates a seating reservation
|
|
1531
|
+
* Creates a seating reservation for one or more places within a seating plan.
|
|
1418
1532
|
* @public
|
|
1419
1533
|
* @documentationMaturity preview
|
|
1420
1534
|
* @permissionId SEATING_PLANS.MANAGE_RESERVATIONS
|
|
1421
1535
|
* @applicableIdentity APP
|
|
1422
|
-
* @returns Created reservation
|
|
1536
|
+
* @returns Created reservation.
|
|
1423
1537
|
* @fqn com.wixpress.seating.SeatingReservationService.CreateSeatingReservation
|
|
1424
1538
|
*/
|
|
1425
1539
|
declare function createSeatingReservation(options?: CreateSeatingReservationOptions): Promise<NonNullablePaths<SeatingReservation, `reservedPlaces` | `reservedPlaces.${number}._id`, 4> & {
|
|
1426
1540
|
__applicationErrorsType?: CreateSeatingReservationApplicationErrors;
|
|
1427
1541
|
}>;
|
|
1428
1542
|
interface CreateSeatingReservationOptions {
|
|
1429
|
-
/**
|
|
1543
|
+
/** Reservation to create. */
|
|
1430
1544
|
reservation?: SeatingReservation;
|
|
1431
1545
|
}
|
|
1432
1546
|
/**
|
|
1433
|
-
*
|
|
1434
|
-
* @param _id -
|
|
1547
|
+
* Retrieves a seating reservation by ID.
|
|
1548
|
+
* @param _id - Reservation ID.
|
|
1435
1549
|
* @public
|
|
1436
1550
|
* @documentationMaturity preview
|
|
1437
1551
|
* @requiredField _id
|
|
1438
1552
|
* @permissionId SEATING_PLANS.READ_RESERVATIONS
|
|
1439
1553
|
* @applicableIdentity APP
|
|
1440
|
-
* @returns
|
|
1554
|
+
* @returns Retrieved reservation.
|
|
1441
1555
|
* @fqn com.wixpress.seating.SeatingReservationService.GetReservation
|
|
1442
1556
|
*/
|
|
1443
1557
|
declare function getReservation(_id: string): Promise<NonNullablePaths<SeatingReservation, `reservedPlaces` | `reservedPlaces.${number}._id`, 4>>;
|
|
1444
1558
|
/**
|
|
1445
|
-
*
|
|
1559
|
+
* Retrieves seating reservations that match specified criteria.
|
|
1446
1560
|
* @public
|
|
1447
1561
|
* @documentationMaturity preview
|
|
1448
1562
|
* @permissionId SEATING_PLANS.READ_RESERVATIONS
|
|
@@ -1476,39 +1590,46 @@ interface ReservationsQueryBuilder {
|
|
|
1476
1590
|
find: () => Promise<ReservationsQueryResult>;
|
|
1477
1591
|
}
|
|
1478
1592
|
/**
|
|
1479
|
-
* Deletes
|
|
1480
|
-
* @param _id -
|
|
1593
|
+
* Deletes a seating reservation and releases all reserved places.
|
|
1594
|
+
* @param _id - Reservation ID.
|
|
1481
1595
|
* @public
|
|
1482
1596
|
* @documentationMaturity preview
|
|
1483
1597
|
* @requiredField _id
|
|
1484
1598
|
* @permissionId SEATING_PLANS.MANAGE_RESERVATIONS
|
|
1485
1599
|
* @applicableIdentity APP
|
|
1600
|
+
* @returns Response after deleting a seating reservation.
|
|
1486
1601
|
* @fqn com.wixpress.seating.SeatingReservationService.DeleteSeatingReservation
|
|
1487
1602
|
*/
|
|
1488
1603
|
declare function deleteSeatingReservation(_id: string): Promise<NonNullablePaths<DeleteSeatingReservationResponse, `reservation.reservedPlaces` | `reservation.reservedPlaces.${number}._id`, 5>>;
|
|
1489
|
-
/**
|
|
1604
|
+
/**
|
|
1605
|
+
* Retrieves capacity and reservation summary by seating category.
|
|
1606
|
+
* @public
|
|
1490
1607
|
* @documentationMaturity preview
|
|
1491
1608
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1492
1609
|
* @applicableIdentity APP
|
|
1610
|
+
* @returns Response containing capacity summary by category.
|
|
1493
1611
|
* @fqn com.wixpress.seating.SeatingReservationService.GetSeatingCategorySummary
|
|
1494
1612
|
*/
|
|
1495
1613
|
declare function getSeatingCategorySummary(options?: GetSeatingCategorySummaryOptions): Promise<NonNullablePaths<GetSeatingCategorySummaryResponse, `categories`, 2>>;
|
|
1496
1614
|
interface GetSeatingCategorySummaryOptions {
|
|
1497
1615
|
/**
|
|
1498
|
-
*
|
|
1616
|
+
* External seating plan ID.
|
|
1499
1617
|
* @minLength 1
|
|
1500
1618
|
* @maxLength 100
|
|
1501
1619
|
*/
|
|
1502
1620
|
externalId?: string;
|
|
1503
1621
|
}
|
|
1504
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Retrieves detailed place-level occupancy data for a seating plan.
|
|
1624
|
+
* @param externalId - External seating plan ID.
|
|
1505
1625
|
* @public
|
|
1506
1626
|
* @documentationMaturity preview
|
|
1507
1627
|
* @requiredField externalId
|
|
1508
1628
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1509
1629
|
* @applicableIdentity APP
|
|
1630
|
+
* @returns Response containing complete seating plan and occupancy data.
|
|
1510
1631
|
* @fqn com.wixpress.seating.SeatingReservationService.GetSeatingReservationSummary
|
|
1511
1632
|
*/
|
|
1512
1633
|
declare function getSeatingReservationSummary(externalId: string): Promise<NonNullablePaths<GetSeatingReservationSummaryResponse, `plan.sections` | `plan.sections.${number}._id` | `plan.sections.${number}.default` | `plan.categories` | `plan.categories.${number}._id` | `plan.categories.${number}.title` | `plan.uncategorizedPlaces` | `plan.elementGroups` | `plan.elementGroups.${number}._id` | `places` | `places.${number}.placeId` | `places.${number}.occupied`, 5>>;
|
|
1513
1634
|
|
|
1514
|
-
export { type ActionEvent, type App, type BaseEventMetadata, type CancelSeatingPlaceReservationsRequest, type CancelSeatingPlaceReservationsResponse, type Category, type CategoryDetails, type CreateSeatingReservationApplicationErrors, type CreateSeatingReservationOptions, type CreateSeatingReservationRequest, type CreateSeatingReservationResponse, type CursorPaging, type Cursors, type CustomTag, type DeleteSeatingPlaceReservationRequest, type DeleteSeatingReservationRequest, type DeleteSeatingReservationResponse, type DomainEvent, type DomainEventBodyOneOf, type Element, type ElementGroup, type ElementGroupUiProperties, type ElementUiProperties, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetReservationRequest, type GetReservationResponse, type GetReservedPlacesRequest, type GetReservedPlacesResponse, type GetSeatingCategorySummaryOptions, type GetSeatingCategorySummaryRequest, type GetSeatingCategorySummaryResponse, type GetSeatingReservationSummaryRequest, type GetSeatingReservationSummaryResponse, Icon, type IconWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type Image, type InvalidateCache, type InvalidateCacheGetByOneOf, type ListReservedPlacesRequest, type ListReservedPlacesResponse, type MessageEnvelope, type MultiRowProperties, Numbering, type NumberingWithLiterals, type Page, type Paging, type PagingMetadata, type PagingMetadataV2, type Place, type PlaceReservation, type PlaceReservationDetails, PlaceTypeEnumType, type PlaceTypeEnumTypeWithLiterals, type Places, Position, type PositionWithLiterals, type QuerySeatingReservationRequest, type QuerySeatingReservationResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RegenerateSummariesRequest, type RegenerateSummariesResponse, type ReservationErrorDetails, type ReservationOptions, type ReservationsQueryBuilder, type ReservationsQueryResult, type ReservedPlace, type RestoreInfo, type RowElement, type RowElementUiProperties, type SeatReservation, type SeatingPlan, type SeatingPlanCategoriesSummaryUpdated, type SeatingPlanUiProperties, type SeatingReservation, type SeatingReservationCreatedEnvelope, type SeatingReservationDeletedEnvelope, type SeatingReservationsSummary, type Section, type Sequencing, ShapeTypeEnumType, type ShapeTypeEnumTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type URI, type UnavailablePlaces, type UpdateSeatingReservationRequest, type UpdateSeatingReservationResponse, type VerticalSequencing, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createSeatingReservation, deleteSeatingReservation, getReservation, getSeatingCategorySummary, getSeatingReservationSummary, onSeatingReservationCreated, onSeatingReservationDeleted, querySeatingReservation };
|
|
1635
|
+
export { type ActionEvent, type App, type AvailablePlace, type BaseEventMetadata, type CancelSeatingPlaceReservationsRequest, type CancelSeatingPlaceReservationsResponse, type Category, type CategoryDetails, type CreateSeatingReservationApplicationErrors, type CreateSeatingReservationOptions, type CreateSeatingReservationRequest, type CreateSeatingReservationResponse, type CursorPaging, type Cursors, type CustomTag, type DeleteSeatingPlaceReservationRequest, type DeleteSeatingReservationRequest, type DeleteSeatingReservationResponse, type DomainEvent, type DomainEventBodyOneOf, type Element, type ElementGroup, type ElementGroupUiProperties, type ElementUiProperties, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetReservationRequest, type GetReservationResponse, type GetReservedPlacesRequest, type GetReservedPlacesResponse, type GetSeatingCategorySummaryOptions, type GetSeatingCategorySummaryRequest, type GetSeatingCategorySummaryResponse, type GetSeatingReservationSummaryRequest, type GetSeatingReservationSummaryResponse, Icon, type IconWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type Image, type InvalidateCache, type InvalidateCacheGetByOneOf, type ListAvailablePlacesRequest, type ListAvailablePlacesResponse, type ListReservedPlacesRequest, type ListReservedPlacesResponse, type MessageEnvelope, type MultiRowProperties, Numbering, type NumberingWithLiterals, type Page, type Paging, type PagingMetadata, type PagingMetadataV2, type Place, type PlaceReservation, type PlaceReservationDetails, PlaceTypeEnumType, type PlaceTypeEnumTypeWithLiterals, type Places, Position, type PositionWithLiterals, type QuerySeatingReservationRequest, type QuerySeatingReservationResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RegenerateSummariesRequest, type RegenerateSummariesResponse, type ReservationErrorDetails, type ReservationOptions, type ReservationsQueryBuilder, type ReservationsQueryResult, type ReservedPlace, type RestoreInfo, type RowElement, type RowElementUiProperties, type SeatReservation, type SeatingPlan, type SeatingPlanCategoriesSummaryUpdated, type SeatingPlanUiProperties, type SeatingReservation, type SeatingReservationCreatedEnvelope, type SeatingReservationDeletedEnvelope, type SeatingReservationsSummary, type Section, type Sequencing, ShapeTypeEnumType, type ShapeTypeEnumTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type URI, type UnavailablePlaces, type UpdateSeatingReservationRequest, type UpdateSeatingReservationResponse, type VerticalSequencing, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createSeatingReservation, deleteSeatingReservation, getReservation, getSeatingCategorySummary, getSeatingReservationSummary, onSeatingReservationCreated, onSeatingReservationDeleted, querySeatingReservation };
|