ExOura.Client.TagRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to tag routes

Summary

Functions

multiple_tag_documents_v2_usercollection_tag_get(opts \\ [])

Multiple Tag Documents

single_tag_document_v2_usercollection_tag_document_id_get(document_id, opts \\ [])

Single Tag Document

Functions

multiple_tag_documents_v2_usercollection_tag_get(opts \\ [])

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

Multiple Tag Documents

Options

  • start_date
  • end_date
  • next_token
  • fields: N/A. This route does not support field selection yet, all fields will be returned.

single_tag_document_v2_usercollection_tag_document_id_get(document_id, opts \\ [])

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

Single Tag Document