ArchAstro.SDK.Types.StatusPing (archastro v0.3.5)

Copy Markdown

Health check response confirming the API is reachable and indicating whether the caller's token is valid.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.SDK.Types.StatusPing{
  deployment: ArchAstro.SDK.Types.Deployment.t() | ArchAstro.SDK.Unset.t(),
  success: boolean(),
  token: %{optional(String.t()) => ArchAstro.SDK.JSON.t()},
  user: ArchAstro.SDK.Types.User.t() | nil | ArchAstro.SDK.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.SDK.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.SDK.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.SDK.JSON.object()