@wix/auto_sdk_bookings_bookings 1.0.56 → 1.0.58
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 +65 -65
- package/build/cjs/index.js +6 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +77 -74
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +19 -16
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +65 -65
- package/build/es/index.mjs +6 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +77 -74
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +19 -16
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +65 -65
- package/build/internal/cjs/index.js +6 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +77 -74
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +19 -16
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +65 -65
- package/build/internal/es/index.mjs +6 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +77 -74
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +19 -16
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -72,7 +72,7 @@ interface CreateBookingSignature {
|
|
|
72
72
|
* Creates a booking.
|
|
73
73
|
*
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
* ### Appointment booking
|
|
76
76
|
*
|
|
77
77
|
* For appointment-based services, specify the relevant `slot` in
|
|
78
78
|
* `bookedEntity.slot`. We recommend specifying the complete
|
|
@@ -80,7 +80,7 @@ interface CreateBookingSignature {
|
|
|
80
80
|
* ([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))
|
|
81
81
|
* in your call's request to avoid failed calls due to unavailability.
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
* ### Class session booking
|
|
84
84
|
*
|
|
85
85
|
* For class services, specify the relevant event ID
|
|
86
86
|
* ([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,27 +92,27 @@ interface CreateBookingSignature {
|
|
|
92
92
|
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
93
93
|
* values are overridden.
|
|
94
94
|
*
|
|
95
|
-
*
|
|
95
|
+
* ### Course booking
|
|
96
96
|
*
|
|
97
97
|
* For course services, specify the course's schedule ID in `bookedEntity.schedule.scheduleId`.
|
|
98
98
|
* We recommend following [this sample flow](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course)
|
|
99
99
|
* to minimize failed calls due to unavailability.
|
|
100
100
|
*
|
|
101
|
-
*
|
|
101
|
+
* ### Related resources
|
|
102
102
|
*
|
|
103
103
|
* Specifying a `resource` triggers an availability check, resulting in a failed
|
|
104
104
|
* call if the resource is unavailable. Omitting a resource allows Wix Bookings
|
|
105
105
|
* to assign a resource belonging to the relevant type randomly when the merchant
|
|
106
106
|
* confirms the booking.
|
|
107
107
|
*
|
|
108
|
-
*
|
|
108
|
+
* ### Participant information
|
|
109
109
|
*
|
|
110
110
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
111
111
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
112
112
|
* _service options and variants_
|
|
113
113
|
* ([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)).
|
|
114
114
|
*
|
|
115
|
-
*
|
|
115
|
+
* ### Notify customers
|
|
116
116
|
*
|
|
117
117
|
* You can specify a `participantNotification.message` for the customer that's send
|
|
118
118
|
* immediately. Ensure `participantNotification.notifyParticipants` is set to `true`
|
|
@@ -121,19 +121,19 @@ interface CreateBookingSignature {
|
|
|
121
121
|
* If you specify `{"sendSmsReminder": true}`, the customer receives an SMS 24 hours
|
|
122
122
|
* before the session starts. The phone number is taken from `contactDetails.phone`.
|
|
123
123
|
*
|
|
124
|
-
*
|
|
124
|
+
* ### Booking status
|
|
125
125
|
*
|
|
126
126
|
* Bookings default to the `CREATED` status, not affecting the business calendar
|
|
127
127
|
* or resource availability. You can specify a different status when the calling
|
|
128
128
|
* [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)
|
|
129
129
|
* has `Manage Bookings` permissions.
|
|
130
130
|
*
|
|
131
|
-
*
|
|
131
|
+
* ### Payment options
|
|
132
132
|
*
|
|
133
133
|
* The specified `selectedPaymentOption` indicates how the customer intends to
|
|
134
134
|
* pay, allowing for later changes to a different method supported by the service.
|
|
135
135
|
*
|
|
136
|
-
*
|
|
136
|
+
* ### Payment status
|
|
137
137
|
*
|
|
138
138
|
* A booking is initially created with `{"paymentStatus": "UNDEFINED"}` regardless
|
|
139
139
|
* of the payment status specified in Create Booking. If a customer uses an
|
|
@@ -148,7 +148,7 @@ interface CreateBookingSignature {
|
|
|
148
148
|
* payment status with Confirm Or Decline Booking
|
|
149
149
|
* ([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)).
|
|
150
150
|
*
|
|
151
|
-
*
|
|
151
|
+
* ### Booking form data
|
|
152
152
|
*
|
|
153
153
|
* When customers sign up for a service, they must fill out the booking form.
|
|
154
154
|
* To create a booking with a completed booking form, specify the relevant data in
|
|
@@ -157,7 +157,7 @@ interface CreateBookingSignature {
|
|
|
157
157
|
* don't match, Create Booking fails. Therefore, we recommend specifying
|
|
158
158
|
* only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
159
159
|
*
|
|
160
|
-
*
|
|
160
|
+
* ### Admin overwrites
|
|
161
161
|
*
|
|
162
162
|
* There are small but important differences when you specify special
|
|
163
163
|
* `flowControlSettings`:
|
|
@@ -220,18 +220,18 @@ interface RescheduleBookingSignature {
|
|
|
220
220
|
* a different session.
|
|
221
221
|
*
|
|
222
222
|
*
|
|
223
|
-
*
|
|
223
|
+
* ### Course booking limitation
|
|
224
224
|
*
|
|
225
225
|
* You can't reschedule course bookings.
|
|
226
226
|
*
|
|
227
|
-
*
|
|
227
|
+
* ### Appointment sessions
|
|
228
228
|
*
|
|
229
229
|
* For appointments, the old session is removed from the business calendar
|
|
230
230
|
* while a new session is added. We recommend calling Query Availability
|
|
231
231
|
* ([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))
|
|
232
232
|
* first and specifying the entire retrieved `slot`.
|
|
233
233
|
*
|
|
234
|
-
*
|
|
234
|
+
* ### Class sessions
|
|
235
235
|
*
|
|
236
236
|
* For classes, the new session must be an existing session belonging to the
|
|
237
237
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
@@ -240,13 +240,13 @@ interface RescheduleBookingSignature {
|
|
|
240
240
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
241
241
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
242
242
|
*
|
|
243
|
-
*
|
|
243
|
+
* ### Notify customers
|
|
244
244
|
*
|
|
245
245
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
246
246
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
247
247
|
* as `true`.
|
|
248
248
|
*
|
|
249
|
-
*
|
|
249
|
+
* ### Admin overwrites
|
|
250
250
|
*
|
|
251
251
|
* There are small but important differences when you specify special
|
|
252
252
|
* `flowControlSettings`:
|
|
@@ -288,7 +288,7 @@ interface ConfirmBookingSignature {
|
|
|
288
288
|
* Updates the booking status to `CONFIRMED` without checking whether the relevant slot or schedule is still available.
|
|
289
289
|
*
|
|
290
290
|
*
|
|
291
|
-
*
|
|
291
|
+
* ### eCommerce checkout restriction
|
|
292
292
|
*
|
|
293
293
|
* Call this method only when using a custom checkout page. Don't
|
|
294
294
|
* call it when using a Wix eCommerce checkout
|
|
@@ -297,17 +297,17 @@ interface ConfirmBookingSignature {
|
|
|
297
297
|
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
298
298
|
* ([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)).
|
|
299
299
|
*
|
|
300
|
-
*
|
|
300
|
+
* ### When to call Confirm Or Decline Booking instead
|
|
301
301
|
*
|
|
302
302
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
303
303
|
* 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.
|
|
304
304
|
*
|
|
305
|
-
*
|
|
305
|
+
* ### Original status validation
|
|
306
306
|
*
|
|
307
307
|
* You can only confirm bookings with a status of `PENDING`, `CREATED`, or
|
|
308
308
|
* `WAITING_LIST`.
|
|
309
309
|
*
|
|
310
|
-
*
|
|
310
|
+
* ### Double bookings
|
|
311
311
|
*
|
|
312
312
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
313
313
|
* You can specify
|
|
@@ -326,12 +326,12 @@ interface ConfirmBookingSignature {
|
|
|
326
326
|
* `{"checkAvailabilityValidation": false}`, the specified `doubleBooked` value
|
|
327
327
|
* is ignored.
|
|
328
328
|
*
|
|
329
|
-
*
|
|
329
|
+
* ### Payment status
|
|
330
330
|
*
|
|
331
331
|
* Also updates the booking's `paymentStatus`, if you specify a new payment
|
|
332
332
|
* status.
|
|
333
333
|
*
|
|
334
|
-
*
|
|
334
|
+
* ### Notify customers
|
|
335
335
|
*
|
|
336
336
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
337
337
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
@@ -383,7 +383,7 @@ interface DeclineBookingSignature {
|
|
|
383
383
|
* slot or schedule is still available.
|
|
384
384
|
*
|
|
385
385
|
*
|
|
386
|
-
*
|
|
386
|
+
* ### eCommerce checkout restriction
|
|
387
387
|
*
|
|
388
388
|
* Call this method only when using a custom checkout page. Don't
|
|
389
389
|
* call it when using a Wix eCommerce checkout
|
|
@@ -392,23 +392,23 @@ interface DeclineBookingSignature {
|
|
|
392
392
|
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
393
393
|
* ([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)).
|
|
394
394
|
*
|
|
395
|
-
*
|
|
395
|
+
* ### When to call Confirm Or Decline Booking instead
|
|
396
396
|
*
|
|
397
397
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
398
398
|
* these checks you can call Confirm or Decline Booking
|
|
399
399
|
* ([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)).
|
|
400
400
|
*
|
|
401
|
-
*
|
|
401
|
+
* ### Original status validation
|
|
402
402
|
*
|
|
403
403
|
* You can only decline bookings with a `status` of `PENDING`, `CREATED`, or
|
|
404
404
|
* `WAITING_LIST`.
|
|
405
405
|
*
|
|
406
|
-
*
|
|
406
|
+
* ### Payment status
|
|
407
407
|
*
|
|
408
408
|
* Also updates the booking's `paymentStatus`, if you specify a new payment
|
|
409
409
|
* status.
|
|
410
410
|
*
|
|
411
|
-
*
|
|
411
|
+
* ### Notify customers
|
|
412
412
|
*
|
|
413
413
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
414
414
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
@@ -430,24 +430,24 @@ interface CancelBookingSignature {
|
|
|
430
430
|
* Updates the booking status to `CANCELED`.
|
|
431
431
|
*
|
|
432
432
|
*
|
|
433
|
-
*
|
|
433
|
+
* ### Appointments
|
|
434
434
|
*
|
|
435
435
|
* For appointments, the corresponding event is removed from the Bookings
|
|
436
436
|
* calendar.
|
|
437
437
|
*
|
|
438
|
-
*
|
|
438
|
+
* ### Class and course bookings
|
|
439
439
|
*
|
|
440
440
|
* For class or course bookings, the relevant participants are removed
|
|
441
441
|
* from the class session or the course. However, the class session or course
|
|
442
442
|
* remain on the business calendar.
|
|
443
443
|
*
|
|
444
|
-
*
|
|
444
|
+
* ### Notify customers
|
|
445
445
|
*
|
|
446
446
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
447
447
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
448
448
|
* as `true`.
|
|
449
449
|
*
|
|
450
|
-
*
|
|
450
|
+
* ### Admin overwrites
|
|
451
451
|
*
|
|
452
452
|
* There are small but important differences when you specify special
|
|
453
453
|
* `flowControlSettings`:
|
|
@@ -486,11 +486,11 @@ interface UpdateNumberOfParticipantsSignature {
|
|
|
486
486
|
* the `totalNumberOfParticipants` for the relevant sessions.
|
|
487
487
|
*
|
|
488
488
|
*
|
|
489
|
-
*
|
|
489
|
+
* ### Appointment limitation
|
|
490
490
|
*
|
|
491
491
|
* You can't update the number of participants for appointment bookings.
|
|
492
492
|
*
|
|
493
|
-
*
|
|
493
|
+
* ### Participant information
|
|
494
494
|
*
|
|
495
495
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
496
496
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
@@ -508,29 +508,29 @@ interface MarkBookingAsPendingSignature {
|
|
|
508
508
|
* Updates the booking status to `PENDING`.
|
|
509
509
|
*
|
|
510
510
|
*
|
|
511
|
-
*
|
|
511
|
+
* ### Service requirement
|
|
512
512
|
*
|
|
513
513
|
* By default, this method only works for services ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
514
514
|
* 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.
|
|
515
515
|
*
|
|
516
|
-
*
|
|
516
|
+
* ### Status requirements
|
|
517
517
|
*
|
|
518
518
|
* - __Original status__: Booking must have `CREATED` status.
|
|
519
519
|
* - __Target status__: Booking moves to `PENDING`.
|
|
520
520
|
*
|
|
521
|
-
*
|
|
521
|
+
* ### Checkout restrictions
|
|
522
522
|
*
|
|
523
523
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](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.
|
|
524
524
|
*
|
|
525
525
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
526
526
|
*
|
|
527
|
-
*
|
|
527
|
+
* ### Business workflow
|
|
528
528
|
*
|
|
529
529
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
530
530
|
* - Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)).
|
|
531
531
|
* - Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)).
|
|
532
532
|
*
|
|
533
|
-
*
|
|
533
|
+
* ### Resource availability and scheduling
|
|
534
534
|
*
|
|
535
535
|
* Marking a booking as `PENDING` immediately affects resource availability:
|
|
536
536
|
*
|
|
@@ -538,16 +538,16 @@ interface MarkBookingAsPendingSignature {
|
|
|
538
538
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
539
539
|
* - **Resource assignment**: 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)) are automatically assigned if none were explicitly selected during booking creation.
|
|
540
540
|
*
|
|
541
|
-
*
|
|
541
|
+
* ### Double bookings
|
|
542
542
|
*
|
|
543
543
|
* By default, the method doesn't check for availability conflicts. To detect and handle double bookings, use the `checkAvailabilityValidation: true` admin overwrite.
|
|
544
544
|
*
|
|
545
|
-
*
|
|
545
|
+
* ### Notify customers
|
|
546
546
|
*
|
|
547
547
|
* You can specify a `participantNotification.message` for the customer.
|
|
548
548
|
* To send the message, you must also specify `participantNotification.notifyParticipants` as `true`.
|
|
549
549
|
*
|
|
550
|
-
*
|
|
550
|
+
* ### Admin overwrites
|
|
551
551
|
*
|
|
552
552
|
* There are small but important differences when you specify special
|
|
553
553
|
* `flowControlSettings`:
|
|
@@ -582,11 +582,11 @@ interface CreateMultiServiceBookingSignature {
|
|
|
582
582
|
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
583
583
|
*
|
|
584
584
|
*
|
|
585
|
-
*
|
|
585
|
+
* ### When to call this method
|
|
586
586
|
*
|
|
587
587
|
* 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.
|
|
588
588
|
*
|
|
589
|
-
*
|
|
589
|
+
* ### Requirements and behavior
|
|
590
590
|
*
|
|
591
591
|
* __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.
|
|
592
592
|
*
|
|
@@ -596,7 +596,7 @@ interface CreateMultiServiceBookingSignature {
|
|
|
596
596
|
*
|
|
597
597
|
* __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.
|
|
598
598
|
*
|
|
599
|
-
*
|
|
599
|
+
* ### Related methods
|
|
600
600
|
*
|
|
601
601
|
* Verify availability first with List Multi Service Availability Time Slots ([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)).
|
|
602
602
|
*
|
|
@@ -675,17 +675,17 @@ interface MarkMultiServiceBookingAsPendingSignature {
|
|
|
675
675
|
*
|
|
676
676
|
* Call this method for multi-service bookings requiring manual business approval before confirmation.
|
|
677
677
|
*
|
|
678
|
-
*
|
|
678
|
+
* ### Status requirements
|
|
679
679
|
*
|
|
680
680
|
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
681
681
|
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
682
682
|
*
|
|
683
|
-
*
|
|
683
|
+
* ### Checkout restrictions
|
|
684
684
|
*
|
|
685
685
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
686
686
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
687
687
|
*
|
|
688
|
-
*
|
|
688
|
+
* ### Additional updates
|
|
689
689
|
*
|
|
690
690
|
* - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
|
|
691
691
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -706,17 +706,17 @@ interface ConfirmMultiServiceBookingSignature {
|
|
|
706
706
|
*
|
|
707
707
|
* Call this method for multi-service bookings requiring manual business approval.
|
|
708
708
|
*
|
|
709
|
-
*
|
|
709
|
+
* ### Status requirements
|
|
710
710
|
*
|
|
711
711
|
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
712
712
|
* - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
|
|
713
713
|
*
|
|
714
|
-
*
|
|
714
|
+
* ### Checkout restrictions
|
|
715
715
|
*
|
|
716
716
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
717
717
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
718
718
|
*
|
|
719
|
-
*
|
|
719
|
+
* ### Additional updates
|
|
720
720
|
*
|
|
721
721
|
* - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
|
|
722
722
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -737,17 +737,17 @@ interface DeclineMultiServiceBookingSignature {
|
|
|
737
737
|
*
|
|
738
738
|
* Call this method to reject multi-service bookings that can't be accommodated or don't meet business requirements.
|
|
739
739
|
*
|
|
740
|
-
*
|
|
740
|
+
* ### Status requirements
|
|
741
741
|
*
|
|
742
742
|
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
743
743
|
* - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
|
|
744
744
|
*
|
|
745
|
-
*
|
|
745
|
+
* ### Checkout restrictions
|
|
746
746
|
*
|
|
747
747
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
748
748
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
749
749
|
*
|
|
750
|
-
*
|
|
750
|
+
* ### Additional updates
|
|
751
751
|
*
|
|
752
752
|
* - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
|
|
753
753
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -805,16 +805,16 @@ interface AddBookingsToMultiServiceBookingSignature {
|
|
|
805
805
|
* Expands an existing multi-service booking by adding existing single-service bookings to the package.
|
|
806
806
|
*
|
|
807
807
|
*
|
|
808
|
-
*
|
|
808
|
+
* ### When to call this method
|
|
809
809
|
*
|
|
810
810
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
811
811
|
* 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/create-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking)) instead.
|
|
812
812
|
*
|
|
813
|
-
*
|
|
813
|
+
* ### Package integration
|
|
814
814
|
*
|
|
815
815
|
* 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.
|
|
816
816
|
*
|
|
817
|
-
*
|
|
817
|
+
* ### Requirements and limitations
|
|
818
818
|
*
|
|
819
819
|
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
820
820
|
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
@@ -832,7 +832,7 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
|
832
832
|
* Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings.
|
|
833
833
|
*
|
|
834
834
|
*
|
|
835
|
-
*
|
|
835
|
+
* ### Removal options
|
|
836
836
|
*
|
|
837
837
|
* __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.
|
|
838
838
|
*
|
|
@@ -840,7 +840,7 @@ interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
|
840
840
|
*
|
|
841
841
|
* __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/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking)) before removing the unwanted bookings.
|
|
842
842
|
*
|
|
843
|
-
*
|
|
843
|
+
* ### Removal behavior
|
|
844
844
|
*
|
|
845
845
|
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
846
846
|
* You can manage them using single-service booking methods.
|
|
@@ -889,30 +889,30 @@ declare const removeBookingsFromMultiServiceBooking: MaybeContext<BuildRESTFunct
|
|
|
889
889
|
/**
|
|
890
890
|
* Triggered when a booking is canceled.
|
|
891
891
|
*/
|
|
892
|
-
declare const onBookingCanceled: BuildEventDefinition<typeof onBookingCanceled$1
|
|
892
|
+
declare const onBookingCanceled: BuildEventDefinition<typeof onBookingCanceled$1> & typeof onBookingCanceled$1;
|
|
893
893
|
/**
|
|
894
894
|
* Triggered when a booking is confirmed.
|
|
895
895
|
*/
|
|
896
|
-
declare const onBookingConfirmed: BuildEventDefinition<typeof onBookingConfirmed$1
|
|
896
|
+
declare const onBookingConfirmed: BuildEventDefinition<typeof onBookingConfirmed$1> & typeof onBookingConfirmed$1;
|
|
897
897
|
/**
|
|
898
898
|
* Triggered when a booking is created.
|
|
899
899
|
*/
|
|
900
|
-
declare const onBookingCreated: BuildEventDefinition<typeof onBookingCreated$1
|
|
900
|
+
declare const onBookingCreated: BuildEventDefinition<typeof onBookingCreated$1> & typeof onBookingCreated$1;
|
|
901
901
|
/**
|
|
902
902
|
* Triggered when a booking is declined.
|
|
903
903
|
*/
|
|
904
|
-
declare const onBookingDeclined: BuildEventDefinition<typeof onBookingDeclined$1
|
|
904
|
+
declare const onBookingDeclined: BuildEventDefinition<typeof onBookingDeclined$1> & typeof onBookingDeclined$1;
|
|
905
905
|
/**
|
|
906
906
|
* Triggered when the number of participants is updated.
|
|
907
907
|
*/
|
|
908
|
-
declare const onBookingNumberOfParticipantsUpdated: BuildEventDefinition<typeof onBookingNumberOfParticipantsUpdated$1
|
|
908
|
+
declare const onBookingNumberOfParticipantsUpdated: BuildEventDefinition<typeof onBookingNumberOfParticipantsUpdated$1> & typeof onBookingNumberOfParticipantsUpdated$1;
|
|
909
909
|
/**
|
|
910
910
|
* Triggered when a booking is rescheduled.
|
|
911
911
|
*/
|
|
912
|
-
declare const onBookingRescheduled: BuildEventDefinition<typeof onBookingRescheduled$1
|
|
912
|
+
declare const onBookingRescheduled: BuildEventDefinition<typeof onBookingRescheduled$1> & typeof onBookingRescheduled$1;
|
|
913
913
|
/**
|
|
914
914
|
* Triggered when a booked schedule is updated.
|
|
915
915
|
*/
|
|
916
|
-
declare const onBookingUpdated: BuildEventDefinition<typeof onBookingUpdated$1
|
|
916
|
+
declare const onBookingUpdated: BuildEventDefinition<typeof onBookingUpdated$1> & typeof onBookingUpdated$1;
|
|
917
917
|
|
|
918
918
|
export { AddBookingsToMultiServiceBookingApplicationErrors, AddBookingsToMultiServiceBookingOptions, AddBookingsToMultiServiceBookingResponse, Booking, BookingCanceledEnvelope, BookingConfirmedEnvelope, BookingCreatedEnvelope, BookingDeclinedEnvelope, BookingNumberOfParticipantsUpdatedEnvelope, BookingRescheduledEnvelope, BookingUpdatedEnvelope, BulkConfirmOrDeclineBookingApplicationErrors, BulkConfirmOrDeclineBookingOptions, BulkConfirmOrDeclineBookingRequestBookingDetails, BulkConfirmOrDeclineBookingResponse, BulkCreateBookingApplicationErrors, BulkCreateBookingOptions, BulkCreateBookingResponse, BulkGetMultiServiceBookingAllowedActionsResponse, CancelBookingApplicationErrors, CancelBookingOptions, CancelBookingResponse, CancelMultiServiceBookingApplicationErrors, CancelMultiServiceBookingOptions, CancelMultiServiceBookingResponse, ConfirmBookingApplicationErrors, ConfirmBookingOptions, ConfirmBookingResponse, ConfirmMultiServiceBookingApplicationErrors, ConfirmMultiServiceBookingOptions, ConfirmMultiServiceBookingResponse, ConfirmOrDeclineBookingApplicationErrors, ConfirmOrDeclineBookingOptions, ConfirmOrDeclineBookingResponse, CreateBookingApplicationErrors, CreateBookingInfo, CreateBookingOptions, CreateBookingResponse, CreateMultiServiceBookingApplicationErrors, CreateMultiServiceBookingOptions, CreateMultiServiceBookingResponse, DeclineBookingApplicationErrors, DeclineBookingOptions, DeclineBookingResponse, DeclineMultiServiceBookingApplicationErrors, DeclineMultiServiceBookingOptions, DeclineMultiServiceBookingResponse, GetMultiServiceBookingAvailabilityApplicationErrors, GetMultiServiceBookingAvailabilityResponse, MarkBookingAsPendingApplicationErrors, MarkBookingAsPendingOptions, MarkBookingAsPendingResponse, MarkMultiServiceBookingAsPendingApplicationErrors, MarkMultiServiceBookingAsPendingOptions, MarkMultiServiceBookingAsPendingResponse, MultiServiceBooking, RemoveBookingsFromMultiServiceBookingApplicationErrors, RemoveBookingsFromMultiServiceBookingOptions, RemoveBookingsFromMultiServiceBookingResponse, RescheduleBookingApplicationErrors, RescheduleBookingInfo, RescheduleBookingOptions, RescheduleBookingResponse, RescheduleMultiServiceBookingApplicationErrors, RescheduleMultiServiceBookingOptions, RescheduleMultiServiceBookingResponse, SetBookingSubmissionIdApplicationErrors, SetBookingSubmissionIdResponse, UpdateExtendedFieldsApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateNumberOfParticipantsApplicationErrors, UpdateNumberOfParticipantsOptions, UpdateNumberOfParticipantsResponse, V2Slot, addBookingsToMultiServiceBooking, bulkConfirmOrDeclineBooking, bulkCreateBooking, bulkGetMultiServiceBookingAllowedActions, cancelBooking, cancelMultiServiceBooking, confirmBooking, confirmMultiServiceBooking, confirmOrDeclineBooking, createBooking, createMultiServiceBooking, declineBooking, declineMultiServiceBooking, getMultiServiceBooking, getMultiServiceBookingAvailability, markBookingAsPending, markMultiServiceBookingAsPending, onBookingCanceled, onBookingConfirmed, onBookingCreated, onBookingDeclined, onBookingNumberOfParticipantsUpdated, onBookingRescheduled, onBookingUpdated, removeBookingsFromMultiServiceBooking, rescheduleBooking, rescheduleMultiServiceBooking, setBookingSubmissionId, updateExtendedFields, updateNumberOfParticipants };
|
package/build/cjs/index.js
CHANGED
|
@@ -2505,8 +2505,12 @@ var onBookingCanceled2 = (0, import_event_definition_modules.createEventModule)(
|
|
|
2505
2505
|
var onBookingConfirmed2 = (0, import_event_definition_modules.createEventModule)(onBookingConfirmed);
|
|
2506
2506
|
var onBookingCreated2 = (0, import_event_definition_modules.createEventModule)(onBookingCreated);
|
|
2507
2507
|
var onBookingDeclined2 = (0, import_event_definition_modules.createEventModule)(onBookingDeclined);
|
|
2508
|
-
var onBookingNumberOfParticipantsUpdated2 = (0, import_event_definition_modules.createEventModule)(
|
|
2509
|
-
|
|
2508
|
+
var onBookingNumberOfParticipantsUpdated2 = (0, import_event_definition_modules.createEventModule)(
|
|
2509
|
+
onBookingNumberOfParticipantsUpdated
|
|
2510
|
+
);
|
|
2511
|
+
var onBookingRescheduled2 = (0, import_event_definition_modules.createEventModule)(
|
|
2512
|
+
onBookingRescheduled
|
|
2513
|
+
);
|
|
2510
2514
|
var onBookingUpdated2 = (0, import_event_definition_modules.createEventModule)(onBookingUpdated);
|
|
2511
2515
|
// Annotate the CommonJS export names for ESM import in node:
|
|
2512
2516
|
0 && (module.exports = {
|