Class: PureCloud::Call

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Call

Initializes the object

Parameters:

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

    Model attributes in the form of hash



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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
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
220
221
222
223
224
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 134

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'errorInfo')
    self.error_info = attributes[:'errorInfo']
  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?(:'documentId')
    self.document_id = attributes[:'documentId']
  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?(:'disconnectReasons')
    if (value = attributes[:'disconnectReasons']).is_a?(Array)
      self.disconnect_reasons = value
    end
  end

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

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

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

end

Instance Attribute Details

#confined ⇒ Object

True if this call is held and the person on this side hears hold music.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 40

def confined
  @confined
end

#connected_time ⇒ Object

The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 63

def connected_time
  @connected_time
end

#direction ⇒ Object

The direction of the call



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 28

def direction
  @direction
end

#disconnect_reasons ⇒ Object

List of reasons that this call was disconnected. This will be set once the call disconnects.



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 69

def disconnect_reasons
  @disconnect_reasons
end

#disconnect_type ⇒ Object

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 54

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 66

def disconnected_time
  @disconnected_time
end

#document_id ⇒ Object

If call is an outbound fax of a document from content management, then this is the id in content management.



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 60

def document_id
  @document_id
end

#error_info ⇒ Object

Returns the value of attribute error_info.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 51

def error_info
  @error_info
end

#fax_status ⇒ Object

Extra information on fax transmission.



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 72

def fax_status
  @fax_status
end

#held ⇒ Object

True if this call is held and the person on this side hears silence.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 43

def held
  @held
end

#id ⇒ Object

A globally unique identifier for this communication.



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

def id
  @id
end

#muted ⇒ Object

True if this call is muted so that remote participants can’t hear any audio from this end.



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

def muted
  @muted
end

#provider ⇒ Object

The source provider for the call.



75
76
77
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 75

def provider
  @provider
end

#recording ⇒ Object

True if this call is being recorded.



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

def recording
  @recording
end

#recording_id ⇒ Object

A globally unique identifier for the recording associated with this call.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 46

def recording_id
  @recording_id
end

#recording_state ⇒ Object

State of recording on this call.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 34

def recording_state
  @recording_state
end

#script_id ⇒ Object

The UUID of the script to use.



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 78

def script_id
  @script_id
end

#segments ⇒ Object

The time line of the participant’s call, divided into activity segments.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 49

def segments
  @segments
end

#start_hold_time ⇒ Object

The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 57

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

The connection state of this communication.



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'state' => :'state',
    :'id' => :'id',
    :'direction' => :'direction',
    :'recording' => :'recording',
    :'recording_state' => :'recordingState',
    :'muted' => :'muted',
    :'confined' => :'confined',
    :'held' => :'held',
    :'recording_id' => :'recordingId',
    :'segments' => :'segments',
    :'error_info' => :'errorInfo',
    :'disconnect_type' => :'disconnectType',
    :'start_hold_time' => :'startHoldTime',
    :'document_id' => :'documentId',
    :'connected_time' => :'connectedTime',
    :'disconnected_time' => :'disconnectedTime',
    :'disconnect_reasons' => :'disconnectReasons',
    :'fax_status' => :'faxStatus',
    :'provider' => :'provider',
    :'script_id' => :'scriptId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 107

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'direction' => :'String',
    :'recording' => :'BOOLEAN',
    :'recording_state' => :'String',
    :'muted' => :'BOOLEAN',
    :'confined' => :'BOOLEAN',
    :'held' => :'BOOLEAN',
    :'recording_id' => :'String',
    :'segments' => :'Array<Segment>',
    :'error_info' => :'ErrorBody',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'document_id' => :'String',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'disconnect_reasons' => :'Array<DisconnectReason>',
    :'fax_status' => :'FaxStatus',
    :'provider' => :'String',
    :'script_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      direction == o.direction &&
      recording == o.recording &&
      recording_state == o.recording_state &&
      muted == o.muted &&
      confined == o.confined &&
      held == o.held &&
      recording_id == o.recording_id &&
      segments == o.segments &&
      error_info == o.error_info &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      document_id == o.document_id &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      disconnect_reasons == o.disconnect_reasons &&
      fax_status == o.fax_status &&
      provider == o.provider &&
      script_id == o.script_id
end

#_deserialize(type, value) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 353

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 413

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 334

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


323
324
325
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



329
330
331
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 329

def hash
  [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider, script_id].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



228
229
230
231
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 228

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



396
397
398
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 396

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



401
402
403
404
405
406
407
408
409
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 401

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 



391
392
393
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 391

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/purecloudplatformclientv2/models/call.rb', line 235

def valid?
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  allowed_values = ["none", "active", "paused"]
  if @recording_state && !allowed_values.include?(@recording_state)
    return false
  end
  allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
end