Class: PureCloud::ConversationNotificationChat

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/conversation_notification_chat.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationNotificationChat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
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
116
117
118
119
120
121
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 75

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 39

def additional_properties
  @additional_properties
end

#connected_time ⇒ Object

Returns the value of attribute connected_time.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 35

def connected_time
  @connected_time
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 31

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

Returns the value of attribute disconnected_time.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 37

def disconnected_time
  @disconnected_time
end

#held ⇒ Object

Returns the value of attribute held.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 29

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 23

def id
  @id
end

#provider ⇒ Object

Returns the value of attribute provider.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 25

def provider
  @provider
end

#room_id ⇒ Object

Returns the value of attribute room_id.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 27

def room_id
  @room_id
end

#start_hold_time ⇒ Object

Returns the value of attribute start_hold_time.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 33

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

Returns the value of attribute state.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 21

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 42

def self.attribute_map
  {
    :'state' => :'state',
    :'id' => :'id',
    :'provider' => :'provider',
    :'room_id' => :'roomId',
    :'held' => :'held',
    :'disconnect_type' => :'disconnectType',
    :'start_hold_time' => :'startHoldTime',
    :'connected_time' => :'connectedTime',
    :'disconnected_time' => :'disconnectedTime',
    :'additional_properties' => :'additionalProperties'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 58

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'provider' => :'String',
    :'room_id' => :'String',
    :'held' => :'BOOLEAN',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'additional_properties' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      provider == o.provider &&
      room_id == o.room_id &&
      held == o.held &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 212

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 272

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

build the object from hash



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 188

def hash
  [state, id, provider, room_id, held, disconnect_type, start_hold_time, connected_time, disconnected_time, additional_properties].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



125
126
127
128
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



255
256
257
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 255

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 260

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 ⇒ Object 



250
251
252
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 250

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



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/purecloudplatformclientv2/models/conversation_notification_chat.rb', line 132

def valid?
  allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "NONE"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSFER_FORWARD", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM", "UNCALLABLE"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
end