@wix/auto_sdk_bookings_bookings 1.0.82 → 1.0.84
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +49 -65
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +97 -124
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +47 -57
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +49 -65
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +97 -124
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +47 -57
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +49 -65
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +97 -124
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +47 -57
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +49 -65
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +97 -124
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +47 -57
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -12,11 +12,9 @@ interface ConfirmOrDeclineBookingSignature {
|
|
|
12
12
|
* ### eCommerce checkout restriction
|
|
13
13
|
*
|
|
14
14
|
* Call this method only when using a custom checkout page. Don't
|
|
15
|
-
* call it when using a
|
|
16
|
-
* ([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)).
|
|
15
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
17
16
|
* In such cases, Wix automatically updates the booking status based on
|
|
18
|
-
* the `paymentStatus` of the corresponding
|
|
19
|
-
* ([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)).
|
|
17
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
20
18
|
*
|
|
21
19
|
* ### New booking status
|
|
22
20
|
*
|
|
@@ -57,8 +55,7 @@ interface BulkConfirmOrDeclineBookingSignature {
|
|
|
57
55
|
* Confirms or declines up to 300 bookings.
|
|
58
56
|
*
|
|
59
57
|
*
|
|
60
|
-
* See
|
|
61
|
-
* ([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))
|
|
58
|
+
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
62
59
|
* for details about when a booking is confirmed or declined.
|
|
63
60
|
* @param - Bookings to confirm or decline.
|
|
64
61
|
*/
|
|
@@ -74,23 +71,19 @@ interface CreateBookingSignature {
|
|
|
74
71
|
*
|
|
75
72
|
* ### Appointment booking
|
|
76
73
|
*
|
|
77
|
-
* For appointment-based services, specify the relevant
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
* in your call's request to avoid failed calls due to unavailability.
|
|
74
|
+
* For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
|
|
75
|
+
*
|
|
76
|
+
* We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
|
|
77
|
+
* Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
|
|
82
78
|
*
|
|
83
79
|
* ### Class session booking
|
|
84
80
|
*
|
|
85
|
-
* For class services, specify the relevant event ID
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* `
|
|
91
|
-
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
92
|
-
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
93
|
-
* values are overridden.
|
|
81
|
+
* For class services, specify the relevant event ID as `bookedEntity.slot.eventId`.
|
|
82
|
+
*
|
|
83
|
+
* We recommend following the [class session booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-a-class-session) using Time Slots V2.
|
|
84
|
+
* Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
|
|
85
|
+
*
|
|
86
|
+
* When you specify `eventId`, Wix Bookings automatically derives `startDate`, `endDate`, `timezone`, `resource`, and `location` based on the event details. Manually specified values are ignored.
|
|
94
87
|
*
|
|
95
88
|
* ### Course booking
|
|
96
89
|
*
|
|
@@ -115,8 +108,7 @@ interface CreateBookingSignature {
|
|
|
115
108
|
*
|
|
116
109
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
117
110
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
118
|
-
*
|
|
119
|
-
* ([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)).
|
|
111
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
120
112
|
*
|
|
121
113
|
* ### Notify customers
|
|
122
114
|
*
|
|
@@ -135,9 +127,9 @@ interface CreateBookingSignature {
|
|
|
135
127
|
*
|
|
136
128
|
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
137
129
|
*
|
|
138
|
-
* For customers paying with a Wix eCommerce checkout
|
|
130
|
+
* 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).
|
|
139
131
|
*
|
|
140
|
-
* For customers using a custom checkout, call Confirm or Decline Booking
|
|
132
|
+
* 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.
|
|
141
133
|
*
|
|
142
134
|
* ### Booking form data
|
|
143
135
|
*
|
|
@@ -148,6 +140,8 @@ interface CreateBookingSignature {
|
|
|
148
140
|
* don't match, Create Booking fails. Therefore, we recommend specifying
|
|
149
141
|
* only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
150
142
|
*
|
|
143
|
+
* You can follow [this sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration#create-a-booking-with-a-filled-out-booking-form) to create bookings with booking form submissions.
|
|
144
|
+
*
|
|
151
145
|
* ### Admin overwrites
|
|
152
146
|
*
|
|
153
147
|
* There are small but important differences when you specify special
|
|
@@ -186,8 +180,7 @@ interface BulkCreateBookingSignature {
|
|
|
186
180
|
* Creates up to 8 bookings.
|
|
187
181
|
*
|
|
188
182
|
*
|
|
189
|
-
* See Create Booking
|
|
190
|
-
* ([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))
|
|
183
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
191
184
|
* for more information.
|
|
192
185
|
*
|
|
193
186
|
* If any of the specified bookings is missing a required field the entire call
|
|
@@ -218,16 +211,14 @@ interface RescheduleBookingSignature {
|
|
|
218
211
|
* ### Appointment sessions
|
|
219
212
|
*
|
|
220
213
|
* For appointments, the old session is removed from the business calendar
|
|
221
|
-
* while a new session is added. We recommend calling Query Availability
|
|
222
|
-
* ([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))
|
|
214
|
+
* 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)
|
|
223
215
|
* first and specifying the entire retrieved `slot`.
|
|
224
216
|
*
|
|
225
217
|
* ### Class sessions
|
|
226
218
|
*
|
|
227
219
|
* For classes, the new session must be an existing session belonging to the
|
|
228
220
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
229
|
-
* from Query Availability
|
|
230
|
-
* ([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))
|
|
221
|
+
* from [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
231
222
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
232
223
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
233
224
|
*
|
|
@@ -282,16 +273,14 @@ interface ConfirmBookingSignature {
|
|
|
282
273
|
* ### eCommerce checkout restriction
|
|
283
274
|
*
|
|
284
275
|
* Call this method only when using a custom checkout page. Don't
|
|
285
|
-
* call it when using a Wix eCommerce checkout
|
|
286
|
-
* ([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)).
|
|
276
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
287
277
|
* In such cases, Wix automatically updates the booking status based on
|
|
288
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
289
|
-
* ([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)).
|
|
278
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
290
279
|
*
|
|
291
280
|
* ### When to call Confirm Or Decline Booking instead
|
|
292
281
|
*
|
|
293
282
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
294
|
-
* For these checks, call Confirm or Decline Booking
|
|
283
|
+
* 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.
|
|
295
284
|
*
|
|
296
285
|
* ### Original status validation
|
|
297
286
|
*
|
|
@@ -377,17 +366,14 @@ interface DeclineBookingSignature {
|
|
|
377
366
|
* ### eCommerce checkout restriction
|
|
378
367
|
*
|
|
379
368
|
* Call this method only when using a custom checkout page. Don't
|
|
380
|
-
* call it when using a Wix eCommerce checkout
|
|
381
|
-
* ([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)).
|
|
369
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
382
370
|
* In such cases, Wix automatically updates the booking status based on
|
|
383
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
384
|
-
* ([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)).
|
|
371
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
385
372
|
*
|
|
386
373
|
* ### When to call Confirm Or Decline Booking instead
|
|
387
374
|
*
|
|
388
375
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
389
|
-
* these checks you can call Confirm or Decline Booking
|
|
390
|
-
* ([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)).
|
|
376
|
+
* 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).
|
|
391
377
|
*
|
|
392
378
|
* ### Original status validation
|
|
393
379
|
*
|
|
@@ -485,8 +471,7 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
485
471
|
*
|
|
486
472
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
487
473
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
488
|
-
* supported service options and variants
|
|
489
|
-
* ([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)).
|
|
474
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
490
475
|
* @param - ID of the booking to update the number of participants for.
|
|
491
476
|
*/
|
|
492
477
|
(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> & {
|
|
@@ -501,7 +486,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
501
486
|
*
|
|
502
487
|
* ### Service requirement
|
|
503
488
|
*
|
|
504
|
-
* By default, this method only works for
|
|
489
|
+
* 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`.
|
|
505
490
|
* 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.
|
|
506
491
|
*
|
|
507
492
|
* ### Status requirements
|
|
@@ -511,15 +496,15 @@ interface MarkBookingAsPendingSignature {
|
|
|
511
496
|
*
|
|
512
497
|
* ### Checkout restrictions
|
|
513
498
|
*
|
|
514
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts
|
|
499
|
+
* 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.
|
|
515
500
|
*
|
|
516
501
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
517
502
|
*
|
|
518
503
|
* ### Business workflow
|
|
519
504
|
*
|
|
520
505
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
521
|
-
* - Confirm Booking
|
|
522
|
-
* - Decline Booking
|
|
506
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
507
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
523
508
|
*
|
|
524
509
|
* ### Resource availability and scheduling
|
|
525
510
|
*
|
|
@@ -527,7 +512,7 @@ interface MarkBookingAsPendingSignature {
|
|
|
527
512
|
*
|
|
528
513
|
* - **Calendar impact**: The booking appears on the business calendar.
|
|
529
514
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
530
|
-
* - **Resource assignment**: Available
|
|
515
|
+
* - **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.
|
|
531
516
|
*
|
|
532
517
|
* ### Double bookings
|
|
533
518
|
*
|
|
@@ -575,7 +560,7 @@ interface CreateMultiServiceBookingSignature {
|
|
|
575
560
|
*
|
|
576
561
|
* ### When to call this method
|
|
577
562
|
*
|
|
578
|
-
* 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
|
|
563
|
+
* 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.
|
|
579
564
|
*
|
|
580
565
|
* ### Requirements and behavior
|
|
581
566
|
*
|
|
@@ -583,15 +568,15 @@ interface CreateMultiServiceBookingSignature {
|
|
|
583
568
|
*
|
|
584
569
|
* __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.
|
|
585
570
|
*
|
|
586
|
-
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order
|
|
571
|
+
* __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).
|
|
587
572
|
*
|
|
588
573
|
* __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.
|
|
589
574
|
*
|
|
590
575
|
* ### Related methods
|
|
591
576
|
*
|
|
592
|
-
* Verify availability first with List Multi Service Availability Time Slots
|
|
577
|
+
* 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).
|
|
593
578
|
*
|
|
594
|
-
* See Create Booking
|
|
579
|
+
* 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.
|
|
595
580
|
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
596
581
|
*
|
|
597
582
|
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
@@ -613,7 +598,7 @@ interface RescheduleMultiServiceBookingSignature {
|
|
|
613
598
|
*
|
|
614
599
|
* 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.
|
|
615
600
|
*
|
|
616
|
-
* See Reschedule Booking
|
|
601
|
+
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
617
602
|
* @param - ID of the multi-service booking to reschedule.
|
|
618
603
|
* @param - Information about the single-service bookings to reschedule.
|
|
619
604
|
*/
|
|
@@ -628,14 +613,13 @@ interface GetMultiServiceBookingAvailabilitySignature {
|
|
|
628
613
|
*
|
|
629
614
|
*
|
|
630
615
|
* Wix Bookings considers:
|
|
631
|
-
* - The relevant services' booking policies
|
|
632
|
-
* - The availability of all required
|
|
616
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
617
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
633
618
|
*
|
|
634
619
|
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
635
620
|
* For example, staff changes, policy updates, or capacity modifications.
|
|
636
621
|
*
|
|
637
|
-
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
638
|
-
* ([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.
|
|
622
|
+
* 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.
|
|
639
623
|
* @param - ID of the multi-service booking to retrieve.
|
|
640
624
|
*/
|
|
641
625
|
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`, 2> & {
|
|
@@ -651,7 +635,7 @@ interface CancelMultiServiceBookingSignature {
|
|
|
651
635
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
652
636
|
* The call fails if all single-service bookings are already canceled or declined.
|
|
653
637
|
*
|
|
654
|
-
* See Cancel Booking
|
|
638
|
+
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
655
639
|
* @param - ID of the multi-service booking to cancel.
|
|
656
640
|
*/
|
|
657
641
|
(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> & {
|
|
@@ -682,7 +666,7 @@ interface MarkMultiServiceBookingAsPendingSignature {
|
|
|
682
666
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
683
667
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
684
668
|
*
|
|
685
|
-
* See Mark Booking as Pending
|
|
669
|
+
* 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.
|
|
686
670
|
* @param - ID of the multi-service booking to mark as `PENDING`.
|
|
687
671
|
*/
|
|
688
672
|
(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> & {
|
|
@@ -713,7 +697,7 @@ interface ConfirmMultiServiceBookingSignature {
|
|
|
713
697
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
714
698
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
715
699
|
*
|
|
716
|
-
* See Confirm Booking
|
|
700
|
+
* 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.
|
|
717
701
|
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
718
702
|
*/
|
|
719
703
|
(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> & {
|
|
@@ -744,7 +728,7 @@ interface DeclineMultiServiceBookingSignature {
|
|
|
744
728
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
745
729
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
746
730
|
*
|
|
747
|
-
* Refer to Decline Booking
|
|
731
|
+
* 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.
|
|
748
732
|
* @param - ID of the multi-service booking to decline.
|
|
749
733
|
*/
|
|
750
734
|
(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> & {
|
|
@@ -763,7 +747,7 @@ interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
|
763
747
|
*
|
|
764
748
|
* Bear the following considerations in mind when calling this method:
|
|
765
749
|
*
|
|
766
|
-
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies
|
|
750
|
+
* __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.
|
|
767
751
|
*
|
|
768
752
|
* __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.
|
|
769
753
|
*
|
|
@@ -784,7 +768,7 @@ interface GetMultiServiceBookingSignature {
|
|
|
784
768
|
* 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.
|
|
785
769
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
786
770
|
*
|
|
787
|
-
* See Query Extended Bookings
|
|
771
|
+
* 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.
|
|
788
772
|
* @param - ID of the multi-service booking.
|
|
789
773
|
* @returns Retrieved multi-service booking.
|
|
790
774
|
*/
|
|
@@ -799,7 +783,7 @@ interface AddBookingsToMultiServiceBookingSignature {
|
|
|
799
783
|
* ### When to call this method
|
|
800
784
|
*
|
|
801
785
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
802
|
-
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking
|
|
786
|
+
* 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.
|
|
803
787
|
*
|
|
804
788
|
* ### Package integration
|
|
805
789
|
*
|
|
@@ -829,7 +813,7 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
|
829
813
|
*
|
|
830
814
|
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
831
815
|
*
|
|
832
|
-
* __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
|
|
816
|
+
* __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.
|
|
833
817
|
*
|
|
834
818
|
* ### Removal behavior
|
|
835
819
|
*
|