@wix/auto_sdk_bookings_bookings 1.0.54 → 1.0.56

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

@@ -2553,15 +2553,21 @@ interface MarkBookingAsPendingRequest {
 }
 interface MarkBookingAsPendingFlowControlSettings {
     /**
-     * Whether to check for double bookings before updating the booking as pending.
+     * Whether to check for double booking conflicts when updating the status.
      *
-     * When passing `false`, a booking is only updated with status `PENDING`.
-     * Default: `false`.
+     * - `true`: Checks for availability conflicts and sets `doubleBooked` to `true`
+     * if conflicts exist.
+     * The booking is still marked as `PENDING` for the business to resolve manually.
+     * - `false`: No availability checking is performed.
+     *
+     * Default: `false`
      */
     checkAvailabilityValidation?: boolean;
     /**
-     * Whether to validate that the booking to be marked as pending has a `booking.slot.serviceId`
-     * of a pending approval service.
+     * Whether to allow marking any booking as pending, even if the service doesn't require manual approval.
+     *
+     * - `true`: Bypasses the validation that checks if the service has `service.onlineBooking.requireManualApproval` set to `true`.
+     * - `false`: Only services that require manual approval can have their bookings marked as pending.
      *
      * Default: `false`.
      */
@@ -2992,6 +2998,7 @@ interface RemoveBookingsFromMultiServiceBookingResponse {
     /** Single-service bookings that were removed from the multi-service booking. */
     bookings?: BookingResult[];
 }
+/** @docsIgnore */
 type ConfirmOrDeclineBookingApplicationErrors = {
     code?: 'INVALID_BOOKING_STATUS';
     description?: string;
@@ -3001,11 +3008,13 @@ type ConfirmOrDeclineBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type BulkConfirmOrDeclineBookingApplicationErrors = {
     code?: 'DUPLICATED_BOOKINGS';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CreateBookingApplicationErrors = {
     code?: 'SESSION_NOT_FOUND';
     description?: string;
@@ -3079,6 +3088,7 @@ type CreateBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type BulkCreateBookingApplicationErrors = {
     code?: 'SESSION_NOT_FOUND';
     description?: string;
@@ -3120,6 +3130,7 @@ type BulkCreateBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type RescheduleBookingApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
@@ -3201,6 +3212,7 @@ type RescheduleBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type ConfirmBookingApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
@@ -3218,16 +3230,19 @@ type ConfirmBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type SetBookingSubmissionIdApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type UpdateExtendedFieldsApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type DeclineBookingApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
@@ -3241,6 +3256,7 @@ type DeclineBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CancelBookingApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
@@ -3266,11 +3282,13 @@ type CancelBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type UpdateNumberOfParticipantsApplicationErrors = {
     code?: 'BOOKING_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type MarkBookingAsPendingApplicationErrors = {
     code?: 'BOOKING_MARK_BOOKING_AS_PENDING';
     description?: string;
@@ -3288,6 +3306,7 @@ type MarkBookingAsPendingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CreateMultiServiceBookingApplicationErrors = {
     code?: 'VALIDATION_FAILURE';
     description?: string;
@@ -3325,6 +3344,7 @@ type CreateMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type RescheduleMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3362,11 +3382,13 @@ type RescheduleMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type GetMultiServiceBookingAvailabilityApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CancelMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3384,6 +3406,7 @@ type CancelMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type MarkMultiServiceBookingAsPendingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3421,6 +3444,7 @@ type MarkMultiServiceBookingAsPendingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type ConfirmMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3470,6 +3494,7 @@ type ConfirmMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type DeclineMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3511,6 +3536,7 @@ type DeclineMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type AddBookingsToMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -3536,6 +3562,7 @@ type AddBookingsToMultiServiceBookingApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type RemoveBookingsFromMultiServiceBookingApplicationErrors = {
     code?: 'MULTI_SERVICE_BOOKING_NOT_FOUND';
     description?: string;
@@ -4484,7 +4511,69 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
      */
     participantsChoices?: ParticipantChoices;
 }
-/** @param bookingId - ID of the booking to mark as `PENDING`.
+/**
+ * Updates the booking status to `PENDING`.
+ *
+ *
+ * ## Service requirement
+ *
+ * By default, this method only works for services ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) with `service.onlineBooking.requireManualApproval` set to `true`.
+ * If you attempt to mark a booking as pending for a service that doesn't require approval, the call fails unless you use the `skipPendingApprovalServiceValidation` admin overwrite.
+ *
+ * ## Status requirements
+ *
+ * - __Original status__: Booking must have `CREATED` status.
+ * - __Target status__: Booking moves to `PENDING`.
+ *
+ * ## Checkout restrictions
+ *
+ * Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/introduction)), Wix Bookings automatically manages the bookings' statuses based on payment processing.
+ *
+ * When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
+ *
+ * ## Business workflow
+ *
+ * After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
+ * - Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)).
+ * - Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)).
+ *
+ * ## Resource availability and scheduling
+ *
+ * Marking a booking as `PENDING` immediately affects resource availability:
+ *
+ * - **Calendar impact**: The booking appears on the business calendar.
+ * - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
+ * - **Resource assignment**: 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)) are automatically assigned if none were explicitly selected during booking creation.
+ *
+ * ## Double bookings
+ *
+ * By default, the method doesn't check for availability conflicts. To detect and handle double bookings, use the `checkAvailabilityValidation: true` admin overwrite.
+ *
+ * ## Notify customers
+ *
+ * You can specify a `participantNotification.message` for the customer.
+ * To send the message, you must also specify `participantNotification.notifyParticipants` as `true`.
+ *
+ * ## Admin overwrites
+ *
+ * There are small but important differences when you specify special
+ * `flowControlSettings`:
+ *
+ * - `{"checkAvailabilityValidation": true}`: Checks for double booking conflicts before updating the status.
+ * When conflicts exist, the booking is still marked as `PENDING` and `doubleBooked` is set to `true` for the business to resolve manually.
+ * - `{"skipPendingApprovalServiceValidation": true}`: Allows marking any booking as pending, even if the service doesn't require manual approval.
+ *
+ * When using special `flowControlSettings`, ensure you have sufficient permissions.
+ * If you encounter failed calls due to insufficient permissions, consider the following options:
+ *
+ * - __App developers__ can use a higher
+ * [permission](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions), such as `MANAGE BOOKINGS - ALL PERMISSIONS`.
+ * - __Site developers__ can utilize
+ * [elevation](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/authorization/elevation).
+ *
+ * Granting additional permissions and using elevation permits method calls that would typically fail due to authorization checks.
+ * Therefore, you should use them intentionally and securely.
+ * @param bookingId - ID of the booking to mark as `PENDING`.
  * @param revision - Revision number, which increments by 1 each time the booking is updated.
  *
  * To prevent conflicting changes, the current revision must be specified when