ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
58 lines • 3.53 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type TerminalSailingSpaceByTerminalIdInput } from "./shared/terminalSailingSpace.input";
import { type TerminalSailingSpace } from "./shared/terminalSailingSpace.output";
/**
* Metadata for the fetchTerminalSailingSpaceByTerminalId endpoint
*/
export declare const terminalSailingSpaceByTerminalIdMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
TerminalID: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
TerminalID: import("zod").ZodNumber;
TerminalSubjectID: import("zod").ZodNumber;
RegionID: import("zod").ZodNumber;
TerminalName: import("zod").ZodNullable<import("zod").ZodString>;
TerminalAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
SortSeq: import("zod").ZodNumber;
DepartingSpaces: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
Departure: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
IsCancelled: import("zod").ZodBoolean;
VesselID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
MaxSpaceCount: import("zod").ZodNumber;
SpaceForArrivalTerminals: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
TerminalID: import("zod").ZodNumber;
TerminalName: import("zod").ZodNullable<import("zod").ZodString>;
VesselID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
DisplayReservableSpace: import("zod").ZodBoolean;
ReservableSpaceCount: import("zod").ZodNullable<import("zod").ZodNumber>;
ReservableSpaceHexColor: import("zod").ZodNullable<import("zod").ZodString>;
DisplayDriveUpSpace: import("zod").ZodBoolean;
DriveUpSpaceCount: import("zod").ZodNullable<import("zod").ZodNumber>;
DriveUpSpaceHexColor: import("zod").ZodNullable<import("zod").ZodString>;
MaxSpaceCount: import("zod").ZodNumber;
ArrivalTerminalIDs: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodNumber>>;
}, import("zod/v4/core").$strip>>>;
}, import("zod/v4/core").$strip>>>>;
IsNoFareCollected: import("zod").ZodNullable<import("zod").ZodBoolean>;
NoFareCollectedMsg: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>;
sampleParams: {
TerminalID: number;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving sailing space availability for a specific terminal by ID
*/
export declare const fetchTerminalSailingSpaceByTerminalId: (params?: FetchFunctionParams<TerminalSailingSpaceByTerminalIdInput>) => Promise<TerminalSailingSpace>;
/**
* React Query hook for retrieving sailing space availability for a specific terminal by ID
*/
export declare const useTerminalSailingSpaceByTerminalId: (params?: FetchFunctionParams<TerminalSailingSpaceByTerminalIdInput>, options?: QueryHookOptions<TerminalSailingSpace>) => UseQueryResult<TerminalSailingSpace, Error>;
//# sourceMappingURL=terminalSailingSpaceByTerminalId.d.ts.map