AgentPushKit.Api.Health (agent_push_kit v0.1.0)

API calls for all endpoints tagged Health.

Summary

Functions

get_health(connection, opts \\ [])

Check Agent Push Kit API health

Functions

get_health(connection, opts \\ [])

@spec get_health(
  Tesla.Env.client(),
  keyword()
) :: {:ok, AgentPushKit.Model.HealthResponse.t()} | {:error, Tesla.Env.t()}

Check Agent Push Kit API health

Parameters

connection (AgentPushKit.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.HealthResponse.t} on success
{:error, Tesla.Env.t} on failure