@wix/auto_sdk_bookings_pricing 1.0.29 → 1.0.31

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

@@ -192,16 +192,19 @@ interface CalculatePriceRequest {
 /** An entity representing a scheduled appointment, class session, or course. */
 interface Booking extends BookingParticipantsInfoOneOf {
     /**
-     * Total number of participants. Available only when the relevant service
-     * doesn't have _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)).
+     * 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)).
      * @min 1
      */
     totalParticipants?: number;
     /**
-     * Information about the booked service choices and participants.
-     * Available only when the booking includes multiple _service variants_
+     * 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)).
+     *
+     * For example, use this for a spa package booking that includes different service levels:
+     * - 2 participants chose "Standard Package".
+     * - 1 participant chose "VIP Package".
      */
     participantsChoices?: ParticipantChoices;
     /**
@@ -211,15 +214,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
      */
     _id?: string | null;
     /**
-     * An object describing the *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))
-     * or *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))
-     * that was booked.
+     * An object describing the bookable entity - either a specific time slot or a recurring schedule.
+     *
+     * The structure depends on the type of service being booked:
+     *
+     * *For appointment services:** Use `slot` to book a specific time slot with a
+     * service provider. Appointments are typically one-time sessions at a specific date and time.
+     *
+     * *For class services:** Use `slot` to book a specific class session. Classes
+     * are individual sessions that can have multiple participants.
+     *
+     * *For course services:** Use `schedule` to book an entire course consisting of
+     * multiple sessions over time. Courses are recurring, multi-session offerings.
+     *
+     * Choose the appropriate field based on your service type and booking requirements.
      */
     bookedEntity?: BookedEntity;
     /**
-     * Contact details of the site visitor or *member*
+     * 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))
      * making the booking.
      */
@@ -234,20 +246,27 @@ interface Booking extends BookingParticipantsInfoOneOf {
      */
     status?: BookingStatusWithLiterals;
     /**
-     * The payment status of the booking corresponds to the `paymentStatus` of the
-     * related *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)),
-     * if one exists. All payment statuses are supported for every booking `status`.
+     * 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))
+     * when customers use Wix eCommerce checkout.
+     *
+     * ## Integration patterns
+     *
+     * *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-writer-v2/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.
+     *
+     * *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.
+     *
+     * 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`.
-     * 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
+     * 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`.
+     *
+     * 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
      */
     selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
     /**
@@ -258,10 +277,8 @@ interface Booking extends BookingParticipantsInfoOneOf {
     /** External user ID that you can provide. */
     externalUserId?: string | null;
     /**
-     * Revision number to be used when updating, rescheduling, or cancelling the
-     * booking. Increments by 1 each time the booking is updated, rescheduled, or
-     * canceled. To prevent conflicting changes, the current revision must be
-     * specified when updating the booking.
+     * Revision number to be used when updating, rescheduling, or cancelling the booking.
+     * Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking.
      */
     revision?: string | null;
     /**
@@ -302,21 +319,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
 /** @oneof */
 interface BookingParticipantsInfoOneOf {
     /**
-     * Total number of participants. Available only when the relevant service
-     * doesn't have _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)).
+     * 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)).
      * @min 1
      */
     totalParticipants?: number;
     /**
-     * Information about the booked service choices and participants.
-     * Available only when the booking includes multiple _service variants_
+     * 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)).
+     *
+     * For example, use this for a spa package booking that includes different service levels:
+     * - 2 participants chose "Standard Package".
+     * - 1 participant chose "VIP Package".
      */
     participantsChoices?: ParticipantChoices;
 }
 /**
- * A multi-service booking is considered available if all individual bookings are available as returned from List Multi Service Availability Time Slots.
+ * A multi-service booking is considered available if all single-service bookings are available as returned from List Multi Service Availability Time Slots.
  * Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
  * Multi-service booking is available if each of its bookings is available separately.
  * For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
@@ -330,22 +350,30 @@ declare enum MultiServiceBookingType {
 type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
 interface BookedEntity extends BookedEntityItemOneOf {
     /**
-     * Booked *slot*
+     * 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)).
-     * Available only for appointment-based services and classes.
-     * For appointment-based services, a new session is created, while for classes,
-     * the booking is automatically linked to the existing session.
+     *
+     * Specify `slot` when creating bookings for:
+     * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
+     * Wix Bookings creates a new session when the booking is confirmed.
+     * - **Class services:** Group sessions at specific times (fitness classes, workshops).
+     * Wix Bookings links the booking to an existing scheduled session.
+     *
+     * For course services, specify `schedule` instead of `slot`.
      */
     slot?: BookedSlot;
     /**
-     * Booked *schedule*
+     * 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)).
-     * Available only for course bookings.
+     *
+     * Specify `schedule` when creating bookings for:
+     * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
+     * Wix Bookings enrolls participants in all sessions defined by the course schedule.
      */
     schedule?: BookedSchedule;
     /**
      * Session title at the time of booking. If there is no pre-existing session,
-     * for example for appointment-based services, `title` is set to the service name.
+     * for example for appointment-based services, Wix Bookings sets `title` to the service name.
      * @readonly
      * @maxLength 6000
      */
@@ -362,17 +390,25 @@ interface BookedEntity extends BookedEntityItemOneOf {
 /** @oneof */
 interface BookedEntityItemOneOf {
     /**
-     * Booked *slot*
+     * 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)).
-     * Available only for appointment-based services and classes.
-     * For appointment-based services, a new session is created, while for classes,
-     * the booking is automatically linked to the existing session.
+     *
+     * Specify `slot` when creating bookings for:
+     * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
+     * Wix Bookings creates a new session when the booking is confirmed.
+     * - **Class services:** Group sessions at specific times (fitness classes, workshops).
+     * Wix Bookings links the booking to an existing scheduled session.
+     *
+     * For course services, specify `schedule` instead of `slot`.
      */
     slot?: BookedSlot;
     /**
-     * Booked *schedule*
+     * 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)).
-     * Available only for course bookings.
+     *
+     * Specify `schedule` when creating bookings for:
+     * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
+     * Wix Bookings enrolls participants in all sessions defined by the course schedule.
      */
     schedule?: BookedSchedule;
 }
@@ -384,35 +420,25 @@ interface BookedSlot {
     /** Schedule ID. */
     scheduleId?: string;
     /**
-     * ID of the corresponding *event*
+     * 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)).
      * 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, it's
-     * automatically populated upon booking creation.
+     * 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.
      * @minLength 36
      * @maxLength 250
      */
     eventId?: string | null;
-    /**
-     * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format.
-     */
+    /** The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
     startDate?: string | null;
-    /**
-     * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format.
-     */
+    /** The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
     endDate?: string | null;
-    /** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
+    /** The time zone according to which the slot was shown to the user when booking, and should be shown in the future. */
     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
+     * ([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.
      */
     resource?: BookedResource;
     /** Location where the session takes place. */
@@ -474,10 +500,7 @@ declare enum LocationType {
 /** @enumType */
 type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
 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 ([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)). */
     scheduleId?: string;
     /**
      * Booked service ID.
@@ -485,26 +508,22 @@ 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 ([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.
      * @readonly
      */
     location?: Location;
     /**
-     * Timezone in which the slot or session was shown to the customer when they booked.
+     * Time zone in which the slot or session was shown to the customer when they booked.
      * Also used whenever the customer reviews the booking's timing in the future.
      */
     timezone?: string | null;
     /**
-     * Start time of the first session related to the booking in
-     * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
+     * Start time of the first session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
      * @readonly
      */
     firstSessionStart?: string | null;
     /**
-     * End time of the last session related to the booking in
-     * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
+     * End time of the last session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
      * @readonly
      */
     lastSessionEnd?: string | null;
@@ -631,38 +650,26 @@ declare enum ValueType {
 type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
 /** Booking status. */
 declare enum BookingStatus {
-    /**
-     * The booking was created, but the customer hasn't completed the related
-     * eCommerce order yet.
-     */
+    /** 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
+     * ([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.
      */
     CONFIRMED = "CONFIRMED",
     /**
-     * The customer has canceled the booking. Depending on the relevant service's
-     * _policy snapshot_
+     * 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)).
+     * 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)).
      */
     CANCELED = "CANCELED",
-    /**
-     * The merchant must manually confirm the booking before it appears
-     * in the business calendar.
-     */
+    /** 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.
+     * 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.
      */
     WAITING_LIST = "WAITING_LIST"
@@ -813,12 +820,25 @@ declare enum IdentityType {
 }
 /** @enumType */
 type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/**
+ * Settings that control booking flow behavior and override default business rules.
+ *
+ * These settings allow administrators to bypass standard validation checks
+ * and policies when creating, confirming, rescheduling, or canceling bookings.
+ * Most settings require elevated permissions to use.
+ *
+ * Use flow control settings to handle special scenarios like:
+ * - Emergency bookings outside normal business hours
+ * - Admin-initiated bookings that bypass availability checks
+ * - Custom payment flows that don't use standard eCommerce checkout
+ * - Overriding cancellation or rescheduling policies in exceptional cases
+ */
 interface FlowControlSettings {
     /** Whether availability is checked when creating or confirming the booking. */
     skipAvailabilityValidation?: boolean;
     /**
      * Whether the booking's `status` is automatically updated to `CONFIRMED` when
-     * the customer completes the *eCommerce checkout*
+     * 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)),
      * regardless of whether the relevant service requires manual business confirmation.
      */
@@ -856,8 +876,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 ([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)).
      * @min 1
      */
     numberOfParticipants?: number | null;
@@ -879,36 +898,36 @@ interface MultiServiceBookingInfo {
 }
 interface BookedAddOn {
     /**
-     * The ID of the Add-On.
+     * The ID of the add-on.
      * @format GUID
      */
     _id?: string;
     /**
-     * The ID of the Add-Ons group.
+     * The ID of the add-on group.
      * @format GUID
      */
     groupId?: string;
     /**
-     * The Add-On duration in minutes at the time of Booking.
+     * The add-on duration in minutes at the time of booking.
      * @min 1
      * @max 1440
      * @readonly
      */
     durationInMinutes?: number | null;
     /**
-     * The quantity of booked Add-Ons.
+     * The quantity of booked add-ons.
      * @min 1
      * @max 1000
      */
     quantity?: number | null;
     /**
-     * Add-On name at the time of booking.
+     * Add-on `name` at the time of booking.
      * @maxLength 100
      * @readonly
      */
     name?: string | null;
     /**
-     * Add-On name translated to the language the booking was made in.
+     * Add-on name translated to the language the customer used during booking.
      * @maxLength 100
      * @readonly
      */