@wix/auto_sdk_bookings_services 1.0.264 → 1.0.266
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-DP1rt4uY.d.ts → bookings-services-v2-service-services.universal-BUP4OIa7.d.ts} +8 -25
- package/build/cjs/index.d.ts +10 -10
- package/build/cjs/index.js +5 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +5 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -12
- package/build/cjs/meta.js +7 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +0 -399
- package/build/cjs/schemas.js +19 -780
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{bookings-services-v2-service-services.universal-DP1rt4uY.d.mts → bookings-services-v2-service-services.universal-BUP4OIa7.d.mts} +8 -25
- package/build/es/index.d.mts +10 -10
- package/build/es/index.mjs +5 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +5 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1 -12
- package/build/es/meta.mjs +7 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +0 -399
- package/build/es/schemas.mjs +19 -780
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{bookings-services-v2-service-services.universal-BOPh4Nt0.d.ts → bookings-services-v2-service-services.universal-BluU4Y4M.d.ts} +647 -16
- package/build/internal/cjs/index.d.ts +10 -10
- package/build/internal/cjs/index.js +5 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +5 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +770 -3
- package/build/internal/cjs/meta.js +7 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +0 -399
- package/build/internal/cjs/schemas.js +19 -780
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{bookings-services-v2-service-services.universal-BOPh4Nt0.d.mts → bookings-services-v2-service-services.universal-BluU4Y4M.d.mts} +647 -16
- package/build/internal/es/index.d.mts +10 -10
- package/build/internal/es/index.mjs +5 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +5 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +770 -3
- package/build/internal/es/meta.mjs +7 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +0 -399
- package/build/internal/es/schemas.mjs +19 -780
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -114,8 +114,27 @@ interface Service {
|
|
|
114
114
|
* @format GUID
|
|
115
115
|
*/
|
|
116
116
|
staffMemberIds?: string[];
|
|
117
|
+
/**
|
|
118
|
+
* Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified.
|
|
119
|
+
* @internal
|
|
120
|
+
* @maxSize 220
|
|
121
|
+
* @readonly
|
|
122
|
+
* @deprecated Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified.
|
|
123
|
+
* @replacedBy staff_member_details.staff_members
|
|
124
|
+
* @targetRemovalDate 2025-01-01
|
|
125
|
+
*/
|
|
126
|
+
staffMembers?: StaffMember[];
|
|
117
127
|
/** Staff members details. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified. */
|
|
118
128
|
staffMemberDetails?: StaffMemberDetails;
|
|
129
|
+
/**
|
|
130
|
+
* Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named "rooms".
|
|
131
|
+
* @internal
|
|
132
|
+
* @maxSize 3
|
|
133
|
+
* @deprecated Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named "rooms".
|
|
134
|
+
* @replacedBy service_resources
|
|
135
|
+
* @targetRemovalDate 2024-08-19
|
|
136
|
+
*/
|
|
137
|
+
resourceGroups?: ResourceGroup[];
|
|
119
138
|
/**
|
|
120
139
|
* Information about which resources must be available so customers can book the service.
|
|
121
140
|
* For example, a meeting room or equipment.
|
|
@@ -176,6 +195,17 @@ interface Service {
|
|
|
176
195
|
addOnDetails?: AddOnDetails[];
|
|
177
196
|
/** Taxable address used to calculate tax */
|
|
178
197
|
taxableAddress?: TaxableAddress;
|
|
198
|
+
/**
|
|
199
|
+
* Phone call options for the service.
|
|
200
|
+
* @internal
|
|
201
|
+
*/
|
|
202
|
+
phoneCall?: V2PhoneCall;
|
|
203
|
+
/**
|
|
204
|
+
* Internal tags for the service. Used for signaling between platform components.
|
|
205
|
+
* @internal
|
|
206
|
+
* @maxSize 10
|
|
207
|
+
*/
|
|
208
|
+
tags?: string[];
|
|
179
209
|
/**
|
|
180
210
|
* ID of the [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction)
|
|
181
211
|
* that serves as the primary resource for this appointment service. The primary resource type
|
|
@@ -188,6 +218,18 @@ interface Service {
|
|
|
188
218
|
* @format GUID
|
|
189
219
|
*/
|
|
190
220
|
primaryResourceType?: string | null;
|
|
221
|
+
/**
|
|
222
|
+
* Whether to derive the service's locations from the locations of its assigned resources
|
|
223
|
+
* instead of using the service's own `locations` field.
|
|
224
|
+
*
|
|
225
|
+
* When `true`, the service is offered at every location where at least one of its
|
|
226
|
+
* assigned resources operates. This is useful for services where the bookable
|
|
227
|
+
* resource determines the location rather than the service itself.
|
|
228
|
+
*
|
|
229
|
+
* Default: `false`
|
|
230
|
+
* @internal
|
|
231
|
+
*/
|
|
232
|
+
inheritResourceLocations?: boolean | null;
|
|
191
233
|
}
|
|
192
234
|
declare enum ServiceType {
|
|
193
235
|
/** Appointment-based service. */
|
|
@@ -245,6 +287,11 @@ interface Form {
|
|
|
245
287
|
* @format GUID
|
|
246
288
|
*/
|
|
247
289
|
_id?: string;
|
|
290
|
+
/**
|
|
291
|
+
* Settings that apply to the service booking form on mobile clients.
|
|
292
|
+
* @internal
|
|
293
|
+
*/
|
|
294
|
+
mobileSettings?: FormSettings;
|
|
248
295
|
}
|
|
249
296
|
interface FormSettings {
|
|
250
297
|
/** Whether the service booking form should be hidden from the site. */
|
|
@@ -366,6 +413,11 @@ interface FixedPayment {
|
|
|
366
413
|
* Required when: `rateType` is `FIXED` and `paymentOptions.deposit` is `true`
|
|
367
414
|
*/
|
|
368
415
|
deposit?: Money;
|
|
416
|
+
/**
|
|
417
|
+
* Whether the price is a base price.
|
|
418
|
+
* @internal
|
|
419
|
+
*/
|
|
420
|
+
basePrice?: boolean | null;
|
|
369
421
|
/**
|
|
370
422
|
* Whether customers can choose to pay the full service price upfront instead of only the deposit.
|
|
371
423
|
*
|
|
@@ -703,6 +755,17 @@ interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
703
755
|
* @maxLength 512
|
|
704
756
|
*/
|
|
705
757
|
formatted?: string | null;
|
|
758
|
+
/**
|
|
759
|
+
* Coordinates of the physical address.
|
|
760
|
+
* @internal
|
|
761
|
+
*/
|
|
762
|
+
location?: CommonAddressLocation;
|
|
763
|
+
/**
|
|
764
|
+
* Free text to help find the address.
|
|
765
|
+
* @internal
|
|
766
|
+
* @maxLength 255
|
|
767
|
+
*/
|
|
768
|
+
hint?: string | null;
|
|
706
769
|
}
|
|
707
770
|
/** @oneof */
|
|
708
771
|
interface CommonAddressStreetOneOf {
|
|
@@ -813,6 +876,12 @@ interface BookingPolicy {
|
|
|
813
876
|
* @format GUID
|
|
814
877
|
*/
|
|
815
878
|
_id?: string;
|
|
879
|
+
/**
|
|
880
|
+
* Revision number, which increments by 1 each time the policy is updated. To prevent conflicting changes, the existing revision must be used when updating a policy. Can be empty after the service was cloned as part of site clone.
|
|
881
|
+
* @internal
|
|
882
|
+
* @readonly
|
|
883
|
+
*/
|
|
884
|
+
revision?: string | null;
|
|
816
885
|
/**
|
|
817
886
|
* Date and time the policy was created.
|
|
818
887
|
* @readonly
|
|
@@ -823,6 +892,13 @@ interface BookingPolicy {
|
|
|
823
892
|
* @readonly
|
|
824
893
|
*/
|
|
825
894
|
_updatedDate?: Date | null;
|
|
895
|
+
/**
|
|
896
|
+
* ID of the app that's associated with the service.
|
|
897
|
+
* @internal
|
|
898
|
+
* @format GUID
|
|
899
|
+
* @readonly
|
|
900
|
+
*/
|
|
901
|
+
appId?: string | null;
|
|
826
902
|
/**
|
|
827
903
|
* Name of the policy.
|
|
828
904
|
* @maxLength 400
|
|
@@ -889,6 +965,35 @@ interface BookingPolicy {
|
|
|
889
965
|
* @readonly
|
|
890
966
|
*/
|
|
891
967
|
saveCreditCardPolicy?: SaveCreditCardPolicy;
|
|
968
|
+
/**
|
|
969
|
+
* Rules for sorting staff.
|
|
970
|
+
* The sorting will affect which staff is chosen during the book flow, if needed.
|
|
971
|
+
* @internal
|
|
972
|
+
* @readonly
|
|
973
|
+
*/
|
|
974
|
+
staffSortingPolicy?: StaffSortingPolicy;
|
|
975
|
+
/**
|
|
976
|
+
* Rules for Intake form integration
|
|
977
|
+
* @internal
|
|
978
|
+
*/
|
|
979
|
+
intakeFormPolicy?: IntakeFormPolicy;
|
|
980
|
+
/**
|
|
981
|
+
* Whether the person making the booking can enter contact details for someone
|
|
982
|
+
* other than themselves, booking on another person's behalf.
|
|
983
|
+
*
|
|
984
|
+
* When `true`, the booking's contact details are taken from the standard
|
|
985
|
+
* booking form rather than assumed to be the booker's own. Applies to any
|
|
986
|
+
* booker, including site visitors who aren't logged-in members.
|
|
987
|
+
*
|
|
988
|
+
* Default: `false`.
|
|
989
|
+
* @internal
|
|
990
|
+
*/
|
|
991
|
+
bookForSomeoneElseAllowed?: boolean | null;
|
|
992
|
+
/**
|
|
993
|
+
* Rule restricting how frequently a customer can rebook the same service.
|
|
994
|
+
* @internal
|
|
995
|
+
*/
|
|
996
|
+
limitRebookingPolicy?: LimitRebookingPolicy;
|
|
892
997
|
}
|
|
893
998
|
/** A description of the policy to display to participants. */
|
|
894
999
|
interface PolicyDescription {
|
|
@@ -1070,6 +1175,15 @@ interface WaitlistPolicy {
|
|
|
1070
1175
|
}
|
|
1071
1176
|
/** The policy for the maximum number of participants per booking. */
|
|
1072
1177
|
interface ParticipantsPolicy {
|
|
1178
|
+
/**
|
|
1179
|
+
* Whether the maximum number of participants applies. When `false`, there is
|
|
1180
|
+
* no maximum.
|
|
1181
|
+
*
|
|
1182
|
+
* Default: `false`
|
|
1183
|
+
* Private because not limiting participants per booking is not supported by Bookings flows today
|
|
1184
|
+
* @internal
|
|
1185
|
+
*/
|
|
1186
|
+
enabled?: boolean;
|
|
1073
1187
|
/**
|
|
1074
1188
|
* Maximum number of participants allowed.
|
|
1075
1189
|
*
|
|
@@ -1078,6 +1192,19 @@ interface ParticipantsPolicy {
|
|
|
1078
1192
|
* @min 1
|
|
1079
1193
|
*/
|
|
1080
1194
|
maxParticipantsPerBooking?: number;
|
|
1195
|
+
/**
|
|
1196
|
+
* Whether the booking form is collected separately for each participant in the
|
|
1197
|
+
* booking, rather than only for the primary contact. When `true`, every
|
|
1198
|
+
* participant completes the form, capturing all of its fields for each of them.
|
|
1199
|
+
*
|
|
1200
|
+
* Only applies when the booking allows more than one participant
|
|
1201
|
+
* (`maxParticipantsPerBooking` is greater than `1`); ignored for
|
|
1202
|
+
* single-participant bookings.
|
|
1203
|
+
*
|
|
1204
|
+
* Default: `false`.
|
|
1205
|
+
* @internal
|
|
1206
|
+
*/
|
|
1207
|
+
collectParticipantForm?: boolean | null;
|
|
1081
1208
|
}
|
|
1082
1209
|
/** The policy regarding the allocation of resources (e.g. staff members). */
|
|
1083
1210
|
interface ResourcesPolicy {
|
|
@@ -1337,6 +1464,7 @@ interface AvailabilityConstraints {
|
|
|
1337
1464
|
* Use `durationRange` for services where the customer chooses how long to book,
|
|
1338
1465
|
* such as equipment or space rentals. The `unitType` determines whether the range
|
|
1339
1466
|
* is measured in hours or days.
|
|
1467
|
+
* @internal
|
|
1340
1468
|
*/
|
|
1341
1469
|
durationRange?: DurationRange;
|
|
1342
1470
|
/**
|
|
@@ -1470,11 +1598,36 @@ interface StaffMember {
|
|
|
1470
1598
|
* @readonly
|
|
1471
1599
|
*/
|
|
1472
1600
|
name?: string | null;
|
|
1601
|
+
/**
|
|
1602
|
+
* IDs of the staff member working hours schedules, can be used to retrieve schedule information using wix-bookings-backend schedules API.
|
|
1603
|
+
* @internal
|
|
1604
|
+
* @format GUID
|
|
1605
|
+
* @readonly
|
|
1606
|
+
* @maxSize 100
|
|
1607
|
+
*/
|
|
1608
|
+
workingHoursScheduleIds?: string[];
|
|
1609
|
+
/**
|
|
1610
|
+
* ID of the staff member events schedule, can be used to retrieve schedule information using wix-bookings-backend schedules API.
|
|
1611
|
+
* @internal
|
|
1612
|
+
* @format GUID
|
|
1613
|
+
* @readonly
|
|
1614
|
+
*/
|
|
1615
|
+
eventsScheduleId?: string | null;
|
|
1473
1616
|
/**
|
|
1474
1617
|
* Main media associated with the service.
|
|
1475
1618
|
* @readonly
|
|
1476
1619
|
*/
|
|
1477
1620
|
mainMedia?: StaffMediaItem;
|
|
1621
|
+
/**
|
|
1622
|
+
* Working hours location coverage for this staff member.
|
|
1623
|
+
* Returned on each entry in `staffMemberDetails.staff_members` when both `STAFF_MEMBER_DETAILS`
|
|
1624
|
+
* and `STAFF_WORKING_HOURS_LOCATIONS` are in `conditional_fields`.
|
|
1625
|
+
* Omitted when the staff member has no working-hours schedules.
|
|
1626
|
+
* If Calendar v3 is unavailable, the entire request fails.
|
|
1627
|
+
* @internal
|
|
1628
|
+
* @readonly
|
|
1629
|
+
*/
|
|
1630
|
+
workingHoursLocationCoverage?: WorkingHoursLocationCoverage;
|
|
1478
1631
|
}
|
|
1479
1632
|
interface StaffMediaItem extends StaffMediaItemItemOneOf {
|
|
1480
1633
|
/** Details of the image associated with the staff, such as URL and size. */
|
|
@@ -1505,6 +1658,22 @@ interface StaffMediaItemItemOneOf {
|
|
|
1505
1658
|
* Omitted when `STAFF_WORKING_HOURS_LOCATIONS` is not requested.
|
|
1506
1659
|
*/
|
|
1507
1660
|
interface WorkingHoursLocationCoverage {
|
|
1661
|
+
/**
|
|
1662
|
+
* Whether this staff member has working hours that apply to all business locations.
|
|
1663
|
+
* Always set to `true` or `false` when enrichment is requested.
|
|
1664
|
+
* @internal
|
|
1665
|
+
* @readonly
|
|
1666
|
+
*/
|
|
1667
|
+
availableAtAllLocations?: boolean | null;
|
|
1668
|
+
/**
|
|
1669
|
+
* Business location IDs where this staff member has location-specific WORKING_HOURS calendar events.
|
|
1670
|
+
* Ignored when `available_at_all_locations` is `true`.
|
|
1671
|
+
* @internal
|
|
1672
|
+
* @format GUID
|
|
1673
|
+
* @readonly
|
|
1674
|
+
* @maxSize 100
|
|
1675
|
+
*/
|
|
1676
|
+
locationIds?: string[];
|
|
1508
1677
|
}
|
|
1509
1678
|
interface StaffMemberDetails {
|
|
1510
1679
|
/**
|
|
@@ -1556,8 +1725,27 @@ interface ServiceResource extends ServiceResourceSelectionOneOf {
|
|
|
1556
1725
|
* When not set, all resources of the specified resource type are eligible.
|
|
1557
1726
|
*/
|
|
1558
1727
|
resourceIds?: ResourceIds;
|
|
1728
|
+
/**
|
|
1729
|
+
* The unique identifier for the service resource. If not specified, it defaults to the resource type ID.
|
|
1730
|
+
* @internal
|
|
1731
|
+
* @format GUID
|
|
1732
|
+
*/
|
|
1733
|
+
_id?: string | null;
|
|
1559
1734
|
/** Details about the required [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction). */
|
|
1560
1735
|
resourceType?: ResourceType;
|
|
1736
|
+
/**
|
|
1737
|
+
* The number of resources required to book the service. Defaults to 1.
|
|
1738
|
+
* @internal
|
|
1739
|
+
* @min 1
|
|
1740
|
+
*/
|
|
1741
|
+
requiredResourcesNumber?: number | null;
|
|
1742
|
+
/**
|
|
1743
|
+
* If set to `true`, the customer can select specific resources while booking the service.
|
|
1744
|
+
* If set to `false`, the resources required to book the service will be auto-selected at the time of booking. Defaults to false.
|
|
1745
|
+
* @internal
|
|
1746
|
+
* @readonly
|
|
1747
|
+
*/
|
|
1748
|
+
selectableResource?: boolean | null;
|
|
1561
1749
|
/**
|
|
1562
1750
|
* Details about the individual resources assigned to this service resource, including their names.
|
|
1563
1751
|
* Only returned when `RESOURCE_DETAILS` is passed in `conditionalFields`.
|
|
@@ -1845,6 +2033,19 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
1845
2033
|
* @targetRemovalDate 2026-03-31
|
|
1846
2034
|
*/
|
|
1847
2035
|
additionalFields?: CustomFormField[];
|
|
2036
|
+
/**
|
|
2037
|
+
* Number of participants.
|
|
2038
|
+
* @internal
|
|
2039
|
+
* @min 1
|
|
2040
|
+
*/
|
|
2041
|
+
numberOfParticipants?: number | null;
|
|
2042
|
+
/**
|
|
2043
|
+
* Internal business note.
|
|
2044
|
+
* @internal
|
|
2045
|
+
* @deprecated Internal business note.
|
|
2046
|
+
* @targetRemovalDate 2026-03-31
|
|
2047
|
+
*/
|
|
2048
|
+
internalBusinessNote?: string | null;
|
|
1848
2049
|
/**
|
|
1849
2050
|
* Booking status. A booking is automatically confirmed if the service allows it
|
|
1850
2051
|
* and an eCommerce order is created. It is automatically declined if there is a
|
|
@@ -1884,6 +2085,27 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
1884
2085
|
_createdDate?: Date | null;
|
|
1885
2086
|
/** External user ID that you can provide. */
|
|
1886
2087
|
externalUserId?: string | null;
|
|
2088
|
+
/**
|
|
2089
|
+
* Platform and app that created the booking.
|
|
2090
|
+
* @internal
|
|
2091
|
+
*/
|
|
2092
|
+
bookingSource?: BookingSource;
|
|
2093
|
+
/**
|
|
2094
|
+
* The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.
|
|
2095
|
+
* @internal
|
|
2096
|
+
* @deprecated The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.
|
|
2097
|
+
* @targetRemovalDate 2026-03-31
|
|
2098
|
+
*/
|
|
2099
|
+
participantNotification?: ParticipantNotification;
|
|
2100
|
+
/**
|
|
2101
|
+
* When `true`, an SMS reminder is sent to the phone number specified in
|
|
2102
|
+
* `contactDetails` 24 hours before the session starts.
|
|
2103
|
+
* @internal
|
|
2104
|
+
* @deprecated When `true`, an SMS reminder is sent to the phone number specified in
|
|
2105
|
+
* `contactDetails` 24 hours before the session starts.
|
|
2106
|
+
* @targetRemovalDate 2026-03-31
|
|
2107
|
+
*/
|
|
2108
|
+
sendSmsReminder?: boolean | null;
|
|
1887
2109
|
/**
|
|
1888
2110
|
* Revision number to be used when updating, rescheduling, or cancelling the booking.
|
|
1889
2111
|
* Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking.
|
|
@@ -1907,6 +2129,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
1907
2129
|
* @readonly
|
|
1908
2130
|
*/
|
|
1909
2131
|
endDate?: Date | null;
|
|
2132
|
+
/**
|
|
2133
|
+
* Settings that modify the standard booking flow.
|
|
2134
|
+
* Use these settings to override default business rules and policies when needed.
|
|
2135
|
+
* Make sure the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has the required permissions.
|
|
2136
|
+
* @internal
|
|
2137
|
+
*/
|
|
2138
|
+
flowControlSettings?: FlowControlSettings;
|
|
1910
2139
|
/**
|
|
1911
2140
|
* Date and time the booking was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1912
2141
|
* @readonly
|
|
@@ -1923,6 +2152,34 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
1923
2152
|
* @readonly
|
|
1924
2153
|
*/
|
|
1925
2154
|
doubleBooked?: boolean | null;
|
|
2155
|
+
/**
|
|
2156
|
+
* Whether this booking availability should be checked with v1 or v2.
|
|
2157
|
+
* @internal
|
|
2158
|
+
*/
|
|
2159
|
+
v2Availability?: boolean | null;
|
|
2160
|
+
/**
|
|
2161
|
+
* Multi-service booking info of which the booking is part of.
|
|
2162
|
+
* @internal
|
|
2163
|
+
* @readonly
|
|
2164
|
+
*/
|
|
2165
|
+
multiServiceBookingInfo?: MultiServiceBookingInfo;
|
|
2166
|
+
/**
|
|
2167
|
+
* The date this booking was canceled in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
2168
|
+
* @internal
|
|
2169
|
+
* @readonly
|
|
2170
|
+
*/
|
|
2171
|
+
canceledDate?: Date | null;
|
|
2172
|
+
/**
|
|
2173
|
+
* Whether this booking availability should be checked with v1 or v2.
|
|
2174
|
+
* @internal
|
|
2175
|
+
*/
|
|
2176
|
+
v2AvailabilityProxy?: boolean | null;
|
|
2177
|
+
/**
|
|
2178
|
+
* Indicates booking language. If empty, the booking was made using the main language.
|
|
2179
|
+
* @internal
|
|
2180
|
+
* @format LANGUAGE_TAG
|
|
2181
|
+
*/
|
|
2182
|
+
language?: string | null;
|
|
1926
2183
|
/**
|
|
1927
2184
|
* ID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction)
|
|
1928
2185
|
* associated with this booking.
|
|
@@ -1984,6 +2241,15 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
1984
2241
|
* When the service supports deposit payments and `fullUpfrontPaymentAllowed` is `true`, this field can be `true` or `false`.
|
|
1985
2242
|
*/
|
|
1986
2243
|
depositSelected?: boolean | null;
|
|
2244
|
+
/**
|
|
2245
|
+
* Whether the customer chose to pay the full subscription price upfront instead of recurring payments.
|
|
2246
|
+
*
|
|
2247
|
+
* Used only when the service's subscription payment has `fullUpfrontPayment.supported` set to `true`.
|
|
2248
|
+
*
|
|
2249
|
+
* Default: Not set (customer pays via recurring subscription).
|
|
2250
|
+
* @internal
|
|
2251
|
+
*/
|
|
2252
|
+
subscriptionUpfrontPaymentSelected?: boolean | null;
|
|
1987
2253
|
/**
|
|
1988
2254
|
* Whether the booking is scheduled to be canceled at the end of the current
|
|
1989
2255
|
* billing period.
|
|
@@ -2011,6 +2277,35 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
2011
2277
|
* @format GUID
|
|
2012
2278
|
*/
|
|
2013
2279
|
recurringGroupId?: string | null;
|
|
2280
|
+
/**
|
|
2281
|
+
* Whether this booking was made on behalf of another person by a logged-in member.
|
|
2282
|
+
*
|
|
2283
|
+
* When `true`, the booking's contact details refer to the person the booking is for —
|
|
2284
|
+
* typically sourced from the booking form's contact fields — rather than the
|
|
2285
|
+
* logged-in member or the eCommerce order's buyer.
|
|
2286
|
+
*
|
|
2287
|
+
* Default: `false`.
|
|
2288
|
+
* @internal
|
|
2289
|
+
*/
|
|
2290
|
+
bookedForSomeoneElse?: boolean | null;
|
|
2291
|
+
/**
|
|
2292
|
+
* Start of the booking adjusted to the requested timezone.
|
|
2293
|
+
* When `timeZone` is specified in the read request, the value is converted to that timezone.
|
|
2294
|
+
* Otherwise, the slot or schedule timezone is used.
|
|
2295
|
+
* See also `startDate` and `endDate`.
|
|
2296
|
+
* @internal
|
|
2297
|
+
* @readonly
|
|
2298
|
+
*/
|
|
2299
|
+
adjustedStart?: ZonedDate;
|
|
2300
|
+
/**
|
|
2301
|
+
* End of the booking adjusted to the requested timezone.
|
|
2302
|
+
* When `timeZone` is specified in the read request, the value is converted to that timezone.
|
|
2303
|
+
* Otherwise, the slot or schedule timezone is used.
|
|
2304
|
+
* See also `startDate` and `endDate`.
|
|
2305
|
+
* @internal
|
|
2306
|
+
* @readonly
|
|
2307
|
+
*/
|
|
2308
|
+
adjustedEnd?: ZonedDate;
|
|
2014
2309
|
}
|
|
2015
2310
|
/** @oneof */
|
|
2016
2311
|
interface BookingParticipantsInfoOneOf {
|
|
@@ -2083,6 +2378,13 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
2083
2378
|
* @maxLength 6000
|
|
2084
2379
|
*/
|
|
2085
2380
|
title?: string | null;
|
|
2381
|
+
/**
|
|
2382
|
+
* If the user made the booking in a secondary language, this field contains the translated title.
|
|
2383
|
+
* @internal
|
|
2384
|
+
* @readonly
|
|
2385
|
+
* @maxLength 400
|
|
2386
|
+
*/
|
|
2387
|
+
titleTranslated?: string | null;
|
|
2086
2388
|
/**
|
|
2087
2389
|
* List of tags for the booking.
|
|
2088
2390
|
*
|
|
@@ -2160,6 +2462,18 @@ interface BookedSlot {
|
|
|
2160
2462
|
resource?: BookedResource;
|
|
2161
2463
|
/** Location where the session takes place. */
|
|
2162
2464
|
location?: Location;
|
|
2465
|
+
/**
|
|
2466
|
+
* Phone call options for the service.
|
|
2467
|
+
* @internal
|
|
2468
|
+
* @readonly
|
|
2469
|
+
*/
|
|
2470
|
+
phoneCall?: PhoneCall;
|
|
2471
|
+
/**
|
|
2472
|
+
* [Non-primary resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking.
|
|
2473
|
+
* For example, a room, equipment, or an additional staff member.
|
|
2474
|
+
* @internal
|
|
2475
|
+
*/
|
|
2476
|
+
additionalResources?: BookedResource[];
|
|
2163
2477
|
/**
|
|
2164
2478
|
* Information about how the customer has selected resources for the booking.
|
|
2165
2479
|
* Each resource type may have a different selection method.
|
|
@@ -2208,6 +2522,13 @@ interface BookedResource {
|
|
|
2208
2522
|
* @maxLength 40
|
|
2209
2523
|
*/
|
|
2210
2524
|
name?: string | null;
|
|
2525
|
+
/**
|
|
2526
|
+
* Resource's name translated to the language the booking was made in.
|
|
2527
|
+
* @internal
|
|
2528
|
+
* @readonly
|
|
2529
|
+
* @maxLength 40
|
|
2530
|
+
*/
|
|
2531
|
+
nameTranslated?: string | null;
|
|
2211
2532
|
/**
|
|
2212
2533
|
* Resource's email at the time of booking.
|
|
2213
2534
|
* @maxLength 500
|
|
@@ -2218,6 +2539,15 @@ interface BookedResource {
|
|
|
2218
2539
|
* @format GUID
|
|
2219
2540
|
*/
|
|
2220
2541
|
scheduleId?: string | null;
|
|
2542
|
+
/**
|
|
2543
|
+
* Whether the customer specifically requested the resource or whether Wix Bookings randomly assigned a resource to the booking.
|
|
2544
|
+
*
|
|
2545
|
+
* - `true`: The customer specifically requested the resource.
|
|
2546
|
+
* - `false`: Wix Bookings randomly assigned a resource of the relevant type to the booking.
|
|
2547
|
+
* @internal
|
|
2548
|
+
* @readonly
|
|
2549
|
+
*/
|
|
2550
|
+
explicitlyRequested?: boolean | null;
|
|
2221
2551
|
/**
|
|
2222
2552
|
* ID of the [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction) associated with this resource.
|
|
2223
2553
|
* For example, `"1cd44cf8-756f-41c3-bd90-3e2ffcaf1155"` for a staff member resource type.
|
|
@@ -2225,6 +2555,17 @@ interface BookedResource {
|
|
|
2225
2555
|
* @readonly
|
|
2226
2556
|
*/
|
|
2227
2557
|
type?: string | null;
|
|
2558
|
+
/**
|
|
2559
|
+
* Specifies whether the resource's calendar is blocked for the duration of the booking.
|
|
2560
|
+
*
|
|
2561
|
+
* Supported values:
|
|
2562
|
+
* + `OPAQUE`: The schedule is blocked during the booking, preventing other bookings involving the same resource from being scheduled at the same time.
|
|
2563
|
+
* + `TRANSPARENT`: The schedule remains open during the booking, allowing other bookings to be scheduled concurrently.
|
|
2564
|
+
*
|
|
2565
|
+
* When not set or `UNKNOWN_TRANSPARENCY`, behaves as `OPAQUE`.
|
|
2566
|
+
* @internal
|
|
2567
|
+
*/
|
|
2568
|
+
transparency?: ResourceTransparencyWithLiterals;
|
|
2228
2569
|
}
|
|
2229
2570
|
declare enum ResourceTransparency {
|
|
2230
2571
|
OPAQUE = "OPAQUE",
|
|
@@ -2602,6 +2943,11 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
|
2602
2943
|
* @format GUID
|
|
2603
2944
|
*/
|
|
2604
2945
|
contactId?: string | null;
|
|
2946
|
+
/**
|
|
2947
|
+
* @internal
|
|
2948
|
+
* @readonly
|
|
2949
|
+
*/
|
|
2950
|
+
identityType?: IdentityTypeWithLiterals;
|
|
2605
2951
|
}
|
|
2606
2952
|
/** @oneof */
|
|
2607
2953
|
interface CommonIdentificationDataIdOneOf {
|
|
@@ -2649,6 +2995,19 @@ type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' |
|
|
|
2649
2995
|
* - Overriding cancellation or rescheduling policies in exceptional cases
|
|
2650
2996
|
*/
|
|
2651
2997
|
interface FlowControlSettings {
|
|
2998
|
+
/**
|
|
2999
|
+
* If `true`, skips the service defined booking-window in the booking policy.
|
|
3000
|
+
* Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.
|
|
3001
|
+
* Private because it is confusing to external users - collides with `skipAvailabilityValidation`.
|
|
3002
|
+
* When removing, use proto's `reserved` field.
|
|
3003
|
+
* @internal
|
|
3004
|
+
* @deprecated If `true`, skips the service defined booking-window in the booking policy.
|
|
3005
|
+
* Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.
|
|
3006
|
+
* Private because it is confusing to external users - collides with `skipAvailabilityValidation`.
|
|
3007
|
+
* When removing, use proto's `reserved` field.
|
|
3008
|
+
* @targetRemovalDate 2026-03-31
|
|
3009
|
+
*/
|
|
3010
|
+
ignoreBookingWindow?: boolean;
|
|
2652
3011
|
/** Whether availability is checked when creating or confirming the booking. */
|
|
2653
3012
|
skipAvailabilityValidation?: boolean;
|
|
2654
3013
|
/**
|
|
@@ -2676,6 +3035,16 @@ interface FlowControlSettings {
|
|
|
2676
3035
|
* Default: `false`.
|
|
2677
3036
|
*/
|
|
2678
3037
|
skipAddOnValidation?: boolean | null;
|
|
3038
|
+
/**
|
|
3039
|
+
* Whether the orders flow was skipped for this booking.
|
|
3040
|
+
*
|
|
3041
|
+
* When `true`, indicates this booking bypassed the standard eCommerce orders flow,
|
|
3042
|
+
* for non-chargeable services.
|
|
3043
|
+
*
|
|
3044
|
+
* Default: `false`.
|
|
3045
|
+
* @internal
|
|
3046
|
+
*/
|
|
3047
|
+
skipOrderConfirmation?: boolean | null;
|
|
2679
3048
|
}
|
|
2680
3049
|
interface ParticipantChoices {
|
|
2681
3050
|
/**
|
|
@@ -2723,6 +3092,14 @@ interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
2723
3092
|
* @format GUID
|
|
2724
3093
|
*/
|
|
2725
3094
|
optionId?: string;
|
|
3095
|
+
/**
|
|
3096
|
+
* ID of the service choice.
|
|
3097
|
+
* If this is provided, the oneof above will be enriched (readOnly essentially)
|
|
3098
|
+
* In pricing this is required. In Bookings, this is optional.
|
|
3099
|
+
* @internal
|
|
3100
|
+
* @format GUID
|
|
3101
|
+
*/
|
|
3102
|
+
choiceId?: string | null;
|
|
2726
3103
|
}
|
|
2727
3104
|
/** @oneof */
|
|
2728
3105
|
interface ServiceChoiceChoiceOneOf {
|
|
@@ -3036,6 +3413,12 @@ interface BulkCreateServicesRequest {
|
|
|
3036
3413
|
services: Service[];
|
|
3037
3414
|
/** Whether to return the created service objects. */
|
|
3038
3415
|
returnEntity?: boolean;
|
|
3416
|
+
/**
|
|
3417
|
+
* Used to provision services from V1, Should be removed
|
|
3418
|
+
* when deprecating services V1
|
|
3419
|
+
* @internal
|
|
3420
|
+
*/
|
|
3421
|
+
skipScheduleCreation?: boolean;
|
|
3039
3422
|
}
|
|
3040
3423
|
interface BulkCreateServicesResponse {
|
|
3041
3424
|
/** The result of each service creation. */
|
|
@@ -3089,6 +3472,12 @@ interface GetServiceRequest {
|
|
|
3089
3472
|
* @maxSize 5
|
|
3090
3473
|
*/
|
|
3091
3474
|
conditionalFields?: V2RequestedFieldsWithLiterals[];
|
|
3475
|
+
/**
|
|
3476
|
+
* Whether to perform an eventually consistent call using
|
|
3477
|
+
* catalog reader (only for dbV1)
|
|
3478
|
+
* @internal
|
|
3479
|
+
*/
|
|
3480
|
+
eventuallyConsistent?: boolean | null;
|
|
3092
3481
|
}
|
|
3093
3482
|
declare enum V2RequestedFields {
|
|
3094
3483
|
/** When passed, `service.staffMemberDetails` is returned. */
|
|
@@ -3097,6 +3486,16 @@ declare enum V2RequestedFields {
|
|
|
3097
3486
|
RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS",
|
|
3098
3487
|
/** When passed, `service.payment.discountInfo` is returned. */
|
|
3099
3488
|
DISCOUNT_INFO_DETAILS = "DISCOUNT_INFO_DETAILS",
|
|
3489
|
+
/**
|
|
3490
|
+
* Requires `STAFF_MEMBER_DETAILS`. Returns each staff member's working-hours location coverage at
|
|
3491
|
+
* `staffMemberDetails.staffMembers[].workingHoursLocationCoverage` for filtering staff by business location.
|
|
3492
|
+
* Coverage is derived from Calendar v3 WORKING_HOURS events (`NONE` and `MASTER` recurrence types),
|
|
3493
|
+
* fetched with cursor pagination (100 events per page).
|
|
3494
|
+
* If Calendar v3 is unavailable, the request fails.
|
|
3495
|
+
* @documentationMaturity preview
|
|
3496
|
+
* @internal
|
|
3497
|
+
*/
|
|
3498
|
+
STAFF_WORKING_HOURS_LOCATIONS = "STAFF_WORKING_HOURS_LOCATIONS",
|
|
3100
3499
|
/**
|
|
3101
3500
|
* Returns details about each individual resource assigned to a service resource, including the resource name. See `serviceResources.resourceDetails`.
|
|
3102
3501
|
* @documentationMaturity preview
|
|
@@ -3183,6 +3582,11 @@ interface SplitInterval {
|
|
|
3183
3582
|
interface UpdateServiceRequest {
|
|
3184
3583
|
/** Service to update. */
|
|
3185
3584
|
service: Service;
|
|
3585
|
+
/**
|
|
3586
|
+
* Explicit list of fields to update.
|
|
3587
|
+
* @internal
|
|
3588
|
+
*/
|
|
3589
|
+
mask?: string[];
|
|
3186
3590
|
}
|
|
3187
3591
|
interface UpdateServiceResponse {
|
|
3188
3592
|
/** Updated service. */
|
|
@@ -3196,6 +3600,11 @@ interface BulkUpdateServicesRequest {
|
|
|
3196
3600
|
services?: MaskedService[];
|
|
3197
3601
|
/** Whether to include the updated services in the response. Default: `false` */
|
|
3198
3602
|
returnEntity?: boolean;
|
|
3603
|
+
/**
|
|
3604
|
+
* When true, uses the currency from the services parameter instead of preserving the existing service's currency. Default: `false`
|
|
3605
|
+
* @internal
|
|
3606
|
+
*/
|
|
3607
|
+
overrideCurrency?: boolean;
|
|
3199
3608
|
}
|
|
3200
3609
|
interface MaskedService {
|
|
3201
3610
|
/** Service to update. */
|
|
@@ -3214,6 +3623,11 @@ interface BulkUpdateServicesByFilterRequest {
|
|
|
3214
3623
|
filter: Record<string, any> | null;
|
|
3215
3624
|
/** Service to update. */
|
|
3216
3625
|
service: Service;
|
|
3626
|
+
/**
|
|
3627
|
+
* Explicit list of fields to update.
|
|
3628
|
+
* @internal
|
|
3629
|
+
*/
|
|
3630
|
+
mask?: string[];
|
|
3217
3631
|
}
|
|
3218
3632
|
interface BulkUpdateServicesByFilterResponse {
|
|
3219
3633
|
/**
|
|
@@ -3332,10 +3746,21 @@ interface QueryServicesRequest {
|
|
|
3332
3746
|
* @maxSize 5
|
|
3333
3747
|
*/
|
|
3334
3748
|
conditionalFields?: V2RequestedFieldsWithLiterals[];
|
|
3749
|
+
/**
|
|
3750
|
+
* Whether to perform an eventually consistent call using
|
|
3751
|
+
* catalog reader (only for dbV1)
|
|
3752
|
+
* @internal
|
|
3753
|
+
*/
|
|
3754
|
+
eventuallyConsistent?: boolean | null;
|
|
3335
3755
|
}
|
|
3336
3756
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
3337
3757
|
/** Paging options to limit and skip the number of items. */
|
|
3338
3758
|
paging?: Paging;
|
|
3759
|
+
/**
|
|
3760
|
+
* Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
|
|
3761
|
+
* @internal
|
|
3762
|
+
*/
|
|
3763
|
+
cursorPaging?: CursorPaging;
|
|
3339
3764
|
/**
|
|
3340
3765
|
* Filter object in the following format:
|
|
3341
3766
|
*
|
|
@@ -3358,11 +3783,30 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
3358
3783
|
* @maxSize 50
|
|
3359
3784
|
*/
|
|
3360
3785
|
sort?: Sorting[];
|
|
3786
|
+
/**
|
|
3787
|
+
* Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
|
|
3788
|
+
* @internal
|
|
3789
|
+
* @maxLength 200
|
|
3790
|
+
* @maxSize 50
|
|
3791
|
+
*/
|
|
3792
|
+
fields?: string[];
|
|
3793
|
+
/**
|
|
3794
|
+
* Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
|
|
3795
|
+
* @internal
|
|
3796
|
+
* @maxLength 100
|
|
3797
|
+
* @maxSize 50
|
|
3798
|
+
*/
|
|
3799
|
+
fieldsets?: string[];
|
|
3361
3800
|
}
|
|
3362
3801
|
/** @oneof */
|
|
3363
3802
|
interface QueryV2PagingMethodOneOf {
|
|
3364
3803
|
/** Paging options to limit and skip the number of items. */
|
|
3365
3804
|
paging?: Paging;
|
|
3805
|
+
/**
|
|
3806
|
+
* Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
|
|
3807
|
+
* @internal
|
|
3808
|
+
*/
|
|
3809
|
+
cursorPaging?: CursorPaging;
|
|
3366
3810
|
}
|
|
3367
3811
|
interface Sorting {
|
|
3368
3812
|
/**
|
|
@@ -3418,6 +3862,13 @@ interface PagingMetadataV2 {
|
|
|
3418
3862
|
tooManyToCount?: boolean | null;
|
|
3419
3863
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3420
3864
|
cursors?: Cursors;
|
|
3865
|
+
/**
|
|
3866
|
+
* Indicates if there are more results after the current page.
|
|
3867
|
+
* If `true`, another page of results can be retrieved.
|
|
3868
|
+
* If `false`, this is the last page.
|
|
3869
|
+
* @internal
|
|
3870
|
+
*/
|
|
3871
|
+
hasNext?: boolean | null;
|
|
3421
3872
|
}
|
|
3422
3873
|
interface Cursors {
|
|
3423
3874
|
/**
|
|
@@ -3570,7 +4021,17 @@ declare enum ScalarType {
|
|
|
3570
4021
|
/** Minimum value. */
|
|
3571
4022
|
MIN = "MIN",
|
|
3572
4023
|
/** Maximum value. */
|
|
3573
|
-
MAX = "MAX"
|
|
4024
|
+
MAX = "MAX",
|
|
4025
|
+
/**
|
|
4026
|
+
* Sum of values.
|
|
4027
|
+
* @internal
|
|
4028
|
+
*/
|
|
4029
|
+
SUM = "SUM",
|
|
4030
|
+
/**
|
|
4031
|
+
* Average of values.
|
|
4032
|
+
* @internal
|
|
4033
|
+
*/
|
|
4034
|
+
AVG = "AVG"
|
|
3574
4035
|
}
|
|
3575
4036
|
/** @enumType */
|
|
3576
4037
|
type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
@@ -4058,6 +4519,30 @@ interface QueryPoliciesResponse {
|
|
|
4058
4519
|
interface BookingPolicyWithServices {
|
|
4059
4520
|
/** Retrieved booking policy. */
|
|
4060
4521
|
bookingPolicy?: BookingPolicy;
|
|
4522
|
+
/**
|
|
4523
|
+
* The services connected to the booking policy. Up to 5 services are returned per policy.
|
|
4524
|
+
* @internal
|
|
4525
|
+
* @maxSize 5
|
|
4526
|
+
* @deprecated The services connected to the booking policy. Up to 5 services are returned per policy.
|
|
4527
|
+
* @replacedBy connected_services
|
|
4528
|
+
* @targetRemovalDate 2025-03-01
|
|
4529
|
+
*/
|
|
4530
|
+
services?: Service[];
|
|
4531
|
+
/**
|
|
4532
|
+
* Whether there are more services associated with the booking policy.
|
|
4533
|
+
* @internal
|
|
4534
|
+
* @deprecated Whether there are more services associated with the booking policy.
|
|
4535
|
+
* @targetRemovalDate 2025-03-01
|
|
4536
|
+
*/
|
|
4537
|
+
hasMoreServices?: boolean | null;
|
|
4538
|
+
/**
|
|
4539
|
+
* The number of services connected to the booking policy.
|
|
4540
|
+
* @internal
|
|
4541
|
+
* @deprecated The number of services connected to the booking policy.
|
|
4542
|
+
* @replacedBy total_service_count
|
|
4543
|
+
* @targetRemovalDate 2025-03-01
|
|
4544
|
+
*/
|
|
4545
|
+
countOfServices?: number;
|
|
4061
4546
|
/**
|
|
4062
4547
|
* Up to 5 services connected to the booking policy. If `totalServiceCount` is
|
|
4063
4548
|
* greater than 5, there are additional services connected to the policy.
|
|
@@ -4230,6 +4715,12 @@ interface QueryCategoriesResponse {
|
|
|
4230
4715
|
interface QueryServicesMultiLanguageRequest {
|
|
4231
4716
|
/** WQL expression. */
|
|
4232
4717
|
query?: QueryV2;
|
|
4718
|
+
/**
|
|
4719
|
+
* Conditional fields to return.
|
|
4720
|
+
* @internal
|
|
4721
|
+
* @maxSize 5
|
|
4722
|
+
*/
|
|
4723
|
+
conditionalFields?: V2RequestedFieldsWithLiterals[];
|
|
4233
4724
|
}
|
|
4234
4725
|
interface QueryServicesMultiLanguageResponse {
|
|
4235
4726
|
/** The retrieved services in the main language */
|
|
@@ -4312,6 +4803,14 @@ interface EnablePricingPlansForServiceRequest {
|
|
|
4312
4803
|
* @maxSize 100
|
|
4313
4804
|
*/
|
|
4314
4805
|
pricingPlanIds: string[];
|
|
4806
|
+
/**
|
|
4807
|
+
* Explicit pricing plan selections with required per-plan benefit selection.
|
|
4808
|
+
* Allows fine-grained control over which benefits to connect for each plan.
|
|
4809
|
+
* Each selection must specify at least one benefit ID.
|
|
4810
|
+
* @internal
|
|
4811
|
+
* @maxSize 10
|
|
4812
|
+
*/
|
|
4813
|
+
pricingPlanSelections?: PricingPlanSelection[];
|
|
4315
4814
|
}
|
|
4316
4815
|
/** Pricing plan selection with required benefit IDs. */
|
|
4317
4816
|
interface PricingPlanSelection {
|
|
@@ -4362,6 +4861,14 @@ interface DisablePricingPlansForServiceRequest {
|
|
|
4362
4861
|
* @maxSize 75
|
|
4363
4862
|
*/
|
|
4364
4863
|
pricingPlanIds?: string[];
|
|
4864
|
+
/**
|
|
4865
|
+
* Explicit pricing plan selections with required per-plan benefit selection.
|
|
4866
|
+
* Allows fine-grained control over which benefits to disconnect for each plan.
|
|
4867
|
+
* Each selection must specify at least one benefit ID.
|
|
4868
|
+
* @internal
|
|
4869
|
+
* @maxSize 10
|
|
4870
|
+
*/
|
|
4871
|
+
pricingPlanSelections?: PricingPlanSelection[];
|
|
4365
4872
|
}
|
|
4366
4873
|
interface DisablePricingPlansForServiceResponse {
|
|
4367
4874
|
/** Updated service. */
|
|
@@ -4373,6 +4880,15 @@ interface SetCustomSlugRequest {
|
|
|
4373
4880
|
* @format GUID
|
|
4374
4881
|
*/
|
|
4375
4882
|
serviceId: string;
|
|
4883
|
+
/**
|
|
4884
|
+
* The custom name to set as the active slug for the service.
|
|
4885
|
+
* @internal
|
|
4886
|
+
* @maxLength 500
|
|
4887
|
+
* @deprecated The custom name to set as the active slug for the service.
|
|
4888
|
+
* @replacedBy slug
|
|
4889
|
+
* @targetRemovalDate 2025-03-01
|
|
4890
|
+
*/
|
|
4891
|
+
slugName?: string;
|
|
4376
4892
|
/**
|
|
4377
4893
|
* Slug to set as the active service slug.
|
|
4378
4894
|
* @maxLength 500
|
|
@@ -4391,6 +4907,15 @@ interface ValidateSlugRequest {
|
|
|
4391
4907
|
* @format GUID
|
|
4392
4908
|
*/
|
|
4393
4909
|
serviceId: string;
|
|
4910
|
+
/**
|
|
4911
|
+
* The custom name to validate as a slug for the service.
|
|
4912
|
+
* @internal
|
|
4913
|
+
* @maxLength 500
|
|
4914
|
+
* @deprecated The custom name to validate as a slug for the service.
|
|
4915
|
+
* @replacedBy slug
|
|
4916
|
+
* @targetRemovalDate 2025-03-01
|
|
4917
|
+
*/
|
|
4918
|
+
slugName?: string;
|
|
4394
4919
|
/**
|
|
4395
4920
|
* Custom slug to validate.
|
|
4396
4921
|
* @maxLength 500
|
|
@@ -4400,6 +4925,19 @@ interface ValidateSlugRequest {
|
|
|
4400
4925
|
interface ValidateSlugResponse {
|
|
4401
4926
|
/** Whether the slug is valid. */
|
|
4402
4927
|
valid?: boolean;
|
|
4928
|
+
/**
|
|
4929
|
+
* The requested custom slug name to validate. If valid, the slug name can
|
|
4930
|
+
* be set as a slug for the service and is populated with the requested
|
|
4931
|
+
* slug. Otherwise, `slugName` is empty.
|
|
4932
|
+
* @internal
|
|
4933
|
+
* @maxLength 500
|
|
4934
|
+
* @deprecated The requested custom slug name to validate. If valid, the slug name can
|
|
4935
|
+
* be set as a slug for the service and is populated with the requested
|
|
4936
|
+
* slug. Otherwise, `slugName` is empty.
|
|
4937
|
+
* @replacedBy slug
|
|
4938
|
+
* @targetRemovalDate 2025-03-01
|
|
4939
|
+
*/
|
|
4940
|
+
slugName?: string | null;
|
|
4403
4941
|
/**
|
|
4404
4942
|
* Valid slug. Available only if `{"valid": true}`.
|
|
4405
4943
|
* @maxLength 500
|
|
@@ -4425,6 +4963,35 @@ interface CloneServiceRequest {
|
|
|
4425
4963
|
* @format GUID
|
|
4426
4964
|
*/
|
|
4427
4965
|
sourceServiceId: string;
|
|
4966
|
+
/**
|
|
4967
|
+
* Whether to copy future recurring [events](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction)
|
|
4968
|
+
* belonging to the service's active schedule. Relevant only for classes and
|
|
4969
|
+
* courses.
|
|
4970
|
+
* @internal
|
|
4971
|
+
*/
|
|
4972
|
+
copyRecurringSessions?: boolean;
|
|
4973
|
+
/**
|
|
4974
|
+
* Whether to copy the original service's `payment.pricingPlanIds` array.
|
|
4975
|
+
* A maximum of 120 pricing plans is copied.
|
|
4976
|
+
* @internal
|
|
4977
|
+
*/
|
|
4978
|
+
copyPricingPlans?: boolean;
|
|
4979
|
+
/**
|
|
4980
|
+
* Whether to hide the cloned service from customers. Specifying an
|
|
4981
|
+
* empty value means that the original service's `hidden` value is used.
|
|
4982
|
+
* @internal
|
|
4983
|
+
*/
|
|
4984
|
+
hideService?: boolean | null;
|
|
4985
|
+
/**
|
|
4986
|
+
* Name of the cloned service.
|
|
4987
|
+
* The `title` of cloned service's active [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction)
|
|
4988
|
+
* is also set to this name.
|
|
4989
|
+
* The default name and schedule title of the cloned service are exact matches
|
|
4990
|
+
* of the corresponding fields from the service to clone.
|
|
4991
|
+
* @internal
|
|
4992
|
+
* @maxLength 400
|
|
4993
|
+
*/
|
|
4994
|
+
cloneServiceName?: string | null;
|
|
4428
4995
|
}
|
|
4429
4996
|
interface CloneServiceResponse {
|
|
4430
4997
|
/** Cloned service. */
|
|
@@ -4437,10 +5004,21 @@ interface CloneServiceResponse {
|
|
|
4437
5004
|
errors?: CloneErrorsWithLiterals[];
|
|
4438
5005
|
}
|
|
4439
5006
|
declare enum CloneErrors {
|
|
5007
|
+
/**
|
|
5008
|
+
* Failed to clone sessions belonging to the original service's active
|
|
5009
|
+
* schedule.
|
|
5010
|
+
* @internal
|
|
5011
|
+
*/
|
|
5012
|
+
SESSIONS = "SESSIONS",
|
|
4440
5013
|
/** 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). */
|
|
4441
5014
|
OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
|
|
4442
5015
|
/** Failed to clone the original service's *booking form*. */
|
|
4443
|
-
FORM = "FORM"
|
|
5016
|
+
FORM = "FORM",
|
|
5017
|
+
/**
|
|
5018
|
+
* Failed to add [pricing plans](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) as supported payment methods for the cloned service.
|
|
5019
|
+
* @internal
|
|
5020
|
+
*/
|
|
5021
|
+
PRICING_PLANS = "PRICING_PLANS"
|
|
4444
5022
|
}
|
|
4445
5023
|
/** @enumType */
|
|
4446
5024
|
type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
|
|
@@ -4462,6 +5040,12 @@ interface Category {
|
|
|
4462
5040
|
* @maxLength 500
|
|
4463
5041
|
*/
|
|
4464
5042
|
name?: string | null;
|
|
5043
|
+
/**
|
|
5044
|
+
* Custom properties that can be associated with the category.
|
|
5045
|
+
* @internal
|
|
5046
|
+
* @maxSize 256
|
|
5047
|
+
*/
|
|
5048
|
+
customProperties?: Record<string, string>;
|
|
4465
5049
|
/**
|
|
4466
5050
|
* Category status.
|
|
4467
5051
|
*
|
|
@@ -4871,6 +5455,11 @@ interface DeleteAddOnGroupResponse {
|
|
|
4871
5455
|
interface UpdateAddOnGroupRequest {
|
|
4872
5456
|
/** Add-on group to update. */
|
|
4873
5457
|
addOnGroup: AddOnGroup;
|
|
5458
|
+
/**
|
|
5459
|
+
* Explicit list of fields to update.
|
|
5460
|
+
* @internal
|
|
5461
|
+
*/
|
|
5462
|
+
mask?: string[];
|
|
4874
5463
|
/**
|
|
4875
5464
|
* ID of the service that contains the add-on group.
|
|
4876
5465
|
* @format GUID
|
|
@@ -5201,8 +5790,6 @@ interface ServiceCreatedEnvelope {
|
|
|
5201
5790
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
5202
5791
|
* @permissionScope Manage Bookings Services and Settings
|
|
5203
5792
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
5204
|
-
* @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
|
|
5205
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
5206
5793
|
* @permissionScope Manage Events
|
|
5207
5794
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
5208
5795
|
* @permissionScope Manage Bookings
|
|
@@ -5233,8 +5820,6 @@ interface ServiceDeletedEnvelope {
|
|
|
5233
5820
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
5234
5821
|
* @permissionScope Manage Bookings Services and Settings
|
|
5235
5822
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
5236
|
-
* @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
|
|
5237
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
5238
5823
|
* @permissionScope Manage Events
|
|
5239
5824
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
5240
5825
|
* @permissionScope Manage Bookings
|
|
@@ -5267,8 +5852,6 @@ interface ServiceUpdatedEnvelope {
|
|
|
5267
5852
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
5268
5853
|
* @permissionScope Manage Bookings Services and Settings
|
|
5269
5854
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
5270
|
-
* @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
|
|
5271
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
5272
5855
|
* @permissionScope Manage Events
|
|
5273
5856
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
5274
5857
|
* @permissionScope Manage Bookings
|
|
@@ -5399,7 +5982,7 @@ declare function onServiceUpdated(handler: (event: ServiceUpdatedEnvelope) => vo
|
|
|
5399
5982
|
* @returns Created service.
|
|
5400
5983
|
* @fqn wix.bookings.services.v2.ServicesService.CreateService
|
|
5401
5984
|
*/
|
|
5402
|
-
declare function createService(service: Service): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `
|
|
5985
|
+
declare function createService(service: Service): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `staffMemberIds` | `staffMemberDetails.staffMembers` | `staffMemberDetails.staffMembers.${number}.staffMemberId` | `serviceResources` | `supportedSlugs` | `supportedSlugs.${number}.name` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `addOnGroups` | `addOnDetails` | `taxableAddress.taxableAddressType`, 6> & {
|
|
5403
5986
|
__validationErrorsType?: CreateServiceValidationErrors;
|
|
5404
5987
|
}>;
|
|
5405
5988
|
/**
|
|
@@ -5443,7 +6026,7 @@ interface BulkCreateServicesOptions {
|
|
|
5443
6026
|
* @returns Retrieved service.
|
|
5444
6027
|
* @fqn wix.bookings.services.v2.ServicesService.GetService
|
|
5445
6028
|
*/
|
|
5446
|
-
declare function getService(serviceId: string, options?: GetServiceOptions): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `
|
|
6029
|
+
declare function getService(serviceId: string, options?: GetServiceOptions): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `staffMemberIds` | `staffMemberDetails.staffMembers` | `staffMemberDetails.staffMembers.${number}.staffMemberId` | `serviceResources` | `supportedSlugs` | `supportedSlugs.${number}.name` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `addOnGroups` | `addOnDetails` | `taxableAddress.taxableAddressType`, 6>>;
|
|
5447
6030
|
interface GetServiceOptions {
|
|
5448
6031
|
/**
|
|
5449
6032
|
* Conditional fields to return.
|
|
@@ -5486,7 +6069,7 @@ interface GetServiceOptions {
|
|
|
5486
6069
|
* @returns Updated service.
|
|
5487
6070
|
* @fqn wix.bookings.services.v2.ServicesService.UpdateService
|
|
5488
6071
|
*/
|
|
5489
|
-
declare function updateService(_id: string, service: NonNullablePaths<UpdateService, `revision`, 2>): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `
|
|
6072
|
+
declare function updateService(_id: string, service: NonNullablePaths<UpdateService, `revision`, 2>): Promise<NonNullablePaths<Service, `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.subscription.frequency` | `payment.subscription.firstChargeDate` | `payment.rateType` | `payment.pricingPlanIds` | `payment.addOnOption` | `payment.discountInfo.discountName` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `staffMemberIds` | `staffMemberDetails.staffMembers` | `staffMemberDetails.staffMembers.${number}.staffMemberId` | `serviceResources` | `supportedSlugs` | `supportedSlugs.${number}.name` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `addOnGroups` | `addOnDetails` | `taxableAddress.taxableAddressType`, 6> & {
|
|
5490
6073
|
__validationErrorsType?: UpdateServiceValidationErrors;
|
|
5491
6074
|
}>;
|
|
5492
6075
|
interface UpdateService {
|
|
@@ -5601,8 +6184,27 @@ interface UpdateService {
|
|
|
5601
6184
|
* @format GUID
|
|
5602
6185
|
*/
|
|
5603
6186
|
staffMemberIds?: string[];
|
|
6187
|
+
/**
|
|
6188
|
+
* Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified.
|
|
6189
|
+
* @internal
|
|
6190
|
+
* @maxSize 220
|
|
6191
|
+
* @readonly
|
|
6192
|
+
* @deprecated Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified.
|
|
6193
|
+
* @replacedBy staff_member_details.staff_members
|
|
6194
|
+
* @targetRemovalDate 2025-01-01
|
|
6195
|
+
*/
|
|
6196
|
+
staffMembers?: StaffMember[];
|
|
5604
6197
|
/** Staff members details. Returned only if `STAFF_MEMBER_DETAILS` conditional field was specified. */
|
|
5605
6198
|
staffMemberDetails?: StaffMemberDetails;
|
|
6199
|
+
/**
|
|
6200
|
+
* Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named "rooms".
|
|
6201
|
+
* @internal
|
|
6202
|
+
* @maxSize 3
|
|
6203
|
+
* @deprecated Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named "rooms".
|
|
6204
|
+
* @replacedBy service_resources
|
|
6205
|
+
* @targetRemovalDate 2024-08-19
|
|
6206
|
+
*/
|
|
6207
|
+
resourceGroups?: ResourceGroup[];
|
|
5606
6208
|
/**
|
|
5607
6209
|
* Information about which resources must be available so customers can book the service.
|
|
5608
6210
|
* For example, a meeting room or equipment.
|
|
@@ -5663,6 +6265,17 @@ interface UpdateService {
|
|
|
5663
6265
|
addOnDetails?: AddOnDetails[];
|
|
5664
6266
|
/** Taxable address used to calculate tax */
|
|
5665
6267
|
taxableAddress?: TaxableAddress;
|
|
6268
|
+
/**
|
|
6269
|
+
* Phone call options for the service.
|
|
6270
|
+
* @internal
|
|
6271
|
+
*/
|
|
6272
|
+
phoneCall?: V2PhoneCall;
|
|
6273
|
+
/**
|
|
6274
|
+
* Internal tags for the service. Used for signaling between platform components.
|
|
6275
|
+
* @internal
|
|
6276
|
+
* @maxSize 10
|
|
6277
|
+
*/
|
|
6278
|
+
tags?: string[];
|
|
5666
6279
|
/**
|
|
5667
6280
|
* ID of the [resource type](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction)
|
|
5668
6281
|
* that serves as the primary resource for this appointment service. The primary resource type
|
|
@@ -5675,6 +6288,18 @@ interface UpdateService {
|
|
|
5675
6288
|
* @format GUID
|
|
5676
6289
|
*/
|
|
5677
6290
|
primaryResourceType?: string | null;
|
|
6291
|
+
/**
|
|
6292
|
+
* Whether to derive the service's locations from the locations of its assigned resources
|
|
6293
|
+
* instead of using the service's own `locations` field.
|
|
6294
|
+
*
|
|
6295
|
+
* When `true`, the service is offered at every location where at least one of its
|
|
6296
|
+
* assigned resources operates. This is useful for services where the bookable
|
|
6297
|
+
* resource determines the location rather than the service itself.
|
|
6298
|
+
*
|
|
6299
|
+
* Default: `false`
|
|
6300
|
+
* @internal
|
|
6301
|
+
*/
|
|
6302
|
+
inheritResourceLocations?: boolean | null;
|
|
5678
6303
|
}
|
|
5679
6304
|
/**
|
|
5680
6305
|
* Updates up to 100 services.
|
|
@@ -5868,6 +6493,12 @@ interface QueryServicesOptions {
|
|
|
5868
6493
|
* @maxSize 5
|
|
5869
6494
|
*/
|
|
5870
6495
|
conditionalFields?: V2RequestedFieldsWithLiterals[] | undefined;
|
|
6496
|
+
/**
|
|
6497
|
+
* Whether to perform an eventually consistent call using
|
|
6498
|
+
* catalog reader (only for dbV1)
|
|
6499
|
+
* @internal
|
|
6500
|
+
*/
|
|
6501
|
+
eventuallyConsistent?: boolean | null | undefined;
|
|
5871
6502
|
}
|
|
5872
6503
|
interface QueryOffsetResult {
|
|
5873
6504
|
currentPage: number | undefined;
|
|
@@ -6462,7 +7093,7 @@ interface QueryCategoriesOptions {
|
|
|
6462
7093
|
* @applicableIdentity APP
|
|
6463
7094
|
* @fqn wix.bookings.services.v2.ServicesService.SetServiceLocations
|
|
6464
7095
|
*/
|
|
6465
|
-
declare function setServiceLocations(serviceId: string, options?: SetServiceLocationsOptions): Promise<NonNullablePaths<SetServiceLocationsResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.
|
|
7096
|
+
declare function setServiceLocations(serviceId: string, options?: SetServiceLocationsOptions): Promise<NonNullablePaths<SetServiceLocationsResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.staffMemberIds` | `service.staffMemberDetails.staffMembers` | `service.staffMemberDetails.staffMembers.${number}.staffMemberId` | `service.serviceResources` | `service.supportedSlugs` | `service.supportedSlugs.${number}.name` | `service.seoData.tags` | `service.seoData.tags.${number}.type` | `service.seoData.tags.${number}.children` | `service.seoData.tags.${number}.custom` | `service.seoData.tags.${number}.disabled` | `service.seoData.settings.preventAutoRedirect` | `service.seoData.settings.keywords` | `service.seoData.settings.keywords.${number}.term` | `service.seoData.settings.keywords.${number}.isMain` | `service.addOnGroups` | `service.addOnDetails` | `service.taxableAddress.taxableAddressType`, 7>>;
|
|
6466
7097
|
interface SetServiceLocationsOptions {
|
|
6467
7098
|
/**
|
|
6468
7099
|
* 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.
|
|
@@ -6499,7 +7130,7 @@ interface SetServiceLocationsOptions {
|
|
|
6499
7130
|
* @applicableIdentity APP
|
|
6500
7131
|
* @fqn wix.bookings.services.v2.ServicesService.EnablePricingPlansForService
|
|
6501
7132
|
*/
|
|
6502
|
-
declare function enablePricingPlansForService(serviceId: string, pricingPlanIds: string[]): Promise<NonNullablePaths<EnablePricingPlansForServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.
|
|
7133
|
+
declare function enablePricingPlansForService(serviceId: string, pricingPlanIds: string[]): Promise<NonNullablePaths<EnablePricingPlansForServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.staffMemberIds` | `service.staffMemberDetails.staffMembers` | `service.staffMemberDetails.staffMembers.${number}.staffMemberId` | `service.serviceResources` | `service.supportedSlugs` | `service.supportedSlugs.${number}.name` | `service.seoData.tags` | `service.seoData.tags.${number}.type` | `service.seoData.tags.${number}.children` | `service.seoData.tags.${number}.custom` | `service.seoData.tags.${number}.disabled` | `service.seoData.settings.preventAutoRedirect` | `service.seoData.settings.keywords` | `service.seoData.settings.keywords.${number}.term` | `service.seoData.settings.keywords.${number}.isMain` | `service.addOnGroups` | `service.addOnDetails` | `service.taxableAddress.taxableAddressType`, 7> & {
|
|
6503
7134
|
__applicationErrorsType?: EnablePricingPlansForServiceApplicationErrors;
|
|
6504
7135
|
}>;
|
|
6505
7136
|
/**
|
|
@@ -6516,7 +7147,7 @@ declare function enablePricingPlansForService(serviceId: string, pricingPlanIds:
|
|
|
6516
7147
|
* @applicableIdentity APP
|
|
6517
7148
|
* @fqn wix.bookings.services.v2.ServicesService.DisablePricingPlansForService
|
|
6518
7149
|
*/
|
|
6519
|
-
declare function disablePricingPlansForService(serviceId: string, options?: DisablePricingPlansForServiceOptions): Promise<NonNullablePaths<DisablePricingPlansForServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.
|
|
7150
|
+
declare function disablePricingPlansForService(serviceId: string, options?: DisablePricingPlansForServiceOptions): Promise<NonNullablePaths<DisablePricingPlansForServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.staffMemberIds` | `service.staffMemberDetails.staffMembers` | `service.staffMemberDetails.staffMembers.${number}.staffMemberId` | `service.serviceResources` | `service.supportedSlugs` | `service.supportedSlugs.${number}.name` | `service.seoData.tags` | `service.seoData.tags.${number}.type` | `service.seoData.tags.${number}.children` | `service.seoData.tags.${number}.custom` | `service.seoData.tags.${number}.disabled` | `service.seoData.settings.preventAutoRedirect` | `service.seoData.settings.keywords` | `service.seoData.settings.keywords.${number}.term` | `service.seoData.settings.keywords.${number}.isMain` | `service.addOnGroups` | `service.addOnDetails` | `service.taxableAddress.taxableAddressType`, 7> & {
|
|
6520
7151
|
__applicationErrorsType?: DisablePricingPlansForServiceApplicationErrors;
|
|
6521
7152
|
}>;
|
|
6522
7153
|
interface DisablePricingPlansForServiceOptions {
|
|
@@ -6544,7 +7175,7 @@ interface DisablePricingPlansForServiceOptions {
|
|
|
6544
7175
|
* @applicableIdentity APP
|
|
6545
7176
|
* @fqn wix.bookings.services.v2.ServicesService.SetCustomSlug
|
|
6546
7177
|
*/
|
|
6547
|
-
declare function setCustomSlug(serviceId: string, options?: SetCustomSlugOptions): Promise<NonNullablePaths<SetCustomSlugResponse, `slug.name` | `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.
|
|
7178
|
+
declare function setCustomSlug(serviceId: string, options?: SetCustomSlugOptions): Promise<NonNullablePaths<SetCustomSlugResponse, `slug.name` | `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.staffMemberIds` | `service.staffMemberDetails.staffMembers` | `service.staffMemberDetails.staffMembers.${number}.staffMemberId` | `service.serviceResources` | `service.supportedSlugs` | `service.supportedSlugs.${number}.name` | `service.seoData.tags` | `service.seoData.tags.${number}.type` | `service.seoData.tags.${number}.children` | `service.seoData.tags.${number}.custom` | `service.seoData.tags.${number}.disabled` | `service.seoData.settings.preventAutoRedirect` | `service.seoData.settings.keywords` | `service.seoData.settings.keywords.${number}.term` | `service.seoData.settings.keywords.${number}.isMain` | `service.addOnGroups` | `service.addOnDetails` | `service.taxableAddress.taxableAddressType`, 7> & {
|
|
6548
7179
|
__applicationErrorsType?: SetCustomSlugApplicationErrors;
|
|
6549
7180
|
__validationErrorsType?: SetCustomSlugValidationErrors;
|
|
6550
7181
|
}>;
|
|
@@ -6638,7 +7269,7 @@ interface ValidateSlugOptions {
|
|
|
6638
7269
|
* @applicableIdentity APP
|
|
6639
7270
|
* @fqn wix.bookings.services.v2.ServicesService.CloneService
|
|
6640
7271
|
*/
|
|
6641
|
-
declare function cloneService(sourceServiceId: string): Promise<NonNullablePaths<CloneServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.
|
|
7272
|
+
declare function cloneService(sourceServiceId: string): Promise<NonNullablePaths<CloneServiceResponse, `service.type` | `service.media.items` | `service.category._id` | `service.form._id` | `service.payment.fixed.price.value` | `service.payment.fixed.price.currency` | `service.payment.subscription.frequency` | `service.payment.subscription.firstChargeDate` | `service.payment.rateType` | `service.payment.pricingPlanIds` | `service.payment.addOnOption` | `service.payment.discountInfo.discountName` | `service.locations` | `service.locations.${number}.business._id` | `service.locations.${number}.business.name` | `service.locations.${number}.custom._id` | `service.locations.${number}._id` | `service.locations.${number}.type` | `service.bookingPolicy._id` | `service.bookingPolicy.customPolicyDescription.enabled` | `service.bookingPolicy.customPolicyDescription.description` | `service.bookingPolicy.limitEarlyBookingPolicy.enabled` | `service.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `service.bookingPolicy.limitLateBookingPolicy.enabled` | `service.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `service.bookingPolicy.bookAfterStartPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.enabled` | `service.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `service.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `service.bookingPolicy.reschedulePolicy.enabled` | `service.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `service.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `service.bookingPolicy.waitlistPolicy.enabled` | `service.bookingPolicy.waitlistPolicy.capacity` | `service.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `service.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `service.bookingPolicy.resourcesPolicy.enabled` | `service.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `service.bookingPolicy.cancellationFeePolicy.enabled` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows` | `service.bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `service.bookingPolicy.saveCreditCardPolicy.enabled` | `service.schedule.availabilityConstraints.durations` | `service.schedule.availabilityConstraints.durations.${number}.minutes` | `service.schedule.availabilityConstraints.sessionDurations` | `service.schedule.availabilityConstraints.timeBetweenSessions` | `service.staffMemberIds` | `service.staffMemberDetails.staffMembers` | `service.staffMemberDetails.staffMembers.${number}.staffMemberId` | `service.serviceResources` | `service.supportedSlugs` | `service.supportedSlugs.${number}.name` | `service.seoData.tags` | `service.seoData.tags.${number}.type` | `service.seoData.tags.${number}.children` | `service.seoData.tags.${number}.custom` | `service.seoData.tags.${number}.disabled` | `service.seoData.settings.preventAutoRedirect` | `service.seoData.settings.keywords` | `service.seoData.settings.keywords.${number}.term` | `service.seoData.settings.keywords.${number}.isMain` | `service.addOnGroups` | `service.addOnDetails` | `service.taxableAddress.taxableAddressType` | `errors`, 7>>;
|
|
6642
7273
|
/**
|
|
6643
7274
|
* Creates a new add-on group for a service and updates the service's `addOnGroups` array.
|
|
6644
7275
|
* @param addOnGroup - Add-on group to create.
|