@wix/auto_sdk_bookings_bookings 1.0.40 → 1.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,16 +3,19 @@ import { NonNullablePaths } from '@wix/sdk-types';
3
3
  /** An entity representing a scheduled appointment, class session, or course. */
4
4
  interface Booking extends BookingParticipantsInfoOneOf {
5
5
  /**
6
- * Total number of participants. Available only when the relevant service
7
- * doesn't have _variants and options_
8
- * ([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)).
6
+ * Total number of participants.
7
+ * 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)).
9
8
  * @min 1
10
9
  */
11
10
  totalParticipants?: number;
12
11
  /**
13
- * Information about the booked service choices and participants.
14
- * Available only when the booking includes multiple _service variants_
12
+ * Information about the booked service choices and participant count for each choice.
13
+ * When creating a booking, use this field only if the booking includes multiple service variants
15
14
  * ([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)).
15
+ *
16
+ * For example, use this for a spa package booking that includes different service levels:
17
+ * - 2 participants chose "Standard Package".
18
+ * - 1 participant chose "VIP Package".
16
19
  */
17
20
  participantsChoices?: ParticipantChoices;
18
21
  /**
@@ -22,15 +25,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
22
25
  */
23
26
  _id?: string | null;
24
27
  /**
25
- * An object describing the *slot*
26
- * ([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))
27
- * or *schedule*
28
- * ([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))
29
- * that was booked.
28
+ * An object describing the bookable entity - either a specific time slot or a recurring schedule.
29
+ *
30
+ * The structure depends on the type of service being booked:
31
+ *
32
+ * *For appointment services:** Use `slot` to book a specific time slot with a
33
+ * service provider. Appointments are typically one-time sessions at a specific date and time.
34
+ *
35
+ * *For class services:** Use `slot` to book a specific class session. Classes
36
+ * are individual sessions that can have multiple participants.
37
+ *
38
+ * *For course services:** Use `schedule` to book an entire course consisting of
39
+ * multiple sessions over time. Courses are recurring, multi-session offerings.
40
+ *
41
+ * Choose the appropriate field based on your service type and booking requirements.
30
42
  */
31
43
  bookedEntity?: BookedEntity;
32
44
  /**
33
- * Contact details of the site visitor or *member*
45
+ * Contact details of the site visitor or member
34
46
  * ([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))
35
47
  * making the booking.
36
48
  */
@@ -45,20 +57,27 @@ interface Booking extends BookingParticipantsInfoOneOf {
45
57
  */
46
58
  status?: BookingStatusWithLiterals;
47
59
  /**
48
- * The payment status of the booking corresponds to the `paymentStatus` of the
49
- * related *eCommerce order*
50
- * ([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)),
51
- * if one exists. All payment statuses are supported for every booking `status`.
60
+ * The payment status of the booking. This field automatically syncs with the
61
+ * `paymentStatus` of the corresponding eCommerce order
62
+ * ([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))
63
+ * when customers use Wix eCommerce checkout.
64
+ *
65
+ * ## Integration patterns
66
+ *
67
+ * *When using Wix eCommerce checkout:** Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
68
+ * Do not manually update this field.
69
+ *
70
+ * *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.
71
+ *
72
+ * *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.
73
+ *
74
+ * All payment statuses are supported for every booking `status`.
52
75
  */
53
76
  paymentStatus?: PaymentStatusWithLiterals;
54
77
  /**
55
- * Payment option selected by the customer. If the customer hasn't completed their
56
- * checkout, they may still change the payment method. Must be one of the payment
57
- * 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)),
58
- * unless `skipSelectedPaymentOptionValidation` is `true`.
59
- * When undefined during an *eCommerce checkout*
60
- * ([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)),
61
- * Wix Bookings uses the service's default payment option
78
+ * 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`.
79
+ *
80
+ * 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
62
81
  */
63
82
  selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
64
83
  /**
@@ -69,10 +88,8 @@ interface Booking extends BookingParticipantsInfoOneOf {
69
88
  /** External user ID that you can provide. */
70
89
  externalUserId?: string | null;
71
90
  /**
72
- * Revision number to be used when updating, rescheduling, or cancelling the
73
- * booking. Increments by 1 each time the booking is updated, rescheduled, or
74
- * canceled. To prevent conflicting changes, the current revision must be
75
- * specified when updating the booking.
91
+ * Revision number to be used when updating, rescheduling, or cancelling the booking.
92
+ * 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.
76
93
  */
77
94
  revision?: string | null;
78
95
  /**
@@ -113,21 +130,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
113
130
  /** @oneof */
114
131
  interface BookingParticipantsInfoOneOf {
115
132
  /**
116
- * Total number of participants. Available only when the relevant service
117
- * doesn't have _variants and options_
118
- * ([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)).
133
+ * Total number of participants.
134
+ * 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)).
119
135
  * @min 1
120
136
  */
121
137
  totalParticipants?: number;
122
138
  /**
123
- * Information about the booked service choices and participants.
124
- * Available only when the booking includes multiple _service variants_
139
+ * Information about the booked service choices and participant count for each choice.
140
+ * When creating a booking, use this field only if the booking includes multiple service variants
125
141
  * ([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)).
142
+ *
143
+ * For example, use this for a spa package booking that includes different service levels:
144
+ * - 2 participants chose "Standard Package".
145
+ * - 1 participant chose "VIP Package".
126
146
  */
127
147
  participantsChoices?: ParticipantChoices;
128
148
  }
129
149
  /**
130
- * A multi-service booking is considered available if all individual bookings are available as returned from List Multi Service Availability Time Slots.
150
+ * A multi-service booking is considered available if all single-service bookings are available as returned from List Multi Service Availability Time Slots.
131
151
  * Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
132
152
  * Multi-service booking is available if each of its bookings is available separately.
133
153
  * For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
@@ -141,22 +161,30 @@ declare enum MultiServiceBookingType {
141
161
  type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
142
162
  interface BookedEntity extends BookedEntityItemOneOf {
143
163
  /**
144
- * Booked *slot*
164
+ * Booked slot
145
165
  * ([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)).
146
- * Available only for appointment-based services and classes.
147
- * For appointment-based services, a new session is created, while for classes,
148
- * the booking is automatically linked to the existing session.
166
+ *
167
+ * Specify `slot` when creating bookings for:
168
+ * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
169
+ * Wix Bookings creates a new session when the booking is confirmed.
170
+ * - **Class services:** Group sessions at specific times (fitness classes, workshops).
171
+ * Wix Bookings links the booking to an existing scheduled session.
172
+ *
173
+ * For course services, specify `schedule` instead of `slot`.
149
174
  */
150
175
  slot?: BookedSlot;
151
176
  /**
152
- * Booked *schedule*
177
+ * Booked schedule
153
178
  * ([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)).
154
- * Available only for course bookings.
179
+ *
180
+ * Specify `schedule` when creating bookings for:
181
+ * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
182
+ * Wix Bookings enrolls participants in all sessions defined by the course schedule.
155
183
  */
156
184
  schedule?: BookedSchedule;
157
185
  /**
158
186
  * Session title at the time of booking. If there is no pre-existing session,
159
- * for example for appointment-based services, `title` is set to the service name.
187
+ * for example for appointment-based services, Wix Bookings sets `title` to the service name.
160
188
  * @readonly
161
189
  * @maxLength 6000
162
190
  */
@@ -173,17 +201,25 @@ interface BookedEntity extends BookedEntityItemOneOf {
173
201
  /** @oneof */
174
202
  interface BookedEntityItemOneOf {
175
203
  /**
176
- * Booked *slot*
204
+ * Booked slot
177
205
  * ([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)).
178
- * Available only for appointment-based services and classes.
179
- * For appointment-based services, a new session is created, while for classes,
180
- * the booking is automatically linked to the existing session.
206
+ *
207
+ * Specify `slot` when creating bookings for:
208
+ * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
209
+ * Wix Bookings creates a new session when the booking is confirmed.
210
+ * - **Class services:** Group sessions at specific times (fitness classes, workshops).
211
+ * Wix Bookings links the booking to an existing scheduled session.
212
+ *
213
+ * For course services, specify `schedule` instead of `slot`.
181
214
  */
182
215
  slot?: BookedSlot;
183
216
  /**
184
- * Booked *schedule*
217
+ * Booked schedule
185
218
  * ([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)).
186
- * Available only for course bookings.
219
+ *
220
+ * Specify `schedule` when creating bookings for:
221
+ * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
222
+ * Wix Bookings enrolls participants in all sessions defined by the course schedule.
187
223
  */
188
224
  schedule?: BookedSchedule;
189
225
  }
@@ -195,35 +231,25 @@ interface BookedSlot {
195
231
  /** Schedule ID. */
196
232
  scheduleId?: string;
197
233
  /**
198
- * ID of the corresponding *event*
234
+ * ID of the corresponding event
199
235
  * ([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)).
200
236
  * Available for both appointment and class bookings, not available for course bookings.
201
- * For appointment-based services, Wix Bookings automatically populates `eventId`
202
- * when the booking `status` changes to `CONFIRMED`. For class bookings, it's
203
- * automatically populated upon booking creation.
237
+ * For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
238
+ * For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
204
239
  * @minLength 36
205
240
  * @maxLength 250
206
241
  */
207
242
  eventId?: string | null;
208
- /**
209
- * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
210
- * format.
211
- */
243
+ /** The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
212
244
  startDate?: string | null;
213
- /**
214
- * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
215
- * format.
216
- */
245
+ /** The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
217
246
  endDate?: string | null;
218
- /** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
247
+ /** The time zone according to which the slot was shown to the user when booking, and should be shown in the future. */
219
248
  timezone?: string | null;
220
249
  /**
221
- * Primary *resource*
222
- * ([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))
223
- * for the booking. For example, the *staff member*
224
- * ([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))
225
- * providing the
226
- * service.
250
+ * Primary resource
251
+ * ([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.
252
+ * 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.
227
253
  */
228
254
  resource?: BookedResource;
229
255
  /** Location where the session takes place. */
@@ -285,10 +311,7 @@ declare enum LocationType {
285
311
  /** @enumType */
286
312
  type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
287
313
  interface BookedSchedule {
288
- /**
289
- * _Schedule ID_
290
- * ([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)).
291
- */
314
+ /** 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)). */
292
315
  scheduleId?: string;
293
316
  /**
294
317
  * Booked service ID.
@@ -296,26 +319,22 @@ interface BookedSchedule {
296
319
  */
297
320
  serviceId?: string | null;
298
321
  /**
299
- * _Location_
300
- * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
301
- * where the schedule's sessions take place.
322
+ * 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.
302
323
  * @readonly
303
324
  */
304
325
  location?: Location;
305
326
  /**
306
- * Timezone in which the slot or session was shown to the customer when they booked.
327
+ * Time zone in which the slot or session was shown to the customer when they booked.
307
328
  * Also used whenever the customer reviews the booking's timing in the future.
308
329
  */
309
330
  timezone?: string | null;
310
331
  /**
311
- * Start time of the first session related to the booking in
312
- * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
332
+ * Start time of the first session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
313
333
  * @readonly
314
334
  */
315
335
  firstSessionStart?: string | null;
316
336
  /**
317
- * End time of the last session related to the booking in
318
- * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
337
+ * End time of the last session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
319
338
  * @readonly
320
339
  */
321
340
  lastSessionEnd?: string | null;
@@ -442,38 +461,26 @@ declare enum ValueType {
442
461
  type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
443
462
  /** Booking status. */
444
463
  declare enum BookingStatus {
445
- /**
446
- * The booking was created, but the customer hasn't completed the related
447
- * eCommerce order yet.
448
- */
464
+ /** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
449
465
  CREATED = "CREATED",
450
466
  /**
451
- * The merchant has confirmed the booking and it appears in the
452
- * business calendar. Merchants can set up their *services*
453
- * ([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))
454
- * to automatically confirm all `PENDING` bookings.
467
+ * The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
468
+ * ([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.
455
469
  */
456
470
  CONFIRMED = "CONFIRMED",
457
471
  /**
458
- * The customer has canceled the booking. Depending on the relevant service's
459
- * _policy snapshot_
472
+ * The customer has canceled the booking. Depending on the relevant service's policy snapshot
460
473
  * ([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))
461
- * they may have to pay a _cancellation fee_
462
- * ([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)).
474
+ * 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)).
463
475
  */
464
476
  CANCELED = "CANCELED",
465
- /**
466
- * The merchant must manually confirm the booking before it appears
467
- * in the business calendar.
468
- */
477
+ /** The merchant must manually confirm the booking before it appears in the business calendar. */
469
478
  PENDING = "PENDING",
470
479
  /** The merchant has declined the booking before the customer was charged. */
471
480
  DECLINED = "DECLINED",
472
481
  /**
473
482
  * The booking is on a waitlist.
474
- * Currently, you can't call Register to Waitlist
475
- * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist))
476
- * for course or appointment bookings, even though this is supported in live sites.
483
+ * 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.
477
484
  * You can call Register to Waitlist only for class session bookings.
478
485
  */
479
486
  WAITING_LIST = "WAITING_LIST"
@@ -624,12 +631,25 @@ declare enum IdentificationDataIdentityType {
624
631
  }
625
632
  /** @enumType */
626
633
  type IdentificationDataIdentityTypeWithLiterals = IdentificationDataIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
634
+ /**
635
+ * Settings that control booking flow behavior and override default business rules.
636
+ *
637
+ * These settings allow administrators to bypass standard validation checks
638
+ * and policies when creating, confirming, rescheduling, or canceling bookings.
639
+ * Most settings require elevated permissions to use.
640
+ *
641
+ * Use flow control settings to handle special scenarios like:
642
+ * - Emergency bookings outside normal business hours
643
+ * - Admin-initiated bookings that bypass availability checks
644
+ * - Custom payment flows that don't use standard eCommerce checkout
645
+ * - Overriding cancellation or rescheduling policies in exceptional cases
646
+ */
627
647
  interface FlowControlSettings {
628
648
  /** Whether availability is checked when creating or confirming the booking. */
629
649
  skipAvailabilityValidation?: boolean;
630
650
  /**
631
651
  * Whether the booking's `status` is automatically updated to `CONFIRMED` when
632
- * the customer completes the *eCommerce checkout*
652
+ * the customer completes the eCommerce checkout
633
653
  * ([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)),
634
654
  * regardless of whether the relevant service requires manual business confirmation.
635
655
  */
@@ -667,8 +687,7 @@ interface ParticipantChoices {
667
687
  }
668
688
  interface ServiceChoices {
669
689
  /**
670
- * Number of participants for this _variant_
671
- * ([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)).
690
+ * 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)).
672
691
  * @min 1
673
692
  */
674
693
  numberOfParticipants?: number | null;
@@ -733,36 +752,36 @@ interface MultiServiceBookingInfo {
733
752
  }
734
753
  interface BookedAddOn {
735
754
  /**
736
- * The ID of the Add-On.
755
+ * The ID of the add-on.
737
756
  * @format GUID
738
757
  */
739
758
  _id?: string;
740
759
  /**
741
- * The ID of the Add-Ons group.
760
+ * The ID of the add-on group.
742
761
  * @format GUID
743
762
  */
744
763
  groupId?: string;
745
764
  /**
746
- * The Add-On duration in minutes at the time of Booking.
765
+ * The add-on duration in minutes at the time of booking.
747
766
  * @min 1
748
767
  * @max 1440
749
768
  * @readonly
750
769
  */
751
770
  durationInMinutes?: number | null;
752
771
  /**
753
- * The quantity of booked Add-Ons.
772
+ * The quantity of booked add-ons.
754
773
  * @min 1
755
774
  * @max 1000
756
775
  */
757
776
  quantity?: number | null;
758
777
  /**
759
- * Add-On name at the time of booking.
778
+ * Add-on `name` at the time of booking.
760
779
  * @maxLength 100
761
780
  * @readonly
762
781
  */
763
782
  name?: string | null;
764
783
  /**
765
- * Add-On name translated to the language the booking was made in.
784
+ * Add-on name translated to the language the customer used during booking.
766
785
  * @maxLength 100
767
786
  * @readonly
768
787
  */
@@ -1482,7 +1501,14 @@ interface CreateBookingFlowControlSettings {
1482
1501
  /**
1483
1502
  * Whether the availability is checked before creating the booking.
1484
1503
  *
1485
- * When passing `false`, a booking is only created when the slot or schedule is available.
1504
+ * - `false`: A booking is only created when the slot or schedule is available.
1505
+ * - `true`: The booking is created regardless of availability conflicts. Make sure the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has the required permissions.
1506
+ *
1507
+ * *Use cases for `true`:**
1508
+ * - Emergency or priority bookings that must be accommodated.
1509
+ * - Administrative bookings that override normal availability rules.
1510
+ * - Testing or demonstration purposes.
1511
+ *
1486
1512
  * Default: `false`.
1487
1513
  */
1488
1514
  skipAvailabilityValidation?: boolean;
@@ -2595,47 +2621,58 @@ interface CountBookingsResponse {
2595
2621
  }
2596
2622
  interface CreateMultiServiceBookingRequest {
2597
2623
  /**
2598
- * Single-service bookings to combine in a multi-service booking.
2624
+ * Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
2625
+ *
2626
+ * Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
2627
+ * Specify contact details, number of participants, and any additional fields as needed.
2628
+ *
2629
+ * For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
2599
2630
  * @minSize 2
2600
2631
  * @maxSize 8
2601
2632
  */
2602
2633
  bookings: Booking[];
2603
- /**
2604
- * Information about whether to notify the customer and
2605
- * the message to send.
2606
- */
2634
+ /** Information about whether to notify the customer and the message to send. */
2607
2635
  participantNotification?: ParticipantNotification;
2608
2636
  /**
2609
- * Whether to send an SMS reminder to the customer 24 hours before the
2610
- * session starts. The phone number is taken from `contactDetails.phone`.
2637
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
2638
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
2611
2639
  *
2612
2640
  * Default: `true`
2613
2641
  */
2614
2642
  sendSmsReminder?: boolean | null;
2615
2643
  /**
2616
2644
  * Whether to ignore specific standard procedures of the Wix Bookings flow.
2617
- * For example, whether to check availability before updating the status.
2645
+ * For example, whether to skip checking availability before updating the status.
2618
2646
  */
2619
2647
  flowControlSettings?: CreateBookingFlowControlSettings;
2620
2648
  /** Whether to return the created single-service bookings. */
2621
2649
  returnFullEntity?: boolean;
2622
- /** Multi service booking type. */
2650
+ /**
2651
+ * Multi-service booking type.
2652
+ *
2653
+ * Currently only `SEQUENTIAL_BOOKINGS` is supported, where you must schedule single-service bookings back-to-back with each booking starting when the previous 1 ends.
2654
+ */
2623
2655
  multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
2624
2656
  }
2625
2657
  interface CreateMultiServiceBookingResponse {
2626
2658
  /**
2627
- * Created multi service booking.
2628
- * Contains the booking results in the same order as specified in the request.
2659
+ * Created multi-service booking.
2660
+ * Contains the single-service bookings in the same order as specified in the request.
2629
2661
  */
2630
2662
  multiServiceBooking?: MultiServiceBooking;
2631
2663
  }
2664
+ /**
2665
+ * A multi-service booking combines multiple single-service bookings into a package.
2666
+ *
2667
+ * Currently, multi-service bookings support only sequential scheduling where services are scheduled back-to-back at the same location, with each single-service booking starting when the previous 1 ends.
2668
+ */
2632
2669
  interface MultiServiceBooking {
2633
2670
  /**
2634
2671
  * Multi-service booking ID.
2635
2672
  * @format GUID
2636
2673
  */
2637
2674
  _id?: string | null;
2638
- /** The created bookings that are part of the multi-service booking. */
2675
+ /** The single-service bookings that make up the multi-service booking package. */
2639
2676
  bookings?: BookingResult[];
2640
2677
  }
2641
2678
  interface BookingResult {
@@ -2649,22 +2686,17 @@ interface BookingResult {
2649
2686
  }
2650
2687
  interface RescheduleMultiServiceBookingRequest {
2651
2688
  /**
2652
- * ID of the multi service booking to reschedule.
2689
+ * ID of the multi-service booking to reschedule.
2653
2690
  * @format GUID
2654
2691
  */
2655
2692
  multiServiceBookingId: string | null;
2656
2693
  /** Information about the single-service bookings to reschedule. */
2657
2694
  rescheduleBookingsInfo: RescheduleBookingInfo[];
2658
- /**
2659
- * Information about whether to notify the customer and
2660
- * the message to send.
2661
- */
2695
+ /** Information about whether to notify the customer and the message to send. */
2662
2696
  participantNotification?: ParticipantNotification;
2663
2697
  /**
2664
- * Information about whether specific procedures of the standard Wix Bookings
2665
- * rescheduling flow are changed. For example, whether the availability of
2666
- * the new slot is checked before rescheduling the booking or if you can
2667
- * reschedule the booking even though the rescheduling policy doesn't allow it.
2698
+ * Information about whether specific procedures of the standard Wix Bookings rescheduling flow are changed.
2699
+ * For example, whether the availability of the new slot is checked before rescheduling the booking or if the customer can reschedule the booking even though the service's rescheduling policy doesn't allow it.
2668
2700
  */
2669
2701
  flowControlSettings?: RescheduleBookingFlowControlSettings;
2670
2702
  /** Whether to return the rescheduled bookings entities. */
@@ -2672,13 +2704,12 @@ interface RescheduleMultiServiceBookingRequest {
2672
2704
  }
2673
2705
  interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
2674
2706
  /**
2675
- * Total number of participants. Available only for services with variants.
2707
+ * 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)).
2676
2708
  * Specify when all participants book the same variant.
2677
2709
  */
2678
2710
  totalParticipants?: number;
2679
2711
  /**
2680
- * Information about the service choices to book. Available only for services with
2681
- * variants.
2712
+ * 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)).
2682
2713
  * Specify when not all participants book the same variant.
2683
2714
  */
2684
2715
  participantsChoices?: ParticipantChoices;
@@ -2691,21 +2722,19 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
2691
2722
  slot?: V2Slot;
2692
2723
  /**
2693
2724
  * Revision number, which increments by 1 each time the booking is updated.
2694
- * To prevent conflicting changes, the current revision must be specified when
2695
- * managing the booking.
2725
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
2696
2726
  */
2697
2727
  revision?: string | null;
2698
2728
  }
2699
2729
  /** @oneof */
2700
2730
  interface RescheduleBookingInfoParticipantsInfoOneOf {
2701
2731
  /**
2702
- * Total number of participants. Available only for services with variants.
2732
+ * 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)).
2703
2733
  * Specify when all participants book the same variant.
2704
2734
  */
2705
2735
  totalParticipants?: number;
2706
2736
  /**
2707
- * Information about the service choices to book. Available only for services with
2708
- * variants.
2737
+ * 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)).
2709
2738
  * Specify when not all participants book the same variant.
2710
2739
  */
2711
2740
  participantsChoices?: ParticipantChoices;
@@ -2728,11 +2757,11 @@ interface GetMultiServiceBookingAvailabilityResponse {
2728
2757
  totalCapacity?: number | null;
2729
2758
  /** Number of open spots. */
2730
2759
  remainingCapacity?: number | null;
2731
- /** Indicators for policy violations of the multi service booking. */
2760
+ /** Indicators for policy violations of the multi-service booking. */
2732
2761
  policyViolations?: BookingPolicyViolations;
2733
2762
  /** Multi-service booking policy settings. */
2734
2763
  policySettings?: BookingPolicySettings;
2735
- /** Info of the bookings this availability was calculated for. */
2764
+ /** Details of the multi-service booking. */
2736
2765
  multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
2737
2766
  }
2738
2767
  interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
@@ -2748,16 +2777,11 @@ interface CancelMultiServiceBookingRequest {
2748
2777
  * @format GUID
2749
2778
  */
2750
2779
  multiServiceBookingId: string | null;
2751
- /**
2752
- * Information about whether to notify the customer and
2753
- * the message to send.
2754
- */
2780
+ /** Information about whether to notify the customer and the message to send. */
2755
2781
  participantNotification?: ParticipantNotification;
2756
2782
  /**
2757
- * Information about whether specific procedures of the standard Wix Bookings
2758
- * cancellation flow are changed. For example, whether you can cancel
2759
- * a booking even though the cancellation policy doesn't allow it or whether
2760
- * to issue a refund.
2783
+ * Information about whether specific procedures of the standard Wix Bookings cancellation flow are changed.
2784
+ * For example, whether the customer can cancel the booking even though the service's cancellation policy doesn't allow it or whether to issue a refund upon cancellation.
2761
2785
  */
2762
2786
  flowControlSettings?: CancelBookingFlowControlSettings;
2763
2787
  /** Whether to return the canceled single-service bookings. */
@@ -2775,14 +2799,11 @@ interface MarkMultiServiceBookingAsPendingRequest {
2775
2799
  multiServiceBookingId: string | null;
2776
2800
  /** Information about the single-service bookings to mark as `PENDING`. */
2777
2801
  markAsPendingBookingsInfo?: BookingInfo[];
2778
- /**
2779
- * Information about whether to notify the customer and
2780
- * the message to send.
2781
- */
2802
+ /** Information about whether to notify the customer and the message to send. */
2782
2803
  participantNotification?: ParticipantNotification;
2783
2804
  /**
2784
- * Whether to send an SMS reminder to the customer 24 hours before the
2785
- * session starts. The phone number is taken from `contactDetails.phone`.
2805
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
2806
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
2786
2807
  *
2787
2808
  * Default: `true`
2788
2809
  */
@@ -2792,9 +2813,8 @@ interface MarkMultiServiceBookingAsPendingRequest {
2792
2813
  /** Whether to return the single-service bookings that were marked as `PENDING`. */
2793
2814
  returnFullEntity?: boolean;
2794
2815
  /**
2795
- * Information about whether specific procedures of the standard Wix Bookings
2796
- * creation flow are changed. For example, whether the availability is checked
2797
- * before updating the booking.
2816
+ * Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
2817
+ * For example, whether Wix Bookings checks availability before updating the booking.
2798
2818
  */
2799
2819
  flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
2800
2820
  }
@@ -2806,8 +2826,7 @@ interface BookingInfo {
2806
2826
  bookingId?: string | null;
2807
2827
  /**
2808
2828
  * Revision number, which increments by 1 each time the booking is updated.
2809
- * To prevent conflicting changes, the current revision must be specified when
2810
- * managing the booking.
2829
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
2811
2830
  */
2812
2831
  revision?: string | null;
2813
2832
  /** Payment status to set for the single-service booking. */
@@ -2825,14 +2844,11 @@ interface ConfirmMultiServiceBookingRequest {
2825
2844
  multiServiceBookingId: string | null;
2826
2845
  /** Information about the single-service bookings to confirm. */
2827
2846
  confirmBookingsInfo?: BookingInfo[];
2828
- /**
2829
- * Information about whether to notify the customer and
2830
- * the message to send.
2831
- */
2847
+ /** Information about whether to notify the customer and the message to send. */
2832
2848
  participantNotification?: ParticipantNotification;
2833
2849
  /**
2834
- * Whether to send an SMS reminder to the customer 24 hours before the
2835
- * session starts. The phone number is taken from `contactDetails.phone`.
2850
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
2851
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
2836
2852
  *
2837
2853
  * Default: `true`
2838
2854
  */
@@ -2842,36 +2858,32 @@ interface ConfirmMultiServiceBookingRequest {
2842
2858
  /** Whether to return the confirmed single-service bookings. */
2843
2859
  returnFullEntity?: boolean;
2844
2860
  /**
2845
- * Information about whether specific procedures of the standard Wix Bookings
2846
- * confirmation flow are changed. For example, whether the availability is
2847
- * checked before confirming the booking.
2861
+ * Information about whether specific procedures of the standard Wix Bookings confirmation flow are changed.
2862
+ * For example, whether Wix Bookings checks availability before confirming the booking.
2848
2863
  */
2849
2864
  flowControlSettings?: ConfirmBookingFlowControlSettings;
2850
2865
  }
2851
2866
  interface ConfirmMultiServiceBookingResponse {
2852
- /** Confirmed multi service booking. */
2867
+ /** Confirmed multi-service booking. */
2853
2868
  multiServiceBooking?: MultiServiceBooking;
2854
2869
  }
2855
2870
  interface DeclineMultiServiceBookingRequest {
2856
2871
  /**
2857
- * ID of the multi service booking to decline.
2872
+ * ID of the multi-service booking to decline.
2858
2873
  * @format GUID
2859
2874
  */
2860
2875
  multiServiceBookingId: string | null;
2861
2876
  /** Information about the single-service bookings to decline. */
2862
2877
  declineBookingsInfo?: BookingInfo[];
2863
- /**
2864
- * Information about whether to notify the customer and
2865
- * the message to send.
2866
- */
2878
+ /** Information about whether to notify the customer and the message to send. */
2867
2879
  participantNotification?: ParticipantNotification;
2868
2880
  /** Whether this booking has a conflict with at least 1 other confirmed booking. */
2869
2881
  doubleBooked?: boolean | null;
2870
2882
  /** Whether to return the declined single-service bookings. */
2871
2883
  returnFullEntity?: boolean;
2872
2884
  /**
2873
- * Information about whether specific procedures of the standard Wix Bookings
2874
- * declining flow are changed. For example, whether to issue a refund.
2885
+ * Information about whether specific procedures of the standard Wix Bookings declining flow are changed.
2886
+ * For example, whether to issue a refund upon cancellation.
2875
2887
  */
2876
2888
  flowControlSettings?: DeclineBookingFlowControlSettings;
2877
2889
  }
@@ -2891,11 +2903,10 @@ interface BulkGetMultiServiceBookingAllowedActionsRequest {
2891
2903
  interface BulkGetMultiServiceBookingAllowedActionsResponse {
2892
2904
  /**
2893
2905
  * Information about the multi-service bookings that were retrieved.
2894
- * Including their ID, index in the bulk request and whether they were
2895
- * successfully updated.
2906
+ * Including their ID, index in the bulk request and whether they were successfully processed.
2896
2907
  */
2897
2908
  results?: BulkCalculateAllowedActionsResult[];
2898
- /** Total number of successes and failures for Bulk Update Bookings. */
2909
+ /** Total number of successes and failures for Bulk Get Multi Service Booking Allowed Actions. */
2899
2910
  bulkActionMetadata?: BulkActionMetadata;
2900
2911
  }
2901
2912
  interface GetMultiServiceBookingRequest {
@@ -2913,9 +2924,8 @@ interface GetMultiServiceBookingResponse {
2913
2924
  }
2914
2925
  interface MultiServiceBookingMetadata {
2915
2926
  /**
2916
- * Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
2917
- * to the multi-service booking. The total includes the number of single-service
2918
- * bookings which couldn't be retrieved due to lack of permissions.
2927
+ * Total number of `CONFIRMED` and `PENDING` single-service bookings belonging to the multi-service booking.
2928
+ * The total includes the number of single-service bookings which couldn't be retrieved due to lack of permissions.
2919
2929
  */
2920
2930
  totalNumberOfScheduledBookings?: number | null;
2921
2931
  }
@@ -2935,14 +2945,13 @@ interface AddBookingsToMultiServiceBookingRequest {
2935
2945
  }
2936
2946
  interface BookingIdAndRevision {
2937
2947
  /**
2938
- * ID of the booking.
2948
+ * ID of the single-service booking.
2939
2949
  * @format GUID
2940
2950
  */
2941
2951
  bookingId?: string | null;
2942
2952
  /**
2943
2953
  * Revision number, which increments by 1 each time the booking is updated.
2944
- * To prevent conflicting changes, the current revision must be specified when
2945
- * managing the booking.
2954
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
2946
2955
  */
2947
2956
  revision?: string | null;
2948
2957
  }
@@ -3828,16 +3837,16 @@ interface BulkConfirmOrDeclineBookingOptions {
3828
3837
  *
3829
3838
  * For appointment-based services, specify the relevant `slot` in
3830
3839
  * `bookedEntity.slot`. We recommend specifying the complete
3831
- * `availabilityEntries.slot` returned in *Query Availability*
3840
+ * `availabilityEntries.slot` returned in Query Availability
3832
3841
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
3833
3842
  * in your call's request to avoid failed calls due to unavailability.
3834
3843
  *
3835
3844
  * ## Class session booking
3836
3845
  *
3837
- * For class services, specify the relevant *event ID*
3846
+ * For class services, specify the relevant event ID
3838
3847
  * ([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))
3839
3848
  * as `bookedEntity.slot.eventId`.
3840
- * We recommend retrieving the event ID from *Query Availability's*
3849
+ * We recommend retrieving the event ID from Query Availability's
3841
3850
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
3842
3851
  * `availabilityEntries.slot.eventId` to avoid failed calls due to unavailability.
3843
3852
  * Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
@@ -3892,12 +3901,12 @@ interface BulkConfirmOrDeclineBookingOptions {
3892
3901
  * _eCommerce checkout_
3893
3902
  * ([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)),
3894
3903
  * Wix Bookings automatically syncs the booking's payment status from
3895
- * the corresponding *eCommerce order*
3904
+ * the corresponding eCommerce order
3896
3905
  * ([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)).
3897
3906
  *
3898
3907
  * If a booking doesn't have a corresponding eCommerce order, for example, since
3899
3908
  * the customer didn't use the eCommerce checkout, you can update the booking's
3900
- * payment status with *Confirm Or Decline Booking*
3909
+ * payment status with Confirm Or Decline Booking
3901
3910
  * ([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)).
3902
3911
  *
3903
3912
  * ## Booking form data
@@ -3972,7 +3981,7 @@ interface CreateBookingOptions {
3972
3981
  * Creates up to 8 bookings.
3973
3982
  *
3974
3983
  *
3975
- * See *Create Booking*
3984
+ * See Create Booking
3976
3985
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/create-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking))
3977
3986
  * for more information.
3978
3987
  *
@@ -4016,7 +4025,7 @@ interface BulkCreateBookingOptions {
4016
4025
  * ## Appointment sessions
4017
4026
  *
4018
4027
  * For appointments, the old session is removed from the business calendar
4019
- * while a new session is added. We recommend calling *Query Availability*
4028
+ * while a new session is added. We recommend calling Query Availability
4020
4029
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
4021
4030
  * first and specifying the entire retrieved `slot`.
4022
4031
  *
@@ -4024,7 +4033,7 @@ interface BulkCreateBookingOptions {
4024
4033
  *
4025
4034
  * For classes, the new session must be an existing session belonging to the
4026
4035
  * same class. We recommend retrieving `availabilityEntries.slot.eventId`
4027
- * from *Query Availability*
4036
+ * from Query Availability
4028
4037
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
4029
4038
  * to avoid failed Reschedule Booking calls due to unavailability. Specify
4030
4039
  * only `slot.eventId` instead of the entire `slot` object.
@@ -4122,24 +4131,22 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
4122
4131
  participantsChoices?: ParticipantChoices;
4123
4132
  }
4124
4133
  /**
4125
- * Updates the booking status to `CONFIRMED` and updates the relevant session's
4126
- * `participants.approvalStatus` to `APPROVED` without checking whether the relevant
4127
- * slot or schedule is still available.
4134
+ * Updates the booking status to `CONFIRMED` without checking whether the relevant slot or schedule is still available.
4135
+ *
4128
4136
  *
4129
4137
  * ## eCommerce checkout restriction
4130
4138
  *
4131
4139
  * Call this method only when using a custom checkout page. Don't
4132
- * call it when using a *Wix eCommerce checkout*
4140
+ * call it when using a Wix eCommerce checkout
4133
4141
  * ([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)).
4134
4142
  * In such cases, Wix automatically updates the booking status based on
4135
- * the `paymentStatus` of the corresponding *Wix eCommerce order*
4143
+ * the `paymentStatus` of the corresponding Wix eCommerce order
4136
4144
  * ([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)).
4137
4145
  *
4138
4146
  * ## When to call Confirm Or Decline Booking instead
4139
4147
  *
4140
- * Confirm Booking doesn't check whether a slot or schedule is still available. For
4141
- * these checks you can call *Confirm or Decline Booking*
4142
- * ([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)).
4148
+ * Confirm Booking doesn't check whether a slot or schedule is still available.
4149
+ * For these checks, 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)) instead.
4143
4150
  *
4144
4151
  * ## Original status validation
4145
4152
  *
@@ -4266,16 +4273,16 @@ interface UpdateExtendedFieldsOptions {
4266
4273
  * ## eCommerce checkout restriction
4267
4274
  *
4268
4275
  * Call this method only when using a custom checkout page. Don't
4269
- * call it when using a *Wix eCommerce checkout*
4276
+ * call it when using a Wix eCommerce checkout
4270
4277
  * ([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)).
4271
4278
  * In such cases, Wix automatically updates the booking status based on
4272
- * the `paymentStatus` of the corresponding *Wix eCommerce order*
4279
+ * the `paymentStatus` of the corresponding Wix eCommerce order
4273
4280
  * ([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)).
4274
4281
  *
4275
4282
  * ## When to call Confirm Or Decline Booking instead
4276
4283
  *
4277
4284
  * The method doesn't check whether a slot or schedule is still available. For
4278
- * these checks you can call *Confirm or Decline Booking*
4285
+ * these checks you can call Confirm or Decline Booking
4279
4286
  * ([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)).
4280
4287
  *
4281
4288
  * ## Original status validation
@@ -4421,7 +4428,7 @@ interface CancelBookingOptions {
4421
4428
  *
4422
4429
  * You must specify either `participantsChoices` or `totalParticipants`.
4423
4430
  * The call fails if the specified `participantsChoices` aren't among the
4424
- * supported *service options and variants*
4431
+ * supported service options and variants
4425
4432
  * ([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)).
4426
4433
  * @param bookingId - ID of the booking to update the number of participants for.
4427
4434
  * @public
@@ -4469,11 +4476,34 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
4469
4476
  participantsChoices?: ParticipantChoices;
4470
4477
  }
4471
4478
  /**
4472
- * Creates a multi-service booking.
4479
+ * Creates a multi-service booking and all included single-service bookings simultaneously.
4480
+ *
4481
+ *
4482
+ * ## When to call this method
4483
+ *
4484
+ * Create sequential appointments where customers book related services. For adding existing single-service bookings to an existing multi-service booking, call Add Bookings to Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking)) instead.
4485
+ *
4486
+ * ## Requirements and behavior
4487
+ *
4488
+ * *Package constraints**: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
4489
+ *
4490
+ * *Timing specification**: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
4491
+ *
4492
+ * *Package pricing**: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/orders/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)) if the customer paid via an eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
4473
4493
  *
4494
+ * *Package notifications**: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
4474
4495
  *
4475
- * See Create Booking for more information.
4476
- * @param bookings - Single-service bookings to combine in a multi-service booking.
4496
+ * ## Related methods
4497
+ *
4498
+ * Verify availability first with List Multi Service Availability Time Slots ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/list-multi-service-availability-time-slots)).
4499
+ *
4500
+ * See Create Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/create-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)) for more details about constraints and effects of creating single-service bookings.
4501
+ * @param bookings - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
4502
+ *
4503
+ * Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
4504
+ * Specify contact details, number of participants, and any additional fields as needed.
4505
+ *
4506
+ * For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
4477
4507
  * @public
4478
4508
  * @documentationMaturity preview
4479
4509
  * @requiredField bookings
@@ -4496,38 +4526,39 @@ declare function createMultiServiceBooking(bookings: NonNullablePaths<Booking, `
4496
4526
  __applicationErrorsType?: CreateMultiServiceBookingApplicationErrors;
4497
4527
  }>;
4498
4528
  interface CreateMultiServiceBookingOptions {
4499
- /**
4500
- * Information about whether to notify the customer and
4501
- * the message to send.
4502
- */
4529
+ /** Information about whether to notify the customer and the message to send. */
4503
4530
  participantNotification?: ParticipantNotification;
4504
4531
  /**
4505
- * Whether to send an SMS reminder to the customer 24 hours before the
4506
- * session starts. The phone number is taken from `contactDetails.phone`.
4532
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
4533
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
4507
4534
  *
4508
4535
  * Default: `true`
4509
4536
  */
4510
4537
  sendSmsReminder?: boolean | null;
4511
4538
  /**
4512
4539
  * Whether to ignore specific standard procedures of the Wix Bookings flow.
4513
- * For example, whether to check availability before updating the status.
4540
+ * For example, whether to skip checking availability before updating the status.
4514
4541
  */
4515
4542
  flowControlSettings?: CreateBookingFlowControlSettings;
4516
4543
  /** Whether to return the created single-service bookings. */
4517
4544
  returnFullEntity?: boolean;
4518
- /** Multi service booking type. */
4545
+ /**
4546
+ * Multi-service booking type.
4547
+ *
4548
+ * Currently only `SEQUENTIAL_BOOKINGS` is supported, where you must schedule single-service bookings back-to-back with each booking starting when the previous 1 ends.
4549
+ */
4519
4550
  multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
4520
4551
  }
4521
4552
  /**
4522
- * Reschedules a multi-service booking.
4553
+ * Reschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package.
4523
4554
  *
4524
4555
  *
4525
- * The call fails if at least 1 individual booking can't be rescheduled due
4526
- * the service being unavailable or a rescheduling policy violation.
4556
+ * This method reschedules single-service bookings within the multi-service booking while maintaining sequential order. You must specify exact new timing for each service to ensure they remain back-to-back with no gaps or overlaps.
4527
4557
  *
4558
+ * This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each booking you're rescheduling to prevent conflicting changes.
4528
4559
  *
4529
- * See Reschedule Booking for more information.
4530
- * @param multiServiceBookingId - ID of the multi service booking to reschedule.
4560
+ * See Reschedule Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking)) for single-service booking rescheduling details.
4561
+ * @param multiServiceBookingId - ID of the multi-service booking to reschedule.
4531
4562
  * @param rescheduleBookingsInfo - Information about the single-service bookings to reschedule.
4532
4563
  * @public
4533
4564
  * @documentationMaturity preview
@@ -4547,27 +4578,32 @@ declare function rescheduleMultiServiceBooking(multiServiceBookingId: string, re
4547
4578
  __applicationErrorsType?: RescheduleMultiServiceBookingApplicationErrors;
4548
4579
  }>;
4549
4580
  interface RescheduleMultiServiceBookingOptions {
4550
- /**
4551
- * Information about whether to notify the customer and
4552
- * the message to send.
4553
- */
4581
+ /** Information about whether to notify the customer and the message to send. */
4554
4582
  participantNotification?: ParticipantNotification;
4555
4583
  /**
4556
- * Information about whether specific procedures of the standard Wix Bookings
4557
- * rescheduling flow are changed. For example, whether the availability of
4558
- * the new slot is checked before rescheduling the booking or if you can
4559
- * reschedule the booking even though the rescheduling policy doesn't allow it.
4584
+ * Information about whether specific procedures of the standard Wix Bookings rescheduling flow are changed.
4585
+ * For example, whether the availability of the new slot is checked before rescheduling the booking or if the customer can reschedule the booking even though the service's rescheduling policy doesn't allow it.
4560
4586
  */
4561
4587
  flowControlSettings?: RescheduleBookingFlowControlSettings;
4562
4588
  /** Whether to return the rescheduled bookings entities. */
4563
4589
  returnFullEntity?: boolean;
4564
4590
  }
4565
4591
  /**
4566
- * Retrieves a multi-service booking's availability.
4592
+ * Checks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations.
4593
+ *
4594
+ *
4595
+ * Wix Bookings considers:
4596
+ * - The relevant services' booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)).
4597
+ * - The availability of all required resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/introduction)).
4598
+ *
4599
+ * ## When to call this method
4600
+ *
4601
+ * Check if an existing multi-service booking is still valid after business configuration changes. For example, staff changes, policy updates, or capacity modifications.
4567
4602
  *
4603
+ * ## When to call List Multi Service Availability Time Slots instead
4568
4604
  *
4569
- * Use List Multi Service Availability Time Slots to check availability for a
4570
- * `SEQUENTIAL_BOOKINGS` multi-service booking.
4605
+ * For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
4606
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/list-multi-service-availability-time-slots)) instead.
4571
4607
  * @param multiServiceBookingId - ID of the multi-service booking to retrieve.
4572
4608
  * @public
4573
4609
  * @documentationMaturity preview
@@ -4581,7 +4617,13 @@ declare function getMultiServiceBookingAvailability(multiServiceBookingId: strin
4581
4617
  __applicationErrorsType?: GetMultiServiceBookingAvailabilityApplicationErrors;
4582
4618
  }>;
4583
4619
  /**
4584
- * Cancels a multi-service booking and thus all its individual bookings.
4620
+ * Cancels a multi-service booking and all its single-service bookings.
4621
+ *
4622
+ *
4623
+ * Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
4624
+ * The call fails if all single-service bookings are already canceled or declined.
4625
+ *
4626
+ * See Cancel Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/cancel-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking)) for single-service booking cancellation details.
4585
4627
  * @param multiServiceBookingId - ID of the multi-service booking to cancel.
4586
4628
  * @public
4587
4629
  * @documentationMaturity preview
@@ -4597,30 +4639,39 @@ declare function cancelMultiServiceBooking(multiServiceBookingId: string, option
4597
4639
  __applicationErrorsType?: CancelMultiServiceBookingApplicationErrors;
4598
4640
  }>;
4599
4641
  interface CancelMultiServiceBookingOptions {
4600
- /**
4601
- * Information about whether to notify the customer and
4602
- * the message to send.
4603
- */
4642
+ /** Information about whether to notify the customer and the message to send. */
4604
4643
  participantNotification?: ParticipantNotification;
4605
4644
  /**
4606
- * Information about whether specific procedures of the standard Wix Bookings
4607
- * cancellation flow are changed. For example, whether you can cancel
4608
- * a booking even though the cancellation policy doesn't allow it or whether
4609
- * to issue a refund.
4645
+ * Information about whether specific procedures of the standard Wix Bookings cancellation flow are changed.
4646
+ * For example, whether the customer can cancel the booking even though the service's cancellation policy doesn't allow it or whether to issue a refund upon cancellation.
4610
4647
  */
4611
4648
  flowControlSettings?: CancelBookingFlowControlSettings;
4612
4649
  /** Whether to return the canceled single-service bookings. */
4613
4650
  returnFullEntity?: boolean;
4614
4651
  }
4615
4652
  /**
4616
- * Updates the status of a multi-service booking to `PENDING`.
4653
+ * Updates the status for all single-service bookings in a multi-service booking to `PENDING`.
4654
+ *
4655
+ *
4656
+ * Call this method for multi-service bookings requiring manual business approval before confirmation.
4617
4657
  *
4658
+ * ## Status requirements
4618
4659
  *
4619
- * Also updates the status of each of individual bookings within the multi-service booking to `PENDING`.
4660
+ * - **Original status**: All single-service bookings must have `CREATED` status.
4661
+ * - **Target status**: All bookings move to `PENDING` together (all-or-nothing operation).
4620
4662
  *
4621
- * The call fails if the status for at least a single individual booking can't be updated.
4663
+ * ## Checkout restrictions
4622
4664
  *
4623
- * See Mark Booking as Pending for more information.
4665
+ * Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
4666
+ * Wix Bookings automatically manages the bookings' statuses based on payment processing.
4667
+ *
4668
+ * ## Additional updates
4669
+ *
4670
+ * - **Payment status**: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
4671
+ * - **Customer notifications**: Send messages using `participantNotification`.
4672
+ * - **Revision control**: Requires current revision numbers for all single-service bookings.
4673
+ *
4674
+ * See Mark Booking as Pending ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/mark-booking-as-pending) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/mark-booking-as-pending)) for more details about marking single-service bookings as pending.
4624
4675
  * @param multiServiceBookingId - ID of the multi-service booking to mark as `PENDING`.
4625
4676
  * @public
4626
4677
  * @documentationMaturity preview
@@ -4637,14 +4688,11 @@ declare function markMultiServiceBookingAsPending(multiServiceBookingId: string,
4637
4688
  interface MarkMultiServiceBookingAsPendingOptions {
4638
4689
  /** Information about the single-service bookings to mark as `PENDING`. */
4639
4690
  markAsPendingBookingsInfo?: BookingInfo[];
4640
- /**
4641
- * Information about whether to notify the customer and
4642
- * the message to send.
4643
- */
4691
+ /** Information about whether to notify the customer and the message to send. */
4644
4692
  participantNotification?: ParticipantNotification;
4645
4693
  /**
4646
- * Whether to send an SMS reminder to the customer 24 hours before the
4647
- * session starts. The phone number is taken from `contactDetails.phone`.
4694
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
4695
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
4648
4696
  *
4649
4697
  * Default: `true`
4650
4698
  */
@@ -4654,21 +4702,34 @@ interface MarkMultiServiceBookingAsPendingOptions {
4654
4702
  /** Whether to return the single-service bookings that were marked as `PENDING`. */
4655
4703
  returnFullEntity?: boolean;
4656
4704
  /**
4657
- * Information about whether specific procedures of the standard Wix Bookings
4658
- * creation flow are changed. For example, whether the availability is checked
4659
- * before updating the booking.
4705
+ * Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
4706
+ * For example, whether Wix Bookings checks availability before updating the booking.
4660
4707
  */
4661
4708
  flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
4662
4709
  }
4663
4710
  /**
4664
- * Updates the status of a multi-service booking to `CONFIRMED`.
4711
+ * Updates the status for all single-service bookings in a multi-service booking to `CONFIRMED`.
4712
+ *
4713
+ *
4714
+ * Call this method for multi-service bookings requiring manual business approval.
4715
+ *
4716
+ * ## Status requirements
4665
4717
  *
4718
+ * - **Original status**: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
4719
+ * - **Target status**: All bookings move to `CONFIRMED` together (all-or-nothing operation).
4666
4720
  *
4667
- * Also updates the status of each of individual bookings within the multi-service booking to `CONFIRMED`.
4721
+ * ## Checkout restrictions
4668
4722
  *
4669
- * The call fails if the status for at least a single individual booking can't be updated.
4723
+ * Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
4724
+ * Wix Bookings automatically manages the bookings' statuses based on payment processing.
4670
4725
  *
4671
- * See Confirm Booking for more information.
4726
+ * ## Additional updates
4727
+ *
4728
+ * - **Payment status**: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
4729
+ * - **Customer notifications**: Send messages using `participantNotification`.
4730
+ * - **Revision control**: Requires current revision numbers for all single-service bookings.
4731
+ *
4732
+ * See Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)) for more details about confirming single-service bookings.
4672
4733
  * @param multiServiceBookingId - ID of the multi-service booking to confirm its related bookings.
4673
4734
  * @public
4674
4735
  * @documentationMaturity preview
@@ -4685,14 +4746,11 @@ declare function confirmMultiServiceBooking(multiServiceBookingId: string, optio
4685
4746
  interface ConfirmMultiServiceBookingOptions {
4686
4747
  /** Information about the single-service bookings to confirm. */
4687
4748
  confirmBookingsInfo?: BookingInfo[];
4688
- /**
4689
- * Information about whether to notify the customer and
4690
- * the message to send.
4691
- */
4749
+ /** Information about whether to notify the customer and the message to send. */
4692
4750
  participantNotification?: ParticipantNotification;
4693
4751
  /**
4694
- * Whether to send an SMS reminder to the customer 24 hours before the
4695
- * session starts. The phone number is taken from `contactDetails.phone`.
4752
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
4753
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
4696
4754
  *
4697
4755
  * Default: `true`
4698
4756
  */
@@ -4702,22 +4760,35 @@ interface ConfirmMultiServiceBookingOptions {
4702
4760
  /** Whether to return the confirmed single-service bookings. */
4703
4761
  returnFullEntity?: boolean;
4704
4762
  /**
4705
- * Information about whether specific procedures of the standard Wix Bookings
4706
- * confirmation flow are changed. For example, whether the availability is
4707
- * checked before confirming the booking.
4763
+ * Information about whether specific procedures of the standard Wix Bookings confirmation flow are changed.
4764
+ * For example, whether Wix Bookings checks availability before confirming the booking.
4708
4765
  */
4709
4766
  flowControlSettings?: ConfirmBookingFlowControlSettings;
4710
4767
  }
4711
4768
  /**
4712
- * Updates the status of a multi-service booking to `DECLINED`.
4769
+ * Updates the status for all single-service bookings in a multi-service booking to `DECLINED`.
4770
+ *
4771
+ *
4772
+ * Call this method to reject multi-service bookings that can't be accommodated or don't meet business requirements.
4773
+ *
4774
+ * ## Status requirements
4713
4775
  *
4776
+ * - **Original status**: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
4777
+ * - **Target status**: All bookings move to `DECLINED` together (all-or-nothing operation).
4714
4778
  *
4715
- * Also updates the status of each of individual bookings within the multi-service booking to `DECLINED`.
4779
+ * ## Checkout restrictions
4716
4780
  *
4717
- * The call fails if the status for at least a single individual booking can't be updated.
4781
+ * Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
4782
+ * Wix Bookings automatically manages the bookings' statuses based on payment processing.
4718
4783
  *
4719
- * See Decline Booking for more information.
4720
- * @param multiServiceBookingId - ID of the multi service booking to decline.
4784
+ * ## Additional updates
4785
+ *
4786
+ * - **Payment status**: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
4787
+ * - **Customer notifications**: Send messages using `participantNotification`.
4788
+ * - **Revision control**: Requires current revision numbers for all single-service bookings.
4789
+ *
4790
+ * Refer to Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)) for more details about declining single-service bookings.
4791
+ * @param multiServiceBookingId - ID of the multi-service booking to decline.
4721
4792
  * @public
4722
4793
  * @documentationMaturity preview
4723
4794
  * @requiredField multiServiceBookingId
@@ -4733,23 +4804,34 @@ declare function declineMultiServiceBooking(multiServiceBookingId: string, optio
4733
4804
  interface DeclineMultiServiceBookingOptions {
4734
4805
  /** Information about the single-service bookings to decline. */
4735
4806
  declineBookingsInfo?: BookingInfo[];
4736
- /**
4737
- * Information about whether to notify the customer and
4738
- * the message to send.
4739
- */
4807
+ /** Information about whether to notify the customer and the message to send. */
4740
4808
  participantNotification?: ParticipantNotification;
4741
4809
  /** Whether this booking has a conflict with at least 1 other confirmed booking. */
4742
4810
  doubleBooked?: boolean | null;
4743
4811
  /** Whether to return the declined single-service bookings. */
4744
4812
  returnFullEntity?: boolean;
4745
4813
  /**
4746
- * Information about whether specific procedures of the standard Wix Bookings
4747
- * declining flow are changed. For example, whether to issue a refund.
4814
+ * Information about whether specific procedures of the standard Wix Bookings declining flow are changed.
4815
+ * For example, whether to issue a refund upon cancellation.
4748
4816
  */
4749
4817
  flowControlSettings?: DeclineBookingFlowControlSettings;
4750
4818
  }
4751
4819
  /**
4752
- * Retrieves the allowed actions for a list of multi-service bookings.
4820
+ * Retrieves information about which actions the customer can perform for up to 50 multi-service bookings.
4821
+ *
4822
+ *
4823
+ * For each multi-service booking, the response indicates which actions are currently allowed:
4824
+ * - `cancel`: Whether the customer can cancel the multi-service booking.
4825
+ * - `reschedule`: Whether the customer can adjust the multi-service booking's timing.
4826
+ *
4827
+ * ## Important considerations
4828
+ *
4829
+ * *Real-time validation**: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)), and available resources ([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)) at the time of the call.
4830
+ *
4831
+ * *Permission context**: Depending on the permissions of the calling [identity](https://dev.wix.com/build-apps/develop-your-app/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
4832
+ *
4833
+ * *Status dependencies**: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
4834
+ * Bookings can skip `PENDING` and move directly from `CREATED` to `CONFIRMED`/`DECLINED` based on service configuration.
4753
4835
  * @param multiServiceBookingIds - IDs of the multi-service bookings to retrieve allowed actions for.
4754
4836
  * @public
4755
4837
  * @documentationMaturity preview
@@ -4761,13 +4843,15 @@ interface DeclineMultiServiceBookingOptions {
4761
4843
  */
4762
4844
  declare function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds: string[]): Promise<NonNullablePaths<BulkGetMultiServiceBookingAllowedActionsResponse, `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`>>;
4763
4845
  /**
4764
- * Retrieves all single-service bookings belonging to a multi-service booking.
4846
+ * Retrieves a multi-service booking and all its associated single-service bookings.
4765
4847
  *
4766
4848
  *
4767
- * If you call as an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)
4768
- * who has permissions to read only part of the bookings,
4769
- * only the permitted bookings are retrieved. The returned total number of
4770
- * bookings includes also the bookings for which you don't have permissions.
4849
+ * Returns the complete multi-service booking information including its ID, included single-service bookings, and the total number of scheduled single-service bookings.
4850
+ *
4851
+ * If you call as an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) who has permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
4852
+ * The returned total number includes single-service bookings for which you don't have permissions.
4853
+ *
4854
+ * See Query Extended Bookings ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/query-extended-bookings) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-booking)) for details about retrieving individual single-service bookings and additional metadata.
4771
4855
  * @param multiServiceBookingId - ID of the multi-service booking.
4772
4856
  * @public
4773
4857
  * @documentationMaturity preview
@@ -4781,11 +4865,24 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
4781
4865
  [P in BookingNonNullablePaths]: `bookings.${number}.booking.${P}`;
4782
4866
  }[BookingNonNullablePaths]>>;
4783
4867
  /**
4784
- * Adds a list of single-service bookings to a multi-service booking.
4868
+ * Expands an existing multi-service booking by adding existing single-service bookings to the package.
4869
+ *
4870
+ *
4871
+ * ## When to call this method
4872
+ *
4873
+ * Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
4874
+ * For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/create-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking)) instead.
4875
+ *
4876
+ * ## Package integration
4877
+ *
4878
+ * The timing of the single-service bookings to add must be compatible with the multi-service booking's sequential schedule to ensure no gaps or overlaps between services in the updated package.
4785
4879
  *
4880
+ * ## Requirements and limitations
4786
4881
  *
4787
- * The call fails, if at least 1 of the specified booking is already part of a
4788
- * multi-service booking.
4882
+ * - **Maximum capacity**: The total number of single-service bookings can't exceed 8.
4883
+ * - **Booking eligibility**: You can add only independent single-service bookings that aren't part of another multi-service booking.
4884
+ * - **Status compatibility**: Added bookings must have compatible status with the target multi-service booking.
4885
+ * - **Revision control**: You must provide current revision numbers for all single-service bookings to add.
4789
4886
  * @param multiServiceBookingId - ID of the multi-service booking.
4790
4887
  * @public
4791
4888
  * @documentationMaturity preview
@@ -4811,16 +4908,26 @@ interface AddBookingsToMultiServiceBookingOptions {
4811
4908
  returnFullEntity?: boolean;
4812
4909
  }
4813
4910
  /**
4814
- * Removes single-service bookings from a multi-service booking and returns the
4815
- * removed bookings.
4911
+ * Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings.
4912
+ *
4913
+ *
4914
+ * ## Removal options
4915
+ *
4916
+ * *Remove all permitted bookings**: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
4917
+ *
4918
+ * *Selective removal**: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
4919
+ *
4920
+ * *Sequential scheduling**: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call Reschedule Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/multi-service-bookings/reschedule-multi-service-booking)) before removing the unwanted bookings.
4921
+ *
4922
+ * ## Removal behavior
4816
4923
  *
4924
+ * *Independent bookings**: Removed single-service bookings become independent bookings.
4925
+ * You can manage them using single-service booking methods.
4817
4926
  *
4818
- * If you specify an empty `bookings` array, all single-service bookings for which
4819
- * the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)
4820
- * has read permissions are removed from the multi-service booking.
4927
+ * *Automatic cleanup**: Multi-service bookings must contain at least 2 services.
4928
+ * If removal results in only 1 remaining single-service booking for the multi-service booking, the entire multi-service booking is deleted and the remaining single-service booking becomes a standalone booking.
4821
4929
  *
4822
- * If the call would create a multi-service booking including only 1 single-service
4823
- * booking, the multi-service booking is also deleted.
4930
+ * *Revision control**: Specify current revision numbers to prevent conflicting modifications during the removal process.
4824
4931
  * @param multiServiceBookingId - ID of the multi-service booking.
4825
4932
  * @public
4826
4933
  * @documentationMaturity preview