@wix/auto_sdk_bookings_bookings 1.0.93 → 1.0.95

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

@@ -11,10 +11,18 @@ interface ConfirmOrDeclineBookingSignature {
      *
      * ### eCommerce checkout restriction
      *
-     * Call this method only when using a custom checkout page. Don't
-     * call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
-     * In such cases, Wix automatically updates the booking status based on
-     * the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
+     * Call this method only when using a custom checkout page.
+     * Don't call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
+     * In such cases, Wix Bookings automatically updates the booking status based on the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
+     *
+     * ### When to call Confirm Booking or Decline Booking instead
+     *
+     * This method has specific limitations based on payment status and double booking conflicts.
+     * Use the alternative methods in these scenarios:
+     * + **To force confirm double-booked free bookings:** Call [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
+     * Confirm Or Decline Booking can't confirm double-booked free bookings.
+     * + **To decline bookings without double booking conflicts:** Call [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
+     * Confirm Or Decline Booking only declines bookings when both a double booking conflict exists and payment status is unpaid.
      *
      * ### New booking status
      *
@@ -415,6 +423,10 @@ interface CreateBookingSignature {
      *
      * The specified `selectedPaymentOption` indicates how the customer intends to pay, allowing for later changes to a different method supported by the service.
      *
+     * When the customer pays with a [Wix eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction), you must specify a `selectedPaymentOption`.
+     * Otherwise, the Create Booking call fails.
+     * For custom checkouts, you don't have to specify a `selectedPaymentOption`.
+     *
      * ### Payment status
      *
      * All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
@@ -567,6 +579,11 @@ interface ConfirmBookingSignature {
      * In such cases, Wix automatically updates the booking status based on
      * the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
      *
+     * ### When to call Confirm Booking
+     *
+     * When using a custom checkout flow for free bookings, call this method to confirm bookings even when a double booking conflict exists.
+     * The alternative [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) method doesn't support confirming double-booked free bookings in this scenario.
+     *
      * ### When to call Confirm Or Decline Booking instead
      *
      * Confirm Booking doesn't check whether a slot or schedule is still available.
@@ -648,22 +665,24 @@ interface UpdateExtendedFieldsSignature {
 declare function declineBooking$1(httpClient: HttpClient): DeclineBookingSignature;
 interface DeclineBookingSignature {
     /**
-     * Updates the booking status to `DECLINED` and updates the relevant session's
-     * `participants.approvalStatus` to `DECLINED` without checking whether the relevant
-     * slot or schedule is still available.
+     * Updates the booking status to `DECLINED` without checking whether the relevant slot or schedule is still available.
      *
      *
      * ### eCommerce checkout restriction
      *
-     * Call this method only when using a custom checkout page. Don't
-     * call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
-     * In such cases, Wix automatically updates the booking status based on
-     * the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
+     * Call this method only when using a custom checkout page.
+     * Don't call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
+     * In such cases, Wix Bookings automatically updates the booking status based on the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
+     *
+     * ### When to call Decline Booking
+     *
+     * When using a custom checkout, call this method to decline bookings that don't have a double booking conflict.
+     * The alternative [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) method doesn't support this scenario.
      *
      * ### When to call Confirm Or Decline Booking instead
      *
-     * The method doesn't check whether a slot or schedule is still available. For
-     * these checks you can call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking).
+     * Decline Booking doesn't check whether a slot or schedule is still available.
+     * For these checks you can call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking).
      *
      * ### Original status validation
      *
@@ -771,10 +790,10 @@ interface UpdateNumberOfParticipantsSignature {
 declare function bulkCalculateAllowedActions$1(httpClient: HttpClient): BulkCalculateAllowedActionsSignature;
 interface BulkCalculateAllowedActionsSignature {
     /**
-     * Checks whether you can [reschedule](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) or [cancel](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) a list of bookings without using force resolution.
+     * Checks whether you can [reschedule](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) or [cancel](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) a list of bookings without using [force resolution](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#force-resolution).
      *
      *
-     * Call this method to determine which standard actions are available before attempting to modify bookings. If standard actions aren't available, you may need to use [force resolution](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows/sample-flows#force-resolution) to override business rules and availability validation.
+     * Call this method to determine which standard actions are available before attempting to modify bookings. If standard actions aren't available, you may need to use force resolution to override business rules and availability validation.
      * @param - List of booking IDs to calculate allowed actions for.
      */
     (bookingIds: string[]): Promise<NonNullablePaths<BulkCalculateAllowedActionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.cancel` | `results.${number}.item.reschedule` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;