View Source ExOura (ex_oura v1.0.0)
Documentation for Oura API
Summary
Functions
Create Webhook Subscription
Delete Webhook Subscription
Get Webhook Subscription
List Webhook Subscription
Multiple Daily Activity
Multiple Daily Cardiovascular Age
Multiple Daily Readiness
Multiple Daily Resilience
Multiple Daily Sleep
Multiple Daily Sp02
Multiple Daily Stress
Multiple Enhanced Tag
Multiple Heart Rate
Multiple Rest Mode Period
Multiple Ring Configuration
Multiple Sleep Time
Renew Webhook Subscription
Single Daily Activity
Single Daily Cardiovascular Age
Single Daily Readiness
Single Daily Resilience
Single Daily Sleep
Single Daily Sp02
Single Daily Stress
Single Enhanced Tag
Single Personal Info
Single Rest Mode Period
Single Ring Configuration
Single Session
Single Sleep
Single Sleep Time
Single Vo2 Max
Single Workout
Update Webhook Subscription
Types
@type document_id() :: String.t()
@type end_date() :: Date.t()
@type error() :: {:error, ExOura.Client.HTTPValidationError.t()}
@type next_token() :: String.t() | nil
@type opts() :: Keyword.t()
@type start_date() :: Date.t()
@type webhook() :: ExOura.Client.CreateWebhookSubscriptionRequest.t() | ExOura.Client.UpdateWebhookSubscriptionRequest.t()
@type webhook_id() :: String.t()
Functions
@spec create_webhook_subscription(webhook(), opts()) :: {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()
Create Webhook Subscription
@spec delete_webhook_subscription(webhook_id(), opts()) :: :ok | error()
Delete Webhook Subscription
@spec get_webhook_subscription(webhook_id(), opts()) :: {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()
Get Webhook Subscription
@spec list_webhook_subscriptions(opts()) :: {:ok, [ExOura.Client.WebhookSubscriptionModel.t()]} | error()
List Webhook Subscription
@spec multiple_daily_activity( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailyActivityModel.t()} | error()
Multiple Daily Activity
@spec multiple_daily_cardiovascular_age( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailyCardiovascularAgeModel.t()} | error()
Multiple Daily Cardiovascular Age
@spec multiple_daily_readiness( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailyReadinessModel.t()} | error()
Multiple Daily Readiness
@spec multiple_daily_resilience( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailyResilienceModel.t()} | error()
Multiple Daily Resilience
@spec multiple_daily_sleep( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailySleepModel.t()} | error()
Multiple Daily Sleep
@spec multiple_daily_sp02( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailySpO2Model.t()} | error()
Multiple Daily Sp02
@spec multiple_daily_stress( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseDailyStressModel.t()} | error()
Multiple Daily Stress
@spec multiple_enhanced_tag( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseEnhancedTagModel.t()} | error()
Multiple Enhanced Tag
@spec multiple_heart_rate( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.TimeSeriesResponseHeartRateModel.t()} | error()
Multiple Heart Rate
@spec multiple_rest_mode_period( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseRestModePeriodModel.t()} | error()
Multiple Rest Mode Period
@spec multiple_ring_configuration( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseRingConfigurationModel.t()} | error()
Multiple Ring Configuration
@spec multiple_session( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseSessionModel.t()} | error()
Multiple Session
@spec multiple_sleep( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseSleepModel.t()} | error()
Multiple Sleep
@spec multiple_sleep_time( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseSleepTimeModel.t()} | error()
Multiple Sleep Time
@spec multiple_vo2_max( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseVo2MaxModel.t()} | error()
Multiple Vo2 Max
@spec multiple_workout( start_date(), end_date(), next_token(), opts() ) :: {:ok, ExOura.Client.MultiDocumentResponseWorkoutModel.t()} | error()
Multiple Workout
@spec renew_webhook_subscription(webhook_id(), opts()) :: {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()
Renew Webhook Subscription
@spec single_daily_activity(document_id(), opts()) :: {:ok, ExOura.Client.DailyActivityModel.t()} | error()
Single Daily Activity
@spec single_daily_cardiovascular_age(document_id(), opts()) :: {:ok, ExOura.Client.DailyCardiovascularAgeModel.t()} | error()
Single Daily Cardiovascular Age
@spec single_daily_readiness(document_id(), opts()) :: {:ok, ExOura.Client.DailyReadinessModel.t()} | error()
Single Daily Readiness
@spec single_daily_resilience(document_id(), opts()) :: {:ok, ExOura.Client.DailyResilienceModel.t()} | error()
Single Daily Resilience
@spec single_daily_sleep(document_id(), opts()) :: {:ok, ExOura.Client.DailySleepModel.t()} | error()
Single Daily Sleep
@spec single_daily_sp02(document_id(), opts()) :: {:ok, ExOura.Client.DailySpO2Model.t()} | error()
Single Daily Sp02
@spec single_daily_stress(document_id(), opts()) :: {:ok, ExOura.Client.DailyStressModel.t()} | error()
Single Daily Stress
@spec single_enhanced_tag(document_id(), opts()) :: {:ok, ExOura.Client.EnhancedTagModel.t()} | error()
Single Enhanced Tag
@spec single_personal_info(opts()) :: {:ok, ExOura.Client.PersonalInfoResponse.t()} | error()
Single Personal Info
@spec single_rest_mode_period(document_id(), opts()) :: {:ok, ExOura.Client.RestModePeriodModel.t()} | error()
Single Rest Mode Period
@spec single_ring_configuration(document_id(), opts()) :: {:ok, ExOura.Client.RingConfigurationModel.t()} | error()
Single Ring Configuration
@spec single_session(document_id(), opts()) :: {:ok, ExOura.Client.SessionModel.t()} | error()
Single Session
@spec single_sleep(document_id(), opts()) :: {:ok, ExOura.Client.SleepModel.t()} | error()
Single Sleep
@spec single_sleep_time(document_id(), opts()) :: {:ok, ExOura.Client.SleepTimeModel.t()} | error()
Single Sleep Time
@spec single_vo2_max(document_id(), opts()) :: {:ok, ExOura.Client.Vo2MaxModel.t()} | error()
Single Vo2 Max
@spec single_workout(document_id(), opts()) :: {:ok, ExOura.Client.WorkoutModel.t()} | error()
Single Workout
@spec update_webhook_subscription(webhook_id(), webhook(), opts()) :: {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()
Update Webhook Subscription