Inttegro.Errors.Error (inttegro v0.2.0)

Represents Error data in the Errors API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Structured API, transport, and decoding failures returned by the SDK.

Summary

Types

t()

The decoded error value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Errors.Error and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Errors.Error{
  cause: String.t() | nil,
  code: String.t(),
  detail: String.t() | nil,
  fix_code: String.t() | nil,
  message: String.t() | nil,
  type: String.t(),
  url: String.t()
}

The decoded error value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Errors.Error and raises KeyError when a required field is missing.