Class: Brevo::CreateWhatsAppTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/create_whats_app_template.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWhatsAppTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 88

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'language')
    self.language = attributes[:'language']
  end

  if attributes.has_key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.has_key?(:'mediaUrl')
    self.media_url = attributes[:'mediaUrl']
  end

  if attributes.has_key?(:'bodyText')
    self.body_text = attributes[:'bodyText']
  end

  if attributes.has_key?(:'headerText')
    self.header_text = attributes[:'headerText']
  end

  if attributes.has_key?(:'source')
    self.source = attributes[:'source']
  end
end

Instance Attribute Details

#body_text ⇒ Object

Body of the template. **Maximum allowed characters are 1024**



30
31
32
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 30

def body_text
  @body_text
end

#category ⇒ Object

Category of the template



24
25
26
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 24

def category
  @category
end

#header_text ⇒ Object

Text content of the header in the template. **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**



33
34
35
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 33

def header_text
  @header_text
end

#language ⇒ Object

Language of the template. For Example : en for English



21
22
23
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 21

def language
  @language
end

#media_url ⇒ Object

Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty.** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf



27
28
29
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 27

def media_url
  @media_url
end

#name ⇒ Object

Name of the template



18
19
20
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 18

def name
  @name
end

#source ⇒ Object

source of the template



36
37
38
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 36

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 61

def self.attribute_map
  {
    :'name' => :'name',
    :'language' => :'language',
    :'category' => :'category',
    :'media_url' => :'mediaUrl',
    :'body_text' => :'bodyText',
    :'header_text' => :'headerText',
    :'source' => :'source'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 74

def self.swagger_types
  {
    :'name' => :'String',
    :'language' => :'String',
    :'category' => :'String',
    :'media_url' => :'String',
    :'body_text' => :'String',
    :'header_text' => :'String',
    :'source' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      language == o.language &&
      category == o.category &&
      media_url == o.media_url &&
      body_text == o.body_text &&
      header_text == o.header_text &&
      source == o.source
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 230

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Brevo.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 296

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 209

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 202

def hash
  [name, language, category, media_url, body_text, header_text, source].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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 276

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 282

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



270
271
272
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 270

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/brevo/models/create_whats_app_template.rb', line 148

def valid?
  return false if @name.nil?
  return false if @language.nil?
  return false if @category.nil?
  category_validator = EnumAttributeValidator.new('String', ['MARKETING', 'UTILITY'])
  return false unless category_validator.valid?(@category)
  return false if @body_text.nil?
  source_validator = EnumAttributeValidator.new('String', ['Automation', 'Conversations'])
  return false unless source_validator.valid?(@source)
  true
end