@wix/auto_sdk_bookings_bookings 1.0.15 → 1.0.16
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/{es/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-r9r1xC1y.d.mts} +626 -232
- package/build/{cjs/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-r9r1xC1y.d.ts} +626 -232
- package/build/{es/src/bookings-v2-booking-bookings.public.d.ts → index.d.mts} +78 -34
- package/build/{internal/cjs/src/bookings-v2-booking-bookings.public.d.ts → index.d.ts} +78 -34
- package/build/index.js +2387 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2323 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-r9r1xC1y.d.mts} +626 -232
- package/build/internal/{es/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-r9r1xC1y.d.ts} +626 -232
- package/build/{cjs/src/bookings-v2-booking-bookings.public.d.ts → internal/index.d.mts} +78 -34
- package/build/internal/{es/src/bookings-v2-booking-bookings.public.d.ts → index.d.ts} +78 -34
- package/build/internal/index.js +2387 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2323 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +1652 -0
- package/build/internal/meta.d.ts +1652 -0
- package/build/internal/meta.js +1522 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1475 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1652 -0
- package/build/meta.d.ts +1652 -0
- package/build/meta.js +1522 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1475 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.context.d.ts +0 -61
- package/build/cjs/src/bookings-v2-booking-bookings.context.js +0 -77
- package/build/cjs/src/bookings-v2-booking-bookings.context.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.http.d.ts +0 -510
- package/build/cjs/src/bookings-v2-booking-bookings.http.js +0 -1579
- package/build/cjs/src/bookings-v2-booking-bookings.http.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.meta.d.ts +0 -61
- package/build/cjs/src/bookings-v2-booking-bookings.meta.js +0 -427
- package/build/cjs/src/bookings-v2-booking-bookings.meta.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.public.js +0 -313
- package/build/cjs/src/bookings-v2-booking-bookings.public.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.types.js +0 -165
- package/build/cjs/src/bookings-v2-booking-bookings.types.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking-bookings.universal.d.ts +0 -4382
- package/build/cjs/src/bookings-v2-booking-bookings.universal.js +0 -1692
- package/build/cjs/src/bookings-v2-booking-bookings.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/bookings-v2-booking-bookings.context.d.ts +0 -61
- package/build/es/src/bookings-v2-booking-bookings.context.js +0 -61
- package/build/es/src/bookings-v2-booking-bookings.context.js.map +0 -1
- package/build/es/src/bookings-v2-booking-bookings.http.d.ts +0 -510
- package/build/es/src/bookings-v2-booking-bookings.http.js +0 -1555
- package/build/es/src/bookings-v2-booking-bookings.http.js.map +0 -1
- package/build/es/src/bookings-v2-booking-bookings.meta.d.ts +0 -61
- package/build/es/src/bookings-v2-booking-bookings.meta.js +0 -380
- package/build/es/src/bookings-v2-booking-bookings.meta.js.map +0 -1
- package/build/es/src/bookings-v2-booking-bookings.public.js +0 -276
- package/build/es/src/bookings-v2-booking-bookings.public.js.map +0 -1
- package/build/es/src/bookings-v2-booking-bookings.types.js +0 -162
- package/build/es/src/bookings-v2-booking-bookings.types.js.map +0 -1
- package/build/es/src/bookings-v2-booking-bookings.universal.d.ts +0 -4382
- package/build/es/src/bookings-v2-booking-bookings.universal.js +0 -1645
- package/build/es/src/bookings-v2-booking-bookings.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.d.ts +0 -61
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.js +0 -77
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.d.ts +0 -510
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.js +0 -1579
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.d.ts +0 -61
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.js +0 -427
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.public.js +0 -313
- package/build/internal/cjs/src/bookings-v2-booking-bookings.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.types.js +0 -165
- package/build/internal/cjs/src/bookings-v2-booking-bookings.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.d.ts +0 -4382
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.js +0 -1692
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.context.d.ts +0 -61
- package/build/internal/es/src/bookings-v2-booking-bookings.context.js +0 -61
- package/build/internal/es/src/bookings-v2-booking-bookings.context.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.http.d.ts +0 -510
- package/build/internal/es/src/bookings-v2-booking-bookings.http.js +0 -1555
- package/build/internal/es/src/bookings-v2-booking-bookings.http.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.d.ts +0 -61
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.js +0 -380
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.public.js +0 -276
- package/build/internal/es/src/bookings-v2-booking-bookings.public.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.types.js +0 -162
- package/build/internal/es/src/bookings-v2-booking-bookings.types.js.map +0 -1
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.d.ts +0 -4382
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.js +0 -1645
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.js.map +0 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** An entity representing a scheduled appointment, class session, or course. */
|
|
2
|
-
|
|
2
|
+
interface Booking extends BookingParticipantsInfoOneOf {
|
|
3
3
|
/**
|
|
4
4
|
* Total number of participants. Available only when the relevant service
|
|
5
5
|
* doesn't have _variants and options_
|
|
@@ -18,7 +18,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
18
18
|
* @format GUID
|
|
19
19
|
* @readonly
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
_id?: string | null;
|
|
22
22
|
/**
|
|
23
23
|
* An object describing the *slot*
|
|
24
24
|
* ([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))
|
|
@@ -63,7 +63,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
63
63
|
* Date and time the booking was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
64
64
|
* @readonly
|
|
65
65
|
*/
|
|
66
|
-
|
|
66
|
+
_createdDate?: Date | null;
|
|
67
67
|
/** External user ID that you can provide. */
|
|
68
68
|
externalUserId?: string | null;
|
|
69
69
|
/**
|
|
@@ -95,7 +95,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
95
95
|
* Date and time the booking was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
96
96
|
* @readonly
|
|
97
97
|
*/
|
|
98
|
-
|
|
98
|
+
_updatedDate?: Date | null;
|
|
99
99
|
/**
|
|
100
100
|
* Custom field data for this object.
|
|
101
101
|
* Extended fields must be configured in the app dashboard before they can be accessed with API calls.
|
|
@@ -109,7 +109,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
109
109
|
doubleBooked?: boolean | null;
|
|
110
110
|
}
|
|
111
111
|
/** @oneof */
|
|
112
|
-
|
|
112
|
+
interface BookingParticipantsInfoOneOf {
|
|
113
113
|
/**
|
|
114
114
|
* Total number of participants. Available only when the relevant service
|
|
115
115
|
* doesn't have _variants and options_
|
|
@@ -130,12 +130,12 @@ export interface BookingParticipantsInfoOneOf {
|
|
|
130
130
|
* Multi-service booking is available if each of its bookings is available separately.
|
|
131
131
|
* For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
|
|
132
132
|
*/
|
|
133
|
-
|
|
133
|
+
declare enum MultiServiceBookingType {
|
|
134
134
|
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
135
135
|
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
136
136
|
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
137
137
|
}
|
|
138
|
-
|
|
138
|
+
interface BookedEntity extends BookedEntityItemOneOf {
|
|
139
139
|
/**
|
|
140
140
|
* Booked *slot*
|
|
141
141
|
* ([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)).
|
|
@@ -167,7 +167,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
167
167
|
tags?: string[] | null;
|
|
168
168
|
}
|
|
169
169
|
/** @oneof */
|
|
170
|
-
|
|
170
|
+
interface BookedEntityItemOneOf {
|
|
171
171
|
/**
|
|
172
172
|
* Booked *slot*
|
|
173
173
|
* ([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,7 +183,7 @@ export interface BookedEntityItemOneOf {
|
|
|
183
183
|
*/
|
|
184
184
|
schedule?: BookedSchedule;
|
|
185
185
|
}
|
|
186
|
-
|
|
186
|
+
interface BookedSlot {
|
|
187
187
|
/** Session ID. */
|
|
188
188
|
sessionId?: string | null;
|
|
189
189
|
/** Service ID. */
|
|
@@ -225,12 +225,12 @@ export interface BookedSlot {
|
|
|
225
225
|
/** Location where the session takes place. */
|
|
226
226
|
location?: Location;
|
|
227
227
|
}
|
|
228
|
-
|
|
228
|
+
interface BookedResource {
|
|
229
229
|
/**
|
|
230
230
|
* ID of the booking's primary resource.
|
|
231
231
|
* @format GUID
|
|
232
232
|
*/
|
|
233
|
-
|
|
233
|
+
_id?: string;
|
|
234
234
|
/**
|
|
235
235
|
* Resource's name at the time of booking.
|
|
236
236
|
* @maxLength 40
|
|
@@ -247,13 +247,13 @@ export interface BookedResource {
|
|
|
247
247
|
*/
|
|
248
248
|
scheduleId?: string | null;
|
|
249
249
|
}
|
|
250
|
-
|
|
250
|
+
interface Location {
|
|
251
251
|
/**
|
|
252
252
|
* Business location ID. Available only for locations that are business locations,
|
|
253
253
|
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
254
254
|
* @format GUID
|
|
255
255
|
*/
|
|
256
|
-
|
|
256
|
+
_id?: string | null;
|
|
257
257
|
/** Location name. */
|
|
258
258
|
name?: string | null;
|
|
259
259
|
/** The full address of this location. */
|
|
@@ -272,13 +272,13 @@ export interface Location {
|
|
|
272
272
|
*/
|
|
273
273
|
locationType?: LocationType;
|
|
274
274
|
}
|
|
275
|
-
|
|
275
|
+
declare enum LocationType {
|
|
276
276
|
UNDEFINED = "UNDEFINED",
|
|
277
277
|
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
278
278
|
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
279
279
|
CUSTOM = "CUSTOM"
|
|
280
280
|
}
|
|
281
|
-
|
|
281
|
+
interface BookedSchedule {
|
|
282
282
|
/**
|
|
283
283
|
* _Schedule ID_
|
|
284
284
|
* ([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)).
|
|
@@ -314,7 +314,7 @@ export interface BookedSchedule {
|
|
|
314
314
|
*/
|
|
315
315
|
lastSessionEnd?: string | null;
|
|
316
316
|
}
|
|
317
|
-
|
|
317
|
+
interface ContactDetails {
|
|
318
318
|
/**
|
|
319
319
|
* Contact ID.
|
|
320
320
|
* @format GUID
|
|
@@ -353,7 +353,7 @@ export interface ContactDetails {
|
|
|
353
353
|
countryCode?: string | null;
|
|
354
354
|
}
|
|
355
355
|
/** Physical address */
|
|
356
|
-
|
|
356
|
+
interface Address extends AddressStreetOneOf {
|
|
357
357
|
/** Street name, number and apartment number. */
|
|
358
358
|
streetAddress?: StreetAddress;
|
|
359
359
|
/** Main address line, usually street and number, as free text. */
|
|
@@ -383,13 +383,13 @@ export interface Address extends AddressStreetOneOf {
|
|
|
383
383
|
subdivisions?: Subdivision[];
|
|
384
384
|
}
|
|
385
385
|
/** @oneof */
|
|
386
|
-
|
|
386
|
+
interface AddressStreetOneOf {
|
|
387
387
|
/** Street name, number and apartment number. */
|
|
388
388
|
streetAddress?: StreetAddress;
|
|
389
389
|
/** Main address line, usually street and number, as free text. */
|
|
390
390
|
addressLine?: string | null;
|
|
391
391
|
}
|
|
392
|
-
|
|
392
|
+
interface StreetAddress {
|
|
393
393
|
/** Street number. */
|
|
394
394
|
number?: string;
|
|
395
395
|
/** Street name. */
|
|
@@ -397,24 +397,24 @@ export interface StreetAddress {
|
|
|
397
397
|
/** Apartment number. */
|
|
398
398
|
apt?: string;
|
|
399
399
|
}
|
|
400
|
-
|
|
400
|
+
interface AddressLocation {
|
|
401
401
|
/** Address latitude. */
|
|
402
402
|
latitude?: number | null;
|
|
403
403
|
/** Address longitude. */
|
|
404
404
|
longitude?: number | null;
|
|
405
405
|
}
|
|
406
|
-
|
|
406
|
+
interface Subdivision {
|
|
407
407
|
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
408
408
|
code?: string;
|
|
409
409
|
/** Subdivision full name. */
|
|
410
410
|
name?: string;
|
|
411
411
|
}
|
|
412
|
-
|
|
412
|
+
interface CustomFormField {
|
|
413
413
|
/**
|
|
414
414
|
* ID of the form field as defined in the form.
|
|
415
415
|
* @format GUID
|
|
416
416
|
*/
|
|
417
|
-
|
|
417
|
+
_id?: string;
|
|
418
418
|
/** Value that was submitted for this field. */
|
|
419
419
|
value?: string | null;
|
|
420
420
|
/**
|
|
@@ -424,7 +424,7 @@ export interface CustomFormField {
|
|
|
424
424
|
label?: string | null;
|
|
425
425
|
valueType?: ValueType;
|
|
426
426
|
}
|
|
427
|
-
|
|
427
|
+
declare enum ValueType {
|
|
428
428
|
/** Short text. This is the default value type. */
|
|
429
429
|
SHORT_TEXT = "SHORT_TEXT",
|
|
430
430
|
/** Long text. */
|
|
@@ -433,7 +433,7 @@ export declare enum ValueType {
|
|
|
433
433
|
CHECK_BOX = "CHECK_BOX"
|
|
434
434
|
}
|
|
435
435
|
/** Booking status. */
|
|
436
|
-
|
|
436
|
+
declare enum BookingStatus {
|
|
437
437
|
/**
|
|
438
438
|
* The booking was created, but the customer hasn't completed the related
|
|
439
439
|
* eCommerce order yet.
|
|
@@ -474,7 +474,7 @@ export declare enum BookingStatus {
|
|
|
474
474
|
* Payment status.
|
|
475
475
|
* Automatically updated when using eCommerce checkout APIs.
|
|
476
476
|
*/
|
|
477
|
-
|
|
477
|
+
declare enum PaymentStatus {
|
|
478
478
|
/** Undefined payment status. */
|
|
479
479
|
UNDEFINED = "UNDEFINED",
|
|
480
480
|
/** The booking isn't paid. */
|
|
@@ -495,7 +495,7 @@ export declare enum PaymentStatus {
|
|
|
495
495
|
* This field is set when the user selects an option during booking.
|
|
496
496
|
* If left undefined, the payment option is resolved by the service configuration on checkout.
|
|
497
497
|
*/
|
|
498
|
-
|
|
498
|
+
declare enum SelectedPaymentOption {
|
|
499
499
|
/** Undefined payment option. */
|
|
500
500
|
UNDEFINED = "UNDEFINED",
|
|
501
501
|
/** Offline payment. */
|
|
@@ -510,7 +510,7 @@ export declare enum SelectedPaymentOption {
|
|
|
510
510
|
*/
|
|
511
511
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
512
512
|
}
|
|
513
|
-
|
|
513
|
+
interface BookingSource {
|
|
514
514
|
/** Platform from which a booking was created. */
|
|
515
515
|
platform?: Platform;
|
|
516
516
|
/** Actor that created this booking. */
|
|
@@ -527,17 +527,17 @@ export interface BookingSource {
|
|
|
527
527
|
*/
|
|
528
528
|
appName?: string | null;
|
|
529
529
|
}
|
|
530
|
-
|
|
530
|
+
declare enum Platform {
|
|
531
531
|
UNDEFINED_PLATFORM = "UNDEFINED_PLATFORM",
|
|
532
532
|
WEB = "WEB",
|
|
533
533
|
MOBILE_APP = "MOBILE_APP"
|
|
534
534
|
}
|
|
535
|
-
|
|
535
|
+
declare enum Actor {
|
|
536
536
|
UNDEFINED_ACTOR = "UNDEFINED_ACTOR",
|
|
537
537
|
BUSINESS = "BUSINESS",
|
|
538
538
|
CUSTOMER = "CUSTOMER"
|
|
539
539
|
}
|
|
540
|
-
|
|
540
|
+
interface ParticipantNotification {
|
|
541
541
|
/**
|
|
542
542
|
* Whether to send the message about the changes to the customer.
|
|
543
543
|
*
|
|
@@ -547,7 +547,7 @@ export interface ParticipantNotification {
|
|
|
547
547
|
/** Custom message to send to the participants about the changes to the booking. */
|
|
548
548
|
message?: string | null;
|
|
549
549
|
}
|
|
550
|
-
|
|
550
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
551
551
|
/**
|
|
552
552
|
* ID of a site visitor that has not logged in to the site.
|
|
553
553
|
* @format GUID
|
|
@@ -575,7 +575,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
575
575
|
contactId?: string | null;
|
|
576
576
|
}
|
|
577
577
|
/** @oneof */
|
|
578
|
-
|
|
578
|
+
interface CommonIdentificationDataIdOneOf {
|
|
579
579
|
/**
|
|
580
580
|
* ID of a site visitor that has not logged in to the site.
|
|
581
581
|
* @format GUID
|
|
@@ -597,14 +597,14 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
597
597
|
*/
|
|
598
598
|
appId?: string;
|
|
599
599
|
}
|
|
600
|
-
|
|
600
|
+
declare enum IdentificationDataIdentityType {
|
|
601
601
|
UNKNOWN = "UNKNOWN",
|
|
602
602
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
603
603
|
MEMBER = "MEMBER",
|
|
604
604
|
WIX_USER = "WIX_USER",
|
|
605
605
|
APP = "APP"
|
|
606
606
|
}
|
|
607
|
-
|
|
607
|
+
interface FlowControlSettings {
|
|
608
608
|
/** Whether availability is checked when creating or confirming the booking. */
|
|
609
609
|
skipAvailabilityValidation?: boolean;
|
|
610
610
|
/**
|
|
@@ -626,7 +626,7 @@ export interface FlowControlSettings {
|
|
|
626
626
|
*/
|
|
627
627
|
withRefund?: boolean | null;
|
|
628
628
|
}
|
|
629
|
-
|
|
629
|
+
interface ExtendedFields {
|
|
630
630
|
/**
|
|
631
631
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
632
632
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -637,7 +637,7 @@ export interface ExtendedFields {
|
|
|
637
637
|
*/
|
|
638
638
|
namespaces?: Record<string, Record<string, any>>;
|
|
639
639
|
}
|
|
640
|
-
|
|
640
|
+
interface ParticipantChoices {
|
|
641
641
|
/**
|
|
642
642
|
* Information about the booked service choices. Includes the number of participants.
|
|
643
643
|
* @minSize 1
|
|
@@ -645,7 +645,7 @@ export interface ParticipantChoices {
|
|
|
645
645
|
*/
|
|
646
646
|
serviceChoices?: ServiceChoices[];
|
|
647
647
|
}
|
|
648
|
-
|
|
648
|
+
interface ServiceChoices {
|
|
649
649
|
/**
|
|
650
650
|
* Number of participants for this _variant_
|
|
651
651
|
* ([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)).
|
|
@@ -658,7 +658,7 @@ export interface ServiceChoices {
|
|
|
658
658
|
*/
|
|
659
659
|
choices?: ServiceChoice[];
|
|
660
660
|
}
|
|
661
|
-
|
|
661
|
+
interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
662
662
|
/**
|
|
663
663
|
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
664
664
|
* Choices are specific values for an option the customer can choose to book. For example,
|
|
@@ -676,7 +676,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
676
676
|
optionId?: string;
|
|
677
677
|
}
|
|
678
678
|
/** @oneof */
|
|
679
|
-
|
|
679
|
+
interface ServiceChoiceChoiceOneOf {
|
|
680
680
|
/**
|
|
681
681
|
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
682
682
|
* Choices are specific values for an option the customer can choose to book. For example,
|
|
@@ -686,7 +686,7 @@ export interface ServiceChoiceChoiceOneOf {
|
|
|
686
686
|
custom?: string;
|
|
687
687
|
duration?: Duration;
|
|
688
688
|
}
|
|
689
|
-
|
|
689
|
+
interface Duration {
|
|
690
690
|
/**
|
|
691
691
|
* Duration of the service in minutes.
|
|
692
692
|
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
@@ -701,22 +701,22 @@ export interface Duration {
|
|
|
701
701
|
*/
|
|
702
702
|
name?: string | null;
|
|
703
703
|
}
|
|
704
|
-
|
|
704
|
+
interface MultiServiceBookingInfo {
|
|
705
705
|
/**
|
|
706
706
|
* Multi-service booking ID.
|
|
707
707
|
* @format GUID
|
|
708
708
|
* @readonly
|
|
709
709
|
*/
|
|
710
|
-
|
|
710
|
+
_id?: string | null;
|
|
711
711
|
/** Type of the multi-service booking. */
|
|
712
712
|
type?: MultiServiceBookingType;
|
|
713
713
|
}
|
|
714
|
-
|
|
714
|
+
interface BookedAddOn {
|
|
715
715
|
/**
|
|
716
716
|
* The ID of the Add-On.
|
|
717
717
|
* @format GUID
|
|
718
718
|
*/
|
|
719
|
-
|
|
719
|
+
_id?: string;
|
|
720
720
|
/**
|
|
721
721
|
* The ID of the Add-Ons group.
|
|
722
722
|
* @format GUID
|
|
@@ -725,7 +725,7 @@ export interface BookedAddOn {
|
|
|
725
725
|
/** The Add-On duration in minutes at the time of Booking. */
|
|
726
726
|
durationInMinutes?: number | null;
|
|
727
727
|
}
|
|
728
|
-
|
|
728
|
+
interface BookingFormFilled {
|
|
729
729
|
/** The booking object that form was filled for. */
|
|
730
730
|
booking?: Booking;
|
|
731
731
|
/**
|
|
@@ -741,7 +741,7 @@ export interface BookingFormFilled {
|
|
|
741
741
|
*/
|
|
742
742
|
formId?: string | null;
|
|
743
743
|
}
|
|
744
|
-
|
|
744
|
+
interface SetBookingFormAndSubmissionIdRequest extends SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
745
745
|
/**
|
|
746
746
|
* The visitor who created the booking.
|
|
747
747
|
* @format GUID
|
|
@@ -784,7 +784,7 @@ export interface SetBookingFormAndSubmissionIdRequest extends SetBookingFormAndS
|
|
|
784
784
|
instanceId?: string | null;
|
|
785
785
|
}
|
|
786
786
|
/** @oneof */
|
|
787
|
-
|
|
787
|
+
interface SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
788
788
|
/**
|
|
789
789
|
* The visitor who created the booking.
|
|
790
790
|
* @format GUID
|
|
@@ -801,11 +801,11 @@ export interface SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
|
801
801
|
*/
|
|
802
802
|
appId?: string | null;
|
|
803
803
|
}
|
|
804
|
-
|
|
804
|
+
interface SetBookingFormAndSubmissionIdResponse {
|
|
805
805
|
/** Updated booking. */
|
|
806
806
|
booking?: Booking;
|
|
807
807
|
}
|
|
808
|
-
|
|
808
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
809
809
|
createdEvent?: EntityCreatedEvent;
|
|
810
810
|
updatedEvent?: EntityUpdatedEvent;
|
|
811
811
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -814,7 +814,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
814
814
|
* Unique event ID.
|
|
815
815
|
* Allows clients to ignore duplicate webhooks.
|
|
816
816
|
*/
|
|
817
|
-
|
|
817
|
+
_id?: string;
|
|
818
818
|
/**
|
|
819
819
|
* Assumes actions are also always typed to an entity_type
|
|
820
820
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -848,36 +848,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
848
848
|
entityEventSequence?: string | null;
|
|
849
849
|
}
|
|
850
850
|
/** @oneof */
|
|
851
|
-
|
|
851
|
+
interface DomainEventBodyOneOf {
|
|
852
852
|
createdEvent?: EntityCreatedEvent;
|
|
853
853
|
updatedEvent?: EntityUpdatedEvent;
|
|
854
854
|
deletedEvent?: EntityDeletedEvent;
|
|
855
855
|
actionEvent?: ActionEvent;
|
|
856
856
|
}
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
860
|
-
restoreInfo?: RestoreInfo;
|
|
857
|
+
interface EntityCreatedEvent {
|
|
858
|
+
entity?: string;
|
|
861
859
|
}
|
|
862
|
-
|
|
860
|
+
interface RestoreInfo {
|
|
863
861
|
deletedDate?: Date | null;
|
|
864
862
|
}
|
|
865
|
-
|
|
863
|
+
interface EntityUpdatedEvent {
|
|
866
864
|
/**
|
|
867
865
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
868
866
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
869
867
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
870
868
|
*/
|
|
871
|
-
|
|
869
|
+
currentEntity?: string;
|
|
872
870
|
}
|
|
873
|
-
|
|
871
|
+
interface EntityDeletedEvent {
|
|
874
872
|
/** Entity that was deleted */
|
|
875
|
-
|
|
873
|
+
deletedEntity?: string | null;
|
|
876
874
|
}
|
|
877
|
-
|
|
878
|
-
|
|
875
|
+
interface ActionEvent {
|
|
876
|
+
body?: string;
|
|
879
877
|
}
|
|
880
|
-
|
|
878
|
+
interface MessageEnvelope {
|
|
881
879
|
/**
|
|
882
880
|
* App instance ID.
|
|
883
881
|
* @format GUID
|
|
@@ -893,7 +891,7 @@ export interface MessageEnvelope {
|
|
|
893
891
|
/** Stringify payload. */
|
|
894
892
|
data?: string;
|
|
895
893
|
}
|
|
896
|
-
|
|
894
|
+
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
897
895
|
/**
|
|
898
896
|
* ID of a site visitor that has not logged in to the site.
|
|
899
897
|
* @format GUID
|
|
@@ -918,7 +916,7 @@ export interface WebhooksIdentificationData extends WebhooksIdentificationDataId
|
|
|
918
916
|
identityType?: WebhookIdentityType;
|
|
919
917
|
}
|
|
920
918
|
/** @oneof */
|
|
921
|
-
|
|
919
|
+
interface WebhooksIdentificationDataIdOneOf {
|
|
922
920
|
/**
|
|
923
921
|
* ID of a site visitor that has not logged in to the site.
|
|
924
922
|
* @format GUID
|
|
@@ -940,14 +938,14 @@ export interface WebhooksIdentificationDataIdOneOf {
|
|
|
940
938
|
*/
|
|
941
939
|
appId?: string;
|
|
942
940
|
}
|
|
943
|
-
|
|
941
|
+
declare enum WebhookIdentityType {
|
|
944
942
|
UNKNOWN = "UNKNOWN",
|
|
945
943
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
946
944
|
MEMBER = "MEMBER",
|
|
947
945
|
WIX_USER = "WIX_USER",
|
|
948
946
|
APP = "APP"
|
|
949
947
|
}
|
|
950
|
-
|
|
948
|
+
interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {
|
|
951
949
|
/**
|
|
952
950
|
* Information about the slot to create a booking for.
|
|
953
951
|
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
@@ -1043,7 +1041,7 @@ export interface V2CreateBookingRequest extends V2CreateBookingRequestBookableIt
|
|
|
1043
1041
|
flowControlSettings?: CreateBookingRequestFlowControlSettings;
|
|
1044
1042
|
}
|
|
1045
1043
|
/** @oneof */
|
|
1046
|
-
|
|
1044
|
+
interface V2CreateBookingRequestBookableItemOneOf {
|
|
1047
1045
|
/**
|
|
1048
1046
|
* Information about the slot to create a booking for.
|
|
1049
1047
|
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
@@ -1055,9 +1053,9 @@ export interface V2CreateBookingRequestBookableItemOneOf {
|
|
|
1055
1053
|
schedule?: BookedSchedule;
|
|
1056
1054
|
}
|
|
1057
1055
|
/** @oneof */
|
|
1058
|
-
|
|
1056
|
+
interface V2CreateBookingRequestParticipantsInfoOneOf {
|
|
1059
1057
|
}
|
|
1060
|
-
|
|
1058
|
+
interface Slot {
|
|
1061
1059
|
/**
|
|
1062
1060
|
* ID for the slot's corresponding session, when the session is either a single session
|
|
1063
1061
|
* or a specific session generated from a recurring session.
|
|
@@ -1115,20 +1113,20 @@ export interface Slot {
|
|
|
1115
1113
|
*/
|
|
1116
1114
|
eventId?: string | null;
|
|
1117
1115
|
}
|
|
1118
|
-
|
|
1116
|
+
interface SlotResource {
|
|
1119
1117
|
/**
|
|
1120
1118
|
* Resource ID.
|
|
1121
1119
|
* @format GUID
|
|
1122
1120
|
* @readonly
|
|
1123
1121
|
*/
|
|
1124
|
-
|
|
1122
|
+
_id?: string | null;
|
|
1125
1123
|
/**
|
|
1126
1124
|
* Resource name. Read only.
|
|
1127
1125
|
* @maxLength 1200
|
|
1128
1126
|
*/
|
|
1129
1127
|
name?: string | null;
|
|
1130
1128
|
}
|
|
1131
|
-
|
|
1129
|
+
interface CreateBookingRequestFlowControlSettings {
|
|
1132
1130
|
/**
|
|
1133
1131
|
* Whether the availability is checked before creating the booking. When
|
|
1134
1132
|
* passing `false` a booking is only created when the slot or schedule is
|
|
@@ -1157,11 +1155,11 @@ export interface CreateBookingRequestFlowControlSettings {
|
|
|
1157
1155
|
*/
|
|
1158
1156
|
skipSelectedPaymentOptionValidation?: boolean;
|
|
1159
1157
|
}
|
|
1160
|
-
|
|
1158
|
+
interface V2CreateBookingResponse {
|
|
1161
1159
|
/** Created booking. */
|
|
1162
1160
|
booking?: Booking;
|
|
1163
1161
|
}
|
|
1164
|
-
|
|
1162
|
+
interface V2CancelBookingRequest {
|
|
1165
1163
|
/**
|
|
1166
1164
|
* ID of the booking to cancel.
|
|
1167
1165
|
* @format GUID
|
|
@@ -1179,7 +1177,7 @@ export interface V2CancelBookingRequest {
|
|
|
1179
1177
|
*/
|
|
1180
1178
|
revision?: string | null;
|
|
1181
1179
|
}
|
|
1182
|
-
|
|
1180
|
+
interface CancelBookingRequestFlowControlSettings {
|
|
1183
1181
|
/**
|
|
1184
1182
|
* Whether the cancellation policy applies when canceling the booking. When
|
|
1185
1183
|
* passing `false` you can only cancel a booking if the cancellation policy
|
|
@@ -1201,11 +1199,11 @@ export interface CancelBookingRequestFlowControlSettings {
|
|
|
1201
1199
|
*/
|
|
1202
1200
|
withRefund?: boolean | null;
|
|
1203
1201
|
}
|
|
1204
|
-
|
|
1202
|
+
interface V2CancelBookingResponse {
|
|
1205
1203
|
/** Canceled booking. */
|
|
1206
1204
|
booking?: Booking;
|
|
1207
1205
|
}
|
|
1208
|
-
|
|
1206
|
+
interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1209
1207
|
/**
|
|
1210
1208
|
* Id of the booking to reschedule.
|
|
1211
1209
|
* @format GUID
|
|
@@ -1226,9 +1224,9 @@ export interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestPa
|
|
|
1226
1224
|
participantNotification?: ParticipantNotification;
|
|
1227
1225
|
}
|
|
1228
1226
|
/** @oneof */
|
|
1229
|
-
|
|
1227
|
+
interface V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1230
1228
|
}
|
|
1231
|
-
|
|
1229
|
+
interface RescheduleBookingRequestFlowControlSettings {
|
|
1232
1230
|
/**
|
|
1233
1231
|
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
1234
1232
|
* When passing `false` you can only cancel a booking if the rescheduling
|
|
@@ -1257,11 +1255,11 @@ export interface RescheduleBookingRequestFlowControlSettings {
|
|
|
1257
1255
|
*/
|
|
1258
1256
|
skipBusinessConfirmation?: boolean;
|
|
1259
1257
|
}
|
|
1260
|
-
|
|
1258
|
+
interface V2RescheduleBookingResponse {
|
|
1261
1259
|
/** Rescheduled booking. */
|
|
1262
1260
|
booking?: Booking;
|
|
1263
1261
|
}
|
|
1264
|
-
|
|
1262
|
+
interface V2ConfirmBookingRequest {
|
|
1265
1263
|
/**
|
|
1266
1264
|
* ID of the booking to confirm.
|
|
1267
1265
|
* @format GUID
|
|
@@ -1279,10 +1277,10 @@ export interface V2ConfirmBookingRequest {
|
|
|
1279
1277
|
*/
|
|
1280
1278
|
participantNotification?: ParticipantNotification;
|
|
1281
1279
|
}
|
|
1282
|
-
|
|
1280
|
+
interface V2ConfirmBookingResponse {
|
|
1283
1281
|
booking?: Booking;
|
|
1284
1282
|
}
|
|
1285
|
-
|
|
1283
|
+
interface V2DeclineBookingRequest {
|
|
1286
1284
|
/**
|
|
1287
1285
|
* ID of the booking to decline.
|
|
1288
1286
|
* @format GUID
|
|
@@ -1300,11 +1298,11 @@ export interface V2DeclineBookingRequest {
|
|
|
1300
1298
|
*/
|
|
1301
1299
|
participantNotification?: ParticipantNotification;
|
|
1302
1300
|
}
|
|
1303
|
-
|
|
1301
|
+
interface V2DeclineBookingResponse {
|
|
1304
1302
|
/** Declined booking. */
|
|
1305
1303
|
booking?: Booking;
|
|
1306
1304
|
}
|
|
1307
|
-
|
|
1305
|
+
interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1308
1306
|
/**
|
|
1309
1307
|
* ID of the booking to update the number of participants for.
|
|
1310
1308
|
* @format GUID
|
|
@@ -1320,13 +1318,13 @@ export interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfPar
|
|
|
1320
1318
|
revision?: string | null;
|
|
1321
1319
|
}
|
|
1322
1320
|
/** @oneof */
|
|
1323
|
-
|
|
1321
|
+
interface V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1324
1322
|
}
|
|
1325
|
-
|
|
1323
|
+
interface V2UpdateNumberOfParticipantsResponse {
|
|
1326
1324
|
/** Booking with updated number of participants. */
|
|
1327
1325
|
booking?: Booking;
|
|
1328
1326
|
}
|
|
1329
|
-
|
|
1327
|
+
interface ConfirmOrDeclineBookingRequest {
|
|
1330
1328
|
/**
|
|
1331
1329
|
* ID of the booking to confirm or decline.
|
|
1332
1330
|
* @format GUID
|
|
@@ -1342,11 +1340,11 @@ export interface ConfirmOrDeclineBookingRequest {
|
|
|
1342
1340
|
*/
|
|
1343
1341
|
paymentStatus?: PaymentStatus;
|
|
1344
1342
|
}
|
|
1345
|
-
|
|
1343
|
+
interface ConfirmOrDeclineBookingResponse {
|
|
1346
1344
|
/** Updated booking. */
|
|
1347
1345
|
booking?: Booking;
|
|
1348
1346
|
}
|
|
1349
|
-
|
|
1347
|
+
interface BulkConfirmOrDeclineBookingRequest {
|
|
1350
1348
|
/**
|
|
1351
1349
|
* Bookings to confirm or decline.
|
|
1352
1350
|
* @minSize 1
|
|
@@ -1356,7 +1354,7 @@ export interface BulkConfirmOrDeclineBookingRequest {
|
|
|
1356
1354
|
/** Whether to return the confirmed or declined booking objects. */
|
|
1357
1355
|
returnEntity?: boolean;
|
|
1358
1356
|
}
|
|
1359
|
-
|
|
1357
|
+
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
1360
1358
|
/**
|
|
1361
1359
|
* ID of the booking to confirm or decline.
|
|
1362
1360
|
* @format GUID
|
|
@@ -1372,13 +1370,13 @@ export interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
|
1372
1370
|
*/
|
|
1373
1371
|
paymentStatus?: PaymentStatus;
|
|
1374
1372
|
}
|
|
1375
|
-
|
|
1373
|
+
interface BulkConfirmOrDeclineBookingResponse {
|
|
1376
1374
|
/** List of confirmed or declined bookings, including metadata. */
|
|
1377
1375
|
results?: BulkBookingResult[];
|
|
1378
1376
|
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
1379
1377
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1380
1378
|
}
|
|
1381
|
-
|
|
1379
|
+
interface BulkBookingResult {
|
|
1382
1380
|
/**
|
|
1383
1381
|
* Information about the booking that was created or updated.
|
|
1384
1382
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1391,9 +1389,9 @@ export interface BulkBookingResult {
|
|
|
1391
1389
|
*/
|
|
1392
1390
|
item?: Booking;
|
|
1393
1391
|
}
|
|
1394
|
-
|
|
1392
|
+
interface ItemMetadata {
|
|
1395
1393
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1396
|
-
|
|
1394
|
+
_id?: string | null;
|
|
1397
1395
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1398
1396
|
originalIndex?: number;
|
|
1399
1397
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -1401,7 +1399,7 @@ export interface ItemMetadata {
|
|
|
1401
1399
|
/** Details about the error in case of failure. */
|
|
1402
1400
|
error?: ApplicationError;
|
|
1403
1401
|
}
|
|
1404
|
-
|
|
1402
|
+
interface ApplicationError {
|
|
1405
1403
|
/** Error code. */
|
|
1406
1404
|
code?: string;
|
|
1407
1405
|
/** Description of the error. */
|
|
@@ -1409,7 +1407,7 @@ export interface ApplicationError {
|
|
|
1409
1407
|
/** Data related to the error. */
|
|
1410
1408
|
data?: Record<string, any> | null;
|
|
1411
1409
|
}
|
|
1412
|
-
|
|
1410
|
+
interface BulkActionMetadata {
|
|
1413
1411
|
/** Number of items that were successfully processed. */
|
|
1414
1412
|
totalSuccesses?: number;
|
|
1415
1413
|
/** Number of items that couldn't be processed. */
|
|
@@ -1417,13 +1415,13 @@ export interface BulkActionMetadata {
|
|
|
1417
1415
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1418
1416
|
undetailedFailures?: number;
|
|
1419
1417
|
}
|
|
1420
|
-
|
|
1418
|
+
interface BookingChanged {
|
|
1421
1419
|
/** The booking before the changes. */
|
|
1422
1420
|
previousBooking?: Booking;
|
|
1423
1421
|
/** The booking after the changes. */
|
|
1424
1422
|
currentBooking?: Booking;
|
|
1425
1423
|
}
|
|
1426
|
-
|
|
1424
|
+
interface CreateBookingRequest {
|
|
1427
1425
|
/** The booking to create. */
|
|
1428
1426
|
booking: Booking;
|
|
1429
1427
|
/**
|
|
@@ -1443,7 +1441,7 @@ export interface CreateBookingRequest {
|
|
|
1443
1441
|
*/
|
|
1444
1442
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1445
1443
|
}
|
|
1446
|
-
|
|
1444
|
+
interface CreateBookingFlowControlSettings {
|
|
1447
1445
|
/**
|
|
1448
1446
|
* Whether the availability is checked before creating the booking.
|
|
1449
1447
|
*
|
|
@@ -1470,7 +1468,7 @@ export interface CreateBookingFlowControlSettings {
|
|
|
1470
1468
|
*/
|
|
1471
1469
|
skipSelectedPaymentOptionValidation?: boolean;
|
|
1472
1470
|
}
|
|
1473
|
-
|
|
1471
|
+
interface CreateBookingResponse {
|
|
1474
1472
|
/** Created booking. */
|
|
1475
1473
|
booking?: Booking;
|
|
1476
1474
|
}
|
|
@@ -1478,30 +1476,30 @@ export interface CreateBookingResponse {
|
|
|
1478
1476
|
* The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1479
1477
|
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1480
1478
|
*/
|
|
1481
|
-
|
|
1479
|
+
interface UpdateBookingRequest {
|
|
1482
1480
|
booking?: Booking;
|
|
1483
1481
|
}
|
|
1484
|
-
|
|
1482
|
+
interface UpdateBookingResponse {
|
|
1485
1483
|
booking?: Booking;
|
|
1486
1484
|
}
|
|
1487
|
-
|
|
1485
|
+
interface LegacyCreateBookingRequest {
|
|
1488
1486
|
booking?: Booking;
|
|
1489
1487
|
}
|
|
1490
|
-
|
|
1488
|
+
interface LegacyCreateBookingResponse {
|
|
1491
1489
|
booking?: Booking;
|
|
1492
1490
|
}
|
|
1493
1491
|
/**
|
|
1494
1492
|
* The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1495
1493
|
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1496
1494
|
*/
|
|
1497
|
-
|
|
1495
|
+
interface BulkUpdateBookingRequest {
|
|
1498
1496
|
bookings?: MaskedBooking[];
|
|
1499
1497
|
}
|
|
1500
|
-
|
|
1498
|
+
interface MaskedBooking {
|
|
1501
1499
|
booking?: Booking;
|
|
1502
1500
|
mask?: string[];
|
|
1503
1501
|
}
|
|
1504
|
-
|
|
1502
|
+
interface BulkUpdateBookingResponse {
|
|
1505
1503
|
/**
|
|
1506
1504
|
* Information about the booking that was updated.
|
|
1507
1505
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1511,7 +1509,7 @@ export interface BulkUpdateBookingResponse {
|
|
|
1511
1509
|
/** Total number of successes and failures for Bulk Update Bookings. */
|
|
1512
1510
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1513
1511
|
}
|
|
1514
|
-
|
|
1512
|
+
interface BulkCreateBookingRequest {
|
|
1515
1513
|
/**
|
|
1516
1514
|
* Bookings to create.
|
|
1517
1515
|
*
|
|
@@ -1523,7 +1521,7 @@ export interface BulkCreateBookingRequest {
|
|
|
1523
1521
|
/** Whether to return the created bookings. */
|
|
1524
1522
|
returnFullEntity?: boolean;
|
|
1525
1523
|
}
|
|
1526
|
-
|
|
1524
|
+
interface CreateBookingInfo {
|
|
1527
1525
|
/** Booking to create. */
|
|
1528
1526
|
booking?: Booking;
|
|
1529
1527
|
/**
|
|
@@ -1543,13 +1541,13 @@ export interface CreateBookingInfo {
|
|
|
1543
1541
|
*/
|
|
1544
1542
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1545
1543
|
}
|
|
1546
|
-
|
|
1544
|
+
interface BulkCreateBookingResponse {
|
|
1547
1545
|
/** List of individual Bulk Create Bookings results. */
|
|
1548
1546
|
results?: BulkBookingResult[];
|
|
1549
1547
|
/** Total number of successes and failures for Bulk Create Bookings. */
|
|
1550
1548
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1551
1549
|
}
|
|
1552
|
-
|
|
1550
|
+
interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1553
1551
|
/**
|
|
1554
1552
|
* Total number of participants. Specify when all participants have booked the
|
|
1555
1553
|
* same service variant.
|
|
@@ -1585,7 +1583,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
|
|
|
1585
1583
|
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
1586
1584
|
}
|
|
1587
1585
|
/** @oneof */
|
|
1588
|
-
|
|
1586
|
+
interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1589
1587
|
/**
|
|
1590
1588
|
* Total number of participants. Specify when all participants have booked the
|
|
1591
1589
|
* same service variant.
|
|
@@ -1597,7 +1595,7 @@ export interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
|
1597
1595
|
*/
|
|
1598
1596
|
participantsChoices?: ParticipantChoices;
|
|
1599
1597
|
}
|
|
1600
|
-
|
|
1598
|
+
interface V2Slot {
|
|
1601
1599
|
/** Identifier for the underlying session when the session is a single session or generated from a recurring session. */
|
|
1602
1600
|
sessionId?: string | null;
|
|
1603
1601
|
/** Service identifier. Required. */
|
|
@@ -1629,7 +1627,7 @@ export interface V2Slot {
|
|
|
1629
1627
|
*/
|
|
1630
1628
|
eventId?: string | null;
|
|
1631
1629
|
}
|
|
1632
|
-
|
|
1630
|
+
declare enum LocationLocationType {
|
|
1633
1631
|
/** Undefined location type. */
|
|
1634
1632
|
UNDEFINED = "UNDEFINED",
|
|
1635
1633
|
/** The business address as set in the site’s general settings. */
|
|
@@ -1639,25 +1637,25 @@ export declare enum LocationLocationType {
|
|
|
1639
1637
|
/** The address set for the individual session. */
|
|
1640
1638
|
CUSTOM = "CUSTOM"
|
|
1641
1639
|
}
|
|
1642
|
-
|
|
1640
|
+
interface SlotSlotResource {
|
|
1643
1641
|
/**
|
|
1644
1642
|
* Resource ID.
|
|
1645
1643
|
* @format GUID
|
|
1646
1644
|
* @readonly
|
|
1647
1645
|
*/
|
|
1648
|
-
|
|
1646
|
+
_id?: string | null;
|
|
1649
1647
|
/**
|
|
1650
1648
|
* Resource name.
|
|
1651
1649
|
* @maxLength 1200
|
|
1652
1650
|
*/
|
|
1653
1651
|
name?: string | null;
|
|
1654
1652
|
}
|
|
1655
|
-
|
|
1653
|
+
interface SlotLocation {
|
|
1656
1654
|
/**
|
|
1657
1655
|
* Business Location ID. Present if the location is a business location.
|
|
1658
1656
|
* @format GUID
|
|
1659
1657
|
*/
|
|
1660
|
-
|
|
1658
|
+
_id?: string | null;
|
|
1661
1659
|
/** Location name. */
|
|
1662
1660
|
name?: string | null;
|
|
1663
1661
|
/** A string containing the full address of this location. */
|
|
@@ -1665,7 +1663,7 @@ export interface SlotLocation {
|
|
|
1665
1663
|
/** Location type. */
|
|
1666
1664
|
locationType?: LocationLocationType;
|
|
1667
1665
|
}
|
|
1668
|
-
|
|
1666
|
+
interface RescheduleBookingFlowControlSettings {
|
|
1669
1667
|
/**
|
|
1670
1668
|
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
1671
1669
|
*
|
|
@@ -1690,11 +1688,11 @@ export interface RescheduleBookingFlowControlSettings {
|
|
|
1690
1688
|
*/
|
|
1691
1689
|
skipBusinessConfirmation?: boolean;
|
|
1692
1690
|
}
|
|
1693
|
-
|
|
1691
|
+
interface RescheduleBookingResponse {
|
|
1694
1692
|
/** Rescheduled booking. */
|
|
1695
1693
|
booking?: Booking;
|
|
1696
1694
|
}
|
|
1697
|
-
|
|
1695
|
+
interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
1698
1696
|
/**
|
|
1699
1697
|
* The previous total number of participants. Available only when the booking includes
|
|
1700
1698
|
* a single service variant.
|
|
@@ -1736,7 +1734,7 @@ export interface BookingRescheduled extends BookingRescheduledPreviousParticipan
|
|
|
1736
1734
|
previousEndDate?: Date | null;
|
|
1737
1735
|
}
|
|
1738
1736
|
/** @oneof */
|
|
1739
|
-
|
|
1737
|
+
interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
1740
1738
|
/**
|
|
1741
1739
|
* The previous total number of participants. Available only when the booking includes
|
|
1742
1740
|
* a single service variant.
|
|
@@ -1748,7 +1746,7 @@ export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
|
1748
1746
|
*/
|
|
1749
1747
|
previousParticipantsChoices?: ParticipantChoices;
|
|
1750
1748
|
}
|
|
1751
|
-
|
|
1749
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1752
1750
|
/**
|
|
1753
1751
|
* ID of a site visitor that has not logged in to the site.
|
|
1754
1752
|
* @format GUID
|
|
@@ -1777,7 +1775,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1777
1775
|
contactId?: string | null;
|
|
1778
1776
|
}
|
|
1779
1777
|
/** @oneof */
|
|
1780
|
-
|
|
1778
|
+
interface IdentificationDataIdOneOf {
|
|
1781
1779
|
/**
|
|
1782
1780
|
* ID of a site visitor that has not logged in to the site.
|
|
1783
1781
|
* @format GUID
|
|
@@ -1799,14 +1797,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
1799
1797
|
*/
|
|
1800
1798
|
appId?: string;
|
|
1801
1799
|
}
|
|
1802
|
-
|
|
1800
|
+
declare enum IdentityType {
|
|
1803
1801
|
UNKNOWN = "UNKNOWN",
|
|
1804
1802
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1805
1803
|
MEMBER = "MEMBER",
|
|
1806
1804
|
WIX_USER = "WIX_USER",
|
|
1807
1805
|
APP = "APP"
|
|
1808
1806
|
}
|
|
1809
|
-
|
|
1807
|
+
interface BulkRescheduleBookingRequest {
|
|
1810
1808
|
/**
|
|
1811
1809
|
* Reschedule multiple bookings to multiple slots.
|
|
1812
1810
|
* @minSize 1
|
|
@@ -1818,12 +1816,12 @@ export interface BulkRescheduleBookingRequest {
|
|
|
1818
1816
|
*/
|
|
1819
1817
|
participantNotification?: ParticipantNotification;
|
|
1820
1818
|
}
|
|
1821
|
-
|
|
1819
|
+
interface BulkRescheduleBookingRequestBooking {
|
|
1822
1820
|
/**
|
|
1823
1821
|
* ID of the booking to reschedule.
|
|
1824
1822
|
* @format GUID
|
|
1825
1823
|
*/
|
|
1826
|
-
|
|
1824
|
+
_id?: string;
|
|
1827
1825
|
/**
|
|
1828
1826
|
* Revision number, which increments by 1 each time the booking is rescheduled.
|
|
1829
1827
|
* To prevent conflicting changes,
|
|
@@ -1832,7 +1830,7 @@ export interface BulkRescheduleBookingRequestBooking {
|
|
|
1832
1830
|
revision?: string | null;
|
|
1833
1831
|
}
|
|
1834
1832
|
/** Bookings to be rescheduled to the given slot. */
|
|
1835
|
-
|
|
1833
|
+
interface SlotBookings {
|
|
1836
1834
|
/**
|
|
1837
1835
|
* The bookings details.
|
|
1838
1836
|
* @minSize 1
|
|
@@ -1844,7 +1842,7 @@ export interface SlotBookings {
|
|
|
1844
1842
|
*/
|
|
1845
1843
|
slot?: BookedSlot;
|
|
1846
1844
|
}
|
|
1847
|
-
|
|
1845
|
+
interface BulkRescheduleBookingResponse {
|
|
1848
1846
|
/**
|
|
1849
1847
|
* Information about the booking that was rescheduled.
|
|
1850
1848
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1855,7 +1853,7 @@ export interface BulkRescheduleBookingResponse {
|
|
|
1855
1853
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1856
1854
|
}
|
|
1857
1855
|
/** Update the booked schedule of multiple bookings to the given schedule. */
|
|
1858
|
-
|
|
1856
|
+
interface BulkUpdateBookedScheduleRequest {
|
|
1859
1857
|
/**
|
|
1860
1858
|
* The bookings whose booked schedule is to be updated to the given schedule.
|
|
1861
1859
|
* @minSize 1
|
|
@@ -1869,15 +1867,15 @@ export interface BulkUpdateBookedScheduleRequest {
|
|
|
1869
1867
|
*/
|
|
1870
1868
|
participantNotification?: ParticipantNotification;
|
|
1871
1869
|
}
|
|
1872
|
-
|
|
1870
|
+
interface BookingDetails {
|
|
1873
1871
|
/**
|
|
1874
1872
|
* ID of the bookings to be updated.
|
|
1875
1873
|
* @format GUID
|
|
1876
1874
|
*/
|
|
1877
|
-
|
|
1875
|
+
_id?: string;
|
|
1878
1876
|
revision?: string | null;
|
|
1879
1877
|
}
|
|
1880
|
-
|
|
1878
|
+
interface BulkUpdateBookedScheduleResponse {
|
|
1881
1879
|
/**
|
|
1882
1880
|
* Information about the schedule that was updated.
|
|
1883
1881
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1887,11 +1885,11 @@ export interface BulkUpdateBookedScheduleResponse {
|
|
|
1887
1885
|
/** Total number of successes and failures for Bulk Updated Booked Schedules. */
|
|
1888
1886
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1889
1887
|
}
|
|
1890
|
-
|
|
1888
|
+
interface QueryBookingsRequest {
|
|
1891
1889
|
/** Information about filters, paging, and sorting. */
|
|
1892
1890
|
query?: QueryV2;
|
|
1893
1891
|
}
|
|
1894
|
-
|
|
1892
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1895
1893
|
/** Paging options to limit and skip the number of items. */
|
|
1896
1894
|
paging?: Paging;
|
|
1897
1895
|
/**
|
|
@@ -1921,7 +1919,7 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
1921
1919
|
fieldsets?: string[];
|
|
1922
1920
|
}
|
|
1923
1921
|
/** @oneof */
|
|
1924
|
-
|
|
1922
|
+
interface QueryV2PagingMethodOneOf {
|
|
1925
1923
|
/** Paging options to limit and skip the number of items. */
|
|
1926
1924
|
paging?: Paging;
|
|
1927
1925
|
/**
|
|
@@ -1932,7 +1930,7 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
1932
1930
|
*/
|
|
1933
1931
|
cursorPaging?: CursorPaging;
|
|
1934
1932
|
}
|
|
1935
|
-
|
|
1933
|
+
interface Sorting {
|
|
1936
1934
|
/**
|
|
1937
1935
|
* Name of the field to sort by.
|
|
1938
1936
|
* @maxLength 512
|
|
@@ -1941,17 +1939,17 @@ export interface Sorting {
|
|
|
1941
1939
|
/** Sort order. */
|
|
1942
1940
|
order?: SortOrder;
|
|
1943
1941
|
}
|
|
1944
|
-
|
|
1942
|
+
declare enum SortOrder {
|
|
1945
1943
|
ASC = "ASC",
|
|
1946
1944
|
DESC = "DESC"
|
|
1947
1945
|
}
|
|
1948
|
-
|
|
1946
|
+
interface Paging {
|
|
1949
1947
|
/** Number of items to load. */
|
|
1950
1948
|
limit?: number | null;
|
|
1951
1949
|
/** Number of items to skip in the current sort order. */
|
|
1952
1950
|
offset?: number | null;
|
|
1953
1951
|
}
|
|
1954
|
-
|
|
1952
|
+
interface CursorPaging {
|
|
1955
1953
|
/**
|
|
1956
1954
|
* Maximum number of items to return in the results.
|
|
1957
1955
|
* @max 100
|
|
@@ -1966,13 +1964,13 @@ export interface CursorPaging {
|
|
|
1966
1964
|
*/
|
|
1967
1965
|
cursor?: string | null;
|
|
1968
1966
|
}
|
|
1969
|
-
|
|
1967
|
+
interface QueryBookingsResponse {
|
|
1970
1968
|
/** Retrieved bookings. */
|
|
1971
1969
|
bookings?: Booking[];
|
|
1972
1970
|
/** Paging metadata. */
|
|
1973
1971
|
pagingMetadata?: PagingMetadataV2;
|
|
1974
1972
|
}
|
|
1975
|
-
|
|
1973
|
+
interface PagingMetadataV2 {
|
|
1976
1974
|
/** Number of items returned in the response. */
|
|
1977
1975
|
count?: number | null;
|
|
1978
1976
|
/** Offset that was requested. */
|
|
@@ -1984,7 +1982,7 @@ export interface PagingMetadataV2 {
|
|
|
1984
1982
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1985
1983
|
cursors?: Cursors;
|
|
1986
1984
|
}
|
|
1987
|
-
|
|
1985
|
+
interface Cursors {
|
|
1988
1986
|
/**
|
|
1989
1987
|
* Cursor string pointing to the next page in the list of results.
|
|
1990
1988
|
* @maxLength 16000
|
|
@@ -1996,25 +1994,25 @@ export interface Cursors {
|
|
|
1996
1994
|
*/
|
|
1997
1995
|
prev?: string | null;
|
|
1998
1996
|
}
|
|
1999
|
-
|
|
1997
|
+
interface ConfirmRequest {
|
|
2000
1998
|
/**
|
|
2001
1999
|
* ID of the booking to confirm.
|
|
2002
2000
|
* @format GUID
|
|
2003
2001
|
*/
|
|
2004
|
-
|
|
2002
|
+
_id?: string;
|
|
2005
2003
|
/**
|
|
2006
2004
|
* Information about whether to notify the customer about the confirmation and
|
|
2007
2005
|
* the message to send.
|
|
2008
2006
|
*/
|
|
2009
2007
|
participantNotification?: ParticipantNotification;
|
|
2010
2008
|
}
|
|
2011
|
-
|
|
2009
|
+
interface ConfirmResponse {
|
|
2012
2010
|
/** Confirmed booking. */
|
|
2013
2011
|
booking?: Booking;
|
|
2014
2012
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
2015
2013
|
doubleBooked?: boolean | null;
|
|
2016
2014
|
}
|
|
2017
|
-
|
|
2015
|
+
interface ConfirmBookingRequest {
|
|
2018
2016
|
/**
|
|
2019
2017
|
* ID of the booking to confirm.
|
|
2020
2018
|
* @format GUID
|
|
@@ -2046,7 +2044,7 @@ export interface ConfirmBookingRequest {
|
|
|
2046
2044
|
*/
|
|
2047
2045
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
2048
2046
|
}
|
|
2049
|
-
|
|
2047
|
+
interface ConfirmBookingFlowControlSettings {
|
|
2050
2048
|
/**
|
|
2051
2049
|
* Whether the availability is checked before confirming the booking.
|
|
2052
2050
|
*
|
|
@@ -2055,11 +2053,11 @@ export interface ConfirmBookingFlowControlSettings {
|
|
|
2055
2053
|
*/
|
|
2056
2054
|
checkAvailabilityValidation?: boolean;
|
|
2057
2055
|
}
|
|
2058
|
-
|
|
2056
|
+
interface ConfirmBookingResponse {
|
|
2059
2057
|
/** Confirmed booking. */
|
|
2060
2058
|
booking?: Booking;
|
|
2061
2059
|
}
|
|
2062
|
-
|
|
2060
|
+
interface BookingConfirmed {
|
|
2063
2061
|
/** The confirmed booking object. */
|
|
2064
2062
|
booking?: Booking;
|
|
2065
2063
|
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
@@ -2078,30 +2076,30 @@ export interface BookingConfirmed {
|
|
|
2078
2076
|
/** The previous payment status of the booking. */
|
|
2079
2077
|
previousPaymentStatus?: PaymentStatus;
|
|
2080
2078
|
}
|
|
2081
|
-
|
|
2079
|
+
interface ConsistentQueryBookingsRequest {
|
|
2082
2080
|
/** Information about filters, paging, and sorting. */
|
|
2083
2081
|
query?: QueryV2;
|
|
2084
2082
|
}
|
|
2085
|
-
|
|
2083
|
+
interface ConsistentQueryBookingsResponse {
|
|
2086
2084
|
/** Retrieved bookings. */
|
|
2087
2085
|
bookings?: Booking[];
|
|
2088
2086
|
/** Paging metadata. */
|
|
2089
2087
|
pagingMetadata?: PagingMetadataV2;
|
|
2090
2088
|
}
|
|
2091
|
-
|
|
2089
|
+
interface SetBookingSessionIdRequest {
|
|
2092
2090
|
/**
|
|
2093
2091
|
* ID of the booking to set `sessionId` for.
|
|
2094
2092
|
* @format GUID
|
|
2095
2093
|
*/
|
|
2096
|
-
|
|
2094
|
+
_id?: string;
|
|
2097
2095
|
/** ID of the session to set on the booking. */
|
|
2098
2096
|
sessionId?: string;
|
|
2099
2097
|
}
|
|
2100
|
-
|
|
2098
|
+
interface SetBookingSessionIdResponse {
|
|
2101
2099
|
/** Updated booking. */
|
|
2102
2100
|
booking?: Booking;
|
|
2103
2101
|
}
|
|
2104
|
-
|
|
2102
|
+
interface SetBookingSubmissionIdRequest {
|
|
2105
2103
|
/**
|
|
2106
2104
|
* ID of the booking to set `submissionId` for.
|
|
2107
2105
|
* @format GUID
|
|
@@ -2113,19 +2111,19 @@ export interface SetBookingSubmissionIdRequest {
|
|
|
2113
2111
|
*/
|
|
2114
2112
|
submissionId?: string;
|
|
2115
2113
|
}
|
|
2116
|
-
|
|
2114
|
+
interface SetBookingSubmissionIdResponse {
|
|
2117
2115
|
/** Updated booking. */
|
|
2118
2116
|
booking?: Booking;
|
|
2119
2117
|
}
|
|
2120
|
-
|
|
2118
|
+
interface UpdateExtendedFieldsRequest {
|
|
2121
2119
|
/** ID of the entity to update. */
|
|
2122
|
-
|
|
2120
|
+
_id: string;
|
|
2123
2121
|
/** Identifier for the app whose extended fields are being updated. */
|
|
2124
2122
|
namespace: string;
|
|
2125
2123
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
2126
2124
|
namespaceData: Record<string, any> | null;
|
|
2127
2125
|
}
|
|
2128
|
-
|
|
2126
|
+
interface UpdateExtendedFieldsResponse {
|
|
2129
2127
|
/**
|
|
2130
2128
|
* Updated namespace.
|
|
2131
2129
|
* @maxLength 164
|
|
@@ -2134,7 +2132,7 @@ export interface UpdateExtendedFieldsResponse {
|
|
|
2134
2132
|
/** Updated data. */
|
|
2135
2133
|
namespaceData?: Record<string, any> | null;
|
|
2136
2134
|
}
|
|
2137
|
-
|
|
2135
|
+
interface DeclineBookingRequest {
|
|
2138
2136
|
/**
|
|
2139
2137
|
* ID of the booking to decline.
|
|
2140
2138
|
* @format GUID
|
|
@@ -2163,7 +2161,7 @@ export interface DeclineBookingRequest {
|
|
|
2163
2161
|
*/
|
|
2164
2162
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2165
2163
|
}
|
|
2166
|
-
|
|
2164
|
+
interface DeclineBookingFlowControlSettings {
|
|
2167
2165
|
/**
|
|
2168
2166
|
* Whether to issue a refund when declining the booking.
|
|
2169
2167
|
*
|
|
@@ -2177,11 +2175,11 @@ export interface DeclineBookingFlowControlSettings {
|
|
|
2177
2175
|
*/
|
|
2178
2176
|
withRefund?: boolean | null;
|
|
2179
2177
|
}
|
|
2180
|
-
|
|
2178
|
+
interface DeclineBookingResponse {
|
|
2181
2179
|
/** Declined booking. */
|
|
2182
2180
|
booking?: Booking;
|
|
2183
2181
|
}
|
|
2184
|
-
|
|
2182
|
+
interface BookingDeclined {
|
|
2185
2183
|
/** The declined booking object. */
|
|
2186
2184
|
booking?: Booking;
|
|
2187
2185
|
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
@@ -2200,7 +2198,7 @@ export interface BookingDeclined {
|
|
|
2200
2198
|
*/
|
|
2201
2199
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2202
2200
|
}
|
|
2203
|
-
|
|
2201
|
+
interface CancelBookingRequest {
|
|
2204
2202
|
/**
|
|
2205
2203
|
* ID of the booking to cancel.
|
|
2206
2204
|
* @format GUID
|
|
@@ -2225,7 +2223,7 @@ export interface CancelBookingRequest {
|
|
|
2225
2223
|
*/
|
|
2226
2224
|
revision: string | null;
|
|
2227
2225
|
}
|
|
2228
|
-
|
|
2226
|
+
interface CancelBookingFlowControlSettings {
|
|
2229
2227
|
/**
|
|
2230
2228
|
* Whether the cancellation policy applies when canceling the booking.
|
|
2231
2229
|
*
|
|
@@ -2246,11 +2244,11 @@ export interface CancelBookingFlowControlSettings {
|
|
|
2246
2244
|
*/
|
|
2247
2245
|
withRefund?: boolean | null;
|
|
2248
2246
|
}
|
|
2249
|
-
|
|
2247
|
+
interface CancelBookingResponse {
|
|
2250
2248
|
/** Canceled booking. */
|
|
2251
2249
|
booking?: Booking;
|
|
2252
2250
|
}
|
|
2253
|
-
|
|
2251
|
+
interface BookingCanceled {
|
|
2254
2252
|
/** The canceled booking object. */
|
|
2255
2253
|
booking?: Booking;
|
|
2256
2254
|
/** Information about whether to notify the customer about the cancellation and the message to send. */
|
|
@@ -2267,7 +2265,7 @@ export interface BookingCanceled {
|
|
|
2267
2265
|
/** The previous status of the booking. */
|
|
2268
2266
|
previousStatus?: BookingStatus;
|
|
2269
2267
|
}
|
|
2270
|
-
|
|
2268
|
+
interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2271
2269
|
/**
|
|
2272
2270
|
* Total number of participants. Specify when all participants have booked the
|
|
2273
2271
|
* same service variant.
|
|
@@ -2292,7 +2290,7 @@ export interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfPartici
|
|
|
2292
2290
|
revision: string | null;
|
|
2293
2291
|
}
|
|
2294
2292
|
/** @oneof */
|
|
2295
|
-
|
|
2293
|
+
interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2296
2294
|
/**
|
|
2297
2295
|
* Total number of participants. Specify when all participants have booked the
|
|
2298
2296
|
* same service variant.
|
|
@@ -2304,11 +2302,11 @@ export interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
|
2304
2302
|
*/
|
|
2305
2303
|
participantsChoices?: ParticipantChoices;
|
|
2306
2304
|
}
|
|
2307
|
-
|
|
2305
|
+
interface UpdateNumberOfParticipantsResponse {
|
|
2308
2306
|
/** Updated booking. */
|
|
2309
2307
|
booking?: Booking;
|
|
2310
2308
|
}
|
|
2311
|
-
|
|
2309
|
+
interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
2312
2310
|
/**
|
|
2313
2311
|
* The previous total number of participants. Available only when the booking includes
|
|
2314
2312
|
* a single service variant.
|
|
@@ -2325,7 +2323,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
|
|
|
2325
2323
|
initiatedBy?: IdentificationData;
|
|
2326
2324
|
}
|
|
2327
2325
|
/** @oneof */
|
|
2328
|
-
|
|
2326
|
+
interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
2329
2327
|
/**
|
|
2330
2328
|
* The previous total number of participants. Available only when the booking includes
|
|
2331
2329
|
* a single service variant.
|
|
@@ -2337,42 +2335,42 @@ export interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
|
2337
2335
|
*/
|
|
2338
2336
|
previousParticipantsChoices?: ParticipantChoices;
|
|
2339
2337
|
}
|
|
2340
|
-
|
|
2338
|
+
interface BulkCalculateAllowedActionsRequest {
|
|
2341
2339
|
/**
|
|
2342
2340
|
* The booking IDs for which we want to calculate the allowed actions.
|
|
2343
2341
|
* @minSize 1
|
|
2344
2342
|
*/
|
|
2345
2343
|
bookingIds?: string[] | null;
|
|
2346
2344
|
}
|
|
2347
|
-
|
|
2345
|
+
interface BulkCalculateAllowedActionsResponse {
|
|
2348
2346
|
results?: BulkCalculateAllowedActionsResult[];
|
|
2349
2347
|
/** Total number of successes and failures for Bulk Calculate Allowed Actions. */
|
|
2350
2348
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2351
2349
|
}
|
|
2352
|
-
|
|
2350
|
+
interface BulkCalculateAllowedActionsResult {
|
|
2353
2351
|
/** Metadata for the booking. Including ID, index in the provided sequence, success status, and error. */
|
|
2354
2352
|
itemMetadata?: ItemMetadata;
|
|
2355
2353
|
/** Booking entity. */
|
|
2356
2354
|
item?: AllowedActions;
|
|
2357
2355
|
}
|
|
2358
2356
|
/** Possible actions allowed for the booking. */
|
|
2359
|
-
|
|
2357
|
+
interface AllowedActions {
|
|
2360
2358
|
/** Whether canceling the booking is allowed. */
|
|
2361
2359
|
cancel?: boolean;
|
|
2362
2360
|
/** Whether rescheduling the booking is allowed. */
|
|
2363
2361
|
reschedule?: boolean;
|
|
2364
2362
|
}
|
|
2365
|
-
|
|
2363
|
+
interface GetSlotAvailabilityRequest {
|
|
2366
2364
|
/** The slot for which the availability is checked. */
|
|
2367
2365
|
slot?: V2Slot;
|
|
2368
2366
|
/** The timezone for which availability is to be calculated. */
|
|
2369
2367
|
timezone?: string | null;
|
|
2370
2368
|
}
|
|
2371
|
-
|
|
2369
|
+
interface GetSlotAvailabilityResponse {
|
|
2372
2370
|
availability?: SlotAvailability;
|
|
2373
2371
|
bookingPolicySettings?: BookingPolicySettings;
|
|
2374
2372
|
}
|
|
2375
|
-
|
|
2373
|
+
interface SlotAvailability {
|
|
2376
2374
|
/** Identifier for the underlying session when the session is a single session or generated from a recurring session. Required. */
|
|
2377
2375
|
slot?: V2Slot;
|
|
2378
2376
|
/** Whether this available slot is bookable. */
|
|
@@ -2394,7 +2392,7 @@ export interface SlotAvailability {
|
|
|
2394
2392
|
/** Indicates whether this slot is locked. */
|
|
2395
2393
|
locked?: boolean | null;
|
|
2396
2394
|
}
|
|
2397
|
-
|
|
2395
|
+
interface WaitingList {
|
|
2398
2396
|
/**
|
|
2399
2397
|
* Total number of spots and open spots for this waiting list.
|
|
2400
2398
|
* For example, a Yoga class of 10 waiting list spots with 3 registered on the waiting list has `total_spots`: 10 and `open_spots`: 7.
|
|
@@ -2402,7 +2400,7 @@ export interface WaitingList {
|
|
|
2402
2400
|
totalSpots?: number | null;
|
|
2403
2401
|
openSpots?: number | null;
|
|
2404
2402
|
}
|
|
2405
|
-
|
|
2403
|
+
interface BookingPolicyViolations {
|
|
2406
2404
|
/** Booking policy violation: Too early to book this slot. */
|
|
2407
2405
|
tooEarlyToBook?: boolean | null;
|
|
2408
2406
|
/** Booking policy violation: Too late to book this slot. */
|
|
@@ -2410,11 +2408,11 @@ export interface BookingPolicyViolations {
|
|
|
2410
2408
|
/** Booking policy violation: Online booking is disabled for this slot. */
|
|
2411
2409
|
bookOnlineDisabled?: boolean | null;
|
|
2412
2410
|
}
|
|
2413
|
-
|
|
2411
|
+
interface BookingPolicySettings {
|
|
2414
2412
|
/** Booking policy settings for a given slot or schedule. */
|
|
2415
2413
|
maxParticipantsPerBooking?: number | null;
|
|
2416
2414
|
}
|
|
2417
|
-
|
|
2415
|
+
interface AvailableResources {
|
|
2418
2416
|
/**
|
|
2419
2417
|
* Resource type ID.
|
|
2420
2418
|
* @format GUID
|
|
@@ -2429,18 +2427,18 @@ export interface AvailableResources {
|
|
|
2429
2427
|
*/
|
|
2430
2428
|
resourceIds?: string[];
|
|
2431
2429
|
}
|
|
2432
|
-
|
|
2430
|
+
interface GetScheduleAvailabilityRequest {
|
|
2433
2431
|
/**
|
|
2434
2432
|
* ID of the schedule for which to check availability.
|
|
2435
2433
|
* @format GUID
|
|
2436
2434
|
*/
|
|
2437
2435
|
scheduleId?: string;
|
|
2438
2436
|
}
|
|
2439
|
-
|
|
2437
|
+
interface GetScheduleAvailabilityResponse {
|
|
2440
2438
|
availability?: ScheduleAvailability;
|
|
2441
2439
|
bookingPolicySettings?: BookingPolicySettings;
|
|
2442
2440
|
}
|
|
2443
|
-
|
|
2441
|
+
interface ScheduleAvailability {
|
|
2444
2442
|
/** Total number of spots. */
|
|
2445
2443
|
totalSpots?: number | null;
|
|
2446
2444
|
/** Number of remaining open spots. */
|
|
@@ -2448,7 +2446,7 @@ export interface ScheduleAvailability {
|
|
|
2448
2446
|
/** Indicators of booking policy violations for the specified schedule. */
|
|
2449
2447
|
bookingPolicyViolations?: BookingPolicyViolations;
|
|
2450
2448
|
}
|
|
2451
|
-
|
|
2449
|
+
interface MarkBookingAsPendingRequest {
|
|
2452
2450
|
/**
|
|
2453
2451
|
* ID of the booking to mark as `PENDING`.
|
|
2454
2452
|
* @format GUID
|
|
@@ -2481,7 +2479,7 @@ export interface MarkBookingAsPendingRequest {
|
|
|
2481
2479
|
*/
|
|
2482
2480
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
2483
2481
|
}
|
|
2484
|
-
|
|
2482
|
+
interface MarkBookingAsPendingFlowControlSettings {
|
|
2485
2483
|
/**
|
|
2486
2484
|
* Whether to check for double bookings before updating the booking as pending.
|
|
2487
2485
|
*
|
|
@@ -2497,11 +2495,11 @@ export interface MarkBookingAsPendingFlowControlSettings {
|
|
|
2497
2495
|
*/
|
|
2498
2496
|
skipPendingApprovalServiceValidation?: boolean;
|
|
2499
2497
|
}
|
|
2500
|
-
|
|
2498
|
+
interface MarkBookingAsPendingResponse {
|
|
2501
2499
|
/** Updated booking. */
|
|
2502
2500
|
booking?: Booking;
|
|
2503
2501
|
}
|
|
2504
|
-
|
|
2502
|
+
interface BookingMarkedAsPending {
|
|
2505
2503
|
/** The booking object that was marked as pending. */
|
|
2506
2504
|
booking?: Booking;
|
|
2507
2505
|
/** Information about whether to notify the customer upon manual confirmation of the pending booking and the message to send. */
|
|
@@ -2520,24 +2518,24 @@ export interface BookingMarkedAsPending {
|
|
|
2520
2518
|
/** The previous payment status of the booking. */
|
|
2521
2519
|
previousPaymentStatus?: PaymentStatus;
|
|
2522
2520
|
}
|
|
2523
|
-
|
|
2521
|
+
interface MigrationCheckIfClashesWithBlockedTimeRequest {
|
|
2524
2522
|
msidAndBookingIds?: MsidAndBookingId[];
|
|
2525
2523
|
}
|
|
2526
|
-
|
|
2524
|
+
interface MsidAndBookingId {
|
|
2527
2525
|
msid?: string;
|
|
2528
2526
|
bookingId?: string;
|
|
2529
2527
|
}
|
|
2530
|
-
|
|
2528
|
+
interface MigrationCheckIfClashesWithBlockedTimeResponse {
|
|
2531
2529
|
clashes?: Clash[];
|
|
2532
2530
|
}
|
|
2533
|
-
|
|
2531
|
+
interface Clash {
|
|
2534
2532
|
msid?: string;
|
|
2535
2533
|
bookingId?: string;
|
|
2536
2534
|
sessionId?: string;
|
|
2537
2535
|
resourceName?: string;
|
|
2538
2536
|
contactName?: string;
|
|
2539
2537
|
}
|
|
2540
|
-
|
|
2538
|
+
interface CountBookingsRequest {
|
|
2541
2539
|
/**
|
|
2542
2540
|
* Filter object in the following format:
|
|
2543
2541
|
* `"filter" : {
|
|
@@ -2548,11 +2546,11 @@ export interface CountBookingsRequest {
|
|
|
2548
2546
|
*/
|
|
2549
2547
|
filter?: Record<string, any> | null;
|
|
2550
2548
|
}
|
|
2551
|
-
|
|
2549
|
+
interface CountBookingsResponse {
|
|
2552
2550
|
/** Number of bookings matching the specified filter. */
|
|
2553
2551
|
count?: number;
|
|
2554
2552
|
}
|
|
2555
|
-
|
|
2553
|
+
interface CreateMultiServiceBookingRequest {
|
|
2556
2554
|
/**
|
|
2557
2555
|
* Single-service bookings to combine in a multi-service booking.
|
|
2558
2556
|
* @minSize 2
|
|
@@ -2581,23 +2579,23 @@ export interface CreateMultiServiceBookingRequest {
|
|
|
2581
2579
|
/** Multi service booking type. */
|
|
2582
2580
|
multiServiceBookingType?: MultiServiceBookingType;
|
|
2583
2581
|
}
|
|
2584
|
-
|
|
2582
|
+
interface CreateMultiServiceBookingResponse {
|
|
2585
2583
|
/**
|
|
2586
2584
|
* Created multi service booking.
|
|
2587
2585
|
* Contains the booking results in the same order as specified in the request.
|
|
2588
2586
|
*/
|
|
2589
2587
|
multiServiceBooking?: MultiServiceBooking;
|
|
2590
2588
|
}
|
|
2591
|
-
|
|
2589
|
+
interface MultiServiceBooking {
|
|
2592
2590
|
/**
|
|
2593
2591
|
* Multi-service booking ID.
|
|
2594
2592
|
* @format GUID
|
|
2595
2593
|
*/
|
|
2596
|
-
|
|
2594
|
+
_id?: string | null;
|
|
2597
2595
|
/** The created bookings that are part of the multi-service booking. */
|
|
2598
2596
|
bookings?: BookingResult[];
|
|
2599
2597
|
}
|
|
2600
|
-
|
|
2598
|
+
interface BookingResult {
|
|
2601
2599
|
/**
|
|
2602
2600
|
* Booking ID.
|
|
2603
2601
|
* @format GUID
|
|
@@ -2606,7 +2604,7 @@ export interface BookingResult {
|
|
|
2606
2604
|
/** Booking entity. */
|
|
2607
2605
|
booking?: Booking;
|
|
2608
2606
|
}
|
|
2609
|
-
|
|
2607
|
+
interface RescheduleMultiServiceBookingRequest {
|
|
2610
2608
|
/**
|
|
2611
2609
|
* ID of the multi service booking to reschedule.
|
|
2612
2610
|
* @format GUID
|
|
@@ -2629,7 +2627,7 @@ export interface RescheduleMultiServiceBookingRequest {
|
|
|
2629
2627
|
/** Whether to return the rescheduled bookings entities. */
|
|
2630
2628
|
returnFullEntity?: boolean;
|
|
2631
2629
|
}
|
|
2632
|
-
|
|
2630
|
+
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2633
2631
|
/**
|
|
2634
2632
|
* Total number of participants. Available only for services with variants.
|
|
2635
2633
|
* Specify when all participants book the same variant.
|
|
@@ -2656,7 +2654,7 @@ export interface RescheduleBookingInfo extends RescheduleBookingInfoParticipants
|
|
|
2656
2654
|
revision?: string | null;
|
|
2657
2655
|
}
|
|
2658
2656
|
/** @oneof */
|
|
2659
|
-
|
|
2657
|
+
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2660
2658
|
/**
|
|
2661
2659
|
* Total number of participants. Available only for services with variants.
|
|
2662
2660
|
* Specify when all participants book the same variant.
|
|
@@ -2669,18 +2667,18 @@ export interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
|
2669
2667
|
*/
|
|
2670
2668
|
participantsChoices?: ParticipantChoices;
|
|
2671
2669
|
}
|
|
2672
|
-
|
|
2670
|
+
interface RescheduleMultiServiceBookingResponse {
|
|
2673
2671
|
/** Rescheduled multi-service booking. */
|
|
2674
2672
|
multiServiceBooking?: MultiServiceBooking;
|
|
2675
2673
|
}
|
|
2676
|
-
|
|
2674
|
+
interface GetMultiServiceBookingAvailabilityRequest {
|
|
2677
2675
|
/**
|
|
2678
2676
|
* ID of the multi-service booking to retrieve.
|
|
2679
2677
|
* @format GUID
|
|
2680
2678
|
*/
|
|
2681
2679
|
multiServiceBookingId: string | null;
|
|
2682
2680
|
}
|
|
2683
|
-
|
|
2681
|
+
interface GetMultiServiceBookingAvailabilityResponse {
|
|
2684
2682
|
/** Whether all contained single-service bookings are bookable. */
|
|
2685
2683
|
bookable?: boolean;
|
|
2686
2684
|
/** Total number of spots. */
|
|
@@ -2694,14 +2692,14 @@ export interface GetMultiServiceBookingAvailabilityResponse {
|
|
|
2694
2692
|
/** Info of the bookings this availability was calculated for. */
|
|
2695
2693
|
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
2696
2694
|
}
|
|
2697
|
-
|
|
2695
|
+
interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
2698
2696
|
/**
|
|
2699
2697
|
* Booking ID.
|
|
2700
2698
|
* @format GUID
|
|
2701
2699
|
*/
|
|
2702
2700
|
bookingId?: string | null;
|
|
2703
2701
|
}
|
|
2704
|
-
|
|
2702
|
+
interface CancelMultiServiceBookingRequest {
|
|
2705
2703
|
/**
|
|
2706
2704
|
* ID of the multi-service booking to cancel.
|
|
2707
2705
|
* @format GUID
|
|
@@ -2722,11 +2720,11 @@ export interface CancelMultiServiceBookingRequest {
|
|
|
2722
2720
|
/** Whether to return the canceled single-service bookings. */
|
|
2723
2721
|
returnFullEntity?: boolean;
|
|
2724
2722
|
}
|
|
2725
|
-
|
|
2723
|
+
interface CancelMultiServiceBookingResponse {
|
|
2726
2724
|
/** Canceled multi-service booking. */
|
|
2727
2725
|
multiServiceBooking?: MultiServiceBooking;
|
|
2728
2726
|
}
|
|
2729
|
-
|
|
2727
|
+
interface MarkMultiServiceBookingAsPendingRequest {
|
|
2730
2728
|
/**
|
|
2731
2729
|
* ID of the multi-service booking to mark as `PENDING`.
|
|
2732
2730
|
* @format GUID
|
|
@@ -2757,7 +2755,7 @@ export interface MarkMultiServiceBookingAsPendingRequest {
|
|
|
2757
2755
|
*/
|
|
2758
2756
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
2759
2757
|
}
|
|
2760
|
-
|
|
2758
|
+
interface BookingInfo {
|
|
2761
2759
|
/**
|
|
2762
2760
|
* ID of the single-service booking.
|
|
2763
2761
|
* @format GUID
|
|
@@ -2772,11 +2770,11 @@ export interface BookingInfo {
|
|
|
2772
2770
|
/** Payment status to set for the single-service booking. */
|
|
2773
2771
|
paymentStatus?: PaymentStatus;
|
|
2774
2772
|
}
|
|
2775
|
-
|
|
2773
|
+
interface MarkMultiServiceBookingAsPendingResponse {
|
|
2776
2774
|
/** Updated multi-service booking. */
|
|
2777
2775
|
multiServiceBooking?: MultiServiceBooking;
|
|
2778
2776
|
}
|
|
2779
|
-
|
|
2777
|
+
interface ConfirmMultiServiceBookingRequest {
|
|
2780
2778
|
/**
|
|
2781
2779
|
* ID of the multi-service booking to confirm its related bookings.
|
|
2782
2780
|
* @format GUID
|
|
@@ -2807,11 +2805,11 @@ export interface ConfirmMultiServiceBookingRequest {
|
|
|
2807
2805
|
*/
|
|
2808
2806
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
2809
2807
|
}
|
|
2810
|
-
|
|
2808
|
+
interface ConfirmMultiServiceBookingResponse {
|
|
2811
2809
|
/** Confirmed multi service booking. */
|
|
2812
2810
|
multiServiceBooking?: MultiServiceBooking;
|
|
2813
2811
|
}
|
|
2814
|
-
|
|
2812
|
+
interface DeclineMultiServiceBookingRequest {
|
|
2815
2813
|
/**
|
|
2816
2814
|
* ID of the multi service booking to decline.
|
|
2817
2815
|
* @format GUID
|
|
@@ -2834,11 +2832,11 @@ export interface DeclineMultiServiceBookingRequest {
|
|
|
2834
2832
|
*/
|
|
2835
2833
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2836
2834
|
}
|
|
2837
|
-
|
|
2835
|
+
interface DeclineMultiServiceBookingResponse {
|
|
2838
2836
|
/** Declined multi-service booking. */
|
|
2839
2837
|
multiServiceBooking?: MultiServiceBooking;
|
|
2840
2838
|
}
|
|
2841
|
-
|
|
2839
|
+
interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
2842
2840
|
/**
|
|
2843
2841
|
* IDs of the multi-service bookings to retrieve allowed actions for.
|
|
2844
2842
|
* @format GUID
|
|
@@ -2847,7 +2845,7 @@ export interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
|
2847
2845
|
*/
|
|
2848
2846
|
multiServiceBookingIds: string[] | null;
|
|
2849
2847
|
}
|
|
2850
|
-
|
|
2848
|
+
interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
2851
2849
|
/**
|
|
2852
2850
|
* Information about the multi-service bookings that were retrieved.
|
|
2853
2851
|
* Including their ID, index in the bulk request and whether they were
|
|
@@ -2857,20 +2855,20 @@ export interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
|
2857
2855
|
/** Total number of successes and failures for Bulk Update Bookings. */
|
|
2858
2856
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2859
2857
|
}
|
|
2860
|
-
|
|
2858
|
+
interface GetMultiServiceBookingRequest {
|
|
2861
2859
|
/**
|
|
2862
2860
|
* ID of the multi-service booking.
|
|
2863
2861
|
* @format GUID
|
|
2864
2862
|
*/
|
|
2865
2863
|
multiServiceBookingId: string | null;
|
|
2866
2864
|
}
|
|
2867
|
-
|
|
2865
|
+
interface GetMultiServiceBookingResponse {
|
|
2868
2866
|
/** Retrieved multi-service booking. */
|
|
2869
2867
|
multiServiceBooking?: MultiServiceBooking;
|
|
2870
2868
|
/** Details about how many single-service bookings belong to the multi-service booking. */
|
|
2871
2869
|
metadata?: MultiServiceBookingMetadata;
|
|
2872
2870
|
}
|
|
2873
|
-
|
|
2871
|
+
interface MultiServiceBookingMetadata {
|
|
2874
2872
|
/**
|
|
2875
2873
|
* Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
|
|
2876
2874
|
* to the multi-service booking. The total includes the number of single-service
|
|
@@ -2878,7 +2876,7 @@ export interface MultiServiceBookingMetadata {
|
|
|
2878
2876
|
*/
|
|
2879
2877
|
totalNumberOfScheduledBookings?: number | null;
|
|
2880
2878
|
}
|
|
2881
|
-
|
|
2879
|
+
interface AddBookingsToMultiServiceBookingRequest {
|
|
2882
2880
|
/**
|
|
2883
2881
|
* ID of the multi-service booking.
|
|
2884
2882
|
* @format GUID
|
|
@@ -2892,7 +2890,7 @@ export interface AddBookingsToMultiServiceBookingRequest {
|
|
|
2892
2890
|
/** Whether to return the single-service bookings that were added to the multi-service booking. */
|
|
2893
2891
|
returnFullEntity?: boolean;
|
|
2894
2892
|
}
|
|
2895
|
-
|
|
2893
|
+
interface BookingIdAndRevision {
|
|
2896
2894
|
/**
|
|
2897
2895
|
* ID of the booking.
|
|
2898
2896
|
* @format GUID
|
|
@@ -2905,11 +2903,11 @@ export interface BookingIdAndRevision {
|
|
|
2905
2903
|
*/
|
|
2906
2904
|
revision?: string | null;
|
|
2907
2905
|
}
|
|
2908
|
-
|
|
2906
|
+
interface AddBookingsToMultiServiceBookingResponse {
|
|
2909
2907
|
/** Single-service bookings that were added to the multi-service booking. */
|
|
2910
2908
|
bookings?: BookingResult[];
|
|
2911
2909
|
}
|
|
2912
|
-
|
|
2910
|
+
interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
2913
2911
|
/**
|
|
2914
2912
|
* ID of the multi-service booking.
|
|
2915
2913
|
* @format GUID
|
|
@@ -2923,7 +2921,403 @@ export interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
|
2923
2921
|
/** Whether to return the single-service bookings. */
|
|
2924
2922
|
returnFullEntity?: boolean;
|
|
2925
2923
|
}
|
|
2926
|
-
|
|
2924
|
+
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
2927
2925
|
/** Single-service bookings that were removed from the multi-service booking. */
|
|
2928
2926
|
bookings?: BookingResult[];
|
|
2929
2927
|
}
|
|
2928
|
+
interface BaseEventMetadata {
|
|
2929
|
+
/**
|
|
2930
|
+
* App instance ID.
|
|
2931
|
+
* @format GUID
|
|
2932
|
+
*/
|
|
2933
|
+
instanceId?: string | null;
|
|
2934
|
+
/**
|
|
2935
|
+
* Event type.
|
|
2936
|
+
* @maxLength 150
|
|
2937
|
+
*/
|
|
2938
|
+
eventType?: string;
|
|
2939
|
+
/** The identification type and identity data. */
|
|
2940
|
+
identity?: WebhooksIdentificationData;
|
|
2941
|
+
}
|
|
2942
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2943
|
+
/**
|
|
2944
|
+
* Unique event ID.
|
|
2945
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2946
|
+
*/
|
|
2947
|
+
_id?: string;
|
|
2948
|
+
/**
|
|
2949
|
+
* Assumes actions are also always typed to an entity_type
|
|
2950
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2951
|
+
*/
|
|
2952
|
+
entityFqdn?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2955
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2956
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2957
|
+
*/
|
|
2958
|
+
slug?: string;
|
|
2959
|
+
/** ID of the entity associated with the event. */
|
|
2960
|
+
entityId?: string;
|
|
2961
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2962
|
+
eventTime?: Date | null;
|
|
2963
|
+
/**
|
|
2964
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2965
|
+
* (for example, GDPR).
|
|
2966
|
+
*/
|
|
2967
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2968
|
+
/** If present, indicates the action that triggered the event. */
|
|
2969
|
+
originatedFrom?: string | null;
|
|
2970
|
+
/**
|
|
2971
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2972
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2973
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2974
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2975
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2976
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2977
|
+
*/
|
|
2978
|
+
entityEventSequence?: string | null;
|
|
2979
|
+
}
|
|
2980
|
+
interface BookingCanceledEnvelope {
|
|
2981
|
+
data: BookingCanceled;
|
|
2982
|
+
metadata: EventMetadata;
|
|
2983
|
+
}
|
|
2984
|
+
interface BookingConfirmedEnvelope {
|
|
2985
|
+
data: BookingConfirmed;
|
|
2986
|
+
metadata: EventMetadata;
|
|
2987
|
+
}
|
|
2988
|
+
interface BookingCreatedEnvelope {
|
|
2989
|
+
entity: Booking;
|
|
2990
|
+
metadata: EventMetadata;
|
|
2991
|
+
}
|
|
2992
|
+
interface BookingDeclinedEnvelope {
|
|
2993
|
+
data: BookingDeclined;
|
|
2994
|
+
metadata: EventMetadata;
|
|
2995
|
+
}
|
|
2996
|
+
interface BookingNumberOfParticipantsUpdatedEnvelope {
|
|
2997
|
+
data: NumberOfParticipantsUpdated;
|
|
2998
|
+
metadata: EventMetadata;
|
|
2999
|
+
}
|
|
3000
|
+
interface BookingRescheduledEnvelope {
|
|
3001
|
+
data: BookingRescheduled;
|
|
3002
|
+
metadata: EventMetadata;
|
|
3003
|
+
}
|
|
3004
|
+
interface BookingUpdatedEnvelope {
|
|
3005
|
+
entity: Booking;
|
|
3006
|
+
metadata: EventMetadata;
|
|
3007
|
+
}
|
|
3008
|
+
interface ConfirmOrDeclineBookingOptions {
|
|
3009
|
+
/**
|
|
3010
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
3011
|
+
* not the *eCommerce checkout*
|
|
3012
|
+
* ([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)).
|
|
3013
|
+
*
|
|
3014
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
3015
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
3016
|
+
*/
|
|
3017
|
+
paymentStatus?: PaymentStatus;
|
|
3018
|
+
}
|
|
3019
|
+
interface BulkConfirmOrDeclineBookingOptions {
|
|
3020
|
+
/** Whether to return the confirmed or declined booking objects. */
|
|
3021
|
+
returnEntity?: boolean;
|
|
3022
|
+
}
|
|
3023
|
+
interface CreateBookingOptions {
|
|
3024
|
+
/**
|
|
3025
|
+
* Information about whether to notify the customer and
|
|
3026
|
+
* the message to send.
|
|
3027
|
+
*/
|
|
3028
|
+
participantNotification?: ParticipantNotification;
|
|
3029
|
+
/**
|
|
3030
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3031
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3032
|
+
* Default: `true`.
|
|
3033
|
+
*/
|
|
3034
|
+
sendSmsReminder?: boolean | null;
|
|
3035
|
+
/**
|
|
3036
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3037
|
+
* For example, whether to check availability when creating a booking.
|
|
3038
|
+
*/
|
|
3039
|
+
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
3040
|
+
}
|
|
3041
|
+
interface BulkCreateBookingOptions {
|
|
3042
|
+
/** Whether to return the created bookings. */
|
|
3043
|
+
returnFullEntity?: boolean;
|
|
3044
|
+
}
|
|
3045
|
+
interface RescheduleBookingOptions extends RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
3046
|
+
/**
|
|
3047
|
+
* Revision number, which increments by 1 each time the booking is rescheduled.
|
|
3048
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
3049
|
+
* rescheduling the booking.
|
|
3050
|
+
*/
|
|
3051
|
+
revision: string | null;
|
|
3052
|
+
/**
|
|
3053
|
+
* Information about whether to notify the customer about the rescheduling and
|
|
3054
|
+
* the message to send.
|
|
3055
|
+
*/
|
|
3056
|
+
participantNotification?: ParticipantNotification;
|
|
3057
|
+
/**
|
|
3058
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3059
|
+
* For example, whether to check availability when rescheduling a booking.
|
|
3060
|
+
*/
|
|
3061
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
3062
|
+
/**
|
|
3063
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3064
|
+
* same service variant.
|
|
3065
|
+
*/
|
|
3066
|
+
totalParticipants?: number;
|
|
3067
|
+
/**
|
|
3068
|
+
* Information about the service choices to book. Specify when not all
|
|
3069
|
+
* participants have booked the same service variant.
|
|
3070
|
+
*/
|
|
3071
|
+
participantsChoices?: ParticipantChoices;
|
|
3072
|
+
}
|
|
3073
|
+
/** @oneof */
|
|
3074
|
+
interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
3075
|
+
/**
|
|
3076
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3077
|
+
* same service variant.
|
|
3078
|
+
*/
|
|
3079
|
+
totalParticipants?: number;
|
|
3080
|
+
/**
|
|
3081
|
+
* Information about the service choices to book. Specify when not all
|
|
3082
|
+
* participants have booked the same service variant.
|
|
3083
|
+
*/
|
|
3084
|
+
participantsChoices?: ParticipantChoices;
|
|
3085
|
+
}
|
|
3086
|
+
interface ConfirmBookingOptions {
|
|
3087
|
+
/**
|
|
3088
|
+
* Information about whether to notify the customer about the confirmation and
|
|
3089
|
+
* the message to send.
|
|
3090
|
+
*/
|
|
3091
|
+
participantNotification?: ParticipantNotification;
|
|
3092
|
+
/**
|
|
3093
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3094
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3095
|
+
*/
|
|
3096
|
+
sendSmsReminder?: boolean | null;
|
|
3097
|
+
/** Payment status to set for the booking. */
|
|
3098
|
+
paymentStatus?: PaymentStatus;
|
|
3099
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3100
|
+
doubleBooked?: boolean | null;
|
|
3101
|
+
/**
|
|
3102
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3103
|
+
* For example, whether to check availability when confirming a booking.
|
|
3104
|
+
*/
|
|
3105
|
+
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
3106
|
+
}
|
|
3107
|
+
interface UpdateExtendedFieldsOptions {
|
|
3108
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3109
|
+
namespaceData: Record<string, any> | null;
|
|
3110
|
+
}
|
|
3111
|
+
interface DeclineBookingOptions {
|
|
3112
|
+
/**
|
|
3113
|
+
* Information about whether to notify the customer and
|
|
3114
|
+
* the message to send.
|
|
3115
|
+
*/
|
|
3116
|
+
participantNotification?: ParticipantNotification;
|
|
3117
|
+
/** Payment status to set for the booking. */
|
|
3118
|
+
paymentStatus?: PaymentStatus;
|
|
3119
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3120
|
+
doubleBooked?: boolean | null;
|
|
3121
|
+
/**
|
|
3122
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3123
|
+
* For example, whether to refund a declined booking.
|
|
3124
|
+
*/
|
|
3125
|
+
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
3126
|
+
}
|
|
3127
|
+
interface CancelBookingOptions {
|
|
3128
|
+
/**
|
|
3129
|
+
* Information about whether to notify the customer about the cancellation and
|
|
3130
|
+
* the message to send.
|
|
3131
|
+
*/
|
|
3132
|
+
participantNotification?: ParticipantNotification;
|
|
3133
|
+
/**
|
|
3134
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3135
|
+
* For example, whether to allow a cancellation even though the service's
|
|
3136
|
+
* policy doesn't allow it.
|
|
3137
|
+
*/
|
|
3138
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
3139
|
+
/**
|
|
3140
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
3141
|
+
*
|
|
3142
|
+
* To prevent conflicting changes, the current revision must be specified when
|
|
3143
|
+
* managing the booking.
|
|
3144
|
+
*/
|
|
3145
|
+
revision: string | null;
|
|
3146
|
+
}
|
|
3147
|
+
interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
3148
|
+
/**
|
|
3149
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
3150
|
+
*
|
|
3151
|
+
* To prevent conflicting changes, the current revision must be specified
|
|
3152
|
+
* when updating the booking.
|
|
3153
|
+
*/
|
|
3154
|
+
revision: string | null;
|
|
3155
|
+
/**
|
|
3156
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3157
|
+
* same service variant.
|
|
3158
|
+
*/
|
|
3159
|
+
totalParticipants?: number;
|
|
3160
|
+
/**
|
|
3161
|
+
* Information about the service choices the participants have booked. Specify
|
|
3162
|
+
* when not all participants have booked the same service variant.
|
|
3163
|
+
*/
|
|
3164
|
+
participantsChoices?: ParticipantChoices;
|
|
3165
|
+
}
|
|
3166
|
+
/** @oneof */
|
|
3167
|
+
interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
3168
|
+
/**
|
|
3169
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3170
|
+
* same service variant.
|
|
3171
|
+
*/
|
|
3172
|
+
totalParticipants?: number;
|
|
3173
|
+
/**
|
|
3174
|
+
* Information about the service choices the participants have booked. Specify
|
|
3175
|
+
* when not all participants have booked the same service variant.
|
|
3176
|
+
*/
|
|
3177
|
+
participantsChoices?: ParticipantChoices;
|
|
3178
|
+
}
|
|
3179
|
+
interface CreateMultiServiceBookingOptions {
|
|
3180
|
+
/**
|
|
3181
|
+
* Information about whether to notify the customer and
|
|
3182
|
+
* the message to send.
|
|
3183
|
+
*/
|
|
3184
|
+
participantNotification?: ParticipantNotification;
|
|
3185
|
+
/**
|
|
3186
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3187
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3188
|
+
*
|
|
3189
|
+
* Default: `true`
|
|
3190
|
+
*/
|
|
3191
|
+
sendSmsReminder?: boolean | null;
|
|
3192
|
+
/**
|
|
3193
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3194
|
+
* For example, whether to check availability before updating the status.
|
|
3195
|
+
*/
|
|
3196
|
+
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
3197
|
+
/** Whether to return the created single-service bookings. */
|
|
3198
|
+
returnFullEntity?: boolean;
|
|
3199
|
+
/** Multi service booking type. */
|
|
3200
|
+
multiServiceBookingType?: MultiServiceBookingType;
|
|
3201
|
+
}
|
|
3202
|
+
interface RescheduleMultiServiceBookingOptions {
|
|
3203
|
+
/**
|
|
3204
|
+
* Information about whether to notify the customer and
|
|
3205
|
+
* the message to send.
|
|
3206
|
+
*/
|
|
3207
|
+
participantNotification?: ParticipantNotification;
|
|
3208
|
+
/**
|
|
3209
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3210
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
3211
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
3212
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
3213
|
+
*/
|
|
3214
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
3215
|
+
/** Whether to return the rescheduled bookings entities. */
|
|
3216
|
+
returnFullEntity?: boolean;
|
|
3217
|
+
}
|
|
3218
|
+
interface CancelMultiServiceBookingOptions {
|
|
3219
|
+
/**
|
|
3220
|
+
* Information about whether to notify the customer and
|
|
3221
|
+
* the message to send.
|
|
3222
|
+
*/
|
|
3223
|
+
participantNotification?: ParticipantNotification;
|
|
3224
|
+
/**
|
|
3225
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3226
|
+
* cancellation flow are changed. For example, whether you can cancel
|
|
3227
|
+
* a booking even though the cancellation policy doesn't allow it or whether
|
|
3228
|
+
* to issue a refund.
|
|
3229
|
+
*/
|
|
3230
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
3231
|
+
/** Whether to return the canceled single-service bookings. */
|
|
3232
|
+
returnFullEntity?: boolean;
|
|
3233
|
+
}
|
|
3234
|
+
interface MarkMultiServiceBookingAsPendingOptions {
|
|
3235
|
+
/** Information about the single-service bookings to mark as `PENDING`. */
|
|
3236
|
+
markAsPendingBookingsInfo?: BookingInfo[];
|
|
3237
|
+
/**
|
|
3238
|
+
* Information about whether to notify the customer and
|
|
3239
|
+
* the message to send.
|
|
3240
|
+
*/
|
|
3241
|
+
participantNotification?: ParticipantNotification;
|
|
3242
|
+
/**
|
|
3243
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3244
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3245
|
+
*
|
|
3246
|
+
* Default: `true`
|
|
3247
|
+
*/
|
|
3248
|
+
sendSmsReminder?: boolean | null;
|
|
3249
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3250
|
+
doubleBooked?: boolean | null;
|
|
3251
|
+
/** Whether to return the single-service bookings that were marked as `PENDING`. */
|
|
3252
|
+
returnFullEntity?: boolean;
|
|
3253
|
+
/**
|
|
3254
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3255
|
+
* creation flow are changed. For example, whether the availability is checked
|
|
3256
|
+
* before updating the booking.
|
|
3257
|
+
*/
|
|
3258
|
+
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
3259
|
+
}
|
|
3260
|
+
interface ConfirmMultiServiceBookingOptions {
|
|
3261
|
+
/** Information about the single-service bookings to confirm. */
|
|
3262
|
+
confirmBookingsInfo?: BookingInfo[];
|
|
3263
|
+
/**
|
|
3264
|
+
* Information about whether to notify the customer and
|
|
3265
|
+
* the message to send.
|
|
3266
|
+
*/
|
|
3267
|
+
participantNotification?: ParticipantNotification;
|
|
3268
|
+
/**
|
|
3269
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3270
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3271
|
+
*
|
|
3272
|
+
* Default: `true`
|
|
3273
|
+
*/
|
|
3274
|
+
sendSmsReminder?: boolean | null;
|
|
3275
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3276
|
+
doubleBooked?: boolean | null;
|
|
3277
|
+
/** Whether to return the confirmed single-service bookings. */
|
|
3278
|
+
returnFullEntity?: boolean;
|
|
3279
|
+
/**
|
|
3280
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3281
|
+
* confirmation flow are changed. For example, whether the availability is
|
|
3282
|
+
* checked before confirming the booking.
|
|
3283
|
+
*/
|
|
3284
|
+
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
3285
|
+
}
|
|
3286
|
+
interface DeclineMultiServiceBookingOptions {
|
|
3287
|
+
/** Information about the single-service bookings to decline. */
|
|
3288
|
+
declineBookingsInfo?: BookingInfo[];
|
|
3289
|
+
/**
|
|
3290
|
+
* Information about whether to notify the customer and
|
|
3291
|
+
* the message to send.
|
|
3292
|
+
*/
|
|
3293
|
+
participantNotification?: ParticipantNotification;
|
|
3294
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3295
|
+
doubleBooked?: boolean | null;
|
|
3296
|
+
/** Whether to return the declined single-service bookings. */
|
|
3297
|
+
returnFullEntity?: boolean;
|
|
3298
|
+
/**
|
|
3299
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3300
|
+
* declining flow are changed. For example, whether to issue a refund.
|
|
3301
|
+
*/
|
|
3302
|
+
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
3303
|
+
}
|
|
3304
|
+
interface AddBookingsToMultiServiceBookingOptions {
|
|
3305
|
+
/**
|
|
3306
|
+
* List of single-service booking IDs and their revision.
|
|
3307
|
+
* @maxSize 8
|
|
3308
|
+
*/
|
|
3309
|
+
bookings: BookingIdAndRevision[];
|
|
3310
|
+
/** Whether to return the single-service bookings that were added to the multi-service booking. */
|
|
3311
|
+
returnFullEntity?: boolean;
|
|
3312
|
+
}
|
|
3313
|
+
interface RemoveBookingsFromMultiServiceBookingOptions {
|
|
3314
|
+
/**
|
|
3315
|
+
* List of single-service booking IDs and their revision.
|
|
3316
|
+
* @maxSize 8
|
|
3317
|
+
*/
|
|
3318
|
+
bookings?: BookingIdAndRevision[];
|
|
3319
|
+
/** Whether to return the single-service bookings. */
|
|
3320
|
+
returnFullEntity?: boolean;
|
|
3321
|
+
}
|
|
3322
|
+
|
|
3323
|
+
export { WebhookIdentityType as $, type ConfirmMultiServiceBookingOptions as A, type BulkConfirmOrDeclineBookingRequestBookingDetails as B, type ConfirmOrDeclineBookingOptions as C, type DeclineBookingOptions as D, type ConfirmMultiServiceBookingResponse as E, type DeclineMultiServiceBookingOptions as F, type GetMultiServiceBookingAvailabilityResponse as G, type DeclineMultiServiceBookingResponse as H, type BulkGetMultiServiceBookingAllowedActionsResponse as I, type MultiServiceBooking as J, type AddBookingsToMultiServiceBookingOptions as K, type AddBookingsToMultiServiceBookingResponse as L, type MarkMultiServiceBookingAsPendingOptions as M, type RemoveBookingsFromMultiServiceBookingOptions as N, type RemoveBookingsFromMultiServiceBookingResponse as O, MultiServiceBookingType as P, LocationType as Q, type RescheduleBookingOptions as R, ValueType as S, BookingStatus as T, type UpdateExtendedFieldsOptions as U, type V2Slot as V, PaymentStatus as W, SelectedPaymentOption as X, Platform as Y, Actor as Z, IdentificationDataIdentityType as _, type ConfirmOrDeclineBookingResponse as a, type V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as a$, LocationLocationType as a0, IdentityType as a1, SortOrder as a2, type BookingParticipantsInfoOneOf as a3, type BookedEntity as a4, type BookedEntityItemOneOf as a5, type BookedSlot as a6, type BookedResource as a7, type Location as a8, type BookedSchedule as a9, type EntityCreatedEvent as aA, type RestoreInfo as aB, type EntityUpdatedEvent as aC, type EntityDeletedEvent as aD, type ActionEvent as aE, type MessageEnvelope as aF, type WebhooksIdentificationData as aG, type WebhooksIdentificationDataIdOneOf as aH, type V2CreateBookingRequest as aI, type V2CreateBookingRequestBookableItemOneOf as aJ, type V2CreateBookingRequestParticipantsInfoOneOf as aK, type Slot as aL, type SlotResource as aM, type CreateBookingRequestFlowControlSettings as aN, type V2CreateBookingResponse as aO, type V2CancelBookingRequest as aP, type CancelBookingRequestFlowControlSettings as aQ, type V2CancelBookingResponse as aR, type V2RescheduleBookingRequest as aS, type V2RescheduleBookingRequestParticipantsInfoOneOf as aT, type RescheduleBookingRequestFlowControlSettings as aU, type V2RescheduleBookingResponse as aV, type V2ConfirmBookingRequest as aW, type V2ConfirmBookingResponse as aX, type V2DeclineBookingRequest as aY, type V2DeclineBookingResponse as aZ, type V2UpdateNumberOfParticipantsRequest as a_, type ContactDetails as aa, type Address as ab, type AddressStreetOneOf as ac, type StreetAddress as ad, type AddressLocation as ae, type Subdivision as af, type CustomFormField as ag, type BookingSource as ah, type ParticipantNotification as ai, type CommonIdentificationData as aj, type CommonIdentificationDataIdOneOf as ak, type FlowControlSettings as al, type ExtendedFields as am, type ParticipantChoices as an, type ServiceChoices as ao, type ServiceChoice as ap, type ServiceChoiceChoiceOneOf as aq, type Duration as ar, type MultiServiceBookingInfo as as, type BookedAddOn as at, type BookingFormFilled as au, type SetBookingFormAndSubmissionIdRequest as av, type SetBookingFormAndSubmissionIdRequestCreatedByOneOf as aw, type SetBookingFormAndSubmissionIdResponse as ax, type DomainEvent as ay, type DomainEventBodyOneOf as az, type BulkConfirmOrDeclineBookingOptions as b, type NumberOfParticipantsUpdated as b$, type V2UpdateNumberOfParticipantsResponse as b0, type ConfirmOrDeclineBookingRequest as b1, type BulkConfirmOrDeclineBookingRequest as b2, type BulkBookingResult as b3, type ItemMetadata as b4, type ApplicationError as b5, type BulkActionMetadata as b6, type BookingChanged as b7, type CreateBookingRequest as b8, type CreateBookingFlowControlSettings as b9, type QueryV2PagingMethodOneOf as bA, type Sorting as bB, type Paging as bC, type CursorPaging as bD, type QueryBookingsResponse as bE, type PagingMetadataV2 as bF, type Cursors as bG, type ConfirmRequest as bH, type ConfirmResponse as bI, type ConfirmBookingRequest as bJ, type ConfirmBookingFlowControlSettings as bK, type BookingConfirmed as bL, type ConsistentQueryBookingsRequest as bM, type ConsistentQueryBookingsResponse as bN, type SetBookingSessionIdRequest as bO, type SetBookingSessionIdResponse as bP, type SetBookingSubmissionIdRequest as bQ, type SetBookingSubmissionIdResponse as bR, type UpdateExtendedFieldsRequest as bS, type DeclineBookingRequest as bT, type DeclineBookingFlowControlSettings as bU, type BookingDeclined as bV, type CancelBookingRequest as bW, type CancelBookingFlowControlSettings as bX, type BookingCanceled as bY, type UpdateNumberOfParticipantsRequest as bZ, type UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as b_, type UpdateBookingRequest as ba, type UpdateBookingResponse as bb, type LegacyCreateBookingRequest as bc, type LegacyCreateBookingResponse as bd, type BulkUpdateBookingRequest as be, type MaskedBooking as bf, type BulkUpdateBookingResponse as bg, type BulkCreateBookingRequest as bh, type RescheduleBookingRequest as bi, type RescheduleBookingRequestParticipantsInfoOneOf as bj, type SlotSlotResource as bk, type SlotLocation as bl, type RescheduleBookingFlowControlSettings as bm, type BookingRescheduled as bn, type BookingRescheduledPreviousParticipantsInfoOneOf as bo, type IdentificationData as bp, type IdentificationDataIdOneOf as bq, type BulkRescheduleBookingRequest as br, type BulkRescheduleBookingRequestBooking as bs, type SlotBookings as bt, type BulkRescheduleBookingResponse as bu, type BulkUpdateBookedScheduleRequest as bv, type BookingDetails as bw, type BulkUpdateBookedScheduleResponse as bx, type QueryBookingsRequest as by, type QueryV2 as bz, type BulkConfirmOrDeclineBookingResponse as c, type NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf as c0, type BulkCalculateAllowedActionsRequest as c1, type BulkCalculateAllowedActionsResponse as c2, type BulkCalculateAllowedActionsResult as c3, type AllowedActions as c4, type GetSlotAvailabilityRequest as c5, type GetSlotAvailabilityResponse as c6, type SlotAvailability as c7, type WaitingList as c8, type BookingPolicyViolations as c9, type BulkGetMultiServiceBookingAllowedActionsRequest as cA, type GetMultiServiceBookingRequest as cB, type GetMultiServiceBookingResponse as cC, type MultiServiceBookingMetadata as cD, type AddBookingsToMultiServiceBookingRequest as cE, type BookingIdAndRevision as cF, type RemoveBookingsFromMultiServiceBookingRequest as cG, type BaseEventMetadata as cH, type EventMetadata as cI, type BookingCanceledEnvelope as cJ, type BookingConfirmedEnvelope as cK, type BookingCreatedEnvelope as cL, type BookingDeclinedEnvelope as cM, type BookingNumberOfParticipantsUpdatedEnvelope as cN, type BookingRescheduledEnvelope as cO, type BookingUpdatedEnvelope as cP, type RescheduleBookingOptionsParticipantsInfoOneOf as cQ, type UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf as cR, type BookingPolicySettings as ca, type AvailableResources as cb, type GetScheduleAvailabilityRequest as cc, type GetScheduleAvailabilityResponse as cd, type ScheduleAvailability as ce, type MarkBookingAsPendingRequest as cf, type MarkBookingAsPendingFlowControlSettings as cg, type MarkBookingAsPendingResponse as ch, type BookingMarkedAsPending as ci, type MigrationCheckIfClashesWithBlockedTimeRequest as cj, type MsidAndBookingId as ck, type MigrationCheckIfClashesWithBlockedTimeResponse as cl, type Clash as cm, type CountBookingsRequest as cn, type CountBookingsResponse as co, type CreateMultiServiceBookingRequest as cp, type BookingResult as cq, type RescheduleMultiServiceBookingRequest as cr, type RescheduleBookingInfoParticipantsInfoOneOf as cs, type GetMultiServiceBookingAvailabilityRequest as ct, type GetMultiServiceBookingAvailabilityResponseBookingInfo as cu, type CancelMultiServiceBookingRequest as cv, type MarkMultiServiceBookingAsPendingRequest as cw, type BookingInfo as cx, type ConfirmMultiServiceBookingRequest as cy, type DeclineMultiServiceBookingRequest as cz, type Booking as d, type CreateBookingOptions as e, type CreateBookingResponse as f, type CreateBookingInfo as g, type BulkCreateBookingOptions as h, type BulkCreateBookingResponse as i, type RescheduleBookingResponse as j, type ConfirmBookingOptions as k, type ConfirmBookingResponse as l, type UpdateExtendedFieldsResponse as m, type DeclineBookingResponse as n, type CancelBookingOptions as o, type CancelBookingResponse as p, type UpdateNumberOfParticipantsOptions as q, type UpdateNumberOfParticipantsResponse as r, type CreateMultiServiceBookingOptions as s, type CreateMultiServiceBookingResponse as t, type RescheduleBookingInfo as u, type RescheduleMultiServiceBookingOptions as v, type RescheduleMultiServiceBookingResponse as w, type CancelMultiServiceBookingOptions as x, type CancelMultiServiceBookingResponse as y, type MarkMultiServiceBookingAsPendingResponse as z };
|