@wix/auto_sdk_bookings_services 1.0.150 → 1.0.151
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-services-v2-service-services.universal-BPPGPPHk.d.ts → bookings-services-v2-service-services.universal-BB-68oF3.d.ts} +77 -165
- package/build/cjs/index.d.ts +43 -91
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +5 -9
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +27 -58
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{bookings-services-v2-service-services.universal-BPPGPPHk.d.mts → bookings-services-v2-service-services.universal-BB-68oF3.d.mts} +77 -165
- package/build/es/index.d.mts +43 -91
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +5 -9
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +27 -58
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{bookings-services-v2-service-services.universal-BPPGPPHk.d.ts → bookings-services-v2-service-services.universal-BB-68oF3.d.ts} +77 -165
- package/build/internal/cjs/index.d.ts +43 -91
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +5 -9
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +27 -58
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{bookings-services-v2-service-services.universal-BPPGPPHk.d.mts → bookings-services-v2-service-services.universal-BB-68oF3.d.mts} +77 -165
- package/build/internal/es/index.d.mts +43 -91
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +5 -9
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +27 -58
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -10,14 +10,10 @@ interface Service {
|
|
|
10
10
|
_id?: string | null;
|
|
11
11
|
/**
|
|
12
12
|
* Service type.
|
|
13
|
-
* Learn more about
|
|
14
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
|
|
13
|
+
* Learn more about [service types](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types).
|
|
15
14
|
*/
|
|
16
15
|
type?: ServiceTypeWithLiterals;
|
|
17
|
-
/**
|
|
18
|
-
* Order of the service within a *category*
|
|
19
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
|
|
20
|
-
*/
|
|
16
|
+
/** Order of the service within a [category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object). */
|
|
21
17
|
sortOrder?: number | null;
|
|
22
18
|
/**
|
|
23
19
|
* Service name.
|
|
@@ -46,8 +42,7 @@ interface Service {
|
|
|
46
42
|
/** Whether the service is hidden from Wix Bookings pages and widgets. */
|
|
47
43
|
hidden?: boolean | null;
|
|
48
44
|
/**
|
|
49
|
-
*
|
|
50
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object))
|
|
45
|
+
* [Category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)
|
|
51
46
|
* the service is associated with.
|
|
52
47
|
*/
|
|
53
48
|
category?: V2Category;
|
|
@@ -55,8 +50,7 @@ interface Service {
|
|
|
55
50
|
form?: Form;
|
|
56
51
|
/**
|
|
57
52
|
* Payment options for booking the service.
|
|
58
|
-
* Learn more about
|
|
59
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-payments) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments)).
|
|
53
|
+
* Learn more about [service payments](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments).
|
|
60
54
|
*/
|
|
61
55
|
payment?: Payment;
|
|
62
56
|
/** Online booking settings. */
|
|
@@ -64,28 +58,23 @@ interface Service {
|
|
|
64
58
|
/** Conferencing options for the service. */
|
|
65
59
|
conferencing?: Conferencing;
|
|
66
60
|
/**
|
|
67
|
-
* The locations this service is offered at. Read more about
|
|
68
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations)).
|
|
61
|
+
* The locations this service is offered at. Read more about [service locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations).
|
|
69
62
|
* @immutable
|
|
70
63
|
* @maxSize 500
|
|
71
64
|
*/
|
|
72
65
|
locations?: Location[];
|
|
73
66
|
/**
|
|
74
|
-
*
|
|
75
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction))
|
|
67
|
+
* [Policy](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)
|
|
76
68
|
* determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins.
|
|
77
69
|
*/
|
|
78
70
|
bookingPolicy?: BookingPolicy;
|
|
79
71
|
/**
|
|
80
|
-
* The service's
|
|
81
|
-
*
|
|
82
|
-
* which can be used to manage the service's *events*
|
|
83
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
|
|
72
|
+
* The service's [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
|
|
73
|
+
* which can be used to manage the service's [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
84
74
|
*/
|
|
85
75
|
schedule?: Schedule;
|
|
86
76
|
/**
|
|
87
|
-
* IDs of the
|
|
88
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
|
|
77
|
+
* IDs of the [staff members](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)
|
|
89
78
|
* providing the service. Available only for appointment-based services.
|
|
90
79
|
* @maxSize 220
|
|
91
80
|
* @format GUID
|
|
@@ -106,8 +95,7 @@ interface Service {
|
|
|
106
95
|
supportedSlugs?: Slug[];
|
|
107
96
|
/**
|
|
108
97
|
* Active slug for the service.
|
|
109
|
-
* Learn more about
|
|
110
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-slugs) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs)).
|
|
98
|
+
* Learn more about [service slugs](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs).
|
|
111
99
|
* @readonly
|
|
112
100
|
*/
|
|
113
101
|
mainSlug?: Slug;
|
|
@@ -233,7 +221,7 @@ interface Payment extends PaymentRateOneOf {
|
|
|
233
221
|
*/
|
|
234
222
|
pricingPlanIds?: string[];
|
|
235
223
|
/**
|
|
236
|
-
* How customers can pay for add-ons when paying for the related booking with a pricing plan
|
|
224
|
+
* How customers can pay for add-ons when paying for the related booking with a [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction).
|
|
237
225
|
* If customers pay for the booking using any method other than a pricing plan, the value of this field is ignored.
|
|
238
226
|
*/
|
|
239
227
|
addOnOption?: AddOnPaymentOptionsWithLiterals;
|
|
@@ -416,15 +404,9 @@ interface LocationOptionsOneOf {
|
|
|
416
404
|
}
|
|
417
405
|
declare enum LocationType {
|
|
418
406
|
UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
|
|
419
|
-
/**
|
|
420
|
-
* Location set by the business that is not a standard business *location*
|
|
421
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
422
|
-
*/
|
|
407
|
+
/** Location set by the business that is not a standard business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
423
408
|
CUSTOM = "CUSTOM",
|
|
424
|
-
/**
|
|
425
|
-
* Business *location*
|
|
426
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
427
|
-
*/
|
|
409
|
+
/** Business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
428
410
|
BUSINESS = "BUSINESS",
|
|
429
411
|
/**
|
|
430
412
|
* The customer specifies any address when booking. Available only for
|
|
@@ -498,8 +480,7 @@ interface AddressLocation {
|
|
|
498
480
|
}
|
|
499
481
|
interface BusinessLocationOptions {
|
|
500
482
|
/**
|
|
501
|
-
* ID of the business
|
|
502
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
483
|
+
* ID of the business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
|
|
503
484
|
* When setting a business location, specify only the location ID. Other location details are overwritten.
|
|
504
485
|
* @format GUID
|
|
505
486
|
*/
|
|
@@ -990,8 +971,7 @@ declare enum CompletionRequirement {
|
|
|
990
971
|
type CompletionRequirementWithLiterals = CompletionRequirement | 'UNKNOWN_COMPLETION_REQUIREMENT' | 'OPTIONAL' | 'REQUIRED_BEFORE_BOOKING';
|
|
991
972
|
interface Schedule {
|
|
992
973
|
/**
|
|
993
|
-
* ID of the
|
|
994
|
-
* ([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))
|
|
974
|
+
* ID of the [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
995
975
|
* to which the service's events belong.
|
|
996
976
|
* @format GUID
|
|
997
977
|
* @readonly
|
|
@@ -1016,8 +996,7 @@ interface AvailabilityConstraints {
|
|
|
1016
996
|
* appointment-based services without varied pricing based on session length, it
|
|
1017
997
|
* matches the single value in the `sessionDurations` array. For appointment-based
|
|
1018
998
|
* services with varied pricing based on session length, it includes session
|
|
1019
|
-
* durations for all
|
|
1020
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)),
|
|
999
|
+
* durations for all [variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction),
|
|
1021
1000
|
* while ignoring `sessionDurations`.
|
|
1022
1001
|
* For courses and classes, it includes durations for all future
|
|
1023
1002
|
* recurring sessions but excludes durations for one-off or past recurring sessions.
|
|
@@ -1029,7 +1008,7 @@ interface AvailabilityConstraints {
|
|
|
1029
1008
|
* List of supported session durations in minutes.
|
|
1030
1009
|
*
|
|
1031
1010
|
* - For appointment-based services, specify `sessionDurations` when creating a service.
|
|
1032
|
-
* - For appointment-based services with varied pricing by session length, you must still specify `sessionDurations`, but the values are ignored. Actual durations are taken from the service variants
|
|
1011
|
+
* - For appointment-based services with varied pricing by session length, you must still specify `sessionDurations`, but the values are ignored. Actual durations are taken from the [service variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
1033
1012
|
* - For classes or courses, don't specify `sessionDurations` when creating a service.
|
|
1034
1013
|
*
|
|
1035
1014
|
* Min: `1` minute
|
|
@@ -1130,10 +1109,7 @@ interface ResourceIds {
|
|
|
1130
1109
|
values?: string[];
|
|
1131
1110
|
}
|
|
1132
1111
|
interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
1133
|
-
/**
|
|
1134
|
-
* Details about the required *resource type*
|
|
1135
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
|
|
1136
|
-
*/
|
|
1112
|
+
/** Details about the required [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction). */
|
|
1137
1113
|
resourceType?: ResourceType;
|
|
1138
1114
|
}
|
|
1139
1115
|
/** @oneof */
|
|
@@ -2036,7 +2012,7 @@ interface SearchServicesRequest {
|
|
|
2036
2012
|
/**
|
|
2037
2013
|
* Search criteria including filter, sort, aggregations, and paging options.
|
|
2038
2014
|
*
|
|
2039
|
-
* Refer to the supported filters article
|
|
2015
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting) for complete filter and sorting options.
|
|
2040
2016
|
*/
|
|
2041
2017
|
search: CursorSearch;
|
|
2042
2018
|
}
|
|
@@ -2049,13 +2025,13 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
2049
2025
|
/**
|
|
2050
2026
|
* Filter object for narrowing search results. For example, to return only services with specific payment options: `"filter": {"payment.options.online": true, "payment.options.in_person": false}`.
|
|
2051
2027
|
*
|
|
2052
|
-
* Learn more about the filter format in the supported filters article
|
|
2028
|
+
* Learn more about the filter format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting).
|
|
2053
2029
|
*/
|
|
2054
2030
|
filter?: Record<string, any> | null;
|
|
2055
2031
|
/**
|
|
2056
2032
|
* Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
2057
2033
|
*
|
|
2058
|
-
* Learn more about the sort format in the supported filters article
|
|
2034
|
+
* Learn more about the sort format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting).
|
|
2059
2035
|
* @maxSize 10
|
|
2060
2036
|
*/
|
|
2061
2037
|
sort?: Sorting[];
|
|
@@ -2646,8 +2622,7 @@ interface BookingPolicyWithServices {
|
|
|
2646
2622
|
/**
|
|
2647
2623
|
* Up to 5 services connected to the booking policy. If `totalServiceCount` is
|
|
2648
2624
|
* greater than 5, there are additional services connected to the policy.
|
|
2649
|
-
* You can call Search Services
|
|
2650
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
2625
|
+
* You can call [Search Services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/search-services)
|
|
2651
2626
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2652
2627
|
* connected to a booking policy.
|
|
2653
2628
|
* @maxSize 5
|
|
@@ -2691,8 +2666,7 @@ interface BookingForm {
|
|
|
2691
2666
|
/**
|
|
2692
2667
|
* Up to 5 services connected to the booking form. If `totalServiceCount` is
|
|
2693
2668
|
* greater than 5, there are additional services connected to the policy.
|
|
2694
|
-
* You can call Search Services
|
|
2695
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
2669
|
+
* You can call [Search Services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/search-services)
|
|
2696
2670
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2697
2671
|
* connected to a booking policy.
|
|
2698
2672
|
* @maxSize 5
|
|
@@ -2912,8 +2886,7 @@ interface EnablePricingPlansForServiceRequest {
|
|
|
2912
2886
|
*/
|
|
2913
2887
|
serviceId: string;
|
|
2914
2888
|
/**
|
|
2915
|
-
* IDs of the pricing plans
|
|
2916
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
2889
|
+
* IDs of the [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/plans/introduction)
|
|
2917
2890
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
2918
2891
|
* @format GUID
|
|
2919
2892
|
* @maxSize 100
|
|
@@ -2943,8 +2916,7 @@ interface DisablePricingPlansForServiceRequest {
|
|
|
2943
2916
|
*/
|
|
2944
2917
|
serviceId: string;
|
|
2945
2918
|
/**
|
|
2946
|
-
* IDs of the pricing plans
|
|
2947
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
2919
|
+
* IDs of the [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/plans/introduction)
|
|
2948
2920
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
2949
2921
|
* @format GUID
|
|
2950
2922
|
* @maxSize 75
|
|
@@ -3027,10 +2999,7 @@ interface CloneServiceResponse {
|
|
|
3027
2999
|
errors?: CloneErrorsWithLiterals[];
|
|
3028
3000
|
}
|
|
3029
3001
|
declare enum CloneErrors {
|
|
3030
|
-
/**
|
|
3031
|
-
* Failed to clone the original service's *options and variants*
|
|
3032
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
3033
|
-
*/
|
|
3002
|
+
/** Failed to clone the original service's [options and variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction). */
|
|
3034
3003
|
OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
|
|
3035
3004
|
/** Failed to clone the original service's *booking form*. */
|
|
3036
3005
|
FORM = "FORM"
|
|
@@ -3938,8 +3907,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3938
3907
|
* ### Required fields
|
|
3939
3908
|
*
|
|
3940
3909
|
* When creating a service you must specify the following fields:
|
|
3941
|
-
* - `type`
|
|
3942
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)):
|
|
3910
|
+
* - [`type`](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-types):
|
|
3943
3911
|
* Whether it's an appointment-based service, class, or course.
|
|
3944
3912
|
* - `name`: Service name that's displayed to customers.
|
|
3945
3913
|
* - `onlineBooking`:
|
|
@@ -3947,8 +3915,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3947
3915
|
* must manually confirm bookings, and whether customers can request to book an
|
|
3948
3916
|
* appointment time slot that already has a booking request awaiting business
|
|
3949
3917
|
* confirmation.
|
|
3950
|
-
* - `payment`
|
|
3951
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-payments) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments)):
|
|
3918
|
+
* - [`payment`](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/about-service-payments):
|
|
3952
3919
|
* How customers can pay when signing up for the service.
|
|
3953
3920
|
* - `defaultCapacity`: The maximum number of customers that can book the service. Required for all service types. For appointment-based services, it must be `1`.
|
|
3954
3921
|
*
|
|
@@ -3971,8 +3938,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3971
3938
|
* - Specify all supported session durations in `schedule.availabilityConstraints.sessionDurations`.
|
|
3972
3939
|
* - Note that Wix Bookings doesn't display these values to customers and
|
|
3973
3940
|
* ignores them in pricing and availability calculations. Instead session
|
|
3974
|
-
* durations are retrieved from the relevant service variants
|
|
3975
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
3941
|
+
* durations are retrieved from the relevant [service variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
3976
3942
|
* - It is mandatory to specify `schedule.availabilityConstraints.sessionDurations`,
|
|
3977
3943
|
* even though these values are ignored.
|
|
3978
3944
|
* @param service - Service to create.
|
|
@@ -3990,9 +3956,7 @@ declare function createService(service: Service): Promise<NonNullablePaths<Servi
|
|
|
3990
3956
|
* Creates multiple services.
|
|
3991
3957
|
*
|
|
3992
3958
|
*
|
|
3993
|
-
* See Create Service
|
|
3994
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/create-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/create-service))
|
|
3995
|
-
* for more details.
|
|
3959
|
+
* See [Create Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/create-service) for more details.
|
|
3996
3960
|
* @param services - Services to create.
|
|
3997
3961
|
* @public
|
|
3998
3962
|
* @requiredField services
|
|
@@ -4030,19 +3994,17 @@ declare function getService(serviceId: string): Promise<NonNullablePaths<Service
|
|
|
4030
3994
|
* Specify `schedule.availabilityConstraints.sessionDurations`
|
|
4031
3995
|
* only if you want to update it for appointment-based services without varied
|
|
4032
3996
|
* pricing based on session length. Don't specify `schedule.availabilityConstraints.sessionDurations`
|
|
4033
|
-
* for all other appointment-based services, classes, or courses. See Create Service
|
|
4034
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/create-service#session-durations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/create-service#session-durations))
|
|
4035
|
-
* for more details.
|
|
3997
|
+
* for all other appointment-based services, classes, or courses. See [Create Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/create-service#session-durations) for more details.
|
|
4036
3998
|
*
|
|
4037
3999
|
* ### Service locations
|
|
4038
4000
|
*
|
|
4039
|
-
* Don't
|
|
4001
|
+
* Don't call Update Service to adjust service locations, call [Set Service Locations](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/set-service-locations) instead.
|
|
4040
4002
|
*
|
|
4041
4003
|
* <!-- ### Add-on groups
|
|
4042
4004
|
*
|
|
4043
4005
|
* Don't use Update Service to modify service add-on groups. Use these dedicated methods instead:
|
|
4044
|
-
* - **Update add-on group properties**: Call Update Add On Group
|
|
4045
|
-
* - **Update add-on display order**: Call Set Add Ons For Group
|
|
4006
|
+
* - **Update add-on group properties**: Call [Update Add On Group](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/update-add-on-group).
|
|
4007
|
+
* - **Update add-on display order**: Call [Set Add Ons For Group](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/set-add-ons-for-group). -->
|
|
4046
4008
|
* @param _id - Service ID.
|
|
4047
4009
|
* @public
|
|
4048
4010
|
* @requiredField _id
|
|
@@ -4065,14 +4027,10 @@ interface UpdateService {
|
|
|
4065
4027
|
_id?: string | null;
|
|
4066
4028
|
/**
|
|
4067
4029
|
* Service type.
|
|
4068
|
-
* Learn more about
|
|
4069
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
|
|
4030
|
+
* Learn more about [service types](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types).
|
|
4070
4031
|
*/
|
|
4071
4032
|
type?: ServiceTypeWithLiterals;
|
|
4072
|
-
/**
|
|
4073
|
-
* Order of the service within a *category*
|
|
4074
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
|
|
4075
|
-
*/
|
|
4033
|
+
/** Order of the service within a [category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object). */
|
|
4076
4034
|
sortOrder?: number | null;
|
|
4077
4035
|
/**
|
|
4078
4036
|
* Service name.
|
|
@@ -4101,8 +4059,7 @@ interface UpdateService {
|
|
|
4101
4059
|
/** Whether the service is hidden from Wix Bookings pages and widgets. */
|
|
4102
4060
|
hidden?: boolean | null;
|
|
4103
4061
|
/**
|
|
4104
|
-
*
|
|
4105
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object))
|
|
4062
|
+
* [Category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)
|
|
4106
4063
|
* the service is associated with.
|
|
4107
4064
|
*/
|
|
4108
4065
|
category?: V2Category;
|
|
@@ -4110,8 +4067,7 @@ interface UpdateService {
|
|
|
4110
4067
|
form?: Form;
|
|
4111
4068
|
/**
|
|
4112
4069
|
* Payment options for booking the service.
|
|
4113
|
-
* Learn more about
|
|
4114
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-payments) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments)).
|
|
4070
|
+
* Learn more about [service payments](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments).
|
|
4115
4071
|
*/
|
|
4116
4072
|
payment?: Payment;
|
|
4117
4073
|
/** Online booking settings. */
|
|
@@ -4119,28 +4075,23 @@ interface UpdateService {
|
|
|
4119
4075
|
/** Conferencing options for the service. */
|
|
4120
4076
|
conferencing?: Conferencing;
|
|
4121
4077
|
/**
|
|
4122
|
-
* The locations this service is offered at. Read more about
|
|
4123
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations)).
|
|
4078
|
+
* The locations this service is offered at. Read more about [service locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations).
|
|
4124
4079
|
* @immutable
|
|
4125
4080
|
* @maxSize 500
|
|
4126
4081
|
*/
|
|
4127
4082
|
locations?: Location[];
|
|
4128
4083
|
/**
|
|
4129
|
-
*
|
|
4130
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction))
|
|
4084
|
+
* [Policy](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)
|
|
4131
4085
|
* determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins.
|
|
4132
4086
|
*/
|
|
4133
4087
|
bookingPolicy?: BookingPolicy;
|
|
4134
4088
|
/**
|
|
4135
|
-
* The service's
|
|
4136
|
-
*
|
|
4137
|
-
* which can be used to manage the service's *events*
|
|
4138
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
|
|
4089
|
+
* The service's [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
|
|
4090
|
+
* which can be used to manage the service's [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
4139
4091
|
*/
|
|
4140
4092
|
schedule?: Schedule;
|
|
4141
4093
|
/**
|
|
4142
|
-
* IDs of the
|
|
4143
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
|
|
4094
|
+
* IDs of the [staff members](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)
|
|
4144
4095
|
* providing the service. Available only for appointment-based services.
|
|
4145
4096
|
* @maxSize 220
|
|
4146
4097
|
* @format GUID
|
|
@@ -4161,8 +4112,7 @@ interface UpdateService {
|
|
|
4161
4112
|
supportedSlugs?: Slug[];
|
|
4162
4113
|
/**
|
|
4163
4114
|
* Active slug for the service.
|
|
4164
|
-
* Learn more about
|
|
4165
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-slugs) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs)).
|
|
4115
|
+
* Learn more about [service slugs](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-slugs).
|
|
4166
4116
|
* @readonly
|
|
4167
4117
|
*/
|
|
4168
4118
|
mainSlug?: Slug;
|
|
@@ -4199,8 +4149,7 @@ interface UpdateService {
|
|
|
4199
4149
|
* Updates up to 100 services.
|
|
4200
4150
|
*
|
|
4201
4151
|
*
|
|
4202
|
-
* See Update Service
|
|
4203
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4152
|
+
* See [Update Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/update-service)
|
|
4204
4153
|
* for more details.
|
|
4205
4154
|
*
|
|
4206
4155
|
* The call succeeds even if one or more individual services can't be updated.
|
|
@@ -4227,13 +4176,9 @@ interface BulkUpdateServicesOptions {
|
|
|
4227
4176
|
* Updates multiple services by filter.
|
|
4228
4177
|
*
|
|
4229
4178
|
*
|
|
4230
|
-
* Refer to the supported filters article
|
|
4231
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
4232
|
-
* for more details.
|
|
4179
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting) for more details.
|
|
4233
4180
|
*
|
|
4234
|
-
* See Update Service
|
|
4235
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4236
|
-
* for more details about updating a service.
|
|
4181
|
+
* See [Update Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/update-service) for more details about updating a service.
|
|
4237
4182
|
*
|
|
4238
4183
|
* The call succeeds even if one or more individual services can't be updated.
|
|
4239
4184
|
* Information about failures is returned in `bulkActionMetadata`.
|
|
@@ -4283,8 +4228,7 @@ interface DeleteServiceOptions {
|
|
|
4283
4228
|
* Deletes multiple services.
|
|
4284
4229
|
*
|
|
4285
4230
|
*
|
|
4286
|
-
* See Delete Service
|
|
4287
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service))
|
|
4231
|
+
* See [Delete Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/delete-service)
|
|
4288
4232
|
* for more details about deleting a service.
|
|
4289
4233
|
*
|
|
4290
4234
|
* The call succeeds even if one or more individual services can't be deleted.
|
|
@@ -4314,15 +4258,13 @@ interface BulkDeleteServicesOptions {
|
|
|
4314
4258
|
* Deletes multiple services by filter.
|
|
4315
4259
|
*
|
|
4316
4260
|
*
|
|
4317
|
-
* See Delete Service
|
|
4318
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service))
|
|
4261
|
+
* See [Delete Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/delete-service)
|
|
4319
4262
|
* for more details about deleting a service.
|
|
4320
4263
|
*
|
|
4321
4264
|
* The call succeeds even if one or more individual services can't be deleted.
|
|
4322
4265
|
* Information about failures is returned in `bulkActionMetadata`.
|
|
4323
4266
|
*
|
|
4324
|
-
* Refer to the supported filters article
|
|
4325
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
4267
|
+
* Refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction#services-filtering-and-sorting)
|
|
4326
4268
|
* for more details.
|
|
4327
4269
|
*
|
|
4328
4270
|
* To learn about working with filters in general, see
|
|
@@ -4524,13 +4466,13 @@ type ServiceSearch = {
|
|
|
4524
4466
|
/**
|
|
4525
4467
|
Filter object for narrowing search results. For example, to return only services with specific payment options: `"filter": {"payment.options.online": true, "payment.options.in_person": false}`.
|
|
4526
4468
|
|
|
4527
|
-
Learn more about the filter format in the supported filters article
|
|
4469
|
+
Learn more about the filter format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting).
|
|
4528
4470
|
*/
|
|
4529
4471
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
4530
4472
|
/**
|
|
4531
4473
|
Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
4532
4474
|
|
|
4533
|
-
Learn more about the sort format in the supported filters article
|
|
4475
|
+
Learn more about the sort format in the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting).
|
|
4534
4476
|
@maxSize: 10
|
|
4535
4477
|
*/
|
|
4536
4478
|
sort?: {
|
|
@@ -4625,8 +4567,7 @@ type ServiceSearch = {
|
|
|
4625
4567
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
4626
4568
|
};
|
|
4627
4569
|
/**
|
|
4628
|
-
* Retrieves a list of up to 100 booking policies
|
|
4629
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)),
|
|
4570
|
+
* Retrieves a list of up to 100 [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction),
|
|
4630
4571
|
* and information about the services that are connected to them,
|
|
4631
4572
|
* given the provided filtering, paging, and sorting.
|
|
4632
4573
|
*
|
|
@@ -4639,8 +4580,7 @@ type ServiceSearch = {
|
|
|
4639
4580
|
*
|
|
4640
4581
|
* ### Filters
|
|
4641
4582
|
*
|
|
4642
|
-
* For a complete list of supported filters, refer to Booking Policies API: Supported Filters
|
|
4643
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters)).
|
|
4583
|
+
* For a complete list of supported filters, refer to Booking Policies API: [Supported Filters](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters).
|
|
4644
4584
|
*
|
|
4645
4585
|
* When using date filters, you must use
|
|
4646
4586
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4649,8 +4589,7 @@ type ServiceSearch = {
|
|
|
4649
4589
|
*
|
|
4650
4590
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4651
4591
|
* those services is returned. The `bookingPolicies.totalServiceCount` values
|
|
4652
|
-
* indicate the total number of services linked to each policy. You can call Search Services
|
|
4653
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
4592
|
+
* indicate the total number of services linked to each policy. You can call [Search Services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/search-services)
|
|
4654
4593
|
* and specify the relevant policy ID in the filter to retrieve all services
|
|
4655
4594
|
* connected to the booking policy.
|
|
4656
4595
|
*
|
|
@@ -4673,8 +4612,7 @@ type ServiceSearch = {
|
|
|
4673
4612
|
*/
|
|
4674
4613
|
declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<QueryPoliciesResponse, `bookingPolicies` | `bookingPolicies.${number}.bookingPolicy._id` | `bookingPolicies.${number}.bookingPolicy.customPolicyDescription.enabled` | `bookingPolicies.${number}.bookingPolicy.customPolicyDescription.description` | `bookingPolicies.${number}.bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicies.${number}.bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicies.${number}.bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.capacity` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicies.${number}.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicies.${number}.bookingPolicy.resourcesPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicies.${number}.bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.saveCreditCardPolicy.enabled` | `bookingPolicies.${number}.totalServiceCount`, 6>>;
|
|
4675
4614
|
/**
|
|
4676
|
-
* Retrieves a list of up to 100 booking forms
|
|
4677
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)),
|
|
4615
|
+
* Retrieves a list of up to 100 booking [forms](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/form-object),
|
|
4678
4616
|
* and information about the services that are connected to them,
|
|
4679
4617
|
* given the provided filtering, paging, and sorting.
|
|
4680
4618
|
*
|
|
@@ -4688,8 +4626,7 @@ declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<Que
|
|
|
4688
4626
|
*
|
|
4689
4627
|
* ### Filters
|
|
4690
4628
|
*
|
|
4691
|
-
* For a complete list of supported filters, refer to Forms API: Supported Filters
|
|
4692
|
-
* ([REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)).
|
|
4629
|
+
* For a complete list of supported filters, refer to Forms API: [Supported Filters](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object).
|
|
4693
4630
|
*
|
|
4694
4631
|
* When using date filters, you must use
|
|
4695
4632
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4698,8 +4635,7 @@ declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<Que
|
|
|
4698
4635
|
*
|
|
4699
4636
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4700
4637
|
* these service IDs and names is returned. The `bookingForms.totalServiceCount`
|
|
4701
|
-
* values indicate the total number of services linked to each form. You can call Query Services
|
|
4702
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/query-services))
|
|
4638
|
+
* values indicate the total number of services linked to each form. You can call [Query Services](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/query-services)
|
|
4703
4639
|
* and specify the relevant form ID in the filter to retrieve all services
|
|
4704
4640
|
* connected to the booking form.
|
|
4705
4641
|
*
|
|
@@ -4759,8 +4695,7 @@ interface CountServicesOptions {
|
|
|
4759
4695
|
filter?: Record<string, any> | null;
|
|
4760
4696
|
}
|
|
4761
4697
|
/**
|
|
4762
|
-
* Retrieves 3 separate lists of business, custom, and customer locations
|
|
4763
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)),
|
|
4698
|
+
* Retrieves 3 separate lists of business, custom, and customer [locations](https://dev.wix.com/docs/api-reference/business-management/locations/introduction),
|
|
4764
4699
|
* given the provided filtering, and whether each location is connected to at
|
|
4765
4700
|
* least one of the site's services.
|
|
4766
4701
|
*
|
|
@@ -4795,7 +4730,7 @@ interface QueryLocationsOptions {
|
|
|
4795
4730
|
filter?: QueryLocationsFilter;
|
|
4796
4731
|
}
|
|
4797
4732
|
/**
|
|
4798
|
-
* Retrieves a list of service categories
|
|
4733
|
+
* Retrieves a list of [service categories](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/categories-v2/introduction), given the provided filtering.
|
|
4799
4734
|
*
|
|
4800
4735
|
*
|
|
4801
4736
|
* ### Defaults
|
|
@@ -4805,8 +4740,7 @@ interface QueryLocationsOptions {
|
|
|
4805
4740
|
*
|
|
4806
4741
|
* ### Filters
|
|
4807
4742
|
*
|
|
4808
|
-
* For a complete list of supported filters, refer to the supported filters article
|
|
4809
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering)).
|
|
4743
|
+
* For a complete list of supported filters, refer to the [supported filters article](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/filtering-and-sorting).
|
|
4810
4744
|
*
|
|
4811
4745
|
* When using date filters, you must use
|
|
4812
4746
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4814,8 +4748,8 @@ interface QueryLocationsOptions {
|
|
|
4814
4748
|
* ### See also
|
|
4815
4749
|
*
|
|
4816
4750
|
* To learn about working with Query methods, see
|
|
4817
|
-
* [API Query Language](https://dev.wix.com/docs/
|
|
4818
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/
|
|
4751
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
|
|
4752
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
4819
4753
|
* @public
|
|
4820
4754
|
* @documentationMaturity preview
|
|
4821
4755
|
* @permissionId BOOKINGS.SERVICES_READ
|
|
@@ -4828,9 +4762,7 @@ interface QueryCategoriesOptions {
|
|
|
4828
4762
|
filter?: QueryCategoriesFilter;
|
|
4829
4763
|
}
|
|
4830
4764
|
/**
|
|
4831
|
-
* Replaces the list of the locations
|
|
4832
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4833
|
-
* where the business offers the service.
|
|
4765
|
+
* Replaces the list of the [locations](https://dev.wix.com/docs/api-reference/business-management/locations/introduction) where the business offers the service.
|
|
4834
4766
|
*
|
|
4835
4767
|
*
|
|
4836
4768
|
* ### Consequences for customers
|
|
@@ -4864,9 +4796,7 @@ interface QueryCategoriesOptions {
|
|
|
4864
4796
|
* Depending on whether the new or updated location is a business or custom location,
|
|
4865
4797
|
* you need to specify different fields.
|
|
4866
4798
|
*
|
|
4867
|
-
* - **Business location**: Specify the relevant location ID
|
|
4868
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4869
|
-
* in `locations.business.id`.
|
|
4799
|
+
* - **Business location**: Specify the relevant [location ID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction) in `locations.business.id`.
|
|
4870
4800
|
* - **Custom location**: Specify the complete address object as
|
|
4871
4801
|
* `locations.custom.address`.
|
|
4872
4802
|
*
|
|
@@ -4901,19 +4831,14 @@ interface SetServiceLocationsOptions {
|
|
|
4901
4831
|
participantNotification?: ParticipantNotification;
|
|
4902
4832
|
}
|
|
4903
4833
|
/**
|
|
4904
|
-
* Adds a list of pricing plan IDs
|
|
4905
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4906
|
-
* to a service's `payment.pricingPlanIds` array.
|
|
4834
|
+
* Adds a list of [pricing plan IDs](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/) to a service's `payment.pricingPlanIds` array.
|
|
4907
4835
|
*
|
|
4908
4836
|
*
|
|
4909
4837
|
* The call doesn't validate whether the service's `payment.options.pricingPlan`
|
|
4910
4838
|
* is set to `true`. If it's set to `false`, customers aren't able to pay
|
|
4911
|
-
* for their bookings using pricing plans. You can call Update Service
|
|
4912
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4913
|
-
* to change a service's supported payment methods.
|
|
4839
|
+
* for their bookings using pricing plans. You can call [Update Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/update-service) to change a service's supported payment methods.
|
|
4914
4840
|
* @param serviceId - ID of the service to update.
|
|
4915
|
-
* @param pricingPlanIds - IDs of the pricing plans
|
|
4916
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4841
|
+
* @param pricingPlanIds - IDs of the [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/plans/introduction)
|
|
4917
4842
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
4918
4843
|
* @public
|
|
4919
4844
|
* @requiredField pricingPlanIds
|
|
@@ -4926,9 +4851,7 @@ declare function enablePricingPlansForService(serviceId: string, pricingPlanIds:
|
|
|
4926
4851
|
__applicationErrorsType?: EnablePricingPlansForServiceApplicationErrors;
|
|
4927
4852
|
}>;
|
|
4928
4853
|
/**
|
|
4929
|
-
* Removes a list of pricing plan IDs
|
|
4930
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4931
|
-
* from a service's `payment.pricingPlanIds` array.
|
|
4854
|
+
* Removes a list of [pricing plan IDs](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/plans/introduction) from a service's `payment.pricingPlanIds` array.
|
|
4932
4855
|
*
|
|
4933
4856
|
*
|
|
4934
4857
|
* If you remove all pricing plan IDs from `payment.pricingPlanIds` and the
|
|
@@ -4946,8 +4869,7 @@ declare function disablePricingPlansForService(serviceId: string, options?: Disa
|
|
|
4946
4869
|
}>;
|
|
4947
4870
|
interface DisablePricingPlansForServiceOptions {
|
|
4948
4871
|
/**
|
|
4949
|
-
* IDs of the pricing plans
|
|
4950
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4872
|
+
* IDs of the [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/plans/introduction)
|
|
4951
4873
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
4952
4874
|
* @format GUID
|
|
4953
4875
|
* @maxSize 75
|
|
@@ -5015,15 +4937,12 @@ interface ValidateSlugOptions {
|
|
|
5015
4937
|
*
|
|
5016
4938
|
* #### Schedule
|
|
5017
4939
|
*
|
|
5018
|
-
* Wix Bookings automatically creates a new active schedule
|
|
5019
|
-
* ([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))
|
|
4940
|
+
* Wix Bookings automatically creates a new active [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
5020
4941
|
* for the cloned service. If Wix Bookings can't create this schedule, the
|
|
5021
4942
|
* Clone Service call fails.
|
|
5022
4943
|
*
|
|
5023
4944
|
* - __For appointment-based services__: Future appointments aren't added to the
|
|
5024
|
-
* cloned service's schedule. Use the Events API
|
|
5025
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
|
|
5026
|
-
* to add them as needed.
|
|
4945
|
+
* cloned service's schedule. Use the [Events API](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction) to add them as needed.
|
|
5027
4946
|
* - __For classes and courses__: Future one-time events aren't added to the
|
|
5028
4947
|
* cloned service's schedule, while future recurring events are added
|
|
5029
4948
|
* asynchronously. The Clone Service call always succeeds, whether or not
|
|
@@ -5031,25 +4950,20 @@ interface ValidateSlugOptions {
|
|
|
5031
4950
|
* If the response includes `RECURRING_EVENTS` in the `errors` array, it means the
|
|
5032
4951
|
* cloned service doesn't have future recurring events, even though the original
|
|
5033
4952
|
* service does. You can either delete the cloned service and try again or use
|
|
5034
|
-
* the Events API
|
|
5035
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
|
|
5036
|
-
* to add missing events to the schedule.
|
|
4953
|
+
* the [Events API](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction) to add missing events to the schedule.
|
|
5037
4954
|
*
|
|
5038
4955
|
* Wix Bookings never adds past events to the cloned service's schedule.
|
|
5039
4956
|
*
|
|
5040
4957
|
* #### Service options and variants
|
|
5041
4958
|
*
|
|
5042
|
-
* If the original service has variants
|
|
5043
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)),
|
|
4959
|
+
* If the original service has [variants](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction),
|
|
5044
4960
|
* they're cloned asynchronously. The Clone Service call always succeeds,
|
|
5045
4961
|
* regardless of whether variants were cloned.
|
|
5046
4962
|
*
|
|
5047
4963
|
* If the response includes `OPTIONS_AND_VARIANTS` in the `errors` array, the cloned
|
|
5048
4964
|
* service doesn't have variants, even though the original service does. You can
|
|
5049
4965
|
* delete the cloned service and call Clone Service again, or use the
|
|
5050
|
-
*
|
|
5051
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction))
|
|
5052
|
-
* to add variants.
|
|
4966
|
+
* [Service Options And Variants API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction) to add variants.
|
|
5053
4967
|
*
|
|
5054
4968
|
* #### Booking form
|
|
5055
4969
|
*
|
|
@@ -5058,11 +4972,9 @@ interface ValidateSlugOptions {
|
|
|
5058
4972
|
*
|
|
5059
4973
|
* #### Pricing plans
|
|
5060
4974
|
*
|
|
5061
|
-
* If the original service's accepts payments via pricing plans
|
|
5062
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/plans/introduction)),
|
|
4975
|
+
* If the original service's accepts payments via [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/introduction/),
|
|
5063
4976
|
* the cloned service's `payment.options.pricingPlan` is also set to `true`. To
|
|
5064
|
-
* accept specific pricing plans, call Enable Pricing Plans For Service
|
|
5065
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/enable-pricing-plans-for-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/enable-pricing-plans-for-service)),
|
|
4977
|
+
* accept specific pricing plans, call [Enable Pricing Plans For Service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/enable-pricing-plans-for-service),
|
|
5066
4978
|
* after cloning the service. If the original service accepts only
|
|
5067
4979
|
* pricing plan payments and you don't call Enable Pricing Plans For Service
|
|
5068
4980
|
* after cloning the service, customers will be unable to book the service.
|