Class: Inttegro::MessageTemplate::UpdateRequest

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

Overview

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

#about ⇒ String? (readonly)

Optional description of when this template should be used.

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

Returns:

  • (String, nil) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
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:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

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

Existing template channel. Channels cannot be changed.

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

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
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:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

#id ⇒ String (readonly)

API-generated message template id.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

#locale ⇒ String? (readonly)

Value of the locale field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

#name ⇒ String? (readonly)

Human-readable template name.

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

Returns:

  • (String, nil) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

#purpose ⇒ String? (readonly)

Caller-defined purpose for filtering and analytics.

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

Returns:

  • (String, nil) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
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:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end

#variables ⇒ Array<Inttegro::MessageTemplate::VariableInput>? (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:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/inttegro/message_template/update_request.rb', line 83

class UpdateRequest < T::Struct
  const :id, String
  const :name, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
  const :purpose, T.nilable(String), default: nil
  const :locale, T.nilable(String), default: nil
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), 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
end