Inttegro.Otp.Transmission (inttegro v0.2.0)

Represents Transmission data in the Otp 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.

Initiates, verifies, and inspects one-time passcode transactions.

OTP delivery and verification are separate steps. Initiation returning successfully means the transaction was accepted, not that the recipient received or verified the code. Keep the returned transaction ID and submit the user-provided code through verify/3.

Summary

Types

t()

The decoded transmission value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Otp.Transmission and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Otp.Transmission{
  recipient: String.t(),
  sender_id: String.t(),
  sent_at: String.t() | nil,
  sent_via: String.t() | nil,
  status: Inttegro.Otp.TransmissionStatus.t() | nil
}

The decoded transmission value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.Otp.Transmission and raises KeyError when a required field is missing.