@wix/auto_sdk_bookings_availability-time-slots 1.0.249 → 1.0.250

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.
@@ -444,225 +444,6 @@ interface GetEventTimeSlotResponse {
444
444
  */
445
445
  timeZone?: string | null;
446
446
  }
447
- interface ListMultiServiceAvailabilityTimeSlotsRequest {
448
- /**
449
- * Services for which the multi-service time slots are returned.
450
- * Each service can include its own resource filters.
451
- *
452
- * Required unless you specify `cursorPaging.cursor`.
453
- *
454
- * Min: 2 services
455
- * Max: 8 services
456
- * @maxSize 8
457
- */
458
- services?: Service[];
459
- /**
460
- * Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
461
- * For example, `2026-01-30T13:30:00`.
462
- * Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`.
463
- *
464
- * Required unless you specify `cursorPaging.cursor`.
465
- * @format LOCAL_DATE_TIME
466
- */
467
- fromLocalDate?: string | null;
468
- /**
469
- * Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
470
- * For example, `2026-01-30T13:30:00`.
471
- * Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`.
472
- *
473
- * Required unless you specify `cursorPaging.cursor`.
474
- * @format LOCAL_DATE_TIME
475
- */
476
- toLocalDate?: string | null;
477
- /**
478
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values. For example, `America/New_York` or `UTC`.
479
- *
480
- * Required unless you specify `cursorPaging.cursor`.
481
- *
482
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
483
- * @minLength 1
484
- * @maxLength 150
485
- */
486
- timeZone?: string | null;
487
- /**
488
- * Location for which the multi-service time slots are returned. If you filter by `{"type": "BUSINESS"}`, you must also specify a location ID. Filters for `location.name` and `location.formattedAddress` are ignored.
489
- *
490
- * Required unless you specify `cursorPaging.cursor`.
491
- */
492
- location?: Location;
493
- /**
494
- * Whether the time slot is bookable according to all services' booking policies.
495
- * If not specified, returns both bookable and non-bookable time slots.
496
- */
497
- bookable?: boolean | null;
498
- /**
499
- * Indicators for service's booking policy violations.
500
- * 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.
501
- */
502
- bookingPolicyViolations?: BookingPolicyViolations;
503
- /**
504
- * Maximum number of slots to return for each day in the specified time range.
505
- * If `bookable` filter isn't specified, bookable slots are returned first.
506
- */
507
- timeSlotsPerDay?: number | null;
508
- /**
509
- * Cursor-based paging configuration.
510
- * Enables fetching results in smaller chunks by setting a limit on the number of results.
511
- * For consistent pagination behavior, use the same `limit` value throughout a pagination sequence.
512
- * When specifying a new `limit` in follow-up requests, the API respects the new value.
513
- */
514
- cursorPaging?: CursorPaging;
515
- }
516
- interface Service {
517
- /**
518
- * Service ID.
519
- * @format GUID
520
- */
521
- serviceId?: string;
522
- /**
523
- * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
524
- * This is in addition to the specifically requested resources.
525
- *
526
- * <blockquote>
527
- * Currently supported only for Staff Member resource type.
528
- * Staff members belong to resource type ID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
529
- * </blockquote>
530
- * @format GUID
531
- * @maxSize 100
532
- */
533
- includeResourceTypeIds?: string[];
534
- /**
535
- * Selected customer choices.
536
- * If specified, the selected choices are used to calculate service configuration.
537
- * If not specified, the service default configuration is used.
538
- * Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API.
539
- *
540
- * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
541
- */
542
- customerChoices?: V2CustomerChoices;
543
- /**
544
- * Resource types to filter time slots.
545
- * Only returns time slots that have these specific resource types available.
546
- * This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
547
- * @maxSize 3
548
- */
549
- resourceTypes?: ResourceType[];
550
- }
551
- /**
552
- * Selected customer choices.
553
- *
554
- * These choices are selected by the customer during the book flow and used to calculate the service's availability configuration.
555
- */
556
- interface V2CustomerChoices {
557
- /**
558
- * Selected duration in minutes, based on a [service variant](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction) the customer chose.
559
- * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` instead of `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
560
- *
561
- * Min: `1` minute
562
- * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
563
- * Default: `15` minutes
564
- * @min 1
565
- * @max 44639
566
- */
567
- durationInMinutes?: number | null;
568
- /**
569
- * Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) IDs.
570
- * When specifying this field, we recommend omitting `durationInMinutes`. Wix Bookings then calculates the total duration based on the service duration plus all selected add-on durations.
571
- *
572
- * Max: 21 (3 add-on groups × 7 add-ons per group).
573
- * @format GUID
574
- * @maxSize 21
575
- */
576
- addOnIds?: string[] | null;
577
- /**
578
- * Selected duration choice ID.
579
- * @format GUID
580
- */
581
- durationChoiceId?: string | null;
582
- }
583
- interface ResourceType {
584
- /**
585
- * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
586
- * @format GUID
587
- */
588
- resourceTypeId?: string | null;
589
- /**
590
- * Resource IDs.
591
- * Available only if there is at least 1 resource available for the slot.
592
- * @format GUID
593
- * @maxSize 135
594
- */
595
- resourceIds?: string[] | null;
596
- }
597
- interface ListMultiServiceAvailabilityTimeSlotsResponse {
598
- /**
599
- * Retrieved time slots.
600
- * Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
601
- * @maxSize 1000
602
- */
603
- timeSlots?: TimeSlot[];
604
- /**
605
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
606
- * For example, `America/New_York` or `UTC`.
607
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
608
- * @minLength 1
609
- * @maxLength 150
610
- */
611
- timeZone?: string | null;
612
- /**
613
- * Paging metadata for the next page of results.
614
- * Contains a cursor if there are more than 1000 results.
615
- */
616
- cursorPagingMetadata?: CursorPagingMetadata;
617
- }
618
- interface GetMultiServiceAvailabilityTimeSlotRequest {
619
- /**
620
- * Services for which the multi-service time slots are returned.
621
- * You can specify resource filters for each service.
622
- * @minSize 2
623
- * @maxSize 8
624
- */
625
- services?: Service[];
626
- /**
627
- * Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
628
- * For example, `2026-01-30T13:30:00`.
629
- * @format LOCAL_DATE_TIME
630
- */
631
- localStartDate?: string;
632
- /**
633
- * Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
634
- * For example, `2026-01-30T13:30:00`.
635
- * @format LOCAL_DATE_TIME
636
- */
637
- localEndDate?: string;
638
- /**
639
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
640
- * For example, `America/New_York` or `UTC`.
641
- *
642
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
643
- * @minLength 1
644
- * @maxLength 150
645
- */
646
- timeZone?: string | null;
647
- /**
648
- * 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.
649
- *
650
- * Required unless you specify `cursorPaging.cursor`.
651
- */
652
- location?: Location;
653
- }
654
- interface GetMultiServiceAvailabilityTimeSlotResponse {
655
- /** Retrieved time slot. */
656
- timeSlot?: TimeSlot;
657
- /**
658
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
659
- * For example, `America/New_York` or `UTC`.
660
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
661
- * @minLength 1
662
- * @maxLength 150
663
- */
664
- timeZone?: string | null;
665
- }
666
447
  interface ListAvailabilityTimeSlotsRequest {
667
448
  /**
668
449
  * Service ID for which to retrieve time slots. You must specify the ID of an appointment-based service.
@@ -772,6 +553,20 @@ interface CustomerChoices {
772
553
  */
773
554
  durationChoiceId?: string | null;
774
555
  }
