@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,133 +1,140 @@
|
|
|
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
|
-
*
|
|
11
|
+
* Reservation ID.
|
|
7
12
|
* @format GUID
|
|
8
13
|
* @readonly
|
|
9
14
|
*/
|
|
10
15
|
id?: string | null;
|
|
11
16
|
/**
|
|
12
|
-
*
|
|
17
|
+
* Seating plan ID.
|
|
13
18
|
* @format GUID
|
|
14
19
|
* @readonly
|
|
15
20
|
*/
|
|
16
21
|
seatingPlanId?: string | null;
|
|
17
22
|
/**
|
|
18
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
53
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
74
|
+
* Table identifier for table-based seating arrangements.
|
|
70
75
|
* @readonly
|
|
71
76
|
*/
|
|
72
77
|
tableLabel?: string | null;
|
|
73
78
|
/**
|
|
74
|
-
* Row
|
|
79
|
+
* Row identifier within a section or area.
|
|
75
80
|
* @readonly
|
|
76
81
|
*/
|
|
77
82
|
rowLabel?: string | null;
|
|
78
83
|
/**
|
|
79
|
-
*
|
|
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. */
|
|
84
90
|
interface SeatingPlanCategoriesSummaryUpdated {
|
|
85
91
|
/**
|
|
86
|
-
* Seating plan
|
|
92
|
+
* Seating plan ID.
|
|
87
93
|
* @format GUID
|
|
88
94
|
*/
|
|
89
95
|
seatingPlanId?: string;
|
|
90
|
-
/** External seating plan
|
|
96
|
+
/** External seating plan ID. */
|
|
91
97
|
externalSeatingPlanId?: string | null;
|
|
92
98
|
/**
|
|
93
|
-
*
|
|
99
|
+
* Updated category capacity and reservation counts.
|
|
94
100
|
* @maxSize 100
|
|
95
101
|
*/
|
|
96
102
|
categories?: CategoryDetails[];
|
|
97
103
|
/**
|
|
98
|
-
* Summary revision.
|
|
104
|
+
* Summary revision number for cache invalidation.
|
|
99
105
|
* @readonly
|
|
100
106
|
*/
|
|
101
107
|
revision?: string | null;
|
|
102
108
|
}
|
|
109
|
+
/** Category capacity and reservation summary. */
|
|
103
110
|
interface CategoryDetails {
|
|
104
111
|
/**
|
|
105
|
-
* Seating
|
|
112
|
+
* Seating Plan ID.
|
|
106
113
|
* @format GUID
|
|
107
114
|
* @readonly
|
|
108
115
|
*/
|
|
109
116
|
seatingPlanId?: string | null;
|
|
110
117
|
/**
|
|
111
|
-
* External
|
|
118
|
+
* External Seating Plan ID used for integration with third-party systems.
|
|
112
119
|
* @minLength 1
|
|
113
120
|
* @maxLength 100
|
|
114
121
|
* @readonly
|
|
115
122
|
*/
|
|
116
123
|
externalSeatingPlanId?: string | null;
|
|
117
124
|
/**
|
|
118
|
-
* External category
|
|
125
|
+
* External Category ID used for mapping to venue-specific category names. For example, `VIP` or `ORCHESTRA`.
|
|
119
126
|
* @minLength 1
|
|
120
127
|
* @maxLength 100
|
|
121
128
|
* @readonly
|
|
122
129
|
*/
|
|
123
130
|
externalCategoryId?: string | null;
|
|
124
131
|
/**
|
|
125
|
-
* Total capacity in
|
|
132
|
+
* Total seating capacity available in category.
|
|
126
133
|
* @readonly
|
|
127
134
|
*/
|
|
128
135
|
totalCapacity?: number | null;
|
|
129
136
|
/**
|
|
130
|
-
*
|
|
137
|
+
* Number of seats currently reserved in category.
|
|
131
138
|
* @readonly
|
|
132
139
|
*/
|
|
133
140
|
reserved?: number | null;
|
|
@@ -247,57 +254,65 @@ interface CustomTag {
|
|
|
247
254
|
*/
|
|
248
255
|
tag?: string;
|
|
249
256
|
}
|
|
257
|
+
/** Request to create a seating reservation. */
|
|
250
258
|
interface CreateSeatingReservationRequest {
|
|
251
|
-
/**
|
|
259
|
+
/** Reservation to create. */
|
|
252
260
|
reservation?: SeatingReservation;
|
|
253
261
|
}
|
|
262
|
+
/** Response after creating a seating reservation. */
|
|
254
263
|
interface CreateSeatingReservationResponse {
|
|
255
|
-
/** Created reservation */
|
|
264
|
+
/** Created reservation. */
|
|
256
265
|
reservation?: SeatingReservation;
|
|
257
266
|
}
|
|
267
|
+
/** Details about specific places, used for error reporting. */
|
|
258
268
|
interface Places {
|
|
259
269
|
/**
|
|
260
|
-
*
|
|
270
|
+
* List of place identifiers. For example, `A1-1-5` or `VIP-12`.
|
|
261
271
|
* @minSize 1
|
|
262
272
|
* @maxSize 100
|
|
263
273
|
*/
|
|
264
274
|
places?: string[];
|
|
265
275
|
}
|
|
276
|
+
/** Details about places that are unavailable, including capacity conflicts. */
|
|
266
277
|
interface UnavailablePlaces {
|
|
267
278
|
/**
|
|
268
|
-
*
|
|
279
|
+
* List of place identifiers that are unavailable. For example, `A1-1-5` or `VIP-12`.
|
|
269
280
|
* @minSize 1
|
|
270
281
|
* @maxSize 100
|
|
271
282
|
*/
|
|
272
283
|
unavailablePlaces?: string[];
|
|
273
284
|
/**
|
|
274
|
-
*
|
|
285
|
+
* Detailed capacity information for each unavailable place.
|
|
275
286
|
* @minSize 1
|
|
276
287
|
* @maxSize 100
|
|
277
288
|
*/
|
|
278
289
|
reservationErrorDetails?: ReservationErrorDetails[];
|
|
279
290
|
}
|
|
291
|
+
/** Capacity conflict details for a given place. */
|
|
280
292
|
interface ReservationErrorDetails {
|
|
281
|
-
/**
|
|
293
|
+
/** ID of the place with a capacity conflict. */
|
|
282
294
|
id?: string;
|
|
283
|
-
/**
|
|
295
|
+
/** Currently available capacity at this place. */
|
|
284
296
|
available?: number;
|
|
285
|
-
/** Requested capacity */
|
|
297
|
+
/** Requested capacity that exceeds the available capacity. */
|
|
286
298
|
requested?: number;
|
|
287
299
|
}
|
|
300
|
+
/** Request to retrieve a specific seating reservation. */
|
|
288
301
|
interface GetReservationRequest {
|
|
289
302
|
/**
|
|
290
|
-
*
|
|
303
|
+
* Reservation ID.
|
|
291
304
|
* @format GUID
|
|
292
305
|
*/
|
|
293
306
|
id: string | null;
|
|
294
307
|
}
|
|
308
|
+
/** Response containing the requested seating reservation. */
|
|
295
309
|
interface GetReservationResponse {
|
|
296
|
-
/**
|
|
310
|
+
/** Retrieved reservation. */
|
|
297
311
|
reservation?: SeatingReservation;
|
|
298
312
|
}
|
|
313
|
+
/** Request to query seating reservations. */
|
|
299
314
|
interface QuerySeatingReservationRequest {
|
|
300
|
-
/**
|
|
315
|
+
/** Query object with filter criteria and pagination settings. */
|
|
301
316
|
query: QueryV2;
|
|
302
317
|
}
|
|
303
318
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -365,10 +380,11 @@ interface CursorPaging {
|
|
|
365
380
|
*/
|
|
366
381
|
cursor?: string | null;
|
|
367
382
|
}
|
|
383
|
+
/** Response containing matching seating reservations. */
|
|
368
384
|
interface QuerySeatingReservationResponse {
|
|
369
|
-
/** Found reservations */
|
|
385
|
+
/** Found reservations matching the query criteria. */
|
|
370
386
|
reservations?: SeatingReservation[];
|
|
371
|
-
/** Paging
|
|
387
|
+
/** Paging metadata for result navigation. */
|
|
372
388
|
metadata?: PagingMetadataV2;
|
|
373
389
|
}
|
|
374
390
|
interface PagingMetadataV2 {
|
|
@@ -395,129 +411,145 @@ interface Cursors {
|
|
|
395
411
|
*/
|
|
396
412
|
prev?: string | null;
|
|
397
413
|
}
|
|
414
|
+
/** Request to delete a seating reservation. */
|
|
398
415
|
interface DeleteSeatingReservationRequest {
|
|
399
416
|
/**
|
|
400
|
-
*
|
|
417
|
+
* Reservation ID.
|
|
401
418
|
* @format GUID
|
|
402
419
|
*/
|
|
403
420
|
id: string | null;
|
|
404
421
|
}
|
|
422
|
+
/** Response after deleting a seating reservation. */
|
|
405
423
|
interface DeleteSeatingReservationResponse {
|
|
406
|
-
/**
|
|
424
|
+
/** Deleted reservation. */
|
|
407
425
|
reservation?: SeatingReservation;
|
|
408
426
|
}
|
|
427
|
+
/** Request to delete a specific place reservation. */
|
|
409
428
|
interface DeleteSeatingPlaceReservationRequest {
|
|
410
|
-
/**
|
|
429
|
+
/** Place reservation ID. */
|
|
411
430
|
id?: string | null;
|
|
412
431
|
/**
|
|
413
|
-
*
|
|
432
|
+
* Seating reservation ID that contains the place reservation.
|
|
414
433
|
* @format GUID
|
|
415
434
|
*/
|
|
416
435
|
reservationId?: string | null;
|
|
417
436
|
}
|
|
418
437
|
interface Empty {
|
|
419
438
|
}
|
|
439
|
+
/** Request to cancel specific place reservations. */
|
|
420
440
|
interface CancelSeatingPlaceReservationsRequest {
|
|
421
441
|
/**
|
|
422
|
-
*
|
|
442
|
+
* Seating reservation ID containing the places to cancel.
|
|
423
443
|
* @format GUID
|
|
424
444
|
*/
|
|
425
445
|
reservationId?: string | null;
|
|
426
446
|
/**
|
|
427
|
-
*
|
|
447
|
+
* Place reservations to cancel with their reduced capacity.
|
|
428
448
|
* @minSize 1
|
|
429
449
|
* @maxSize 100
|
|
430
450
|
*/
|
|
431
451
|
placeReservations?: PlaceReservationDetails[];
|
|
432
452
|
}
|
|
453
|
+
/** Occupancy details for a specific place in a seating plan. */
|
|
433
454
|
interface PlaceReservationDetails {
|
|
455
|
+
/** Place ID. */
|
|
434
456
|
placeId?: string;
|
|
457
|
+
/** Number of occupied seats or capacity units at this place. */
|
|
435
458
|
occupied?: number;
|
|
436
459
|
}
|
|
460
|
+
/** Response after canceling place reservations. */
|
|
437
461
|
interface CancelSeatingPlaceReservationsResponse {
|
|
438
|
-
/**
|
|
462
|
+
/** Reservation with canceled place reservations. */
|
|
439
463
|
reservation?: SeatingReservation;
|
|
440
464
|
}
|
|
465
|
+
/** Request to update a seating reservation. */
|
|
441
466
|
interface UpdateSeatingReservationRequest {
|
|
442
|
-
/**
|
|
467
|
+
/** Reservation to update with modified capacity values. */
|
|
443
468
|
reservation?: SeatingReservation;
|
|
444
469
|
}
|
|
470
|
+
/** Response after updating a seating reservation. */
|
|
445
471
|
interface UpdateSeatingReservationResponse {
|
|
446
|
-
/**
|
|
472
|
+
/** Updated reservation. */
|
|
447
473
|
reservation?: SeatingReservation;
|
|
448
474
|
}
|
|
475
|
+
/** Request to retrieve all reserved places for a seating plan. */
|
|
449
476
|
interface GetReservedPlacesRequest {
|
|
450
477
|
/**
|
|
451
|
-
* Seating plan
|
|
478
|
+
* Seating plan ID.
|
|
452
479
|
* @format GUID
|
|
453
480
|
*/
|
|
454
481
|
id?: string | null;
|
|
455
482
|
}
|
|
483
|
+
/** Response containing all reserved places for a seating plan. */
|
|
456
484
|
interface GetReservedPlacesResponse {
|
|
457
|
-
/** Reserved places
|
|
485
|
+
/** Reserved places in the seating plan. */
|
|
458
486
|
placeReservations?: PlaceReservation[];
|
|
459
487
|
}
|
|
488
|
+
/** Request to list reserved places with optional filtering. */
|
|
460
489
|
interface ListReservedPlacesRequest {
|
|
461
490
|
/**
|
|
462
|
-
* Seating plan
|
|
491
|
+
* Seating plan ID.
|
|
463
492
|
* @format GUID
|
|
464
493
|
*/
|
|
465
494
|
planId?: string | null;
|
|
466
495
|
/**
|
|
467
|
-
* Optional filter by reservation
|
|
496
|
+
* Optional filter by reservation ID.
|
|
468
497
|
* @format GUID
|
|
469
498
|
*/
|
|
470
499
|
reservationId?: string | null;
|
|
471
500
|
/**
|
|
472
|
-
* Optional filter by seat
|
|
501
|
+
* Optional filter by specific seat IDs.
|
|
473
502
|
* @maxSize 50
|
|
474
503
|
* @maxLength 20
|
|
475
504
|
*/
|
|
476
505
|
seatId?: string[];
|
|
477
|
-
/** Paging */
|
|
506
|
+
/** Paging configuration. */
|
|
478
507
|
paging?: Paging;
|
|
479
508
|
}
|
|
509
|
+
/** Response containing filtered reserved places. */
|
|
480
510
|
interface ListReservedPlacesResponse {
|
|
481
|
-
/**
|
|
511
|
+
/** Reserved places matching the filter criteria. */
|
|
482
512
|
reservedPlaces?: ReservedPlace[];
|
|
483
|
-
/** Paging */
|
|
513
|
+
/** Paging metadata for result navigation. */
|
|
484
514
|
pagingMetadata?: PagingMetadata;
|
|
485
515
|
}
|
|
516
|
+
/** Internal representation of a place reservation. */
|
|
486
517
|
interface SeatReservation {
|
|
487
518
|
/**
|
|
488
|
-
* Place reservation
|
|
519
|
+
* Place reservation ID.
|
|
489
520
|
* @maxLength 72
|
|
490
521
|
*/
|
|
491
522
|
seatReservationId?: string | null;
|
|
492
523
|
/**
|
|
493
|
-
*
|
|
524
|
+
* Place ID.
|
|
494
525
|
* @maxLength 20
|
|
495
526
|
*/
|
|
496
527
|
seatId?: string | null;
|
|
497
528
|
/**
|
|
498
|
-
* Seating plan
|
|
529
|
+
* Seating plan ID.
|
|
499
530
|
* @format GUID
|
|
500
531
|
*/
|
|
501
532
|
planId?: string | null;
|
|
502
533
|
/**
|
|
503
|
-
* Seating reservation
|
|
534
|
+
* Seating reservation ID.
|
|
504
535
|
* @format GUID
|
|
505
536
|
*/
|
|
506
537
|
reservationId?: string | null;
|
|
507
538
|
/**
|
|
508
|
-
*
|
|
539
|
+
* Number of occupied spots at this place.
|
|
509
540
|
* @max 50000
|
|
510
541
|
*/
|
|
511
542
|
spots?: number | null;
|
|
512
|
-
/**
|
|
543
|
+
/** Whether this is an area-based reservation (true) or individual seat (false). */
|
|
513
544
|
area?: boolean | null;
|
|
514
545
|
}
|
|
546
|
+
/** Individual reserved place with full context. */
|
|
515
547
|
interface ReservedPlace {
|
|
516
|
-
/** Place reservation */
|
|
548
|
+
/** Place reservation details. */
|
|
517
549
|
seatReservation?: SeatReservation;
|
|
518
|
-
/**
|
|
550
|
+
/** Parent reservation (active). */
|
|
519
551
|
reservation?: SeatingReservation;
|
|
520
|
-
/**
|
|
552
|
+
/** Parent reservation (deleted, for audit trail). */
|
|
521
553
|
reservationFromTrashBin?: SeatingReservation;
|
|
522
554
|
}
|
|
523
555
|
interface PagingMetadata {
|
|
@@ -530,32 +562,40 @@ interface PagingMetadata {
|
|
|
530
562
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
531
563
|
tooManyToCount?: boolean | null;
|
|
532
564
|
}
|
|
565
|
+
/** Request to retrieve category-level capacity summary. */
|
|
533
566
|
interface GetSeatingCategorySummaryRequest {
|
|
534
567
|
/**
|
|
535
|
-
*
|
|
568
|
+
* External seating plan ID.
|
|
536
569
|
* @minLength 1
|
|
537
570
|
* @maxLength 100
|
|
538
571
|
*/
|
|
539
572
|
externalId?: string;
|
|
540
573
|
}
|
|
574
|
+
/** Response containing capacity summary by category. */
|
|
541
575
|
interface GetSeatingCategorySummaryResponse {
|
|
542
576
|
/**
|
|
543
|
-
*
|
|
577
|
+
* Capacity and reservation counts by category.
|
|
544
578
|
* @maxSize 50000
|
|
545
579
|
*/
|
|
546
580
|
categories?: CategoryDetails[];
|
|
547
581
|
}
|
|
582
|
+
/** Request to retrieve detailed place-level occupancy data. */
|
|
548
583
|
interface GetSeatingReservationSummaryRequest {
|
|
549
584
|
/**
|
|
550
|
-
*
|
|
585
|
+
* External seating plan ID.
|
|
551
586
|
* @minLength 1
|
|
552
587
|
* @maxLength 100
|
|
553
588
|
*/
|
|
554
589
|
externalId: string;
|
|
555
590
|
}
|
|
591
|
+
/** Response containing complete seating plan and occupancy data. */
|
|
556
592
|
interface GetSeatingReservationSummaryResponse {
|
|
593
|
+
/** Complete seating plan structure. */
|
|
557
594
|
plan?: SeatingPlan;
|
|
558
|
-
/**
|
|
595
|
+
/**
|
|
596
|
+
* Occupancy details for each place in the plan.
|
|
597
|
+
* @maxSize 50000
|
|
598
|
+
*/
|
|
559
599
|
places?: PlaceReservationDetails[];
|
|
560
600
|
}
|
|
561
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. */
|
|
@@ -1184,20 +1224,30 @@ interface ElementGroupUiProperties {
|
|
|
1184
1224
|
*/
|
|
1185
1225
|
rotationAngle?: number | null;
|
|
1186
1226
|
}
|
|
1227
|
+
/** Request to regenerate cached summaries. */
|
|
1187
1228
|
interface RegenerateSummariesRequest {
|
|
1188
1229
|
/**
|
|
1189
|
-
* Seating plan
|
|
1230
|
+
* Seating plan ID.
|
|
1190
1231
|
* @format GUID
|
|
1191
1232
|
*/
|
|
1192
1233
|
planId?: string | null;
|
|
1193
1234
|
}
|
|
1235
|
+
/** Response after regenerating summaries. */
|
|
1194
1236
|
interface RegenerateSummariesResponse {
|
|
1237
|
+
/** Regenerated place-level occupancy summary. */
|
|
1195
1238
|
seatingReservationsSummary?: SeatingReservationsSummary;
|
|
1196
|
-
/**
|
|
1239
|
+
/**
|
|
1240
|
+
* Regenerated category-level summaries.
|
|
1241
|
+
* @maxSize 50000
|
|
1242
|
+
*/
|
|
1197
1243
|
categories?: CategoryDetails[];
|
|
1198
1244
|
}
|
|
1245
|
+
/** Aggregated occupancy data for all places in a seating plan. */
|
|
1199
1246
|
interface SeatingReservationsSummary {
|
|
1200
|
-
/**
|
|
1247
|
+
/**
|
|
1248
|
+
* Occupancy details for each place.
|
|
1249
|
+
* @maxSize 50000
|
|
1250
|
+
*/
|
|
1201
1251
|
places?: PlaceReservationDetails[];
|
|
1202
1252
|
}
|
|
1203
1253
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -1264,6 +1314,70 @@ interface EntityDeletedEvent {
|
|
|
1264
1314
|
interface ActionEvent {
|
|
1265
1315
|
bodyAsJson?: string;
|
|
1266
1316
|
}
|
|
1317
|
+
/** Request to list all available places in a seating plan. */
|
|
1318
|
+
interface ListAvailablePlacesRequest {
|
|
1319
|
+
/**
|
|
1320
|
+
* External seating plan ID. For example, `wix.events.v1.event:abc-123-def`.
|
|
1321
|
+
* @minLength 1
|
|
1322
|
+
* @maxLength 100
|
|
1323
|
+
*/
|
|
1324
|
+
externalId?: string;
|
|
1325
|
+
}
|
|
1326
|
+
/** Response containing all available places with their details. */
|
|
1327
|
+
interface ListAvailablePlacesResponse {
|
|
1328
|
+
/**
|
|
1329
|
+
* Available places across all categories in the seating plan.
|
|
1330
|
+
* @maxSize 50000
|
|
1331
|
+
*/
|
|
1332
|
+
places?: AvailablePlace[];
|
|
1333
|
+
}
|
|
1334
|
+
/** An individual available place with all relevant details. */
|
|
1335
|
+
interface AvailablePlace {
|
|
1336
|
+
/**
|
|
1337
|
+
* Place ID in the format `{section_id}-{element_id}-{label}`. For example, `0-1-A5`.
|
|
1338
|
+
* @minLength 1
|
|
1339
|
+
* @maxLength 20
|
|
1340
|
+
*/
|
|
1341
|
+
placeId?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Human-readable label for this place, such as `A1`, `12`, or `VIP1`.
|
|
1344
|
+
* @minLength 1
|
|
1345
|
+
* @maxLength 4
|
|
1346
|
+
*/
|
|
1347
|
+
label?: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Section name where this place is located. For example, `Orchestra` or `Balcony`.
|
|
1350
|
+
* @minLength 1
|
|
1351
|
+
* @maxLength 20
|
|
1352
|
+
*/
|
|
1353
|
+
sectionLabel?: string | null;
|
|
1354
|
+
/**
|
|
1355
|
+
* Element label from the seating plan. For example, `Row A`, `Table 5`, or `General Admission`.
|
|
1356
|
+
* @minLength 1
|
|
1357
|
+
* @maxLength 50
|
|
1358
|
+
*/
|
|
1359
|
+
elementLabel?: string | null;
|
|
1360
|
+
/** Numeric category ID this place is assigned to for pricing and organization. */
|
|
1361
|
+
categoryId?: number;
|
|
1362
|
+
/**
|
|
1363
|
+
* External category ID for cross-referencing with ticketing systems. Format: `{entity_fqdn}:{entity_id}`. For example, `wix.events.v1.ticket_definition:xyz-456`.
|
|
1364
|
+
* @minLength 1
|
|
1365
|
+
* @maxLength 100
|
|
1366
|
+
*/
|
|
1367
|
+
externalCategoryId?: string | null;
|
|
1368
|
+
/** Type of seating element (AREA, ROW, MULTI_ROW, TABLE, ROUND_TABLE, SHAPE). */
|
|
1369
|
+
elementType?: TypeWithLiterals;
|
|
1370
|
+
/**
|
|
1371
|
+
* Available capacity at this place. For AREA type: remaining spots; for other types: 0 or 1.
|
|
1372
|
+
* @max 50000
|
|
1373
|
+
*/
|
|
1374
|
+
availableCapacity?: number;
|
|
1375
|
+
/**
|
|
1376
|
+
* Total capacity of this place.
|
|
1377
|
+
* @max 50000
|
|
1378
|
+
*/
|
|
1379
|
+
totalCapacity?: number;
|
|
1380
|
+
}
|
|
1267
1381
|
interface MessageEnvelope {
|
|
1268
1382
|
/**
|
|
1269
1383
|
* App instance ID.
|
|
@@ -1370,4 +1484,4 @@ declare function getSeatingReservationSummary(): __PublicMethodMetaInfo<'GET', {
|
|
|
1370
1484
|
externalId: string;
|
|
1371
1485
|
}, GetSeatingReservationSummaryRequest$1, GetSeatingReservationSummaryRequest, GetSeatingReservationSummaryResponse$1, GetSeatingReservationSummaryResponse>;
|
|
1372
1486
|
|
|
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 };
|
|
1487
|
+
export { type ActionEvent as ActionEventOriginal, type App as AppOriginal, type AvailablePlace as AvailablePlaceOriginal, 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 ListAvailablePlacesRequest as ListAvailablePlacesRequestOriginal, type ListAvailablePlacesResponse as ListAvailablePlacesResponseOriginal, 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 };
|