@wix/auto_sdk_bookings_bookings 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/bookings-v2-booking-bookings.context.d.ts +61 -0
- package/build/cjs/src/bookings-v2-booking-bookings.context.js +77 -0
- package/build/cjs/src/bookings-v2-booking-bookings.context.js.map +1 -0
- package/build/cjs/src/bookings-v2-booking-bookings.http.d.ts +510 -0
- package/build/cjs/src/bookings-v2-booking-bookings.http.js +1579 -0
- package/build/cjs/src/bookings-v2-booking-bookings.http.js.map +1 -0
- package/build/cjs/src/bookings-v2-booking-bookings.meta.d.ts +61 -0
- package/build/cjs/src/bookings-v2-booking-bookings.meta.js +427 -0
- package/build/cjs/src/bookings-v2-booking-bookings.meta.js.map +1 -0
- package/build/{internal/index.d.ts → cjs/src/bookings-v2-booking-bookings.public.d.ts} +34 -78
- package/build/cjs/src/bookings-v2-booking-bookings.public.js +313 -0
- package/build/cjs/src/bookings-v2-booking-bookings.public.js.map +1 -0
- package/build/{bookings-v2-booking-bookings.universal-r9r1xC1y.d.mts → cjs/src/bookings-v2-booking-bookings.types.d.ts} +261 -628
- package/build/cjs/src/bookings-v2-booking-bookings.types.js +165 -0
- package/build/cjs/src/bookings-v2-booking-bookings.types.js.map +1 -0
- package/build/cjs/src/bookings-v2-booking-bookings.universal.d.ts +4351 -0
- package/build/cjs/src/bookings-v2-booking-bookings.universal.js +1652 -0
- package/build/cjs/src/bookings-v2-booking-bookings.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/bookings-v2-booking-bookings.context.d.ts +61 -0
- package/build/es/src/bookings-v2-booking-bookings.context.js +61 -0
- package/build/es/src/bookings-v2-booking-bookings.context.js.map +1 -0
- package/build/es/src/bookings-v2-booking-bookings.http.d.ts +510 -0
- package/build/es/src/bookings-v2-booking-bookings.http.js +1555 -0
- package/build/es/src/bookings-v2-booking-bookings.http.js.map +1 -0
- package/build/es/src/bookings-v2-booking-bookings.meta.d.ts +61 -0
- package/build/es/src/bookings-v2-booking-bookings.meta.js +380 -0
- package/build/es/src/bookings-v2-booking-bookings.meta.js.map +1 -0
- package/build/{index.d.ts → es/src/bookings-v2-booking-bookings.public.d.ts} +34 -78
- package/build/es/src/bookings-v2-booking-bookings.public.js +276 -0
- package/build/es/src/bookings-v2-booking-bookings.public.js.map +1 -0
- package/build/{bookings-v2-booking-bookings.universal-r9r1xC1y.d.ts → es/src/bookings-v2-booking-bookings.types.d.ts} +261 -628
- package/build/es/src/bookings-v2-booking-bookings.types.js +162 -0
- package/build/es/src/bookings-v2-booking-bookings.types.js.map +1 -0
- package/build/es/src/bookings-v2-booking-bookings.universal.d.ts +4351 -0
- package/build/es/src/bookings-v2-booking-bookings.universal.js +1605 -0
- package/build/es/src/bookings-v2-booking-bookings.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.d.ts +61 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.js +77 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.context.js.map +1 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.d.ts +510 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.js +1579 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.http.js.map +1 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.d.ts +61 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.js +427 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.meta.js.map +1 -0
- package/build/internal/{index.d.mts → cjs/src/bookings-v2-booking-bookings.public.d.ts} +34 -78
- package/build/internal/cjs/src/bookings-v2-booking-bookings.public.js +313 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.public.js.map +1 -0
- package/build/internal/{bookings-v2-booking-bookings.universal-r9r1xC1y.d.ts → cjs/src/bookings-v2-booking-bookings.types.d.ts} +261 -628
- package/build/internal/cjs/src/bookings-v2-booking-bookings.types.js +165 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.types.js.map +1 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.d.ts +4351 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.js +1652 -0
- package/build/internal/cjs/src/bookings-v2-booking-bookings.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.context.d.ts +61 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.context.js +61 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.context.js.map +1 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.http.d.ts +510 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.http.js +1555 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.http.js.map +1 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.d.ts +61 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.js +380 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.meta.js.map +1 -0
- package/build/{index.d.mts → internal/es/src/bookings-v2-booking-bookings.public.d.ts} +34 -78
- package/build/internal/es/src/bookings-v2-booking-bookings.public.js +276 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.public.js.map +1 -0
- package/build/internal/{bookings-v2-booking-bookings.universal-r9r1xC1y.d.mts → es/src/bookings-v2-booking-bookings.types.d.ts} +261 -628
- package/build/internal/es/src/bookings-v2-booking-bookings.types.js +162 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.types.js.map +1 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.d.ts +4351 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.js +1605 -0
- package/build/internal/es/src/bookings-v2-booking-bookings.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.js +0 -2387
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -2323
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js +0 -2387
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -2323
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -1652
- package/build/internal/meta.d.ts +0 -1652
- package/build/internal/meta.js +0 -1522
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1475
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -1652
- package/build/meta.d.ts +0 -1652
- package/build/meta.js +0 -1522
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1475
- package/build/meta.mjs.map +0 -1
package/build/meta.d.mts
DELETED
|
@@ -1,1652 +0,0 @@
|
|
|
1
|
-
import { b1 as ConfirmOrDeclineBookingRequest$1, a as ConfirmOrDeclineBookingResponse$1, b2 as BulkConfirmOrDeclineBookingRequest$1, c as BulkConfirmOrDeclineBookingResponse$1, b8 as CreateBookingRequest$1, f as CreateBookingResponse$1, bh as BulkCreateBookingRequest$1, i as BulkCreateBookingResponse$1, bi as RescheduleBookingRequest$1, j as RescheduleBookingResponse$1, bJ as ConfirmBookingRequest$1, l as ConfirmBookingResponse$1, bS as UpdateExtendedFieldsRequest$1, m as UpdateExtendedFieldsResponse$1, bT as DeclineBookingRequest$1, n as DeclineBookingResponse$1, bW as CancelBookingRequest$1, p as CancelBookingResponse$1, bZ as UpdateNumberOfParticipantsRequest$1, r as UpdateNumberOfParticipantsResponse$1, cp as CreateMultiServiceBookingRequest$1, t as CreateMultiServiceBookingResponse$1, cr as RescheduleMultiServiceBookingRequest$1, w as RescheduleMultiServiceBookingResponse$1, ct as GetMultiServiceBookingAvailabilityRequest$1, G as GetMultiServiceBookingAvailabilityResponse$1, cv as CancelMultiServiceBookingRequest$1, y as CancelMultiServiceBookingResponse$1, cw as MarkMultiServiceBookingAsPendingRequest$1, z as MarkMultiServiceBookingAsPendingResponse$1, cy as ConfirmMultiServiceBookingRequest$1, E as ConfirmMultiServiceBookingResponse$1, cz as DeclineMultiServiceBookingRequest$1, H as DeclineMultiServiceBookingResponse$1, cA as BulkGetMultiServiceBookingAllowedActionsRequest$1, I as BulkGetMultiServiceBookingAllowedActionsResponse$1, cB as GetMultiServiceBookingRequest$1, cC as GetMultiServiceBookingResponse$1, cE as AddBookingsToMultiServiceBookingRequest$1, L as AddBookingsToMultiServiceBookingResponse$1, cG as RemoveBookingsFromMultiServiceBookingRequest$1, O as RemoveBookingsFromMultiServiceBookingResponse$1 } from './bookings-v2-booking-bookings.universal-r9r1xC1y.mjs';
|
|
2
|
-
|
|
3
|
-
/** An entity representing a scheduled appointment, class session, or course. */
|
|
4
|
-
interface Booking extends BookingParticipantsInfoOneOf {
|
|
5
|
-
/**
|
|
6
|
-
* Total number of participants. Available only when the relevant service
|
|
7
|
-
* doesn't have _variants and options_
|
|
8
|
-
* ([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)).
|
|
9
|
-
* @min 1
|
|
10
|
-
*/
|
|
11
|
-
totalParticipants?: number;
|
|
12
|
-
/**
|
|
13
|
-
* Information about the booked service choices and participants.
|
|
14
|
-
* Available only when the booking includes multiple _service variants_
|
|
15
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
16
|
-
*/
|
|
17
|
-
participantsChoices?: ParticipantChoices;
|
|
18
|
-
/**
|
|
19
|
-
* Booking ID.
|
|
20
|
-
* @format GUID
|
|
21
|
-
* @readonly
|
|
22
|
-
*/
|
|
23
|
-
id?: string | null;
|
|
24
|
-
/**
|
|
25
|
-
* An object describing the *slot*
|
|
26
|
-
* ([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))
|
|
27
|
-
* or *schedule*
|
|
28
|
-
* ([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))
|
|
29
|
-
* that was booked.
|
|
30
|
-
*/
|
|
31
|
-
bookedEntity?: BookedEntity;
|
|
32
|
-
/**
|
|
33
|
-
* Contact details of the site visitor or *member*
|
|
34
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction))
|
|
35
|
-
* making the booking.
|
|
36
|
-
*/
|
|
37
|
-
contactDetails?: ContactDetails;
|
|
38
|
-
/** Additional custom fields submitted with the booking form. */
|
|
39
|
-
additionalFields?: CustomFormField[];
|
|
40
|
-
/**
|
|
41
|
-
* Booking status. A booking is automatically confirmed if the service allows it
|
|
42
|
-
* and an eCommerce order is created. It is automatically declined if there is a
|
|
43
|
-
* double booking and the customer hasn't paid or is eligible for an automatic
|
|
44
|
-
* refund. Currently, only payments with pricing plans are automatically refundable.
|
|
45
|
-
*/
|
|
46
|
-
status?: BookingStatus;
|
|
47
|
-
/**
|
|
48
|
-
* The payment status of the booking corresponds to the `paymentStatus` of the
|
|
49
|
-
* related *eCommerce order*
|
|
50
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)| [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)),
|
|
51
|
-
* if one exists. All payment statuses are supported for every booking `status`.
|
|
52
|
-
*/
|
|
53
|
-
paymentStatus?: PaymentStatus;
|
|
54
|
-
/**
|
|
55
|
-
* Payment option selected by the customer. If the customer hasn't completed their
|
|
56
|
-
* checkout, they may still change the payment method. Must be one of the payment
|
|
57
|
-
* options offered by the service ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)),
|
|
58
|
-
* unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
59
|
-
* When undefined during an *eCommerce checkout*
|
|
60
|
-
* ([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)),
|
|
61
|
-
* Wix Bookings uses the service's default payment option
|
|
62
|
-
*/
|
|
63
|
-
selectedPaymentOption?: SelectedPaymentOption;
|
|
64
|
-
/**
|
|
65
|
-
* Date and time the booking was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
66
|
-
* @readonly
|
|
67
|
-
*/
|
|
68
|
-
createdDate?: Date | null;
|
|
69
|
-
/** External user ID that you can provide. */
|
|
70
|
-
externalUserId?: string | null;
|
|
71
|
-
/**
|
|
72
|
-
* Revision number to be used when updating, rescheduling, or cancelling the
|
|
73
|
-
* booking. Increments by 1 each time the booking is updated, rescheduled, or
|
|
74
|
-
* canceled. To prevent conflicting changes, the current revision must be
|
|
75
|
-
* specified when updating the booking.
|
|
76
|
-
*/
|
|
77
|
-
revision?: string | null;
|
|
78
|
-
/**
|
|
79
|
-
* ID of the creator of the booking.
|
|
80
|
-
* If `appId` and another ID are present, the other ID takes precedence.
|
|
81
|
-
* @readonly
|
|
82
|
-
*/
|
|
83
|
-
createdBy?: CommonIdentificationData;
|
|
84
|
-
/**
|
|
85
|
-
* The start date of the booking in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
86
|
-
* For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.
|
|
87
|
-
* @readonly
|
|
88
|
-
*/
|
|
89
|
-
startDate?: Date | null;
|
|
90
|
-
/**
|
|
91
|
-
* The end date of the booking in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
92
|
-
* For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.
|
|
93
|
-
* @readonly
|
|
94
|
-
*/
|
|
95
|
-
endDate?: Date | null;
|
|
96
|
-
/**
|
|
97
|
-
* Date and time the booking was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
98
|
-
* @readonly
|
|
99
|
-
*/
|
|
100
|
-
updatedDate?: Date | null;
|
|
101
|
-
/**
|
|
102
|
-
* Custom field data for this object.
|
|
103
|
-
* Extended fields must be configured in the app dashboard before they can be accessed with API calls.
|
|
104
|
-
*/
|
|
105
|
-
extendedFields?: ExtendedFields;
|
|
106
|
-
/**
|
|
107
|
-
* Whether this booking overlaps with another confirmed booking. Returned
|
|
108
|
-
* only if set to `true`.
|
|
109
|
-
* @readonly
|
|
110
|
-
*/
|
|
111
|
-
doubleBooked?: boolean | null;
|
|
112
|
-
}
|
|
113
|
-
/** @oneof */
|
|
114
|
-
interface BookingParticipantsInfoOneOf {
|
|
115
|
-
/**
|
|
116
|
-
* Total number of participants. Available only when the relevant service
|
|
117
|
-
* doesn't have _variants and options_
|
|
118
|
-
* ([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)).
|
|
119
|
-
* @min 1
|
|
120
|
-
*/
|
|
121
|
-
totalParticipants?: number;
|
|
122
|
-
/**
|
|
123
|
-
* Information about the booked service choices and participants.
|
|
124
|
-
* Available only when the booking includes multiple _service variants_
|
|
125
|
-
* ([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)).
|
|
126
|
-
*/
|
|
127
|
-
participantsChoices?: ParticipantChoices;
|
|
128
|
-
}
|
|
129
|
-
/**
|
|
130
|
-
* A multi-service booking is considered available if all individual bookings are available as returned from List Multi Service Availability Time Slots.
|
|
131
|
-
* Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
|
|
132
|
-
* Multi-service booking is available if each of its bookings is available separately.
|
|
133
|
-
* For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
|
|
134
|
-
*/
|
|
135
|
-
declare enum MultiServiceBookingType {
|
|
136
|
-
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
137
|
-
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
138
|
-
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
139
|
-
}
|
|
140
|
-
interface BookedEntity extends BookedEntityItemOneOf {
|
|
141
|
-
/**
|
|
142
|
-
* Booked *slot*
|
|
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)).
|
|
144
|
-
* Available only for appointment-based services and classes.
|
|
145
|
-
* For appointment-based services, a new session is created, while for classes,
|
|
146
|
-
* the booking is automatically linked to the existing session.
|
|
147
|
-
*/
|
|
148
|
-
slot?: BookedSlot;
|
|
149
|
-
/**
|
|
150
|
-
* Booked *schedule*
|
|
151
|
-
* ([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)).
|
|
152
|
-
* Available only for course bookings.
|
|
153
|
-
*/
|
|
154
|
-
schedule?: BookedSchedule;
|
|
155
|
-
/**
|
|
156
|
-
* Session title at the time of booking. If there is no pre-existing session,
|
|
157
|
-
* for example for appointment-based services, `title` is set to the service name.
|
|
158
|
-
* @readonly
|
|
159
|
-
* @maxLength 6000
|
|
160
|
-
*/
|
|
161
|
-
title?: string | null;
|
|
162
|
-
/**
|
|
163
|
-
* List of tags for the booking.
|
|
164
|
-
*
|
|
165
|
-
* - "INDIVIDUAL": For bookings of appointment-based services. Including when the appointment is for a group of participants.
|
|
166
|
-
* - "GROUP": For bookings of individual class sessions.
|
|
167
|
-
* - "COURSE": For course bookings.
|
|
168
|
-
*/
|
|
169
|
-
tags?: string[] | null;
|
|
170
|
-
}
|
|
171
|
-
/** @oneof */
|
|
172
|
-
interface BookedEntityItemOneOf {
|
|
173
|
-
/**
|
|
174
|
-
* Booked *slot*
|
|
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)).
|
|
176
|
-
* Available only for appointment-based services and classes.
|
|
177
|
-
* For appointment-based services, a new session is created, while for classes,
|
|
178
|
-
* the booking is automatically linked to the existing session.
|
|
179
|
-
*/
|
|
180
|
-
slot?: BookedSlot;
|
|
181
|
-
/**
|
|
182
|
-
* Booked *schedule*
|
|
183
|
-
* ([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)).
|
|
184
|
-
* Available only for course bookings.
|
|
185
|
-
*/
|
|
186
|
-
schedule?: BookedSchedule;
|
|
187
|
-
}
|
|
188
|
-
interface BookedSlot {
|
|
189
|
-
/** Session ID. */
|
|
190
|
-
sessionId?: string | null;
|
|
191
|
-
/** Service ID. */
|
|
192
|
-
serviceId?: string;
|
|
193
|
-
/** Schedule ID. */
|
|
194
|
-
scheduleId?: string;
|
|
195
|
-
/**
|
|
196
|
-
* ID of the corresponding *event*
|
|
197
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
|
|
198
|
-
* Available for both appointment and class bookings, not available for course bookings.
|
|
199
|
-
* For appointment-based services, Wix Bookings automatically populates `eventId`
|
|
200
|
-
* when the booking `status` changes to `CONFIRMED`. For class bookings, it's
|
|
201
|
-
* automatically populated upon booking creation.
|
|
202
|
-
* @minLength 36
|
|
203
|
-
* @maxLength 250
|
|
204
|
-
*/
|
|
205
|
-
eventId?: string | null;
|
|
206
|
-
/**
|
|
207
|
-
* The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
208
|
-
* format.
|
|
209
|
-
*/
|
|
210
|
-
startDate?: string | null;
|
|
211
|
-
/**
|
|
212
|
-
* The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
213
|
-
* format.
|
|
214
|
-
*/
|
|
215
|
-
endDate?: string | null;
|
|
216
|
-
/** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
|
|
217
|
-
timezone?: string | null;
|
|
218
|
-
/**
|
|
219
|
-
* Primary *resource*
|
|
220
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
|
|
221
|
-
* for the booking. For example, the *staff member*
|
|
222
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
|
|
223
|
-
* providing the
|
|
224
|
-
* service.
|
|
225
|
-
*/
|
|
226
|
-
resource?: BookedResource;
|
|
227
|
-
/** Location where the session takes place. */
|
|
228
|
-
location?: Location;
|
|
229
|
-
}
|
|
230
|
-
interface BookedResource {
|
|
231
|
-
/**
|
|
232
|
-
* ID of the booking's primary resource.
|
|
233
|
-
* @format GUID
|
|
234
|
-
*/
|
|
235
|
-
id?: string;
|
|
236
|
-
/**
|
|
237
|
-
* Resource's name at the time of booking.
|
|
238
|
-
* @maxLength 40
|
|
239
|
-
*/
|
|
240
|
-
name?: string | null;
|
|
241
|
-
/**
|
|
242
|
-
* Resource's email at the time of booking.
|
|
243
|
-
* @maxLength 500
|
|
244
|
-
*/
|
|
245
|
-
email?: string | null;
|
|
246
|
-
/**
|
|
247
|
-
* ID of the schedule belonging to the booking's primary resource.
|
|
248
|
-
* @format GUID
|
|
249
|
-
*/
|
|
250
|
-
scheduleId?: string | null;
|
|
251
|
-
}
|
|
252
|
-
interface Location {
|
|
253
|
-
/**
|
|
254
|
-
* Business location ID. Available only for locations that are business locations,
|
|
255
|
-
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
256
|
-
* @format GUID
|
|
257
|
-
*/
|
|
258
|
-
id?: string | null;
|
|
259
|
-
/** Location name. */
|
|
260
|
-
name?: string | null;
|
|
261
|
-
/** The full address of this location. */
|
|
262
|
-
formattedAddress?: string | null;
|
|
263
|
-
/**
|
|
264
|
-
* The full translated address of this location.
|
|
265
|
-
* @maxLength 512
|
|
266
|
-
*/
|
|
267
|
-
formattedAddressTranslated?: string | null;
|
|
268
|
-
/**
|
|
269
|
-
* Location type.
|
|
270
|
-
*
|
|
271
|
-
* - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings.
|
|
272
|
-
* - `"OWNER_CUSTOM"`: The address as set when creating the service.
|
|
273
|
-
* - `"CUSTOM"`: The address as set for the individual session.
|
|
274
|
-
*/
|
|
275
|
-
locationType?: LocationType;
|
|
276
|
-
}
|
|
277
|
-
declare enum LocationType {
|
|
278
|
-
UNDEFINED = "UNDEFINED",
|
|
279
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
280
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
281
|
-
CUSTOM = "CUSTOM"
|
|
282
|
-
}
|
|
283
|
-
interface BookedSchedule {
|
|
284
|
-
/**
|
|
285
|
-
* _Schedule ID_
|
|
286
|
-
* ([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)).
|
|
287
|
-
*/
|
|
288
|
-
scheduleId?: string;
|
|
289
|
-
/**
|
|
290
|
-
* Booked service ID.
|
|
291
|
-
* @format GUID
|
|
292
|
-
*/
|
|
293
|
-
serviceId?: string | null;
|
|
294
|
-
/**
|
|
295
|
-
* _Location_
|
|
296
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
297
|
-
* where the schedule's sessions take place.
|
|
298
|
-
* @readonly
|
|
299
|
-
*/
|
|
300
|
-
location?: Location;
|
|
301
|
-
/**
|
|
302
|
-
* Timezone in which the slot or session was shown to the customer when they booked.
|
|
303
|
-
* Also used whenever the customer reviews the booking's timing in the future.
|
|
304
|
-
*/
|
|
305
|
-
timezone?: string | null;
|
|
306
|
-
/**
|
|
307
|
-
* Start time of the first session related to the booking in
|
|
308
|
-
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
309
|
-
* @readonly
|
|
310
|
-
*/
|
|
311
|
-
firstSessionStart?: string | null;
|
|
312
|
-
/**
|
|
313
|
-
* End time of the last session related to the booking in
|
|
314
|
-
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
315
|
-
* @readonly
|
|
316
|
-
*/
|
|
317
|
-
lastSessionEnd?: string | null;
|
|
318
|
-
}
|
|
319
|
-
interface ContactDetails {
|
|
320
|
-
/**
|
|
321
|
-
* Contact ID.
|
|
322
|
-
* @format GUID
|
|
323
|
-
*/
|
|
324
|
-
contactId?: string | null;
|
|
325
|
-
/**
|
|
326
|
-
* Contact's first name. When populated from a standard booking form, this
|
|
327
|
-
* property corresponds to the `name` field.
|
|
328
|
-
*/
|
|
329
|
-
firstName?: string | null;
|
|
330
|
-
/** Contact's last name. */
|
|
331
|
-
lastName?: string | null;
|
|
332
|
-
/**
|
|
333
|
-
* Contact's email. If no [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
334
|
-
* with this email exist, a new contact is created.
|
|
335
|
-
* Used to validate coupon usage limitations per contact. If not specified,
|
|
336
|
-
* the coupon usage limitation will not be enforced. (Coupon usage limitation
|
|
337
|
-
* validation is not supported yet).
|
|
338
|
-
* @format EMAIL
|
|
339
|
-
*/
|
|
340
|
-
email?: string | null;
|
|
341
|
-
/** Contact's phone number. */
|
|
342
|
-
phone?: string | null;
|
|
343
|
-
/** Contact's full address. */
|
|
344
|
-
fullAddress?: Address;
|
|
345
|
-
/**
|
|
346
|
-
* Contact's time zone.
|
|
347
|
-
* @deprecated
|
|
348
|
-
*/
|
|
349
|
-
timeZone?: string | null;
|
|
350
|
-
/**
|
|
351
|
-
* Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
352
|
-
* format.
|
|
353
|
-
* @format COUNTRY
|
|
354
|
-
*/
|
|
355
|
-
countryCode?: string | null;
|
|
356
|
-
}
|
|
357
|
-
/** Physical address */
|
|
358
|
-
interface Address extends AddressStreetOneOf {
|
|
359
|
-
/** Street name, number and apartment number. */
|
|
360
|
-
streetAddress?: StreetAddress;
|
|
361
|
-
/** Main address line, usually street and number, as free text. */
|
|
362
|
-
addressLine?: string | null;
|
|
363
|
-
/**
|
|
364
|
-
* Country code.
|
|
365
|
-
* @format COUNTRY
|
|
366
|
-
*/
|
|
367
|
-
country?: string | null;
|
|
368
|
-
/** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
369
|
-
subdivision?: string | null;
|
|
370
|
-
/** City name. */
|
|
371
|
-
city?: string | null;
|
|
372
|
-
/** Zip/postal code. */
|
|
373
|
-
postalCode?: string | null;
|
|
374
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
375
|
-
addressLine2?: string | null;
|
|
376
|
-
/** A string containing the full address of this location. */
|
|
377
|
-
formattedAddress?: string | null;
|
|
378
|
-
/** Free text to help find the address. */
|
|
379
|
-
hint?: string | null;
|
|
380
|
-
/** Coordinates of the physical address. */
|
|
381
|
-
geocode?: AddressLocation;
|
|
382
|
-
/** Country full name. */
|
|
383
|
-
countryFullname?: string | null;
|
|
384
|
-
/** Multi-level subdivisions from top to bottom. */
|
|
385
|
-
subdivisions?: Subdivision[];
|
|
386
|
-
}
|
|
387
|
-
/** @oneof */
|
|
388
|
-
interface AddressStreetOneOf {
|
|
389
|
-
/** Street name, number and apartment number. */
|
|
390
|
-
streetAddress?: StreetAddress;
|
|
391
|
-
/** Main address line, usually street and number, as free text. */
|
|
392
|
-
addressLine?: string | null;
|
|
393
|
-
}
|
|
394
|
-
interface StreetAddress {
|
|
395
|
-
/** Street number. */
|
|
396
|
-
number?: string;
|
|
397
|
-
/** Street name. */
|
|
398
|
-
name?: string;
|
|
399
|
-
/** Apartment number. */
|
|
400
|
-
apt?: string;
|
|
401
|
-
}
|
|
402
|
-
interface AddressLocation {
|
|
403
|
-
/** Address latitude. */
|
|
404
|
-
latitude?: number | null;
|
|
405
|
-
/** Address longitude. */
|
|
406
|
-
longitude?: number | null;
|
|
407
|
-
}
|
|
408
|
-
interface Subdivision {
|
|
409
|
-
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
410
|
-
code?: string;
|
|
411
|
-
/** Subdivision full name. */
|
|
412
|
-
name?: string;
|
|
413
|
-
}
|
|
414
|
-
interface CustomFormField {
|
|
415
|
-
/**
|
|
416
|
-
* ID of the form field as defined in the form.
|
|
417
|
-
* @format GUID
|
|
418
|
-
*/
|
|
419
|
-
id?: string;
|
|
420
|
-
/** Value that was submitted for this field. */
|
|
421
|
-
value?: string | null;
|
|
422
|
-
/**
|
|
423
|
-
* Form field's label at the time of submission.
|
|
424
|
-
* @readonly
|
|
425
|
-
*/
|
|
426
|
-
label?: string | null;
|
|
427
|
-
valueType?: ValueType;
|
|
428
|
-
}
|
|
429
|
-
declare enum ValueType {
|
|
430
|
-
/** Short text. This is the default value type. */
|
|
431
|
-
SHORT_TEXT = "SHORT_TEXT",
|
|
432
|
-
/** Long text. */
|
|
433
|
-
LONG_TEXT = "LONG_TEXT",
|
|
434
|
-
/** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
|
|
435
|
-
CHECK_BOX = "CHECK_BOX"
|
|
436
|
-
}
|
|
437
|
-
/** Booking status. */
|
|
438
|
-
declare enum BookingStatus {
|
|
439
|
-
/**
|
|
440
|
-
* The booking was created, but the customer hasn't completed the related
|
|
441
|
-
* eCommerce order yet.
|
|
442
|
-
*/
|
|
443
|
-
CREATED = "CREATED",
|
|
444
|
-
/**
|
|
445
|
-
* The merchant has confirmed the booking and it appears in the
|
|
446
|
-
* business calendar. Merchants can set up their *services*
|
|
447
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
|
|
448
|
-
* to automatically confirm all `PENDING` bookings.
|
|
449
|
-
*/
|
|
450
|
-
CONFIRMED = "CONFIRMED",
|
|
451
|
-
/**
|
|
452
|
-
* The customer has canceled the booking. Depending on the relevant service's
|
|
453
|
-
* _policy snapshot_
|
|
454
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction))
|
|
455
|
-
* they may have to pay a _cancellation fee_
|
|
456
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction)).
|
|
457
|
-
*/
|
|
458
|
-
CANCELED = "CANCELED",
|
|
459
|
-
/**
|
|
460
|
-
* The merchant must manually confirm the booking before it appears
|
|
461
|
-
* in the business calendar.
|
|
462
|
-
*/
|
|
463
|
-
PENDING = "PENDING",
|
|
464
|
-
/** The merchant has declined the booking before the customer was charged. */
|
|
465
|
-
DECLINED = "DECLINED",
|
|
466
|
-
/**
|
|
467
|
-
* The booking is on a waitlist.
|
|
468
|
-
* Currently, you can't call Register to Waitlist
|
|
469
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist))
|
|
470
|
-
* for course or appointment bookings, even though this is supported in live sites.
|
|
471
|
-
* You can call Register to Waitlist only for class session bookings.
|
|
472
|
-
*/
|
|
473
|
-
WAITING_LIST = "WAITING_LIST"
|
|
474
|
-
}
|
|
475
|
-
/**
|
|
476
|
-
* Payment status.
|
|
477
|
-
* Automatically updated when using eCommerce checkout APIs.
|
|
478
|
-
*/
|
|
479
|
-
declare enum PaymentStatus {
|
|
480
|
-
/** Undefined payment status. */
|
|
481
|
-
UNDEFINED = "UNDEFINED",
|
|
482
|
-
/** The booking isn't paid. */
|
|
483
|
-
NOT_PAID = "NOT_PAID",
|
|
484
|
-
/** The booking is fully paid. */
|
|
485
|
-
PAID = "PAID",
|
|
486
|
-
/** The booking is partially paid. */
|
|
487
|
-
PARTIALLY_PAID = "PARTIALLY_PAID",
|
|
488
|
-
/** The booking is refunded. */
|
|
489
|
-
REFUNDED = "REFUNDED",
|
|
490
|
-
/** The booking is free of charge. */
|
|
491
|
-
EXEMPT = "EXEMPT"
|
|
492
|
-
}
|
|
493
|
-
/**
|
|
494
|
-
* Selected payment option.
|
|
495
|
-
*
|
|
496
|
-
* One of the payment options offered by the service.
|
|
497
|
-
* This field is set when the user selects an option during booking.
|
|
498
|
-
* If left undefined, the payment option is resolved by the service configuration on checkout.
|
|
499
|
-
*/
|
|
500
|
-
declare enum SelectedPaymentOption {
|
|
501
|
-
/** Undefined payment option. */
|
|
502
|
-
UNDEFINED = "UNDEFINED",
|
|
503
|
-
/** Offline payment. */
|
|
504
|
-
OFFLINE = "OFFLINE",
|
|
505
|
-
/** Online payment. */
|
|
506
|
-
ONLINE = "ONLINE",
|
|
507
|
-
/** Payment using a Wix Pricing Plan. */
|
|
508
|
-
MEMBERSHIP = "MEMBERSHIP",
|
|
509
|
-
/**
|
|
510
|
-
* Customers can pay only in person with a Wix Pricing Plan, while the Wix user
|
|
511
|
-
* must manually redeem the pricing plan in the dashboard.
|
|
512
|
-
*/
|
|
513
|
-
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
514
|
-
}
|
|
515
|
-
interface ParticipantNotification {
|
|
516
|
-
/**
|
|
517
|
-
* Whether to send the message about the changes to the customer.
|
|
518
|
-
*
|
|
519
|
-
* Default: `false`
|
|
520
|
-
*/
|
|
521
|
-
notifyParticipants?: boolean;
|
|
522
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
523
|
-
message?: string | null;
|
|
524
|
-
}
|
|
525
|
-
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
526
|
-
/**
|
|
527
|
-
* ID of a site visitor that has not logged in to the site.
|
|
528
|
-
* @format GUID
|
|
529
|
-
*/
|
|
530
|
-
anonymousVisitorId?: string;
|
|
531
|
-
/**
|
|
532
|
-
* ID of a site visitor that has logged in to the site.
|
|
533
|
-
* @format GUID
|
|
534
|
-
*/
|
|
535
|
-
memberId?: string;
|
|
536
|
-
/**
|
|
537
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
538
|
-
* @format GUID
|
|
539
|
-
*/
|
|
540
|
-
wixUserId?: string;
|
|
541
|
-
/**
|
|
542
|
-
* ID of an app.
|
|
543
|
-
* @format GUID
|
|
544
|
-
*/
|
|
545
|
-
appId?: string;
|
|
546
|
-
/**
|
|
547
|
-
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
548
|
-
* @format GUID
|
|
549
|
-
*/
|
|
550
|
-
contactId?: string | null;
|
|
551
|
-
}
|
|
552
|
-
/** @oneof */
|
|
553
|
-
interface CommonIdentificationDataIdOneOf {
|
|
554
|
-
/**
|
|
555
|
-
* ID of a site visitor that has not logged in to the site.
|
|
556
|
-
* @format GUID
|
|
557
|
-
*/
|
|
558
|
-
anonymousVisitorId?: string;
|
|
559
|
-
/**
|
|
560
|
-
* ID of a site visitor that has logged in to the site.
|
|
561
|
-
* @format GUID
|
|
562
|
-
*/
|
|
563
|
-
memberId?: string;
|
|
564
|
-
/**
|
|
565
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
566
|
-
* @format GUID
|
|
567
|
-
*/
|
|
568
|
-
wixUserId?: string;
|
|
569
|
-
/**
|
|
570
|
-
* ID of an app.
|
|
571
|
-
* @format GUID
|
|
572
|
-
*/
|
|
573
|
-
appId?: string;
|
|
574
|
-
}
|
|
575
|
-
interface ExtendedFields {
|
|
576
|
-
/**
|
|
577
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
578
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
579
|
-
*
|
|
580
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
581
|
-
*
|
|
582
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
583
|
-
*/
|
|
584
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
585
|
-
}
|
|
586
|
-
interface ParticipantChoices {
|
|
587
|
-
/**
|
|
588
|
-
* Information about the booked service choices. Includes the number of participants.
|
|
589
|
-
* @minSize 1
|
|
590
|
-
* @maxSize 20
|
|
591
|
-
*/
|
|
592
|
-
serviceChoices?: ServiceChoices[];
|
|
593
|
-
}
|
|
594
|
-
interface ServiceChoices {
|
|
595
|
-
/**
|
|
596
|
-
* Number of participants for this _variant_
|
|
597
|
-
* ([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)).
|
|
598
|
-
* @min 1
|
|
599
|
-
*/
|
|
600
|
-
numberOfParticipants?: number | null;
|
|
601
|
-
/**
|
|
602
|
-
* Service choices for these participants.
|
|
603
|
-
* @maxSize 5
|
|
604
|
-
*/
|
|
605
|
-
choices?: ServiceChoice[];
|
|
606
|
-
}
|
|
607
|
-
interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
608
|
-
/**
|
|
609
|
-
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
610
|
-
* Choices are specific values for an option the customer can choose to book. For example,
|
|
611
|
-
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
612
|
-
* Each choice may have a different price.
|
|
613
|
-
*/
|
|
614
|
-
custom?: string;
|
|
615
|
-
duration?: Duration;
|
|
616
|
-
/**
|
|
617
|
-
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
618
|
-
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
619
|
-
* for the `ageGroup` option.
|
|
620
|
-
* @format GUID
|
|
621
|
-
*/
|
|
622
|
-
optionId?: string;
|
|
623
|
-
}
|
|
624
|
-
/** @oneof */
|
|
625
|
-
interface ServiceChoiceChoiceOneOf {
|
|
626
|
-
/**
|
|
627
|
-
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
628
|
-
* Choices are specific values for an option the customer can choose to book. For example,
|
|
629
|
-
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
630
|
-
* Each choice may have a different price.
|
|
631
|
-
*/
|
|
632
|
-
custom?: string;
|
|
633
|
-
duration?: Duration;
|
|
634
|
-
}
|
|
635
|
-
interface Duration {
|
|
636
|
-
/**
|
|
637
|
-
* Duration of the service in minutes.
|
|
638
|
-
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
639
|
-
* @min 1
|
|
640
|
-
* @max 44639
|
|
641
|
-
*/
|
|
642
|
-
minutes?: number;
|
|
643
|
-
/**
|
|
644
|
-
* Name of the duration option.
|
|
645
|
-
* Defaults to the formatted duration e.g. "1 hour, 30 minutes".
|
|
646
|
-
* @maxLength 255
|
|
647
|
-
*/
|
|
648
|
-
name?: string | null;
|
|
649
|
-
}
|
|
650
|
-
interface ConfirmOrDeclineBookingRequest {
|
|
651
|
-
/**
|
|
652
|
-
* ID of the booking to confirm or decline.
|
|
653
|
-
* @format GUID
|
|
654
|
-
*/
|
|
655
|
-
bookingId: string;
|
|
656
|
-
/**
|
|
657
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
658
|
-
* not the *eCommerce checkout*
|
|
659
|
-
* ([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)).
|
|
660
|
-
*
|
|
661
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
662
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
663
|
-
*/
|
|
664
|
-
paymentStatus?: PaymentStatus;
|
|
665
|
-
}
|
|
666
|
-
interface ConfirmOrDeclineBookingResponse {
|
|
667
|
-
/** Updated booking. */
|
|
668
|
-
booking?: Booking;
|
|
669
|
-
}
|
|
670
|
-
interface BulkConfirmOrDeclineBookingRequest {
|
|
671
|
-
/**
|
|
672
|
-
* Bookings to confirm or decline.
|
|
673
|
-
* @minSize 1
|
|
674
|
-
* @maxSize 300
|
|
675
|
-
*/
|
|
676
|
-
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
677
|
-
/** Whether to return the confirmed or declined booking objects. */
|
|
678
|
-
returnEntity?: boolean;
|
|
679
|
-
}
|
|
680
|
-
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
681
|
-
/**
|
|
682
|
-
* ID of the booking to confirm or decline.
|
|
683
|
-
* @format GUID
|
|
684
|
-
*/
|
|
685
|
-
bookingId?: string;
|
|
686
|
-
/**
|
|
687
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
688
|
-
* not the *eCommerce checkout*
|
|
689
|
-
* ([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)).
|
|
690
|
-
*
|
|
691
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
692
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
693
|
-
*/
|
|
694
|
-
paymentStatus?: PaymentStatus;
|
|
695
|
-
}
|
|
696
|
-
interface BulkConfirmOrDeclineBookingResponse {
|
|
697
|
-
/** List of confirmed or declined bookings, including metadata. */
|
|
698
|
-
results?: BulkBookingResult[];
|
|
699
|
-
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
700
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
701
|
-
}
|
|
702
|
-
interface BulkBookingResult {
|
|
703
|
-
/**
|
|
704
|
-
* Information about the booking that was created or updated.
|
|
705
|
-
* Including its ID, index in the bulk request and whether it was
|
|
706
|
-
* successfully created or updated.
|
|
707
|
-
*/
|
|
708
|
-
itemMetadata?: ItemMetadata;
|
|
709
|
-
/**
|
|
710
|
-
* Created or updated booking. Available only if you requested
|
|
711
|
-
* to return the booking entity.
|
|
712
|
-
*/
|
|
713
|
-
item?: Booking;
|
|
714
|
-
}
|
|
715
|
-
interface ItemMetadata {
|
|
716
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
717
|
-
id?: string | null;
|
|
718
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
719
|
-
originalIndex?: number;
|
|
720
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
721
|
-
success?: boolean;
|
|
722
|
-
/** Details about the error in case of failure. */
|
|
723
|
-
error?: ApplicationError;
|
|
724
|
-
}
|
|
725
|
-
interface ApplicationError {
|
|
726
|
-
/** Error code. */
|
|
727
|
-
code?: string;
|
|
728
|
-
/** Description of the error. */
|
|
729
|
-
description?: string;
|
|
730
|
-
/** Data related to the error. */
|
|
731
|
-
data?: Record<string, any> | null;
|
|
732
|
-
}
|
|
733
|
-
interface BulkActionMetadata {
|
|
734
|
-
/** Number of items that were successfully processed. */
|
|
735
|
-
totalSuccesses?: number;
|
|
736
|
-
/** Number of items that couldn't be processed. */
|
|
737
|
-
totalFailures?: number;
|
|
738
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
739
|
-
undetailedFailures?: number;
|
|
740
|
-
}
|
|
741
|
-
interface CreateBookingRequest {
|
|
742
|
-
/** The booking to create. */
|
|
743
|
-
booking: Booking;
|
|
744
|
-
/**
|
|
745
|
-
* Information about whether to notify the customer and
|
|
746
|
-
* the message to send.
|
|
747
|
-
*/
|
|
748
|
-
participantNotification?: ParticipantNotification;
|
|
749
|
-
/**
|
|
750
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
751
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
752
|
-
* Default: `true`.
|
|
753
|
-
*/
|
|
754
|
-
sendSmsReminder?: boolean | null;
|
|
755
|
-
/**
|
|
756
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
757
|
-
* For example, whether to check availability when creating a booking.
|
|
758
|
-
*/
|
|
759
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
760
|
-
}
|
|
761
|
-
interface CreateBookingFlowControlSettings {
|
|
762
|
-
/**
|
|
763
|
-
* Whether the availability is checked before creating the booking.
|
|
764
|
-
*
|
|
765
|
-
* When passing `false`, a booking is only created when the slot or schedule is available.
|
|
766
|
-
* Default: `false`.
|
|
767
|
-
*/
|
|
768
|
-
skipAvailabilityValidation?: boolean;
|
|
769
|
-
/**
|
|
770
|
-
* Whether `PENDING` bookings are automatically set to `CONFIRMED` for
|
|
771
|
-
* services that normally require the owner's manual confirmation.
|
|
772
|
-
*
|
|
773
|
-
* Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope
|
|
774
|
-
* when passing `true`.
|
|
775
|
-
* Default: `false`.
|
|
776
|
-
*/
|
|
777
|
-
skipBusinessConfirmation?: boolean;
|
|
778
|
-
/**
|
|
779
|
-
* Whether customers can pay using a payment method that isn't supported
|
|
780
|
-
* for the service, but that's supported for other services.
|
|
781
|
-
*
|
|
782
|
-
* Your app must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing
|
|
783
|
-
* `true`.
|
|
784
|
-
* Default: `false`.
|
|
785
|
-
*/
|
|
786
|
-
skipSelectedPaymentOptionValidation?: boolean;
|
|
787
|
-
}
|
|
788
|
-
interface CreateBookingResponse {
|
|
789
|
-
/** Created booking. */
|
|
790
|
-
booking?: Booking;
|
|
791
|
-
}
|
|
792
|
-
interface BulkCreateBookingRequest {
|
|
793
|
-
/**
|
|
794
|
-
* Bookings to create.
|
|
795
|
-
*
|
|
796
|
-
* Max: 8 bookings
|
|
797
|
-
* @minSize 1
|
|
798
|
-
* @maxSize 8
|
|
799
|
-
*/
|
|
800
|
-
createBookingsInfo: CreateBookingInfo[];
|
|
801
|
-
/** Whether to return the created bookings. */
|
|
802
|
-
returnFullEntity?: boolean;
|
|
803
|
-
}
|
|
804
|
-
interface CreateBookingInfo {
|
|
805
|
-
/** Booking to create. */
|
|
806
|
-
booking?: Booking;
|
|
807
|
-
/**
|
|
808
|
-
* Information about whether to notify the customer and
|
|
809
|
-
* the message to send.
|
|
810
|
-
*/
|
|
811
|
-
participantNotification?: ParticipantNotification;
|
|
812
|
-
/**
|
|
813
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
814
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
815
|
-
* Default: `true`.
|
|
816
|
-
*/
|
|
817
|
-
sendSmsReminder?: boolean | null;
|
|
818
|
-
/**
|
|
819
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
820
|
-
* For example, whether to check availability when creating a booking.
|
|
821
|
-
*/
|
|
822
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
823
|
-
}
|
|
824
|
-
interface BulkCreateBookingResponse {
|
|
825
|
-
/** List of individual Bulk Create Bookings results. */
|
|
826
|
-
results?: BulkBookingResult[];
|
|
827
|
-
/** Total number of successes and failures for Bulk Create Bookings. */
|
|
828
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
829
|
-
}
|
|
830
|
-
interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsInfoOneOf {
|
|
831
|
-
/**
|
|
832
|
-
* Total number of participants. Specify when all participants have booked the
|
|
833
|
-
* same service variant.
|
|
834
|
-
*/
|
|
835
|
-
totalParticipants?: number;
|
|
836
|
-
/**
|
|
837
|
-
* Information about the service choices to book. Specify when not all
|
|
838
|
-
* participants have booked the same service variant.
|
|
839
|
-
*/
|
|
840
|
-
participantsChoices?: ParticipantChoices;
|
|
841
|
-
/**
|
|
842
|
-
* ID of the booking to reschedule.
|
|
843
|
-
* @format GUID
|
|
844
|
-
*/
|
|
845
|
-
bookingId: string;
|
|
846
|
-
/** New slot of the booking. */
|
|
847
|
-
slot: V2Slot;
|
|
848
|
-
/**
|
|
849
|
-
* Revision number, which increments by 1 each time the booking is rescheduled.
|
|
850
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
851
|
-
* rescheduling the booking.
|
|
852
|
-
*/
|
|
853
|
-
revision: string | null;
|
|
854
|
-
/**
|
|
855
|
-
* Information about whether to notify the customer about the rescheduling and
|
|
856
|
-
* the message to send.
|
|
857
|
-
*/
|
|
858
|
-
participantNotification?: ParticipantNotification;
|
|
859
|
-
/**
|
|
860
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
861
|
-
* For example, whether to check availability when rescheduling a booking.
|
|
862
|
-
*/
|
|
863
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
864
|
-
}
|
|
865
|
-
/** @oneof */
|
|
866
|
-
interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
867
|
-
/**
|
|
868
|
-
* Total number of participants. Specify when all participants have booked the
|
|
869
|
-
* same service variant.
|
|
870
|
-
*/
|
|
871
|
-
totalParticipants?: number;
|
|
872
|
-
/**
|
|
873
|
-
* Information about the service choices to book. Specify when not all
|
|
874
|
-
* participants have booked the same service variant.
|
|
875
|
-
*/
|
|
876
|
-
participantsChoices?: ParticipantChoices;
|
|
877
|
-
}
|
|
878
|
-
interface V2Slot {
|
|
879
|
-
/** Identifier for the underlying session when the session is a single session or generated from a recurring session. */
|
|
880
|
-
sessionId?: string | null;
|
|
881
|
-
/** Service identifier. Required. */
|
|
882
|
-
serviceId?: string;
|
|
883
|
-
/** Schedule identifier. Required. */
|
|
884
|
-
scheduleId?: string;
|
|
885
|
-
/** The start time of this slot (formatted according to RFC3339). */
|
|
886
|
-
startDate?: string | null;
|
|
887
|
-
/** The end time of this slot (formatted according to RFC3339). */
|
|
888
|
-
endDate?: string | null;
|
|
889
|
-
/** The timezone according to which the slot is calculated and presented. */
|
|
890
|
-
timezone?: string | null;
|
|
891
|
-
/**
|
|
892
|
-
* The resource required for this slot.
|
|
893
|
-
* When populated, the specified resource will be assigned to the slot upon confirmation according to its availability.
|
|
894
|
-
* When empty, if `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation.
|
|
895
|
-
* Otherwise, one of the service resources will be assigned to the slot randomly upon confirmation.
|
|
896
|
-
*/
|
|
897
|
-
resource?: SlotSlotResource;
|
|
898
|
-
/** Geographic location of the slot. */
|
|
899
|
-
location?: SlotLocation;
|
|
900
|
-
/**
|
|
901
|
-
* Calendar event ID - not supported.
|
|
902
|
-
* If not empty, on all write flows (create/update), it takes priority over `sessionId`.
|
|
903
|
-
* So if both `sessionId` and `eventId` are provided, the `sessionId` will be based on the `eventId`.
|
|
904
|
-
* Otherwise, if `eventId` is empty on write flow,
|
|
905
|
-
* @minLength 36
|
|
906
|
-
* @maxLength 250
|
|
907
|
-
*/
|
|
908
|
-
eventId?: string | null;
|
|
909
|
-
}
|
|
910
|
-
declare enum LocationLocationType {
|
|
911
|
-
/** Undefined location type. */
|
|
912
|
-
UNDEFINED = "UNDEFINED",
|
|
913
|
-
/** The business address as set in the site’s general settings. */
|
|
914
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
915
|
-
/** The address set when creating the service. */
|
|
916
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
917
|
-
/** The address set for the individual session. */
|
|
918
|
-
CUSTOM = "CUSTOM"
|
|
919
|
-
}
|
|
920
|
-
interface SlotSlotResource {
|
|
921
|
-
/**
|
|
922
|
-
* Resource ID.
|
|
923
|
-
* @format GUID
|
|
924
|
-
* @readonly
|
|
925
|
-
*/
|
|
926
|
-
id?: string | null;
|
|
927
|
-
/**
|
|
928
|
-
* Resource name.
|
|
929
|
-
* @maxLength 1200
|
|
930
|
-
*/
|
|
931
|
-
name?: string | null;
|
|
932
|
-
}
|
|
933
|
-
interface SlotLocation {
|
|
934
|
-
/**
|
|
935
|
-
* Business Location ID. Present if the location is a business location.
|
|
936
|
-
* @format GUID
|
|
937
|
-
*/
|
|
938
|
-
id?: string | null;
|
|
939
|
-
/** Location name. */
|
|
940
|
-
name?: string | null;
|
|
941
|
-
/** A string containing the full address of this location. */
|
|
942
|
-
formattedAddress?: string | null;
|
|
943
|
-
/** Location type. */
|
|
944
|
-
locationType?: LocationLocationType;
|
|
945
|
-
}
|
|
946
|
-
interface RescheduleBookingFlowControlSettings {
|
|
947
|
-
/**
|
|
948
|
-
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
949
|
-
*
|
|
950
|
-
* When passing `false`, you can only cancel a booking if the rescheduling
|
|
951
|
-
* policy allows it.
|
|
952
|
-
* Default: `false`.
|
|
953
|
-
*/
|
|
954
|
-
ignoreReschedulePolicy?: boolean;
|
|
955
|
-
/**
|
|
956
|
-
* Whether the availability is checked before rescheduling the booking.
|
|
957
|
-
*
|
|
958
|
-
* When passing `false`, a booking is only created when the slot or
|
|
959
|
-
* schedule is available.
|
|
960
|
-
* Default: `false`.
|
|
961
|
-
*/
|
|
962
|
-
skipAvailabilityValidation?: boolean;
|
|
963
|
-
/**
|
|
964
|
-
* Whether the rescheduled booking's status is automatically set to
|
|
965
|
-
* `CONFIRMED` for services that normally require the owner's manual
|
|
966
|
-
* confirmation.
|
|
967
|
-
* Default: `false`.
|
|
968
|
-
*/
|
|
969
|
-
skipBusinessConfirmation?: boolean;
|
|
970
|
-
}
|
|
971
|
-
interface RescheduleBookingResponse {
|
|
972
|
-
/** Rescheduled booking. */
|
|
973
|
-
booking?: Booking;
|
|
974
|
-
}
|
|
975
|
-
interface ConfirmBookingRequest {
|
|
976
|
-
/**
|
|
977
|
-
* ID of the booking to confirm.
|
|
978
|
-
* @format GUID
|
|
979
|
-
*/
|
|
980
|
-
bookingId: string;
|
|
981
|
-
/**
|
|
982
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
983
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
984
|
-
* updating the booking.
|
|
985
|
-
*/
|
|
986
|
-
revision: string | null;
|
|
987
|
-
/**
|
|
988
|
-
* Information about whether to notify the customer about the confirmation and
|
|
989
|
-
* the message to send.
|
|
990
|
-
*/
|
|
991
|
-
participantNotification?: ParticipantNotification;
|
|
992
|
-
/**
|
|
993
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
994
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
995
|
-
*/
|
|
996
|
-
sendSmsReminder?: boolean | null;
|
|
997
|
-
/** Payment status to set for the booking. */
|
|
998
|
-
paymentStatus?: PaymentStatus;
|
|
999
|
-
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1000
|
-
doubleBooked?: boolean | null;
|
|
1001
|
-
/**
|
|
1002
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
1003
|
-
* For example, whether to check availability when confirming a booking.
|
|
1004
|
-
*/
|
|
1005
|
-
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
1006
|
-
}
|
|
1007
|
-
interface ConfirmBookingFlowControlSettings {
|
|
1008
|
-
/**
|
|
1009
|
-
* Whether the availability is checked before confirming the booking.
|
|
1010
|
-
*
|
|
1011
|
-
* When specifying `false`, a booking is only updated with status `CONFIRMED`.
|
|
1012
|
-
* Default: `false`.
|
|
1013
|
-
*/
|
|
1014
|
-
checkAvailabilityValidation?: boolean;
|
|
1015
|
-
}
|
|
1016
|
-
interface ConfirmBookingResponse {
|
|
1017
|
-
/** Confirmed booking. */
|
|
1018
|
-
booking?: Booking;
|
|
1019
|
-
}
|
|
1020
|
-
interface UpdateExtendedFieldsRequest {
|
|
1021
|
-
/** ID of the entity to update. */
|
|
1022
|
-
id: string;
|
|
1023
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
1024
|
-
namespace: string;
|
|
1025
|
-
/** 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. */
|
|
1026
|
-
namespaceData: Record<string, any> | null;
|
|
1027
|
-
}
|
|
1028
|
-
interface UpdateExtendedFieldsResponse {
|
|
1029
|
-
/**
|
|
1030
|
-
* Updated namespace.
|
|
1031
|
-
* @maxLength 164
|
|
1032
|
-
*/
|
|
1033
|
-
namespace?: string;
|
|
1034
|
-
/** Updated data. */
|
|
1035
|
-
namespaceData?: Record<string, any> | null;
|
|
1036
|
-
}
|
|
1037
|
-
interface DeclineBookingRequest {
|
|
1038
|
-
/**
|
|
1039
|
-
* ID of the booking to decline.
|
|
1040
|
-
* @format GUID
|
|
1041
|
-
*/
|
|
1042
|
-
bookingId: string;
|
|
1043
|
-
/**
|
|
1044
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1045
|
-
*
|
|
1046
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1047
|
-
* declining the booking.
|
|
1048
|
-
* @min 1
|
|
1049
|
-
*/
|
|
1050
|
-
revision: string | null;
|
|
1051
|
-
/**
|
|
1052
|
-
* Information about whether to notify the customer and
|
|
1053
|
-
* the message to send.
|
|
1054
|
-
*/
|
|
1055
|
-
participantNotification?: ParticipantNotification;
|
|
1056
|
-
/** Payment status to set for the booking. */
|
|
1057
|
-
paymentStatus?: PaymentStatus;
|
|
1058
|
-
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1059
|
-
doubleBooked?: boolean | null;
|
|
1060
|
-
/**
|
|
1061
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
1062
|
-
* For example, whether to refund a declined booking.
|
|
1063
|
-
*/
|
|
1064
|
-
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
1065
|
-
}
|
|
1066
|
-
interface DeclineBookingFlowControlSettings {
|
|
1067
|
-
/**
|
|
1068
|
-
* Whether to issue a refund when declining the booking.
|
|
1069
|
-
*
|
|
1070
|
-
* The refund will be issued only if the booking is refundable.
|
|
1071
|
-
* Currently, a booking is considered refundable when it was paid by membership.
|
|
1072
|
-
* If specifying `true`, the booking flow control settings will be set with a refund.
|
|
1073
|
-
* If you specify `false` or an empty field,
|
|
1074
|
-
* the booking flow control settings are set without refund.
|
|
1075
|
-
*
|
|
1076
|
-
* Default: `false`.
|
|
1077
|
-
*/
|
|
1078
|
-
withRefund?: boolean | null;
|
|
1079
|
-
}
|
|
1080
|
-
interface DeclineBookingResponse {
|
|
1081
|
-
/** Declined booking. */
|
|
1082
|
-
booking?: Booking;
|
|
1083
|
-
}
|
|
1084
|
-
interface CancelBookingRequest {
|
|
1085
|
-
/**
|
|
1086
|
-
* ID of the booking to cancel.
|
|
1087
|
-
* @format GUID
|
|
1088
|
-
*/
|
|
1089
|
-
bookingId: string;
|
|
1090
|
-
/**
|
|
1091
|
-
* Information about whether to notify the customer about the cancellation and
|
|
1092
|
-
* the message to send.
|
|
1093
|
-
*/
|
|
1094
|
-
participantNotification?: ParticipantNotification;
|
|
1095
|
-
/**
|
|
1096
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
1097
|
-
* For example, whether to allow a cancellation even though the service's
|
|
1098
|
-
* policy doesn't allow it.
|
|
1099
|
-
*/
|
|
1100
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1101
|
-
/**
|
|
1102
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1103
|
-
*
|
|
1104
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1105
|
-
* managing the booking.
|
|
1106
|
-
*/
|
|
1107
|
-
revision: string | null;
|
|
1108
|
-
}
|
|
1109
|
-
interface CancelBookingFlowControlSettings {
|
|
1110
|
-
/**
|
|
1111
|
-
* Whether the cancellation policy applies when canceling the booking.
|
|
1112
|
-
*
|
|
1113
|
-
* When passing `false`, you can only cancel a booking if the cancellation policy allows it.
|
|
1114
|
-
* Default: `false`.
|
|
1115
|
-
*/
|
|
1116
|
-
ignoreCancellationPolicy?: boolean | null;
|
|
1117
|
-
/**
|
|
1118
|
-
* Whether to issue a refund when canceling the booking.
|
|
1119
|
-
*
|
|
1120
|
-
* The refund will be issued only if the booking is refundable.
|
|
1121
|
-
* Currently, a booking is considered refundable when it was paid by membership.
|
|
1122
|
-
* If you specify `true`, the booking flow control settings is set to include a refund.
|
|
1123
|
-
* If `false` is specified or the field remains empty,
|
|
1124
|
-
* the booking flow control settings are set without refund.
|
|
1125
|
-
*
|
|
1126
|
-
* Default: `false`.
|
|
1127
|
-
*/
|
|
1128
|
-
withRefund?: boolean | null;
|
|
1129
|
-
}
|
|
1130
|
-
interface CancelBookingResponse {
|
|
1131
|
-
/** Canceled booking. */
|
|
1132
|
-
booking?: Booking;
|
|
1133
|
-
}
|
|
1134
|
-
interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1135
|
-
/**
|
|
1136
|
-
* Total number of participants. Specify when all participants have booked the
|
|
1137
|
-
* same service variant.
|
|
1138
|
-
*/
|
|
1139
|
-
totalParticipants?: number;
|
|
1140
|
-
/**
|
|
1141
|
-
* Information about the service choices the participants have booked. Specify
|
|
1142
|
-
* when not all participants have booked the same service variant.
|
|
1143
|
-
*/
|
|
1144
|
-
participantsChoices?: ParticipantChoices;
|
|
1145
|
-
/**
|
|
1146
|
-
* ID of the booking to update the number of participants for.
|
|
1147
|
-
* @format GUID
|
|
1148
|
-
*/
|
|
1149
|
-
bookingId: string;
|
|
1150
|
-
/**
|
|
1151
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1152
|
-
*
|
|
1153
|
-
* To prevent conflicting changes, the current revision must be specified
|
|
1154
|
-
* when updating the booking.
|
|
1155
|
-
*/
|
|
1156
|
-
revision: string | null;
|
|
1157
|
-
}
|
|
1158
|
-
/** @oneof */
|
|
1159
|
-
interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1160
|
-
/**
|
|
1161
|
-
* Total number of participants. Specify when all participants have booked the
|
|
1162
|
-
* same service variant.
|
|
1163
|
-
*/
|
|
1164
|
-
totalParticipants?: number;
|
|
1165
|
-
/**
|
|
1166
|
-
* Information about the service choices the participants have booked. Specify
|
|
1167
|
-
* when not all participants have booked the same service variant.
|
|
1168
|
-
*/
|
|
1169
|
-
participantsChoices?: ParticipantChoices;
|
|
1170
|
-
}
|
|
1171
|
-
interface UpdateNumberOfParticipantsResponse {
|
|
1172
|
-
/** Updated booking. */
|
|
1173
|
-
booking?: Booking;
|
|
1174
|
-
}
|
|
1175
|
-
interface BulkCalculateAllowedActionsResult {
|
|
1176
|
-
/** Metadata for the booking. Including ID, index in the provided sequence, success status, and error. */
|
|
1177
|
-
itemMetadata?: ItemMetadata;
|
|
1178
|
-
/** Booking entity. */
|
|
1179
|
-
item?: AllowedActions;
|
|
1180
|
-
}
|
|
1181
|
-
/** Possible actions allowed for the booking. */
|
|
1182
|
-
interface AllowedActions {
|
|
1183
|
-
/** Whether canceling the booking is allowed. */
|
|
1184
|
-
cancel?: boolean;
|
|
1185
|
-
/** Whether rescheduling the booking is allowed. */
|
|
1186
|
-
reschedule?: boolean;
|
|
1187
|
-
}
|
|
1188
|
-
interface BookingPolicyViolations {
|
|
1189
|
-
/** Booking policy violation: Too early to book this slot. */
|
|
1190
|
-
tooEarlyToBook?: boolean | null;
|
|
1191
|
-
/** Booking policy violation: Too late to book this slot. */
|
|
1192
|
-
tooLateToBook?: boolean | null;
|
|
1193
|
-
/** Booking policy violation: Online booking is disabled for this slot. */
|
|
1194
|
-
bookOnlineDisabled?: boolean | null;
|
|
1195
|
-
}
|
|
1196
|
-
interface BookingPolicySettings {
|
|
1197
|
-
/** Booking policy settings for a given slot or schedule. */
|
|
1198
|
-
maxParticipantsPerBooking?: number | null;
|
|
1199
|
-
}
|
|
1200
|
-
interface MarkBookingAsPendingFlowControlSettings {
|
|
1201
|
-
/**
|
|
1202
|
-
* Whether to check for double bookings before updating the booking as pending.
|
|
1203
|
-
*
|
|
1204
|
-
* When passing `false`, a booking is only updated with status `PENDING`.
|
|
1205
|
-
* Default: `false`.
|
|
1206
|
-
*/
|
|
1207
|
-
checkAvailabilityValidation?: boolean;
|
|
1208
|
-
/**
|
|
1209
|
-
* Whether to validate that the booking to be marked as pending has a `booking.slot.serviceId`
|
|
1210
|
-
* of a pending approval service.
|
|
1211
|
-
*
|
|
1212
|
-
* Default: `false`.
|
|
1213
|
-
*/
|
|
1214
|
-
skipPendingApprovalServiceValidation?: boolean;
|
|
1215
|
-
}
|
|
1216
|
-
interface CreateMultiServiceBookingRequest {
|
|
1217
|
-
/**
|
|
1218
|
-
* Single-service bookings to combine in a multi-service booking.
|
|
1219
|
-
* @minSize 2
|
|
1220
|
-
* @maxSize 8
|
|
1221
|
-
*/
|
|
1222
|
-
bookings: Booking[];
|
|
1223
|
-
/**
|
|
1224
|
-
* Information about whether to notify the customer and
|
|
1225
|
-
* the message to send.
|
|
1226
|
-
*/
|
|
1227
|
-
participantNotification?: ParticipantNotification;
|
|
1228
|
-
/**
|
|
1229
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1230
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1231
|
-
*
|
|
1232
|
-
* Default: `true`
|
|
1233
|
-
*/
|
|
1234
|
-
sendSmsReminder?: boolean | null;
|
|
1235
|
-
/**
|
|
1236
|
-
* Whether to ignore specific standard procedures of the Wix Bookings flow.
|
|
1237
|
-
* For example, whether to check availability before updating the status.
|
|
1238
|
-
*/
|
|
1239
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1240
|
-
/** Whether to return the created single-service bookings. */
|
|
1241
|
-
returnFullEntity?: boolean;
|
|
1242
|
-
/** Multi service booking type. */
|
|
1243
|
-
multiServiceBookingType?: MultiServiceBookingType;
|
|
1244
|
-
}
|
|
1245
|
-
interface CreateMultiServiceBookingResponse {
|
|
1246
|
-
/**
|
|
1247
|
-
* Created multi service booking.
|
|
1248
|
-
* Contains the booking results in the same order as specified in the request.
|
|
1249
|
-
*/
|
|
1250
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1251
|
-
}
|
|
1252
|
-
interface MultiServiceBooking {
|
|
1253
|
-
/**
|
|
1254
|
-
* Multi-service booking ID.
|
|
1255
|
-
* @format GUID
|
|
1256
|
-
*/
|
|
1257
|
-
id?: string | null;
|
|
1258
|
-
/** The created bookings that are part of the multi-service booking. */
|
|
1259
|
-
bookings?: BookingResult[];
|
|
1260
|
-
}
|
|
1261
|
-
interface BookingResult {
|
|
1262
|
-
/**
|
|
1263
|
-
* Booking ID.
|
|
1264
|
-
* @format GUID
|
|
1265
|
-
*/
|
|
1266
|
-
bookingId?: string | null;
|
|
1267
|
-
/** Booking entity. */
|
|
1268
|
-
booking?: Booking;
|
|
1269
|
-
}
|
|
1270
|
-
interface RescheduleMultiServiceBookingRequest {
|
|
1271
|
-
/**
|
|
1272
|
-
* ID of the multi service booking to reschedule.
|
|
1273
|
-
* @format GUID
|
|
1274
|
-
*/
|
|
1275
|
-
multiServiceBookingId: string | null;
|
|
1276
|
-
/** Information about the single-service bookings to reschedule. */
|
|
1277
|
-
rescheduleBookingsInfo: RescheduleBookingInfo[];
|
|
1278
|
-
/**
|
|
1279
|
-
* Information about whether to notify the customer and
|
|
1280
|
-
* the message to send.
|
|
1281
|
-
*/
|
|
1282
|
-
participantNotification?: ParticipantNotification;
|
|
1283
|
-
/**
|
|
1284
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1285
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
1286
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
1287
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
1288
|
-
*/
|
|
1289
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
1290
|
-
/** Whether to return the rescheduled bookings entities. */
|
|
1291
|
-
returnFullEntity?: boolean;
|
|
1292
|
-
}
|
|
1293
|
-
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
1294
|
-
/**
|
|
1295
|
-
* Total number of participants. Available only for services with variants.
|
|
1296
|
-
* Specify when all participants book the same variant.
|
|
1297
|
-
*/
|
|
1298
|
-
totalParticipants?: number;
|
|
1299
|
-
/**
|
|
1300
|
-
* Information about the service choices to book. Available only for services with
|
|
1301
|
-
* variants.
|
|
1302
|
-
* Specify when not all participants book the same variant.
|
|
1303
|
-
*/
|
|
1304
|
-
participantsChoices?: ParticipantChoices;
|
|
1305
|
-
/**
|
|
1306
|
-
* ID of the booking to reschedule.
|
|
1307
|
-
* @format GUID
|
|
1308
|
-
*/
|
|
1309
|
-
bookingId?: string | null;
|
|
1310
|
-
/** Information about the new slot. */
|
|
1311
|
-
slot?: V2Slot;
|
|
1312
|
-
/**
|
|
1313
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1314
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1315
|
-
* managing the booking.
|
|
1316
|
-
*/
|
|
1317
|
-
revision?: string | null;
|
|
1318
|
-
}
|
|
1319
|
-
/** @oneof */
|
|
1320
|
-
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
1321
|
-
/**
|
|
1322
|
-
* Total number of participants. Available only for services with variants.
|
|
1323
|
-
* Specify when all participants book the same variant.
|
|
1324
|
-
*/
|
|
1325
|
-
totalParticipants?: number;
|
|
1326
|
-
/**
|
|
1327
|
-
* Information about the service choices to book. Available only for services with
|
|
1328
|
-
* variants.
|
|
1329
|
-
* Specify when not all participants book the same variant.
|
|
1330
|
-
*/
|
|
1331
|
-
participantsChoices?: ParticipantChoices;
|
|
1332
|
-
}
|
|
1333
|
-
interface RescheduleMultiServiceBookingResponse {
|
|
1334
|
-
/** Rescheduled multi-service booking. */
|
|
1335
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1336
|
-
}
|
|
1337
|
-
interface GetMultiServiceBookingAvailabilityRequest {
|
|
1338
|
-
/**
|
|
1339
|
-
* ID of the multi-service booking to retrieve.
|
|
1340
|
-
* @format GUID
|
|
1341
|
-
*/
|
|
1342
|
-
multiServiceBookingId: string | null;
|
|
1343
|
-
}
|
|
1344
|
-
interface GetMultiServiceBookingAvailabilityResponse {
|
|
1345
|
-
/** Whether all contained single-service bookings are bookable. */
|
|
1346
|
-
bookable?: boolean;
|
|
1347
|
-
/** Total number of spots. */
|
|
1348
|
-
totalCapacity?: number | null;
|
|
1349
|
-
/** Number of open spots. */
|
|
1350
|
-
remainingCapacity?: number | null;
|
|
1351
|
-
/** Indicators for policy violations of the multi service booking. */
|
|
1352
|
-
policyViolations?: BookingPolicyViolations;
|
|
1353
|
-
/** Multi-service booking policy settings. */
|
|
1354
|
-
policySettings?: BookingPolicySettings;
|
|
1355
|
-
/** Info of the bookings this availability was calculated for. */
|
|
1356
|
-
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
1357
|
-
}
|
|
1358
|
-
interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
1359
|
-
/**
|
|
1360
|
-
* Booking ID.
|
|
1361
|
-
* @format GUID
|
|
1362
|
-
*/
|
|
1363
|
-
bookingId?: string | null;
|
|
1364
|
-
}
|
|
1365
|
-
interface CancelMultiServiceBookingRequest {
|
|
1366
|
-
/**
|
|
1367
|
-
* ID of the multi-service booking to cancel.
|
|
1368
|
-
* @format GUID
|
|
1369
|
-
*/
|
|
1370
|
-
multiServiceBookingId: string | null;
|
|
1371
|
-
/**
|
|
1372
|
-
* Information about whether to notify the customer and
|
|
1373
|
-
* the message to send.
|
|
1374
|
-
*/
|
|
1375
|
-
participantNotification?: ParticipantNotification;
|
|
1376
|
-
/**
|
|
1377
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1378
|
-
* cancellation flow are changed. For example, whether you can cancel
|
|
1379
|
-
* a booking even though the cancellation policy doesn't allow it or whether
|
|
1380
|
-
* to issue a refund.
|
|
1381
|
-
*/
|
|
1382
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1383
|
-
/** Whether to return the canceled single-service bookings. */
|
|
1384
|
-
returnFullEntity?: boolean;
|
|
1385
|
-
}
|
|
1386
|
-
interface CancelMultiServiceBookingResponse {
|
|
1387
|
-
/** Canceled multi-service booking. */
|
|
1388
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1389
|
-
}
|
|
1390
|
-
interface MarkMultiServiceBookingAsPendingRequest {
|
|
1391
|
-
/**
|
|
1392
|
-
* ID of the multi-service booking to mark as `PENDING`.
|
|
1393
|
-
* @format GUID
|
|
1394
|
-
*/
|
|
1395
|
-
multiServiceBookingId: string | null;
|
|
1396
|
-
/** Information about the single-service bookings to mark as `PENDING`. */
|
|
1397
|
-
markAsPendingBookingsInfo?: BookingInfo[];
|
|
1398
|
-
/**
|
|
1399
|
-
* Information about whether to notify the customer and
|
|
1400
|
-
* the message to send.
|
|
1401
|
-
*/
|
|
1402
|
-
participantNotification?: ParticipantNotification;
|
|
1403
|
-
/**
|
|
1404
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1405
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1406
|
-
*
|
|
1407
|
-
* Default: `true`
|
|
1408
|
-
*/
|
|
1409
|
-
sendSmsReminder?: boolean | null;
|
|
1410
|
-
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1411
|
-
doubleBooked?: boolean | null;
|
|
1412
|
-
/** Whether to return the single-service bookings that were marked as `PENDING`. */
|
|
1413
|
-
returnFullEntity?: boolean;
|
|
1414
|
-
/**
|
|
1415
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1416
|
-
* creation flow are changed. For example, whether the availability is checked
|
|
1417
|
-
* before updating the booking.
|
|
1418
|
-
*/
|
|
1419
|
-
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
1420
|
-
}
|
|
1421
|
-
interface BookingInfo {
|
|
1422
|
-
/**
|
|
1423
|
-
* ID of the single-service booking.
|
|
1424
|
-
* @format GUID
|
|
1425
|
-
*/
|
|
1426
|
-
bookingId?: string | null;
|
|
1427
|
-
/**
|
|
1428
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1429
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1430
|
-
* managing the booking.
|
|
1431
|
-
*/
|
|
1432
|
-
revision?: string | null;
|
|
1433
|
-
/** Payment status to set for the single-service booking. */
|
|
1434
|
-
paymentStatus?: PaymentStatus;
|
|
1435
|
-
}
|
|
1436
|
-
interface MarkMultiServiceBookingAsPendingResponse {
|
|
1437
|
-
/** Updated multi-service booking. */
|
|
1438
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1439
|
-
}
|
|
1440
|
-
interface ConfirmMultiServiceBookingRequest {
|
|
1441
|
-
/**
|
|
1442
|
-
* ID of the multi-service booking to confirm its related bookings.
|
|
1443
|
-
* @format GUID
|
|
1444
|
-
*/
|
|
1445
|
-
multiServiceBookingId: string | null;
|
|
1446
|
-
/** Information about the single-service bookings to confirm. */
|
|
1447
|
-
confirmBookingsInfo?: BookingInfo[];
|
|
1448
|
-
/**
|
|
1449
|
-
* Information about whether to notify the customer and
|
|
1450
|
-
* the message to send.
|
|
1451
|
-
*/
|
|
1452
|
-
participantNotification?: ParticipantNotification;
|
|
1453
|
-
/**
|
|
1454
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1455
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1456
|
-
*
|
|
1457
|
-
* Default: `true`
|
|
1458
|
-
*/
|
|
1459
|
-
sendSmsReminder?: boolean | null;
|
|
1460
|
-
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1461
|
-
doubleBooked?: boolean | null;
|
|
1462
|
-
/** Whether to return the confirmed single-service bookings. */
|
|
1463
|
-
returnFullEntity?: boolean;
|
|
1464
|
-
/**
|
|
1465
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1466
|
-
* confirmation flow are changed. For example, whether the availability is
|
|
1467
|
-
* checked before confirming the booking.
|
|
1468
|
-
*/
|
|
1469
|
-
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
1470
|
-
}
|
|
1471
|
-
interface ConfirmMultiServiceBookingResponse {
|
|
1472
|
-
/** Confirmed multi service booking. */
|
|
1473
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1474
|
-
}
|
|
1475
|
-
interface DeclineMultiServiceBookingRequest {
|
|
1476
|
-
/**
|
|
1477
|
-
* ID of the multi service booking to decline.
|
|
1478
|
-
* @format GUID
|
|
1479
|
-
*/
|
|
1480
|
-
multiServiceBookingId: string | null;
|
|
1481
|
-
/** Information about the single-service bookings to decline. */
|
|
1482
|
-
declineBookingsInfo?: BookingInfo[];
|
|
1483
|
-
/**
|
|
1484
|
-
* Information about whether to notify the customer and
|
|
1485
|
-
* the message to send.
|
|
1486
|
-
*/
|
|
1487
|
-
participantNotification?: ParticipantNotification;
|
|
1488
|
-
/** Whether this booking has a conflict with at least 1 other confirmed booking. */
|
|
1489
|
-
doubleBooked?: boolean | null;
|
|
1490
|
-
/** Whether to return the declined single-service bookings. */
|
|
1491
|
-
returnFullEntity?: boolean;
|
|
1492
|
-
/**
|
|
1493
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1494
|
-
* declining flow are changed. For example, whether to issue a refund.
|
|
1495
|
-
*/
|
|
1496
|
-
flowControlSettings?: DeclineBookingFlowControlSettings;
|
|
1497
|
-
}
|
|
1498
|
-
interface DeclineMultiServiceBookingResponse {
|
|
1499
|
-
/** Declined multi-service booking. */
|
|
1500
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1501
|
-
}
|
|
1502
|
-
interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
1503
|
-
/**
|
|
1504
|
-
* IDs of the multi-service bookings to retrieve allowed actions for.
|
|
1505
|
-
* @format GUID
|
|
1506
|
-
* @minSize 1
|
|
1507
|
-
* @maxSize 50
|
|
1508
|
-
*/
|
|
1509
|
-
multiServiceBookingIds: string[] | null;
|
|
1510
|
-
}
|
|
1511
|
-
interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
1512
|
-
/**
|
|
1513
|
-
* Information about the multi-service bookings that were retrieved.
|
|
1514
|
-
* Including their ID, index in the bulk request and whether they were
|
|
1515
|
-
* successfully updated.
|
|
1516
|
-
*/
|
|
1517
|
-
results?: BulkCalculateAllowedActionsResult[];
|
|
1518
|
-
/** Total number of successes and failures for Bulk Update Bookings. */
|
|
1519
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1520
|
-
}
|
|
1521
|
-
interface GetMultiServiceBookingRequest {
|
|
1522
|
-
/**
|
|
1523
|
-
* ID of the multi-service booking.
|
|
1524
|
-
* @format GUID
|
|
1525
|
-
*/
|
|
1526
|
-
multiServiceBookingId: string | null;
|
|
1527
|
-
}
|
|
1528
|
-
interface GetMultiServiceBookingResponse {
|
|
1529
|
-
/** Retrieved multi-service booking. */
|
|
1530
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1531
|
-
/** Details about how many single-service bookings belong to the multi-service booking. */
|
|
1532
|
-
metadata?: MultiServiceBookingMetadata;
|
|
1533
|
-
}
|
|
1534
|
-
interface MultiServiceBookingMetadata {
|
|
1535
|
-
/**
|
|
1536
|
-
* Total number of `CONFIRMED` and `PENDING` single-service bookings belonging
|
|
1537
|
-
* to the multi-service booking. The total includes the number of single-service
|
|
1538
|
-
* bookings which couldn't be retrieved due to lack of permissions.
|
|
1539
|
-
*/
|
|
1540
|
-
totalNumberOfScheduledBookings?: number | null;
|
|
1541
|
-
}
|
|
1542
|
-
interface AddBookingsToMultiServiceBookingRequest {
|
|
1543
|
-
/**
|
|
1544
|
-
* ID of the multi-service booking.
|
|
1545
|
-
* @format GUID
|
|
1546
|
-
*/
|
|
1547
|
-
multiServiceBookingId: string | null;
|
|
1548
|
-
/**
|
|
1549
|
-
* List of single-service booking IDs and their revision.
|
|
1550
|
-
* @maxSize 8
|
|
1551
|
-
*/
|
|
1552
|
-
bookings: BookingIdAndRevision[];
|
|
1553
|
-
/** Whether to return the single-service bookings that were added to the multi-service booking. */
|
|
1554
|
-
returnFullEntity?: boolean;
|
|
1555
|
-
}
|
|
1556
|
-
interface BookingIdAndRevision {
|
|
1557
|
-
/**
|
|
1558
|
-
* ID of the booking.
|
|
1559
|
-
* @format GUID
|
|
1560
|
-
*/
|
|
1561
|
-
bookingId?: string | null;
|
|
1562
|
-
/**
|
|
1563
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1564
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
1565
|
-
* managing the booking.
|
|
1566
|
-
*/
|
|
1567
|
-
revision?: string | null;
|
|
1568
|
-
}
|
|
1569
|
-
interface AddBookingsToMultiServiceBookingResponse {
|
|
1570
|
-
/** Single-service bookings that were added to the multi-service booking. */
|
|
1571
|
-
bookings?: BookingResult[];
|
|
1572
|
-
}
|
|
1573
|
-
interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
1574
|
-
/**
|
|
1575
|
-
* ID of the multi-service booking.
|
|
1576
|
-
* @format GUID
|
|
1577
|
-
*/
|
|
1578
|
-
multiServiceBookingId: string | null;
|
|
1579
|
-
/**
|
|
1580
|
-
* List of single-service booking IDs and their revision.
|
|
1581
|
-
* @maxSize 8
|
|
1582
|
-
*/
|
|
1583
|
-
bookings?: BookingIdAndRevision[];
|
|
1584
|
-
/** Whether to return the single-service bookings. */
|
|
1585
|
-
returnFullEntity?: boolean;
|
|
1586
|
-
}
|
|
1587
|
-
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
1588
|
-
/** Single-service bookings that were removed from the multi-service booking. */
|
|
1589
|
-
bookings?: BookingResult[];
|
|
1590
|
-
}
|
|
1591
|
-
|
|
1592
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1593
|
-
getUrl: (context: any) => string;
|
|
1594
|
-
httpMethod: K;
|
|
1595
|
-
path: string;
|
|
1596
|
-
pathParams: M;
|
|
1597
|
-
__requestType: T;
|
|
1598
|
-
__originalRequestType: S;
|
|
1599
|
-
__responseType: Q;
|
|
1600
|
-
__originalResponseType: R;
|
|
1601
|
-
};
|
|
1602
|
-
declare function confirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1603
|
-
bookingId: string;
|
|
1604
|
-
}, ConfirmOrDeclineBookingRequest$1, ConfirmOrDeclineBookingRequest, ConfirmOrDeclineBookingResponse$1, ConfirmOrDeclineBookingResponse>;
|
|
1605
|
-
declare function bulkConfirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {}, BulkConfirmOrDeclineBookingRequest$1, BulkConfirmOrDeclineBookingRequest, BulkConfirmOrDeclineBookingResponse$1, BulkConfirmOrDeclineBookingResponse>;
|
|
1606
|
-
declare function createBooking(): __PublicMethodMetaInfo<'POST', {}, CreateBookingRequest$1, CreateBookingRequest, CreateBookingResponse$1, CreateBookingResponse>;
|
|
1607
|
-
declare function bulkCreateBooking(): __PublicMethodMetaInfo<'POST', {}, BulkCreateBookingRequest$1, BulkCreateBookingRequest, BulkCreateBookingResponse$1, BulkCreateBookingResponse>;
|
|
1608
|
-
declare function rescheduleBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1609
|
-
bookingId: string;
|
|
1610
|
-
}, RescheduleBookingRequest$1, RescheduleBookingRequest, RescheduleBookingResponse$1, RescheduleBookingResponse>;
|
|
1611
|
-
declare function confirmBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1612
|
-
bookingId: string;
|
|
1613
|
-
}, ConfirmBookingRequest$1, ConfirmBookingRequest, ConfirmBookingResponse$1, ConfirmBookingResponse>;
|
|
1614
|
-
declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
1615
|
-
id: string;
|
|
1616
|
-
}, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>;
|
|
1617
|
-
declare function declineBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1618
|
-
bookingId: string;
|
|
1619
|
-
}, DeclineBookingRequest$1, DeclineBookingRequest, DeclineBookingResponse$1, DeclineBookingResponse>;
|
|
1620
|
-
declare function cancelBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1621
|
-
bookingId: string;
|
|
1622
|
-
}, CancelBookingRequest$1, CancelBookingRequest, CancelBookingResponse$1, CancelBookingResponse>;
|
|
1623
|
-
declare function updateNumberOfParticipants(): __PublicMethodMetaInfo<'POST', {
|
|
1624
|
-
bookingId: string;
|
|
1625
|
-
}, UpdateNumberOfParticipantsRequest$1, UpdateNumberOfParticipantsRequest, UpdateNumberOfParticipantsResponse$1, UpdateNumberOfParticipantsResponse>;
|
|
1626
|
-
declare function createMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, CreateMultiServiceBookingRequest$1, CreateMultiServiceBookingRequest, CreateMultiServiceBookingResponse$1, CreateMultiServiceBookingResponse>;
|
|
1627
|
-
declare function rescheduleMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1628
|
-
multiServiceBookingId: string;
|
|
1629
|
-
}, RescheduleMultiServiceBookingRequest$1, RescheduleMultiServiceBookingRequest, RescheduleMultiServiceBookingResponse$1, RescheduleMultiServiceBookingResponse>;
|
|
1630
|
-
declare function getMultiServiceBookingAvailability(): __PublicMethodMetaInfo<'POST', {
|
|
1631
|
-
multiServiceBookingId: string;
|
|
1632
|
-
}, GetMultiServiceBookingAvailabilityRequest$1, GetMultiServiceBookingAvailabilityRequest, GetMultiServiceBookingAvailabilityResponse$1, GetMultiServiceBookingAvailabilityResponse>;
|
|
1633
|
-
declare function cancelMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1634
|
-
multiServiceBookingId: string;
|
|
1635
|
-
}, CancelMultiServiceBookingRequest$1, CancelMultiServiceBookingRequest, CancelMultiServiceBookingResponse$1, CancelMultiServiceBookingResponse>;
|
|
1636
|
-
declare function markMultiServiceBookingAsPending(): __PublicMethodMetaInfo<'POST', {
|
|
1637
|
-
multiServiceBookingId: string;
|
|
1638
|
-
}, MarkMultiServiceBookingAsPendingRequest$1, MarkMultiServiceBookingAsPendingRequest, MarkMultiServiceBookingAsPendingResponse$1, MarkMultiServiceBookingAsPendingResponse>;
|
|
1639
|
-
declare function confirmMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1640
|
-
multiServiceBookingId: string;
|
|
1641
|
-
}, ConfirmMultiServiceBookingRequest$1, ConfirmMultiServiceBookingRequest, ConfirmMultiServiceBookingResponse$1, ConfirmMultiServiceBookingResponse>;
|
|
1642
|
-
declare function declineMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {
|
|
1643
|
-
multiServiceBookingId: string;
|
|
1644
|
-
}, DeclineMultiServiceBookingRequest$1, DeclineMultiServiceBookingRequest, DeclineMultiServiceBookingResponse$1, DeclineMultiServiceBookingResponse>;
|
|
1645
|
-
declare function bulkGetMultiServiceBookingAllowedActions(): __PublicMethodMetaInfo<'POST', {}, BulkGetMultiServiceBookingAllowedActionsRequest$1, BulkGetMultiServiceBookingAllowedActionsRequest, BulkGetMultiServiceBookingAllowedActionsResponse$1, BulkGetMultiServiceBookingAllowedActionsResponse>;
|
|
1646
|
-
declare function getMultiServiceBooking(): __PublicMethodMetaInfo<'GET', {
|
|
1647
|
-
multiServiceBookingId: string;
|
|
1648
|
-
}, GetMultiServiceBookingRequest$1, GetMultiServiceBookingRequest, GetMultiServiceBookingResponse$1, GetMultiServiceBookingResponse>;
|
|
1649
|
-
declare function addBookingsToMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, AddBookingsToMultiServiceBookingRequest$1, AddBookingsToMultiServiceBookingRequest, AddBookingsToMultiServiceBookingResponse$1, AddBookingsToMultiServiceBookingResponse>;
|
|
1650
|
-
declare function removeBookingsFromMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, RemoveBookingsFromMultiServiceBookingRequest$1, RemoveBookingsFromMultiServiceBookingRequest, RemoveBookingsFromMultiServiceBookingResponse$1, RemoveBookingsFromMultiServiceBookingResponse>;
|
|
1651
|
-
|
|
1652
|
-
export { type __PublicMethodMetaInfo, addBookingsToMultiServiceBooking, bulkConfirmOrDeclineBooking, bulkCreateBooking, bulkGetMultiServiceBookingAllowedActions, cancelBooking, cancelMultiServiceBooking, confirmBooking, confirmMultiServiceBooking, confirmOrDeclineBooking, createBooking, createMultiServiceBooking, declineBooking, declineMultiServiceBooking, getMultiServiceBooking, getMultiServiceBookingAvailability, markMultiServiceBookingAsPending, removeBookingsFromMultiServiceBooking, rescheduleBooking, rescheduleMultiServiceBooking, updateExtendedFields, updateNumberOfParticipants };
|