@wix/bookings 1.0.175 → 1.0.177

package/build/cjs/src/bookings-catalog-v1-resource.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-catalog-v1-resource.public.js","sourceRoot":"","sources":["../../../src/bookings-catalog-v1-resource.public.ts"],"names":[],"mappings":";;;AACA,qGAakD;AAErC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,IAAI,CAAC,UAAsB;IACzC,OAAO,CAAC,OAAqB,EAAE,EAAE,CAC/B,IAAA,6CAAa,EACX,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oBAOC;AAED,SAAgB,oBAAoB,CAAC,UAAsB;IACzD,OAAO,CAAC,OAAqC,EAAE,EAAE,CAC/C,IAAA,6DAA6B,EAC3B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oDAOC;AAED,SAAgB,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,QAAkB,EAAE,OAA+B,EAAE,EAAE,CAC7D,IAAA,uDAAuB,EACrB,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wCAQC;AAED,SAAgB,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,GAAkB,EAAE,OAA+B,EAAE,EAAE,CAC7D,IAAA,uDAAuB,EACrB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wCAQC;AAED,SAAgB,sBAAsB,CAAC,UAAsB;IAC3D,OAAO,CAAC,UAAyB,EAAE,OAAuC,EAAE,EAAE,CAC5E,IAAA,+DAA+B,EAC7B,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wDAQC;AAED,SAAgB,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,gDAAgB,EACd,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0BAOC;AAED,mGAckD;AAbhD,6HAAA,GAAG,OAAA;AACH,sIAAA,YAAY,OAAA;AACZ,+IAAA,qBAAqB,OAAA;AACrB,sIAAA,YAAY,OAAA;AACZ,wIAAA,cAAc,OAAA;AACd,+IAAA,qBAAqB,OAAA;AACrB,mIAAA,SAAS,OAAA;AACT,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,mIAAA,SAAS,OAAA;AACT,+HAAA,KAAK,OAAA"}
+{"version":3,"file":"bookings-catalog-v1-resource.public.js","sourceRoot":"","sources":["../../../src/bookings-catalog-v1-resource.public.ts"],"names":[],"mappings":";;;AACA,qGAakD;AAErC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,IAAI,CAAC,UAAsB;IACzC,OAAO,CAAC,OAAqB,EAAE,EAAE,CAC/B,IAAA,6CAAa,EACX,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oBAOC;AAED,SAAgB,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,OAAsB,EAAE,EAAE,CAChC,IAAA,8CAAc,EACZ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sBAOC;AAED,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,QAAkB,EAAE,OAAuB,EAAE,EAAE,CACrD,IAAA,+CAAe,EACb,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wBAQC;AAED,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,GAAkB,EAAE,OAAuB,EAAE,EAAE,CACrD,IAAA,+CAAe,EACb,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wBAQC;AAED,SAAgB,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,UAAyB,EAAE,OAA+B,EAAE,EAAE,CACpE,IAAA,uDAAuB,EACrB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wCAQC;AAED,SAAgB,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,gDAAgB,EACd,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0BAOC;AAED,mGAckD;AAbhD,6HAAA,GAAG,OAAA;AACH,sIAAA,YAAY,OAAA;AACZ,+IAAA,qBAAqB,OAAA;AACrB,sIAAA,YAAY,OAAA;AACZ,wIAAA,cAAc,OAAA;AACd,+IAAA,qBAAqB,OAAA;AACrB,mIAAA,SAAS,OAAA;AACT,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,wIAAA,cAAc,OAAA;AACd,mIAAA,SAAS,OAAA;AACT,+HAAA,KAAK,OAAA"}

package/build/cjs/src/bookings-catalog-v1-resource.universal.d.ts

