@wix/auto_sdk_bookings_availability-time-slots 1.0.252 → 1.0.253

package/build/cjs/index.typings.d.ts

@@ -115,7 +115,6 @@ interface TimeSlot {
     scheduleId?: string | null;
     /**
      * Whether this time slot spans one or more full days.
-     * Populated only for class- and course-based services. Not populated for appointment-based services.
      * When `true`, `localStartDate` is `00:00:00` of the first day and `localEndDate` is `00:00:00` of the day after the last day (exclusive).
      * Midnight boundaries are interpreted in the event's `timeZone`.
      * The time component should be ignored for display purposes.
@@ -739,6 +738,8 @@ interface ListAvailabilityTimeSlotsRequest {
      * Selected customer choices for service configuration.
      * If not specified, uses the service's default configuration.
      *
+     * Not supported for services configured with a duration range (`availabilityConstraints.durationRange`).
+     *
      * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
      */
     customerChoices?: CustomerChoices;
@@ -796,52 +797,39 @@ interface ListAvailabilityTimeSlotsResponse {
 }
 interface ListAvailabilityTimeSlotEndOptionsRequest {
     /**
-     * Service ID. Must be an appointment-based service whose
-     * `availabilityConstraints.durationRange` is configured. Call
-     * [Get Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/get-service)
-     * from Services V2 to check `availabilityConstraints.durationRange` before
-     * invoking this method.
+     * [Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) ID. Must be an appointment-based service configured with `availabilityConstraints.durationRange.hourConfig`.
      * @format GUID
      */
     serviceId: string;
     /**
-     * The picked start time. Each returned end option pairs with this start.
+     * Selected start time in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-03-23T10:00:00`.
+     * Each returned end option shares this start time.
      * @format LOCAL_DATE_TIME
      */
     localStartDate: string;
     /**
-     * Latest end time to include. Default: `localStartDate + maxDurationInMinutes`
-     * from the service's `durationRange.hourConfig` (read from Services V2).
-     * A tighter value is honored; `maxDurationInMinutes` always bounds the
-     * result.
+     * Latest end time to include in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-03-23T14:00:00`.
+     * The service's maximum duration always caps the result, even if a later value is specified.
+     *
+     * Default: `localStartDate` plus the service's maximum duration from `durationRange.hourConfig`.
      * @format LOCAL_DATE_TIME
      */
     maxLocalEndDate?: string | null;
     /**
-     * IANA time zone. Default: site `timeZone` property.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
      * @minLength 1
      * @maxLength 150
      */
     timeZone?: string | null;
-    /**
-     * Location of the picked start. Required; must match the location of the
-     * `localStartDate` slot returned by `ListAvailabilityTimeSlots`. The handler
-     * validates that end options reachable from this start at this location.
-     */
+    /** Location of the selected start time. Must match the location of the slot returned by [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots). */
     location: Location;
     /**
      * Resource types to constrain the end options.
-     * When the customer has already picked a resource before the end time
-     * (e.g. flows that select a resource first, then start, then end), pass the
-     * selected resource here so the response surfaces only ends that the
-     * chosen resource can actually cover. Without this filter, the response
-     * reflects the resource pool — ends valid for the pool but not for a
-     * preselected resource would still be returned, and booking would fail
-     * later.
-     *
-     * Omit when no resource has been preselected. In that case, end options
-     * reflect any resource in the pool; pick the resource later via
-     * `GetAvailabilityTimeSlot` with the chosen `localEndDate`.
+     * When the customer has already selected a resource before choosing an end time, pass that resource here so the response only includes end times the selected resource can cover.
+     *
+     * If no resource has been preselected, omit this field. End options then reflect the full resource pool. Select the resource later by calling [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot) with the chosen `localEndDate`.
      * @maxSize 3
      */
     resourceTypes?: ResourceType[];
@@ -849,14 +837,12 @@ interface ListAvailabilityTimeSlotEndOptionsRequest {
 interface ListAvailabilityTimeSlotEndOptionsResponse {
     /**
      * Available end options for the requested start.
-     * Each entry is a `TimeSlot` sharing `localStartDate` with the request
-     * and varying only in `localEndDate`. Sorted by `localEndDate` ascending
-     * (shortest duration first).
-     * See `TimeSlot` field notes for the constrained semantics of this response.
+     * Each entry is a `TimeSlot` sharing `localStartDate` with the request and varying only in `localEndDate`.
+     * Sorted by `localEndDate` in ascending order (shortest duration first).
      * @maxSize 1000
      */
     endOptions?: TimeSlot[];
-    /** IANA time zone, echoed from the request or resolved from the site default. */
+    /** Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`. */
     timeZone?: string | null;
 }
 interface GetAvailabilityTimeSlotRequest {
@@ -1209,6 +1195,8 @@ type GetAvailabilityTimeSlotApplicationErrors = {
  *
  * Use `customerChoices` to calculate availability based on the customer's selected service duration or add-ons.
  *
+ * `customerChoices` is not supported for services configured with a duration range (`availabilityConstraints.durationRange`). For these services, availability is calculated based on the duration range configuration.
+ *
  * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` in `customerChoices` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
  *
  * ### Business hours exception
@@ -1305,6 +1293,8 @@ interface ListAvailabilityTimeSlotsOptions {
      * Selected customer choices for service configuration.
      * If not specified, uses the service's default configuration.
      *
+     * Not supported for services configured with a duration range (`availabilityConstraints.durationRange`).
+     *
      * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
      */
     customerChoices?: CustomerChoices;
@@ -1316,45 +1306,71 @@ interface ListAvailabilityTimeSlotsOptions {
      */
     resourceTypes?: ResourceType[];
 }
+/**
+ * Retrieves the available end times for a selected start time of an appointment-based service configured with a duration range.
+ *
+ *
+ * Call this after the customer selects a start time with [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots). Each returned entry is a `TimeSlot` that shares the requested `localStartDate` and differs only in `localEndDate`. The response doesn't include resource lists.
+ *
+ * Only supported for hourly duration-range services (services with `availabilityConstraints.durationRange.hourConfig` configured in [Services V2](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction)). Calling this for a fixed-duration or daily duration-range service returns `END_OPTIONS_NOT_SUPPORTED`.
+ *
+ * ### Resource selection
+ *
+ * Resource selection depends on the booking flow:
+ * - If the customer hasn't selected a resource yet, call [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot) with the selected `localEndDate` to retrieve candidate resources before booking.
+ * - If the customer selected a resource before the end time, pass that resource in `resourceTypes` so the response only includes end times that the selected resource can cover.
+ *
+ * ### Time slot shape
+ *
+ * The response uses the `TimeSlot` model with constrained semantics:
+ * - `localStartDate` and `location` are identical on every entry, echoing the request.
+ * - `localEndDate` varies across entries and represents each end option.
+ * - `availableResources` is always empty. Use [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot) to retrieve resources for a selected end time.
+ * - `eventInfo`, `nestedTimeSlots`, and `allDay` are not populated.
+ * - `totalCapacity` is always `1`.
+ * @param serviceId - [Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) ID. Must be an appointment-based service configured with `availabilityConstraints.durationRange.hourConfig`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.localStartDate
+ * @requiredField options.location
+ * @requiredField serviceId
+ * @permissionId BOOKINGS.AVAILABILITY_READ_TIME_SLOTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.bookings.availability.v2.AvailabilityTimeSlots.ListAvailabilityTimeSlotEndOptions
+ */
+declare function listAvailabilityTimeSlotEndOptions(serviceId: string, options?: NonNullablePaths<ListAvailabilityTimeSlotEndOptions, `localStartDate` | `location`, 2>): Promise<NonNullablePaths<ListAvailabilityTimeSlotEndOptionsResponse, `endOptions` | `endOptions.${number}.location.locationType`, 5> & {
+    __applicationErrorsType?: ListAvailabilityTimeSlotEndOptionsApplicationErrors;
+}>;
 interface ListAvailabilityTimeSlotEndOptions {
     /**
-     * The picked start time. Each returned end option pairs with this start.
+     * Selected start time in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-03-23T10:00:00`.
+     * Each returned end option shares this start time.
      * @format LOCAL_DATE_TIME
      */
     localStartDate: string;
     /**
-     * Latest end time to include. Default: `localStartDate + maxDurationInMinutes`
-     * from the service's `durationRange.hourConfig` (read from Services V2).
-     * A tighter value is honored; `maxDurationInMinutes` always bounds the
-     * result.
+     * Latest end time to include in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-03-23T14:00:00`.
+     * The service's maximum duration always caps the result, even if a later value is specified.
+     *
+     * Default: `localStartDate` plus the service's maximum duration from `durationRange.hourConfig`.
      * @format LOCAL_DATE_TIME
      */
     maxLocalEndDate?: string | null;
     /**
-     * IANA time zone. Default: site `timeZone` property.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
      * @minLength 1
      * @maxLength 150
      */
     timeZone?: string | null;
-    /**
-     * Location of the picked start. Required; must match the location of the
-     * `localStartDate` slot returned by `ListAvailabilityTimeSlots`. The handler
-     * validates that end options reachable from this start at this location.
-     */
+    /** Location of the selected start time. Must match the location of the slot returned by [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots). */
     location: Location;
     /**
      * Resource types to constrain the end options.
-     * When the customer has already picked a resource before the end time
-     * (e.g. flows that select a resource first, then start, then end), pass the
-     * selected resource here so the response surfaces only ends that the
-     * chosen resource can actually cover. Without this filter, the response
-     * reflects the resource pool — ends valid for the pool but not for a
-     * preselected resource would still be returned, and booking would fail
-     * later.
-     *
-     * Omit when no resource has been preselected. In that case, end options
-     * reflect any resource in the pool; pick the resource later via
-     * `GetAvailabilityTimeSlot` with the chosen `localEndDate`.
+     * When the customer has already selected a resource before choosing an end time, pass that resource here so the response only includes end times the selected resource can cover.
+     *
+     * If no resource has been preselected, omit this field. End options then reflect the full resource pool. Select the resource later by calling [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot) with the chosen `localEndDate`.
      * @maxSize 3
      */
     resourceTypes?: ResourceType[];
@@ -1370,7 +1386,7 @@ interface ListAvailabilityTimeSlotEndOptions {
  * 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
+ * - Includes full booking status and capacity details.
  *
  * ### Service type limitations
  *
@@ -1380,6 +1396,10 @@ interface ListAvailabilityTimeSlotEndOptions {
  *
  * To retrieve course availability, you can follow the [End-to-End Booking Flow for courses](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows#book-a-course).
  *
+ * ### Duration-range services
+ *
+ * For services configured with a duration range (`availabilityConstraints.durationRange`), `customerChoices` is not supported. The duration is derived from the `localStartDate` and `localEndDate` specified in the request.
+ *
  * ### Business hours exception
  *
  * Wix Bookings disregards business opening hours when all of the following conditions are met:
@@ -1433,4 +1453,4 @@ interface GetAvailabilityTimeSlotOptions {
     resourceTypes?: ResourceType[];
 }
 
-export { type AvailableResources, type BookingPolicyViolations, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomerChoices, type DiagnoseAvailabilityRequest, type DiagnoseAvailabilityResponse, type DiagnosisReason, type EventInfo, type GetAvailabilityTimeSlotApplicationErrors, type GetAvailabilityTimeSlotOptions, type GetAvailabilityTimeSlotRequest, type GetAvailabilityTimeSlotRequestCustomerChoices, type GetAvailabilityTimeSlotResponse, type GetEventTimeSlotRequest, type GetEventTimeSlotResponse, type GetMultiServiceAvailabilityTimeSlotRequest, type GetMultiServiceAvailabilityTimeSlotResponse, type ListAvailabilityTimeSlotEndOptions, type ListAvailabilityTimeSlotEndOptionsApplicationErrors, type ListAvailabilityTimeSlotEndOptionsRequest, type ListAvailabilityTimeSlotEndOptionsResponse, type ListAvailabilityTimeSlotsApplicationErrors, type ListAvailabilityTimeSlotsOptions, type ListAvailabilityTimeSlotsRequest, type ListAvailabilityTimeSlotsResponse, type ListEventTimeSlotsRequest, type ListEventTimeSlotsResponse, type ListMultiServiceAvailabilityTimeSlotsRequest, type ListMultiServiceAvailabilityTimeSlotsResponse, type Location, LocationType, type LocationTypeWithLiterals, type NestedTimeSlot, type NonBookableReasons, ReasonCode, type ReasonCodeWithLiterals, type ResolvedContext, type Resource, type ResourceType, type Service, SuggestedAction, type SuggestedActionWithLiterals, type TimeSlot, type V2CustomerChoices, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlots };
+export { type AvailableResources, type BookingPolicyViolations, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomerChoices, type DiagnoseAvailabilityRequest, type DiagnoseAvailabilityResponse, type DiagnosisReason, type EventInfo, type GetAvailabilityTimeSlotApplicationErrors, type GetAvailabilityTimeSlotOptions, type GetAvailabilityTimeSlotRequest, type GetAvailabilityTimeSlotRequestCustomerChoices, type GetAvailabilityTimeSlotResponse, type GetEventTimeSlotRequest, type GetEventTimeSlotResponse, type GetMultiServiceAvailabilityTimeSlotRequest, type GetMultiServiceAvailabilityTimeSlotResponse, type ListAvailabilityTimeSlotEndOptions, type ListAvailabilityTimeSlotEndOptionsApplicationErrors, type ListAvailabilityTimeSlotEndOptionsRequest, type ListAvailabilityTimeSlotEndOptionsResponse, type ListAvailabilityTimeSlotsApplicationErrors, type ListAvailabilityTimeSlotsOptions, type ListAvailabilityTimeSlotsRequest, type ListAvailabilityTimeSlotsResponse, type ListEventTimeSlotsRequest, type ListEventTimeSlotsResponse, type ListMultiServiceAvailabilityTimeSlotsRequest, type ListMultiServiceAvailabilityTimeSlotsResponse, type Location, LocationType, type LocationTypeWithLiterals, type NestedTimeSlot, type NonBookableReasons, ReasonCode, type ReasonCodeWithLiterals, type ResolvedContext, type Resource, type ResourceType, type Service, SuggestedAction, type SuggestedActionWithLiterals, type TimeSlot, type V2CustomerChoices, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlotEndOptions, listAvailabilityTimeSlots };