@wix/auto_sdk_bookings_extended-bookings 1.0.21 → 1.0.23
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/bookings-reader-v2-extended-booking-extended-bookings.universal-CnngrgaY.d.mts +1189 -0
- package/build/bookings-reader-v2-extended-booking-extended-bookings.universal-CnngrgaY.d.ts +1189 -0
- package/build/{internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.d.ts → index.d.mts} +13 -9
- package/build/{cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.d.ts → index.d.ts} +13 -9
- package/build/index.js +430 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +392 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/bookings-reader-v2-extended-booking-extended-bookings.universal-CnngrgaY.d.mts +1189 -0
- package/build/internal/bookings-reader-v2-extended-booking-extended-bookings.universal-CnngrgaY.d.ts +1189 -0
- package/build/{es/src/bookings-reader-v2-extended-booking-extended-bookings.public.d.ts → internal/index.d.mts} +13 -9
- package/build/internal/{es/src/bookings-reader-v2-extended-booking-extended-bookings.public.d.ts → index.d.ts} +13 -9
- package/build/internal/index.js +430 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +392 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts → meta.d.mts} +79 -193
- package/build/{es/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts → internal/meta.d.ts} +79 -193
- package/build/internal/meta.js +248 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +219 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts → meta.d.mts} +79 -193
- package/build/{cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.d.ts → meta.d.ts} +79 -193
- package/build/meta.js +248 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +219 -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-reader-v2-extended-booking-extended-bookings.context.d.ts +0 -7
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.context.js +0 -22
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.context.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.d.ts +0 -78
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.js +0 -237
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.d.ts +0 -15
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js +0 -85
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.js +0 -37
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +0 -156
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +0 -1347
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +0 -422
- package/build/cjs/src/bookings-reader-v2-extended-booking-extended-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-reader-v2-extended-booking-extended-bookings.context.d.ts +0 -7
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.context.js +0 -7
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.context.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.d.ts +0 -78
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.js +0 -231
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.d.ts +0 -15
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js +0 -56
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.public.js +0 -19
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.public.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +0 -153
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +0 -1347
- package/build/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +0 -393
- package/build/es/src/bookings-reader-v2-extended-booking-extended-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-reader-v2-extended-booking-extended-bookings.context.d.ts +0 -7
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.context.js +0 -22
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.d.ts +0 -78
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.js +0 -237
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.d.ts +0 -15
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js +0 -85
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.js +0 -37
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +0 -156
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +0 -1347
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +0 -422
- package/build/internal/cjs/src/bookings-reader-v2-extended-booking-extended-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-reader-v2-extended-booking-extended-bookings.context.d.ts +0 -7
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.context.js +0 -7
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.context.js.map +0 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.d.ts +0 -78
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.js +0 -231
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.http.js.map +0 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.d.ts +0 -15
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js +0 -56
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.meta.js.map +0 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.public.js +0 -19
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.public.js.map +0 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js +0 -153
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.types.js.map +0 -1
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.d.ts +0 -1347
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js +0 -393
- package/build/internal/es/src/bookings-reader-v2-extended-booking-extended-bookings.universal.js.map +0 -1
|
@@ -0,0 +1,1189 @@
|
|
|
1
|
+
/** Extended bookings. */
|
|
2
|
+
interface ExtendedBooking {
|
|
3
|
+
/** Booking. */
|
|
4
|
+
booking?: Booking;
|
|
5
|
+
/**
|
|
6
|
+
* Information about the actions the customer can perform for the
|
|
7
|
+
* booking. Available only when you've specified `withBookingAllowedActions` as
|
|
8
|
+
* `true`.
|
|
9
|
+
*/
|
|
10
|
+
allowedActions?: AllowedActions;
|
|
11
|
+
/**
|
|
12
|
+
* Information about the attendance. Available only when passing
|
|
13
|
+
* `withBookingAttendanceInfo` as `true`.
|
|
14
|
+
*/
|
|
15
|
+
attendance?: Attendance;
|
|
16
|
+
/**
|
|
17
|
+
* Information about the online conferencing details. Available only when passing
|
|
18
|
+
* `withBookingConferencingDetails` as `true`.
|
|
19
|
+
*/
|
|
20
|
+
conferencingDetails?: ConferencingDetails;
|
|
21
|
+
/**
|
|
22
|
+
* Information about the booking's policy settings according to the relevant
|
|
23
|
+
* booking policy snapshot.
|
|
24
|
+
*
|
|
25
|
+
* Available only when you've specified `withBookingPolicySettings` as `true`.
|
|
26
|
+
*/
|
|
27
|
+
bookingPolicySettings?: BookingPolicySettings;
|
|
28
|
+
/**
|
|
29
|
+
* Information about booking fee
|
|
30
|
+
* ([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))
|
|
31
|
+
* statuses. Available only if you've specified
|
|
32
|
+
* `withBookingFeeDetails` as `true`.
|
|
33
|
+
*
|
|
34
|
+
* Only details for fees that have already been applied to a booking are
|
|
35
|
+
* returned. No details are provided for the following scenarios:
|
|
36
|
+
* - Hypothetical fees related to a potential future cancellation by the customer.
|
|
37
|
+
* - Scenarios where the booking has been canceled before the start of the earliest cancellation window that includes a penalty.
|
|
38
|
+
*
|
|
39
|
+
* To retrieve hypothetical booking fees, call List Booking Fees By Booking Ids
|
|
40
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/list-booking-fees-by-booking-ids) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/list-booking-fees-by-booking-ids))
|
|
41
|
+
* instead.
|
|
42
|
+
*/
|
|
43
|
+
bookingFeeDetails?: BookingFeeDetails;
|
|
44
|
+
}
|
|
45
|
+
declare enum AttendanceStatus {
|
|
46
|
+
/** There is no available attendance information. */
|
|
47
|
+
NOT_SET = "NOT_SET",
|
|
48
|
+
/** At least a single participant attended the session. */
|
|
49
|
+
ATTENDED = "ATTENDED",
|
|
50
|
+
/** No participants attended the session. */
|
|
51
|
+
NOT_ATTENDED = "NOT_ATTENDED"
|
|
52
|
+
}
|
|
53
|
+
/** @enumType */
|
|
54
|
+
type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_SET' | 'ATTENDED' | 'NOT_ATTENDED';
|
|
55
|
+
/** An entity representing a scheduled appointment, class session, or course. */
|
|
56
|
+
interface Booking extends BookingParticipantsInfoOneOf {
|
|
57
|
+
/**
|
|
58
|
+
* Total number of participants. Available only when the relevant service
|
|
59
|
+
* doesn't have _variants and options_
|
|
60
|
+
* ([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)).
|
|
61
|
+
* @min 1
|
|
62
|
+
*/
|
|
63
|
+
totalParticipants?: number;
|
|
64
|
+
/**
|
|
65
|
+
* Information about the booked service choices and participants.
|
|
66
|
+
* Available only when the booking includes multiple _service variants_
|
|
67
|
+
* ([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)).
|
|
68
|
+
*/
|
|
69
|
+
participantsChoices?: ParticipantChoices;
|
|
70
|
+
/**
|
|
71
|
+
* Booking ID.
|
|
72
|
+
* @format GUID
|
|
73
|
+
* @readonly
|
|
74
|
+
*/
|
|
75
|
+
_id?: string | null;
|
|
76
|
+
/**
|
|
77
|
+
* An object describing the *slot*
|
|
78
|
+
* ([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))
|
|
79
|
+
* or *schedule*
|
|
80
|
+
* ([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))
|
|
81
|
+
* that was booked.
|
|
82
|
+
*/
|
|
83
|
+
bookedEntity?: BookedEntity;
|
|
84
|
+
/**
|
|
85
|
+
* Contact details of the site visitor or *member*
|
|
86
|
+
* ([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))
|
|
87
|
+
* making the booking.
|
|
88
|
+
*/
|
|
89
|
+
contactDetails?: ContactDetails;
|
|
90
|
+
/** Additional custom fields submitted with the booking form. */
|
|
91
|
+
additionalFields?: CustomFormField[];
|
|
92
|
+
/**
|
|
93
|
+
* Booking status. A booking is automatically confirmed if the service allows it
|
|
94
|
+
* and an eCommerce order is created. It is automatically declined if there is a
|
|
95
|
+
* double booking and the customer hasn't paid or is eligible for an automatic
|
|
96
|
+
* refund. Currently, only payments with pricing plans are automatically refundable.
|
|
97
|
+
*/
|
|
98
|
+
status?: BookingStatusWithLiterals;
|
|
99
|
+
/**
|
|
100
|
+
* The payment status of the booking corresponds to the `paymentStatus` of the
|
|
101
|
+
* related *eCommerce order*
|
|
102
|
+
* ([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)),
|
|
103
|
+
* if one exists. All payment statuses are supported for every booking `status`.
|
|
104
|
+
*/
|
|
105
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
106
|
+
/**
|
|
107
|
+
* Payment option selected by the customer. If the customer hasn't completed their
|
|
108
|
+
* checkout, they may still change the payment method. Must be one of the payment
|
|
109
|
+
* 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)),
|
|
110
|
+
* unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
111
|
+
* When undefined during an *eCommerce checkout*
|
|
112
|
+
* ([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)),
|
|
113
|
+
* Wix Bookings uses the service's default payment option
|
|
114
|
+
*/
|
|
115
|
+
selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
|
|
116
|
+
/**
|
|
117
|
+
* Date and time the booking was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
118
|
+
* @readonly
|
|
119
|
+
*/
|
|
120
|
+
_createdDate?: Date | null;
|
|
121
|
+
/** External user ID that you can provide. */
|
|
122
|
+
externalUserId?: string | null;
|
|
123
|
+
/**
|
|
124
|
+
* Revision number to be used when updating, rescheduling, or cancelling the
|
|
125
|
+
* booking. Increments by 1 each time the booking is updated, rescheduled, or
|
|
126
|
+
* canceled. To prevent conflicting changes, the current revision must be
|
|
127
|
+
* specified when updating the booking.
|
|
128
|
+
*/
|
|
129
|
+
revision?: string | null;
|
|
130
|
+
/**
|
|
131
|
+
* ID of the creator of the booking.
|
|
132
|
+
* If `appId` and another ID are present, the other ID takes precedence.
|
|
133
|
+
* @readonly
|
|
134
|
+
*/
|
|
135
|
+
createdBy?: IdentificationData;
|
|
136
|
+
/**
|
|
137
|
+
* The start date of the booking in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
138
|
+
* For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.
|
|
139
|
+
* @readonly
|
|
140
|
+
*/
|
|
141
|
+
startDate?: Date | null;
|
|
142
|
+
/**
|
|
143
|
+
* The end date of the booking in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
144
|
+
* For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.
|
|
145
|
+
* @readonly
|
|
146
|
+
*/
|
|
147
|
+
endDate?: Date | null;
|
|
148
|
+
/**
|
|
149
|
+
* Date and time the booking was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
150
|
+
* @readonly
|
|
151
|
+
*/
|
|
152
|
+
_updatedDate?: Date | null;
|
|
153
|
+
/**
|
|
154
|
+
* Custom field data for this object.
|
|
155
|
+
* Extended fields must be configured in the app dashboard before they can be accessed with API calls.
|
|
156
|
+
*/
|
|
157
|
+
extendedFields?: ExtendedFields;
|
|
158
|
+
/**
|
|
159
|
+
* Whether this booking overlaps with another confirmed booking. Returned
|
|
160
|
+
* only if set to `true`.
|
|
161
|
+
* @readonly
|
|
162
|
+
*/
|
|
163
|
+
doubleBooked?: boolean | null;
|
|
164
|
+
}
|
|
165
|
+
/** @oneof */
|
|
166
|
+
interface BookingParticipantsInfoOneOf {
|
|
167
|
+
/**
|
|
168
|
+
* Total number of participants. Available only when the relevant service
|
|
169
|
+
* doesn't have _variants and options_
|
|
170
|
+
* ([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)).
|
|
171
|
+
* @min 1
|
|
172
|
+
*/
|
|
173
|
+
totalParticipants?: number;
|
|
174
|
+
/**
|
|
175
|
+
* Information about the booked service choices and participants.
|
|
176
|
+
* Available only when the booking includes multiple _service variants_
|
|
177
|
+
* ([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)).
|
|
178
|
+
*/
|
|
179
|
+
participantsChoices?: ParticipantChoices;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* A multi-service booking is considered available if all individual bookings are available as returned from List Multi Service Availability Time Slots.
|
|
183
|
+
* Currently, `SEPARATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
|
|
184
|
+
* Multi-service booking is available if each of its bookings is available separately.
|
|
185
|
+
* For `SEQUENTIAL_BOOKINGS`, see `List Multi Service Availability Time Slots` documentation.
|
|
186
|
+
*/
|
|
187
|
+
declare enum MultiServiceBookingType {
|
|
188
|
+
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
189
|
+
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
190
|
+
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
191
|
+
}
|
|
192
|
+
/** @enumType */
|
|
193
|
+
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
194
|
+
interface BookedEntity extends BookedEntityItemOneOf {
|
|
195
|
+
/**
|
|
196
|
+
* Booked *slot*
|
|
197
|
+
* ([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)).
|
|
198
|
+
* Available only for appointment-based services and classes.
|
|
199
|
+
* For appointment-based services, a new session is created, while for classes,
|
|
200
|
+
* the booking is automatically linked to the existing session.
|
|
201
|
+
*/
|
|
202
|
+
slot?: BookedSlot;
|
|
203
|
+
/**
|
|
204
|
+
* Booked *schedule*
|
|
205
|
+
* ([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)).
|
|
206
|
+
* Available only for course bookings.
|
|
207
|
+
*/
|
|
208
|
+
schedule?: BookedSchedule;
|
|
209
|
+
/**
|
|
210
|
+
* Session title at the time of booking. If there is no pre-existing session,
|
|
211
|
+
* for example for appointment-based services, `title` is set to the service name.
|
|
212
|
+
* @readonly
|
|
213
|
+
* @maxLength 6000
|
|
214
|
+
*/
|
|
215
|
+
title?: string | null;
|
|
216
|
+
/**
|
|
217
|
+
* List of tags for the booking.
|
|
218
|
+
*
|
|
219
|
+
* - "INDIVIDUAL": For bookings of appointment-based services. Including when the appointment is for a group of participants.
|
|
220
|
+
* - "GROUP": For bookings of individual class sessions.
|
|
221
|
+
* - "COURSE": For course bookings.
|
|
222
|
+
*/
|
|
223
|
+
tags?: string[] | null;
|
|
224
|
+
}
|
|
225
|
+
/** @oneof */
|
|
226
|
+
interface BookedEntityItemOneOf {
|
|
227
|
+
/**
|
|
228
|
+
* Booked *slot*
|
|
229
|
+
* ([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)).
|
|
230
|
+
* Available only for appointment-based services and classes.
|
|
231
|
+
* For appointment-based services, a new session is created, while for classes,
|
|
232
|
+
* the booking is automatically linked to the existing session.
|
|
233
|
+
*/
|
|
234
|
+
slot?: BookedSlot;
|
|
235
|
+
/**
|
|
236
|
+
* Booked *schedule*
|
|
237
|
+
* ([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)).
|
|
238
|
+
* Available only for course bookings.
|
|
239
|
+
*/
|
|
240
|
+
schedule?: BookedSchedule;
|
|
241
|
+
}
|
|
242
|
+
interface BookedSlot {
|
|
243
|
+
/** Session ID. */
|
|
244
|
+
sessionId?: string | null;
|
|
245
|
+
/** Service ID. */
|
|
246
|
+
serviceId?: string;
|
|
247
|
+
/** Schedule ID. */
|
|
248
|
+
scheduleId?: string;
|
|
249
|
+
/**
|
|
250
|
+
* ID of the corresponding *event*
|
|
251
|
+
* ([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)).
|
|
252
|
+
* Available for both appointment and class bookings, not available for course bookings.
|
|
253
|
+
* For appointment-based services, Wix Bookings automatically populates `eventId`
|
|
254
|
+
* when the booking `status` changes to `CONFIRMED`. For class bookings, it's
|
|
255
|
+
* automatically populated upon booking creation.
|
|
256
|
+
* @minLength 36
|
|
257
|
+
* @maxLength 250
|
|
258
|
+
*/
|
|
259
|
+
eventId?: string | null;
|
|
260
|
+
/**
|
|
261
|
+
* The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
262
|
+
* format.
|
|
263
|
+
*/
|
|
264
|
+
startDate?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
267
|
+
* format.
|
|
268
|
+
*/
|
|
269
|
+
endDate?: string | null;
|
|
270
|
+
/** The timezone according to which the slot was shown to the user when booking, and should be shown in the future. */
|
|
271
|
+
timezone?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* Primary *resource*
|
|
274
|
+
* ([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))
|
|
275
|
+
* for the booking. For example, the *staff member*
|
|
276
|
+
* ([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))
|
|
277
|
+
* providing the
|
|
278
|
+
* service.
|
|
279
|
+
*/
|
|
280
|
+
resource?: BookedResource;
|
|
281
|
+
/** Location where the session takes place. */
|
|
282
|
+
location?: Location;
|
|
283
|
+
}
|
|
284
|
+
interface BookedResource {
|
|
285
|
+
/**
|
|
286
|
+
* ID of the booking's primary resource.
|
|
287
|
+
* @format GUID
|
|
288
|
+
*/
|
|
289
|
+
_id?: string;
|
|
290
|
+
/**
|
|
291
|
+
* Resource's name at the time of booking.
|
|
292
|
+
* @maxLength 40
|
|
293
|
+
*/
|
|
294
|
+
name?: string | null;
|
|
295
|
+
/**
|
|
296
|
+
* Resource's email at the time of booking.
|
|
297
|
+
* @maxLength 500
|
|
298
|
+
*/
|
|
299
|
+
email?: string | null;
|
|
300
|
+
/**
|
|
301
|
+
* ID of the schedule belonging to the booking's primary resource.
|
|
302
|
+
* @format GUID
|
|
303
|
+
*/
|
|
304
|
+
scheduleId?: string | null;
|
|
305
|
+
}
|
|
306
|
+
interface Location {
|
|
307
|
+
/**
|
|
308
|
+
* Business location ID. Available only for locations that are business locations,
|
|
309
|
+
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
310
|
+
* @format GUID
|
|
311
|
+
*/
|
|
312
|
+
_id?: string | null;
|
|
313
|
+
/** Location name. */
|
|
314
|
+
name?: string | null;
|
|
315
|
+
/** The full address of this location. */
|
|
316
|
+
formattedAddress?: string | null;
|
|
317
|
+
/**
|
|
318
|
+
* The full translated address of this location.
|
|
319
|
+
* @maxLength 512
|
|
320
|
+
*/
|
|
321
|
+
formattedAddressTranslated?: string | null;
|
|
322
|
+
/**
|
|
323
|
+
* Location type.
|
|
324
|
+
*
|
|
325
|
+
* - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings.
|
|
326
|
+
* - `"OWNER_CUSTOM"`: The address as set when creating the service.
|
|
327
|
+
* - `"CUSTOM"`: The address as set for the individual session.
|
|
328
|
+
*/
|
|
329
|
+
locationType?: LocationTypeWithLiterals;
|
|
330
|
+
}
|
|
331
|
+
declare enum LocationType {
|
|
332
|
+
UNDEFINED = "UNDEFINED",
|
|
333
|
+
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
334
|
+
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
335
|
+
CUSTOM = "CUSTOM"
|
|
336
|
+
}
|
|
337
|
+
/** @enumType */
|
|
338
|
+
type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
|
|
339
|
+
interface BookedSchedule {
|
|
340
|
+
/**
|
|
341
|
+
* _Schedule ID_
|
|
342
|
+
* ([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)).
|
|
343
|
+
*/
|
|
344
|
+
scheduleId?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Booked service ID.
|
|
347
|
+
* @format GUID
|
|
348
|
+
*/
|
|
349
|
+
serviceId?: string | null;
|
|
350
|
+
/**
|
|
351
|
+
* _Location_
|
|
352
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
353
|
+
* where the schedule's sessions take place.
|
|
354
|
+
* @readonly
|
|
355
|
+
*/
|
|
356
|
+
location?: Location;
|
|
357
|
+
/**
|
|
358
|
+
* Timezone in which the slot or session was shown to the customer when they booked.
|
|
359
|
+
* Also used whenever the customer reviews the booking's timing in the future.
|
|
360
|
+
*/
|
|
361
|
+
timezone?: string | null;
|
|
362
|
+
/**
|
|
363
|
+
* Start time of the first session related to the booking in
|
|
364
|
+
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
365
|
+
* @readonly
|
|
366
|
+
*/
|
|
367
|
+
firstSessionStart?: string | null;
|
|
368
|
+
/**
|
|
369
|
+
* End time of the last session related to the booking in
|
|
370
|
+
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
371
|
+
* @readonly
|
|
372
|
+
*/
|
|
373
|
+
lastSessionEnd?: string | null;
|
|
374
|
+
}
|
|
375
|
+
interface ContactDetails {
|
|
376
|
+
/**
|
|
377
|
+
* Contact ID.
|
|
378
|
+
* @format GUID
|
|
379
|
+
*/
|
|
380
|
+
contactId?: string | null;
|
|
381
|
+
/**
|
|
382
|
+
* Contact's first name. When populated from a standard booking form, this
|
|
383
|
+
* property corresponds to the `name` field.
|
|
384
|
+
*/
|
|
385
|
+
firstName?: string | null;
|
|
386
|
+
/** Contact's last name. */
|
|
387
|
+
lastName?: string | null;
|
|
388
|
+
/**
|
|
389
|
+
* Contact's email. If no [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
390
|
+
* with this email exist, a new contact is created.
|
|
391
|
+
* Used to validate coupon usage limitations per contact. If not specified,
|
|
392
|
+
* the coupon usage limitation will not be enforced. (Coupon usage limitation
|
|
393
|
+
* validation is not supported yet).
|
|
394
|
+
* @format EMAIL
|
|
395
|
+
*/
|
|
396
|
+
email?: string | null;
|
|
397
|
+
/** Contact's phone number. */
|
|
398
|
+
phone?: string | null;
|
|
399
|
+
/** Contact's full address. */
|
|
400
|
+
fullAddress?: Address;
|
|
401
|
+
/**
|
|
402
|
+
* Contact's time zone.
|
|
403
|
+
* @deprecated
|
|
404
|
+
*/
|
|
405
|
+
timeZone?: string | null;
|
|
406
|
+
/**
|
|
407
|
+
* Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
408
|
+
* format.
|
|
409
|
+
* @format COUNTRY
|
|
410
|
+
*/
|
|
411
|
+
countryCode?: string | null;
|
|
412
|
+
}
|
|
413
|
+
/** Physical address */
|
|
414
|
+
interface Address extends AddressStreetOneOf {
|
|
415
|
+
/** Street name, number and apartment number. */
|
|
416
|
+
streetAddress?: StreetAddress;
|
|
417
|
+
/** Main address line, usually street and number, as free text. */
|
|
418
|
+
addressLine?: string | null;
|
|
419
|
+
/**
|
|
420
|
+
* Country code.
|
|
421
|
+
* @format COUNTRY
|
|
422
|
+
*/
|
|
423
|
+
country?: string | null;
|
|
424
|
+
/** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
425
|
+
subdivision?: string | null;
|
|
426
|
+
/** City name. */
|
|
427
|
+
city?: string | null;
|
|
428
|
+
/** Zip/postal code. */
|
|
429
|
+
postalCode?: string | null;
|
|
430
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
431
|
+
addressLine2?: string | null;
|
|
432
|
+
/** A string containing the full address of this location. */
|
|
433
|
+
formattedAddress?: string | null;
|
|
434
|
+
/** Free text to help find the address. */
|
|
435
|
+
hint?: string | null;
|
|
436
|
+
/** Coordinates of the physical address. */
|
|
437
|
+
geocode?: AddressLocation;
|
|
438
|
+
/** Country full name. */
|
|
439
|
+
countryFullname?: string | null;
|
|
440
|
+
/** Multi-level subdivisions from top to bottom. */
|
|
441
|
+
subdivisions?: Subdivision[];
|
|
442
|
+
}
|
|
443
|
+
/** @oneof */
|
|
444
|
+
interface AddressStreetOneOf {
|
|
445
|
+
/** Street name, number and apartment number. */
|
|
446
|
+
streetAddress?: StreetAddress;
|
|
447
|
+
/** Main address line, usually street and number, as free text. */
|
|
448
|
+
addressLine?: string | null;
|
|
449
|
+
}
|
|
450
|
+
interface StreetAddress {
|
|
451
|
+
/** Street number. */
|
|
452
|
+
number?: string;
|
|
453
|
+
/** Street name. */
|
|
454
|
+
name?: string;
|
|
455
|
+
/** Apartment number. */
|
|
456
|
+
apt?: string;
|
|
457
|
+
}
|
|
458
|
+
interface AddressLocation {
|
|
459
|
+
/** Address latitude. */
|
|
460
|
+
latitude?: number | null;
|
|
461
|
+
/** Address longitude. */
|
|
462
|
+
longitude?: number | null;
|
|
463
|
+
}
|
|
464
|
+
interface Subdivision {
|
|
465
|
+
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
466
|
+
code?: string;
|
|
467
|
+
/** Subdivision full name. */
|
|
468
|
+
name?: string;
|
|
469
|
+
}
|
|
470
|
+
interface CustomFormField {
|
|
471
|
+
/**
|
|
472
|
+
* ID of the form field as defined in the form.
|
|
473
|
+
* @format GUID
|
|
474
|
+
*/
|
|
475
|
+
_id?: string;
|
|
476
|
+
/** Value that was submitted for this field. */
|
|
477
|
+
value?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* Form field's label at the time of submission.
|
|
480
|
+
* @readonly
|
|
481
|
+
*/
|
|
482
|
+
label?: string | null;
|
|
483
|
+
valueType?: ValueTypeWithLiterals;
|
|
484
|
+
}
|
|
485
|
+
declare enum ValueType {
|
|
486
|
+
/** Short text. This is the default value type. */
|
|
487
|
+
SHORT_TEXT = "SHORT_TEXT",
|
|
488
|
+
/** Long text. */
|
|
489
|
+
LONG_TEXT = "LONG_TEXT",
|
|
490
|
+
/** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
|
|
491
|
+
CHECK_BOX = "CHECK_BOX"
|
|
492
|
+
}
|
|
493
|
+
/** @enumType */
|
|
494
|
+
type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX';
|
|
495
|
+
/** Booking status. */
|
|
496
|
+
declare enum BookingStatus {
|
|
497
|
+
/**
|
|
498
|
+
* The booking was created, but the customer hasn't completed the related
|
|
499
|
+
* eCommerce order yet.
|
|
500
|
+
*/
|
|
501
|
+
CREATED = "CREATED",
|
|
502
|
+
/**
|
|
503
|
+
* The merchant has confirmed the booking and it appears in the
|
|
504
|
+
* business calendar. Merchants can set up their *services*
|
|
505
|
+
* ([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))
|
|
506
|
+
* to automatically confirm all `PENDING` bookings.
|
|
507
|
+
*/
|
|
508
|
+
CONFIRMED = "CONFIRMED",
|
|
509
|
+
/**
|
|
510
|
+
* The customer has canceled the booking. Depending on the relevant service's
|
|
511
|
+
* _policy snapshot_
|
|
512
|
+
* ([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))
|
|
513
|
+
* they may have to pay a _cancellation fee_
|
|
514
|
+
* ([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)).
|
|
515
|
+
*/
|
|
516
|
+
CANCELED = "CANCELED",
|
|
517
|
+
/**
|
|
518
|
+
* The merchant must manually confirm the booking before it appears
|
|
519
|
+
* in the business calendar.
|
|
520
|
+
*/
|
|
521
|
+
PENDING = "PENDING",
|
|
522
|
+
/** The merchant has declined the booking before the customer was charged. */
|
|
523
|
+
DECLINED = "DECLINED",
|
|
524
|
+
/**
|
|
525
|
+
* The booking is on a waitlist.
|
|
526
|
+
* Currently, you can't call Register to Waitlist
|
|
527
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist))
|
|
528
|
+
* for course or appointment bookings, even though this is supported in live sites.
|
|
529
|
+
* You can call Register to Waitlist only for class session bookings.
|
|
530
|
+
*/
|
|
531
|
+
WAITING_LIST = "WAITING_LIST"
|
|
532
|
+
}
|
|
533
|
+
/** @enumType */
|
|
534
|
+
type BookingStatusWithLiterals = BookingStatus | 'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PENDING' | 'DECLINED' | 'WAITING_LIST';
|
|
535
|
+
/**
|
|
536
|
+
* Payment status.
|
|
537
|
+
* Automatically updated when using eCommerce checkout APIs.
|
|
538
|
+
*/
|
|
539
|
+
declare enum PaymentStatus {
|
|
540
|
+
/** Undefined payment status. */
|
|
541
|
+
UNDEFINED = "UNDEFINED",
|
|
542
|
+
/** The booking isn't paid. */
|
|
543
|
+
NOT_PAID = "NOT_PAID",
|
|
544
|
+
/** The booking is fully paid. */
|
|
545
|
+
PAID = "PAID",
|
|
546
|
+
/** The booking is partially paid. */
|
|
547
|
+
PARTIALLY_PAID = "PARTIALLY_PAID",
|
|
548
|
+
/** The booking is refunded. */
|
|
549
|
+
REFUNDED = "REFUNDED",
|
|
550
|
+
/** The booking is free of charge. */
|
|
551
|
+
EXEMPT = "EXEMPT"
|
|
552
|
+
}
|
|
553
|
+
/** @enumType */
|
|
554
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_PAID' | 'REFUNDED' | 'EXEMPT';
|
|
555
|
+
/**
|
|
556
|
+
* Selected payment option.
|
|
557
|
+
*
|
|
558
|
+
* One of the payment options offered by the service.
|
|
559
|
+
* This field is set when the user selects an option during booking.
|
|
560
|
+
* If left undefined, the payment option is resolved by the service configuration on checkout.
|
|
561
|
+
*/
|
|
562
|
+
declare enum SelectedPaymentOption {
|
|
563
|
+
/** Undefined payment option. */
|
|
564
|
+
UNDEFINED = "UNDEFINED",
|
|
565
|
+
/** Offline payment. */
|
|
566
|
+
OFFLINE = "OFFLINE",
|
|
567
|
+
/** Online payment. */
|
|
568
|
+
ONLINE = "ONLINE",
|
|
569
|
+
/** Payment using a Wix Pricing Plan. */
|
|
570
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
571
|
+
/**
|
|
572
|
+
* Customers can pay only in person with a Wix Pricing Plan, while the Wix user
|
|
573
|
+
* must manually redeem the pricing plan in the dashboard.
|
|
574
|
+
*/
|
|
575
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
576
|
+
}
|
|
577
|
+
/** @enumType */
|
|
578
|
+
type SelectedPaymentOptionWithLiterals = SelectedPaymentOption | 'UNDEFINED' | 'OFFLINE' | 'ONLINE' | 'MEMBERSHIP' | 'MEMBERSHIP_OFFLINE';
|
|
579
|
+
interface BookingSource {
|
|
580
|
+
/** Platform from which a booking was created. */
|
|
581
|
+
platform?: PlatformWithLiterals;
|
|
582
|
+
/** Actor that created this booking. */
|
|
583
|
+
actor?: ActorWithLiterals;
|
|
584
|
+
/**
|
|
585
|
+
* Wix site ID of the application that created the booking.
|
|
586
|
+
* @format GUID
|
|
587
|
+
* @readonly
|
|
588
|
+
*/
|
|
589
|
+
appDefId?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.
|
|
592
|
+
* @readonly
|
|
593
|
+
*/
|
|
594
|
+
appName?: string | null;
|
|
595
|
+
}
|
|
596
|
+
declare enum Platform {
|
|
597
|
+
UNDEFINED_PLATFORM = "UNDEFINED_PLATFORM",
|
|
598
|
+
WEB = "WEB",
|
|
599
|
+
MOBILE_APP = "MOBILE_APP"
|
|
600
|
+
}
|
|
601
|
+
/** @enumType */
|
|
602
|
+
type PlatformWithLiterals = Platform | 'UNDEFINED_PLATFORM' | 'WEB' | 'MOBILE_APP';
|
|
603
|
+
declare enum Actor {
|
|
604
|
+
UNDEFINED_ACTOR = "UNDEFINED_ACTOR",
|
|
605
|
+
BUSINESS = "BUSINESS",
|
|
606
|
+
CUSTOMER = "CUSTOMER"
|
|
607
|
+
}
|
|
608
|
+
/** @enumType */
|
|
609
|
+
type ActorWithLiterals = Actor | 'UNDEFINED_ACTOR' | 'BUSINESS' | 'CUSTOMER';
|
|
610
|
+
interface ParticipantNotification {
|
|
611
|
+
/**
|
|
612
|
+
* Whether to send the message about the changes to the customer.
|
|
613
|
+
*
|
|
614
|
+
* Default: `false`
|
|
615
|
+
*/
|
|
616
|
+
notifyParticipants?: boolean;
|
|
617
|
+
/** Custom message to send to the participants about the changes to the booking. */
|
|
618
|
+
message?: string | null;
|
|
619
|
+
}
|
|
620
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
621
|
+
/**
|
|
622
|
+
* ID of a site visitor that has not logged in to the site.
|
|
623
|
+
* @format GUID
|
|
624
|
+
*/
|
|
625
|
+
anonymousVisitorId?: string;
|
|
626
|
+
/**
|
|
627
|
+
* ID of a site visitor that has logged in to the site.
|
|
628
|
+
* @format GUID
|
|
629
|
+
*/
|
|
630
|
+
memberId?: string;
|
|
631
|
+
/**
|
|
632
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
633
|
+
* @format GUID
|
|
634
|
+
*/
|
|
635
|
+
wixUserId?: string;
|
|
636
|
+
/**
|
|
637
|
+
* ID of an app.
|
|
638
|
+
* @format GUID
|
|
639
|
+
*/
|
|
640
|
+
appId?: string;
|
|
641
|
+
/**
|
|
642
|
+
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
643
|
+
* @format GUID
|
|
644
|
+
*/
|
|
645
|
+
contactId?: string | null;
|
|
646
|
+
}
|
|
647
|
+
/** @oneof */
|
|
648
|
+
interface IdentificationDataIdOneOf {
|
|
649
|
+
/**
|
|
650
|
+
* ID of a site visitor that has not logged in to the site.
|
|
651
|
+
* @format GUID
|
|
652
|
+
*/
|
|
653
|
+
anonymousVisitorId?: string;
|
|
654
|
+
/**
|
|
655
|
+
* ID of a site visitor that has logged in to the site.
|
|
656
|
+
* @format GUID
|
|
657
|
+
*/
|
|
658
|
+
memberId?: string;
|
|
659
|
+
/**
|
|
660
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
661
|
+
* @format GUID
|
|
662
|
+
*/
|
|
663
|
+
wixUserId?: string;
|
|
664
|
+
/**
|
|
665
|
+
* ID of an app.
|
|
666
|
+
* @format GUID
|
|
667
|
+
*/
|
|
668
|
+
appId?: string;
|
|
669
|
+
}
|
|
670
|
+
declare enum IdentityType {
|
|
671
|
+
UNKNOWN = "UNKNOWN",
|
|
672
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
673
|
+
MEMBER = "MEMBER",
|
|
674
|
+
WIX_USER = "WIX_USER",
|
|
675
|
+
APP = "APP"
|
|
676
|
+
}
|
|
677
|
+
interface FlowControlSettings {
|
|
678
|
+
/** Whether availability is checked when creating or confirming the booking. */
|
|
679
|
+
skipAvailabilityValidation?: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* Whether the booking's `status` is automatically updated to `CONFIRMED` when
|
|
682
|
+
* the customer completes the *eCommerce checkout*
|
|
683
|
+
* ([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)),
|
|
684
|
+
* regardless of whether the relevant service requires manual business confirmation.
|
|
685
|
+
*/
|
|
686
|
+
skipBusinessConfirmation?: boolean;
|
|
687
|
+
/**
|
|
688
|
+
* Whether the customer is allowed to pay with a payment method that isn't
|
|
689
|
+
* supported for the relevant service.
|
|
690
|
+
*/
|
|
691
|
+
skipSelectedPaymentOptionValidation?: boolean;
|
|
692
|
+
/**
|
|
693
|
+
* Whether the customer receives an automatic refund if there's a double booking
|
|
694
|
+
* conflict. Only available if the customer has paid with a
|
|
695
|
+
* pricing plan.
|
|
696
|
+
*/
|
|
697
|
+
withRefund?: boolean | null;
|
|
698
|
+
}
|
|
699
|
+
interface ExtendedFields {
|
|
700
|
+
/**
|
|
701
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
702
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
703
|
+
*
|
|
704
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
705
|
+
*
|
|
706
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
707
|
+
*/
|
|
708
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
709
|
+
}
|
|
710
|
+
interface ParticipantChoices {
|
|
711
|
+
/**
|
|
712
|
+
* Information about the booked service choices. Includes the number of participants.
|
|
713
|
+
* @minSize 1
|
|
714
|
+
* @maxSize 20
|
|
715
|
+
*/
|
|
716
|
+
serviceChoices?: ServiceChoices[];
|
|
717
|
+
}
|
|
718
|
+
interface ServiceChoices {
|
|
719
|
+
/**
|
|
720
|
+
* Number of participants for this _variant_
|
|
721
|
+
* ([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)).
|
|
722
|
+
* @min 1
|
|
723
|
+
*/
|
|
724
|
+
numberOfParticipants?: number | null;
|
|
725
|
+
/**
|
|
726
|
+
* Service choices for these participants.
|
|
727
|
+
* @maxSize 5
|
|
728
|
+
*/
|
|
729
|
+
choices?: ServiceChoice[];
|
|
730
|
+
}
|
|
731
|
+
interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
732
|
+
/**
|
|
733
|
+
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
734
|
+
* Choices are specific values for an option the customer can choose to book. For example,
|
|
735
|
+
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
736
|
+
* Each choice may have a different price.
|
|
737
|
+
*/
|
|
738
|
+
custom?: string;
|
|
739
|
+
duration?: Duration;
|
|
740
|
+
/**
|
|
741
|
+
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
742
|
+
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
743
|
+
* for the `ageGroup` option.
|
|
744
|
+
* @format GUID
|
|
745
|
+
*/
|
|
746
|
+
optionId?: string;
|
|
747
|
+
}
|
|
748
|
+
/** @oneof */
|
|
749
|
+
interface ServiceChoiceChoiceOneOf {
|
|
750
|
+
/**
|
|
751
|
+
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
752
|
+
* Choices are specific values for an option the customer can choose to book. For example,
|
|
753
|
+
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
754
|
+
* Each choice may have a different price.
|
|
755
|
+
*/
|
|
756
|
+
custom?: string;
|
|
757
|
+
duration?: Duration;
|
|
758
|
+
}
|
|
759
|
+
interface Duration {
|
|
760
|
+
/**
|
|
761
|
+
* Duration of the service in minutes.
|
|
762
|
+
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
763
|
+
* @min 1
|
|
764
|
+
* @max 44639
|
|
765
|
+
*/
|
|
766
|
+
minutes?: number;
|
|
767
|
+
/**
|
|
768
|
+
* Name of the duration option.
|
|
769
|
+
* Defaults to the formatted duration e.g. "1 hour, 30 minutes".
|
|
770
|
+
* @maxLength 255
|
|
771
|
+
*/
|
|
772
|
+
name?: string | null;
|
|
773
|
+
}
|
|
774
|
+
interface MultiServiceBookingInfo {
|
|
775
|
+
/**
|
|
776
|
+
* Multi-service booking ID.
|
|
777
|
+
* @format GUID
|
|
778
|
+
* @readonly
|
|
779
|
+
*/
|
|
780
|
+
_id?: string | null;
|
|
781
|
+
/** Type of the multi-service booking. */
|
|
782
|
+
type?: MultiServiceBookingTypeWithLiterals;
|
|
783
|
+
}
|
|
784
|
+
interface BookedAddOn {
|
|
785
|
+
/**
|
|
786
|
+
* The ID of the Add-On.
|
|
787
|
+
* @format GUID
|
|
788
|
+
*/
|
|
789
|
+
_id?: string;
|
|
790
|
+
/**
|
|
791
|
+
* The ID of the Add-Ons group.
|
|
792
|
+
* @format GUID
|
|
793
|
+
*/
|
|
794
|
+
groupId?: string;
|
|
795
|
+
/**
|
|
796
|
+
* The Add-On duration in minutes at the time of Booking.
|
|
797
|
+
* @min 1
|
|
798
|
+
* @max 1440
|
|
799
|
+
* @readonly
|
|
800
|
+
*/
|
|
801
|
+
durationInMinutes?: number | null;
|
|
802
|
+
/**
|
|
803
|
+
* The quantity of booked Add-Ons.
|
|
804
|
+
* @min 1
|
|
805
|
+
* @max 1000
|
|
806
|
+
*/
|
|
807
|
+
quantity?: number | null;
|
|
808
|
+
/**
|
|
809
|
+
* Add-On name at the time of booking.
|
|
810
|
+
* @maxLength 100
|
|
811
|
+
* @readonly
|
|
812
|
+
*/
|
|
813
|
+
name?: string | null;
|
|
814
|
+
/**
|
|
815
|
+
* Add-On name translated to the language the booking was made in.
|
|
816
|
+
* @maxLength 100
|
|
817
|
+
* @readonly
|
|
818
|
+
*/
|
|
819
|
+
nameTranslated?: string | null;
|
|
820
|
+
}
|
|
821
|
+
/** Possible allowed actions for a Booking */
|
|
822
|
+
interface AllowedActions {
|
|
823
|
+
/** Whether the customer is allowed to cancel the booking. */
|
|
824
|
+
cancel?: boolean;
|
|
825
|
+
/** Whether the customer is allowed to reschedule the booking. */
|
|
826
|
+
reschedule?: boolean;
|
|
827
|
+
/**
|
|
828
|
+
* Deprecated.
|
|
829
|
+
* Whether the customer is entitled to a refund when canceling the booking.
|
|
830
|
+
* @deprecated
|
|
831
|
+
*/
|
|
832
|
+
refund?: boolean | null;
|
|
833
|
+
}
|
|
834
|
+
interface Attendance {
|
|
835
|
+
/**
|
|
836
|
+
* ID of the attendance object.
|
|
837
|
+
* @format GUID
|
|
838
|
+
* @readonly
|
|
839
|
+
*/
|
|
840
|
+
_id?: string | null;
|
|
841
|
+
/** General information about the booking's attendance. */
|
|
842
|
+
status?: AttendanceStatusWithLiterals;
|
|
843
|
+
/**
|
|
844
|
+
* Total number of participants who attended the session. Can
|
|
845
|
+
* be greater than `1` for bookings with multiple participants.
|
|
846
|
+
*/
|
|
847
|
+
numberOfAttendees?: number;
|
|
848
|
+
}
|
|
849
|
+
interface ConferencingDetails {
|
|
850
|
+
/**
|
|
851
|
+
* URL used by a guest to join the conference.
|
|
852
|
+
* @minLength 1
|
|
853
|
+
* @maxLength 2000
|
|
854
|
+
*/
|
|
855
|
+
guestUrl?: string | null;
|
|
856
|
+
/**
|
|
857
|
+
* Conference password.
|
|
858
|
+
* @minLength 1
|
|
859
|
+
* @maxLength 100
|
|
860
|
+
*/
|
|
861
|
+
password?: string | null;
|
|
862
|
+
}
|
|
863
|
+
interface BookingPolicySettings {
|
|
864
|
+
/** Whether the booking has an active cancellation fee policy. */
|
|
865
|
+
cancellationFeeEnabled?: boolean | null;
|
|
866
|
+
}
|
|
867
|
+
interface BookingFeeDetails {
|
|
868
|
+
/** Cancellation fee status. */
|
|
869
|
+
cancellationFeeStatus?: BookingFeeStatusWithLiterals;
|
|
870
|
+
}
|
|
871
|
+
declare enum BookingFeeStatus {
|
|
872
|
+
/** There is no information about the booking fee status. */
|
|
873
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
874
|
+
/** The booking fee hasn't been applied to the eCommerce order yet. */
|
|
875
|
+
NOT_YET_APPLIED_TO_ORDER = "NOT_YET_APPLIED_TO_ORDER",
|
|
876
|
+
/** The booking fee has already been applied as an additional fee to the eCommerce order. */
|
|
877
|
+
APPLIED_TO_ORDER = "APPLIED_TO_ORDER"
|
|
878
|
+
}
|
|
879
|
+
/** @enumType */
|
|
880
|
+
type BookingFeeStatusWithLiterals = BookingFeeStatus | 'UNKNOWN_STATUS' | 'NOT_YET_APPLIED_TO_ORDER' | 'APPLIED_TO_ORDER';
|
|
881
|
+
interface QueryExtendedBookingRequest {
|
|
882
|
+
/** Information about filters, paging, and sorting. */
|
|
883
|
+
query: QueryV2;
|
|
884
|
+
/** Whether information about which actions the customer can perform for the bookings is returned. */
|
|
885
|
+
withBookingAllowedActions?: boolean;
|
|
886
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
887
|
+
withBookingAttendanceInfo?: boolean;
|
|
888
|
+
/**
|
|
889
|
+
* Filters the retrieved bookings by the booking ID that corresponds to the
|
|
890
|
+
* specified `sessionId`.
|
|
891
|
+
*
|
|
892
|
+
* The `booking.id` is calculated by calling Get Session and saving the returned
|
|
893
|
+
* values for `participants.Id`.
|
|
894
|
+
*
|
|
895
|
+
* These participant IDs are then used as `booking.id`.
|
|
896
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
897
|
+
*
|
|
898
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
899
|
+
* bookings, you must use this field to filter by session ID.
|
|
900
|
+
*/
|
|
901
|
+
sessionId?: string | null;
|
|
902
|
+
}
|
|
903
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
904
|
+
/** Paging options to limit and skip the number of items. */
|
|
905
|
+
paging?: Paging;
|
|
906
|
+
/**
|
|
907
|
+
* Cursor token pointing to a page of results. In the first request,
|
|
908
|
+
* specify `cursorPaging.limit`. For following requests, specify the
|
|
909
|
+
* retrieved `cursorPaging.cursor` token and not `query.filter` or
|
|
910
|
+
* `query.sort`.
|
|
911
|
+
*/
|
|
912
|
+
cursorPaging?: CursorPaging;
|
|
913
|
+
/**
|
|
914
|
+
* Filter object in the following format:
|
|
915
|
+
* `"filter" : {
|
|
916
|
+
* "fieldName1": "value1",
|
|
917
|
+
* "fieldName2":{"$operator":"value2"}
|
|
918
|
+
* }`
|
|
919
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
920
|
+
*/
|
|
921
|
+
filter?: Record<string, any> | null;
|
|
922
|
+
/**
|
|
923
|
+
* Sort object in the following format:
|
|
924
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
925
|
+
*/
|
|
926
|
+
sort?: Sorting[];
|
|
927
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
928
|
+
fields?: string[];
|
|
929
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
930
|
+
fieldsets?: string[];
|
|
931
|
+
}
|
|
932
|
+
/** @oneof */
|
|
933
|
+
interface QueryV2PagingMethodOneOf {
|
|
934
|
+
/** Paging options to limit and skip the number of items. */
|
|
935
|
+
paging?: Paging;
|
|
936
|
+
/**
|
|
937
|
+
* Cursor token pointing to a page of results. In the first request,
|
|
938
|
+
* specify `cursorPaging.limit`. For following requests, specify the
|
|
939
|
+
* retrieved `cursorPaging.cursor` token and not `query.filter` or
|
|
940
|
+
* `query.sort`.
|
|
941
|
+
*/
|
|
942
|
+
cursorPaging?: CursorPaging;
|
|
943
|
+
}
|
|
944
|
+
interface Sorting {
|
|
945
|
+
/**
|
|
946
|
+
* Name of the field to sort by.
|
|
947
|
+
* @maxLength 512
|
|
948
|
+
*/
|
|
949
|
+
fieldName?: string;
|
|
950
|
+
/** Sort order. */
|
|
951
|
+
order?: SortOrderWithLiterals;
|
|
952
|
+
}
|
|
953
|
+
declare enum SortOrder {
|
|
954
|
+
ASC = "ASC",
|
|
955
|
+
DESC = "DESC"
|
|
956
|
+
}
|
|
957
|
+
/** @enumType */
|
|
958
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
959
|
+
interface Paging {
|
|
960
|
+
/** Number of items to load. */
|
|
961
|
+
limit?: number | null;
|
|
962
|
+
/** Number of items to skip in the current sort order. */
|
|
963
|
+
offset?: number | null;
|
|
964
|
+
}
|
|
965
|
+
interface CursorPaging {
|
|
966
|
+
/**
|
|
967
|
+
* Maximum number of items to return in the results.
|
|
968
|
+
* @max 100
|
|
969
|
+
*/
|
|
970
|
+
limit?: number | null;
|
|
971
|
+
/**
|
|
972
|
+
* Pointer to the next or previous page in the list of results.
|
|
973
|
+
*
|
|
974
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
975
|
+
* Not relevant for the first request.
|
|
976
|
+
* @maxLength 16000
|
|
977
|
+
*/
|
|
978
|
+
cursor?: string | null;
|
|
979
|
+
}
|
|
980
|
+
interface QueryExtendedBookingResponse {
|
|
981
|
+
/**
|
|
982
|
+
* Retrieved bookings and additional information about attendance or actions
|
|
983
|
+
* the customer can perform
|
|
984
|
+
*/
|
|
985
|
+
extendedBookings?: ExtendedBooking[];
|
|
986
|
+
/** Paging metadata. */
|
|
987
|
+
pagingMetadata?: PagingMetadataV2;
|
|
988
|
+
}
|
|
989
|
+
interface PagingMetadataV2 {
|
|
990
|
+
/** Number of items returned in the response. */
|
|
991
|
+
count?: number | null;
|
|
992
|
+
/** Offset that was requested. */
|
|
993
|
+
offset?: number | null;
|
|
994
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
995
|
+
total?: number | null;
|
|
996
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
997
|
+
tooManyToCount?: boolean | null;
|
|
998
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
999
|
+
cursors?: Cursors;
|
|
1000
|
+
}
|
|
1001
|
+
interface Cursors {
|
|
1002
|
+
/**
|
|
1003
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1004
|
+
* @maxLength 16000
|
|
1005
|
+
*/
|
|
1006
|
+
next?: string | null;
|
|
1007
|
+
/**
|
|
1008
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1009
|
+
* @maxLength 16000
|
|
1010
|
+
*/
|
|
1011
|
+
prev?: string | null;
|
|
1012
|
+
}
|
|
1013
|
+
interface QueryExtendedBookingsRequest {
|
|
1014
|
+
/** Information about filters, paging, and sorting. */
|
|
1015
|
+
query: CommonQueryV2;
|
|
1016
|
+
/** Whether to return information about the actions the customer can perform for the bookings. */
|
|
1017
|
+
withBookingAllowedActions?: boolean;
|
|
1018
|
+
/** Whether to return information about the attendance for the bookings. */
|
|
1019
|
+
withBookingAttendanceInfo?: boolean;
|
|
1020
|
+
/** Whether to return information about the online conferencing details for the bookings. */
|
|
1021
|
+
withBookingConferencingDetails?: boolean;
|
|
1022
|
+
/**
|
|
1023
|
+
* Whether to retrieve information about booking policy settings.
|
|
1024
|
+
*
|
|
1025
|
+
* You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope
|
|
1026
|
+
* when passing `true`.
|
|
1027
|
+
*
|
|
1028
|
+
* Default: `false`.
|
|
1029
|
+
*/
|
|
1030
|
+
withBookingPolicySettings?: boolean;
|
|
1031
|
+
/**
|
|
1032
|
+
* Whether to retrieve information about booking fee
|
|
1033
|
+
* ([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))
|
|
1034
|
+
* statuses.
|
|
1035
|
+
*
|
|
1036
|
+
* Information about booking fees with a status of `PREVIEW` isn't returned,
|
|
1037
|
+
* and only fees that have already been applied are included in the response.
|
|
1038
|
+
* If there are hypothetical fees for a booking that may be canceled in the
|
|
1039
|
+
* future, these fees aren't returned. To retrieve such fees, call
|
|
1040
|
+
* List Booking Fees By Booking Ids
|
|
1041
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/list-booking-fees-by-booking-ids) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/list-booking-fees-by-booking-ids))
|
|
1042
|
+
* instead.
|
|
1043
|
+
*
|
|
1044
|
+
* You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing
|
|
1045
|
+
* `true`.
|
|
1046
|
+
*
|
|
1047
|
+
* Default: `false`
|
|
1048
|
+
*/
|
|
1049
|
+
withBookingFeeDetails?: boolean;
|
|
1050
|
+
}
|
|
1051
|
+
interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
1052
|
+
/** Paging options to limit and skip the number of items. */
|
|
1053
|
+
paging?: CommonPaging;
|
|
1054
|
+
/**
|
|
1055
|
+
* Cursor token pointing to a page of results. In the first request,
|
|
1056
|
+
* specify `cursorPaging.limit`. For following requests, specify the
|
|
1057
|
+
* retrieved `cursorPaging.cursor` token and not `query.filter` or
|
|
1058
|
+
* `query.sort`.
|
|
1059
|
+
*/
|
|
1060
|
+
cursorPaging?: CursorPaging;
|
|
1061
|
+
/**
|
|
1062
|
+
* Filter object in the following format:
|
|
1063
|
+
* `"filter" : {
|
|
1064
|
+
* "fieldName1": "value1",
|
|
1065
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1066
|
+
* }`
|
|
1067
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1068
|
+
*
|
|
1069
|
+
* See [Supported Filters](https://www.wix.com/velo/reference/wix-bookings-v2/extendedbookings/supported-filters)
|
|
1070
|
+
* for a full list.
|
|
1071
|
+
*/
|
|
1072
|
+
filter?: Record<string, any> | null;
|
|
1073
|
+
/**
|
|
1074
|
+
* Sort object in the following format:
|
|
1075
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1076
|
+
*/
|
|
1077
|
+
sort?: Sorting[];
|
|
1078
|
+
}
|
|
1079
|
+
/** @oneof */
|
|
1080
|
+
interface CommonQueryV2PagingMethodOneOf {
|
|
1081
|
+
/** Paging options to limit and skip the number of items. */
|
|
1082
|
+
paging?: CommonPaging;
|
|
1083
|
+
/**
|
|
1084
|
+
* Cursor token pointing to a page of results. In the first request,
|
|
1085
|
+
* specify `cursorPaging.limit`. For following requests, specify the
|
|
1086
|
+
* retrieved `cursorPaging.cursor` token and not `query.filter` or
|
|
1087
|
+
* `query.sort`.
|
|
1088
|
+
*/
|
|
1089
|
+
cursorPaging?: CursorPaging;
|
|
1090
|
+
}
|
|
1091
|
+
interface CommonPaging {
|
|
1092
|
+
/** Number of items to load. */
|
|
1093
|
+
limit?: number | null;
|
|
1094
|
+
/** Number of items to skip in the current sort order. */
|
|
1095
|
+
offset?: number | null;
|
|
1096
|
+
}
|
|
1097
|
+
interface QueryExtendedBookingsResponse {
|
|
1098
|
+
/**
|
|
1099
|
+
* Retrieved bookings and additional information, such as information about about the attendance or actions
|
|
1100
|
+
* the customer can perform.
|
|
1101
|
+
*/
|
|
1102
|
+
extendedBookings?: ExtendedBooking[];
|
|
1103
|
+
/** Paging metadata. */
|
|
1104
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1105
|
+
}
|
|
1106
|
+
interface CountExtendedBookingsRequest {
|
|
1107
|
+
/**
|
|
1108
|
+
* Filter object in the following format:
|
|
1109
|
+
* `"filter" : {
|
|
1110
|
+
* "fieldName1": "value1",
|
|
1111
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1112
|
+
* }`
|
|
1113
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1114
|
+
*/
|
|
1115
|
+
filter?: Record<string, any> | null;
|
|
1116
|
+
}
|
|
1117
|
+
interface CountExtendedBookingsResponse {
|
|
1118
|
+
/** The number of bookings matching the specified filter. */
|
|
1119
|
+
count?: number;
|
|
1120
|
+
}
|
|
1121
|
+
interface QueryOptions {
|
|
1122
|
+
/** Whether information about which actions the customer can perform for the bookings is returned. */
|
|
1123
|
+
withBookingAllowedActions?: boolean;
|
|
1124
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
1125
|
+
withBookingAttendanceInfo?: boolean;
|
|
1126
|
+
/**
|
|
1127
|
+
* Filters the retrieved bookings by the booking ID that corresponds to the
|
|
1128
|
+
* specified `sessionId`.
|
|
1129
|
+
*
|
|
1130
|
+
* The `booking.id` is calculated by calling Get Session and saving the returned
|
|
1131
|
+
* values for `participants.Id`.
|
|
1132
|
+
*
|
|
1133
|
+
* These participant IDs are then used as `booking.id`.
|
|
1134
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
1135
|
+
*
|
|
1136
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
1137
|
+
* bookings, you must use this field to filter by session ID.
|
|
1138
|
+
*/
|
|
1139
|
+
sessionId?: string | null;
|
|
1140
|
+
}
|
|
1141
|
+
interface QueryExtendedBookingsOptions {
|
|
1142
|
+
/** Whether to return information about the actions the customer can perform for the bookings. */
|
|
1143
|
+
withBookingAllowedActions?: boolean;
|
|
1144
|
+
/** Whether to return information about the attendance for the bookings. */
|
|
1145
|
+
withBookingAttendanceInfo?: boolean;
|
|
1146
|
+
/** Whether to return information about the online conferencing details for the bookings. */
|
|
1147
|
+
withBookingConferencingDetails?: boolean;
|
|
1148
|
+
/**
|
|
1149
|
+
* Whether to retrieve information about booking policy settings.
|
|
1150
|
+
*
|
|
1151
|
+
* You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope
|
|
1152
|
+
* when passing `true`.
|
|
1153
|
+
*
|
|
1154
|
+
* Default: `false`.
|
|
1155
|
+
*/
|
|
1156
|
+
withBookingPolicySettings?: boolean;
|
|
1157
|
+
/**
|
|
1158
|
+
* Whether to retrieve information about booking fee
|
|
1159
|
+
* ([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))
|
|
1160
|
+
* statuses.
|
|
1161
|
+
*
|
|
1162
|
+
* Information about booking fees with a status of `PREVIEW` isn't returned,
|
|
1163
|
+
* and only fees that have already been applied are included in the response.
|
|
1164
|
+
* If there are hypothetical fees for a booking that may be canceled in the
|
|
1165
|
+
* future, these fees aren't returned. To retrieve such fees, call
|
|
1166
|
+
* List Booking Fees By Booking Ids
|
|
1167
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/list-booking-fees-by-booking-ids) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/list-booking-fees-by-booking-ids))
|
|
1168
|
+
* instead.
|
|
1169
|
+
*
|
|
1170
|
+
* You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing
|
|
1171
|
+
* `true`.
|
|
1172
|
+
*
|
|
1173
|
+
* Default: `false`
|
|
1174
|
+
*/
|
|
1175
|
+
withBookingFeeDetails?: boolean;
|
|
1176
|
+
}
|
|
1177
|
+
interface CountExtendedBookingsOptions {
|
|
1178
|
+
/**
|
|
1179
|
+
* Filter object in the following format:
|
|
1180
|
+
* `"filter" : {
|
|
1181
|
+
* "fieldName1": "value1",
|
|
1182
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1183
|
+
* }`
|
|
1184
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1185
|
+
*/
|
|
1186
|
+
filter?: Record<string, any> | null;
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
export { type BookingFeeDetails as $, AttendanceStatus as A, BookingStatus as B, type CommonQueryV2 as C, type ParticipantNotification as D, type ExtendedBooking as E, type IdentificationData as F, type IdentificationDataIdOneOf as G, type FlowControlSettings as H, IdentityType as I, type ExtendedFields as J, type ParticipantChoices as K, LocationType as L, MultiServiceBookingType as M, type ServiceChoices as N, type ServiceChoice as O, PaymentStatus as P, type QueryV2 as Q, type ServiceChoiceChoiceOneOf as R, SelectedPaymentOption as S, type Duration as T, type MultiServiceBookingInfo as U, ValueType as V, type BookedAddOn as W, type AllowedActions as X, type Attendance as Y, type ConferencingDetails as Z, type BookingPolicySettings as _, type QueryOptions as a, type QueryExtendedBookingRequest as a0, type QueryV2PagingMethodOneOf as a1, type Sorting as a2, type Paging as a3, type CursorPaging as a4, type PagingMetadataV2 as a5, type Cursors as a6, type QueryExtendedBookingsRequest as a7, type CommonQueryV2PagingMethodOneOf as a8, type CommonPaging as a9, type CountExtendedBookingsRequest as aa, type QueryExtendedBookingResponse as b, type QueryExtendedBookingsOptions as c, type QueryExtendedBookingsResponse as d, type CountExtendedBookingsOptions as e, type CountExtendedBookingsResponse as f, Platform as g, Actor as h, BookingFeeStatus as i, SortOrder as j, type Booking as k, type BookingParticipantsInfoOneOf as l, type BookedEntity as m, type BookedEntityItemOneOf as n, type BookedSlot as o, type BookedResource as p, type Location as q, type BookedSchedule as r, type ContactDetails as s, type Address as t, type AddressStreetOneOf as u, type StreetAddress as v, type AddressLocation as w, type Subdivision as x, type CustomFormField as y, type BookingSource as z };
|