@wix/auto_sdk_bookings_pricing 1.0.39 → 1.0.41

package/build/cjs/index.typings.d.ts

@@ -1,27 +1,20 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
 interface PriceInfo extends PriceInfoTotalPriceOneOf {
-    /**
-     * 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`.
-     */
+    /** 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. 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`.
+     * 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 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`.
+     * 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;
     /**
@@ -30,74 +23,53 @@ interface PriceInfo extends PriceInfoTotalPriceOneOf {
      */
     bookingLineItems?: BookingLineItem[];
     /**
-     * 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`.
+     * 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 */
 interface PriceInfoTotalPriceOneOf {
-    /**
-     * 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`.
-     */
+    /** 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. 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`.
+     * 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 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`.
+     * 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;
 }
 interface BookingLineItem {
     /**
-     * _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.
+     * 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)).
      *
-     * 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.
+     * Required parameter in:
+     * - 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 all service types. All line items must have the same service ID.
+     * - 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)) when using Wix Bookings' default pricing logic. Optional in Calculate Price when using a Pricing Service Provider Plugin.
      * @format GUID
      */
     serviceId?: string | null;
     /**
-     * _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.
+     * 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 parameter 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)) for all service types ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
+     * - 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. Optional in Preview Price for courses.
      * @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. 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.
+     * Service choices selected by the customer when booking.
+     * Choices are specific values for service options that may affect pricing. For example, the option `ageGroup` may have choices like `child`, `student`, `adult`, and `senior`, each with different pricing.
+     * 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[];
     /**
@@ -156,53 +128,54 @@ interface Duration {
 }
 interface PricingServiceChoices {
     /**
-     * Number of participants for this variant
+     * Number of participants for this service variant.
      * @min 1
      */
     numberOfParticipants?: number | null;
     /**
-     * Service choices for these participants.
+     * Service choices selected by these participants.
+     * Each choice represents a specific value for a service option.
+     * For example, age group, duration, or equipment type.
      * @maxSize 5
      */
     choices?: ServiceChoice[];
     /**
-     * Price per participant for the line item.
+     * Price per participant for this service variant.
      * @readonly
      */
     pricePerParticipant?: number | null;
 }
 interface PriceDescriptionInfo {
     /**
-     * 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.
+     * 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 booking was made in a
-     * secondary language.
+     * Translated price description.
+     * Available if the booking was made in a secondary language.
      * @maxLength 50
      */
     translated?: string | null;
 }
 interface PreviewPriceRequest {
     /**
-     * List of line items to preview the price for.
+     * Booking line items to preview pricing for.
+     * All line items must belong to the same service ([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)).
      * @minSize 1
      * @maxSize 20
      */
     bookingLineItems: BookingLineItem[];
 }
 interface PreviewPriceResponse {
-    /** Information about each line item's price and the estimated total price based on the line items. */
+    /** Pricing information including individual line item costs and total estimated price. */
     priceInfo?: PriceInfo;
 }
 interface CalculatePriceRequest {
     /**
-     * _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.
+     * Existing 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.
+     * Must include `bookedEntity` details and participant information.
      */
     booking: Booking;
 }
@@ -957,6 +930,7 @@ interface CalculatePriceResponse {
     /** Information about each line item's base price and the total base price. */
     priceInfo?: PriceInfo;
 }
+/** @docsIgnore */
 type PreviewPriceApplicationErrors = {
     code?: 'INVALID_SERVICE_ID';
     description?: string;
@@ -970,6 +944,7 @@ type PreviewPriceApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CalculatePriceApplicationErrors = {
     code?: 'INVALID_BOOKING';
     description?: string;
@@ -992,80 +967,54 @@ type CalculatePriceApplicationErrors = {
     data?: Record<string, any>;
 };
 /**
- * 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 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.
- *
- * ## Errors
+ * Previews the base price for a set of line items belonging to the same service, before a booking is created.
  *
- * _Preview Price_ fails if:
+ * The response includes each line item's individual preview price and the total of all line item preview prices.
+ * In most situations, the preview price matches the final booking price when using the same parameters.
+ * The final amount may differ due to discounts, booking fees, payment processing charges, or service price changes made by the business between preview and booking creation.
  *
- * - 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)).
+ * Preview Price fails if:
  *
- * ## When to call Calculate Price instead
+ * - 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 a Bookings Pricing Integration Service Plugin ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction)). Note that external apps can't currently check whether a plugin is installed on the site before calling Preview Price.
  *
- * 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.
+ * 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)) instead.
+ * @param bookingLineItems - Booking line items to preview pricing for.
+ * All line items must belong to the same service ([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)).
  * @public
- * @documentationMaturity preview
  * @requiredField bookingLineItems
  * @permissionId BOOKINGS.PRICE_PREVIEW
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn com.wixpress.bookings.pricing.BookingsPricingService.PreviewPrice
  */
 declare function previewPrice(bookingLineItems: BookingLineItem[]): Promise<NonNullablePaths<PreviewPriceResponse, `priceInfo.calculatedPrice` | `priceInfo.priceDescription` | `priceInfo.priceDescriptionInfo.original` | `priceInfo.bookingLineItems`, 4> & {
     __applicationErrorsType?: PreviewPriceApplicationErrors;
 }>;
 /**
- * Calculates the base price of a booking.
+ * Calculates the current base price for an existing 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.
+ * Use this method to display booking costs in external apps or dashboards, or to retrieve accurate pricing for bookings created through other channels.
  *
- * ## Price calculation method
+ * The returned price represents the fundamental booking cost before additional charges during 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)). For recently created unpaid bookings, this typically matches the original booking price. However, this method calculates prices based on the service's current pricing configuration, so the returned price may differ from the original booking price if service pricing has changed since the booking was created.
  *
- * 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`.
+ * ## Price calculation methods
  *
- * 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`.
+ * *Standard pricing**: Wix Bookings calculates prices based on the number of participants for each service variant ([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)).
+ * Specify `booking.bookedEntity.slot.serviceId` for appointment-based services and classes, or `booking.bookedEntity.schedule.serviceId` for courses.
  *
- * ## When to call Preview Price instead
+ * *Custom pricing**: When a [Pricing Service Provider Plugin](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/pricing-integration-service-plugin/introduction) is installed, Calculate Price gets responses directly from the external provider instead of using standard Wix pricing logic.
+ * In this case, specify `booking.bookedEntity`. Note that external apps can't currently check whether a plugin is installed on the site before calling Calculate Price.
  *
- * 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.
+ * 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)) instead.
+ * @param booking - Existing 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.
+ * Must include `bookedEntity` details and participant information.
  * @public
- * @documentationMaturity preview
  * @requiredField booking
  * @permissionId BOOKINGS.PRICE_CALCULATE
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn com.wixpress.bookings.pricing.BookingsPricingService.CalculatePrice
  */
 declare function calculatePrice(booking: Booking): Promise<NonNullablePaths<CalculatePriceResponse, `priceInfo.calculatedPrice` | `priceInfo.priceDescription` | `priceInfo.priceDescriptionInfo.original` | `priceInfo.bookingLineItems`, 4> & {