@wix/auto_sdk_bookings_resources 1.0.0 → 1.0.1

package/build/internal/es/src/bookings-resources-v2-resource-resources.public.d.ts

@@ -8,24 +8,35 @@ interface CreateResourceSignature {
     /**
      * Creates a new resource.
      *
-     * A new events schedule is automatically created specific to this resource. This schedule will contain information
-     * on when the resource is booked in order to prevent double bookings.
-     * See [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) for more information.
-     *
-     * - If the request does not include the field `locationOptions`, then the service will create this field and set
-     * `availableInAllLocations` in this structure to `true`.
-     * - If the request includes one or more business location IDs in the `locationOptions.specificLocationOptions.businessLocations`
-     * field, then the field `locationOptions.specificLocationOptions.availableInBusinessLocations` must be set
-     * to `true`.
+     *
+     * ## Connected schedules
+     *
+     * A new event *schedule*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/wix-bookings-integration) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration))
+     * is automatically created for the resource.
+     *
+     * ## Locations
+     *
+     * If you don't specify `locationOptions`, Wix Bookings automatically sets
+     * `locationOptions.availableInAllLocations` to `true`.
+     *
+     * If you specify 1 business location ID in `locationOptions.specificLocationOptions.businessLocations`,
+     * you must specify `locationOptions.specificLocationOptions.availableInBusinessLocations`
+     * as `true`. Currently, you can specify only a single business location.
      * @param - Resource to create.
-     * @returns The created resource.
+     * @returns Created resource.
      */
     (resource: Resource): Promise<Resource & ResourceNonNullableFields>;
 }
 export declare function bulkCreateResources(httpClient: HttpClient): BulkCreateResourcesSignature;
 interface BulkCreateResourcesSignature {
     /**
-     * Creates multiple resources.
+     * Creates up to 50 resources.
+     *
+     *
+     * Refer to *Create Resource*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/create-resource) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/create-resource))
+     * for more details.
      * @param - Resources to create.
      */
     (resources: Resource[], options?: BulkCreateResourcesOptions | undefined): Promise<BulkCreateResourcesResponse & BulkCreateResourcesResponseNonNullableFields>;
@@ -33,9 +44,9 @@ interface BulkCreateResourcesSignature {
 export declare function getResource(httpClient: HttpClient): GetResourceSignature;
 interface GetResourceSignature {
     /**
-     * Retrieves a resource by ID.
+     * Retrieves a resource.
      * @param - ID of the resource to retrieve.
-     * @returns The retrieved resource.
+     * @returns Retrieved resource.
      */
     (resourceId: string): Promise<Resource & ResourceNonNullableFields>;
 }
@@ -44,10 +55,11 @@ interface UpdateResourceSignature {
     /**
      * Updates a resource.
      *
+     *
      * Each time the resource is updated, `revision` increments by 1. You must include the current revision of the resource when updating it.
      * This ensures you're working with the latest service information and prevents unintended overwrites.
      * @param - Resource ID.
-     * @returns The updated resource.
+     * @returns Updated resource.
      */
     (_id: string | null, resource: UpdateResource): Promise<Resource & ResourceNonNullableFields>;
 }
@@ -56,7 +68,11 @@ interface DeleteResourceSignature {
     /**
      * Deletes a resource.
      *
-     * Also cancels the associated events schedule and any working hours schedule that isn’t shared among multiple resources.
+     *
+     * Deleting a resource cancels its event schedule and all its working hour
+     * schedules that aren't shared with another resource. Learn more about
+     * how Bookings uses the Calendar APIs*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/wix-bookings-integration) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration)).
      * @param - ID of the resource to delete.
      */
     (resourceId: string): Promise<void>;
@@ -65,7 +81,12 @@ export declare function bulkDeleteResources(httpClient: HttpClient): BulkDeleteR
 interface BulkDeleteResourcesSignature {
     /**
      * Deletes multiple resources.
-     * @param - The IDs of the resources to delete.
+     *
+     *
+     * Refer to *Delete Resource*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/delete-resource) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/delete-resource))
+     * for more details.
+     * @param - IDs of the resources to delete.
      */
     (ids: string[]): Promise<BulkDeleteResourcesResponse & BulkDeleteResourcesResponseNonNullableFields>;
 }
@@ -74,8 +95,10 @@ interface SearchResourcesSignature {
     /**
      * Retrieves a list of resources matching the provided search criteria.
      *
-     * The search endpoints allow to perform advanced search including partial text search, exact match, and more.
-     * The endpoint also allows to aggregate resources by type, name, app id, management type, management type and location options.
+     *
+     * Refer to the *supported filters article*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
+     * for a complete list of supported filters and sorting options.
      */
     (options?: SearchResourcesOptions | undefined): Promise<SearchResourcesResponse & SearchResourcesResponseNonNullableFields>;
 }
@@ -95,7 +118,7 @@ interface QueryResourcesSignature {
      * + `limit` is `50`.
      * + Sorted by `id` in ascending order.
      *
-     * The functions that are chained to `queryResources()` are applied in the order they are called. For example, if you apply `ascending("typeId")` and then `ascending("id")`, the results are sorted first by the `"typeId"`, and then, if there are multiple results with the same `"typeId"`, the items are sorted by `"id"`.
+     * The functions that are chained to `queryResources()` are applied in the order they are called. For example, if you apply `ascending("typeId")` and then `ascending("name")`, the results are sorted first by the `"typeId"`, and then, if there are multiple results with the same `"typeId"`, the items are sorted by `"name"`.
      *
      * The following `ResourcesQueryBuilder` functions are supported for the `queryResources()` function. For a full description of the resource object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/resources-query-result/items) property in `ResourcesQueryResult`.
      */
@@ -106,10 +129,11 @@ interface CountResourcesSignature {
     /**
      * Counts resources according to given criteria.
      *
-     * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.
-     * @param - Filter to base the count on. See
-     * [queryResources()](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/query-resources)
-     * for supported filters.
+     *
+     * Refer to the *supported filters article*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
+     * for a complete list of supported filters and sorting options.
+     * @param - Filter to base the count on. See *the supported filters article* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting)) for a complete list of filtering options.
      */
     (options?: CountResourcesOptions | undefined): Promise<CountResourcesResponse & CountResourcesResponseNonNullableFields>;
 }

package/build/internal/es/src/bookings-resources-v2-resource-resources.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-resources-v2-resource-resources.public.js","sourceRoot":"","sources":["../../../../src/bookings-resources-v2-resource-resources.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAmBL,mBAAmB,IAAI,4BAA4B,EACnD,mBAAmB,IAAI,4BAA4B,EACnD,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,WAAW,IAAI,oBAAoB,EACnC,cAAc,IAAI,uBAAuB,EACzC,eAAe,IAAI,wBAAwB,EAC3C,cAAc,IAAI,uBAAuB,GAC1C,MAAM,yDAAyD,CAAC;AAEjE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAqBD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,SAAqB,EAAE,OAAoC,EAAE,EAAE,CACrE,4BAA4B,CAC1B,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAeD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,oBAAoB,CAClB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,QAAwB,EAAE,EAAE,CACtD,uBAAuB,CACrB,GAAG,EACH,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,GAAa,EAAE,EAAE,CACvB,4BAA4B,CAC1B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAwBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,OAA+B,EAAE,EAAE,CACzC,uBAAuB,CACrB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAE7B,OAAO,EAQL,eAAe,EAwDf,QAAQ,EAKR,cAAc,EAEd,aAAa,EACb,IAAI,EAMJ,qBAAqB,EA+BrB,UAAU,EAQV,aAAa,EACb,SAAS,EACT,QAAQ,EAaR,mBAAmB,GAGpB,MAAM,yDAAyD,CAAC"}
+{"version":3,"file":"bookings-resources-v2-resource-resources.public.js","sourceRoot":"","sources":["../../../../src/bookings-resources-v2-resource-resources.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAmBL,mBAAmB,IAAI,4BAA4B,EACnD,mBAAmB,IAAI,4BAA4B,EACnD,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,WAAW,IAAI,oBAAoB,EACnC,cAAc,IAAI,uBAAuB,EACzC,eAAe,IAAI,wBAAwB,EAC3C,cAAc,IAAI,uBAAuB,GAC1C,MAAM,yDAAyD,CAAC;AAEjE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA2BD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,SAAqB,EAAE,OAAoC,EAAE,EAAE,CACrE,4BAA4B,CAC1B,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAoBD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,oBAAoB,CAClB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,QAAwB,EAAE,EAAE,CACtD,uBAAuB,CACrB,GAAG,EACH,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,GAAa,EAAE,EAAE,CACvB,4BAA4B,CAC1B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAwBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,OAA+B,EAAE,EAAE,CACzC,uBAAuB,CACrB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,4CAA4C,EAC5C,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAE7B,OAAO,EAQL,eAAe,EAwDf,QAAQ,EAKR,cAAc,EAEd,aAAa,EACb,IAAI,EAMJ,qBAAqB,EA+BrB,UAAU,EAQV,aAAa,EACb,SAAS,EACT,QAAQ,EAaR,mBAAmB,GAGpB,MAAM,yDAAyD,CAAC"}

package/build/internal/es/src/bookings-resources-v2-resource-resources.types.d.ts

@@ -1,7 +1,9 @@
 /**
- * A resource represents an entity that can be scheduled for use, such as a room or a staff member.
- * The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings.
- * Read more about resources in this [article](https://support.wix.com/en/article/wix-bookings-managing-your-resources).
+ * A resource represents an entity, such as a room or a staff member, that can be
+ * scheduled for use in a *booking*
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/about-the-bookings-apis)).
+ * The availability of a resource is tracked to ensure that it
+ * can be allocated at a requested time slot and to prevent double bookings.
  */
 export interface Resource extends ResourceCompositionDetailsOneOf {
     /**
@@ -17,35 +19,42 @@ export interface Resource extends ResourceCompositionDetailsOneOf {
      */
     revision?: string | null;
     /**
-     * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource was created.
+     * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource was last updated.
+     * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource was last updated.
      * @readonly
      */
     updatedDate?: Date | null;
     /** Name of the resource. */
     name?: string | null;
     /**
-     * ID of the [resource type](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-type-v2/introduction).
+     * ID of the *resource type*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
      *
      * Once a type has been set it can't be modified. You can create a resource
-     * without specifying a type. However, such resources cannot be booked.
+     * without specifying a type. However, customers can't book such resources.
      */
     typeId?: string | null;
     /**
-     * Schedule details that specify the working hours and locations of this resource.
+     * Information about the *schedule*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction))
+     * specifying the working hours and locations of the resource.
      *
-     * Resources without this field are available 24/7 at the locations specified in the field `locationOptions`.
-     * When both `workingHoursSchedules` and `locationOptions` are set then `workingHoursSchedules` takes precedence.
+     * Resources without a working hour schedule are available 24/7 at the locations
+     * specified in the field `locationOptions`.
+     * When both `workingHoursSchedules` and `locationOptions` are set,
+     * `workingHoursSchedules` takes precedence.
      */
     workingHoursSchedules?: WorkingHoursSchedules;
-    /** Location details that specify where this resource is available. */
+    /** Information about the location where the resource is available. */
     locationOptions?: LocationOptions;
     /**
-     * This schedule contains the sessions in which this resource has been booked.
+     * Schedule containing the *events*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
+     * for which the resource has been booked.
      * @readonly
      */
     eventsSchedule?: EventsSchedule;
@@ -56,13 +65,15 @@ export interface Resource extends ResourceCompositionDetailsOneOf {
 export interface ResourceCompositionDetailsOneOf {
 }
 export interface WorkingHoursSchedule {
-    /** Schedule ID. See [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) for more information. */
+    /**
+     * ID of the working hour *schedule*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
+     */
     scheduleId?: string | null;
     /**
-     * Whether this schedule is used by multiple resources or unique for this resource.
+     * Whether the schedule is shared by multiple resources or unique for this resource.
      *
-     * `true` if it is a shared schedule (for example from a business or location), `false` this is a custom schedule specific to the resource.
-     * Default: `false`.
+     * Default: `false`
      * @readonly
      */
     shared?: boolean | null;
@@ -71,25 +82,29 @@ export interface SingleResource {
     /**
      * Schedule details that specify the working hours and locations of this resource.
      *
-     * When this field is not set the resource is assumed to be available full time (7 x 24) at the locations specified
-     * in the field `location_options`. When both `working_hours_schedules` and `location_options` are set then
-     * `working_hours_schedules` takes precedence.
+     * When this field is missing or empty, the resource is assumed to be available
+     * around the clock (24/7) at the locations specified in `locationOptions`. When
+     * both `workingHoursSchedules` and `locationOptions` are set,
+     * `workingHoursSchedules` takes precedence.
      */
     workingHoursSchedules?: V2WorkingHoursSchedules;
     /**
-     * Location details that specify where this resource is available.
+     * Information about the location where the resource is available.
      *
-     * If this field is not supplied then `location_options.available_in_all_locations` is set to `true`.
+     * If you don't specify `locationOptions`, Wix Bookings automatically sets
+     * `{"availableInAllLocations": true}`.
      */
     locationOptions?: LocationOptions;
     /**
-     * This schedule contains the sessions in which this resource has been booked.
+     * Schedule containing the *events*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
+     * for which the resource has been booked.
      * @readonly
      */
     eventsSchedule?: Schedule;
 }
 export interface V2WorkingHoursSchedules {
-    /** schedules specifying all the working hours of the resource. Currently a single schedule is supported. */
+    /** Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. */
     values?: Schedule[];
 }
 /** Deprecated and subject to removal */
@@ -106,39 +121,53 @@ export interface Schedule {
 }
 export interface LocationOptions {
     /**
-     * `true` if the resource is available in all locations, `false` if the resource is available only in specific locations.
+     * Whether the resource is available in all *business locations*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
+     *
+     * - `true`: The resource is available in all business locations.
+     * - `false`: The resource is available only in specific locations.
+     *
      * Default: `false`
      */
     availableInAllLocations?: boolean | null;
-    /**
-     * Details of specific locations. It must be left empty if `availableInAllLocations` is `true`.
-     * If supplied then the field `specificLocationOptions.availableInBusinessLocations` must be set to `true`.
-     */
+    /** Details of resource availability in specific locations. */
     specificLocationOptions?: SpecificLocation;
 }
 export interface SpecificLocation {
     /**
-     * `true` if the resource is available in some business locations, `false` otherwise.
+     * Whether the resource is available in *business locations*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
+     *
+     * - `true`: The resource is available in business locations.
+     * - `false`: The resource isn't available in business locations.
      *
      * Default: `false`
      */
     availableInBusinessLocations?: boolean | null;
     /**
-     * Information about business locations. Should be empty if `availableInBusinessLocations` is `false` or if no business location exists in Locations.
-     * Read more about business locations in this [article](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * Information about the business locations where the resource is available.
+     * Not returned, if the resource is available in either all business locations
+     * or in no business location.
+     * You can specify up to 5 business locations.
      */
     businessLocations?: BusinessLocation[];
 }
 export interface BusinessLocation {
-    /** The ID of the business location. Must not be empty. */
+    /**
+     * ID of the business *location*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
+     */
     locationId?: string | null;
 }
 export interface WorkingHoursSchedules {
-    /** Schedules specifying all the working hours of the resource. Currently a single schedule is supported. */
+    /** Schedules specifying the working hours of the resource. Currently, only a single schedule is supported. */
     values?: WorkingHoursSchedule[];
 }
 export interface EventsSchedule {
-    /** Schedule ID. See [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) for more information. */
+    /**
+     * ID of the event *schedule*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
+     */
     scheduleId?: string | null;
 }
 export declare enum ManagementType {
@@ -161,13 +190,17 @@ export interface CreateResourceRequest {
     resource: Resource;
 }
 export interface CreateResourceResponse {
-    /** The created resource. */
+    /** Created resource. */
     resource?: Resource;
 }
 export interface BulkCreateResourcesRequest {
     /** Resources to create. */
     resources: Resource[];
-    /** Whether to include the created resources in the response. Default: `false` */
+    /**
+     * Whether to include the created resources in the response.
+     *
+     * Default: `false`
+     */
     returnEntity?: boolean;
 }
 export interface BulkCreateResourcesResponse {
@@ -177,7 +210,7 @@ export interface BulkCreateResourcesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface BulkResourceResult {
-    /** Item metadata */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** The resulting resource after the bulk operation. */
     item?: Resource;
@@ -213,21 +246,21 @@ export interface GetResourceRequest {
     resourceId: string;
 }
 export interface GetResourceResponse {
-    /** The retrieved resource. */
+    /** Retrieved resource. */
     resource?: Resource;
 }
 export interface GetDeletedResourceRequest {
-    /** ID of the resource to retrieve. */
+    /** ID of the deleted resource to retrieve from the trash bin. */
     resourceId?: string;
 }
 export interface GetDeletedResourceResponse {
-    /** The retrieved resource. */
+    /** Retrieved resource. */
     resource?: Resource;
 }
 export interface ListDeletedResourcesRequest {
-    /** The ids of the resources to retrieve. */
+    /** IDs of the resources to retrieve. */
     resourceIds?: string[];
-    /** Paging parameter, enabling to pass a limit and a cursor. */
+    /** Paging details, allowing you specify a limit and a cursor. */
     paging?: CursorPaging;
 }
 export interface CursorPaging {
@@ -242,9 +275,9 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface ListDeletedResourcesResponse {
-    /** The retrieved Resources */
+    /** Retrieved resources. */
     resources?: Resource[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 export interface CursorPagingMetadata {
@@ -267,7 +300,7 @@ export interface Cursors {
     prev?: string | null;
 }
 export interface RemoveResourceFromTrashBinRequest {
-    /** ID of the resource to remove from the trash bin. */
+    /** ID of the resource to permanently delete from the trash bin. */
     resourceId?: string;
 }
 export interface RemoveResourceFromTrashBinResponse {
@@ -277,15 +310,15 @@ export interface RestoreResourceFromTrashBinRequest {
     resourceId?: string;
 }
 export interface RestoreResourceFromTrashBinResponse {
-    /** The restored resource. */
+    /** Restored resource. */
     resource?: Resource;
 }
 export interface UpdateResourceRequest {
-    /** Resource to be updated, may be partial. */
+    /** Resource to update. */
     resource: Resource;
 }
 export interface UpdateResourceResponse {
-    /** The updated resource. */
+    /** Updated resource. */
     resource?: Resource;
 }
 export interface DeleteResourceRequest {
@@ -295,7 +328,7 @@ export interface DeleteResourceRequest {
 export interface DeleteResourceResponse {
 }
 export interface BulkDeleteResourcesRequest {
-    /** The IDs of the resources to delete. */
+    /** IDs of the resources to delete. */
     ids: string[];
 }
 export interface BulkDeleteResourcesResponse {
@@ -305,7 +338,11 @@ export interface BulkDeleteResourcesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface SearchResourcesRequest {
-    /** Search condition */
+    /**
+     * Search condition. Refer to the *supported filters article*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
+     * for a complete list of supported filters and sorting options.
+     */
     search?: CursorSearch;
 }
 export interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -558,11 +595,11 @@ export declare enum Mode {
     AND = "AND"
 }
 export interface SearchResourcesResponse {
-    /** The retrieved resources */
+    /** Retrieved resources. */
     resources?: Resource[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
-    /** Aggregation results */
+    /** Aggregation results. */
     aggregationData?: AggregationData;
 }
 export interface AggregationData {
@@ -727,7 +764,11 @@ export interface AggregationResultsResultOneOf {
     nested?: NestedResults;
 }
 export interface QueryResourcesRequest {
-    /** WQL expression. */
+    /**
+     * Query for retrieving resources. Refer to the *supported filters article*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
+     * for a complete list of supported filters.
+     */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -754,40 +795,45 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface QueryResourcesResponse {
-    /** The retrieved Resources. */
+    /** Retrieved resources. */
     resources?: Resource[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 export interface CountResourcesRequest {
-    /** Filter to apply on resources to count. */
+    /**
+     * Filter to base the count on. Refer to the *supported filters article*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
+     * for a complete list of supported filters.
+     */
     filter?: Record<string, any> | null;
     /**
-     * @deprecated
+     * Free text to match in searchable fields. Field is deprecated due to decision to use query instead of search for performing the count.
+     * @deprecated Free text to match in searchable fields. Field is deprecated due to decision to use query instead of search for performing the count.
      * @targetRemovalDate 2024-05-01
      */
     search?: SearchDetails;
 }
 export interface CountResourcesResponse {
-    /** The number of resources matching the given filter. */
+    /** Total number of resources matching the filter. */
     count?: number;
 }
 export interface ImportResourceRequest {
-    /** Resource to be imported. */
+    /** Resource to import. */
     resource?: Resource;
 }
 export interface ImportResourceResponse {
-    /** The imported resource. */
+    /** Imported resource. */
     resource?: Resource;
 }
 export interface FixResourceSchedulesRequest {
-    /** Id of the resource of which the schedules must be fixed */
+    /** ID of the resource to fix schedules for. */
     resourceId?: string;
-    /** the working hours schedule that must be set for this resource. */
+    /** Working hour schedule that must be set for this resource. */
     workingHoursSchedule?: Schedule;
 }
 export interface FixResourceSchedulesResponse {
-    /** The resource with the fixed schedule IDs. */
+    /** Updated resource. */
     resource?: Resource;
 }
 export interface ReindexTenantRequest {

package/build/internal/es/src/bookings-resources-v2-resource-resources.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-resources-v2-resource-resources.types.js","sourceRoot":"","sources":["../../../../src/bookings-resources-v2-resource-resources.types.ts"],"names":[],"mappings":"AAyJA,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6CAA6C;IAC7C,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AA0OD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAiDD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uCAAuC;IACvC,2BAAe,CAAA;IACf,uDAAuD;IACvD,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,sCAAsC;IACtC,8BAAa,CAAA;IACb,qCAAqC;IACrC,4BAAW,CAAA;AACb,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,qEAAqE;IACrE,oCAAmB,CAAA;IACnB,mEAAmE;IACnE,oCAAmB,CAAA;AACrB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAOD,MAAM,CAAN,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,+BAA+B;IAC/B,+CAAiC,CAAA;IACjC,oBAAoB;IACpB,yBAAW,CAAA;IACX,oBAAoB;IACpB,yBAAW,CAAA;AACb,CAAC,EARW,UAAU,KAAV,UAAU,QAQrB;AAqBD,MAAM,CAAN,IAAY,qBAUX;AAVD,WAAY,qBAAqB;IAC/B,8EAAqD,CAAA;IACrD,uFAAuF;IACvF,wCAAe,CAAA;IACf,uFAAuF;IACvF,wCAAe,CAAA;IACf,kEAAkE;IAClE,0CAAiB,CAAA;IACjB,iHAAiH;IACjH,0DAAiC,CAAA;AACnC,CAAC,EAVW,qBAAqB,KAArB,qBAAqB,QAUhC;AAiBD,MAAM,CAAN,IAAY,QAgBX;AAhBD,WAAY,QAAQ;IAClB,iDAAqC,CAAA;IACrC,sBAAsB;IACtB,yBAAa,CAAA;IACb,uBAAuB;IACvB,2BAAe,CAAA;IACf,sBAAsB;IACtB,yBAAa,CAAA;IACb,qBAAqB;IACrB,uBAAW,CAAA;IACX,sBAAsB;IACtB,yBAAa,CAAA;IACb,sBAAsB;IACtB,6BAAiB,CAAA;IACjB,sBAAsB;IACtB,6BAAiB,CAAA;AACnB,CAAC,EAhBW,QAAQ,KAAR,QAAQ,QAgBnB;AA+BD,MAAM,CAAN,IAAY,eAYX;AAZD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,uFAAuF;IACvF,kCAAe,CAAA;IACf,uFAAuF;IACvF,kCAAe,CAAA;IACf,kEAAkE;IAClE,oCAAiB,CAAA;IACjB,iHAAiH;IACjH,oDAAiC,CAAA;IACjC,yFAAyF;IACzF,oCAAiB,CAAA;AACnB,CAAC,EAZW,eAAe,KAAf,eAAe,QAY1B;AAkCD,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,8CAA8C;IAC9C,iBAAS,CAAA;IACT,uCAAuC;IACvC,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf;AAqYD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"bookings-resources-v2-resource-resources.types.js","sourceRoot":"","sources":["../../../../src/bookings-resources-v2-resource-resources.types.ts"],"names":[],"mappings":"AAsLA,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6CAA6C;IAC7C,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAkPD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAiDD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uCAAuC;IACvC,2BAAe,CAAA;IACf,uDAAuD;IACvD,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,sCAAsC;IACtC,8BAAa,CAAA;IACb,qCAAqC;IACrC,4BAAW,CAAA;AACb,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,qEAAqE;IACrE,oCAAmB,CAAA;IACnB,mEAAmE;IACnE,oCAAmB,CAAA;AACrB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAOD,MAAM,CAAN,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,+BAA+B;IAC/B,+CAAiC,CAAA;IACjC,oBAAoB;IACpB,yBAAW,CAAA;IACX,oBAAoB;IACpB,yBAAW,CAAA;AACb,CAAC,EARW,UAAU,KAAV,UAAU,QAQrB;AAqBD,MAAM,CAAN,IAAY,qBAUX;AAVD,WAAY,qBAAqB;IAC/B,8EAAqD,CAAA;IACrD,uFAAuF;IACvF,wCAAe,CAAA;IACf,uFAAuF;IACvF,wCAAe,CAAA;IACf,kEAAkE;IAClE,0CAAiB,CAAA;IACjB,iHAAiH;IACjH,0DAAiC,CAAA;AACnC,CAAC,EAVW,qBAAqB,KAArB,qBAAqB,QAUhC;AAiBD,MAAM,CAAN,IAAY,QAgBX;AAhBD,WAAY,QAAQ;IAClB,iDAAqC,CAAA;IACrC,sBAAsB;IACtB,yBAAa,CAAA;IACb,uBAAuB;IACvB,2BAAe,CAAA;IACf,sBAAsB;IACtB,yBAAa,CAAA;IACb,qBAAqB;IACrB,uBAAW,CAAA;IACX,sBAAsB;IACtB,yBAAa,CAAA;IACb,sBAAsB;IACtB,6BAAiB,CAAA;IACjB,sBAAsB;IACtB,6BAAiB,CAAA;AACnB,CAAC,EAhBW,QAAQ,KAAR,QAAQ,QAgBnB;AA+BD,MAAM,CAAN,IAAY,eAYX;AAZD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,uFAAuF;IACvF,kCAAe,CAAA;IACf,uFAAuF;IACvF,kCAAe,CAAA;IACf,kEAAkE;IAClE,oCAAiB,CAAA;IACjB,iHAAiH;IACjH,oDAAiC,CAAA;IACjC,yFAAyF;IACzF,oCAAiB,CAAA;AACnB,CAAC,EAZW,eAAe,KAAf,eAAe,QAY1B;AAkCD,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,8CAA8C;IAC9C,iBAAS,CAAA;IACT,uCAAuC;IACvC,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf;AA8YD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}