@wix/auto_sdk_bookings_availability-time-slots 1.0.260 → 1.0.261

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.
@@ -443,225 +443,6 @@ interface GetEventTimeSlotResponse {
443
443
  */
444
444
  timeZone?: string | null;
445
445
  }
446
- interface ListMultiServiceAvailabilityTimeSlotsRequest {
447
- /**
448
- * Services for which the multi-service time slots are returned.
449
- * Each service can include its own resource filters.
450
- *
451
- * Required unless you specify `cursorPaging.cursor`.
452
- *
453
- * Min: 2 services
454
- * Max: 8 services
455
- * @maxSize 8
456
- */
457
- services?: Service[];
458
- /**
459
- * Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
460
- * For example, `2026-01-30T13:30:00`.
461
- * Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`.
462
- *
463
- * Required unless you specify `cursorPaging.cursor`.
464
- * @format LOCAL_DATE_TIME
465
- */
466
- fromLocalDate?: string | null;
467
- /**
468
- * Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
469
- * For example, `2026-01-30T13:30:00`.
470
- * Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`.
471
- *
472
- * Required unless you specify `cursorPaging.cursor`.
473
- * @format LOCAL_DATE_TIME
474
- */
475
- toLocalDate?: string | null;
476
- /**
477
- * 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`.
478
- *
479
- * Required unless you specify `cursorPaging.cursor`.
480
- *
481
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
482
- * @minLength 1
483
- * @maxLength 150
484
- */
485
- timeZone?: string | null;
486
- /**
487
- * 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.
488
- *
489
- * Required unless you specify `cursorPaging.cursor`.
490
- */
491
- location?: Location;
492
- /**
493
- * Whether the time slot is bookable according to all services' booking policies.
494
- * If not specified, returns both bookable and non-bookable time slots.
495
- */
496
- bookable?: boolean | null;
497
- /**
498
- * Indicators for service's booking policy violations.
499
- * 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.
500
- */
501
- bookingPolicyViolations?: BookingPolicyViolations;
502
- /**
503
- * Maximum number of slots to return for each day in the specified time range.
504
- * If `bookable` filter isn't specified, bookable slots are returned first.
505
- */
506
- timeSlotsPerDay?: number | null;
507
- /**
508
- * Cursor-based paging configuration.
509
- * Enables fetching results in smaller chunks by setting a limit on the number of results.
510
- * For consistent pagination behavior, use the same `limit` value throughout a pagination sequence.
511
- * When specifying a new `limit` in follow-up requests, the API respects the new value.
512
- */
513
- cursorPaging?: CursorPaging;
514
- }
515
- interface Service {
516
- /**
517
- * Service ID.
518
- * @format GUID
519
- */
520
- serviceId?: string;
521
- /**
522
- * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
523
- * This is in addition to the specifically requested resources.
524
- *
525
- * <blockquote>
526
- * Currently supported only for Staff Member resource type.
527
- * Staff members belong to resource type ID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
528
- * </blockquote>
529
- * @format GUID
530
- * @maxSize 100
531
- */
532
- includeResourceTypeIds?: string[];
533
- /**
534
- * Selected customer choices.
535
- * If specified, the selected choices are used to calculate service configuration.
536
- * If not specified, the service default configuration is used.
537
- * Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API.
538
- *
539
- * 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.
540
- */
541
- customerChoices?: V2CustomerChoices;
542
- /**
543
- * Resource types to filter time slots.
544
- * Only returns time slots that have these specific resource types available.
545
- * This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
546
- * @maxSize 3
547
- */
548
- resourceTypes?: ResourceType[];
549
- }
550
- /**
551
- * Selected customer choices.
552
- *
553
- * These choices are selected by the customer during the book flow and used to calculate the service's availability configuration.
554
- */
555
- interface V2CustomerChoices {
556
- /**
557
- * 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.
558
- * 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.
559
- *
560
- * Min: `1` minute
561
- * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
562
- * Default: `15` minutes
563
- * @min 1
564
- * @max 44639
565
- */
566
- durationInMinutes?: number | null;
567
- /**
568
- * Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) IDs.
569
- * 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.
570
- *
571
- * Max: 21 (3 add-on groups × 7 add-ons per group).
572
- * @format GUID
573
- * @maxSize 21
574
- */
575
- addOnIds?: string[] | null;
576
- /**
577
- * Selected duration choice ID.
578
- * @format GUID
579
- */
580
- durationChoiceId?: string | null;
581
- }
582
- interface ResourceType {
583
- /**
584
- * [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
585
- * @format GUID
586
- */
587
- resourceTypeId?: string | null;
588
- /**
589
- * Resource IDs.
590
- * Available only if there is at least 1 resource available for the slot.
591
- * @format GUID
592
- * @maxSize 135
593
- */
594
- resourceIds?: string[] | null;
595
- }
596
- interface ListMultiServiceAvailabilityTimeSlotsResponse {
597
- /**
598
- * Retrieved time slots.
599
- * Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
600
- * @maxSize 1000
601
- */
602
- timeSlots?: TimeSlot[];
603
- /**
604
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
605
- * For example, `America/New_York` or `UTC`.
606
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
607
- * @minLength 1
608
- * @maxLength 150
609
- */
610
- timeZone?: string | null;
611
- /**
612
- * Paging metadata for the next page of results.
613
- * Contains a cursor if there are more than 1000 results.
614
- */
615
- cursorPagingMetadata?: CursorPagingMetadata;
616
- }
617
- interface GetMultiServiceAvailabilityTimeSlotRequest {
618
- /**
619
- * Services for which the multi-service time slots are returned.
620
- * You can specify resource filters for each service.
621
- * @minSize 2
622
- * @maxSize 8
623
- */
624
- services?: Service[];
625
- /**
626
- * Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
627
- * For example, `2026-01-30T13:30:00`.
628
- * @format LOCAL_DATE_TIME
629
- */
630
- localStartDate?: string;
631
- /**
632
- * Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
633
- * For example, `2026-01-30T13:30:00`.
634
- * @format LOCAL_DATE_TIME
635
- */
636
- localEndDate?: string;
637
- /**
638
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
639
- * For example, `America/New_York` or `UTC`.
640
- *
641
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
642
- * @minLength 1
643
- * @maxLength 150
644
- */
645
- timeZone?: string | null;
646
- /**
647
- * 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.
648
- *
649
- * Required unless you specify `cursorPaging.cursor`.
650
- */
651
- location?: Location;
652
- }
653
- interface GetMultiServiceAvailabilityTimeSlotResponse {
654
- /** Retrieved time slot. */
655
- timeSlot?: TimeSlot;
656
- /**
657
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
658
- * For example, `America/New_York` or `UTC`.
659
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
660
- * @minLength 1
661
- * @maxLength 150
662
- */
663
- timeZone?: string | null;
664
- }
665
446
  interface ListAvailabilityTimeSlotsRequest {
666
447
  /**
667
448
  * 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.
@@ -1252,6 +1047,211 @@ interface BulkActionMetadata {
1252
1047
  /** Number of failures without details because detailed failure threshold was exceeded. */
1253
1048
  undetailedFailures?: number;
1254
1049
  }
