@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
|
@@ -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
|
*/
|
|
@@ -119,17 +116,14 @@ interface CreateBookingSignature {
|
|
|
119
116
|
*
|
|
120
117
|
* For appointment-based services, specify the relevant `slot` in
|
|
121
118
|
* `bookedEntity.slot`. We recommend specifying the complete
|
|
122
|
-
* `availabilityEntries.slot` returned in Query Availability
|
|
123
|
-
* ([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))
|
|
119
|
+
* `availabilityEntries.slot` returned in [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
124
120
|
* in your call's request to avoid failed calls due to unavailability.
|
|
125
121
|
*
|
|
126
122
|
* ### Class session booking
|
|
127
123
|
*
|
|
128
|
-
* For class services, specify the relevant event ID
|
|
129
|
-
* ([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))
|
|
124
|
+
* For class services, specify the relevant [event ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
|
|
130
125
|
* as `bookedEntity.slot.eventId`.
|
|
131
|
-
* We recommend retrieving the event ID from Query Availability's
|
|
132
|
-
* ([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))
|
|
126
|
+
* 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)
|
|
133
127
|
* `availabilityEntries.slot.eventId` to avoid failed calls due to unavailability.
|
|
134
128
|
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
135
129
|
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
@@ -158,8 +152,7 @@ interface CreateBookingSignature {
|
|
|
158
152
|
*
|
|
159
153
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
160
154
|
* 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)).
|
|
155
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
163
156
|
*
|
|
164
157
|
* ### Notify customers
|
|
165
158
|
*
|
|
@@ -178,9 +171,9 @@ interface CreateBookingSignature {
|
|
|
178
171
|
*
|
|
179
172
|
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
180
173
|
*
|
|
181
|
-
* For customers paying with a Wix eCommerce checkout
|
|
174
|
+
* 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
175
|
*
|
|
183
|
-
* For customers using a custom checkout, call Confirm or Decline Booking
|
|
176
|
+
* 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
177
|
*
|
|
185
178
|
* ### Booking form data
|
|
186
179
|
*
|
|
@@ -229,8 +222,7 @@ interface BulkCreateBookingSignature {
|
|
|
229
222
|
* Creates up to 8 bookings.
|
|
230
223
|
*
|
|
231
224
|
*
|
|
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))
|
|
225
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
234
226
|
* for more information.
|
|
235
227
|
*
|
|
236
228
|
* If any of the specified bookings is missing a required field the entire call
|
|
@@ -261,16 +253,14 @@ interface RescheduleBookingSignature {
|
|
|
261
253
|
* ### Appointment sessions
|
|
262
254
|
*
|
|
263
255
|
* 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))
|
|
256
|
+
* 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
257
|
* first and specifying the entire retrieved `slot`.
|
|
267
258
|
*
|
|
268
259
|
* ### Class sessions
|
|
269
260
|
*
|
|
270
261
|
* For classes, the new session must be an existing session belonging to the
|
|
271
262
|
* 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))
|
|
263
|
+
* from [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
274
264
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
275
265
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
276
266
|
*
|
|
@@ -325,16 +315,14 @@ interface ConfirmBookingSignature {
|
|
|
325
315
|
* ### eCommerce checkout restriction
|
|
326
316
|
*
|
|
327
317
|
* 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)).
|
|
318
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
330
319
|
* 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)).
|
|
320
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
333
321
|
*
|
|
334
322
|
* ### When to call Confirm Or Decline Booking instead
|
|
335
323
|
*
|
|
336
324
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
337
|
-
* For these checks, call Confirm or Decline Booking
|
|
325
|
+
* 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
326
|
*
|
|
339
327
|
* ### Original status validation
|
|
340
328
|
*
|
|
@@ -420,17 +408,14 @@ interface DeclineBookingSignature {
|
|
|
420
408
|
* ### eCommerce checkout restriction
|
|
421
409
|
*
|
|
422
410
|
* 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)).
|
|
411
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
425
412
|
* 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)).
|
|
413
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
428
414
|
*
|
|
429
415
|
* ### When to call Confirm Or Decline Booking instead
|
|
430
416
|
*
|
|
431
417
|
* 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)).
|
|
418
|
+
* 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
419
|
*
|
|
435
420
|
* ### Original status validation
|
|
436
421
|
*
|
|
@@ -528,8 +513,7 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
528
513
|
*
|
|
529
514
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
530
515
|
* 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)).
|
|
516
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
533
517
|
* @param - ID of the booking to update the number of participants for.
|
|
534
518
|
*/
|
|
535
519
|
(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 +528,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
544
528
|
*
|
|
545
529
|
* ### Service requirement
|
|
546
530
|
*
|
|
547
|
-
* By default, this method only works for
|
|
531
|
+
* 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
532
|
* 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
533
|
*
|
|
550
534
|
* ### Status requirements
|
|
@@ -554,15 +538,15 @@ interface MarkBookingAsPendingSignature {
|
|
|
554
538
|
*
|
|
555
539
|
* ### Checkout restrictions
|
|
556
540
|
*
|
|
557
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts
|
|
541
|
+
* 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
542
|
*
|
|
559
543
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
560
544
|
*
|
|
561
545
|
* ### Business workflow
|
|
562
546
|
*
|
|
563
547
|
* 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
|
|
548
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
549
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
566
550
|
*
|
|
567
551
|
* ### Resource availability and scheduling
|
|
568
552
|
*
|
|
@@ -570,7 +554,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
570
554
|
*
|
|
571
555
|
* - **Calendar impact**: The booking appears on the business calendar.
|
|
572
556
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
573
|
-
* - **Resource assignment**: Available
|
|
557
|
+
* - **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
558
|
*
|
|
575
559
|
* ### Double bookings
|
|
576
560
|
*
|
|
@@ -618,7 +602,7 @@ interface CreateMultiServiceBookingSignature {
|
|
|
618
602
|
*
|
|
619
603
|
* ### When to call this method
|
|
620
604
|
*
|
|
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
|
|
605
|
+
* 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
606
|
*
|
|
623
607
|
* ### Requirements and behavior
|
|
624
608
|
*
|
|
@@ -626,15 +610,15 @@ interface CreateMultiServiceBookingSignature {
|
|
|
626
610
|
*
|
|
627
611
|
* __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
612
|
*
|
|
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
|
|
613
|
+
* __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
614
|
*
|
|
631
615
|
* __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
616
|
*
|
|
633
617
|
* ### Related methods
|
|
634
618
|
*
|
|
635
|
-
* Verify availability first with List Multi Service Availability Time Slots
|
|
619
|
+
* 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
620
|
*
|
|
637
|
-
* See Create Booking
|
|
621
|
+
* 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
622
|
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
639
623
|
*
|
|
640
624
|
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
@@ -656,7 +640,7 @@ interface RescheduleMultiServiceBookingSignature {
|
|
|
656
640
|
*
|
|
657
641
|
* 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
642
|
*
|
|
659
|
-
* See Reschedule Booking
|
|
643
|
+
* 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
644
|
* @param - ID of the multi-service booking to reschedule.
|
|
661
645
|
* @param - Information about the single-service bookings to reschedule.
|
|
662
646
|
*/
|
|
@@ -671,14 +655,13 @@ interface GetMultiServiceBookingAvailabilitySignature {
|
|
|
671
655
|
*
|
|
672
656
|
*
|
|
673
657
|
* Wix Bookings considers:
|
|
674
|
-
* - The relevant services' booking policies
|
|
675
|
-
* - The availability of all required
|
|
658
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
659
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
676
660
|
*
|
|
677
661
|
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
678
662
|
* For example, staff changes, policy updates, or capacity modifications.
|
|
679
663
|
*
|
|
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.
|
|
664
|
+
* 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
665
|
* @param - ID of the multi-service booking to retrieve.
|
|
683
666
|
*/
|
|
684
667
|
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`, 2> & {
|
|
@@ -694,7 +677,7 @@ interface CancelMultiServiceBookingSignature {
|
|
|
694
677
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
695
678
|
* The call fails if all single-service bookings are already canceled or declined.
|
|
696
679
|
*
|
|
697
|
-
* See Cancel Booking
|
|
680
|
+
* 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
681
|
* @param - ID of the multi-service booking to cancel.
|
|
699
682
|
*/
|
|
700
683
|
(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 +708,7 @@ interface MarkMultiServiceBookingAsPendingSignature {
|
|
|
725
708
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
726
709
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
727
710
|
*
|
|
728
|
-
* See Mark Booking as Pending
|
|
711
|
+
* 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
712
|
* @param - ID of the multi-service booking to mark as `PENDING`.
|
|
730
713
|
*/
|
|
731
714
|
(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 +739,7 @@ interface ConfirmMultiServiceBookingSignature {
|
|
|
756
739
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
757
740
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
758
741
|
*
|
|
759
|
-
* See Confirm Booking
|
|
742
|
+
* 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
743
|
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
761
744
|
*/
|
|
762
745
|
(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 +770,7 @@ interface DeclineMultiServiceBookingSignature {
|
|
|
787
770
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
788
771
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
789
772
|
*
|
|
790
|
-
* Refer to Decline Booking
|
|
773
|
+
* 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
774
|
* @param - ID of the multi-service booking to decline.
|
|
792
775
|
*/
|
|
793
776
|
(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 +789,7 @@ interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
|
806
789
|
*
|
|
807
790
|
* Bear the following considerations in mind when calling this method:
|
|
808
791
|
*
|
|
809
|
-
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies
|
|
792
|
+
* __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
793
|
*
|
|
811
794
|
* __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
795
|
*
|
|
@@ -827,7 +810,7 @@ interface GetMultiServiceBookingSignature {
|
|
|
827
810
|
* 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
811
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
829
812
|
*
|
|
830
|
-
* See Query Extended Bookings
|
|
813
|
+
* 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
814
|
* @param - ID of the multi-service booking.
|
|
832
815
|
* @returns Retrieved multi-service booking.
|
|
833
816
|
*/
|
|
@@ -842,7 +825,7 @@ interface AddBookingsToMultiServiceBookingSignature {
|
|
|
842
825
|
* ### When to call this method
|
|
843
826
|
*
|
|
844
827
|
* 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
|
|
828
|
+
* 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
829
|
*
|
|
847
830
|
* ### Package integration
|
|
848
831
|
*
|
|
@@ -872,7 +855,7 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
|
872
855
|
*
|
|
873
856
|
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
874
857
|
*
|
|
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
|
|
858
|
+
* __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
859
|
*
|
|
877
860
|
* ### Removal behavior
|
|
878
861
|
*
|