Class: PureCloud::CallConversation

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/call_conversation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallConversation

Returns a new instance of CallConversation.



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
98
99
100
101
102
103
104
# File 'lib/purecloud/models/call_conversation.rb', line 69

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'participants']
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end
  
  if attributes[:'otherMediaUris']
    if (value = attributes[:'otherMediaUris']).is_a?(Array)
      self.other_media_uris = value
    end
  end
  
  if attributes[:'recordingState']
    self.recording_state = attributes[:'recordingState']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloud/models/call_conversation.rb', line 22

def id
  @id
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloud/models/call_conversation.rb', line 24

def name
  @name
end

#other_media_urisObject

The list of other media channels involved in the conversation.



30
31
32
# File 'lib/purecloud/models/call_conversation.rb', line 30

def other_media_uris
  @other_media_uris
end

#participantsObject

The list of participants involved in the conversation.



27
28
29
# File 'lib/purecloud/models/call_conversation.rb', line 27

def participants
  @participants
end

#recording_stateObject

Returns the value of attribute recording_state.



32
33
34
# File 'lib/purecloud/models/call_conversation.rb', line 32

def recording_state
  @recording_state
end

#self_uriObject

The URI for this object



35
36
37
# File 'lib/purecloud/models/call_conversation.rb', line 35

def self_uri
  @self_uri
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/purecloud/models/call_conversation.rb', line 38

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'participants' => :'participants',
    
    :'other_media_uris' => :'otherMediaUris',
    
    :'recording_state' => :'recordingState',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
# File 'lib/purecloud/models/call_conversation.rb', line 57

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'participants' => :'Array<CallMediaParticipant>',
    :'other_media_uris' => :'Array<String>',
    :'recording_state' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



116
117
118
119
120
121
122
123
124
125
# File 'lib/purecloud/models/call_conversation.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      participants == o.participants &&
      other_media_uris == o.other_media_uris &&
      recording_state == o.recording_state &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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
188
189
190
191
192
193
# File 'lib/purecloud/models/call_conversation.rb', line 157

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



217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/purecloud/models/call_conversation.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

build the object from hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/purecloud/models/call_conversation.rb', line 138

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

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
# File 'lib/purecloud/models/call_conversation.rb', line 128

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



133
134
135
# File 'lib/purecloud/models/call_conversation.rb', line 133

def hash
  [id, name, participants, other_media_uris, recording_state, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



200
201
202
# File 'lib/purecloud/models/call_conversation.rb', line 200

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



205
206
207
208
209
210
211
212
213
# File 'lib/purecloud/models/call_conversation.rb', line 205

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_sObject



195
196
197
# File 'lib/purecloud/models/call_conversation.rb', line 195

def to_s
  to_hash.to_s
end