@wix/table-reservations 1.0.163 → 1.0.164
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/table-reservations",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.164",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"@wix/table-reservations_reservation-locations": "1.0.71",
|
|
25
|
-
"@wix/table-reservations_reservations": "1.0.
|
|
26
|
-
"@wix/table-reservations_time-slots": "1.0.
|
|
25
|
+
"@wix/table-reservations_reservations": "1.0.58",
|
|
26
|
+
"@wix/table-reservations_time-slots": "1.0.51"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"glob": "^10.4.1",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": ""
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "6ccaf7b87e6159eddcd7d657e94640771a6e9b1aa1179da80e88eb33"
|
|
52
52
|
}
|
|
@@ -544,7 +544,7 @@ interface Reservation {
|
|
|
544
544
|
_updatedDate?: Date | null;
|
|
545
545
|
/**
|
|
546
546
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
547
|
-
* To prevent conflicting changes, the current revision must be
|
|
547
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
548
548
|
*
|
|
549
549
|
* Ignored when creating a reservation.
|
|
550
550
|
* @readonly
|
|
@@ -564,9 +564,9 @@ interface Reservation {
|
|
|
564
564
|
*/
|
|
565
565
|
extendedFields?: ExtendedFields$1;
|
|
566
566
|
}
|
|
567
|
-
/** Tables used for the reservation. If you don't
|
|
567
|
+
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
568
568
|
interface Tables {
|
|
569
|
-
/** IDs of tables used for this reservation. If you don't
|
|
569
|
+
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
570
570
|
ids?: string[];
|
|
571
571
|
}
|
|
572
572
|
declare enum Status$1 {
|
|
@@ -734,7 +734,7 @@ interface CreateReservationRequest {
|
|
|
734
734
|
/** Reservation details. */
|
|
735
735
|
reservation: Reservation;
|
|
736
736
|
/**
|
|
737
|
-
* Ignore table combination conflicts of the types
|
|
737
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
738
738
|
*
|
|
739
739
|
* Possible values:
|
|
740
740
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -744,7 +744,7 @@ interface CreateReservationRequest {
|
|
|
744
744
|
*/
|
|
745
745
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
746
746
|
/**
|
|
747
|
-
* Ignored reservation location conflicts of the types
|
|
747
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
748
748
|
*
|
|
749
749
|
* Possible values:
|
|
750
750
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -806,7 +806,7 @@ interface UpdateReservationRequest {
|
|
|
806
806
|
/** Reservation information to update. */
|
|
807
807
|
reservation: Reservation;
|
|
808
808
|
/**
|
|
809
|
-
* Ignore table combination conflicts of the types
|
|
809
|
+
* 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.
|
|
810
810
|
*
|
|
811
811
|
* Possible values:
|
|
812
812
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -816,7 +816,7 @@ interface UpdateReservationRequest {
|
|
|
816
816
|
*/
|
|
817
817
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
818
818
|
/**
|
|
819
|
-
* Ignored reservation location conflicts of the types
|
|
819
|
+
* 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.
|
|
820
820
|
*
|
|
821
821
|
* Possible values:
|
|
822
822
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -865,7 +865,7 @@ interface ReserveReservationRequest {
|
|
|
865
865
|
/**
|
|
866
866
|
* Revision number.
|
|
867
867
|
*
|
|
868
|
-
*
|
|
868
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
869
869
|
*/
|
|
870
870
|
revision: string | null;
|
|
871
871
|
}
|
|
@@ -879,7 +879,7 @@ interface CancelReservationRequest {
|
|
|
879
879
|
/**
|
|
880
880
|
* Revision number.
|
|
881
881
|
*
|
|
882
|
-
*
|
|
882
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
883
883
|
*/
|
|
884
884
|
revision: string | null;
|
|
885
885
|
/**
|
|
@@ -1726,7 +1726,7 @@ interface ReservationDeletedEnvelope {
|
|
|
1726
1726
|
}
|
|
1727
1727
|
interface CreateReservationOptions {
|
|
1728
1728
|
/**
|
|
1729
|
-
* Ignore table combination conflicts of the types
|
|
1729
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1730
1730
|
*
|
|
1731
1731
|
* Possible values:
|
|
1732
1732
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1736,7 +1736,7 @@ interface CreateReservationOptions {
|
|
|
1736
1736
|
*/
|
|
1737
1737
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
1738
1738
|
/**
|
|
1739
|
-
* Ignored reservation location conflicts of the types
|
|
1739
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1740
1740
|
*
|
|
1741
1741
|
* Possible values:
|
|
1742
1742
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -1809,7 +1809,7 @@ interface UpdateReservation {
|
|
|
1809
1809
|
_updatedDate?: Date | null;
|
|
1810
1810
|
/**
|
|
1811
1811
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
1812
|
-
* To prevent conflicting changes, the current revision must be
|
|
1812
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
1813
1813
|
*
|
|
1814
1814
|
* Ignored when creating a reservation.
|
|
1815
1815
|
* @readonly
|
|
@@ -1831,7 +1831,7 @@ interface UpdateReservation {
|
|
|
1831
1831
|
}
|
|
1832
1832
|
interface UpdateReservationOptions {
|
|
1833
1833
|
/**
|
|
1834
|
-
* Ignore table combination conflicts of the types
|
|
1834
|
+
* 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.
|
|
1835
1835
|
*
|
|
1836
1836
|
* Possible values:
|
|
1837
1837
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1841,7 +1841,7 @@ interface UpdateReservationOptions {
|
|
|
1841
1841
|
*/
|
|
1842
1842
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
1843
1843
|
/**
|
|
1844
|
-
* Ignored reservation location conflicts of the types
|
|
1844
|
+
* 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.
|
|
1845
1845
|
*
|
|
1846
1846
|
* Possible values:
|
|
1847
1847
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -2048,7 +2048,7 @@ interface ReserveReservationSignature {
|
|
|
2048
2048
|
* @param - Reservee details.
|
|
2049
2049
|
* @param - Revision number.
|
|
2050
2050
|
*
|
|
2051
|
-
*
|
|
2051
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
2052
2052
|
*/
|
|
2053
2053
|
(reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
|
|
2054
2054
|
}
|
|
@@ -2061,7 +2061,7 @@ interface CancelReservationSignature {
|
|
|
2061
2061
|
* @param - Reservation ID.
|
|
2062
2062
|
* @param - Revision number.
|
|
2063
2063
|
*
|
|
2064
|
-
*
|
|
2064
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
2065
2065
|
* @param - Options for canceling the reservation.
|
|
2066
2066
|
*/
|
|
2067
2067
|
(reservationId: string, revision: string | null, options?: CancelReservationOptions | undefined): Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
|
|
@@ -2106,9 +2106,9 @@ interface QueryReservationsSignature {
|
|
|
2106
2106
|
declare function searchReservations$1(httpClient: HttpClient): SearchReservationsSignature;
|
|
2107
2107
|
interface SearchReservationsSignature {
|
|
2108
2108
|
/**
|
|
2109
|
-
* Use this
|
|
2109
|
+
* Use this method to search the fields of the table reservations on a site for a given expression.
|
|
2110
2110
|
*
|
|
2111
|
-
* You can also use this
|
|
2111
|
+
* You can also use this method to perform data aggregations on a site's table reservation fields.
|
|
2112
2112
|
* For a detailed list of supported operations, see the [Sorting, Filtering, and Search](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
2113
2113
|
* @param - Search query.
|
|
2114
2114
|
*/
|
|
@@ -5203,8 +5203,8 @@ interface TimeSlot {
|
|
|
5203
5203
|
/**
|
|
5204
5204
|
* Availability status of this time slot.
|
|
5205
5205
|
*
|
|
5206
|
-
* * `AVAILABLE`: The restaurant can accommodate a party of the
|
|
5207
|
-
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the
|
|
5206
|
+
* * `AVAILABLE`: The restaurant can accommodate a party of the specified size in this time slot.
|
|
5207
|
+
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the specified size in this time slot.
|
|
5208
5208
|
* * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
|
|
5209
5209
|
*/
|
|
5210
5210
|
status?: Status;
|
|
@@ -5238,13 +5238,13 @@ interface GetTimeSlotsRequest {
|
|
|
5238
5238
|
* Min: `1`
|
|
5239
5239
|
*/
|
|
5240
5240
|
partySize: number | null;
|
|
5241
|
-
/** The number of time slots to retrieve before the
|
|
5241
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
5242
5242
|
slotsBefore?: number | null;
|
|
5243
|
-
/** The number of time slots to retrieve after the
|
|
5243
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
5244
5244
|
slotsAfter?: number | null;
|
|
5245
5245
|
}
|
|
5246
5246
|
interface GetTimeSlotsResponse {
|
|
5247
|
-
/** A list of time slots and their availability according to the
|
|
5247
|
+
/** A list of time slots and their availability according to the specified party size. */
|
|
5248
5248
|
timeSlots?: TimeSlot[];
|
|
5249
5249
|
}
|
|
5250
5250
|
interface CheckReservationDetailsRequest {
|
|
@@ -5346,7 +5346,7 @@ interface CheckTimeSlotRequest {
|
|
|
5346
5346
|
interface CheckTimeSlotResponse {
|
|
5347
5347
|
/** Table combinations and their availability information. */
|
|
5348
5348
|
tableCombinationAvailabilities?: TableCombinationAvailability[];
|
|
5349
|
-
/** Reservation location conflicts that would occur by making a reservation for the
|
|
5349
|
+
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
5350
5350
|
reservationLocationConflicts?: Type[];
|
|
5351
5351
|
}
|
|
5352
5352
|
interface TableCombinationAvailability {
|
|
@@ -5381,9 +5381,9 @@ interface GetTimeSlotsOptions {
|
|
|
5381
5381
|
* Min: `5`
|
|
5382
5382
|
*/
|
|
5383
5383
|
duration?: number | null;
|
|
5384
|
-
/** The number of time slots to retrieve before the
|
|
5384
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
5385
5385
|
slotsBefore?: number | null;
|
|
5386
|
-
/** The number of time slots to retrieve after the
|
|
5386
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
5387
5387
|
slotsAfter?: number | null;
|
|
5388
5388
|
}
|
|
5389
5389
|
interface CheckTimeSlotOptions {
|
|
@@ -5408,13 +5408,13 @@ interface CheckTimeSlotOptions {
|
|
|
5408
5408
|
declare function getTimeSlots$1(httpClient: HttpClient): GetTimeSlotsSignature;
|
|
5409
5409
|
interface GetTimeSlotsSignature {
|
|
5410
5410
|
/**
|
|
5411
|
-
* Returns a list of time slots at a
|
|
5411
|
+
* Returns a list of time slots at a specified reservation location on a specified `date`, and their availability for a specified `partySize`.
|
|
5412
5412
|
*
|
|
5413
|
-
* Without passing optional parameters, the list will contain a single time slot at the
|
|
5414
|
-
* Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the
|
|
5413
|
+
* Without passing optional parameters, the list will contain a single time slot at the specified `date`.
|
|
5414
|
+
* Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the specified `date`.
|
|
5415
5415
|
*
|
|
5416
5416
|
* If you do not provide a `duration`, the duration will be calculated automatically based on the reservation location's configuration.
|
|
5417
|
-
* The reservation location's settings used to determine the duration are its `defaultTurnoverTime` and `turnoverTimeRules`. These specify how much time should be allotted for a reservation of a party of a
|
|
5417
|
+
* The reservation location's settings used to determine the duration are its `defaultTurnoverTime` and `turnoverTimeRules`. These specify how much time should be allotted for a reservation of a party of a specified size.
|
|
5418
5418
|
*
|
|
5419
5419
|
* The interval between `startDate`s of time slots in the response is determined by the reservation location's `timeSlotInterval`. This interval is not affected by the `duration` provided.
|
|
5420
5420
|
* @param - ID of the reservation location for which to retrieve time slots.
|
|
@@ -544,7 +544,7 @@ interface Reservation {
|
|
|
544
544
|
_updatedDate?: Date | null;
|
|
545
545
|
/**
|
|
546
546
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
547
|
-
* To prevent conflicting changes, the current revision must be
|
|
547
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
548
548
|
*
|
|
549
549
|
* Ignored when creating a reservation.
|
|
550
550
|
* @readonly
|
|
@@ -564,9 +564,9 @@ interface Reservation {
|
|
|
564
564
|
*/
|
|
565
565
|
extendedFields?: ExtendedFields$1;
|
|
566
566
|
}
|
|
567
|
-
/** Tables used for the reservation. If you don't
|
|
567
|
+
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
568
568
|
interface Tables {
|
|
569
|
-
/** IDs of tables used for this reservation. If you don't
|
|
569
|
+
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
570
570
|
ids?: string[];
|
|
571
571
|
}
|
|
572
572
|
declare enum Status$1 {
|
|
@@ -734,7 +734,7 @@ interface CreateReservationRequest {
|
|
|
734
734
|
/** Reservation details. */
|
|
735
735
|
reservation: Reservation;
|
|
736
736
|
/**
|
|
737
|
-
* Ignore table combination conflicts of the types
|
|
737
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
738
738
|
*
|
|
739
739
|
* Possible values:
|
|
740
740
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -744,7 +744,7 @@ interface CreateReservationRequest {
|
|
|
744
744
|
*/
|
|
745
745
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
746
746
|
/**
|
|
747
|
-
* Ignored reservation location conflicts of the types
|
|
747
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
748
748
|
*
|
|
749
749
|
* Possible values:
|
|
750
750
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -806,7 +806,7 @@ interface UpdateReservationRequest {
|
|
|
806
806
|
/** Reservation information to update. */
|
|
807
807
|
reservation: Reservation;
|
|
808
808
|
/**
|
|
809
|
-
* Ignore table combination conflicts of the types
|
|
809
|
+
* 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.
|
|
810
810
|
*
|
|
811
811
|
* Possible values:
|
|
812
812
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -816,7 +816,7 @@ interface UpdateReservationRequest {
|
|
|
816
816
|
*/
|
|
817
817
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
818
818
|
/**
|
|
819
|
-
* Ignored reservation location conflicts of the types
|
|
819
|
+
* 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.
|
|
820
820
|
*
|
|
821
821
|
* Possible values:
|
|
822
822
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -865,7 +865,7 @@ interface ReserveReservationRequest {
|
|
|
865
865
|
/**
|
|
866
866
|
* Revision number.
|
|
867
867
|
*
|
|
868
|
-
*
|
|
868
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
869
869
|
*/
|
|
870
870
|
revision: string | null;
|
|
871
871
|
}
|
|
@@ -879,7 +879,7 @@ interface CancelReservationRequest {
|
|
|
879
879
|
/**
|
|
880
880
|
* Revision number.
|
|
881
881
|
*
|
|
882
|
-
*
|
|
882
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
883
883
|
*/
|
|
884
884
|
revision: string | null;
|
|
885
885
|
/**
|
|
@@ -1726,7 +1726,7 @@ interface ReservationDeletedEnvelope {
|
|
|
1726
1726
|
}
|
|
1727
1727
|
interface CreateReservationOptions {
|
|
1728
1728
|
/**
|
|
1729
|
-
* Ignore table combination conflicts of the types
|
|
1729
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1730
1730
|
*
|
|
1731
1731
|
* Possible values:
|
|
1732
1732
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1736,7 +1736,7 @@ interface CreateReservationOptions {
|
|
|
1736
1736
|
*/
|
|
1737
1737
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
1738
1738
|
/**
|
|
1739
|
-
* Ignored reservation location conflicts of the types
|
|
1739
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1740
1740
|
*
|
|
1741
1741
|
* Possible values:
|
|
1742
1742
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -1809,7 +1809,7 @@ interface UpdateReservation {
|
|
|
1809
1809
|
_updatedDate?: Date | null;
|
|
1810
1810
|
/**
|
|
1811
1811
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
1812
|
-
* To prevent conflicting changes, the current revision must be
|
|
1812
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
1813
1813
|
*
|
|
1814
1814
|
* Ignored when creating a reservation.
|
|
1815
1815
|
* @readonly
|
|
@@ -1831,7 +1831,7 @@ interface UpdateReservation {
|
|
|
1831
1831
|
}
|
|
1832
1832
|
interface UpdateReservationOptions {
|
|
1833
1833
|
/**
|
|
1834
|
-
* Ignore table combination conflicts of the types
|
|
1834
|
+
* 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.
|
|
1835
1835
|
*
|
|
1836
1836
|
* Possible values:
|
|
1837
1837
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1841,7 +1841,7 @@ interface UpdateReservationOptions {
|
|
|
1841
1841
|
*/
|
|
1842
1842
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
1843
1843
|
/**
|
|
1844
|
-
* Ignored reservation location conflicts of the types
|
|
1844
|
+
* 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.
|
|
1845
1845
|
*
|
|
1846
1846
|
* Possible values:
|
|
1847
1847
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -2048,7 +2048,7 @@ interface ReserveReservationSignature {
|
|
|
2048
2048
|
* @param - Reservee details.
|
|
2049
2049
|
* @param - Revision number.
|
|
2050
2050
|
*
|
|
2051
|
-
*
|
|
2051
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
2052
2052
|
*/
|
|
2053
2053
|
(reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
|
|
2054
2054
|
}
|
|
@@ -2061,7 +2061,7 @@ interface CancelReservationSignature {
|
|
|
2061
2061
|
* @param - Reservation ID.
|
|
2062
2062
|
* @param - Revision number.
|
|
2063
2063
|
*
|
|
2064
|
-
*
|
|
2064
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
2065
2065
|
* @param - Options for canceling the reservation.
|
|
2066
2066
|
*/
|
|
2067
2067
|
(reservationId: string, revision: string | null, options?: CancelReservationOptions | undefined): Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
|
|
@@ -2106,9 +2106,9 @@ interface QueryReservationsSignature {
|
|
|
2106
2106
|
declare function searchReservations$1(httpClient: HttpClient): SearchReservationsSignature;
|
|
2107
2107
|
interface SearchReservationsSignature {
|
|
2108
2108
|
/**
|
|
2109
|
-
* Use this
|
|
2109
|
+
* Use this method to search the fields of the table reservations on a site for a given expression.
|
|
2110
2110
|
*
|
|
2111
|
-
* You can also use this
|
|
2111
|
+
* You can also use this method to perform data aggregations on a site's table reservation fields.
|
|
2112
2112
|
* For a detailed list of supported operations, see the [Sorting, Filtering, and Search](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
2113
2113
|
* @param - Search query.
|
|
2114
2114
|
*/
|
|
@@ -5203,8 +5203,8 @@ interface TimeSlot {
|
|
|
5203
5203
|
/**
|
|
5204
5204
|
* Availability status of this time slot.
|
|
5205
5205
|
*
|
|
5206
|
-
* * `AVAILABLE`: The restaurant can accommodate a party of the
|
|
5207
|
-
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the
|
|
5206
|
+
* * `AVAILABLE`: The restaurant can accommodate a party of the specified size in this time slot.
|
|
5207
|
+
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the specified size in this time slot.
|
|
5208
5208
|
* * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
|
|
5209
5209
|
*/
|
|
5210
5210
|
status?: Status;
|
|
@@ -5238,13 +5238,13 @@ interface GetTimeSlotsRequest {
|
|
|
5238
5238
|
* Min: `1`
|
|
5239
5239
|
*/
|
|
5240
5240
|
partySize: number | null;
|
|
5241
|
-
/** The number of time slots to retrieve before the
|
|
5241
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
5242
5242
|
slotsBefore?: number | null;
|
|
5243
|
-
/** The number of time slots to retrieve after the
|
|
5243
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
5244
5244
|
slotsAfter?: number | null;
|
|
5245
5245
|
}
|
|
5246
5246
|
interface GetTimeSlotsResponse {
|
|
5247
|
-
/** A list of time slots and their availability according to the
|
|
5247
|
+
/** A list of time slots and their availability according to the specified party size. */
|
|
5248
5248
|
timeSlots?: TimeSlot[];
|
|
5249
5249
|
}
|
|
5250
5250
|
interface CheckReservationDetailsRequest {
|
|
@@ -5346,7 +5346,7 @@ interface CheckTimeSlotRequest {
|
|
|
5346
5346
|
interface CheckTimeSlotResponse {
|
|
5347
5347
|
/** Table combinations and their availability information. */
|
|
5348
5348
|
tableCombinationAvailabilities?: TableCombinationAvailability[];
|
|
5349
|
-
/** Reservation location conflicts that would occur by making a reservation for the
|
|
5349
|
+
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
5350
5350
|
reservationLocationConflicts?: Type[];
|
|
5351
5351
|
}
|
|
5352
5352
|
interface TableCombinationAvailability {
|
|
@@ -5381,9 +5381,9 @@ interface GetTimeSlotsOptions {
|
|
|
5381
5381
|
* Min: `5`
|
|
5382
5382
|
*/
|
|
5383
5383
|
duration?: number | null;
|
|
5384
|
-
/** The number of time slots to retrieve before the
|
|
5384
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
5385
5385
|
slotsBefore?: number | null;
|
|
5386
|
-
/** The number of time slots to retrieve after the
|
|
5386
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
5387
5387
|
slotsAfter?: number | null;
|
|
5388
5388
|
}
|
|
5389
5389
|
interface CheckTimeSlotOptions {
|
|
@@ -5408,13 +5408,13 @@ interface CheckTimeSlotOptions {
|
|
|
5408
5408
|
declare function getTimeSlots$1(httpClient: HttpClient): GetTimeSlotsSignature;
|
|
5409
5409
|
interface GetTimeSlotsSignature {
|
|
5410
5410
|
/**
|
|
5411
|
-
* Returns a list of time slots at a
|
|
5411
|
+
* Returns a list of time slots at a specified reservation location on a specified `date`, and their availability for a specified `partySize`.
|
|
5412
5412
|
*
|
|
5413
|
-
* Without passing optional parameters, the list will contain a single time slot at the
|
|
5414
|
-
* Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the
|
|
5413
|
+
* Without passing optional parameters, the list will contain a single time slot at the specified `date`.
|
|
5414
|
+
* Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the specified `date`.
|
|
5415
5415
|
*
|
|
5416
5416
|
* If you do not provide a `duration`, the duration will be calculated automatically based on the reservation location's configuration.
|
|
5417
|
-
* The reservation location's settings used to determine the duration are its `defaultTurnoverTime` and `turnoverTimeRules`. These specify how much time should be allotted for a reservation of a party of a
|
|
5417
|
+
* The reservation location's settings used to determine the duration are its `defaultTurnoverTime` and `turnoverTimeRules`. These specify how much time should be allotted for a reservation of a party of a specified size.
|
|
5418
5418
|
*
|
|
5419
5419
|
* The interval between `startDate`s of time slots in the response is determined by the reservation location's `timeSlotInterval`. This interval is not affected by the `duration` provided.
|
|
5420
5420
|
* @param - ID of the reservation location for which to retrieve time slots.
|
|
@@ -16,9 +16,9 @@ interface Reservation$1 {
|
|
|
16
16
|
* * `CANCELED`: The reservation is canceled.
|
|
17
17
|
* * `NO_SHOW`: The customer didn't show up for their reservation.
|
|
18
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 reserve reservation
|
|
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
20
|
*
|
|
21
|
-
* See the
|
|
21
|
+
* 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
22
|
*/
|
|
23
23
|
status?: Status$3;
|
|
24
24
|
/**
|
|
@@ -64,7 +64,7 @@ interface Reservation$1 {
|
|
|
64
64
|
updatedDate?: Date | null;
|
|
65
65
|
/**
|
|
66
66
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
67
|
-
* To prevent conflicting changes, the current revision must be
|
|
67
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
68
68
|
*
|
|
69
69
|
* Ignored when creating a reservation.
|
|
70
70
|
* @readonly
|
|
@@ -84,9 +84,9 @@ interface Reservation$1 {
|
|
|
84
84
|
*/
|
|
85
85
|
extendedFields?: ExtendedFields$3;
|
|
86
86
|
}
|
|
87
|
-
/** Tables used for the reservation. If you don't
|
|
87
|
+
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
88
88
|
interface Tables$1 {
|
|
89
|
-
/** IDs of tables used for this reservation. If you don't
|
|
89
|
+
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
90
90
|
ids?: string[];
|
|
91
91
|
}
|
|
92
92
|
declare enum Status$3 {
|
|
@@ -213,7 +213,7 @@ interface CreateReservationRequest$1 {
|
|
|
213
213
|
/** Reservation details. */
|
|
214
214
|
reservation: Reservation$1;
|
|
215
215
|
/**
|
|
216
|
-
* Ignore table combination conflicts of the types
|
|
216
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
217
217
|
*
|
|
218
218
|
* Possible values:
|
|
219
219
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -223,7 +223,7 @@ interface CreateReservationRequest$1 {
|
|
|
223
223
|
*/
|
|
224
224
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$3[];
|
|
225
225
|
/**
|
|
226
|
-
* Ignored reservation location conflicts of the types
|
|
226
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
227
227
|
*
|
|
228
228
|
* Possible values:
|
|
229
229
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -273,7 +273,7 @@ interface UpdateReservationRequest$1 {
|
|
|
273
273
|
/** Reservation information to update. */
|
|
274
274
|
reservation: Reservation$1;
|
|
275
275
|
/**
|
|
276
|
-
* Ignore table combination conflicts of the types
|
|
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
277
|
*
|
|
278
278
|
* Possible values:
|
|
279
279
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -283,7 +283,7 @@ interface UpdateReservationRequest$1 {
|
|
|
283
283
|
*/
|
|
284
284
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$3[];
|
|
285
285
|
/**
|
|
286
|
-
* Ignored reservation location conflicts of the types
|
|
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
287
|
*
|
|
288
288
|
* Possible values:
|
|
289
289
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -332,7 +332,7 @@ interface ReserveReservationRequest$1 {
|
|
|
332
332
|
/**
|
|
333
333
|
* Revision number.
|
|
334
334
|
*
|
|
335
|
-
*
|
|
335
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
336
336
|
*/
|
|
337
337
|
revision: string | null;
|
|
338
338
|
}
|
|
@@ -346,7 +346,7 @@ interface CancelReservationRequest$1 {
|
|
|
346
346
|
/**
|
|
347
347
|
* Revision number.
|
|
348
348
|
*
|
|
349
|
-
*
|
|
349
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
350
350
|
*/
|
|
351
351
|
revision: string | null;
|
|
352
352
|
/**
|
|
@@ -1050,7 +1050,7 @@ interface Reservation {
|
|
|
1050
1050
|
_updatedDate?: Date | null;
|
|
1051
1051
|
/**
|
|
1052
1052
|
* Revision number, which increments by 1 each time the reservation is updated.
|
|
1053
|
-
* To prevent conflicting changes, the current revision must be
|
|
1053
|
+
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
1054
1054
|
*
|
|
1055
1055
|
* Ignored when creating a reservation.
|
|
1056
1056
|
* @readonly
|
|
@@ -1070,9 +1070,9 @@ interface Reservation {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
extendedFields?: ExtendedFields$2;
|
|
1072
1072
|
}
|
|
1073
|
-
/** Tables used for the reservation. If you don't
|
|
1073
|
+
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
1074
1074
|
interface Tables {
|
|
1075
|
-
/** IDs of tables used for this reservation. If you don't
|
|
1075
|
+
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
1076
1076
|
ids?: string[];
|
|
1077
1077
|
}
|
|
1078
1078
|
declare enum Status$2 {
|
|
@@ -1199,7 +1199,7 @@ interface CreateReservationRequest {
|
|
|
1199
1199
|
/** Reservation details. */
|
|
1200
1200
|
reservation: Reservation;
|
|
1201
1201
|
/**
|
|
1202
|
-
* Ignore table combination conflicts of the types
|
|
1202
|
+
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1203
1203
|
*
|
|
1204
1204
|
* Possible values:
|
|
1205
1205
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1209,7 +1209,7 @@ interface CreateReservationRequest {
|
|
|
1209
1209
|
*/
|
|
1210
1210
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$2[];
|
|
1211
1211
|
/**
|
|
1212
|
-
* Ignored reservation location conflicts of the types
|
|
1212
|
+
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1213
1213
|
*
|
|
1214
1214
|
* Possible values:
|
|
1215
1215
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -1257,7 +1257,7 @@ interface UpdateReservationRequest {
|
|
|
1257
1257
|
/** Reservation information to update. */
|
|
1258
1258
|
reservation: Reservation;
|
|
1259
1259
|
/**
|
|
1260
|
-
* Ignore table combination conflicts of the types
|
|
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
1261
|
*
|
|
1262
1262
|
* Possible values:
|
|
1263
1263
|
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
@@ -1267,7 +1267,7 @@ interface UpdateReservationRequest {
|
|
|
1267
1267
|
*/
|
|
1268
1268
|
ignoreTableCombinationConflicts?: TableCombinationConflictType$2[];
|
|
1269
1269
|
/**
|
|
1270
|
-
* Ignored reservation location conflicts of the types
|
|
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
1271
|
*
|
|
1272
1272
|
* Possible values:
|
|
1273
1273
|
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
@@ -1316,7 +1316,7 @@ interface ReserveReservationRequest {
|
|
|
1316
1316
|
/**
|
|
1317
1317
|
* Revision number.
|
|
1318
1318
|
*
|
|
1319
|
-
*
|
|
1319
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
1320
1320
|
*/
|
|
1321
1321
|
revision: string | null;
|
|
1322
1322
|
}
|
|
@@ -1330,7 +1330,7 @@ interface CancelReservationRequest {
|
|
|
1330
1330
|
/**
|
|
1331
1331
|
* Revision number.
|
|
1332
1332
|
*
|
|
1333
|
-
*
|
|
1333
|
+
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
1334
1334
|
*/
|
|
1335
1335
|
revision: string | null;
|
|
1336
1336
|
/**
|
|
@@ -3621,8 +3621,8 @@ interface TimeSlot$1 {
|
|
|
3621
3621
|
/**
|
|
3622
3622
|
* Availability status of this time slot.
|
|
3623
3623
|
*
|
|
3624
|
-
* * `AVAILABLE`: The restaurant can accommodate a party of the
|
|
3625
|
-
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the
|
|
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
3626
|
* * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
|
|
3627
3627
|
*/
|
|
3628
3628
|
status?: Status$1;
|
|
@@ -3651,13 +3651,13 @@ interface GetTimeSlotsRequest$1 {
|
|
|
3651
3651
|
* Min: `1`
|
|
3652
3652
|
*/
|
|
3653
3653
|
partySize: number | null;
|
|
3654
|
-
/** The number of time slots to retrieve before the
|
|
3654
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
3655
3655
|
slotsBefore?: number | null;
|
|
3656
|
-
/** The number of time slots to retrieve after the
|
|
3656
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
3657
3657
|
slotsAfter?: number | null;
|
|
3658
3658
|
}
|
|
3659
3659
|
interface GetTimeSlotsResponse$1 {
|
|
3660
|
-
/** A list of time slots and their availability according to the
|
|
3660
|
+
/** A list of time slots and their availability according to the specified party size. */
|
|
3661
3661
|
timeSlots?: TimeSlot$1[];
|
|
3662
3662
|
}
|
|
3663
3663
|
declare enum TableCombinationConflictType$1 {
|
|
@@ -3695,7 +3695,7 @@ interface CheckTimeSlotRequest$1 {
|
|
|
3695
3695
|
interface CheckTimeSlotResponse$1 {
|
|
3696
3696
|
/** Table combinations and their availability information. */
|
|
3697
3697
|
tableCombinationAvailabilities?: TableCombinationAvailability$1[];
|
|
3698
|
-
/** Reservation location conflicts that would occur by making a reservation for the
|
|
3698
|
+
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
3699
3699
|
reservationLocationConflicts?: Type$1[];
|
|
3700
3700
|
}
|
|
3701
3701
|
interface TableCombinationAvailability$1 {
|
|
@@ -3732,8 +3732,8 @@ interface TimeSlot {
|
|
|
3732
3732
|
/**
|
|
3733
3733
|
* Availability status of this time slot.
|
|
3734
3734
|
*
|
|
3735
|
-
* * `AVAILABLE`: The restaurant can accommodate a party of the
|
|
3736
|
-
* * `UNAVAILABLE`: The restaurant can't accommodate a party of the
|
|
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
3737
|
* * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
|
|
3738
3738
|
*/
|
|
3739
3739
|
status?: Status;
|
|
@@ -3762,13 +3762,13 @@ interface GetTimeSlotsRequest {
|
|
|
3762
3762
|
* Min: `1`
|
|
3763
3763
|
*/
|
|
3764
3764
|
partySize: number | null;
|
|
3765
|
-
/** The number of time slots to retrieve before the
|
|
3765
|
+
/** The number of time slots to retrieve before the specified `date`. */
|
|
3766
3766
|
slotsBefore?: number | null;
|
|
3767
|
-
/** The number of time slots to retrieve after the
|
|
3767
|
+
/** The number of time slots to retrieve after the specified `date`. */
|
|
3768
3768
|
slotsAfter?: number | null;
|
|
3769
3769
|
}
|
|
3770
3770
|
interface GetTimeSlotsResponse {
|
|
3771
|
-
/** A list of time slots and their availability according to the
|
|
3771
|
+
/** A list of time slots and their availability according to the specified party size. */
|
|
3772
3772
|
timeSlots?: TimeSlot[];
|
|
3773
3773
|
}
|
|
3774
3774
|
declare enum TableCombinationConflictType {
|
|
@@ -3806,7 +3806,7 @@ interface CheckTimeSlotRequest {
|
|
|
3806
3806
|
interface CheckTimeSlotResponse {
|
|
3807
3807
|
/** Table combinations and their availability information. */
|
|
3808
3808
|
tableCombinationAvailabilities?: TableCombinationAvailability[];
|
|
3809
|
-
/** Reservation location conflicts that would occur by making a reservation for the
|
|
3809
|
+
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
3810
3810
|
reservationLocationConflicts?: Type[];
|
|
3811
3811
|
}
|
|
3812
3812
|
interface TableCombinationAvailability {
|