ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
84 lines • 3.46 kB
TypeScript
/**
* @fileoverview WSF Terminals API Output Schemas
*
* This module provides Zod schemas for validating output data from the WSF
* Terminals API endpoints.
*/
import { z } from "../../../../shared/zod";
/**
* Bulletin schema
*
* This operation retrieves alerts and bulletins associated with terminals. Each terminal may have zero or more bulletins assigned to it. A TerminalID, or unique terminal identifier, may be optionally passed to retrieve a specific terminal.
*/
export declare const bulletinSchema: z.ZodObject<{
BulletinTitle: z.ZodNullable<z.ZodString>;
BulletinText: z.ZodNullable<z.ZodString>;
BulletinSortSeq: z.ZodNumber;
BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>;
}, z.core.$strip>;
export type Bulletin = z.infer<typeof bulletinSchema>;
/**
* TerminalBulletin schema
*
* Contains terminal information with associated bulletins.
*/
export declare const terminalBulletinSchema: z.ZodObject<{
TerminalID: z.ZodNumber;
TerminalSubjectID: z.ZodNumber;
RegionID: z.ZodNumber;
TerminalName: z.ZodNullable<z.ZodString>;
TerminalAbbrev: z.ZodNullable<z.ZodString>;
SortSeq: z.ZodNumber;
Bulletins: z.ZodArray<z.ZodObject<{
BulletinTitle: z.ZodNullable<z.ZodString>;
BulletinText: z.ZodNullable<z.ZodString>;
BulletinSortSeq: z.ZodNumber;
BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>;
export type TerminalBulletin = z.infer<typeof terminalBulletinSchema>;
/**
* GetAllTerminalBulletins schema
*
* Returns all terminal bulletins.
*/
export declare const getAllTerminalBulletinsSchema: z.ZodArray<z.ZodObject<{
TerminalID: z.ZodNumber;
TerminalSubjectID: z.ZodNumber;
RegionID: z.ZodNumber;
TerminalName: z.ZodNullable<z.ZodString>;
TerminalAbbrev: z.ZodNullable<z.ZodString>;
SortSeq: z.ZodNumber;
Bulletins: z.ZodArray<z.ZodObject<{
BulletinTitle: z.ZodNullable<z.ZodString>;
BulletinText: z.ZodNullable<z.ZodString>;
BulletinSortSeq: z.ZodNumber;
BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>>;
export type GetAllTerminalBulletins = z.infer<typeof getAllTerminalBulletinsSchema>;
/**
* GetSpecificTerminalBulletin schema
*
* Returns bulletins for a specific terminal.
*/
export declare const getSpecificTerminalBulletinSchema: z.ZodObject<{
TerminalID: z.ZodNumber;
TerminalSubjectID: z.ZodNumber;
RegionID: z.ZodNumber;
TerminalName: z.ZodNullable<z.ZodString>;
TerminalAbbrev: z.ZodNullable<z.ZodString>;
SortSeq: z.ZodNumber;
Bulletins: z.ZodArray<z.ZodObject<{
BulletinTitle: z.ZodNullable<z.ZodString>;
BulletinText: z.ZodNullable<z.ZodString>;
BulletinSortSeq: z.ZodNumber;
BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>;
export type GetSpecificTerminalBulletin = z.infer<typeof getSpecificTerminalBulletinSchema>;
//# sourceMappingURL=terminalBulletins.output.d.ts.map