@wix/bookings 1.0.301 → 1.0.303

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

@@ -13,7 +13,7 @@
  * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?
  *
  * > __Note:__
- * When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information
+ * > 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 {
@@ -27,17 +27,11 @@ export interface TimeSlot {
     /**
      * Local start date of the time slot in ISO-8601 format.
      * For example, "2024-01-30T13:30:00".
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > represents the earliest `localStartDate` of the `TimeSlot`'s nested time slots.
      */
     localStartDate?: string | null;
     /**
      * Local end date of the time slot in ISO-8601 format.
      * For example, "2024-01-30T14:30:00".
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > represents the latest `localEndDate` of the `TimeSlot`'s nested time slots.
      */
     localEndDate?: string | null;
     /**
@@ -45,39 +39,22 @@ export interface TimeSlot {
      *
      * If booking this time slot does not violates any of the service's booking policies,
      * the returned value is `true`. Otherwise, returns `false`.
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > + `bookable` is `false` if at least one of the provided services is not bookable within the time slot.
-     * > + `bookable` is `true` if all provided services are bookable within the time slot.
      */
     bookable?: boolean | null;
-    /**
-     * The geographic location of the slot.
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > the geographic location of all nested time slots of the `TimeSlot`.
-     */
+    /** The geographic location of the slot. */
     location?: Location;
-    /**
-     * Total number of spots for the slot.
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > `totalCapacity` is always 1, regardless the number of requested services.
-     */
+    /** Total number of spots for the slot. */
     totalCapacity?: number | null;
     /**
      * Remaining number of spots for the slot.
      * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.
-     *
-     * > When returned from `MultiServiceAvailabilityTimeSlots` API calls,
-     * > `remainingCapacity` is 1 if all requested services has `remainingCapacity` >= 1.
-     * > `remainingCapacity` is 0, if there is at least one requested service with `remainingCapacity` < 1.
      */
     remainingCapacity?: number | null;
     /**
-     * > When returned from `ListMultiServiceAvailabilityTimeSlots`,
-     * > indicates that at least one of the nested time slots does not meet with at least one of the service's booking policies.
-     * > There is no indication which of the requested services violates a booking policy.
+     * Indicators for booking policy violations for the slot.
+     *
+     * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
+     * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
      */
     bookingPolicyViolations?: BookingPolicyViolations;
     /**
@@ -318,43 +295,57 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
      * Services for which the multiService time slots are being returned for.
      * Each service contains its own resources filters within.
      *
-     * MinSize: 2.
-     * MaxSize: 8.
+     * MinSize: `2`.
+     * MaxSize: `8`.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
      */
     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.
-     * > __Note:__: Each returned `TimeSlot` in response has a `localStartDate`
-     * > within the provided `fromLocalDate` and `toLocalDate` exclusive.
      */
     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.
-     * > __Note:__: Each returned `TimeSlot` in response has a `localStartDate`
-     * > within the provided `fromLocalDate` and `toLocalDate` exclusive.
      */
     toLocalDate?: string | null;
     /**
      * Time zone, in IANA time zone format.
+     *
      * Required, unless `cursorPaging`.`cursor` is provided.
      */
     timeZone?: string | null;
     /**
-     * Location for which the multiService time slots are being returned for.
+     * 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>
      *
-     * You can specify location or location type for which the time slots will be returned for.
-     * > __Note:__ Supports filtering by location type, or by locationId. Other fields like `name` are ignored.
-     * > If locationType is `BUSINESS`, you __must__ provide a locationId.
+     * Required, unless `cursorPaging`.`cursor` is provided.
      */
     location?: Location;
     /**
-     * Whether the `TimeSlot` is bookable according all of the services booking policies.
+     * 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,
+     * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,
      * returns as `false`. Otherwise, returns as `true`.
      *
      * > __Note:__
@@ -368,7 +359,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
      * 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
+     * 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.
      *
@@ -378,7 +369,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
     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 `TimeSlot`'s for each day within the date range specified in request.
+     * 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,
@@ -391,8 +382,8 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
     /**
      * CursorPaging.
      *
-     * Enables you to fetch `TimeSlot`'s in smaller, more manageable chunks
-     * by setting a limit on the number of `TimeSlots` returned in response.
+     * 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`
@@ -404,17 +395,12 @@ export interface ListMultiServiceAvailabilityTimeSlotsRequest {
      * the `cursorPaging`.`limit`. You may pass a different `limit`.
      * No need to specify any additional parameters.
      *
-     * __TODO: This is only describes the current behavior, should be fixed__
      * <blockquote class="important">
      * <p><strong>Important:</strong><br/>
-     * If you only provide a `cursorPaging`.`cursor`,
-     * the response will contain the default size of results = 1000.
+     * 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.limit:
-     * Default: 1000
-     * Max: 1000
      */
     cursorPaging?: CommonCursorPaging;
 }
@@ -436,10 +422,10 @@ export interface Service {
 }
 export interface CommonCursorPaging {
     /**
-     * Number of items to load.
+     * Number of results to load.
      *
-     * Default: `1000`
-     * Max: `1000`
+     * Default: `1000`.
+     * Max: `1000`.
      */
     limit?: number | null;
     /**
@@ -456,7 +442,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsResponse {
     timeSlots?: TimeSlot[];
     /**
      * Time zone, in IANA time zone format.
-     * Shared for all `TimeSlot`'s in response.
+     * Shared for all TimeSlots in response.
      */
     timeZone?: string | null;
     /**
@@ -469,8 +455,7 @@ export interface ListMultiServiceAvailabilityTimeSlotsResponse {
      *
      * <blockquote class="important">
      * <p><strong>Important:</strong><br/>
-     * `count` is not supported.
-     * </p>
+     * <code class="grey-background">count</code> is not supported.</p>
      * </blockquote>
      */
     cursorPagingMetadata?: CommonCursorPagingMetadata;
@@ -493,7 +478,7 @@ export interface CommonCursors {
 }
 export interface GetMultiServiceAvailabilityTimeSlotRequest {
     /**
-     * Services for which the multiService time slots are being returned for.
+     * Services for which the multiService TimeSlots are being returned for.
      * Each service contains its own resources filters within.
      *
      * MinSize: 2.
@@ -516,12 +501,11 @@ export interface GetMultiServiceAvailabilityTimeSlotRequest {
      * The location of the time slot.
      *
      * You must provide a specific `locationType`.
-     * If locationType is `BUSINESS`, you __must__ also provide a locationId.
+     * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
      *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong><br/>
-     * `name` and `formattedAddress` are ignored.
-     * </p>
+     * <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>
      */
     location: Location;
@@ -535,29 +519,34 @@ export interface GetMultiServiceAvailabilityTimeSlotResponse {
 export interface ListAvailabilityTimeSlotsRequest {
     /**
      * Service ID for which the time slots are being returned for.
-     * Currently supports only services of type `Appointment`.
+     * Currently supported only for services of type `APPOINTMENT`.
+     *
      * Required, unless `cursorPaging`.`cursor` is provided.
      */
     serviceId?: string | null;
     /**
      * 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.
-     * > __Note:__: Each returned `TimeSlot` in response has a `localStartDate`
-     * > within the provided `fromLocalDate` and `toLocalDate` exclusive.
      */
     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.
-     * > __Note:__: Each returned `TimeSlot` in response has a `localStartDate`
-     * > within the provided `fromLocalDate` and `toLocalDate` exclusive.
-     * > The `localEndDate` of the returned `TimeSlot` is the `TimeSlot`'s `localStartDate` + the service duration
      */
     toLocalDate?: string | null;
     /**
      * Time zone, in IANA time zone format.
+     *
      * Required, unless `cursorPaging`.`cursor` is provided.
      */
     timeZone?: string | null;
@@ -566,34 +555,37 @@ export interface ListAvailabilityTimeSlotsRequest {
      *
      * By default,
      * if no locations are provided,
-     * the response contains `TimeSlot`'s for all locations where the service is available.
+     * the response contains TimeSlots for all locations where the service is available.
      *
      * You can specify locations or location types for which the time slots will be returned for.
-     * > __Note:__ Supports filtering by location type, or by locationId. Other fields like `name` are ignored.
-     * > If locationType is `BUSINESS`, you __must__ provide a locationId.
+     * 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>
      */
     locations?: Location[];
     /**
      * Resources to include in response.
      *
      * If specified,
-     * the returned time slots will contain __up__ to 10 available resources out of the provided list.
-     * Otherwise, the returned time slots returns with an empty `AvailableResources`.
-     * > __Note:__ Not specifying `resourceIds` can be handy in case you want to avoid large response in flows that only
-     * > interested whether the time slots are available or not. [An example for such flow](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/sample-flows#all-apis_wix-service-availability_service-availability-time-slots_sample-flows_let-your-customers-to-dynamically-select-an-available-time-slot-for-any-of-your-business-services).
+     * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.
+     * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.
      */
     resourceIds?: string[];
     /**
-     * Resource type ID's to include in response, this is in addition to the requested resourceIds.
+     * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.
      *
-     * If specified in request, the returned time slots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`
+     * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`
      * out of those specified, each contains __up__ to 10 available resources of this type.
      */
     includeResourceTypeIds?: string[];
     /**
      * Whether the `TimeSlot` is bookable according to the service's booking policies.
      *
-     * If booking this time slot does not violates any of the service's booking policies,
+     * If booking this `TimeSlot` does not violates any of the service's booking policies,
      * returns as `true`. Otherwise, returns as `false`.
      *
      * > __Note:__
@@ -613,7 +605,7 @@ export interface ListAvailabilityTimeSlotsRequest {
     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 `TimeSlot`'s for each day within the date range specified in request.
+     * 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,
@@ -626,8 +618,8 @@ export interface ListAvailabilityTimeSlotsRequest {
     /**
      * CursorPaging.
      *
-     * Enables you to fetch `TimeSlot`'s in smaller, more manageable chunks
-     * by setting a limit on the number of `TimeSlots` returned in response.
+     * Enables you to fetch results 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`
@@ -635,21 +627,16 @@ export interface ListAvailabilityTimeSlotsRequest {
      * 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`.
+     * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and
+     * a `cursorPaging`.`limit`.
      * No need to specify any additional parameters.
      *
-     * __TODO: This is only describes the current behavior, should be fixed__
      * <blockquote class="important">
      * <p><strong>Important:</strong><br/>
-     * If you only provide a `cursorPaging`.`cursor`,
-     * the response will contain the default size of results = 1000.
+     * 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.limit:
-     * Default: 1000
-     * Max: 1000
      */
     cursorPaging?: CommonCursorPaging;
 }
@@ -658,7 +645,7 @@ export interface ListAvailabilityTimeSlotsResponse {
     timeSlots?: TimeSlot[];
     /**
      * Time zone, in IANA time zone format.
-     * Shared for all `TimeSlot`'s in response.
+     * Shared for all TimeSlots in response.
      */
     timeZone?: string | null;
     /**
@@ -671,8 +658,7 @@ export interface ListAvailabilityTimeSlotsResponse {
      *
      * <blockquote class="important">
      * <p><strong>Important:</strong><br/>
-     * `count` is not supported.
-     * </p>
+     * <code class="grey-background">count</code> is not supported.</p>
      * </blockquote>
      */
     cursorPagingMetadata?: CommonCursorPagingMetadata;
@@ -680,7 +666,7 @@ export interface ListAvailabilityTimeSlotsResponse {
 export interface GetAvailabilityTimeSlotRequest {
     /**
      * Service ID of the time slot.
-     * Currently supports only services of type `Appointment`.
+     * Currently supported only for services of type `APPOINTMENT`.
      */
     serviceId: string;
     /**
@@ -699,12 +685,11 @@ export interface GetAvailabilityTimeSlotRequest {
      * The location of the time slot.
      *
      * You must provide a specific `locationType`.
-     * If locationType is `BUSINESS`, you __must__ also provide a locationId.
+     * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
      *
-     * <blockquote class="important">
-     * <p><strong>Important:</strong><br/>
-     * `name` and `formattedAddress` are ignored.
-     * </p>
+     * <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>
      */
     location: Location;
@@ -712,16 +697,14 @@ export interface GetAvailabilityTimeSlotRequest {
      * Resources to include in response.
      *
      * If specified,
-     * the returned time slot contain only the available resources out of provided list.
-     * Otherwise, the returned time slot returned with all possible `AvailableResources`.
-     * > __Note:__ This can be handy in case you want to avoid large response in flows that only
-     * > interested to check the availability of the time slot for specific resources.
+     * the returned `TimeSlot` contains only the available resources out of provided list.
+     * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.
      */
     resourceIds?: string[];
     /**
-     * Resource type ID's to include in response, this is in addition to the requested resourceIds.
+     * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.
      *
-     * If specified in request, the returned time slot contain only the `AvailableResources` with `ResourceTypeId`
+     * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`
      * out of those specified, each contains all the available resources of this type.
      */
     includeResourceTypeIds?: string[];

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

@@ -1 +1 @@
-{"version":3,"file":"bookings-availability-v2-time-slot.types.js","sourceRoot":"","sources":["../../../src/bookings-availability-v2-time-slot.types.ts"],"names":[],"mappings":";;;AAiHA,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,GAAZ,oBAAY,KAAZ,oBAAY,QAQvB"}
+{"version":3,"file":"bookings-availability-v2-time-slot.types.js","sourceRoot":"","sources":["../../../src/bookings-availability-v2-time-slot.types.ts"],"names":[],"mappings":";;;AA0FA,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,GAAZ,oBAAY,KAAZ,oBAAY,QAQvB"}