Guava.Events (Guava v0.34.0)

Server-to-client events received over a call's WebSocket connection.

Each event is a struct discriminated on the wire by event_type. Use decode/1 to turn a decoded JSON map into the matching struct.

Summary

Types

t()

Any event that can be received from the Guava server.

Functions

decode(m)

Decode a JSON map into an event struct.

decode_json(json)

Decode an event from a JSON string. Returns nil for unknown types.

Types

t()

@type t() ::
  Guava.Events.InboundCall.t()
  | Guava.Events.SocketHealth.t()
  | Guava.Events.CallerSpeech.t()
  | Guava.Events.AgentSpeech.t()
  | Guava.Events.Error.t()
  | Guava.Events.Warning.t()
  | Guava.Events.AgentQuestion.t()
  | Guava.Events.Intent.t()
  | Guava.Events.ActionRequest.t()
  | Guava.Events.ActionItemCompleted.t()
  | Guava.Events.TaskCompleted.t()
  | Guava.Events.ExecuteAction.t()
  | Guava.Events.OutboundCallConnected.t()
  | Guava.Events.OutboundCallFailed.t()
  | Guava.Events.BotSessionEnded.t()
  | Guava.Events.ChoiceQuery.t()
  | Guava.Events.Escalate.t()
  | Guava.Events.DTMFPressed.t()
  | Guava.Events.OutboundSessionStarted.t()

Any event that can be received from the Guava server.

Functions

decode(m)

@spec decode(map()) :: t() | nil

Decode a JSON map into an event struct.

Returns nil (and logs a warning) for unknown event types, matching the Python SDK's forward-compatible behavior.

decode_json(json)

@spec decode_json(String.t() | binary()) :: t() | nil

Decode an event from a JSON string. Returns nil for unknown types.