@wix/table-reservations 1.0.163 → 1.0.165

package/type-bundles/index.bundle.d.ts

@@ -505,9 +505,6 @@ interface Reservation {
      * Reservation source.
      *
      * This indicates how the reservation was made.
-     * * `ONLINE` indicates that the customer made the reservation through a website or app.
-     * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
-     * * `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.
      */
     source?: Source;
     /** Reservation details. */
@@ -544,7 +541,7 @@ interface Reservation {
     _updatedDate?: Date | null;
     /**
      * Revision number, which increments by 1 each time the reservation is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the reservation.
+     * To prevent conflicting changes, the current revision must be specified when updating the reservation.
      *
      * Ignored when creating a reservation.
      * @readonly
@@ -564,39 +561,41 @@ interface Reservation {
      */
     extendedFields?: ExtendedFields$1;
 }
-/** Tables used for the reservation. If you don't pass a `tables` object, the server attempts to assign tables automatically. */
+/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
 interface Tables {
-    /** IDs of tables used for this reservation. If you don't pass an `ids` array, or you pass an empty array, no tables are assigned. */
+    /** 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. */
     ids?: string[];
 }
 declare enum Status$1 {
+    /** Undefined reservation status. */
     UNKNOWN = "UNKNOWN",
-    /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
+    /** 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. */
     HELD = "HELD",
-    /** The reservation has been reserved. */
+    /** The reservation is confirmed. */
     RESERVED = "RESERVED",
-    /** The reservation has been canceled. */
+    /** The reservation is canceled. */
     CANCELED = "CANCELED",
-    /** The reservation has finished successfully. */
+    /** The reservation completed successfully. */
     FINISHED = "FINISHED",
-    /** The reservee didn't arrive. */
+    /** The customer didn't show up for their reservation. */
     NO_SHOW = "NO_SHOW",
-    /** The reservee occupied the table. */
+    /** The customer is currently occupying the table. */
     SEATED = "SEATED",
-    /** The reservee requested a reservation and is waiting for manual approval. */
+    /** 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. */
     REQUESTED = "REQUESTED",
-    /** The owner declined a reservee's request. */
+    /** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
     DECLINED = "DECLINED",
-    /** 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. */
+    /** 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`. */
     PAYMENT_PENDING = "PAYMENT_PENDING"
 }
 declare enum Source {
+    /** Undefined reservation source. */
     UNKNOWN = "UNKNOWN",
-    /** The reservation is created by a User. */
+    /** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
     OFFLINE = "OFFLINE",
-    /** The reservation is created by UoU. */
+    /** The reservation was made through a website or app. */
     ONLINE = "ONLINE",
-    /** The reservation is created by a User. It can be created without reservee data. */
+    /** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
     WALK_IN = "WALK_IN"
 }
 /** Reservation details. */
@@ -674,18 +673,19 @@ interface TableWithReservationConflicts {
     reservationIds?: string[];
 }
 declare enum PaymentStatus {
+    /** Undefined payment status. */
     UNKNOWN = "UNKNOWN",
     /** A reservation is free of charge. */
     FREE = "FREE",
-    /** A payment is not received yet. */
+    /** Payment is not received yet. */
     NOT_PAID = "NOT_PAID",
-    /** A corresponding to reservation order was fully payed. */
+    /** The corresponding reservation order was fully paid. */
     PAID = "PAID",
-    /** A corresponding to reservation order was refunded, but refund amount is less than order total price. */
+    /** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
     PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    /** A corresponding to reservation order was fully refunded. The refund amount equals total price. */
+    /** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
     FULLY_REFUNDED = "FULLY_REFUNDED",
-    /** A corresponding to reservation order was partially payed. */
+    /** The corresponding reservation order was partially paid. */
     PARTIALLY_PAID = "PARTIALLY_PAID"
 }
 interface ExtendedFields$1 {
@@ -734,7 +734,7 @@ interface CreateReservationRequest {
     /** Reservation details. */
     reservation: Reservation;
     /**
-     * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     * 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.
      *
      * Possible values:
      * * `"RESERVED"`: One or more of the chosen tables are already reserved.
@@ -744,7 +744,7 @@ interface CreateReservationRequest {
      */
     ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
     /**
-     * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     * 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.
      *
      * Possible values:
      * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
@@ -753,15 +753,23 @@ interface CreateReservationRequest {
     ignoreReservationLocationConflicts?: Type$2[];
 }
 declare enum TableCombinationConflictType$1 {
+    /** Undefined conflict type. */
     UNKNOWN = "UNKNOWN",
+    /** One or more of the chosen tables are already reserved. */
     RESERVED = "RESERVED",
+    /** The party is too big for the selected table. */
     TOO_BIG = "TOO_BIG",
+    /** The party is too small for the selected table. */
     TOO_SMALL = "TOO_SMALL",
+    /** The restaurant does not allow online reservations. */
     OFFLINE_ONLY = "OFFLINE_ONLY"
 }
 declare enum Type$2 {
+    /** Undefined reservation location conflict type. */
     UNKNOWN = "UNKNOWN",
+    /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
     PARTY_PACING = "PARTY_PACING",
+    /** The required number of seats are unavailable according to seat pacing settings. */
     SEAT_PACING = "SEAT_PACING"
 }
 interface CreateReservationResponse {
@@ -795,7 +803,12 @@ interface GetReservationRequest {
     fieldsets?: Set$1[];
 }
 declare enum Set$1 {
+    /**
+     * Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
+     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
+     */
     PUBLIC = "PUBLIC",
+    /** Returns all fields. */
     FULL = "FULL"
 }
 interface GetReservationResponse {
@@ -805,23 +818,8 @@ interface GetReservationResponse {
 interface UpdateReservationRequest {
     /** Reservation information to update. */
     reservation: Reservation;
-    /**
-     * 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.
-     *
-     * Possible values:
-     * * `"RESERVED"`: One or more of the chosen tables are already reserved.
-     * * `"TOO_BIG"`: The party is too big for the selected table.
-     * * `"TOO_SMALL"`: The party is too small for the selected table.
-     * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
-     */
+    /** 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. */
     ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
-    /**
-     * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
-     *
-     * Possible values:
-     * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
-     * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
-     */
     ignoreReservationLocationConflicts?: Type$2[];
 }
 interface UpdateReservationResponse {
@@ -865,7 +863,7 @@ interface ReserveReservationRequest {
     /**
      * Revision number.
      *
-     * Include the existing `revision` to prevent conflicting updates to reservations.
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
      */
     revision: string | null;
 }
@@ -879,7 +877,7 @@ interface CancelReservationRequest {
     /**
      * Revision number.
      *
-     * Include the existing `revision` to prevent conflicting updates to reservations.
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
      */
     revision: string | null;
     /**
@@ -914,18 +912,7 @@ interface ListReservationsRequest {
     startDateFrom?: Date | null;
     /** Only reservations starting before this date are returned. */
     startDateTo?: Date | null;
-    /**
-     * Only reservations with this status are returned.
-     *
-     * * `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.
-     * * `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.
-     * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
-     * * `RESERVED`: The reservation is confirmed.
-     * * `SEATED`: The customer is currently occupying the table.
-     * * `CANCELED`: The reservation is canceled.
-     * * `NO_SHOW`: The customer didn't show up for their reservation.
-     * * `FINISHED`: The reservation completed successfully.
-     */
+    /** Only reservations with this status are returned. */
     status?: Status$1;
 }
 interface CursorPaging$1 {
@@ -945,13 +932,14 @@ interface Sorting$1 {
     fieldName?: string;
     /**
      * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
+     * Default: `ASC`.
      */
     order?: SortOrder$1;
 }
 declare enum SortOrder$1 {
+    /** Sort by ascending order. */
     ASC = "ASC",
+    /** Sort by descending order. */
     DESC = "DESC"
 }
 interface ListReservationsResponse {
@@ -1112,6 +1100,7 @@ interface IncludeMissingValuesOptions {
     addToBucket?: string;
 }
 declare enum ScalarType {
+    /** Undefined scalar type. */
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
     /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -1125,14 +1114,15 @@ declare enum ScalarType {
     AVG = "AVG"
 }
 declare enum NestedAggregationType {
+    /** Undefined aggregation type. */
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
     /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
     /** An aggregation where you can define a set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg. */
+    /** A single-value metric aggregation - such as min, max, sum, and avg. */
     SCALAR = "SCALAR",
-    /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface ValueAggregation extends ValueAggregationOptionsOneOf {
@@ -1210,14 +1200,15 @@ interface NestedAggregationItemKindOneOf {
     dateHistogram?: DateHistogramAggregation;
 }
 declare enum AggregationType {
+    /** Undefined aggregation type. */
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
     /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
     /** An aggregation where you can define a set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg. */
+    /** A single-value metric aggregation - such as min, max, sum, or avg. */
     SCALAR = "SCALAR",
-    /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
     /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
     NESTED = "NESTED"
@@ -1726,7 +1717,7 @@ interface ReservationDeletedEnvelope {
 }
 interface CreateReservationOptions {
     /**
-     * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     * 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.
      *
      * Possible values:
      * * `"RESERVED"`: One or more of the chosen tables are already reserved.
@@ -1736,7 +1727,7 @@ interface CreateReservationOptions {
      */
     ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
     /**
-     * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     * 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.
      *
      * Possible values:
      * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
@@ -1770,9 +1761,6 @@ interface UpdateReservation {
      * Reservation source.
      *
      * This indicates how the reservation was made.
-     * * `ONLINE` indicates that the customer made the reservation through a website or app.
-     * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
-     * * `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.
      */
     source?: Source;
     /** Reservation details. */
@@ -1809,7 +1797,7 @@ interface UpdateReservation {
     _updatedDate?: Date | null;
     /**
      * Revision number, which increments by 1 each time the reservation is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the reservation.
+     * To prevent conflicting changes, the current revision must be specified when updating the reservation.
      *
      * Ignored when creating a reservation.
      * @readonly
@@ -1830,23 +1818,8 @@ interface UpdateReservation {
     extendedFields?: ExtendedFields$1;
 }
 interface UpdateReservationOptions {
-    /**
-     * 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.
-     *
-     * Possible values:
-     * * `"RESERVED"`: One or more of the chosen tables are already reserved.
-     * * `"TOO_BIG"`: The party is too big for the selected table.
-     * * `"TOO_SMALL"`: The party is too small for the selected table.
-     * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
-     */
+    /** 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. */
     ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];
-    /**
-     * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.
-     *
-     * Possible values:
-     * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
-     * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
-     */
     ignoreReservationLocationConflicts?: Type$2[];
 }
 interface UpdateExtendedFieldsOptions$1 {
@@ -1872,18 +1845,7 @@ interface ListReservationsOptions {
     startDateFrom?: Date | null;
     /** Only reservations starting before this date are returned. */
     startDateTo?: Date | null;
-    /**
-     * Only reservations with this status are returned.
-     *
-     * * `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.
-     * * `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.
-     * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
-     * * `RESERVED`: The reservation is confirmed.
-     * * `SEATED`: The customer is currently occupying the table.
-     * * `CANCELED`: The reservation is canceled.
-     * * `NO_SHOW`: The customer didn't show up for their reservation.
-     * * `FINISHED`: The reservation completed successfully.
-     */
+    /** Only reservations with this status are returned. */
     status?: Status$1;
 }
 interface QueryCursorResult$1 {
@@ -2048,7 +2010,7 @@ interface ReserveReservationSignature {
      * @param - Reservee details.
      * @param - Revision number.
      *
-     * Include the existing `revision` to prevent conflicting updates to reservations.
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
      */
     (reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
 }
@@ -2061,7 +2023,7 @@ interface CancelReservationSignature {
      * @param - Reservation ID.
      * @param - Revision number.
      *
-     * Include the existing `revision` to prevent conflicting updates to reservations.
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
      * @param - Options for canceling the reservation.
      */
     (reservationId: string, revision: string | null, options?: CancelReservationOptions | undefined): Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
@@ -2106,9 +2068,9 @@ interface QueryReservationsSignature {
 declare function searchReservations$1(httpClient: HttpClient): SearchReservationsSignature;
 interface SearchReservationsSignature {
     /**
-     * Use this endpoint to search the fields of the table reservations on a site for a given expression.
+     * Use this method to search the fields of the table reservations on a site for a given expression.
      *
-     * You can also use this endpoint to perform data aggregations on a site's table reservation fields.
+     * You can also use this method to perform data aggregations on a site's table reservation fields.
      * 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.
      * @param - Search query.
      */
@@ -2882,18 +2844,19 @@ interface GetReservationLocationRequest {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[];
 }
 declare enum Set {
+    /**
+     * Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
+     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
+     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
+     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
+     */
     PUBLIC = "PUBLIC",
+    /** - `FULL`: Returns all fields. */
     FULL = "FULL"
 }
 interface GetReservationLocationResponse {
@@ -3224,12 +3187,6 @@ interface QueryReservationLocationsRequest {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[];
@@ -3269,12 +3226,14 @@ interface Sorting {
     /**
      * Sort order.
      *
-     * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
+     * Defaults to `ASC`.
      */
     order?: SortOrder;
 }
 declare enum SortOrder {
+    /** Soer by ascending order. */
     ASC = "ASC",
+    /** Sort by descending order. */
     DESC = "DESC"
 }
 interface Paging {
@@ -3321,12 +3280,6 @@ interface ListReservationLocationsRequest {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[];
@@ -3362,8 +3315,8 @@ interface MigrateOldRestaurantSettingsRequest {
     overrideNotDefault?: boolean;
 }
 declare enum Mode {
-    /** DRY RUN. */
     UNDEFINED = "UNDEFINED",
+    /** Dry run. */
     DRY_RUN = "DRY_RUN",
     MIGRATE = "MIGRATE",
     FORCE_MIGRATE = "FORCE_MIGRATE"
@@ -4725,12 +4678,6 @@ interface GetReservationLocationOptions {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[];
@@ -4788,12 +4735,6 @@ interface QueryReservationLocationsOptions {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[] | undefined;
@@ -4843,12 +4784,6 @@ interface ListReservationLocationsOptions {
     /**
      * Array of named, predefined sets of projected fields to be returned.
      *
-     * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
-     * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
-     * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
-     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
-     * - `FULL`: Returns all fields.
-     *
      * Default: `PUBLIC`.
      */
     fieldsets?: Set[];
@@ -5200,20 +5135,17 @@ interface TimeSlot {
     startDate?: Date | null;
     /** Duration in minutes of this time slot. */
     duration?: number;
-    /**
-     * Availability status of this time slot.
-     *
-     * * `AVAILABLE`: The restaurant can accommodate a party of the given size in this time slot.
-     * * `UNAVAILABLE`: The restaurant can't accommodate a party of the given size in this time slot.
-     * * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.
-     */
+    /** Availability status of this time slot. */
     status?: Status;
     /** Whether manual approval is required to make a reservation in this time slot. */
     manualApproval?: boolean | null;
 }
 declare enum Status {
+    /** The restaurant can accommodate a party of the given size in this time slot. */
     AVAILABLE = "AVAILABLE",
+    /** The restaurant can't accommodate a party of the given size in this time slot. */
     UNAVAILABLE = "UNAVAILABLE",
+    /** The restaurant is not open during this time slot. */
     NON_WORKING_HOURS = "NON_WORKING_HOURS"
 }
 /** Table combination. */
@@ -5238,13 +5170,13 @@ interface GetTimeSlotsRequest {
      * Min: `1`
      */
     partySize: number | null;
-    /** The number of time slots to retrieve before the given `date`. */
+    /** The number of time slots to retrieve before the specified `date`. */
     slotsBefore?: number | null;
-    /** The number of time slots to retrieve after the given `date`. */
+    /** The number of time slots to retrieve after the specified `date`. */
     slotsAfter?: number | null;
 }
 interface GetTimeSlotsResponse {
-    /** A list of time slots and their availability according to the given party size. */
+    /** A list of time slots and their availability according to the specified party size. */
     timeSlots?: TimeSlot[];
 }
 interface CheckReservationDetailsRequest {
@@ -5302,10 +5234,15 @@ interface TableCombinationConflict {
     type?: TableCombinationConflictType;
 }
 declare enum TableCombinationConflictType {
+    /** Undefined conflict type. */
     UNKNOWN = "UNKNOWN",
+    /** One or more of the chosen tables are already reserved. */
     RESERVED = "RESERVED",
+    /** The party is too big for the selected table. */
     TOO_BIG = "TOO_BIG",
+    /** The party is too small for the selected table. */
     TOO_SMALL = "TOO_SMALL",
+    /** The restaurant does not allow online reservations. */
     OFFLINE_ONLY = "OFFLINE_ONLY"
 }
 interface ReservationLocationConflict {
@@ -5313,8 +5250,11 @@ interface ReservationLocationConflict {
     type?: Type;
 }
 declare enum Type {
+    /** Undefined reservation location conflict type. */
     UNKNOWN = "UNKNOWN",
+    /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
     PARTY_PACING = "PARTY_PACING",
+    /** The required number of seats are unavailable according to seat pacing settings. */
     SEAT_PACING = "SEAT_PACING"
 }
 interface TableReservedConflict {
@@ -5346,7 +5286,7 @@ interface CheckTimeSlotRequest {
 interface CheckTimeSlotResponse {
     /** Table combinations and their availability information. */
     tableCombinationAvailabilities?: TableCombinationAvailability[];
-    /** Reservation location conflicts that would occur by making a reservation for the given party size in the given time slot. */
+    /** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
     reservationLocationConflicts?: Type[];
 }
 interface TableCombinationAvailability {
@@ -5381,9 +5321,9 @@ interface GetTimeSlotsOptions {
      * Min: `5`
      */
     duration?: number | null;
-    /** The number of time slots to retrieve before the given `date`. */
+    /** The number of time slots to retrieve before the specified `date`. */
     slotsBefore?: number | null;
-    /** The number of time slots to retrieve after the given `date`. */
+    /** The number of time slots to retrieve after the specified `date`. */
     slotsAfter?: number | null;
 }
 interface CheckTimeSlotOptions {
@@ -5408,13 +5348,13 @@ interface CheckTimeSlotOptions {
 declare function getTimeSlots$1(httpClient: HttpClient): GetTimeSlotsSignature;
 interface GetTimeSlotsSignature {
     /**
-     * Returns a list of time slots at a given reservation location on a given `date`, and their availability for a given `partySize`.
+     * Returns a list of time slots at a specified reservation location on a specified `date`, and their availability for a specified `partySize`.
      *
-     * Without passing optional parameters, the list will contain a single time slot at the given `date`.
-     * Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the given `date`.
+     * Without passing optional parameters, the list will contain a single time slot at the specified `date`.
+     * Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the specified `date`.
      *
      * If you do not provide a `duration`, the duration will be calculated automatically based on the reservation location's configuration.
-     * 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 given size.
+     * 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.
      *
      * 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.
      * @param - ID of the reservation location for which to retrieve time slots.