order3000 1.6.0 → 1.8.0
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/dist/client.cjs +16 -0
- package/dist/client.d.cts +206 -135
- package/dist/client.d.mts +206 -135
- package/dist/client.mjs +16 -0
- package/dist/schemas.cjs +297 -177
- package/dist/schemas.d.cts +245 -27
- package/dist/schemas.d.mts +245 -27
- package/dist/schemas.mjs +297 -177
- package/package.json +1 -1
package/dist/client.cjs
CHANGED
|
@@ -623,6 +623,22 @@ class EventsResource extends BaseResource {
|
|
|
623
623
|
});
|
|
624
624
|
return event.assets ?? [];
|
|
625
625
|
}
|
|
626
|
+
/**
|
|
627
|
+
* Per-start-slot occupancy availability for an event on a date. Each slot's
|
|
628
|
+
* `offered` honours the venue's reservation mode (`passive`: every slot;
|
|
629
|
+
* `auto_steer`: only acceptable slots), so a public widget can pre-exclude
|
|
630
|
+
* fully-booked start times.
|
|
631
|
+
*/
|
|
632
|
+
async getSlotAvailability(idOrAccessor, options) {
|
|
633
|
+
const params = new URLSearchParams();
|
|
634
|
+
params.set("reservationDate", options.reservationDate);
|
|
635
|
+
params.set("partySize", String(options.partySize));
|
|
636
|
+
if (options.areaId) params.set("areaId", options.areaId);
|
|
637
|
+
return this.request(
|
|
638
|
+
"GET",
|
|
639
|
+
`/${encodeURIComponent(idOrAccessor)}/slot-availability?${params.toString()}`
|
|
640
|
+
);
|
|
641
|
+
}
|
|
626
642
|
/**
|
|
627
643
|
* Upload a asset image for an event. The SDK builds the multipart
|
|
628
644
|
* body internally — pass a Buffer/Uint8Array, the original filename,
|
package/dist/client.d.cts
CHANGED
|
@@ -80,7 +80,7 @@ interface components {
|
|
|
80
80
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
81
81
|
[key: string]: unknown;
|
|
82
82
|
} | unknown[]) | null;
|
|
83
|
-
|
|
83
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
84
84
|
[key: string]: unknown;
|
|
85
85
|
} | unknown[]) | null;
|
|
86
86
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -123,7 +123,7 @@ interface components {
|
|
|
123
123
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
124
124
|
[key: string]: unknown;
|
|
125
125
|
} | unknown[]) | null;
|
|
126
|
-
|
|
126
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
127
127
|
[key: string]: unknown;
|
|
128
128
|
} | unknown[]) | null;
|
|
129
129
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -179,7 +179,7 @@ interface components {
|
|
|
179
179
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
180
180
|
[key: string]: unknown;
|
|
181
181
|
} | unknown[]) | null;
|
|
182
|
-
|
|
182
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
183
183
|
[key: string]: unknown;
|
|
184
184
|
} | unknown[]) | null;
|
|
185
185
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -250,7 +250,7 @@ interface components {
|
|
|
250
250
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
251
251
|
[key: string]: unknown;
|
|
252
252
|
} | unknown[]) | null;
|
|
253
|
-
|
|
253
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
254
254
|
[key: string]: unknown;
|
|
255
255
|
} | unknown[]) | null;
|
|
256
256
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -324,7 +324,7 @@ interface components {
|
|
|
324
324
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
325
325
|
[key: string]: unknown;
|
|
326
326
|
} | unknown[]) | null;
|
|
327
|
-
|
|
327
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
328
328
|
[key: string]: unknown;
|
|
329
329
|
} | unknown[]) | null;
|
|
330
330
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -382,7 +382,7 @@ interface components {
|
|
|
382
382
|
metaRefs: ((string | number | boolean | (null)) | {
|
|
383
383
|
[key: string]: unknown;
|
|
384
384
|
} | unknown[]) | null;
|
|
385
|
-
|
|
385
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
386
386
|
[key: string]: unknown;
|
|
387
387
|
} | unknown[]) | null;
|
|
388
388
|
keywords: (string | number | boolean | (null)) | {
|
|
@@ -442,6 +442,11 @@ interface components {
|
|
|
442
442
|
isBookable?: boolean;
|
|
443
443
|
isPublic?: boolean;
|
|
444
444
|
isActive?: boolean;
|
|
445
|
+
areaType?: components["schemas"]["AreaType"];
|
|
446
|
+
turnTimes?: {
|
|
447
|
+
[key: string]: number;
|
|
448
|
+
} | null;
|
|
449
|
+
cleanup?: number | null;
|
|
445
450
|
assets?: {
|
|
446
451
|
id: string;
|
|
447
452
|
type: components["schemas"]["AssetType"];
|
|
@@ -462,6 +467,14 @@ interface components {
|
|
|
462
467
|
/** Format: uri */
|
|
463
468
|
publicUrl: string;
|
|
464
469
|
}[];
|
|
470
|
+
closures?: {
|
|
471
|
+
id: string;
|
|
472
|
+
date: string;
|
|
473
|
+
reason: {
|
|
474
|
+
[key: string]: string;
|
|
475
|
+
} | null;
|
|
476
|
+
isActive: boolean;
|
|
477
|
+
}[];
|
|
465
478
|
};
|
|
466
479
|
/** FetchAreasResponse */
|
|
467
480
|
FetchAreasResponse: components["schemas"]["Area"][];
|
|
@@ -500,6 +513,11 @@ interface components {
|
|
|
500
513
|
isBookable?: boolean;
|
|
501
514
|
isPublic?: boolean;
|
|
502
515
|
isActive?: boolean;
|
|
516
|
+
areaType?: components["schemas"]["AreaType"];
|
|
517
|
+
turnTimes?: {
|
|
518
|
+
[key: string]: number;
|
|
519
|
+
} | null;
|
|
520
|
+
cleanup?: number | null;
|
|
503
521
|
assets?: {
|
|
504
522
|
id: string;
|
|
505
523
|
type: components["schemas"]["AssetType"];
|
|
@@ -520,6 +538,14 @@ interface components {
|
|
|
520
538
|
/** Format: uri */
|
|
521
539
|
publicUrl: string;
|
|
522
540
|
}[];
|
|
541
|
+
closures?: {
|
|
542
|
+
id: string;
|
|
543
|
+
date: string;
|
|
544
|
+
reason: {
|
|
545
|
+
[key: string]: string;
|
|
546
|
+
} | null;
|
|
547
|
+
isActive: boolean;
|
|
548
|
+
}[];
|
|
523
549
|
};
|
|
524
550
|
/** GetAreaAvailabilityResponse */
|
|
525
551
|
GetAreaAvailabilityResponse: {
|
|
@@ -991,7 +1017,7 @@ interface components {
|
|
|
991
1017
|
bookingClosesAtOffset: number | null;
|
|
992
1018
|
isActive: boolean;
|
|
993
1019
|
isFeatured: boolean;
|
|
994
|
-
|
|
1020
|
+
takesOverDay: boolean;
|
|
995
1021
|
createdBy: string | null;
|
|
996
1022
|
updatedBy: string | null;
|
|
997
1023
|
createdAt: unknown;
|
|
@@ -1010,7 +1036,6 @@ interface components {
|
|
|
1010
1036
|
exdates: string[] | null;
|
|
1011
1037
|
validFrom: string | null;
|
|
1012
1038
|
validTo: string | null;
|
|
1013
|
-
priority: number | null;
|
|
1014
1039
|
slotMode: components["schemas"]["SlotMode"];
|
|
1015
1040
|
intervalDuration: number | null;
|
|
1016
1041
|
isActive: boolean;
|
|
@@ -1022,7 +1047,6 @@ interface components {
|
|
|
1022
1047
|
scheduleOverrides: {
|
|
1023
1048
|
id: string;
|
|
1024
1049
|
date: string;
|
|
1025
|
-
priority: number | null;
|
|
1026
1050
|
isActive: boolean;
|
|
1027
1051
|
updatedAt: unknown;
|
|
1028
1052
|
updatedBy: string | null;
|
|
@@ -1180,7 +1204,7 @@ interface components {
|
|
|
1180
1204
|
bookingClosesAtOffset: number | null;
|
|
1181
1205
|
isActive: boolean;
|
|
1182
1206
|
isFeatured: boolean;
|
|
1183
|
-
|
|
1207
|
+
takesOverDay: boolean;
|
|
1184
1208
|
createdAt: unknown;
|
|
1185
1209
|
updatedAt: unknown;
|
|
1186
1210
|
nextOccurrence?: string | null;
|
|
@@ -1197,7 +1221,6 @@ interface components {
|
|
|
1197
1221
|
exdates: string[] | null;
|
|
1198
1222
|
validFrom: string | null;
|
|
1199
1223
|
validTo: string | null;
|
|
1200
|
-
priority: number | null;
|
|
1201
1224
|
isActive: boolean;
|
|
1202
1225
|
slotMode: components["schemas"]["SlotMode"];
|
|
1203
1226
|
intervalDuration: number | null;
|
|
@@ -1232,6 +1255,16 @@ interface components {
|
|
|
1232
1255
|
publicUrl: string;
|
|
1233
1256
|
}[];
|
|
1234
1257
|
};
|
|
1258
|
+
/** FetchSlotAvailabilityResponse */
|
|
1259
|
+
FetchSlotAvailabilityResponse: {
|
|
1260
|
+
/** @description Slot start time in HH:MM:SS format */
|
|
1261
|
+
startTime: string;
|
|
1262
|
+
/** @description Whether a party of this size can be booked at this slot */
|
|
1263
|
+
acceptable: boolean;
|
|
1264
|
+
/** @description Whether the public widget should offer this slot — passive: always; auto_steer: only when acceptable */
|
|
1265
|
+
offered: boolean;
|
|
1266
|
+
reason: components["schemas"]["OccupancyReason"];
|
|
1267
|
+
}[];
|
|
1235
1268
|
/**
|
|
1236
1269
|
* CreateEventRequest
|
|
1237
1270
|
* @description Request payload for creating a new event
|
|
@@ -1250,13 +1283,19 @@ interface components {
|
|
|
1250
1283
|
maxGuests?: number | null;
|
|
1251
1284
|
minPartySize?: number | null;
|
|
1252
1285
|
maxPartySize?: number | null;
|
|
1286
|
+
staffByRole?: ((string | number | boolean | (null)) | {
|
|
1287
|
+
[key: string]: unknown;
|
|
1288
|
+
} | unknown[]) | null;
|
|
1253
1289
|
isPublic?: boolean;
|
|
1254
1290
|
reservationsEnabled?: boolean;
|
|
1255
1291
|
bookingOpensAtDays?: number | null;
|
|
1256
1292
|
bookingClosesAtOffset?: number | null;
|
|
1257
1293
|
isActive?: boolean;
|
|
1258
1294
|
isFeatured?: boolean;
|
|
1259
|
-
|
|
1295
|
+
takesOverDay?: boolean;
|
|
1296
|
+
servedMarket?: ((string | number | boolean | (null)) | {
|
|
1297
|
+
[key: string]: unknown;
|
|
1298
|
+
} | unknown[]) | null;
|
|
1260
1299
|
schedule?: {
|
|
1261
1300
|
rrule?: string | null;
|
|
1262
1301
|
timezone?: string | null;
|
|
@@ -1295,13 +1334,19 @@ interface components {
|
|
|
1295
1334
|
maxGuests: number | null;
|
|
1296
1335
|
minPartySize: number | null;
|
|
1297
1336
|
maxPartySize: number | null;
|
|
1337
|
+
staffByRole: ((string | number | boolean | (null)) | {
|
|
1338
|
+
[key: string]: unknown;
|
|
1339
|
+
} | unknown[]) | null;
|
|
1298
1340
|
isPublic: boolean;
|
|
1299
1341
|
reservationsEnabled: boolean;
|
|
1300
1342
|
bookingOpensAtDays: number | null;
|
|
1301
1343
|
bookingClosesAtOffset: number | null;
|
|
1302
1344
|
isActive: boolean;
|
|
1303
1345
|
isFeatured: boolean;
|
|
1304
|
-
|
|
1346
|
+
takesOverDay: boolean;
|
|
1347
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
1348
|
+
[key: string]: unknown;
|
|
1349
|
+
} | unknown[]) | null;
|
|
1305
1350
|
createdBy: string | null;
|
|
1306
1351
|
updatedBy: string | null;
|
|
1307
1352
|
createdAt: unknown;
|
|
@@ -1325,13 +1370,19 @@ interface components {
|
|
|
1325
1370
|
maxGuests?: number | null;
|
|
1326
1371
|
minPartySize?: number | null;
|
|
1327
1372
|
maxPartySize?: number | null;
|
|
1373
|
+
staffByRole?: ((string | number | boolean | (null)) | {
|
|
1374
|
+
[key: string]: unknown;
|
|
1375
|
+
} | unknown[]) | null;
|
|
1328
1376
|
isPublic?: boolean;
|
|
1329
1377
|
reservationsEnabled?: boolean;
|
|
1330
1378
|
bookingOpensAtDays?: number | null;
|
|
1331
1379
|
bookingClosesAtOffset?: number | null;
|
|
1332
1380
|
isActive?: boolean;
|
|
1333
1381
|
isFeatured?: boolean;
|
|
1334
|
-
|
|
1382
|
+
takesOverDay?: boolean;
|
|
1383
|
+
servedMarket?: ((string | number | boolean | (null)) | {
|
|
1384
|
+
[key: string]: unknown;
|
|
1385
|
+
} | unknown[]) | null;
|
|
1335
1386
|
schedule?: {
|
|
1336
1387
|
rrule?: string | null;
|
|
1337
1388
|
timezone?: string | null;
|
|
@@ -1348,65 +1399,66 @@ interface components {
|
|
|
1348
1399
|
} | null;
|
|
1349
1400
|
ritualAccessor?: string | null;
|
|
1350
1401
|
};
|
|
1351
|
-
/**
|
|
1352
|
-
|
|
1353
|
-
* @description Successfully updated event with schedule
|
|
1354
|
-
*/
|
|
1355
|
-
EditEventResponse: {
|
|
1402
|
+
/** Schedule */
|
|
1403
|
+
Schedule: {
|
|
1356
1404
|
id: string;
|
|
1357
|
-
venueId: string;
|
|
1358
|
-
accessor: string | null;
|
|
1359
1405
|
name: (string | number | boolean | (null)) | {
|
|
1360
1406
|
[key: string]: unknown;
|
|
1361
1407
|
} | unknown[];
|
|
1362
1408
|
description: ((string | number | boolean | (null)) | {
|
|
1363
1409
|
[key: string]: unknown;
|
|
1364
1410
|
} | unknown[]) | null;
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
reservationsEnabled: boolean;
|
|
1374
|
-
bookingOpensAtDays: number | null;
|
|
1375
|
-
bookingClosesAtOffset: number | null;
|
|
1411
|
+
timezone: string;
|
|
1412
|
+
rrule: string | null;
|
|
1413
|
+
exdates: string[] | null;
|
|
1414
|
+
validFrom: string | null;
|
|
1415
|
+
validTo: string | null;
|
|
1416
|
+
slotMode: components["schemas"]["SlotMode"];
|
|
1417
|
+
intervalDuration: number | null;
|
|
1418
|
+
duration: number | null;
|
|
1376
1419
|
isActive: boolean;
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
createdBy: string | null;
|
|
1420
|
+
sortIndex: string | null;
|
|
1421
|
+
updatedAt: unknown;
|
|
1380
1422
|
updatedBy: string | null;
|
|
1381
1423
|
createdAt: unknown;
|
|
1382
|
-
|
|
1383
|
-
|
|
1424
|
+
createdBy: string | null;
|
|
1425
|
+
scheduleTimeSlots?: {
|
|
1426
|
+
scheduleId: string | null;
|
|
1427
|
+
timeSlotId: string | null;
|
|
1428
|
+
dayOfWeek: components["schemas"]["DayOfWeek"];
|
|
1429
|
+
sortIndex: string | null;
|
|
1430
|
+
timeSlot: {
|
|
1431
|
+
id: string;
|
|
1432
|
+
startTime: string;
|
|
1433
|
+
endTime: string | null;
|
|
1434
|
+
isActive: boolean | null;
|
|
1435
|
+
isSchedulable: boolean | null;
|
|
1436
|
+
maxBookings: number | null;
|
|
1437
|
+
maxGuests: number | null;
|
|
1438
|
+
overflowBookings: number | null;
|
|
1439
|
+
overflowGuests: number | null;
|
|
1440
|
+
sortIndex: string | null;
|
|
1441
|
+
updatedAt: unknown;
|
|
1442
|
+
updatedBy: string | null;
|
|
1443
|
+
createdAt: unknown;
|
|
1444
|
+
createdBy: string | null;
|
|
1445
|
+
} | null;
|
|
1446
|
+
}[];
|
|
1447
|
+
scheduleOverrides?: {
|
|
1384
1448
|
id: string;
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
description: ((string | number | boolean | (null)) | {
|
|
1449
|
+
scheduleId: string;
|
|
1450
|
+
date: string;
|
|
1451
|
+
reason: ((string | number | boolean | (null)) | {
|
|
1389
1452
|
[key: string]: unknown;
|
|
1390
1453
|
} | unknown[]) | null;
|
|
1391
|
-
timezone: string;
|
|
1392
|
-
rrule: string | null;
|
|
1393
|
-
exdates: string[] | null;
|
|
1394
|
-
validFrom: string | null;
|
|
1395
|
-
validTo: string | null;
|
|
1396
|
-
priority: number | null;
|
|
1397
|
-
slotMode: components["schemas"]["SlotMode"];
|
|
1398
|
-
intervalDuration: number | null;
|
|
1399
|
-
duration: number | null;
|
|
1400
1454
|
isActive: boolean;
|
|
1401
|
-
sortIndex: string | null;
|
|
1402
1455
|
updatedAt: unknown;
|
|
1403
1456
|
updatedBy: string | null;
|
|
1404
1457
|
createdAt: unknown;
|
|
1405
1458
|
createdBy: string | null;
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
timeSlotId: string
|
|
1409
|
-
dayOfWeek: components["schemas"]["DayOfWeek"];
|
|
1459
|
+
scheduleOverrideTimeSlots: {
|
|
1460
|
+
overrideId: string;
|
|
1461
|
+
timeSlotId: string;
|
|
1410
1462
|
sortIndex: string | null;
|
|
1411
1463
|
timeSlot: {
|
|
1412
1464
|
id: string;
|
|
@@ -1414,14 +1466,58 @@ interface components {
|
|
|
1414
1466
|
endTime: string | null;
|
|
1415
1467
|
isActive: boolean | null;
|
|
1416
1468
|
isSchedulable: boolean | null;
|
|
1469
|
+
maxBookings: number | null;
|
|
1470
|
+
maxGuests: number | null;
|
|
1471
|
+
overflowBookings: number | null;
|
|
1472
|
+
overflowGuests: number | null;
|
|
1417
1473
|
sortIndex: string | null;
|
|
1418
1474
|
updatedAt: unknown;
|
|
1419
1475
|
updatedBy: string | null;
|
|
1420
1476
|
createdAt: unknown;
|
|
1421
1477
|
createdBy: string | null;
|
|
1422
|
-
}
|
|
1478
|
+
};
|
|
1423
1479
|
}[];
|
|
1424
|
-
}
|
|
1480
|
+
}[];
|
|
1481
|
+
};
|
|
1482
|
+
/**
|
|
1483
|
+
* EditEventResponse
|
|
1484
|
+
* @description Successfully updated event with schedule
|
|
1485
|
+
*/
|
|
1486
|
+
EditEventResponse: {
|
|
1487
|
+
id: string;
|
|
1488
|
+
venueId: string;
|
|
1489
|
+
accessor: string | null;
|
|
1490
|
+
name: (string | number | boolean | (null)) | {
|
|
1491
|
+
[key: string]: unknown;
|
|
1492
|
+
} | unknown[];
|
|
1493
|
+
description: ((string | number | boolean | (null)) | {
|
|
1494
|
+
[key: string]: unknown;
|
|
1495
|
+
} | unknown[]) | null;
|
|
1496
|
+
scheduleId: string | null;
|
|
1497
|
+
ritualId: string | null;
|
|
1498
|
+
occurrenceDate: string | null;
|
|
1499
|
+
maxBookings: number | null;
|
|
1500
|
+
maxGuests: number | null;
|
|
1501
|
+
minPartySize: number | null;
|
|
1502
|
+
maxPartySize: number | null;
|
|
1503
|
+
staffByRole: ((string | number | boolean | (null)) | {
|
|
1504
|
+
[key: string]: unknown;
|
|
1505
|
+
} | unknown[]) | null;
|
|
1506
|
+
isPublic: boolean;
|
|
1507
|
+
reservationsEnabled: boolean;
|
|
1508
|
+
bookingOpensAtDays: number | null;
|
|
1509
|
+
bookingClosesAtOffset: number | null;
|
|
1510
|
+
isActive: boolean;
|
|
1511
|
+
isFeatured: boolean;
|
|
1512
|
+
takesOverDay: boolean;
|
|
1513
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
1514
|
+
[key: string]: unknown;
|
|
1515
|
+
} | unknown[]) | null;
|
|
1516
|
+
createdBy: string | null;
|
|
1517
|
+
updatedBy: string | null;
|
|
1518
|
+
createdAt: unknown;
|
|
1519
|
+
updatedAt: unknown;
|
|
1520
|
+
schedule: components["schemas"]["Schedule"] | null;
|
|
1425
1521
|
};
|
|
1426
1522
|
/** DeleteEventResponse */
|
|
1427
1523
|
DeleteEventResponse: {
|
|
@@ -1441,13 +1537,19 @@ interface components {
|
|
|
1441
1537
|
maxGuests: number | null;
|
|
1442
1538
|
minPartySize: number | null;
|
|
1443
1539
|
maxPartySize: number | null;
|
|
1540
|
+
staffByRole: ((string | number | boolean | (null)) | {
|
|
1541
|
+
[key: string]: unknown;
|
|
1542
|
+
} | unknown[]) | null;
|
|
1444
1543
|
isPublic: boolean;
|
|
1445
1544
|
reservationsEnabled: boolean;
|
|
1446
1545
|
bookingOpensAtDays: number | null;
|
|
1447
1546
|
bookingClosesAtOffset: number | null;
|
|
1448
1547
|
isActive: boolean;
|
|
1449
1548
|
isFeatured: boolean;
|
|
1450
|
-
|
|
1549
|
+
takesOverDay: boolean;
|
|
1550
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
1551
|
+
[key: string]: unknown;
|
|
1552
|
+
} | unknown[]) | null;
|
|
1451
1553
|
createdBy: string | null;
|
|
1452
1554
|
updatedBy: string | null;
|
|
1453
1555
|
createdAt: unknown;
|
|
@@ -1904,6 +2006,11 @@ interface components {
|
|
|
1904
2006
|
* @description UUID of the event this reservation is for
|
|
1905
2007
|
*/
|
|
1906
2008
|
eventId: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* Format: uuid
|
|
2011
|
+
* @description UUID of the area to seat this party in. Defaults to the event's primary area (the one with the most tables) when omitted; the occupancy gate evaluates capacity against this area.
|
|
2012
|
+
*/
|
|
2013
|
+
areaId?: string | null;
|
|
1907
2014
|
/** @description Date of the reservation in YYYY-MM-DD format */
|
|
1908
2015
|
reservationDate: string;
|
|
1909
2016
|
/** @description Time of the reservation in HH:MM:SS format */
|
|
@@ -1963,6 +2070,7 @@ interface components {
|
|
|
1963
2070
|
* @description Event identifier for this reservation
|
|
1964
2071
|
*/
|
|
1965
2072
|
eventId: string;
|
|
2073
|
+
areaId: string | null;
|
|
1966
2074
|
quickReferenceNumber: number | null;
|
|
1967
2075
|
/** @description Date of the reservation in YYYY-MM-DD format */
|
|
1968
2076
|
reservationDate: string;
|
|
@@ -2046,7 +2154,9 @@ interface components {
|
|
|
2046
2154
|
bookingClosesAtOffset: number | null;
|
|
2047
2155
|
isActive: boolean;
|
|
2048
2156
|
isFeatured: boolean;
|
|
2049
|
-
|
|
2157
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
2158
|
+
[key: string]: unknown;
|
|
2159
|
+
} | unknown[]) | null;
|
|
2050
2160
|
createdBy: string | null;
|
|
2051
2161
|
updatedBy: string | null;
|
|
2052
2162
|
createdAt: unknown;
|
|
@@ -2098,92 +2208,26 @@ interface components {
|
|
|
2098
2208
|
maxGuests: number | null;
|
|
2099
2209
|
minPartySize: number | null;
|
|
2100
2210
|
maxPartySize: number | null;
|
|
2211
|
+
staffByRole: ((string | number | boolean | (null)) | {
|
|
2212
|
+
[key: string]: unknown;
|
|
2213
|
+
} | unknown[]) | null;
|
|
2101
2214
|
isPublic: boolean;
|
|
2102
2215
|
reservationsEnabled: boolean;
|
|
2103
2216
|
bookingOpensAtDays: number | null;
|
|
2104
2217
|
bookingClosesAtOffset: number | null;
|
|
2105
2218
|
isActive: boolean;
|
|
2106
2219
|
isFeatured: boolean;
|
|
2107
|
-
|
|
2220
|
+
takesOverDay: boolean;
|
|
2221
|
+
servedMarket: ((string | number | boolean | (null)) | {
|
|
2222
|
+
[key: string]: unknown;
|
|
2223
|
+
} | unknown[]) | null;
|
|
2108
2224
|
createdBy: string | null;
|
|
2109
2225
|
updatedBy: string | null;
|
|
2110
2226
|
createdAt: unknown;
|
|
2111
2227
|
updatedAt: unknown;
|
|
2112
2228
|
covers: number;
|
|
2113
2229
|
}[];
|
|
2114
|
-
schedule:
|
|
2115
|
-
id: string;
|
|
2116
|
-
name: (string | number | boolean | (null)) | {
|
|
2117
|
-
[key: string]: unknown;
|
|
2118
|
-
} | unknown[];
|
|
2119
|
-
description: ((string | number | boolean | (null)) | {
|
|
2120
|
-
[key: string]: unknown;
|
|
2121
|
-
} | unknown[]) | null;
|
|
2122
|
-
timezone: string;
|
|
2123
|
-
rrule: string | null;
|
|
2124
|
-
exdates: string[] | null;
|
|
2125
|
-
validFrom: string | null;
|
|
2126
|
-
validTo: string | null;
|
|
2127
|
-
priority: number | null;
|
|
2128
|
-
slotMode: components["schemas"]["SlotMode"];
|
|
2129
|
-
intervalDuration: number | null;
|
|
2130
|
-
duration: number | null;
|
|
2131
|
-
isActive: boolean;
|
|
2132
|
-
sortIndex: string | null;
|
|
2133
|
-
updatedAt: unknown;
|
|
2134
|
-
updatedBy: string | null;
|
|
2135
|
-
createdAt: unknown;
|
|
2136
|
-
createdBy: string | null;
|
|
2137
|
-
scheduleTimeSlots: {
|
|
2138
|
-
scheduleId: string | null;
|
|
2139
|
-
timeSlotId: string | null;
|
|
2140
|
-
dayOfWeek: components["schemas"]["DayOfWeek"];
|
|
2141
|
-
sortIndex: string | null;
|
|
2142
|
-
timeSlot: {
|
|
2143
|
-
id: string;
|
|
2144
|
-
startTime: string;
|
|
2145
|
-
endTime: string | null;
|
|
2146
|
-
isActive: boolean | null;
|
|
2147
|
-
isSchedulable: boolean | null;
|
|
2148
|
-
sortIndex: string | null;
|
|
2149
|
-
updatedAt: unknown;
|
|
2150
|
-
updatedBy: string | null;
|
|
2151
|
-
createdAt: unknown;
|
|
2152
|
-
createdBy: string | null;
|
|
2153
|
-
} | null;
|
|
2154
|
-
}[];
|
|
2155
|
-
scheduleOverrides: {
|
|
2156
|
-
id: string;
|
|
2157
|
-
scheduleId: string;
|
|
2158
|
-
date: string;
|
|
2159
|
-
reason: ((string | number | boolean | (null)) | {
|
|
2160
|
-
[key: string]: unknown;
|
|
2161
|
-
} | unknown[]) | null;
|
|
2162
|
-
isActive: boolean;
|
|
2163
|
-
priority: number | null;
|
|
2164
|
-
updatedAt: unknown;
|
|
2165
|
-
updatedBy: string | null;
|
|
2166
|
-
createdAt: unknown;
|
|
2167
|
-
createdBy: string | null;
|
|
2168
|
-
scheduleOverrideTimeSlots: {
|
|
2169
|
-
overrideId: string;
|
|
2170
|
-
timeSlotId: string;
|
|
2171
|
-
sortIndex: string | null;
|
|
2172
|
-
timeSlot: {
|
|
2173
|
-
id: string;
|
|
2174
|
-
startTime: string;
|
|
2175
|
-
endTime: string | null;
|
|
2176
|
-
isActive: boolean | null;
|
|
2177
|
-
isSchedulable: boolean | null;
|
|
2178
|
-
sortIndex: string | null;
|
|
2179
|
-
updatedAt: unknown;
|
|
2180
|
-
updatedBy: string | null;
|
|
2181
|
-
createdAt: unknown;
|
|
2182
|
-
createdBy: string | null;
|
|
2183
|
-
};
|
|
2184
|
-
}[];
|
|
2185
|
-
}[];
|
|
2186
|
-
} | null;
|
|
2230
|
+
schedule: components["schemas"]["Schedule"] | null;
|
|
2187
2231
|
};
|
|
2188
2232
|
/** GetSubscriptionResponse */
|
|
2189
2233
|
GetSubscriptionResponse: {
|
|
@@ -2590,6 +2634,8 @@ interface components {
|
|
|
2590
2634
|
/** @enum {string} */
|
|
2591
2635
|
AreaBookingStatus: "confirmed" | "arrived" | "completed" | "cancelled" | "no_show";
|
|
2592
2636
|
/** @enum {string} */
|
|
2637
|
+
AreaType: "indoor" | "outdoor";
|
|
2638
|
+
/** @enum {string} */
|
|
2593
2639
|
ArticleEditorSaveState: "idle" | "saving" | "saved" | "error";
|
|
2594
2640
|
/** @enum {string} */
|
|
2595
2641
|
ArticleStatus: "draft" | "published";
|
|
@@ -2626,14 +2672,24 @@ interface components {
|
|
|
2626
2672
|
/** @enum {string} */
|
|
2627
2673
|
MenuItemType: "dish" | "beverage";
|
|
2628
2674
|
/** @enum {string} */
|
|
2675
|
+
OccupancyReason: "ok" | "tables" | "personnel";
|
|
2676
|
+
/** @enum {string} */
|
|
2629
2677
|
FulfillmentType: "pickup" | "delivery";
|
|
2630
2678
|
/** @enum {string} */
|
|
2631
2679
|
OrderStatus: "pending" | "in_progress" | "ready" | "completed" | "cancelled";
|
|
2632
2680
|
/** @enum {string} */
|
|
2681
|
+
PaxBand: "1-2" | "3-4" | "5-6" | "7+";
|
|
2682
|
+
/** @enum {string} */
|
|
2633
2683
|
PaymentMethod: "card" | "cash" | "voucher";
|
|
2634
2684
|
/** @enum {string} */
|
|
2635
2685
|
PaymentStatus: "unpaid" | "paid" | "refunded" | "authorized" | "cash_pending";
|
|
2636
2686
|
/** @enum {string} */
|
|
2687
|
+
PlatformRole: "platform_maintainer";
|
|
2688
|
+
/** @enum {string} */
|
|
2689
|
+
ReservationMode: "passive" | "auto_steer";
|
|
2690
|
+
/** @enum {string} */
|
|
2691
|
+
Role: "superadmin" | "admin" | "manager" | "chef" | "cook" | "waiter" | "rider";
|
|
2692
|
+
/** @enum {string} */
|
|
2637
2693
|
ScanTokenEntityType: "order" | "depositware";
|
|
2638
2694
|
/** @enum {string} */
|
|
2639
2695
|
SortOrder: "asc" | "desc";
|
|
@@ -2656,13 +2712,13 @@ interface components {
|
|
|
2656
2712
|
/** @enum {string} */
|
|
2657
2713
|
MentionEntityType: "dish" | "beverage" | "ingredient" | "menu" | "ritual";
|
|
2658
2714
|
/** @enum {string} */
|
|
2659
|
-
|
|
2715
|
+
MentionType: "link" | "value";
|
|
2660
2716
|
/** @enum {string} */
|
|
2661
2717
|
PendingSuperadminTransferStatus: "pending_invite" | "accepted_awaiting_payment" | "completed" | "cancelled" | "expired";
|
|
2662
2718
|
/** @enum {string} */
|
|
2663
2719
|
BillingMode: "single_anchor" | "split";
|
|
2664
2720
|
/** @enum {string} */
|
|
2665
|
-
|
|
2721
|
+
VenueChargeType: "base" | "addon";
|
|
2666
2722
|
/** @enum {string} */
|
|
2667
2723
|
AssetType: "image" | "video" | "document";
|
|
2668
2724
|
/** @enum {string} */
|
|
@@ -2670,6 +2726,8 @@ interface components {
|
|
|
2670
2726
|
/** @enum {string} */
|
|
2671
2727
|
GbpSyncStatus: "processing" | "live" | "rejected" | "failed" | "removed";
|
|
2672
2728
|
/** @enum {string} */
|
|
2729
|
+
GeoAreaType: "postcode" | "city" | "region";
|
|
2730
|
+
/** @enum {string} */
|
|
2673
2731
|
Jurisdiction: "DE" | "CH" | "FR" | "IT";
|
|
2674
2732
|
/** @enum {string} */
|
|
2675
2733
|
EventAssetSource: "inherited" | "manual";
|
|
@@ -3009,6 +3067,12 @@ interface GetAreaOptions {
|
|
|
3009
3067
|
}
|
|
3010
3068
|
type AreaAvailabilityWindow = schemas['GetAreaAvailabilityResponse']['occupied'][number];
|
|
3011
3069
|
type AreaAvailabilityResponse = schemas['GetAreaAvailabilityResponse'];
|
|
3070
|
+
type EventSlotAvailabilityResponse = schemas['FetchSlotAvailabilityResponse'];
|
|
3071
|
+
interface GetEventSlotAvailabilityOptions {
|
|
3072
|
+
reservationDate: string;
|
|
3073
|
+
partySize: number;
|
|
3074
|
+
areaId?: string;
|
|
3075
|
+
}
|
|
3012
3076
|
interface GetAreaAvailabilityOptions {
|
|
3013
3077
|
/** YYYY-MM-DD — defaults to today */
|
|
3014
3078
|
from?: string;
|
|
@@ -3398,6 +3462,13 @@ declare class EventsResource extends BaseResource {
|
|
|
3398
3462
|
* `assets[]` array (empty when the event has none).
|
|
3399
3463
|
*/
|
|
3400
3464
|
listAssets(idOrAccessor: string): Promise<EventAssetEntry[]>;
|
|
3465
|
+
/**
|
|
3466
|
+
* Per-start-slot occupancy availability for an event on a date. Each slot's
|
|
3467
|
+
* `offered` honours the venue's reservation mode (`passive`: every slot;
|
|
3468
|
+
* `auto_steer`: only acceptable slots), so a public widget can pre-exclude
|
|
3469
|
+
* fully-booked start times.
|
|
3470
|
+
*/
|
|
3471
|
+
getSlotAvailability(idOrAccessor: string, options: GetEventSlotAvailabilityOptions): Promise<EventSlotAvailabilityResponse>;
|
|
3401
3472
|
/**
|
|
3402
3473
|
* Upload a asset image for an event. The SDK builds the multipart
|
|
3403
3474
|
* body internally — pass a Buffer/Uint8Array, the original filename,
|