@wix/auto_sdk_bookings_extended-bookings 1.0.0 → 1.0.2
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/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts +151 -51
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +3 -3
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +1 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +151 -51
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +3 -3
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js.map +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts +151 -51
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +3 -3
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +151 -51
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +3 -3
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js.map +1 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts +151 -51
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +3 -3
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +1 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +151 -51
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +3 -3
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js.map +1 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts +151 -51
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +3 -3
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +1 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +151 -51
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +3 -3
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -47,32 +47,34 @@ export declare enum AttendanceStatus {
|
|
|
47
47
|
export interface Booking extends BookingParticipantsInfoOneOf {
|
|
48
48
|
/**
|
|
49
49
|
* Total number of participants. Available only when the relevant service
|
|
50
|
-
* doesn't have
|
|
50
|
+
* doesn't have _variants and options_
|
|
51
51
|
* ([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)).
|
|
52
|
+
* @min 1
|
|
52
53
|
*/
|
|
53
54
|
totalParticipants?: number;
|
|
54
55
|
/**
|
|
55
56
|
* Information about the booked service choices and participants.
|
|
56
|
-
* Available only when the booking includes multiple
|
|
57
|
+
* Available only when the booking includes multiple _service variants_
|
|
57
58
|
* ([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)).
|
|
58
59
|
*/
|
|
59
60
|
participantsChoices?: ParticipantChoices;
|
|
60
61
|
/**
|
|
61
62
|
* Booking ID.
|
|
63
|
+
* @format GUID
|
|
62
64
|
* @readonly
|
|
63
65
|
*/
|
|
64
66
|
id?: string | null;
|
|
65
67
|
/**
|
|
66
|
-
* An object describing the slot
|
|
68
|
+
* An object describing the *slot*
|
|
67
69
|
* ([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))
|
|
68
|
-
* or schedule
|
|
70
|
+
* or *schedule*
|
|
69
71
|
* ([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))
|
|
70
72
|
* that was booked.
|
|
71
73
|
*/
|
|
72
74
|
bookedEntity?: BookedEntity;
|
|
73
75
|
/**
|
|
74
|
-
* Contact details of the site visitor or
|
|
75
|
-
*
|
|
76
|
+
* Contact details of the site visitor or *member*
|
|
77
|
+
* ([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))
|
|
76
78
|
* making the booking.
|
|
77
79
|
*/
|
|
78
80
|
contactDetails?: ContactDetails;
|
|
@@ -87,7 +89,8 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
87
89
|
status?: BookingStatus;
|
|
88
90
|
/**
|
|
89
91
|
* The payment status of the booking corresponds to the `paymentStatus` of the
|
|
90
|
-
* related eCommerce order
|
|
92
|
+
* related *eCommerce order*
|
|
93
|
+
* ([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)),
|
|
91
94
|
* if one exists. All payment statuses are supported for every booking `status`.
|
|
92
95
|
*/
|
|
93
96
|
paymentStatus?: PaymentStatus;
|
|
@@ -96,8 +99,8 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
96
99
|
* checkout, they may still change the payment method. Must be one of the payment
|
|
97
100
|
* 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)),
|
|
98
101
|
* unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
99
|
-
* When undefined during an
|
|
100
|
-
*
|
|
102
|
+
* When undefined during an *eCommerce checkout*
|
|
103
|
+
* ([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)),
|
|
101
104
|
* Wix Bookings uses the service's default payment option
|
|
102
105
|
*/
|
|
103
106
|
selectedPaymentOption?: SelectedPaymentOption;
|
|
@@ -154,13 +157,14 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
154
157
|
export interface BookingParticipantsInfoOneOf {
|
|
155
158
|
/**
|
|
156
159
|
* Total number of participants. Available only when the relevant service
|
|
157
|
-
* doesn't have
|
|
160
|
+
* doesn't have _variants and options_
|
|
158
161
|
* ([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)).
|
|
162
|
+
* @min 1
|
|
159
163
|
*/
|
|
160
164
|
totalParticipants?: number;
|
|
161
165
|
/**
|
|
162
166
|
* Information about the booked service choices and participants.
|
|
163
|
-
* Available only when the booking includes multiple
|
|
167
|
+
* Available only when the booking includes multiple _service variants_
|
|
164
168
|
* ([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)).
|
|
165
169
|
*/
|
|
166
170
|
participantsChoices?: ParticipantChoices;
|
|
@@ -178,7 +182,7 @@ export declare enum MultiServiceBookingType {
|
|
|
178
182
|
}
|
|
179
183
|
export interface BookedEntity extends BookedEntityItemOneOf {
|
|
180
184
|
/**
|
|
181
|
-
* Booked slot
|
|
185
|
+
* Booked *slot*
|
|
182
186
|
* ([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)).
|
|
183
187
|
* Available only for appointment-based services and classes.
|
|
184
188
|
* For appointment-based services, a new session is created, while for classes,
|
|
@@ -186,7 +190,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
186
190
|
*/
|
|
187
191
|
slot?: BookedSlot;
|
|
188
192
|
/**
|
|
189
|
-
* Booked schedule
|
|
193
|
+
* Booked *schedule*
|
|
190
194
|
* ([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)).
|
|
191
195
|
* Available only for course bookings.
|
|
192
196
|
*/
|
|
@@ -195,6 +199,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
195
199
|
* Session title at the time of booking. If there is no pre-existing session,
|
|
196
200
|
* for example for appointment-based services, `title` is set to the service name.
|
|
197
201
|
* @readonly
|
|
202
|
+
* @maxLength 6000
|
|
198
203
|
*/
|
|
199
204
|
title?: string | null;
|
|
200
205
|
/**
|
|
@@ -209,7 +214,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
209
214
|
/** @oneof */
|
|
210
215
|
export interface BookedEntityItemOneOf {
|
|
211
216
|
/**
|
|
212
|
-
* Booked slot
|
|
217
|
+
* Booked *slot*
|
|
213
218
|
* ([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)).
|
|
214
219
|
* Available only for appointment-based services and classes.
|
|
215
220
|
* For appointment-based services, a new session is created, while for classes,
|
|
@@ -217,7 +222,7 @@ export interface BookedEntityItemOneOf {
|
|
|
217
222
|
*/
|
|
218
223
|
slot?: BookedSlot;
|
|
219
224
|
/**
|
|
220
|
-
* Booked schedule
|
|
225
|
+
* Booked *schedule*
|
|
221
226
|
* ([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)).
|
|
222
227
|
* Available only for course bookings.
|
|
223
228
|
*/
|
|
@@ -231,12 +236,14 @@ export interface BookedSlot {
|
|
|
231
236
|
/** Schedule ID. */
|
|
232
237
|
scheduleId?: string;
|
|
233
238
|
/**
|
|
234
|
-
* ID of the corresponding event
|
|
239
|
+
* ID of the corresponding *event*
|
|
235
240
|
* ([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)).
|
|
236
241
|
* Available for both appointment and class bookings, not available for course bookings.
|
|
237
242
|
* For appointment-based services, Wix Bookings automatically populates `eventId`
|
|
238
243
|
* when the booking `status` changes to `CONFIRMED`. For class bookings, it's
|
|
239
244
|
* automatically populated upon booking creation.
|
|
245
|
+
* @minLength 36
|
|
246
|
+
* @maxLength 250
|
|
240
247
|
*/
|
|
241
248
|
eventId?: string | null;
|
|
242
249
|
/**
|
|
@@ -252,9 +259,9 @@ export interface BookedSlot {
|
|
|
252
259
|
/** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
|
|
253
260
|
timezone?: string | null;
|
|
254
261
|
/**
|
|
255
|
-
* Primary resource
|
|
262
|
+
* Primary *resource*
|
|
256
263
|
* ([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))
|
|
257
|
-
* for the booking. For example, the staff member
|
|
264
|
+
* for the booking. For example, the *staff member*
|
|
258
265
|
* ([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))
|
|
259
266
|
* providing the
|
|
260
267
|
* service.
|
|
@@ -264,26 +271,42 @@ export interface BookedSlot {
|
|
|
264
271
|
location?: Location;
|
|
265
272
|
}
|
|
266
273
|
export interface BookedResource {
|
|
267
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* ID of the booking's primary resource.
|
|
276
|
+
* @format GUID
|
|
277
|
+
*/
|
|
268
278
|
id?: string;
|
|
269
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* Resource's name at the time of booking.
|
|
281
|
+
* @maxLength 40
|
|
282
|
+
*/
|
|
270
283
|
name?: string | null;
|
|
271
|
-
/**
|
|
284
|
+
/**
|
|
285
|
+
* Resource's email at the time of booking.
|
|
286
|
+
* @maxLength 500
|
|
287
|
+
*/
|
|
272
288
|
email?: string | null;
|
|
273
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* ID of the schedule belonging to the booking's primary resource.
|
|
291
|
+
* @format GUID
|
|
292
|
+
*/
|
|
274
293
|
scheduleId?: string | null;
|
|
275
294
|
}
|
|
276
295
|
export interface Location {
|
|
277
296
|
/**
|
|
278
297
|
* Business location ID. Available only for locations that are business locations,
|
|
279
298
|
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
299
|
+
* @format GUID
|
|
280
300
|
*/
|
|
281
301
|
id?: string | null;
|
|
282
302
|
/** Location name. */
|
|
283
303
|
name?: string | null;
|
|
284
304
|
/** The full address of this location. */
|
|
285
305
|
formattedAddress?: string | null;
|
|
286
|
-
/**
|
|
306
|
+
/**
|
|
307
|
+
* The full translated address of this location.
|
|
308
|
+
* @maxLength 512
|
|
309
|
+
*/
|
|
287
310
|
formattedAddressTranslated?: string | null;
|
|
288
311
|
/**
|
|
289
312
|
* Location type.
|
|
@@ -302,14 +325,17 @@ export declare enum LocationType {
|
|
|
302
325
|
}
|
|
303
326
|
export interface BookedSchedule {
|
|
304
327
|
/**
|
|
305
|
-
*
|
|
328
|
+
* _Schedule ID_
|
|
306
329
|
* ([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)).
|
|
307
330
|
*/
|
|
308
331
|
scheduleId?: string;
|
|
309
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Booked service ID.
|
|
334
|
+
* @format GUID
|
|
335
|
+
*/
|
|
310
336
|
serviceId?: string | null;
|
|
311
337
|
/**
|
|
312
|
-
*
|
|
338
|
+
* _Location_
|
|
313
339
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
314
340
|
* where the schedule's sessions take place.
|
|
315
341
|
* @readonly
|
|
@@ -334,7 +360,10 @@ export interface BookedSchedule {
|
|
|
334
360
|
lastSessionEnd?: string | null;
|
|
335
361
|
}
|
|
336
362
|
export interface ContactDetails {
|
|
337
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* Contact ID.
|
|
365
|
+
* @format GUID
|
|
366
|
+
*/
|
|
338
367
|
contactId?: string | null;
|
|
339
368
|
/**
|
|
340
369
|
* Contact's first name. When populated from a standard booking form, this
|
|
@@ -349,6 +378,7 @@ export interface ContactDetails {
|
|
|
349
378
|
* Used to validate coupon usage limitations per contact. If not specified,
|
|
350
379
|
* the coupon usage limitation will not be enforced. (Coupon usage limitation
|
|
351
380
|
* validation is not supported yet).
|
|
381
|
+
* @format EMAIL
|
|
352
382
|
*/
|
|
353
383
|
email?: string | null;
|
|
354
384
|
/** Contact's phone number. */
|
|
@@ -363,6 +393,7 @@ export interface ContactDetails {
|
|
|
363
393
|
/**
|
|
364
394
|
* Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
365
395
|
* format.
|
|
396
|
+
* @format COUNTRY
|
|
366
397
|
*/
|
|
367
398
|
countryCode?: string | null;
|
|
368
399
|
}
|
|
@@ -372,7 +403,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
372
403
|
streetAddress?: StreetAddress;
|
|
373
404
|
/** Main address line, usually street and number, as free text. */
|
|
374
405
|
addressLine?: string | null;
|
|
375
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* Country code.
|
|
408
|
+
* @format COUNTRY
|
|
409
|
+
*/
|
|
376
410
|
country?: string | null;
|
|
377
411
|
/** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
378
412
|
subdivision?: string | null;
|
|
@@ -421,7 +455,10 @@ export interface Subdivision {
|
|
|
421
455
|
name?: string;
|
|
422
456
|
}
|
|
423
457
|
export interface CustomFormField {
|
|
424
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* ID of the form field as defined in the form.
|
|
460
|
+
* @format GUID
|
|
461
|
+
*/
|
|
425
462
|
id?: string;
|
|
426
463
|
/** Value that was submitted for this field. */
|
|
427
464
|
value?: string | null;
|
|
@@ -449,16 +486,16 @@ export declare enum BookingStatus {
|
|
|
449
486
|
CREATED = "CREATED",
|
|
450
487
|
/**
|
|
451
488
|
* The merchant has confirmed the booking and it appears in the
|
|
452
|
-
* business calendar. Merchants can set up their services
|
|
489
|
+
* business calendar. Merchants can set up their *services*
|
|
453
490
|
* ([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))
|
|
454
491
|
* to automatically confirm all `PENDING` bookings.
|
|
455
492
|
*/
|
|
456
493
|
CONFIRMED = "CONFIRMED",
|
|
457
494
|
/**
|
|
458
495
|
* The customer has canceled the booking. Depending on the relevant service's
|
|
459
|
-
*
|
|
496
|
+
* _policy snapshot_
|
|
460
497
|
* ([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))
|
|
461
|
-
* they may have to pay a
|
|
498
|
+
* they may have to pay a _cancellation fee_
|
|
462
499
|
* ([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)).
|
|
463
500
|
*/
|
|
464
501
|
CANCELED = "CANCELED",
|
|
@@ -525,6 +562,7 @@ export interface BookingSource {
|
|
|
525
562
|
actor?: Actor;
|
|
526
563
|
/**
|
|
527
564
|
* Wix site ID of the application that created the booking.
|
|
565
|
+
* @format GUID
|
|
528
566
|
* @readonly
|
|
529
567
|
*/
|
|
530
568
|
appDefId?: string | null;
|
|
@@ -555,26 +593,53 @@ export interface ParticipantNotification {
|
|
|
555
593
|
message?: string | null;
|
|
556
594
|
}
|
|
557
595
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
558
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* ID of a site visitor that has not logged in to the site.
|
|
598
|
+
* @format GUID
|
|
599
|
+
*/
|
|
559
600
|
anonymousVisitorId?: string;
|
|
560
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* ID of a site visitor that has logged in to the site.
|
|
603
|
+
* @format GUID
|
|
604
|
+
*/
|
|
561
605
|
memberId?: string;
|
|
562
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
608
|
+
* @format GUID
|
|
609
|
+
*/
|
|
563
610
|
wixUserId?: string;
|
|
564
|
-
/**
|
|
611
|
+
/**
|
|
612
|
+
* ID of an app.
|
|
613
|
+
* @format GUID
|
|
614
|
+
*/
|
|
565
615
|
appId?: string;
|
|
566
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
618
|
+
* @format GUID
|
|
619
|
+
*/
|
|
567
620
|
contactId?: string | null;
|
|
568
621
|
}
|
|
569
622
|
/** @oneof */
|
|
570
623
|
export interface IdentificationDataIdOneOf {
|
|
571
|
-
/**
|
|
624
|
+
/**
|
|
625
|
+
* ID of a site visitor that has not logged in to the site.
|
|
626
|
+
* @format GUID
|
|
627
|
+
*/
|
|
572
628
|
anonymousVisitorId?: string;
|
|
573
|
-
/**
|
|
629
|
+
/**
|
|
630
|
+
* ID of a site visitor that has logged in to the site.
|
|
631
|
+
* @format GUID
|
|
632
|
+
*/
|
|
574
633
|
memberId?: string;
|
|
575
|
-
/**
|
|
634
|
+
/**
|
|
635
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
636
|
+
* @format GUID
|
|
637
|
+
*/
|
|
576
638
|
wixUserId?: string;
|
|
577
|
-
/**
|
|
639
|
+
/**
|
|
640
|
+
* ID of an app.
|
|
641
|
+
* @format GUID
|
|
642
|
+
*/
|
|
578
643
|
appId?: string;
|
|
579
644
|
}
|
|
580
645
|
export declare enum IdentityType {
|
|
@@ -589,7 +654,7 @@ export interface FlowControlSettings {
|
|
|
589
654
|
skipAvailabilityValidation?: boolean;
|
|
590
655
|
/**
|
|
591
656
|
* Whether the booking's `status` is automatically updated to `CONFIRMED` when
|
|
592
|
-
* the customer completes the eCommerce checkout
|
|
657
|
+
* the customer completes the *eCommerce checkout*
|
|
593
658
|
* ([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)),
|
|
594
659
|
* regardless of whether the relevant service requires manual business confirmation.
|
|
595
660
|
*/
|
|
@@ -618,16 +683,24 @@ export interface ExtendedFields {
|
|
|
618
683
|
namespaces?: Record<string, Record<string, any>>;
|
|
619
684
|
}
|
|
620
685
|
export interface ParticipantChoices {
|
|
621
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* Information about the booked service choices. Includes the number of participants.
|
|
688
|
+
* @minSize 1
|
|
689
|
+
* @maxSize 10
|
|
690
|
+
*/
|
|
622
691
|
serviceChoices?: ServiceChoices[];
|
|
623
692
|
}
|
|
624
693
|
export interface ServiceChoices {
|
|
625
694
|
/**
|
|
626
|
-
* Number of participants for this
|
|
695
|
+
* Number of participants for this _variant_
|
|
627
696
|
* ([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)).
|
|
697
|
+
* @min 1
|
|
628
698
|
*/
|
|
629
699
|
numberOfParticipants?: number | null;
|
|
630
|
-
/**
|
|
700
|
+
/**
|
|
701
|
+
* Service choices for these participants.
|
|
702
|
+
* @maxSize 5
|
|
703
|
+
*/
|
|
631
704
|
choices?: ServiceChoice[];
|
|
632
705
|
}
|
|
633
706
|
export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
@@ -643,6 +716,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
643
716
|
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
644
717
|
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
645
718
|
* for the `ageGroup` option.
|
|
719
|
+
* @format GUID
|
|
646
720
|
*/
|
|
647
721
|
optionId?: string;
|
|
648
722
|
}
|
|
@@ -661,17 +735,21 @@ export interface Duration {
|
|
|
661
735
|
/**
|
|
662
736
|
* Duration of the service in minutes.
|
|
663
737
|
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
738
|
+
* @min 1
|
|
739
|
+
* @max 44639
|
|
664
740
|
*/
|
|
665
741
|
minutes?: number;
|
|
666
742
|
/**
|
|
667
743
|
* Name of the duration option.
|
|
668
744
|
* Defaults to the formatted duration e.g. "1 hour, 30 minutes".
|
|
745
|
+
* @maxLength 255
|
|
669
746
|
*/
|
|
670
747
|
name?: string | null;
|
|
671
748
|
}
|
|
672
749
|
export interface MultiServiceBookingInfo {
|
|
673
750
|
/**
|
|
674
751
|
* Multi-service booking ID.
|
|
752
|
+
* @format GUID
|
|
675
753
|
* @readonly
|
|
676
754
|
*/
|
|
677
755
|
id?: string | null;
|
|
@@ -694,6 +772,7 @@ export interface AllowedActions {
|
|
|
694
772
|
export interface Attendance {
|
|
695
773
|
/**
|
|
696
774
|
* ID of the attendance object.
|
|
775
|
+
* @format GUID
|
|
697
776
|
* @readonly
|
|
698
777
|
*/
|
|
699
778
|
id?: string | null;
|
|
@@ -706,9 +785,17 @@ export interface Attendance {
|
|
|
706
785
|
numberOfAttendees?: number;
|
|
707
786
|
}
|
|
708
787
|
export interface ConferencingDetails {
|
|
709
|
-
/**
|
|
788
|
+
/**
|
|
789
|
+
* URL used by a guest to join the conference.
|
|
790
|
+
* @minLength 1
|
|
791
|
+
* @maxLength 2000
|
|
792
|
+
*/
|
|
710
793
|
guestUrl?: string | null;
|
|
711
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* Conference password.
|
|
796
|
+
* @minLength 1
|
|
797
|
+
* @maxLength 100
|
|
798
|
+
*/
|
|
712
799
|
password?: string | null;
|
|
713
800
|
}
|
|
714
801
|
export interface BookingPolicySettings {
|
|
@@ -781,7 +868,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
781
868
|
cursorPaging?: CursorPaging;
|
|
782
869
|
}
|
|
783
870
|
export interface Sorting {
|
|
784
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Name of the field to sort by.
|
|
873
|
+
* @maxLength 512
|
|
874
|
+
*/
|
|
785
875
|
fieldName?: string;
|
|
786
876
|
/** Sort order. */
|
|
787
877
|
order?: SortOrder;
|
|
@@ -797,13 +887,17 @@ export interface Paging {
|
|
|
797
887
|
offset?: number | null;
|
|
798
888
|
}
|
|
799
889
|
export interface CursorPaging {
|
|
800
|
-
/**
|
|
890
|
+
/**
|
|
891
|
+
* Maximum number of items to return in the results.
|
|
892
|
+
* @max 100
|
|
893
|
+
*/
|
|
801
894
|
limit?: number | null;
|
|
802
895
|
/**
|
|
803
896
|
* Pointer to the next or previous page in the list of results.
|
|
804
897
|
*
|
|
805
898
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
806
899
|
* Not relevant for the first request.
|
|
900
|
+
* @maxLength 16000
|
|
807
901
|
*/
|
|
808
902
|
cursor?: string | null;
|
|
809
903
|
}
|
|
@@ -831,9 +925,15 @@ export interface PagingMetadataV2 {
|
|
|
831
925
|
cursors?: Cursors;
|
|
832
926
|
}
|
|
833
927
|
export interface Cursors {
|
|
834
|
-
/**
|
|
928
|
+
/**
|
|
929
|
+
* Cursor string pointing to the next page in the list of results.
|
|
930
|
+
* @maxLength 16000
|
|
931
|
+
*/
|
|
835
932
|
next?: string | null;
|
|
836
|
-
/**
|
|
933
|
+
/**
|
|
934
|
+
* Cursor pointing to the previous page in the list of results.
|
|
935
|
+
* @maxLength 16000
|
|
936
|
+
*/
|
|
837
937
|
prev?: string | null;
|
|
838
938
|
}
|
|
839
939
|
export interface QueryExtendedBookingsRequest {
|
|
@@ -48,16 +48,16 @@ var BookingStatus;
|
|
|
48
48
|
BookingStatus["CREATED"] = "CREATED";
|
|
49
49
|
/**
|
|
50
50
|
* The merchant has confirmed the booking and it appears in the
|
|
51
|
-
* business calendar. Merchants can set up their services
|
|
51
|
+
* business calendar. Merchants can set up their *services*
|
|
52
52
|
* ([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))
|
|
53
53
|
* to automatically confirm all `PENDING` bookings.
|
|
54
54
|
*/
|
|
55
55
|
BookingStatus["CONFIRMED"] = "CONFIRMED";
|
|
56
56
|
/**
|
|
57
57
|
* The customer has canceled the booking. Depending on the relevant service's
|
|
58
|
-
*
|
|
58
|
+
* _policy snapshot_
|
|
59
59
|
* ([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))
|
|
60
|
-
* they may have to pay a
|
|
60
|
+
* they may have to pay a _cancellation fee_
|
|
61
61
|
* ([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)).
|
|
62
62
|
*/
|
|
63
63
|
BookingStatus["CANCELED"] = "CANCELED";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-reader-v2-extended-booking-extended-bookings.types.js","sourceRoot":"","sources":["../../../src/bookings-reader-v2-extended-booking-extended-bookings.types.ts"],"names":[],"mappings":";;;AAsCA,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,oDAAoD;IACpD,uCAAmB,CAAA;IACnB,0DAA0D;IAC1D,yCAAqB,CAAA;IACrB,4CAA4C;IAC5C,iDAA6B,CAAA;AAC/B,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;
|
|
1
|
+
{"version":3,"file":"bookings-reader-v2-extended-booking-extended-bookings.types.js","sourceRoot":"","sources":["../../../src/bookings-reader-v2-extended-booking-extended-bookings.types.ts"],"names":[],"mappings":";;;AAsCA,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,oDAAoD;IACpD,uCAAmB,CAAA;IACnB,0DAA0D;IAC1D,yCAAqB,CAAA;IACrB,4CAA4C;IAC5C,iDAA6B,CAAA;AAC/B,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAkID;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;IACvC,kEAAuC,CAAA;AACzC,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAgJD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA4JD,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kDAAkD;IAClD,sCAAyB,CAAA;IACzB,iBAAiB;IACjB,oCAAuB,CAAA;IACvB,sGAAsG;IACtG,oCAAuB,CAAA;AACzB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAED,sBAAsB;AACtB,IAAY,aAoCX;AApCD,WAAY,aAAa;IACvB;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;;;OAKG;IACH,wCAAuB,CAAA;IACvB;;;;;;OAMG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,oCAAmB,CAAA;IACnB,6EAA6E;IAC7E,sCAAqB,CAAA;IACrB;;;;;;OAMG;IACH,8CAA6B,CAAA;AAC/B,CAAC,EApCW,aAAa,6BAAb,aAAa,QAoCxB;AAED;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,8BAA8B;IAC9B,sCAAqB,CAAA;IACrB,iCAAiC;IACjC,8BAAa,CAAA;IACb,qCAAqC;IACrC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,qCAAqC;IACrC,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;;;;GAMG;AACH,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,gCAAgC;IAChC,gDAAuB,CAAA;IACvB,uBAAuB;IACvB,4CAAmB,CAAA;IACnB,sBAAsB;IACtB,0CAAiB,CAAA;IACjB,wCAAwC;IACxC,kDAAyB,CAAA;IACzB;;;OAGG;IACH,kEAAyC,CAAA;AAC3C,CAAC,EAdW,qBAAqB,qCAArB,qBAAqB,QAchC;AAoBD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qDAAyC,CAAA;IACzC,uBAAW,CAAA;IACX,qCAAyB,CAAA;AAC3B,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4CAAmC,CAAA;IACnC,8BAAqB,CAAA;IACrB,8BAAqB,CAAA;AACvB,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAiED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA4KD,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,4DAA4D;IAC5D,qDAAiC,CAAA;IACjC,sEAAsE;IACtE,yEAAqD,CAAA;IACrD,4FAA4F;IAC5F,yDAAqC,CAAA;AACvC,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAoED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|