Class: Inttegro::MessageTemplate::Rendered

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/message_template/rendered.rb

Overview

Typed representation of the rendered 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

#attachments ⇒ Inttegro::MessageTemplate::AttachmentIDs? (readonly)

Stored file IDs returned by previews. Chime send, schedule, and broadcast currently reject stored-template attachments.

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

Returns:



46
47
48
49
50
51
 
# File 'lib/inttegro/message_template/rendered.rb', line 46

class Rendered < T::Struct
  const :channel, Inttegro::MessageTemplate::Channel
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::RenderedSMS), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::RenderedEmail), default: nil
end

#channel ⇒ Inttegro::MessageTemplate::Channel (readonly)

Value of the channel field in the Inttegro API payload.

Required in the API payload. Wire name: channel.

Returns:



46
47
48
49
50
51
 
# File 'lib/inttegro/message_template/rendered.rb', line 46

class Rendered < T::Struct
  const :channel, Inttegro::MessageTemplate::Channel
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::RenderedSMS), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::RenderedEmail), default: nil
end

#email ⇒ Inttegro::MessageTemplate::RenderedEmail? (readonly)

Value of the email field in the Inttegro API payload.

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

Returns:



46
47
48
49
50
51
 
# File 'lib/inttegro/message_template/rendered.rb', line 46

class Rendered < T::Struct
  const :channel, Inttegro::MessageTemplate::Channel
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::RenderedSMS), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::RenderedEmail), default: nil
end

#sms ⇒ Inttegro::MessageTemplate::RenderedSMS? (readonly)

Value of the sms field in the Inttegro API payload.

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

Returns:



46
47
48
49
50
51
 
# File 'lib/inttegro/message_template/rendered.rb', line 46

class Rendered < T::Struct
  const :channel, Inttegro::MessageTemplate::Channel
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::RenderedSMS), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::RenderedEmail), default: nil
end