Class: PureCloud::Conversation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Conversation

Returns a new instance of Conversation.



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
122
123
124
125
126
127
128
129
 
# File 'lib/purecloud/models/conversation.rb', line 78

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[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'participants']
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end
  
  if attributes[:'conversationIds']
    if (value = attributes[:'conversationIds']).is_a?(Array)
      self.conversation_ids = value
    end
  end
  
  if attributes[:'maxParticipants']
    self.max_participants = attributes[:'maxParticipants']
  end
  
  if attributes[:'recordingState']
    self.recording_state = attributes[:'recordingState']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#address ⇒ Object

The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.



17
18
19
 
# File 'lib/purecloud/models/conversation.rb', line 17

def address
  @address
end

#conversation_ids ⇒ Object

A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.



23
24
25
 
# File 'lib/purecloud/models/conversation.rb', line 23

def conversation_ids
  @conversation_ids
end

#end_time ⇒ Object

The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



14
15
16
 
# File 'lib/purecloud/models/conversation.rb', line 14

def end_time
  @end_time
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/conversation.rb', line 6

def id
  @id
end

#max_participants ⇒ Object

If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.



26
27
28
 
# File 'lib/purecloud/models/conversation.rb', line 26

def max_participants
  @max_participants
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/conversation.rb', line 8

def name
  @name
end

#participants ⇒ Object

The list of all participants in the conversation.



20
21
22
 
# File 'lib/purecloud/models/conversation.rb', line 20

def participants
  @participants
end

#recording_state ⇒ Object

On update, ‘paused’ initiates a secure pause, ‘active’ resumes any paused recordings; otherwise indicates state of conversation recording.



29
30
31
 
# File 'lib/purecloud/models/conversation.rb', line 29

def recording_state
  @recording_state
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#start_time ⇒ Object

The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



11
12
13
 
# File 'lib/purecloud/models/conversation.rb', line 11

def start_time
  @start_time
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloud/models/conversation.rb', line 35

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'address' => :'address',
    
    :'participants' => :'participants',
    
    :'conversation_ids' => :'conversationIds',
    
    :'max_participants' => :'maxParticipants',
    
    :'recording_state' => :'recordingState',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloud/models/conversation.rb', line 62

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'start_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'address' => :'String',
    :'participants' => :'Array<Participant>',
    :'conversation_ids' => :'Array<String>',
    :'max_participants' => :'Integer',
    :'recording_state' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      address == o.address &&
      participants == o.participants &&
      conversation_ids == o.conversation_ids &&
      max_participants == o.max_participants &&
      recording_state == o.recording_state &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/purecloud/models/conversation.rb', line 186

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/purecloud/models/conversation.rb', line 243

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/purecloud/models/conversation.rb', line 167

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


157
158
159
 
# File 'lib/purecloud/models/conversation.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



162
163
164
 
# File 'lib/purecloud/models/conversation.rb', line 162

def hash
  [id, name, start_time, end_time, address, participants, conversation_ids, max_participants, recording_state, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



226
227
228
 
# File 'lib/purecloud/models/conversation.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloud/models/conversation.rb', line 231

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 



221
222
223
 
# File 'lib/purecloud/models/conversation.rb', line 221

def to_s
  to_hash.to_s
end