freedom_api/
lib.rs

1#![doc = include_str!("../README.md")]
2
3mod api;
4#[cfg(feature = "caching")]
5mod caching_client;
6mod client;
7pub mod error;
8pub mod extensions;
9mod utils;
10
11pub use self::{
12    api::{Api, Container, Inner, PaginatedStream, Value},
13    client::Client,
14};
15
16/// Contains the client, data models, and traits necessary for queries
17pub mod prelude {
18    #[cfg(feature = "caching")]
19    pub use crate::caching_client::CachingClient;
20    pub use crate::{
21        api::{
22            post::{
23                BandDetailsBuilder, OverrideBuilder, SatelliteBuilder,
24                SatelliteConfigurationBuilder, UserBuilder,
25            },
26            Api, Container, Inner, PaginatedStream, Value,
27        },
28        client::Client,
29        config::*,
30        extensions::*,
31        models::*,
32    };
33}
34
35/// Data types exposed by the Freedom API
36///
37/// Re-export of the models found in the `freedom-models` crate.
38pub mod models {
39    pub use freedom_models::{
40        account::*, azel::*, band::*, satellite::*, satellite_configuration::*, site::*, task::*,
41        user::*,
42    };
43}
44
45/// Configuration options for Freedom API
46///
47/// Re-export of the types found in the `freedom-config` crate.
48pub mod config {
49    pub use freedom_config::{
50        Config, ConfigBuilder, Env, Environment, IntoEnv, Prod, Secret, Test,
51    };
52}