@wix/auto_sdk_bookings_bookings 1.0.82 → 1.0.84
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 +49 -65
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +97 -124
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +47 -57
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +49 -65
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +97 -124
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +47 -57
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +49 -65
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +97 -124
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +47 -57
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +49 -65
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +97 -124
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +47 -57
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -55,11 +55,9 @@ interface ConfirmOrDeclineBookingSignature {
|
|
|
55
55
|
* ### eCommerce checkout restriction
|
|
56
56
|
*
|
|
57
57
|
* Call this method only when using a custom checkout page. Don't
|
|
58
|
-
* call it when using a
|
|
59
|
-
* ([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)).
|
|
58
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
60
59
|
* In such cases, Wix automatically updates the booking status based on
|
|
61
|
-
* the `paymentStatus` of the corresponding
|
|
62
|
-
* ([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)).
|
|
60
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
63
61
|
*
|
|
64
62
|
* ### New booking status
|
|
65
63
|
*
|
|
@@ -100,8 +98,7 @@ interface BulkConfirmOrDeclineBookingSignature {
|
|
|
100
98
|
* Confirms or declines up to 300 bookings.
|
|
101
99
|
*
|
|
102
100
|
*
|
|
103
|
-
* See
|
|
104
|
-
* ([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))
|
|
101
|
+
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
105
102
|
* for details about when a booking is confirmed or declined.
|
|
106
103
|
* @param - Bookings to confirm or decline.
|
|
107
104
|
*/
|
|
@@ -117,23 +114,19 @@ interface CreateBookingSignature {
|
|
|
117
114
|
*
|
|
118
115
|
* ### Appointment booking
|
|
119
116
|
*
|
|
120
|
-
* For appointment-based services, specify the relevant
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
* in your call's request to avoid failed calls due to unavailability.
|
|
117
|
+
* For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
|
|
118
|
+
*
|
|
119
|
+
* We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
|
|
120
|
+
* Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
|
|
125
121
|
*
|
|
126
122
|
* ### Class session booking
|
|
127
123
|
*
|
|
128
|
-
* For class services, specify the relevant event ID
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
* `
|
|
134
|
-
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
135
|
-
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
136
|
-
* values are overridden.
|
|
124
|
+
* For class services, specify the relevant event ID as `bookedEntity.slot.eventId`.
|
|
125
|
+
*
|
|
126
|
+
* We recommend following the [class session booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-a-class-session) using Time Slots V2.
|
|
127
|
+
* Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
|
|
128
|
+
*
|
|
129
|
+
* When you specify `eventId`, Wix Bookings automatically derives `startDate`, `endDate`, `timezone`, `resource`, and `location` based on the event details. Manually specified values are ignored.
|
|
137
130
|
*
|
|
138
131
|
* ### Course booking
|
|
139
132
|
*
|
|
@@ -158,8 +151,7 @@ interface CreateBookingSignature {
|
|
|
158
151
|
*
|
|
159
152
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
160
153
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
161
|
-
*
|
|
162
|
-
* ([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)).
|
|
154
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
163
155
|
*
|
|
164
156
|
* ### Notify customers
|
|
165
157
|
*
|
|
@@ -178,9 +170,9 @@ interface CreateBookingSignature {
|
|
|
178
170
|
*
|
|
179
171
|
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
180
172
|
*
|
|
181
|
-
* For customers paying with a Wix eCommerce checkout
|
|
173
|
+
* 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).
|
|
182
174
|
*
|
|
183
|
-
* For customers using a custom checkout, call Confirm or Decline Booking
|
|
175
|
+
* 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.
|
|
184
176
|
*
|
|
185
177
|
* ### Booking form data
|
|
186
178
|
*
|
|
@@ -191,6 +183,8 @@ interface CreateBookingSignature {
|
|
|
191
183
|
* don't match, Create Booking fails. Therefore, we recommend specifying
|
|
192
184
|
* only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
193
185
|
*
|
|
186
|
+
* You can follow [this sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration#create-a-booking-with-a-filled-out-booking-form) to create bookings with booking form submissions.
|
|
187
|
+
*
|
|
194
188
|
* ### Admin overwrites
|
|
195
189
|
*
|
|
196
190
|
* There are small but important differences when you specify special
|
|
@@ -229,8 +223,7 @@ interface BulkCreateBookingSignature {
|
|
|
229
223
|
* Creates up to 8 bookings.
|
|
230
224
|
*
|
|
231
225
|
*
|
|
232
|
-
* See Create Booking
|
|
233
|
-
* ([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))
|
|
226
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
234
227
|
* for more information.
|
|
235
228
|
*
|
|
236
229
|
* If any of the specified bookings is missing a required field the entire call
|
|
@@ -261,16 +254,14 @@ interface RescheduleBookingSignature {
|
|
|
261
254
|
* ### Appointment sessions
|
|
262
255
|
*
|
|
263
256
|
* For appointments, the old session is removed from the business calendar
|
|
264
|
-
* while a new session is added. We recommend calling Query Availability
|
|
265
|
-
* ([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))
|
|
257
|
+
* 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)
|
|
266
258
|
* first and specifying the entire retrieved `slot`.
|
|
267
259
|
*
|
|
268
260
|
* ### Class sessions
|
|
269
261
|
*
|
|
270
262
|
* For classes, the new session must be an existing session belonging to the
|
|
271
263
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
272
|
-
* from Query Availability
|
|
273
|
-
* ([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))
|
|
264
|
+
* from [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
274
265
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
275
266
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
276
267
|
*
|
|
@@ -325,16 +316,14 @@ interface ConfirmBookingSignature {
|
|
|
325
316
|
* ### eCommerce checkout restriction
|
|
326
317
|
*
|
|
327
318
|
* Call this method only when using a custom checkout page. Don't
|
|
328
|
-
* call it when using a Wix eCommerce checkout
|
|
329
|
-
* ([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)).
|
|
319
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
330
320
|
* In such cases, Wix automatically updates the booking status based on
|
|
331
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
332
|
-
* ([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)).
|
|
321
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
333
322
|
*
|
|
334
323
|
* ### When to call Confirm Or Decline Booking instead
|
|
335
324
|
*
|
|
336
325
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
337
|
-
* For these checks, call Confirm or Decline Booking
|
|
326
|
+
* 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.
|
|
338
327
|
*
|
|
339
328
|
* ### Original status validation
|
|
340
329
|
*
|
|
@@ -420,17 +409,14 @@ interface DeclineBookingSignature {
|
|
|
420
409
|
* ### eCommerce checkout restriction
|
|
421
410
|
*
|
|
422
411
|
* Call this method only when using a custom checkout page. Don't
|
|
423
|
-
* call it when using a Wix eCommerce checkout
|
|
424
|
-
* ([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)).
|
|
412
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
425
413
|
* In such cases, Wix automatically updates the booking status based on
|
|
426
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
427
|
-
* ([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)).
|
|
414
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
428
415
|
*
|
|
429
416
|
* ### When to call Confirm Or Decline Booking instead
|
|
430
417
|
*
|
|
431
418
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
432
|
-
* these checks you can call Confirm or Decline Booking
|
|
433
|
-
* ([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)).
|
|
419
|
+
* 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).
|
|
434
420
|
*
|
|
435
421
|
* ### Original status validation
|
|
436
422
|
*
|
|
@@ -528,8 +514,7 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
528
514
|
*
|
|
529
515
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
530
516
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
531
|
-
* supported service options and variants
|
|
532
|
-
* ([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)).
|
|
517
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
533
518
|
* @param - ID of the booking to update the number of participants for.
|
|
534
519
|
*/
|
|
535
520
|
(bookingId: string, options?: NonNullablePaths<UpdateNumberOfParticipantsOptions, `revision`, 2>): Promise<NonNullablePaths<UpdateNumberOfParticipantsResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId`, 7> & {
|
|
@@ -544,7 +529,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
544
529
|
*
|
|
545
530
|
* ### Service requirement
|
|
546
531
|
*
|
|
547
|
-
* By default, this method only works for
|
|
532
|
+
* 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`.
|
|
548
533
|
* 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.
|
|
549
534
|
*
|
|
550
535
|
* ### Status requirements
|
|
@@ -554,15 +539,15 @@ interface MarkBookingAsPendingSignature {
|
|
|
554
539
|
*
|
|
555
540
|
* ### Checkout restrictions
|
|
556
541
|
*
|
|
557
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts
|
|
542
|
+
* 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.
|
|
558
543
|
*
|
|
559
544
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
560
545
|
*
|
|
561
546
|
* ### Business workflow
|
|
562
547
|
*
|
|
563
548
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
564
|
-
* - Confirm Booking
|
|
565
|
-
* - Decline Booking
|
|
549
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
550
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
566
551
|
*
|
|
567
552
|
* ### Resource availability and scheduling
|
|
568
553
|
*
|
|
@@ -570,7 +555,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
570
555
|
*
|
|
571
556
|
* - **Calendar impact**: The booking appears on the business calendar.
|
|
572
557
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
573
|
-
* - **Resource assignment**: Available
|
|
558
|
+
* - **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.
|
|
574
559
|
*
|
|
575
560
|
* ### Double bookings
|
|
576
561
|
*
|
|
@@ -618,7 +603,7 @@ interface CreateMultiServiceBookingSignature {
|
|
|
618
603
|
*
|
|
619
604
|
* ### When to call this method
|
|
620
605
|
*
|
|
621
|
-
* 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
|
|
606
|
+
* 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.
|
|
622
607
|
*
|
|
623
608
|
* ### Requirements and behavior
|
|
624
609
|
*
|
|
@@ -626,15 +611,15 @@ interface CreateMultiServiceBookingSignature {
|
|
|
626
611
|
*
|
|
627
612
|
* __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.
|
|
628
613
|
*
|
|
629
|
-
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order
|
|
614
|
+
* __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).
|
|
630
615
|
*
|
|
631
616
|
* __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.
|
|
632
617
|
*
|
|
633
618
|
* ### Related methods
|
|
634
619
|
*
|
|
635
|
-
* Verify availability first with List Multi Service Availability Time Slots
|
|
620
|
+
* 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).
|
|
636
621
|
*
|
|
637
|
-
* See Create Booking
|
|
622
|
+
* 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.
|
|
638
623
|
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
639
624
|
*
|
|
640
625
|
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
@@ -656,7 +641,7 @@ interface RescheduleMultiServiceBookingSignature {
|
|
|
656
641
|
*
|
|
657
642
|
* 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.
|
|
658
643
|
*
|
|
659
|
-
* See Reschedule Booking
|
|
644
|
+
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
660
645
|
* @param - ID of the multi-service booking to reschedule.
|
|
661
646
|
* @param - Information about the single-service bookings to reschedule.
|
|
662
647
|
*/
|
|
@@ -671,14 +656,13 @@ interface GetMultiServiceBookingAvailabilitySignature {
|
|
|
671
656
|
*
|
|
672
657
|
*
|
|
673
658
|
* Wix Bookings considers:
|
|
674
|
-
* - The relevant services' booking policies
|
|
675
|
-
* - The availability of all required
|
|
659
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
660
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
676
661
|
*
|
|
677
662
|
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
678
663
|
* For example, staff changes, policy updates, or capacity modifications.
|
|
679
664
|
*
|
|
680
|
-
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
681
|
-
* ([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.
|
|
665
|
+
* 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.
|
|
682
666
|
* @param - ID of the multi-service booking to retrieve.
|
|
683
667
|
*/
|
|
684
668
|
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`, 2> & {
|
|
@@ -694,7 +678,7 @@ interface CancelMultiServiceBookingSignature {
|
|
|
694
678
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
695
679
|
* The call fails if all single-service bookings are already canceled or declined.
|
|
696
680
|
*
|
|
697
|
-
* See Cancel Booking
|
|
681
|
+
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
698
682
|
* @param - ID of the multi-service booking to cancel.
|
|
699
683
|
*/
|
|
700
684
|
(multiServiceBookingId: string, options?: CancelMultiServiceBookingOptions): Promise<NonNullablePaths<CancelMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
@@ -725,7 +709,7 @@ interface MarkMultiServiceBookingAsPendingSignature {
|
|
|
725
709
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
726
710
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
727
711
|
*
|
|
728
|
-
* See Mark Booking as Pending
|
|
712
|
+
* 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.
|
|
729
713
|
* @param - ID of the multi-service booking to mark as `PENDING`.
|
|
730
714
|
*/
|
|
731
715
|
(multiServiceBookingId: string, options?: MarkMultiServiceBookingAsPendingOptions): Promise<NonNullablePaths<MarkMultiServiceBookingAsPendingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
@@ -756,7 +740,7 @@ interface ConfirmMultiServiceBookingSignature {
|
|
|
756
740
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
757
741
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
758
742
|
*
|
|
759
|
-
* See Confirm Booking
|
|
743
|
+
* 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.
|
|
760
744
|
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
761
745
|
*/
|
|
762
746
|
(multiServiceBookingId: string, options?: ConfirmMultiServiceBookingOptions): Promise<NonNullablePaths<ConfirmMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
@@ -787,7 +771,7 @@ interface DeclineMultiServiceBookingSignature {
|
|
|
787
771
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
788
772
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
789
773
|
*
|
|
790
|
-
* Refer to Decline Booking
|
|
774
|
+
* 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.
|
|
791
775
|
* @param - ID of the multi-service booking to decline.
|
|
792
776
|
*/
|
|
793
777
|
(multiServiceBookingId: string, options?: DeclineMultiServiceBookingOptions): Promise<NonNullablePaths<DeclineMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
@@ -806,7 +790,7 @@ interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
|
806
790
|
*
|
|
807
791
|
* Bear the following considerations in mind when calling this method:
|
|
808
792
|
*
|
|
809
|
-
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies
|
|
793
|
+
* __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.
|
|
810
794
|
*
|
|
811
795
|
* __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.
|
|
812
796
|
*
|
|
@@ -827,7 +811,7 @@ interface GetMultiServiceBookingSignature {
|
|
|
827
811
|
* 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.
|
|
828
812
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
829
813
|
*
|
|
830
|
-
* See Query Extended Bookings
|
|
814
|
+
* 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.
|
|
831
815
|
* @param - ID of the multi-service booking.
|
|
832
816
|
* @returns Retrieved multi-service booking.
|
|
833
817
|
*/
|
|
@@ -842,7 +826,7 @@ interface AddBookingsToMultiServiceBookingSignature {
|
|
|
842
826
|
* ### When to call this method
|
|
843
827
|
*
|
|
844
828
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
845
|
-
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking
|
|
829
|
+
* 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.
|
|
846
830
|
*
|
|
847
831
|
* ### Package integration
|
|
848
832
|
*
|
|
@@ -872,7 +856,7 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
|
872
856
|
*
|
|
873
857
|
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
874
858
|
*
|
|
875
|
-
* __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
|
|
859
|
+
* __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.
|
|
876
860
|
*
|
|
877
861
|
* ### Removal behavior
|
|
878
862
|
*
|