@wix/bookings 1.0.342 → 1.0.344

package/build/cjs/src/bookings-v2-booking.http.d.ts

@@ -1,191 +0,0 @@
-import { RequestOptionsFactory } from '@wix/sdk-types';
-/**
- * Creates a booking.
- *
- *
- * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
- *
- * To create a booking for the entire course, pass a booking with the relevant `schedule`.
- * You can use the Query Availability endpoint to check the availability beforehand.
- *
- * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
- * Then, any specified slot details are calculated.
- *
- * If you create a booking for a new session, we recommend to call Query Availability first.
- * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
- *
- * Bookings are created with a status of `CREATED`.
- * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
- *
- * To create a booking with a given status, pass a booking with the wanted status.
- * This is only permitted for site Owners.
- *
- * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
- * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
- *
- * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
- *
- * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
- * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
- *
- * When creating a booking, you can pass `selectedPaymentOption`.
- * This specifies which payment method the customer plans to use.
- * But it's possible for them to later use another supported payment method.
- *
- * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
- * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
- */
-export declare function createBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Creates multiple bookings.
- *
- *
- * See [`createBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/createbooking) documentation.
- *
- * If for any of the bookings required fields were not passed on the request or if the caller doesn't have the required permissions to create such booking, the call will fail.
- * If the request contains unavailable bookings, the call will be completed successfully, but the unavailable bookings will not be created and will be considered as a failure on the response.
- */
-export declare function bulkCreateBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Reschedules a booking to a different slot or session.
- *
- *
- * You can only reschedule bookings for appointments or classes, you can't
- * reschedule course bookings.
- *
- * The old session is removed from the calendar and the new session is
- * added.
- *
- * If you reschedule a booking for a class session the new session must be an
- * existing session for the same class.
- *
- * You can pass a `participantNotification.message` to notify the customer of
- * the rescheduling. You also need to pass `participantNotification.notifyParticipants`
- * as `true` to actually send the message.
- *
- * In case the service has
- * variants, you can call this endpoint to update the booking's `totalParticipants` or `participantsChoices`.
- * If you provide `participantsChoices`, all of the provided choices must exist for
- * the service. Otherwise, the call returns an `INVALID_SERVICE_CHOICES` error.
- * If you omit `participantsChoices` in the request, the existing choices are
- * kept and not replaced with an empty object.
- *
- * <!-- INTERNAL PERMISSION COMMENT:
- * You need to have the `BOOKINGS.NUMBER_OF_PARTICIPANTS_UPDATE` permission
- * to reschedule bookings including `participantsInfo`.
- * <!--END: INTERNAL PERMISSION COMMENT-->
- *
- * In case you want to reschedule a booking on behalf of a customer, we recommend
- * to pass `flowControlSettings.ignoreReschedulePolicy` as `false`. This
- * ensures that the rescheduling is validated against the service's rescheduling
- * policy.
- */
-export declare function rescheduleBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Confirms a booking request and changes the booking status to `CONFIRMED`.
- *
- *
- * Calling this method doesn't check whether a slot or schedule is still
- * available at this time.
- *
- * You can only confirm bookings for services that require the owner's manual
- * approval for bookings and that have a status of `PENDING`.
- *
- * For appointment services the slot may become unavailable, depending on the
- * [service's](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business)
- * `policy.bookingApprovalPolicy.requestsAffectsAvailability`.
- *
- * Calling this method also changes the
- * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
- * `participants.approvalStatus` to `APPROVED`.
- *
- * You can pass a `participantNotification.message` to notify the customer of
- * the confirmation. You also need to pass `participantNotification.notifyParticipants`
- * as `true` to actually send the message.
- *
- * Bookings are automatically confirmed when the
- * service is configured to automatically confirm
- * bookings and the [eCommerce order](https://www.wix.com/velo/reference/wix-ecom-backend/orders)
- * has been approved. The slot's or schedule's availability is checked just
- * before confirming the booking as part of the automatic flow.
- */
-export declare function bookingsConfirmBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Updates the extended fields for a booking.
- *
- *
- * Extended fields must first be configured in the Wix Developers Center.
- *
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
- */
-export declare function updateExtendedFields(payload: object): RequestOptionsFactory<any>;
-/**
- * Declines a `PENDING` booking request and changes the booking status to
- * `DECLINED`.
- *
- * Calling this method also changes the
- * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
- * `participants.approvalStatus` to `DECLINED`.
- *
- * You can only decline bookings for services that require the owner's manual
- * approval for bookings and that have a status of `PENDING`.
- *
- * You can pass a `participantNotification.message` to notify the customer of
- * the decline. You also need to pass `participantNotification.notifyParticipants`
- * as `true` to actually send the message.
- */
-export declare function bookingsDeclineBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Cancels a booking.
- *
- *
- * The booking status changes to `CANCELED`.
- *
- * If the booking was for an appointment, the corresponding session is
- * deleted from the business calendar.
- *
- * If the booking was for a class or course, the participants are removed
- * from the class session or the course. But the course or class session
- * remains on the business calendar.
- *
- * You can pass a `participantNotification.message` to notify the customer of
- * the cancelation. You also need to pass `participantNotification.notifyParticipants`
- * as `true` to actually send the message.
- *
- * In case you want to cancel a booking on behalf of a customer, we recommend
- * to pass `flowControlSettings.ignoreCancellationPolicy` as `false`. This
- * ensures that the cancelation is validated against the service's cancelation
- * policy.
- */
-export declare function bookingsCancelBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Updates the number of participants for a booking.
- *
- *
- * You can only update the number of participants for class and course
- * bookings, you can't update it for appointment bookings.
- *
- * Calling this method also changes the
- * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)
- * `totalNumberOfParticipants`.
- *
- * When updating the number of participants for a booking you must pass either
- * `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`
- * for services that have variants,
- * all of the provided choices must exist for the service. Otherwise, the
- * call returns an `INVALID_SERVICE_CHOICES` error.
- */
-export declare function bookingsUpdateNumberOfParticipants(payload: object): RequestOptionsFactory<any>;
-/**
- * Use `confirmOrDeclineBooking()` to determine if the booking is valid, payment is received, and the booking can be processed.
- * Call `confirmOrDeclineBooking()` after checkout or after calling `createBooking()` to verify the booking.
- *
- * + If a session is valid and payment is received, the booking is visible on the calendar.
- * + If a session is double booked, `confirmOrDeclineBooking()` can catch this and decline the duplicate booking, the booking is not visible on the calendar.
- */
-export declare function confirmOrDeclineBooking(payload: object): RequestOptionsFactory<any>;
-/**
- * Confirm or decline multiple bookings.
- * See [Confirm Or Decline Booking] (https://dev.wix.com/api/rest/wix-bookings/confirmation/confirm-or-decline-booking) documentation.
- */
-export declare function bulkConfirmOrDeclineBooking(payload: object): RequestOptionsFactory<any>;