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