Skip to content
2 changes: 1 addition & 1 deletion wix-bookings-backend/wix-bookings-backend.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"set": false,
"type": "wix-bookings-backend.Resources",
"locations":
[ { "lineno": 24,
[ { "lineno": 34,
"filename": "resources.js" } ],
"docs":
{ "summary": "The Resources API provides functionality for creating and managing wix-bookings resources.",
Expand Down
28 changes: 19 additions & 9 deletions wix-bookings-backend/wix-bookings-backend/Resources.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@
{ "summary": "The Bookings Resources API provides functionality for creating, managing, and querying resources.",
"description":
[ "The Bookings Resources API provides functionality for creating, managing, and querying resources.",
"",
"<blockquote class='warning'>",
"",
"__Deprecation Notice:__",
"",
"The **Bookings V1 Resources Velo API** has been replaced with the [Resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction), [Resource Types](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction), [Staff Members](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction), and [Calendar Schedules](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) SDK APIs and will be removed on March 31, 2026.",
"",
"</blockquote>",
"",
"**Migration Instructions**: Resources with `\"staff\"` tags should migrate to the [Staff Members SDK API](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction). All other resources (for example, equipment or rooms) should use the [Resources SDK API](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) and must be assigned to a resource type via the [Resource Types SDK API](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction). Schedule management moves to the [Calendar Schedules SDK API](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction). Existing resources will continue working until the deprecation date.",
"",
"A resource is a business asset like a staff member, or equipment needed to provide a service.",
"Each resource owns a schedule. The schedule defines the resource's availability. You can set up a custom schedule for a resource, use the business's default working hours, or combine the two.",
Expand Down Expand Up @@ -56,10 +66,10 @@
[ "wix-bookings-backend.Resource" ] },
"doc": "Fulfilled - Resource" },
"locations":
[ { "lineno": 35,
[ { "lineno": 45,
"filename": "resources.js" } ],
"docs":
{ "summary": "Creates a resource.",
{ "summary": "**Deprecated.**\nCreate Resource has been replaced with the [Create Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/create-resource) and [Create Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/create-staff-member) SDK methods and will be removed on March 31, 2026.",
"description":
[ "<!--ONLY:VELO-->",
" The `createResource()` function returns a Promise that resolves to the created resource.",
Expand Down Expand Up @@ -365,10 +375,10 @@
[ "string" ] },
"doc": "Fulfilled - ID of the deleted resource." },
"locations":
[ { "lineno": 111,
[ { "lineno": 124,
"filename": "resources.js" } ],
"docs":
{ "summary": "Deletes a resource.",
{ "summary": "**Deprecated.**\nDelete Resource has been replaced with [Delete Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/delete-resource) and [Delete Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/delete-staff-member) SDK methods and will be removed on March 31, 2026.",
"description":
[ "The `deleteResource()` function returns a Promise that resolves to the resource ID when the resouce is deleted.",
"Deleting a resource updates its `status` to `\"DELETED\"`.",
Expand Down Expand Up @@ -423,7 +433,7 @@
[ { "lineno": 27,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Creates a query to retrieve extended resource information.",
{ "summary": "**Deprecated.**\nQuery Resource Catalog has been replaced with [Query Resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/query-resources) and [Query Staff Members](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/query-staff-members) SDK methods and will be removed on March 31, 2026.",
"description":
[ "<!--ONLY:VELO-->",
"The `queryResourceCatalog()` function builds a query to retrieve a catalog of resources, including resources' related schedules and slugs, and returns a [`ResourceCatalogQueryBuilder`](https://dev.wix.com/docs/velo/api-reference/wix-bookings-backend/resources/resource-catalog-query-builder/introduction) object.",
Expand Down Expand Up @@ -550,10 +560,10 @@
[ "wix-bookings-backend.Resource" ] },
"doc": "Fulfilled - Updated resource" },
"locations":
[ { "lineno": 85,
[ { "lineno": 96,
"filename": "resources.js" } ],
"docs":
{ "summary": "Updates a resource.",
{ "summary": "**Deprecated.**\nUpdate Resource has been replaced with [Update Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/update-resource) and [Update Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/update-staff-member) SDK methods and will be removed on March 31, 2026.",
"description":
[ "<!--ONLY:VELO-->",
"The `updateResource()` function returns a Promise that resolves when a resource is updated.",
Expand Down Expand Up @@ -636,10 +646,10 @@
[ "wix-bookings-backend.Resources.ResourceSchedule" ] },
"doc": "" },
"locations":
[ { "lineno": 140,
[ { "lineno": 154,
"filename": "resources.js" } ],
"docs":
{ "summary": "Updates a resource's schedule.",
{ "summary": "**Deprecated.**\nUpdate Schedule has been replaced with [Update Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/update-schedule) and [Assign Working Hours Schedule](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/assign-working-hours-schedule) SDK methods and will be removed on March 31, 2026.",
"description":
[ "<!--ONLY:VELO-->",
"The `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
{ "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder",
"doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." },
"locations":
[ { "lineno": 96,
[ { "lineno": 97,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Refines a query to match items whose specified property value equals the specified value.",
Expand Down Expand Up @@ -116,7 +116,7 @@
[ "wix-bookings-backend.Resources.ResourceCatalogQueryResult" ] },
"doc": "Fulfilled - A Promise that resolves to the results of the query.\nRejected - Error that caused the query to fail." },
"locations":
[ { "lineno": 243,
[ { "lineno": 244,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Returns the resource catalog items that match the query.",
Expand Down Expand Up @@ -211,7 +211,7 @@
{ "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder",
"doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." },
"locations":
[ { "lineno": 122,
[ { "lineno": 123,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Refines a query to match items whose specified property contains any of the specified `value` parameters.",
Expand Down Expand Up @@ -274,7 +274,7 @@
{ "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder",
"doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." },
"locations":
[ { "lineno": 204,
[ { "lineno": 205,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Limits the number of items the query returns.",
Expand Down Expand Up @@ -339,7 +339,7 @@
{ "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder",
"doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." },
"locations":
[ { "lineno": 224,
[ { "lineno": 225,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Sets the number of items to skip before returning query results.",
Expand Down Expand Up @@ -397,7 +397,7 @@
"messages":
[ { "name": "QueryOptions",
"locations":
[ { "lineno": 80,
[ { "lineno": 81,
"filename": "ResourceCatalogQueryBuilder.js" } ],
"docs":
{ "summary": "Options to use when performing a query.",
Expand Down