@wix/auto_sdk_bookings_bookings 1.0.25 → 1.0.27
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-BEUtU-41.d.mts} +629 -247
- package/build/{cjs/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-BEUtU-41.d.ts} +629 -247
- package/build/{es/src/bookings-v2-booking-bookings.public.d.ts → index.d.mts} +84 -34
- package/build/{internal/cjs/src/bookings-v2-booking-bookings.public.d.ts → index.d.ts} +84 -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-BEUtU-41.d.mts} +629 -247
- package/build/internal/{es/src/bookings-v2-booking-bookings.types.d.ts → bookings-v2-booking-bookings.universal-BEUtU-41.d.ts} +629 -247
- package/build/{cjs/src/bookings-v2-booking-bookings.public.d.ts → internal/index.d.mts} +84 -34
- package/build/internal/{es/src/bookings-v2-booking-bookings.public.d.ts → index.d.ts} +84 -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 +1666 -0
- package/build/internal/meta.d.ts +1666 -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 +1666 -0
- package/build/meta.d.ts +1666 -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 +12 -11
- 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 -4359
- package/build/cjs/src/bookings-v2-booking-bookings.universal.js +0 -1654
- 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 -4359
- package/build/es/src/bookings-v2-booking-bookings.universal.js +0 -1607
- 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 -4359
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.js +0 -1654
- 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 -4359
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.js +0 -1607
- 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,14 +130,14 @@ 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
|
/** @enumType */
|
|
139
|
-
|
|
140
|
-
|
|
139
|
+
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
140
|
+
interface BookedEntity extends BookedEntityItemOneOf {
|
|
141
141
|
/**
|
|
142
142
|
* Booked *slot*
|
|
143
143
|
* ([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)).
|
|
@@ -169,7 +169,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
169
169
|
tags?: string[] | null;
|
|
170
170
|
}
|
|
171
171
|
/** @oneof */
|
|
172
|
-
|
|
172
|
+
interface BookedEntityItemOneOf {
|
|
173
173
|
/**
|
|
174
174
|
* Booked *slot*
|
|
175
175
|
* ([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)).
|
|
@@ -185,7 +185,7 @@ export interface BookedEntityItemOneOf {
|
|
|
185
185
|
*/
|
|
186
186
|
schedule?: BookedSchedule;
|
|
187
187
|
}
|
|
188
|
-
|
|
188
|
+
interface BookedSlot {
|
|
189
189
|
/** Session ID. */
|
|
190
190
|
sessionId?: string | null;
|
|
191
191
|
/** Service ID. */
|
|
@@ -227,12 +227,12 @@ export interface BookedSlot {
|
|
|
227
227
|
/** Location where the session takes place. */
|
|
228
228
|
location?: Location;
|
|
229
229
|
}
|
|
230
|
-
|
|
230
|
+
interface BookedResource {
|
|
231
231
|
/**
|
|
232
232
|
* ID of the booking's primary resource.
|
|
233
233
|
* @format GUID
|
|
234
234
|
*/
|
|
235
|
-
|
|
235
|
+
_id?: string;
|
|
236
236
|
/**
|
|
237
237
|
* Resource's name at the time of booking.
|
|
238
238
|
* @maxLength 40
|
|
@@ -249,13 +249,13 @@ export interface BookedResource {
|
|
|
249
249
|
*/
|
|
250
250
|
scheduleId?: string | null;
|
|
251
251
|
}
|
|
252
|
-
|
|
252
|
+
interface Location {
|
|
253
253
|
/**
|
|
254
254
|
* Business location ID. Available only for locations that are business locations,
|
|
255
255
|
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
256
256
|
* @format GUID
|
|
257
257
|
*/
|
|
258
|
-
|
|
258
|
+
_id?: string | null;
|
|
259
259
|
/** Location name. */
|
|
260
260
|
name?: string | null;
|
|
261
261
|
/** The full address of this location. */
|
|
@@ -274,15 +274,15 @@ export interface Location {
|
|
|
274
274
|
*/
|
|
275
275
|
locationType?: LocationTypeWithLiterals;
|
|
276
276
|
}
|
|
277
|
-
|
|
277
|
+
declare enum LocationType {
|
|
278
278
|
UNDEFINED = "UNDEFINED",
|
|
279
279
|
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
280
280
|
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
281
281
|
CUSTOM = "CUSTOM"
|
|
282
282
|
}
|
|
283
283
|
/** @enumType */
|
|
284
|
-
|
|
285
|
-
|
|
284
|
+
type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
|
|
285
|
+
interface BookedSchedule {
|
|
286
286
|
/**
|
|
287
287
|
* _Schedule ID_
|
|
288
288
|
* ([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)).
|
|
@@ -318,7 +318,7 @@ export interface BookedSchedule {
|
|
|
318
318
|
*/
|
|
319
319
|
lastSessionEnd?: string | null;
|
|
320
320
|
}
|
|
321
|
-
|
|
321
|
+
interface ContactDetails {
|
|
322
322
|
/**
|
|
323
323
|
* Contact ID.
|
|
324
324
|
* @format GUID
|
|
@@ -357,7 +357,7 @@ export interface ContactDetails {
|
|
|
357
357
|
countryCode?: string | null;
|
|
358
358
|
}
|
|
359
359
|
/** Physical address */
|
|
360
|
-
|
|
360
|
+
interface Address extends AddressStreetOneOf {
|
|
361
361
|
/** Street name, number and apartment number. */
|
|
362
362
|
streetAddress?: StreetAddress;
|
|
363
363
|
/** Main address line, usually street and number, as free text. */
|
|
@@ -387,13 +387,13 @@ export interface Address extends AddressStreetOneOf {
|
|
|
387
387
|
subdivisions?: Subdivision[];
|
|
388
388
|
}
|
|
389
389
|
/** @oneof */
|
|
390
|
-
|
|
390
|
+
interface AddressStreetOneOf {
|
|
391
391
|
/** Street name, number and apartment number. */
|
|
392
392
|
streetAddress?: StreetAddress;
|
|
393
393
|
/** Main address line, usually street and number, as free text. */
|
|
394
394
|
addressLine?: string | null;
|
|
395
395
|
}
|
|
396
|
-
|
|
396
|
+
interface StreetAddress {
|
|
397
397
|
/** Street number. */
|
|
398
398
|
number?: string;
|
|
399
399
|
/** Street name. */
|
|
@@ -401,24 +401,24 @@ export interface StreetAddress {
|
|
|
401
401
|
/** Apartment number. */
|
|
402
402
|
apt?: string;
|
|
403
403
|
}
|
|
404
|
-
|
|
404
|
+
interface AddressLocation {
|
|
405
405
|
/** Address latitude. */
|
|
406
406
|
latitude?: number | null;
|
|
407
407
|
/** Address longitude. */
|
|
408
408
|
longitude?: number | null;
|
|
409
409
|
}
|
|
410
|
-
|
|
410
|
+
interface Subdivision {
|
|
411
411
|
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
412
412
|
code?: string;
|
|
413
413
|
/** Subdivision full name. */
|
|
414
414
|
name?: string;
|
|
415
415
|
}
|
|
416
|
-
|
|
416
|
+
interface CustomFormField {
|
|
417
417
|
/**
|
|
418
418
|
* ID of the form field as defined in the form.
|
|
419
419
|
* @format GUID
|
|
420
420
|
*/
|
|
421
|
-
|
|
421
|
+
_id?: string;
|
|
422
422
|
/** Value that was submitted for this field. */
|
|
423
423
|
value?: string | null;
|
|
424
424
|
/**
|
|
@@ -428,7 +428,7 @@ export interface CustomFormField {
|
|
|
428
428
|
label?: string | null;
|
|
429
429
|
valueType?: ValueTypeWithLiterals;
|
|
430
430
|
}
|
|
431
|
-
|
|
431
|
+
declare enum ValueType {
|
|
432
432
|
/** Short text. This is the default value type. */
|
|
433
433
|
SHORT_TEXT = "SHORT_TEXT",
|
|
434
434
|
/** Long text. */
|
|
@@ -437,9 +437,9 @@ export declare enum ValueType {
|
|
|
437
437
|
CHECK_BOX = "CHECK_BOX"
|
|
438
438
|
}
|
|
439
439
|
/** @enumType */
|
|
440
|
-
|
|
440
|
+
type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
|
|
441
441
|
/** Booking status. */
|
|
442
|
-
|
|
442
|
+
declare enum BookingStatus {
|
|
443
443
|
/**
|
|
444
444
|
* The booking was created, but the customer hasn't completed the related
|
|
445
445
|
* eCommerce order yet.
|
|
@@ -477,12 +477,12 @@ export declare enum BookingStatus {
|
|
|
477
477
|
WAITING_LIST = "WAITING_LIST"
|
|
478
478
|
}
|
|
479
479
|
/** @enumType */
|
|
480
|
-
|
|
480
|
+
type BookingStatusWithLiterals = BookingStatus | 'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PENDING' | 'DECLINED' | 'WAITING_LIST';
|
|
481
481
|
/**
|
|
482
482
|
* Payment status.
|
|
483
483
|
* Automatically updated when using eCommerce checkout APIs.
|
|
484
484
|
*/
|
|
485
|
-
|
|
485
|
+
declare enum PaymentStatus {
|
|
486
486
|
/** Undefined payment status. */
|
|
487
487
|
UNDEFINED = "UNDEFINED",
|
|
488
488
|
/** The booking isn't paid. */
|
|
@@ -497,7 +497,7 @@ export declare enum PaymentStatus {
|
|
|
497
497
|
EXEMPT = "EXEMPT"
|
|
498
498
|
}
|
|
499
499
|
/** @enumType */
|
|
500
|
-
|
|
500
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_PAID' | 'REFUNDED' | 'EXEMPT';
|
|
501
501
|
/**
|
|
502
502
|
* Selected payment option.
|
|
503
503
|
*
|
|
@@ -505,7 +505,7 @@ export type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'NOT_PAID'
|
|
|
505
505
|
* This field is set when the user selects an option during booking.
|
|
506
506
|
* If left undefined, the payment option is resolved by the service configuration on checkout.
|
|
507
507
|
*/
|
|
508
|
-
|
|
508
|
+
declare enum SelectedPaymentOption {
|
|
509
509
|
/** Undefined payment option. */
|
|
510
510
|
UNDEFINED = "UNDEFINED",
|
|
511
511
|
/** Offline payment. */
|
|
@@ -521,8 +521,8 @@ export declare enum SelectedPaymentOption {
|
|
|
521
521
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
522
522
|
}
|
|
523
523
|
/** @enumType */
|
|
524
|
-
|
|
525
|
-
|
|
524
|
+
type SelectedPaymentOptionWithLiterals = SelectedPaymentOption | 'UNDEFINED' | 'OFFLINE' | 'ONLINE' | 'MEMBERSHIP' | 'MEMBERSHIP_OFFLINE';
|
|
525
|
+
interface BookingSource {
|
|
526
526
|
/** Platform from which a booking was created. */
|
|
527
527
|
platform?: PlatformWithLiterals;
|
|
528
528
|
/** Actor that created this booking. */
|
|
@@ -539,21 +539,21 @@ export interface BookingSource {
|
|
|
539
539
|
*/
|
|
540
540
|
appName?: string | null;
|
|
541
541
|
}
|
|
542
|
-
|
|
542
|
+
declare enum Platform {
|
|
543
543
|
UNDEFINED_PLATFORM = "UNDEFINED_PLATFORM",
|
|
544
544
|
WEB = "WEB",
|
|
545
545
|
MOBILE_APP = "MOBILE_APP"
|
|
546
546
|
}
|
|
547
547
|
/** @enumType */
|
|
548
|
-
|
|
549
|
-
|
|
548
|
+
type PlatformWithLiterals = Platform | 'UNDEFINED_PLATFORM' | 'WEB' | 'MOBILE_APP';
|
|
549
|
+
declare enum Actor {
|
|
550
550
|
UNDEFINED_ACTOR = "UNDEFINED_ACTOR",
|
|
551
551
|
BUSINESS = "BUSINESS",
|
|
552
552
|
CUSTOMER = "CUSTOMER"
|
|
553
553
|
}
|
|
554
554
|
/** @enumType */
|
|
555
|
-
|
|
556
|
-
|
|
555
|
+
type ActorWithLiterals = Actor | 'UNDEFINED_ACTOR' | 'BUSINESS' | 'CUSTOMER';
|
|
556
|
+
interface ParticipantNotification {
|
|
557
557
|
/**
|
|
558
558
|
* Whether to send the message about the changes to the customer.
|
|
559
559
|
*
|
|
@@ -563,7 +563,7 @@ export interface ParticipantNotification {
|
|
|
563
563
|
/** Custom message to send to the participants about the changes to the booking. */
|
|
564
564
|
message?: string | null;
|
|
565
565
|
}
|
|
566
|
-
|
|
566
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
567
567
|
/**
|
|
568
568
|
* ID of a site visitor that has not logged in to the site.
|
|
569
569
|
* @format GUID
|
|
@@ -591,7 +591,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
591
591
|
contactId?: string | null;
|
|
592
592
|
}
|
|
593
593
|
/** @oneof */
|
|
594
|
-
|
|
594
|
+
interface CommonIdentificationDataIdOneOf {
|
|
595
595
|
/**
|
|
596
596
|
* ID of a site visitor that has not logged in to the site.
|
|
597
597
|
* @format GUID
|
|
@@ -613,16 +613,14 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
613
613
|
*/
|
|
614
614
|
appId?: string;
|
|
615
615
|
}
|
|
616
|
-
|
|
616
|
+
declare enum IdentificationDataIdentityType {
|
|
617
617
|
UNKNOWN = "UNKNOWN",
|
|
618
618
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
619
619
|
MEMBER = "MEMBER",
|
|
620
620
|
WIX_USER = "WIX_USER",
|
|
621
621
|
APP = "APP"
|
|
622
622
|
}
|
|
623
|
-
|
|
624
|
-
export type IdentificationDataIdentityTypeWithLiterals = IdentificationDataIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
625
|
-
export interface FlowControlSettings {
|
|
623
|
+
interface FlowControlSettings {
|
|
626
624
|
/** Whether availability is checked when creating or confirming the booking. */
|
|
627
625
|
skipAvailabilityValidation?: boolean;
|
|
628
626
|
/**
|
|
@@ -644,7 +642,7 @@ export interface FlowControlSettings {
|
|
|
644
642
|
*/
|
|
645
643
|
withRefund?: boolean | null;
|
|
646
644
|
}
|
|
647
|
-
|
|
645
|
+
interface ExtendedFields {
|
|
648
646
|
/**
|
|
649
647
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
650
648
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -655,7 +653,7 @@ export interface ExtendedFields {
|
|
|
655
653
|
*/
|
|
656
654
|
namespaces?: Record<string, Record<string, any>>;
|
|
657
655
|
}
|
|
658
|
-
|
|
656
|
+
interface ParticipantChoices {
|
|
659
657
|
/**
|
|
660
658
|
* Information about the booked service choices. Includes the number of participants.
|
|
661
659
|
* @minSize 1
|
|
@@ -663,7 +661,7 @@ export interface ParticipantChoices {
|
|
|
663
661
|
*/
|
|
664
662
|
serviceChoices?: ServiceChoices[];
|
|
665
663
|
}
|
|
666
|
-
|
|
664
|
+
interface ServiceChoices {
|
|
667
665
|
/**
|
|
668
666
|
* Number of participants for this _variant_
|
|
669
667
|
* ([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)).
|
|
@@ -676,7 +674,7 @@ export interface ServiceChoices {
|
|
|
676
674
|
*/
|
|
677
675
|
choices?: ServiceChoice[];
|
|
678
676
|
}
|
|
679
|
-
|
|
677
|
+
interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
680
678
|
/**
|
|
681
679
|
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
682
680
|
* Choices are specific values for an option the customer can choose to book. For example,
|
|
@@ -694,7 +692,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
694
692
|
optionId?: string;
|
|
695
693
|
}
|
|
696
694
|
/** @oneof */
|
|
697
|
-
|
|
695
|
+
interface ServiceChoiceChoiceOneOf {
|
|
698
696
|
/**
|
|
699
697
|
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
700
698
|
* Choices are specific values for an option the customer can choose to book. For example,
|
|
@@ -704,7 +702,7 @@ export interface ServiceChoiceChoiceOneOf {
|
|
|
704
702
|
custom?: string;
|
|
705
703
|
duration?: Duration;
|
|
706
704
|
}
|
|
707
|
-
|
|
705
|
+
interface Duration {
|
|
708
706
|
/**
|
|
709
707
|
* Duration of the service in minutes.
|
|
710
708
|
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
@@ -719,22 +717,22 @@ export interface Duration {
|
|
|
719
717
|
*/
|
|
720
718
|
name?: string | null;
|
|
721
719
|
}
|
|
722
|
-
|
|
720
|
+
interface MultiServiceBookingInfo {
|
|
723
721
|
/**
|
|
724
722
|
* Multi-service booking ID.
|
|
725
723
|
* @format GUID
|
|
726
724
|
* @readonly
|
|
727
725
|
*/
|
|
728
|
-
|
|
726
|
+
_id?: string | null;
|
|
729
727
|
/** Type of the multi-service booking. */
|
|
730
728
|
type?: MultiServiceBookingTypeWithLiterals;
|
|
731
729
|
}
|
|
732
|
-
|
|
730
|
+
interface BookedAddOn {
|
|
733
731
|
/**
|
|
734
732
|
* The ID of the Add-On.
|
|
735
733
|
* @format GUID
|
|
736
734
|
*/
|
|
737
|
-
|
|
735
|
+
_id?: string;
|
|
738
736
|
/**
|
|
739
737
|
* The ID of the Add-Ons group.
|
|
740
738
|
* @format GUID
|
|
@@ -766,7 +764,7 @@ export interface BookedAddOn {
|
|
|
766
764
|
*/
|
|
767
765
|
nameTranslated?: string | null;
|
|
768
766
|
}
|
|
769
|
-
|
|
767
|
+
interface BookingFormFilled {
|
|
770
768
|
/** The booking object that form was filled for. */
|
|
771
769
|
booking?: Booking;
|
|
772
770
|
/**
|
|
@@ -782,7 +780,7 @@ export interface BookingFormFilled {
|
|
|
782
780
|
*/
|
|
783
781
|
formId?: string | null;
|
|
784
782
|
}
|
|
785
|
-
|
|
783
|
+
interface SetBookingFormAndSubmissionIdRequest extends SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
786
784
|
/**
|
|
787
785
|
* The visitor who created the booking.
|
|
788
786
|
* @format GUID
|
|
@@ -825,7 +823,7 @@ export interface SetBookingFormAndSubmissionIdRequest extends SetBookingFormAndS
|
|
|
825
823
|
instanceId?: string | null;
|
|
826
824
|
}
|
|
827
825
|
/** @oneof */
|
|
828
|
-
|
|
826
|
+
interface SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
829
827
|
/**
|
|
830
828
|
* The visitor who created the booking.
|
|
831
829
|
* @format GUID
|
|
@@ -842,17 +840,17 @@ export interface SetBookingFormAndSubmissionIdRequestCreatedByOneOf {
|
|
|
842
840
|
*/
|
|
843
841
|
appId?: string | null;
|
|
844
842
|
}
|
|
845
|
-
|
|
843
|
+
interface SetBookingFormAndSubmissionIdResponse {
|
|
846
844
|
/** Updated booking. */
|
|
847
845
|
booking?: Booking;
|
|
848
846
|
}
|
|
849
|
-
|
|
847
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
850
848
|
createdEvent?: EntityCreatedEvent;
|
|
851
849
|
updatedEvent?: EntityUpdatedEvent;
|
|
852
850
|
deletedEvent?: EntityDeletedEvent;
|
|
853
851
|
actionEvent?: ActionEvent;
|
|
854
852
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
855
|
-
|
|
853
|
+
_id?: string;
|
|
856
854
|
/**
|
|
857
855
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
858
856
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -881,36 +879,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
881
879
|
entityEventSequence?: string | null;
|
|
882
880
|
}
|
|
883
881
|
/** @oneof */
|
|
884
|
-
|
|
882
|
+
interface DomainEventBodyOneOf {
|
|
885
883
|
createdEvent?: EntityCreatedEvent;
|
|
886
884
|
updatedEvent?: EntityUpdatedEvent;
|
|
887
885
|
deletedEvent?: EntityDeletedEvent;
|
|
888
886
|
actionEvent?: ActionEvent;
|
|
889
887
|
}
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
893
|
-
restoreInfo?: RestoreInfo;
|
|
888
|
+
interface EntityCreatedEvent {
|
|
889
|
+
entity?: string;
|
|
894
890
|
}
|
|
895
|
-
|
|
891
|
+
interface RestoreInfo {
|
|
896
892
|
deletedDate?: Date | null;
|
|
897
893
|
}
|
|
898
|
-
|
|
894
|
+
interface EntityUpdatedEvent {
|
|
899
895
|
/**
|
|
900
896
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
901
897
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
902
898
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
903
899
|
*/
|
|
904
|
-
|
|
900
|
+
currentEntity?: string;
|
|
905
901
|
}
|
|
906
|
-
|
|
902
|
+
interface EntityDeletedEvent {
|
|
907
903
|
/** Entity that was deleted. */
|
|
908
|
-
|
|
904
|
+
deletedEntity?: string | null;
|
|
909
905
|
}
|
|
910
|
-
|
|
911
|
-
|
|
906
|
+
interface ActionEvent {
|
|
907
|
+
body?: string;
|
|
912
908
|
}
|
|
913
|
-
|
|
909
|
+
interface MessageEnvelope {
|
|
914
910
|
/**
|
|
915
911
|
* App instance ID.
|
|
916
912
|
* @format GUID
|
|
@@ -926,7 +922,7 @@ export interface MessageEnvelope {
|
|
|
926
922
|
/** Stringify payload. */
|
|
927
923
|
data?: string;
|
|
928
924
|
}
|
|
929
|
-
|
|
925
|
+
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
930
926
|
/**
|
|
931
927
|
* ID of a site visitor that has not logged in to the site.
|
|
932
928
|
* @format GUID
|
|
@@ -951,7 +947,7 @@ export interface WebhooksIdentificationData extends WebhooksIdentificationDataId
|
|
|
951
947
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
952
948
|
}
|
|
953
949
|
/** @oneof */
|
|
954
|
-
|
|
950
|
+
interface WebhooksIdentificationDataIdOneOf {
|
|
955
951
|
/**
|
|
956
952
|
* ID of a site visitor that has not logged in to the site.
|
|
957
953
|
* @format GUID
|
|
@@ -973,7 +969,7 @@ export interface WebhooksIdentificationDataIdOneOf {
|
|
|
973
969
|
*/
|
|
974
970
|
appId?: string;
|
|
975
971
|
}
|
|
976
|
-
|
|
972
|
+
declare enum WebhookIdentityType {
|
|
977
973
|
UNKNOWN = "UNKNOWN",
|
|
978
974
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
979
975
|
MEMBER = "MEMBER",
|
|
@@ -981,8 +977,8 @@ export declare enum WebhookIdentityType {
|
|
|
981
977
|
APP = "APP"
|
|
982
978
|
}
|
|
983
979
|
/** @enumType */
|
|
984
|
-
|
|
985
|
-
|
|
980
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
981
|
+
interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {
|
|
986
982
|
/**
|
|
987
983
|
* Information about the slot to create a booking for.
|
|
988
984
|
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
@@ -1078,7 +1074,7 @@ export interface V2CreateBookingRequest extends V2CreateBookingRequestBookableIt
|
|
|
1078
1074
|
flowControlSettings?: CreateBookingRequestFlowControlSettings;
|
|
1079
1075
|
}
|
|
1080
1076
|
/** @oneof */
|
|
1081
|
-
|
|
1077
|
+
interface V2CreateBookingRequestBookableItemOneOf {
|
|
1082
1078
|
/**
|
|
1083
1079
|
* Information about the slot to create a booking for.
|
|
1084
1080
|
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
@@ -1090,9 +1086,9 @@ export interface V2CreateBookingRequestBookableItemOneOf {
|
|
|
1090
1086
|
schedule?: BookedSchedule;
|
|
1091
1087
|
}
|
|
1092
1088
|
/** @oneof */
|
|
1093
|
-
|
|
1089
|
+
interface V2CreateBookingRequestParticipantsInfoOneOf {
|
|
1094
1090
|
}
|
|
1095
|
-
|
|
1091
|
+
interface Slot {
|
|
1096
1092
|
/**
|
|
1097
1093
|
* ID for the slot's corresponding session, when the session is either a single session
|
|
1098
1094
|
* or a specific session generated from a recurring session.
|
|
@@ -1150,20 +1146,20 @@ export interface Slot {
|
|
|
1150
1146
|
*/
|
|
1151
1147
|
eventId?: string | null;
|
|
1152
1148
|
}
|
|
1153
|
-
|
|
1149
|
+
interface SlotResource {
|
|
1154
1150
|
/**
|
|
1155
1151
|
* Resource ID.
|
|
1156
1152
|
* @format GUID
|
|
1157
1153
|
* @readonly
|
|
1158
1154
|
*/
|
|
1159
|
-
|
|
1155
|
+
_id?: string | null;
|
|
1160
1156
|
/**
|
|
1161
1157
|
* Resource name. Read only.
|
|
1162
1158
|
* @maxLength 1200
|
|
1163
1159
|
*/
|
|
1164
1160
|
name?: string | null;
|
|
1165
1161
|
}
|
|
1166
|
-
|
|
1162
|
+
interface CreateBookingRequestFlowControlSettings {
|
|
1167
1163
|
/**
|
|
1168
1164
|
* Whether the availability is checked before creating the booking. When
|
|
1169
1165
|
* passing `false` a booking is only created when the slot or schedule is
|
|
@@ -1192,11 +1188,11 @@ export interface CreateBookingRequestFlowControlSettings {
|
|
|
1192
1188
|
*/
|
|
1193
1189
|
skipSelectedPaymentOptionValidation?: boolean;
|
|
1194
1190
|
}
|
|
1195
|
-
|
|
1191
|
+
interface V2CreateBookingResponse {
|
|
1196
1192
|
/** Created booking. */
|
|
1197
1193
|
booking?: Booking;
|
|
1198
1194
|
}
|
|
1199
|
-
|
|
1195
|
+
interface V2CancelBookingRequest {
|
|
1200
1196
|
/**
|
|
1201
1197
|
* ID of the booking to cancel.
|
|
1202
1198
|
* @format GUID
|
|
@@ -1214,7 +1210,7 @@ export interface V2CancelBookingRequest {
|
|
|
1214
1210
|
*/
|
|
1215
1211
|
revision?: string | null;
|
|
1216
1212
|
}
|
|
1217
|
-
|
|
1213
|
+
interface CancelBookingRequestFlowControlSettings {
|
|
1218
1214
|
/**
|
|
1219
1215
|
* Whether the cancellation policy applies when canceling the booking. When
|
|
1220
1216
|
* passing `false` you can only cancel a booking if the cancellation policy
|
|
@@ -1236,11 +1232,11 @@ export interface CancelBookingRequestFlowControlSettings {
|
|
|
1236
1232
|
*/
|
|
1237
1233
|
withRefund?: boolean | null;
|
|
1238
1234
|
}
|
|
1239
|
-
|
|
1235
|
+
interface V2CancelBookingResponse {
|
|
1240
1236
|
/** Canceled booking. */
|
|
1241
1237
|
booking?: Booking;
|
|
1242
1238
|
}
|
|
1243
|
-
|
|
1239
|
+
interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1244
1240
|
/**
|
|
1245
1241
|
* Id of the booking to reschedule.
|
|
1246
1242
|
* @format GUID
|
|
@@ -1261,9 +1257,9 @@ export interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestPa
|
|
|
1261
1257
|
participantNotification?: ParticipantNotification;
|
|
1262
1258
|
}
|
|
1263
1259
|
/** @oneof */
|
|
1264
|
-
|
|
1260
|
+
interface V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1265
1261
|
}
|
|
1266
|
-
|
|
1262
|
+
interface RescheduleBookingRequestFlowControlSettings {
|
|
1267
1263
|
/**
|
|
1268
1264
|
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
1269
1265
|
* When passing `false` you can only cancel a booking if the rescheduling
|
|
@@ -1292,11 +1288,11 @@ export interface RescheduleBookingRequestFlowControlSettings {
|
|
|
1292
1288
|
*/
|
|
1293
1289
|
skipBusinessConfirmation?: boolean;
|
|
1294
1290
|
}
|
|
1295
|
-
|
|
1291
|
+
interface V2RescheduleBookingResponse {
|
|
1296
1292
|
/** Rescheduled booking. */
|
|
1297
1293
|
booking?: Booking;
|
|
1298
1294
|
}
|
|
1299
|
-
|
|
1295
|
+
interface V2ConfirmBookingRequest {
|
|
1300
1296
|
/**
|
|
1301
1297
|
* ID of the booking to confirm.
|
|
1302
1298
|
* @format GUID
|
|
@@ -1314,10 +1310,10 @@ export interface V2ConfirmBookingRequest {
|
|
|
1314
1310
|
*/
|
|
1315
1311
|
participantNotification?: ParticipantNotification;
|
|
1316
1312
|
}
|
|
1317
|
-
|
|
1313
|
+
interface V2ConfirmBookingResponse {
|
|
1318
1314
|
booking?: Booking;
|
|
1319
1315
|
}
|
|
1320
|
-
|
|
1316
|
+
interface V2DeclineBookingRequest {
|
|
1321
1317
|
/**
|
|
1322
1318
|
* ID of the booking to decline.
|
|
1323
1319
|
* @format GUID
|
|
@@ -1335,11 +1331,11 @@ export interface V2DeclineBookingRequest {
|
|
|
1335
1331
|
*/
|
|
1336
1332
|
participantNotification?: ParticipantNotification;
|
|
1337
1333
|
}
|
|
1338
|
-
|
|
1334
|
+
interface V2DeclineBookingResponse {
|
|
1339
1335
|
/** Declined booking. */
|
|
1340
1336
|
booking?: Booking;
|
|
1341
1337
|
}
|
|
1342
|
-
|
|
1338
|
+
interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1343
1339
|
/**
|
|
1344
1340
|
* ID of the booking to update the number of participants for.
|
|
1345
1341
|
* @format GUID
|
|
@@ -1355,13 +1351,13 @@ export interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfPar
|
|
|
1355
1351
|
revision?: string | null;
|
|
1356
1352
|
}
|
|
1357
1353
|
/** @oneof */
|
|
1358
|
-
|
|
1354
|
+
interface V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1359
1355
|
}
|
|
1360
|
-
|
|
1356
|
+
interface V2UpdateNumberOfParticipantsResponse {
|
|
1361
1357
|
/** Booking with updated number of participants. */
|
|
1362
1358
|
booking?: Booking;
|
|
1363
1359
|
}
|
|
1364
|
-
|
|
1360
|
+
interface ConfirmOrDeclineBookingRequest {
|
|
1365
1361
|
/**
|
|
1366
1362
|
* ID of the booking to confirm or decline.
|
|
1367
1363
|
* @format GUID
|
|
@@ -1377,11 +1373,11 @@ export interface ConfirmOrDeclineBookingRequest {
|
|
|
1377
1373
|
*/
|
|
1378
1374
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
1379
1375
|
}
|
|
1380
|
-
|
|
1376
|
+
interface ConfirmOrDeclineBookingResponse {
|
|
1381
1377
|
/** Updated booking. */
|
|
1382
1378
|
booking?: Booking;
|
|
1383
1379
|
}
|
|
1384
|
-
|
|
1380
|
+
interface BulkConfirmOrDeclineBookingRequest {
|
|
1385
1381
|
/**
|
|
1386
1382
|
* Bookings to confirm or decline.
|
|
1387
1383
|
* @minSize 1
|
|
@@ -1391,7 +1387,7 @@ export interface BulkConfirmOrDeclineBookingRequest {
|
|
|
1391
1387
|
/** Whether to return the confirmed or declined booking objects. */
|
|
1392
1388
|
returnEntity?: boolean;
|
|
1393
1389
|
}
|
|
1394
|
-
|
|
1390
|
+
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
1395
1391
|
/**
|
|
1396
1392
|
* ID of the booking to confirm or decline.
|
|
1397
1393
|
* @format GUID
|
|
@@ -1407,13 +1403,13 @@ export interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
|
1407
1403
|
*/
|
|
1408
1404
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
1409
1405
|
}
|
|
1410
|
-
|
|
1406
|
+
interface BulkConfirmOrDeclineBookingResponse {
|
|
1411
1407
|
/** List of confirmed or declined bookings, including metadata. */
|
|
1412
1408
|
results?: BulkBookingResult[];
|
|
1413
1409
|
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
1414
1410
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1415
1411
|
}
|
|
1416
|
-
|
|
1412
|
+
interface BulkBookingResult {
|
|
1417
1413
|
/**
|
|
1418
1414
|
* Information about the booking that was created or updated.
|
|
1419
1415
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1426,9 +1422,9 @@ export interface BulkBookingResult {
|
|
|
1426
1422
|
*/
|
|
1427
1423
|
item?: Booking;
|
|
1428
1424
|
}
|
|
1429
|
-
|
|
1425
|
+
interface ItemMetadata {
|
|
1430
1426
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1431
|
-
|
|
1427
|
+
_id?: string | null;
|
|
1432
1428
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1433
1429
|
originalIndex?: number;
|
|
1434
1430
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -1436,7 +1432,7 @@ export interface ItemMetadata {
|
|
|
1436
1432
|
/** Details about the error in case of failure. */
|
|
1437
1433
|
error?: ApplicationError;
|
|
1438
1434
|
}
|
|
1439
|
-
|
|
1435
|
+
interface ApplicationError {
|
|
1440
1436
|
/** Error code. */
|
|
1441
1437
|
code?: string;
|
|
1442
1438
|
/** Description of the error. */
|
|
@@ -1444,7 +1440,7 @@ export interface ApplicationError {
|
|
|
1444
1440
|
/** Data related to the error. */
|
|
1445
1441
|
data?: Record<string, any> | null;
|
|
1446
1442
|
}
|
|
1447
|
-
|
|
1443
|
+
interface BulkActionMetadata {
|
|
1448
1444
|
/** Number of items that were successfully processed. */
|
|
1449
1445
|
totalSuccesses?: number;
|
|
1450
1446
|
/** Number of items that couldn't be processed. */
|
|
@@ -1452,13 +1448,13 @@ export interface BulkActionMetadata {
|
|
|
1452
1448
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1453
1449
|
undetailedFailures?: number;
|
|
1454
1450
|
}
|
|
1455
|
-
|
|
1451
|
+
interface BookingChanged {
|
|
1456
1452
|
/** The booking before the changes. */
|
|
1457
1453
|
previousBooking?: Booking;
|
|
1458
1454
|
/** The booking after the changes. */
|
|
1459
1455
|
currentBooking?: Booking;
|
|
1460
1456
|
}
|
|
1461
|
-
|
|
1457
|
+
interface CreateBookingRequest {
|
|
1462
1458
|
/** The booking to create. */
|
|
1463
1459
|
booking: Booking;
|
|
1464
1460
|
/**
|
|
@@ -1478,7 +1474,7 @@ export interface CreateBookingRequest {
|
|
|
1478
1474
|
*/
|
|
1479
1475
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1480
1476
|
}
|
|
1481
|
-
|
|
1477
|
+
interface CreateBookingFlowControlSettings {
|
|
1482
1478
|
/**
|
|
1483
1479
|
* Whether the availability is checked before creating the booking.
|
|
1484
1480
|
*
|
|
@@ -1505,7 +1501,7 @@ export interface CreateBookingFlowControlSettings {
|
|
|
1505
1501
|
*/
|
|
1506
1502
|
skipSelectedPaymentOptionValidation?: boolean;
|
|
1507
1503
|
}
|
|
1508
|
-
|
|
1504
|
+
interface CreateBookingResponse {
|
|
1509
1505
|
/** Created booking. */
|
|
1510
1506
|
booking?: Booking;
|
|
1511
1507
|
}
|
|
@@ -1513,30 +1509,30 @@ export interface CreateBookingResponse {
|
|
|
1513
1509
|
* The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1514
1510
|
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1515
1511
|
*/
|
|
1516
|
-
|
|
1512
|
+
interface UpdateBookingRequest {
|
|
1517
1513
|
booking?: Booking;
|
|
1518
1514
|
}
|
|
1519
|
-
|
|
1515
|
+
interface UpdateBookingResponse {
|
|
1520
1516
|
booking?: Booking;
|
|
1521
1517
|
}
|
|
1522
|
-
|
|
1518
|
+
interface LegacyCreateBookingRequest {
|
|
1523
1519
|
booking?: Booking;
|
|
1524
1520
|
}
|
|
1525
|
-
|
|
1521
|
+
interface LegacyCreateBookingResponse {
|
|
1526
1522
|
booking?: Booking;
|
|
1527
1523
|
}
|
|
1528
1524
|
/**
|
|
1529
1525
|
* The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1530
1526
|
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1531
1527
|
*/
|
|
1532
|
-
|
|
1528
|
+
interface BulkUpdateBookingRequest {
|
|
1533
1529
|
bookings?: MaskedBooking[];
|
|
1534
1530
|
}
|
|
1535
|
-
|
|
1531
|
+
interface MaskedBooking {
|
|
1536
1532
|
booking?: Booking;
|
|
1537
1533
|
mask?: string[];
|
|
1538
1534
|
}
|
|
1539
|
-
|
|
1535
|
+
interface BulkUpdateBookingResponse {
|
|
1540
1536
|
/**
|
|
1541
1537
|
* Information about the booking that was updated.
|
|
1542
1538
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1546,7 +1542,7 @@ export interface BulkUpdateBookingResponse {
|
|
|
1546
1542
|
/** Total number of successes and failures for Bulk Update Bookings. */
|
|
1547
1543
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1548
1544
|
}
|
|
1549
|
-
|
|
1545
|
+
interface BulkCreateBookingRequest {
|
|
1550
1546
|
/**
|
|
1551
1547
|
* Bookings to create.
|
|
1552
1548
|
*
|
|
@@ -1558,7 +1554,7 @@ export interface BulkCreateBookingRequest {
|
|
|
1558
1554
|
/** Whether to return the created bookings. */
|
|
1559
1555
|
returnFullEntity?: boolean;
|
|
1560
1556
|
}
|
|
1561
|
-
|
|
1557
|
+
interface CreateBookingInfo {
|
|
1562
1558
|
/** Booking to create. */
|
|
1563
1559
|
booking?: Booking;
|
|
1564
1560
|
/**
|
|
@@ -1578,13 +1574,13 @@ export interface CreateBookingInfo {
|
|
|
1578
1574
|
*/
|
|
1579
1575
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1580
1576
|
}
|
|
1581
|
-
|
|
1577
|
+
interface BulkCreateBookingResponse {
|
|
1582
1578
|
/** List of individual Bulk Create Bookings results. */
|
|
1583
1579
|
results?: BulkBookingResult[];
|
|
1584
1580
|
/** Total number of successes and failures for Bulk Create Bookings. */
|
|
1585
1581
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1586
1582
|
}
|
|
1587
|
-
|
|
1583
|
+
interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1588
1584
|
/**
|
|
1589
1585
|
* Total number of participants. Specify when all participants have booked the
|
|
1590
1586
|
* same service variant.
|
|
@@ -1620,7 +1616,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
|
|
|
1620
1616
|
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
1621
1617
|
}
|
|
1622
1618
|
/** @oneof */
|
|
1623
|
-
|
|
1619
|
+
interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1624
1620
|
/**
|
|
1625
1621
|
* Total number of participants. Specify when all participants have booked the
|
|
1626
1622
|
* same service variant.
|
|
@@ -1632,7 +1628,7 @@ export interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
|
1632
1628
|
*/
|
|
1633
1629
|
participantsChoices?: ParticipantChoices;
|
|
1634
1630
|
}
|
|
1635
|
-
|
|
1631
|
+
interface V2Slot {
|
|
1636
1632
|
/** Identifier for the underlying session when the session is a single session or generated from a recurring session. */
|
|
1637
1633
|
sessionId?: string | null;
|
|
1638
1634
|
/** Service identifier. Required. */
|
|
@@ -1664,7 +1660,7 @@ export interface V2Slot {
|
|
|
1664
1660
|
*/
|
|
1665
1661
|
eventId?: string | null;
|
|
1666
1662
|
}
|
|
1667
|
-
|
|
1663
|
+
declare enum LocationLocationType {
|
|
1668
1664
|
/** Undefined location type. */
|
|
1669
1665
|
UNDEFINED = "UNDEFINED",
|
|
1670
1666
|
/** The business address as set in the site’s general settings. */
|
|
@@ -1675,26 +1671,26 @@ export declare enum LocationLocationType {
|
|
|
1675
1671
|
CUSTOM = "CUSTOM"
|
|
1676
1672
|
}
|
|
1677
1673
|
/** @enumType */
|
|
1678
|
-
|
|
1679
|
-
|
|
1674
|
+
type LocationLocationTypeWithLiterals = LocationLocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
|
|
1675
|
+
interface SlotSlotResource {
|
|
1680
1676
|
/**
|
|
1681
1677
|
* Resource ID.
|
|
1682
1678
|
* @format GUID
|
|
1683
1679
|
* @readonly
|
|
1684
1680
|
*/
|
|
1685
|
-
|
|
1681
|
+
_id?: string | null;
|
|
1686
1682
|
/**
|
|
1687
1683
|
* Resource name.
|
|
1688
1684
|
* @maxLength 1200
|
|
1689
1685
|
*/
|
|
1690
1686
|
name?: string | null;
|
|
1691
1687
|
}
|
|
1692
|
-
|
|
1688
|
+
interface SlotLocation {
|
|
1693
1689
|
/**
|
|
1694
1690
|
* Business Location ID. Present if the location is a business location.
|
|
1695
1691
|
* @format GUID
|
|
1696
1692
|
*/
|
|
1697
|
-
|
|
1693
|
+
_id?: string | null;
|
|
1698
1694
|
/** Location name. */
|
|
1699
1695
|
name?: string | null;
|
|
1700
1696
|
/** A string containing the full address of this location. */
|
|
@@ -1702,7 +1698,7 @@ export interface SlotLocation {
|
|
|
1702
1698
|
/** Location type. */
|
|
1703
1699
|
locationType?: LocationLocationTypeWithLiterals;
|
|
1704
1700
|
}
|
|
1705
|
-
|
|
1701
|
+
interface RescheduleBookingFlowControlSettings {
|
|
1706
1702
|
/**
|
|
1707
1703
|
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
1708
1704
|
*
|
|
@@ -1727,11 +1723,11 @@ export interface RescheduleBookingFlowControlSettings {
|
|
|
1727
1723
|
*/
|
|
1728
1724
|
skipBusinessConfirmation?: boolean;
|
|
1729
1725
|
}
|
|
1730
|
-
|
|
1726
|
+
interface RescheduleBookingResponse {
|
|
1731
1727
|
/** Rescheduled booking. */
|
|
1732
1728
|
booking?: Booking;
|
|
1733
1729
|
}
|
|
1734
|
-
|
|
1730
|
+
interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
1735
1731
|
/**
|
|
1736
1732
|
* The previous total number of participants. Available only when the booking includes
|
|
1737
1733
|
* a single service variant.
|
|
@@ -1773,7 +1769,7 @@ export interface BookingRescheduled extends BookingRescheduledPreviousParticipan
|
|
|
1773
1769
|
previousEndDate?: Date | null;
|
|
1774
1770
|
}
|
|
1775
1771
|
/** @oneof */
|
|
1776
|
-
|
|
1772
|
+
interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
1777
1773
|
/**
|
|
1778
1774
|
* The previous total number of participants. Available only when the booking includes
|
|
1779
1775
|
* a single service variant.
|
|
@@ -1785,7 +1781,7 @@ export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
|
1785
1781
|
*/
|
|
1786
1782
|
previousParticipantsChoices?: ParticipantChoices;
|
|
1787
1783
|
}
|
|
1788
|
-
|
|
1784
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1789
1785
|
/**
|
|
1790
1786
|
* ID of a site visitor that has not logged in to the site.
|
|
1791
1787
|
* @format GUID
|
|
@@ -1814,7 +1810,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1814
1810
|
contactId?: string | null;
|
|
1815
1811
|
}
|
|
1816
1812
|
/** @oneof */
|
|
1817
|
-
|
|
1813
|
+
interface IdentificationDataIdOneOf {
|
|
1818
1814
|
/**
|
|
1819
1815
|
* ID of a site visitor that has not logged in to the site.
|
|
1820
1816
|
* @format GUID
|
|
@@ -1836,16 +1832,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
1836
1832
|
*/
|
|
1837
1833
|
appId?: string;
|
|
1838
1834
|
}
|
|
1839
|
-
|
|
1835
|
+
declare enum IdentityType {
|
|
1840
1836
|
UNKNOWN = "UNKNOWN",
|
|
1841
1837
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1842
1838
|
MEMBER = "MEMBER",
|
|
1843
1839
|
WIX_USER = "WIX_USER",
|
|
1844
1840
|
APP = "APP"
|
|
1845
1841
|
}
|
|
1846
|
-
|
|
1847
|
-
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1848
|
-
export interface BulkRescheduleBookingRequest {
|
|
1842
|
+
interface BulkRescheduleBookingRequest {
|
|
1849
1843
|
/**
|
|
1850
1844
|
* Reschedule multiple bookings to multiple slots.
|
|
1851
1845
|
* @minSize 1
|
|
@@ -1857,12 +1851,12 @@ export interface BulkRescheduleBookingRequest {
|
|
|
1857
1851
|
*/
|
|
1858
1852
|
participantNotification?: ParticipantNotification;
|
|
1859
1853
|
}
|
|
1860
|
-
|
|
1854
|
+
interface BulkRescheduleBookingRequestBooking {
|
|
1861
1855
|
/**
|
|
1862
1856
|
* ID of the booking to reschedule.
|
|
1863
1857
|
* @format GUID
|
|
1864
1858
|
*/
|
|
1865
|
-
|
|
1859
|
+
_id?: string;
|
|
1866
1860
|
/**
|
|
1867
1861
|
* Revision number, which increments by 1 each time the booking is rescheduled.
|
|
1868
1862
|
* To prevent conflicting changes,
|
|
@@ -1871,7 +1865,7 @@ export interface BulkRescheduleBookingRequestBooking {
|
|
|
1871
1865
|
revision?: string | null;
|
|
1872
1866
|
}
|
|
1873
1867
|
/** Bookings to be rescheduled to the given slot. */
|
|
1874
|
-
|
|
1868
|
+
interface SlotBookings {
|
|
1875
1869
|
/**
|
|
1876
1870
|
* The bookings details.
|
|
1877
1871
|
* @minSize 1
|
|
@@ -1883,7 +1877,7 @@ export interface SlotBookings {
|
|
|
1883
1877
|
*/
|
|
1884
1878
|
slot?: BookedSlot;
|
|
1885
1879
|
}
|
|
1886
|
-
|
|
1880
|
+
interface BulkRescheduleBookingResponse {
|
|
1887
1881
|
/**
|
|
1888
1882
|
* Information about the booking that was rescheduled.
|
|
1889
1883
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1894,7 +1888,7 @@ export interface BulkRescheduleBookingResponse {
|
|
|
1894
1888
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1895
1889
|
}
|
|
1896
1890
|
/** Update the booked schedule of multiple bookings to the given schedule. */
|
|
1897
|
-
|
|
1891
|
+
interface BulkUpdateBookedScheduleRequest {
|
|
1898
1892
|
/**
|
|
1899
1893
|
* The bookings whose booked schedule is to be updated to the given schedule.
|
|
1900
1894
|
* @minSize 1
|
|
@@ -1908,15 +1902,15 @@ export interface BulkUpdateBookedScheduleRequest {
|
|
|
1908
1902
|
*/
|
|
1909
1903
|
participantNotification?: ParticipantNotification;
|
|
1910
1904
|
}
|
|
1911
|
-
|
|
1905
|
+
interface BookingDetails {
|
|
1912
1906
|
/**
|
|
1913
1907
|
* ID of the bookings to be updated.
|
|
1914
1908
|
* @format GUID
|
|
1915
1909
|
*/
|
|
1916
|
-
|
|
1910
|
+
_id?: string;
|
|
1917
1911
|
revision?: string | null;
|
|
1918
1912
|
}
|
|
1919
|
-
|
|
1913
|
+
interface BulkUpdateBookedScheduleResponse {
|
|
1920
1914
|
/**
|
|
1921
1915
|
* Information about the schedule that was updated.
|
|
1922
1916
|
* Including its ID, index in the bulk request and whether it was
|
|
@@ -1926,11 +1920,11 @@ export interface BulkUpdateBookedScheduleResponse {
|
|
|
1926
1920
|
/** Total number of successes and failures for Bulk Updated Booked Schedules. */
|
|
1927
1921
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1928
1922
|
}
|
|
1929
|
-
|
|
1923
|
+
interface QueryBookingsRequest {
|
|
1930
1924
|
/** Information about filters, paging, and sorting. */
|
|
1931
1925
|
query?: QueryV2;
|
|
1932
1926
|
}
|
|
1933
|
-
|
|
1927
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1934
1928
|
/** Paging options to limit and skip the number of items. */
|
|
1935
1929
|
paging?: Paging;
|
|
1936
1930
|
/**
|
|
@@ -1960,7 +1954,7 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
1960
1954
|
fieldsets?: string[];
|
|
1961
1955
|
}
|
|
1962
1956
|
/** @oneof */
|
|
1963
|
-
|
|
1957
|
+
interface QueryV2PagingMethodOneOf {
|
|
1964
1958
|
/** Paging options to limit and skip the number of items. */
|
|
1965
1959
|
paging?: Paging;
|
|
1966
1960
|
/**
|
|
@@ -1971,7 +1965,7 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
1971
1965
|
*/
|
|
1972
1966
|
cursorPaging?: CursorPaging;
|
|
1973
1967
|
}
|
|
1974
|
-
|
|
1968
|
+
interface Sorting {
|
|
1975
1969
|
/**
|
|
1976
1970
|
* Name of the field to sort by.
|
|
1977
1971
|
* @maxLength 512
|
|
@@ -1980,19 +1974,19 @@ export interface Sorting {
|
|
|
1980
1974
|
/** Sort order. */
|
|
1981
1975
|
order?: SortOrderWithLiterals;
|
|
1982
1976
|
}
|
|
1983
|
-
|
|
1977
|
+
declare enum SortOrder {
|
|
1984
1978
|
ASC = "ASC",
|
|
1985
1979
|
DESC = "DESC"
|
|
1986
1980
|
}
|
|
1987
1981
|
/** @enumType */
|
|
1988
|
-
|
|
1989
|
-
|
|
1982
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1983
|
+
interface Paging {
|
|
1990
1984
|
/** Number of items to load. */
|
|
1991
1985
|
limit?: number | null;
|
|
1992
1986
|
/** Number of items to skip in the current sort order. */
|
|
1993
1987
|
offset?: number | null;
|
|
1994
1988
|
}
|
|
1995
|
-
|
|
1989
|
+
interface CursorPaging {
|
|
1996
1990
|
/**
|
|
1997
1991
|
* Maximum number of items to return in the results.
|
|
1998
1992
|
* @max 100
|
|
@@ -2007,13 +2001,13 @@ export interface CursorPaging {
|
|
|
2007
2001
|
*/
|
|
2008
2002
|
cursor?: string | null;
|
|
2009
2003
|
}
|
|
2010
|
-
|
|
2004
|
+
interface QueryBookingsResponse {
|
|
2011
2005
|
/** Retrieved bookings. */
|
|
2012
2006
|
bookings?: Booking[];
|
|
2013
2007
|
/** Paging metadata. */
|
|
2014
2008
|
pagingMetadata?: PagingMetadataV2;
|
|
2015
2009
|
}
|
|
2016
|
-
|
|
2010
|
+
interface PagingMetadataV2 {
|
|
2017
2011
|
/** Number of items returned in the response. */
|
|
2018
2012
|
count?: number | null;
|
|
2019
2013
|
/** Offset that was requested. */
|
|
@@ -2025,7 +2019,7 @@ export interface PagingMetadataV2 {
|
|
|
2025
2019
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2026
2020
|
cursors?: Cursors;
|
|
2027
2021
|
}
|
|
2028
|
-
|
|
2022
|
+
interface Cursors {
|
|
2029
2023
|
/**
|
|
2030
2024
|
* Cursor string pointing to the next page in the list of results.
|
|
2031
2025
|
* @maxLength 16000
|
|
@@ -2037,25 +2031,25 @@ export interface Cursors {
|
|
|
2037
2031
|
*/
|
|
2038
2032
|
prev?: string | null;
|
|
2039
2033
|
}
|
|
2040
|
-
|
|
2034
|
+
interface ConfirmRequest {
|
|
2041
2035
|
/**
|
|
2042
2036
|
* ID of the booking to confirm.
|
|
2043
2037
|
* @format GUID
|
|
2044
2038
|
*/
|
|
2045
|
-
|
|
2039
|
+
_id?: string;
|
|
2046
2040
|
/**
|
|
2047
2041
|
* Information about whether to notify the customer about the confirmation and
|
|
2048
2042
|
* the message to send.
|
|
2049
2043
|
*/
|
|
2050
2044
|
participantNotification?: ParticipantNotification;
|
|
2051
2045
|
}
|
|
2052
|
-
|
|
2046
|
+
interface ConfirmResponse {
|
|
2053
2047
|
/** Confirmed booking. */
|
|
2054
2048
|
booking?: Booking;
|
|
2055
2049
|
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
2056
2050
|
doubleBooked?: boolean | null;
|
|
2057
2051
|
}
|
|
2058
|
-
|
|
2052
|
+
interface ConfirmBookingRequest {
|
|
2059
2053
|
/**
|
|
2060
2054
|
* ID of the booking to confirm.
|
|
2061
2055
|
* @format GUID
|
|
@@ -2087,7 +2081,7 @@ export interface ConfirmBookingRequest {
|
|
|
2087
2081
|
*/
|
|
2088
2082
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
2089
2083
|
}
|
|
2090
|
-
|
|
2084
|
+
interface ConfirmBookingFlowControlSettings {
|
|
2091
2085
|
/**
|
|
2092
2086
|
* Whether the availability is checked before confirming the booking.
|
|
2093
2087
|
*
|
|
@@ -2096,11 +2090,11 @@ export interface ConfirmBookingFlowControlSettings {
|
|
|
2096
2090
|
*/
|
|
2097
2091
|
checkAvailabilityValidation?: boolean;
|
|
2098
2092
|
}
|
|
2099
|
-
|
|
2093
|
+
interface ConfirmBookingResponse {
|
|
2100
2094
|
/** Confirmed booking. */
|
|
2101
2095
|
booking?: Booking;
|
|
2102
2096
|
}
|
|
2103
|
-
|
|
2097
|
+
interface BookingConfirmed {
|
|
2104
2098
|
/** The confirmed booking object. */
|
|
2105
2099
|
booking?: Booking;
|
|
2106
2100
|
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
@@ -2119,30 +2113,30 @@ export interface BookingConfirmed {
|
|
|
2119
2113
|
/** The previous payment status of the booking. */
|
|
2120
2114
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
2121
2115
|
}
|
|
2122
|
-
|
|
2116
|
+
interface ConsistentQueryBookingsRequest {
|
|
2123
2117
|
/** Information about filters, paging, and sorting. */
|
|
2124
2118
|
query?: QueryV2;
|
|
2125
2119
|
}
|
|
2126
|
-
|
|
2120
|
+
interface ConsistentQueryBookingsResponse {
|
|
2127
2121
|
/** Retrieved bookings. */
|
|
2128
2122
|
bookings?: Booking[];
|
|
2129
2123
|
/** Paging metadata. */
|
|
2130
2124
|
pagingMetadata?: PagingMetadataV2;
|
|
2131
2125
|
}
|
|
2132
|
-
|
|
2126
|
+
interface SetBookingSessionIdRequest {
|
|
2133
2127
|
/**
|
|
2134
2128
|
* ID of the booking to set `sessionId` for.
|
|
2135
2129
|
* @format GUID
|
|
2136
2130
|
*/
|
|
2137
|
-
|
|
2131
|
+
_id?: string;
|
|
2138
2132
|
/** ID of the session to set on the booking. */
|
|
2139
2133
|
sessionId?: string;
|
|
2140
2134
|
}
|
|
2141
|
-
|
|
2135
|
+
interface SetBookingSessionIdResponse {
|
|
2142
2136
|
/** Updated booking. */
|
|
2143
2137
|
booking?: Booking;
|
|
2144
2138
|
}
|
|
2145
|
-
|
|
2139
|
+
interface SetBookingSubmissionIdRequest {
|
|
2146
2140
|
/**
|
|
2147
2141
|
* ID of the booking to set `submissionId` for.
|
|
2148
2142
|
* @format GUID
|
|
@@ -2154,19 +2148,19 @@ export interface SetBookingSubmissionIdRequest {
|
|
|
2154
2148
|
*/
|
|
2155
2149
|
submissionId?: string;
|
|
2156
2150
|
}
|
|
2157
|
-
|
|
2151
|
+
interface SetBookingSubmissionIdResponse {
|
|
2158
2152
|
/** Updated booking. */
|
|
2159
2153
|
booking?: Booking;
|
|
2160
2154
|
}
|
|
2161
|
-
|
|
2155
|
+
interface UpdateExtendedFieldsRequest {
|
|
2162
2156
|
/** ID of the entity to update. */
|
|
2163
|
-
|
|
2157
|
+
_id: string;
|
|
2164
2158
|
/** Identifier for the app whose extended fields are being updated. */
|
|
2165
2159
|
namespace: string;
|
|
2166
2160
|
/** 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. */
|
|
2167
2161
|
namespaceData: Record<string, any> | null;
|
|
2168
2162
|
}
|
|
2169
|
-
|
|
2163
|
+
interface UpdateExtendedFieldsResponse {
|
|
2170
2164
|
/**
|
|
2171
2165
|
* Updated namespace.
|
|
2172
2166
|
* @maxLength 164
|
|
@@ -2175,7 +2169,7 @@ export interface UpdateExtendedFieldsResponse {
|
|
|
2175
2169
|
/** Updated data. */
|
|
2176
2170
|
namespaceData?: Record<string, any> | null;
|
|
2177
2171
|
}
|
|
2178
|
-
|
|
2172
|
+
interface DeclineBookingRequest {
|
|
2179
2173
|
/**
|
|
2180
2174
|
* ID of the booking to decline.
|
|
2181
2175
|
* @format GUID
|
|
@@ -2204,7 +2198,7 @@ export interface DeclineBookingRequest {
|
|
|
2204
2198
|
*/
|
|
2205
2199
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2206
2200
|
}
|
|
2207
|
-
|
|
2201
|
+
interface DeclineBookingFlowControlSettings {
|
|
2208
2202
|
/**
|
|
2209
2203
|
* Whether to issue a refund when declining the booking.
|
|
2210
2204
|
*
|
|
@@ -2218,11 +2212,11 @@ export interface DeclineBookingFlowControlSettings {
|
|
|
2218
2212
|
*/
|
|
2219
2213
|
withRefund?: boolean | null;
|
|
2220
2214
|
}
|
|
2221
|
-
|
|
2215
|
+
interface DeclineBookingResponse {
|
|
2222
2216
|
/** Declined booking. */
|
|
2223
2217
|
booking?: Booking;
|
|
2224
2218
|
}
|
|
2225
|
-
|
|
2219
|
+
interface BookingDeclined {
|
|
2226
2220
|
/** The declined booking object. */
|
|
2227
2221
|
booking?: Booking;
|
|
2228
2222
|
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
@@ -2241,7 +2235,7 @@ export interface BookingDeclined {
|
|
|
2241
2235
|
*/
|
|
2242
2236
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2243
2237
|
}
|
|
2244
|
-
|
|
2238
|
+
interface CancelBookingRequest {
|
|
2245
2239
|
/**
|
|
2246
2240
|
* ID of the booking to cancel.
|
|
2247
2241
|
* @format GUID
|
|
@@ -2266,7 +2260,7 @@ export interface CancelBookingRequest {
|
|
|
2266
2260
|
*/
|
|
2267
2261
|
revision: string | null;
|
|
2268
2262
|
}
|
|
2269
|
-
|
|
2263
|
+
interface CancelBookingFlowControlSettings {
|
|
2270
2264
|
/**
|
|
2271
2265
|
* Whether the cancellation policy applies when canceling the booking.
|
|
2272
2266
|
*
|
|
@@ -2287,11 +2281,11 @@ export interface CancelBookingFlowControlSettings {
|
|
|
2287
2281
|
*/
|
|
2288
2282
|
withRefund?: boolean | null;
|
|
2289
2283
|
}
|
|
2290
|
-
|
|
2284
|
+
interface CancelBookingResponse {
|
|
2291
2285
|
/** Canceled booking. */
|
|
2292
2286
|
booking?: Booking;
|
|
2293
2287
|
}
|
|
2294
|
-
|
|
2288
|
+
interface BookingCanceled {
|
|
2295
2289
|
/** The canceled booking object. */
|
|
2296
2290
|
booking?: Booking;
|
|
2297
2291
|
/** Information about whether to notify the customer about the cancellation and the message to send. */
|
|
@@ -2308,7 +2302,7 @@ export interface BookingCanceled {
|
|
|
2308
2302
|
/** The previous status of the booking. */
|
|
2309
2303
|
previousStatus?: BookingStatusWithLiterals;
|
|
2310
2304
|
}
|
|
2311
|
-
|
|
2305
|
+
interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2312
2306
|
/**
|
|
2313
2307
|
* Total number of participants. Specify when all participants have booked the
|
|
2314
2308
|
* same service variant.
|
|
@@ -2333,7 +2327,7 @@ export interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfPartici
|
|
|
2333
2327
|
revision: string | null;
|
|
2334
2328
|
}
|
|
2335
2329
|
/** @oneof */
|
|
2336
|
-
|
|
2330
|
+
interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2337
2331
|
/**
|
|
2338
2332
|
* Total number of participants. Specify when all participants have booked the
|
|
2339
2333
|
* same service variant.
|
|
@@ -2345,11 +2339,11 @@ export interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
|
2345
2339
|
*/
|
|
2346
2340
|
participantsChoices?: ParticipantChoices;
|
|
2347
2341
|
}
|
|
2348
|
-
|
|
2342
|
+
interface UpdateNumberOfParticipantsResponse {
|
|
2349
2343
|
/** Updated booking. */
|
|
2350
2344
|
booking?: Booking;
|
|
2351
2345
|
}
|
|
2352
|
-
|
|
2346
|
+
interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
2353
2347
|
/**
|
|
2354
2348
|
* The previous total number of participants. Available only when the booking includes
|
|
2355
2349
|
* a single service variant.
|
|
@@ -2366,7 +2360,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
|
|
|
2366
2360
|
initiatedBy?: IdentificationData;
|
|
2367
2361
|
}
|
|
2368
2362
|
/** @oneof */
|
|
2369
|
-
|
|
2363
|
+
interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
2370
2364
|
/**
|
|
2371
2365
|
* The previous total number of participants. Available only when the booking includes
|
|
2372
2366
|
* a single service variant.
|
|
@@ -2378,42 +2372,42 @@ export interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
|
2378
2372
|
*/
|
|
2379
2373
|
previousParticipantsChoices?: ParticipantChoices;
|
|
2380
2374
|
}
|
|
2381
|
-
|
|
2375
|
+
interface BulkCalculateAllowedActionsRequest {
|
|
2382
2376
|
/**
|
|
2383
2377
|
* The booking IDs for which we want to calculate the allowed actions.
|
|
2384
2378
|
* @minSize 1
|
|
2385
2379
|
*/
|
|
2386
2380
|
bookingIds?: string[] | null;
|
|
2387
2381
|
}
|
|
2388
|
-
|
|
2382
|
+
interface BulkCalculateAllowedActionsResponse {
|
|
2389
2383
|
results?: BulkCalculateAllowedActionsResult[];
|
|
2390
2384
|
/** Total number of successes and failures for Bulk Calculate Allowed Actions. */
|
|
2391
2385
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2392
2386
|
}
|
|
2393
|
-
|
|
2387
|
+
interface BulkCalculateAllowedActionsResult {
|
|
2394
2388
|
/** Metadata for the booking. Including ID, index in the provided sequence, success status, and error. */
|
|
2395
2389
|
itemMetadata?: ItemMetadata;
|
|
2396
2390
|
/** Booking entity. */
|
|
2397
2391
|
item?: AllowedActions;
|
|
2398
2392
|
}
|
|
2399
2393
|
/** Possible actions allowed for the booking. */
|
|
2400
|
-
|
|
2394
|
+
interface AllowedActions {
|
|
2401
2395
|
/** Whether canceling the booking is allowed. */
|
|
2402
2396
|
cancel?: boolean;
|
|
2403
2397
|
/** Whether rescheduling the booking is allowed. */
|
|
2404
2398
|
reschedule?: boolean;
|
|
2405
2399
|
}
|
|
2406
|
-
|
|
2400
|
+
interface GetSlotAvailabilityRequest {
|
|
2407
2401
|
/** The slot for which the availability is checked. */
|
|
2408
2402
|
slot?: V2Slot;
|
|
2409
2403
|
/** The timezone for which availability is to be calculated. */
|
|
2410
2404
|
timezone?: string | null;
|
|
2411
2405
|
}
|
|
2412
|
-
|
|
2406
|
+
interface GetSlotAvailabilityResponse {
|
|
2413
2407
|
availability?: SlotAvailability;
|
|
2414
2408
|
bookingPolicySettings?: BookingPolicySettings;
|
|
2415
2409
|
}
|
|
2416
|
-
|
|
2410
|
+
interface SlotAvailability {
|
|
2417
2411
|
/** Identifier for the underlying session when the session is a single session or generated from a recurring session. Required. */
|
|
2418
2412
|
slot?: V2Slot;
|
|
2419
2413
|
/** Whether this available slot is bookable. */
|
|
@@ -2435,7 +2429,7 @@ export interface SlotAvailability {
|
|
|
2435
2429
|
/** Indicates whether this slot is locked. */
|
|
2436
2430
|
locked?: boolean | null;
|
|
2437
2431
|
}
|
|
2438
|
-
|
|
2432
|
+
interface WaitingList {
|
|
2439
2433
|
/**
|
|
2440
2434
|
* Total number of spots and open spots for this waiting list.
|
|
2441
2435
|
* 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.
|
|
@@ -2443,7 +2437,7 @@ export interface WaitingList {
|
|
|
2443
2437
|
totalSpots?: number | null;
|
|
2444
2438
|
openSpots?: number | null;
|
|
2445
2439
|
}
|
|
2446
|
-
|
|
2440
|
+
interface BookingPolicyViolations {
|
|
2447
2441
|
/** Booking policy violation: Too early to book this slot. */
|
|
2448
2442
|
tooEarlyToBook?: boolean | null;
|
|
2449
2443
|
/** Booking policy violation: Too late to book this slot. */
|
|
@@ -2451,11 +2445,11 @@ export interface BookingPolicyViolations {
|
|
|
2451
2445
|
/** Booking policy violation: Online booking is disabled for this slot. */
|
|
2452
2446
|
bookOnlineDisabled?: boolean | null;
|
|
2453
2447
|
}
|
|
2454
|
-
|
|
2448
|
+
interface BookingPolicySettings {
|
|
2455
2449
|
/** Booking policy settings for a given slot or schedule. */
|
|
2456
2450
|
maxParticipantsPerBooking?: number | null;
|
|
2457
2451
|
}
|
|
2458
|
-
|
|
2452
|
+
interface AvailableResources {
|
|
2459
2453
|
/**
|
|
2460
2454
|
* Resource type ID.
|
|
2461
2455
|
* @format GUID
|
|
@@ -2470,18 +2464,18 @@ export interface AvailableResources {
|
|
|
2470
2464
|
*/
|
|
2471
2465
|
resourceIds?: string[];
|
|
2472
2466
|
}
|
|
2473
|
-
|
|
2467
|
+
interface GetScheduleAvailabilityRequest {
|
|
2474
2468
|
/**
|
|
2475
2469
|
* ID of the schedule for which to check availability.
|
|
2476
2470
|
* @format GUID
|
|
2477
2471
|
*/
|
|
2478
2472
|
scheduleId?: string;
|
|
2479
2473
|
}
|
|
2480
|
-
|
|
2474
|
+
interface GetScheduleAvailabilityResponse {
|
|
2481
2475
|
availability?: ScheduleAvailability;
|
|
2482
2476
|
bookingPolicySettings?: BookingPolicySettings;
|
|
2483
2477
|
}
|
|
2484
|
-
|
|
2478
|
+
interface ScheduleAvailability {
|
|
2485
2479
|
/** Total number of spots. */
|
|
2486
2480
|
totalSpots?: number | null;
|
|
2487
2481
|
/** Number of remaining open spots. */
|
|
@@ -2489,7 +2483,7 @@ export interface ScheduleAvailability {
|
|
|
2489
2483
|
/** Indicators of booking policy violations for the specified schedule. */
|
|
2490
2484
|
bookingPolicyViolations?: BookingPolicyViolations;
|
|
2491
2485
|
}
|
|
2492
|
-
|
|
2486
|
+
interface MarkBookingAsPendingRequest {
|
|
2493
2487
|
/**
|
|
2494
2488
|
* ID of the booking to mark as `PENDING`.
|
|
2495
2489
|
* @format GUID
|
|
@@ -2522,7 +2516,7 @@ export interface MarkBookingAsPendingRequest {
|
|
|
2522
2516
|
*/
|
|
2523
2517
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
2524
2518
|
}
|
|
2525
|
-
|
|
2519
|
+
interface MarkBookingAsPendingFlowControlSettings {
|
|
2526
2520
|
/**
|
|
2527
2521
|
* Whether to check for double bookings before updating the booking as pending.
|
|
2528
2522
|
*
|
|
@@ -2538,11 +2532,11 @@ export interface MarkBookingAsPendingFlowControlSettings {
|
|
|
2538
2532
|
*/
|
|
2539
2533
|
skipPendingApprovalServiceValidation?: boolean;
|
|
2540
2534
|
}
|
|
2541
|
-
|
|
2535
|
+
interface MarkBookingAsPendingResponse {
|
|
2542
2536
|
/** Updated booking. */
|
|
2543
2537
|
booking?: Booking;
|
|
2544
2538
|
}
|
|
2545
|
-
|
|
2539
|
+
interface BookingMarkedAsPending {
|
|
2546
2540
|
/** The booking object that was marked as pending. */
|
|
2547
2541
|
booking?: Booking;
|
|
2548
2542
|
/** Information about whether to notify the customer upon manual confirmation of the pending booking and the message to send. */
|
|
@@ -2561,24 +2555,24 @@ export interface BookingMarkedAsPending {
|
|
|
2561
2555
|
/** The previous payment status of the booking. */
|
|
2562
2556
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
2563
2557
|
}
|
|
2564
|
-
|
|
2558
|
+
interface MigrationCheckIfClashesWithBlockedTimeRequest {
|
|
2565
2559
|
msidAndBookingIds?: MsidAndBookingId[];
|
|
2566
2560
|
}
|
|
2567
|
-
|
|
2561
|
+
interface MsidAndBookingId {
|
|
2568
2562
|
msid?: string;
|
|
2569
2563
|
bookingId?: string;
|
|
2570
2564
|
}
|
|
2571
|
-
|
|
2565
|
+
interface MigrationCheckIfClashesWithBlockedTimeResponse {
|
|
2572
2566
|
clashes?: Clash[];
|
|
2573
2567
|
}
|
|
2574
|
-
|
|
2568
|
+
interface Clash {
|
|
2575
2569
|
msid?: string;
|
|
2576
2570
|
bookingId?: string;
|
|
2577
2571
|
sessionId?: string;
|
|
2578
2572
|
resourceName?: string;
|
|
2579
2573
|
contactName?: string;
|
|
2580
2574
|
}
|
|
2581
|
-
|
|
2575
|
+
interface CountBookingsRequest {
|
|
2582
2576
|
/**
|
|
2583
2577
|
* Filter object in the following format:
|
|
2584
2578
|
* `"filter" : {
|
|
@@ -2589,11 +2583,11 @@ export interface CountBookingsRequest {
|
|
|
2589
2583
|
*/
|
|
2590
2584
|
filter?: Record<string, any> | null;
|
|
2591
2585
|
}
|
|
2592
|
-
|
|
2586
|
+
interface CountBookingsResponse {
|
|
2593
2587
|
/** Number of bookings matching the specified filter. */
|
|
2594
2588
|
count?: number;
|
|
2595
2589
|
}
|
|
2596
|
-
|
|
2590
|
+
interface CreateMultiServiceBookingRequest {
|
|
2597
2591
|
/**
|
|
2598
2592
|
* Single-service bookings to combine in a multi-service booking.
|
|
2599
2593
|
* @minSize 2
|
|
@@ -2622,23 +2616,23 @@ export interface CreateMultiServiceBookingRequest {
|
|
|
2622
2616
|
/** Multi service booking type. */
|
|
2623
2617
|
multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
|
|
2624
2618
|
}
|
|
2625
|
-
|
|
2619
|
+
interface CreateMultiServiceBookingResponse {
|
|
2626
2620
|
/**
|
|
2627
2621
|
* Created multi service booking.
|
|
2628
2622
|
* Contains the booking results in the same order as specified in the request.
|
|
2629
2623
|
*/
|
|
2630
2624
|
multiServiceBooking?: MultiServiceBooking;
|
|
2631
2625
|
}
|
|
2632
|
-
|
|
2626
|
+
interface MultiServiceBooking {
|
|
2633
2627
|
/**
|
|
2634
2628
|
* Multi-service booking ID.
|
|
2635
2629
|
* @format GUID
|
|
2636
2630
|
*/
|
|
2637
|
-
|
|
2631
|
+
_id?: string | null;
|
|
2638
2632
|
/** The created bookings that are part of the multi-service booking. */
|
|
2639
2633
|
bookings?: BookingResult[];
|
|
2640
2634
|
}
|
|
2641
|
-
|
|
2635
|
+
interface BookingResult {
|
|
2642
2636
|
/**
|
|
2643
2637
|
* Booking ID.
|
|
2644
2638
|
* @format GUID
|
|
@@ -2647,7 +2641,7 @@ export interface BookingResult {
|
|
|
2647
2641
|
/** Booking entity. */
|
|
2648
2642
|
booking?: Booking;
|
|
2649
2643
|
}
|
|
2650
|
-
|
|
2644
|
+
interface RescheduleMultiServiceBookingRequest {
|
|
2651
2645
|
/**
|
|
2652
2646
|
* ID of the multi service booking to reschedule.
|
|
2653
2647
|
* @format GUID
|
|
@@ -2670,7 +2664,7 @@ export interface RescheduleMultiServiceBookingRequest {
|
|
|
2670
2664
|
/** Whether to return the rescheduled bookings entities. */
|
|
2671
2665
|
returnFullEntity?: boolean;
|
|
2672
2666
|
}
|
|
2673
|
-
|
|
2667
|
+
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2674
2668
|
/**
|
|
2675
2669
|
* Total number of participants. Available only for services with variants.
|
|
2676
2670
|
* Specify when all participants book the same variant.
|
|
@@ -2697,7 +2691,7 @@ export interface RescheduleBookingInfo extends RescheduleBookingInfoParticipants
|
|
|
2697
2691
|
revision?: string | null;
|
|
2698
2692
|
}
|
|
2699
2693
|
/** @oneof */
|
|
2700
|
-
|
|
2694
|
+
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2701
2695
|
/**
|
|
2702
2696
|
* Total number of participants. Available only for services with variants.
|
|
2703
2697
|
* Specify when all participants book the same variant.
|
|
@@ -2710,18 +2704,18 @@ export interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
|
2710
2704
|
*/
|
|
2711
2705
|
participantsChoices?: ParticipantChoices;
|
|
2712
2706
|
}
|
|
2713
|
-
|
|
2707
|
+
interface RescheduleMultiServiceBookingResponse {
|
|
2714
2708
|
/** Rescheduled multi-service booking. */
|
|
2715
2709
|
multiServiceBooking?: MultiServiceBooking;
|
|
2716
2710
|
}
|
|
2717
|
-
|
|
2711
|
+
interface GetMultiServiceBookingAvailabilityRequest {
|
|
2718
2712
|
/**
|
|
2719
2713
|
* ID of the multi-service booking to retrieve.
|
|
2720
2714
|
* @format GUID
|
|
2721
2715
|
*/
|
|
2722
2716
|
multiServiceBookingId: string | null;
|
|
2723
2717
|
}
|
|
2724
|
-
|
|
2718
|
+
interface GetMultiServiceBookingAvailabilityResponse {
|
|
2725
2719
|
/** Whether all contained single-service bookings are bookable. */
|
|
2726
2720
|
bookable?: boolean;
|
|
2727
2721
|
/** Total number of spots. */
|
|
@@ -2735,14 +2729,14 @@ export interface GetMultiServiceBookingAvailabilityResponse {
|
|
|
2735
2729
|
/** Info of the bookings this availability was calculated for. */
|
|
2736
2730
|
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
2737
2731
|
}
|
|
2738
|
-
|
|
2732
|
+
interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
2739
2733
|
/**
|
|
2740
2734
|
* Booking ID.
|
|
2741
2735
|
* @format GUID
|
|
2742
2736
|
*/
|
|
2743
2737
|
bookingId?: string | null;
|
|
2744
2738
|
}
|
|
2745
|
-
|
|
2739
|
+
interface CancelMultiServiceBookingRequest {
|
|
2746
2740
|
/**
|
|
2747
2741
|
* ID of the multi-service booking to cancel.
|
|
2748
2742
|
* @format GUID
|
|
@@ -2763,11 +2757,11 @@ export interface CancelMultiServiceBookingRequest {
|
|
|
2763
2757
|
/** Whether to return the canceled single-service bookings. */
|
|
2764
2758
|
returnFullEntity?: boolean;
|
|
2765
2759
|
}
|
|
2766
|
-
|
|
2760
|
+
interface CancelMultiServiceBookingResponse {
|
|
2767
2761
|
/** Canceled multi-service booking. */
|
|
2768
2762
|
multiServiceBooking?: MultiServiceBooking;
|
|
2769
2763
|
}
|
|
2770
|
-
|
|
2764
|
+
interface MarkMultiServiceBookingAsPendingRequest {
|
|
2771
2765
|
/**
|
|
2772
2766
|
* ID of the multi-service booking to mark as `PENDING`.
|
|
2773
2767
|
* @format GUID
|
|
@@ -2798,7 +2792,7 @@ export interface MarkMultiServiceBookingAsPendingRequest {
|
|
|
2798
2792
|
*/
|
|
2799
2793
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
2800
2794
|
}
|
|
2801
|
-
|
|
2795
|
+
interface BookingInfo {
|
|
2802
2796
|
/**
|
|
2803
2797
|
* ID of the single-service booking.
|
|
2804
2798
|
* @format GUID
|
|
@@ -2813,11 +2807,11 @@ export interface BookingInfo {
|
|
|
2813
2807
|
/** Payment status to set for the single-service booking. */
|
|
2814
2808
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
2815
2809
|
}
|
|
2816
|
-
|
|
2810
|
+
interface MarkMultiServiceBookingAsPendingResponse {
|
|
2817
2811
|
/** Updated multi-service booking. */
|
|
2818
2812
|
multiServiceBooking?: MultiServiceBooking;
|
|
2819
2813
|
}
|
|
2820
|
-
|
|
2814
|
+
interface ConfirmMultiServiceBookingRequest {
|
|
2821
2815
|
/**
|
|
2822
2816
|
* ID of the multi-service booking to confirm its related bookings.
|
|
2823
2817
|
* @format GUID
|
|
@@ -2848,11 +2842,11 @@ export interface ConfirmMultiServiceBookingRequest {
|
|
|
2848
2842
|
*/
|
|
2849
2843
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
2850
2844
|
}
|
|
2851
|
-
|
|
2845
|
+
interface ConfirmMultiServiceBookingResponse {
|
|
2852
2846
|
/** Confirmed multi service booking. */
|
|
2853
2847
|
multiServiceBooking?: MultiServiceBooking;
|
|
2854
2848
|
}
|
|
2855
|
-
|
|
2849
|
+
interface DeclineMultiServiceBookingRequest {
|
|
2856
2850
|
/**
|
|
2857
2851
|
* ID of the multi service booking to decline.
|
|
2858
2852
|
* @format GUID
|
|
@@ -2875,11 +2869,11 @@ export interface DeclineMultiServiceBookingRequest {
|
|
|
2875
2869
|
*/
|
|
2876
2870
|
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
2877
2871
|
}
|
|
2878
|
-
|
|
2872
|
+
interface DeclineMultiServiceBookingResponse {
|
|
2879
2873
|
/** Declined multi-service booking. */
|
|
2880
2874
|
multiServiceBooking?: MultiServiceBooking;
|
|
2881
2875
|
}
|
|
2882
|
-
|
|
2876
|
+
interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
2883
2877
|
/**
|
|
2884
2878
|
* IDs of the multi-service bookings to retrieve allowed actions for.
|
|
2885
2879
|
* @format GUID
|
|
@@ -2888,7 +2882,7 @@ export interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
|
2888
2882
|
*/
|
|
2889
2883
|
multiServiceBookingIds: string[] | null;
|
|
2890
2884
|
}
|
|
2891
|
-
|
|
2885
|
+
interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
2892
2886
|
/**
|
|
2893
2887
|
* Information about the multi-service bookings that were retrieved.
|
|
2894
2888
|
* Including their ID, index in the bulk request and whether they were
|
|
@@ -2898,20 +2892,20 @@ export interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
|
2898
2892
|
/** Total number of successes and failures for Bulk Update Bookings. */
|
|
2899
2893
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2900
2894
|
}
|
|
2901
|
-
|
|
2895
|
+
interface GetMultiServiceBookingRequest {
|
|
2902
2896
|
/**
|
|
2903
2897
|
* ID of the multi-service booking.
|
|
2904
2898
|
* @format GUID
|
|
2905
2899
|
*/
|
|
2906
2900
|
multiServiceBookingId: string | null;
|
|
2907
2901
|
}
|
|
2908
|
-
|
|
2902
|
+
interface GetMultiServiceBookingResponse {
|
|
2909
2903
|
/** Retrieved multi-service booking. */
|
|
2910
2904
|
multiServiceBooking?: MultiServiceBooking;
|
|
2911
2905
|
/** Details about how many single-service bookings belong to the multi-service booking. */
|
|
2912
2906
|
metadata?: MultiServiceBookingMetadata;
|
|
2913
2907
|
}
|
|
2914
|
-
|
|
2908
|
+
interface MultiServiceBookingMetadata {
|
|
2915
2909
|
/**
|
|
2916
2910
|
* Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
|
|
2917
2911
|
* to the multi-service booking. The total includes the number of single-service
|
|
@@ -2919,7 +2913,7 @@ export interface MultiServiceBookingMetadata {
|
|
|
2919
2913
|
*/
|
|
2920
2914
|
totalNumberOfScheduledBookings?: number | null;
|
|
2921
2915
|
}
|
|
2922
|
-
|
|
2916
|
+
interface AddBookingsToMultiServiceBookingRequest {
|
|
2923
2917
|
/**
|
|
2924
2918
|
* ID of the multi-service booking.
|
|
2925
2919
|
* @format GUID
|
|
@@ -2933,7 +2927,7 @@ export interface AddBookingsToMultiServiceBookingRequest {
|
|
|
2933
2927
|
/** Whether to return the single-service bookings that were added to the multi-service booking. */
|
|
2934
2928
|
returnFullEntity?: boolean;
|
|
2935
2929
|
}
|
|
2936
|
-
|
|
2930
|
+
interface BookingIdAndRevision {
|
|
2937
2931
|
/**
|
|
2938
2932
|
* ID of the booking.
|
|
2939
2933
|
* @format GUID
|
|
@@ -2946,11 +2940,11 @@ export interface BookingIdAndRevision {
|
|
|
2946
2940
|
*/
|
|
2947
2941
|
revision?: string | null;
|
|
2948
2942
|
}
|
|
2949
|
-
|
|
2943
|
+
interface AddBookingsToMultiServiceBookingResponse {
|
|
2950
2944
|
/** Single-service bookings that were added to the multi-service booking. */
|
|
2951
2945
|
bookings?: BookingResult[];
|
|
2952
2946
|
}
|
|
2953
|
-
|
|
2947
|
+
interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
2954
2948
|
/**
|
|
2955
2949
|
* ID of the multi-service booking.
|
|
2956
2950
|
* @format GUID
|
|
@@ -2964,7 +2958,395 @@ export interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
|
2964
2958
|
/** Whether to return the single-service bookings. */
|
|
2965
2959
|
returnFullEntity?: boolean;
|
|
2966
2960
|
}
|
|
2967
|
-
|
|
2961
|
+
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
2968
2962
|
/** Single-service bookings that were removed from the multi-service booking. */
|
|
2969
2963
|
bookings?: BookingResult[];
|
|
2970
2964
|
}
|
|
2965
|
+
interface BaseEventMetadata {
|
|
2966
|
+
/**
|
|
2967
|
+
* App instance ID.
|
|
2968
|
+
* @format GUID
|
|
2969
|
+
*/
|
|
2970
|
+
instanceId?: string | null;
|
|
2971
|
+
/**
|
|
2972
|
+
* Event type.
|
|
2973
|
+
* @maxLength 150
|
|
2974
|
+
*/
|
|
2975
|
+
eventType?: string;
|
|
2976
|
+
/** The identification type and identity data. */
|
|
2977
|
+
identity?: WebhooksIdentificationData;
|
|
2978
|
+
}
|
|
2979
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2980
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2981
|
+
_id?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2984
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2985
|
+
*/
|
|
2986
|
+
entityFqdn?: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2989
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2990
|
+
*/
|
|
2991
|
+
slug?: string;
|
|
2992
|
+
/** ID of the entity associated with the event. */
|
|
2993
|
+
entityId?: string;
|
|
2994
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2995
|
+
eventTime?: Date | null;
|
|
2996
|
+
/**
|
|
2997
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2998
|
+
* (for example, GDPR).
|
|
2999
|
+
*/
|
|
3000
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3001
|
+
/** If present, indicates the action that triggered the event. */
|
|
3002
|
+
originatedFrom?: string | null;
|
|
3003
|
+
/**
|
|
3004
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3005
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3006
|
+
*/
|
|
3007
|
+
entityEventSequence?: string | null;
|
|
3008
|
+
}
|
|
3009
|
+
interface BookingCanceledEnvelope {
|
|
3010
|
+
data: BookingCanceled;
|
|
3011
|
+
metadata: EventMetadata;
|
|
3012
|
+
}
|
|
3013
|
+
interface BookingConfirmedEnvelope {
|
|
3014
|
+
data: BookingConfirmed;
|
|
3015
|
+
metadata: EventMetadata;
|
|
3016
|
+
}
|
|
3017
|
+
interface BookingCreatedEnvelope {
|
|
3018
|
+
entity: Booking;
|
|
3019
|
+
metadata: EventMetadata;
|
|
3020
|
+
}
|
|
3021
|
+
interface BookingDeclinedEnvelope {
|
|
3022
|
+
data: BookingDeclined;
|
|
3023
|
+
metadata: EventMetadata;
|
|
3024
|
+
}
|
|
3025
|
+
interface BookingNumberOfParticipantsUpdatedEnvelope {
|
|
3026
|
+
data: NumberOfParticipantsUpdated;
|
|
3027
|
+
metadata: EventMetadata;
|
|
3028
|
+
}
|
|
3029
|
+
interface BookingRescheduledEnvelope {
|
|
3030
|
+
data: BookingRescheduled;
|
|
3031
|
+
metadata: EventMetadata;
|
|
3032
|
+
}
|
|
3033
|
+
interface BookingUpdatedEnvelope {
|
|
3034
|
+
entity: Booking;
|
|
3035
|
+
metadata: EventMetadata;
|
|
3036
|
+
}
|
|
3037
|
+
interface ConfirmOrDeclineBookingOptions {
|
|
3038
|
+
/**
|
|
3039
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
3040
|
+
* not the *eCommerce checkout*
|
|
3041
|
+
* ([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)).
|
|
3042
|
+
*
|
|
3043
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
3044
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
3045
|
+
*/
|
|
3046
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
3047
|
+
}
|
|
3048
|
+
interface BulkConfirmOrDeclineBookingOptions {
|
|
3049
|
+
/** Whether to return the confirmed or declined booking objects. */
|
|
3050
|
+
returnEntity?: boolean;
|
|
3051
|
+
}
|
|
3052
|
+
interface CreateBookingOptions {
|
|
3053
|
+
/**
|
|
3054
|
+
* Information about whether to notify the customer and
|
|
3055
|
+
* the message to send.
|
|
3056
|
+
*/
|
|
3057
|
+
participantNotification?: ParticipantNotification;
|
|
3058
|
+
/**
|
|
3059
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3060
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3061
|
+
* Default: `true`.
|
|
3062
|
+
*/
|
|
3063
|
+
sendSmsReminder?: boolean | null;
|
|
3064
|
+
/**
|
|
3065
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3066
|
+
* For example, whether to check availability when creating a booking.
|
|
3067
|
+
*/
|
|
3068
|
+
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
3069
|
+
}
|
|
3070
|
+
interface BulkCreateBookingOptions {
|
|
3071
|
+
/** Whether to return the created bookings. */
|
|
3072
|
+
returnFullEntity?: boolean;
|
|
3073
|
+
}
|
|
3074
|
+
interface RescheduleBookingOptions extends RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
3075
|
+
/**
|
|
3076
|
+
* Revision number, which increments by 1 each time the booking is rescheduled.
|
|
3077
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
3078
|
+
* rescheduling the booking.
|
|
3079
|
+
*/
|
|
3080
|
+
revision: string | null;
|
|
3081
|
+
/**
|
|
3082
|
+
* Information about whether to notify the customer about the rescheduling and
|
|
3083
|
+
* the message to send.
|
|
3084
|
+
*/
|
|
3085
|
+
participantNotification?: ParticipantNotification;
|
|
3086
|
+
/**
|
|
3087
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3088
|
+
* For example, whether to check availability when rescheduling a booking.
|
|
3089
|
+
*/
|
|
3090
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
3091
|
+
/**
|
|
3092
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3093
|
+
* same service variant.
|
|
3094
|
+
*/
|
|
3095
|
+
totalParticipants?: number;
|
|
3096
|
+
/**
|
|
3097
|
+
* Information about the service choices to book. Specify when not all
|
|
3098
|
+
* participants have booked the same service variant.
|
|
3099
|
+
*/
|
|
3100
|
+
participantsChoices?: ParticipantChoices;
|
|
3101
|
+
}
|
|
3102
|
+
/** @oneof */
|
|
3103
|
+
interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
3104
|
+
/**
|
|
3105
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3106
|
+
* same service variant.
|
|
3107
|
+
*/
|
|
3108
|
+
totalParticipants?: number;
|
|
3109
|
+
/**
|
|
3110
|
+
* Information about the service choices to book. Specify when not all
|
|
3111
|
+
* participants have booked the same service variant.
|
|
3112
|
+
*/
|
|
3113
|
+
participantsChoices?: ParticipantChoices;
|
|
3114
|
+
}
|
|
3115
|
+
interface ConfirmBookingOptions {
|
|
3116
|
+
/**
|
|
3117
|
+
* Information about whether to notify the customer about the confirmation and
|
|
3118
|
+
* the message to send.
|
|
3119
|
+
*/
|
|
3120
|
+
participantNotification?: ParticipantNotification;
|
|
3121
|
+
/**
|
|
3122
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3123
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3124
|
+
*/
|
|
3125
|
+
sendSmsReminder?: boolean | null;
|
|
3126
|
+
/** Payment status to set for the booking. */
|
|
3127
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
3128
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3129
|
+
doubleBooked?: boolean | null;
|
|
3130
|
+
/**
|
|
3131
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3132
|
+
* For example, whether to check availability when confirming a booking.
|
|
3133
|
+
*/
|
|
3134
|
+
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
3135
|
+
}
|
|
3136
|
+
interface UpdateExtendedFieldsOptions {
|
|
3137
|
+
/** 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. */
|
|
3138
|
+
namespaceData: Record<string, any> | null;
|
|
3139
|
+
}
|
|
3140
|
+
interface DeclineBookingOptions {
|
|
3141
|
+
/**
|
|
3142
|
+
* Information about whether to notify the customer and
|
|
3143
|
+
* the message to send.
|
|
3144
|
+
*/
|
|
3145
|
+
participantNotification?: ParticipantNotification;
|
|
3146
|
+
/** Payment status to set for the booking. */
|
|
3147
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
3148
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3149
|
+
doubleBooked?: boolean | null;
|
|
3150
|
+
/**
|
|
3151
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3152
|
+
* For example, whether to refund a declined booking.
|
|
3153
|
+
*/
|
|
3154
|
+
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
3155
|
+
}
|
|
3156
|
+
interface CancelBookingOptions {
|
|
3157
|
+
/**
|
|
3158
|
+
* Information about whether to notify the customer about the cancellation and
|
|
3159
|
+
* the message to send.
|
|
3160
|
+
*/
|
|
3161
|
+
participantNotification?: ParticipantNotification;
|
|
3162
|
+
/**
|
|
3163
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3164
|
+
* For example, whether to allow a cancellation even though the service's
|
|
3165
|
+
* policy doesn't allow it.
|
|
3166
|
+
*/
|
|
3167
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
3168
|
+
/**
|
|
3169
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
3170
|
+
*
|
|
3171
|
+
* To prevent conflicting changes, the current revision must be specified when
|
|
3172
|
+
* managing the booking.
|
|
3173
|
+
*/
|
|
3174
|
+
revision: string | null;
|
|
3175
|
+
}
|
|
3176
|
+
interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
3177
|
+
/**
|
|
3178
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
3179
|
+
*
|
|
3180
|
+
* To prevent conflicting changes, the current revision must be specified
|
|
3181
|
+
* when updating the booking.
|
|
3182
|
+
*/
|
|
3183
|
+
revision: string | null;
|
|
3184
|
+
/**
|
|
3185
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3186
|
+
* same service variant.
|
|
3187
|
+
*/
|
|
3188
|
+
totalParticipants?: number;
|
|
3189
|
+
/**
|
|
3190
|
+
* Information about the service choices the participants have booked. Specify
|
|
3191
|
+
* when not all participants have booked the same service variant.
|
|
3192
|
+
*/
|
|
3193
|
+
participantsChoices?: ParticipantChoices;
|
|
3194
|
+
}
|
|
3195
|
+
/** @oneof */
|
|
3196
|
+
interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
3197
|
+
/**
|
|
3198
|
+
* Total number of participants. Specify when all participants have booked the
|
|
3199
|
+
* same service variant.
|
|
3200
|
+
*/
|
|
3201
|
+
totalParticipants?: number;
|
|
3202
|
+
/**
|
|
3203
|
+
* Information about the service choices the participants have booked. Specify
|
|
3204
|
+
* when not all participants have booked the same service variant.
|
|
3205
|
+
*/
|
|
3206
|
+
participantsChoices?: ParticipantChoices;
|
|
3207
|
+
}
|
|
3208
|
+
interface CreateMultiServiceBookingOptions {
|
|
3209
|
+
/**
|
|
3210
|
+
* Information about whether to notify the customer and
|
|
3211
|
+
* the message to send.
|
|
3212
|
+
*/
|
|
3213
|
+
participantNotification?: ParticipantNotification;
|
|
3214
|
+
/**
|
|
3215
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3216
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3217
|
+
*
|
|
3218
|
+
* Default: `true`
|
|
3219
|
+
*/
|
|
3220
|
+
sendSmsReminder?: boolean | null;
|
|
3221
|
+
/**
|
|
3222
|
+
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
3223
|
+
* For example, whether to check availability before updating the status.
|
|
3224
|
+
*/
|
|
3225
|
+
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
3226
|
+
/** Whether to return the created single-service bookings. */
|
|
3227
|
+
returnFullEntity?: boolean;
|
|
3228
|
+
/** Multi service booking type. */
|
|
3229
|
+
multiServiceBookingType?: MultiServiceBookingTypeWithLiterals;
|
|
3230
|
+
}
|
|
3231
|
+
interface RescheduleMultiServiceBookingOptions {
|
|
3232
|
+
/**
|
|
3233
|
+
* Information about whether to notify the customer and
|
|
3234
|
+
* the message to send.
|
|
3235
|
+
*/
|
|
3236
|
+
participantNotification?: ParticipantNotification;
|
|
3237
|
+
/**
|
|
3238
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3239
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
3240
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
3241
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
3242
|
+
*/
|
|
3243
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
3244
|
+
/** Whether to return the rescheduled bookings entities. */
|
|
3245
|
+
returnFullEntity?: boolean;
|
|
3246
|
+
}
|
|
3247
|
+
interface CancelMultiServiceBookingOptions {
|
|
3248
|
+
/**
|
|
3249
|
+
* Information about whether to notify the customer and
|
|
3250
|
+
* the message to send.
|
|
3251
|
+
*/
|
|
3252
|
+
participantNotification?: ParticipantNotification;
|
|
3253
|
+
/**
|
|
3254
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3255
|
+
* cancellation flow are changed. For example, whether you can cancel
|
|
3256
|
+
* a booking even though the cancellation policy doesn't allow it or whether
|
|
3257
|
+
* to issue a refund.
|
|
3258
|
+
*/
|
|
3259
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
3260
|
+
/** Whether to return the canceled single-service bookings. */
|
|
3261
|
+
returnFullEntity?: boolean;
|
|
3262
|
+
}
|
|
3263
|
+
interface MarkMultiServiceBookingAsPendingOptions {
|
|
3264
|
+
/** Information about the single-service bookings to mark as `PENDING`. */
|
|
3265
|
+
markAsPendingBookingsInfo?: BookingInfo[];
|
|
3266
|
+
/**
|
|
3267
|
+
* Information about whether to notify the customer and
|
|
3268
|
+
* the message to send.
|
|
3269
|
+
*/
|
|
3270
|
+
participantNotification?: ParticipantNotification;
|
|
3271
|
+
/**
|
|
3272
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3273
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3274
|
+
*
|
|
3275
|
+
* Default: `true`
|
|
3276
|
+
*/
|
|
3277
|
+
sendSmsReminder?: boolean | null;
|
|
3278
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3279
|
+
doubleBooked?: boolean | null;
|
|
3280
|
+
/** Whether to return the single-service bookings that were marked as `PENDING`. */
|
|
3281
|
+
returnFullEntity?: boolean;
|
|
3282
|
+
/**
|
|
3283
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3284
|
+
* creation flow are changed. For example, whether the availability is checked
|
|
3285
|
+
* before updating the booking.
|
|
3286
|
+
*/
|
|
3287
|
+
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
3288
|
+
}
|
|
3289
|
+
interface ConfirmMultiServiceBookingOptions {
|
|
3290
|
+
/** Information about the single-service bookings to confirm. */
|
|
3291
|
+
confirmBookingsInfo?: BookingInfo[];
|
|
3292
|
+
/**
|
|
3293
|
+
* Information about whether to notify the customer and
|
|
3294
|
+
* the message to send.
|
|
3295
|
+
*/
|
|
3296
|
+
participantNotification?: ParticipantNotification;
|
|
3297
|
+
/**
|
|
3298
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3299
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3300
|
+
*
|
|
3301
|
+
* Default: `true`
|
|
3302
|
+
*/
|
|
3303
|
+
sendSmsReminder?: boolean | null;
|
|
3304
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3305
|
+
doubleBooked?: boolean | null;
|
|
3306
|
+
/** Whether to return the confirmed single-service bookings. */
|
|
3307
|
+
returnFullEntity?: boolean;
|
|
3308
|
+
/**
|
|
3309
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3310
|
+
* confirmation flow are changed. For example, whether the availability is
|
|
3311
|
+
* checked before confirming the booking.
|
|
3312
|
+
*/
|
|
3313
|
+
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
3314
|
+
}
|
|
3315
|
+
interface DeclineMultiServiceBookingOptions {
|
|
3316
|
+
/** Information about the single-service bookings to decline. */
|
|
3317
|
+
declineBookingsInfo?: BookingInfo[];
|
|
3318
|
+
/**
|
|
3319
|
+
* Information about whether to notify the customer and
|
|
3320
|
+
* the message to send.
|
|
3321
|
+
*/
|
|
3322
|
+
participantNotification?: ParticipantNotification;
|
|
3323
|
+
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
3324
|
+
doubleBooked?: boolean | null;
|
|
3325
|
+
/** Whether to return the declined single-service bookings. */
|
|
3326
|
+
returnFullEntity?: boolean;
|
|
3327
|
+
/**
|
|
3328
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
3329
|
+
* declining flow are changed. For example, whether to issue a refund.
|
|
3330
|
+
*/
|
|
3331
|
+
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
3332
|
+
}
|
|
3333
|
+
interface AddBookingsToMultiServiceBookingOptions {
|
|
3334
|
+
/**
|
|
3335
|
+
* List of single-service booking IDs and their revision.
|
|
3336
|
+
* @maxSize 8
|
|
3337
|
+
*/
|
|
3338
|
+
bookings: BookingIdAndRevision[];
|
|
3339
|
+
/** Whether to return the single-service bookings that were added to the multi-service booking. */
|
|
3340
|
+
returnFullEntity?: boolean;
|
|
3341
|
+
}
|
|
3342
|
+
interface RemoveBookingsFromMultiServiceBookingOptions {
|
|
3343
|
+
/**
|
|
3344
|
+
* List of single-service booking IDs and their revision.
|
|
3345
|
+
* @maxSize 8
|
|
3346
|
+
*/
|
|
3347
|
+
bookings?: BookingIdAndRevision[];
|
|
3348
|
+
/** Whether to return the single-service bookings. */
|
|
3349
|
+
returnFullEntity?: boolean;
|
|
3350
|
+
}
|
|
3351
|
+
|
|
3352
|
+
export { ValueType 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, type BookingCanceledEnvelope as P, type BookingConfirmedEnvelope as Q, type RescheduleBookingOptions as R, type BookingCreatedEnvelope as S, type BookingDeclinedEnvelope as T, type UpdateExtendedFieldsOptions as U, type V2Slot as V, type BookingNumberOfParticipantsUpdatedEnvelope as W, type BookingRescheduledEnvelope as X, type BookingUpdatedEnvelope as Y, MultiServiceBookingType as Z, LocationType as _, type ConfirmOrDeclineBookingResponse as a, type RescheduleBookingRequestFlowControlSettings as a$, BookingStatus as a0, PaymentStatus as a1, SelectedPaymentOption as a2, Platform as a3, Actor as a4, IdentificationDataIdentityType as a5, WebhookIdentityType as a6, LocationLocationType as a7, IdentityType as a8, SortOrder as a9, type BookedAddOn as aA, type BookingFormFilled as aB, type SetBookingFormAndSubmissionIdRequest as aC, type SetBookingFormAndSubmissionIdRequestCreatedByOneOf as aD, type SetBookingFormAndSubmissionIdResponse as aE, type DomainEvent as aF, type DomainEventBodyOneOf as aG, type EntityCreatedEvent as aH, type RestoreInfo as aI, type EntityUpdatedEvent as aJ, type EntityDeletedEvent as aK, type ActionEvent as aL, type MessageEnvelope as aM, type WebhooksIdentificationData as aN, type WebhooksIdentificationDataIdOneOf as aO, type V2CreateBookingRequest as aP, type V2CreateBookingRequestBookableItemOneOf as aQ, type V2CreateBookingRequestParticipantsInfoOneOf as aR, type Slot as aS, type SlotResource as aT, type CreateBookingRequestFlowControlSettings as aU, type V2CreateBookingResponse as aV, type V2CancelBookingRequest as aW, type CancelBookingRequestFlowControlSettings as aX, type V2CancelBookingResponse as aY, type V2RescheduleBookingRequest as aZ, type V2RescheduleBookingRequestParticipantsInfoOneOf as a_, type BookingParticipantsInfoOneOf as aa, type BookedEntity as ab, type BookedEntityItemOneOf as ac, type BookedSlot as ad, type BookedResource as ae, type Location as af, type BookedSchedule as ag, type ContactDetails as ah, type Address as ai, type AddressStreetOneOf as aj, type StreetAddress as ak, type AddressLocation as al, type Subdivision as am, type CustomFormField as an, type BookingSource as ao, type ParticipantNotification as ap, type CommonIdentificationData as aq, type CommonIdentificationDataIdOneOf as ar, type FlowControlSettings as as, type ExtendedFields as at, type ParticipantChoices as au, type ServiceChoices as av, type ServiceChoice as aw, type ServiceChoiceChoiceOneOf as ax, type Duration as ay, type MultiServiceBookingInfo as az, type BulkConfirmOrDeclineBookingOptions as b, type DeclineBookingFlowControlSettings as b$, type V2RescheduleBookingResponse as b0, type V2ConfirmBookingRequest as b1, type V2ConfirmBookingResponse as b2, type V2DeclineBookingRequest as b3, type V2DeclineBookingResponse as b4, type V2UpdateNumberOfParticipantsRequest as b5, type V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as b6, type V2UpdateNumberOfParticipantsResponse as b7, type ConfirmOrDeclineBookingRequest as b8, type BulkConfirmOrDeclineBookingRequest as b9, type SlotBookings as bA, type BulkRescheduleBookingResponse as bB, type BulkUpdateBookedScheduleRequest as bC, type BookingDetails as bD, type BulkUpdateBookedScheduleResponse as bE, type QueryBookingsRequest as bF, type QueryV2 as bG, type QueryV2PagingMethodOneOf as bH, type Sorting as bI, type Paging as bJ, type CursorPaging as bK, type QueryBookingsResponse as bL, type PagingMetadataV2 as bM, type Cursors as bN, type ConfirmRequest as bO, type ConfirmResponse as bP, type ConfirmBookingRequest as bQ, type ConfirmBookingFlowControlSettings as bR, type BookingConfirmed as bS, type ConsistentQueryBookingsRequest as bT, type ConsistentQueryBookingsResponse as bU, type SetBookingSessionIdRequest as bV, type SetBookingSessionIdResponse as bW, type SetBookingSubmissionIdRequest as bX, type SetBookingSubmissionIdResponse as bY, type UpdateExtendedFieldsRequest as bZ, type DeclineBookingRequest as b_, type BulkBookingResult as ba, type ItemMetadata as bb, type ApplicationError as bc, type BulkActionMetadata as bd, type BookingChanged as be, type CreateBookingRequest as bf, type CreateBookingFlowControlSettings as bg, type UpdateBookingRequest as bh, type UpdateBookingResponse as bi, type LegacyCreateBookingRequest as bj, type LegacyCreateBookingResponse as bk, type BulkUpdateBookingRequest as bl, type MaskedBooking as bm, type BulkUpdateBookingResponse as bn, type BulkCreateBookingRequest as bo, type RescheduleBookingRequest as bp, type RescheduleBookingRequestParticipantsInfoOneOf as bq, type SlotSlotResource as br, type SlotLocation as bs, type RescheduleBookingFlowControlSettings as bt, type BookingRescheduled as bu, type BookingRescheduledPreviousParticipantsInfoOneOf as bv, type IdentificationData as bw, type IdentificationDataIdOneOf as bx, type BulkRescheduleBookingRequest as by, type BulkRescheduleBookingRequestBooking as bz, type BulkConfirmOrDeclineBookingResponse as c, type BookingDeclined as c0, type CancelBookingRequest as c1, type CancelBookingFlowControlSettings as c2, type BookingCanceled as c3, type UpdateNumberOfParticipantsRequest as c4, type UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as c5, type NumberOfParticipantsUpdated as c6, type NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf as c7, type BulkCalculateAllowedActionsRequest as c8, type BulkCalculateAllowedActionsResponse as c9, type GetMultiServiceBookingAvailabilityRequest as cA, type GetMultiServiceBookingAvailabilityResponseBookingInfo as cB, type CancelMultiServiceBookingRequest as cC, type MarkMultiServiceBookingAsPendingRequest as cD, type BookingInfo as cE, type ConfirmMultiServiceBookingRequest as cF, type DeclineMultiServiceBookingRequest as cG, type BulkGetMultiServiceBookingAllowedActionsRequest as cH, type GetMultiServiceBookingRequest as cI, type GetMultiServiceBookingResponse as cJ, type MultiServiceBookingMetadata as cK, type AddBookingsToMultiServiceBookingRequest as cL, type BookingIdAndRevision as cM, type RemoveBookingsFromMultiServiceBookingRequest as cN, type BaseEventMetadata as cO, type EventMetadata as cP, type RescheduleBookingOptionsParticipantsInfoOneOf as cQ, type UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf as cR, type BulkCalculateAllowedActionsResult as ca, type AllowedActions as cb, type GetSlotAvailabilityRequest as cc, type GetSlotAvailabilityResponse as cd, type SlotAvailability as ce, type WaitingList as cf, type BookingPolicyViolations as cg, type BookingPolicySettings as ch, type AvailableResources as ci, type GetScheduleAvailabilityRequest as cj, type GetScheduleAvailabilityResponse as ck, type ScheduleAvailability as cl, type MarkBookingAsPendingRequest as cm, type MarkBookingAsPendingFlowControlSettings as cn, type MarkBookingAsPendingResponse as co, type BookingMarkedAsPending as cp, type MigrationCheckIfClashesWithBlockedTimeRequest as cq, type MsidAndBookingId as cr, type MigrationCheckIfClashesWithBlockedTimeResponse as cs, type Clash as ct, type CountBookingsRequest as cu, type CountBookingsResponse as cv, type CreateMultiServiceBookingRequest as cw, type BookingResult as cx, type RescheduleMultiServiceBookingRequest as cy, type RescheduleBookingInfoParticipantsInfoOneOf 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 };
|