@@ -929,14 +929,26 @@ export interface ListOptions {
 /**
  * Retrieves a list of the resources according to the specified filters and paging.
  *
+ * The query parameter is optional. If no query is provided than all non-deleted resources are returned.
  *
- * The query parameter is optional. If no query is provided, all non-deleted resources are returned.
+ * |Property|Is supported|
+ * |--|--|
+ * |filter | supported fields: `resource.id`, `resource.tags`, `resource.status`|
+ * |paging | supported |
+ * |fields | supported |
+ * |fieldsets | **not supported**  |
+ * |sort | **not supported**  |
  *
- * > **Notes:** The following objects in the query parameter are not supported for this query:
- * > - sort
- * > - fieldsets
  *
+ * >**Notes:**
+ * > + The following objects in the `query` parameter are not supported for this query:
+ * >    - `sort`
+ * >    - `fieldsets`
+ *
+ * > **Permissions**
+ * > This endpoint requires the Read Bookings Calendar, Read Bookings - Public Data, Read Bookings - Including Participants or Manage Bookings permission scope.
  * @public
+ * @documentationMaturity preview
  * @permissionScope Read Bookings - Public Data
  * @permissionScope Read bookings calendar - including participants
  * @permissionScope Read Bookings Calendar
@@ -944,35 +956,54 @@ export interface ListOptions {
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-export declare function queryResourceCatalog(options?: QueryResourceCatalogOptions): Promise<QueryResourcesResponse>;
-export interface QueryResourceCatalogOptions {
+export declare function query(options?: QueryOptions): Promise<QueryResourcesResponse>;
+export interface QueryOptions {
     query?: QueryV2;
 }
 /**
  * Creates a resource.
- *
- *
+ * <!--ONLY:VELO
  * The `createResource()` function returns a Promise that resolves to the created resource.
- * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the availability.start property. For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `WORKING_HOURS` using the resource's schedule. You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
+ * <!--END:ONLY:VELO-->
  *
+ * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the `availability.start` property.
+ * For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `"WORKING_HOURS"` using the resource's schedule.
+ * You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
  *
+ * <!--ONLY:VELO
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
- * - 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.
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](wix-bookings-v2/sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
- * - You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
- *
+ * + 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.
+ * + If the resource has its own custom working hours, create the resource, then create sessions of type `"WORKING_HOURS"` using the [`createSession()`](wix-bookings-backend.Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
+ * + You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
  *
  * > **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.
- * - The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
- * - You can only add the business resource's schedule as a linked schedule for a resource.
- * - A resource can have one schedule only.
- * - You can have up to 135 active resources and an additional 135 deleted resources.
- * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource.
+ * > + 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.
+ * > + The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
+ * > + You can only add the business resource's schedule as a linked schedule for a resource.
+ * > + A resource can have one schedule only.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
+ *
+ * <!--ONLY:REST-->
+ * Use the following steps to create resources:
+ * - Create the resource using including schedule information.
+ * - 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 in the schedule parameters.
+ * - If the resource has its own custom working hours, create sessions of type `"WORKING_HOURS"`. Use the `scheduleId` of the new resource when creating the sessions. These session can be single sessions or recurring sessions. You can have both business hours and custom hours for the same resource schedule.
+ *
+ * >**Notes:**
+ * > + A resource can have one schedule only.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
+ *
  *
- * This function is not a universal function and runs only on the backend.
+ *
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param resource - Resource details.
  * @public
+ * @documentationMaturity preview
  * @requiredField options.schedules.availability.start
  * @requiredField options.schedules.intervals.start
  * @requiredField resource
@@ -980,8 +1011,8 @@ export interface QueryResourceCatalogOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function createResource(resource: Resource, options?: CreateResourceOptions): Promise<CreateResourceResponse>;
-export interface CreateResourceOptions {
+export declare function create(resource: Resource, options?: CreateOptions): Promise<CreateResourceResponse>;
+export interface CreateOptions {
     /**
      * List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.
      * If provided, any schedules in the resource entity will be ignored.
@@ -990,18 +1021,29 @@ export interface CreateResourceOptions {
 }
 /**
  * Updates a resource.
+ * <!--ONLY:VELO
+ * 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()`](wix-bookings-backend/resource/updateresourceschedule).
  *
- *
- * 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).
- *
+ * >**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. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
+ * <!--ONLY:REST-->
+ * Use this endpoint to update all resource information except for the resource's schedule. To update a resource's schedule use
+ * the [Update Schedule](https://dev.wix.com/api/rest/wix-bookings/resources/update-schedule) endpoint.
  *
  * >**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.
+ * > + 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"`.
+ * > + When updating a resource's schedule you cannot change the resource tag used by the Wix Bookings app. Tags used by the app have the values `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE”`.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
- * This function is not a universal function and runs only on the backend.
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param _id - Resource ID.
  * @public
+ * @documentationMaturity preview
  * @requiredField _id
  * @requiredField scheduleActions.cancelRequests.scheduleId
  * @requiredField scheduleActions.createRequests.schedule.availability.start
@@ -1011,8 +1053,8 @@ export interface CreateResourceOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function updateResource(_id: string | null, options?: UpdateResourceOptions): Promise<UpdateResourceResponse>;
-export interface UpdateResourceOptions {
+export declare function update(_id: string | null, options?: UpdateOptions): Promise<UpdateResourceResponse>;
+export interface UpdateOptions {
     resource: {
         /**
          * Resource ID.
@@ -1027,13 +1069,17 @@ export interface UpdateResourceOptions {
         phone?: string | null;
         /** Resource description. */
         description?: string | null;
-        /** @internal */
+        /**
+         * @internal
+         * @internal */
         tag?: string | null;
         /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
         tags?: string[] | null;
         /** Resource images. */
         images?: string[];
-        /** @internal */
+        /**
+         * @internal
+         * @internal */
         schedules?: Schedule[];
         /**
          * List of IDs of schedules owned by this resource.
@@ -1065,39 +1111,67 @@ export interface UpdateResourceOptions {
     fieldMask?: string[];
 }
 /**
- * Updates a resource's schedule.
- *
- *
- * 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`
- *
+ * Updates a resource's schedule
+ * <!--ONLY:VELO
+ * 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()`]  (wix-bookings-backend/resources/updateresource).
+ * The following schedule properties can be updated:
+ * + `availability.start`
+ * + `availability.linkedSchedules`
+ * <!--END:ONLY:VELO-->
  *
  * To update a resource's schedule to remove business hours and add custom hours:
- * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
- * - Use [`createSession()`](wix-bookings-v2/sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
- *
+ * <!--ONLY:REST-->
+ * + Update the resource's schedule to remove the business's `scheduleId` from the `availability.linkedSchedules` array.
+ * + Create a set of recurring sessions of type `"WORKING_HOURS"` to define the resource's new hours.
+ * <!--END:ONLY:REST-->
+ * <!--ONLY:VELO
+ * + Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the   `availability.linkedSchedules` array.
+ * + Use [`createSession()`](wix-bookings-backend.Sessions/createsession) to create a set of recurring sessions of type `"WORKING_HOURS"` to   define the resource's new hours.
+ * <!--END:ONLY:VELO-->
  *
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
+ * <!--ONLY:REST-->
+ * + Update the resource's schedule to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
+ * + If you want to remove the custom sessions, delete the resource's sessions of type `"WORKING_HOURS"`.
+ * You do not have to delete exiting custom sessions. Custom session that are not deleted will continue to be included in availability  calculations and can still be booked.
+ * <!--END:ONLY:REST-->
+ * <!--ONLY:VELO
+ * + Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to   the `availability.linkedSchedules` array.
+ * + 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.
  *
- * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-v2/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.
+ * > **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. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * @snippet [updateResourceScheduleDefaultToCustom.es6=Update a resource's schedule from business to custom hours]
+ * Update a resource's schedule from the business's default working hours to 2 custom days per week.
+ * @snippet [updateResourceScheduleCustomToDefault.es6=Update a resource's schedule from custom to business hours]
+ * <!--END:ONLY:VELO-->
+ * <!--ONLY:REST-->
+ * >**Notes:**
+ * > + 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”`.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
  *
- * > **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.
  *
- * This function is not a universal function and runs only on the backend.
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param resourceId - Resource id to update.
  * @public
+ * @documentationMaturity preview
  * @requiredField options.schedule._id
  * @requiredField resourceId
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function updateResourceSchedule(resourceId: string | null, options?: UpdateResourceScheduleOptions): Promise<UpdateScheduleResponse>;
-export interface UpdateResourceScheduleOptions {
+export declare function updateSchedule(resourceId: string | null, options?: UpdateScheduleOptions): Promise<UpdateScheduleResponse>;
+export interface UpdateScheduleOptions {
     /** Fieldmask for schedule */
     fieldmask?: string[];
     /** The schedule to update */
@@ -1105,19 +1179,28 @@ export interface UpdateResourceScheduleOptions {
 }
 /**
  * Deletes a resource.
- *
+ * <!--ONLY:VELO
  * The `deleteResource()` function returns a Promise that is resolved when a resource is deleted.
- *
- *
- * Deleting a resource updates its status to `DELETED`.
+ * <!--END:ONLY:VELO-->
+ * Deleting a resource updates its `status` to `"DELETED"`.
  *
  * You cannot delete a resource if it has booked sessions.
  *
+ * <!--ONLY:VELO
+ * >**Notes:**
+ * > + The Bookings app automatically creates a resource with a name and tag of value `"business"``. This resource is used for the business's schedule and working hours and cannot be deleted.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
  *
+ * <!--ONLY:REST-->
  * >**Notes:**
- * - The Bookings app automatically creates a resource with a name and tag of value `business`. This resource is used for the business's schedule and working hours and cannot be deleted.
- * - You can have up to 135 active resources and an additional 135 deleted resources.
- * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource.
+ * > + The Bookings app creates a resource with `"business"` in name and tag values. This resource is used for the business's schedule and working hours and cannot be deleted.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ *
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param _id - ID of the resource to delete.
  * @public
  * @documentationMaturity preview

package/build/cjs/src/bookings-catalog-v1-resource.universal.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._delete = exports.updateResourceSchedule = exports.updateResource = exports.createResource = exports.queryResourceCatalog = exports.list = exports.Event = exports.SortOrder = exports.ResourceStatus = exports.ConferenceType = exports.ScheduleStatus = exports.ApprovalStatus = exports.DayOfWeek = exports.LocationsLocationType = exports.LocationStatus = exports.LocationType = exports.RecurringIntervalType = exports.Transparency = exports.Day = exports.__debug = void 0;
+exports._delete = exports.updateSchedule = exports.update = exports.create = exports.query = exports.list = exports.Event = exports.SortOrder = exports.ResourceStatus = exports.ConferenceType = exports.ScheduleStatus = exports.ApprovalStatus = exports.DayOfWeek = exports.LocationsLocationType = exports.LocationStatus = exports.LocationType = exports.RecurringIntervalType = exports.Transparency = exports.Day = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
 const ambassadorWixBookingsCatalogV1Resource = __importStar(require("./bookings-catalog-v1-resource.http"));
 let __verbose = false;
@@ -267,14 +267,26 @@ exports.list = list;
 /**
  * Retrieves a list of the resources according to the specified filters and paging.
  *
+ * The query parameter is optional. If no query is provided than all non-deleted resources are returned.
  *
- * The query parameter is optional. If no query is provided, all non-deleted resources are returned.
+ * |Property|Is supported|
+ * |--|--|
+ * |filter | supported fields: `resource.id`, `resource.tags`, `resource.status`|
+ * |paging | supported |
+ * |fields | supported |
+ * |fieldsets | **not supported**  |
+ * |sort | **not supported**  |
  *
- * > **Notes:** The following objects in the query parameter are not supported for this query:
- * > - sort
- * > - fieldsets
  *
+ * >**Notes:**
+ * > + The following objects in the `query` parameter are not supported for this query:
+ * >    - `sort`
+ * >    - `fieldsets`
+ *
+ * > **Permissions**
+ * > This endpoint requires the Read Bookings Calendar, Read Bookings - Public Data, Read Bookings - Including Participants or Manage Bookings permission scope.
  * @public
+ * @documentationMaturity preview
  * @permissionScope Read Bookings - Public Data
  * @permissionScope Read bookings calendar - including participants
  * @permissionScope Read Bookings Calendar
@@ -282,7 +294,7 @@ exports.list = list;
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-function queryResourceCatalog(options) {
+function query(options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = { query: '$[0].query' };
@@ -331,32 +343,51 @@ function queryResourceCatalog(options) {
         }
     });
 }
-exports.queryResourceCatalog = queryResourceCatalog;
+exports.query = query;
 /**
  * Creates a resource.
- *
- *
+ * <!--ONLY:VELO
  * The `createResource()` function returns a Promise that resolves to the created resource.
- * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the availability.start property. For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `WORKING_HOURS` using the resource's schedule. You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
+ * <!--END:ONLY:VELO-->
  *
+ * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the `availability.start` property.
+ * For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `"WORKING_HOURS"` using the resource's schedule.
+ * You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
  *
+ * <!--ONLY:VELO
  * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
- * - 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.
- * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](wix-bookings-v2/sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
- * - You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
- *
+ * + 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.
+ * + If the resource has its own custom working hours, create the resource, then create sessions of type `"WORKING_HOURS"` using the [`createSession()`](wix-bookings-backend.Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
+ * + You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
  *
  * > **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.
- * - The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
- * - You can only add the business resource's schedule as a linked schedule for a resource.
- * - A resource can have one schedule only.
- * - You can have up to 135 active resources and an additional 135 deleted resources.
- * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource.
+ * > + 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.
+ * > + The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
+ * > + You can only add the business resource's schedule as a linked schedule for a resource.
+ * > + A resource can have one schedule only.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
+ *
+ * <!--ONLY:REST-->
+ * Use the following steps to create resources:
+ * - Create the resource using including schedule information.
+ * - 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 in the schedule parameters.
+ * - If the resource has its own custom working hours, create sessions of type `"WORKING_HOURS"`. Use the `scheduleId` of the new resource when creating the sessions. These session can be single sessions or recurring sessions. You can have both business hours and custom hours for the same resource schedule.
+ *
+ * >**Notes:**
+ * > + A resource can have one schedule only.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
- * This function is not a universal function and runs only on the backend.
+ *
+ *
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param resource - Resource details.
  * @public
+ * @documentationMaturity preview
  * @requiredField options.schedules.availability.start
  * @requiredField options.schedules.intervals.start
  * @requiredField resource
@@ -364,7 +395,7 @@ exports.queryResourceCatalog = queryResourceCatalog;
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-function createResource(resource, options) {
+function create(resource, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
@@ -423,21 +454,32 @@ function createResource(resource, options) {
         }
     });
 }
-exports.createResource = createResource;
+exports.create = create;
 /**
  * Updates a resource.
+ * <!--ONLY:VELO
+ * 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()`](wix-bookings-backend/resource/updateresourceschedule).
  *
- *
- * 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).
- *
+ * >**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. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
+ * <!--ONLY:REST-->
+ * Use this endpoint to update all resource information except for the resource's schedule. To update a resource's schedule use
+ * the [Update Schedule](https://dev.wix.com/api/rest/wix-bookings/resources/update-schedule) endpoint.
  *
  * >**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.
+ * > + 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"`.
+ * > + When updating a resource's schedule you cannot change the resource tag used by the Wix Bookings app. Tags used by the app have the values `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE”`.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
- * This function is not a universal function and runs only on the backend.
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param _id - Resource ID.
  * @public
+ * @documentationMaturity preview
  * @requiredField _id
  * @requiredField scheduleActions.cancelRequests.scheduleId
  * @requiredField scheduleActions.createRequests.schedule.availability.start
@@ -447,7 +489,7 @@ exports.createResource = createResource;
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-function updateResource(_id, options) {
+function update(_id, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
@@ -510,40 +552,68 @@ function updateResource(_id, options) {
         }
     });
 }
-exports.updateResource = updateResource;
+exports.update = update;
 /**
- * Updates a resource's schedule.
- *
- *
- * 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`
- *
+ * Updates a resource's schedule
+ * <!--ONLY:VELO
+ * 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()`]  (wix-bookings-backend/resources/updateresource).
+ * The following schedule properties can be updated:
+ * + `availability.start`
+ * + `availability.linkedSchedules`
+ * <!--END:ONLY:VELO-->
  *
  * To update a resource's schedule to remove business hours and add custom hours:
- * - Use [`updateResourceSchedule()`](#updateresourceschedule) to remove the business's scheduleId from the `availability.linkedSchedules` array.
- * - Use [`createSession()`](wix-bookings-v2/sessions/createsession) to create a set of recurring sessions of type `WORKING_HOURS` to define the resource's new hours.
- *
+ * <!--ONLY:REST-->
+ * + Update the resource's schedule to remove the business's `scheduleId` from the `availability.linkedSchedules` array.
+ * + Create a set of recurring sessions of type `"WORKING_HOURS"` to define the resource's new hours.
+ * <!--END:ONLY:REST-->
+ * <!--ONLY:VELO
+ * + Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the   `availability.linkedSchedules` array.
+ * + Use [`createSession()`](wix-bookings-backend.Sessions/createsession) to create a set of recurring sessions of type `"WORKING_HOURS"` to   define the resource's new hours.
+ * <!--END:ONLY:VELO-->
  *
  * To update a resource's schedule to add default business hours, and keep or remove custom hours:
+ * <!--ONLY:REST-->
+ * + Update the resource's schedule to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
+ * + If you want to remove the custom sessions, delete the resource's sessions of type `"WORKING_HOURS"`.
+ * You do not have to delete exiting custom sessions. Custom session that are not deleted will continue to be included in availability  calculations and can still be booked.
+ * <!--END:ONLY:REST-->
+ * <!--ONLY:VELO
+ * + Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to   the `availability.linkedSchedules` array.
+ * + 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.
  *
- * - Use [`updateResourceSchedule()`](#updateresourceschedule) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.
- * - If you want to remove the custom sessions, use [`deleteSession()`](wix-bookings-v2/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.
+ * > **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. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * @snippet [updateResourceScheduleDefaultToCustom.es6=Update a resource's schedule from business to custom hours]
+ * Update a resource's schedule from the business's default working hours to 2 custom days per week.
+ * @snippet [updateResourceScheduleCustomToDefault.es6=Update a resource's schedule from custom to business hours]
+ * <!--END:ONLY:VELO-->
+ * <!--ONLY:REST-->
+ * >**Notes:**
+ * > + 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”`.
+ * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
  *
- * > **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.
  *
- * This function is not a universal function and runs only on the backend.
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param resourceId - Resource id to update.
  * @public
+ * @documentationMaturity preview
  * @requiredField options.schedule._id
  * @requiredField resourceId
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-function updateResourceSchedule(resourceId, options) {
+function updateSchedule(resourceId, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
@@ -591,22 +661,31 @@ function updateResourceSchedule(resourceId, options) {
         }
     });
 }
-exports.updateResourceSchedule = updateResourceSchedule;
+exports.updateSchedule = updateSchedule;
 /**
  * Deletes a resource.
- *
+ * <!--ONLY:VELO
  * The `deleteResource()` function returns a Promise that is resolved when a resource is deleted.
- *
- *
- * Deleting a resource updates its status to `DELETED`.
+ * <!--END:ONLY:VELO-->
+ * Deleting a resource updates its `status` to `"DELETED"`.
  *
  * You cannot delete a resource if it has booked sessions.
  *
+ * <!--ONLY:VELO
+ * >**Notes:**
+ * > + The Bookings app automatically creates a resource with a name and tag of value `"business"``. This resource is used for the business's schedule and working hours and cannot be deleted.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
+ * <!--END:ONLY:VELO-->
  *
+ * <!--ONLY:REST-->
  * >**Notes:**
- * - The Bookings app automatically creates a resource with a name and tag of value `business`. This resource is used for the business's schedule and working hours and cannot be deleted.
- * - You can have up to 135 active resources and an additional 135 deleted resources.
- * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource.
+ * > + The Bookings app creates a resource with `"business"` in name and tag values. This resource is used for the business's schedule and working hours and cannot be deleted.
+ * > + You can have up to 135 active resources and an additional 135 deleted resources.
+ *
+ * >**Permissions:**
+ * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
+ * <!--END:ONLY:REST-->
  * @param _id - ID of the resource to delete.
  * @public
  * @documentationMaturity preview