Class: Inttegro::MessageTemplate

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/message_template/message_template.rb,
lib/inttegro/message_template/base.rb,
lib/inttegro/message_template/page.rb,
lib/inttegro/message_template/status.rb,
lib/inttegro/message_template/channel.rb,
lib/inttegro/message_template/mailbox.rb,
lib/inttegro/message_template/preview.rb,
lib/inttegro/message_template/envelope.rb,
lib/inttegro/message_template/rendered.rb,
lib/inttegro/message_template/variable.rb,
lib/inttegro/message_template/reference.rb,
lib/inttegro/message_template/variables.rb,
lib/inttegro/message_template/id_request.rb,
lib/inttegro/message_template/sms_content.rb,
lib/inttegro/message_template/page_request.rb,
lib/inttegro/message_template/rendered_sms.rb,
lib/inttegro/message_template/scanned_link.rb,
lib/inttegro/message_template/create_fields.rb,
lib/inttegro/message_template/email_content.rb,
lib/inttegro/message_template/page_envelope.rb,
lib/inttegro/message_template/safety_result.rb,
lib/inttegro/message_template/variable_item.rb,
lib/inttegro/message_template/variable_type.rb,
lib/inttegro/message_template/attachment_ids.rb,
lib/inttegro/message_template/create_request.rb,
lib/inttegro/message_template/rendered_email.rb,
lib/inttegro/message_template/update_request.rb,
lib/inttegro/message_template/variable_input.rb,
lib/inttegro/message_template/create_sms_request.rb,
lib/inttegro/message_template/variable_item_type.rb,
lib/inttegro/message_template/variable_item_input.rb,
lib/inttegro/message_template/create_email_request.rb,
lib/inttegro/message_template/render_preview_request.rb,
lib/inttegro/message_template/create_sms_request_channel.rb,
lib/inttegro/message_template/create_email_request_channel.rb

Overview

Typed representation of the message template 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.

Defined Under Namespace

Classes: Channel, CreateEmailRequest, CreateEmailRequestChannel, CreateFields, CreateSMSRequest, CreateSMSRequestChannel, EmailContent, Envelope, IDRequest, Mailbox, Page, PageEnvelope, PageRequest, Preview, Reference, RenderPreviewRequest, Rendered, RenderedEmail, RenderedSMS, SMSContent, SafetyResult, ScannedLink, Status, UpdateRequest, Variable, VariableInput, VariableItem, VariableItemInput, VariableItemType, VariableType, Variables

Constant Summary collapse

AttachmentIDs =

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

Returns:

  • (Array<String>) 
T.type_alias { T::Array[String] }
CreateRequest =

Create request for one reusable SMS or email message template.

Returns:

T.type_alias { T.any(Inttegro::MessageTemplate::CreateSMSRequest, Inttegro::MessageTemplate::CreateEmailRequest) }

Instance Attribute Summary collapse

Instance Attribute Details

#about ⇒ String? (readonly)

Value of the about field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#archived_at ⇒ Time? (readonly)

Value of the archived_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#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:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), 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:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#draft_version ⇒ Integer (readonly)

Value of the draft_version field in the Inttegro API payload.

Required in the API payload. Wire name: draft_version.

Returns:

  • (Integer) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#email ⇒ Inttegro::MessageTemplate::EmailContent? (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:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#has_unpublished_changes ⇒ Boolean (readonly)

Value of the has_unpublished_changes field in the Inttegro API payload.

Required in the API payload. Wire name: has_unpublished_changes.

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#id ⇒ String (readonly)

API-generated unique template id.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#locale ⇒ String (readonly)

Value of the locale field in the Inttegro API payload.

Required in the API payload. Wire name: locale.

Returns:

  • (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#name ⇒ String (readonly)

Value of the name field in the Inttegro API payload.

Required in the API payload. Wire name: name.

Returns:

  • (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#published_at ⇒ Time? (readonly)

Value of the published_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#published_version ⇒ Integer? (readonly)

Value of the published_version field in the Inttegro API payload.

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

Returns:

  • (Integer, nil) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#purpose ⇒ String (readonly)

Value of the purpose field in the Inttegro API payload.

Required in the API payload. Wire name: purpose.

Returns:

  • (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#sms ⇒ Inttegro::MessageTemplate::SMSContent? (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:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#status ⇒ Inttegro::MessageTemplate::Status (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#updated_at ⇒ Time (readonly)

Value of the updated_at field in the Inttegro API payload.

Required in the API payload. Wire name: updated_at.

Returns:

  • (Time) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#variables ⇒ Array<Inttegro::MessageTemplate::Variable>? (readonly)

Value of the variables field in the Inttegro API payload.

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

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#version ⇒ Integer (readonly)

Value of the version field in the Inttegro API payload.

Required in the API payload. Wire name: version.

Returns:

  • (Integer) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/inttegro/message_template/message_template.rb', line 137

class MessageTemplate
  const :id, String
  const :name, String
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::Channel
  const :purpose, String
  const :locale, String
  const :status, Inttegro::MessageTemplate::Status
  const :version, Integer
  const :published_version, T.nilable(Integer), default: nil
  const :draft_version, Integer
  const :has_unpublished_changes, T::Boolean
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), default: nil
  const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
  const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
  const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :published_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end