@wix/bookings 1.0.159 → 1.0.160

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.
@@ -26,7 +26,7 @@ export declare function query(payload: QueryResourcesRequest): RequestOptionsFac
26
26
  *
27
27
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
28
28
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
29
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
29
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
30
30
  *
31
31
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
32
32
  *
@@ -44,7 +44,7 @@ export declare function create(payload: CreateResourceRequest): RequestOptionsFa
44
44
  * Updates a resource.
45
45
  *
46
46
  *
47
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
47
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
48
48
  *
49
49
  *
50
50
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -54,18 +54,18 @@ export declare function update(payload: UpdateResourceRequest): RequestOptionsFa
54
54
  * Updates a resource's schedule.
55
55
  *
56
56
  *
57
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
57
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
58
58
  *
59
59
  *
60
60
  * To update a resource's schedule to remove business hours and add custom hours:
61
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
62
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
61
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
62
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
63
63
  *
64
64
  *
65
65
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
66
66
  *
67
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
68
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
67
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
68
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
69
69
  *
70
70
  *
71
71
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -257,7 +257,7 @@ exports.query = query;
257
257
  *
258
258
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
259
259
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
260
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
260
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
261
261
  *
262
262
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
263
263
  *
@@ -317,7 +317,7 @@ exports.create = create;
317
317
  * Updates a resource.
318
318
  *
319
319
  *
320
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
320
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
321
321
  *
322
322
  *
323
323
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -374,18 +374,18 @@ exports.update = update;
374
374
  * Updates a resource's schedule.
375
375
  *
376
376
  *
377
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
377
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
378
378
  *
379
379
  *
380
380
  * To update a resource's schedule to remove business hours and add custom hours:
381
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
382
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
381
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
382
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
383
383
  *
384
384
  *
385
385
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
386
386
  *
387
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
388
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
387
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
388
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
389
389
  *
390
390
  *
