Struct Client

pub struct Client { /* private fields */ }

An asynchronous Client for interfacing with the ATLAS freedom API.

The client is primarily defined based on it’s Env and it’s credentials (username and password).

Implementations

impl Client

pub fn from_config(config: Config) -> Self

Construct an API client from the provided Freedom config

Example

let config = Config::builder()
    .environment(Test)
    .key("foo")
    .secret("bar")
    .build()
    .unwrap();
let client = Client::from_config(config);

assert_eq!(client.config().key(), "foo");

pub fn from_env() -> Result<Self, Error>

A convenience method for constructing an FPS client from environment variables.

This function expects the following environment variables:

• ATLAS_ENV: [possible values: test, prod]
• ATLAS_KEY: The ATLAS freedom key registered with an account
• ATLAS_SECRET: The ATLAS freedom secret registered with an account

Trait Implementations

impl Api for Client

type Container<T: Value> = Inner<T>

The Api supports implementors with different so-called “container” types.

async fn get(&self, url: Url) -> Result<(Bytes, StatusCode), Error>

Creates a get request at the provided absolute URI for the client’s environment, using basic authentication.

async fn delete(&self, url: Url) -> Result<Response, Error>

async fn post<S>(&self, url: Url, msg: S) -> Result<Response, Error>

where S: Serialize + Sync + Send,

Lower level method, not intended for direct use

fn config(&self) -> &Config

Returns the freedom configuration for the API

fn config_mut(&mut self) -> &mut Config

Returns a mutable reference to the freedom configuration for the API

fn get_json_map<T>( &self, url: Url, ) -> impl Future<Output = Result<T, Error>> + Send + Sync

where T: Value,

Creates a get request at the provided absolute URI for the client’s environment, using basic authentication.

fn get_paginated<T>( &self, head_url: Url, ) -> PaginatedStream<'_, Self::Container<T>>

where T: 'static + Value + Send + Sync,

Creates a stream of items from a paginated endpoint.

fn path_to_url(&self, path: impl AsRef<str>) -> Url

Fetch the URL from the given path