1050
+ interface ListMultiServiceAvailabilityTimeSlotsRequest {
1051
+ /**
1052
+ * Services for which the multi-service time slots are returned.
1053
+ * Each service can include its own resource filters.
1054
+ *
1055
+ * Required unless you specify `cursorPaging.cursor`.
1056
+ *
1057
+ * Min: 2 services
1058
+ * Max: 8 services
1059
+ * @maxSize 8
1060
+ */
1061
+ services?: Service[];
1062
+ /**
1063
+ * Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1064
+ * For example, `2026-01-30T13:30:00`.
1065
+ * Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`.
1066
+ *
1067
+ * Required unless you specify `cursorPaging.cursor`.
1068
+ * @format LOCAL_DATE_TIME
1069
+ */
1070
+ fromLocalDate?: string | null;
1071
+ /**
1072
+ * Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1073
+ * For example, `2026-01-30T13:30:00`.
1074
+ * Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`.
1075
+ *
1076
+ * Required unless you specify `cursorPaging.cursor`.
1077
+ * @format LOCAL_DATE_TIME
1078
+ */
1079
+ toLocalDate?: string | null;
1080
+ /**
1081
+ * 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`.
1082
+ *
1083
+ * Required unless you specify `cursorPaging.cursor`.
1084
+ *
1085
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1086
+ * @minLength 1
1087
+ * @maxLength 150
1088
+ */
1089
+ timeZone?: string | null;
1090
+ /**
1091
+ * 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.
1092
+ *
1093
+ * Required unless you specify `cursorPaging.cursor`.
1094
+ */
1095
+ location?: Location;
1096
+ /**
1097
+ * Whether the time slot is bookable according to all services' booking policies.
1098
+ * If not specified, returns both bookable and non-bookable time slots.
1099
+ */
1100
+ bookable?: boolean | null;
1101
+ /**
1102
+ * Indicators for service's booking policy violations.
1103
+ * 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.
1104
+ */
1105
+ bookingPolicyViolations?: BookingPolicyViolations;
1106
+ /**
1107
+ * Maximum number of slots to return for each day in the specified time range.
1108
+ * If `bookable` filter isn't specified, bookable slots are returned first.
1109
+ */
1110
+ timeSlotsPerDay?: number | null;
1111
+ /**
1112
+ * Cursor-based paging configuration.
1113
+ * Enables fetching results in smaller chunks by setting a limit on the number of results.
1114
+ * For consistent pagination behavior, use the same `limit` value throughout a pagination sequence.
1115
+ * When specifying a new `limit` in follow-up requests, the API respects the new value.
1116
+ */
1117
+ cursorPaging?: CursorPaging;
1118
+ }
1119
+ interface Service {
1120
+ /**
1121
+ * Service ID.
1122
+ * @format GUID
1123
+ */
1124
+ serviceId?: string;
1125
+ /**
1126
+ * Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
1127
+ * This is in addition to the specifically requested resources.
1128
+ *
1129
+ * <blockquote>
1130
+ * Currently supported only for Staff Member resource type.
1131
+ * Staff members belong to resource type ID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
1132
+ * </blockquote>
1133
+ * @format GUID
1134
+ * @maxSize 100
1135
+ */
1136
+ includeResourceTypeIds?: string[];
1137
+ /**
1138
+ * Selected customer choices.
1139
+ * If specified, the selected choices are used to calculate service configuration.
1140
+ * If not specified, the service default configuration is used.
1141
+ * Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API.
1142
+ *
1143
+ * 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.
1144
+ */
1145
+ customerChoices?: V2CustomerChoices;
1146
+ /**
1147
+ * Resource types to filter time slots.
1148
+ * Only returns time slots that have these specific resource types available.
1149
+ * This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
1150
+ * @maxSize 3
1151
+ */
1152
+ resourceTypes?: ResourceType[];
1153
+ }
1154
+ /**
1155
+ * Selected customer choices.
1156
+ *
1157
+ * These choices are selected by the customer during the book flow and used to calculate the service's availability configuration.
1158
+ */
1159
+ interface V2CustomerChoices {
1160
+ /**
1161
+ * 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.
1162
+ * 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.
1163
+ *
1164
+ * Min: `1` minute
1165
+ * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
1166
+ * Default: `15` minutes
1167
+ * @min 1
1168
+ * @max 44639
1169
+ */
1170
+ durationInMinutes?: number | null;
1171
+ /**
1172
+ * Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) IDs.
1173
+ * 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.
1174
+ *
1175
+ * Max: 21 (3 add-on groups × 7 add-ons per group).
1176
+ * @format GUID
1177
+ * @maxSize 21
1178
+ */
1179
+ addOnIds?: string[] | null;
1180
+ /**
1181
+ * Selected duration choice ID.
1182
+ * @format GUID
1183
+ */
1184
+ durationChoiceId?: string | null;
1185
+ }
1186
+ interface ListMultiServiceAvailabilityTimeSlotsResponse {
1187
+ /**
1188
+ * Retrieved time slots.
1189
+ * Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
1190
+ * @maxSize 1000
1191
+ */
1192
+ timeSlots?: TimeSlot[];
1193
+ /**
1194
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
1195
+ * For example, `America/New_York` or `UTC`.
1196
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1197
+ * @minLength 1
1198
+ * @maxLength 150
1199
+ */
1200
+ timeZone?: string | null;
1201
+ /**
1202
+ * Paging metadata for the next page of results.
1203
+ * Contains a cursor if there are more than 1000 results.
1204
+ */
1205
+ cursorPagingMetadata?: CursorPagingMetadata;
1206
+ }
1207
+ interface GetMultiServiceAvailabilityTimeSlotRequest {
1208
+ /**
1209
+ * Services for which the multi-service time slots are returned.
1210
+ * You can specify resource filters for each service.
1211
+ * @minSize 2
1212
+ * @maxSize 8
1213
+ */
1214
+ services?: Service[];
1215
+ /**
1216
+ * Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1217
+ * For example, `2026-01-30T13:30:00`.
1218
+ * @format LOCAL_DATE_TIME
1219
+ */
1220
+ localStartDate?: string;
1221
+ /**
1222
+ * Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1223
+ * For example, `2026-01-30T13:30:00`.
1224
+ * @format LOCAL_DATE_TIME
1225
+ */
1226
+ localEndDate?: string;
1227
+ /**
1228
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
1229
+ * For example, `America/New_York` or `UTC`.
1230
+ *
1231
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1232
+ * @minLength 1
1233
+ * @maxLength 150
1234
+ */
1235
+ timeZone?: string | null;
1236
+ /**
1237
+ * 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.
1238
+ *
1239
+ * Required unless you specify `cursorPaging.cursor`.
1240
+ */
1241
+ location?: Location;
1242
+ }
1243
+ interface GetMultiServiceAvailabilityTimeSlotResponse {
1244
+ /** Retrieved time slot. */
1245
+ timeSlot?: TimeSlot;
1246
+ /**
1247
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
1248
+ * For example, `America/New_York` or `UTC`.
1249
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
1250
+ * @minLength 1
1251
+ * @maxLength 150
1252
+ */
1253
+ timeZone?: string | null;
1254
+ }
1255
1255
  /** @docsIgnore */
1256
1256
  type ListAvailabilityTimeSlotsApplicationErrors = {
1257
1257
  code?: 'NO_IMPLEMENTERS_FOUND';