@wix/auto_sdk_bookings_booking-policies 1.0.15 → 1.0.17
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-BOznK2N1.d.mts} +116 -430
- package/build/{cjs/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-BOznK2N1.d.ts} +116 -430
- package/build/index.d.mts +143 -0
- package/build/index.d.ts +143 -0
- package/build/index.js +791 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +747 -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-BOznK2N1.d.mts} +116 -430
- package/build/{es/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → internal/bookings-v1-booking-policy-booking-policies.universal-BOznK2N1.d.ts} +116 -430
- package/build/internal/index.d.mts +143 -0
- package/build/internal/index.d.ts +143 -0
- package/build/internal/index.js +791 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +747 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +543 -0
- package/build/internal/meta.d.ts +543 -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 +543 -0
- package/build/meta.d.ts +543 -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 +13 -12
- 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 -1400
- 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 -600
- 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/package.json +0 -3
- 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 -1400
- 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 -566
- 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 -1400
- 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 -600
- 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 -1400
- 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 -566
- 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,11 +476,11 @@ export interface Sorting {
|
|
|
477
476
|
/** Sort order. */
|
|
478
477
|
order?: SortOrder;
|
|
479
478
|
}
|
|
480
|
-
|
|
479
|
+
declare enum SortOrder {
|
|
481
480
|
ASC = "ASC",
|
|
482
481
|
DESC = "DESC"
|
|
483
482
|
}
|
|
484
|
-
|
|
483
|
+
interface CursorPaging {
|
|
485
484
|
/**
|
|
486
485
|
* Number of items to load.
|
|
487
486
|
* @max 100
|
|
@@ -497,13 +496,13 @@ export interface CursorPaging {
|
|
|
497
496
|
*/
|
|
498
497
|
cursor?: string | null;
|
|
499
498
|
}
|
|
500
|
-
|
|
499
|
+
interface QueryBookingPoliciesResponse {
|
|
501
500
|
/** Retrieved booking policies. */
|
|
502
501
|
bookingPolicies?: BookingPolicy[];
|
|
503
502
|
/** Paging metadata. */
|
|
504
503
|
pagingMetadata?: CursorPagingMetadata;
|
|
505
504
|
}
|
|
506
|
-
|
|
505
|
+
interface CursorPagingMetadata {
|
|
507
506
|
/** Number of items returned in the response. */
|
|
508
507
|
count?: number | null;
|
|
509
508
|
/** Offset that was requested. */
|
|
@@ -515,7 +514,7 @@ export interface CursorPagingMetadata {
|
|
|
515
514
|
*/
|
|
516
515
|
hasNext?: boolean | null;
|
|
517
516
|
}
|
|
518
|
-
|
|
517
|
+
interface Cursors {
|
|
519
518
|
/**
|
|
520
519
|
* Cursor pointing to next page in the list of results.
|
|
521
520
|
* @maxLength 16000
|
|
@@ -527,7 +526,7 @@ export interface Cursors {
|
|
|
527
526
|
*/
|
|
528
527
|
prev?: string | null;
|
|
529
528
|
}
|
|
530
|
-
|
|
529
|
+
interface CountBookingPoliciesRequest {
|
|
531
530
|
/**
|
|
532
531
|
* Filter to base the count on. See
|
|
533
532
|
* supported filters*
|
|
@@ -536,27 +535,27 @@ export interface CountBookingPoliciesRequest {
|
|
|
536
535
|
*/
|
|
537
536
|
filter?: Record<string, any> | null;
|
|
538
537
|
}
|
|
539
|
-
|
|
538
|
+
interface CountBookingPoliciesResponse {
|
|
540
539
|
/** Number of booking policies matching the provided filter. */
|
|
541
540
|
count?: number;
|
|
542
541
|
}
|
|
543
|
-
|
|
542
|
+
interface UpdateAllPoliciesRequest {
|
|
544
543
|
/** Fields to set to all booking policies. */
|
|
545
544
|
bookingPolicy?: BookingPolicy;
|
|
546
545
|
/** List of fields to update */
|
|
547
546
|
mask?: string[];
|
|
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;
|
|
@@ -599,19 +598,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
599
598
|
entityEventSequence?: string | null;
|
|
600
599
|
}
|
|
601
600
|
/** @oneof */
|
|
602
|
-
|
|
601
|
+
interface DomainEventBodyOneOf {
|
|
603
602
|
createdEvent?: EntityCreatedEvent;
|
|
604
603
|
updatedEvent?: EntityUpdatedEvent;
|
|
605
604
|
deletedEvent?: EntityDeletedEvent;
|
|
606
605
|
actionEvent?: ActionEvent;
|
|
607
606
|
}
|
|
608
|
-
|
|
607
|
+
interface EntityCreatedEvent {
|
|
609
608
|
entity?: string;
|
|
610
609
|
}
|
|
611
|
-
|
|
610
|
+
interface RestoreInfo {
|
|
612
611
|
deletedDate?: Date | null;
|
|
613
612
|
}
|
|
614
|
-
|
|
613
|
+
interface EntityUpdatedEvent {
|
|
615
614
|
/**
|
|
616
615
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
617
616
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -619,17 +618,17 @@ export interface EntityUpdatedEvent {
|
|
|
619
618
|
*/
|
|
620
619
|
currentEntity?: string;
|
|
621
620
|
}
|
|
622
|
-
|
|
621
|
+
interface EntityDeletedEvent {
|
|
623
622
|
/** Entity that was deleted */
|
|
624
623
|
deletedEntity?: string | null;
|
|
625
624
|
}
|
|
626
|
-
|
|
625
|
+
interface ActionEvent {
|
|
627
626
|
body?: string;
|
|
628
627
|
}
|
|
629
|
-
|
|
628
|
+
interface Empty {
|
|
630
629
|
}
|
|
631
630
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
632
|
-
|
|
631
|
+
interface SitePropertiesNotification {
|
|
633
632
|
/** The site ID for which this update notification applies. */
|
|
634
633
|
metasiteId?: string;
|
|
635
634
|
/** The actual update event. */
|
|
@@ -643,7 +642,7 @@ export interface SitePropertiesNotification {
|
|
|
643
642
|
changeContext?: ChangeContext;
|
|
644
643
|
}
|
|
645
644
|
/** The actual update event for a particular notification. */
|
|
646
|
-
|
|
645
|
+
interface SitePropertiesEvent {
|
|
647
646
|
/** Version of the site's properties represented by this update. */
|
|
648
647
|
version?: number;
|
|
649
648
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -651,7 +650,7 @@ export interface SitePropertiesEvent {
|
|
|
651
650
|
/** Updated properties. */
|
|
652
651
|
properties?: Properties;
|
|
653
652
|
}
|
|
654
|
-
|
|
653
|
+
interface Properties {
|
|
655
654
|
/** Site categories. */
|
|
656
655
|
categories?: Categories;
|
|
657
656
|
/** Site locale. */
|
|
@@ -707,7 +706,7 @@ export interface Properties {
|
|
|
707
706
|
/** Track clicks analytics. */
|
|
708
707
|
trackClicksAnalytics?: boolean;
|
|
709
708
|
}
|
|
710
|
-
|
|
709
|
+
interface Categories {
|
|
711
710
|
/** Primary site category. */
|
|
712
711
|
primary?: string;
|
|
713
712
|
/**
|
|
@@ -718,13 +717,13 @@ export interface Categories {
|
|
|
718
717
|
/** Business Term Id */
|
|
719
718
|
businessTermId?: string | null;
|
|
720
719
|
}
|
|
721
|
-
|
|
720
|
+
interface Locale {
|
|
722
721
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
723
722
|
languageCode?: string;
|
|
724
723
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
725
724
|
country?: string;
|
|
726
725
|
}
|
|
727
|
-
|
|
726
|
+
interface Address {
|
|
728
727
|
/** Street name. */
|
|
729
728
|
street?: string;
|
|
730
729
|
/** City name. */
|
|
@@ -756,27 +755,27 @@ export interface Address {
|
|
|
756
755
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
757
756
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
758
757
|
*/
|
|
759
|
-
|
|
758
|
+
interface AddressHint {
|
|
760
759
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
761
760
|
text?: string;
|
|
762
761
|
/** Where the extra text should be displayed. */
|
|
763
762
|
placement?: PlacementType;
|
|
764
763
|
}
|
|
765
764
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
766
|
-
|
|
765
|
+
declare enum PlacementType {
|
|
767
766
|
BEFORE = "BEFORE",
|
|
768
767
|
AFTER = "AFTER",
|
|
769
768
|
REPLACE = "REPLACE"
|
|
770
769
|
}
|
|
771
770
|
/** Geocoordinates for a particular address. */
|
|
772
|
-
|
|
771
|
+
interface GeoCoordinates {
|
|
773
772
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
774
773
|
latitude?: number;
|
|
775
774
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
776
775
|
longitude?: number;
|
|
777
776
|
}
|
|
778
777
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
779
|
-
|
|
778
|
+
interface BusinessSchedule {
|
|
780
779
|
/**
|
|
781
780
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
782
781
|
* @maxSize 100
|
|
@@ -789,7 +788,7 @@ export interface BusinessSchedule {
|
|
|
789
788
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
790
789
|
}
|
|
791
790
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
792
|
-
|
|
791
|
+
interface TimePeriod {
|
|
793
792
|
/** Day of the week the period starts on. */
|
|
794
793
|
openDay?: DayOfWeek;
|
|
795
794
|
/**
|
|
@@ -808,7 +807,7 @@ export interface TimePeriod {
|
|
|
808
807
|
closeTime?: string;
|
|
809
808
|
}
|
|
810
809
|
/** Enumerates the days of the week. */
|
|
811
|
-
|
|
810
|
+
declare enum DayOfWeek {
|
|
812
811
|
MONDAY = "MONDAY",
|
|
813
812
|
TUESDAY = "TUESDAY",
|
|
814
813
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -818,7 +817,7 @@ export declare enum DayOfWeek {
|
|
|
818
817
|
SUNDAY = "SUNDAY"
|
|
819
818
|
}
|
|
820
819
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
821
|
-
|
|
820
|
+
interface SpecialHourPeriod {
|
|
822
821
|
/** 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). */
|
|
823
822
|
startDate?: string;
|
|
824
823
|
/** 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). */
|
|
@@ -832,7 +831,7 @@ export interface SpecialHourPeriod {
|
|
|
832
831
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
833
832
|
comment?: string;
|
|
834
833
|
}
|
|
835
|
-
|
|
834
|
+
interface Multilingual {
|
|
836
835
|
/**
|
|
837
836
|
* Supported languages list.
|
|
838
837
|
* @maxSize 200
|
|
@@ -841,7 +840,7 @@ export interface Multilingual {
|
|
|
841
840
|
/** Whether to redirect to user language. */
|
|
842
841
|
autoRedirect?: boolean;
|
|
843
842
|
}
|
|
844
|
-
|
|
843
|
+
interface SupportedLanguage {
|
|
845
844
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
846
845
|
languageCode?: string;
|
|
847
846
|
/** Locale. */
|
|
@@ -853,12 +852,12 @@ export interface SupportedLanguage {
|
|
|
853
852
|
/** How the language will be resolved. For internal use. */
|
|
854
853
|
resolutionMethod?: ResolutionMethod;
|
|
855
854
|
}
|
|
856
|
-
|
|
855
|
+
declare enum ResolutionMethod {
|
|
857
856
|
QUERY_PARAM = "QUERY_PARAM",
|
|
858
857
|
SUBDOMAIN = "SUBDOMAIN",
|
|
859
858
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
860
859
|
}
|
|
861
|
-
|
|
860
|
+
interface ConsentPolicy {
|
|
862
861
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
863
862
|
essential?: boolean | null;
|
|
864
863
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -871,7 +870,7 @@ export interface ConsentPolicy {
|
|
|
871
870
|
dataToThirdParty?: boolean | null;
|
|
872
871
|
}
|
|
873
872
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
874
|
-
|
|
873
|
+
interface Translation {
|
|
875
874
|
/** The service type. */
|
|
876
875
|
serviceType?: string;
|
|
877
876
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -879,7 +878,7 @@ export interface Translation {
|
|
|
879
878
|
/** The instance ID of the service. */
|
|
880
879
|
instanceId?: string;
|
|
881
880
|
}
|
|
882
|
-
|
|
881
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
883
882
|
/** Properties were updated. */
|
|
884
883
|
propertiesChange?: PropertiesChange;
|
|
885
884
|
/** Default properties were created on site creation. */
|
|
@@ -888,7 +887,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
888
887
|
siteCloned?: SiteCloned;
|
|
889
888
|
}
|
|
890
889
|
/** @oneof */
|
|
891
|
-
|
|
890
|
+
interface ChangeContextPayloadOneOf {
|
|
892
891
|
/** Properties were updated. */
|
|
893
892
|
propertiesChange?: PropertiesChange;
|
|
894
893
|
/** Default properties were created on site creation. */
|
|
@@ -896,17 +895,17 @@ export interface ChangeContextPayloadOneOf {
|
|
|
896
895
|
/** Properties were cloned on site cloning. */
|
|
897
896
|
siteCloned?: SiteCloned;
|
|
898
897
|
}
|
|
899
|
-
|
|
898
|
+
interface PropertiesChange {
|
|
900
899
|
}
|
|
901
|
-
|
|
900
|
+
interface V4SiteCreated {
|
|
902
901
|
/** Origin template site id. */
|
|
903
902
|
originTemplateId?: string | null;
|
|
904
903
|
}
|
|
905
|
-
|
|
904
|
+
interface SiteCloned {
|
|
906
905
|
/** Origin site id. */
|
|
907
906
|
originMetaSiteId?: string;
|
|
908
907
|
}
|
|
909
|
-
|
|
908
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
910
909
|
/** Emitted on a meta site creation. */
|
|
911
910
|
siteCreated?: SiteCreated;
|
|
912
911
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -964,7 +963,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
964
963
|
assets?: Asset[];
|
|
965
964
|
}
|
|
966
965
|
/** @oneof */
|
|
967
|
-
|
|
966
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
968
967
|
/** Emitted on a meta site creation. */
|
|
969
968
|
siteCreated?: SiteCreated;
|
|
970
969
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1006,7 +1005,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1006
1005
|
/** Site is marked as PurgedExternally */
|
|
1007
1006
|
sitePurgedExternally?: SitePurgedExternally;
|
|
1008
1007
|
}
|
|
1009
|
-
|
|
1008
|
+
interface Asset {
|
|
1010
1009
|
/**
|
|
1011
1010
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1012
1011
|
* @maxLength 36
|
|
@@ -1020,14 +1019,14 @@ export interface Asset {
|
|
|
1020
1019
|
/** An application state. */
|
|
1021
1020
|
state?: State;
|
|
1022
1021
|
}
|
|
1023
|
-
|
|
1022
|
+
declare enum State {
|
|
1024
1023
|
UNKNOWN = "UNKNOWN",
|
|
1025
1024
|
ENABLED = "ENABLED",
|
|
1026
1025
|
DISABLED = "DISABLED",
|
|
1027
1026
|
PENDING = "PENDING",
|
|
1028
1027
|
DEMO = "DEMO"
|
|
1029
1028
|
}
|
|
1030
|
-
|
|
1029
|
+
interface SiteCreated {
|
|
1031
1030
|
/**
|
|
1032
1031
|
* A template identifier (empty if not created from a template).
|
|
1033
1032
|
* @maxLength 36
|
|
@@ -1056,7 +1055,7 @@ export interface SiteCreated {
|
|
|
1056
1055
|
/** A namespace. */
|
|
1057
1056
|
namespace?: Namespace;
|
|
1058
1057
|
}
|
|
1059
|
-
|
|
1058
|
+
declare enum SiteCreatedContext {
|
|
1060
1059
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1061
1060
|
OTHER = "OTHER",
|
|
1062
1061
|
/** A meta site was created from template. */
|
|
@@ -1070,7 +1069,7 @@ export declare enum SiteCreatedContext {
|
|
|
1070
1069
|
/** deprecated A meta site was created for Flash editor. */
|
|
1071
1070
|
FLASH = "FLASH"
|
|
1072
1071
|
}
|
|
1073
|
-
|
|
1072
|
+
declare enum Namespace {
|
|
1074
1073
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1075
1074
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1076
1075
|
WIX = "WIX",
|
|
@@ -1153,7 +1152,7 @@ export declare enum Namespace {
|
|
|
1153
1152
|
MIMIR = "MIMIR"
|
|
1154
1153
|
}
|
|
1155
1154
|
/** Site transferred to another user. */
|
|
1156
|
-
|
|
1155
|
+
interface SiteTransferred {
|
|
1157
1156
|
/**
|
|
1158
1157
|
* A previous owner id (user that transfers meta site).
|
|
1159
1158
|
* @format GUID
|
|
@@ -1166,11 +1165,11 @@ export interface SiteTransferred {
|
|
|
1166
1165
|
newOwnerId?: string;
|
|
1167
1166
|
}
|
|
1168
1167
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1169
|
-
|
|
1168
|
+
interface SiteDeleted {
|
|
1170
1169
|
/** A deletion context. */
|
|
1171
1170
|
deleteContext?: DeleteContext;
|
|
1172
1171
|
}
|
|
1173
|
-
|
|
1172
|
+
interface DeleteContext {
|
|
1174
1173
|
/** When the meta site was deleted. */
|
|
1175
1174
|
dateDeleted?: Date | null;
|
|
1176
1175
|
/** A status. */
|
|
@@ -1186,7 +1185,7 @@ export interface DeleteContext {
|
|
|
1186
1185
|
*/
|
|
1187
1186
|
initiatorId?: string | null;
|
|
1188
1187
|
}
|
|
1189
|
-
|
|
1188
|
+
declare enum DeleteStatus {
|
|
1190
1189
|
UNKNOWN = "UNKNOWN",
|
|
1191
1190
|
TRASH = "TRASH",
|
|
1192
1191
|
DELETED = "DELETED",
|
|
@@ -1194,12 +1193,12 @@ export declare enum DeleteStatus {
|
|
|
1194
1193
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1195
1194
|
}
|
|
1196
1195
|
/** Restoration of the meta site. */
|
|
1197
|
-
|
|
1196
|
+
interface SiteUndeleted {
|
|
1198
1197
|
}
|
|
1199
1198
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1200
|
-
|
|
1199
|
+
interface SitePublished {
|
|
1201
1200
|
}
|
|
1202
|
-
|
|
1201
|
+
interface SiteUnpublished {
|
|
1203
1202
|
/**
|
|
1204
1203
|
* A list of URLs previously associated with the meta site.
|
|
1205
1204
|
* @maxLength 4000
|
|
@@ -1207,9 +1206,9 @@ export interface SiteUnpublished {
|
|
|
1207
1206
|
*/
|
|
1208
1207
|
urls?: string[];
|
|
1209
1208
|
}
|
|
1210
|
-
|
|
1209
|
+
interface SiteMarkedAsTemplate {
|
|
1211
1210
|
}
|
|
1212
|
-
|
|
1211
|
+
interface SiteMarkedAsWixSite {
|
|
1213
1212
|
}
|
|
1214
1213
|
/**
|
|
1215
1214
|
* Represents a service provisioned a site.
|
|
@@ -1226,7 +1225,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1226
1225
|
* changes made to the original template afterward.
|
|
1227
1226
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1228
1227
|
*/
|
|
1229
|
-
|
|
1228
|
+
interface ServiceProvisioned {
|
|
1230
1229
|
/**
|
|
1231
1230
|
* Either UUID or EmbeddedServiceType.
|
|
1232
1231
|
* @maxLength 36
|
|
@@ -1253,7 +1252,7 @@ export interface ServiceProvisioned {
|
|
|
1253
1252
|
*/
|
|
1254
1253
|
originMetaSiteId?: string | null;
|
|
1255
1254
|
}
|
|
1256
|
-
|
|
1255
|
+
interface ServiceRemoved {
|
|
1257
1256
|
/**
|
|
1258
1257
|
* Either UUID or EmbeddedServiceType.
|
|
1259
1258
|
* @maxLength 36
|
|
@@ -1271,7 +1270,7 @@ export interface ServiceRemoved {
|
|
|
1271
1270
|
version?: string | null;
|
|
1272
1271
|
}
|
|
1273
1272
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1274
|
-
|
|
1273
|
+
interface SiteRenamed {
|
|
1275
1274
|
/**
|
|
1276
1275
|
* A new meta site name (URL slug).
|
|
1277
1276
|
* @maxLength 20
|
|
@@ -1288,21 +1287,21 @@ export interface SiteRenamed {
|
|
|
1288
1287
|
*
|
|
1289
1288
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1290
1289
|
*/
|
|
1291
|
-
|
|
1290
|
+
interface SiteHardDeleted {
|
|
1292
1291
|
/** A deletion context. */
|
|
1293
1292
|
deleteContext?: DeleteContext;
|
|
1294
1293
|
}
|
|
1295
|
-
|
|
1294
|
+
interface NamespaceChanged {
|
|
1296
1295
|
/** A previous namespace. */
|
|
1297
1296
|
oldNamespace?: Namespace;
|
|
1298
1297
|
/** A new namespace. */
|
|
1299
1298
|
newNamespace?: Namespace;
|
|
1300
1299
|
}
|
|
1301
1300
|
/** Assigned Studio editor */
|
|
1302
|
-
|
|
1301
|
+
interface StudioAssigned {
|
|
1303
1302
|
}
|
|
1304
1303
|
/** Unassigned Studio editor */
|
|
1305
|
-
|
|
1304
|
+
interface StudioUnassigned {
|
|
1306
1305
|
}
|
|
1307
1306
|
/**
|
|
1308
1307
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1312,13 +1311,13 @@ export interface StudioUnassigned {
|
|
|
1312
1311
|
*
|
|
1313
1312
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1314
1313
|
*/
|
|
1315
|
-
|
|
1314
|
+
interface SiteUrlChanged {
|
|
1316
1315
|
}
|
|
1317
1316
|
/**
|
|
1318
1317
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1319
1318
|
* Consumed by other teams to remove relevant data.
|
|
1320
1319
|
*/
|
|
1321
|
-
|
|
1320
|
+
interface SitePurgedExternally {
|
|
1322
1321
|
/**
|
|
1323
1322
|
* @maxLength 2048
|
|
1324
1323
|
* @maxSize 100
|
|
@@ -1327,7 +1326,7 @@ export interface SitePurgedExternally {
|
|
|
1327
1326
|
*/
|
|
1328
1327
|
appDefId?: string[];
|
|
1329
1328
|
}
|
|
1330
|
-
|
|
1329
|
+
interface MessageEnvelope {
|
|
1331
1330
|
/**
|
|
1332
1331
|
* App instance ID.
|
|
1333
1332
|
* @format GUID
|
|
@@ -1343,7 +1342,7 @@ export interface MessageEnvelope {
|
|
|
1343
1342
|
/** Stringify payload. */
|
|
1344
1343
|
data?: string;
|
|
1345
1344
|
}
|
|
1346
|
-
|
|
1345
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1347
1346
|
/**
|
|
1348
1347
|
* ID of a site visitor that has not logged in to the site.
|
|
1349
1348
|
* @format GUID
|
|
@@ -1368,7 +1367,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1368
1367
|
identityType?: WebhookIdentityType;
|
|
1369
1368
|
}
|
|
1370
1369
|
/** @oneof */
|
|
1371
|
-
|
|
1370
|
+
interface IdentificationDataIdOneOf {
|
|
1372
1371
|
/**
|
|
1373
1372
|
* ID of a site visitor that has not logged in to the site.
|
|
1374
1373
|
* @format GUID
|
|
@@ -1390,14 +1389,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
1390
1389
|
*/
|
|
1391
1390
|
appId?: string;
|
|
1392
1391
|
}
|
|
1393
|
-
|
|
1392
|
+
declare enum WebhookIdentityType {
|
|
1394
1393
|
UNKNOWN = "UNKNOWN",
|
|
1395
1394
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1396
1395
|
MEMBER = "MEMBER",
|
|
1397
1396
|
WIX_USER = "WIX_USER",
|
|
1398
1397
|
APP = "APP"
|
|
1399
1398
|
}
|
|
1400
|
-
|
|
1399
|
+
interface BaseEventMetadata {
|
|
1401
1400
|
/**
|
|
1402
1401
|
* App instance ID.
|
|
1403
1402
|
* @format GUID
|
|
@@ -1411,7 +1410,7 @@ export interface BaseEventMetadata {
|
|
|
1411
1410
|
/** The identification type and identity data. */
|
|
1412
1411
|
identity?: IdentificationData;
|
|
1413
1412
|
}
|
|
1414
|
-
|
|
1413
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1415
1414
|
/**
|
|
1416
1415
|
* Unique event ID.
|
|
1417
1416
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1449,221 +1448,22 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1449
1448
|
*/
|
|
1450
1449
|
entityEventSequence?: string | null;
|
|
1451
1450
|
}
|
|
1452
|
-
|
|
1451
|
+
interface BookingPolicyCreatedEnvelope {
|
|
1453
1452
|
entity: BookingPolicy;
|
|
1454
1453
|
metadata: EventMetadata;
|
|
1455
1454
|
}
|
|
1456
|
-
|
|
1457
|
-
* Triggered when a booking policy is created.
|
|
1458
|
-
* @permissionScope Read Bookings - Public Data
|
|
1459
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1460
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1461
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1462
|
-
* @permissionScope Manage Bookings
|
|
1463
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1464
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1465
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1466
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1467
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1468
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1469
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1470
|
-
* @permissionScope Picasso private app mega scope
|
|
1471
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1472
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1473
|
-
* @webhook
|
|
1474
|
-
* @eventType wix.bookings.v1.booking_policy_created
|
|
1475
|
-
* @slug created
|
|
1476
|
-
*/
|
|
1477
|
-
export declare function onBookingPolicyCreated(handler: (event: BookingPolicyCreatedEnvelope) => void | Promise<void>): void;
|
|
1478
|
-
export interface BookingPolicyDefaultBookingPolicySetEnvelope {
|
|
1455
|
+
interface BookingPolicyDefaultBookingPolicySetEnvelope {
|
|
1479
1456
|
data: DefaultBookingPolicySet;
|
|
1480
1457
|
metadata: EventMetadata;
|
|
1481
1458
|
}
|
|
1482
|
-
|
|
1483
|
-
* Triggered when the site's default policy changes. Then,
|
|
1484
|
-
* _Booking Policy Updated_
|
|
1485
|
-
* ([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))
|
|
1486
|
-
* is also triggered both for the new and the previous default policy.
|
|
1487
|
-
* @permissionScope Read Bookings - Public Data
|
|
1488
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1489
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1490
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1491
|
-
* @permissionScope Manage Bookings
|
|
1492
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1493
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1494
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1495
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1496
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1497
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1498
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1499
|
-
* @permissionScope Picasso private app mega scope
|
|
1500
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1501
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1502
|
-
* @webhook
|
|
1503
|
-
* @eventType wix.bookings.v1.booking_policy_default_booking_policy_set
|
|
1504
|
-
* @slug default_booking_policy_set
|
|
1505
|
-
*/
|
|
1506
|
-
export declare function onBookingPolicyDefaultBookingPolicySet(handler: (event: BookingPolicyDefaultBookingPolicySetEnvelope) => void | Promise<void>): void;
|
|
1507
|
-
export interface BookingPolicyDeletedEnvelope {
|
|
1459
|
+
interface BookingPolicyDeletedEnvelope {
|
|
1508
1460
|
metadata: EventMetadata;
|
|
1509
1461
|
}
|
|
1510
|
-
|
|
1511
|
-
* Triggered when a booking policy is deleted.
|
|
1512
|
-
* @permissionScope Read Bookings - Public Data
|
|
1513
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1514
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1515
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1516
|
-
* @permissionScope Manage Bookings
|
|
1517
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1518
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1519
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1520
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1521
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1522
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1523
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1524
|
-
* @permissionScope Picasso private app mega scope
|
|
1525
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1526
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1527
|
-
* @webhook
|
|
1528
|
-
* @eventType wix.bookings.v1.booking_policy_deleted
|
|
1529
|
-
* @slug deleted
|
|
1530
|
-
*/
|
|
1531
|
-
export declare function onBookingPolicyDeleted(handler: (event: BookingPolicyDeletedEnvelope) => void | Promise<void>): void;
|
|
1532
|
-
export interface BookingPolicyUpdatedEnvelope {
|
|
1462
|
+
interface BookingPolicyUpdatedEnvelope {
|
|
1533
1463
|
entity: BookingPolicy;
|
|
1534
1464
|
metadata: EventMetadata;
|
|
1535
1465
|
}
|
|
1536
|
-
|
|
1537
|
-
* Triggered when a booking policy is updated, including when a policy's
|
|
1538
|
-
* `default` attribute changes.
|
|
1539
|
-
* @permissionScope Read Bookings - Public Data
|
|
1540
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1541
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1542
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1543
|
-
* @permissionScope Manage Bookings
|
|
1544
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1545
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1546
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1547
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1548
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1549
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1550
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1551
|
-
* @permissionScope Picasso private app mega scope
|
|
1552
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1553
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1554
|
-
* @webhook
|
|
1555
|
-
* @eventType wix.bookings.v1.booking_policy_updated
|
|
1556
|
-
* @slug updated
|
|
1557
|
-
*/
|
|
1558
|
-
export declare function onBookingPolicyUpdated(handler: (event: BookingPolicyUpdatedEnvelope) => void | Promise<void>): void;
|
|
1559
|
-
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`;
|
|
1560
|
-
/**
|
|
1561
|
-
* Creates a booking policy.
|
|
1562
|
-
* @param bookingPolicy - Booking policy to create.
|
|
1563
|
-
* @public
|
|
1564
|
-
* @requiredField bookingPolicy
|
|
1565
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_CREATE
|
|
1566
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1567
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1568
|
-
* @permissionScope Manage Bookings
|
|
1569
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1570
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1571
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1572
|
-
* @permissionScope Picasso private app mega scope
|
|
1573
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1574
|
-
* @applicableIdentity APP
|
|
1575
|
-
* @returns Created booking policy.
|
|
1576
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.CreateBookingPolicy
|
|
1577
|
-
*/
|
|
1578
|
-
export declare function createBookingPolicy(bookingPolicy: BookingPolicy): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1579
|
-
/**
|
|
1580
|
-
* Retrieves a booking policy.
|
|
1581
|
-
* @param bookingPolicyId - ID of the booking policy to retrieve.
|
|
1582
|
-
* @public
|
|
1583
|
-
* @requiredField bookingPolicyId
|
|
1584
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1585
|
-
* @permissionScope Read Bookings - Public Data
|
|
1586
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1587
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1588
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1589
|
-
* @permissionScope Manage Bookings
|
|
1590
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1591
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1592
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1593
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1594
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1595
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1596
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1597
|
-
* @permissionScope Picasso private app mega scope
|
|
1598
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1599
|
-
* @applicableIdentity APP
|
|
1600
|
-
* @applicableIdentity VISITOR
|
|
1601
|
-
* @returns Retrieved booking policy.
|
|
1602
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.GetBookingPolicy
|
|
1603
|
-
*/
|
|
1604
|
-
export declare function getBookingPolicy(bookingPolicyId: string): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1605
|
-
/**
|
|
1606
|
-
* Retrieves the strictest version of each policy rule from a list of booking
|
|
1607
|
-
* policies.
|
|
1608
|
-
*
|
|
1609
|
-
*
|
|
1610
|
-
* Returns a hypothetical `bookingPolicy` object that combines the strictest
|
|
1611
|
-
* version of each rule. The `id` of the returned policy is `null` and no
|
|
1612
|
-
* corresponding `bookingPolicy` object is created. To create a new policy, you
|
|
1613
|
-
* can call *Create Booking Policy*
|
|
1614
|
-
* ([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)).
|
|
1615
|
-
* @param bookingPolicyIds - IDs of the booking policies for which to retrieve the strictest rules for.
|
|
1616
|
-
* @public
|
|
1617
|
-
* @requiredField bookingPolicyIds
|
|
1618
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1619
|
-
* @permissionScope Read Bookings - Public Data
|
|
1620
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1621
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1622
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1623
|
-
* @permissionScope Manage Bookings
|
|
1624
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1625
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1626
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1627
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1628
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1629
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1630
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1631
|
-
* @permissionScope Picasso private app mega scope
|
|
1632
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1633
|
-
* @applicableIdentity APP
|
|
1634
|
-
* @applicableIdentity VISITOR
|
|
1635
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.GetStrictestBookingPolicy
|
|
1636
|
-
*/
|
|
1637
|
-
export declare function getStrictestBookingPolicy(bookingPolicyIds: string[]): Promise<NonNullablePaths<GetStrictestBookingPolicyResponse, {
|
|
1638
|
-
[P in BookingPolicyNonNullablePaths]: `bookingPolicy.${P}`;
|
|
1639
|
-
}[BookingPolicyNonNullablePaths]>>;
|
|
1640
|
-
/**
|
|
1641
|
-
* Updates a booking policy.
|
|
1642
|
-
*
|
|
1643
|
-
*
|
|
1644
|
-
* Each time the booking policy is updated, `revision` increments by 1.
|
|
1645
|
-
* The current `revision` must be specified when updating the booking policy.
|
|
1646
|
-
* This ensures you're working with the latest booking policy and prevents unintended overwrites.
|
|
1647
|
-
* @param _id - ID of the booking policy.
|
|
1648
|
-
* @public
|
|
1649
|
-
* @requiredField _id
|
|
1650
|
-
* @requiredField bookingPolicy
|
|
1651
|
-
* @requiredField bookingPolicy.revision
|
|
1652
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_UPDATE
|
|
1653
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1654
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1655
|
-
* @permissionScope Manage Bookings
|
|
1656
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1657
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1658
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1659
|
-
* @permissionScope Picasso private app mega scope
|
|
1660
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1661
|
-
* @applicableIdentity APP
|
|
1662
|
-
* @returns Updated booking policy.
|
|
1663
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.UpdateBookingPolicy
|
|
1664
|
-
*/
|
|
1665
|
-
export declare function updateBookingPolicy(_id: string, bookingPolicy: NonNullablePaths<UpdateBookingPolicy, `revision`>): Promise<NonNullablePaths<BookingPolicy, BookingPolicyNonNullablePaths>>;
|
|
1666
|
-
export interface UpdateBookingPolicy {
|
|
1466
|
+
interface UpdateBookingPolicy {
|
|
1667
1467
|
/**
|
|
1668
1468
|
* ID of the booking policy.
|
|
1669
1469
|
* @format GUID
|
|
@@ -1729,93 +1529,6 @@ export interface UpdateBookingPolicy {
|
|
|
1729
1529
|
/** Extensions enabling users to save custom data related to the booking policies. */
|
|
1730
1530
|
extendedFields?: ExtendedFields;
|
|
1731
1531
|
}
|
|
1732
|
-
/**
|
|
1733
|
-
* Sets a booking policy as the default.
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1736
|
-
* Also updates the site's current default policy by setting its `default`
|
|
1737
|
-
* attribute to `false`. If the provided policy is already the site's
|
|
1738
|
-
* default, the call succeeds without changing any `bookingPolicy` object.
|
|
1739
|
-
* @param bookingPolicyId - ID of the booking policy that's set as default.
|
|
1740
|
-
* @public
|
|
1741
|
-
* @requiredField bookingPolicyId
|
|
1742
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_SET_DEFAULT
|
|
1743
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1744
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1745
|
-
* @permissionScope Manage Bookings
|
|
1746
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1747
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1748
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1749
|
-
* @permissionScope Picasso private app mega scope
|
|
1750
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1751
|
-
* @applicableIdentity APP
|
|
1752
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.SetDefaultBookingPolicy
|
|
1753
|
-
*/
|
|
1754
|
-
export declare function setDefaultBookingPolicy(bookingPolicyId: string): Promise<NonNullablePaths<SetDefaultBookingPolicyResponse, {
|
|
1755
|
-
[P in BookingPolicyNonNullablePaths]: `currentDefaultBookingPolicy.${P}`;
|
|
1756
|
-
}[BookingPolicyNonNullablePaths] | {
|
|
1757
|
-
[P in BookingPolicyNonNullablePaths]: `previousDefaultBookingPolicy.${P}`;
|
|
1758
|
-
}[BookingPolicyNonNullablePaths]>>;
|
|
1759
|
-
/**
|
|
1760
|
-
* Deletes a booking policy.
|
|
1761
|
-
*
|
|
1762
|
-
*
|
|
1763
|
-
* You can't delete the default policy without first *setting a different policy as default*
|
|
1764
|
-
* ([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)).
|
|
1765
|
-
* @param bookingPolicyId - ID of the booking policy to delete.
|
|
1766
|
-
* @public
|
|
1767
|
-
* @requiredField bookingPolicyId
|
|
1768
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_DELETE
|
|
1769
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1770
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1771
|
-
* @permissionScope Manage Bookings
|
|
1772
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1773
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1774
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1775
|
-
* @permissionScope Picasso private app mega scope
|
|
1776
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1777
|
-
* @applicableIdentity APP
|
|
1778
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.DeleteBookingPolicy
|
|
1779
|
-
*/
|
|
1780
|
-
export declare function deleteBookingPolicy(bookingPolicyId: string): Promise<void>;
|
|
1781
|
-
/**
|
|
1782
|
-
* Creates a query to retrieve a list of `bookingPolicy` objects.
|
|
1783
|
-
*
|
|
1784
|
-
* The `queryBookingPolicies()` function builds a query to retrieve a list of `bookingPolicy` objects and returns a `BookingPoliciesQueryBuilder` object.
|
|
1785
|
-
*
|
|
1786
|
-
* 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.
|
|
1787
|
-
*
|
|
1788
|
-
* 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.
|
|
1789
|
-
*
|
|
1790
|
-
* `queryBookingPolicies()` runs with the following `BookingPoliciesQueryBuilder` defaults that you can override:
|
|
1791
|
-
*
|
|
1792
|
-
* + `limit` is `50`.
|
|
1793
|
-
* + Sorted by `createdDate` in ascending order.
|
|
1794
|
-
*
|
|
1795
|
-
* 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`.
|
|
1796
|
-
*
|
|
1797
|
-
* 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`.
|
|
1798
|
-
* @public
|
|
1799
|
-
* @permissionScope Read Bookings - Public Data
|
|
1800
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1801
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1802
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1803
|
-
* @permissionScope Manage Bookings
|
|
1804
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1805
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1806
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1807
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1808
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1809
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1810
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1811
|
-
* @permissionScope Picasso private app mega scope
|
|
1812
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1813
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1814
|
-
* @applicableIdentity APP
|
|
1815
|
-
* @applicableIdentity VISITOR
|
|
1816
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.QueryBookingPolicies
|
|
1817
|
-
*/
|
|
1818
|
-
export declare function queryBookingPolicies(): BookingPoliciesQueryBuilder;
|
|
1819
1532
|
interface QueryCursorResult {
|
|
1820
1533
|
cursors: Cursors;
|
|
1821
1534
|
hasNext: () => boolean;
|
|
@@ -1823,13 +1536,13 @@ interface QueryCursorResult {
|
|
|
1823
1536
|
length: number;
|
|
1824
1537
|
pageSize: number;
|
|
1825
1538
|
}
|
|
1826
|
-
|
|
1539
|
+
interface BookingPoliciesQueryResult extends QueryCursorResult {
|
|
1827
1540
|
items: BookingPolicy[];
|
|
1828
1541
|
query: BookingPoliciesQueryBuilder;
|
|
1829
1542
|
next: () => Promise<BookingPoliciesQueryResult>;
|
|
1830
1543
|
prev: () => Promise<BookingPoliciesQueryResult>;
|
|
1831
1544
|
}
|
|
1832
|
-
|
|
1545
|
+
interface BookingPoliciesQueryBuilder {
|
|
1833
1546
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1834
1547
|
* @param value - Value to compare against.
|
|
1835
1548
|
*/
|
|
@@ -1869,35 +1582,7 @@ export interface BookingPoliciesQueryBuilder {
|
|
|
1869
1582
|
skipTo: (cursor: string) => BookingPoliciesQueryBuilder;
|
|
1870
1583
|
find: () => Promise<BookingPoliciesQueryResult>;
|
|
1871
1584
|
}
|
|
1872
|
-
|
|
1873
|
-
* Counts booking policies, given the provided filtering.
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
* See *supported filters*
|
|
1877
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters))
|
|
1878
|
-
* for a complete list of supported filters.
|
|
1879
|
-
* @public
|
|
1880
|
-
* @permissionId BOOKINGS.BOOKING_POLICY_READ
|
|
1881
|
-
* @permissionScope Read Bookings - Public Data
|
|
1882
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1883
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1884
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1885
|
-
* @permissionScope Manage Bookings
|
|
1886
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1887
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1888
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1889
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1890
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1891
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1892
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1893
|
-
* @permissionScope Picasso private app mega scope
|
|
1894
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1895
|
-
* @applicableIdentity APP
|
|
1896
|
-
* @applicableIdentity VISITOR
|
|
1897
|
-
* @fqn wix.bookings.v1.BookingPoliciesService.CountBookingPolicies
|
|
1898
|
-
*/
|
|
1899
|
-
export declare function countBookingPolicies(options?: CountBookingPoliciesOptions): Promise<NonNullablePaths<CountBookingPoliciesResponse, `count`>>;
|
|
1900
|
-
export interface CountBookingPoliciesOptions {
|
|
1585
|
+
interface CountBookingPoliciesOptions {
|
|
1901
1586
|
/**
|
|
1902
1587
|
* Filter to base the count on. See
|
|
1903
1588
|
* supported filters*
|
|
@@ -1906,4 +1591,5 @@ export interface CountBookingPoliciesOptions {
|
|
|
1906
1591
|
*/
|
|
1907
1592
|
filter?: Record<string, any> | null;
|
|
1908
1593
|
}
|
|
1909
|
-
|
|
1594
|
+
|
|
1595
|
+
export { type CreateMissingDefaultPolicyRequest as $, type SetDefaultBookingPolicyRequest as A, type BookingPolicy as B, type CountBookingPoliciesOptions as C, DayOfWeek as D, type ExtendedFields as E, type DeleteBookingPolicyRequest as F, type GetStrictestBookingPolicyResponse as G, type DeleteBookingPolicyResponse as H, type CursorQuery as I, type CursorQueryPagingMethodOneOf as J, type Sorting as K, type LimitEarlyBookingPolicy as L, type Money as M, Namespace as N, type CursorPaging as O, PlacementType as P, type QueryBookingPoliciesRequest as Q, ResolutionMethod as R, type SetDefaultBookingPolicyResponse as S, type QueryBookingPoliciesResponse as T, type UpdateBookingPolicy as U, type CursorPagingMetadata as V, WebhookIdentityType as W, type Cursors as X, type CountBookingPoliciesRequest as Y, type UpdateAllPoliciesRequest as Z, type UpdateAllPoliciesResponse as _, type BookingPoliciesQueryBuilder as a, type CreateMissingDefaultPolicyResponse as a0, type DomainEvent as a1, type DomainEventBodyOneOf as a2, type EntityCreatedEvent as a3, type RestoreInfo as a4, type EntityUpdatedEvent as a5, type EntityDeletedEvent as a6, type ActionEvent as a7, type Empty as a8, type SitePropertiesNotification as a9, type SiteUndeleted as aA, type SitePublished as aB, type SiteUnpublished as aC, type SiteMarkedAsTemplate as aD, type SiteMarkedAsWixSite as aE, type ServiceProvisioned as aF, type ServiceRemoved as aG, type SiteRenamed as aH, type SiteHardDeleted as aI, type NamespaceChanged as aJ, type StudioAssigned as aK, type StudioUnassigned as aL, type SiteUrlChanged as aM, type SitePurgedExternally as aN, type MessageEnvelope as aO, type IdentificationData as aP, type IdentificationDataIdOneOf as aQ, type BaseEventMetadata as aR, type EventMetadata as aS, type BookingPolicyCreatedEnvelope as aT, type BookingPolicyDefaultBookingPolicySetEnvelope as aU, type BookingPolicyDeletedEnvelope as aV, type BookingPolicyUpdatedEnvelope as aW, type BookingPoliciesQueryResult as aX, type SitePropertiesEvent as aa, type Properties as ab, type Categories as ac, type Locale as ad, type Address as ae, type AddressHint as af, type GeoCoordinates as ag, type BusinessSchedule as ah, type TimePeriod as ai, type SpecialHourPeriod as aj, type Multilingual as ak, type SupportedLanguage as al, type ConsentPolicy as am, type Translation as an, type ChangeContext as ao, type ChangeContextPayloadOneOf as ap, type PropertiesChange as aq, type V4SiteCreated as ar, type SiteCloned as as, type MetaSiteSpecialEvent as at, type MetaSiteSpecialEventPayloadOneOf as au, type Asset as av, type SiteCreated as aw, type SiteTransferred as ax, type SiteDeleted as ay, type DeleteContext as az, type CountBookingPoliciesResponse as b, SortOrder as c, State as d, SiteCreatedContext as e, DeleteStatus as f, type PolicyDescription as g, type LimitLateBookingPolicy as h, type BookAfterStartPolicy as i, type CancellationPolicy as j, type ReschedulePolicy as k, type WaitlistPolicy as l, type ParticipantsPolicy as m, type ResourcesPolicy as n, type CancellationFeePolicy as o, type CancellationWindow as p, type CancellationWindowFeeOneOf as q, type SaveCreditCardPolicy as r, type DefaultBookingPolicySet as s, type CreateBookingPolicyRequest as t, type CreateBookingPolicyResponse as u, type GetBookingPolicyRequest as v, type GetBookingPolicyResponse as w, type GetStrictestBookingPolicyRequest as x, type UpdateBookingPolicyRequest as y, type UpdateBookingPolicyResponse as z };
|