Class: Omnichannel::WhatsApp

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WhatsApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/omnichannel/models/whats_app.rb', line 62

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?(:'sender')
    self.sender = attributes[:'sender']
  end

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

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

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

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

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

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

Instance Attribute Details

#audio ⇒ Object

Returns the value of attribute audio.



30
31
32
 
# File 'lib/omnichannel/models/whats_app.rb', line 30

def audio
  @audio
end

#channel ⇒ Object

Returns the value of attribute channel.



32
33
34
 
# File 'lib/omnichannel/models/whats_app.rb', line 32

def channel
  @channel
end

#document ⇒ Object

Returns the value of attribute document.



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

def document
  @document
end

#image ⇒ Object

Returns the value of attribute image.



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

def image
  @image
end

#sender ⇒ Object

Phone number or alphanumeric sender name



19
20
21
 
# File 'lib/omnichannel/models/whats_app.rb', line 19

def sender
  @sender
end

#text ⇒ Object

Returns the value of attribute text.



24
25
26
 
# File 'lib/omnichannel/models/whats_app.rb', line 24

def text
  @text
end

#validity ⇒ Object

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



22
23
24
 
# File 'lib/omnichannel/models/whats_app.rb', line 22

def validity
  @validity
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/omnichannel/models/whats_app.rb', line 35

def self.attribute_map
  {
    :'sender' => :'sender',
    :'validity' => :'validity',
    :'text' => :'text',
    :'image' => :'image',
    :'document' => :'document',
    :'audio' => :'audio',
    :'channel' => :'channel'
  }
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



141
142
143
 
# File 'lib/omnichannel/models/whats_app.rb', line 141

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/omnichannel/models/whats_app.rb', line 48

def self.openapi_types
  {
    :'sender' => :'String',
    :'validity' => :'Integer',
    :'text' => :'WhatsAppText',
    :'image' => :'WhatsAppImage',
    :'document' => :'WhatsAppDocument',
    :'audio' => :'WhatsAppAudio',
    :'channel' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/omnichannel/models/whats_app.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sender == o.sender &&
      validity == o.validity &&
      text == o.text &&
      image == o.image &&
      document == o.document &&
      audio == o.audio &&
      channel == o.channel
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/omnichannel/models/whats_app.rb', line 169

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
    Omnichannel.const_get(type).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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/omnichannel/models/whats_app.rb', line 234

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/omnichannel/models/whats_app.rb', line 148

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


128
129
130
 
# File 'lib/omnichannel/models/whats_app.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/omnichannel/models/whats_app.rb', line 134

def hash
  [sender, validity, text, image, document, audio, channel].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



101
102
103
104
 
# File 'lib/omnichannel/models/whats_app.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  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



214
215
216
 
# File 'lib/omnichannel/models/whats_app.rb', line 214

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/omnichannel/models/whats_app.rb', line 220

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



208
209
210
 
# File 'lib/omnichannel/models/whats_app.rb', line 208

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



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

def valid?
  true
end