DocWorks for wix-bookings-frontend - 4 changes detected

wix-bookings-frontend/wix-bookings-frontend.service.json

@@ -8,7 +8,21 @@
   "docs":
     { "summary": "The wix-bookings-frontend module contains functionality for working with\n bookings from client-side code.",
       "description":
-        [ "With the Bookings API, you can build a customized bookings experience ",
+        [ "<blockquote class='warning'>",
+          "",
+          "__Deprecation Notice:__",
+          "",
+          "The **Bookings Frontend Velo API** has been replaced with [Time Slots](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/introduction), [Bookings](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction), and [eCommerce](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction) SDK APIs and will be removed on March 31, 2026.",
+          "",
+          "</blockquote>",
+          "",
+          "**Migration Instructions**:",
+          "+ Replace `getServiceAvailability()` with [Bookings Time Slots SDK methods](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/introduction) for availability checking.",
+          "+ Replace `checkoutBooking()` with the [Bookings SDK Create Booking](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/create-booking) and [eCommerce SDK Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) methods for booking creation and payment processing.",
+          "+ Replace `getCheckoutOptions()` by optionally customizing the eCommerce purchase flow using [eCommerce SDK APIs](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction).",
+          "+ See [End-to-End Booking Flows](https://dev.wix.com/docs/sdk/backend-modules/bookings/end-to-end-booking-flows) for complete implementation examples.",
+          "",
+          " With the Bookings API, you can build a customized bookings experience ",
           " for customers to book and check out a service.",
           "",
           " With the Bookings API, you can:",
@@ -58,10 +72,10 @@
                   [ "wix-bookings-frontend.BookingResult" ] },
             "doc": "Fulfilled - Results of the booking checkout." },
         "locations":
-          [ { "lineno": 229,
+          [ { "lineno": 244,
               "filename": "bookings.js" } ],
         "docs":
-          { "summary": "Books a service and processes payment for the service.",
+          { "summary": "**Deprecated.**\nCheckout Booking has been replaced with [Create Booking](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/create-booking) and Wix eCommerce's [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) SDK methods and will be removed on March 31, 2026.",
             "description":
               [ "To understand how `checkoutBooking()` is used in a typical booking lifecycle,",
                 " see Typical Booking Lifecycle ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/sample-flow) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/sample-flow)).",
@@ -267,10 +281,10 @@
                   [ "wix-bookings-frontend.CheckoutMethod" ] },
             "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." },
         "locations":
-          [ { "lineno": 354,
+          [ { "lineno": 371,
               "filename": "bookings.js" } ],
         "docs":
-          { "summary": "Gets the valid checkout options for a service's slot.",
+          { "summary": "**Deprecated.**\nGet Checkout Options will be removed on March 31, 2026. By default, no replacement is needed as the eCommerce purchase flow handles payment options automatically. However, [eCommerce SDK APIs](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction) are available for custom payment flow implementations. See the [End-to-End Booking Flows](https://dev.wix.com/docs/sdk/backend-modules/bookings/end-to-end-booking-flows) for complete implementation examples.",
             "description":
               [ "To understand how `getCheckoutOptions()` is used in a typical booking lifecycle,",
                 " see Typical Booking Lifecycle ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/sample-flow) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/sample-flow)).",
@@ -340,7 +354,8 @@
         "extra":
           {  } },
       { "name": "getServiceAvailability",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "serviceId",
@@ -357,10 +372,10 @@
                   [ "wix-bookings-frontend.ServiceAvailability" ] },
             "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." },
         "locations":
-          [ { "lineno": 292,
+          [ { "lineno": 308,
               "filename": "bookings.js" } ],
         "docs":
-          { "summary": "Gets the available slots for a specific service.",
+          { "summary": "**Deprecated.**\nGet Service Availability has been replaced with [Time Slots](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/introduction) SDK methods and will be removed on March 31, 2026. Depending on your [service type](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types), use the appropriate Time Slots API to replace it. See the [End-to-End Booking Flows](https://dev.wix.com/docs/sdk/backend-modules/bookings/end-to-end-booking-flows) for implementation examples.",
             "description":
               [ "> **Note:** `location` in the slot object is not yet available to all sites.",
                 "",
@@ -609,7 +624,7 @@
   "messages":
     [ { "name": "Address",
         "locations":
-          [ { "lineno": 94,
+          [ { "lineno": 109,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object that contains address information.",
@@ -644,7 +659,7 @@
         "labels": [] },
       { "name": "AddressCoordinates",
         "locations":
-          [ { "lineno": 106,
+          [ { "lineno": 121,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object that contains the geographic coordinates of the address.",
@@ -664,7 +679,7 @@
         "labels": [] },
       { "name": "AvailabilityOptions",
         "locations":
-          [ { "lineno": 36,
+          [ { "lineno": 51,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used when calling getServiceAvailability() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/get-service-availability) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/get-service-availability))\n containing options for which slots should be returned.",
@@ -752,7 +767,7 @@
         "labels": [] },
       { "name": "BookingInfo",
         "locations":
-          [ { "lineno": 128,
+          [ { "lineno": 143,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used when calling checkoutBooking() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/checkout-booking) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/checkout-booking))\n containing information about the slot to be booked.",
@@ -809,7 +824,7 @@
         "labels": [] },
       { "name": "BookingResult",
         "locations":
-          [ { "lineno": 216,
+          [ { "lineno": 231,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object representing the result of a call to checkoutBooking() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/checkout-booking) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/checkout-booking)).",
@@ -864,7 +879,7 @@
         "labels": [] },
       { "name": "BusinessLocation",
         "locations":
-          [ { "lineno": 85,
+          [ { "lineno": 100,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object describing the business location.",
@@ -890,7 +905,7 @@
         "labels": [] },
       { "name": "CheckoutMethod",
         "locations":
-          [ { "lineno": 188,
+          [ { "lineno": 203,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object returned after calling getCheckoutOptions() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/get-checkout-options) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/get-checkout-options))\n containing information about the available payment options for the service and the logged-in user.",
@@ -910,7 +925,7 @@
         "labels": [] },
       { "name": "CheckoutMethodOption",
         "locations":
-          [ { "lineno": 195,
+          [ { "lineno": 210,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object returned after calling getCheckoutOptions() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/get-checkout-options) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/get-checkout-options))\n containing information about the available payment options for the service and the logged-in user.",
@@ -1119,7 +1134,7 @@
           [ "removed" ] },
       { "name": "CheckoutOptionOptions",
         "locations":
-          [ { "lineno": 120,
+          [ { "lineno": 135,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used to request checkout options for the service. Currently, you can request the checkout options using the ID of a slot.",
@@ -1192,7 +1207,7 @@
         "labels": [] },
       { "name": "Constraints",
         "locations":
-          [ { "lineno": 139,
+          [ { "lineno": 154,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object that defines a booking window for limiting when a member can book a slot. For example,\n you can prevent members from booking a service too far in advance, because perhaps the service might\n be discontinued by then. Or, you can prevent members from booking a service right before it starts, as\n this would make it hard to schedule resources.",
@@ -1212,7 +1227,7 @@
         "labels": [] },
       { "name": "FormField",
         "locations":
-          [ { "lineno": 150,
+          [ { "lineno": 165,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used when calling checkoutBooking() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/checkout-booking) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/checkout-booking))\n containing values for form fields required to book the session.",
@@ -1262,7 +1277,7 @@
         "labels": [] },
       { "name": "Location",
         "locations":
-          [ { "lineno": 74,
+          [ { "lineno": 89,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "The location where a service is offered.",
@@ -1285,7 +1300,7 @@
         "labels": [] },
       { "name": "PaidPlan",
         "locations":
-          [ { "lineno": 180,
+          [ { "lineno": 195,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used when calling checkoutBooking() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/checkout-booking) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/checkout-booking))\n containing details about the pricing plan used to pay for the booking.",
@@ -1307,7 +1322,7 @@
         "labels": [] },
       { "name": "PaymentOptions",
         "locations":
-          [ { "lineno": 159,
+          [ { "lineno": 174,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object used when calling checkoutBooking() ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/bookings/checkout-booking) | [Velo](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/checkout-booking))\n containing information about the payment options.",
@@ -1437,11 +1452,10 @@
               "optional": true } ],
         "extra":
           {  },
-        "labels":
-          [ "changed" ] },
+        "labels": [] },
       { "name": "ServiceAvailability",
         "locations":
-          [ { "lineno": 48,
+          [ { "lineno": 63,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.",
@@ -1516,7 +1530,7 @@
         "labels": [] },
       { "name": "Slot",
         "locations":
-          [ { "lineno": 58,
+          [ { "lineno": 73,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object representing a booking slot.",
@@ -1615,7 +1629,7 @@
         "labels": [] },
       { "name": "StreetAddress",
         "locations":
-          [ { "lineno": 113,
+          [ { "lineno": 128,
               "filename": "bookings.js" } ],
         "docs":
           { "summary": "An object representing information about the street name and street number of an address.",