@wix/auto_sdk_bookings_booking-policies 1.0.30 → 1.0.32
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/{internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.mts} +131 -435
- package/build/{cjs/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.ts} +131 -435
- package/build/index.d.mts +146 -0
- package/build/index.d.ts +146 -0
- package/build/index.js +794 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +750 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.mts} +131 -435
- package/build/{es/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → internal/bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.ts} +131 -435
- package/build/internal/index.d.mts +146 -0
- package/build/internal/index.d.ts +146 -0
- package/build/internal/index.js +794 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +750 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +545 -0
- package/build/internal/meta.d.ts +545 -0
- package/build/internal/meta.js +448 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +414 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +545 -0
- package/build/meta.d.ts +545 -0
- package/build/meta.js +448 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +414 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.js +0 -49
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.js +0 -330
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -180
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.js +0 -110
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1436
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.js +0 -155
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -594
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.js +0 -37
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.js +0 -319
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -146
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.js +0 -90
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1436
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.js +0 -152
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -560
- package/build/es/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.js +0 -49
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.js +0 -330
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -180
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.js +0 -110
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1436
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.js +0 -155
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -594
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.js +0 -37
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.js +0 -319
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -146
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.js +0 -90
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1436
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.js +0 -152
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -560
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A booking policy is a set of rules that determine how customers can book a
|
|
4
3
|
* service, including timeframes for booking, canceling, or rescheduling.
|
|
5
4
|
*/
|
|
6
|
-
|
|
5
|
+
interface BookingPolicy {
|
|
7
6
|
/**
|
|
8
7
|
* ID of the booking policy.
|
|
9
8
|
* @format GUID
|
|
@@ -70,7 +69,7 @@ export interface BookingPolicy {
|
|
|
70
69
|
extendedFields?: ExtendedFields;
|
|
71
70
|
}
|
|
72
71
|
/** A description of the booking policy to display to participants. */
|
|
73
|
-
|
|
72
|
+
interface PolicyDescription {
|
|
74
73
|
/**
|
|
75
74
|
* Whether the description is displayed to the participant. `true` means the
|
|
76
75
|
* description is displayed.
|
|
@@ -88,7 +87,7 @@ export interface PolicyDescription {
|
|
|
88
87
|
description?: string;
|
|
89
88
|
}
|
|
90
89
|
/** The rule for limiting early bookings. */
|
|
91
|
-
|
|
90
|
+
interface LimitEarlyBookingPolicy {
|
|
92
91
|
/**
|
|
93
92
|
* Whether there's a limit about how early a customer can book. `false` means there's
|
|
94
93
|
* no limit to the earliest supported booking time.
|
|
@@ -111,7 +110,7 @@ export interface LimitEarlyBookingPolicy {
|
|
|
111
110
|
*
|
|
112
111
|
* This rule and `bookAfterStartPolicy` can't be both enabled at the same time.
|
|
113
112
|
*/
|
|
114
|
-
|
|
113
|
+
interface LimitLateBookingPolicy {
|
|
115
114
|
/**
|
|
116
115
|
* Whether there's a limit about how late customers can book. `false` means
|
|
117
116
|
* customers can book up to the last minute. If specified as `true`,
|
|
@@ -137,7 +136,7 @@ export interface LimitLateBookingPolicy {
|
|
|
137
136
|
* This rule and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this rule
|
|
138
137
|
* is enabled, the `LimitLateBookingPolicy` rule must be disabled.
|
|
139
138
|
*/
|
|
140
|
-
|
|
139
|
+
interface BookAfterStartPolicy {
|
|
141
140
|
/**
|
|
142
141
|
* Whether customers can book after the session has started. `true` means
|
|
143
142
|
* customers can book after the session has started. For courses, this refers to
|
|
@@ -149,7 +148,7 @@ export interface BookAfterStartPolicy {
|
|
|
149
148
|
enabled?: boolean;
|
|
150
149
|
}
|
|
151
150
|
/** The rule for canceling a booked session. */
|
|
152
|
-
|
|
151
|
+
interface CancellationPolicy {
|
|
153
152
|
/**
|
|
154
153
|
* Whether customers can cancel the booking. `true` means customers can cancel
|
|
155
154
|
* the booking.
|
|
@@ -175,7 +174,7 @@ export interface CancellationPolicy {
|
|
|
175
174
|
latestCancellationInMinutes?: number;
|
|
176
175
|
}
|
|
177
176
|
/** The rule for rescheduling a booked session. */
|
|
178
|
-
|
|
177
|
+
interface ReschedulePolicy {
|
|
179
178
|
/**
|
|
180
179
|
* Whether customers can reschedule a booking for an appointment-based service.
|
|
181
180
|
* `true` means customers can reschedule.
|
|
@@ -201,7 +200,7 @@ export interface ReschedulePolicy {
|
|
|
201
200
|
latestRescheduleInMinutes?: number;
|
|
202
201
|
}
|
|
203
202
|
/** The rule for the waitlist. */
|
|
204
|
-
|
|
203
|
+
interface WaitlistPolicy {
|
|
205
204
|
/**
|
|
206
205
|
* Whether the service has a waitlist. `true` means there's a waitlist.
|
|
207
206
|
*
|
|
@@ -228,7 +227,7 @@ export interface WaitlistPolicy {
|
|
|
228
227
|
reservationTimeInMinutes?: number;
|
|
229
228
|
}
|
|
230
229
|
/** The rule for the maximum number of participants per booking. */
|
|
231
|
-
|
|
230
|
+
interface ParticipantsPolicy {
|
|
232
231
|
/**
|
|
233
232
|
* Maximum number of participants per booking.
|
|
234
233
|
*
|
|
@@ -239,7 +238,7 @@ export interface ParticipantsPolicy {
|
|
|
239
238
|
maxParticipantsPerBooking?: number;
|
|
240
239
|
}
|
|
241
240
|
/** The rule regarding the allocation of resources (e.g. staff members). */
|
|
242
|
-
|
|
241
|
+
interface ResourcesPolicy {
|
|
243
242
|
/**
|
|
244
243
|
* Whether the customer must select a resource, for example a staff member, when
|
|
245
244
|
* booking. `false` means the customer can book without selecting a resource.
|
|
@@ -257,7 +256,7 @@ export interface ResourcesPolicy {
|
|
|
257
256
|
*/
|
|
258
257
|
autoAssignAllowed?: boolean;
|
|
259
258
|
}
|
|
260
|
-
|
|
259
|
+
interface CancellationFeePolicy {
|
|
261
260
|
/**
|
|
262
261
|
* Whether customers must pay a cancellation fee when canceling a booking.
|
|
263
262
|
*
|
|
@@ -282,7 +281,7 @@ export interface CancellationFeePolicy {
|
|
|
282
281
|
* Money.
|
|
283
282
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
284
283
|
*/
|
|
285
|
-
|
|
284
|
+
interface Money {
|
|
286
285
|
/**
|
|
287
286
|
* 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.
|
|
288
287
|
* @format DECIMAL_VALUE
|
|
@@ -301,7 +300,7 @@ export interface Money {
|
|
|
301
300
|
*/
|
|
302
301
|
formattedValue?: string | null;
|
|
303
302
|
}
|
|
304
|
-
|
|
303
|
+
interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
305
304
|
/** Fixed amount customers must pay when canceling the booking within this window. */
|
|
306
305
|
amount?: Money;
|
|
307
306
|
/**
|
|
@@ -321,7 +320,7 @@ export interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
|
321
320
|
startInMinutes?: number | null;
|
|
322
321
|
}
|
|
323
322
|
/** @oneof */
|
|
324
|
-
|
|
323
|
+
interface CancellationWindowFeeOneOf {
|
|
325
324
|
/** Fixed amount customers must pay when canceling the booking within this window. */
|
|
326
325
|
amount?: Money;
|
|
327
326
|
/**
|
|
@@ -334,7 +333,7 @@ export interface CancellationWindowFeeOneOf {
|
|
|
334
333
|
*/
|
|
335
334
|
percentage?: string;
|
|
336
335
|
}
|
|
337
|
-
|
|
336
|
+
interface SaveCreditCardPolicy {
|
|
338
337
|
/**
|
|
339
338
|
* Whether Wix stores credit card details of the customer. Storing the details
|
|
340
339
|
* allows Wix to prefill the *eCommerce checkout*
|
|
@@ -346,7 +345,7 @@ export interface SaveCreditCardPolicy {
|
|
|
346
345
|
*/
|
|
347
346
|
enabled?: boolean;
|
|
348
347
|
}
|
|
349
|
-
|
|
348
|
+
interface ExtendedFields {
|
|
350
349
|
/**
|
|
351
350
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
352
351
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -358,7 +357,7 @@ export interface ExtendedFields {
|
|
|
358
357
|
namespaces?: Record<string, Record<string, any>>;
|
|
359
358
|
}
|
|
360
359
|
/** This event is triggered when a different booking policy has been set as the default policy. */
|
|
361
|
-
|
|
360
|
+
interface DefaultBookingPolicySet {
|
|
362
361
|
/** The new default booking policy. */
|
|
363
362
|
currentDefaultBookingPolicy?: BookingPolicy;
|
|
364
363
|
/**
|
|
@@ -367,26 +366,26 @@ export interface DefaultBookingPolicySet {
|
|
|
367
366
|
*/
|
|
368
367
|
previousDefaultBookingPolicy?: BookingPolicy;
|
|
369
368
|
}
|
|
370
|
-
|
|
369
|
+
interface CreateBookingPolicyRequest {
|
|
371
370
|
/** Booking policy to create. */
|
|
372
371
|
bookingPolicy: BookingPolicy;
|
|
373
372
|
}
|
|
374
|
-
|
|
373
|
+
interface CreateBookingPolicyResponse {
|
|
375
374
|
/** Created booking policy. */
|
|
376
375
|
bookingPolicy?: BookingPolicy;
|
|
377
376
|
}
|
|
378
|
-
|
|
377
|
+
interface GetBookingPolicyRequest {
|
|
379
378
|
/**
|
|
380
379
|
* ID of the booking policy to retrieve.
|
|
381
380
|
* @format GUID
|
|
382
381
|
*/
|
|
383
382
|
bookingPolicyId: string;
|
|
384
383
|
}
|
|
385
|
-
|
|
384
|
+
interface GetBookingPolicyResponse {
|
|
386
385
|
/** Retrieved booking policy. */
|
|
387
386
|
bookingPolicy?: BookingPolicy;
|
|
388
387
|
}
|
|
389
|
-
|
|
388
|
+
interface GetStrictestBookingPolicyRequest {
|
|
390
389
|
/**
|
|
391
390
|
* IDs of the booking policies for which to retrieve the strictest rules for.
|
|
392
391
|
* @format GUID
|
|
@@ -394,7 +393,7 @@ export interface GetStrictestBookingPolicyRequest {
|
|
|
394
393
|
*/
|
|
395
394
|
bookingPolicyIds: string[];
|
|
396
395
|
}
|
|
397
|
-
|
|
396
|
+
interface GetStrictestBookingPolicyResponse {
|
|
398
397
|
/**
|
|
399
398
|
* Hypothetical `bookingPolicy` object that combines the strictest version of
|
|
400
399
|
* each rule. `bookingPolicy.id` is `null` and the returned object isn't actually
|
|
@@ -403,22 +402,22 @@ export interface GetStrictestBookingPolicyResponse {
|
|
|
403
402
|
*/
|
|
404
403
|
bookingPolicy?: BookingPolicy;
|
|
405
404
|
}
|
|
406
|
-
|
|
405
|
+
interface UpdateBookingPolicyRequest {
|
|
407
406
|
/** Booking policy to update. */
|
|
408
407
|
bookingPolicy: BookingPolicy;
|
|
409
408
|
}
|
|
410
|
-
|
|
409
|
+
interface UpdateBookingPolicyResponse {
|
|
411
410
|
/** Updated booking policy. */
|
|
412
411
|
bookingPolicy?: BookingPolicy;
|
|
413
412
|
}
|
|
414
|
-
|
|
413
|
+
interface SetDefaultBookingPolicyRequest {
|
|
415
414
|
/**
|
|
416
415
|
* ID of the booking policy that's set as default.
|
|
417
416
|
* @format GUID
|
|
418
417
|
*/
|
|
419
418
|
bookingPolicyId: string;
|
|
420
419
|
}
|
|
421
|
-
|
|
420
|
+
interface SetDefaultBookingPolicyResponse {
|
|
422
421
|
/** New default booking policy. */
|
|
423
422
|
currentDefaultBookingPolicy?: BookingPolicy;
|
|
424
423
|
/**
|
|
@@ -427,16 +426,16 @@ export interface SetDefaultBookingPolicyResponse {
|
|
|
427
426
|
*/
|
|
428
427
|
previousDefaultBookingPolicy?: BookingPolicy;
|
|
429
428
|
}
|
|
430
|
-
|
|
429
|
+
interface DeleteBookingPolicyRequest {
|
|
431
430
|
/**
|
|
432
431
|
* ID of the booking policy to delete.
|
|
433
432
|
* @format GUID
|
|
434
433
|
*/
|
|
435
434
|
bookingPolicyId: string;
|
|
436
435
|
}
|
|
437
|
-
|
|
436
|
+
interface DeleteBookingPolicyResponse {
|
|
438
437
|
}
|
|
439
|
-
|
|
438
|
+
interface QueryBookingPoliciesRequest {
|
|
440
439
|
/**
|
|
441
440
|
* The query by which to select booking policies. See
|
|
442
441
|
* [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)
|
|
@@ -444,7 +443,7 @@ export interface QueryBookingPoliciesRequest {
|
|
|
444
443
|
*/
|
|
445
444
|
query: CursorQuery;
|
|
446
445
|
}
|
|
447
|
-
|
|
446
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
448
447
|
/** 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`. */
|
|
449
448
|
cursorPaging?: CursorPaging;
|
|
450
449
|
/**
|
|
@@ -464,11 +463,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
464
463
|
sort?: Sorting[];
|
|
465
464
|
}
|
|
466
465
|
/** @oneof */
|
|
467
|
-
|
|
466
|
+
interface CursorQueryPagingMethodOneOf {
|
|
468
467
|
/** 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`. */
|
|
469
468
|
cursorPaging?: CursorPaging;
|
|
470
469
|
}
|
|
471
|
-
|
|
470
|
+
interface Sorting {
|
|
472
471
|
/**
|
|
473
472
|
* Name of the field to sort by.
|
|
474
473
|
* @maxLength 512
|
|
@@ -477,13 +476,13 @@ export interface Sorting {
|
|
|
477
476
|
/** Sort order. */
|
|
478
477
|
order?: SortOrderWithLiterals;
|
|
479
478
|
}
|
|
480
|
-
|
|
479
|
+
declare enum SortOrder {
|
|
481
480
|
ASC = "ASC",
|
|
482
481
|
DESC = "DESC"
|
|
483
482
|
}
|
|
484
483
|
/** @enumType */
|
|
485
|
-
|
|
486
|
-
|
|
484
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
485
|
+
interface CursorPaging {
|
|
487
486
|
/**
|
|
488
487
|
* Number of items to load.
|
|
489
488
|
* @max 100
|
|
@@ -499,13 +498,13 @@ export interface CursorPaging {
|
|
|
499
498
|
*/
|
|
500
499
|
cursor?: string | null;
|
|
501
500
|
}
|
|
502
|
-
|
|
501
|
+
interface QueryBookingPoliciesResponse {
|
|
503
502
|
/** Retrieved booking policies. */
|
|
504
503
|
bookingPolicies?: BookingPolicy[];
|
|
505
504
|
/** Paging metadata. */
|
|
506
505
|
pagingMetadata?: CursorPagingMetadata;
|
|
507
506
|
}
|
|
508
|
-
|
|
507
|
+
interface CursorPagingMetadata {
|
|
509
508
|
/** Number of items returned in the response. */
|
|
510
509
|
count?: number | null;
|
|
511
510
|
/** Offset that was requested. */
|
|
@@ -517,7 +516,7 @@ export interface CursorPagingMetadata {
|
|
|
517
516
|
*/
|
|
518
517
|
hasNext?: boolean | null;
|
|
519
518
|
}
|
|
520
|
-
|
|
519
|
+
interface Cursors {
|
|
521
520
|
/**
|
|
522
521
|
* Cursor pointing to next page in the list of results.
|
|
523
522
|
* @maxLength 16000
|
|
@@ -529,7 +528,7 @@ export interface Cursors {
|
|
|
529
528
|
*/
|
|
530
529
|
prev?: string | null;
|
|
531
530
|
}
|
|
532
|
-
|
|
531
|
+
interface CountBookingPoliciesRequest {
|
|
533
532
|
/**
|
|
534
533
|
* Filter to base the count on. See
|
|
535
534
|
* supported filters*
|
|
@@ -538,25 +537,25 @@ export interface CountBookingPoliciesRequest {
|
|
|
538
537
|
*/
|
|
539
538
|
filter?: Record<string, any> | null;
|
|
540
539
|
}
|
|
541
|
-
|
|
540
|
+
interface CountBookingPoliciesResponse {
|
|
542
541
|
/** Number of booking policies matching the provided filter. */
|
|
543
542
|
count?: number;
|
|
544
543
|
}
|
|
545
|
-
|
|
544
|
+
interface UpdateAllPoliciesRequest {
|
|
546
545
|
/** Fields to set to all booking policies. */
|
|
547
546
|
bookingPolicy?: BookingPolicy;
|
|
548
547
|
}
|
|
549
|
-
|
|
548
|
+
interface UpdateAllPoliciesResponse {
|
|
550
549
|
}
|
|
551
|
-
|
|
550
|
+
interface CreateMissingDefaultPolicyRequest {
|
|
552
551
|
}
|
|
553
|
-
|
|
552
|
+
interface CreateMissingDefaultPolicyResponse {
|
|
554
553
|
/** The default booking policy. */
|
|
555
554
|
defaultBookingPolicy?: BookingPolicy;
|
|
556
555
|
/** Whether a new default policy was created. */
|
|
557
556
|
wasANewPolicyCreated?: boolean;
|
|
558
557
|
}
|
|
559
|
-
|
|
558
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
560
559
|
createdEvent?: EntityCreatedEvent;
|
|
561
560
|
updatedEvent?: EntityUpdatedEvent;
|
|
562
561
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -591,19 +590,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
591
590
|
entityEventSequence?: string | null;
|
|
592
591
|
}
|
|
593
592
|
/** @oneof */
|
|
594
|
-
|
|
593
|
+
interface DomainEventBodyOneOf {
|
|
595
594
|
createdEvent?: EntityCreatedEvent;
|
|
596
595
|
updatedEvent?: EntityUpdatedEvent;
|
|
597
596
|
deletedEvent?: EntityDeletedEvent;
|
|
598
597
|
actionEvent?: ActionEvent;
|
|
599
598
|
}
|
|
600
|
-
|
|
599
|
+
interface EntityCreatedEvent {
|
|
601
600
|
entity?: string;
|
|
602
601
|
}
|
|
603
|
-
|
|
602
|
+
interface RestoreInfo {
|
|
604
603
|
deletedDate?: Date | null;
|
|
605
604
|
}
|
|
606
|
-
|
|
605
|
+
interface EntityUpdatedEvent {
|
|
607
606
|
/**
|
|
608
607
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
609
608
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -611,17 +610,17 @@ export interface EntityUpdatedEvent {
|
|
|
611
610
|
*/
|
|
612
611
|
currentEntity?: string;
|
|
613
612
|
}
|
|
614
|
-
|
|
613
|
+
interface EntityDeletedEvent {
|
|
615
614
|
/** Entity that was deleted. */
|
|
616
615
|
deletedEntity?: string | null;
|
|
617
616
|
}
|
|
618
|
-
|
|
617
|
+
interface ActionEvent {
|
|
619
618
|
body?: string;
|
|
620
619
|
}
|
|
621
|
-
|
|
620
|
+
interface Empty {
|
|
622
621
|
}
|
|
623
622
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
624
|
-
|
|
623
|
+
interface SitePropertiesNotification {
|
|
625
624
|
/** The site ID for which this update notification applies. */
|
|
626
625
|
metasiteId?: string;
|
|
627
626
|
/** The actual update event. */
|
|
@@ -635,7 +634,7 @@ export interface SitePropertiesNotification {
|
|
|
635
634
|
changeContext?: ChangeContext;
|
|
636
635
|
}
|
|
637
636
|
/** The actual update event for a particular notification. */
|
|
638
|
-
|
|
637
|
+
interface SitePropertiesEvent {
|
|
639
638
|
/** Version of the site's properties represented by this update. */
|
|
640
639
|
version?: number;
|
|
641
640
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -643,7 +642,7 @@ export interface SitePropertiesEvent {
|
|
|
643
642
|
/** Updated properties. */
|
|
644
643
|
properties?: Properties;
|
|
645
644
|
}
|
|
646
|
-
|
|
645
|
+
interface Properties {
|
|
647
646
|
/** Site categories. */
|
|
648
647
|
categories?: Categories;
|
|
649
648
|
/** Site locale. */
|
|
@@ -699,7 +698,7 @@ export interface Properties {
|
|
|
699
698
|
/** Track clicks analytics. */
|
|
700
699
|
trackClicksAnalytics?: boolean;
|
|
701
700
|
}
|
|
702
|
-
|
|
701
|
+
interface Categories {
|
|
703
702
|
/** Primary site category. */
|
|
704
703
|
primary?: string;
|
|
705
704
|
/**
|
|
@@ -710,13 +709,13 @@ export interface Categories {
|
|
|
710
709
|
/** Business Term Id */
|
|
711
710
|
businessTermId?: string | null;
|
|
712
711
|
}
|
|
713
|
-
|
|
712
|
+
interface Locale {
|
|
714
713
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
715
714
|
languageCode?: string;
|
|
716
715
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
717
716
|
country?: string;
|
|
718
717
|
}
|
|
719
|
-
|
|
718
|
+
interface Address {
|
|
720
719
|
/** Street name. */
|
|
721
720
|
street?: string;
|
|
722
721
|
/** City name. */
|
|
@@ -748,29 +747,29 @@ export interface Address {
|
|
|
748
747
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
749
748
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
750
749
|
*/
|
|
751
|
-
|
|
750
|
+
interface AddressHint {
|
|
752
751
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
753
752
|
text?: string;
|
|
754
753
|
/** Where the extra text should be displayed. */
|
|
755
754
|
placement?: PlacementTypeWithLiterals;
|
|
756
755
|
}
|
|
757
756
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
758
|
-
|
|
757
|
+
declare enum PlacementType {
|
|
759
758
|
BEFORE = "BEFORE",
|
|
760
759
|
AFTER = "AFTER",
|
|
761
760
|
REPLACE = "REPLACE"
|
|
762
761
|
}
|
|
763
762
|
/** @enumType */
|
|
764
|
-
|
|
763
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
765
764
|
/** Geocoordinates for a particular address. */
|
|
766
|
-
|
|
765
|
+
interface GeoCoordinates {
|
|
767
766
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
768
767
|
latitude?: number;
|
|
769
768
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
770
769
|
longitude?: number;
|
|
771
770
|
}
|
|
772
771
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
773
|
-
|
|
772
|
+
interface BusinessSchedule {
|
|
774
773
|
/**
|
|
775
774
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
776
775
|
* @maxSize 100
|
|
@@ -783,7 +782,7 @@ export interface BusinessSchedule {
|
|
|
783
782
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
784
783
|
}
|
|
785
784
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
786
|
-
|
|
785
|
+
interface TimePeriod {
|
|
787
786
|
/** Day of the week the period starts on. */
|
|
788
787
|
openDay?: DayOfWeekWithLiterals;
|
|
789
788
|
/**
|
|
@@ -802,7 +801,7 @@ export interface TimePeriod {
|
|
|
802
801
|
closeTime?: string;
|
|
803
802
|
}
|
|
804
803
|
/** Enumerates the days of the week. */
|
|
805
|
-
|
|
804
|
+
declare enum DayOfWeek {
|
|
806
805
|
MONDAY = "MONDAY",
|
|
807
806
|
TUESDAY = "TUESDAY",
|
|
808
807
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -812,9 +811,9 @@ export declare enum DayOfWeek {
|
|
|
812
811
|
SUNDAY = "SUNDAY"
|
|
813
812
|
}
|
|
814
813
|
/** @enumType */
|
|
815
|
-
|
|
814
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
816
815
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
817
|
-
|
|
816
|
+
interface SpecialHourPeriod {
|
|
818
817
|
/** 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). */
|
|
819
818
|
startDate?: string;
|
|
820
819
|
/** 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). */
|
|
@@ -828,7 +827,7 @@ export interface SpecialHourPeriod {
|
|
|
828
827
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
829
828
|
comment?: string;
|
|
830
829
|
}
|
|
831
|
-
|
|
830
|
+
interface Multilingual {
|
|
832
831
|
/**
|
|
833
832
|
* Supported languages list.
|
|
834
833
|
* @maxSize 200
|
|
@@ -837,7 +836,7 @@ export interface Multilingual {
|
|
|
837
836
|
/** Whether to redirect to user language. */
|
|
838
837
|
autoRedirect?: boolean;
|
|
839
838
|
}
|
|
840
|
-
|
|
839
|
+
interface SupportedLanguage {
|
|
841
840
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
842
841
|
languageCode?: string;
|
|
843
842
|
/** Locale. */
|
|
@@ -848,15 +847,17 @@ export interface SupportedLanguage {
|
|
|
848
847
|
countryCode?: string;
|
|
849
848
|
/** How the language will be resolved. For internal use. */
|
|
850
849
|
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
850
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
851
|
+
isVisitorPrimary?: boolean | null;
|
|
851
852
|
}
|
|
852
|
-
|
|
853
|
+
declare enum ResolutionMethod {
|
|
853
854
|
QUERY_PARAM = "QUERY_PARAM",
|
|
854
855
|
SUBDOMAIN = "SUBDOMAIN",
|
|
855
856
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
856
857
|
}
|
|
857
858
|
/** @enumType */
|
|
858
|
-
|
|
859
|
-
|
|
859
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
860
|
+
interface ConsentPolicy {
|
|
860
861
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
861
862
|
essential?: boolean | null;
|
|
862
863
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -869,7 +870,7 @@ export interface ConsentPolicy {
|
|
|
869
870
|
dataToThirdParty?: boolean | null;
|
|
870
871
|
}
|
|
871
872
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
872
|
-
|
|
873
|
+
interface Translation {
|
|
873
874
|
/** The service type. */
|
|
874
875
|
serviceType?: string;
|
|
875
876
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -877,7 +878,7 @@ export interface Translation {
|
|
|
877
878
|
/** The instance ID of the service. */
|
|
878
879
|
instanceId?: string;
|
|
879
880
|
}
|
|
880
|
-
|
|
881
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
881
882
|
/** Properties were updated. */
|
|
882
883
|
propertiesChange?: PropertiesChange;
|
|
883
884
|
/** Default properties were created on site creation. */
|
|
@@ -886,7 +887,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
886
887
|
siteCloned?: SiteCloned;
|
|
887
888
|
}
|
|
888
889
|
/** @oneof */
|
|
889
|
-
|
|
890
|
+
interface ChangeContextPayloadOneOf {
|
|
890
891
|
/** Properties were updated. */
|
|
891
892
|
propertiesChange?: PropertiesChange;
|
|
892
893
|
/** Default properties were created on site creation. */
|
|
@@ -894,17 +895,17 @@ export interface ChangeContextPayloadOneOf {
|
|
|
894
895
|
/** Properties were cloned on site cloning. */
|
|
895
896
|
siteCloned?: SiteCloned;
|
|
896
897
|
}
|
|
897
|
-
|
|
898
|
+
interface PropertiesChange {
|
|
898
899
|
}
|
|
899
|
-
|
|
900
|
+
interface V4SiteCreated {
|
|
900
901
|
/** Origin template site id. */
|
|
901
902
|
originTemplateId?: string | null;
|
|
902
903
|
}
|
|
903
|
-
|
|
904
|
+
interface SiteCloned {
|
|
904
905
|
/** Origin site id. */
|
|
905
906
|
originMetaSiteId?: string;
|
|
906
907
|
}
|
|
907
|
-
|
|
908
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
908
909
|
/** Emitted on a meta site creation. */
|
|
909
910
|
siteCreated?: SiteCreated;
|
|
910
911
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -970,7 +971,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
970
971
|
assets?: Asset[];
|
|
971
972
|
}
|
|
972
973
|
/** @oneof */
|
|
973
|
-
|
|
974
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
974
975
|
/** Emitted on a meta site creation. */
|
|
975
976
|
siteCreated?: SiteCreated;
|
|
976
977
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1020,7 +1021,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1020
1021
|
/** Emitted when Picasso is detached. */
|
|
1021
1022
|
picassoUnassigned?: PicassoUnassigned;
|
|
1022
1023
|
}
|
|
1023
|
-
|
|
1024
|
+
interface Asset {
|
|
1024
1025
|
/**
|
|
1025
1026
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1026
1027
|
* @maxLength 36
|
|
@@ -1034,7 +1035,7 @@ export interface Asset {
|
|
|
1034
1035
|
/** An application state. */
|
|
1035
1036
|
state?: StateWithLiterals;
|
|
1036
1037
|
}
|
|
1037
|
-
|
|
1038
|
+
declare enum State {
|
|
1038
1039
|
UNKNOWN = "UNKNOWN",
|
|
1039
1040
|
ENABLED = "ENABLED",
|
|
1040
1041
|
DISABLED = "DISABLED",
|
|
@@ -1042,8 +1043,8 @@ export declare enum State {
|
|
|
1042
1043
|
DEMO = "DEMO"
|
|
1043
1044
|
}
|
|
1044
1045
|
/** @enumType */
|
|
1045
|
-
|
|
1046
|
-
|
|
1046
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1047
|
+
interface SiteCreated {
|
|
1047
1048
|
/**
|
|
1048
1049
|
* A template identifier (empty if not created from a template).
|
|
1049
1050
|
* @maxLength 36
|
|
@@ -1072,7 +1073,7 @@ export interface SiteCreated {
|
|
|
1072
1073
|
/** A namespace. */
|
|
1073
1074
|
namespace?: NamespaceWithLiterals;
|
|
1074
1075
|
}
|
|
1075
|
-
|
|
1076
|
+
declare enum SiteCreatedContext {
|
|
1076
1077
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1077
1078
|
OTHER = "OTHER",
|
|
1078
1079
|
/** A meta site was created from template. */
|
|
@@ -1087,8 +1088,8 @@ export declare enum SiteCreatedContext {
|
|
|
1087
1088
|
FLASH = "FLASH"
|
|
1088
1089
|
}
|
|
1089
1090
|
/** @enumType */
|
|
1090
|
-
|
|
1091
|
-
|
|
1091
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1092
|
+
declare enum Namespace {
|
|
1092
1093
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1093
1094
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1094
1095
|
WIX = "WIX",
|
|
@@ -1171,9 +1172,9 @@ export declare enum Namespace {
|
|
|
1171
1172
|
MIMIR = "MIMIR"
|
|
1172
1173
|
}
|
|
1173
1174
|
/** @enumType */
|
|
1174
|
-
|
|
1175
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
1175
1176
|
/** Site transferred to another user. */
|
|
1176
|
-
|
|
1177
|
+
interface SiteTransferred {
|
|
1177
1178
|
/**
|
|
1178
1179
|
* A previous owner id (user that transfers meta site).
|
|
1179
1180
|
* @format GUID
|
|
@@ -1186,11 +1187,11 @@ export interface SiteTransferred {
|
|
|
1186
1187
|
newOwnerId?: string;
|
|
1187
1188
|
}
|
|
1188
1189
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1189
|
-
|
|
1190
|
+
interface SiteDeleted {
|
|
1190
1191
|
/** A deletion context. */
|
|
1191
1192
|
deleteContext?: DeleteContext;
|
|
1192
1193
|
}
|
|
1193
|
-
|
|
1194
|
+
interface DeleteContext {
|
|
1194
1195
|
/** When the meta site was deleted. */
|
|
1195
1196
|
dateDeleted?: Date | null;
|
|
1196
1197
|
/** A status. */
|
|
@@ -1206,7 +1207,7 @@ export interface DeleteContext {
|
|
|
1206
1207
|
*/
|
|
1207
1208
|
initiatorId?: string | null;
|
|
1208
1209
|
}
|
|
1209
|
-
|
|
1210
|
+
declare enum DeleteStatus {
|
|
1210
1211
|
UNKNOWN = "UNKNOWN",
|
|
1211
1212
|
TRASH = "TRASH",
|
|
1212
1213
|
DELETED = "DELETED",
|
|
@@ -1214,14 +1215,14 @@ export declare enum DeleteStatus {
|
|
|
1214
1215
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1215
1216
|
}
|
|
1216
1217
|
/** @enumType */
|
|
1217
|
-
|
|
1218
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1218
1219
|
/** Restoration of the meta site. */
|
|
1219
|
-
|
|
1220
|
+
interface SiteUndeleted {
|
|
1220
1221
|
}
|
|
1221
1222
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1222
|
-
|
|
1223
|
+
interface SitePublished {
|
|
1223
1224
|
}
|
|
1224
|
-
|
|
1225
|
+
interface SiteUnpublished {
|
|
1225
1226
|
/**
|
|
1226
1227
|
* A list of URLs previously associated with the meta site.
|
|
1227
1228
|
* @maxLength 4000
|
|
@@ -1229,9 +1230,9 @@ export interface SiteUnpublished {
|
|
|
1229
1230
|
*/
|
|
1230
1231
|
urls?: string[];
|
|
1231
1232
|
}
|
|
1232
|
-
|
|
1233
|
+
interface SiteMarkedAsTemplate {
|
|
1233
1234
|
}
|
|
1234
|
-
|
|
1235
|
+
interface SiteMarkedAsWixSite {
|
|
1235
1236
|
}
|
|
1236
1237
|
/**
|
|
1237
1238
|
* Represents a service provisioned a site.
|
|
@@ -1248,7 +1249,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1248
1249
|
* changes made to the original template afterward.
|
|
1249
1250
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1250
1251
|
*/
|
|
1251
|
-
|
|
1252
|
+
interface ServiceProvisioned {
|
|
1252
1253
|
/**
|
|
1253
1254
|
* Either UUID or EmbeddedServiceType.
|
|
1254
1255
|
* @maxLength 36
|
|
@@ -1275,7 +1276,7 @@ export interface ServiceProvisioned {
|
|
|
1275
1276
|
*/
|
|
1276
1277
|
originMetaSiteId?: string | null;
|
|
1277
1278
|
}
|
|
1278
|
-
|
|
1279
|
+
interface ServiceRemoved {
|
|
1279
1280
|
/**
|
|
1280
1281
|
* Either UUID or EmbeddedServiceType.
|
|
1281
1282
|
* @maxLength 36
|
|
@@ -1293,7 +1294,7 @@ export interface ServiceRemoved {
|
|
|
1293
1294
|
version?: string | null;
|
|
1294
1295
|
}
|
|
1295
1296
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1296
|
-
|
|
1297
|
+
interface SiteRenamed {
|
|
1297
1298
|
/**
|
|
1298
1299
|
* A new meta site name (URL slug).
|
|
1299
1300
|
* @maxLength 20
|
|
@@ -1310,21 +1311,21 @@ export interface SiteRenamed {
|
|
|
1310
1311
|
*
|
|
1311
1312
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1312
1313
|
*/
|
|
1313
|
-
|
|
1314
|
+
interface SiteHardDeleted {
|
|
1314
1315
|
/** A deletion context. */
|
|
1315
1316
|
deleteContext?: DeleteContext;
|
|
1316
1317
|
}
|
|
1317
|
-
|
|
1318
|
+
interface NamespaceChanged {
|
|
1318
1319
|
/** A previous namespace. */
|
|
1319
1320
|
oldNamespace?: NamespaceWithLiterals;
|
|
1320
1321
|
/** A new namespace. */
|
|
1321
1322
|
newNamespace?: NamespaceWithLiterals;
|
|
1322
1323
|
}
|
|
1323
1324
|
/** Assigned Studio editor */
|
|
1324
|
-
|
|
1325
|
+
interface StudioAssigned {
|
|
1325
1326
|
}
|
|
1326
1327
|
/** Unassigned Studio editor */
|
|
1327
|
-
|
|
1328
|
+
interface StudioUnassigned {
|
|
1328
1329
|
}
|
|
1329
1330
|
/**
|
|
1330
1331
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1334,13 +1335,13 @@ export interface StudioUnassigned {
|
|
|
1334
1335
|
*
|
|
1335
1336
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1336
1337
|
*/
|
|
1337
|
-
|
|
1338
|
+
interface SiteUrlChanged {
|
|
1338
1339
|
}
|
|
1339
1340
|
/**
|
|
1340
1341
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1341
1342
|
* Consumed by other teams to remove relevant data.
|
|
1342
1343
|
*/
|
|
1343
|
-
|
|
1344
|
+
interface SitePurgedExternally {
|
|
1344
1345
|
/**
|
|
1345
1346
|
* @maxLength 2048
|
|
1346
1347
|
* @maxSize 100
|
|
@@ -1350,18 +1351,18 @@ export interface SitePurgedExternally {
|
|
|
1350
1351
|
appDefId?: string[];
|
|
1351
1352
|
}
|
|
1352
1353
|
/** Assigned Odeditor */
|
|
1353
|
-
|
|
1354
|
+
interface OdeditorAssigned {
|
|
1354
1355
|
}
|
|
1355
1356
|
/** Unassigned Odeditor */
|
|
1356
|
-
|
|
1357
|
+
interface OdeditorUnassigned {
|
|
1357
1358
|
}
|
|
1358
1359
|
/** Assigned Picasso editor */
|
|
1359
|
-
|
|
1360
|
+
interface PicassoAssigned {
|
|
1360
1361
|
}
|
|
1361
1362
|
/** Unassigned Picasso */
|
|
1362
|
-
|
|
1363
|
+
interface PicassoUnassigned {
|
|
1363
1364
|
}
|
|
1364
|
-
|
|
1365
|
+
interface MessageEnvelope {
|
|
1365
1366
|
/**
|
|
1366
1367
|
* App instance ID.
|
|
1367
1368
|
* @format GUID
|
|
@@ -1377,7 +1378,7 @@ export interface MessageEnvelope {
|
|
|
1377
1378
|
/** Stringify payload. */
|
|
1378
1379
|
data?: string;
|
|
1379
1380
|
}
|
|
1380
|
-
|
|
1381
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1381
1382
|
/**
|
|
1382
1383
|
* ID of a site visitor that has not logged in to the site.
|
|
1383
1384
|
* @format GUID
|
|
@@ -1402,7 +1403,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1402
1403
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1403
1404
|
}
|
|
1404
1405
|
/** @oneof */
|
|
1405
|
-
|
|
1406
|
+
interface IdentificationDataIdOneOf {
|
|
1406
1407
|
/**
|
|
1407
1408
|
* ID of a site visitor that has not logged in to the site.
|
|
1408
1409
|
* @format GUID
|
|
@@ -1424,7 +1425,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1424
1425
|
*/
|
|
1425
1426
|
appId?: string;
|
|
1426
1427
|
}
|
|
1427
|
-
|
|
1428
|
+
declare enum WebhookIdentityType {
|
|
1428
1429
|
UNKNOWN = "UNKNOWN",
|
|
1429
1430
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1430
1431
|
MEMBER = "MEMBER",
|
|
@@ -1432,8 +1433,8 @@ export declare enum WebhookIdentityType {
|
|
|
1432
1433
|
APP = "APP"
|
|
1433
1434
|
}
|
|
1434
1435
|
/** @enumType */
|
|
1435
|
-
|
|
1436
|
-
|
|
1436
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1437
|
+
interface BaseEventMetadata {
|
|
1437
1438
|
/**
|
|
1438
1439
|
* App instance ID.
|
|
1439
1440
|
* @format GUID
|
|
@@ -1447,7 +1448,7 @@ export interface BaseEventMetadata {
|
|
|
1447
1448
|
/** The identification type and identity data. */
|
|
1448
1449
|
identity?: IdentificationData;
|
|
1449
1450
|
}
|
|
1450
|
-
|
|
1451
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1451
1452
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1452
1453
|
_id?: string;
|
|
1453
1454
|
/**
|
|
@@ -1477,217 +1478,22 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1477
1478
|
*/
|
|
1478
1479
|
entityEventSequence?: string | null;
|
|
1479
1480
|
}
|
|
1480
|
-
|
|
1481
|
+
interface BookingPolicyCreatedEnvelope {
|
|
1481
1482
|
entity: BookingPolicy;
|
|
1482
1483
|
metadata: EventMetadata;
|
|
1483
1484
|
}
|
|
1484
|
-
|
|
1485
|
-
* Triggered when a booking policy is created.
|
|
1486
|
-
* @permissionScope Manage Stores
|
|
1487
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1488
|
-
* @permissionScope Read Bookings - Public Data
|
|
1489
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1490
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1491
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1492
|
-
* @permissionScope Manage Bookings
|
|
1493
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1494
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1495
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1496
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1497
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1498
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1499
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1500
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1501
|
-
* @webhook
|
|
1502
|
-
* @eventType wix.bookings.v1.booking_policy_created
|
|
1503
|
-
* @slug created
|
|
1504
|
-
*/
|
|
1505
|
-
export declare function onBookingPolicyCreated(handler: (event: BookingPolicyCreatedEnvelope) => void | Promise<void>): void;
|
|
1506
|
-
export interface BookingPolicyDefaultBookingPolicySetEnvelope {
|
|
1485
|
+
interface BookingPolicyDefaultBookingPolicySetEnvelope {
|
|
1507
1486
|
data: DefaultBookingPolicySet;
|
|
1508
1487
|
metadata: EventMetadata;
|
|
1509
1488
|
}
|
|
1510
|
-
|
|
1511
|
-
* Triggered when the site's default policy changes. Then,
|
|
1512
|
-
* _Booking Policy Updated_
|
|
1513
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/on-booking-policy-updated) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/booking-policy-updated))
|
|
1514
|
-
* is also triggered both for the new and the previous default policy.
|
|
1515
|
-
* @permissionScope Manage Stores
|
|
1516
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1517
|
-
* @permissionScope Read Bookings - Public Data
|
|
1518
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1519
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1520
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1521
|
-
* @permissionScope Manage Bookings
|
|
1522
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1523
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1524
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1525
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1526
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1527
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1528
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1529
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1530
|
-
* @webhook
|
|
1531
|
-
* @eventType wix.bookings.v1.booking_policy_default_booking_policy_set
|
|
1532
|
-
* @slug default_booking_policy_set
|
|
1533
|
-
*/
|
|
1534
|
-
export declare function onBookingPolicyDefaultBookingPolicySet(handler: (event: BookingPolicyDefaultBookingPolicySetEnvelope) => void | Promise<void>): void;
|
|
1535
|
-
export interface BookingPolicyDeletedEnvelope {
|
|
1489
|
+
interface BookingPolicyDeletedEnvelope {
|
|
1536
1490
|
metadata: EventMetadata;
|
|
1537
1491
|
}
|
|
1538
|
-
|
|
1539
|
-
* Triggered when a booking policy is deleted.
|
|
1540
|
-
* @permissionScope Manage Stores
|
|
1541
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1542
|
-
* @permissionScope Read Bookings - Public Data
|
|
1543
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1544
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1545
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1546
|
-
* @permissionScope Manage Bookings
|
|
1547
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1548
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1549
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1550
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1551
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1552
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1553
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1554
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1555
|
-
* @webhook
|
|
1556
|
-
* @eventType wix.bookings.v1.booking_policy_deleted
|
|
1557
|
-
* @slug deleted
|
|
1558
|
-
*/
|
|
1559
|
-
export declare function onBookingPolicyDeleted(handler: (event: BookingPolicyDeletedEnvelope) => void | Promise<void>): void;
|
|
1560
|
-
export interface BookingPolicyUpdatedEnvelope {
|
|
1492
|
+
interface BookingPolicyUpdatedEnvelope {
|
|
1561
1493
|
entity: BookingPolicy;
|
|
1562
1494
|
metadata: EventMetadata;
|
|
1563
1495
|
}
|
|
1564
|
-
|
|
1565
|
-
* Triggered when a booking policy is updated, including when a policy's
|
|
1566
|
-
* `default` attribute changes.
|
|
1567
|
-
* @permissionScope Manage Stores
|
|
1568
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1569
|
-
* @permissionScope Read Bookings - Public Data
|
|
1570
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1571
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1572
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1573
|
-
* @permissionScope Manage Bookings
|
|
1574
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1575
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1576
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1577
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1578
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1579
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1580
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1581
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1582
|
-
* @webhook
|
|
1583
|
-
* @eventType wix.bookings.v1.booking_policy_updated
|
|
1584
|
-
* @slug updated
|
|
1585
|
-
*/
|
|
1586
|
-
export declare function onBookingPolicyUpdated(handler: (event: BookingPolicyUpdatedEnvelope) => void | Promise<void>): void;
|
|
1587
|
-
type BookingPolicyNonNullablePaths = `customPolicyDescription.enabled` | `customPolicyDescription.description` | `limitEarlyBookingPolicy.enabled` | `limitEarlyBookingPolicy.earliestBookingInMinutes` | `limitLateBookingPolicy.enabled` | `limitLateBookingPolicy.latestBookingInMinutes` | `bookAfterStartPolicy.enabled` | `cancellationPolicy.enabled` | `cancellationPolicy.limitLatestCancellation` | `cancellationPolicy.latestCancellationInMinutes` | `reschedulePolicy.enabled` | `reschedulePolicy.limitLatestReschedule` | `reschedulePolicy.latestRescheduleInMinutes` | `waitlistPolicy.enabled` | `waitlistPolicy.capacity` | `waitlistPolicy.reservationTimeInMinutes` | `participantsPolicy.maxParticipantsPerBooking` | `cancellationFeePolicy.enabled` | `cancellationFeePolicy.cancellationWindows` | `cancellationFeePolicy.cancellationWindows.${number}.amount.value` | `cancellationFeePolicy.cancellationWindows.${number}.amount.currency` | `cancellationFeePolicy.cancellationWindows.${number}.percentage` | `saveCreditCardPolicy.enabled`;
|
|
1588
|
-
/**
|
|
1589
|
-
* Creates a booking policy.
|
|
1590
|
-
* @param bookingPolicy - Booking policy to create.
|
|
1591
|
-
* @public
|
|
1592
|
-
* @requiredField bookingPolicy
|
|
1593
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_CREATE
|
|
1594
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1595
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1596
|
-
* @permissionScope Manage Bookings
|
|
1597
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1598
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1599
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1600
|
-
* @applicableIdentity APP
|
|
1601
|
-
* @returns Created booking policy.
|
|
1602
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.CreateBookingPolicy
|
|
1603
|
-
*/
|
|
1604
|
-
export declare function createBookingPolicy(bookingPolicy: BookingPolicy): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1605
|
-
/**
|
|
1606
|
-
* Retrieves a booking policy.
|
|
1607
|
-
* @param bookingPolicyId - ID of the booking policy to retrieve.
|
|
1608
|
-
* @public
|
|
1609
|
-
* @requiredField bookingPolicyId
|
|
1610
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1611
|
-
* @permissionScope Manage Stores
|
|
1612
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1613
|
-
* @permissionScope Read Bookings - Public Data
|
|
1614
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1615
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1616
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1617
|
-
* @permissionScope Manage Bookings
|
|
1618
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1619
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1620
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1621
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1622
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1623
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1624
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1625
|
-
* @applicableIdentity APP
|
|
1626
|
-
* @applicableIdentity VISITOR
|
|
1627
|
-
* @returns Retrieved booking policy.
|
|
1628
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.GetBookingPolicy
|
|
1629
|
-
*/
|
|
1630
|
-
export declare function getBookingPolicy(bookingPolicyId: string): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1631
|
-
/**
|
|
1632
|
-
* Retrieves the strictest version of each policy rule from a list of booking
|
|
1633
|
-
* policies.
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1636
|
-
* Returns a hypothetical `bookingPolicy` object that combines the strictest
|
|
1637
|
-
* version of each rule. The `id` of the returned policy is `null` and no
|
|
1638
|
-
* corresponding `bookingPolicy` object is created. To create a new policy, you
|
|
1639
|
-
* can call *Create Booking Policy*
|
|
1640
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/create-booking-policy) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/create-booking-policy)).
|
|
1641
|
-
* @param bookingPolicyIds - IDs of the booking policies for which to retrieve the strictest rules for.
|
|
1642
|
-
* @public
|
|
1643
|
-
* @requiredField bookingPolicyIds
|
|
1644
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1645
|
-
* @permissionScope Manage Stores
|
|
1646
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1647
|
-
* @permissionScope Read Bookings - Public Data
|
|
1648
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1649
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1650
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1651
|
-
* @permissionScope Manage Bookings
|
|
1652
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1653
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1654
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1655
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1656
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1657
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1658
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1659
|
-
* @applicableIdentity APP
|
|
1660
|
-
* @applicableIdentity VISITOR
|
|
1661
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.GetStrictestBookingPolicy
|
|
1662
|
-
*/
|
|
1663
|
-
export declare function getStrictestBookingPolicy(bookingPolicyIds: string[]): Promise<NonNullablePaths<GetStrictestBookingPolicyResponse, {
|
|
1664
|
-
[P in BookingPolicyNonNullablePaths]: `bookingPolicy.${P}`;
|
|
1665
|
-
}[BookingPolicyNonNullablePaths]>>;
|
|
1666
|
-
/**
|
|
1667
|
-
* Updates a booking policy.
|
|
1668
|
-
*
|
|
1669
|
-
*
|
|
1670
|
-
* Each time the booking policy is updated, `revision` increments by 1.
|
|
1671
|
-
* The current `revision` must be specified when updating the booking policy.
|
|
1672
|
-
* This ensures you're working with the latest booking policy and prevents unintended overwrites.
|
|
1673
|
-
* @param _id - ID of the booking policy.
|
|
1674
|
-
* @public
|
|
1675
|
-
* @requiredField _id
|
|
1676
|
-
* @requiredField bookingPolicy
|
|
1677
|
-
* @requiredField bookingPolicy.revision
|
|
1678
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_UPDATE
|
|
1679
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1680
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1681
|
-
* @permissionScope Manage Bookings
|
|
1682
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1683
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1684
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1685
|
-
* @applicableIdentity APP
|
|
1686
|
-
* @returns Updated booking policy.
|
|
1687
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.UpdateBookingPolicy
|
|
1688
|
-
*/
|
|
1689
|
-
export declare function updateBookingPolicy(_id: string, bookingPolicy: NonNullablePaths<UpdateBookingPolicy, `revision`>): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1690
|
-
export interface UpdateBookingPolicy {
|
|
1496
|
+
interface UpdateBookingPolicy {
|
|
1691
1497
|
/**
|
|
1692
1498
|
* ID of the booking policy.
|
|
1693
1499
|
* @format GUID
|
|
@@ -1753,89 +1559,6 @@ export interface UpdateBookingPolicy {
|
|
|
1753
1559
|
/** Extensions enabling users to save custom data related to the booking policies. */
|
|
1754
1560
|
extendedFields?: ExtendedFields;
|
|
1755
1561
|
}
|
|
1756
|
-
/**
|
|
1757
|
-
* Sets a booking policy as the default.
|
|
1758
|
-
*
|
|
1759
|
-
*
|
|
1760
|
-
* Also updates the site's current default policy by setting its `default`
|
|
1761
|
-
* attribute to `false`. If the provided policy is already the site's
|
|
1762
|
-
* default, the call succeeds without changing any `bookingPolicy` object.
|
|
1763
|
-
* @param bookingPolicyId - ID of the booking policy that's set as default.
|
|
1764
|
-
* @public
|
|
1765
|
-
* @requiredField bookingPolicyId
|
|
1766
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_SET_DEFAULT
|
|
1767
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1768
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1769
|
-
* @permissionScope Manage Bookings
|
|
1770
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1771
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1772
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1773
|
-
* @applicableIdentity APP
|
|
1774
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.SetDefaultBookingPolicy
|
|
1775
|
-
*/
|
|
1776
|
-
export declare function setDefaultBookingPolicy(bookingPolicyId: string): Promise<NonNullablePaths<SetDefaultBookingPolicyResponse, {
|
|
1777
|
-
[P in BookingPolicyNonNullablePaths]: `currentDefaultBookingPolicy.${P}`;
|
|
1778
|
-
}[BookingPolicyNonNullablePaths] | {
|
|
1779
|
-
[P in BookingPolicyNonNullablePaths]: `previousDefaultBookingPolicy.${P}`;
|
|
1780
|
-
}[BookingPolicyNonNullablePaths]>>;
|
|
1781
|
-
/**
|
|
1782
|
-
* Deletes a booking policy.
|
|
1783
|
-
*
|
|
1784
|
-
*
|
|
1785
|
-
* You can't delete the default policy without first *setting a different policy as default*
|
|
1786
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/set-default-booking-policy) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/set-default-booking-policy)).
|
|
1787
|
-
* @param bookingPolicyId - ID of the booking policy to delete.
|
|
1788
|
-
* @public
|
|
1789
|
-
* @requiredField bookingPolicyId
|
|
1790
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_DELETE
|
|
1791
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1792
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1793
|
-
* @permissionScope Manage Bookings
|
|
1794
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1795
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1796
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1797
|
-
* @applicableIdentity APP
|
|
1798
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.DeleteBookingPolicy
|
|
1799
|
-
*/
|
|
1800
|
-
export declare function deleteBookingPolicy(bookingPolicyId: string): Promise<void>;
|
|
1801
|
-
/**
|
|
1802
|
-
* Creates a query to retrieve a list of `bookingPolicy` objects.
|
|
1803
|
-
*
|
|
1804
|
-
* The `queryBookingPolicies()` function builds a query to retrieve a list of `bookingPolicy` objects and returns a `BookingPoliciesQueryBuilder` object.
|
|
1805
|
-
*
|
|
1806
|
-
* The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/booking-policies-query-builder/find) function.
|
|
1807
|
-
*
|
|
1808
|
-
* You can refine the query by chaining `BookingPoliciesQueryBuilder` functions onto the query. `BookingPoliciesQueryBuilder` functions enable you to sort, filter, and control the results that `queryBookingPolicies()` returns.
|
|
1809
|
-
*
|
|
1810
|
-
* `queryBookingPolicies()` runs with the following `BookingPoliciesQueryBuilder` defaults that you can override:
|
|
1811
|
-
*
|
|
1812
|
-
* + `limit` is `50`.
|
|
1813
|
-
* + Sorted by `createdDate` in ascending order.
|
|
1814
|
-
*
|
|
1815
|
-
* The functions that are chained to `queryBookingPolicies()` are applied in the order they are called. For example, if you apply `ascending("waitlistPolicy.capacity")` and then `ascending("name")`, the results are sorted first by `waitlistPolicy.capacity`, and then, if there are multiple results with the same `waitlistPolicy.capacity`, the items are sorted by `name`.
|
|
1816
|
-
*
|
|
1817
|
-
* The following `BookingPoliciesQueryBuilder` functions are supported for the `queryBookingPolicies()` function. For a full description of the `bookingPolicy` object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/booking-policies-query-result/items) property in `BookingPoliciesQueryResult`.
|
|
1818
|
-
* @public
|
|
1819
|
-
* @permissionScope Manage Stores
|
|
1820
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1821
|
-
* @permissionScope Read Bookings - Public Data
|
|
1822
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1823
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1824
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1825
|
-
* @permissionScope Manage Bookings
|
|
1826
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1827
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1828
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1829
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1830
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1831
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1832
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1833
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1834
|
-
* @applicableIdentity APP
|
|
1835
|
-
* @applicableIdentity VISITOR
|
|
1836
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.QueryBookingPolicies
|
|
1837
|
-
*/
|
|
1838
|
-
export declare function queryBookingPolicies(): BookingPoliciesQueryBuilder;
|
|
1839
1562
|
interface QueryCursorResult {
|
|
1840
1563
|
cursors: Cursors;
|
|
1841
1564
|
hasNext: () => boolean;
|
|
@@ -1843,13 +1566,13 @@ interface QueryCursorResult {
|
|
|
1843
1566
|
length: number;
|
|
1844
1567
|
pageSize: number;
|
|
1845
1568
|
}
|
|
1846
|
-
|
|
1569
|
+
interface BookingPoliciesQueryResult extends QueryCursorResult {
|
|
1847
1570
|
items: BookingPolicy[];
|
|
1848
1571
|
query: BookingPoliciesQueryBuilder;
|
|
1849
1572
|
next: () => Promise<BookingPoliciesQueryResult>;
|
|
1850
1573
|
prev: () => Promise<BookingPoliciesQueryResult>;
|
|
1851
1574
|
}
|
|
1852
|
-
|
|
1575
|
+
interface BookingPoliciesQueryBuilder {
|
|
1853
1576
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1854
1577
|
* @param value - Value to compare against.
|
|
1855
1578
|
*/
|
|
@@ -1889,35 +1612,7 @@ export interface BookingPoliciesQueryBuilder {
|
|
|
1889
1612
|
skipTo: (cursor: string) => BookingPoliciesQueryBuilder;
|
|
1890
1613
|
find: () => Promise<BookingPoliciesQueryResult>;
|
|
1891
1614
|
}
|
|
1892
|
-
|
|
1893
|
-
* Counts booking policies, given the provided filtering.
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1896
|
-
* See *supported filters*
|
|
1897
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters))
|
|
1898
|
-
* for a complete list of supported filters.
|
|
1899
|
-
* @public
|
|
1900
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1901
|
-
* @permissionScope Manage Stores
|
|
1902
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1903
|
-
* @permissionScope Read Bookings - Public Data
|
|
1904
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1905
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1906
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1907
|
-
* @permissionScope Manage Bookings
|
|
1908
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1909
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1910
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1911
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1912
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1913
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1914
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1915
|
-
* @applicableIdentity APP
|
|
1916
|
-
* @applicableIdentity VISITOR
|
|
1917
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.CountBookingPolicies
|
|
1918
|
-
*/
|
|
1919
|
-
export declare function countBookingPolicies(options?: CountBookingPoliciesOptions): Promise<NonNullablePaths<CountBookingPoliciesResponse, `count`>>;
|
|
1920
|
-
export interface CountBookingPoliciesOptions {
|
|
1615
|
+
interface CountBookingPoliciesOptions {
|
|
1921
1616
|
/**
|
|
1922
1617
|
* Filter to base the count on. See
|
|
1923
1618
|
* supported filters*
|
|
@@ -1926,4 +1621,5 @@ export interface CountBookingPoliciesOptions {
|
|
|
1926
1621
|
*/
|
|
1927
1622
|
filter?: Record<string, any> | null;
|
|
1928
1623
|
}
|
|
1929
|
-
|
|
1624
|
+
|
|
1625
|
+
export { type Cursors as $, type GetBookingPolicyResponse as A, type BookingPolicy as B, type CountBookingPoliciesOptions as C, DayOfWeek as D, type ExtendedFields as E, type GetStrictestBookingPolicyRequest as F, type GetStrictestBookingPolicyResponse as G, type UpdateBookingPolicyRequest as H, type UpdateBookingPolicyResponse as I, type SetDefaultBookingPolicyRequest as J, type DeleteBookingPolicyRequest as K, type LimitEarlyBookingPolicy as L, type Money as M, Namespace as N, type DeleteBookingPolicyResponse as O, PlacementType as P, type QueryBookingPoliciesRequest as Q, ResolutionMethod as R, type SetDefaultBookingPolicyResponse as S, type CursorQuery as T, type UpdateBookingPolicy as U, type CursorQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type CursorPaging as Y, type QueryBookingPoliciesResponse as Z, type CursorPagingMetadata as _, type BookingPoliciesQueryBuilder as a, type BookingPoliciesQueryResult as a$, type CountBookingPoliciesRequest as a0, type UpdateAllPoliciesRequest as a1, type UpdateAllPoliciesResponse as a2, type CreateMissingDefaultPolicyRequest as a3, type CreateMissingDefaultPolicyResponse as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type SiteCreated as aA, type SiteTransferred as aB, type SiteDeleted as aC, type DeleteContext as aD, type SiteUndeleted as aE, type SitePublished as aF, type SiteUnpublished as aG, type SiteMarkedAsTemplate as aH, type SiteMarkedAsWixSite as aI, type ServiceProvisioned as aJ, type ServiceRemoved as aK, type SiteRenamed as aL, type SiteHardDeleted as aM, type NamespaceChanged as aN, type StudioAssigned as aO, type StudioUnassigned as aP, type SiteUrlChanged as aQ, type SitePurgedExternally as aR, type OdeditorAssigned as aS, type OdeditorUnassigned as aT, type PicassoAssigned as aU, type PicassoUnassigned as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type EntityDeletedEvent as aa, type ActionEvent as ab, type Empty as ac, type SitePropertiesNotification as ad, type SitePropertiesEvent as ae, type Properties as af, type Categories as ag, type Locale as ah, type Address as ai, type AddressHint as aj, type GeoCoordinates as ak, type BusinessSchedule as al, type TimePeriod as am, type SpecialHourPeriod as an, type Multilingual as ao, type SupportedLanguage as ap, type ConsentPolicy as aq, type Translation as ar, type ChangeContext as as, type ChangeContextPayloadOneOf as at, type PropertiesChange as au, type V4SiteCreated as av, type SiteCloned as aw, type MetaSiteSpecialEvent as ax, type MetaSiteSpecialEventPayloadOneOf as ay, type Asset as az, type CountBookingPoliciesResponse as b, type BookingPolicyCreatedEnvelope as c, type BookingPolicyDefaultBookingPolicySetEnvelope as d, type BookingPolicyDeletedEnvelope as e, type BookingPolicyUpdatedEnvelope as f, SortOrder as g, State as h, SiteCreatedContext as i, DeleteStatus as j, type PolicyDescription as k, type LimitLateBookingPolicy as l, type BookAfterStartPolicy as m, type CancellationPolicy as n, type ReschedulePolicy as o, type WaitlistPolicy as p, type ParticipantsPolicy as q, type ResourcesPolicy as r, type CancellationFeePolicy as s, type CancellationWindow as t, type CancellationWindowFeeOneOf as u, type SaveCreditCardPolicy as v, type DefaultBookingPolicySet as w, type CreateBookingPolicyRequest as x, type CreateBookingPolicyResponse as y, type GetBookingPolicyRequest as z };
|