@wix/bookings 1.0.511 → 1.0.513

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/bookings",
-  "version": "1.0.511",
+  "version": "1.0.513",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -38,7 +38,7 @@
     "@wix/bookings_service-categories": "1.0.1",
     "@wix/bookings_service-options-and-variants": "1.0.58",
     "@wix/bookings_services": "1.0.82",
-    "@wix/bookings_staff-members": "1.0.18"
+    "@wix/bookings_staff-members": "1.0.20"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -63,5 +63,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "773be3087af3e457fd1752fa40005c3c46b5520997b847519ff3ef31"
+  "falconPackageHash": "5e431b19b891d866c4859076138a6178d2b30babe2471f986291fbf7"
 }

package/type-bundles/context.bundle.d.ts

@@ -19371,6 +19371,7 @@ interface CreateStaffMemberSignature {
      *
      * To modify the working hours of a staff member, use the `AssignWorkingHoursSchedule` API.
      * @param - Staff member to be created.
+     * @param - Options for creating the staff member.
      * @returns The created staff member.
      */
     (staffMember: StaffMember, options?: CreateStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19380,6 +19381,7 @@ interface GetStaffMemberSignature {
     /**
      * Retrieves a staff member.
      * @param - ID of the staff member to retrieve.
+     * @param - Option for retrieving the staff member.
      * @returns The retrieved staff member.
      */
     (staffMemberId: string, options?: GetStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19392,6 +19394,8 @@ interface UpdateStaffMemberSignature {
      * Each time the staff member is updated, `revision` increments by 1. You must include current revision of the staff member when updating it.
      * This ensures you're working with the latest service information and prevents unintended overwrites.
      * @param - Staff member's ID.
+     * @param - The staff member to update
+     * @param - Options for updating the staff member.
      * @returns The updated staff member.
      */
     (_id: string | null, staffMember: UpdateStaffMember, options?: UpdateStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19409,9 +19413,22 @@ interface DeleteStaffMemberSignature {
 declare function queryStaffMembers$1(httpClient: HttpClient): QueryStaffMembersSignature;
 interface QueryStaffMembersSignature {
     /**
-     * Query StaffMembers using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Creates a query to retrieve a list of staff members.
      *
-     * For field support for filters, see [Staff Members: Supported Filters](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/filtering-and-sorting)
+     * The `queryStaffMembers()` function builds a query to retrieve a list of staff members and returns a `StaffMembersQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/staff-members-query-builder/find) function.
+     *
+     * You can refine the query by chaining `StaffMembersQueryBuilder` functions onto the query. `StaffMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryStaffMembers()` returns.
+     *
+     * `queryStaffMembers()` runs with the following `StaffMembersQueryBuilder` default that you can override:
+     *
+     * + `limit` is `50`.
+     * + Sorted by `id` in ascending order.
+     *
+     * The functions that are chained to `staffMembersTypes()` are applied in the order they are called.
+     *
+     * The following `StaffMembersQueryBuilder` functions are supported for the `queryStaffMembers()` 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/staff-members/staff-members-query-result/items) property in `StaffMembersQueryResult`.
      */
     (options?: QueryStaffMembersOptions | undefined): StaffMembersQueryBuilder;
 }
@@ -19447,6 +19464,7 @@ interface ConnectStaffMemberToUserSignature {
      * - `EXPIRED` - The invitation to connect to the staff member has expired.
      * - `DISCONNECTED` - The staff member is not connected to a user.
      * @param - ID of the staff member. The staff member to connect to a user.
+     * @param - Options for connecting the staff member to a Wix user.
      */
     (staffMemberId: string, options?: ConnectStaffMemberToUserOptions | undefined): Promise<ConnectStaffMemberToUserResponse & ConnectStaffMemberToUserResponseNonNullableFields>;
 }
@@ -19473,6 +19491,7 @@ interface DisconnectStaffMemberFromUserSignature {
      *
      * After the staff member is disconnected from the user, the staff member can be connected to a different user.
      * @param - ID of the StaffMember to disconnect.
+     * @param - Options to disconnect the staff member from a Wix user.
      */
     (staffMemberId: string, options?: DisconnectStaffMemberFromUserOptions | undefined): Promise<DisconnectStaffMemberFromUserResponse & DisconnectStaffMemberFromUserResponseNonNullableFields>;
 }
@@ -19482,15 +19501,17 @@ interface AssignWorkingHoursScheduleSignature {
      * Assigns a custom working hours schedule to the staff member
      *
      *
-     * The working hours schedule is a schedule that defines the working hours of a staff member,
-     * and dictate when the staff member is available for bookings.
+     *     The working hours schedule is a schedule that defines the working hours of a staff member,
+     *     and dictate when the staff member is available for bookings.
      *
-     * By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,
-     * you can define specific working hours for that staff member.
+     *     By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,
+     *     you can define specific working hours f
+     *     or that staff member.
      *
-     * To create and manage schedules and working hours sessions, use [Schedules and Sessions API](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/schedules-and-sessions/introduction).
+     *     To create and manage schedules and working hours sessions, use [Events API](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/intro).
      * @param - Id of the staff member to assign the schedule to.
      * @param - Id of a schedule to assign to the staff's working hours schedule.
+     * @param - Options for setting the staff member's working hours schedule.
      */
     (staffMemberId: string, scheduleId: string, options?: AssignWorkingHoursScheduleOptions | undefined): Promise<AssignWorkingHoursScheduleResponse & AssignWorkingHoursScheduleResponseNonNullableFields>;
 }

package/type-bundles/index.bundle.d.ts

@@ -19371,6 +19371,7 @@ interface CreateStaffMemberSignature {
      *
      * To modify the working hours of a staff member, use the `AssignWorkingHoursSchedule` API.
      * @param - Staff member to be created.
+     * @param - Options for creating the staff member.
      * @returns The created staff member.
      */
     (staffMember: StaffMember, options?: CreateStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19380,6 +19381,7 @@ interface GetStaffMemberSignature {
     /**
      * Retrieves a staff member.
      * @param - ID of the staff member to retrieve.
+     * @param - Option for retrieving the staff member.
      * @returns The retrieved staff member.
      */
     (staffMemberId: string, options?: GetStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19392,6 +19394,8 @@ interface UpdateStaffMemberSignature {
      * Each time the staff member is updated, `revision` increments by 1. You must include current revision of the staff member when updating it.
      * This ensures you're working with the latest service information and prevents unintended overwrites.
      * @param - Staff member's ID.
+     * @param - The staff member to update
+     * @param - Options for updating the staff member.
      * @returns The updated staff member.
      */
     (_id: string | null, staffMember: UpdateStaffMember, options?: UpdateStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
@@ -19409,9 +19413,22 @@ interface DeleteStaffMemberSignature {
 declare function queryStaffMembers$1(httpClient: HttpClient): QueryStaffMembersSignature;
 interface QueryStaffMembersSignature {
     /**
-     * Query StaffMembers using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Creates a query to retrieve a list of staff members.
      *
-     * For field support for filters, see [Staff Members: Supported Filters](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/filtering-and-sorting)
+     * The `queryStaffMembers()` function builds a query to retrieve a list of staff members and returns a `StaffMembersQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/staff-members-query-builder/find) function.
+     *
+     * You can refine the query by chaining `StaffMembersQueryBuilder` functions onto the query. `StaffMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryStaffMembers()` returns.
+     *
+     * `queryStaffMembers()` runs with the following `StaffMembersQueryBuilder` default that you can override:
+     *
+     * + `limit` is `50`.
+     * + Sorted by `id` in ascending order.
+     *
+     * The functions that are chained to `staffMembersTypes()` are applied in the order they are called.
+     *
+     * The following `StaffMembersQueryBuilder` functions are supported for the `queryStaffMembers()` 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/staff-members/staff-members-query-result/items) property in `StaffMembersQueryResult`.
      */
     (options?: QueryStaffMembersOptions | undefined): StaffMembersQueryBuilder;
 }
@@ -19447,6 +19464,7 @@ interface ConnectStaffMemberToUserSignature {
      * - `EXPIRED` - The invitation to connect to the staff member has expired.
      * - `DISCONNECTED` - The staff member is not connected to a user.
      * @param - ID of the staff member. The staff member to connect to a user.
+     * @param - Options for connecting the staff member to a Wix user.
      */
     (staffMemberId: string, options?: ConnectStaffMemberToUserOptions | undefined): Promise<ConnectStaffMemberToUserResponse & ConnectStaffMemberToUserResponseNonNullableFields>;
 }
@@ -19473,6 +19491,7 @@ interface DisconnectStaffMemberFromUserSignature {
      *
      * After the staff member is disconnected from the user, the staff member can be connected to a different user.
      * @param - ID of the StaffMember to disconnect.
+     * @param - Options to disconnect the staff member from a Wix user.
      */
     (staffMemberId: string, options?: DisconnectStaffMemberFromUserOptions | undefined): Promise<DisconnectStaffMemberFromUserResponse & DisconnectStaffMemberFromUserResponseNonNullableFields>;
 }
@@ -19482,15 +19501,17 @@ interface AssignWorkingHoursScheduleSignature {
      * Assigns a custom working hours schedule to the staff member
      *
      *
-     * The working hours schedule is a schedule that defines the working hours of a staff member,
-     * and dictate when the staff member is available for bookings.
+     *     The working hours schedule is a schedule that defines the working hours of a staff member,
+     *     and dictate when the staff member is available for bookings.
      *
-     * By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,
-     * you can define specific working hours for that staff member.
+     *     By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,
+     *     you can define specific working hours f
+     *     or that staff member.
      *
-     * To create and manage schedules and working hours sessions, use [Schedules and Sessions API](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/schedules-and-sessions/introduction).
+     *     To create and manage schedules and working hours sessions, use [Events API](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/intro).
      * @param - Id of the staff member to assign the schedule to.
      * @param - Id of a schedule to assign to the staff's working hours schedule.
+     * @param - Options for setting the staff member's working hours schedule.
      */
     (staffMemberId: string, scheduleId: string, options?: AssignWorkingHoursScheduleOptions | undefined): Promise<AssignWorkingHoursScheduleResponse & AssignWorkingHoursScheduleResponseNonNullableFields>;
 }