ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
51 lines • 2.73 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type VesselAccommodationsByIdInput } from "./shared/vesselAccommodations.input";
import { type VesselAccommodation } from "./shared/vesselAccommodations.output";
/**
* Metadata for the fetchVesselAccommodationsByVesselId endpoint
*/
export declare const vesselAccommodationsByVesselIdMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
VesselID: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
VesselID: import("zod").ZodNumber;
VesselSubjectID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
VesselAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
Class: import("zod").ZodNullable<import("zod").ZodObject<{
ClassID: import("zod").ZodNumber;
ClassSubjectID: import("zod").ZodNumber;
ClassName: import("zod").ZodNullable<import("zod").ZodString>;
SortSeq: import("zod").ZodNullable<import("zod").ZodNumber>;
DrawingImg: import("zod").ZodNullable<import("zod").ZodString>;
SilhouetteImg: import("zod").ZodNullable<import("zod").ZodString>;
PublicDisplayName: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
CarDeckRestroom: import("zod").ZodBoolean;
CarDeckShelter: import("zod").ZodBoolean;
Elevator: import("zod").ZodBoolean;
ADAAccessible: import("zod").ZodBoolean;
MainCabinGalley: import("zod").ZodBoolean;
MainCabinRestroom: import("zod").ZodBoolean;
PublicWifi: import("zod").ZodBoolean;
ADAInfo: import("zod").ZodNullable<import("zod").ZodString>;
AdditionalInfo: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>;
sampleParams: {
VesselID: number;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving amenities and accessibility features for a specific vessel
*/
export declare const fetchVesselAccommodationsByVesselId: (params?: FetchFunctionParams<VesselAccommodationsByIdInput>) => Promise<VesselAccommodation>;
/**
* React Query hook for retrieving amenities and accessibility features for a specific vessel
*/
export declare const useVesselAccommodationsByVesselId: (params?: FetchFunctionParams<VesselAccommodationsByIdInput>, options?: QueryHookOptions<VesselAccommodation>) => UseQueryResult<VesselAccommodation, Error>;
//# sourceMappingURL=vesselAccommodationsByVesselId.d.ts.map