{"id":"151a27fa-e53a-47b9-9def-f54e6ec1b959","createdDate":"2024-09-03T07:31:08.006Z","updatedDate":"2024-09-03T07:31:08.006Z","resourceId":"1cc26461-adc8-4178-8f5e-eea11e077ded","sdk":{"schema":{"name":"velo_wix-bookings-backend","fqn":"","slug":"velo-wix-bookings-backend","typesMap":{"Bookings.CancelBookingOptions":{"name":"CancelBookingOptions","fqn":"Bookings.CancelBookingOptions","slug":"cancel-booking-options","actions":[],"properties":[{"name":"flowControlSettings","slug":"flow-control-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FlowControlSettingsInfo","referenceFqn":"Bookings.FlowControlSettingsInfo"},"description":"Sets the cancel booking flow behavior."},{"name":"participantNotification","slug":"participant-notification","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParticipantNotificationInfo","referenceFqn":"ParticipantNotificationInfo"},"description":"Whether to notify the participants about the booking confirmation, and an optional custom message."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Bookings.FlowControlSettingsInfo":{"name":"FlowControlSettingsInfo","fqn":"Bookings.FlowControlSettingsInfo","slug":"flow-control-settings-info","actions":[],"properties":[{"name":"ignoreCancellationPolicy","slug":"ignore-cancellation-policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to ignore the service's cancellation policy.\r\n \r\n\r\n Requires \"Manage Wix Bookings App\" and \"Manage Bookings' Calendar\" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)."}]},"ParticipantNotificationInfo":{"name":"ParticipantNotificationInfo","fqn":"ParticipantNotificationInfo","slug":"participant-notification-info","actions":[],"properties":[{"name":"message","slug":"message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom message to send to the participants."},{"name":"notifyParticipants","slug":"notify-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to notify participants about the change."}]},"Bookings.CancelBookingResult":{"name":"CancelBookingResult","fqn":"Bookings.CancelBookingResult","slug":"cancel-booking-result","actions":[],"properties":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the canceled booking."}]},"Bookings.ConfirmBookingOptions":{"name":"ConfirmBookingOptions","fqn":"Bookings.ConfirmBookingOptions","slug":"confirm-booking-options","actions":[],"properties":[{"name":"participantNotification","slug":"participant-notification","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParticipantNotificationInfo","referenceFqn":"ParticipantNotificationInfo"},"description":"Whether to notify the participants about the booking confirmation, and an optional custom message."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Bookings.DeclineBookingOptions":{"name":"DeclineBookingOptions","fqn":"Bookings.DeclineBookingOptions","slug":"decline-booking-options","actions":[],"properties":[{"name":"participantNotification","slug":"participant-notification","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParticipantNotificationInfo","referenceFqn":"ParticipantNotificationInfo"},"description":"Whether to notify the participants about the booking confirmation, and an optional custom message."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Bookings.DeclineBookingResult":{"name":"DeclineBookingResult","fqn":"Bookings.DeclineBookingResult","slug":"decline-booking-result","actions":[],"properties":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the declined booking."}]},"Bookings.BookingsQueryBuilder.BookingsQueryBuilder":{"name":"BookingsQueryBuilder","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","slug":"bookings-query-builder","actions":[{"name":"ascending","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `BookingsQueryBuilder` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"descending","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `BookingsQueryBuilder` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"eq","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `contactId`\r\n+ `sessionId`\r\n+ `status`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `BookingsQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.BookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the bookings that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n > **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can retrieve other customers' bookings. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"ge","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `BookingsQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`."},{"name":"gt","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `endTime`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `BookingsQueryBuilder` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`."},{"name":"hasSome","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `sessionId`\r\n+ `status`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `BookingsQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"le","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `endTime`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `BookingsQueryBuilder`to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`."},{"name":"limit","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend/bookings/bookings-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend/bookings/bookings-query-result/next)\r\n and [`prev()`](wix-bookings-backend/bookings/bookings-query-result/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `BookingsQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"skip","fqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"properties":[]},"Bookings.BookingsQueryBuilder.QueryOptions":{"name":"QueryOptions","fqn":"Bookings.BookingsQueryBuilder.QueryOptions","slug":"query-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents permission checks from running for the `find()` operation. Defaults to `false`."}]},"Bookings.BookingsQueryResult.BookingsQueryResult":{"name":"BookingsQueryResult","fqn":"Bookings.BookingsQueryResult.BookingsQueryResult","slug":"bookings-query-result","actions":[{"name":"hasNext","fqn":"Bookings.BookingsQueryResult.BookingsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Bookings.BookingsQueryResult.BookingsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates the query has previous results."},{"name":"next","fqn":"Bookings.BookingsQueryResult.BookingsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `BookingsQueryResult` may change."},{"name":"prev","fqn":"Bookings.BookingsQueryResult.BookingsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"}},"description":"Returns an array of bookings that match the query.\r\n\r\nThe current page of bookings retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `booking` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](#prev) and [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder"},"description":"Returns the BookingsQueryBuilder object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional BookingsQueryBuilder functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},"Booking":{"name":"Booking","fqn":"Booking","slug":"booking","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the booking was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Booking ID."},{"name":"attendanceInfo","slug":"attendance-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AttendanceInfo","referenceFqn":"AttendanceInfo"},"description":"Attendance information."},{"name":"bookedEntity","slug":"booked-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookedEntity","referenceFqn":"BookedEntity"},"description":"An object describing the entity that was booked."},{"name":"bookedResources","slug":"booked-resources","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BookedResource","referenceFqn":"BookedResource"}},"description":"List of booked resources. Currently, only one is supported. The booked resource would be the staff-member giving the session."},{"name":"bookingSource","slug":"booking-source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingSource","referenceFqn":"BookingSource"},"description":"An object describing the platform and application that made the booking."},{"name":"externalUserId","slug":"external-user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"External ID provided by the client app on creation."},{"name":"formInfo","slug":"form-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Form","referenceFqn":"Form"},"description":"Form information submitted when booking. FormInfo contains contact details, participants, and other form fields, set up for the service."},{"name":"paymentDetails","slug":"payment-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentDetails","referenceFqn":"PaymentDetails"},"description":"Payment Details."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Booking status.\r\n\r\n One of:\r\n - `\"PENDING_CHECKOUT\"` The booking is waiting to be checked out.\r\n - `\"CONFIRMED\"` The booking has beed approved by the owner.\r\n - `\"CANCELED\"` The booking has been canceled.\r\n - `\"PENDING\"` The booking has been created.\r\n - `\"PENDING_APPROVAL\"` The booking is waiting for the owner to approve or decline.\r\n - `\"DECLINED\"` The booking was declined by the owner."}]},"AttendanceInfo":{"name":"AttendanceInfo","fqn":"AttendanceInfo","slug":"attendance-info","actions":[],"properties":[{"name":"attendanceStatus","slug":"attendance-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the booked contact attended the session."},{"name":"numberOfAttendees","slug":"number-of-attendees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of attendees that attended the session. This can be greater than 1 when the booking is made for a group of people."}]},"BookedEntity":{"name":"BookedEntity","fqn":"BookedEntity","slug":"booked-entity","actions":[],"oneofProperties":{"bookedEntityType":[{"name":"setOfSessions","slug":"set-of-sessions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SetOfSessions","referenceFqn":"SetOfSessions"},"description":"First start and last end time of the booked sessions."},{"name":"singleSession","slug":"single-session","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SingleSession","referenceFqn":"SingleSession"},"description":"Start and end time of the booked sessions."}]},"properties":[{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Location","referenceFqn":"Location"},"description":"Location of the session."},{"name":"onlineConference","slug":"online-conference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineConference","referenceFqn":"OnlineConference"},"description":"Online conference information."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Rate","referenceFqn":"Rate"},"description":"Price options offered to book this session at the time of booking."},{"name":"scheduleId","slug":"schedule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booked schedule."},{"name":"serviceId","slug":"service-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booked service."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of tags for the booking."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session title at the time of booking."}]},"Location":{"name":"Location","fqn":"Location","slug":"location","actions":[],"properties":[{"name":"businessLocation","slug":"business-location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BusinessLocation","referenceFqn":"BusinessLocation"},"description":"An object describing the business location.\r\nValid when `locationType` is `\"OWNER_BUSINESS\"`. Defaults to the business's default location."},{"name":"customAddress","slug":"custom-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"Address"},"description":"Custom [address](https://www.wix.com/velo/reference/$w/addressinput/value), used when location_type is `\"OWNER_CUSTOM\"`."},{"name":"locationType","slug":"location-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location type.\r\n\r\n One of:\r\n - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\r\n - `\"OWNER_CUSTOM\"` The address as set when creating the service.\r\n - `\"CUSTOM\"` The address set for the individual session."}]},"BusinessLocation":{"name":"BusinessLocation","fqn":"BusinessLocation","slug":"business-location","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the location."},{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"Address"},"description":"Address."},{"name":"archived","slug":"archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the location is archived.\r\nArchived locations can't be updated."},{"name":"default","slug":"default","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this is the default location.\r\nThere can only be one default location per site. Changes to the default location are made on the **Site Properties** page of the dashboard.\r\nThe default location can't be deleted."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text describing the location."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address."},{"name":"fax","slug":"fax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fax number."},{"name":"locationType","slug":"location-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of the location.\r\nOne of:\r\n + `\"UNKNOWN\"`\r\n + `\"BRANCH\"`\r\n + `\"OFFICES\"`\r\n + `\"RECEPTION\"`\r\n + `\"HEADQUARTERS\"`"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name of the location."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location revision, represents the number of changes to the location."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Status of the location. Default is `\"ACTIVE\"`.\r\nOne of:\r\n + `\"ACTIVE\"`\r\n + `\"IN_ACTIVE\"`"},{"name":"timeZone","slug":"time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Time zone."}]},"Address":{"name":"Address","fqn":"Address","slug":"address","actions":[],"oneofProperties":{"addressStreet":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number, as free text."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"StreetAddress"},"description":"Street name, number and apartment number."}]},"properties":[{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains Apt, Suite, and Floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Country code."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String containing the full address of this location."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocation","referenceFqn":"AddressLocation"},"description":"Coordinates of the physical address."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Zip/postal code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)."}]},"AddressLocation":{"name":"AddressLocation","fqn":"AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"StreetAddress":{"name":"StreetAddress","fqn":"StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"apt","slug":"apt","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Apartment number."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"OnlineConference":{"name":"OnlineConference","fqn":"OnlineConference","slug":"online-conference","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Online conference description."},{"name":"guestUrl","slug":"guest-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Participant url."},{"name":"password","slug":"password","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Online conference password."},{"name":"providerId","slug":"provider-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Online conference provider identifier."}]},"Rate":{"name":"Rate","fqn":"Rate","slug":"rate","actions":[],"properties":[{"name":"labeledPriceOptions","slug":"labeled-price-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Set of key-value pairs.Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount."},{"name":"priceText","slug":"price-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page."}]},"SetOfSessions":{"name":"SetOfSessions","fqn":"SetOfSessions","slug":"set-of-sessions","actions":[],"properties":[{"name":"firstSessionStart","slug":"first-session-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start time of the first session."},{"name":"lastSessionEnd","slug":"last-session-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End time of the last session."}]},"SingleSession":{"name":"SingleSession","fqn":"SingleSession","slug":"single-session","actions":[],"properties":[{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End time of the session."},{"name":"sessionId","slug":"session-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start time of the session."}]},"BookedResource":{"name":"BookedResource","fqn":"BookedResource","slug":"booked-resource","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Booked resource ID."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource's email at the time of booking."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource's name at the time of booking."}]},"BookingSource":{"name":"BookingSource","fqn":"BookingSource","slug":"booking-source","actions":[],"properties":[{"name":"actor","slug":"actor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Actor that created this booking.\r\n\r\nOne of:\r\n - `\"BUSINESS\"`\r\n - `\"CUSTOMER\"`"},{"name":"appDefId","slug":"app-def-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix site ID of the application that created this booking."},{"name":"appName","slug":"app-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the application that created this booking, as saved in Wix-dev-center at the time of booking."},{"name":"platform","slug":"platform","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Platform from which a booking was created\r\n\r\n One of:\r\n - `\"WEB\"` Desktop browser.\r\n - `\"MOBILE_APP\"` Mobile application."}]},"Form":{"name":"Form","fqn":"Form","slug":"form","actions":[],"properties":[{"name":"additionalFields","slug":"additional-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomFormField","referenceFqn":"CustomFormField"}},"description":"Additional custom fields submitted with the form."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactDetails","referenceFqn":"ContactDetails"},"description":"Contact details of the customer making the booking."},{"name":"paymentSelection","slug":"payment-selection","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PaymentSelection","referenceFqn":"PaymentSelection"}},"description":"List of rates and the number of participants for each rate."}]},"CustomFormField":{"name":"CustomFormField","fqn":"CustomFormField","slug":"custom-form-field","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the form field as defined in the form."},{"name":"label","slug":"label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Form field's label at the time of submission."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value that was submitted for this field."},{"name":"valueType","slug":"value-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"One of:\r\n - `\"SHORT_TEXT\"`\r\n - `\"LONG_TEXT\"`\r\n - `\"CHECK_BOX\"`"}]},"ContactDetails":{"name":"ContactDetails","fqn":"ContactDetails","slug":"contact-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"Address"},"description":"Custom [address](https://www.wix.com/velo/reference/$w/addressinput/value), used when location_type is `\"OWNER_CUSTOM\"`."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's ID."},{"name":"countryCode","slug":"country-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's email, used to create a new contact or get existing one from the [CRM API](wix-crm-frontend/introduction)."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's phone number."},{"name":"timeZone","slug":"time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's time zone."}]},"PaymentSelection":{"name":"PaymentSelection","fqn":"PaymentSelection","slug":"payment-selection","actions":[],"properties":[{"name":"numberOfParticipants","slug":"number-of-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of participants for this rate."},{"name":"rateLabel","slug":"rate-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label corresponding to the booking rate. Default is free/custom."}]},"PaymentDetails":{"name":"PaymentDetails","fqn":"PaymentDetails","slug":"payment-details","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout ID."},{"name":"balance","slug":"balance","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Balance","referenceFqn":"Balance"},"description":"Final price, currency, down payment, and amount received."},{"name":"couponDetails","slug":"coupon-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CouponDetails","referenceFqn":"CouponDetails"},"description":"Coupon details, if a coupon was used to pay for the booking."},{"name":"pricingPlanDetails","slug":"pricing-plan-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaidPlanDetails","referenceFqn":"PaidPlanDetails"},"description":"Pricing plan details, if a pricing plan was used to pay for the booking."},{"name":"state","slug":"state","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout current state.\r\n\r\n One of:\r\n - `\"COMPLETE\"` Amount paid in full.\r\n - `\"PENDING_CASHIER\"` An online payment is in progress and awaiting a response.\r\n - `\"REJECTED\"` The checkout request was rejected by the online payment process. \r\n - `\"READY\"` All online checkout requirements were met. For example, when the service uses pay in person, or a partial or down payment was paid online.\r\n - `\"CANCELED\"` Checkout canceled.\r\n - `\"REFUNDED\"` When using Pricing Plans, if the booking was canceled, it will be automatically refunded.\r\n - `\"PENDING_MERCHANT\"` An online payment was made, but the owner has not set up the necessary details.\r\n - `\"WIX_PAY_FAILURE\"` Online payment failure.\r\n - `\"PENDING_MARK_AS_PAID\"` Offline transaction. The transaction will be complete when explicitly marked as paid.\r\n - `\"PENDING_BUYER\"` The transaction started, but is waiting for confirmation on the buyer's side. This can be due to credit or fraud checking on the provider's side, a long bank transfer, or similar processes."},{"name":"wixPayMultipleDetails","slug":"wix-pay-multiple-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"WixPayDetails","referenceFqn":"WixPayDetails"}},"description":"In case of wix-pay service, holds all payment history for a booking."}]},"Balance":{"name":"Balance","fqn":"Balance","slug":"balance","actions":[],"properties":[{"name":"amountReceived","slug":"amount-received","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Current total amount paid."},{"name":"finalPrice","slug":"final-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"Price"},"description":"Required payment amount, currency, and any down payment required."}]},"Price":{"name":"Price","fqn":"Price","slug":"price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Required payment amount."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency in which the amount is quoted."},{"name":"downPayAmount","slug":"down-pay-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount of a down payment or deposit as part of the transaction."}]},"CouponDetails":{"name":"CouponDetails","fqn":"CouponDetails","slug":"coupon-details","actions":[],"properties":[{"name":"couponCode","slug":"coupon-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"couponDiscount","slug":"coupon-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon discount amount."},{"name":"couponId","slug":"coupon-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"couponName","slug":"coupon-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"PaidPlanDetails":{"name":"PaidPlanDetails","fqn":"PaidPlanDetails","slug":"paid-plan-details","actions":[],"properties":[{"name":"plan","slug":"plan","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaidPlan","referenceFqn":"PaidPlan"},"description":"Plan details."},{"name":"planName","slug":"plan-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Plan name."},{"name":"transactionId","slug":"transaction-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Transaction ID created in the Pricing Plans service when the member redeemed a benefit to pay for this booking."}]},"PaidPlan":{"name":"PaidPlan","fqn":"PaidPlan","slug":"paid-plan","actions":[],"properties":[{"name":"benefitId","slug":"benefit-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Benefit ID."},{"name":"orderId","slug":"order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order ID when the Pricing Plan was purchased."},{"name":"planId","slug":"plan-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the pricing plan."}]},"WixPayDetails":{"name":"WixPayDetails","fqn":"WixPayDetails","slug":"wix-pay-details","actions":[],"properties":[{"name":"orderAmount","slug":"order-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order amount sent to the Wix Pay system."},{"name":"orderApprovalTime","slug":"order-approval-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time that the order was approved."},{"name":"orderId","slug":"order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix Pay payment order ID."},{"name":"orderStatus","slug":"order-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Transaction status\r\n\r\n One of:\r\n - `\"CREATED\"` The transaction has been started.\r\n - `\"PENDING_MERCHANT\"` An online payment was made, but the owner has not set up the necessary details.\r\n - `\"COMPLETE\"` The current part of the payment was completed.\r\n - `\"FAILED\"` The Wix online payment system is unavailable or failed processing.\r\n - `\"DECLINED\"` The payment was declined.\r\n - `\"PENDING_MARK_AS_PAID\"` Offline transaction. The transaction will be complete when explicitly marked as paid.\r\n - `\"CANCELED\"` The transaction was canceled."},{"name":"paymentVendorName","slug":"payment-vendor-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment vendor name. The company processing the payment, such as Pay Pal or a credit card company. `inPerson` is used for cash payments."},{"name":"txId","slug":"tx-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix Pay payment transaction ID."}]},"Bookings.AttendanceInfo":{"name":"AttendanceInfo","fqn":"Bookings.AttendanceInfo","slug":"attendance-info","actions":[],"properties":[{"name":"attended","slug":"attended","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the booked contact attended the session."},{"name":"numberOfAttendees","slug":"number-of-attendees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of attendees that attended the session. This can be greater than 1 when the booking is made for a group of people."}]},"Options":{"name":"Options","fqn":"Options","slug":"options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Bookings.FormInfo":{"name":"FormInfo","fqn":"Bookings.FormInfo","slug":"form-info","actions":[],"properties":[{"name":"additionalFields","slug":"additional-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomFormFieldInfo","referenceFqn":"CustomFormFieldInfo"}},"description":"Additional custom fields submitted with the form."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactDetails","referenceFqn":"Bookings.ContactDetails"},"description":"Contact details of the customer making the booking."},{"name":"paymentSelection","slug":"payment-selection","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PaymentSelectionInfo","referenceFqn":"PaymentSelectionInfo"}},"description":"List of rates and the number of participants for each rate."}]},"CustomFormFieldInfo":{"name":"CustomFormFieldInfo","fqn":"CustomFormFieldInfo","slug":"custom-form-field-info","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the form field as defined in the form."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value that was submitted for this field."},{"name":"valueType","slug":"value-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"One of:\r\n - `\"SHORT_TEXT\"`\r\n - `\"LONG_TEXT\"`\r\n - `\"CHECK_BOX\"`"}]},"Bookings.ContactDetails":{"name":"ContactDetails","fqn":"Bookings.ContactDetails","slug":"contact-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OwnerAddress","referenceFqn":"Bookings.OwnerAddress"},"description":"Contact's full [address](https://www.wix.com/velo/reference/$w/addressinput/value)."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's ID."},{"name":"countryCode","slug":"country-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's email, used to create a new contact or get existing one from the [CRM API](wix-crm-frontend/introduction)."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's phone number."},{"name":"timeZone","slug":"time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's time zone."}]},"Bookings.OwnerAddress":{"name":"OwnerAddress","fqn":"Bookings.OwnerAddress","slug":"owner-address","actions":[],"oneofProperties":{"ownerAddressStreet":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number, as free text."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddressInfo","referenceFqn":"StreetAddressInfo"},"description":"Street name, number and apartment number."}]},"properties":[{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains Apt, Suite, and Floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Country code."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String containing the full address of this location."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocationInfo","referenceFqn":"AddressLocationInfo"},"description":"Coordinates of the physical address."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Zip/postal code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)."}]},"AddressLocationInfo":{"name":"AddressLocationInfo","fqn":"AddressLocationInfo","slug":"address-location-info","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"StreetAddressInfo":{"name":"StreetAddressInfo","fqn":"StreetAddressInfo","slug":"street-address-info","actions":[],"properties":[{"name":"apt","slug":"apt","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Apartment number."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"PaymentSelectionInfo":{"name":"PaymentSelectionInfo","fqn":"PaymentSelectionInfo","slug":"payment-selection-info","actions":[],"properties":[{"name":"numberOfParticipants","slug":"number-of-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of participants for this rate."},{"name":"rateLabel","slug":"rate-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label corresponding to the booking rate. Default is free/custom."}]},"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder":{"name":"WixBookingsQueryBuilder","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","slug":"wix-bookings-query-builder","actions":[{"name":"ascending","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixBookingsQueryBuilder` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"count","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfilled - The number of items that match the query.\r\nRejected - The errors that caused the rejection."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.WixBookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query or query count."}],"description":"Returns the number of items that match the query.\r\n\r\nThe `count()` function returns a Promise that resolves to the number of\r\n items that match the query. The Promise is rejected if `count()` is called\r\n with incorrect permissions or if any of the functions used to refine the\r\n query are invalid.\r\n\r\n Use the `options` parameter to run `count()` without checking for permissions.\r\n\r\n Any function that does not filter query results (for example, [`ascending()`](#ascending))\r\n does not affect the result of `count()`.\r\n\r\n If you have already run a query with [`find()`](#find), you can retrieve\r\n the number of query results without calling `count()`. The [`find()`](#find)\r\n function returns a Promise that resolves to a [`WixBookingsQueryResult`](wix-bookings-backend.WixBookingsQueryResult)\r\n object, which has a `totalCount` property whose value is the number of results."},{"name":"descending","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixBookingsQueryBuilder` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"eq","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixBookingsQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `eq()` includes items\r\n in which any of the elements of the Array match the specified `value`."},{"name":"find","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.WixBookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query or query count."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n Use the `options` parameter to run `find()` without checking for permissions."},{"name":"ge","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixBookingsQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n\r\nß"},{"name":"gt","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixBookingsQueryBuilder` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`."},{"name":"hasSome","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixBookingsQueryBuilder` to\r\n only match items where any of the values of the array of the specified property equal any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"le","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixBookingsQueryBuilder`to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`."},{"name":"limit","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend.WixBookingsQueryResult.html#pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.WixBookingsQueryResult.html#next)\r\n and [`prev()`](wix-bookings-backend.WixBookingsQueryResult.html#prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixBookingsQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"skip","fqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"properties":[]},"Bookings.WixBookingsQueryBuilder.QueryOptions":{"name":"QueryOptions","fqn":"Bookings.WixBookingsQueryBuilder.QueryOptions","slug":"query-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation."}]},"Bookings.WixBookingsQueryResult.WixBookingsQueryResult":{"name":"WixBookingsQueryResult","fqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult","slug":"wix-bookings-query-result","actions":[{"name":"hasNext","fqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates the query has previous results."},{"name":"next","fqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataQueryResult` may change."},{"name":"prev","fqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder"},"description":"Returns the query used to get the current results."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},"Events.BookingEvent":{"name":"BookingEvent","fqn":"Events.BookingEvent","slug":"booking-event","actions":[],"properties":[{"name":"booking","slug":"booking","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"},"description":"Booking object after the event was triggered."},{"name":"previousBooking","slug":"previous-booking","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"},"description":"Booking object before the event was triggered."},{"name":"trigger","slug":"trigger","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Action that triggered the event. Each event has its own set of possible trigger values."}]},"Resources.ResourceInfo":{"name":"ResourceInfo","fqn":"Resources.ResourceInfo","slug":"resource-info","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource description."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource email address."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource phone number."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'."}]},"Resources.ResourceScheduleInfo":{"name":"ResourceScheduleInfo","fqn":"Resources.ResourceScheduleInfo","slug":"resource-schedule-info","actions":[],"properties":[{"name":"availability","slug":"availability","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ResourceScheduleAvailability","referenceFqn":"Resources.ResourceScheduleAvailability"},"description":"An object describing how to calculate the schedule's availability.\r\nAn empty object indicates that the schedule is not available for booking."}]},"Resources.ResourceScheduleAvailability":{"name":"ResourceScheduleAvailability","fqn":"Resources.ResourceScheduleAvailability","slug":"resource-schedule-availability","actions":[],"properties":[{"name":"linkedSchedules","slug":"linked-schedules","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LinkedResourceScheduleInfo","referenceFqn":"LinkedResourceScheduleInfo"}},"description":"Other schedules that impact the availability calculation. Relevant only when there are availability constraints."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the schedule starts to be available for booking."}]},"LinkedResourceScheduleInfo":{"name":"LinkedResourceScheduleInfo","fqn":"LinkedResourceScheduleInfo","slug":"linked-resource-schedule-info","actions":[],"properties":[{"name":"scheduleId","slug":"schedule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Schedule ID."}]},"Resource":{"name":"Resource","fqn":"Resource","slug":"resource","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource ID."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource description."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource email address."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource phone number."},{"name":"scheduleIds","slug":"schedule-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of schedules owned by this resource."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource status.\r\n\r\n One of:\r\n - `\"CREATED\"` Default status.\r\n - `\"DELETED\"` The resource was deleted.\r\n - `\"UPDATED\"` The resource was updated."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'."}]},"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder":{"name":"ResourceCatalogQueryBuilder","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","slug":"resource-catalog-query-builder","actions":[{"name":"eq","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `slugs.name`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `ResourceCatalogQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Resources.ResourceCatalogQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the resource catalog items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n Use the `options` parameter to run `find()` without checking for permissions."},{"name":"hasSome","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `slugs.name`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `ResourceCatalogQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"limit","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next)\r\n and [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"skip","fqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"properties":[]},"Resources.ResourceCatalogQueryBuilder.QueryOptions":{"name":"QueryOptions","fqn":"Resources.ResourceCatalogQueryBuilder.QueryOptions","slug":"query-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult":{"name":"ResourceCatalogQueryResult","fqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult","slug":"resource-catalog-query-result","actions":[{"name":"hasNext","fqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates the query has previous results."},{"name":"next","fqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `ResourceCatalogQueryResult` may change."},{"name":"prev","fqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ResourceQueryResults","referenceFqn":"Resources.ResourceQueryResults"}},"description":"Returns an array of resources, slugs, and schedules that match the query.\r\n\r\nThe current page of resources, slugs, and schedules retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n When no items match the query, the array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder"},"description":"Returns the ResourceCatalogQueryBuilder object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional `ResourceCatalogQueryBuilder` functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."}]},"Resources.ResourceQueryResults":{"name":"ResourceQueryResults","fqn":"Resources.ResourceQueryResults","slug":"resource-query-results","actions":[],"properties":[{"name":"resource","slug":"resource","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Resource","referenceFqn":"Resource"},"description":"Resource."},{"name":"schedules","slug":"schedules","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ResourceSchedule","referenceFqn":"Resources.ResourceSchedule"}},"description":"Resource's schedules."},{"name":"slugs","slug":"slugs","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Slug","referenceFqn":"Resources.Slug"}},"description":"History of slugified resource names."}]},"Resources.ResourceSchedule":{"name":"ResourceSchedule","fqn":"Resources.ResourceSchedule","slug":"resource-schedule","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Schedule ID."},{"name":"availability","slug":"availability","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ResourceScheduleAvailability","referenceFqn":"Resources.ResourceScheduleAvailability"},"description":"An object describing how to calculate the schedule's availability.\r\nAn empty object indicates that the schedule is not available for booking."},{"name":"scheduleOwnerId","slug":"schedule-owner-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the schedule's owner entity. This may be a resource ID or a service ID."}]},"Resources.Slug":{"name":"Slug","fqn":"Resources.Slug","slug":"slug","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the resource name was created."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Slugified resource name."}]},"Resources.UpdateResourceInfo":{"name":"UpdateResourceInfo","fqn":"Resources.UpdateResourceInfo","slug":"update-resource-info","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource description."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource email address."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource phone number."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'."}]},"Sessions.SessionInfo":{"name":"SessionInfo","fqn":"Sessions.SessionInfo","slug":"session-info","actions":[],"properties":[{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTimeInfo","referenceFqn":"CalendarDateTimeInfo"},"description":"An object specifying the end date and time of the session. If the session is a recurring session, `end` must contain a `localDateTime`."},{"name":"notes","slug":"notes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional information about the session.\r\nNotes are not supported for recurring sessions."},{"name":"recurrence","slug":"recurrence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\r\nIf the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\r\nThe RRULE defines a rule for repeating a session.\r\nSupported parameters are:\r\n\r\n|Keyword|Description|Supported values|\r\n|--|--|---|\r\n|`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\r\n|`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\r\n|`UNTIL`|The UTC end date and time of the recurrence. Optional.|\r\n|`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\r\n\r\n\r\n For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\r\n`\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`"},{"name":"scheduleId","slug":"schedule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the schedule that the session belongs to."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTimeInfo","referenceFqn":"CalendarDateTimeInfo"},"description":"An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags for the session.\r\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session type.\r\n\r\n One of:\r\n - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\r\n - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule."}]},"CalendarDateTimeInfo":{"name":"CalendarDateTimeInfo","fqn":"CalendarDateTimeInfo","slug":"calendar-date-time-info","actions":[],"properties":[{"name":"localDateTime","slug":"local-date-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDateTimeInfo","referenceFqn":"LocalDateTimeInfo"},"description":"An object containing the local date and time for the business's timezone."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a timezone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\r\nRequired if `localDateTime` is not specified.\r\nIf `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's timezone."}]},"LocalDateTimeInfo":{"name":"LocalDateTimeInfo","fqn":"LocalDateTimeInfo","slug":"local-date-time-info","actions":[],"properties":[{"name":"dayOfMonth","slug":"day-of-month","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Day of the month, from 1-31."},{"name":"hourOfDay","slug":"hour-of-day","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Hour of the day in 24-hour format, from 0-23."},{"name":"minutesOfHour","slug":"minutes-of-hour","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minute, from 0-59."},{"name":"monthOfYear","slug":"month-of-year","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Month number, from 1-12."},{"name":"year","slug":"year","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Year. 4-digit format."}]},"Sessions.Session":{"name":"Session","fqn":"Sessions.Session","slug":"session","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session ID."},{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTime","referenceFqn":"CalendarDateTime"},"description":"An object specifying the end date and time of the session. If the session is a recurring session, `end` must contain a `localDateTime`."},{"name":"instanceOfRecurrence","slug":"instance-of-recurrence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\r\nEmpty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty."},{"name":"notes","slug":"notes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional information about the session.\r\nNotes are not supported for recurring sessions."},{"name":"recurrence","slug":"recurrence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\r\nIf the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\r\nThe RRULE defines a rule for repeating a session.\r\nSupported parameters are:\r\n\r\n|Keyword|Description|Supported values|\r\n|--|--|---|\r\n|`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\r\n|`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\r\n|`UNTIL`|The UTC end date and time of the recurrence. Optional.|\r\n|`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\r\n\r\n\r\n For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\r\n`\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`"},{"name":"recurringSessionId","slug":"recurring-session-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances."},{"name":"scheduleId","slug":"schedule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the schedule that the session belongs to."},{"name":"scheduleOwnerId","slug":"schedule-owner-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the resource or service that the session's schedule belongs to."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTime","referenceFqn":"CalendarDateTime"},"description":"An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session status.\r\n\r\n One of:\r\n - `\"CONFIRMED\"` Default value.\r\n - `\"CANCELLED\"` The session was deleted."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags for the session.\r\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session type.\r\n\r\n One of:\r\n - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\r\n - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule."}]},"CalendarDateTime":{"name":"CalendarDateTime","fqn":"CalendarDateTime","slug":"calendar-date-time","actions":[],"properties":[{"name":"localDateTime","slug":"local-date-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDateTime","referenceFqn":"LocalDateTime"},"description":"An object containing the local date and time for the business's timezone."},{"name":"timestamp","slug":"timestamp","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a timezone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\r\nRequired if `localDateTime` is not specified.\r\nIf `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's timezone."}]},"LocalDateTime":{"name":"LocalDateTime","fqn":"LocalDateTime","slug":"local-date-time","actions":[],"properties":[{"name":"dayOfMonth","slug":"day-of-month","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Day of the month, from 1-31."},{"name":"hourOfDay","slug":"hour-of-day","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Hour of the day in 24-hour format, from 0-23."},{"name":"minutesOfHour","slug":"minutes-of-hour","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minute, from 0-59."},{"name":"monthOfYear","slug":"month-of-year","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Month number, from 1-12."},{"name":"year","slug":"year","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Year. 4-digit format."}]},"Sessions.DeleteSessionOptions":{"name":"DeleteSessionOptions","fqn":"Sessions.DeleteSessionOptions","slug":"delete-session-options","actions":[],"properties":[{"name":"participantNotification","slug":"participant-notification","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParticipantNotificationInfo","referenceFqn":"ParticipantNotificationInfo"},"description":"Whether to notify participants about the change, and an optional custom message."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Sessions.SessionQueryBuilder.SessionQueryBuilder":{"name":"SessionQueryBuilder","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","slug":"session-query-builder","actions":[{"name":"eq","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `type`\r\n+ `tags`\r\n+ `scheduleId`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Sessions.SessionQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the bookings that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n > **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can view participant information in a session query. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"ge","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `start.timestamp`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`."},{"name":"hasSome","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `sessionId`\r\n+ `type`\r\n+ `tags`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `SessionQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"limit","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend/sessions/session-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend/sessions/session-query-result/next)\r\n and [`prev()`](wix-bookings-backend/sessions/session-query-result/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `end.timestamp`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `SessionQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`."},{"name":"ne","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refine query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\nSupported properties:\r\n+ `recurrence`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n The `ne()` function only supports the `recurrence` property for `null` values. \r\n Use `.ne(\"recurrence\",null)` to query recurring sessions together with `.eq(\"sessionId\", \"\")`."},{"name":"skip","fqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"properties":[]},"Sessions.SessionQueryBuilder.QueryOptions":{"name":"QueryOptions","fqn":"Sessions.SessionQueryBuilder.QueryOptions","slug":"query-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the `find()` operation. Defaults to `false`."}]},"Sessions.SessionQueryResult.SessionQueryResult":{"name":"SessionQueryResult","fqn":"Sessions.SessionQueryResult.SessionQueryResult","slug":"session-query-result","actions":[{"name":"hasNext","fqn":"Sessions.SessionQueryResult.SessionQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Sessions.SessionQueryResult.SessionQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates the query has previous results."},{"name":"next","fqn":"Sessions.SessionQueryResult.SessionQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `BookingsQueryResult` may change."},{"name":"prev","fqn":"Sessions.SessionQueryResult.SessionQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#page-size) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Session","referenceFqn":"Sessions.Session"}},"description":"Returns an array of sessions that match the query.\r\n\r\nThe current page of sessions retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](#prev) and [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder"},"description":"Returns the `SessionQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional `SessionQueryBuilder` functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},"Sessions.UpdateSessionInfo":{"name":"UpdateSessionInfo","fqn":"Sessions.UpdateSessionInfo","slug":"update-session-info","actions":[],"properties":[{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTimeInfo","referenceFqn":"CalendarDateTimeInfo"},"description":"An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`."},{"name":"notes","slug":"notes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional information about the session.\r\nNotes are not supported for recurring sessions."},{"name":"recurrence","slug":"recurrence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\r\nIf the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\r\nThe RRULE defines a rule for repeating a session.\r\nSupported parameters are:\r\n\r\n|Keyword|Description|Supported values|\r\n|--|--|---|\r\n|`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\r\n|`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\r\n|`UNTIL`|The UTC end date and time of the recurrence. Optional.|\r\n|`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\r\n\r\n\r\n For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\r\n`\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`"},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalendarDateTimeInfo","referenceFqn":"CalendarDateTimeInfo"},"description":"An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags for the session.\r\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session type.\r\n\r\n One of:\r\n - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\r\n - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule."}]}},"standaloneTypes":[],"metadata":{},"actions":[],"webhooks":[],"articles":[{"content":"# Introduction\nThe wix-bookings-backend API allows you to manage bookings and calendar functionality on your site.\n\nTo enable bookings backend API functionality for your site, add the [Wix Bookings](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#adding-wix-bookings-to-your-site) application to your site.\nYou must upgrade your site to a [Premium Plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683) in order to accept bookings and receive online payments. To accept payments, see [About Accepting Payments](https://support.wix.com/en/article/accepting-payments-on-your-wix-site-7014346).\n\n\nThe following objects are maintained by the wix-bookings-backend API: \n\n|Object|Description|Relationships\n|--|--|---|\n|[`Bookings`](wix-bookings-backend/bookings/introduction)| An order placed by a customer for a service or series of services.|Books a service's schedule. Has sessions.\n|[`Resources`](wix-bookings-backend/resources/introduction)| A business asset like a staff member, a room, or equipment needed to provide a service.|Owns a schedule.\n|[`Schedule`](wix-bookings-backend/sessions/introduction#api-reference_wix-bookings-backend_sessions_schedules)| A collection of sessions and the information needed to calculate availability.|Owned by a resource or service. Has sessions.\n|[`Sessions`](wix-bookings-backend/sessions/introduction) | A reserved period of time for an appointment, class, or course, or a period of availability for a resource. |Belongs to a resource or service via a schedule.\n\nFor each object, the wix-bookings-backend API provides the following functionality:\n+ [Bookings](wix-bookings-backend/bookings/introduction)\n + List and [query](wix-bookings-backend/bookings/query-bookings) booking information.\n + [Confirm](wix-bookings-backend/bookings/confirm-booking) pending booking requests.\n + [Decline](wix-bookings-backend/bookings/decline-booking) pending booking requests.\n + [Cancel](wix-bookings-backend/bookings/cancel-booking) bookings.\n + [Set attendance](wix-bookings-backend/bookings/set-attendance) for booked sessions.\n + [Mark](wix-bookings-backend/bookings/set-booking-as-paid) a bookings as paid.\n + Update the customer's [booking information](wix-bookings-backend/bookings/update-customer-info).\n+ [Resources](wix-bookings-backend/resources/introduction)\n + [Create](wix-bookings-backend/resources/create-resource) resources and schedules.\n + [Update](wix-bookings-backend/resources/update-resource) resource details.\n + [Update ](wix-bookings-backend/resources/update-resource-schedule) resource schedule information.\n + [Delete](wix-bookings-backend/resources/delete-resource) resources.\n + [Query](wix-bookings-backend/resources/query-resource-catalog) the resource catalog.\n+ [Sessions](wix-bookings-backend/sessions/introduction)\n + [Create](wix-bookings-backend/sessions/create-session) sessions for a resource.\n + [Get](wix-bookings-backend/sessions/get-session) session information.\n + [Update](wix-bookings-backend/sessions/update-session) session details.\n + [Delete](wix-bookings-backend/sessions/delete-session) sessions.\n + [Query](wix-bookings-backend/sessions/query-sessions) session information.\n\n>**Note:** You cannot book a service in preview mode, or when logged in as the site owner. To make a booking, publish your site, then either log out of your Wix account, or open the published site in an incognito browser window.","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"Bookings","slug":"bookings","fqn":"Bookings","standaloneTypes":[],"metadata":{},"actions":[{"name":"cancelBooking","fqn":"Bookings.cancelBooking","slug":"cancel-booking","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CancelBookingResult","referenceFqn":"Bookings.CancelBookingResult"}},"examples":[{"title":"Cancel a booking.","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { bookings } from \"wix-bookings-backend\";\n\nexport const cancelBooking = webMethod(Permissions.Anyone, async () => {\n const bookingId = \"001c0674-d7c9-4c77-acb5-b492b427b201\";\n const cancelBookingOptions = {\n participantNotification: {\n notifyParticipants: true,\n message: \"Custom cancel booking message\",\n },\n flowControlSettings: {\n ignoreCancellationPolicy: false,\n },\n suppressAuth: true,\n };\n\n try {\n const id = await bookings.cancelBooking(bookingId, cancelBookingOptions);\n return id;\n } catch (error) {\n return error;\n }\n});\n\n/* Returns a promise that resolves to:\n * {\n * \"bookingId\": \"001c0674-d7c9-4c77-acb5-b492b427b201\"\n * }\n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booking to be canceled."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CancelBookingOptions","referenceFqn":"Bookings.CancelBookingOptions"},"description":"An object representing the available options for canceling a booking."}],"description":"Cancels an existing booking.\r\n\r\nThe `cancelBooking()` function returns a Promise that resolves when the specified booking is canceled.\r\n\r\nCanceling a booking causes the following changes:\r\n- The booking status changes to `CANCELED`.\r\n- The participant is removed from the session.\r\n- If the booking creates a session, the session that was created is deleted from the calendar.\r\n- The participant is notified, according to the `participantNotification` properties.\r\n\r\nWhen `cancelBooking()` is invoked, the cancellation is validated against the service's bookings policy.\r\nIf `cancelBooking()` is invoked by a Bookings Admin, the service's bookings policy can be ignored by setting `ignoreCancellationPolicy` to `true`.\r\n\r\n> **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can cancel other customers' bookings. You can override the permissions by setting the `suppressAuth` option to `true`."},{"name":"confirmBooking","fqn":"Bookings.confirmBooking","slug":"confirm-booking","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the confirmed booking."},"examples":[{"title":"Confirm a booking request","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { bookings } from \"wix-bookings-backend\";\n\nexport const confirmBooking = webMethod(Permissions.Anyone, () => {\n const bookingId = \"001c0674-d7c9-4c77-acb5-b492b427b201\";\n const confirmBookingOptions = {\n participantNotification: {\n notifyParticipants: true,\n message: \"We are pleased to let you know that your booking has been confirmed\"\n },\n suppressAuth: true \n };\n\n return bookings\n .confirmBooking(bookingId, confirmBookingOptions)\n .then((result) => {\n return result;\n })\n .catch((error) => {\n return error;\n });\n});\n\n/* Returns a promise that resolves to:\n *\n * {\n * \"bookingId\": \"001c0674-d7c9-4c77-acb5-b492b427b201\"\n * }\n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booking to be confirmed."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ConfirmBookingOptions","referenceFqn":"Bookings.ConfirmBookingOptions"},"description":"An object representing the available options for confirming a booking."}],"description":"Confirms a booking request.\r\n\r\nThe `confirmBooking()` function returns a Promise that resolves to the ID of the confirmed booking.\r\n\r\nA service can be set to \"Automatically accept all bookings when staff are available\" or \"Manually approve or decline booking requests\" in the Online Booking Preferences page under [\"Additional Settings\"](https://support.wix.com/en/article/wix-bookings-requiring-approval-for-appointments). When set to manual, the business must confirm or decline each request.\r\n\r\nWhen a booking is confirmed, the following events occur:\r\n- The booking status changes to `CONFIRMED`.\r\n- The participant status in the session changes to `APPROVED`.\r\n- Slot availability is updated.\r\n- An offline order is created in the Wix Payment Service.\r\n- An email notification is sent to the participant according to the `participantNotification` properties.\r\n\r\n> **Note**: Only users with [Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) permissions can confirm a booking. Override the permissions by setting the `suppressAuth` options to `true`."},{"name":"declineBooking","fqn":"Bookings.declineBooking","slug":"decline-booking","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeclineBookingResult","referenceFqn":"Bookings.DeclineBookingResult"}},"examples":[{"title":"Decline a booking request","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { bookings } from \"wix-bookings-backend\";\n\nexport const declineBooking = webMethod(Permissions.Anyone, (bookingId) => {\n const declineBookingOptions = {\n participantNotification: {\n notifyParticipants: true,\n message: \"Sorry, but your booking request has been declined.\",\n },\n };\n\n return bookings\n .declineBooking(bookingId, declineBookingOptions)\n .then((result) => {\n return result;\n })\n .catch((error) => {\n return error;\n });\n});\n\n/* Returns a promise that resolves to:\n *\n * {\n * \"bookingId\": \"001c0674-d7c9-4c77-acb5-b492b427b201\"\n * }\n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booking to be declined."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeclineBookingOptions","referenceFqn":"Bookings.DeclineBookingOptions"},"description":"An object representing the available options for declining a booking."}],"description":"Declines a pending booking request.\r\n\r\nThe `declineBooking()` function returns a Promise that resolves when the specified booking is declined.\r\n\r\nA service can be set to \"Automatically accept all bookings when staff are available\" or \"Manually approve or decline booking requests\" in the Online Booking Preferences page under [\"Additional Settings\"](https://wix.wixanswers.com/app/kb/article/0553a31c-1f6a-4291-9e51-03a2339a1ee9/en). When set to manual, the business must confirm or decline each request.\r\n\r\nWhen a booking is declined, the following events occur:\r\n- The booking status changes from `PENDING_APPROVAL` to `DECLINED`.\r\n- The participant status on the session changes to `DECLINED`.\r\n- The corresponding session or participant is deleted from the calendar.\r\n- An email notification is sent to the participant according to the `participantNotification` properties.\r\n\r\n> **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can decline a booking. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"queryBookings","fqn":"Bookings.queryBookings","slug":"query-bookings","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder"},"examples":[{"title":"List all bookings","description":"Use a `hasSome()` filter to override the default and retrieve all booking statuses.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { bookings } from 'wix-bookings-backend';\n\nexport const queryBookings = webMethod(Permissions.Anyone, () => {\n return bookings\n .queryBookings()\n .hasSome(\"status\", [\"PENDING_CHECKOUT\", \"CONFIRMED\", \"CANCELED\", \"PENDING\", \"PENDING_APPROVAL\", \"DECLINED\"])\n .find()\n .then((queryResult) => {\n return queryResult.items;\n })\n .catch((error) => {\n return error;\n });\n});"},{"title":"Retrieve bookings that are pending approval, where the creation date is on or after December 20, 2020 at 10 am, and the start date of the session is before January 7, 2021 at 5 pm","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { bookings } from 'wix-bookings-backend';\n\nexport const queryBookings = webMethod(Permissions.Anyone, () => {\n return bookings\n .queryBookings()\n .eq(\"status\", \"PENDING_APPROVAL\")\n .ge(\"_createdDate\", \"2020-12-20T10:00:00.000Z\")\n .lt(\"startTime\", \"2021-01-07T17:00:00.000Z\")\n .find()\n .then((queryResult) => {\n return queryResult.items;\n })\n .catch((error) => {\n return error;\n });\n});"}],"description":"Creates a query to retrieve a list of bookings.\r\n\r\nThe `queryBookings()` function builds a query to retrieve a list of bookings and returns a [BookingsQueryBuilder](wix-bookings-backend.Bookings/bookingsquerybuilder) object.\r\n\r\nThe returned object contains the query definition which is typically used to run the query using the [`find()`](wix-bookings-backend.Bookings/bookingsquerybuilder/find) function.\r\n\r\nYou can refine the query by chaining `BookingsQueryBuilder` functions onto the query. `BookingsQueryBuilder` functions enable you to sort, filter, and control the results that `queryBookings()` returns.\r\n\r\nThe query runs with the following `BookingsQueryBuilder` defaults that you can override:\r\n\r\n+ [`eq`](wix-bookings-backend.Bookings.BookingsQueryBuilder.html.#eq): `\"status\": \"CONFIRMED\"`\r\n+ [`skip`](wix-bookings-backend.Bookings.BookingsQueryBuilder.html.#skip): `0`\r\n+ [`limit`](wix-bookings-backend.Bookings.BookingsQueryBuilder.html.#limit): `50`\r\n+ [`descending`](wix-bookings-backend.Bookings.BookingsQueryBuilder.html.#descending): `_createdDate`\r\n\r\nThe functions that are chained to `queryBookings()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `status` property in descending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by status in descending order, per created date value.\r\n\r\n\r\nThe following `BookingsQueryBuilder` functions are supported for `queryBookings()`. \r\nFor a full description of the Booking object, see the object returned for the [`items`](wix-bookings-backend.Bookings/bookingsqueryresult/items) property in [`BookingsQueryResult`](wix-bookings-backend.Bookings/bookingsqueryresult). \r\n\r\n|Property|Filters|Description|\r\n|--|--|--|\r\n|`_id`|[`eq()`](wix-bookings-backend.Bookings/bookingsquerybuilder/eq)| Query for a specific booking. `eq(\"_id\",\"46ce4cd4-46ff-4aa7-9cc0-02fd4f0f3209\")`|\r\n|`contactId` | [`eq()`](wix-bookings-backend.Bookings/bookingsquerybuilder/eq)| Bookings made by the specified contact ID. `eq(\"contactId\",\"8711a950-74cc-4608-80fb-8f09df9cbbf4\")`|\r\n|`sessionId`| [`eq()`](wix-bookings-backend.Bookings/bookingsquerybuilder/eq), [`hasSome()`](wix-bookings-backend.Bookings/bookingsquerybuilder/hassome)|Bookings made to a given session or a list of sessions. `hasSome(\"sessionId\",\"[193ZPR9ppP9emJUCLevcLf6orynNE45\", \"c8UhG9ppABemJUCLevcLf6orynNE98\"] )`|\r\n|`startTime`| [`ge()`](wix-bookings-backend.Bookings/bookingsquerybuilder/ge) , [`lt()`](wix-bookings-backend.Bookings/bookingsquerybuilder/lt), [`ascending()`](wix-bookings-backend.Bookings/bookingsquerybuilder/ascending), [`descending()`](wix-bookings-backend.Bookings/bookingsquerybuilder/descending)|Bookings with a schedule or session start time (UTC) earlier than a given time, or at a given time or later. `ge(\"startTime\", \"2020-04-27T10:00:00.000Z\")`|\r\n|`endTime`|[`gt()`](wix-bookings-backend.Bookings/bookingsquerybuilder/gt), [`le()`](wix-bookings-backend.Bookings/bookingsquerybuilder/le)|Bookings with a schedule or session end time (UTC) later than a given time, or at a given time or earlier. `gt(\"endTime\", \"2020-04-27T10:00:00.000Z\")`|\r\n|`status`|[`eq()`](wix-bookings-backend.Bookings/bookingsquerybuilder/eq), [`hasSome()`](wix-bookings-backend.Bookings/bookingsquerybuilder/hassome)|Bookings with a given status or a status that is in a given list of statuses. `hasSome(\"status\", [\"CONFIRMED\", \"PENDING_APPROVAL\",\"CANCELED\"])`|\r\n|`_createdDate`|[`ge()`](wix-bookings-backend.Bookings/bookingsquerybuilder/ge), [`lt()`](wix-bookings-backend.Bookings/bookingsquerybuilder/lt), [`ascending()`](wix-bookings-backend.Bookings/bookingsquerybuilder/ascending), [`descending()`](wix-bookings-backend.Bookings/bookingsquerybuilder/descending)|Bookings created at a given date or later, or earlier than a given date. `lt(\"_createdDate\", \"2020-04-27T10:00:00.000Z\")`|\r\n\r\nYou can only use one filter function for each property. If a property is used in more than one filter, only the first filter will work.\r\n\r\n>**Notes:**\r\n> + By default, `queryBookings()` retrieves only statuses of `\"CONFIRMED\"`. To retrieve all booking statuses use a `hasSome()` filter with all of the statuses.\r\n> + When using the `queryBookings()` function immediately following a change to your bookings, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data/introduction#wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay querying for a number of seconds, following any changes to your bookings data.\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can retrieve other customers' bookings. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"setAttendance","fqn":"Bookings.setAttendance","slug":"set-attendance","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId","attendanceInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"}},"examples":[{"title":"Set attendance information","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { bookings } from 'wix-bookings-backend';\n\nexport const setAttendance = webMethod(Permissions.Anyone, async () => {\n const bookingId = '25a285ec-fc3b-4ca3-bb05-42ec7b510c2e';\n const attendanceInfo = {\n attended: true,\n numberOfAttendees: 3\n };\n\n try {\n const booking = await bookings.setAttendance(bookingId, attendanceInfo);\n return booking;\n } catch (error) {\n return error;\n }\n});\n\n/* Returns a promise that resolves to a booking object:\n *\n * {\n * \"_id\": \"7125331e-75e6-4889-809a-5dea10648b30\",\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": * \"1ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1* HujEPUQ0IeScwcTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5* IVtDpF30FnQDoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN* 3AbndYxESrFnttLnRSFzcsolPAjYhaRCdJBhUj8rAoBoj71MgiFi4Tw3FDyVZz2OeOH* GmwRi0ELuqZvw0Y5tmMXrIKa48SvG8sr2MyOQsaIbMHy8YX1Q8anAgfdt\",\n * \"start\": \"2021-01-22T10:30:00Z\",\n * \"end\": \"2021-01-22T11:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"GROUP\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }\n * ],\n * \"status\": \"PENDING_CHECKOUT\",\n * \"_createdDate\": \"2021-01-11T08:45:00.214Z\",\n * \"attendanceInfo\": {\n * \"attendanceStatus\": true,\n * \"numberOfAttendees\": 1\n * },\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"value\": \"Cant wait to start\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"a6d4c19e-1882-4e29-9eb3-411e1aeeb874\",\n * \"firstName\": \"Joe Green\",\n * \"email\": \"JoeGreen@hmail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_CASHIER\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"orderId\": \"dd702e88-68e0-4faa-94b2-4996136a9828\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\"\n * }\n * ]\n * }\n * }\n * \n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the Booking to be updated."},{"name":"attendanceInfo","slug":"attendance-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AttendanceInfo","referenceFqn":"Bookings.AttendanceInfo"},"description":"Attendance information for the booking"},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for setting attendance."}],"description":"Sets the number of people who actually attended the session for the given booking.\r\n\r\nThe `setAttendance()` function returns a Promise that resolves when attendance information has been updated.\r\n\r\nThe number of attendees can be greater than 1 when the booking is made for a group of people.\r\nSet the `attended` boolean to `true` if the customer making the booking or anyone from their group attended.\r\n\r\n>**Notes:**\r\n> + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and `attended`.\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can set the attendance for a booking. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"setBookingAsPaid","fqn":"Bookings.setBookingAsPaid","slug":"set-booking-as-paid","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"}},"examples":[{"title":"Set a booking as paid","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { bookings } from 'wix-bookings-backend';\n\nexport const setBookingAsPaid = webMethod(Permissions.Anyone, async () => {\n const bookingId = '1b136d38-02e1-4452-8849-c253e29428a5';\n\n const options = { suppressAuth: true };\n try {\n const booking = await bookings.setBookingAsPaid(bookingId, options);\n return booking;\n } catch (error) {\n return error;\n }\n});\n\n/* Returns a promise that resolves to a booking object:\n * * {\n * \"_id\": \"3bab599d-c032-4f4c-89b1-c73dc51f013c\",\n * \"bookedEntity\": {\n * \"serviceId\": \"57daccbf-0fc9-4f3d-9c9e-1969947f33fa\",\n * \"scheduleId\": \"b5c9d6f1-8606-4378-9f4b-7e94d98de91f\",\n * \"setOfSessions\": {\n * \"firstSessionStart\": \"2021-01-20T14:30:00Z\",\n * \"lastSessionEnd\": \"2021-03-24T14:30:00Z\"\n * },\n * \"title\": \"12 Part Meditation Course\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"5000\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"50\"\n * }\n * }\n * },\n * \"tags\": [\n * \"COURSE\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }\n * ],\n * \"status\": \"CONFIRMED\",\n * \"_createdDate\": \"2021-01-11T08:46:20.703Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"593da82a-9718-4d43-9db0-8414320b3aa0\",\n * \"firstName\": \"Frank White\",\n * \"email\": \"frankw@wmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"5000\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"50\"\n * },\n * \"amountReceived\": \"5000\"\n * },\n * \"state\": \"COMPLETE\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"txId\": \"eb804fc3-ecab-49c9-8785-0e12d71aaff8\",\n * \"orderId\": \"6fa06198-1c39-4cf0-91db-a01b10720f56\",\n * \"orderAmount\": \"4950\",\n * \"orderStatus\": \"COMPLETE\",\n * \"orderApprovalTime\": \"2021-01-11T08:47:44.757Z\",\n * \"paymentVendorName\": \"inPerson\"\n * },\n * {\n * \"orderId\": \"aedcae46-844b-4091-b174-cf90f102629f\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"COMPLETE\"\n * }\n * ]\n * }\n * },\n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Booking ID to update as paid."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for setting a booking as paid."}],"description":"Marks a booking as fully paid.\r\n\r\nThe `setBookingAsPaid()` function returns a Promise that resolves when the booking is set as fully paid.\r\n\r\nWhen the business has received full payment from the customer, the booking can be marked as fully paid.\r\n\r\nWhen a booking is set as paid, the following events occur:\r\n- The `paymentDetails.state` status changes to `\"COMPLETE\"`.\r\n- The `amountReceived` value is updated to the `finalPrice.amount` value.\r\n\r\nYou cannot mark a booking as paid if the booking `status` is `\"PENDING_APPROVAL\"`.\r\n\r\n>**Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can mark a booking as paid. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"updateCustomerInfo","fqn":"Bookings.updateCustomerInfo","slug":"update-customer-info","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["bookingId","formInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"}},"examples":[{"title":"Update customer information","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { bookings } from 'wix-bookings-backend';\n\nexport const updateCustomerInfo = webMethod(Permissions.Anyone, async () => {\n const bookingId = '0b535e5c-5d30-493c-bd5e-ef92ba6503b7';\n const formInfo = {\n contactDetails: {\n firstName: 'Fred',\n lastName: 'Thompson',\n email: 'fred@thompson.com',\n phone: '5558707',\n },\n paymentSelection: [{\n rateLabel: 'General',\n numberOfParticipants: 3\n }],\n additionalFields: [{\n 'value': 'A Message from Fred',\n '_id': '00000000-0000-0000-0000-000000000008'\n }]\n }\n return bookings\n .updateCustomerInfo(bookingId, formInfo)\n .then((booking) => {\n return booking;\n })\n .catch((error) => {\n return error;\n });\n});\n\n\n/* Returns a promise that resolves to a booking object:\n *\n * {\n * \"_id\": \"0b535e5c-5d30-493c-bd5e-ef92ba6503b7\",\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": \"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1HunZjEPUQ0IeScw cTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5IVhgtDpF30FnQDoG8I60n21QAlhok4 LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN3AfXbndYxESrFnttLnRSFzcsolOnBRWHQAvTO0Tm0lEZ2 wIkEAlBrLj6aximrsee44236Oi5bWmdlEdc6fgZ8rfy8bmNsGyV8ryxoDEs8OrU3KHtZEnocCDS1rwZBU2n\",\n * \"start\": \"2021-01-15T17:30:00Z\",\n * \"end\": \"2021-01-15T18:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"GROUP\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\",\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\"\n * }\n * ],\n * \"status\": \"CONFIRMED\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"_createdDate\": \"2021-01-13T17:51:21.566Z\",\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 3\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"value\": \"A Message from Fred\",\n * \"valueType\": \"LONG_TEXT\",\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"b5d03d59-f4b9-49e5-95e2-864b33f30049\",\n * \"firstName\": \"Fred\",\n * \"lastName\": \"Thompson\",\n * \"email\": \"fred@thompson.com\",\n * \"phone\": \"5558707\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"txId\": \"893ee533-22fe-4ee5-b2e4-a8aef5c4906c\",\n * \"orderId\": \"d91f9a7e-077f-4d47-9037-ff6a040787a9\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\",\n * \"paymentVendorName\": \"offline\"\n * }\n * ]\n * }\n * }\n */"}],"actionParams":[{"name":"bookingId","slug":"booking-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the booking to be updated."},{"name":"formInfo","slug":"form-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormInfo","referenceFqn":"Bookings.FormInfo"},"description":"Updated form info and contact details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for updating customer information."}],"description":"Updates the customer's information for a booking.\r\n\r\nThe `updateCustomerInfo()` function returns a Promise that resolves to a `Booking` object when the specified customer's information has been updated. \r\n\r\n> **Notes:**\r\n> + The whole `formInfo` object is updated for each request. Values for properties that are not included in the request will therefore be deleted.\r\n> + `updateCustomerInfo()` does not update the information for the corresponding contact or member. To update contacts or members use [`updateContact()`](wix-crm-backend/updatecontact) or [`updateUserFields()`](wix-users-backend/updateuserfields).\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can update customer information for a booking. You can override the permissions by setting the `suppressAuth` options to `true`."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe Bookings API provides functionality for updating and managing bookings created in the Wix Bookings app.\n\nTo enable bookings backend API functionality for your site, add the [Wix Bookings](https://support.wix.com/en/article/wix-bookings-about-wix-bookings#adding-wix-bookings-to-your-site) application to your site.\nYou must upgrade your site to a [Premium Plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683) in order to accept bookings and receive online payments. \n\n>**Note:** You cannot book a service in preview mode, or when logged in as the site owner. To make a booking, publish your site, then either log out of your Wix account, or open the published site in an incognito browser window.\n\nThe Bookings API provides bookings functionality allowing you to:\n+ List and [query](wix-bookings-backend/bookings/query-bookings) booking information.\n+ [Confirm](wix-bookings-backend/bookings/confirm-booking) pending booking requests.\n+ [Decline](wix-bookings-backend/bookings/decline-booking) pending booking requests.\n+ [Cancel](wix-bookings-backend/bookings/cancel-booking) a booking.\n+ [Set attendance](wix-bookings-backend/bookings/set-attendance) for booked sessions.\n+ [Set](wix-bookings-backend/bookings/set-booking-as-paid) a booking as paid.\n+ Update the customer's [booking information](wix-bookings-backend/bookings/update-customer-info).\n\nTo use the Bookings API, import `bookings` from the `wix-bookings-backend` module:\n\n```javascript\nimport { bookings } from \"wix-bookings-backend\";\n```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"BookingsQueryBuilder","slug":"bookings-query-builder","fqn":"Bookings.BookingsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"Bookings.BookingsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an ascending sort to a query","content":"let query = bookings.queryBookings().ascending(\"startTime\", \"_createdDate\");"},{"title":"Create a query, add an ascending sort, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .ascending(\"startTime\", \"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `BookingsQueryBuilder` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"descending","fqn":"Bookings.BookingsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a descending sort to a query","content":"let query = bookings.queryBookings().descending(\"startTime\", \"_createdDate\");"},{"title":"Create a query, add a descending sort, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .descending(\"startTime\", \"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `BookingsQueryBuilder` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"eq","fqn":"Bookings.BookingsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let query = bookings.queryBookings().eq(\"status\", \"CANCELED\");"},{"title":"Create a query, add an equals filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .eq(\"status\", \"CANCELED\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `contactId`\r\n+ `sessionId`\r\n+ `status`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `BookingsQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Bookings.BookingsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Perform a find on a query","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Perform a find on a query using options","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\nconst options = {\n \"suppressAuth\": true\n};\n\nbookings.queryBookings()\n .find(options)\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.BookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the bookings that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n > **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can retrieve other customers' bookings. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"ge","fqn":"Bookings.BookingsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query","content":"let query = bookings.queryBookings().ge(\"startTime\", \"2020-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .ge(\"startTime\", \"2020-04-27T10:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `BookingsQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`."},{"name":"gt","fqn":"Bookings.BookingsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a greater than filter to a query","content":"let query=bookings.queryBookings().gt(\"endTime\",\"2021-04-27T10:00:00.000Z\")"},{"title":"Create a query, add a greater than filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .gt(\"endTime\", \"2021-04-27T10:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `endTime`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `BookingsQueryBuilder` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`."},{"name":"hasSome","fqn":"Bookings.BookingsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a hasSome filter to a query","content":"let query = bookings.queryBookings().hasSome(\"status\", [\"PENDING_CHECKOUT\", \"PENDING\", \"PENDING_APPROVAL\"]);"},{"title":"Create a query, add a hasSome filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .hasSome(\"status\", [\"PENDING_CHECKOUT\", \"PENDING\", \"PENDING_APPROVAL\"])\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `sessionId`\r\n+ `status`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `BookingsQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"le","fqn":"Bookings.BookingsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a less than or equals filter to a query","content":"let query = bookings.queryBookings().le(\"endTime\", \"2021-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .le(\"endTime\", \"2021-04-27T10:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `endTime`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `BookingsQueryBuilder`to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`."},{"name":"limit","fqn":"Bookings.BookingsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a limit to a query","content":"let query = bookings.queryBookings().limit(10);"},{"title":"Create a query, add a limit, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend/bookings/bookings-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend/bookings/bookings-query-result/next)\r\n and [`prev()`](wix-bookings-backend/bookings/bookings-query-result/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Bookings.BookingsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a less than filter to a query","content":"let query = bookings.queryBookings().lt(\"startTime\", \"2021-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a less than filter, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .lt(\"startTime\", \"2021-04-27T10:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `startTime`\r\n+ `_createdDate`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `BookingsQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"skip","fqn":"Bookings.BookingsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder","description":"A `BookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a skip to a query","content":"let query = bookings.queryBookings().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .skip(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `BookingsQueryBuilder` functions enable you to run, sort, filter, and control\n which results a query returns.\n\n Typically, you build a query using the Bookings query function,\n refine the query by chaining `BookingsQueryBuilder` functions, and then execute the\n query by chaining the [`find()`](#find) function.\n\n> **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can retrieve other customers' bookings. You can override the permissions by setting the `suppressAuth` options to `true` in the [`find()`](#find) function..\n\n For example, the following code queries all bookings of the customer with the\n specified contact ID, and logs the first 5 results to the console, sorted in\n ascending order by the sessions' start times:\n\n ```javascript\n import { bookings } from 'wix-bookings-backend';\n\n bookings.queryBookings\n .eq(\"contactId\", \"2cb1846f-0c7a-4c39-8736-349236cfab40\")\n .ascending(\"startTime\")\n .limit(5)\n .find()\n .then( (results) => {\n console.log(results.items);\n } );\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"BookingsQueryResult","slug":"bookings-query-result","fqn":"Bookings.BookingsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Bookings.BookingsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { bookings } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await bookings.queryBookings()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Bookings.BookingsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates the query has previous results."},{"name":"next","fqn":"Bookings.BookingsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { bookings } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await bookings.queryBookings()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `BookingsQueryResult` may change."},{"name":"prev","fqn":"Bookings.BookingsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BookingsQueryResult","referenceFqn":"Bookings.BookingsQueryResult.BookingsQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-bookings-backend/bookings/bookings-query-builder/find)\n function, it returns a Promise that resolves to a `BookingsQueryResult` object.\n This object contains the items that match the query, information about the\n query itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"let resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPage = results.currentPage; // 0\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the booking items from the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\nbookings.queryBookings()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n/* items:\n * [\n * {\n * \"_id\": \"3bab599d-c032-4f4c-89b1-c73dc51f013c\",\n * \"bookedEntity\": {\n * \"serviceId\": \"57daccbf-0fc9-4f3d-9c9e-1969947f33fa\",\n * \"scheduleId\": \"b5c9d6f1-8606-4378-9f4b-7e94d98de91f\",\n * \"setOfSessions\": {\n * \"firstSessionStart\": \"2021-01-20T14:30:00Z\",\n * \"lastSessionEnd\": \"2021-03-24T14:30:00Z\"\n * },\n * \"title\": \"12 Part Meditation Course\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"5000\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"50\"\n * }\n * }\n * },\n * \"tags\": [\n * \"COURSE\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }\n * ],\n * \"status\": \"CONFIRMED\",\n * \"_createdDate\": \"2021-01-11T08:46:20.703Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"593da82a-9718-4d43-9db0-8414320b3aa0\",\n * \"firstName\": \"Frank White\",\n * \"email\": \"frankw@wmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"5000\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"50\"\n * },\n * \"amountReceived\": \"5000\"\n * },\n * \"state\": \"COMPLETE\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"txId\": \"eb804fc3-ecab-49c9-8785-0e12d71aaff8\",\n * \"orderId\": \"6fa06198-1c39-4cf0-91db-a01b10720f56\",\n * \"orderAmount\": \"4950\",\n * \"orderStatus\": \"UNDEFINED\",\n * \"orderApprovalTime\": \"2021-01-11T08:47:44.757Z\",\n * \"paymentVendorName\": \"inPerson\"\n * },\n * {\n * \"orderId\": \"aedcae46-844b-4091-b174-cf90f102629f\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\"\n * }\n * ]\n * }\n * },\n * {\n * \"_id\": \"7125331e-75e6-4889-809a-5dea10648b30\",\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": * \"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1* HunZjEPUQ0IeScwcTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5* IVhgtDpF30FnQDoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN* 3AfXbndYxESrFnttLnRSFzcsolPAjYhaRCdJBhUj8rAoBoj71MgiFi4Tw3FDyVZz2OeOH* GmfQwRi0ELuqZvw0Y5tmMXrIKa48SvG8sr2MyOQsaIbMHy8YX1Q8anAgfdt\",\n * \"start\": \"2021-01-22T10:30:00Z\",\n * \"end\": \"2021-01-22T11:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"GROUP\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }\n * ],\n * \"status\": \"PENDING_CHECKOUT\",\n * \"_createdDate\": \"2021-01-11T08:45:00.214Z\",\n * \"attendanceInfo\": {\n * \"attendanceStatus\": true,\n * \"numberOfAttendees\": 1\n * },\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * : \"00000000-0000-0000-0000-000000000008\",\n * \"value\": \"Cant wait to start\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\",\n * \"_id\": \"00000000-0000-0000-0000-000000000008\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"a6d4c19e-1882-4e29-9eb3-411e1aeeb874\",\n * \"firstName\": \"Joe Green\",\n * \"email\": \"JoeGreen@hmail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_CASHIER\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"orderId\": \"dd702e88-68e0-4faa-94b2-4996136a9828\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\"\n * }\n * ]\n * },\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Booking","referenceFqn":"Booking"}},"description":"Returns an array of bookings that match the query.\r\n\r\nThe current page of bookings retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `booking` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the length of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the length of the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultLength = results.length; // 20\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPageSize = results.pageSize; // 50\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](#prev) and [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"let resultQuery = results.query;"},{"title":"Perform a query, get the query that produced the results and modify it","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let newQuery = results.query;\n newQuery\n .ge(\"startTime\", \"2021-01-01T15:21:41.960Z\")\n .find()\n .then((newQueryResults) => {\n let firstItem = newQueryResults.items[0];\n })\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"REFERENCE","name":"BookingsQueryBuilder","referenceFqn":"Bookings.BookingsQueryBuilder.BookingsQueryBuilder"},"description":"Returns the BookingsQueryBuilder object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional BookingsQueryBuilder functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a query and get the number of items in the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultCount = results.totalCount; // 150\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"let resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPages = results.totalPages; // 3\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/bookings/bookings-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},{"name":"WixBookingsQueryBuilder","slug":"wix-bookings-query-builder","fqn":"Bookings.WixBookingsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"Bookings.WixBookingsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an ascending sort to a query.","content":"let query = bookings.queryBookings().ascending(\"startTime\", \"created\");"},{"title":"Create a query, add an ascending sort, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.ascending(\"startTime\",\"created\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixBookingsQueryBuilder` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"count","fqn":"Bookings.WixBookingsQueryBuilder.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfilled - The number of items that match the query.\r\nRejected - The errors that caused the rejection."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.WixBookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query or query count."}],"description":"Returns the number of items that match the query.\r\n\r\nThe `count()` function returns a Promise that resolves to the number of\r\n items that match the query. The Promise is rejected if `count()` is called\r\n with incorrect permissions or if any of the functions used to refine the\r\n query are invalid.\r\n\r\n Use the `options` parameter to run `count()` without checking for permissions.\r\n\r\n Any function that does not filter query results (for example, [`ascending()`](#ascending))\r\n does not affect the result of `count()`.\r\n\r\n If you have already run a query with [`find()`](#find), you can retrieve\r\n the number of query results without calling `count()`. The [`find()`](#find)\r\n function returns a Promise that resolves to a [`WixBookingsQueryResult`](wix-bookings-backend.WixBookingsQueryResult)\r\n object, which has a `totalCount` property whose value is the number of results."},{"name":"descending","fqn":"Bookings.WixBookingsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a descending sort to a query.","content":"let query = bookings.queryBookings().descending(\"startTime\", \"created\");"},{"title":"Create a query, add a descending sort, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.descending(\"startTime\",\"created\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixBookingsQueryBuilder` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"eq","fqn":"Bookings.WixBookingsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query.","content":"let query = bookings.queryBookings().eq(\"status\", \"CANCELED\");"},{"title":"Create a query, add an equals filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.eq(\"status\", \"CANCELED\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixBookingsQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `eq()` includes items\r\n in which any of the elements of the Array match the specified `value`."},{"name":"find","fqn":"Bookings.WixBookingsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Perform a find on a query.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"},{"title":"Perform a find on a query using options.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\nconst options = {\n \"suppressAuth\": true\n};\n\nbookings.queryBookings()\n.find(options)\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Bookings.WixBookingsQueryBuilder.QueryOptions"},"description":"Options to use when performing a query or query count."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n Use the `options` parameter to run `find()` without checking for permissions."},{"name":"ge","fqn":"Bookings.WixBookingsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query.","content":"let query = bookings.queryBookings().ge(\"startTime\", \"2020-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a greater than or equals filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.ge(\"startTime\",\"2020-04-27T10:00:00.000Z\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixBookingsQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n\r\nß"},{"name":"gt","fqn":"Bookings.WixBookingsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a greater than filter to a query.","content":"let query=bookings.queryBookings().gt(\"endTime\",\"2021-04-27T10:00:00.000Z\")"},{"title":"Create a query, add a greater than filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.gt(\"endTime\",\"2021-04-27T10:00:00.000Z\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixBookingsQueryBuilder` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`."},{"name":"hasSome","fqn":"Bookings.WixBookingsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a hasSome filter to a query.","content":"let query = bookings.queryBookings().hasSome(\"status\", [\"PENDING_CHECKOUT\", \"PENDING\", \"PENDING_APPROVAL\"]);"},{"title":"Create a query, add a hasSome filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.hasSome(\"status\",[\"PENDING_CHECKOUT\",\"PENDING\",\"PENDING_APPROVAL\"])\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixBookingsQueryBuilder` to\r\n only match items where any of the values of the array of the specified property equal any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"le","fqn":"Bookings.WixBookingsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a less than or equals filter to a query.","content":"let query = bookings.queryBookings().le(\"endTime\", \"2021-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a less than or equals filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.le(\"endTime\",\"2021-04-27T10:00:00.000Z\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixBookingsQueryBuilder`to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`."},{"name":"limit","fqn":"Bookings.WixBookingsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a limit to a query.","content":"let query = bookings.queryBookings().limit(10);"},{"title":"Create a query, add a limit, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.limit(10)\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend.WixBookingsQueryResult.html#pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.WixBookingsQueryResult.html#next)\r\n and [`prev()`](wix-bookings-backend.WixBookingsQueryResult.html#prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Bookings.WixBookingsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a less than filter to a query.","content":"let query = bookings.queryBookings().lt(\"startTime\", \"2021-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a less than filter, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.lt(\"startTime\",\"2021-04-27T10:00:00.000Z\")\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixBookingsQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`."},{"name":"skip","fqn":"Bookings.WixBookingsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder","description":"A `WixBookingsQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a skip to a query.","content":"let query = bookings.queryBookings().skip(10);"},{"title":"Create a query, add a skip, and run it.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n.skip(10)\n.find()\n.then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query; \n } else {\n // handle case where no matching items found\n }\n})\n.catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n});"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `WixBookingsQueryBuilder` functions enable you to run, sort, filter, and control\n which results a query returns.\n\n Typically, you build a query using any of the Bookings query functions,\n refine the query by chaining `WixBookingsQueryBuilder` functions, and then execute the\n query by chaining *one* of the following: [`find()`](#find) or [`count()`](#count).\n\n For example, the following code queries all bookings of the customer with the\n specified contact ID and logs the first 5 results to the console, sorted in\n ascending order by the sessions' start times:\n\n ```javascript\n import wixBookingsBackend from 'wix-bookings-backend';\n\n wixBookingsBackend.queryBookings\n .eq(\"contactId\", \"2cb1846f-0c7a-4c39-8736-349236cfab40\")\n .ascending(\"startTime\")\n .limit(5)\n .find()\n .then( (results) => {\n console.log(results.items);\n } );\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixBookingsQueryResult","slug":"wix-bookings-query-result","fqn":"Bookings.WixBookingsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Bookings.WixBookingsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { bookings } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await bookings.queryBookings()\n .limit(1000)\n .find(); \n allItems.push(results.items);\n\n while(results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n return allItems;\n}\n"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Bookings.WixBookingsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates the query has previous results."},{"name":"next","fqn":"Bookings.WixBookingsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then( (results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let pageSize = newResults.pageSize;\n let currentPage = newResults.currentPage;\n let totalPages = newResults.totalPages;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n let length = newResults.length;\n let query = newResults.query;\n } )\n .catch( (error) => {\n let errorMsg = error.message;\n let code = error.code;\n } );"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { bookings } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await bookings.queryBookings()\n .limit(1000)\n .find(); \n allItems.push(results.items);\n\n while(results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataQueryResult` may change."},{"name":"prev","fqn":"Bookings.WixBookingsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixBookingsQueryResult","referenceFqn":"Bookings.WixBookingsQueryResult.WixBookingsQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then( (results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let pageSize = newResults.pageSize;\n let currentPage = newResults.currentPage;\n let totalPages = newResults.totalPages;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n let length = newResults.length;\n let query = newResults.query;\n } )\n .catch( (error) => {\n let errorMsg = error.message;\n let code = error.code;\n } );"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-data.BookingsQuery.html#find)\n function, it returns a Promise that resolves to a `BookingsQueryResult` object.\n This object contains the items that match the query, information about the\n query itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"let resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPage = results.currentPage; // 0\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the booking items from a query result.","content":"let items = results.items;\n\n/*\n * [\n * {\n * \"_id\": \"1234\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-29T08:35:52.344Z\",\n * \"_updatedDate\": \"2017-05-29T08:35:52.344Z\",\n * \"title\": \"Dr.\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * },\n * {\n * \"_id\": \"5678\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-25T12:48:56.572Z\",\n * \"_updatedDate\": \"2017-05-29T07:30:15.869Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * }\n * ]\n */"},{"title":"Perform a query and get the booking items from the result.","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\nbookings.queryBookings()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n\n/* items:\n *\n * [\n * {\n * \"id\": \"28f8d0d2-9704-441c-b8d0-5ac89548f729\",\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": \"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7Exg\n IRM1HunZjEPUQ0IeScwcTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5IVhgtDpF30FnQDoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN3AfXbndYxESrFnttLnRSFzcsolOnBRWHQAvTO0Tm0lEZ2wIkEAlBrLj6aximrsee44236Oi5bWmdlEdc6fgZ8rfy8bmNs GyV8ryxoDEs8OrU3KHtZEnocCDS1rwZBU2n\",\n * \"start\": \"2021-01-15T10:30:00Z\",\n * \"end\": \"2021-01-15T11:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"GROUP\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"\",\n * \"_id\": \"76570209-101f-409b-af97-b445bdb63125\"\n * }\n * ],\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"wixPayDetails\": {\n * \"orderId\": \"4c34902f-e821-4886-90ea-dd43c56065bd\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\"\n * },\n * \"state\": \"CANCELED\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"orderId\": \"4c34902f-e821-4886-90ea-dd43c56065bd\",\n * \"orderAmount\": \"50\",\n * \"orderStatus\": \"UNDEFINED\"\n * }\n * ]\n * },\n * \"status\": \"CANCELED\",\n * \"created\": \"2021-01-05T13:51:37.029Z\",\n * \"attendanceInfo\": {\n * \"attendanceStatus\": true,\n * \"numberOfAttendees\": 3\n * },\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"customFormFields\": {},\n * \"additionalFields\": [\n * {\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\",\n * \"_id\": \"00000000-0000-0000-0000-000000000008\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"81c9168e-95b8-47fd-8e6a-ad9fdf71b38e\",\n * \"firstName\": \"Michael Smith\",\n * \"email\": \"msmith@home.com\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * },\n * \"_id\": \"28f8d0d2-9704-441c-b8d0-5ac89548f729\" \n * },\n * {\n * \"id\": \"1b136d38-02e1-4452-8849-c253e29428a5\",\n * \"bookedEntity\": {\n * \"serviceId\": \"55dd33e7-6b98-4b18-beaf-4341e31c42f1\",\n * \"scheduleId\": \"3bf923b4-990b-4303-bde1-7f326e30a1f9\",\n * \"singleSession\": {\n * \"sessionId\": \"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7Exg\n IRM1HunZjEPUQ0IeScwcTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5IVhgtDpF30FnQDoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN3AfXbndYxESrFnttLnRSFzcsolOnBRWHQAvTO0Tm0lEZ2wIkEAlBrLj6aximrsee44236Oi5bWmdlEdc6fgZ8rfy8bmNs GyV8ryxoDEs8OrU3KHtZEnocCDS1rwZBU2n\",\n * \"start\": \"2020-12-25T12:00:00Z\",\n * \"end\": \"2020-12-25T12:30:00Z\"\n * },\n * \"title\": \"Self Defence\",\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * },\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"25\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * },\n * \"priceText\": \"\"\n * },\n * \"tags\": [\n * \"GROUP\"\n * ]\n * },\n * \"bookedResources\": [\n * {\n * \"id\": \"00dc9bd7-d69d-4b39-8c2b-6a9177725431\",\n * \"name\": \"Jane Smith\",\n * \"email\": \"jsmith@gmail.com\",\n * \"_id\": \"00dc9bd7-d69d-4b39-8c2b-6a9177725431\"\n * }\n * ],\n * \"formInfo\": {\n * \"contactDetails\": {\n * \"contactId\": \"9434edfb-eb71-4799-a544-79d5d67b5c44\",\n * \"firstName\": \"Paul White\",\n * \"email\": \"paulw@gmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * },\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"customFormFields\": {\n * \"00000000-0000-0000-0000-000000000008\": \"\"\n * },\n * \"additionalFields\": [\n * {\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"value\": \"\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\",\n * \"_id\": \"00000000-0000-0000-0000-000000000008\"\n * }\n * ]\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"25\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"25\"\n * },\n * \"wixPayDetails\": {\n * \"txId\": \"9ce4b5fa-05ee-4932-8889-0d873a732ddf\",\n * \"orderId\": \"3279d38d-8618-4c93-ba60-f403ff272601\",\n * \"orderAmount\": \"25\",\n * \"orderStatus\": \"UNDEFINED\",\n * \"orderApprovalTime\": \"2020-12-24T09:39:05.617Z\",\n * \"paymentVendorName\": \"offline\"\n * },\n * \"state\": \"COMPLETE\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"txId\": \"9ce4b5fa-05ee-4932-8889-0d873a732ddf\",\n * \"orderId\": \"3279d38d-8618-4c93-ba60-f403ff272601\",\n * \"orderAmount\": \"25\",\n * \"orderStatus\": \"UNDEFINED\",\n * \"orderApprovalTime\": \"2020-12-24T09:39:05.617Z\",\n * \"paymentVendorName\": \"offline\"\n * }\n * ]\n * },\n * \"status\": \"CONFIRMED\",\n * \"created\": \"2020-12-24T09:37:33.996Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"_id\": \"1b136d38-02e1-4452-8849-c253e29428a5\"\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the length of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the length of the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultLength = results.length; // 20\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPageSize = results.pageSize; // 50\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"let resultQuery = results.query;\n\n/* resultQuery:\n * \n * \"filterTree\": {\n * \"$and\": [\n * {\n * \"status\": {\n * \"$hasSome\": [\n * \"PENDING_APPROVAL\",\n * \"CONFIRMED\",\n * \"DECLINED\",\n * \"CANCELED\",\n * \"PENDING_CHECKOUT\",\n * \"PENDING\"\n * ]\n * }\n * }\n * ]\n * },\n * \"invalidArguments\": [],\n * \"sort\": [\n * {\n * \"fieldName\": \"created\",\n * \"order\": \"DESC\"\n * }\n * ],\n * \"paging\": {\n * \"offset\": 9\n * },\n * \"pagingMethod\": \"OFFSET\"\n * \n */"},{"title":"Perform a query and get the query that produced the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultQuery = results.query;\n });\n\n\n/* resultQuery:\n * \n * \"filterTree\": {\n * \"$and\": [\n * {\n * \"status\": {\n * \"$hasSome\": [\n * \"PENDING_APPROVAL\",\n * \"CONFIRMED\",\n * \"DECLINED\",\n * \"CANCELED\",\n * \"PENDING_CHECKOUT\",\n * \"PENDING\"\n * ]\n * }\n * }\n * ]\n * },\n * \"invalidArguments\": [],\n * \"sort\": [\n * {\n * \"fieldName\": \"created\",\n * \"order\": \"DESC\"\n * }\n * ],\n * \"paging\": {\n * \"offset\": 9\n * },\n * \"pagingMethod\": \"OFFSET\"\n * \n */"}],"type":{"kind":"REFERENCE","name":"WixBookingsQueryBuilder","referenceFqn":"Bookings.WixBookingsQueryBuilder.WixBookingsQueryBuilder"},"description":"Returns the query used to get the current results."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a query and get the number of items in the result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultCount = results.totalCount; // 150\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"let resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the query result","content":"import { bookings } from \"wix-bookings-backend\";\n\n// ...\n\nbookings.queryBookings()\n .find()\n .then((results) => {\n let resultPages = results.totalPages; // 3\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]}],"builderTypes":[],"properties":[]},{"name":"Events","slug":"events","fqn":"Events","standaloneTypes":[],"metadata":{},"actions":[{"name":"onBookingCanceled","fqn":"Events.onBookingCanceled","slug":"on-booking-canceled","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking is canceled","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingCanceled(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object\n * {\n * \"trigger\": \"OWNER_CANCELED\",\n * \"booking\": {\n * \"id\": \"23c9c0e1-345e-48e6-8d8f-30fd7249521e\",\n * \"bookedResources\": [{\n * \"id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }],\n * \"status\": \"CANCELED\",\n * \"createdDate\": \"2021-02-24T10:15:22.485Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\":193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7Ex\n * gIRM1HunZjEPUQ0IeScwcTFJNXEmLG2g6 * Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyy\n * y5IVhgtDpF30FnQoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN3AfXb\n * ndYxESrFnttLnRSFzcsolQicMTHTo5lYkhTLLlW8g5lcg1nWBohx2JkDABUO7SXWvqSkQZBmgXo\n * aZqiD1TBONPzIF84Vryelr1iTTzNl1cc6uJkhqo7DeSwWL\",\n * \"start\": \"2021-03-12T17:30:00Z\",\n * \"end\": \"2021-03-12T18:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"GROUP\"],\n * \"location\": { \"locationType\": \"OWNER_BUSINESS\" }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"CANCELED\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"76c8f02b-b530-433b-9fb2-ee5e3483418c\",\n * \"orderId\": \"93e44e16-17d1-48de-837c-53ed55132405\",\n * \"orderAmount\": \"50\",\n * \"paymentVendorName\": \"offline\"\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"156b86e2-0cee-4586-aac8-f434c919e14c\",\n * \"firstName\": \"Michael White\",\n * \"email\": \"mwhite@gmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"id\": \"23c9c0e1-345e-48e6-8d8f-30fd7249521e\",\n * \"bookedResources\": [{\n * \"id\": \"76570209-101f-409b-af97-b445bdb63125\",\n * \"name\": \"John Smith\",\n * \"email\": \"jsmith@gmail.com\"\n * }],\n * \"status\": \"CONFIRMED\",\n * \"createdDate\": \"2021-02-24T10:15:22.485Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\":193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7Ex\n * gIRM1HunZjEPUQ0IeScwcTFJNXEmLG2g6 * Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyy\n * y5IVhgtDpF30FnQoG8I60n21QAlhok4LHNlkBszoGZ67jGMeDOqxS8PXZgJx87ByXwfgsN3AfXb\n * ndYxESrFnttLnRSFzcsolQicMTHTo5lYkhTLLlW8g5lcg1nWBohx2JkDABUO7SXWvqSkQZBmgXo\n * aZqiD1TBONPzIF84Vryelr1iTTzNl1cc6uJkhqo7DeSwWL\",\n * \"start\": \"2021-03-12T17:30:00Z\",\n * \"end\": \"2021-03-12T18:00:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"GROUP\"],\n * \"location\": { \"locationType\": \"OWNER_BUSINESS\" }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"76c8f02b-b530-433b-9fb2-ee5e3483418c\",\n * \"orderId\": \"93e44e16-17d1-48de-837c-53ed55132405\",\n * \"orderAmount\": \"50\",\n * \"paymentVendorName\": \"offline\"\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"156b86e2-0cee-4586-aac8-f434c919e14c\",\n * \"firstName\": \"Michael White\",\n * \"email\": \"mwhite@gmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about a canceled booking."}],"description":"An event that fires when a booking is canceled.\r\n\r\nThe `onBookingCanceled()` event handler runs when a booking is canceled. \r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event.\r\nThe `trigger` value is one of:\r\n+ `\"OWNER_CANCELED\"`: The booking was canceled by the business.\r\n+ `\"MEMBER_CANCELED\"`: The booking was canceled by the member.\r\n\r\n> **Note:** Backend events don't work when previewing your site."},{"name":"onBookingConfirmed","fqn":"Events.onBookingConfirmed","slug":"on-booking-confirmed","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking is confirmed","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingConfirmed(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object\n * {\n * \"trigger\": \"BOOKING_AUTO_CONFIRMED\",\n * \"booking\": {\n * \"_id\": \"99a406e7-cbce-4765-a4cd-ff0d2d9fb8c2\",\n * \"bookedResources\": [\n * {\n * \"id\": \"5fe118a5-d4b2-464e-9334-268be4422908\",\n * \"name\": \"Sam Slade\",\n * \"email\": \"sams@gmail.com\"\n * }\n * ],\n * \"status\": \"CONFIRMED\",\n * \"createdDate\": \"2021-02-23T16:47:36.403Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": * \"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1HunZjEPUQ0IeScwcTFJNXEmLG2g6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADF * iCPyyy5IVhgtDpF30FnPznyrtkyH5fPewLT28aPO3bYaUZcXnNWumH3AaEAb8eyvUVbvkBxGSsv9RZXCgcMTjnhXUNwTBUGGxULnv2i5O933JqU3MACfQ6DUFaws9ufRJUc * RZwhmKpRIwWNmd0NtCD7ZlKaLkhu41yYjkZ4Z7YnqdBStzobnKjwbPbzPbVw4rXF8n47h8MTF\",\n * \"start\": \"2021-02-25T23:30:00Z\",\n * \"end\": \"2021-02-26T00:30:00Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"GROUP\"\n * ],\n * \"location\": {\n * \"locationType\": \"OWNER_BUSINESS\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [\n * {\n * \"txId\": \"f86bdab0-bd12-4128-85cd-e24f82dc38b8\",\n * \"orderId\": \"5e65776f-ac54-4dc7-b94e-f2b887ba06e3\",\n * \"orderAmount\": \"50\",\n * \"paymentVendorName\": \"offline\"\n * }\n * ]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"eef94a55-8309-4927-ab6f-d91711e5484a\",\n * \"firstName\": \"Andrew Brown\",\n * \"email\": \"abrown@gmail.com\",\n * \"phone\": \"555 3456\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"bookedEntity\": {\n * \"location\": { }\n * },\n * \"paymentDetails\": { },\n * \"formInfo\": {\n * \"contactDetails\": { }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about a confirmed booking."}],"description":"An event that fires when a booking request is confirmed.\r\n\r\nThe `onBookingConfirmed()` event handler runs when a new booking request is confirmed. \r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event.\r\nThe `trigger` value is one of:\r\n+ `\"BOOKING_AUTO_CONFIRMED\"`: A new booking was made for a service that is configured for automatic confirmation.\r\n+ `\"OWNER_CONFIRMED_BOOKING_REQUEST\"`: A booking was confirmed by the business.\r\n+ `\"OWNER_BOOKED\"`: The owner made a booking directly from the calendar.\r\n\r\n\r\n> **Note:** Backend events don't work when previewing your site."},{"name":"onBookingDeclined","fqn":"Events.onBookingDeclined","slug":"on-booking-declined","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking request is declined","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingDeclined(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object \n * {\n * \"trigger\": \"OWNER_DECLINED_BOOKING_REQUEST\",\n * \"booking\": {\n * \"_id\": \"d939f806-bb01-4472-a366-c0e136592531\",\n * \"bookedResources\": [{\n * \"id\": \"dc19d7db-6996-494b-8d6d-943d64e1f32a\",\n * \"name\": \"Tom Jones\",\n * \"email\": \"tom@yoga.com\"\n * }],\n * \"status\": \"DECLINED\",\n * \"createdDate\": \"2021-02-28T17:32:18.310Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"49c7fac5-227c-44d0-a4f3-c1a5c511edf1\",\n * \"scheduleId\": \"4b21a5af-3b69-42ce-a3ba-9cf60d7b4422\",\n * \"singleSession\": {\n * \"sessionId\":\"2mmoW0vwKcSFyxtOfCdMkutTlCGjD2Zol12Xf8oBKd3JBbarU\n * KabZB1NL1R17TsQtpgpCg6eScmLnAtlwEzi7IiungZ45aRewhjR\",\n * \"start\": \"2021-03-05T15:00:00.000Z\",\n * \"end\": \"2021-03-05T16:00:00.000Z\"\n * },\n * \"title\": \"Meditation Tutorial\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"INDIVIDUAL\"],\n * \"location\": {\n * \"address\": \"105 West Street, Apt. 321, New York, New York\",\n * \"customAddress\": {\n * \"formatted\": \"105 West Street, Apt. 321, New York, New York\"\n * },\n * \"locationType\": \"CUSTOM\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * }\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * },\n * {\n * \"id\": \"1b1ee05f-aa4d-4a9e-9086-aef1d9d98a49\",\n * \"label\": \"Agree to terms\",\n * \"valueType\": \"CHECK_BOX\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"53013366-1ff2-419f-ac58-2c82a7a3abdb\",\n * \"firstName\": \"John Walker\",\n * \"email\": \"jw@test.com\",\n * \"phone\": \"5557321\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\",\n * \"address\": {\n * \"formatted\": \"105 West Street, Apt. 321, New York,New York\"\n * }\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"_id\": \"d939f806-bb01-4472-a366-c0e136592531\",\n * \"bookedResources\": [{\n * \"id\": \"dc19d7db-6996-494b-8d6d-943d64e1f32a\",\n * \"name\": \"Tom Jones\",\n * \"email\": \"tom@yoga.com\"\n * }],\n * \"status\": \"PENDING_APPROVAL\",\n * \"createdDate\": \"2021-02-28T17:32:18.310Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"49c7fac5-227c-44d0-a4f3-c1a5c511edf1\",\n * \"scheduleId\": \"4b21a5af-3b69-42ce-a3ba-9cf60d7b4422\",\n * \"singleSession\": {\n * \"sessionId\":\"2mmoW0vwKcSFyxtOfCdMkutTlCGjD2Zol12Xf8oBKd3JBbarU\n * KabZB1NL1R17TsQtpgpCg6eScmLnAtlwEzi7IiungZ45aRewhjR\",\n * \"start\": \"2021-03-05T15:00:00.000Z\",\n * \"end\": \"2021-03-05T16:00:00.000Z\"\n * },\n * \"title\": \"Meditation Tutorial\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"INDIVIDUAL\"],\n * \"location\": {\n * \"address\": \"105 West Street, Apt. 321, New York, New York\",\n * \"customAddress\": {\n * \"formatted\": \"105 West Street, Apt. 321, New York, New York\"\n * },\n * \"locationType\": \"CUSTOM\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * }\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * },\n * {\n * \"id\": \"1b1ee05f-aa4d-4a9e-9086-aef1d9d98a49\",\n * \"label\": \"Agree to terms\",\n * \"valueType\": \"CHECK_BOX\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"53013366-1ff2-419f-ac58-2c82a7a3abdb\",\n * \"firstName\": \"John Walker\",\n * \"email\": \"jw@test.com\",\n * \"phone\": \"5557321\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\",\n * \"address\": {\n * \"formatted\": \"105 West Street, Apt. 321, New York, New York\"\n * }\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about a declined booking."}],"description":"An event that fires when a booking request is declined.\r\n\r\nThe `onBookingDeclined()` event handler runs when a booking request is declined by the business. \r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event. The `trigger` value for this event is `\"OWNER_DECLINED_BOOKING_REQUEST\"`.\r\n\r\n> **Note:** Backend events don't work when previewing your site."},{"name":"onBookingRequestCreated","fqn":"Events.onBookingRequestCreated","slug":"on-booking-request-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking request is created","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingRequestCreated(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object\n * {\n * \"trigger\": \"VISITOR_BOOKING_REQUEST_CREATED\",\n * \"booking\": {\n * \"_id\": \"abcde6c0-312d-463f-ac15-12345db761a6\",\n * \"bookedResources\": [\n * {\n * \"id\": \"dc19d7db-6996-494b-8d6d-943d64e1f32a\",\n * \"name\": \"Tom Jones\",\n * \"email\": \"tom@yoga.com\"\n * }\n * ],\n * \"status\": \"PENDING_APPROVAL\",\n * \"createdDate\": \"2021-02-23T13:25:08.447Z\",\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"CUSTOMER\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"49c7fac5-227c-44d0-a4f3-c1a5c511edf1\",\n * \"scheduleId\": \"4b21a5af-3b69-42ce-a3ba-9cf60d7b4422\",\n * \"singleSession\": {\n * \"sessionId\":\"mmoW0vwKcSFyxtOfCdMkx03iaGJPrwicZi6txH3v4xV1BjsDJnqagj\n * 6Kgq9OkF0yrmnAQoowvm9jGbIhun5QPTT3hBcxoTtd5zB\",\n * \"start\": \"2021-03-26T14:30:00Z\",\n * \"end\": \"2021-03-26T15:30:00Z\"\n * },\n * \"title\": \"Meditation Tutorial\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\n * \"INDIVIDUAL\"\n * ],\n * \"location\": {\n * \"address\": \"123 4th Street Fivetown\",\n * \"customAddress\": {\n * \"formatted\": \"123 4th Street Fivetown\"\n * },\n * \"locationType\": \"CUSTOM\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"100\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * }\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [\n * {\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }\n * ],\n * \"additionalFields\": [\n * {\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * },\n * {\n * \"id\": \"1b1ee05f-aa4d-4a9e-9086-aef1d9d98a49\",\n * \"label\": \"I need equipment\",\n * \"valueType\": \"CHECK_BOX\"\n * }\n * ],\n * \"contactDetails\": {\n * \"contactId\": \"f8937331-2452-4c9f-a090-69b6b384021b\",\n * \"firstName\": \"John Smith\",\n * \"email\": \"johnsmith@gmail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\",\n * \"address\": {\n * \"formatted\": \"123 4th Street Fivetown\"\n * }\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"bookedEntity\": {\n * \"location\": {}\n * },\n * \"paymentDetails\": {},\n * \"formInfo\": {\n * \"contactDetails\": {}\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about a newly-created booking request."}],"description":"An event that fires when a booking request is created.\r\n\r\nThe `onBookingRequestCreated()` event handler runs when a new booking request is created for a service that requires manual booking confirmation.\r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event. The `trigger` value for this event is `\"VISITOR_BOOKING_REQUEST_CREATED\"`. \r\n\r\n> **Note:** Backend events don't work when previewing your site."},{"name":"onBookingScheduleUpdated","fqn":"Events.onBookingScheduleUpdated","slug":"on-booking-schedule-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking schedule is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingScheduleUpdated(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object \n * {\n * \"trigger\": \"OWNER_UPDATED_SESSION\",\n * \"booking\": {\n * \"_id\": \"98edaf1a-6dcf-4cd5-90c7-02983649227c\",\n * \"bookedResources\": [{\n * \"id\": \"3eaef8e0-465f-47a0-a686-16620dfb20dc\",\n * \"name\": \"Harold Snow\",\n * \"email\": \"hs@a.com\"\n * }],\n * \"status\": \"CONFIRMED\",\n * \"createdDate\": \"2021-02-28T17:58:45.568Z\",\n * \"bookingSource\": {\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": *\"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1HunZjEPUQ0IeScwcTFJNXEmLG2g *6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5IVhgtDpF30FnQEWHzPMns58Sr8MvMAWkXSK8uJwh6UEdKaJSUymSrx *fZLltS56uD8nF6wfFUUkwcJNPklOZY3iwdK69i4mBxWWKleDBJrtctN2M4M3JVsi9kJ5cH8fSCPxUUQyqeKqquHxIyAF7TAe *wiEN6ID3HACgTwE6n5FaQ6cDssdarwuTWaqsFQ0GEhtgJvZ\",\n * \"start\": \"2021-03-18T16:30:00.000Z\",\n * \"end\": \"2021-03-18T17:00:00.000Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"GROUP\"],\n * \"location\": {\n * \"address\": \"123 West Street, New York, New York\",\n * \"customAddress\": {\n * \"formatted\": \"123 West Street, New York, New York\"\n * },\n * \"locationType\": \"OWNER_CUSTOM\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"dccef7b1-0b8a-47a2-af8a-4cd349a3f8cb\",\n * \"orderId\": \"c3e0e57a-b8fc-48a8-9869-e0839aed92ce\",\n * \"orderAmount\": \"50\",\n * \"paymentVendorName\": \"inPerson\",\n * \"orderApprovalTime\": null\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"baf3cd37-c32c-4f01-9e1a-c8ab152af490\",\n * \"firstName\": \"Adam Smith\",\n * \"email\": \"asmith@amail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"_id\": \"98edaf1a-6dcf-4cd5-90c7-02983649227c\",\n * \"bookedResources\": [{\n * \"id\": \"3eaef8e0-465f-47a0-a686-16620dfb20dc\",\n * \"name\": \"Harold Snow\",\n * \"email\": \"hs@a.com\"\n * }],\n * \"status\": \"CONFIRMED\",\n * \"createdDate\": \"2021-02-28T17:58:45.568Z\",\n * \"bookingSource\": {\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"singleSession\": {\n * \"sessionId\": *\"193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1HunZjEPUQ0IeScwcTFJNXEmLG2g *6Q8tvUJQZrPhU6XKhVrlLZraC3YcVfygADFiCPyyy5IVhgtDpF30FnQEWHzPMns58Sr8MvMAWkXSK8uJwh6UEdKaJSUymSrx *fZLltS56uD8nF6wfFUUkwcJNPklOZY3iwdK69i4mBxWWKleDBJrtctN2M4M3JVsi9kJ5cH8fSCPxUUQyqeKqquHxIyAF7TAe *wiEN6ID3HACgTwE6n5FaQ6cDssdarwuTWaqsFQ0GEhtgJvZ\",\n * \"start\": \"2021-03-18T16:00:00.000Z\",\n * \"end\": \"2021-03-18T16:30:00.000Z\"\n * },\n * \"title\": \"Yoga Class\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"GROUP\"],\n * \"location\": {\n * \"address\": \"123 West Street, New York, New York\",\n * \"customAddress\": {\n * \"formatted\": \"123 West Street, New York, New York\"\n * },\n * \"locationType\": \"OWNER_CUSTOM\"\n * }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"50\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"dccef7b1-0b8a-47a2-af8a-4cd349a3f8cb\",\n * \"orderId\": \"c3e0e57a-b8fc-48a8-9869-e0839aed92ce\",\n * \"orderAmount\": \"50\",\n * \"paymentVendorName\": \"inPerson\",\n * \"orderApprovalTime\": null\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"baf3cd37-c32c-4f01-9e1a-c8ab152af490\",\n * \"firstName\": \"Adam Smith\",\n * \"email\": \"asmith@amail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about a booking with an updated schedule."}],"description":"An event that fires when a booking's schedule is updated.\r\n\r\nThe `onBookingScheduleUpdated()` event handler runs when a booking's schedule is updated.\r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event.\r\nThe `trigger` value is one of:\r\n+ `\"OWNER_UPDATED_SESSION\"`: The booking's session was updated by the business.\r\n+ `\"MEMBER_RESCHEDULED_BOOKING\"`: The booking was rescheduled by the member.\r\n+ `\"OWNER_CANCELED_SESSION_IN_SET\"`: A session in a set of sessions was canceled by the business. A session is part of a set when it belongs to a schedule that has `\"course\"` as one of its tags.\r\n\r\n> **Note:** Backend events don't work when previewing your site."},{"name":"onBookingUpdated","fqn":"Events.onBookingUpdated","slug":"on-booking-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a booking is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\nexport function wixBookings_onBookingUpdated(event) {\n const eventTrigger = event.trigger;\n const bookingId = event.booking._id;\n}\n\n/* Full event object \n * {\n * \"trigger\": \"OWNER_UPDATED_ATTENDANCE\",\n * \"booking\": {\n * \"_id\": \"9f5a05d6-2fb4-4de8-990d-12db585d25c5\",\n * \"bookedResources\": [{\n * \"_id\": \"6dd5e48d-9e6d-4e74-bf61-e103e8d52575\",\n * \"name\": \"Jane Doe\",\n * \"email\": \"Doe\"\n * }],\n * \"status\": \"CONFIRMED\",\n * \"_createdDate\": \"2021-02-28T18:11:56.177Z\",\n * \"attendanceInfo\": {\n * \"attendanceStatus\": true,\n * \"numberOfAttendees\": 3\n * },\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"BUSINESS\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"2e80e5e0-2385-49c7-9f9f-2e59a3566809\",\n * \"scheduleId\": \"f1945fde-d567-4ebc-85ef-dd1d52327c11\",\n * \"singleSession\": {\n * \"sessionId\": \"2mmoW0vwKcSFyxtOfCdMhFC1gAivXqAQVAQP0hHoOUADs242fBtwKRY3sHLMmbVxJ75TQ4G6BkCe6z1E1fVT6gUPWDDNF4WX2S6P\",\n * \"start\": \"2021-03-18T19:00:00.000Z\",\n * \"end\": \"2021-03-18T20:00:00.000Z\"\n * },\n * \"title\": \"Appointment service\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"10\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"INDIVIDUAL\"],\n * \"location\": { \"locationType\": \"OWNER_BUSINESS\" }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"10\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"c1cef510-e382-4c1c-aeec-4300cfea219a\",\n * \"orderId\": \"179c361c-8a04-4f78-b28f-065b62cf4806\",\n * \"orderAmount\": \"10\",\n * \"paymentVendorName\": \"inPerson\",\n * \"orderApprovalTime\": null\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"baf3cd37-c32c-4f01-9e1a-c8ab152af490\",\n * \"firstName\": \"Adam Smith \",\n * \"email\": \"asmith@amail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * },\n * \"previousBooking\": {\n * \"_id\": \"9f5a05d6-2fb4-4de8-990d-12db585d25c5\",\n * \"bookedResources\": [{\n * \"_id\": \"6dd5e48d-9e6d-4e74-bf61-e103e8d52575\",\n * \"name\": \"Jane Doe\",\n * \"email\": \"Doe\"\n * }],\n * \"status\": \"CONFIRMED\",\n * \"_createdDate\": \"2021-02-28T18:11:56.177Z\",\n * \"attendanceInfo\": {\n * \"attendanceStatus\": true,\n * \"numberOfAttendees\": 1\n * },\n * \"bookingSource\": {\n * \"platform\": \"WEB\",\n * \"actor\": \"BUSINESS\",\n * \"appDefId\": \"13d21c63-b5ec-5912-8397-c3a5ddb27a97\",\n * \"appName\": \"Wix Bookings\"\n * },\n * \"bookedEntity\": {\n * \"serviceId\": \"2e80e5e0-2385-49c7-9f9f-2e59a3566809\",\n * \"scheduleId\": \"f1945fde-d567-4ebc-85ef-dd1d52327c11\",\n * \"singleSession\": {\n * \"sessionId\": \"2mmoW0vwKcSFyxtOfCdMhFC1gAivXqAQVAQP0hHoOUADs242fBtwKRY3sHLMmbVxJ75TQ4G6BkCe6z1E1fVT6gUPWDDNF4WX2S6P\",\n * \"start\": \"2021-03-18T19:00:00.000Z\",\n * \"end\": \"2021-03-18T20:00:00.000Z\"\n * },\n * \"title\": \"Appointment service\",\n * \"rate\": {\n * \"labeledPriceOptions\": {\n * \"general\": {\n * \"amount\": \"10\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * }\n * }\n * },\n * \"tags\": [\"INDIVIDUAL\"],\n * \"location\": { \"locationType\": \"OWNER_BUSINESS\" }\n * },\n * \"paymentDetails\": {\n * \"balance\": {\n * \"finalPrice\": {\n * \"amount\": \"10\",\n * \"currency\": \"USD\",\n * \"downPayAmount\": \"0\"\n * },\n * \"amountReceived\": \"0\"\n * },\n * \"state\": \"PENDING_MARK_AS_PAID\",\n * \"wixPayMultipleDetails\": [{\n * \"txId\": \"c1cef510-e382-4c1c-aeec-4300cfea219a\",\n * \"orderId\": \"179c361c-8a04-4f78-b28f-065b62cf4806\",\n * \"orderAmount\": \"10\",\n * \"paymentVendorName\": \"inPerson\",\n * \"orderApprovalTime\": null\n * }]\n * },\n * \"formInfo\": {\n * \"paymentSelection\": [{\n * \"rateLabel\": \"general\",\n * \"numberOfParticipants\": 1\n * }],\n * \"additionalFields\": [{\n * \"_id\": \"00000000-0000-0000-0000-000000000008\",\n * \"label\": \"Add Your Message\",\n * \"valueType\": \"LONG_TEXT\"\n * }],\n * \"contactDetails\": {\n * \"contactId\": \"baf3cd37-c32c-4f01-9e1a-c8ab152af490\",\n * \"firstName\": \"Adam Smith \",\n * \"email\": \"asmith@amail.com\",\n * \"phone\": \"9998765\",\n * \"timeZone\": \"America/New_York\",\n * \"countryCode\": \"US\"\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingEvent","referenceFqn":"Events.BookingEvent"},"description":"Information about an updated booking."}],"description":"An event that fires when a booking's details are updated.\r\n\r\nThe `onBookingUpdated()` event handler runs when a booking's details are updated.\r\n\r\nThe `event` object includes a `trigger` property that describes the action that triggered the event. The `trigger` value for this event is `\"OWNER_UPDATED_ATTENDANCE\"` when the business updates the booking's attendance information.\r\n\r\n> **Note:** Backend events don't work when previewing your site."}],"webhooks":[],"articles":[{"content":"# Introduction\nWix Bookings events are fired in your site's backend when certain events occur in your site's Bookings application.\n You can write event handlers that react to these events. Event handler functions\n receive data that correspond to the event that has occurred. Use event handlers\n to create custom responses to bookings events.\n\n To add a bookings event handler, add an **events.js** file to the **Backend** section\n of your site if one does not already exist. All event handler functions for your\n site are defined in this file.\n\n Event handler functions are defined using the following pattern:\n\n ```javascript\n export function _(event) { }\n ```\n\n For example, an event handler that handles a new booking request looks\n like this:\n\n ```javascript\n export function wixBookings_onBookingRequestCreated(event) { }\n ```\n\n > **Note:** Backend events don't work when previewing your site.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Resources","slug":"resources","fqn":"Resources","standaloneTypes":[],"metadata":{},"actions":[{"name":"createResource","fqn":"Resources.createResource","slug":"create-resource","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["resourceInfo","scheduleInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Resource","referenceFqn":"Resource"},"description":"Fulfilled - Resource"},"examples":[{"title":"Create a resource using the business's hours for the resource's availability","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { resources } from \"wix-bookings-backend\";\n\nexport const getBusinessSchedule = webMethod(Permissions.Anyone, () => {\n return resources\n .queryResourceCatalog()\n .eq(\"slugs.name\", \"business\")\n .find()\n .then((results) => {\n const businessResource = results.items[0].resource;\n return businessResource;\n });\n});\n\nexport const createStaffWithBusinessHours = webMethod(\n Permissions.Anyone,\n async (staffInfo) => {\n staffInfo = {\n name: \"John Doe\",\n email: \"john@doe.com\",\n phone: \"555 4567\",\n description: \"Fitness Instructor\",\n };\n\n const businessResource = await getBusinessSchedule();\n const businessResourceScheduleId = businessResource.scheduleIds[0];\n const schedules = [\n {\n availability: {\n linkedSchedules: [\n {\n scheduleId: businessResourceScheduleId,\n },\n ],\n start: new Date(),\n },\n },\n ];\n const resource = {\n name: staffInfo.name,\n email: staffInfo.email,\n phone: staffInfo.phone,\n description: staffInfo.description,\n tags: [\"staff\"],\n };\n const options = { suppressAuth: true };\n\n return resources\n .createResource(resource, schedules, options)\n .then((resource) => {\n return resource;\n })\n .catch((error) => {\n console.error(\"Failed to create resource: \", error);\n return error;\n });\n }\n);\n\n/* Example of a returned resource:\n * \"_id\": \"6235c808-c3c6-49f2-a000-bc8eded9f106\",\n * \"name\": \"John Doe\",\n * \"email\": \"john@doe.com\",\n * \"phone\": \"555 4567\",\n * \"description\": \"Fitness Instructor\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"a5d20a3a-eb25-497a-9fc1-f546ac8422fc\"\n * ],\n * \"status\": \"CREATED\"\n */"},{"title":"Create a resource with its own schedule","description":"Create a resource, then create 2 recurring sessions on Mondays and Wednesdays from 10 AM to 4 PM.","content":"\nimport { Permissions, webMethod } from \"wix-web-module\";\nimport { resources, sessions } from \"wix-bookings-backend\";\n\nexport const createResourceWithRecurringSession = webMethod(Permissions.Anyone, async () => {\n let staffInfo = {\n 'name': \"John W. Doe\",\n 'email': \"john@doe.com\",\n 'phone': \"555 4567\",\n 'description': \"Fitness Instructor\"\n };\n\n \n const resource = {\n name: staffInfo.name,\n email: staffInfo.email,\n phone: staffInfo.phone,\n description: staffInfo.description,\n tags: ['staff'],\n };\n\n const resourceSchedule = [{\n availability: {\n linkedSchedules: [],\n start: new Date()\n }\n }];\n const options = { suppressAuth: true }\n let newResource;\n\n try {\n newResource = await resources.createResource(resource, resourceSchedule, options)\n } catch (error) {\n console.error('Failed to create resource: ', error);\n return error;\n }\n\n let recurringSession = {\n scheduleId: newResource.scheduleIds[0],\n start: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 10,\n minutesOfHour: 0\n }\n },\n end: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 16,\n minutesOfHour: 0\n }\n },\n type: 'AVAILABILITY',\n recurrence: 'FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;UNTIL=20220101T000000Z'\n };\n\n let recurrenceRules = ['FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;UNTIL=20220101T000000Z']\n recurrenceRules.push('FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z')\n\n let promiseList = [];\n recurrenceRules.forEach(rule => {\n try {\n recurringSession.recurrence = rule;\n console.log(\"recurringSession\", recurringSession)\n promiseList.push(sessions.createSession(recurringSession, options))\n } catch (error) {\n console.error('Failed to create session:', error);\n }\n })\n\n return Promise.all(promiseList)\n .then(sessions => {\n const resourceSessions = {\n resource: newResource,\n sessions: sessions\n };\n return resourceSessions;\n })\n .catch((error) => {\n console.error(error)\n })\n});\n\n /* Example returned object:\n *\n * {\n * \"resource\": {\n * \"_id\": \"09ca6193-3532-4c55-bed6-5ebf8608684f\",\n * \"name\": \"John W. Doe\",\n * \"email\": \"john@doe.com\",\n * \"phone\": \"555 4567\",\n * \"description\": \"Fitness Instructor\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"62e49e88-c668-46a2-9033-3a0cf09013e7\"\n * ],\n * \"status\": \"CREATED\"\n * },\n * \"sessions\": [\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 16,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"_id\": \"62e49e88c66846a290333a0cf09013e7-4eb49d5842a049fbbbc1742dd1b6ac7d\",\n * \"notes\": \"\",\n * \"recurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;UNTIL=20220101T000000Z\",\n * \"scheduleId\": \"62e49e88-c668-46a2-9033-3a0cf09013e7\",\n * \"scheduleOwnerId\": \"09ca6193-3532-4c55-bed6-5ebf8608684f\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 16,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"_id\": \"62e49e88c66846a290333a0cf09013e7-0f43ee04eaa6430f849b210531ce2854\",\n * \"notes\": \"\",\n * \"recurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z\",\n * \"scheduleId\": \"62e49e88-c668-46a2-9033-3a0cf09013e7\",\n * \"scheduleOwnerId\": \"09ca6193-3532-4c55-bed6-5ebf8608684f\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n * ]\n */ \n"}],"actionParams":[{"name":"resourceInfo","slug":"resource-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ResourceInfo","referenceFqn":"Resources.ResourceInfo"},"description":"Information to use when creating a resource."},{"name":"scheduleInfo","slug":"schedule-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ResourceScheduleInfo","referenceFqn":"Resources.ResourceScheduleInfo"}},"description":"List of schedules to be assigned to the created resource. Currently only a single schedule is allowed. If provided, any additional schedules in the resource object will be ignored."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for creating a resource."}],"description":"Creates a resource.\r\n\r\n\r\n The `createResource()` function returns a Promise that resolves to the created resource.\r\n\r\n\r\n 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.\r\n 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.\r\n You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.\r\n\r\n \r\n When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:\r\n+ 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.\r\n+ 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.\r\n+ You can have both default business hours and custom hours for the same resource schedule by combining the steps above.\r\n\r\n> **Notes:**\r\n> + 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.\r\n> + The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.\r\n> + You can only add the business resource's schedule as a linked schedule for a resource.\r\n> + A resource can have one schedule only.\r\n> + You can have up to 135 active resources and an additional 135 deleted resources.\r\n> + 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`.\r\n\r\n\r\n**Notes:**\r\n> + A resource can have one schedule only.\r\n> + You can have up to 135 active resources and an additional 135 deleted resources."},{"name":"deleteResource","fqn":"Resources.deleteResource","slug":"delete-resource","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["resourceId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the deleted resource."},"examples":[{"title":"Delete a resource","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { resources } from 'wix-bookings-backend';\n\nexport const myDeleteResource = webMethod(Permissions.Anyone, (resourceId) => {\n const options = { suppressAuth: true };\n return resources.deleteResource(resourceId, options)\n .then((deletedResource) => {\n return deletedResource;\n })\n .catch((error) => {\n return error;\n });\n});\n\n// Resolves to a string containing the deleted resource ID.\n// For example: \"3f9215e0-7e96-417f-9c16-628e71c77311\""}],"actionParams":[{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the resource to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for deleting a resource."}],"description":"Deletes a resource.\r\n\r\nThe `deleteResource()` function returns a Promise that resolves to the resource ID when the resouce is deleted.\r\nDeleting a resource updates its `status` to `\"DELETED\"`.\r\n\r\nYou cannot delete a resource if it has booked sessions.\r\n\r\n\r\n>**Notes:**\r\n> + 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.\r\n> + You can have up to 135 active resources and an additional 135 deleted resources.\r\n> + 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`.\r\n\r\n**Notes:**\r\n> + 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.\r\n> + You can have up to 135 active resources and an additional 135 deleted resources."},{"name":"queryResourceCatalog","fqn":"Resources.queryResourceCatalog","slug":"query-resource-catalog","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object that contains the refined query"},"examples":[{"title":"Create a query, add an eq filter, and run it","description":" \n\n","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nreturn resources.queryResourceCatalog()\n .eq(\"_id\",\"290113d8-e525-4619-a154-b0c45110348f\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n return results.items;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n /* Returns a promise that resolves to an array of resourceCatalog objects:\n *\n * [\n * {\n * \"resource\": {\n * \"_id\": \"290113d8-e525-4619-a154-b0c45110348f\",\n * \"name\": \"Jack Brown\",\n * \"email\": \"jbrown@test.com\",\n * \"phone\": \"555 4321\",\n * \"description\": \"Instructor\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"95d8769e-ce74-4fe2-ab79-ab24e5c14e0e\"\n * ],\n * \"status\": \"UPDATED\"\n * },\n * \"schedules\": [\n * {\n * \"availability\": {\n * \"linkedSchedules\": [\n * {\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\"\n * }\n * ],\n * \"start\": \"2021-04-18T07:22:42.274Z\"\n * },\n * \"_id\": \"95d8769e-ce74-4fe2-ab79-ab24e5c14e0e\",\n * \"scheduleOwnerId\": \"290113d8-e525-4619-a154-b0c45110348f\"\n * }\n * ],\n * \"slugs\": [\n * {\n * \"_createdDate\": \"2021-04-18T07:22:43.392Z\",\n * \"name\": \"jack-brown\"\n * }\n * ]\n */ "}],"description":"Creates a query to retrieve extended resource information.\r\n\r\n\r\nThe `queryResourceCatalog()` function builds a query to retrieve a catalog of resources, including resources' related schedules and slugs, and returns a [`ResourceCatalogQueryBuilder`](wix-bookings-backend.resources/resourcecatalogquerybuilder/introduction) object.\r\nThe returned object contains the query definition, which is typically used to run the query using the [`find()`](#find) function.\r\n\r\nThe `ResourceCatalogQueryBuilder` functions enable you to run, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using the resource catalog query function,\r\nrefine the query by chaining `ResourceCatalogQueryBuilder` functions, and then execute the\r\nquery by chaining the `find()` function.\r\n\r\n\r\nThe query runs with the following `ResourceCatalogQueryBuilder` defaults that you can override:\r\n\r\n+ [`skip`](wix-bookings-backend.Resources.resourcecatalogquerybuilder.html.#skip): `0`\r\n+ [`limit`](wix-bookings-backend.Resources.resourcecatalogquerybuilder.html.#limit): `50`\r\n\r\nThe following query builder functions are supported for `queryResourceCatalog()`. \r\n|Property|Supported Filters |\r\n|--|--|\r\n|`_id`|[`eq()`](wix-bookings-backend.Resources/resourcecatalogquerybuilder/eq)| \r\n|`slugs.name` | [`eq()`](wix-bookings-backend.Resources/resourcecatalogquerybuilder/eq), [`hasSome()`](wix-bookings-backend.Resources/resourcecatalogquerybuilder/hasSome)| \r\n\r\nFor a full description of the Resources object, see the object returned for the [`items`](wix-bookings-backend.resources/resourcecatalogqueryresult/items) array in `ResourceCatalogQueryResult`.\r\n\r\n>**Note:**\r\n> Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can query resources."},{"name":"updateResource","fqn":"Resources.updateResource","slug":"update-resource","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["id","resourceInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Resource","referenceFqn":"Resource"},"description":"Fulfilled - Updated resource"},"examples":[{"title":"Update a resource, changing its phone and email","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { resources } from \"wix-bookings-backend\";\n\nexport const myUpdateResource = webMethod(Permissions.Anyone, async (resourceId) => {\n const newPhone = \"7778521\";\n const newEmail = \"tomjones@yoga.com\";\n const options = { suppressAuth: true };\n\n try {\n const updatedResource = await resources.updateResource(resourceId, { phone: newPhone, email: newEmail }, options);\n return updatedResource;\n } catch (error) {\n console.error(\"Failed to update resource: \", error);\n return error;\n }\n});\n\n/* Updated resource:\n *\n * {\n * \"_id\": \"dc19d7db-6996-494b-8d6d-943d64e1f32a\",\n * \"name\": \"Tom Jones\",\n * \"email\": \"tomjones@yoga.com\",\n * \"phone\": \"7778521\",\n * \"description\": \"Yoga and self-defense instructor.\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"8fbeefbb-76dc-4f67-b292-66e871d5984a\"\n * ],\n * \"status\": \"UPDATED\"\n * }\n */"}],"actionParams":[{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the resource to be updated."},{"name":"resourceInfo","slug":"resource-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateResourceInfo","referenceFqn":"Resources.UpdateResourceInfo"},"description":"Resource information to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for updating a resource."}],"description":"Updates a resource.\r\n\r\n\r\nThe `updateResource()` function returns a Promise that resolves when a resource is updated.\r\n\r\nUse 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).\r\n\r\n\r\n>**Notes:**\r\n> + 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\"`.\r\n> + 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`.\r\n\r\n**Note:** 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\"`."},{"name":"updateResourceSchedule","fqn":"Resources.updateResourceSchedule","slug":"update-resource-schedule","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["resourceId","scheduleId","scheduleInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceSchedule","referenceFqn":"Resources.ResourceSchedule"}},"examples":[{"title":"Update a resource's schedule from business to custom hours","description":"Update a resource's schedule from the business's default working hours to 2 custom days per week.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { resources, sessions } from 'wix-bookings-backend';\n\nexport const getResourceById = webMethod(Permissions.Anyone, async (resourceId) => {\n return resources.queryResourceCatalog()\n .eq(\"_id\", resourceId)\n .find()\n .then((results) => {\n if (results.items.length > 0)\n return results.items[0].resource\n })\n});\n\nexport const updateResourceToCustomHours = webMethod(Permissions.Anyone, async (resourceId) => {\n let resource = await getResourceById(resourceId);\n let recurrenceRules = ['FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;UNTIL=20220101T000000Z'];\n recurrenceRules.push('FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z');\n let recurringSession = {\n scheduleId: resource.scheduleIds[0],\n start: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 10,\n minutesOfHour: 0\n }\n },\n end: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 16,\n minutesOfHour: 0\n }\n },\n type: 'WORKING_HOURS',\n recurrence: 'placeholder'\n };\n let updateResourceScheduleInfo = {\n availability: {\n linkedSchedules: []\n }\n };\n try {\n var resourceSchedule = await resources.updateResourceSchedule(resourceId, resource.scheduleIds[0], updateResourceScheduleInfo);\n } catch (error) {\n console.error('Failed to update resource: ', error);\n }\n let promiseList = [];\n recurrenceRules.forEach(rule => {\n try {\n recurringSession.recurrence = rule;\n console.log(\"Rec sess\", rule, recurringSession)\n promiseList.push(sessions.createSession(recurringSession, []));\n } catch (error) {\n console.error('Failed to create session:', error);\n }\n })\n return Promise.all(promiseList)\n .then(sessions => {\n const resourceSessions = {\n resource: resource,\n schedule: resourceSchedule,\n sessions: sessions\n };\n return resourceSessions;\n })\n .catch((error) => {\n console.error(error);\n })\n});\n"},{"title":"Update a resource's schedule from custom to business hours","description":"\n","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { resources } from \"wix-bookings-backend\";\n\nexport const getBusinessSchedule = webMethod(Permissions.Anyone, async () => {\n return resources\n .queryResourceCatalog()\n .eq(\"slugs.name\", \"business\")\n .find()\n .then((results) => {\n const businessResource = results.items[0].resource;\n return businessResource;\n });\n});\n\nexport const updateResourceToBusinessHours = webMethod(\n Permissions.Anyone,\n async (resourceId) => {\n const businessResource = await getBusinessSchedule();\n const businessResourceScheduleId = businessResource.scheduleIds[0];\n\n const result = await resources\n .queryResourceCatalog()\n .eq(\"_id\", resourceId)\n .find();\n const resource = result.items[0].resource;\n const scheduleId = resource.scheduleIds[0];\n\n let updateResourceScheduleInfo = {\n availability: {\n linkedSchedules: [\n {\n scheduleId: businessResourceScheduleId,\n },\n ],\n start: new Date(),\n },\n };\n\n return resources\n .updateResourceSchedule(resourceId, scheduleId, updateResourceScheduleInfo)\n .then((schedule) => {\n return schedule;\n })\n .catch((error) => {\n console.error(\"Failed to update resource schedule: \", error);\n return error;\n });\n }\n);\n\n/* Example returned schedule:\n *\n * {\n * \"_id\": \"9f372f46-cf75-49d2-837a-9c013525e17f\",\n * \"scheduleOwnerId\": \"bbed138b-f7c6-497c-b5bf-0fcf9389018d\",\n * \"availability\": {\n * \"linkedSchedules\": [\n * {\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\"\n * }\n * ],\n * \"start\": \"2021-04-28T17:07:29.124Z\"\n * }\n * }\n */"}],"actionParams":[{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource ID to update."},{"name":"scheduleId","slug":"schedule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Schedule ID."},{"name":"scheduleInfo","slug":"schedule-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ResourceScheduleInfo","referenceFqn":"Resources.ResourceScheduleInfo"},"description":"Updated schedule information."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for updating a resource schedule."}],"description":"Updates a resource's schedule.\r\n\r\n\r\nThe `updateResourceSchedule()` function returns a Promise that resolves when a resource's schedule has been updated.\r\nUse this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](wix-bookings-backend/resources/updateresource).\r\n\r\nThe following schedule properties can be updated:\r\n+ `availability.start`\r\n + `availability.linkedSchedules`\r\n\r\n**Update a resource's schedule to remove business hours and add custom hours.**\r\n \r\n\r\n+ Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to remove the business's scheduleId from the `availability.linkedSchedules` array.\r\n+ 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.\r\n\r\n\r\n**Update a resource's schedule to add default business hours, and keep or remove custom hours.**\r\n\r\n\r\n+ Use [`updateResourceSchedule()`](wix-bookings-backend.Resources/updateresourcesession) to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.\r\n+ 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.\r\n> **Notes:**\r\n> + 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.\r\n> + A resource can have one schedule only.\r\n> + A resource can have both default business hours and custom hours in its schedule.\r\n> + 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”.\r\n> + 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`."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe Bookings Resources API provides functionality for creating, managing, and querying resources.\n\nA resource is a business asset like a staff member, or equipment needed to provide a service.\nEach 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.\n\nResources have tags that you can use for grouping. For example, add a `\"room\"` tag for classroom resources and an `\"equipment\"` tag for resources like computers and projectors.\n\nThere are 2 tags that are used by the Wix Bookings app:\n+ `\"staff\"`: Resources with the `\"staff\"` tag appear in the Bookings app's **Staff** page. \n+ `\"business\"`: The Bookings app creates a resource with a name and tag value of `\"business\"`. This resource owns a schedule that contains the operating hours of the business and cannot be deleted. This schedule is used when creating resources that use the business’s operating hours for the resource's working hours.\n\nYou can have up to 135 active resources and an additional 135 deleted resources.\n\nTo use the Resources API, import `resources` from the `wix-bookings-backend` module:\n\n```javascript\nimport { resources } from \"wix-bookings-backend\";\n```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"ResourceCatalogQueryBuilder","slug":"resource-catalog-query-builder","fqn":"Resources.ResourceCatalogQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"eq","fqn":"Resources.ResourceCatalogQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let query = resources.queryResourceCatalog().eq(\"_id\",\"3f9215e0-7e96-417f-9c16-628e71c77311\");"},{"title":"Create a query, add an equals filter, and run it","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .eq(\"slugs.name\",\"john-smith\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `slugs.name`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `ResourceCatalogQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Resources.ResourceCatalogQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Perform a find on a query","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Perform a find on a query using options","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\nconst options = {\n \"suppressAuth\": true\n};\n\nresources.queryResourceCatalog()\n .find(options)\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Resources.ResourceCatalogQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the resource catalog items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n Use the `options` parameter to run `find()` without checking for permissions."},{"name":"hasSome","fqn":"Resources.ResourceCatalogQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a hasSome filter to a query","content":"let query = resources.queryResourceCatalog().hasSome(\"slugs.name\", [\"john-smith\", \"jane-doe\", \"jack-black\"]);"},{"title":"Create a query, add a hasSome filter, and run it","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .hasSome(\"slugs.name\", [\"john-smith\", \"jane-doe\", \"jack-black\"])\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `_id`\r\n+ `slugs.name`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `ResourceCatalogQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"limit","fqn":"Resources.ResourceCatalogQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a limit to a query","content":"let query = resources.queryResourceCatalog().limit(10);"},{"title":"Create a query, add a limit, and run it","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next)\r\n and [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"skip","fqn":"Resources.ResourceCatalogQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder","description":"A `ResourceCatalogQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a skip to a query","content":"let query = resources.queryResourceCatalog().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .skip(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `ResourceCatalogQueryBuilder` functions enable you to run, filter, and control\n which results a query returns.\n\n Typically, you build a query using the resource catalog query function,\n refine the query by chaining `ResourceCatalogQueryBuilder` functions, and then execute the\n query by chaining the [`find()`](wix-bookings-backend.Resources/resourcescatalogquerybuilder/find) function.\n\nFor example, the following code queries extended resource information where the slug name is \"john-doe\", and logs the first 5 results to the console:\n\n```javascript\nimport { resources } from 'wix-bookings-backend';\n\nresources.resourceCatalogQueryBuilder.queryResourceCatalog()\n .eq(\"slugs.name\", \"john-doe\")\n .limit(5)\n .find()\n .then( (results) => {\n console.log(results.items);\n });","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"ResourceCatalogQueryResult","slug":"resource-catalog-query-result","fqn":"Resources.ResourceCatalogQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Resources.ResourceCatalogQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { resources } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await resources.queryResourceCatalog()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Resources.ResourceCatalogQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates the query has previous results."},{"name":"next","fqn":"Resources.ResourceCatalogQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { resources } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await resources.queryResourceCatalog()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `ResourceCatalogQueryResult` may change."},{"name":"prev","fqn":"Resources.ResourceCatalogQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ResourceCatalogQueryResult","referenceFqn":"Resources.ResourceCatalogQueryResult.ResourceCatalogQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/find)\n function, it returns a Promise that resolves to a `ResourceCatalogQueryResult` object.\n This object contains the items that match the query, information about the\n query itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"let resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let resultPage = results.currentPage; // 0\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the resource catalog items from the result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n /* items:\n * \n * [\n * {\n * \"resource\": {\n * \"_id\": \"2015d816-4ae1-4eb3-8f93-3c97441b5832\",\n * \"name\": \"John Doe\",\n * \"email\": \"john@doe.com\",\n * \"phone\": \"555 4567\",\n * \"description\": \"Fitness Instructor\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"3ade521f-ba4e-4782-977c-0efe84e7c797\"\n * ],\n * \"status\": \"UPDATED\"\n * },\n * \"schedules\": [\n * {\n * \"availability\": {\n * \"linkedSchedules\": [],\n * \"start\": \"2021-01-01T06:00:00Z\"\n * },\n * \"_id\": \"3ade521f-ba4e-4782-977c-0efe84e7c797\",\n * \"scheduleOwnerId\": \"2015d816-4ae1-4eb3-8f93-3c97441b5832\"\n * }\n * ],\n * \"slugs\": [\n * {\n * \"_createdDate\": \"2021-04-12T11:49:50.416Z\",\n * \"name\": \"john-doe-6\"\n * }\n * ]\n * },\n * {\n * \"resource\": {\n * \"_id\": \"290113d8-e525-4619-a154-b0c45110348f\",\n * \"name\": \"Jack Brown\",\n * \"email\": \"jbrown@test.com\",\n * \"phone\": \"555 4321\",\n * \"description\": \"Instructor\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"95d8769e-ce74-4fe2-ab79-ab24e5c14e0e\"\n * ],\n * \"status\": \"UPDATED\"\n * },\n * \"schedules\": [\n * {\n * \"availability\": {\n * \"linkedSchedules\": [\n * {\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\"\n * }\n * ],\n * \"start\": \"2021-04-18T07:22:42.274Z\"\n * },\n * \"_id\": \"95d8769e-ce74-4fe2-ab79-ab24e5c14e0e\",\n * \"scheduleOwnerId\": \"290113d8-e525-4619-a154-b0c45110348f\"\n * }\n * ],\n * \"slugs\": [\n * {\n * \"_createdDate\": \"2021-04-18T07:22:43.392Z\",\n * \"name\": \"jack-brown\"\n * }\n * ]\n * },\n * {\n * \"resource\": {\n * \"_id\": \"4c17a7cc-c1d8-4fd1-aacd-0768df100b6d\",\n * \"name\": \"Joe Blue\",\n * \"email\": \"jb@gmail.com\",\n * \"description\": \"Joe is a good guy\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"d165e99c-bae4-4e6f-a064-7d4108902be0\"\n * ],\n * \"status\": \"UPDATED\"\n * },\n * \"schedules\": [\n * {\n * \"availability\": {\n * \"linkedSchedules\": [\n * {\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\"\n * }\n * ],\n * \"start\": \"2021-03-24T16:08:16.832Z\"\n * },\n * \"_id\": \"d165e99c-bae4-4e6f-a064-7d4108902be0\",\n * \"scheduleOwnerId\": \"4c17a7cc-c1d8-4fd1-aacd-0768df100b6d\"\n * }\n * ],\n * \"slugs\": [\n * {\n * \"_createdDate\": \"2021-01-18T10:41:31.652Z\",\n * \"name\": \"joe-blue\"\n * }\n * ]\n * },\n * {\n * \"resource\": {\n * \"_id\": \"b5147aad-f117-4f8e-90fe-d61043112c94\",\n * \"name\": \"Joe Smith\",\n * \"email\": \"js@s.com\",\n * \"phone\": \"8888\",\n * \"description\": \"\",\n * \"tags\": [\n * \"staff\"\n * ],\n * \"scheduleIds\": [\n * \"892714a8-01f6-491c-b07c-89ae4f416dc0\"\n * ],\n * \"status\": \"UPDATED\"\n * },\n * \"schedules\": [\n * {\n * \"availability\": {\n * \"linkedSchedules\": [\n * {\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\"\n * }\n * ],\n * \"start\": \"2021-01-01T06:00:00Z\"\n * },\n * \"_id\": \"892714a8-01f6-491c-b07c-89ae4f416dc0\",\n * \"scheduleOwnerId\": \"b5147aad-f117-4f8e-90fe-d61043112c94\"\n * }\n * ],\n * \"slugs\": [\n * {\n * \"_createdDate\": \"2021-01-25T18:10:42.682Z\",\n * \"name\": \"joe-smith\"\n * }\n * ]\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ResourceQueryResults","referenceFqn":"Resources.ResourceQueryResults"}},"description":"Returns an array of resources, slugs, and schedules that match the query.\r\n\r\nThe current page of resources, slugs, and schedules retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.\r\n\r\n When no items match the query, the array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the length of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the length of the result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let resultLength = results.length; // 20\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the query result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let resultPageSize = results.pageSize; // 50\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"let resultQuery = results.query;"},{"title":"Perform a query, get the query that produced the results and modify it","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let newQuery = results.query;\n newQuery\n .eq(\"slugs.name\",\"john-doe\")\n .find()\n .then((newQueryResults) => {\n let firstItem = newQueryResults.items[0];\n })\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"REFERENCE","name":"ResourceCatalogQueryBuilder","referenceFqn":"Resources.ResourceCatalogQueryBuilder.ResourceCatalogQueryBuilder"},"description":"Returns the ResourceCatalogQueryBuilder object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional `ResourceCatalogQueryBuilder` functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a query and get the number of items in the result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let resultCount = results.totalCount; // 150\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"let resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the query result","content":"import { resources } from \"wix-bookings-backend\";\n\n// ...\n\nresources.queryResourceCatalog()\n .find()\n .then((results) => {\n let resultPages = results.totalPages; // 3\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)\r\n function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and\r\n navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and\r\n [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions."}]}],"builderTypes":[],"properties":[]},{"name":"Sessions","slug":"sessions","fqn":"Sessions","standaloneTypes":[],"metadata":{},"actions":[{"name":"createSession","fqn":"Sessions.createSession","slug":"create-session","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["sessionInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Session","referenceFqn":"Sessions.Session"},"description":"Fulfilled - Session."},"examples":[{"title":"Create a session.","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { sessions } from \"wix-bookings-backend\";\n\nexport const createNonRecurringSessions = webMethod(Permissions.Anyone, (scheduleId) => {\n const sessionInfo = {\n scheduleId,\n start: {\n timestamp: new Date(\"2021-02-15T12:00:00.000-07:00\"),\n },\n end: {\n timestamp: new Date(\"2021-02-15T13:00:00.000-07:00\"),\n },\n type: \"WORKING_HOURS\",\n };\n\n const options = { suppressAuth: true };\n\n return sessions\n .createSession(sessionInfo, options)\n .then((session) => {\n return session;\n })\n .catch((error) => {\n console.error(\"Failed to create session:\", error);\n });\n});\n\n/* Returns a Promise that resolves to a session object:\n * {\n * \"_id\": \"2mmoW0vwKcSFyxtOfCdMhHQCHOQ1j8BjlhonXsthFhhClxedYCD7W67Dzj8Gcsw0EBU60ml88FFboL9qt39lLftLn3tcMtFZoPu9\",\n * \"notes\": \"\",\n * \"scheduleId\": \"aec380c0-ca2c-43c2-98f4-9aebbd3276f3\",\n * \"scheduleOwnerId\": \"2a843db6-cb3f-4c96-90b8-f2f6e0055cae\",\n * \"start\": {\n * \"timestamp\": \"2021-02-15T19:00:00.000Z\"\n * },\n * \"end\": {\n * \"timestamp\": \"2021-02-15T20:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n */"},{"title":"Create a recurring session for a resource.","description":"","content":"\nimport { Permissions, webMethod } from \"wix-web-module\";\nimport { sessions } from \"wix-bookings-backend\";\n\nexport const createRecurringSessions = webMethod(Permissions.Anyone, (scheduleId) => {\n const recurringSession = {\n scheduleId,\n start: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 9,\n minutesOfHour: 0,\n },\n },\n end: {\n localDateTime: {\n year: 2021,\n monthOfYear: 3,\n dayOfMonth: 1,\n hourOfDay: 17,\n minutesOfHour: 0,\n },\n },\n type: \"WORKING_HOURS\",\n recurrence: \"FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z\",\n };\n const options = { suppressAuth: true };\n\n return sessions\n .createSession(recurringSession, options)\n .then((session) => {\n return session;\n })\n .catch((error) => {\n console.error(\"Failed to create session:\", error);\n });\n});\n\n/* Returns a Promise that resolves to a session object:\n * {\n * \"_id\": \"aec380c0ca2c43c298f49aebbd3276f3-10c6d84adc9247e7b9cd17e12b01addc\",\n * \"notes\": \"\",\n * \"recurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z\",\n * \"scheduleId\": \"aec380c0-ca2c-43c2-98f4-9aebbd3276f3\",\n * \"scheduleOwnerId\": \"2a843db6-cb3f-4c96-90b8-f2f6e0055cae\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 9,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 17,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n */\n"}],"actionParams":[{"name":"sessionInfo","slug":"session-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SessionInfo","referenceFqn":"Sessions.SessionInfo"},"description":"Information to use when creating a session.."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for creating a session."}],"description":"Creates a session.\r\n\r\n\r\nThe `createSession()` function returns a Promise that resolves when a session is created.\r\n\r\n\r\nA session is one of the following:\r\n+ `\"EVENT\"`: Reserved period of time on any [schedule](wix-bookings-backend.sessions/introduction#schedules). For example, an appointment, class, or course. Events are visible in the Dashboard in the Bookings app's [**Booking Calendar**](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page. Set `type` to `\"EVENT\"` when creating sessions that reserve time on a service's schedule, or when creating a blocked time for a resource. \r\n+ `\"WORKING_HOURS\"`: Placeholder for available time on a resource’s schedule. Set `type` to `\"WORKING_HOURS\"` when creating sessions for resource availability.\r\n\r\nSessions belong to a schedule. Schedules are owned by a resource or a service.\r\n\r\nA session may be an individual session or a recurring session. \r\nAn individual session has a discrete start and end date, while a recurring session defines a series of repeating sessions. An instance of a recurring session is a specific session in a series of repeating sessions, generated according to the recurrence rule.\r\nThe `start` and `end` properties set the time and duration of the session. For non-recurring sessions, you can use either the `timestamp` or `localDateTime` properties. \r\nFor recurring sessions, use the `localDateTime` property only. For recurring sessions, the `start` property sets the date and time of the first recurring session, subject to the recurrence rule. For example, if you set the `start` to Saturday, May 1 and your recurrence rule says every second Monday, then the first session will only be on Monday, May 10. \r\n\r\nThe `year`, `monthOfYear` and `dayOfMonth` properties in the `end` property are used with the `hourOfDay` and `minutesOfHour` properties to set the duration of each session relative to the `start`.\r\nThe `UNTIL` keyword in the `recurrence` property sets the date for the last recurring session.\r\n\r\nYou can create a session that blocks hours on the resource's calendar, making the resource unavailable.\r\nCreate a non-recurring session of type `\"EVENT\"`, and add `\"Blocked\"` to the `tags` array.\r\n\r\n\r\n>**Notes:**\r\n> + For properties where there is no explicit timezone information, the timezone used is the business’s timezone.\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can create a session. You can override the permissions by setting the `suppressAuth` option to `true`.\r\n\r\n\r\n **Permissions**\r\n> This endpoint requires the Manage Bookings permissions scope"},{"name":"deleteSession","fqn":"Sessions.deleteSession","slug":"delete-session","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["sessionId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the deleted session."},"examples":[{"title":"Delete a session.","description":"","content":"\nimport { Permissions, webMethod } from \"wix-web-module\";\nimport { sessions } from \"wix-bookings-backend\";\n\nexport const myDeleteSession = webMethod(Permissions.Anyone, async (sessionId) => {\n const deleteSessionOptions = {\n suppressAuth: true,\n participantNotification: {\n notifyParticipants: true,\n },\n };\n try {\n const result = await sessions.deleteSession(sessionId, deleteSessionOptions);\n return result;\n } catch (error) {\n console.error(\"Delete session failed:\", error);\n }\n});\n\n/* Returns a Promise that resolves to a sessionId:\n *\n \"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTGcgvAnGyw6uKEiNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFkTukwrkodDkJBBtH3JaGj18FY3z9vvxDE0COr8D282JjVfq7YMAwQnTq4tYWYJkfPm7PDLI6zoWZREstI4jt6L0rFzLgnygdPd34xwV1XTWy29NYFXkahlmVNGcT28Psi8J35SjuXKVSpBiz8AbGJNwhVjBiZ8mSR1C8AqlOXknDFaYIQ2dd1Bsgub\"\n *\n */\n"}],"actionParams":[{"name":"sessionId","slug":"session-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the session to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteSessionOptions","referenceFqn":"Sessions.DeleteSessionOptions"},"description":"An object representing the available options for deleting a session."}],"description":"Deletes a session from a schedule.\r\n\r\n\r\nThe `deleteSession()` function returns a Promise that resolves to a session ID when the session has been deleted.\r\n\r\nUse the `participantNotification` property to send an email to the participants when the session is deleted.\r\nWhen deleting a session of type `\"EVENT\"` where a booking exists, the booking's status is updated to `\"CANCELED\"`.\r\nTo delete a set of recurring sessions, specify the session's `recurringSessionId` in the `sessionId` property in the parameters. \r\nWhen deleting a recurrence, only future instances of the recurrence are deleted.\r\n\r\n\r\n>**Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can delete a session. You can override the permissions by setting the `suppressAuth` option to `true`.\r\n\r\n\r\n **Permissions**\r\n> This endpoint requires the Manage Bookings permissions scope"},{"name":"getSession","fqn":"Sessions.getSession","slug":"get-session","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["sessionId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Session","referenceFqn":"Sessions.Session"},"description":"Fulfilled - Session."},"examples":[{"title":"Gets a session.","description":"","content":"\nimport { Permissions, webMethod } from \"wix-web-module\";\nimport { sessions } from \"wix-bookings-backend\";\n\nexport const myGetSession = webMethod(Permissions.Anyone, (sessionId) => {\n return sessions.getSession(sessionId, { suppressAuth: true })\n .then((session) => {\n return session\n })\n .catch((error) => {\n console.error(\"Failed to get the session:\", error);\n });\n});\n\n/* Returns a Promise that resolves to a session object:\n *\n * {\n * \"_id\":\"193...Jzp\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-01T15:00:00.000Z\"\n * }, \n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 11,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-01T16:00:00.000Z\"\n * },\n * \"notes\": \"\",\n * \"recurringSessionId\": \"53616b1f0c3c45a1b282675acd248179-44539bfb63ae496693109b6cb3a65a65\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"scheduleOwnerId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"status\": \"CONFIRMED\",\n * \"tags\": [\n * \"GROUP\"\n * ],\n * \"type\": \"EVENT\"\n * }\n */ \n"}],"actionParams":[{"name":"sessionId","slug":"session-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the session to retrieve."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for getting a session."}],"description":"Gets a session.\r\n\r\n\r\nThe `getSession()` function returns a Promise that resolves to a session with the specified session ID.\r\n\r\n> **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can view participant information in a retrieved session. You can override the permissions by setting the `suppressAuth` options to `true`.\r\n\r\n\r\n **Permissions**\r\n> This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope.\r\n> With the Read Bookings Calendar permission scope, the session participants are not returned."},{"name":"querySessions","fqn":"Sessions.querySessions","slug":"query-sessions","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Create a query, add filters, and run it","description":" \n","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nreturn sessions.querySessions()\n .eq(\"scheduleId\", \"9299760d-8a4a-4f89-b348-1fc611f4be17\")\n .ge(\"end.timestamp\",\"2020-01-01T08:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-06-01T08:00:00.000Z\")\n .limit(5)\n .find({suppressAuth:true})\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n return results.items;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n /* Returns a Promise that resolves to an array of sessions.\n *\n * [\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2020,\n * \"monthOfYear\": 12,\n * \"dayOfMonth\": 31,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2020-12-31T16:00:00.000Z\"\n * },\n * \"_id\": \"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTG\n * cgvAnGyw6uKEiNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFlTVokima8xqZJ3K8Mt5W8JtTsJi2KIa3BmFTWVGdkTgSQ0VtgHgVZWUkZS\n * JRO9bmwylbZ9RmiJAAXeHMH4peyCBj1KWkxLTM6V5DFXqC9xxWE2e937Uk4dGhLsygwwECBXVCm3dtPgBdoEgmrfEWBOCLZGxoanZBKNamF\n * FpYzUy2Anc7LTDAqZtUbN\",\n * \"notes\": \"An updated note\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-d0156d516f264989b727b0da13a42662\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2020,\n * \"monthOfYear\": 12,\n * \"dayOfMonth\": 31,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2020-12-31T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"EVENT\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 4,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-04T16:00:00.000Z\"\n * },\n * \"_id\": *\"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTGcgvAnGyw6uKE\n * iNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFlV7u2wmfZmcjnaGKeU15ZlbLQhG2uvyCf0hQuk6tKFmzj3xdqdDjdlKJCrJs2cslMgLxIotwGRWg\n * ipZJM2wzo6c2XCSUYjYWHe7FmpcExTyKZ2JUD9iftin96C2Y6nYREYoJMXYFzBBtdmoQprQkm5dXOPg2oUWasimBH1Y2EehSBEWVmKxAmH12IH\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-ecc4a5932acb4b7bb8c27c6ffb57fd49\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 4,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-04T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 6,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-06T16:00:00.000Z\"\n * },\n * \"_id\": *\"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTGcgvAnGyw6uKE\n * iNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFkPrsq3Jhjbq8UeqhF4rOEyqzl3ZcVqpQtlI8Yyo6yRlAnbAWq5pradMKsvlkHC4QPrB5AcrYvmfD\n * jteuRaWbm5JFSng4LouD3sCED8MUALsTSuUor4yNxYzE8aucYxUDpauUXDmkbSk0bmcpWVUwE6D79ogsY1libzXvGgJLxujpZFokC1fWNiLWwv\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-3d6b38529f544674a4976eca75e584ca\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 6,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-06T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 7,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-07T16:00:00.000Z\"\n * },\n * \"_id\": *\"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTGcgvAnGyw6uKE\n * iNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFlTVokima8xqZJ3K8Mt5W8JtTsJi2KIa3BmFTWVGdkTgSQ0VtgHgVZWUkZSJRO9bmwylbZ9RmiJAA\n * XeHMH4w0TkFE1ZSlf0MBCfuln4l0G7oKGKuO90Ai25Ud0wzQ6B6APNYOpsUkqppufK8twT7VYGmrozTLrL2zb01cFcL7bbssRdAFCskSZWbDaP\",\n * \"notes\": \"An updated note\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-d0156d516f264989b727b0da13a42662\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 7,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-07T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"EVENT\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 8,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-08T16:00:00.000Z\"\n * },\n * \"_id\": *\"4jOkD28c0FrsNUSgzQzuLRkA2t1rv1FLTwquKmJyctoZm00vdeKFMyH4n9cCLtmQe8wvOVwmsJCUCPWT3LA2geDOBViOg62YOeTGcgvAnGyw6uKE\n * iNVqqdHt8QVz4i7qMZu5irOPVjACrV2o5F5SFkTukwrkodDkJBBtH3JaGj18FY3z9vvxDE0COr8D282JjVfq7YMAwQnTq4tYWYJkfPm7PDLI6zoWZ\n * REstI4qEbt9u6qB3UHudvTCxqFYL1IOaWl48c2kHaCaEwfB53cbd5ndRAj4yv8JchSIwDa1rgxINU4JITqstE4QJ5FMugAnqVkzBjiH1P502ZB\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-6f9f945736fd4490b4b95fbb4b1326b3\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 8,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-08T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n * ]\n */"}],"description":"Retrieves a list of the sessions according to the specified filters and paging.\r\n\r\n\r\nThe `querySessions()` function builds a query to retrieve a list of sessions, and returns a [`SessionQueryBuilder`](wix-bookings-backend/sessions/session-query-builder/introduction) object.\r\nThe returned object contains the query definition, which is typically used to run the query using the [`find()`](#find) function.\r\n\r\nThe `SessionQueryBuilder` functions enable you to run, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using the session query function,\r\nrefine the query by chaining `SessionQueryBuilder` functions, and then execute the\r\nquery by chaining the `find()` function.\r\n\r\nThe query must include the following `SessionQueryBuilder` functions:\r\n + [ge](wix-bookings-backend/sessions/session-query-builder/ge)(\"end.timestamp\", \"\\\")\r\n + [lt](wix-bookings-backend/sessions/session-query-builder/lt)(\"start.timestamp\", \"\\\")\r\n\r\nUse `start` and `end` to set the range of dates you want to return in your session query. Use `ge(\"end.timestamp\", \"\")` to set the lower limit of your query range as greater or equal to the `end` date of the earliest session, and `lt(\"start.timestamp\", \"\")` to set the upper limit as less than the `start` date of the latest session. Sessions that are partially within the requested date range will be included in the returned sessions.\r\n\r\n![query](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_querysessions.png)\r\n\r\n\r\nThe query runs with the following `SessionQueryBuilder` defaults that you can override:\r\n\r\n+ [`skip`](wix-bookings-backend/sessions/session-query-builder/skip): `0`\r\n+ [`limit`](wix-bookings-backend/sessions/session-query-builder/limit): `50`\r\n+ `ascending`: `start.timestamp`\r\n\r\nBy default, recurring sessions, sessions that define recurrence patterns, are not returned in the query. Only instances of the recurring sessions are returned. To query recurring sessions, use `.ne(\"recurrence\",null)` and `.eq(\"scheduleId\", \"\")`. While instances of recurring sessions can be queried for all schedules, recurring sessions can only be queried for a specified schedule ID.\r\n\r\n\r\nThe following query builder filters are supported for `querySessions()`.\r\n|Property|Supported Filters |\r\n|--|--|\r\n|`scheduleId`|[`eq()`](wix-bookings-backend/sessions/session-query-builder/eq),[`hasSome()`](wix-bookings-backend/sessions/session-query-builder/hasSome)|\r\n|`end`|[`ge()`](wix-bookings-backend/sessions/session-query-builder/ge)|\r\n|`start`|[`lt()`](wix-bookings-backend/sessions/session-query-builder/lt)|\r\n|`tags` | [`eq()`](wix-bookings-backend/sessions/session-query-builder/eq), [`hasSome()`](wix-bookings-backend/sessions/session-query-builder/hasSome)|\r\n|`type` | [`eq()`](wix-bookings-backend/sessions/session-query-builder/eq), [`hasSome()`](wix-bookings-backend/sessions/session-query-builder/hasSome)|\r\n|`recurrence`| [`ne()`](wix-bookings-backend/sessions/session-query-builder/ne)\r\n\r\nFor a full description of the Session object, see the object returned for the [`items`](wix-bookings-backend/sessions/session-query-result/items) property in `SessionQueryResult`.\r\n\r\n\r\n> Notes: \r\n> + If `timestamp` not specified when creating a session, it is calculated as the UTC date and time using localDateTime and the business's timezone.\r\n> + Sessions that occur as a result of a linked schedule are not returned in a session query. For example, `WORKING_HOURS` sessions for a resource that has the default business hours in its `linkedSchedules` array, will not be returned in a query.\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can view participant information in a session query. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"updateSession","fqn":"Sessions.updateSession","slug":"update-session","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["sessionId","sessionInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Session","referenceFqn":"Sessions.Session"},"description":"Fulfilled - Session."},"examples":[{"title":"Update a session.","description":"","content":"\nimport { Permissions, webMethod } from \"wix-web-module\";\nimport { sessions } from \"wix-bookings-backend\";\n\nexport const myUpdateSession = webMethod(Permissions.Anyone, async (sessionId) => {\n const sessionInfo = {\n notes: \"An updated note\"\n };\n\n const updateSessionOptions = {\n suppressAuth: true\n };\n\n try {\n const updatedSession = await sessions.updateSession(sessionId, sessionInfo, updateSessionOptions);\n return updatedSession;\n } catch (error) {\n console.error(\"Update session failed:\", error);\n }\n});\n /* Returns a Promise that resolves to a session object:\n * {\n * \"_id\": \"2mmoW0vwKcSFyxtOfCdKNWpXfTMwOG1eDJiG34R4gORBP7dZp75XWXUVtvdEzhzsxfmG3a2lDyh9eqcQi2o6zxLAigrZPso7AQoP\",\n * \"scheduleId\": \"4b21a5af-3b69-42ce-a3ba-9cf60d7b4422\",\n * \"scheduleOwnerId\": \"49c7fac5-227c-44d0-a4f3-c1a5c511edf1\",\n * \"start\": {\n * \"timestamp\": \"2020-12-30T15:00:00.000Z\"\n * },\n * \"end\": {\n * \"timestamp\": \"2020-12-30T16:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [\n * \"INDIVIDUAL\"\n * ],\n * \"type\": \"EVENT\",\n * \"notes\": \"An updated note\"\n * }\n */\n"}],"actionParams":[{"name":"sessionId","slug":"session-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the session to update."},{"name":"sessionInfo","slug":"session-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateSessionInfo","referenceFqn":"Sessions.UpdateSessionInfo"},"description":"Information to use when updating a session."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Options"},"description":"An object representing the available options for updating a session."}],"description":"Updates a session.\r\n\r\n\r\nThe `updateSession()` function returns a Promise that resolves when the session has been updated.\r\n\r\nThe property values specified in the `sessionInfo` object replace the existing values. If a property is not specified in the request it will remain unchanged. Array properties, if specified, overwrite the existing array and all of its elements.\r\n\r\nWhen you update a recurring session, only the future instances of the recurrence will be updated. Changing an individual instance's `start` or `end` time will change the way updates to `start` and `end` on the recurring session affect the session instance:\r\n|Change made to the instance | Effect of changes made to the recurrence\r\n|--|--|\r\n|Instance `start` time changed.|Changes to the recurring session's `start` or `end` time will not update the instance.|\r\n|Instance `end` time changed, changing the session's duration| Changes made to the recurring session's start time will be updated on the instance while keeping the new duration, but changes to the recurring session's `end` time not be updated on the instance.\r\n|Updating a changed `start` time for an instance back to the recurring session's value.|Future changes to the recurring session `start` and `end` times will update the instance's `starts` and `end` time.\r\n\r\n\r\nChanges to properties on the recurring session, other than `start` and `end`, are always updated on the recurrence instance.\r\n\r\nUse the `options.participantNotification` object to notify participants if the session has been booked.\r\n\r\n\r\n\r\n\r\n>**Notes:** \r\n> + Where there is no explicit timezone information, the timezone used is the business’s timezone.\r\n> + Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can update a session. You can override the permissions by setting the `suppressAuth` option to `true`.\r\n\r\n\r\n **Permissions**\r\n> This endpoint requires the Manage Bookings permissions scope"}],"webhooks":[],"articles":[{"content":"# Introduction\nA session is one of the following:\n+ `\"EVENT\"`: Reserved period of time on any [schedule](wix-bookings-backend/sessions/introduction#api-reference_wix-bookings-backend_sessions_schedules). For example, an appointment, class, or course. Events are visible in the Dashboard on the Bookings app's [**Booking Calendar**](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n+ `\"WORKING_HOURS\"` : Placeholder for available time on a resource’s schedule.\n\nSessions belong to a schedule. Schedules are owned by a resource or a service.\n\n### Recurrence\nA session may be an individual session or a recurring session. \nAn individual session has a discrete start and end date, while a recurring session defines a series of repeating sessions. A session is a recurring session if the `recurrence` property contains a recurrence rule. A session is an instance of a recurring session if the `instanceOfRecurrence` property contains a recurrence rule and the `recurrence` property is `null`.\nChanging a recurring session will update the future recurrence instances. If the `start` or `end` time has been changed on an instance, updates to `start` or `end` on the recurring session may not be updated on the instance. See [`updateSession()`](wix-bookings-backend/sessions/update-session) for details.\n\nThe recurrence is defined using a subset of recurrence rules ([RRULEs](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html)).\n\nThe following RRULE parameters are supported:\n\n|Keyword|Description|Supported values|\n|--|--|---|\n|`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n|`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n|`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n|`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n\nFor example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n`\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n\n\n\n### Tags\nSessions have tags that can be used to group sessions. The Wix Bookings app uses the following system tags: \n+ `\"Blocked\"`: Used to create a session that blocks the resource's availability, but is not related to a service. Use this tag to schedule non-working hours where the resource is not available. \n+ `\"google\"`: Used by the app for events created by Google applications. Google events are read-only.\n\n\n\n### Schedules\nA schedule is a collection of [sessions](wix-bookings-backend/sessions/introduction) and the information needed to calculate availability.\nA schedule is owned by either a service or a resource. The `scheduleOwnerId` property contains the ID of the owning resource or service.\n\n\n\n\n\nTo use the Sessions API, import `sessions` from the `wix-bookings-backend` module:\n\n```javascript\nimport { sessions } from \"wix-bookings-backend\";\n```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"SessionQueryBuilder","slug":"session-query-builder","fqn":"Sessions.SessionQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"eq","fqn":"Sessions.SessionQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let query = sessions.querySessions().eq(\"scheduleId\", \"9299760d-8a4a-4f89-b348-1fc611f4be17\")"},{"title":"Create a query, add an equals filter, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .eq(\"scheduleId\", \"9299760d-8a4a-4f89-b348-1fc611f4be17\")\n .ge(\"end.timestamp\",\"2020-01-01T08:00:00.000Z\")\n .lt(\"start.timestamp\",\"2021-06-01T08:00:00.000Z\")\n .find({suppressAuth:true})\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `type`\r\n+ `tags`\r\n+ `scheduleId`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`."},{"name":"find","fqn":"Sessions.SessionQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Perform a find on a query","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Perform a find on a query using options","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\nconst options = {\n \"suppressAuth\": true\n};\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find(options)\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryOptions","referenceFqn":"Sessions.SessionQueryBuilder.QueryOptions"},"description":"Options to use when performing a query."}],"description":"Returns the bookings that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query are invalid.\r\n\r\n > **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can view participant information in a session query. You can override the permissions by setting the `suppressAuth` options to `true`."},{"name":"ge","fqn":"Sessions.SessionQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query","content":"let query = sessions.querySessions().ge(\"startTime\", \"2020-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `start.timestamp`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`."},{"name":"hasSome","fqn":"Sessions.SessionQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a hasSome filter to a query","content":"let query = sessions.querySessions().hasSome(\"tags\", [\"GROUP\", \"Blocked\"]);"},{"title":"Create a query, add a hasSome filter, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .hasSome(\"tags\",[\"GROUP\", \"Blocked\"])\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose values will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `sessionId`\r\n+ `type`\r\n+ `tags`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property contains any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `SessionQueryBuilder` to only match items where the value of the specified property equals any of the specified values in the array.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\nYou can specify a list of values to match by providing comma-separated String types as the `value` parameters. You can also specify a list of these values by including them in an array and providing the array as the `value`."},{"name":"limit","fqn":"Sessions.SessionQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a limit to a query","content":"let query = sessions.querySessions().limit(10);"},{"title":"Create a query, add a limit, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-bookings-backend/sessions/session-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend/sessions/session-query-result/next)\r\n and [`prev()`](wix-bookings-backend/sessions/session-query-result/prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`."},{"name":"lt","fqn":"Sessions.SessionQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a less than filter to a query","content":"let query = sessions.querySessions().lt(\"start.timestamp\", \"2021-04-27T10:00:00.000Z\");"},{"title":"Create a query, add a less than filter, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n+ `end.timestamp`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `SessionQueryBuilder` to only match\r\n items where the value of the specified property is less than the specified `value`."},{"name":"ne","fqn":"Sessions.SessionQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refine query."},"examples":[{"title":"Add a not equals filter to a query","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ne(\"recurrence\", null)\n .eq(\"scheduleId\", \"9299760d-8a4a-4f89-b348-1fc611f4be17\")\n .ge(\"end.timestamp\",\"2020-01-01T08:00:00.000Z\")\n .lt(\"start.timestamp\",\"2021-06-01T08:00:00.000Z\")\n .find({suppressAuth:true})\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\nSupported properties:\r\n+ `recurrence`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `SessionQueryBuilder` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n The `ne()` function only supports the `recurrence` property for `null` values. \r\n Use `.ne(\"recurrence\",null)` to query recurring sessions together with `.eq(\"sessionId\", \"\")`."},{"name":"skip","fqn":"Sessions.SessionQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder","description":"A `SessionQueryBuilder` object representing the refined query."},"examples":[{"title":"Add a skip to a query","content":"let query = sessions.querySessions().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .skip(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const totalCount = results.totalCount;\n const pageSize = results.pageSize;\n const currentPage = results.currentPage;\n const totalPages = results.totalPages;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `SessionQueryBuilder` functions enable you to run, filter, and control\n which results a query returns.\n\n Typically, you build a query using the session query function,\n refine the query by chaining `SessionQueryBuilder` functions, and then execute the\n query by chaining the [`find()`](wix-bookings-backend/sessions/session-query-builder/find) function.\n\n> **Note:** Only users with **[Bookings Admin](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin)** permissions can view participant information in a session query. You can override the permissions by setting the `suppressAuth` options to `true` in the [`find()`](wix-bookings-backend/sessions/session-query-builder/find) function.\n\n All queries must include the following `SessionQueryBuilder` functions:\n + [ge](wix-bookings-backend/sessions/session-query-builder/ge)(\"end.timestamp\", \"\\\")\n + [lt](wix-bookings-backend/sessions/session-query-builder/lt)(\"start.timestamp\", \"\\\")\n\n For example, the following code queries all sessions between the\n specified start and end dates, and logs the first 5 results to the console.\n\n ```javascript\n import { sessions } from 'wix-bookings-backend';\n\n sessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .limit(5)\n .find()\n .then( (results) => {\n console.log(results.items);\n } );\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"SessionQueryResult","slug":"session-query-result","fqn":"Sessions.SessionQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Sessions.SessionQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { sessions } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await sessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .limit(100)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"Sessions.SessionQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates the query has previous results."},{"name":"next","fqn":"Sessions.SessionQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"firstResults.next()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { sessions } from \"wix-bookings-backend\";\n\nasync function retrieveAllItems() {\n let allItems = [];\n\n let results = await sessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .limit(100)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `BookingsQueryResult` may change."},{"name":"prev","fqn":"Sessions.SessionQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SessionQueryResult","referenceFqn":"Sessions.SessionQueryResult.SessionQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n const newResults = results;\n const items = newResults.items;\n const firstItem = items[0];\n const totalCount = newResults.totalCount;\n const pageSize = newResults.pageSize;\n const currentPage = newResults.currentPage;\n const totalPages = newResults.totalPages;\n const hasNext = newResults.hasNext();\n const hasPrev = newResults.hasPrev();\n const length = newResults.length;\n const query = newResults.query;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#page-size) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-bookings-backend/sessions/session-query-builder/find)\n function, it returns a Promise that resolves to a `SessionQueryResult` object.\n This object contains the items that match the query, information about the\n query itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"let resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n let resultPage = results.currentPage; // 0\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the session items from the result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .limit(3)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n /* items:\n * [\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 11,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-01T09:00:00.000Z\"\n * },\n * \"_id\": \"193Z...gIR\",\n * \"instanceOfRecurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=FR\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"53616b1f0c3c45a1b282675acd248179-44539bfb63ae496693109b6cb3a65a65\",\n * \"scheduleId\": \"53616b1f-0c3c-45a1-b282-675acd248179\",\n * \"scheduleOwnerId\": \"b71df756-309f-468e-aec2-f82b9a9a9441\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-01T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [\n * \"GROUP\"\n * ],\n * \"type\": \"EVENT\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 4,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-04T16:00:00.000Z\"\n * },\n * \"_id\": \"4jO...deK\",\n * \"instanceOfRecurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=FR\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-ecc4a5932acb4b7bb8c27c6ffb57fd49\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 4,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-04T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * },\n * {\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 6,\n * \"hourOfDay\": 18,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-06T16:00:00.000Z\"\n * },\n * \"_id\": \"4jO...Wwv\",\n * \"instanceOfRecurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=FR\",\n * \"notes\": \"\",\n * \"recurringSessionId\": \"9299760d8a4a4f89b3481fc611f4be17-3d6b38529f544674a4976eca75e584ca\",\n * \"scheduleId\": \"9299760d-8a4a-4f89-b348-1fc611f4be17\",\n * \"scheduleOwnerId\": \"e6b6108c-92bc-462b-937c-dab386909fd2\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 1,\n * \"dayOfMonth\": 6,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * },\n * \"timestamp\": \"2021-01-06T08:00:00.000Z\"\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n * ]\n */"},{"title":"Perform a query for recurring sessions and get the session items from the result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .eq(\"scheduleId\", \"aec380c0-ca2c-43c2-98f4-9aebbd3276f3\")\n .ne(\"recurrence\",null)\n .limit(5)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n /*\n * items:\n * [\n * {\n * \n * \"_id\": \"aec380c0ca2c43c298f49aebbd3276f3-7c4fc7d98139444bbbc93aed0ac7e8ca\",\n * \"notes\": \"\",\n * \"recurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=WE;UNTIL=20220101T000000Z\",\n * \"scheduleId\": \"aec380c0-ca2c-43c2-98f4-9aebbd3276f3\",\n * \"scheduleOwnerId\": \"2a843db6-cb3f-4c96-90b8-f2f6e0055cae\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 16,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * },\n * {\n * \n * \"_id\": \"aec380c0ca2c43c298f49aebbd3276f3-316ff0991aa2417aaed137e1c051d8c6\",\n * \"notes\": \"\",\n * \"recurrence\": \"FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;UNTIL=20220101T000000Z\",\n * \"scheduleId\": \"aec380c0-ca2c-43c2-98f4-9aebbd3276f3\",\n * \"scheduleOwnerId\": \"2a843db6-cb3f-4c96-90b8-f2f6e0055cae\",\n * \"start\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 10,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"end\": {\n * \"localDateTime\": {\n * \"year\": 2021,\n * \"monthOfYear\": 3,\n * \"dayOfMonth\": 1,\n * \"hourOfDay\": 16,\n * \"minutesOfHour\": 0\n * }\n * },\n * \"status\": \"CONFIRMED\",\n * \"tags\": [],\n * \"type\": \"WORKING_HOURS\"\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Session","referenceFqn":"Sessions.Session"}},"description":"Returns an array of sessions that match the query.\r\n\r\nThe current page of sessions retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the query result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n let resultPageSize = results.pageSize; // 50\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit) function, can be retrieved using \r\nthe `pageSize` property, and navigating through pages is done with \r\nthe [`prev()`](#prev) and [`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"let resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n let newQuery = results.query;\n newQuery\n .ge(\"startTime\", \"2021-01-01T15:21:41.960Z\")\n .find()\n .then((newQueryResults) => {\n let firstItem = newQueryResults.items[0];\n })\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"REFERENCE","name":"SessionQueryBuilder","referenceFqn":"Sessions.SessionQueryBuilder.SessionQueryBuilder"},"description":"Returns the `SessionQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional `SessionQueryBuilder` functions to it. You can only filter on properties that have not already been used in the previous query."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a query, get the query that produced the results and modify it","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n let resultCount = results.totalCount; // 150\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"let resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the query result","content":"import { sessions } from \"wix-bookings-backend\";\n\n// ...\n\nsessions.querySessions()\n .ge(\"end.timestamp\", \"2021-01-01T00:00:00.000Z\")\n .lt(\"start.timestamp\", \"2021-05-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n let resultPages = results.totalPages; // 3\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-bookings-backend/sessions/session-query-builder/limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}