ExOura.Client.RingConfigurationRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to ring configuration routes

Summary

Functions

multiple_ring_configuration_documents_v2_usercollection_ring_configuration_get(opts \\ [])

Multiple Ring Configuration Documents

single_ring_configuration_document_v2_usercollection_ring_configuration_document_id_get(document_id, opts \\ [])

Single Ring Configuration Document

Functions

multiple_ring_configuration_documents_v2_usercollection_ring_configuration_get(opts \\ [])

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

Multiple Ring Configuration Documents

Options

  • 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.
  • next_token

single_ring_configuration_document_v2_usercollection_ring_configuration_document_id_get(document_id, opts \\ [])

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

Single Ring Configuration Document