Struct OuraClient

pub struct OuraClient<'a> { /* private fields */ }

The Oura API client.

This client is used to make requests to the Oura API.

Implementations

impl<'a> OuraClient<'a>

pub fn new(token: &'a str) -> Self

Creates a new OuraClient from a personal access token.

pub fn build_with_base_url(token: &'a str, base_url: &'a str) -> Self

Creates a new OuraClient from a personal access token and a base URL.

Note: This is only useful for testing against a mock server.

pub fn get_daily_activity(&self, id: &str) -> Result<DailyActivity, Error>

Gets a single DailyActivity item by id.

pub fn list_daily_activity( &self, query: DateQuery<'_>, ) -> Result<ListResponse<DailyActivity>, Error>

Returns a ListResponse of DailyActivity items based on the supplied query.

pub fn get_daily_readiness(&self, id: &str) -> Result<DailyReadiness, Error>

Gets a single DailyReadiness item by id.

pub fn list_daily_readiness( &self, query: DateQuery<'_>, ) -> Result<ListResponse<DailyReadiness>, Error>

Returns a ListResponse of DailyReadiness items based on the supplied query.

pub fn get_daily_sleep(&self, id: &str) -> Result<DailySleep, Error>

Gets a single DailySleep item by id.

pub fn list_daily_sleep( &self, query: DateQuery<'_>, ) -> Result<ListResponse<DailySleep>, Error>

Returns a ListResponse of DailySleep items based on the supplied query.

pub fn get_daily_spo2(&self, id: &str) -> Result<DailySpO2, Error>

Gets a single DailySpO2 item by id.

pub fn list_daily_spo2( &self, query: DateQuery<'_>, ) -> Result<ListResponse<DailySpO2>, Error>

Returns a ListResponse of DailySpO2 items based on the supplied query.

pub fn list_heart_rate( &self, query: DatetimeQuery<'_>, ) -> Result<ListResponse<HeartRate>, Error>

Returns a ListResponse of HeartRate items based on the supplied query.

pub fn get_personal_info(&self) -> Result<PersonalInfo, Error>

Returns a PersonalInfo based on the caller.

pub fn get_rest_mode_period(&self, id: &str) -> Result<RestModePeriod, Error>

Gets a single RestModePeriod item by id.

pub fn list_rest_mode_period( &self, query: DateQuery<'_>, ) -> Result<ListResponse<RestModePeriod>, Error>

Returns a ListResponse of RestModePeriod items based on the supplied query.

pub fn get_ring_configuration( &self, id: &str, ) -> Result<RingConfiguration, Error>

Gets a single RingConfiguration item by id.

pub fn list_ring_configuration( &self, query: DateQuery<'_>, ) -> Result<ListResponse<RingConfiguration>, Error>

Returns a ListResponse of RingConfiguration items based on the supplied query.

pub fn get_session(&self, id: &str) -> Result<Session, Error>

Gets a single Session item by id.

pub fn list_session( &self, query: DateQuery<'_>, ) -> Result<ListResponse<Session>, Error>

Returns a ListResponse of Session items based on the supplied query.

pub fn get_sleep(&self, id: &str) -> Result<Sleep, Error>

Gets a single Sleep item by id.

pub fn list_sleep( &self, query: DateQuery<'_>, ) -> Result<ListResponse<Sleep>, Error>

Returns a ListResponse of Sleep items based on the supplied query.

pub fn get_sleep_time(&self, id: &str) -> Result<SleepTime, Error>

Gets a single SleepTime item by id.

pub fn list_sleep_time( &self, query: DateQuery<'_>, ) -> Result<ListResponse<SleepTime>, Error>

Returns a ListResponse of SleepTime items based on the supplied query.

pub fn get_tag(&self, id: &str) -> Result<Tag, Error>

Gets a single Tag item by id.

pub fn list_tag(&self, query: DateQuery<'_>) -> Result<ListResponse<Tag>, Error>

Returns a ListResponse of Tag items based on the supplied query.

pub fn get_workout(&self, id: &str) -> Result<Workout, Error>

Gets a single Workout item by id.

pub fn list_workout( &self, query: DateQuery<'_>, ) -> Result<ListResponse<Workout>, Error>

Returns a ListResponse of Workout items based on the supplied query.

pub fn get_tag_v2(&self, id: &str) -> Result<TagV2, Error>

Gets a single TagV2 item by id.

pub fn list_tag_v2( &self, query: DateQuery<'_>, ) -> Result<ListResponse<TagV2>, Error>

Returns a ListResponse of TagV2 items based on the supplied query.