@wix/auto_sdk_bookings_availability-time-slots 1.0.248 → 1.0.249

package/build/cjs/index.typings.d.ts

@@ -935,6 +935,160 @@ interface GetAvailabilityTimeSlotResponse {
      */
     timeZone?: string | null;
 }
+interface DiagnoseAvailabilityRequest {
+    /**
+     * Service to diagnose; provide this or `resource_id`.
+     * @format GUID
+     */
+    serviceId?: string | null;
+    /**
+     * Staff member / resource to diagnose; provide this or `service_id`.
+     * @format GUID
+     */
+    resourceId?: string | null;
+    /**
+     * Lower boundary of the diagnosed range, `YYYY-MM-DDThh:mm:ss` (ISO-8601). Optional; defaults to the current time when omitted.
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Upper boundary of the diagnosed range, `YYYY-MM-DDThh:mm:ss` (ISO-8601). Optional; defaults to `fromLocalDate` + 90 days when omitted.
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * IANA tz database time zone for `fromLocalDate`/`toLocalDate`.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /**
+     * Locations to diagnose; all offered locations when empty.
+     * @maxSize 100
+     */
+    locations?: Location[];
+    /**
+     * Whether to run a deeper diagnosis. Optional; defaults to `false` — the fast, deterministic
+     * configuration/setup checks (resource-availability-window checks are added to this path as they
+     * roll out). Set `true` only when the default result is inconclusive (no reasons) and you need to
+     * know *why* specific resources have no availability at specific times — it samples resource
+     * availability to attribute an empty window to a working-hours gap vs. blocked time, at extra
+     * latency. Not supported yet — `true` currently returns `DIAGNOSTIC_DEPTH_NOT_SUPPORTED`.
+     */
+    deep?: boolean;
+}
+interface DiagnoseAvailabilityResponse {
+    /**
+     * Whether the service or resource has bookable availability in the diagnosed range.
+     * Note: the current diagnosis detects setup/configuration problems and does not positively confirm
+     * availability, so this is not set to `true` yet (reserved for the deeper availability-window check).
+     */
+    hasAvailability?: boolean;
+    /**
+     * Causes of unavailability, most-specific first. When empty, the diagnosis is undetermined: no
+     * blocking cause was identified (and availability was not positively confirmed).
+     * @maxSize 20
+     */
+    reasons?: DiagnosisReason[];
+    /** Resolved inputs used for the diagnosis, echoed for debugging. */
+    resolvedContext?: ResolvedContext;
+}
+interface DiagnosisReason {
+    /** Machine-readable reason code. */
+    code?: ReasonCodeWithLiterals;
+    /** Suggested owner-facing action key. Wording and localization are the client's responsibility. */
+    suggestedAction?: SuggestedActionWithLiterals;
+}
+/** Machine-readable cause for empty availability. */
+declare enum ReasonCode {
+    /** No staff or resources are assigned to the service. */
+    NO_ASSIGNED_STAFF_OR_RESOURCES = "NO_ASSIGNED_STAFF_OR_RESOURCES",
+    /** The service's availability configuration is missing. */
+    SERVICE_AVAILABILITY_CONFIGURATION_MISSING = "SERVICE_AVAILABILITY_CONFIGURATION_MISSING",
+    /** The requested location(s) are not offered by the service. */
+    REQUESTED_LOCATION_NOT_OFFERED_BY_SERVICE = "REQUESTED_LOCATION_NOT_OFFERED_BY_SERVICE",
+    /** The service's resource types could not be resolved. */
+    RESOURCE_TYPE_RESOLUTION_FAILED = "RESOURCE_TYPE_RESOLUTION_FAILED",
+    /** No resource-availability windows exist in the diagnosed range. */
+    NO_RESOURCE_AVAILABILITY_WINDOWS = "NO_RESOURCE_AVAILABILITY_WINDOWS",
+    /** The service duration is longer than every available window. */
+    DURATION_TOO_LONG_FOR_AVAILABLE_WINDOWS = "DURATION_TOO_LONG_FOR_AVAILABLE_WINDOWS",
+    /** Buffer time eliminates all otherwise-available windows. */
+    BUFFER_TIME_ELIMINATES_WINDOWS = "BUFFER_TIME_ELIMINATES_WINDOWS",
+    /** Resources are not within working hours during the diagnosed range. Reported only at `DEEP` depth. */
+    RESOURCE_NOT_IN_WORKING_HOURS = "RESOURCE_NOT_IN_WORKING_HOURS",
+    /** Resources are blocked by events or external calendars during the range. Reported only at `DEEP` depth. */
+    RESOURCE_BLOCKED = "RESOURCE_BLOCKED",
+    /** The staff member / resource has no working-hours schedule configured. */
+    RESOURCE_HAS_NO_WORKING_HOURS = "RESOURCE_HAS_NO_WORKING_HOURS",
+    /** The staff member / resource is not assigned to the service. */
+    RESOURCE_NOT_ASSIGNED_TO_SERVICE = "RESOURCE_NOT_ASSIGNED_TO_SERVICE"
+}
+/** @enumType */
+type ReasonCodeWithLiterals = ReasonCode | 'NO_ASSIGNED_STAFF_OR_RESOURCES' | 'SERVICE_AVAILABILITY_CONFIGURATION_MISSING' | 'REQUESTED_LOCATION_NOT_OFFERED_BY_SERVICE' | 'RESOURCE_TYPE_RESOLUTION_FAILED' | 'NO_RESOURCE_AVAILABILITY_WINDOWS' | 'DURATION_TOO_LONG_FOR_AVAILABLE_WINDOWS' | 'BUFFER_TIME_ELIMINATES_WINDOWS' | 'RESOURCE_NOT_IN_WORKING_HOURS' | 'RESOURCE_BLOCKED' | 'RESOURCE_HAS_NO_WORKING_HOURS' | 'RESOURCE_NOT_ASSIGNED_TO_SERVICE';
+/** Owner-facing action key suggested to resolve a diagnosed reason. */
+declare enum SuggestedAction {
+    /** Assign staff or resources to the service. */
+    ASSIGN_STAFF_OR_RESOURCES = "ASSIGN_STAFF_OR_RESOURCES",
+    /** Review staff working hours. */
+    CHECK_STAFF_WORKING_HOURS = "CHECK_STAFF_WORKING_HOURS",
+    /** Review staff work locations. */
+    CHECK_WORK_LOCATIONS = "CHECK_WORK_LOCATIONS",
+    /** Review the service's offered locations. */
+    CHECK_SERVICE_LOCATIONS = "CHECK_SERVICE_LOCATIONS",
+    /** Reduce the service duration or buffer time. */
+    REDUCE_DURATION_OR_BUFFER = "REDUCE_DURATION_OR_BUFFER",
+    /** Review blocked time and calendar events. */
+    CHECK_BLOCKED_TIME = "CHECK_BLOCKED_TIME",
+    /** Assign the staff member / resource to the service. */
+    ASSIGN_RESOURCE_TO_SERVICE = "ASSIGN_RESOURCE_TO_SERVICE"
+}
+/** @enumType */
+type SuggestedActionWithLiterals = SuggestedAction | 'ASSIGN_STAFF_OR_RESOURCES' | 'CHECK_STAFF_WORKING_HOURS' | 'CHECK_WORK_LOCATIONS' | 'CHECK_SERVICE_LOCATIONS' | 'REDUCE_DURATION_OR_BUFFER' | 'CHECK_BLOCKED_TIME' | 'ASSIGN_RESOURCE_TO_SERVICE';
+interface ResolvedContext {
+    /**
+     * Service ID that was diagnosed.
+     * @format GUID
+     */
+    serviceId?: string | null;
+    /**
+     * Staff member / resource ID that was diagnosed.
+     * @format GUID
+     */
+    resourceId?: string | null;
+    /**
+     * Locations resolved for the diagnosis (the service's offered locations, capped like the
+     * configuration provider's location list).
+     * @maxSize 100
+     */
+    resolvedLocations?: Location[];
+    /**
+     * Service duration in minutes used for the diagnosis. Set only when `serviceId` is provided
+     * (reflects service configuration); absent on the resource-only path.
+     */
+    durationInMinutes?: number | null;
+    /**
+     * Buffer time in minutes used for the diagnosis. Set only when `serviceId` is provided
+     * (reflects service configuration); absent on the resource-only path.
+     */
+    bufferTimeInMinutes?: number | null;
+    /**
+     * Lower boundary of the diagnosed range actually used (the request value, or the default).
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Upper boundary of the diagnosed range actually used (the request value, or the default).
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * Time zone used for the diagnosis, in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+}
 /** @docsIgnore */
 type ListAvailabilityTimeSlotsApplicationErrors = {
     code?: 'NO_IMPLEMENTERS_FOUND';
@@ -1276,4 +1430,4 @@ interface GetAvailabilityTimeSlotOptions {
     resourceTypes?: ResourceType[];
 }
 
-export { type AvailableResources, type BookingPolicyViolations, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomerChoices, type EventInfo, type GetAvailabilityTimeSlotApplicationErrors, type GetAvailabilityTimeSlotOptions, type GetAvailabilityTimeSlotRequest, type GetAvailabilityTimeSlotRequestCustomerChoices, type GetAvailabilityTimeSlotResponse, type GetEventTimeSlotRequest, type GetEventTimeSlotResponse, type GetMultiServiceAvailabilityTimeSlotRequest, type GetMultiServiceAvailabilityTimeSlotResponse, 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, type Resource, type ResourceType, type Service, type TimeSlot, type V2CustomerChoices, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlots };
+export { type AvailableResources, type BookingPolicyViolations, 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 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, SuggestedAction, type SuggestedActionWithLiterals, type TimeSlot, type V2CustomerChoices, type WaitingList, getAvailabilityTimeSlot, listAvailabilityTimeSlots };

package/build/cjs/index.typings.js

@@ -21,6 +21,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_typings_exports = {};
 __export(index_typings_exports, {
   LocationType: () => LocationType,
+  ReasonCode: () => ReasonCode,
+  SuggestedAction: () => SuggestedAction,
   getAvailabilityTimeSlot: () => getAvailabilityTimeSlot2,
   listAvailabilityTimeSlotEndOptions: () => listAvailabilityTimeSlotEndOptions2,
   listAvailabilityTimeSlots: () => listAvailabilityTimeSlots2
@@ -271,6 +273,30 @@ var LocationType = /* @__PURE__ */ ((LocationType2) => {
   LocationType2["CUSTOMER"] = "CUSTOMER";
   return LocationType2;
 })(LocationType || {});
+var ReasonCode = /* @__PURE__ */ ((ReasonCode2) => {
+  ReasonCode2["NO_ASSIGNED_STAFF_OR_RESOURCES"] = "NO_ASSIGNED_STAFF_OR_RESOURCES";
+  ReasonCode2["SERVICE_AVAILABILITY_CONFIGURATION_MISSING"] = "SERVICE_AVAILABILITY_CONFIGURATION_MISSING";
+  ReasonCode2["REQUESTED_LOCATION_NOT_OFFERED_BY_SERVICE"] = "REQUESTED_LOCATION_NOT_OFFERED_BY_SERVICE";
+  ReasonCode2["RESOURCE_TYPE_RESOLUTION_FAILED"] = "RESOURCE_TYPE_RESOLUTION_FAILED";
+  ReasonCode2["NO_RESOURCE_AVAILABILITY_WINDOWS"] = "NO_RESOURCE_AVAILABILITY_WINDOWS";
+  ReasonCode2["DURATION_TOO_LONG_FOR_AVAILABLE_WINDOWS"] = "DURATION_TOO_LONG_FOR_AVAILABLE_WINDOWS";
+  ReasonCode2["BUFFER_TIME_ELIMINATES_WINDOWS"] = "BUFFER_TIME_ELIMINATES_WINDOWS";
+  ReasonCode2["RESOURCE_NOT_IN_WORKING_HOURS"] = "RESOURCE_NOT_IN_WORKING_HOURS";
+  ReasonCode2["RESOURCE_BLOCKED"] = "RESOURCE_BLOCKED";
+  ReasonCode2["RESOURCE_HAS_NO_WORKING_HOURS"] = "RESOURCE_HAS_NO_WORKING_HOURS";
+  ReasonCode2["RESOURCE_NOT_ASSIGNED_TO_SERVICE"] = "RESOURCE_NOT_ASSIGNED_TO_SERVICE";
+  return ReasonCode2;
+})(ReasonCode || {});
+var SuggestedAction = /* @__PURE__ */ ((SuggestedAction2) => {
+  SuggestedAction2["ASSIGN_STAFF_OR_RESOURCES"] = "ASSIGN_STAFF_OR_RESOURCES";
+  SuggestedAction2["CHECK_STAFF_WORKING_HOURS"] = "CHECK_STAFF_WORKING_HOURS";
+  SuggestedAction2["CHECK_WORK_LOCATIONS"] = "CHECK_WORK_LOCATIONS";
+  SuggestedAction2["CHECK_SERVICE_LOCATIONS"] = "CHECK_SERVICE_LOCATIONS";
+  SuggestedAction2["REDUCE_DURATION_OR_BUFFER"] = "REDUCE_DURATION_OR_BUFFER";
+  SuggestedAction2["CHECK_BLOCKED_TIME"] = "CHECK_BLOCKED_TIME";
+  SuggestedAction2["ASSIGN_RESOURCE_TO_SERVICE"] = "ASSIGN_RESOURCE_TO_SERVICE";
+  return SuggestedAction2;
+})(SuggestedAction || {});
 async function listAvailabilityTimeSlots2(options) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -412,6 +438,8 @@ async function getAvailabilityTimeSlot2(serviceId, localStartDate, localEndDate,
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LocationType,
+  ReasonCode,
+  SuggestedAction,
   getAvailabilityTimeSlot,
   listAvailabilityTimeSlotEndOptions,
   listAvailabilityTimeSlots