@wix/bookings 1.0.310 → 1.0.312

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

@@ -0,0 +1,366 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAvailabilityTimeSlot = exports.listAvailabilityTimeSlots = exports.LocationType = exports.__debug = void 0;
+const velo_1 = require("@wix/metro-runtime/velo");
+const transform_error_1 = require("@wix/sdk-runtime/transform-error");
+const ambassadorWixBookingsAvailabilityV2TimeSlot = __importStar(require("./bookings-availability-v2-time-slot-availability-time-slots.http"));
+let __verbose = false;
+function __log(...args) {
+    __verbose && console.log(...args);
+}
+function __inspect(obj) {
+    return obj;
+}
+exports.__debug = {
+    verboseLogging: {
+        on: () => (__verbose = true),
+        off: () => (__verbose = false),
+    },
+};
+const _toVeloEntity = '$';
+const _fromVeloEntity = '$';
+var LocationType;
+(function (LocationType) {
+    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. */
+    LocationType["BUSINESS"] = "BUSINESS";
+    /** The location is unique to this service and isn't defined as one of the business locations. */
+    LocationType["CUSTOM"] = "CUSTOM";
+    /** The location can be determined by the customer and is not set up beforehand. */
+    LocationType["CUSTOMER"] = "CUSTOMER";
+})(LocationType || (exports.LocationType = LocationType = {}));
+const _getAvailabilityTimeSlotRequest = {};
+const _getAvailabilityTimeSlotResponse = {};
+const _listAvailabilityTimeSlotsRequest = {};
+const _listAvailabilityTimeSlotsResponse = {};
+/**
+ * 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`
+ * @public
+ * @documentationMaturity preview
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScope Read Bookings - all read permissions
+ * @permissionScope Read Bookings Calendar Availability
+ * @permissionScope Manage Bookings - all permissions
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
+function listAvailabilityTimeSlots(options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            serviceId: '$[0].serviceId',
+            fromLocalDate: '$[0].fromLocalDate',
+            toLocalDate: '$[0].toLocalDate',
+            timeZone: '$[0].timeZone',
+            locations: '$[0].locations',
+            resourceIds: '$[0].resourceIds',
+            includeResourceTypeIds: '$[0].includeResourceTypeIds',
+            bookable: '$[0].bookable',
+            bookingPolicyViolations: '$[0].bookingPolicyViolations',
+            timeSlotsPerDay: '$[0].timeSlotsPerDay',
+            cursorPaging: '$[0].cursorPaging',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = (0, velo_1.serializer)({
+            rootSchema: _listAvailabilityTimeSlotsRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = (0, velo_1.serializer)({
+            rootSchema: _listAvailabilityTimeSlotsResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['Array#timeSlots']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([options]);
+        const reqOpts = ambassadorWixBookingsAvailabilityV2TimeSlot.listAvailabilityTimeSlots(payload);
+        __log(`"ListAvailabilityTimeSlots" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: {
+                    serviceId: '$[0].serviceId',
+                    fromLocalDate: '$[0].fromLocalDate',
+                    toLocalDate: '$[0].toLocalDate',
+                    timeZone: '$[0].timeZone',
+                    locations: '$[0].locations',
+                    resourceIds: '$[0].resourceIds',
+                    includeResourceTypeIds: '$[0].includeResourceTypeIds',
+                    bookable: '$[0].bookable',
+                    bookingPolicyViolations: '$[0].bookingPolicyViolations',
+                    timeSlotsPerDay: '$[0].timeSlotsPerDay',
+                    cursorPaging: '$[0].cursorPaging',
+                },
+                singleArgumentUnchanged: false,
+            }, ['options']);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.listAvailabilityTimeSlots = listAvailabilityTimeSlots;
+/**
+ * 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 serviceId - Service ID of the time slot.
+ * Currently supported only for services of type `APPOINTMENT`.
+ * @param localStartDate - Local start date of the time slot, in ISO-8601 format.
+ * For example, "2024-01-30T13:30:00".
+ * @param localEndDate - Local end date of the time slot, in ISO-8601 format.
+ * For example, "2024-01-30T14:30:00".
+ * @param timeZone - Time zone, in IANA time zone format.
+ * @param location - 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>
+ * @public
+ * @documentationMaturity preview
+ * @requiredField localEndDate
+ * @requiredField localStartDate
+ * @requiredField location
+ * @requiredField serviceId
+ * @requiredField timeZone
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScope Read Bookings - all read permissions
+ * @permissionScope Read Bookings Calendar Availability
+ * @permissionScope Manage Bookings - all permissions
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
+function getAvailabilityTimeSlot(serviceId, localStartDate, localEndDate, timeZone, location, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            serviceId: '$[0]',
+            localStartDate: '$[1]',
+            localEndDate: '$[2]',
+            timeZone: '$[3]',
+            location: '$[4]',
+            resourceIds: '$[5].resourceIds',
+            includeResourceTypeIds: '$[5].includeResourceTypeIds',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[6];
+        const { toAmbassadorRequest } = (0, velo_1.serializer)({
+            rootSchema: _getAvailabilityTimeSlotRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = (0, velo_1.serializer)({
+            rootSchema: _getAvailabilityTimeSlotResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['timeSlot']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([
+            serviceId,
+            localStartDate,
+            localEndDate,
+            timeZone,
+            location,
+            options,
+        ]);
+        const reqOpts = ambassadorWixBookingsAvailabilityV2TimeSlot.getAvailabilityTimeSlot(payload);
+        __log(`"GetAvailabilityTimeSlot" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: {
+                    serviceId: '$[0]',
+                    localStartDate: '$[1]',
+                    localEndDate: '$[2]',
+                    timeZone: '$[3]',
+                    location: '$[4]',
+                    resourceIds: '$[5].resourceIds',
+                    includeResourceTypeIds: '$[5].includeResourceTypeIds',
+                },
+                singleArgumentUnchanged: false,
+            }, [
+                'serviceId',
+                'localStartDate',
+                'localEndDate',
+                'timeZone',
+                'location',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.getAvailabilityTimeSlot = getAvailabilityTimeSlot;
+//# sourceMappingURL=bookings-availability-v2-time-slot-availability-time-slots.universal.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bookings-availability-v2-time-slot-availability-time-slots.universal.js","sourceRoot":"","sources":["../../../src/bookings-availability-v2-time-slot-availability-time-slots.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqD;AACrD,sEAAuF;AAEvF,+IAAiI;AAEjI,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA4F5B,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,+DAA+C,CAAA;IAC/C,4HAA4H;IAC5H,qCAAqB,CAAA;IACrB,iGAAiG;IACjG,iCAAiB,CAAA;IACjB,mFAAmF;IACnF,qCAAqB,CAAA;AACvB,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AA0rBD,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6FG;AACH,SAAsB,yBAAyB,CAC7C,OAA0C;;;QAK1C,MAAM,qBAAqB,GAAG;YAC5B,SAAS,EAAE,gBAAgB;YAC3B,aAAa,EAAE,oBAAoB;YACnC,WAAW,EAAE,kBAAkB;YAC/B,QAAQ,EAAE,eAAe;YACzB,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,kBAAkB;YAC/B,sBAAsB,EAAE,6BAA6B;YACrD,QAAQ,EAAE,eAAe;YACzB,uBAAuB,EAAE,8BAA8B;YACvD,eAAe,EAAE,sBAAsB;YACvC,YAAY,EAAE,mBAAmB;SAClC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,iCAAiC;YAC7C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,kCAAkC;YAC9C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,2CAA2C,CAAC,yBAAyB,CACnE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,qDAAqD,SAAS,CAAC,OAAO,CAAC,EAAE,CAC1E,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,2DAAI,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,4DAAG,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;QACtC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;gBACE,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE;oBACxB,SAAS,EAAE,gBAAgB;oBAC3B,aAAa,EAAE,oBAAoB;oBACnC,WAAW,EAAE,kBAAkB;oBAC/B,QAAQ,EAAE,eAAe;oBACzB,SAAS,EAAE,gBAAgB;oBAC3B,WAAW,EAAE,kBAAkB;oBAC/B,sBAAsB,EAAE,6BAA6B;oBACrD,QAAQ,EAAE,eAAe;oBACzB,uBAAuB,EAAE,8BAA8B;oBACvD,eAAe,EAAE,sBAAsB;oBACvC,YAAY,EAAE,mBAAmB;iBAClC;gBACD,uBAAuB,EAAE,KAAK;aAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;YACF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,4DAAG,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;QACzB,CAAC;;CACF;AA1FD,8DA0FC;AA+HD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,SAAsB,uBAAuB,CAC3C,SAAiB,EACjB,cAAsB,EACtB,YAAoB,EACpB,QAAuB,EACvB,QAAkB,EAClB,OAAwC;;;QAKxC,MAAM,qBAAqB,GAAG;YAC5B,SAAS,EAAE,MAAM;YACjB,cAAc,EAAE,MAAM;YACtB,YAAY,EAAE,MAAM;YACpB,QAAQ,EAAE,MAAM;YAChB,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE,kBAAkB;YAC/B,sBAAsB,EAAE,6BAA6B;SACtD,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,+BAA+B;YAC3C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC;YAClC,SAAS;YACT,cAAc;YACd,YAAY;YACZ,QAAQ;YACR,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,OAAO,GACX,2CAA2C,CAAC,uBAAuB,CACjE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,mDAAmD,SAAS,CAAC,OAAO,CAAC,EAAE,CACxE,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,2DAAI,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,4DAAG,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;QACtC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;gBACE,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE;oBACxB,SAAS,EAAE,MAAM;oBACjB,cAAc,EAAE,MAAM;oBACtB,YAAY,EAAE,MAAM;oBACpB,QAAQ,EAAE,MAAM;oBAChB,QAAQ,EAAE,MAAM;oBAChB,WAAW,EAAE,kBAAkB;oBAC/B,sBAAsB,EAAE,6BAA6B;iBACtD;gBACD,uBAAuB,EAAE,KAAK;aAC/B,EACD;gBACE,WAAW;gBACX,gBAAgB;gBAChB,cAAc;gBACd,UAAU;gBACV,UAAU;gBACV,SAAS;aACV,CACF,CAAC;YACF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,4DAAG,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;QACzB,CAAC;;CACF;AArGD,0DAqGC"}

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

@@ -0,0 +1,223 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { GetAvailabilityTimeSlotRequest, GetAvailabilityTimeSlotResponse, GetMultiServiceAvailabilityTimeSlotRequest, GetMultiServiceAvailabilityTimeSlotResponse, ListAvailabilityTimeSlotsRequest, ListAvailabilityTimeSlotsResponse, ListMultiServiceAvailabilityTimeSlotsRequest, ListMultiServiceAvailabilityTimeSlotsResponse, ListMultiServiceAvailabilityTimeSlotsResponseNonNullableFields, GetMultiServiceAvailabilityTimeSlotResponseNonNullableFields, ListAvailabilityTimeSlotsResponseNonNullableFields, GetAvailabilityTimeSlotResponseNonNullableFields } from './bookings-availability-v2-time-slot-event-time-slots.types';
+/**
+ * Retrieves a list of multiService `TimeSlot`s that match the provided filters.
+ *
+ * <blockquote class="important">
+ * <p><strong>Important:</strong><br/>
+ * 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:  `service`.`serviceId`, `fromLocalDate`, `toLocalDate`, `location`, 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 given sequence of services in a specific order, location, and within a given range of time.
+ *
+ * Each `TimeSlot`.`NestedTimeSlot` represents a single service from the given list. The order of the `NestedTimeSlots` is the same as the order
+ * of the given services in request.
+ * The first `NestedTimeSlot` has `localStartDate` within the given `fromLocalDate` and `toLocalDate` exclusive,
+ * and each following `NestedTimeSlot` has a `localStartDate` that equals to the previous `NestedTimeSlot`'s `localEndDate`.
+ *
+ * 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.
+ *
+ * > __Notes:__
+ * >  + All nested time slots share the same location.
+ * >  + You can pass up to 8 services in request.
+ *
+ * ### AvailableResources in response:
+ * The `TimeSlot`.`NestedTimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service
+ * within the `NestedTimeSlot` range of time. 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">service</code>.<code class="grey-background">includeResourceTypeIds</code>
+ * or  <code class="grey-background">service</code>.<code class="grey-background">resourceIds</code> filters in request,
+ * we return TimeSlots with <code class="grey-background">NestedTimeSlot</code>s 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/multi-service-availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_multi-service-availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-all-selected-services-are-available-for)
+ * is an example for such flow.
+ * </p>
+ * </blockquote>
+ *
+ *
+ * If you wish to get a list of available resources for a `TimeSlot`.`NestedTimeSlot` you should either:
+ * + provide `service`.`resourceIds` in request.
+ * + provide `service`.`includeResourceTypeIds` in request.
+ *
+ * __Notes:__
+ * + In both cases the returned `TimeSlot`.`NestedTimeSlot` 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.
+ * + If you wish to get the full available resources list for all `NestedTimeSlot` of a specific `TimeSlot`, you should call [GetMultiServiceAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/get-multi-service-availability-time-slot).
+ *
+ *
+ * ### Availability VS Bookability
+ * An `available` time slot is not necessarily `bookable`.
+ * The `bookable` field of a `TimeSlot` indicates whether the customer can book all of the of the services 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/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-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 one of the services from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`, we don't return TimeSlots with `NestedTimeSlot`.`localStartDate` within this range for this service.
+ * + The response contains both `bookable` and `un-bookable` TimeSlots.For example, if one of the services has a booking policy which enforces booking the service up to 10 minutes before the session starts, we return TimeSlots with the violating `NestedTimeSlot`.`localStartDate`, with `bookable` as `false`. If you want to list only __bookable__ TimeSlots you should pass `bookable` as `true`.
+ * + If booking one of the `NestedTimeSlot`s violates one of the corresponding service's booking policies, the `TimeSlot` returns with `bookable` as false. There is no indication which service's policy was violated.
+ *
+ * <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/wix-service-availability/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-service-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`.
+ */
+export declare function listMultiServiceAvailabilityTimeSlots(payload: ListMultiServiceAvailabilityTimeSlotsRequest): RequestOptionsFactory<ListMultiServiceAvailabilityTimeSlotsResponse & ListMultiServiceAvailabilityTimeSlotsResponseNonNullableFields>;
+/**
+ * Retrieves an available multiService `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 a `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,
+ * we return for each `TimeSlot`.`NestedTimeSlot` all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide
+ * the corresponding service within the time slot.
+ *
+ * If you specify `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,
+ * the returned `TimeSlot`.`NestedTimeSlot` for this service 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.
+ *
+ * + Notes:
+ * + All nested time slots share the same location.
+ * + You can pass up to 8 services.
+ *
+ * <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">ListMultiServiceAvailabilityTimeSlots</code> API.</p>
+ * </blockquote>
+ */
+export declare function getMultiServiceAvailabilityTimeSlot(payload: GetMultiServiceAvailabilityTimeSlotRequest): RequestOptionsFactory<GetMultiServiceAvailabilityTimeSlotResponse & GetMultiServiceAvailabilityTimeSlotResponseNonNullableFields>;
+/**
+ * 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`
+ */
+export declare function listAvailabilityTimeSlots(payload: ListAvailabilityTimeSlotsRequest): RequestOptionsFactory<ListAvailabilityTimeSlotsResponse & ListAvailabilityTimeSlotsResponseNonNullableFields>;
+/**
+ * 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>
+ */
+export declare function getAvailabilityTimeSlot(payload: GetAvailabilityTimeSlotRequest): RequestOptionsFactory<GetAvailabilityTimeSlotResponse & GetAvailabilityTimeSlotResponseNonNullableFields>;