Class: Zernio::CommentAutomationTemplate

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/comment_automation_template.rb

Overview

A Meta generic template (product card) sent as the automation's first DM. It REPLACES the plain dmMessage bubble: a Meta message carries one body shape, and a comment gets exactly one private reply, so the card and the text cannot both be delivered. Put your selling copy in subtitle. Mutually exclusive with buttons (sending both is a 400). Works on both the comment and story_reply triggers. Up to 10 elements, rendered as a horizontally swipeable carousel. Rendering confirmed on the Instagram and Messenger mobile apps.

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 = {}) ⇒ CommentAutomationTemplate

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



84
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
113
114
115
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CommentAutomationTemplate` 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::CommentAutomationTemplate`. 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']
  else
    self.type = nil
  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
  else
    self.elements = nil
  end
end

Instance Attribute Details

#elements ⇒ Object

Returns the value of attribute elements.



24
25
26
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 24

def elements
  @elements
end

#image_aspect_ratio ⇒ Object

Facebook only. How Messenger renders each element imageUrl: horizontal (1.91:1, the default) or square (1:1). Instagram has no such setting, so an Instagram automation carrying it is a 400.



22
23
24
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 22

def image_aspect_ratio
  @image_aspect_ratio
end

#type ⇒ Object

Returns the value of attribute type.



19
20
21
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 19

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 219

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 196

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 212

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @elements.nil?
    invalid_properties.push('invalid value for "elements", elements cannot be nil.')
  end

  if @elements.length > 10
    invalid_properties.push('invalid value for "elements", number of items must be less than or equal to 10.')
  end

  if @elements.length < 1
    invalid_properties.push('invalid value for "elements", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 241

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

Returns:

  • (Boolean) —

    true if the model is valid



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/zernio-sdk/models/comment_automation_template.rb', line 143

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  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?
  return false if @elements.length > 10
  return false if @elements.length < 1
  true
end