@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.
@@ -505,9 +505,6 @@ interface Reservation {
505
505
  * Reservation source.
506
506
  *
507
507
  * This indicates how the reservation was made.
508
- * * `ONLINE` indicates that the customer made the reservation through a website or app.
509
- * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
510
- * * `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.
511
508
  */
512
509
  source?: Source;
513
510
  /** Reservation details. */
@@ -570,33 +567,35 @@ interface Tables {
570
567
  ids?: string[];
571
568
  }
572
569
  declare enum Status$1 {
570
+ /** Undefined reservation status. */
573
571
  UNKNOWN = "UNKNOWN",
574
- /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
572
+ /** 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. */
575
573
  HELD = "HELD",
576
- /** The reservation has been reserved. */
574
+ /** The reservation is confirmed. */
577
575
  RESERVED = "RESERVED",
578
- /** The reservation has been canceled. */
576
+ /** The reservation is canceled. */
579
577
  CANCELED = "CANCELED",
580
- /** The reservation has finished successfully. */
578
+ /** The reservation completed successfully. */
581
579
  FINISHED = "FINISHED",
582
- /** The reservee didn't arrive. */
580
+ /** The customer didn't show up for their reservation. */
583
581
  NO_SHOW = "NO_SHOW",
584
- /** The reservee occupied the table. */
582
+ /** The customer is currently occupying the table. */
585
583
  SEATED = "SEATED",
586
- /** The reservee requested a reservation and is waiting for manual approval. */
584
+ /** 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. */
587
585
  REQUESTED = "REQUESTED",
588
- /** The owner declined a reservee's request. */
586
+ /** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
589
587
  DECLINED = "DECLINED",
590
- /** 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. */
588
+ /** 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`. */
591
589
  PAYMENT_PENDING = "PAYMENT_PENDING"
592
590
  }
