nbp 0.2.0

A Rust library for accessing the National Bank of Poland's 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

mod get_rates;
mod get_tables;

use crate::api::exchange_rates::get_rates::GetRatesBuilder;
use crate::api::exchange_rates::get_tables::GetTablesBuilder;
use crate::client::service_client::ServiceClient;
use crate::client::{NBP_API_EXCHANGE_RATES_ENDPOINT, NbpClient};
use crate::models::currency_code::CurrencyCode;
use crate::models::date_parameters::NoDateParameter;
use crate::models::table_type::TableType;

/// Handler for exchange rates API operations.
///
/// Provides methods to access exchange rates data from the NBP API.
/// Supports different table types (A, B, C) and various date ranges.
pub struct ExchangeRatesHandler {
    client: ServiceClient,
}

impl NbpClient {
    /// Creates a new [`ExchangeRatesHandler`] that allows you to access
    /// NBP Exchange Rates API.
    ///
    /// ## Example
    ///
    /// ```rust
    /// use nbp::client::NbpClient;
    /// use nbp::models::TableType;
    ///
    /// let client = NbpClient::default();
    /// let exchange_rates = client.exchange_rates();
    ///
    /// // Get table A for today
    /// let tables = exchange_rates.tables(TableType::A).today();
    /// ```
    pub fn exchange_rates(&self) -> ExchangeRatesHandler {
        ExchangeRatesHandler {
            client: ServiceClient::new(
                self.base_url()
                    .join(NBP_API_EXCHANGE_RATES_ENDPOINT)
                    .unwrap(),
            ),
        }
    }
}

impl ExchangeRatesHandler {
    /// Creates a builder for getting exchange rate tables.
    ///
    /// ## Example
    ///
    /// ```rust
    /// use nbp::client::NbpClient;
    /// use nbp::models::TableType;
    ///
    /// let client = NbpClient::default();
    /// let tables = client
    ///     .exchange_rates()
    ///     .tables(TableType::A)
    ///     .last_days(5);
    /// ```
    pub fn tables(&self, table: TableType) -> GetTablesBuilder<NoDateParameter> {
        GetTablesBuilder::new(self.client.clone(), table)
    }

    /// Creates a builder for getting exchange rates for a specific currency.
    ///
    /// ## Example
    ///
    /// ```rust
    /// use nbp::client::NbpClient;
    /// use nbp::models::{TableType, CurrencyCode};
    ///
    /// let client = NbpClient::default();
    /// let rates = client
    ///     .exchange_rates()
    ///     .rates(TableType::A, CurrencyCode::USD)
    ///     .last_days(5);
    /// ```
    pub fn rates(
        &self,
        table: TableType,
        currency: CurrencyCode,
    ) -> GetRatesBuilder<NoDateParameter> {
        GetRatesBuilder::new(self.client.clone(), table, currency)
    }
}