Class: Inttegro::Broadcast::Error

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/broadcast/error.rb

Overview

Error encountered when broadcasting to a specific recipient

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

#fix_code ⇒ String? (readonly)

Code indicating how to fix this error

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/broadcast/error.rb', line 35

class Error < T::Struct
  const :recipient, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
end

#recipient ⇒ String? (readonly)

Recipient address that caused the error

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/broadcast/error.rb', line 35

class Error < T::Struct
  const :recipient, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
end

#type ⇒ String? (readonly)

Error type classification

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/broadcast/error.rb', line 35

class Error < T::Struct
  const :recipient, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
end