ExOura.Session (ex_oura v3.0.1)

Copy Markdown View Source

Documentation for Oura API - Session

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()

session_response()

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

single_session_response()

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

start_date()

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

Functions

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

@spec multiple_session(start_date(), end_date(), next_token(), opts()) ::
  session_response()

Multiple Session

single_session(document_id, opts \\ [])

@spec single_session(document_id(), opts()) :: single_session_response()

Single Session