556
+ interface ResourceType {
557
+ /**
558
+ * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
559
+ * @format GUID
560
+ */
561
+ resourceTypeId?: string | null;
562
+ /**
563
+ * Resource IDs.
564
+ * Available only if there is at least 1 resource available for the slot.
565
+ * @format GUID
566
+ * @maxSize 135
567
+ */
568
+ resourceIds?: string[] | null;
569
+ }
775
570
  interface ListAvailabilityTimeSlotsResponse {
776
571
  /**
777
572
  * Retrieved time slots.
@@ -1089,6 +884,211 @@ interface ResolvedContext {
1089
884
  */
1090
885
  timeZone?: string | null;
1091
886
  }
887
+ interface ListMultiServiceAvailabilityTimeSlotsRequest {
888
+ /**
889
+ * Services for which the multi-service time slots are returned.
890
+ * Each service can include its own resource filters.
891
+ *
892
+ * Required unless you specify `cursorPaging.cursor`.
893
+ *
894
+ * Min: 2 services
895
+ * Max: 8 services
896
+ * @maxSize 8
897
+ */
898
+ services?: Service[];
899
+ /**
900
+ * Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
901
+ * For example, `2026-01-30T13:30:00`.
902
+ * Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`.
903
+ *
904
+ * Required unless you specify `cursorPaging.cursor`.
905
+ * @format LOCAL_DATE_TIME
906
+ */
907
+ fromLocalDate?: string | null;
908
+ /**
909
+ * Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
910
+ * For example, `2026-01-30T13:30:00`.
911
+ * Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`.
912
+ *
913
+ * Required unless you specify `cursorPaging.cursor`.
914
+ * @format LOCAL_DATE_TIME
915
+ */
916
+ toLocalDate?: string | null;
917
+ /**
918
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values. For example, `America/New_York` or `UTC`.
919
+ *
920
+ * Required unless you specify `cursorPaging.cursor`.
921
+ *
922
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
923
+ * @minLength 1
924
+ * @maxLength 150
925
+ */
926
+ timeZone?: string | null;
927
+ /**
928
+ * Location for which the multi-service time slots are returned. If you filter by `{"type": "BUSINESS"}`, you must also specify a location ID. Filters for `location.name` and `location.formattedAddress` are ignored.
929
+ *
930
+ * Required unless you specify `cursorPaging.cursor`.
931
+ */
932
+ location?: Location;
933
+ /**
934
+ * Whether the time slot is bookable according to all services' booking policies.
935
+ * If not specified, returns both bookable and non-bookable time slots.
936
+ */
937
+ bookable?: boolean | null;
938
+ /**
939
+ * Indicators for service's booking policy violations.
940
+ * 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.
941
+ */
942
+ bookingPolicyViolations?: BookingPolicyViolations;
943
+ /**
944
+ * Maximum number of slots to return for each day in the specified time range.
945
+ * If `bookable` filter isn't specified, bookable slots are returned first.
946
+ */
947
+ timeSlotsPerDay?: number | null;
948
+ /**
949
+ * Cursor-based paging configuration.
950
+ * Enables fetching results in smaller chunks by setting a limit on the number of results.
951
+ * For consistent pagination behavior, use the same `limit` value throughout a pagination sequence.
952
+ * When specifying a new `limit` in follow-up requests, the API respects the new value.
953
+ */
954
+ cursorPaging?: CursorPaging;
955
+ }
956
+ interface Service {
957
+ /**
958
+ * Service ID.
959
+ * @format GUID
960
+ */
961
+ serviceId?: string;
962
+ /**
963
+ * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
964
+ * This is in addition to the specifically requested resources.
965
+ *
966
+ * <blockquote>
967
+ * Currently supported only for Staff Member resource type.
968
+ * Staff members belong to resource type ID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
969
+ * </blockquote>
970
+ * @format GUID
971
+ * @maxSize 100
972
+ */
973
+ includeResourceTypeIds?: string[];
974
+ /**
975
+ * Selected customer choices.
976
+ * If specified, the selected choices are used to calculate service configuration.
977
+ * If not specified, the service default configuration is used.
978
+ * Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API.
979
+ *
980
+ * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
981
+ */
982
+ customerChoices?: V2CustomerChoices;
983
+ /**
984
+ * Resource types to filter time slots.
985
+ * Only returns time slots that have these specific resource types available.
986
+ * This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
987
+ * @maxSize 3
988
+ */
989
+ resourceTypes?: ResourceType[];
990
+ }
991
+ /**
992
+ * Selected customer choices.
993
+ *
994
+ * These choices are selected by the customer during the book flow and used to calculate the service's availability configuration.
995
+ */
996
+ interface V2CustomerChoices {
997
+ /**
998
+ * Selected duration in minutes, based on a [service variant](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction) the customer chose.
999
+ * When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction), we recommend passing only `addOnIds` instead of `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations.
1000
+ *
1001
+ * Min: `1` minute
1002
+ * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
1003
+ * Default: `15` minutes
1004
+ * @min 1
1005
+ * @max 44639
1006
+ */
1007
+ durationInMinutes?: number | null;
1008
+ /**
1009
+ * Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) IDs.
1010
+ * When specifying this field, we recommend omitting `durationInMinutes`. Wix Bookings then calculates the total duration based on the service duration plus all selected add-on durations.
1011
+ *
1012
+ * Max: 21 (3 add-on groups × 7 add-ons per group).
1013
+ * @format GUID
1014
+ * @maxSize 21
1015
+ */
1016
+ addOnIds?: string[] | null;
1017
+ /**
1018
+ * Selected duration choice ID.
1019
+ * @format GUID
1020
+ */
1021
+ durationChoiceId?: string | null;
1022
+ }
1023
+ interface ListMultiServiceAvailabilityTimeSlotsResponse {
1024
+ /**
1025
+ * Retrieved time slots.
1026
+ * Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
1027
+ * @maxSize 1000
1028
+ */
1029
+ timeSlots?: TimeSlot[];
1030
+ /**
1031
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
1032
+ * For example, `America/New_York` or `UTC`.
1033
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1034
+ * @minLength 1
1035
+ * @maxLength 150
1036
+ */
1037
+ timeZone?: string | null;
1038
+ /**
1039
+ * Paging metadata for the next page of results.
1040
+ * Contains a cursor if there are more than 1000 results.
1041
+ */
1042
+ cursorPagingMetadata?: CursorPagingMetadata;
1043
+ }
1044
+ interface GetMultiServiceAvailabilityTimeSlotRequest {
1045
+ /**
1046
+ * Services for which the multi-service time slots are returned.
1047
+ * You can specify resource filters for each service.
1048
+ * @minSize 2
1049
+ * @maxSize 8
1050
+ */
1051
+ services?: Service[];
1052
+ /**
1053
+ * Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1054
+ * For example, `2026-01-30T13:30:00`.
1055
+ * @format LOCAL_DATE_TIME
1056
+ */
1057
+ localStartDate?: string;
1058
+ /**
1059
+ * Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1060
+ * For example, `2026-01-30T13:30:00`.
1061
+ * @format LOCAL_DATE_TIME
1062
+ */
1063
+ localEndDate?: string;
1064
+ /**
1065
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
1066
+ * For example, `America/New_York` or `UTC`.
1067
+ *
1068
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1069
+ * @minLength 1
1070
+ * @maxLength 150
1071
+ */
1072
+ timeZone?: string | null;
1073
+ /**
1074
+ * 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.
1075
+ *
1076
+ * Required unless you specify `cursorPaging.cursor`.
1077
+ */
1078
+ location?: Location;
1079
+ }
1080
+ interface GetMultiServiceAvailabilityTimeSlotResponse {
1081
+ /** Retrieved time slot. */
1082
+ timeSlot?: TimeSlot;
1083
+ /**
1084
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
1085
+ * For example, `America/New_York` or `UTC`.
1086
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1087
+ * @minLength 1
1088
+ * @maxLength 150
1089
+ */
1090
+ timeZone?: string | null;
1091
+ }
1092
1092
  /** @docsIgnore */
1093
1093
  type ListAvailabilityTimeSlotsApplicationErrors = {
1094
1094
  code?: 'NO_IMPLEMENTERS_FOUND';