@wix/auto_sdk_bookings_bookings 1.0.60 → 1.0.62

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

@@ -3727,6 +3727,8 @@ interface BookingCanceledEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
  * @eventType wix.bookings.v2.booking_canceled
@@ -3750,6 +3752,8 @@ interface BookingConfirmedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
  * @eventType wix.bookings.v2.booking_confirmed
@@ -3771,6 +3775,8 @@ interface BookingCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
  * @permissionScope Manage Bookings - all permissions
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionScope Manage Bookings
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
  * @permissionScope Read Bookings - Including Participants
@@ -3781,6 +3787,8 @@ interface BookingCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.READ_BOOKINGS
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
@@ -3805,6 +3813,8 @@ interface BookingDeclinedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
  * @eventType wix.bookings.v2.booking_declined
@@ -3828,6 +3838,8 @@ interface BookingNumberOfParticipantsUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
  * @eventType wix.bookings.v2.booking_number_of_participants_updated
@@ -3851,6 +3863,8 @@ interface BookingRescheduledEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
  * @eventType wix.bookings.v2.booking_rescheduled
@@ -3872,6 +3886,8 @@ interface BookingUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
  * @permissionScope Manage Bookings - all permissions
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionScope Manage Bookings
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
  * @permissionScope Read Bookings - Including Participants
@@ -3882,6 +3898,8 @@ interface BookingUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
  * @permissionScope Read bookings calendar - including participants
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Picasso private app mega scope (site)
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
  * @permissionId BOOKINGS.READ_BOOKINGS
  * @permissionId BOOKINGS.BOOKING_READ
  * @webhook
@@ -4004,12 +4022,18 @@ interface BulkConfirmOrDeclineBookingOptions {
  * We recommend following [this sample flow](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course)
  * to minimize failed calls due to unavailability.
  *
+ * ### Booking status
+ *
+ * Create Booking defaults to `status=CREATED`. Such bookings aren't visible in the [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar).
+ *
+ * Only [identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with `Manage Bookings` permissions can set `status=CONFIRMED`.
+ *
  * ### Related resources
  *
- * Specifying a `resource` triggers an availability check, resulting in a failed
- * call if the resource is unavailable. Omitting a resource allows Wix Bookings
- * to assign a resource belonging to the relevant type randomly when the merchant
- * confirms the booking.
+ * Specifying a `resource` triggers an availability check, and the Create Booking call fails if the resource is unavailable.
+ *
+ * If you omit `resource`, resource assignment and availability validation occur during booking confirmation.
+ * If no resources are available, the behavior depends on the confirmation method used and payment status.
  *
  * ### Participant information
  *
@@ -4027,32 +4051,17 @@ interface BulkConfirmOrDeclineBookingOptions {
  * If you specify `{"sendSmsReminder": true}`, the customer receives an SMS 24 hours
  * before the session starts. The phone number is taken from `contactDetails.phone`.
  *
- * ### Booking status
- *
- * Bookings default to the `CREATED` status, not affecting the business calendar
- * or resource availability. You can specify a different status when the calling
- * [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)
- * has `Manage Bookings` permissions.
- *
  * ### Payment options
  *
- * The specified `selectedPaymentOption` indicates how the customer intends to
- * pay, allowing for later changes to a different method supported by the service.
+ * The specified `selectedPaymentOption` indicates how the customer intends to pay, allowing for later changes to a different method supported by the service.
  *
  * ### Payment status
  *
- * A booking is initially created with `{"paymentStatus": "UNDEFINED"}` regardless
- * of the payment status specified in Create Booking. If a customer uses an
- * _eCommerce checkout_
- * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)),
- * Wix Bookings automatically syncs the booking's payment status from
- * the corresponding eCommerce order
- * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)).
+ * All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
  *
- * If a booking doesn't have a corresponding eCommerce order, for example, since
- * the customer didn't use the eCommerce checkout, you can update the booking's
- * payment status with Confirm Or Decline Booking
- * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)).
+ * For customers paying with a Wix eCommerce checkout ([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/checkout/introduction)), Wix Bookings automatically syncs the booking's payment status from the corresponding eCommerce order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)).
+ *
+ * For customers using a custom checkout, call Confirm or Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)) to update booking's payment status manually.
  *
  * ### Booking form data
  *