Skip to content

Commit

Permalink
Auto commit to autodocs-wix-bookings-v1 from WixDocs Server
Browse files Browse the repository at this point in the history
  • Loading branch information
wix-docs-feds committed Aug 29, 2023
1 parent 7bc4e5d commit 4c4a6d2
Showing 1 changed file with 23 additions and 90 deletions.
113 changes: 23 additions & 90 deletions wix-bookings-v1/wix-bookings-v1/Resources.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -149,65 +149,6 @@
],
"syntaxName": "deleteResource"
},
{
"name": "queryResources",
"params": [
{
"name": "options",
"type": [
{
"referenceType": "wix-bookings-v1.Resources.QueryResourcesOptions"
}
],
"doc": "",
"required": false
}
],
"requiredFields": [],
"ret": {
"type": [
{
"complexType": {
"nativeType": "Promise",
"typeParams": [
{
"referenceType": "wix-bookings-v1.Resources.QueryResourcesResponse"
}
]
}
}
],
"doc": null
},
"docs": {
"summary": "Creates a query to retrieve extended resource information.",
"description": [
"The `queryResources()` function builds a query to retrieve a catalog of resources, including resources' related schedules and slugs, and returns a [`ResourceQueryBuilder`](#) object. The returned object contains the query definition, which is typically used to run the query using the [`find()`](#) function.\n\nThe `ResourceQueryBuilder` functions enable you to run, filter, and control which results a query returns.\n\nTypically, you build a query using the `queryResources()` function, refine the query by chaining `ResourceQueryBuilder` functions, and then execute the query by chaining the `find()` function.\n\nThe query runs with the following defaults that you can override:\n- [`skip`](#): `0`\n- [`limit`](#): `50`\n\nThe following query builder functions are supported for `queryResources()`. For a full description of the `Resources` object, see the object returned for the [`items`](#) array in [`ResourceQueryResult`](#)."
],
"examples": [
{
"title": "queryResources example",
"body": [
"import { resources } from 'wix-bookings.v1';",
" ",
" async function queryResources(options) {",
" try {",
" const result = await resources.queryResources(options);",
"",
" return result;",
" } catch (error) {",
" console.error(error);",
" // Handle the error",
" }",
" }",
" "
]
}
]
},
"isVeloEvent": false,
"syntaxName": "queryResources"
},
{
"name": "updateResource",
"params": [
Expand All @@ -222,18 +163,19 @@
"required": true
},
{
"name": "options",
"name": "resource",
"type": [
{
"referenceType": "wix-bookings-v1.Resources.UpdateResourceOptions"
"referenceType": "wix-bookings-v1.Resources.UpdateResource"
}
],
"doc": "",
"required": false
"required": true
}
],
"requiredFields": [
"_id"
"_id",
"resource"
],
"ret": {
"type": [
Expand Down Expand Up @@ -261,9 +203,9 @@
"body": [
"import { resources } from 'wix-bookings.v1';",
" ",
" async function updateResource(id, options) {",
" async function updateResource(id, resource, options) {",
" try {",
" const result = await resources.updateResource(id, options);",
" const result = await resources.updateResource(id, resource, options);",
"",
" return result;",
" } catch (error) {",
Expand Down Expand Up @@ -292,6 +234,16 @@
"doc": "Resource id to update.",
"required": true
},
{
"name": "schedule",
"type": [
{
"referenceType": "wix-bookings-v1.Resources.Schedule"
}
],
"doc": "The schedule to update",
"required": true
},
{
"name": "options",
"type": [
Expand All @@ -304,8 +256,9 @@
}
],
"requiredFields": [
"options.schedule._id",
"resourceId"
"resourceId",
"schedule",
"schedule._id"
],
"ret": {
"type": [
Expand Down Expand Up @@ -333,9 +286,9 @@
"body": [
"import { resources } from 'wix-bookings.v1';",
" ",
" async function updateSchedule(resourceId, options) {",
" async function updateSchedule(resourceId, schedule, options) {",
" try {",
" const result = await resources.updateSchedule(resourceId, options);",
" const result = await resources.updateSchedule(resourceId, schedule, options);",
"",
" return result;",
" } catch (error) {",
Expand Down Expand Up @@ -3458,17 +3411,7 @@
},
{
"name": "UpdateResourceOptions",
"members": [
{
"name": "resource",
"type": [
{
"referenceType": "wix-bookings-v1.Resources.UpdateResource"
}
],
"doc": ""
}
],
"members": [],
"docs": {
"description": [
""
Expand Down Expand Up @@ -3561,16 +3504,6 @@
}
],
"doc": "Fieldmask for schedule"
},
{
"name": "schedule",
"optional": true,
"type": [
{
"referenceType": "wix-bookings-v1.Resources.Schedule"
}
],
"doc": "The schedule to update"
}
],
"docs": {
Expand Down

0 comments on commit 4c4a6d2

Please sign in to comment.