@wix/auto_sdk_bookings_staff-members 1.0.66 → 1.0.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{bookings-staff-v1-staff-member-staff-members.universal-DG3a38ei.d.ts → bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.d.ts} +52 -89
- package/build/cjs/index.d.ts +20 -23
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +30 -58
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{bookings-staff-v1-staff-member-staff-members.universal-DG3a38ei.d.mts → bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.d.mts} +52 -89
- package/build/es/index.d.mts +20 -23
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +5 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +30 -58
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{bookings-staff-v1-staff-member-staff-members.universal-DG3a38ei.d.ts → bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.d.ts} +52 -89
- package/build/internal/cjs/index.d.ts +20 -23
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +5 -5
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +30 -58
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{bookings-staff-v1-staff-member-staff-members.universal-DG3a38ei.d.mts → bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.d.mts} +52 -89
- package/build/internal/es/index.d.mts +20 -23
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +5 -5
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +30 -58
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -38,16 +38,14 @@ interface StaffMember {
|
|
|
38
38
|
/** Staff media. */
|
|
39
39
|
mainMedia?: MediaItem;
|
|
40
40
|
/**
|
|
41
|
-
* Staff member's
|
|
42
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)),
|
|
41
|
+
* Staff member's [resource ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction),
|
|
43
42
|
* identical to `resource.id`.
|
|
44
43
|
* @readonly
|
|
45
44
|
* @format GUID
|
|
46
45
|
*/
|
|
47
46
|
resourceId?: string | null;
|
|
48
47
|
/**
|
|
49
|
-
* Details about the
|
|
50
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
|
|
48
|
+
* Details about the [resource object](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/resource-object)
|
|
51
49
|
* associated with the staff member. Available only if you specify `RESOURCE_DETAILS`
|
|
52
50
|
* in the `fields` array.
|
|
53
51
|
* @readonly
|
|
@@ -55,8 +53,7 @@ interface StaffMember {
|
|
|
55
53
|
resource?: Resource;
|
|
56
54
|
/**
|
|
57
55
|
* Identity of the Wix user associated with the staff member. Learn more about
|
|
58
|
-
*
|
|
59
|
-
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-identities) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities)).
|
|
56
|
+
* [identities](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities).
|
|
60
57
|
* @readonly
|
|
61
58
|
*/
|
|
62
59
|
associatedWixIdentity?: AssociatedWixIdentity;
|
|
@@ -79,10 +76,7 @@ interface StaffMember {
|
|
|
79
76
|
_updatedDate?: Date | null;
|
|
80
77
|
/** Extensions enabling users to save custom data related to the staff member. */
|
|
81
78
|
extendedFields?: ExtendedFields;
|
|
82
|
-
/**
|
|
83
|
-
* Tags allowing you to classify staff members. Learn more about *tags*
|
|
84
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction)).
|
|
85
|
-
*/
|
|
79
|
+
/** Tags allowing you to classify staff members. Learn more about [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction). */
|
|
86
80
|
tags?: Tags;
|
|
87
81
|
}
|
|
88
82
|
interface MediaItem extends MediaItemMediaOneOf {
|
|
@@ -96,31 +90,26 @@ interface MediaItemMediaOneOf {
|
|
|
96
90
|
}
|
|
97
91
|
interface Resource {
|
|
98
92
|
/**
|
|
99
|
-
* ID of the
|
|
100
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
|
|
93
|
+
* ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)
|
|
101
94
|
* associated with the staff member.
|
|
102
95
|
* @format GUID
|
|
103
96
|
*/
|
|
104
97
|
_id?: string | null;
|
|
105
98
|
/**
|
|
106
|
-
* Working hour
|
|
107
|
-
* ([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))
|
|
99
|
+
* Working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
|
|
108
100
|
* of the staff member. By default, identical the opening hours of the
|
|
109
|
-
* business's
|
|
110
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
101
|
+
* business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
111
102
|
* If the staff has custom working hours, identical to `eventsSchedule`.
|
|
112
103
|
* @maxSize 1
|
|
113
104
|
*/
|
|
114
105
|
workingHoursSchedules?: WorkingHoursSchedule[];
|
|
115
106
|
/**
|
|
116
|
-
* Event
|
|
117
|
-
* ([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))
|
|
107
|
+
* Event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
|
|
118
108
|
* of the staff member.
|
|
119
109
|
*/
|
|
120
110
|
eventsSchedule?: EventSchedule;
|
|
121
111
|
/**
|
|
122
|
-
* Whether the staff member works according to business's
|
|
123
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
112
|
+
* Whether the staff member works according to business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction)
|
|
124
113
|
* opening hours.
|
|
125
114
|
*
|
|
126
115
|
* `false`: The staff has custom working hours.
|
|
@@ -128,22 +117,15 @@ interface Resource {
|
|
|
128
117
|
* Default: `true`
|
|
129
118
|
*/
|
|
130
119
|
usesDefaultWorkingHours?: boolean;
|
|
131
|
-
/**
|
|
132
|
-
* Revision number, which increments by 1 each time the resource is updated.
|
|
133
|
-
* To prevent conflicting changes,
|
|
134
|
-
* the current revision must be passed when updating the resource.
|
|
135
|
-
* @readonly
|
|
136
|
-
*/
|
|
120
|
+
/** Revision number, which increments by 1 each time the resource is updated. */
|
|
137
121
|
revision?: string | null;
|
|
138
122
|
}
|
|
139
123
|
interface WorkingHoursSchedule {
|
|
140
124
|
/**
|
|
141
|
-
* ID of the working hour
|
|
142
|
-
* ([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))
|
|
125
|
+
* ID of the working hour [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
143
126
|
* associated with the staff member. Currently, each staff member can't have more than a
|
|
144
127
|
* single working hour schedule. Learn more about
|
|
145
|
-
*
|
|
146
|
-
* ([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)).
|
|
128
|
+
* [how Wix Bookings uses the Calendar APIs](https://dev.wix.com/docs/api-reference/business-management/calendar/wix-bookings-integration).
|
|
147
129
|
* @format GUID
|
|
148
130
|
*/
|
|
149
131
|
_id?: string | null;
|
|
@@ -155,19 +137,17 @@ interface WorkingHoursSchedule {
|
|
|
155
137
|
}
|
|
156
138
|
interface EventSchedule {
|
|
157
139
|
/**
|
|
158
|
-
* ID of the event
|
|
159
|
-
* ([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))
|
|
140
|
+
* ID of the event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
|
|
160
141
|
* associated with the staff member. Learn more about
|
|
161
142
|
* _how Wix Bookings uses the Calendar APIs_
|
|
162
|
-
*
|
|
143
|
+
* [Wix Bookings](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration).
|
|
163
144
|
* @format GUID
|
|
164
145
|
*/
|
|
165
146
|
_id?: string | null;
|
|
166
147
|
}
|
|
167
148
|
interface LocationOptions {
|
|
168
149
|
/**
|
|
169
|
-
* Whether the resource is available in all
|
|
170
|
-
* ([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)).
|
|
150
|
+
* Whether the resource is available in all [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types).
|
|
171
151
|
*
|
|
172
152
|
* - `true`: The resource is available in all business locations.
|
|
173
153
|
* - `false`: The resource is available only in specific locations.
|
|
@@ -180,8 +160,7 @@ interface LocationOptions {
|
|
|
180
160
|
}
|
|
181
161
|
interface SpecificLocation {
|
|
182
162
|
/**
|
|
183
|
-
* Whether the resource is available in
|
|
184
|
-
* ([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)).
|
|
163
|
+
* Whether the resource is available in [business locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types).
|
|
185
164
|
*
|
|
186
165
|
* - `true`: The resource is available in business locations.
|
|
187
166
|
* - `false`: The resource isn't available in business locations.
|
|
@@ -200,8 +179,7 @@ interface SpecificLocation {
|
|
|
200
179
|
}
|
|
201
180
|
interface BusinessLocation {
|
|
202
181
|
/**
|
|
203
|
-
* ID of the business
|
|
204
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
182
|
+
* ID of the business [location](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
205
183
|
* @format GUID
|
|
206
184
|
*/
|
|
207
185
|
locationId?: string | null;
|
|
@@ -210,8 +188,7 @@ interface BusinessLocation {
|
|
|
210
188
|
interface AssociatedWixIdentity {
|
|
211
189
|
/**
|
|
212
190
|
* Information about the identity connected to the staff member. Available only
|
|
213
|
-
* if the staff member is connected to a Wix user. Learn more about
|
|
214
|
-
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-identities) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities)).
|
|
191
|
+
* if the staff member is connected to a Wix user. Learn more about [identities](https://dev.wix.com/docs/rest/articles/getting-started/about-identities).
|
|
215
192
|
*/
|
|
216
193
|
identificationData?: CommonIdentificationData;
|
|
217
194
|
/**
|
|
@@ -633,9 +610,8 @@ interface DeleteStaffMemberResponse {
|
|
|
633
610
|
}
|
|
634
611
|
interface QueryStaffMembersRequest {
|
|
635
612
|
/**
|
|
636
|
-
* Information about filters, paging, and sorting. See the
|
|
637
|
-
*
|
|
638
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting))
|
|
613
|
+
* Information about filters, paging, and sorting. See the
|
|
614
|
+
* [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
639
615
|
* for all supported filters and sorting options.
|
|
640
616
|
*/
|
|
641
617
|
query?: CursorQuery;
|
|
@@ -693,8 +669,7 @@ interface QueryStaffMembersResponse {
|
|
|
693
669
|
interface QueryStaffMembersMultiLanguageRequest {
|
|
694
670
|
/**
|
|
695
671
|
* Information about filters, paging, and sorting. See the article about
|
|
696
|
-
* booking policy filters
|
|
697
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting))
|
|
672
|
+
* [booking policy filters](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/supported-filters)
|
|
698
673
|
* for all supported filters and sorting options.
|
|
699
674
|
*/
|
|
700
675
|
query?: CursorQuery;
|
|
@@ -714,8 +689,8 @@ interface QueryStaffMembersMultiLanguageResponse {
|
|
|
714
689
|
}
|
|
715
690
|
interface CountStaffMembersRequest {
|
|
716
691
|
/**
|
|
717
|
-
* Filter to base the count upon. See the
|
|
718
|
-
*
|
|
692
|
+
* Filter to base the count upon. See the
|
|
693
|
+
* [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
719
694
|
* for a complete list of supported filters.
|
|
720
695
|
*/
|
|
721
696
|
filter?: Record<string, any> | null;
|
|
@@ -752,7 +727,7 @@ interface SearchStaffMembersRequest {
|
|
|
752
727
|
/**
|
|
753
728
|
* Search criteria including filter, sort, and paging options.
|
|
754
729
|
*
|
|
755
|
-
* See the supported filters article
|
|
730
|
+
* See the [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting) for complete filter and sorting options.
|
|
756
731
|
*/
|
|
757
732
|
search: CursorSearch;
|
|
758
733
|
/**
|
|
@@ -770,13 +745,13 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
770
745
|
/**
|
|
771
746
|
* Filter object for narrowing search results. For example, to return only staff members with specific email domains: `"filter": {"email": {"$contains": "@company.com"}}`.
|
|
772
747
|
*
|
|
773
|
-
* Learn more about the filter format in the supported filters article
|
|
748
|
+
* Learn more about the filter format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting).
|
|
774
749
|
*/
|
|
775
750
|
filter?: Record<string, any> | null;
|
|
776
751
|
/**
|
|
777
752
|
* Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
778
753
|
*
|
|
779
|
-
* Learn more about the sort format in the supported filters article
|
|
754
|
+
* Learn more about the sort format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting).
|
|
780
755
|
* @maxSize 10
|
|
781
756
|
*/
|
|
782
757
|
sort?: Sorting[];
|
|
@@ -1090,8 +1065,7 @@ interface AssignWorkingHoursScheduleRequest {
|
|
|
1090
1065
|
*/
|
|
1091
1066
|
staffMemberId: string;
|
|
1092
1067
|
/**
|
|
1093
|
-
* ID of the
|
|
1094
|
-
* ([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))
|
|
1068
|
+
* ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
1095
1069
|
* to assign to the staff member.
|
|
1096
1070
|
*
|
|
1097
1071
|
* Must be either the staff member's event schedule ID or the working hour
|
|
@@ -1116,8 +1090,7 @@ interface AssignCustomScheduleRequest {
|
|
|
1116
1090
|
*/
|
|
1117
1091
|
staffMemberId: string;
|
|
1118
1092
|
/**
|
|
1119
|
-
* ID of the
|
|
1120
|
-
* ([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))
|
|
1093
|
+
* ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
1121
1094
|
* to assign to the staff member.
|
|
1122
1095
|
* @format GUID
|
|
1123
1096
|
*/
|
|
@@ -1190,8 +1163,7 @@ interface BulkActionMetadata {
|
|
|
1190
1163
|
}
|
|
1191
1164
|
interface BulkUpdateStaffMemberTagsByFilterRequest {
|
|
1192
1165
|
/**
|
|
1193
|
-
* Filter to base the update upon. See the
|
|
1194
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting))
|
|
1166
|
+
* Filter to base the update upon. See the [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
1195
1167
|
* for a complete list of supported filters.
|
|
1196
1168
|
*/
|
|
1197
1169
|
filter: Record<string, any> | null;
|
|
@@ -2645,7 +2617,7 @@ declare function onStaffMemberUpdated(handler: (event: StaffMemberUpdatedEnvelop
|
|
|
2645
2617
|
*
|
|
2646
2618
|
*
|
|
2647
2619
|
* By default, the staff member works during the business working hours.
|
|
2648
|
-
* You could follow this sample flow
|
|
2620
|
+
* You could follow this [sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/sample-flows#assign-a-staff-working-hour-schedule) to set custom working hours.
|
|
2649
2621
|
* @param staffMember - Staff member to create.
|
|
2650
2622
|
* @public
|
|
2651
2623
|
* @requiredField staffMember
|
|
@@ -2799,16 +2771,14 @@ interface UpdateStaffMember {
|
|
|
2799
2771
|
/** Staff media. */
|
|
2800
2772
|
mainMedia?: MediaItem;
|
|
2801
2773
|
/**
|
|
2802
|
-
* Staff member's
|
|
2803
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)),
|
|
2774
|
+
* Staff member's [resource ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction),
|
|
2804
2775
|
* identical to `resource.id`.
|
|
2805
2776
|
* @readonly
|
|
2806
2777
|
* @format GUID
|
|
2807
2778
|
*/
|
|
2808
2779
|
resourceId?: string | null;
|
|
2809
2780
|
/**
|
|
2810
|
-
* Details about the
|
|
2811
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
|
|
2781
|
+
* Details about the [resource object](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/resource-object)
|
|
2812
2782
|
* associated with the staff member. Available only if you specify `RESOURCE_DETAILS`
|
|
2813
2783
|
* in the `fields` array.
|
|
2814
2784
|
* @readonly
|
|
@@ -2816,8 +2786,7 @@ interface UpdateStaffMember {
|
|
|
2816
2786
|
resource?: Resource;
|
|
2817
2787
|
/**
|
|
2818
2788
|
* Identity of the Wix user associated with the staff member. Learn more about
|
|
2819
|
-
*
|
|
2820
|
-
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-identities) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities)).
|
|
2789
|
+
* [identities](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities).
|
|
2821
2790
|
* @readonly
|
|
2822
2791
|
*/
|
|
2823
2792
|
associatedWixIdentity?: AssociatedWixIdentity;
|
|
@@ -2840,10 +2809,7 @@ interface UpdateStaffMember {
|
|
|
2840
2809
|
_updatedDate?: Date | null;
|
|
2841
2810
|
/** Extensions enabling users to save custom data related to the staff member. */
|
|
2842
2811
|
extendedFields?: ExtendedFields;
|
|
2843
|
-
/**
|
|
2844
|
-
* Tags allowing you to classify staff members. Learn more about *tags*
|
|
2845
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction)).
|
|
2846
|
-
*/
|
|
2812
|
+
/** Tags allowing you to classify staff members. Learn more about [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction). */
|
|
2847
2813
|
tags?: Tags;
|
|
2848
2814
|
}
|
|
2849
2815
|
interface UpdateStaffMemberOptions {
|
|
@@ -2857,7 +2823,7 @@ interface UpdateStaffMemberOptions {
|
|
|
2857
2823
|
* Deletes a staff member.
|
|
2858
2824
|
*
|
|
2859
2825
|
*
|
|
2860
|
-
* Also deletes the resource
|
|
2826
|
+
* Also deletes the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) associated with the staff member.
|
|
2861
2827
|
* @param staffMemberId - ID of the staff member to delete.
|
|
2862
2828
|
* @public
|
|
2863
2829
|
* @requiredField staffMemberId
|
|
@@ -2964,7 +2930,7 @@ interface StaffMembersQueryBuilder {
|
|
|
2964
2930
|
*
|
|
2965
2931
|
* ### Filter
|
|
2966
2932
|
*
|
|
2967
|
-
* Refer to the supported filters article
|
|
2933
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting) for a complete list of supported filters and sorting options.
|
|
2968
2934
|
*
|
|
2969
2935
|
* ### See also
|
|
2970
2936
|
*
|
|
@@ -2977,8 +2943,8 @@ interface StaffMembersQueryBuilder {
|
|
|
2977
2943
|
declare function countStaffMembers(options?: CountStaffMembersOptions): Promise<NonNullablePaths<CountStaffMembersResponse, `count`, 2>>;
|
|
2978
2944
|
interface CountStaffMembersOptions {
|
|
2979
2945
|
/**
|
|
2980
|
-
* Filter to base the count upon. See the
|
|
2981
|
-
*
|
|
2946
|
+
* Filter to base the count upon. See the
|
|
2947
|
+
* [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
2982
2948
|
* for a complete list of supported filters.
|
|
2983
2949
|
*/
|
|
2984
2950
|
filter?: Record<string, any> | null;
|
|
@@ -2991,9 +2957,9 @@ interface CountStaffMembersOptions {
|
|
|
2991
2957
|
* However, you can specify an alternative email address. If no existing Wix user is associated with that email, Wix sends them an invitation to become a Wix user.
|
|
2992
2958
|
* If an existing user is found but not linked to the site, Wix Bookings sends an invitation to join the site.
|
|
2993
2959
|
*
|
|
2994
|
-
* To check the connection status, call Get Staff Member
|
|
2960
|
+
* To check the connection status, call [Get Staff Member](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/get-staff-member), and specify `ASSOCIATED_IDENTITY_STATUS` in the `fields` parameter.
|
|
2995
2961
|
*
|
|
2996
|
-
* You must call Disconnect Staff Member From User
|
|
2962
|
+
* You must call [Disconnect Staff Member From User](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/disconnect-staff-member-from-user) before connecting a different Wix user to the staff member.
|
|
2997
2963
|
* @param staffMemberId - ID of the staff member to connect to the Wix user.
|
|
2998
2964
|
* @public
|
|
2999
2965
|
* @requiredField staffMemberId
|
|
@@ -3061,13 +3027,13 @@ type StaffMemberSearch = {
|
|
|
3061
3027
|
/**
|
|
3062
3028
|
Filter object for narrowing search results. For example, to return only staff members with specific email domains: `"filter": {"email": {"$contains": "@company.com"}}`.
|
|
3063
3029
|
|
|
3064
|
-
Learn more about the filter format in the supported filters article
|
|
3030
|
+
Learn more about the filter format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting).
|
|
3065
3031
|
*/
|
|
3066
3032
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
3067
3033
|
/**
|
|
3068
3034
|
Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
3069
3035
|
|
|
3070
|
-
Learn more about the sort format in the supported filters article
|
|
3036
|
+
Learn more about the sort format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting).
|
|
3071
3037
|
@maxSize: 10
|
|
3072
3038
|
*/
|
|
3073
3039
|
sort?: {
|
|
@@ -3130,12 +3096,12 @@ interface DisconnectStaffMemberFromUserOptions {
|
|
|
3130
3096
|
fields?: RequestedFieldsWithLiterals[];
|
|
3131
3097
|
}
|
|
3132
3098
|
/**
|
|
3133
|
-
* Updates a staff member's working hours based on the specified schedule ID
|
|
3099
|
+
* Updates a staff member's working hours based on the specified [schedule ID](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction).
|
|
3134
3100
|
*
|
|
3135
3101
|
*
|
|
3136
3102
|
* ### Default working hours
|
|
3137
3103
|
*
|
|
3138
|
-
* By default, staff members work during the opening hours of the business's default location
|
|
3104
|
+
* By default, staff members work during the opening hours of the business's default [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
|
|
3139
3105
|
*
|
|
3140
3106
|
* ### Schedule ID
|
|
3141
3107
|
*
|
|
@@ -3145,14 +3111,13 @@ interface DisconnectStaffMemberFromUserOptions {
|
|
|
3145
3111
|
* #### Staff event schedule
|
|
3146
3112
|
*
|
|
3147
3113
|
* To customize a staff member's working hours, specify their event schedule ID as `scheduleId`.
|
|
3148
|
-
* Refer to this sample flow
|
|
3114
|
+
* Refer to this [sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/sample-flows#assign-a-staff-working-hour-schedule) for more details.
|
|
3149
3115
|
*
|
|
3150
3116
|
* #### Business working hour schedule
|
|
3151
3117
|
*
|
|
3152
3118
|
* To reset a staff member's working hours to the default business hours, specify the ID of the business working hour schedule as `scheduleId`.
|
|
3153
3119
|
* @param staffMemberId - ID of the staff member to assign the schedule to.
|
|
3154
|
-
* @param scheduleId - ID of the
|
|
3155
|
-
* ([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))
|
|
3120
|
+
* @param scheduleId - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
3156
3121
|
* to assign to the staff member.
|
|
3157
3122
|
*
|
|
3158
3123
|
* Must be either the staff member's event schedule ID or the working hour
|
|
@@ -3182,10 +3147,9 @@ interface AssignWorkingHoursScheduleOptions {
|
|
|
3182
3147
|
* By default staff members use the shared business working hours schedule.
|
|
3183
3148
|
* By assigning a custom working hours schedule to a staff member, you can define specific working hours for that staff member.
|
|
3184
3149
|
*
|
|
3185
|
-
* To create and manage schedules and working hours sessions, use the Events API
|
|
3150
|
+
* To create and manage schedules and working hours sessions, use the [Events API](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction).
|
|
3186
3151
|
* @param staffMemberId - ID of the staff member for which to assign a working hour schedule.
|
|
3187
|
-
* @param scheduleId - ID of the
|
|
3188
|
-
* ([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))
|
|
3152
|
+
* @param scheduleId - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
3189
3153
|
* to assign to the staff member.
|
|
3190
3154
|
* @public
|
|
3191
3155
|
* @requiredField scheduleId
|
|
@@ -3206,7 +3170,7 @@ interface AssignCustomScheduleOptions {
|
|
|
3206
3170
|
fields?: RequestedFieldsWithLiterals[];
|
|
3207
3171
|
}
|
|
3208
3172
|
/**
|
|
3209
|
-
* Synchronously updates tags
|
|
3173
|
+
* Synchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for up to 100 staff members.
|
|
3210
3174
|
*
|
|
3211
3175
|
*
|
|
3212
3176
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
@@ -3225,16 +3189,15 @@ interface BulkUpdateStaffMemberTagsOptions {
|
|
|
3225
3189
|
unassignTags?: Tags;
|
|
3226
3190
|
}
|
|
3227
3191
|
/**
|
|
3228
|
-
* Asynchronously updates tags
|
|
3192
|
+
* Asynchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for staff members, given the provided filtering.
|
|
3229
3193
|
*
|
|
3230
3194
|
*
|
|
3231
3195
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
3232
3196
|
*
|
|
3233
3197
|
* ### Filter
|
|
3234
3198
|
*
|
|
3235
|
-
* Refer to the supported filters article
|
|
3236
|
-
* @param filter - Filter to base the update upon. See the
|
|
3237
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting))
|
|
3199
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting) for a complete list of supported filters and sorting options.
|
|
3200
|
+
* @param filter - Filter to base the update upon. See the [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
3238
3201
|
* for a complete list of supported filters.
|
|
3239
3202
|
* @public
|
|
3240
3203
|
* @requiredField filter
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { S as StaffMember, C as CreateStaffMemberOptions, G as GetStaffMemberOptions, a as GetDeletedStaffMemberOptions, b as GetDeletedStaffMemberResponse, L as ListDeletedStaffMembersOptions, c as ListDeletedStaffMembersResponse, U as UpdateStaffMember, d as UpdateStaffMemberOptions, Q as QueryStaffMembersOptions, e as StaffMembersQueryBuilder, f as CountStaffMembersOptions, g as CountStaffMembersResponse, h as ConnectStaffMemberToUserOptions, i as ConnectStaffMemberToUserResponse, j as StaffMemberSearch, k as SearchStaffMembersOptions, l as SearchStaffMembersResponse, D as DisconnectStaffMemberFromUserOptions, m as DisconnectStaffMemberFromUserResponse, A as AssignWorkingHoursScheduleOptions, n as AssignWorkingHoursScheduleResponse, o as AssignCustomScheduleOptions, p as AssignCustomScheduleResponse, B as BulkUpdateStaffMemberTagsOptions, q as BulkUpdateStaffMemberTagsResponse, r as BulkUpdateStaffMemberTagsByFilterOptions, s as BulkUpdateStaffMemberTagsByFilterResponse, t as StaffMemberConnectedToUserEnvelope, u as StaffMemberCreatedEnvelope, v as StaffMemberDeletedEnvelope, w as StaffMemberDisconnectedFromUserEnvelope, x as StaffMemberFullyCreatedEnvelope, y as StaffMemberUpdatedEnvelope } from './bookings-staff-v1-staff-member-staff-members.universal-
|
|
3
|
-
export { bx as ActionEvent, bH as Address, bK as AddressLocation, bI as AddressStreetOneOf, aU as AggregationData, bb as AggregationResults, bc as AggregationResultsResultOneOf, a$ as AggregationResultsScalarResult, J as AggregationType, cC as AggregationTypeWithLiterals, bi as ApplicationError, X as ApprovalStatus, cK as ApprovalStatusWithLiterals, bf as AssignCustomScheduleRequest, be as AssignWorkingHoursScheduleRequest, ah as AssociatedConferencingAccount, ai as AssociatedConferencingAccountAccountOneOf, ag as AssociatedConferencingAccounts, af as AssociatedConferencingProvider, ae as AssociatedConferencingProviders, aa as AssociatedWixIdentity, z as AssociatedWixIdentityConnectionStatusEnumConnectionStatus, cw as AssociatedWixIdentityConnectionStatusEnumConnectionStatusWithLiterals, bV as Availability, bW as AvailabilityConstraints, ce as AvailabilityPolicy, cd as AvailabilityPolicyUpdated, cr as BaseEventMetadata, bk as BulkActionMetadata, bl as BulkUpdateStaffMemberTagsByFilterRequest, bg as BulkUpdateStaffMemberTagsRequest, bj as BulkUpdateStaffMemberTagsResult, a9 as BusinessLocation, bQ as BusinessSchedule, c0 as CalendarConference, c4 as CalendarDateTime, _ as CalendarType, cN as CalendarTypeWithLiterals, ab as CommonIdentificationData, ac as CommonIdentificationDataIdOneOf, cR as CommonSearchWithEntityContext, b$ as ConferenceProvider, Z as ConferenceType, cM as ConferenceTypeWithLiterals, aP as ConnectStaffMemberToUserRequest, ad as Connection, E as ConnectionStatus, cx as ConnectionStatusWithLiterals, aO as CountStaffMembersRequest, aq as CreateStaffMemberRequest, ar as CreateStaffMemberResponse, aw as CursorPaging, ax as CursorPagingMetadata, aI as CursorQuery, aJ as CursorQueryPagingMethodOneOf, aR as CursorSearch, aS as CursorSearchPagingMethodOneOf, ay as Cursors, aj as CustomConferenceAccount, b7 as DateHistogramResult, b9 as DateHistogramResults, K as Day, W as DayOfWeek, cJ as DayOfWeekWithLiterals, cD as DayWithLiterals, aF as DeleteStaffMemberRequest, aG as DeleteStaffMemberResponse, bd as DisconnectStaffMemberFromUserRequest, br as DomainEvent, bs as DomainEventBodyOneOf, bo as Empty, bt as EntityCreatedEvent, bw as EntityDeletedEvent, bv as EntityUpdatedEvent, cs as EventMetadata, a6 as EventSchedule, ak as ExtendedFields, c6 as ExternalCalendarInfo, bZ as ExternalCalendarOverrides, bE as Frequency, au as GetDeletedStaffMemberRequest, as as GetStaffMemberRequest, at as GetStaffMemberResponse, b8 as GroupByValueResults, cp as IdentificationData, cq as IdentificationDataIdOneOf, I as IdentityType, cv as IdentityTypeWithLiterals, bD as Interval, cf as IntervalSplit, bh as ItemMetadata, bF as LinkedSchedule, av as ListDeletedStaffMembersRequest, c5 as LocalDateTime, bG as Location, a7 as LocationOptions, P as LocationStatus, cH as LocationStatusWithLiterals, O as LocationType, cG as LocationTypeWithLiterals, bN as LocationsAddress, bP as LocationsAddressLocation, bM as LocationsLocation, V as LocationsLocationType, cI as LocationsLocationTypeWithLiterals, bO as LocationsStreetAddress, a2 as MediaItem, a3 as MediaItemMediaOneOf, co as MessageEnvelope, cm as MigrationData, cl as MigrationEvent, M as Mode, cA as ModeWithLiterals, ci as MultipleSessionsCreated, aX as NestedAggregationResults, aY as NestedAggregationResultsResultOneOf, b4 as NestedResultValue, b5 as NestedResultValueResultOneOf, ba as NestedResults, b0 as NestedValueAggregationResult, bY as Participant, c8 as ParticipantNotification, bp as PolicyRemovedFromContributor, bq as PolicyUpdatedForContributor, bU as Price, aM as QueryStaffMembersMultiLanguageRequest, aN as QueryStaffMembersMultiLanguageResponse, aH as QueryStaffMembersRequest, aL as QueryStaffMembersResponse, aW as RangeAggregationResult, b2 as RangeResult, a_ as RangeResults, bT as Rate, bC as RecurringInterval, N as RecurringIntervalType, cF as RecurringIntervalTypeWithLiterals, cg as RecurringSessionSplit, c2 as RecurringSessionsUpdated, az as RemoveStaffMemberFromTrashBinRequest, aA as RemoveStaffMemberFromTrashBinResponse, R as RequestedFields, cy as RequestedFieldsWithLiterals, a4 as Resource, bu as RestoreInfo, aB as RestoreStaffMemberFromTrashBinRequest, aC as RestoreStaffMemberFromTrashBinResponse, bm as RestoreStaffRequest, bn as RestoreStaffResponse, b6 as Results, b3 as ScalarResult, H as ScalarType, cB as ScalarTypeWithLiterals, bB as Schedule, c9 as ScheduleCancelled, bA as ScheduleCreated, by as ScheduleNotification, bz as ScheduleNotificationEventOneOf, Y as ScheduleStatus, cL as ScheduleStatusWithLiterals, ch as ScheduleUnassignedFromUser, c1 as ScheduleUpdated, cj as ScheduleWithSessions, aT as SearchDetails, aQ as SearchStaffMembersRequest, c3 as Session, cc as SessionCancelled, ca as SessionCreated, a0 as SessionType, cP as SessionTypeWithLiterals, cb as SessionUpdated, c7 as SessionVersion, ck as SitePropertiesOnScheduleCreation, F as SortOrder, cz as SortOrderWithLiterals, aK as Sorting, bS as SpecialHourPeriod, a8 as SpecificLocation, bX as SplitInterval, cn as StaffData, ao as StaffMemberConnectedToUser, an as StaffMemberDisconnectedFromUser, ap as StaffMemberFullyCreated, cu as StaffMemberSearchSpec, ct as StaffMembersQueryResult, $ as Status, cO as StatusWithLiterals, bJ as StreetAddress, bL as Subdivision, am as TagList, al as Tags, bR as TimePeriod, T as Transparency, cE as TransparencyWithLiterals, aD as UpdateStaffMemberRequest, aE as UpdateStaffMemberResponse, aV as ValueAggregationResult, b1 as ValueResult, aZ as ValueResults, b_ as Version, a1 as WebhookIdentityType, cQ as WebhookIdentityTypeWithLiterals, a5 as WorkingHoursSchedule } from './bookings-staff-v1-staff-member-staff-members.universal-
|
|
2
|
+
import { S as StaffMember, C as CreateStaffMemberOptions, G as GetStaffMemberOptions, a as GetDeletedStaffMemberOptions, b as GetDeletedStaffMemberResponse, L as ListDeletedStaffMembersOptions, c as ListDeletedStaffMembersResponse, U as UpdateStaffMember, d as UpdateStaffMemberOptions, Q as QueryStaffMembersOptions, e as StaffMembersQueryBuilder, f as CountStaffMembersOptions, g as CountStaffMembersResponse, h as ConnectStaffMemberToUserOptions, i as ConnectStaffMemberToUserResponse, j as StaffMemberSearch, k as SearchStaffMembersOptions, l as SearchStaffMembersResponse, D as DisconnectStaffMemberFromUserOptions, m as DisconnectStaffMemberFromUserResponse, A as AssignWorkingHoursScheduleOptions, n as AssignWorkingHoursScheduleResponse, o as AssignCustomScheduleOptions, p as AssignCustomScheduleResponse, B as BulkUpdateStaffMemberTagsOptions, q as BulkUpdateStaffMemberTagsResponse, r as BulkUpdateStaffMemberTagsByFilterOptions, s as BulkUpdateStaffMemberTagsByFilterResponse, t as StaffMemberConnectedToUserEnvelope, u as StaffMemberCreatedEnvelope, v as StaffMemberDeletedEnvelope, w as StaffMemberDisconnectedFromUserEnvelope, x as StaffMemberFullyCreatedEnvelope, y as StaffMemberUpdatedEnvelope } from './bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.mjs';
|
|
3
|
+
export { bx as ActionEvent, bH as Address, bK as AddressLocation, bI as AddressStreetOneOf, aU as AggregationData, bb as AggregationResults, bc as AggregationResultsResultOneOf, a$ as AggregationResultsScalarResult, J as AggregationType, cC as AggregationTypeWithLiterals, bi as ApplicationError, X as ApprovalStatus, cK as ApprovalStatusWithLiterals, bf as AssignCustomScheduleRequest, be as AssignWorkingHoursScheduleRequest, ah as AssociatedConferencingAccount, ai as AssociatedConferencingAccountAccountOneOf, ag as AssociatedConferencingAccounts, af as AssociatedConferencingProvider, ae as AssociatedConferencingProviders, aa as AssociatedWixIdentity, z as AssociatedWixIdentityConnectionStatusEnumConnectionStatus, cw as AssociatedWixIdentityConnectionStatusEnumConnectionStatusWithLiterals, bV as Availability, bW as AvailabilityConstraints, ce as AvailabilityPolicy, cd as AvailabilityPolicyUpdated, cr as BaseEventMetadata, bk as BulkActionMetadata, bl as BulkUpdateStaffMemberTagsByFilterRequest, bg as BulkUpdateStaffMemberTagsRequest, bj as BulkUpdateStaffMemberTagsResult, a9 as BusinessLocation, bQ as BusinessSchedule, c0 as CalendarConference, c4 as CalendarDateTime, _ as CalendarType, cN as CalendarTypeWithLiterals, ab as CommonIdentificationData, ac as CommonIdentificationDataIdOneOf, cR as CommonSearchWithEntityContext, b$ as ConferenceProvider, Z as ConferenceType, cM as ConferenceTypeWithLiterals, aP as ConnectStaffMemberToUserRequest, ad as Connection, E as ConnectionStatus, cx as ConnectionStatusWithLiterals, aO as CountStaffMembersRequest, aq as CreateStaffMemberRequest, ar as CreateStaffMemberResponse, aw as CursorPaging, ax as CursorPagingMetadata, aI as CursorQuery, aJ as CursorQueryPagingMethodOneOf, aR as CursorSearch, aS as CursorSearchPagingMethodOneOf, ay as Cursors, aj as CustomConferenceAccount, b7 as DateHistogramResult, b9 as DateHistogramResults, K as Day, W as DayOfWeek, cJ as DayOfWeekWithLiterals, cD as DayWithLiterals, aF as DeleteStaffMemberRequest, aG as DeleteStaffMemberResponse, bd as DisconnectStaffMemberFromUserRequest, br as DomainEvent, bs as DomainEventBodyOneOf, bo as Empty, bt as EntityCreatedEvent, bw as EntityDeletedEvent, bv as EntityUpdatedEvent, cs as EventMetadata, a6 as EventSchedule, ak as ExtendedFields, c6 as ExternalCalendarInfo, bZ as ExternalCalendarOverrides, bE as Frequency, au as GetDeletedStaffMemberRequest, as as GetStaffMemberRequest, at as GetStaffMemberResponse, b8 as GroupByValueResults, cp as IdentificationData, cq as IdentificationDataIdOneOf, I as IdentityType, cv as IdentityTypeWithLiterals, bD as Interval, cf as IntervalSplit, bh as ItemMetadata, bF as LinkedSchedule, av as ListDeletedStaffMembersRequest, c5 as LocalDateTime, bG as Location, a7 as LocationOptions, P as LocationStatus, cH as LocationStatusWithLiterals, O as LocationType, cG as LocationTypeWithLiterals, bN as LocationsAddress, bP as LocationsAddressLocation, bM as LocationsLocation, V as LocationsLocationType, cI as LocationsLocationTypeWithLiterals, bO as LocationsStreetAddress, a2 as MediaItem, a3 as MediaItemMediaOneOf, co as MessageEnvelope, cm as MigrationData, cl as MigrationEvent, M as Mode, cA as ModeWithLiterals, ci as MultipleSessionsCreated, aX as NestedAggregationResults, aY as NestedAggregationResultsResultOneOf, b4 as NestedResultValue, b5 as NestedResultValueResultOneOf, ba as NestedResults, b0 as NestedValueAggregationResult, bY as Participant, c8 as ParticipantNotification, bp as PolicyRemovedFromContributor, bq as PolicyUpdatedForContributor, bU as Price, aM as QueryStaffMembersMultiLanguageRequest, aN as QueryStaffMembersMultiLanguageResponse, aH as QueryStaffMembersRequest, aL as QueryStaffMembersResponse, aW as RangeAggregationResult, b2 as RangeResult, a_ as RangeResults, bT as Rate, bC as RecurringInterval, N as RecurringIntervalType, cF as RecurringIntervalTypeWithLiterals, cg as RecurringSessionSplit, c2 as RecurringSessionsUpdated, az as RemoveStaffMemberFromTrashBinRequest, aA as RemoveStaffMemberFromTrashBinResponse, R as RequestedFields, cy as RequestedFieldsWithLiterals, a4 as Resource, bu as RestoreInfo, aB as RestoreStaffMemberFromTrashBinRequest, aC as RestoreStaffMemberFromTrashBinResponse, bm as RestoreStaffRequest, bn as RestoreStaffResponse, b6 as Results, b3 as ScalarResult, H as ScalarType, cB as ScalarTypeWithLiterals, bB as Schedule, c9 as ScheduleCancelled, bA as ScheduleCreated, by as ScheduleNotification, bz as ScheduleNotificationEventOneOf, Y as ScheduleStatus, cL as ScheduleStatusWithLiterals, ch as ScheduleUnassignedFromUser, c1 as ScheduleUpdated, cj as ScheduleWithSessions, aT as SearchDetails, aQ as SearchStaffMembersRequest, c3 as Session, cc as SessionCancelled, ca as SessionCreated, a0 as SessionType, cP as SessionTypeWithLiterals, cb as SessionUpdated, c7 as SessionVersion, ck as SitePropertiesOnScheduleCreation, F as SortOrder, cz as SortOrderWithLiterals, aK as Sorting, bS as SpecialHourPeriod, a8 as SpecificLocation, bX as SplitInterval, cn as StaffData, ao as StaffMemberConnectedToUser, an as StaffMemberDisconnectedFromUser, ap as StaffMemberFullyCreated, cu as StaffMemberSearchSpec, ct as StaffMembersQueryResult, $ as Status, cO as StatusWithLiterals, bJ as StreetAddress, bL as Subdivision, am as TagList, al as Tags, bR as TimePeriod, T as Transparency, cE as TransparencyWithLiterals, aD as UpdateStaffMemberRequest, aE as UpdateStaffMemberResponse, aV as ValueAggregationResult, b1 as ValueResult, aZ as ValueResults, b_ as Version, a1 as WebhookIdentityType, cQ as WebhookIdentityTypeWithLiterals, a5 as WorkingHoursSchedule } from './bookings-staff-v1-staff-member-staff-members.universal-ClAII2Rf.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createStaffMember$1(httpClient: HttpClient): CreateStaffMemberSignature;
|
|
6
6
|
interface CreateStaffMemberSignature {
|
|
@@ -9,7 +9,7 @@ interface CreateStaffMemberSignature {
|
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* By default, the staff member works during the business working hours.
|
|
12
|
-
* You could follow this sample flow
|
|
12
|
+
* You could follow this [sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/sample-flows#assign-a-staff-working-hour-schedule) to set custom working hours.
|
|
13
13
|
* @param - Staff member to create.
|
|
14
14
|
* @param - Options for creating the staff member.
|
|
15
15
|
* @returns Created staff member.
|
|
@@ -78,7 +78,7 @@ interface DeleteStaffMemberSignature {
|
|
|
78
78
|
* Deletes a staff member.
|
|
79
79
|
*
|
|
80
80
|
*
|
|
81
|
-
* Also deletes the resource
|
|
81
|
+
* Also deletes the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) associated with the staff member.
|
|
82
82
|
* @param - ID of the staff member to delete.
|
|
83
83
|
*/
|
|
84
84
|
(staffMemberId: string): Promise<void>;
|
|
@@ -113,7 +113,7 @@ interface CountStaffMembersSignature {
|
|
|
113
113
|
*
|
|
114
114
|
* ### Filter
|
|
115
115
|
*
|
|
116
|
-
* Refer to the supported filters article
|
|
116
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting) for a complete list of supported filters and sorting options.
|
|
117
117
|
*
|
|
118
118
|
* ### See also
|
|
119
119
|
*
|
|
@@ -131,9 +131,9 @@ interface ConnectStaffMemberToUserSignature {
|
|
|
131
131
|
* However, you can specify an alternative email address. If no existing Wix user is associated with that email, Wix sends them an invitation to become a Wix user.
|
|
132
132
|
* If an existing user is found but not linked to the site, Wix Bookings sends an invitation to join the site.
|
|
133
133
|
*
|
|
134
|
-
* To check the connection status, call Get Staff Member
|
|
134
|
+
* To check the connection status, call [Get Staff Member](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/get-staff-member), and specify `ASSOCIATED_IDENTITY_STATUS` in the `fields` parameter.
|
|
135
135
|
*
|
|
136
|
-
* You must call Disconnect Staff Member From User
|
|
136
|
+
* You must call [Disconnect Staff Member From User](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/disconnect-staff-member-from-user) before connecting a different Wix user to the staff member.
|
|
137
137
|
* @param - ID of the staff member to connect to the Wix user.
|
|
138
138
|
* @param - Options for connecting the staff member to a Wix user.
|
|
139
139
|
*/
|
|
@@ -153,14 +153,14 @@ interface SearchStaffMembersSignature {
|
|
|
153
153
|
*
|
|
154
154
|
* ### Filter
|
|
155
155
|
*
|
|
156
|
-
* Refer to the supported filters article
|
|
156
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting) for a complete list of supported filters and sorting options.
|
|
157
157
|
*
|
|
158
158
|
* ### See also
|
|
159
159
|
*
|
|
160
|
-
* To learn about working with Search methods, see API Query Language
|
|
160
|
+
* To learn about working with Search methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
161
161
|
* @param - Search criteria including filter, sort, and paging options.
|
|
162
162
|
*
|
|
163
|
-
* See the supported filters article
|
|
163
|
+
* See the [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting) for complete filter and sorting options.
|
|
164
164
|
*/
|
|
165
165
|
(search: StaffMemberSearch, options?: SearchStaffMembersOptions): Promise<NonNullablePaths<SearchStaffMembersResponse, `staffMembers` | `staffMembers.${number}.resource.usesDefaultWorkingHours` | `staffMembers.${number}.associatedWixIdentity.identificationData.anonymousVisitorId` | `staffMembers.${number}.associatedWixIdentity.identificationData.memberId` | `staffMembers.${number}.associatedWixIdentity.identificationData.wixUserId` | `staffMembers.${number}.associatedWixIdentity.identificationData.appId` | `staffMembers.${number}.associatedWixIdentity.connectionStatus` | `staffMembers.${number}.associatedWixIdentity.connection.status` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
|
|
166
166
|
}
|
|
@@ -181,12 +181,12 @@ interface DisconnectStaffMemberFromUserSignature {
|
|
|
181
181
|
declare function assignWorkingHoursSchedule$1(httpClient: HttpClient): AssignWorkingHoursScheduleSignature;
|
|
182
182
|
interface AssignWorkingHoursScheduleSignature {
|
|
183
183
|
/**
|
|
184
|
-
* Updates a staff member's working hours based on the specified schedule ID
|
|
184
|
+
* Updates a staff member's working hours based on the specified [schedule ID](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction).
|
|
185
185
|
*
|
|
186
186
|
*
|
|
187
187
|
* ### Default working hours
|
|
188
188
|
*
|
|
189
|
-
* By default, staff members work during the opening hours of the business's default location
|
|
189
|
+
* By default, staff members work during the opening hours of the business's default [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
|
|
190
190
|
*
|
|
191
191
|
* ### Schedule ID
|
|
192
192
|
*
|
|
@@ -196,14 +196,13 @@ interface AssignWorkingHoursScheduleSignature {
|
|
|
196
196
|
* #### Staff event schedule
|
|
197
197
|
*
|
|
198
198
|
* To customize a staff member's working hours, specify their event schedule ID as `scheduleId`.
|
|
199
|
-
* Refer to this sample flow
|
|
199
|
+
* Refer to this [sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/sample-flows#assign-a-staff-working-hour-schedule) for more details.
|
|
200
200
|
*
|
|
201
201
|
* #### Business working hour schedule
|
|
202
202
|
*
|
|
203
203
|
* To reset a staff member's working hours to the default business hours, specify the ID of the business working hour schedule as `scheduleId`.
|
|
204
204
|
* @param - ID of the staff member to assign the schedule to.
|
|
205
|
-
* @param - ID of the
|
|
206
|
-
* ([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))
|
|
205
|
+
* @param - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
207
206
|
* to assign to the staff member.
|
|
208
207
|
*
|
|
209
208
|
* Must be either the staff member's event schedule ID or the working hour
|
|
@@ -223,10 +222,9 @@ interface AssignCustomScheduleSignature {
|
|
|
223
222
|
* By default staff members use the shared business working hours schedule.
|
|
224
223
|
* By assigning a custom working hours schedule to a staff member, you can define specific working hours for that staff member.
|
|
225
224
|
*
|
|
226
|
-
* To create and manage schedules and working hours sessions, use the Events API
|
|
225
|
+
* To create and manage schedules and working hours sessions, use the [Events API](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction).
|
|
227
226
|
* @param - ID of the staff member for which to assign a working hour schedule.
|
|
228
|
-
* @param - ID of the
|
|
229
|
-
* ([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))
|
|
227
|
+
* @param - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
230
228
|
* to assign to the staff member.
|
|
231
229
|
* @deprecated
|
|
232
230
|
*/
|
|
@@ -235,7 +233,7 @@ interface AssignCustomScheduleSignature {
|
|
|
235
233
|
declare function bulkUpdateStaffMemberTags$1(httpClient: HttpClient): BulkUpdateStaffMemberTagsSignature;
|
|
236
234
|
interface BulkUpdateStaffMemberTagsSignature {
|
|
237
235
|
/**
|
|
238
|
-
* Synchronously updates tags
|
|
236
|
+
* Synchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for up to 100 staff members.
|
|
239
237
|
*
|
|
240
238
|
*
|
|
241
239
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
@@ -246,16 +244,15 @@ interface BulkUpdateStaffMemberTagsSignature {
|
|
|
246
244
|
declare function bulkUpdateStaffMemberTagsByFilter$1(httpClient: HttpClient): BulkUpdateStaffMemberTagsByFilterSignature;
|
|
247
245
|
interface BulkUpdateStaffMemberTagsByFilterSignature {
|
|
248
246
|
/**
|
|
249
|
-
* Asynchronously updates tags
|
|
247
|
+
* Asynchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for staff members, given the provided filtering.
|
|
250
248
|
*
|
|
251
249
|
*
|
|
252
250
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
253
251
|
*
|
|
254
252
|
* ### Filter
|
|
255
253
|
*
|
|
256
|
-
* Refer to the supported filters article
|
|
257
|
-
* @param - Filter to base the update upon. See the
|
|
258
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting))
|
|
254
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/filtering-and-sorting) for a complete list of supported filters and sorting options.
|
|
255
|
+
* @param - Filter to base the update upon. See the [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
259
256
|
* for a complete list of supported filters.
|
|
260
257
|
*/
|
|
261
258
|
(filter: Record<string, any>, options?: BulkUpdateStaffMemberTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateStaffMemberTagsByFilterResponse, `jobId`, 2>>;
|