ws-dottie/dist/apis/wsf-schedule/scheduleToday/scheduleTodayByTerminals.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 ScheduleTodayByTerminalsInput } from "./shared/scheduleToday.input";
import { type Schedule } from "./shared/scheduleToday.output";
/**
 * Metadata for the fetchScheduleTodayByTerminals endpoint
 */
export declare const scheduleTodayByTerminalsMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        DepartingTerminalID: import("zod").ZodNumber;
        ArrivingTerminalID: import("zod").ZodNumber;
        OnlyRemainingTimes: import("zod").ZodBoolean;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodObject<{
        ScheduleID: import("zod").ZodNumber;
        ScheduleName: import("zod").ZodString;
        ScheduleSeason: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<0>, import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>;
        SchedulePDFUrl: import("zod").ZodString;
        ScheduleStart: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
        ScheduleEnd: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
        AllRoutes: import("zod").ZodArray<import("zod").ZodNumber>;
        TerminalCombos: import("zod").ZodArray<import("zod").ZodObject<{
            DepartingTerminalID: import("zod").ZodNumber;
            DepartingTerminalName: import("zod").ZodString;
            ArrivingTerminalID: import("zod").ZodNumber;
            ArrivingTerminalName: import("zod").ZodString;
            SailingNotes: import("zod").ZodString;
            Annotations: import("zod").ZodArray<import("zod").ZodString>;
            Times: import("zod").ZodArray<import("zod").ZodObject<{
                DepartingTime: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
                ArrivingTime: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
                LoadingRule: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>;
                VesselID: import("zod").ZodNumber;
                VesselName: import("zod").ZodString;
                VesselHandicapAccessible: import("zod").ZodBoolean;
                VesselPositionNum: import("zod").ZodNumber;
                Routes: import("zod").ZodArray<import("zod").ZodNumber>;
                AnnotationIndexes: import("zod").ZodArray<import("zod").ZodNumber>;
            }, import("zod/v4/core").$strip>>;
            AnnotationsIVR: import("zod").ZodArray<import("zod").ZodString>;
        }, import("zod/v4/core").$strip>>;
    }, import("zod/v4/core").$strip>;
    sampleParams: {
        DepartingTerminalID: number;
        ArrivingTerminalID: number;
        OnlyRemainingTimes: false;
    };
    endpointDescription: string;
};
/**
 * Fetch function for retrieving today's schedule for a terminal pair
 */
export declare const fetchScheduleTodayByTerminals: (params?: FetchFunctionParams<ScheduleTodayByTerminalsInput>) => Promise<Schedule>;
/**
 * React Query hook for retrieving today's schedule for a terminal pair
 */
export declare const useScheduleTodayByTerminals: (params?: FetchFunctionParams<ScheduleTodayByTerminalsInput>, options?: QueryHookOptions<Schedule>) => UseQueryResult<Schedule, Error>;
//# sourceMappingURL=scheduleTodayByTerminals.d.ts.map