@wix/bookings 1.0.302 → 1.0.304

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

@@ -1,102 +1,83 @@
 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.types';
 /**
- * Retrieves a list of multiService `TimeSlot`'s that match the provided filters.
+ * 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 `APPOINTMENT`.
- * </p>
+ * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
  * </blockquote>
  *
- * The request body __must__ include one of:
- *
- * + All of the following filters:  `serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone`. You may add additional filters as you wish.
+ * 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 list of services in a specific location, within a given range of time.
+ * 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,
+ * 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 `service`.`includeResourceTypeIds` or `service`.`resourceIds` filters in request,
- * we return `TimeSlot`.`NestedTimeSlot`'s with an empty `AvailableResources`.
+ * 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`'s 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 can 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).
- *
+ * __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.
  *
+ * ### 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 `TimeSlot`'s.
- * 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 `TimeSlot`'s with `localStartDate` within this range.
- * + The response contains both `bookable` and `un-bookable` `TimeSlot`'s.
- * 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 `TimeSlot`'s with the violating `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.
+ * + 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><br/>
+ * <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 about [DST Handling](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)
- * </p>
+ * 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>
  *
- *
- * ### Pagination:
- * You can specify how many `TimeSlot`'s will return in response by providing a `limit`
- * for the `cursorPaging` in request.
- *
- * If there are more `TimeSlot`s that match the provided filters, we return a `cursorPagingMetaData`
- * with `hasNext` = true and a `cursors`.`next` that points to the next page of results.
- * In order to retrieve the next page of results, you should only provide `cursorPaging` with a limit and the cursor
- * you got in previous call to `cursorPaging`.`cursor` in the request of the following call.
- *
- * 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.
- *
- * #### ListAvailabilityTimeSlots runs with the following defaults:
- * + `cursorPaging`.`limit` is 1000.
+ * ### 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>;
 /**
@@ -106,8 +87,7 @@ export declare function listMultiServiceAvailabilityTimeSlots(payload: ListMulti
  *
  * <blockquote class="important">
  * <p><strong>Important:</strong><br/>
- * Currently supported only for services of type `APPOINTMENT`.
- * </p>
+ * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
  * </blockquote>
  *
  * By default,
@@ -123,33 +103,51 @@ export declare function listMultiServiceAvailabilityTimeSlots(payload: ListMulti
  * + 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.
+ * Retrieves a list of `TimeSlot`s that match the provided filters.
  *
  * <blockquote class="important">
- * <p><strong>Important:</strong><br/>
- * Currently supported only for services of type `APPOINTMENT`.
- * </p>
+ * <p><strong>Important:</strong>
+ * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
  * </blockquote>
  *
- * The request body __must__ include one of:
- *
- * + All of the following filters:  `serviceId`, `fromLocalDate`, `toLocalDate`, and `timeZone`. You may add additional filters as you wish.
+ * 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.
  *
- * ### AvailableResources in response:
  * <blockquote class="important">
  * <p><strong>Important:</strong><br/>
  * By default,
- * if you don't specify `includeResourceTypeIds` or `resourceIds` filters in request,
- * we return `TimeSlot`'s with an empty `AvailableResources`.
+ * 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>
  *
@@ -157,61 +155,43 @@ export declare function getMultiServiceAvailabilityTimeSlot(payload: GetMultiSer
  * + provide `resourceIds` in request.
  * + provide `includeResourceTypeIds` in request.
  *
- * > __Notes:__
- * >
- * > + In both cases the returned `TimeSlot`'s 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 a specific `TimeSlot`,
- * > you can call [GetAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/get-availability-time-slot).
- *
+ * __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.
  *
+ * ### 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 `TimeSlot`'s.
+ * + 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 `TimeSlot`'s with `localStartDate` within this range.
- * + The response contains both `bookable` and `un-bookable` `TimeSlot`'s.
+ * 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 `TimeSlot`'s with the violating `localStartDate` with `bookable` as false.
- * If you want to list only __bookable__ `TimeSlots` you should pass `bookable` as true.
+ * 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><br/>
+ * <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 about [DST Handling](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_daylight-saving-time-dst-handling)
- * </p>
+ * 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>
  *
  *
- * ### Pagination:
- * You can specify how many `TimeSlot`'s will return in response by providing a `limit`
- * for the `cursorPaging` in request.
- *
- * If there are more `TimeSlot`s that match the provided filters, we return a `cursorPagingMetaData`
- * with `hasNext` = true and a `cursors`.`next` that points to the next page of results.
- * In order to retrieve the next page of results, you should only provide `cursorPaging` with a limit and the cursor
- * you got in previous call to `cursorPaging`.`cursor` in the request of the following call.
- *
- * 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.
- *
- * #### ListAvailabilityTimeSlots runs with the following defaults:
- * + `cursorPaging`.`limit` is 1000.
- * + `localStartDate` is sorted in `ASC` order.
+ * ### 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>;
 /**
@@ -221,8 +201,7 @@ export declare function listAvailabilityTimeSlots(payload: ListAvailabilityTimeS
  *
  * <blockquote class="important">
  * <p><strong>Important:</strong><br/>
- * Currently supported only for services of type `APPOINTMENT`.
- * </p>
+ * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
  * </blockquote>
  *
  * By default,
@@ -234,5 +213,11 @@ export declare function listAvailabilityTimeSlots(payload: ListAvailabilityTimeS
  * 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>;