@wix/bookings 1.0.342 → 1.0.344
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/cjs/context.d.ts +12 -14
- package/build/cjs/context.js +13 -15
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +12 -16
- package/build/cjs/index.js +13 -17
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +12 -15
- package/build/cjs/meta.js +13 -16
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +12 -14
- package/build/es/context.js +12 -14
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +12 -16
- package/build/es/index.js +12 -16
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +12 -15
- package/build/es/meta.js +12 -15
- package/build/es/meta.js.map +1 -1
- package/package.json +22 -9
- package/build/cjs/index.typings.d.ts +0 -15
- package/build/cjs/index.typings.js +0 -42
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.context.d.ts +0 -3
- package/build/cjs/src/bookings-availability-v1-slot-availability.context.js +0 -17
- package/build/cjs/src/bookings-availability-v1-slot-availability.context.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.http.d.ts +0 -50
- package/build/cjs/src/bookings-availability-v1-slot-availability.http.js +0 -184
- package/build/cjs/src/bookings-availability-v1-slot-availability.http.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.meta.d.ts +0 -13
- package/build/cjs/src/bookings-availability-v1-slot-availability.meta.js +0 -47
- package/build/cjs/src/bookings-availability-v1-slot-availability.meta.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.public.d.ts +0 -8
- package/build/cjs/src/bookings-availability-v1-slot-availability.public.js +0 -15
- package/build/cjs/src/bookings-availability-v1-slot-availability.public.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.types.d.ts +0 -345
- package/build/cjs/src/bookings-availability-v1-slot-availability.types.js +0 -16
- package/build/cjs/src/bookings-availability-v1-slot-availability.types.js.map +0 -1
- package/build/cjs/src/bookings-availability-v1-slot-availability.universal.d.ts +0 -413
- package/build/cjs/src/bookings-availability-v1-slot-availability.universal.js +0 -177
- package/build/cjs/src/bookings-availability-v1-slot-availability.universal.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.context.d.ts +0 -4
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.context.js +0 -29
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.context.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.http.d.ts +0 -222
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.http.js +0 -504
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.http.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.meta.d.ts +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.meta.js +0 -66
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.meta.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.d.ts +0 -9
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.js +0 -20
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.public.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.types.d.ts +0 -831
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.types.js +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.types.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.universal.d.ts +0 -1143
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.universal.js +0 -365
- package/build/cjs/src/bookings-availability-v2-time-slot-availability-time-slots.universal.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.http.d.ts +0 -222
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.http.js +0 -436
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.http.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.types.d.ts +0 -831
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.types.js +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot-event-time-slots.types.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -4
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -29
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -222
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -504
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -66
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts +0 -9
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -20
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts +0 -831
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1115
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -351
- package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot.http.d.ts +0 -223
- package/build/cjs/src/bookings-availability-v2-time-slot.http.js +0 -541
- package/build/cjs/src/bookings-availability-v2-time-slot.http.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot.meta.d.ts +0 -16
- package/build/cjs/src/bookings-availability-v2-time-slot.meta.js +0 -104
- package/build/cjs/src/bookings-availability-v2-time-slot.meta.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot.public.d.ts +0 -11
- package/build/cjs/src/bookings-availability-v2-time-slot.public.js +0 -32
- package/build/cjs/src/bookings-availability-v2-time-slot.public.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot.types.d.ts +0 -805
- package/build/cjs/src/bookings-availability-v2-time-slot.types.js +0 -14
- package/build/cjs/src/bookings-availability-v2-time-slot.types.js.map +0 -1
- package/build/cjs/src/bookings-availability-v2-time-slot.universal.d.ts +0 -1401
- package/build/cjs/src/bookings-availability-v2-time-slot.universal.js +0 -566
- package/build/cjs/src/bookings-availability-v2-time-slot.universal.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.context.d.ts +0 -5
- package/build/cjs/src/bookings-calendar-v1-session.context.js +0 -41
- package/build/cjs/src/bookings-calendar-v1-session.context.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.http.d.ts +0 -54
- package/build/cjs/src/bookings-calendar-v1-session.http.js +0 -337
- package/build/cjs/src/bookings-calendar-v1-session.http.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.meta.d.ts +0 -17
- package/build/cjs/src/bookings-calendar-v1-session.meta.js +0 -85
- package/build/cjs/src/bookings-calendar-v1-session.meta.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.public.d.ts +0 -57
- package/build/cjs/src/bookings-calendar-v1-session.public.js +0 -37
- package/build/cjs/src/bookings-calendar-v1-session.public.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.types.d.ts +0 -1260
- package/build/cjs/src/bookings-calendar-v1-session.types.js +0 -121
- package/build/cjs/src/bookings-calendar-v1-session.types.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v1-session.universal.d.ts +0 -1360
- package/build/cjs/src/bookings-calendar-v1-session.universal.js +0 -428
- package/build/cjs/src/bookings-calendar-v1-session.universal.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.context.d.ts +0 -11
- package/build/cjs/src/bookings-calendar-v2-external-calendar.context.js +0 -113
- package/build/cjs/src/bookings-calendar-v2-external-calendar.context.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.http.d.ts +0 -111
- package/build/cjs/src/bookings-calendar-v2-external-calendar.http.js +0 -325
- package/build/cjs/src/bookings-calendar-v2-external-calendar.http.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.meta.d.ts +0 -29
- package/build/cjs/src/bookings-calendar-v2-external-calendar.meta.js +0 -199
- package/build/cjs/src/bookings-calendar-v2-external-calendar.meta.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.public.d.ts +0 -16
- package/build/cjs/src/bookings-calendar-v2-external-calendar.public.js +0 -80
- package/build/cjs/src/bookings-calendar-v2-external-calendar.public.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.types.d.ts +0 -1525
- package/build/cjs/src/bookings-calendar-v2-external-calendar.types.js +0 -210
- package/build/cjs/src/bookings-calendar-v2-external-calendar.types.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.universal.d.ts +0 -1818
- package/build/cjs/src/bookings-calendar-v2-external-calendar.universal.js +0 -928
- package/build/cjs/src/bookings-calendar-v2-external-calendar.universal.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.http.d.ts +0 -7
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.http.js +0 -42
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.http.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.public.d.ts +0 -4
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.public.js +0 -25
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.public.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.types.d.ts +0 -1115
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.types.js +0 -141
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.types.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.universal.d.ts +0 -1122
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.universal.js +0 -240
- package/build/cjs/src/bookings-calendar-v2-session-feed-event.universal.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.context.d.ts +0 -3
- package/build/cjs/src/bookings-calendar-v2-session-view.context.js +0 -17
- package/build/cjs/src/bookings-calendar-v2-session-view.context.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.http.d.ts +0 -6
- package/build/cjs/src/bookings-calendar-v2-session-view.http.js +0 -53
- package/build/cjs/src/bookings-calendar-v2-session-view.http.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.meta.d.ts +0 -13
- package/build/cjs/src/bookings-calendar-v2-session-view.meta.js +0 -47
- package/build/cjs/src/bookings-calendar-v2-session-view.meta.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.public.d.ts +0 -8
- package/build/cjs/src/bookings-calendar-v2-session-view.public.js +0 -29
- package/build/cjs/src/bookings-calendar-v2-session-view.public.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.types.d.ts +0 -1191
- package/build/cjs/src/bookings-calendar-v2-session-view.types.js +0 -142
- package/build/cjs/src/bookings-calendar-v2-session-view.types.js.map +0 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.universal.d.ts +0 -1207
- package/build/cjs/src/bookings-calendar-v2-session-view.universal.js +0 -235
- package/build/cjs/src/bookings-calendar-v2-session-view.universal.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.context.d.ts +0 -6
- package/build/cjs/src/bookings-catalog-v1-resource.context.js +0 -49
- package/build/cjs/src/bookings-catalog-v1-resource.context.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.http.d.ts +0 -56
- package/build/cjs/src/bookings-catalog-v1-resource.http.js +0 -821
- package/build/cjs/src/bookings-catalog-v1-resource.http.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.meta.d.ts +0 -22
- package/build/cjs/src/bookings-catalog-v1-resource.meta.js +0 -104
- package/build/cjs/src/bookings-catalog-v1-resource.meta.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.public.d.ts +0 -156
- package/build/cjs/src/bookings-catalog-v1-resource.public.js +0 -46
- package/build/cjs/src/bookings-catalog-v1-resource.public.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.types.d.ts +0 -2138
- package/build/cjs/src/bookings-catalog-v1-resource.types.js +0 -126
- package/build/cjs/src/bookings-catalog-v1-resource.types.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-resource.universal.d.ts +0 -1519
- package/build/cjs/src/bookings-catalog-v1-resource.universal.js +0 -510
- package/build/cjs/src/bookings-catalog-v1-resource.universal.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.context.d.ts +0 -9
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.context.js +0 -89
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.context.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.http.d.ts +0 -60
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.http.js +0 -275
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.http.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.meta.d.ts +0 -29
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.meta.js +0 -167
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.meta.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.public.d.ts +0 -111
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.public.js +0 -74
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.public.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.types.d.ts +0 -2051
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.types.js +0 -198
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.types.js.map +0 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.d.ts +0 -2297
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.js +0 -758
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.context.d.ts +0 -3
- package/build/cjs/src/bookings-reader-v2-extended-booking.context.js +0 -17
- package/build/cjs/src/bookings-reader-v2-extended-booking.context.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.http.d.ts +0 -28
- package/build/cjs/src/bookings-reader-v2-extended-booking.http.js +0 -107
- package/build/cjs/src/bookings-reader-v2-extended-booking.http.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.meta.d.ts +0 -13
- package/build/cjs/src/bookings-reader-v2-extended-booking.meta.js +0 -47
- package/build/cjs/src/bookings-reader-v2-extended-booking.meta.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.d.ts +0 -8
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.js +0 -24
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.d.ts +0 -854
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.js +0 -107
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.js.map +0 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.d.ts +0 -890
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.js +0 -255
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.context.d.ts +0 -7
- package/build/cjs/src/bookings-services-v2-service.context.js +0 -65
- package/build/cjs/src/bookings-services-v2-service.context.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.http.d.ts +0 -30
- package/build/cjs/src/bookings-services-v2-service.http.js +0 -395
- package/build/cjs/src/bookings-services-v2-service.http.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.meta.d.ts +0 -23
- package/build/cjs/src/bookings-services-v2-service.meta.js +0 -123
- package/build/cjs/src/bookings-services-v2-service.meta.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.public.d.ts +0 -406
- package/build/cjs/src/bookings-services-v2-service.public.js +0 -79
- package/build/cjs/src/bookings-services-v2-service.public.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.types.d.ts +0 -3909
- package/build/cjs/src/bookings-services-v2-service.types.js +0 -353
- package/build/cjs/src/bookings-services-v2-service.types.js.map +0 -1
- package/build/cjs/src/bookings-services-v2-service.universal.d.ts +0 -3910
- package/build/cjs/src/bookings-services-v2-service.universal.js +0 -811
- package/build/cjs/src/bookings-services-v2-service.universal.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.context.d.ts +0 -6
- package/build/cjs/src/bookings-v1-category.context.js +0 -49
- package/build/cjs/src/bookings-v1-category.context.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.http.d.ts +0 -13
- package/build/cjs/src/bookings-v1-category.http.js +0 -248
- package/build/cjs/src/bookings-v1-category.http.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.meta.d.ts +0 -20
- package/build/cjs/src/bookings-v1-category.meta.js +0 -104
- package/build/cjs/src/bookings-v1-category.meta.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.public.d.ts +0 -14
- package/build/cjs/src/bookings-v1-category.public.js +0 -35
- package/build/cjs/src/bookings-v1-category.public.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.types.d.ts +0 -107
- package/build/cjs/src/bookings-v1-category.types.js +0 -17
- package/build/cjs/src/bookings-v1-category.types.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.universal.d.ts +0 -200
- package/build/cjs/src/bookings-v1-category.universal.js +0 -316
- package/build/cjs/src/bookings-v1-category.universal.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.context.d.ts +0 -6
- package/build/cjs/src/bookings-v2-attendance.context.js +0 -53
- package/build/cjs/src/bookings-v2-attendance.context.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.http.d.ts +0 -63
- package/build/cjs/src/bookings-v2-attendance.http.js +0 -229
- package/build/cjs/src/bookings-v2-attendance.http.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.meta.d.ts +0 -18
- package/build/cjs/src/bookings-v2-attendance.meta.js +0 -104
- package/build/cjs/src/bookings-v2-attendance.meta.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.public.d.ts +0 -14
- package/build/cjs/src/bookings-v2-attendance.public.js +0 -33
- package/build/cjs/src/bookings-v2-attendance.public.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.types.d.ts +0 -303
- package/build/cjs/src/bookings-v2-attendance.types.js +0 -20
- package/build/cjs/src/bookings-v2-attendance.types.js.map +0 -1
- package/build/cjs/src/bookings-v2-attendance.universal.d.ts +0 -496
- package/build/cjs/src/bookings-v2-attendance.universal.js +0 -375
- package/build/cjs/src/bookings-v2-attendance.universal.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.context.d.ts +0 -12
- package/build/cjs/src/bookings-v2-booking.context.js +0 -125
- package/build/cjs/src/bookings-v2-booking.context.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.http.d.ts +0 -191
- package/build/cjs/src/bookings-v2-booking.http.js +0 -696
- package/build/cjs/src/bookings-v2-booking.http.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.meta.d.ts +0 -36
- package/build/cjs/src/bookings-v2-booking.meta.js +0 -218
- package/build/cjs/src/bookings-v2-booking.meta.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.public.d.ts +0 -18
- package/build/cjs/src/bookings-v2-booking.public.js +0 -87
- package/build/cjs/src/bookings-v2-booking.public.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.types.d.ts +0 -3015
- package/build/cjs/src/bookings-v2-booking.types.js +0 -116
- package/build/cjs/src/bookings-v2-booking.types.js.map +0 -1
- package/build/cjs/src/bookings-v2-booking.universal.d.ts +0 -3319
- package/build/cjs/src/bookings-v2-booking.universal.js +0 -1035
- package/build/cjs/src/bookings-v2-booking.universal.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.context.d.ts +0 -4
- package/build/cjs/src/bookings-v2-price-info.context.js +0 -29
- package/build/cjs/src/bookings-v2-price-info.context.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.http.d.ts +0 -60
- package/build/cjs/src/bookings-v2-price-info.http.js +0 -181
- package/build/cjs/src/bookings-v2-price-info.http.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.meta.d.ts +0 -14
- package/build/cjs/src/bookings-v2-price-info.meta.js +0 -66
- package/build/cjs/src/bookings-v2-price-info.meta.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.public.d.ts +0 -9
- package/build/cjs/src/bookings-v2-price-info.public.js +0 -28
- package/build/cjs/src/bookings-v2-price-info.public.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.types.d.ts +0 -651
- package/build/cjs/src/bookings-v2-price-info.types.js +0 -96
- package/build/cjs/src/bookings-v2-price-info.types.js.map +0 -1
- package/build/cjs/src/bookings-v2-price-info.universal.d.ts +0 -737
- package/build/cjs/src/bookings-v2-price-info.universal.js +0 -318
- package/build/cjs/src/bookings-v2-price-info.universal.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -15
- package/build/es/index.typings.js +0 -16
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.context.d.ts +0 -3
- package/build/es/src/bookings-availability-v1-slot-availability.context.js +0 -13
- package/build/es/src/bookings-availability-v1-slot-availability.context.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.http.d.ts +0 -50
- package/build/es/src/bookings-availability-v1-slot-availability.http.js +0 -180
- package/build/es/src/bookings-availability-v1-slot-availability.http.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.meta.d.ts +0 -13
- package/build/es/src/bookings-availability-v1-slot-availability.meta.js +0 -20
- package/build/es/src/bookings-availability-v1-slot-availability.meta.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.public.d.ts +0 -8
- package/build/es/src/bookings-availability-v1-slot-availability.public.js +0 -9
- package/build/es/src/bookings-availability-v1-slot-availability.public.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.types.d.ts +0 -345
- package/build/es/src/bookings-availability-v1-slot-availability.types.js +0 -13
- package/build/es/src/bookings-availability-v1-slot-availability.types.js.map +0 -1
- package/build/es/src/bookings-availability-v1-slot-availability.universal.d.ts +0 -413
- package/build/es/src/bookings-availability-v1-slot-availability.universal.js +0 -150
- package/build/es/src/bookings-availability-v1-slot-availability.universal.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.context.d.ts +0 -4
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.context.js +0 -24
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.context.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.http.d.ts +0 -222
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.http.js +0 -497
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.http.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.meta.d.ts +0 -14
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.meta.js +0 -38
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.meta.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.public.d.ts +0 -9
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.public.js +0 -14
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.public.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.types.d.ts +0 -831
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.types.js +0 -11
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.types.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.universal.d.ts +0 -1143
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.universal.js +0 -337
- package/build/es/src/bookings-availability-v2-time-slot-availability-time-slots.universal.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.http.d.ts +0 -222
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.http.js +0 -429
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.http.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.types.d.ts +0 -831
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.types.js +0 -11
- package/build/es/src/bookings-availability-v2-time-slot-event-time-slots.types.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -4
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -24
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -222
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -497
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -38
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts +0 -9
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -14
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts +0 -831
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -11
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1115
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -323
- package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot.http.d.ts +0 -223
- package/build/es/src/bookings-availability-v2-time-slot.http.js +0 -534
- package/build/es/src/bookings-availability-v2-time-slot.http.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot.meta.d.ts +0 -16
- package/build/es/src/bookings-availability-v2-time-slot.meta.js +0 -74
- package/build/es/src/bookings-availability-v2-time-slot.meta.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot.public.d.ts +0 -11
- package/build/es/src/bookings-availability-v2-time-slot.public.js +0 -24
- package/build/es/src/bookings-availability-v2-time-slot.public.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot.types.d.ts +0 -805
- package/build/es/src/bookings-availability-v2-time-slot.types.js +0 -11
- package/build/es/src/bookings-availability-v2-time-slot.types.js.map +0 -1
- package/build/es/src/bookings-availability-v2-time-slot.universal.d.ts +0 -1401
- package/build/es/src/bookings-availability-v2-time-slot.universal.js +0 -536
- package/build/es/src/bookings-availability-v2-time-slot.universal.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.context.d.ts +0 -5
- package/build/es/src/bookings-calendar-v1-session.context.js +0 -35
- package/build/es/src/bookings-calendar-v1-session.context.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.http.d.ts +0 -54
- package/build/es/src/bookings-calendar-v1-session.http.js +0 -331
- package/build/es/src/bookings-calendar-v1-session.http.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.meta.d.ts +0 -17
- package/build/es/src/bookings-calendar-v1-session.meta.js +0 -56
- package/build/es/src/bookings-calendar-v1-session.meta.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.public.d.ts +0 -57
- package/build/es/src/bookings-calendar-v1-session.public.js +0 -19
- package/build/es/src/bookings-calendar-v1-session.public.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.types.d.ts +0 -1260
- package/build/es/src/bookings-calendar-v1-session.types.js +0 -118
- package/build/es/src/bookings-calendar-v1-session.types.js.map +0 -1
- package/build/es/src/bookings-calendar-v1-session.universal.d.ts +0 -1360
- package/build/es/src/bookings-calendar-v1-session.universal.js +0 -399
- package/build/es/src/bookings-calendar-v1-session.universal.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.context.d.ts +0 -11
- package/build/es/src/bookings-calendar-v2-external-calendar.context.js +0 -101
- package/build/es/src/bookings-calendar-v2-external-calendar.context.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.http.d.ts +0 -111
- package/build/es/src/bookings-calendar-v2-external-calendar.http.js +0 -313
- package/build/es/src/bookings-calendar-v2-external-calendar.http.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.meta.d.ts +0 -29
- package/build/es/src/bookings-calendar-v2-external-calendar.meta.js +0 -164
- package/build/es/src/bookings-calendar-v2-external-calendar.meta.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.public.d.ts +0 -16
- package/build/es/src/bookings-calendar-v2-external-calendar.public.js +0 -49
- package/build/es/src/bookings-calendar-v2-external-calendar.public.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.types.d.ts +0 -1525
- package/build/es/src/bookings-calendar-v2-external-calendar.types.js +0 -207
- package/build/es/src/bookings-calendar-v2-external-calendar.types.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.universal.d.ts +0 -1818
- package/build/es/src/bookings-calendar-v2-external-calendar.universal.js +0 -893
- package/build/es/src/bookings-calendar-v2-external-calendar.universal.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-feed-event.http.d.ts +0 -7
- package/build/es/src/bookings-calendar-v2-session-feed-event.http.js +0 -38
- package/build/es/src/bookings-calendar-v2-session-feed-event.http.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-feed-event.public.d.ts +0 -4
- package/build/es/src/bookings-calendar-v2-session-feed-event.public.js +0 -8
- package/build/es/src/bookings-calendar-v2-session-feed-event.public.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-feed-event.types.d.ts +0 -1115
- package/build/es/src/bookings-calendar-v2-session-feed-event.types.js +0 -138
- package/build/es/src/bookings-calendar-v2-session-feed-event.types.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-feed-event.universal.d.ts +0 -1122
- package/build/es/src/bookings-calendar-v2-session-feed-event.universal.js +0 -213
- package/build/es/src/bookings-calendar-v2-session-feed-event.universal.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.context.d.ts +0 -3
- package/build/es/src/bookings-calendar-v2-session-view.context.js +0 -13
- package/build/es/src/bookings-calendar-v2-session-view.context.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.http.d.ts +0 -6
- package/build/es/src/bookings-calendar-v2-session-view.http.js +0 -49
- package/build/es/src/bookings-calendar-v2-session-view.http.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.meta.d.ts +0 -13
- package/build/es/src/bookings-calendar-v2-session-view.meta.js +0 -20
- package/build/es/src/bookings-calendar-v2-session-view.meta.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.public.d.ts +0 -8
- package/build/es/src/bookings-calendar-v2-session-view.public.js +0 -10
- package/build/es/src/bookings-calendar-v2-session-view.public.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.types.d.ts +0 -1191
- package/build/es/src/bookings-calendar-v2-session-view.types.js +0 -139
- package/build/es/src/bookings-calendar-v2-session-view.types.js.map +0 -1
- package/build/es/src/bookings-calendar-v2-session-view.universal.d.ts +0 -1207
- package/build/es/src/bookings-calendar-v2-session-view.universal.js +0 -208
- package/build/es/src/bookings-calendar-v2-session-view.universal.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.context.d.ts +0 -6
- package/build/es/src/bookings-catalog-v1-resource.context.js +0 -42
- package/build/es/src/bookings-catalog-v1-resource.context.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.http.d.ts +0 -56
- package/build/es/src/bookings-catalog-v1-resource.http.js +0 -814
- package/build/es/src/bookings-catalog-v1-resource.http.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.meta.d.ts +0 -22
- package/build/es/src/bookings-catalog-v1-resource.meta.js +0 -74
- package/build/es/src/bookings-catalog-v1-resource.meta.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.public.d.ts +0 -156
- package/build/es/src/bookings-catalog-v1-resource.public.js +0 -25
- package/build/es/src/bookings-catalog-v1-resource.public.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.types.d.ts +0 -2138
- package/build/es/src/bookings-catalog-v1-resource.types.js +0 -123
- package/build/es/src/bookings-catalog-v1-resource.types.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-resource.universal.d.ts +0 -1519
- package/build/es/src/bookings-catalog-v1-resource.universal.js +0 -480
- package/build/es/src/bookings-catalog-v1-resource.universal.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.context.d.ts +0 -9
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.context.js +0 -79
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.context.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.http.d.ts +0 -60
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.http.js +0 -265
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.http.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.meta.d.ts +0 -29
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.meta.js +0 -134
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.meta.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.public.d.ts +0 -111
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.public.js +0 -40
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.public.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.types.d.ts +0 -2051
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.types.js +0 -195
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.types.js.map +0 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.d.ts +0 -2297
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.js +0 -725
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.context.d.ts +0 -3
- package/build/es/src/bookings-reader-v2-extended-booking.context.js +0 -13
- package/build/es/src/bookings-reader-v2-extended-booking.context.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.http.d.ts +0 -28
- package/build/es/src/bookings-reader-v2-extended-booking.http.js +0 -103
- package/build/es/src/bookings-reader-v2-extended-booking.http.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.meta.d.ts +0 -13
- package/build/es/src/bookings-reader-v2-extended-booking.meta.js +0 -20
- package/build/es/src/bookings-reader-v2-extended-booking.meta.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.public.d.ts +0 -8
- package/build/es/src/bookings-reader-v2-extended-booking.public.js +0 -9
- package/build/es/src/bookings-reader-v2-extended-booking.public.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.types.d.ts +0 -854
- package/build/es/src/bookings-reader-v2-extended-booking.types.js +0 -104
- package/build/es/src/bookings-reader-v2-extended-booking.types.js.map +0 -1
- package/build/es/src/bookings-reader-v2-extended-booking.universal.d.ts +0 -890
- package/build/es/src/bookings-reader-v2-extended-booking.universal.js +0 -228
- package/build/es/src/bookings-reader-v2-extended-booking.universal.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.context.d.ts +0 -7
- package/build/es/src/bookings-services-v2-service.context.js +0 -57
- package/build/es/src/bookings-services-v2-service.context.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.http.d.ts +0 -30
- package/build/es/src/bookings-services-v2-service.http.js +0 -387
- package/build/es/src/bookings-services-v2-service.http.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.meta.d.ts +0 -23
- package/build/es/src/bookings-services-v2-service.meta.js +0 -92
- package/build/es/src/bookings-services-v2-service.meta.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.public.d.ts +0 -406
- package/build/es/src/bookings-services-v2-service.public.js +0 -30
- package/build/es/src/bookings-services-v2-service.public.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.types.d.ts +0 -3909
- package/build/es/src/bookings-services-v2-service.types.js +0 -350
- package/build/es/src/bookings-services-v2-service.types.js.map +0 -1
- package/build/es/src/bookings-services-v2-service.universal.d.ts +0 -3910
- package/build/es/src/bookings-services-v2-service.universal.js +0 -780
- package/build/es/src/bookings-services-v2-service.universal.js.map +0 -1
- package/build/es/src/bookings-v1-category.context.d.ts +0 -6
- package/build/es/src/bookings-v1-category.context.js +0 -42
- package/build/es/src/bookings-v1-category.context.js.map +0 -1
- package/build/es/src/bookings-v1-category.http.d.ts +0 -13
- package/build/es/src/bookings-v1-category.http.js +0 -241
- package/build/es/src/bookings-v1-category.http.js.map +0 -1
- package/build/es/src/bookings-v1-category.meta.d.ts +0 -20
- package/build/es/src/bookings-v1-category.meta.js +0 -74
- package/build/es/src/bookings-v1-category.meta.js.map +0 -1
- package/build/es/src/bookings-v1-category.public.d.ts +0 -14
- package/build/es/src/bookings-v1-category.public.js +0 -25
- package/build/es/src/bookings-v1-category.public.js.map +0 -1
- package/build/es/src/bookings-v1-category.types.d.ts +0 -107
- package/build/es/src/bookings-v1-category.types.js +0 -14
- package/build/es/src/bookings-v1-category.types.js.map +0 -1
- package/build/es/src/bookings-v1-category.universal.d.ts +0 -200
- package/build/es/src/bookings-v1-category.universal.js +0 -286
- package/build/es/src/bookings-v1-category.universal.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.context.d.ts +0 -6
- package/build/es/src/bookings-v2-attendance.context.js +0 -46
- package/build/es/src/bookings-v2-attendance.context.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.http.d.ts +0 -63
- package/build/es/src/bookings-v2-attendance.http.js +0 -222
- package/build/es/src/bookings-v2-attendance.http.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.meta.d.ts +0 -18
- package/build/es/src/bookings-v2-attendance.meta.js +0 -74
- package/build/es/src/bookings-v2-attendance.meta.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.public.d.ts +0 -14
- package/build/es/src/bookings-v2-attendance.public.js +0 -24
- package/build/es/src/bookings-v2-attendance.public.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.types.d.ts +0 -303
- package/build/es/src/bookings-v2-attendance.types.js +0 -17
- package/build/es/src/bookings-v2-attendance.types.js.map +0 -1
- package/build/es/src/bookings-v2-attendance.universal.d.ts +0 -496
- package/build/es/src/bookings-v2-attendance.universal.js +0 -345
- package/build/es/src/bookings-v2-attendance.universal.js.map +0 -1
- package/build/es/src/bookings-v2-booking.context.d.ts +0 -12
- package/build/es/src/bookings-v2-booking.context.js +0 -112
- package/build/es/src/bookings-v2-booking.context.js.map +0 -1
- package/build/es/src/bookings-v2-booking.http.d.ts +0 -191
- package/build/es/src/bookings-v2-booking.http.js +0 -683
- package/build/es/src/bookings-v2-booking.http.js.map +0 -1
- package/build/es/src/bookings-v2-booking.meta.d.ts +0 -36
- package/build/es/src/bookings-v2-booking.meta.js +0 -182
- package/build/es/src/bookings-v2-booking.meta.js.map +0 -1
- package/build/es/src/bookings-v2-booking.public.d.ts +0 -18
- package/build/es/src/bookings-v2-booking.public.js +0 -55
- package/build/es/src/bookings-v2-booking.public.js.map +0 -1
- package/build/es/src/bookings-v2-booking.types.d.ts +0 -3015
- package/build/es/src/bookings-v2-booking.types.js +0 -113
- package/build/es/src/bookings-v2-booking.types.js.map +0 -1
- package/build/es/src/bookings-v2-booking.universal.d.ts +0 -3319
- package/build/es/src/bookings-v2-booking.universal.js +0 -999
- package/build/es/src/bookings-v2-booking.universal.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.context.d.ts +0 -4
- package/build/es/src/bookings-v2-price-info.context.js +0 -24
- package/build/es/src/bookings-v2-price-info.context.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.http.d.ts +0 -60
- package/build/es/src/bookings-v2-price-info.http.js +0 -176
- package/build/es/src/bookings-v2-price-info.http.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.meta.d.ts +0 -14
- package/build/es/src/bookings-v2-price-info.meta.js +0 -38
- package/build/es/src/bookings-v2-price-info.meta.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.public.d.ts +0 -9
- package/build/es/src/bookings-v2-price-info.public.js +0 -14
- package/build/es/src/bookings-v2-price-info.public.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.types.d.ts +0 -651
- package/build/es/src/bookings-v2-price-info.types.js +0 -93
- package/build/es/src/bookings-v2-price-info.types.js.map +0 -1
- package/build/es/src/bookings-v2-price-info.universal.d.ts +0 -737
- package/build/es/src/bookings-v2-price-info.universal.js +0 -290
- package/build/es/src/bookings-v2-price-info.universal.js.map +0 -1
|
@@ -1,3910 +0,0 @@
|
|
|
1
|
-
import { EventDefinition } from '@wix/sdk-types';
|
|
2
|
-
/** The `Service` object represents the business offering that a business provides to its customers. */
|
|
3
|
-
export interface Service {
|
|
4
|
-
/**
|
|
5
|
-
* Service ID.
|
|
6
|
-
* @readonly
|
|
7
|
-
*/
|
|
8
|
-
_id?: string | null;
|
|
9
|
-
/**
|
|
10
|
-
* Service type.
|
|
11
|
-
*
|
|
12
|
-
* Supported Values:
|
|
13
|
-
* - "APPOINTMENT"
|
|
14
|
-
* - "CLASS"
|
|
15
|
-
* - "COURSE"
|
|
16
|
-
*
|
|
17
|
-
*/
|
|
18
|
-
type?: ServiceType;
|
|
19
|
-
/** Order of a service within a category. */
|
|
20
|
-
sortOrder?: number | null;
|
|
21
|
-
name?: string | null;
|
|
22
|
-
description?: string | null;
|
|
23
|
-
tagLine?: string | null;
|
|
24
|
-
/** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
|
|
25
|
-
defaultCapacity?: number | null;
|
|
26
|
-
/** Media associated with the service. */
|
|
27
|
-
media?: Media;
|
|
28
|
-
/** Whether the service is hidden from the site. */
|
|
29
|
-
hidden?: boolean | null;
|
|
30
|
-
/** The category the service is associated with. */
|
|
31
|
-
category?: V2Category;
|
|
32
|
-
/** The form used when booking the service. */
|
|
33
|
-
form?: Form;
|
|
34
|
-
/** Payment options for booking the service. */
|
|
35
|
-
payment?: Payment;
|
|
36
|
-
/** Online booking settings. */
|
|
37
|
-
onlineBooking?: OnlineBooking;
|
|
38
|
-
/** Conferencing options for this service. */
|
|
39
|
-
conferencing?: Conferencing;
|
|
40
|
-
/**
|
|
41
|
-
* The locations this service is offered at.
|
|
42
|
-
* In case of multiple (more than 1) location, All locations must be of type `BUSINESS`.
|
|
43
|
-
* For courses only: Currently, only 1 location is supported, for all location types.
|
|
44
|
-
*/
|
|
45
|
-
locations?: Location[];
|
|
46
|
-
/** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */
|
|
47
|
-
bookingPolicy?: BookingPolicy;
|
|
48
|
-
/** The service's schedule, which can be used to manage the service's sessions. */
|
|
49
|
-
schedule?: Schedule;
|
|
50
|
-
/** IDs of the staff members providing the service. For appointments only. */
|
|
51
|
-
staffMemberIds?: string[];
|
|
52
|
-
/**
|
|
53
|
-
* A slug is the last part of the URL address that serves as a unique identifier of the service.
|
|
54
|
-
* The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
|
|
55
|
-
* @readonly
|
|
56
|
-
*/
|
|
57
|
-
supportedSlugs?: Slug[];
|
|
58
|
-
/**
|
|
59
|
-
* The main slug for the service. `mainSlug` is either taken from the current service name or is a custom slug set by the business owner.
|
|
60
|
-
* `mainSlug` is used to construct the service's URLs.
|
|
61
|
-
* @readonly
|
|
62
|
-
*/
|
|
63
|
-
mainSlug?: Slug;
|
|
64
|
-
/**
|
|
65
|
-
* URLs to various service-related pages, such as the calendar page and the booking page.
|
|
66
|
-
* @readonly
|
|
67
|
-
*/
|
|
68
|
-
urls?: URLs;
|
|
69
|
-
/**
|
|
70
|
-
* Extensions enabling users to save custom data related to the service.
|
|
71
|
-
* @readonly
|
|
72
|
-
*/
|
|
73
|
-
extendedFields?: ExtendedFields;
|
|
74
|
-
/** Custom SEO data for the service. */
|
|
75
|
-
seoData?: SeoSchema;
|
|
76
|
-
/**
|
|
77
|
-
* Date and time the service was created.
|
|
78
|
-
* @readonly
|
|
79
|
-
*/
|
|
80
|
-
_createdDate?: Date;
|
|
81
|
-
/**
|
|
82
|
-
* Date and time the service was updated.
|
|
83
|
-
* @readonly
|
|
84
|
-
*/
|
|
85
|
-
_updatedDate?: Date;
|
|
86
|
-
/**
|
|
87
|
-
* Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.
|
|
88
|
-
* @readonly
|
|
89
|
-
*/
|
|
90
|
-
revision?: string | null;
|
|
91
|
-
}
|
|
92
|
-
export declare enum ServiceType {
|
|
93
|
-
UNKNOWN_SERVICE_TYPE = "UNKNOWN_SERVICE_TYPE",
|
|
94
|
-
/** Service is an appointment. */
|
|
95
|
-
APPOINTMENT = "APPOINTMENT",
|
|
96
|
-
/** Service is a class. */
|
|
97
|
-
CLASS = "CLASS",
|
|
98
|
-
/** Service is a course. */
|
|
99
|
-
COURSE = "COURSE"
|
|
100
|
-
}
|
|
101
|
-
export interface Media {
|
|
102
|
-
/** Media items associated with the service. */
|
|
103
|
-
items?: MediaItem[];
|
|
104
|
-
/** Primary media associated with the service. */
|
|
105
|
-
mainMedia?: MediaItem;
|
|
106
|
-
/** Cover media associated with the service. */
|
|
107
|
-
coverMedia?: MediaItem;
|
|
108
|
-
}
|
|
109
|
-
export interface MediaItem extends MediaItemItemOneOf {
|
|
110
|
-
/** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
|
|
111
|
-
image?: string;
|
|
112
|
-
}
|
|
113
|
-
/** @oneof */
|
|
114
|
-
export interface MediaItemItemOneOf {
|
|
115
|
-
/** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
|
|
116
|
-
image?: string;
|
|
117
|
-
}
|
|
118
|
-
export interface V2Category {
|
|
119
|
-
/** Category ID. */
|
|
120
|
-
_id?: string;
|
|
121
|
-
/**
|
|
122
|
-
* Category name.
|
|
123
|
-
* @readonly
|
|
124
|
-
*/
|
|
125
|
-
name?: string | null;
|
|
126
|
-
/**
|
|
127
|
-
* Order of a category within a category list.
|
|
128
|
-
* @readonly
|
|
129
|
-
*/
|
|
130
|
-
sortOrder?: number | null;
|
|
131
|
-
}
|
|
132
|
-
export interface Form {
|
|
133
|
-
/**
|
|
134
|
-
* ID of the form associated with the service.
|
|
135
|
-
* Form information submitted when booking, including contact details, participants, and other form fields, set up for the service.
|
|
136
|
-
*/
|
|
137
|
-
_id?: string;
|
|
138
|
-
}
|
|
139
|
-
export interface FormSettings {
|
|
140
|
-
/** Whether the service booking form should be hidden from the site. */
|
|
141
|
-
hidden?: boolean | null;
|
|
142
|
-
}
|
|
143
|
-
export interface Payment extends PaymentRateOneOf {
|
|
144
|
-
/**
|
|
145
|
-
* The details for the fixed price of the service.
|
|
146
|
-
*
|
|
147
|
-
* Required when: `rateType` is `FIXED`
|
|
148
|
-
*/
|
|
149
|
-
fixed?: FixedPayment;
|
|
150
|
-
/**
|
|
151
|
-
* The details for the custom price of the service.
|
|
152
|
-
*
|
|
153
|
-
* Required when: `rateType` is `CUSTOM`
|
|
154
|
-
*/
|
|
155
|
-
custom?: CustomPayment;
|
|
156
|
-
/**
|
|
157
|
-
* The details for the varied pricing of the service.
|
|
158
|
-
* Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).
|
|
159
|
-
*
|
|
160
|
-
* Required when: `rateType` is `VARIED`
|
|
161
|
-
*/
|
|
162
|
-
varied?: VariedPayment;
|
|
163
|
-
/**
|
|
164
|
-
* The rate the customer is expected to pay for the service.
|
|
165
|
-
* Can be:
|
|
166
|
-
* - `FIXED`: The service has a fixed price.
|
|
167
|
-
* - `CUSTOM`: The service has a custom price, expressed as a price description.
|
|
168
|
-
* - `VARIED`: This service is offered with a set of different prices based on different terms.
|
|
169
|
-
* - `NO_FEE`: This service is offered free of charge.
|
|
170
|
-
*/
|
|
171
|
-
rateType?: RateType;
|
|
172
|
-
/** The payment options a customer can use to pay for the service. */
|
|
173
|
-
options?: PaymentOptions;
|
|
174
|
-
/**
|
|
175
|
-
* IDs of pricing plans that can be used as payment for the service.
|
|
176
|
-
* @readonly
|
|
177
|
-
*/
|
|
178
|
-
pricingPlanIds?: string[];
|
|
179
|
-
}
|
|
180
|
-
/** @oneof */
|
|
181
|
-
export interface PaymentRateOneOf {
|
|
182
|
-
/**
|
|
183
|
-
* The details for the fixed price of the service.
|
|
184
|
-
*
|
|
185
|
-
* Required when: `rateType` is `FIXED`
|
|
186
|
-
*/
|
|
187
|
-
fixed?: FixedPayment;
|
|
188
|
-
/**
|
|
189
|
-
* The details for the custom price of the service.
|
|
190
|
-
*
|
|
191
|
-
* Required when: `rateType` is `CUSTOM`
|
|
192
|
-
*/
|
|
193
|
-
custom?: CustomPayment;
|
|
194
|
-
/**
|
|
195
|
-
* The details for the varied pricing of the service.
|
|
196
|
-
* Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).
|
|
197
|
-
*
|
|
198
|
-
* Required when: `rateType` is `VARIED`
|
|
199
|
-
*/
|
|
200
|
-
varied?: VariedPayment;
|
|
201
|
-
}
|
|
202
|
-
export declare enum RateType {
|
|
203
|
-
UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
|
|
204
|
-
/** The service has a fixed price. */
|
|
205
|
-
FIXED = "FIXED",
|
|
206
|
-
/** The service has a custom price, expressed as a price description. */
|
|
207
|
-
CUSTOM = "CUSTOM",
|
|
208
|
-
/** This service is offered with a set of different prices based on different terms. */
|
|
209
|
-
VARIED = "VARIED",
|
|
210
|
-
/** This service is offered free of charge. */
|
|
211
|
-
NO_FEE = "NO_FEE"
|
|
212
|
-
}
|
|
213
|
-
export interface FixedPayment {
|
|
214
|
-
/**
|
|
215
|
-
* The fixed price required to book the service.
|
|
216
|
-
*
|
|
217
|
-
* Required when: `rateType` is `FIXED`
|
|
218
|
-
*/
|
|
219
|
-
price?: Money;
|
|
220
|
-
/**
|
|
221
|
-
* The deposit price required to book the service.
|
|
222
|
-
*
|
|
223
|
-
* Required when: `rateType` is `FIXED` and `paymentOptions.deposit` is `true`
|
|
224
|
-
*/
|
|
225
|
-
deposit?: Money;
|
|
226
|
-
}
|
|
227
|
-
/**
|
|
228
|
-
* Money.
|
|
229
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
230
|
-
*/
|
|
231
|
-
export interface Money {
|
|
232
|
-
/** 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. */
|
|
233
|
-
value?: string;
|
|
234
|
-
/** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
|
|
235
|
-
currency?: string;
|
|
236
|
-
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
237
|
-
formattedValue?: string | null;
|
|
238
|
-
}
|
|
239
|
-
export interface CustomPayment {
|
|
240
|
-
/** A custom description explaining to the customer how to pay for the service. */
|
|
241
|
-
description?: string | null;
|
|
242
|
-
}
|
|
243
|
-
export interface VariedPayment {
|
|
244
|
-
/** The default price for the service without any variants. It will also be used as the default price for any new variant. */
|
|
245
|
-
defaultPrice?: Money;
|
|
246
|
-
/**
|
|
247
|
-
* The deposit price required to book the service.
|
|
248
|
-
*
|
|
249
|
-
* Required when: `rateType` is `VARIED` and `paymentOptions.deposit` is `true`
|
|
250
|
-
*/
|
|
251
|
-
deposit?: Money;
|
|
252
|
-
/**
|
|
253
|
-
* The minimal price a customer may pay for this service, based on its variants.
|
|
254
|
-
* @readonly
|
|
255
|
-
*/
|
|
256
|
-
minPrice?: Money;
|
|
257
|
-
/**
|
|
258
|
-
* The maximum price a customer may pay for this service, based on its variants.
|
|
259
|
-
* @readonly
|
|
260
|
-
*/
|
|
261
|
-
maxPrice?: Money;
|
|
262
|
-
}
|
|
263
|
-
export interface PaymentOptions {
|
|
264
|
-
/**
|
|
265
|
-
* Customers can pay for the service online.
|
|
266
|
-
* When `true`:
|
|
267
|
-
* + `rateType` must be either `FIXED` or `VARIED`.
|
|
268
|
-
* + `fixed.price` or `varied.default_price` must be specified respectively. Read more about [getting paid online](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online).
|
|
269
|
-
*/
|
|
270
|
-
online?: boolean | null;
|
|
271
|
-
/** Customers can pay for the service in person. */
|
|
272
|
-
inPerson?: boolean | null;
|
|
273
|
-
/**
|
|
274
|
-
* This service requires a deposit to be made online in order to book it.
|
|
275
|
-
* When `true`:
|
|
276
|
-
* + `rateType` must be `VARIED` or `FIXED`.
|
|
277
|
-
* + A `deposit` must be specified.
|
|
278
|
-
*/
|
|
279
|
-
deposit?: boolean | null;
|
|
280
|
-
/** Customers can pay for the service using a pricing plan. */
|
|
281
|
-
pricingPlan?: boolean | null;
|
|
282
|
-
}
|
|
283
|
-
export interface OnlineBooking {
|
|
284
|
-
/**
|
|
285
|
-
* Whether this service can be booked online.
|
|
286
|
-
* When set to `true`, customers can book the service online. Configuring the payment options is done via `service.payment` property.
|
|
287
|
-
* When set to `false`, customers cannot book the service online, and the service can only be paid for in person.
|
|
288
|
-
*/
|
|
289
|
-
enabled?: boolean | null;
|
|
290
|
-
/** Booking the service requires approval by the business owner. */
|
|
291
|
-
requireManualApproval?: boolean | null;
|
|
292
|
-
/** Multiple customers can request to book the same time slot. Relevant when `requireManualApproval` is `true`. */
|
|
293
|
-
allowMultipleRequests?: boolean | null;
|
|
294
|
-
}
|
|
295
|
-
export interface Conferencing {
|
|
296
|
-
/** Whether a conference link is generated for the service's sessions. */
|
|
297
|
-
enabled?: boolean | null;
|
|
298
|
-
}
|
|
299
|
-
export interface Location extends LocationOptionsOneOf {
|
|
300
|
-
/** The service is offered at the referenced business location, the location has to reference a location from the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
|
|
301
|
-
business?: BusinessLocationOptions;
|
|
302
|
-
/** The service is offered at a custom location. */
|
|
303
|
-
custom?: CustomLocationOptions;
|
|
304
|
-
/**
|
|
305
|
-
* The type of location:
|
|
306
|
-
* - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
|
|
307
|
-
* - `BUSINESS`: A business location, as defined for the by the Business Info [Locations API](https://www.wix.com/velo/reference/wix-business-tools-v2/locations).
|
|
308
|
-
* - `CUSTOMER`: Will be determined by the customer. For appointments only.
|
|
309
|
-
*/
|
|
310
|
-
type?: LocationType;
|
|
311
|
-
/**
|
|
312
|
-
* The location address, based on the location `type`. If `type` is `CUSTOMER`, this address is empty.
|
|
313
|
-
* @readonly
|
|
314
|
-
*/
|
|
315
|
-
calculatedAddress?: Address;
|
|
316
|
-
}
|
|
317
|
-
/** @oneof */
|
|
318
|
-
export interface LocationOptionsOneOf {
|
|
319
|
-
/** The service is offered at the referenced business location, the location has to reference a location from the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
|
|
320
|
-
business?: BusinessLocationOptions;
|
|
321
|
-
/** The service is offered at a custom location. */
|
|
322
|
-
custom?: CustomLocationOptions;
|
|
323
|
-
}
|
|
324
|
-
export declare enum LocationType {
|
|
325
|
-
UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
|
|
326
|
-
/** The location is unique to this service and isn't defined as one of the business locations. `CUSTOM` is the equivalent of the `OWNER_CUSTOM` location type in [Schedules & Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions). */
|
|
327
|
-
CUSTOM = "CUSTOM",
|
|
328
|
-
/** The location is one of the business locations available using the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
|
|
329
|
-
BUSINESS = "BUSINESS",
|
|
330
|
-
/** The location can be determined by the customer and is not set up beforehand. This is applicable to services of type `APPOINTMENT` only. */
|
|
331
|
-
CUSTOMER = "CUSTOMER"
|
|
332
|
-
}
|
|
333
|
-
export interface Address extends AddressStreetOneOf {
|
|
334
|
-
/** Street name and number. */
|
|
335
|
-
streetAddress?: StreetAddress;
|
|
336
|
-
/** Main address line, usually street and number as free text. */
|
|
337
|
-
addressLine1?: string | null;
|
|
338
|
-
/** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
339
|
-
country?: string | null;
|
|
340
|
-
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
|
|
341
|
-
subdivision?: string | null;
|
|
342
|
-
/** City name. */
|
|
343
|
-
city?: string | null;
|
|
344
|
-
/** Postal or zip code. */
|
|
345
|
-
postalCode?: string | null;
|
|
346
|
-
/** Full address of the location. */
|
|
347
|
-
formatted?: string | null;
|
|
348
|
-
}
|
|
349
|
-
/** @oneof */
|
|
350
|
-
export interface AddressStreetOneOf {
|
|
351
|
-
/** Street name and number. */
|
|
352
|
-
streetAddress?: StreetAddress;
|
|
353
|
-
/** Main address line, usually street and number as free text. */
|
|
354
|
-
addressLine?: string | null;
|
|
355
|
-
}
|
|
356
|
-
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
357
|
-
export interface StreetAddress {
|
|
358
|
-
/** Street number. */
|
|
359
|
-
number?: string;
|
|
360
|
-
/** Street name. */
|
|
361
|
-
name?: string;
|
|
362
|
-
/** Apartment number. */
|
|
363
|
-
apt?: string;
|
|
364
|
-
}
|
|
365
|
-
export interface AddressLocation {
|
|
366
|
-
/** Address latitude. */
|
|
367
|
-
latitude?: number | null;
|
|
368
|
-
/** Address longitude. */
|
|
369
|
-
longitude?: number | null;
|
|
370
|
-
}
|
|
371
|
-
export interface BusinessLocationOptions {
|
|
372
|
-
/** Business location ID. */
|
|
373
|
-
_id?: string;
|
|
374
|
-
/**
|
|
375
|
-
* Business location name.
|
|
376
|
-
* @readonly
|
|
377
|
-
*/
|
|
378
|
-
name?: string;
|
|
379
|
-
/**
|
|
380
|
-
* Whether this is the default location. There can only be 1 default location per site. The default location can't be archived.
|
|
381
|
-
* @readonly
|
|
382
|
-
*/
|
|
383
|
-
default?: boolean | null;
|
|
384
|
-
/**
|
|
385
|
-
* Business location address. The address is derived from the business location and is read-only.
|
|
386
|
-
* @readonly
|
|
387
|
-
*/
|
|
388
|
-
address?: Address;
|
|
389
|
-
}
|
|
390
|
-
export interface CustomLocationOptions {
|
|
391
|
-
/** A custom address for the location. */
|
|
392
|
-
address?: Address;
|
|
393
|
-
}
|
|
394
|
-
/**
|
|
395
|
-
* `BookingPolicy` is the main entity of `BookingPolicyService` and specifies a set of rules for booking a service
|
|
396
|
-
* by visitors and members.
|
|
397
|
-
*
|
|
398
|
-
* Each `BookingPolicy` consists of a number of sub-policies. When the Bookings App is provisioned to a meta site then a
|
|
399
|
-
* default `BookingPolicy` will be created with defaults for each of these sub-policies. This also applies when a request
|
|
400
|
-
* is received to create a new `BookingPolicy` and one or more of these sub-policies are not provided.
|
|
401
|
-
*
|
|
402
|
-
* Sub-policies are defined in separate objects as specified below.
|
|
403
|
-
*
|
|
404
|
-
* - The `LimitEarlyBookingPolicy` object defines the policy for limiting early bookings.
|
|
405
|
-
* - The `LimitLateBookingPolicy` object defines the policy for limiting late bookings.
|
|
406
|
-
* - The `BookAfterStartPolicy` object defines the policy for booking after the start of the schedule.
|
|
407
|
-
* - The `CancellationPolicy` object defines the policy for canceling a booked entity.
|
|
408
|
-
* - The `ReschedulePolicy` object defines the policy for rescheduling booked entity.
|
|
409
|
-
* - The `WaitlistPolicy` object defines the policy for a waitlist.
|
|
410
|
-
* - The `ParticipantsPolicy` object defines the policy regarding the participants per booking.
|
|
411
|
-
* - The `ResourcesPolicy` object defines the policy regarding the resources per booking.
|
|
412
|
-
*
|
|
413
|
-
* By default each sub-policy is disabled. A more detailed specification of the default settings of each sub-policy
|
|
414
|
-
* can be found in the description of the corresponding object.
|
|
415
|
-
*
|
|
416
|
-
* Partial updates are supported on the main entity level, however in order to update a sub-policy the client needs to provide the whole sub-policy object.
|
|
417
|
-
*/
|
|
418
|
-
export interface BookingPolicy {
|
|
419
|
-
/** The ID to the policy for the booking. */
|
|
420
|
-
_id?: string;
|
|
421
|
-
/**
|
|
422
|
-
* Date and time the policy was created.
|
|
423
|
-
* @readonly
|
|
424
|
-
*/
|
|
425
|
-
_createdDate?: Date;
|
|
426
|
-
/**
|
|
427
|
-
* Date and time the policy was updated.
|
|
428
|
-
* @readonly
|
|
429
|
-
*/
|
|
430
|
-
_updatedDate?: Date;
|
|
431
|
-
/**
|
|
432
|
-
* Name of the policy.
|
|
433
|
-
* @readonly
|
|
434
|
-
*/
|
|
435
|
-
name?: string | null;
|
|
436
|
-
/**
|
|
437
|
-
* Custom description for the policy. This policy is displayed to the participant.
|
|
438
|
-
* @readonly
|
|
439
|
-
*/
|
|
440
|
-
customPolicyDescription?: PolicyDescription;
|
|
441
|
-
/**
|
|
442
|
-
* Whether the policy is the default for the meta site.
|
|
443
|
-
* @readonly
|
|
444
|
-
*/
|
|
445
|
-
default?: boolean | null;
|
|
446
|
-
/**
|
|
447
|
-
* Policy for limiting early bookings.
|
|
448
|
-
* @readonly
|
|
449
|
-
*/
|
|
450
|
-
limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;
|
|
451
|
-
/**
|
|
452
|
-
* Policy for limiting late bookings.
|
|
453
|
-
* @readonly
|
|
454
|
-
*/
|
|
455
|
-
limitLateBookingPolicy?: LimitLateBookingPolicy;
|
|
456
|
-
/**
|
|
457
|
-
* Policy on booking an entity after the start of the schedule.
|
|
458
|
-
* @readonly
|
|
459
|
-
*/
|
|
460
|
-
bookAfterStartPolicy?: BookAfterStartPolicy;
|
|
461
|
-
/**
|
|
462
|
-
* Policy for canceling a booked entity.
|
|
463
|
-
* @readonly
|
|
464
|
-
*/
|
|
465
|
-
cancellationPolicy?: CancellationPolicy;
|
|
466
|
-
/**
|
|
467
|
-
* Policy for rescheduling a booked entity.
|
|
468
|
-
* @readonly
|
|
469
|
-
*/
|
|
470
|
-
reschedulePolicy?: ReschedulePolicy;
|
|
471
|
-
/**
|
|
472
|
-
* Waitlist policy for the service.
|
|
473
|
-
* @readonly
|
|
474
|
-
*/
|
|
475
|
-
waitlistPolicy?: WaitlistPolicy;
|
|
476
|
-
/**
|
|
477
|
-
* Policy regarding the participants per booking.
|
|
478
|
-
* @readonly
|
|
479
|
-
*/
|
|
480
|
-
participantsPolicy?: ParticipantsPolicy;
|
|
481
|
-
/**
|
|
482
|
-
* Policy for allocating resources.
|
|
483
|
-
* @readonly
|
|
484
|
-
*/
|
|
485
|
-
resourcesPolicy?: ResourcesPolicy;
|
|
486
|
-
}
|
|
487
|
-
/** A description of the policy to display to participants. */
|
|
488
|
-
export interface PolicyDescription {
|
|
489
|
-
/**
|
|
490
|
-
* Whether the description should be displayed. If `true`, the description is displayed.
|
|
491
|
-
*
|
|
492
|
-
* Default: `false`
|
|
493
|
-
*/
|
|
494
|
-
enabled?: boolean;
|
|
495
|
-
/**
|
|
496
|
-
* The description to display.
|
|
497
|
-
*
|
|
498
|
-
* Default: Empty
|
|
499
|
-
* Max length: 2500 characters
|
|
500
|
-
*/
|
|
501
|
-
description?: string;
|
|
502
|
-
}
|
|
503
|
-
/** The policy for limiting early bookings. */
|
|
504
|
-
export interface LimitEarlyBookingPolicy {
|
|
505
|
-
/**
|
|
506
|
-
* Whether there is a limit on how early a customer
|
|
507
|
-
* can book. When `false`, there is no limit on the earliest
|
|
508
|
-
* booking time and customers can book in advance, as early as they like.
|
|
509
|
-
*
|
|
510
|
-
* Default: `false`
|
|
511
|
-
*/
|
|
512
|
-
enabled?: boolean;
|
|
513
|
-
/**
|
|
514
|
-
* Maximum number of minutes before the start of the session that a booking can be made. This value must be greater
|
|
515
|
-
* than `latest_booking_in_minutes` in the `LimitLateBookingPolicy` policy.
|
|
516
|
-
*
|
|
517
|
-
* Default: 10080 minutes (7 days)
|
|
518
|
-
* Min: 1 minute
|
|
519
|
-
*/
|
|
520
|
-
earliestBookingInMinutes?: number;
|
|
521
|
-
}
|
|
522
|
-
/**
|
|
523
|
-
* The policy for limiting late bookings.
|
|
524
|
-
*
|
|
525
|
-
* This policy and the `BookAfterStartPolicy` policy cannot be enabled at the same time. So if this policy
|
|
526
|
-
* is enabled, `BookAfterStartPolicy` must be disabled.
|
|
527
|
-
*/
|
|
528
|
-
export interface LimitLateBookingPolicy {
|
|
529
|
-
/**
|
|
530
|
-
* Whether there is a limit on how late a customer
|
|
531
|
-
* can book. When `false`, there is no limit on the latest
|
|
532
|
-
* booking time and customers can book up to the last minute.
|
|
533
|
-
*
|
|
534
|
-
* Default: `false`
|
|
535
|
-
*/
|
|
536
|
-
enabled?: boolean;
|
|
537
|
-
/**
|
|
538
|
-
* Minimum number of minutes before the start of the session that a booking can be made.
|
|
539
|
-
* For a schedule, this is relative to the start time of the next booked session, excluding past-booked sessions.
|
|
540
|
-
* This value must be less than `earliest_booking_in_minutes` in the `LimitEarlyBookingPolicy` policy.
|
|
541
|
-
*
|
|
542
|
-
* Default: 1440 minutes (1 day)
|
|
543
|
-
* Min: 1 minute
|
|
544
|
-
*/
|
|
545
|
-
latestBookingInMinutes?: number;
|
|
546
|
-
}
|
|
547
|
-
/**
|
|
548
|
-
* The policy for whether a session can be booked after the start of the schedule.
|
|
549
|
-
* This policy and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this policy
|
|
550
|
-
* is enabled, the `LimitLateBookingPolicy` policy must be disabled.
|
|
551
|
-
*/
|
|
552
|
-
export interface BookAfterStartPolicy {
|
|
553
|
-
/**
|
|
554
|
-
* Whether booking is allowed after the start of the schedule. When `true`,
|
|
555
|
-
* customers can book after the start of the schedule.
|
|
556
|
-
*
|
|
557
|
-
* Default: `false`
|
|
558
|
-
*/
|
|
559
|
-
enabled?: boolean;
|
|
560
|
-
}
|
|
561
|
-
/** The policy for canceling a booked session. */
|
|
562
|
-
export interface CancellationPolicy {
|
|
563
|
-
/**
|
|
564
|
-
* Whether canceling a booking is allowed. When `true`, customers
|
|
565
|
-
* can cancel the booking.
|
|
566
|
-
*
|
|
567
|
-
* Default: `false`
|
|
568
|
-
*/
|
|
569
|
-
enabled?: boolean;
|
|
570
|
-
/**
|
|
571
|
-
* Whether there is a limit on the latest cancellation time. When `true`,
|
|
572
|
-
* a time limit is enforced.
|
|
573
|
-
*
|
|
574
|
-
* Default: `false`
|
|
575
|
-
*/
|
|
576
|
-
limitLatestCancellation?: boolean;
|
|
577
|
-
/**
|
|
578
|
-
* Minimum number of minutes before the start of the booked session that the booking can be canceled.
|
|
579
|
-
*
|
|
580
|
-
* Default: 1440 minutes (1 day)
|
|
581
|
-
* Min: 1 minute
|
|
582
|
-
*/
|
|
583
|
-
latestCancellationInMinutes?: number;
|
|
584
|
-
}
|
|
585
|
-
/** The policy for rescheduling a booked session. */
|
|
586
|
-
export interface ReschedulePolicy {
|
|
587
|
-
/**
|
|
588
|
-
* Whether rescheduling a booking is allowed. When `true`, customers
|
|
589
|
-
* can reschedule the booking.
|
|
590
|
-
*
|
|
591
|
-
* Default: `false`
|
|
592
|
-
*/
|
|
593
|
-
enabled?: boolean;
|
|
594
|
-
/**
|
|
595
|
-
* Whether there is a limit on the latest reschedule time. When `true`,
|
|
596
|
-
* a time limit is enforced.
|
|
597
|
-
*
|
|
598
|
-
* Default: `false`
|
|
599
|
-
*/
|
|
600
|
-
limitLatestReschedule?: boolean;
|
|
601
|
-
/**
|
|
602
|
-
* Minimum number of minutes before the start of the booked session that the booking can be rescheduled.
|
|
603
|
-
*
|
|
604
|
-
* Default: 1440 minutes (1 day)
|
|
605
|
-
* Min: 1 minute
|
|
606
|
-
*/
|
|
607
|
-
latestRescheduleInMinutes?: number;
|
|
608
|
-
}
|
|
609
|
-
/** The policy for the waitlist. */
|
|
610
|
-
export interface WaitlistPolicy {
|
|
611
|
-
/**
|
|
612
|
-
* Whether the session has a waitlist. If `true`, there is a waitlist.
|
|
613
|
-
*
|
|
614
|
-
* Default: `false`
|
|
615
|
-
*/
|
|
616
|
-
enabled?: boolean;
|
|
617
|
-
/**
|
|
618
|
-
* Number of spots available in the waitlist.
|
|
619
|
-
*
|
|
620
|
-
* Default: 10 spots
|
|
621
|
-
* Min: 1 spot
|
|
622
|
-
*/
|
|
623
|
-
capacity?: number;
|
|
624
|
-
/**
|
|
625
|
-
* Amount of time a participant is given to book, once notified that a spot is available.
|
|
626
|
-
*
|
|
627
|
-
* Default: 10 minutes
|
|
628
|
-
* Min: 1 spot
|
|
629
|
-
*/
|
|
630
|
-
reservationTimeInMinutes?: number;
|
|
631
|
-
}
|
|
632
|
-
/** The policy for the maximum number of participants per booking. */
|
|
633
|
-
export interface ParticipantsPolicy {
|
|
634
|
-
/**
|
|
635
|
-
* Maximum number of participants allowed.
|
|
636
|
-
*
|
|
637
|
-
* Default: 1 participant
|
|
638
|
-
* Min: 1 participant
|
|
639
|
-
*/
|
|
640
|
-
maxParticipantsPerBooking?: number;
|
|
641
|
-
}
|
|
642
|
-
/** The policy regarding the allocation of resources (e.g. staff members). */
|
|
643
|
-
export interface ResourcesPolicy {
|
|
644
|
-
/**
|
|
645
|
-
* `true` if this policy is enabled, `false` otherwise.
|
|
646
|
-
* When `false` then the client must always select a resource when booking an appointment.
|
|
647
|
-
*/
|
|
648
|
-
enabled?: boolean;
|
|
649
|
-
/**
|
|
650
|
-
* `true`, if it is allowed to automatically assign a resource when booking an appointment,
|
|
651
|
-
* `false`, if the client must always select a resource.
|
|
652
|
-
*
|
|
653
|
-
* Default: `false`
|
|
654
|
-
*/
|
|
655
|
-
autoAssignAllowed?: boolean;
|
|
656
|
-
}
|
|
657
|
-
export interface Schedule {
|
|
658
|
-
/**
|
|
659
|
-
* Schedule ID, used to manage the service's sessions.
|
|
660
|
-
* @readonly
|
|
661
|
-
*/
|
|
662
|
-
_id?: string | null;
|
|
663
|
-
/** Limitations dictating the way session availability is calculated. For appointments only. */
|
|
664
|
-
availabilityConstraints?: AvailabilityConstraints;
|
|
665
|
-
}
|
|
666
|
-
export interface AvailabilityConstraints {
|
|
667
|
-
/**
|
|
668
|
-
* A list of duration options for sessions, in minutes.
|
|
669
|
-
*
|
|
670
|
-
* The availability calculation generates slots for sessions with these durations, unless there is a conflict with existing sessions or other availability constraints exist.
|
|
671
|
-
* Required for services of type `APPOINTMENT` to allow the customer to book a session of the service. Not relevant for other service types.
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
* Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
|
|
675
|
-
*/
|
|
676
|
-
sessionDurations?: number[];
|
|
677
|
-
/**
|
|
678
|
-
* The number of minutes between the end of a session and the start of the next.
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
* Min: 0 minutes
|
|
682
|
-
* Max: 720 minutes
|
|
683
|
-
*/
|
|
684
|
-
timeBetweenSessions?: number;
|
|
685
|
-
}
|
|
686
|
-
export interface StaffMember {
|
|
687
|
-
/**
|
|
688
|
-
* ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.
|
|
689
|
-
* @readonly
|
|
690
|
-
*/
|
|
691
|
-
staffMemberId?: string;
|
|
692
|
-
/** Name of the staff member */
|
|
693
|
-
name?: string | null;
|
|
694
|
-
}
|
|
695
|
-
export interface ResourceGroup {
|
|
696
|
-
/**
|
|
697
|
-
* An optional resource group id, if provided it references a resource group in the resource groups API.
|
|
698
|
-
* TODO - referenced_entity annotation
|
|
699
|
-
*/
|
|
700
|
-
resourceGroupId?: string | null;
|
|
701
|
-
/**
|
|
702
|
-
* Resource ids, each referencing a resource in resources API. may be a subset of resources within a resource group.
|
|
703
|
-
* TODO - referenced_entity annotation
|
|
704
|
-
*/
|
|
705
|
-
resourceIds?: ResourceIds;
|
|
706
|
-
/**
|
|
707
|
-
* How many resources of the group / resource ids are required in order to book the service.
|
|
708
|
-
* Defaults to 1.
|
|
709
|
-
*/
|
|
710
|
-
requiredResourcesNumber?: number | null;
|
|
711
|
-
/**
|
|
712
|
-
* If set to `true`, the custom can select the specific resources while booking the service.
|
|
713
|
-
* If set to `false`, the resources required for to book the service would be auto selected at the time of the booking.
|
|
714
|
-
* Defaults to false.
|
|
715
|
-
* @readonly
|
|
716
|
-
*/
|
|
717
|
-
selectableResource?: boolean | null;
|
|
718
|
-
}
|
|
719
|
-
export interface ResourceIds {
|
|
720
|
-
/** Values of the resource ids. TODO - referenced_entity annotation */
|
|
721
|
-
values?: string[];
|
|
722
|
-
}
|
|
723
|
-
export interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
724
|
-
/** Resource ids, each referencing a resource in resources API. Must be a subset of resources within the selected resource type. */
|
|
725
|
-
resourceIds?: ResourceIds;
|
|
726
|
-
/** The unique identifier for the service resource, if not provided, would default to the resource type id. */
|
|
727
|
-
_id?: string | null;
|
|
728
|
-
resourceType?: ResourceType;
|
|
729
|
-
/**
|
|
730
|
-
* How many resources of the are required in order to book the service.
|
|
731
|
-
* Defaults to 1.
|
|
732
|
-
*/
|
|
733
|
-
requiredResourcesNumber?: number | null;
|
|
734
|
-
/**
|
|
735
|
-
* If set to `true`, the customer can select the specific resources while booking the service.
|
|
736
|
-
* If set to `false`, the resources required for to book the service would be auto selected at the time of the booking.
|
|
737
|
-
* Defaults to false.
|
|
738
|
-
* @readonly
|
|
739
|
-
*/
|
|
740
|
-
selectableResource?: boolean | null;
|
|
741
|
-
}
|
|
742
|
-
/** @oneof */
|
|
743
|
-
export interface ServiceResourceSelectionOneOf {
|
|
744
|
-
/** Resource ids, each referencing a resource in resources API. Must be a subset of resources within the selected resource type. */
|
|
745
|
-
resourceIds?: ResourceIds;
|
|
746
|
-
}
|
|
747
|
-
export interface ResourceType {
|
|
748
|
-
/** The type of the resource. */
|
|
749
|
-
_id?: string | null;
|
|
750
|
-
/**
|
|
751
|
-
* The name of the resource type.
|
|
752
|
-
* @readonly
|
|
753
|
-
*/
|
|
754
|
-
name?: string | null;
|
|
755
|
-
}
|
|
756
|
-
export interface Slug {
|
|
757
|
-
/** The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`. */
|
|
758
|
-
name?: string;
|
|
759
|
-
/**
|
|
760
|
-
* Whether the slug was generated or customized. If `true`, the slug was customized manually by the business owner. Otherwise, the slug was automatically generated from the service name.
|
|
761
|
-
* @readonly
|
|
762
|
-
*/
|
|
763
|
-
custom?: boolean | null;
|
|
764
|
-
/**
|
|
765
|
-
* Date and time the slug was created. This is a system field.
|
|
766
|
-
* @readonly
|
|
767
|
-
*/
|
|
768
|
-
_createdDate?: Date;
|
|
769
|
-
}
|
|
770
|
-
export interface URLs {
|
|
771
|
-
/**
|
|
772
|
-
* The URL for the service page.
|
|
773
|
-
* @readonly
|
|
774
|
-
*/
|
|
775
|
-
servicePage?: string;
|
|
776
|
-
/**
|
|
777
|
-
* The URL for the booking entry point. It can be either to the calendar or to the service page.
|
|
778
|
-
* @readonly
|
|
779
|
-
*/
|
|
780
|
-
bookingPage?: string;
|
|
781
|
-
/**
|
|
782
|
-
* The URL for the calendar. Can be empty if no calendar exists.
|
|
783
|
-
* @readonly
|
|
784
|
-
*/
|
|
785
|
-
calendarPage?: string;
|
|
786
|
-
}
|
|
787
|
-
export interface ExtendedFields {
|
|
788
|
-
/**
|
|
789
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
790
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
791
|
-
*
|
|
792
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
793
|
-
*
|
|
794
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
795
|
-
*/
|
|
796
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
797
|
-
}
|
|
798
|
-
/**
|
|
799
|
-
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
800
|
-
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
801
|
-
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
802
|
-
*/
|
|
803
|
-
export interface SeoSchema {
|
|
804
|
-
/** SEO tag information. */
|
|
805
|
-
tags?: Tag[];
|
|
806
|
-
/** SEO general settings. */
|
|
807
|
-
settings?: Settings;
|
|
808
|
-
}
|
|
809
|
-
export interface Keyword {
|
|
810
|
-
/** Keyword value. */
|
|
811
|
-
term?: string;
|
|
812
|
-
/** Whether the keyword is the main focus keyword. */
|
|
813
|
-
isMain?: boolean;
|
|
814
|
-
}
|
|
815
|
-
export interface Tag {
|
|
816
|
-
/**
|
|
817
|
-
* SEO tag type.
|
|
818
|
-
*
|
|
819
|
-
*
|
|
820
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
821
|
-
*/
|
|
822
|
-
type?: string;
|
|
823
|
-
/**
|
|
824
|
-
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
825
|
-
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
826
|
-
*/
|
|
827
|
-
props?: Record<string, any> | null;
|
|
828
|
-
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
829
|
-
meta?: Record<string, any> | null;
|
|
830
|
-
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
831
|
-
children?: string;
|
|
832
|
-
/** Whether the tag is a custom tag. */
|
|
833
|
-
custom?: boolean;
|
|
834
|
-
/** Whether the tag is disabled. */
|
|
835
|
-
disabled?: boolean;
|
|
836
|
-
}
|
|
837
|
-
export interface Settings {
|
|
838
|
-
/**
|
|
839
|
-
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
840
|
-
*
|
|
841
|
-
*
|
|
842
|
-
* Default: `false` (Auto Redirect is enabled.)
|
|
843
|
-
*/
|
|
844
|
-
preventAutoRedirect?: boolean;
|
|
845
|
-
/** User-selected keyword terms for a specific page. */
|
|
846
|
-
keywords?: Keyword[];
|
|
847
|
-
}
|
|
848
|
-
/**
|
|
849
|
-
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
850
|
-
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
851
|
-
*/
|
|
852
|
-
export interface ReindexMessage extends ReindexMessageActionOneOf {
|
|
853
|
-
upsert?: Upsert;
|
|
854
|
-
delete?: Delete;
|
|
855
|
-
entityFqdn?: string;
|
|
856
|
-
tenantId?: string;
|
|
857
|
-
eventTime?: Date;
|
|
858
|
-
entityEventSequence?: string | null;
|
|
859
|
-
schema?: Schema;
|
|
860
|
-
}
|
|
861
|
-
/** @oneof */
|
|
862
|
-
export interface ReindexMessageActionOneOf {
|
|
863
|
-
upsert?: Upsert;
|
|
864
|
-
delete?: Delete;
|
|
865
|
-
}
|
|
866
|
-
export interface Upsert {
|
|
867
|
-
entityId?: string;
|
|
868
|
-
entityAsJson?: string;
|
|
869
|
-
}
|
|
870
|
-
export interface Delete {
|
|
871
|
-
entityId?: string;
|
|
872
|
-
}
|
|
873
|
-
export interface Schema {
|
|
874
|
-
label?: string;
|
|
875
|
-
clusterName?: string;
|
|
876
|
-
}
|
|
877
|
-
export interface SetCustomSlugEvent {
|
|
878
|
-
/** The main slug for the service after the update */
|
|
879
|
-
mainSlug?: Slug;
|
|
880
|
-
}
|
|
881
|
-
export interface CreateServiceRequest {
|
|
882
|
-
/** Service to be created. */
|
|
883
|
-
service: Service;
|
|
884
|
-
}
|
|
885
|
-
export interface CreateServiceResponse {
|
|
886
|
-
/** The created service. */
|
|
887
|
-
service?: Service;
|
|
888
|
-
}
|
|
889
|
-
export interface BulkCreateServicesRequest {
|
|
890
|
-
/** Services to create */
|
|
891
|
-
services?: Service[];
|
|
892
|
-
/** `true` if the created entities must be included in the response, otherwise no entities are included in the response. */
|
|
893
|
-
returnEntity?: boolean;
|
|
894
|
-
}
|
|
895
|
-
export interface BulkCreateServicesResponse {
|
|
896
|
-
/** The result of each service creation. */
|
|
897
|
-
results?: BulkServiceResult[];
|
|
898
|
-
/** Create statistics. */
|
|
899
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
900
|
-
}
|
|
901
|
-
export interface BulkServiceResult {
|
|
902
|
-
itemMetadata?: ItemMetadata;
|
|
903
|
-
item?: Service;
|
|
904
|
-
}
|
|
905
|
-
export interface ItemMetadata {
|
|
906
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
907
|
-
_id?: string | null;
|
|
908
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
909
|
-
originalIndex?: number;
|
|
910
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
911
|
-
success?: boolean;
|
|
912
|
-
/** Details about the error in case of failure. */
|
|
913
|
-
error?: ApplicationError;
|
|
914
|
-
}
|
|
915
|
-
export interface ApplicationError {
|
|
916
|
-
/** Error code. */
|
|
917
|
-
code?: string;
|
|
918
|
-
/** Description of the error. */
|
|
919
|
-
description?: string;
|
|
920
|
-
/** Data related to the error. */
|
|
921
|
-
data?: Record<string, any> | null;
|
|
922
|
-
}
|
|
923
|
-
export interface BulkActionMetadata {
|
|
924
|
-
/** Number of items that were successfully processed. */
|
|
925
|
-
totalSuccesses?: number;
|
|
926
|
-
/** Number of items that couldn't be processed. */
|
|
927
|
-
totalFailures?: number;
|
|
928
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
929
|
-
undetailedFailures?: number;
|
|
930
|
-
}
|
|
931
|
-
export interface GetServiceRequest {
|
|
932
|
-
/** ID of the service to retrieve. */
|
|
933
|
-
serviceId: string;
|
|
934
|
-
}
|
|
935
|
-
export declare enum RequestedFields {
|
|
936
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
937
|
-
/** When passed, `service.staff_members` is returned */
|
|
938
|
-
STAFF_MEMBER_DETAILS = "STAFF_MEMBER_DETAILS",
|
|
939
|
-
/** When passed, `service.service_resources.resource_type.name` is returned */
|
|
940
|
-
RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
|
|
941
|
-
}
|
|
942
|
-
export interface GetServiceResponse {
|
|
943
|
-
/** The retrieved service. */
|
|
944
|
-
service?: Service;
|
|
945
|
-
}
|
|
946
|
-
export interface GetServiceAvailabilityConstraintsRequest {
|
|
947
|
-
/** ID of the service to retrieve. */
|
|
948
|
-
serviceId?: string;
|
|
949
|
-
}
|
|
950
|
-
export interface GetServiceAvailabilityConstraintsResponse {
|
|
951
|
-
/** The retrieved availability constraints of the service. */
|
|
952
|
-
constraints?: ServiceAvailabilityConstraints;
|
|
953
|
-
}
|
|
954
|
-
export interface ServiceAvailabilityConstraints {
|
|
955
|
-
/**
|
|
956
|
-
* The booking policy.
|
|
957
|
-
* @readonly
|
|
958
|
-
*/
|
|
959
|
-
bookingPolicy?: BookingPolicy;
|
|
960
|
-
/**
|
|
961
|
-
* The service schedule, including the schedule id and availability constraints.
|
|
962
|
-
* @readonly
|
|
963
|
-
*/
|
|
964
|
-
schedule?: Schedule;
|
|
965
|
-
/**
|
|
966
|
-
* The locations this service is offered at.
|
|
967
|
-
* Only multiple locations of type `BUSINESS` are supported. multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.
|
|
968
|
-
* For courses only: Currently, only 1 location is supported, for all location types.
|
|
969
|
-
* Use `setServiceLocations` method to change the locations this service is offered at.
|
|
970
|
-
* @readonly
|
|
971
|
-
*/
|
|
972
|
-
locations?: Location[];
|
|
973
|
-
/** @readonly */
|
|
974
|
-
resourceGroups?: ResourceGroup[];
|
|
975
|
-
/**
|
|
976
|
-
* Resource groups required to book the service
|
|
977
|
-
* @readonly
|
|
978
|
-
*/
|
|
979
|
-
serviceResources?: ServiceResource[];
|
|
980
|
-
/**
|
|
981
|
-
* The time between available slots' start times.
|
|
982
|
-
* For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc.
|
|
983
|
-
* Is applied to all schedules of the site.
|
|
984
|
-
* For appointment only.
|
|
985
|
-
* @readonly
|
|
986
|
-
*/
|
|
987
|
-
slotsSplitInterval?: V1SplitInterval;
|
|
988
|
-
/**
|
|
989
|
-
* Online booking settings.
|
|
990
|
-
* @readonly
|
|
991
|
-
*/
|
|
992
|
-
onlineBooking?: OnlineBooking;
|
|
993
|
-
}
|
|
994
|
-
/** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
|
|
995
|
-
export interface V1SplitInterval {
|
|
996
|
-
/**
|
|
997
|
-
* Whether the slot duration is used as the split interval value.
|
|
998
|
-
* If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
|
|
999
|
-
* `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
|
|
1000
|
-
*/
|
|
1001
|
-
sameAsDuration?: boolean | null;
|
|
1002
|
-
/** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
|
|
1003
|
-
valueInMinutes?: number | null;
|
|
1004
|
-
}
|
|
1005
|
-
export interface UpdateServiceRequest {
|
|
1006
|
-
/** Service to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */
|
|
1007
|
-
service: Service;
|
|
1008
|
-
}
|
|
1009
|
-
export interface UpdateServiceResponse {
|
|
1010
|
-
/** The updated service. */
|
|
1011
|
-
service?: Service;
|
|
1012
|
-
}
|
|
1013
|
-
export interface BulkUpdateServicesRequest {
|
|
1014
|
-
/** Services to update. */
|
|
1015
|
-
services?: MaskedService[];
|
|
1016
|
-
/** `true` if the updated entities must be included in the response, otherwise no entities are included in the response. */
|
|
1017
|
-
returnEntity?: boolean;
|
|
1018
|
-
}
|
|
1019
|
-
export interface MaskedService {
|
|
1020
|
-
/** Service to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */
|
|
1021
|
-
service?: Service;
|
|
1022
|
-
}
|
|
1023
|
-
export interface BulkUpdateServicesResponse {
|
|
1024
|
-
/** The result of each service update. */
|
|
1025
|
-
results?: BulkServiceResult[];
|
|
1026
|
-
/** Update statistics. */
|
|
1027
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1028
|
-
}
|
|
1029
|
-
export interface DeleteServiceRequest {
|
|
1030
|
-
/** ID of the service to delete. */
|
|
1031
|
-
serviceId: string;
|
|
1032
|
-
/**
|
|
1033
|
-
* Whether to preserve future sessions with participants.
|
|
1034
|
-
*
|
|
1035
|
-
* Default: `false`
|
|
1036
|
-
*/
|
|
1037
|
-
preserveFutureSessionsWithParticipants?: boolean;
|
|
1038
|
-
/** Whether to notify participants about the change and an optional custom message. */
|
|
1039
|
-
participantNotification?: ParticipantNotification;
|
|
1040
|
-
}
|
|
1041
|
-
export interface ParticipantNotification {
|
|
1042
|
-
/**
|
|
1043
|
-
* Whether to send the message about the changes to the customer.
|
|
1044
|
-
*
|
|
1045
|
-
* Default: `false`
|
|
1046
|
-
*/
|
|
1047
|
-
notifyParticipants?: boolean | null;
|
|
1048
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
1049
|
-
message?: string | null;
|
|
1050
|
-
}
|
|
1051
|
-
export interface DeleteServiceResponse {
|
|
1052
|
-
}
|
|
1053
|
-
export interface BulkDeleteServicesRequest {
|
|
1054
|
-
ids?: string[];
|
|
1055
|
-
preserveFutureSessionsWithParticipants?: boolean;
|
|
1056
|
-
/**
|
|
1057
|
-
* Whether to preserve future sessions with participants.
|
|
1058
|
-
*
|
|
1059
|
-
* Default: `false`.
|
|
1060
|
-
*/
|
|
1061
|
-
participantNotification?: ParticipantNotification;
|
|
1062
|
-
}
|
|
1063
|
-
export interface BulkDeleteServicesResponse {
|
|
1064
|
-
/** The result of each service removal. */
|
|
1065
|
-
results?: BulkServiceResult[];
|
|
1066
|
-
/** Update statistics. */
|
|
1067
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1068
|
-
}
|
|
1069
|
-
export interface QueryServicesRequest {
|
|
1070
|
-
/** WQL expression. */
|
|
1071
|
-
query: QueryV2;
|
|
1072
|
-
}
|
|
1073
|
-
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1074
|
-
/** Paging options to limit and skip the number of items. */
|
|
1075
|
-
paging?: Paging;
|
|
1076
|
-
/**
|
|
1077
|
-
* Filter object in the following format:
|
|
1078
|
-
*
|
|
1079
|
-
* `"filter" : {
|
|
1080
|
-
* "fieldName1": "value1",
|
|
1081
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1082
|
-
* }`
|
|
1083
|
-
*
|
|
1084
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`
|
|
1085
|
-
*
|
|
1086
|
-
* Read more about [supported fields and operators](https://dev.wix.com/api/rest/wix-bookings/services-v2/filtering-and-sorting).
|
|
1087
|
-
*/
|
|
1088
|
-
filter?: Record<string, any> | null;
|
|
1089
|
-
/**
|
|
1090
|
-
* Sort object in the following format:
|
|
1091
|
-
* `[ {"fieldName":"sortField1","order":"ASC"},
|
|
1092
|
-
* {"fieldName":"sortField2","order":"DESC"} ]`
|
|
1093
|
-
*
|
|
1094
|
-
* Read more about [sorting](https://dev.wix.com/api/rest/wix-bookings/services-v2/filtering-and-sorting#wix-bookings_services-v2_filtering-and-sorting_sorting).
|
|
1095
|
-
*/
|
|
1096
|
-
sort?: Sorting[];
|
|
1097
|
-
}
|
|
1098
|
-
/** @oneof */
|
|
1099
|
-
export interface QueryV2PagingMethodOneOf {
|
|
1100
|
-
/** Paging options to limit and skip the number of items. */
|
|
1101
|
-
paging?: Paging;
|
|
1102
|
-
}
|
|
1103
|
-
export interface Sorting {
|
|
1104
|
-
/** Name of the field to sort by. */
|
|
1105
|
-
fieldName?: string;
|
|
1106
|
-
/** Sort order. */
|
|
1107
|
-
order?: SortOrder;
|
|
1108
|
-
}
|
|
1109
|
-
export declare enum SortOrder {
|
|
1110
|
-
ASC = "ASC",
|
|
1111
|
-
DESC = "DESC"
|
|
1112
|
-
}
|
|
1113
|
-
export interface Paging {
|
|
1114
|
-
/** Number of items to load. */
|
|
1115
|
-
limit?: number | null;
|
|
1116
|
-
/** Number of items to skip in the current sort order. */
|
|
1117
|
-
offset?: number | null;
|
|
1118
|
-
}
|
|
1119
|
-
export interface CursorPaging {
|
|
1120
|
-
/** Number of items to load. */
|
|
1121
|
-
limit?: number | null;
|
|
1122
|
-
/**
|
|
1123
|
-
* Pointer to the next or previous page in the list of results.
|
|
1124
|
-
*
|
|
1125
|
-
* You can get the relevant cursor token
|
|
1126
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1127
|
-
* Not relevant for the first request.
|
|
1128
|
-
*/
|
|
1129
|
-
cursor?: string | null;
|
|
1130
|
-
}
|
|
1131
|
-
export interface QueryServicesResponse {
|
|
1132
|
-
/** The retrieved services. */
|
|
1133
|
-
services?: Service[];
|
|
1134
|
-
/** Paging metadata, including offset and count. */
|
|
1135
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1136
|
-
}
|
|
1137
|
-
export interface PagingMetadataV2 {
|
|
1138
|
-
/** Number of items returned in the response. */
|
|
1139
|
-
count?: number | null;
|
|
1140
|
-
/** Offset that was requested. */
|
|
1141
|
-
offset?: number | null;
|
|
1142
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1143
|
-
total?: number | null;
|
|
1144
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1145
|
-
tooManyToCount?: boolean | null;
|
|
1146
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1147
|
-
cursors?: Cursors;
|
|
1148
|
-
}
|
|
1149
|
-
export interface Cursors {
|
|
1150
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1151
|
-
next?: string | null;
|
|
1152
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1153
|
-
prev?: string | null;
|
|
1154
|
-
}
|
|
1155
|
-
export interface SearchServicesRequest {
|
|
1156
|
-
search?: CursorSearch;
|
|
1157
|
-
}
|
|
1158
|
-
export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
1159
|
-
/** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
|
|
1160
|
-
cursorPaging?: CursorPaging;
|
|
1161
|
-
/** A filter object. See documentation [here](https:// bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
1162
|
-
filter?: Record<string, any> | null;
|
|
1163
|
-
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
|
1164
|
-
sort?: Sorting[];
|
|
1165
|
-
/** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
|
|
1166
|
-
aggregations?: Aggregation[];
|
|
1167
|
-
/** Free text to match in searchable fields */
|
|
1168
|
-
search?: SearchDetails;
|
|
1169
|
-
}
|
|
1170
|
-
/** @oneof */
|
|
1171
|
-
export interface CursorSearchPagingMethodOneOf {
|
|
1172
|
-
/** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
|
|
1173
|
-
cursorPaging?: CursorPaging;
|
|
1174
|
-
}
|
|
1175
|
-
export interface Aggregation extends AggregationKindOneOf {
|
|
1176
|
-
value?: ValueAggregation;
|
|
1177
|
-
range?: RangeAggregation;
|
|
1178
|
-
scalar?: ScalarAggregation;
|
|
1179
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1180
|
-
nested?: NestedAggregation;
|
|
1181
|
-
name?: string | null;
|
|
1182
|
-
type?: AggregationType;
|
|
1183
|
-
fieldPath?: string;
|
|
1184
|
-
groupBy?: GroupByAggregation;
|
|
1185
|
-
}
|
|
1186
|
-
/** @oneof */
|
|
1187
|
-
export interface AggregationKindOneOf {
|
|
1188
|
-
value?: ValueAggregation;
|
|
1189
|
-
range?: RangeAggregation;
|
|
1190
|
-
scalar?: ScalarAggregation;
|
|
1191
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1192
|
-
nested?: NestedAggregation;
|
|
1193
|
-
}
|
|
1194
|
-
export interface RangeBucket {
|
|
1195
|
-
/** Inclusive lower bound of the range. Required if to is not given. */
|
|
1196
|
-
from?: number | null;
|
|
1197
|
-
/** Exclusive upper bound of the range. Required if from is not given. */
|
|
1198
|
-
to?: number | null;
|
|
1199
|
-
}
|
|
1200
|
-
export declare enum SortType {
|
|
1201
|
-
COUNT = "COUNT",
|
|
1202
|
-
VALUE = "VALUE"
|
|
1203
|
-
}
|
|
1204
|
-
export declare enum SortDirection {
|
|
1205
|
-
DESC = "DESC",
|
|
1206
|
-
ASC = "ASC"
|
|
1207
|
-
}
|
|
1208
|
-
export declare enum MissingValues {
|
|
1209
|
-
EXCLUDE = "EXCLUDE",
|
|
1210
|
-
INCLUDE = "INCLUDE"
|
|
1211
|
-
}
|
|
1212
|
-
export interface IncludeMissingValuesOptions {
|
|
1213
|
-
/** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
|
|
1214
|
-
addToBucket?: string;
|
|
1215
|
-
}
|
|
1216
|
-
export declare enum ScalarType {
|
|
1217
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
1218
|
-
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
1219
|
-
MIN = "MIN",
|
|
1220
|
-
MAX = "MAX",
|
|
1221
|
-
SUM = "SUM",
|
|
1222
|
-
AVG = "AVG"
|
|
1223
|
-
}
|
|
1224
|
-
export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1225
|
-
/** options for including missing values */
|
|
1226
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
1227
|
-
sortType?: SortType;
|
|
1228
|
-
sortDirection?: SortDirection;
|
|
1229
|
-
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
1230
|
-
limit?: number | null;
|
|
1231
|
-
/** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
|
|
1232
|
-
missingValues?: MissingValues;
|
|
1233
|
-
}
|
|
1234
|
-
/** @oneof */
|
|
1235
|
-
export interface ValueAggregationOptionsOneOf {
|
|
1236
|
-
/** options for including missing values */
|
|
1237
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
1238
|
-
}
|
|
1239
|
-
export declare enum NestedAggregationType {
|
|
1240
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1241
|
-
VALUE = "VALUE",
|
|
1242
|
-
RANGE = "RANGE",
|
|
1243
|
-
SCALAR = "SCALAR",
|
|
1244
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1245
|
-
}
|
|
1246
|
-
export interface RangeAggregation {
|
|
1247
|
-
/** Range buckets */
|
|
1248
|
-
buckets?: RangeBucket[];
|
|
1249
|
-
}
|
|
1250
|
-
export interface ScalarAggregation {
|
|
1251
|
-
type?: ScalarType;
|
|
1252
|
-
}
|
|
1253
|
-
export interface DateHistogramAggregation {
|
|
1254
|
-
interval?: DateHistogramAggregationInterval;
|
|
1255
|
-
}
|
|
1256
|
-
export declare enum DateHistogramAggregationInterval {
|
|
1257
|
-
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
1258
|
-
YEAR = "YEAR",
|
|
1259
|
-
MONTH = "MONTH",
|
|
1260
|
-
WEEK = "WEEK",
|
|
1261
|
-
DAY = "DAY",
|
|
1262
|
-
HOUR = "HOUR",
|
|
1263
|
-
MINUTE = "MINUTE",
|
|
1264
|
-
SECOND = "SECOND"
|
|
1265
|
-
}
|
|
1266
|
-
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1267
|
-
value?: ValueAggregation;
|
|
1268
|
-
range?: RangeAggregation;
|
|
1269
|
-
scalar?: ScalarAggregation;
|
|
1270
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1271
|
-
name?: string | null;
|
|
1272
|
-
type?: NestedAggregationType;
|
|
1273
|
-
fieldPath?: string;
|
|
1274
|
-
}
|
|
1275
|
-
/** @oneof */
|
|
1276
|
-
export interface NestedAggregationItemKindOneOf {
|
|
1277
|
-
value?: ValueAggregation;
|
|
1278
|
-
range?: RangeAggregation;
|
|
1279
|
-
scalar?: ScalarAggregation;
|
|
1280
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1281
|
-
}
|
|
1282
|
-
export declare enum AggregationType {
|
|
1283
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1284
|
-
VALUE = "VALUE",
|
|
1285
|
-
RANGE = "RANGE",
|
|
1286
|
-
SCALAR = "SCALAR",
|
|
1287
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1288
|
-
NESTED = "NESTED"
|
|
1289
|
-
}
|
|
1290
|
-
/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
1291
|
-
export interface NestedAggregation {
|
|
1292
|
-
nestedAggregations?: NestedAggregationItem[];
|
|
1293
|
-
}
|
|
1294
|
-
export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
1295
|
-
value?: ValueAggregation;
|
|
1296
|
-
name?: string | null;
|
|
1297
|
-
fieldPath?: string;
|
|
1298
|
-
}
|
|
1299
|
-
/** @oneof */
|
|
1300
|
-
export interface GroupByAggregationKindOneOf {
|
|
1301
|
-
value?: ValueAggregation;
|
|
1302
|
-
}
|
|
1303
|
-
export interface SearchDetails {
|
|
1304
|
-
/** Boolean search mode */
|
|
1305
|
-
mode?: Mode;
|
|
1306
|
-
/** Search term or expression */
|
|
1307
|
-
expression?: string | null;
|
|
1308
|
-
/** Fields to search in. If empty - server will search in own default fields */
|
|
1309
|
-
fields?: string[];
|
|
1310
|
-
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
1311
|
-
fuzzy?: boolean;
|
|
1312
|
-
}
|
|
1313
|
-
export declare enum Mode {
|
|
1314
|
-
/** Any */
|
|
1315
|
-
OR = "OR",
|
|
1316
|
-
/** All */
|
|
1317
|
-
AND = "AND"
|
|
1318
|
-
}
|
|
1319
|
-
export interface SearchServicesResponse {
|
|
1320
|
-
/** The retrieved services. */
|
|
1321
|
-
services?: Service[];
|
|
1322
|
-
/** Cursor paging metadata */
|
|
1323
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1324
|
-
/** Response aggregation data */
|
|
1325
|
-
aggregationData?: AggregationData;
|
|
1326
|
-
}
|
|
1327
|
-
export interface CursorPagingMetadata {
|
|
1328
|
-
/** Number of items returned in the response. */
|
|
1329
|
-
count?: number | null;
|
|
1330
|
-
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
1331
|
-
cursors?: Cursors;
|
|
1332
|
-
/**
|
|
1333
|
-
* Indicates if there are more results after the current page.
|
|
1334
|
-
* If `true`, another page of results can be retrieved.
|
|
1335
|
-
* If `false`, this is the last page.
|
|
1336
|
-
*/
|
|
1337
|
-
hasNext?: boolean | null;
|
|
1338
|
-
}
|
|
1339
|
-
export interface AggregationData {
|
|
1340
|
-
/** key = aggregation name (as derived from search request) */
|
|
1341
|
-
results?: AggregationResults[];
|
|
1342
|
-
}
|
|
1343
|
-
export interface ValueAggregationResult {
|
|
1344
|
-
value?: string;
|
|
1345
|
-
count?: number;
|
|
1346
|
-
}
|
|
1347
|
-
export interface RangeAggregationResult {
|
|
1348
|
-
from?: number | null;
|
|
1349
|
-
to?: number | null;
|
|
1350
|
-
count?: number;
|
|
1351
|
-
}
|
|
1352
|
-
export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
1353
|
-
values?: ValueResults;
|
|
1354
|
-
ranges?: RangeResults;
|
|
1355
|
-
scalar?: ScalarResult;
|
|
1356
|
-
name?: string;
|
|
1357
|
-
type?: AggregationType;
|
|
1358
|
-
fieldPath?: string;
|
|
1359
|
-
}
|
|
1360
|
-
/** @oneof */
|
|
1361
|
-
export interface NestedAggregationResultsResultOneOf {
|
|
1362
|
-
values?: ValueResults;
|
|
1363
|
-
ranges?: RangeResults;
|
|
1364
|
-
scalar?: ScalarResult;
|
|
1365
|
-
}
|
|
1366
|
-
export interface ValueResults {
|
|
1367
|
-
results?: ValueAggregationResult[];
|
|
1368
|
-
}
|
|
1369
|
-
export interface RangeResults {
|
|
1370
|
-
results?: RangeAggregationResult[];
|
|
1371
|
-
}
|
|
1372
|
-
export interface ScalarResult {
|
|
1373
|
-
type?: ScalarType;
|
|
1374
|
-
value?: number;
|
|
1375
|
-
}
|
|
1376
|
-
export interface NestedValueAggregationResult {
|
|
1377
|
-
value?: string;
|
|
1378
|
-
nestedResults?: NestedAggregationResults;
|
|
1379
|
-
}
|
|
1380
|
-
export interface ValueResult {
|
|
1381
|
-
value?: string;
|
|
1382
|
-
count?: number | null;
|
|
1383
|
-
}
|
|
1384
|
-
export interface RangeResult {
|
|
1385
|
-
from?: number | null;
|
|
1386
|
-
to?: number | null;
|
|
1387
|
-
count?: number | null;
|
|
1388
|
-
}
|
|
1389
|
-
export interface NestedResultsScalarResult {
|
|
1390
|
-
value?: number;
|
|
1391
|
-
}
|
|
1392
|
-
export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1393
|
-
value?: ValueResult;
|
|
1394
|
-
range?: RangeResult;
|
|
1395
|
-
scalar?: NestedResultsScalarResult;
|
|
1396
|
-
dateHistogram?: ValueResult;
|
|
1397
|
-
}
|
|
1398
|
-
/** @oneof */
|
|
1399
|
-
export interface NestedResultValueResultOneOf {
|
|
1400
|
-
value?: ValueResult;
|
|
1401
|
-
range?: RangeResult;
|
|
1402
|
-
scalar?: NestedResultsScalarResult;
|
|
1403
|
-
dateHistogram?: ValueResult;
|
|
1404
|
-
}
|
|
1405
|
-
export interface Results {
|
|
1406
|
-
results?: Record<string, NestedResultValue>;
|
|
1407
|
-
}
|
|
1408
|
-
export interface DateHistogramResult {
|
|
1409
|
-
value?: string;
|
|
1410
|
-
count?: number;
|
|
1411
|
-
}
|
|
1412
|
-
export interface GroupByValueResults {
|
|
1413
|
-
results?: NestedValueAggregationResult[];
|
|
1414
|
-
}
|
|
1415
|
-
export interface DateHistogramResults {
|
|
1416
|
-
results?: DateHistogramResult[];
|
|
1417
|
-
}
|
|
1418
|
-
/**
|
|
1419
|
-
* results of `NESTED` aggregation type in a flattened form
|
|
1420
|
-
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1421
|
-
*/
|
|
1422
|
-
export interface NestedResults {
|
|
1423
|
-
results?: Results[];
|
|
1424
|
-
}
|
|
1425
|
-
export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1426
|
-
values?: ValueResults;
|
|
1427
|
-
ranges?: RangeResults;
|
|
1428
|
-
scalar?: ScalarResult;
|
|
1429
|
-
groupedByValue?: GroupByValueResults;
|
|
1430
|
-
dateHistogram?: DateHistogramResults;
|
|
1431
|
-
nested?: NestedResults;
|
|
1432
|
-
name?: string;
|
|
1433
|
-
type?: AggregationType;
|
|
1434
|
-
fieldPath?: string;
|
|
1435
|
-
}
|
|
1436
|
-
/** @oneof */
|
|
1437
|
-
export interface AggregationResultsResultOneOf {
|
|
1438
|
-
values?: ValueResults;
|
|
1439
|
-
ranges?: RangeResults;
|
|
1440
|
-
scalar?: ScalarResult;
|
|
1441
|
-
groupedByValue?: GroupByValueResults;
|
|
1442
|
-
dateHistogram?: DateHistogramResults;
|
|
1443
|
-
nested?: NestedResults;
|
|
1444
|
-
}
|
|
1445
|
-
export interface QueryPoliciesRequest {
|
|
1446
|
-
/** WQL expression. */
|
|
1447
|
-
query?: CursorQuery;
|
|
1448
|
-
}
|
|
1449
|
-
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1450
|
-
/** 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`. */
|
|
1451
|
-
cursorPaging?: CursorPaging;
|
|
1452
|
-
/**
|
|
1453
|
-
* Filter object in the following format:
|
|
1454
|
-
* `"filter" : {
|
|
1455
|
-
* "fieldName1": "value1",
|
|
1456
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1457
|
-
* }`
|
|
1458
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`
|
|
1459
|
-
*/
|
|
1460
|
-
filter?: Record<string, any> | null;
|
|
1461
|
-
/**
|
|
1462
|
-
* Sort object in the following format:
|
|
1463
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1464
|
-
*/
|
|
1465
|
-
sort?: Sorting[];
|
|
1466
|
-
}
|
|
1467
|
-
/** @oneof */
|
|
1468
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
1469
|
-
/** 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`. */
|
|
1470
|
-
cursorPaging?: CursorPaging;
|
|
1471
|
-
}
|
|
1472
|
-
export interface QueryPoliciesResponse {
|
|
1473
|
-
/** The retrieved policies. */
|
|
1474
|
-
bookingPolicies?: BookingPolicyWithServices[];
|
|
1475
|
-
/** Paging metadata, including offset and count. */
|
|
1476
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1477
|
-
}
|
|
1478
|
-
export interface BookingPolicyWithServices {
|
|
1479
|
-
/** The booking policy. */
|
|
1480
|
-
bookingPolicy?: BookingPolicy;
|
|
1481
|
-
/** The services associated with the booking policy. Up to 5 services are returned per policy. */
|
|
1482
|
-
services?: Service[];
|
|
1483
|
-
/** Whether there are more services associated with the booking policy. */
|
|
1484
|
-
hasMoreServices?: boolean | null;
|
|
1485
|
-
/** The number of services associated with the booking policy. */
|
|
1486
|
-
countOfServices?: number;
|
|
1487
|
-
}
|
|
1488
|
-
export interface CountServicesRequest {
|
|
1489
|
-
/** The filters for performing the count. */
|
|
1490
|
-
filter?: Record<string, any> | null;
|
|
1491
|
-
}
|
|
1492
|
-
export interface CountServicesResponse {
|
|
1493
|
-
/** The number of services matching the given filter. */
|
|
1494
|
-
count?: number;
|
|
1495
|
-
}
|
|
1496
|
-
/** An event sent every time a category entity is changed. */
|
|
1497
|
-
export interface CategoryNotification {
|
|
1498
|
-
category?: Category;
|
|
1499
|
-
event?: Event;
|
|
1500
|
-
}
|
|
1501
|
-
/** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
|
|
1502
|
-
export interface Category {
|
|
1503
|
-
/**
|
|
1504
|
-
* Category ID.
|
|
1505
|
-
* @readonly
|
|
1506
|
-
*/
|
|
1507
|
-
_id?: string | null;
|
|
1508
|
-
/** Category name. */
|
|
1509
|
-
name?: string | null;
|
|
1510
|
-
/**
|
|
1511
|
-
* Category status.
|
|
1512
|
-
* Supported values:
|
|
1513
|
-
* - "CREATED". The category is created.
|
|
1514
|
-
* - "DELETED". The category is deleted.
|
|
1515
|
-
* Default: "CREATED"
|
|
1516
|
-
* @readonly
|
|
1517
|
-
*/
|
|
1518
|
-
status?: Status;
|
|
1519
|
-
/** Sort order of the category in the Dashboard. */
|
|
1520
|
-
sortOrder?: number | null;
|
|
1521
|
-
}
|
|
1522
|
-
export declare enum Status {
|
|
1523
|
-
/** Default status. */
|
|
1524
|
-
CREATED = "CREATED",
|
|
1525
|
-
/** Category is deleted. */
|
|
1526
|
-
DELETED = "DELETED"
|
|
1527
|
-
}
|
|
1528
|
-
export declare enum Event {
|
|
1529
|
-
Updated = "Updated",
|
|
1530
|
-
Deleted = "Deleted",
|
|
1531
|
-
Created = "Created"
|
|
1532
|
-
}
|
|
1533
|
-
export interface Empty {
|
|
1534
|
-
}
|
|
1535
|
-
export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
|
|
1536
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
1537
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
1538
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
1539
|
-
actionEvent?: ActionEvent<T>;
|
|
1540
|
-
/**
|
|
1541
|
-
* Unique event ID.
|
|
1542
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1543
|
-
*/
|
|
1544
|
-
_id?: string;
|
|
1545
|
-
/**
|
|
1546
|
-
* Assumes actions are also always typed to an entity_type
|
|
1547
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1548
|
-
*/
|
|
1549
|
-
entityFqdn?: string;
|
|
1550
|
-
/**
|
|
1551
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1552
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1553
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1554
|
-
*/
|
|
1555
|
-
slug?: string;
|
|
1556
|
-
/** ID of the entity associated with the event. */
|
|
1557
|
-
entityId?: string;
|
|
1558
|
-
/** Event timestamp. */
|
|
1559
|
-
eventTime?: Date;
|
|
1560
|
-
/**
|
|
1561
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1562
|
-
* (for example, GDPR).
|
|
1563
|
-
*/
|
|
1564
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1565
|
-
/** If present, indicates the action that triggered the event. */
|
|
1566
|
-
originatedFrom?: string | null;
|
|
1567
|
-
/**
|
|
1568
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1569
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1570
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1571
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1572
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1573
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1574
|
-
*/
|
|
1575
|
-
entityEventSequence?: string | null;
|
|
1576
|
-
}
|
|
1577
|
-
export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
1578
|
-
}
|
|
1579
|
-
export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
1580
|
-
}
|
|
1581
|
-
export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
|
|
1582
|
-
}
|
|
1583
|
-
export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
|
|
1584
|
-
}
|
|
1585
|
-
/** @oneof */
|
|
1586
|
-
export interface DomainEventBodyOneOf<T> {
|
|
1587
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
1588
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
1589
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
1590
|
-
actionEvent?: ActionEvent<T>;
|
|
1591
|
-
}
|
|
1592
|
-
export interface EntityCreatedEvent<T> {
|
|
1593
|
-
entity?: T;
|
|
1594
|
-
}
|
|
1595
|
-
export interface EntityUpdatedEvent<T> {
|
|
1596
|
-
/**
|
|
1597
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1598
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1599
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1600
|
-
*/
|
|
1601
|
-
currentEntity?: T;
|
|
1602
|
-
}
|
|
1603
|
-
export interface EntityDeletedEvent<T> {
|
|
1604
|
-
/** Entity that was deleted */
|
|
1605
|
-
deletedEntity?: T | null;
|
|
1606
|
-
}
|
|
1607
|
-
export interface ActionEvent<T> {
|
|
1608
|
-
body?: T;
|
|
1609
|
-
}
|
|
1610
|
-
export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
|
|
1611
|
-
scheduleCreated?: ScheduleCreated;
|
|
1612
|
-
scheduleUpdated?: ScheduleUpdated;
|
|
1613
|
-
scheduleCancelled?: ScheduleCancelled;
|
|
1614
|
-
sessionCreated?: SessionCreated;
|
|
1615
|
-
sessionUpdated?: SessionUpdated;
|
|
1616
|
-
sessionCancelled?: SessionCancelled;
|
|
1617
|
-
availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
|
|
1618
|
-
intervalSplit?: IntervalSplit;
|
|
1619
|
-
recurringSessionSplit?: RecurringSessionSplit;
|
|
1620
|
-
/** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */
|
|
1621
|
-
scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
|
|
1622
|
-
preserveFutureSessionsWithParticipants?: boolean | null;
|
|
1623
|
-
/** Whether to notify participants about changed sessions. deprecated, use participant_notification */
|
|
1624
|
-
notifyParticipants?: boolean;
|
|
1625
|
-
/** site properties. Optional. Given in create schedule notification. */
|
|
1626
|
-
siteProperties?: SitePropertiesOnScheduleCreation;
|
|
1627
|
-
instanceId?: string;
|
|
1628
|
-
}
|
|
1629
|
-
/** @oneof */
|
|
1630
|
-
export interface ScheduleNotificationEventOneOf {
|
|
1631
|
-
scheduleCreated?: ScheduleCreated;
|
|
1632
|
-
scheduleUpdated?: ScheduleUpdated;
|
|
1633
|
-
scheduleCancelled?: ScheduleCancelled;
|
|
1634
|
-
sessionCreated?: SessionCreated;
|
|
1635
|
-
sessionUpdated?: SessionUpdated;
|
|
1636
|
-
sessionCancelled?: SessionCancelled;
|
|
1637
|
-
availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
|
|
1638
|
-
intervalSplit?: IntervalSplit;
|
|
1639
|
-
recurringSessionSplit?: RecurringSessionSplit;
|
|
1640
|
-
/** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */
|
|
1641
|
-
scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
|
|
1642
|
-
}
|
|
1643
|
-
export interface ScheduleCreated {
|
|
1644
|
-
schedule?: V1Schedule;
|
|
1645
|
-
}
|
|
1646
|
-
export interface V1Schedule {
|
|
1647
|
-
/** Schedule ID. */
|
|
1648
|
-
_id?: string;
|
|
1649
|
-
/** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
|
|
1650
|
-
scheduleOwnerId?: string | null;
|
|
1651
|
-
/**
|
|
1652
|
-
* Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
|
|
1653
|
-
* Derived from the Wix Business time zone.
|
|
1654
|
-
* @readonly
|
|
1655
|
-
*/
|
|
1656
|
-
timeZone?: string | null;
|
|
1657
|
-
/** Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead. */
|
|
1658
|
-
intervals?: RecurringInterval[];
|
|
1659
|
-
/** Default title for the schedule's sessions. Maximum length: 6000 characters. */
|
|
1660
|
-
title?: string | null;
|
|
1661
|
-
/**
|
|
1662
|
-
* __Deprecated.__
|
|
1663
|
-
* Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
|
|
1664
|
-
* The Wix Bookings app uses the following predefined tags to set schedule type: `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.
|
|
1665
|
-
*/
|
|
1666
|
-
tags?: string[] | null;
|
|
1667
|
-
/** Default location for the schedule's sessions. */
|
|
1668
|
-
location?: V1Location;
|
|
1669
|
-
/**
|
|
1670
|
-
* Maximum number of participants that can be added to the schedule's sessions.
|
|
1671
|
-
* Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
|
|
1672
|
-
*/
|
|
1673
|
-
capacity?: number | null;
|
|
1674
|
-
/** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */
|
|
1675
|
-
rate?: Rate;
|
|
1676
|
-
/** __Deprecated.__ */
|
|
1677
|
-
availability?: Availability;
|
|
1678
|
-
/**
|
|
1679
|
-
* Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
|
|
1680
|
-
* @readonly
|
|
1681
|
-
*/
|
|
1682
|
-
totalNumberOfParticipants?: number;
|
|
1683
|
-
/**
|
|
1684
|
-
* *Partial list** of participants which are registered to sessions in this schedule.
|
|
1685
|
-
* Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
|
|
1686
|
-
* To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
|
|
1687
|
-
* @readonly
|
|
1688
|
-
*/
|
|
1689
|
-
participants?: Participant[];
|
|
1690
|
-
/** __Deprecated.__ */
|
|
1691
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
1692
|
-
/**
|
|
1693
|
-
* Schedule status.
|
|
1694
|
-
* @readonly
|
|
1695
|
-
*/
|
|
1696
|
-
status?: ScheduleStatus;
|
|
1697
|
-
/**
|
|
1698
|
-
* Schedule creation date.
|
|
1699
|
-
* @readonly
|
|
1700
|
-
*/
|
|
1701
|
-
created?: Date;
|
|
1702
|
-
/**
|
|
1703
|
-
* Schedule last update date.
|
|
1704
|
-
* @readonly
|
|
1705
|
-
*/
|
|
1706
|
-
updated?: Date;
|
|
1707
|
-
/**
|
|
1708
|
-
* Schedule version number, updated each time the schedule is updated.
|
|
1709
|
-
* @readonly
|
|
1710
|
-
*/
|
|
1711
|
-
version?: number;
|
|
1712
|
-
/**
|
|
1713
|
-
* Fields which were inherited from the Business Info page under Settings in the Dashboard.
|
|
1714
|
-
* @readonly
|
|
1715
|
-
*/
|
|
1716
|
-
inheritedFields?: string[];
|
|
1717
|
-
/** __Deprecated.__ */
|
|
1718
|
-
conferenceProvider?: ConferenceProvider;
|
|
1719
|
-
/**
|
|
1720
|
-
* A conference created for the schedule. This is used when a participant is added to a schedule.
|
|
1721
|
-
* **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
|
|
1722
|
-
*/
|
|
1723
|
-
calendarConference?: CalendarConference;
|
|
1724
|
-
}
|
|
1725
|
-
export interface RecurringInterval {
|
|
1726
|
-
/**
|
|
1727
|
-
* The recurring interval identifier.
|
|
1728
|
-
* @readonly
|
|
1729
|
-
*/
|
|
1730
|
-
_id?: string;
|
|
1731
|
-
/** The start time of the recurring interval. Required. */
|
|
1732
|
-
start?: Date;
|
|
1733
|
-
/** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */
|
|
1734
|
-
end?: Date;
|
|
1735
|
-
/** The interval rules. The day, hour and minutes the interval is recurring. */
|
|
1736
|
-
interval?: Interval;
|
|
1737
|
-
/** The frequency of the interval. Optional. The default is frequency with the default repetition. */
|
|
1738
|
-
frequency?: Frequency;
|
|
1739
|
-
/** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */
|
|
1740
|
-
affectedSchedules?: LinkedSchedule[];
|
|
1741
|
-
/**
|
|
1742
|
-
* The type of recurring interval.
|
|
1743
|
-
* <!--ONLY:VELO
|
|
1744
|
-
* One of:
|
|
1745
|
-
* - `"UNDEFINED"` The default value. Sessions for this interval will be of type EVENT.
|
|
1746
|
-
* - `"EVENT"` A recurring interval of events.
|
|
1747
|
-
* - `"WORKING_HOURS"` A recurring interval for availability.
|
|
1748
|
-
* <!--END:ONLY:VELO-->
|
|
1749
|
-
*/
|
|
1750
|
-
intervalType?: RecurringIntervalType;
|
|
1751
|
-
}
|
|
1752
|
-
export interface Interval {
|
|
1753
|
-
/** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */
|
|
1754
|
-
daysOfWeek?: Day;
|
|
1755
|
-
/** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */
|
|
1756
|
-
hourOfDay?: number | null;
|
|
1757
|
-
/** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */
|
|
1758
|
-
minuteOfHour?: number | null;
|
|
1759
|
-
/** The duration of the interval in minutes. Required. Part of the session end time calculation. */
|
|
1760
|
-
duration?: number;
|
|
1761
|
-
}
|
|
1762
|
-
export declare enum Day {
|
|
1763
|
-
/** Undefined. */
|
|
1764
|
-
UNDEFINED = "UNDEFINED",
|
|
1765
|
-
/** Monday. */
|
|
1766
|
-
MON = "MON",
|
|
1767
|
-
/** Tuesday. */
|
|
1768
|
-
TUE = "TUE",
|
|
1769
|
-
/** Wednesday. */
|
|
1770
|
-
WED = "WED",
|
|
1771
|
-
/** Thursday. */
|
|
1772
|
-
THU = "THU",
|
|
1773
|
-
/** Friday. */
|
|
1774
|
-
FRI = "FRI",
|
|
1775
|
-
/** Saturday. */
|
|
1776
|
-
SAT = "SAT",
|
|
1777
|
-
/** Sunday. */
|
|
1778
|
-
SUN = "SUN"
|
|
1779
|
-
}
|
|
1780
|
-
export interface Frequency {
|
|
1781
|
-
/** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */
|
|
1782
|
-
repetition?: number | null;
|
|
1783
|
-
}
|
|
1784
|
-
export interface LinkedSchedule {
|
|
1785
|
-
/** Schedule ID. */
|
|
1786
|
-
scheduleId?: string;
|
|
1787
|
-
/**
|
|
1788
|
-
* Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`.
|
|
1789
|
-
* <!--ONLY:REST-->
|
|
1790
|
-
* If set to `"BUSY"`, this schedule cannot have any available slots during the linked schedule's sessions.
|
|
1791
|
-
* If set to `"FREE"`, this schedule can have available slots during the linked schedule's sessions.
|
|
1792
|
-
* <!--END:ONLY:REST-->
|
|
1793
|
-
*
|
|
1794
|
-
* <!--ONLY:VELO
|
|
1795
|
-
* One of:
|
|
1796
|
-
* - `"FREE"` This schedule can have available slots during the linked schedule's sessions.
|
|
1797
|
-
* - `"BUSY"` This schedule cannot have any available slots during the linked schedule's sessions.
|
|
1798
|
-
* <!--END:ONLY:VELO-->
|
|
1799
|
-
*/
|
|
1800
|
-
transparency?: Transparency;
|
|
1801
|
-
/**
|
|
1802
|
-
* Owner ID, of the linked schedule.
|
|
1803
|
-
* @readonly
|
|
1804
|
-
*/
|
|
1805
|
-
scheduleOwnerId?: string;
|
|
1806
|
-
}
|
|
1807
|
-
export declare enum Transparency {
|
|
1808
|
-
UNDEFINED = "UNDEFINED",
|
|
1809
|
-
/** The schedule can have available slots during the session. */
|
|
1810
|
-
FREE = "FREE",
|
|
1811
|
-
/** The schedule cannot have available slots during the session. Default value. */
|
|
1812
|
-
BUSY = "BUSY"
|
|
1813
|
-
}
|
|
1814
|
-
export declare enum RecurringIntervalType {
|
|
1815
|
-
/** The default value. Sessions for this interval will be of type EVENT. */
|
|
1816
|
-
UNDEFINED = "UNDEFINED",
|
|
1817
|
-
/** A recurring interval of events */
|
|
1818
|
-
EVENT = "EVENT",
|
|
1819
|
-
/** Deprecated */
|
|
1820
|
-
TIME_AVAILABILITY = "TIME_AVAILABILITY",
|
|
1821
|
-
/** A recurring interval for availability */
|
|
1822
|
-
AVAILABILITY = "AVAILABILITY"
|
|
1823
|
-
}
|
|
1824
|
-
export interface V1Location {
|
|
1825
|
-
/**
|
|
1826
|
-
* Location type.
|
|
1827
|
-
* One of:
|
|
1828
|
-
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
1829
|
-
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
1830
|
-
* - `"CUSTOM"` The address set for the individual session.
|
|
1831
|
-
*/
|
|
1832
|
-
locationType?: LocationLocationType;
|
|
1833
|
-
/** Free text address used when locationType is `OWNER_CUSTOM`. */
|
|
1834
|
-
address?: string | null;
|
|
1835
|
-
/** Custom address, used when locationType is `"OWNER_CUSTOM"`. Might be used when locationType is `"CUSTOM"` in case the owner sets a custom address for the session which is different from the default. */
|
|
1836
|
-
customAddress?: CommonAddress;
|
|
1837
|
-
}
|
|
1838
|
-
export declare enum LocationLocationType {
|
|
1839
|
-
UNDEFINED = "UNDEFINED",
|
|
1840
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
1841
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
1842
|
-
CUSTOM = "CUSTOM"
|
|
1843
|
-
}
|
|
1844
|
-
/** Physical address */
|
|
1845
|
-
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
1846
|
-
/** Street name, number and apartment number. */
|
|
1847
|
-
streetAddress?: CommonStreetAddress;
|
|
1848
|
-
/** Main address line, usually street and number, as free text. */
|
|
1849
|
-
addressLine?: string | null;
|
|
1850
|
-
/** Country code. */
|
|
1851
|
-
country?: string | null;
|
|
1852
|
-
/** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
1853
|
-
subdivision?: string | null;
|
|
1854
|
-
/** City name. */
|
|
1855
|
-
city?: string | null;
|
|
1856
|
-
/** Zip/postal code. */
|
|
1857
|
-
postalCode?: string | null;
|
|
1858
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
1859
|
-
addressLine2?: string | null;
|
|
1860
|
-
/** A string containing the full address of this location. */
|
|
1861
|
-
formattedAddress?: string | null;
|
|
1862
|
-
/** Free text to help find the address. */
|
|
1863
|
-
hint?: string | null;
|
|
1864
|
-
/** Coordinates of the physical address. */
|
|
1865
|
-
geocode?: CommonAddressLocation;
|
|
1866
|
-
/** Country full name. */
|
|
1867
|
-
countryFullname?: string | null;
|
|
1868
|
-
/** Multi-level subdivisions from top to bottom. */
|
|
1869
|
-
subdivisions?: Subdivision[];
|
|
1870
|
-
}
|
|
1871
|
-
/** @oneof */
|
|
1872
|
-
export interface CommonAddressStreetOneOf {
|
|
1873
|
-
/** Street name, number and apartment number. */
|
|
1874
|
-
streetAddress?: CommonStreetAddress;
|
|
1875
|
-
/** Main address line, usually street and number, as free text. */
|
|
1876
|
-
addressLine?: string | null;
|
|
1877
|
-
}
|
|
1878
|
-
export interface CommonStreetAddress {
|
|
1879
|
-
/** Street number. */
|
|
1880
|
-
number?: string;
|
|
1881
|
-
/** Street name. */
|
|
1882
|
-
name?: string;
|
|
1883
|
-
/** Apartment number. */
|
|
1884
|
-
apt?: string;
|
|
1885
|
-
}
|
|
1886
|
-
export interface CommonAddressLocation {
|
|
1887
|
-
/** Address latitude. */
|
|
1888
|
-
latitude?: number | null;
|
|
1889
|
-
/** Address longitude. */
|
|
1890
|
-
longitude?: number | null;
|
|
1891
|
-
}
|
|
1892
|
-
export interface Subdivision {
|
|
1893
|
-
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
1894
|
-
code?: string;
|
|
1895
|
-
/** Subdivision full name. */
|
|
1896
|
-
name?: string;
|
|
1897
|
-
}
|
|
1898
|
-
export interface LocationsLocation {
|
|
1899
|
-
/**
|
|
1900
|
-
* Location ID.
|
|
1901
|
-
* @readonly
|
|
1902
|
-
*/
|
|
1903
|
-
_id?: string | null;
|
|
1904
|
-
/** Location name. */
|
|
1905
|
-
name?: string;
|
|
1906
|
-
/** Location description. */
|
|
1907
|
-
description?: string | null;
|
|
1908
|
-
/**
|
|
1909
|
-
* Whether this is the default location. There can only be one default location per site. The default location can't be archived.
|
|
1910
|
-
* @readonly
|
|
1911
|
-
*/
|
|
1912
|
-
default?: boolean;
|
|
1913
|
-
/**
|
|
1914
|
-
* Location status. Defaults to `ACTIVE`.
|
|
1915
|
-
* __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
|
|
1916
|
-
* doesn't affect the location's status. `INACTIVE` is currently not supported.
|
|
1917
|
-
*/
|
|
1918
|
-
status?: LocationStatus;
|
|
1919
|
-
/**
|
|
1920
|
-
* Location type.
|
|
1921
|
-
*
|
|
1922
|
-
* **Note:** Currently not supported.
|
|
1923
|
-
*/
|
|
1924
|
-
locationType?: LocationsLocationType;
|
|
1925
|
-
/** Fax number. */
|
|
1926
|
-
fax?: string | null;
|
|
1927
|
-
/** Timezone in `America/New_York` format. */
|
|
1928
|
-
timeZone?: string | null;
|
|
1929
|
-
/** Email address. */
|
|
1930
|
-
email?: string | null;
|
|
1931
|
-
/** Phone number. */
|
|
1932
|
-
phone?: string | null;
|
|
1933
|
-
/** Address. */
|
|
1934
|
-
address?: LocationsAddress;
|
|
1935
|
-
/**
|
|
1936
|
-
* Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.
|
|
1937
|
-
*
|
|
1938
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
1939
|
-
*/
|
|
1940
|
-
businessSchedule?: BusinessSchedule;
|
|
1941
|
-
/**
|
|
1942
|
-
* Revision number, which increments by 1 each time the location is updated.
|
|
1943
|
-
* To prevent conflicting changes, the existing revision must be used when updating a location.
|
|
1944
|
-
*/
|
|
1945
|
-
revision?: string | null;
|
|
1946
|
-
/**
|
|
1947
|
-
* Whether the location is archived. Archived locations can't be updated.
|
|
1948
|
-
* __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
|
|
1949
|
-
* doesn't affect its `status`.
|
|
1950
|
-
* @readonly
|
|
1951
|
-
*/
|
|
1952
|
-
archived?: boolean;
|
|
1953
|
-
/** Location types. */
|
|
1954
|
-
locationTypes?: LocationsLocationType[];
|
|
1955
|
-
}
|
|
1956
|
-
/** For future use */
|
|
1957
|
-
export declare enum LocationStatus {
|
|
1958
|
-
ACTIVE = "ACTIVE",
|
|
1959
|
-
INACTIVE = "INACTIVE"
|
|
1960
|
-
}
|
|
1961
|
-
/** For future use */
|
|
1962
|
-
export declare enum LocationsLocationType {
|
|
1963
|
-
UNKNOWN = "UNKNOWN",
|
|
1964
|
-
BRANCH = "BRANCH",
|
|
1965
|
-
OFFICES = "OFFICES",
|
|
1966
|
-
RECEPTION = "RECEPTION",
|
|
1967
|
-
HEADQUARTERS = "HEADQUARTERS",
|
|
1968
|
-
INVENTORY = "INVENTORY"
|
|
1969
|
-
}
|
|
1970
|
-
export interface LocationsAddress {
|
|
1971
|
-
/** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1972
|
-
country?: string | null;
|
|
1973
|
-
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
|
|
1974
|
-
subdivision?: string | null;
|
|
1975
|
-
/** City name. */
|
|
1976
|
-
city?: string | null;
|
|
1977
|
-
/** Postal or zip code. */
|
|
1978
|
-
postalCode?: string | null;
|
|
1979
|
-
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
1980
|
-
streetAddress?: LocationsStreetAddress;
|
|
1981
|
-
/** Full address of the location. */
|
|
1982
|
-
formatted?: string | null;
|
|
1983
|
-
/** Geographic coordinates of location. */
|
|
1984
|
-
location?: LocationsAddressLocation;
|
|
1985
|
-
}
|
|
1986
|
-
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
1987
|
-
export interface LocationsStreetAddress {
|
|
1988
|
-
/** Street number. */
|
|
1989
|
-
number?: string;
|
|
1990
|
-
/** Street name. */
|
|
1991
|
-
name?: string;
|
|
1992
|
-
/** Apartment number. */
|
|
1993
|
-
apt?: string;
|
|
1994
|
-
}
|
|
1995
|
-
/** Address Geolocation */
|
|
1996
|
-
export interface LocationsAddressLocation {
|
|
1997
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
1998
|
-
latitude?: number | null;
|
|
1999
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
2000
|
-
longitude?: number | null;
|
|
2001
|
-
}
|
|
2002
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
2003
|
-
export interface BusinessSchedule {
|
|
2004
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
|
|
2005
|
-
periods?: TimePeriod[];
|
|
2006
|
-
/** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
|
|
2007
|
-
specialHourPeriod?: SpecialHourPeriod[];
|
|
2008
|
-
}
|
|
2009
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
2010
|
-
export interface TimePeriod {
|
|
2011
|
-
/** Day of the week the period starts on. */
|
|
2012
|
-
openDay?: DayOfWeek;
|
|
2013
|
-
/**
|
|
2014
|
-
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
2015
|
-
* midnight at the end of the specified day.
|
|
2016
|
-
*/
|
|
2017
|
-
openTime?: string;
|
|
2018
|
-
/** Day of the week the period ends on. */
|
|
2019
|
-
closeDay?: DayOfWeek;
|
|
2020
|
-
/**
|
|
2021
|
-
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
2022
|
-
* midnight at the end of the specified day.
|
|
2023
|
-
*
|
|
2024
|
-
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
2025
|
-
*/
|
|
2026
|
-
closeTime?: string;
|
|
2027
|
-
}
|
|
2028
|
-
/** Enumerates the days of the week. */
|
|
2029
|
-
export declare enum DayOfWeek {
|
|
2030
|
-
MONDAY = "MONDAY",
|
|
2031
|
-
TUESDAY = "TUESDAY",
|
|
2032
|
-
WEDNESDAY = "WEDNESDAY",
|
|
2033
|
-
THURSDAY = "THURSDAY",
|
|
2034
|
-
FRIDAY = "FRIDAY",
|
|
2035
|
-
SATURDAY = "SATURDAY",
|
|
2036
|
-
SUNDAY = "SUNDAY"
|
|
2037
|
-
}
|
|
2038
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
2039
|
-
export interface SpecialHourPeriod {
|
|
2040
|
-
/** 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). */
|
|
2041
|
-
startDate?: string;
|
|
2042
|
-
/** 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). */
|
|
2043
|
-
endDate?: string;
|
|
2044
|
-
/**
|
|
2045
|
-
* Whether the business is closed (or the service is not available) during the exception.
|
|
2046
|
-
*
|
|
2047
|
-
* Default: `true`.
|
|
2048
|
-
*/
|
|
2049
|
-
isClosed?: boolean;
|
|
2050
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
2051
|
-
comment?: string;
|
|
2052
|
-
}
|
|
2053
|
-
export interface Rate {
|
|
2054
|
-
/**
|
|
2055
|
-
* Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
|
|
2056
|
-
* When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
|
|
2057
|
-
*/
|
|
2058
|
-
labeledPriceOptions?: Record<string, Price>;
|
|
2059
|
-
/**
|
|
2060
|
-
* Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
|
|
2061
|
-
* When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
|
|
2062
|
-
*/
|
|
2063
|
-
priceText?: string | null;
|
|
2064
|
-
}
|
|
2065
|
-
export interface Price {
|
|
2066
|
-
/** Required payment amount. */
|
|
2067
|
-
amount?: string;
|
|
2068
|
-
/** Currency in which the amount is quoted. */
|
|
2069
|
-
currency?: string;
|
|
2070
|
-
/** Amount of a down payment or deposit as part of the transaction. */
|
|
2071
|
-
downPayAmount?: string;
|
|
2072
|
-
}
|
|
2073
|
-
/**
|
|
2074
|
-
* <!-- Needs updating when recurrence has been tested
|
|
2075
|
-
* Schedule's availability calculation is executed by the schedule's available intervals and this additional information.
|
|
2076
|
-
* Schedule's available intervals are recurring intervals (defined in the schedule) minus sessions that has no more spots for bookings (including time between_slots), or schedule's sessions with open spots for bookings.-->
|
|
2077
|
-
*/
|
|
2078
|
-
export interface Availability {
|
|
2079
|
-
/** Date and time the schedule starts to be available for booking. */
|
|
2080
|
-
start?: Date;
|
|
2081
|
-
/** Date and time the schedule stops being available for booking. No value indicates no end time. */
|
|
2082
|
-
end?: Date;
|
|
2083
|
-
/** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */
|
|
2084
|
-
linkedSchedules?: LinkedSchedule[];
|
|
2085
|
-
/** Constraints for calculating the schedule's availability. */
|
|
2086
|
-
constraints?: V1AvailabilityConstraints;
|
|
2087
|
-
}
|
|
2088
|
-
/** Describes how to calculate the specific slots that are available for booking. */
|
|
2089
|
-
export interface V1AvailabilityConstraints {
|
|
2090
|
-
/**
|
|
2091
|
-
* A list of duration options for slots, in minutes. Minimum value for a duration is 1.
|
|
2092
|
-
* The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
|
|
2093
|
-
*/
|
|
2094
|
-
slotDurations?: number[];
|
|
2095
|
-
/**
|
|
2096
|
-
* The number of minutes between the `end` of one slot, and the `start` of the next.
|
|
2097
|
-
* Minimum value is 0, maximum value is 120.
|
|
2098
|
-
*/
|
|
2099
|
-
timeBetweenSlots?: number;
|
|
2100
|
-
/**
|
|
2101
|
-
* Specify how to split the slots in intervals of minutes.
|
|
2102
|
-
* This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).
|
|
2103
|
-
* Optional. The default is the first duration in slot_durations field.
|
|
2104
|
-
* Deprecated. Use the `split_slots_interval.value_in_minutes`.
|
|
2105
|
-
*/
|
|
2106
|
-
splitInterval?: number | null;
|
|
2107
|
-
/**
|
|
2108
|
-
* An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.
|
|
2109
|
-
* @readonly
|
|
2110
|
-
*/
|
|
2111
|
-
slotsSplitInterval?: SplitInterval;
|
|
2112
|
-
}
|
|
2113
|
-
/** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
|
|
2114
|
-
export interface SplitInterval {
|
|
2115
|
-
/**
|
|
2116
|
-
* Whether the slot duration is used as the split interval value.
|
|
2117
|
-
* If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
|
|
2118
|
-
* `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
|
|
2119
|
-
*/
|
|
2120
|
-
sameAsDuration?: boolean | null;
|
|
2121
|
-
/** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
|
|
2122
|
-
valueInMinutes?: number | null;
|
|
2123
|
-
}
|
|
2124
|
-
export interface Participant {
|
|
2125
|
-
/** Participant ID. Currently represents the booking.id. */
|
|
2126
|
-
_id?: string;
|
|
2127
|
-
/** Contact ID. */
|
|
2128
|
-
contactId?: string | null;
|
|
2129
|
-
/** Participant's name. */
|
|
2130
|
-
name?: string | null;
|
|
2131
|
-
/** Participant's phone number. */
|
|
2132
|
-
phone?: string | null;
|
|
2133
|
-
/** Participant's email address. */
|
|
2134
|
-
email?: string | null;
|
|
2135
|
-
/** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */
|
|
2136
|
-
partySize?: number;
|
|
2137
|
-
/**
|
|
2138
|
-
* Approval status for the participant.
|
|
2139
|
-
* <!-- Commented out untill updateParticipant is exposed Generally the same status as the booking, unless updated using the `updateParticipant()` API. Defaults to `"UNDEFINED"`.-->
|
|
2140
|
-
* <!--ONLY:VELO
|
|
2141
|
-
* One of:
|
|
2142
|
-
* - `"PENDING"` Pending business approval.
|
|
2143
|
-
* - `"APPROVED"` Approved by the business.
|
|
2144
|
-
* - `"DECLINED"` Declined by the business.
|
|
2145
|
-
* <!--END:ONLY:VELO-->
|
|
2146
|
-
*/
|
|
2147
|
-
approvalStatus?: ApprovalStatus;
|
|
2148
|
-
/**
|
|
2149
|
-
* Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.
|
|
2150
|
-
* @readonly
|
|
2151
|
-
*/
|
|
2152
|
-
inherited?: boolean;
|
|
2153
|
-
}
|
|
2154
|
-
export declare enum ApprovalStatus {
|
|
2155
|
-
/** Default. */
|
|
2156
|
-
UNDEFINED = "UNDEFINED",
|
|
2157
|
-
/** Pending business approval. */
|
|
2158
|
-
PENDING = "PENDING",
|
|
2159
|
-
/** Approved by the business. */
|
|
2160
|
-
APPROVED = "APPROVED",
|
|
2161
|
-
/** Declined by the business. */
|
|
2162
|
-
DECLINED = "DECLINED"
|
|
2163
|
-
}
|
|
2164
|
-
export interface ExternalCalendarOverrides {
|
|
2165
|
-
/** Synced title of the external calendar event. */
|
|
2166
|
-
title?: string | null;
|
|
2167
|
-
/** Synced description of the external calendar event. */
|
|
2168
|
-
description?: string | null;
|
|
2169
|
-
}
|
|
2170
|
-
export declare enum ScheduleStatus {
|
|
2171
|
-
UNDEFINED = "UNDEFINED",
|
|
2172
|
-
/** The default value when the schedule is created. */
|
|
2173
|
-
CREATED = "CREATED",
|
|
2174
|
-
/** The schedule has been canceled. */
|
|
2175
|
-
CANCELLED = "CANCELLED"
|
|
2176
|
-
}
|
|
2177
|
-
export interface Version {
|
|
2178
|
-
/** Schedule version number, updated each time the schedule is updated. */
|
|
2179
|
-
scheduleVersion?: number | null;
|
|
2180
|
-
/** Participants version number, updated each time the schedule participants are updated. */
|
|
2181
|
-
participantsVersion?: number | null;
|
|
2182
|
-
}
|
|
2183
|
-
export interface ConferenceProvider {
|
|
2184
|
-
/** Conferencing provider ID */
|
|
2185
|
-
providerId?: string;
|
|
2186
|
-
}
|
|
2187
|
-
export interface CalendarConference {
|
|
2188
|
-
/** Wix Calendar conference ID. */
|
|
2189
|
-
_id?: string;
|
|
2190
|
-
/** Conference meeting ID in the provider's conferencing system. */
|
|
2191
|
-
externalId?: string;
|
|
2192
|
-
/** Conference provider ID. */
|
|
2193
|
-
providerId?: string;
|
|
2194
|
-
/** URL used by the host to start the conference. */
|
|
2195
|
-
hostUrl?: string;
|
|
2196
|
-
/** URL used by a guest to join the conference. */
|
|
2197
|
-
guestUrl?: string;
|
|
2198
|
-
/** Password to join the conference. */
|
|
2199
|
-
password?: string | null;
|
|
2200
|
-
/** Conference description. */
|
|
2201
|
-
description?: string | null;
|
|
2202
|
-
/**
|
|
2203
|
-
* Conference type.
|
|
2204
|
-
* <!--ONLY:VELO
|
|
2205
|
-
* One of:
|
|
2206
|
-
* - `"ONLINE_MEETING_PROVIDER"` API-generated online meeting.
|
|
2207
|
-
* - `"CUSTOM"` User-defined meeting.
|
|
2208
|
-
* <!--END:ONLY:VELO-->
|
|
2209
|
-
*/
|
|
2210
|
-
conferenceType?: ConferenceType;
|
|
2211
|
-
/** ID of the account owner in the video conferencing service. */
|
|
2212
|
-
accountOwnerId?: string | null;
|
|
2213
|
-
}
|
|
2214
|
-
export declare enum ConferenceType {
|
|
2215
|
-
UNDEFINED = "UNDEFINED",
|
|
2216
|
-
/** API-generated online meeting. */
|
|
2217
|
-
ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
|
|
2218
|
-
/** User-defined meeting. */
|
|
2219
|
-
CUSTOM = "CUSTOM"
|
|
2220
|
-
}
|
|
2221
|
-
export interface ScheduleUpdated {
|
|
2222
|
-
/** The old schedule before the update. */
|
|
2223
|
-
oldSchedule?: V1Schedule;
|
|
2224
|
-
/** The new schedule after the update. */
|
|
2225
|
-
newSchedule?: V1Schedule;
|
|
2226
|
-
/**
|
|
2227
|
-
* Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
|
|
2228
|
-
* updating at least one of the given schedule's recurring sessions.
|
|
2229
|
-
* This event is triggered by create/update/delete recurring session apis.
|
|
2230
|
-
*/
|
|
2231
|
-
recurringSessions?: RecurringSessionsUpdated;
|
|
2232
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
2233
|
-
participantNotification?: V1ParticipantNotification;
|
|
2234
|
-
/**
|
|
2235
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
2236
|
-
* An anonymized participant will have the following details:
|
|
2237
|
-
* name = "deleted"
|
|
2238
|
-
* phone = "deleted"
|
|
2239
|
-
* email = "deleted@deleted.com"
|
|
2240
|
-
*/
|
|
2241
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2242
|
-
}
|
|
2243
|
-
export interface RecurringSessionsUpdated {
|
|
2244
|
-
/** Old schedule's recurring session list. */
|
|
2245
|
-
oldRecurringSessions?: Session[];
|
|
2246
|
-
/** New schedule's recurring session list. */
|
|
2247
|
-
newRecurringSessions?: Session[];
|
|
2248
|
-
}
|
|
2249
|
-
export interface Session {
|
|
2250
|
-
/**
|
|
2251
|
-
* Session ID.
|
|
2252
|
-
* @readonly
|
|
2253
|
-
*/
|
|
2254
|
-
_id?: string | null;
|
|
2255
|
-
/** ID of the schedule that the session belongs to. */
|
|
2256
|
-
scheduleId?: string;
|
|
2257
|
-
/**
|
|
2258
|
-
* ID of the resource or service that the session's schedule belongs to.
|
|
2259
|
-
* @readonly
|
|
2260
|
-
*/
|
|
2261
|
-
scheduleOwnerId?: string | null;
|
|
2262
|
-
/** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
|
|
2263
|
-
originalStart?: Date;
|
|
2264
|
-
/** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
|
|
2265
|
-
start?: CalendarDateTime;
|
|
2266
|
-
/**
|
|
2267
|
-
* An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.
|
|
2268
|
-
* If the session is a recurring session, `end` must contain a `localDateTime`.
|
|
2269
|
-
*/
|
|
2270
|
-
end?: CalendarDateTime;
|
|
2271
|
-
/**
|
|
2272
|
-
* An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.
|
|
2273
|
-
* The array is inherited from the schedule and can be overridden even if the session is a recurring session.
|
|
2274
|
-
*/
|
|
2275
|
-
affectedSchedules?: LinkedSchedule[];
|
|
2276
|
-
/**
|
|
2277
|
-
* Session title.
|
|
2278
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
2279
|
-
*/
|
|
2280
|
-
title?: string | null;
|
|
2281
|
-
/**
|
|
2282
|
-
* __Deprecated.__
|
|
2283
|
-
* Tags for the session.
|
|
2284
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
2285
|
-
*/
|
|
2286
|
-
tags?: string[] | null;
|
|
2287
|
-
/**
|
|
2288
|
-
* An object describing the location where the session takes place.
|
|
2289
|
-
* Defaults to the schedule location.
|
|
2290
|
-
* For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.
|
|
2291
|
-
*/
|
|
2292
|
-
location?: V1Location;
|
|
2293
|
-
/**
|
|
2294
|
-
* Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
|
|
2295
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
2296
|
-
*/
|
|
2297
|
-
capacity?: number | null;
|
|
2298
|
-
/** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */
|
|
2299
|
-
rate?: Rate;
|
|
2300
|
-
/**
|
|
2301
|
-
* Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
|
|
2302
|
-
* If the session is a recurring session, this field must be empty.
|
|
2303
|
-
*/
|
|
2304
|
-
timeReservedAfter?: number | null;
|
|
2305
|
-
/**
|
|
2306
|
-
* Additional information about the session.
|
|
2307
|
-
* Notes are not supported for recurring sessions.
|
|
2308
|
-
*/
|
|
2309
|
-
notes?: string;
|
|
2310
|
-
/**
|
|
2311
|
-
* The number of participants booked for the session. Read-only.
|
|
2312
|
-
* Calculated as the sum of the party sizes.
|
|
2313
|
-
* @readonly
|
|
2314
|
-
*/
|
|
2315
|
-
totalNumberOfParticipants?: number;
|
|
2316
|
-
/**
|
|
2317
|
-
* *Partial list** list of participants booked for the session.
|
|
2318
|
-
* The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
|
|
2319
|
-
* If the session is a recurring session, this field must be empty.
|
|
2320
|
-
* To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
|
|
2321
|
-
*/
|
|
2322
|
-
participants?: Participant[];
|
|
2323
|
-
/**
|
|
2324
|
-
* A list of properties for which values were inherited from the schedule.
|
|
2325
|
-
* This does not include participants that were inherited from the schedule.
|
|
2326
|
-
* @readonly
|
|
2327
|
-
*/
|
|
2328
|
-
inheritedFields?: string[];
|
|
2329
|
-
/** __Deprecated.__ */
|
|
2330
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
2331
|
-
/**
|
|
2332
|
-
* Session status.
|
|
2333
|
-
* <!--ONLY:VELO
|
|
2334
|
-
* One of:
|
|
2335
|
-
* - `"CONFIRMED"` Default value.
|
|
2336
|
-
* - `"CANCELLED"` The session was deleted.
|
|
2337
|
-
* <!--END:ONLY:VELO-->
|
|
2338
|
-
* @readonly
|
|
2339
|
-
*/
|
|
2340
|
-
status?: SessionStatus;
|
|
2341
|
-
/**
|
|
2342
|
-
* Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
|
|
2343
|
-
* For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
|
|
2344
|
-
* This field is omitted for single sessions or instances of recurring sessions.
|
|
2345
|
-
* Specified when the session was originally generated from a schedule recurring interval.
|
|
2346
|
-
* Deprecated. Use `recurringSessionId`.
|
|
2347
|
-
* @readonly
|
|
2348
|
-
*/
|
|
2349
|
-
recurringIntervalId?: string | null;
|
|
2350
|
-
/**
|
|
2351
|
-
* The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.
|
|
2352
|
-
* @readonly
|
|
2353
|
-
*/
|
|
2354
|
-
recurringSessionId?: string | null;
|
|
2355
|
-
/**
|
|
2356
|
-
* Session type.
|
|
2357
|
-
* <!--ONLY:VELO
|
|
2358
|
-
* One of:
|
|
2359
|
-
* - `"EVENT"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.
|
|
2360
|
-
* - `"WORKING_HOURS"` Placeholder for available time on a resource’s schedule.
|
|
2361
|
-
* <!--END:ONLY:VELO-->
|
|
2362
|
-
*/
|
|
2363
|
-
type?: SessionType;
|
|
2364
|
-
/**
|
|
2365
|
-
* A conference created for the session according to the details set in the schedule's conference provider information.
|
|
2366
|
-
* If the session is a recurring session, this field is inherited from the schedule.
|
|
2367
|
-
* **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
|
|
2368
|
-
*/
|
|
2369
|
-
calendarConference?: CalendarConference;
|
|
2370
|
-
/**
|
|
2371
|
-
* A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).
|
|
2372
|
-
* If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.
|
|
2373
|
-
* The RRULE defines a rule for repeating a session.
|
|
2374
|
-
* Supported parameters are:
|
|
2375
|
-
*
|
|
2376
|
-
* |Keyword|Description|Supported values|
|
|
2377
|
-
* |--|--|---|
|
|
2378
|
-
* |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
|
|
2379
|
-
* |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
|
|
2380
|
-
* |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
|
|
2381
|
-
* |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
|
|
2382
|
-
*
|
|
2383
|
-
*
|
|
2384
|
-
* For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
|
|
2385
|
-
* `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
|
|
2386
|
-
*
|
|
2387
|
-
* <!--ORIGINAL COMMENTS:
|
|
2388
|
-
* `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
|
|
2389
|
-
* Supported `WEEKLY` value is supported.
|
|
2390
|
-
* INTERVAL — Works together with FREQ to specify how often the session should be repeated. For example, FREQ=WEEKLY;INTERVAL=2 means once every two weeks. Optional. Default value is 1.
|
|
2391
|
-
* COUNT — The number of times this event should be repeated. Not yet supported.
|
|
2392
|
-
* UNTIL — The UTC date & time until which the session should be repeated. This parameter is optional. When it is not specified, the event repeats forever.
|
|
2393
|
-
* The format is a short ISO date, followed by 'T' and a short time with seconds and without milliseconds, terminated by the UTC designator 'Z'. For example, until Jan. 19th 2018 at 7:00 AM: 'UNTIL=20180119T070000Z'.
|
|
2394
|
-
* BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
|
|
2395
|
-
* Possible values are: MO, TU, WE, TH, FR, SA, SU
|
|
2396
|
-
* Note that DTSTART and DTEND lines are not allowed in this field; session start and end times are specified in the start and end fields.
|
|
2397
|
-
* **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
|
|
2398
|
-
* ORIGINAL COMMENTS-->
|
|
2399
|
-
*/
|
|
2400
|
-
recurrence?: string | null;
|
|
2401
|
-
/**
|
|
2402
|
-
* A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
|
|
2403
|
-
* Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.
|
|
2404
|
-
* @readonly
|
|
2405
|
-
*/
|
|
2406
|
-
instanceOfRecurrence?: string | null;
|
|
2407
|
-
/**
|
|
2408
|
-
* The session version.
|
|
2409
|
-
* Composed by the schedule, session and participants versions.
|
|
2410
|
-
* @readonly
|
|
2411
|
-
*/
|
|
2412
|
-
version?: SessionVersion;
|
|
2413
|
-
}
|
|
2414
|
-
export interface CalendarDateTime {
|
|
2415
|
-
/**
|
|
2416
|
-
* UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `"2021-01-06T23:00:00.000Z"`.
|
|
2417
|
-
* Required if `localDateTime` is not specified.
|
|
2418
|
-
* If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
|
|
2419
|
-
*/
|
|
2420
|
-
timestamp?: Date;
|
|
2421
|
-
/** An object containing the local date and time for the business's time zone. */
|
|
2422
|
-
localDateTime?: LocalDateTime;
|
|
2423
|
-
/**
|
|
2424
|
-
* The time zone. Optional. Derived from the schedule's time zone.
|
|
2425
|
-
* In case this field is associated with recurring session, this field is empty.
|
|
2426
|
-
* @readonly
|
|
2427
|
-
*/
|
|
2428
|
-
timeZone?: string | null;
|
|
2429
|
-
}
|
|
2430
|
-
export interface LocalDateTime {
|
|
2431
|
-
/** Year. 4-digit format. */
|
|
2432
|
-
year?: number | null;
|
|
2433
|
-
/** Month number, from 1-12. */
|
|
2434
|
-
monthOfYear?: number | null;
|
|
2435
|
-
/** Day of the month, from 1-31. */
|
|
2436
|
-
dayOfMonth?: number | null;
|
|
2437
|
-
/** Hour of the day in 24-hour format, from 0-23. */
|
|
2438
|
-
hourOfDay?: number | null;
|
|
2439
|
-
/** Minute, from 0-59. */
|
|
2440
|
-
minutesOfHour?: number | null;
|
|
2441
|
-
}
|
|
2442
|
-
export interface ExternalCalendarInfo {
|
|
2443
|
-
/** The external calendar type (e.g. Google Calendar, iCal, etc). */
|
|
2444
|
-
calendarType?: CalendarType;
|
|
2445
|
-
}
|
|
2446
|
-
export declare enum CalendarType {
|
|
2447
|
-
UNDEFINED = "UNDEFINED",
|
|
2448
|
-
GOOGLE = "GOOGLE",
|
|
2449
|
-
I_CAL = "I_CAL",
|
|
2450
|
-
/** Use `MICROSOFT` instead. */
|
|
2451
|
-
OUTLOOK = "OUTLOOK",
|
|
2452
|
-
/** Use `MICROSOFT` instead. */
|
|
2453
|
-
OFFICE_365 = "OFFICE_365",
|
|
2454
|
-
MICROSOFT = "MICROSOFT",
|
|
2455
|
-
OTHER = "OTHER"
|
|
2456
|
-
}
|
|
2457
|
-
export declare enum SessionStatus {
|
|
2458
|
-
UNDEFINED = "UNDEFINED",
|
|
2459
|
-
/** The session is confirmed. Default status. */
|
|
2460
|
-
CONFIRMED = "CONFIRMED",
|
|
2461
|
-
/**
|
|
2462
|
-
* The session is cancelled.
|
|
2463
|
-
* A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
|
|
2464
|
-
* The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
|
|
2465
|
-
*/
|
|
2466
|
-
CANCELLED = "CANCELLED"
|
|
2467
|
-
}
|
|
2468
|
-
export declare enum SessionType {
|
|
2469
|
-
UNDEFINED = "UNDEFINED",
|
|
2470
|
-
/**
|
|
2471
|
-
* The session creates an event on the calendar for the owner of the schedule that the session belongs to.
|
|
2472
|
-
* Default type.
|
|
2473
|
-
*/
|
|
2474
|
-
EVENT = "EVENT",
|
|
2475
|
-
/** The session represents a resource's available working hours. */
|
|
2476
|
-
WORKING_HOURS = "WORKING_HOURS",
|
|
2477
|
-
/** Deprecated. please use WORKING_HOURS */
|
|
2478
|
-
TIME_AVAILABILITY = "TIME_AVAILABILITY",
|
|
2479
|
-
/** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */
|
|
2480
|
-
AVAILABILITY = "AVAILABILITY"
|
|
2481
|
-
}
|
|
2482
|
-
export interface SessionVersion {
|
|
2483
|
-
/** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
|
|
2484
|
-
number?: string | null;
|
|
2485
|
-
}
|
|
2486
|
-
export interface V1ParticipantNotification {
|
|
2487
|
-
/**
|
|
2488
|
-
* Whether to send the message about the changes to the customer.
|
|
2489
|
-
*
|
|
2490
|
-
* Default: `false`
|
|
2491
|
-
*/
|
|
2492
|
-
notifyParticipants?: boolean;
|
|
2493
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
2494
|
-
message?: string | null;
|
|
2495
|
-
}
|
|
2496
|
-
export interface ScheduleCancelled {
|
|
2497
|
-
schedule?: V1Schedule;
|
|
2498
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
2499
|
-
participantNotification?: V1ParticipantNotification;
|
|
2500
|
-
oldSchedule?: V1Schedule;
|
|
2501
|
-
}
|
|
2502
|
-
export interface SessionCreated {
|
|
2503
|
-
session?: Session;
|
|
2504
|
-
}
|
|
2505
|
-
export interface SessionUpdated {
|
|
2506
|
-
oldSession?: Session;
|
|
2507
|
-
newSession?: Session;
|
|
2508
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
2509
|
-
participantNotification?: V1ParticipantNotification;
|
|
2510
|
-
/**
|
|
2511
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
2512
|
-
* An anonymized participant will have the following details:
|
|
2513
|
-
* name = "deleted"
|
|
2514
|
-
* phone = "deleted"
|
|
2515
|
-
* email = "deleted@deleted.com"
|
|
2516
|
-
*/
|
|
2517
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2518
|
-
}
|
|
2519
|
-
export interface SessionCancelled {
|
|
2520
|
-
session?: Session;
|
|
2521
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
2522
|
-
participantNotification?: V1ParticipantNotification;
|
|
2523
|
-
}
|
|
2524
|
-
export interface AvailabilityPolicyUpdated {
|
|
2525
|
-
availabilityPolicy?: AvailabilityPolicy;
|
|
2526
|
-
}
|
|
2527
|
-
/** Availability policy applied to all site schedules. */
|
|
2528
|
-
export interface AvailabilityPolicy {
|
|
2529
|
-
/** Specify how to split the schedule slots in intervals of minutes. */
|
|
2530
|
-
splitInterval?: SplitInterval;
|
|
2531
|
-
}
|
|
2532
|
-
export interface IntervalSplit {
|
|
2533
|
-
scheduleId?: string;
|
|
2534
|
-
intervals?: RecurringInterval[];
|
|
2535
|
-
newScheduleVersion?: number | null;
|
|
2536
|
-
oldScheduleVersion?: number | null;
|
|
2537
|
-
}
|
|
2538
|
-
export interface RecurringSessionSplit {
|
|
2539
|
-
scheduleId?: string;
|
|
2540
|
-
recurringSessions?: Session[];
|
|
2541
|
-
newScheduleVersion?: number | null;
|
|
2542
|
-
oldScheduleVersion?: number | null;
|
|
2543
|
-
}
|
|
2544
|
-
/** Schedule unassigned from user. */
|
|
2545
|
-
export interface ScheduleUnassignedFromUser {
|
|
2546
|
-
/** The Wix user id. */
|
|
2547
|
-
userId?: string | null;
|
|
2548
|
-
/** The schedule that was unassigned from the user. */
|
|
2549
|
-
schedule?: V1Schedule;
|
|
2550
|
-
}
|
|
2551
|
-
export interface MultipleSessionsCreated {
|
|
2552
|
-
schedulesWithSessions?: ScheduleWithSessions[];
|
|
2553
|
-
}
|
|
2554
|
-
export interface ScheduleWithSessions {
|
|
2555
|
-
schedule?: V1Schedule;
|
|
2556
|
-
siteProperties?: SitePropertiesOnScheduleCreation;
|
|
2557
|
-
sessions?: Session[];
|
|
2558
|
-
}
|
|
2559
|
-
export interface SitePropertiesOnScheduleCreation {
|
|
2560
|
-
/** The global time zone value. */
|
|
2561
|
-
timeZone?: string | null;
|
|
2562
|
-
}
|
|
2563
|
-
export interface MigrationEvent {
|
|
2564
|
-
migrationData?: MigrationData;
|
|
2565
|
-
}
|
|
2566
|
-
export interface MigrationData {
|
|
2567
|
-
businessId?: string | null;
|
|
2568
|
-
staffs?: StaffData[];
|
|
2569
|
-
}
|
|
2570
|
-
export interface StaffData {
|
|
2571
|
-
resourceId?: string;
|
|
2572
|
-
syncRequestEmail?: string;
|
|
2573
|
-
refreshToken?: string;
|
|
2574
|
-
}
|
|
2575
|
-
export interface ResourceNotification {
|
|
2576
|
-
/**
|
|
2577
|
-
* Updated resource entity.
|
|
2578
|
-
* 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
|
|
2579
|
-
*/
|
|
2580
|
-
resource?: Resource;
|
|
2581
|
-
/** Event type. */
|
|
2582
|
-
event?: ResourceNotificationEvent;
|
|
2583
|
-
}
|
|
2584
|
-
export interface Resource {
|
|
2585
|
-
/**
|
|
2586
|
-
* Resource ID.
|
|
2587
|
-
* @readonly
|
|
2588
|
-
*/
|
|
2589
|
-
_id?: string | null;
|
|
2590
|
-
/** Resource name. */
|
|
2591
|
-
name?: string | null;
|
|
2592
|
-
/** Resource email address. */
|
|
2593
|
-
email?: string | null;
|
|
2594
|
-
/** Resource phone number. */
|
|
2595
|
-
phone?: string | null;
|
|
2596
|
-
/** Resource description. */
|
|
2597
|
-
description?: string | null;
|
|
2598
|
-
/** Deprecated. Please use tags. */
|
|
2599
|
-
tag?: string | null;
|
|
2600
|
-
/** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
|
|
2601
|
-
tags?: string[] | null;
|
|
2602
|
-
/** Resource images. */
|
|
2603
|
-
images?: string[];
|
|
2604
|
-
/** Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1. */
|
|
2605
|
-
schedules?: V1Schedule[];
|
|
2606
|
-
/**
|
|
2607
|
-
* List of IDs of schedules owned by this resource.
|
|
2608
|
-
* @readonly
|
|
2609
|
-
*/
|
|
2610
|
-
scheduleIds?: string[] | null;
|
|
2611
|
-
/**
|
|
2612
|
-
* Resource status.
|
|
2613
|
-
* <!--ONLY:VELO
|
|
2614
|
-
* One of:
|
|
2615
|
-
* - `"CREATED"` Default status.
|
|
2616
|
-
* - `"DELETED"` The resource was deleted.
|
|
2617
|
-
* - `"UPDATED"` The resource was updated.
|
|
2618
|
-
* <!--END:ONLY:VELO-->
|
|
2619
|
-
* @readonly
|
|
2620
|
-
*/
|
|
2621
|
-
status?: ResourceStatus;
|
|
2622
|
-
/**
|
|
2623
|
-
* Wix user ID, if the resource is associated with the Wix user.
|
|
2624
|
-
* A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
|
|
2625
|
-
* <!--ONLY:VELO
|
|
2626
|
-
* Click the **Set Permissions** button for the staff member on the Staff page on your site's dashboard.
|
|
2627
|
-
* <!--END:ONLY:VELO-->
|
|
2628
|
-
* @readonly
|
|
2629
|
-
*/
|
|
2630
|
-
wixUserId?: string | null;
|
|
2631
|
-
}
|
|
2632
|
-
export declare enum ResourceStatus {
|
|
2633
|
-
UNDEFINED = "UNDEFINED",
|
|
2634
|
-
/** Default status. */
|
|
2635
|
-
CREATED = "CREATED",
|
|
2636
|
-
/** The resource was deleted. */
|
|
2637
|
-
DELETED = "DELETED",
|
|
2638
|
-
/** The resource was updated. */
|
|
2639
|
-
UPDATED = "UPDATED"
|
|
2640
|
-
}
|
|
2641
|
-
export interface BusinessLocation {
|
|
2642
|
-
/** The ID of the business location. Has to be non-empty */
|
|
2643
|
-
locationId?: string;
|
|
2644
|
-
}
|
|
2645
|
-
export declare enum ResourceNotificationEvent {
|
|
2646
|
-
UNDEFINED = "UNDEFINED",
|
|
2647
|
-
Updated = "Updated",
|
|
2648
|
-
Deleted = "Deleted",
|
|
2649
|
-
Created = "Created",
|
|
2650
|
-
Schedule_Updated = "Schedule_Updated"
|
|
2651
|
-
}
|
|
2652
|
-
export interface BenefitNotification {
|
|
2653
|
-
/** Plan unique ID */
|
|
2654
|
-
planId?: string;
|
|
2655
|
-
/** App def ID */
|
|
2656
|
-
appDefId?: string;
|
|
2657
|
-
/** Current benefit details */
|
|
2658
|
-
benefit?: Benefit;
|
|
2659
|
-
/** Previous benefit */
|
|
2660
|
-
prevBenefit?: Benefit;
|
|
2661
|
-
/** Notification event */
|
|
2662
|
-
event?: BenefitNotificationEvent;
|
|
2663
|
-
}
|
|
2664
|
-
export interface Benefit {
|
|
2665
|
-
/**
|
|
2666
|
-
* Benefit unique ID
|
|
2667
|
-
* @readonly
|
|
2668
|
-
*/
|
|
2669
|
-
_id?: string | null;
|
|
2670
|
-
/** Benefit Type */
|
|
2671
|
-
benefitType?: BenefitType;
|
|
2672
|
-
/** Resource IDs that serves by this benefit */
|
|
2673
|
-
resourceIds?: string[];
|
|
2674
|
-
/** Amount of credits that provided by this benefit */
|
|
2675
|
-
creditAmount?: number | null;
|
|
2676
|
-
/** additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value */
|
|
2677
|
-
customFields?: Record<string, string>;
|
|
2678
|
-
/** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
|
|
2679
|
-
editable?: boolean | null;
|
|
2680
|
-
/** Benefit behavior */
|
|
2681
|
-
behavior?: Behavior;
|
|
2682
|
-
/**
|
|
2683
|
-
* Id of the app associated with this benefit
|
|
2684
|
-
* @readonly
|
|
2685
|
-
*/
|
|
2686
|
-
appDefId?: string | null;
|
|
2687
|
-
}
|
|
2688
|
-
export interface EntryPass {
|
|
2689
|
-
}
|
|
2690
|
-
export interface Discount extends DiscountDiscountOneOf {
|
|
2691
|
-
/** Fixed-rate percent off discount */
|
|
2692
|
-
percentOffRate?: string;
|
|
2693
|
-
/** Absolute amount discount */
|
|
2694
|
-
moneyOffAmount?: string;
|
|
2695
|
-
}
|
|
2696
|
-
/** @oneof */
|
|
2697
|
-
export interface DiscountDiscountOneOf {
|
|
2698
|
-
/** Fixed-rate percent off discount */
|
|
2699
|
-
percentOffRate?: string;
|
|
2700
|
-
/** Absolute amount discount */
|
|
2701
|
-
moneyOffAmount?: string;
|
|
2702
|
-
}
|
|
2703
|
-
export declare enum BenefitType {
|
|
2704
|
-
/** Should never be used */
|
|
2705
|
-
UNDEFINED = "UNDEFINED",
|
|
2706
|
-
/** Limited benefit type */
|
|
2707
|
-
LIMITED = "LIMITED",
|
|
2708
|
-
/** Unlimited benefit type */
|
|
2709
|
-
UNLIMITED = "UNLIMITED"
|
|
2710
|
-
}
|
|
2711
|
-
export interface Behavior extends BehaviorBehaviorOneOf {
|
|
2712
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
2713
|
-
defaultBehavior?: EntryPass;
|
|
2714
|
-
/** Discount applied to paid resources */
|
|
2715
|
-
discount?: Discount;
|
|
2716
|
-
}
|
|
2717
|
-
/** @oneof */
|
|
2718
|
-
export interface BehaviorBehaviorOneOf {
|
|
2719
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
2720
|
-
defaultBehavior?: EntryPass;
|
|
2721
|
-
/** Discount applied to paid resources */
|
|
2722
|
-
discount?: Discount;
|
|
2723
|
-
}
|
|
2724
|
-
export declare enum BenefitNotificationEvent {
|
|
2725
|
-
Updated = "Updated",
|
|
2726
|
-
Deleted = "Deleted",
|
|
2727
|
-
Created = "Created"
|
|
2728
|
-
}
|
|
2729
|
-
export interface UserDomainInfoChangedEvent {
|
|
2730
|
-
domainName?: string;
|
|
2731
|
-
crudType?: CrudType;
|
|
2732
|
-
metaSiteId?: string | null;
|
|
2733
|
-
changeTime?: Date;
|
|
2734
|
-
}
|
|
2735
|
-
export declare enum CrudType {
|
|
2736
|
-
INVALID_CRUD_TYPE = "INVALID_CRUD_TYPE",
|
|
2737
|
-
CREATE = "CREATE",
|
|
2738
|
-
UPDATE = "UPDATE",
|
|
2739
|
-
DELETE = "DELETE",
|
|
2740
|
-
/** Unfortunately this action is used by hibernate save in wix-war */
|
|
2741
|
-
CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
|
|
2742
|
-
}
|
|
2743
|
-
export interface HtmlSitePublished {
|
|
2744
|
-
/** Application instance ID */
|
|
2745
|
-
appInstanceId?: string;
|
|
2746
|
-
/** Application type */
|
|
2747
|
-
appType?: string;
|
|
2748
|
-
/** Revision */
|
|
2749
|
-
revision?: string;
|
|
2750
|
-
/** MSID */
|
|
2751
|
-
metaSiteId?: string | null;
|
|
2752
|
-
/** optional branch id if publish is done from branch */
|
|
2753
|
-
branchId?: string | null;
|
|
2754
|
-
/** The site's last transactionId */
|
|
2755
|
-
lastTransactionId?: string | null;
|
|
2756
|
-
/** A list of the site's pages */
|
|
2757
|
-
pages?: Page[];
|
|
2758
|
-
/** Site's publish date */
|
|
2759
|
-
publishDate?: string;
|
|
2760
|
-
}
|
|
2761
|
-
export interface Page {
|
|
2762
|
-
/** Page's Id */
|
|
2763
|
-
_id?: string;
|
|
2764
|
-
}
|
|
2765
|
-
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
2766
|
-
export interface SitePropertiesNotification {
|
|
2767
|
-
/** The site ID for which this update notification applies. */
|
|
2768
|
-
metasiteId?: string;
|
|
2769
|
-
/** The actual update event. */
|
|
2770
|
-
event?: SitePropertiesEvent;
|
|
2771
|
-
/** A convenience set of mappings from the MetaSite ID to its constituent services. */
|
|
2772
|
-
translations?: Translation[];
|
|
2773
|
-
/** Context of the notification */
|
|
2774
|
-
changeContext?: ChangeContext;
|
|
2775
|
-
}
|
|
2776
|
-
/** The actual update event for a particular notification. */
|
|
2777
|
-
export interface SitePropertiesEvent {
|
|
2778
|
-
/** Version of the site's properties represented by this update. */
|
|
2779
|
-
version?: number;
|
|
2780
|
-
/** Updated properties. */
|
|
2781
|
-
properties?: Properties;
|
|
2782
|
-
}
|
|
2783
|
-
export interface Properties {
|
|
2784
|
-
/** Site categories. */
|
|
2785
|
-
categories?: Categories;
|
|
2786
|
-
/** Site locale. */
|
|
2787
|
-
locale?: Locale;
|
|
2788
|
-
/**
|
|
2789
|
-
* Site language.
|
|
2790
|
-
*
|
|
2791
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
2792
|
-
*/
|
|
2793
|
-
language?: string | null;
|
|
2794
|
-
/**
|
|
2795
|
-
* Site currency format used to bill customers.
|
|
2796
|
-
*
|
|
2797
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
2798
|
-
*/
|
|
2799
|
-
paymentCurrency?: string | null;
|
|
2800
|
-
/** Timezone in `America/New_York` format. */
|
|
2801
|
-
timeZone?: string | null;
|
|
2802
|
-
/** Email address. */
|
|
2803
|
-
email?: string | null;
|
|
2804
|
-
/** Phone number. */
|
|
2805
|
-
phone?: string | null;
|
|
2806
|
-
/** Fax number. */
|
|
2807
|
-
fax?: string | null;
|
|
2808
|
-
/** Address. */
|
|
2809
|
-
address?: V4Address;
|
|
2810
|
-
/** Site display name. */
|
|
2811
|
-
siteDisplayName?: string | null;
|
|
2812
|
-
/** Business name. */
|
|
2813
|
-
businessName?: string | null;
|
|
2814
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
2815
|
-
logo?: string | null;
|
|
2816
|
-
/** Site description. */
|
|
2817
|
-
description?: string | null;
|
|
2818
|
-
/**
|
|
2819
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
2820
|
-
*
|
|
2821
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
2822
|
-
*/
|
|
2823
|
-
businessSchedule?: BusinessSchedule;
|
|
2824
|
-
/** Supported languages of a site and the primary language. */
|
|
2825
|
-
multilingual?: Multilingual;
|
|
2826
|
-
/** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
|
|
2827
|
-
consentPolicy?: ConsentPolicy;
|
|
2828
|
-
/**
|
|
2829
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
2830
|
-
*
|
|
2831
|
-
* Site business type.
|
|
2832
|
-
*/
|
|
2833
|
-
businessConfig?: string | null;
|
|
2834
|
-
/** External site url that uses Wix as its headless business solution */
|
|
2835
|
-
externalSiteUrl?: string | null;
|
|
2836
|
-
/** Track clicks analytics */
|
|
2837
|
-
trackClicksAnalytics?: boolean;
|
|
2838
|
-
}
|
|
2839
|
-
export interface Categories {
|
|
2840
|
-
/** Primary site category. */
|
|
2841
|
-
primary?: string;
|
|
2842
|
-
/** Secondary site category. */
|
|
2843
|
-
secondary?: string[];
|
|
2844
|
-
/** Business Term Id */
|
|
2845
|
-
businessTermId?: string | null;
|
|
2846
|
-
}
|
|
2847
|
-
export interface Locale {
|
|
2848
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
2849
|
-
languageCode?: string;
|
|
2850
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
2851
|
-
country?: string;
|
|
2852
|
-
}
|
|
2853
|
-
export interface V4Address {
|
|
2854
|
-
/** Street name. */
|
|
2855
|
-
street?: string;
|
|
2856
|
-
/** City name. */
|
|
2857
|
-
city?: string;
|
|
2858
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
2859
|
-
country?: string;
|
|
2860
|
-
/** State. */
|
|
2861
|
-
state?: string;
|
|
2862
|
-
/** Zip or postal code. */
|
|
2863
|
-
zip?: string;
|
|
2864
|
-
/** Extra information to be displayed in the address. */
|
|
2865
|
-
hint?: AddressHint;
|
|
2866
|
-
/** Whether this address represents a physical location. */
|
|
2867
|
-
isPhysical?: boolean;
|
|
2868
|
-
/** Google-formatted version of this address. */
|
|
2869
|
-
googleFormattedAddress?: string;
|
|
2870
|
-
/** Street number. */
|
|
2871
|
-
streetNumber?: string;
|
|
2872
|
-
/** Apartment number. */
|
|
2873
|
-
apartmentNumber?: string;
|
|
2874
|
-
/** Geographic coordinates of location. */
|
|
2875
|
-
coordinates?: GeoCoordinates;
|
|
2876
|
-
}
|
|
2877
|
-
/**
|
|
2878
|
-
* Extra information on displayed addresses.
|
|
2879
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
2880
|
-
* Free text. In addition the user can state where he wants that additional description - before, after, or instead
|
|
2881
|
-
* the address string.
|
|
2882
|
-
*/
|
|
2883
|
-
export interface AddressHint {
|
|
2884
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
2885
|
-
text?: string;
|
|
2886
|
-
/** Where the extra text should be displayed. */
|
|
2887
|
-
placement?: PlacementType;
|
|
2888
|
-
}
|
|
2889
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
2890
|
-
export declare enum PlacementType {
|
|
2891
|
-
BEFORE = "BEFORE",
|
|
2892
|
-
AFTER = "AFTER",
|
|
2893
|
-
REPLACE = "REPLACE"
|
|
2894
|
-
}
|
|
2895
|
-
/** Geocoordinates for a particular address. */
|
|
2896
|
-
export interface GeoCoordinates {
|
|
2897
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
2898
|
-
latitude?: number;
|
|
2899
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
2900
|
-
longitude?: number;
|
|
2901
|
-
}
|
|
2902
|
-
export interface Multilingual {
|
|
2903
|
-
/** Supported languages list. */
|
|
2904
|
-
supportedLanguages?: SupportedLanguage[];
|
|
2905
|
-
/** Whether to redirect to user language. */
|
|
2906
|
-
autoRedirect?: boolean;
|
|
2907
|
-
}
|
|
2908
|
-
export interface SupportedLanguage {
|
|
2909
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
2910
|
-
languageCode?: string;
|
|
2911
|
-
/** Locale. */
|
|
2912
|
-
locale?: Locale;
|
|
2913
|
-
/** Whether the supported language is the primary language for the site. */
|
|
2914
|
-
isPrimary?: boolean;
|
|
2915
|
-
/** Language icon. */
|
|
2916
|
-
countryCode?: string;
|
|
2917
|
-
/** How the language will be resolved. For internal use. */
|
|
2918
|
-
resolutionMethod?: ResolutionMethod;
|
|
2919
|
-
}
|
|
2920
|
-
export declare enum ResolutionMethod {
|
|
2921
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
2922
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
2923
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
2924
|
-
}
|
|
2925
|
-
export interface ConsentPolicy {
|
|
2926
|
-
/** Whether the site uses cookies that are essential to site operation. */
|
|
2927
|
-
essential?: boolean | null;
|
|
2928
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
2929
|
-
functional?: boolean | null;
|
|
2930
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
2931
|
-
analytics?: boolean | null;
|
|
2932
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
2933
|
-
advertising?: boolean | null;
|
|
2934
|
-
/** CCPA compliance flag. */
|
|
2935
|
-
dataToThirdParty?: boolean | null;
|
|
2936
|
-
}
|
|
2937
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
2938
|
-
export interface Translation {
|
|
2939
|
-
/** The service type. */
|
|
2940
|
-
serviceType?: string;
|
|
2941
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
2942
|
-
appDefId?: string;
|
|
2943
|
-
/** The instance ID of the service. */
|
|
2944
|
-
instanceId?: string;
|
|
2945
|
-
}
|
|
2946
|
-
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
2947
|
-
/** Properties were updated. */
|
|
2948
|
-
propertiesChange?: PropertiesChange;
|
|
2949
|
-
/** Default properties were created on site creation. */
|
|
2950
|
-
siteCreated?: SiteCreated;
|
|
2951
|
-
/** Properties were cloned on site cloning. */
|
|
2952
|
-
siteCloned?: SiteCloned;
|
|
2953
|
-
}
|
|
2954
|
-
/** @oneof */
|
|
2955
|
-
export interface ChangeContextPayloadOneOf {
|
|
2956
|
-
/** Properties were updated. */
|
|
2957
|
-
propertiesChange?: PropertiesChange;
|
|
2958
|
-
/** Default properties were created on site creation. */
|
|
2959
|
-
siteCreated?: SiteCreated;
|
|
2960
|
-
/** Properties were cloned on site cloning. */
|
|
2961
|
-
siteCloned?: SiteCloned;
|
|
2962
|
-
}
|
|
2963
|
-
export interface PropertiesChange {
|
|
2964
|
-
}
|
|
2965
|
-
export interface SiteCreated {
|
|
2966
|
-
/** Origin template site id. */
|
|
2967
|
-
originTemplateId?: string | null;
|
|
2968
|
-
}
|
|
2969
|
-
export interface SiteCloned {
|
|
2970
|
-
/** Origin site id. */
|
|
2971
|
-
originMetaSiteId?: string;
|
|
2972
|
-
}
|
|
2973
|
-
export interface SetServiceLocationsRequest {
|
|
2974
|
-
/** ID of the service. */
|
|
2975
|
-
serviceId?: string;
|
|
2976
|
-
/** The locations you specify replace the existing service locations. */
|
|
2977
|
-
locations?: Location[];
|
|
2978
|
-
/** The action to perform on sessions currently set to a removed location. For example, move existing sessions to a new specified location. */
|
|
2979
|
-
removedLocationSessionsAction?: RemovedLocationSessionsAction;
|
|
2980
|
-
/** Whether to notify participants about the change of location, and an optional custom message. */
|
|
2981
|
-
participantNotification?: ParticipantNotification;
|
|
2982
|
-
}
|
|
2983
|
-
export interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2984
|
-
/** Options related to the action, such as a new location to move existing sessions to. */
|
|
2985
|
-
moveToLocationOptions?: MoveToNewLocationsOptions;
|
|
2986
|
-
/** The action to perform on sessions currently set to a removed location. For example, move existing sessions to a new specified location. */
|
|
2987
|
-
action?: Action;
|
|
2988
|
-
}
|
|
2989
|
-
/** @oneof */
|
|
2990
|
-
export interface RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2991
|
-
/** Options related to the action, such as a new location to move existing sessions to. */
|
|
2992
|
-
moveToLocationOptions?: MoveToNewLocationsOptions;
|
|
2993
|
-
}
|
|
2994
|
-
export declare enum Action {
|
|
2995
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2996
|
-
/**
|
|
2997
|
-
* Keep future sessions at their current location. This is the default.
|
|
2998
|
-
* Note: The location will be set directly on the session. i.e, if the location is currently inherited from the schedule, the inheritance will be overridden.
|
|
2999
|
-
*/
|
|
3000
|
-
KEEP_AT_CURRENT_LOCATION = "KEEP_AT_CURRENT_LOCATION",
|
|
3001
|
-
/**
|
|
3002
|
-
* Move future sessions to a new location.
|
|
3003
|
-
* The new location must be specified in the availability locations to set ('SetAvailabilityLocationsRequest.locations').
|
|
3004
|
-
*/
|
|
3005
|
-
MOVE_TO_LOCATION = "MOVE_TO_LOCATION",
|
|
3006
|
-
/**
|
|
3007
|
-
* Delete future sessions.
|
|
3008
|
-
* Currently not supported.
|
|
3009
|
-
*/
|
|
3010
|
-
DELETE = "DELETE"
|
|
3011
|
-
}
|
|
3012
|
-
export interface MoveToNewLocationsOptions {
|
|
3013
|
-
/** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
|
|
3014
|
-
newLocation?: Location;
|
|
3015
|
-
}
|
|
3016
|
-
export interface SetServiceLocationsResponse {
|
|
3017
|
-
/** The updated service with the newly set locations. */
|
|
3018
|
-
service?: Service;
|
|
3019
|
-
}
|
|
3020
|
-
export interface EnablePricingPlansForServiceRequest {
|
|
3021
|
-
/** ID of the service to add the pricing plans to. */
|
|
3022
|
-
serviceId?: string;
|
|
3023
|
-
/** IDs of the pricing plans to connect to the service. */
|
|
3024
|
-
pricingPlanIds?: string[];
|
|
3025
|
-
}
|
|
3026
|
-
export interface EnablePricingPlansForServiceResponse {
|
|
3027
|
-
/** IDs of the pricing plans connected to the service. */
|
|
3028
|
-
pricingPlanIds?: string[];
|
|
3029
|
-
/** The service after the pricing plans update. */
|
|
3030
|
-
service?: Service;
|
|
3031
|
-
}
|
|
3032
|
-
export interface InvalidPricingPlan {
|
|
3033
|
-
/** The invalid pricing plan id. */
|
|
3034
|
-
_id?: string;
|
|
3035
|
-
/** The reason for the pricing plan considered as invalid */
|
|
3036
|
-
message?: string;
|
|
3037
|
-
}
|
|
3038
|
-
export interface DisablePricingPlansForServiceRequest {
|
|
3039
|
-
/** ID of the service to disconnect the pricing plans from. */
|
|
3040
|
-
serviceId?: string;
|
|
3041
|
-
/** ID of the pricing plans to disconnect from the service. */
|
|
3042
|
-
pricingPlanIds?: string[];
|
|
3043
|
-
}
|
|
3044
|
-
export interface DisablePricingPlansForServiceResponse {
|
|
3045
|
-
/** The service after the pricing plans update. */
|
|
3046
|
-
service?: Service;
|
|
3047
|
-
}
|
|
3048
|
-
export interface SetCustomSlugRequest {
|
|
3049
|
-
/** ID of the service to assign the custom slug to. */
|
|
3050
|
-
serviceId?: string;
|
|
3051
|
-
/** The custom name to set as the active slug for the service. */
|
|
3052
|
-
slugName?: string;
|
|
3053
|
-
}
|
|
3054
|
-
export interface SetCustomSlugResponse {
|
|
3055
|
-
/** The new slug set as the active slug for the service. */
|
|
3056
|
-
slug?: Slug;
|
|
3057
|
-
}
|
|
3058
|
-
export interface ValidateSlugRequest {
|
|
3059
|
-
/** ID of the service to validate the slug name for. */
|
|
3060
|
-
serviceId?: string;
|
|
3061
|
-
/** The custom name to validate as a slug for the service. */
|
|
3062
|
-
slugName?: string;
|
|
3063
|
-
}
|
|
3064
|
-
export interface ValidateSlugResponse {
|
|
3065
|
-
/** Whether the requested slug name is valid. */
|
|
3066
|
-
valid?: boolean;
|
|
3067
|
-
/** The requested custom slug name to validate. If valid, the slug name can be set as a slug for the service and is populated with the requested slug. Otherwise, `slugName` is empty. */
|
|
3068
|
-
slugName?: string | null;
|
|
3069
|
-
/** If the slug is invalid, this field is populated with the reasons why the slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`, `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`. */
|
|
3070
|
-
errors?: InvalidSlugError[];
|
|
3071
|
-
}
|
|
3072
|
-
export declare enum InvalidSlugError {
|
|
3073
|
-
UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
|
|
3074
|
-
/** The provided slug name contains illegal characters. */
|
|
3075
|
-
SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
|
|
3076
|
-
/** The provided slug name already exists for another service. */
|
|
3077
|
-
SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
|
|
3078
|
-
}
|
|
3079
|
-
export interface CloneServiceRequest {
|
|
3080
|
-
/** ID of a source service */
|
|
3081
|
-
sourceServiceId?: string;
|
|
3082
|
-
/** copy recurring sessions of an active service's schedule */
|
|
3083
|
-
copyRecurringSessions?: boolean;
|
|
3084
|
-
/** copy benefits with pricing plans that are connected to the source service. If the source service is connected to more than 120 benefits with pricing plans then they will not be copied. In that case the field `error_types` in the response will include `PRICING_PLANS`. */
|
|
3085
|
-
copyPricingPlans?: boolean;
|
|
3086
|
-
/** whether to hide service from the list or not. Empty means that we will copy this value from the source service without overriding it */
|
|
3087
|
-
hideService?: boolean | null;
|
|
3088
|
-
/** the name of the clone service. The title of the clone service's schedule will also be set to this name. When this parameter is omitted then the clone service will have the same name as the source service and the clone service's schedule will get the same title as the source service's active schedule. */
|
|
3089
|
-
cloneServiceName?: string | null;
|
|
3090
|
-
}
|
|
3091
|
-
export interface CloneServiceResponse {
|
|
3092
|
-
/** Cloned service */
|
|
3093
|
-
service?: Service;
|
|
3094
|
-
/** List of entity types that we failed to clone */
|
|
3095
|
-
errors?: CloneErrors[];
|
|
3096
|
-
}
|
|
3097
|
-
export declare enum CloneErrors {
|
|
3098
|
-
UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
|
|
3099
|
-
/** Failed to clone sessions of active service's schedule */
|
|
3100
|
-
SESSIONS = "SESSIONS",
|
|
3101
|
-
/** Failed to clone service's options and variants even though source service have them */
|
|
3102
|
-
OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
|
|
3103
|
-
/** Failed to clone service's form */
|
|
3104
|
-
FORM = "FORM",
|
|
3105
|
-
/** Failed to clone pricing plans connected to the source service */
|
|
3106
|
-
PRICING_PLANS = "PRICING_PLANS"
|
|
3107
|
-
}
|
|
3108
|
-
export interface MultiServiceEnabledNotification {
|
|
3109
|
-
}
|
|
3110
|
-
export interface CreateServiceResponseNonNullableFields {
|
|
3111
|
-
service?: {
|
|
3112
|
-
type: ServiceType;
|
|
3113
|
-
media?: {
|
|
3114
|
-
items: {
|
|
3115
|
-
image: string;
|
|
3116
|
-
}[];
|
|
3117
|
-
mainMedia?: {
|
|
3118
|
-
image: string;
|
|
3119
|
-
};
|
|
3120
|
-
coverMedia?: {
|
|
3121
|
-
image: string;
|
|
3122
|
-
};
|
|
3123
|
-
};
|
|
3124
|
-
category?: {
|
|
3125
|
-
_id: string;
|
|
3126
|
-
};
|
|
3127
|
-
form?: {
|
|
3128
|
-
_id: string;
|
|
3129
|
-
};
|
|
3130
|
-
payment?: {
|
|
3131
|
-
fixed?: {
|
|
3132
|
-
price?: {
|
|
3133
|
-
value: string;
|
|
3134
|
-
currency: string;
|
|
3135
|
-
};
|
|
3136
|
-
deposit?: {
|
|
3137
|
-
value: string;
|
|
3138
|
-
currency: string;
|
|
3139
|
-
};
|
|
3140
|
-
};
|
|
3141
|
-
varied?: {
|
|
3142
|
-
defaultPrice?: {
|
|
3143
|
-
value: string;
|
|
3144
|
-
currency: string;
|
|
3145
|
-
};
|
|
3146
|
-
deposit?: {
|
|
3147
|
-
value: string;
|
|
3148
|
-
currency: string;
|
|
3149
|
-
};
|
|
3150
|
-
minPrice?: {
|
|
3151
|
-
value: string;
|
|
3152
|
-
currency: string;
|
|
3153
|
-
};
|
|
3154
|
-
maxPrice?: {
|
|
3155
|
-
value: string;
|
|
3156
|
-
currency: string;
|
|
3157
|
-
};
|
|
3158
|
-
};
|
|
3159
|
-
rateType: RateType;
|
|
3160
|
-
pricingPlanIds: string[];
|
|
3161
|
-
};
|
|
3162
|
-
locations: {
|
|
3163
|
-
business?: {
|
|
3164
|
-
_id: string;
|
|
3165
|
-
name: string;
|
|
3166
|
-
};
|
|
3167
|
-
type: LocationType;
|
|
3168
|
-
}[];
|
|
3169
|
-
bookingPolicy?: {
|
|
3170
|
-
_id: string;
|
|
3171
|
-
customPolicyDescription?: {
|
|
3172
|
-
enabled: boolean;
|
|
3173
|
-
description: string;
|
|
3174
|
-
};
|
|
3175
|
-
limitEarlyBookingPolicy?: {
|
|
3176
|
-
enabled: boolean;
|
|
3177
|
-
earliestBookingInMinutes: number;
|
|
3178
|
-
};
|
|
3179
|
-
limitLateBookingPolicy?: {
|
|
3180
|
-
enabled: boolean;
|
|
3181
|
-
latestBookingInMinutes: number;
|
|
3182
|
-
};
|
|
3183
|
-
bookAfterStartPolicy?: {
|
|
3184
|
-
enabled: boolean;
|
|
3185
|
-
};
|
|
3186
|
-
cancellationPolicy?: {
|
|
3187
|
-
enabled: boolean;
|
|
3188
|
-
limitLatestCancellation: boolean;
|
|
3189
|
-
latestCancellationInMinutes: number;
|
|
3190
|
-
};
|
|
3191
|
-
reschedulePolicy?: {
|
|
3192
|
-
enabled: boolean;
|
|
3193
|
-
limitLatestReschedule: boolean;
|
|
3194
|
-
latestRescheduleInMinutes: number;
|
|
3195
|
-
};
|
|
3196
|
-
waitlistPolicy?: {
|
|
3197
|
-
enabled: boolean;
|
|
3198
|
-
capacity: number;
|
|
3199
|
-
reservationTimeInMinutes: number;
|
|
3200
|
-
};
|
|
3201
|
-
participantsPolicy?: {
|
|
3202
|
-
maxParticipantsPerBooking: number;
|
|
3203
|
-
};
|
|
3204
|
-
resourcesPolicy?: {
|
|
3205
|
-
enabled: boolean;
|
|
3206
|
-
autoAssignAllowed: boolean;
|
|
3207
|
-
};
|
|
3208
|
-
};
|
|
3209
|
-
schedule?: {
|
|
3210
|
-
availabilityConstraints?: {
|
|
3211
|
-
sessionDurations: number[];
|
|
3212
|
-
timeBetweenSessions: number;
|
|
3213
|
-
};
|
|
3214
|
-
};
|
|
3215
|
-
staffMemberIds: string[];
|
|
3216
|
-
supportedSlugs: {
|
|
3217
|
-
name: string;
|
|
3218
|
-
}[];
|
|
3219
|
-
mainSlug?: {
|
|
3220
|
-
name: string;
|
|
3221
|
-
};
|
|
3222
|
-
urls?: {
|
|
3223
|
-
servicePage: string;
|
|
3224
|
-
bookingPage: string;
|
|
3225
|
-
calendarPage: string;
|
|
3226
|
-
};
|
|
3227
|
-
seoData?: {
|
|
3228
|
-
tags: {
|
|
3229
|
-
type: string;
|
|
3230
|
-
children: string;
|
|
3231
|
-
custom: boolean;
|
|
3232
|
-
disabled: boolean;
|
|
3233
|
-
}[];
|
|
3234
|
-
settings?: {
|
|
3235
|
-
preventAutoRedirect: boolean;
|
|
3236
|
-
keywords: {
|
|
3237
|
-
term: string;
|
|
3238
|
-
isMain: boolean;
|
|
3239
|
-
}[];
|
|
3240
|
-
};
|
|
3241
|
-
};
|
|
3242
|
-
};
|
|
3243
|
-
}
|
|
3244
|
-
export interface GetServiceResponseNonNullableFields {
|
|
3245
|
-
service?: {
|
|
3246
|
-
type: ServiceType;
|
|
3247
|
-
media?: {
|
|
3248
|
-
items: {
|
|
3249
|
-
image: string;
|
|
3250
|
-
}[];
|
|
3251
|
-
mainMedia?: {
|
|
3252
|
-
image: string;
|
|
3253
|
-
};
|
|
3254
|
-
coverMedia?: {
|
|
3255
|
-
image: string;
|
|
3256
|
-
};
|
|
3257
|
-
};
|
|
3258
|
-
category?: {
|
|
3259
|
-
_id: string;
|
|
3260
|
-
};
|
|
3261
|
-
form?: {
|
|
3262
|
-
_id: string;
|
|
3263
|
-
};
|
|
3264
|
-
payment?: {
|
|
3265
|
-
fixed?: {
|
|
3266
|
-
price?: {
|
|
3267
|
-
value: string;
|
|
3268
|
-
currency: string;
|
|
3269
|
-
};
|
|
3270
|
-
deposit?: {
|
|
3271
|
-
value: string;
|
|
3272
|
-
currency: string;
|
|
3273
|
-
};
|
|
3274
|
-
};
|
|
3275
|
-
varied?: {
|
|
3276
|
-
defaultPrice?: {
|
|
3277
|
-
value: string;
|
|
3278
|
-
currency: string;
|
|
3279
|
-
};
|
|
3280
|
-
deposit?: {
|
|
3281
|
-
value: string;
|
|
3282
|
-
currency: string;
|
|
3283
|
-
};
|
|
3284
|
-
minPrice?: {
|
|
3285
|
-
value: string;
|
|
3286
|
-
currency: string;
|
|
3287
|
-
};
|
|
3288
|
-
maxPrice?: {
|
|
3289
|
-
value: string;
|
|
3290
|
-
currency: string;
|
|
3291
|
-
};
|
|
3292
|
-
};
|
|
3293
|
-
rateType: RateType;
|
|
3294
|
-
pricingPlanIds: string[];
|
|
3295
|
-
};
|
|
3296
|
-
locations: {
|
|
3297
|
-
business?: {
|
|
3298
|
-
_id: string;
|
|
3299
|
-
name: string;
|
|
3300
|
-
};
|
|
3301
|
-
type: LocationType;
|
|
3302
|
-
}[];
|
|
3303
|
-
bookingPolicy?: {
|
|
3304
|
-
_id: string;
|
|
3305
|
-
customPolicyDescription?: {
|
|
3306
|
-
enabled: boolean;
|
|
3307
|
-
description: string;
|
|
3308
|
-
};
|
|
3309
|
-
limitEarlyBookingPolicy?: {
|
|
3310
|
-
enabled: boolean;
|
|
3311
|
-
earliestBookingInMinutes: number;
|
|
3312
|
-
};
|
|
3313
|
-
limitLateBookingPolicy?: {
|
|
3314
|
-
enabled: boolean;
|
|
3315
|
-
latestBookingInMinutes: number;
|
|
3316
|
-
};
|
|
3317
|
-
bookAfterStartPolicy?: {
|
|
3318
|
-
enabled: boolean;
|
|
3319
|
-
};
|
|
3320
|
-
cancellationPolicy?: {
|
|
3321
|
-
enabled: boolean;
|
|
3322
|
-
limitLatestCancellation: boolean;
|
|
3323
|
-
latestCancellationInMinutes: number;
|
|
3324
|
-
};
|
|
3325
|
-
reschedulePolicy?: {
|
|
3326
|
-
enabled: boolean;
|
|
3327
|
-
limitLatestReschedule: boolean;
|
|
3328
|
-
latestRescheduleInMinutes: number;
|
|
3329
|
-
};
|
|
3330
|
-
waitlistPolicy?: {
|
|
3331
|
-
enabled: boolean;
|
|
3332
|
-
capacity: number;
|
|
3333
|
-
reservationTimeInMinutes: number;
|
|
3334
|
-
};
|
|
3335
|
-
participantsPolicy?: {
|
|
3336
|
-
maxParticipantsPerBooking: number;
|
|
3337
|
-
};
|
|
3338
|
-
resourcesPolicy?: {
|
|
3339
|
-
enabled: boolean;
|
|
3340
|
-
autoAssignAllowed: boolean;
|
|
3341
|
-
};
|
|
3342
|
-
};
|
|
3343
|
-
schedule?: {
|
|
3344
|
-
availabilityConstraints?: {
|
|
3345
|
-
sessionDurations: number[];
|
|
3346
|
-
timeBetweenSessions: number;
|
|
3347
|
-
};
|
|
3348
|
-
};
|
|
3349
|
-
staffMemberIds: string[];
|
|
3350
|
-
supportedSlugs: {
|
|
3351
|
-
name: string;
|
|
3352
|
-
}[];
|
|
3353
|
-
mainSlug?: {
|
|
3354
|
-
name: string;
|
|
3355
|
-
};
|
|
3356
|
-
urls?: {
|
|
3357
|
-
servicePage: string;
|
|
3358
|
-
bookingPage: string;
|
|
3359
|
-
calendarPage: string;
|
|
3360
|
-
};
|
|
3361
|
-
seoData?: {
|
|
3362
|
-
tags: {
|
|
3363
|
-
type: string;
|
|
3364
|
-
children: string;
|
|
3365
|
-
custom: boolean;
|
|
3366
|
-
disabled: boolean;
|
|
3367
|
-
}[];
|
|
3368
|
-
settings?: {
|
|
3369
|
-
preventAutoRedirect: boolean;
|
|
3370
|
-
keywords: {
|
|
3371
|
-
term: string;
|
|
3372
|
-
isMain: boolean;
|
|
3373
|
-
}[];
|
|
3374
|
-
};
|
|
3375
|
-
};
|
|
3376
|
-
};
|
|
3377
|
-
}
|
|
3378
|
-
export interface UpdateServiceResponseNonNullableFields {
|
|
3379
|
-
service?: {
|
|
3380
|
-
type: ServiceType;
|
|
3381
|
-
media?: {
|
|
3382
|
-
items: {
|
|
3383
|
-
image: string;
|
|
3384
|
-
}[];
|
|
3385
|
-
mainMedia?: {
|
|
3386
|
-
image: string;
|
|
3387
|
-
};
|
|
3388
|
-
coverMedia?: {
|
|
3389
|
-
image: string;
|
|
3390
|
-
};
|
|
3391
|
-
};
|
|
3392
|
-
category?: {
|
|
3393
|
-
_id: string;
|
|
3394
|
-
};
|
|
3395
|
-
form?: {
|
|
3396
|
-
_id: string;
|
|
3397
|
-
};
|
|
3398
|
-
payment?: {
|
|
3399
|
-
fixed?: {
|
|
3400
|
-
price?: {
|
|
3401
|
-
value: string;
|
|
3402
|
-
currency: string;
|
|
3403
|
-
};
|
|
3404
|
-
deposit?: {
|
|
3405
|
-
value: string;
|
|
3406
|
-
currency: string;
|
|
3407
|
-
};
|
|
3408
|
-
};
|
|
3409
|
-
varied?: {
|
|
3410
|
-
defaultPrice?: {
|
|
3411
|
-
value: string;
|
|
3412
|
-
currency: string;
|
|
3413
|
-
};
|
|
3414
|
-
deposit?: {
|
|
3415
|
-
value: string;
|
|
3416
|
-
currency: string;
|
|
3417
|
-
};
|
|
3418
|
-
minPrice?: {
|
|
3419
|
-
value: string;
|
|
3420
|
-
currency: string;
|
|
3421
|
-
};
|
|
3422
|
-
maxPrice?: {
|
|
3423
|
-
value: string;
|
|
3424
|
-
currency: string;
|
|
3425
|
-
};
|
|
3426
|
-
};
|
|
3427
|
-
rateType: RateType;
|
|
3428
|
-
pricingPlanIds: string[];
|
|
3429
|
-
};
|
|
3430
|
-
locations: {
|
|
3431
|
-
business?: {
|
|
3432
|
-
_id: string;
|
|
3433
|
-
name: string;
|
|
3434
|
-
};
|
|
3435
|
-
type: LocationType;
|
|
3436
|
-
}[];
|
|
3437
|
-
bookingPolicy?: {
|
|
3438
|
-
_id: string;
|
|
3439
|
-
customPolicyDescription?: {
|
|
3440
|
-
enabled: boolean;
|
|
3441
|
-
description: string;
|
|
3442
|
-
};
|
|
3443
|
-
limitEarlyBookingPolicy?: {
|
|
3444
|
-
enabled: boolean;
|
|
3445
|
-
earliestBookingInMinutes: number;
|
|
3446
|
-
};
|
|
3447
|
-
limitLateBookingPolicy?: {
|
|
3448
|
-
enabled: boolean;
|
|
3449
|
-
latestBookingInMinutes: number;
|
|
3450
|
-
};
|
|
3451
|
-
bookAfterStartPolicy?: {
|
|
3452
|
-
enabled: boolean;
|
|
3453
|
-
};
|
|
3454
|
-
cancellationPolicy?: {
|
|
3455
|
-
enabled: boolean;
|
|
3456
|
-
limitLatestCancellation: boolean;
|
|
3457
|
-
latestCancellationInMinutes: number;
|
|
3458
|
-
};
|
|
3459
|
-
reschedulePolicy?: {
|
|
3460
|
-
enabled: boolean;
|
|
3461
|
-
limitLatestReschedule: boolean;
|
|
3462
|
-
latestRescheduleInMinutes: number;
|
|
3463
|
-
};
|
|
3464
|
-
waitlistPolicy?: {
|
|
3465
|
-
enabled: boolean;
|
|
3466
|
-
capacity: number;
|
|
3467
|
-
reservationTimeInMinutes: number;
|
|
3468
|
-
};
|
|
3469
|
-
participantsPolicy?: {
|
|
3470
|
-
maxParticipantsPerBooking: number;
|
|
3471
|
-
};
|
|
3472
|
-
resourcesPolicy?: {
|
|
3473
|
-
enabled: boolean;
|
|
3474
|
-
autoAssignAllowed: boolean;
|
|
3475
|
-
};
|
|
3476
|
-
};
|
|
3477
|
-
schedule?: {
|
|
3478
|
-
availabilityConstraints?: {
|
|
3479
|
-
sessionDurations: number[];
|
|
3480
|
-
timeBetweenSessions: number;
|
|
3481
|
-
};
|
|
3482
|
-
};
|
|
3483
|
-
staffMemberIds: string[];
|
|
3484
|
-
supportedSlugs: {
|
|
3485
|
-
name: string;
|
|
3486
|
-
}[];
|
|
3487
|
-
mainSlug?: {
|
|
3488
|
-
name: string;
|
|
3489
|
-
};
|
|
3490
|
-
urls?: {
|
|
3491
|
-
servicePage: string;
|
|
3492
|
-
bookingPage: string;
|
|
3493
|
-
calendarPage: string;
|
|
3494
|
-
};
|
|
3495
|
-
seoData?: {
|
|
3496
|
-
tags: {
|
|
3497
|
-
type: string;
|
|
3498
|
-
children: string;
|
|
3499
|
-
custom: boolean;
|
|
3500
|
-
disabled: boolean;
|
|
3501
|
-
}[];
|
|
3502
|
-
settings?: {
|
|
3503
|
-
preventAutoRedirect: boolean;
|
|
3504
|
-
keywords: {
|
|
3505
|
-
term: string;
|
|
3506
|
-
isMain: boolean;
|
|
3507
|
-
}[];
|
|
3508
|
-
};
|
|
3509
|
-
};
|
|
3510
|
-
};
|
|
3511
|
-
}
|
|
3512
|
-
export interface QueryServicesResponseNonNullableFields {
|
|
3513
|
-
services: {
|
|
3514
|
-
type: ServiceType;
|
|
3515
|
-
media?: {
|
|
3516
|
-
items: {
|
|
3517
|
-
image: string;
|
|
3518
|
-
}[];
|
|
3519
|
-
mainMedia?: {
|
|
3520
|
-
image: string;
|
|
3521
|
-
};
|
|
3522
|
-
coverMedia?: {
|
|
3523
|
-
image: string;
|
|
3524
|
-
};
|
|
3525
|
-
};
|
|
3526
|
-
category?: {
|
|
3527
|
-
_id: string;
|
|
3528
|
-
};
|
|
3529
|
-
form?: {
|
|
3530
|
-
_id: string;
|
|
3531
|
-
};
|
|
3532
|
-
payment?: {
|
|
3533
|
-
fixed?: {
|
|
3534
|
-
price?: {
|
|
3535
|
-
value: string;
|
|
3536
|
-
currency: string;
|
|
3537
|
-
};
|
|
3538
|
-
deposit?: {
|
|
3539
|
-
value: string;
|
|
3540
|
-
currency: string;
|
|
3541
|
-
};
|
|
3542
|
-
};
|
|
3543
|
-
varied?: {
|
|
3544
|
-
defaultPrice?: {
|
|
3545
|
-
value: string;
|
|
3546
|
-
currency: string;
|
|
3547
|
-
};
|
|
3548
|
-
deposit?: {
|
|
3549
|
-
value: string;
|
|
3550
|
-
currency: string;
|
|
3551
|
-
};
|
|
3552
|
-
minPrice?: {
|
|
3553
|
-
value: string;
|
|
3554
|
-
currency: string;
|
|
3555
|
-
};
|
|
3556
|
-
maxPrice?: {
|
|
3557
|
-
value: string;
|
|
3558
|
-
currency: string;
|
|
3559
|
-
};
|
|
3560
|
-
};
|
|
3561
|
-
rateType: RateType;
|
|
3562
|
-
pricingPlanIds: string[];
|
|
3563
|
-
};
|
|
3564
|
-
locations: {
|
|
3565
|
-
business?: {
|
|
3566
|
-
_id: string;
|
|
3567
|
-
name: string;
|
|
3568
|
-
};
|
|
3569
|
-
type: LocationType;
|
|
3570
|
-
}[];
|
|
3571
|
-
bookingPolicy?: {
|
|
3572
|
-
_id: string;
|
|
3573
|
-
customPolicyDescription?: {
|
|
3574
|
-
enabled: boolean;
|
|
3575
|
-
description: string;
|
|
3576
|
-
};
|
|
3577
|
-
limitEarlyBookingPolicy?: {
|
|
3578
|
-
enabled: boolean;
|
|
3579
|
-
earliestBookingInMinutes: number;
|
|
3580
|
-
};
|
|
3581
|
-
limitLateBookingPolicy?: {
|
|
3582
|
-
enabled: boolean;
|
|
3583
|
-
latestBookingInMinutes: number;
|
|
3584
|
-
};
|
|
3585
|
-
bookAfterStartPolicy?: {
|
|
3586
|
-
enabled: boolean;
|
|
3587
|
-
};
|
|
3588
|
-
cancellationPolicy?: {
|
|
3589
|
-
enabled: boolean;
|
|
3590
|
-
limitLatestCancellation: boolean;
|
|
3591
|
-
latestCancellationInMinutes: number;
|
|
3592
|
-
};
|
|
3593
|
-
reschedulePolicy?: {
|
|
3594
|
-
enabled: boolean;
|
|
3595
|
-
limitLatestReschedule: boolean;
|
|
3596
|
-
latestRescheduleInMinutes: number;
|
|
3597
|
-
};
|
|
3598
|
-
waitlistPolicy?: {
|
|
3599
|
-
enabled: boolean;
|
|
3600
|
-
capacity: number;
|
|
3601
|
-
reservationTimeInMinutes: number;
|
|
3602
|
-
};
|
|
3603
|
-
participantsPolicy?: {
|
|
3604
|
-
maxParticipantsPerBooking: number;
|
|
3605
|
-
};
|
|
3606
|
-
resourcesPolicy?: {
|
|
3607
|
-
enabled: boolean;
|
|
3608
|
-
autoAssignAllowed: boolean;
|
|
3609
|
-
};
|
|
3610
|
-
};
|
|
3611
|
-
schedule?: {
|
|
3612
|
-
availabilityConstraints?: {
|
|
3613
|
-
sessionDurations: number[];
|
|
3614
|
-
timeBetweenSessions: number;
|
|
3615
|
-
};
|
|
3616
|
-
};
|
|
3617
|
-
staffMemberIds: string[];
|
|
3618
|
-
supportedSlugs: {
|
|
3619
|
-
name: string;
|
|
3620
|
-
}[];
|
|
3621
|
-
mainSlug?: {
|
|
3622
|
-
name: string;
|
|
3623
|
-
};
|
|
3624
|
-
urls?: {
|
|
3625
|
-
servicePage: string;
|
|
3626
|
-
bookingPage: string;
|
|
3627
|
-
calendarPage: string;
|
|
3628
|
-
};
|
|
3629
|
-
seoData?: {
|
|
3630
|
-
tags: {
|
|
3631
|
-
type: string;
|
|
3632
|
-
children: string;
|
|
3633
|
-
custom: boolean;
|
|
3634
|
-
disabled: boolean;
|
|
3635
|
-
}[];
|
|
3636
|
-
settings?: {
|
|
3637
|
-
preventAutoRedirect: boolean;
|
|
3638
|
-
keywords: {
|
|
3639
|
-
term: string;
|
|
3640
|
-
isMain: boolean;
|
|
3641
|
-
}[];
|
|
3642
|
-
};
|
|
3643
|
-
};
|
|
3644
|
-
}[];
|
|
3645
|
-
}
|
|
3646
|
-
export declare const onServiceCreated: EventDefinition<DomainCreatedEvent<Service>, "wix.bookings.services.v2.service_created">;
|
|
3647
|
-
export declare const onServiceUpdated: EventDefinition<DomainUpdatedEvent<Service>, "wix.bookings.services.v2.service_updated">;
|
|
3648
|
-
export declare const onServiceDeleted: EventDefinition<DomainDeletedEvent<Service>, "wix.bookings.services.v2.service_deleted">;
|
|
3649
|
-
/**
|
|
3650
|
-
* Creates a new service.
|
|
3651
|
-
* @param service - Service to be created.
|
|
3652
|
-
* @public
|
|
3653
|
-
* @documentationMaturity preview
|
|
3654
|
-
* @requiredField service
|
|
3655
|
-
* @permissionScope Manage Bookings
|
|
3656
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3657
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3658
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3659
|
-
* @applicableIdentity APP
|
|
3660
|
-
* @returns The created service.
|
|
3661
|
-
*/
|
|
3662
|
-
export declare function createService(service: Service): Promise<Service & NonNullable<CreateServiceResponseNonNullableFields>['service']>;
|
|
3663
|
-
/**
|
|
3664
|
-
* Retrieves a service.
|
|
3665
|
-
* @param serviceId - ID of the service to retrieve.
|
|
3666
|
-
* @public
|
|
3667
|
-
* @documentationMaturity preview
|
|
3668
|
-
* @requiredField serviceId
|
|
3669
|
-
* @permissionScope Read Bookings - Public Data
|
|
3670
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
3671
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
3672
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3673
|
-
* @permissionScope Manage Bookings
|
|
3674
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3675
|
-
* @permissionScope Read Bookings - Including Participants
|
|
3676
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
3677
|
-
* @permissionScope Read Bookings - all read permissions
|
|
3678
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
3679
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3680
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3681
|
-
* @applicableIdentity APP
|
|
3682
|
-
* @applicableIdentity MEMBER
|
|
3683
|
-
* @applicableIdentity VISITOR
|
|
3684
|
-
* @returns The retrieved service.
|
|
3685
|
-
*/
|
|
3686
|
-
export declare function getService(serviceId: string): Promise<Service & NonNullable<GetServiceResponseNonNullableFields>['service']>;
|
|
3687
|
-
/**
|
|
3688
|
-
* Updates a service.
|
|
3689
|
-
*
|
|
3690
|
-
* [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported.
|
|
3691
|
-
*
|
|
3692
|
-
* Each time the service is updated, `revision` increments by 1. You must include the
|
|
3693
|
-
* number of the existing revision when
|
|
3694
|
-
* updating the service. This ensures you're working with the
|
|
3695
|
-
* latest service information and prevents unintended overwrites.
|
|
3696
|
-
* @param _id - Service ID.
|
|
3697
|
-
* @public
|
|
3698
|
-
* @documentationMaturity preview
|
|
3699
|
-
* @requiredField _id
|
|
3700
|
-
* @requiredField service
|
|
3701
|
-
* @requiredField service.revision
|
|
3702
|
-
* @permissionScope Manage Bookings
|
|
3703
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3704
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3705
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3706
|
-
* @applicableIdentity APP
|
|
3707
|
-
* @returns The updated service.
|
|
3708
|
-
*/
|
|
3709
|
-
export declare function updateService(_id: string | null, service: UpdateService): Promise<Service & NonNullable<UpdateServiceResponseNonNullableFields>['service']>;
|
|
3710
|
-
export interface UpdateService {
|
|
3711
|
-
/**
|
|
3712
|
-
* Service ID.
|
|
3713
|
-
* @readonly
|
|
3714
|
-
*/
|
|
3715
|
-
_id?: string | null;
|
|
3716
|
-
/**
|
|
3717
|
-
* Service type.
|
|
3718
|
-
*
|
|
3719
|
-
* Supported Values:
|
|
3720
|
-
* - "APPOINTMENT"
|
|
3721
|
-
* - "CLASS"
|
|
3722
|
-
* - "COURSE"
|
|
3723
|
-
*
|
|
3724
|
-
*/
|
|
3725
|
-
type?: ServiceType;
|
|
3726
|
-
/** Order of a service within a category. */
|
|
3727
|
-
sortOrder?: number | null;
|
|
3728
|
-
name?: string | null;
|
|
3729
|
-
description?: string | null;
|
|
3730
|
-
tagLine?: string | null;
|
|
3731
|
-
/** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
|
|
3732
|
-
defaultCapacity?: number | null;
|
|
3733
|
-
/** Media associated with the service. */
|
|
3734
|
-
media?: Media;
|
|
3735
|
-
/** Whether the service is hidden from the site. */
|
|
3736
|
-
hidden?: boolean | null;
|
|
3737
|
-
/** The category the service is associated with. */
|
|
3738
|
-
category?: V2Category;
|
|
3739
|
-
/** The form used when booking the service. */
|
|
3740
|
-
form?: Form;
|
|
3741
|
-
/** Payment options for booking the service. */
|
|
3742
|
-
payment?: Payment;
|
|
3743
|
-
/** Online booking settings. */
|
|
3744
|
-
onlineBooking?: OnlineBooking;
|
|
3745
|
-
/** Conferencing options for this service. */
|
|
3746
|
-
conferencing?: Conferencing;
|
|
3747
|
-
/**
|
|
3748
|
-
* The locations this service is offered at.
|
|
3749
|
-
* In case of multiple (more than 1) location, All locations must be of type `BUSINESS`.
|
|
3750
|
-
* For courses only: Currently, only 1 location is supported, for all location types.
|
|
3751
|
-
*/
|
|
3752
|
-
locations?: Location[];
|
|
3753
|
-
/** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */
|
|
3754
|
-
bookingPolicy?: BookingPolicy;
|
|
3755
|
-
/** The service's schedule, which can be used to manage the service's sessions. */
|
|
3756
|
-
schedule?: Schedule;
|
|
3757
|
-
/** IDs of the staff members providing the service. For appointments only. */
|
|
3758
|
-
staffMemberIds?: string[];
|
|
3759
|
-
/**
|
|
3760
|
-
* A slug is the last part of the URL address that serves as a unique identifier of the service.
|
|
3761
|
-
* The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
|
|
3762
|
-
* @readonly
|
|
3763
|
-
*/
|
|
3764
|
-
supportedSlugs?: Slug[];
|
|
3765
|
-
/**
|
|
3766
|
-
* The main slug for the service. `mainSlug` is either taken from the current service name or is a custom slug set by the business owner.
|
|
3767
|
-
* `mainSlug` is used to construct the service's URLs.
|
|
3768
|
-
* @readonly
|
|
3769
|
-
*/
|
|
3770
|
-
mainSlug?: Slug;
|
|
3771
|
-
/**
|
|
3772
|
-
* URLs to various service-related pages, such as the calendar page and the booking page.
|
|
3773
|
-
* @readonly
|
|
3774
|
-
*/
|
|
3775
|
-
urls?: URLs;
|
|
3776
|
-
/**
|
|
3777
|
-
* Extensions enabling users to save custom data related to the service.
|
|
3778
|
-
* @readonly
|
|
3779
|
-
*/
|
|
3780
|
-
extendedFields?: ExtendedFields;
|
|
3781
|
-
/** Custom SEO data for the service. */
|
|
3782
|
-
seoData?: SeoSchema;
|
|
3783
|
-
/**
|
|
3784
|
-
* Date and time the service was created.
|
|
3785
|
-
* @readonly
|
|
3786
|
-
*/
|
|
3787
|
-
_createdDate?: Date;
|
|
3788
|
-
/**
|
|
3789
|
-
* Date and time the service was updated.
|
|
3790
|
-
* @readonly
|
|
3791
|
-
*/
|
|
3792
|
-
_updatedDate?: Date;
|
|
3793
|
-
/**
|
|
3794
|
-
* Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.
|
|
3795
|
-
* @readonly
|
|
3796
|
-
*/
|
|
3797
|
-
revision?: string | null;
|
|
3798
|
-
}
|
|
3799
|
-
/**
|
|
3800
|
-
* Deletes a service.
|
|
3801
|
-
* @param serviceId - ID of the service to delete.
|
|
3802
|
-
* @public
|
|
3803
|
-
* @documentationMaturity preview
|
|
3804
|
-
* @requiredField serviceId
|
|
3805
|
-
* @param options - Allows you to configure how to handle the deleted service's future sessions and how to notify the sessions participants.
|
|
3806
|
-
* @permissionScope Manage Bookings
|
|
3807
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3808
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3809
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3810
|
-
* @applicableIdentity APP
|
|
3811
|
-
*/
|
|
3812
|
-
export declare function deleteService(serviceId: string, options?: DeleteServiceOptions): Promise<void>;
|
|
3813
|
-
export interface DeleteServiceOptions {
|
|
3814
|
-
/**
|
|
3815
|
-
* Whether to preserve future sessions with participants.
|
|
3816
|
-
*
|
|
3817
|
-
* Default: `false`
|
|
3818
|
-
*/
|
|
3819
|
-
preserveFutureSessionsWithParticipants?: boolean;
|
|
3820
|
-
/** Whether to notify participants about the change and an optional custom message. */
|
|
3821
|
-
participantNotification?: ParticipantNotification;
|
|
3822
|
-
}
|
|
3823
|
-
/**
|
|
3824
|
-
* Retrieves a list of up to 100 services, given the provided paging, filtering, and sorting.
|
|
3825
|
-
* `queryServices()` runs with these defaults, which you can override:
|
|
3826
|
-
* + `paging.limit` is `100`.
|
|
3827
|
-
* + `paging.offset` is `0`.
|
|
3828
|
-
*
|
|
3829
|
-
*
|
|
3830
|
-
* >**Notes:**
|
|
3831
|
-
* > + Use UTC format when filtering with dates.
|
|
3832
|
-
* > + Only 1 use of each filter in the same query is supported. If a filter is defined more than once in a query, only the first occurrence is processed.
|
|
3833
|
-
* @public
|
|
3834
|
-
* @documentationMaturity preview
|
|
3835
|
-
* @permissionScope Read Bookings - Public Data
|
|
3836
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
3837
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
3838
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3839
|
-
* @permissionScope Manage Bookings
|
|
3840
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3841
|
-
* @permissionScope Read Bookings - Including Participants
|
|
3842
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
3843
|
-
* @permissionScope Read Bookings - all read permissions
|
|
3844
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
3845
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3846
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3847
|
-
* @applicableIdentity APP
|
|
3848
|
-
* @applicableIdentity MEMBER
|
|
3849
|
-
* @applicableIdentity VISITOR
|
|
3850
|
-
*/
|
|
3851
|
-
export declare function queryServices(options?: QueryServicesOptions): ServicesQueryBuilder;
|
|
3852
|
-
export interface QueryServicesOptions {
|
|
3853
|
-
}
|
|
3854
|
-
interface QueryOffsetResult {
|
|
3855
|
-
currentPage: number | undefined;
|
|
3856
|
-
totalPages: number | undefined;
|
|
3857
|
-
totalCount: number | undefined;
|
|
3858
|
-
hasNext: () => boolean;
|
|
3859
|
-
hasPrev: () => boolean;
|
|
3860
|
-
length: number;
|
|
3861
|
-
pageSize: number;
|
|
3862
|
-
}
|
|
3863
|
-
export interface ServicesQueryResult extends QueryOffsetResult {
|
|
3864
|
-
items: Service[];
|
|
3865
|
-
query: ServicesQueryBuilder;
|
|
3866
|
-
next: () => Promise<ServicesQueryResult>;
|
|
3867
|
-
prev: () => Promise<ServicesQueryResult>;
|
|
3868
|
-
}
|
|
3869
|
-
export interface ServicesQueryBuilder {
|
|
3870
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3871
|
-
* @param value - Value to compare against.
|
|
3872
|
-
* @documentationMaturity preview
|
|
3873
|
-
*/
|
|
3874
|
-
eq: (propertyName: 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3875
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3876
|
-
* @param value - Value to compare against.
|
|
3877
|
-
* @documentationMaturity preview
|
|
3878
|
-
*/
|
|
3879
|
-
ne: (propertyName: 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3880
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
3881
|
-
* @param string - String to compare against. Case-insensitive.
|
|
3882
|
-
* @documentationMaturity preview
|
|
3883
|
-
*/
|
|
3884
|
-
startsWith: (propertyName: 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'supportedSlugs.name' | 'mainSlug.name', value: string) => ServicesQueryBuilder;
|
|
3885
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
3886
|
-
* @param values - List of values to compare against.
|
|
3887
|
-
* @documentationMaturity preview
|
|
3888
|
-
*/
|
|
3889
|
-
hasSome: (propertyName: 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any[]) => ServicesQueryBuilder;
|
|
3890
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
3891
|
-
* @param values - List of values to compare against.
|
|
3892
|
-
* @documentationMaturity preview
|
|
3893
|
-
*/
|
|
3894
|
-
hasAll: (propertyName: 'staffMemberIds', value: any[]) => ServicesQueryBuilder;
|
|
3895
|
-
/** @documentationMaturity preview */
|
|
3896
|
-
in: (propertyName: 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
|
|
3897
|
-
/** @documentationMaturity preview */
|
|
3898
|
-
exists: (propertyName: 'type' | 'name' | 'description' | 'tagLine' | 'hidden' | 'category.id' | 'category.name' | 'form.id' | 'payment.options.online' | 'payment.options.inPerson' | 'payment.options.pricingPlan' | 'onlineBooking.enabled' | 'locations.business.id' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: boolean) => ServicesQueryBuilder;
|
|
3899
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3900
|
-
* @documentationMaturity preview
|
|
3901
|
-
*/
|
|
3902
|
-
limit: (limit: number) => ServicesQueryBuilder;
|
|
3903
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
3904
|
-
* @documentationMaturity preview
|
|
3905
|
-
*/
|
|
3906
|
-
skip: (skip: number) => ServicesQueryBuilder;
|
|
3907
|
-
/** @documentationMaturity preview */
|
|
3908
|
-
find: () => Promise<ServicesQueryResult>;
|
|
3909
|
-
}
|
|
3910
|
-
export {};
|