@wix/bookings 1.0.343 → 1.0.345
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 -73
- 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 -55
- 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 -73
- package/build/cjs/src/bookings-v1-category.context.js.map +0 -1
- package/build/cjs/src/bookings-v1-category.http.d.ts +0 -12
- 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 -66
- 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 -55
- 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 -66
- package/build/es/src/bookings-v1-category.context.js.map +0 -1
- package/build/es/src/bookings-v1-category.http.d.ts +0 -12
- 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,3319 +0,0 @@
|
|
|
1
|
-
import { EventDefinition } from '@wix/sdk-types';
|
|
2
|
-
/** The booking object, version 2. */
|
|
3
|
-
export interface Booking extends BookingParticipantsInfoOneOf {
|
|
4
|
-
/** Total number of participants. Available only when the booking includes a single service variant. */
|
|
5
|
-
totalParticipants?: number;
|
|
6
|
-
/**
|
|
7
|
-
* Information about the booked service choices and participants.
|
|
8
|
-
* Available only when the booking includes multiple service variants.
|
|
9
|
-
*/
|
|
10
|
-
participantsChoices?: ParticipantChoices;
|
|
11
|
-
/**
|
|
12
|
-
* Booking ID.
|
|
13
|
-
* @readonly
|
|
14
|
-
*/
|
|
15
|
-
_id?: string | null;
|
|
16
|
-
/** An object describing the slot or schedule that was booked. */
|
|
17
|
-
bookedEntity?: BookedEntity;
|
|
18
|
-
/** Contact details of the site visitor or member making the booking. */
|
|
19
|
-
contactDetails?: ContactDetails;
|
|
20
|
-
/** Additional custom fields submitted with the booking form. */
|
|
21
|
-
additionalFields?: CustomFormField[];
|
|
22
|
-
/**
|
|
23
|
-
* Booking status.
|
|
24
|
-
* One of:
|
|
25
|
-
* - `"CREATED"` - The booking was created.
|
|
26
|
-
* - `"UPDATED"` - The booking was updated.
|
|
27
|
-
* - `"CONFIRMED"` - The booking has been confirmed and appears on the bookings calendar.
|
|
28
|
-
* Booking can be automatically confirmed when the following requirements are met:
|
|
29
|
-
* + The service is configured as automatically confirmed.
|
|
30
|
-
* + Invoking eCommerce checkout API and an order has been created.
|
|
31
|
-
* - `"CANCELED"` - The booking has been canceled and synced to bookings calendar.
|
|
32
|
-
* The booking can be canceled using cancel cancelBooking().
|
|
33
|
-
* - `"PENDING"` - The booking waiting to be confirmed or declined buy the owner and is synced to bookings calendar.
|
|
34
|
-
* Booking can be automatically set as pending when the following requirements are met:
|
|
35
|
-
* + The Service is configured as manually confirmed.
|
|
36
|
-
* + Invoking the eCommerce checkout API and an order has been created.
|
|
37
|
-
* - `"WAITING_LIST"` - The booking is pending on a waiting list.
|
|
38
|
-
* - `"DECLINED"` - The booking was declined by the owner and synced to bookings calendar.
|
|
39
|
-
* Booking can be manually declined using declineBooking() and requires manage booking permissions.
|
|
40
|
-
* Booking can be automatically declined when the following requirements are met:
|
|
41
|
-
* + Invoking eCommerce checkout API and the order declined event has been sent.
|
|
42
|
-
* + Invoking eCommerce checkout API and order approved event has been sent, but the booking is offline and the booking causes a double booking.
|
|
43
|
-
*/
|
|
44
|
-
status?: BookingStatus;
|
|
45
|
-
/**
|
|
46
|
-
* Payment status.
|
|
47
|
-
* One of:
|
|
48
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
49
|
-
* - `"PAID"` The booking is fully paid.
|
|
50
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
51
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
52
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
53
|
-
* @readonly
|
|
54
|
-
*/
|
|
55
|
-
paymentStatus?: PaymentStatus;
|
|
56
|
-
/**
|
|
57
|
-
* Selected payment option.
|
|
58
|
-
* One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.
|
|
59
|
-
* When undefined, the payment option is resolved by the service configuration on checkout.
|
|
60
|
-
*/
|
|
61
|
-
selectedPaymentOption?: SelectedPaymentOption;
|
|
62
|
-
/**
|
|
63
|
-
* Date and time the booking was created.
|
|
64
|
-
* @readonly
|
|
65
|
-
*/
|
|
66
|
-
_createdDate?: Date;
|
|
67
|
-
/** External ID provided by the client app on creation. */
|
|
68
|
-
externalUserId?: string | null;
|
|
69
|
-
/** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */
|
|
70
|
-
revision?: string | null;
|
|
71
|
-
/**
|
|
72
|
-
* ID of the creator of the Booking.
|
|
73
|
-
* If `appId` and another ID are present, the other ID takes precedence.
|
|
74
|
-
* @readonly
|
|
75
|
-
*/
|
|
76
|
-
createdBy?: CommonIdentificationData;
|
|
77
|
-
/**
|
|
78
|
-
* The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.
|
|
79
|
-
* @readonly
|
|
80
|
-
*/
|
|
81
|
-
startDate?: Date;
|
|
82
|
-
/**
|
|
83
|
-
* The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.
|
|
84
|
-
* @readonly
|
|
85
|
-
*/
|
|
86
|
-
endDate?: Date;
|
|
87
|
-
/**
|
|
88
|
-
* Date and time the booking was updated.
|
|
89
|
-
* @readonly
|
|
90
|
-
*/
|
|
91
|
-
_updatedDate?: Date;
|
|
92
|
-
/** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */
|
|
93
|
-
extendedFields?: ExtendedFields;
|
|
94
|
-
/**
|
|
95
|
-
* Whether this booking overlaps another existing confirmed booking. Returned when: `true`
|
|
96
|
-
* @readonly
|
|
97
|
-
*/
|
|
98
|
-
doubleBooked?: boolean | null;
|
|
99
|
-
}
|
|
100
|
-
/** @oneof */
|
|
101
|
-
export interface BookingParticipantsInfoOneOf {
|
|
102
|
-
/** Total number of participants. Available only when the booking includes a single service variant. */
|
|
103
|
-
totalParticipants?: number;
|
|
104
|
-
/**
|
|
105
|
-
* Information about the booked service choices and participants.
|
|
106
|
-
* Available only when the booking includes multiple service variants.
|
|
107
|
-
*/
|
|
108
|
-
participantsChoices?: ParticipantChoices;
|
|
109
|
-
}
|
|
110
|
-
export declare enum MultiServiceBookingType {
|
|
111
|
-
/**
|
|
112
|
-
* Multi service booking will be considered available if its bookings are
|
|
113
|
-
* available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
114
|
-
* See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
|
|
115
|
-
*/
|
|
116
|
-
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
117
|
-
/**
|
|
118
|
-
* Multi service booking will be considered available if each of its bookings is available separately.
|
|
119
|
-
* Not supported yet
|
|
120
|
-
*/
|
|
121
|
-
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
122
|
-
/** Not supported yet */
|
|
123
|
-
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
124
|
-
}
|
|
125
|
-
export interface BookedEntity extends BookedEntityItemOneOf {
|
|
126
|
-
/** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */
|
|
127
|
-
slot?: BookedSlot;
|
|
128
|
-
/** The booked schedule. The booking is automatically assigned to the schedule's sessions. */
|
|
129
|
-
schedule?: BookedSchedule;
|
|
130
|
-
/**
|
|
131
|
-
* Session title at the time of booking.
|
|
132
|
-
* If session doesn't exist at the time of the booking, service name is used.
|
|
133
|
-
* @readonly
|
|
134
|
-
*/
|
|
135
|
-
title?: string | null;
|
|
136
|
-
/**
|
|
137
|
-
* List of tags for the booking.
|
|
138
|
-
* System-assigned tags for sessions and schedules are:
|
|
139
|
-
* + "INDIVIDUAL" Appointments, including appointments with more than 1 participant.
|
|
140
|
-
* + "GROUP" Individual classes.
|
|
141
|
-
* + "COURSE" Courses.
|
|
142
|
-
*/
|
|
143
|
-
tags?: string[] | null;
|
|
144
|
-
}
|
|
145
|
-
/** @oneof */
|
|
146
|
-
export interface BookedEntityItemOneOf {
|
|
147
|
-
/** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */
|
|
148
|
-
slot?: BookedSlot;
|
|
149
|
-
/** The booked schedule. The booking is automatically assigned to the schedule's sessions. */
|
|
150
|
-
schedule?: BookedSchedule;
|
|
151
|
-
}
|
|
152
|
-
export interface BookedSlot {
|
|
153
|
-
/**
|
|
154
|
-
* ID of the underlying session when session is a single session or generated from a recurring session.
|
|
155
|
-
* If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.
|
|
156
|
-
*/
|
|
157
|
-
sessionId?: string | null;
|
|
158
|
-
/** Service ID. */
|
|
159
|
-
serviceId?: string;
|
|
160
|
-
/** Schedule ID. Required. */
|
|
161
|
-
scheduleId?: string;
|
|
162
|
-
/**
|
|
163
|
-
* Calendar 3 event ID
|
|
164
|
-
* If not empty, on all write flows (create / update) gets priority over session_id.
|
|
165
|
-
* so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.
|
|
166
|
-
* Otherwise, if event_id is empty on write flow,
|
|
167
|
-
*/
|
|
168
|
-
eventId?: string | null;
|
|
169
|
-
/**
|
|
170
|
-
* The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
171
|
-
* format.
|
|
172
|
-
*/
|
|
173
|
-
startDate?: string | null;
|
|
174
|
-
/**
|
|
175
|
-
* The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
176
|
-
* format.
|
|
177
|
-
*/
|
|
178
|
-
endDate?: string | null;
|
|
179
|
-
/** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */
|
|
180
|
-
timezone?: string | null;
|
|
181
|
-
/**
|
|
182
|
-
* The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.
|
|
183
|
-
* When populated, the given resource will be booked according to it's availability.
|
|
184
|
-
* When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,
|
|
185
|
-
* otherwise one of the service resources will be assigned to the slot randomly upon confirmation.
|
|
186
|
-
* This resource is the slot primary resource.
|
|
187
|
-
*/
|
|
188
|
-
resource?: BookedResource;
|
|
189
|
-
/** Location where the slot's session takes place. */
|
|
190
|
-
location?: Location;
|
|
191
|
-
}
|
|
192
|
-
export interface BookedResource {
|
|
193
|
-
/** Booked resource ID. */
|
|
194
|
-
_id?: string;
|
|
195
|
-
/** Resource's name at the time of booking. */
|
|
196
|
-
name?: string | null;
|
|
197
|
-
/** Resource's email at the time of booking. */
|
|
198
|
-
email?: string | null;
|
|
199
|
-
/** Resource's schedule ID. */
|
|
200
|
-
scheduleId?: string | null;
|
|
201
|
-
}
|
|
202
|
-
export interface Location {
|
|
203
|
-
/**
|
|
204
|
-
* Business location ID. Available only for locations that are business locations,
|
|
205
|
-
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
206
|
-
*/
|
|
207
|
-
_id?: string | null;
|
|
208
|
-
/** Location name. */
|
|
209
|
-
name?: string | null;
|
|
210
|
-
/** The full address of this location. */
|
|
211
|
-
formattedAddress?: string | null;
|
|
212
|
-
/**
|
|
213
|
-
* Location type.
|
|
214
|
-
*
|
|
215
|
-
* - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings.
|
|
216
|
-
* - `"OWNER_CUSTOM"`: The address as set when creating the service.
|
|
217
|
-
* - `"CUSTOM"`: The address as set for the individual session.
|
|
218
|
-
*/
|
|
219
|
-
locationType?: LocationType;
|
|
220
|
-
}
|
|
221
|
-
export declare enum LocationType {
|
|
222
|
-
UNDEFINED = "UNDEFINED",
|
|
223
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
224
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
225
|
-
CUSTOM = "CUSTOM"
|
|
226
|
-
}
|
|
227
|
-
export interface BookedSchedule {
|
|
228
|
-
/** Schedule ID. */
|
|
229
|
-
scheduleId?: string;
|
|
230
|
-
/** Booked service ID. */
|
|
231
|
-
serviceId?: string | null;
|
|
232
|
-
/**
|
|
233
|
-
* Location where the schedule's sessions take place. Read only.
|
|
234
|
-
* @readonly
|
|
235
|
-
*/
|
|
236
|
-
location?: Location;
|
|
237
|
-
/** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */
|
|
238
|
-
timezone?: string | null;
|
|
239
|
-
/**
|
|
240
|
-
* The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
241
|
-
* format. Required.
|
|
242
|
-
* @readonly
|
|
243
|
-
*/
|
|
244
|
-
firstSessionStart?: string | null;
|
|
245
|
-
/**
|
|
246
|
-
* The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
247
|
-
* format. Required.
|
|
248
|
-
* @readonly
|
|
249
|
-
*/
|
|
250
|
-
lastSessionEnd?: string | null;
|
|
251
|
-
}
|
|
252
|
-
export interface ContactDetails {
|
|
253
|
-
/** Contact's ID. */
|
|
254
|
-
contactId?: string | null;
|
|
255
|
-
/** Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field. */
|
|
256
|
-
firstName?: string | null;
|
|
257
|
-
/** Contact's last name. */
|
|
258
|
-
lastName?: string | null;
|
|
259
|
-
/** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts/introduction). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */
|
|
260
|
-
email?: string | null;
|
|
261
|
-
/** Contact's phone number. */
|
|
262
|
-
phone?: string | null;
|
|
263
|
-
/** Contact's full address. */
|
|
264
|
-
fullAddress?: Address;
|
|
265
|
-
/** Contact's time zone. */
|
|
266
|
-
timeZone?: string | null;
|
|
267
|
-
/** Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
268
|
-
countryCode?: string | null;
|
|
269
|
-
}
|
|
270
|
-
/** Physical address */
|
|
271
|
-
export interface Address extends AddressStreetOneOf {
|
|
272
|
-
/** Street name, number and apartment number. */
|
|
273
|
-
streetAddress?: StreetAddress;
|
|
274
|
-
/** Main address line, usually street and number, as free text. */
|
|
275
|
-
addressLine?: string | null;
|
|
276
|
-
/** Country code. */
|
|
277
|
-
country?: string | null;
|
|
278
|
-
/** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
279
|
-
subdivision?: string | null;
|
|
280
|
-
/** City name. */
|
|
281
|
-
city?: string | null;
|
|
282
|
-
/** Zip/postal code. */
|
|
283
|
-
postalCode?: string | null;
|
|
284
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
285
|
-
addressLine2?: string | null;
|
|
286
|
-
/** A string containing the full address of this location. */
|
|
287
|
-
formattedAddress?: string | null;
|
|
288
|
-
/** Free text to help find the address. */
|
|
289
|
-
hint?: string | null;
|
|
290
|
-
/** Coordinates of the physical address. */
|
|
291
|
-
geocode?: AddressLocation;
|
|
292
|
-
/** Country full name. */
|
|
293
|
-
countryFullname?: string | null;
|
|
294
|
-
/** Multi-level subdivisions from top to bottom. */
|
|
295
|
-
subdivisions?: Subdivision[];
|
|
296
|
-
}
|
|
297
|
-
/** @oneof */
|
|
298
|
-
export interface AddressStreetOneOf {
|
|
299
|
-
/** Street name, number and apartment number. */
|
|
300
|
-
streetAddress?: StreetAddress;
|
|
301
|
-
/** Main address line, usually street and number, as free text. */
|
|
302
|
-
addressLine?: string | null;
|
|
303
|
-
}
|
|
304
|
-
export interface StreetAddress {
|
|
305
|
-
/** Street number. */
|
|
306
|
-
number?: string;
|
|
307
|
-
/** Street name. */
|
|
308
|
-
name?: string;
|
|
309
|
-
/** Apartment number. */
|
|
310
|
-
apt?: string;
|
|
311
|
-
}
|
|
312
|
-
export interface AddressLocation {
|
|
313
|
-
/** Address latitude. */
|
|
314
|
-
latitude?: number | null;
|
|
315
|
-
/** Address longitude. */
|
|
316
|
-
longitude?: number | null;
|
|
317
|
-
}
|
|
318
|
-
export interface Subdivision {
|
|
319
|
-
/** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
320
|
-
code?: string;
|
|
321
|
-
/** Subdivision full name. */
|
|
322
|
-
name?: string;
|
|
323
|
-
}
|
|
324
|
-
export interface CustomFormField {
|
|
325
|
-
/** ID of the form field as defined in the form. */
|
|
326
|
-
_id?: string;
|
|
327
|
-
/** Value that was submitted for this field. */
|
|
328
|
-
value?: string | null;
|
|
329
|
-
/**
|
|
330
|
-
* Form field's label at the time of submission.
|
|
331
|
-
* @readonly
|
|
332
|
-
*/
|
|
333
|
-
label?: string | null;
|
|
334
|
-
/**
|
|
335
|
-
* One of:
|
|
336
|
-
* - `"SHORT_TEXT"`
|
|
337
|
-
* - `"LONG_TEXT"`
|
|
338
|
-
* - `"CHECK_BOX"`
|
|
339
|
-
*/
|
|
340
|
-
valueType?: ValueType;
|
|
341
|
-
}
|
|
342
|
-
export declare enum ValueType {
|
|
343
|
-
/** Short text. This is the default value type. */
|
|
344
|
-
SHORT_TEXT = "SHORT_TEXT",
|
|
345
|
-
/** Long text */
|
|
346
|
-
LONG_TEXT = "LONG_TEXT",
|
|
347
|
-
/** a text that represent the check box value: if selected the value is "true", otherwise "false". */
|
|
348
|
-
CHECK_BOX = "CHECK_BOX"
|
|
349
|
-
}
|
|
350
|
-
/** Booking status. */
|
|
351
|
-
export declare enum BookingStatus {
|
|
352
|
-
CREATED = "CREATED",
|
|
353
|
-
CONFIRMED = "CONFIRMED",
|
|
354
|
-
CANCELED = "CANCELED",
|
|
355
|
-
PENDING = "PENDING",
|
|
356
|
-
DECLINED = "DECLINED",
|
|
357
|
-
WAITING_LIST = "WAITING_LIST"
|
|
358
|
-
}
|
|
359
|
-
/**
|
|
360
|
-
* Payment status.
|
|
361
|
-
* Automatically updated when using eCom checkout APIs.
|
|
362
|
-
*/
|
|
363
|
-
export declare enum PaymentStatus {
|
|
364
|
-
UNDEFINED = "UNDEFINED",
|
|
365
|
-
NOT_PAID = "NOT_PAID",
|
|
366
|
-
PAID = "PAID",
|
|
367
|
-
/** not supported yet. */
|
|
368
|
-
PARTIALLY_PAID = "PARTIALLY_PAID",
|
|
369
|
-
/** not supported yet */
|
|
370
|
-
REFUNDED = "REFUNDED",
|
|
371
|
-
EXEMPT = "EXEMPT"
|
|
372
|
-
}
|
|
373
|
-
/**
|
|
374
|
-
* The selected payment option.
|
|
375
|
-
* One of the payment options offered by the service.
|
|
376
|
-
* This field is be set when the user selects an option during booking.
|
|
377
|
-
* If left undefined, the payment option is resolved by the service configuration on checkout.
|
|
378
|
-
*/
|
|
379
|
-
export declare enum SelectedPaymentOption {
|
|
380
|
-
UNDEFINED = "UNDEFINED",
|
|
381
|
-
OFFLINE = "OFFLINE",
|
|
382
|
-
ONLINE = "ONLINE",
|
|
383
|
-
MEMBERSHIP = "MEMBERSHIP",
|
|
384
|
-
/** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
|
|
385
|
-
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
386
|
-
}
|
|
387
|
-
export interface BookingSource {
|
|
388
|
-
/**
|
|
389
|
-
* Platform from which a booking was created
|
|
390
|
-
* <!--ONLY:VELO
|
|
391
|
-
* One of:
|
|
392
|
-
* - `"WEB"` Desktop browser.
|
|
393
|
-
* - `"MOBILE_APP"` Mobile application.
|
|
394
|
-
* <!--END:ONLY:VELO-->
|
|
395
|
-
*/
|
|
396
|
-
platform?: Platform;
|
|
397
|
-
/**
|
|
398
|
-
* Actor that created this booking.
|
|
399
|
-
* <!--ONLY:VELO
|
|
400
|
-
* One of:
|
|
401
|
-
* - `"BUSINESS"`
|
|
402
|
-
* - `"CUSTOMER"`
|
|
403
|
-
* <!--END:ONLY:VELO-->
|
|
404
|
-
*/
|
|
405
|
-
actor?: Actor;
|
|
406
|
-
/**
|
|
407
|
-
* Wix site ID of the application that created the booking.
|
|
408
|
-
* @readonly
|
|
409
|
-
*/
|
|
410
|
-
appDefId?: string | null;
|
|
411
|
-
/**
|
|
412
|
-
* Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.
|
|
413
|
-
* @readonly
|
|
414
|
-
*/
|
|
415
|
-
appName?: string | null;
|
|
416
|
-
}
|
|
417
|
-
export declare enum Platform {
|
|
418
|
-
UNDEFINED_PLATFORM = "UNDEFINED_PLATFORM",
|
|
419
|
-
WEB = "WEB",
|
|
420
|
-
MOBILE_APP = "MOBILE_APP"
|
|
421
|
-
}
|
|
422
|
-
export declare enum Actor {
|
|
423
|
-
UNDEFINED_ACTOR = "UNDEFINED_ACTOR",
|
|
424
|
-
BUSINESS = "BUSINESS",
|
|
425
|
-
CUSTOMER = "CUSTOMER"
|
|
426
|
-
}
|
|
427
|
-
export interface ParticipantNotification {
|
|
428
|
-
/**
|
|
429
|
-
* Whether to send the message about the changes to the customer.
|
|
430
|
-
*
|
|
431
|
-
* Default: `false`
|
|
432
|
-
*/
|
|
433
|
-
notifyParticipants?: boolean;
|
|
434
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
435
|
-
message?: string | null;
|
|
436
|
-
}
|
|
437
|
-
export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
438
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
439
|
-
anonymousVisitorId?: string;
|
|
440
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
441
|
-
memberId?: string;
|
|
442
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
443
|
-
wixUserId?: string;
|
|
444
|
-
/** ID of an app. */
|
|
445
|
-
appId?: string;
|
|
446
|
-
/** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */
|
|
447
|
-
contactId?: string | null;
|
|
448
|
-
}
|
|
449
|
-
/** @oneof */
|
|
450
|
-
export interface CommonIdentificationDataIdOneOf {
|
|
451
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
452
|
-
anonymousVisitorId?: string;
|
|
453
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
454
|
-
memberId?: string;
|
|
455
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
456
|
-
wixUserId?: string;
|
|
457
|
-
/** ID of an app. */
|
|
458
|
-
appId?: string;
|
|
459
|
-
}
|
|
460
|
-
export declare enum IdentificationDataIdentityType {
|
|
461
|
-
UNKNOWN = "UNKNOWN",
|
|
462
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
463
|
-
MEMBER = "MEMBER",
|
|
464
|
-
WIX_USER = "WIX_USER",
|
|
465
|
-
APP = "APP"
|
|
466
|
-
}
|
|
467
|
-
export interface FlowControlSettings {
|
|
468
|
-
/**
|
|
469
|
-
* When true, skips availability checking and allows booking.
|
|
470
|
-
* Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.
|
|
471
|
-
*/
|
|
472
|
-
skipAvailabilityValidation?: boolean;
|
|
473
|
-
/**
|
|
474
|
-
* When true, allows booking a confirmation-required service without requiring confirmation.
|
|
475
|
-
* Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.
|
|
476
|
-
*/
|
|
477
|
-
skipBusinessConfirmation?: boolean;
|
|
478
|
-
/**
|
|
479
|
-
* When true, skips selected payment option checking as defined in `selectedPaymentOption` field
|
|
480
|
-
* and allows booking.
|
|
481
|
-
* Requires BOOKINGS.MANAGE_PAYMENTS permissions.
|
|
482
|
-
*/
|
|
483
|
-
skipSelectedPaymentOptionValidation?: boolean;
|
|
484
|
-
/** When true, refunds the booking's payment when the booking is canceled. */
|
|
485
|
-
withRefund?: boolean | null;
|
|
486
|
-
}
|
|
487
|
-
export interface ExtendedFields {
|
|
488
|
-
/**
|
|
489
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
490
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
491
|
-
*
|
|
492
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
493
|
-
*
|
|
494
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
495
|
-
*/
|
|
496
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
497
|
-
}
|
|
498
|
-
export interface ParticipantChoices {
|
|
499
|
-
/** Information about the booked service choices. Includes the number of participants. */
|
|
500
|
-
serviceChoices?: ServiceChoices[];
|
|
501
|
-
}
|
|
502
|
-
export interface ServiceChoices {
|
|
503
|
-
/** Number of participants for this variant. */
|
|
504
|
-
numberOfParticipants?: number | null;
|
|
505
|
-
/** Service choices for these participants. */
|
|
506
|
-
choices?: ServiceChoice[];
|
|
507
|
-
}
|
|
508
|
-
export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
509
|
-
/**
|
|
510
|
-
* Value for one of the choices in the `CustomServiceOption.choices` list.
|
|
511
|
-
* Choices are specific values for an option the customer can choose to book. For example,
|
|
512
|
-
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
513
|
-
* Each choice may have a different price.
|
|
514
|
-
*/
|
|
515
|
-
custom?: string;
|
|
516
|
-
/**
|
|
517
|
-
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
518
|
-
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
519
|
-
* for the `ageGroup` option.
|
|
520
|
-
*/
|
|
521
|
-
optionId?: string;
|
|
522
|
-
}
|
|
523
|
-
/** @oneof */
|
|
524
|
-
export interface ServiceChoiceChoiceOneOf {
|
|
525
|
-
/**
|
|
526
|
-
* Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
|
|
527
|
-
* Choices are specific values for an option the customer can choose to book. For example,
|
|
528
|
-
* the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
|
|
529
|
-
* Each choice may have a different price.
|
|
530
|
-
*/
|
|
531
|
-
custom?: string;
|
|
532
|
-
}
|
|
533
|
-
export interface MultiServiceBookingInfo {
|
|
534
|
-
/**
|
|
535
|
-
* Multi service booking ID.
|
|
536
|
-
* @readonly
|
|
537
|
-
*/
|
|
538
|
-
_id?: string | null;
|
|
539
|
-
/** Multi service booking type. */
|
|
540
|
-
type?: MultiServiceBookingType;
|
|
541
|
-
}
|
|
542
|
-
export interface CreateMultiServiceBookingRequest {
|
|
543
|
-
/** The bookings to create as multi service booking. */
|
|
544
|
-
bookings?: Booking[];
|
|
545
|
-
/** Information about a message to send to the customer. */
|
|
546
|
-
participantNotification?: ParticipantNotification;
|
|
547
|
-
/**
|
|
548
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
549
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
550
|
-
* Default: `true`.
|
|
551
|
-
*/
|
|
552
|
-
sendSmsReminder?: boolean | null;
|
|
553
|
-
/**
|
|
554
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
555
|
-
* creation flow are changed. For example, whether the availability is
|
|
556
|
-
* checked before creating the booking or if additional payment options are
|
|
557
|
-
* accepted.
|
|
558
|
-
*/
|
|
559
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
560
|
-
/** Whether to return the created bookings entities. */
|
|
561
|
-
returnFullEntity?: boolean;
|
|
562
|
-
/**
|
|
563
|
-
* Multi service booking type.
|
|
564
|
-
* One of:
|
|
565
|
-
* - `"SEQUENTIAL_BOOKINGS"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
566
|
-
* - `"SEPARATE_BOOKINGS"` Not supported yet.
|
|
567
|
-
* - `"PARALLEL_BOOKINGS"` Not supported yet.
|
|
568
|
-
*/
|
|
569
|
-
multiServiceBookingType?: MultiServiceBookingType;
|
|
570
|
-
}
|
|
571
|
-
export interface CreateBookingFlowControlSettings {
|
|
572
|
-
/**
|
|
573
|
-
* Whether the availability is checked before creating the booking. When
|
|
574
|
-
* passing `false` a booking is only created when the slot or schedule is
|
|
575
|
-
* available.
|
|
576
|
-
* Default: `false`.
|
|
577
|
-
*/
|
|
578
|
-
skipAvailabilityValidation?: boolean;
|
|
579
|
-
/**
|
|
580
|
-
* Whether `PENDING` bookings are automatically set to `CONFIRMED` for
|
|
581
|
-
* services that normally require the owner's manual confirmation. Your
|
|
582
|
-
* app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope
|
|
583
|
-
* when passing `true`.
|
|
584
|
-
* Default: `false`.
|
|
585
|
-
*/
|
|
586
|
-
skipBusinessConfirmation?: boolean;
|
|
587
|
-
/**
|
|
588
|
-
* Whether customers can pay using a payment method that isn't supported
|
|
589
|
-
* for the service, but that's supported for other services. Your app
|
|
590
|
-
* must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing
|
|
591
|
-
* `true`.
|
|
592
|
-
* Default: `false`.
|
|
593
|
-
*/
|
|
594
|
-
skipSelectedPaymentOptionValidation?: boolean;
|
|
595
|
-
}
|
|
596
|
-
export interface CreateMultiServiceBookingResponse {
|
|
597
|
-
/**
|
|
598
|
-
* Created multi service booking.
|
|
599
|
-
* Contains the booking results on the same order as passed on the request.
|
|
600
|
-
*/
|
|
601
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
602
|
-
}
|
|
603
|
-
export interface MultiServiceBooking {
|
|
604
|
-
/** Multi service booking ID. */
|
|
605
|
-
_id?: string | null;
|
|
606
|
-
/** The created bookings which are part of the multi service booking */
|
|
607
|
-
bookings?: BookingResult[];
|
|
608
|
-
}
|
|
609
|
-
export interface BookingResult {
|
|
610
|
-
/** Booking ID. */
|
|
611
|
-
bookingId?: string | null;
|
|
612
|
-
/** Booking entity. */
|
|
613
|
-
booking?: Booking;
|
|
614
|
-
}
|
|
615
|
-
export interface RescheduleMultiServiceBookingRequest {
|
|
616
|
-
/** ID of the multi service booking to reschedule it's related bookings. */
|
|
617
|
-
multiServiceBookingId?: string | null;
|
|
618
|
-
/** Bookings to reschedule. */
|
|
619
|
-
rescheduleBookingsInfo?: RescheduleMultiServiceBookingRequestRescheduleBookingInfo[];
|
|
620
|
-
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
621
|
-
participantNotification?: ParticipantNotification;
|
|
622
|
-
/**
|
|
623
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
624
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
625
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
626
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
627
|
-
*/
|
|
628
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
629
|
-
/** Whether to return the rescheduled bookings entities. */
|
|
630
|
-
returnFullEntity?: boolean;
|
|
631
|
-
}
|
|
632
|
-
export interface V2Slot {
|
|
633
|
-
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
634
|
-
sessionId?: string | null;
|
|
635
|
-
/** Service identifier. Required. */
|
|
636
|
-
serviceId?: string;
|
|
637
|
-
/** Schedule identifier. Required. */
|
|
638
|
-
scheduleId?: string;
|
|
639
|
-
/** The start time of this Slot (formatted according to RFC3339). Required. */
|
|
640
|
-
startDate?: string | null;
|
|
641
|
-
/** The end time of this Slot (formatted according to RFC3339). Required. */
|
|
642
|
-
endDate?: string | null;
|
|
643
|
-
/** The timezone according to which the slot is calculated presented. */
|
|
644
|
-
timezone?: string | null;
|
|
645
|
-
/**
|
|
646
|
-
* The resource required for this slot.
|
|
647
|
-
* When populated, the given resource will be assigned to the slot upon confirmation according to it's availability.
|
|
648
|
-
* When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,
|
|
649
|
-
* otherwise one of the service resources will be assigned to the slot randomly upon confirmation.
|
|
650
|
-
*/
|
|
651
|
-
resource?: SlotSlotResource;
|
|
652
|
-
/** Geographic location of the slot. */
|
|
653
|
-
location?: SlotLocation;
|
|
654
|
-
}
|
|
655
|
-
export declare enum LocationLocationType {
|
|
656
|
-
UNDEFINED = "UNDEFINED",
|
|
657
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
658
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
659
|
-
CUSTOM = "CUSTOM"
|
|
660
|
-
}
|
|
661
|
-
export interface SlotSlotResource {
|
|
662
|
-
/**
|
|
663
|
-
* Resource ID
|
|
664
|
-
* @readonly
|
|
665
|
-
*/
|
|
666
|
-
_id?: string | null;
|
|
667
|
-
/** Read only. Resource name. */
|
|
668
|
-
name?: string | null;
|
|
669
|
-
}
|
|
670
|
-
export interface SlotLocation {
|
|
671
|
-
/** Business Location ID. Present if the location is a business location. */
|
|
672
|
-
_id?: string | null;
|
|
673
|
-
/** Location name. */
|
|
674
|
-
name?: string | null;
|
|
675
|
-
/** A string containing the full address of this location. */
|
|
676
|
-
formattedAddress?: string | null;
|
|
677
|
-
/**
|
|
678
|
-
* Location type.
|
|
679
|
-
* One of:
|
|
680
|
-
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
681
|
-
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
682
|
-
* - `"CUSTOM"` The address set for the individual session.
|
|
683
|
-
*/
|
|
684
|
-
locationType?: LocationLocationType;
|
|
685
|
-
}
|
|
686
|
-
export interface RescheduleMultiServiceBookingRequestRescheduleBookingInfo extends RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {
|
|
687
|
-
/**
|
|
688
|
-
* Total number of participants. Available only for services with
|
|
689
|
-
* variants.
|
|
690
|
-
* Pass when all participants book the same variant.
|
|
691
|
-
*/
|
|
692
|
-
totalParticipants?: number;
|
|
693
|
-
/**
|
|
694
|
-
* Information about the service choices to book. Available only for services with
|
|
695
|
-
* variants.
|
|
696
|
-
* Pass when not all participants book the same variant.
|
|
697
|
-
*/
|
|
698
|
-
participantsChoices?: ParticipantChoices;
|
|
699
|
-
/** ID of the booking to reschedule. */
|
|
700
|
-
bookingId?: string | null;
|
|
701
|
-
/** Information about the new slot. */
|
|
702
|
-
slot?: V2Slot;
|
|
703
|
-
/**
|
|
704
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
705
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
706
|
-
* managing the booking.
|
|
707
|
-
*/
|
|
708
|
-
revision?: string | null;
|
|
709
|
-
}
|
|
710
|
-
/** @oneof */
|
|
711
|
-
export interface RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {
|
|
712
|
-
/**
|
|
713
|
-
* Total number of participants. Available only for services with
|
|
714
|
-
* variants.
|
|
715
|
-
* Pass when all participants book the same variant.
|
|
716
|
-
*/
|
|
717
|
-
totalParticipants?: number;
|
|
718
|
-
/**
|
|
719
|
-
* Information about the service choices to book. Available only for services with
|
|
720
|
-
* variants.
|
|
721
|
-
* Pass when not all participants book the same variant.
|
|
722
|
-
*/
|
|
723
|
-
participantsChoices?: ParticipantChoices;
|
|
724
|
-
}
|
|
725
|
-
export interface RescheduleBookingFlowControlSettings {
|
|
726
|
-
/**
|
|
727
|
-
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
728
|
-
* When passing `false` you can only cancel a booking if the rescheduling
|
|
729
|
-
* policy allows it.
|
|
730
|
-
* Default: `false`.
|
|
731
|
-
* <!--ONLY:VELO
|
|
732
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
733
|
-
* <!--END:ONLY:VELO-->
|
|
734
|
-
*/
|
|
735
|
-
ignoreReschedulePolicy?: boolean;
|
|
736
|
-
/**
|
|
737
|
-
* Whether the availability is checked before rescheduling the booking.
|
|
738
|
-
* When passing `false` a booking is only created when the slot or
|
|
739
|
-
* schedule is available.
|
|
740
|
-
* Default: `false`.
|
|
741
|
-
*/
|
|
742
|
-
skipAvailabilityValidation?: boolean;
|
|
743
|
-
/**
|
|
744
|
-
* Whether the rescheduled booking's status is automatically set to
|
|
745
|
-
* `CONFIRMED` for services that normally require the owner's manual
|
|
746
|
-
* confirmation.
|
|
747
|
-
* Default: `false`.
|
|
748
|
-
*/
|
|
749
|
-
skipBusinessConfirmation?: boolean;
|
|
750
|
-
}
|
|
751
|
-
export interface RescheduleMultiServiceBookingResponse {
|
|
752
|
-
/** Rescheduled multi service booking. */
|
|
753
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
754
|
-
}
|
|
755
|
-
export interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
756
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
757
|
-
previousTotalParticipants?: number;
|
|
758
|
-
/**
|
|
759
|
-
* Information about the previous booked service choices and participants.
|
|
760
|
-
* Available only when the booking includes multiple service variants.
|
|
761
|
-
*/
|
|
762
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
763
|
-
/** The rescheduled booking object. */
|
|
764
|
-
booking?: Booking;
|
|
765
|
-
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
766
|
-
participantNotification?: ParticipantNotification;
|
|
767
|
-
/**
|
|
768
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
769
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
770
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
771
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
772
|
-
*/
|
|
773
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
774
|
-
/** ID of the rescheduling initiator. */
|
|
775
|
-
initiatedBy?: IdentificationData;
|
|
776
|
-
/** The previous status of the booking. */
|
|
777
|
-
previousStatus?: BookingStatus;
|
|
778
|
-
/** An object describing the previous slot or schedule of the booking. */
|
|
779
|
-
previousBookedEntity?: BookedEntity;
|
|
780
|
-
/** The previous start date of the booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session. */
|
|
781
|
-
previousStartDate?: Date;
|
|
782
|
-
/** The previous end date of the booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session. */
|
|
783
|
-
previousEndDate?: Date;
|
|
784
|
-
}
|
|
785
|
-
/** @oneof */
|
|
786
|
-
export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
787
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
788
|
-
previousTotalParticipants?: number;
|
|
789
|
-
/**
|
|
790
|
-
* Information about the previous booked service choices and participants.
|
|
791
|
-
* Available only when the booking includes multiple service variants.
|
|
792
|
-
*/
|
|
793
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
794
|
-
}
|
|
795
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
796
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
797
|
-
anonymousVisitorId?: string;
|
|
798
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
799
|
-
memberId?: string;
|
|
800
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
801
|
-
wixUserId?: string;
|
|
802
|
-
/** ID of an app. */
|
|
803
|
-
appId?: string;
|
|
804
|
-
/**
|
|
805
|
-
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
806
|
-
* @readonly
|
|
807
|
-
*/
|
|
808
|
-
contactId?: string | null;
|
|
809
|
-
}
|
|
810
|
-
/** @oneof */
|
|
811
|
-
export interface IdentificationDataIdOneOf {
|
|
812
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
813
|
-
anonymousVisitorId?: string;
|
|
814
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
815
|
-
memberId?: string;
|
|
816
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
817
|
-
wixUserId?: string;
|
|
818
|
-
/** ID of an app. */
|
|
819
|
-
appId?: string;
|
|
820
|
-
}
|
|
821
|
-
export declare enum IdentityType {
|
|
822
|
-
UNKNOWN = "UNKNOWN",
|
|
823
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
824
|
-
MEMBER = "MEMBER",
|
|
825
|
-
WIX_USER = "WIX_USER",
|
|
826
|
-
APP = "APP"
|
|
827
|
-
}
|
|
828
|
-
export interface GetMultiServiceBookingAvailabilityRequest {
|
|
829
|
-
multiServiceBookingId?: string | null;
|
|
830
|
-
}
|
|
831
|
-
export interface GetMultiServiceBookingAvailabilityResponse {
|
|
832
|
-
/** Whether these bookings are bookable. */
|
|
833
|
-
bookable?: boolean;
|
|
834
|
-
/** Total number of spots for this availability. */
|
|
835
|
-
totalCapacity?: number | null;
|
|
836
|
-
/** Number of open spots for this availability. */
|
|
837
|
-
remainingCapacity?: number | null;
|
|
838
|
-
/** Indicators for policy violations of the multi service booking. */
|
|
839
|
-
policyViolations?: BookingPolicyViolations;
|
|
840
|
-
/** Multi service booking policy settings */
|
|
841
|
-
policySettings?: BookingPolicySettings;
|
|
842
|
-
/** Info of the bookings this availability was calculated for. */
|
|
843
|
-
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
844
|
-
}
|
|
845
|
-
export interface BookingPolicyViolations {
|
|
846
|
-
/** Bookings policy violation. Too early to book this slot. */
|
|
847
|
-
tooEarlyToBook?: boolean | null;
|
|
848
|
-
/** Bookings policy violation. Too late to book this slot. */
|
|
849
|
-
tooLateToBook?: boolean | null;
|
|
850
|
-
/** Bookings policy violation. Online booking is disabled for this slot. */
|
|
851
|
-
bookOnlineDisabled?: boolean | null;
|
|
852
|
-
}
|
|
853
|
-
export interface BookingPolicySettings {
|
|
854
|
-
/** Booking policy settings for a given Slot/Schedule */
|
|
855
|
-
maxParticipantsPerBooking?: number | null;
|
|
856
|
-
}
|
|
857
|
-
export interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
858
|
-
/** Booking id */
|
|
859
|
-
bookingId?: string | null;
|
|
860
|
-
}
|
|
861
|
-
export interface CancelMultiServiceBookingRequest {
|
|
862
|
-
/** ID of the multi service booking to cancel it's related bookings. */
|
|
863
|
-
multiServiceBookingId?: string | null;
|
|
864
|
-
/** Information about whether to notify the customer about the cancelation and the message to send. */
|
|
865
|
-
participantNotification?: ParticipantNotification;
|
|
866
|
-
/**
|
|
867
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
868
|
-
* cancelation flow are changed. For example, whether the you can cancel
|
|
869
|
-
* a booking even though the cancelation policy doesn't allow it or whether
|
|
870
|
-
* to issue a refund.
|
|
871
|
-
*/
|
|
872
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
873
|
-
/** Whether to return the canceled bookings entities. */
|
|
874
|
-
returnFullEntity?: boolean;
|
|
875
|
-
}
|
|
876
|
-
export interface CancelBookingFlowControlSettings {
|
|
877
|
-
/**
|
|
878
|
-
* Whether the cancelation policy applies when canceling the booking. When
|
|
879
|
-
* passing `false` you can only cancel a booking if the cancelation policy
|
|
880
|
-
* allows it.
|
|
881
|
-
* Default: `false`.
|
|
882
|
-
* <!--ONLY:VELO
|
|
883
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
884
|
-
* <!--END:ONLY:VELO-->
|
|
885
|
-
*/
|
|
886
|
-
ignoreCancellationPolicy?: boolean | null;
|
|
887
|
-
/**
|
|
888
|
-
* Whether to issue a refund when canceling the booking.
|
|
889
|
-
* The refund will be issued only if the booking is refundable.
|
|
890
|
-
* Currently, booking is considered refundable when it was paid by membership.
|
|
891
|
-
* If passing `true`, the booking flow control settings will be set with refund,
|
|
892
|
-
* otherwise, either if `false` is passed or the field remains empty,
|
|
893
|
-
* the booking flow control settings will be set with no refund.
|
|
894
|
-
* Default: `false`.
|
|
895
|
-
*/
|
|
896
|
-
withRefund?: boolean | null;
|
|
897
|
-
}
|
|
898
|
-
export interface CancelMultiServiceBookingResponse {
|
|
899
|
-
/** Canceled multi service booking. */
|
|
900
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
901
|
-
}
|
|
902
|
-
export interface BookingCanceled {
|
|
903
|
-
/** The canceled booking object. */
|
|
904
|
-
booking?: Booking;
|
|
905
|
-
/** Information about whether to notify the customer about the cancelation and the message to send. */
|
|
906
|
-
participantNotification?: ParticipantNotification;
|
|
907
|
-
/**
|
|
908
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
909
|
-
* cancelation flow are changed. For example, whether you can cancel
|
|
910
|
-
* a booking even though the cancelation policy doesn't allow it or whether
|
|
911
|
-
* to issue a refund.
|
|
912
|
-
*/
|
|
913
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
914
|
-
/** ID of the cancelation initiator. */
|
|
915
|
-
initiatedBy?: IdentificationData;
|
|
916
|
-
/** The previous status of the booking. */
|
|
917
|
-
previousStatus?: BookingStatus;
|
|
918
|
-
}
|
|
919
|
-
export interface MarkMultiServiceBookingAsPendingRequest {
|
|
920
|
-
/** ID of the multi service booking to mark as pending it's related bookings. */
|
|
921
|
-
multiServiceBookingId?: string | null;
|
|
922
|
-
/** Bookings to mark as pending. */
|
|
923
|
-
markAsPendingBookingsInfo?: BookingInfo[];
|
|
924
|
-
/** Information about whether to notify the customer upon manual confirmation and the message to send. */
|
|
925
|
-
participantNotification?: ParticipantNotification;
|
|
926
|
-
/**
|
|
927
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
928
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
929
|
-
*/
|
|
930
|
-
sendSmsReminder?: boolean | null;
|
|
931
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
932
|
-
doubleBooked?: boolean | null;
|
|
933
|
-
/** Whether to return the pending bookings entities. */
|
|
934
|
-
returnFullEntity?: boolean;
|
|
935
|
-
/**
|
|
936
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
937
|
-
* creation flow are changed. For example, whether the availability is
|
|
938
|
-
* checked before updating the booking.
|
|
939
|
-
*/
|
|
940
|
-
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
941
|
-
}
|
|
942
|
-
export interface BookingInfo {
|
|
943
|
-
/** ID of the booking. */
|
|
944
|
-
bookingId?: string | null;
|
|
945
|
-
/**
|
|
946
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
947
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
948
|
-
* managing the booking.
|
|
949
|
-
*/
|
|
950
|
-
revision?: string | null;
|
|
951
|
-
/**
|
|
952
|
-
* Payment status to set for the booking.
|
|
953
|
-
* One of:
|
|
954
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
955
|
-
* - `"PAID"` The booking is fully paid.
|
|
956
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
957
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
958
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
959
|
-
*/
|
|
960
|
-
paymentStatus?: PaymentStatus;
|
|
961
|
-
}
|
|
962
|
-
export interface MarkBookingAsPendingFlowControlSettings {
|
|
963
|
-
/**
|
|
964
|
-
* Whether should check for double bookings before updating the booking as pending.
|
|
965
|
-
* When passing `false` a booking is only being updated with status PENDING
|
|
966
|
-
* Default: `false`.
|
|
967
|
-
*/
|
|
968
|
-
checkAvailabilityValidation?: boolean;
|
|
969
|
-
/**
|
|
970
|
-
* Whether should validate that the given booking to be marked as pending, has a booking.slot.serviceId
|
|
971
|
-
* of a pending approval service.
|
|
972
|
-
* Default: `false`.
|
|
973
|
-
*/
|
|
974
|
-
skipPendingApprovalServiceValidation?: boolean;
|
|
975
|
-
}
|
|
976
|
-
export interface MarkMultiServiceBookingAsPendingResponse {
|
|
977
|
-
/** Pending multi service booking. */
|
|
978
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
979
|
-
}
|
|
980
|
-
export interface ConfirmMultiServiceBookingRequest {
|
|
981
|
-
/** ID of the multi service booking to confirm it's related bookings. */
|
|
982
|
-
multiServiceBookingId?: string | null;
|
|
983
|
-
/** Bookings to confirm. */
|
|
984
|
-
confirmBookingsInfo?: BookingInfo[];
|
|
985
|
-
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
986
|
-
participantNotification?: ParticipantNotification;
|
|
987
|
-
/**
|
|
988
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
989
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
990
|
-
*/
|
|
991
|
-
sendSmsReminder?: boolean | null;
|
|
992
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
993
|
-
doubleBooked?: boolean | null;
|
|
994
|
-
/** Whether to return the confirmed bookings entities. */
|
|
995
|
-
returnFullEntity?: boolean;
|
|
996
|
-
/**
|
|
997
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
998
|
-
* confirmation flow are changed. For example, whether the availability is
|
|
999
|
-
* checked before confirming the booking.
|
|
1000
|
-
*/
|
|
1001
|
-
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
1002
|
-
}
|
|
1003
|
-
export interface ConfirmBookingFlowControlSettings {
|
|
1004
|
-
/**
|
|
1005
|
-
* todo: docs any-resource flow behavior
|
|
1006
|
-
* Whether the availability is checked before confirming the booking.
|
|
1007
|
-
* When passing `false` a booking is only being updated with status CONFIRMED
|
|
1008
|
-
* Default: `false`.
|
|
1009
|
-
*/
|
|
1010
|
-
checkAvailabilityValidation?: boolean;
|
|
1011
|
-
}
|
|
1012
|
-
export interface ConfirmMultiServiceBookingResponse {
|
|
1013
|
-
/** Confirmed multi service booking. */
|
|
1014
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1015
|
-
}
|
|
1016
|
-
export interface BookingConfirmed {
|
|
1017
|
-
/** The confirmed booking object. */
|
|
1018
|
-
booking?: Booking;
|
|
1019
|
-
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
1020
|
-
participantNotification?: ParticipantNotification;
|
|
1021
|
-
/**
|
|
1022
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1023
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1024
|
-
*/
|
|
1025
|
-
sendSmsReminder?: boolean | null;
|
|
1026
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1027
|
-
doubleBooked?: boolean | null;
|
|
1028
|
-
/** ID of the confirmation initiator. */
|
|
1029
|
-
initiatedBy?: IdentificationData;
|
|
1030
|
-
/** The previous status of the booking. */
|
|
1031
|
-
previousStatus?: BookingStatus;
|
|
1032
|
-
/** The previous payment status of the booking. */
|
|
1033
|
-
previousPaymentStatus?: PaymentStatus;
|
|
1034
|
-
}
|
|
1035
|
-
export interface DeclineMultiServiceBookingRequest {
|
|
1036
|
-
/** ID of the multi service booking to decline it's related bookings. */
|
|
1037
|
-
multiServiceBookingId?: string | null;
|
|
1038
|
-
/** Bookings to decline. */
|
|
1039
|
-
declineBookingsInfo?: BookingInfo[];
|
|
1040
|
-
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
1041
|
-
participantNotification?: ParticipantNotification;
|
|
1042
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1043
|
-
doubleBooked?: boolean | null;
|
|
1044
|
-
/** Whether to return the declined bookings entities. */
|
|
1045
|
-
returnFullEntity?: boolean;
|
|
1046
|
-
}
|
|
1047
|
-
export interface DeclineMultiServiceBookingResponse {
|
|
1048
|
-
/** Declined multi service booking. */
|
|
1049
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1050
|
-
}
|
|
1051
|
-
export interface BookingDeclined {
|
|
1052
|
-
/** The declined booking object. */
|
|
1053
|
-
booking?: Booking;
|
|
1054
|
-
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
1055
|
-
participantNotification?: ParticipantNotification;
|
|
1056
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1057
|
-
doubleBooked?: boolean | null;
|
|
1058
|
-
/** ID of the decline initiator. */
|
|
1059
|
-
initiatedBy?: IdentificationData;
|
|
1060
|
-
/** The previous status of the booking. */
|
|
1061
|
-
previousStatus?: BookingStatus;
|
|
1062
|
-
/** The previous payment status of the booking. */
|
|
1063
|
-
previousPaymentStatus?: PaymentStatus;
|
|
1064
|
-
}
|
|
1065
|
-
export interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
1066
|
-
/** The multi service booking ids to get the allowedActions for. */
|
|
1067
|
-
multiServiceBookingIds?: string[] | null;
|
|
1068
|
-
}
|
|
1069
|
-
export interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
1070
|
-
results?: BulkCalculateAllowedActionsResult[];
|
|
1071
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1072
|
-
}
|
|
1073
|
-
export interface BulkCalculateAllowedActionsResult {
|
|
1074
|
-
/** (id, indexInGivenSeq, isSuccessful, error) */
|
|
1075
|
-
itemMetadata?: ItemMetadata;
|
|
1076
|
-
item?: AllowedActions;
|
|
1077
|
-
}
|
|
1078
|
-
export interface ItemMetadata {
|
|
1079
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1080
|
-
_id?: string | null;
|
|
1081
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1082
|
-
originalIndex?: number;
|
|
1083
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1084
|
-
success?: boolean;
|
|
1085
|
-
/** Details about the error in case of failure. */
|
|
1086
|
-
error?: ApplicationError;
|
|
1087
|
-
}
|
|
1088
|
-
export interface ApplicationError {
|
|
1089
|
-
/** Error code. */
|
|
1090
|
-
code?: string;
|
|
1091
|
-
/** Description of the error. */
|
|
1092
|
-
description?: string;
|
|
1093
|
-
/** Data related to the error. */
|
|
1094
|
-
data?: Record<string, any> | null;
|
|
1095
|
-
}
|
|
1096
|
-
/** Possible allowed actions for a Booking */
|
|
1097
|
-
export interface AllowedActions {
|
|
1098
|
-
/** Is cancel booking allowed */
|
|
1099
|
-
cancel?: boolean;
|
|
1100
|
-
/** Is reschedule booking allowed */
|
|
1101
|
-
reschedule?: boolean;
|
|
1102
|
-
}
|
|
1103
|
-
export interface BulkActionMetadata {
|
|
1104
|
-
/** Number of items that were successfully processed. */
|
|
1105
|
-
totalSuccesses?: number;
|
|
1106
|
-
/** Number of items that couldn't be processed. */
|
|
1107
|
-
totalFailures?: number;
|
|
1108
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1109
|
-
undetailedFailures?: number;
|
|
1110
|
-
}
|
|
1111
|
-
export interface MarkAsMultiServiceBookingRequest {
|
|
1112
|
-
/** IDs of the bookings to mark as multi service booking. */
|
|
1113
|
-
bookingIds?: string[] | null;
|
|
1114
|
-
/**
|
|
1115
|
-
* Multi service booking type.
|
|
1116
|
-
* One of:
|
|
1117
|
-
* - `"SEQUENTIAL_BOOKINGS"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
1118
|
-
* - `"SEPARATE_BOOKINGS"` Not supported yet.
|
|
1119
|
-
* - `"PARALLEL_BOOKINGS"` Not supported yet.
|
|
1120
|
-
*/
|
|
1121
|
-
multiServiceBookingType?: MultiServiceBookingType;
|
|
1122
|
-
}
|
|
1123
|
-
export interface MarkAsMultiServiceBookingResponse {
|
|
1124
|
-
/** Multi service booking ID. */
|
|
1125
|
-
multiServiceBookingId?: string | null;
|
|
1126
|
-
}
|
|
1127
|
-
export interface GetMultiServiceBookingRequest {
|
|
1128
|
-
/** Multi service booking ID. */
|
|
1129
|
-
multiServiceBookingId?: string | null;
|
|
1130
|
-
}
|
|
1131
|
-
export interface GetMultiServiceBookingResponse {
|
|
1132
|
-
/** Multi service booking. */
|
|
1133
|
-
multiServiceBooking?: MultiServiceBooking;
|
|
1134
|
-
metadata?: MultiServiceBookingMetadata;
|
|
1135
|
-
}
|
|
1136
|
-
export interface MultiServiceBookingMetadata {
|
|
1137
|
-
/**
|
|
1138
|
-
* Total number of the scheduled bookings within the multi service booking, including bookings which were not retrieved due to lack of read permissions.
|
|
1139
|
-
* Scheduled bookings are bookings with status CONFIRMED or PENDING.
|
|
1140
|
-
*/
|
|
1141
|
-
totalNumberOfScheduledBookings?: number | null;
|
|
1142
|
-
}
|
|
1143
|
-
export interface AddBookingsToMultiServiceBookingRequest {
|
|
1144
|
-
/** ID of the multi service booking. */
|
|
1145
|
-
multiServiceBookingId?: string | null;
|
|
1146
|
-
/** List of bookings ids and their revisions to add to the multi service booking. */
|
|
1147
|
-
bookings?: BookingIdAndRevision[];
|
|
1148
|
-
/** Whether to return the bookings entities. */
|
|
1149
|
-
returnFullEntity?: boolean;
|
|
1150
|
-
}
|
|
1151
|
-
export interface BookingIdAndRevision {
|
|
1152
|
-
/** ID of the booking. */
|
|
1153
|
-
bookingId?: string | null;
|
|
1154
|
-
/**
|
|
1155
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1156
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1157
|
-
* managing the booking.
|
|
1158
|
-
*/
|
|
1159
|
-
revision?: string | null;
|
|
1160
|
-
}
|
|
1161
|
-
export interface AddBookingsToMultiServiceBookingResponse {
|
|
1162
|
-
/** The bookings that were added to the multi service booking. */
|
|
1163
|
-
bookings?: BookingResult[];
|
|
1164
|
-
}
|
|
1165
|
-
export interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
1166
|
-
/** ID of the multi service booking. */
|
|
1167
|
-
multiServiceBookingId?: string | null;
|
|
1168
|
-
/** List of bookings ids and their revisions to remove from the multi service booking. */
|
|
1169
|
-
bookings?: BookingIdAndRevision[];
|
|
1170
|
-
/** Whether to return the bookings entities. */
|
|
1171
|
-
returnFullEntity?: boolean;
|
|
1172
|
-
}
|
|
1173
|
-
export interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
1174
|
-
/** The bookings that were removed from the multi service booking. */
|
|
1175
|
-
bookings?: BookingResult[];
|
|
1176
|
-
}
|
|
1177
|
-
export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
|
|
1178
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
1179
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
1180
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
1181
|
-
actionEvent?: ActionEvent<T>;
|
|
1182
|
-
/**
|
|
1183
|
-
* Unique event ID.
|
|
1184
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1185
|
-
*/
|
|
1186
|
-
_id?: string;
|
|
1187
|
-
/**
|
|
1188
|
-
* Assumes actions are also always typed to an entity_type
|
|
1189
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1190
|
-
*/
|
|
1191
|
-
entityFqdn?: string;
|
|
1192
|
-
/**
|
|
1193
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1194
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1195
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1196
|
-
*/
|
|
1197
|
-
slug?: string;
|
|
1198
|
-
/** ID of the entity associated with the event. */
|
|
1199
|
-
entityId?: string;
|
|
1200
|
-
/** Event timestamp. */
|
|
1201
|
-
eventTime?: Date;
|
|
1202
|
-
/**
|
|
1203
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1204
|
-
* (for example, GDPR).
|
|
1205
|
-
*/
|
|
1206
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1207
|
-
/** If present, indicates the action that triggered the event. */
|
|
1208
|
-
originatedFrom?: string | null;
|
|
1209
|
-
/**
|
|
1210
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1211
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1212
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1213
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1214
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1215
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1216
|
-
*/
|
|
1217
|
-
entityEventSequence?: string | null;
|
|
1218
|
-
}
|
|
1219
|
-
export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
1220
|
-
}
|
|
1221
|
-
export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
1222
|
-
}
|
|
1223
|
-
export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
|
|
1224
|
-
}
|
|
1225
|
-
export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
|
|
1226
|
-
}
|
|
1227
|
-
/** @oneof */
|
|
1228
|
-
export interface DomainEventBodyOneOf<T> {
|
|
1229
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
1230
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
1231
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
1232
|
-
actionEvent?: ActionEvent<T>;
|
|
1233
|
-
}
|
|
1234
|
-
export interface EntityCreatedEvent<T> {
|
|
1235
|
-
entity?: T;
|
|
1236
|
-
}
|
|
1237
|
-
export interface EntityUpdatedEvent<T> {
|
|
1238
|
-
/**
|
|
1239
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1240
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1241
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1242
|
-
*/
|
|
1243
|
-
currentEntity?: T;
|
|
1244
|
-
}
|
|
1245
|
-
export interface EntityDeletedEvent<T> {
|
|
1246
|
-
/** Entity that was deleted */
|
|
1247
|
-
deletedEntity?: T | null;
|
|
1248
|
-
}
|
|
1249
|
-
export interface ActionEvent<T> {
|
|
1250
|
-
body?: T;
|
|
1251
|
-
}
|
|
1252
|
-
export interface BookingChanged {
|
|
1253
|
-
/** The booking before the changes. */
|
|
1254
|
-
previousBooking?: Booking;
|
|
1255
|
-
/** The booking after the changes. */
|
|
1256
|
-
currentBooking?: Booking;
|
|
1257
|
-
}
|
|
1258
|
-
export interface CreateBookingRequest {
|
|
1259
|
-
/** The booking to create. */
|
|
1260
|
-
booking: Booking;
|
|
1261
|
-
/** Information about a message to send to the customer. */
|
|
1262
|
-
participantNotification?: ParticipantNotification;
|
|
1263
|
-
/**
|
|
1264
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1265
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1266
|
-
* Default: `true`.
|
|
1267
|
-
*/
|
|
1268
|
-
sendSmsReminder?: boolean | null;
|
|
1269
|
-
/**
|
|
1270
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1271
|
-
* creation flow are changed. For example, whether the availability is
|
|
1272
|
-
* checked before creating the booking or if additional payment options are
|
|
1273
|
-
* accepted.
|
|
1274
|
-
*/
|
|
1275
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1276
|
-
}
|
|
1277
|
-
export interface CreateBookingResponse {
|
|
1278
|
-
/** Created booking. */
|
|
1279
|
-
booking?: Booking;
|
|
1280
|
-
}
|
|
1281
|
-
/**
|
|
1282
|
-
* The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1283
|
-
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1284
|
-
*/
|
|
1285
|
-
export interface UpdateBookingRequest {
|
|
1286
|
-
booking?: Booking;
|
|
1287
|
-
}
|
|
1288
|
-
export interface UpdateBookingResponse {
|
|
1289
|
-
booking?: Booking;
|
|
1290
|
-
}
|
|
1291
|
-
export interface LegacyCreateBookingRequest {
|
|
1292
|
-
booking?: Booking;
|
|
1293
|
-
}
|
|
1294
|
-
export interface LegacyCreateBookingResponse {
|
|
1295
|
-
booking?: Booking;
|
|
1296
|
-
}
|
|
1297
|
-
/**
|
|
1298
|
-
* The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
|
|
1299
|
-
* in an error. `participantsInfo` is preferred over `numberOfParticipants`.
|
|
1300
|
-
*/
|
|
1301
|
-
export interface BulkUpdateBookingRequest {
|
|
1302
|
-
bookings?: MaskedBooking[];
|
|
1303
|
-
}
|
|
1304
|
-
export interface MaskedBooking {
|
|
1305
|
-
booking?: Booking;
|
|
1306
|
-
}
|
|
1307
|
-
export interface BulkUpdateBookingResponse {
|
|
1308
|
-
results?: ItemMetadata[];
|
|
1309
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1310
|
-
}
|
|
1311
|
-
export interface BulkCreateBookingRequest {
|
|
1312
|
-
/**
|
|
1313
|
-
* Bookings to create.
|
|
1314
|
-
* Max: 8 bookings.
|
|
1315
|
-
*/
|
|
1316
|
-
createBookingsInfo: CreateBookingInfo[];
|
|
1317
|
-
/** Whether to return the created bookings entities. */
|
|
1318
|
-
returnFullEntity?: boolean;
|
|
1319
|
-
}
|
|
1320
|
-
export interface CreateBookingInfo {
|
|
1321
|
-
/** The booking to create */
|
|
1322
|
-
booking?: Booking;
|
|
1323
|
-
/** Information about a message to send to the customer. */
|
|
1324
|
-
participantNotification?: ParticipantNotification;
|
|
1325
|
-
/**
|
|
1326
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1327
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1328
|
-
* Default: `true`.
|
|
1329
|
-
*/
|
|
1330
|
-
sendSmsReminder?: boolean | null;
|
|
1331
|
-
/**
|
|
1332
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1333
|
-
* creation flow are changed. For example, whether the availability is
|
|
1334
|
-
* checked before creating the booking or if additional payment options are
|
|
1335
|
-
* accepted.
|
|
1336
|
-
*/
|
|
1337
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1338
|
-
}
|
|
1339
|
-
export interface BulkCreateBookingResponse {
|
|
1340
|
-
/**
|
|
1341
|
-
* Bulk create booking results.
|
|
1342
|
-
* Whether it successfully created each booking, providing the corresponding error message if a failure occurred, and includes the created booking entity if the `returnFullEntity` is `true`.
|
|
1343
|
-
*/
|
|
1344
|
-
results?: BulkBookingResult[];
|
|
1345
|
-
/** Total successes and failures of the bulk create booking action. */
|
|
1346
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1347
|
-
}
|
|
1348
|
-
export interface BulkBookingResult {
|
|
1349
|
-
itemMetadata?: ItemMetadata;
|
|
1350
|
-
item?: Booking;
|
|
1351
|
-
}
|
|
1352
|
-
export interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1353
|
-
/**
|
|
1354
|
-
* Total number of participants. Available only for services with
|
|
1355
|
-
* variants.
|
|
1356
|
-
* Pass when all participants book the same variant.
|
|
1357
|
-
*/
|
|
1358
|
-
totalParticipants?: number;
|
|
1359
|
-
/**
|
|
1360
|
-
* Information about the service choices to book. Available only for services with
|
|
1361
|
-
* variants.
|
|
1362
|
-
* Pass when not all participants book the same variant.
|
|
1363
|
-
*/
|
|
1364
|
-
participantsChoices?: ParticipantChoices;
|
|
1365
|
-
/** ID of the booking to reschedule. */
|
|
1366
|
-
bookingId: string;
|
|
1367
|
-
/** Information about the new slot. */
|
|
1368
|
-
slot: V2Slot;
|
|
1369
|
-
/**
|
|
1370
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1371
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1372
|
-
* managing the booking.
|
|
1373
|
-
*/
|
|
1374
|
-
revision: string | null;
|
|
1375
|
-
/**
|
|
1376
|
-
* Information about whether to notify the customer about the rescheduling and
|
|
1377
|
-
* the message to send.
|
|
1378
|
-
*/
|
|
1379
|
-
participantNotification?: ParticipantNotification;
|
|
1380
|
-
/**
|
|
1381
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1382
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
1383
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
1384
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
1385
|
-
*/
|
|
1386
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
1387
|
-
}
|
|
1388
|
-
/** @oneof */
|
|
1389
|
-
export interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
1390
|
-
/**
|
|
1391
|
-
* Total number of participants. Available only for services with
|
|
1392
|
-
* variants.
|
|
1393
|
-
* Pass when all participants book the same variant.
|
|
1394
|
-
*/
|
|
1395
|
-
totalParticipants?: number;
|
|
1396
|
-
/**
|
|
1397
|
-
* Information about the service choices to book. Available only for services with
|
|
1398
|
-
* variants.
|
|
1399
|
-
* Pass when not all participants book the same variant.
|
|
1400
|
-
*/
|
|
1401
|
-
participantsChoices?: ParticipantChoices;
|
|
1402
|
-
}
|
|
1403
|
-
export interface RescheduleBookingResponse {
|
|
1404
|
-
/** Rescheduled booking. */
|
|
1405
|
-
booking?: Booking;
|
|
1406
|
-
}
|
|
1407
|
-
export interface BulkRescheduleBookingRequest {
|
|
1408
|
-
/** Reschedule multiple bookings to multiple slots. */
|
|
1409
|
-
slotsBookings?: SlotBookings[];
|
|
1410
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
1411
|
-
participantNotification?: ParticipantNotification;
|
|
1412
|
-
}
|
|
1413
|
-
export interface BulkRescheduleBookingRequestBooking {
|
|
1414
|
-
/** ID of the bookings to be rescheduled. */
|
|
1415
|
-
_id?: string;
|
|
1416
|
-
revision?: string | null;
|
|
1417
|
-
}
|
|
1418
|
-
/** Bookings to be rescheduled to the given slot. */
|
|
1419
|
-
export interface SlotBookings {
|
|
1420
|
-
/** The bookings details. */
|
|
1421
|
-
bookings?: BulkRescheduleBookingRequestBooking[];
|
|
1422
|
-
/**
|
|
1423
|
-
* The slot to which the bookings were rescheduled.
|
|
1424
|
-
* This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.
|
|
1425
|
-
*/
|
|
1426
|
-
slot?: BookedSlot;
|
|
1427
|
-
}
|
|
1428
|
-
export interface BulkRescheduleBookingResponse {
|
|
1429
|
-
/** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */
|
|
1430
|
-
results?: ItemMetadata[];
|
|
1431
|
-
/** Total successes and failures of the bulk reschedule action. */
|
|
1432
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1433
|
-
}
|
|
1434
|
-
/** Update the booked schedule of multiple bookings to the given schedule. */
|
|
1435
|
-
export interface BulkUpdateBookedScheduleRequest {
|
|
1436
|
-
/** The bookings whose booked schedule is to be updated to the given schedule. */
|
|
1437
|
-
bookings?: BookingDetails[];
|
|
1438
|
-
/** The ID of the schedule to be updated. */
|
|
1439
|
-
scheduleId?: string;
|
|
1440
|
-
/** Whether to notify participants about the change and an optional custom message. */
|
|
1441
|
-
participantNotification?: ParticipantNotification;
|
|
1442
|
-
}
|
|
1443
|
-
export interface BookingDetails {
|
|
1444
|
-
/** ID of the bookings to be updated. */
|
|
1445
|
-
_id?: string;
|
|
1446
|
-
revision?: string | null;
|
|
1447
|
-
}
|
|
1448
|
-
export interface BulkUpdateBookedScheduleResponse {
|
|
1449
|
-
/** The bulk update results. For each booking, the results contain the metadata of the update action. */
|
|
1450
|
-
results?: ItemMetadata[];
|
|
1451
|
-
/** Total successes and failures of the bulk update action. */
|
|
1452
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1453
|
-
}
|
|
1454
|
-
export interface QueryBookingsRequest {
|
|
1455
|
-
query?: QueryV2;
|
|
1456
|
-
}
|
|
1457
|
-
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1458
|
-
/** Paging options to limit and skip the number of items. */
|
|
1459
|
-
paging?: Paging;
|
|
1460
|
-
/** 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`. */
|
|
1461
|
-
cursorPaging?: CursorPaging;
|
|
1462
|
-
/**
|
|
1463
|
-
* Filter object in the following format:
|
|
1464
|
-
* `"filter" : {
|
|
1465
|
-
* "fieldName1": "value1",
|
|
1466
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1467
|
-
* }`
|
|
1468
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1469
|
-
*/
|
|
1470
|
-
filter?: Record<string, any> | null;
|
|
1471
|
-
/**
|
|
1472
|
-
* Sort object in the following format:
|
|
1473
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1474
|
-
*/
|
|
1475
|
-
sort?: Sorting[];
|
|
1476
|
-
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1477
|
-
fields?: string[];
|
|
1478
|
-
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1479
|
-
fieldsets?: string[];
|
|
1480
|
-
}
|
|
1481
|
-
/** @oneof */
|
|
1482
|
-
export interface QueryV2PagingMethodOneOf {
|
|
1483
|
-
/** Paging options to limit and skip the number of items. */
|
|
1484
|
-
paging?: Paging;
|
|
1485
|
-
/** 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`. */
|
|
1486
|
-
cursorPaging?: CursorPaging;
|
|
1487
|
-
}
|
|
1488
|
-
export interface Sorting {
|
|
1489
|
-
/** Name of the field to sort by. */
|
|
1490
|
-
fieldName?: string;
|
|
1491
|
-
/** Sort order. */
|
|
1492
|
-
order?: SortOrder;
|
|
1493
|
-
}
|
|
1494
|
-
export declare enum SortOrder {
|
|
1495
|
-
ASC = "ASC",
|
|
1496
|
-
DESC = "DESC"
|
|
1497
|
-
}
|
|
1498
|
-
export interface Paging {
|
|
1499
|
-
/** Number of items to load. */
|
|
1500
|
-
limit?: number | null;
|
|
1501
|
-
/** Number of items to skip in the current sort order. */
|
|
1502
|
-
offset?: number | null;
|
|
1503
|
-
}
|
|
1504
|
-
export interface CursorPaging {
|
|
1505
|
-
/** Maximum number of items to return in the results. */
|
|
1506
|
-
limit?: number | null;
|
|
1507
|
-
/**
|
|
1508
|
-
* Pointer to the next or previous page in the list of results.
|
|
1509
|
-
*
|
|
1510
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1511
|
-
* Not relevant for the first request.
|
|
1512
|
-
*/
|
|
1513
|
-
cursor?: string | null;
|
|
1514
|
-
}
|
|
1515
|
-
export interface QueryBookingsResponse {
|
|
1516
|
-
bookings?: Booking[];
|
|
1517
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1518
|
-
}
|
|
1519
|
-
export interface PagingMetadataV2 {
|
|
1520
|
-
/** Number of items returned in the response. */
|
|
1521
|
-
count?: number | null;
|
|
1522
|
-
/** Offset that was requested. */
|
|
1523
|
-
offset?: number | null;
|
|
1524
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1525
|
-
total?: number | null;
|
|
1526
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1527
|
-
tooManyToCount?: boolean | null;
|
|
1528
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1529
|
-
cursors?: Cursors;
|
|
1530
|
-
}
|
|
1531
|
-
export interface Cursors {
|
|
1532
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
1533
|
-
next?: string | null;
|
|
1534
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
1535
|
-
prev?: string | null;
|
|
1536
|
-
}
|
|
1537
|
-
export interface ConfirmRequest {
|
|
1538
|
-
/** ID of the booking to be confirmed. */
|
|
1539
|
-
_id?: string;
|
|
1540
|
-
/** Whether to notify the participants about the booking confirmation, and an optional custom message. */
|
|
1541
|
-
participantNotification?: ParticipantNotification;
|
|
1542
|
-
}
|
|
1543
|
-
export interface ConfirmResponse {
|
|
1544
|
-
/** Confirmed booking. */
|
|
1545
|
-
booking?: Booking;
|
|
1546
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1547
|
-
doubleBooked?: boolean | null;
|
|
1548
|
-
}
|
|
1549
|
-
export interface ConfirmBookingRequest {
|
|
1550
|
-
/** ID of the booking to confirm. */
|
|
1551
|
-
bookingId: string;
|
|
1552
|
-
/**
|
|
1553
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1554
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1555
|
-
* managing the booking.
|
|
1556
|
-
*/
|
|
1557
|
-
revision: string | null;
|
|
1558
|
-
/**
|
|
1559
|
-
* Information about whether to notify the customer about the confirmation and
|
|
1560
|
-
* the message to send.
|
|
1561
|
-
*/
|
|
1562
|
-
participantNotification?: ParticipantNotification;
|
|
1563
|
-
/**
|
|
1564
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1565
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1566
|
-
*/
|
|
1567
|
-
sendSmsReminder?: boolean | null;
|
|
1568
|
-
/**
|
|
1569
|
-
* Payment status to set for the booking.
|
|
1570
|
-
* One of:
|
|
1571
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
1572
|
-
* - `"PAID"` The booking is fully paid.
|
|
1573
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
1574
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
1575
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
1576
|
-
*/
|
|
1577
|
-
paymentStatus?: PaymentStatus;
|
|
1578
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1579
|
-
doubleBooked?: boolean | null;
|
|
1580
|
-
/**
|
|
1581
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1582
|
-
* creation flow are changed. For example, whether the availability is
|
|
1583
|
-
* checked before confirming the booking.
|
|
1584
|
-
*/
|
|
1585
|
-
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
1586
|
-
}
|
|
1587
|
-
export interface ConfirmBookingResponse {
|
|
1588
|
-
booking?: Booking;
|
|
1589
|
-
}
|
|
1590
|
-
export interface PartySizeRequest extends PartySizeRequestPartySizeForOneOf {
|
|
1591
|
-
sessionId?: string | null;
|
|
1592
|
-
scheduleId?: string | null;
|
|
1593
|
-
}
|
|
1594
|
-
/** @oneof */
|
|
1595
|
-
export interface PartySizeRequestPartySizeForOneOf {
|
|
1596
|
-
sessionId?: string | null;
|
|
1597
|
-
scheduleId?: string | null;
|
|
1598
|
-
}
|
|
1599
|
-
export interface PartySizeResponse {
|
|
1600
|
-
partySize?: number | null;
|
|
1601
|
-
}
|
|
1602
|
-
export interface ConsistentQueryBookingsRequest {
|
|
1603
|
-
query?: QueryV2;
|
|
1604
|
-
}
|
|
1605
|
-
export interface ConsistentQueryBookingsResponse {
|
|
1606
|
-
bookings?: Booking[];
|
|
1607
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1608
|
-
}
|
|
1609
|
-
export interface SetBookingSessionIdRequest {
|
|
1610
|
-
/** ID of the booking to set its sessionId. */
|
|
1611
|
-
_id?: string;
|
|
1612
|
-
/** The sessionId to be set. */
|
|
1613
|
-
sessionId?: string;
|
|
1614
|
-
}
|
|
1615
|
-
export interface SetBookingSessionIdResponse {
|
|
1616
|
-
/** The updated booking. */
|
|
1617
|
-
booking?: Booking;
|
|
1618
|
-
}
|
|
1619
|
-
export interface UpdateExtendedFieldsRequest {
|
|
1620
|
-
/** ID of the entity to update. */
|
|
1621
|
-
_id: string;
|
|
1622
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
1623
|
-
namespace: string;
|
|
1624
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
1625
|
-
namespaceData: Record<string, any> | null;
|
|
1626
|
-
}
|
|
1627
|
-
export interface UpdateExtendedFieldsResponse {
|
|
1628
|
-
/** Identifier for the app whose extended field data was updated. */
|
|
1629
|
-
namespace?: string;
|
|
1630
|
-
/** Updated data. */
|
|
1631
|
-
namespaceData?: Record<string, any> | null;
|
|
1632
|
-
}
|
|
1633
|
-
export interface DeclineBookingRequest {
|
|
1634
|
-
/** ID of the booking to decline. */
|
|
1635
|
-
bookingId: string;
|
|
1636
|
-
/**
|
|
1637
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1638
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1639
|
-
* managing the booking.
|
|
1640
|
-
*/
|
|
1641
|
-
revision: string | null;
|
|
1642
|
-
/**
|
|
1643
|
-
* Information about whether to notify the customer about the decline and
|
|
1644
|
-
* the message to send.
|
|
1645
|
-
*/
|
|
1646
|
-
participantNotification?: ParticipantNotification;
|
|
1647
|
-
/**
|
|
1648
|
-
* Payment status to set on the booking.
|
|
1649
|
-
* One of:
|
|
1650
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
1651
|
-
* - `"PAID"` The booking is fully paid.
|
|
1652
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
1653
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
1654
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
1655
|
-
*/
|
|
1656
|
-
paymentStatus?: PaymentStatus;
|
|
1657
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1658
|
-
doubleBooked?: boolean | null;
|
|
1659
|
-
}
|
|
1660
|
-
export interface DeclineBookingResponse {
|
|
1661
|
-
/** eclined booking */
|
|
1662
|
-
booking?: Booking;
|
|
1663
|
-
}
|
|
1664
|
-
export interface CancelBookingRequest {
|
|
1665
|
-
/** ID of the booking to cancel. */
|
|
1666
|
-
bookingId: string;
|
|
1667
|
-
/**
|
|
1668
|
-
* Information about whether to notify the customer about the cancelation and
|
|
1669
|
-
* the message to send.
|
|
1670
|
-
*/
|
|
1671
|
-
participantNotification?: ParticipantNotification;
|
|
1672
|
-
/**
|
|
1673
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1674
|
-
* cancelation flow are changed. For example, whether the you can cancel
|
|
1675
|
-
* a booking even though the cancelation policy doesn't allow it or whether
|
|
1676
|
-
* to issue a refund.
|
|
1677
|
-
*/
|
|
1678
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1679
|
-
/**
|
|
1680
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1681
|
-
* To prevent conflicting changes,
|
|
1682
|
-
* the current revision must be passed when managing the booking.
|
|
1683
|
-
*/
|
|
1684
|
-
revision: string | null;
|
|
1685
|
-
}
|
|
1686
|
-
export interface CancelBookingResponse {
|
|
1687
|
-
/** Canceled booking. */
|
|
1688
|
-
booking?: Booking;
|
|
1689
|
-
}
|
|
1690
|
-
export interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1691
|
-
/**
|
|
1692
|
-
* Total number of participants. Available only for services with
|
|
1693
|
-
* variants.
|
|
1694
|
-
* Pass when all participants book the same variant.
|
|
1695
|
-
*/
|
|
1696
|
-
totalParticipants?: number;
|
|
1697
|
-
/**
|
|
1698
|
-
* Information about the service choices to book. Available only for services with
|
|
1699
|
-
* variants.
|
|
1700
|
-
* Pass when not all participants book the same variant.
|
|
1701
|
-
*/
|
|
1702
|
-
participantsChoices?: ParticipantChoices;
|
|
1703
|
-
/** ID of the booking to update the number of participants for. */
|
|
1704
|
-
bookingId: string;
|
|
1705
|
-
/**
|
|
1706
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1707
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1708
|
-
* managing the booking.
|
|
1709
|
-
*/
|
|
1710
|
-
revision: string | null;
|
|
1711
|
-
}
|
|
1712
|
-
/** @oneof */
|
|
1713
|
-
export interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1714
|
-
/**
|
|
1715
|
-
* Total number of participants. Available only for services with
|
|
1716
|
-
* variants.
|
|
1717
|
-
* Pass when all participants book the same variant.
|
|
1718
|
-
*/
|
|
1719
|
-
totalParticipants?: number;
|
|
1720
|
-
/**
|
|
1721
|
-
* Information about the service choices to book. Available only for services with
|
|
1722
|
-
* variants.
|
|
1723
|
-
* Pass when not all participants book the same variant.
|
|
1724
|
-
*/
|
|
1725
|
-
participantsChoices?: ParticipantChoices;
|
|
1726
|
-
}
|
|
1727
|
-
export interface UpdateNumberOfParticipantsResponse {
|
|
1728
|
-
/** Booking with updated number of participants. */
|
|
1729
|
-
booking?: Booking;
|
|
1730
|
-
}
|
|
1731
|
-
export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
1732
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
1733
|
-
previousTotalParticipants?: number;
|
|
1734
|
-
/**
|
|
1735
|
-
* Information about the previous booked service choices and participants.
|
|
1736
|
-
* Available only when the booking includes multiple service variants.
|
|
1737
|
-
*/
|
|
1738
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
1739
|
-
/** The updated booking object. */
|
|
1740
|
-
booking?: Booking;
|
|
1741
|
-
/** ID of the participant number update initiator. */
|
|
1742
|
-
initiatedBy?: IdentificationData;
|
|
1743
|
-
}
|
|
1744
|
-
/** @oneof */
|
|
1745
|
-
export interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {
|
|
1746
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
1747
|
-
previousTotalParticipants?: number;
|
|
1748
|
-
/**
|
|
1749
|
-
* Information about the previous booked service choices and participants.
|
|
1750
|
-
* Available only when the booking includes multiple service variants.
|
|
1751
|
-
*/
|
|
1752
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
1753
|
-
}
|
|
1754
|
-
export interface CalculateAllowedActionsRequest {
|
|
1755
|
-
/** The booking id that we want to calculate the allowedActions for */
|
|
1756
|
-
bookingId?: string | null;
|
|
1757
|
-
}
|
|
1758
|
-
export interface CalculateAllowedActionsResponse {
|
|
1759
|
-
allowedActions?: AllowedActions;
|
|
1760
|
-
}
|
|
1761
|
-
export interface BulkCalculateAllowedActionsRequest {
|
|
1762
|
-
/** The booking id's that we want to calculate the allowedActions for */
|
|
1763
|
-
bookingIds?: string[] | null;
|
|
1764
|
-
}
|
|
1765
|
-
export interface BulkCalculateAllowedActionsResponse {
|
|
1766
|
-
results?: BulkCalculateAllowedActionsResult[];
|
|
1767
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1768
|
-
}
|
|
1769
|
-
export interface GetSlotAvailabilityRequest {
|
|
1770
|
-
/** The slot for which the availability is checked. */
|
|
1771
|
-
slot?: V2Slot;
|
|
1772
|
-
/** The timezone for which availability is to be calculated. */
|
|
1773
|
-
timezone?: string | null;
|
|
1774
|
-
}
|
|
1775
|
-
export interface GetSlotAvailabilityResponse {
|
|
1776
|
-
availability?: SlotAvailability;
|
|
1777
|
-
bookingPolicySettings?: BookingPolicySettings;
|
|
1778
|
-
}
|
|
1779
|
-
export interface SlotAvailability {
|
|
1780
|
-
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
1781
|
-
slot?: V2Slot;
|
|
1782
|
-
/** Whether this available slot is bookable. */
|
|
1783
|
-
bookable?: boolean;
|
|
1784
|
-
/**
|
|
1785
|
-
* Total number of spots for this availability.
|
|
1786
|
-
* For example, for a class of 10 spots with 3 spots booked, `spotsTotal` is 10, `openSpots` is 7.
|
|
1787
|
-
*/
|
|
1788
|
-
totalSpots?: number | null;
|
|
1789
|
-
/**
|
|
1790
|
-
* Number of open spots for this availability.
|
|
1791
|
-
* For appointment if there are existing bookings with overlapping time, service & resource, `openSpots` is 0, otherwise `openSpots` is 1.
|
|
1792
|
-
*/
|
|
1793
|
-
openSpots?: number | null;
|
|
1794
|
-
/** An object describing the slot's waiting-list and its occupancy. */
|
|
1795
|
-
waitingList?: WaitingList;
|
|
1796
|
-
/** Indicators for booking policy violations for the slot. */
|
|
1797
|
-
bookingPolicyViolations?: BookingPolicyViolations;
|
|
1798
|
-
/** Indicates whether this slot is locked. */
|
|
1799
|
-
locked?: boolean | null;
|
|
1800
|
-
}
|
|
1801
|
-
export interface WaitingList {
|
|
1802
|
-
/**
|
|
1803
|
-
* Total number of spots and open spots for this waiting list.
|
|
1804
|
-
* For example, a Yoga class of 10 waiting list spots with 3 registered on the waiting list has total_spots: 10 and open_spots: 7.
|
|
1805
|
-
*/
|
|
1806
|
-
totalSpots?: number | null;
|
|
1807
|
-
openSpots?: number | null;
|
|
1808
|
-
}
|
|
1809
|
-
export interface AvailableResources {
|
|
1810
|
-
/** Resource type ID. */
|
|
1811
|
-
resourceTypeId?: string | null;
|
|
1812
|
-
/**
|
|
1813
|
-
* Available resources for the slot.
|
|
1814
|
-
* maxSize defined by 135 staff members + 3 resource types and 50 resources per type.
|
|
1815
|
-
* Availability-2 currently have no maxSize defined.
|
|
1816
|
-
*/
|
|
1817
|
-
resourceIds?: string[];
|
|
1818
|
-
}
|
|
1819
|
-
export interface GetScheduleAvailabilityRequest {
|
|
1820
|
-
/** The schedule ID for which availability is checked. */
|
|
1821
|
-
scheduleId?: string;
|
|
1822
|
-
}
|
|
1823
|
-
export interface GetScheduleAvailabilityResponse {
|
|
1824
|
-
availability?: ScheduleAvailability;
|
|
1825
|
-
bookingPolicySettings?: BookingPolicySettings;
|
|
1826
|
-
}
|
|
1827
|
-
export interface ScheduleAvailability {
|
|
1828
|
-
totalSpots?: number | null;
|
|
1829
|
-
openSpots?: number | null;
|
|
1830
|
-
/** Indicators of booking policy violations for the given Schedule. */
|
|
1831
|
-
bookingPolicyViolations?: BookingPolicyViolations;
|
|
1832
|
-
}
|
|
1833
|
-
export interface MarkBookingAsPendingRequest {
|
|
1834
|
-
/** ID of the booking to mark as PENDING. */
|
|
1835
|
-
bookingId?: string;
|
|
1836
|
-
/**
|
|
1837
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1838
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1839
|
-
* managing the booking.
|
|
1840
|
-
*/
|
|
1841
|
-
revision?: string | null;
|
|
1842
|
-
/**
|
|
1843
|
-
* Information about whether to notify the customer and
|
|
1844
|
-
* the message to send.
|
|
1845
|
-
*/
|
|
1846
|
-
participantNotification?: ParticipantNotification;
|
|
1847
|
-
/**
|
|
1848
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1849
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1850
|
-
*/
|
|
1851
|
-
sendSmsReminder?: boolean | null;
|
|
1852
|
-
/**
|
|
1853
|
-
* Payment status to set for the booking.
|
|
1854
|
-
* One of:
|
|
1855
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
1856
|
-
* - `"PAID"` The booking is fully paid.
|
|
1857
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
1858
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
1859
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
1860
|
-
*/
|
|
1861
|
-
paymentStatus?: PaymentStatus;
|
|
1862
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1863
|
-
doubleBooked?: boolean | null;
|
|
1864
|
-
/**
|
|
1865
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1866
|
-
* creation flow are changed. For example, whether the availability is
|
|
1867
|
-
* checked before updating the booking's status.
|
|
1868
|
-
*/
|
|
1869
|
-
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
1870
|
-
}
|
|
1871
|
-
export interface MarkBookingAsPendingResponse {
|
|
1872
|
-
/** The updated booking */
|
|
1873
|
-
booking?: Booking;
|
|
1874
|
-
}
|
|
1875
|
-
export interface BookingMarkedAsPending {
|
|
1876
|
-
/** The booking object that was marked as pending. */
|
|
1877
|
-
booking?: Booking;
|
|
1878
|
-
/** Information about whether to notify the customer upon manual confirmation of the pending booking and the message to send. */
|
|
1879
|
-
participantNotification?: ParticipantNotification;
|
|
1880
|
-
/**
|
|
1881
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1882
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1883
|
-
*/
|
|
1884
|
-
sendSmsReminder?: boolean | null;
|
|
1885
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1886
|
-
doubleBooked?: boolean | null;
|
|
1887
|
-
/** ID of the mark as pending initiator. */
|
|
1888
|
-
initiatedBy?: IdentificationData;
|
|
1889
|
-
/** The previous status of the booking. */
|
|
1890
|
-
previousStatus?: BookingStatus;
|
|
1891
|
-
/** The previous payment status of the booking. */
|
|
1892
|
-
previousPaymentStatus?: PaymentStatus;
|
|
1893
|
-
}
|
|
1894
|
-
export interface MigrationCheckIfClashesWithBlockedTimeRequest {
|
|
1895
|
-
msidAndBookingIds?: MsidAndBookingId[];
|
|
1896
|
-
}
|
|
1897
|
-
export interface MsidAndBookingId {
|
|
1898
|
-
msid?: string;
|
|
1899
|
-
bookingId?: string;
|
|
1900
|
-
}
|
|
1901
|
-
export interface MigrationCheckIfClashesWithBlockedTimeResponse {
|
|
1902
|
-
clashes?: Clash[];
|
|
1903
|
-
}
|
|
1904
|
-
export interface Clash {
|
|
1905
|
-
msid?: string;
|
|
1906
|
-
bookingId?: string;
|
|
1907
|
-
sessionId?: string;
|
|
1908
|
-
resourceName?: string;
|
|
1909
|
-
contactName?: string;
|
|
1910
|
-
}
|
|
1911
|
-
export interface ConfirmOrDeclineBookingRequest {
|
|
1912
|
-
/** ID of the booking to confirm or decline. */
|
|
1913
|
-
bookingId: string;
|
|
1914
|
-
/** Current payment status of the booking. */
|
|
1915
|
-
paymentStatus?: PaymentStatus;
|
|
1916
|
-
}
|
|
1917
|
-
export interface ConfirmOrDeclineBookingResponse {
|
|
1918
|
-
booking?: Booking;
|
|
1919
|
-
}
|
|
1920
|
-
export interface BulkConfirmOrDeclineBookingRequest {
|
|
1921
|
-
/** The bookings to confirm or decline. */
|
|
1922
|
-
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
1923
|
-
/**
|
|
1924
|
-
* Whether to return the confirmed or declined bookings entities.
|
|
1925
|
-
* Not supported yet, currently the entity is not returned.
|
|
1926
|
-
*/
|
|
1927
|
-
returnEntity?: boolean;
|
|
1928
|
-
}
|
|
1929
|
-
export interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
1930
|
-
/** ID of the booking to confirm or decline. */
|
|
1931
|
-
bookingId?: string;
|
|
1932
|
-
/** Current payment status of the booking. */
|
|
1933
|
-
paymentStatus?: PaymentStatus;
|
|
1934
|
-
}
|
|
1935
|
-
export interface BulkConfirmOrDeclineBookingResponse {
|
|
1936
|
-
/**
|
|
1937
|
-
* The bulk confirm or decline results.
|
|
1938
|
-
* For each booking, the results contain the metadata of the confirm or decline action.
|
|
1939
|
-
*/
|
|
1940
|
-
results?: BulkBookingResult[];
|
|
1941
|
-
/** Total successes and failures of the bulk confirm or decline action. */
|
|
1942
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1943
|
-
}
|
|
1944
|
-
export interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {
|
|
1945
|
-
/**
|
|
1946
|
-
* Information about the slot to create a booking for.
|
|
1947
|
-
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
1948
|
-
* location is set to `slot.location.formattedAddress` when provided.
|
|
1949
|
-
* Otherwise it's set to `contactDetails.fullAddress.formattedAddress`.
|
|
1950
|
-
*/
|
|
1951
|
-
slot?: Slot;
|
|
1952
|
-
/** Information about the schedule to create a booking for. */
|
|
1953
|
-
schedule?: BookedSchedule;
|
|
1954
|
-
/** Contact details of the customer booking the service. */
|
|
1955
|
-
contactDetails?: ContactDetails;
|
|
1956
|
-
/**
|
|
1957
|
-
* Booking status.
|
|
1958
|
-
* One of:
|
|
1959
|
-
* - `"CREATED"` - The booking was created.
|
|
1960
|
-
* - `"UPDATED"` - The booking was updated.
|
|
1961
|
-
* - `"CONFIRMED"` - The booking has been confirmed and appears on the bookings calendar.
|
|
1962
|
-
* Booking can be manually confirmed using the Set As Confirmed endpoint.
|
|
1963
|
-
* Booking can be automatically confirmed when the following requirements are met:
|
|
1964
|
-
* + The service is configured as automatically confirmed.
|
|
1965
|
-
* + Invoking eCommerce checkout API and an order has been created.
|
|
1966
|
-
* - `"CANCELED"` - The booking has been canceled and synced to bookings calendar.
|
|
1967
|
-
* The booking can be canceled using cancel API.
|
|
1968
|
-
* - `"PENDING"` - The booking waiting to be confirmed or declined buy the owner and is synced to bookings calendar.
|
|
1969
|
-
* Bookings can be manually set as pending using setAsPending API, requires manage booking status permissions.
|
|
1970
|
-
* Booking can be automatically set as pending when the following requirements are met:
|
|
1971
|
-
* + The Service is configured as manually confirmed.
|
|
1972
|
-
* + Invoking the eCommerce checkout API and an order has been created.
|
|
1973
|
-
* - `"WAITING_LIST"` - The booking is pending on a waiting list.
|
|
1974
|
-
* Booking can be created with this status when invoking waiting list join API.
|
|
1975
|
-
* - `"DECLINED"` - The booking was declined by the owner and synced to bookings calendar.
|
|
1976
|
-
* Booking can be manually declined using decline API and requires manage booking permissions.
|
|
1977
|
-
* Booking can be automatically declined when the following requirements are met:
|
|
1978
|
-
* + Invoking eCommerce checkout API and the order declined event has been sent.
|
|
1979
|
-
* + Invoking eCommerce checkout API and order approved event has been sent, but the booking is offline and the booking causes a double booking.
|
|
1980
|
-
*/
|
|
1981
|
-
status?: BookingStatus;
|
|
1982
|
-
/**
|
|
1983
|
-
* Additional custom fields of the booking form. The customer must provide
|
|
1984
|
-
* information for each field when booking the service. For example, that they
|
|
1985
|
-
* bring their own towels or whether they use a wheelchair.
|
|
1986
|
-
*
|
|
1987
|
-
* Max: 100 fields
|
|
1988
|
-
*/
|
|
1989
|
-
additionalFields?: CustomFormField[];
|
|
1990
|
-
/**
|
|
1991
|
-
* Total number of participants. Available only when the service doesn't have
|
|
1992
|
-
* [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).
|
|
1993
|
-
*
|
|
1994
|
-
* Max: `20`
|
|
1995
|
-
*/
|
|
1996
|
-
numberOfParticipants?: number | null;
|
|
1997
|
-
/**
|
|
1998
|
-
* Internal business note. Not visible to the customer.
|
|
1999
|
-
*
|
|
2000
|
-
* Max: 200 characters
|
|
2001
|
-
*/
|
|
2002
|
-
internalBusinessNote?: string | null;
|
|
2003
|
-
/**
|
|
2004
|
-
* Payment option the customer intends to use.
|
|
2005
|
-
* Must be one of the payment options defined for the service, unless
|
|
2006
|
-
* you pass `flowControlSettings.skipSelectedPaymentOptionValidation` as `true`.
|
|
2007
|
-
*/
|
|
2008
|
-
selectedPaymentOption?: SelectedPaymentOption;
|
|
2009
|
-
/**
|
|
2010
|
-
* Identifies the source (platform, actor and app) that created this booking.
|
|
2011
|
-
* This property of the booking cannot be changed.
|
|
2012
|
-
* The app_def_id and app_name will be resolved automatically.
|
|
2013
|
-
* TODO GAP See if we need this - might be able to get this data from the headers?
|
|
2014
|
-
*/
|
|
2015
|
-
bookingSource?: BookingSource;
|
|
2016
|
-
/**
|
|
2017
|
-
* A user identifier of an external application user that initiated the book request.
|
|
2018
|
-
* Allows an external application to later identify its own bookings and correlate to its own internal users
|
|
2019
|
-
*/
|
|
2020
|
-
externalUserId?: string | null;
|
|
2021
|
-
/** Information about a message to send to the customer. */
|
|
2022
|
-
participantNotification?: ParticipantNotification;
|
|
2023
|
-
/**
|
|
2024
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
2025
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
2026
|
-
*
|
|
2027
|
-
* Default: `true`.
|
|
2028
|
-
*/
|
|
2029
|
-
sendSmsReminder?: boolean | null;
|
|
2030
|
-
/**
|
|
2031
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
2032
|
-
* creation flow are changed. For example, whether the availability is
|
|
2033
|
-
* checked before creating the booking or if additional payment options are
|
|
2034
|
-
* accepted.
|
|
2035
|
-
*/
|
|
2036
|
-
flowControlSettings?: CreateBookingRequestFlowControlSettings;
|
|
2037
|
-
}
|
|
2038
|
-
/** @oneof */
|
|
2039
|
-
export interface V2CreateBookingRequestBookableItemOneOf {
|
|
2040
|
-
/**
|
|
2041
|
-
* Information about the slot to create a booking for.
|
|
2042
|
-
* If you set `slot.location.locationType` to `CUSTOM`, the created slot's
|
|
2043
|
-
* location is set to `slot.location.formattedAddress` when provided.
|
|
2044
|
-
* Otherwise it's set to `contactDetails.fullAddress.formattedAddress`.
|
|
2045
|
-
*/
|
|
2046
|
-
slot?: Slot;
|
|
2047
|
-
/** Information about the schedule to create a booking for. */
|
|
2048
|
-
schedule?: BookedSchedule;
|
|
2049
|
-
}
|
|
2050
|
-
/** @oneof */
|
|
2051
|
-
export interface V2CreateBookingRequestParticipantsInfoOneOf {
|
|
2052
|
-
}
|
|
2053
|
-
export interface Slot {
|
|
2054
|
-
/**
|
|
2055
|
-
* ID for the slot's corresponding session, when the session is either a single session
|
|
2056
|
-
* or a specific session generated from a recurring session.
|
|
2057
|
-
*/
|
|
2058
|
-
sessionId?: string | null;
|
|
2059
|
-
/** Service ID. */
|
|
2060
|
-
serviceId?: string;
|
|
2061
|
-
/** Schedule ID. */
|
|
2062
|
-
scheduleId?: string;
|
|
2063
|
-
/**
|
|
2064
|
-
* The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
|
|
2065
|
-
* format.
|
|
2066
|
-
*
|
|
2067
|
-
* If `timezone` is specified,
|
|
2068
|
-
* dates are based on the local date/time. This means that the timezone offset
|
|
2069
|
-
* in the `start_date` is ignored.
|
|
2070
|
-
*/
|
|
2071
|
-
startDate?: string | null;
|
|
2072
|
-
/**
|
|
2073
|
-
* The end time of this slot in
|
|
2074
|
-
* [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
|
|
2075
|
-
*
|
|
2076
|
-
* If `timezone` is specified,
|
|
2077
|
-
* dates are based on the local date/time. This means that the timezone offset
|
|
2078
|
-
* in the `end_date` is ignored.
|
|
2079
|
-
*/
|
|
2080
|
-
endDate?: string | null;
|
|
2081
|
-
/**
|
|
2082
|
-
* The timezone for which slot availability is to be calculated.
|
|
2083
|
-
*
|
|
2084
|
-
* Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)
|
|
2085
|
-
* when calculating availability.
|
|
2086
|
-
*/
|
|
2087
|
-
timezone?: string | null;
|
|
2088
|
-
/**
|
|
2089
|
-
* The resource required for this slot. Currently, the only supported resource
|
|
2090
|
-
* is the relevant staff member for the slot.
|
|
2091
|
-
*/
|
|
2092
|
-
resource?: SlotResource;
|
|
2093
|
-
/** Geographic location of the slot. */
|
|
2094
|
-
location?: Location;
|
|
2095
|
-
}
|
|
2096
|
-
export interface SlotResource {
|
|
2097
|
-
/**
|
|
2098
|
-
* Resource ID.
|
|
2099
|
-
* @readonly
|
|
2100
|
-
*/
|
|
2101
|
-
_id?: string | null;
|
|
2102
|
-
/** Resource name. Read only. */
|
|
2103
|
-
name?: string | null;
|
|
2104
|
-
}
|
|
2105
|
-
export interface CreateBookingRequestFlowControlSettings {
|
|
2106
|
-
/**
|
|
2107
|
-
* Whether the availability is checked before creating the booking. When
|
|
2108
|
-
* passing `false` a booking is only created when the slot or schedule is
|
|
2109
|
-
* available. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`
|
|
2110
|
-
* permission scope when passing `true`.
|
|
2111
|
-
*
|
|
2112
|
-
* Default: `false`.
|
|
2113
|
-
*/
|
|
2114
|
-
skipAvailabilityValidation?: boolean;
|
|
2115
|
-
/**
|
|
2116
|
-
* Whether `PENDING` bookings are automatically set to `CONFIRMED` for
|
|
2117
|
-
* services that normally require the owner's manual confirmation. Your
|
|
2118
|
-
* app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope
|
|
2119
|
-
* when passing `true`.
|
|
2120
|
-
*
|
|
2121
|
-
* Default: `false`.
|
|
2122
|
-
*/
|
|
2123
|
-
skipBusinessConfirmation?: boolean;
|
|
2124
|
-
/**
|
|
2125
|
-
* Whether customers can pay using a payment method that isn't supported
|
|
2126
|
-
* for the service, but that's supported for other services. Your app
|
|
2127
|
-
* must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing
|
|
2128
|
-
* `true`.
|
|
2129
|
-
*
|
|
2130
|
-
* Default: `false`.
|
|
2131
|
-
*/
|
|
2132
|
-
skipSelectedPaymentOptionValidation?: boolean;
|
|
2133
|
-
}
|
|
2134
|
-
export interface V2CreateBookingResponse {
|
|
2135
|
-
/** Created booking. */
|
|
2136
|
-
booking?: Booking;
|
|
2137
|
-
}
|
|
2138
|
-
export interface V2CancelBookingRequest {
|
|
2139
|
-
/** ID of the booking to cancel. */
|
|
2140
|
-
bookingId?: string;
|
|
2141
|
-
/**
|
|
2142
|
-
* Information about whether to notify the customer about the cancelation and
|
|
2143
|
-
* the message to send.
|
|
2144
|
-
*/
|
|
2145
|
-
participantNotification?: ParticipantNotification;
|
|
2146
|
-
/**
|
|
2147
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2148
|
-
* To prevent conflicting changes,
|
|
2149
|
-
* the current revision must be passed when managing the booking.
|
|
2150
|
-
*/
|
|
2151
|
-
revision?: string | null;
|
|
2152
|
-
}
|
|
2153
|
-
export interface V2CancelBookingRequestFlowControlSettings {
|
|
2154
|
-
/**
|
|
2155
|
-
* Whether the cancelation policy applies when canceling the booking. When
|
|
2156
|
-
* passing `false` you can only cancel a booking if the cancelation policy
|
|
2157
|
-
* allows it. Your app must have the `BOOKINGS.IGNORE_BOOKING_POLICY `
|
|
2158
|
-
* permission scope when passing `true`.
|
|
2159
|
-
*
|
|
2160
|
-
* Default: `false`.
|
|
2161
|
-
*
|
|
2162
|
-
* <!--ONLY:VELO
|
|
2163
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
2164
|
-
* <!--END:ONLY:VELO-->
|
|
2165
|
-
*/
|
|
2166
|
-
ignoreCancellationPolicy?: boolean;
|
|
2167
|
-
/**
|
|
2168
|
-
* Whether to issue a refund when canceling the booking.
|
|
2169
|
-
* The refund will be issued only if the booking is refundable.
|
|
2170
|
-
* Currently, booking is considered refundable when it was paid by membership.
|
|
2171
|
-
* If passing `true`, the booking flow control settings will be set with refund,
|
|
2172
|
-
* otherwise, either if `false` is passed or the field remains empty,
|
|
2173
|
-
* the booking flow control settings will be set with no refund.
|
|
2174
|
-
*
|
|
2175
|
-
* Default: `false`.
|
|
2176
|
-
*/
|
|
2177
|
-
withRefund?: boolean | null;
|
|
2178
|
-
}
|
|
2179
|
-
export interface V2CancelBookingResponse {
|
|
2180
|
-
/** Canceled booking. */
|
|
2181
|
-
booking?: Booking;
|
|
2182
|
-
}
|
|
2183
|
-
export interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
2184
|
-
/** Id of the booking to reschedule. */
|
|
2185
|
-
bookingId?: string;
|
|
2186
|
-
/** Information about the new slot. */
|
|
2187
|
-
slot?: Slot;
|
|
2188
|
-
/**
|
|
2189
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2190
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
2191
|
-
* managing the booking.
|
|
2192
|
-
*/
|
|
2193
|
-
revision?: string | null;
|
|
2194
|
-
/**
|
|
2195
|
-
* Information about whether to notify the customer about the rescheduling and
|
|
2196
|
-
* the message to send.
|
|
2197
|
-
*/
|
|
2198
|
-
participantNotification?: ParticipantNotification;
|
|
2199
|
-
}
|
|
2200
|
-
/** @oneof */
|
|
2201
|
-
export interface V2RescheduleBookingRequestParticipantsInfoOneOf {
|
|
2202
|
-
}
|
|
2203
|
-
export interface V2RescheduleBookingRequestFlowControlSettings {
|
|
2204
|
-
/**
|
|
2205
|
-
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
2206
|
-
* When passing `false` you can only cancel a booking if the rescheduling
|
|
2207
|
-
* policy allows it. Your app must have the `BOOKINGS.IGNORE_BOOKING_POLICY `
|
|
2208
|
-
* permission scope when passing `true`.
|
|
2209
|
-
*
|
|
2210
|
-
* Default: `false`.
|
|
2211
|
-
*
|
|
2212
|
-
* <!--ONLY:VELO
|
|
2213
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
2214
|
-
* <!--END:ONLY:VELO-->
|
|
2215
|
-
*/
|
|
2216
|
-
ignoreReschedulePolicy?: boolean;
|
|
2217
|
-
/**
|
|
2218
|
-
* Whether the availability is checked before rescheduling the booking.
|
|
2219
|
-
* When passing `false` a booking is only created when the slot or
|
|
2220
|
-
* schedule is available. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`
|
|
2221
|
-
* permission scope when passing `true`.
|
|
2222
|
-
*
|
|
2223
|
-
* Default: `false`.
|
|
2224
|
-
*/
|
|
2225
|
-
skipAvailabilityValidation?: boolean;
|
|
2226
|
-
/**
|
|
2227
|
-
* Whether the rescheduled booking's status is automatically set to
|
|
2228
|
-
* `CONFIRMED` for services that normally require the owner's manual
|
|
2229
|
-
* confirmation. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`
|
|
2230
|
-
* permission scope when passing `true`.
|
|
2231
|
-
*
|
|
2232
|
-
* Default: `false`.
|
|
2233
|
-
*/
|
|
2234
|
-
skipBusinessConfirmation?: boolean;
|
|
2235
|
-
}
|
|
2236
|
-
export interface V2RescheduleBookingResponse {
|
|
2237
|
-
/** Rescheduled booking. */
|
|
2238
|
-
booking?: Booking;
|
|
2239
|
-
}
|
|
2240
|
-
export interface V2ConfirmBookingRequest {
|
|
2241
|
-
/** ID of the booking to confirm. */
|
|
2242
|
-
bookingId?: string;
|
|
2243
|
-
/**
|
|
2244
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2245
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
2246
|
-
* managing the booking.
|
|
2247
|
-
*/
|
|
2248
|
-
revision?: string | null;
|
|
2249
|
-
/**
|
|
2250
|
-
* Information about whether to notify the customer about the confirmation and
|
|
2251
|
-
* the message to send.
|
|
2252
|
-
*/
|
|
2253
|
-
participantNotification?: ParticipantNotification;
|
|
2254
|
-
}
|
|
2255
|
-
export interface V2ConfirmBookingResponse {
|
|
2256
|
-
booking?: Booking;
|
|
2257
|
-
}
|
|
2258
|
-
export interface V2DeclineBookingRequest {
|
|
2259
|
-
/** ID of the booking to decline. */
|
|
2260
|
-
bookingId?: string;
|
|
2261
|
-
/**
|
|
2262
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2263
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
2264
|
-
* managing the booking.
|
|
2265
|
-
*/
|
|
2266
|
-
revision?: string | null;
|
|
2267
|
-
/**
|
|
2268
|
-
* Information about whether to notify the customer about the decline and
|
|
2269
|
-
* the message to send.
|
|
2270
|
-
*/
|
|
2271
|
-
participantNotification?: ParticipantNotification;
|
|
2272
|
-
}
|
|
2273
|
-
export interface V2DeclineBookingResponse {
|
|
2274
|
-
/** Declined booking. */
|
|
2275
|
-
booking?: Booking;
|
|
2276
|
-
}
|
|
2277
|
-
export interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2278
|
-
/** ID of the booking to update the number of participants for. */
|
|
2279
|
-
bookingId?: string;
|
|
2280
|
-
/** Updated number of participants. */
|
|
2281
|
-
numberOfParticipants?: number | null;
|
|
2282
|
-
/**
|
|
2283
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2284
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
2285
|
-
* managing the booking.
|
|
2286
|
-
*/
|
|
2287
|
-
revision?: string | null;
|
|
2288
|
-
}
|
|
2289
|
-
/** @oneof */
|
|
2290
|
-
export interface V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
2291
|
-
}
|
|
2292
|
-
export interface V2UpdateNumberOfParticipantsResponse {
|
|
2293
|
-
/** Booking with updated number of participants. */
|
|
2294
|
-
booking?: Booking;
|
|
2295
|
-
}
|
|
2296
|
-
export interface CreateBookingResponseNonNullableFields {
|
|
2297
|
-
booking?: {
|
|
2298
|
-
totalParticipants: number;
|
|
2299
|
-
participantsChoices?: {
|
|
2300
|
-
serviceChoices: {
|
|
2301
|
-
choices: {
|
|
2302
|
-
custom: string;
|
|
2303
|
-
optionId: string;
|
|
2304
|
-
}[];
|
|
2305
|
-
}[];
|
|
2306
|
-
};
|
|
2307
|
-
bookedEntity?: {
|
|
2308
|
-
slot?: {
|
|
2309
|
-
serviceId: string;
|
|
2310
|
-
scheduleId: string;
|
|
2311
|
-
resource?: {
|
|
2312
|
-
_id: string;
|
|
2313
|
-
};
|
|
2314
|
-
location?: {
|
|
2315
|
-
locationType: LocationType;
|
|
2316
|
-
};
|
|
2317
|
-
};
|
|
2318
|
-
schedule?: {
|
|
2319
|
-
scheduleId: string;
|
|
2320
|
-
location?: {
|
|
2321
|
-
locationType: LocationType;
|
|
2322
|
-
};
|
|
2323
|
-
};
|
|
2324
|
-
};
|
|
2325
|
-
contactDetails?: {
|
|
2326
|
-
fullAddress?: {
|
|
2327
|
-
streetAddress?: {
|
|
2328
|
-
number: string;
|
|
2329
|
-
name: string;
|
|
2330
|
-
apt: string;
|
|
2331
|
-
};
|
|
2332
|
-
subdivisions: {
|
|
2333
|
-
code: string;
|
|
2334
|
-
name: string;
|
|
2335
|
-
}[];
|
|
2336
|
-
};
|
|
2337
|
-
};
|
|
2338
|
-
additionalFields: {
|
|
2339
|
-
_id: string;
|
|
2340
|
-
valueType: ValueType;
|
|
2341
|
-
}[];
|
|
2342
|
-
status: BookingStatus;
|
|
2343
|
-
paymentStatus: PaymentStatus;
|
|
2344
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2345
|
-
createdBy?: {
|
|
2346
|
-
anonymousVisitorId: string;
|
|
2347
|
-
memberId: string;
|
|
2348
|
-
wixUserId: string;
|
|
2349
|
-
appId: string;
|
|
2350
|
-
};
|
|
2351
|
-
};
|
|
2352
|
-
}
|
|
2353
|
-
export interface BulkCreateBookingResponseNonNullableFields {
|
|
2354
|
-
results: {
|
|
2355
|
-
itemMetadata?: {
|
|
2356
|
-
originalIndex: number;
|
|
2357
|
-
success: boolean;
|
|
2358
|
-
error?: {
|
|
2359
|
-
code: string;
|
|
2360
|
-
description: string;
|
|
2361
|
-
};
|
|
2362
|
-
};
|
|
2363
|
-
item?: {
|
|
2364
|
-
totalParticipants: number;
|
|
2365
|
-
participantsChoices?: {
|
|
2366
|
-
serviceChoices: {
|
|
2367
|
-
choices: {
|
|
2368
|
-
custom: string;
|
|
2369
|
-
optionId: string;
|
|
2370
|
-
}[];
|
|
2371
|
-
}[];
|
|
2372
|
-
};
|
|
2373
|
-
bookedEntity?: {
|
|
2374
|
-
slot?: {
|
|
2375
|
-
serviceId: string;
|
|
2376
|
-
scheduleId: string;
|
|
2377
|
-
resource?: {
|
|
2378
|
-
_id: string;
|
|
2379
|
-
};
|
|
2380
|
-
location?: {
|
|
2381
|
-
locationType: LocationType;
|
|
2382
|
-
};
|
|
2383
|
-
};
|
|
2384
|
-
schedule?: {
|
|
2385
|
-
scheduleId: string;
|
|
2386
|
-
location?: {
|
|
2387
|
-
locationType: LocationType;
|
|
2388
|
-
};
|
|
2389
|
-
};
|
|
2390
|
-
};
|
|
2391
|
-
contactDetails?: {
|
|
2392
|
-
fullAddress?: {
|
|
2393
|
-
streetAddress?: {
|
|
2394
|
-
number: string;
|
|
2395
|
-
name: string;
|
|
2396
|
-
apt: string;
|
|
2397
|
-
};
|
|
2398
|
-
subdivisions: {
|
|
2399
|
-
code: string;
|
|
2400
|
-
name: string;
|
|
2401
|
-
}[];
|
|
2402
|
-
};
|
|
2403
|
-
};
|
|
2404
|
-
additionalFields: {
|
|
2405
|
-
_id: string;
|
|
2406
|
-
valueType: ValueType;
|
|
2407
|
-
}[];
|
|
2408
|
-
status: BookingStatus;
|
|
2409
|
-
paymentStatus: PaymentStatus;
|
|
2410
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2411
|
-
createdBy?: {
|
|
2412
|
-
anonymousVisitorId: string;
|
|
2413
|
-
memberId: string;
|
|
2414
|
-
wixUserId: string;
|
|
2415
|
-
appId: string;
|
|
2416
|
-
};
|
|
2417
|
-
};
|
|
2418
|
-
}[];
|
|
2419
|
-
bulkActionMetadata?: {
|
|
2420
|
-
totalSuccesses: number;
|
|
2421
|
-
totalFailures: number;
|
|
2422
|
-
undetailedFailures: number;
|
|
2423
|
-
};
|
|
2424
|
-
}
|
|
2425
|
-
export interface RescheduleBookingResponseNonNullableFields {
|
|
2426
|
-
booking?: {
|
|
2427
|
-
totalParticipants: number;
|
|
2428
|
-
participantsChoices?: {
|
|
2429
|
-
serviceChoices: {
|
|
2430
|
-
choices: {
|
|
2431
|
-
custom: string;
|
|
2432
|
-
optionId: string;
|
|
2433
|
-
}[];
|
|
2434
|
-
}[];
|
|
2435
|
-
};
|
|
2436
|
-
bookedEntity?: {
|
|
2437
|
-
slot?: {
|
|
2438
|
-
serviceId: string;
|
|
2439
|
-
scheduleId: string;
|
|
2440
|
-
resource?: {
|
|
2441
|
-
_id: string;
|
|
2442
|
-
};
|
|
2443
|
-
location?: {
|
|
2444
|
-
locationType: LocationType;
|
|
2445
|
-
};
|
|
2446
|
-
};
|
|
2447
|
-
schedule?: {
|
|
2448
|
-
scheduleId: string;
|
|
2449
|
-
location?: {
|
|
2450
|
-
locationType: LocationType;
|
|
2451
|
-
};
|
|
2452
|
-
};
|
|
2453
|
-
};
|
|
2454
|
-
contactDetails?: {
|
|
2455
|
-
fullAddress?: {
|
|
2456
|
-
streetAddress?: {
|
|
2457
|
-
number: string;
|
|
2458
|
-
name: string;
|
|
2459
|
-
apt: string;
|
|
2460
|
-
};
|
|
2461
|
-
subdivisions: {
|
|
2462
|
-
code: string;
|
|
2463
|
-
name: string;
|
|
2464
|
-
}[];
|
|
2465
|
-
};
|
|
2466
|
-
};
|
|
2467
|
-
additionalFields: {
|
|
2468
|
-
_id: string;
|
|
2469
|
-
valueType: ValueType;
|
|
2470
|
-
}[];
|
|
2471
|
-
status: BookingStatus;
|
|
2472
|
-
paymentStatus: PaymentStatus;
|
|
2473
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2474
|
-
createdBy?: {
|
|
2475
|
-
anonymousVisitorId: string;
|
|
2476
|
-
memberId: string;
|
|
2477
|
-
wixUserId: string;
|
|
2478
|
-
appId: string;
|
|
2479
|
-
};
|
|
2480
|
-
};
|
|
2481
|
-
}
|
|
2482
|
-
export interface ConfirmBookingResponseNonNullableFields {
|
|
2483
|
-
booking?: {
|
|
2484
|
-
totalParticipants: number;
|
|
2485
|
-
participantsChoices?: {
|
|
2486
|
-
serviceChoices: {
|
|
2487
|
-
choices: {
|
|
2488
|
-
custom: string;
|
|
2489
|
-
optionId: string;
|
|
2490
|
-
}[];
|
|
2491
|
-
}[];
|
|
2492
|
-
};
|
|
2493
|
-
bookedEntity?: {
|
|
2494
|
-
slot?: {
|
|
2495
|
-
serviceId: string;
|
|
2496
|
-
scheduleId: string;
|
|
2497
|
-
resource?: {
|
|
2498
|
-
_id: string;
|
|
2499
|
-
};
|
|
2500
|
-
location?: {
|
|
2501
|
-
locationType: LocationType;
|
|
2502
|
-
};
|
|
2503
|
-
};
|
|
2504
|
-
schedule?: {
|
|
2505
|
-
scheduleId: string;
|
|
2506
|
-
location?: {
|
|
2507
|
-
locationType: LocationType;
|
|
2508
|
-
};
|
|
2509
|
-
};
|
|
2510
|
-
};
|
|
2511
|
-
contactDetails?: {
|
|
2512
|
-
fullAddress?: {
|
|
2513
|
-
streetAddress?: {
|
|
2514
|
-
number: string;
|
|
2515
|
-
name: string;
|
|
2516
|
-
apt: string;
|
|
2517
|
-
};
|
|
2518
|
-
subdivisions: {
|
|
2519
|
-
code: string;
|
|
2520
|
-
name: string;
|
|
2521
|
-
}[];
|
|
2522
|
-
};
|
|
2523
|
-
};
|
|
2524
|
-
additionalFields: {
|
|
2525
|
-
_id: string;
|
|
2526
|
-
valueType: ValueType;
|
|
2527
|
-
}[];
|
|
2528
|
-
status: BookingStatus;
|
|
2529
|
-
paymentStatus: PaymentStatus;
|
|
2530
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2531
|
-
createdBy?: {
|
|
2532
|
-
anonymousVisitorId: string;
|
|
2533
|
-
memberId: string;
|
|
2534
|
-
wixUserId: string;
|
|
2535
|
-
appId: string;
|
|
2536
|
-
};
|
|
2537
|
-
};
|
|
2538
|
-
}
|
|
2539
|
-
export interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
2540
|
-
namespace: string;
|
|
2541
|
-
}
|
|
2542
|
-
export interface DeclineBookingResponseNonNullableFields {
|
|
2543
|
-
booking?: {
|
|
2544
|
-
totalParticipants: number;
|
|
2545
|
-
participantsChoices?: {
|
|
2546
|
-
serviceChoices: {
|
|
2547
|
-
choices: {
|
|
2548
|
-
custom: string;
|
|
2549
|
-
optionId: string;
|
|
2550
|
-
}[];
|
|
2551
|
-
}[];
|
|
2552
|
-
};
|
|
2553
|
-
bookedEntity?: {
|
|
2554
|
-
slot?: {
|
|
2555
|
-
serviceId: string;
|
|
2556
|
-
scheduleId: string;
|
|
2557
|
-
resource?: {
|
|
2558
|
-
_id: string;
|
|
2559
|
-
};
|
|
2560
|
-
location?: {
|
|
2561
|
-
locationType: LocationType;
|
|
2562
|
-
};
|
|
2563
|
-
};
|
|
2564
|
-
schedule?: {
|
|
2565
|
-
scheduleId: string;
|
|
2566
|
-
location?: {
|
|
2567
|
-
locationType: LocationType;
|
|
2568
|
-
};
|
|
2569
|
-
};
|
|
2570
|
-
};
|
|
2571
|
-
contactDetails?: {
|
|
2572
|
-
fullAddress?: {
|
|
2573
|
-
streetAddress?: {
|
|
2574
|
-
number: string;
|
|
2575
|
-
name: string;
|
|
2576
|
-
apt: string;
|
|
2577
|
-
};
|
|
2578
|
-
subdivisions: {
|
|
2579
|
-
code: string;
|
|
2580
|
-
name: string;
|
|
2581
|
-
}[];
|
|
2582
|
-
};
|
|
2583
|
-
};
|
|
2584
|
-
additionalFields: {
|
|
2585
|
-
_id: string;
|
|
2586
|
-
valueType: ValueType;
|
|
2587
|
-
}[];
|
|
2588
|
-
status: BookingStatus;
|
|
2589
|
-
paymentStatus: PaymentStatus;
|
|
2590
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2591
|
-
createdBy?: {
|
|
2592
|
-
anonymousVisitorId: string;
|
|
2593
|
-
memberId: string;
|
|
2594
|
-
wixUserId: string;
|
|
2595
|
-
appId: string;
|
|
2596
|
-
};
|
|
2597
|
-
};
|
|
2598
|
-
}
|
|
2599
|
-
export interface CancelBookingResponseNonNullableFields {
|
|
2600
|
-
booking?: {
|
|
2601
|
-
totalParticipants: number;
|
|
2602
|
-
participantsChoices?: {
|
|
2603
|
-
serviceChoices: {
|
|
2604
|
-
choices: {
|
|
2605
|
-
custom: string;
|
|
2606
|
-
optionId: string;
|
|
2607
|
-
}[];
|
|
2608
|
-
}[];
|
|
2609
|
-
};
|
|
2610
|
-
bookedEntity?: {
|
|
2611
|
-
slot?: {
|
|
2612
|
-
serviceId: string;
|
|
2613
|
-
scheduleId: string;
|
|
2614
|
-
resource?: {
|
|
2615
|
-
_id: string;
|
|
2616
|
-
};
|
|
2617
|
-
location?: {
|
|
2618
|
-
locationType: LocationType;
|
|
2619
|
-
};
|
|
2620
|
-
};
|
|
2621
|
-
schedule?: {
|
|
2622
|
-
scheduleId: string;
|
|
2623
|
-
location?: {
|
|
2624
|
-
locationType: LocationType;
|
|
2625
|
-
};
|
|
2626
|
-
};
|
|
2627
|
-
};
|
|
2628
|
-
contactDetails?: {
|
|
2629
|
-
fullAddress?: {
|
|
2630
|
-
streetAddress?: {
|
|
2631
|
-
number: string;
|
|
2632
|
-
name: string;
|
|
2633
|
-
apt: string;
|
|
2634
|
-
};
|
|
2635
|
-
subdivisions: {
|
|
2636
|
-
code: string;
|
|
2637
|
-
name: string;
|
|
2638
|
-
}[];
|
|
2639
|
-
};
|
|
2640
|
-
};
|
|
2641
|
-
additionalFields: {
|
|
2642
|
-
_id: string;
|
|
2643
|
-
valueType: ValueType;
|
|
2644
|
-
}[];
|
|
2645
|
-
status: BookingStatus;
|
|
2646
|
-
paymentStatus: PaymentStatus;
|
|
2647
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2648
|
-
createdBy?: {
|
|
2649
|
-
anonymousVisitorId: string;
|
|
2650
|
-
memberId: string;
|
|
2651
|
-
wixUserId: string;
|
|
2652
|
-
appId: string;
|
|
2653
|
-
};
|
|
2654
|
-
};
|
|
2655
|
-
}
|
|
2656
|
-
export interface UpdateNumberOfParticipantsResponseNonNullableFields {
|
|
2657
|
-
booking?: {
|
|
2658
|
-
totalParticipants: number;
|
|
2659
|
-
participantsChoices?: {
|
|
2660
|
-
serviceChoices: {
|
|
2661
|
-
choices: {
|
|
2662
|
-
custom: string;
|
|
2663
|
-
optionId: string;
|
|
2664
|
-
}[];
|
|
2665
|
-
}[];
|
|
2666
|
-
};
|
|
2667
|
-
bookedEntity?: {
|
|
2668
|
-
slot?: {
|
|
2669
|
-
serviceId: string;
|
|
2670
|
-
scheduleId: string;
|
|
2671
|
-
resource?: {
|
|
2672
|
-
_id: string;
|
|
2673
|
-
};
|
|
2674
|
-
location?: {
|
|
2675
|
-
locationType: LocationType;
|
|
2676
|
-
};
|
|
2677
|
-
};
|
|
2678
|
-
schedule?: {
|
|
2679
|
-
scheduleId: string;
|
|
2680
|
-
location?: {
|
|
2681
|
-
locationType: LocationType;
|
|
2682
|
-
};
|
|
2683
|
-
};
|
|
2684
|
-
};
|
|
2685
|
-
contactDetails?: {
|
|
2686
|
-
fullAddress?: {
|
|
2687
|
-
streetAddress?: {
|
|
2688
|
-
number: string;
|
|
2689
|
-
name: string;
|
|
2690
|
-
apt: string;
|
|
2691
|
-
};
|
|
2692
|
-
subdivisions: {
|
|
2693
|
-
code: string;
|
|
2694
|
-
name: string;
|
|
2695
|
-
}[];
|
|
2696
|
-
};
|
|
2697
|
-
};
|
|
2698
|
-
additionalFields: {
|
|
2699
|
-
_id: string;
|
|
2700
|
-
valueType: ValueType;
|
|
2701
|
-
}[];
|
|
2702
|
-
status: BookingStatus;
|
|
2703
|
-
paymentStatus: PaymentStatus;
|
|
2704
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2705
|
-
createdBy?: {
|
|
2706
|
-
anonymousVisitorId: string;
|
|
2707
|
-
memberId: string;
|
|
2708
|
-
wixUserId: string;
|
|
2709
|
-
appId: string;
|
|
2710
|
-
};
|
|
2711
|
-
};
|
|
2712
|
-
}
|
|
2713
|
-
export interface ConfirmOrDeclineBookingResponseNonNullableFields {
|
|
2714
|
-
booking?: {
|
|
2715
|
-
totalParticipants: number;
|
|
2716
|
-
participantsChoices?: {
|
|
2717
|
-
serviceChoices: {
|
|
2718
|
-
choices: {
|
|
2719
|
-
custom: string;
|
|
2720
|
-
optionId: string;
|
|
2721
|
-
}[];
|
|
2722
|
-
}[];
|
|
2723
|
-
};
|
|
2724
|
-
bookedEntity?: {
|
|
2725
|
-
slot?: {
|
|
2726
|
-
serviceId: string;
|
|
2727
|
-
scheduleId: string;
|
|
2728
|
-
resource?: {
|
|
2729
|
-
_id: string;
|
|
2730
|
-
};
|
|
2731
|
-
location?: {
|
|
2732
|
-
locationType: LocationType;
|
|
2733
|
-
};
|
|
2734
|
-
};
|
|
2735
|
-
schedule?: {
|
|
2736
|
-
scheduleId: string;
|
|
2737
|
-
location?: {
|
|
2738
|
-
locationType: LocationType;
|
|
2739
|
-
};
|
|
2740
|
-
};
|
|
2741
|
-
};
|
|
2742
|
-
contactDetails?: {
|
|
2743
|
-
fullAddress?: {
|
|
2744
|
-
streetAddress?: {
|
|
2745
|
-
number: string;
|
|
2746
|
-
name: string;
|
|
2747
|
-
apt: string;
|
|
2748
|
-
};
|
|
2749
|
-
subdivisions: {
|
|
2750
|
-
code: string;
|
|
2751
|
-
name: string;
|
|
2752
|
-
}[];
|
|
2753
|
-
};
|
|
2754
|
-
};
|
|
2755
|
-
additionalFields: {
|
|
2756
|
-
_id: string;
|
|
2757
|
-
valueType: ValueType;
|
|
2758
|
-
}[];
|
|
2759
|
-
status: BookingStatus;
|
|
2760
|
-
paymentStatus: PaymentStatus;
|
|
2761
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2762
|
-
createdBy?: {
|
|
2763
|
-
anonymousVisitorId: string;
|
|
2764
|
-
memberId: string;
|
|
2765
|
-
wixUserId: string;
|
|
2766
|
-
appId: string;
|
|
2767
|
-
};
|
|
2768
|
-
};
|
|
2769
|
-
}
|
|
2770
|
-
export interface BulkConfirmOrDeclineBookingResponseNonNullableFields {
|
|
2771
|
-
results: {
|
|
2772
|
-
itemMetadata?: {
|
|
2773
|
-
originalIndex: number;
|
|
2774
|
-
success: boolean;
|
|
2775
|
-
error?: {
|
|
2776
|
-
code: string;
|
|
2777
|
-
description: string;
|
|
2778
|
-
};
|
|
2779
|
-
};
|
|
2780
|
-
item?: {
|
|
2781
|
-
totalParticipants: number;
|
|
2782
|
-
participantsChoices?: {
|
|
2783
|
-
serviceChoices: {
|
|
2784
|
-
choices: {
|
|
2785
|
-
custom: string;
|
|
2786
|
-
optionId: string;
|
|
2787
|
-
}[];
|
|
2788
|
-
}[];
|
|
2789
|
-
};
|
|
2790
|
-
bookedEntity?: {
|
|
2791
|
-
slot?: {
|
|
2792
|
-
serviceId: string;
|
|
2793
|
-
scheduleId: string;
|
|
2794
|
-
resource?: {
|
|
2795
|
-
_id: string;
|
|
2796
|
-
};
|
|
2797
|
-
location?: {
|
|
2798
|
-
locationType: LocationType;
|
|
2799
|
-
};
|
|
2800
|
-
};
|
|
2801
|
-
schedule?: {
|
|
2802
|
-
scheduleId: string;
|
|
2803
|
-
location?: {
|
|
2804
|
-
locationType: LocationType;
|
|
2805
|
-
};
|
|
2806
|
-
};
|
|
2807
|
-
};
|
|
2808
|
-
contactDetails?: {
|
|
2809
|
-
fullAddress?: {
|
|
2810
|
-
streetAddress?: {
|
|
2811
|
-
number: string;
|
|
2812
|
-
name: string;
|
|
2813
|
-
apt: string;
|
|
2814
|
-
};
|
|
2815
|
-
subdivisions: {
|
|
2816
|
-
code: string;
|
|
2817
|
-
name: string;
|
|
2818
|
-
}[];
|
|
2819
|
-
};
|
|
2820
|
-
};
|
|
2821
|
-
additionalFields: {
|
|
2822
|
-
_id: string;
|
|
2823
|
-
valueType: ValueType;
|
|
2824
|
-
}[];
|
|
2825
|
-
status: BookingStatus;
|
|
2826
|
-
paymentStatus: PaymentStatus;
|
|
2827
|
-
selectedPaymentOption: SelectedPaymentOption;
|
|
2828
|
-
createdBy?: {
|
|
2829
|
-
anonymousVisitorId: string;
|
|
2830
|
-
memberId: string;
|
|
2831
|
-
wixUserId: string;
|
|
2832
|
-
appId: string;
|
|
2833
|
-
};
|
|
2834
|
-
};
|
|
2835
|
-
}[];
|
|
2836
|
-
bulkActionMetadata?: {
|
|
2837
|
-
totalSuccesses: number;
|
|
2838
|
-
totalFailures: number;
|
|
2839
|
-
undetailedFailures: number;
|
|
2840
|
-
};
|
|
2841
|
-
}
|
|
2842
|
-
export declare const onBookingCreated: EventDefinition<DomainCreatedEvent<Booking>, "wix.bookings.v2.booking_created">;
|
|
2843
|
-
export declare const onBookingRescheduled: EventDefinition<DomainActionEvent<BookingRescheduled>, "wix.bookings.v2.booking_rescheduled">;
|
|
2844
|
-
export declare const onBookingCanceled: EventDefinition<DomainActionEvent<BookingCanceled>, "wix.bookings.v2.booking_canceled">;
|
|
2845
|
-
export declare const onBookingUpdated: EventDefinition<DomainUpdatedEvent<Booking>, "wix.bookings.v2.booking_updated">;
|
|
2846
|
-
export declare const onBookingConfirmed: EventDefinition<DomainActionEvent<BookingConfirmed>, "wix.bookings.v2.booking_confirmed">;
|
|
2847
|
-
export declare const onBookingDeclined: EventDefinition<DomainActionEvent<BookingDeclined>, "wix.bookings.v2.booking_declined">;
|
|
2848
|
-
export declare const onBookingNumberOfParticipantsUpdated: EventDefinition<DomainActionEvent<NumberOfParticipantsUpdated>, "wix.bookings.v2.booking_number_of_participants_updated">;
|
|
2849
|
-
/**
|
|
2850
|
-
* Creates a booking.
|
|
2851
|
-
*
|
|
2852
|
-
*
|
|
2853
|
-
* To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
|
|
2854
|
-
*
|
|
2855
|
-
* To create a booking for the entire course, pass a booking with the relevant `schedule`.
|
|
2856
|
-
* You can use the Query Availability endpoint to check the availability beforehand.
|
|
2857
|
-
*
|
|
2858
|
-
* If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
|
|
2859
|
-
* Then, any specified slot details are calculated.
|
|
2860
|
-
*
|
|
2861
|
-
* If you create a booking for a new session, we recommend to call Query Availability first.
|
|
2862
|
-
* Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
|
|
2863
|
-
*
|
|
2864
|
-
* Bookings are created with a status of `CREATED`.
|
|
2865
|
-
* `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
|
|
2866
|
-
*
|
|
2867
|
-
* To create a booking with a given status, pass a booking with the wanted status.
|
|
2868
|
-
* This is only permitted for site Owners.
|
|
2869
|
-
*
|
|
2870
|
-
* You can pass a `participantNotification.message` to notify the customer of the booking with a message.
|
|
2871
|
-
* It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
|
|
2872
|
-
*
|
|
2873
|
-
* You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
|
|
2874
|
-
*
|
|
2875
|
-
* When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
|
|
2876
|
-
* provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
|
|
2877
|
-
*
|
|
2878
|
-
* When creating a booking, you can pass `selectedPaymentOption`.
|
|
2879
|
-
* This specifies which payment method the customer plans to use.
|
|
2880
|
-
* But it's possible for them to later use another supported payment method.
|
|
2881
|
-
*
|
|
2882
|
-
* You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
|
|
2883
|
-
* Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
|
|
2884
|
-
* @param booking - The booking to create.
|
|
2885
|
-
* @public
|
|
2886
|
-
* @documentationMaturity preview
|
|
2887
|
-
* @requiredField booking
|
|
2888
|
-
* @requiredField booking.additionalFields._id
|
|
2889
|
-
* @requiredField booking.bookedEntity
|
|
2890
|
-
* @permissionScope Manage Bookings
|
|
2891
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2892
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2893
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2894
|
-
* @applicableIdentity APP
|
|
2895
|
-
* @applicableIdentity MEMBER
|
|
2896
|
-
* @applicableIdentity VISITOR
|
|
2897
|
-
*/
|
|
2898
|
-
export declare function createBooking(booking: Booking, options?: CreateBookingOptions): Promise<CreateBookingResponse & CreateBookingResponseNonNullableFields>;
|
|
2899
|
-
export interface CreateBookingOptions {
|
|
2900
|
-
/** Information about a message to send to the customer. */
|
|
2901
|
-
participantNotification?: ParticipantNotification;
|
|
2902
|
-
/**
|
|
2903
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
2904
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
2905
|
-
* Default: `true`.
|
|
2906
|
-
*/
|
|
2907
|
-
sendSmsReminder?: boolean | null;
|
|
2908
|
-
/**
|
|
2909
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
2910
|
-
* creation flow are changed. For example, whether the availability is
|
|
2911
|
-
* checked before creating the booking or if additional payment options are
|
|
2912
|
-
* accepted.
|
|
2913
|
-
*/
|
|
2914
|
-
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
2915
|
-
}
|
|
2916
|
-
/**
|
|
2917
|
-
* Creates multiple bookings.
|
|
2918
|
-
*
|
|
2919
|
-
*
|
|
2920
|
-
* See [`createBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/createbooking) documentation.
|
|
2921
|
-
*
|
|
2922
|
-
* If for any of the bookings required fields were not passed on the request or if the caller doesn't have the required permissions to create such booking, the call will fail.
|
|
2923
|
-
* If the request contains unavailable bookings, the call will be completed successfully, but the unavailable bookings will not be created and will be considered as a failure on the response.
|
|
2924
|
-
* @param createBookingsInfo - Bookings to create.
|
|
2925
|
-
* Max: 8 bookings.
|
|
2926
|
-
* @public
|
|
2927
|
-
* @documentationMaturity preview
|
|
2928
|
-
* @requiredField createBookingsInfo
|
|
2929
|
-
* @requiredField createBookingsInfo.booking
|
|
2930
|
-
* @requiredField createBookingsInfo.booking.additionalFields._id
|
|
2931
|
-
* @requiredField createBookingsInfo.booking.bookedEntity
|
|
2932
|
-
* @permissionScope Manage Bookings
|
|
2933
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2934
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2935
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2936
|
-
* @applicableIdentity APP
|
|
2937
|
-
* @applicableIdentity MEMBER
|
|
2938
|
-
* @applicableIdentity VISITOR
|
|
2939
|
-
*/
|
|
2940
|
-
export declare function bulkCreateBooking(createBookingsInfo: CreateBookingInfo[], options?: BulkCreateBookingOptions): Promise<BulkCreateBookingResponse & BulkCreateBookingResponseNonNullableFields>;
|
|
2941
|
-
export interface BulkCreateBookingOptions {
|
|
2942
|
-
/** Whether to return the created bookings entities. */
|
|
2943
|
-
returnFullEntity?: boolean;
|
|
2944
|
-
}
|
|
2945
|
-
/**
|
|
2946
|
-
* Reschedules a booking to a different slot or session.
|
|
2947
|
-
*
|
|
2948
|
-
*
|
|
2949
|
-
* You can only reschedule bookings for appointments or classes, you can't
|
|
2950
|
-
* reschedule course bookings.
|
|
2951
|
-
*
|
|
2952
|
-
* The old session is removed from the calendar and the new session is
|
|
2953
|
-
* added.
|
|
2954
|
-
*
|
|
2955
|
-
* If you reschedule a booking for a class session the new session must be an
|
|
2956
|
-
* existing session for the same class.
|
|
2957
|
-
*
|
|
2958
|
-
* You can pass a `participantNotification.message` to notify the customer of
|
|
2959
|
-
* the rescheduling. You also need to pass `participantNotification.notifyParticipants`
|
|
2960
|
-
* as `true` to actually send the message.
|
|
2961
|
-
*
|
|
2962
|
-
* In case the service has
|
|
2963
|
-
* variants, you can call this endpoint to update the booking's `totalParticipants` or `participantsChoices`.
|
|
2964
|
-
* If you provide `participantsChoices`, all of the provided choices must exist for
|
|
2965
|
-
* the service. Otherwise, the call returns an `INVALID_SERVICE_CHOICES` error.
|
|
2966
|
-
* If you omit `participantsChoices` in the request, the existing choices are
|
|
2967
|
-
* kept and not replaced with an empty object.
|
|
2968
|
-
*
|
|
2969
|
-
* <!-- INTERNAL PERMISSION COMMENT:
|
|
2970
|
-
* You need to have the `BOOKINGS.NUMBER_OF_PARTICIPANTS_UPDATE` permission
|
|
2971
|
-
* to reschedule bookings including `participantsInfo`.
|
|
2972
|
-
* <!--END: INTERNAL PERMISSION COMMENT-->
|
|
2973
|
-
*
|
|
2974
|
-
* In case you want to reschedule a booking on behalf of a customer, we recommend
|
|
2975
|
-
* to pass `flowControlSettings.ignoreReschedulePolicy` as `false`. This
|
|
2976
|
-
* ensures that the rescheduling is validated against the service's rescheduling
|
|
2977
|
-
* policy.
|
|
2978
|
-
* @param bookingId - ID of the booking to reschedule.
|
|
2979
|
-
* @param slot - Information about the new slot.
|
|
2980
|
-
* @public
|
|
2981
|
-
* @documentationMaturity preview
|
|
2982
|
-
* @requiredField bookingId
|
|
2983
|
-
* @requiredField options.revision
|
|
2984
|
-
* @requiredField slot
|
|
2985
|
-
* @param options - An object representing the available options for rescheduling a booking.
|
|
2986
|
-
* @permissionScope Manage Bookings
|
|
2987
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2988
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2989
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2990
|
-
* @applicableIdentity APP
|
|
2991
|
-
* @applicableIdentity MEMBER
|
|
2992
|
-
*/
|
|
2993
|
-
export declare function rescheduleBooking(bookingId: string, slot: V2Slot, options?: RescheduleBookingOptions): Promise<RescheduleBookingResponse & RescheduleBookingResponseNonNullableFields>;
|
|
2994
|
-
export interface RescheduleBookingOptions extends RescheduleBookingRequestParticipantsInfoOneOf {
|
|
2995
|
-
/**
|
|
2996
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2997
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
2998
|
-
* managing the booking.
|
|
2999
|
-
*/
|
|
3000
|
-
revision: string | null;
|
|
3001
|
-
/**
|
|
3002
|
-
* Information about whether to notify the customer about the rescheduling and
|
|
3003
|
-
* the message to send.
|
|
3004
|
-
*/
|
|
3005
|
-
participantNotification?: ParticipantNotification;
|
|
3006
|
-
/**
|
|
3007
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
3008
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
3009
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
3010
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
3011
|
-
*/
|
|
3012
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
3013
|
-
/**
|
|
3014
|
-
* Total number of participants. Available only for services with
|
|
3015
|
-
* variants.
|
|
3016
|
-
* Pass when all participants book the same variant.
|
|
3017
|
-
*/
|
|
3018
|
-
totalParticipants?: number;
|
|
3019
|
-
/**
|
|
3020
|
-
* Information about the service choices to book. Available only for services with
|
|
3021
|
-
* variants.
|
|
3022
|
-
* Pass when not all participants book the same variant.
|
|
3023
|
-
*/
|
|
3024
|
-
participantsChoices?: ParticipantChoices;
|
|
3025
|
-
}
|
|
3026
|
-
/**
|
|
3027
|
-
* Confirms a booking request and changes the booking status to `CONFIRMED`.
|
|
3028
|
-
*
|
|
3029
|
-
*
|
|
3030
|
-
* Calling this method doesn't check whether a slot or schedule is still
|
|
3031
|
-
* available at this time.
|
|
3032
|
-
*
|
|
3033
|
-
* You can only confirm bookings for services that require the owner's manual
|
|
3034
|
-
* approval for bookings and that have a status of `PENDING`.
|
|
3035
|
-
*
|
|
3036
|
-
* For appointment services the slot may become unavailable, depending on the
|
|
3037
|
-
* [service's](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business)
|
|
3038
|
-
* `policy.bookingApprovalPolicy.requestsAffectsAvailability`.
|
|
3039
|
-
*
|
|
3040
|
-
* Calling this method also changes the
|
|
3041
|
-
* [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
|
|
3042
|
-
* `participants.approvalStatus` to `APPROVED`.
|
|
3043
|
-
*
|
|
3044
|
-
* You can pass a `participantNotification.message` to notify the customer of
|
|
3045
|
-
* the confirmation. You also need to pass `participantNotification.notifyParticipants`
|
|
3046
|
-
* as `true` to actually send the message.
|
|
3047
|
-
*
|
|
3048
|
-
* Bookings are automatically confirmed when the
|
|
3049
|
-
* service is configured to automatically confirm
|
|
3050
|
-
* bookings and the [eCommerce order](https://www.wix.com/velo/reference/wix-ecom-backend/orders)
|
|
3051
|
-
* has been approved. The slot's or schedule's availability is checked just
|
|
3052
|
-
* before confirming the booking as part of the automatic flow.
|
|
3053
|
-
* @param bookingId - ID of the booking to confirm.
|
|
3054
|
-
* @param revision - Revision number, which increments by 1 each time the booking is updated.
|
|
3055
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
3056
|
-
* managing the booking.
|
|
3057
|
-
* @public
|
|
3058
|
-
* @documentationMaturity preview
|
|
3059
|
-
* @requiredField bookingId
|
|
3060
|
-
* @requiredField revision
|
|
3061
|
-
* @param options - An object representing the available options for canceling a booking.
|
|
3062
|
-
* @permissionScope Manage Bookings
|
|
3063
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3064
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3065
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3066
|
-
* @applicableIdentity APP
|
|
3067
|
-
*/
|
|
3068
|
-
export declare function confirmBooking(bookingId: string, revision: string | null, options?: ConfirmBookingOptions): Promise<ConfirmBookingResponse & ConfirmBookingResponseNonNullableFields>;
|
|
3069
|
-
export interface ConfirmBookingOptions {
|
|
3070
|
-
/**
|
|
3071
|
-
* Information about whether to notify the customer about the confirmation and
|
|
3072
|
-
* the message to send.
|
|
3073
|
-
*/
|
|
3074
|
-
participantNotification?: ParticipantNotification;
|
|
3075
|
-
/**
|
|
3076
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
3077
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
3078
|
-
*/
|
|
3079
|
-
sendSmsReminder?: boolean | null;
|
|
3080
|
-
/**
|
|
3081
|
-
* Payment status to set for the booking.
|
|
3082
|
-
* One of:
|
|
3083
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
3084
|
-
* - `"PAID"` The booking is fully paid.
|
|
3085
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
3086
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
3087
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
3088
|
-
*/
|
|
3089
|
-
paymentStatus?: PaymentStatus;
|
|
3090
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
3091
|
-
doubleBooked?: boolean | null;
|
|
3092
|
-
/**
|
|
3093
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
3094
|
-
* creation flow are changed. For example, whether the availability is
|
|
3095
|
-
* checked before confirming the booking.
|
|
3096
|
-
*/
|
|
3097
|
-
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
3098
|
-
}
|
|
3099
|
-
/**
|
|
3100
|
-
* Updates the extended fields for a booking.
|
|
3101
|
-
*
|
|
3102
|
-
*
|
|
3103
|
-
* Extended fields must first be configured in the Wix Developers Center.
|
|
3104
|
-
*
|
|
3105
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
3106
|
-
* @param _id - ID of the entity to update.
|
|
3107
|
-
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
3108
|
-
* @public
|
|
3109
|
-
* @documentationMaturity preview
|
|
3110
|
-
* @requiredField _id
|
|
3111
|
-
* @requiredField namespace
|
|
3112
|
-
* @requiredField options
|
|
3113
|
-
* @requiredField options.namespaceData
|
|
3114
|
-
* @permissionScope Manage Bookings
|
|
3115
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3116
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3117
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3118
|
-
* @applicableIdentity APP
|
|
3119
|
-
*/
|
|
3120
|
-
export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
|
|
3121
|
-
export interface UpdateExtendedFieldsOptions {
|
|
3122
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3123
|
-
namespaceData: Record<string, any> | null;
|
|
3124
|
-
}
|
|
3125
|
-
/**
|
|
3126
|
-
* Declines a `PENDING` booking request and changes the booking status to
|
|
3127
|
-
* `DECLINED`.
|
|
3128
|
-
*
|
|
3129
|
-
* Calling this method also changes the
|
|
3130
|
-
* [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
|
|
3131
|
-
* `participants.approvalStatus` to `DECLINED`.
|
|
3132
|
-
*
|
|
3133
|
-
* You can only decline bookings for services that require the owner's manual
|
|
3134
|
-
* approval for bookings and that have a status of `PENDING`.
|
|
3135
|
-
*
|
|
3136
|
-
* You can pass a `participantNotification.message` to notify the customer of
|
|
3137
|
-
* the decline. You also need to pass `participantNotification.notifyParticipants`
|
|
3138
|
-
* as `true` to actually send the message.
|
|
3139
|
-
* @param bookingId - ID of the booking to decline.
|
|
3140
|
-
* @param revision - Revision number, which increments by 1 each time the booking is updated.
|
|
3141
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
3142
|
-
* managing the booking.
|
|
3143
|
-
* @public
|
|
3144
|
-
* @documentationMaturity preview
|
|
3145
|
-
* @requiredField bookingId
|
|
3146
|
-
* @requiredField revision
|
|
3147
|
-
* @param options - An object representing the available options for declining a booking.
|
|
3148
|
-
* @permissionScope Manage Bookings
|
|
3149
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3150
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3151
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3152
|
-
* @applicableIdentity APP
|
|
3153
|
-
*/
|
|
3154
|
-
export declare function declineBooking(bookingId: string, revision: string | null, options?: DeclineBookingOptions): Promise<DeclineBookingResponse & DeclineBookingResponseNonNullableFields>;
|
|
3155
|
-
export interface DeclineBookingOptions {
|
|
3156
|
-
/**
|
|
3157
|
-
* Information about whether to notify the customer about the decline and
|
|
3158
|
-
* the message to send.
|
|
3159
|
-
*/
|
|
3160
|
-
participantNotification?: ParticipantNotification;
|
|
3161
|
-
/**
|
|
3162
|
-
* Payment status to set on the booking.
|
|
3163
|
-
* One of:
|
|
3164
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
3165
|
-
* - `"PAID"` The booking is fully paid.
|
|
3166
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
3167
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
3168
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
3169
|
-
*/
|
|
3170
|
-
paymentStatus?: PaymentStatus;
|
|
3171
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
3172
|
-
doubleBooked?: boolean | null;
|
|
3173
|
-
}
|
|
3174
|
-
/**
|
|
3175
|
-
* Cancels a booking.
|
|
3176
|
-
*
|
|
3177
|
-
*
|
|
3178
|
-
* The booking status changes to `CANCELED`.
|
|
3179
|
-
*
|
|
3180
|
-
* If the booking was for an appointment, the corresponding session is
|
|
3181
|
-
* deleted from the business calendar.
|
|
3182
|
-
*
|
|
3183
|
-
* If the booking was for a class or course, the participants are removed
|
|
3184
|
-
* from the class session or the course. But the course or class session
|
|
3185
|
-
* remains on the business calendar.
|
|
3186
|
-
*
|
|
3187
|
-
* You can pass a `participantNotification.message` to notify the customer of
|
|
3188
|
-
* the cancelation. You also need to pass `participantNotification.notifyParticipants`
|
|
3189
|
-
* as `true` to actually send the message.
|
|
3190
|
-
*
|
|
3191
|
-
* In case you want to cancel a booking on behalf of a customer, we recommend
|
|
3192
|
-
* to pass `flowControlSettings.ignoreCancellationPolicy` as `false`. This
|
|
3193
|
-
* ensures that the cancelation is validated against the service's cancelation
|
|
3194
|
-
* policy.
|
|
3195
|
-
* @param bookingId - ID of the booking to cancel.
|
|
3196
|
-
* @public
|
|
3197
|
-
* @documentationMaturity preview
|
|
3198
|
-
* @requiredField bookingId
|
|
3199
|
-
* @requiredField options.revision
|
|
3200
|
-
* @param options - An object representing the available options for canceling a booking.
|
|
3201
|
-
* @permissionScope Manage Bookings
|
|
3202
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3203
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3204
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3205
|
-
* @applicableIdentity APP
|
|
3206
|
-
* @applicableIdentity MEMBER
|
|
3207
|
-
*/
|
|
3208
|
-
export declare function cancelBooking(bookingId: string, options?: CancelBookingOptions): Promise<CancelBookingResponse & CancelBookingResponseNonNullableFields>;
|
|
3209
|
-
export interface CancelBookingOptions {
|
|
3210
|
-
/**
|
|
3211
|
-
* Information about whether to notify the customer about the cancelation and
|
|
3212
|
-
* the message to send.
|
|
3213
|
-
*/
|
|
3214
|
-
participantNotification?: ParticipantNotification;
|
|
3215
|
-
/**
|
|
3216
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
3217
|
-
* cancelation flow are changed. For example, whether the you can cancel
|
|
3218
|
-
* a booking even though the cancelation policy doesn't allow it or whether
|
|
3219
|
-
* to issue a refund.
|
|
3220
|
-
*/
|
|
3221
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
3222
|
-
/**
|
|
3223
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
3224
|
-
* To prevent conflicting changes,
|
|
3225
|
-
* the current revision must be passed when managing the booking.
|
|
3226
|
-
*/
|
|
3227
|
-
revision: string | null;
|
|
3228
|
-
}
|
|
3229
|
-
/**
|
|
3230
|
-
* Updates the number of participants for a booking.
|
|
3231
|
-
*
|
|
3232
|
-
*
|
|
3233
|
-
* You can only update the number of participants for class and course
|
|
3234
|
-
* bookings, you can't update it for appointment bookings.
|
|
3235
|
-
*
|
|
3236
|
-
* Calling this method also changes the
|
|
3237
|
-
* [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
|
|
3238
|
-
* `totalNumberOfParticipants`.
|
|
3239
|
-
*
|
|
3240
|
-
* When updating the number of participants for a booking you must pass either
|
|
3241
|
-
* `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`
|
|
3242
|
-
* for services that have variants,
|
|
3243
|
-
* all of the provided choices must exist for the service. Otherwise, the
|
|
3244
|
-
* call returns an `INVALID_SERVICE_CHOICES` error.
|
|
3245
|
-
* @param bookingId - ID of the booking to update the number of participants for.
|
|
3246
|
-
* @public
|
|
3247
|
-
* @documentationMaturity preview
|
|
3248
|
-
* @requiredField bookingId
|
|
3249
|
-
* @requiredField options.revision
|
|
3250
|
-
* @permissionScope Manage Bookings
|
|
3251
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3252
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3253
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3254
|
-
* @applicableIdentity APP
|
|
3255
|
-
*/
|
|
3256
|
-
export declare function updateNumberOfParticipants(bookingId: string, options?: UpdateNumberOfParticipantsOptions): Promise<UpdateNumberOfParticipantsResponse & UpdateNumberOfParticipantsResponseNonNullableFields>;
|
|
3257
|
-
export interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
3258
|
-
/**
|
|
3259
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
3260
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
3261
|
-
* managing the booking.
|
|
3262
|
-
*/
|
|
3263
|
-
revision: string | null;
|
|
3264
|
-
/**
|
|
3265
|
-
* Total number of participants. Available only for services with
|
|
3266
|
-
* variants.
|
|
3267
|
-
* Pass when all participants book the same variant.
|
|
3268
|
-
*/
|
|
3269
|
-
totalParticipants?: number;
|
|
3270
|
-
/**
|
|
3271
|
-
* Information about the service choices to book. Available only for services with
|
|
3272
|
-
* variants.
|
|
3273
|
-
* Pass when not all participants book the same variant.
|
|
3274
|
-
*/
|
|
3275
|
-
participantsChoices?: ParticipantChoices;
|
|
3276
|
-
}
|
|
3277
|
-
/**
|
|
3278
|
-
* Use `confirmOrDeclineBooking()` to determine if the booking is valid, payment is received, and the booking can be processed.
|
|
3279
|
-
* Call `confirmOrDeclineBooking()` after checkout or after calling `createBooking()` to verify the booking.
|
|
3280
|
-
*
|
|
3281
|
-
* + If a session is valid and payment is received, the booking is visible on the calendar.
|
|
3282
|
-
* + If a session is double booked, `confirmOrDeclineBooking()` can catch this and decline the duplicate booking, the booking is not visible on the calendar.
|
|
3283
|
-
* @param bookingId - ID of the booking to confirm or decline.
|
|
3284
|
-
* @public
|
|
3285
|
-
* @documentationMaturity preview
|
|
3286
|
-
* @requiredField bookingId
|
|
3287
|
-
* @permissionScope Manage Bookings
|
|
3288
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3289
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3290
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3291
|
-
* @applicableIdentity APP
|
|
3292
|
-
*/
|
|
3293
|
-
export declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise<ConfirmOrDeclineBookingResponse & ConfirmOrDeclineBookingResponseNonNullableFields>;
|
|
3294
|
-
export interface ConfirmOrDeclineBookingOptions {
|
|
3295
|
-
/** Current payment status of the booking. */
|
|
3296
|
-
paymentStatus?: PaymentStatus;
|
|
3297
|
-
}
|
|
3298
|
-
/**
|
|
3299
|
-
* Confirm or decline multiple bookings.
|
|
3300
|
-
* See [Confirm Or Decline Booking] (https://dev.wix.com/api/rest/wix-bookings/confirmation/confirm-or-decline-booking) documentation.
|
|
3301
|
-
* @param details - The bookings to confirm or decline.
|
|
3302
|
-
* @public
|
|
3303
|
-
* @documentationMaturity preview
|
|
3304
|
-
* @requiredField details
|
|
3305
|
-
* @requiredField details.bookingId
|
|
3306
|
-
* @permissionScope Manage Bookings
|
|
3307
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3308
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3309
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3310
|
-
* @applicableIdentity APP
|
|
3311
|
-
*/
|
|
3312
|
-
export declare function bulkConfirmOrDeclineBooking(details: BulkConfirmOrDeclineBookingRequestBookingDetails[], options?: BulkConfirmOrDeclineBookingOptions): Promise<BulkConfirmOrDeclineBookingResponse & BulkConfirmOrDeclineBookingResponseNonNullableFields>;
|
|
3313
|
-
export interface BulkConfirmOrDeclineBookingOptions {
|
|
3314
|
-
/**
|
|
3315
|
-
* Whether to return the confirmed or declined bookings entities.
|
|
3316
|
-
* Not supported yet, currently the entity is not returned.
|
|
3317
|
-
*/
|
|
3318
|
-
returnEntity?: boolean;
|
|
3319
|
-
}
|