@wix/auto_sdk_bookings_services 1.0.53 → 1.0.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{es/src/bookings-services-v2-service-services.types.d.ts → bookings-services-v2-service-services.universal-B8YoV8-Q.d.mts} +895 -374
- package/build/{cjs/src/bookings-services-v2-service-services.types.d.ts → bookings-services-v2-service-services.universal-B8YoV8-Q.d.ts} +895 -374
- package/build/{internal/cjs/src/bookings-services-v2-service-services.public.d.ts → index.d.mts} +66 -31
- package/build/{internal/es/src/bookings-services-v2-service-services.public.d.ts → index.d.ts} +66 -31
- package/build/index.js +3306 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +3232 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/bookings-services-v2-service-services.types.d.ts → bookings-services-v2-service-services.universal-B8YoV8-Q.d.mts} +895 -374
- package/build/internal/{es/src/bookings-services-v2-service-services.types.d.ts → bookings-services-v2-service-services.universal-B8YoV8-Q.d.ts} +895 -374
- package/build/{cjs/src/bookings-services-v2-service-services.public.d.ts → internal/index.d.mts} +66 -31
- package/build/{es/src/bookings-services-v2-service-services.public.d.ts → internal/index.d.ts} +66 -31
- package/build/internal/index.js +3306 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +3232 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2350 -0
- package/build/internal/meta.d.ts +2350 -0
- package/build/internal/meta.js +1879 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1831 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2350 -0
- package/build/meta.d.ts +2350 -0
- package/build/meta.js +1879 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1831 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -56
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +0 -42
- package/build/cjs/src/bookings-services-v2-service-services.context.js +0 -72
- package/build/cjs/src/bookings-services-v2-service-services.context.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.http.d.ts +0 -498
- package/build/cjs/src/bookings-services-v2-service-services.http.js +0 -1904
- package/build/cjs/src/bookings-services-v2-service-services.http.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.meta.d.ts +0 -48
- package/build/cjs/src/bookings-services-v2-service-services.meta.js +0 -446
- package/build/cjs/src/bookings-services-v2-service-services.meta.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.public.js +0 -299
- package/build/cjs/src/bookings-services-v2-service-services.public.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.types.js +0 -235
- package/build/cjs/src/bookings-services-v2-service-services.types.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +0 -4833
- package/build/cjs/src/bookings-services-v2-service-services.universal.js +0 -2257
- package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -56
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.context.d.ts +0 -42
- package/build/es/src/bookings-services-v2-service-services.context.js +0 -42
- package/build/es/src/bookings-services-v2-service-services.context.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.http.d.ts +0 -498
- package/build/es/src/bookings-services-v2-service-services.http.js +0 -1879
- package/build/es/src/bookings-services-v2-service-services.http.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.meta.d.ts +0 -48
- package/build/es/src/bookings-services-v2-service-services.meta.js +0 -398
- package/build/es/src/bookings-services-v2-service-services.meta.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.public.js +0 -247
- package/build/es/src/bookings-services-v2-service-services.public.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.types.js +0 -232
- package/build/es/src/bookings-services-v2-service-services.types.js.map +0 -1
- package/build/es/src/bookings-services-v2-service-services.universal.d.ts +0 -4833
- package/build/es/src/bookings-services-v2-service-services.universal.js +0 -2209
- package/build/es/src/bookings-services-v2-service-services.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -56
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +0 -42
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +0 -72
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.d.ts +0 -498
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.js +0 -1904
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.d.ts +0 -48
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.js +0 -446
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js +0 -299
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +0 -235
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +0 -4833
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +0 -2257
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -56
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +0 -42
- package/build/internal/es/src/bookings-services-v2-service-services.context.js +0 -42
- package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.http.d.ts +0 -498
- package/build/internal/es/src/bookings-services-v2-service-services.http.js +0 -1879
- package/build/internal/es/src/bookings-services-v2-service-services.http.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.meta.d.ts +0 -48
- package/build/internal/es/src/bookings-services-v2-service-services.meta.js +0 -398
- package/build/internal/es/src/bookings-services-v2-service-services.meta.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.public.js +0 -247
- package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.types.js +0 -232
- package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +0 -1
- package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +0 -4833
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js +0 -2209
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +0 -1
|
@@ -1,11 +1,13 @@
|
|
|
1
|
+
import { SearchSpec, Search } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/** The `service` object represents an offering that a business provides to its customers. */
|
|
2
|
-
|
|
4
|
+
interface Service {
|
|
3
5
|
/**
|
|
4
6
|
* Service ID.
|
|
5
7
|
* @format GUID
|
|
6
8
|
* @readonly
|
|
7
9
|
*/
|
|
8
|
-
|
|
10
|
+
_id?: string | null;
|
|
9
11
|
/**
|
|
10
12
|
* Service type.
|
|
11
13
|
* Learn more about *service types*
|
|
@@ -122,12 +124,12 @@ export interface Service {
|
|
|
122
124
|
* Date and time the service was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
123
125
|
* @readonly
|
|
124
126
|
*/
|
|
125
|
-
|
|
127
|
+
_createdDate?: Date | null;
|
|
126
128
|
/**
|
|
127
129
|
* Date and time the service was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
128
130
|
* @readonly
|
|
129
131
|
*/
|
|
130
|
-
|
|
132
|
+
_updatedDate?: Date | null;
|
|
131
133
|
/**
|
|
132
134
|
* Revision number, which increments by 1 each time the service is updated. To
|
|
133
135
|
* prevent conflicting changes, the existing revision must be used when updating
|
|
@@ -136,7 +138,7 @@ export interface Service {
|
|
|
136
138
|
*/
|
|
137
139
|
revision?: string | null;
|
|
138
140
|
}
|
|
139
|
-
|
|
141
|
+
declare enum ServiceType {
|
|
140
142
|
/** Appointment-based service. */
|
|
141
143
|
APPOINTMENT = "APPOINTMENT",
|
|
142
144
|
/** Class service. */
|
|
@@ -145,8 +147,8 @@ export declare enum ServiceType {
|
|
|
145
147
|
COURSE = "COURSE"
|
|
146
148
|
}
|
|
147
149
|
/** @enumType */
|
|
148
|
-
|
|
149
|
-
|
|
150
|
+
type ServiceTypeWithLiterals = ServiceType | 'APPOINTMENT' | 'CLASS' | 'COURSE';
|
|
151
|
+
interface Media {
|
|
150
152
|
/**
|
|
151
153
|
* Media items associated with the service.
|
|
152
154
|
* @maxSize 100
|
|
@@ -157,48 +159,21 @@ export interface Media {
|
|
|
157
159
|
/** Cover media associated with the service. */
|
|
158
160
|
coverMedia?: MediaItem;
|
|
159
161
|
}
|
|
160
|
-
|
|
162
|
+
interface MediaItem extends MediaItemItemOneOf {
|
|
161
163
|
/** Details of the image associated with the service, such as URL and size. */
|
|
162
|
-
image?:
|
|
164
|
+
image?: string;
|
|
163
165
|
}
|
|
164
166
|
/** @oneof */
|
|
165
|
-
|
|
167
|
+
interface MediaItemItemOneOf {
|
|
166
168
|
/** Details of the image associated with the service, such as URL and size. */
|
|
167
|
-
image?:
|
|
169
|
+
image?: string;
|
|
168
170
|
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* WixMedia image ID. (e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg")
|
|
172
|
-
* @maxLength 2048
|
|
173
|
-
*/
|
|
174
|
-
id?: string;
|
|
175
|
-
/**
|
|
176
|
-
* Image URL. (similar to image.id e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg")
|
|
177
|
-
* @maxLength 2048
|
|
178
|
-
*/
|
|
179
|
-
url?: string;
|
|
180
|
-
/** Original image height. */
|
|
181
|
-
height?: number;
|
|
182
|
-
/** Original image width. */
|
|
183
|
-
width?: number;
|
|
184
|
-
/**
|
|
185
|
-
* Image alt text.
|
|
186
|
-
* @maxLength 134061
|
|
187
|
-
*/
|
|
188
|
-
altText?: string | null;
|
|
189
|
-
/**
|
|
190
|
-
* Image file name.
|
|
191
|
-
* @readonly
|
|
192
|
-
* @maxLength 2048
|
|
193
|
-
*/
|
|
194
|
-
filename?: string | null;
|
|
195
|
-
}
|
|
196
|
-
export interface V2Category {
|
|
171
|
+
interface V2Category {
|
|
197
172
|
/**
|
|
198
173
|
* Category ID.
|
|
199
174
|
* @format GUID
|
|
200
175
|
*/
|
|
201
|
-
|
|
176
|
+
_id?: string;
|
|
202
177
|
/**
|
|
203
178
|
* Category name.
|
|
204
179
|
* @maxLength 500
|
|
@@ -211,20 +186,20 @@ export interface V2Category {
|
|
|
211
186
|
*/
|
|
212
187
|
sortOrder?: number | null;
|
|
213
188
|
}
|
|
214
|
-
|
|
189
|
+
interface Form {
|
|
215
190
|
/**
|
|
216
191
|
* ID of the form associated with the service.
|
|
217
192
|
* The form information that you submit when booking includes contact details, participants, and other form fields set up for the service.
|
|
218
193
|
* You can manage the service booking form fields using the Bookings Forms API.
|
|
219
194
|
* @format GUID
|
|
220
195
|
*/
|
|
221
|
-
|
|
196
|
+
_id?: string;
|
|
222
197
|
}
|
|
223
|
-
|
|
198
|
+
interface FormSettings {
|
|
224
199
|
/** Whether the service booking form should be hidden from the site. */
|
|
225
200
|
hidden?: boolean | null;
|
|
226
201
|
}
|
|
227
|
-
|
|
202
|
+
interface Payment extends PaymentRateOneOf {
|
|
228
203
|
/**
|
|
229
204
|
* The details for the fixed price of the service.
|
|
230
205
|
*
|
|
@@ -257,7 +232,7 @@ export interface Payment extends PaymentRateOneOf {
|
|
|
257
232
|
pricingPlanIds?: string[];
|
|
258
233
|
}
|
|
259
234
|
/** @oneof */
|
|
260
|
-
|
|
235
|
+
interface PaymentRateOneOf {
|
|
261
236
|
/**
|
|
262
237
|
* The details for the fixed price of the service.
|
|
263
238
|
*
|
|
@@ -278,7 +253,7 @@ export interface PaymentRateOneOf {
|
|
|
278
253
|
*/
|
|
279
254
|
varied?: VariedPayment;
|
|
280
255
|
}
|
|
281
|
-
|
|
256
|
+
declare enum RateType {
|
|
282
257
|
/** Unknown rate type. */
|
|
283
258
|
UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
|
|
284
259
|
/** The service has a fixed price. */
|
|
@@ -291,8 +266,8 @@ export declare enum RateType {
|
|
|
291
266
|
NO_FEE = "NO_FEE"
|
|
292
267
|
}
|
|
293
268
|
/** @enumType */
|
|
294
|
-
|
|
295
|
-
|
|
269
|
+
type RateTypeWithLiterals = RateType | 'UNKNOWN_RATE_TYPE' | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE';
|
|
270
|
+
interface FixedPayment {
|
|
296
271
|
/**
|
|
297
272
|
* The fixed price required to book the service.
|
|
298
273
|
*
|
|
@@ -310,7 +285,7 @@ export interface FixedPayment {
|
|
|
310
285
|
* Money.
|
|
311
286
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
312
287
|
*/
|
|
313
|
-
|
|
288
|
+
interface Money {
|
|
314
289
|
/**
|
|
315
290
|
* 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.
|
|
316
291
|
* @format DECIMAL_VALUE
|
|
@@ -329,14 +304,14 @@ export interface Money {
|
|
|
329
304
|
*/
|
|
330
305
|
formattedValue?: string | null;
|
|
331
306
|
}
|
|
332
|
-
|
|
307
|
+
interface CustomPayment {
|
|
333
308
|
/**
|
|
334
309
|
* A custom description explaining to the customer how to pay for the service.
|
|
335
310
|
* @maxLength 50
|
|
336
311
|
*/
|
|
337
312
|
description?: string | null;
|
|
338
313
|
}
|
|
339
|
-
|
|
314
|
+
interface VariedPayment {
|
|
340
315
|
/** The default price for the service without any variants. It will also be used as the default price for any new variant. */
|
|
341
316
|
defaultPrice?: Money;
|
|
342
317
|
/**
|
|
@@ -356,7 +331,7 @@ export interface VariedPayment {
|
|
|
356
331
|
*/
|
|
357
332
|
maxPrice?: Money;
|
|
358
333
|
}
|
|
359
|
-
|
|
334
|
+
interface PaymentOptions {
|
|
360
335
|
/**
|
|
361
336
|
* Customers can pay for the service online.
|
|
362
337
|
* When `true`:
|
|
@@ -376,7 +351,7 @@ export interface PaymentOptions {
|
|
|
376
351
|
/** Customers can pay for the service using a pricing plan. */
|
|
377
352
|
pricingPlan?: boolean | null;
|
|
378
353
|
}
|
|
379
|
-
|
|
354
|
+
interface OnlineBooking {
|
|
380
355
|
/**
|
|
381
356
|
* Whether the service can be booked online.
|
|
382
357
|
* When set to `true`, customers can book the service online. Configure the payment options via the `service.payment` property.
|
|
@@ -388,11 +363,11 @@ export interface OnlineBooking {
|
|
|
388
363
|
/** Multiple customers can request to book the same time slot. This is relevant when `requireManualApproval` is `true`. */
|
|
389
364
|
allowMultipleRequests?: boolean | null;
|
|
390
365
|
}
|
|
391
|
-
|
|
366
|
+
interface Conferencing {
|
|
392
367
|
/** Whether a conference link is generated for the service's sessions. */
|
|
393
368
|
enabled?: boolean | null;
|
|
394
369
|
}
|
|
395
|
-
|
|
370
|
+
interface Location extends LocationOptionsOneOf {
|
|
396
371
|
/** Information about business locations. */
|
|
397
372
|
business?: BusinessLocationOptions;
|
|
398
373
|
/** Information about custom locations. */
|
|
@@ -402,7 +377,7 @@ export interface Location extends LocationOptionsOneOf {
|
|
|
402
377
|
* @format GUID
|
|
403
378
|
* @readonly
|
|
404
379
|
*/
|
|
405
|
-
|
|
380
|
+
_id?: string;
|
|
406
381
|
/**
|
|
407
382
|
* Location type.
|
|
408
383
|
*
|
|
@@ -416,13 +391,13 @@ export interface Location extends LocationOptionsOneOf {
|
|
|
416
391
|
calculatedAddress?: CommonAddress;
|
|
417
392
|
}
|
|
418
393
|
/** @oneof */
|
|
419
|
-
|
|
394
|
+
interface LocationOptionsOneOf {
|
|
420
395
|
/** Information about business locations. */
|
|
421
396
|
business?: BusinessLocationOptions;
|
|
422
397
|
/** Information about custom locations. */
|
|
423
398
|
custom?: CustomLocationOptions;
|
|
424
399
|
}
|
|
425
|
-
|
|
400
|
+
declare enum LocationType {
|
|
426
401
|
UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
|
|
427
402
|
/**
|
|
428
403
|
* Location set by the business that is not a standard business *location*
|
|
@@ -441,12 +416,12 @@ export declare enum LocationType {
|
|
|
441
416
|
CUSTOMER = "CUSTOMER"
|
|
442
417
|
}
|
|
443
418
|
/** @enumType */
|
|
444
|
-
|
|
445
|
-
|
|
419
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION_TYPE' | 'CUSTOM' | 'BUSINESS' | 'CUSTOMER';
|
|
420
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
446
421
|
/** Street name and number. */
|
|
447
422
|
streetAddress?: StreetAddress;
|
|
448
423
|
/** @maxLength 255 */
|
|
449
|
-
|
|
424
|
+
addressLine1?: string | null;
|
|
450
425
|
/**
|
|
451
426
|
* 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
452
427
|
* @format COUNTRY
|
|
@@ -471,17 +446,17 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
471
446
|
* Full address of the location.
|
|
472
447
|
* @maxLength 512
|
|
473
448
|
*/
|
|
474
|
-
|
|
449
|
+
formatted?: string | null;
|
|
475
450
|
}
|
|
476
451
|
/** @oneof */
|
|
477
|
-
|
|
452
|
+
interface CommonAddressStreetOneOf {
|
|
478
453
|
/** Street name and number. */
|
|
479
454
|
streetAddress?: StreetAddress;
|
|
480
455
|
/** @maxLength 255 */
|
|
481
456
|
addressLine?: string | null;
|
|
482
457
|
}
|
|
483
458
|
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
484
|
-
|
|
459
|
+
interface StreetAddress {
|
|
485
460
|
/**
|
|
486
461
|
* Street number.
|
|
487
462
|
* @maxLength 255
|
|
@@ -498,20 +473,20 @@ export interface StreetAddress {
|
|
|
498
473
|
*/
|
|
499
474
|
apt?: string;
|
|
500
475
|
}
|
|
501
|
-
|
|
476
|
+
interface AddressLocation {
|
|
502
477
|
/** Address latitude. */
|
|
503
478
|
latitude?: number | null;
|
|
504
479
|
/** Address longitude. */
|
|
505
480
|
longitude?: number | null;
|
|
506
481
|
}
|
|
507
|
-
|
|
482
|
+
interface BusinessLocationOptions {
|
|
508
483
|
/**
|
|
509
484
|
* ID of the business *location*
|
|
510
485
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
511
486
|
* When setting a business location, specify only the location ID. Other location details are overwritten.
|
|
512
487
|
* @format GUID
|
|
513
488
|
*/
|
|
514
|
-
|
|
489
|
+
_id?: string;
|
|
515
490
|
/**
|
|
516
491
|
* Business location name.
|
|
517
492
|
* @readonly
|
|
@@ -541,13 +516,13 @@ export interface BusinessLocationOptions {
|
|
|
541
516
|
*/
|
|
542
517
|
phone?: string | null;
|
|
543
518
|
}
|
|
544
|
-
|
|
519
|
+
interface CustomLocationOptions {
|
|
545
520
|
/**
|
|
546
521
|
* ID of the custom location.
|
|
547
522
|
* @format GUID
|
|
548
523
|
* @readonly
|
|
549
524
|
*/
|
|
550
|
-
|
|
525
|
+
_id?: string;
|
|
551
526
|
/** Address of the custom location. */
|
|
552
527
|
address?: CommonAddress;
|
|
553
528
|
}
|
|
@@ -577,22 +552,22 @@ export interface CustomLocationOptions {
|
|
|
577
552
|
*
|
|
578
553
|
* 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.
|
|
579
554
|
*/
|
|
580
|
-
|
|
555
|
+
interface BookingPolicy {
|
|
581
556
|
/**
|
|
582
557
|
* The ID to the policy for the booking.
|
|
583
558
|
* @format GUID
|
|
584
559
|
*/
|
|
585
|
-
|
|
560
|
+
_id?: string;
|
|
586
561
|
/**
|
|
587
562
|
* Date and time the policy was created.
|
|
588
563
|
* @readonly
|
|
589
564
|
*/
|
|
590
|
-
|
|
565
|
+
_createdDate?: Date | null;
|
|
591
566
|
/**
|
|
592
567
|
* Date and time the policy was updated.
|
|
593
568
|
* @readonly
|
|
594
569
|
*/
|
|
595
|
-
|
|
570
|
+
_updatedDate?: Date | null;
|
|
596
571
|
/**
|
|
597
572
|
* Name of the policy.
|
|
598
573
|
* @maxLength 400
|
|
@@ -661,7 +636,7 @@ export interface BookingPolicy {
|
|
|
661
636
|
saveCreditCardPolicy?: SaveCreditCardPolicy;
|
|
662
637
|
}
|
|
663
638
|
/** A description of the policy to display to participants. */
|
|
664
|
-
|
|
639
|
+
interface PolicyDescription {
|
|
665
640
|
/**
|
|
666
641
|
* Whether the description should be displayed. If `true`, the description is displayed.
|
|
667
642
|
*
|
|
@@ -678,7 +653,7 @@ export interface PolicyDescription {
|
|
|
678
653
|
description?: string;
|
|
679
654
|
}
|
|
680
655
|
/** The policy for limiting early bookings. */
|
|
681
|
-
|
|
656
|
+
interface LimitEarlyBookingPolicy {
|
|
682
657
|
/**
|
|
683
658
|
* Whether there is a limit on how early a customer
|
|
684
659
|
* can book. When `false`, there is no limit on the earliest
|
|
@@ -703,7 +678,7 @@ export interface LimitEarlyBookingPolicy {
|
|
|
703
678
|
* This policy and the `BookAfterStartPolicy` policy cannot be enabled at the same time. So if this policy
|
|
704
679
|
* is enabled, `BookAfterStartPolicy` must be disabled.
|
|
705
680
|
*/
|
|
706
|
-
|
|
681
|
+
interface LimitLateBookingPolicy {
|
|
707
682
|
/**
|
|
708
683
|
* Whether there is a limit on how late a customer
|
|
709
684
|
* can book. When `false`, there is no limit on the latest
|
|
@@ -728,7 +703,7 @@ export interface LimitLateBookingPolicy {
|
|
|
728
703
|
* This policy and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this policy
|
|
729
704
|
* is enabled, the `LimitLateBookingPolicy` policy must be disabled.
|
|
730
705
|
*/
|
|
731
|
-
|
|
706
|
+
interface BookAfterStartPolicy {
|
|
732
707
|
/**
|
|
733
708
|
* Whether booking is allowed after the start of the schedule. When `true`,
|
|
734
709
|
* customers can book after the start of the schedule.
|
|
@@ -738,7 +713,7 @@ export interface BookAfterStartPolicy {
|
|
|
738
713
|
enabled?: boolean;
|
|
739
714
|
}
|
|
740
715
|
/** The policy for canceling a booked session. */
|
|
741
|
-
|
|
716
|
+
interface CancellationPolicy {
|
|
742
717
|
/**
|
|
743
718
|
* Whether canceling a booking is allowed. When `true`, customers
|
|
744
719
|
* can cancel the booking.
|
|
@@ -763,7 +738,7 @@ export interface CancellationPolicy {
|
|
|
763
738
|
latestCancellationInMinutes?: number;
|
|
764
739
|
}
|
|
765
740
|
/** The policy for rescheduling a booked session. */
|
|
766
|
-
|
|
741
|
+
interface ReschedulePolicy {
|
|
767
742
|
/**
|
|
768
743
|
* Whether rescheduling a booking is allowed. When `true`, customers
|
|
769
744
|
* can reschedule the booking.
|
|
@@ -788,7 +763,7 @@ export interface ReschedulePolicy {
|
|
|
788
763
|
latestRescheduleInMinutes?: number;
|
|
789
764
|
}
|
|
790
765
|
/** The policy for the waitlist. */
|
|
791
|
-
|
|
766
|
+
interface WaitlistPolicy {
|
|
792
767
|
/**
|
|
793
768
|
* Whether the session has a waitlist. If `true`, there is a waitlist.
|
|
794
769
|
*
|
|
@@ -813,7 +788,7 @@ export interface WaitlistPolicy {
|
|
|
813
788
|
reservationTimeInMinutes?: number;
|
|
814
789
|
}
|
|
815
790
|
/** The policy for the maximum number of participants per booking. */
|
|
816
|
-
|
|
791
|
+
interface ParticipantsPolicy {
|
|
817
792
|
/**
|
|
818
793
|
* Maximum number of participants allowed.
|
|
819
794
|
*
|
|
@@ -824,7 +799,7 @@ export interface ParticipantsPolicy {
|
|
|
824
799
|
maxParticipantsPerBooking?: number;
|
|
825
800
|
}
|
|
826
801
|
/** The policy regarding the allocation of resources (e.g. staff members). */
|
|
827
|
-
|
|
802
|
+
interface ResourcesPolicy {
|
|
828
803
|
/**
|
|
829
804
|
* `true` if this policy is enabled, `false` otherwise.
|
|
830
805
|
* When `false` then the client must always select a resource when booking an appointment.
|
|
@@ -838,7 +813,7 @@ export interface ResourcesPolicy {
|
|
|
838
813
|
*/
|
|
839
814
|
autoAssignAllowed?: boolean;
|
|
840
815
|
}
|
|
841
|
-
|
|
816
|
+
interface CancellationFeePolicy {
|
|
842
817
|
/**
|
|
843
818
|
* Whether canceling a booking will result in a cancellation fee
|
|
844
819
|
*
|
|
@@ -857,7 +832,7 @@ export interface CancellationFeePolicy {
|
|
|
857
832
|
*/
|
|
858
833
|
autoCollectFeeEnabled?: boolean | null;
|
|
859
834
|
}
|
|
860
|
-
|
|
835
|
+
interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
861
836
|
/** Amount to be charged as a cancellation fee. */
|
|
862
837
|
amount?: Money;
|
|
863
838
|
/**
|
|
@@ -872,7 +847,7 @@ export interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
|
872
847
|
startInMinutes?: number | null;
|
|
873
848
|
}
|
|
874
849
|
/** @oneof */
|
|
875
|
-
|
|
850
|
+
interface CancellationWindowFeeOneOf {
|
|
876
851
|
/** Amount to be charged as a cancellation fee. */
|
|
877
852
|
amount?: Money;
|
|
878
853
|
/**
|
|
@@ -881,11 +856,11 @@ export interface CancellationWindowFeeOneOf {
|
|
|
881
856
|
*/
|
|
882
857
|
percentage?: string;
|
|
883
858
|
}
|
|
884
|
-
|
|
859
|
+
interface SaveCreditCardPolicy {
|
|
885
860
|
/** Default: `false` */
|
|
886
861
|
enabled?: boolean;
|
|
887
862
|
}
|
|
888
|
-
|
|
863
|
+
interface Schedule {
|
|
889
864
|
/**
|
|
890
865
|
* ID of the *schedule*
|
|
891
866
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction))
|
|
@@ -893,7 +868,7 @@ export interface Schedule {
|
|
|
893
868
|
* @format GUID
|
|
894
869
|
* @readonly
|
|
895
870
|
*/
|
|
896
|
-
|
|
871
|
+
_id?: string | null;
|
|
897
872
|
/**
|
|
898
873
|
* Start time of the first session in the schedule. For courses only.
|
|
899
874
|
* @readonly
|
|
@@ -907,7 +882,7 @@ export interface Schedule {
|
|
|
907
882
|
/** Limitations affecting the service availability. */
|
|
908
883
|
availabilityConstraints?: AvailabilityConstraints;
|
|
909
884
|
}
|
|
910
|
-
|
|
885
|
+
interface AvailabilityConstraints {
|
|
911
886
|
/**
|
|
912
887
|
* Calculated list of all supported session durations for the service. For
|
|
913
888
|
* appointment-based services without varied pricing based on session length, it
|
|
@@ -946,7 +921,7 @@ export interface AvailabilityConstraints {
|
|
|
946
921
|
*/
|
|
947
922
|
timeBetweenSessions?: number;
|
|
948
923
|
}
|
|
949
|
-
|
|
924
|
+
interface Duration {
|
|
950
925
|
/**
|
|
951
926
|
* The duration of the service in minutes.
|
|
952
927
|
*
|
|
@@ -957,7 +932,7 @@ export interface Duration {
|
|
|
957
932
|
*/
|
|
958
933
|
minutes?: number;
|
|
959
934
|
}
|
|
960
|
-
|
|
935
|
+
interface StaffMember {
|
|
961
936
|
/**
|
|
962
937
|
* ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.
|
|
963
938
|
* @format GUID
|
|
@@ -976,23 +951,23 @@ export interface StaffMember {
|
|
|
976
951
|
*/
|
|
977
952
|
mainMedia?: StaffMediaItem;
|
|
978
953
|
}
|
|
979
|
-
|
|
954
|
+
interface StaffMediaItem extends StaffMediaItemItemOneOf {
|
|
980
955
|
/** Details of the image associated with the staff, such as URL and size. */
|
|
981
|
-
image?:
|
|
956
|
+
image?: string;
|
|
982
957
|
}
|
|
983
958
|
/** @oneof */
|
|
984
|
-
|
|
959
|
+
interface StaffMediaItemItemOneOf {
|
|
985
960
|
/** Details of the image associated with the staff, such as URL and size. */
|
|
986
|
-
image?:
|
|
961
|
+
image?: string;
|
|
987
962
|
}
|
|
988
|
-
|
|
963
|
+
interface StaffMemberDetails {
|
|
989
964
|
/**
|
|
990
965
|
* Staff members providing the service. For appointments only.
|
|
991
966
|
* @maxSize 220
|
|
992
967
|
*/
|
|
993
968
|
staffMembers?: StaffMember[];
|
|
994
969
|
}
|
|
995
|
-
|
|
970
|
+
interface ResourceGroup {
|
|
996
971
|
/**
|
|
997
972
|
* An optional resource group ID. If specified, it references a resource group in the resource groups API.
|
|
998
973
|
* TODO - referenced_entity annotation
|
|
@@ -1018,7 +993,7 @@ export interface ResourceGroup {
|
|
|
1018
993
|
*/
|
|
1019
994
|
selectableResource?: boolean | null;
|
|
1020
995
|
}
|
|
1021
|
-
|
|
996
|
+
interface ResourceIds {
|
|
1022
997
|
/**
|
|
1023
998
|
* Values of the resource IDs.
|
|
1024
999
|
* @maxSize 100
|
|
@@ -1026,7 +1001,7 @@ export interface ResourceIds {
|
|
|
1026
1001
|
*/
|
|
1027
1002
|
values?: string[];
|
|
1028
1003
|
}
|
|
1029
|
-
|
|
1004
|
+
interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
1030
1005
|
/**
|
|
1031
1006
|
* Details about the required *resource type*
|
|
1032
1007
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
|
|
@@ -1034,14 +1009,14 @@ export interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
|
1034
1009
|
resourceType?: ResourceType;
|
|
1035
1010
|
}
|
|
1036
1011
|
/** @oneof */
|
|
1037
|
-
|
|
1012
|
+
interface ServiceResourceSelectionOneOf {
|
|
1038
1013
|
}
|
|
1039
|
-
|
|
1014
|
+
interface ResourceType {
|
|
1040
1015
|
/**
|
|
1041
1016
|
* The type of the resource.
|
|
1042
1017
|
* @format GUID
|
|
1043
1018
|
*/
|
|
1044
|
-
|
|
1019
|
+
_id?: string | null;
|
|
1045
1020
|
/**
|
|
1046
1021
|
* The name of the resource type.
|
|
1047
1022
|
* @readonly
|
|
@@ -1050,7 +1025,7 @@ export interface ResourceType {
|
|
|
1050
1025
|
*/
|
|
1051
1026
|
name?: string | null;
|
|
1052
1027
|
}
|
|
1053
|
-
|
|
1028
|
+
interface Slug {
|
|
1054
1029
|
/**
|
|
1055
1030
|
* 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`.
|
|
1056
1031
|
* @maxLength 500
|
|
@@ -1065,38 +1040,26 @@ export interface Slug {
|
|
|
1065
1040
|
* Date and time the slug was created. This is a system field.
|
|
1066
1041
|
* @readonly
|
|
1067
1042
|
*/
|
|
1068
|
-
|
|
1043
|
+
_createdDate?: Date | null;
|
|
1069
1044
|
}
|
|
1070
|
-
|
|
1045
|
+
interface URLs {
|
|
1071
1046
|
/**
|
|
1072
1047
|
* The URL for the service page.
|
|
1073
1048
|
* @readonly
|
|
1074
1049
|
*/
|
|
1075
|
-
servicePage?:
|
|
1050
|
+
servicePage?: string;
|
|
1076
1051
|
/**
|
|
1077
1052
|
* The URL for the booking entry point. It can be either to the calendar or to the service page.
|
|
1078
1053
|
* @readonly
|
|
1079
1054
|
*/
|
|
1080
|
-
bookingPage?:
|
|
1055
|
+
bookingPage?: string;
|
|
1081
1056
|
/**
|
|
1082
1057
|
* The URL for the calendar. Can be empty if no calendar exists.
|
|
1083
1058
|
* @readonly
|
|
1084
1059
|
*/
|
|
1085
|
-
calendarPage?:
|
|
1060
|
+
calendarPage?: string;
|
|
1086
1061
|
}
|
|
1087
|
-
|
|
1088
|
-
/**
|
|
1089
|
-
* The relative path for the page within the site. For example, `/product-page/a-product`.
|
|
1090
|
-
* @maxLength 2048
|
|
1091
|
-
*/
|
|
1092
|
-
relativePath?: string;
|
|
1093
|
-
/**
|
|
1094
|
-
* The page's full URL. For example, `https://mysite.com/product-page/a-product`.
|
|
1095
|
-
* @maxLength 2048
|
|
1096
|
-
*/
|
|
1097
|
-
url?: string | null;
|
|
1098
|
-
}
|
|
1099
|
-
export interface ExtendedFields {
|
|
1062
|
+
interface ExtendedFields {
|
|
1100
1063
|
/**
|
|
1101
1064
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1102
1065
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -1112,13 +1075,13 @@ export interface ExtendedFields {
|
|
|
1112
1075
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1113
1076
|
* 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.
|
|
1114
1077
|
*/
|
|
1115
|
-
|
|
1078
|
+
interface SeoSchema {
|
|
1116
1079
|
/** SEO tag information. */
|
|
1117
1080
|
tags?: Tag[];
|
|
1118
1081
|
/** SEO general settings. */
|
|
1119
1082
|
settings?: Settings;
|
|
1120
1083
|
}
|
|
1121
|
-
|
|
1084
|
+
interface Keyword {
|
|
1122
1085
|
/** Keyword value. */
|
|
1123
1086
|
term?: string;
|
|
1124
1087
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1129,7 +1092,7 @@ export interface Keyword {
|
|
|
1129
1092
|
*/
|
|
1130
1093
|
origin?: string | null;
|
|
1131
1094
|
}
|
|
1132
|
-
|
|
1095
|
+
interface Tag {
|
|
1133
1096
|
/**
|
|
1134
1097
|
* SEO tag type.
|
|
1135
1098
|
*
|
|
@@ -1151,7 +1114,7 @@ export interface Tag {
|
|
|
1151
1114
|
/** Whether the tag is disabled. */
|
|
1152
1115
|
disabled?: boolean;
|
|
1153
1116
|
}
|
|
1154
|
-
|
|
1117
|
+
interface Settings {
|
|
1155
1118
|
/**
|
|
1156
1119
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1157
1120
|
*
|
|
@@ -1165,13 +1128,13 @@ export interface Settings {
|
|
|
1165
1128
|
*/
|
|
1166
1129
|
keywords?: Keyword[];
|
|
1167
1130
|
}
|
|
1168
|
-
|
|
1131
|
+
interface AddOnGroup {
|
|
1169
1132
|
/**
|
|
1170
1133
|
* ID of the group.
|
|
1171
1134
|
* @readonly
|
|
1172
1135
|
* @format GUID
|
|
1173
1136
|
*/
|
|
1174
|
-
|
|
1137
|
+
_id?: string | null;
|
|
1175
1138
|
/**
|
|
1176
1139
|
* The name of the group.
|
|
1177
1140
|
* @maxLength 100
|
|
@@ -1194,7 +1157,7 @@ export interface AddOnGroup {
|
|
|
1194
1157
|
*/
|
|
1195
1158
|
prompt?: string | null;
|
|
1196
1159
|
}
|
|
1197
|
-
|
|
1160
|
+
interface AddOnDetails {
|
|
1198
1161
|
/**
|
|
1199
1162
|
* ID of the AddOn.
|
|
1200
1163
|
* @format GUID
|
|
@@ -1210,7 +1173,7 @@ export interface AddOnDetails {
|
|
|
1210
1173
|
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
1211
1174
|
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
1212
1175
|
*/
|
|
1213
|
-
|
|
1176
|
+
interface ReindexMessage extends ReindexMessageActionOneOf {
|
|
1214
1177
|
upsert?: Upsert;
|
|
1215
1178
|
delete?: Delete;
|
|
1216
1179
|
entityFqdn?: string;
|
|
@@ -1220,34 +1183,34 @@ export interface ReindexMessage extends ReindexMessageActionOneOf {
|
|
|
1220
1183
|
schema?: Schema;
|
|
1221
1184
|
}
|
|
1222
1185
|
/** @oneof */
|
|
1223
|
-
|
|
1186
|
+
interface ReindexMessageActionOneOf {
|
|
1224
1187
|
upsert?: Upsert;
|
|
1225
1188
|
delete?: Delete;
|
|
1226
1189
|
}
|
|
1227
|
-
|
|
1190
|
+
interface Upsert {
|
|
1228
1191
|
entityId?: string;
|
|
1229
1192
|
entityAsJson?: string;
|
|
1230
1193
|
}
|
|
1231
|
-
|
|
1194
|
+
interface Delete {
|
|
1232
1195
|
entityId?: string;
|
|
1233
1196
|
}
|
|
1234
|
-
|
|
1197
|
+
interface Schema {
|
|
1235
1198
|
label?: string;
|
|
1236
1199
|
clusterName?: string;
|
|
1237
1200
|
}
|
|
1238
|
-
|
|
1201
|
+
interface SetCustomSlugEvent {
|
|
1239
1202
|
/** The main slug for the service after the update */
|
|
1240
1203
|
mainSlug?: Slug;
|
|
1241
1204
|
}
|
|
1242
|
-
|
|
1205
|
+
interface ServicesUrlsChanged {
|
|
1243
1206
|
}
|
|
1244
|
-
|
|
1207
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1245
1208
|
createdEvent?: EntityCreatedEvent;
|
|
1246
1209
|
updatedEvent?: EntityUpdatedEvent;
|
|
1247
1210
|
deletedEvent?: EntityDeletedEvent;
|
|
1248
1211
|
actionEvent?: ActionEvent;
|
|
1249
1212
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1250
|
-
|
|
1213
|
+
_id?: string;
|
|
1251
1214
|
/**
|
|
1252
1215
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1253
1216
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -1276,36 +1239,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1276
1239
|
entityEventSequence?: string | null;
|
|
1277
1240
|
}
|
|
1278
1241
|
/** @oneof */
|
|
1279
|
-
|
|
1242
|
+
interface DomainEventBodyOneOf {
|
|
1280
1243
|
createdEvent?: EntityCreatedEvent;
|
|
1281
1244
|
updatedEvent?: EntityUpdatedEvent;
|
|
1282
1245
|
deletedEvent?: EntityDeletedEvent;
|
|
1283
1246
|
actionEvent?: ActionEvent;
|
|
1284
1247
|
}
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1288
|
-
restoreInfo?: RestoreInfo;
|
|
1248
|
+
interface EntityCreatedEvent {
|
|
1249
|
+
entity?: string;
|
|
1289
1250
|
}
|
|
1290
|
-
|
|
1251
|
+
interface RestoreInfo {
|
|
1291
1252
|
deletedDate?: Date | null;
|
|
1292
1253
|
}
|
|
1293
|
-
|
|
1254
|
+
interface EntityUpdatedEvent {
|
|
1294
1255
|
/**
|
|
1295
1256
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1296
1257
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1297
1258
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1298
1259
|
*/
|
|
1299
|
-
|
|
1260
|
+
currentEntity?: string;
|
|
1300
1261
|
}
|
|
1301
|
-
|
|
1262
|
+
interface EntityDeletedEvent {
|
|
1302
1263
|
/** Entity that was deleted. */
|
|
1303
|
-
|
|
1264
|
+
deletedEntity?: string | null;
|
|
1304
1265
|
}
|
|
1305
|
-
|
|
1306
|
-
|
|
1266
|
+
interface ActionEvent {
|
|
1267
|
+
body?: string;
|
|
1307
1268
|
}
|
|
1308
|
-
|
|
1269
|
+
interface MessageEnvelope {
|
|
1309
1270
|
/**
|
|
1310
1271
|
* App instance ID.
|
|
1311
1272
|
* @format GUID
|
|
@@ -1321,7 +1282,7 @@ export interface MessageEnvelope {
|
|
|
1321
1282
|
/** Stringify payload. */
|
|
1322
1283
|
data?: string;
|
|
1323
1284
|
}
|
|
1324
|
-
|
|
1285
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1325
1286
|
/**
|
|
1326
1287
|
* ID of a site visitor that has not logged in to the site.
|
|
1327
1288
|
* @format GUID
|
|
@@ -1346,7 +1307,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1346
1307
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1347
1308
|
}
|
|
1348
1309
|
/** @oneof */
|
|
1349
|
-
|
|
1310
|
+
interface IdentificationDataIdOneOf {
|
|
1350
1311
|
/**
|
|
1351
1312
|
* ID of a site visitor that has not logged in to the site.
|
|
1352
1313
|
* @format GUID
|
|
@@ -1368,7 +1329,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1368
1329
|
*/
|
|
1369
1330
|
appId?: string;
|
|
1370
1331
|
}
|
|
1371
|
-
|
|
1332
|
+
declare enum WebhookIdentityType {
|
|
1372
1333
|
UNKNOWN = "UNKNOWN",
|
|
1373
1334
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1374
1335
|
MEMBER = "MEMBER",
|
|
@@ -1376,8 +1337,8 @@ export declare enum WebhookIdentityType {
|
|
|
1376
1337
|
APP = "APP"
|
|
1377
1338
|
}
|
|
1378
1339
|
/** @enumType */
|
|
1379
|
-
|
|
1380
|
-
|
|
1340
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1341
|
+
interface CreateAddOnGroupRequest {
|
|
1381
1342
|
/** AddOnGroup to create. */
|
|
1382
1343
|
addOnGroup?: AddOnGroup;
|
|
1383
1344
|
/**
|
|
@@ -1386,11 +1347,11 @@ export interface CreateAddOnGroupRequest {
|
|
|
1386
1347
|
*/
|
|
1387
1348
|
serviceId?: string | null;
|
|
1388
1349
|
}
|
|
1389
|
-
|
|
1350
|
+
interface CreateAddOnGroupResponse {
|
|
1390
1351
|
/** Created AddOnGroup. */
|
|
1391
1352
|
addOnGroup?: AddOnGroup;
|
|
1392
1353
|
}
|
|
1393
|
-
|
|
1354
|
+
interface DeleteAddOnGroupRequest {
|
|
1394
1355
|
/**
|
|
1395
1356
|
* ID of the AddOnGroup to delete.
|
|
1396
1357
|
* @format GUID
|
|
@@ -1402,9 +1363,9 @@ export interface DeleteAddOnGroupRequest {
|
|
|
1402
1363
|
*/
|
|
1403
1364
|
serviceId?: string | null;
|
|
1404
1365
|
}
|
|
1405
|
-
|
|
1366
|
+
interface DeleteAddOnGroupResponse {
|
|
1406
1367
|
}
|
|
1407
|
-
|
|
1368
|
+
interface UpdateAddOnGroupRequest {
|
|
1408
1369
|
/** AddOnGroup to update. */
|
|
1409
1370
|
addOnGroup?: AddOnGroup;
|
|
1410
1371
|
/**
|
|
@@ -1413,11 +1374,11 @@ export interface UpdateAddOnGroupRequest {
|
|
|
1413
1374
|
*/
|
|
1414
1375
|
serviceId?: string | null;
|
|
1415
1376
|
}
|
|
1416
|
-
|
|
1377
|
+
interface UpdateAddOnGroupResponse {
|
|
1417
1378
|
/** Updated AddOnGroup */
|
|
1418
1379
|
addOnGroup?: AddOnGroup;
|
|
1419
1380
|
}
|
|
1420
|
-
|
|
1381
|
+
interface ListAddOnGroupsByServiceIdRequest {
|
|
1421
1382
|
/**
|
|
1422
1383
|
* ID of the service to retrieve AddOnGroups for.
|
|
1423
1384
|
* @format GUID
|
|
@@ -1430,14 +1391,14 @@ export interface ListAddOnGroupsByServiceIdRequest {
|
|
|
1430
1391
|
*/
|
|
1431
1392
|
groupIds?: string[] | null;
|
|
1432
1393
|
}
|
|
1433
|
-
|
|
1394
|
+
interface ListAddOnGroupsByServiceIdResponse {
|
|
1434
1395
|
/**
|
|
1435
1396
|
* List of group IDs and their linked AddOns.
|
|
1436
1397
|
* @maxSize 3
|
|
1437
1398
|
*/
|
|
1438
1399
|
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
1439
1400
|
}
|
|
1440
|
-
|
|
1401
|
+
interface AddOn extends AddOnAddOnInfoOneOf {
|
|
1441
1402
|
/** The AddOn description. */
|
|
1442
1403
|
durationInMinutes?: number;
|
|
1443
1404
|
/** The AddOn max quantity. */
|
|
@@ -1456,13 +1417,13 @@ export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
|
1456
1417
|
price?: Money;
|
|
1457
1418
|
}
|
|
1458
1419
|
/** @oneof */
|
|
1459
|
-
|
|
1420
|
+
interface AddOnAddOnInfoOneOf {
|
|
1460
1421
|
/** The AddOn description. */
|
|
1461
1422
|
durationInMinutes?: number;
|
|
1462
1423
|
/** The AddOn max quantity. */
|
|
1463
1424
|
maxQuantity?: number;
|
|
1464
1425
|
}
|
|
1465
|
-
|
|
1426
|
+
interface AddOnGroupDetail {
|
|
1466
1427
|
/**
|
|
1467
1428
|
* The group ID.
|
|
1468
1429
|
* @format GUID
|
|
@@ -1486,7 +1447,7 @@ export interface AddOnGroupDetail {
|
|
|
1486
1447
|
*/
|
|
1487
1448
|
prompt?: string | null;
|
|
1488
1449
|
}
|
|
1489
|
-
|
|
1450
|
+
interface SetAddOnsForGroupRequest {
|
|
1490
1451
|
/**
|
|
1491
1452
|
* The service ID to set AddOns for.
|
|
1492
1453
|
* @format GUID
|
|
@@ -1505,11 +1466,11 @@ export interface SetAddOnsForGroupRequest {
|
|
|
1505
1466
|
*/
|
|
1506
1467
|
addOnIds?: string[] | null;
|
|
1507
1468
|
}
|
|
1508
|
-
|
|
1469
|
+
interface SetAddOnsForGroupResponse {
|
|
1509
1470
|
/** The updated AddOnGroup. */
|
|
1510
1471
|
addOnGroup?: AddOnGroup;
|
|
1511
1472
|
}
|
|
1512
|
-
|
|
1473
|
+
interface ValidateAddOnsSelectionRequest {
|
|
1513
1474
|
/**
|
|
1514
1475
|
* The service ID to validate AddOns against.
|
|
1515
1476
|
* @format GUID
|
|
@@ -1528,11 +1489,11 @@ export interface ValidateAddOnsSelectionRequest {
|
|
|
1528
1489
|
*/
|
|
1529
1490
|
addOnIds?: string[] | null;
|
|
1530
1491
|
}
|
|
1531
|
-
|
|
1492
|
+
interface ValidateAddOnsSelectionResponse {
|
|
1532
1493
|
/** The validation result. */
|
|
1533
1494
|
result?: ValidationResult;
|
|
1534
1495
|
}
|
|
1535
|
-
|
|
1496
|
+
interface ValidationResult {
|
|
1536
1497
|
/** Whether the AddOns selection is valid. */
|
|
1537
1498
|
valid?: boolean | null;
|
|
1538
1499
|
/**
|
|
@@ -1543,25 +1504,25 @@ export interface ValidationResult {
|
|
|
1543
1504
|
*/
|
|
1544
1505
|
message?: string | null;
|
|
1545
1506
|
}
|
|
1546
|
-
|
|
1507
|
+
interface CreateServiceRequest {
|
|
1547
1508
|
/** Service to create. */
|
|
1548
1509
|
service: Service;
|
|
1549
1510
|
}
|
|
1550
|
-
|
|
1511
|
+
interface CreateServiceResponse {
|
|
1551
1512
|
/** Created service. */
|
|
1552
1513
|
service?: Service;
|
|
1553
1514
|
}
|
|
1554
|
-
|
|
1515
|
+
interface ValidateServiceRequest {
|
|
1555
1516
|
/** Service to validate. */
|
|
1556
1517
|
service?: Service;
|
|
1557
1518
|
}
|
|
1558
|
-
|
|
1519
|
+
interface ValidateServiceResponse {
|
|
1559
1520
|
/** Whether the service is valid. */
|
|
1560
1521
|
valid?: boolean;
|
|
1561
1522
|
/** Field violations. */
|
|
1562
1523
|
fieldViolations?: FieldViolation[];
|
|
1563
1524
|
}
|
|
1564
|
-
|
|
1525
|
+
interface FieldViolation {
|
|
1565
1526
|
/**
|
|
1566
1527
|
* Path to the invalid field.
|
|
1567
1528
|
* @maxLength 2000
|
|
@@ -1578,7 +1539,7 @@ export interface FieldViolation {
|
|
|
1578
1539
|
*/
|
|
1579
1540
|
ruleName?: string;
|
|
1580
1541
|
}
|
|
1581
|
-
|
|
1542
|
+
interface BulkCreateServicesRequest {
|
|
1582
1543
|
/**
|
|
1583
1544
|
* Services to create.
|
|
1584
1545
|
* @maxSize 100
|
|
@@ -1587,24 +1548,24 @@ export interface BulkCreateServicesRequest {
|
|
|
1587
1548
|
/** Whether to return the created service objects. */
|
|
1588
1549
|
returnEntity?: boolean;
|
|
1589
1550
|
}
|
|
1590
|
-
|
|
1551
|
+
interface BulkCreateServicesResponse {
|
|
1591
1552
|
/** The result of each service creation. */
|
|
1592
1553
|
results?: BulkServiceResult[];
|
|
1593
1554
|
/** Create statistics. */
|
|
1594
1555
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1595
1556
|
}
|
|
1596
|
-
|
|
1557
|
+
interface BulkServiceResult {
|
|
1597
1558
|
/** Update metadata. */
|
|
1598
1559
|
itemMetadata?: ItemMetadata;
|
|
1599
1560
|
/** Updated service. */
|
|
1600
1561
|
item?: Service;
|
|
1601
1562
|
}
|
|
1602
|
-
|
|
1563
|
+
interface ItemMetadata {
|
|
1603
1564
|
/**
|
|
1604
1565
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
1605
1566
|
* @format GUID
|
|
1606
1567
|
*/
|
|
1607
|
-
|
|
1568
|
+
_id?: string | null;
|
|
1608
1569
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1609
1570
|
originalIndex?: number;
|
|
1610
1571
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -1612,7 +1573,7 @@ export interface ItemMetadata {
|
|
|
1612
1573
|
/** Details about the error in case of failure. */
|
|
1613
1574
|
error?: ApplicationError;
|
|
1614
1575
|
}
|
|
1615
|
-
|
|
1576
|
+
interface ApplicationError {
|
|
1616
1577
|
/** Error code. */
|
|
1617
1578
|
code?: string;
|
|
1618
1579
|
/** Description of the error. */
|
|
@@ -1620,7 +1581,7 @@ export interface ApplicationError {
|
|
|
1620
1581
|
/** Data related to the error. */
|
|
1621
1582
|
data?: Record<string, any> | null;
|
|
1622
1583
|
}
|
|
1623
|
-
|
|
1584
|
+
interface BulkActionMetadata {
|
|
1624
1585
|
/** Number of items that were successfully processed. */
|
|
1625
1586
|
totalSuccesses?: number;
|
|
1626
1587
|
/** Number of items that couldn't be processed. */
|
|
@@ -1628,14 +1589,14 @@ export interface BulkActionMetadata {
|
|
|
1628
1589
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1629
1590
|
undetailedFailures?: number;
|
|
1630
1591
|
}
|
|
1631
|
-
|
|
1592
|
+
interface GetServiceRequest {
|
|
1632
1593
|
/**
|
|
1633
1594
|
* ID of the service to retrieve.
|
|
1634
1595
|
* @format GUID
|
|
1635
1596
|
*/
|
|
1636
1597
|
serviceId: string;
|
|
1637
1598
|
}
|
|
1638
|
-
|
|
1599
|
+
declare enum V2RequestedFields {
|
|
1639
1600
|
/** Unknown requested field. */
|
|
1640
1601
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1641
1602
|
/** When passed, `service.staff_members` is returned. */
|
|
@@ -1643,24 +1604,22 @@ export declare enum V2RequestedFields {
|
|
|
1643
1604
|
/** When passed, `service.service_resources.resource_type.name` is returned. */
|
|
1644
1605
|
RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
|
|
1645
1606
|
}
|
|
1646
|
-
|
|
1647
|
-
export type V2RequestedFieldsWithLiterals = V2RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'STAFF_MEMBER_DETAILS' | 'RESOURCE_TYPE_DETAILS';
|
|
1648
|
-
export interface GetServiceResponse {
|
|
1607
|
+
interface GetServiceResponse {
|
|
1649
1608
|
/** Retrieved service. */
|
|
1650
1609
|
service?: Service;
|
|
1651
1610
|
}
|
|
1652
|
-
|
|
1611
|
+
interface GetServiceAvailabilityConstraintsRequest {
|
|
1653
1612
|
/**
|
|
1654
1613
|
* ID of the service to retrieve.
|
|
1655
1614
|
* @format GUID
|
|
1656
1615
|
*/
|
|
1657
1616
|
serviceId?: string;
|
|
1658
1617
|
}
|
|
1659
|
-
|
|
1618
|
+
interface GetServiceAvailabilityConstraintsResponse {
|
|
1660
1619
|
/** The retrieved availability constraints of the service. */
|
|
1661
1620
|
constraints?: ServiceAvailabilityConstraints;
|
|
1662
1621
|
}
|
|
1663
|
-
|
|
1622
|
+
interface ServiceAvailabilityConstraints {
|
|
1664
1623
|
/**
|
|
1665
1624
|
* The booking policy.
|
|
1666
1625
|
* @readonly
|
|
@@ -1710,7 +1669,7 @@ export interface ServiceAvailabilityConstraints {
|
|
|
1710
1669
|
onlineBooking?: OnlineBooking;
|
|
1711
1670
|
}
|
|
1712
1671
|
/** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
|
|
1713
|
-
|
|
1672
|
+
interface SplitInterval {
|
|
1714
1673
|
/**
|
|
1715
1674
|
* Whether the slot duration is used as the split interval value.
|
|
1716
1675
|
* If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
|
|
@@ -1720,15 +1679,15 @@ export interface SplitInterval {
|
|
|
1720
1679
|
/** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
|
|
1721
1680
|
valueInMinutes?: number | null;
|
|
1722
1681
|
}
|
|
1723
|
-
|
|
1682
|
+
interface UpdateServiceRequest {
|
|
1724
1683
|
/** Service to update. */
|
|
1725
1684
|
service: Service;
|
|
1726
1685
|
}
|
|
1727
|
-
|
|
1686
|
+
interface UpdateServiceResponse {
|
|
1728
1687
|
/** Updated service. */
|
|
1729
1688
|
service?: Service;
|
|
1730
1689
|
}
|
|
1731
|
-
|
|
1690
|
+
interface BulkUpdateServicesRequest {
|
|
1732
1691
|
/**
|
|
1733
1692
|
* Services to update.
|
|
1734
1693
|
* @maxSize 100
|
|
@@ -1737,25 +1696,25 @@ export interface BulkUpdateServicesRequest {
|
|
|
1737
1696
|
/** Whether to include the updated services in the response. Default: `false` */
|
|
1738
1697
|
returnEntity?: boolean;
|
|
1739
1698
|
}
|
|
1740
|
-
|
|
1699
|
+
interface MaskedService {
|
|
1741
1700
|
/** Service to update. */
|
|
1742
1701
|
service?: Service;
|
|
1743
1702
|
/** Explicit list of fields to update. */
|
|
1744
1703
|
mask?: string[];
|
|
1745
1704
|
}
|
|
1746
|
-
|
|
1705
|
+
interface BulkUpdateServicesResponse {
|
|
1747
1706
|
/** The result of each service update. */
|
|
1748
1707
|
results?: BulkServiceResult[];
|
|
1749
1708
|
/** Update statistics. */
|
|
1750
1709
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1751
1710
|
}
|
|
1752
|
-
|
|
1711
|
+
interface BulkUpdateServicesByFilterRequest {
|
|
1753
1712
|
/** Filter to identify the services to update. */
|
|
1754
1713
|
filter: Record<string, any> | null;
|
|
1755
1714
|
/** Service to update. */
|
|
1756
1715
|
service: Service;
|
|
1757
1716
|
}
|
|
1758
|
-
|
|
1717
|
+
interface BulkUpdateServicesByFilterResponse {
|
|
1759
1718
|
/**
|
|
1760
1719
|
* ID of the service update job.
|
|
1761
1720
|
*
|
|
@@ -1764,7 +1723,7 @@ export interface BulkUpdateServicesByFilterResponse {
|
|
|
1764
1723
|
*/
|
|
1765
1724
|
jobId?: string;
|
|
1766
1725
|
}
|
|
1767
|
-
|
|
1726
|
+
interface DeleteServiceRequest {
|
|
1768
1727
|
/**
|
|
1769
1728
|
* ID of the service to delete.
|
|
1770
1729
|
* @format GUID
|
|
@@ -1782,7 +1741,7 @@ export interface DeleteServiceRequest {
|
|
|
1782
1741
|
*/
|
|
1783
1742
|
participantNotification?: ParticipantNotification;
|
|
1784
1743
|
}
|
|
1785
|
-
|
|
1744
|
+
interface ParticipantNotification {
|
|
1786
1745
|
/**
|
|
1787
1746
|
* Whether to send the message about the changes to the customer.
|
|
1788
1747
|
*
|
|
@@ -1795,9 +1754,9 @@ export interface ParticipantNotification {
|
|
|
1795
1754
|
*/
|
|
1796
1755
|
message?: string | null;
|
|
1797
1756
|
}
|
|
1798
|
-
|
|
1757
|
+
interface DeleteServiceResponse {
|
|
1799
1758
|
}
|
|
1800
|
-
|
|
1759
|
+
interface BulkDeleteServicesRequest {
|
|
1801
1760
|
/**
|
|
1802
1761
|
* IDs of the services to delete.
|
|
1803
1762
|
* @format GUID
|
|
@@ -1816,13 +1775,13 @@ export interface BulkDeleteServicesRequest {
|
|
|
1816
1775
|
*/
|
|
1817
1776
|
participantNotification?: ParticipantNotification;
|
|
1818
1777
|
}
|
|
1819
|
-
|
|
1778
|
+
interface BulkDeleteServicesResponse {
|
|
1820
1779
|
/** The result of each service removal. */
|
|
1821
1780
|
results?: BulkServiceResult[];
|
|
1822
1781
|
/** Delete statistics. */
|
|
1823
1782
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1824
1783
|
}
|
|
1825
|
-
|
|
1784
|
+
interface BulkDeleteServicesByFilterRequest {
|
|
1826
1785
|
/** Filter to identify the services that need to be deleted. */
|
|
1827
1786
|
filter: Record<string, any> | null;
|
|
1828
1787
|
/**
|
|
@@ -1834,7 +1793,7 @@ export interface BulkDeleteServicesByFilterRequest {
|
|
|
1834
1793
|
/** Whether to notify participants about the change and an optional custom message. */
|
|
1835
1794
|
participantNotification?: ParticipantNotification;
|
|
1836
1795
|
}
|
|
1837
|
-
|
|
1796
|
+
interface BulkDeleteServicesByFilterResponse {
|
|
1838
1797
|
/**
|
|
1839
1798
|
* ID of the service deletion job.
|
|
1840
1799
|
*
|
|
@@ -1843,11 +1802,11 @@ export interface BulkDeleteServicesByFilterResponse {
|
|
|
1843
1802
|
*/
|
|
1844
1803
|
jobId?: string;
|
|
1845
1804
|
}
|
|
1846
|
-
|
|
1805
|
+
interface QueryServicesRequest {
|
|
1847
1806
|
/** WQL expression. */
|
|
1848
1807
|
query: QueryV2;
|
|
1849
1808
|
}
|
|
1850
|
-
|
|
1809
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1851
1810
|
/** Paging options to limit and skip the number of items. */
|
|
1852
1811
|
paging?: Paging;
|
|
1853
1812
|
/**
|
|
@@ -1874,11 +1833,11 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
1874
1833
|
sort?: Sorting[];
|
|
1875
1834
|
}
|
|
1876
1835
|
/** @oneof */
|
|
1877
|
-
|
|
1836
|
+
interface QueryV2PagingMethodOneOf {
|
|
1878
1837
|
/** Paging options to limit and skip the number of items. */
|
|
1879
1838
|
paging?: Paging;
|
|
1880
1839
|
}
|
|
1881
|
-
|
|
1840
|
+
interface Sorting {
|
|
1882
1841
|
/**
|
|
1883
1842
|
* Name of the field to sort by.
|
|
1884
1843
|
* @maxLength 512
|
|
@@ -1887,19 +1846,19 @@ export interface Sorting {
|
|
|
1887
1846
|
/** Sort order. */
|
|
1888
1847
|
order?: SortOrderWithLiterals;
|
|
1889
1848
|
}
|
|
1890
|
-
|
|
1849
|
+
declare enum SortOrder {
|
|
1891
1850
|
ASC = "ASC",
|
|
1892
1851
|
DESC = "DESC"
|
|
1893
1852
|
}
|
|
1894
1853
|
/** @enumType */
|
|
1895
|
-
|
|
1896
|
-
|
|
1854
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1855
|
+
interface Paging {
|
|
1897
1856
|
/** Number of items to load. */
|
|
1898
1857
|
limit?: number | null;
|
|
1899
1858
|
/** Number of items to skip in the current sort order. */
|
|
1900
1859
|
offset?: number | null;
|
|
1901
1860
|
}
|
|
1902
|
-
|
|
1861
|
+
interface CursorPaging {
|
|
1903
1862
|
/**
|
|
1904
1863
|
* Number of items to load.
|
|
1905
1864
|
* @max 100
|
|
@@ -1915,13 +1874,13 @@ export interface CursorPaging {
|
|
|
1915
1874
|
*/
|
|
1916
1875
|
cursor?: string | null;
|
|
1917
1876
|
}
|
|
1918
|
-
|
|
1877
|
+
interface QueryServicesResponse {
|
|
1919
1878
|
/** The retrieved services. */
|
|
1920
1879
|
services?: Service[];
|
|
1921
1880
|
/** Paging metadata, including offset and count. */
|
|
1922
1881
|
pagingMetadata?: PagingMetadataV2;
|
|
1923
1882
|
}
|
|
1924
|
-
|
|
1883
|
+
interface PagingMetadataV2 {
|
|
1925
1884
|
/** Number of items returned in the response. */
|
|
1926
1885
|
count?: number | null;
|
|
1927
1886
|
/** Offset that was requested. */
|
|
@@ -1933,7 +1892,7 @@ export interface PagingMetadataV2 {
|
|
|
1933
1892
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1934
1893
|
cursors?: Cursors;
|
|
1935
1894
|
}
|
|
1936
|
-
|
|
1895
|
+
interface Cursors {
|
|
1937
1896
|
/**
|
|
1938
1897
|
* Cursor pointing to next page in the list of results.
|
|
1939
1898
|
* @maxLength 16000
|
|
@@ -1945,11 +1904,11 @@ export interface Cursors {
|
|
|
1945
1904
|
*/
|
|
1946
1905
|
prev?: string | null;
|
|
1947
1906
|
}
|
|
1948
|
-
|
|
1907
|
+
interface SearchServicesRequest {
|
|
1949
1908
|
/** WQL, search or aggregation expression. */
|
|
1950
1909
|
search: CursorSearch;
|
|
1951
1910
|
}
|
|
1952
|
-
|
|
1911
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
1953
1912
|
/**
|
|
1954
1913
|
* Cursor pointing to page of results.
|
|
1955
1914
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -1982,14 +1941,14 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
1982
1941
|
timeZone?: string | null;
|
|
1983
1942
|
}
|
|
1984
1943
|
/** @oneof */
|
|
1985
|
-
|
|
1944
|
+
interface CursorSearchPagingMethodOneOf {
|
|
1986
1945
|
/**
|
|
1987
1946
|
* Cursor pointing to page of results.
|
|
1988
1947
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
1989
1948
|
*/
|
|
1990
1949
|
cursorPaging?: CursorPaging;
|
|
1991
1950
|
}
|
|
1992
|
-
|
|
1951
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
1993
1952
|
/** Value aggregation */
|
|
1994
1953
|
value?: ValueAggregation;
|
|
1995
1954
|
/** Range aggregation */
|
|
@@ -2021,7 +1980,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
2021
1980
|
groupBy?: GroupByAggregation;
|
|
2022
1981
|
}
|
|
2023
1982
|
/** @oneof */
|
|
2024
|
-
|
|
1983
|
+
interface AggregationKindOneOf {
|
|
2025
1984
|
/** Value aggregation */
|
|
2026
1985
|
value?: ValueAggregation;
|
|
2027
1986
|
/** Range aggregation */
|
|
@@ -2033,46 +1992,46 @@ export interface AggregationKindOneOf {
|
|
|
2033
1992
|
/** Nested aggregation */
|
|
2034
1993
|
nested?: NestedAggregation;
|
|
2035
1994
|
}
|
|
2036
|
-
|
|
1995
|
+
interface RangeBucket {
|
|
2037
1996
|
/** Inclusive lower bound of the range. Required if to is not given. */
|
|
2038
1997
|
from?: number | null;
|
|
2039
1998
|
/** Exclusive upper bound of the range. Required if from is not given. */
|
|
2040
1999
|
to?: number | null;
|
|
2041
2000
|
}
|
|
2042
|
-
|
|
2001
|
+
declare enum SortType {
|
|
2043
2002
|
COUNT = "COUNT",
|
|
2044
2003
|
VALUE = "VALUE"
|
|
2045
2004
|
}
|
|
2046
2005
|
/** @enumType */
|
|
2047
|
-
|
|
2048
|
-
|
|
2006
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
2007
|
+
declare enum SortDirection {
|
|
2049
2008
|
DESC = "DESC",
|
|
2050
2009
|
ASC = "ASC"
|
|
2051
2010
|
}
|
|
2052
2011
|
/** @enumType */
|
|
2053
|
-
|
|
2054
|
-
|
|
2012
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
2013
|
+
declare enum MissingValues {
|
|
2055
2014
|
EXCLUDE = "EXCLUDE",
|
|
2056
2015
|
INCLUDE = "INCLUDE"
|
|
2057
2016
|
}
|
|
2058
2017
|
/** @enumType */
|
|
2059
|
-
|
|
2060
|
-
|
|
2018
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
2019
|
+
interface IncludeMissingValuesOptions {
|
|
2061
2020
|
/**
|
|
2062
2021
|
* can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
2063
2022
|
* @maxLength 20
|
|
2064
2023
|
*/
|
|
2065
2024
|
addToBucket?: string;
|
|
2066
2025
|
}
|
|
2067
|
-
|
|
2026
|
+
declare enum ScalarType {
|
|
2068
2027
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
2069
2028
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
2070
2029
|
MIN = "MIN",
|
|
2071
2030
|
MAX = "MAX"
|
|
2072
2031
|
}
|
|
2073
2032
|
/** @enumType */
|
|
2074
|
-
|
|
2075
|
-
|
|
2033
|
+
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
2034
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
2076
2035
|
/** options for including missing values */
|
|
2077
2036
|
includeOptions?: IncludeMissingValuesOptions;
|
|
2078
2037
|
/** Should sort by number of matches or value of the field */
|
|
@@ -2085,11 +2044,11 @@ export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
|
2085
2044
|
missingValues?: MissingValuesWithLiterals;
|
|
2086
2045
|
}
|
|
2087
2046
|
/** @oneof */
|
|
2088
|
-
|
|
2047
|
+
interface ValueAggregationOptionsOneOf {
|
|
2089
2048
|
/** options for including missing values */
|
|
2090
2049
|
includeOptions?: IncludeMissingValuesOptions;
|
|
2091
2050
|
}
|
|
2092
|
-
|
|
2051
|
+
declare enum NestedAggregationType {
|
|
2093
2052
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2094
2053
|
VALUE = "VALUE",
|
|
2095
2054
|
RANGE = "RANGE",
|
|
@@ -2097,23 +2056,23 @@ export declare enum NestedAggregationType {
|
|
|
2097
2056
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
2098
2057
|
}
|
|
2099
2058
|
/** @enumType */
|
|
2100
|
-
|
|
2101
|
-
|
|
2059
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
2060
|
+
interface RangeAggregation {
|
|
2102
2061
|
/**
|
|
2103
2062
|
* Range buckets
|
|
2104
2063
|
* @maxSize 50
|
|
2105
2064
|
*/
|
|
2106
2065
|
buckets?: RangeBucket[];
|
|
2107
2066
|
}
|
|
2108
|
-
|
|
2067
|
+
interface ScalarAggregation {
|
|
2109
2068
|
/** Define the operator for the scalar aggregation */
|
|
2110
2069
|
type?: ScalarTypeWithLiterals;
|
|
2111
2070
|
}
|
|
2112
|
-
|
|
2071
|
+
interface DateHistogramAggregation {
|
|
2113
2072
|
/** Interval for date histogram aggregation */
|
|
2114
2073
|
interval?: IntervalWithLiterals;
|
|
2115
2074
|
}
|
|
2116
|
-
|
|
2075
|
+
declare enum Interval {
|
|
2117
2076
|
/** Unknown interval. */
|
|
2118
2077
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
2119
2078
|
/** Yearly interval. */
|
|
@@ -2132,8 +2091,8 @@ export declare enum Interval {
|
|
|
2132
2091
|
SECOND = "SECOND"
|
|
2133
2092
|
}
|
|
2134
2093
|
/** @enumType */
|
|
2135
|
-
|
|
2136
|
-
|
|
2094
|
+
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
2095
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
2137
2096
|
/** Value aggregation */
|
|
2138
2097
|
value?: ValueAggregation;
|
|
2139
2098
|
/** Range aggregation */
|
|
@@ -2156,7 +2115,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
2156
2115
|
fieldPath?: string;
|
|
2157
2116
|
}
|
|
2158
2117
|
/** @oneof */
|
|
2159
|
-
|
|
2118
|
+
interface NestedAggregationItemKindOneOf {
|
|
2160
2119
|
/** Value aggregation */
|
|
2161
2120
|
value?: ValueAggregation;
|
|
2162
2121
|
/** Range aggregation */
|
|
@@ -2166,7 +2125,7 @@ export interface NestedAggregationItemKindOneOf {
|
|
|
2166
2125
|
/** Date histogram aggregation */
|
|
2167
2126
|
dateHistogram?: DateHistogramAggregation;
|
|
2168
2127
|
}
|
|
2169
|
-
|
|
2128
|
+
declare enum AggregationType {
|
|
2170
2129
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2171
2130
|
VALUE = "VALUE",
|
|
2172
2131
|
RANGE = "RANGE",
|
|
@@ -2175,9 +2134,9 @@ export declare enum AggregationType {
|
|
|
2175
2134
|
NESTED = "NESTED"
|
|
2176
2135
|
}
|
|
2177
2136
|
/** @enumType */
|
|
2178
|
-
|
|
2137
|
+
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
2179
2138
|
/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
2180
|
-
|
|
2139
|
+
interface NestedAggregation {
|
|
2181
2140
|
/**
|
|
2182
2141
|
* Flattened list of aggregations, where each next aggregation is nested within previous one
|
|
2183
2142
|
* @minSize 2
|
|
@@ -2185,7 +2144,7 @@ export interface NestedAggregation {
|
|
|
2185
2144
|
*/
|
|
2186
2145
|
nestedAggregations?: NestedAggregationItem[];
|
|
2187
2146
|
}
|
|
2188
|
-
|
|
2147
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
2189
2148
|
/** Value aggregation configuration */
|
|
2190
2149
|
value?: ValueAggregation;
|
|
2191
2150
|
/**
|
|
@@ -2200,11 +2159,11 @@ export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
|
2200
2159
|
fieldPath?: string;
|
|
2201
2160
|
}
|
|
2202
2161
|
/** @oneof */
|
|
2203
|
-
|
|
2162
|
+
interface GroupByAggregationKindOneOf {
|
|
2204
2163
|
/** Value aggregation configuration */
|
|
2205
2164
|
value?: ValueAggregation;
|
|
2206
2165
|
}
|
|
2207
|
-
|
|
2166
|
+
interface SearchDetails {
|
|
2208
2167
|
/** Boolean search mode */
|
|
2209
2168
|
mode?: ModeWithLiterals;
|
|
2210
2169
|
/**
|
|
@@ -2221,15 +2180,15 @@ export interface SearchDetails {
|
|
|
2221
2180
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
2222
2181
|
fuzzy?: boolean;
|
|
2223
2182
|
}
|
|
2224
|
-
|
|
2183
|
+
declare enum Mode {
|
|
2225
2184
|
/** Any */
|
|
2226
2185
|
OR = "OR",
|
|
2227
2186
|
/** All */
|
|
2228
2187
|
AND = "AND"
|
|
2229
2188
|
}
|
|
2230
2189
|
/** @enumType */
|
|
2231
|
-
|
|
2232
|
-
|
|
2190
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
2191
|
+
interface SearchServicesResponse {
|
|
2233
2192
|
/** The retrieved services. */
|
|
2234
2193
|
services?: Service[];
|
|
2235
2194
|
/** Cursor paging metadata */
|
|
@@ -2237,7 +2196,7 @@ export interface SearchServicesResponse {
|
|
|
2237
2196
|
/** Response aggregation data */
|
|
2238
2197
|
aggregationData?: AggregationData;
|
|
2239
2198
|
}
|
|
2240
|
-
|
|
2199
|
+
interface CursorPagingMetadata {
|
|
2241
2200
|
/** Number of items returned in the response. */
|
|
2242
2201
|
count?: number | null;
|
|
2243
2202
|
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
@@ -2249,14 +2208,14 @@ export interface CursorPagingMetadata {
|
|
|
2249
2208
|
*/
|
|
2250
2209
|
hasNext?: boolean | null;
|
|
2251
2210
|
}
|
|
2252
|
-
|
|
2211
|
+
interface AggregationData {
|
|
2253
2212
|
/**
|
|
2254
2213
|
* key = aggregation name (as derived from search request)
|
|
2255
2214
|
* @maxSize 10000
|
|
2256
2215
|
*/
|
|
2257
2216
|
results?: AggregationResults[];
|
|
2258
2217
|
}
|
|
2259
|
-
|
|
2218
|
+
interface ValueAggregationResult {
|
|
2260
2219
|
/**
|
|
2261
2220
|
* Value of the field
|
|
2262
2221
|
* @maxLength 100
|
|
@@ -2265,7 +2224,7 @@ export interface ValueAggregationResult {
|
|
|
2265
2224
|
/** Count of entities with this value */
|
|
2266
2225
|
count?: number;
|
|
2267
2226
|
}
|
|
2268
|
-
|
|
2227
|
+
interface RangeAggregationResult {
|
|
2269
2228
|
/** Inclusive lower bound of the range */
|
|
2270
2229
|
from?: number | null;
|
|
2271
2230
|
/** Exclusive upper bound of the range */
|
|
@@ -2273,7 +2232,7 @@ export interface RangeAggregationResult {
|
|
|
2273
2232
|
/** Count of entities in this range */
|
|
2274
2233
|
count?: number;
|
|
2275
2234
|
}
|
|
2276
|
-
|
|
2235
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
2277
2236
|
/** Value aggregation results */
|
|
2278
2237
|
values?: ValueResults;
|
|
2279
2238
|
/** Range aggregation results */
|
|
@@ -2294,7 +2253,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
2294
2253
|
fieldPath?: string;
|
|
2295
2254
|
}
|
|
2296
2255
|
/** @oneof */
|
|
2297
|
-
|
|
2256
|
+
interface NestedAggregationResultsResultOneOf {
|
|
2298
2257
|
/** Value aggregation results */
|
|
2299
2258
|
values?: ValueResults;
|
|
2300
2259
|
/** Range aggregation results */
|
|
@@ -2302,27 +2261,27 @@ export interface NestedAggregationResultsResultOneOf {
|
|
|
2302
2261
|
/** Scalar aggregation results */
|
|
2303
2262
|
scalar?: AggregationResultsScalarResult;
|
|
2304
2263
|
}
|
|
2305
|
-
|
|
2264
|
+
interface ValueResults {
|
|
2306
2265
|
/**
|
|
2307
2266
|
* List of value aggregations
|
|
2308
2267
|
* @maxSize 250
|
|
2309
2268
|
*/
|
|
2310
2269
|
results?: ValueAggregationResult[];
|
|
2311
2270
|
}
|
|
2312
|
-
|
|
2271
|
+
interface RangeResults {
|
|
2313
2272
|
/**
|
|
2314
2273
|
* List of ranges returned in same order as requested
|
|
2315
2274
|
* @maxSize 50
|
|
2316
2275
|
*/
|
|
2317
2276
|
results?: RangeAggregationResult[];
|
|
2318
2277
|
}
|
|
2319
|
-
|
|
2278
|
+
interface AggregationResultsScalarResult {
|
|
2320
2279
|
/** Type of scalar aggregation */
|
|
2321
2280
|
type?: ScalarTypeWithLiterals;
|
|
2322
2281
|
/** Value of the scalar aggregation */
|
|
2323
2282
|
value?: number;
|
|
2324
2283
|
}
|
|
2325
|
-
|
|
2284
|
+
interface NestedValueAggregationResult {
|
|
2326
2285
|
/**
|
|
2327
2286
|
* Value of the field
|
|
2328
2287
|
* @maxLength 1000
|
|
@@ -2331,7 +2290,7 @@ export interface NestedValueAggregationResult {
|
|
|
2331
2290
|
/** Nested aggregations */
|
|
2332
2291
|
nestedResults?: NestedAggregationResults;
|
|
2333
2292
|
}
|
|
2334
|
-
|
|
2293
|
+
interface ValueResult {
|
|
2335
2294
|
/**
|
|
2336
2295
|
* Value of the field
|
|
2337
2296
|
* @maxLength 1000
|
|
@@ -2340,7 +2299,7 @@ export interface ValueResult {
|
|
|
2340
2299
|
/** Count of entities with this value */
|
|
2341
2300
|
count?: number | null;
|
|
2342
2301
|
}
|
|
2343
|
-
|
|
2302
|
+
interface RangeResult {
|
|
2344
2303
|
/** Inclusive lower bound of the range */
|
|
2345
2304
|
from?: number | null;
|
|
2346
2305
|
/** Exclusive upper bound of the range */
|
|
@@ -2348,11 +2307,11 @@ export interface RangeResult {
|
|
|
2348
2307
|
/** Count of entities in this range */
|
|
2349
2308
|
count?: number | null;
|
|
2350
2309
|
}
|
|
2351
|
-
|
|
2310
|
+
interface ScalarResult {
|
|
2352
2311
|
/** Value of the scalar aggregation */
|
|
2353
2312
|
value?: number;
|
|
2354
2313
|
}
|
|
2355
|
-
|
|
2314
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
2356
2315
|
/** Value aggregation result */
|
|
2357
2316
|
value?: ValueResult;
|
|
2358
2317
|
/** Range aggregation result */
|
|
@@ -2363,7 +2322,7 @@ export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
|
2363
2322
|
dateHistogram?: ValueResult;
|
|
2364
2323
|
}
|
|
2365
2324
|
/** @oneof */
|
|
2366
|
-
|
|
2325
|
+
interface NestedResultValueResultOneOf {
|
|
2367
2326
|
/** Value aggregation result */
|
|
2368
2327
|
value?: ValueResult;
|
|
2369
2328
|
/** Range aggregation result */
|
|
@@ -2373,11 +2332,11 @@ export interface NestedResultValueResultOneOf {
|
|
|
2373
2332
|
/** Date histogram aggregation result */
|
|
2374
2333
|
dateHistogram?: ValueResult;
|
|
2375
2334
|
}
|
|
2376
|
-
|
|
2335
|
+
interface Results {
|
|
2377
2336
|
/** List of nested aggregations */
|
|
2378
2337
|
results?: Record<string, NestedResultValue>;
|
|
2379
2338
|
}
|
|
2380
|
-
|
|
2339
|
+
interface DateHistogramResult {
|
|
2381
2340
|
/**
|
|
2382
2341
|
* Date in ISO 8601 format
|
|
2383
2342
|
* @maxLength 100
|
|
@@ -2386,14 +2345,14 @@ export interface DateHistogramResult {
|
|
|
2386
2345
|
/** Count of documents in the bucket */
|
|
2387
2346
|
count?: number;
|
|
2388
2347
|
}
|
|
2389
|
-
|
|
2348
|
+
interface GroupByValueResults {
|
|
2390
2349
|
/**
|
|
2391
2350
|
* List of value aggregations
|
|
2392
2351
|
* @maxSize 1000
|
|
2393
2352
|
*/
|
|
2394
2353
|
results?: NestedValueAggregationResult[];
|
|
2395
2354
|
}
|
|
2396
|
-
|
|
2355
|
+
interface DateHistogramResults {
|
|
2397
2356
|
/**
|
|
2398
2357
|
* List of date histogram aggregations
|
|
2399
2358
|
* @maxSize 200
|
|
@@ -2404,14 +2363,14 @@ export interface DateHistogramResults {
|
|
|
2404
2363
|
* results of `NESTED` aggregation type in a flattened form
|
|
2405
2364
|
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
2406
2365
|
*/
|
|
2407
|
-
|
|
2366
|
+
interface NestedResults {
|
|
2408
2367
|
/**
|
|
2409
2368
|
* List of nested aggregations
|
|
2410
2369
|
* @maxSize 1000
|
|
2411
2370
|
*/
|
|
2412
2371
|
results?: Results[];
|
|
2413
2372
|
}
|
|
2414
|
-
|
|
2373
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
2415
2374
|
/** Value aggregation results */
|
|
2416
2375
|
values?: ValueResults;
|
|
2417
2376
|
/** Range aggregation results */
|
|
@@ -2438,7 +2397,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
2438
2397
|
fieldPath?: string;
|
|
2439
2398
|
}
|
|
2440
2399
|
/** @oneof */
|
|
2441
|
-
|
|
2400
|
+
interface AggregationResultsResultOneOf {
|
|
2442
2401
|
/** Value aggregation results */
|
|
2443
2402
|
values?: ValueResults;
|
|
2444
2403
|
/** Range aggregation results */
|
|
@@ -2452,7 +2411,7 @@ export interface AggregationResultsResultOneOf {
|
|
|
2452
2411
|
/** Nested aggregation results */
|
|
2453
2412
|
nested?: NestedResults;
|
|
2454
2413
|
}
|
|
2455
|
-
|
|
2414
|
+
interface QueryPoliciesRequest {
|
|
2456
2415
|
/**
|
|
2457
2416
|
* Information about filters, paging, and sorting. See the article about
|
|
2458
2417
|
* booking policy filters
|
|
@@ -2461,7 +2420,7 @@ export interface QueryPoliciesRequest {
|
|
|
2461
2420
|
*/
|
|
2462
2421
|
query: CursorQuery;
|
|
2463
2422
|
}
|
|
2464
|
-
|
|
2423
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2465
2424
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
2466
2425
|
cursorPaging?: CursorPaging;
|
|
2467
2426
|
/**
|
|
@@ -2481,17 +2440,17 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2481
2440
|
sort?: Sorting[];
|
|
2482
2441
|
}
|
|
2483
2442
|
/** @oneof */
|
|
2484
|
-
|
|
2443
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2485
2444
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
2486
2445
|
cursorPaging?: CursorPaging;
|
|
2487
2446
|
}
|
|
2488
|
-
|
|
2447
|
+
interface QueryPoliciesResponse {
|
|
2489
2448
|
/** Retrieved booking policies and information about the services using them. */
|
|
2490
2449
|
bookingPolicies?: BookingPolicyWithServices[];
|
|
2491
2450
|
/** Paging metadata. */
|
|
2492
2451
|
pagingMetadata?: CursorPagingMetadata;
|
|
2493
2452
|
}
|
|
2494
|
-
|
|
2453
|
+
interface BookingPolicyWithServices {
|
|
2495
2454
|
/** Retrieved booking policy. */
|
|
2496
2455
|
bookingPolicy?: BookingPolicy;
|
|
2497
2456
|
/**
|
|
@@ -2507,7 +2466,7 @@ export interface BookingPolicyWithServices {
|
|
|
2507
2466
|
/** Total number of services connected to the booking policy. */
|
|
2508
2467
|
totalServiceCount?: number;
|
|
2509
2468
|
}
|
|
2510
|
-
|
|
2469
|
+
interface QueryBookingFormsRequest {
|
|
2511
2470
|
/**
|
|
2512
2471
|
* Information about filters, paging, and sorting. See the article about
|
|
2513
2472
|
* form filters ([REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object))
|
|
@@ -2520,15 +2479,15 @@ export interface QueryBookingFormsRequest {
|
|
|
2520
2479
|
*/
|
|
2521
2480
|
conditionalFields?: RequestedFieldsWithLiterals[];
|
|
2522
2481
|
}
|
|
2523
|
-
|
|
2482
|
+
declare enum RequestedFields {
|
|
2524
2483
|
/** Unknown requested conditional field. */
|
|
2525
2484
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2526
2485
|
/** Whether to return the site's default booking form. */
|
|
2527
2486
|
DEFAULT_BOOKING_FORM = "DEFAULT_BOOKING_FORM"
|
|
2528
2487
|
}
|
|
2529
2488
|
/** @enumType */
|
|
2530
|
-
|
|
2531
|
-
|
|
2489
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DEFAULT_BOOKING_FORM';
|
|
2490
|
+
interface QueryBookingFormsResponse {
|
|
2532
2491
|
/** Retrieved booking forms and information about connected services. */
|
|
2533
2492
|
bookingForms?: BookingForm[];
|
|
2534
2493
|
/** Paging metadata. */
|
|
@@ -2536,7 +2495,7 @@ export interface QueryBookingFormsResponse {
|
|
|
2536
2495
|
/** The site's default booking form and information about connected services. */
|
|
2537
2496
|
defaultBookingForm?: BookingForm;
|
|
2538
2497
|
}
|
|
2539
|
-
|
|
2498
|
+
interface BookingForm {
|
|
2540
2499
|
/** Information about the retrieved booking form. */
|
|
2541
2500
|
formDetails?: FormDetails;
|
|
2542
2501
|
/**
|
|
@@ -2552,7 +2511,7 @@ export interface BookingForm {
|
|
|
2552
2511
|
/** Total number of services connected to the booking form. */
|
|
2553
2512
|
totalServiceCount?: number;
|
|
2554
2513
|
}
|
|
2555
|
-
|
|
2514
|
+
interface FormDetails {
|
|
2556
2515
|
/**
|
|
2557
2516
|
* Form ID.
|
|
2558
2517
|
* @format GUID
|
|
@@ -2571,12 +2530,12 @@ export interface FormDetails {
|
|
|
2571
2530
|
*/
|
|
2572
2531
|
revision?: string | null;
|
|
2573
2532
|
}
|
|
2574
|
-
|
|
2533
|
+
interface ConnectedService {
|
|
2575
2534
|
/**
|
|
2576
2535
|
* ID of the service connected to the booking form.
|
|
2577
2536
|
* @format GUID
|
|
2578
2537
|
*/
|
|
2579
|
-
|
|
2538
|
+
_id?: string | null;
|
|
2580
2539
|
/**
|
|
2581
2540
|
* Name of the service connected to the booking form.
|
|
2582
2541
|
* @maxLength 400
|
|
@@ -2584,7 +2543,7 @@ export interface ConnectedService {
|
|
|
2584
2543
|
*/
|
|
2585
2544
|
name?: string | null;
|
|
2586
2545
|
}
|
|
2587
|
-
|
|
2546
|
+
interface CountServicesRequest {
|
|
2588
2547
|
/**
|
|
2589
2548
|
* Query filter to base the count on. See supported filters
|
|
2590
2549
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
@@ -2592,15 +2551,15 @@ export interface CountServicesRequest {
|
|
|
2592
2551
|
*/
|
|
2593
2552
|
filter?: Record<string, any> | null;
|
|
2594
2553
|
}
|
|
2595
|
-
|
|
2554
|
+
interface CountServicesResponse {
|
|
2596
2555
|
/** Number of services matching the specified filter. */
|
|
2597
2556
|
count?: number;
|
|
2598
2557
|
}
|
|
2599
|
-
|
|
2558
|
+
interface QueryLocationsRequest {
|
|
2600
2559
|
/** Filter. */
|
|
2601
2560
|
filter?: QueryLocationsFilter;
|
|
2602
2561
|
}
|
|
2603
|
-
|
|
2562
|
+
interface QueryLocationsFilter {
|
|
2604
2563
|
/**
|
|
2605
2564
|
* Service filter. See supported filters
|
|
2606
2565
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
@@ -2614,7 +2573,7 @@ export interface QueryLocationsFilter {
|
|
|
2614
2573
|
*/
|
|
2615
2574
|
businessLocationIds?: string[];
|
|
2616
2575
|
}
|
|
2617
|
-
|
|
2576
|
+
interface QueryLocationsResponse {
|
|
2618
2577
|
/**
|
|
2619
2578
|
* Retrieved business locations and whether each location is connected to at
|
|
2620
2579
|
* least one service.
|
|
@@ -2631,7 +2590,7 @@ export interface QueryLocationsResponse {
|
|
|
2631
2590
|
*/
|
|
2632
2591
|
customerLocations?: CustomerLocations;
|
|
2633
2592
|
}
|
|
2634
|
-
|
|
2593
|
+
interface BusinessLocations {
|
|
2635
2594
|
/**
|
|
2636
2595
|
* Whether at least one service matching the filter is connected to any of the
|
|
2637
2596
|
* retrieved business locations.
|
|
@@ -2643,25 +2602,25 @@ export interface BusinessLocations {
|
|
|
2643
2602
|
*/
|
|
2644
2603
|
locations?: Location[];
|
|
2645
2604
|
}
|
|
2646
|
-
|
|
2605
|
+
interface CustomLocations {
|
|
2647
2606
|
/**
|
|
2648
2607
|
* Whether at least one service matching the filter is connected to any of the
|
|
2649
2608
|
* retrieved custom locations.
|
|
2650
2609
|
*/
|
|
2651
2610
|
exists?: boolean;
|
|
2652
2611
|
}
|
|
2653
|
-
|
|
2612
|
+
interface CustomerLocations {
|
|
2654
2613
|
/**
|
|
2655
2614
|
* Whether at least one service matching the filter is connected to any of the
|
|
2656
2615
|
* retrieved customer locations.
|
|
2657
2616
|
*/
|
|
2658
2617
|
exists?: boolean;
|
|
2659
2618
|
}
|
|
2660
|
-
|
|
2619
|
+
interface QueryCategoriesRequest {
|
|
2661
2620
|
/** Filter. */
|
|
2662
2621
|
filter?: QueryCategoriesFilter;
|
|
2663
2622
|
}
|
|
2664
|
-
|
|
2623
|
+
interface QueryCategoriesFilter {
|
|
2665
2624
|
/**
|
|
2666
2625
|
* Service filter. See supported filters
|
|
2667
2626
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
@@ -2675,15 +2634,15 @@ export interface QueryCategoriesFilter {
|
|
|
2675
2634
|
*/
|
|
2676
2635
|
categoryIds?: string[];
|
|
2677
2636
|
}
|
|
2678
|
-
|
|
2637
|
+
interface QueryCategoriesResponse {
|
|
2679
2638
|
/** Retrieved categories. */
|
|
2680
2639
|
categories?: V2Category[];
|
|
2681
2640
|
}
|
|
2682
|
-
|
|
2641
|
+
interface QueryServicesMultiLanguageRequest {
|
|
2683
2642
|
/** WQL expression. */
|
|
2684
2643
|
query?: QueryV2;
|
|
2685
2644
|
}
|
|
2686
|
-
|
|
2645
|
+
interface QueryServicesMultiLanguageResponse {
|
|
2687
2646
|
/** The retrieved services in the main language */
|
|
2688
2647
|
services?: Service[];
|
|
2689
2648
|
/**
|
|
@@ -2694,7 +2653,7 @@ export interface QueryServicesMultiLanguageResponse {
|
|
|
2694
2653
|
/** Paging metadata, including offset and count. */
|
|
2695
2654
|
pagingMetadata?: PagingMetadataV2;
|
|
2696
2655
|
}
|
|
2697
|
-
|
|
2656
|
+
interface SetServiceLocationsRequest {
|
|
2698
2657
|
/**
|
|
2699
2658
|
* ID of the service.
|
|
2700
2659
|
* @format GUID
|
|
@@ -2717,7 +2676,7 @@ export interface SetServiceLocationsRequest {
|
|
|
2717
2676
|
*/
|
|
2718
2677
|
participantNotification?: ParticipantNotification;
|
|
2719
2678
|
}
|
|
2720
|
-
|
|
2679
|
+
interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2721
2680
|
/**
|
|
2722
2681
|
* Details about the new location of future events that were scheduled to take
|
|
2723
2682
|
* place at a removed location.
|
|
@@ -2727,14 +2686,14 @@ export interface RemovedLocationSessionsAction extends RemovedLocationSessionsAc
|
|
|
2727
2686
|
action?: ActionWithLiterals;
|
|
2728
2687
|
}
|
|
2729
2688
|
/** @oneof */
|
|
2730
|
-
|
|
2689
|
+
interface RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2731
2690
|
/**
|
|
2732
2691
|
* Details about the new location of future events that were scheduled to take
|
|
2733
2692
|
* place at a removed location.
|
|
2734
2693
|
*/
|
|
2735
2694
|
moveToLocationOptions?: MoveToNewLocationsOptions;
|
|
2736
2695
|
}
|
|
2737
|
-
|
|
2696
|
+
declare enum Action {
|
|
2738
2697
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2739
2698
|
/** Retain all future sessions at their current location. This is the default. */
|
|
2740
2699
|
KEEP_AT_CURRENT_LOCATION = "KEEP_AT_CURRENT_LOCATION",
|
|
@@ -2747,16 +2706,16 @@ export declare enum Action {
|
|
|
2747
2706
|
DELETE = "DELETE"
|
|
2748
2707
|
}
|
|
2749
2708
|
/** @enumType */
|
|
2750
|
-
|
|
2751
|
-
|
|
2709
|
+
type ActionWithLiterals = Action | 'UNKNOWN_ACTION_TYPE' | 'KEEP_AT_CURRENT_LOCATION' | 'MOVE_TO_LOCATION' | 'DELETE';
|
|
2710
|
+
interface MoveToNewLocationsOptions {
|
|
2752
2711
|
/** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
|
|
2753
2712
|
newLocation?: Location;
|
|
2754
2713
|
}
|
|
2755
|
-
|
|
2714
|
+
interface SetServiceLocationsResponse {
|
|
2756
2715
|
/** The updated service with the newly set locations. */
|
|
2757
2716
|
service?: Service;
|
|
2758
2717
|
}
|
|
2759
|
-
|
|
2718
|
+
interface EnablePricingPlansForServiceRequest {
|
|
2760
2719
|
/**
|
|
2761
2720
|
* ID of the service to update.
|
|
2762
2721
|
* @format GUID
|
|
@@ -2771,23 +2730,23 @@ export interface EnablePricingPlansForServiceRequest {
|
|
|
2771
2730
|
*/
|
|
2772
2731
|
pricingPlanIds: string[];
|
|
2773
2732
|
}
|
|
2774
|
-
|
|
2733
|
+
interface EnablePricingPlansForServiceResponse {
|
|
2775
2734
|
/** Updated service. */
|
|
2776
2735
|
service?: Service;
|
|
2777
2736
|
}
|
|
2778
|
-
|
|
2737
|
+
interface InvalidPricingPlan {
|
|
2779
2738
|
/**
|
|
2780
2739
|
* ID of the invalid pricing plan.
|
|
2781
2740
|
* @format GUID
|
|
2782
2741
|
*/
|
|
2783
|
-
|
|
2742
|
+
_id?: string;
|
|
2784
2743
|
/**
|
|
2785
2744
|
* Explanation why the pricing plan is considered invalid.
|
|
2786
2745
|
* @maxLength 2000
|
|
2787
2746
|
*/
|
|
2788
2747
|
message?: string;
|
|
2789
2748
|
}
|
|
2790
|
-
|
|
2749
|
+
interface DisablePricingPlansForServiceRequest {
|
|
2791
2750
|
/**
|
|
2792
2751
|
* ID of the service to update.
|
|
2793
2752
|
* @format GUID
|
|
@@ -2802,11 +2761,11 @@ export interface DisablePricingPlansForServiceRequest {
|
|
|
2802
2761
|
*/
|
|
2803
2762
|
pricingPlanIds?: string[];
|
|
2804
2763
|
}
|
|
2805
|
-
|
|
2764
|
+
interface DisablePricingPlansForServiceResponse {
|
|
2806
2765
|
/** Updated service. */
|
|
2807
2766
|
service?: Service;
|
|
2808
2767
|
}
|
|
2809
|
-
|
|
2768
|
+
interface SetCustomSlugRequest {
|
|
2810
2769
|
/**
|
|
2811
2770
|
* ID of the service for which to update the active slug.
|
|
2812
2771
|
* @format GUID
|
|
@@ -2818,13 +2777,13 @@ export interface SetCustomSlugRequest {
|
|
|
2818
2777
|
*/
|
|
2819
2778
|
slug?: string;
|
|
2820
2779
|
}
|
|
2821
|
-
|
|
2780
|
+
interface SetCustomSlugResponse {
|
|
2822
2781
|
/** Updated active service slug. */
|
|
2823
2782
|
slug?: Slug;
|
|
2824
2783
|
/** Updated service. */
|
|
2825
2784
|
service?: Service;
|
|
2826
2785
|
}
|
|
2827
|
-
|
|
2786
|
+
interface ValidateSlugRequest {
|
|
2828
2787
|
/**
|
|
2829
2788
|
* IO of the service to check custom slug validity for.
|
|
2830
2789
|
* @format GUID
|
|
@@ -2836,7 +2795,7 @@ export interface ValidateSlugRequest {
|
|
|
2836
2795
|
*/
|
|
2837
2796
|
slug?: string;
|
|
2838
2797
|
}
|
|
2839
|
-
|
|
2798
|
+
interface ValidateSlugResponse {
|
|
2840
2799
|
/** Whether the slug is valid. */
|
|
2841
2800
|
valid?: boolean;
|
|
2842
2801
|
/**
|
|
@@ -2850,7 +2809,7 @@ export interface ValidateSlugResponse {
|
|
|
2850
2809
|
*/
|
|
2851
2810
|
errors?: InvalidSlugErrorWithLiterals[];
|
|
2852
2811
|
}
|
|
2853
|
-
|
|
2812
|
+
declare enum InvalidSlugError {
|
|
2854
2813
|
/** Unknown slug error. */
|
|
2855
2814
|
UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
|
|
2856
2815
|
/** Slug contains illegal characters. */
|
|
@@ -2859,15 +2818,15 @@ export declare enum InvalidSlugError {
|
|
|
2859
2818
|
SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
|
|
2860
2819
|
}
|
|
2861
2820
|
/** @enumType */
|
|
2862
|
-
|
|
2863
|
-
|
|
2821
|
+
type InvalidSlugErrorWithLiterals = InvalidSlugError | 'UNKNOWN_SLUG_ERROR' | 'SLUG_CONTAINS_ILLEGAL_CHARACTERS' | 'SLUG_ALREADY_EXISTS';
|
|
2822
|
+
interface CloneServiceRequest {
|
|
2864
2823
|
/**
|
|
2865
2824
|
* ID of the service to clone.
|
|
2866
2825
|
* @format GUID
|
|
2867
2826
|
*/
|
|
2868
2827
|
sourceServiceId: string;
|
|
2869
2828
|
}
|
|
2870
|
-
|
|
2829
|
+
interface CloneServiceResponse {
|
|
2871
2830
|
/** Cloned service. */
|
|
2872
2831
|
service?: Service;
|
|
2873
2832
|
/**
|
|
@@ -2877,7 +2836,7 @@ export interface CloneServiceResponse {
|
|
|
2877
2836
|
*/
|
|
2878
2837
|
errors?: CloneErrorsWithLiterals[];
|
|
2879
2838
|
}
|
|
2880
|
-
|
|
2839
|
+
declare enum CloneErrors {
|
|
2881
2840
|
/**
|
|
2882
2841
|
* Failed to clone the original service's *options and variants*
|
|
2883
2842
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
@@ -2887,20 +2846,20 @@ export declare enum CloneErrors {
|
|
|
2887
2846
|
FORM = "FORM"
|
|
2888
2847
|
}
|
|
2889
2848
|
/** @enumType */
|
|
2890
|
-
|
|
2849
|
+
type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
|
|
2891
2850
|
/** An event sent every time a category entity is changed. */
|
|
2892
|
-
|
|
2851
|
+
interface CategoryNotification {
|
|
2893
2852
|
category?: Category;
|
|
2894
2853
|
event?: CategoryNotificationEventWithLiterals;
|
|
2895
2854
|
}
|
|
2896
2855
|
/** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
|
|
2897
|
-
|
|
2856
|
+
interface Category {
|
|
2898
2857
|
/**
|
|
2899
2858
|
* Category ID.
|
|
2900
2859
|
* @format GUID
|
|
2901
2860
|
* @readonly
|
|
2902
2861
|
*/
|
|
2903
|
-
|
|
2862
|
+
_id?: string | null;
|
|
2904
2863
|
/**
|
|
2905
2864
|
* Category name.
|
|
2906
2865
|
* @maxLength 500
|
|
@@ -2916,15 +2875,15 @@ export interface Category {
|
|
|
2916
2875
|
/** Sort order of the category in the live site and dashboard. */
|
|
2917
2876
|
sortOrder?: number | null;
|
|
2918
2877
|
}
|
|
2919
|
-
|
|
2878
|
+
declare enum Status {
|
|
2920
2879
|
/** The category was created. */
|
|
2921
2880
|
CREATED = "CREATED",
|
|
2922
2881
|
/** The category was deleted. */
|
|
2923
2882
|
DELETED = "DELETED"
|
|
2924
2883
|
}
|
|
2925
2884
|
/** @enumType */
|
|
2926
|
-
|
|
2927
|
-
|
|
2885
|
+
type StatusWithLiterals = Status | 'CREATED' | 'DELETED';
|
|
2886
|
+
declare enum CategoryNotificationEvent {
|
|
2928
2887
|
/** Category was updated. */
|
|
2929
2888
|
Updated = "Updated",
|
|
2930
2889
|
/** Category was deleted. */
|
|
@@ -2933,10 +2892,10 @@ export declare enum CategoryNotificationEvent {
|
|
|
2933
2892
|
Created = "Created"
|
|
2934
2893
|
}
|
|
2935
2894
|
/** @enumType */
|
|
2936
|
-
|
|
2937
|
-
|
|
2895
|
+
type CategoryNotificationEventWithLiterals = CategoryNotificationEvent | 'Updated' | 'Deleted' | 'Created';
|
|
2896
|
+
interface Empty {
|
|
2938
2897
|
}
|
|
2939
|
-
|
|
2898
|
+
interface BenefitNotification {
|
|
2940
2899
|
/**
|
|
2941
2900
|
* Plan unique ID
|
|
2942
2901
|
* @format GUID
|
|
@@ -2954,13 +2913,13 @@ export interface BenefitNotification {
|
|
|
2954
2913
|
/** Notification event */
|
|
2955
2914
|
event?: EventWithLiterals;
|
|
2956
2915
|
}
|
|
2957
|
-
|
|
2916
|
+
interface Benefit {
|
|
2958
2917
|
/**
|
|
2959
2918
|
* Benefit unique ID
|
|
2960
2919
|
* @format GUID
|
|
2961
2920
|
* @readonly
|
|
2962
2921
|
*/
|
|
2963
|
-
|
|
2922
|
+
_id?: string | null;
|
|
2964
2923
|
/** Benefit Type */
|
|
2965
2924
|
benefitType?: BenefitTypeWithLiterals;
|
|
2966
2925
|
/**
|
|
@@ -2986,9 +2945,9 @@ export interface Benefit {
|
|
|
2986
2945
|
*/
|
|
2987
2946
|
appDefId?: string | null;
|
|
2988
2947
|
}
|
|
2989
|
-
|
|
2948
|
+
interface EntryPass {
|
|
2990
2949
|
}
|
|
2991
|
-
|
|
2950
|
+
interface Discount extends DiscountDiscountOneOf {
|
|
2992
2951
|
/**
|
|
2993
2952
|
* Fixed-rate percent off discount
|
|
2994
2953
|
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
@@ -3001,7 +2960,7 @@ export interface Discount extends DiscountDiscountOneOf {
|
|
|
3001
2960
|
moneyOffAmount?: string;
|
|
3002
2961
|
}
|
|
3003
2962
|
/** @oneof */
|
|
3004
|
-
|
|
2963
|
+
interface DiscountDiscountOneOf {
|
|
3005
2964
|
/**
|
|
3006
2965
|
* Fixed-rate percent off discount
|
|
3007
2966
|
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
@@ -3013,7 +2972,7 @@ export interface DiscountDiscountOneOf {
|
|
|
3013
2972
|
*/
|
|
3014
2973
|
moneyOffAmount?: string;
|
|
3015
2974
|
}
|
|
3016
|
-
|
|
2975
|
+
declare enum BenefitType {
|
|
3017
2976
|
/** Should never be used */
|
|
3018
2977
|
UNDEFINED = "UNDEFINED",
|
|
3019
2978
|
/** Limited benefit type */
|
|
@@ -3022,35 +2981,35 @@ export declare enum BenefitType {
|
|
|
3022
2981
|
UNLIMITED = "UNLIMITED"
|
|
3023
2982
|
}
|
|
3024
2983
|
/** @enumType */
|
|
3025
|
-
|
|
3026
|
-
|
|
2984
|
+
type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
|
|
2985
|
+
interface Behavior extends BehaviorBehaviorOneOf {
|
|
3027
2986
|
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
3028
2987
|
defaultBehavior?: EntryPass;
|
|
3029
2988
|
/** Discount applied to paid resources */
|
|
3030
2989
|
discount?: Discount;
|
|
3031
2990
|
}
|
|
3032
2991
|
/** @oneof */
|
|
3033
|
-
|
|
2992
|
+
interface BehaviorBehaviorOneOf {
|
|
3034
2993
|
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
3035
2994
|
defaultBehavior?: EntryPass;
|
|
3036
2995
|
/** Discount applied to paid resources */
|
|
3037
2996
|
discount?: Discount;
|
|
3038
2997
|
}
|
|
3039
|
-
|
|
2998
|
+
declare enum Event {
|
|
3040
2999
|
Updated = "Updated",
|
|
3041
3000
|
Deleted = "Deleted",
|
|
3042
3001
|
Created = "Created"
|
|
3043
3002
|
}
|
|
3044
3003
|
/** @enumType */
|
|
3045
|
-
|
|
3046
|
-
|
|
3004
|
+
type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
|
|
3005
|
+
interface UserDomainInfoChangedEvent {
|
|
3047
3006
|
domainName?: string;
|
|
3048
3007
|
crudType?: CrudTypeWithLiterals;
|
|
3049
3008
|
/** @format GUID */
|
|
3050
3009
|
metaSiteId?: string | null;
|
|
3051
3010
|
changeTime?: Date | null;
|
|
3052
3011
|
}
|
|
3053
|
-
|
|
3012
|
+
declare enum CrudType {
|
|
3054
3013
|
INVALID_CRUD_TYPE = "INVALID_CRUD_TYPE",
|
|
3055
3014
|
CREATE = "CREATE",
|
|
3056
3015
|
UPDATE = "UPDATE",
|
|
@@ -3059,8 +3018,8 @@ export declare enum CrudType {
|
|
|
3059
3018
|
CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
|
|
3060
3019
|
}
|
|
3061
3020
|
/** @enumType */
|
|
3062
|
-
|
|
3063
|
-
|
|
3021
|
+
type CrudTypeWithLiterals = CrudType | 'INVALID_CRUD_TYPE' | 'CREATE' | 'UPDATE' | 'DELETE' | 'CREATE_OR_UPDATE';
|
|
3022
|
+
interface HtmlSitePublished {
|
|
3064
3023
|
/**
|
|
3065
3024
|
* Application instance ID
|
|
3066
3025
|
* @maxLength 50
|
|
@@ -3090,15 +3049,15 @@ export interface HtmlSitePublished {
|
|
|
3090
3049
|
/** Site's publish date */
|
|
3091
3050
|
publishDate?: string;
|
|
3092
3051
|
}
|
|
3093
|
-
|
|
3052
|
+
interface Page {
|
|
3094
3053
|
/**
|
|
3095
3054
|
* Page's Id
|
|
3096
3055
|
* @maxLength 100
|
|
3097
3056
|
*/
|
|
3098
|
-
|
|
3057
|
+
_id?: string;
|
|
3099
3058
|
}
|
|
3100
3059
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
3101
|
-
|
|
3060
|
+
interface SitePropertiesNotification {
|
|
3102
3061
|
/** The site ID for which this update notification applies. */
|
|
3103
3062
|
metasiteId?: string;
|
|
3104
3063
|
/** The actual update event. */
|
|
@@ -3112,7 +3071,7 @@ export interface SitePropertiesNotification {
|
|
|
3112
3071
|
changeContext?: ChangeContext;
|
|
3113
3072
|
}
|
|
3114
3073
|
/** The actual update event for a particular notification. */
|
|
3115
|
-
|
|
3074
|
+
interface SitePropertiesEvent {
|
|
3116
3075
|
/** Version of the site's properties represented by this update. */
|
|
3117
3076
|
version?: number;
|
|
3118
3077
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -3120,7 +3079,7 @@ export interface SitePropertiesEvent {
|
|
|
3120
3079
|
/** Updated properties. */
|
|
3121
3080
|
properties?: Properties;
|
|
3122
3081
|
}
|
|
3123
|
-
|
|
3082
|
+
interface Properties {
|
|
3124
3083
|
/** Site categories. */
|
|
3125
3084
|
categories?: Categories;
|
|
3126
3085
|
/** Site locale. */
|
|
@@ -3176,7 +3135,7 @@ export interface Properties {
|
|
|
3176
3135
|
/** Track clicks analytics. */
|
|
3177
3136
|
trackClicksAnalytics?: boolean;
|
|
3178
3137
|
}
|
|
3179
|
-
|
|
3138
|
+
interface Categories {
|
|
3180
3139
|
/** Primary site category. */
|
|
3181
3140
|
primary?: string;
|
|
3182
3141
|
/**
|
|
@@ -3187,13 +3146,13 @@ export interface Categories {
|
|
|
3187
3146
|
/** Business Term Id */
|
|
3188
3147
|
businessTermId?: string | null;
|
|
3189
3148
|
}
|
|
3190
|
-
|
|
3149
|
+
interface Locale {
|
|
3191
3150
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
3192
3151
|
languageCode?: string;
|
|
3193
3152
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
3194
3153
|
country?: string;
|
|
3195
3154
|
}
|
|
3196
|
-
|
|
3155
|
+
interface Address {
|
|
3197
3156
|
/** Street name. */
|
|
3198
3157
|
street?: string;
|
|
3199
3158
|
/** City name. */
|
|
@@ -3225,29 +3184,29 @@ export interface Address {
|
|
|
3225
3184
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
3226
3185
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
3227
3186
|
*/
|
|
3228
|
-
|
|
3187
|
+
interface AddressHint {
|
|
3229
3188
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
3230
3189
|
text?: string;
|
|
3231
3190
|
/** Where the extra text should be displayed. */
|
|
3232
3191
|
placement?: PlacementTypeWithLiterals;
|
|
3233
3192
|
}
|
|
3234
3193
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
3235
|
-
|
|
3194
|
+
declare enum PlacementType {
|
|
3236
3195
|
BEFORE = "BEFORE",
|
|
3237
3196
|
AFTER = "AFTER",
|
|
3238
3197
|
REPLACE = "REPLACE"
|
|
3239
3198
|
}
|
|
3240
3199
|
/** @enumType */
|
|
3241
|
-
|
|
3200
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
3242
3201
|
/** Geocoordinates for a particular address. */
|
|
3243
|
-
|
|
3202
|
+
interface GeoCoordinates {
|
|
3244
3203
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
3245
3204
|
latitude?: number;
|
|
3246
3205
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
3247
3206
|
longitude?: number;
|
|
3248
3207
|
}
|
|
3249
3208
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
3250
|
-
|
|
3209
|
+
interface BusinessSchedule {
|
|
3251
3210
|
/**
|
|
3252
3211
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
3253
3212
|
* @maxSize 100
|
|
@@ -3260,7 +3219,7 @@ export interface BusinessSchedule {
|
|
|
3260
3219
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
3261
3220
|
}
|
|
3262
3221
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
3263
|
-
|
|
3222
|
+
interface TimePeriod {
|
|
3264
3223
|
/** Day of the week the period starts on. */
|
|
3265
3224
|
openDay?: DayOfWeekWithLiterals;
|
|
3266
3225
|
/**
|
|
@@ -3279,7 +3238,7 @@ export interface TimePeriod {
|
|
|
3279
3238
|
closeTime?: string;
|
|
3280
3239
|
}
|
|
3281
3240
|
/** Enumerates the days of the week. */
|
|
3282
|
-
|
|
3241
|
+
declare enum DayOfWeek {
|
|
3283
3242
|
MONDAY = "MONDAY",
|
|
3284
3243
|
TUESDAY = "TUESDAY",
|
|
3285
3244
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -3289,9 +3248,9 @@ export declare enum DayOfWeek {
|
|
|
3289
3248
|
SUNDAY = "SUNDAY"
|
|
3290
3249
|
}
|
|
3291
3250
|
/** @enumType */
|
|
3292
|
-
|
|
3251
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
3293
3252
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
3294
|
-
|
|
3253
|
+
interface SpecialHourPeriod {
|
|
3295
3254
|
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
3296
3255
|
startDate?: string;
|
|
3297
3256
|
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
@@ -3305,7 +3264,7 @@ export interface SpecialHourPeriod {
|
|
|
3305
3264
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
3306
3265
|
comment?: string;
|
|
3307
3266
|
}
|
|
3308
|
-
|
|
3267
|
+
interface Multilingual {
|
|
3309
3268
|
/**
|
|
3310
3269
|
* Supported languages list.
|
|
3311
3270
|
* @maxSize 200
|
|
@@ -3314,7 +3273,7 @@ export interface Multilingual {
|
|
|
3314
3273
|
/** Whether to redirect to user language. */
|
|
3315
3274
|
autoRedirect?: boolean;
|
|
3316
3275
|
}
|
|
3317
|
-
|
|
3276
|
+
interface SupportedLanguage {
|
|
3318
3277
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
3319
3278
|
languageCode?: string;
|
|
3320
3279
|
/** Locale. */
|
|
@@ -3325,15 +3284,17 @@ export interface SupportedLanguage {
|
|
|
3325
3284
|
countryCode?: string;
|
|
3326
3285
|
/** How the language will be resolved. For internal use. */
|
|
3327
3286
|
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
3287
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
3288
|
+
isVisitorPrimary?: boolean | null;
|
|
3328
3289
|
}
|
|
3329
|
-
|
|
3290
|
+
declare enum ResolutionMethod {
|
|
3330
3291
|
QUERY_PARAM = "QUERY_PARAM",
|
|
3331
3292
|
SUBDOMAIN = "SUBDOMAIN",
|
|
3332
3293
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
3333
3294
|
}
|
|
3334
3295
|
/** @enumType */
|
|
3335
|
-
|
|
3336
|
-
|
|
3296
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
3297
|
+
interface ConsentPolicy {
|
|
3337
3298
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
3338
3299
|
essential?: boolean | null;
|
|
3339
3300
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -3346,7 +3307,7 @@ export interface ConsentPolicy {
|
|
|
3346
3307
|
dataToThirdParty?: boolean | null;
|
|
3347
3308
|
}
|
|
3348
3309
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
3349
|
-
|
|
3310
|
+
interface Translation {
|
|
3350
3311
|
/** The service type. */
|
|
3351
3312
|
serviceType?: string;
|
|
3352
3313
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -3354,7 +3315,7 @@ export interface Translation {
|
|
|
3354
3315
|
/** The instance ID of the service. */
|
|
3355
3316
|
instanceId?: string;
|
|
3356
3317
|
}
|
|
3357
|
-
|
|
3318
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
3358
3319
|
/** Properties were updated. */
|
|
3359
3320
|
propertiesChange?: PropertiesChange;
|
|
3360
3321
|
/** Default properties were created on site creation. */
|
|
@@ -3363,7 +3324,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
3363
3324
|
siteCloned?: SiteCloned;
|
|
3364
3325
|
}
|
|
3365
3326
|
/** @oneof */
|
|
3366
|
-
|
|
3327
|
+
interface ChangeContextPayloadOneOf {
|
|
3367
3328
|
/** Properties were updated. */
|
|
3368
3329
|
propertiesChange?: PropertiesChange;
|
|
3369
3330
|
/** Default properties were created on site creation. */
|
|
@@ -3371,13 +3332,573 @@ export interface ChangeContextPayloadOneOf {
|
|
|
3371
3332
|
/** Properties were cloned on site cloning. */
|
|
3372
3333
|
siteCloned?: SiteCloned;
|
|
3373
3334
|
}
|
|
3374
|
-
|
|
3335
|
+
interface PropertiesChange {
|
|
3375
3336
|
}
|
|
3376
|
-
|
|
3337
|
+
interface SiteCreated {
|
|
3377
3338
|
/** Origin template site id. */
|
|
3378
3339
|
originTemplateId?: string | null;
|
|
3379
3340
|
}
|
|
3380
|
-
|
|
3341
|
+
interface SiteCloned {
|
|
3381
3342
|
/** Origin site id. */
|
|
3382
3343
|
originMetaSiteId?: string;
|
|
3383
3344
|
}
|
|
3345
|
+
interface BaseEventMetadata {
|
|
3346
|
+
/**
|
|
3347
|
+
* App instance ID.
|
|
3348
|
+
* @format GUID
|
|
3349
|
+
*/
|
|
3350
|
+
instanceId?: string | null;
|
|
3351
|
+
/**
|
|
3352
|
+
* Event type.
|
|
3353
|
+
* @maxLength 150
|
|
3354
|
+
*/
|
|
3355
|
+
eventType?: string;
|
|
3356
|
+
/** The identification type and identity data. */
|
|
3357
|
+
identity?: IdentificationData;
|
|
3358
|
+
}
|
|
3359
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3360
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3361
|
+
_id?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3364
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3365
|
+
*/
|
|
3366
|
+
entityFqdn?: string;
|
|
3367
|
+
/**
|
|
3368
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3369
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3370
|
+
*/
|
|
3371
|
+
slug?: string;
|
|
3372
|
+
/** ID of the entity associated with the event. */
|
|
3373
|
+
entityId?: string;
|
|
3374
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3375
|
+
eventTime?: Date | null;
|
|
3376
|
+
/**
|
|
3377
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3378
|
+
* (for example, GDPR).
|
|
3379
|
+
*/
|
|
3380
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3381
|
+
/** If present, indicates the action that triggered the event. */
|
|
3382
|
+
originatedFrom?: string | null;
|
|
3383
|
+
/**
|
|
3384
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3385
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3386
|
+
*/
|
|
3387
|
+
entityEventSequence?: string | null;
|
|
3388
|
+
}
|
|
3389
|
+
interface ServiceCreatedEnvelope {
|
|
3390
|
+
entity: Service;
|
|
3391
|
+
metadata: EventMetadata;
|
|
3392
|
+
}
|
|
3393
|
+
interface ServiceDeletedEnvelope {
|
|
3394
|
+
entity: Service;
|
|
3395
|
+
metadata: EventMetadata;
|
|
3396
|
+
}
|
|
3397
|
+
interface ServiceUpdatedEnvelope {
|
|
3398
|
+
entity: Service;
|
|
3399
|
+
metadata: EventMetadata;
|
|
3400
|
+
}
|
|
3401
|
+
interface BulkCreateServicesOptions {
|
|
3402
|
+
/** Whether to return the created service objects. */
|
|
3403
|
+
returnEntity?: boolean;
|
|
3404
|
+
}
|
|
3405
|
+
interface UpdateService {
|
|
3406
|
+
/**
|
|
3407
|
+
* Service ID.
|
|
3408
|
+
* @format GUID
|
|
3409
|
+
* @readonly
|
|
3410
|
+
*/
|
|
3411
|
+
_id?: string | null;
|
|
3412
|
+
/**
|
|
3413
|
+
* Service type.
|
|
3414
|
+
* Learn more about *service types*
|
|
3415
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
|
|
3416
|
+
*/
|
|
3417
|
+
type?: ServiceTypeWithLiterals;
|
|
3418
|
+
/**
|
|
3419
|
+
* Order of the service within a *category*
|
|
3420
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
|
|
3421
|
+
*/
|
|
3422
|
+
sortOrder?: number | null;
|
|
3423
|
+
/**
|
|
3424
|
+
* Service name.
|
|
3425
|
+
* @maxLength 400
|
|
3426
|
+
* @minLength 1
|
|
3427
|
+
*/
|
|
3428
|
+
name?: string | null;
|
|
3429
|
+
/**
|
|
3430
|
+
* Service description. For example, `High-class hair styling, cuts, straightening and color`.
|
|
3431
|
+
* @maxLength 7000
|
|
3432
|
+
*/
|
|
3433
|
+
description?: string | null;
|
|
3434
|
+
/**
|
|
3435
|
+
* Short service description, such as `Hair styling`.
|
|
3436
|
+
* @maxLength 6000
|
|
3437
|
+
*/
|
|
3438
|
+
tagLine?: string | null;
|
|
3439
|
+
/**
|
|
3440
|
+
* Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.
|
|
3441
|
+
* @min 1
|
|
3442
|
+
* @max 1000
|
|
3443
|
+
*/
|
|
3444
|
+
defaultCapacity?: number | null;
|
|
3445
|
+
/** Media associated with the service. */
|
|
3446
|
+
media?: Media;
|
|
3447
|
+
/** Whether the service is hidden from the site. */
|
|
3448
|
+
hidden?: boolean | null;
|
|
3449
|
+
/**
|
|
3450
|
+
* _Category_
|
|
3451
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object))
|
|
3452
|
+
* the service is associated with.
|
|
3453
|
+
*/
|
|
3454
|
+
category?: V2Category;
|
|
3455
|
+
/** Form the customer filled out when booking the service. */
|
|
3456
|
+
form?: Form;
|
|
3457
|
+
/**
|
|
3458
|
+
* Payment options for booking the service.
|
|
3459
|
+
* Learn more about *service payments*
|
|
3460
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-payments) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments)).
|
|
3461
|
+
*/
|
|
3462
|
+
payment?: Payment;
|
|
3463
|
+
/** Online booking settings. */
|
|
3464
|
+
onlineBooking?: OnlineBooking;
|
|
3465
|
+
/** Conferencing options for the service. */
|
|
3466
|
+
conferencing?: Conferencing;
|
|
3467
|
+
/**
|
|
3468
|
+
* The locations this service is offered at. Read more about *service locations*
|
|
3469
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations)).
|
|
3470
|
+
* @immutable
|
|
3471
|
+
* @maxSize 500
|
|
3472
|
+
*/
|
|
3473
|
+
locations?: Location[];
|
|
3474
|
+
/**
|
|
3475
|
+
* _Policy_
|
|
3476
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction))
|
|
3477
|
+
* 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.
|
|
3478
|
+
*/
|
|
3479
|
+
bookingPolicy?: BookingPolicy;
|
|
3480
|
+
/**
|
|
3481
|
+
* The service's *schedule*
|
|
3482
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)),
|
|
3483
|
+
* which can be used to manage the service's *events*
|
|
3484
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
|
|
3485
|
+
*/
|
|
3486
|
+
schedule?: Schedule;
|
|
3487
|
+
/**
|
|
3488
|
+
* IDs of the *staff members*
|
|
3489
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
|
|
3490
|
+
* providing the service. Available only for appointment-based services.
|
|
3491
|
+
* @maxSize 220
|
|
3492
|
+
* @format GUID
|
|
3493
|
+
*/
|
|
3494
|
+
staffMemberIds?: string[];
|
|
3495
|
+
/**
|
|
3496
|
+
* Information about which resources must be available so customers can book the service.
|
|
3497
|
+
* For example, a meeting room or equipment.
|
|
3498
|
+
* @maxSize 3
|
|
3499
|
+
*/
|
|
3500
|
+
serviceResources?: ServiceResource[];
|
|
3501
|
+
/**
|
|
3502
|
+
* A slug is the last part of the URL address that serves as a unique identifier of the service.
|
|
3503
|
+
* The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
|
|
3504
|
+
* @readonly
|
|
3505
|
+
* @maxSize 100
|
|
3506
|
+
*/
|
|
3507
|
+
supportedSlugs?: Slug[];
|
|
3508
|
+
/**
|
|
3509
|
+
* Active slug for the service.
|
|
3510
|
+
* Learn more about *service slugs*
|
|
3511
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-slugs) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs)).
|
|
3512
|
+
* @readonly
|
|
3513
|
+
*/
|
|
3514
|
+
mainSlug?: Slug;
|
|
3515
|
+
/**
|
|
3516
|
+
* URLs to various service-related pages, such as the calendar page and the booking page.
|
|
3517
|
+
* @readonly
|
|
3518
|
+
*/
|
|
3519
|
+
urls?: URLs;
|
|
3520
|
+
/** Extensions enabling users to save custom data related to the service. */
|
|
3521
|
+
extendedFields?: ExtendedFields;
|
|
3522
|
+
/** Custom SEO data for the service. */
|
|
3523
|
+
seoData?: SeoSchema;
|
|
3524
|
+
/**
|
|
3525
|
+
* Date and time the service was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
3526
|
+
* @readonly
|
|
3527
|
+
*/
|
|
3528
|
+
_createdDate?: Date | null;
|
|
3529
|
+
/**
|
|
3530
|
+
* Date and time the service was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
3531
|
+
* @readonly
|
|
3532
|
+
*/
|
|
3533
|
+
_updatedDate?: Date | null;
|
|
3534
|
+
/**
|
|
3535
|
+
* Revision number, which increments by 1 each time the service is updated. To
|
|
3536
|
+
* prevent conflicting changes, the existing revision must be used when updating
|
|
3537
|
+
* a service.
|
|
3538
|
+
* @readonly
|
|
3539
|
+
*/
|
|
3540
|
+
revision?: string | null;
|
|
3541
|
+
}
|
|
3542
|
+
interface BulkUpdateServicesOptions {
|
|
3543
|
+
/**
|
|
3544
|
+
* Services to update.
|
|
3545
|
+
* @maxSize 100
|
|
3546
|
+
*/
|
|
3547
|
+
services?: MaskedService[];
|
|
3548
|
+
/** Whether to include the updated services in the response. Default: `false` */
|
|
3549
|
+
returnEntity?: boolean;
|
|
3550
|
+
}
|
|
3551
|
+
interface BulkUpdateServicesByFilterOptions {
|
|
3552
|
+
/** Service to update. */
|
|
3553
|
+
service: Service;
|
|
3554
|
+
}
|
|
3555
|
+
interface DeleteServiceOptions {
|
|
3556
|
+
/**
|
|
3557
|
+
* Whether to preserve future sessions with participants.
|
|
3558
|
+
*
|
|
3559
|
+
* Default: `false`
|
|
3560
|
+
*/
|
|
3561
|
+
preserveFutureSessionsWithParticipants?: boolean;
|
|
3562
|
+
/**
|
|
3563
|
+
* Whether to notify participants about the change and an optional
|
|
3564
|
+
* custom message.
|
|
3565
|
+
*/
|
|
3566
|
+
participantNotification?: ParticipantNotification;
|
|
3567
|
+
}
|
|
3568
|
+
interface BulkDeleteServicesOptions {
|
|
3569
|
+
/**
|
|
3570
|
+
* Whether to preserve future sessions with participants.
|
|
3571
|
+
*
|
|
3572
|
+
* Default: `false`.
|
|
3573
|
+
*/
|
|
3574
|
+
preserveFutureSessionsWithParticipants?: boolean;
|
|
3575
|
+
/**
|
|
3576
|
+
* Whether to notify participants about the change and an optional
|
|
3577
|
+
* custom message.
|
|
3578
|
+
*/
|
|
3579
|
+
participantNotification?: ParticipantNotification;
|
|
3580
|
+
}
|
|
3581
|
+
interface BulkDeleteServicesByFilterOptions {
|
|
3582
|
+
/**
|
|
3583
|
+
* Whether to preserve future sessions with participants.
|
|
3584
|
+
*
|
|
3585
|
+
* Default: `false`.
|
|
3586
|
+
*/
|
|
3587
|
+
preserveFutureSessionsWithParticipants?: boolean;
|
|
3588
|
+
/** Whether to notify participants about the change and an optional custom message. */
|
|
3589
|
+
participantNotification?: ParticipantNotification;
|
|
3590
|
+
}
|
|
3591
|
+
interface QueryServicesOptions {
|
|
3592
|
+
}
|
|
3593
|
+
interface QueryOffsetResult {
|
|
3594
|
+
currentPage: number | undefined;
|
|
3595
|
+
totalPages: number | undefined;
|
|
3596
|
+
totalCount: number | undefined;
|
|
3597
|
+
hasNext: () => boolean;
|
|
3598
|
+
hasPrev: () => boolean;
|
|
3599
|
+
length: number;
|
|
3600
|
+
pageSize: number;
|
|
3601
|
+
}
|
|
3602
|
+
interface ServicesQueryResult extends QueryOffsetResult {
|
|
3603
|
+
items: Service[];
|
|
3604
|
+
query: ServicesQueryBuilder;
|
|
3605
|
+
next: () => Promise<ServicesQueryResult>;
|
|
3606
|
+
prev: () => Promise<ServicesQueryResult>;
|
|
3607
|
+
}
|
|
3608
|
+
interface ServicesQueryBuilder {
|
|
3609
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3610
|
+
* @param value - Value to compare against.
|
|
3611
|
+
*/
|
|
3612
|
+
eq: (propertyName: '_id' | 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3613
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3614
|
+
* @param value - Value to compare against.
|
|
3615
|
+
*/
|
|
3616
|
+
ne: (propertyName: '_id' | 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3617
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3618
|
+
* @param value - Value to compare against.
|
|
3619
|
+
*/
|
|
3620
|
+
ge: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3621
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3622
|
+
* @param value - Value to compare against.
|
|
3623
|
+
*/
|
|
3624
|
+
gt: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3625
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3626
|
+
* @param value - Value to compare against.
|
|
3627
|
+
*/
|
|
3628
|
+
le: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3629
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3630
|
+
* @param value - Value to compare against.
|
|
3631
|
+
*/
|
|
3632
|
+
lt: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3633
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
3634
|
+
* @param string - String to compare against. Case-insensitive.
|
|
3635
|
+
*/
|
|
3636
|
+
startsWith: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'supportedSlugs.name' | 'mainSlug.name', value: string) => ServicesQueryBuilder;
|
|
3637
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
3638
|
+
* @param values - List of values to compare against.
|
|
3639
|
+
*/
|
|
3640
|
+
hasSome: (propertyName: '_id' | 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any[]) => ServicesQueryBuilder;
|
|
3641
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
3642
|
+
* @param values - List of values to compare against.
|
|
3643
|
+
*/
|
|
3644
|
+
hasAll: (propertyName: 'staffMemberIds', value: any[]) => ServicesQueryBuilder;
|
|
3645
|
+
in: (propertyName: '_id' | 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3646
|
+
exists: (propertyName: '_id' | 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: boolean) => ServicesQueryBuilder;
|
|
3647
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
3648
|
+
limit: (limit: number) => ServicesQueryBuilder;
|
|
3649
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
3650
|
+
skip: (skip: number) => ServicesQueryBuilder;
|
|
3651
|
+
find: () => Promise<ServicesQueryResult>;
|
|
3652
|
+
}
|
|
3653
|
+
interface ServiceSearchSpec extends SearchSpec {
|
|
3654
|
+
aggregatable: [
|
|
3655
|
+
'_id',
|
|
3656
|
+
'addOnDetails.addOnId',
|
|
3657
|
+
'addOnDetails.durationInMinutes',
|
|
3658
|
+
'appId',
|
|
3659
|
+
'category._id',
|
|
3660
|
+
'category.name',
|
|
3661
|
+
'category.sortOrder',
|
|
3662
|
+
'description',
|
|
3663
|
+
'form._id',
|
|
3664
|
+
'hidden',
|
|
3665
|
+
'locations.business._id',
|
|
3666
|
+
'locations.business.name',
|
|
3667
|
+
'locations.type',
|
|
3668
|
+
'mainSlug.name',
|
|
3669
|
+
'name',
|
|
3670
|
+
'onlineBooking.enabled',
|
|
3671
|
+
'payment.options.inPerson',
|
|
3672
|
+
'payment.options.online',
|
|
3673
|
+
'payment.options.pricingPlan',
|
|
3674
|
+
'staffMemberIds',
|
|
3675
|
+
'supportedSlugs.name',
|
|
3676
|
+
'tagLine',
|
|
3677
|
+
'type'
|
|
3678
|
+
];
|
|
3679
|
+
paging: 'cursor';
|
|
3680
|
+
wql: [
|
|
3681
|
+
{
|
|
3682
|
+
operators: ['$hasAll', '$hasSome'];
|
|
3683
|
+
fields: [
|
|
3684
|
+
'locations.business._id',
|
|
3685
|
+
'locations.business.name',
|
|
3686
|
+
'locations.calculatedAddress.formattedAddress',
|
|
3687
|
+
'locations.type',
|
|
3688
|
+
'staffMemberIds',
|
|
3689
|
+
'supportedSlugs.name'
|
|
3690
|
+
];
|
|
3691
|
+
sort: 'NONE';
|
|
3692
|
+
},
|
|
3693
|
+
{
|
|
3694
|
+
operators: '*';
|
|
3695
|
+
fields: [
|
|
3696
|
+
'_id',
|
|
3697
|
+
'addOnDetails.addOnId',
|
|
3698
|
+
'addOnDetails.durationInMinutes',
|
|
3699
|
+
'appId',
|
|
3700
|
+
'category._id',
|
|
3701
|
+
'category.name',
|
|
3702
|
+
'category.sortOrder',
|
|
3703
|
+
'description',
|
|
3704
|
+
'form._id',
|
|
3705
|
+
'hidden',
|
|
3706
|
+
'mainSlug.name',
|
|
3707
|
+
'name',
|
|
3708
|
+
'onlineBooking.enabled',
|
|
3709
|
+
'payment.options.inPerson',
|
|
3710
|
+
'payment.options.online',
|
|
3711
|
+
'payment.options.pricingPlan',
|
|
3712
|
+
'tagLine',
|
|
3713
|
+
'type'
|
|
3714
|
+
];
|
|
3715
|
+
sort: 'NONE';
|
|
3716
|
+
}
|
|
3717
|
+
];
|
|
3718
|
+
}
|
|
3719
|
+
type CommonSearchWithEntityContext = Search<Service, ServiceSearchSpec>;
|
|
3720
|
+
type ServiceSearch = {
|
|
3721
|
+
/**
|
|
3722
|
+
Cursor pointing to page of results.
|
|
3723
|
+
When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
3724
|
+
*/
|
|
3725
|
+
cursorPaging?: {
|
|
3726
|
+
/**
|
|
3727
|
+
Number of items to load.
|
|
3728
|
+
@max: 100
|
|
3729
|
+
*/
|
|
3730
|
+
limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
|
|
3731
|
+
/**
|
|
3732
|
+
Pointer to the next or previous page in the list of results.
|
|
3733
|
+
|
|
3734
|
+
You can get the relevant cursor token
|
|
3735
|
+
from the `pagingMetadata` object in the previous call's response.
|
|
3736
|
+
Not relevant for the first request.
|
|
3737
|
+
@maxLength: 16000
|
|
3738
|
+
*/
|
|
3739
|
+
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
3740
|
+
};
|
|
3741
|
+
/**
|
|
3742
|
+
A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
|
|
3743
|
+
*/
|
|
3744
|
+
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
3745
|
+
/**
|
|
3746
|
+
Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
3747
|
+
@maxSize: 10
|
|
3748
|
+
*/
|
|
3749
|
+
sort?: {
|
|
3750
|
+
/**
|
|
3751
|
+
Name of the field to sort by.
|
|
3752
|
+
@maxLength: 512
|
|
3753
|
+
*/
|
|
3754
|
+
fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
|
|
3755
|
+
/**
|
|
3756
|
+
Sort order.
|
|
3757
|
+
*/
|
|
3758
|
+
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
3759
|
+
}[];
|
|
3760
|
+
/**
|
|
3761
|
+
Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
|
|
3762
|
+
@maxSize: 10
|
|
3763
|
+
*/
|
|
3764
|
+
aggregations?: {
|
|
3765
|
+
/**
|
|
3766
|
+
Value aggregation
|
|
3767
|
+
*/
|
|
3768
|
+
value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
|
|
3769
|
+
/**
|
|
3770
|
+
Range aggregation
|
|
3771
|
+
*/
|
|
3772
|
+
range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
|
|
3773
|
+
/**
|
|
3774
|
+
Scalar aggregation
|
|
3775
|
+
*/
|
|
3776
|
+
scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
|
|
3777
|
+
/**
|
|
3778
|
+
Date histogram aggregation
|
|
3779
|
+
*/
|
|
3780
|
+
dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
|
|
3781
|
+
/**
|
|
3782
|
+
Nested aggregation
|
|
3783
|
+
*/
|
|
3784
|
+
nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
|
|
3785
|
+
/**
|
|
3786
|
+
User-defined name of aggregation, should be unique, will appear in aggregation results
|
|
3787
|
+
@maxLength: 100
|
|
3788
|
+
*/
|
|
3789
|
+
name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
|
|
3790
|
+
/**
|
|
3791
|
+
Type of aggregation, client must provide matching aggregation field below
|
|
3792
|
+
*/
|
|
3793
|
+
type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
|
|
3794
|
+
/**
|
|
3795
|
+
Field to aggregate by, use dot notation to specify json path
|
|
3796
|
+
@maxLength: 200
|
|
3797
|
+
*/
|
|
3798
|
+
fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
|
|
3799
|
+
/**
|
|
3800
|
+
deprecated, use `nested` instead
|
|
3801
|
+
@deprecated: deprecated, use `nested` instead,
|
|
3802
|
+
@replacedBy: kind.nested,
|
|
3803
|
+
@targetRemovalDate: 2025-01-01
|
|
3804
|
+
*/
|
|
3805
|
+
groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
|
|
3806
|
+
}[];
|
|
3807
|
+
/**
|
|
3808
|
+
Free text to match in searchable fields
|
|
3809
|
+
*/
|
|
3810
|
+
search?: {
|
|
3811
|
+
/**
|
|
3812
|
+
Boolean search mode
|
|
3813
|
+
*/
|
|
3814
|
+
mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
|
|
3815
|
+
/**
|
|
3816
|
+
Search term or expression
|
|
3817
|
+
@maxLength: 200
|
|
3818
|
+
*/
|
|
3819
|
+
expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
|
|
3820
|
+
/**
|
|
3821
|
+
Fields to search in. If empty - server will search in own default fields
|
|
3822
|
+
@maxSize: 10,
|
|
3823
|
+
@maxLength: 200
|
|
3824
|
+
*/
|
|
3825
|
+
fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
|
|
3826
|
+
/**
|
|
3827
|
+
Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
|
|
3828
|
+
*/
|
|
3829
|
+
fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
|
|
3830
|
+
};
|
|
3831
|
+
/**
|
|
3832
|
+
UTC offset or IANA time zone. Valid values are
|
|
3833
|
+
ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
3834
|
+
and IANA time zone IDs, such as Europe/Rome
|
|
3835
|
+
|
|
3836
|
+
Affects all filters and aggregations returned values.
|
|
3837
|
+
You may override this behavior in a specific filter by providing
|
|
3838
|
+
timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
3839
|
+
@maxLength: 50
|
|
3840
|
+
*/
|
|
3841
|
+
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
3842
|
+
};
|
|
3843
|
+
interface QueryBookingFormsOptions {
|
|
3844
|
+
/**
|
|
3845
|
+
* Conditional fields to return.
|
|
3846
|
+
* @maxSize 1
|
|
3847
|
+
*/
|
|
3848
|
+
conditionalFields?: RequestedFieldsWithLiterals[];
|
|
3849
|
+
}
|
|
3850
|
+
interface CountServicesOptions {
|
|
3851
|
+
/**
|
|
3852
|
+
* Query filter to base the count on. See supported filters
|
|
3853
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
3854
|
+
* for more details.
|
|
3855
|
+
*/
|
|
3856
|
+
filter?: Record<string, any> | null;
|
|
3857
|
+
}
|
|
3858
|
+
interface QueryLocationsOptions {
|
|
3859
|
+
/** Filter. */
|
|
3860
|
+
filter?: QueryLocationsFilter;
|
|
3861
|
+
}
|
|
3862
|
+
interface QueryCategoriesOptions {
|
|
3863
|
+
/** Filter. */
|
|
3864
|
+
filter?: QueryCategoriesFilter;
|
|
3865
|
+
}
|
|
3866
|
+
interface SetServiceLocationsOptions {
|
|
3867
|
+
/**
|
|
3868
|
+
* The action to perform on sessions currently set to a removed location. For
|
|
3869
|
+
* example, move existing sessions to a new specified location.
|
|
3870
|
+
* If not specified, sessions will not be moved to a new location.
|
|
3871
|
+
*/
|
|
3872
|
+
removedLocationSessionsAction?: RemovedLocationSessionsAction;
|
|
3873
|
+
/**
|
|
3874
|
+
* Whether to notify participants about the change of location, and an
|
|
3875
|
+
* Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
|
|
3876
|
+
*/
|
|
3877
|
+
participantNotification?: ParticipantNotification;
|
|
3878
|
+
}
|
|
3879
|
+
interface DisablePricingPlansForServiceOptions {
|
|
3880
|
+
/**
|
|
3881
|
+
* IDs of the *pricing plans*
|
|
3882
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
3883
|
+
* to remove from the service's `payment.pricingPlanIds` array.
|
|
3884
|
+
* @format GUID
|
|
3885
|
+
* @maxSize 75
|
|
3886
|
+
*/
|
|
3887
|
+
pricingPlanIds?: string[];
|
|
3888
|
+
}
|
|
3889
|
+
interface SetCustomSlugOptions {
|
|
3890
|
+
/**
|
|
3891
|
+
* Slug to set as the active service slug.
|
|
3892
|
+
* @maxLength 500
|
|
3893
|
+
*/
|
|
3894
|
+
slug?: string;
|
|
3895
|
+
}
|
|
3896
|
+
interface ValidateSlugOptions {
|
|
3897
|
+
/**
|
|
3898
|
+
* Custom slug to validate.
|
|
3899
|
+
* @maxLength 500
|
|
3900
|
+
*/
|
|
3901
|
+
slug?: string;
|
|
3902
|
+
}
|
|
3903
|
+
|
|
3904
|
+
export { AggregationType as $, type SetCustomSlugResponse as A, type BulkCreateServicesOptions as B, type CursorQuery as C, type DeleteServiceOptions as D, type EnablePricingPlansForServiceResponse as E, type ValidateSlugResponse as F, type CloneServiceResponse as G, type ServiceCreatedEnvelope as H, type ServiceDeletedEnvelope as I, type ServiceUpdatedEnvelope as J, ServiceType as K, type Location as L, LocationType as M, V2RequestedFields as N, SortOrder as O, SortType as P, type QueryServicesOptions as Q, RateType as R, type Service as S, SortDirection as T, type UpdateService as U, type ValidateSlugOptions as V, WebhookIdentityType as W, MissingValues as X, ScalarType as Y, NestedAggregationType as Z, Interval as _, type BulkCreateServicesResponse as a, type ExtendedFields as a$, Mode as a0, RequestedFields as a1, Action as a2, InvalidSlugError as a3, CloneErrors as a4, Status as a5, CategoryNotificationEvent as a6, BenefitType as a7, Event as a8, CrudType as a9, type PolicyDescription as aA, type LimitEarlyBookingPolicy as aB, type LimitLateBookingPolicy as aC, type BookAfterStartPolicy as aD, type CancellationPolicy as aE, type ReschedulePolicy as aF, type WaitlistPolicy as aG, type ParticipantsPolicy as aH, type ResourcesPolicy as aI, type CancellationFeePolicy as aJ, type CancellationWindow as aK, type CancellationWindowFeeOneOf as aL, type SaveCreditCardPolicy as aM, type Schedule as aN, type AvailabilityConstraints as aO, type Duration as aP, type StaffMember as aQ, type StaffMediaItem as aR, type StaffMediaItemItemOneOf as aS, type StaffMemberDetails as aT, type ResourceGroup as aU, type ResourceIds as aV, type ServiceResource as aW, type ServiceResourceSelectionOneOf as aX, type ResourceType as aY, type Slug as aZ, type URLs as a_, PlacementType as aa, DayOfWeek as ab, ResolutionMethod as ac, type Media as ad, type MediaItem as ae, type MediaItemItemOneOf as af, type V2Category as ag, type Form as ah, type FormSettings as ai, type Payment as aj, type PaymentRateOneOf as ak, type FixedPayment as al, type Money as am, type CustomPayment as an, type VariedPayment as ao, type PaymentOptions as ap, type OnlineBooking as aq, type Conferencing as ar, type LocationOptionsOneOf as as, type CommonAddress as at, type CommonAddressStreetOneOf as au, type StreetAddress as av, type AddressLocation as aw, type BusinessLocationOptions as ax, type CustomLocationOptions as ay, type BookingPolicy as az, type BulkUpdateServicesOptions as b, type BulkDeleteServicesRequest as b$, type SeoSchema as b0, type Keyword as b1, type Tag as b2, type Settings as b3, type AddOnGroup as b4, type AddOnDetails as b5, type ReindexMessage as b6, type ReindexMessageActionOneOf as b7, type Upsert as b8, type Delete as b9, type ValidateAddOnsSelectionRequest as bA, type ValidateAddOnsSelectionResponse as bB, type ValidationResult as bC, type CreateServiceRequest as bD, type CreateServiceResponse as bE, type ValidateServiceRequest as bF, type ValidateServiceResponse as bG, type FieldViolation as bH, type BulkCreateServicesRequest as bI, type BulkServiceResult as bJ, type ItemMetadata as bK, type ApplicationError as bL, type BulkActionMetadata as bM, type GetServiceRequest as bN, type GetServiceResponse as bO, type GetServiceAvailabilityConstraintsRequest as bP, type GetServiceAvailabilityConstraintsResponse as bQ, type ServiceAvailabilityConstraints as bR, type SplitInterval as bS, type UpdateServiceRequest as bT, type UpdateServiceResponse as bU, type BulkUpdateServicesRequest as bV, type MaskedService as bW, type BulkUpdateServicesByFilterRequest as bX, type DeleteServiceRequest as bY, type ParticipantNotification as bZ, type DeleteServiceResponse as b_, type Schema as ba, type SetCustomSlugEvent as bb, type ServicesUrlsChanged as bc, type DomainEvent as bd, type DomainEventBodyOneOf as be, type EntityCreatedEvent as bf, type RestoreInfo as bg, type EntityUpdatedEvent as bh, type EntityDeletedEvent as bi, type ActionEvent as bj, type MessageEnvelope as bk, type IdentificationData as bl, type IdentificationDataIdOneOf as bm, type CreateAddOnGroupRequest as bn, type CreateAddOnGroupResponse as bo, type DeleteAddOnGroupRequest as bp, type DeleteAddOnGroupResponse as bq, type UpdateAddOnGroupRequest as br, type UpdateAddOnGroupResponse as bs, type ListAddOnGroupsByServiceIdRequest as bt, type ListAddOnGroupsByServiceIdResponse as bu, type AddOn as bv, type AddOnAddOnInfoOneOf as bw, type AddOnGroupDetail as bx, type SetAddOnsForGroupRequest as by, type SetAddOnsForGroupResponse as bz, type BulkUpdateServicesResponse as c, type QueryCategoriesRequest as c$, type BulkDeleteServicesByFilterRequest as c0, type QueryServicesRequest as c1, type QueryV2 as c2, type QueryV2PagingMethodOneOf as c3, type Sorting as c4, type Paging as c5, type CursorPaging as c6, type QueryServicesResponse as c7, type PagingMetadataV2 as c8, type Cursors as c9, type AggregationResultsScalarResult as cA, type NestedValueAggregationResult as cB, type ValueResult as cC, type RangeResult as cD, type ScalarResult as cE, type NestedResultValue as cF, type NestedResultValueResultOneOf as cG, type Results as cH, type DateHistogramResult as cI, type GroupByValueResults as cJ, type DateHistogramResults as cK, type NestedResults as cL, type AggregationResults as cM, type AggregationResultsResultOneOf as cN, type QueryPoliciesRequest as cO, type CursorQueryPagingMethodOneOf as cP, type BookingPolicyWithServices as cQ, type QueryBookingFormsRequest as cR, type BookingForm as cS, type FormDetails as cT, type ConnectedService as cU, type CountServicesRequest as cV, type QueryLocationsRequest as cW, type QueryLocationsFilter as cX, type BusinessLocations as cY, type CustomLocations as cZ, type CustomerLocations as c_, type SearchServicesRequest as ca, type CursorSearch as cb, type CursorSearchPagingMethodOneOf as cc, type Aggregation as cd, type AggregationKindOneOf as ce, type RangeBucket as cf, type IncludeMissingValuesOptions as cg, type ValueAggregation as ch, type ValueAggregationOptionsOneOf as ci, type RangeAggregation as cj, type ScalarAggregation as ck, type DateHistogramAggregation as cl, type NestedAggregationItem as cm, type NestedAggregationItemKindOneOf as cn, type NestedAggregation as co, type GroupByAggregation as cp, type GroupByAggregationKindOneOf as cq, type SearchDetails as cr, type CursorPagingMetadata as cs, type AggregationData as ct, type ValueAggregationResult as cu, type RangeAggregationResult as cv, type NestedAggregationResults as cw, type NestedAggregationResultsResultOneOf as cx, type ValueResults as cy, type RangeResults as cz, type BulkUpdateServicesByFilterOptions as d, type QueryCategoriesFilter as d0, type QueryServicesMultiLanguageRequest as d1, type QueryServicesMultiLanguageResponse as d2, type SetServiceLocationsRequest as d3, type RemovedLocationSessionsAction as d4, type RemovedLocationSessionsActionActionOptionsOneOf as d5, type MoveToNewLocationsOptions as d6, type EnablePricingPlansForServiceRequest as d7, type InvalidPricingPlan as d8, type DisablePricingPlansForServiceRequest as d9, type TimePeriod as dA, type SpecialHourPeriod as dB, type Multilingual as dC, type SupportedLanguage as dD, type ConsentPolicy as dE, type Translation as dF, type ChangeContext as dG, type ChangeContextPayloadOneOf as dH, type PropertiesChange as dI, type SiteCreated as dJ, type SiteCloned as dK, type BaseEventMetadata as dL, type EventMetadata as dM, type ServicesQueryResult as dN, type ServiceSearchSpec as dO, type SetCustomSlugRequest as da, type ValidateSlugRequest as db, type CloneServiceRequest as dc, type CategoryNotification as dd, type Category as de, type Empty as df, type BenefitNotification as dg, type Benefit as dh, type EntryPass as di, type Discount as dj, type DiscountDiscountOneOf as dk, type Behavior as dl, type BehaviorBehaviorOneOf as dm, type UserDomainInfoChangedEvent as dn, type HtmlSitePublished as dp, type Page as dq, type SitePropertiesNotification as dr, type SitePropertiesEvent as ds, type Properties as dt, type Categories as du, type Locale as dv, type Address as dw, type AddressHint as dx, type GeoCoordinates as dy, type BusinessSchedule as dz, type BulkUpdateServicesByFilterResponse as e, type BulkDeleteServicesOptions as f, type BulkDeleteServicesResponse as g, type BulkDeleteServicesByFilterOptions as h, type BulkDeleteServicesByFilterResponse as i, type ServicesQueryBuilder as j, type ServiceSearch as k, type SearchServicesResponse as l, type QueryPoliciesResponse as m, type QueryBookingFormsOptions as n, type QueryBookingFormsResponse as o, type CountServicesOptions as p, type CountServicesResponse as q, type QueryLocationsOptions as r, type QueryLocationsResponse as s, type QueryCategoriesOptions as t, type QueryCategoriesResponse as u, type SetServiceLocationsOptions as v, type SetServiceLocationsResponse as w, type DisablePricingPlansForServiceOptions as x, type DisablePricingPlansForServiceResponse as y, type SetCustomSlugOptions as z };
|