From dec4875fcc9401f97f507c045e930f87d11a5a86 Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Thu, 24 Nov 2022 10:58:19 +0000 Subject: [PATCH 01/20] Published by the Tech Writer Single Sourcing Tool --- .../wix-bookings/guides/sample-flow.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 wix-bookings/wix-bookings/guides/sample-flow.md diff --git a/wix-bookings/wix-bookings/guides/sample-flow.md b/wix-bookings/wix-bookings/guides/sample-flow.md new file mode 100644 index 0000000000..ebfe80c2bd --- /dev/null +++ b/wix-bookings/wix-bookings/guides/sample-flow.md @@ -0,0 +1,39 @@ +# Typical Booking Sample Flow + +**TBD** _Make sure to update all links because I am moving this out of the Intro description._ + +The following list outlines a sample flow in a typical booking lifecycle: + +1. Get a list of services from one of: + + A dataset connected to the **Bookings/Services** collection. + + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. +1. A service is selected. +1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function + using the selected service's **Service ID** (`_id`) value. (Optionally, + you can pass a `AvailabilityOptions` + object to change the limits on the slots that are returned.) +1. You can match the returned slots to their related staff member items using + the **Bookings/Staff** collection. +1. A slot is selected. +1. Gather values for the selected service's form fields, if there are any. + The list of form fields is found in the **form** property of the items + in the **Bookings/Services** collection. +1. Get the available payment options for the currently logged-in user and + **TBD**_-LINK_ the selected service with the + [`getCheckoutOptions()`](#getCheckoutOptions) function. +1. A payment option is selected (offline, online, a pricing plan package, or a + pricing plan membership). +1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the + selected slot object, the values for the form fields, and the payment type + if necessary. Note, the specified payment type must match the service's + configuration in your site's **Dashboard**. You cannot book a paid service + as if it were free. + + + If the service is free, you do not need to pass a `paymentOptions` + object. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be online, a payment popup is presented + for the user to enter payment information, such as credit card information. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be offline, the payment popup is not + presented to the user. \ No newline at end of file From dc6216efe22b99a2871aa21d818b9163b2c7f4c2 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Thu, 24 Nov 2022 13:30:53 +0200 Subject: [PATCH 02/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 79 ++++++++++++++-------- 1 file changed, 49 insertions(+), 30 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 2ae6bf7c7b..be96f24375 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,20 +1,35 @@ { "name": "wix-bookings", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "bookings.js" }, "docs": { "summary": "The wix-bookings module contains functionality for working with\n bookings from client-side code.", "description": - [ "Using the Bookings API, you can build a customized bookings experience.", + [ "Using the Bookings API, you can build a customized bookings experience for customers to book and check out a service.", "", - " To process bookings on your site, first set up your site to accept bookings", - " as described in [About Wix Bookings](https://support.wix.com/en/article/about-wix-bookings).", + " With the Bookings API, you can:", "", - "You must upgrade your site to a [Premium Business Plan](https://support.wix.com/en/article/upgrading-wix-bookings) in order to accept bookings and receive payments.", + " + See the available slots and payment options for a service.", + " + Book a service and process payment. ", "", - " ### Typical Booking Lifecycle", + " ", + " To use the Bookings API, import `wixBookings` from the `wix-bookings` module:", + "", + " ```javascript", + " import wixBookings from 'wix-bookings';", + " ```", + "", + " ### Before you begin ", + "", + " + You must upgrade your site to a [Premium Business Plan](https://support.wix.com/en/article/upgrading-wix-bookings) in order to accept bookings and receive payments.", + "", + " + To process bookings on your site, first set up your site to accept bookings", + " as described in [About Wix Bookings](https://support.wix.com/en/article/about-wix-bookings).", + "", + " ### Typical booking lifecycle **TBD**_-MOVE TO \"SAMPLE FLOW\" ARTICLE_", "", " The following list outlines the data flow in a typical booking lifecycle:", "", @@ -52,13 +67,17 @@ " object indicating the payment should be offline, the payment popup is not", " presented to the user.", "", + " ### Terminology **TBD**", "", - "", - " To use the Bookings API, import `wixBookings` from the `wix-bookings` module:", - "", - " ```javascript", - " import wixBookings from 'wix-bookings';", - " ```" ], + " **Visitor**: Anyone who is not registered as a member in the Wix site (upon booking, visitors are registered as contacts).", + " **Member**: Someone who is registered as a member in the Wix site.", + " **Owner**: The Wix site owner (who has Wix Bookings installed).", + " **Appointments**: **TBD**", + " **Classes**: **TBD**", + " **Courses**: **TBD**", + " **Booking**: **TBD**", + " **Slot**: An available period of time in a schedule that can be booked by a customer. While this includes existing sessions that are available for booking, it can also represent a period of time that can be booked based on the availability of a resource (e.g., a barber with appointments of 30 minutes each that are open for booking every weekday between 8:00 - 17:00). These slots are calculated by the constraints of the schedule.", + " **Wix Pricing Plans**: A pre-paid bundle of services, or a membership including access to certain services. Access a member's pricing plans by calling the `checkoutOptions()` function with the member's `contactId`." ], "links": [], "examples": [], "extra": @@ -83,7 +102,7 @@ [ "wix-bookings.BookingResult" ] }, "doc": "Fulfilled - Results of the booking checkout." }, "locations": - [ { "lineno": 243, + [ { "lineno": 262, "filename": "bookings.js" } ], "docs": { "summary": "Books a service and processes payment for the service.", @@ -297,7 +316,7 @@ [ "wix-bookings.CheckoutOption" ] } ] }, "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." }, "locations": - [ { "lineno": 375, + [ { "lineno": 394, "filename": "bookings.js" } ], "docs": { "summary": "Gets the valid checkout options for a service's slot.", @@ -389,7 +408,7 @@ [ "wix-bookings.ServiceAvailability" ] }, "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." }, "locations": - [ { "lineno": 309, + [ { "lineno": 328, "filename": "bookings.js" } ], "docs": { "summary": "Gets the available slots for a specific service.", @@ -645,7 +664,7 @@ "messages": [ { "name": "Address", "locations": - [ { "lineno": 117, + [ { "lineno": 136, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains address information.", @@ -680,7 +699,7 @@ "labels": [] }, { "name": "AddressCoordinates", "locations": - [ { "lineno": 129, + [ { "lineno": 148, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains the geographic coordinates of the address.", @@ -721,7 +740,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 61, + [ { "lineno": 80, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -809,7 +828,7 @@ "labels": [] }, { "name": "BookingInfo", "locations": - [ { "lineno": 151, + [ { "lineno": 170, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the slot to be booked.", @@ -866,7 +885,7 @@ "labels": [] }, { "name": "BookingResult", "locations": - [ { "lineno": 230, + [ { "lineno": 249, "filename": "bookings.js" } ], "docs": { "summary": "An object representing the result of a call to [`checkoutBooking()`](#checkoutBooking).", @@ -921,7 +940,7 @@ "labels": [] }, { "name": "BusinessLocation", "locations": - [ { "lineno": 108, + [ { "lineno": 127, "filename": "bookings.js" } ], "docs": { "summary": "An object describing the business location.", @@ -947,7 +966,7 @@ "labels": [] }, { "name": "CheckoutOption", "locations": - [ { "lineno": 203, + [ { "lineno": 222, "filename": "bookings.js" } ], "docs": { "summary": "An object returned after calling [`getCheckoutOptions()`](#getCheckoutOptions)\n containing information about the available payment options for the service and the logged-in user.", @@ -1113,7 +1132,7 @@ "labels": [] }, { "name": "CheckoutOptionOptions", "locations": - [ { "lineno": 143, + [ { "lineno": 162, "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.", @@ -1186,7 +1205,7 @@ "labels": [] }, { "name": "Constraints", "locations": - [ { "lineno": 162, + [ { "lineno": 181, "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.", @@ -1206,7 +1225,7 @@ "labels": [] }, { "name": "FormField", "locations": - [ { "lineno": 173, + [ { "lineno": 192, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing values for form fields required to book the session.", @@ -1256,7 +1275,7 @@ "labels": [] }, { "name": "Location", "locations": - [ { "lineno": 97, + [ { "lineno": 116, "filename": "bookings.js" } ], "docs": { "summary": "The location where a service is offered.", @@ -1279,7 +1298,7 @@ "labels": [] }, { "name": "PaymentOptions", "locations": - [ { "lineno": 182, + [ { "lineno": 201, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the payment options.", @@ -1407,7 +1426,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 73, + [ { "lineno": 92, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1482,7 +1501,7 @@ "labels": [] }, { "name": "Slot", "locations": - [ { "lineno": 81, + [ { "lineno": 100, "filename": "bookings.js" } ], "docs": { "summary": "An object representing a booking slot.", @@ -1581,7 +1600,7 @@ "labels": [] }, { "name": "StreetAddress", "locations": - [ { "lineno": 136, + [ { "lineno": 155, "filename": "bookings.js" } ], "docs": { "summary": "An object representing information about the street name and street number of an address.", From 833b90b39add11bb203bfa756463884b536c69d5 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Thu, 24 Nov 2022 13:32:49 +0200 Subject: [PATCH 03/20] DocWorks for wixcode-bookings - no significant changes detected --- wixcode-bookings/wix-bookings.service.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index be96f24375..8e5ca3745b 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,7 +1,6 @@ { "name": "wix-bookings", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "bookings.js" }, From bac80a37736bba67e0f20f55f55633dfb773eead Mon Sep 17 00:00:00 2001 From: MartaBerman <50321691+MartaBerman@users.noreply.github.com> Date: Thu, 24 Nov 2022 13:44:44 +0200 Subject: [PATCH 04/20] Delete wix-bookings/wix-bookings/guides directory --- .../wix-bookings/guides/sample-flow.md | 39 ------------------- 1 file changed, 39 deletions(-) delete mode 100644 wix-bookings/wix-bookings/guides/sample-flow.md diff --git a/wix-bookings/wix-bookings/guides/sample-flow.md b/wix-bookings/wix-bookings/guides/sample-flow.md deleted file mode 100644 index ebfe80c2bd..0000000000 --- a/wix-bookings/wix-bookings/guides/sample-flow.md +++ /dev/null @@ -1,39 +0,0 @@ -# Typical Booking Sample Flow - -**TBD** _Make sure to update all links because I am moving this out of the Intro description._ - -The following list outlines a sample flow in a typical booking lifecycle: - -1. Get a list of services from one of: - + A dataset connected to the **Bookings/Services** collection. - + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. -1. A service is selected. -1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function - using the selected service's **Service ID** (`_id`) value. (Optionally, - you can pass a `AvailabilityOptions` - object to change the limits on the slots that are returned.) -1. You can match the returned slots to their related staff member items using - the **Bookings/Staff** collection. -1. A slot is selected. -1. Gather values for the selected service's form fields, if there are any. - The list of form fields is found in the **form** property of the items - in the **Bookings/Services** collection. -1. Get the available payment options for the currently logged-in user and - **TBD**_-LINK_ the selected service with the - [`getCheckoutOptions()`](#getCheckoutOptions) function. -1. A payment option is selected (offline, online, a pricing plan package, or a - pricing plan membership). -1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the - selected slot object, the values for the form fields, and the payment type - if necessary. Note, the specified payment type must match the service's - configuration in your site's **Dashboard**. You cannot book a paid service - as if it were free. - - + If the service is free, you do not need to pass a `paymentOptions` - object. - + If the service is not free and you pass a `paymentOptions` - object indicating the payment should be online, a payment popup is presented - for the user to enter payment information, such as credit card information. - + If the service is not free and you pass a `paymentOptions` - object indicating the payment should be offline, the payment popup is not - presented to the user. \ No newline at end of file From 762a57328dfdb7fd9a53c26dc285649ccf6e90e3 Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Thu, 24 Nov 2022 11:48:02 +0000 Subject: [PATCH 05/20] Published by the Tech Writer Single Sourcing Tool --- .../wix-bookings/guides/sample-flow.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 wixcode-bookings/wix-bookings/guides/sample-flow.md diff --git a/wixcode-bookings/wix-bookings/guides/sample-flow.md b/wixcode-bookings/wix-bookings/guides/sample-flow.md new file mode 100644 index 0000000000..ebfe80c2bd --- /dev/null +++ b/wixcode-bookings/wix-bookings/guides/sample-flow.md @@ -0,0 +1,39 @@ +# Typical Booking Sample Flow + +**TBD** _Make sure to update all links because I am moving this out of the Intro description._ + +The following list outlines a sample flow in a typical booking lifecycle: + +1. Get a list of services from one of: + + A dataset connected to the **Bookings/Services** collection. + + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. +1. A service is selected. +1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function + using the selected service's **Service ID** (`_id`) value. (Optionally, + you can pass a `AvailabilityOptions` + object to change the limits on the slots that are returned.) +1. You can match the returned slots to their related staff member items using + the **Bookings/Staff** collection. +1. A slot is selected. +1. Gather values for the selected service's form fields, if there are any. + The list of form fields is found in the **form** property of the items + in the **Bookings/Services** collection. +1. Get the available payment options for the currently logged-in user and + **TBD**_-LINK_ the selected service with the + [`getCheckoutOptions()`](#getCheckoutOptions) function. +1. A payment option is selected (offline, online, a pricing plan package, or a + pricing plan membership). +1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the + selected slot object, the values for the form fields, and the payment type + if necessary. Note, the specified payment type must match the service's + configuration in your site's **Dashboard**. You cannot book a paid service + as if it were free. + + + If the service is free, you do not need to pass a `paymentOptions` + object. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be online, a payment popup is presented + for the user to enter payment information, such as credit card information. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be offline, the payment popup is not + presented to the user. \ No newline at end of file From c509ec1402518674cf7e2a0583e572acb48e6709 Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Thu, 24 Nov 2022 11:50:49 +0000 Subject: [PATCH 06/20] Published by the Tech Writer Single Sourcing Tool --- .../wix-bookings/guides/Sample Flow.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 wixcode-bookings/wix-bookings/guides/Sample Flow.md diff --git a/wixcode-bookings/wix-bookings/guides/Sample Flow.md b/wixcode-bookings/wix-bookings/guides/Sample Flow.md new file mode 100644 index 0000000000..ebfe80c2bd --- /dev/null +++ b/wixcode-bookings/wix-bookings/guides/Sample Flow.md @@ -0,0 +1,39 @@ +# Typical Booking Sample Flow + +**TBD** _Make sure to update all links because I am moving this out of the Intro description._ + +The following list outlines a sample flow in a typical booking lifecycle: + +1. Get a list of services from one of: + + A dataset connected to the **Bookings/Services** collection. + + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. +1. A service is selected. +1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function + using the selected service's **Service ID** (`_id`) value. (Optionally, + you can pass a `AvailabilityOptions` + object to change the limits on the slots that are returned.) +1. You can match the returned slots to their related staff member items using + the **Bookings/Staff** collection. +1. A slot is selected. +1. Gather values for the selected service's form fields, if there are any. + The list of form fields is found in the **form** property of the items + in the **Bookings/Services** collection. +1. Get the available payment options for the currently logged-in user and + **TBD**_-LINK_ the selected service with the + [`getCheckoutOptions()`](#getCheckoutOptions) function. +1. A payment option is selected (offline, online, a pricing plan package, or a + pricing plan membership). +1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the + selected slot object, the values for the form fields, and the payment type + if necessary. Note, the specified payment type must match the service's + configuration in your site's **Dashboard**. You cannot book a paid service + as if it were free. + + + If the service is free, you do not need to pass a `paymentOptions` + object. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be online, a payment popup is presented + for the user to enter payment information, such as credit card information. + + If the service is not free and you pass a `paymentOptions` + object indicating the payment should be offline, the payment popup is not + presented to the user. \ No newline at end of file From cbec5f9c8704d68972011567cda8d4829cd36363 Mon Sep 17 00:00:00 2001 From: MartaBerman <50321691+MartaBerman@users.noreply.github.com> Date: Thu, 24 Nov 2022 13:52:25 +0200 Subject: [PATCH 07/20] Delete sample-flow.md --- .../wix-bookings/guides/sample-flow.md | 39 ------------------- 1 file changed, 39 deletions(-) delete mode 100644 wixcode-bookings/wix-bookings/guides/sample-flow.md diff --git a/wixcode-bookings/wix-bookings/guides/sample-flow.md b/wixcode-bookings/wix-bookings/guides/sample-flow.md deleted file mode 100644 index ebfe80c2bd..0000000000 --- a/wixcode-bookings/wix-bookings/guides/sample-flow.md +++ /dev/null @@ -1,39 +0,0 @@ -# Typical Booking Sample Flow - -**TBD** _Make sure to update all links because I am moving this out of the Intro description._ - -The following list outlines a sample flow in a typical booking lifecycle: - -1. Get a list of services from one of: - + A dataset connected to the **Bookings/Services** collection. - + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. -1. A service is selected. -1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function - using the selected service's **Service ID** (`_id`) value. (Optionally, - you can pass a `AvailabilityOptions` - object to change the limits on the slots that are returned.) -1. You can match the returned slots to their related staff member items using - the **Bookings/Staff** collection. -1. A slot is selected. -1. Gather values for the selected service's form fields, if there are any. - The list of form fields is found in the **form** property of the items - in the **Bookings/Services** collection. -1. Get the available payment options for the currently logged-in user and - **TBD**_-LINK_ the selected service with the - [`getCheckoutOptions()`](#getCheckoutOptions) function. -1. A payment option is selected (offline, online, a pricing plan package, or a - pricing plan membership). -1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the - selected slot object, the values for the form fields, and the payment type - if necessary. Note, the specified payment type must match the service's - configuration in your site's **Dashboard**. You cannot book a paid service - as if it were free. - - + If the service is free, you do not need to pass a `paymentOptions` - object. - + If the service is not free and you pass a `paymentOptions` - object indicating the payment should be online, a payment popup is presented - for the user to enter payment information, such as credit card information. - + If the service is not free and you pass a `paymentOptions` - object indicating the payment should be offline, the payment popup is not - presented to the user. \ No newline at end of file From 6f9b2a97ebfd051bfbd20b0e19e37619d64a4285 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Thu, 24 Nov 2022 14:04:39 +0200 Subject: [PATCH 08/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 108 ++++++++------------- 1 file changed, 43 insertions(+), 65 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 8e5ca3745b..119a11822b 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,6 +1,7 @@ { "name": "wix-bookings", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "bookings.js" }, @@ -10,11 +11,9 @@ [ "Using 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:", - "", " + See the available slots and payment options for a service.", " + Book a service and process payment. ", "", - " ", " To use the Bookings API, import `wixBookings` from the `wix-bookings` module:", "", " ```javascript", @@ -28,55 +27,34 @@ " + To process bookings on your site, first set up your site to accept bookings", " as described in [About Wix Bookings](https://support.wix.com/en/article/about-wix-bookings).", "", - " ### Typical booking lifecycle **TBD**_-MOVE TO \"SAMPLE FLOW\" ARTICLE_", + " ### Terminology", + "", + " + **Visitor**: Anyone who is not registered as a member in the Wix site ", + " (upon booking, visitors are registered as contacts).", + "", + " + **Member**: Someone who is registered as a member in the Wix site.", + "", + " + **Owner**: The Wix site owner (who has Wix Bookings installed).", + "", + " + **Appointments**: **TBD**", "", - " The following list outlines the data flow in a typical booking lifecycle:", + " + **Classes**: **TBD**", "", - " 1. Get a list of services from one of:", - " + A dataset connected to the **Bookings/Services** collection.", - " + A [query](wix-data.html#query) on the **Bookings/Services** collection.", - " 1. A service is selected.", - " 1. Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function", - " using the selected service's **Service ID** (`_id`) value. (Optionally,", - " you can pass a `AvailabilityOptions`", - " object to change the limits on the slots that are returned.)", - " 1. You can match the returned slots to their related staff member items using", - " the **Bookings/Staff** collection.", - " 1. A slot is selected.", - " 1. Gather values for the selected service's form fields, if there are any.", - " The list of form fields is found in the **form** property of the items", - " in the **Bookings/Services** collection.", - " 1. Get the available payment options for the currently logged-in user and", - " the selected service with the", - " [`getCheckoutOptions()`](#getCheckoutOptions) function.", - " 1. A payment option is selected (offline, online, a pricing plan package, or a", - " pricing plan membership).", - " 1. Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the", - " selected slot object, the values for the form fields, and the payment type", - " if necessary. Note, the specified payment type must match the service's", - " configuration in your site's **Dashboard**. You cannot book a paid service", - " as if it were free.", + " + **Courses**: **TBD**", "", - " + If the service is free, you do not need to pass a `paymentOptions`", - " object.", - " + If the service is not free and you pass a `paymentOptions`", - " object indicating the payment should be online, a payment popup is presented", - " for the user to enter payment information, such as credit card information.", - " + If the service is not free and you pass a `paymentOptions`", - " object indicating the payment should be offline, the payment popup is not", - " presented to the user.", + " + **Booking**: **TBD**", "", - " ### Terminology **TBD**", + " + **Slot**: An available period of time in a schedule that can be booked ", + " by a customer. While this includes existing sessions that are available ", + " for booking, it can also represent a period of time that can be booked ", + " based on the availability of a resource (e.g., a barber with ", + " appointments of 30 minutes each that are open for booking every weekday ", + " between 8:00 - 17:00). These slots are calculated by the constraints of ", + " the schedule.", "", - " **Visitor**: Anyone who is not registered as a member in the Wix site (upon booking, visitors are registered as contacts).", - " **Member**: Someone who is registered as a member in the Wix site.", - " **Owner**: The Wix site owner (who has Wix Bookings installed).", - " **Appointments**: **TBD**", - " **Classes**: **TBD**", - " **Courses**: **TBD**", - " **Booking**: **TBD**", - " **Slot**: An available period of time in a schedule that can be booked by a customer. While this includes existing sessions that are available for booking, it can also represent a period of time that can be booked based on the availability of a resource (e.g., a barber with appointments of 30 minutes each that are open for booking every weekday between 8:00 - 17:00). These slots are calculated by the constraints of the schedule.", - " **Wix Pricing Plans**: A pre-paid bundle of services, or a membership including access to certain services. Access a member's pricing plans by calling the `checkoutOptions()` function with the member's `contactId`." ], + " + **Wix Pricing Plans**: A pre-paid bundle of services, or a membership ", + " including access to certain services. Access a member's pricing plans by ", + " calling the `checkoutOptions()` function with the member's `contactId`." ], "links": [], "examples": [], "extra": @@ -101,7 +79,7 @@ [ "wix-bookings.BookingResult" ] }, "doc": "Fulfilled - Results of the booking checkout." }, "locations": - [ { "lineno": 262, + [ { "lineno": 239, "filename": "bookings.js" } ], "docs": { "summary": "Books a service and processes payment for the service.", @@ -315,7 +293,7 @@ [ "wix-bookings.CheckoutOption" ] } ] }, "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." }, "locations": - [ { "lineno": 394, + [ { "lineno": 371, "filename": "bookings.js" } ], "docs": { "summary": "Gets the valid checkout options for a service's slot.", @@ -407,7 +385,7 @@ [ "wix-bookings.ServiceAvailability" ] }, "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." }, "locations": - [ { "lineno": 328, + [ { "lineno": 305, "filename": "bookings.js" } ], "docs": { "summary": "Gets the available slots for a specific service.", @@ -663,7 +641,7 @@ "messages": [ { "name": "Address", "locations": - [ { "lineno": 136, + [ { "lineno": 113, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains address information.", @@ -698,7 +676,7 @@ "labels": [] }, { "name": "AddressCoordinates", "locations": - [ { "lineno": 148, + [ { "lineno": 125, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains the geographic coordinates of the address.", @@ -739,7 +717,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 80, + [ { "lineno": 57, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -827,7 +805,7 @@ "labels": [] }, { "name": "BookingInfo", "locations": - [ { "lineno": 170, + [ { "lineno": 147, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the slot to be booked.", @@ -884,7 +862,7 @@ "labels": [] }, { "name": "BookingResult", "locations": - [ { "lineno": 249, + [ { "lineno": 226, "filename": "bookings.js" } ], "docs": { "summary": "An object representing the result of a call to [`checkoutBooking()`](#checkoutBooking).", @@ -939,7 +917,7 @@ "labels": [] }, { "name": "BusinessLocation", "locations": - [ { "lineno": 127, + [ { "lineno": 104, "filename": "bookings.js" } ], "docs": { "summary": "An object describing the business location.", @@ -965,7 +943,7 @@ "labels": [] }, { "name": "CheckoutOption", "locations": - [ { "lineno": 222, + [ { "lineno": 199, "filename": "bookings.js" } ], "docs": { "summary": "An object returned after calling [`getCheckoutOptions()`](#getCheckoutOptions)\n containing information about the available payment options for the service and the logged-in user.", @@ -1131,7 +1109,7 @@ "labels": [] }, { "name": "CheckoutOptionOptions", "locations": - [ { "lineno": 162, + [ { "lineno": 139, "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.", @@ -1204,7 +1182,7 @@ "labels": [] }, { "name": "Constraints", "locations": - [ { "lineno": 181, + [ { "lineno": 158, "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.", @@ -1224,7 +1202,7 @@ "labels": [] }, { "name": "FormField", "locations": - [ { "lineno": 192, + [ { "lineno": 169, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing values for form fields required to book the session.", @@ -1274,7 +1252,7 @@ "labels": [] }, { "name": "Location", "locations": - [ { "lineno": 116, + [ { "lineno": 93, "filename": "bookings.js" } ], "docs": { "summary": "The location where a service is offered.", @@ -1297,7 +1275,7 @@ "labels": [] }, { "name": "PaymentOptions", "locations": - [ { "lineno": 201, + [ { "lineno": 178, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the payment options.", @@ -1425,7 +1403,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 92, + [ { "lineno": 69, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1500,7 +1478,7 @@ "labels": [] }, { "name": "Slot", "locations": - [ { "lineno": 100, + [ { "lineno": 77, "filename": "bookings.js" } ], "docs": { "summary": "An object representing a booking slot.", @@ -1599,7 +1577,7 @@ "labels": [] }, { "name": "StreetAddress", "locations": - [ { "lineno": 155, + [ { "lineno": 132, "filename": "bookings.js" } ], "docs": { "summary": "An object representing information about the street name and street number of an address.", From c61c394b754b6abae252265c90dd51a26e6cbb56 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Thu, 24 Nov 2022 15:11:20 +0200 Subject: [PATCH 09/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 38 ++++++++++++---------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 119a11822b..fa17d6da0f 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -22,6 +22,8 @@ "", " ### Before you begin ", "", + " **TBD**: Add intro section", + "", " + You must upgrade your site to a [Premium Business Plan](https://support.wix.com/en/article/upgrading-wix-bookings) in order to accept bookings and receive payments.", "", " + To process bookings on your site, first set up your site to accept bookings", @@ -79,7 +81,7 @@ [ "wix-bookings.BookingResult" ] }, "doc": "Fulfilled - Results of the booking checkout." }, "locations": - [ { "lineno": 239, + [ { "lineno": 241, "filename": "bookings.js" } ], "docs": { "summary": "Books a service and processes payment for the service.", @@ -293,7 +295,7 @@ [ "wix-bookings.CheckoutOption" ] } ] }, "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." }, "locations": - [ { "lineno": 371, + [ { "lineno": 373, "filename": "bookings.js" } ], "docs": { "summary": "Gets the valid checkout options for a service's slot.", @@ -385,7 +387,7 @@ [ "wix-bookings.ServiceAvailability" ] }, "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." }, "locations": - [ { "lineno": 305, + [ { "lineno": 307, "filename": "bookings.js" } ], "docs": { "summary": "Gets the available slots for a specific service.", @@ -641,7 +643,7 @@ "messages": [ { "name": "Address", "locations": - [ { "lineno": 113, + [ { "lineno": 115, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains address information.", @@ -676,7 +678,7 @@ "labels": [] }, { "name": "AddressCoordinates", "locations": - [ { "lineno": 125, + [ { "lineno": 127, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains the geographic coordinates of the address.", @@ -717,7 +719,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 57, + [ { "lineno": 59, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -805,7 +807,7 @@ "labels": [] }, { "name": "BookingInfo", "locations": - [ { "lineno": 147, + [ { "lineno": 149, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the slot to be booked.", @@ -862,7 +864,7 @@ "labels": [] }, { "name": "BookingResult", "locations": - [ { "lineno": 226, + [ { "lineno": 228, "filename": "bookings.js" } ], "docs": { "summary": "An object representing the result of a call to [`checkoutBooking()`](#checkoutBooking).", @@ -917,7 +919,7 @@ "labels": [] }, { "name": "BusinessLocation", "locations": - [ { "lineno": 104, + [ { "lineno": 106, "filename": "bookings.js" } ], "docs": { "summary": "An object describing the business location.", @@ -943,7 +945,7 @@ "labels": [] }, { "name": "CheckoutOption", "locations": - [ { "lineno": 199, + [ { "lineno": 201, "filename": "bookings.js" } ], "docs": { "summary": "An object returned after calling [`getCheckoutOptions()`](#getCheckoutOptions)\n containing information about the available payment options for the service and the logged-in user.", @@ -1109,7 +1111,7 @@ "labels": [] }, { "name": "CheckoutOptionOptions", "locations": - [ { "lineno": 139, + [ { "lineno": 141, "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.", @@ -1182,7 +1184,7 @@ "labels": [] }, { "name": "Constraints", "locations": - [ { "lineno": 158, + [ { "lineno": 160, "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.", @@ -1202,7 +1204,7 @@ "labels": [] }, { "name": "FormField", "locations": - [ { "lineno": 169, + [ { "lineno": 171, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing values for form fields required to book the session.", @@ -1252,7 +1254,7 @@ "labels": [] }, { "name": "Location", "locations": - [ { "lineno": 93, + [ { "lineno": 95, "filename": "bookings.js" } ], "docs": { "summary": "The location where a service is offered.", @@ -1275,7 +1277,7 @@ "labels": [] }, { "name": "PaymentOptions", "locations": - [ { "lineno": 178, + [ { "lineno": 180, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the payment options.", @@ -1403,7 +1405,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 69, + [ { "lineno": 71, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1478,7 +1480,7 @@ "labels": [] }, { "name": "Slot", "locations": - [ { "lineno": 77, + [ { "lineno": 79, "filename": "bookings.js" } ], "docs": { "summary": "An object representing a booking slot.", @@ -1577,7 +1579,7 @@ "labels": [] }, { "name": "StreetAddress", "locations": - [ { "lineno": 132, + [ { "lineno": 134, "filename": "bookings.js" } ], "docs": { "summary": "An object representing information about the street name and street number of an address.", From 6c91dd286e27001a7828f5393583b041730692e6 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 27 Nov 2022 13:50:22 +0200 Subject: [PATCH 10/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 74 +++++++++++++--------- 1 file changed, 43 insertions(+), 31 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index fa17d6da0f..342ddcf139 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -8,11 +8,14 @@ "docs": { "summary": "The wix-bookings module contains functionality for working with\n bookings from client-side code.", "description": - [ "Using the Bookings API, you can build a customized bookings experience for customers to book and check out a service.", + [ "Using 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:", " + See the available slots and payment options for a service.", - " + Book a service and process payment. ", + " + Book a service and process payment. ", + "", + " Learn more by reviewing this [sample flow](wix-bookings.html#sample-flow). ", "", " To use the Bookings API, import `wixBookings` from the `wix-bookings` module:", "", @@ -22,7 +25,7 @@ "", " ### Before you begin ", "", - " **TBD**: Add intro section", + " It's important to note the following points before starting to code: ", "", " + You must upgrade your site to a [Premium Business Plan](https://support.wix.com/en/article/upgrading-wix-bookings) in order to accept bookings and receive payments.", "", @@ -31,20 +34,27 @@ "", " ### Terminology", "", - " + **Visitor**: Anyone who is not registered as a member in the Wix site ", - " (upon booking, visitors are registered as contacts).", + " + **Site owner**: The Wix site owner (who has Wix Bookings installed).", + "", + " + **Resources**: A business asset like a staff member, a room, ", + " or equipment needed to provide a service.", "", - " + **Member**: Someone who is registered as a member in the Wix site.", + " + **Service**: An offering that you can book. Wix Bookings offers 3 types of ", + " services: ", "", - " + **Owner**: The Wix site owner (who has Wix Bookings installed).", + " + [**Appointment**](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business#appointments): A specific time slot that a customer can book in a calendar.", "", - " + **Appointments**: **TBD**", + " + [**Class**](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business#classes): A single session or a set of sessions that are offered on specific days and at specific times.", "", - " + **Classes**: **TBD**", + " + [**Course**](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business#courses): A multi-session course, or a workshop that starts and ends on a particular day. Customers sign up for the entire course and not one session.", + " ", + " + **Sessions**: A reserved period of time for an appointment, class, ", + " or course, or a period of availability for a resource.", "", - " + **Courses**: **TBD**", + " + **Schedule**: A collection of sessions and the information needed ", + " to calculate availability. ", "", - " + **Booking**: **TBD**", + " + **Booking**: An order placed by a customer for a service or series of services.", "", " + **Slot**: An available period of time in a schedule that can be booked ", " by a customer. While this includes existing sessions that are available ", @@ -54,8 +64,10 @@ " between 8:00 - 17:00). These slots are calculated by the constraints of ", " the schedule.", "", - " + **Wix Pricing Plans**: A pre-paid bundle of services, or a membership ", - " including access to certain services. Access a member's pricing plans by ", + " + [**Calendar**](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar): Where you schedule appointments, classes, and courses.", + "", + " + [**Membership plans with Wix Pricing Plans**](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#selling-membership-plans-and-packages): A pre-paid bundle of services, or a membership ", + " including access to certain services. Access a member's pricing plans with APIs by ", " calling the `checkoutOptions()` function with the member's `contactId`." ], "links": [], "examples": [], @@ -81,7 +93,7 @@ [ "wix-bookings.BookingResult" ] }, "doc": "Fulfilled - Results of the booking checkout." }, "locations": - [ { "lineno": 241, + [ { "lineno": 253, "filename": "bookings.js" } ], "docs": { "summary": "Books a service and processes payment for the service.", @@ -295,7 +307,7 @@ [ "wix-bookings.CheckoutOption" ] } ] }, "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." }, "locations": - [ { "lineno": 373, + [ { "lineno": 385, "filename": "bookings.js" } ], "docs": { "summary": "Gets the valid checkout options for a service's slot.", @@ -387,7 +399,7 @@ [ "wix-bookings.ServiceAvailability" ] }, "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." }, "locations": - [ { "lineno": 307, + [ { "lineno": 319, "filename": "bookings.js" } ], "docs": { "summary": "Gets the available slots for a specific service.", @@ -643,7 +655,7 @@ "messages": [ { "name": "Address", "locations": - [ { "lineno": 115, + [ { "lineno": 127, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains address information.", @@ -678,7 +690,7 @@ "labels": [] }, { "name": "AddressCoordinates", "locations": - [ { "lineno": 127, + [ { "lineno": 139, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains the geographic coordinates of the address.", @@ -719,7 +731,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 59, + [ { "lineno": 71, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -807,7 +819,7 @@ "labels": [] }, { "name": "BookingInfo", "locations": - [ { "lineno": 149, + [ { "lineno": 161, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the slot to be booked.", @@ -864,7 +876,7 @@ "labels": [] }, { "name": "BookingResult", "locations": - [ { "lineno": 228, + [ { "lineno": 240, "filename": "bookings.js" } ], "docs": { "summary": "An object representing the result of a call to [`checkoutBooking()`](#checkoutBooking).", @@ -919,7 +931,7 @@ "labels": [] }, { "name": "BusinessLocation", "locations": - [ { "lineno": 106, + [ { "lineno": 118, "filename": "bookings.js" } ], "docs": { "summary": "An object describing the business location.", @@ -945,7 +957,7 @@ "labels": [] }, { "name": "CheckoutOption", "locations": - [ { "lineno": 201, + [ { "lineno": 213, "filename": "bookings.js" } ], "docs": { "summary": "An object returned after calling [`getCheckoutOptions()`](#getCheckoutOptions)\n containing information about the available payment options for the service and the logged-in user.", @@ -1111,7 +1123,7 @@ "labels": [] }, { "name": "CheckoutOptionOptions", "locations": - [ { "lineno": 141, + [ { "lineno": 153, "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.", @@ -1184,7 +1196,7 @@ "labels": [] }, { "name": "Constraints", "locations": - [ { "lineno": 160, + [ { "lineno": 172, "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.", @@ -1204,7 +1216,7 @@ "labels": [] }, { "name": "FormField", "locations": - [ { "lineno": 171, + [ { "lineno": 183, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing values for form fields required to book the session.", @@ -1254,7 +1266,7 @@ "labels": [] }, { "name": "Location", "locations": - [ { "lineno": 95, + [ { "lineno": 107, "filename": "bookings.js" } ], "docs": { "summary": "The location where a service is offered.", @@ -1277,7 +1289,7 @@ "labels": [] }, { "name": "PaymentOptions", "locations": - [ { "lineno": 180, + [ { "lineno": 192, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the payment options.", @@ -1405,7 +1417,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 71, + [ { "lineno": 83, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1480,7 +1492,7 @@ "labels": [] }, { "name": "Slot", "locations": - [ { "lineno": 79, + [ { "lineno": 91, "filename": "bookings.js" } ], "docs": { "summary": "An object representing a booking slot.", @@ -1579,7 +1591,7 @@ "labels": [] }, { "name": "StreetAddress", "locations": - [ { "lineno": 134, + [ { "lineno": 146, "filename": "bookings.js" } ], "docs": { "summary": "An object representing information about the street name and street number of an address.", From 729ea9d30868ddf570fa4007e1f2eaceba21a5ef Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 27 Nov 2022 15:42:25 +0200 Subject: [PATCH 11/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 45 ++++++++++++---------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 342ddcf139..d8f862e8bc 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -39,8 +39,10 @@ " + **Resources**: A business asset like a staff member, a room, ", " or equipment needed to provide a service.", "", - " + **Service**: An offering that you can book. Wix Bookings offers 3 types of ", - " services: ", + " + **Service**: A business offering that you can book. For example, ", + " a fitness studio may offer a 1-hour yoga class, a 45 minute HIIT ", + " training session, and a 30 minute 1-on-1 personal training. Wix Bookings ", + " offers 3 types of services: ", "", " + [**Appointment**](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business#appointments): A specific time slot that a customer can book in a calendar.", "", @@ -54,7 +56,8 @@ " + **Schedule**: A collection of sessions and the information needed ", " to calculate availability. ", "", - " + **Booking**: An order placed by a customer for a service or series of services.", + " + **Booking**: Information about an order placed by a customer for a service or ", + " series of services. Includes details about the time, location, participants, and price.", "", " + **Slot**: An available period of time in a schedule that can be booked ", " by a customer. While this includes existing sessions that are available ", @@ -93,7 +96,7 @@ [ "wix-bookings.BookingResult" ] }, "doc": "Fulfilled - Results of the booking checkout." }, "locations": - [ { "lineno": 253, + [ { "lineno": 256, "filename": "bookings.js" } ], "docs": { "summary": "Books a service and processes payment for the service.", @@ -307,7 +310,7 @@ [ "wix-bookings.CheckoutOption" ] } ] }, "doc": "Fulfilled - The available payment options for the service and the logged-in user.\nRejected - Checkout payment options error object." }, "locations": - [ { "lineno": 385, + [ { "lineno": 388, "filename": "bookings.js" } ], "docs": { "summary": "Gets the valid checkout options for a service's slot.", @@ -399,7 +402,7 @@ [ "wix-bookings.ServiceAvailability" ] }, "doc": "Fulfilled - A list of available slots.\nRejected - Bookings error object." }, "locations": - [ { "lineno": 319, + [ { "lineno": 322, "filename": "bookings.js" } ], "docs": { "summary": "Gets the available slots for a specific service.", @@ -655,7 +658,7 @@ "messages": [ { "name": "Address", "locations": - [ { "lineno": 127, + [ { "lineno": 130, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains address information.", @@ -690,7 +693,7 @@ "labels": [] }, { "name": "AddressCoordinates", "locations": - [ { "lineno": 139, + [ { "lineno": 142, "filename": "bookings.js" } ], "docs": { "summary": "An object that contains the geographic coordinates of the address.", @@ -731,7 +734,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 71, + [ { "lineno": 74, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -819,7 +822,7 @@ "labels": [] }, { "name": "BookingInfo", "locations": - [ { "lineno": 161, + [ { "lineno": 164, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the slot to be booked.", @@ -876,7 +879,7 @@ "labels": [] }, { "name": "BookingResult", "locations": - [ { "lineno": 240, + [ { "lineno": 243, "filename": "bookings.js" } ], "docs": { "summary": "An object representing the result of a call to [`checkoutBooking()`](#checkoutBooking).", @@ -931,7 +934,7 @@ "labels": [] }, { "name": "BusinessLocation", "locations": - [ { "lineno": 118, + [ { "lineno": 121, "filename": "bookings.js" } ], "docs": { "summary": "An object describing the business location.", @@ -957,7 +960,7 @@ "labels": [] }, { "name": "CheckoutOption", "locations": - [ { "lineno": 213, + [ { "lineno": 216, "filename": "bookings.js" } ], "docs": { "summary": "An object returned after calling [`getCheckoutOptions()`](#getCheckoutOptions)\n containing information about the available payment options for the service and the logged-in user.", @@ -1123,7 +1126,7 @@ "labels": [] }, { "name": "CheckoutOptionOptions", "locations": - [ { "lineno": 153, + [ { "lineno": 156, "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.", @@ -1196,7 +1199,7 @@ "labels": [] }, { "name": "Constraints", "locations": - [ { "lineno": 172, + [ { "lineno": 175, "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.", @@ -1216,7 +1219,7 @@ "labels": [] }, { "name": "FormField", "locations": - [ { "lineno": 183, + [ { "lineno": 186, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing values for form fields required to book the session.", @@ -1266,7 +1269,7 @@ "labels": [] }, { "name": "Location", "locations": - [ { "lineno": 107, + [ { "lineno": 110, "filename": "bookings.js" } ], "docs": { "summary": "The location where a service is offered.", @@ -1289,7 +1292,7 @@ "labels": [] }, { "name": "PaymentOptions", "locations": - [ { "lineno": 192, + [ { "lineno": 195, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`checkoutBooking()`](#checkoutBooking)\n containing information about the payment options.", @@ -1417,7 +1420,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 83, + [ { "lineno": 86, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1492,7 +1495,7 @@ "labels": [] }, { "name": "Slot", "locations": - [ { "lineno": 91, + [ { "lineno": 94, "filename": "bookings.js" } ], "docs": { "summary": "An object representing a booking slot.", @@ -1591,7 +1594,7 @@ "labels": [] }, { "name": "StreetAddress", "locations": - [ { "lineno": 146, + [ { "lineno": 149, "filename": "bookings.js" } ], "docs": { "summary": "An object representing information about the street name and street number of an address.", From e8921d8cf85a1fbd495b1d874e5a805df43898e1 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 27 Nov 2022 15:47:51 +0200 Subject: [PATCH 12/20] DocWorks for wixcode-bookings - no significant changes detected --- wixcode-bookings/wix-bookings.service.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index d8f862e8bc..6ce1f05b24 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,7 +1,6 @@ { "name": "wix-bookings", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "bookings.js" }, From 08bb837b8c2b7fae0c87c692fa69518aaa467803 Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Sun, 27 Nov 2022 14:10:33 +0000 Subject: [PATCH 13/20] Published by the Tech Writer Single Sourcing Tool --- .../wix-bookings/guides/Sample Flow.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/wixcode-bookings/wix-bookings/guides/Sample Flow.md b/wixcode-bookings/wix-bookings/guides/Sample Flow.md index ebfe80c2bd..d32443faba 100644 --- a/wixcode-bookings/wix-bookings/guides/Sample Flow.md +++ b/wixcode-bookings/wix-bookings/guides/Sample Flow.md @@ -1,14 +1,12 @@ # Typical Booking Sample Flow -**TBD** _Make sure to update all links because I am moving this out of the Intro description._ - The following list outlines a sample flow in a typical booking lifecycle: 1. Get a list of services from one of: + A dataset connected to the **Bookings/Services** collection. - + **TBD**_-LINK_ A [query](wix-data.html#query) on the **Bookings/Services** collection. + + A [query](wix-data.html#query) on the **Bookings/Services** collection. 1. A service is selected. -1. **TBD**_-LINK_ Get available slots by calling the [`getServiceAvailability()`](#getServiceAvailability) function +1. **TBD** Get available slots by calling the [`getServiceAvailability()`](wix-bookings/getServiceAvailability) function using the selected service's **Service ID** (`_id`) value. (Optionally, you can pass a `AvailabilityOptions` object to change the limits on the slots that are returned.) @@ -19,11 +17,12 @@ The following list outlines a sample flow in a typical booking lifecycle: The list of form fields is found in the **form** property of the items in the **Bookings/Services** collection. 1. Get the available payment options for the currently logged-in user and - **TBD**_-LINK_ the selected service with the - [`getCheckoutOptions()`](#getCheckoutOptions) function. + **TBD** the selected service with the + [`getCheckoutOptions()`](wix-bookings/getCheckoutOptions) function. 1. A payment option is selected (offline, online, a pricing plan package, or a pricing plan membership). -1. **TBD**_-LINK_ Call the [`checkoutBooking()`](#checkoutBooking) function. Pass the +1. **TBD** Call the [`checkoutBooking()`](wix-bookings/checkoutBooking + function. Pass the selected slot object, the values for the form fields, and the payment type if necessary. Note, the specified payment type must match the service's configuration in your site's **Dashboard**. You cannot book a paid service @@ -33,7 +32,7 @@ The following list outlines a sample flow in a typical booking lifecycle: object. + If the service is not free and you pass a `paymentOptions` object indicating the payment should be online, a payment popup is presented - for the user to enter payment information, such as credit card information. + for the user to enter payment information, such as credit card details. + If the service is not free and you pass a `paymentOptions` object indicating the payment should be offline, the payment popup is not presented to the user. \ No newline at end of file From 756092b36d7ce2044a70463c3cc488ce6f9e435b Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Sun, 27 Nov 2022 14:15:04 +0000 Subject: [PATCH 14/20] Published by the Tech Writer Single Sourcing Tool --- wixcode-bookings/wix-bookings/guides/Sample Flow.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/wixcode-bookings/wix-bookings/guides/Sample Flow.md b/wixcode-bookings/wix-bookings/guides/Sample Flow.md index d32443faba..939f21e883 100644 --- a/wixcode-bookings/wix-bookings/guides/Sample Flow.md +++ b/wixcode-bookings/wix-bookings/guides/Sample Flow.md @@ -5,8 +5,9 @@ The following list outlines a sample flow in a typical booking lifecycle: 1. Get a list of services from one of: + A dataset connected to the **Bookings/Services** collection. + A [query](wix-data.html#query) on the **Bookings/Services** collection. + 1. A service is selected. -1. **TBD** Get available slots by calling the [`getServiceAvailability()`](wix-bookings/getServiceAvailability) function +1. Get available slots by calling the [`getServiceAvailability()`](wix-bookings/getServiceAvailability) function using the selected service's **Service ID** (`_id`) value. (Optionally, you can pass a `AvailabilityOptions` object to change the limits on the slots that are returned.) @@ -17,14 +18,14 @@ The following list outlines a sample flow in a typical booking lifecycle: The list of form fields is found in the **form** property of the items in the **Bookings/Services** collection. 1. Get the available payment options for the currently logged-in user and - **TBD** the selected service with the + the selected service with the [`getCheckoutOptions()`](wix-bookings/getCheckoutOptions) function. 1. A payment option is selected (offline, online, a pricing plan package, or a pricing plan membership). -1. **TBD** Call the [`checkoutBooking()`](wix-bookings/checkoutBooking +1. Call the [`checkoutBooking()`](wix-bookings/checkoutBooking) function. Pass the selected slot object, the values for the form fields, and the payment type - if necessary. Note, the specified payment type must match the service's + if necessary. Note that the specified payment type must match the service's configuration in your site's **Dashboard**. You cannot book a paid service as if it were free. From a2b28c3b80a4b9132073ec9fa62c92767a4623fd Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Sun, 27 Nov 2022 14:17:00 +0000 Subject: [PATCH 15/20] Published by the Tech Writer Single Sourcing Tool --- wixcode-bookings/wix-bookings/guides/Sample Flow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wixcode-bookings/wix-bookings/guides/Sample Flow.md b/wixcode-bookings/wix-bookings/guides/Sample Flow.md index 939f21e883..fbf823bfa1 100644 --- a/wixcode-bookings/wix-bookings/guides/Sample Flow.md +++ b/wixcode-bookings/wix-bookings/guides/Sample Flow.md @@ -5,7 +5,7 @@ The following list outlines a sample flow in a typical booking lifecycle: 1. Get a list of services from one of: + A dataset connected to the **Bookings/Services** collection. + A [query](wix-data.html#query) on the **Bookings/Services** collection. - + 1. A service is selected. 1. Get available slots by calling the [`getServiceAvailability()`](wix-bookings/getServiceAvailability) function using the selected service's **Service ID** (`_id`) value. (Optionally, From 8172f3ad70b47ee8d45f8a7f4d43152493dfbfe3 Mon Sep 17 00:00:00 2001 From: Wix Tech Writers Date: Sun, 27 Nov 2022 14:19:05 +0000 Subject: [PATCH 16/20] Published by the Tech Writer Single Sourcing Tool --- wixcode-bookings/wix-bookings/guides/Sample Flow.md | 1 + 1 file changed, 1 insertion(+) diff --git a/wixcode-bookings/wix-bookings/guides/Sample Flow.md b/wixcode-bookings/wix-bookings/guides/Sample Flow.md index fbf823bfa1..51b17deb9f 100644 --- a/wixcode-bookings/wix-bookings/guides/Sample Flow.md +++ b/wixcode-bookings/wix-bookings/guides/Sample Flow.md @@ -6,6 +6,7 @@ The following list outlines a sample flow in a typical booking lifecycle: + A dataset connected to the **Bookings/Services** collection. + A [query](wix-data.html#query) on the **Bookings/Services** collection. + 1. A service is selected. 1. Get available slots by calling the [`getServiceAvailability()`](wix-bookings/getServiceAvailability) function using the selected service's **Service ID** (`_id`) value. (Optionally, From 93f57d946e52f607330de14ac0e8b12f070f27a0 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 4 Dec 2022 09:16:34 +0200 Subject: [PATCH 17/20] DocWorks for wixcode-bookings - 2 changes detected changes: Service wix-bookings has changed description Service wix-bookings message ServiceAvailability member slots has changed doc --- wixcode-bookings/wix-bookings.service.json | 32 +++++++++++----------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 6ce1f05b24..bc314561c0 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,6 +1,7 @@ { "name": "wix-bookings", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "bookings.js" }, @@ -22,7 +23,7 @@ " import wixBookings from 'wix-bookings';", " ```", "", - " ### Before you begin ", + " ## Before you begin ", "", " It's important to note the following points before starting to code: ", "", @@ -31,12 +32,13 @@ " + To process bookings on your site, first set up your site to accept bookings", " as described in [About Wix Bookings](https://support.wix.com/en/article/about-wix-bookings).", "", - " ### Terminology", + " ## Terminology", "", - " + **Site owner**: The Wix site owner (who has Wix Bookings installed).", - "", - " + **Resources**: A business asset like a staff member, a room, ", + " + **Resource**: A business asset like a staff member, a room, ", " or equipment needed to provide a service.", + " ", + " + **Booking**: Information about an order placed by a customer for a service or ", + " series of services. Includes details about the time, location, participants, and price.", "", " + **Service**: A business offering that you can book. For example, ", " a fitness studio may offer a 1-hour yoga class, a 45 minute HIIT ", @@ -55,22 +57,19 @@ " + **Schedule**: A collection of sessions and the information needed ", " to calculate availability. ", "", - " + **Booking**: Information about an order placed by a customer for a service or ", - " series of services. Includes details about the time, location, participants, and price.", - "", " + **Slot**: An available period of time in a schedule that can be booked ", " by a customer. While this includes existing sessions that are available ", " for booking, it can also represent a period of time that can be booked ", - " based on the availability of a resource (e.g., a barber with ", + " based on the availability of a resource (for example, a barber with ", " appointments of 30 minutes each that are open for booking every weekday ", " between 8:00 - 17:00). These slots are calculated by the constraints of ", " the schedule.", "", " + [**Calendar**](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar): Where you schedule appointments, classes, and courses.", "", - " + [**Membership plans with Wix Pricing Plans**](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#selling-membership-plans-and-packages): A pre-paid bundle of services, or a membership ", + " + [**Membership plans with Wix Pricing Plans**](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#selling-membership-plans-and-packages): A prepaid bundle of services, or a membership ", " including access to certain services. Access a member's pricing plans with APIs by ", - " calling the `checkoutOptions()` function with the member's `contactId`." ], + " calling the [`getCheckoutOptions()`](#getCheckoutOptions) function." ], "links": [], "examples": [], "extra": @@ -733,7 +732,7 @@ [ "removed" ] }, { "name": "AvailabilityOptions", "locations": - [ { "lineno": 74, + [ { "lineno": 72, "filename": "bookings.js" } ], "docs": { "summary": "An object used when calling [`getServiceAvailability()`](#getServiceAvailability)\n containing options for which slots should be returned.", @@ -1419,7 +1418,7 @@ "labels": [] }, { "name": "ServiceAvailability", "locations": - [ { "lineno": 86, + [ { "lineno": 84, "filename": "bookings.js" } ], "docs": { "summary": "An object returned from [`getServiceAvailability()`](#getServiceAvailability)\n containing the available bookings slots.", @@ -1488,10 +1487,11 @@ { "name": "Array", "typeParams": [ "wix-bookings.Slot" ] }, - "doc": "List of available slots." } ], + "doc": "List of the available slots.\n\nMax: 500 slots" } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "Slot", "locations": [ { "lineno": 94, From 8d274b80d5df588b0e630d626d0a06d3b2497051 Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 4 Dec 2022 09:22:12 +0200 Subject: [PATCH 18/20] DocWorks for wixcode-bookings - no significant changes detected --- wixcode-bookings/wix-bookings.service.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index bc314561c0..4efea0df6d 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,7 +1,6 @@ { "name": "wix-bookings", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "bookings.js" }, @@ -1490,8 +1489,7 @@ "doc": "List of the available slots.\n\nMax: 500 slots" } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "Slot", "locations": [ { "lineno": 94, From 125e0213eab0f8eb55ee34a3b5eb37233e81aebd Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Sun, 4 Dec 2022 09:28:51 +0200 Subject: [PATCH 19/20] DocWorks for wixcode-bookings - 1 change detected changes: Service wix-bookings has changed description --- wixcode-bookings/wix-bookings.service.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index 4efea0df6d..e74545709c 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,6 +1,7 @@ { "name": "wix-bookings", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "bookings.js" }, @@ -68,7 +69,7 @@ "", " + [**Membership plans with Wix Pricing Plans**](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#selling-membership-plans-and-packages): A prepaid bundle of services, or a membership ", " including access to certain services. Access a member's pricing plans with APIs by ", - " calling the [`getCheckoutOptions()`](#getCheckoutOptions) function." ], + " calling the [`checkoutBooking()`](wix-bookings/checkoutBooking) function." ], "links": [], "examples": [], "extra": From 1c80d06d52fff5ff75e3c1089952a5e84c78617a Mon Sep 17 00:00:00 2001 From: MartaBerman Date: Mon, 5 Dec 2022 09:13:31 +0200 Subject: [PATCH 20/20] DocWorks for wixcode-bookings - no significant changes detected --- wixcode-bookings/wix-bookings.service.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/wixcode-bookings/wix-bookings.service.json b/wixcode-bookings/wix-bookings.service.json index e74545709c..91b9ed9697 100644 --- a/wixcode-bookings/wix-bookings.service.json +++ b/wixcode-bookings/wix-bookings.service.json @@ -1,7 +1,6 @@ { "name": "wix-bookings", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "bookings.js" },