@wix/table-reservations 1.0.118 → 1.0.119

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/table-reservations",
-  "version": "1.0.118",
+  "version": "1.0.119",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,9 +18,9 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/table-reservations_reservation-locations": "1.0.40",
-    "@wix/table-reservations_reservations": "1.0.36",
-    "@wix/table-reservations_time-slots": "1.0.38"
+    "@wix/table-reservations_reservation-locations": "1.0.41",
+    "@wix/table-reservations_reservations": "1.0.37",
+    "@wix/table-reservations_time-slots": "1.0.39"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -45,5 +45,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c3a1013bd805c53cf12294c6f628e3e2219efb1b00ec9495256e5cf6"
+  "falconPackageHash": "ee219035473bc54f3047debfe407f36873031fc5ac43ad3b45bce872"
 }

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

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /** The reservation domain object. */
 interface Reservation {
     /**
@@ -1412,60 +1456,159 @@ interface ReservationsQueryBuilder {
     find: () => Promise<ReservationsQueryResult>;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
+interface CreateReservationSignature {
+    /**
+     * Creates a new reservation.
+     *
+     * `createReservation()` accepts and requires different fields depending on the `status` provided and your permissions.
+     *
+     * **Status and source**
+     *
+     * If a `status` is not provided, it will be set to:
+     * * `RESERVED` if manual approval is not required for confirmation
+     * * `REQUESTED` if manual approval is required for confirmation.
+     *
+     * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
+     * Attempting to create a reservation without these fields will result in an error.
+     *
+     * **Permissions**
+     *
+     * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
+     *
+     * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
+     *
+     *
+     *  > **Note:** `createReservation()` requires all details of the reservation upfront. The process of creating a reservation can be broken up using `createHeldReservation`.  `createHeldReservation` creates a temporary reservation that expires automatically unless it is completed with the addition of more details using `reserveReservation()`.
+     * @param - Reservation details.
+     * @param - Options for creating the reservation.
+     * @returns Reservation.
+     */
+    (reservation: Reservation, options?: CreateReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getReservation$1(httpClient: HttpClient): GetReservationSignature;
+interface GetReservationSignature {
+    /**
+     * Retrieves a reservation.
+     *
+     * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
+     * @param - Reservation ID.
+     * @returns Reservation.
+     */
+    (reservationId: string, options?: GetReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
+}
+declare function updateReservation$1(httpClient: HttpClient): UpdateReservationSignature;
+interface UpdateReservationSignature {
+    /**
+     * Updates a reservation.
+     *
+     * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, and `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
+     *
+     * Each time the reservation is updated, revision increments by 1. The existing revision must be included when updating the reservation. This ensures you're working with the latest reservation information, and it prevents unintended overwrites.
+     * @param - Reservation ID.
+     * @param - Options for updating the reservation.
+     * @param - Reservation information to update.
+     * @returns Reservation.
+     */
+    (_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
+}
+declare function createHeldReservation$1(httpClient: HttpClient): CreateHeldReservationSignature;
+interface CreateHeldReservationSignature {
+    /**
+     * Creates a new temporary reservation and holds it for the customer for 10 minutes.
+     *
+     * Creates a new reservation with the `HELD` status. `HELD` reservations are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error.
+     *
+     * You cannot call `updateReservation()` to change a reservation’s status from `HELD`. Trying to do so returns an error. Instead, you should use `reserveReservation()`.
+     *
+     * If you do not wish to have `HELD` reservations in your flow, you can create a reservation with all required details using `createReservation()`.
+     *
+     * @param - Held reservation information to update.
+     */
+    (reservationDetails: HeldReservationDetails): Promise<CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields>;
+}
+declare function reserveReservation$1(httpClient: HttpClient): ReserveReservationSignature;
+interface ReserveReservationSignature {
+    /**
+     * Reserves or requests a held reservation.
+     *
+     * Held reservations are temporary reservations with the `HELD` status created by `createHeldReservation()`.
+     *
+     * They are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to call `Reserve Reservation` with a held reservation older than 10 minutes returns an error.
+     *
+     * `Reserve Reservation` changes a reservation's `HELD` status to:
+     * * `RESERVED` if the reservation's reservation location does not require manual approval.
+     * * `REQUESTED` if the reservation's reservation location requires manual approval.
+     * @param - Reservation ID.
+     * @param - Reservee details.
+     * @param - Revision number.
+     *
+     * Include the existing `revision` to prevent conflicting updates to reservations.
+     */
+    (reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
+}
+declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
+interface CancelReservationSignature {
+    /**
+     * Cancels a reservation.
+     *
+     * Sets the reservation status to `CANCELED`.
+     * @param - Reservation ID.
+     * @param - Revision number.
+     *
+     * Include 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>;
+}
+declare function deleteReservation$1(httpClient: HttpClient): DeleteReservationSignature;
+interface DeleteReservationSignature {
+    /**
+     * Deletes a reservation. Only reservations with the `HELD` status can be deleted.
+     * @param - Reservation ID.
+     */
+    (reservationId: string): Promise<void>;
+}
+declare function listReservations$1(httpClient: HttpClient): ListReservationsSignature;
+interface ListReservationsSignature {
+    /**
+     * Retrieves a list of up to 100 reservations.
+     * @param - Options for listing the reservations.
+     */
+    (options?: ListReservationsOptions | undefined): Promise<ListReservationsResponse & ListReservationsResponseNonNullableFields>;
+}
+declare function queryReservations$1(httpClient: HttpClient): QueryReservationsSignature;
+interface QueryReservationsSignature {
+    /**
+     * Creates a query to retrieve a list of reservations.
+     *
+     * The `queryReservations()` function builds a query to retrieve a list of reservations and returns a [`ReservationsQueryBuilder`](/reservations/reservations-query-builder) object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the [find()](/reservations/reservations-query-builder/find) function.
+     *
+     * You can refine the query by chaining `ReservationsQueryBuilder` functions onto the query. `ReservationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryReservations()` returns.
+     *
+     * `queryReservations()` runs with the following `ReservationsQueryBuilder` defaults, which you can override:
+     *
+     * * [`skip(0)`](/reservations/reservations-query-builder/skip)
+     * * [`limit(50)`](/reservations/reservations-query-builder/limit)
+     * * [`descending('_createdDate')`](/reservations/reservations-query-builder/descending)
+     *
+     * The following `ReservationsQueryBuilder` functions are supported for `queryReservations()`. For a full description of the reservation object, see the object returned for the [`items`](/reservations/reservations-query-builder/items) property in [`ReservationsQueryResult`](/reservations/reservations-query-result).
+     */
+    (): ReservationsQueryBuilder;
+}
+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.
+     *
+     * You can also use this endpoint 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.
+     */
+    (search: CursorSearch): Promise<SearchReservationsResponse & SearchReservationsResponseNonNullableFields>;
 }
-
-declare function createReservation$1(httpClient: HttpClient): (reservation: Reservation, options?: CreateReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function getReservation$1(httpClient: HttpClient): (reservationId: string, options?: GetReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function updateReservation$1(httpClient: HttpClient): (_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function createHeldReservation$1(httpClient: HttpClient): (reservationDetails: HeldReservationDetails) => Promise<CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields>;
-declare function reserveReservation$1(httpClient: HttpClient): (reservationId: string, reservee: Reservee, revision: string | null) => Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
-declare function cancelReservation$1(httpClient: HttpClient): (reservationId: string, revision: string | null, options?: CancelReservationOptions) => Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
-declare function deleteReservation$1(httpClient: HttpClient): (reservationId: string) => Promise<void>;
-declare function listReservations$1(httpClient: HttpClient): (options?: ListReservationsOptions) => Promise<ListReservationsResponse & ListReservationsResponseNonNullableFields>;
-declare function queryReservations$1(httpClient: HttpClient): () => ReservationsQueryBuilder;
-declare function searchReservations$1(httpClient: HttpClient): (search: CursorSearch) => Promise<SearchReservationsResponse & SearchReservationsResponseNonNullableFields>;
 declare const onReservationCreated$1: EventDefinition<ReservationCreatedEnvelope, "wix.table_reservations.v1.reservation_created">;
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -1494,6 +1637,9 @@ type _publicSearchReservationsType = typeof searchReservations$1;
 declare const searchReservations: ReturnType<typeof createRESTModule$2<_publicSearchReservationsType>>;
 
 type _publicOnReservationCreatedType = typeof onReservationCreated$1;
+/**
+ * Triggered when a held reservation is created.
+ */
 declare const onReservationCreated: ReturnType<typeof createEventModule$1<_publicOnReservationCreatedType>>;
 
 type context$2_Aggregation = Aggregation;
@@ -3779,10 +3925,65 @@ interface ListReservationLocationsOptions {
     fieldsets?: Set[];
 }
 
-declare function getReservationLocation$1(httpClient: HttpClient): (reservationLocationId: string, options?: GetReservationLocationOptions) => Promise<ReservationLocation & ReservationLocationNonNullableFields>;
-declare function updateReservationLocation$1(httpClient: HttpClient): (_id: string | null, reservationLocation: UpdateReservationLocation) => Promise<ReservationLocation & ReservationLocationNonNullableFields>;
-declare function queryReservationLocations$1(httpClient: HttpClient): (options?: QueryReservationLocationsOptions) => ReservationLocationsQueryBuilder;
-declare function listReservationLocations$1(httpClient: HttpClient): (options?: ListReservationLocationsOptions) => Promise<ListReservationLocationsResponse & ListReservationLocationsResponseNonNullableFields>;
+declare function getReservationLocation$1(httpClient: HttpClient): GetReservationLocationSignature;
+interface GetReservationLocationSignature {
+    /**
+     * Retrieves a reservation location by ID.
+     *
+     * The `FULL` fieldset can only be retrieved by users with the `READ RESERVATION LOCATIONS (FULL)` or `MANAGE RESERVATION LOCATIONS` permission scopes.
+     * @param - ID of the ReservationLocation to retrieve.
+     * @param - An object representing the available options for retrieving a reservation location.
+     * @returns The retrieved reservation location.
+     */
+    (reservationLocationId: string, options?: GetReservationLocationOptions | undefined): Promise<ReservationLocation & ReservationLocationNonNullableFields>;
+}
+declare function updateReservationLocation$1(httpClient: HttpClient): UpdateReservationLocationSignature;
+interface UpdateReservationLocationSignature {
+    /**
+     * Updates a reservation location. Supports partial updates.
+     *
+     * Each time the reservation location is updated, `revision` increments by 1. The existing revision must be included when updating the reservation location. This ensures you're working with the latest reservation location information, and it prevents unintended overwrites.
+     *
+     * You cannot use this endpoint to change a reservation location's `location` object. Attempting to do so will cause the server to return an application error.
+     * @param - Reservation location ID.
+     * @param - Reservation location information to update.
+     * @returns The updated reservation location.
+     */
+    (_id: string | null, reservationLocation: UpdateReservationLocation): Promise<ReservationLocation & ReservationLocationNonNullableFields>;
+}
+declare function queryReservationLocations$1(httpClient: HttpClient): QueryReservationLocationsSignature;
+interface QueryReservationLocationsSignature {
+    /**
+     * Creates a query to retrieve a list of reservation locations.
+     *
+     *
+     * The `queryReservationLocations()` function builds a query to retrieve a list of reservation locations and returns a [`ReservationLocationsQueryBuilder`](/reservation-locations/reservation-locations-query-builder/) object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the [find()](/reservation-locations/reservation-locations-query-builder/find) function.
+     *
+     * You can refine the query by chaining `ReservationLocationsQueryBuilder` functions onto the query. `ReservationLocationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryReservationLocations()` returns.
+     *
+     * `queryReservationLocations()` runs with the following `ReservationLocationsQueryBuilder` defaults, which you can override:
+     *
+     * * [`skip(0)`](/reservation-locations/reservation-locations-query-builder/skip)
+     * * [`limit(50)`](/reservation-locations/reservation-locations-query-builder/limit)
+     * * [`descending('_createdDate')`](/reservation-locations/reservation-locations-query-builder/descending)
+     *
+     * The following `ReservationLocationsQueryBuilder` functions are supported for `queryReservationLocations()`. For a full description of the reservation location object, see the object returned for the [`items`](/reservation-locations/reservation-locations-query-result/items) property in [`ReservationLocationsQueryResult`](/reservation-locations/reservation-locations-query-result).
+     * @param - An object representing the available options for querying reservation locations.
+     */
+    (options?: QueryReservationLocationsOptions | undefined): ReservationLocationsQueryBuilder;
+}
+declare function listReservationLocations$1(httpClient: HttpClient): ListReservationLocationsSignature;
+interface ListReservationLocationsSignature {
+    /**
+     * Retrieves a list of up to 100 reservation locations.
+     *
+     * The `FULL` fieldset can only be retrieved by users with the `READ RESERVATION LOCATIONS (FULL)` or `MANAGE RESERVATION LOCATIONS` permission scopes.
+     * @param - An object representing the available options for listing reservation locations.
+     */
+    (options?: ListReservationLocationsOptions | undefined): Promise<ListReservationLocationsResponse & ListReservationLocationsResponseNonNullableFields>;
+}
 declare const onReservationLocationUpdated$1: EventDefinition<ReservationLocationUpdatedEnvelope, "wix.table_reservations.v1.reservation_location_updated">;
 declare const onReservationLocationCreated$1: EventDefinition<ReservationLocationCreatedEnvelope, "wix.table_reservations.v1.reservation_location_created">;
 
@@ -3800,9 +4001,15 @@ type _publicListReservationLocationsType = typeof listReservationLocations$1;
 declare const listReservationLocations: ReturnType<typeof createRESTModule$1<_publicListReservationLocationsType>>;
 
 type _publicOnReservationLocationUpdatedType = typeof onReservationLocationUpdated$1;
+/**
+ * Triggered when a reservation location is updated.
+ */
 declare const onReservationLocationUpdated: ReturnType<typeof createEventModule<_publicOnReservationLocationUpdatedType>>;
 
 type _publicOnReservationLocationCreatedType = typeof onReservationLocationCreated$1;
+/**
+ * Triggered when a reservation location is updated.
+ */
 declare const onReservationLocationCreated: ReturnType<typeof createEventModule<_publicOnReservationLocationCreatedType>>;
 
 type context$1_ActionEvent = ActionEvent;
@@ -4223,8 +4430,37 @@ interface CheckTimeSlotOptions {
     excludeReservationId?: string | null;
 }
 
-declare function getTimeSlots$1(httpClient: HttpClient): (reservationLocationId: string, date: Date, partySize: number | null, options?: GetTimeSlotsOptions) => Promise<GetTimeSlotsResponse & GetTimeSlotsResponseNonNullableFields>;
-declare function checkTimeSlot$1(httpClient: HttpClient): (reservationLocationId: string, options?: CheckTimeSlotOptions) => Promise<CheckTimeSlotResponse & CheckTimeSlotResponseNonNullableFields>;
+declare function getTimeSlots$1(httpClient: HttpClient): GetTimeSlotsSignature;
+interface GetTimeSlotsSignature {
+    /**
+     * Returns a list of time slots at a given restaurant on a given `date`, and their availability for a given `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`.
+     *
+     * 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 `startDate`s of time slots in the response are 15 minutes apart regardless of the `duration` provided.
+     * @param - ID of the reservation location for which to retrieve time slots.
+     * @param - Date and time for which to retrieve a time slot in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format.
+     * @param - Size of the party that needs to be seated during this time slot.
+     *
+     * Min: `1`
+     * @param - Options for retrieving the time slots.
+     */
+    (reservationLocationId: string, date: Date, partySize: number | null, options?: GetTimeSlotsOptions | undefined): Promise<GetTimeSlotsResponse & GetTimeSlotsResponseNonNullableFields>;
+}
+declare function checkTimeSlot$1(httpClient: HttpClient): CheckTimeSlotSignature;
+interface CheckTimeSlotSignature {
+    /**
+     * Checks a restaurant's availability to accommodate a reservation for a given party size in a given time slot.
+     *
+     * This endpoint returns availability information for the restaurant's table combinations, and flags any party pacing or seat pacing conflicts that the proposed reservation would cause.
+     * @param - ID of the reservation location for which to check the time slot.
+     */
+    (reservationLocationId: string, options?: CheckTimeSlotOptions | undefined): Promise<CheckTimeSlotResponse & CheckTimeSlotResponseNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 

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

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /** The reservation domain object. */
 interface Reservation {
     /**
@@ -1412,60 +1456,159 @@ interface ReservationsQueryBuilder {
     find: () => Promise<ReservationsQueryResult>;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
+interface CreateReservationSignature {
+    /**
+     * Creates a new reservation.
+     *
+     * `createReservation()` accepts and requires different fields depending on the `status` provided and your permissions.
+     *
+     * **Status and source**
+     *
+     * If a `status` is not provided, it will be set to:
+     * * `RESERVED` if manual approval is not required for confirmation
+     * * `REQUESTED` if manual approval is required for confirmation.
+     *
+     * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
+     * Attempting to create a reservation without these fields will result in an error.
+     *
+     * **Permissions**
+     *
+     * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
+     *
+     * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
+     *
+     *
+     *  > **Note:** `createReservation()` requires all details of the reservation upfront. The process of creating a reservation can be broken up using `createHeldReservation`.  `createHeldReservation` creates a temporary reservation that expires automatically unless it is completed with the addition of more details using `reserveReservation()`.
+     * @param - Reservation details.
+     * @param - Options for creating the reservation.
+     * @returns Reservation.
+     */
+    (reservation: Reservation, options?: CreateReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getReservation$1(httpClient: HttpClient): GetReservationSignature;
+interface GetReservationSignature {
+    /**
+     * Retrieves a reservation.
+     *
+     * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
+     * @param - Reservation ID.
+     * @returns Reservation.
+     */
+    (reservationId: string, options?: GetReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
+}
+declare function updateReservation$1(httpClient: HttpClient): UpdateReservationSignature;
+interface UpdateReservationSignature {
+    /**
+     * Updates a reservation.
+     *
+     * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, and `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
+     *
+     * Each time the reservation is updated, revision increments by 1. The existing revision must be included when updating the reservation. This ensures you're working with the latest reservation information, and it prevents unintended overwrites.
+     * @param - Reservation ID.
+     * @param - Options for updating the reservation.
+     * @param - Reservation information to update.
+     * @returns Reservation.
+     */
+    (_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions | undefined): Promise<Reservation & ReservationNonNullableFields>;
+}
+declare function createHeldReservation$1(httpClient: HttpClient): CreateHeldReservationSignature;
+interface CreateHeldReservationSignature {
+    /**
+     * Creates a new temporary reservation and holds it for the customer for 10 minutes.
+     *
+     * Creates a new reservation with the `HELD` status. `HELD` reservations are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error.
+     *
+     * You cannot call `updateReservation()` to change a reservation’s status from `HELD`. Trying to do so returns an error. Instead, you should use `reserveReservation()`.
+     *
+     * If you do not wish to have `HELD` reservations in your flow, you can create a reservation with all required details using `createReservation()`.
+     *
+     * @param - Held reservation information to update.
+     */
+    (reservationDetails: HeldReservationDetails): Promise<CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields>;
+}
+declare function reserveReservation$1(httpClient: HttpClient): ReserveReservationSignature;
+interface ReserveReservationSignature {
+    /**
+     * Reserves or requests a held reservation.
+     *
+     * Held reservations are temporary reservations with the `HELD` status created by `createHeldReservation()`.
+     *
+     * They are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to call `Reserve Reservation` with a held reservation older than 10 minutes returns an error.
+     *
+     * `Reserve Reservation` changes a reservation's `HELD` status to:
+     * * `RESERVED` if the reservation's reservation location does not require manual approval.
+     * * `REQUESTED` if the reservation's reservation location requires manual approval.
+     * @param - Reservation ID.
+     * @param - Reservee details.
+     * @param - Revision number.
+     *
+     * Include the existing `revision` to prevent conflicting updates to reservations.
+     */
+    (reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
+}
+declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
+interface CancelReservationSignature {
+    /**
+     * Cancels a reservation.
+     *
+     * Sets the reservation status to `CANCELED`.
+     * @param - Reservation ID.
+     * @param - Revision number.
+     *
+     * Include 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>;
+}
+declare function deleteReservation$1(httpClient: HttpClient): DeleteReservationSignature;
+interface DeleteReservationSignature {
+    /**
+     * Deletes a reservation. Only reservations with the `HELD` status can be deleted.
+     * @param - Reservation ID.
+     */
+    (reservationId: string): Promise<void>;
+}
+declare function listReservations$1(httpClient: HttpClient): ListReservationsSignature;
+interface ListReservationsSignature {
+    /**
+     * Retrieves a list of up to 100 reservations.
+     * @param - Options for listing the reservations.
+     */
+    (options?: ListReservationsOptions | undefined): Promise<ListReservationsResponse & ListReservationsResponseNonNullableFields>;
+}
+declare function queryReservations$1(httpClient: HttpClient): QueryReservationsSignature;
+interface QueryReservationsSignature {
+    /**
+     * Creates a query to retrieve a list of reservations.
+     *
+     * The `queryReservations()` function builds a query to retrieve a list of reservations and returns a [`ReservationsQueryBuilder`](/reservations/reservations-query-builder) object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the [find()](/reservations/reservations-query-builder/find) function.
+     *
+     * You can refine the query by chaining `ReservationsQueryBuilder` functions onto the query. `ReservationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryReservations()` returns.
+     *
+     * `queryReservations()` runs with the following `ReservationsQueryBuilder` defaults, which you can override:
+     *
+     * * [`skip(0)`](/reservations/reservations-query-builder/skip)
+     * * [`limit(50)`](/reservations/reservations-query-builder/limit)
+     * * [`descending('_createdDate')`](/reservations/reservations-query-builder/descending)
+     *
+     * The following `ReservationsQueryBuilder` functions are supported for `queryReservations()`. For a full description of the reservation object, see the object returned for the [`items`](/reservations/reservations-query-builder/items) property in [`ReservationsQueryResult`](/reservations/reservations-query-result).
+     */
+    (): ReservationsQueryBuilder;
+}
+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.
+     *
+     * You can also use this endpoint 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.
+     */
+    (search: CursorSearch): Promise<SearchReservationsResponse & SearchReservationsResponseNonNullableFields>;
 }
-
-declare function createReservation$1(httpClient: HttpClient): (reservation: Reservation, options?: CreateReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function getReservation$1(httpClient: HttpClient): (reservationId: string, options?: GetReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function updateReservation$1(httpClient: HttpClient): (_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions) => Promise<Reservation & ReservationNonNullableFields>;
-declare function createHeldReservation$1(httpClient: HttpClient): (reservationDetails: HeldReservationDetails) => Promise<CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields>;
-declare function reserveReservation$1(httpClient: HttpClient): (reservationId: string, reservee: Reservee, revision: string | null) => Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
-declare function cancelReservation$1(httpClient: HttpClient): (reservationId: string, revision: string | null, options?: CancelReservationOptions) => Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
-declare function deleteReservation$1(httpClient: HttpClient): (reservationId: string) => Promise<void>;
-declare function listReservations$1(httpClient: HttpClient): (options?: ListReservationsOptions) => Promise<ListReservationsResponse & ListReservationsResponseNonNullableFields>;
-declare function queryReservations$1(httpClient: HttpClient): () => ReservationsQueryBuilder;
-declare function searchReservations$1(httpClient: HttpClient): (search: CursorSearch) => Promise<SearchReservationsResponse & SearchReservationsResponseNonNullableFields>;
 declare const onReservationCreated$1: EventDefinition<ReservationCreatedEnvelope, "wix.table_reservations.v1.reservation_created">;
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -1494,6 +1637,9 @@ type _publicSearchReservationsType = typeof searchReservations$1;
 declare const searchReservations: ReturnType<typeof createRESTModule$2<_publicSearchReservationsType>>;
 
 type _publicOnReservationCreatedType = typeof onReservationCreated$1;
+/**
+ * Triggered when a held reservation is created.
+ */
 declare const onReservationCreated: ReturnType<typeof createEventModule$1<_publicOnReservationCreatedType>>;
 
 type index_d$2_Aggregation = Aggregation;
@@ -3779,10 +3925,65 @@ interface ListReservationLocationsOptions {
     fieldsets?: Set[];
 }
 
-declare function getReservationLocation$1(httpClient: HttpClient): (reservationLocationId: string, options?: GetReservationLocationOptions) => Promise<ReservationLocation & ReservationLocationNonNullableFields>;
-declare function updateReservationLocation$1(httpClient: HttpClient): (_id: string | null, reservationLocation: UpdateReservationLocation) => Promise<ReservationLocation & ReservationLocationNonNullableFields>;
-declare function queryReservationLocations$1(httpClient: HttpClient): (options?: QueryReservationLocationsOptions) => ReservationLocationsQueryBuilder;
-declare function listReservationLocations$1(httpClient: HttpClient): (options?: ListReservationLocationsOptions) => Promise<ListReservationLocationsResponse & ListReservationLocationsResponseNonNullableFields>;
+declare function getReservationLocation$1(httpClient: HttpClient): GetReservationLocationSignature;
+interface GetReservationLocationSignature {
+    /**
+     * Retrieves a reservation location by ID.
+     *
+     * The `FULL` fieldset can only be retrieved by users with the `READ RESERVATION LOCATIONS (FULL)` or `MANAGE RESERVATION LOCATIONS` permission scopes.
+     * @param - ID of the ReservationLocation to retrieve.
+     * @param - An object representing the available options for retrieving a reservation location.
+     * @returns The retrieved reservation location.
+     */
+    (reservationLocationId: string, options?: GetReservationLocationOptions | undefined): Promise<ReservationLocation & ReservationLocationNonNullableFields>;
+}
+declare function updateReservationLocation$1(httpClient: HttpClient): UpdateReservationLocationSignature;
+interface UpdateReservationLocationSignature {
+    /**
+     * Updates a reservation location. Supports partial updates.
+     *
+     * Each time the reservation location is updated, `revision` increments by 1. The existing revision must be included when updating the reservation location. This ensures you're working with the latest reservation location information, and it prevents unintended overwrites.
+     *
+     * You cannot use this endpoint to change a reservation location's `location` object. Attempting to do so will cause the server to return an application error.
+     * @param - Reservation location ID.
+     * @param - Reservation location information to update.
+     * @returns The updated reservation location.
+     */
+    (_id: string | null, reservationLocation: UpdateReservationLocation): Promise<ReservationLocation & ReservationLocationNonNullableFields>;
+}
+declare function queryReservationLocations$1(httpClient: HttpClient): QueryReservationLocationsSignature;
+interface QueryReservationLocationsSignature {
+    /**
+     * Creates a query to retrieve a list of reservation locations.
+     *
+     *
+     * The `queryReservationLocations()` function builds a query to retrieve a list of reservation locations and returns a [`ReservationLocationsQueryBuilder`](/reservation-locations/reservation-locations-query-builder/) object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the [find()](/reservation-locations/reservation-locations-query-builder/find) function.
+     *
+     * You can refine the query by chaining `ReservationLocationsQueryBuilder` functions onto the query. `ReservationLocationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryReservationLocations()` returns.
+     *
+     * `queryReservationLocations()` runs with the following `ReservationLocationsQueryBuilder` defaults, which you can override:
+     *
+     * * [`skip(0)`](/reservation-locations/reservation-locations-query-builder/skip)
+     * * [`limit(50)`](/reservation-locations/reservation-locations-query-builder/limit)
+     * * [`descending('_createdDate')`](/reservation-locations/reservation-locations-query-builder/descending)
+     *
+     * The following `ReservationLocationsQueryBuilder` functions are supported for `queryReservationLocations()`. For a full description of the reservation location object, see the object returned for the [`items`](/reservation-locations/reservation-locations-query-result/items) property in [`ReservationLocationsQueryResult`](/reservation-locations/reservation-locations-query-result).
+     * @param - An object representing the available options for querying reservation locations.
+     */
+    (options?: QueryReservationLocationsOptions | undefined): ReservationLocationsQueryBuilder;
+}
+declare function listReservationLocations$1(httpClient: HttpClient): ListReservationLocationsSignature;
+interface ListReservationLocationsSignature {
+    /**
+     * Retrieves a list of up to 100 reservation locations.
+     *
+     * The `FULL` fieldset can only be retrieved by users with the `READ RESERVATION LOCATIONS (FULL)` or `MANAGE RESERVATION LOCATIONS` permission scopes.
+     * @param - An object representing the available options for listing reservation locations.
+     */
+    (options?: ListReservationLocationsOptions | undefined): Promise<ListReservationLocationsResponse & ListReservationLocationsResponseNonNullableFields>;
+}
 declare const onReservationLocationUpdated$1: EventDefinition<ReservationLocationUpdatedEnvelope, "wix.table_reservations.v1.reservation_location_updated">;
 declare const onReservationLocationCreated$1: EventDefinition<ReservationLocationCreatedEnvelope, "wix.table_reservations.v1.reservation_location_created">;
 
@@ -3800,9 +4001,15 @@ type _publicListReservationLocationsType = typeof listReservationLocations$1;
 declare const listReservationLocations: ReturnType<typeof createRESTModule$1<_publicListReservationLocationsType>>;
 
 type _publicOnReservationLocationUpdatedType = typeof onReservationLocationUpdated$1;
+/**
+ * Triggered when a reservation location is updated.
+ */
 declare const onReservationLocationUpdated: ReturnType<typeof createEventModule<_publicOnReservationLocationUpdatedType>>;
 
 type _publicOnReservationLocationCreatedType = typeof onReservationLocationCreated$1;
+/**
+ * Triggered when a reservation location is updated.
+ */
 declare const onReservationLocationCreated: ReturnType<typeof createEventModule<_publicOnReservationLocationCreatedType>>;
 
 type index_d$1_ActionEvent = ActionEvent;
@@ -4223,8 +4430,37 @@ interface CheckTimeSlotOptions {
     excludeReservationId?: string | null;
 }
 
-declare function getTimeSlots$1(httpClient: HttpClient): (reservationLocationId: string, date: Date, partySize: number | null, options?: GetTimeSlotsOptions) => Promise<GetTimeSlotsResponse & GetTimeSlotsResponseNonNullableFields>;
-declare function checkTimeSlot$1(httpClient: HttpClient): (reservationLocationId: string, options?: CheckTimeSlotOptions) => Promise<CheckTimeSlotResponse & CheckTimeSlotResponseNonNullableFields>;
+declare function getTimeSlots$1(httpClient: HttpClient): GetTimeSlotsSignature;
+interface GetTimeSlotsSignature {
+    /**
+     * Returns a list of time slots at a given restaurant on a given `date`, and their availability for a given `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`.
+     *
+     * 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 `startDate`s of time slots in the response are 15 minutes apart regardless of the `duration` provided.
+     * @param - ID of the reservation location for which to retrieve time slots.
+     * @param - Date and time for which to retrieve a time slot in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format.
+     * @param - Size of the party that needs to be seated during this time slot.
+     *
+     * Min: `1`
+     * @param - Options for retrieving the time slots.
+     */
+    (reservationLocationId: string, date: Date, partySize: number | null, options?: GetTimeSlotsOptions | undefined): Promise<GetTimeSlotsResponse & GetTimeSlotsResponseNonNullableFields>;
+}
+declare function checkTimeSlot$1(httpClient: HttpClient): CheckTimeSlotSignature;
+interface CheckTimeSlotSignature {
+    /**
+     * Checks a restaurant's availability to accommodate a reservation for a given party size in a given time slot.
+     *
+     * This endpoint returns availability information for the restaurant's table combinations, and flags any party pacing or seat pacing conflicts that the proposed reservation would cause.
+     * @param - ID of the reservation location for which to check the time slot.
+     */
+    (reservationLocationId: string, options?: CheckTimeSlotOptions | undefined): Promise<CheckTimeSlotResponse & CheckTimeSlotResponseNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;