@wix/auto_sdk_bookings_bookings 1.0.41 → 1.0.42

package/build/cjs/index.d.ts

@@ -531,17 +531,17 @@ interface CreateMultiServiceBookingSignature {
      *
      * ## When to call this method
      *
-     * Create sequential appointments where customers book related services. For adding existing single-service bookings to an existing multi-service booking, call Add Bookings to Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking)) instead.
+     * Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call Add Bookings to Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking)) instead.
      *
      * ## Requirements and behavior
      *
-     * *Package constraints**: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
+     * __Package constraints__: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
      *
-     * *Timing specification**: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
+     * __Timing specification__: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
      *
-     * *Package pricing**: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/orders/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)) if the customer paid via an eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
+     * __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/orders/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)) if the customer paid via an eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
      *
-     * *Package notifications**: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
+     * __Package notifications__: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
      *
      * ## Related methods
      *
@@ -569,7 +569,7 @@ interface RescheduleMultiServiceBookingSignature {
      *
      * This method reschedules single-service bookings within the multi-service booking while maintaining sequential order. You must specify exact new timing for each service to ensure they remain back-to-back with no gaps or overlaps.
      *
-     * This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each booking you're rescheduling to prevent conflicting changes.
+     * This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each single-service booking you're rescheduling to prevent conflicting changes.
      *
      * See Reschedule Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking)) for single-service booking rescheduling details.
      * @param - ID of the multi-service booking to reschedule.
@@ -591,14 +591,11 @@ interface GetMultiServiceBookingAvailabilitySignature {
      * - The relevant services' booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)).
      * - The availability of all required resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/introduction)).
      *
