@wix/auto_sdk_bookings_staff-members 1.0.67 → 1.0.69
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-q-tWyQ3e.d.ts → bookings-staff-v1-staff-member-staff-members.universal-BXgWwq9J.d.ts} +58 -84
- package/build/cjs/index.d.ts +28 -47
- package/build/cjs/index.js +54 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +5 -5
- package/build/cjs/index.typings.js +35 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +29 -52
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{bookings-staff-v1-staff-member-staff-members.universal-q-tWyQ3e.d.mts → bookings-staff-v1-staff-member-staff-members.universal-BXgWwq9J.d.mts} +58 -84
- package/build/es/index.d.mts +28 -47
- package/build/es/index.mjs +54 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +5 -5
- package/build/es/index.typings.mjs +34 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +29 -52
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{bookings-staff-v1-staff-member-staff-members.universal-q-tWyQ3e.d.ts → bookings-staff-v1-staff-member-staff-members.universal-BXgWwq9J.d.ts} +58 -84
- package/build/internal/cjs/index.d.ts +28 -47
- package/build/internal/cjs/index.js +54 -1
- 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 +35 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +29 -52
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{bookings-staff-v1-staff-member-staff-members.universal-q-tWyQ3e.d.mts → bookings-staff-v1-staff-member-staff-members.universal-BXgWwq9J.d.mts} +58 -84
- package/build/internal/es/index.d.mts +28 -47
- package/build/internal/es/index.mjs +54 -1
- 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 +34 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +29 -52
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -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.
|
|
@@ -133,12 +122,10 @@ interface Resource {
|
|
|
133
122
|
}
|
|
134
123
|
interface WorkingHoursSchedule {
|
|
135
124
|
/**
|
|
136
|
-
* ID of the working hour
|
|
137
|
-
* ([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)
|
|
138
126
|
* associated with the staff member. Currently, each staff member can't have more than a
|
|
139
127
|
* single working hour schedule. Learn more about
|
|
140
|
-
*
|
|
141
|
-
* ([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).
|
|
142
129
|
* @format GUID
|
|
143
130
|
*/
|
|
144
131
|
_id?: string | null;
|
|
@@ -150,19 +137,17 @@ interface WorkingHoursSchedule {
|
|
|
150
137
|
}
|
|
151
138
|
interface EventSchedule {
|
|
152
139
|
/**
|
|
153
|
-
* ID of the event
|
|
154
|
-
* ([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)
|
|
155
141
|
* associated with the staff member. Learn more about
|
|
156
142
|
* _how Wix Bookings uses the Calendar APIs_
|
|
157
|
-
*
|
|
143
|
+
* [Wix Bookings](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration).
|
|
158
144
|
* @format GUID
|
|
159
145
|
*/
|
|
160
146
|
_id?: string | null;
|
|
161
147
|
}
|
|
162
148
|
interface LocationOptions {
|
|
163
149
|
/**
|
|
164
|
-
* Whether the resource is available in all
|
|
165
|
-
* ([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).
|
|
166
151
|
*
|
|
167
152
|
* - `true`: The resource is available in all business locations.
|
|
168
153
|
* - `false`: The resource is available only in specific locations.
|
|
@@ -175,8 +160,7 @@ interface LocationOptions {
|
|
|
175
160
|
}
|
|
176
161
|
interface SpecificLocation {
|
|
177
162
|
/**
|
|
178
|
-
* Whether the resource is available in
|
|
179
|
-
* ([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).
|
|
180
164
|
*
|
|
181
165
|
* - `true`: The resource is available in business locations.
|
|
182
166
|
* - `false`: The resource isn't available in business locations.
|
|
@@ -195,8 +179,7 @@ interface SpecificLocation {
|
|
|
195
179
|
}
|
|
196
180
|
interface BusinessLocation {
|
|
197
181
|
/**
|
|
198
|
-
* ID of the business
|
|
199
|
-
* ([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).
|
|
200
183
|
* @format GUID
|
|
201
184
|
*/
|
|
202
185
|
locationId?: string | null;
|
|
@@ -205,8 +188,7 @@ interface BusinessLocation {
|
|
|
205
188
|
interface AssociatedWixIdentity {
|
|
206
189
|
/**
|
|
207
190
|
* Information about the identity connected to the staff member. Available only
|
|
208
|
-
* if the staff member is connected to a Wix user. Learn more about
|
|
209
|
-
* ([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).
|
|
210
192
|
*/
|
|
211
193
|
identificationData?: CommonIdentificationData;
|
|
212
194
|
/**
|
|
@@ -628,9 +610,8 @@ interface DeleteStaffMemberResponse {
|
|
|
628
610
|
}
|
|
629
611
|
interface QueryStaffMembersRequest {
|
|
630
612
|
/**
|
|
631
|
-
* Information about filters, paging, and sorting. See the
|
|
632
|
-
*
|
|
633
|
-
* ([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)
|
|
634
615
|
* for all supported filters and sorting options.
|
|
635
616
|
*/
|
|
636
617
|
query?: CursorQuery;
|
|
@@ -688,8 +669,7 @@ interface QueryStaffMembersResponse {
|
|
|
688
669
|
interface QueryStaffMembersMultiLanguageRequest {
|
|
689
670
|
/**
|
|
690
671
|
* Information about filters, paging, and sorting. See the article about
|
|
691
|
-
* booking policy filters
|
|
692
|
-
* ([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)
|
|
693
673
|
* for all supported filters and sorting options.
|
|
694
674
|
*/
|
|
695
675
|
query?: CursorQuery;
|
|
@@ -709,8 +689,8 @@ interface QueryStaffMembersMultiLanguageResponse {
|
|
|
709
689
|
}
|
|
710
690
|
interface CountStaffMembersRequest {
|
|
711
691
|
/**
|
|
712
|
-
* Filter to base the count upon. See the
|
|
713
|
-
*
|
|
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)
|
|
714
694
|
* for a complete list of supported filters.
|
|
715
695
|
*/
|
|
716
696
|
filter?: Record<string, any> | null;
|
|
@@ -747,7 +727,7 @@ interface SearchStaffMembersRequest {
|
|
|
747
727
|
/**
|
|
748
728
|
* Search criteria including filter, sort, and paging options.
|
|
749
729
|
*
|
|
750
|
-
* 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.
|
|
751
731
|
*/
|
|
752
732
|
search: CursorSearch;
|
|
753
733
|
/**
|
|
@@ -765,13 +745,13 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
765
745
|
/**
|
|
766
746
|
* Filter object for narrowing search results. For example, to return only staff members with specific email domains: `"filter": {"email": {"$contains": "@company.com"}}`.
|
|
767
747
|
*
|
|
768
|
-
* 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).
|
|
769
749
|
*/
|
|
770
750
|
filter?: Record<string, any> | null;
|
|
771
751
|
/**
|
|
772
752
|
* Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
773
753
|
*
|
|
774
|
-
* 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).
|
|
775
755
|
* @maxSize 10
|
|
776
756
|
*/
|
|
777
757
|
sort?: Sorting[];
|
|
@@ -1085,8 +1065,7 @@ interface AssignWorkingHoursScheduleRequest {
|
|
|
1085
1065
|
*/
|
|
1086
1066
|
staffMemberId: string;
|
|
1087
1067
|
/**
|
|
1088
|
-
* ID of the
|
|
1089
|
-
* ([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)
|
|
1090
1069
|
* to assign to the staff member.
|
|
1091
1070
|
*
|
|
1092
1071
|
* Must be either the staff member's event schedule ID or the working hour
|
|
@@ -1111,8 +1090,7 @@ interface AssignCustomScheduleRequest {
|
|
|
1111
1090
|
*/
|
|
1112
1091
|
staffMemberId: string;
|
|
1113
1092
|
/**
|
|
1114
|
-
* ID of the
|
|
1115
|
-
* ([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)
|
|
1116
1094
|
* to assign to the staff member.
|
|
1117
1095
|
* @format GUID
|
|
1118
1096
|
*/
|
|
@@ -1185,8 +1163,7 @@ interface BulkActionMetadata {
|
|
|
1185
1163
|
}
|
|
1186
1164
|
interface BulkUpdateStaffMemberTagsByFilterRequest {
|
|
1187
1165
|
/**
|
|
1188
|
-
* Filter to base the update upon. See the
|
|
1189
|
-
* ([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)
|
|
1190
1167
|
* for a complete list of supported filters.
|
|
1191
1168
|
*/
|
|
1192
1169
|
filter: Record<string, any> | null;
|
|
@@ -2640,7 +2617,7 @@ declare function onStaffMemberUpdated(handler: (event: StaffMemberUpdatedEnvelop
|
|
|
2640
2617
|
*
|
|
2641
2618
|
*
|
|
2642
2619
|
* By default, the staff member works during the business working hours.
|
|
2643
|
-
* 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.
|
|
2644
2621
|
* @param staffMember - Staff member to create.
|
|
2645
2622
|
* @public
|
|
2646
2623
|
* @requiredField staffMember
|
|
@@ -2794,16 +2771,14 @@ interface UpdateStaffMember {
|
|
|
2794
2771
|
/** Staff media. */
|
|
2795
2772
|
mainMedia?: MediaItem;
|
|
2796
2773
|
/**
|
|
2797
|
-
* Staff member's
|
|
2798
|
-
* ([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),
|
|
2799
2775
|
* identical to `resource.id`.
|
|
2800
2776
|
* @readonly
|
|
2801
2777
|
* @format GUID
|
|
2802
2778
|
*/
|
|
2803
2779
|
resourceId?: string | null;
|
|
2804
2780
|
/**
|
|
2805
|
-
* Details about the
|
|
2806
|
-
* ([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)
|
|
2807
2782
|
* associated with the staff member. Available only if you specify `RESOURCE_DETAILS`
|
|
2808
2783
|
* in the `fields` array.
|
|
2809
2784
|
* @readonly
|
|
@@ -2811,8 +2786,7 @@ interface UpdateStaffMember {
|
|
|
2811
2786
|
resource?: Resource;
|
|
2812
2787
|
/**
|
|
2813
2788
|
* Identity of the Wix user associated with the staff member. Learn more about
|
|
2814
|
-
*
|
|
2815
|
-
* ([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).
|
|
2816
2790
|
* @readonly
|
|
2817
2791
|
*/
|
|
2818
2792
|
associatedWixIdentity?: AssociatedWixIdentity;
|
|
@@ -2835,10 +2809,7 @@ interface UpdateStaffMember {
|
|
|
2835
2809
|
_updatedDate?: Date | null;
|
|
2836
2810
|
/** Extensions enabling users to save custom data related to the staff member. */
|
|
2837
2811
|
extendedFields?: ExtendedFields;
|
|
2838
|
-
/**
|
|
2839
|
-
* Tags allowing you to classify staff members. Learn more about *tags*
|
|
2840
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction)).
|
|
2841
|
-
*/
|
|
2812
|
+
/** Tags allowing you to classify staff members. Learn more about [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction). */
|
|
2842
2813
|
tags?: Tags;
|
|
2843
2814
|
}
|
|
2844
2815
|
interface UpdateStaffMemberOptions {
|
|
@@ -2852,7 +2823,7 @@ interface UpdateStaffMemberOptions {
|
|
|
2852
2823
|
* Deletes a staff member.
|
|
2853
2824
|
*
|
|
2854
2825
|
*
|
|
2855
|
-
* 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.
|
|
2856
2827
|
* @param staffMemberId - ID of the staff member to delete.
|
|
2857
2828
|
* @public
|
|
2858
2829
|
* @requiredField staffMemberId
|
|
@@ -2953,13 +2924,19 @@ interface StaffMembersQueryBuilder {
|
|
|
2953
2924
|
skipTo: (cursor: string) => StaffMembersQueryBuilder;
|
|
2954
2925
|
find: () => Promise<StaffMembersQueryResult>;
|
|
2955
2926
|
}
|
|
2927
|
+
/**
|
|
2928
|
+
* @hidden
|
|
2929
|
+
* @fqn wix.bookings.staff.v1.StaffMembersService.QueryStaffMembers
|
|
2930
|
+
* @requiredField query
|
|
2931
|
+
*/
|
|
2932
|
+
declare function typedQueryStaffMembers(query: CursorQuery, options?: QueryStaffMembersOptions): Promise<NonNullablePaths<QueryStaffMembersResponse, `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`, 6>>;
|
|
2956
2933
|
/**
|
|
2957
2934
|
* Counts how many staff members match the given filter.
|
|
2958
2935
|
*
|
|
2959
2936
|
*
|
|
2960
2937
|
* ### Filter
|
|
2961
2938
|
*
|
|
2962
|
-
* Refer to the supported filters article
|
|
2939
|
+
* 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.
|
|
2963
2940
|
*
|
|
2964
2941
|
* ### See also
|
|
2965
2942
|
*
|
|
@@ -2972,8 +2949,8 @@ interface StaffMembersQueryBuilder {
|
|
|
2972
2949
|
declare function countStaffMembers(options?: CountStaffMembersOptions): Promise<NonNullablePaths<CountStaffMembersResponse, `count`, 2>>;
|
|
2973
2950
|
interface CountStaffMembersOptions {
|
|
2974
2951
|
/**
|
|
2975
|
-
* Filter to base the count upon. See the
|
|
2976
|
-
*
|
|
2952
|
+
* Filter to base the count upon. See the
|
|
2953
|
+
* [supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/filtering-and-sorting)
|
|
2977
2954
|
* for a complete list of supported filters.
|
|
2978
2955
|
*/
|
|
2979
2956
|
filter?: Record<string, any> | null;
|
|
@@ -2986,9 +2963,9 @@ interface CountStaffMembersOptions {
|
|
|
2986
2963
|
* 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.
|
|
2987
2964
|
* If an existing user is found but not linked to the site, Wix Bookings sends an invitation to join the site.
|
|
2988
2965
|
*
|
|
2989
|
-
* To check the connection status, call Get Staff Member
|
|
2966
|
+
* 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.
|
|
2990
2967
|
*
|
|
2991
|
-
* You must call Disconnect Staff Member From User
|
|
2968
|
+
* 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.
|
|
2992
2969
|
* @param staffMemberId - ID of the staff member to connect to the Wix user.
|
|
2993
2970
|
* @public
|
|
2994
2971
|
* @requiredField staffMemberId
|
|
@@ -3056,13 +3033,13 @@ type StaffMemberSearch = {
|
|
|
3056
3033
|
/**
|
|
3057
3034
|
Filter object for narrowing search results. For example, to return only staff members with specific email domains: `"filter": {"email": {"$contains": "@company.com"}}`.
|
|
3058
3035
|
|
|
3059
|
-
Learn more about the filter format in the supported filters article
|
|
3036
|
+
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).
|
|
3060
3037
|
*/
|
|
3061
3038
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
3062
3039
|
/**
|
|
3063
3040
|
Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
3064
3041
|
|
|
3065
|
-
Learn more about the sort format in the supported filters article
|
|
3042
|
+
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).
|
|
3066
3043
|
@maxSize: 10
|
|
3067
3044
|
*/
|
|
3068
3045
|
sort?: {
|
|
@@ -3125,12 +3102,12 @@ interface DisconnectStaffMemberFromUserOptions {
|
|
|
3125
3102
|
fields?: RequestedFieldsWithLiterals[];
|
|
3126
3103
|
}
|
|
3127
3104
|
/**
|
|
3128
|
-
* Updates a staff member's working hours based on the specified schedule ID
|
|
3105
|
+
* 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).
|
|
3129
3106
|
*
|
|
3130
3107
|
*
|
|
3131
3108
|
* ### Default working hours
|
|
3132
3109
|
*
|
|
3133
|
-
* By default, staff members work during the opening hours of the business's default location
|
|
3110
|
+
* 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).
|
|
3134
3111
|
*
|
|
3135
3112
|
* ### Schedule ID
|
|
3136
3113
|
*
|
|
@@ -3140,14 +3117,13 @@ interface DisconnectStaffMemberFromUserOptions {
|
|
|
3140
3117
|
* #### Staff event schedule
|
|
3141
3118
|
*
|
|
3142
3119
|
* To customize a staff member's working hours, specify their event schedule ID as `scheduleId`.
|
|
3143
|
-
* Refer to this sample flow
|
|
3120
|
+
* 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.
|
|
3144
3121
|
*
|
|
3145
3122
|
* #### Business working hour schedule
|
|
3146
3123
|
*
|
|
3147
3124
|
* To reset a staff member's working hours to the default business hours, specify the ID of the business working hour schedule as `scheduleId`.
|
|
3148
3125
|
* @param staffMemberId - ID of the staff member to assign the schedule to.
|
|
3149
|
-
* @param scheduleId - ID of the
|
|
3150
|
-
* ([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))
|
|
3126
|
+
* @param scheduleId - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
3151
3127
|
* to assign to the staff member.
|
|
3152
3128
|
*
|
|
3153
3129
|
* Must be either the staff member's event schedule ID or the working hour
|
|
@@ -3177,10 +3153,9 @@ interface AssignWorkingHoursScheduleOptions {
|
|
|
3177
3153
|
* By default staff members use the shared business working hours schedule.
|
|
3178
3154
|
* By assigning a custom working hours schedule to a staff member, you can define specific working hours for that staff member.
|
|
3179
3155
|
*
|
|
3180
|
-
* To create and manage schedules and working hours sessions, use the Events API
|
|
3156
|
+
* 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).
|
|
3181
3157
|
* @param staffMemberId - ID of the staff member for which to assign a working hour schedule.
|
|
3182
|
-
* @param scheduleId - ID of the
|
|
3183
|
-
* ([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))
|
|
3158
|
+
* @param scheduleId - ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
3184
3159
|
* to assign to the staff member.
|
|
3185
3160
|
* @public
|
|
3186
3161
|
* @requiredField scheduleId
|
|
@@ -3201,7 +3176,7 @@ interface AssignCustomScheduleOptions {
|
|
|
3201
3176
|
fields?: RequestedFieldsWithLiterals[];
|
|
3202
3177
|
}
|
|
3203
3178
|
/**
|
|
3204
|
-
* Synchronously updates tags
|
|
3179
|
+
* Synchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for up to 100 staff members.
|
|
3205
3180
|
*
|
|
3206
3181
|
*
|
|
3207
3182
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
@@ -3220,16 +3195,15 @@ interface BulkUpdateStaffMemberTagsOptions {
|
|
|
3220
3195
|
unassignTags?: Tags;
|
|
3221
3196
|
}
|
|
3222
3197
|
/**
|
|
3223
|
-
* Asynchronously updates tags
|
|
3198
|
+
* Asynchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) for staff members, given the provided filtering.
|
|
3224
3199
|
*
|
|
3225
3200
|
*
|
|
3226
3201
|
* If you specify a tag both in `assignTags` and `unassignTags`, the call succeeds and the tag is assigned.
|
|
3227
3202
|
*
|
|
3228
3203
|
* ### Filter
|
|
3229
3204
|
*
|
|
3230
|
-
* Refer to the supported filters article
|
|
3231
|
-
* @param filter - Filter to base the update upon. See the
|
|
3232
|
-
* ([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))
|
|
3205
|
+
* 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.
|
|
3206
|
+
* @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)
|
|
3233
3207
|
* for a complete list of supported filters.
|
|
3234
3208
|
* @public
|
|
3235
3209
|
* @requiredField filter
|
|
@@ -3245,4 +3219,4 @@ interface BulkUpdateStaffMemberTagsByFilterOptions {
|
|
|
3245
3219
|
unassignTags?: Tags;
|
|
3246
3220
|
}
|
|
3247
3221
|
|
|
3248
|
-
export {
|
|
3222
|
+
export { ConferenceType as $, type AssignWorkingHoursScheduleOptions as A, type BulkUpdateStaffMemberTagsOptions as B, type CreateStaffMemberOptions as C, type DisconnectStaffMemberFromUserOptions as D, type StaffMembersQueryBuilder as E, AssociatedWixIdentityConnectionStatusEnumConnectionStatus as F, type GetStaffMemberOptions as G, ConnectionStatus as H, IdentityType as I, SortOrder as J, ScalarType as K, type ListDeletedStaffMembersOptions as L, Mode as M, AggregationType as N, Day as O, RecurringIntervalType as P, type QueryStaffMembersOptions as Q, RequestedFields as R, type StaffMember as S, Transparency as T, type UpdateStaffMember as U, LocationType as V, LocationStatus as W, LocationsLocationType as X, DayOfWeek as Y, ApprovalStatus as Z, ScheduleStatus as _, type GetDeletedStaffMemberOptions as a, type RangeResults as a$, CalendarType as a0, Status as a1, SessionType as a2, WebhookIdentityType as a3, type MediaItem as a4, type MediaItemMediaOneOf as a5, type Resource as a6, type WorkingHoursSchedule as a7, type EventSchedule as a8, type LocationOptions as a9, type Cursors as aA, type RemoveStaffMemberFromTrashBinRequest as aB, type RemoveStaffMemberFromTrashBinResponse as aC, type RestoreStaffMemberFromTrashBinRequest as aD, type RestoreStaffMemberFromTrashBinResponse as aE, type UpdateStaffMemberRequest as aF, type UpdateStaffMemberResponse as aG, type DeleteStaffMemberRequest as aH, type DeleteStaffMemberResponse as aI, type QueryStaffMembersRequest as aJ, type CursorQueryPagingMethodOneOf as aK, type Sorting as aL, type QueryStaffMembersResponse as aM, type QueryStaffMembersMultiLanguageRequest as aN, type QueryStaffMembersMultiLanguageResponse as aO, type CountStaffMembersRequest as aP, type ConnectStaffMemberToUserRequest as aQ, type SearchStaffMembersRequest as aR, type CursorSearch as aS, type CursorSearchPagingMethodOneOf as aT, type SearchDetails as aU, type AggregationData as aV, type ValueAggregationResult as aW, type RangeAggregationResult as aX, type NestedAggregationResults as aY, type NestedAggregationResultsResultOneOf as aZ, type ValueResults as a_, type SpecificLocation as aa, type BusinessLocation as ab, type AssociatedWixIdentity as ac, type CommonIdentificationData as ad, type CommonIdentificationDataIdOneOf as ae, type Connection as af, type AssociatedConferencingProviders as ag, type AssociatedConferencingProvider as ah, type AssociatedConferencingAccounts as ai, type AssociatedConferencingAccount as aj, type AssociatedConferencingAccountAccountOneOf as ak, type CustomConferenceAccount as al, type ExtendedFields as am, type Tags as an, type TagList as ao, type StaffMemberDisconnectedFromUser as ap, type StaffMemberConnectedToUser as aq, type StaffMemberFullyCreated as ar, type CreateStaffMemberRequest as as, type CreateStaffMemberResponse as at, type GetStaffMemberRequest as au, type GetStaffMemberResponse as av, type GetDeletedStaffMemberRequest as aw, type ListDeletedStaffMembersRequest as ax, type CursorPaging as ay, type CursorPagingMetadata as az, type GetDeletedStaffMemberResponse as b, type Version as b$, type AggregationResultsScalarResult as b0, type NestedValueAggregationResult as b1, type ValueResult as b2, type RangeResult as b3, type ScalarResult as b4, type NestedResultValue as b5, type NestedResultValueResultOneOf as b6, type Results as b7, type DateHistogramResult as b8, type GroupByValueResults as b9, type ScheduleNotificationEventOneOf as bA, type ScheduleCreated as bB, type Schedule as bC, type RecurringInterval as bD, type Interval as bE, type Frequency as bF, type LinkedSchedule as bG, type Location as bH, type Address as bI, type AddressStreetOneOf as bJ, type StreetAddress as bK, type AddressLocation as bL, type Subdivision as bM, type LocationsLocation as bN, type LocationsAddress as bO, type LocationsStreetAddress as bP, type LocationsAddressLocation as bQ, type BusinessSchedule as bR, type TimePeriod as bS, type SpecialHourPeriod as bT, type Rate as bU, type Price as bV, type Availability as bW, type AvailabilityConstraints as bX, type SplitInterval as bY, type Participant as bZ, type ExternalCalendarOverrides as b_, type DateHistogramResults as ba, type NestedResults as bb, type AggregationResults as bc, type AggregationResultsResultOneOf as bd, type DisconnectStaffMemberFromUserRequest as be, type AssignWorkingHoursScheduleRequest as bf, type AssignCustomScheduleRequest as bg, type BulkUpdateStaffMemberTagsRequest as bh, type ItemMetadata as bi, type ApplicationError as bj, type BulkUpdateStaffMemberTagsResult as bk, type BulkActionMetadata as bl, type BulkUpdateStaffMemberTagsByFilterRequest as bm, type RestoreStaffRequest as bn, type RestoreStaffResponse as bo, type Empty as bp, type PolicyRemovedFromContributor as bq, type PolicyUpdatedForContributor as br, type DomainEvent as bs, type DomainEventBodyOneOf as bt, type EntityCreatedEvent as bu, type RestoreInfo as bv, type EntityUpdatedEvent as bw, type EntityDeletedEvent as bx, type ActionEvent as by, type ScheduleNotification as bz, type ListDeletedStaffMembersResponse as c, getDeletedStaffMember as c$, type ConferenceProvider as c0, type CalendarConference as c1, type ScheduleUpdated as c2, type RecurringSessionsUpdated as c3, type Session as c4, type CalendarDateTime as c5, type LocalDateTime as c6, type ExternalCalendarInfo as c7, type SessionVersion as c8, type ParticipantNotification as c9, type SortOrderWithLiterals as cA, type ModeWithLiterals as cB, type ScalarTypeWithLiterals as cC, type AggregationTypeWithLiterals as cD, type DayWithLiterals as cE, type TransparencyWithLiterals as cF, type RecurringIntervalTypeWithLiterals as cG, type LocationTypeWithLiterals as cH, type LocationStatusWithLiterals as cI, type LocationsLocationTypeWithLiterals as cJ, type DayOfWeekWithLiterals as cK, type ApprovalStatusWithLiterals as cL, type ScheduleStatusWithLiterals as cM, type ConferenceTypeWithLiterals as cN, type CalendarTypeWithLiterals as cO, type StatusWithLiterals as cP, type SessionTypeWithLiterals as cQ, type WebhookIdentityTypeWithLiterals as cR, type CommonSearchWithEntityContext as cS, onStaffMemberConnectedToUser as cT, onStaffMemberCreated as cU, onStaffMemberDeleted as cV, onStaffMemberDisconnectedFromUser as cW, onStaffMemberFullyCreated as cX, onStaffMemberUpdated as cY, createStaffMember as cZ, getStaffMember as c_, type ScheduleCancelled as ca, type SessionCreated as cb, type SessionUpdated as cc, type SessionCancelled as cd, type AvailabilityPolicyUpdated as ce, type AvailabilityPolicy as cf, type IntervalSplit as cg, type RecurringSessionSplit as ch, type ScheduleUnassignedFromUser as ci, type MultipleSessionsCreated as cj, type ScheduleWithSessions as ck, type SitePropertiesOnScheduleCreation as cl, type MigrationEvent as cm, type MigrationData as cn, type StaffData as co, type MessageEnvelope as cp, type IdentificationData as cq, type IdentificationDataIdOneOf as cr, type BaseEventMetadata as cs, type EventMetadata as ct, type StaffMembersQueryResult as cu, type StaffMemberSearchSpec as cv, type IdentityTypeWithLiterals as cw, type AssociatedWixIdentityConnectionStatusEnumConnectionStatusWithLiterals as cx, type ConnectionStatusWithLiterals as cy, type RequestedFieldsWithLiterals as cz, type UpdateStaffMemberOptions as d, listDeletedStaffMembers as d0, removeStaffMemberFromTrashBin as d1, updateStaffMember as d2, deleteStaffMember as d3, queryStaffMembers as d4, countStaffMembers as d5, connectStaffMemberToUser as d6, disconnectStaffMemberFromUser as d7, assignWorkingHoursSchedule as d8, assignCustomSchedule as d9, bulkUpdateStaffMemberTags as da, bulkUpdateStaffMemberTagsByFilter as db, type CountStaffMembersOptions as e, type CountStaffMembersResponse as f, type ConnectStaffMemberToUserOptions as g, type ConnectStaffMemberToUserResponse as h, type StaffMemberSearch as i, type SearchStaffMembersOptions as j, type SearchStaffMembersResponse as k, type DisconnectStaffMemberFromUserResponse as l, type AssignWorkingHoursScheduleResponse as m, type AssignCustomScheduleOptions as n, type AssignCustomScheduleResponse as o, type BulkUpdateStaffMemberTagsResponse as p, type BulkUpdateStaffMemberTagsByFilterOptions as q, type BulkUpdateStaffMemberTagsByFilterResponse as r, type StaffMemberConnectedToUserEnvelope as s, type StaffMemberCreatedEnvelope as t, type StaffMemberDeletedEnvelope as u, type StaffMemberDisconnectedFromUserEnvelope as v, type StaffMemberFullyCreatedEnvelope as w, type StaffMemberUpdatedEnvelope as x, type CursorQuery as y, typedQueryStaffMembers as z };
|