Class: Zavudev::Models::TemplateCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Zavudev::Models::TemplateCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/zavudev/models/template_create_params.rb

Overview

See Also:

• Resources::Templates#create

Defined Under Namespace

Modules: HeaderType Classes: Button

Instance Attribute Summary

• #add_security_recommendation ⇒ Boolean^?

  Add ‘Do not share this code’ disclaimer.

• #body ⇒ String

  Default template body.

• #buttons ⇒ Array<Zavudev::Models::TemplateCreateParams::Button>^?

  Template buttons (max 3).

• #code_expiration_minutes ⇒ Integer^?

  Code expiration time in minutes.

• #footer ⇒ String^?

  Footer text for the template.

• #header_content ⇒ String^?

  Header content (text string or media URL).

• #header_type ⇒ Symbol, ...

  Type of header for the template.

• #instagram_body ⇒ String^?

  Channel-specific body for Instagram.

• #language ⇒ String
• #name ⇒ String
• #sms_body ⇒ String^?

  Channel-specific body for SMS.

• #telegram_body ⇒ String^?

  Channel-specific body for Telegram.

• #variables ⇒ Array<String>^?
• #whatsapp_category ⇒ Symbol, ...

  WhatsApp template category.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from Zavudev::Internal::Type::BaseModel

Instance Attribute Details

#add_security_recommendation ⇒ Boolean^?

Add ‘Do not share this code’ disclaimer. Only for AUTHENTICATION templates.

Returns:

• (Boolean, nil)

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

optional :add_security_recommendation,
Zavudev::Internal::Type::Boolean,
api_name: :addSecurityRecommendation

#body ⇒ String

Default template body. Used when no channel-specific body is set.

Returns:

• (String)

# File 'lib/zavudev/models/template_create_params.rb', line 14

required :body, String

#buttons ⇒ Array<Zavudev::Models::TemplateCreateParams::Button>^?

Template buttons (max 3).

Returns:

• (Array<Zavudev::Models::TemplateCreateParams::Button>, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 38

optional :buttons, -> { Zavudev::Internal::Type::ArrayOf[Zavudev::TemplateCreateParams::Button] }

#code_expiration_minutes ⇒ Integer^?

Code expiration time in minutes. Only for AUTHENTICATION templates.

Returns:

• (Integer, nil)

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

optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes

#footer ⇒ String^?

Footer text for the template.

Returns:

• (String, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 50

optional :footer, String

#header_content ⇒ String^?

Header content (text string or media URL).

Returns:

• (String, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 56

optional :header_content, String, api_name: :headerContent

#header_type ⇒ Symbol, ...

Type of header for the template.

Returns:

• (Symbol, Zavudev::Models::TemplateCreateParams::HeaderType, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 62

optional :header_type, enum: -> { Zavudev::TemplateCreateParams::HeaderType }, api_name: :headerType

#instagram_body ⇒ String^?

Channel-specific body for Instagram. Falls back to ‘body` if not set.

Returns:

• (String, nil)

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

optional :instagram_body, String, api_name: :instagramBody

#language ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/template_create_params.rb', line 19

required :language, String

#name ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/template_create_params.rb', line 24

required :name, String

#sms_body ⇒ String^?

Channel-specific body for SMS. Falls back to ‘body` if not set.

Returns:

• (String, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 74

optional :sms_body, String, api_name: :smsBody

#telegram_body ⇒ String^?

Channel-specific body for Telegram. Falls back to ‘body` if not set.

Returns:

• (String, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 80

optional :telegram_body, String, api_name: :telegramBody

#variables ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 85

optional :variables, Zavudev::Internal::Type::ArrayOf[String]

#whatsapp_category ⇒ Symbol, ...

WhatsApp template category.

Returns:

• (Symbol, Zavudev::Models::WhatsappCategory, nil)

# File 'lib/zavudev/models/template_create_params.rb', line 91

optional :whatsapp_category, enum: -> { Zavudev::WhatsappCategory }, api_name: :whatsappCategory

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/zavudev/models/template_create_params.rb', line 205