Module: Whatsapp::MessageTemplates::ParameterFormats

Defined in:
lib/ruby/whatsapp/message_templates/parameter_formats.rb

Overview

The two placeholder styles a template can declare, set once per template via parameter_format and inherited by every component in it.

POSITIONAL uses {{1}}, {{2}} — index numbers starting at 1, and send-side values must be supplied in the same order. NAMED uses {{first_name}} — lowercase-and-underscore names, and send-side values may be supplied in any order. POSITIONAL is Meta's default when the field is omitted.

The format also decides the key name of a component's example payload, which is why it has to be threaded down into each component. See Example. Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/overview

Constant Summary collapse

POSITIONAL = 
"POSITIONAL"
NAMED = 
"NAMED"
ALL = 
[POSITIONAL, NAMED].freeze

Class Method Summary collapse

Class Method Details

.named?(value) ⇒ Boolean

Parameters:

  • value (String, Symbol, nil)

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/ruby/whatsapp/message_templates/parameter_formats.rb', line 38

def self.named?(value)
  normalize(value) == NAMED
end

.normalize(value) ⇒ String?

Normalizes caller input to a canonical uppercase format string.

Meta's own docs are inconsistent about enum casing, so callers may reasonably pass :named, "named", or "NAMED". Unrecognized values are returned untouched so validations can report them.

Parameters:

  • value (String, Symbol, nil)

Returns:

  • (String, nil) 


29
30
31
32
33
34
 
# File 'lib/ruby/whatsapp/message_templates/parameter_formats.rb', line 29

def self.normalize(value)
  return if value.nil?

  candidate = value.to_s.upcase
  ALL.include?(candidate) ? candidate : value.to_s
end

.valid?(value) ⇒ Boolean

Parameters:

  • value (String, Symbol, nil)

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/ruby/whatsapp/message_templates/parameter_formats.rb', line 44

def self.valid?(value)
  ALL.include?(normalize(value))
end