Class: Omnichannel::Omnimessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Omnimessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/omnichannel/models/omnimessage.rb', line 50

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?(:'messages')
    if (value = attributes[:'messages']).is_a?(Array)
      self.messages = value
    end
  end

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

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

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

Instance Attribute Details

#dlr_urlObject

URL where the delivery report will be sent



23
24
25
# File 'lib/omnichannel/models/omnimessage.rb', line 23

def dlr_url
  @dlr_url
end

#messagesObject

Returns the value of attribute messages.



17
18
19
# File 'lib/omnichannel/models/omnimessage.rb', line 17

def messages
  @messages
end

#time_to_sendObject

Optional parameter for sending messages at some specific time in the future. Time must be specified in the 8601 format. If no timezone is specified, then the timezone is assumed to be UTC. Examples: Time specified with timezone: 2018-06-22T09:05:07+00:00 Time specified in UTC: 2018-06-22T09:05:07Z Time specified without timezone: 2018-06-22T09:05 (equivalent to 2018-06-22T09:05+00:00)



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

def time_to_send
  @time_to_send
end

#toObject

Phone number of the recipient in e.164 format



20
21
22
# File 'lib/omnichannel/models/omnimessage.rb', line 20

def to
  @to
end

Class Method Details

.attribute_mapObject

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



29
30
31
32
33
34
35
36
# File 'lib/omnichannel/models/omnimessage.rb', line 29

def self.attribute_map
  {
    :'messages' => :'messages',
    :'to' => :'to',
    :'dlr_url' => :'dlr_url',
    :'time_to_send' => :'time_to_send'
  }
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



124
125
126
# File 'lib/omnichannel/models/omnimessage.rb', line 124

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

.openapi_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
# File 'lib/omnichannel/models/omnimessage.rb', line 39

def self.openapi_types
  {
    :'messages' => :'Array<OneOfViberSMSWhatsApp>',
    :'to' => :'String',
    :'dlr_url' => :'String',
    :'time_to_send' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



100
101
102
103
104
105
106
107
# File 'lib/omnichannel/models/omnimessage.rb', line 100

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages == o.messages &&
      to == o.to &&
      dlr_url == o.dlr_url &&
      time_to_send == o.time_to_send
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/omnichannel/models/omnimessage.rb', line 152

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



217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/omnichannel/models/omnimessage.rb', line 217

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/omnichannel/models/omnimessage.rb', line 131

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


111
112
113
# File 'lib/omnichannel/models/omnimessage.rb', line 111

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



117
118
119
# File 'lib/omnichannel/models/omnimessage.rb', line 117

def hash
  [messages, to, dlr_url, time_to_send].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/omnichannel/models/omnimessage.rb', line 77

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



197
198
199
# File 'lib/omnichannel/models/omnimessage.rb', line 197

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
# File 'lib/omnichannel/models/omnimessage.rb', line 203

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



191
192
193
# File 'lib/omnichannel/models/omnimessage.rb', line 191

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



92
93
94
95
96
# File 'lib/omnichannel/models/omnimessage.rb', line 92

def valid?
  return false if @messages.nil?
  return false if @to.nil?
  true
end