@tulipnpm/timekit_project_selector 2.0.8 → 2.1.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/dist/timekit_project_selector.js +3873 -135
- package/dist/timekit_project_selector.min.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -42,6 +42,8 @@ Tulip Appointments Web Widget has many configuration options:
|
|
|
42
42
|
| selectorOptions | No | | See below for details |
|
|
43
43
|
| widgetImageUrl | Yes | Tulip Appointments Icon | When using the default widget UI, change this value to your desired image URL to replace widget image |
|
|
44
44
|
| duplicateCustomerCheck | Yes | false | When a new booking is created, a call is made to check for potential duplicate Timekit customers. Requires the following webhook to be configured via Timekit: **/api/customers/timekit_webhook_connect_client**|
|
|
45
|
+
| shouldConsiderAssociateAvailability | Yes | false | When enabled, this configuration ensures that service availability considers store associate schedules, returning only times when associates are available.|
|
|
46
|
+
| shouldAutomaticallyBookAssociates | Yes | false | When enabled, associates are automatically assigned to bookings. |
|
|
45
47
|
|
|
46
48
|
### Widget Modes
|
|
47
49
|
|
|
@@ -265,6 +267,34 @@ timekit_project_selector.init({
|
|
|
265
267
|
});
|
|
266
268
|
```
|
|
267
269
|
|
|
270
|
+
### Include Associate Schedules In Project Availability (Optional)
|
|
271
|
+
|
|
272
|
+
By default, the widget does not include associates availability when displaying services availability. To include associates availability, the `shouldConsiderAssociateAvailability` configuration option can be set to `true`.
|
|
273
|
+
|
|
274
|
+
```js
|
|
275
|
+
timekit_project_selector.init({
|
|
276
|
+
app_key: <timekit_app_key>,
|
|
277
|
+
...,
|
|
278
|
+
shouldConsiderAssociateAvailability: true,
|
|
279
|
+
});
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
### Automatically Assign Associates To Bookings (Optional)
|
|
285
|
+
|
|
286
|
+
Once bokings are created associates must be manually assigned to those bookings. This automatically assigns assigns associates when bookings are created. To automatically assign associates to bookings the `shouldAutomaticallyBookAssociates` configuration option can be set to `true`.
|
|
287
|
+
|
|
288
|
+
```js
|
|
289
|
+
timekit_project_selector.init({
|
|
290
|
+
app_key: <timekit_app_key>,
|
|
291
|
+
...,
|
|
292
|
+
shouldAutomaticallyBookAssociates: true,
|
|
293
|
+
});
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
268
298
|
### Search For Potential Duplicate Timekit Customers (Optional)
|
|
269
299
|
|
|
270
300
|
By default, the widget does not check for potential duplicate customers when creating a new booking. To check for potential duplicate customers, the `duplicateCustomerCheck` configuration option can be set to `true`. A webhook must also be configured via the [Admin Dashboard](https://admin.timekit.io/) in Timekit under API Settings with the following url: **https://**your_server_url**/api/customers/timekit_webhook_connect_client**.
|