@wix/auto_sdk_bookings_pricing 1.0.3 → 1.0.5

package/build/cjs/src/bookings-v2-price-info-pricing.universal.d.ts

@@ -1,25 +1,25 @@
 export interface PriceInfo extends PriceInfoTotalPriceOneOf {
     /**
-     * Calculated total price. Available only when the
-     * [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s
-     * price has been set up as a numerical value in the
-     * `schedule.rate.labeledPriceOptions` object.
+     * Calculated total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `FIXED`, `VARIED`, or `NO_FEE`.
      */
     calculatedPrice?: number;
     /**
-     * Description of the total price. __Deprecated.__ Use `priceDescriptionInfo.original` instead.
-     * `priceDescription` will be removed on March 31, 2025.
-     * @deprecated Description of the total price. Available only when the
-     * [service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s
-     * price has been set up as a text value in the
-     * [`schedule.rate.priceText`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.
+     * Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
+     * @deprecated Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
      * @replacedBy price_description_info.original
      * @targetRemovalDate 2025-01-10
      */
     priceDescription?: string;
     /**
-     * Description of the total price. Available only when the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s
-     * `payment.rateType` is set to `CUSTOM`.
+     * Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
      */
     priceDescriptionInfo?: PriceDescriptionInfo;
     /**
@@ -28,56 +28,74 @@ export interface PriceInfo extends PriceInfoTotalPriceOneOf {
      */
     bookingLineItems?: BookingLineItem[];
     /**
-     * Total deposit the customer must pay when booking the service.
-     *
-     * Available when: The service includes a deposit.
+     * Total deposit the customer must pay when booking the service. Available if
+     * the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.options.deposit` is set to `true`.
      */
     deposit?: number | null;
 }
 /** @oneof */
 export interface PriceInfoTotalPriceOneOf {
     /**
-     * Calculated total price. Available only when the
-     * [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s
-     * price has been set up as a numerical value in
-     * `schedule.rate.labeledPriceOptions`.
-     *
+     * Calculated total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `FIXED`, `VARIED`, or `NO_FEE`.
      */
     calculatedPrice?: number;
     /**
-     * Description of the total price. __Deprecated.__ Use `priceDescriptionInfo.original` instead.
-     * `priceDescription` will be removed on March 31, 2025.
-     * @deprecated Description of the total price. Available only when the
-     * [service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s
-     * price has been set up as a text value in the
-     * [`schedule.rate.priceText`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.
+     * Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
+     * @deprecated Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
      * @replacedBy price_description_info.original
      * @targetRemovalDate 2025-01-10
      */
     priceDescription?: string;
     /**
-     * Description of the total price. Available only when the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s
-     * `payment.rateType` is set to `CUSTOM`.
+     * Description of the total price. Available if the _service's_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
+     * `payment.rateType` is `CUSTOM`.
      */
     priceDescriptionInfo?: PriceDescriptionInfo;
 }
 export interface BookingLineItem {
     /**
-     * Service ID.
+     * _Service ID_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)).
+     *
+     * Required in *Calculate Price*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/calculate-price))
+     * if the site uses Wix Bookings' default pricing logic.
      *
-     * Required when not using Wix Booking's default pricing logic.
+     * Optional in *Calculate Price*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/calculate-price))
+     * if the site use pricing logic defined by a
+     * Wix Bookings Pricing Integration service plugin*
+     * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction))
+     * integration.
      * @format GUID
      */
     serviceId?: string | null;
     /**
-     * Resource ID. Required for services of type appointment or class.
+     * _Resource ID_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)).
+     * Required in *Calculate Price*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/calculate-price))
+     * and *Preview Price*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/preview-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/preview-price))
+     * for appointment-based services and classes.
      * @format GUID
      */
     resourceId?: string | null;
     /**
      * Custom choices. Choices are specific values for an option the customer can choose to book.
      * For example, the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
-     * Each choice may have a different price.
+     * Each choice may have a different price. Refer to the *Service Options And Variants API*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction))
+     * for more details.
      */
     choices?: ServiceChoice[];
     /**
@@ -93,7 +111,7 @@ export interface BookingLineItem {
 }
 export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
     /**
-     * Value for one of the choices in the `CustomServiceOption.choices` list.
+     * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
      * Choices are specific values for an option the customer can choose to book. For example,
      * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
      * Each choice may have a different price.
@@ -111,7 +129,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
 /** @oneof */
 export interface ServiceChoiceChoiceOneOf {
     /**
-     * Value for one of the choices in the `CustomServiceOption.choices` list.
+     * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
      * Choices are specific values for an option the customer can choose to book. For example,
      * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
      * Each choice may have a different price.
@@ -136,12 +154,15 @@ export interface Duration {
 }
 export interface PriceDescriptionInfo {
     /**
-     * Price description in the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages).
+     * Price description in the site's main language. Refer to the *Site Properties API*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/introduction))
+     * for more details.
      * @maxLength 50
      */
     original?: string;
     /**
-     * Translated price description. Available if the customer booked in a language other than the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages).
+     * Translated price description. Available if the booking was made in a
+     * secondary language.
      * @maxLength 50
      */
     translated?: string | null;
@@ -159,7 +180,11 @@ export interface PreviewPriceResponse {
     priceInfo?: PriceInfo;
 }
 export interface CalculatePriceRequest {
-    /** Booking to calculate the price for. */
+    /**
+     * _Booking_
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/introduction))
+     * to calculate the base price for.
+     */
     booking: Booking;
 }
 /** An entity representing a scheduled appointment, class session, or course. */
@@ -200,24 +225,10 @@ export interface Booking extends BookingParticipantsInfoOneOf {
     /** Additional custom fields submitted with the booking form. */
     additionalFields?: CustomFormField[];
     /**
-     * Booking status.
-     * One of:
-     * - `"CREATED"` - The booking was created.
-     * - `"UPDATED"` - The booking was updated.
-     * - `"CONFIRMED"` - The booking was confirmed and appears on the bookings calendar. A booking can be manually confirmed using the [`confirmOrDecline()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/confirmordeclinebooking) API. A booking can be automatically confirmed when the following requirements are met:
-     *     + The service is configured as automatically confirmed.
-     *     + The system invoked the eCommerce checkout API and created an order.
-     * - `"CANCELED"` - The booking has been canceled and synced to the bookings calendar.
-     * The booking can be canceled using [`cancelBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/cancelbooking) API.
-     * - `"PENDING"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.
-     * Bookings can be manually set as `PENDING` using the `setAsPending()` API, by those with Manage Booking Status permissions scopes.
-     * Bookings can be automatically set as `PENDING` when the following requirements are met:
-     *     + The service is configured as manually confirmed.
-     *     + Invoking the eCommerce checkout API and an order has been created.
-     * - `"WAITING_LIST"` - The booking is on a waiting list.
-     * - `"DECLINED"` - The booking was declined by the owner and synced to the Bookings calendar. Bookings can be manually declined using the [`declineBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/declinebooking) API by those with Manage Booking Status permission scopes. Bookings can be automatically declined when one of the following requirements are met:
-     *     + Invoking the `eCommerce checkout` API and the order declined event has been sent.
-     *     + Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking.
+     * Booking status. A booking is automatically confirmed if the service allows it
+     * and an eCommerce order is created. It is automatically declined if there is a
+     * double booking and the customer hasn't paid or is eligible for an automatic
+     * refund. Currently, only payments with pricing plans are automatically refundable.
      */
     status?: BookingStatus;
     /**
@@ -228,12 +239,13 @@ export interface Booking extends BookingParticipantsInfoOneOf {
      */
     paymentStatus?: PaymentStatus;
     /**
-     * Selected payment option.
-     *
-     * Supported values: `"OFFLINE"`, `"ONLINE"`, `"MEMBERSHIP"`, `"MEMBERSHIP_OFFLINE"`.
-     *
-     * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.
-     * When undefined, the payment option is resolved by the service configuration on checkout.
+     * Payment option selected by the customer. If the customer hasn't completed their
+     * checkout, they may still change the payment method. Must be one of the payment
+     * options offered by the service ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)),
+     * unless `skipSelectedPaymentOptionValidation` is `true`.
+     * When undefined during an *eCommerce checkout*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)),
+     * Wix Bookings uses the service's default payment option
      */
     selectedPaymentOption?: SelectedPaymentOption;
     /**
@@ -243,7 +255,12 @@ export interface Booking extends BookingParticipantsInfoOneOf {
     _createdDate?: Date | null;
     /** External user ID that you can provide. */
     externalUserId?: string | null;
-    /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */
+    /**
+     * Revision number to be used when updating, rescheduling, or cancelling the
+     * booking. Increments by 1 each time the booking is updated, rescheduled, or
+     * canceled. To prevent conflicting changes, the current revision must be
+     * specified when updating the booking.
+     */
     revision?: string | null;
     /**
      * ID of the creator of the booking.
@@ -500,7 +517,11 @@ export interface ContactDetails {
     /** Contact's last name. */
     lastName?: string | null;
     /**
-     * Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet).
+     * Contact's email. If no [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * with this email exist, a new contact is created.
+     * Used to validate coupon usage limitations per contact. If not specified,
+     * the coupon usage limitation will not be enforced. (Coupon usage limitation
+     * validation is not supported yet).
      * @format EMAIL
      */
     email?: string | null;
@@ -590,11 +611,6 @@ export interface CustomFormField {
      * @readonly
      */
     label?: string | null;
-    /**
-     * Form field value's type at the time of submission.
-     *
-     * Supported values: `"SHORT_TEXT"`, `"LONG_TEXT"`, `"CHECK_BOX"`
-     */
     valueType?: ValueType;
 }
 export declare enum ValueType {
@@ -801,12 +817,12 @@ export interface FlowControlSettings {
 }
 export interface ExtendedFields {
     /**
-     * Data Extensions extended fields expressed as a set of key-value pairs:
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
      *
-     * `key:value`
+     * You can only access fields for which you have the appropriate permissions.
      *
-     * + `key` is the namespace, type `string`.
-     * + `value` is the data of the extended fields data, type `struct`.
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
      */
     namespaces?: Record<string, Record<string, any>>;
 }
@@ -814,7 +830,7 @@ export interface ParticipantChoices {
     /**
      * Information about the booked service choices. Includes the number of participants.
      * @minSize 1
-     * @maxSize 10
+     * @maxSize 20
      */
     serviceChoices?: ServiceChoices[];
 }
@@ -842,7 +858,7 @@ export interface MultiServiceBookingInfo {
     type?: MultiServiceBookingType;
 }
 export interface CalculatePriceResponse {
-    /** Information about each line item's price and the actual total base price. */
+    /** Information about each line item's base price and the total base price. */
     priceInfo?: PriceInfo;
 }
 interface PriceDescriptionInfoNonNullableFields {
@@ -872,33 +888,30 @@ export interface CalculatePriceResponseNonNullableFields {
     priceInfo?: PriceInfoNonNullableFields;
 }
 /**
- * Previews the base price for a set of line items belonging to the same service
- * before a potential booking is actually created.
+ * Previews the base price for a set of line items belonging to the same
+ * service, before a booking is created. During the booking flow, additional
+ * taxes and fees may be added to the base price.
  *
  *
+ * ## Response
  *
- * The returned price preview information about each line
- * item's price and sums up each line item's price.
+ * The response includes each line item's individual preview price and the
+ * total of all line item preview prices. Note that the final price upon
+ * booking creation may differ from the preview price.
  *
- * The previewed price is not the actual price that will be used to charge the customer.
- * `Preview Price` only estimates the base price by adding up the price
- * of each line item before
- * the booking is actually created.
+ * ## Errors
  *
- * Use [`Calculate Price`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice) to get the base price
- * after the booking is created.
+ * _Preview Price_ fails if:
  *
- * Passing line items that belong to different services results in an error.
+ * - You specify line items that belong to different *services*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)).
+ * - The site is using the *Bookings Pricing Integration SPI*
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction)).
  *
- * ## Calculating the previewed price
+ * ## When to call Calculate Price instead
  *
- * Wix Bookings has its own default pricing logic for previewing the price. You must
- * pass the `serviceId` in the `slot`
- * or `schedule` object to `previewPrice()`.
- *
- * You cannot call `previewPrice()` if you have customized Bookings pricing logic using the
- * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin. Calling `previewPrice` if custom pricing
- * logic has been implemented for the site results in an error.
+ * To retrieve the price of an existing booking, call *Calculate Price*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/calculate-price)).
  * @param bookingLineItems - List of line items to preview the price for.
  * @public
  * @documentationMaturity preview
@@ -923,30 +936,34 @@ export declare function previewPrice(bookingLineItems: BookingLineItem[]): Promi
  * Calculates the base price of a booking.
  *
  *
+ * The returned price serves as the foundation for charging the customer. During the
+ * _eCommerce checkout_
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/introduction)),
+ * additional taxes and fees may be added to this base price.
  *
- * You can call `calculatePrice()` after a booking is created. The returned calculated price includes information about each line
- * item's price and the booking's total price.
- *
- * You can use `previewPrice()` to get the base price
- * before a booking is created.
+ * ## Price calculation method
  *
- * The calculated price is the base price that will be used as a basis for charging the customer.
- * During checkout, additional taxes
- * and fees might be added to this base price.
+ * By default, Wix Bookings calculates a booking's price based on the relevant
+ * `serviceOptionsAndVariants.variants.values.price`
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+ * You must then specify either `booking.bookedEntity.slot.serviceId` or
+ * `booking.bookedEntity.schedule.scheduleId`.
  *
- * ## Calculating the price
+ * If the business uses the *Wix Bookings Pricing Integration service plugin*
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction)),
+ * the returned `priceInfo` object reflects values received from the SPI implementor in
+ * _Calculate Price_
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/calculate-price)).
+ * In this case, it suffices to specify `booking.bookedEntity`.
  *
- * Wix Bookings has its own default pricing logic for calculating the price. When
- * using Wix Bookings' default pricing logic, you must pass the `serviceId` in the `slot`
- * or `schedule` object to `calculatePrice()`.
+ * ## When to call Preview Price instead
  *
- * Alternatively you can customize the pricing logic using the
- * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin.
- * If you integrate with a pricing provider, the customized pricing logic becomes
- * the default logic. This means that, if the Custom Pricing service plugin is implemented,
- * when calling `calculatePrice()`,
- * the customized logic is used instead.
- * @param booking - Booking to calculate the price for.
+ * To estimate the price for multiple booking line items before the booking exists,
+ * call *Preview Price*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/preview-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/preview-price)).
+ * @param booking - _Booking_
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/introduction))
+ * to calculate the base price for.
  * @public
  * @documentationMaturity preview
  * @requiredField booking

package/build/cjs/src/bookings-v2-price-info-pricing.universal.js

@@ -157,33 +157,30 @@ var IdentityType;
     IdentityType["APP"] = "APP";
 })(IdentityType || (exports.IdentityType = IdentityType = {}));
 /**
- * Previews the base price for a set of line items belonging to the same service
- * before a potential booking is actually created.
+ * Previews the base price for a set of line items belonging to the same
+ * service, before a booking is created. During the booking flow, additional
+ * taxes and fees may be added to the base price.
  *
  *
+ * ## Response
  *
- * The returned price preview information about each line
- * item's price and sums up each line item's price.
+ * The response includes each line item's individual preview price and the
+ * total of all line item preview prices. Note that the final price upon
+ * booking creation may differ from the preview price.
  *
- * The previewed price is not the actual price that will be used to charge the customer.
- * `Preview Price` only estimates the base price by adding up the price
- * of each line item before
- * the booking is actually created.
+ * ## Errors
  *
- * Use [`Calculate Price`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice) to get the base price
- * after the booking is created.
+ * _Preview Price_ fails if:
  *
- * Passing line items that belong to different services results in an error.
+ * - You specify line items that belong to different *services*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)).
+ * - The site is using the *Bookings Pricing Integration SPI*
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction)).
  *
- * ## Calculating the previewed price
+ * ## When to call Calculate Price instead
  *
- * Wix Bookings has its own default pricing logic for previewing the price. You must
- * pass the `serviceId` in the `slot`
- * or `schedule` object to `previewPrice()`.
- *
- * You cannot call `previewPrice()` if you have customized Bookings pricing logic using the
- * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin. Calling `previewPrice` if custom pricing
- * logic has been implemented for the site results in an error.
+ * To retrieve the price of an existing booking, call *Calculate Price*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/calculate-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/calculate-price)).
  * @param bookingLineItems - List of line items to preview the price for.
  * @public
  * @documentationMaturity preview
@@ -231,30 +228,34 @@ exports.previewPrice = previewPrice;
  * Calculates the base price of a booking.
  *
  *
+ * The returned price serves as the foundation for charging the customer. During the
+ * _eCommerce checkout_
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/introduction)),
+ * additional taxes and fees may be added to this base price.
  *
- * You can call `calculatePrice()` after a booking is created. The returned calculated price includes information about each line
- * item's price and the booking's total price.
- *
- * You can use `previewPrice()` to get the base price
- * before a booking is created.
+ * ## Price calculation method
  *
- * The calculated price is the base price that will be used as a basis for charging the customer.
- * During checkout, additional taxes
- * and fees might be added to this base price.
+ * By default, Wix Bookings calculates a booking's price based on the relevant
+ * `serviceOptionsAndVariants.variants.values.price`
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
+ * You must then specify either `booking.bookedEntity.slot.serviceId` or
+ * `booking.bookedEntity.schedule.scheduleId`.
  *
- * ## Calculating the price
+ * If the business uses the *Wix Bookings Pricing Integration service plugin*
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction)),
+ * the returned `priceInfo` object reflects values received from the SPI implementor in
+ * _Calculate Price_
+ * ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/calculate-price)).
+ * In this case, it suffices to specify `booking.bookedEntity`.
  *
- * Wix Bookings has its own default pricing logic for calculating the price. When
- * using Wix Bookings' default pricing logic, you must pass the `serviceId` in the `slot`
- * or `schedule` object to `calculatePrice()`.
+ * ## When to call Preview Price instead
  *
- * Alternatively you can customize the pricing logic using the
- * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin.
- * If you integrate with a pricing provider, the customized pricing logic becomes
- * the default logic. This means that, if the Custom Pricing service plugin is implemented,
- * when calling `calculatePrice()`,
- * the customized logic is used instead.
- * @param booking - Booking to calculate the price for.
+ * To estimate the price for multiple booking line items before the booking exists,
+ * call *Preview Price*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/pricing/preview-price) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-api/preview-price)).
+ * @param booking - _Booking_
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/introduction))
+ * to calculate the base price for.
  * @public
  * @documentationMaturity preview
  * @requiredField booking

package/build/cjs/src/bookings-v2-price-info-pricing.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-v2-price-info-pricing.universal.js","sourceRoot":"","sources":["../../../src/bookings-v2-price-info-pricing.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,2GAA6F;AAwT7F;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;IACvC,kEAAuC,CAAA;AACzC,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAgJD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA6JD,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kDAAkD;IAClD,sCAAyB,CAAA;IACzB,iBAAiB;IACjB,oCAAuB,CAAA;IACvB,sGAAsG;IACtG,oCAAuB,CAAA;AACzB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAED,sBAAsB;AACtB,IAAY,aAoCX;AApCD,WAAY,aAAa;IACvB;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;;;OAKG;IACH,wCAAuB,CAAA;IACvB;;;;;;OAMG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,oCAAmB,CAAA;IACnB,6EAA6E;IAC7E,sCAAqB,CAAA;IACrB;;;;;;OAMG;IACH,8CAA6B,CAAA;AAC/B,CAAC,EApCW,aAAa,6BAAb,aAAa,QAoCxB;AAED;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,8BAA8B;IAC9B,sCAAqB,CAAA;IACrB,iCAAiC;IACjC,8BAAa,CAAA;IACb,qCAAqC;IACrC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,qCAAqC;IACrC,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;;;;GAMG;AACH,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,gCAAgC;IAChC,gDAAuB,CAAA;IACvB,uBAAuB;IACvB,4CAAmB,CAAA;IACnB,sBAAsB;IACtB,0CAAiB,CAAA;IACjB,wCAAwC;IACxC,kDAAyB,CAAA;IACzB;;;OAGG;IACH,kEAAyC,CAAA;AAC3C,CAAC,EAdW,qBAAqB,qCAArB,qBAAqB,QAchC;AAoBD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qDAAyC,CAAA;IACzC,uBAAW,CAAA;IACX,qCAAyB,CAAA;AAC3B,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4CAAmC,CAAA;IACnC,8BAAqB,CAAA;IACrB,8BAAqB,CAAA;AACvB,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAiED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA6GD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACI,KAAK,UAAU,YAAY,CAChC,gBAAmC;IAEnC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,gCAAgC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,oCAmCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACI,KAAK,UAAU,cAAc,CAClC,OAAgB;IAEhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;YAC7C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjCD,wCAiCC"}
+{"version":3,"file":"bookings-v2-price-info-pricing.universal.js","sourceRoot":"","sources":["../../../src/bookings-v2-price-info-pricing.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,2GAA6F;AAyU7F;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;IACvC,kEAAuC,CAAA;AACzC,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAgJD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA4JD,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kDAAkD;IAClD,sCAAyB,CAAA;IACzB,iBAAiB;IACjB,oCAAuB,CAAA;IACvB,sGAAsG;IACtG,oCAAuB,CAAA;AACzB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAED,sBAAsB;AACtB,IAAY,aAoCX;AApCD,WAAY,aAAa;IACvB;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;;;OAKG;IACH,wCAAuB,CAAA;IACvB;;;;;;OAMG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,oCAAmB,CAAA;IACnB,6EAA6E;IAC7E,sCAAqB,CAAA;IACrB;;;;;;OAMG;IACH,8CAA6B,CAAA;AAC/B,CAAC,EApCW,aAAa,6BAAb,aAAa,QAoCxB;AAED;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,8BAA8B;IAC9B,sCAAqB,CAAA;IACrB,iCAAiC;IACjC,8BAAa,CAAA;IACb,qCAAqC;IACrC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,qCAAqC;IACrC,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;;;;GAMG;AACH,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,gCAAgC;IAChC,gDAAuB,CAAA;IACvB,uBAAuB;IACvB,4CAAmB,CAAA;IACnB,sBAAsB;IACtB,0CAAiB,CAAA;IACjB,wCAAwC;IACxC,kDAAyB,CAAA;IACzB;;;OAGG;IACH,kEAAyC,CAAA;AAC3C,CAAC,EAdW,qBAAqB,qCAArB,qBAAqB,QAchC;AAoBD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qDAAyC,CAAA;IACzC,uBAAW,CAAA;IACX,qCAAyB,CAAA;AAC3B,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4CAAmC,CAAA;IACnC,8BAAqB,CAAA;IACrB,8BAAqB,CAAA;AACvB,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAiED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA6GD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACI,KAAK,UAAU,YAAY,CAChC,gBAAmC;IAEnC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,gCAAgC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,oCAmCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACI,KAAK,UAAU,cAAc,CAClC,OAAgB;IAEhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;YAC7C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjCD,wCAiCC"}