@wix/auto_sdk_bookings_bookings 1.0.40 → 1.0.42
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 +176 -61
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +430 -299
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +191 -180
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +176 -61
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +430 -299
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +191 -180
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +176 -61
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +430 -299
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +191 -180
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +176 -61
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +430 -299
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +191 -180
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -81,16 +81,16 @@ interface CreateBookingSignature {
|
|
|
81
81
|
*
|
|
82
82
|
* For appointment-based services, specify the relevant `slot` in
|
|
83
83
|
* `bookedEntity.slot`. We recommend specifying the complete
|
|
84
|
-
* `availabilityEntries.slot` returned in
|
|
84
|
+
* `availabilityEntries.slot` returned in Query Availability
|
|
85
85
|
* ([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))
|
|
86
86
|
* in your call's request to avoid failed calls due to unavailability.
|
|
87
87
|
*
|
|
88
88
|
* ## Class session booking
|
|
89
89
|
*
|
|
90
|
-
* For class services, specify the relevant
|
|
90
|
+
* For class services, specify the relevant event ID
|
|
91
91
|
* ([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))
|
|
92
92
|
* as `bookedEntity.slot.eventId`.
|
|
93
|
-
* We recommend retrieving the event ID from
|
|
93
|
+
* We recommend retrieving the event ID from Query Availability's
|
|
94
94
|
* ([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))
|
|
95
95
|
* `availabilityEntries.slot.eventId` to avoid failed calls due to unavailability.
|
|
96
96
|
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
@@ -145,12 +145,12 @@ interface CreateBookingSignature {
|
|
|
145
145
|
* _eCommerce checkout_
|
|
146
146
|
* ([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)),
|
|
147
147
|
* Wix Bookings automatically syncs the booking's payment status from
|
|
148
|
-
* the corresponding
|
|
148
|
+
* the corresponding eCommerce order
|
|
149
149
|
* ([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)).
|
|
150
150
|
*
|
|
151
151
|
* If a booking doesn't have a corresponding eCommerce order, for example, since
|
|
152
152
|
* the customer didn't use the eCommerce checkout, you can update the booking's
|
|
153
|
-
* payment status with
|
|
153
|
+
* payment status with Confirm Or Decline Booking
|
|
154
154
|
* ([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)).
|
|
155
155
|
*
|
|
156
156
|
* ## Booking form data
|
|
@@ -202,7 +202,7 @@ interface BulkCreateBookingSignature {
|
|
|
202
202
|
* Creates up to 8 bookings.
|
|
203
203
|
*
|
|
204
204
|
*
|
|
205
|
-
* See
|
|
205
|
+
* See Create Booking
|
|
206
206
|
* ([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))
|
|
207
207
|
* for more information.
|
|
208
208
|
*
|
|
@@ -236,7 +236,7 @@ interface RescheduleBookingSignature {
|
|
|
236
236
|
* ## Appointment sessions
|
|
237
237
|
*
|
|
238
238
|
* For appointments, the old session is removed from the business calendar
|
|
239
|
-
* while a new session is added. We recommend calling
|
|
239
|
+
* while a new session is added. We recommend calling Query Availability
|
|
240
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/time-slots/availability-calendar/query-availability))
|
|
241
241
|
* first and specifying the entire retrieved `slot`.
|
|
242
242
|
*
|
|
@@ -244,7 +244,7 @@ interface RescheduleBookingSignature {
|
|
|
244
244
|
*
|
|
245
245
|
* For classes, the new session must be an existing session belonging to the
|
|
246
246
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
247
|
-
* from
|
|
247
|
+
* from Query Availability
|
|
248
248
|
* ([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))
|
|
249
249
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
250
250
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
@@ -296,24 +296,22 @@ interface RescheduleBookingSignature {
|
|
|
296
296
|
declare function confirmBooking$1(httpClient: HttpClient): ConfirmBookingSignature;
|
|
297
297
|
interface ConfirmBookingSignature {
|
|
298
298
|
/**
|
|
299
|
-
* Updates the booking status to `CONFIRMED`
|
|
300
|
-
*
|
|
301
|
-
* slot or schedule is still available.
|
|
299
|
+
* Updates the booking status to `CONFIRMED` without checking whether the relevant slot or schedule is still available.
|
|
300
|
+
*
|
|
302
301
|
*
|
|
303
302
|
* ## eCommerce checkout restriction
|
|
304
303
|
*
|
|
305
304
|
* Call this method only when using a custom checkout page. Don't
|
|
306
|
-
* call it when using a
|
|
305
|
+
* call it when using a Wix eCommerce checkout
|
|
307
306
|
* ([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)).
|
|
308
307
|
* In such cases, Wix automatically updates the booking status based on
|
|
309
|
-
* the `paymentStatus` of the corresponding
|
|
308
|
+
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
310
309
|
* ([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)).
|
|
311
310
|
*
|
|
312
311
|
* ## When to call Confirm Or Decline Booking instead
|
|
313
312
|
*
|
|
314
|
-
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
315
|
-
* these checks
|
|
316
|
-
* ([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)).
|
|
313
|
+
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
314
|
+
* For these checks, call Confirm or Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)) instead.
|
|
317
315
|
*
|
|
318
316
|
* ## Original status validation
|
|
319
317
|
*
|
|
@@ -403,16 +401,16 @@ interface DeclineBookingSignature {
|
|
|
403
401
|
* ## eCommerce checkout restriction
|
|
404
402
|
*
|
|
405
403
|
* Call this method only when using a custom checkout page. Don't
|
|
406
|
-
* call it when using a
|
|
404
|
+
* call it when using a Wix eCommerce checkout
|
|
407
405
|
* ([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)).
|
|
408
406
|
* In such cases, Wix automatically updates the booking status based on
|
|
409
|
-
* the `paymentStatus` of the corresponding
|
|
407
|
+
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
410
408
|
* ([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)).
|
|
411
409
|
*
|
|
412
410
|
* ## When to call Confirm Or Decline Booking instead
|
|
413
411
|
*
|
|
414
412
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
415
|
-
* these checks you can call
|
|
413
|
+
* these checks you can call Confirm or Decline Booking
|
|
416
414
|
* ([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)).
|
|
417
415
|
*
|
|
418
416
|
* ## Original status validation
|
|
@@ -515,7 +513,7 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
515
513
|
*
|
|
516
514
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
517
515
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
518
|
-
* supported
|
|
516
|
+
* supported service options and variants
|
|
519
517
|
* ([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)).
|
|
520
518
|
* @param - ID of the booking to update the number of participants for.
|
|
521
519
|
*/
|
|
@@ -528,11 +526,34 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
528
526
|
declare function createMultiServiceBooking$1(httpClient: HttpClient): CreateMultiServiceBookingSignature;
|
|
529
527
|
interface CreateMultiServiceBookingSignature {
|
|
530
528
|
/**
|
|
531
|
-
* Creates a multi-service booking.
|
|
529
|
+
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
530
|
+
*
|
|
531
|
+
*
|
|
532
|
+
* ## When to call this method
|
|
533
|
+
*
|
|
534
|
+
* 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking)) instead.
|
|
535
|
+
*
|
|
536
|
+
* ## Requirements and behavior
|
|
537
|
+
*
|
|
538
|
+
* __Package constraints__: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
|
|
539
|
+
*
|
|
540
|
+
* __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.
|
|
541
|
+
*
|
|
542
|
+
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/orders/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)) if the customer paid via an eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecommerce/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
532
543
|
*
|
|
544
|
+
* __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.
|
|
533
545
|
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
546
|
+
* ## Related methods
|
|
547
|
+
*
|
|
548
|
+
* Verify availability first with List Multi Service Availability Time Slots ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-reader-v2/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/list-multi-service-availability-time-slots)).
|
|
549
|
+
*
|
|
550
|
+
* See Create Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/create-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)) for more details about constraints and effects of creating single-service bookings.
|
|
551
|
+
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
552
|
+
*
|
|
553
|
+
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
554
|
+
* Specify contact details, number of participants, and any additional fields as needed.
|
|
555
|
+
*
|
|
556
|
+
* For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
|
|
536
557
|
*/
|
|
537
558
|
(bookings: NonNullablePaths<Booking, `additionalFields.${number}._id` | `bookedEntity` | `bookedEntity.slot` | `bookedEntity.slot.endDate` | `bookedEntity.slot.location.locationType` | `bookedEntity.slot.scheduleId` | `bookedEntity.slot.startDate`>[], options?: CreateMultiServiceBookingOptions): Promise<NonNullablePaths<CreateMultiServiceBookingResponse, `multiServiceBooking.bookings` | {
|
|
538
559
|
[P in BookingNonNullablePaths]: `multiServiceBooking.bookings.${number}.booking.${P}`;
|
|
@@ -543,15 +564,15 @@ interface CreateMultiServiceBookingSignature {
|
|
|
543
564
|
declare function rescheduleMultiServiceBooking$1(httpClient: HttpClient): RescheduleMultiServiceBookingSignature;
|
|
544
565
|
interface RescheduleMultiServiceBookingSignature {
|
|
545
566
|
/**
|
|
546
|
-
* Reschedules a multi-service booking.
|
|
567
|
+
* Reschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package.
|
|
547
568
|
*
|
|
548
569
|
*
|
|
549
|
-
*
|
|
550
|
-
* the service being unavailable or a rescheduling policy violation.
|
|
570
|
+
* This method reschedules single-service bookings within the multi-service booking while maintaining sequential order. You must specify exact new timing for each service to ensure they remain back-to-back with no gaps or overlaps.
|
|
551
571
|
*
|
|
572
|
+
* 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.
|
|
552
573
|
*
|
|
553
|
-
* See Reschedule Booking for
|
|
554
|
-
* @param - ID of the multi
|
|
574
|
+
* See Reschedule Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking)) for single-service booking rescheduling details.
|
|
575
|
+
* @param - ID of the multi-service booking to reschedule.
|
|
555
576
|
* @param - Information about the single-service bookings to reschedule.
|
|
556
577
|
*/
|
|
557
578
|
(multiServiceBookingId: string, rescheduleBookingsInfo: NonNullablePaths<RescheduleBookingInfo, `bookingId` | `revision` | `slot`>[], options?: RescheduleMultiServiceBookingOptions): Promise<NonNullablePaths<RescheduleMultiServiceBookingResponse, `multiServiceBooking.bookings` | {
|
|
@@ -563,11 +584,18 @@ interface RescheduleMultiServiceBookingSignature {
|
|
|
563
584
|
declare function getMultiServiceBookingAvailability$1(httpClient: HttpClient): GetMultiServiceBookingAvailabilitySignature;
|
|
564
585
|
interface GetMultiServiceBookingAvailabilitySignature {
|
|
565
586
|
/**
|
|
566
|
-
*
|
|
587
|
+
* Checks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations.
|
|
567
588
|
*
|
|
568
589
|
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
590
|
+
* Wix Bookings considers:
|
|
591
|
+
* - The relevant services' booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)).
|
|
592
|
+
* - The availability of all required resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/introduction)).
|
|
593
|
+
*
|
|
594
|
+
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
595
|
+
* For example, staff changes, policy updates, or capacity modifications.
|
|
596
|
+
*
|
|
597
|
+
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
598
|
+
* ([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.
|
|
571
599
|
* @param - ID of the multi-service booking to retrieve.
|
|
572
600
|
*/
|
|
573
601
|
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`> & {
|
|
@@ -577,7 +605,13 @@ interface GetMultiServiceBookingAvailabilitySignature {
|
|
|
577
605
|
declare function cancelMultiServiceBooking$1(httpClient: HttpClient): CancelMultiServiceBookingSignature;
|
|
578
606
|
interface CancelMultiServiceBookingSignature {
|
|
579
607
|
/**
|
|
580
|
-
* Cancels a multi-service booking and
|
|
608
|
+
* Cancels a multi-service booking and all its associated single-service bookings.
|
|
609
|
+
*
|
|
610
|
+
*
|
|
611
|
+
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
612
|
+
* The call fails if all single-service bookings are already canceled or declined.
|
|
613
|
+
*
|
|
614
|
+
* See Cancel Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/cancel-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking)) for single-service booking cancellation details.
|
|
581
615
|
* @param - ID of the multi-service booking to cancel.
|
|
582
616
|
*/
|
|
583
617
|
(multiServiceBookingId: string, options?: CancelMultiServiceBookingOptions): Promise<NonNullablePaths<CancelMultiServiceBookingResponse, `multiServiceBooking.bookings` | {
|
|
@@ -589,14 +623,28 @@ interface CancelMultiServiceBookingSignature {
|
|
|
589
623
|
declare function markMultiServiceBookingAsPending$1(httpClient: HttpClient): MarkMultiServiceBookingAsPendingSignature;
|
|
590
624
|
interface MarkMultiServiceBookingAsPendingSignature {
|
|
591
625
|
/**
|
|
592
|
-
* Updates the status
|
|
626
|
+
* Updates the status for all single-service bookings in a multi-service booking to `PENDING`.
|
|
627
|
+
*
|
|
628
|
+
*
|
|
629
|
+
* Call this method for multi-service bookings requiring manual business approval before confirmation.
|
|
630
|
+
*
|
|
631
|
+
* ## Status requirements
|
|
632
|
+
*
|
|
633
|
+
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
634
|
+
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
635
|
+
*
|
|
636
|
+
* ## Checkout restrictions
|
|
593
637
|
*
|
|
638
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
639
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
594
640
|
*
|
|
595
|
-
*
|
|
641
|
+
* ## Additional updates
|
|
596
642
|
*
|
|
597
|
-
*
|
|
643
|
+
* - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
|
|
644
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
645
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
598
646
|
*
|
|
599
|
-
* See Mark Booking as Pending for more
|
|
647
|
+
* See Mark Booking as Pending ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/mark-booking-as-pending) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/mark-booking-as-pending)) for more details about marking single-service bookings as pending.
|
|
600
648
|
* @param - ID of the multi-service booking to mark as `PENDING`.
|
|
601
649
|
*/
|
|
602
650
|
(multiServiceBookingId: string, options?: MarkMultiServiceBookingAsPendingOptions): Promise<NonNullablePaths<MarkMultiServiceBookingAsPendingResponse, `multiServiceBooking.bookings` | {
|
|
@@ -608,14 +656,28 @@ interface MarkMultiServiceBookingAsPendingSignature {
|
|
|
608
656
|
declare function confirmMultiServiceBooking$1(httpClient: HttpClient): ConfirmMultiServiceBookingSignature;
|
|
609
657
|
interface ConfirmMultiServiceBookingSignature {
|
|
610
658
|
/**
|
|
611
|
-
* Updates the status
|
|
659
|
+
* Updates the status for all single-service bookings in a multi-service booking to `CONFIRMED`.
|
|
612
660
|
*
|
|
613
661
|
*
|
|
614
|
-
*
|
|
662
|
+
* Call this method for multi-service bookings requiring manual business approval.
|
|
615
663
|
*
|
|
616
|
-
*
|
|
664
|
+
* ## Status requirements
|
|
617
665
|
*
|
|
618
|
-
*
|
|
666
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
667
|
+
* - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
|
|
668
|
+
*
|
|
669
|
+
* ## Checkout restrictions
|
|
670
|
+
*
|
|
671
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
672
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
673
|
+
*
|
|
674
|
+
* ## Additional updates
|
|
675
|
+
*
|
|
676
|
+
* - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
|
|
677
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
678
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
679
|
+
*
|
|
680
|
+
* See Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)) for more details about confirming single-service bookings.
|
|
619
681
|
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
620
682
|
*/
|
|
621
683
|
(multiServiceBookingId: string, options?: ConfirmMultiServiceBookingOptions): Promise<NonNullablePaths<ConfirmMultiServiceBookingResponse, `multiServiceBooking.bookings` | {
|
|
@@ -627,15 +689,29 @@ interface ConfirmMultiServiceBookingSignature {
|
|
|
627
689
|
declare function declineMultiServiceBooking$1(httpClient: HttpClient): DeclineMultiServiceBookingSignature;
|
|
628
690
|
interface DeclineMultiServiceBookingSignature {
|
|
629
691
|
/**
|
|
630
|
-
* Updates the status
|
|
692
|
+
* Updates the status for all single-service bookings in a multi-service booking to `DECLINED`.
|
|
693
|
+
*
|
|
694
|
+
*
|
|
695
|
+
* Call this method to reject multi-service bookings that can't be accommodated or don't meet business requirements.
|
|
696
|
+
*
|
|
697
|
+
* ## Status requirements
|
|
631
698
|
*
|
|
699
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
700
|
+
* - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
|
|
632
701
|
*
|
|
633
|
-
*
|
|
702
|
+
* ## Checkout restrictions
|
|
634
703
|
*
|
|
635
|
-
*
|
|
704
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
705
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
636
706
|
*
|
|
637
|
-
*
|
|
638
|
-
*
|
|
707
|
+
* ## Additional updates
|
|
708
|
+
*
|
|
709
|
+
* - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
|
|
710
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
711
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
712
|
+
*
|
|
713
|
+
* Refer to Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)) for more details about declining single-service bookings.
|
|
714
|
+
* @param - ID of the multi-service booking to decline.
|
|
639
715
|
*/
|
|
640
716
|
(multiServiceBookingId: string, options?: DeclineMultiServiceBookingOptions): Promise<NonNullablePaths<DeclineMultiServiceBookingResponse, `multiServiceBooking.bookings` | {
|
|
641
717
|
[P in BookingNonNullablePaths]: `multiServiceBooking.bookings.${number}.booking.${P}`;
|
|
@@ -646,7 +722,21 @@ interface DeclineMultiServiceBookingSignature {
|
|
|
646
722
|
declare function bulkGetMultiServiceBookingAllowedActions$1(httpClient: HttpClient): BulkGetMultiServiceBookingAllowedActionsSignature;
|
|
647
723
|
interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
648
724
|
/**
|
|
649
|
-
* Retrieves
|
|
725
|
+
* Retrieves information about which actions the customer can perform for up to 50 multi-service bookings.
|
|
726
|
+
*
|
|
727
|
+
*
|
|
728
|
+
* For each multi-service booking, the response indicates which actions are currently allowed:
|
|
729
|
+
* - `cancel`: Whether the customer can cancel the multi-service booking.
|
|
730
|
+
* - `reschedule`: Whether the customer can adjust the multi-service booking's timing.
|
|
731
|
+
*
|
|
732
|
+
* Bear the following considerations in mind when calling this method:
|
|
733
|
+
*
|
|
734
|
+
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)), and available resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) at the time of the call.
|
|
735
|
+
*
|
|
736
|
+
* __Permission context__: Depending on the permissions of the calling [identity](https://dev.wix.com/build-apps/develop-your-app/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
|
|
737
|
+
*
|
|
738
|
+
* __Status dependencies__: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
|
|
739
|
+
* Bookings can skip `PENDING` and move directly from `CREATED` to `CONFIRMED`/`DECLINED` based on service configuration.
|
|
650
740
|
* @param - IDs of the multi-service bookings to retrieve allowed actions for.
|
|
651
741
|
*/
|
|
652
742
|
(multiServiceBookingIds: string[]): Promise<NonNullablePaths<BulkGetMultiServiceBookingAllowedActionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.cancel` | `results.${number}.item.reschedule` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
@@ -654,13 +744,15 @@ interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
|
654
744
|
declare function getMultiServiceBooking$1(httpClient: HttpClient): GetMultiServiceBookingSignature;
|
|
655
745
|
interface GetMultiServiceBookingSignature {
|
|
656
746
|
/**
|
|
657
|
-
* Retrieves
|
|
747
|
+
* Retrieves a multi-service booking and all its associated single-service bookings.
|
|
748
|
+
*
|
|
658
749
|
*
|
|
750
|
+
* Returns the complete multi-service booking information including its ID, associated single-service bookings, and the total number of scheduled single-service bookings.
|
|
659
751
|
*
|
|
660
|
-
* If you call
|
|
661
|
-
*
|
|
662
|
-
*
|
|
663
|
-
*
|
|
752
|
+
* 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.
|
|
753
|
+
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
754
|
+
*
|
|
755
|
+
* See Query Extended Bookings ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/query-extended-bookings) | [REST](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.
|
|
664
756
|
* @param - ID of the multi-service booking.
|
|
665
757
|
* @returns Retrieved multi-service booking.
|
|
666
758
|
*/
|
|
@@ -671,11 +763,24 @@ interface GetMultiServiceBookingSignature {
|
|
|
671
763
|
declare function addBookingsToMultiServiceBooking$1(httpClient: HttpClient): AddBookingsToMultiServiceBookingSignature;
|
|
672
764
|
interface AddBookingsToMultiServiceBookingSignature {
|
|
673
765
|
/**
|
|
674
|
-
*
|
|
766
|
+
* Expands an existing multi-service booking by adding existing single-service bookings to the package.
|
|
767
|
+
*
|
|
768
|
+
*
|
|
769
|
+
* ## When to call this method
|
|
770
|
+
*
|
|
771
|
+
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
772
|
+
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/create-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking)) instead.
|
|
773
|
+
*
|
|
774
|
+
* ## Package integration
|
|
675
775
|
*
|
|
776
|
+
* The timing of the single-service bookings to add must be compatible with the multi-service booking's sequential schedule to ensure no gaps or overlaps between services in the updated package.
|
|
676
777
|
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
778
|
+
* ## Requirements and limitations
|
|
779
|
+
*
|
|
780
|
+
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
781
|
+
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
782
|
+
* - __Status compatibility__: Added bookings must have compatible status with the target multi-service booking.
|
|
783
|
+
* - __Revision control__: You must provide current revision numbers for all single-service bookings to add.
|
|
679
784
|
* @param - ID of the multi-service booking.
|
|
680
785
|
*/
|
|
681
786
|
(multiServiceBookingId: string, options?: NonNullablePaths<AddBookingsToMultiServiceBookingOptions, `bookings` | `bookings.${number}.bookingId` | `bookings.${number}.revision`>): Promise<NonNullablePaths<AddBookingsToMultiServiceBookingResponse, `bookings` | {
|
|
@@ -687,16 +792,26 @@ interface AddBookingsToMultiServiceBookingSignature {
|
|
|
687
792
|
declare function removeBookingsFromMultiServiceBooking$1(httpClient: HttpClient): RemoveBookingsFromMultiServiceBookingSignature;
|
|
688
793
|
interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
689
794
|
/**
|
|
690
|
-
* Removes single-service bookings from a multi-service booking and
|
|
691
|
-
*
|
|
795
|
+
* Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings.
|
|
796
|
+
*
|
|
797
|
+
*
|
|
798
|
+
* ## Removal options
|
|
799
|
+
*
|
|
800
|
+
* __Remove all permitted bookings__: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
|
|
801
|
+
*
|
|
802
|
+
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
803
|
+
*
|
|
804
|
+
* __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call Reschedule Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/multi-service-bookings/reschedule-multi-service-booking)) before removing the unwanted bookings.
|
|
805
|
+
*
|
|
806
|
+
* ## Removal behavior
|
|
692
807
|
*
|
|
808
|
+
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
809
|
+
* You can manage them using single-service booking methods.
|
|
693
810
|
*
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
* has read permissions are removed from the multi-service booking.
|
|
811
|
+
* __Automatic cleanup__: Multi-service bookings must contain at least 2 services.
|
|
812
|
+
* If removal results in only 1 remaining single-service booking for the multi-service booking, the entire multi-service booking is deleted and the remaining single-service booking becomes a standalone booking.
|
|
697
813
|
*
|
|
698
|
-
*
|
|
699
|
-
* booking, the multi-service booking is also deleted.
|
|
814
|
+
* __Revision control__: Specify current revision numbers to prevent conflicting modifications during the removal process.
|
|
700
815
|
* @param - ID of the multi-service booking.
|
|
701
816
|
*/
|
|
702
817
|
(multiServiceBookingId: string, options?: RemoveBookingsFromMultiServiceBookingOptions): Promise<NonNullablePaths<RemoveBookingsFromMultiServiceBookingResponse, `bookings` | {
|