@wix/auto_sdk_bookings_multi-service-availability-time-slots 1.0.187 → 1.0.189

package/build/internal/es/index.typings.d.mts

@@ -9,7 +9,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
  */
 interface TimeSlot {
     /**
-     * Service ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)).
+     * [Service ID] (https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction).
      *
      * Available only for single-service bookings. For multi-service bookings, this field is empty and individual service IDs are provided in `nestedTimeSlots`.
      * @format GUID
@@ -32,7 +32,7 @@ interface TimeSlot {
      */
     localEndDate?: string | null;
     /**
-     * Whether customers can book the slot according to the service's booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)).
+     * Whether customers can book the slot according to the service's [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction).
      *
      * For multi-service bookings, this is `true` only when all services in the sequence comply with their respective booking policies.
      */
@@ -40,7 +40,7 @@ interface TimeSlot {
     /** Information about where the business provides the service to the customer. */
     location?: Location;
     /**
-     * Information about the event ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)) related to the slot.
+     * Information about the [event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction) related to the slot.
      * Available only for classes. Not available for appointment-based services and courses.
      */
     eventInfo?: EventInfo;
@@ -75,7 +75,7 @@ interface TimeSlot {
      */
     bookingPolicyViolations?: BookingPolicyViolations;
     /**
-     * List of resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) available during the time slot.
+     * List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) available during the time slot.
      *
      * Available only for single-service bookings. For multi-service bookings, resource information is provided in `nestedTimeSlots`.
      */
@@ -99,7 +99,7 @@ interface TimeSlot {
 }
 interface Location {
     /**
-     * Location ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
+     * [Location ID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
      * Available only for business locations.
      * @format GUID
      */
@@ -175,7 +175,7 @@ interface BookingPolicyViolations {
 }
 interface AvailableResources {
     /**
-     * Resource type ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
+     * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
      * @format GUID
      */
     resourceTypeId?: string | null;
@@ -230,7 +230,7 @@ interface NestedTimeSlot {
      */
     localEndDate?: string;
     /**
-     * List of resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) available during the nested time slot.
+     * List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) available during the nested time slot.
      * @maxSize 10
      */
     availableResources?: AvailableResources[];
@@ -286,7 +286,7 @@ interface ListMultiServiceAvailabilityTimeSlotsRequest {
      *
      * Required unless you specify `cursorPaging.cursor`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -304,7 +304,7 @@ interface ListMultiServiceAvailabilityTimeSlotsRequest {
     bookable?: boolean | null;
     /**
      * Indicators for service's booking policy violations.
-     * Allows filtering for time slots with specific violation types based on booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
+     * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
      */
     bookingPolicyViolations?: BookingPolicyViolations;
     /**
@@ -327,7 +327,7 @@ interface Service {
      */
     serviceId?: string;
     /**
-     * Resource type IDs ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) to include in returned time slots.
+     * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
      * This is in addition to the specifically requested resources.
      *
      * <blockquote>
@@ -383,7 +383,7 @@ interface V2CustomerChoices {
 }
 interface ResourceType {
     /**
-     * Resource type ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
+     * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
      * @format GUID
      */
     resourceTypeId?: string | null;
@@ -394,6 +394,16 @@ interface ResourceType {
      * @maxSize 135
      */
     resourceIds?: string[] | null;
+    /**
+     * Whether to return resources of this type in a sorted order.
+     * + `true`: Resources are sorted using the relevant implementor of the [Resource Sorting service plugin](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-sorting-service-plugin/introduction).
+     * + `false`: Resources are returned in an unpredictable, but not entirely random, order.
+     * Sorting is not supported in the [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots) and [List Multi Service Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) methods.
+     *
+     * Default: `false`
+     * @internal
+     */
+    sorted?: boolean | null;
 }
 interface CursorPaging {
     /**
@@ -423,7 +433,7 @@ interface ListMultiServiceAvailabilityTimeSlotsResponse {
     /**
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -474,7 +484,7 @@ interface GetMultiServiceAvailabilityTimeSlotRequest {
      * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -492,7 +502,7 @@ interface GetMultiServiceAvailabilityTimeSlotResponse {
     /**
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -529,7 +539,7 @@ interface ListAvailabilityTimeSlotsRequest {
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -555,7 +565,7 @@ interface ListAvailabilityTimeSlotsRequest {
     bookable?: boolean | null;
     /**
      * Indicators for service's booking policy violations.
-     * Allows filtering for time slots with specific violation types based on booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
+     * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
      */
     bookingPolicyViolations?: BookingPolicyViolations;
     /**
@@ -615,7 +625,7 @@ interface ListAvailabilityTimeSlotsResponse {
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -649,7 +659,7 @@ interface GetAvailabilityTimeSlotRequest {
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -662,7 +672,7 @@ interface GetAvailabilityTimeSlotRequest {
      */
     location?: Location;
     /**
-     * IDs of the resource types ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) to check availability for.
+     * IDs of the [resource types](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction) to check availability for.
      * @format GUID
      * @maxSize 100
      */
@@ -696,7 +706,7 @@ interface GetAvailabilityTimeSlotResponse {
      * 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/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -727,7 +737,7 @@ interface ListEventTimeSlotsRequest {
      * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
      * @maxLength 100
      */
     timeZone?: string | null;
@@ -773,7 +783,7 @@ interface ListEventTimeSlotsRequest {
     cursorPaging?: CursorPaging;
     /**
      * Indicators for service's booking policy violations.
-     * Allows filtering for time slots with specific violation types based on booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
+     * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
      */
     bookingPolicyViolations?: BookingPolicyViolations;
 }
@@ -784,7 +794,7 @@ interface ListEventTimeSlotsResponse {
      * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -806,7 +816,7 @@ interface GetEventTimeSlotRequest {
      * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
      * @maxLength 100
      */
     timeZone?: string | null;
@@ -818,7 +828,7 @@ interface GetEventTimeSlotResponse {
      * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -886,11 +896,11 @@ type GetMultiServiceAvailabilityTimeSlotApplicationErrors = {
  *
  * Only appointment-type services are supported.
  *
- * To retrieve appointment availability for a single service, call List Availability Time Slots ([SDK](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots?apiView=SDK) | [REST](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots)).
+ * To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots).
  *
  * ### Booking policy filtering
  *
- * Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)).
+ * Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction).
  *
  * *Default behavior**: When you don't specify any `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
  *
@@ -941,7 +951,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
      *
      * Required unless you specify `cursorPaging.cursor`.
      *
-     * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+     * 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
      */
@@ -959,7 +969,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
     bookable?: boolean | null;
     /**
      * Indicators for service's booking policy violations.
-     * Allows filtering for time slots with specific violation types based on booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
+     * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
      */
     bookingPolicyViolations?: BookingPolicyViolations;
     /**
@@ -992,7 +1002,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
  *
  * Only appointment-type services are supported.
  *
- * To retrieve appointment availability for a single service, call List Availability Time Slots ([SDK](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots?apiView=SDK) | [REST](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots)).
+ * To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots).
  * @param services - Services for which the multi-service time slots are returned.
  * You can specify resource filters for each service.
  * @param localStartDate - Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
@@ -1002,7 +1012,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
  * @param timeZone - Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
  * For example, `America/New_York` or `UTC`.
  *
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
  * @param location - Location for which the multi-service time slots are returned. If you filter by `{"type": "BUSINESS"}`, you must also specify a location ID. A filter for `location.name` is ignored.
  *
  * Required unless you specify `cursorPaging.cursor`.