-     * ## When to call this method
-     *
-     * Check if an existing multi-service booking is still valid after business configuration changes. For example, staff changes, policy updates, or capacity modifications.
-     *
-     * ## When to call List Multi Service Availability Time Slots instead
+     * Call this method to check if an existing multi-service booking is still valid after business configuration changes.
+     * For example, staff changes, policy updates, or capacity modifications.
      *
      * For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/list-multi-service-availability-time-slots)) instead.
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/multi-service-availability-time-slots/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots)) instead.
      * @param - ID of the multi-service booking to retrieve.
      */
     (multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`> & {
@@ -608,7 +605,7 @@ interface GetMultiServiceBookingAvailabilitySignature {
 declare function cancelMultiServiceBooking$1(httpClient: HttpClient): CancelMultiServiceBookingSignature;
 interface CancelMultiServiceBookingSignature {
     /**
-     * Cancels a multi-service booking and all its single-service bookings.
+     * Cancels a multi-service booking and all its associated single-service bookings.
      *
      *
      * Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
@@ -633,8 +630,8 @@ interface MarkMultiServiceBookingAsPendingSignature {
      *
      * ## Status requirements
      *
-     * - **Original status**: All single-service bookings must have `CREATED` status.
-     * - **Target status**: All bookings move to `PENDING` together (all-or-nothing operation).
+     * - __Original status__: All single-service bookings must have `CREATED` status.
+     * - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
      *
      * ## Checkout restrictions
      *
@@ -643,9 +640,9 @@ interface MarkMultiServiceBookingAsPendingSignature {
      *
      * ## Additional updates
      *
-     * - **Payment status**: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
-     * - **Customer notifications**: Send messages using `participantNotification`.
-     * - **Revision control**: Requires current revision numbers for all single-service bookings.
+     * - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
+     * - __Customer notifications__: Send messages using `participantNotification`.
+     * - __Revision control__: Requires current revision numbers for all single-service bookings.
      *
      * See Mark Booking as Pending ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/mark-booking-as-pending) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/mark-booking-as-pending)) for more details about marking single-service bookings as pending.
      * @param - ID of the multi-service booking to mark as `PENDING`.
@@ -666,8 +663,8 @@ interface ConfirmMultiServiceBookingSignature {
      *
      * ## Status requirements
      *
-     * - **Original status**: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
-     * - **Target status**: All bookings move to `CONFIRMED` together (all-or-nothing operation).
+     * - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
+     * - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
      *
      * ## Checkout restrictions
      *
@@ -676,9 +673,9 @@ interface ConfirmMultiServiceBookingSignature {
      *
      * ## Additional updates
      *
-     * - **Payment status**: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
-     * - **Customer notifications**: Send messages using `participantNotification`.
-     * - **Revision control**: Requires current revision numbers for all single-service bookings.
+     * - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
+     * - __Customer notifications__: Send messages using `participantNotification`.
+     * - __Revision control__: Requires current revision numbers for all single-service bookings.
      *
      * See Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)) for more details about confirming single-service bookings.
      * @param - ID of the multi-service booking to confirm its related bookings.
@@ -699,8 +696,8 @@ interface DeclineMultiServiceBookingSignature {
      *
      * ## Status requirements
      *
-     * - **Original status**: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
-     * - **Target status**: All bookings move to `DECLINED` together (all-or-nothing operation).
+     * - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
+     * - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
      *
      * ## Checkout restrictions
      *
@@ -709,9 +706,9 @@ interface DeclineMultiServiceBookingSignature {
      *
      * ## Additional updates
      *
-     * - **Payment status**: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
-     * - **Customer notifications**: Send messages using `participantNotification`.
-     * - **Revision control**: Requires current revision numbers for all single-service bookings.
+     * - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
+     * - __Customer notifications__: Send messages using `participantNotification`.
+     * - __Revision control__: Requires current revision numbers for all single-service bookings.
      *
      * Refer to Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)) for more details about declining single-service bookings.
      * @param - ID of the multi-service booking to decline.
@@ -732,13 +729,13 @@ interface BulkGetMultiServiceBookingAllowedActionsSignature {
      * - `cancel`: Whether the customer can cancel the multi-service booking.
      * - `reschedule`: Whether the customer can adjust the multi-service booking's timing.
      *
-     * ## Important considerations
+     * Bear the following considerations in mind when calling this method:
      *
-     * *Real-time validation**: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)), and available resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) at the time of the call.
+     * __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)), and available resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) at the time of the call.
      *
-     * *Permission context**: Depending on the permissions of the calling [identity](https://dev.wix.com/build-apps/develop-your-app/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
+     * __Permission context__: Depending on the permissions of the calling [identity](https://dev.wix.com/build-apps/develop-your-app/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
      *
-     * *Status dependencies**: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
+     * __Status dependencies__: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
      * Bookings can skip `PENDING` and move directly from `CREATED` to `CONFIRMED`/`DECLINED` based on service configuration.
      * @param - IDs of the multi-service bookings to retrieve allowed actions for.
      */
@@ -750,12 +747,12 @@ interface GetMultiServiceBookingSignature {
      * Retrieves a multi-service booking and all its associated single-service bookings.
      *
      *
-     * Returns the complete multi-service booking information including its ID, included single-service bookings, and the total number of scheduled single-service bookings.
+     * Returns the complete multi-service booking information including its ID, associated single-service bookings, and the total number of scheduled single-service bookings.
      *
-     * If you call as an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) who has permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
+     * If you call on behalf of an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
      * The returned total number includes single-service bookings for which you don't have permissions.
      *
-     * See Query Extended Bookings ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/query-extended-bookings) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-booking)) for details about retrieving individual single-service bookings and additional metadata.
+     * See Query Extended Bookings ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/query-extended-bookings) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings)) for details about retrieving individual single-service bookings and additional metadata.
      * @param - ID of the multi-service booking.
      * @returns Retrieved multi-service booking.
      */
@@ -780,10 +777,10 @@ interface AddBookingsToMultiServiceBookingSignature {
      *
      * ## Requirements and limitations
      *
-     * - **Maximum capacity**: The total number of single-service bookings can't exceed 8.
-     * - **Booking eligibility**: You can add only independent single-service bookings that aren't part of another multi-service booking.
-     * - **Status compatibility**: Added bookings must have compatible status with the target multi-service booking.
-     * - **Revision control**: You must provide current revision numbers for all single-service bookings to add.
+     * - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
+     * - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
+     * - __Status compatibility__: Added bookings must have compatible status with the target multi-service booking.
+     * - __Revision control__: You must provide current revision numbers for all single-service bookings to add.
      * @param - ID of the multi-service booking.
      */
     (multiServiceBookingId: string, options?: NonNullablePaths<AddBookingsToMultiServiceBookingOptions, `bookings` | `bookings.${number}.bookingId` | `bookings.${number}.revision`>): Promise<NonNullablePaths<AddBookingsToMultiServiceBookingResponse, `bookings` | {
@@ -800,21 +797,21 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
      *
      * ## Removal options
      *
-     * *Remove all permitted bookings**: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
+     * __Remove all permitted bookings__: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
      *
-     * *Selective removal**: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
+     * __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
      *
-     * *Sequential scheduling**: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call Reschedule Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/multi-service-bookings/reschedule-multi-service-booking)) before removing the unwanted bookings.
+     * __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call Reschedule Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/multi-service-bookings/reschedule-multi-service-booking)) before removing the unwanted bookings.
      *
      * ## Removal behavior
      *
-     * *Independent bookings**: Removed single-service bookings become independent bookings.
+     * __Independent bookings__: Removed single-service bookings become independent bookings.
      * You can manage them using single-service booking methods.
      *
-     * *Automatic cleanup**: Multi-service bookings must contain at least 2 services.
+     * __Automatic cleanup__: Multi-service bookings must contain at least 2 services.
      * If removal results in only 1 remaining single-service booking for the multi-service booking, the entire multi-service booking is deleted and the remaining single-service booking becomes a standalone booking.
      *
-     * *Revision control**: Specify current revision numbers to prevent conflicting modifications during the removal process.
+     * __Revision control__: Specify current revision numbers to prevent conflicting modifications during the removal process.
      * @param - ID of the multi-service booking.
      */
     (multiServiceBookingId: string, options?: RemoveBookingsFromMultiServiceBookingOptions): Promise<NonNullablePaths<RemoveBookingsFromMultiServiceBookingResponse, `bookings` | {