Class: Inttegro::OTP::Transmission

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/otp/transmission.rb

Overview

Typed representation of the transmission object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#recipient ⇒ String (readonly)

Value of the recipient field in the Inttegro API payload.

Required in the API payload. Wire name: recipient.

Returns:

  • (String) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/otp/transmission.rb', line 49

class Transmission < T::Struct
  const :recipient, String
  const :sender_id, String
  const :sent_at, T.nilable(Time), default: nil
  const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
  const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
end

#sender_id ⇒ String (readonly)

SMS sender identifier or approved email From address.

Required in the API payload. Wire name: sender_id.

Returns:

  • (String) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/otp/transmission.rb', line 49

class Transmission < T::Struct
  const :recipient, String
  const :sender_id, String
  const :sent_at, T.nilable(Time), default: nil
  const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
  const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
end

#sent_at ⇒ Time? (readonly)

Value of the sent_at field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: sent_at.

Returns:

  • (Time, nil) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/otp/transmission.rb', line 49

class Transmission < T::Struct
  const :recipient, String
  const :sender_id, String
  const :sent_at, T.nilable(Time), default: nil
  const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
  const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
end

#sent_via ⇒ Inttegro::Chime::Transport? (readonly)

Value of the sent_via field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: sent_via.

Returns:



49
50
51
52
53
54
55
 
# File 'lib/inttegro/otp/transmission.rb', line 49

class Transmission < T::Struct
  const :recipient, String
  const :sender_id, String
  const :sent_at, T.nilable(Time), default: nil
  const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
  const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
end

#status ⇒ Inttegro::OTP::TransmissionStatus? (readonly)

Value of the status field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: status.

Returns:



49
50
51
52
53
54
55
 
# File 'lib/inttegro/otp/transmission.rb', line 49

class Transmission < T::Struct
  const :recipient, String
  const :sender_id, String
  const :sent_at, T.nilable(Time), default: nil
  const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
  const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
end