@wix/table-reservations 1.0.164 → 1.0.165

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.
@@ -8,16 +8,6 @@ interface Reservation$1 {
8
8
  /**
9
9
  * Status of the reservation.
10
10
  *
11
- * * `HELD`: The reservation is temporary and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.
12
- * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.
13
- * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
14
- * * `RESERVED`: The reservation is confirmed.
15
- * * `SEATED`: The customer is currently occupying the table.
16
- * * `CANCELED`: The reservation is canceled.
17
- * * `NO_SHOW`: The customer didn't show up for their reservation.
18
- * * `FINISHED`: The reservation completed successfully.
19
- * * `PAYMENT_PENDING`: The reservation is temporary and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reservation is in `HELD` status and the reserve reservation method is called and payment is needed. After payment is completed status will be changed automatically to `RESERVED`.
20
- *
21
11
  * See the Reservation Lifecycle article([REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/table-reservations/reservations/the-reservation-lifecycle)) for an explanation of the role of statuses in the reservation lifecycle.
22
12
  */
23
13
  status?: Status$3;
@@ -25,9 +15,6 @@ interface Reservation$1 {
25
15
  * Reservation source.
26
16
  *
27
17
  * This indicates how the reservation was made.
28
- * * `ONLINE` indicates that the customer made the reservation through a website or app.
29
- * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
30
- * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.
31
18
  */
32
19
  source?: Source$1;
33
20
  /** Reservation details. */
@@ -90,33 +77,35 @@ interface Tables$1 {
90
77
  ids?: string[];
91
78
  }
92
79
  declare enum Status$3 {
80
+ /** Undefined reservation status. */
93
81
  UNKNOWN = "UNKNOWN",
94
- /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
82
+ /** A customer has begun the reservation flow, a temporary reservation is created and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request. */
95
83
  HELD = "HELD",
96
- /** The reservation has been reserved. */
84
+ /** The reservation is confirmed. */
97
85
  RESERVED = "RESERVED",
98
- /** The reservation has been canceled. */
86
+ /** The reservation is canceled. */
99
87
  CANCELED = "CANCELED",
100
- /** The reservation has finished successfully. */
88
+ /** The reservation completed successfully. */
101
89
  FINISHED = "FINISHED",
102
- /** The reservee didn't arrive. */
90
+ /** The customer didn't show up for their reservation. */
103
91
  NO_SHOW = "NO_SHOW",
104
- /** The reservee occupied the table. */
92
+ /** The customer is currently occupying the table. */
105
93
  SEATED = "SEATED",
106
- /** The reservee requested a reservation and is waiting for manual approval. */
94
+ /** A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request. */
107
95
  REQUESTED = "REQUESTED",
108
- /** The owner declined a reservee's request. */
96
+ /** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
109
97
  DECLINED = "DECLINED",
110
- /** The reservation is held for 10 minutes from the created time, during which time the reservee should pay. After payment is completed status will be changed automatically to RESERVED. */
98
+ /** A customer has begun the checkout flow, the temporary reservation is moved to this status and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reserve reservation endpoint is called for a reservation in `HELD` status and payment is needed. After payment is completed status will be changed automatically to `RESERVED`. */
111
99
  PAYMENT_PENDING = "PAYMENT_PENDING"
112
100
  }
113
101
  declare enum Source$1 {
102
+ /** Undefined reservation source. */
114
103
  UNKNOWN = "UNKNOWN",
115
- /** The reservation is created by a User. */
104
+ /** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
116
105
  OFFLINE = "OFFLINE",
117
- /** The reservation is created by UoU. */
106
+ /** The reservation was made through a website or app. */
118
107
  ONLINE = "ONLINE",
119
- /** The reservation is created by a User. It can be created without reservee data. */
108
+ /** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
120
109
  WALK_IN = "WALK_IN"
121
110
  }
122
111
  /** Reservation details. */
@@ -184,18 +173,19 @@ interface ReservedBy$1 {
184
173
  contactId?: string | null;
185
174
  }
186
175
  declare enum PaymentStatus$1 {
176
+ /** Undefined payment status. */
187
177
  UNKNOWN = "UNKNOWN",
188
178
  /** A reservation is free of charge. */
189
179
  FREE = "FREE",
190
- /** A payment is not received yet. */
180
+ /** Payment is not received yet. */
191
181
  NOT_PAID = "NOT_PAID",
192
- /** A corresponding to reservation order was fully payed. */
182
+ /** The corresponding reservation order was fully paid. */
193
183
  PAID = "PAID",
194
- /** A corresponding to reservation order was refunded, but refund amount is less than order total price. */
184
+ /** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
195
185
  PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
196
- /** A corresponding to reservation order was fully refunded. The refund amount equals total price. */
186
+ /** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
197
187
  FULLY_REFUNDED = "FULLY_REFUNDED",
198
- /** A corresponding to reservation order was partially payed. */
188
+ /** The corresponding reservation order was partially paid. */
199
189
  PARTIALLY_PAID = "PARTIALLY_PAID"
200
190
  }
201
191
  interface ExtendedFields$3 {
@@ -232,15 +222,23 @@ interface CreateReservationRequest$1 {
232
222
  ignoreReservationLocationConflicts?: Type$3[];
233
223
  }
234
224
  declare enum TableCombinationConflictType$3 {
225
+ /** Undefined conflict type. */
235
226
  UNKNOWN = "UNKNOWN",
227
+ /** One or more of the chosen tables are already reserved. */
236
228
  RESERVED = "RESERVED",
229
+ /** The party is too big for the selected table. */
237
230
  TOO_BIG = "TOO_BIG",
231
+ /** The party is too small for the selected table. */
238
232
  TOO_SMALL = "TOO_SMALL",
233
+ /** The restaurant does not allow online reservations. */
239
234
  OFFLINE_ONLY = "OFFLINE_ONLY"
240
235
  }
241
236
  declare enum Type$3 {
237
+ /** Undefined reservation location conflict type. */
242
238
  UNKNOWN = "UNKNOWN",
239
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
243
240
  PARTY_PACING = "PARTY_PACING",
241
+ /** The required number of seats are unavailable according to seat pacing settings. */
244
242
  SEAT_PACING = "SEAT_PACING"
245
243
  }
246
244
  interface CreateReservationResponse$1 {
@@ -252,17 +250,17 @@ interface GetReservationRequest$1 {
252
250
  reservationId: string;
253
251
  /**
254
252
  * Array of named, predefined sets of projected fields to be returned.
255
- *
256
- * - `PUBLIC`: Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`.
257
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
258
- * - `FULL`: Returns all fields.
259
- *
260
253
  * Default: If `fields` is omitted from the request, `PUBLIC`.
261
254
  */
262
255
  fieldsets?: Set$3[];
263
256
  }
264
257
  declare enum Set$3 {
258
+ /**
259
+ * Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
260
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
261
+ */
265
262
  PUBLIC = "PUBLIC",
263
+ /** Returns all fields. */
266
264
  FULL = "FULL"
267
265
  }
268
266
  interface GetReservationResponse$1 {
@@ -272,23 +270,8 @@ interface GetReservationResponse$1 {
272
270
  interface UpdateReservationRequest$1 {
273
271
  /** Reservation information to update. */
274
272
  reservation: Reservation$1;
275
- /**
276
- * Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
277
- *
278
- * Possible values:
279
- * * `"RESERVED"`: One or more of the chosen tables are already reserved.
280
- * * `"TOO_BIG"`: The party is too big for the selected table.
281
- * * `"TOO_SMALL"`: The party is too small for the selected table.
282
- * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
283
- */
273
+ /** Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it. */
284
274
  ignoreTableCombinationConflicts?: TableCombinationConflictType$3[];
285
- /**
286
- * Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
287
- *
288
- * Possible values:
289
- * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
290
- * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
291
- */
292
275
  ignoreReservationLocationConflicts?: Type$3[];
293
276
  }
294
277
  interface UpdateReservationResponse$1 {
@@ -377,18 +360,7 @@ interface ListReservationsRequest$1 {
377
360
  startDateFrom?: Date | null;
378
361
  /** Only reservations starting before this date are returned. */
379
362
  startDateTo?: Date | null;
380
- /**
381
- * Only reservations with this status are returned.
382
- *
383
- * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.
384
- * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.
385
- * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
386
- * * `RESERVED`: The reservation is confirmed.
387
- * * `SEATED`: The customer is currently occupying the table.
388
- * * `CANCELED`: The reservation is canceled.
389
- * * `NO_SHOW`: The customer didn't show up for their reservation.
390
- * * `FINISHED`: The reservation completed successfully.
391
- */
363
+ /** Only reservations with this status are returned. */
392
364
  status?: Status$3;
393
365
  }
394
366
  interface CursorPaging$3 {
@@ -408,13 +380,14 @@ interface Sorting$3 {
408
380
  fieldName?: string;
409
381
  /**
410
382
  * Sort order.
411
- *
412
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
383
+ * Default: `ASC`.
413
384
  */
414
385
  order?: SortOrder$3;
415
386
  }
416
387
  declare enum SortOrder$3 {
388
+ /** Sort by ascending order. */
417
389
  ASC = "ASC",
390
+ /** Sort by descending order. */
418
391
  DESC = "DESC"
419
392
  }
420
393
  interface ListReservationsResponse$1 {
@@ -575,6 +548,7 @@ interface IncludeMissingValuesOptions$1 {
575
548
  addToBucket?: string;
576
549
  }
577
550
  declare enum ScalarType$1 {
551
+ /** Undefined scalar type. */
578
552
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
579
553
  /** Count of distinct values. */
580
554
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -588,14 +562,15 @@ declare enum ScalarType$1 {
588
562
  AVG = "AVG"
589
563
  }
590
564
  declare enum NestedAggregationType$1 {
565
+ /** Undefined aggregation type. */
591
566
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
592
567
  /** An aggregation where result buckets are dynamically built - one per unique value. */
593
568
  VALUE = "VALUE",
594
569
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
595
570
  RANGE = "RANGE",
596
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
571
+ /** A single-value metric aggregation - such as min, max, sum, and avg. */
597
572
  SCALAR = "SCALAR",
598
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
573
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
599
574
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
600
575
  }
601
576
  interface ValueAggregation$1 extends ValueAggregationOptionsOneOf$1 {
@@ -673,14 +648,15 @@ interface NestedAggregationItemKindOneOf$1 {
673
648
  dateHistogram?: DateHistogramAggregation$1;
674
649
  }
675
650
  declare enum AggregationType$1 {
651
+ /** Undefined aggregation type. */
676
652
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
677
653
  /** An aggregation where result buckets are dynamically built - one per unique value. */
678
654
  VALUE = "VALUE",
679
655
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
680
656
  RANGE = "RANGE",
681
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
657
+ /** A single-value metric aggregation - such as min, max, sum, or avg. */
682
658
  SCALAR = "SCALAR",
683
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
659
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
684
660
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
685
661
  /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
686
662
  NESTED = "NESTED"
@@ -1011,9 +987,6 @@ interface Reservation {
1011
987
  * Reservation source.
1012
988
  *
1013
989
  * This indicates how the reservation was made.
1014
- * * `ONLINE` indicates that the customer made the reservation through a website or app.
1015
- * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
1016
- * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.
1017
990
  */
1018
991
  source?: Source;
1019
992
  /** Reservation details. */
@@ -1076,33 +1049,35 @@ interface Tables {
1076
1049
  ids?: string[];
1077
1050
  }
1078
1051
  declare enum Status$2 {
1052
+ /** Undefined reservation status. */
1079
1053
  UNKNOWN = "UNKNOWN",
1080
- /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
1054
+ /** A customer has begun the reservation flow, a temporary reservation is created and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request. */
1081
1055
  HELD = "HELD",
1082
- /** The reservation has been reserved. */
1056
+ /** The reservation is confirmed. */
1083
1057
  RESERVED = "RESERVED",
1084
- /** The reservation has been canceled. */
1058
+ /** The reservation is canceled. */
1085
1059
  CANCELED = "CANCELED",
1086
- /** The reservation has finished successfully. */
1060
+ /** The reservation completed successfully. */
1087
1061
  FINISHED = "FINISHED",
1088
- /** The reservee didn't arrive. */
1062
+ /** The customer didn't show up for their reservation. */
1089
1063
  NO_SHOW = "NO_SHOW",
1090
- /** The reservee occupied the table. */
1064
+ /** The customer is currently occupying the table. */
1091
1065
  SEATED = "SEATED",
1092
- /** The reservee requested a reservation and is waiting for manual approval. */
1066
+ /** A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request. */
1093
1067
  REQUESTED = "REQUESTED",
1094
- /** The owner declined a reservee's request. */
1068
+ /** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
1095
1069
  DECLINED = "DECLINED",
1096
- /** The reservation is held for 10 minutes from the created time, during which time the reservee should pay. After payment is completed status will be changed automatically to RESERVED. */
1070
+ /** A customer has begun the checkout flow, the temporary reservation is moved to this status and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reserve reservation endpoint is called for a reservation in `HELD` status and payment is needed. After payment is completed status will be changed automatically to `RESERVED`. */
1097
1071
  PAYMENT_PENDING = "PAYMENT_PENDING"
1098
1072
  }
1099
1073
  declare enum Source {
1074
+ /** Undefined reservation source. */
1100
1075
  UNKNOWN = "UNKNOWN",
1101
- /** The reservation is created by a User. */
1076
+ /** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
1102
1077
  OFFLINE = "OFFLINE",
1103
- /** The reservation is created by UoU. */
1078
+ /** The reservation was made through a website or app. */
1104
1079
  ONLINE = "ONLINE",
1105
- /** The reservation is created by a User. It can be created without reservee data. */
1080
+ /** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
1106
1081
  WALK_IN = "WALK_IN"
1107
1082
  }
1108
1083
  /** Reservation details. */
@@ -1170,18 +1145,19 @@ interface ReservedBy {
1170
1145
  contactId?: string | null;
1171
1146
  }
1172
1147
  declare enum PaymentStatus {
1148
+ /** Undefined payment status. */
1173
1149
  UNKNOWN = "UNKNOWN",
1174
1150
  /** A reservation is free of charge. */
1175
1151
  FREE = "FREE",
1176
- /** A payment is not received yet. */
1152
+ /** Payment is not received yet. */
1177
1153
  NOT_PAID = "NOT_PAID",
1178
- /** A corresponding to reservation order was fully payed. */
1154
+ /** The corresponding reservation order was fully paid. */
1179
1155
  PAID = "PAID",
1180
- /** A corresponding to reservation order was refunded, but refund amount is less than order total price. */
1156
+ /** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
1181
1157
  PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
1182
- /** A corresponding to reservation order was fully refunded. The refund amount equals total price. */
1158
+ /** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
1183
1159
  FULLY_REFUNDED = "FULLY_REFUNDED",
1184
- /** A corresponding to reservation order was partially payed. */
1160
+ /** The corresponding reservation order was partially paid. */
1185
1161
  PARTIALLY_PAID = "PARTIALLY_PAID"
1186
1162
  }
1187
1163
  interface ExtendedFields$2 {
@@ -1218,15 +1194,23 @@ interface CreateReservationRequest {
1218
1194
  ignoreReservationLocationConflicts?: Type$2[];
1219
1195
  }
1220
1196
  declare enum TableCombinationConflictType$2 {
1197
+ /** Undefined conflict type. */
1221
1198
  UNKNOWN = "UNKNOWN",
1199
+ /** One or more of the chosen tables are already reserved. */
1222
1200
  RESERVED = "RESERVED",
1201
+ /** The party is too big for the selected table. */
1223
1202
  TOO_BIG = "TOO_BIG",
1203
+ /** The party is too small for the selected table. */
1224
1204
  TOO_SMALL = "TOO_SMALL",
1205
+ /** The restaurant does not allow online reservations. */
1225
1206
  OFFLINE_ONLY = "OFFLINE_ONLY"
1226
1207
  }
1227
1208
  declare enum Type$2 {
1209
+ /** Undefined reservation location conflict type. */
1228
1210
  UNKNOWN = "UNKNOWN",
1211
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
1229
1212
  PARTY_PACING = "PARTY_PACING",
1213
+ /** The required number of seats are unavailable according to seat pacing settings. */
1230
1214
  SEAT_PACING = "SEAT_PACING"
1231
1215
  }
1232
1216
  interface CreateReservationResponse {
@@ -1246,7 +1230,12 @@ interface GetReservationRequest {
1246
1230
  fieldsets?: Set$2[];
1247
1231
  }
1248
1232
  declare enum Set$2 {
1233
+ /**
1234
+ * Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
1235
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
1236
+ */
1249
1237
  PUBLIC = "PUBLIC",
1238
+ /** Returns all fields. */
1250
1239
  FULL = "FULL"
1251
1240
  }
1252
1241
  interface GetReservationResponse {
@@ -1256,23 +1245,8 @@ interface GetReservationResponse {
1256
1245
  interface UpdateReservationRequest {
1257
1246
  /** Reservation information to update. */
1258
1247
  reservation: Reservation;
1259
- /**
1260
- * Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
1261
- *
1262
- * Possible values:
1263
- * * `"RESERVED"`: One or more of the chosen tables are already reserved.
1264
- * * `"TOO_BIG"`: The party is too big for the selected table.
1265
- * * `"TOO_SMALL"`: The party is too small for the selected table.
1266
- * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
1267
- */
1248
+ /** Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it. */
1268
1249
  ignoreTableCombinationConflicts?: TableCombinationConflictType$2[];
1269
- /**
1270
- * Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
1271
- *
1272
- * Possible values:
1273
- * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
1274
- * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
1275
- */
1276
1250
  ignoreReservationLocationConflicts?: Type$2[];
1277
1251
  }
1278
1252
  interface UpdateReservationResponse {
@@ -1361,18 +1335,7 @@ interface ListReservationsRequest {
1361
1335
  startDateFrom?: Date | null;
1362
1336
  /** Only reservations starting before this date are returned. */
1363
1337
  startDateTo?: Date | null;
1364
- /**
1365
- * Only reservations with this status are returned.
1366
- *
1367
- * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.
1368
- * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.
1369
- * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
1370
- * * `RESERVED`: The reservation is confirmed.
1371
- * * `SEATED`: The customer is currently occupying the table.
1372
- * * `CANCELED`: The reservation is canceled.
1373
- * * `NO_SHOW`: The customer didn't show up for their reservation.
1374
- * * `FINISHED`: The reservation completed successfully.
1375
- */
1338
+ /** Only reservations with this status are returned. */
1376
1339
  status?: Status$2;
1377
1340
  }
1378
1341
  interface CursorPaging$2 {
@@ -1392,13 +1355,14 @@ interface Sorting$2 {
1392
1355
  fieldName?: string;
1393
1356
  /**
1394
1357
  * Sort order.
1395
- *
1396
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
1358
+ * Default: `ASC`.
1397
1359
  */
1398
1360
  order?: SortOrder$2;
1399
1361
  }
1400
1362
  declare enum SortOrder$2 {
1363
+ /** Sort by ascending order. */
1401
1364
  ASC = "ASC",
1365
+ /** Sort by descending order. */
1402
1366
  DESC = "DESC"
1403
1367
  }
1404
1368
  interface ListReservationsResponse {
@@ -1559,6 +1523,7 @@ interface IncludeMissingValuesOptions {
1559
1523
  addToBucket?: string;
1560
1524
  }
1561
1525
  declare enum ScalarType {
1526
+ /** Undefined scalar type. */
1562
1527
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1563
1528
  /** Count of distinct values. */
1564
1529
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -1572,14 +1537,15 @@ declare enum ScalarType {
1572
1537
  AVG = "AVG"
1573
1538
  }
1574
1539
  declare enum NestedAggregationType {
1540
+ /** Undefined aggregation type. */
1575
1541
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1576
1542
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1577
1543
  VALUE = "VALUE",
1578
1544
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
1579
1545
  RANGE = "RANGE",
1580
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
1546
+ /** A single-value metric aggregation - such as min, max, sum, and avg. */
1581
1547
  SCALAR = "SCALAR",
1582
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1548
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
1583
1549
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1584
1550
  }
1585
1551
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
@@ -1657,14 +1623,15 @@ interface NestedAggregationItemKindOneOf {
1657
1623
  dateHistogram?: DateHistogramAggregation;
1658
1624
  }
1659
1625
  declare enum AggregationType {
1626
+ /** Undefined aggregation type. */
1660
1627
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1661
1628
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1662
1629
  VALUE = "VALUE",
1663
1630
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
1664
1631
  RANGE = "RANGE",
1665
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
1632
+ /** A single-value metric aggregation - such as min, max, sum, or avg. */
1666
1633
  SCALAR = "SCALAR",
1667
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1634
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
1668
1635
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
1669
1636
  /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
1670
1637
  NESTED = "NESTED"
@@ -2478,18 +2445,19 @@ interface GetReservationLocationRequest$1 {
2478
2445
  /**
2479
2446
  * Array of named, predefined sets of projected fields to be returned.
2480
2447
  *
2481
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2482
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2483
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2484
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2485
- * - `FULL`: Returns all fields.
2486
- *
2487
2448
  * Default: `PUBLIC`.
2488
2449
  */
2489
2450
  fieldsets?: Set$1[];
2490
2451
  }
2491
2452
  declare enum Set$1 {
2453
+ /**
2454
+ * Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2455
+ * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2456
+ * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2457
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2458
+ */
2492
2459
  PUBLIC = "PUBLIC",
2460
+ /** - `FULL`: Returns all fields. */
2493
2461
  FULL = "FULL"
2494
2462
  }
2495
2463
  interface GetReservationLocationResponse$1 {
@@ -2522,12 +2490,6 @@ interface QueryReservationLocationsRequest$1 {
2522
2490
  /**
2523
2491
  * Array of named, predefined sets of projected fields to be returned.
2524
2492
  *
2525
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2526
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2527
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2528
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2529
- * - `FULL`: Returns all fields.
2530
- *
2531
2493
  * Default: `PUBLIC`.
2532
2494
  */
2533
2495
  fieldsets?: Set$1[];
@@ -2567,12 +2529,14 @@ interface Sorting$1 {
2567
2529
  /**
2568
2530
  * Sort order.
2569
2531
  *
2570
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
2532
+ * Defaults to `ASC`.
2571
2533
  */
2572
2534
  order?: SortOrder$1;
2573
2535
  }
2574
2536
  declare enum SortOrder$1 {
2537
+ /** Soer by ascending order. */
2575
2538
  ASC = "ASC",
2539
+ /** Sort by descending order. */
2576
2540
  DESC = "DESC"
2577
2541
  }
2578
2542
  interface Paging$1 {
@@ -2619,12 +2583,6 @@ interface ListReservationLocationsRequest$1 {
2619
2583
  /**
2620
2584
  * Array of named, predefined sets of projected fields to be returned.
2621
2585
  *
2622
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2623
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2624
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2625
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2626
- * - `FULL`: Returns all fields.
2627
- *
2628
2586
  * Default: `PUBLIC`.
2629
2587
  */
2630
2588
  fieldsets?: Set$1[];
@@ -3263,18 +3221,19 @@ interface GetReservationLocationRequest {
3263
3221
  /**
3264
3222
  * Array of named, predefined sets of projected fields to be returned.
3265
3223
  *
3266
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3267
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3268
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3269
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3270
- * - `FULL`: Returns all fields.
3271
- *
3272
3224
  * Default: `PUBLIC`.
3273
3225
  */
3274
3226
  fieldsets?: Set[];
3275
3227
  }
3276
3228
  declare enum Set {
3229
+ /**
3230
+ * Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3231
+ * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3232
+ * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3233
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3234
+ */
3277
3235
  PUBLIC = "PUBLIC",
3236
+ /** - `FULL`: Returns all fields. */
3278
3237
  FULL = "FULL"
3279
3238
  }
3280
3239
  interface GetReservationLocationResponse {
@@ -3307,12 +3266,6 @@ interface QueryReservationLocationsRequest {
3307
3266
  /**
3308
3267
  * Array of named, predefined sets of projected fields to be returned.
3309
3268
  *
3310
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3311
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3312
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3313
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3314
- * - `FULL`: Returns all fields.
3315
- *
3316
3269
  * Default: `PUBLIC`.
3317
3270
  */
3318
3271
  fieldsets?: Set[];
@@ -3352,12 +3305,14 @@ interface Sorting {
3352
3305
  /**
3353
3306
  * Sort order.
3354
3307
  *
3355
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
3308
+ * Defaults to `ASC`.
3356
3309
  */
3357
3310
  order?: SortOrder;
3358
3311
  }
3359
3312
  declare enum SortOrder {
3313
+ /** Soer by ascending order. */
3360
3314
  ASC = "ASC",
3315
+ /** Sort by descending order. */
3361
3316
  DESC = "DESC"
3362
3317
  }
3363
3318
  interface Paging {
@@ -3404,12 +3359,6 @@ interface ListReservationLocationsRequest {
3404
3359
  /**
3405
3360
  * Array of named, predefined sets of projected fields to be returned.
3406
3361
  *
3407
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3408
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3409
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3410
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3411
- * - `FULL`: Returns all fields.
3412
- *
3413
3362
  * Default: `PUBLIC`.
3414
3363
  */
3415
3364
  fieldsets?: Set[];
@@ -3618,20 +3567,17 @@ interface TimeSlot$1 {
3618
3567
  startDate?: Date | null;
3619
3568
  /** Duration in minutes of this time slot. */
3620
3569
  duration?: number;
3621
- /**
3622
- * Availability status of this time slot.
3623
- *
3624
- * * `AVAILABLE`: The restaurant can accommodate a party of the specified size in this time slot.
3625
- * * `UNAVAILABLE`: The restaurant can't accommodate a party of the specified size in this time slot.
3626
- * * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
3627
- */
3570
+ /** Availability status of this time slot. */
3628
3571
  status?: Status$1;
3629
3572
  /** Whether manual approval is required to make a reservation in this time slot. */
3630
3573
  manualApproval?: boolean | null;
3631
3574
  }
3632
3575
  declare enum Status$1 {
3576
+ /** The restaurant can accommodate a party of the given size in this time slot. */
3633
3577
  AVAILABLE = "AVAILABLE",
3578
+ /** The restaurant can't accommodate a party of the given size in this time slot. */
3634
3579
  UNAVAILABLE = "UNAVAILABLE",
3580
+ /** The restaurant is not open during this time slot. */
3635
3581
  NON_WORKING_HOURS = "NON_WORKING_HOURS"
3636
3582
  }
3637
3583
  interface GetTimeSlotsRequest$1 {
@@ -3661,15 +3607,23 @@ interface GetTimeSlotsResponse$1 {
3661
3607
  timeSlots?: TimeSlot$1[];
3662
3608
  }
3663
3609
  declare enum TableCombinationConflictType$1 {
3610
+ /** Undefined conflict type. */
3664
3611
  UNKNOWN = "UNKNOWN",
3612
+ /** One or more of the chosen tables are already reserved. */
3665
3613
  RESERVED = "RESERVED",
3614
+ /** The party is too big for the selected table. */
3666
3615
  TOO_BIG = "TOO_BIG",
3616
+ /** The party is too small for the selected table. */
3667
3617
  TOO_SMALL = "TOO_SMALL",
3618
+ /** The restaurant does not allow online reservations. */
3668
3619
  OFFLINE_ONLY = "OFFLINE_ONLY"
3669
3620
  }
3670
3621
  declare enum Type$1 {
3622
+ /** Undefined reservation location conflict type. */
3671
3623
  UNKNOWN = "UNKNOWN",
3624
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
3672
3625
  PARTY_PACING = "PARTY_PACING",
3626
+ /** The required number of seats are unavailable according to seat pacing settings. */
3673
3627
  SEAT_PACING = "SEAT_PACING"
3674
3628
  }
3675
3629
  interface CheckTimeSlotRequest$1 {
@@ -3729,20 +3683,17 @@ interface TimeSlot {
3729
3683
  startDate?: Date | null;
3730
3684
  /** Duration in minutes of this time slot. */
3731
3685
  duration?: number;
3732
- /**
3733
- * Availability status of this time slot.
3734
- *
3735
- * * `AVAILABLE`: The restaurant can accommodate a party of the specified size in this time slot.
3736
- * * `UNAVAILABLE`: The restaurant can't accommodate a party of the specified size in this time slot.
3737
- * * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
3738
- */
3686
+ /** Availability status of this time slot. */
3739
3687
  status?: Status;
3740
3688
  /** Whether manual approval is required to make a reservation in this time slot. */
3741
3689
  manualApproval?: boolean | null;
3742
3690
  }
3743
3691
  declare enum Status {
3692
+ /** The restaurant can accommodate a party of the given size in this time slot. */
3744
3693
  AVAILABLE = "AVAILABLE",
3694
+ /** The restaurant can't accommodate a party of the given size in this time slot. */
3745
3695
  UNAVAILABLE = "UNAVAILABLE",
3696
+ /** The restaurant is not open during this time slot. */
3746
3697
  NON_WORKING_HOURS = "NON_WORKING_HOURS"
3747
3698
  }
3748
3699
  interface GetTimeSlotsRequest {
@@ -3772,15 +3723,23 @@ interface GetTimeSlotsResponse {
3772
3723
  timeSlots?: TimeSlot[];
3773
3724
  }
3774
3725
  declare enum TableCombinationConflictType {
3726
+ /** Undefined conflict type. */
3775
3727
  UNKNOWN = "UNKNOWN",
3728
+ /** One or more of the chosen tables are already reserved. */
3776
3729
  RESERVED = "RESERVED",
3730
+ /** The party is too big for the selected table. */
3777
3731
  TOO_BIG = "TOO_BIG",
3732
+ /** The party is too small for the selected table. */
3778
3733
  TOO_SMALL = "TOO_SMALL",
3734
+ /** The restaurant does not allow online reservations. */
3779
3735
  OFFLINE_ONLY = "OFFLINE_ONLY"
3780
3736
  }
3781
3737
  declare enum Type {
3738
+ /** Undefined reservation location conflict type. */
3782
3739
  UNKNOWN = "UNKNOWN",
3740
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
3783
3741
  PARTY_PACING = "PARTY_PACING",
3742
+ /** The required number of seats are unavailable according to seat pacing settings. */
3784
3743
  SEAT_PACING = "SEAT_PACING"
3785
3744
  }
3786
3745
  interface CheckTimeSlotRequest {