ExOura.Vo2Max (ex_oura v3.0.1)

Copy Markdown View Source

Documentation for Oura API - Vo2 Max

Summary

Types

document_id()

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

end_date()

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

next_token()

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

opts()

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

single_vo2_max_response()

@type single_vo2_max_response() ::
  {:ok, ExOura.Client.PublicVo2Max.t()} | {:error, term()}

start_date()

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

vo2_max_response()

@type vo2_max_response() ::
  {:ok, ExOura.Client.MultiDocumentResponsePublicVo2Max.t()} | {:error, term()}

Functions

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

@spec multiple_vo2_max(start_date(), end_date(), next_token(), opts()) ::
  vo2_max_response()

Multiple Vo2 Max

single_vo2_max(document_id, opts \\ [])

@spec single_vo2_max(document_id(), opts()) :: single_vo2_max_response()

Single Vo2 Max