@wix/auto_sdk_bookings_bookings 1.0.41 → 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 +42 -45
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +81 -57
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +23 -8
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +42 -45
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +81 -57
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +23 -8
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +42 -45
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +81 -57
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +23 -8
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +42 -45
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +81 -57
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +23 -8
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -153,8 +153,11 @@ interface BookingParticipantsInfoOneOf {
|
|
|
153
153
|
* For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
|
|
154
154
|
*/
|
|
155
155
|
declare enum MultiServiceBookingType {
|
|
156
|
+
/** You must schedule single-service bookings back-to-back with each booking starting when the previous booking ends */
|
|
156
157
|
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
158
|
+
/** Not currently supported. */
|
|
157
159
|
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
160
|
+
/** Not currently supported. */
|
|
158
161
|
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
159
162
|
}
|
|
160
163
|
/** @enumType */
|
|
@@ -564,7 +567,7 @@ declare enum Actor {
|
|
|
564
567
|
type ActorWithLiterals = Actor | 'UNDEFINED_ACTOR' | 'BUSINESS' | 'CUSTOMER';
|
|
565
568
|
interface ParticipantNotification {
|
|
566
569
|
/**
|
|
567
|
-
* Whether to send
|
|
570
|
+
* Whether to send a message about the changes to the customer.
|
|
568
571
|
*
|
|
569
572
|
* Default: `false`
|
|
570
573
|
*/
|
|
@@ -1516,7 +1519,7 @@ interface CreateBookingFlowControlSettings {
|
|
|
1516
1519
|
* Whether `PENDING` bookings are automatically set to `CONFIRMED` for
|
|
1517
1520
|
* services that normally require the owner's manual confirmation.
|
|
1518
1521
|
*
|
|
1519
|
-
* Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission
|
|
1522
|
+
* Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission
|
|
1520
1523
|
* when passing `true`.
|
|
1521
1524
|
* Default: `false`.
|
|
1522
1525
|
*/
|
|
@@ -1525,7 +1528,7 @@ interface CreateBookingFlowControlSettings {
|
|
|
1525
1528
|
* Whether customers can pay using a payment method that isn't supported
|
|
1526
1529
|
* for the service, but that's supported for other services.
|
|
1527
1530
|
*
|
|
1528
|
-
* Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission
|
|
1531
|
+
* Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission when passing
|
|
1529
1532
|
* `true`.
|
|
1530
1533
|
* Default: `false`.
|
|
1531
1534
|
*/
|
|
@@ -2650,7 +2653,7 @@ interface CreateMultiServiceBookingRequest {
|
|
|
2650
2653
|
/**
|
|
2651
2654
|
* Multi-service booking type.
|
|
2652
2655
|
*
|
|
2653
|
-
* Currently only `SEQUENTIAL_BOOKINGS` is supported
|
|
2656
|
+
* Currently only `SEQUENTIAL_BOOKINGS` is supported.
|
|
2654
2657
|
*/
|
|
2655
2658
|
multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
|
|
2656
2659
|
}
|
|
@@ -2810,7 +2813,11 @@ interface MarkMultiServiceBookingAsPendingRequest {
|
|
|
2810
2813
|
sendSmsReminder?: boolean | null;
|
|
2811
2814
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
2812
2815
|
doubleBooked?: boolean | null;
|
|
2813
|
-
/**
|
|
2816
|
+
/**
|
|
2817
|
+
* Whether to return the single-service bookings that were marked as `PENDING`.
|
|
2818
|
+
*
|
|
2819
|
+
* Default: `false`
|
|
2820
|
+
*/
|
|
2814
2821
|
returnFullEntity?: boolean;
|
|
2815
2822
|
/**
|
|
2816
2823
|
* Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
|
|
@@ -2903,7 +2910,7 @@ interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
|
2903
2910
|
interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
2904
2911
|
/**
|
|
2905
2912
|
* Information about the multi-service bookings that were retrieved.
|
|
2906
|
-
*
|
|
2913
|
+
* Includes their ID, index in the bulk request and whether they were successfully processed.
|
|
2907
2914
|
*/
|
|
2908
2915
|
results?: BulkCalculateAllowedActionsResult[];
|
|
2909
2916
|
/** Total number of successes and failures for Bulk Get Multi Service Booking Allowed Actions. */
|
|
@@ -2940,7 +2947,11 @@ interface AddBookingsToMultiServiceBookingRequest {
|
|
|
2940
2947
|
* @maxSize 8
|
|
2941
2948
|
*/
|
|
2942
2949
|
bookings: BookingIdAndRevision[];
|
|
2943
|
-
/**
|
|
2950
|
+
/**
|
|
2951
|
+
* Whether to return the single-service bookings that were added to the multi-service booking.
|
|
2952
|
+
*
|
|
2953
|
+
* Default: `false`
|
|
2954
|
+
*/
|
|
2944
2955
|
returnFullEntity?: boolean;
|
|
2945
2956
|
}
|
|
2946
2957
|
interface BookingIdAndRevision {
|
|
@@ -2970,7 +2981,11 @@ interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
|
2970
2981
|
* @maxSize 8
|
|
2971
2982
|
*/
|
|
2972
2983
|
bookings?: BookingIdAndRevision[];
|
|
2973
|
-
/**
|
|
2984
|
+
/**
|
|
2985
|
+
* Whether to return the single-service bookings.
|
|
2986
|
+
*
|
|
2987
|
+
* Default: `false`
|
|
2988
|
+
*/
|
|
2974
2989
|
returnFullEntity?: boolean;
|
|
2975
2990
|
}
|
|
2976
2991
|
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
@@ -4481,17 +4496,17 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4481
4496
|
*
|
|
4482
4497
|
* ## When to call this method
|
|
4483
4498
|
*
|
|
4484
|
-
* Create sequential appointments where customers book related services. 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.
|
|
4499
|
+
* 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.
|
|
4485
4500
|
*
|
|
4486
4501
|
* ## Requirements and behavior
|
|
4487
4502
|
*
|
|
4488
|
-
*
|
|
4503
|
+
* __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.
|
|
4489
4504
|
*
|
|
4490
|
-
*
|
|
4505
|
+
* __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.
|
|
4491
4506
|
*
|
|
4492
|
-
*
|
|
4507
|
+
* __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)).
|
|
4493
4508
|
*
|
|
4494
|
-
*
|
|
4509
|
+
* __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.
|
|
4495
4510
|
*
|
|
4496
4511
|
* ## Related methods
|
|
4497
4512
|
*
|
|
@@ -4545,7 +4560,7 @@ interface CreateMultiServiceBookingOptions {
|
|
|
4545
4560
|
/**
|
|
4546
4561
|
* Multi-service booking type.
|
|
4547
4562
|
*
|
|
4548
|
-
* Currently only `SEQUENTIAL_BOOKINGS` is supported
|
|
4563
|
+
* Currently only `SEQUENTIAL_BOOKINGS` is supported.
|
|
4549
4564
|
*/
|
|
4550
4565
|
multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
|
|
4551
4566
|
}
|
|
@@ -4555,7 +4570,7 @@ interface CreateMultiServiceBookingOptions {
|
|
|
4555
4570
|
*
|
|
4556
4571
|
* 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.
|
|
4557
4572
|
*
|
|
4558
|
-
* This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each booking you're rescheduling to prevent conflicting changes.
|
|
4573
|
+
* 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.
|
|
4559
4574
|
*
|
|
4560
4575
|
* 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.
|
|
4561
4576
|
* @param multiServiceBookingId - ID of the multi-service booking to reschedule.
|
|
@@ -4596,14 +4611,11 @@ interface RescheduleMultiServiceBookingOptions {
|
|
|
4596
4611
|
* - 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)).
|
|
4597
4612
|
* - 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)).
|
|
4598
4613
|
*
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* Check if an existing multi-service booking is still valid after business configuration changes. For example, staff changes, policy updates, or capacity modifications.
|
|
4602
|
-
*
|
|
4603
|
-
* ## When to call List Multi Service Availability Time Slots instead
|
|
4614
|
+
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
4615
|
+
* For example, staff changes, policy updates, or capacity modifications.
|
|
4604
4616
|
*
|
|
4605
4617
|
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
4606
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/
|
|
4618
|
+
* ([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.
|
|
4607
4619
|
* @param multiServiceBookingId - ID of the multi-service booking to retrieve.
|
|
4608
4620
|
* @public
|
|
4609
4621
|
* @documentationMaturity preview
|
|
@@ -4617,7 +4629,7 @@ declare function getMultiServiceBookingAvailability(multiServiceBookingId: strin
|
|
|
4617
4629
|
__applicationErrorsType?: GetMultiServiceBookingAvailabilityApplicationErrors;
|
|
4618
4630
|
}>;
|
|
4619
4631
|
/**
|
|
4620
|
-
* Cancels a multi-service booking and all its single-service bookings.
|
|
4632
|
+
* Cancels a multi-service booking and all its associated single-service bookings.
|
|
4621
4633
|
*
|
|
4622
4634
|
*
|
|
4623
4635
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
@@ -4657,8 +4669,8 @@ interface CancelMultiServiceBookingOptions {
|
|
|
4657
4669
|
*
|
|
4658
4670
|
* ## Status requirements
|
|
4659
4671
|
*
|
|
4660
|
-
* -
|
|
4661
|
-
* -
|
|
4672
|
+
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
4673
|
+
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
4662
4674
|
*
|
|
4663
4675
|
* ## Checkout restrictions
|
|
4664
4676
|
*
|
|
@@ -4667,9 +4679,9 @@ interface CancelMultiServiceBookingOptions {
|
|
|
4667
4679
|
*
|
|
4668
4680
|
* ## Additional updates
|
|
4669
4681
|
*
|
|
4670
|
-
* -
|
|
4671
|
-
* -
|
|
4672
|
-
* -
|
|
4682
|
+
* - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
|
|
4683
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
4684
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
4673
4685
|
*
|
|
4674
4686
|
* 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.
|
|
4675
4687
|
* @param multiServiceBookingId - ID of the multi-service booking to mark as `PENDING`.
|
|
@@ -4699,7 +4711,11 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
4699
4711
|
sendSmsReminder?: boolean | null;
|
|
4700
4712
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
4701
4713
|
doubleBooked?: boolean | null;
|
|
4702
|
-
/**
|
|
4714
|
+
/**
|
|
4715
|
+
* Whether to return the single-service bookings that were marked as `PENDING`.
|
|
4716
|
+
*
|
|
4717
|
+
* Default: `false`
|
|
4718
|
+
*/
|
|
4703
4719
|
returnFullEntity?: boolean;
|
|
4704
4720
|
/**
|
|
4705
4721
|
* Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
|
|
@@ -4715,8 +4731,8 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
4715
4731
|
*
|
|
4716
4732
|
* ## Status requirements
|
|
4717
4733
|
*
|
|
4718
|
-
* -
|
|
4719
|
-
* -
|
|
4734
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
4735
|
+
* - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
|
|
4720
4736
|
*
|
|
4721
4737
|
* ## Checkout restrictions
|
|
4722
4738
|
*
|
|
@@ -4725,9 +4741,9 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
4725
4741
|
*
|
|
4726
4742
|
* ## Additional updates
|
|
4727
4743
|
*
|
|
4728
|
-
* -
|
|
4729
|
-
* -
|
|
4730
|
-
* -
|
|
4744
|
+
* - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
|
|
4745
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
4746
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
4731
4747
|
*
|
|
4732
4748
|
* 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.
|
|
4733
4749
|
* @param multiServiceBookingId - ID of the multi-service booking to confirm its related bookings.
|
|
@@ -4773,8 +4789,8 @@ interface ConfirmMultiServiceBookingOptions {
|
|
|
4773
4789
|
*
|
|
4774
4790
|
* ## Status requirements
|
|
4775
4791
|
*
|
|
4776
|
-
* -
|
|
4777
|
-
* -
|
|
4792
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
4793
|
+
* - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
|
|
4778
4794
|
*
|
|
4779
4795
|
* ## Checkout restrictions
|
|
4780
4796
|
*
|
|
@@ -4783,9 +4799,9 @@ interface ConfirmMultiServiceBookingOptions {
|
|
|
4783
4799
|
*
|
|
4784
4800
|
* ## Additional updates
|
|
4785
4801
|
*
|
|
4786
|
-
* -
|
|
4787
|
-
* -
|
|
4788
|
-
* -
|
|
4802
|
+
* - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
|
|
4803
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
4804
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
4789
4805
|
*
|
|
4790
4806
|
* 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.
|
|
4791
4807
|
* @param multiServiceBookingId - ID of the multi-service booking to decline.
|
|
@@ -4824,13 +4840,13 @@ interface DeclineMultiServiceBookingOptions {
|
|
|
4824
4840
|
* - `cancel`: Whether the customer can cancel the multi-service booking.
|
|
4825
4841
|
* - `reschedule`: Whether the customer can adjust the multi-service booking's timing.
|
|
4826
4842
|
*
|
|
4827
|
-
*
|
|
4843
|
+
* Bear the following considerations in mind when calling this method:
|
|
4828
4844
|
*
|
|
4829
|
-
*
|
|
4845
|
+
* __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.
|
|
4830
4846
|
*
|
|
4831
|
-
*
|
|
4847
|
+
* __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.
|
|
4832
4848
|
*
|
|
4833
|
-
*
|
|
4849
|
+
* __Status dependencies__: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
|
|
4834
4850
|
* Bookings can skip `PENDING` and move directly from `CREATED` to `CONFIRMED`/`DECLINED` based on service configuration.
|
|
4835
4851
|
* @param multiServiceBookingIds - IDs of the multi-service bookings to retrieve allowed actions for.
|
|
4836
4852
|
* @public
|
|
@@ -4846,12 +4862,12 @@ declare function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds
|
|
|
4846
4862
|
* Retrieves a multi-service booking and all its associated single-service bookings.
|
|
4847
4863
|
*
|
|
4848
4864
|
*
|
|
4849
|
-
* Returns the complete multi-service booking information including its ID,
|
|
4865
|
+
* Returns the complete multi-service booking information including its ID, associated single-service bookings, and the total number of scheduled single-service bookings.
|
|
4850
4866
|
*
|
|
4851
|
-
* If you call
|
|
4867
|
+
* 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.
|
|
4852
4868
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
4853
4869
|
*
|
|
4854
|
-
* See Query Extended Bookings ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings
|
|
4870
|
+
* 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.
|
|
4855
4871
|
* @param multiServiceBookingId - ID of the multi-service booking.
|
|
4856
4872
|
* @public
|
|
4857
4873
|
* @documentationMaturity preview
|
|
@@ -4879,10 +4895,10 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
|
|
|
4879
4895
|
*
|
|
4880
4896
|
* ## Requirements and limitations
|
|
4881
4897
|
*
|
|
4882
|
-
* -
|
|
4883
|
-
* -
|
|
4884
|
-
* -
|
|
4885
|
-
* -
|
|
4898
|
+
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
4899
|
+
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
4900
|
+
* - __Status compatibility__: Added bookings must have compatible status with the target multi-service booking.
|
|
4901
|
+
* - __Revision control__: You must provide current revision numbers for all single-service bookings to add.
|
|
4886
4902
|
* @param multiServiceBookingId - ID of the multi-service booking.
|
|
4887
4903
|
* @public
|
|
4888
4904
|
* @documentationMaturity preview
|
|
@@ -4904,7 +4920,11 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
4904
4920
|
* @maxSize 8
|
|
4905
4921
|
*/
|
|
4906
4922
|
bookings: BookingIdAndRevision[];
|
|
4907
|
-
/**
|
|
4923
|
+
/**
|
|
4924
|
+
* Whether to return the single-service bookings that were added to the multi-service booking.
|
|
4925
|
+
*
|
|
4926
|
+
* Default: `false`
|
|
4927
|
+
*/
|
|
4908
4928
|
returnFullEntity?: boolean;
|
|
4909
4929
|
}
|
|
4910
4930
|
/**
|
|
@@ -4913,21 +4933,21 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
4913
4933
|
*
|
|
4914
4934
|
* ## Removal options
|
|
4915
4935
|
*
|
|
4916
|
-
*
|
|
4936
|
+
* __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.
|
|
4917
4937
|
*
|
|
4918
|
-
*
|
|
4938
|
+
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
4919
4939
|
*
|
|
4920
|
-
*
|
|
4940
|
+
* __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.
|
|
4921
4941
|
*
|
|
4922
4942
|
* ## Removal behavior
|
|
4923
4943
|
*
|
|
4924
|
-
*
|
|
4944
|
+
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
4925
4945
|
* You can manage them using single-service booking methods.
|
|
4926
4946
|
*
|
|
4927
|
-
*
|
|
4947
|
+
* __Automatic cleanup__: Multi-service bookings must contain at least 2 services.
|
|
4928
4948
|
* 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.
|
|
4929
4949
|
*
|
|
4930
|
-
*
|
|
4950
|
+
* __Revision control__: Specify current revision numbers to prevent conflicting modifications during the removal process.
|
|
4931
4951
|
* @param multiServiceBookingId - ID of the multi-service booking.
|
|
4932
4952
|
* @public
|
|
4933
4953
|
* @documentationMaturity preview
|
|
@@ -4947,7 +4967,11 @@ interface RemoveBookingsFromMultiServiceBookingOptions {
|
|
|
4947
4967
|
* @maxSize 8
|
|
4948
4968
|
*/
|
|
4949
4969
|
bookings?: BookingIdAndRevision[];
|
|
4950
|
-
/**
|
|
4970
|
+
/**
|
|
4971
|
+
* Whether to return the single-service bookings.
|
|
4972
|
+
*
|
|
4973
|
+
* Default: `false`
|
|
4974
|
+
*/
|
|
4951
4975
|
returnFullEntity?: boolean;
|
|
4952
4976
|
}
|
|
4953
4977
|
|