ExOura.Tag (ex_oura v2.0.0)

View Source

Tag API operations for the deprecated Tag endpoints.

Note: Tag endpoints are deprecated. Use Enhanced Tags instead.

Summary

Types

document_id()
end_date()
next_token()
opts()
start_date()

Functions

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

Multiple Tag Documents

single_tag(document_id, opts \\ [])

Single Tag Document

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

start_date()

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

Functions

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

@spec multiple_tag(start_date(), end_date(), next_token(), opts()) ::
  {:ok, ExOura.Client.MultiDocumentResponseTagModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Multiple Tag Documents

Note: This endpoint is deprecated. Use Enhanced Tags instead.

single_tag(document_id, opts \\ [])

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

Single Tag Document

Note: This endpoint is deprecated. Use Enhanced Tags instead.