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