fn delete_band_details( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the band details object matching the provided id

fn delete_satellite_configuration( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the satellite configuration matching the provided id

fn delete_satellite( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the satellite object matching the provided id

fn delete_override( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the override matching the provided id

fn delete_user( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the user matching the provided id

fn delete_task_request( &self, id: i32, ) -> impl Future<Output = Result<Response, Error>> + Send

Request to delete the user matching the provided id

fn post_deserialize<S, T>( &self, url: Url, msg: S, ) -> impl Future<Output = Result<T, Error>> + Send + Sync

where S: Serialize + Send + Sync, T: Value,

Lower level method, not intended for direct use

fn get_account_by_name( &self, account_name: &str, ) -> impl Future<Output = Result<Self::Container<Account>, Error>> + Send + Sync

Produces a single Account matching the provided ID.

fn get_file_by_task_id_and_name( &self, task_id: i32, file_name: &str, ) -> impl Future<Output = Result<Bytes, Error>> + Send + Sync

Produces a single Account matching the provided ID.

fn get_account_by_id( &self, account_id: i32, ) -> impl Future<Output = Result<Self::Container<Account>, Error>> + Send + Sync

Produces a single Account matching the provided ID.

fn get_accounts(&self) -> PaginatedStream<'_, Self::Container<Account>>

Produces a paginated stream of Account objects.

fn get_satellite_bands(&self) -> PaginatedStream<'_, Self::Container<Band>>

Produces a paginated stream of Band objects.

fn get_satellite_band_by_id( &self, satellite_band_id: i32, ) -> impl Future<Output = Result<Self::Container<Band>, Error>> + Send + Sync

Produces a single Band matching the provided ID.

fn get_satellite_band_by_name( &self, satellite_band_name: &str, ) -> impl Future<Output = Result<Self::Container<Band>, Error>> + Send + Sync

Produces a single Band matching the provided name.

fn get_satellite_bands_by_account_name( &self, account_name: &str, ) -> PaginatedStream<'_, Self::Container<Band>>

Produces a paginated stream of Band objects matching the provided account name.

fn get_satellite_configurations_by_account_name( &self, account_name: &str, ) -> PaginatedStream<'_, Self::Container<SatelliteConfiguration>>

Produces a paginated stream of SatelliteConfiguration objects matching the provided account name.

fn get_satellite_configurations( &self, ) -> PaginatedStream<'_, Self::Container<SatelliteConfiguration>>

Produces a paginated stream of SatelliteConfiguration objects.

fn get_satellite_configuration_by_id( &self, satellite_configuration_id: i32, ) -> impl Future<Output = Result<Self::Container<SatelliteConfiguration>, Error>> + Send + Sync

Produces a single satellite configuration matching the provided satellite configuration ID

fn get_satellite_configuration_by_name( &self, satellite_configuration_name: &str, ) -> impl Future<Output = Result<Self::Container<SatelliteConfiguration>, Error>> + Send + Sync

Produces a single satellite configuration matching the provided satellite configuration name

fn get_sites(&self) -> PaginatedStream<'_, Self::Container<Site>>

Produces a paginated stream of Site objects.

fn get_site_by_id( &self, id: i32, ) -> impl Future<Output = Result<Self::Container<Site>, Error>> + Send + Sync

Produces a single Site object matching the provided ID.

fn get_site_by_name( &self, name: impl AsRef<str> + Send + Sync, ) -> impl Future<Output = Result<Self::Container<Site>, Error>> + Send + Sync

Produces a single Site object matching the provided name.

fn get_request_by_id( &self, task_request_id: i32, ) -> impl Future<Output = Result<Self::Container<TaskRequest>, Error>> + Send + Sync

Produces a single TaskRequest matching the provided ID.

fn get_requests(&self) -> PaginatedStream<'_, Self::Container<TaskRequest>>

Produces a paginated stream of TaskRequest objects.

fn get_requests_by_target_date_between( &self, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

Produces a vector of TaskRequest items, representing all the task requests matching the target time overlapping with the provided time range.

fn get_requests_by_account_and_target_date_between<T>( &self, account_uri: T, start: OffsetDateTime, end: OffsetDateTime, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

where T: AsRef<str> + Send + Sync,

Produces a vector of TaskRequest items, representing all the task requests matching the account at the provided URI and whose target time overlaps with the provided time range.

fn get_requests_by_account_and_upcoming_today( &self, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

Produces a paginated stream of TaskRequest objects whose account name matches the provided name, and whose pass will occur today.

fn get_requests_by_configuration<T>( &self, configuration_uri: T, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

where T: AsRef<str> + Send + Sync,

Produces a paginated stream of TaskRequest objects whose satellite configuration matches that of the configuration at the configuration_uri endpoint.

fn get_requests_by_configuration_and_satellite_names_and_target_date_between<T, I, S>( &self, configuration_uri: T, satellites: I, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync, I: IntoIterator<Item = S> + Send + Sync, S: AsRef<str> + Send + Sync,

Produces a vector of TaskRequest items, representing all the task requests which match the provided configuration, whose satellite name matches one of the names provided as part of satellite_name, and which overlaps the provided time range.

fn get_requests_by_configuration_and_target_date_between<T>( &self, configuration_uri: T, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync,

Produces a vector of TaskRequest items, representing all the task requests matching the configuration at the provided URI and whose target time overlaps with the provided time range.

fn get_requests_by_ids<I, S>( &self, ids: I, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

where I: IntoIterator<Item = S> + Send + Sync, S: AsRef<str> + Send + Sync,

Produces a vector of TaskRequest items, representing all the task requests whose ID matches one of the IDs provided as part of ids.

fn get_requests_by_overlapping_public( &self, start: OffsetDateTime, end: OffsetDateTime, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

Produces a paginated stream of TaskRequest objects which are public, and which overlap with the provided time range.

fn get_requests_by_satellite_name<T>( &self, satellite_name: T, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

where T: AsRef<str> + Send + Sync,

Produces a paginated stream of TaskRequest objects whose satellite name matches one of the names provided as part of satellite_name.

fn get_requests_by_satellite_name_and_target_date_between<T>( &self, satellite_name: T, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync,

Produces a vector of TaskRequest items, representing all the task requests whose satellite name matches the provided name and whose target time overlaps with the provided time range.

fn get_requests_by_status<T>( &self, status: T, ) -> Result<PaginatedStream<'_, Self::Container<TaskRequest>>, Error>

where T: TryInto<TaskStatusType> + Send + Sync, Error: From<<T as TryInto<TaskStatusType>>::Error>,

Produces a paginated stream of TaskRequest objects whose status matches the provided status.

fn get_requests_by_status_and_account_and_target_date_between<T, U>( &self, status: T, account_uri: U, start: OffsetDateTime, end: OffsetDateTime, ) -> PaginatedStream<'_, Self::Container<TaskRequest>>

where T: AsRef<str> + Send + Sync, U: AsRef<str> + Send + Sync,

Produces a paginated stream of TaskRequest, representing all the task requests which match the provided status, account, and overlap the provided time range.

fn get_requests_by_type_and_target_date_between<T>( &self, typ: T, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

where T: TryInto<TaskType> + Send + Sync, Error: From<<T as TryInto<TaskType>>::Error>,

Produces a vector of TaskRequest items, representing all the tasks which match the provided type, overlap with the provided time range.

fn get_requests_passed_today( &self, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

Produces a vector of TaskRequest items, representing the list of tasks which have already occurred today.

fn get_requests_upcoming_today( &self, ) -> impl Future<Output = Result<Self::Container<Vec<TaskRequest>>, Error>> + Send + Sync

Produces a vector of TaskRequest items, representing the list of tasks which will occur later today.

fn get_satellites(&self) -> PaginatedStream<'_, Self::Container<Satellite>>

Produces a paginated stream of Satellite objects.

fn get_satellite_by_id( &self, satellite_id: i32, ) -> impl Future<Output = Result<Self::Container<Satellite>, Error>> + Send + Sync

Produces single satellite object matching the provided satellite ID

fn get_satellite_by_name( &self, satellite_name: &str, ) -> impl Future<Output = Result<Self::Container<Satellite>, Error>> + Send + Sync

Produces single satellite object matching the provided satellite name

fn get_task_by_id( &self, task_id: i32, ) -> impl Future<Output = Result<Self::Container<Task>, Error>> + Send + Sync

Produces a single Task matching the provided ID.

fn get_tasks_by_account_and_pass_overlapping<T>( &self, account_uri: T, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync,

Produces a vector of Task items, representing all the tasks which match the provided account, and intersect with the provided time frame.

fn get_tasks_by_account_and_satellite_and_band_and_pass_overlapping<T, U, V>( &self, account_uri: T, satellite_config_uri: U, band: V, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync, U: AsRef<str> + Send + Sync, V: AsRef<str> + Send + Sync,

Produces a vector of Task items, representing all the tasks which match the provided account, satellite, band, and intersect with the provided time frame.

fn get_tasks_by_account_and_site_configuration_and_band_and_pass_overlapping<T, U, V>( &self, account_uri: T, site_config_uri: U, band: V, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

where T: AsRef<str> + Send + Sync, U: AsRef<str> + Send + Sync, V: AsRef<str> + Send + Sync,

Produces a vector of Task representing all the tasks which match the provided account, site configuration, band, and intersect with the provided time frame.

fn get_tasks_by_pass_window( &self, start: OffsetDateTime, end: OffsetDateTime, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

Produces a vector of Task items, representing all the tasks contained within the provided time frame.

fn get_tasks_by_pass_overlapping( &self, start: OffsetDateTime, end: OffsetDateTime, ) -> PaginatedStream<'_, Self::Container<Task>>

Produces a paginated stream of Task items, representing all the tasks which overlap the provided time frame.

fn get_tasks_passed_today( &self, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

Produces a vector of Task items, representing the list of tasks which have already occurred today.

fn get_tasks_upcoming_today( &self, ) -> impl Future<Output = Result<Self::Container<Vec<Task>>, Error>> + Send + Sync

Produces a vector of Task items, representing the list of tasks which will occur later today.

fn get_users(&self) -> PaginatedStream<'_, Self::Container<User>>

Produces a paginated stream of User objects.

fn new_band_details(&self) -> BandDetailsBuilder<'_, Self, NoName>

where Self: Sized,

Create a new satellite band object

fn new_satellite_configuration( &self, ) -> SatelliteConfigurationBuilder<'_, Self, NoName>

where Self: Sized,

Create a new satellite configuration

fn new_satellite(&self) -> SatelliteBuilder<'_, Self, NoName>

where Self: Sized,

Create a new satellite

fn new_override(&self) -> OverrideBuilder<'_, Self, NoName>

where Self: Sized,

Create a new override

fn new_user(&self) -> UserBuilder<'_, Self, NoAccount>

where Self: Sized,

Create a new user

fn new_task_request(&self) -> TaskRequestBuilder<'_, Self, NoType>

where Self: Sized,

Create a new task request

fn new_token_by_site_configuration_id( &self, band_id: u32, site_configuration_id: u32, ) -> impl Future<Output = Result<String, Error>> + Send + Sync

Fetch an FPS token for the provided band ID and site configuration ID

fn new_token_by_satellite_id( &self, band_id: u32, satellite_id: u32, ) -> impl Future<Output = Result<String, Error>> + Send + Sync

Fetch an FPS token for the provided band ID and satellite ID

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Client

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.