freedom-api 3.2.0

Freedom API for Rustaceans
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

#![doc = include_str!("../README.md")]

mod api;
#[cfg(feature = "caching")]
mod caching_client;
mod client;
pub mod error;
pub mod extensions;
mod gateway_licenses;
mod utils;

pub use self::{
    api::{Api, Container, Inner, PaginatedStream, Value, post::Post},
    client::Client,
    gateway_licenses::GatewayApi,
};

/// Contains the client, data models, and traits necessary for queries
pub mod prelude {
    #[cfg(feature = "caching")]
    pub use crate::caching_client::CachingClient;
    pub use crate::{
        api::{
            Api, Container, Inner, PaginatedStream, Value,
            post::{
                BandDetailsBuilder, OverrideBuilder, Post, SatelliteBuilder,
                SatelliteConfigurationBuilder, UserBuilder,
            },
        },
        client::Client,
        config::*,
        extensions::*,
        models::*,
    };
}

/// Data types exposed by the Freedom API
///
/// Re-export of the models found in the `freedom-models` crate.
pub mod models {
    pub use freedom_models::{
        account::*, azel::*, band::*, satellite::*, satellite_configuration::*, site::*, task::*,
        user::*,
    };
}

/// Configuration options for Freedom API
///
/// Re-export of the types found in the `freedom-config` crate.
pub mod config {
    pub use freedom_config::{
        Config, ConfigBuilder, Env, Environment, IntoEnv, Prod, Secret, Test,
    };
}