@wix/auto_sdk_bookings_services 1.0.102 → 1.0.104
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-Ckx3A9Qa.d.ts → bookings-services-v2-service-services.universal-BvheLzPB.d.ts} +67 -69
- package/build/cjs/index.d.ts +69 -72
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +7 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{bookings-services-v2-service-services.universal-Ckx3A9Qa.d.mts → bookings-services-v2-service-services.universal-BvheLzPB.d.mts} +67 -69
- package/build/es/index.d.mts +69 -72
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +7 -8
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{bookings-services-v2-service-services.universal-Ckx3A9Qa.d.ts → bookings-services-v2-service-services.universal-BvheLzPB.d.ts} +67 -69
- package/build/internal/cjs/index.d.ts +69 -72
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +7 -8
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +5 -5
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{bookings-services-v2-service-services.universal-Ckx3A9Qa.d.mts → bookings-services-v2-service-services.universal-BvheLzPB.d.mts} +67 -69
- package/build/internal/es/index.d.mts +69 -72
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +7 -8
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +5 -5
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2507,7 +2507,7 @@ interface BookingPolicyWithServices {
|
|
|
2507
2507
|
/**
|
|
2508
2508
|
* Up to 5 services connected to the booking policy. If `totalServiceCount` is
|
|
2509
2509
|
* greater than 5, there are additional services connected to the policy.
|
|
2510
|
-
* You can call
|
|
2510
|
+
* You can call Search Services
|
|
2511
2511
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
2512
2512
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2513
2513
|
* connected to a booking policy.
|
|
@@ -2552,7 +2552,7 @@ interface BookingForm {
|
|
|
2552
2552
|
/**
|
|
2553
2553
|
* Up to 5 services connected to the booking form. If `totalServiceCount` is
|
|
2554
2554
|
* greater than 5, there are additional services connected to the policy.
|
|
2555
|
-
* You can call
|
|
2555
|
+
* You can call Search Services
|
|
2556
2556
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
2557
2557
|
* specifying the relevant policy ID in the filter, to retrieve all services that are
|
|
2558
2558
|
* connected to a booking policy.
|
|
@@ -2773,7 +2773,7 @@ interface EnablePricingPlansForServiceRequest {
|
|
|
2773
2773
|
*/
|
|
2774
2774
|
serviceId: string;
|
|
2775
2775
|
/**
|
|
2776
|
-
* IDs of the
|
|
2776
|
+
* IDs of the pricing plans
|
|
2777
2777
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
2778
2778
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
2779
2779
|
* @format GUID
|
|
@@ -2804,7 +2804,7 @@ interface DisablePricingPlansForServiceRequest {
|
|
|
2804
2804
|
*/
|
|
2805
2805
|
serviceId: string;
|
|
2806
2806
|
/**
|
|
2807
|
-
* IDs of the
|
|
2807
|
+
* IDs of the pricing plans
|
|
2808
2808
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
2809
2809
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
2810
2810
|
* @format GUID
|
|
@@ -3777,7 +3777,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3777
3777
|
* Creates a service.
|
|
3778
3778
|
*
|
|
3779
3779
|
*
|
|
3780
|
-
*
|
|
3780
|
+
* ### Required fields
|
|
3781
3781
|
*
|
|
3782
3782
|
* When creating a service you must specify the following fields:
|
|
3783
3783
|
* - `type`
|
|
@@ -3793,7 +3793,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3793
3793
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-payments) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-payments)):
|
|
3794
3794
|
* How customers can pay when signing up for the service.
|
|
3795
3795
|
*
|
|
3796
|
-
*
|
|
3796
|
+
* #### Session durations
|
|
3797
3797
|
*
|
|
3798
3798
|
* Depending on which type of service you're creating, you may also need to specify
|
|
3799
3799
|
* supported session durations.
|
|
@@ -3812,7 +3812,7 @@ interface SetAddOnsForGroupOptions {
|
|
|
3812
3812
|
* - Specify all supported session durations in `schedule.availabilityConstraints.sessionDurations`.
|
|
3813
3813
|
* - Note that Wix Bookings doesn't display these values to customers and
|
|
3814
3814
|
* ignores them in pricing and availability calculations. Instead session
|
|
3815
|
-
* durations are retrieved from the relevant service
|
|
3815
|
+
* durations are retrieved from the relevant service variants
|
|
3816
3816
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
3817
3817
|
* - It is mandatory to specify `schedule.availabilityConstraints.sessionDurations`,
|
|
3818
3818
|
* even though these values are ignored.
|
|
@@ -3831,7 +3831,7 @@ declare function createService(service: Service): Promise<NonNullablePaths<Servi
|
|
|
3831
3831
|
* Creates multiple services.
|
|
3832
3832
|
*
|
|
3833
3833
|
*
|
|
3834
|
-
* See
|
|
3834
|
+
* See Create Service
|
|
3835
3835
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/create-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/create-service))
|
|
3836
3836
|
* for more details.
|
|
3837
3837
|
* @param services - Services to create.
|
|
@@ -3866,12 +3866,12 @@ declare function getService(serviceId: string): Promise<NonNullablePaths<Service
|
|
|
3866
3866
|
* This ensures you're working with the latest service information and
|
|
3867
3867
|
* prevents unintended overwrites.
|
|
3868
3868
|
*
|
|
3869
|
-
*
|
|
3869
|
+
* ### Session durations
|
|
3870
3870
|
*
|
|
3871
3871
|
* Specify `schedule.availabilityConstraints.sessionDurations`
|
|
3872
3872
|
* only if you want to update it for appointment-based services without varied
|
|
3873
3873
|
* pricing based on session length. Don't specify `schedule.availabilityConstraints.sessionDurations`
|
|
3874
|
-
* for all other appointment-based services, classes, or courses. See
|
|
3874
|
+
* for all other appointment-based services, classes, or courses. See Create Service
|
|
3875
3875
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/create-service#session-durations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/create-service#session-durations))
|
|
3876
3876
|
* for more details.
|
|
3877
3877
|
* @param _id - Service ID.
|
|
@@ -4028,7 +4028,7 @@ interface UpdateService {
|
|
|
4028
4028
|
* Updates up to 100 services.
|
|
4029
4029
|
*
|
|
4030
4030
|
*
|
|
4031
|
-
* See
|
|
4031
|
+
* See Update Service
|
|
4032
4032
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4033
4033
|
* for more details.
|
|
4034
4034
|
*
|
|
@@ -4060,7 +4060,7 @@ interface BulkUpdateServicesOptions {
|
|
|
4060
4060
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering))
|
|
4061
4061
|
* for more details.
|
|
4062
4062
|
*
|
|
4063
|
-
* See
|
|
4063
|
+
* See Update Service
|
|
4064
4064
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4065
4065
|
* for more details about updating a service.
|
|
4066
4066
|
*
|
|
@@ -4112,7 +4112,7 @@ interface DeleteServiceOptions {
|
|
|
4112
4112
|
* Deletes multiple services.
|
|
4113
4113
|
*
|
|
4114
4114
|
*
|
|
4115
|
-
* See
|
|
4115
|
+
* See Delete Service
|
|
4116
4116
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service))
|
|
4117
4117
|
* for more details about deleting a service.
|
|
4118
4118
|
*
|
|
@@ -4143,7 +4143,7 @@ interface BulkDeleteServicesOptions {
|
|
|
4143
4143
|
* Deletes multiple services by filter.
|
|
4144
4144
|
*
|
|
4145
4145
|
*
|
|
4146
|
-
* See
|
|
4146
|
+
* See Delete Service
|
|
4147
4147
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service))
|
|
4148
4148
|
* for more details about deleting a service.
|
|
4149
4149
|
*
|
|
@@ -4454,38 +4454,38 @@ type ServiceSearch = {
|
|
|
4454
4454
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
4455
4455
|
};
|
|
4456
4456
|
/**
|
|
4457
|
-
* Retrieves a list of up to 100
|
|
4457
|
+
* Retrieves a list of up to 100 booking policies
|
|
4458
4458
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)),
|
|
4459
4459
|
* and information about the services that are connected to them,
|
|
4460
4460
|
* given the provided filtering, paging, and sorting.
|
|
4461
4461
|
*
|
|
4462
|
-
*
|
|
4462
|
+
* ### Defaults
|
|
4463
4463
|
*
|
|
4464
4464
|
* Query Policies has the following default settings, which you can override:
|
|
4465
4465
|
*
|
|
4466
4466
|
* + Sorted by `id` in ascending order.
|
|
4467
4467
|
* + `cursorPaging.limit` set to `100`.
|
|
4468
4468
|
*
|
|
4469
|
-
*
|
|
4469
|
+
* ### Filters
|
|
4470
4470
|
*
|
|
4471
|
-
* For a complete list of supported filters, refer to
|
|
4471
|
+
* For a complete list of supported filters, refer to Booking Policies API: Supported Filters
|
|
4472
4472
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters)).
|
|
4473
4473
|
*
|
|
4474
4474
|
* When using date filters, you must use
|
|
4475
4475
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
4476
4476
|
*
|
|
4477
|
-
*
|
|
4477
|
+
* ### Returned services
|
|
4478
4478
|
*
|
|
4479
4479
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4480
4480
|
* those services is returned. The `bookingPolicies.totalServiceCount` values
|
|
4481
|
-
* indicate the total number of services linked to each policy. You can call
|
|
4481
|
+
* indicate the total number of services linked to each policy. You can call Search Services
|
|
4482
4482
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
|
|
4483
4483
|
* and specify the relevant policy ID in the filter to retrieve all services
|
|
4484
4484
|
* connected to the booking policy.
|
|
4485
4485
|
*
|
|
4486
|
-
*
|
|
4486
|
+
* ### See also
|
|
4487
4487
|
*
|
|
4488
|
-
* To learn about working with
|
|
4488
|
+
* To learn about working with Query methods, see
|
|
4489
4489
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
4490
4490
|
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4491
4491
|
* @param query - Information about filters, paging, and sorting. See the article about
|
|
@@ -4502,45 +4502,45 @@ type ServiceSearch = {
|
|
|
4502
4502
|
*/
|
|
4503
4503
|
declare function queryPolicies(query: CursorQuery): Promise<NonNullablePaths<QueryPoliciesResponse, `bookingPolicies` | `bookingPolicies.${number}.bookingPolicy._id` | `bookingPolicies.${number}.bookingPolicy.customPolicyDescription.enabled` | `bookingPolicies.${number}.bookingPolicy.customPolicyDescription.description` | `bookingPolicies.${number}.bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicies.${number}.bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicies.${number}.bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicies.${number}.bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicies.${number}.bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.capacity` | `bookingPolicies.${number}.bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicies.${number}.bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicies.${number}.bookingPolicy.resourcesPolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicies.${number}.bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicies.${number}.bookingPolicy.saveCreditCardPolicy.enabled` | `bookingPolicies.${number}.totalServiceCount`, 6>>;
|
|
4504
4504
|
/**
|
|
4505
|
-
* Retrieves a list of up to 100
|
|
4505
|
+
* Retrieves a list of up to 100 booking forms
|
|
4506
4506
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)),
|
|
4507
4507
|
* and information about the services that are connected to them,
|
|
4508
4508
|
* given the provided filtering, paging, and sorting.
|
|
4509
4509
|
*
|
|
4510
4510
|
*
|
|
4511
|
-
*
|
|
4511
|
+
* ### Defaults
|
|
4512
4512
|
*
|
|
4513
4513
|
* Query Booking Forms has the following default settings, which you can override:
|
|
4514
4514
|
*
|
|
4515
4515
|
* + Sorted by `id` in ascending order.
|
|
4516
4516
|
* + `cursorPaging.limit` set to `100`.
|
|
4517
4517
|
*
|
|
4518
|
-
*
|
|
4518
|
+
* ### Filters
|
|
4519
4519
|
*
|
|
4520
|
-
* For a complete list of supported filters, refer to
|
|
4520
|
+
* For a complete list of supported filters, refer to Forms API: Supported Filters
|
|
4521
4521
|
* ([REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)).
|
|
4522
4522
|
*
|
|
4523
4523
|
* When using date filters, you must use
|
|
4524
4524
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
4525
4525
|
*
|
|
4526
|
-
*
|
|
4526
|
+
* ### Returned services
|
|
4527
4527
|
*
|
|
4528
4528
|
* If a booking policy is connected to more than 5 services, only a subset of
|
|
4529
4529
|
* these service IDs and names is returned. The `bookingForms.totalServiceCount`
|
|
4530
|
-
* values indicate the total number of services linked to each form. You can call
|
|
4530
|
+
* values indicate the total number of services linked to each form. You can call Query Services
|
|
4531
4531
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/query-services))
|
|
4532
4532
|
* and specify the relevant form ID in the filter to retrieve all services
|
|
4533
4533
|
* connected to the booking form.
|
|
4534
4534
|
*
|
|
4535
|
-
*
|
|
4535
|
+
* ### Default booking forms
|
|
4536
4536
|
*
|
|
4537
4537
|
* By default, all Wix Bookings services use a standard booking form. To retrieve
|
|
4538
4538
|
* a site's default booking form with Query Booking Forms, specify
|
|
4539
4539
|
* `{"conditionalFields": ["DEFAULT_BOOKING_FORM"]}`.
|
|
4540
4540
|
*
|
|
4541
|
-
*
|
|
4541
|
+
* ### See also
|
|
4542
4542
|
*
|
|
4543
|
-
* To learn about working with
|
|
4543
|
+
* To learn about working with Query methods, see
|
|
4544
4544
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
4545
4545
|
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4546
4546
|
* @param query - Information about filters, paging, and sorting. See the article about
|
|
@@ -4588,18 +4588,18 @@ interface CountServicesOptions {
|
|
|
4588
4588
|
filter?: Record<string, any> | null;
|
|
4589
4589
|
}
|
|
4590
4590
|
/**
|
|
4591
|
-
* Retrieves 3 separate lists of business, custom, and customer
|
|
4591
|
+
* Retrieves 3 separate lists of business, custom, and customer locations
|
|
4592
4592
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)),
|
|
4593
4593
|
* given the provided filtering, and whether each location is connected to at
|
|
4594
4594
|
* least one of the site's services.
|
|
4595
4595
|
*
|
|
4596
4596
|
*
|
|
4597
|
-
*
|
|
4597
|
+
* ### Defaults
|
|
4598
4598
|
*
|
|
4599
4599
|
* Query Locations has the following default setting, which you can't override:
|
|
4600
4600
|
* Sorted by `id` in ascending order.
|
|
4601
4601
|
*
|
|
4602
|
-
*
|
|
4602
|
+
* ### Filters
|
|
4603
4603
|
*
|
|
4604
4604
|
* For a complete list of supported filters, refer to the `location` object
|
|
4605
4605
|
* ([REST](https://dev.wix.com/docs/rest/business-management/locations/location-object)).
|
|
@@ -4607,9 +4607,9 @@ interface CountServicesOptions {
|
|
|
4607
4607
|
* When using date filters, you must use
|
|
4608
4608
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
4609
4609
|
*
|
|
4610
|
-
*
|
|
4610
|
+
* ### See also
|
|
4611
4611
|
*
|
|
4612
|
-
* To learn about working with
|
|
4612
|
+
* To learn about working with Query methods, see
|
|
4613
4613
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
4614
4614
|
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4615
4615
|
* @public
|
|
@@ -4624,17 +4624,15 @@ interface QueryLocationsOptions {
|
|
|
4624
4624
|
filter?: QueryLocationsFilter;
|
|
4625
4625
|
}
|
|
4626
4626
|
/**
|
|
4627
|
-
* Retrieves a list of service
|
|
4628
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v2/introduction)),
|
|
4629
|
-
* given the provided filtering.
|
|
4627
|
+
* Retrieves a list of service categories ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v2/introduction)), given the provided filtering.
|
|
4630
4628
|
*
|
|
4631
4629
|
*
|
|
4632
|
-
*
|
|
4630
|
+
* ### Defaults
|
|
4633
4631
|
*
|
|
4634
4632
|
* Query Categories has the following default setting, which you can't override:
|
|
4635
4633
|
* Sorted by `id` in ascending order.
|
|
4636
4634
|
*
|
|
4637
|
-
*
|
|
4635
|
+
* ### Filters
|
|
4638
4636
|
*
|
|
4639
4637
|
* For a complete list of supported filters, refer to the supported filters article
|
|
4640
4638
|
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting#filtering)).
|
|
@@ -4642,9 +4640,9 @@ interface QueryLocationsOptions {
|
|
|
4642
4640
|
* When using date filters, you must use
|
|
4643
4641
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
4644
4642
|
*
|
|
4645
|
-
*
|
|
4643
|
+
* ### See also
|
|
4646
4644
|
*
|
|
4647
|
-
* To learn about working with
|
|
4645
|
+
* To learn about working with Query methods, see
|
|
4648
4646
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
4649
4647
|
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4650
4648
|
* @public
|
|
@@ -4659,12 +4657,12 @@ interface QueryCategoriesOptions {
|
|
|
4659
4657
|
filter?: QueryCategoriesFilter;
|
|
4660
4658
|
}
|
|
4661
4659
|
/**
|
|
4662
|
-
* Replaces the list of the
|
|
4660
|
+
* Replaces the list of the locations
|
|
4663
4661
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4664
4662
|
* where the business offers the service.
|
|
4665
4663
|
*
|
|
4666
4664
|
*
|
|
4667
|
-
*
|
|
4665
|
+
* ### Consequences for customers
|
|
4668
4666
|
*
|
|
4669
4667
|
* Removing a service location may impact existing sessions and their
|
|
4670
4668
|
* participants. If you remove at least one service location, you must
|
|
@@ -4690,18 +4688,18 @@ interface QueryCategoriesOptions {
|
|
|
4690
4688
|
* Future sessions scheduled for a location defined by the customer are also not
|
|
4691
4689
|
* updated.
|
|
4692
4690
|
*
|
|
4693
|
-
*
|
|
4691
|
+
* ### Specify location details
|
|
4694
4692
|
*
|
|
4695
4693
|
* Depending on whether the new or updated location is a business or custom location,
|
|
4696
4694
|
* you need to specify different fields.
|
|
4697
4695
|
*
|
|
4698
|
-
* - **Business location**: Specify the relevant
|
|
4696
|
+
* - **Business location**: Specify the relevant location ID
|
|
4699
4697
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction))
|
|
4700
4698
|
* in `locations.business.id`.
|
|
4701
4699
|
* - **Custom location**: Specify the complete address object as
|
|
4702
4700
|
* `locations.custom.address`.
|
|
4703
4701
|
*
|
|
4704
|
-
*
|
|
4702
|
+
* ### Participant notifications
|
|
4705
4703
|
*
|
|
4706
4704
|
* You can specify a `participantNotification.message` that's immediately send
|
|
4707
4705
|
* to all customers who had booked at a changed location. Ensure
|
|
@@ -4732,18 +4730,18 @@ interface SetServiceLocationsOptions {
|
|
|
4732
4730
|
participantNotification?: ParticipantNotification;
|
|
4733
4731
|
}
|
|
4734
4732
|
/**
|
|
4735
|
-
* Adds a list of
|
|
4733
|
+
* Adds a list of pricing plan IDs
|
|
4736
4734
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4737
4735
|
* to a service's `payment.pricingPlanIds` array.
|
|
4738
4736
|
*
|
|
4739
4737
|
*
|
|
4740
4738
|
* The call doesn't validate whether the service's `payment.options.pricingPlan`
|
|
4741
4739
|
* is set to `true`. If it's set to `false`, customers aren't able to pay
|
|
4742
|
-
* for their bookings using pricing plans. You can call
|
|
4740
|
+
* for their bookings using pricing plans. You can call Update Service
|
|
4743
4741
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
|
|
4744
4742
|
* to change a service's supported payment methods.
|
|
4745
4743
|
* @param serviceId - ID of the service to update.
|
|
4746
|
-
* @param pricingPlanIds - IDs of the
|
|
4744
|
+
* @param pricingPlanIds - IDs of the pricing plans
|
|
4747
4745
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4748
4746
|
* to add to the service's `payment.pricingPlanIds` array.
|
|
4749
4747
|
* @public
|
|
@@ -4757,7 +4755,7 @@ declare function enablePricingPlansForService(serviceId: string, pricingPlanIds:
|
|
|
4757
4755
|
__applicationErrorsType?: EnablePricingPlansForServiceApplicationErrors;
|
|
4758
4756
|
}>;
|
|
4759
4757
|
/**
|
|
4760
|
-
* Removes a list of
|
|
4758
|
+
* Removes a list of pricing plan IDs
|
|
4761
4759
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4762
4760
|
* from a service's `payment.pricingPlanIds` array.
|
|
4763
4761
|
*
|
|
@@ -4777,7 +4775,7 @@ declare function disablePricingPlansForService(serviceId: string, options?: Disa
|
|
|
4777
4775
|
}>;
|
|
4778
4776
|
interface DisablePricingPlansForServiceOptions {
|
|
4779
4777
|
/**
|
|
4780
|
-
* IDs of the
|
|
4778
|
+
* IDs of the pricing plans
|
|
4781
4779
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
|
|
4782
4780
|
* to remove from the service's `payment.pricingPlanIds` array.
|
|
4783
4781
|
* @format GUID
|
|
@@ -4840,62 +4838,62 @@ interface ValidateSlugOptions {
|
|
|
4840
4838
|
* Clones a service.
|
|
4841
4839
|
*
|
|
4842
4840
|
*
|
|
4843
|
-
*
|
|
4841
|
+
* ### Connected entities
|
|
4844
4842
|
*
|
|
4845
4843
|
* By default, not all entities connected to the service are cloned.
|
|
4846
4844
|
*
|
|
4847
|
-
*
|
|
4845
|
+
* #### Schedule
|
|
4848
4846
|
*
|
|
4849
|
-
* Wix Bookings automatically creates a new active
|
|
4847
|
+
* Wix Bookings automatically creates a new active schedule
|
|
4850
4848
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction))
|
|
4851
4849
|
* for the cloned service. If Wix Bookings can't create this schedule, the
|
|
4852
|
-
* Clone Service
|
|
4850
|
+
* Clone Service call fails.
|
|
4853
4851
|
*
|
|
4854
4852
|
* - __For appointment-based services__: Future appointments aren't added to the
|
|
4855
|
-
* cloned service's schedule. Use the
|
|
4853
|
+
* cloned service's schedule. Use the Events API
|
|
4856
4854
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
|
|
4857
4855
|
* to add them as needed.
|
|
4858
4856
|
* - __For classes and courses__: Future one-time events aren't added to the
|
|
4859
4857
|
* cloned service's schedule, while future recurring events are added
|
|
4860
|
-
* asynchronously. The
|
|
4858
|
+
* asynchronously. The Clone Service call always succeeds, whether or not
|
|
4861
4859
|
* recurring events are added.
|
|
4862
4860
|
* If the response includes `RECURRING_EVENTS` in the `errors` array, it means the
|
|
4863
4861
|
* cloned service doesn't have future recurring events, even though the original
|
|
4864
4862
|
* service does. You can either delete the cloned service and try again or use
|
|
4865
|
-
* the
|
|
4863
|
+
* the Events API
|
|
4866
4864
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
|
|
4867
4865
|
* to add missing events to the schedule.
|
|
4868
4866
|
*
|
|
4869
4867
|
* Wix Bookings never adds past events to the cloned service's schedule.
|
|
4870
4868
|
*
|
|
4871
|
-
*
|
|
4869
|
+
* #### Service options and variants
|
|
4872
4870
|
*
|
|
4873
|
-
* If the original service has
|
|
4871
|
+
* If the original service has variants
|
|
4874
4872
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)),
|
|
4875
|
-
* they're cloned asynchronously. The
|
|
4873
|
+
* they're cloned asynchronously. The Clone Service call always succeeds,
|
|
4876
4874
|
* regardless of whether variants were cloned.
|
|
4877
4875
|
*
|
|
4878
4876
|
* If the response includes `OPTIONS_AND_VARIANTS` in the `errors` array, the cloned
|
|
4879
4877
|
* service doesn't have variants, even though the original service does. You can
|
|
4880
|
-
* delete the cloned service and call
|
|
4878
|
+
* delete the cloned service and call Clone Service again, or use the
|
|
4881
4879
|
* _Service Options And Variants API_
|
|
4882
4880
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction))
|
|
4883
4881
|
* to add variants.
|
|
4884
4882
|
*
|
|
4885
|
-
*
|
|
4883
|
+
* #### Booking form
|
|
4886
4884
|
*
|
|
4887
4885
|
* The original service's booking form isn't cloned, whether it's
|
|
4888
4886
|
* the default or a custom booking form.
|
|
4889
4887
|
*
|
|
4890
|
-
*
|
|
4888
|
+
* #### Pricing plans
|
|
4891
4889
|
*
|
|
4892
|
-
* If the original service's accepts payments via
|
|
4890
|
+
* If the original service's accepts payments via pricing plans
|
|
4893
4891
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/plans/introduction)),
|
|
4894
4892
|
* the cloned service's `payment.options.pricingPlan` is also set to `true`. To
|
|
4895
|
-
* accept specific pricing plans, call
|
|
4893
|
+
* accept specific pricing plans, call Enable Pricing Plans For Service
|
|
4896
4894
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/enable-pricing-plans-for-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/enable-pricing-plans-for-service)),
|
|
4897
4895
|
* after cloning the service. If the original service accepts only
|
|
4898
|
-
* pricing plan payments and you don't call
|
|
4896
|
+
* pricing plan payments and you don't call Enable Pricing Plans For Service
|
|
4899
4897
|
* after cloning the service, customers will be unable to book the service.
|
|
4900
4898
|
* @param sourceServiceId - ID of the service to clone.
|
|
4901
4899
|
* @public
|