ExOura.RingConfiguration (ex_oura v4.0.0)

Documentation for Oura API - Ring Configuration

Summary

document_id()

end_date()

next_token()

opts()

start_date()

Multiple Ring Configuration

Single Ring Configuration

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

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

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

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

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

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

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

@spec multiple_ring_configuration(start_date(), end_date(), next_token(), opts()) ::
  public_ring_configuration_response()

Multiple Ring Configuration

@spec single_ring_configuration(document_id(), opts()) ::
  single_ring_configuration_response()

Single Ring Configuration