@wix/auto_sdk_bookings_bookings 1.0.89 → 1.0.90
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/index.d.ts +490 -490
- package/build/cjs/index.js +931 -931
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2376 -2460
- package/build/cjs/index.typings.js +803 -803
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1346 -1410
- package/build/cjs/meta.js +646 -646
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +490 -490
- package/build/es/index.mjs +931 -931
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2376 -2460
- package/build/es/index.typings.mjs +803 -803
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1346 -1410
- package/build/es/meta.mjs +646 -646
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +490 -490
- package/build/internal/cjs/index.js +931 -931
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2381 -2465
- package/build/internal/cjs/index.typings.js +803 -803
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1346 -1410
- package/build/internal/cjs/meta.js +646 -646
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +490 -490
- package/build/internal/es/index.mjs +931 -931
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2381 -2465
- package/build/internal/es/index.typings.mjs +803 -803
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1346 -1410
- package/build/internal/es/meta.mjs +646 -646
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,46 +1,7 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export { ActionEvent, Actor, ActorWithLiterals, AddBookingsToMultiServiceBookingRequest, Address, AddressLocation, AddressStreetOneOf, AllowedActions, AllowedActionsAnonymously, AnonymousBookingUrls, ApplicationError, AvailableResources, BaseEventMetadata, BookedAddOn, BookedEntity, BookedEntityItemOneOf, BookedResource, BookedSchedule, BookedSlot, BookingCanceled, BookingChanged, BookingConfirmed, BookingDeclined, BookingDetails, BookingFormFilled, BookingIdAndRevision, BookingInfo, BookingMarkedAsPending, BookingParticipantsInfoOneOf, BookingPolicySettings, BookingPolicyViolations, BookingRescheduled, BookingRescheduledPreviousParticipantsInfoOneOf, BookingResult, BookingSource, BookingStatus, BookingStatusWithLiterals, BulkActionMetadata, BulkBookingResult, BulkCalculateAllowedActionsRequest, BulkCalculateAllowedActionsResponse, BulkCalculateAllowedActionsResult, BulkConfirmOrDeclineBookingRequest, BulkCreateBookingRequest, BulkGetMultiServiceBookingAllowedActionsRequest, BulkRescheduleBookingRequest, BulkRescheduleBookingRequestBooking, BulkRescheduleBookingResponse, BulkUpdateBookedScheduleRequest, BulkUpdateBookedScheduleResponse, BulkUpdateBookingRequest, BulkUpdateBookingResponse, CancelBookingAnonymouslyRequest, CancelBookingFlowControlSettings, CancelBookingRequest, CancelBookingRequestFlowControlSettings, CancelMultiServiceBookingRequest, Clash, CommonIdentificationData, CommonIdentificationDataIdOneOf, ConfirmBookingFlowControlSettings, ConfirmBookingRequest, ConfirmMultiServiceBookingRequest, ConfirmOrDeclineBookingRequest, ConfirmRequest, ConfirmResponse, ConsistentQueryBookingsRequest, ConsistentQueryBookingsResponse, ContactDetails, CountBookingsRequest, CountBookingsResponse, CreateBookingFlowControlSettings, CreateBookingRequest, CreateBookingRequestFlowControlSettings, CreateMultiServiceBookingRequest, CursorPaging, Cursors, CustomFormField, DeclineBookingFlowControlSettings, DeclineBookingRequest, DeclineMultiServiceBookingRequest, DomainEvent, DomainEventBodyOneOf, Duration, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FlowControlSettings, GetAnonymousActionDetailsRequest, GetBookingAnonymouslyRequest, GetMultiServiceBookingAvailabilityRequest, GetMultiServiceBookingAvailabilityResponseBookingInfo, GetMultiServiceBookingRequest, GetMultiServiceBookingResponse, GetScheduleAvailabilityRequest, GetScheduleAvailabilityResponse, GetSlotAvailabilityRequest, GetSlotAvailabilityResponse, IdentificationData, IdentificationDataIdOneOf, IdentificationDataIdentityType, IdentificationDataIdentityTypeWithLiterals, IdentityType, IdentityTypeWithLiterals, ItemMetadata, LegacyCreateBookingRequest, LegacyCreateBookingResponse, Location, LocationLocationType, LocationLocationTypeWithLiterals, LocationType, LocationTypeWithLiterals, MarkBookingAsPendingFlowControlSettings, MarkBookingAsPendingRequest, MarkMultiServiceBookingAsPendingRequest, MaskedBooking, MessageEnvelope, MigrationCheckIfClashesWithBlockedTimeRequest, MigrationCheckIfClashesWithBlockedTimeResponse, MsidAndBookingId, MultiServiceBookingInfo, MultiServiceBookingMetadata, MultiServiceBookingType, MultiServiceBookingTypeWithLiterals, NumberOfParticipantsUpdated, NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf, Paging, PagingMetadataV2, ParticipantChoices, ParticipantNotification, PaymentStatus, PaymentStatusWithLiterals, PhoneCall, Platform, PlatformWithLiterals, QueryBookingsRequest, QueryBookingsResponse, QueryV2, QueryV2PagingMethodOneOf, RemoveBookingsFromMultiServiceBookingRequest, RescheduleBookingAnonymouslyRequest, RescheduleBookingFlowControlSettings, RescheduleBookingInfoParticipantsInfoOneOf, RescheduleBookingOptionsParticipantsInfoOneOf, RescheduleBookingRequest, RescheduleBookingRequestFlowControlSettings, RescheduleBookingRequestParticipantsInfoOneOf, RescheduleMultiServiceBookingRequest, ResourceSelection, RestoreInfo, ScheduleAvailability, SelectedPaymentOption, SelectedPaymentOptionWithLiterals, SelectionMethod, SelectionMethodWithLiterals, ServiceChoice, ServiceChoiceChoiceOneOf, ServiceChoices,
|
|
2
|
+
import { ConfirmOrDeclineBookingOptions, ConfirmOrDeclineBookingResponse, ConfirmOrDeclineBookingApplicationErrors, BulkConfirmOrDeclineBookingRequestBookingDetails, BulkConfirmOrDeclineBookingOptions, BulkConfirmOrDeclineBookingResponse, BulkConfirmOrDeclineBookingApplicationErrors, Booking, CreateMultiServiceBookingOptions, CreateMultiServiceBookingResponse, CreateMultiServiceBookingApplicationErrors, RescheduleBookingInfo, RescheduleMultiServiceBookingOptions, RescheduleMultiServiceBookingResponse, RescheduleMultiServiceBookingApplicationErrors, GetMultiServiceBookingAvailabilityResponse, GetMultiServiceBookingAvailabilityApplicationErrors, CancelMultiServiceBookingOptions, CancelMultiServiceBookingResponse, CancelMultiServiceBookingApplicationErrors, MarkMultiServiceBookingAsPendingOptions, MarkMultiServiceBookingAsPendingResponse, MarkMultiServiceBookingAsPendingApplicationErrors, ConfirmMultiServiceBookingOptions, ConfirmMultiServiceBookingResponse, ConfirmMultiServiceBookingApplicationErrors, DeclineMultiServiceBookingOptions, DeclineMultiServiceBookingResponse, DeclineMultiServiceBookingApplicationErrors, BulkGetMultiServiceBookingAllowedActionsResponse, MultiServiceBooking, AddBookingsToMultiServiceBookingOptions, AddBookingsToMultiServiceBookingResponse, AddBookingsToMultiServiceBookingApplicationErrors, RemoveBookingsFromMultiServiceBookingOptions, RemoveBookingsFromMultiServiceBookingResponse, RemoveBookingsFromMultiServiceBookingApplicationErrors, CreateBookingOptions, CreateBookingResponse, CreateBookingApplicationErrors, CreateBookingInfo, BulkCreateBookingOptions, BulkCreateBookingResponse, BulkCreateBookingApplicationErrors, V2Slot, RescheduleBookingOptions, RescheduleBookingResponse, RescheduleBookingApplicationErrors, ConfirmBookingOptions, ConfirmBookingResponse, ConfirmBookingApplicationErrors, SetBookingSubmissionIdResponse, SetBookingSubmissionIdApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateExtendedFieldsApplicationErrors, DeclineBookingOptions, DeclineBookingResponse, DeclineBookingApplicationErrors, CancelBookingOptions, CancelBookingResponse, CancelBookingApplicationErrors, UpdateNumberOfParticipantsOptions, UpdateNumberOfParticipantsResponse, UpdateNumberOfParticipantsApplicationErrors, MarkBookingAsPendingOptions, MarkBookingAsPendingResponse, MarkBookingAsPendingApplicationErrors, GetAnonymousActionDetailsOptions, GetAnonymousActionDetailsResponse, CancelBookingAnonymouslyOptions, CancelBookingAnonymouslyResponse, RescheduleBookingAnonymouslyOptions, RescheduleBookingAnonymouslyResponse, GetBookingAnonymouslyResponse, BookingCanceledEnvelope, BookingConfirmedEnvelope, BookingCreatedEnvelope, BookingDeclinedEnvelope, BookingRescheduledEnvelope, BookingUpdatedEnvelope, BookingNumberOfParticipantsUpdatedEnvelope } from './index.typings.js';
|
|
3
|
+
export { ActionEvent, Actor, ActorWithLiterals, AddBookingsToMultiServiceBookingRequest, Address, AddressLocation, AddressStreetOneOf, AllowedActions, AllowedActionsAnonymously, AnonymousBookingUrls, ApplicationError, AvailableResources, BaseEventMetadata, BookedAddOn, BookedEntity, BookedEntityItemOneOf, BookedResource, BookedSchedule, BookedSlot, BookingCanceled, BookingChanged, BookingConfirmed, BookingDeclined, BookingDetails, BookingFormFilled, BookingIdAndRevision, BookingInfo, BookingMarkedAsPending, BookingParticipantsInfoOneOf, BookingPolicySettings, BookingPolicyViolations, BookingRescheduled, BookingRescheduledPreviousParticipantsInfoOneOf, BookingResult, BookingSource, BookingStatus, BookingStatusWithLiterals, BulkActionMetadata, BulkBookingResult, BulkCalculateAllowedActionsRequest, BulkCalculateAllowedActionsResponse, BulkCalculateAllowedActionsResult, BulkConfirmOrDeclineBookingRequest, BulkCreateBookingRequest, BulkGetMultiServiceBookingAllowedActionsRequest, BulkRescheduleBookingRequest, BulkRescheduleBookingRequestBooking, BulkRescheduleBookingResponse, BulkUpdateBookedScheduleRequest, BulkUpdateBookedScheduleResponse, BulkUpdateBookingRequest, BulkUpdateBookingResponse, CancelBookingAnonymouslyRequest, CancelBookingFlowControlSettings, CancelBookingRequest, CancelBookingRequestFlowControlSettings, CancelMultiServiceBookingRequest, Clash, CommonIdentificationData, CommonIdentificationDataIdOneOf, ConfirmBookingFlowControlSettings, ConfirmBookingRequest, ConfirmMultiServiceBookingRequest, ConfirmOrDeclineBookingRequest, ConfirmRequest, ConfirmResponse, ConsistentQueryBookingsRequest, ConsistentQueryBookingsResponse, ContactDetails, CountBookingsRequest, CountBookingsResponse, CreateBookingFlowControlSettings, CreateBookingRequest, CreateBookingRequestFlowControlSettings, CreateMultiServiceBookingRequest, CursorPaging, Cursors, CustomFormField, DeclineBookingFlowControlSettings, DeclineBookingRequest, DeclineMultiServiceBookingRequest, DomainEvent, DomainEventBodyOneOf, Duration, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FlowControlSettings, GetAnonymousActionDetailsRequest, GetBookingAnonymouslyRequest, GetMultiServiceBookingAvailabilityRequest, GetMultiServiceBookingAvailabilityResponseBookingInfo, GetMultiServiceBookingRequest, GetMultiServiceBookingResponse, GetScheduleAvailabilityRequest, GetScheduleAvailabilityResponse, GetSlotAvailabilityRequest, GetSlotAvailabilityResponse, IdentificationData, IdentificationDataIdOneOf, IdentificationDataIdentityType, IdentificationDataIdentityTypeWithLiterals, IdentityType, IdentityTypeWithLiterals, ItemMetadata, LegacyCreateBookingRequest, LegacyCreateBookingResponse, Location, LocationLocationType, LocationLocationTypeWithLiterals, LocationType, LocationTypeWithLiterals, MarkBookingAsPendingFlowControlSettings, MarkBookingAsPendingRequest, MarkMultiServiceBookingAsPendingRequest, MaskedBooking, MessageEnvelope, MigrationCheckIfClashesWithBlockedTimeRequest, MigrationCheckIfClashesWithBlockedTimeResponse, MsidAndBookingId, MultiServiceBookingInfo, MultiServiceBookingMetadata, MultiServiceBookingType, MultiServiceBookingTypeWithLiterals, NumberOfParticipantsUpdated, NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf, Paging, PagingMetadataV2, ParticipantChoices, ParticipantNotification, PaymentStatus, PaymentStatusWithLiterals, PhoneCall, Platform, PlatformWithLiterals, QueryBookingsRequest, QueryBookingsResponse, QueryV2, QueryV2PagingMethodOneOf, RemoveBookingsFromMultiServiceBookingRequest, RescheduleBookingAnonymouslyRequest, RescheduleBookingFlowControlSettings, RescheduleBookingInfoParticipantsInfoOneOf, RescheduleBookingOptionsParticipantsInfoOneOf, RescheduleBookingRequest, RescheduleBookingRequestFlowControlSettings, RescheduleBookingRequestParticipantsInfoOneOf, RescheduleMultiServiceBookingRequest, ResourceSelection, RestoreInfo, ScheduleAvailability, SelectedPaymentOption, SelectedPaymentOptionWithLiterals, SelectionMethod, SelectionMethodWithLiterals, ServiceChoice, ServiceChoiceChoiceOneOf, ServiceChoices, SetBookingSessionIdRequest, SetBookingSessionIdResponse, SetBookingSubmissionIdRequest, Slot, SlotAvailability, SlotBookings, SlotLocation, SlotResource, SlotSlotResource, SortOrder, SortOrderWithLiterals, Sorting, StreetAddress, Subdivision, UpdateBookingRequest, UpdateBookingResponse, UpdateExtendedFieldsRequest, UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf, UpdateNumberOfParticipantsRequest, UpdateNumberOfParticipantsRequestParticipantsInfoOneOf, V2CancelBookingRequest, V2CancelBookingResponse, V2ConfirmBookingRequest, V2ConfirmBookingResponse, V2CreateBookingRequest, V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf, V2CreateBookingResponse, V2DeclineBookingRequest, V2DeclineBookingResponse, V2PhoneCall, V2RescheduleBookingRequest, V2RescheduleBookingRequestParticipantsInfoOneOf, V2RescheduleBookingResponse, V2UpdateNumberOfParticipantsRequest, V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf, V2UpdateNumberOfParticipantsResponse, ValueType, ValueTypeWithLiterals, WaitingList, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WebhooksIdentificationData, WebhooksIdentificationDataIdOneOf } from './index.typings.js';
|
|
4
4
|
|
|
5
|
-
declare function getAnonymousActionDetails$1(httpClient: HttpClient): GetAnonymousActionDetailsSignature;
|
|
6
|
-
interface GetAnonymousActionDetailsSignature {
|
|
7
|
-
/**
|
|
8
|
-
* Returns booking details related to AnonymousActions
|
|
9
|
-
* Anonymous tokens for getting, canceling or rescheduling the booking.
|
|
10
|
-
* That token is symmetrically encrypted and Url-safe.
|
|
11
|
-
* That allows the UoU to cancel or reschedule without Authentication.
|
|
12
|
-
* @returns Response for GetAnonymousActionDetails
|
|
13
|
-
*/
|
|
14
|
-
(options?: GetAnonymousActionDetailsOptions): Promise<GetAnonymousActionDetailsResponse>;
|
|
15
|
-
}
|
|
16
|
-
declare function cancelBookingAnonymously$1(httpClient: HttpClient): CancelBookingAnonymouslySignature;
|
|
17
|
-
interface CancelBookingAnonymouslySignature {
|
|
18
|
-
/**
|
|
19
|
-
* Cancel booking using an anonymous token
|
|
20
|
-
* @param - The token provided in the booking links for anonymous access
|
|
21
|
-
* @returns Response for CancelBookingAnonymously
|
|
22
|
-
*/
|
|
23
|
-
(token: string, options?: CancelBookingAnonymouslyOptions): Promise<NonNullablePaths<CancelBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7>>;
|
|
24
|
-
}
|
|
25
|
-
declare function rescheduleBookingAnonymously$1(httpClient: HttpClient): RescheduleBookingAnonymouslySignature;
|
|
26
|
-
interface RescheduleBookingAnonymouslySignature {
|
|
27
|
-
/**
|
|
28
|
-
* Reschedule booking using an anonymous token
|
|
29
|
-
* @param - The token provided in the booking links for anonymous access
|
|
30
|
-
* @param - New slot of the booking.
|
|
31
|
-
* @returns Response for RescheduleBookingAnonymously
|
|
32
|
-
*/
|
|
33
|
-
(token: string, slot: V2Slot, options: NonNullablePaths<RescheduleBookingAnonymouslyOptions, `revision`, 2>): Promise<NonNullablePaths<RescheduleBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7>>;
|
|
34
|
-
}
|
|
35
|
-
declare function getBookingAnonymously$1(httpClient: HttpClient): GetBookingAnonymouslySignature;
|
|
36
|
-
interface GetBookingAnonymouslySignature {
|
|
37
|
-
/**
|
|
38
|
-
* Get booking using an anonymous token
|
|
39
|
-
* @param - The token provided in the booking links for anonymous access
|
|
40
|
-
* @returns Response for GetBookingAnonymously
|
|
41
|
-
*/
|
|
42
|
-
(token: string): Promise<NonNullablePaths<GetBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId` | `allowedActionsAnonymously.cancel` | `allowedActionsAnonymously.reschedule`, 7>>;
|
|
43
|
-
}
|
|
44
5
|
declare function confirmOrDeclineBooking$1(httpClient: HttpClient): ConfirmOrDeclineBookingSignature;
|
|
45
6
|
interface ConfirmOrDeclineBookingSignature {
|
|
46
7
|
/**
|
|
@@ -102,162 +63,440 @@ interface BulkConfirmOrDeclineBookingSignature {
|
|
|
102
63
|
__applicationErrorsType?: BulkConfirmOrDeclineBookingApplicationErrors;
|
|
103
64
|
}>;
|
|
104
65
|
}
|
|
105
|
-
declare function
|
|
106
|
-
interface
|
|
66
|
+
declare function createMultiServiceBooking$1(httpClient: HttpClient): CreateMultiServiceBookingSignature;
|
|
67
|
+
interface CreateMultiServiceBookingSignature {
|
|
107
68
|
/**
|
|
108
|
-
* Creates a booking.
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
* ### Appointment booking
|
|
112
|
-
*
|
|
113
|
-
* For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
|
|
114
|
-
*
|
|
115
|
-
* We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
|
|
116
|
-
* Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
|
|
69
|
+
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
117
70
|
*
|
|
118
|
-
* ### Class session booking
|
|
119
71
|
*
|
|
120
|
-
*
|
|
72
|
+
* ### When to call this method
|
|
121
73
|
*
|
|
122
|
-
*
|
|
123
|
-
* Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
|
|
74
|
+
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call [Add Bookings to Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) instead.
|
|
124
75
|
*
|
|
125
|
-
*
|
|
76
|
+
* ### Requirements and behavior
|
|
126
77
|
*
|
|
127
|
-
*
|
|
78
|
+
* __Package constraints__: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
|
|
128
79
|
*
|
|
129
|
-
*
|
|
130
|
-
* We recommend following [this sample flow](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course)
|
|
131
|
-
* to minimize failed calls due to unavailability.
|
|
80
|
+
* __Timing specification__: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
|
|
132
81
|
*
|
|
133
|
-
*
|
|
82
|
+
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) if the customer paid via an [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
134
83
|
*
|
|
135
|
-
*
|
|
84
|
+
* __Package notifications__: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
|
|
136
85
|
*
|
|
137
|
-
*
|
|
86
|
+
* ### Related methods
|
|
138
87
|
*
|
|
139
|
-
*
|
|
88
|
+
* Verify availability first with [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots).
|
|
140
89
|
*
|
|
141
|
-
*
|
|
90
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) for more details about constraints and effects of creating single-service bookings.
|
|
91
|
+
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
142
92
|
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
93
|
+
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
94
|
+
* Specify contact details, number of participants, and any additional fields as needed.
|
|
145
95
|
*
|
|
146
|
-
*
|
|
96
|
+
* For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
|
|
97
|
+
*/
|
|
98
|
+
(bookings: NonNullablePaths<Booking, `additionalFields.${number}._id` | `bookedEntity` | `bookedEntity.slot` | `bookedEntity.slot.endDate` | `bookedEntity.slot.location.locationType` | `bookedEntity.slot.scheduleId` | `bookedEntity.slot.startDate`, 5>[], options?: CreateMultiServiceBookingOptions): Promise<NonNullablePaths<CreateMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
99
|
+
__applicationErrorsType?: CreateMultiServiceBookingApplicationErrors;
|
|
100
|
+
}>;
|
|
101
|
+
}
|
|
102
|
+
declare function rescheduleMultiServiceBooking$1(httpClient: HttpClient): RescheduleMultiServiceBookingSignature;
|
|
103
|
+
interface RescheduleMultiServiceBookingSignature {
|
|
104
|
+
/**
|
|
105
|
+
* Reschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package.
|
|
147
106
|
*
|
|
148
|
-
* When customers sign up for a service, they must fill out the [booking form](https://support.wix.com/en/article/wix-bookings-creating-and-setting-up-your-booking-forms).
|
|
149
|
-
* To create a booking with a completed booking form, specify the relevant data in `formSubmission`.
|
|
150
|
-
* Ensure the values of the corresponding fields in `booking.contactDetails` and `formSubmission` are identical.
|
|
151
|
-
* If these values don't match, Create Booking fails.
|
|
152
|
-
* Therefore, we recommend specifying only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
153
|
-
* Learn more about the [Bookings and Wix Forms integration](https://dev.wix.com/docs/rest/business-solutions/bookings/wix-forms-integration).
|
|
154
107
|
*
|
|
155
|
-
*
|
|
108
|
+
* This method reschedules single-service bookings within the multi-service booking while maintaining sequential order. You must specify exact new timing for each service to ensure they remain back-to-back with no gaps or overlaps.
|
|
156
109
|
*
|
|
157
|
-
* You must
|
|
158
|
-
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
159
|
-
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
110
|
+
* This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each single-service booking you're rescheduling to prevent conflicting changes.
|
|
160
111
|
*
|
|
161
|
-
*
|
|
112
|
+
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
113
|
+
* @param - ID of the multi-service booking to reschedule.
|
|
114
|
+
* @param - Information about the single-service bookings to reschedule.
|
|
115
|
+
*/
|
|
116
|
+
(multiServiceBookingId: string, rescheduleBookingsInfo: NonNullablePaths<RescheduleBookingInfo, `bookingId` | `revision` | `slot`, 2>[], options?: RescheduleMultiServiceBookingOptions): Promise<NonNullablePaths<RescheduleMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
117
|
+
__applicationErrorsType?: RescheduleMultiServiceBookingApplicationErrors;
|
|
118
|
+
}>;
|
|
119
|
+
}
|
|
120
|
+
declare function getMultiServiceBookingAvailability$1(httpClient: HttpClient): GetMultiServiceBookingAvailabilitySignature;
|
|
121
|
+
interface GetMultiServiceBookingAvailabilitySignature {
|
|
122
|
+
/**
|
|
123
|
+
* Checks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations.
|
|
162
124
|
*
|
|
163
|
-
* You can include [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) when creating a booking by specifying `bookedAddOns`.
|
|
164
|
-
* Each selected add-on must belong to an [add-on group](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-add-on-groups) associated with the service and respect the group's selection limits.
|
|
165
125
|
*
|
|
166
|
-
*
|
|
126
|
+
* Wix Bookings considers:
|
|
127
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
128
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
167
129
|
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
* to send the message.
|
|
130
|
+
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
131
|
+
* For example, staff changes, policy updates, or capacity modifications.
|
|
171
132
|
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
133
|
+
* For checking availability before creating new multi-service bookings, call [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) instead.
|
|
134
|
+
* @param - ID of the multi-service booking to retrieve.
|
|
135
|
+
*/
|
|
136
|
+
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`, 2> & {
|
|
137
|
+
__applicationErrorsType?: GetMultiServiceBookingAvailabilityApplicationErrors;
|
|
138
|
+
}>;
|
|
139
|
+
}
|
|
140
|
+
declare function cancelMultiServiceBooking$1(httpClient: HttpClient): CancelMultiServiceBookingSignature;
|
|
141
|
+
interface CancelMultiServiceBookingSignature {
|
|
142
|
+
/**
|
|
143
|
+
* Cancels a multi-service booking and all its associated single-service bookings.
|
|
174
144
|
*
|
|
175
|
-
* ### Payment options
|
|
176
145
|
*
|
|
177
|
-
*
|
|
146
|
+
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
147
|
+
* The call fails if all single-service bookings are already canceled or declined.
|
|
178
148
|
*
|
|
179
|
-
*
|
|
149
|
+
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
150
|
+
* @param - ID of the multi-service booking to cancel.
|
|
151
|
+
*/
|
|
152
|
+
(multiServiceBookingId: string, options?: CancelMultiServiceBookingOptions): Promise<NonNullablePaths<CancelMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
153
|
+
__applicationErrorsType?: CancelMultiServiceBookingApplicationErrors;
|
|
154
|
+
}>;
|
|
155
|
+
}
|
|
156
|
+
declare function markMultiServiceBookingAsPending$1(httpClient: HttpClient): MarkMultiServiceBookingAsPendingSignature;
|
|
157
|
+
interface MarkMultiServiceBookingAsPendingSignature {
|
|
158
|
+
/**
|
|
159
|
+
* Updates the status for all single-service bookings in a multi-service booking to `PENDING`.
|
|
180
160
|
*
|
|
181
|
-
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
182
161
|
*
|
|
183
|
-
*
|
|
162
|
+
* Call this method for multi-service bookings requiring manual business approval before confirmation.
|
|
184
163
|
*
|
|
185
|
-
*
|
|
164
|
+
* ### Status requirements
|
|
186
165
|
*
|
|
187
|
-
*
|
|
166
|
+
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
167
|
+
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
188
168
|
*
|
|
189
|
-
*
|
|
190
|
-
* `flowControlSettings`:
|
|
169
|
+
* ### Checkout restrictions
|
|
191
170
|
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* succeeds even if no resource of the relevant type is available.
|
|
195
|
-
* - `{"skipBusinessConfirmation": true}`: Automatically confirms `PENDING`
|
|
196
|
-
* bookings that require manual confirmation.
|
|
197
|
-
* - `{"skipSelectedPaymentOptionValidation": true}`: Allows customers to pay
|
|
198
|
-
* with payment methods that aren't supported for the service.
|
|
199
|
-
* - `{"skipAddOnValidation": true}`: Allows customers to choose add-ons that aren't associated with the service or exceed group selection limits.
|
|
200
|
-
* - `{"allowAddOnChanges": true}`: Allows customers to update the list of add-ons associated with the booking when rescheduling.
|
|
171
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
172
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
201
173
|
*
|
|
202
|
-
*
|
|
203
|
-
* permissions. If you encounter failed calls due to insufficient permissions,
|
|
204
|
-
* consider the following options:
|
|
174
|
+
* ### Additional updates
|
|
205
175
|
*
|
|
206
|
-
* -
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
* - **Site developers** can utilize
|
|
210
|
-
* [elevation](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/authorization/elevation).
|
|
176
|
+
* - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
|
|
177
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
178
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
211
179
|
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
* them intentionally and securely.
|
|
215
|
-
* @param - The booking to create.
|
|
180
|
+
* See [Mark Booking as Pending](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/mark-booking-as-pending) for more details about marking single-service bookings as pending.
|
|
181
|
+
* @param - ID of the multi-service booking to mark as `PENDING`.
|
|
216
182
|
*/
|
|
217
|
-
(
|
|
218
|
-
__applicationErrorsType?:
|
|
183
|
+
(multiServiceBookingId: string, options?: MarkMultiServiceBookingAsPendingOptions): Promise<NonNullablePaths<MarkMultiServiceBookingAsPendingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
184
|
+
__applicationErrorsType?: MarkMultiServiceBookingAsPendingApplicationErrors;
|
|
219
185
|
}>;
|
|
220
186
|
}
|
|
221
|
-
declare function
|
|
222
|
-
interface
|
|
187
|
+
declare function confirmMultiServiceBooking$1(httpClient: HttpClient): ConfirmMultiServiceBookingSignature;
|
|
188
|
+
interface ConfirmMultiServiceBookingSignature {
|
|
223
189
|
/**
|
|
224
|
-
*
|
|
190
|
+
* Updates the status for all single-service bookings in a multi-service booking to `CONFIRMED`.
|
|
225
191
|
*
|
|
226
192
|
*
|
|
227
|
-
*
|
|
228
|
-
* for more information.
|
|
193
|
+
* Call this method for multi-service bookings requiring manual business approval.
|
|
229
194
|
*
|
|
230
|
-
*
|
|
231
|
-
* fails.
|
|
195
|
+
* ### Status requirements
|
|
232
196
|
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
* failures in the returned `bulkActionMetadata`.
|
|
236
|
-
* @param - Bookings to create.
|
|
197
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
198
|
+
* - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
|
|
237
199
|
*
|
|
238
|
-
*
|
|
200
|
+
* ### Checkout restrictions
|
|
201
|
+
*
|
|
202
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
203
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
204
|
+
*
|
|
205
|
+
* ### Additional updates
|
|
206
|
+
*
|
|
207
|
+
* - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
|
|
208
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
209
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
210
|
+
*
|
|
211
|
+
* See [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking) for more details about confirming single-service bookings.
|
|
212
|
+
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
239
213
|
*/
|
|
240
|
-
(
|
|
241
|
-
__applicationErrorsType?:
|
|
214
|
+
(multiServiceBookingId: string, options?: ConfirmMultiServiceBookingOptions): Promise<NonNullablePaths<ConfirmMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
215
|
+
__applicationErrorsType?: ConfirmMultiServiceBookingApplicationErrors;
|
|
242
216
|
}>;
|
|
243
217
|
}
|
|
244
|
-
declare function
|
|
245
|
-
interface
|
|
218
|
+
declare function declineMultiServiceBooking$1(httpClient: HttpClient): DeclineMultiServiceBookingSignature;
|
|
219
|
+
interface DeclineMultiServiceBookingSignature {
|
|
246
220
|
/**
|
|
247
|
-
*
|
|
248
|
-
* a different session.
|
|
221
|
+
* Updates the status for all single-service bookings in a multi-service booking to `DECLINED`.
|
|
249
222
|
*
|
|
250
223
|
*
|
|
251
|
-
*
|
|
224
|
+
* Call this method to reject multi-service bookings that can't be accommodated or don't meet business requirements.
|
|
252
225
|
*
|
|
253
|
-
*
|
|
254
|
-
* To do so, both of these conditions must be met:
|
|
255
|
-
* + The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
256
|
-
* + You must have `BOOKINGS.MANAGE_ADDONS` permissions and specify `flowControlSettings.allowAddOnChanges` as `true`.
|
|
226
|
+
* ### Status requirements
|
|
257
227
|
*
|
|
258
|
-
*
|
|
228
|
+
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
229
|
+
* - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
|
|
259
230
|
*
|
|
260
|
-
*
|
|
231
|
+
* ### Checkout restrictions
|
|
232
|
+
*
|
|
233
|
+
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
234
|
+
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
235
|
+
*
|
|
236
|
+
* ### Additional updates
|
|
237
|
+
*
|
|
238
|
+
* - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
|
|
239
|
+
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
240
|
+
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
241
|
+
*
|
|
242
|
+
* Refer to [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking) for more details about declining single-service bookings.
|
|
243
|
+
* @param - ID of the multi-service booking to decline.
|
|
244
|
+
*/
|
|
245
|
+
(multiServiceBookingId: string, options?: DeclineMultiServiceBookingOptions): Promise<NonNullablePaths<DeclineMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
246
|
+
__applicationErrorsType?: DeclineMultiServiceBookingApplicationErrors;
|
|
247
|
+
}>;
|
|
248
|
+
}
|
|
249
|
+
declare function bulkGetMultiServiceBookingAllowedActions$1(httpClient: HttpClient): BulkGetMultiServiceBookingAllowedActionsSignature;
|
|
250
|
+
interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
251
|
+
/**
|
|
252
|
+
* Retrieves information about which actions the customer can perform for up to 50 multi-service bookings.
|
|
253
|
+
*
|
|
254
|
+
*
|
|
255
|
+
* For each multi-service booking, the response indicates which actions are currently allowed:
|
|
256
|
+
* - `cancel`: Whether the customer can cancel the multi-service booking.
|
|
257
|
+
* - `reschedule`: Whether the customer can adjust the multi-service booking's timing.
|
|
258
|
+
*
|
|
259
|
+
* Bear the following considerations in mind when calling this method:
|
|
260
|
+
*
|
|
261
|
+
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction), and [available resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) at the time of the call.
|
|
262
|
+
*
|
|
263
|
+
* __Permission context__: Depending on the permissions of the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
|
|
264
|
+
*
|
|
265
|
+
* __Status dependencies__: Allowed actions change as bookings progress through their lifecycle (`CREATED` → `PENDING` → `CONFIRMED`/`DECLINED` → `CANCELED`).
|
|
266
|
+
* Bookings can skip `PENDING` and move directly from `CREATED` to `CONFIRMED`/`DECLINED` based on service configuration.
|
|
267
|
+
* @param - IDs of the multi-service bookings to retrieve allowed actions for.
|
|
268
|
+
*/
|
|
269
|
+
(multiServiceBookingIds: string[]): Promise<NonNullablePaths<BulkGetMultiServiceBookingAllowedActionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.cancel` | `results.${number}.item.reschedule` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
270
|
+
}
|
|
271
|
+
declare function getMultiServiceBooking$1(httpClient: HttpClient): GetMultiServiceBookingSignature;
|
|
272
|
+
interface GetMultiServiceBookingSignature {
|
|
273
|
+
/**
|
|
274
|
+
* Retrieves a multi-service booking and all its associated single-service bookings.
|
|
275
|
+
*
|
|
276
|
+
*
|
|
277
|
+
* Returns the complete multi-service booking information including its ID, associated single-service bookings, and the total number of scheduled single-service bookings.
|
|
278
|
+
*
|
|
279
|
+
* If you call on behalf of an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
|
|
280
|
+
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
281
|
+
*
|
|
282
|
+
* See [Query Extended Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings) for details about retrieving individual single-service bookings and additional metadata.
|
|
283
|
+
* @param - ID of the multi-service booking.
|
|
284
|
+
* @returns Retrieved multi-service booking.
|
|
285
|
+
*/
|
|
286
|
+
(multiServiceBookingId: string): Promise<NonNullablePaths<MultiServiceBooking, `bookings` | `bookings.${number}.booking.totalParticipants` | `bookings.${number}.booking.status` | `bookings.${number}.booking.paymentStatus` | `bookings.${number}.booking.selectedPaymentOption` | `bookings.${number}.booking.createdBy.anonymousVisitorId` | `bookings.${number}.booking.createdBy.memberId` | `bookings.${number}.booking.createdBy.wixUserId` | `bookings.${number}.booking.createdBy.appId`, 6>>;
|
|
287
|
+
}
|
|
288
|
+
declare function addBookingsToMultiServiceBooking$1(httpClient: HttpClient): AddBookingsToMultiServiceBookingSignature;
|
|
289
|
+
interface AddBookingsToMultiServiceBookingSignature {
|
|
290
|
+
/**
|
|
291
|
+
* Expands an existing multi-service booking by adding existing single-service bookings to the package.
|
|
292
|
+
*
|
|
293
|
+
*
|
|
294
|
+
* ### When to call this method
|
|
295
|
+
*
|
|
296
|
+
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
297
|
+
* For creating a new multi-service booking with new single-service bookings, call [Create Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) instead.
|
|
298
|
+
*
|
|
299
|
+
* ### Package integration
|
|
300
|
+
*
|
|
301
|
+
* The timing of the single-service bookings to add must be compatible with the multi-service booking's sequential schedule to ensure no gaps or overlaps between services in the updated package.
|
|
302
|
+
*
|
|
303
|
+
* ### Requirements and limitations
|
|
304
|
+
*
|
|
305
|
+
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
306
|
+
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
307
|
+
* - __Status compatibility__: Added bookings must have compatible status with the target multi-service booking.
|
|
308
|
+
* - __Revision control__: You must provide current revision numbers for all single-service bookings to add.
|
|
309
|
+
* @param - ID of the multi-service booking.
|
|
310
|
+
*/
|
|
311
|
+
(multiServiceBookingId: string, options?: NonNullablePaths<AddBookingsToMultiServiceBookingOptions, `bookings` | `bookings.${number}.bookingId` | `bookings.${number}.revision`, 4>): Promise<NonNullablePaths<AddBookingsToMultiServiceBookingResponse, `bookings` | `bookings.${number}.booking.totalParticipants` | `bookings.${number}.booking.status` | `bookings.${number}.booking.paymentStatus` | `bookings.${number}.booking.selectedPaymentOption` | `bookings.${number}.booking.createdBy.anonymousVisitorId` | `bookings.${number}.booking.createdBy.memberId` | `bookings.${number}.booking.createdBy.wixUserId` | `bookings.${number}.booking.createdBy.appId`, 6> & {
|
|
312
|
+
__applicationErrorsType?: AddBookingsToMultiServiceBookingApplicationErrors;
|
|
313
|
+
}>;
|
|
314
|
+
}
|
|
315
|
+
declare function removeBookingsFromMultiServiceBooking$1(httpClient: HttpClient): RemoveBookingsFromMultiServiceBookingSignature;
|
|
316
|
+
interface RemoveBookingsFromMultiServiceBookingSignature {
|
|
317
|
+
/**
|
|
318
|
+
* Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings.
|
|
319
|
+
*
|
|
320
|
+
*
|
|
321
|
+
* ### Removal options
|
|
322
|
+
*
|
|
323
|
+
* __Remove all permitted bookings__: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
|
|
324
|
+
*
|
|
325
|
+
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
326
|
+
*
|
|
327
|
+
* __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call [Reschedule Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) before removing the unwanted bookings.
|
|
328
|
+
*
|
|
329
|
+
* ### Removal behavior
|
|
330
|
+
*
|
|
331
|
+
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
332
|
+
* You can manage them using single-service booking methods.
|
|
333
|
+
*
|
|
334
|
+
* __Automatic cleanup__: Multi-service bookings must contain at least 2 services.
|
|
335
|
+
* If removal results in only 1 remaining single-service booking for the multi-service booking, the entire multi-service booking is deleted and the remaining single-service booking becomes a standalone booking.
|
|
336
|
+
*
|
|
337
|
+
* __Revision control__: Specify current revision numbers to prevent conflicting modifications during the removal process.
|
|
338
|
+
* @param - ID of the multi-service booking.
|
|
339
|
+
*/
|
|
340
|
+
(multiServiceBookingId: string, options?: RemoveBookingsFromMultiServiceBookingOptions): Promise<NonNullablePaths<RemoveBookingsFromMultiServiceBookingResponse, `bookings` | `bookings.${number}.booking.totalParticipants` | `bookings.${number}.booking.status` | `bookings.${number}.booking.paymentStatus` | `bookings.${number}.booking.selectedPaymentOption` | `bookings.${number}.booking.createdBy.anonymousVisitorId` | `bookings.${number}.booking.createdBy.memberId` | `bookings.${number}.booking.createdBy.wixUserId` | `bookings.${number}.booking.createdBy.appId`, 6> & {
|
|
341
|
+
__applicationErrorsType?: RemoveBookingsFromMultiServiceBookingApplicationErrors;
|
|
342
|
+
}>;
|
|
343
|
+
}
|
|
344
|
+
declare function createBooking$1(httpClient: HttpClient): CreateBookingSignature;
|
|
345
|
+
interface CreateBookingSignature {
|
|
346
|
+
/**
|
|
347
|
+
* Creates a booking.
|
|
348
|
+
*
|
|
349
|
+
*
|
|
350
|
+
* ### Appointment booking
|
|
351
|
+
*
|
|
352
|
+
* For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
|
|
353
|
+
*
|
|
354
|
+
* We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
|
|
355
|
+
* Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
|
|
356
|
+
*
|
|
357
|
+
* ### Class session booking
|
|
358
|
+
*
|
|
359
|
+
* For class services, specify the relevant event ID as `bookedEntity.slot.eventId`.
|
|
360
|
+
*
|
|
361
|
+
* We recommend following the [class session booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-a-class-session) using Time Slots V2.
|
|
362
|
+
* Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
|
|
363
|
+
*
|
|
364
|
+
* When you specify `eventId`, Wix Bookings automatically derives `startDate`, `endDate`, `timezone`, `resource`, and `location` based on the event details. Manually specified values are ignored.
|
|
365
|
+
*
|
|
366
|
+
* ### Course booking
|
|
367
|
+
*
|
|
368
|
+
* For course services, specify the course's schedule ID in `bookedEntity.schedule.scheduleId`.
|
|
369
|
+
* We recommend following [this sample flow](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course)
|
|
370
|
+
* to minimize failed calls due to unavailability.
|
|
371
|
+
*
|
|
372
|
+
* ### Booking status
|
|
373
|
+
*
|
|
374
|
+
* Create Booking defaults to `status=CREATED`. Such bookings aren't visible in the [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar).
|
|
375
|
+
*
|
|
376
|
+
* Only [identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with `Manage Bookings` permissions can set `status=CONFIRMED`.
|
|
377
|
+
*
|
|
378
|
+
* ### Related resources
|
|
379
|
+
*
|
|
380
|
+
* Specifying a `resource` triggers an availability check, and the Create Booking call fails if the resource is unavailable.
|
|
381
|
+
*
|
|
382
|
+
* If you omit `resource`, resource assignment and availability validation occur during booking confirmation.
|
|
383
|
+
* If no resources are available, the behavior depends on the confirmation method used and payment status.
|
|
384
|
+
*
|
|
385
|
+
* ### Booking form data
|
|
386
|
+
*
|
|
387
|
+
* When customers sign up for a service, they must fill out the [booking form](https://support.wix.com/en/article/wix-bookings-creating-and-setting-up-your-booking-forms).
|
|
388
|
+
* To create a booking with a completed booking form, specify the relevant data in `formSubmission`.
|
|
389
|
+
* Ensure the values of the corresponding fields in `booking.contactDetails` and `formSubmission` are identical.
|
|
390
|
+
* If these values don't match, Create Booking fails.
|
|
391
|
+
* Therefore, we recommend specifying only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
392
|
+
* Learn more about the [Bookings and Wix Forms integration](https://dev.wix.com/docs/rest/business-solutions/bookings/wix-forms-integration).
|
|
393
|
+
*
|
|
394
|
+
* ### Participant information
|
|
395
|
+
*
|
|
396
|
+
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
397
|
+
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
398
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
399
|
+
*
|
|
400
|
+
* ### Add-ons
|
|
401
|
+
*
|
|
402
|
+
* You can include [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) when creating a booking by specifying `bookedAddOns`.
|
|
403
|
+
* Each selected add-on must belong to an [add-on group](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-add-on-groups) associated with the service and respect the group's selection limits.
|
|
404
|
+
*
|
|
405
|
+
* ### Notify customers
|
|
406
|
+
*
|
|
407
|
+
* You can specify a `participantNotification.message` for the customer that's send
|
|
408
|
+
* immediately. Ensure `participantNotification.notifyParticipants` is set to `true`
|
|
409
|
+
* to send the message.
|
|
410
|
+
*
|
|
411
|
+
* If you specify `{"sendSmsReminder": true}`, the customer receives an SMS 24 hours
|
|
412
|
+
* before the session starts. The phone number is taken from `contactDetails.phone`.
|
|
413
|
+
*
|
|
414
|
+
* ### Payment options
|
|
415
|
+
*
|
|
416
|
+
* The specified `selectedPaymentOption` indicates how the customer intends to pay, allowing for later changes to a different method supported by the service.
|
|
417
|
+
*
|
|
418
|
+
* ### Payment status
|
|
419
|
+
*
|
|
420
|
+
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
421
|
+
*
|
|
422
|
+
* For customers paying with a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/checkout/introduction), Wix Bookings automatically syncs the booking's payment status from the corresponding [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
423
|
+
*
|
|
424
|
+
* For customers using a custom checkout, call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to update booking's payment status manually.
|
|
425
|
+
*
|
|
426
|
+
* ### Admin overwrites
|
|
427
|
+
*
|
|
428
|
+
* There are small but important differences when you specify special
|
|
429
|
+
* `flowControlSettings`:
|
|
430
|
+
*
|
|
431
|
+
* - `{"skipAvailabilityValidation": true}`: The call succeeds
|
|
432
|
+
* regardless of availability. If you don't specify any resource, the call
|
|
433
|
+
* succeeds even if no resource of the relevant type is available.
|
|
434
|
+
* - `{"skipBusinessConfirmation": true}`: Automatically confirms `PENDING`
|
|
435
|
+
* bookings that require manual confirmation.
|
|
436
|
+
* - `{"skipSelectedPaymentOptionValidation": true}`: Allows customers to pay
|
|
437
|
+
* with payment methods that aren't supported for the service.
|
|
438
|
+
* - `{"skipAddOnValidation": true}`: Allows customers to choose add-ons that aren't associated with the service or exceed group selection limits.
|
|
439
|
+
* - `{"allowAddOnChanges": true}`: Allows customers to update the list of add-ons associated with the booking when rescheduling.
|
|
440
|
+
*
|
|
441
|
+
* When using special `flowControlSettings`, ensure you have sufficient
|
|
442
|
+
* permissions. If you encounter failed calls due to insufficient permissions,
|
|
443
|
+
* consider the following options:
|
|
444
|
+
*
|
|
445
|
+
* - **App developers** can use a higher
|
|
446
|
+
* [permission](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions),
|
|
447
|
+
* such as `MANAGE BOOKINGS - ALL PERMISSIONS`.
|
|
448
|
+
* - **Site developers** can utilize
|
|
449
|
+
* [elevation](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/authorization/elevation).
|
|
450
|
+
*
|
|
451
|
+
* Granting additional permissions and using elevation permits method calls that
|
|
452
|
+
* would typically fail due to authorization checks. Therefore, you should use
|
|
453
|
+
* them intentionally and securely.
|
|
454
|
+
* @param - The booking to create.
|
|
455
|
+
*/
|
|
456
|
+
(booking: NonNullablePaths<Booking, `additionalFields.${number}._id` | `bookedEntity`, 4>, options?: CreateBookingOptions): Promise<NonNullablePaths<CreateBookingResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
457
|
+
__applicationErrorsType?: CreateBookingApplicationErrors;
|
|
458
|
+
}>;
|
|
459
|
+
}
|
|
460
|
+
declare function bulkCreateBooking$1(httpClient: HttpClient): BulkCreateBookingSignature;
|
|
461
|
+
interface BulkCreateBookingSignature {
|
|
462
|
+
/**
|
|
463
|
+
* Creates up to 8 bookings.
|
|
464
|
+
*
|
|
465
|
+
*
|
|
466
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
467
|
+
* for more information.
|
|
468
|
+
*
|
|
469
|
+
* If any of the specified bookings is missing a required field the entire call
|
|
470
|
+
* fails.
|
|
471
|
+
*
|
|
472
|
+
* If you specify 1 or more unavailable bookings, the call succeeds
|
|
473
|
+
* while the unavailable bookings aren't created. Instead, they're counted as
|
|
474
|
+
* failures in the returned `bulkActionMetadata`.
|
|
475
|
+
* @param - Bookings to create.
|
|
476
|
+
*
|
|
477
|
+
* Max: 8 bookings
|
|
478
|
+
*/
|
|
479
|
+
(createBookingsInfo: NonNullablePaths<CreateBookingInfo, `booking` | `booking.additionalFields.${number}._id` | `booking.bookedEntity`, 5>[], options?: BulkCreateBookingOptions): Promise<NonNullablePaths<BulkCreateBookingResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.totalParticipants` | `results.${number}.item.status` | `results.${number}.item.paymentStatus` | `results.${number}.item.selectedPaymentOption` | `results.${number}.item.createdBy.anonymousVisitorId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.wixUserId` | `results.${number}.item.createdBy.appId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
480
|
+
__applicationErrorsType?: BulkCreateBookingApplicationErrors;
|
|
481
|
+
}>;
|
|
482
|
+
}
|
|
483
|
+
declare function rescheduleBooking$1(httpClient: HttpClient): RescheduleBookingSignature;
|
|
484
|
+
interface RescheduleBookingSignature {
|
|
485
|
+
/**
|
|
486
|
+
* Reschedules an appointment booking to a different slot or a class booking to
|
|
487
|
+
* a different session.
|
|
488
|
+
*
|
|
489
|
+
*
|
|
490
|
+
* ### Updating add-ons
|
|
491
|
+
*
|
|
492
|
+
* You can also call this method to update the list of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) associated with the booking.
|
|
493
|
+
* To do so, both of these conditions must be met:
|
|
494
|
+
* + The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
495
|
+
* + You must have `BOOKINGS.MANAGE_ADDONS` permissions and specify `flowControlSettings.allowAddOnChanges` as `true`.
|
|
496
|
+
*
|
|
497
|
+
* ### Course booking limitation
|
|
498
|
+
*
|
|
499
|
+
* You can't reschedule course bookings.
|
|
261
500
|
*
|
|
262
501
|
* ### Appointment sessions
|
|
263
502
|
*
|
|
@@ -510,401 +749,148 @@ interface CancelBookingSignature {
|
|
|
510
749
|
declare function updateNumberOfParticipants$1(httpClient: HttpClient): UpdateNumberOfParticipantsSignature;
|
|
511
750
|
interface UpdateNumberOfParticipantsSignature {
|
|
512
751
|
/**
|
|
513
|
-
* Updates the number of participants for a class or course booking and changes
|
|
514
|
-
* the `totalNumberOfParticipants` for the relevant sessions.
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
* ### Appointment limitation
|
|
518
|
-
*
|
|
519
|
-
* You can't update the number of participants for appointment bookings.
|
|
520
|
-
*
|
|
521
|
-
* ### Participant information
|
|
522
|
-
*
|
|
523
|
-
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
524
|
-
* The call fails if the specified `participantsChoices` aren't among the
|
|
525
|
-
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
526
|
-
* @param - ID of the booking to update the number of participants for.
|
|
527
|
-
*/
|
|
528
|
-
(bookingId: string, options?: NonNullablePaths<UpdateNumberOfParticipantsOptions, `revision`, 2>): Promise<NonNullablePaths<UpdateNumberOfParticipantsResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
529
|
-
__applicationErrorsType?: UpdateNumberOfParticipantsApplicationErrors;
|
|
530
|
-
}>;
|
|
531
|
-
}
|
|
532
|
-
declare function markBookingAsPending$1(httpClient: HttpClient): MarkBookingAsPendingSignature;
|
|
533
|
-
interface MarkBookingAsPendingSignature {
|
|
534
|
-
/**
|
|
535
|
-
* Updates the booking status to `PENDING`.
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
* ### Service requirement
|
|
539
|
-
*
|
|
540
|
-
* By default, this method only works for [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
541
|
-
* If you attempt to mark a booking as pending for a service that doesn't require approval, the call fails unless you use the `skipPendingApprovalServiceValidation` admin overwrite.
|
|
542
|
-
*
|
|
543
|
-
* ### Status requirements
|
|
544
|
-
*
|
|
545
|
-
* - __Original status__: Booking must have `CREATED` status.
|
|
546
|
-
* - __Target status__: Booking moves to `PENDING`.
|
|
547
|
-
*
|
|
548
|
-
* ### Checkout restrictions
|
|
549
|
-
*
|
|
550
|
-
* Only call this method if the customer paid via a custom checkout. For [Wix eCommerce checkouts](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/introduction), Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
551
|
-
*
|
|
552
|
-
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
553
|
-
*
|
|
554
|
-
* ### Business workflow
|
|
555
|
-
*
|
|
556
|
-
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
557
|
-
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
558
|
-
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
559
|
-
*
|
|
560
|
-
* ### Resource availability and scheduling
|
|
561
|
-
*
|
|
562
|
-
* Marking a booking as `PENDING` immediately affects resource availability:
|
|
563
|
-
*
|
|
564
|
-
* - **Calendar impact**: The booking appears on the business calendar.
|
|
565
|
-
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
566
|
-
* - **Resource assignment**: Available [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) are automatically assigned if none were explicitly selected during booking creation.
|
|
567
|
-
*
|
|
568
|
-
* ### Double bookings
|
|
569
|
-
*
|
|
570
|
-
* By default, the method doesn't check for availability conflicts. To detect and handle double bookings, use the `checkAvailabilityValidation: true` admin overwrite.
|
|
571
|
-
*
|
|
572
|
-
* ### Notify customers
|
|
573
|
-
*
|
|
574
|
-
* You can specify a `participantNotification.message` for the customer.
|
|
575
|
-
* To send the message, you must also specify `participantNotification.notifyParticipants` as `true`.
|
|
576
|
-
*
|
|
577
|
-
* ### Admin overwrites
|
|
578
|
-
*
|
|
579
|
-
* There are small but important differences when you specify special
|
|
580
|
-
* `flowControlSettings`:
|
|
581
|
-
*
|
|
582
|
-
* - `{"checkAvailabilityValidation": true}`: Checks for double booking conflicts before updating the status.
|
|
583
|
-
* When conflicts exist, the booking is still marked as `PENDING` and `doubleBooked` is set to `true` for the business to resolve manually.
|
|
584
|
-
* - `{"skipPendingApprovalServiceValidation": true}`: Allows marking any booking as pending, even if the service doesn't require manual approval.
|
|
585
|
-
*
|
|
586
|
-
* When using special `flowControlSettings`, ensure you have sufficient permissions.
|
|
587
|
-
* If you encounter failed calls due to insufficient permissions, consider the following options:
|
|
588
|
-
*
|
|
589
|
-
* - __App developers__ can use a higher
|
|
590
|
-
* [permission](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions), such as `MANAGE BOOKINGS - ALL PERMISSIONS`.
|
|
591
|
-
* - __Site developers__ can utilize
|
|
592
|
-
* [elevation](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/authorization/elevation).
|
|
593
|
-
*
|
|
594
|
-
* Granting additional permissions and using elevation permits method calls that would typically fail due to authorization checks.
|
|
595
|
-
* Therefore, you should use them intentionally and securely.
|
|
596
|
-
* @param - ID of the booking to mark as `PENDING`.
|
|
597
|
-
* @param - Revision number, which increments by 1 each time the booking is updated.
|
|
598
|
-
*
|
|
599
|
-
* To prevent conflicting changes, the current revision must be specified when
|
|
600
|
-
* managing the booking.
|
|
601
|
-
*/
|
|
602
|
-
(bookingId: string, revision: string, options?: MarkBookingAsPendingOptions): Promise<NonNullablePaths<MarkBookingAsPendingResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
603
|
-
__applicationErrorsType?: MarkBookingAsPendingApplicationErrors;
|
|
604
|
-
}>;
|
|
605
|
-
}
|
|
606
|
-
declare function createMultiServiceBooking$1(httpClient: HttpClient): CreateMultiServiceBookingSignature;
|
|
607
|
-
interface CreateMultiServiceBookingSignature {
|
|
608
|
-
/**
|
|
609
|
-
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
* ### When to call this method
|
|
613
|
-
*
|
|
614
|
-
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call [Add Bookings to Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) instead.
|
|
615
|
-
*
|
|
616
|
-
* ### Requirements and behavior
|
|
617
|
-
*
|
|
618
|
-
* __Package constraints__: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
|
|
619
|
-
*
|
|
620
|
-
* __Timing specification__: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
|
|
621
|
-
*
|
|
622
|
-
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) if the customer paid via an [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
623
|
-
*
|
|
624
|
-
* __Package notifications__: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
|
|
625
|
-
*
|
|
626
|
-
* ### Related methods
|
|
627
|
-
*
|
|
628
|
-
* Verify availability first with [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots).
|
|
629
|
-
*
|
|
630
|
-
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) for more details about constraints and effects of creating single-service bookings.
|
|
631
|
-
* @param - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
632
|
-
*
|
|
633
|
-
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
634
|
-
* Specify contact details, number of participants, and any additional fields as needed.
|
|
635
|
-
*
|
|
636
|
-
* For sequential bookings, ensure the timing allows services to be scheduled back-to-back.
|
|
637
|
-
*/
|
|
638
|
-
(bookings: NonNullablePaths<Booking, `additionalFields.${number}._id` | `bookedEntity` | `bookedEntity.slot` | `bookedEntity.slot.endDate` | `bookedEntity.slot.location.locationType` | `bookedEntity.slot.scheduleId` | `bookedEntity.slot.startDate`, 5>[], options?: CreateMultiServiceBookingOptions): Promise<NonNullablePaths<CreateMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
639
|
-
__applicationErrorsType?: CreateMultiServiceBookingApplicationErrors;
|
|
640
|
-
}>;
|
|
641
|
-
}
|
|
642
|
-
declare function rescheduleMultiServiceBooking$1(httpClient: HttpClient): RescheduleMultiServiceBookingSignature;
|
|
643
|
-
interface RescheduleMultiServiceBookingSignature {
|
|
644
|
-
/**
|
|
645
|
-
* Reschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package.
|
|
646
|
-
*
|
|
647
|
-
*
|
|
648
|
-
* This method reschedules single-service bookings within the multi-service booking while maintaining sequential order. You must specify exact new timing for each service to ensure they remain back-to-back with no gaps or overlaps.
|
|
649
|
-
*
|
|
650
|
-
* This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each single-service booking you're rescheduling to prevent conflicting changes.
|
|
651
|
-
*
|
|
652
|
-
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
653
|
-
* @param - ID of the multi-service booking to reschedule.
|
|
654
|
-
* @param - Information about the single-service bookings to reschedule.
|
|
655
|
-
*/
|
|
656
|
-
(multiServiceBookingId: string, rescheduleBookingsInfo: NonNullablePaths<RescheduleBookingInfo, `bookingId` | `revision` | `slot`, 2>[], options?: RescheduleMultiServiceBookingOptions): Promise<NonNullablePaths<RescheduleMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
657
|
-
__applicationErrorsType?: RescheduleMultiServiceBookingApplicationErrors;
|
|
658
|
-
}>;
|
|
659
|
-
}
|
|
660
|
-
declare function getMultiServiceBookingAvailability$1(httpClient: HttpClient): GetMultiServiceBookingAvailabilitySignature;
|
|
661
|
-
interface GetMultiServiceBookingAvailabilitySignature {
|
|
662
|
-
/**
|
|
663
|
-
* Checks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations.
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
* Wix Bookings considers:
|
|
667
|
-
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
668
|
-
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
669
|
-
*
|
|
670
|
-
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
671
|
-
* For example, staff changes, policy updates, or capacity modifications.
|
|
672
|
-
*
|
|
673
|
-
* For checking availability before creating new multi-service bookings, call [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) instead.
|
|
674
|
-
* @param - ID of the multi-service booking to retrieve.
|
|
675
|
-
*/
|
|
676
|
-
(multiServiceBookingId: string): Promise<NonNullablePaths<GetMultiServiceBookingAvailabilityResponse, `bookable` | `multiServiceBookingInfo`, 2> & {
|
|
677
|
-
__applicationErrorsType?: GetMultiServiceBookingAvailabilityApplicationErrors;
|
|
678
|
-
}>;
|
|
679
|
-
}
|
|
680
|
-
declare function cancelMultiServiceBooking$1(httpClient: HttpClient): CancelMultiServiceBookingSignature;
|
|
681
|
-
interface CancelMultiServiceBookingSignature {
|
|
682
|
-
/**
|
|
683
|
-
* Cancels a multi-service booking and all its associated single-service bookings.
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
687
|
-
* The call fails if all single-service bookings are already canceled or declined.
|
|
688
|
-
*
|
|
689
|
-
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
690
|
-
* @param - ID of the multi-service booking to cancel.
|
|
691
|
-
*/
|
|
692
|
-
(multiServiceBookingId: string, options?: CancelMultiServiceBookingOptions): Promise<NonNullablePaths<CancelMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
693
|
-
__applicationErrorsType?: CancelMultiServiceBookingApplicationErrors;
|
|
694
|
-
}>;
|
|
695
|
-
}
|
|
696
|
-
declare function markMultiServiceBookingAsPending$1(httpClient: HttpClient): MarkMultiServiceBookingAsPendingSignature;
|
|
697
|
-
interface MarkMultiServiceBookingAsPendingSignature {
|
|
698
|
-
/**
|
|
699
|
-
* Updates the status for all single-service bookings in a multi-service booking to `PENDING`.
|
|
700
|
-
*
|
|
701
|
-
*
|
|
702
|
-
* Call this method for multi-service bookings requiring manual business approval before confirmation.
|
|
703
|
-
*
|
|
704
|
-
* ### Status requirements
|
|
705
|
-
*
|
|
706
|
-
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
707
|
-
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
752
|
+
* Updates the number of participants for a class or course booking and changes
|
|
753
|
+
* the `totalNumberOfParticipants` for the relevant sessions.
|
|
708
754
|
*
|
|
709
|
-
* ### Checkout restrictions
|
|
710
755
|
*
|
|
711
|
-
*
|
|
712
|
-
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
756
|
+
* ### Appointment limitation
|
|
713
757
|
*
|
|
714
|
-
*
|
|
758
|
+
* You can't update the number of participants for appointment bookings.
|
|
715
759
|
*
|
|
716
|
-
*
|
|
717
|
-
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
718
|
-
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
760
|
+
* ### Participant information
|
|
719
761
|
*
|
|
720
|
-
*
|
|
721
|
-
*
|
|
762
|
+
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
763
|
+
* The call fails if the specified `participantsChoices` aren't among the
|
|
764
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
765
|
+
* @param - ID of the booking to update the number of participants for.
|
|
722
766
|
*/
|
|
723
|
-
(
|
|
724
|
-
__applicationErrorsType?:
|
|
767
|
+
(bookingId: string, options?: NonNullablePaths<UpdateNumberOfParticipantsOptions, `revision`, 2>): Promise<NonNullablePaths<UpdateNumberOfParticipantsResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
768
|
+
__applicationErrorsType?: UpdateNumberOfParticipantsApplicationErrors;
|
|
725
769
|
}>;
|
|
726
770
|
}
|
|
727
|
-
declare function
|
|
728
|
-
interface
|
|
771
|
+
declare function markBookingAsPending$1(httpClient: HttpClient): MarkBookingAsPendingSignature;
|
|
772
|
+
interface MarkBookingAsPendingSignature {
|
|
729
773
|
/**
|
|
730
|
-
* Updates the status
|
|
774
|
+
* Updates the booking status to `PENDING`.
|
|
731
775
|
*
|
|
732
776
|
*
|
|
733
|
-
*
|
|
777
|
+
* ### Service requirement
|
|
778
|
+
*
|
|
779
|
+
* By default, this method only works for [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
780
|
+
* If you attempt to mark a booking as pending for a service that doesn't require approval, the call fails unless you use the `skipPendingApprovalServiceValidation` admin overwrite.
|
|
734
781
|
*
|
|
735
782
|
* ### Status requirements
|
|
736
783
|
*
|
|
737
|
-
* - __Original status__:
|
|
738
|
-
* - __Target status__:
|
|
784
|
+
* - __Original status__: Booking must have `CREATED` status.
|
|
785
|
+
* - __Target status__: Booking moves to `PENDING`.
|
|
739
786
|
*
|
|
740
787
|
* ### Checkout restrictions
|
|
741
788
|
*
|
|
742
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
743
|
-
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
744
|
-
*
|
|
745
|
-
* ### Additional updates
|
|
789
|
+
* Only call this method if the customer paid via a custom checkout. For [Wix eCommerce checkouts](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/introduction), Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
746
790
|
*
|
|
747
|
-
*
|
|
748
|
-
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
749
|
-
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
791
|
+
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
750
792
|
*
|
|
751
|
-
*
|
|
752
|
-
* @param - ID of the multi-service booking to confirm its related bookings.
|
|
753
|
-
*/
|
|
754
|
-
(multiServiceBookingId: string, options?: ConfirmMultiServiceBookingOptions): Promise<NonNullablePaths<ConfirmMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
755
|
-
__applicationErrorsType?: ConfirmMultiServiceBookingApplicationErrors;
|
|
756
|
-
}>;
|
|
757
|
-
}
|
|
758
|
-
declare function declineMultiServiceBooking$1(httpClient: HttpClient): DeclineMultiServiceBookingSignature;
|
|
759
|
-
interface DeclineMultiServiceBookingSignature {
|
|
760
|
-
/**
|
|
761
|
-
* Updates the status for all single-service bookings in a multi-service booking to `DECLINED`.
|
|
793
|
+
* ### Business workflow
|
|
762
794
|
*
|
|
795
|
+
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
796
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
797
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
763
798
|
*
|
|
764
|
-
*
|
|
799
|
+
* ### Resource availability and scheduling
|
|
765
800
|
*
|
|
766
|
-
*
|
|
801
|
+
* Marking a booking as `PENDING` immediately affects resource availability:
|
|
767
802
|
*
|
|
768
|
-
* -
|
|
769
|
-
* -
|
|
803
|
+
* - **Calendar impact**: The booking appears on the business calendar.
|
|
804
|
+
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
805
|
+
* - **Resource assignment**: Available [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) are automatically assigned if none were explicitly selected during booking creation.
|
|
770
806
|
*
|
|
771
|
-
* ###
|
|
807
|
+
* ### Double bookings
|
|
772
808
|
*
|
|
773
|
-
*
|
|
774
|
-
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
809
|
+
* By default, the method doesn't check for availability conflicts. To detect and handle double bookings, use the `checkAvailabilityValidation: true` admin overwrite.
|
|
775
810
|
*
|
|
776
|
-
* ###
|
|
811
|
+
* ### Notify customers
|
|
777
812
|
*
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
813
|
+
* You can specify a `participantNotification.message` for the customer.
|
|
814
|
+
* To send the message, you must also specify `participantNotification.notifyParticipants` as `true`.
|
|
781
815
|
*
|
|
782
|
-
*
|
|
783
|
-
* @param - ID of the multi-service booking to decline.
|
|
784
|
-
*/
|
|
785
|
-
(multiServiceBookingId: string, options?: DeclineMultiServiceBookingOptions): Promise<NonNullablePaths<DeclineMultiServiceBookingResponse, `multiServiceBooking.bookings` | `multiServiceBooking.bookings.${number}.booking.totalParticipants` | `multiServiceBooking.bookings.${number}.booking.status` | `multiServiceBooking.bookings.${number}.booking.paymentStatus` | `multiServiceBooking.bookings.${number}.booking.selectedPaymentOption` | `multiServiceBooking.bookings.${number}.booking.createdBy.anonymousVisitorId` | `multiServiceBooking.bookings.${number}.booking.createdBy.memberId` | `multiServiceBooking.bookings.${number}.booking.createdBy.wixUserId` | `multiServiceBooking.bookings.${number}.booking.createdBy.appId`, 7> & {
|
|
786
|
-
__applicationErrorsType?: DeclineMultiServiceBookingApplicationErrors;
|
|
787
|
-
}>;
|
|
788
|
-
}
|
|
789
|
-
declare function bulkGetMultiServiceBookingAllowedActions$1(httpClient: HttpClient): BulkGetMultiServiceBookingAllowedActionsSignature;
|
|
790
|
-
interface BulkGetMultiServiceBookingAllowedActionsSignature {
|
|
791
|
-
/**
|
|
792
|
-
* Retrieves information about which actions the customer can perform for up to 50 multi-service bookings.
|
|
816
|
+
* ### Admin overwrites
|
|
793
817
|
*
|
|
818
|
+
* There are small but important differences when you specify special
|
|
819
|
+
* `flowControlSettings`:
|
|
794
820
|
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
* - `
|
|
821
|
+
* - `{"checkAvailabilityValidation": true}`: Checks for double booking conflicts before updating the status.
|
|
822
|
+
* When conflicts exist, the booking is still marked as `PENDING` and `doubleBooked` is set to `true` for the business to resolve manually.
|
|
823
|
+
* - `{"skipPendingApprovalServiceValidation": true}`: Allows marking any booking as pending, even if the service doesn't require manual approval.
|
|
798
824
|
*
|
|
799
|
-
*
|
|
825
|
+
* When using special `flowControlSettings`, ensure you have sufficient permissions.
|
|
826
|
+
* If you encounter failed calls due to insufficient permissions, consider the following options:
|
|
800
827
|
*
|
|
801
|
-
*
|
|
828
|
+
* - __App developers__ can use a higher
|
|
829
|
+
* [permission](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions), such as `MANAGE BOOKINGS - ALL PERMISSIONS`.
|
|
830
|
+
* - __Site developers__ can utilize
|
|
831
|
+
* [elevation](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/authorization/elevation).
|
|
802
832
|
*
|
|
803
|
-
*
|
|
833
|
+
* Granting additional permissions and using elevation permits method calls that would typically fail due to authorization checks.
|
|
834
|
+
* Therefore, you should use them intentionally and securely.
|
|
835
|
+
* @param - ID of the booking to mark as `PENDING`.
|
|
836
|
+
* @param - Revision number, which increments by 1 each time the booking is updated.
|
|
804
837
|
*
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
* @param - IDs of the multi-service bookings to retrieve allowed actions for.
|
|
838
|
+
* To prevent conflicting changes, the current revision must be specified when
|
|
839
|
+
* managing the booking.
|
|
808
840
|
*/
|
|
809
|
-
(
|
|
841
|
+
(bookingId: string, revision: string, options?: MarkBookingAsPendingOptions): Promise<NonNullablePaths<MarkBookingAsPendingResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
842
|
+
__applicationErrorsType?: MarkBookingAsPendingApplicationErrors;
|
|
843
|
+
}>;
|
|
810
844
|
}
|
|
811
|
-
declare function
|
|
812
|
-
interface
|
|
845
|
+
declare function getAnonymousActionDetails$1(httpClient: HttpClient): GetAnonymousActionDetailsSignature;
|
|
846
|
+
interface GetAnonymousActionDetailsSignature {
|
|
813
847
|
/**
|
|
814
|
-
*
|
|
815
|
-
*
|
|
816
|
-
*
|
|
817
|
-
*
|
|
818
|
-
*
|
|
819
|
-
* If you call on behalf of an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
|
|
820
|
-
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
821
|
-
*
|
|
822
|
-
* See [Query Extended Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings) for details about retrieving individual single-service bookings and additional metadata.
|
|
823
|
-
* @param - ID of the multi-service booking.
|
|
824
|
-
* @returns Retrieved multi-service booking.
|
|
848
|
+
* Returns booking details related to AnonymousActions
|
|
849
|
+
* Anonymous tokens for getting, canceling or rescheduling the booking.
|
|
850
|
+
* That token is symmetrically encrypted and Url-safe.
|
|
851
|
+
* That allows the UoU to cancel or reschedule without Authentication.
|
|
852
|
+
* @returns Response for GetAnonymousActionDetails
|
|
825
853
|
*/
|
|
826
|
-
(
|
|
854
|
+
(options?: GetAnonymousActionDetailsOptions): Promise<GetAnonymousActionDetailsResponse>;
|
|
827
855
|
}
|
|
828
|
-
declare function
|
|
829
|
-
interface
|
|
856
|
+
declare function cancelBookingAnonymously$1(httpClient: HttpClient): CancelBookingAnonymouslySignature;
|
|
857
|
+
interface CancelBookingAnonymouslySignature {
|
|
830
858
|
/**
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
* ### When to call this method
|
|
835
|
-
*
|
|
836
|
-
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
837
|
-
* For creating a new multi-service booking with new single-service bookings, call [Create Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) instead.
|
|
838
|
-
*
|
|
839
|
-
* ### Package integration
|
|
840
|
-
*
|
|
841
|
-
* The timing of the single-service bookings to add must be compatible with the multi-service booking's sequential schedule to ensure no gaps or overlaps between services in the updated package.
|
|
842
|
-
*
|
|
843
|
-
* ### Requirements and limitations
|
|
844
|
-
*
|
|
845
|
-
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
846
|
-
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
847
|
-
* - __Status compatibility__: Added bookings must have compatible status with the target multi-service booking.
|
|
848
|
-
* - __Revision control__: You must provide current revision numbers for all single-service bookings to add.
|
|
849
|
-
* @param - ID of the multi-service booking.
|
|
859
|
+
* Cancel booking using an anonymous token
|
|
860
|
+
* @param - The token provided in the booking links for anonymous access
|
|
861
|
+
* @returns Response for CancelBookingAnonymously
|
|
850
862
|
*/
|
|
851
|
-
(
|
|
852
|
-
__applicationErrorsType?: AddBookingsToMultiServiceBookingApplicationErrors;
|
|
853
|
-
}>;
|
|
863
|
+
(token: string, options?: CancelBookingAnonymouslyOptions): Promise<NonNullablePaths<CancelBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7>>;
|
|
854
864
|
}
|
|
855
|
-
declare function
|
|
856
|
-
interface
|
|
865
|
+
declare function rescheduleBookingAnonymously$1(httpClient: HttpClient): RescheduleBookingAnonymouslySignature;
|
|
866
|
+
interface RescheduleBookingAnonymouslySignature {
|
|
857
867
|
/**
|
|
858
|
-
*
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
* __Remove all permitted bookings__: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
|
|
864
|
-
*
|
|
865
|
-
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
866
|
-
*
|
|
867
|
-
* __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call [Reschedule Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) before removing the unwanted bookings.
|
|
868
|
-
*
|
|
869
|
-
* ### Removal behavior
|
|
870
|
-
*
|
|
871
|
-
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
872
|
-
* You can manage them using single-service booking methods.
|
|
873
|
-
*
|
|
874
|
-
* __Automatic cleanup__: Multi-service bookings must contain at least 2 services.
|
|
875
|
-
* If removal results in only 1 remaining single-service booking for the multi-service booking, the entire multi-service booking is deleted and the remaining single-service booking becomes a standalone booking.
|
|
876
|
-
*
|
|
877
|
-
* __Revision control__: Specify current revision numbers to prevent conflicting modifications during the removal process.
|
|
878
|
-
* @param - ID of the multi-service booking.
|
|
868
|
+
* Reschedule booking using an anonymous token
|
|
869
|
+
* @param - The token provided in the booking links for anonymous access
|
|
870
|
+
* @param - New slot of the booking.
|
|
871
|
+
* @returns Response for RescheduleBookingAnonymously
|
|
879
872
|
*/
|
|
880
|
-
(
|
|
881
|
-
|
|
882
|
-
|
|
873
|
+
(token: string, slot: V2Slot, options: NonNullablePaths<RescheduleBookingAnonymouslyOptions, `revision`, 2>): Promise<NonNullablePaths<RescheduleBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7>>;
|
|
874
|
+
}
|
|
875
|
+
declare function getBookingAnonymously$1(httpClient: HttpClient): GetBookingAnonymouslySignature;
|
|
876
|
+
interface GetBookingAnonymouslySignature {
|
|
877
|
+
/**
|
|
878
|
+
* Get booking using an anonymous token
|
|
879
|
+
* @param - The token provided in the booking links for anonymous access
|
|
880
|
+
* @returns Response for GetBookingAnonymously
|
|
881
|
+
*/
|
|
882
|
+
(token: string): Promise<NonNullablePaths<GetBookingAnonymouslyResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId` | `allowedActionsAnonymously.cancel` | `allowedActionsAnonymously.reschedule`, 7>>;
|
|
883
883
|
}
|
|
884
884
|
declare const onBookingCanceled$1: EventDefinition<BookingCanceledEnvelope, "wix.bookings.v2.booking_canceled">;
|
|
885
885
|
declare const onBookingConfirmed$1: EventDefinition<BookingConfirmedEnvelope, "wix.bookings.v2.booking_confirmed">;
|
|
886
886
|
declare const onBookingCreated$1: EventDefinition<BookingCreatedEnvelope, "wix.bookings.v2.booking_created">;
|
|
887
887
|
declare const onBookingDeclined$1: EventDefinition<BookingDeclinedEnvelope, "wix.bookings.v2.booking_declined">;
|
|
888
|
-
declare const onBookingNumberOfParticipantsUpdated$1: EventDefinition<BookingNumberOfParticipantsUpdatedEnvelope, "wix.bookings.v2.booking_number_of_participants_updated">;
|
|
889
888
|
declare const onBookingRescheduled$1: EventDefinition<BookingRescheduledEnvelope, "wix.bookings.v2.booking_rescheduled">;
|
|
890
889
|
declare const onBookingUpdated$1: EventDefinition<BookingUpdatedEnvelope, "wix.bookings.v2.booking_updated">;
|
|
890
|
+
declare const onBookingNumberOfParticipantsUpdated$1: EventDefinition<BookingNumberOfParticipantsUpdatedEnvelope, "wix.bookings.v2.booking_number_of_participants_updated">;
|
|
891
891
|
|
|
892
|
-
declare const getAnonymousActionDetails: MaybeContext<BuildRESTFunction<typeof getAnonymousActionDetails$1> & typeof getAnonymousActionDetails$1>;
|
|
893
|
-
declare const cancelBookingAnonymously: MaybeContext<BuildRESTFunction<typeof cancelBookingAnonymously$1> & typeof cancelBookingAnonymously$1>;
|
|
894
|
-
declare const rescheduleBookingAnonymously: MaybeContext<BuildRESTFunction<typeof rescheduleBookingAnonymously$1> & typeof rescheduleBookingAnonymously$1>;
|
|
895
|
-
declare const getBookingAnonymously: MaybeContext<BuildRESTFunction<typeof getBookingAnonymously$1> & typeof getBookingAnonymously$1>;
|
|
896
892
|
declare const confirmOrDeclineBooking: MaybeContext<BuildRESTFunction<typeof confirmOrDeclineBooking$1> & typeof confirmOrDeclineBooking$1>;
|
|
897
893
|
declare const bulkConfirmOrDeclineBooking: MaybeContext<BuildRESTFunction<typeof bulkConfirmOrDeclineBooking$1> & typeof bulkConfirmOrDeclineBooking$1>;
|
|
898
|
-
declare const createBooking: MaybeContext<BuildRESTFunction<typeof createBooking$1> & typeof createBooking$1>;
|
|
899
|
-
declare const bulkCreateBooking: MaybeContext<BuildRESTFunction<typeof bulkCreateBooking$1> & typeof bulkCreateBooking$1>;
|
|
900
|
-
declare const rescheduleBooking: MaybeContext<BuildRESTFunction<typeof rescheduleBooking$1> & typeof rescheduleBooking$1>;
|
|
901
|
-
declare const confirmBooking: MaybeContext<BuildRESTFunction<typeof confirmBooking$1> & typeof confirmBooking$1>;
|
|
902
|
-
declare const setBookingSubmissionId: MaybeContext<BuildRESTFunction<typeof setBookingSubmissionId$1> & typeof setBookingSubmissionId$1>;
|
|
903
|
-
declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
|
|
904
|
-
declare const declineBooking: MaybeContext<BuildRESTFunction<typeof declineBooking$1> & typeof declineBooking$1>;
|
|
905
|
-
declare const cancelBooking: MaybeContext<BuildRESTFunction<typeof cancelBooking$1> & typeof cancelBooking$1>;
|
|
906
|
-
declare const updateNumberOfParticipants: MaybeContext<BuildRESTFunction<typeof updateNumberOfParticipants$1> & typeof updateNumberOfParticipants$1>;
|
|
907
|
-
declare const markBookingAsPending: MaybeContext<BuildRESTFunction<typeof markBookingAsPending$1> & typeof markBookingAsPending$1>;
|
|
908
894
|
declare const createMultiServiceBooking: MaybeContext<BuildRESTFunction<typeof createMultiServiceBooking$1> & typeof createMultiServiceBooking$1>;
|
|
909
895
|
declare const rescheduleMultiServiceBooking: MaybeContext<BuildRESTFunction<typeof rescheduleMultiServiceBooking$1> & typeof rescheduleMultiServiceBooking$1>;
|
|
910
896
|
declare const getMultiServiceBookingAvailability: MaybeContext<BuildRESTFunction<typeof getMultiServiceBookingAvailability$1> & typeof getMultiServiceBookingAvailability$1>;
|
|
@@ -916,6 +902,20 @@ declare const bulkGetMultiServiceBookingAllowedActions: MaybeContext<BuildRESTFu
|
|
|
916
902
|
declare const getMultiServiceBooking: MaybeContext<BuildRESTFunction<typeof getMultiServiceBooking$1> & typeof getMultiServiceBooking$1>;
|
|
917
903
|
declare const addBookingsToMultiServiceBooking: MaybeContext<BuildRESTFunction<typeof addBookingsToMultiServiceBooking$1> & typeof addBookingsToMultiServiceBooking$1>;
|
|
918
904
|
declare const removeBookingsFromMultiServiceBooking: MaybeContext<BuildRESTFunction<typeof removeBookingsFromMultiServiceBooking$1> & typeof removeBookingsFromMultiServiceBooking$1>;
|
|
905
|
+
declare const createBooking: MaybeContext<BuildRESTFunction<typeof createBooking$1> & typeof createBooking$1>;
|
|
906
|
+
declare const bulkCreateBooking: MaybeContext<BuildRESTFunction<typeof bulkCreateBooking$1> & typeof bulkCreateBooking$1>;
|
|
907
|
+
declare const rescheduleBooking: MaybeContext<BuildRESTFunction<typeof rescheduleBooking$1> & typeof rescheduleBooking$1>;
|
|
908
|
+
declare const confirmBooking: MaybeContext<BuildRESTFunction<typeof confirmBooking$1> & typeof confirmBooking$1>;
|
|
909
|
+
declare const setBookingSubmissionId: MaybeContext<BuildRESTFunction<typeof setBookingSubmissionId$1> & typeof setBookingSubmissionId$1>;
|
|
910
|
+
declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
|
|
911
|
+
declare const declineBooking: MaybeContext<BuildRESTFunction<typeof declineBooking$1> & typeof declineBooking$1>;
|
|
912
|
+
declare const cancelBooking: MaybeContext<BuildRESTFunction<typeof cancelBooking$1> & typeof cancelBooking$1>;
|
|
913
|
+
declare const updateNumberOfParticipants: MaybeContext<BuildRESTFunction<typeof updateNumberOfParticipants$1> & typeof updateNumberOfParticipants$1>;
|
|
914
|
+
declare const markBookingAsPending: MaybeContext<BuildRESTFunction<typeof markBookingAsPending$1> & typeof markBookingAsPending$1>;
|
|
915
|
+
declare const getAnonymousActionDetails: MaybeContext<BuildRESTFunction<typeof getAnonymousActionDetails$1> & typeof getAnonymousActionDetails$1>;
|
|
916
|
+
declare const cancelBookingAnonymously: MaybeContext<BuildRESTFunction<typeof cancelBookingAnonymously$1> & typeof cancelBookingAnonymously$1>;
|
|
917
|
+
declare const rescheduleBookingAnonymously: MaybeContext<BuildRESTFunction<typeof rescheduleBookingAnonymously$1> & typeof rescheduleBookingAnonymously$1>;
|
|
918
|
+
declare const getBookingAnonymously: MaybeContext<BuildRESTFunction<typeof getBookingAnonymously$1> & typeof getBookingAnonymously$1>;
|
|
919
919
|
/**
|
|
920
920
|
* Triggered when a booking is canceled.
|
|
921
921
|
*/
|
|
@@ -932,10 +932,6 @@ declare const onBookingCreated: BuildEventDefinition<typeof onBookingCreated$1>
|
|
|
932
932
|
* Triggered when a booking is declined.
|
|
933
933
|
*/
|
|
934
934
|
declare const onBookingDeclined: BuildEventDefinition<typeof onBookingDeclined$1> & typeof onBookingDeclined$1;
|
|
935
|
-
/**
|
|
936
|
-
* Triggered when the number of participants is updated.
|
|
937
|
-
*/
|
|
938
|
-
declare const onBookingNumberOfParticipantsUpdated: BuildEventDefinition<typeof onBookingNumberOfParticipantsUpdated$1> & typeof onBookingNumberOfParticipantsUpdated$1;
|
|
939
935
|
/**
|
|
940
936
|
* Triggered when a booking is rescheduled.
|
|
941
937
|
*/
|
|
@@ -944,5 +940,9 @@ declare const onBookingRescheduled: BuildEventDefinition<typeof onBookingResched
|
|
|
944
940
|
* Triggered when a booked schedule is updated.
|
|
945
941
|
*/
|
|
946
942
|
declare const onBookingUpdated: BuildEventDefinition<typeof onBookingUpdated$1> & typeof onBookingUpdated$1;
|
|
943
|
+
/**
|
|
944
|
+
* Triggered when the number of participants is updated.
|
|
945
|
+
*/
|
|
946
|
+
declare const onBookingNumberOfParticipantsUpdated: BuildEventDefinition<typeof onBookingNumberOfParticipantsUpdated$1> & typeof onBookingNumberOfParticipantsUpdated$1;
|
|
947
947
|
|
|
948
948
|
export { AddBookingsToMultiServiceBookingApplicationErrors, AddBookingsToMultiServiceBookingOptions, AddBookingsToMultiServiceBookingResponse, Booking, BookingCanceledEnvelope, BookingConfirmedEnvelope, BookingCreatedEnvelope, BookingDeclinedEnvelope, BookingNumberOfParticipantsUpdatedEnvelope, BookingRescheduledEnvelope, BookingUpdatedEnvelope, BulkConfirmOrDeclineBookingApplicationErrors, BulkConfirmOrDeclineBookingOptions, BulkConfirmOrDeclineBookingRequestBookingDetails, BulkConfirmOrDeclineBookingResponse, BulkCreateBookingApplicationErrors, BulkCreateBookingOptions, BulkCreateBookingResponse, BulkGetMultiServiceBookingAllowedActionsResponse, CancelBookingAnonymouslyOptions, CancelBookingAnonymouslyResponse, CancelBookingApplicationErrors, CancelBookingOptions, CancelBookingResponse, CancelMultiServiceBookingApplicationErrors, CancelMultiServiceBookingOptions, CancelMultiServiceBookingResponse, ConfirmBookingApplicationErrors, ConfirmBookingOptions, ConfirmBookingResponse, ConfirmMultiServiceBookingApplicationErrors, ConfirmMultiServiceBookingOptions, ConfirmMultiServiceBookingResponse, ConfirmOrDeclineBookingApplicationErrors, ConfirmOrDeclineBookingOptions, ConfirmOrDeclineBookingResponse, CreateBookingApplicationErrors, CreateBookingInfo, CreateBookingOptions, CreateBookingResponse, CreateMultiServiceBookingApplicationErrors, CreateMultiServiceBookingOptions, CreateMultiServiceBookingResponse, DeclineBookingApplicationErrors, DeclineBookingOptions, DeclineBookingResponse, DeclineMultiServiceBookingApplicationErrors, DeclineMultiServiceBookingOptions, DeclineMultiServiceBookingResponse, GetAnonymousActionDetailsOptions, GetAnonymousActionDetailsResponse, GetBookingAnonymouslyResponse, GetMultiServiceBookingAvailabilityApplicationErrors, GetMultiServiceBookingAvailabilityResponse, MarkBookingAsPendingApplicationErrors, MarkBookingAsPendingOptions, MarkBookingAsPendingResponse, MarkMultiServiceBookingAsPendingApplicationErrors, MarkMultiServiceBookingAsPendingOptions, MarkMultiServiceBookingAsPendingResponse, MultiServiceBooking, RemoveBookingsFromMultiServiceBookingApplicationErrors, RemoveBookingsFromMultiServiceBookingOptions, RemoveBookingsFromMultiServiceBookingResponse, RescheduleBookingAnonymouslyOptions, RescheduleBookingAnonymouslyResponse, RescheduleBookingApplicationErrors, RescheduleBookingInfo, RescheduleBookingOptions, RescheduleBookingResponse, RescheduleMultiServiceBookingApplicationErrors, RescheduleMultiServiceBookingOptions, RescheduleMultiServiceBookingResponse, SetBookingSubmissionIdApplicationErrors, SetBookingSubmissionIdResponse, UpdateExtendedFieldsApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateNumberOfParticipantsApplicationErrors, UpdateNumberOfParticipantsOptions, UpdateNumberOfParticipantsResponse, V2Slot, addBookingsToMultiServiceBooking, bulkConfirmOrDeclineBooking, bulkCreateBooking, bulkGetMultiServiceBookingAllowedActions, cancelBooking, cancelBookingAnonymously, cancelMultiServiceBooking, confirmBooking, confirmMultiServiceBooking, confirmOrDeclineBooking, createBooking, createMultiServiceBooking, declineBooking, declineMultiServiceBooking, getAnonymousActionDetails, getBookingAnonymously, getMultiServiceBooking, getMultiServiceBookingAvailability, markBookingAsPending, markMultiServiceBookingAsPending, onBookingCanceled, onBookingConfirmed, onBookingCreated, onBookingDeclined, onBookingNumberOfParticipantsUpdated, onBookingRescheduled, onBookingUpdated, removeBookingsFromMultiServiceBooking, rescheduleBooking, rescheduleBookingAnonymously, rescheduleMultiServiceBooking, setBookingSubmissionId, updateExtendedFields, updateNumberOfParticipants };
|