ferric-fred 0.3.5

//! `ferric-fred` — a strongly-typed async Rust client for the [FRED] API
//! (Federal Reserve Economic Data, from the Federal Reserve Bank of St. Louis).
//!
//! [FRED]: https://fred.stlouisfed.org/
//!
//! The client covers all of FRED's read endpoints — series, observations,
//! search, categories, releases, sources, tags, and the release table tree —
//! plus the GeoFRED / Maps API for regional data and its geographic shape files,
//! behind ergonomic async builders, with newtype identifiers, typed enums for
//! FRED's closed value sets, and a typed [`Error`] taxonomy that never panics on
//! a network or parse failure. Paginated endpoints can be walked to exhaustion
//! with [`Paginate::send_all`] or streamed lazily with [`Paginate::stream`]. See
//! the design ADRs under `docs/adr/` for the decisions that shape the API.
//!
//! # Feature flags
//!
//! - `schemars` *(off by default)* — derive `schemars::JsonSchema` on the
//!   public return types, so a consumer (the bundled MCP server, say) can
//!   advertise the exact shape an endpoint returns. Additive; plain consumers
//!   pay nothing. See [ADR-0023].
//!
//! [ADR-0023]: https://github.com/ojhermann-org/ferric-fred/blob/main/docs/adr/0023-mcp-output-schemas.md
//!
//! ```no_run
//! # async fn run() -> ferric_fred::Result<()> {
//! use ferric_fred::{Client, Paginate, SeriesId};
//!
//! let client = Client::from_env()?; // reads FRED_API_KEY
//!
//! // One series' observations:
//! let observations = client.observations(&SeriesId::new("GNPCA")).send().await?;
//! println!("{} observations", observations.len());
//!
//! // Search, paged to exhaustion (or `.stream()` for lazy iteration):
//! let matches = client.search("unemployment rate").send_all().await?;
//! println!("{} matching series", matches.len());
//! # Ok(())
//! # }
//! ```

mod aggregation_method;
mod category;
mod client;
mod error;
mod frequency;
mod ids;
mod observation;
mod observations_request;
mod order_by;
mod paginate;
mod region_type;
mod regional_data;
mod release;
mod release_date;
mod release_dates_request;
mod release_table;
mod release_tables_request;
mod releases_request;
mod search_type;
mod seasonal_adjustment;
mod series;
mod series_data_request;
mod series_group;
mod series_list_request;
mod series_search_request;
mod series_updates_request;
mod shape_file;
mod shape_type;
mod sort_order;
mod source;
mod sources_request;
mod tag;
mod tags_request;
mod units;
mod updates_filter;
mod vintage_dates;
mod vintage_dates_request;

pub use aggregation_method::AggregationMethod;
pub use category::Category;
pub use client::Client;
pub use error::Error;
pub use frequency::Frequency;
pub use ids::{CategoryId, ReleaseElementId, ReleaseId, SeriesGroupId, SeriesId, SourceId};
pub use observation::Observation;
pub use observations_request::ObservationsRequest;
pub use order_by::OrderBy;
pub use paginate::{Page, Paginate};
pub use region_type::RegionType;
pub use regional_data::{RegionalData, RegionalDataMeta, RegionalDataPoint};
pub use release::{Release, ReleasesResults};
pub use release_date::{ReleaseDate, ReleaseDatesResults};
pub use release_dates_request::ReleaseDatesRequest;
pub use release_table::{ReleaseTable, ReleaseTableElement};
pub use release_tables_request::ReleaseTablesRequest;
pub use releases_request::ReleasesRequest;
pub use search_type::SearchType;
pub use seasonal_adjustment::SeasonalAdjustment;
pub use series::{Series, SeriesSearchResults};
pub use series_data_request::SeriesDataRequest;
pub use series_group::SeriesGroup;
pub use series_list_request::SeriesListRequest;
pub use series_search_request::SeriesSearchRequest;
pub use series_updates_request::SeriesUpdatesRequest;
pub use shape_file::{Feature, Geometry, ShapeFile};
pub use shape_type::ShapeType;
pub use sort_order::SortOrder;
pub use source::{Source, SourcesResults};
pub use sources_request::SourcesRequest;
pub use tag::{Tag, TagsResults};
pub use tags_request::TagsRequest;
pub use units::Units;
pub use updates_filter::UpdatesFilter;
pub use vintage_dates::VintageDates;
pub use vintage_dates_request::VintageDatesRequest;

/// A `Result` whose error type is this crate's [`Error`].
pub type Result<T> = std::result::Result<T, Error>;