Class: Inttegro::MessageTemplate::CreateSMSRequest

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

Overview

Typed representation of the create sms 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)

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) 


62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

class CreateSMSRequest < T::Struct
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::CreateSMSRequestChannel
  const :locale, T.nilable(String), default: nil
  const :name, String
  const :purpose, String
  const :sms, Inttegro::MessageTemplate::SMSContent
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
end

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

Value of the channel field in the Inttegro API payload.

Required in the API payload. Wire name: channel.

Returns:



62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

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


62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

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


62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

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


62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

class CreateSMSRequest < T::Struct
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::CreateSMSRequestChannel
  const :locale, T.nilable(String), default: nil
  const :name, String
  const :purpose, String
  const :sms, Inttegro::MessageTemplate::SMSContent
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
end

#sms ⇒ Inttegro::MessageTemplate::SMSContent (readonly)

Value of the sms field in the Inttegro API payload.

Required in the API payload. Wire name: sms.

Returns:



62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

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



62
63
64
65
66
67
68
69
70
 
# File 'lib/inttegro/message_template/create_sms_request.rb', line 62

class CreateSMSRequest < T::Struct
  const :about, T.nilable(String), default: nil
  const :channel, Inttegro::MessageTemplate::CreateSMSRequestChannel
  const :locale, T.nilable(String), default: nil
  const :name, String
  const :purpose, String
  const :sms, Inttegro::MessageTemplate::SMSContent
  const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
end