593
591
  declare enum Source {
592
+ /** Undefined reservation source. */
594
593
  UNKNOWN = "UNKNOWN",
595
- /** The reservation is created by a User. */
594
+ /** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
596
595
  OFFLINE = "OFFLINE",
597
- /** The reservation is created by UoU. */
596
+ /** The reservation was made through a website or app. */
598
597
  ONLINE = "ONLINE",
599
- /** The reservation is created by a User. It can be created without reservee data. */
598
+ /** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
600
599
  WALK_IN = "WALK_IN"
601
600
  }
602
601
  /** Reservation details. */
@@ -674,18 +673,19 @@ interface TableWithReservationConflicts {
674
673
  reservationIds?: string[];
675
674
  }
676
675
  declare enum PaymentStatus {
676
+ /** Undefined payment status. */
677
677
  UNKNOWN = "UNKNOWN",
678
678
  /** A reservation is free of charge. */
679
679
  FREE = "FREE",
680
- /** A payment is not received yet. */
680
+ /** Payment is not received yet. */
681
681
  NOT_PAID = "NOT_PAID",
682
- /** A corresponding to reservation order was fully payed. */
682
+ /** The corresponding reservation order was fully paid. */
683
683
  PAID = "PAID",
684
- /** A corresponding to reservation order was refunded, but refund amount is less than order total price. */
684
+ /** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
685
685
  PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
686
- /** A corresponding to reservation order was fully refunded. The refund amount equals total price. */
686
+ /** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
687
687
  FULLY_REFUNDED = "FULLY_REFUNDED",
688
- /** A corresponding to reservation order was partially payed. */
688
+ /** The corresponding reservation order was partially paid. */
689
689
  PARTIALLY_PAID = "PARTIALLY_PAID"
690
690
  }
691
691
  interface ExtendedFields$1 {
@@ -753,15 +753,23 @@ interface CreateReservationRequest {
753
753
  ignoreReservationLocationConflicts?: Type$2[];
754
754
  }
755
755
  declare enum TableCombinationConflictType$1 {
756
+ /** Undefined conflict type. */
756
757
  UNKNOWN = "UNKNOWN",
758
+ /** One or more of the chosen tables are already reserved. */
757
759
  RESERVED = "RESERVED",
760
+ /** The party is too big for the selected table. */
758
761
  TOO_BIG = "TOO_BIG",
762
+ /** The party is too small for the selected table. */
759
763
  TOO_SMALL = "TOO_SMALL",
764
+ /** The restaurant does not allow online reservations. */
760
765
  OFFLINE_ONLY = "OFFLINE_ONLY"
761
766
  }
762
767
  declare enum Type$2 {
768
+ /** Undefined reservation location conflict type. */
763
769
  UNKNOWN = "UNKNOWN",
770
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
764
771
  PARTY_PACING = "PARTY_PACING",
772
+ /** The required number of seats are unavailable according to seat pacing settings. */
765
773
  SEAT_PACING = "SEAT_PACING"
766
774
  }
767
775
  interface CreateReservationResponse {
@@ -795,7 +803,12 @@ interface GetReservationRequest {
795
803
  fieldsets?: Set$1[];
796
804
  }
797
805
  declare enum Set$1 {
806
+ /**
807
+ * Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
808
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
809
+ */
798
810
  PUBLIC = "PUBLIC",
811
+ /** Returns all fields. */
799
812
  FULL = "FULL"
800
813
  }
801
814
  interface GetReservationResponse {
@@ -805,23 +818,8 @@ interface GetReservationResponse {
805
818
  interface UpdateReservationRequest {
806
819
  /** Reservation information to update. */
807
820
  reservation: Reservation;
808
- /**
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
- *
811
- * Possible values:
812
- * * `"RESERVED"`: One or more of the chosen tables are already reserved.
813
- * * `"TOO_BIG"`: The party is too big for the selected table.
814
- * * `"TOO_SMALL"`: The party is too small for the selected table.
815
- * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
816
- */
821
+ /** 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. */
817
822
  ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
818
- /**
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
- *
821
- * Possible values:
822
- * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
823
- * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
824
- */
825
823
  ignoreReservationLocationConflicts?: Type$2[];
826
824
  }
827
825
  interface UpdateReservationResponse {
@@ -914,18 +912,7 @@ interface ListReservationsRequest {
914
912
  startDateFrom?: Date | null;
915
913
  /** Only reservations starting before this date are returned. */
916
914
  startDateTo?: Date | null;
917
- /**
918
- * Only reservations with this status are returned.
919
- *
920
- * * `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.
921
- * * `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.
922
- * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
923
- * * `RESERVED`: The reservation is confirmed.
924
- * * `SEATED`: The customer is currently occupying the table.
925
- * * `CANCELED`: The reservation is canceled.
926
- * * `NO_SHOW`: The customer didn't show up for their reservation.
927
- * * `FINISHED`: The reservation completed successfully.
928
- */
915
+ /** Only reservations with this status are returned. */
929
916
  status?: Status$1;
930
917
  }
931
918
  interface CursorPaging$1 {
@@ -945,13 +932,14 @@ interface Sorting$1 {
945
932
  fieldName?: string;
946
933
  /**
947
934
  * Sort order.
948
- *
949
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
935
+ * Default: `ASC`.
950
936
  */
951
937
  order?: SortOrder$1;
952
938
  }
953
939
  declare enum SortOrder$1 {
940
+ /** Sort by ascending order. */
954
941
  ASC = "ASC",
942
+ /** Sort by descending order. */
955
943
  DESC = "DESC"
956
944
  }
957
945
  interface ListReservationsResponse {
@@ -1112,6 +1100,7 @@ interface IncludeMissingValuesOptions {
1112
1100
  addToBucket?: string;
1113
1101
  }
1114
1102
  declare enum ScalarType {
1103
+ /** Undefined scalar type. */
1115
1104
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1116
1105
  /** Count of distinct values. */
1117
1106
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -1125,14 +1114,15 @@ declare enum ScalarType {
1125
1114
  AVG = "AVG"
1126
1115
  }
1127
1116
  declare enum NestedAggregationType {
1117
+ /** Undefined aggregation type. */
1128
1118
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1129
1119
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1130
1120
  VALUE = "VALUE",
1131
1121
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
1132
1122
  RANGE = "RANGE",
1133
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
1123
+ /** A single-value metric aggregation - such as min, max, sum, and avg. */
1134
1124
  SCALAR = "SCALAR",
1135
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1125
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
1136
1126
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1137
1127
  }
1138
1128
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
@@ -1210,14 +1200,15 @@ interface NestedAggregationItemKindOneOf {
1210
1200
  dateHistogram?: DateHistogramAggregation;
1211
1201
  }
1212
1202
  declare enum AggregationType {
1203
+ /** Undefined aggregation type. */
1213
1204
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1214
1205
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1215
1206
  VALUE = "VALUE",
1216
1207
  /** An aggregation where you can define a set of ranges - each representing a bucket. */
1217
1208
  RANGE = "RANGE",
1218
- /** A single-value metric aggregation - e.g. min, max, sum, avg. */
1209
+ /** A single-value metric aggregation - such as min, max, sum, or avg. */
1219
1210
  SCALAR = "SCALAR",
1220
- /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1211
+ /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
1221
1212
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
1222
1213
  /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
1223
1214
  NESTED = "NESTED"
@@ -1770,9 +1761,6 @@ interface UpdateReservation {
1770
1761
  * Reservation source.
1771
1762
  *
1772
1763
  * This indicates how the reservation was made.
1773
- * * `ONLINE` indicates that the customer made the reservation through a website or app.
1774
- * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
1775
- * * `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.
1776
1764
  */
1777
1765
  source?: Source;
1778
1766
  /** Reservation details. */
@@ -1830,23 +1818,8 @@ interface UpdateReservation {
1830
1818
  extendedFields?: ExtendedFields$1;
1831
1819
  }
1832
1820
  interface UpdateReservationOptions {
1833
- /**
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
- *
1836
- * Possible values:
1837
- * * `"RESERVED"`: One or more of the chosen tables are already reserved.
1838
- * * `"TOO_BIG"`: The party is too big for the selected table.
1839
- * * `"TOO_SMALL"`: The party is too small for the selected table.
1840
- * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
1841
- */
1821
+ /** 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. */
1842
1822
  ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
1843
- /**
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
- *
1846
- * Possible values:
1847
- * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
1848
- * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
1849
- */
1850
1823
  ignoreReservationLocationConflicts?: Type$2[];
1851
1824
  }
1852
1825
  interface UpdateExtendedFieldsOptions$1 {
@@ -1872,18 +1845,7 @@ interface ListReservationsOptions {
1872
1845
  startDateFrom?: Date | null;
1873
1846
  /** Only reservations starting before this date are returned. */
1874
1847
  startDateTo?: Date | null;
1875
- /**
1876
- * Only reservations with this status are returned.
1877
- *
1878
- * * `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.
1879
- * * `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.
1880
- * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
1881
- * * `RESERVED`: The reservation is confirmed.
1882
- * * `SEATED`: The customer is currently occupying the table.
1883
- * * `CANCELED`: The reservation is canceled.
1884
- * * `NO_SHOW`: The customer didn't show up for their reservation.
1885
- * * `FINISHED`: The reservation completed successfully.
1886
- */
1848
+ /** Only reservations with this status are returned. */
1887
1849
  status?: Status$1;
1888
1850
  }
1889
1851
  interface QueryCursorResult$1 {
@@ -2882,18 +2844,19 @@ interface GetReservationLocationRequest {
2882
2844
  /**
2883
2845
  * Array of named, predefined sets of projected fields to be returned.
2884
2846
  *
2885
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2886
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2887
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2888
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2889
- * - `FULL`: Returns all fields.
2890
- *
2891
2847
  * Default: `PUBLIC`.
2892
2848
  */
2893
2849
  fieldsets?: Set[];
2894
2850
  }
2895
2851
  declare enum Set {
2852
+ /**
2853
+ * Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
2854
+ * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
2855
+ * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
2856
+ * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
2857
+ */
2896
2858
  PUBLIC = "PUBLIC",
2859
+ /** - `FULL`: Returns all fields. */
2897
2860
  FULL = "FULL"
2898
2861
  }
2899
2862
  interface GetReservationLocationResponse {
@@ -3224,12 +3187,6 @@ interface QueryReservationLocationsRequest {
3224
3187
  /**
3225
3188
  * Array of named, predefined sets of projected fields to be returned.
3226
3189
  *
3227
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3228
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3229
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3230
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3231
- * - `FULL`: Returns all fields.
3232
- *
3233
3190
  * Default: `PUBLIC`.
3234
3191
  */
3235
3192
  fieldsets?: Set[];
@@ -3269,12 +3226,14 @@ interface Sorting {
3269
3226
  /**
3270
3227
  * Sort order.
3271
3228
  *
3272
- * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
3229
+ * Defaults to `ASC`.
3273
3230
  */
3274
3231
  order?: SortOrder;
3275
3232
  }
3276
3233
  declare enum SortOrder {
3234
+ /** Soer by ascending order. */
3277
3235
  ASC = "ASC",
3236
+ /** Sort by descending order. */
3278
3237
  DESC = "DESC"
3279
3238
  }
3280
3239
  interface Paging {
@@ -3321,12 +3280,6 @@ interface ListReservationLocationsRequest {
3321
3280
  /**
3322
3281
  * Array of named, predefined sets of projected fields to be returned.
3323
3282
  *
3324
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
3325
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
3326
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
3327
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
3328
- * - `FULL`: Returns all fields.
3329
- *
3330
3283
  * Default: `PUBLIC`.
3331
3284
  */
3332
3285
  fieldsets?: Set[];
@@ -3362,8 +3315,8 @@ interface MigrateOldRestaurantSettingsRequest {
3362
3315
  overrideNotDefault?: boolean;
3363
3316
  }
3364
3317
  declare enum Mode {
3365
- /** DRY RUN. */
3366
3318
  UNDEFINED = "UNDEFINED",
3319
+ /** Dry run. */
3367
3320
  DRY_RUN = "DRY_RUN",
3368
3321
  MIGRATE = "MIGRATE",
3369
3322
  FORCE_MIGRATE = "FORCE_MIGRATE"
@@ -4725,12 +4678,6 @@ interface GetReservationLocationOptions {
4725
4678
  /**
4726
4679
  * Array of named, predefined sets of projected fields to be returned.
4727
4680
  *
4728
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
4729
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
4730
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
4731
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
4732
- * - `FULL`: Returns all fields.
4733
- *
4734
4681
  * Default: `PUBLIC`.
4735
4682
  */
4736
4683
  fieldsets?: Set[];
@@ -4788,12 +4735,6 @@ interface QueryReservationLocationsOptions {
4788
4735
  /**
4789
4736
  * Array of named, predefined sets of projected fields to be returned.
4790
4737
  *
4791
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
4792
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
4793
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
4794
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
4795
- * - `FULL`: Returns all fields.
4796
- *
4797
4738
  * Default: `PUBLIC`.
4798
4739
  */
4799
4740
  fieldsets?: Set[] | undefined;
@@ -4843,12 +4784,6 @@ interface ListReservationLocationsOptions {
4843
4784
  /**
4844
4785
  * Array of named, predefined sets of projected fields to be returned.
4845
4786
  *
4846
- * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
4847
- * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
4848
- * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
4849
- * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
4850
- * - `FULL`: Returns all fields.
4851
- *
4852
4787
  * Default: `PUBLIC`.
4853
4788
  */
4854
4789
  fieldsets?: Set[];
@@ -5200,20 +5135,17 @@ interface TimeSlot {
5200
5135
  startDate?: Date | null;
5201
5136
  /** Duration in minutes of this time slot. */
5202
5137
  duration?: number;
5203
- /**
5204
- * Availability status of this time slot.
5205
- *
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
- * * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
5209
- */
5138
+ /** Availability status of this time slot. */
5210
5139
  status?: Status;
5211
5140
  /** Whether manual approval is required to make a reservation in this time slot. */
5212
5141
  manualApproval?: boolean | null;
5213
5142
  }
5214
5143
  declare enum Status {
5144
+ /** The restaurant can accommodate a party of the given size in this time slot. */
5215
5145
  AVAILABLE = "AVAILABLE",
5146
+ /** The restaurant can't accommodate a party of the given size in this time slot. */
5216
5147
  UNAVAILABLE = "UNAVAILABLE",
5148
+ /** The restaurant is not open during this time slot. */
5217
5149
  NON_WORKING_HOURS = "NON_WORKING_HOURS"
5218
5150
  }
5219
5151
  /** Table combination. */
@@ -5302,10 +5234,15 @@ interface TableCombinationConflict {
5302
5234
  type?: TableCombinationConflictType;
5303
5235
  }
5304
5236
  declare enum TableCombinationConflictType {
5237
+ /** Undefined conflict type. */
5305
5238
  UNKNOWN = "UNKNOWN",
5239
+ /** One or more of the chosen tables are already reserved. */
5306
5240
  RESERVED = "RESERVED",
5241
+ /** The party is too big for the selected table. */
5307
5242
  TOO_BIG = "TOO_BIG",
5243
+ /** The party is too small for the selected table. */
5308
5244
  TOO_SMALL = "TOO_SMALL",
5245
+ /** The restaurant does not allow online reservations. */
5309
5246
  OFFLINE_ONLY = "OFFLINE_ONLY"
5310
5247
  }
5311
5248
  interface ReservationLocationConflict {
@@ -5313,8 +5250,11 @@ interface ReservationLocationConflict {
5313
5250
  type?: Type;
5314
5251
  }
5315
5252
  declare enum Type {
5253
+ /** Undefined reservation location conflict type. */
5316
5254
  UNKNOWN = "UNKNOWN",
5255
+ /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
5317
5256
  PARTY_PACING = "PARTY_PACING",
5257
+ /** The required number of seats are unavailable according to seat pacing settings. */
5318
5258
  SEAT_PACING = "SEAT_PACING"
5319
5259
  }
5320
5260
  interface TableReservedConflict {