Inttegro.Schedules.Error (inttegro v0.2.0)

Represents Error data in the Schedules 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.

Reads and cancels scheduled work created through Inttegro APIs.

A schedule records when a supported operation should run and whether it is still actionable. Cancellation affects future execution; it does not reverse work that has already completed.

Summary

Types

t()

The decoded error value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Schedules.Error{
  fix_code: String.t() | nil,
  recipient: String.t() | nil,
  type: String.t() | nil
}

The decoded error value.

Functions

new!(attrs \\ %{})

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

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