@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.
@@ -4,16 +4,19 @@ import '@wix/sdk-types';
4
4
  /** An entity representing a scheduled appointment, class session, or course. */
5
5
  interface Booking extends BookingParticipantsInfoOneOf {
6
6
  /**
7
- * Total number of participants. Available only when the relevant service
8
- * doesn't have _variants and options_
9
- * ([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)).
7
+ * Total number of participants.
8
+ * 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)).
10
9
  * @min 1
11
10
  */
12
11
  totalParticipants?: number;
13
12
  /**
14
- * Information about the booked service choices and participants.
15
- * Available only when the booking includes multiple _service variants_
13
+ * Information about the booked service choices and participant count for each choice.
14
+ * When creating a booking, use this field only if the booking includes multiple service variants
16
15
  * ([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)).
16
+ *
17
+ * For example, use this for a spa package booking that includes different service levels:
18
+ * - 2 participants chose "Standard Package".
19
+ * - 1 participant chose "VIP Package".
17
20
  */
18
21
  participantsChoices?: ParticipantChoices;
19
22
  /**
@@ -23,15 +26,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
23
26
  */
24
27
  id?: string | null;
25
28
  /**
26
- * An object describing the *slot*
27
- * ([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))
28
- * or *schedule*
29
- * ([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))
30
- * that was booked.
29
+ * An object describing the bookable entity - either a specific time slot or a recurring schedule.
30
+ *
31
+ * The structure depends on the type of service being booked:
32
+ *
33
+ * *For appointment services:** Use `slot` to book a specific time slot with a
34
+ * service provider. Appointments are typically one-time sessions at a specific date and time.
35
+ *
36
+ * *For class services:** Use `slot` to book a specific class session. Classes
37
+ * are individual sessions that can have multiple participants.
38
+ *
39
+ * *For course services:** Use `schedule` to book an entire course consisting of
40
+ * multiple sessions over time. Courses are recurring, multi-session offerings.
41
+ *
42
+ * Choose the appropriate field based on your service type and booking requirements.
31
43
  */
32
44
  bookedEntity?: BookedEntity;
33
45
  /**
34
- * Contact details of the site visitor or *member*
46
+ * Contact details of the site visitor or member
35
47
  * ([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))
36
48
  * making the booking.
37
49
  */
@@ -46,20 +58,27 @@ interface Booking extends BookingParticipantsInfoOneOf {
46
58
  */
47
59
  status?: BookingStatusWithLiterals;
48
60
  /**
49
- * The payment status of the booking corresponds to the `paymentStatus` of the
50
- * related *eCommerce order*
51
- * ([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)),
52
- * if one exists. All payment statuses are supported for every booking `status`.
61
+ * The payment status of the booking. This field automatically syncs with the
62
+ * `paymentStatus` of the corresponding eCommerce order
63
+ * ([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))
64
+ * when customers use Wix eCommerce checkout.
65
+ *
66
+ * ## Integration patterns
67
+ *
68
+ * *When using Wix eCommerce checkout:** Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
69
+ * Do not manually update this field.
70
+ *
71
+ * *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.
72
+ *
73
+ * *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.
74
+ *
75
+ * All payment statuses are supported for every booking `status`.
53
76
  */
54
77
  paymentStatus?: PaymentStatusWithLiterals;
55
78
  /**
56
- * Payment option selected by the customer. If the customer hasn't completed their
57
- * checkout, they may still change the payment method. Must be one of the payment
58
- * 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)),
59
- * unless `skipSelectedPaymentOptionValidation` is `true`.
60
- * When undefined during an *eCommerce checkout*
61
- * ([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)),
62
- * Wix Bookings uses the service's default payment option
79
+ * 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`.
80
+ *
81
+ * 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
63
82
  */
64
83
  selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
65
84
  /**
@@ -70,10 +89,8 @@ interface Booking extends BookingParticipantsInfoOneOf {
70
89
  /** External user ID that you can provide. */
71
90
  externalUserId?: string | null;
72
91
  /**
73
- * Revision number to be used when updating, rescheduling, or cancelling the
74
- * booking. Increments by 1 each time the booking is updated, rescheduled, or
75
- * canceled. To prevent conflicting changes, the current revision must be
76
- * specified when updating the booking.
92
+ * Revision number to be used when updating, rescheduling, or cancelling the booking.
93
+ * 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.
77
94
  */
78
95
  revision?: string | null;
79
96
  /**
@@ -114,21 +131,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
114
131
  /** @oneof */
115
132
  interface BookingParticipantsInfoOneOf {
116
133
  /**
117
- * Total number of participants. Available only when the relevant service
118
- * doesn't have _variants and options_
119
- * ([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)).
134
+ * Total number of participants.
135
+ * 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)).
120
136
  * @min 1
121
137
  */
122
138
  totalParticipants?: number;
123
139
  /**
124
- * Information about the booked service choices and participants.
125
- * Available only when the booking includes multiple _service variants_
140
+ * Information about the booked service choices and participant count for each choice.
141
+ * When creating a booking, use this field only if the booking includes multiple service variants
126
142
  * ([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)).
143
+ *
144
+ * For example, use this for a spa package booking that includes different service levels:
145
+ * - 2 participants chose "Standard Package".
146
+ * - 1 participant chose "VIP Package".
127
147
  */
128
148
  participantsChoices?: ParticipantChoices;
129
149
  }
130
150
  /**
131
- * A multi-service booking is considered available if all individual bookings are available as returned from List Multi Service Availability Time Slots.
151
+ * A multi-service booking is considered available if all single-service bookings are available as returned from List Multi Service Availability Time Slots.
132
152
  * Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
133
153
  * Multi-service booking is available if each of its bookings is available separately.
134
154
  * For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
@@ -142,22 +162,30 @@ declare enum MultiServiceBookingType {
142
162
  type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
143
163
  interface BookedEntity extends BookedEntityItemOneOf {
144
164
  /**
145
- * Booked *slot*
165
+ * Booked slot
146
166
  * ([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)).
147
- * Available only for appointment-based services and classes.
148
- * For appointment-based services, a new session is created, while for classes,
149
- * the booking is automatically linked to the existing session.
167
+ *
168
+ * Specify `slot` when creating bookings for:
169
+ * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
170
+ * Wix Bookings creates a new session when the booking is confirmed.
171
+ * - **Class services:** Group sessions at specific times (fitness classes, workshops).
172
+ * Wix Bookings links the booking to an existing scheduled session.
173
+ *
174
+ * For course services, specify `schedule` instead of `slot`.
150
175
  */
151
176
  slot?: BookedSlot;
152
177
  /**
153
- * Booked *schedule*
178
+ * Booked schedule
154
179
  * ([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)).
155
- * Available only for course bookings.
180
+ *
181
+ * Specify `schedule` when creating bookings for:
182
+ * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
183
+ * Wix Bookings enrolls participants in all sessions defined by the course schedule.
156
184
  */
157
185
  schedule?: BookedSchedule;
158
186
  /**
159
187
  * Session title at the time of booking. If there is no pre-existing session,
160
- * for example for appointment-based services, `title` is set to the service name.
188
+ * for example for appointment-based services, Wix Bookings sets `title` to the service name.
161
189
  * @readonly
162
190
  * @maxLength 6000
163
191
  */
@@ -174,17 +202,25 @@ interface BookedEntity extends BookedEntityItemOneOf {
174
202
  /** @oneof */
175
203
  interface BookedEntityItemOneOf {
176
204
  /**
177
- * Booked *slot*
205
+ * Booked slot
178
206
  * ([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)).
179
- * Available only for appointment-based services and classes.
180
- * For appointment-based services, a new session is created, while for classes,
181
- * the booking is automatically linked to the existing session.
207
+ *
208
+ * Specify `slot` when creating bookings for:
209
+ * - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
210
+ * Wix Bookings creates a new session when the booking is confirmed.
211
+ * - **Class services:** Group sessions at specific times (fitness classes, workshops).
212
+ * Wix Bookings links the booking to an existing scheduled session.
213
+ *
214
+ * For course services, specify `schedule` instead of `slot`.
182
215
  */
183
216
  slot?: BookedSlot;
184
217
  /**
185
- * Booked *schedule*
218
+ * Booked schedule
186
219
  * ([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)).
187
- * Available only for course bookings.
220
+ *
221
+ * Specify `schedule` when creating bookings for:
222
+ * - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
223
+ * Wix Bookings enrolls participants in all sessions defined by the course schedule.
188
224
  */
189
225
  schedule?: BookedSchedule;
190
226
  }
@@ -196,35 +232,25 @@ interface BookedSlot {
196
232
  /** Schedule ID. */
197
233
  scheduleId?: string;
198
234
  /**
199
- * ID of the corresponding *event*
235
+ * ID of the corresponding event
200
236
  * ([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)).
201
237
  * Available for both appointment and class bookings, not available for course bookings.
202
- * For appointment-based services, Wix Bookings automatically populates `eventId`
203
- * when the booking `status` changes to `CONFIRMED`. For class bookings, it's
204
- * automatically populated upon booking creation.
238
+ * For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
239
+ * For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
205
240
  * @minLength 36
206
241
  * @maxLength 250
207
242
  */
208
243
  eventId?: string | null;
209
- /**
210
- * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
211
- * format.
212
- */
244
+ /** The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
213
245
  startDate?: string | null;
214
- /**
215
- * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
216
- * format.
217
- */
246
+ /** The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
218
247
  endDate?: string | null;
219
- /** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
248
+ /** The time zone according to which the slot was shown to the user when booking, and should be shown in the future. */
220
249
  timezone?: string | null;
221
250
  /**
222
- * Primary *resource*
223
- * ([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))
224
- * for the booking. For example, the *staff member*
225
- * ([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))
226
- * providing the
227
- * service.
251
+ * Primary resource
252
+ * ([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.
253
+ * 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.
228
254
  */
229
255
  resource?: BookedResource;
230
256
  /** Location where the session takes place. */
@@ -286,10 +312,7 @@ declare enum LocationType {
286
312
  /** @enumType */
287
313
  type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
288
314
  interface BookedSchedule {
289
- /**
290
- * _Schedule ID_
291
- * ([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
+ /** 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)). */
293
316
  scheduleId?: string;
294
317
  /**
295
318
  * Booked service ID.
@@ -297,26 +320,22 @@ interface BookedSchedule {
297
320
  */
298
321
  serviceId?: string | null;
299
322
  /**
300
- * _Location_
301
- * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
302
- * where the schedule's sessions take place.
323
+ * 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.
303
324
  * @readonly
304
325
  */
305
326
  location?: Location;
306
327
  /**
307
- * Timezone in which the slot or session was shown to the customer when they booked.
328
+ * Time zone in which the slot or session was shown to the customer when they booked.
308
329
  * Also used whenever the customer reviews the booking's timing in the future.
309
330
  */
310
331
  timezone?: string | null;
311
332
  /**
312
- * Start time of the first session related to the booking in
313
- * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
333
+ * Start time of the first session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
314
334
  * @readonly
315
335
  */
316
336
  firstSessionStart?: string | null;
317
337
  /**
318
- * End time of the last session related to the booking in
319
- * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
338
+ * End time of the last session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
320
339
  * @readonly
321
340
  */
322
341
  lastSessionEnd?: string | null;
@@ -443,38 +462,26 @@ declare enum ValueType {
443
462
  type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
444
463
  /** Booking status. */
445
464
  declare enum BookingStatus {
446
- /**
447
- * The booking was created, but the customer hasn't completed the related
448
- * eCommerce order yet.
449
- */
465
+ /** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
450
466
  CREATED = "CREATED",
451
467
  /**
452
- * The merchant has confirmed the booking and it appears in the
453
- * business calendar. Merchants can set up their *services*
454
- * ([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))
455
- * to automatically confirm all `PENDING` bookings.
468
+ * The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
469
+ * ([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.
456
470
  */
457
471
  CONFIRMED = "CONFIRMED",
458
472
  /**
459
- * The customer has canceled the booking. Depending on the relevant service's
460
- * _policy snapshot_
473
+ * The customer has canceled the booking. Depending on the relevant service's policy snapshot
461
474
  * ([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))
462
- * they may have to pay a _cancellation fee_
463
- * ([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)).
475
+ * 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)).
464
476
  */
465
477
  CANCELED = "CANCELED",
466
- /**
467
- * The merchant must manually confirm the booking before it appears
468
- * in the business calendar.
469
- */
478
+ /** The merchant must manually confirm the booking before it appears in the business calendar. */
470
479
  PENDING = "PENDING",
471
480
  /** The merchant has declined the booking before the customer was charged. */
472
481
  DECLINED = "DECLINED",
473
482
  /**
474
483
  * The booking is on a waitlist.
475
- * Currently, you can't call Register to Waitlist
476
- * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist))
477
- * for course or appointment bookings, even though this is supported in live sites.
484
+ * 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.
478
485
  * You can call Register to Waitlist only for class session bookings.
479
486
  */
480
487
  WAITING_LIST = "WAITING_LIST"
@@ -606,8 +613,7 @@ interface ParticipantChoices {
606
613
  }
607
614
  interface ServiceChoices {
608
615
  /**
609
- * Number of participants for this _variant_
610
- * ([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)).
616
+ * 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)).
611
617
  * @min 1
612
618
  */
613
619
  numberOfParticipants?: number | null;
@@ -775,7 +781,14 @@ interface CreateBookingFlowControlSettings {
775
781
  /**
776
782
  * Whether the availability is checked before creating the booking.
777
783
  *
778
- * When passing `false`, a booking is only created when the slot or schedule is available.
784
+ * - `false`: A booking is only created when the slot or schedule is available.
785
+ * - `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.
786
+ *
787
+ * *Use cases for `true`:**
788
+ * - Emergency or priority bookings that must be accommodated.
789
+ * - Administrative bookings that override normal availability rules.
790
+ * - Testing or demonstration purposes.
791
+ *
779
792
  * Default: `false`.
780
793
  */
781
794
  skipAvailabilityValidation?: boolean;
@@ -1246,47 +1259,58 @@ interface MarkBookingAsPendingFlowControlSettings {
1246
1259
  }
1247
1260
  interface CreateMultiServiceBookingRequest {
1248
1261
  /**
1249
- * Single-service bookings to combine in a multi-service booking.
1262
+ * Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
1263
+ *
1264
+ * Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
1265
+ * Specify contact details, number of participants, and any additional fields as needed.
1266
+ *
1267
+ * For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
1250
1268
  * @minSize 2
1251
1269
  * @maxSize 8
1252
1270
  */
1253
1271
  bookings: Booking[];
1254
- /**
1255
- * Information about whether to notify the customer and
1256
- * the message to send.
1257
- */
1272
+ /** Information about whether to notify the customer and the message to send. */
1258
1273
  participantNotification?: ParticipantNotification;
1259
1274
  /**
1260
- * Whether to send an SMS reminder to the customer 24 hours before the
1261
- * session starts. The phone number is taken from `contactDetails.phone`.
1275
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
1276
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
1262
1277
  *
1263
1278
  * Default: `true`
1264
1279
  */
1265
1280
  sendSmsReminder?: boolean | null;
1266
1281
  /**
1267
1282
  * Whether to ignore specific standard procedures of the Wix Bookings flow.
1268
- * For example, whether to check availability before updating the status.
1283
+ * For example, whether to skip checking availability before updating the status.
1269
1284
  */
1270
1285
  flowControlSettings?: CreateBookingFlowControlSettings;
1271
1286
  /** Whether to return the created single-service bookings. */
1272
1287
  returnFullEntity?: boolean;
1273
- /** Multi service booking type. */
1288
+ /**
1289
+ * Multi-service booking type.
1290
+ *
1291
+ * 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.
1292
+ */
1274
1293
  multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
1275
1294
  }
1276
1295
  interface CreateMultiServiceBookingResponse {
1277
1296
  /**
1278
- * Created multi service booking.
1279
- * Contains the booking results in the same order as specified in the request.
1297
+ * Created multi-service booking.
1298
+ * Contains the single-service bookings in the same order as specified in the request.
1280
1299
  */
1281
1300
  multiServiceBooking?: MultiServiceBooking;
1282
1301
  }
1302
+ /**
1303
+ * A multi-service booking combines multiple single-service bookings into a package.
1304
+ *
1305
+ * 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.
1306
+ */
1283
1307
  interface MultiServiceBooking {
1284
1308
  /**
1285
1309
  * Multi-service booking ID.
1286
1310
  * @format GUID
1287
1311
  */
1288
1312
  id?: string | null;
1289
- /** The created bookings that are part of the multi-service booking. */
1313
+ /** The single-service bookings that make up the multi-service booking package. */
1290
1314
  bookings?: BookingResult[];
1291
1315
  }
1292
1316
  interface BookingResult {
@@ -1300,22 +1324,17 @@ interface BookingResult {
1300
1324
  }
1301
1325
  interface RescheduleMultiServiceBookingRequest {
1302
1326
  /**
1303
- * ID of the multi service booking to reschedule.
1327
+ * ID of the multi-service booking to reschedule.
1304
1328
  * @format GUID
1305
1329
  */
1306
1330
  multiServiceBookingId: string | null;
1307
1331
  /** Information about the single-service bookings to reschedule. */
1308
1332
  rescheduleBookingsInfo: RescheduleBookingInfo[];
1309
- /**
1310
- * Information about whether to notify the customer and
1311
- * the message to send.
1312
- */
1333
+ /** Information about whether to notify the customer and the message to send. */
1313
1334
  participantNotification?: ParticipantNotification;
1314
1335
  /**
1315
- * Information about whether specific procedures of the standard Wix Bookings
1316
- * rescheduling flow are changed. For example, whether the availability of
1317
- * the new slot is checked before rescheduling the booking or if you can
1318
- * reschedule the booking even though the rescheduling policy doesn't allow it.
1336
+ * Information about whether specific procedures of the standard Wix Bookings rescheduling flow are changed.
1337
+ * 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.
1319
1338
  */
1320
1339
  flowControlSettings?: RescheduleBookingFlowControlSettings;
1321
1340
  /** Whether to return the rescheduled bookings entities. */
@@ -1323,13 +1342,12 @@ interface RescheduleMultiServiceBookingRequest {
1323
1342
  }
1324
1343
  interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
1325
1344
  /**
1326
- * Total number of participants. Available only for services with variants.
1345
+ * 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)).
1327
1346
  * Specify when all participants book the same variant.
1328
1347
  */
1329
1348
  totalParticipants?: number;
1330
1349
  /**
1331
- * Information about the service choices to book. Available only for services with
1332
- * variants.
1350
+ * 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)).
1333
1351
  * Specify when not all participants book the same variant.
1334
1352
  */
1335
1353
  participantsChoices?: ParticipantChoices;
@@ -1342,21 +1360,19 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
1342
1360
  slot?: V2Slot;
1343
1361
  /**
1344
1362
  * Revision number, which increments by 1 each time the booking is updated.
1345
- * To prevent conflicting changes, the current revision must be specified when
1346
- * managing the booking.
1363
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
1347
1364
  */
1348
1365
  revision?: string | null;
1349
1366
  }
1350
1367
  /** @oneof */
1351
1368
  interface RescheduleBookingInfoParticipantsInfoOneOf {
1352
1369
  /**
1353
- * Total number of participants. Available only for services with variants.
1370
+ * 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)).
1354
1371
  * Specify when all participants book the same variant.
1355
1372
  */
1356
1373
  totalParticipants?: number;
1357
1374
  /**
1358
- * Information about the service choices to book. Available only for services with
1359
- * variants.
1375
+ * 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)).
1360
1376
  * Specify when not all participants book the same variant.
1361
1377
  */
1362
1378
  participantsChoices?: ParticipantChoices;
@@ -1379,11 +1395,11 @@ interface GetMultiServiceBookingAvailabilityResponse {
1379
1395
  totalCapacity?: number | null;
1380
1396
  /** Number of open spots. */
1381
1397
  remainingCapacity?: number | null;
1382
- /** Indicators for policy violations of the multi service booking. */
1398
+ /** Indicators for policy violations of the multi-service booking. */
1383
1399
  policyViolations?: BookingPolicyViolations;
1384
1400
  /** Multi-service booking policy settings. */
1385
1401
  policySettings?: BookingPolicySettings;
1386
- /** Info of the bookings this availability was calculated for. */
1402
+ /** Details of the multi-service booking. */
1387
1403
  multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
1388
1404
  }
1389
1405
  interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
@@ -1399,16 +1415,11 @@ interface CancelMultiServiceBookingRequest {
1399
1415
  * @format GUID
1400
1416
  */
1401
1417
  multiServiceBookingId: string | null;
1402
- /**
1403
- * Information about whether to notify the customer and
1404
- * the message to send.
1405
- */
1418
+ /** Information about whether to notify the customer and the message to send. */
1406
1419
  participantNotification?: ParticipantNotification;
1407
1420
  /**
1408
- * Information about whether specific procedures of the standard Wix Bookings
1409
- * cancellation flow are changed. For example, whether you can cancel
1410
- * a booking even though the cancellation policy doesn't allow it or whether
1411
- * to issue a refund.
1421
+ * Information about whether specific procedures of the standard Wix Bookings cancellation flow are changed.
1422
+ * 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.
1412
1423
  */
1413
1424
  flowControlSettings?: CancelBookingFlowControlSettings;
1414
1425
  /** Whether to return the canceled single-service bookings. */
@@ -1426,14 +1437,11 @@ interface MarkMultiServiceBookingAsPendingRequest {
1426
1437
  multiServiceBookingId: string | null;
1427
1438
  /** Information about the single-service bookings to mark as `PENDING`. */
1428
1439
  markAsPendingBookingsInfo?: BookingInfo[];
1429
- /**
1430
- * Information about whether to notify the customer and
1431
- * the message to send.
1432
- */
1440
+ /** Information about whether to notify the customer and the message to send. */
1433
1441
  participantNotification?: ParticipantNotification;
1434
1442
  /**
1435
- * Whether to send an SMS reminder to the customer 24 hours before the
1436
- * session starts. The phone number is taken from `contactDetails.phone`.
1443
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
1444
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
1437
1445
  *
1438
1446
  * Default: `true`
1439
1447
  */
@@ -1443,9 +1451,8 @@ interface MarkMultiServiceBookingAsPendingRequest {
1443
1451
  /** Whether to return the single-service bookings that were marked as `PENDING`. */
1444
1452
  returnFullEntity?: boolean;
1445
1453
  /**
1446
- * Information about whether specific procedures of the standard Wix Bookings
1447
- * creation flow are changed. For example, whether the availability is checked
1448
- * before updating the booking.
1454
+ * Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
1455
+ * For example, whether Wix Bookings checks availability before updating the booking.
1449
1456
  */
1450
1457
  flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
1451
1458
  }
@@ -1457,8 +1464,7 @@ interface BookingInfo {
1457
1464
  bookingId?: string | null;
1458
1465
  /**
1459
1466
  * Revision number, which increments by 1 each time the booking is updated.
1460
- * To prevent conflicting changes, the current revision must be specified when
1461
- * managing the booking.
1467
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
1462
1468
  */
1463
1469
  revision?: string | null;
1464
1470
  /** Payment status to set for the single-service booking. */
@@ -1476,14 +1482,11 @@ interface ConfirmMultiServiceBookingRequest {
1476
1482
  multiServiceBookingId: string | null;
1477
1483
  /** Information about the single-service bookings to confirm. */
1478
1484
  confirmBookingsInfo?: BookingInfo[];
1479
- /**
1480
- * Information about whether to notify the customer and
1481
- * the message to send.
1482
- */
1485
+ /** Information about whether to notify the customer and the message to send. */
1483
1486
  participantNotification?: ParticipantNotification;
1484
1487
  /**
1485
- * Whether to send an SMS reminder to the customer 24 hours before the
1486
- * session starts. The phone number is taken from `contactDetails.phone`.
1488
+ * Whether to send an SMS reminder to the customer 24 hours before the session starts.
1489
+ * Wix Bookings takes the phone number from `contactDetails.phone`.
1487
1490
  *
1488
1491
  * Default: `true`
1489
1492
  */
@@ -1493,36 +1496,32 @@ interface ConfirmMultiServiceBookingRequest {
1493
1496
  /** Whether to return the confirmed single-service bookings. */
1494
1497
  returnFullEntity?: boolean;
1495
1498
  /**
1496
- * Information about whether specific procedures of the standard Wix Bookings
1497
- * confirmation flow are changed. For example, whether the availability is
1498
- * checked before confirming the booking.
1499
+ * Information about whether specific procedures of the standard Wix Bookings confirmation flow are changed.
1500
+ * For example, whether Wix Bookings checks availability before confirming the booking.
1499
1501
  */
1500
1502
  flowControlSettings?: ConfirmBookingFlowControlSettings;
1501
1503
  }
1502
1504
  interface ConfirmMultiServiceBookingResponse {
1503
- /** Confirmed multi service booking. */
1505
+ /** Confirmed multi-service booking. */
1504
1506
  multiServiceBooking?: MultiServiceBooking;
1505
1507
  }
1506
1508
  interface DeclineMultiServiceBookingRequest {
1507
1509
  /**
1508
- * ID of the multi service booking to decline.
1510
+ * ID of the multi-service booking to decline.
1509
1511
  * @format GUID
1510
1512
  */
1511
1513
  multiServiceBookingId: string | null;
1512
1514
  /** Information about the single-service bookings to decline. */
1513
1515
  declineBookingsInfo?: BookingInfo[];
1514
- /**
1515
- * Information about whether to notify the customer and
1516
- * the message to send.
1517
- */
1516
+ /** Information about whether to notify the customer and the message to send. */
1518
1517
  participantNotification?: ParticipantNotification;
1519
1518
  /** Whether this booking has a conflict with at least 1 other confirmed booking. */
1520
1519
  doubleBooked?: boolean | null;
1521
1520
  /** Whether to return the declined single-service bookings. */
1522
1521
  returnFullEntity?: boolean;
1523
1522
  /**
1524
- * Information about whether specific procedures of the standard Wix Bookings
1525
- * declining flow are changed. For example, whether to issue a refund.
1523
+ * Information about whether specific procedures of the standard Wix Bookings declining flow are changed.
1524
+ * For example, whether to issue a refund upon cancellation.
1526
1525
  */
1527
1526
  flowControlSettings?: DeclineBookingFlowControlSettings;
1528
1527
  }
@@ -1542,11 +1541,10 @@ interface BulkGetMultiServiceBookingAllowedActionsRequest {
1542
1541
  interface BulkGetMultiServiceBookingAllowedActionsResponse {
1543
1542
  /**
1544
1543
  * Information about the multi-service bookings that were retrieved.
1545
- * Including their ID, index in the bulk request and whether they were
1546
- * successfully updated.
1544
+ * Including their ID, index in the bulk request and whether they were successfully processed.
1547
1545
  */
1548
1546
  results?: BulkCalculateAllowedActionsResult[];
1549
- /** Total number of successes and failures for Bulk Update Bookings. */
1547
+ /** Total number of successes and failures for Bulk Get Multi Service Booking Allowed Actions. */
1550
1548
  bulkActionMetadata?: BulkActionMetadata;
1551
1549
  }
1552
1550
  interface GetMultiServiceBookingRequest {
@@ -1564,9 +1562,8 @@ interface GetMultiServiceBookingResponse {
1564
1562
  }
1565
1563
  interface MultiServiceBookingMetadata {
1566
1564
  /**
1567
- * Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
1568
- * to the multi-service booking. The total includes the number of single-service
1569
- * bookings which couldn't be retrieved due to lack of permissions.
1565
+ * Total number of `CONFIRMED` and `PENDING` single-service bookings belonging to the multi-service booking.
1566
+ * The total includes the number of single-service bookings which couldn't be retrieved due to lack of permissions.
1570
1567
  */
1571
1568
  totalNumberOfScheduledBookings?: number | null;
1572
1569
  }
@@ -1586,14 +1583,13 @@ interface AddBookingsToMultiServiceBookingRequest {
1586
1583
  }
1587
1584
  interface BookingIdAndRevision {
1588
1585
  /**
1589
- * ID of the booking.
1586
+ * ID of the single-service booking.
1590
1587
  * @format GUID
1591
1588
  */
1592
1589
  bookingId?: string | null;
1593
1590
  /**
1594
1591
  * Revision number, which increments by 1 each time the booking is updated.
1595
- * To prevent conflicting changes, the current revision must be specified when
1596
- * managing the booking.
1592
+ * To prevent conflicting changes, the current revision must be specified when managing the booking.
1597
1593
  */
1598
1594
  revision?: string | null;
1599
1595
  }