@wix/auto_sdk_bookings_bookings 1.0.40 → 1.0.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +176 -61
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +430 -299
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +191 -180
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +176 -61
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +430 -299
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +191 -180
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +176 -61
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +430 -299
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +191 -180
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +176 -61
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +430 -299
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +191 -180
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -2
|
@@ -4,16 +4,19 @@ import '@wix/sdk-types';
|
|
|
4
4
|
/** An entity representing a scheduled appointment, class session, or course. */
|
|
5
5
|
interface Booking extends BookingParticipantsInfoOneOf {
|
|
6
6
|
/**
|
|
7
|
-
* Total number of participants.
|
|
8
|
-
* doesn't
|
|
9
|
-
* ([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)).
|
|
7
|
+
* Total number of participants.
|
|
8
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options ([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)).
|
|
10
9
|
* @min 1
|
|
11
10
|
*/
|
|
12
11
|
totalParticipants?: number;
|
|
13
12
|
/**
|
|
14
|
-
* Information about the booked service choices and
|
|
15
|
-
*
|
|
13
|
+
* Information about the booked service choices and participant count for each choice.
|
|
14
|
+
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
16
15
|
* ([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)).
|
|
16
|
+
*
|
|
17
|
+
* For example, use this for a spa package booking that includes different service levels:
|
|
18
|
+
* - 2 participants chose "Standard Package".
|
|
19
|
+
* - 1 participant chose "VIP Package".
|
|
17
20
|
*/
|
|
18
21
|
participantsChoices?: ParticipantChoices;
|
|
19
22
|
/**
|
|
@@ -23,15 +26,24 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
23
26
|
*/
|
|
24
27
|
id?: string | null;
|
|
25
28
|
/**
|
|
26
|
-
* An object describing the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* An object describing the bookable entity - either a specific time slot or a recurring schedule.
|
|
30
|
+
*
|
|
31
|
+
* The structure depends on the type of service being booked:
|
|
32
|
+
*
|
|
33
|
+
* *For appointment services:** Use `slot` to book a specific time slot with a
|
|
34
|
+
* service provider. Appointments are typically one-time sessions at a specific date and time.
|
|
35
|
+
*
|
|
36
|
+
* *For class services:** Use `slot` to book a specific class session. Classes
|
|
37
|
+
* are individual sessions that can have multiple participants.
|
|
38
|
+
*
|
|
39
|
+
* *For course services:** Use `schedule` to book an entire course consisting of
|
|
40
|
+
* multiple sessions over time. Courses are recurring, multi-session offerings.
|
|
41
|
+
*
|
|
42
|
+
* Choose the appropriate field based on your service type and booking requirements.
|
|
31
43
|
*/
|
|
32
44
|
bookedEntity?: BookedEntity;
|
|
33
45
|
/**
|
|
34
|
-
* Contact details of the site visitor or
|
|
46
|
+
* Contact details of the site visitor or member
|
|
35
47
|
* ([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))
|
|
36
48
|
* making the booking.
|
|
37
49
|
*/
|
|
@@ -46,20 +58,27 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
46
58
|
*/
|
|
47
59
|
status?: BookingStatusWithLiterals;
|
|
48
60
|
/**
|
|
49
|
-
* The payment status of the booking
|
|
50
|
-
*
|
|
51
|
-
* ([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))
|
|
52
|
-
*
|
|
61
|
+
* The payment status of the booking. This field automatically syncs with the
|
|
62
|
+
* `paymentStatus` of the corresponding eCommerce order
|
|
63
|
+
* ([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))
|
|
64
|
+
* when customers use Wix eCommerce checkout.
|
|
65
|
+
*
|
|
66
|
+
* ## Integration patterns
|
|
67
|
+
*
|
|
68
|
+
* *When using Wix eCommerce checkout:** Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
|
|
69
|
+
* Do not manually update this field.
|
|
70
|
+
*
|
|
71
|
+
* *When using custom payment flows:** You can manually update the payment status with Confirm Booking or Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)) to reflect the customer's payment state.
|
|
72
|
+
*
|
|
73
|
+
* *For membership/pricing plan payments:** Wix Bookings automatically manages the payment status when customers pay with an active pricing plan ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/introduction)) subscription.
|
|
74
|
+
*
|
|
75
|
+
* All payment statuses are supported for every booking `status`.
|
|
53
76
|
*/
|
|
54
77
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
55
78
|
/**
|
|
56
|
-
* Payment option selected by the customer. If the customer hasn't completed their
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
60
|
-
* When undefined during an *eCommerce checkout*
|
|
61
|
-
* ([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)),
|
|
62
|
-
* Wix Bookings uses the service's default payment option
|
|
79
|
+
* 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 ([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)), unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
80
|
+
*
|
|
81
|
+
* When undefined during an eCommerce checkout ([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)), Wix Bookings uses the service's default payment option
|
|
63
82
|
*/
|
|
64
83
|
selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
|
|
65
84
|
/**
|
|
@@ -70,10 +89,8 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
70
89
|
/** External user ID that you can provide. */
|
|
71
90
|
externalUserId?: string | null;
|
|
72
91
|
/**
|
|
73
|
-
* Revision number to be used when updating, rescheduling, or cancelling the
|
|
74
|
-
*
|
|
75
|
-
* canceled. To prevent conflicting changes, the current revision must be
|
|
76
|
-
* specified when updating the booking.
|
|
92
|
+
* Revision number to be used when updating, rescheduling, or cancelling the booking.
|
|
93
|
+
* Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking.
|
|
77
94
|
*/
|
|
78
95
|
revision?: string | null;
|
|
79
96
|
/**
|
|
@@ -114,50 +131,64 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
114
131
|
/** @oneof */
|
|
115
132
|
interface BookingParticipantsInfoOneOf {
|
|
116
133
|
/**
|
|
117
|
-
* Total number of participants.
|
|
118
|
-
* doesn't
|
|
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)).
|
|
134
|
+
* Total number of participants.
|
|
135
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options ([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)).
|
|
120
136
|
* @min 1
|
|
121
137
|
*/
|
|
122
138
|
totalParticipants?: number;
|
|
123
139
|
/**
|
|
124
|
-
* Information about the booked service choices and
|
|
125
|
-
*
|
|
140
|
+
* Information about the booked service choices and participant count for each choice.
|
|
141
|
+
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
126
142
|
* ([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)).
|
|
143
|
+
*
|
|
144
|
+
* For example, use this for a spa package booking that includes different service levels:
|
|
145
|
+
* - 2 participants chose "Standard Package".
|
|
146
|
+
* - 1 participant chose "VIP Package".
|
|
127
147
|
*/
|
|
128
148
|
participantsChoices?: ParticipantChoices;
|
|
129
149
|
}
|
|
130
150
|
/**
|
|
131
|
-
* A multi-service booking is considered available if all
|
|
151
|
+
* A multi-service booking is considered available if all single-service bookings are available as returned from List Multi Service Availability Time Slots.
|
|
132
152
|
* Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
|
|
133
153
|
* Multi-service booking is available if each of its bookings is available separately.
|
|
134
154
|
* For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
|
|
135
155
|
*/
|
|
136
156
|
declare enum MultiServiceBookingType {
|
|
157
|
+
/** You must schedule single-service bookings back-to-back with each booking starting when the previous booking ends */
|
|
137
158
|
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
159
|
+
/** Not currently supported. */
|
|
138
160
|
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
161
|
+
/** Not currently supported. */
|
|
139
162
|
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
140
163
|
}
|
|
141
164
|
/** @enumType */
|
|
142
165
|
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
143
166
|
interface BookedEntity extends BookedEntityItemOneOf {
|
|
144
167
|
/**
|
|
145
|
-
* Booked
|
|
168
|
+
* Booked slot
|
|
146
169
|
* ([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)).
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
170
|
+
*
|
|
171
|
+
* Specify `slot` when creating bookings for:
|
|
172
|
+
* - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
|
|
173
|
+
* Wix Bookings creates a new session when the booking is confirmed.
|
|
174
|
+
* - **Class services:** Group sessions at specific times (fitness classes, workshops).
|
|
175
|
+
* Wix Bookings links the booking to an existing scheduled session.
|
|
176
|
+
*
|
|
177
|
+
* For course services, specify `schedule` instead of `slot`.
|
|
150
178
|
*/
|
|
151
179
|
slot?: BookedSlot;
|
|
152
180
|
/**
|
|
153
|
-
* Booked
|
|
181
|
+
* Booked schedule
|
|
154
182
|
* ([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)).
|
|
155
|
-
*
|
|
183
|
+
*
|
|
184
|
+
* Specify `schedule` when creating bookings for:
|
|
185
|
+
* - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
186
|
+
* Wix Bookings enrolls participants in all sessions defined by the course schedule.
|
|
156
187
|
*/
|
|
157
188
|
schedule?: BookedSchedule;
|
|
158
189
|
/**
|
|
159
190
|
* Session title at the time of booking. If there is no pre-existing session,
|
|
160
|
-
* for example for appointment-based services, `title`
|
|
191
|
+
* for example for appointment-based services, Wix Bookings sets `title` to the service name.
|
|
161
192
|
* @readonly
|
|
162
193
|
* @maxLength 6000
|
|
163
194
|
*/
|
|
@@ -174,17 +205,25 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
174
205
|
/** @oneof */
|
|
175
206
|
interface BookedEntityItemOneOf {
|
|
176
207
|
/**
|
|
177
|
-
* Booked
|
|
208
|
+
* Booked slot
|
|
178
209
|
* ([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)).
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
210
|
+
*
|
|
211
|
+
* Specify `slot` when creating bookings for:
|
|
212
|
+
* - **Appointment-based services:** Individual sessions with service providers (consultations, treatments).
|
|
213
|
+
* Wix Bookings creates a new session when the booking is confirmed.
|
|
214
|
+
* - **Class services:** Group sessions at specific times (fitness classes, workshops).
|
|
215
|
+
* Wix Bookings links the booking to an existing scheduled session.
|
|
216
|
+
*
|
|
217
|
+
* For course services, specify `schedule` instead of `slot`.
|
|
182
218
|
*/
|
|
183
219
|
slot?: BookedSlot;
|
|
184
220
|
/**
|
|
185
|
-
* Booked
|
|
221
|
+
* Booked schedule
|
|
186
222
|
* ([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)).
|
|
187
|
-
*
|
|
223
|
+
*
|
|
224
|
+
* Specify `schedule` when creating bookings for:
|
|
225
|
+
* - **Course services:** Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
226
|
+
* Wix Bookings enrolls participants in all sessions defined by the course schedule.
|
|
188
227
|
*/
|
|
189
228
|
schedule?: BookedSchedule;
|
|
190
229
|
}
|
|
@@ -196,35 +235,25 @@ interface BookedSlot {
|
|
|
196
235
|
/** Schedule ID. */
|
|
197
236
|
scheduleId?: string;
|
|
198
237
|
/**
|
|
199
|
-
* ID of the corresponding
|
|
238
|
+
* ID of the corresponding event
|
|
200
239
|
* ([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)).
|
|
201
240
|
* Available for both appointment and class bookings, not available for course bookings.
|
|
202
|
-
* For appointment-based services, Wix Bookings automatically populates `eventId`
|
|
203
|
-
*
|
|
204
|
-
* automatically populated upon booking creation.
|
|
241
|
+
* For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
|
|
242
|
+
* For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
|
|
205
243
|
* @minLength 36
|
|
206
244
|
* @maxLength 250
|
|
207
245
|
*/
|
|
208
246
|
eventId?: string | null;
|
|
209
|
-
/**
|
|
210
|
-
* The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
211
|
-
* format.
|
|
212
|
-
*/
|
|
247
|
+
/** The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
|
|
213
248
|
startDate?: string | null;
|
|
214
|
-
/**
|
|
215
|
-
* The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
216
|
-
* format.
|
|
217
|
-
*/
|
|
249
|
+
/** The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format. */
|
|
218
250
|
endDate?: string | null;
|
|
219
|
-
/** The
|
|
251
|
+
/** The time zone according to which the slot was shown to the user when booking, and should be shown in the future. */
|
|
220
252
|
timezone?: string | null;
|
|
221
253
|
/**
|
|
222
|
-
* Primary
|
|
223
|
-
* ([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))
|
|
224
|
-
*
|
|
225
|
-
* ([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))
|
|
226
|
-
* providing the
|
|
227
|
-
* service.
|
|
254
|
+
* Primary resource
|
|
255
|
+
* ([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)) for the booking.
|
|
256
|
+
* 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.
|
|
228
257
|
*/
|
|
229
258
|
resource?: BookedResource;
|
|
230
259
|
/** Location where the session takes place. */
|
|
@@ -286,10 +315,7 @@ declare enum LocationType {
|
|
|
286
315
|
/** @enumType */
|
|
287
316
|
type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
|
|
288
317
|
interface BookedSchedule {
|
|
289
|
-
/**
|
|
290
|
-
* _Schedule ID_
|
|
291
|
-
* ([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)).
|
|
292
|
-
*/
|
|
318
|
+
/** Schedule ID ([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)). */
|
|
293
319
|
scheduleId?: string;
|
|
294
320
|
/**
|
|
295
321
|
* Booked service ID.
|
|
@@ -297,26 +323,22 @@ interface BookedSchedule {
|
|
|
297
323
|
*/
|
|
298
324
|
serviceId?: string | null;
|
|
299
325
|
/**
|
|
300
|
-
*
|
|
301
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
302
|
-
* where the schedule's sessions take place.
|
|
326
|
+
* Location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)) where the schedule's sessions take place.
|
|
303
327
|
* @readonly
|
|
304
328
|
*/
|
|
305
329
|
location?: Location;
|
|
306
330
|
/**
|
|
307
|
-
*
|
|
331
|
+
* Time zone in which the slot or session was shown to the customer when they booked.
|
|
308
332
|
* Also used whenever the customer reviews the booking's timing in the future.
|
|
309
333
|
*/
|
|
310
334
|
timezone?: string | null;
|
|
311
335
|
/**
|
|
312
|
-
* Start time of the first session related to the booking in
|
|
313
|
-
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
336
|
+
* Start time of the first session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
314
337
|
* @readonly
|
|
315
338
|
*/
|
|
316
339
|
firstSessionStart?: string | null;
|
|
317
340
|
/**
|
|
318
|
-
* End time of the last session related to the booking in
|
|
319
|
-
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
341
|
+
* End time of the last session related to the booking in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
320
342
|
* @readonly
|
|
321
343
|
*/
|
|
322
344
|
lastSessionEnd?: string | null;
|
|
@@ -443,38 +465,26 @@ declare enum ValueType {
|
|
|
443
465
|
type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
|
|
444
466
|
/** Booking status. */
|
|
445
467
|
declare enum BookingStatus {
|
|
446
|
-
/**
|
|
447
|
-
* The booking was created, but the customer hasn't completed the related
|
|
448
|
-
* eCommerce order yet.
|
|
449
|
-
*/
|
|
468
|
+
/** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
|
|
450
469
|
CREATED = "CREATED",
|
|
451
470
|
/**
|
|
452
|
-
* The merchant has confirmed the booking and it appears in the
|
|
453
|
-
*
|
|
454
|
-
* ([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))
|
|
455
|
-
* to automatically confirm all `PENDING` bookings.
|
|
471
|
+
* The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
|
|
472
|
+
* ([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.
|
|
456
473
|
*/
|
|
457
474
|
CONFIRMED = "CONFIRMED",
|
|
458
475
|
/**
|
|
459
|
-
* The customer has canceled the booking. Depending on the relevant service's
|
|
460
|
-
* _policy snapshot_
|
|
476
|
+
* The customer has canceled the booking. Depending on the relevant service's policy snapshot
|
|
461
477
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction))
|
|
462
|
-
* they may have to pay a
|
|
463
|
-
* ([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)).
|
|
478
|
+
* 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)).
|
|
464
479
|
*/
|
|
465
480
|
CANCELED = "CANCELED",
|
|
466
|
-
/**
|
|
467
|
-
* The merchant must manually confirm the booking before it appears
|
|
468
|
-
* in the business calendar.
|
|
469
|
-
*/
|
|
481
|
+
/** The merchant must manually confirm the booking before it appears in the business calendar. */
|
|
470
482
|
PENDING = "PENDING",
|
|
471
483
|
/** The merchant has declined the booking before the customer was charged. */
|
|
472
484
|
DECLINED = "DECLINED",
|
|
473
485
|
/**
|
|
474
486
|
* The booking is on a waitlist.
|
|
475
|
-
* Currently, you can't call Register to Waitlist
|
|
476
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist))
|
|
477
|
-
* for course or appointment bookings, even though this is supported in live sites.
|
|
487
|
+
* 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.
|
|
478
488
|
* You can call Register to Waitlist only for class session bookings.
|
|
479
489
|
*/
|
|
480
490
|
WAITING_LIST = "WAITING_LIST"
|
|
@@ -527,7 +537,7 @@ declare enum SelectedPaymentOption {
|
|
|
527
537
|
type SelectedPaymentOptionWithLiterals = SelectedPaymentOption | 'UNDEFINED' | 'OFFLINE' | 'ONLINE' | 'MEMBERSHIP' | 'MEMBERSHIP_OFFLINE';
|
|
528
538
|
interface ParticipantNotification {
|
|
529
539
|
/**
|
|
530
|
-
* Whether to send
|
|
540
|
+
* Whether to send a message about the changes to the customer.
|
|
531
541
|
*
|
|
532
542
|
* Default: `false`
|
|
533
543
|
*/
|
|
@@ -606,8 +616,7 @@ interface ParticipantChoices {
|
|
|
606
616
|
}
|
|
607
617
|
interface ServiceChoices {
|
|
608
618
|
/**
|
|
609
|
-
* Number of participants for this
|
|
610
|
-
* ([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)).
|
|
619
|
+
* Number of participants for this variant ([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)).
|
|
611
620
|
* @min 1
|
|
612
621
|
*/
|
|
613
622
|
numberOfParticipants?: number | null;
|
|
@@ -775,7 +784,14 @@ interface CreateBookingFlowControlSettings {
|
|
|
775
784
|
/**
|
|
776
785
|
* Whether the availability is checked before creating the booking.
|
|
777
786
|
*
|
|
778
|
-
*
|
|
787
|
+
* - `false`: A booking is only created when the slot or schedule is available.
|
|
788
|
+
* - `true`: The booking is created regardless of availability conflicts. Make sure the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has the required permissions.
|
|
789
|
+
*
|
|
790
|
+
* *Use cases for `true`:**
|
|
791
|
+
* - Emergency or priority bookings that must be accommodated.
|
|
792
|
+
* - Administrative bookings that override normal availability rules.
|
|
793
|
+
* - Testing or demonstration purposes.
|
|
794
|
+
*
|
|
779
795
|
* Default: `false`.
|
|
780
796
|
*/
|
|
781
797
|
skipAvailabilityValidation?: boolean;
|
|
@@ -783,7 +799,7 @@ interface CreateBookingFlowControlSettings {
|
|
|
783
799
|
* Whether `PENDING` bookings are automatically set to `CONFIRMED` for
|
|
784
800
|
* services that normally require the owner's manual confirmation.
|
|
785
801
|
*
|
|
786
|
-
* Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission
|
|
802
|
+
* Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission
|
|
787
803
|
* when passing `true`.
|
|
788
804
|
* Default: `false`.
|
|
789
805
|
*/
|
|
@@ -792,7 +808,7 @@ interface CreateBookingFlowControlSettings {
|
|
|
792
808
|
* Whether customers can pay using a payment method that isn't supported
|
|
793
809
|
* for the service, but that's supported for other services.
|
|
794
810
|
*
|
|
795
|
-
* Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission
|
|
811
|
+
* Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission when passing
|
|
796
812
|
* `true`.
|
|
797
813
|
* Default: `false`.
|
|
798
814
|
*/
|
|
@@ -1246,47 +1262,58 @@ interface MarkBookingAsPendingFlowControlSettings {
|
|
|
1246
1262
|
}
|
|
1247
1263
|
interface CreateMultiServiceBookingRequest {
|
|
1248
1264
|
/**
|
|
1249
|
-
*
|
|
1265
|
+
* Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
1266
|
+
*
|
|
1267
|
+
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
1268
|
+
* Specify contact details, number of participants, and any additional fields as needed.
|
|
1269
|
+
*
|
|
1270
|
+
* For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
|
|
1250
1271
|
* @minSize 2
|
|
1251
1272
|
* @maxSize 8
|
|
1252
1273
|
*/
|
|
1253
1274
|
bookings: Booking[];
|
|
1254
|
-
/**
|
|
1255
|
-
* Information about whether to notify the customer and
|
|
1256
|
-
* the message to send.
|
|
1257
|
-
*/
|
|
1275
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1258
1276
|
participantNotification?: ParticipantNotification;
|
|
1259
1277
|
/**
|
|
1260
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1261
|
-
*
|
|
1278
|
+
* Whether to send an SMS reminder to the customer 24 hours before the session starts.
|
|
1279
|
+
* Wix Bookings takes the phone number from `contactDetails.phone`.
|
|
1262
1280
|
*
|
|
1263
1281
|
* Default: `true`
|
|
1264
1282
|
*/
|
|
1265
1283
|
sendSmsReminder?: boolean | null;
|
|
1266
1284
|
/**
|
|
1267
1285
|
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
1268
|
-
* For example, whether to
|
|
1286
|
+
* For example, whether to skip checking availability before updating the status.
|
|
1269
1287
|
*/
|
|
1270
1288
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1271
1289
|
/** Whether to return the created single-service bookings. */
|
|
1272
1290
|
returnFullEntity?: boolean;
|
|
1273
|
-
/**
|
|
1291
|
+
/**
|
|
1292
|
+
* Multi-service booking type.
|
|
1293
|
+
*
|
|
1294
|
+
* Currently only `SEQUENTIAL_BOOKINGS` is supported.
|
|
1295
|
+
*/
|
|
1274
1296
|
multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
|
|
1275
1297
|
}
|
|
1276
1298
|
interface CreateMultiServiceBookingResponse {
|
|
1277
1299
|
/**
|
|
1278
|
-
* Created multi
|
|
1279
|
-
* Contains the
|
|
1300
|
+
* Created multi-service booking.
|
|
1301
|
+
* Contains the single-service bookings in the same order as specified in the request.
|
|
1280
1302
|
*/
|
|
1281
1303
|
multiServiceBooking?: MultiServiceBooking;
|
|
1282
1304
|
}
|
|
1305
|
+
/**
|
|
1306
|
+
* A multi-service booking combines multiple single-service bookings into a package.
|
|
1307
|
+
*
|
|
1308
|
+
* Currently, multi-service bookings support only sequential scheduling where services are scheduled back-to-back at the same location, with each single-service booking starting when the previous 1 ends.
|
|
1309
|
+
*/
|
|
1283
1310
|
interface MultiServiceBooking {
|
|
1284
1311
|
/**
|
|
1285
1312
|
* Multi-service booking ID.
|
|
1286
1313
|
* @format GUID
|
|
1287
1314
|
*/
|
|
1288
1315
|
id?: string | null;
|
|
1289
|
-
/** The
|
|
1316
|
+
/** The single-service bookings that make up the multi-service booking package. */
|
|
1290
1317
|
bookings?: BookingResult[];
|
|
1291
1318
|
}
|
|
1292
1319
|
interface BookingResult {
|
|
@@ -1300,22 +1327,17 @@ interface BookingResult {
|
|
|
1300
1327
|
}
|
|
1301
1328
|
interface RescheduleMultiServiceBookingRequest {
|
|
1302
1329
|
/**
|
|
1303
|
-
* ID of the multi
|
|
1330
|
+
* ID of the multi-service booking to reschedule.
|
|
1304
1331
|
* @format GUID
|
|
1305
1332
|
*/
|
|
1306
1333
|
multiServiceBookingId: string | null;
|
|
1307
1334
|
/** Information about the single-service bookings to reschedule. */
|
|
1308
1335
|
rescheduleBookingsInfo: RescheduleBookingInfo[];
|
|
1309
|
-
/**
|
|
1310
|
-
* Information about whether to notify the customer and
|
|
1311
|
-
* the message to send.
|
|
1312
|
-
*/
|
|
1336
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1313
1337
|
participantNotification?: ParticipantNotification;
|
|
1314
1338
|
/**
|
|
1315
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1316
|
-
*
|
|
1317
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
1318
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
1339
|
+
* Information about whether specific procedures of the standard Wix Bookings rescheduling flow are changed.
|
|
1340
|
+
* For example, whether the availability of the new slot is checked before rescheduling the booking or if the customer can reschedule the booking even though the service's rescheduling policy doesn't allow it.
|
|
1319
1341
|
*/
|
|
1320
1342
|
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
1321
1343
|
/** Whether to return the rescheduled bookings entities. */
|
|
@@ -1323,13 +1345,12 @@ interface RescheduleMultiServiceBookingRequest {
|
|
|
1323
1345
|
}
|
|
1324
1346
|
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
1325
1347
|
/**
|
|
1326
|
-
* Total number of participants. Available only for services with variants.
|
|
1348
|
+
* Total number of participants. Available only for services with variants ([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)).
|
|
1327
1349
|
* Specify when all participants book the same variant.
|
|
1328
1350
|
*/
|
|
1329
1351
|
totalParticipants?: number;
|
|
1330
1352
|
/**
|
|
1331
|
-
* Information about the service choices to book. Available only for services with
|
|
1332
|
-
* variants.
|
|
1353
|
+
* Information about the service choices to book. Available only for services with variants ([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)).
|
|
1333
1354
|
* Specify when not all participants book the same variant.
|
|
1334
1355
|
*/
|
|
1335
1356
|
participantsChoices?: ParticipantChoices;
|
|
@@ -1342,21 +1363,19 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
|
|
|
1342
1363
|
slot?: V2Slot;
|
|
1343
1364
|
/**
|
|
1344
1365
|
* Revision number, which increments by 1 each time the booking is updated.
|
|
1345
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1346
|
-
* managing the booking.
|
|
1366
|
+
* To prevent conflicting changes, the current revision must be specified when managing the booking.
|
|
1347
1367
|
*/
|
|
1348
1368
|
revision?: string | null;
|
|
1349
1369
|
}
|
|
1350
1370
|
/** @oneof */
|
|
1351
1371
|
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
1352
1372
|
/**
|
|
1353
|
-
* Total number of participants. Available only for services with variants.
|
|
1373
|
+
* Total number of participants. Available only for services with variants ([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)).
|
|
1354
1374
|
* Specify when all participants book the same variant.
|
|
1355
1375
|
*/
|
|
1356
1376
|
totalParticipants?: number;
|
|
1357
1377
|
/**
|
|
1358
|
-
* Information about the service choices to book. Available only for services with
|
|
1359
|
-
* variants.
|
|
1378
|
+
* Information about the service choices to book. Available only for services with variants ([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)).
|
|
1360
1379
|
* Specify when not all participants book the same variant.
|
|
1361
1380
|
*/
|
|
1362
1381
|
participantsChoices?: ParticipantChoices;
|
|
@@ -1379,11 +1398,11 @@ interface GetMultiServiceBookingAvailabilityResponse {
|
|
|
1379
1398
|
totalCapacity?: number | null;
|
|
1380
1399
|
/** Number of open spots. */
|
|
1381
1400
|
remainingCapacity?: number | null;
|
|
1382
|
-
/** Indicators for policy violations of the multi
|
|
1401
|
+
/** Indicators for policy violations of the multi-service booking. */
|
|
1383
1402
|
policyViolations?: BookingPolicyViolations;
|
|
1384
1403
|
/** Multi-service booking policy settings. */
|
|
1385
1404
|
policySettings?: BookingPolicySettings;
|
|
1386
|
-
/**
|
|
1405
|
+
/** Details of the multi-service booking. */
|
|
1387
1406
|
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
1388
1407
|
}
|
|
1389
1408
|
interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
@@ -1399,16 +1418,11 @@ interface CancelMultiServiceBookingRequest {
|
|
|
1399
1418
|
* @format GUID
|
|
1400
1419
|
*/
|
|
1401
1420
|
multiServiceBookingId: string | null;
|
|
1402
|
-
/**
|
|
1403
|
-
* Information about whether to notify the customer and
|
|
1404
|
-
* the message to send.
|
|
1405
|
-
*/
|
|
1421
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1406
1422
|
participantNotification?: ParticipantNotification;
|
|
1407
1423
|
/**
|
|
1408
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1409
|
-
* cancellation
|
|
1410
|
-
* a booking even though the cancellation policy doesn't allow it or whether
|
|
1411
|
-
* to issue a refund.
|
|
1424
|
+
* Information about whether specific procedures of the standard Wix Bookings cancellation flow are changed.
|
|
1425
|
+
* For example, whether the customer can cancel the booking even though the service's cancellation policy doesn't allow it or whether to issue a refund upon cancellation.
|
|
1412
1426
|
*/
|
|
1413
1427
|
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1414
1428
|
/** Whether to return the canceled single-service bookings. */
|
|
@@ -1426,26 +1440,26 @@ interface MarkMultiServiceBookingAsPendingRequest {
|
|
|
1426
1440
|
multiServiceBookingId: string | null;
|
|
1427
1441
|
/** Information about the single-service bookings to mark as `PENDING`. */
|
|
1428
1442
|
markAsPendingBookingsInfo?: BookingInfo[];
|
|
1429
|
-
/**
|
|
1430
|
-
* Information about whether to notify the customer and
|
|
1431
|
-
* the message to send.
|
|
1432
|
-
*/
|
|
1443
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1433
1444
|
participantNotification?: ParticipantNotification;
|
|
1434
1445
|
/**
|
|
1435
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1436
|
-
*
|
|
1446
|
+
* Whether to send an SMS reminder to the customer 24 hours before the session starts.
|
|
1447
|
+
* Wix Bookings takes the phone number from `contactDetails.phone`.
|
|
1437
1448
|
*
|
|
1438
1449
|
* Default: `true`
|
|
1439
1450
|
*/
|
|
1440
1451
|
sendSmsReminder?: boolean | null;
|
|
1441
1452
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1442
1453
|
doubleBooked?: boolean | null;
|
|
1443
|
-
/**
|
|
1454
|
+
/**
|
|
1455
|
+
* Whether to return the single-service bookings that were marked as `PENDING`.
|
|
1456
|
+
*
|
|
1457
|
+
* Default: `false`
|
|
1458
|
+
*/
|
|
1444
1459
|
returnFullEntity?: boolean;
|
|
1445
1460
|
/**
|
|
1446
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1447
|
-
*
|
|
1448
|
-
* before updating the booking.
|
|
1461
|
+
* Information about whether specific procedures of the standard Wix Bookings creation flow are changed.
|
|
1462
|
+
* For example, whether Wix Bookings checks availability before updating the booking.
|
|
1449
1463
|
*/
|
|
1450
1464
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
1451
1465
|
}
|
|
@@ -1457,8 +1471,7 @@ interface BookingInfo {
|
|
|
1457
1471
|
bookingId?: string | null;
|
|
1458
1472
|
/**
|
|
1459
1473
|
* Revision number, which increments by 1 each time the booking is updated.
|
|
1460
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1461
|
-
* managing the booking.
|
|
1474
|
+
* To prevent conflicting changes, the current revision must be specified when managing the booking.
|
|
1462
1475
|
*/
|
|
1463
1476
|
revision?: string | null;
|
|
1464
1477
|
/** Payment status to set for the single-service booking. */
|
|
@@ -1476,14 +1489,11 @@ interface ConfirmMultiServiceBookingRequest {
|
|
|
1476
1489
|
multiServiceBookingId: string | null;
|
|
1477
1490
|
/** Information about the single-service bookings to confirm. */
|
|
1478
1491
|
confirmBookingsInfo?: BookingInfo[];
|
|
1479
|
-
/**
|
|
1480
|
-
* Information about whether to notify the customer and
|
|
1481
|
-
* the message to send.
|
|
1482
|
-
*/
|
|
1492
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1483
1493
|
participantNotification?: ParticipantNotification;
|
|
1484
1494
|
/**
|
|
1485
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1486
|
-
*
|
|
1495
|
+
* Whether to send an SMS reminder to the customer 24 hours before the session starts.
|
|
1496
|
+
* Wix Bookings takes the phone number from `contactDetails.phone`.
|
|
1487
1497
|
*
|
|
1488
1498
|
* Default: `true`
|
|
1489
1499
|
*/
|
|
@@ -1493,36 +1503,32 @@ interface ConfirmMultiServiceBookingRequest {
|
|
|
1493
1503
|
/** Whether to return the confirmed single-service bookings. */
|
|
1494
1504
|
returnFullEntity?: boolean;
|
|
1495
1505
|
/**
|
|
1496
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1497
|
-
*
|
|
1498
|
-
* checked before confirming the booking.
|
|
1506
|
+
* Information about whether specific procedures of the standard Wix Bookings confirmation flow are changed.
|
|
1507
|
+
* For example, whether Wix Bookings checks availability before confirming the booking.
|
|
1499
1508
|
*/
|
|
1500
1509
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
1501
1510
|
}
|
|
1502
1511
|
interface ConfirmMultiServiceBookingResponse {
|
|
1503
|
-
/** Confirmed multi
|
|
1512
|
+
/** Confirmed multi-service booking. */
|
|
1504
1513
|
multiServiceBooking?: MultiServiceBooking;
|
|
1505
1514
|
}
|
|
1506
1515
|
interface DeclineMultiServiceBookingRequest {
|
|
1507
1516
|
/**
|
|
1508
|
-
* ID of the multi
|
|
1517
|
+
* ID of the multi-service booking to decline.
|
|
1509
1518
|
* @format GUID
|
|
1510
1519
|
*/
|
|
1511
1520
|
multiServiceBookingId: string | null;
|
|
1512
1521
|
/** Information about the single-service bookings to decline. */
|
|
1513
1522
|
declineBookingsInfo?: BookingInfo[];
|
|
1514
|
-
/**
|
|
1515
|
-
* Information about whether to notify the customer and
|
|
1516
|
-
* the message to send.
|
|
1517
|
-
*/
|
|
1523
|
+
/** Information about whether to notify the customer and the message to send. */
|
|
1518
1524
|
participantNotification?: ParticipantNotification;
|
|
1519
1525
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1520
1526
|
doubleBooked?: boolean | null;
|
|
1521
1527
|
/** Whether to return the declined single-service bookings. */
|
|
1522
1528
|
returnFullEntity?: boolean;
|
|
1523
1529
|
/**
|
|
1524
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1525
|
-
*
|
|
1530
|
+
* Information about whether specific procedures of the standard Wix Bookings declining flow are changed.
|
|
1531
|
+
* For example, whether to issue a refund upon cancellation.
|
|
1526
1532
|
*/
|
|
1527
1533
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
1528
1534
|
}
|
|
@@ -1542,11 +1548,10 @@ interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
|
1542
1548
|
interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
1543
1549
|
/**
|
|
1544
1550
|
* Information about the multi-service bookings that were retrieved.
|
|
1545
|
-
*
|
|
1546
|
-
* successfully updated.
|
|
1551
|
+
* Includes their ID, index in the bulk request and whether they were successfully processed.
|
|
1547
1552
|
*/
|
|
1548
1553
|
results?: BulkCalculateAllowedActionsResult[];
|
|
1549
|
-
/** Total number of successes and failures for Bulk
|
|
1554
|
+
/** Total number of successes and failures for Bulk Get Multi Service Booking Allowed Actions. */
|
|
1550
1555
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1551
1556
|
}
|
|
1552
1557
|
interface GetMultiServiceBookingRequest {
|
|
@@ -1564,9 +1569,8 @@ interface GetMultiServiceBookingResponse {
|
|
|
1564
1569
|
}
|
|
1565
1570
|
interface MultiServiceBookingMetadata {
|
|
1566
1571
|
/**
|
|
1567
|
-
* Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
|
|
1568
|
-
*
|
|
1569
|
-
* bookings which couldn't be retrieved due to lack of permissions.
|
|
1572
|
+
* Total number of `CONFIRMED` and `PENDING` single-service bookings belonging to the multi-service booking.
|
|
1573
|
+
* The total includes the number of single-service bookings which couldn't be retrieved due to lack of permissions.
|
|
1570
1574
|
*/
|
|
1571
1575
|
totalNumberOfScheduledBookings?: number | null;
|
|
1572
1576
|
}
|
|
@@ -1581,19 +1585,22 @@ interface AddBookingsToMultiServiceBookingRequest {
|
|
|
1581
1585
|
* @maxSize 8
|
|
1582
1586
|
*/
|
|
1583
1587
|
bookings: BookingIdAndRevision[];
|
|
1584
|
-
/**
|
|
1588
|
+
/**
|
|
1589
|
+
* Whether to return the single-service bookings that were added to the multi-service booking.
|
|
1590
|
+
*
|
|
1591
|
+
* Default: `false`
|
|
1592
|
+
*/
|
|
1585
1593
|
returnFullEntity?: boolean;
|
|
1586
1594
|
}
|
|
1587
1595
|
interface BookingIdAndRevision {
|
|
1588
1596
|
/**
|
|
1589
|
-
* ID of the booking.
|
|
1597
|
+
* ID of the single-service booking.
|
|
1590
1598
|
* @format GUID
|
|
1591
1599
|
*/
|
|
1592
1600
|
bookingId?: string | null;
|
|
1593
1601
|
/**
|
|
1594
1602
|
* Revision number, which increments by 1 each time the booking is updated.
|
|
1595
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1596
|
-
* managing the booking.
|
|
1603
|
+
* To prevent conflicting changes, the current revision must be specified when managing the booking.
|
|
1597
1604
|
*/
|
|
1598
1605
|
revision?: string | null;
|
|
1599
1606
|
}
|
|
@@ -1612,7 +1619,11 @@ interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
|
1612
1619
|
* @maxSize 8
|
|
1613
1620
|
*/
|
|
1614
1621
|
bookings?: BookingIdAndRevision[];
|
|
1615
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Whether to return the single-service bookings.
|
|
1624
|
+
*
|
|
1625
|
+
* Default: `false`
|
|
1626
|
+
*/
|
|
1616
1627
|
returnFullEntity?: boolean;
|
|
1617
1628
|
}
|
|
1618
1629
|
interface RemoveBookingsFromMultiServiceBookingResponse {
|