libfmp 1.0.0

Async, typed Rust client for the Financial Modeling Prep API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! Historical and trailing-twelve-month cash-flow-statement endpoints.

use crate::{Client, Result, endpoints::EndpointSpec, responses::statements::CashFlowStatement};

use super::{CashFlowStatementQuery, CashFlowStatementTtmQuery, WORLDWIDE_STATEMENT_METADATA};

/// Describes `GET cash-flow-statement` without binding it to a transport.
pub fn cash_flow_statement(
    query: CashFlowStatementQuery,
) -> EndpointSpec<CashFlowStatementQuery, Vec<CashFlowStatement>> {
    EndpointSpec::get("cash-flow-statement", "cash-flow-statement", query)
        .with_metadata(WORLDWIDE_STATEMENT_METADATA)
}

/// Describes `GET cash-flow-statement-ttm` without binding it to a transport.
pub fn cash_flow_statement_ttm(
    query: CashFlowStatementTtmQuery,
) -> EndpointSpec<CashFlowStatementTtmQuery, Vec<CashFlowStatement>> {
    EndpointSpec::get("cash-flow-statement-ttm", "cash-flow-statement-ttm", query)
        .with_metadata(WORLDWIDE_STATEMENT_METADATA)
}

impl Client {
    /// Retrieves historical worldwide cash-flow statements for one company.
    pub async fn cash_flow_statement(
        &self,
        query: impl Into<CashFlowStatementQuery>,
    ) -> Result<Vec<CashFlowStatement>> {
        self.execute(&cash_flow_statement(query.into())).await
    }

    /// Retrieves trailing-twelve-month worldwide cash-flow statements for one company.
    pub async fn cash_flow_statement_ttm(
        &self,
        query: impl Into<CashFlowStatementTtmQuery>,
    ) -> Result<Vec<CashFlowStatement>> {
        self.execute(&cash_flow_statement_ttm(query.into())).await
    }
}