Class: Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb

Defined Under Namespace

Modules: Format, Type Classes: Example

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(file_format:, type:, example: nil, text: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent for more details.

Optional header displayed at the top of the message.

Parameters:




# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 34

Instance Attribute Details

#example ⇒ Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent::Example?

Sample values for header variables.

Returns:



25
 
# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 25

optional :example, -> { Telnyx::Whatsapp::WhatsappTemplateHeaderComponent::Example }

#file_format ⇒ Symbol, Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent::Format

Header format type: TEXT (supports one variable), IMAGE, VIDEO, DOCUMENT, or LOCATION.

Returns:



12
13
14
 
# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 12

required :file_format,
enum: -> { Telnyx::Whatsapp::WhatsappTemplateHeaderComponent::Format },
api_name: :format

#text ⇒ String?

Header text. Required when format is TEXT. Supports one variable ({1}). Variables cannot be at the start or end.

Returns:

  • (String, nil) 


32
 
# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 32

optional :text, String

#type ⇒ Symbol, Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent::Type

Returns:



19
 
# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 19

required :type, enum: -> { Telnyx::Whatsapp::WhatsappTemplateHeaderComponent::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/whatsapp/whatsapp_template_header_component.rb', line 61