@wix/auto_sdk_bookings_bookings 1.0.82 → 1.0.84

package/build/cjs/meta.d.ts

@@ -5,14 +5,13 @@ import '@wix/sdk-types';
 interface Booking extends BookingParticipantsInfoOneOf {
     /**
      * Total number of participants.
-     * When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * @min 1
      */
     totalParticipants?: number;
     /**
      * Information about the booked service choices and participant count for each choice.
-     * When creating a booking, use this field only if the booking includes multiple service variants
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      *
      * For example, use this for a spa package booking that includes different service levels:
      * - 2 participants chose "Standard Package".
@@ -43,8 +42,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
      */
     bookedEntity?: BookedEntity;
     /**
-     * Contact details of the site visitor or member
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction))
+     * Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction))
      * making the booking.
      */
     contactDetails?: ContactDetails;
@@ -70,8 +68,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
     status?: BookingStatusWithLiterals;
     /**
      * The payment status of the booking. This field automatically syncs with the
-     * `paymentStatus` of the corresponding eCommerce order
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)| [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction))
+     * `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction)
      * when customers use Wix eCommerce checkout.
      *
      * ### Integration patterns
@@ -79,17 +76,17 @@ interface Booking extends BookingParticipantsInfoOneOf {
      * __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
      * Do not manually update this field.
      *
-     * __When using custom payment flows__: You can manually update the payment status with Confirm Booking 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 reflect the customer's payment state.
+     * __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.
      *
-     * __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active pricing plan ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/introduction)) subscription.
+     * __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.
      *
      * All payment statuses are supported for every booking `status`.
      */
     paymentStatus?: PaymentStatusWithLiterals;
     /**
-     * Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the service ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)), unless `skipSelectedPaymentOptionValidation` is `true`.
+     * Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.
      *
-     * When undefined during an eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)), Wix Bookings uses the service's default payment option
+     * When undefined during an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), Wix Bookings uses the service's default payment option
      */
     selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
     /**
@@ -139,15 +136,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
      */
     doubleBooked?: boolean | null;
     /**
-     * ID of the form submission
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction))
+     * ID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction)
      * associated with this booking.
      * @format GUID
      */
     formSubmissionId?: string | null;
     /**
-     * ID of the form
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object))
+     * ID of the [form](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)
      * associated with this booking. The value depends on how the
      * booking was created:
      * - For bookings created with Create Booking or Bulk Create Booking, `formId`
@@ -164,14 +159,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
 interface BookingParticipantsInfoOneOf {
     /**
      * Total number of participants.
-     * When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * @min 1
      */
     totalParticipants?: number;
     /**
      * Information about the booked service choices and participant count for each choice.
-     * When creating a booking, use this field only if the booking includes multiple service variants
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      *
      * For example, use this for a spa package booking that includes different service levels:
      * - 2 participants chose "Standard Package".
@@ -197,8 +191,7 @@ declare enum MultiServiceBookingType {
 type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
 interface BookedEntity extends BookedEntityItemOneOf {
     /**
-     * Booked slot
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
+     * [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
      *
      * Specify `slot` when creating bookings for:
      * - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
@@ -210,8 +203,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
      */
     slot?: BookedSlot;
     /**
-     * Booked schedule
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
+     * [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
      *
      * Specify `schedule` when creating bookings for:
      * - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
@@ -237,8 +229,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
 /** @oneof */
 interface BookedEntityItemOneOf {
     /**
-     * Booked slot
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
+     * [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
      *
      * Specify `slot` when creating bookings for:
      * - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
@@ -250,8 +241,7 @@ interface BookedEntityItemOneOf {
      */
     slot?: BookedSlot;
     /**
-     * Booked schedule
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
+     * [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
      *
      * Specify `schedule` when creating bookings for:
      * - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
@@ -260,15 +250,27 @@ 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;
     /** Schedule ID. */
     scheduleId?: string;
     /**
-     * ID of the corresponding event
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
+     * ID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
      * Available for both appointment and class bookings, not available for course bookings.
      * For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
      * For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
@@ -286,9 +288,8 @@ interface BookedSlot {
      */
     timezone?: string | null;
     /**
-     * Primary resource
-     * ([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)) for the booking.
-     * For example, the staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)) providing the service.
+     * [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking.
+     * For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service.
      */
     resource?: BookedResource;
     /** Location where the session takes place. */
@@ -370,7 +371,7 @@ declare enum SelectionMethod {
 /** @enumType */
 type SelectionMethodWithLiterals = SelectionMethod | 'UNKNOWN_SELECTION_METHOD' | 'SPECIFIC_RESOURCE' | 'ANY_RESOURCE' | 'NO_SELECTION';
 interface BookedSchedule {
-    /** Schedule ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)). */
+    /** [Schedule ID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). */
     scheduleId?: string;
     /**
      * Booked service ID.
@@ -378,7 +379,7 @@ interface BookedSchedule {
      */
     serviceId?: string | null;
     /**
-     * Location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)) where the schedule's sessions take place.
+     * [Location](https://dev.wix.com/docs/rest/business-management/locations/introduction) where the schedule's sessions take place.
      * @readonly
      */
     location?: Location;
@@ -522,26 +523,18 @@ type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX
 declare enum BookingStatus {
     /** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
     CREATED = "CREATED",
-    /**
-     * The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) to automatically confirm all `PENDING` bookings.
-     */
+    /** The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings. */
     CONFIRMED = "CONFIRMED",
     /**
-     * The customer has canceled the booking. Depending on the relevant service's policy snapshot
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction))
-     * they may have to pay a cancellation fee ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction)).
+     * The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction)
+     * they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
      */
     CANCELED = "CANCELED",
     /** The merchant must manually confirm the booking before it appears in the business calendar. */
     PENDING = "PENDING",
     /** The merchant has declined the booking before the customer was charged. */
     DECLINED = "DECLINED",
-    /**
-     * The booking is on a waitlist.
-     * Currently, you can't call Register to Waitlist ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist)) for course or appointment bookings, even though this is supported in live sites.
-     * You can call Register to Waitlist only for class session bookings.
-     */
+    /** Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites. */
     WAITING_LIST = "WAITING_LIST"
 }
 /** @enumType */
@@ -708,8 +701,7 @@ interface FlowControlSettings {
     skipAvailabilityValidation?: boolean;
     /**
      * Whether the booking's `status` is automatically updated to `CONFIRMED` when
-     * the customer completes the eCommerce checkout
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)),
+     * the customer completes the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),
      * regardless of whether the relevant service requires manual business confirmation.
      */
     skipBusinessConfirmation?: boolean;
@@ -746,7 +738,7 @@ interface ParticipantChoices {
 }
 interface ServiceChoices {
     /**
-     * Number of participants for this variant ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * @min 1
      */
     numberOfParticipants?: number | null;
@@ -1616,8 +1608,7 @@ interface ConfirmOrDeclineBookingRequest {
     bookingId: string;
     /**
      * Current payment status of the booking when using a custom checkout page and
-     * not the *eCommerce checkout*
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
+     * not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
      *
      * The booking is declined if there is a double booking conflict and you provide
      * one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
@@ -1646,8 +1637,7 @@ interface BulkConfirmOrDeclineBookingRequestBookingDetails {
     bookingId?: string;
     /**
      * Current payment status of the booking when using a custom checkout page and
-     * not the *eCommerce checkout*
-     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
+     * not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
      *
      * The booking is declined if there is a double booking conflict and you provide
      * one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
@@ -2868,12 +2858,12 @@ interface RescheduleMultiServiceBookingRequest {
 }
 interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
     /**
-     * Total number of participants. Available only for services with variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * Specify when all participants book the same variant.
      */
     totalParticipants?: number;
     /**
-     * Information about the service choices to book. Available only for services with variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * Specify when not all participants book the same variant.
      */
     participantsChoices?: ParticipantChoices;
@@ -2893,12 +2883,12 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
 /** @oneof */
 interface RescheduleBookingInfoParticipantsInfoOneOf {
     /**
-     * Total number of participants. Available only for services with variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * Specify when all participants book the same variant.
      */
     totalParticipants?: number;
     /**
-     * Information about the service choices to book. Available only for services with variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+     * Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
      * Specify when not all participants book the same variant.
      */
     participantsChoices?: ParticipantChoices;