Class: Inttegro::MessageTemplate::VariableInput

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

Overview

Typed representation of the variable input 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 the variable.

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

Returns:

  • (String, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), default: nil
end

#default ⇒ Object? (readonly)

Default value used when this variable is omitted.

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

Returns:

  • (Object, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), default: nil
end

#items ⇒ Array<Inttegro::MessageTemplate::VariableItemInput>? (readonly)

Field schema for array item objects. Nested arrays are not supported.

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

Returns:



55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), 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) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), default: nil
end

#required ⇒ Boolean? (readonly)

Value of the required field in the Inttegro API payload.

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

Returns:

  • (Boolean, nil) 


55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), default: nil
end

#type ⇒ Inttegro::MessageTemplate::VariableType (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.

Returns:



55
56
57
58
59
60
61
62
 
# File 'lib/inttegro/message_template/variable_input.rb', line 55

class VariableInput < T::Struct
  const :name, String
  const :type, Inttegro::MessageTemplate::VariableType
  const :required, T.nilable(T::Boolean), default: nil
  const :default, T.nilable(Object), default: nil
  const :about, T.nilable(String), default: nil
  const :items, T.nilable(T::Array[Inttegro::MessageTemplate::VariableItemInput]), default: nil
end