ws-dottie/dist/apis/wsf-schedule/scheduledRoutes/scheduledRoutes.d.ts

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type ScheduledRoutesInput } from "./shared/scheduledRoutes.input";
import { type SchedRoute } from "./shared/scheduledRoutes.output";
/**
 * Metadata for the fetchScheduledRoutes endpoint
 */
export declare const scheduledRoutesMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        ScheduleID: import("zod").ZodOptional<import("zod").ZodNumber>;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
        ScheduleID: import("zod").ZodNumber;
        SchedRouteID: import("zod").ZodNumber;
        ContingencyOnly: import("zod").ZodBoolean;
        RouteID: import("zod").ZodNumber;
        RouteAbbrev: import("zod").ZodString;
        Description: import("zod").ZodString;
        SeasonalRouteNotes: import("zod").ZodNullable<import("zod").ZodString>;
        RegionID: import("zod").ZodNumber;
        ServiceDisruptions: import("zod").ZodArray<import("zod").ZodObject<{
            BulletinID: import("zod").ZodNumber;
            BulletinFlag: import("zod").ZodBoolean;
            PublishDate: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
            DisruptionDescription: import("zod").ZodString;
        }, import("zod/v4/core").$strip>>;
        ContingencyAdj: import("zod").ZodArray<import("zod").ZodObject<{
            DateFrom: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
            DateThru: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
            EventID: import("zod").ZodNullable<import("zod").ZodNumber>;
            EventDescription: import("zod").ZodNullable<import("zod").ZodString>;
            AdjType: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
            ReplacedBySchedRouteID: import("zod").ZodNullable<import("zod").ZodNumber>;
        }, import("zod/v4/core").$strip>>;
    }, import("zod/v4/core").$strip>>;
    sampleParams: {};
    endpointDescription: string;
};
/**
 * Fetch function for retrieving all scheduled routes across current and upcoming seasons
 */
export declare const fetchScheduledRoutes: (params?: FetchFunctionParams<ScheduledRoutesInput>) => Promise<SchedRoute[]>;
/**
 * React Query hook for retrieving all scheduled routes across current and upcoming seasons
 */
export declare const useScheduledRoutes: (params?: FetchFunctionParams<ScheduledRoutesInput>, options?: QueryHookOptions<SchedRoute[]>) => UseQueryResult<SchedRoute[], Error>;
//# sourceMappingURL=scheduledRoutes.d.ts.map