Class: PhoneComClient::CallLogFull

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/models/call_log_full.rb

Overview

The Full Call Log Object includes the properties in the Call Log Summary Object, along with the following:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallLogFull

Initializes the object

Parameters:

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

    Model attributes in the form of hash



132
133
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
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 132

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#call_duration ⇒ Object

Call duration in seconds



46
47
48
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 46

def call_duration
  @call_duration
end

#call_number ⇒ Object

Internal system call reference number



52
53
54
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 52

def call_number
  @call_number
end

#call_recording_cp_url ⇒ Object

URL of call recording if available. User may listen to the audio online via this URL. Empty string if call recording does not exist



70
71
72
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 70

def call_recording_cp_url
  @call_recording_cp_url
end

#call_recording_url ⇒ Object

URL of call recording if available. User may download the audio via this URL. Empty string if call recording does not exist



67
68
69
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 67

def call_recording_url
  @call_recording_url
end

#called_number ⇒ Object

Call made to this phone number



31
32
33
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 31

def called_number
  @called_number
end

#caller_cnam ⇒ Object

Internal system caller id / name



76
77
78
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 76

def caller_cnam
  @caller_cnam
end

#caller_id ⇒ Object

Call made from this phone number



28
29
30
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 28

def caller_id
  @caller_id
end

#created_at ⇒ Object

Call log creation time. Same as call end time + time needed to create call log



37
38
39
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 37

def created_at
  @created_at
end

#details ⇒ Object

A list of call flows from beginning of call to end of call.



73
74
75
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 73

def details
  @details
end

#direction ⇒ Object

Call direction: in or out



40
41
42
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 40

def direction
  @direction
end

#extension ⇒ Object

Account extension



25
26
27
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 25

def extension
  @extension
end

#final_action ⇒ Object

Last action of call flow



55
56
57
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 55

def final_action
  @final_action
end

#id ⇒ Object

ID



19
20
21
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 19

def id
  @id
end

#is_monitored ⇒ Object

Was call being monitored?



49
50
51
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 49

def is_monitored
  @is_monitored
end

#start_time ⇒ Object

Call start time



34
35
36
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 34

def start_time
  @start_time
end

#type ⇒ Object

Call type: call, fax, audiogram …



43
44
45
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 43

def type
  @type
end

#uuid ⇒ Object

Internal system id, may be null



22
23
24
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 22

def uuid
  @uuid
end

#voicemail_cp_url ⇒ Object

URL of voicemail if available. User may listen to the audio online via this URL. Empty string if voicemail does not exist



61
62
63
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 61

def voicemail_cp_url
  @voicemail_cp_url
end

#voicemail_transcript ⇒ Object

Transcript of voicemail if enabled and available



64
65
66
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 64

def voicemail_transcript
  @voicemail_transcript
end

#voicemail_url ⇒ Object

URL of voicemail if available. User may download the audio via this URL. Empty string if voicemail does not exist



58
59
60
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 58

def voicemail_url
  @voicemail_url
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 79

def self.attribute_map
  {
    :'id' => :'id',
    :'uuid' => :'uuid',
    :'extension' => :'extension',
    :'caller_id' => :'caller_id',
    :'called_number' => :'called_number',
    :'start_time' => :'start_time',
    :'created_at' => :'created_at',
    :'direction' => :'direction',
    :'type' => :'type',
    :'call_duration' => :'call_duration',
    :'is_monitored' => :'is_monitored',
    :'call_number' => :'call_number',
    :'final_action' => :'final_action',
    :'voicemail_url' => :'voicemail_url',
    :'voicemail_cp_url' => :'voicemail_cp_url',
    :'voicemail_transcript' => :'voicemail_transcript',
    :'call_recording_url' => :'call_recording_url',
    :'call_recording_cp_url' => :'call_recording_cp_url',
    :'details' => :'details',
    :'caller_cnam' => :'caller_cnam'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'uuid' => :'String',
    :'extension' => :'ExtensionSummary',
    :'caller_id' => :'String',
    :'called_number' => :'String',
    :'start_time' => :'String',
    :'created_at' => :'String',
    :'direction' => :'String',
    :'type' => :'String',
    :'call_duration' => :'Integer',
    :'is_monitored' => :'String',
    :'call_number' => :'String',
    :'final_action' => :'String',
    :'voicemail_url' => :'String',
    :'voicemail_cp_url' => :'String',
    :'voicemail_transcript' => :'String',
    :'call_recording_url' => :'String',
    :'call_recording_cp_url' => :'String',
    :'details' => :'Array<CallDetails>',
    :'caller_cnam' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      uuid == o.uuid &&
      extension == o.extension &&
      caller_id == o.caller_id &&
      called_number == o.called_number &&
      start_time == o.start_time &&
      created_at == o.created_at &&
      direction == o.direction &&
      type == o.type &&
      call_duration == o.call_duration &&
      is_monitored == o.is_monitored &&
      call_number == o.call_number &&
      final_action == o.final_action &&
      voicemail_url == o.voicemail_url &&
      voicemail_cp_url == o.voicemail_cp_url &&
      voicemail_transcript == o.voicemail_transcript &&
      call_recording_url == o.call_recording_url &&
      call_recording_cp_url == o.call_recording_cp_url &&
      details == o.details &&
      caller_cnam == o.caller_cnam
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 297

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = PhoneComClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 363

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 276

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


263
264
265
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 269

def hash
  [id, uuid, extension, caller_id, called_number, start_time, created_at, direction, type, call_duration, is_monitored, call_number, final_action, voicemail_url, voicemail_cp_url, voicemail_transcript, call_recording_url, call_recording_cp_url, details, caller_cnam].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



223
224
225
226
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 223

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 343

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 349

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



337
338
339
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 337

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



230
231
232
 
# File 'lib/phone_com_client/models/call_log_full.rb', line 230

def valid?
  true
end