@wix/auto_sdk_bookings_bookings 1.0.41 → 1.0.43

package/build/cjs/index.typings.d.ts

@@ -153,8 +153,11 @@ interface BookingParticipantsInfoOneOf {
  * For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
  */
 declare enum MultiServiceBookingType {
+    /** You must schedule single-service bookings back-to-back with each booking starting when the previous booking ends */
     SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
+    /** Not currently supported. */
     SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
+    /** Not currently supported. */
     PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
 }
 /** @enumType */
@@ -564,7 +567,7 @@ declare enum Actor {
 type ActorWithLiterals = Actor | 'UNDEFINED_ACTOR' | 'BUSINESS' | 'CUSTOMER';
 interface ParticipantNotification {
     /**
-     * Whether to send the message about the changes to the customer.
+     * Whether to send a message about the changes to the customer.
      *
      * Default: `false`
      */
@@ -1516,7 +1519,7 @@ interface CreateBookingFlowControlSettings {
      * Whether `PENDING` bookings are automatically set to `CONFIRMED` for
      * services that normally require the owner's manual confirmation.
      *
-     * Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope
+     * Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission
      * when passing `true`.
      * Default: `false`.
      */
@@ -1525,7 +1528,7 @@ interface CreateBookingFlowControlSettings {
      * Whether customers can pay using a payment method that isn't supported
      * for the service, but that's supported for other services.
      *
-     * Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing
+     * Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission when passing
      * `true`.
      * Default: `false`.
      */
@@ -2650,7 +2653,7 @@ interface CreateMultiServiceBookingRequest {
     /**
      * Multi-service booking type.
      *
-     * Currently only `SEQUENTIAL_BOOKINGS` is supported, where you must schedule single-service bookings back-to-back with each booking starting when the previous 1 ends.
+     * Currently only `SEQUENTIAL_BOOKINGS` is supported.
      */
     multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
 }
@@ -2810,7 +2813,11 @@ interface MarkMultiServiceBookingAsPendingRequest {
     sendSmsReminder?: boolean | null;
     /** Whether this booking has a conflict with at least 1 other confirmed booking. */
     doubleBooked?: boolean | null;
-    /** Whether to return the single-service bookings that were marked as `PENDING`. */
+    /**
+     * Whether to return the single-service bookings that were marked as `PENDING`.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
     /**
      * Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
@@ -2903,7 +2910,7 @@ interface BulkGetMultiServiceBookingAllowedActionsRequest {
 interface BulkGetMultiServiceBookingAllowedActionsResponse {
     /**
      * Information about the multi-service bookings that were retrieved.
-     * Including their ID, index in the bulk request and whether they were successfully processed.
+     * Includes their ID, index in the bulk request and whether they were successfully processed.
      */
     results?: BulkCalculateAllowedActionsResult[];
     /** Total number of successes and failures for Bulk Get Multi Service Booking Allowed Actions. */
@@ -2940,7 +2947,11 @@ interface AddBookingsToMultiServiceBookingRequest {
      * @maxSize 8
      */
     bookings: BookingIdAndRevision[];
-    /** Whether to return the single-service bookings that were added to the multi-service booking. */
+    /**
+     * Whether to return the single-service bookings that were added to the multi-service booking.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
 }
 interface BookingIdAndRevision {
@@ -2970,7 +2981,11 @@ interface RemoveBookingsFromMultiServiceBookingRequest {
      * @maxSize 8
      */
     bookings?: BookingIdAndRevision[];
-    /** Whether to return the single-service bookings. */
+    /**
+     * Whether to return the single-service bookings.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
 }
 interface RemoveBookingsFromMultiServiceBookingResponse {
@@ -4481,17 +4496,17 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
  *
  * ## 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
  *
@@ -4545,7 +4560,7 @@ interface CreateMultiServiceBookingOptions {
     /**
      * Multi-service booking type.
      *
-     * Currently only `SEQUENTIAL_BOOKINGS` is supported, where you must schedule single-service bookings back-to-back with each booking starting when the previous 1 ends.
+     * Currently only `SEQUENTIAL_BOOKINGS` is supported.
      */
     multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
 }
@@ -4555,7 +4570,7 @@ interface CreateMultiServiceBookingOptions {
  *
  * 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 multiServiceBookingId - ID of the multi-service booking to reschedule.
@@ -4596,14 +4611,11 @@ interface RescheduleMultiServiceBookingOptions {
  * - 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 multiServiceBookingId - ID of the multi-service booking to retrieve.
  * @public
  * @documentationMaturity preview
@@ -4617,7 +4629,7 @@ declare function getMultiServiceBookingAvailability(multiServiceBookingId: strin
     __applicationErrorsType?: GetMultiServiceBookingAvailabilityApplicationErrors;
 }>;
 /**
- * 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`.
@@ -4657,8 +4669,8 @@ interface CancelMultiServiceBookingOptions {
  *
  * ## 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
  *
@@ -4667,9 +4679,9 @@ interface CancelMultiServiceBookingOptions {
  *
  * ## 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 multiServiceBookingId - ID of the multi-service booking to mark as `PENDING`.
@@ -4699,7 +4711,11 @@ interface MarkMultiServiceBookingAsPendingOptions {
     sendSmsReminder?: boolean | null;
     /** Whether this booking has a conflict with at least 1 other confirmed booking. */
     doubleBooked?: boolean | null;
-    /** Whether to return the single-service bookings that were marked as `PENDING`. */
+    /**
+     * Whether to return the single-service bookings that were marked as `PENDING`.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
     /**
      * Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
@@ -4715,8 +4731,8 @@ interface MarkMultiServiceBookingAsPendingOptions {
  *
  * ## 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
  *
@@ -4725,9 +4741,9 @@ interface MarkMultiServiceBookingAsPendingOptions {
  *
  * ## 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 multiServiceBookingId - ID of the multi-service booking to confirm its related bookings.
@@ -4773,8 +4789,8 @@ interface ConfirmMultiServiceBookingOptions {
  *
  * ## 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
  *
@@ -4783,9 +4799,9 @@ interface ConfirmMultiServiceBookingOptions {
  *
  * ## 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 multiServiceBookingId - ID of the multi-service booking to decline.
@@ -4824,13 +4840,13 @@ interface DeclineMultiServiceBookingOptions {
  * - `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 multiServiceBookingIds - IDs of the multi-service bookings to retrieve allowed actions for.
  * @public
@@ -4846,12 +4862,12 @@ declare function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds
  * 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 multiServiceBookingId - ID of the multi-service booking.
  * @public
  * @documentationMaturity preview
@@ -4879,10 +4895,10 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
  *
  * ## 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 multiServiceBookingId - ID of the multi-service booking.
  * @public
  * @documentationMaturity preview
@@ -4904,7 +4920,11 @@ interface AddBookingsToMultiServiceBookingOptions {
      * @maxSize 8
      */
     bookings: BookingIdAndRevision[];
-    /** Whether to return the single-service bookings that were added to the multi-service booking. */
+    /**
+     * Whether to return the single-service bookings that were added to the multi-service booking.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
 }
 /**
@@ -4913,21 +4933,21 @@ interface AddBookingsToMultiServiceBookingOptions {
  *
  * ## 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 multiServiceBookingId - ID of the multi-service booking.
  * @public
  * @documentationMaturity preview
@@ -4947,7 +4967,11 @@ interface RemoveBookingsFromMultiServiceBookingOptions {
      * @maxSize 8
      */
     bookings?: BookingIdAndRevision[];
-    /** Whether to return the single-service bookings. */
+    /**
+     * Whether to return the single-service bookings.
+     *
+     * Default: `false`
+     */
     returnFullEntity?: boolean;
 }
 

package/build/cjs/index.typings.js

@@ -37,14 +37,14 @@ __export(index_typings_exports, {
   bulkConfirmOrDeclineBooking: () => bulkConfirmOrDeclineBooking2,
   bulkCreateBooking: () => bulkCreateBooking2,
   bulkGetMultiServiceBookingAllowedActions: () => bulkGetMultiServiceBookingAllowedActions2,
-  cancelBooking: () => cancelBooking,
+  cancelBooking: () => cancelBooking2,
   cancelMultiServiceBooking: () => cancelMultiServiceBooking2,
-  confirmBooking: () => confirmBooking,
+  confirmBooking: () => confirmBooking2,
   confirmMultiServiceBooking: () => confirmMultiServiceBooking2,
   confirmOrDeclineBooking: () => confirmOrDeclineBooking2,
   createBooking: () => createBooking2,
   createMultiServiceBooking: () => createMultiServiceBooking2,
-  declineBooking: () => declineBooking,
+  declineBooking: () => declineBooking2,
   declineMultiServiceBooking: () => declineMultiServiceBooking2,
   getMultiServiceBooking: () => getMultiServiceBooking2,
   getMultiServiceBookingAvailability: () => getMultiServiceBookingAvailability2,
@@ -54,7 +54,7 @@ __export(index_typings_exports, {
   rescheduleMultiServiceBooking: () => rescheduleMultiServiceBooking2,
   setBookingSubmissionId: () => setBookingSubmissionId2,
   updateExtendedFields: () => updateExtendedFields2,
-  updateNumberOfParticipants: () => updateNumberOfParticipants
+  updateNumberOfParticipants: () => updateNumberOfParticipants2
 });
 module.exports = __toCommonJS(index_typings_exports);
 
@@ -539,8 +539,8 @@ function rescheduleBooking(payload) {
   }
   return __rescheduleBooking;
 }
-function bookingsConfirmBooking(payload) {
-  function __bookingsConfirmBooking({ host }) {
+function confirmBooking(payload) {
+  function __confirmBooking({ host }) {
     const metadata = {
       entityFqdn: "wix.bookings.v2.booking",
       method: "POST",
@@ -574,7 +574,7 @@ function bookingsConfirmBooking(payload) {
     };
     return metadata;
   }
-  return __bookingsConfirmBooking;
+  return __confirmBooking;
 }
 function setBookingSubmissionId(payload) {
   function __setBookingSubmissionId({ host }) {
@@ -631,8 +631,8 @@ function updateExtendedFields(payload) {
   }
   return __updateExtendedFields;
 }
-function bookingsDeclineBooking(payload) {
-  function __bookingsDeclineBooking({ host }) {
+function declineBooking(payload) {
+  function __declineBooking({ host }) {
     const metadata = {
       entityFqdn: "wix.bookings.v2.booking",
       method: "POST",
@@ -666,10 +666,10 @@ function bookingsDeclineBooking(payload) {
     };
     return metadata;
   }
-  return __bookingsDeclineBooking;
+  return __declineBooking;
 }
-function bookingsCancelBooking(payload) {
-  function __bookingsCancelBooking({ host }) {
+function cancelBooking(payload) {
+  function __cancelBooking({ host }) {
     const metadata = {
       entityFqdn: "wix.bookings.v2.booking",
       method: "POST",
@@ -703,10 +703,10 @@ function bookingsCancelBooking(payload) {
     };
     return metadata;
   }
-  return __bookingsCancelBooking;
+  return __cancelBooking;
 }
-function bookingsUpdateNumberOfParticipants(payload) {
-  function __bookingsUpdateNumberOfParticipants({ host }) {
+function updateNumberOfParticipants(payload) {
+  function __updateNumberOfParticipants({ host }) {
     const metadata = {
       entityFqdn: "wix.bookings.v2.booking",
       method: "POST",
@@ -740,7 +740,7 @@ function bookingsUpdateNumberOfParticipants(payload) {
     };
     return metadata;
   }
-  return __bookingsUpdateNumberOfParticipants;
+  return __updateNumberOfParticipants;
 }
 function createMultiServiceBooking(payload) {
   function __createMultiServiceBooking({ host }) {
@@ -1420,7 +1420,7 @@ async function rescheduleBooking2(bookingId, slot, options) {
     throw transformedError;
   }
 }
-async function confirmBooking(bookingId, revision, options) {
+async function confirmBooking2(bookingId, revision, options) {
   const { httpClient, sideEffects } = arguments[3];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     bookingId,
@@ -1431,7 +1431,7 @@ async function confirmBooking(bookingId, revision, options) {
     doubleBooked: options?.doubleBooked,
     flowControlSettings: options?.flowControlSettings
   });
-  const reqOpts = bookingsConfirmBooking(payload);
+  const reqOpts = confirmBooking(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);
@@ -1516,7 +1516,7 @@ async function updateExtendedFields2(_id, namespace, options) {
     throw transformedError;
   }
 }
-async function declineBooking(bookingId, revision, options) {
+async function declineBooking2(bookingId, revision, options) {
   const { httpClient, sideEffects } = arguments[3];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     bookingId,
@@ -1526,7 +1526,7 @@ async function declineBooking(bookingId, revision, options) {
     doubleBooked: options?.doubleBooked,
     flowControlSettings: options?.flowControlSettings
   });
-  const reqOpts = bookingsDeclineBooking(payload);
+  const reqOpts = declineBooking(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);
@@ -1553,7 +1553,7 @@ async function declineBooking(bookingId, revision, options) {
     throw transformedError;
   }
 }
-async function cancelBooking(bookingId, options) {
+async function cancelBooking2(bookingId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     bookingId,
@@ -1561,7 +1561,7 @@ async function cancelBooking(bookingId, options) {
     flowControlSettings: options?.flowControlSettings,
     revision: options?.revision
   });
-  const reqOpts = bookingsCancelBooking(payload);
+  const reqOpts = cancelBooking(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);
@@ -1586,7 +1586,7 @@ async function cancelBooking(bookingId, options) {
     throw transformedError;
   }
 }
-async function updateNumberOfParticipants(bookingId, options) {
+async function updateNumberOfParticipants2(bookingId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     bookingId,
@@ -1594,7 +1594,7 @@ async function updateNumberOfParticipants(bookingId, options) {
     totalParticipants: options?.totalParticipants,
     participantsChoices: options?.participantsChoices
   });
-  const reqOpts = bookingsUpdateNumberOfParticipants(payload);
+  const reqOpts = updateNumberOfParticipants(payload);
   sideEffects?.onSiteCall?.();
   try {
     const result = await httpClient.request(reqOpts);