Class: MessenteApi::WhatsApp

Inherits:
Object
  • Object
show all
Defined in:
lib/messente_api/models/whats_app.rb

Overview

WhatsApp message content. Only one of "text", "image", "document" or "audio" can be provided

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WhatsApp

Initializes the object



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/messente_api/models/whats_app.rb', line 114

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

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

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

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

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

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

  if attributes.key?(:'channel')
    self.channel = attributes[:'channel']
  else
    self.channel = 'whatsapp'
  end

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

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

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

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

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

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

Instance Attribute Details

#audio ⇒ Object

Returns the value of attribute audio.



39
40
41
 
# File 'lib/messente_api/models/whats_app.rb', line 39

def audio
  @audio
end

#channel ⇒ Object

The channel used to deliver the message



31
32
33
 
# File 'lib/messente_api/models/whats_app.rb', line 31

def channel
  @channel
end

#document ⇒ Object

Returns the value of attribute document.



41
42
43
 
# File 'lib/messente_api/models/whats_app.rb', line 41

def document
  @document
end

#image ⇒ Object

Returns the value of attribute image.



35
36
37
 
# File 'lib/messente_api/models/whats_app.rb', line 35

def image
  @image
end

#sender ⇒ Object

Phone number or alphanumeric sender name



20
21
22
 
# File 'lib/messente_api/models/whats_app.rb', line 20

def sender
  @sender
end

#sticker ⇒ Object

Returns the value of attribute sticker.



43
44
45
 
# File 'lib/messente_api/models/whats_app.rb', line 43

def sticker
  @sticker
end

#template ⇒ Object

Returns the value of attribute template.



28
29
30
 
# File 'lib/messente_api/models/whats_app.rb', line 28

def template
  @template
end

#text ⇒ Object

Returns the value of attribute text.



33
34
35
 
# File 'lib/messente_api/models/whats_app.rb', line 33

def text
  @text
end

#ttl ⇒ Object

After how many seconds this channel is considered as failed and the next channel is attempted. Only one of "ttl" and "validity" can be used.



26
27
28
 
# File 'lib/messente_api/models/whats_app.rb', line 26

def ttl
  @ttl
end

#validity ⇒ Object

After how many minutes this channel is considered as failed and the next channel is attempted



23
24
25
 
# File 'lib/messente_api/models/whats_app.rb', line 23

def validity
  @validity
end

#video ⇒ Object

Returns the value of attribute video.



37
38
39
 
# File 'lib/messente_api/models/whats_app.rb', line 37

def video
  @video
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/messente_api/models/whats_app.rb', line 258

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MessenteApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/messente_api/models/whats_app.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/messente_api/models/whats_app.rb', line 68

def self.attribute_map
  {
    :'sender' => :'sender',
    :'validity' => :'validity',
    :'ttl' => :'ttl',
    :'template' => :'template',
    :'channel' => :'channel',
    :'text' => :'text',
    :'image' => :'image',
    :'video' => :'video',
    :'audio' => :'audio',
    :'document' => :'document',
    :'sticker' => :'sticker'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/messente_api/models/whats_app.rb', line 234

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



107
108
109
110
 
# File 'lib/messente_api/models/whats_app.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/messente_api/models/whats_app.rb', line 90

def self.openapi_types
  {
    :'sender' => :'String',
    :'validity' => :'Integer',
    :'ttl' => :'Integer',
    :'template' => :'WhatsAppTemplate',
    :'channel' => :'String',
    :'text' => :'WhatsAppText',
    :'image' => :'WhatsAppImage',
    :'video' => :'WhatsAppVideo',
    :'audio' => :'WhatsAppAudio',
    :'document' => :'WhatsAppDocument',
    :'sticker' => :'WhatsAppSticker'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/messente_api/models/whats_app.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sender == o.sender &&
      validity == o.validity &&
      ttl == o.ttl &&
      template == o.template &&
      channel == o.channel &&
      text == o.text &&
      image == o.image &&
      video == o.video &&
      audio == o.audio &&
      document == o.document &&
      sticker == o.sticker
end

#_to_hash(value) ⇒ Hash

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/messente_api/models/whats_app.rb', line 329

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


221
222
223
 
# File 'lib/messente_api/models/whats_app.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



227
228
229
 
# File 'lib/messente_api/models/whats_app.rb', line 227

def hash
  [sender, validity, ttl, template, channel, text, image, video, audio, document, sticker].hash
end

#list_invalid_properties ⇒ Object

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



176
177
178
179
180
 
# File 'lib/messente_api/models/whats_app.rb', line 176

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



305
306
307
 
# File 'lib/messente_api/models/whats_app.rb', line 305

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/messente_api/models/whats_app.rb', line 311

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

#to_s ⇒ String

Returns the string representation of the object



299
300
301
 
# File 'lib/messente_api/models/whats_app.rb', line 299

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



184
185
186
187
188
189
 
# File 'lib/messente_api/models/whats_app.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  channel_validator = EnumAttributeValidator.new('String', ["whatsapp"])
  return false unless channel_validator.valid?(@channel)
  true
end