@wix/auto_sdk_bookings_bookings 1.0.82 → 1.0.83
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.
- package/build/cjs/index.d.ts +40 -57
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +74 -115
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +33 -56
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +40 -57
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +74 -115
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +33 -56
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +40 -57
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +74 -115
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +33 -56
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +40 -57
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +74 -115
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +33 -56
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -4,14 +4,13 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
4
4
|
interface Booking extends BookingParticipantsInfoOneOf {
|
|
5
5
|
/**
|
|
6
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
|
|
7
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
8
8
|
* @min 1
|
|
9
9
|
*/
|
|
10
10
|
totalParticipants?: number;
|
|
11
11
|
/**
|
|
12
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
|
|
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)).
|
|
13
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
15
14
|
*
|
|
16
15
|
* For example, use this for a spa package booking that includes different service levels:
|
|
17
16
|
* - 2 participants chose "Standard Package".
|
|
@@ -42,8 +41,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
42
41
|
*/
|
|
43
42
|
bookedEntity?: BookedEntity;
|
|
44
43
|
/**
|
|
45
|
-
* Contact details of the site visitor or member
|
|
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))
|
|
44
|
+
* Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction))
|
|
47
45
|
* making the booking.
|
|
48
46
|
*/
|
|
49
47
|
contactDetails?: ContactDetails;
|
|
@@ -69,8 +67,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
69
67
|
status?: BookingStatusWithLiterals;
|
|
70
68
|
/**
|
|
71
69
|
* The payment status of the booking. This field automatically syncs with the
|
|
72
|
-
* `paymentStatus` of the corresponding eCommerce order
|
|
73
|
-
* ([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))
|
|
70
|
+
* `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction)
|
|
74
71
|
* when customers use Wix eCommerce checkout.
|
|
75
72
|
*
|
|
76
73
|
* ### Integration patterns
|
|
@@ -78,17 +75,17 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
78
75
|
* __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
|
|
79
76
|
* Do not manually update this field.
|
|
80
77
|
*
|
|
81
|
-
* __When using custom payment flows__: You can manually update the payment status with Confirm Booking or Decline Booking
|
|
78
|
+
* __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.
|
|
82
79
|
*
|
|
83
|
-
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active pricing plan
|
|
80
|
+
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.
|
|
84
81
|
*
|
|
85
82
|
* All payment statuses are supported for every booking `status`.
|
|
86
83
|
*/
|
|
87
84
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
88
85
|
/**
|
|
89
|
-
* 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
|
|
86
|
+
* Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
90
87
|
*
|
|
91
|
-
* When undefined during an eCommerce checkout
|
|
88
|
+
* When undefined during an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), Wix Bookings uses the service's default payment option
|
|
92
89
|
*/
|
|
93
90
|
selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
|
|
94
91
|
/**
|
|
@@ -138,15 +135,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
138
135
|
*/
|
|
139
136
|
doubleBooked?: boolean | null;
|
|
140
137
|
/**
|
|
141
|
-
* ID of the form submission
|
|
142
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction))
|
|
138
|
+
* ID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction)
|
|
143
139
|
* associated with this booking.
|
|
144
140
|
* @format GUID
|
|
145
141
|
*/
|
|
146
142
|
formSubmissionId?: string | null;
|
|
147
143
|
/**
|
|
148
|
-
* ID of the form
|
|
149
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object))
|
|
144
|
+
* ID of the [form](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)
|
|
150
145
|
* associated with this booking. The value depends on how the
|
|
151
146
|
* booking was created:
|
|
152
147
|
* - For bookings created with Create Booking or Bulk Create Booking, `formId`
|
|
@@ -163,14 +158,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
163
158
|
interface BookingParticipantsInfoOneOf {
|
|
164
159
|
/**
|
|
165
160
|
* Total number of participants.
|
|
166
|
-
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options
|
|
161
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
167
162
|
* @min 1
|
|
168
163
|
*/
|
|
169
164
|
totalParticipants?: number;
|
|
170
165
|
/**
|
|
171
166
|
* Information about the booked service choices and participant count for each choice.
|
|
172
|
-
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
173
|
-
* ([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)).
|
|
167
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
174
168
|
*
|
|
175
169
|
* For example, use this for a spa package booking that includes different service levels:
|
|
176
170
|
* - 2 participants chose "Standard Package".
|
|
@@ -196,8 +190,7 @@ declare enum MultiServiceBookingType {
|
|
|
196
190
|
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
197
191
|
interface BookedEntity extends BookedEntityItemOneOf {
|
|
198
192
|
/**
|
|
199
|
-
* Booked slot
|
|
200
|
-
* ([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)).
|
|
193
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
201
194
|
*
|
|
202
195
|
* Specify `slot` when creating bookings for:
|
|
203
196
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -209,8 +202,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
209
202
|
*/
|
|
210
203
|
slot?: BookedSlot;
|
|
211
204
|
/**
|
|
212
|
-
* Booked schedule
|
|
213
|
-
* ([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)).
|
|
205
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
214
206
|
*
|
|
215
207
|
* Specify `schedule` when creating bookings for:
|
|
216
208
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -236,8 +228,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
236
228
|
/** @oneof */
|
|
237
229
|
interface BookedEntityItemOneOf {
|
|
238
230
|
/**
|
|
239
|
-
* Booked slot
|
|
240
|
-
* ([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)).
|
|
231
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
241
232
|
*
|
|
242
233
|
* Specify `slot` when creating bookings for:
|
|
243
234
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -249,8 +240,7 @@ interface BookedEntityItemOneOf {
|
|
|
249
240
|
*/
|
|
250
241
|
slot?: BookedSlot;
|
|
251
242
|
/**
|
|
252
|
-
* Booked schedule
|
|
253
|
-
* ([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)).
|
|
243
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
254
244
|
*
|
|
255
245
|
* Specify `schedule` when creating bookings for:
|
|
256
246
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -266,8 +256,7 @@ interface BookedSlot {
|
|
|
266
256
|
/** Schedule ID. */
|
|
267
257
|
scheduleId?: string;
|
|
268
258
|
/**
|
|
269
|
-
* ID of the corresponding event
|
|
270
|
-
* ([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)).
|
|
259
|
+
* ID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
271
260
|
* Available for both appointment and class bookings, not available for course bookings.
|
|
272
261
|
* For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
|
|
273
262
|
* For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
|
|
@@ -285,9 +274,8 @@ interface BookedSlot {
|
|
|
285
274
|
*/
|
|
286
275
|
timezone?: string | null;
|
|
287
276
|
/**
|
|
288
|
-
* Primary resource
|
|
289
|
-
*
|
|
290
|
-
* 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.
|
|
277
|
+
* [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking.
|
|
278
|
+
* For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service.
|
|
291
279
|
*/
|
|
292
280
|
resource?: BookedResource;
|
|
293
281
|
/** Location where the session takes place. */
|
|
@@ -369,7 +357,7 @@ declare enum SelectionMethod {
|
|
|
369
357
|
/** @enumType */
|
|
370
358
|
type SelectionMethodWithLiterals = SelectionMethod | 'UNKNOWN_SELECTION_METHOD' | 'SPECIFIC_RESOURCE' | 'ANY_RESOURCE' | 'NO_SELECTION';
|
|
371
359
|
interface BookedSchedule {
|
|
372
|
-
/** Schedule ID
|
|
360
|
+
/** [Schedule ID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). */
|
|
373
361
|
scheduleId?: string;
|
|
374
362
|
/**
|
|
375
363
|
* Booked service ID.
|
|
@@ -377,7 +365,7 @@ interface BookedSchedule {
|
|
|
377
365
|
*/
|
|
378
366
|
serviceId?: string | null;
|
|
379
367
|
/**
|
|
380
|
-
* Location
|
|
368
|
+
* [Location](https://dev.wix.com/docs/rest/business-management/locations/introduction) where the schedule's sessions take place.
|
|
381
369
|
* @readonly
|
|
382
370
|
*/
|
|
383
371
|
location?: Location;
|
|
@@ -521,26 +509,18 @@ type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX
|
|
|
521
509
|
declare enum BookingStatus {
|
|
522
510
|
/** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
|
|
523
511
|
CREATED = "CREATED",
|
|
524
|
-
/**
|
|
525
|
-
* The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
|
|
526
|
-
* ([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.
|
|
527
|
-
*/
|
|
512
|
+
/** The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings. */
|
|
528
513
|
CONFIRMED = "CONFIRMED",
|
|
529
514
|
/**
|
|
530
|
-
* The customer has canceled the booking. Depending on the relevant service's policy snapshot
|
|
531
|
-
*
|
|
532
|
-
* 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)).
|
|
515
|
+
* The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction)
|
|
516
|
+
* they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
|
|
533
517
|
*/
|
|
534
518
|
CANCELED = "CANCELED",
|
|
535
519
|
/** The merchant must manually confirm the booking before it appears in the business calendar. */
|
|
536
520
|
PENDING = "PENDING",
|
|
537
521
|
/** The merchant has declined the booking before the customer was charged. */
|
|
538
522
|
DECLINED = "DECLINED",
|
|
539
|
-
/**
|
|
540
|
-
* The booking is on a waitlist.
|
|
541
|
-
* 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.
|
|
542
|
-
* You can call Register to Waitlist only for class session bookings.
|
|
543
|
-
*/
|
|
523
|
+
/** Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites. */
|
|
544
524
|
WAITING_LIST = "WAITING_LIST"
|
|
545
525
|
}
|
|
546
526
|
/** @enumType */
|
|
@@ -707,8 +687,7 @@ interface FlowControlSettings {
|
|
|
707
687
|
skipAvailabilityValidation?: boolean;
|
|
708
688
|
/**
|
|
709
689
|
* Whether the booking's `status` is automatically updated to `CONFIRMED` when
|
|
710
|
-
* the customer completes the eCommerce checkout
|
|
711
|
-
* ([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)),
|
|
690
|
+
* the customer completes the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),
|
|
712
691
|
* regardless of whether the relevant service requires manual business confirmation.
|
|
713
692
|
*/
|
|
714
693
|
skipBusinessConfirmation?: boolean;
|
|
@@ -745,7 +724,7 @@ interface ParticipantChoices {
|
|
|
745
724
|
}
|
|
746
725
|
interface ServiceChoices {
|
|
747
726
|
/**
|
|
748
|
-
* Number of participants for this variant
|
|
727
|
+
* Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
749
728
|
* @min 1
|
|
750
729
|
*/
|
|
751
730
|
numberOfParticipants?: number | null;
|
|
@@ -1613,8 +1592,7 @@ interface ConfirmOrDeclineBookingRequest {
|
|
|
1613
1592
|
bookingId: string;
|
|
1614
1593
|
/**
|
|
1615
1594
|
* Current payment status of the booking when using a custom checkout page and
|
|
1616
|
-
* not the
|
|
1617
|
-
* ([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)).
|
|
1595
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
1618
1596
|
*
|
|
1619
1597
|
* The booking is declined if there is a double booking conflict and you provide
|
|
1620
1598
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -1643,8 +1621,7 @@ interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
|
1643
1621
|
bookingId?: string;
|
|
1644
1622
|
/**
|
|
1645
1623
|
* Current payment status of the booking when using a custom checkout page and
|
|
1646
|
-
* not the
|
|
1647
|
-
* ([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)).
|
|
1624
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
1648
1625
|
*
|
|
1649
1626
|
* The booking is declined if there is a double booking conflict and you provide
|
|
1650
1627
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -2865,12 +2842,12 @@ interface RescheduleMultiServiceBookingRequest {
|
|
|
2865
2842
|
}
|
|
2866
2843
|
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2867
2844
|
/**
|
|
2868
|
-
* Total number of participants. Available only for services with
|
|
2845
|
+
* Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2869
2846
|
* Specify when all participants book the same variant.
|
|
2870
2847
|
*/
|
|
2871
2848
|
totalParticipants?: number;
|
|
2872
2849
|
/**
|
|
2873
|
-
* Information about the service choices to book. Available only for services with
|
|
2850
|
+
* Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2874
2851
|
* Specify when not all participants book the same variant.
|
|
2875
2852
|
*/
|
|
2876
2853
|
participantsChoices?: ParticipantChoices;
|
|
@@ -2890,12 +2867,12 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
|
|
|
2890
2867
|
/** @oneof */
|
|
2891
2868
|
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2892
2869
|
/**
|
|
2893
|
-
* Total number of participants. Available only for services with
|
|
2870
|
+
* Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2894
2871
|
* Specify when all participants book the same variant.
|
|
2895
2872
|
*/
|
|
2896
2873
|
totalParticipants?: number;
|
|
2897
2874
|
/**
|
|
2898
|
-
* Information about the service choices to book. Available only for services with
|
|
2875
|
+
* Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2899
2876
|
* Specify when not all participants book the same variant.
|
|
2900
2877
|
*/
|
|
2901
2878
|
participantsChoices?: ParticipantChoices;
|
|
@@ -3979,11 +3956,9 @@ interface RescheduleBookingAnonymouslyOptions {
|
|
|
3979
3956
|
* ### eCommerce checkout restriction
|
|
3980
3957
|
*
|
|
3981
3958
|
* Call this method only when using a custom checkout page. Don't
|
|
3982
|
-
* call it when using a
|
|
3983
|
-
* ([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)).
|
|
3959
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
3984
3960
|
* In such cases, Wix automatically updates the booking status based on
|
|
3985
|
-
* the `paymentStatus` of the corresponding
|
|
3986
|
-
* ([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)).
|
|
3961
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
3987
3962
|
*
|
|
3988
3963
|
* ### New booking status
|
|
3989
3964
|
*
|
|
@@ -4025,8 +4000,7 @@ declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrD
|
|
|
4025
4000
|
interface ConfirmOrDeclineBookingOptions {
|
|
4026
4001
|
/**
|
|
4027
4002
|
* Current payment status of the booking when using a custom checkout page and
|
|
4028
|
-
* not the
|
|
4029
|
-
* ([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)).
|
|
4003
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4030
4004
|
*
|
|
4031
4005
|
* The booking is declined if there is a double booking conflict and you provide
|
|
4032
4006
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -4037,8 +4011,7 @@ interface ConfirmOrDeclineBookingOptions {
|
|
|
4037
4011
|
* Confirms or declines up to 300 bookings.
|
|
4038
4012
|
*
|
|
4039
4013
|
*
|
|
4040
|
-
* See
|
|
4041
|
-
* ([SDK](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking))
|
|
4014
|
+
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
4042
4015
|
* for details about when a booking is confirmed or declined.
|
|
4043
4016
|
* @param details - Bookings to confirm or decline.
|
|
4044
4017
|
* @public
|
|
@@ -4063,17 +4036,14 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4063
4036
|
*
|
|
4064
4037
|
* For appointment-based services, specify the relevant `slot` in
|
|
4065
4038
|
* `bookedEntity.slot`. We recommend specifying the complete
|
|
4066
|
-
* `availabilityEntries.slot` returned in Query Availability
|
|
4067
|
-
* ([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))
|
|
4039
|
+
* `availabilityEntries.slot` returned in [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4068
4040
|
* in your call's request to avoid failed calls due to unavailability.
|
|
4069
4041
|
*
|
|
4070
4042
|
* ### Class session booking
|
|
4071
4043
|
*
|
|
4072
|
-
* For class services, specify the relevant event ID
|
|
4073
|
-
* ([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))
|
|
4044
|
+
* For class services, specify the relevant [event ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
|
|
4074
4045
|
* as `bookedEntity.slot.eventId`.
|
|
4075
|
-
* We recommend retrieving the event ID from Query Availability's
|
|
4076
|
-
* ([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))
|
|
4046
|
+
* We recommend retrieving the event ID from [Query Availability's](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4077
4047
|
* `availabilityEntries.slot.eventId` to avoid failed calls due to unavailability.
|
|
4078
4048
|
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
4079
4049
|
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
@@ -4102,8 +4072,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4102
4072
|
*
|
|
4103
4073
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
4104
4074
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
4105
|
-
*
|
|
4106
|
-
* ([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)).
|
|
4075
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
4107
4076
|
*
|
|
4108
4077
|
* ### Notify customers
|
|
4109
4078
|
*
|
|
@@ -4122,9 +4091,9 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4122
4091
|
*
|
|
4123
4092
|
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
4124
4093
|
*
|
|
4125
|
-
* For customers paying with a Wix eCommerce checkout
|
|
4094
|
+
* For customers paying with a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/checkout/introduction), Wix Bookings automatically syncs the booking's payment status from the corresponding [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4126
4095
|
*
|
|
4127
|
-
* For customers using a custom checkout, call Confirm or Decline Booking
|
|
4096
|
+
* For customers using a custom checkout, call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to update booking's payment status manually.
|
|
4128
4097
|
*
|
|
4129
4098
|
* ### Booking form data
|
|
4130
4099
|
*
|
|
@@ -4195,8 +4164,7 @@ interface CreateBookingOptions {
|
|
|
4195
4164
|
* Creates up to 8 bookings.
|
|
4196
4165
|
*
|
|
4197
4166
|
*
|
|
4198
|
-
* See Create Booking
|
|
4199
|
-
* ([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))
|
|
4167
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
4200
4168
|
* for more information.
|
|
4201
4169
|
*
|
|
4202
4170
|
* If any of the specified bookings is missing a required field the entire call
|
|
@@ -4236,16 +4204,14 @@ interface BulkCreateBookingOptions {
|
|
|
4236
4204
|
* ### Appointment sessions
|
|
4237
4205
|
*
|
|
4238
4206
|
* For appointments, the old session is removed from the business calendar
|
|
4239
|
-
* while a new session is added. We recommend calling Query Availability
|
|
4240
|
-
* ([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))
|
|
4207
|
+
* while a new session is added. We recommend calling [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4241
4208
|
* first and specifying the entire retrieved `slot`.
|
|
4242
4209
|
*
|
|
4243
4210
|
* ### Class sessions
|
|
4244
4211
|
*
|
|
4245
4212
|
* For classes, the new session must be an existing session belonging to the
|
|
4246
4213
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
4247
|
-
* from Query Availability
|
|
4248
|
-
* ([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))
|
|
4214
|
+
* from [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4249
4215
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
4250
4216
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
4251
4217
|
*
|
|
@@ -4346,16 +4312,14 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
|
4346
4312
|
* ### eCommerce checkout restriction
|
|
4347
4313
|
*
|
|
4348
4314
|
* Call this method only when using a custom checkout page. Don't
|
|
4349
|
-
* call it when using a Wix eCommerce checkout
|
|
4350
|
-
* ([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)).
|
|
4315
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4351
4316
|
* In such cases, Wix automatically updates the booking status based on
|
|
4352
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4353
|
-
* ([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)).
|
|
4317
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4354
4318
|
*
|
|
4355
4319
|
* ### When to call Confirm Or Decline Booking instead
|
|
4356
4320
|
*
|
|
4357
4321
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
4358
|
-
* For these checks, call Confirm or Decline Booking
|
|
4322
|
+
* For these checks, call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) instead.
|
|
4359
4323
|
*
|
|
4360
4324
|
* ### Original status validation
|
|
4361
4325
|
*
|
|
@@ -4478,17 +4442,14 @@ interface UpdateExtendedFieldsOptions {
|
|
|
4478
4442
|
* ### eCommerce checkout restriction
|
|
4479
4443
|
*
|
|
4480
4444
|
* Call this method only when using a custom checkout page. Don't
|
|
4481
|
-
* call it when using a Wix eCommerce checkout
|
|
4482
|
-
* ([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)).
|
|
4445
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4483
4446
|
* In such cases, Wix automatically updates the booking status based on
|
|
4484
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4485
|
-
* ([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)).
|
|
4447
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4486
4448
|
*
|
|
4487
4449
|
* ### When to call Confirm Or Decline Booking instead
|
|
4488
4450
|
*
|
|
4489
4451
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
4490
|
-
* these checks you can call Confirm or Decline Booking
|
|
4491
|
-
* ([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)).
|
|
4452
|
+
* these checks you can call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking).
|
|
4492
4453
|
*
|
|
4493
4454
|
* ### Original status validation
|
|
4494
4455
|
*
|
|
@@ -4629,8 +4590,7 @@ interface CancelBookingOptions {
|
|
|
4629
4590
|
*
|
|
4630
4591
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
4631
4592
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
4632
|
-
* supported service options and variants
|
|
4633
|
-
* ([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)).
|
|
4593
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
4634
4594
|
* @param bookingId - ID of the booking to update the number of participants for.
|
|
4635
4595
|
* @public
|
|
4636
4596
|
* @requiredField bookingId
|
|
@@ -4680,7 +4640,7 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4680
4640
|
*
|
|
4681
4641
|
* ### Service requirement
|
|
4682
4642
|
*
|
|
4683
|
-
* By default, this method only works for
|
|
4643
|
+
* By default, this method only works for [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
4684
4644
|
* If you attempt to mark a booking as pending for a service that doesn't require approval, the call fails unless you use the `skipPendingApprovalServiceValidation` admin overwrite.
|
|
4685
4645
|
*
|
|
4686
4646
|
* ### Status requirements
|
|
@@ -4690,15 +4650,15 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4690
4650
|
*
|
|
4691
4651
|
* ### Checkout restrictions
|
|
4692
4652
|
*
|
|
4693
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts
|
|
4653
|
+
* Only call this method if the customer paid via a custom checkout. For [Wix eCommerce checkouts](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/introduction), Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
4694
4654
|
*
|
|
4695
4655
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
4696
4656
|
*
|
|
4697
4657
|
* ### Business workflow
|
|
4698
4658
|
*
|
|
4699
4659
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
4700
|
-
* - Confirm Booking
|
|
4701
|
-
* - Decline Booking
|
|
4660
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
4661
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
4702
4662
|
*
|
|
4703
4663
|
* ### Resource availability and scheduling
|
|
4704
4664
|
*
|
|
@@ -4706,7 +4666,7 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4706
4666
|
*
|
|
4707
4667
|
* - **Calendar impact**: The booking appears on the business calendar.
|
|
4708
4668
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
4709
|
-
* - **Resource assignment**: Available
|
|
4669
|
+
* - **Resource assignment**: Available [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) are automatically assigned if none were explicitly selected during booking creation.
|
|
4710
4670
|
*
|
|
4711
4671
|
* ### Double bookings
|
|
4712
4672
|
*
|
|
@@ -4779,7 +4739,7 @@ interface MarkBookingAsPendingOptions {
|
|
|
4779
4739
|
*
|
|
4780
4740
|
* ### When to call this method
|
|
4781
4741
|
*
|
|
4782
|
-
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call Add Bookings to Multi Service Booking
|
|
4742
|
+
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call [Add Bookings to Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) instead.
|
|
4783
4743
|
*
|
|
4784
4744
|
* ### Requirements and behavior
|
|
4785
4745
|
*
|
|
@@ -4787,15 +4747,15 @@ interface MarkBookingAsPendingOptions {
|
|
|
4787
4747
|
*
|
|
4788
4748
|
* __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.
|
|
4789
4749
|
*
|
|
4790
|
-
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order
|
|
4750
|
+
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) if the customer paid via an [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4791
4751
|
*
|
|
4792
4752
|
* __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.
|
|
4793
4753
|
*
|
|
4794
4754
|
* ### Related methods
|
|
4795
4755
|
*
|
|
4796
|
-
* Verify availability first with List Multi Service Availability Time Slots
|
|
4756
|
+
* Verify availability first with [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots).
|
|
4797
4757
|
*
|
|
4798
|
-
* See Create Booking
|
|
4758
|
+
* See [Create Booking](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.
|
|
4799
4759
|
* @param bookings - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
4800
4760
|
*
|
|
4801
4761
|
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
@@ -4852,7 +4812,7 @@ interface CreateMultiServiceBookingOptions {
|
|
|
4852
4812
|
*
|
|
4853
4813
|
* This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each single-service booking you're rescheduling to prevent conflicting changes.
|
|
4854
4814
|
*
|
|
4855
|
-
* See Reschedule Booking
|
|
4815
|
+
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
4856
4816
|
* @param multiServiceBookingId - ID of the multi-service booking to reschedule.
|
|
4857
4817
|
* @param rescheduleBookingsInfo - Information about the single-service bookings to reschedule.
|
|
4858
4818
|
* @public
|
|
@@ -4886,14 +4846,13 @@ interface RescheduleMultiServiceBookingOptions {
|
|
|
4886
4846
|
*
|
|
4887
4847
|
*
|
|
4888
4848
|
* Wix Bookings considers:
|
|
4889
|
-
* - The relevant services' booking policies
|
|
4890
|
-
* - The availability of all required
|
|
4849
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
4850
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
4891
4851
|
*
|
|
4892
4852
|
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
4893
4853
|
* For example, staff changes, policy updates, or capacity modifications.
|
|
4894
4854
|
*
|
|
4895
|
-
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
4896
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/multi-service-availability-time-slots/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots)) instead.
|
|
4855
|
+
* For checking availability before creating new multi-service bookings, call [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) instead.
|
|
4897
4856
|
* @param multiServiceBookingId - ID of the multi-service booking to retrieve.
|
|
4898
4857
|
* @public
|
|
4899
4858
|
* @documentationMaturity preview
|
|
@@ -4912,7 +4871,7 @@ declare function getMultiServiceBookingAvailability(multiServiceBookingId: strin
|
|
|
4912
4871
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
4913
4872
|
* The call fails if all single-service bookings are already canceled or declined.
|
|
4914
4873
|
*
|
|
4915
|
-
* See Cancel Booking
|
|
4874
|
+
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
4916
4875
|
* @param multiServiceBookingId - ID of the multi-service booking to cancel.
|
|
4917
4876
|
* @public
|
|
4918
4877
|
* @documentationMaturity preview
|
|
@@ -4958,7 +4917,7 @@ interface CancelMultiServiceBookingOptions {
|
|
|
4958
4917
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
4959
4918
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
4960
4919
|
*
|
|
4961
|
-
* See Mark Booking as Pending
|
|
4920
|
+
* See [Mark Booking as Pending](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.
|
|
4962
4921
|
* @param multiServiceBookingId - ID of the multi-service booking to mark as `PENDING`.
|
|
4963
4922
|
* @public
|
|
4964
4923
|
* @documentationMaturity preview
|
|
@@ -5018,7 +4977,7 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
5018
4977
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
5019
4978
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
5020
4979
|
*
|
|
5021
|
-
* See Confirm Booking
|
|
4980
|
+
* See [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking) for more details about confirming single-service bookings.
|
|
5022
4981
|
* @param multiServiceBookingId - ID of the multi-service booking to confirm its related bookings.
|
|
5023
4982
|
* @public
|
|
5024
4983
|
* @documentationMaturity preview
|
|
@@ -5074,7 +5033,7 @@ interface ConfirmMultiServiceBookingOptions {
|
|
|
5074
5033
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
5075
5034
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
5076
5035
|
*
|
|
5077
|
-
* Refer to Decline Booking
|
|
5036
|
+
* Refer to [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking) for more details about declining single-service bookings.
|
|
5078
5037
|
* @param multiServiceBookingId - ID of the multi-service booking to decline.
|
|
5079
5038
|
* @public
|
|
5080
5039
|
* @documentationMaturity preview
|
|
@@ -5111,7 +5070,7 @@ interface DeclineMultiServiceBookingOptions {
|
|
|
5111
5070
|
*
|
|
5112
5071
|
* Bear the following considerations in mind when calling this method:
|
|
5113
5072
|
*
|
|
5114
|
-
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies
|
|
5073
|
+
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction), and [available resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) at the time of the call.
|
|
5115
5074
|
*
|
|
5116
5075
|
* __Permission context__: Depending on the permissions of the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/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.
|
|
5117
5076
|
*
|
|
@@ -5135,7 +5094,7 @@ declare function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds
|
|
|
5135
5094
|
* If you call on behalf of an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
|
|
5136
5095
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
5137
5096
|
*
|
|
5138
|
-
* See Query Extended Bookings
|
|
5097
|
+
* See [Query Extended Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings) for details about retrieving individual single-service bookings and additional metadata.
|
|
5139
5098
|
* @param multiServiceBookingId - ID of the multi-service booking.
|
|
5140
5099
|
* @public
|
|
5141
5100
|
* @documentationMaturity preview
|
|
@@ -5153,7 +5112,7 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
|
|
|
5153
5112
|
* ### When to call this method
|
|
5154
5113
|
*
|
|
5155
5114
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
5156
|
-
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking
|
|
5115
|
+
* For creating a new multi-service booking with new single-service bookings, call [Create Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) instead.
|
|
5157
5116
|
*
|
|
5158
5117
|
* ### Package integration
|
|
5159
5118
|
*
|
|
@@ -5202,7 +5161,7 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
5202
5161
|
*
|
|
5203
5162
|
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
5204
5163
|
*
|
|
5205
|
-
* __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
|
|
5164
|
+
* __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](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) before removing the unwanted bookings.
|
|
5206
5165
|
*
|
|
5207
5166
|
* ### Removal behavior
|
|
5208
5167
|
*
|