/** * Regulations.gov SDK — typed API client for the Regulations.gov API (v4). * * Standalone — no MCP server required. Usage: * * import { searchDocuments, searchComments, searchDockets } from "us-gov-open-data-mcp/sdk/regulations"; * * const docs = await searchDocuments({ searchTerm: "water", agencyId: "EPA", pageSize: 10 }); * console.log(docs.data); * * const comments = await searchComments({ searchTerm: "climate", pageSize: 5 }); * console.log(comments.data); * * Requires DATA_GOV_API_KEY env var. Get one at https://api.data.gov/signup/ * Docs: https://open.gsa.gov/api/regulationsgov/ */ /** Regulations Document. */ export interface RegulationsDocument { id: string; type: string; attributes: { agencyId: string; commentEndDate?: string; commentStartDate?: string; docketId: string; documentType: string; frDocNum?: string; lastModifiedDate: string; objectId: string; postedDate: string; subtype?: string; title: string; withdrawn: boolean; [key: string]: unknown; }; links?: { self: string; }; } /** Regulations Comment. */ export interface RegulationsComment { id: string; type: string; attributes: { agencyId: string; comment?: string; docketId: string; documentType: string; lastModifiedDate: string; objectId: string; postedDate: string; title: string; withdrawn: boolean; [key: string]: unknown; }; links?: { self: string; }; } /** Regulations Docket. */ export interface RegulationsDocket { id: string; type: string; attributes: { agencyId: string; docketType: string; lastModifiedDate: string; objectId: string; title: string; [key: string]: unknown; }; links?: { self: string; }; } /** Regulations List Response. */ export interface RegulationsListResponse { data: T[]; meta?: { hasNextPage: boolean; hasPreviousPage: boolean; numberOfElements: number; pageNumber: number; pageSize: number; totalElements: number; totalPages: number; firstPage: boolean; lastPage: boolean; }; } /** Regulations Detail Response. */ export interface RegulationsDetailResponse { data: T; } /** Regulations.gov document type filters. */ export declare const DOCUMENT_TYPES: { readonly "Proposed Rule": "Proposed Rule"; readonly Rule: "Final Rule"; readonly "Supporting & Related Material": "Supporting & Related Material"; readonly Other: "Other"; }; /** * Search for regulatory documents (proposed rules, final rules, supporting materials). */ export declare function searchDocuments(opts?: { searchTerm?: string; agencyId?: string; docketId?: string; documentType?: string; postedDate?: string; postedDateGe?: string; postedDateLe?: string; sort?: string; pageSize?: number; pageNumber?: number; }): Promise>; /** * Get detailed information for a single document by its document ID. */ export declare function getDocument(documentId: string): Promise>; /** * Search for public comments on regulatory documents. */ export declare function searchComments(opts?: { searchTerm?: string; agencyId?: string; docketId?: string; commentOnId?: string; postedDate?: string; postedDateGe?: string; postedDateLe?: string; sort?: string; pageSize?: number; pageNumber?: number; }): Promise>; /** * Get detailed information for a single comment. */ export declare function getComment(commentId: string): Promise>; /** * Search for regulatory dockets. */ export declare function searchDockets(opts?: { searchTerm?: string; agencyId?: string; docketType?: string; sort?: string; pageSize?: number; pageNumber?: number; }): Promise>; /** * Get detailed information for a single docket. */ export declare function getDocket(docketId: string): Promise>; /** Clear cached responses. */ export declare function clearCache(): void; //# sourceMappingURL=sdk.d.ts.map