@wix/auto_sdk_bookings_availability-time-slots 1.0.254 → 1.0.256

package/build/cjs/meta.d.ts

@@ -1079,6 +1079,178 @@ interface ResolvedContext {
      */
     timeZone?: string | null;
 }
+interface BulkListAvailabilityTimeSlotsRequest {
+    /**
+     * IDs of the appointment-based services to retrieve time slots for.
+     * Non-appointment services and IDs that don't exist are returned as failed entries in `results`.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    serviceIds?: string[];
+    /**
+     * Lower boundary for `localStartDate` to include, applied to every service.
+     * Each returned time slot has a `localStartDate` within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Local start date in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2026-01-30T13:30:00`.
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Upper boundary for `localStartDate` to include, applied to every service.
+     * Each returned time slot has a `localStartDate` within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Local end date in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2026-01-30T13:30:00`.
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`.
+     * For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /**
+     * Whether the time slot is bookable according to each service's booking policies.
+     * If not specified, returns both bookable and un-bookable time slots.
+     */
+    bookable?: boolean | null;
+    /**
+     * Maximum number of slots to return per service for each day in the specified time range.
+     * If `bookable` filter isn't specified, bookable slots are returned first.
+     *
+     * Min: `1`.
+     * @min 1
+     */
+    timeSlotsPerDay?: number | null;
+    /**
+     * Maximum number of time slots to return per service.
+     *
+     * Min: `1`. Max: `1000`.
+     *
+     * Default: `1000`.
+     * @min 1
+     * @max 1000
+     */
+    limitPerService?: number | null;
+    /**
+     * Locations to include in response, applied to every service.
+     * If not specified, returns time slots for all locations where each service is available.
+     * @maxSize 5
+     */
+    locations?: Location[];
+    /**
+     * Resource type IDs to include in the response, applied to every service.
+     * If specified, returns up to 10 `availableResources` with matching `resourceTypeId`.
+     * This controls which resource details are included in the response but doesn't filter the time slots themselves.
+     * @format GUID
+     * @maxSize 100
+     */
+    includeResourceTypeIds?: string[];
+    /**
+     * Indicators for services' booking policy violations, applied to every service.
+     * 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.
+     */
+    bookingPolicyViolations?: BookingPolicyViolations;
+    /**
+     * Selected customer choices for service configuration, applied to every service.
+     * If not specified, uses each service's default configuration.
+     *
+     * Not supported for services configured with a duration range (`availabilityConstraints.durationRange`).
+     *
+     * 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.
+     */
+    customerChoices?: CustomerChoices;
+    /**
+     * Resource types to filter time slots, applied to every service.
+     * Only returns time slots that have these specific resource types available.
+     * This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details.
+     * @maxSize 3
+     */
+    resourceTypes?: ResourceType[];
+}
+interface BulkListAvailabilityTimeSlotsResponse {
+    /**
+     * Per-service results, one entry per requested `serviceId`.
+     * Each entry carries `itemMetadata` with the outcome, and `serviceTimeSlots` on success.
+     * Order isn't guaranteed to match the request; correlate via `itemMetadata.id` or `itemMetadata.originalIndex`.
+     * @maxSize 100
+     */
+    results?: BulkServiceTimeSlotsResult[];
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) used for all services.
+     * For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /** Success and failure totals across all requested services. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkServiceTimeSlotsResult {
+    /**
+     * Outcome for a single requested service.
+     * `id` echoes the `serviceId`, `originalIndex` is the service's position in the request, and
+     * `success`/`error` describe whether availability could be computed.
+     */
+    itemMetadata?: ItemMetadata;
+    /** Time slots for the service. Populated only when `itemMetadata.success` is `true`. */
+    serviceTimeSlots?: ServiceTimeSlots;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface ServiceTimeSlots {
+    /**
+     * Service the time slots belong to.
+     * @format GUID
+     */
+    serviceId?: string;
+    /**
+     * Retrieved time slots for the service.
+     * Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed.
+     * @maxSize 1000
+     */
+    timeSlots?: TimeSlot[];
+    /**
+     * Paging metadata for the service's remaining slots.
+     * To fetch more slots for this service, pass `cursors.next` to `ListAvailabilityTimeSlots`.
+     */
+    cursorPagingMetadata?: CursorPagingMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 /** @docsIgnore */
 type ListAvailabilityTimeSlotsApplicationErrors = {
     code?: 'NO_IMPLEMENTERS_FOUND';
@@ -1160,4 +1332,4 @@ declare function listAvailabilityTimeSlots(): __PublicMethodMetaInfo<'POST', {},
 declare function listAvailabilityTimeSlotEndOptions(): __PublicMethodMetaInfo<'POST', {}, ListAvailabilityTimeSlotEndOptionsRequest$1, ListAvailabilityTimeSlotEndOptionsRequest, ListAvailabilityTimeSlotEndOptionsResponse$1, ListAvailabilityTimeSlotEndOptionsResponse>;
 declare function getAvailabilityTimeSlot(): __PublicMethodMetaInfo<'POST', {}, GetAvailabilityTimeSlotRequest$1, GetAvailabilityTimeSlotRequest, GetAvailabilityTimeSlotResponse$1, GetAvailabilityTimeSlotResponse>;
 
-export { type AvailableResources as AvailableResourcesOriginal, type BookingPolicyViolations as BookingPolicyViolationsOriginal, 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 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, SuggestedAction as SuggestedActionOriginal, type SuggestedActionWithLiterals as SuggestedActionWithLiteralsOriginal, type TimeSlot as TimeSlotOriginal, type V2CustomerChoices as V2CustomerChoicesOriginal, type WaitingList as WaitingListOriginal, type __PublicMethodMetaInfo, getAvailabilityTimeSlot, listAvailabilityTimeSlotEndOptions, listAvailabilityTimeSlots };
+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 };