@wix/auto_sdk_bookings_multi-service-availability-time-slots 1.0.82 → 1.0.83

package/build/{cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts → bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-DD3QA5-2.d.mts}

@@ -16,7 +16,7 @@
  * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information
  * > for a given list of `Appointment` services within a specific time slot.
  */
-export interface TimeSlot {
+interface TimeSlot {
     /**
      * Service ID.
      *
@@ -89,12 +89,12 @@ export interface TimeSlot {
     /** Reasons why the time slot is not available for booking. */
     nonBookableReasons?: NonBookableReasons;
 }
-export interface Location {
+interface Location {
     /**
      * Business Location ID. Present only if the location is a business location.
      * @format GUID
      */
-    id?: string | null;
+    _id?: string | null;
     /** The location name. */
     name?: string | null;
     /** A string representation for the full address of the location. */
@@ -107,7 +107,7 @@ export interface Location {
      */
     locationType?: LocationType;
 }
-export declare enum LocationType {
+declare enum LocationType {
     UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
     /** A business location, either the default business address, or locations defined for the business by the Business Info. */
     BUSINESS = "BUSINESS",
@@ -117,7 +117,7 @@ export declare enum LocationType {
     CUSTOMER = "CUSTOMER"
 }
 /** relevant for event based slots, and not for availability based slots */
-export interface EventInfo {
+interface EventInfo {
     /**
      * The event ID.
      * @minLength 36
@@ -127,7 +127,7 @@ export interface EventInfo {
     /** Waiting list details for the event, if enabled in the service's booking policy. */
     waitingList?: WaitingList;
 }
-export interface WaitingList {
+interface WaitingList {
     /**
      * Total number of spots in the waiting list.
      * @min 1
@@ -139,7 +139,7 @@ export interface WaitingList {
      */
     remainingCapacity?: number | null;
 }
-export interface BookingPolicyViolations {
+interface BookingPolicyViolations {
     /** Bookings policy violation. Too early to book this slot. */
     tooEarlyToBook?: boolean | null;
     /** The earliest time at which booking for this slot is allowed, in UTC format (`YYYY-MM-DDThh:mm:ss.sssZ`). */
@@ -149,7 +149,7 @@ export interface BookingPolicyViolations {
     /** Bookings policy violation. Online booking is disabled for the `TimeSlot` service. */
     bookOnlineDisabled?: boolean | null;
 }
-export interface AvailableResources {
+interface AvailableResources {
     /**
      * Resource type ID.
      * @format GUID
@@ -182,19 +182,19 @@ export interface AvailableResources {
      */
     hasMoreAvailableResources?: boolean | null;
 }
-export interface Resource {
+interface Resource {
     /**
      * Resource ID.
      * @format GUID
      */
-    id?: string;
+    _id?: string;
     /**
      * Resource name.
      * @minLength 1
      */
     name?: string | null;
 }
-export interface NestedTimeSlot {
+interface NestedTimeSlot {
     /**
      * Service ID of the nested time slot.
      * @format GUID
@@ -219,7 +219,7 @@ export interface NestedTimeSlot {
      */
     availableResources?: AvailableResources[];
 }
-export interface NonBookableReasons {
+interface NonBookableReasons {
     /** The slot is fully booked with no remaining capacity. */
     noRemainingCapacity?: boolean | null;
     /** Booking this slot would violate the service's booking policy. */
@@ -227,7 +227,7 @@ export interface NonBookableReasons {
     /** The slot is reserved for the waiting list and not available for direct booking. */
     reservedForWaitingList?: boolean | null;
 }
-export interface ListMultiServiceAvailabilityTimeSlotsRequest {
+interface ListMultiServiceAvailabilityTimeSlotsRequest {
     /**
      * Services for which the multiService time slots are being returned for.
      * Each service contains its own resources filters within.
@@ -346,7 +346,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
      */
     cursorPaging?: CursorPaging;
 }
-export interface Service {
+interface Service {
     /**
      * Service ID.
      * @format GUID
@@ -382,7 +382,7 @@ export interface Service {
  * Selected customer choices.
  * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.
  */
-export interface V2CustomerChoices {
+interface V2CustomerChoices {
     /**
      * The selected customer duration in minutes.
      * Min: `1 minute`
@@ -399,7 +399,7 @@ export interface V2CustomerChoices {
      */
     addOnIds?: string[] | null;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Number of results to load.
      *
@@ -417,7 +417,7 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface ListMultiServiceAvailabilityTimeSlotsResponse {
+interface ListMultiServiceAvailabilityTimeSlotsResponse {
     /**
      * Time slots.
      * @maxSize 1000
@@ -445,7 +445,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsResponse {
      */
     cursorPagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Offset that was requested. */
     cursors?: Cursors;
     /**
@@ -455,13 +455,13 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /** Cursor pointing to next page in the list of results. */
     next?: string | null;
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
-export interface GetMultiServiceAvailabilityTimeSlotRequest {
+interface GetMultiServiceAvailabilityTimeSlotRequest {
     /**
      * Services for which the multiService TimeSlots are being returned for.
      * Each service contains its own resources filters within.
@@ -503,7 +503,7 @@ export interface GetMultiServiceAvailabilityTimeSlotRequest {
      */
     location: Location;
 }
-export interface GetMultiServiceAvailabilityTimeSlotResponse {
+interface GetMultiServiceAvailabilityTimeSlotResponse {
     /** Time slot. */
     timeSlot?: TimeSlot;
     /**
@@ -513,7 +513,7 @@ export interface GetMultiServiceAvailabilityTimeSlotResponse {
      */
     timeZone?: string | null;
 }
-export interface ListAvailabilityTimeSlotsRequest {
+interface ListAvailabilityTimeSlotsRequest {
     /**
      * Service ID for which the time slots are being returned for.
      * Currently supported only for services of type `APPOINTMENT`.
@@ -658,7 +658,7 @@ export interface ListAvailabilityTimeSlotsRequest {
  * Selected customer choices.
  * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.
  */
-export interface CustomerChoices {
+interface CustomerChoices {
     /**
      * The selected customer duration in minutes.
      * Min: `1 minute`
@@ -675,7 +675,7 @@ export interface CustomerChoices {
      */
     addOnIds?: string[] | null;
 }
-export interface ResourceType {
+interface ResourceType {
     /**
      * Resource type ID.
      * @format GUID
@@ -690,7 +690,7 @@ export interface ResourceType {
      */
     resourceIds?: string[] | null;
 }
-export interface ListAvailabilityTimeSlotsResponse {
+interface ListAvailabilityTimeSlotsResponse {
     /**
      * Time slots.
      * @maxSize 1000
@@ -718,7 +718,7 @@ export interface ListAvailabilityTimeSlotsResponse {
      */
     cursorPagingMetadata?: CursorPagingMetadata;
 }
-export interface GetAvailabilityTimeSlotRequest {
+interface GetAvailabilityTimeSlotRequest {
     /**
      * Service ID of the time slot.
      * Currently supported only for services of type `APPOINTMENT`.
@@ -775,7 +775,7 @@ export interface GetAvailabilityTimeSlotRequest {
      */
     includeResourceTypeIds?: string[];
 }
-export interface GetAvailabilityTimeSlotResponse {
+interface GetAvailabilityTimeSlotResponse {
     /** Time slot. */
     timeSlot?: TimeSlot;
     /**
@@ -785,7 +785,7 @@ export interface GetAvailabilityTimeSlotResponse {
      */
     timeZone?: string | null;
 }
-export interface ListEventTimeSlotsRequest {
+interface ListEventTimeSlotsRequest {
     /**
      * Local start date for which event time slots are returned, in ISO-8601 format.
      * E.g., "2024-01-30T13:30:00".
@@ -843,7 +843,7 @@ export interface ListEventTimeSlotsRequest {
     /** Cursor to retrieve the next page of results. */
     cursorPaging?: CursorPaging;
 }
-export interface ListEventTimeSlotsResponse {
+interface ListEventTimeSlotsResponse {
     /** Retrieved time slots matching the specified filters. */
     timeSlots?: TimeSlot[];
     /**
@@ -856,7 +856,7 @@ export interface ListEventTimeSlotsResponse {
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface GetEventTimeSlotRequest {
+interface GetEventTimeSlotRequest {
     /**
      * The event ID.
      * @minLength 36
@@ -872,7 +872,7 @@ export interface GetEventTimeSlotRequest {
      */
     timeZone?: string | null;
 }
-export interface GetEventTimeSlotResponse {
+interface GetEventTimeSlotResponse {
     /** The time slot. */
     timeSlot?: TimeSlot;
     /**
@@ -883,3 +883,124 @@ export interface GetEventTimeSlotResponse {
      */
     timeZone?: string | null;
 }
+interface ListMultiServiceAvailabilityTimeSlotsOptions {
+    /**
+     * Services for which the multiService time slots are being returned for.
+     * Each service contains its own resources filters within.
+     *
+     * MinSize: `2`.
+     * MaxSize: `8`.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @maxSize 8
+     */
+    services?: Service[];
+    /**
+     * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.
+     * For example, "2024-01-30T13:30:00".
+     *
+     * Each returned `TimeSlot` in response has a `localStartDate`
+     * within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.
+     * For example, "2024-01-30T14:30:00".
+     *
+     * Each returned `TimeSlot` in response has a `localStartDate`
+     * within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * Time zone, in IANA time zone format.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /**
+     * Location for which the multiService TimeSlots are being returned for.
+     *
+     * You can specify location or location type for which the TimeSlots will be returned for.
+     * If locationType is `BUSINESS`, you __must__ provide a locationId.
+     *
+     * <blockquote class="warning">
+     * <p><strong>warning:</strong><br/>
+     * Supports filtering by location type, or by location ID. </br>
+     * Other fields like <code class="grey-background">name</code> are ignored.</p>
+     * </blockquote>
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     */
+    location?: Location;
+    /**
+     * Whether the `TimeSlot` is bookable according to all of the services booking policies.
+     *
+     * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,
+     * returns as `false`. Otherwise, returns as `true`.
+     *
+     * > __Note:__
+     * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,
+     * > while a `TimeSlot` with no available resources will not be returned at all.
+     */
+    bookable?: boolean | null;
+    /**
+     * Indicators for service's booking policy violations for booking the `TimeSlot`.
+     *
+     * A bookable time slot must not violate any policy,
+     * therefor, this filter is only relevant when `bookable` filter is false.
+     *
+     * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s
+     * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether
+     * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.
+     *
+     * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
+     * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
+     */
+    bookingPolicyViolations?: BookingPolicyViolations;
+    /**
+     * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,
+     * we return at most 3 available TimeSlots for each day within the date range specified in request.
+     *
+     * By default,
+     * if `bookable` filter was not specified,
+     * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.
+     *
+     * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,
+     * `un-bookable` slots will be returned according to the specified filters.
+     */
+    timeSlotsPerDay?: number | null;
+    /**
+     * CursorPaging.
+     *
+     * Enables you to fetch TimeSlots in smaller, more manageable chunks
+     * by setting a limit on the number of results returned in response.
+     * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.
+     *
+     * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`
+     * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the
+     * returned cursor to the next call as `cursorPaging`.`cursor`.
+     *
+     * For the first call, you should only specify the `limit` for the results page.
+     * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`
+     * the `cursorPaging`.`limit`. You may pass a different `limit`.
+     * No need to specify any additional parameters.
+     *
+     * <blockquote class="important">
+     * <p><strong>Important:</strong><br/>
+     * If you only provide a <code class="grey-background">cursorPaging</code>. <code class="grey-background">cursor</code>,
+     * the response will contain the default size of results which is `1000`.
+     * </p>
+     * </blockquote>
+     */
+    cursorPaging?: CursorPaging;
+}
+
+export { type AvailableResources as A, type BookingPolicyViolations as B, type CursorPaging as C, type EventInfo as E, type GetMultiServiceAvailabilityTimeSlotResponse as G, type ListMultiServiceAvailabilityTimeSlotsOptions as L, type NestedTimeSlot as N, type Resource as R, type Service as S, type TimeSlot as T, type V2CustomerChoices as V, type WaitingList as W, type ListMultiServiceAvailabilityTimeSlotsResponse as a, type Location as b, LocationType as c, type NonBookableReasons as d, type ListMultiServiceAvailabilityTimeSlotsRequest as e, type CursorPagingMetadata as f, type Cursors as g, type GetMultiServiceAvailabilityTimeSlotRequest as h, type ListAvailabilityTimeSlotsRequest as i, type CustomerChoices as j, type ResourceType as k, type ListAvailabilityTimeSlotsResponse as l, type GetAvailabilityTimeSlotRequest as m, type GetAvailabilityTimeSlotResponse as n, type ListEventTimeSlotsRequest as o, type ListEventTimeSlotsResponse as p, type GetEventTimeSlotRequest as q, type GetEventTimeSlotResponse as r };