ExOura.RestModePeriod (ex_oura v4.0.0)

Copy Markdown View Source

Documentation for Oura API - Rest Mode Period

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

rest_mode_period_response()

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

single_rest_mode_period_response()

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

start_date()

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

Functions

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

@spec multiple_rest_mode_period(start_date(), end_date(), next_token(), opts()) ::
  rest_mode_period_response()

Multiple Rest Mode Period

single_rest_mode_period(document_id, opts \\ [])

@spec single_rest_mode_period(document_id(), opts()) ::
  single_rest_mode_period_response()

Single Rest Mode Period