@us-legal-tools/ecfr-sdk
Version:
TypeScript SDK and MCP server for the eCFR (Electronic Code of Federal Regulations) API
59 lines (58 loc) • 1.91 kB
TypeScript
/**
* Generated by orval v7.10.0 🍺
* Do not edit manually.
* eCFR SDK
* TypeScript SDK and Model Context Protocol server for the Electronic Code of Federal Regulations (eCFR) API
* OpenAPI spec version: 1.0.0
*/
import type { GetApiSearchV1ResultsOrder } from './getApiSearchV1ResultsOrder';
import type { GetApiSearchV1ResultsPaginateBy } from './getApiSearchV1ResultsPaginateBy';
export type GetApiSearchV1ResultsParams = {
/**
* Search term; searches the headings and the full text
*/
query?: string;
/**
* limit to content currently associated with these agencies (see AdminService agencies endpoint to retrieve a list of agency slugs)
*/
'agency_slugs[]'?: string[];
/**
* limit to content present on this date (YYYY-MM-DD)
*/
date?: string;
/**
* limit to content last modified after this date (YYYY-MM-DD)
*/
last_modified_after?: string;
/**
* limit to content last modified on or after this date (YYYY-MM-DD)
*/
last_modified_on_or_after?: string;
/**
* limit to content last modified before this date (YYYY-MM-DD)
*/
last_modified_before?: string;
/**
* limit to content last modified on or before this date (YYYY-MM-DD)
*/
last_modified_on_or_before?: string;
/**
* number of results per page; max of 1,000
* @minimum 1
* @maximum 1000
*/
per_page?: number;
/**
* page of results; can't paginate beyond 10,000 total results
* @minimum 1
*/
page?: number;
/**
* order of results
*/
order?: GetApiSearchV1ResultsOrder;
/**
* how results should be paginated - 'date' will group results so that all results from a date appear on the same page of pagination. If 'date' is chosen then one of the last_modified_* options is required.
*/
paginate_by?: GetApiSearchV1ResultsPaginateBy;
};