391
391
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -960,7 +960,7 @@ export interface QueryResourceCatalogOptions {
960
960
  *
961
961
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
962
962
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
963
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
963
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
964
964
  *
965
965
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
966
966
  *
@@ -993,7 +993,7 @@ export interface CreateResourceOptions {
993
993
  * Updates a resource.
994
994
  *
995
995
  *
996
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
996
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
997
997
  *
998
998
  *
999
999
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -1065,18 +1065,18 @@ export interface UpdateResourceOptions {
1065
1065
  * Updates a resource's schedule.
1066
1066
  *
1067
1067
  *
1068
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
1068
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
1069
1069
  *
1070
1070
  *
1071
1071
  * To update a resource's schedule to remove business hours and add custom hours:
1072
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
1073
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
1072
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
1073
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
1074
1074
  *
1075
1075
  *
1076
1076
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
1077
1077
  *
1078
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
1079
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
1078
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
1079
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
1080
1080
  *
1081
1081
  *
1082
1082
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -344,7 +344,7 @@ exports.queryResourceCatalog = queryResourceCatalog;
344
344
  *
345
345
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
346
346
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
347
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
347
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
348
348
  *
349
349
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
350
350
  *
@@ -429,7 +429,7 @@ exports.createResource = createResource;
429
429
  * Updates a resource.
430
430
  *
431
431
  *
432
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
432
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
433
433
  *
434
434
  *
435
435
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -512,18 +512,18 @@ exports.updateResource = updateResource;
512
512
  * Updates a resource's schedule.
513
513
  *
514
514
  *
515
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
515
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
516
516
  *
517
517
  *
518
518
  * To update a resource's schedule to remove business hours and add custom hours:
519
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
520
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
519
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
520
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
521
521
  *
522
522
  *
523
523
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
524
524
  *
525
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
526
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
525
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
526
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
527
527
  *
528
528
  *
529
529
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -26,7 +26,7 @@ export declare function query(payload: QueryResourcesRequest): RequestOptionsFac
26
26
  *
27
27
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
28
28
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
29
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
29
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
30
30
  *
31
31
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
32
32
  *
@@ -44,7 +44,7 @@ export declare function create(payload: CreateResourceRequest): RequestOptionsFa
44
44
  * Updates a resource.
45
45
  *
46
46
  *
47
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
47
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
48
48
  *
49
49
  *
50
50
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -54,18 +54,18 @@ export declare function update(payload: UpdateResourceRequest): RequestOptionsFa
54
54
  * Updates a resource's schedule.
55
55
  *
56
56
  *
57
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
57
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
58
58
  *
59
59
  *
60
60
  * To update a resource's schedule to remove business hours and add custom hours:
61
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
62
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
61
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
62
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
63
63
  *
64
64
  *
65
65
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
66
66
  *
67
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
68
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
67
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
68
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
69
69
  *
70
70
  *
71
71
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -252,7 +252,7 @@ export function query(payload) {
252
252
  *
253
253
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
254
254
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
255
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
255
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
256
256
  *
257
257
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
258
258
  *
@@ -311,7 +311,7 @@ export function create(payload) {
311
311
  * Updates a resource.
312
312
  *
313
313
  *
314
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
314
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
315
315
  *
316
316
  *
317
317
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -367,18 +367,18 @@ export function update(payload) {
367
367
  * Updates a resource's schedule.
368
368
  *
369
369
  *
370
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
370
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
371
371
  *
372
372
  *
373
373
  * To update a resource's schedule to remove business hours and add custom hours:
374
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
375
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
374
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
375
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
376
376
  *
377
377
  *
378
378
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
379
379
  *
380
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
381
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
380
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
381
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
382
382
  *
383
383
  *
384
384
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -960,7 +960,7 @@ export interface QueryResourceCatalogOptions {
960
960
  *
961
961
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
962
962
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
963
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
963
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
964
964
  *
965
965
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
966
966
  *
@@ -993,7 +993,7 @@ export interface CreateResourceOptions {
993
993
  * Updates a resource.
994
994
  *
995
995
  *
996
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
996
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
997
997
  *
998
998
  *
999
999
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -1065,18 +1065,18 @@ export interface UpdateResourceOptions {
1065
1065
  * Updates a resource's schedule.
1066
1066
  *
1067
1067
  *
1068
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
1068
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
1069
1069
  *
1070
1070
  *
1071
1071
  * To update a resource's schedule to remove business hours and add custom hours:
1072
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
1073
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
1072
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
1073
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
1074
1074
  *
1075
1075
  *
1076
1076
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
1077
1077
  *
1078
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
1079
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
1078
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
1079
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
1080
1080
  *
1081
1081
  *
1082
1082
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
@@ -320,7 +320,7 @@ export function queryResourceCatalog(options) {
320
320
  *
321
321
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
322
322
  * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
323
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
323
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](../Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
324
324
  *
325
325
  * You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
326
326
  *
@@ -404,7 +404,7 @@ export function createResource(resource, options) {
404
404
  * Updates a resource.
405
405
  *
406
406
  *
407
- * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](resources/updateresourceschedule).
407
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
408
408
  *
409
409
  *
410
410
  * >**Notes:** When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
@@ -486,18 +486,18 @@ export function updateResource(_id, options) {
486
486
  * Updates a resource's schedule.
487
487
  *
488
488
  *
489
- * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`] (resources/updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
489
+ * The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource). The following schedule properties can be updated: + `availability.start` + `availability.linkedSchedules`
490
490
  *
491
491
  *
492
492
  * To update a resource's schedule to remove business hours and add custom hours:
493
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.
494
- * - Use [`createSession()`](Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
493
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
494
+ * - Use [`createSession()`](../Sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
495
495
  *
496
496
  *
497
497
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
498
498
  *
499
- * - Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
500
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-backend.Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
499
+ * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
500
+ * - If you want to remove the custom sessions, use [`deleteSession()`](../Sessions/deletesession) to delete the resource's sessions of type `WORKING_HOURS`. You do not have to delete exiting custom sessions. You can have both default working hours and custom hours for the same schedule. Custom sessions that are not deleted will continue to be included in availability calculations and can still be booked.
501
501
  *
502
502
  *
503
503
  * > **Notes:** The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working. A resource can have one schedule only. A resource can have both default business hours and custom hours in its schedule. When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `INDIVIDUAL`, `GROUP`, and `COURSE`. Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource schedule.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/bookings",
3
- "version": "1.0.159",
3
+ "version": "1.0.160",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "7448cd9cd5e5cb02febb2625c337f248fa7a934ce0994a631447d88e"
36
+ "falconPackageHash": "f4d0afeffeb3c6487600f07734fb0ac63f32fa87e43d3c20a3e91f59"
37
37
  }