Class: PureCloud::CallConversation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallConversation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/purecloudplatformclientv2/models/call_conversation.rb', line 63

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

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

  if attributes.has_key?(:'participants')
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end

  if attributes.has_key?(:'otherMediaUris')
    if (value = attributes[:'otherMediaUris']).is_a?(Array)
      self.other_media_uris = value
    end
  end

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

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

end

Instance Attribute Details

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#other_media_uris ⇒ Object

The list of other media channels involved in the conversation.



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

def other_media_uris
  @other_media_uris
end

#participants ⇒ Object

The list of participants involved in the conversation.



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

def participants
  @participants
end

#recording_state ⇒ Object

Returns the value of attribute recording_state.



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

def recording_state
  @recording_state
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/purecloudplatformclientv2/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_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 50

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

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 127

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 



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
205
206
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 170

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 230

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 151

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


140
141
142
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 146

def hash
  [id, name, participants, other_media_uris, recording_state, self_uri].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



101
102
103
104
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 101

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))



213
214
215
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 213

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



218
219
220
221
222
223
224
225
226
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 218

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 



208
209
210
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.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
111
112
113
 
# File 'lib/purecloudplatformclientv2/models/call_conversation.rb', line 108

def valid?
  allowed_values = ["none", "active", "paused"]
  if @recording_state && !allowed_values.include?(@recording_state)
    return false
  end
end