@wix/auto_sdk_bookings_availability-time-slots 1.0.260 → 1.0.262
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.
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +14 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +250 -220
- package/build/cjs/index.typings.js +14 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +250 -220
- package/build/cjs/meta.js +14 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +12 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +250 -220
- package/build/es/index.typings.mjs +12 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +250 -220
- package/build/es/meta.mjs +12 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.js +14 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +326 -247
- package/build/internal/cjs/index.typings.js +14 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +326 -247
- package/build/internal/cjs/meta.js +14 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.mjs +12 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +326 -247
- package/build/internal/es/index.typings.mjs +12 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +326 -247
- package/build/internal/es/meta.mjs +12 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -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,33 @@ interface CustomerChoices {
|
|
|
773
554
|
*/
|
|
774
555
|
durationChoiceId?: string | null;
|
|
775
556
|
}
|
|
557
|
+
/** Gender narrowing for an "any staff member" selection. */
|
|
558
|
+
interface RequestedGenderValue {
|
|
559
|
+
/** Gender the customer narrowed "any staff member" to. */
|
|
560
|
+
gender?: RequestedGenderWithLiterals;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* Selectable genders. Staff members of any other gender are reachable
|
|
564
|
+
* through plain "any staff member" or by name.
|
|
565
|
+
*/
|
|
566
|
+
declare enum RequestedGender {
|
|
567
|
+
}
|
|
568
|
+
/** @enumType */
|
|
569
|
+
type RequestedGenderWithLiterals = RequestedGender;
|
|
570
|
+
interface ResourceType {
|
|
571
|
+
/**
|
|
572
|
+
* [Resource type ID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction).
|
|
573
|
+
* @format GUID
|
|
574
|
+
*/
|
|
575
|
+
resourceTypeId?: string | null;
|
|
576
|
+
/**
|
|
577
|
+
* Resource IDs.
|
|
578
|
+
* Available only if there is at least 1 resource available for the slot.
|
|
579
|
+
* @format GUID
|
|
580
|
+
* @maxSize 135
|
|
581
|
+
*/
|
|
582
|
+
resourceIds?: string[] | null;
|
|
583
|
+
}
|
|
776
584
|
interface ListAvailabilityTimeSlotsResponse {
|
|
777
585
|
/**
|
|
778
586
|
* Retrieved time slots.
|
|
@@ -894,6 +702,19 @@ interface GetAvailabilityTimeSlotRequest {
|
|
|
894
702
|
*/
|
|
895
703
|
resourceTypes?: ResourceType[];
|
|
896
704
|
}
|
|
705
|
+
/** Gender narrowing for an "any staff member" selection. */
|
|
706
|
+
interface V2RequestedGenderValue {
|
|
707
|
+
/** Gender the customer narrowed "any staff member" to. */
|
|
708
|
+
gender?: RequestedGenderValueRequestedGenderWithLiterals;
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* Selectable genders. Staff members of any other gender are reachable
|
|
712
|
+
* through plain "any staff member" or by name.
|
|
713
|
+
*/
|
|
714
|
+
declare enum RequestedGenderValueRequestedGender {
|
|
715
|
+
}
|
|
716
|
+
/** @enumType */
|
|
717
|
+
type RequestedGenderValueRequestedGenderWithLiterals = RequestedGenderValueRequestedGender;
|
|
897
718
|
interface GetAvailabilityTimeSlotRequestCustomerChoices {
|
|
898
719
|
/**
|
|
899
720
|
* Selected add-on IDs.
|
|
@@ -1252,6 +1073,211 @@ interface BulkActionMetadata {
|
|
|
1252
1073
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1253
1074
|
undetailedFailures?: number;
|
|
1254
1075
|
}
|
|
1076
|
+
interface ListMultiServiceAvailabilityTimeSlotsRequest {
|
|
1077
|
+
/**
|
|
1078
|
+
* Services for which the multi-service time slots are returned.
|
|
1079
|
+
* Each service can include its own resource filters.
|
|
1080
|
+
*
|
|
1081
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1082
|
+
*
|
|
1083
|
+
* Min: 2 services
|
|
1084
|
+
* Max: 8 services
|
|
1085
|
+
* @maxSize 8
|
|
1086
|
+
*/
|
|
1087
|
+
services?: Service[];
|
|
1088
|
+
/**
|
|
1089
|
+
* Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
1090
|
+
* For example, `2026-01-30T13:30:00`.
|
|
1091
|
+
* Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`.
|
|
1092
|
+
*
|
|
1093
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1094
|
+
* @format LOCAL_DATE_TIME
|
|
1095
|
+
*/
|
|
1096
|
+
fromLocalDate?: string | null;
|
|
1097
|
+
/**
|
|
1098
|
+
* Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
1099
|
+
* For example, `2026-01-30T13:30:00`.
|
|
1100
|
+
* Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`.
|
|
1101
|
+
*
|
|
1102
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1103
|
+
* @format LOCAL_DATE_TIME
|
|
1104
|
+
*/
|
|
1105
|
+
toLocalDate?: string | null;
|
|
1106
|
+
/**
|
|
1107
|
+
* 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`.
|
|
1108
|
+
*
|
|
1109
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1110
|
+
*
|
|
1111
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
1112
|
+
* @minLength 1
|
|
1113
|
+
* @maxLength 150
|
|
1114
|
+
*/
|
|
1115
|
+
timeZone?: string | null;
|
|
1116
|
+
/**
|
|
1117
|
+
* 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.
|
|
1118
|
+
*
|
|
1119
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1120
|
+
*/
|
|
1121
|
+
location?: Location;
|
|
1122
|
+
/**
|
|
1123
|
+
* Whether the time slot is bookable according to all services' booking policies.
|
|
1124
|
+
* If not specified, returns both bookable and non-bookable time slots.
|
|
1125
|
+
*/
|
|
1126
|
+
bookable?: boolean | null;
|
|
1127
|
+
/**
|
|
1128
|
+
* Indicators for service's booking policy violations.
|
|
1129
|
+
* 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.
|
|
1130
|
+
*/
|
|
1131
|
+
bookingPolicyViolations?: BookingPolicyViolations;
|
|
1132
|
+
/**
|
|
1133
|
+
* Maximum number of slots to return for each day in the specified time range.
|
|
1134
|
+
* If `bookable` filter isn't specified, bookable slots are returned first.
|
|
1135
|
+
*/
|
|
1136
|
+
timeSlotsPerDay?: number | null;
|
|
1137
|
+
/**
|
|
1138
|
+
* Cursor-based paging configuration.
|
|
1139
|
+
* Enables fetching results in smaller chunks by setting a limit on the number of results.
|
|
1140
|
+
* For consistent pagination behavior, use the same `limit` value throughout a pagination sequence.
|
|
1141
|
+
* When specifying a new `limit` in follow-up requests, the API respects the new value.
|
|
1142
|
+
*/
|
|
1143
|
+
cursorPaging?: CursorPaging;
|
|
1144
|
+
}
|
|
1145
|
+
interface Service {
|
|
1146
|
+
/**
|
|
1147
|
+
* Service ID.
|
|
1148
|
+
* @format GUID
|
|
1149
|
+
*/
|
|
1150
|
+
serviceId?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Resource [type IDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction) to include in returned time slots.
|
|
1153
|
+
* This is in addition to the specifically requested resources.
|
|
1154
|
+
*
|
|
1155
|
+
* <blockquote>
|
|
1156
|
+
* Currently supported only for Staff Member resource type.
|
|
1157
|
+
* Staff members belong to resource type ID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
|
|
1158
|
+
* </blockquote>
|
|
1159
|
+
* @format GUID
|
|
1160
|
+
* @maxSize 100
|
|
1161
|
+
*/
|
|
1162
|
+
includeResourceTypeIds?: string[];
|
|
1163
|
+
/**
|
|
1164
|
+
* Selected customer choices.
|
|
1165
|
+
* If specified, the selected choices are used to calculate service configuration.
|
|
1166
|
+
* If not specified, the service default configuration is used.
|
|
1167
|
+
* Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API.
|
|
1168
|
+
*
|
|
1169
|
+
* 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.
|
|
1170
|
+
*/
|
|
1171
|
+
customerChoices?: V2CustomerChoices;
|
|
1172
|
+
/**
|
|
1173
|
+
* Resource types to filter time slots.
|
|
1174
|
+
* Only returns time slots that have these specific resource types available.
|
|
1175
|
+
* This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
|
|
1176
|
+
* @maxSize 3
|
|
1177
|
+
*/
|
|
1178
|
+
resourceTypes?: ResourceType[];
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* Selected customer choices.
|
|
1182
|
+
*
|
|
1183
|
+
* These choices are selected by the customer during the book flow and used to calculate the service's availability configuration.
|
|
1184
|
+
*/
|
|
1185
|
+
interface V2CustomerChoices {
|
|
1186
|
+
/**
|
|
1187
|
+
* 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.
|
|
1188
|
+
* 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.
|
|
1189
|
+
*
|
|
1190
|
+
* Min: `1` minute
|
|
1191
|
+
* Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
|
|
1192
|
+
* Default: `15` minutes
|
|
1193
|
+
* @min 1
|
|
1194
|
+
* @max 44639
|
|
1195
|
+
*/
|
|
1196
|
+
durationInMinutes?: number | null;
|
|
1197
|
+
/**
|
|
1198
|
+
* Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) IDs.
|
|
1199
|
+
* 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.
|
|
1200
|
+
*
|
|
1201
|
+
* Max: 21 (3 add-on groups × 7 add-ons per group).
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
* @maxSize 21
|
|
1204
|
+
*/
|
|
1205
|
+
addOnIds?: string[] | null;
|
|
1206
|
+
/**
|
|
1207
|
+
* Selected duration choice ID.
|
|
1208
|
+
* @format GUID
|
|
1209
|
+
*/
|
|
1210
|
+
durationChoiceId?: string | null;
|
|
1211
|
+
}
|
|
1212
|
+
interface ListMultiServiceAvailabilityTimeSlotsResponse {
|
|
1213
|
+
/**
|
|
1214
|
+
* Retrieved time slots.
|
|
1215
|
+
* Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
|
|
1216
|
+
* @maxSize 1000
|
|
1217
|
+
*/
|
|
1218
|
+
timeSlots?: TimeSlot[];
|
|
1219
|
+
/**
|
|
1220
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
|
|
1221
|
+
* For example, `America/New_York` or `UTC`.
|
|
1222
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
1223
|
+
* @minLength 1
|
|
1224
|
+
* @maxLength 150
|
|
1225
|
+
*/
|
|
1226
|
+
timeZone?: string | null;
|
|
1227
|
+
/**
|
|
1228
|
+
* Paging metadata for the next page of results.
|
|
1229
|
+
* Contains a cursor if there are more than 1000 results.
|
|
1230
|
+
*/
|
|
1231
|
+
cursorPagingMetadata?: CursorPagingMetadata;
|
|
1232
|
+
}
|
|
1233
|
+
interface GetMultiServiceAvailabilityTimeSlotRequest {
|
|
1234
|
+
/**
|
|
1235
|
+
* Services for which the multi-service time slots are returned.
|
|
1236
|
+
* You can specify resource filters for each service.
|
|
1237
|
+
* @minSize 2
|
|
1238
|
+
* @maxSize 8
|
|
1239
|
+
*/
|
|
1240
|
+
services?: Service[];
|
|
1241
|
+
/**
|
|
1242
|
+
* Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
1243
|
+
* For example, `2026-01-30T13:30:00`.
|
|
1244
|
+
* @format LOCAL_DATE_TIME
|
|
1245
|
+
*/
|
|
1246
|
+
localStartDate?: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
1249
|
+
* For example, `2026-01-30T13:30:00`.
|
|
1250
|
+
* @format LOCAL_DATE_TIME
|
|
1251
|
+
*/
|
|
1252
|
+
localEndDate?: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values.
|
|
1255
|
+
* For example, `America/New_York` or `UTC`.
|
|
1256
|
+
*
|
|
1257
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
1258
|
+
* @minLength 1
|
|
1259
|
+
* @maxLength 150
|
|
1260
|
+
*/
|
|
1261
|
+
timeZone?: string | null;
|
|
1262
|
+
/**
|
|
1263
|
+
* 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.
|
|
1264
|
+
*
|
|
1265
|
+
* Required unless you specify `cursorPaging.cursor`.
|
|
1266
|
+
*/
|
|
1267
|
+
location?: Location;
|
|
1268
|
+
}
|
|
1269
|
+
interface GetMultiServiceAvailabilityTimeSlotResponse {
|
|
1270
|
+
/** Retrieved time slot. */
|
|
1271
|
+
timeSlot?: TimeSlot;
|
|
1272
|
+
/**
|
|
1273
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
|
|
1274
|
+
* For example, `America/New_York` or `UTC`.
|
|
1275
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
1276
|
+
* @minLength 1
|
|
1277
|
+
* @maxLength 150
|
|
1278
|
+
*/
|
|
1279
|
+
timeZone?: string | null;
|
|
1280
|
+
}
|
|
1255
1281
|
/** @docsIgnore */
|
|
1256
1282
|
type ListAvailabilityTimeSlotsApplicationErrors = {
|
|
1257
1283
|
code?: 'NO_IMPLEMENTERS_FOUND';
|
|
@@ -1273,6 +1299,10 @@ type ListAvailabilityTimeSlotsApplicationErrors = {
|
|
|
1273
1299
|
code?: 'SERVICE_NOT_FOUND';
|
|
1274
1300
|
description?: string;
|
|
1275
1301
|
data?: Record<string, any>;
|
|
1302
|
+
} | {
|
|
1303
|
+
code?: 'REQUESTED_GENDER_NOT_ALLOWED';
|
|
1304
|
+
description?: string;
|
|
1305
|
+
data?: Record<string, any>;
|
|
1276
1306
|
};
|
|
1277
1307
|
/** @docsIgnore */
|
|
1278
1308
|
type ListAvailabilityTimeSlotEndOptionsApplicationErrors = {
|
|
@@ -1627,4 +1657,4 @@ interface GetAvailabilityTimeSlotOptions {
|
|
|
1627
1657
|
resourceTypes?: ResourceType[];
|
|
1628
1658
|
}
|
|
1629
1659
|
|
|
1630
|
-
export { type ApplicationError, type AvailableResources, type BookingPolicyViolations, type BulkActionMetadata, type BulkListAvailabilityTimeSlotsRequest, type BulkListAvailabilityTimeSlotsResponse, type BulkServiceTimeSlotsResult, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomerChoices, type DiagnoseAvailabilityRequest, type DiagnoseAvailabilityResponse, type DiagnosisReason, type EventInfo, type GetAvailabilityTimeSlotApplicationErrors, type GetAvailabilityTimeSlotOptions, type GetAvailabilityTimeSlotRequest, type GetAvailabilityTimeSlotRequestCustomerChoices, type GetAvailabilityTimeSlotResponse, type GetEventTimeSlotRequest, type GetEventTimeSlotResponse, type GetMultiServiceAvailabilityTimeSlotRequest, type GetMultiServiceAvailabilityTimeSlotResponse, type ItemMetadata, type ListAvailabilityTimeSlotEndOptions, type ListAvailabilityTimeSlotEndOptionsApplicationErrors, type ListAvailabilityTimeSlotEndOptionsRequest, type ListAvailabilityTimeSlotEndOptionsResponse, type ListAvailabilityTimeSlotsApplicationErrors, type ListAvailabilityTimeSlotsOptions, type ListAvailabilityTimeSlotsRequest, type ListAvailabilityTimeSlotsResponse, type ListEventTimeSlotsRequest, type ListEventTimeSlotsResponse, type ListMultiServiceAvailabilityTimeSlotsRequest, type ListMultiServiceAvailabilityTimeSlotsResponse, type Location, LocationType, type LocationTypeWithLiterals, type NestedTimeSlot, type NonBookableReasons, ReasonCode, type ReasonCodeWithLiterals, type ResolvedContext, type Resource, type ResourceType, type Service, type ServiceTimeSlots, SuggestedAction, type SuggestedActionWithLiterals, type TimeSlot, type V2CustomerChoices, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlotEndOptions, listAvailabilityTimeSlots };
|
|
1660
|
+
export { type ApplicationError, type AvailableResources, type BookingPolicyViolations, type BulkActionMetadata, type BulkListAvailabilityTimeSlotsRequest, type BulkListAvailabilityTimeSlotsResponse, type BulkServiceTimeSlotsResult, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomerChoices, type DiagnoseAvailabilityRequest, type DiagnoseAvailabilityResponse, type DiagnosisReason, type EventInfo, type GetAvailabilityTimeSlotApplicationErrors, type GetAvailabilityTimeSlotOptions, type GetAvailabilityTimeSlotRequest, type GetAvailabilityTimeSlotRequestCustomerChoices, type GetAvailabilityTimeSlotResponse, type GetEventTimeSlotRequest, type GetEventTimeSlotResponse, type GetMultiServiceAvailabilityTimeSlotRequest, type GetMultiServiceAvailabilityTimeSlotResponse, type ItemMetadata, type ListAvailabilityTimeSlotEndOptions, type ListAvailabilityTimeSlotEndOptionsApplicationErrors, type ListAvailabilityTimeSlotEndOptionsRequest, type ListAvailabilityTimeSlotEndOptionsResponse, type ListAvailabilityTimeSlotsApplicationErrors, type ListAvailabilityTimeSlotsOptions, type ListAvailabilityTimeSlotsRequest, type ListAvailabilityTimeSlotsResponse, type ListEventTimeSlotsRequest, type ListEventTimeSlotsResponse, type ListMultiServiceAvailabilityTimeSlotsRequest, type ListMultiServiceAvailabilityTimeSlotsResponse, type Location, LocationType, type LocationTypeWithLiterals, type NestedTimeSlot, type NonBookableReasons, ReasonCode, type ReasonCodeWithLiterals, RequestedGender, type RequestedGenderValue, RequestedGenderValueRequestedGender, type RequestedGenderValueRequestedGenderWithLiterals, type RequestedGenderWithLiterals, type ResolvedContext, type Resource, type ResourceType, type Service, type ServiceTimeSlots, SuggestedAction, type SuggestedActionWithLiterals, type TimeSlot, type V2CustomerChoices, type V2RequestedGenderValue, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlotEndOptions, listAvailabilityTimeSlots };
|
|
@@ -22,6 +22,8 @@ var index_typings_exports = {};
|
|
|
22
22
|
__export(index_typings_exports, {
|
|
23
23
|
LocationType: () => LocationType,
|
|
24
24
|
ReasonCode: () => ReasonCode,
|
|
25
|
+
RequestedGender: () => RequestedGender,
|
|
26
|
+
RequestedGenderValueRequestedGender: () => RequestedGenderValueRequestedGender,
|
|
25
27
|
SuggestedAction: () => SuggestedAction,
|
|
26
28
|
getAvailabilityTimeSlot: () => getAvailabilityTimeSlot2,
|
|
27
29
|
listAvailabilityTimeSlotEndOptions: () => listAvailabilityTimeSlotEndOptions2,
|
|
@@ -273,6 +275,16 @@ var LocationType = /* @__PURE__ */ ((LocationType2) => {
|
|
|
273
275
|
LocationType2["CUSTOMER"] = "CUSTOMER";
|
|
274
276
|
return LocationType2;
|
|
275
277
|
})(LocationType || {});
|
|
278
|
+
var RequestedGender = /* @__PURE__ */ ((RequestedGender2) => {
|
|
279
|
+
RequestedGender2["ANY_MALE"] = "ANY_MALE";
|
|
280
|
+
RequestedGender2["ANY_FEMALE"] = "ANY_FEMALE";
|
|
281
|
+
return RequestedGender2;
|
|
282
|
+
})(RequestedGender || {});
|
|
283
|
+
var RequestedGenderValueRequestedGender = /* @__PURE__ */ ((RequestedGenderValueRequestedGender2) => {
|
|
284
|
+
RequestedGenderValueRequestedGender2["ANY_MALE"] = "ANY_MALE";
|
|
285
|
+
RequestedGenderValueRequestedGender2["ANY_FEMALE"] = "ANY_FEMALE";
|
|
286
|
+
return RequestedGenderValueRequestedGender2;
|
|
287
|
+
})(RequestedGenderValueRequestedGender || {});
|
|
276
288
|
var ReasonCode = /* @__PURE__ */ ((ReasonCode2) => {
|
|
277
289
|
ReasonCode2["NO_ASSIGNED_STAFF_OR_RESOURCES"] = "NO_ASSIGNED_STAFF_OR_RESOURCES";
|
|
278
290
|
ReasonCode2["SERVICE_AVAILABILITY_CONFIGURATION_MISSING"] = "SERVICE_AVAILABILITY_CONFIGURATION_MISSING";
|
|
@@ -442,6 +454,8 @@ async function getAvailabilityTimeSlot2(serviceId, localStartDate, localEndDate,
|
|
|
442
454
|
0 && (module.exports = {
|
|
443
455
|
LocationType,
|
|
444
456
|
ReasonCode,
|
|
457
|
+
RequestedGender,
|
|
458
|
+
RequestedGenderValueRequestedGender,
|
|
445
459
|
SuggestedAction,
|
|
446
460
|
getAvailabilityTimeSlot,
|
|
447
461
|
listAvailabilityTimeSlotEndOptions,
|