@wix/bookings 1.0.1741 → 1.0.1743
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/_sdk-exports/context-booking-checkout-context/runtime.d.ts +2784 -0
- package/_sdk-exports/context-booking-checkout-context/runtime.js +2 -0
- package/_sdk-exports/context-categories-context/runtime.d.ts +144 -0
- package/_sdk-exports/context-categories-context/runtime.js +1 -0
- package/_sdk-exports/context-locations-context/runtime.d.ts +282 -0
- package/_sdk-exports/context-locations-context/runtime.js +1 -0
- package/_sdk-exports/context-service-addons-context/runtime.d.ts +264 -0
- package/_sdk-exports/context-service-addons-context/runtime.js +1 -0
- package/_sdk-exports/context-service-context/runtime.d.ts +3667 -0
- package/_sdk-exports/context-service-context/runtime.js +2 -0
- package/_sdk-exports/context-services-context/runtime.d.ts +2863 -0
- package/_sdk-exports/context-services-context/runtime.js +2 -0
- package/_sdk-exports/context-time-slots-context/runtime.d.ts +660 -0
- package/_sdk-exports/context-time-slots-context/runtime.js +2 -0
- package/build/cjs/context-booking-checkout-context.d.ts +2784 -0
- package/build/cjs/context-booking-checkout-context.js +3940 -0
- package/build/cjs/context-booking-checkout-context.js.map +1 -0
- package/build/cjs/context-categories-context.d.ts +144 -0
- package/build/cjs/context-categories-context.js +1188 -0
- package/build/cjs/context-categories-context.js.map +1 -0
- package/build/cjs/context-locations-context.d.ts +282 -0
- package/build/cjs/context-locations-context.js +1252 -0
- package/build/cjs/context-locations-context.js.map +1 -0
- package/build/cjs/context-service-addons-context.d.ts +264 -0
- package/build/cjs/context-service-addons-context.js +1324 -0
- package/build/cjs/context-service-addons-context.js.map +1 -0
- package/build/cjs/context-service-context.d.ts +3667 -0
- package/build/cjs/context-service-context.js +5336 -0
- package/build/cjs/context-service-context.js.map +1 -0
- package/build/cjs/context-services-context.d.ts +2863 -0
- package/build/cjs/context-services-context.js +2203 -0
- package/build/cjs/context-services-context.js.map +1 -0
- package/build/cjs/context-time-slots-context.d.ts +660 -0
- package/build/cjs/context-time-slots-context.js +2822 -0
- package/build/cjs/context-time-slots-context.js.map +1 -0
- package/build/es/context-booking-checkout-context.d.mts +2784 -0
- package/build/es/context-booking-checkout-context.mjs +3898 -0
- package/build/es/context-booking-checkout-context.mjs.map +1 -0
- package/build/es/context-categories-context.d.mts +144 -0
- package/build/es/context-categories-context.mjs +1157 -0
- package/build/es/context-categories-context.mjs.map +1 -0
- package/build/es/context-locations-context.d.mts +282 -0
- package/build/es/context-locations-context.mjs +1221 -0
- package/build/es/context-locations-context.mjs.map +1 -0
- package/build/es/context-service-addons-context.d.mts +264 -0
- package/build/es/context-service-addons-context.mjs +1294 -0
- package/build/es/context-service-addons-context.mjs.map +1 -0
- package/build/es/context-service-context.d.mts +3667 -0
- package/build/es/context-service-context.mjs +5304 -0
- package/build/es/context-service-context.mjs.map +1 -0
- package/build/es/context-services-context.d.mts +2863 -0
- package/build/es/context-services-context.mjs +2172 -0
- package/build/es/context-services-context.mjs.map +1 -0
- package/build/es/context-time-slots-context.d.mts +660 -0
- package/build/es/context-time-slots-context.mjs +2792 -0
- package/build/es/context-time-slots-context.mjs.map +1 -0
- package/build/internal/cjs/context-booking-checkout-context.d.ts +2784 -0
- package/build/internal/cjs/context-categories-context.d.ts +144 -0
- package/build/internal/cjs/context-locations-context.d.ts +282 -0
- package/build/internal/cjs/context-service-addons-context.d.ts +264 -0
- package/build/internal/cjs/context-service-context.d.ts +3667 -0
- package/build/internal/cjs/context-services-context.d.ts +2863 -0
- package/build/internal/cjs/context-time-slots-context.d.ts +660 -0
- package/build/internal/es/context-booking-checkout-context.d.mts +2784 -0
- package/build/internal/es/context-categories-context.d.mts +144 -0
- package/build/internal/es/context-locations-context.d.mts +282 -0
- package/build/internal/es/context-service-addons-context.d.mts +264 -0
- package/build/internal/es/context-service-context.d.mts +3667 -0
- package/build/internal/es/context-services-context.d.mts +2863 -0
- package/build/internal/es/context-time-slots-context.d.mts +660 -0
- package/context/booking-checkout-context/package.json +3 -0
- package/context/categories-context/package.json +3 -0
- package/context/locations-context/package.json +3 -0
- package/context/service-addons-context/package.json +3 -0
- package/context/service-context/package.json +3 -0
- package/context/services-context/package.json +3 -0
- package/context/time-slots-context/package.json +3 -0
- package/package.json +69 -8
|
@@ -0,0 +1,2863 @@
|
|
|
1
|
+
import React, { ReactNode } from "react";
|
|
2
|
+
|
|
3
|
+
//#region ../../node_modules/type-fest/source/observable-like.d.ts
|
|
4
|
+
declare global {
|
|
5
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
6
|
+
interface SymbolConstructor {
|
|
7
|
+
readonly observable: symbol;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
@remarks
|
|
12
|
+
The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
|
|
13
|
+
As well, some guidance on making an `Observable` to not include `closed` property.
|
|
14
|
+
@see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
|
|
15
|
+
@see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
|
|
16
|
+
@see https://github.com/benlesh/symbol-observable#making-an-object-observable
|
|
17
|
+
|
|
18
|
+
@category Observable
|
|
19
|
+
*/
|
|
20
|
+
//#endregion
|
|
21
|
+
//#region ../../node_modules/@wix/sdk-types/internal/build/index.d.ts
|
|
22
|
+
declare global {
|
|
23
|
+
interface ContextualClient {}
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Creates concrete types from SDK descriptors when a contextual client is
|
|
27
|
+
* available.
|
|
28
|
+
*
|
|
29
|
+
* For a REST descriptor the built (bound) API is intersected with the original
|
|
30
|
+
* descriptor, matching what `contextualizeRESTModuleV2` returns at runtime — a
|
|
31
|
+
* value callable as the bound API and still usable as a descriptor. Keeping the
|
|
32
|
+
* descriptor half lets contextual modules be passed to descriptor-constrained
|
|
33
|
+
* helpers such as `elevate` from `@wix/sdk/context` (FEDINF-14092).
|
|
34
|
+
*
|
|
35
|
+
* The `& T` is scoped to REST descriptors — the only shape codegen wraps in
|
|
36
|
+
* `MaybeContext` — so `BuildDescriptors` (used by `createClient().use`) is left
|
|
37
|
+
* unchanged and stays bound-only. The fix lives here rather than in `elevate`,
|
|
38
|
+
* which is kept strict on purpose (see #941) so it still rejects bound-only
|
|
39
|
+
* functions that are unsafe through `createRESTModule`.
|
|
40
|
+
*/
|
|
41
|
+
declare global {
|
|
42
|
+
/**
|
|
43
|
+
* A global interface to set the exposure toggle for the SDK.
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* declare global {
|
|
47
|
+
* interface SDKExposureToggle {
|
|
48
|
+
* alpha: true;
|
|
49
|
+
* }
|
|
50
|
+
* }
|
|
51
|
+
*/
|
|
52
|
+
interface SDKExposureToggle {}
|
|
53
|
+
}
|
|
54
|
+
declare global {
|
|
55
|
+
/**
|
|
56
|
+
* A global interface to set the type mode for the SDK.
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* declare global {
|
|
60
|
+
* interface SDKTypeMode {
|
|
61
|
+
* strict: true;
|
|
62
|
+
* }
|
|
63
|
+
* }
|
|
64
|
+
*/
|
|
65
|
+
interface SDKTypeMode {}
|
|
66
|
+
}
|
|
67
|
+
//#endregion
|
|
68
|
+
//#region ../../node_modules/@wix/auto_sdk_calendar_events/build/es/index.typings.d.mts
|
|
69
|
+
/**
|
|
70
|
+
* An event is a scheduled entry on a calendar that includes details like timing,
|
|
71
|
+
* location, and participants. Each event is associated with
|
|
72
|
+
* a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
|
|
73
|
+
* from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
|
|
74
|
+
* Events can either be standalone, part of a recurring series, or define a
|
|
75
|
+
* recurrence pattern. You can also specify whether events block time on the
|
|
76
|
+
* schedule or allow other events to be scheduled concurrently.
|
|
77
|
+
*/
|
|
78
|
+
interface Event {
|
|
79
|
+
/**
|
|
80
|
+
* Event ID.
|
|
81
|
+
* @minLength 36
|
|
82
|
+
* @maxLength 250
|
|
83
|
+
* @readonly
|
|
84
|
+
*/
|
|
85
|
+
_id?: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
88
|
+
* the event belongs to.
|
|
89
|
+
* After creating an event, you can't assign it to a different schedule.
|
|
90
|
+
* @format GUID
|
|
91
|
+
* @immutable
|
|
92
|
+
*/
|
|
93
|
+
scheduleId?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* ID of the external schedule the event belongs to.
|
|
96
|
+
*
|
|
97
|
+
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
98
|
+
* @format GUID
|
|
99
|
+
* @readonly
|
|
100
|
+
*/
|
|
101
|
+
externalScheduleId?: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Schedule name.
|
|
104
|
+
* @readonly
|
|
105
|
+
*/
|
|
106
|
+
scheduleName?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
* Event type. You can set the event type but you can't update it.
|
|
109
|
+
*
|
|
110
|
+
* Supported values:
|
|
111
|
+
* + `DEFAULT`: A standard event that's not further specified.
|
|
112
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
|
|
113
|
+
*
|
|
114
|
+
* Additional supported values, if Wix Bookings is installed:
|
|
115
|
+
* + `APPOINTMENT`: Bookings appointment event.
|
|
116
|
+
* + `CLASS`: Bookings class event.
|
|
117
|
+
* + `COURSE`: Bookings course event.
|
|
118
|
+
* @immutable
|
|
119
|
+
*/
|
|
120
|
+
type?: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* Event status.
|
|
123
|
+
*
|
|
124
|
+
* Supported values:
|
|
125
|
+
* + `CONFIRMED`: Event is scheduled to happen or has happened.
|
|
126
|
+
* + `CANCELLED`: Event has been canceled.
|
|
127
|
+
*
|
|
128
|
+
* Default: `CONFIRMED`
|
|
129
|
+
* @readonly
|
|
130
|
+
*/
|
|
131
|
+
status?: StatusWithLiterals;
|
|
132
|
+
/**
|
|
133
|
+
* Event title.
|
|
134
|
+
*
|
|
135
|
+
* Min: 1 character
|
|
136
|
+
* Max: 200 characters
|
|
137
|
+
* @minLength 1
|
|
138
|
+
* @maxLength 200
|
|
139
|
+
*/
|
|
140
|
+
title?: string | null;
|
|
141
|
+
/** Information about when the event starts. */
|
|
142
|
+
start?: ZonedDate;
|
|
143
|
+
/**
|
|
144
|
+
* Information about when the event ends.
|
|
145
|
+
*
|
|
146
|
+
* Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
|
|
147
|
+
*/
|
|
148
|
+
end?: ZonedDate;
|
|
149
|
+
/**
|
|
150
|
+
* Information about when the event starts adjusted to the `timeZone` of the
|
|
151
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
152
|
+
* or a different `timeZone` you provide in the call's request.
|
|
153
|
+
* @readonly
|
|
154
|
+
*/
|
|
155
|
+
adjustedStart?: ZonedDate;
|
|
156
|
+
/**
|
|
157
|
+
* Information about when the event ends adjusted to the `timeZone` of the
|
|
158
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
159
|
+
* or a different `timeZone` you provide in the call's request.
|
|
160
|
+
* @readonly
|
|
161
|
+
*/
|
|
162
|
+
adjustedEnd?: ZonedDate;
|
|
163
|
+
/**
|
|
164
|
+
* Time zone the event is associated with in
|
|
165
|
+
* [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
166
|
+
* Only regional time zones and UTC are supported.
|
|
167
|
+
* For example, `America/New_York` or `UTC`.
|
|
168
|
+
*
|
|
169
|
+
* Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
170
|
+
*/
|
|
171
|
+
timeZone?: string | null;
|
|
172
|
+
/**
|
|
173
|
+
* Whether the event spans one or more full days.
|
|
174
|
+
*
|
|
175
|
+
* When `true`, `start` and `end` represent full-day boundaries:
|
|
176
|
+
* + `start.localDate`: First day at `00:00:00`.
|
|
177
|
+
* + `end.localDate`: Day after the last day at `00:00:00` (exclusive).
|
|
178
|
+
* Midnight boundaries are interpreted in the event's `timeZone`.
|
|
179
|
+
*
|
|
180
|
+
* Default: `false`
|
|
181
|
+
*/
|
|
182
|
+
allDay?: boolean | null;
|
|
183
|
+
/**
|
|
184
|
+
* Information about whether the event is a single occurrence or part of a
|
|
185
|
+
* recurring series.
|
|
186
|
+
*
|
|
187
|
+
* Supported values:
|
|
188
|
+
* + `NONE`: The event occurs only once and doesn't repeat.
|
|
189
|
+
* + `MASTER`: Defines the recurrence pattern for a series of recurring events.
|
|
190
|
+
* + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
|
|
191
|
+
* + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
|
|
192
|
+
*
|
|
193
|
+
* Default: `NONE`
|
|
194
|
+
* @readonly
|
|
195
|
+
*/
|
|
196
|
+
recurrenceType?: RecurrenceTypeWithLiterals;
|
|
197
|
+
/**
|
|
198
|
+
* Recurrence pattern for a series of events. This field is required when
|
|
199
|
+
* creating a `MASTER` event and isn't available for non-recurring events.
|
|
200
|
+
* You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
|
|
201
|
+
*
|
|
202
|
+
* For example, an event that repeats every second Monday until January 7, 2026,
|
|
203
|
+
* at 8:00 AM has the following `recurrenceRule`:
|
|
204
|
+
* - `frequency = WEEKLY`
|
|
205
|
+
* - `interval = 2`
|
|
206
|
+
* - `days = [MONDAY]`
|
|
207
|
+
* - `until = 20260107T08:00:00Z`
|
|
208
|
+
*/
|
|
209
|
+
recurrenceRule?: RecurrenceRule;
|
|
210
|
+
/**
|
|
211
|
+
* ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
|
|
212
|
+
* and `EXCEPTION` events.
|
|
213
|
+
* @minLength 64
|
|
214
|
+
* @maxLength 64
|
|
215
|
+
* @readonly
|
|
216
|
+
*/
|
|
217
|
+
recurringEventId?: string | null;
|
|
218
|
+
/**
|
|
219
|
+
* Specifies whether the event blocks time in the schedule it belongs to.
|
|
220
|
+
*
|
|
221
|
+
* Supported values:
|
|
222
|
+
* + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
|
|
223
|
+
* + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
|
|
224
|
+
*
|
|
225
|
+
* Default: `OPAQUE`
|
|
226
|
+
*/
|
|
227
|
+
transparency?: TransparencyWithLiterals;
|
|
228
|
+
/**
|
|
229
|
+
* Event location.
|
|
230
|
+
*
|
|
231
|
+
* Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
|
|
232
|
+
*/
|
|
233
|
+
location?: Location;
|
|
234
|
+
/**
|
|
235
|
+
* List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
|
|
236
|
+
* affected by the event. This could include, for example, the
|
|
237
|
+
* [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
|
|
238
|
+
* providing the service or the room where the appointment takes place.
|
|
239
|
+
*
|
|
240
|
+
* Max: 100 resources
|
|
241
|
+
* @maxSize 100
|
|
242
|
+
*/
|
|
243
|
+
resources?: Resource[];
|
|
244
|
+
/**
|
|
245
|
+
* Maximum number of participants who can participate in the event.
|
|
246
|
+
*
|
|
247
|
+
* Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
248
|
+
*/
|
|
249
|
+
totalCapacity?: number | null;
|
|
250
|
+
/**
|
|
251
|
+
* Number of participants who can still be added to the event.
|
|
252
|
+
* @readonly
|
|
253
|
+
*/
|
|
254
|
+
remainingCapacity?: number | null;
|
|
255
|
+
/**
|
|
256
|
+
* Information about the event's participants.
|
|
257
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
258
|
+
* @readonly
|
|
259
|
+
*/
|
|
260
|
+
participants?: Participants;
|
|
261
|
+
/**
|
|
262
|
+
* Information about the event's online conferencing.
|
|
263
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
264
|
+
*
|
|
265
|
+
* Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
266
|
+
*/
|
|
267
|
+
conferencingDetails?: ConferencingDetails;
|
|
268
|
+
/**
|
|
269
|
+
* Additional notes about the event.
|
|
270
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
271
|
+
*
|
|
272
|
+
* Min: 1 character
|
|
273
|
+
* Max: 5000 characters
|
|
274
|
+
* @minLength 1
|
|
275
|
+
* @maxLength 5000
|
|
276
|
+
*/
|
|
277
|
+
notes?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* List of fields whose values are inherited.
|
|
280
|
+
* + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
281
|
+
* + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
|
|
282
|
+
* @readonly
|
|
283
|
+
*/
|
|
284
|
+
inheritedFields?: FieldWithLiterals[];
|
|
285
|
+
/**
|
|
286
|
+
* ID of the app that owns the event. Identical to `appId` of the
|
|
287
|
+
* [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
288
|
+
* to which the event belongs.
|
|
289
|
+
* @format GUID
|
|
290
|
+
* @readonly
|
|
291
|
+
*/
|
|
292
|
+
appId?: string | null;
|
|
293
|
+
/**
|
|
294
|
+
* List of permissions associated with the event. Refer to the
|
|
295
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
|
|
296
|
+
* for more information.
|
|
297
|
+
* @readonly
|
|
298
|
+
*/
|
|
299
|
+
permissions?: Permission[];
|
|
300
|
+
/** Extensions enabling applications or users to save custom data related to the event. */
|
|
301
|
+
extendedFields?: ExtendedFields$2;
|
|
302
|
+
/**
|
|
303
|
+
* Revision number, which increments each time the event is updated.
|
|
304
|
+
* To prevent conflicting changes, the current revision must be passed when updating the event.
|
|
305
|
+
* Ignored when creating an event.
|
|
306
|
+
* @readonly
|
|
307
|
+
*/
|
|
308
|
+
revision?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
311
|
+
* @readonly
|
|
312
|
+
*/
|
|
313
|
+
_createdDate?: Date | null;
|
|
314
|
+
/**
|
|
315
|
+
* Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
316
|
+
* @readonly
|
|
317
|
+
*/
|
|
318
|
+
_updatedDate?: Date | null;
|
|
319
|
+
}
|
|
320
|
+
declare enum Status {
|
|
321
|
+
/** Event is scheduled to happen or has happened. */
|
|
322
|
+
CONFIRMED = "CONFIRMED",
|
|
323
|
+
/** Event has been canceled. */
|
|
324
|
+
CANCELLED = "CANCELLED"
|
|
325
|
+
}
|
|
326
|
+
/** @enumType */
|
|
327
|
+
type StatusWithLiterals = Status | 'CONFIRMED' | 'CANCELLED';
|
|
328
|
+
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
329
|
+
interface ZonedDate {
|
|
330
|
+
/**
|
|
331
|
+
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
332
|
+
* For example, `2024-01-30T13:30:00`.
|
|
333
|
+
* Wix Calendar APIs ignore seconds.
|
|
334
|
+
* @format LOCAL_DATE_TIME
|
|
335
|
+
*/
|
|
336
|
+
localDate?: string | null;
|
|
337
|
+
/**
|
|
338
|
+
* Time zone in
|
|
339
|
+
* [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
340
|
+
* For example, `America/New_York`.
|
|
341
|
+
* @readonly
|
|
342
|
+
*/
|
|
343
|
+
timeZone?: string | null;
|
|
344
|
+
/**
|
|
345
|
+
* UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
346
|
+
* For example, `2024-01-30T13:30:00`.
|
|
347
|
+
* Not available for adjusted date fields.
|
|
348
|
+
* @readonly
|
|
349
|
+
*/
|
|
350
|
+
utcDate?: Date | null;
|
|
351
|
+
}
|
|
352
|
+
declare enum RecurrenceType {
|
|
353
|
+
/** The event occurs only once and doesn't repeat. */
|
|
354
|
+
NONE = "NONE",
|
|
355
|
+
/** Defines the recurrence pattern for a series of recurring events. */
|
|
356
|
+
MASTER = "MASTER",
|
|
357
|
+
/** A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`. */
|
|
358
|
+
INSTANCE = "INSTANCE",
|
|
359
|
+
/** A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event. */
|
|
360
|
+
EXCEPTION = "EXCEPTION"
|
|
361
|
+
}
|
|
362
|
+
/** @enumType */
|
|
363
|
+
type RecurrenceTypeWithLiterals = RecurrenceType | 'NONE' | 'MASTER' | 'INSTANCE' | 'EXCEPTION';
|
|
364
|
+
interface RecurrenceRule {
|
|
365
|
+
/**
|
|
366
|
+
* Frequency how often the event repeats. Works together with `interval`.
|
|
367
|
+
*
|
|
368
|
+
* Supported values:
|
|
369
|
+
* + `WEEKLY`: The event's recurrence pattern is based on weeks.
|
|
370
|
+
*/
|
|
371
|
+
frequency?: FrequencyWithLiterals;
|
|
372
|
+
/**
|
|
373
|
+
* Interval how often the event repeats. Works together with `frequency`.
|
|
374
|
+
* For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
|
|
375
|
+
* the event repeats every 2 weeks.
|
|
376
|
+
*
|
|
377
|
+
* Min: `1`
|
|
378
|
+
* Max: `4`
|
|
379
|
+
* Default: `1`
|
|
380
|
+
* @min 1
|
|
381
|
+
* @max 4
|
|
382
|
+
*/
|
|
383
|
+
interval?: number | null;
|
|
384
|
+
/**
|
|
385
|
+
* Days of the week when the recurring event takes place.
|
|
386
|
+
* Currently, only a single day is supported.
|
|
387
|
+
*
|
|
388
|
+
* Min: 1 day
|
|
389
|
+
* Max: 1 day
|
|
390
|
+
* @minSize 1
|
|
391
|
+
* @maxSize 1
|
|
392
|
+
*/
|
|
393
|
+
days?: DayWithLiterals$1[];
|
|
394
|
+
/**
|
|
395
|
+
* Date until when the event repeats.
|
|
396
|
+
* If not specified, the event repeats forever.
|
|
397
|
+
*/
|
|
398
|
+
until?: ZonedDate;
|
|
399
|
+
/**
|
|
400
|
+
* Date until when the event repeats
|
|
401
|
+
* adjusted to the `timeZone` of the business
|
|
402
|
+
* [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
403
|
+
* or a different `timeZone` you provide in the call's request.
|
|
404
|
+
* @readonly
|
|
405
|
+
*/
|
|
406
|
+
adjustedUntil?: ZonedDate;
|
|
407
|
+
}
|
|
408
|
+
declare enum Frequency {
|
|
409
|
+
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
410
|
+
/** The event's recurrence pattern is based on weeks. */
|
|
411
|
+
WEEKLY = "WEEKLY"
|
|
412
|
+
}
|
|
413
|
+
/** @enumType */
|
|
414
|
+
type FrequencyWithLiterals = Frequency | 'UNKNOWN_FREQUENCY' | 'WEEKLY';
|
|
415
|
+
declare enum Day$1 {
|
|
416
|
+
/** The recurring event takes place on Mondays. */
|
|
417
|
+
MONDAY = "MONDAY",
|
|
418
|
+
/** The recurring event takes place on Tuesdays. */
|
|
419
|
+
TUESDAY = "TUESDAY",
|
|
420
|
+
/** The recurring event takes place on Wednesday. */
|
|
421
|
+
WEDNESDAY = "WEDNESDAY",
|
|
422
|
+
/** The recurring event takes place on Thursdays. */
|
|
423
|
+
THURSDAY = "THURSDAY",
|
|
424
|
+
/** The recurring event takes place on Fridays. */
|
|
425
|
+
FRIDAY = "FRIDAY",
|
|
426
|
+
/** The recurring event takes place on Saturdays. */
|
|
427
|
+
SATURDAY = "SATURDAY",
|
|
428
|
+
/** The recurring event takes place on Sundays. */
|
|
429
|
+
SUNDAY = "SUNDAY"
|
|
430
|
+
}
|
|
431
|
+
/** @enumType */
|
|
432
|
+
type DayWithLiterals$1 = Day$1 | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
433
|
+
declare enum Transparency {
|
|
434
|
+
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
435
|
+
/** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
|
|
436
|
+
OPAQUE = "OPAQUE",
|
|
437
|
+
/** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
|
|
438
|
+
TRANSPARENT = "TRANSPARENT"
|
|
439
|
+
}
|
|
440
|
+
/** @enumType */
|
|
441
|
+
type TransparencyWithLiterals = Transparency | 'UNKNOWN_TRANSPARENCY' | 'OPAQUE' | 'TRANSPARENT';
|
|
442
|
+
interface Location {
|
|
443
|
+
/**
|
|
444
|
+
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
445
|
+
* ID. Available only for `BUSINESS` locations.
|
|
446
|
+
* @format GUID
|
|
447
|
+
*/
|
|
448
|
+
_id?: string | null;
|
|
449
|
+
/**
|
|
450
|
+
* Location type.
|
|
451
|
+
*
|
|
452
|
+
* Supported values:
|
|
453
|
+
* + `BUSINESS`: The event is held at a business location.
|
|
454
|
+
* + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
|
|
455
|
+
* + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
|
|
456
|
+
*/
|
|
457
|
+
type?: LocationTypeWithLiterals;
|
|
458
|
+
/**
|
|
459
|
+
* Location name. For `BUSINESS` locations, it's identical to the
|
|
460
|
+
* [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
461
|
+
* `name`.
|
|
462
|
+
*
|
|
463
|
+
* Min: 1 character
|
|
464
|
+
* Max: 150 characters
|
|
465
|
+
* @minLength 1
|
|
466
|
+
* @maxLength 150
|
|
467
|
+
*/
|
|
468
|
+
name?: string | null;
|
|
469
|
+
/**
|
|
470
|
+
* Location address. For `BUSINESS` locations, it's identical to the
|
|
471
|
+
* [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
|
|
472
|
+
* `formattedAddress`.
|
|
473
|
+
* @minLength 1
|
|
474
|
+
* @maxLength 300
|
|
475
|
+
*/
|
|
476
|
+
address?: string | null;
|
|
477
|
+
}
|
|
478
|
+
declare enum LocationType {
|
|
479
|
+
/** The event is held at a business location. */
|
|
480
|
+
BUSINESS = "BUSINESS",
|
|
481
|
+
/** The event is held at the customer's location, such as their home or office. */
|
|
482
|
+
CUSTOMER = "CUSTOMER",
|
|
483
|
+
/** The event is held at an address or venue not tied to the business or customer. */
|
|
484
|
+
CUSTOM = "CUSTOM"
|
|
485
|
+
}
|
|
486
|
+
/** @enumType */
|
|
487
|
+
type LocationTypeWithLiterals = LocationType | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
|
|
488
|
+
interface Resource {
|
|
489
|
+
/**
|
|
490
|
+
* Resource ID.
|
|
491
|
+
* @format GUID
|
|
492
|
+
*/
|
|
493
|
+
_id?: string | null;
|
|
494
|
+
/**
|
|
495
|
+
* Resource name.
|
|
496
|
+
* @readonly
|
|
497
|
+
*/
|
|
498
|
+
name?: string | null;
|
|
499
|
+
/**
|
|
500
|
+
* Resource type.
|
|
501
|
+
* @readonly
|
|
502
|
+
*/
|
|
503
|
+
type?: string | null;
|
|
504
|
+
/**
|
|
505
|
+
* Specifies whether the event blocks time in the resource's schedule.
|
|
506
|
+
*
|
|
507
|
+
* Supported values:
|
|
508
|
+
* + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
|
|
509
|
+
* + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
|
|
510
|
+
*
|
|
511
|
+
* Default: `OPAQUE`.
|
|
512
|
+
*/
|
|
513
|
+
transparency?: TransparencyWithLiterals;
|
|
514
|
+
/**
|
|
515
|
+
* Permission role associated with the resource. Refer to the
|
|
516
|
+
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
|
|
517
|
+
* for more information.
|
|
518
|
+
*/
|
|
519
|
+
permissionRole?: RoleWithLiterals;
|
|
520
|
+
}
|
|
521
|
+
declare enum Role {
|
|
522
|
+
/** Full read and write access. */
|
|
523
|
+
WRITER = "WRITER",
|
|
524
|
+
/** Full read access, write access limited to `event.notes`. */
|
|
525
|
+
COMMENTER = "COMMENTER"
|
|
526
|
+
}
|
|
527
|
+
/** @enumType */
|
|
528
|
+
type RoleWithLiterals = Role | 'WRITER' | 'COMMENTER';
|
|
529
|
+
interface Participants {
|
|
530
|
+
/**
|
|
531
|
+
* Total number of participants.
|
|
532
|
+
*
|
|
533
|
+
* Min: `0`
|
|
534
|
+
*/
|
|
535
|
+
total?: number | null;
|
|
536
|
+
/**
|
|
537
|
+
* Full or partial list of the participants.
|
|
538
|
+
*
|
|
539
|
+
* Max: 50 participants
|
|
540
|
+
* @maxSize 50
|
|
541
|
+
*/
|
|
542
|
+
list?: Participant[];
|
|
543
|
+
/**
|
|
544
|
+
* Whether there are more participants for the event than listed.
|
|
545
|
+
*
|
|
546
|
+
* + `false`: The list includes all participants.
|
|
547
|
+
* + `true`: The list doesn't include all participants.
|
|
548
|
+
*/
|
|
549
|
+
hasMore?: boolean | null;
|
|
550
|
+
/**
|
|
551
|
+
* Participant's status.
|
|
552
|
+
*
|
|
553
|
+
* Supported values:
|
|
554
|
+
* + `CONFIRMED`: All participants are confirmed.
|
|
555
|
+
* + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
|
|
556
|
+
*/
|
|
557
|
+
status?: ParticipantsStatusWithLiterals;
|
|
558
|
+
}
|
|
559
|
+
interface Participant {
|
|
560
|
+
/**
|
|
561
|
+
* Participant name.
|
|
562
|
+
*
|
|
563
|
+
* Min: 1 character
|
|
564
|
+
* Max: 200 characters
|
|
565
|
+
* @minLength 1
|
|
566
|
+
* @maxLength 200
|
|
567
|
+
*/
|
|
568
|
+
name?: string | null;
|
|
569
|
+
/**
|
|
570
|
+
* Participant's phone number.
|
|
571
|
+
* @format PHONE
|
|
572
|
+
*/
|
|
573
|
+
phone?: string | null;
|
|
574
|
+
/**
|
|
575
|
+
* Participant's email address.
|
|
576
|
+
* @format EMAIL
|
|
577
|
+
*/
|
|
578
|
+
email?: string | null;
|
|
579
|
+
/**
|
|
580
|
+
* [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
581
|
+
* ID of the participant.
|
|
582
|
+
* @format GUID
|
|
583
|
+
*/
|
|
584
|
+
contactId?: string | null;
|
|
585
|
+
}
|
|
586
|
+
declare enum ParticipantsStatus {
|
|
587
|
+
/** All participants are confirmed. */
|
|
588
|
+
CONFIRMED = "CONFIRMED",
|
|
589
|
+
/** At least one participant isn't confirmed yet. */
|
|
590
|
+
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
591
|
+
}
|
|
592
|
+
/** @enumType */
|
|
593
|
+
type ParticipantsStatusWithLiterals = ParticipantsStatus | 'CONFIRMED' | 'PENDING_CONFIRMATION';
|
|
594
|
+
interface ConferencingDetails {
|
|
595
|
+
/**
|
|
596
|
+
* Conference type. For example, `Zoom`.
|
|
597
|
+
* @deprecated Conference type. For example, `Zoom`.
|
|
598
|
+
* @replacedBy provider
|
|
599
|
+
* @targetRemovalDate 2026-12-01
|
|
600
|
+
*/
|
|
601
|
+
type?: TypeWithLiterals;
|
|
602
|
+
/**
|
|
603
|
+
* URL used by the host to start the conference.
|
|
604
|
+
*
|
|
605
|
+
* Min: 1 character
|
|
606
|
+
* Max: 2000 characters
|
|
607
|
+
* @minLength 1
|
|
608
|
+
* @maxLength 2000
|
|
609
|
+
*/
|
|
610
|
+
hostUrl?: string | null;
|
|
611
|
+
/**
|
|
612
|
+
* URL used by a guest to join the conference.
|
|
613
|
+
*
|
|
614
|
+
* Min: 1 character
|
|
615
|
+
* Max: 2000 characters
|
|
616
|
+
* @minLength 1
|
|
617
|
+
* @maxLength 2000
|
|
618
|
+
*/
|
|
619
|
+
guestUrl?: string | null;
|
|
620
|
+
/**
|
|
621
|
+
* Conference password.
|
|
622
|
+
*
|
|
623
|
+
* Min: 1 character
|
|
624
|
+
* Max: 100 characters
|
|
625
|
+
* @minLength 1
|
|
626
|
+
* @maxLength 100
|
|
627
|
+
*/
|
|
628
|
+
password?: string | null;
|
|
629
|
+
/**
|
|
630
|
+
* Conference ID in an external system.
|
|
631
|
+
*
|
|
632
|
+
* Min: 1 character
|
|
633
|
+
* Max: 150 characters
|
|
634
|
+
* @minLength 1
|
|
635
|
+
* @maxLength 150
|
|
636
|
+
*/
|
|
637
|
+
externalId?: string | null;
|
|
638
|
+
/** Conferencing provider information. */
|
|
639
|
+
provider?: Provider;
|
|
640
|
+
}
|
|
641
|
+
declare enum ProviderType {
|
|
642
|
+
/** Custom conferencing link manually configured by the user. */
|
|
643
|
+
CUSTOM = "CUSTOM",
|
|
644
|
+
/** Online meeting provider integrated via an app. */
|
|
645
|
+
ONLINE_MEETING = "ONLINE_MEETING"
|
|
646
|
+
}
|
|
647
|
+
/** @enumType */
|
|
648
|
+
type ProviderTypeWithLiterals = ProviderType | 'CUSTOM' | 'ONLINE_MEETING';
|
|
649
|
+
interface OnlineMeetingInfo {
|
|
650
|
+
/** @format GUID */
|
|
651
|
+
appId?: string;
|
|
652
|
+
}
|
|
653
|
+
declare enum Type {
|
|
654
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
655
|
+
ZOOM = "ZOOM",
|
|
656
|
+
CUSTOM = "CUSTOM"
|
|
657
|
+
}
|
|
658
|
+
/** @enumType */
|
|
659
|
+
type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
|
|
660
|
+
interface Provider extends ProviderProviderInfoOneOf {
|
|
661
|
+
/** Information about online meeting providers. */
|
|
662
|
+
onlineMeetingInfo?: OnlineMeetingInfo;
|
|
663
|
+
providerType?: ProviderTypeWithLiterals;
|
|
664
|
+
}
|
|
665
|
+
/** @oneof */
|
|
666
|
+
interface ProviderProviderInfoOneOf {
|
|
667
|
+
/** Information about online meeting providers. */
|
|
668
|
+
onlineMeetingInfo?: OnlineMeetingInfo;
|
|
669
|
+
}
|
|
670
|
+
declare enum Field$1 {
|
|
671
|
+
/** `title` is inherited from the schedule or `MASTER` event. */
|
|
672
|
+
TITLE = "TITLE",
|
|
673
|
+
/** `timeZone` is inherited from the schedule or `MASTER` event. */
|
|
674
|
+
TIME_ZONE = "TIME_ZONE",
|
|
675
|
+
/** `start` and `end` are inherited from the `MASTER` event. */
|
|
676
|
+
TIME = "TIME",
|
|
677
|
+
/** `location` is inherited from the schedule or `MASTER` event. */
|
|
678
|
+
LOCATION = "LOCATION",
|
|
679
|
+
/** `resources` is inherited from the `MASTER` event. */
|
|
680
|
+
RESOURCES = "RESOURCES",
|
|
681
|
+
/** `capacity` is inherited from the schedule or `MASTER` event. */
|
|
682
|
+
CAPACITY = "CAPACITY",
|
|
683
|
+
/** `participants` is inherited from the `MASTER` event. */
|
|
684
|
+
PARTICIPANTS = "PARTICIPANTS",
|
|
685
|
+
/** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
|
|
686
|
+
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
687
|
+
}
|
|
688
|
+
/** @enumType */
|
|
689
|
+
type FieldWithLiterals = Field$1 | 'TITLE' | 'TIME_ZONE' | 'TIME' | 'LOCATION' | 'RESOURCES' | 'CAPACITY' | 'PARTICIPANTS' | 'CONFERENCING_DETAILS';
|
|
690
|
+
interface Permission {
|
|
691
|
+
/**
|
|
692
|
+
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
693
|
+
* granted the permission.
|
|
694
|
+
*/
|
|
695
|
+
identity?: CommonIdentificationData;
|
|
696
|
+
/**
|
|
697
|
+
* Permission role.
|
|
698
|
+
*
|
|
699
|
+
* Supported values:
|
|
700
|
+
* + `WRITER`: Full read and write access.
|
|
701
|
+
* + `COMMENTER`: Full read access, write access limited to `event.notes`.
|
|
702
|
+
*/
|
|
703
|
+
role?: RoleWithLiterals;
|
|
704
|
+
}
|
|
705
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
706
|
+
/**
|
|
707
|
+
* ID of a Wix user. For example, the site owner or a
|
|
708
|
+
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
709
|
+
* @format GUID
|
|
710
|
+
*/
|
|
711
|
+
wixUserId?: string;
|
|
712
|
+
}
|
|
713
|
+
/** @oneof */
|
|
714
|
+
interface CommonIdentificationDataIdOneOf {
|
|
715
|
+
/**
|
|
716
|
+
* ID of a Wix user. For example, the site owner or a
|
|
717
|
+
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
718
|
+
* @format GUID
|
|
719
|
+
*/
|
|
720
|
+
wixUserId?: string;
|
|
721
|
+
}
|
|
722
|
+
interface ExtendedFields$2 {
|
|
723
|
+
/**
|
|
724
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
725
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
726
|
+
*
|
|
727
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
728
|
+
*
|
|
729
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
730
|
+
*/
|
|
731
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
732
|
+
}
|
|
733
|
+
//#endregion
|
|
734
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/links.d.ts
|
|
735
|
+
type LinkTarget = '_self' | '_blank';
|
|
736
|
+
/**
|
|
737
|
+
* A link to a URL, used for navigation within components.
|
|
738
|
+
*
|
|
739
|
+
* @example
|
|
740
|
+
* ```tsx
|
|
741
|
+
* import type { Link } from '@wix/editor-react-types';
|
|
742
|
+
*
|
|
743
|
+
* interface MyComponentProps {
|
|
744
|
+
* link?: Link;
|
|
745
|
+
* }
|
|
746
|
+
* ```
|
|
747
|
+
*/
|
|
748
|
+
type Link = {
|
|
749
|
+
/**
|
|
750
|
+
* The link URL. For partial links (see `pageRole`), this is the router prefix
|
|
751
|
+
* (e.g. `https://www.my-site.com/prefix`) rather than a fully resolved URL.
|
|
752
|
+
*/
|
|
753
|
+
href?: string;
|
|
754
|
+
/**
|
|
755
|
+
* Where this link should open.
|
|
756
|
+
* - `'_self'` — opens in the same page.
|
|
757
|
+
* - `'_blank'` — opens in a new tab.
|
|
758
|
+
*/
|
|
759
|
+
target?: LinkTarget; /** The `rel` attribute of the link. Accepts LinkRel values separated by a space. */
|
|
760
|
+
rel?: string;
|
|
761
|
+
/**
|
|
762
|
+
* Page role identifier. Present only on partial links, where only the router prefix is
|
|
763
|
+
* known and the full URL format is owned by the Router/App. Applications can use such
|
|
764
|
+
* links in functions to resolve the complete URL at runtime (e.g. for binding links).
|
|
765
|
+
* Resolved links will not have this field.
|
|
766
|
+
*/
|
|
767
|
+
pageRole?: string;
|
|
768
|
+
};
|
|
769
|
+
//#endregion
|
|
770
|
+
//#region ../../node_modules/@wix/auto_sdk_bookings_service-options-and-variants/build/es/index.typings.d.mts
|
|
771
|
+
/**
|
|
772
|
+
* The `serviceOptionsAndVariants` object links a [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction)
|
|
773
|
+
* to its variants.
|
|
774
|
+
* You can use it to offer customers different prices for a service,
|
|
775
|
+
* depending on which choices they book.
|
|
776
|
+
*/
|
|
777
|
+
interface ServiceOptionsAndVariants$1 {
|
|
778
|
+
/**
|
|
779
|
+
* ID of the `serviceOptionsAndVariants` object.
|
|
780
|
+
* @format GUID
|
|
781
|
+
* @readonly
|
|
782
|
+
*/
|
|
783
|
+
_id?: string | null;
|
|
784
|
+
/**
|
|
785
|
+
* ID of the service related to these options and variants.
|
|
786
|
+
* @format GUID
|
|
787
|
+
* @immutable
|
|
788
|
+
*/
|
|
789
|
+
serviceId?: string | null;
|
|
790
|
+
/** Service options. Note that currently only a single option is supported per service. */
|
|
791
|
+
options?: ServiceOptions;
|
|
792
|
+
/** Information about the service's variants. */
|
|
793
|
+
variants?: ServiceVariants;
|
|
794
|
+
/**
|
|
795
|
+
* Price of the cheapest service variant.
|
|
796
|
+
* @readonly
|
|
797
|
+
*/
|
|
798
|
+
minPrice?: Money$1;
|
|
799
|
+
/**
|
|
800
|
+
* Price of the most expensive service variant.
|
|
801
|
+
* @readonly
|
|
802
|
+
*/
|
|
803
|
+
maxPrice?: Money$1;
|
|
804
|
+
/**
|
|
805
|
+
* Revision number, which increments by 1 each time the `serviceOptionsAndVariants` object is updated.
|
|
806
|
+
* To prevent conflicting changes,
|
|
807
|
+
* the current revision must be passed when updating and deleting the `serviceOptionsAndVariants` object.
|
|
808
|
+
*
|
|
809
|
+
* Ignored when creating a `serviceOptionsAndVariants` object.
|
|
810
|
+
* @immutable
|
|
811
|
+
*/
|
|
812
|
+
revision?: string | null;
|
|
813
|
+
/** Extensions enabling users to save custom data related to service options and variants. */
|
|
814
|
+
extendedFields?: ExtendedFields$1;
|
|
815
|
+
}
|
|
816
|
+
interface ServiceOption extends ServiceOptionOptionSpecificDataOneOf {
|
|
817
|
+
/** Details about the custom option. Available only for `CUSTOM` options. */
|
|
818
|
+
customData?: CustomServiceOption;
|
|
819
|
+
durationData?: DurationServiceOption;
|
|
820
|
+
/**
|
|
821
|
+
* ID of the service option.
|
|
822
|
+
* @format GUID
|
|
823
|
+
*/
|
|
824
|
+
_id?: string;
|
|
825
|
+
/** Type of the service option. */
|
|
826
|
+
type?: ServiceOptionTypeWithLiterals;
|
|
827
|
+
}
|
|
828
|
+
/** @oneof */
|
|
829
|
+
interface ServiceOptionOptionSpecificDataOneOf {
|
|
830
|
+
/** Details about the custom option. Available only for `CUSTOM` options. */
|
|
831
|
+
customData?: CustomServiceOption;
|
|
832
|
+
durationData?: DurationServiceOption;
|
|
833
|
+
}
|
|
834
|
+
declare enum ServiceOptionType {
|
|
835
|
+
/** There is no information about the option type. */
|
|
836
|
+
UNKNOWN = "UNKNOWN",
|
|
837
|
+
/**
|
|
838
|
+
* The service option is based on a custom parameter. For example, age group,
|
|
839
|
+
* booked equipment, or appointment timing.
|
|
840
|
+
*/
|
|
841
|
+
CUSTOM = "CUSTOM",
|
|
842
|
+
/**
|
|
843
|
+
* It's a [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)
|
|
844
|
+
* based option.
|
|
845
|
+
*/
|
|
846
|
+
STAFF_MEMBER = "STAFF_MEMBER",
|
|
847
|
+
/** It's a duration-based option. */
|
|
848
|
+
DURATION = "DURATION",
|
|
849
|
+
/**
|
|
850
|
+
* The price is resolved from rules based on when the service is booked
|
|
851
|
+
* (days and hours, months, or a date range).
|
|
852
|
+
* @documentationMaturity preview
|
|
853
|
+
*/
|
|
854
|
+
DATE_TIME = "DATE_TIME",
|
|
855
|
+
/**
|
|
856
|
+
* The price is resolved from rules based on the number of participants.
|
|
857
|
+
* @documentationMaturity preview
|
|
858
|
+
*/
|
|
859
|
+
NUMBER_OF_PARTICIPANTS = "NUMBER_OF_PARTICIPANTS",
|
|
860
|
+
/**
|
|
861
|
+
* The price is resolved from pricing tiers based on the booking duration range.
|
|
862
|
+
* @documentationMaturity preview
|
|
863
|
+
*/
|
|
864
|
+
DURATION_RANGE = "DURATION_RANGE"
|
|
865
|
+
}
|
|
866
|
+
/** @enumType */
|
|
867
|
+
type ServiceOptionTypeWithLiterals = ServiceOptionType | 'UNKNOWN' | 'CUSTOM' | 'STAFF_MEMBER' | 'DURATION' | 'DATE_TIME' | 'NUMBER_OF_PARTICIPANTS' | 'DURATION_RANGE';
|
|
868
|
+
interface CustomServiceOption {
|
|
869
|
+
/**
|
|
870
|
+
* Name of the service option. For example, `Age group`, `Location`, `Equipment`,
|
|
871
|
+
* or `Time`.
|
|
872
|
+
* @maxLength 255
|
|
873
|
+
*/
|
|
874
|
+
name?: string;
|
|
875
|
+
/**
|
|
876
|
+
* Available choices for the service option. For example, `child`, `student`,
|
|
877
|
+
* `adult`, and `senior` for a service option named `Age group`. Each value must
|
|
878
|
+
* be unique. The value's case is ignored, meaning `Child` and `child` are
|
|
879
|
+
* considered to be identical. Currently, only a single choice is supported
|
|
880
|
+
* because a service can have only a single option.
|
|
881
|
+
*
|
|
882
|
+
* Max: 1 choice
|
|
883
|
+
* @maxSize 100
|
|
884
|
+
* @maxLength 255
|
|
885
|
+
*/
|
|
886
|
+
choices?: string[];
|
|
887
|
+
}
|
|
888
|
+
interface DurationServiceOption {
|
|
889
|
+
/**
|
|
890
|
+
* Optional name of the duration option. For example, `Short Class`, or
|
|
891
|
+
* `Extended Class`.
|
|
892
|
+
* @maxLength 255
|
|
893
|
+
*/
|
|
894
|
+
name?: string | null;
|
|
895
|
+
}
|
|
896
|
+
interface ServiceVariant {
|
|
897
|
+
/**
|
|
898
|
+
* Choices for the service option. Currently, only a single choice is supported
|
|
899
|
+
* because a service can have only a single option.
|
|
900
|
+
*
|
|
901
|
+
* Max: 1 choice
|
|
902
|
+
* @minSize 1
|
|
903
|
+
* @maxSize 1
|
|
904
|
+
*/
|
|
905
|
+
choices?: ServiceChoice[];
|
|
906
|
+
/** Information about the service variant's price. */
|
|
907
|
+
price?: Money$1;
|
|
908
|
+
}
|
|
909
|
+
interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
910
|
+
/**
|
|
911
|
+
* Name of the custom choice.
|
|
912
|
+
* @maxLength 255
|
|
913
|
+
*/
|
|
914
|
+
custom?: string;
|
|
915
|
+
/**
|
|
916
|
+
* ID of the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction)
|
|
917
|
+
* associated with the [staff member](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/introduction)
|
|
918
|
+
* providing the service.
|
|
919
|
+
* @format GUID
|
|
920
|
+
*/
|
|
921
|
+
staffMemberId?: string;
|
|
922
|
+
/** Information about the option's duration. */
|
|
923
|
+
duration?: Duration;
|
|
924
|
+
/** A rule resolving the price by when the service is booked. Available only for `DATE_TIME` options. */
|
|
925
|
+
dateTime?: DateTimeRule;
|
|
926
|
+
/** A rule resolving the price by the number of participants. Available only for `NUMBER_OF_PARTICIPANTS` options. */
|
|
927
|
+
participantRange?: ParticipantsRange;
|
|
928
|
+
/**
|
|
929
|
+
* A duration range tier resolving the price by how long the booking is.
|
|
930
|
+
* Available only for `DURATION_RANGE` options.
|
|
931
|
+
*/
|
|
932
|
+
durationRange?: DurationRange$1;
|
|
933
|
+
/**
|
|
934
|
+
* ID of the service option.
|
|
935
|
+
* @format GUID
|
|
936
|
+
*/
|
|
937
|
+
optionId?: string;
|
|
938
|
+
}
|
|
939
|
+
/** @oneof */
|
|
940
|
+
interface ServiceChoiceChoiceOneOf {
|
|
941
|
+
/**
|
|
942
|
+
* Name of the custom choice.
|
|
943
|
+
* @maxLength 255
|
|
944
|
+
*/
|
|
945
|
+
custom?: string;
|
|
946
|
+
/**
|
|
947
|
+
* ID of the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction)
|
|
948
|
+
* associated with the [staff member](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/introduction)
|
|
949
|
+
* providing the service.
|
|
950
|
+
* @format GUID
|
|
951
|
+
*/
|
|
952
|
+
staffMemberId?: string;
|
|
953
|
+
/** Information about the option's duration. */
|
|
954
|
+
duration?: Duration;
|
|
955
|
+
/** A rule resolving the price by when the service is booked. Available only for `DATE_TIME` options. */
|
|
956
|
+
dateTime?: DateTimeRule;
|
|
957
|
+
/** A rule resolving the price by the number of participants. Available only for `NUMBER_OF_PARTICIPANTS` options. */
|
|
958
|
+
participantRange?: ParticipantsRange;
|
|
959
|
+
/**
|
|
960
|
+
* A duration range tier resolving the price by how long the booking is.
|
|
961
|
+
* Available only for `DURATION_RANGE` options.
|
|
962
|
+
*/
|
|
963
|
+
durationRange?: DurationRange$1;
|
|
964
|
+
}
|
|
965
|
+
interface Duration {
|
|
966
|
+
/**
|
|
967
|
+
* Duration of the service in minutes.
|
|
968
|
+
*
|
|
969
|
+
* Min: `1` minute
|
|
970
|
+
* Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
|
|
971
|
+
* @min 1
|
|
972
|
+
* @max 44639
|
|
973
|
+
*/
|
|
974
|
+
minutes?: number;
|
|
975
|
+
/**
|
|
976
|
+
* Name of the duration option.
|
|
977
|
+
*
|
|
978
|
+
* Default: Human-readable text of `minutes`. For example, `1 hr 30 min`.
|
|
979
|
+
* @maxLength 255
|
|
980
|
+
*/
|
|
981
|
+
name?: string | null;
|
|
982
|
+
}
|
|
983
|
+
interface DateTimeRule extends DateTimeRuleRuleOneOf {
|
|
984
|
+
/** Matches when the booked slot falls on one of the given days within the time window. */
|
|
985
|
+
hoursAndDaysRule?: HoursAndDaysRule;
|
|
986
|
+
/** Matches when the booked slot falls in one of the given months. */
|
|
987
|
+
monthsRule?: MonthsRule;
|
|
988
|
+
/** Matches when the booked slot falls within the date range. */
|
|
989
|
+
dateRangeRule?: DateRangeRule;
|
|
990
|
+
/** Which kind of rule this is. Must match the populated `rule` case. */
|
|
991
|
+
ruleType?: DateTimeRuleTypeWithLiterals;
|
|
992
|
+
/**
|
|
993
|
+
* Optional name of the rule. For example, `Weekend mornings`, or `Holiday season`.
|
|
994
|
+
* @maxLength 255
|
|
995
|
+
*/
|
|
996
|
+
name?: string | null;
|
|
997
|
+
}
|
|
998
|
+
/** @oneof */
|
|
999
|
+
interface DateTimeRuleRuleOneOf {
|
|
1000
|
+
/** Matches when the booked slot falls on one of the given days within the time window. */
|
|
1001
|
+
hoursAndDaysRule?: HoursAndDaysRule;
|
|
1002
|
+
/** Matches when the booked slot falls in one of the given months. */
|
|
1003
|
+
monthsRule?: MonthsRule;
|
|
1004
|
+
/** Matches when the booked slot falls within the date range. */
|
|
1005
|
+
dateRangeRule?: DateRangeRule;
|
|
1006
|
+
}
|
|
1007
|
+
declare enum DateTimeRuleType {
|
|
1008
|
+
HOURS_AND_DAYS = "HOURS_AND_DAYS",
|
|
1009
|
+
MONTHS = "MONTHS",
|
|
1010
|
+
DATE_RANGE = "DATE_RANGE"
|
|
1011
|
+
}
|
|
1012
|
+
/** @enumType */
|
|
1013
|
+
type DateTimeRuleTypeWithLiterals = DateTimeRuleType | 'HOURS_AND_DAYS' | 'MONTHS' | 'DATE_RANGE';
|
|
1014
|
+
interface HoursAndDaysRule {
|
|
1015
|
+
/**
|
|
1016
|
+
* Days the rule applies to. The time window is evaluated in the business time zone.
|
|
1017
|
+
* @minSize 1
|
|
1018
|
+
* @maxSize 7
|
|
1019
|
+
*/
|
|
1020
|
+
days?: DayWithLiterals[];
|
|
1021
|
+
/**
|
|
1022
|
+
* Start of the time window in `HH:mm` format, inclusive. Evaluated in the business time zone.
|
|
1023
|
+
* @format LOCAL_TIME
|
|
1024
|
+
*/
|
|
1025
|
+
startTime?: string | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* End of the time window in `HH:mm` format, exclusive. When earlier than `start_time` the window wraps past midnight.
|
|
1028
|
+
* @format LOCAL_TIME
|
|
1029
|
+
*/
|
|
1030
|
+
endTime?: string | null;
|
|
1031
|
+
}
|
|
1032
|
+
declare enum Day {
|
|
1033
|
+
MONDAY = "MONDAY",
|
|
1034
|
+
TUESDAY = "TUESDAY",
|
|
1035
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1036
|
+
THURSDAY = "THURSDAY",
|
|
1037
|
+
FRIDAY = "FRIDAY",
|
|
1038
|
+
SATURDAY = "SATURDAY",
|
|
1039
|
+
SUNDAY = "SUNDAY"
|
|
1040
|
+
}
|
|
1041
|
+
/** @enumType */
|
|
1042
|
+
type DayWithLiterals = Day | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1043
|
+
interface MonthsRule {
|
|
1044
|
+
/**
|
|
1045
|
+
* Months the rule applies to, as numbers `1`-`12`. Each value must be unique.
|
|
1046
|
+
*
|
|
1047
|
+
* Min: 1 month
|
|
1048
|
+
* Max: 12 months
|
|
1049
|
+
* @minSize 1
|
|
1050
|
+
* @maxSize 12
|
|
1051
|
+
* @min 1
|
|
1052
|
+
* @max 12
|
|
1053
|
+
*/
|
|
1054
|
+
months?: number[];
|
|
1055
|
+
}
|
|
1056
|
+
interface DateRangeRule {
|
|
1057
|
+
/**
|
|
1058
|
+
* Start of the date range in `YYYY-MM-DDThh:mm:ss` format, inclusive. Evaluated in the business time zone.
|
|
1059
|
+
* @format LOCAL_DATE_TIME
|
|
1060
|
+
*/
|
|
1061
|
+
localStartDate?: string | null;
|
|
1062
|
+
/**
|
|
1063
|
+
* End of the date range in `YYYY-MM-DDThh:mm:ss` format, inclusive. Evaluated in the business time zone.
|
|
1064
|
+
* @format LOCAL_DATE_TIME
|
|
1065
|
+
*/
|
|
1066
|
+
localEndDate?: string | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Whether the date range repeats every year on the same month and day.
|
|
1069
|
+
* The range dates define both the window (month and day) and the first occurrence.
|
|
1070
|
+
*
|
|
1071
|
+
* Changing this field from `true` to `false` pins the range to the current year:
|
|
1072
|
+
* `local_start_date` and `local_end_date` then apply to a single concrete year
|
|
1073
|
+
* instead of repeating annually.
|
|
1074
|
+
*/
|
|
1075
|
+
repeatsAnnually?: boolean | null;
|
|
1076
|
+
}
|
|
1077
|
+
interface ParticipantsRange {
|
|
1078
|
+
/**
|
|
1079
|
+
* Lower bound of the participants range, inclusive.
|
|
1080
|
+
*
|
|
1081
|
+
* Min: `1`
|
|
1082
|
+
* Max: `999`
|
|
1083
|
+
* @min 1
|
|
1084
|
+
* @max 999
|
|
1085
|
+
*/
|
|
1086
|
+
minParticipants?: number | null;
|
|
1087
|
+
/**
|
|
1088
|
+
* Upper bound of the participants range, inclusive.
|
|
1089
|
+
*
|
|
1090
|
+
* Min: `1`
|
|
1091
|
+
* Max: `999`
|
|
1092
|
+
* @min 1
|
|
1093
|
+
* @max 999
|
|
1094
|
+
*/
|
|
1095
|
+
maxParticipants?: number | null;
|
|
1096
|
+
/**
|
|
1097
|
+
* Optional name of the range. For example, `Small group`, or `Large group`.
|
|
1098
|
+
* @maxLength 255
|
|
1099
|
+
*/
|
|
1100
|
+
name?: string | null;
|
|
1101
|
+
}
|
|
1102
|
+
interface DurationRange$1 extends DurationRangeConfigOneOf$1 {
|
|
1103
|
+
/** Tier bounds in minutes. Set when `unit_type` is `HOUR`. */
|
|
1104
|
+
hourOptions?: HourlyConfig$1;
|
|
1105
|
+
/** Tier bounds in days. Set when `unit_type` is `DAY`. */
|
|
1106
|
+
dayOptions?: DailyConfig$1;
|
|
1107
|
+
/**
|
|
1108
|
+
* Display name for this tier. For example, `1–3 hours` or `4–7 days`.
|
|
1109
|
+
* @maxLength 255
|
|
1110
|
+
*/
|
|
1111
|
+
name?: string | null;
|
|
1112
|
+
/** Unit type for this tier. */
|
|
1113
|
+
unitType?: DurationUnitTypeWithLiterals;
|
|
1114
|
+
}
|
|
1115
|
+
/** @oneof */
|
|
1116
|
+
interface DurationRangeConfigOneOf$1 {
|
|
1117
|
+
/** Tier bounds in minutes. Set when `unit_type` is `HOUR`. */
|
|
1118
|
+
hourOptions?: HourlyConfig$1;
|
|
1119
|
+
/** Tier bounds in days. Set when `unit_type` is `DAY`. */
|
|
1120
|
+
dayOptions?: DailyConfig$1;
|
|
1121
|
+
}
|
|
1122
|
+
declare enum DurationUnitType {
|
|
1123
|
+
/** Duration is expressed in minutes (hourly services). */
|
|
1124
|
+
HOUR = "HOUR",
|
|
1125
|
+
/** Duration is expressed in days (daily services). */
|
|
1126
|
+
DAY = "DAY"
|
|
1127
|
+
}
|
|
1128
|
+
/** @enumType */
|
|
1129
|
+
type DurationUnitTypeWithLiterals = DurationUnitType | 'HOUR' | 'DAY';
|
|
1130
|
+
/** Hourly bounds for a duration range tier. Durations are in minutes. */
|
|
1131
|
+
interface HourlyConfig$1 {
|
|
1132
|
+
/**
|
|
1133
|
+
* @min 30
|
|
1134
|
+
* @max 1440
|
|
1135
|
+
*/
|
|
1136
|
+
minDurationInMinutes?: number;
|
|
1137
|
+
/**
|
|
1138
|
+
* @min 30
|
|
1139
|
+
* @max 1440
|
|
1140
|
+
*/
|
|
1141
|
+
maxDurationInMinutes?: number;
|
|
1142
|
+
}
|
|
1143
|
+
/** Daily bounds for a duration range tier. Durations are in days. */
|
|
1144
|
+
interface DailyConfig$1 {
|
|
1145
|
+
/**
|
|
1146
|
+
* @min 1
|
|
1147
|
+
* @max 40
|
|
1148
|
+
*/
|
|
1149
|
+
minDurationInDays?: number;
|
|
1150
|
+
/**
|
|
1151
|
+
* @min 1
|
|
1152
|
+
* @max 40
|
|
1153
|
+
*/
|
|
1154
|
+
maxDurationInDays?: number;
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* Money.
|
|
1158
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
1159
|
+
*/
|
|
1160
|
+
interface Money$1 {
|
|
1161
|
+
/**
|
|
1162
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
1163
|
+
* @format DECIMAL_VALUE
|
|
1164
|
+
* @decimalValue options { gte:0, maxScale:2 }
|
|
1165
|
+
*/
|
|
1166
|
+
value?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
1169
|
+
* @format CURRENCY
|
|
1170
|
+
*/
|
|
1171
|
+
currency?: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
|
|
1174
|
+
* @maxLength 50
|
|
1175
|
+
*/
|
|
1176
|
+
formattedValue?: string | null;
|
|
1177
|
+
}
|
|
1178
|
+
interface ServiceOptions {
|
|
1179
|
+
/**
|
|
1180
|
+
* Values of the service options.
|
|
1181
|
+
*
|
|
1182
|
+
* Max: 1 service option
|
|
1183
|
+
* @minSize 1
|
|
1184
|
+
* @maxSize 1
|
|
1185
|
+
*/
|
|
1186
|
+
values?: ServiceOption[];
|
|
1187
|
+
}
|
|
1188
|
+
interface ServiceVariants {
|
|
1189
|
+
/**
|
|
1190
|
+
* Values of the service variants.
|
|
1191
|
+
* @minSize 1
|
|
1192
|
+
* @maxSize 100
|
|
1193
|
+
*/
|
|
1194
|
+
values?: ServiceVariant[];
|
|
1195
|
+
}
|
|
1196
|
+
interface ExtendedFields$1 {
|
|
1197
|
+
/**
|
|
1198
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1199
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
1200
|
+
*
|
|
1201
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
1202
|
+
*
|
|
1203
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
1204
|
+
*/
|
|
1205
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
1206
|
+
}
|
|
1207
|
+
//#endregion
|
|
1208
|
+
//#region ../../node_modules/@wix/auto_sdk_bookings_services/build/es/bookings-services-v2-service-services.universal-Bf4TC5aj.d.mts
|
|
1209
|
+
/** The `service` object represents an offering that a business provides to its customers. */
|
|
1210
|
+
interface Service$1 {
|
|
1211
|
+
/**
|
|
1212
|
+
* Service ID.
|
|
1213
|
+
* @format GUID
|
|
1214
|
+
* @readonly
|
|
1215
|
+
*/
|
|
1216
|
+
_id?: string | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* ID of the app associated with the service. You can't update `appId`.
|
|
1219
|
+
* Services are displayed in Wix Bookings only if they are associated with the Wix Bookings appId or have no associated app ID.
|
|
1220
|
+
* Default: `13d21c63-b5ec-5912-8397-c3a5ddb27a97` (Wix Bookings app ID)
|
|
1221
|
+
* For services from Wix apps, the following values apply:
|
|
1222
|
+
* - Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
1223
|
+
* - Wix Services: `"cc552162-24a4-45e0-9695-230c4931ef40"`
|
|
1224
|
+
* - Wix Meetings: `"6646a75c-2027-4f49-976c-58f3d713ed0f"`.<!-- [Scheduling Form Fields](https://dev.wix.com/docs/api-reference/business-solutions/bookings/about-scheduling-form-fields) services also use this app ID. Use `createdByAppId` to distinguish between Wix Meetings and Scheduling Form Fields services.-->
|
|
1225
|
+
* [Full list of apps created by Wix](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-apps-created-by-wix).
|
|
1226
|
+
* <!-- TODO: Uncomment when Platform docs are published - Learn more about [app identity in the Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/app-identity-in-the-bookings-platform). -->
|
|
1227
|
+
* @format GUID
|
|
1228
|
+
* @immutable
|
|
1229
|
+
*/
|
|
1230
|
+
appId?: string | null;
|
|
1231
|
+
/**
|
|
1232
|
+
* ID of the app that created the service. This field is used for analytics, auditing, and tracking creation sources.
|
|
1233
|
+
* This read-only field is automatically populated during service creation by checking these sources in order:
|
|
1234
|
+
* 1. The caller's App ID from the request identity context.
|
|
1235
|
+
* 2. The service's `appId` field.
|
|
1236
|
+
* 3. The Wix Bookings App ID (`13d21c63-b5ec-5912-8397-c3a5ddb27a97`) as the final fallback.
|
|
1237
|
+
* <!-- TODO: Uncomment when Platform docs are published - Learn more about [app identity in the Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/app-identity-in-the-bookings-platform). -->
|
|
1238
|
+
* @format GUID
|
|
1239
|
+
* @readonly
|
|
1240
|
+
*/
|
|
1241
|
+
createdByAppId?: string | null;
|
|
1242
|
+
/**
|
|
1243
|
+
* Service type.
|
|
1244
|
+
* Learn more about [service types](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types).
|
|
1245
|
+
*/
|
|
1246
|
+
type?: ServiceTypeWithLiterals;
|
|
1247
|
+
/** Order of the service within a [category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object). */
|
|
1248
|
+
sortOrder?: number | null;
|
|
1249
|
+
/**
|
|
1250
|
+
* Service name.
|
|
1251
|
+
* @maxLength 400
|
|
1252
|
+
* @minLength 1
|
|
1253
|
+
*/
|
|
1254
|
+
name?: string | null;
|
|
1255
|
+
/**
|
|
1256
|
+
* Service description. For example, `High-class hair styling, cuts, straightening and color`.
|
|
1257
|
+
* @maxLength 7000
|
|
1258
|
+
*/
|
|
1259
|
+
description?: string | null;
|
|
1260
|
+
/**
|
|
1261
|
+
* Short service description, such as `Hair styling`.
|
|
1262
|
+
* @maxLength 6000
|
|
1263
|
+
*/
|
|
1264
|
+
tagLine?: string | null;
|
|
1265
|
+
/**
|
|
1266
|
+
* Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.
|
|
1267
|
+
* @min 1
|
|
1268
|
+
* @max 1000
|
|
1269
|
+
*/
|
|
1270
|
+
defaultCapacity?: number | null;
|
|
1271
|
+
/** Media associated with the service. */
|
|
1272
|
+
media?: Media;
|
|
1273
|
+
/** Whether the service is hidden from Wix Bookings pages and widgets. */
|
|
1274
|
+
hidden?: boolean | null;
|
|
1275
|
+
/**
|
|
1276
|
+
* [Category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v2/introduction)
|
|
1277
|
+
* the service is associated with. Services aren't automatically assigned to a category.
|
|
1278
|
+
* Without an associated category, the service isn't visible on the live site.
|
|
1279
|
+
*/
|
|
1280
|
+
category?: V2Category;
|
|
1281
|
+
/** Form the customer filled out when booking the service. */
|
|
1282
|
+
form?: Form;
|
|
1283
|
+
/**
|
|
1284
|
+
* Payment options for booking the service.
|
|
1285
|
+
* Learn more about [service payments](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments).
|
|
1286
|
+
*/
|
|
1287
|
+
payment?: Payment;
|
|
1288
|
+
/** Online booking settings. */
|
|
1289
|
+
onlineBooking?: OnlineBooking;
|
|
1290
|
+
/** Conferencing options for the service. */
|
|
1291
|
+
conferencing?: Conferencing;
|
|
1292
|
+
/**
|
|
1293
|
+
* The locations this service is offered at. Read more about [service locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations).
|
|
1294
|
+
* @immutable
|
|
1295
|
+
* @maxSize 500
|
|
1296
|
+
*/
|
|
1297
|
+
locations?: V2Location[];
|
|
1298
|
+
/**
|
|
1299
|
+
* [Policy](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)
|
|
1300
|
+
* determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins.
|
|
1301
|
+
*/
|
|
1302
|
+
bookingPolicy?: BookingPolicy;
|
|
1303
|
+
/**
|
|
1304
|
+
* The service's [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
|
|
1305
|
+
* which can be used to manage the service's [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
1306
|
+
*/
|
|
1307
|
+
schedule?: Schedule;
|
|
1308
|
+
/**
|
|
1309
|
+
* IDs of the [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) associated with the [staff members](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-members/introduction) providing the service.
|
|
1310
|
+
* Note that these are the resource IDs, not the staff member IDs.
|
|
1311
|
+
*
|
|
1312
|
+
* For appointment-based services, set this field when creating or updating the service.
|
|
1313
|
+
* For classes and courses, this field is read-only and is automatically derived from staff assigned to the service's recurring scheduled sessions.
|
|
1314
|
+
* Staff assigned only to single, non-recurring events are not included.
|
|
1315
|
+
* Once all of a staff member's upcoming recurring sessions have ended, their ID is removed from this field.
|
|
1316
|
+
* To retrieve the full list of staff for classes or courses, query the service's calendar events instead.
|
|
1317
|
+
* Learn more about [retrieving staff for classes and courses](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/sample-flows#retrieve-staff-members-for-a-class-or-course).
|
|
1318
|
+
* @maxSize 220
|
|
1319
|
+
* @format GUID
|
|
1320
|
+
*/
|
|
1321
|
+
staffMemberIds?: string[];
|
|
1322
|
+
/** Staff members details. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified. */
|
|
1323
|
+
staffMemberDetails?: StaffMemberDetails;
|
|
1324
|
+
/**
|
|
1325
|
+
* Information about which resources must be available so customers can book the service.
|
|
1326
|
+
* For example, a meeting room or equipment.
|
|
1327
|
+
* Some nested fields are only returned when specific conditional fields are requested:
|
|
1328
|
+
* pass `RESOURCE_TYPE_DETAILS` to retrieve `resourceType.name`, and `RESOURCE_DETAILS` to retrieve `resourceDetails.resources`.
|
|
1329
|
+
* @maxSize 8
|
|
1330
|
+
*/
|
|
1331
|
+
serviceResources?: ServiceResource[];
|
|
1332
|
+
/**
|
|
1333
|
+
* A slug is the last part of the URL address that serves as a unique identifier of the service.
|
|
1334
|
+
* The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
|
|
1335
|
+
* @readonly
|
|
1336
|
+
* @maxSize 100
|
|
1337
|
+
*/
|
|
1338
|
+
supportedSlugs?: Slug[];
|
|
1339
|
+
/**
|
|
1340
|
+
* Active slug for the service.
|
|
1341
|
+
* Learn more about [service slugs](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs).
|
|
1342
|
+
* @readonly
|
|
1343
|
+
*/
|
|
1344
|
+
mainSlug?: Slug;
|
|
1345
|
+
/**
|
|
1346
|
+
* URLs to various service-related pages, such as the calendar page and the booking page.
|
|
1347
|
+
* @readonly
|
|
1348
|
+
*/
|
|
1349
|
+
urls?: URLs;
|
|
1350
|
+
/** Extensions enabling users to save custom data related to the service. */
|
|
1351
|
+
extendedFields?: ExtendedFields;
|
|
1352
|
+
/** Custom SEO data for the service. */
|
|
1353
|
+
seoData?: SeoSchema;
|
|
1354
|
+
/**
|
|
1355
|
+
* Date and time the service was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1356
|
+
* @readonly
|
|
1357
|
+
*/
|
|
1358
|
+
_createdDate?: Date | null;
|
|
1359
|
+
/**
|
|
1360
|
+
* Date and time the service was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1361
|
+
* @readonly
|
|
1362
|
+
*/
|
|
1363
|
+
_updatedDate?: Date | null;
|
|
1364
|
+
/**
|
|
1365
|
+
* Revision number, which increments by 1 each time the service is updated. To
|
|
1366
|
+
* prevent conflicting changes, the existing revision must be used when updating
|
|
1367
|
+
* a service.
|
|
1368
|
+
* @readonly
|
|
1369
|
+
*/
|
|
1370
|
+
revision?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* Information about the [add-on groups](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-add-on-groups) associated with the service.
|
|
1373
|
+
* @maxSize 3
|
|
1374
|
+
*/
|
|
1375
|
+
addOnGroups?: AddOnGroup[];
|
|
1376
|
+
/**
|
|
1377
|
+
* Details about all [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) customers can choose when booking the service.
|
|
1378
|
+
* @readonly
|
|
1379
|
+
* @maxSize 50
|
|
1380
|
+
*/
|
|
1381
|
+
addOnDetails?: AddOnDetails[];
|
|
1382
|
+
/** Taxable address used to calculate tax */
|
|
1383
|
+
taxableAddress?: TaxableAddress;
|
|
1384
|
+
/**
|
|
1385
|
+
* ID of the [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction)
|
|
1386
|
+
* that serves as the primary resource for this appointment service. The primary resource type
|
|
1387
|
+
* determines which resources drive slot assignment and availability resolution.
|
|
1388
|
+
*
|
|
1389
|
+
* For example, when set to a "Meeting Rooms" resource type, availability is calculated
|
|
1390
|
+
* based on the rooms' schedules rather than staff schedules.
|
|
1391
|
+
*
|
|
1392
|
+
* Default: The staff resource type.
|
|
1393
|
+
* @format GUID
|
|
1394
|
+
*/
|
|
1395
|
+
primaryResourceType?: string | null;
|
|
1396
|
+
}
|
|
1397
|
+
declare enum ServiceType {
|
|
1398
|
+
/** Appointment-based service. */
|
|
1399
|
+
APPOINTMENT = "APPOINTMENT",
|
|
1400
|
+
/** Class service. */
|
|
1401
|
+
CLASS = "CLASS",
|
|
1402
|
+
/** Course service. */
|
|
1403
|
+
COURSE = "COURSE"
|
|
1404
|
+
}
|
|
1405
|
+
/** @enumType */
|
|
1406
|
+
type ServiceTypeWithLiterals = ServiceType | 'APPOINTMENT' | 'CLASS' | 'COURSE';
|
|
1407
|
+
interface Media {
|
|
1408
|
+
/**
|
|
1409
|
+
* Media items associated with the service.
|
|
1410
|
+
* @maxSize 100
|
|
1411
|
+
*/
|
|
1412
|
+
items?: MediaItem[];
|
|
1413
|
+
/** Primary media associated with the service. */
|
|
1414
|
+
mainMedia?: MediaItem;
|
|
1415
|
+
/** Cover media associated with the service. */
|
|
1416
|
+
coverMedia?: MediaItem;
|
|
1417
|
+
}
|
|
1418
|
+
interface MediaItem extends MediaItemItemOneOf {
|
|
1419
|
+
/** Details of the image associated with the service, such as URL and size. */
|
|
1420
|
+
image?: string;
|
|
1421
|
+
}
|
|
1422
|
+
/** @oneof */
|
|
1423
|
+
interface MediaItemItemOneOf {
|
|
1424
|
+
/** Details of the image associated with the service, such as URL and size. */
|
|
1425
|
+
image?: string;
|
|
1426
|
+
}
|
|
1427
|
+
interface V2Category {
|
|
1428
|
+
/**
|
|
1429
|
+
* Category ID.
|
|
1430
|
+
* @format GUID
|
|
1431
|
+
*/
|
|
1432
|
+
_id?: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* Category name.
|
|
1435
|
+
* @maxLength 500
|
|
1436
|
+
* @readonly
|
|
1437
|
+
*/
|
|
1438
|
+
name?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Order of a category within a category list.
|
|
1441
|
+
* @readonly
|
|
1442
|
+
*/
|
|
1443
|
+
sortOrder?: number | null;
|
|
1444
|
+
}
|
|
1445
|
+
interface Form {
|
|
1446
|
+
/**
|
|
1447
|
+
* ID of the form associated with the service.
|
|
1448
|
+
* The form information that you submit when booking includes contact details, participants, and other form fields set up for the service.
|
|
1449
|
+
* You can manage the service booking form fields using the Bookings Forms API.
|
|
1450
|
+
* @format GUID
|
|
1451
|
+
*/
|
|
1452
|
+
_id?: string;
|
|
1453
|
+
}
|
|
1454
|
+
interface Payment extends PaymentRateOneOf {
|
|
1455
|
+
/**
|
|
1456
|
+
* The details for the fixed price of the service.
|
|
1457
|
+
*
|
|
1458
|
+
* Required when: `rateType` is `FIXED`
|
|
1459
|
+
*/
|
|
1460
|
+
fixed?: FixedPayment;
|
|
1461
|
+
/**
|
|
1462
|
+
* The details for the custom price of the service.
|
|
1463
|
+
*
|
|
1464
|
+
* Required when: `rateType` is `CUSTOM`
|
|
1465
|
+
*/
|
|
1466
|
+
custom?: CustomPayment;
|
|
1467
|
+
/**
|
|
1468
|
+
* The details for the varied pricing of the service.
|
|
1469
|
+
* Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).
|
|
1470
|
+
*
|
|
1471
|
+
* Required when: `rateType` is `VARIED`
|
|
1472
|
+
*/
|
|
1473
|
+
varied?: VariedPayment;
|
|
1474
|
+
/**
|
|
1475
|
+
* Subscription pricing details for the service. Supported for course services only.
|
|
1476
|
+
* The business charges recurring monthly payments instead of a one-time fee.
|
|
1477
|
+
*
|
|
1478
|
+
* Required when: `rateType` is `SUBSCRIPTION`.
|
|
1479
|
+
*/
|
|
1480
|
+
subscription?: SubscriptionPayment;
|
|
1481
|
+
/** The rate the customer is expected to pay for the service. */
|
|
1482
|
+
rateType?: RateTypeWithLiterals;
|
|
1483
|
+
/** The payment options a customer can use to pay for the service. */
|
|
1484
|
+
options?: PaymentOptions;
|
|
1485
|
+
/**
|
|
1486
|
+
* IDs of pricing plans that can be used as payment for the service.
|
|
1487
|
+
* Read more about [service payment options](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-payments).
|
|
1488
|
+
* @readonly
|
|
1489
|
+
* @maxSize 75
|
|
1490
|
+
* @format GUID
|
|
1491
|
+
*/
|
|
1492
|
+
pricingPlanIds?: string[];
|
|
1493
|
+
/**
|
|
1494
|
+
* How customers can pay for add-ons when paying for the related booking with a [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction).
|
|
1495
|
+
* If customers pay for the booking using any method other than a pricing plan, the value of this field is ignored.
|
|
1496
|
+
*/
|
|
1497
|
+
addOnOption?: AddOnPaymentOptionsWithLiterals;
|
|
1498
|
+
/**
|
|
1499
|
+
* Estimated discount information for the service based on active [eCommerce discounts](https://dev.wix.com/docs/rest/business-solutions/e-commerce/extensions/discounts/introduction).
|
|
1500
|
+
* The final discount is determined during eCommerce checkout and may differ from the estimate,
|
|
1501
|
+
* for example when discounts depend on cart totals.
|
|
1502
|
+
*
|
|
1503
|
+
* A discount is considered active when its start time has passed and its end time hasn't.
|
|
1504
|
+
* If multiple active discounts apply, one is returned:
|
|
1505
|
+
* + Services with subscription pricing: the most recently updated discount that the business set to cover subscription purchases.
|
|
1506
|
+
* + Other services, when at least one discount's price can be estimated: the discount with the lowest estimated price.
|
|
1507
|
+
* + Other services, when no discount's price can be estimated: the most recently updated discount.
|
|
1508
|
+
*
|
|
1509
|
+
* The returned discount is an estimate and isn't guaranteed to be the one applied at checkout.
|
|
1510
|
+
*
|
|
1511
|
+
* Returned only when `DISCOUNT_INFO_DETAILS` is requested.
|
|
1512
|
+
* @readonly
|
|
1513
|
+
*/
|
|
1514
|
+
discountInfo?: DiscountInfo;
|
|
1515
|
+
}
|
|
1516
|
+
/** @oneof */
|
|
1517
|
+
interface PaymentRateOneOf {
|
|
1518
|
+
/**
|
|
1519
|
+
* The details for the fixed price of the service.
|
|
1520
|
+
*
|
|
1521
|
+
* Required when: `rateType` is `FIXED`
|
|
1522
|
+
*/
|
|
1523
|
+
fixed?: FixedPayment;
|
|
1524
|
+
/**
|
|
1525
|
+
* The details for the custom price of the service.
|
|
1526
|
+
*
|
|
1527
|
+
* Required when: `rateType` is `CUSTOM`
|
|
1528
|
+
*/
|
|
1529
|
+
custom?: CustomPayment;
|
|
1530
|
+
/**
|
|
1531
|
+
* The details for the varied pricing of the service.
|
|
1532
|
+
* Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).
|
|
1533
|
+
*
|
|
1534
|
+
* Required when: `rateType` is `VARIED`
|
|
1535
|
+
*/
|
|
1536
|
+
varied?: VariedPayment;
|
|
1537
|
+
/**
|
|
1538
|
+
* Subscription pricing details for the service. Supported for course services only.
|
|
1539
|
+
* The business charges recurring monthly payments instead of a one-time fee.
|
|
1540
|
+
*
|
|
1541
|
+
* Required when: `rateType` is `SUBSCRIPTION`.
|
|
1542
|
+
*/
|
|
1543
|
+
subscription?: SubscriptionPayment;
|
|
1544
|
+
}
|
|
1545
|
+
declare enum RateType {
|
|
1546
|
+
/** The service has a fixed price. */
|
|
1547
|
+
FIXED = "FIXED",
|
|
1548
|
+
/** The service has a custom price, expressed as a price description. */
|
|
1549
|
+
CUSTOM = "CUSTOM",
|
|
1550
|
+
/** This service is offered with a set of different prices based on different terms. */
|
|
1551
|
+
VARIED = "VARIED",
|
|
1552
|
+
/** This service is offered free of charge. */
|
|
1553
|
+
NO_FEE = "NO_FEE",
|
|
1554
|
+
/**
|
|
1555
|
+
* The service charges recurring monthly payments. Supported for course services only.
|
|
1556
|
+
* @documentationMaturity preview
|
|
1557
|
+
*/
|
|
1558
|
+
SUBSCRIPTION = "SUBSCRIPTION"
|
|
1559
|
+
}
|
|
1560
|
+
/** @enumType */
|
|
1561
|
+
type RateTypeWithLiterals = RateType | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE' | 'SUBSCRIPTION';
|
|
1562
|
+
interface FixedPayment {
|
|
1563
|
+
/**
|
|
1564
|
+
* The fixed price required to book the service.
|
|
1565
|
+
*
|
|
1566
|
+
* Required when: `rateType` is `FIXED`
|
|
1567
|
+
*/
|
|
1568
|
+
price?: Money;
|
|
1569
|
+
/**
|
|
1570
|
+
* The deposit price required to book the service.
|
|
1571
|
+
*
|
|
1572
|
+
* Required when: `rateType` is `FIXED` and `paymentOptions.deposit` is `true`
|
|
1573
|
+
*/
|
|
1574
|
+
deposit?: Money;
|
|
1575
|
+
/**
|
|
1576
|
+
* Whether customers can choose to pay the full service price upfront instead of only the deposit.
|
|
1577
|
+
*
|
|
1578
|
+
* Used only when a `deposit` amount is set.
|
|
1579
|
+
*
|
|
1580
|
+
* Default: `false`.
|
|
1581
|
+
*/
|
|
1582
|
+
fullUpfrontPaymentAllowed?: boolean | null;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* Money.
|
|
1586
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
1587
|
+
*/
|
|
1588
|
+
interface Money {
|
|
1589
|
+
/**
|
|
1590
|
+
* Monetary amount. Decimal string with a period as a decimal separator. For example `25.05`.
|
|
1591
|
+
* @format DECIMAL_VALUE
|
|
1592
|
+
* @decimalValue options { gt:0, maxScale:2 }
|
|
1593
|
+
*/
|
|
1594
|
+
value?: string;
|
|
1595
|
+
/**
|
|
1596
|
+
* Currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217). For example, `USD`.
|
|
1597
|
+
* @format CURRENCY
|
|
1598
|
+
* @readonly
|
|
1599
|
+
*/
|
|
1600
|
+
currency?: string;
|
|
1601
|
+
/**
|
|
1602
|
+
* Monetary amount. Decimal string in local format. For example, `1 000,30`.
|
|
1603
|
+
* @maxLength 50
|
|
1604
|
+
*/
|
|
1605
|
+
formattedValue?: string | null;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* A deposit expressed as exactly one of a fixed monetary amount or a percentage of the full service price.
|
|
1609
|
+
* Structurally exclusive: at most one of `amount` or `percentage` may be set.
|
|
1610
|
+
*/
|
|
1611
|
+
interface CustomPayment {
|
|
1612
|
+
/**
|
|
1613
|
+
* A custom description explaining to the customer how to pay for the service.
|
|
1614
|
+
* @maxLength 50
|
|
1615
|
+
*/
|
|
1616
|
+
description?: string | null;
|
|
1617
|
+
}
|
|
1618
|
+
interface VariedPayment {
|
|
1619
|
+
/** The default price for the service without any variants. It will also be used as the default price for any new variant. */
|
|
1620
|
+
defaultPrice?: Money;
|
|
1621
|
+
/**
|
|
1622
|
+
* The deposit price required to book the service.
|
|
1623
|
+
*
|
|
1624
|
+
* Required when: `rateType` is `VARIED` and `paymentOptions.deposit` is `true`
|
|
1625
|
+
*/
|
|
1626
|
+
deposit?: Money;
|
|
1627
|
+
/**
|
|
1628
|
+
* The minimal price a customer may pay for this service, based on its variants.
|
|
1629
|
+
* @readonly
|
|
1630
|
+
*/
|
|
1631
|
+
minPrice?: Money;
|
|
1632
|
+
/**
|
|
1633
|
+
* The maximum price a customer may pay for this service, based on its variants.
|
|
1634
|
+
* @readonly
|
|
1635
|
+
*/
|
|
1636
|
+
maxPrice?: Money;
|
|
1637
|
+
/**
|
|
1638
|
+
* Whether customers can choose to pay the full service price upfront instead of only the deposit.
|
|
1639
|
+
*
|
|
1640
|
+
* Used only when a `deposit` amount is set.
|
|
1641
|
+
*
|
|
1642
|
+
* Default: `false`.
|
|
1643
|
+
*/
|
|
1644
|
+
fullUpfrontPaymentAllowed?: boolean | null;
|
|
1645
|
+
}
|
|
1646
|
+
interface SubscriptionPayment {
|
|
1647
|
+
/**
|
|
1648
|
+
* Base price charged per billing cycle before tax and discounts.
|
|
1649
|
+
* The actual amount charged may differ after checkout applies tax and discounts.
|
|
1650
|
+
*/
|
|
1651
|
+
amountPerBillingCycle?: Money;
|
|
1652
|
+
/**
|
|
1653
|
+
* Billing frequency for recurring subscription charges.
|
|
1654
|
+
* Reflected as `billingFrequency` in the booking's subscription info.
|
|
1655
|
+
*
|
|
1656
|
+
* Currently supports `MONTHLY` only.
|
|
1657
|
+
*/
|
|
1658
|
+
frequency?: FrequencyTypeWithLiterals;
|
|
1659
|
+
/**
|
|
1660
|
+
* Total number of billing cycles in the subscription. For example, `12` for a 12-month subscription with monthly payments.
|
|
1661
|
+
* Reflected as `totalCycles` in the booking's subscription info.
|
|
1662
|
+
*
|
|
1663
|
+
* Required when: `rateType` is `SUBSCRIPTION`.
|
|
1664
|
+
* @min 2
|
|
1665
|
+
*/
|
|
1666
|
+
totalPayments?: number | null;
|
|
1667
|
+
/** Determines when the first billing cycle payment is charged. Used together with `recurringStartDate` to define the subscription billing schedule. */
|
|
1668
|
+
firstChargeDate?: FirstChargeDateTypeWithLiterals;
|
|
1669
|
+
/**
|
|
1670
|
+
* Date and time when recurring billing starts.
|
|
1671
|
+
*
|
|
1672
|
+
* When `firstChargeDate` is `CHECKOUT`, the first charge occurs at checkout and subsequent billing cycles start from this date.
|
|
1673
|
+
*
|
|
1674
|
+
* When `firstChargeDate` is `SCHEDULED`, the first charge occurs on this date.
|
|
1675
|
+
*
|
|
1676
|
+
* Customers who book after recurring billing starts are billed for the remaining billing cycles only.
|
|
1677
|
+
*
|
|
1678
|
+
* Required when: `rateType` is `SUBSCRIPTION`.
|
|
1679
|
+
*/
|
|
1680
|
+
recurringStartDate?: Date | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* Deprecated.
|
|
1683
|
+
* @deprecated Deprecated.
|
|
1684
|
+
* @targetRemovalDate 2026-07-01
|
|
1685
|
+
*/
|
|
1686
|
+
enrollmentFeeAmount?: Money;
|
|
1687
|
+
}
|
|
1688
|
+
declare enum FrequencyType {
|
|
1689
|
+
/** Billing cycle repeats once per month. */
|
|
1690
|
+
MONTHLY = "MONTHLY"
|
|
1691
|
+
}
|
|
1692
|
+
/** @enumType */
|
|
1693
|
+
type FrequencyTypeWithLiterals = FrequencyType | 'MONTHLY';
|
|
1694
|
+
declare enum FirstChargeDateType {
|
|
1695
|
+
/** The first billing cycle is charged at checkout. Recurring billing continues from the `recurringStartDate`. */
|
|
1696
|
+
CHECKOUT = "CHECKOUT",
|
|
1697
|
+
/** The first billing cycle is charged on the `recurringStartDate`. */
|
|
1698
|
+
SCHEDULED = "SCHEDULED"
|
|
1699
|
+
}
|
|
1700
|
+
/** @enumType */
|
|
1701
|
+
type FirstChargeDateTypeWithLiterals = FirstChargeDateType | 'CHECKOUT' | 'SCHEDULED';
|
|
1702
|
+
/**
|
|
1703
|
+
* The payment options a customer can use to pay for the service.
|
|
1704
|
+
* For payments of type `FIXED` or `VARIED`, at least one of `online`, `inPerson`, or `pricingPlan` must be `true`.
|
|
1705
|
+
*/
|
|
1706
|
+
interface PaymentOptions {
|
|
1707
|
+
/**
|
|
1708
|
+
* Customers can pay for the service online.
|
|
1709
|
+
* When `true`:
|
|
1710
|
+
* + `rateType` must be `FIXED`, `VARIED`, or `SUBSCRIPTION`.
|
|
1711
|
+
* + `fixed.price`, `varied.defaultPrice`, or `subscription.amountPerBillingCycle` must be specified respectively.
|
|
1712
|
+
*
|
|
1713
|
+
* Required when: `rateType` is `SUBSCRIPTION`.
|
|
1714
|
+
* Read more about [getting paid online](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online).
|
|
1715
|
+
*/
|
|
1716
|
+
online?: boolean | null;
|
|
1717
|
+
/** Customers can pay for the service in person. */
|
|
1718
|
+
inPerson?: boolean | null;
|
|
1719
|
+
/**
|
|
1720
|
+
* This service requires a deposit to be made online in order to book it.
|
|
1721
|
+
* When `true`:
|
|
1722
|
+
* + `rateType` must be `VARIED` or `FIXED`.
|
|
1723
|
+
* + A `deposit` must be specified.
|
|
1724
|
+
* + `online` must be `true`.
|
|
1725
|
+
* + `inPerson` must be `false`.
|
|
1726
|
+
*/
|
|
1727
|
+
deposit?: boolean | null;
|
|
1728
|
+
/**
|
|
1729
|
+
* Whether customers can pay for the service using a pricing plan.
|
|
1730
|
+
* Read more about [service payment options](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-payments).
|
|
1731
|
+
*/
|
|
1732
|
+
pricingPlan?: boolean | null;
|
|
1733
|
+
}
|
|
1734
|
+
declare enum AddOnPaymentOptions {
|
|
1735
|
+
/** Customers are required to pay online for add-ons when the booking is paid for with a pricing plan. */
|
|
1736
|
+
ONLINE = "ONLINE",
|
|
1737
|
+
/** Customers are required to pay in person for add-ons when the booking is paid for with a pricing plan. */
|
|
1738
|
+
IN_PERSON = "IN_PERSON"
|
|
1739
|
+
}
|
|
1740
|
+
/** @enumType */
|
|
1741
|
+
type AddOnPaymentOptionsWithLiterals = AddOnPaymentOptions | 'ONLINE' | 'IN_PERSON';
|
|
1742
|
+
/** Estimated discount information for a service based on active eCommerce discounts. */
|
|
1743
|
+
interface DiscountInfo {
|
|
1744
|
+
/**
|
|
1745
|
+
* Name of the discount. For example, `Summer Sale - 20% Off`.
|
|
1746
|
+
* @minLength 1
|
|
1747
|
+
* @maxLength 50
|
|
1748
|
+
*/
|
|
1749
|
+
discountName?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Estimated price after applying the discount. The final price is determined at checkout and may differ when additional discounts are applied or rules are re-evaluated with complete booking information.
|
|
1752
|
+
* For services with subscription pricing, this is the estimated price per billing cycle for the discounted cycles (see `discountedCycleCount`).
|
|
1753
|
+
*
|
|
1754
|
+
* Not returned when the discount depends on booking or cart context, for example a discount that applies to a service only when booked together with another service, or when the discount requires information only available at checkout.
|
|
1755
|
+
*/
|
|
1756
|
+
priceAfterDiscount?: Money;
|
|
1757
|
+
}
|
|
1758
|
+
/** A mandatory fee the customer pays in addition to the service price. */
|
|
1759
|
+
interface OnlineBooking {
|
|
1760
|
+
/**
|
|
1761
|
+
* Whether the service can be booked online.
|
|
1762
|
+
* When set to `true`, customers can book the service online. Configure the payment options via the `service.payment` property.
|
|
1763
|
+
* When set to `false`, customers cannot book the service online, and the service can only be paid for in person.
|
|
1764
|
+
*/
|
|
1765
|
+
enabled?: boolean | null;
|
|
1766
|
+
/** Booking the service requires approval by the Wix user. */
|
|
1767
|
+
requireManualApproval?: boolean | null;
|
|
1768
|
+
/** Multiple customers can request to book the same time slot. This is relevant when `requireManualApproval` is `true`. */
|
|
1769
|
+
allowMultipleRequests?: boolean | null;
|
|
1770
|
+
}
|
|
1771
|
+
interface Conferencing {
|
|
1772
|
+
/** Whether a conference link is generated for the service's sessions. */
|
|
1773
|
+
enabled?: boolean | null;
|
|
1774
|
+
}
|
|
1775
|
+
interface V2Location extends V2LocationOptionsOneOf {
|
|
1776
|
+
/** Information about business locations. Required when `type` is `BUSINESS`. */
|
|
1777
|
+
business?: BusinessLocationOptions;
|
|
1778
|
+
/** Information about custom locations. Required when `type` is `CUSTOM`. */
|
|
1779
|
+
custom?: CustomLocationOptions;
|
|
1780
|
+
/**
|
|
1781
|
+
* Location ID.
|
|
1782
|
+
* @format GUID
|
|
1783
|
+
* @readonly
|
|
1784
|
+
*/
|
|
1785
|
+
_id?: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* Location type.
|
|
1788
|
+
*
|
|
1789
|
+
* Default: `CUSTOM`
|
|
1790
|
+
*/
|
|
1791
|
+
type?: LocationTypeEnumLocationTypeWithLiterals;
|
|
1792
|
+
/**
|
|
1793
|
+
* Location address. Empty for `{"type": "CUSTOMER"}`.
|
|
1794
|
+
* @readonly
|
|
1795
|
+
*/
|
|
1796
|
+
calculatedAddress?: CommonAddress;
|
|
1797
|
+
}
|
|
1798
|
+
/** @oneof */
|
|
1799
|
+
interface V2LocationOptionsOneOf {
|
|
1800
|
+
/** Information about business locations. Required when `type` is `BUSINESS`. */
|
|
1801
|
+
business?: BusinessLocationOptions;
|
|
1802
|
+
/** Information about custom locations. Required when `type` is `CUSTOM`. */
|
|
1803
|
+
custom?: CustomLocationOptions;
|
|
1804
|
+
}
|
|
1805
|
+
declare enum LocationTypeEnumLocationType {
|
|
1806
|
+
/** Location set by the business that is not a standard business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
1807
|
+
CUSTOM = "CUSTOM",
|
|
1808
|
+
/** Business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
1809
|
+
BUSINESS = "BUSINESS",
|
|
1810
|
+
/**
|
|
1811
|
+
* The customer specifies any address when booking. Available only for
|
|
1812
|
+
* appointment-based services.
|
|
1813
|
+
*/
|
|
1814
|
+
CUSTOMER = "CUSTOMER"
|
|
1815
|
+
}
|
|
1816
|
+
/** @enumType */
|
|
1817
|
+
type LocationTypeEnumLocationTypeWithLiterals = LocationTypeEnumLocationType | 'CUSTOM' | 'BUSINESS' | 'CUSTOMER';
|
|
1818
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
1819
|
+
/** Street name and number. */
|
|
1820
|
+
streetAddress?: CommonStreetAddress;
|
|
1821
|
+
/** @maxLength 255 */
|
|
1822
|
+
addressLine1?: string | null;
|
|
1823
|
+
/**
|
|
1824
|
+
* 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1825
|
+
* @format COUNTRY
|
|
1826
|
+
*/
|
|
1827
|
+
country?: string | null;
|
|
1828
|
+
/**
|
|
1829
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
|
|
1830
|
+
* @maxLength 255
|
|
1831
|
+
*/
|
|
1832
|
+
subdivision?: string | null;
|
|
1833
|
+
/**
|
|
1834
|
+
* City name.
|
|
1835
|
+
* @maxLength 255
|
|
1836
|
+
*/
|
|
1837
|
+
city?: string | null;
|
|
1838
|
+
/**
|
|
1839
|
+
* Postal or zip code.
|
|
1840
|
+
* @maxLength 255
|
|
1841
|
+
*/
|
|
1842
|
+
postalCode?: string | null;
|
|
1843
|
+
/**
|
|
1844
|
+
* Full address of the location.
|
|
1845
|
+
* @maxLength 512
|
|
1846
|
+
*/
|
|
1847
|
+
formatted?: string | null;
|
|
1848
|
+
}
|
|
1849
|
+
/** @oneof */
|
|
1850
|
+
interface CommonAddressStreetOneOf {
|
|
1851
|
+
/** Street name and number. */
|
|
1852
|
+
streetAddress?: CommonStreetAddress;
|
|
1853
|
+
/** @maxLength 255 */
|
|
1854
|
+
addressLine?: string | null;
|
|
1855
|
+
}
|
|
1856
|
+
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
1857
|
+
interface CommonStreetAddress {
|
|
1858
|
+
/**
|
|
1859
|
+
* Street number.
|
|
1860
|
+
* @maxLength 255
|
|
1861
|
+
*/
|
|
1862
|
+
number?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* Street name.
|
|
1865
|
+
* @maxLength 255
|
|
1866
|
+
*/
|
|
1867
|
+
name?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* Apartment number.
|
|
1870
|
+
* @maxLength 255
|
|
1871
|
+
*/
|
|
1872
|
+
apt?: string;
|
|
1873
|
+
}
|
|
1874
|
+
interface BusinessLocationOptions {
|
|
1875
|
+
/**
|
|
1876
|
+
* ID of the business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
|
|
1877
|
+
* When setting a business location, specify only the location ID. Other location details are overwritten.
|
|
1878
|
+
* @format GUID
|
|
1879
|
+
*/
|
|
1880
|
+
_id?: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* Business location name.
|
|
1883
|
+
* @readonly
|
|
1884
|
+
* @maxLength 150
|
|
1885
|
+
*/
|
|
1886
|
+
name?: string;
|
|
1887
|
+
/**
|
|
1888
|
+
* Whether this is the default location. There can only be a single default location per site.
|
|
1889
|
+
* @readonly
|
|
1890
|
+
*/
|
|
1891
|
+
default?: boolean | null;
|
|
1892
|
+
/**
|
|
1893
|
+
* Business location address.
|
|
1894
|
+
* @readonly
|
|
1895
|
+
*/
|
|
1896
|
+
address?: CommonAddress;
|
|
1897
|
+
/**
|
|
1898
|
+
* Business location email.
|
|
1899
|
+
* @format EMAIL
|
|
1900
|
+
* @readonly
|
|
1901
|
+
*/
|
|
1902
|
+
email?: string | null;
|
|
1903
|
+
/**
|
|
1904
|
+
* Business location phone.
|
|
1905
|
+
* @format PHONE
|
|
1906
|
+
* @readonly
|
|
1907
|
+
*/
|
|
1908
|
+
phone?: string | null;
|
|
1909
|
+
}
|
|
1910
|
+
interface CustomLocationOptions {
|
|
1911
|
+
/**
|
|
1912
|
+
* ID of the custom location.
|
|
1913
|
+
* @format GUID
|
|
1914
|
+
* @readonly
|
|
1915
|
+
*/
|
|
1916
|
+
_id?: string;
|
|
1917
|
+
/** Address of the custom location. */
|
|
1918
|
+
address?: CommonAddress;
|
|
1919
|
+
}
|
|
1920
|
+
/**
|
|
1921
|
+
* `BookingPolicy` is the main entity of `BookingPolicyService` and specifies a set of rules for booking a service
|
|
1922
|
+
* by visitors and members.
|
|
1923
|
+
*
|
|
1924
|
+
* Each `BookingPolicy` consists of a number of sub-policies. When the Bookings App is provisioned to a meta site then a
|
|
1925
|
+
* default `BookingPolicy` will be created with defaults for each of these sub-policies. This also applies when a request
|
|
1926
|
+
* is received to create a new `BookingPolicy` and one or more of these sub-policies are not provided.
|
|
1927
|
+
*
|
|
1928
|
+
* Sub-policies are defined in separate objects as specified below.
|
|
1929
|
+
*
|
|
1930
|
+
* - The `LimitEarlyBookingPolicy` object defines the policy for limiting early bookings.
|
|
1931
|
+
* - The `LimitLateBookingPolicy` object defines the policy for limiting late bookings.
|
|
1932
|
+
* - The `BookAfterStartPolicy` object defines the policy for booking after the start of the schedule.
|
|
1933
|
+
* - The `CancellationPolicy` object defines the policy for canceling a booked entity.
|
|
1934
|
+
* - The `ReschedulePolicy` object defines the policy for rescheduling booked entity.
|
|
1935
|
+
* - The `WaitlistPolicy` object defines the policy for a waitlist.
|
|
1936
|
+
* - The `ParticipantsPolicy` object defines the policy regarding the participants per booking.
|
|
1937
|
+
* - The `ResourcesPolicy` object defines the policy regarding the resources per booking.
|
|
1938
|
+
* - The `CancellationFeePolicy` object defines the policy regarding cancellation fees.
|
|
1939
|
+
* - The `SaveCreditCardPolicy` object defines the policy for saving credit card details.
|
|
1940
|
+
*
|
|
1941
|
+
* By default each sub-policy is disabled. A more detailed specification of the default settings of each sub-policy
|
|
1942
|
+
* can be found in the description of the corresponding object.
|
|
1943
|
+
*
|
|
1944
|
+
* Partial updates are supported on the main entity level, however in order to update a sub-policy the client needs to provide the whole sub-policy object.
|
|
1945
|
+
*/
|
|
1946
|
+
interface BookingPolicy {
|
|
1947
|
+
/**
|
|
1948
|
+
* The ID to the policy for the booking.
|
|
1949
|
+
* @format GUID
|
|
1950
|
+
*/
|
|
1951
|
+
_id?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Date and time the policy was created.
|
|
1954
|
+
* @readonly
|
|
1955
|
+
*/
|
|
1956
|
+
_createdDate?: Date | null;
|
|
1957
|
+
/**
|
|
1958
|
+
* Date and time the policy was updated.
|
|
1959
|
+
* @readonly
|
|
1960
|
+
*/
|
|
1961
|
+
_updatedDate?: Date | null;
|
|
1962
|
+
/**
|
|
1963
|
+
* Name of the policy.
|
|
1964
|
+
* @maxLength 400
|
|
1965
|
+
* @readonly
|
|
1966
|
+
*/
|
|
1967
|
+
name?: string | null;
|
|
1968
|
+
/**
|
|
1969
|
+
* Custom description for the policy. This policy is displayed to the participant.
|
|
1970
|
+
* @readonly
|
|
1971
|
+
*/
|
|
1972
|
+
customPolicyDescription?: PolicyDescription;
|
|
1973
|
+
/**
|
|
1974
|
+
* Whether the policy is the default for the meta site.
|
|
1975
|
+
* @readonly
|
|
1976
|
+
*/
|
|
1977
|
+
default?: boolean | null;
|
|
1978
|
+
/**
|
|
1979
|
+
* Policy for limiting early bookings.
|
|
1980
|
+
* @readonly
|
|
1981
|
+
*/
|
|
1982
|
+
limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;
|
|
1983
|
+
/**
|
|
1984
|
+
* Policy for limiting late bookings.
|
|
1985
|
+
* @readonly
|
|
1986
|
+
*/
|
|
1987
|
+
limitLateBookingPolicy?: LimitLateBookingPolicy;
|
|
1988
|
+
/**
|
|
1989
|
+
* Policy on booking an entity after the start of the schedule.
|
|
1990
|
+
* @readonly
|
|
1991
|
+
*/
|
|
1992
|
+
bookAfterStartPolicy?: BookAfterStartPolicy;
|
|
1993
|
+
/**
|
|
1994
|
+
* Policy for canceling a booked entity.
|
|
1995
|
+
* @readonly
|
|
1996
|
+
*/
|
|
1997
|
+
cancellationPolicy?: CancellationPolicy;
|
|
1998
|
+
/**
|
|
1999
|
+
* Policy for rescheduling a booked entity.
|
|
2000
|
+
* @readonly
|
|
2001
|
+
*/
|
|
2002
|
+
reschedulePolicy?: ReschedulePolicy;
|
|
2003
|
+
/**
|
|
2004
|
+
* Waitlist policy for the service.
|
|
2005
|
+
* @readonly
|
|
2006
|
+
*/
|
|
2007
|
+
waitlistPolicy?: WaitlistPolicy;
|
|
2008
|
+
/**
|
|
2009
|
+
* Policy regarding the participants per booking.
|
|
2010
|
+
* @readonly
|
|
2011
|
+
*/
|
|
2012
|
+
participantsPolicy?: ParticipantsPolicy;
|
|
2013
|
+
/**
|
|
2014
|
+
* Policy for allocating resources.
|
|
2015
|
+
* @readonly
|
|
2016
|
+
*/
|
|
2017
|
+
resourcesPolicy?: ResourcesPolicy;
|
|
2018
|
+
/**
|
|
2019
|
+
* Rules for cancellation fees.
|
|
2020
|
+
* @readonly
|
|
2021
|
+
*/
|
|
2022
|
+
cancellationFeePolicy?: CancellationFeePolicy;
|
|
2023
|
+
/**
|
|
2024
|
+
* Rule for saving credit card.
|
|
2025
|
+
* @readonly
|
|
2026
|
+
*/
|
|
2027
|
+
saveCreditCardPolicy?: SaveCreditCardPolicy;
|
|
2028
|
+
/** Rule for requiring customers to complete an [intake form](https://dev.wix.com/docs/api-reference/crm/forms/other-services/intake-forms/introduction) during or after booking. */
|
|
2029
|
+
intakeFormPolicy?: IntakeFormPolicy;
|
|
2030
|
+
}
|
|
2031
|
+
/** A description of the policy to display to participants. */
|
|
2032
|
+
interface PolicyDescription {
|
|
2033
|
+
/**
|
|
2034
|
+
* Whether the description should be displayed. If `true`, the description is displayed.
|
|
2035
|
+
*
|
|
2036
|
+
* Default: `false`
|
|
2037
|
+
*/
|
|
2038
|
+
enabled?: boolean;
|
|
2039
|
+
/**
|
|
2040
|
+
* The description to display.
|
|
2041
|
+
*
|
|
2042
|
+
* Default: Empty
|
|
2043
|
+
* Max length: 2500 characters
|
|
2044
|
+
* @maxLength 2500
|
|
2045
|
+
*/
|
|
2046
|
+
description?: string;
|
|
2047
|
+
}
|
|
2048
|
+
/** The policy for limiting early bookings. */
|
|
2049
|
+
interface LimitEarlyBookingPolicy {
|
|
2050
|
+
/**
|
|
2051
|
+
* Whether there is a limit on how early a customer
|
|
2052
|
+
* can book. When `false`, there is no limit on the earliest
|
|
2053
|
+
* booking time and customers can book in advance, as early as they like.
|
|
2054
|
+
*
|
|
2055
|
+
* Default: `false`
|
|
2056
|
+
*/
|
|
2057
|
+
enabled?: boolean;
|
|
2058
|
+
/**
|
|
2059
|
+
* Maximum number of minutes before the start of the session that a booking can be made. This value must be greater
|
|
2060
|
+
* than `latest_booking_in_minutes` in the `LimitLateBookingPolicy` policy.
|
|
2061
|
+
*
|
|
2062
|
+
* Default: 10080 minutes (7 days)
|
|
2063
|
+
* Min: 1 minute
|
|
2064
|
+
* @min 1
|
|
2065
|
+
*/
|
|
2066
|
+
earliestBookingInMinutes?: number;
|
|
2067
|
+
}
|
|
2068
|
+
/**
|
|
2069
|
+
* The policy for limiting late bookings.
|
|
2070
|
+
*
|
|
2071
|
+
* This policy and the `BookAfterStartPolicy` policy cannot be enabled at the same time. So if this policy
|
|
2072
|
+
* is enabled, `BookAfterStartPolicy` must be disabled.
|
|
2073
|
+
*/
|
|
2074
|
+
interface LimitLateBookingPolicy {
|
|
2075
|
+
/**
|
|
2076
|
+
* Whether there is a limit on how late a customer
|
|
2077
|
+
* can book. When `false`, there is no limit on the latest
|
|
2078
|
+
* booking time and customers can book up to the last minute.
|
|
2079
|
+
*
|
|
2080
|
+
* Default: `false`
|
|
2081
|
+
*/
|
|
2082
|
+
enabled?: boolean;
|
|
2083
|
+
/**
|
|
2084
|
+
* Minimum number of minutes before the start of the session that a booking can be made.
|
|
2085
|
+
* For a schedule, this is relative to the start time of the next booked session, excluding past-booked sessions.
|
|
2086
|
+
* This value must be less than `earliest_booking_in_minutes` in the `LimitEarlyBookingPolicy` policy.
|
|
2087
|
+
*
|
|
2088
|
+
* Default: 1440 minutes (1 day)
|
|
2089
|
+
* Min: 1 minute
|
|
2090
|
+
* @min 1
|
|
2091
|
+
*/
|
|
2092
|
+
latestBookingInMinutes?: number;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* The policy for whether a session can be booked after the start of the schedule.
|
|
2096
|
+
* This policy and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this policy
|
|
2097
|
+
* is enabled, the `LimitLateBookingPolicy` policy must be disabled.
|
|
2098
|
+
*/
|
|
2099
|
+
interface BookAfterStartPolicy {
|
|
2100
|
+
/**
|
|
2101
|
+
* Whether booking is allowed after the start of the schedule. When `true`,
|
|
2102
|
+
* customers can book after the start of the schedule.
|
|
2103
|
+
*
|
|
2104
|
+
* Default: `false`
|
|
2105
|
+
*/
|
|
2106
|
+
enabled?: boolean;
|
|
2107
|
+
}
|
|
2108
|
+
/** The policy for canceling a booked session. */
|
|
2109
|
+
interface CancellationPolicy {
|
|
2110
|
+
/**
|
|
2111
|
+
* Whether canceling a booking is allowed. When `true`, customers
|
|
2112
|
+
* can cancel the booking.
|
|
2113
|
+
*
|
|
2114
|
+
* Default: `false`
|
|
2115
|
+
*/
|
|
2116
|
+
enabled?: boolean;
|
|
2117
|
+
/**
|
|
2118
|
+
* Whether there is a limit on the latest cancellation time. When `true`,
|
|
2119
|
+
* a time limit is enforced.
|
|
2120
|
+
*
|
|
2121
|
+
* Default: `false`
|
|
2122
|
+
*/
|
|
2123
|
+
limitLatestCancellation?: boolean;
|
|
2124
|
+
/**
|
|
2125
|
+
* Minimum number of minutes before the start of the booked session that the booking can be canceled.
|
|
2126
|
+
*
|
|
2127
|
+
* Default: 1440 minutes (1 day)
|
|
2128
|
+
* Min: 1 minute
|
|
2129
|
+
* @min 1
|
|
2130
|
+
*/
|
|
2131
|
+
latestCancellationInMinutes?: number;
|
|
2132
|
+
/**
|
|
2133
|
+
* Whether this cancellation policy allows anonymous cancellations.
|
|
2134
|
+
*
|
|
2135
|
+
* **Important**: This flag only applies when `enabled` is `true`. If the cancellation
|
|
2136
|
+
* policy itself is disabled (`enabled` = `false`), anonymous users cannot cancel
|
|
2137
|
+
* regardless of this flag's value.
|
|
2138
|
+
*
|
|
2139
|
+
* When not set (null), defaults to enabled. Anonymous cancellations are allowed by default
|
|
2140
|
+
* so that customers aren't required to be site members to cancel their bookings.
|
|
2141
|
+
*
|
|
2142
|
+
* Default: `null` (treated as `true`)
|
|
2143
|
+
*/
|
|
2144
|
+
allowAnonymous?: boolean | null;
|
|
2145
|
+
}
|
|
2146
|
+
/** The policy for rescheduling a booked session. */
|
|
2147
|
+
interface ReschedulePolicy {
|
|
2148
|
+
/**
|
|
2149
|
+
* Whether rescheduling a booking is allowed. When `true`, customers
|
|
2150
|
+
* can reschedule the booking.
|
|
2151
|
+
*
|
|
2152
|
+
* Default: `false`
|
|
2153
|
+
*/
|
|
2154
|
+
enabled?: boolean;
|
|
2155
|
+
/**
|
|
2156
|
+
* Whether there is a limit on the latest reschedule time. When `true`,
|
|
2157
|
+
* a time limit is enforced.
|
|
2158
|
+
*
|
|
2159
|
+
* Default: `false`
|
|
2160
|
+
*/
|
|
2161
|
+
limitLatestReschedule?: boolean;
|
|
2162
|
+
/**
|
|
2163
|
+
* Minimum number of minutes before the start of the booked session that the booking can be rescheduled.
|
|
2164
|
+
*
|
|
2165
|
+
* Default: 1440 minutes (1 day)
|
|
2166
|
+
* Min: 1 minute
|
|
2167
|
+
* @min 1
|
|
2168
|
+
*/
|
|
2169
|
+
latestRescheduleInMinutes?: number;
|
|
2170
|
+
/**
|
|
2171
|
+
* Whether this reschedule policy allows anonymous rescheduling.
|
|
2172
|
+
*
|
|
2173
|
+
* **Important**: This flag only applies when `enabled` is `true`. If the reschedule
|
|
2174
|
+
* policy itself is disabled (`enabled` = `false`), anonymous users cannot reschedule
|
|
2175
|
+
* regardless of this flag's value.
|
|
2176
|
+
*
|
|
2177
|
+
* When not set (null), defaults to enabled. Anonymous rescheduling is allowed by default
|
|
2178
|
+
* so that customers aren't required to be site members to reschedule their bookings.
|
|
2179
|
+
*
|
|
2180
|
+
* Default: `null` (treated as `true`)
|
|
2181
|
+
*/
|
|
2182
|
+
allowAnonymous?: boolean | null;
|
|
2183
|
+
}
|
|
2184
|
+
/** The policy for the waitlist. */
|
|
2185
|
+
interface WaitlistPolicy {
|
|
2186
|
+
/**
|
|
2187
|
+
* Whether the session has a waitlist. If `true`, there is a waitlist.
|
|
2188
|
+
*
|
|
2189
|
+
* Default: `false`
|
|
2190
|
+
*/
|
|
2191
|
+
enabled?: boolean;
|
|
2192
|
+
/**
|
|
2193
|
+
* Number of spots available in the waitlist.
|
|
2194
|
+
*
|
|
2195
|
+
* Default: 10 spots
|
|
2196
|
+
* Min: 1 spot
|
|
2197
|
+
* @min 1
|
|
2198
|
+
*/
|
|
2199
|
+
capacity?: number;
|
|
2200
|
+
/**
|
|
2201
|
+
* Amount of time a participant is given to book, once notified that a spot is available.
|
|
2202
|
+
*
|
|
2203
|
+
* Default: 10 minutes
|
|
2204
|
+
* Min: 1 spot
|
|
2205
|
+
* @min 1
|
|
2206
|
+
*/
|
|
2207
|
+
reservationTimeInMinutes?: number;
|
|
2208
|
+
}
|
|
2209
|
+
/** The policy for the maximum number of participants per booking. */
|
|
2210
|
+
interface ParticipantsPolicy {
|
|
2211
|
+
/**
|
|
2212
|
+
* Maximum number of participants allowed.
|
|
2213
|
+
*
|
|
2214
|
+
* Default: 1 participant
|
|
2215
|
+
* Min: 1 participant
|
|
2216
|
+
* @min 1
|
|
2217
|
+
*/
|
|
2218
|
+
maxParticipantsPerBooking?: number;
|
|
2219
|
+
}
|
|
2220
|
+
/** The policy regarding the allocation of resources (e.g. staff members). */
|
|
2221
|
+
interface ResourcesPolicy {
|
|
2222
|
+
/**
|
|
2223
|
+
* `true` if this policy is enabled, `false` otherwise.
|
|
2224
|
+
* When `false` then the client must always select a resource when booking an appointment.
|
|
2225
|
+
*/
|
|
2226
|
+
enabled?: boolean;
|
|
2227
|
+
/**
|
|
2228
|
+
* `true`, if it is allowed to automatically assign a resource when booking an appointment,
|
|
2229
|
+
* `false`, if the client must always select a resource.
|
|
2230
|
+
*
|
|
2231
|
+
* Default: `false`
|
|
2232
|
+
*/
|
|
2233
|
+
autoAssignAllowed?: boolean;
|
|
2234
|
+
}
|
|
2235
|
+
interface CancellationFeePolicy {
|
|
2236
|
+
/**
|
|
2237
|
+
* Whether canceling a booking will result in a cancellation fee
|
|
2238
|
+
*
|
|
2239
|
+
* Default: `false`
|
|
2240
|
+
*/
|
|
2241
|
+
enabled?: boolean;
|
|
2242
|
+
/**
|
|
2243
|
+
* Cancellation windows describing the time of cancellation and the fee to charge.
|
|
2244
|
+
* @maxSize 2
|
|
2245
|
+
*/
|
|
2246
|
+
cancellationWindows?: CancellationWindow[];
|
|
2247
|
+
/**
|
|
2248
|
+
* Whether the cancellation fee should not be automatically collected when customer cancels the booking.
|
|
2249
|
+
*
|
|
2250
|
+
* Default: `true`
|
|
2251
|
+
*/
|
|
2252
|
+
autoCollectFeeEnabled?: boolean | null;
|
|
2253
|
+
}
|
|
2254
|
+
interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
2255
|
+
/** Amount to be charged as a cancellation fee. */
|
|
2256
|
+
amount?: Money;
|
|
2257
|
+
/**
|
|
2258
|
+
* Percentage of the original price to be charged as a cancellation fee.
|
|
2259
|
+
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
2260
|
+
*/
|
|
2261
|
+
percentage?: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* The fee will be applied if the booked session starts within this start time in minutes.
|
|
2264
|
+
* @min 1
|
|
2265
|
+
*/
|
|
2266
|
+
startInMinutes?: number | null;
|
|
2267
|
+
}
|
|
2268
|
+
/** @oneof */
|
|
2269
|
+
interface CancellationWindowFeeOneOf {
|
|
2270
|
+
/** Amount to be charged as a cancellation fee. */
|
|
2271
|
+
amount?: Money;
|
|
2272
|
+
/**
|
|
2273
|
+
* Percentage of the original price to be charged as a cancellation fee.
|
|
2274
|
+
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
2275
|
+
*/
|
|
2276
|
+
percentage?: string;
|
|
2277
|
+
}
|
|
2278
|
+
interface SaveCreditCardPolicy {
|
|
2279
|
+
/** Default: `false` */
|
|
2280
|
+
enabled?: boolean;
|
|
2281
|
+
}
|
|
2282
|
+
/**
|
|
2283
|
+
* Policy for determining how staff members are sorted and selected during the booking process.
|
|
2284
|
+
* This affects which staff member is chosen when multiple staff members are available for a service.
|
|
2285
|
+
*/
|
|
2286
|
+
/** Policy for integrating with Intake form. Stores which form to use and when to present it. */
|
|
2287
|
+
interface IntakeFormPolicy {
|
|
2288
|
+
/**
|
|
2289
|
+
* Whether intake form integration is enabled for the service.
|
|
2290
|
+
* Default: `false`
|
|
2291
|
+
*/
|
|
2292
|
+
enabled?: boolean;
|
|
2293
|
+
/**
|
|
2294
|
+
* ID of the intake form to integrate with the service.
|
|
2295
|
+
* @format GUID
|
|
2296
|
+
*/
|
|
2297
|
+
formId?: string | null;
|
|
2298
|
+
/** When to present the intake form to the customer. */
|
|
2299
|
+
timing?: TimingWithLiterals;
|
|
2300
|
+
completionRequirement?: CompletionRequirementWithLiterals;
|
|
2301
|
+
}
|
|
2302
|
+
declare enum Timing {
|
|
2303
|
+
/** Send form after booking. */
|
|
2304
|
+
AFTER_BOOKING = "AFTER_BOOKING",
|
|
2305
|
+
/** Show form during booking flow. */
|
|
2306
|
+
BEFORE_BOOKING = "BEFORE_BOOKING"
|
|
2307
|
+
}
|
|
2308
|
+
/** @enumType */
|
|
2309
|
+
type TimingWithLiterals = Timing | 'AFTER_BOOKING' | 'BEFORE_BOOKING';
|
|
2310
|
+
/** Requirement for completing the intake form. */
|
|
2311
|
+
declare enum CompletionRequirement {
|
|
2312
|
+
/** Form completion is optional and can be skipped entirely. */
|
|
2313
|
+
OPTIONAL = "OPTIONAL",
|
|
2314
|
+
/**
|
|
2315
|
+
* Form must be completed before the booking can be finalized.
|
|
2316
|
+
* can used only if timing is BEFORE_BOOKING.
|
|
2317
|
+
*/
|
|
2318
|
+
REQUIRED_BEFORE_BOOKING = "REQUIRED_BEFORE_BOOKING"
|
|
2319
|
+
}
|
|
2320
|
+
/** @enumType */
|
|
2321
|
+
type CompletionRequirementWithLiterals = CompletionRequirement | 'OPTIONAL' | 'REQUIRED_BEFORE_BOOKING';
|
|
2322
|
+
/**
|
|
2323
|
+
* Rule limiting how many times the same customer can book a service within a given period.
|
|
2324
|
+
* The first booking is always allowed; the limit constrains additional bookings.
|
|
2325
|
+
*/
|
|
2326
|
+
interface Schedule {
|
|
2327
|
+
/**
|
|
2328
|
+
* ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
2329
|
+
* to which the service's events belong.
|
|
2330
|
+
* @format GUID
|
|
2331
|
+
* @readonly
|
|
2332
|
+
*/
|
|
2333
|
+
_id?: string | null;
|
|
2334
|
+
/**
|
|
2335
|
+
* Start time of the first session in the schedule. For courses only.
|
|
2336
|
+
* @readonly
|
|
2337
|
+
*/
|
|
2338
|
+
firstSessionStart?: Date | null;
|
|
2339
|
+
/**
|
|
2340
|
+
* End time of the last session in the schedule. For courses only.
|
|
2341
|
+
* @readonly
|
|
2342
|
+
*/
|
|
2343
|
+
lastSessionEnd?: Date | null;
|
|
2344
|
+
/** Limitations affecting the service availability. */
|
|
2345
|
+
availabilityConstraints?: AvailabilityConstraints;
|
|
2346
|
+
}
|
|
2347
|
+
interface AvailabilityConstraints {
|
|
2348
|
+
/**
|
|
2349
|
+
* Calculated list of all supported session durations for the service. For
|
|
2350
|
+
* appointment-based services without varied pricing based on session length, it
|
|
2351
|
+
* matches the single value in the `sessionDurations` array. For appointment-based
|
|
2352
|
+
* services with varied pricing based on session length, it includes session
|
|
2353
|
+
* durations for all [variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction),
|
|
2354
|
+
* while ignoring `sessionDurations`.
|
|
2355
|
+
* For courses and classes, it includes durations for all future
|
|
2356
|
+
* recurring sessions but excludes durations for one-off or past recurring sessions.
|
|
2357
|
+
* @readonly
|
|
2358
|
+
* @maxSize 50
|
|
2359
|
+
*/
|
|
2360
|
+
durations?: V2Duration[];
|
|
2361
|
+
/**
|
|
2362
|
+
* List of supported session durations in minutes.
|
|
2363
|
+
*
|
|
2364
|
+
* - For appointment-based services, specify `sessionDurations` when creating a service.
|
|
2365
|
+
* - For appointment-based services with varied pricing by session length, you must still specify `sessionDurations`, but the values are ignored. Actual durations are taken from the [service variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2366
|
+
* - For classes or courses, don't specify `sessionDurations` when creating a service.
|
|
2367
|
+
* @min 1
|
|
2368
|
+
* @max 44639
|
|
2369
|
+
* @maxSize 50
|
|
2370
|
+
*/
|
|
2371
|
+
sessionDurations?: number[];
|
|
2372
|
+
/**
|
|
2373
|
+
* The number of minutes between the end of a session and the start of the next.
|
|
2374
|
+
* @max 720
|
|
2375
|
+
*/
|
|
2376
|
+
timeBetweenSessions?: number;
|
|
2377
|
+
/**
|
|
2378
|
+
* Duration range for the service. When set, the customer picks a duration
|
|
2379
|
+
* within the configured min/max range instead of a fixed session duration.
|
|
2380
|
+
* Mutually exclusive with `sessionDurations`. A service uses one or the other.
|
|
2381
|
+
* Can't be combined with `workingHours`.
|
|
2382
|
+
*
|
|
2383
|
+
* Use `durationRange` for services where the customer chooses how long to book,
|
|
2384
|
+
* such as equipment or space rentals. The `unitType` determines whether the range
|
|
2385
|
+
* is measured in hours or days.
|
|
2386
|
+
*/
|
|
2387
|
+
durationRange?: DurationRange;
|
|
2388
|
+
}
|
|
2389
|
+
interface V2Duration {
|
|
2390
|
+
/**
|
|
2391
|
+
* The duration of the service in minutes.
|
|
2392
|
+
* @min 1
|
|
2393
|
+
* @max 44639
|
|
2394
|
+
*/
|
|
2395
|
+
minutes?: number;
|
|
2396
|
+
}
|
|
2397
|
+
/**
|
|
2398
|
+
* Duration range configuration for a service. Defines the minimum and maximum
|
|
2399
|
+
* booking duration a customer can select, and the unit of measurement.
|
|
2400
|
+
*
|
|
2401
|
+
* For hourly services, durations are configured in minutes via `hourOptions`.
|
|
2402
|
+
* For daily services, durations are configured in days via `dayOptions`.
|
|
2403
|
+
*/
|
|
2404
|
+
interface DurationRange extends DurationRangeConfigOneOf {
|
|
2405
|
+
/** Configuration for hourly duration ranges. Set when `unitType` is `HOUR`. */
|
|
2406
|
+
hourOptions?: HourlyConfig;
|
|
2407
|
+
/** Configuration for daily duration ranges. Set when `unitType` is `DAY`. */
|
|
2408
|
+
dayOptions?: DailyConfig;
|
|
2409
|
+
/** The unit type for this duration range. Determines which configuration to use in the `config` union. */
|
|
2410
|
+
unitType?: UnitTypeWithLiterals;
|
|
2411
|
+
}
|
|
2412
|
+
/** @oneof */
|
|
2413
|
+
interface DurationRangeConfigOneOf {
|
|
2414
|
+
/** Configuration for hourly duration ranges. Set when `unitType` is `HOUR`. */
|
|
2415
|
+
hourOptions?: HourlyConfig;
|
|
2416
|
+
/** Configuration for daily duration ranges. Set when `unitType` is `DAY`. */
|
|
2417
|
+
dayOptions?: DailyConfig;
|
|
2418
|
+
}
|
|
2419
|
+
/** The booking unit for the duration range. */
|
|
2420
|
+
declare enum UnitType {
|
|
2421
|
+
/** Hourly booking unit. Durations are configured in minutes via `hourOptions`. */
|
|
2422
|
+
HOUR = "HOUR",
|
|
2423
|
+
/** Daily booking unit. Durations are configured in days via `dayOptions`. */
|
|
2424
|
+
DAY = "DAY"
|
|
2425
|
+
}
|
|
2426
|
+
/** @enumType */
|
|
2427
|
+
type UnitTypeWithLiterals = UnitType | 'HOUR' | 'DAY';
|
|
2428
|
+
/** Hourly duration configuration. Durations are specified in minutes. */
|
|
2429
|
+
interface HourlyConfig {
|
|
2430
|
+
/**
|
|
2431
|
+
* Minimum bookable duration in minutes. The customer can't book for less than this duration.
|
|
2432
|
+
* @min 30
|
|
2433
|
+
* @max 1440
|
|
2434
|
+
*/
|
|
2435
|
+
minDurationInMinutes?: number;
|
|
2436
|
+
/**
|
|
2437
|
+
* Maximum bookable duration in minutes. The customer can't book for more than this duration.
|
|
2438
|
+
*
|
|
2439
|
+
* Must be greater than or equal to `minDurationInMinutes`.
|
|
2440
|
+
* @min 30
|
|
2441
|
+
* @max 1440
|
|
2442
|
+
*/
|
|
2443
|
+
maxDurationInMinutes?: number;
|
|
2444
|
+
}
|
|
2445
|
+
/** Daily duration configuration. Durations are specified in days. */
|
|
2446
|
+
interface DailyConfig {
|
|
2447
|
+
/**
|
|
2448
|
+
* Minimum bookable duration in days. The customer can't book for less than this number of days.
|
|
2449
|
+
* @min 1
|
|
2450
|
+
* @max 40
|
|
2451
|
+
*/
|
|
2452
|
+
minDurationInDays?: number;
|
|
2453
|
+
/**
|
|
2454
|
+
* Maximum bookable duration in days. The customer can't book for more than this number of days.
|
|
2455
|
+
*
|
|
2456
|
+
* Must be greater than or equal to `minDurationInDays`.
|
|
2457
|
+
* @min 1
|
|
2458
|
+
* @max 40
|
|
2459
|
+
*/
|
|
2460
|
+
maxDurationInDays?: number;
|
|
2461
|
+
}
|
|
2462
|
+
/**
|
|
2463
|
+
* Controls how a service's own working hours combine with the working hours of its assigned
|
|
2464
|
+
* staff members and required resources. The hours themselves are not held here. They are the
|
|
2465
|
+
* `WORKING_HOURS` events on the service's schedule (`schedule.id`), and this message controls
|
|
2466
|
+
* only how they combine with the resources working hours.
|
|
2467
|
+
*/
|
|
2468
|
+
interface StaffMember {
|
|
2469
|
+
/**
|
|
2470
|
+
* ID of the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) associated with the staff member providing the service.
|
|
2471
|
+
* Despite the field name, this is the resource ID, not the staff member ID.
|
|
2472
|
+
* This value matches the staff member's `resourceId` from the [Staff Members API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-members/introduction)
|
|
2473
|
+
* and corresponds to the IDs in the service's `staffMemberIds` field.
|
|
2474
|
+
* @format GUID
|
|
2475
|
+
* @readonly
|
|
2476
|
+
*/
|
|
2477
|
+
staffMemberId?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* Name of the staff member
|
|
2480
|
+
* @maxLength 40
|
|
2481
|
+
* @readonly
|
|
2482
|
+
*/
|
|
2483
|
+
name?: string | null;
|
|
2484
|
+
/**
|
|
2485
|
+
* Main media associated with the service.
|
|
2486
|
+
* @readonly
|
|
2487
|
+
*/
|
|
2488
|
+
mainMedia?: StaffMediaItem;
|
|
2489
|
+
}
|
|
2490
|
+
interface StaffMediaItem extends StaffMediaItemItemOneOf {
|
|
2491
|
+
/** Details of the image associated with the staff, such as URL and size. */
|
|
2492
|
+
image?: string;
|
|
2493
|
+
}
|
|
2494
|
+
/** @oneof */
|
|
2495
|
+
interface StaffMediaItemItemOneOf {
|
|
2496
|
+
/** Details of the image associated with the staff, such as URL and size. */
|
|
2497
|
+
image?: string;
|
|
2498
|
+
}
|
|
2499
|
+
/**
|
|
2500
|
+
* Working hours location coverage derived from Calendar v3 WORKING_HOURS events
|
|
2501
|
+
* (`NONE` and `MASTER` recurrence types). The server paginates through Calendar results
|
|
2502
|
+
* (100 events per page) until all matching events are collected.
|
|
2503
|
+
*
|
|
2504
|
+
* Coverage states when enrichment is requested:
|
|
2505
|
+
* + `available_at_all_locations = true`: Staff applies to every business location. Set when the staff
|
|
2506
|
+
* uses default business working hours, or has any WORKING_HOURS event without a location ID
|
|
2507
|
+
* (including when mixed with location-specific events).
|
|
2508
|
+
* + `available_at_all_locations = false` with non-empty `location_ids`: Staff has location-specific
|
|
2509
|
+
* WORKING_HOURS only. Show the staff member only when the selected location is in `location_ids`.
|
|
2510
|
+
* + `available_at_all_locations = false` with empty `location_ids`: Staff has working-hours schedules
|
|
2511
|
+
* but no applicable location coverage was found.
|
|
2512
|
+
*
|
|
2513
|
+
* Recommended client filter:
|
|
2514
|
+
* `availableAtAllLocations || locationIds.includes(selectedLocationId)`
|
|
2515
|
+
*
|
|
2516
|
+
* Omitted when `STAFF_WORKING_HOURS_LOCATIONS` is not requested.
|
|
2517
|
+
*/
|
|
2518
|
+
interface StaffMemberDetails {
|
|
2519
|
+
/**
|
|
2520
|
+
* Staff members providing the service. For appointments only.
|
|
2521
|
+
* @maxSize 220
|
|
2522
|
+
*/
|
|
2523
|
+
staffMembers?: StaffMember[];
|
|
2524
|
+
}
|
|
2525
|
+
interface ResourceIds {
|
|
2526
|
+
/**
|
|
2527
|
+
* Values of the resource IDs.
|
|
2528
|
+
* @maxSize 100
|
|
2529
|
+
* @format GUID
|
|
2530
|
+
*/
|
|
2531
|
+
values?: string[];
|
|
2532
|
+
}
|
|
2533
|
+
interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
2534
|
+
/**
|
|
2535
|
+
* IDs of specific [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction)
|
|
2536
|
+
* assigned to this service resource. Each ID must reference a resource within the specified `resourceType`.
|
|
2537
|
+
*
|
|
2538
|
+
* When set, only these resources are considered for availability and booking.
|
|
2539
|
+
* When not set, all resources of the specified resource type are eligible.
|
|
2540
|
+
*/
|
|
2541
|
+
resourceIds?: ResourceIds;
|
|
2542
|
+
/** Details about the required [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction). */
|
|
2543
|
+
resourceType?: ResourceType;
|
|
2544
|
+
}
|
|
2545
|
+
/** @oneof */
|
|
2546
|
+
interface ServiceResourceSelectionOneOf {
|
|
2547
|
+
/**
|
|
2548
|
+
* IDs of specific [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction)
|
|
2549
|
+
* assigned to this service resource. Each ID must reference a resource within the specified `resourceType`.
|
|
2550
|
+
*
|
|
2551
|
+
* When set, only these resources are considered for availability and booking.
|
|
2552
|
+
* When not set, all resources of the specified resource type are eligible.
|
|
2553
|
+
*/
|
|
2554
|
+
resourceIds?: ResourceIds;
|
|
2555
|
+
}
|
|
2556
|
+
interface ResourceType {
|
|
2557
|
+
/**
|
|
2558
|
+
* The type of the resource.
|
|
2559
|
+
* @format GUID
|
|
2560
|
+
*/
|
|
2561
|
+
_id?: string | null;
|
|
2562
|
+
/**
|
|
2563
|
+
* The name of the resource type.
|
|
2564
|
+
* @readonly
|
|
2565
|
+
* @maxLength 40
|
|
2566
|
+
* @minLength 1
|
|
2567
|
+
*/
|
|
2568
|
+
name?: string | null;
|
|
2569
|
+
}
|
|
2570
|
+
/** Details about the individual resources assigned to a service resource. */
|
|
2571
|
+
interface Slug {
|
|
2572
|
+
/**
|
|
2573
|
+
* The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`.
|
|
2574
|
+
* @maxLength 500
|
|
2575
|
+
*/
|
|
2576
|
+
name?: string;
|
|
2577
|
+
/**
|
|
2578
|
+
* Whether the slug was generated or customized. If `true`, the slug was customized manually by the business owner. Otherwise, the slug was automatically generated from the service name.
|
|
2579
|
+
* @readonly
|
|
2580
|
+
*/
|
|
2581
|
+
custom?: boolean | null;
|
|
2582
|
+
/**
|
|
2583
|
+
* Date and time the slug was created. This is a system field.
|
|
2584
|
+
* @readonly
|
|
2585
|
+
*/
|
|
2586
|
+
_createdDate?: Date | null;
|
|
2587
|
+
}
|
|
2588
|
+
interface URLs {
|
|
2589
|
+
/**
|
|
2590
|
+
* The URL for the service page.
|
|
2591
|
+
* @readonly
|
|
2592
|
+
*/
|
|
2593
|
+
servicePage?: string;
|
|
2594
|
+
/**
|
|
2595
|
+
* The URL for the booking entry point. It can be either to the calendar or to the service page.
|
|
2596
|
+
* @readonly
|
|
2597
|
+
*/
|
|
2598
|
+
bookingPage?: string;
|
|
2599
|
+
/**
|
|
2600
|
+
* The URL for the calendar. Can be empty if no calendar exists.
|
|
2601
|
+
* @readonly
|
|
2602
|
+
*/
|
|
2603
|
+
calendarPage?: string;
|
|
2604
|
+
}
|
|
2605
|
+
interface ExtendedFields {
|
|
2606
|
+
/**
|
|
2607
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
2608
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
2609
|
+
*
|
|
2610
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
2611
|
+
*
|
|
2612
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
2613
|
+
*/
|
|
2614
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
2615
|
+
}
|
|
2616
|
+
/**
|
|
2617
|
+
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
2618
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
2619
|
+
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
2620
|
+
*/
|
|
2621
|
+
interface SeoSchema {
|
|
2622
|
+
/** SEO tag information. */
|
|
2623
|
+
tags?: Tag[];
|
|
2624
|
+
/** SEO general settings. */
|
|
2625
|
+
settings?: Settings;
|
|
2626
|
+
}
|
|
2627
|
+
interface Keyword {
|
|
2628
|
+
/** Keyword value. */
|
|
2629
|
+
term?: string;
|
|
2630
|
+
/** Whether the keyword is the main focus keyword. */
|
|
2631
|
+
isMain?: boolean;
|
|
2632
|
+
/**
|
|
2633
|
+
* The source that added the keyword terms to the SEO settings.
|
|
2634
|
+
* @maxLength 1000
|
|
2635
|
+
*/
|
|
2636
|
+
origin?: string | null;
|
|
2637
|
+
}
|
|
2638
|
+
interface Tag {
|
|
2639
|
+
/**
|
|
2640
|
+
* SEO tag type.
|
|
2641
|
+
*
|
|
2642
|
+
*
|
|
2643
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
2644
|
+
*
|
|
2645
|
+
* Which of these an API actually accepts depends on where the tag is being set: this
|
|
2646
|
+
* list is not a blanket guarantee across every API that reuses this message. Site SEO
|
|
2647
|
+
* Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
|
|
2648
|
+
* `title`/`script`/`link` with a validation error even though they appear here —
|
|
2649
|
+
* check the field description of the specific `tags`-typed field you're writing to
|
|
2650
|
+
* for the types it actually supports and the error it returns.
|
|
2651
|
+
*
|
|
2652
|
+
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
2653
|
+
* `"application/ld+json"` carrying structured data) are supported only when
|
|
2654
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
|
|
2655
|
+
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
|
|
2656
|
+
* write through the site's Advanced/Custom Tags list. To write structured data,
|
|
2657
|
+
* omit `custom` (or set it to `false`).
|
|
2658
|
+
*/
|
|
2659
|
+
type?: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
|
|
2662
|
+
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
2663
|
+
*/
|
|
2664
|
+
props?: Record<string, any> | null;
|
|
2665
|
+
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
2666
|
+
meta?: Record<string, any> | null;
|
|
2667
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
2668
|
+
children?: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
2671
|
+
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
2672
|
+
*
|
|
2673
|
+
* Setting this to `true` on a write restricts which `type` values are accepted
|
|
2674
|
+
* — the same restriction the Advanced/Custom Tags UI enforces. `title` and
|
|
2675
|
+
* `script` tags (including JSON-LD structured data) must be sent with `custom`
|
|
2676
|
+
* omitted or `false`; sending them with `custom: true` is rejected with
|
|
2677
|
+
* `TAG_TYPE_NOT_ALLOWED`.
|
|
2678
|
+
*
|
|
2679
|
+
* Note this is a separate restriction from Site SEO Tags' own type restriction on
|
|
2680
|
+
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
|
|
2681
|
+
* for site-wide structured data) unconditionally. There is currently no way to set
|
|
2682
|
+
* site-wide, every-page structured data through any of these APIs — write a per-page
|
|
2683
|
+
* `script` tag through the Item SEO Tags API instead.
|
|
2684
|
+
*
|
|
2685
|
+
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
2686
|
+
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
2687
|
+
* default/pattern — standard tags always resolve with `custom: false`, even when their content comes
|
|
2688
|
+
* from a page's manually saved SEO title/description override. Don't use this field to verify whether
|
|
2689
|
+
* a live page reflects a manual per-page SEO edit.
|
|
2690
|
+
*
|
|
2691
|
+
* Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
|
|
2692
|
+
* only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
|
|
2693
|
+
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
2694
|
+
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
2695
|
+
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
2696
|
+
*/
|
|
2697
|
+
custom?: boolean;
|
|
2698
|
+
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
2699
|
+
disabled?: boolean;
|
|
2700
|
+
}
|
|
2701
|
+
interface Settings {
|
|
2702
|
+
/**
|
|
2703
|
+
* Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
|
|
2704
|
+
*
|
|
2705
|
+
*
|
|
2706
|
+
* Default: `false` (automatical redirect is enabled).
|
|
2707
|
+
*/
|
|
2708
|
+
preventAutoRedirect?: boolean;
|
|
2709
|
+
/**
|
|
2710
|
+
* User-selected keyword terms for a specific page.
|
|
2711
|
+
* @maxSize 5
|
|
2712
|
+
*/
|
|
2713
|
+
keywords?: Keyword[];
|
|
2714
|
+
}
|
|
2715
|
+
interface AddOnGroup {
|
|
2716
|
+
/**
|
|
2717
|
+
* ID of the add-on group.
|
|
2718
|
+
* Wix Bookings automatically populates this field when creating or updating an add-on group.
|
|
2719
|
+
* @readonly
|
|
2720
|
+
* @format GUID
|
|
2721
|
+
*/
|
|
2722
|
+
_id?: string | null;
|
|
2723
|
+
/**
|
|
2724
|
+
* Name of the add-on group.
|
|
2725
|
+
* @maxLength 100
|
|
2726
|
+
*/
|
|
2727
|
+
name?: string | null;
|
|
2728
|
+
/**
|
|
2729
|
+
* Maximum number of different [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) from the group customers can add when booking the service.
|
|
2730
|
+
* When empty, there's no upper limit.
|
|
2731
|
+
*/
|
|
2732
|
+
maxNumberOfAddOns?: number | null;
|
|
2733
|
+
/**
|
|
2734
|
+
* List of IDs of all [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) included in the group.
|
|
2735
|
+
* @format GUID
|
|
2736
|
+
* @maxSize 7
|
|
2737
|
+
*/
|
|
2738
|
+
addOnIds?: string[] | null;
|
|
2739
|
+
/**
|
|
2740
|
+
* Description or instructional prompt of the add-on group that's displayed to customers when booking the service.
|
|
2741
|
+
* @maxLength 200
|
|
2742
|
+
*/
|
|
2743
|
+
prompt?: string | null;
|
|
2744
|
+
}
|
|
2745
|
+
interface AddOnDetails {
|
|
2746
|
+
/**
|
|
2747
|
+
* ID of the add-on.
|
|
2748
|
+
* @format GUID
|
|
2749
|
+
*/
|
|
2750
|
+
addOnId?: string | null;
|
|
2751
|
+
/**
|
|
2752
|
+
* Duration in minutes for add-ons that extend service time.
|
|
2753
|
+
* Empty for [quantity-based add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction#terminology).
|
|
2754
|
+
*/
|
|
2755
|
+
durationInMinutes?: number | null;
|
|
2756
|
+
}
|
|
2757
|
+
/** `TaxableAddress` defines the taxable address used for the service. */
|
|
2758
|
+
interface TaxableAddress {
|
|
2759
|
+
/** Taxable address type. */
|
|
2760
|
+
taxableAddressType?: TaxableAddressTypeWithLiterals;
|
|
2761
|
+
}
|
|
2762
|
+
declare enum TaxableAddressType {
|
|
2763
|
+
BUSINESS = "BUSINESS",
|
|
2764
|
+
BILLING = "BILLING"
|
|
2765
|
+
}
|
|
2766
|
+
/** @enumType */
|
|
2767
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'BUSINESS' | 'BILLING';
|
|
2768
|
+
//#endregion
|
|
2769
|
+
//#region ../../node_modules/@wix/auto_sdk_bookings_bookings-settings/build/es/index.typings.d.mts
|
|
2770
|
+
declare enum BasedOn {
|
|
2771
|
+
/** Times are displayed in the business's time zone. */
|
|
2772
|
+
BUSINESS_TIME_ZONE = "BUSINESS_TIME_ZONE",
|
|
2773
|
+
/** Times are displayed in the customer's time zone. */
|
|
2774
|
+
CUSTOMER_TIME_ZONE = "CUSTOMER_TIME_ZONE"
|
|
2775
|
+
}
|
|
2776
|
+
/** @enumType */
|
|
2777
|
+
type BasedOnWithLiterals = BasedOn | 'BUSINESS_TIME_ZONE' | 'CUSTOMER_TIME_ZONE';
|
|
2778
|
+
//#endregion
|
|
2779
|
+
//#region src/api/adapters/service/service.d.ts
|
|
2780
|
+
type Service = Service$1;
|
|
2781
|
+
//#endregion
|
|
2782
|
+
//#region src/api/adapters/service-options-and-variants/service-options-and-variants.d.ts
|
|
2783
|
+
type ServiceOptionsAndVariants = ServiceOptionsAndVariants$1;
|
|
2784
|
+
//#endregion
|
|
2785
|
+
//#region src/api/adapters/bookings-settings/bookings-settings.d.ts
|
|
2786
|
+
/** A policy, not an IANA zone: the real zone needs the business zone from site properties. */
|
|
2787
|
+
type DisplayTimeZonePolicy = {
|
|
2788
|
+
basedOn: BasedOnWithLiterals;
|
|
2789
|
+
customerCanChange: boolean;
|
|
2790
|
+
};
|
|
2791
|
+
interface ExposedBookingsSettings {
|
|
2792
|
+
displayTimeZonePolicy: DisplayTimeZonePolicy;
|
|
2793
|
+
multiServiceAppointmentsEnabled: boolean;
|
|
2794
|
+
}
|
|
2795
|
+
//#endregion
|
|
2796
|
+
//#region src/lib/picker-filter.d.ts
|
|
2797
|
+
/** One field of a panel filter backed by an Items Selection provider (`$in`, or `$eq` after an operator switch). */
|
|
2798
|
+
interface PickerRule {
|
|
2799
|
+
$in?: string[];
|
|
2800
|
+
$eq?: string;
|
|
2801
|
+
}
|
|
2802
|
+
interface CategoriesPickerFilter {
|
|
2803
|
+
categoryId?: PickerRule;
|
|
2804
|
+
}
|
|
2805
|
+
//#endregion
|
|
2806
|
+
//#region src/extensions/contexts/services-context/services-context.d.ts
|
|
2807
|
+
/** Raw data only; the nested service-context derives display values. Not for direct binding. */
|
|
2808
|
+
interface ServiceItem {
|
|
2809
|
+
serviceId: string | null;
|
|
2810
|
+
refreshSignal: number;
|
|
2811
|
+
service: Service;
|
|
2812
|
+
masterEvents: Event[];
|
|
2813
|
+
/** Null when not VARIED, not loaded yet, or failed (a failed refetch keeps the last value). */
|
|
2814
|
+
serviceOptionsAndVariants: ServiceOptionsAndVariants | null;
|
|
2815
|
+
bookingsSettings: ExposedBookingsSettings;
|
|
2816
|
+
/**
|
|
2817
|
+
* The service page, resolved like every in-app link to it (custom URL structure first). Read by
|
|
2818
|
+
* the gallery converter (data-conversions), which has no site services to resolve it itself.
|
|
2819
|
+
* Runtime-only: not declared in the manifest, so it is not a bindable field (the full item rides
|
|
2820
|
+
* through regardless). Null when the page can't be resolved (no slug, no service page section).
|
|
2821
|
+
*/
|
|
2822
|
+
servicePageLink: Link | null;
|
|
2823
|
+
}
|
|
2824
|
+
/** The loaded bookable services, with load-more paging and the category and location they are filtered by. */
|
|
2825
|
+
interface ServicesContextValue {
|
|
2826
|
+
serviceItems: ServiceItem[];
|
|
2827
|
+
bookingsSettings: ExposedBookingsSettings | null;
|
|
2828
|
+
hasMore: boolean;
|
|
2829
|
+
isLoading: boolean;
|
|
2830
|
+
hasError: boolean;
|
|
2831
|
+
categoryId: string | null;
|
|
2832
|
+
locationId: string | null;
|
|
2833
|
+
loadMore: () => Promise<void>;
|
|
2834
|
+
}
|
|
2835
|
+
interface ServicesPickerFilter {
|
|
2836
|
+
serviceId?: PickerRule;
|
|
2837
|
+
}
|
|
2838
|
+
/** Props accepted by {@link ServicesContextProvider}. */
|
|
2839
|
+
interface ServicesContextProviderProps {
|
|
2840
|
+
categoryData?: {
|
|
2841
|
+
categoryId?: string | null;
|
|
2842
|
+
};
|
|
2843
|
+
limit?: number;
|
|
2844
|
+
servicesPicker?: ServicesPickerFilter;
|
|
2845
|
+
categoriesPicker?: CategoriesPickerFilter;
|
|
2846
|
+
refreshSignal?: number;
|
|
2847
|
+
children: ReactNode;
|
|
2848
|
+
}
|
|
2849
|
+
declare const servicesContext: React.Context<ServicesContextValue | null>;
|
|
2850
|
+
declare const SERVICES_CONTEXT_MISSING_PROVIDER_ERROR = "useServicesContext must be used within ServicesContextProvider";
|
|
2851
|
+
/** Reads the services list state; throws when no ServicesContextProvider is above. */
|
|
2852
|
+
declare function useServicesContext(): ServicesContextValue;
|
|
2853
|
+
/** Loads a paged list of bookable services, filtered by the category and location in the page URL or a category-list item, and narrowed by the service and category pickers. */
|
|
2854
|
+
declare function ServicesContextProvider({
|
|
2855
|
+
categoryData,
|
|
2856
|
+
limit,
|
|
2857
|
+
servicesPicker,
|
|
2858
|
+
categoriesPicker,
|
|
2859
|
+
refreshSignal,
|
|
2860
|
+
children
|
|
2861
|
+
}: ServicesContextProviderProps): React.JSX.Element;
|
|
2862
|
+
//#endregion
|
|
2863
|
+
export { type CategoriesPickerFilter, SERVICES_CONTEXT_MISSING_PROVIDER_ERROR, ServiceItem, ServicesContextProviderProps, ServicesContextValue, ServicesPickerFilter, ServicesContextProvider as default, servicesContext, useServicesContext };
|