@wix/auto_sdk_bookings_services 1.0.149 → 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-Bmp_SJXU.d.ts → bookings-services-v2-service-services.universal-BB-68oF3.d.ts} +77 -169
- 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 -60
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{bookings-services-v2-service-services.universal-Bmp_SJXU.d.mts → bookings-services-v2-service-services.universal-BB-68oF3.d.mts} +77 -169
- 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 -60
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{bookings-services-v2-service-services.universal-Bmp_SJXU.d.ts → bookings-services-v2-service-services.universal-BB-68oF3.d.ts} +77 -169
- 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 -60
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{bookings-services-v2-service-services.universal-Bmp_SJXU.d.mts → bookings-services-v2-service-services.universal-BB-68oF3.d.mts} +77 -169
- 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 -60
- 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;
|
|
@@ -139,8 +127,6 @@ interface Service {
|
|
|
139
127
|
revision?: string | null;
|
|
140
128
|
/** Taxable address used to calculate tax */
|
|
141
129
|
taxableAddress?: TaxableAddress;
|
|
142
|
-
/** Phone call options for the service. */
|
|
143
|
-
phoneCall?: PhoneCall;
|
|
144
130
|
}
|
|
145
131
|
declare enum ServiceType {
|
|
146
132
|
/** Appointment-based service. */
|
|
@@ -235,7 +221,7 @@ interface Payment extends PaymentRateOneOf {
|
|
|
235
221
|
*/
|
|
236
222
|
pricingPlanIds?: string[];
|
|
237
223
|
/**
|
|
238
|
-
* 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).
|
|
239
225
|
* If customers pay for the booking using any method other than a pricing plan, the value of this field is ignored.
|
|
240
226
|
*/
|
|
241
227
|
addOnOption?: AddOnPaymentOptionsWithLiterals;
|
|
@@ -418,15 +404,9 @@ interface LocationOptionsOneOf {
|
|
|
418
404
|
}
|
|
419
405
|
declare enum LocationType {
|
|
420
406
|
UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
|
|
421
|
-
/**
|
|
422
|
-
* Location set by the business that is not a standard business *location*
|
|
423
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
424
|
-
*/
|
|
407
|
+
/** Location set by the business that is not a standard business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
425
408
|
CUSTOM = "CUSTOM",
|
|
426
|
-
/**
|
|
427
|
-
* Business *location*
|
|
428
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
429
|
-
*/
|
|
409
|
+
/** Business [location](https://dev.wix.com/docs/api-reference/business-management/locations/introduction). */
|
|
430
410
|
BUSINESS = "BUSINESS",
|
|
431
411
|
/**
|
|
432
412
|
* The customer specifies any address when booking. Available only for
|
|
@@ -500,8 +480,7 @@ interface AddressLocation {
|
|
|
500
480
|
}
|
|
501
481
|
interface BusinessLocationOptions {
|
|
502
482
|
/**
|
|
503
|
-
* ID of the business
|
|
504
|
-
* ([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).
|
|
505
484
|
* When setting a business location, specify only the location ID. Other location details are overwritten.
|
|
506
485
|
* @format GUID
|
|
507
486
|
*/
|
|
@@ -992,8 +971,7 @@ declare enum CompletionRequirement {
|
|
|
992
971
|
type CompletionRequirementWithLiterals = CompletionRequirement | 'UNKNOWN_COMPLETION_REQUIREMENT' | 'OPTIONAL' | 'REQUIRED_BEFORE_BOOKING';
|
|
993
972
|
interface Schedule {
|
|
994
973
|
/**
|
|
995
|
-
* ID of the
|
|
996
|
-
* ([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)
|
|
997
975
|
* to which the service's events belong.
|
|
998
976
|
* @format GUID
|
|
999
977
|
* @readonly
|
|
@@ -1018,8 +996,7 @@ interface AvailabilityConstraints {
|
|
|
1018
996
|
* appointment-based services without varied pricing based on session length, it
|
|
1019
997
|
* matches the single value in the `sessionDurations` array. For appointment-based
|
|
1020
998
|
* services with varied pricing based on session length, it includes session
|
|
1021
|
-
* durations for all
|
|
1022
|
-
* ([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),
|
|
1023
1000
|
* while ignoring `sessionDurations`.
|
|
1024
1001
|
* For courses and classes, it includes durations for all future
|
|
1025
1002
|
* recurring sessions but excludes durations for one-off or past recurring sessions.
|
|
@@ -1031,7 +1008,7 @@ interface AvailabilityConstraints {
|
|
|
1031
1008
|
* List of supported session durations in minutes.
|
|
1032
1009
|
*
|
|
1033
1010
|
* - For appointment-based services, specify `sessionDurations` when creating a service.
|
|
1034
|
-
* - 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).
|
|
1035
1012
|
* - For classes or courses, don't specify `sessionDurations` when creating a service.
|
|
1036
1013
|
*
|
|
1037
1014
|
* Min: `1` minute
|
|
@@ -1132,10 +1109,7 @@ interface ResourceIds {
|
|
|
1132
1109
|
values?: string[];
|
|
1133
1110
|
}
|
|
1134
1111
|
interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
1135
|
-
/**
|
|
1136
|
-
* Details about the required *resource type*
|
|
1137
|
-
* ([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)).
|
|
1138
|
-
*/
|
|
1112
|
+
/** Details about the required [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction). */
|
|
1139
1113
|
resourceType?: ResourceType;
|
|
1140
1114
|
}
|
|
1141
1115
|
/** @oneof */
|
|
@@ -2038,7 +2012,7 @@ interface SearchServicesRequest {
|
|
|
2038
2012
|
/**
|
|
2039
2013
|
* Search criteria including filter, sort, aggregations, and paging options.
|
|
2040
2014
|
*
|
|
2041
|
-
* 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.
|
|
2042
2016
|
*/
|
|
2043
2017
|
search: CursorSearch;
|
|
2044
2018
|
}
|
|
@@ -2051,13 +2025,13 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
2051
2025
|
/**
|
|
2052
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}`.
|
|
2053
2027
|
*
|
|
2054
|
-
* 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).
|
|
2055
2029
|
*/
|
|
2056
2030
|
filter?: Record<string, any> | null;
|
|
2057
2031
|
/**
|
|
2058
2032
|
* Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
2059
2033
|
*
|
|
2060
|
-
* 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).
|
|
2061
2035
|
* @maxSize 10
|
|
2062
2036
|
*/
|
|
2063
2037
|
sort?: Sorting[];
|
|
@@ -2648,8 +2622,7 @@ interface BookingPolicyWithServices {
|
|
|
2648
2622
|
/**
|
|
2649
2623
|
* Up to 5 services connected to the booking policy. If `totalServiceCount` is
|
|
2650
2624
|
* greater than 5, there are additional services connected to the policy.
|
|
2651
|
-
* You can call Search Services
|
|
2652
|
-
* ([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)
|
|
2653
2626
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2654
2627
|
* connected to a booking policy.
|
|
2655
2628
|
* @maxSize 5
|
|
@@ -2693,8 +2666,7 @@ interface BookingForm {
|
|
|
2693
2666
|
/**
|
|
2694
2667
|
* Up to 5 services connected to the booking form. If `totalServiceCount` is
|
|
2695
2668
|
* greater than 5, there are additional services connected to the policy.
|
|
2696
|
-
* You can call Search Services
|
|
2697
|
-
* ([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)
|
|
2698
2670
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2699
2671
|
* connected to a booking policy.
|
|
2700
2672
|
* @maxSize 5
|
|
@@ -2914,8 +2886,7 @@ interface EnablePricingPlansForServiceRequest {
|
|
|
2914
2886
|
*/
|
|
2915
2887
|
serviceId: string;
|
|
2916
2888
|
/**
|
|
2917
|
-
* IDs of the pricing plans
|
|
2918
|
-
* ([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)
|
|
2919
2890
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
2920
2891
|
* @format GUID
|
|
2921
2892
|
* @maxSize 100
|
|
@@ -2945,8 +2916,7 @@ interface DisablePricingPlansForServiceRequest {
|
|
|
2945
2916
|
*/
|
|
2946
2917
|
serviceId: string;
|
|
2947
2918
|
/**
|
|
2948
|
-
* IDs of the pricing plans
|
|
2949
|
-
* ([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)
|
|
2950
2920
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
2951
2921
|
* @format GUID
|
|
2952
2922
|
* @maxSize 75
|
|
@@ -3029,10 +2999,7 @@ interface CloneServiceResponse {
|
|
|
3029
2999
|
errors?: CloneErrorsWithLiterals[];
|
|
3030
3000
|
}
|
|
3031
3001
|
declare enum CloneErrors {
|
|
3032
|
-
/**
|
|
3033
|
-
* Failed to clone the original service's *options and variants*
|
|
3034
|
-
* ([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)).
|
|
3035
|
-
*/
|
|
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). */
|
|
3036
3003
|
OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
|
|
3037
3004
|
/** Failed to clone the original service's *booking form*. */
|
|
3038
3005
|
FORM = "FORM"
|
|
@@ -3940,8 +3907,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3940
3907
|
* ### Required fields
|
|
3941
3908
|
*
|
|
3942
3909
|
* When creating a service you must specify the following fields:
|
|
3943
|
-
* - `type`
|
|
3944
|
-
* ([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):
|
|
3945
3911
|
* Whether it's an appointment-based service, class, or course.
|
|
3946
3912
|
* - `name`: Service name that's displayed to customers.
|
|
3947
3913
|
* - `onlineBooking`:
|
|
@@ -3949,8 +3915,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3949
3915
|
* must manually confirm bookings, and whether customers can request to book an
|
|
3950
3916
|
* appointment time slot that already has a booking request awaiting business
|
|
3951
3917
|
* confirmation.
|
|
3952
|
-
* - `payment`
|
|
3953
|
-
* ([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):
|
|
3954
3919
|
* How customers can pay when signing up for the service.
|
|
3955
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`.
|
|
3956
3921
|
*
|
|
@@ -3973,8 +3938,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3973
3938
|
* - Specify all supported session durations in `schedule.availabilityConstraints.sessionDurations`.
|
|
3974
3939
|
* - Note that Wix Bookings doesn't display these values to customers and
|
|
3975
3940
|
* ignores them in pricing and availability calculations. Instead session
|
|
3976
|
-
* durations are retrieved from the relevant service variants
|
|
3977
|
-
* ([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).
|
|
3978
3942
|
* - It is mandatory to specify `schedule.availabilityConstraints.sessionDurations`,
|
|
3979
3943
|
* even though these values are ignored.
|
|
3980
3944
|
* @param service - Service to create.
|
|
@@ -3992,9 +3956,7 @@ declare function createService(service: Service): Promise<NonNullablePaths<Servi
|
|
|
3992
3956
|
* Creates multiple services.
|
|
3993
3957
|
*
|
|
3994
3958
|
*
|
|
3995
|
-
* See Create Service
|
|
3996
|
-
* ([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))
|
|
3997
|
-
* 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.
|
|
3998
3960
|
* @param services - Services to create.
|
|
3999
3961
|
* @public
|
|
4000
3962
|
* @requiredField services
|
|
@@ -4032,19 +3994,17 @@ declare function getService(serviceId: string): Promise<NonNullablePaths<Service
|
|
|
4032
3994
|
* Specify `schedule.availabilityConstraints.sessionDurations`
|
|
4033
3995
|
* only if you want to update it for appointment-based services without varied
|
|
4034
3996
|
* pricing based on session length. Don't specify `schedule.availabilityConstraints.sessionDurations`
|
|
4035
|
-
* for all other appointment-based services, classes, or courses. See Create Service
|
|
4036
|
-
* ([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))
|
|
4037
|
-
* 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.
|
|
4038
3998
|
*
|
|
4039
3999
|
* ### Service locations
|
|
4040
4000
|
*
|
|
4041
|
-
* 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.
|
|
4042
4002
|
*
|
|
4043
4003
|
* <!-- ### Add-on groups
|
|
4044
4004
|
*
|
|
4045
4005
|
* Don't use Update Service to modify service add-on groups. Use these dedicated methods instead:
|
|
4046
|
-
* - **Update add-on group properties**: Call Update Add On Group
|
|
4047
|
-
* - **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). -->
|
|
4048
4008
|
* @param _id - Service ID.
|
|
4049
4009
|
* @public
|
|
4050
4010
|
* @requiredField _id
|
|
@@ -4067,14 +4027,10 @@ interface UpdateService {
|
|
|
4067
4027
|
_id?: string | null;
|
|
4068
4028
|
/**
|
|
4069
4029
|
* Service type.
|
|
4070
|
-
* Learn more about
|
|
4071
|
-
* ([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).
|
|
4072
4031
|
*/
|
|
4073
4032
|
type?: ServiceTypeWithLiterals;
|
|
4074
|
-
/**
|
|
4075
|
-
* Order of the service within a *category*
|
|
4076
|
-
* ([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)).
|
|
4077
|
-
*/
|
|
4033
|
+
/** Order of the service within a [category](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object). */
|
|
4078
4034
|
sortOrder?: number | null;
|
|
4079
4035
|
/**
|
|
4080
4036
|
* Service name.
|
|
@@ -4103,8 +4059,7 @@ interface UpdateService {
|
|
|
4103
4059
|
/** Whether the service is hidden from Wix Bookings pages and widgets. */
|
|
4104
4060
|
hidden?: boolean | null;
|
|
4105
4061
|
/**
|
|
4106
|
-
*
|
|
4107
|
-
* ([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)
|
|
4108
4063
|
* the service is associated with.
|
|
4109
4064
|
*/
|
|
4110
4065
|
category?: V2Category;
|
|
@@ -4112,8 +4067,7 @@ interface UpdateService {
|
|
|
4112
4067
|
form?: Form;
|
|
4113
4068
|
/**
|
|
4114
4069
|
* Payment options for booking the service.
|
|
4115
|
-
* Learn more about
|
|
4116
|
-
* ([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).
|
|
4117
4071
|
*/
|
|
4118
4072
|
payment?: Payment;
|
|
4119
4073
|
/** Online booking settings. */
|
|
@@ -4121,28 +4075,23 @@ interface UpdateService {
|
|
|
4121
4075
|
/** Conferencing options for the service. */
|
|
4122
4076
|
conferencing?: Conferencing;
|
|
4123
4077
|
/**
|
|
4124
|
-
* The locations this service is offered at. Read more about
|
|
4125
|
-
* ([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).
|
|
4126
4079
|
* @immutable
|
|
4127
4080
|
* @maxSize 500
|
|
4128
4081
|
*/
|
|
4129
4082
|
locations?: Location[];
|
|
4130
4083
|
/**
|
|
4131
|
-
*
|
|
4132
|
-
* ([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)
|
|
4133
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.
|
|
4134
4086
|
*/
|
|
4135
4087
|
bookingPolicy?: BookingPolicy;
|
|
4136
4088
|
/**
|
|
4137
|
-
* The service's
|
|
4138
|
-
*
|
|
4139
|
-
* which can be used to manage the service's *events*
|
|
4140
|
-
* ([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).
|
|
4141
4091
|
*/
|
|
4142
4092
|
schedule?: Schedule;
|
|
4143
4093
|
/**
|
|
4144
|
-
* IDs of the
|
|
4145
|
-
* ([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)
|
|
4146
4095
|
* providing the service. Available only for appointment-based services.
|
|
4147
4096
|
* @maxSize 220
|
|
4148
4097
|
* @format GUID
|
|
@@ -4163,8 +4112,7 @@ interface UpdateService {
|
|
|
4163
4112
|
supportedSlugs?: Slug[];
|
|
4164
4113
|
/**
|
|
4165
4114
|
* Active slug for the service.
|
|
4166
|
-
* Learn more about
|
|
4167
|
-
* ([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).
|
|
4168
4116
|
* @readonly
|
|
4169
4117
|
*/
|
|
4170
4118
|
mainSlug?: Slug;
|
|
@@ -4196,15 +4144,12 @@ interface UpdateService {
|
|
|
4196
4144
|
revision?: string | null;
|
|
4197
4145
|
/** Taxable address used to calculate tax */
|
|
4198
4146
|
taxableAddress?: TaxableAddress;
|
|
4199
|
-
/** Phone call options for the service. */
|
|
4200
|
-
phoneCall?: PhoneCall;
|
|
4201
4147
|
}
|
|
4202
4148
|
/**
|
|
4203
4149
|
* Updates up to 100 services.
|
|
4204
4150
|
*
|
|
4205
4151
|
*
|
|
4206
|
-
* See Update Service
|
|
4207
|
-
* ([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)
|
|
4208
4153
|
* for more details.
|
|
4209
4154
|
*
|
|
4210
4155
|
* The call succeeds even if one or more individual services can't be updated.
|
|
@@ -4231,13 +4176,9 @@ interface BulkUpdateServicesOptions {
|
|
|
4231
4176
|
* Updates multiple services by filter.
|
|
4232
4177
|
*
|
|
4233
4178
|
*
|
|
4234
|
-
* Refer to the supported filters article
|
|
4235
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
4236
|
-
* 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.
|
|
4237
4180
|
*
|
|
4238
|
-
* See Update Service
|
|
4239
|
-
* ([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))
|
|
4240
|
-
* 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.
|
|
4241
4182
|
*
|
|
4242
4183
|
* The call succeeds even if one or more individual services can't be updated.
|
|
4243
4184
|
* Information about failures is returned in `bulkActionMetadata`.
|
|
@@ -4287,8 +4228,7 @@ interface DeleteServiceOptions {
|
|
|
4287
4228
|
* Deletes multiple services.
|
|
4288
4229
|
*
|
|
4289
4230
|
*
|
|
4290
|
-
* See Delete Service
|
|
4291
|
-
* ([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)
|
|
4292
4232
|
* for more details about deleting a service.
|
|
4293
4233
|
*
|
|
4294
4234
|
* The call succeeds even if one or more individual services can't be deleted.
|
|
@@ -4318,15 +4258,13 @@ interface BulkDeleteServicesOptions {
|
|
|
4318
4258
|
* Deletes multiple services by filter.
|
|
4319
4259
|
*
|
|
4320
4260
|
*
|
|
4321
|
-
* See Delete Service
|
|
4322
|
-
* ([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)
|
|
4323
4262
|
* for more details about deleting a service.
|
|
4324
4263
|
*
|
|
4325
4264
|
* The call succeeds even if one or more individual services can't be deleted.
|
|
4326
4265
|
* Information about failures is returned in `bulkActionMetadata`.
|
|
4327
4266
|
*
|
|
4328
|
-
* Refer to the supported filters article
|
|
4329
|
-
* ([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)
|
|
4330
4268
|
* for more details.
|
|
4331
4269
|
*
|
|
4332
4270
|
* To learn about working with filters in general, see
|
|
@@ -4528,13 +4466,13 @@ type ServiceSearch = {
|
|
|
4528
4466
|
/**
|
|
4529
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}`.
|
|
4530
4468
|
|
|
4531
|
-
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).
|
|
4532
4470
|
*/
|
|
4533
4471
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
4534
4472
|
/**
|
|
4535
4473
|
Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
4536
4474
|
|
|
4537
|
-
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).
|
|
4538
4476
|
@maxSize: 10
|
|
4539
4477
|
*/
|
|
4540
4478
|
sort?: {
|
|
@@ -4629,8 +4567,7 @@ type ServiceSearch = {
|
|
|
4629
4567
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
4630
4568
|
};
|
|
4631
4569
|
/**
|
|
4632
|
-
* Retrieves a list of up to 100 booking policies
|
|
4633
|
-
* ([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),
|
|
4634
4571
|
* and information about the services that are connected to them,
|
|
4635
4572
|
* given the provided filtering, paging, and sorting.
|
|
4636
4573
|
*
|
|
@@ -4643,8 +4580,7 @@ type ServiceSearch = {
|
|
|
4643
4580
|
*
|
|
4644
4581
|
* ### Filters
|
|
4645
4582
|
*
|
|
4646
|
-
* For a complete list of supported filters, refer to Booking Policies API: Supported Filters
|
|
4647
|
-
* ([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).
|
|
4648
4584
|
*
|
|
4649
4585
|
* When using date filters, you must use
|
|
4650
4586
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4653,8 +4589,7 @@ type ServiceSearch = {
|
|
|
4653
4589
|
*
|
|
4654
4590
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4655
4591
|
* those services is returned. The `bookingPolicies.totalServiceCount` values
|
|
4656
|
-
* indicate the total number of services linked to each policy. You can call Search Services
|
|
4657
|
-
* ([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)
|
|
4658
4593
|
* and specify the relevant policy ID in the filter to retrieve all services
|
|
4659
4594
|
* connected to the booking policy.
|
|
4660
4595
|
*
|
|
@@ -4677,8 +4612,7 @@ type ServiceSearch = {
|
|
|
4677
4612
|
*/
|
|
4678
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>>;
|
|
4679
4614
|
/**
|
|
4680
|
-
* Retrieves a list of up to 100 booking forms
|
|
4681
|
-
* ([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),
|
|
4682
4616
|
* and information about the services that are connected to them,
|
|
4683
4617
|
* given the provided filtering, paging, and sorting.
|
|
4684
4618
|
*
|
|
@@ -4692,8 +4626,7 @@ declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<Que
|
|
|
4692
4626
|
*
|
|
4693
4627
|
* ### Filters
|
|
4694
4628
|
*
|
|
4695
|
-
* For a complete list of supported filters, refer to Forms API: Supported Filters
|
|
4696
|
-
* ([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).
|
|
4697
4630
|
*
|
|
4698
4631
|
* When using date filters, you must use
|
|
4699
4632
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4702,8 +4635,7 @@ declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<Que
|
|
|
4702
4635
|
*
|
|
4703
4636
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4704
4637
|
* these service IDs and names is returned. The `bookingForms.totalServiceCount`
|
|
4705
|
-
* values indicate the total number of services linked to each form. You can call Query Services
|
|
4706
|
-
* ([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)
|
|
4707
4639
|
* and specify the relevant form ID in the filter to retrieve all services
|
|
4708
4640
|
* connected to the booking form.
|
|
4709
4641
|
*
|
|
@@ -4763,8 +4695,7 @@ interface CountServicesOptions {
|
|
|
4763
4695
|
filter?: Record<string, any> | null;
|
|
4764
4696
|
}
|
|
4765
4697
|
/**
|
|
4766
|
-
* Retrieves 3 separate lists of business, custom, and customer locations
|
|
4767
|
-
* ([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),
|
|
4768
4699
|
* given the provided filtering, and whether each location is connected to at
|
|
4769
4700
|
* least one of the site's services.
|
|
4770
4701
|
*
|
|
@@ -4799,7 +4730,7 @@ interface QueryLocationsOptions {
|
|
|
4799
4730
|
filter?: QueryLocationsFilter;
|
|
4800
4731
|
}
|
|
4801
4732
|
/**
|
|
4802
|
-
* 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.
|
|
4803
4734
|
*
|
|
4804
4735
|
*
|
|
4805
4736
|
* ### Defaults
|
|
@@ -4809,8 +4740,7 @@ interface QueryLocationsOptions {
|
|
|
4809
4740
|
*
|
|
4810
4741
|
* ### Filters
|
|
4811
4742
|
*
|
|
4812
|
-
* For a complete list of supported filters, refer to the supported filters article
|
|
4813
|
-
* ([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).
|
|
4814
4744
|
*
|
|
4815
4745
|
* When using date filters, you must use
|
|
4816
4746
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
@@ -4818,8 +4748,8 @@ interface QueryLocationsOptions {
|
|
|
4818
4748
|
* ### See also
|
|
4819
4749
|
*
|
|
4820
4750
|
* To learn about working with Query methods, see
|
|
4821
|
-
* [API Query Language](https://dev.wix.com/docs/
|
|
4822
|
-
* 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).
|
|
4823
4753
|
* @public
|
|
4824
4754
|
* @documentationMaturity preview
|
|
4825
4755
|
* @permissionId BOOKINGS.SERVICES_READ
|
|
@@ -4832,9 +4762,7 @@ interface QueryCategoriesOptions {
|
|
|
4832
4762
|
filter?: QueryCategoriesFilter;
|
|
4833
4763
|
}
|
|
4834
4764
|
/**
|
|
4835
|
-
* Replaces the list of the locations
|
|
4836
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4837
|
-
* 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.
|
|
4838
4766
|
*
|
|
4839
4767
|
*
|
|
4840
4768
|
* ### Consequences for customers
|
|
@@ -4868,9 +4796,7 @@ interface QueryCategoriesOptions {
|
|
|
4868
4796
|
* Depending on whether the new or updated location is a business or custom location,
|
|
4869
4797
|
* you need to specify different fields.
|
|
4870
4798
|
*
|
|
4871
|
-
* - **Business location**: Specify the relevant location ID
|
|
4872
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4873
|
-
* 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`.
|
|
4874
4800
|
* - **Custom location**: Specify the complete address object as
|
|
4875
4801
|
* `locations.custom.address`.
|
|
4876
4802
|
*
|
|
@@ -4905,19 +4831,14 @@ interface SetServiceLocationsOptions {
|
|
|
4905
4831
|
participantNotification?: ParticipantNotification;
|
|
4906
4832
|
}
|
|
4907
4833
|
/**
|
|
4908
|
-
* Adds a list of pricing plan IDs
|
|
4909
|
-
* ([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))
|
|
4910
|
-
* 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.
|
|
4911
4835
|
*
|
|
4912
4836
|
*
|
|
4913
4837
|
* The call doesn't validate whether the service's `payment.options.pricingPlan`
|
|
4914
4838
|
* is set to `true`. If it's set to `false`, customers aren't able to pay
|
|
4915
|
-
* for their bookings using pricing plans. You can call Update Service
|
|
4916
|
-
* ([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))
|
|
4917
|
-
* 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.
|
|
4918
4840
|
* @param serviceId - ID of the service to update.
|
|
4919
|
-
* @param pricingPlanIds - IDs of the pricing plans
|
|
4920
|
-
* ([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)
|
|
4921
4842
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
4922
4843
|
* @public
|
|
4923
4844
|
* @requiredField pricingPlanIds
|
|
@@ -4930,9 +4851,7 @@ declare function enablePricingPlansForService(serviceId: string, pricingPlanIds:
|
|
|
4930
4851
|
__applicationErrorsType?: EnablePricingPlansForServiceApplicationErrors;
|
|
4931
4852
|
}>;
|
|
4932
4853
|
/**
|
|
4933
|
-
* Removes a list of pricing plan IDs
|
|
4934
|
-
* ([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))
|
|
4935
|
-
* 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.
|
|
4936
4855
|
*
|
|
4937
4856
|
*
|
|
4938
4857
|
* If you remove all pricing plan IDs from `payment.pricingPlanIds` and the
|
|
@@ -4950,8 +4869,7 @@ declare function disablePricingPlansForService(serviceId: string, options?: Disa
|
|
|
4950
4869
|
}>;
|
|
4951
4870
|
interface DisablePricingPlansForServiceOptions {
|
|
4952
4871
|
/**
|
|
4953
|
-
* IDs of the pricing plans
|
|
4954
|
-
* ([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)
|
|
4955
4873
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
4956
4874
|
* @format GUID
|
|
4957
4875
|
* @maxSize 75
|
|
@@ -5019,15 +4937,12 @@ interface ValidateSlugOptions {
|
|
|
5019
4937
|
*
|
|
5020
4938
|
* #### Schedule
|
|
5021
4939
|
*
|
|
5022
|
-
* Wix Bookings automatically creates a new active schedule
|
|
5023
|
-
* ([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)
|
|
5024
4941
|
* for the cloned service. If Wix Bookings can't create this schedule, the
|
|
5025
4942
|
* Clone Service call fails.
|
|
5026
4943
|
*
|
|
5027
4944
|
* - __For appointment-based services__: Future appointments aren't added to the
|
|
5028
|
-
* cloned service's schedule. Use the Events API
|
|
5029
|
-
* ([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))
|
|
5030
|
-
* 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.
|
|
5031
4946
|
* - __For classes and courses__: Future one-time events aren't added to the
|
|
5032
4947
|
* cloned service's schedule, while future recurring events are added
|
|
5033
4948
|
* asynchronously. The Clone Service call always succeeds, whether or not
|
|
@@ -5035,25 +4950,20 @@ interface ValidateSlugOptions {
|
|
|
5035
4950
|
* If the response includes `RECURRING_EVENTS` in the `errors` array, it means the
|
|
5036
4951
|
* cloned service doesn't have future recurring events, even though the original
|
|
5037
4952
|
* service does. You can either delete the cloned service and try again or use
|
|
5038
|
-
* the Events API
|
|
5039
|
-
* ([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))
|
|
5040
|
-
* 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.
|
|
5041
4954
|
*
|
|
5042
4955
|
* Wix Bookings never adds past events to the cloned service's schedule.
|
|
5043
4956
|
*
|
|
5044
4957
|
* #### Service options and variants
|
|
5045
4958
|
*
|
|
5046
|
-
* If the original service has variants
|
|
5047
|
-
* ([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),
|
|
5048
4960
|
* they're cloned asynchronously. The Clone Service call always succeeds,
|
|
5049
4961
|
* regardless of whether variants were cloned.
|
|
5050
4962
|
*
|
|
5051
4963
|
* If the response includes `OPTIONS_AND_VARIANTS` in the `errors` array, the cloned
|
|
5052
4964
|
* service doesn't have variants, even though the original service does. You can
|
|
5053
4965
|
* delete the cloned service and call Clone Service again, or use the
|
|
5054
|
-
*
|
|
5055
|
-
* ([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))
|
|
5056
|
-
* 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.
|
|
5057
4967
|
*
|
|
5058
4968
|
* #### Booking form
|
|
5059
4969
|
*
|
|
@@ -5062,11 +4972,9 @@ interface ValidateSlugOptions {
|
|
|
5062
4972
|
*
|
|
5063
4973
|
* #### Pricing plans
|
|
5064
4974
|
*
|
|
5065
|
-
* If the original service's accepts payments via pricing plans
|
|
5066
|
-
* ([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/),
|
|
5067
4976
|
* the cloned service's `payment.options.pricingPlan` is also set to `true`. To
|
|
5068
|
-
* accept specific pricing plans, call Enable Pricing Plans For Service
|
|
5069
|
-
* ([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),
|
|
5070
4978
|
* after cloning the service. If the original service accepts only
|
|
5071
4979
|
* pricing plan payments and you don't call Enable Pricing Plans For Service
|
|
5072
4980
|
* after cloning the service, customers will be unable to book the service.
|