@wix/auto_sdk_bookings_multi-service-availability-time-slots 1.0.188 → 1.0.189

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.
@@ -9,7 +9,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
9
9
  */
10
10
  interface TimeSlot {
11
11
  /**
12
- * Service ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)).
12
+ * [Service ID] (https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction).
13
13
  *
14
14
  * Available only for single-service bookings. For multi-service bookings, this field is empty and individual service IDs are provided in `nestedTimeSlots`.
15
15
  * @format GUID
@@ -32,7 +32,7 @@ interface TimeSlot {
32
32
  */
33
33
  localEndDate?: string | null;
34
34
  /**
35
- * Whether customers can book the slot according to the service's booking policies ([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)).
35
+ * Whether customers can book the slot according to the service's [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction).
36
36
  *
37
37
  * For multi-service bookings, this is `true` only when all services in the sequence comply with their respective booking policies.
38
38
  */
@@ -40,7 +40,7 @@ interface TimeSlot {
40
40
  /** Information about where the business provides the service to the customer. */
41
41
  location?: Location;
42
42
  /**
43
- * Information about the event ([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)) related to the slot.
43
+ * Information about the [event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction) related to the slot.
44
44
  * Available only for classes. Not available for appointment-based services and courses.
45
45
  */
46
46
  eventInfo?: EventInfo;
@@ -75,7 +75,7 @@ interface TimeSlot {
75
75
  */
76
76
  bookingPolicyViolations?: BookingPolicyViolations;
77
77
  /**
78
- * List of resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) available during the time slot.
78
+ * List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) available during the time slot.
79
79
  *
80
80
  * Available only for single-service bookings. For multi-service bookings, resource information is provided in `nestedTimeSlots`.
81
81
  */
@@ -99,7 +99,7 @@ interface TimeSlot {
99
99
  }
100
100
  interface Location {
101
101
  /**
102
- * Location ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
102
+ * [Location ID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
103
103
  * Available only for business locations.
104
104
  * @format GUID
105
105
  */
@@ -175,7 +175,7 @@ interface BookingPolicyViolations {
175
175
  }
176
176
  interface AvailableResources {
177
177
  /**
178
- * Resource type ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
178
+ * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
179
179
  * @format GUID
180
180
  */
181
181
  resourceTypeId?: string | null;
@@ -230,7 +230,7 @@ interface NestedTimeSlot {
230
230
  */
231
231
  localEndDate?: string;
232
232
  /**
233
- * List of resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) available during the nested time slot.
233
+ * List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) available during the nested time slot.
234
234
  * @maxSize 10
235
235
  */
236
236
  availableResources?: AvailableResources[];
@@ -286,7 +286,7 @@ interface ListMultiServiceAvailabilityTimeSlotsRequest {
286
286
  *
287
287
  * Required unless you specify `cursorPaging.cursor`.
288
288
  *
289
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
289
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
290
290
  * @minLength 1
291
291
  * @maxLength 150
292
292
  */
@@ -304,7 +304,7 @@ interface ListMultiServiceAvailabilityTimeSlotsRequest {
304
304
  bookable?: boolean | null;
305
305
  /**
306
306
  * Indicators for service's booking policy violations.
307
- * Allows filtering for time slots with specific violation types based on booking policies ([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)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
307
+ * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
308
308
  */
309
309
  bookingPolicyViolations?: BookingPolicyViolations;
310
310
  /**
@@ -327,7 +327,7 @@ interface Service {
327
327
  */
328
328
  serviceId?: string;
329
329
  /**
330
- * Resource type IDs ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) to include in returned time slots.
330
+ * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
331
331
  * This is in addition to the specifically requested resources.
332
332
  *
333
333
  * <blockquote>
@@ -383,7 +383,7 @@ interface V2CustomerChoices {
383
383
  }
384
384
  interface ResourceType {
385
385
  /**
386
- * Resource type ID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
386
+ * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
387
387
  * @format GUID
388
388
  */
389
389
  resourceTypeId?: string | null;
@@ -423,7 +423,7 @@ interface ListMultiServiceAvailabilityTimeSlotsResponse {
423
423
  /**
424
424
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
425
425
  * For example, `America/New_York` or `UTC`.
426
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
426
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
427
427
  * @minLength 1
428
428
  * @maxLength 150
429
429
  */
@@ -474,7 +474,7 @@ interface GetMultiServiceAvailabilityTimeSlotRequest {
474
474
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
475
475
  * For example, `America/New_York` or `UTC`.
476
476
  *
477
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
477
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
478
478
  * @minLength 1
479
479
  * @maxLength 150
480
480
  */
@@ -492,7 +492,7 @@ interface GetMultiServiceAvailabilityTimeSlotResponse {
492
492
  /**
493
493
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
494
494
  * For example, `America/New_York` or `UTC`.
495
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
495
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
496
496
  * @minLength 1
497
497
  * @maxLength 150
498
498
  */
@@ -529,7 +529,7 @@ interface ListAvailabilityTimeSlotsRequest {
529
529
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
530
530
  * For example, `America/New_York` or `UTC`.
531
531
  *
532
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
532
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
533
533
  * @minLength 1
534
534
  * @maxLength 150
535
535
  */
@@ -555,7 +555,7 @@ interface ListAvailabilityTimeSlotsRequest {
555
555
  bookable?: boolean | null;
556
556
  /**
557
557
  * Indicators for service's booking policy violations.
558
- * Allows filtering for time slots with specific violation types based on booking policies ([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)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
558
+ * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
559
559
  */
560
560
  bookingPolicyViolations?: BookingPolicyViolations;
561
561
  /**
@@ -615,7 +615,7 @@ interface ListAvailabilityTimeSlotsResponse {
615
615
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
616
616
  * For example, `America/New_York` or `UTC`.
617
617
  *
618
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
618
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
619
619
  * @minLength 1
620
620
  * @maxLength 150
621
621
  */
@@ -649,7 +649,7 @@ interface GetAvailabilityTimeSlotRequest {
649
649
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
650
650
  * For example, `America/New_York` or `UTC`.
651
651
  *
652
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
652
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
653
653
  * @minLength 1
654
654
  * @maxLength 150
655
655
  */
@@ -662,7 +662,7 @@ interface GetAvailabilityTimeSlotRequest {
662
662
  */
663
663
  location?: Location;
664
664
  /**
665
- * IDs of the resource types ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)) to check availability for.
665
+ * IDs of the [resource types](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction) to check availability for.
666
666
  * @format GUID
667
667
  * @maxSize 100
668
668
  */
@@ -696,7 +696,7 @@ interface GetAvailabilityTimeSlotResponse {
696
696
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
697
697
  * For example, `America/New_York` or `UTC`.
698
698
  *
699
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
699
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
700
700
  * @minLength 1
701
701
  * @maxLength 150
702
702
  */
@@ -727,7 +727,7 @@ interface ListEventTimeSlotsRequest {
727
727
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
728
728
  * For example, `America/New_York` or `UTC`.
729
729
  *
730
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
730
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
731
731
  * @maxLength 100
732
732
  */
733
733
  timeZone?: string | null;
@@ -773,7 +773,7 @@ interface ListEventTimeSlotsRequest {
773
773
  cursorPaging?: CursorPaging;
774
774
  /**
775
775
  * Indicators for service's booking policy violations.
776
- * Allows filtering for time slots with specific violation types based on booking policies ([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)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
776
+ * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
777
777
  */
778
778
  bookingPolicyViolations?: BookingPolicyViolations;
779
779
  }
@@ -784,7 +784,7 @@ interface ListEventTimeSlotsResponse {
784
784
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
785
785
  * For example, `America/New_York` or `UTC`.
786
786
  *
787
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
787
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
788
788
  * @minLength 1
789
789
  * @maxLength 150
790
790
  */
@@ -806,7 +806,7 @@ interface GetEventTimeSlotRequest {
806
806
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
807
807
  * For example, `America/New_York` or `UTC`.
808
808
  *
809
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
809
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
810
810
  * @maxLength 100
811
811
  */
812
812
  timeZone?: string | null;
@@ -818,7 +818,7 @@ interface GetEventTimeSlotResponse {
818
818
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
819
819
  * For example, `America/New_York` or `UTC`.
820
820
  *
821
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
821
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
822
822
  * @minLength 1
823
823
  * @maxLength 150
824
824
  */
@@ -886,11 +886,11 @@ type GetMultiServiceAvailabilityTimeSlotApplicationErrors = {
886
886
  *
887
887
  * Only appointment-type services are supported.
888
888
  *
889
- * To retrieve appointment availability for a single service, call List Availability Time Slots ([SDK](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots?apiView=SDK) | [REST](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots)).
889
+ * To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots).
890
890
  *
891
891
  * ### Booking policy filtering
892
892
  *
893
- * Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your booking policies ([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)).
893
+ * Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction).
894
894
  *
895
895
  * *Default behavior**: When you don't specify any `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
896
896
  *
@@ -941,7 +941,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
941
941
  *
942
942
  * Required unless you specify `cursorPaging.cursor`.
943
943
  *
944
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
944
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
945
945
  * @minLength 1
946
946
  * @maxLength 150
947
947
  */
@@ -959,7 +959,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
959
959
  bookable?: boolean | null;
960
960
  /**
961
961
  * Indicators for service's booking policy violations.
962
- * Allows filtering for time slots with specific violation types based on booking policies ([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)). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
962
+ * Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
963
963
  */
964
964
  bookingPolicyViolations?: BookingPolicyViolations;
965
965
  /**
@@ -992,7 +992,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
992
992
  *
993
993
  * Only appointment-type services are supported.
994
994
  *
995
- * To retrieve appointment availability for a single service, call List Availability Time Slots ([SDK](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots?apiView=SDK) | [REST](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots)).
995
+ * To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots).
996
996
  * @param services - Services for which the multi-service time slots are returned.
997
997
  * You can specify resource filters for each service.
998
998
  * @param localStartDate - Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
@@ -1002,7 +1002,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
1002
1002
  * @param timeZone - Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
1003
1003
  * For example, `America/New_York` or `UTC`.
1004
1004
  *
1005
- * Default: `timeZone` specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
1005
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1006
1006
  * @param location - Location for which the multi-service time slots are returned. If you filter by `{"type": "BUSINESS"}`, you must also specify a location ID. A filter for `location.name` is ignored.
1007
1007
  *
1008
1008
  * Required unless you specify `cursorPaging.cursor`.