@wix/auto_sdk_bookings_bookings 1.0.83 → 1.0.85

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

@@ -249,7 +249,20 @@ interface BookedEntityItemOneOf {
     schedule?: BookedSchedule;
 }
 interface BookedSlot {
-    /** Session ID. */
+    /**
+     * Session ID. For class bookings, this is the ID of the existing session.
+     * For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
+     *
+     * __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
+     * You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
+     * @deprecated Session ID. For class bookings, this is the ID of the existing session.
+     * For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
+     *
+     * __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
+     * You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
+     * @replacedBy event_id
+     * @targetRemovalDate 2026-03-31
+     */
     sessionId?: string | null;
     /** Service ID. */
     serviceId?: string;
@@ -3955,7 +3968,7 @@ declare function onBookingUpdated(handler: (event: BookingUpdatedEnvelope) => vo
  * Anonymous tokens for getting, canceling or rescheduling the booking.
  * That token is symmetrically encrypted and Url-safe.
  * That allows the UoU to cancel or reschedule without Authentication.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @permissionId BOOKINGS.ANONYMOUS_BOOKING_ACTIONS_READ
  * @returns Response for GetAnonymousActionDetails
@@ -3969,7 +3982,7 @@ interface GetAnonymousActionDetailsOptions {
 /**
  * Cancel booking using an anonymous token
  * @param token - The token provided in the booking links for anonymous access
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField token
  * @returns Response for CancelBookingAnonymously
@@ -3988,7 +4001,7 @@ interface CancelBookingAnonymouslyOptions {
  * Reschedule booking using an anonymous token
  * @param token - The token provided in the booking links for anonymous access
  * @param slot - New slot of the booking.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.revision
@@ -4009,7 +4022,7 @@ interface RescheduleBookingAnonymouslyOptions {
 /**
  * Get booking using an anonymous token
  * @param token - The token provided in the booking links for anonymous access
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField token
  * @returns Response for GetBookingAnonymously
@@ -4102,20 +4115,19 @@ interface BulkConfirmOrDeclineBookingOptions {
  *
  * ### Appointment booking
  *
- * For appointment-based services, specify the relevant `slot` in
- * `bookedEntity.slot`. We recommend specifying the complete
- * `availabilityEntries.slot` returned in [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
- * in your call's request to avoid failed calls due to unavailability.
+ * For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
+ *
+ * We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
+ * Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
  *
  * ### Class session booking
  *
- * For class services, specify the relevant [event ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
- * as `bookedEntity.slot.eventId`.
- * We recommend retrieving the event ID from [Query Availability's](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
- * `availabilityEntries.slot.eventId` to avoid failed calls due to unavailability.
- * Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
- * `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
- * values are overridden.
+ * For class services, specify the relevant event ID as `bookedEntity.slot.eventId`.
+ *
+ * We recommend following the [class session booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-a-class-session) using Time Slots V2.
+ * Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
+ *
+ * When you specify `eventId`, Wix Bookings automatically derives `startDate`, `endDate`, `timezone`, `resource`, and `location` based on the event details. Manually specified values are ignored.
  *
  * ### Course booking
  *
@@ -4172,6 +4184,8 @@ interface BulkConfirmOrDeclineBookingOptions {
  * don't match, Create Booking fails. Therefore, we recommend specifying
  * only `booking.contactDetails.contactId` when providing `formSubmission`.
  *
+ * You can follow [this sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration#create-a-booking-with-a-filled-out-booking-form) to create bookings with booking form submissions.
+ *
  * ### Admin overwrites
  *
  * There are small but important differences when you specify special