Skip to main content

rust_ynab/
lib.rs

1//! A Rust client for the [YNAB API](https://api.ynab.com).
2//!
3//! # Quick Start
4//!
5//! ```rust,no_run
6//! use rust_ynab::{Client, PlanId};
7//!
8//! #[tokio::main]
9//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
10//!     let client = Client::new(&std::env::var("YNAB_TOKEN")?)?;
11//!     let plans = client.get_plans().include_accounts().send().await?;
12//!     for plan in plans {
13//!         println!("{}", plan.name);
14//!     }
15//!     Ok(())
16//! }
17//! ```
18
19mod ynab;
20
21pub use ynab::account::{Account, AccountType, SaveAccount};
22pub use ynab::category::{
23    Category, CategoryGroup, GoalType, NewCategory, SaveCategory, SaveCategoryGroup,
24    SaveMonthCategory,
25};
26pub use ynab::client::Client;
27pub use ynab::common::{CurrencyFormat, DateFormat};
28pub use ynab::errors::{ApiError, Error};
29pub use ynab::month::Month;
30pub use ynab::movements::{MoneyMovement, MoneyMovementGroup};
31pub use ynab::payee::{Payee, PayeeLocation, PostPayee, SavePayee};
32pub use ynab::plan::{Plan, PlanId, PlanSettings};
33pub use ynab::transaction::{
34    ClearedStatus, ExistingTransaction, FlagColor, Frequency, NewTransaction,
35    SaveScheduledTransaction, SaveSubTransaction, SaveTransactionResponse,
36    SaveTransactionWithIdOrImportId, SaveTransactionsResponse, ScheduledSubtransaction,
37    ScheduledTransaction, Subtransaction, Transaction, TransactionType,
38};
39pub use ynab::user::User;
40
41/// Converts a YNAB milliunit amount to a dollar amount.
42///
43/// # Examples
44///
45/// ```
46/// assert_eq!(rust_ynab::milliunits_to_amount(50000), 50.0);
47/// assert_eq!(rust_ynab::milliunits_to_amount(-1500), -1.5);
48/// ```
49pub fn milliunits_to_amount(milliunits: i64) -> f64 {
50    milliunits as f64 / 1000.0
51}