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

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;
@@ -433,7 +433,7 @@ interface ListMultiServiceAvailabilityTimeSlotsResponse {
433
433
  /**
434
434
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
435
435
  * For example, `America/New_York` or `UTC`.
436
- * 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)).
436
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
437
437
  * @minLength 1
438
438
  * @maxLength 150
439
439
  */
@@ -484,7 +484,7 @@ interface GetMultiServiceAvailabilityTimeSlotRequest {
484
484
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
485
485
  * For example, `America/New_York` or `UTC`.
486
486
  *
487
- * 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)).
487
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
488
488
  * @minLength 1
489
489
  * @maxLength 150
490
490
  */
@@ -502,7 +502,7 @@ interface GetMultiServiceAvailabilityTimeSlotResponse {
502
502
  /**
503
503
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
504
504
  * For example, `America/New_York` or `UTC`.
505
- * 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)).
505
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
506
506
  * @minLength 1
507
507
  * @maxLength 150
508
508
  */
@@ -539,7 +539,7 @@ interface ListAvailabilityTimeSlotsRequest {
539
539
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
540
540
  * For example, `America/New_York` or `UTC`.
541
541
  *
542
- * 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)).
542
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
543
543
  * @minLength 1
544
544
  * @maxLength 150
545
545
  */
@@ -565,7 +565,7 @@ interface ListAvailabilityTimeSlotsRequest {
565
565
  bookable?: boolean | null;
566
566
  /**
567
567
  * Indicators for service's booking policy violations.
568
- * 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.
568
+ * 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.
569
569
  */
570
570
  bookingPolicyViolations?: BookingPolicyViolations;
571
571
  /**
@@ -625,7 +625,7 @@ interface ListAvailabilityTimeSlotsResponse {
625
625
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
626
626
  * For example, `America/New_York` or `UTC`.
627
627
  *
628
- * 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)).
628
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
629
629
  * @minLength 1
630
630
  * @maxLength 150
631
631
  */
@@ -659,7 +659,7 @@ interface GetAvailabilityTimeSlotRequest {
659
659
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
660
660
  * For example, `America/New_York` or `UTC`.
661
661
  *
662
- * 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)).
662
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
663
663
  * @minLength 1
664
664
  * @maxLength 150
665
665
  */
@@ -672,7 +672,7 @@ interface GetAvailabilityTimeSlotRequest {
672
672
  */
673
673
  location?: Location;
674
674
  /**
675
- * 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.
675
+ * IDs of the [resource types](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction) to check availability for.
676
676
  * @format GUID
677
677
  * @maxSize 100
678
678
  */
@@ -706,7 +706,7 @@ interface GetAvailabilityTimeSlotResponse {
706
706
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
707
707
  * For example, `America/New_York` or `UTC`.
708
708
  *
709
- * 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)).
709
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
710
710
  * @minLength 1
711
711
  * @maxLength 150
712
712
  */
@@ -737,7 +737,7 @@ interface ListEventTimeSlotsRequest {
737
737
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
738
738
  * For example, `America/New_York` or `UTC`.
739
739
  *
740
- * 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)).
740
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
741
741
  * @maxLength 100
742
742
  */
743
743
  timeZone?: string | null;
@@ -783,7 +783,7 @@ interface ListEventTimeSlotsRequest {
783
783
  cursorPaging?: CursorPaging;
784
784
  /**
785
785
  * Indicators for service's booking policy violations.
786
- * 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.
786
+ * 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.
787
787
  */
788
788
  bookingPolicyViolations?: BookingPolicyViolations;
789
789
  }
@@ -794,7 +794,7 @@ interface ListEventTimeSlotsResponse {
794
794
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
795
795
  * For example, `America/New_York` or `UTC`.
796
796
  *
797
- * 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)).
797
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
798
798
  * @minLength 1
799
799
  * @maxLength 150
800
800
  */
@@ -816,7 +816,7 @@ interface GetEventTimeSlotRequest {
816
816
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
817
817
  * For example, `America/New_York` or `UTC`.
818
818
  *
819
- * 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)).
819
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
820
820
  * @maxLength 100
821
821
  */
822
822
  timeZone?: string | null;
@@ -828,7 +828,7 @@ interface GetEventTimeSlotResponse {
828
828
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
829
829
  * For example, `America/New_York` or `UTC`.
830
830
  *
831
- * 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)).
831
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
832
832
  * @minLength 1
833
833
  * @maxLength 150
834
834
  */
@@ -896,11 +896,11 @@ type GetMultiServiceAvailabilityTimeSlotApplicationErrors = {
896
896
  *
897
897
  * Only appointment-type services are supported.
898
898
  *
899
- * 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)).
899
+ * 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).
900
900
  *
901
901
  * ### Booking policy filtering
902
902
  *
903
- * 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)).
903
+ * 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).
904
904
  *
905
905
  * *Default behavior**: When you don't specify any `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status.
906
906
  *
@@ -951,7 +951,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
951
951
  *
952
952
  * Required unless you specify `cursorPaging.cursor`.
953
953
  *
954
- * 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)).
954
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
955
955
  * @minLength 1
956
956
  * @maxLength 150
957
957
  */
@@ -969,7 +969,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
969
969
  bookable?: boolean | null;
970
970
  /**
971
971
  * Indicators for service's booking policy violations.
972
- * 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.
972
+ * 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.
973
973
  */
974
974
  bookingPolicyViolations?: BookingPolicyViolations;
975
975
  /**
@@ -1002,7 +1002,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
1002
1002
  *
1003
1003
  * Only appointment-type services are supported.
1004
1004
  *
1005
- * 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)).
1005
+ * 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).
1006
1006
  * @param services - Services for which the multi-service time slots are returned.
1007
1007
  * You can specify resource filters for each service.
1008
1008
  * @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).
@@ -1012,7 +1012,7 @@ interface ListMultiServiceAvailabilityTimeSlotsOptions {
1012
1012
  * @param timeZone - Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
1013
1013
  * For example, `America/New_York` or `UTC`.
1014
1014
  *
1015
- * 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)).
1015
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1016
1016
  * @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.
1017
1017
  *
1018
1018
  * Required unless you specify `cursorPaging.cursor`.