ws-dottie/dist/apis/wsf-vessels/vesselVerbose/vesselsVerboseById.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 VesselVerboseByIdInput } from "./shared/vesselVerbose.input";
import { type VesselVerbose } from "./shared/vesselVerbose.output";
/**
 * Metadata for the fetchVesselsVerboseByVesselId endpoint
 */
export declare const vesselsVerboseByVesselIdMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        VesselID: import("zod").ZodNumber;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodIntersection<import("zod").ZodIntersection<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>>;
        Status: import("zod").ZodNullable<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>>;
        OwnedByWSF: import("zod").ZodBoolean;
    }, import("zod/v4/core").$strip>, 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>>, 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>>;
        VesselNameDesc: import("zod").ZodString;
        VesselHistory: import("zod").ZodNullable<import("zod").ZodString>;
        Beam: import("zod").ZodString;
        CityBuilt: import("zod").ZodString;
        SpeedInKnots: import("zod").ZodNullable<import("zod").ZodNumber>;
        Draft: import("zod").ZodString;
        EngineCount: import("zod").ZodNullable<import("zod").ZodNumber>;
        Horsepower: import("zod").ZodNullable<import("zod").ZodNumber>;
        Length: import("zod").ZodString;
        MaxPassengerCount: import("zod").ZodNullable<import("zod").ZodNumber>;
        PassengerOnly: import("zod").ZodBoolean;
        FastFerry: import("zod").ZodBoolean;
        PropulsionInfo: import("zod").ZodString;
        TallDeckClearance: import("zod").ZodNullable<import("zod").ZodNumber>;
        RegDeckSpace: import("zod").ZodNullable<import("zod").ZodNumber>;
        TallDeckSpace: import("zod").ZodNullable<import("zod").ZodNumber>;
        Tonnage: import("zod").ZodNullable<import("zod").ZodNumber>;
        Displacement: import("zod").ZodNullable<import("zod").ZodNumber>;
        YearBuilt: import("zod").ZodNullable<import("zod").ZodNumber>;
        YearRebuilt: import("zod").ZodNullable<import("zod").ZodNumber>;
        VesselDrawingImg: import("zod").ZodNullable<import("zod").ZodString>;
        SolasCertified: import("zod").ZodBoolean;
        MaxPassengerCountForInternational: import("zod").ZodNullable<import("zod").ZodNumber>;
    }, import("zod/v4/core").$strip>>;
    sampleParams: {
        VesselID: number;
    };
    endpointDescription: string;
};
/**
 * Fetch function for retrieving complete vessel information for a specific vessel by ID
 */
export declare const fetchVesselsVerboseByVesselId: (params?: FetchFunctionParams<VesselVerboseByIdInput>) => Promise<VesselVerbose>;
/**
 * React Query hook for retrieving complete vessel information for a specific vessel by ID
 */
export declare const useVesselsVerboseByVesselId: (params?: FetchFunctionParams<VesselVerboseByIdInput>, options?: QueryHookOptions<VesselVerbose>) => UseQueryResult<VesselVerbose, Error>;
//# sourceMappingURL=vesselsVerboseById.d.ts.map