Class: Telnyx::Models::EmailTemplateCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/email_template_create_params.rb,
sig/telnyx/models/email_template_create_params.rbs

Overview

See Also:

  • Telnyx::Resources::EmailTemplates#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(name:, html_body: nil, subject: nil, text_body: nil, variables: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

  • name (String) —

    Letters, numbers, spaces, hyphens, and underscores only.

  • html_body (String, nil) (defaults to: nil) —

    Liquid template HTML body.

  • subject (String, nil) (defaults to: nil) —

    Liquid template subject.

  • text_body (String, nil) (defaults to: nil) —

    Liquid template text body.

  • variables (Array<String>) (defaults to: nil) —

    Template variables. Auto-extracted from subject/body fields when absent.

  • idempotency_key (String) (defaults to: nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/email_template_create_params.rb', line 45

Instance Attribute Details

#html_body ⇒ String?

Liquid template HTML body.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


20
 
# File 'lib/telnyx/models/email_template_create_params.rb', line 20

optional :html_body, String, nil?: true

#idempotency_key ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/telnyx/models/email_template_create_params.rb', line 43

optional :idempotency_key, String

#name ⇒ String

Letters, numbers, spaces, hyphens, and underscores only.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/email_template_create_params.rb', line 14

required :name, String

#subject ⇒ String?

Liquid template subject.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/email_template_create_params.rb', line 26

optional :subject, String, nil?: true

#text_body ⇒ String?

Liquid template text body.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :text_body, String, nil?: true

#variables ⇒ Array<String>?

Template variables. Auto-extracted from subject/body fields when absent.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


38
 
# File 'lib/telnyx/models/email_template_create_params.rb', line 38

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/telnyx/models/email_template_create_params.rbs', line 44

def to_hash: -> {