@wix/auto_sdk_bookings_services 1.0.0
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/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +41 -0
- package/build/cjs/src/bookings-services-v2-service-services.context.js +85 -0
- package/build/cjs/src/bookings-services-v2-service-services.context.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.http.d.ts +482 -0
- package/build/cjs/src/bookings-services-v2-service-services.http.js +1790 -0
- package/build/cjs/src/bookings-services-v2-service-services.http.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.meta.d.ts +47 -0
- package/build/cjs/src/bookings-services-v2-service-services.meta.js +427 -0
- package/build/cjs/src/bookings-services-v2-service-services.meta.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +584 -0
- package/build/cjs/src/bookings-services-v2-service-services.public.js +307 -0
- package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +4056 -0
- package/build/cjs/src/bookings-services-v2-service-services.types.js +386 -0
- package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -0
- package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +5180 -0
- package/build/cjs/src/bookings-services-v2-service-services.universal.js +2282 -0
- package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/bookings-services-v2-service-services.context.d.ts +41 -0
- package/build/es/src/bookings-services-v2-service-services.context.js +41 -0
- package/build/es/src/bookings-services-v2-service-services.context.js.map +1 -0
- package/build/es/src/bookings-services-v2-service-services.http.d.ts +482 -0
- package/build/es/src/bookings-services-v2-service-services.http.js +1766 -0
- package/build/es/src/bookings-services-v2-service-services.http.js.map +1 -0
- package/build/es/src/bookings-services-v2-service-services.meta.d.ts +47 -0
- package/build/es/src/bookings-services-v2-service-services.meta.js +380 -0
- package/build/es/src/bookings-services-v2-service-services.meta.js.map +1 -0
- package/build/es/src/bookings-services-v2-service-services.public.d.ts +584 -0
- package/build/es/src/bookings-services-v2-service-services.public.js +242 -0
- package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -0
- package/build/es/src/bookings-services-v2-service-services.types.d.ts +4056 -0
- package/build/es/src/bookings-services-v2-service-services.types.js +383 -0
- package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -0
- package/build/es/src/bookings-services-v2-service-services.universal.d.ts +5180 -0
- package/build/es/src/bookings-services-v2-service-services.universal.js +2234 -0
- package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +41 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +85 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.d.ts +482 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.js +1790 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.http.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.d.ts +47 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.js +427 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.meta.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +584 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js +307 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +4056 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +386 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +5180 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +2282 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +41 -0
- package/build/internal/es/src/bookings-services-v2-service-services.context.js +41 -0
- package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.http.d.ts +482 -0
- package/build/internal/es/src/bookings-services-v2-service-services.http.js +1766 -0
- package/build/internal/es/src/bookings-services-v2-service-services.http.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.meta.d.ts +47 -0
- package/build/internal/es/src/bookings-services-v2-service-services.meta.js +380 -0
- package/build/internal/es/src/bookings-services-v2-service-services.meta.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +584 -0
- package/build/internal/es/src/bookings-services-v2-service-services.public.js +242 -0
- package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +4056 -0
- package/build/internal/es/src/bookings-services-v2-service-services.types.js +383 -0
- package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -0
- package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +5180 -0
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js +2234 -0
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,584 @@
|
|
|
1
|
+
import { EventDefinition, HttpClient } from '@wix/sdk-types';
|
|
2
|
+
import { BulkDeleteServicesByFilterOptions, BulkDeleteServicesByFilterResponse, BulkDeleteServicesByFilterResponseNonNullableFields, BulkDeleteServicesOptions, BulkDeleteServicesResponse, BulkDeleteServicesResponseNonNullableFields, BulkUpdateServicesByFilterOptions, BulkUpdateServicesByFilterResponse, BulkUpdateServicesByFilterResponseNonNullableFields, BulkUpdateServicesOptions, BulkUpdateServicesResponse, BulkUpdateServicesResponseNonNullableFields, CloneServiceResponse, CloneServiceResponseNonNullableFields, CountServicesOptions, CountServicesResponse, CountServicesResponseNonNullableFields, CursorQuery, CursorSearch, DeleteServiceOptions, DisablePricingPlansForServiceOptions, DisablePricingPlansForServiceResponse, DisablePricingPlansForServiceResponseNonNullableFields, EnablePricingPlansForServiceResponse, EnablePricingPlansForServiceResponseNonNullableFields, QueryBookingFormsOptions, QueryBookingFormsResponse, QueryBookingFormsResponseNonNullableFields, QueryCategoriesOptions, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, QueryLocationsOptions, QueryLocationsResponse, QueryLocationsResponseNonNullableFields, QueryPoliciesResponse, QueryPoliciesResponseNonNullableFields, QueryServicesOptions, SearchServicesResponse, SearchServicesResponseNonNullableFields, Service, ServiceCreatedEnvelope, ServiceDeletedEnvelope, ServiceNonNullableFields, ServiceUpdatedEnvelope, ServicesQueryBuilder, SetCustomSlugOptions, SetCustomSlugResponse, SetCustomSlugResponseNonNullableFields, SetServiceLocationsOptions, SetServiceLocationsResponse, SetServiceLocationsResponseNonNullableFields, UpdateService, V2Location, ValidateSlugOptions, ValidateSlugResponse, ValidateSlugResponseNonNullableFields } from './bookings-services-v2-service-services.universal.js';
|
|
3
|
+
export declare const __metadata: {
|
|
4
|
+
PACKAGE_NAME: string;
|
|
5
|
+
};
|
|
6
|
+
export declare function createService(httpClient: HttpClient): CreateServiceSignature;
|
|
7
|
+
interface CreateServiceSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Creates a service.
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* ## Required fields
|
|
13
|
+
*
|
|
14
|
+
* When creating a service you must specify the following fields:
|
|
15
|
+
* - `type`
|
|
16
|
+
* ([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)):
|
|
17
|
+
* Whether it's an appointment-based service, class, or course.
|
|
18
|
+
* - `name`: Service name that's displayed to customers.
|
|
19
|
+
* - `onlineBooking`:
|
|
20
|
+
* Settings determining whether customers can book online, whether the business
|
|
21
|
+
* must manually confirm bookings, and whether customers can request to book an
|
|
22
|
+
* appointment time slot that already has a booking request awaiting business
|
|
23
|
+
* confirmation.
|
|
24
|
+
* - `payment`
|
|
25
|
+
* ([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)):
|
|
26
|
+
* How customers can pay when signing up for the service.
|
|
27
|
+
*
|
|
28
|
+
* ### Session durations
|
|
29
|
+
*
|
|
30
|
+
* Depending on which type of service you're creating, you may also need to specify
|
|
31
|
+
* supported session durations.
|
|
32
|
+
*
|
|
33
|
+
* __Classes and courses__
|
|
34
|
+
*
|
|
35
|
+
* Don't specify `schedule.availabilityConstraints.sessionDurations`.
|
|
36
|
+
*
|
|
37
|
+
* __Appointment-based services without varied pricing based on session length__
|
|
38
|
+
*
|
|
39
|
+
* Specify the single supported session duration in the
|
|
40
|
+
* `schedule.availabilityConstraints.sessionDurations` array.
|
|
41
|
+
*
|
|
42
|
+
* __Appointment-based services with varied pricing based on session length__
|
|
43
|
+
*
|
|
44
|
+
* - Specify all supported session durations in `schedule.availabilityConstraints.sessionDurations`.
|
|
45
|
+
* - Note that Wix Bookings doesn't display these values to customers and
|
|
46
|
+
* ignores them in pricing and availability calculations. Instead session
|
|
47
|
+
* durations are retrieved from the relevant service variants
|
|
48
|
+
* ([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)).
|
|
49
|
+
* - It is mandatory to specify `schedule.availabilityConstraints.sessionDurations`,
|
|
50
|
+
* even though these values are ignored.
|
|
51
|
+
* @param - Service to create.
|
|
52
|
+
* @returns Created service.
|
|
53
|
+
*/
|
|
54
|
+
(service: Service): Promise<Service & ServiceNonNullableFields>;
|
|
55
|
+
}
|
|
56
|
+
export declare function getService(httpClient: HttpClient): GetServiceSignature;
|
|
57
|
+
interface GetServiceSignature {
|
|
58
|
+
/**
|
|
59
|
+
* Retrieves a service.
|
|
60
|
+
* @param - ID of the service to retrieve.
|
|
61
|
+
* @returns Retrieved service.
|
|
62
|
+
*/
|
|
63
|
+
(serviceId: string): Promise<Service & ServiceNonNullableFields>;
|
|
64
|
+
}
|
|
65
|
+
export declare function updateService(httpClient: HttpClient): UpdateServiceSignature;
|
|
66
|
+
interface UpdateServiceSignature {
|
|
67
|
+
/**
|
|
68
|
+
* Updates a service.
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* Each time the service is updated, `revision` increments by 1. You must
|
|
72
|
+
* include the number of the existing revision when updating the service.
|
|
73
|
+
* This ensures you're working with the latest service information and
|
|
74
|
+
* prevents unintended overwrites.
|
|
75
|
+
*
|
|
76
|
+
* ## Session durations
|
|
77
|
+
*
|
|
78
|
+
* Specify `schedule.availabilityConstraints.sessionDurations`
|
|
79
|
+
* only if you want to update it for appointment-based services without varied
|
|
80
|
+
* pricing based on session length. Don't specify `schedule.availabilityConstraints.sessionDurations`
|
|
81
|
+
* for all other appointment-based services, classes, or courses. See Create Service
|
|
82
|
+
* ([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))
|
|
83
|
+
* for more details.
|
|
84
|
+
* @param - Service ID.
|
|
85
|
+
* @returns Updated service.
|
|
86
|
+
*/
|
|
87
|
+
(_id: string | null, service: UpdateService): Promise<Service & ServiceNonNullableFields>;
|
|
88
|
+
}
|
|
89
|
+
export declare function bulkUpdateServices(httpClient: HttpClient): BulkUpdateServicesSignature;
|
|
90
|
+
interface BulkUpdateServicesSignature {
|
|
91
|
+
/**
|
|
92
|
+
* Updates multiple services.
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* See Update Service
|
|
96
|
+
* ([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))
|
|
97
|
+
* for more details.
|
|
98
|
+
*
|
|
99
|
+
* The call succeeds even if one or more individual services can't be updated.
|
|
100
|
+
* Information about failures is returned in `bulkActionMetadata`.
|
|
101
|
+
*/
|
|
102
|
+
(options?: BulkUpdateServicesOptions | undefined): Promise<BulkUpdateServicesResponse & BulkUpdateServicesResponseNonNullableFields>;
|
|
103
|
+
}
|
|
104
|
+
export declare function bulkUpdateServicesByFilter(httpClient: HttpClient): BulkUpdateServicesByFilterSignature;
|
|
105
|
+
interface BulkUpdateServicesByFilterSignature {
|
|
106
|
+
/**
|
|
107
|
+
* Updates multiple services by filter.
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* Refer to the supported filters article
|
|
111
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
112
|
+
* for more details.
|
|
113
|
+
*
|
|
114
|
+
* See Update Service
|
|
115
|
+
* ([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))
|
|
116
|
+
* for more details about updating a service.
|
|
117
|
+
*
|
|
118
|
+
* The call succeeds even if one or more individual services can't be updated.
|
|
119
|
+
* Information about failures is returned in `bulkActionMetadata`.
|
|
120
|
+
* @param - Filter to identify the services to update.
|
|
121
|
+
*/
|
|
122
|
+
(filter: Record<string, any> | null, options: BulkUpdateServicesByFilterOptions): Promise<BulkUpdateServicesByFilterResponse & BulkUpdateServicesByFilterResponseNonNullableFields>;
|
|
123
|
+
}
|
|
124
|
+
export declare function deleteService(httpClient: HttpClient): DeleteServiceSignature;
|
|
125
|
+
interface DeleteServiceSignature {
|
|
126
|
+
/**
|
|
127
|
+
* Deletes a service.
|
|
128
|
+
*
|
|
129
|
+
*
|
|
130
|
+
* Specify `{"preserveFutureSessionsWithParticipants": true}` to retain all
|
|
131
|
+
* future sessions for the service. By default, all future sessions are canceled.
|
|
132
|
+
* @param - ID of the service to delete.
|
|
133
|
+
* @param - Allows you to configure how to handle the deleted service's future sessions and how to notify the sessions participants.
|
|
134
|
+
*/
|
|
135
|
+
(serviceId: string, options?: DeleteServiceOptions | undefined): Promise<void>;
|
|
136
|
+
}
|
|
137
|
+
export declare function bulkDeleteServices(httpClient: HttpClient): BulkDeleteServicesSignature;
|
|
138
|
+
interface BulkDeleteServicesSignature {
|
|
139
|
+
/**
|
|
140
|
+
* Deletes multiple services.
|
|
141
|
+
*
|
|
142
|
+
*
|
|
143
|
+
* See Delete Service
|
|
144
|
+
* ([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))
|
|
145
|
+
* for more details about deleting a service.
|
|
146
|
+
*
|
|
147
|
+
* The call succeeds even if one or more individual services can't be deleted.
|
|
148
|
+
* Information about failures is returned in `bulkActionMetadata`.
|
|
149
|
+
* @param - IDs of the services to delete.
|
|
150
|
+
*/
|
|
151
|
+
(ids: string[], options?: BulkDeleteServicesOptions | undefined): Promise<BulkDeleteServicesResponse & BulkDeleteServicesResponseNonNullableFields>;
|
|
152
|
+
}
|
|
153
|
+
export declare function bulkDeleteServicesByFilter(httpClient: HttpClient): BulkDeleteServicesByFilterSignature;
|
|
154
|
+
interface BulkDeleteServicesByFilterSignature {
|
|
155
|
+
/**
|
|
156
|
+
* Deletes multiple services by filter.
|
|
157
|
+
*
|
|
158
|
+
*
|
|
159
|
+
* See Delete Service
|
|
160
|
+
* ([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))
|
|
161
|
+
* for more details about deleting a service.
|
|
162
|
+
*
|
|
163
|
+
* The call succeeds even if one or more individual services can't be deleted.
|
|
164
|
+
* Information about failures is returned in `bulkActionMetadata`.
|
|
165
|
+
*
|
|
166
|
+
* Refer to the supported filters article
|
|
167
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
168
|
+
* for more details.
|
|
169
|
+
*
|
|
170
|
+
* To learn about working with filters in general, see
|
|
171
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
172
|
+
* @param - Filter to identify the services that need to be deleted.
|
|
173
|
+
*/
|
|
174
|
+
(filter: Record<string, any> | null, options?: BulkDeleteServicesByFilterOptions | undefined): Promise<BulkDeleteServicesByFilterResponse & BulkDeleteServicesByFilterResponseNonNullableFields>;
|
|
175
|
+
}
|
|
176
|
+
export declare function queryServices(httpClient: HttpClient): QueryServicesSignature;
|
|
177
|
+
interface QueryServicesSignature {
|
|
178
|
+
/**
|
|
179
|
+
* Retrieves a list of up to 100 services, given the provided paging, filtering, and sorting.
|
|
180
|
+
* `queryServices()` runs with these defaults, which you can override:
|
|
181
|
+
* + `paging.limit` is `100`.
|
|
182
|
+
* + `paging.offset` is `0`.
|
|
183
|
+
*
|
|
184
|
+
*
|
|
185
|
+
* >**Notes:**
|
|
186
|
+
* > + Use UTC format when filtering with dates.
|
|
187
|
+
* > + Only 1 use of each filter in the same query is supported. If a filter is defined more than once in a query, only the first occurrence is processed.
|
|
188
|
+
*/
|
|
189
|
+
(options?: QueryServicesOptions | undefined): ServicesQueryBuilder;
|
|
190
|
+
}
|
|
191
|
+
export declare function searchServices(httpClient: HttpClient): SearchServicesSignature;
|
|
192
|
+
interface SearchServicesSignature {
|
|
193
|
+
/**
|
|
194
|
+
* Retrieves a list of up to 100 services, given the provided filtering, paging,
|
|
195
|
+
* and sorting.
|
|
196
|
+
*
|
|
197
|
+
*
|
|
198
|
+
* ## Defaults
|
|
199
|
+
*
|
|
200
|
+
* Search Services has the following default settings, which you can override:
|
|
201
|
+
* + Sorted by `createdDate` in ascending order.
|
|
202
|
+
* + `paging.limit` set to `100`.
|
|
203
|
+
* + `paging.offset` set to `0`.
|
|
204
|
+
*
|
|
205
|
+
* ## Filters
|
|
206
|
+
*
|
|
207
|
+
* When using filters for dates, you must use
|
|
208
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
209
|
+
*
|
|
210
|
+
* Refer to the supported filters article
|
|
211
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting))
|
|
212
|
+
* for a complete list of supported filters and sorting options.
|
|
213
|
+
*
|
|
214
|
+
* ## See also
|
|
215
|
+
*
|
|
216
|
+
* To learn about working with *Search* methods, see
|
|
217
|
+
* API Query Language
|
|
218
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language))
|
|
219
|
+
* and Sorting and Paging
|
|
220
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language#the-sort-array) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging)).
|
|
221
|
+
* @param - WQL, search or aggregation expression.
|
|
222
|
+
*/
|
|
223
|
+
(search: CursorSearch): Promise<SearchServicesResponse & SearchServicesResponseNonNullableFields>;
|
|
224
|
+
}
|
|
225
|
+
export declare function queryPolicies(httpClient: HttpClient): QueryPoliciesSignature;
|
|
226
|
+
interface QueryPoliciesSignature {
|
|
227
|
+
/**
|
|
228
|
+
* Retrieves a list of up to 100 booking policies
|
|
229
|
+
* ([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)),
|
|
230
|
+
* and information about the services that are connected to them,
|
|
231
|
+
* given the provided filtering, paging, and sorting.
|
|
232
|
+
*
|
|
233
|
+
* ## Defaults
|
|
234
|
+
*
|
|
235
|
+
* Query Policies has the following default settings, which you can override:
|
|
236
|
+
*
|
|
237
|
+
* + Sorted by `id` in ascending order.
|
|
238
|
+
* + `cursorPaging.limit` set to `100`.
|
|
239
|
+
*
|
|
240
|
+
* ## Filters
|
|
241
|
+
*
|
|
242
|
+
* For a complete list of supported filters, refer to **Booking Policies API: Supported Filters**
|
|
243
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters)).
|
|
244
|
+
*
|
|
245
|
+
* When using date filters, you must use
|
|
246
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
247
|
+
*
|
|
248
|
+
* ## Returned services
|
|
249
|
+
*
|
|
250
|
+
* If a booking policy is connected to more than 5 services, only a subset of
|
|
251
|
+
* those services is returned. The `bookingPolicies.totalServiceCount` values
|
|
252
|
+
* indicate the total number of services linked to each policy. You can call Search Services
|
|
253
|
+
* ([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))
|
|
254
|
+
* and specify the relevant policy ID in the filter to retrieve all services
|
|
255
|
+
* connected to the booking policy.
|
|
256
|
+
*
|
|
257
|
+
* ## See also
|
|
258
|
+
*
|
|
259
|
+
* To learn about working with *Query* endpoints, see
|
|
260
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
261
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
262
|
+
* @param - Information about filters, paging, and sorting. See the article about
|
|
263
|
+
* booking policy filters
|
|
264
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters))
|
|
265
|
+
* for all supported filters and sorting options.
|
|
266
|
+
*/
|
|
267
|
+
(query: CursorQuery): Promise<QueryPoliciesResponse & QueryPoliciesResponseNonNullableFields>;
|
|
268
|
+
}
|
|
269
|
+
export declare function queryBookingForms(httpClient: HttpClient): QueryBookingFormsSignature;
|
|
270
|
+
interface QueryBookingFormsSignature {
|
|
271
|
+
/**
|
|
272
|
+
* Retrieves a list of up to 100 booking forms
|
|
273
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/forms/introduction)),
|
|
274
|
+
* and information about the services that are connected to them,
|
|
275
|
+
* given the provided filtering, paging, and sorting.
|
|
276
|
+
*
|
|
277
|
+
*
|
|
278
|
+
* ## Defaults
|
|
279
|
+
*
|
|
280
|
+
* Query Booking Forms has the following default settings, which you can override:
|
|
281
|
+
*
|
|
282
|
+
* + Sorted by `id` in ascending order.
|
|
283
|
+
* + `cursorPaging.limit` set to `100`.
|
|
284
|
+
*
|
|
285
|
+
* ## Filters
|
|
286
|
+
*
|
|
287
|
+
* For a complete list of supported filters, refer to **Forms API: Supported Filters**
|
|
288
|
+
* ([REST](https://dev.wix.com/docs/rest/crm/forms/forms/introduction/supported-filters)).
|
|
289
|
+
*
|
|
290
|
+
* When using date filters, you must use
|
|
291
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
292
|
+
*
|
|
293
|
+
* ## Returned services
|
|
294
|
+
*
|
|
295
|
+
* If a booking policy is connected to more than 5 services, only a subset of
|
|
296
|
+
* these service IDs and names is returned. The `bookingForms.totalServiceCount`
|
|
297
|
+
* values indicate the total number of services linked to each form. You can call Query Services
|
|
298
|
+
* ([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))
|
|
299
|
+
* and specify the relevant form ID in the filter to retrieve all services
|
|
300
|
+
* connected to the booking form.
|
|
301
|
+
*
|
|
302
|
+
* ## Default booking forms
|
|
303
|
+
*
|
|
304
|
+
* By default, all Wix Bookings services use a standard booking form. To retrieve
|
|
305
|
+
* a site's default booking form with Query Booking Forms, specify
|
|
306
|
+
* `{"conditionalFields": ["DEFAULT_BOOKING_FORM"]}`.
|
|
307
|
+
*
|
|
308
|
+
* ## See also
|
|
309
|
+
*
|
|
310
|
+
* To learn about working with *Query* endpoints, see
|
|
311
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
312
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
313
|
+
* @param - Information about filters, paging, and sorting. See the article about
|
|
314
|
+
* form filters ([REST](https://dev.wix.com/docs/rest/crm/forms/forms/introduction/supported-filters))
|
|
315
|
+
* for all supported filters and sorting options.
|
|
316
|
+
*/
|
|
317
|
+
(query: CursorQuery, options?: QueryBookingFormsOptions | undefined): Promise<QueryBookingFormsResponse & QueryBookingFormsResponseNonNullableFields>;
|
|
318
|
+
}
|
|
319
|
+
export declare function countServices(httpClient: HttpClient): CountServicesSignature;
|
|
320
|
+
interface CountServicesSignature {
|
|
321
|
+
/**
|
|
322
|
+
* Counts how many services match the given filter.
|
|
323
|
+
*
|
|
324
|
+
*
|
|
325
|
+
* Refer to the supported filters article
|
|
326
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
327
|
+
* for more details.
|
|
328
|
+
*
|
|
329
|
+
* To learn about working with filters in general, see
|
|
330
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters)
|
|
331
|
+
*/
|
|
332
|
+
(options?: CountServicesOptions | undefined): Promise<CountServicesResponse & CountServicesResponseNonNullableFields>;
|
|
333
|
+
}
|
|
334
|
+
export declare function queryLocations(httpClient: HttpClient): QueryLocationsSignature;
|
|
335
|
+
interface QueryLocationsSignature {
|
|
336
|
+
/**
|
|
337
|
+
* Retrieves 3 separate lists of business, custom, and customer locations
|
|
338
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)),
|
|
339
|
+
* given the provided filtering, and whether each location is connected to at
|
|
340
|
+
* least one of the site's services.
|
|
341
|
+
*
|
|
342
|
+
*
|
|
343
|
+
* ## Defaults
|
|
344
|
+
*
|
|
345
|
+
* Query Locations has the following default setting, which you can't override:
|
|
346
|
+
* Sorted by `id` in ascending order.
|
|
347
|
+
*
|
|
348
|
+
* ## Filters
|
|
349
|
+
*
|
|
350
|
+
* For a complete list of supported filters, refer to the supported filters article
|
|
351
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering)).
|
|
352
|
+
*
|
|
353
|
+
* When using date filters, you must use
|
|
354
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
355
|
+
*
|
|
356
|
+
* ## See also
|
|
357
|
+
*
|
|
358
|
+
* To learn about working with *Query* endpoints, see
|
|
359
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
360
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
361
|
+
*/
|
|
362
|
+
(options?: QueryLocationsOptions | undefined): Promise<QueryLocationsResponse & QueryLocationsResponseNonNullableFields>;
|
|
363
|
+
}
|
|
364
|
+
export declare function queryCategories(httpClient: HttpClient): QueryCategoriesSignature;
|
|
365
|
+
interface QueryCategoriesSignature {
|
|
366
|
+
/**
|
|
367
|
+
* Retrieves a list of service categories
|
|
368
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v2/introduction)),
|
|
369
|
+
* given the provided filtering.
|
|
370
|
+
*
|
|
371
|
+
*
|
|
372
|
+
* ## Defaults
|
|
373
|
+
*
|
|
374
|
+
* Query Categories has the following default setting, which you can't override:
|
|
375
|
+
* Sorted by `id` in ascending order.
|
|
376
|
+
*
|
|
377
|
+
* ## Filters
|
|
378
|
+
*
|
|
379
|
+
* For a complete list of supported filters, refer to the supported filters article
|
|
380
|
+
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering)).
|
|
381
|
+
*
|
|
382
|
+
* When using date filters, you must use
|
|
383
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
384
|
+
*
|
|
385
|
+
* ## See also
|
|
386
|
+
*
|
|
387
|
+
* To learn about working with *Query* endpoints, see
|
|
388
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
389
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
390
|
+
*/
|
|
391
|
+
(options?: QueryCategoriesOptions | undefined): Promise<QueryCategoriesResponse & QueryCategoriesResponseNonNullableFields>;
|
|
392
|
+
}
|
|
393
|
+
export declare function setServiceLocations(httpClient: HttpClient): SetServiceLocationsSignature;
|
|
394
|
+
interface SetServiceLocationsSignature {
|
|
395
|
+
/**
|
|
396
|
+
* Replaces the list of the locations
|
|
397
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
398
|
+
* where the business offers the service.
|
|
399
|
+
*
|
|
400
|
+
*
|
|
401
|
+
* ## Consequences for customers
|
|
402
|
+
*
|
|
403
|
+
* Removing a service location may impact existing sessions and their
|
|
404
|
+
* participants. If you remove at least one service location, you must
|
|
405
|
+
* specify `removedLocationSessionsAction` to indicate what happens to all
|
|
406
|
+
* future sessions scheduled at this location.
|
|
407
|
+
*
|
|
408
|
+
* - **Keep existing location**: If you want to retain future sessions at their
|
|
409
|
+
* originally scheduled location, specify
|
|
410
|
+
* `{"removedLocationSessionsAction.action": "KEEP_AT_CURRENT_LOCATION"}`.
|
|
411
|
+
* This ensures nothing changes for the customer, but the business must be
|
|
412
|
+
* able to provide access to the removed location in the future.
|
|
413
|
+
* - **Update location**: If you want to update the location for future sessions
|
|
414
|
+
* scheduled at the removed location, specify
|
|
415
|
+
* `{"removedLocationSessionsAction.action": "MOVE_TO_LOCATION"}` and
|
|
416
|
+
* `moveToLocationOptions.newLocation`.
|
|
417
|
+
*
|
|
418
|
+
* You can't mix and match to keep some sessions at the previous location while
|
|
419
|
+
* moving other sessions to an updated location.
|
|
420
|
+
*
|
|
421
|
+
* Past session details aren't changed, no matter which option you choose for
|
|
422
|
+
* future sessions.
|
|
423
|
+
*
|
|
424
|
+
* Future sessions scheduled for a location defined by the customer are also not
|
|
425
|
+
* updated.
|
|
426
|
+
*
|
|
427
|
+
* ## Specify location details
|
|
428
|
+
*
|
|
429
|
+
* Depending on whether the new or updated location is a business or custom location,
|
|
430
|
+
* you need to specify different fields.
|
|
431
|
+
*
|
|
432
|
+
* - **Business location**: Specify the relevant location ID
|
|
433
|
+
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
434
|
+
* in `locations.business.id`.
|
|
435
|
+
* - **Custom location**: Specify the complete address object as
|
|
436
|
+
* `locations.custom.address`.
|
|
437
|
+
*
|
|
438
|
+
* ## Participant notifications
|
|
439
|
+
*
|
|
440
|
+
* You can specify a `participantNotification.message` that's immediately send
|
|
441
|
+
* to all customers who had booked at a changed location. Ensure
|
|
442
|
+
* `participantNotification.notifyParticipants` is set to `true` to send the
|
|
443
|
+
* message.
|
|
444
|
+
* @param - ID of the service.
|
|
445
|
+
* @param - List of locations replacing existing service locations. Omitting an existing location removes it from the service. Specify `removedLocationSessionsAction` to determine the handling of future sessions scheduled at that location.
|
|
446
|
+
*/
|
|
447
|
+
(serviceId: string, locations: V2Location[], options?: SetServiceLocationsOptions | undefined): Promise<SetServiceLocationsResponse & SetServiceLocationsResponseNonNullableFields>;
|
|
448
|
+
}
|
|
449
|
+
export declare function enablePricingPlansForService(httpClient: HttpClient): EnablePricingPlansForServiceSignature;
|
|
450
|
+
interface EnablePricingPlansForServiceSignature {
|
|
451
|
+
/**
|
|
452
|
+
* Adds a list of pricing plans ID
|
|
453
|
+
* ([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))
|
|
454
|
+
* to a service's `payment.pricingPlanIds` array.
|
|
455
|
+
*
|
|
456
|
+
*
|
|
457
|
+
* The call doesn't validate whether the service's `payment.options.pricingPlan`
|
|
458
|
+
* is set to `true`. If it's set to `false`, customers aren't able to pay
|
|
459
|
+
* for their bookings using pricing plans. You can call Update Service
|
|
460
|
+
* ([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))
|
|
461
|
+
* to change a service's supported payment methods.
|
|
462
|
+
* @param - ID of the service to update.
|
|
463
|
+
* @param - IDs of the pricing plans
|
|
464
|
+
* ([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))
|
|
465
|
+
* to add to the service's `payment.pricingPlanIds` array.
|
|
466
|
+
*/
|
|
467
|
+
(serviceId: string, pricingPlanIds: string[]): Promise<EnablePricingPlansForServiceResponse & EnablePricingPlansForServiceResponseNonNullableFields>;
|
|
468
|
+
}
|
|
469
|
+
export declare function disablePricingPlansForService(httpClient: HttpClient): DisablePricingPlansForServiceSignature;
|
|
470
|
+
interface DisablePricingPlansForServiceSignature {
|
|
471
|
+
/**
|
|
472
|
+
* Removes a list of pricing plans ID
|
|
473
|
+
* ([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))
|
|
474
|
+
* from a service's `payment.pricingPlanIds` array.
|
|
475
|
+
*
|
|
476
|
+
*
|
|
477
|
+
* If you remove all pricing plan IDs from `payment.pricingPlanIds` and the
|
|
478
|
+
* service supports only payments by pricing plan, customers will no longer be
|
|
479
|
+
* able to book the service, as they will have no payment options available.
|
|
480
|
+
* @param - ID of the service to update.
|
|
481
|
+
*/
|
|
482
|
+
(serviceId: string, options?: DisablePricingPlansForServiceOptions | undefined): Promise<DisablePricingPlansForServiceResponse & DisablePricingPlansForServiceResponseNonNullableFields>;
|
|
483
|
+
}
|
|
484
|
+
export declare function setCustomSlug(httpClient: HttpClient): SetCustomSlugSignature;
|
|
485
|
+
interface SetCustomSlugSignature {
|
|
486
|
+
/**
|
|
487
|
+
* Sets a new active slug for the service.
|
|
488
|
+
*
|
|
489
|
+
*
|
|
490
|
+
* The call fails if at least one of these conditions is met:
|
|
491
|
+
* - The slug doesn't adheres to the supported format.
|
|
492
|
+
* - Another service is currently using the slug.
|
|
493
|
+
* - Another service has used the slug in the past.
|
|
494
|
+
* @param - ID of the service for which to update the active slug.
|
|
495
|
+
*/
|
|
496
|
+
(serviceId: string, options?: SetCustomSlugOptions | undefined): Promise<SetCustomSlugResponse & SetCustomSlugResponseNonNullableFields>;
|
|
497
|
+
}
|
|
498
|
+
export declare function validateSlug(httpClient: HttpClient): ValidateSlugSignature;
|
|
499
|
+
interface ValidateSlugSignature {
|
|
500
|
+
/**
|
|
501
|
+
* Checks whether a custom slug is validate for the service.
|
|
502
|
+
*
|
|
503
|
+
*
|
|
504
|
+
* The checks include:
|
|
505
|
+
* - The slug adheres to the supported format.
|
|
506
|
+
* - No other service is currently using the slug.
|
|
507
|
+
* - No other service has used the slug in the past.
|
|
508
|
+
*
|
|
509
|
+
* The call fails if at least one of the checks fails.
|
|
510
|
+
* @param - IO of the service to check custom slug validity for.
|
|
511
|
+
*/
|
|
512
|
+
(serviceId: string, options?: ValidateSlugOptions | undefined): Promise<ValidateSlugResponse & ValidateSlugResponseNonNullableFields>;
|
|
513
|
+
}
|
|
514
|
+
export declare function cloneService(httpClient: HttpClient): CloneServiceSignature;
|
|
515
|
+
interface CloneServiceSignature {
|
|
516
|
+
/**
|
|
517
|
+
* Clones a service.
|
|
518
|
+
*
|
|
519
|
+
*
|
|
520
|
+
* ## Connected entities
|
|
521
|
+
*
|
|
522
|
+
* By default, not all entities connected to the service are cloned.
|
|
523
|
+
*
|
|
524
|
+
* ### Schedule
|
|
525
|
+
*
|
|
526
|
+
* Wix Bookings automatically creates a new active *schedule*
|
|
527
|
+
* ([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))
|
|
528
|
+
* for the cloned service. If Wix Bookings can't create this schedule, the
|
|
529
|
+
* Clone Service* call fails.
|
|
530
|
+
*
|
|
531
|
+
* - __For appointment-based services__: Future appointments aren't added to the
|
|
532
|
+
* cloned service's schedule. Use the *Events API*
|
|
533
|
+
* ([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))
|
|
534
|
+
* to add them as needed.
|
|
535
|
+
* - __For classes and courses__: Future one-time events aren't added to the
|
|
536
|
+
* cloned service's schedule, while future recurring events are added
|
|
537
|
+
* asynchronously. The *Clone Service* call always succeeds, whether or not
|
|
538
|
+
* recurring events are added.
|
|
539
|
+
* If the response includes `RECURRING_EVENTS` in the `errors` array, it means the
|
|
540
|
+
* cloned service doesn't have future recurring events, even though the original
|
|
541
|
+
* service does. You can either delete the cloned service and try again or use
|
|
542
|
+
* the *Events API*
|
|
543
|
+
* ([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))
|
|
544
|
+
* to add missing events to the schedule.
|
|
545
|
+
*
|
|
546
|
+
* Wix Bookings never adds past events to the cloned service's schedule.
|
|
547
|
+
*
|
|
548
|
+
* ### Service options and variants
|
|
549
|
+
*
|
|
550
|
+
* If the original service has variants
|
|
551
|
+
* ([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)),
|
|
552
|
+
* they're cloned asynchronously. The *Clone Service* call always succeeds,
|
|
553
|
+
* regardless of whether variants were cloned.
|
|
554
|
+
*
|
|
555
|
+
* If the response includes `OPTIONS_AND_VARIANTS` in the `errors` array, the cloned
|
|
556
|
+
* service doesn't have variants, even though the original service does. You can
|
|
557
|
+
* delete the cloned service and call *Clone Service* again, or use the
|
|
558
|
+
* Service Options And Variants API*
|
|
559
|
+
* ([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))
|
|
560
|
+
* to add variants.
|
|
561
|
+
*
|
|
562
|
+
* ### Booking form
|
|
563
|
+
*
|
|
564
|
+
* The original service's booking form isn't cloned, whether it's
|
|
565
|
+
* the default or a custom booking form.
|
|
566
|
+
*
|
|
567
|
+
* ### Pricing plans
|
|
568
|
+
*
|
|
569
|
+
* If the original service's accepts payments via pricing plans
|
|
570
|
+
* ([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)),
|
|
571
|
+
* the cloned service's `payment.options.pricingPlan` is also set to `true`. To
|
|
572
|
+
* accept specific pricing plans, call *Enable Pricing Plans For Service*
|
|
573
|
+
* ([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)),
|
|
574
|
+
* after cloning the service. If the original service accepts only
|
|
575
|
+
* pricing plan payments and you don't call *Enable Pricing Plans For Service*
|
|
576
|
+
* after cloning the service, customers will be unable to book the service.
|
|
577
|
+
* @param - ID of the service to clone.
|
|
578
|
+
*/
|
|
579
|
+
(sourceServiceId: string): Promise<CloneServiceResponse & CloneServiceResponseNonNullableFields>;
|
|
580
|
+
}
|
|
581
|
+
export declare const onServiceCreated: EventDefinition<ServiceCreatedEnvelope, "wix.bookings.services.v2.service_created">;
|
|
582
|
+
export declare const onServiceDeleted: EventDefinition<ServiceDeletedEnvelope, "wix.bookings.services.v2.service_deleted">;
|
|
583
|
+
export declare const onServiceUpdated: EventDefinition<ServiceUpdatedEnvelope, "wix.bookings.services.v2.service_updated">;
|
|
584
|
+
export { Action, ActionEvent, Address, AddressHint, AddressLocation, AddressStreetOneOf, Aggregation, AggregationData, AggregationKindOneOf, AggregationResults, AggregationResultsResultOneOf, AggregationResultsScalarResult, AggregationType, ApplicationError, ApprovalStatus, Availability, AvailabilityConstraints, AvailabilityPolicy, AvailabilityPolicyUpdated, BaseEventMetadata, Behavior, BehaviorBehaviorOneOf, Benefit, BenefitNotification, BenefitType, BookAfterStartPolicy, BookingForm, BookingPolicy, BookingPolicyWithServices, BulkActionMetadata, BulkCreateServicesRequest, BulkCreateServicesResponse, BulkDeleteServicesByFilterOptions, BulkDeleteServicesByFilterRequest, BulkDeleteServicesByFilterResponse, BulkDeleteServicesByFilterResponseNonNullableFields, BulkDeleteServicesOptions, BulkDeleteServicesRequest, BulkDeleteServicesResponse, BulkDeleteServicesResponseNonNullableFields, BulkServiceResult, BulkUpdateServicesByFilterOptions, BulkUpdateServicesByFilterRequest, BulkUpdateServicesByFilterResponse, BulkUpdateServicesByFilterResponseNonNullableFields, BulkUpdateServicesOptions, BulkUpdateServicesRequest, BulkUpdateServicesResponse, BulkUpdateServicesResponseNonNullableFields, BusinessLocation, BusinessLocationOptions, BusinessLocations, BusinessSchedule, CalendarConference, CalendarDateTime, CalendarType, CancellationFeePolicy, CancellationPolicy, CancellationWindow, CancellationWindowFeeOneOf, Categories, Category, CategoryNotification, CategoryNotificationEvent, CategoryStatus, ChangeContext, ChangeContextPayloadOneOf, CloneErrors, CloneServiceRequest, CloneServiceResponse, CloneServiceResponseNonNullableFields, CommonAddress, CommonAddressLocation, CommonAddressStreetOneOf, CommonStreetAddress, ConferenceProvider, ConferenceType, Conferencing, ConnectedService, ConsentPolicy, CountServicesOptions, CountServicesRequest, CountServicesResponse, CountServicesResponseNonNullableFields, CreateServiceRequest, CreateServiceResponse, CreateServiceResponseNonNullableFields, CrudType, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, CursorSearch, CursorSearchPagingMethodOneOf, Cursors, CustomLocationOptions, CustomLocations, CustomPayment, CustomerLocations, DateHistogramAggregation, DateHistogramAggregationInterval, DateHistogramResult, DateHistogramResults, Day, DayOfWeek, DeleteServiceOptions, DeleteServiceRequest, DeleteServiceResponse, DisablePricingPlansForServiceOptions, DisablePricingPlansForServiceRequest, DisablePricingPlansForServiceResponse, DisablePricingPlansForServiceResponseNonNullableFields, Discount, DiscountDiscountOneOf, DomainEvent, DomainEventBodyOneOf, Duration, Empty, EnablePricingPlansForServiceRequest, EnablePricingPlansForServiceResponse, EnablePricingPlansForServiceResponseNonNullableFields, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntryPass, Event, EventMetadata, ExtendedFields, ExternalCalendarInfo, ExternalCalendarOverrides, FieldViolation, FixedPayment, FocalPoint, Form, FormDetails, FormSettings, Frequency, GeoCoordinates, GetServiceAvailabilityConstraintsRequest, GetServiceAvailabilityConstraintsResponse, GetServiceRequest, GetServiceResponse, GetServiceResponseNonNullableFields, GroupByAggregation, GroupByAggregationKindOneOf, GroupByValueResults, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, IncludeMissingValuesOptions, Interval, IntervalSplit, InvalidPricingPlan, InvalidSlugError, ItemMetadata, Keyword, LimitEarlyBookingPolicy, LimitLateBookingPolicy, LinkedSchedule, LocalDateTime, Locale, Location, LocationStatus, LocationType, LocationTypeEnumLocationType, LocationsAddress, LocationsAddressLocation, LocationsLocation, LocationsLocationType, LocationsStreetAddress, MaskedService, Media, MediaItem, MediaItemItemOneOf, MessageEnvelope, MigrationData, MigrationEvent, MissingValues, Mode, Money, MoveToNewLocationsOptions, Multilingual, MultipleSessionsCreated, NestedAggregation, NestedAggregationItem, NestedAggregationItemKindOneOf, NestedAggregationResults, NestedAggregationResultsResultOneOf, NestedAggregationType, NestedResultValue, NestedResultValueResultOneOf, NestedResults, NestedValueAggregationResult, OnlineBooking, Page, Paging, PagingMetadataV2, Participant, ParticipantNotification, ParticipantsPolicy, Payment, PaymentOptions, PaymentRateOneOf, PlacementType, PolicyDescription, Price, Properties, PropertiesChange, QueryBookingFormsOptions, QueryBookingFormsRequest, QueryBookingFormsResponse, QueryBookingFormsResponseNonNullableFields, QueryCategoriesFilter, QueryCategoriesOptions, QueryCategoriesRequest, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, QueryLocationsFilter, QueryLocationsOptions, QueryLocationsRequest, QueryLocationsResponse, QueryLocationsResponseNonNullableFields, QueryPoliciesRequest, QueryPoliciesResponse, QueryPoliciesResponseNonNullableFields, QueryServicesMultiLanguageRequest, QueryServicesMultiLanguageResponse, QueryServicesOptions, QueryServicesRequest, QueryServicesResponse, QueryServicesResponseNonNullableFields, QueryV2, QueryV2PagingMethodOneOf, RangeAggregation, RangeAggregationResult, RangeBucket, RangeResult, RangeResults, Rate, RateType, RecurringInterval, RecurringIntervalType, RecurringSessionSplit, RecurringSessionsUpdated, RemovedLocationSessionsAction, RemovedLocationSessionsActionActionOptionsOneOf, RequestedFields, ReschedulePolicy, ResolutionMethod, Resource, ResourceGroup, ResourceIds, ResourceNotification, ResourceNotificationEvent, ResourceStatus, ResourceType, ResourcesPolicy, RestoreInfo, Results, SaveCreditCardPolicy, ScalarAggregation, ScalarResult, ScalarType, Schedule, ScheduleCancelled, ScheduleCreated, ScheduleNotification, ScheduleNotificationEventOneOf, ScheduleStatus, ScheduleUnassignedFromUser, ScheduleUpdated, ScheduleWithSessions, SearchDetails, SearchServicesRequest, SearchServicesResponse, SearchServicesResponseNonNullableFields, SeoSchema, Service, ServiceAvailabilityConstraints, ServiceCreatedEnvelope, ServiceDeletedEnvelope, ServiceNonNullableFields, ServiceResource, ServiceResourceSelectionOneOf, ServiceType, ServiceUpdatedEnvelope, ServicesQueryBuilder, ServicesQueryResult, ServicesUrlsChanged, Session, SessionCancelled, SessionCreated, SessionType, SessionUpdated, SessionVersion, SetCustomSlugEvent, SetCustomSlugOptions, SetCustomSlugRequest, SetCustomSlugResponse, SetCustomSlugResponseNonNullableFields, SetServiceLocationsOptions, SetServiceLocationsRequest, SetServiceLocationsResponse, SetServiceLocationsResponseNonNullableFields, Settings, SiteCloned, SiteCreated, SitePropertiesEvent, SitePropertiesNotification, SitePropertiesOnScheduleCreation, Slug, SortDirection, SortOrder, SortType, Sorting, SpecialHourPeriod, SplitInterval, StaffData, StaffMediaItem, StaffMediaItemItemOneOf, StaffMember, StaffMemberDetails, Status, StreetAddress, Subdivision, SupportedLanguage, Tag, TimePeriod, Translation, Transparency, URLs, UpdateService, UpdateServiceRequest, UpdateServiceResponse, UpdateServiceResponseNonNullableFields, UserDomainInfoChangedEvent, V1SplitInterval, V2AvailabilityConstraints, V2Category, V2Location, V2LocationOptionsOneOf, V2ParticipantNotification, V2RequestedFields, V2Schedule, V4Address, ValidateServiceRequest, ValidateServiceResponse, ValidateSlugOptions, ValidateSlugRequest, ValidateSlugResponse, ValidateSlugResponseNonNullableFields, ValueAggregation, ValueAggregationOptionsOneOf, ValueAggregationResult, ValueResult, ValueResults, VariedPayment, Version, WaitlistPolicy, WebhookIdentityType, } from './bookings-services-v2-service-services.universal.js';
|