rusty-fmp 0.5.1

//! Stable API endpoint descriptors for confirmed FMP paths.
//!
//! All endpoints are flat [`Endpoint`] values. Query shape (symbol-only,
//! date-range, annual statement, etc.) is supplied by the caller using the
//! corresponding [`FmpClient`](crate::FmpClient) shape method.

/// Default period used by annual statement-style endpoints.
pub const ANNUAL_PERIOD: &str = "annual";

/// Default row limit for annual statement-style endpoints.
pub const ANNUAL_LIMIT: u16 = 5;

/// Default item limit for news and other limited list endpoints.
pub const NEWS_LIMIT: u16 = 10;

/// Default page for paginated endpoints.
pub const PAGE: u16 = 0;

/// Stable API endpoint path.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Endpoint {
    path: &'static str,
}

impl Endpoint {
    /// Creates a descriptor for an FMP stable API path.
    #[must_use]
    pub const fn new(path: &'static str) -> Self {
        Self { path }
    }

    /// Returns the stable API path.
    #[must_use]
    pub const fn path(self) -> &'static str {
        self.path
    }
}

/// Symbol search endpoint.
pub const SEARCH_SYMBOL: Endpoint = Endpoint::new("search-symbol");
/// Company profile endpoint.
pub const PROFILE: Endpoint = Endpoint::new("profile");
/// Key executives endpoint.
pub const KEY_EXECUTIVES: Endpoint = Endpoint::new("key-executives");
/// Quote endpoint.
pub const QUOTE: Endpoint = Endpoint::new("quote");
/// Batch quote endpoint (multiple symbols as comma-separated `?symbols=`).
pub const BATCH_QUOTE: Endpoint = Endpoint::new("batch-quote");
/// Historical end-of-day price endpoint.
pub const HISTORICAL_PRICE_EOD_FULL: Endpoint = Endpoint::new("historical-price-eod/full");
/// Cryptocurrency list endpoint.
pub const CRYPTOCURRENCY_LIST: Endpoint = Endpoint::new("cryptocurrency-list");
/// Stock peers endpoint.
pub const STOCK_PEERS: Endpoint = Endpoint::new("stock-peers");
/// Stock list endpoint.
pub const STOCK_LIST: Endpoint = Endpoint::new("stock-list");
/// ETF holdings endpoint.
pub const ETF_HOLDINGS: Endpoint = Endpoint::new("etf/holdings");
/// Historical dividends endpoint.
pub const DIVIDENDS: Endpoint = Endpoint::new("dividends");
/// Historical stock splits endpoint.
pub const SPLITS: Endpoint = Endpoint::new("splits");
/// SEC filings search by symbol endpoint.
pub const SEC_FILINGS_SEARCH_SYMBOL: Endpoint = Endpoint::new("sec-filings-search/symbol");
/// Earnings calendar endpoint.
pub const EARNINGS_CALENDAR: Endpoint = Endpoint::new("earnings-calendar");
/// Treasury rates endpoint.
pub const TREASURY_RATES: Endpoint = Endpoint::new("treasury-rates");
/// Simple moving average technical indicator endpoint.
pub const TECHNICAL_SMA: Endpoint = Endpoint::new("technical-indicators/sma");
/// Stock price change endpoint.
pub const STOCK_PRICE_CHANGE: Endpoint = Endpoint::new("stock-price-change");
/// Shares float endpoint.
pub const SHARES_FLOAT: Endpoint = Endpoint::new("shares-float");
/// Financial report dates endpoint.
pub const FINANCIAL_REPORTS_DATES: Endpoint = Endpoint::new("financial-reports-dates");
/// Annual report form JSON endpoint.
pub const FINANCIAL_REPORTS_JSON: Endpoint = Endpoint::new("financial-reports-json");
/// Annual income statement endpoint.
pub const INCOME_STATEMENT: Endpoint = Endpoint::new("income-statement");
/// Annual income statement as reported endpoint.
pub const INCOME_STATEMENT_AS_REPORTED: Endpoint = Endpoint::new("income-statement-as-reported");
/// Annual balance sheet endpoint.
pub const BALANCE_SHEET_STATEMENT: Endpoint = Endpoint::new("balance-sheet-statement");
/// Annual cash flow statement endpoint.
pub const CASH_FLOW_STATEMENT: Endpoint = Endpoint::new("cash-flow-statement");
/// Annual financial ratios endpoint.
pub const RATIOS: Endpoint = Endpoint::new("ratios");
/// Annual key metrics endpoint.
pub const KEY_METRICS: Endpoint = Endpoint::new("key-metrics");
/// Annual income statement growth endpoint.
pub const INCOME_STATEMENT_GROWTH: Endpoint = Endpoint::new("income-statement-growth");
/// Annual balance sheet statement growth endpoint.
pub const BALANCE_SHEET_STATEMENT_GROWTH: Endpoint =
    Endpoint::new("balance-sheet-statement-growth");
