Class: Zernio::SendInboxMessageRequestTemplate

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/send_inbox_message_request_template.rb

Overview

Platform-dependent template payload. Ignored on Telegram. Instagram / Facebook: a generic template (carousel). Set type: generic and provide up to 10 elements, each with a title (required) and optional subtitle, imageUrl, and buttons. Mutually exclusive with the top-level buttons field (sending both is a 400); put the card's buttons on its elements instead. On Facebook, imageAspectRatio (horizontal, the default, or square) sets how Messenger renders the element images; Instagram has no such setting and rejects it. WhatsApp: sends an approved WhatsApp template message, the only message type WhatsApp accepts when the 24-hour customer-service window is closed. Provide exactly one element carrying the template reference: { \"elements\": [{ \"name\": \"order_update\", \"language\": \"en_US\", \"components\": [...] }] } (type is ignored on WhatsApp). components is optional and is forwarded unchanged as the template.components array of Meta's Cloud API send payload; use it to fill body/header variables and button parameters, e.g. [{ \"type\": \"body\", \"parameters\": [{ \"type\": \"text\", \"text\": \"John\" }] }]. Templates with media headers (image, video, document) must include the header component with its media link here at send time. To send a template to a phone number with no existing conversation, or to have media headers filled in automatically from the template definition, use the create-conversation endpoint (POST /v1/inbox/conversations) instead.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SendInboxMessageRequestTemplate

Initializes the object



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::SendInboxMessageRequestTemplate` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::SendInboxMessageRequestTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'image_aspect_ratio')
    self.image_aspect_ratio = attributes[:'image_aspect_ratio']
  end

  if attributes.key?(:'elements')
    if (value = attributes[:'elements']).is_a?(Array)
      self.elements = value
    end
  end
end

Instance Attribute Details

#elements ⇒ Object

Returns the value of attribute elements.



25
26
27
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 25

def elements
  @elements
end

#image_aspect_ratio ⇒ Object

Facebook only. Aspect ratio Messenger renders element images at: horizontal (1.91:1, default) or square (1:1). A 400 on Instagram.



23
24
25
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 23

def image_aspect_ratio
  @image_aspect_ratio
end

#type ⇒ Object

Template type. Required for Instagram/Facebook generic templates; ignored on WhatsApp.



20
21
22
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 50

def self.attribute_map
  {
    :'type' => :'type',
    :'image_aspect_ratio' => :'imageAspectRatio',
    :'elements' => :'elements'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 197

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 78

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 69

def self.openapi_types
  {
    :'type' => :'String',
    :'image_aspect_ratio' => :'String',
    :'elements' => :'Array<SendInboxMessageRequestTemplateElementsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



174
175
176
177
178
179
180
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      image_aspect_ratio == o.image_aspect_ratio &&
      elements == o.elements
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


184
185
186
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



190
191
192
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 190

def hash
  [type, image_aspect_ratio, elements].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



116
117
118
119
120
121
122
123
124
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 116

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@elements.nil? && @elements.length > 10
    invalid_properties.push('invalid value for "elements", number of items must be less than or equal to 10.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



128
129
130
131
132
133
134
135
136
 
# File 'lib/zernio-sdk/models/send_inbox_message_request_template.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["generic"])
  return false unless type_validator.valid?(@type)
  image_aspect_ratio_validator = EnumAttributeValidator.new('String', ["horizontal", "square"])
  return false unless image_aspect_ratio_validator.valid?(@image_aspect_ratio)
  return false if !@elements.nil? && @elements.length > 10
  true
end