@wix/auto_sdk_bookings_availability-time-slots 1.0.0

package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.d.ts

@@ -0,0 +1,139 @@
+import { HttpClient } from '@wix/sdk-types';
+import { GetAvailabilityTimeSlotOptions, GetAvailabilityTimeSlotResponse, GetAvailabilityTimeSlotResponseNonNullableFields, ListAvailabilityTimeSlotsOptions, ListAvailabilityTimeSlotsResponse, ListAvailabilityTimeSlotsResponseNonNullableFields, Location } from './bookings-availability-v2-time-slot-availability-time-slots.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function listAvailabilityTimeSlots(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`
+     */
+    (options?: ListAvailabilityTimeSlotsOptions | undefined): Promise<ListAvailabilityTimeSlotsResponse & ListAvailabilityTimeSlotsResponseNonNullableFields>;
+}
+export declare function getAvailabilityTimeSlot(httpClient: HttpClient): GetAvailabilityTimeSlotSignature;
+interface GetAvailabilityTimeSlotSignature {
+    /**
+     * Retrieves an available `TimeSlot` that match the provided filters.
+     *
+     * Throws `SlotNotFound` if there is no such available 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>
+     *
+     * 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.
+     *
+     * 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.
+     *
+     *
+     * <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>
+     * @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>
+     */
+    (serviceId: string, localStartDate: string, localEndDate: string, timeZone: string | null, location: Location, options?: GetAvailabilityTimeSlotOptions | undefined): Promise<GetAvailabilityTimeSlotResponse & GetAvailabilityTimeSlotResponseNonNullableFields>;
+}
+export { AvailableResources, BookingPolicyViolations, CalculateEventBasedAvailabilityRequest, CalculateEventBasedAvailabilityResponse, CommonCursorPaging, CommonCursorPagingMetadata, CommonCursors, CursorPaging, CursorPagingMetadata, Cursors, CustomerChoices, EventInfo, GetAvailabilityTimeSlotOptions, GetAvailabilityTimeSlotRequest, GetAvailabilityTimeSlotResponse, GetAvailabilityTimeSlotResponseNonNullableFields, GetMultiServiceAvailabilityTimeSlotRequest, GetMultiServiceAvailabilityTimeSlotResponse, ListAvailabilityTimeSlotsOptions, ListAvailabilityTimeSlotsRequest, ListAvailabilityTimeSlotsResponse, ListAvailabilityTimeSlotsResponseNonNullableFields, ListEventTimeSlotsRequest, ListEventTimeSlotsResponse, ListMultiServiceAvailabilityTimeSlotsRequest, ListMultiServiceAvailabilityTimeSlotsResponse, Location, LocationType, NestedTimeSlot, Resource, ResourceType, Service, TimeSlot, V2CustomerChoices, WaitingList, } from './bookings-availability-v2-time-slot-availability-time-slots.universal.js';

package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationType = exports.getAvailabilityTimeSlot = exports.listAvailabilityTimeSlots = exports.__metadata = void 0;
+const bookings_availability_v2_time_slot_availability_time_slots_universal_js_1 = require("./bookings-availability-v2-time-slot-availability-time-slots.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/bookings' };
+function listAvailabilityTimeSlots(httpClient) {
+    return (options) => (0, bookings_availability_v2_time_slot_availability_time_slots_universal_js_1.listAvailabilityTimeSlots)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.listAvailabilityTimeSlots = listAvailabilityTimeSlots;
+function getAvailabilityTimeSlot(httpClient) {
+    return (serviceId, localStartDate, localEndDate, timeZone, location, options) => (0, bookings_availability_v2_time_slot_availability_time_slots_universal_js_1.getAvailabilityTimeSlot)(serviceId, localStartDate, localEndDate, timeZone, location, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getAvailabilityTimeSlot = getAvailabilityTimeSlot;
+var bookings_availability_v2_time_slot_availability_time_slots_universal_js_2 = require("./bookings-availability-v2-time-slot-availability-time-slots.universal.js");
+Object.defineProperty(exports, "LocationType", { enumerable: true, get: function () { return bookings_availability_v2_time_slot_availability_time_slots_universal_js_2.LocationType; } });
+//# sourceMappingURL=bookings-availability-v2-time-slot-availability-time-slots.public.js.map

package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bookings-availability-v2-time-slot-availability-time-slots.public.js","sourceRoot":"","sources":["../../../src/bookings-availability-v2-time-slot-availability-time-slots.public.ts"],"names":[],"mappings":";;;AACA,uKAUmF;AAEtE,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,yBAAyB,CACvC,UAAsB;IAEtB,OAAO,CAAC,OAA0C,EAAE,EAAE,CACpD,IAAA,mGAAkC,EAChC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8DASC;AA4FD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,cAAsB,EACtB,YAAoB,EACpB,QAAuB,EACvB,QAAkB,EAClB,OAAwC,EACxC,EAAE,CACF,IAAA,iGAAgC,EAC9B,SAAS,EACT,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AArBD,0DAqBC;AA0DD,qKAoCmF;AARjF,uKAAA,YAAY,OAAA"}