ExOura.Client.SleepRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to sleep routes

Summary

Functions

multiple_sleep_documents_v2_usercollection_sleep_get(opts \\ [])

Multiple Sleep Documents

single_sleep_document_v2_usercollection_sleep_document_id_get(document_id, opts \\ [])

Single Sleep Document

Functions

multiple_sleep_documents_v2_usercollection_sleep_get(opts \\ [])

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

Multiple 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_sleep_document_v2_usercollection_sleep_document_id_get(document_id, opts \\ [])

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

Single Sleep Document