/// Annual cash flow statement growth endpoint.
pub const CASH_FLOW_STATEMENT_GROWTH: Endpoint = Endpoint::new("cash-flow-statement-growth");
/// Annual enterprise values endpoint.
pub const ENTERPRISE_VALUES: Endpoint = Endpoint::new("enterprise-values");
/// Financial scores endpoint.
pub const FINANCIAL_SCORES: Endpoint = Endpoint::new("financial-scores");
/// Annual analyst estimates endpoint.
pub const ANALYST_ESTIMATES: Endpoint = Endpoint::new("analyst-estimates");
/// Analyst grades endpoint.
pub const GRADES: Endpoint = Endpoint::new("grades");
/// Price target consensus endpoint.
pub const PRICE_TARGET_CONSENSUS: Endpoint = Endpoint::new("price-target-consensus");
/// Price target summary endpoint.
pub const PRICE_TARGET_SUMMARY: Endpoint = Endpoint::new("price-target-summary");
/// Analyst grades consensus endpoint.
pub const GRADES_CONSENSUS: Endpoint = Endpoint::new("grades-consensus");
/// Historical company rating endpoint.
pub const RATINGS_HISTORICAL: Endpoint = Endpoint::new("ratings-historical");
/// Latest insider trading endpoint.
pub const INSIDER_TRADING_LATEST: Endpoint = Endpoint::new("insider-trading/latest");
/// Insider trading search endpoint (by symbol).
pub const INSIDER_TRADING_SEARCH: Endpoint = Endpoint::new("insider-trading/search");
/// Economic indicators endpoint.
pub const ECONOMIC_INDICATORS: Endpoint = Endpoint::new("economic-indicators");
/// Stock news endpoint.
pub const STOCK_NEWS: Endpoint = Endpoint::new("news/stock");
/// General news endpoint.
pub const GENERAL_NEWS: Endpoint = Endpoint::new("news/general-latest");
/// FMP articles endpoint.
pub const FMP_ARTICLES: Endpoint = Endpoint::new("fmp-articles");
/// Forex news endpoint.
pub const FOREX_NEWS: Endpoint = Endpoint::new("news/forex-latest");
/// Crypto news endpoint.
pub const CRYPTO_NEWS: Endpoint = Endpoint::new("news/crypto-latest");
/// Analyst upgrades and downgrades endpoint.
pub const UPGRADES_DOWNGRADES: Endpoint = Endpoint::new("upgrades-downgrades");
/// Ratings snapshot endpoint.
pub const RATINGS_SNAPSHOT: Endpoint = Endpoint::new("ratings-snapshot");
/// Earnings surprises endpoint.
pub const EARNINGS_SURPRISES: Endpoint = Endpoint::new("earnings-surprises");
/// Company outlook endpoint.
pub const COMPANY_OUTLOOK: Endpoint = Endpoint::new("company-outlook");
/// ETF list endpoint.
pub const ETF_LIST: Endpoint = Endpoint::new("etf-list");
/// Delisted companies endpoint.
pub const DELISTED_COMPANIES: Endpoint = Endpoint::new("delisted-companies");
/// Symbol-based earnings endpoint.
pub const EARNINGS: Endpoint = Endpoint::new("earnings");
/// Real-time quote endpoint.
pub const REALTIME_QUOTE: Endpoint = Endpoint::new("realtime-quote");
/// Price target endpoint.
pub const PRICE_TARGET: Endpoint = Endpoint::new("price-target");
/// Consolidated financial statement growth endpoint.
pub const FINANCIAL_STATEMENT_GROWTH: Endpoint = Endpoint::new("financial-statement-growth");
/// ETF info endpoint.
pub const ETF_INFO: Endpoint = Endpoint::new("etf/info");
/// Market risk premium endpoint.
pub const MARKET_RISK_PREMIUM: Endpoint = Endpoint::new("market-risk-premium");
/// Market hours endpoint.
pub const MARKET_HOURS: Endpoint = Endpoint::new("market-hours");
/// Aftermarket quote endpoint.
pub const AFTERMARKET_QUOTE: Endpoint = Endpoint::new("aftermarket-quote");
/// Aftermarket trade endpoint.
pub const AFTERMARKET_TRADE: Endpoint = Endpoint::new("aftermarket-trade");