Class: Telnyx::Models::Whatsapp::TemplateCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/whatsapp/template_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Category, Component

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(category:, components:, language:, name:, waba_id:, request_options: {}) ⇒ Object

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

Parameters:




# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 44

Instance Attribute Details

#category ⇒ Symbol, Telnyx::Models::Whatsapp::TemplateCreateParams::Category

Template category: AUTHENTICATION, UTILITY, or MARKETING.

Returns:



15
 
# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 15

required :category, enum: -> { Telnyx::Whatsapp::TemplateCreateParams::Category }

#components ⇒ Array<Telnyx::Models::Whatsapp::WhatsappTemplateHeaderComponent, Telnyx::Models::Whatsapp::WhatsappTemplateBodyComponent, Telnyx::Models::Whatsapp::WhatsappTemplateFooterComponent, Telnyx::Models::Whatsapp::WhatsappTemplateButtonsComponent, Telnyx::Models::Whatsapp::WhatsappTemplateCarouselComponent>

Template components defining message structure. Passed through to Meta Graph API. Templates with variables must include example values. Supports HEADER, BODY, FOOTER, BUTTONS, CAROUSEL and any future Meta component types.

Returns:



23
24
 
# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 23

required :components,
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Whatsapp::TemplateCreateParams::Component] }

#language ⇒ String

Template language code (e.g. en_US, es, pt_BR).

Returns:

  • (String) 


30
 
# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 30

required :language, String

#name ⇒ String

Template name. Lowercase letters, numbers, and underscores only.

Returns:

  • (String) 


36
 
# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 36

required :name, String

#waba_id ⇒ String

The WhatsApp Business Account ID.

Returns:

  • (String) 


42
 
# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 42

required :waba_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/whatsapp/template_create_params.rb', line 68