ExOura.Client.DailySleepRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to daily sleep routes

Summary

Functions

multiple_daily_sleep_documents_v2_usercollection_daily_sleep_get(opts \\ [])

Multiple Daily Sleep Documents

single_daily_sleep_document_v2_usercollection_daily_sleep_document_id_get(document_id, opts \\ [])

Single Daily Sleep Document

Functions

multiple_daily_sleep_documents_v2_usercollection_daily_sleep_get(opts \\ [])

@spec multiple_daily_sleep_documents_v2_usercollection_daily_sleep_get(
  opts :: keyword()
) ::
  {:ok,
   ExOura.Client.MultiDocumentResponseDict.t()
   | ExOura.Client.MultiDocumentResponsePublicDailySleep.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Multiple Daily Sleep Documents

Options

  • start_date
  • end_date
  • next_token
  • fields: Comma-separated list of fields to include in the response, in addition to the always returned fields. Defaults to all fields if not provided.

single_daily_sleep_document_v2_usercollection_daily_sleep_document_id_get(document_id, opts \\ [])

@spec single_daily_sleep_document_v2_usercollection_daily_sleep_document_id_get(
  document_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.PublicDailySleep.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Single Daily Sleep Document