@wix/auto_sdk_bookings_availability-time-slots 1.0.155 → 1.0.157

package/build/cjs/index.d.ts

@@ -6,87 +6,50 @@ type TimeSlotNonNullablePaths = `location.locationType` | `availableResources` |
 declare function listAvailabilityTimeSlots$1(httpClient: HttpClient): ListAvailabilityTimeSlotsSignature;
 interface ListAvailabilityTimeSlotsSignature {
     /**
-     * Retrieves a list of `TimeSlot`s that match the provided filters.
-     *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong>
-     * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
-     * </blockquote>
-     *
-     * The request body __must__ include either:
-     * + All of the following filters:  `serviceId`, `fromLocalDate`, `toLocalDate`, and `timeZone`.
-     * You may add additional filters as you wish.
-     * + A `cursorPaging` with a valid `cursor` from previous response.
-     *
-     *
-     * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response
-     * represents the availability of the service in a specific location,
-     * and has a `localStartDate` within the range of the provided `fromLocalDate` and `toLocalDate` exclusive.
-     * The `localEndDate` of a `TimeSlot` is calculated as the sum of the `TimeSlot`'s `localStartDate` and the duration of the service.
-     *
-     * By default,
-     * the response contains at most 1000 results.
-     * If there are more than 1000 results, we return a `cursorPagingMetadata` with
-     * a cursor for the next page of results, regardless of whether a `cursorPaging`
-     * was provided in request.
-     *
-     * ### AvailableResources in response
-     * The `TimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service
-     * within the time slot. Each `AvailableResources` contains information about available resources of the same type.
-     *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong><br/>
-     * By default,
-     * if you don't specify <code class="grey-background">includeResourceTypeIds</code>
-     * or <code class="grey-background">resourceIds</code> filters in request,
-     * we return TimeSlots with an empty <code class="grey-background">AvailableResources</code>.
-     * <br/><strong>Note:</strong><br/> Not specifying resources filters can be handy in case you want to avoid large response in flows that only
-     * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-the-selected-service-is-available-for)
-     * is an example for such flow.
-     * </p>
-     * </blockquote>
-     *
-     * If you wish to get a list of available resources for each `TimeSlot` you should either:
-     * + provide `resourceIds` in request.
-     * + provide `includeResourceTypeIds` in request.
-     *
-     * __Notes:__
-     * + In both cases the returned TimeSlots contains  __up__ to 10 `AvailableResources` that match the provided filters.
-     * Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.
-     * + If an `AvailableResources` has more available resources which are not listed within it,
-     * we return `AvailableResources`.`hasMoreAvailableResources` as true.
-     * > __Note:__
-     * > If you wish to get the full available resources list for a specific `TimeSlot`,
-     * > you should call [GetAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/get-availability-time-slot).
-     *
-     *
-     * ### Availability VS Bookability
-     * An `available` time slot is not necessarily `bookable`.
-     * The `bookable` field of a `TimeSlot` indicates whether a customer can book the service within the given time slot,
-     * at a specific period of time.
-     * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/introduction#all-apis_wix-service-availability_service-availability-time-slots_introduction_availability-vs-bookability).
-     *
-     * By default,
-     * + The response does not contains `unavailable` TimeSlots.
-     * For example,
-     * if there are no available resources to provide the service from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`,
-     * we don't return TimeSlots with `localStartDate` within this range.
-     * + The response contains both `bookable` and `un-bookable` TimeSlots.
-     * For example,
-     * if the service has a booking policy which enforces booking the service up to 10 minutes before the session starts,
-     * we return TimeSlots with the violating `localStartDate` with `bookable` as false.
-     * If you wish to list only available __bookable__ TimeSlots you should pass `bookable` filter as true.
-     *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong>
-     * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.
-     * Read more about <a href="https://bo.wix.com/wix-docs/rest/all-apis/service-availability/availability-time-slots/introduction?localViewerId=inbari#all-apis_service-availability_availability-time-slots_introduction_daylight-saving-time-dst-handling">DST Handling</a></p>
-     * </blockquote>
-     *
-     *
-     * ### ListAvailabilityTimeSlots runs with the following defaults
-     * + `localStartDate` is sorted in `ASC` order
-     * + `cursorPaging`.`limit` is `1000`
+     * Retrieves a list of appointment time slots that match the provided filters.
+     *
+     *
+     * ## Defaults
+     *
+     * List Availability Time Slots uses the following defaults:
+     *
+     * - Sorts time slots by `localStartDate` in ascending order.
+     * - `cursorPaging.limit` set to `1000`.
+     * - Returns both bookable and un-bookable time slots.
+     * - If `bookable` filter isn't specified, bookable slots are returned first.
+     * - Wix Bookings uses the current time as the default for `fromLocalDate`.
+     *
+     * ## Filtering behavior
+     *
+     * The method automatically filters time slots:
+     *
+     * - **Past time slots**: Only time slots starting from the specified `fromLocalDate` are included. When you omit `fromLocalDate`, Wix Bookings uses the current time as the default.
+     * - **Resource availability**: Only time slots with at least some available resources are returned.
+     *
+     * ## Service type limitations
+     *
+     * Only appointment-based services are supported when calling List Availability Time Slots.
+     *
+     * To retrieve class availability, you can call List Event Time Slots([SDK](https://dev.wix.com/docs/rest/business-solutions/bookings/event-time-slots/list-event-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-event-time-slots)).
+     *
+     * To retrieve course availability, you can follow the End-to-End Booking Flow for course([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/end-to-end-booking-flow#book-a-course) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flow#book-a-course)).
+     *
+     * ## Available resources
+     *
+     * Time slots aren't returned when they have no available resources.
+     *
+     * Each time slots include details for up to 10 available resources.
+     * If there are more than 10 resources, you can call Get Availability Time Slots ([SDK](https://dev.wix.com/docs/rest/business-solutions/bookings/availability/availability-time-slots/get-availability-time-slot) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/availability/availability-time-slots/get-availability-time-slot)) filtering by the resource Type ID to get details for the remaining resources.
+     *
+     * ## Business hours exception
+     *
+     * Wix Bookings disregards business opening hours when all of the following conditions are met:
+     *
+     * 1. 1 or more staff members ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)) are needed to provide the service.
+     * 2. No other resource type ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/resource-types-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) is needed to provide the service.
+     * 3. The service doesn't have duration-based variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/service-options-and-variants/introduction)).
+     *
+     * In these cases, the working hours of the relevant staff member are used instead for availability calculation.
      */
     (options?: ListAvailabilityTimeSlotsOptions): Promise<NonNullablePaths<ListAvailabilityTimeSlotsResponse, {
         [P in TimeSlotNonNullablePaths]: `timeSlots.${number}.${P}`;
@@ -97,46 +60,49 @@ interface ListAvailabilityTimeSlotsSignature {
 declare function getAvailabilityTimeSlot$1(httpClient: HttpClient): GetAvailabilityTimeSlotSignature;
 interface GetAvailabilityTimeSlotSignature {
     /**
-     * Retrieves an available `TimeSlot` that match the provided filters.
+     * Retrieves detailed information about a specific appointment time slot.
+     *
+     *
+     * Call this method to get complete resource availability after finding a suitable slot with List Availability Time Slots ([SDK](https://dev.wix.com/docs/rest/business-solutions/bookings/availability/availability-time-slots/list-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/availability/availability-time-slots/list-availability-time-slots)).
+     *
+     * ## Defaults
+     *
+     * Get Availability Time Slot uses the following defaults:
+     *
+     * - Returns all available resources unless filtered by `resourceIds` or `includeResourceTypeIds`.
+     * - Includes full booking status and capacity details
+     *
+     * ## Service type limitations
+     *
+     * Only appointment-based services are supported when calling Get Availability Time Slot.
      *
-     * Throws `SlotNotFound` if there is no such available time slot.
+     * To retrieve class session availability, you can call Get Event Time Slot ([SDK](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/get-event-time-slot) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/get-event-time-slot)).
      *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong><br/>
-     * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
-     * </blockquote>
+     * To retrieve course availability, you can follow the End-to-End Booking Flow for courses ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/end-to-end-booking-flows#book-a-course) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flow#book-a-course)).
      *
-     * By default,
-     * if you don't provide `includeResourceTypeIds` or `resourceIds` in request,
-     * we return all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide
-     * the service within the time slot.
+     * ## Business hours exception
      *
-     * If you specify `includeResourceTypeIds` or `resourceIds` in request,
-     * the returned `TimeSlot` will contain only `AvailableResources` with at least one available resource
-     * which match the given resources filters,
-     * each contains all available resources out of those requested.
+     * Wix Bookings disregards business opening hours when all of the following conditions are met:
      *
+     * 1. 1 or more staff members ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)) are needed to provide the service.
+     * 2. No other resource type ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/resource-types-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) is needed to provide the service.
+     * 3. The service doesn't have duration-based variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/service-options-and-variants/introduction)).
      *
-     * <blockquote class="tip">
-     * <p><strong>Tip:</strong><br/>
-     * Use this API in order to get the availability of a specific <code class="grey-background">TimeSlot</code> out of those returned from  <code class="grey-background">ListAvailabilityTimeSlots</code> API.</p>
-     * </blockquote>
+     * In these cases, the working hours of the relevant staff member are used instead for availability calculation.
      * @param - Service ID of the time slot.
-     * Currently supported only for services of type `APPOINTMENT`.
-     * @param - Local start date of the time slot, in ISO-8601 format.
-     * For example, "2024-01-30T13:30:00".
-     * @param - Local end date of the time slot, in ISO-8601 format.
-     * For example, "2024-01-30T14:30:00".
-     * @param - Time zone, in IANA time zone format.
-     * @param - The location of the time slot.
-     *
-     * You must provide a specific `locationType`.
-     * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
-     *
-     * <blockquote class="warning">
-     * <p>Supports filtering by location type, or by location ID.
-     * Other fields like <code class="grey-background">name</code> are ignored.</p>
-     * </blockquote>
+     * You must specify the ID of an appointment-based service.
+     * @param - Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2026-01-30T13:30:00`.
+     * @param - Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2026-01-30T13:30:00`.
+     * @param - Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
+     * For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/site-properties/properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * @param - Location to filter time slots by.
+     *
+     * For business locations, you must specify a location ID.
+     * When specifying a location ID, all other location field filters are ignored.
      */
     (serviceId: string, localStartDate: string, localEndDate: string, timeZone: string, location: Location, options?: GetAvailabilityTimeSlotOptions): Promise<NonNullablePaths<GetAvailabilityTimeSlotResponse, {
         [P in TimeSlotNonNullablePaths]: `timeSlot.${P}`;