View Source ExOura (ex_oura v1.0.0)

Documentation for Oura API

Summary

Functions

List Webhook Subscription

Single Personal Info

Types

document_id()

@type document_id() :: String.t()

end_date()

@type end_date() :: Date.t()

error()

@type error() :: {:error, ExOura.Client.HTTPValidationError.t()}

next_token()

@type next_token() :: String.t() | nil

opts()

@type opts() :: Keyword.t()

start_date()

@type start_date() :: Date.t()

webhook()

webhook_id()

@type webhook_id() :: String.t()

Functions

create_webhook_subscription(webhook, opts \\ [])

@spec create_webhook_subscription(webhook(), opts()) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()

Create Webhook Subscription

delete_webhook_subscription(webhook_id, opts \\ [])

@spec delete_webhook_subscription(webhook_id(), opts()) :: :ok | error()

Delete Webhook Subscription

get_webhook_subscription(webhook_id, opts \\ [])

@spec get_webhook_subscription(webhook_id(), opts()) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()

Get Webhook Subscription

list_webhook_subscriptions(opts \\ [])

@spec list_webhook_subscriptions(opts()) ::
  {:ok, [ExOura.Client.WebhookSubscriptionModel.t()]} | error()

List Webhook Subscription

multiple_daily_activity(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_activity(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseDailyActivityModel.t()} | error()

Multiple Daily Activity

multiple_daily_cardiovascular_age(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_cardiovascular_age(
  start_date(),
  end_date(),
  next_token(),
  opts()
) ::
  {:ok, ExOura.Client.MultiDocumentResponseDailyCardiovascularAgeModel.t()}
  | error()

Multiple Daily Cardiovascular Age

multiple_daily_readiness(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_readiness(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseDailyReadinessModel.t()} | error()

Multiple Daily Readiness

multiple_daily_resilience(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_resilience(
  start_date(),
  end_date(),
  next_token(),
  opts()
) ::
  {:ok, ExOura.Client.MultiDocumentResponseDailyResilienceModel.t()} | error()

Multiple Daily Resilience

multiple_daily_sleep(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_sleep(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseDailySleepModel.t()} | error()

Multiple Daily Sleep

multiple_daily_sp02(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_sp02(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseDailySpO2Model.t()} | error()

Multiple Daily Sp02

multiple_daily_stress(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_daily_stress(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseDailyStressModel.t()} | error()

Multiple Daily Stress

multiple_enhanced_tag(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_enhanced_tag(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseEnhancedTagModel.t()} | error()

Multiple Enhanced Tag

multiple_heart_rate(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_heart_rate(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.TimeSeriesResponseHeartRateModel.t()} | error()

Multiple Heart Rate

multiple_rest_mode_period(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_rest_mode_period(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseRestModePeriodModel.t()} | error()

Multiple Rest Mode Period

multiple_ring_configuration(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_ring_configuration(
  start_date(),
  end_date(),
  next_token(),
  opts()
) ::
  {:ok, ExOura.Client.MultiDocumentResponseRingConfigurationModel.t()} | error()

Multiple Ring Configuration

multiple_session(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_session(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseSessionModel.t()} | error()

Multiple Session

multiple_sleep(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_sleep(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseSleepModel.t()} | error()

Multiple Sleep

multiple_sleep_time(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_sleep_time(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseSleepTimeModel.t()} | error()

Multiple Sleep Time

multiple_vo2_max(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_vo2_max(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseVo2MaxModel.t()} | error()

Multiple Vo2 Max

multiple_workout(start_date, end_date, next_token \\ nil, opts \\ [])

@spec multiple_workout(
  start_date(),
  end_date(),
  next_token(),
  opts()
) :: {:ok, ExOura.Client.MultiDocumentResponseWorkoutModel.t()} | error()

Multiple Workout

renew_webhook_subscription(webhook_id, opts \\ [])

@spec renew_webhook_subscription(webhook_id(), opts()) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()

Renew Webhook Subscription

single_daily_activity(document_id, opts \\ [])

@spec single_daily_activity(document_id(), opts()) ::
  {:ok, ExOura.Client.DailyActivityModel.t()} | error()

Single Daily Activity

single_daily_cardiovascular_age(document_id, opts \\ [])

@spec single_daily_cardiovascular_age(document_id(), opts()) ::
  {:ok, ExOura.Client.DailyCardiovascularAgeModel.t()} | error()

Single Daily Cardiovascular Age

single_daily_readiness(document_id, opts \\ [])

@spec single_daily_readiness(document_id(), opts()) ::
  {:ok, ExOura.Client.DailyReadinessModel.t()} | error()

Single Daily Readiness

single_daily_resilience(document_id, opts \\ [])

@spec single_daily_resilience(document_id(), opts()) ::
  {:ok, ExOura.Client.DailyResilienceModel.t()} | error()

Single Daily Resilience

single_daily_sleep(document_id, opts \\ [])

@spec single_daily_sleep(document_id(), opts()) ::
  {:ok, ExOura.Client.DailySleepModel.t()} | error()

Single Daily Sleep

single_daily_sp02(document_id, opts \\ [])

@spec single_daily_sp02(document_id(), opts()) ::
  {:ok, ExOura.Client.DailySpO2Model.t()} | error()

Single Daily Sp02

single_daily_stress(document_id, opts \\ [])

@spec single_daily_stress(document_id(), opts()) ::
  {:ok, ExOura.Client.DailyStressModel.t()} | error()

Single Daily Stress

single_enhanced_tag(document_id, opts \\ [])

@spec single_enhanced_tag(document_id(), opts()) ::
  {:ok, ExOura.Client.EnhancedTagModel.t()} | error()

Single Enhanced Tag

single_personal_info(opts \\ [])

@spec single_personal_info(opts()) ::
  {:ok, ExOura.Client.PersonalInfoResponse.t()} | error()

Single Personal Info

single_rest_mode_period(document_id, opts \\ [])

@spec single_rest_mode_period(document_id(), opts()) ::
  {:ok, ExOura.Client.RestModePeriodModel.t()} | error()

Single Rest Mode Period

single_ring_configuration(document_id, opts \\ [])

@spec single_ring_configuration(document_id(), opts()) ::
  {:ok, ExOura.Client.RingConfigurationModel.t()} | error()

Single Ring Configuration

single_session(document_id, opts \\ [])

@spec single_session(document_id(), opts()) ::
  {:ok, ExOura.Client.SessionModel.t()} | error()

Single Session

single_sleep(document_id, opts \\ [])

@spec single_sleep(document_id(), opts()) ::
  {:ok, ExOura.Client.SleepModel.t()} | error()

Single Sleep

single_sleep_time(document_id, opts \\ [])

@spec single_sleep_time(document_id(), opts()) ::
  {:ok, ExOura.Client.SleepTimeModel.t()} | error()

Single Sleep Time

single_vo2_max(document_id, opts \\ [])

@spec single_vo2_max(document_id(), opts()) ::
  {:ok, ExOura.Client.Vo2MaxModel.t()} | error()

Single Vo2 Max

single_workout(document_id, opts \\ [])

@spec single_workout(document_id(), opts()) ::
  {:ok, ExOura.Client.WorkoutModel.t()} | error()

Single Workout

update_webhook_subscription(webhook_id, webhook, opts \\ [])

@spec update_webhook_subscription(webhook_id(), webhook(), opts()) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()} | error()

Update Webhook Subscription