@wix/auto_sdk_bookings_pricing 1.0.53 → 1.0.55
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 +8 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +68 -76
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +60 -68
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +8 -8
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +68 -76
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +60 -68
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +8 -8
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +68 -76
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +60 -68
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +8 -8
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +68 -76
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +60 -68
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -2,20 +2,20 @@ import { PreviewPriceRequest as PreviewPriceRequest$1, PreviewPriceResponse as P
|
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface PriceInfo extends PriceInfoTotalPriceOneOf {
|
|
5
|
-
/** Calculated total price. Available if the service's
|
|
5
|
+
/** Calculated total price. Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `FIXED`, `VARIED`, or `NO_FEE`. */
|
|
6
6
|
calculatedPrice?: number;
|
|
7
7
|
/**
|
|
8
8
|
* Description of the total price.
|
|
9
|
-
* Available if the service's
|
|
9
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
10
10
|
* @deprecated Description of the total price.
|
|
11
|
-
* Available if the service's
|
|
11
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
12
12
|
* @replacedBy price_description_info.original
|
|
13
13
|
* @targetRemovalDate 2025-01-10
|
|
14
14
|
*/
|
|
15
15
|
priceDescription?: string;
|
|
16
16
|
/**
|
|
17
17
|
* Description of the total price.
|
|
18
|
-
* Available if the service's
|
|
18
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
19
19
|
*/
|
|
20
20
|
priceDescriptionInfo?: PriceDescriptionInfo;
|
|
21
21
|
/**
|
|
@@ -25,52 +25,52 @@ interface PriceInfo extends PriceInfoTotalPriceOneOf {
|
|
|
25
25
|
bookingLineItems?: BookingLineItem[];
|
|
26
26
|
/**
|
|
27
27
|
* Total deposit the customer must pay when booking the service.
|
|
28
|
-
* Available if the service's
|
|
28
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.options.deposit` is set to `true`.
|
|
29
29
|
*/
|
|
30
30
|
deposit?: number | null;
|
|
31
31
|
}
|
|
32
32
|
/** @oneof */
|
|
33
33
|
interface PriceInfoTotalPriceOneOf {
|
|
34
|
-
/** Calculated total price. Available if the service's
|
|
34
|
+
/** Calculated total price. Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `FIXED`, `VARIED`, or `NO_FEE`. */
|
|
35
35
|
calculatedPrice?: number;
|
|
36
36
|
/**
|
|
37
37
|
* Description of the total price.
|
|
38
|
-
* Available if the service's
|
|
38
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
39
39
|
* @deprecated Description of the total price.
|
|
40
|
-
* Available if the service's
|
|
40
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
41
41
|
* @replacedBy price_description_info.original
|
|
42
42
|
* @targetRemovalDate 2025-01-10
|
|
43
43
|
*/
|
|
44
44
|
priceDescription?: string;
|
|
45
45
|
/**
|
|
46
46
|
* Description of the total price.
|
|
47
|
-
* Available if the service's
|
|
47
|
+
* Available if the [service's](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) `payment.rateType` is `CUSTOM`.
|
|
48
48
|
*/
|
|
49
49
|
priceDescriptionInfo?: PriceDescriptionInfo;
|
|
50
50
|
}
|
|
51
51
|
interface BookingLineItem {
|
|
52
52
|
/**
|
|
53
|
-
* Service ID
|
|
53
|
+
* [Service ID](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction).
|
|
54
54
|
*
|
|
55
55
|
* Required parameter in:
|
|
56
|
-
* - Preview Price
|
|
57
|
-
* - Calculate Price
|
|
56
|
+
* - [Preview Price](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/preview-price) for all service types. All line items must have the same service ID.
|
|
57
|
+
* - [Calculate Price](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/calculate-price) when using Wix Bookings' default pricing logic. Optional in Calculate Price when using a Pricing Service Provider Plugin.
|
|
58
58
|
* @format GUID
|
|
59
59
|
*/
|
|
60
60
|
serviceId?: string | null;
|
|
61
61
|
/**
|
|
62
|
-
* Resource ID
|
|
62
|
+
* [Resource ID](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
63
63
|
*
|
|
64
64
|
* Required parameter in:
|
|
65
|
-
* - Calculate Price
|
|
66
|
-
* - Preview Price
|
|
65
|
+
* - [Calculate Price](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/calculate-price) for all service types ([service types](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
|
|
66
|
+
* - [Preview Price](https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/pricing-api/preview-price) for appointment-based services and classes. Optional in Preview Price for courses.
|
|
67
67
|
* @format GUID
|
|
68
68
|
*/
|
|
69
69
|
resourceId?: string | null;
|
|
70
70
|
/**
|
|
71
71
|
* Service choices selected by the customer when booking.
|
|
72
72
|
* Choices are specific values for service options that may affect pricing. For example, the option `ageGroup` may have choices like `child`, `student`, `adult`, and `senior`, each with different pricing.
|
|
73
|
-
* Refer to the Service Options and Variants API
|
|
73
|
+
* Refer to the [Service Options and Variants API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction) for more details.
|
|
74
74
|
*/
|
|
75
75
|
choices?: ServiceChoice[];
|
|
76
76
|
/**
|
|
@@ -149,7 +149,7 @@ interface PricingServiceChoices {
|
|
|
149
149
|
interface PriceDescriptionInfo {
|
|
150
150
|
/**
|
|
151
151
|
* Price description in the site's main language.
|
|
152
|
-
* Refer to the Site Properties API
|
|
152
|
+
* Refer to the [Site Properties API](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/introduction) for more details.
|
|
153
153
|
* @maxLength 50
|
|
154
154
|
*/
|
|
155
155
|
original?: string;
|
|
@@ -163,7 +163,7 @@ interface PriceDescriptionInfo {
|
|
|
163
163
|
interface PreviewPriceRequest {
|
|
164
164
|
/**
|
|
165
165
|
* Booking line items to preview pricing for.
|
|
166
|
-
* All line items must belong to the same service
|
|
166
|
+
* All line items must belong to the same [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction).
|
|
167
167
|
* @minSize 1
|
|
168
168
|
* @maxSize 20
|
|
169
169
|
*/
|
|
@@ -175,7 +175,7 @@ interface PreviewPriceResponse {
|
|
|
175
175
|
}
|
|
176
176
|
interface CalculatePriceRequest {
|
|
177
177
|
/**
|
|
178
|
-
* Existing booking
|
|
178
|
+
* Existing [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/introduction) to calculate the base price for.
|
|
179
179
|
* Must include `bookedEntity` details and participant information.
|
|
180
180
|
*/
|
|
181
181
|
booking: Booking;
|
|
@@ -184,14 +184,13 @@ interface CalculatePriceRequest {
|
|
|
184
184
|
interface Booking extends BookingParticipantsInfoOneOf {
|
|
185
185
|
/**
|
|
186
186
|
* Total number of participants.
|
|
187
|
-
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options
|
|
187
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
188
188
|
* @min 1
|
|
189
189
|
*/
|
|
190
190
|
totalParticipants?: number;
|
|
191
191
|
/**
|
|
192
192
|
* Information about the booked service choices and participant count for each choice.
|
|
193
|
-
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
194
|
-
* ([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)).
|
|
193
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
195
194
|
*
|
|
196
195
|
* For example, use this for a spa package booking that includes different service levels:
|
|
197
196
|
* - 2 participants chose "Standard Package".
|
|
@@ -222,8 +221,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
222
221
|
*/
|
|
223
222
|
bookedEntity?: BookedEntity;
|
|
224
223
|
/**
|
|
225
|
-
* Contact details of the site visitor or member
|
|
226
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction))
|
|
224
|
+
* Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction))
|
|
227
225
|
* making the booking.
|
|
228
226
|
*/
|
|
229
227
|
contactDetails?: ContactDetails;
|
|
@@ -249,8 +247,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
249
247
|
status?: BookingStatusWithLiterals;
|
|
250
248
|
/**
|
|
251
249
|
* The payment status of the booking. This field automatically syncs with the
|
|
252
|
-
* `paymentStatus` of the corresponding eCommerce order
|
|
253
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)| [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction))
|
|
250
|
+
* `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction)
|
|
254
251
|
* when customers use Wix eCommerce checkout.
|
|
255
252
|
*
|
|
256
253
|
* ### Integration patterns
|
|
@@ -258,17 +255,17 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
258
255
|
* __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
|
|
259
256
|
* Do not manually update this field.
|
|
260
257
|
*
|
|
261
|
-
* __When using custom payment flows__: You can manually update the payment status with Confirm Booking or Decline Booking
|
|
258
|
+
* __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.
|
|
262
259
|
*
|
|
263
|
-
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active pricing plan
|
|
260
|
+
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.
|
|
264
261
|
*
|
|
265
262
|
* All payment statuses are supported for every booking `status`.
|
|
266
263
|
*/
|
|
267
264
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
268
265
|
/**
|
|
269
|
-
* Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the service
|
|
266
|
+
* Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
270
267
|
*
|
|
271
|
-
* When undefined during an eCommerce checkout
|
|
268
|
+
* When undefined during an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), Wix Bookings uses the service's default payment option
|
|
272
269
|
*/
|
|
273
270
|
selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
|
|
274
271
|
/**
|
|
@@ -318,15 +315,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
318
315
|
*/
|
|
319
316
|
doubleBooked?: boolean | null;
|
|
320
317
|
/**
|
|
321
|
-
* ID of the form submission
|
|
322
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction))
|
|
318
|
+
* ID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction)
|
|
323
319
|
* associated with this booking.
|
|
324
320
|
* @format GUID
|
|
325
321
|
*/
|
|
326
322
|
formSubmissionId?: string | null;
|
|
327
323
|
/**
|
|
328
|
-
* ID of the form
|
|
329
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object))
|
|
324
|
+
* ID of the [form](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)
|
|
330
325
|
* associated with this booking. The value depends on how the
|
|
331
326
|
* booking was created:
|
|
332
327
|
* - For bookings created with Create Booking or Bulk Create Booking, `formId`
|
|
@@ -343,14 +338,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
343
338
|
interface BookingParticipantsInfoOneOf {
|
|
344
339
|
/**
|
|
345
340
|
* Total number of participants.
|
|
346
|
-
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options
|
|
341
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
347
342
|
* @min 1
|
|
348
343
|
*/
|
|
349
344
|
totalParticipants?: number;
|
|
350
345
|
/**
|
|
351
346
|
* Information about the booked service choices and participant count for each choice.
|
|
352
|
-
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
353
|
-
* ([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)).
|
|
347
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
354
348
|
*
|
|
355
349
|
* For example, use this for a spa package booking that includes different service levels:
|
|
356
350
|
* - 2 participants chose "Standard Package".
|
|
@@ -376,8 +370,7 @@ declare enum MultiServiceBookingType {
|
|
|
376
370
|
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
377
371
|
interface BookedEntity extends BookedEntityItemOneOf {
|
|
378
372
|
/**
|
|
379
|
-
* Booked slot
|
|
380
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
|
|
373
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
381
374
|
*
|
|
382
375
|
* Specify `slot` when creating bookings for:
|
|
383
376
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -389,8 +382,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
389
382
|
*/
|
|
390
383
|
slot?: BookedSlot;
|
|
391
384
|
/**
|
|
392
|
-
* Booked schedule
|
|
393
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
385
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
394
386
|
*
|
|
395
387
|
* Specify `schedule` when creating bookings for:
|
|
396
388
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -416,8 +408,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
416
408
|
/** @oneof */
|
|
417
409
|
interface BookedEntityItemOneOf {
|
|
418
410
|
/**
|
|
419
|
-
* Booked slot
|
|
420
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
|
|
411
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
421
412
|
*
|
|
422
413
|
* Specify `slot` when creating bookings for:
|
|
423
414
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -429,8 +420,7 @@ interface BookedEntityItemOneOf {
|
|
|
429
420
|
*/
|
|
430
421
|
slot?: BookedSlot;
|
|
431
422
|
/**
|
|
432
|
-
* Booked schedule
|
|
433
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
423
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
434
424
|
*
|
|
435
425
|
* Specify `schedule` when creating bookings for:
|
|
436
426
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -439,15 +429,27 @@ interface BookedEntityItemOneOf {
|
|
|
439
429
|
schedule?: BookedSchedule;
|
|
440
430
|
}
|
|
441
431
|
interface BookedSlot {
|
|
442
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* Session ID. For class bookings, this is the ID of the existing session.
|
|
434
|
+
* For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
|
|
435
|
+
*
|
|
436
|
+
* __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
|
|
437
|
+
* You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
|
|
438
|
+
* @deprecated Session ID. For class bookings, this is the ID of the existing session.
|
|
439
|
+
* For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
|
|
440
|
+
*
|
|
441
|
+
* __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
|
|
442
|
+
* You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
|
|
443
|
+
* @replacedBy event_id
|
|
444
|
+
* @targetRemovalDate 2026-03-31
|
|
445
|
+
*/
|
|
443
446
|
sessionId?: string | null;
|
|
444
447
|
/** Service ID. */
|
|
445
448
|
serviceId?: string;
|
|
446
449
|
/** Schedule ID. */
|
|
447
450
|
scheduleId?: string;
|
|
448
451
|
/**
|
|
449
|
-
* ID of the corresponding event
|
|
450
|
-
* ([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)).
|
|
452
|
+
* ID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
451
453
|
* Available for both appointment and class bookings, not available for course bookings.
|
|
452
454
|
* For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
|
|
453
455
|
* For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
|
|
@@ -465,9 +467,8 @@ interface BookedSlot {
|
|
|
465
467
|
*/
|
|
466
468
|
timezone?: string | null;
|
|
467
469
|
/**
|
|
468
|
-
* Primary resource
|
|
469
|
-
*
|
|
470
|
-
* For example, the staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)) providing the service.
|
|
470
|
+
* [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking.
|
|
471
|
+
* For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service.
|
|
471
472
|
*/
|
|
472
473
|
resource?: BookedResource;
|
|
473
474
|
/** Location where the session takes place. */
|
|
@@ -549,7 +550,7 @@ declare enum SelectionMethod {
|
|
|
549
550
|
/** @enumType */
|
|
550
551
|
type SelectionMethodWithLiterals = SelectionMethod | 'UNKNOWN_SELECTION_METHOD' | 'SPECIFIC_RESOURCE' | 'ANY_RESOURCE' | 'NO_SELECTION';
|
|
551
552
|
interface BookedSchedule {
|
|
552
|
-
/** Schedule ID
|
|
553
|
+
/** [Schedule ID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). */
|
|
553
554
|
scheduleId?: string;
|
|
554
555
|
/**
|
|
555
556
|
* Booked service ID.
|
|
@@ -557,7 +558,7 @@ interface BookedSchedule {
|
|
|
557
558
|
*/
|
|
558
559
|
serviceId?: string | null;
|
|
559
560
|
/**
|
|
560
|
-
* Location
|
|
561
|
+
* [Location](https://dev.wix.com/docs/rest/business-management/locations/introduction) where the schedule's sessions take place.
|
|
561
562
|
* @readonly
|
|
562
563
|
*/
|
|
563
564
|
location?: Location;
|
|
@@ -701,26 +702,18 @@ type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX
|
|
|
701
702
|
declare enum BookingStatus {
|
|
702
703
|
/** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
|
|
703
704
|
CREATED = "CREATED",
|
|
704
|
-
/**
|
|
705
|
-
* The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
|
|
706
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) to automatically confirm all `PENDING` bookings.
|
|
707
|
-
*/
|
|
705
|
+
/** The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings. */
|
|
708
706
|
CONFIRMED = "CONFIRMED",
|
|
709
707
|
/**
|
|
710
|
-
* The customer has canceled the booking. Depending on the relevant service's policy snapshot
|
|
711
|
-
*
|
|
712
|
-
* they may have to pay a cancellation fee ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction)).
|
|
708
|
+
* The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction)
|
|
709
|
+
* they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
|
|
713
710
|
*/
|
|
714
711
|
CANCELED = "CANCELED",
|
|
715
712
|
/** The merchant must manually confirm the booking before it appears in the business calendar. */
|
|
716
713
|
PENDING = "PENDING",
|
|
717
714
|
/** The merchant has declined the booking before the customer was charged. */
|
|
718
715
|
DECLINED = "DECLINED",
|
|
719
|
-
/**
|
|
720
|
-
* The booking is on a waitlist.
|
|
721
|
-
* Currently, you can't call Register to Waitlist ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist)) for course or appointment bookings, even though this is supported in live sites.
|
|
722
|
-
* You can call Register to Waitlist only for class session bookings.
|
|
723
|
-
*/
|
|
716
|
+
/** Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites. */
|
|
724
717
|
WAITING_LIST = "WAITING_LIST"
|
|
725
718
|
}
|
|
726
719
|
/** @enumType */
|
|
@@ -887,8 +880,7 @@ interface FlowControlSettings {
|
|
|
887
880
|
skipAvailabilityValidation?: boolean;
|
|
888
881
|
/**
|
|
889
882
|
* Whether the booking's `status` is automatically updated to `CONFIRMED` when
|
|
890
|
-
* the customer completes the eCommerce checkout
|
|
891
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)),
|
|
883
|
+
* the customer completes the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),
|
|
892
884
|
* regardless of whether the relevant service requires manual business confirmation.
|
|
893
885
|
*/
|
|
894
886
|
skipBusinessConfirmation?: boolean;
|
|
@@ -925,7 +917,7 @@ interface ParticipantChoices {
|
|
|
925
917
|
}
|
|
926
918
|
interface ServiceChoices {
|
|
927
919
|
/**
|
|
928
|
-
* Number of participants for this variant
|
|
920
|
+
* Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
929
921
|
* @min 1
|
|
930
922
|
*/
|
|
931
923
|
numberOfParticipants?: number | null;
|