Class: Freeclimb::CallResult

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/call_result.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/freeclimb/models/call_result.rb', line 162

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::CallResult` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::CallResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'uri')
    self.uri = attributes[:'uri']
  end

  if attributes.key?(:'date_created')
    self.date_created = attributes[:'date_created']
  end

  if attributes.key?(:'date_updated')
    self.date_updated = attributes[:'date_updated']
  end

  if attributes.key?(:'revision')
    self.revision = attributes[:'revision']
  end

  if attributes.key?(:'call_id')
    self.call_id = attributes[:'call_id']
  end

  if attributes.key?(:'parent_call_id')
    self.parent_call_id = attributes[:'parent_call_id']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  end

  if attributes.key?(:'phone_number_id')
    self.phone_number_id = attributes[:'phone_number_id']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

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

  if attributes.key?(:'connect_time')
    self.connect_time = attributes[:'connect_time']
  end

  if attributes.key?(:'end_time')
    self.end_time = attributes[:'end_time']
  end

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.key?(:'connect_duration')
    self.connect_duration = attributes[:'connect_duration']
  end

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

  if attributes.key?(:'answered_by')
    self.answered_by = attributes[:'answered_by']
  end

  if attributes.key?(:'subresource_uris')
    self.subresource_uris = attributes[:'subresource_uris']
  end
end

Instance Attribute Details

#account_id ⇒ Object

ID of the account that owns this Call.



36
37
38
 
# File 'lib/freeclimb/models/call_result.rb', line 36

def 
  @account_id
end

#answered_by ⇒ Object

If this Call was initiated with answering machine detection, either ‘human` or `machine`. Empty otherwise.



69
70
71
 
# File 'lib/freeclimb/models/call_result.rb', line 69

def answered_by
  @answered_by
end

#call_id ⇒ Object

String that uniquely identifies this Call resource.



30
31
32
 
# File 'lib/freeclimb/models/call_result.rb', line 30

def call_id
  @call_id
end

#connect_duration ⇒ Object

Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.



63
64
65
 
# File 'lib/freeclimb/models/call_result.rb', line 63

def connect_duration
  @connect_duration
end

#connect_time ⇒ Object

Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.



54
55
56
 
# File 'lib/freeclimb/models/call_result.rb', line 54

def connect_time
  @connect_time
end

#date_created ⇒ Object

The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



21
22
23
 
# File 'lib/freeclimb/models/call_result.rb', line 21

def date_created
  @date_created
end

#date_updated ⇒ Object

The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



24
25
26
 
# File 'lib/freeclimb/models/call_result.rb', line 24

def date_updated
  @date_updated
end

#direction ⇒ Object

Direction of the Call. ‘inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command.



66
67
68
 
# File 'lib/freeclimb/models/call_result.rb', line 66

def direction
  @direction
end

#duration ⇒ Object

Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.



60
61
62
 
# File 'lib/freeclimb/models/call_result.rb', line 60

def duration
  @duration
end

#end_time ⇒ Object

End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully.



57
58
59
 
# File 'lib/freeclimb/models/call_result.rb', line 57

def end_time
  @end_time
end

#from ⇒ Object

Phone number that initiated this Call.



39
40
41
 
# File 'lib/freeclimb/models/call_result.rb', line 39

def from
  @from
end

#parent_call_id ⇒ Object

ID of the Call that created this leg (child Call).



33
34
35
 
# File 'lib/freeclimb/models/call_result.rb', line 33

def parent_call_id
  @parent_call_id
end

#phone_number_id ⇒ Object

If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).



45
46
47
 
# File 'lib/freeclimb/models/call_result.rb', line 45

def phone_number_id
  @phone_number_id
end

#revision ⇒ Object

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.



27
28
29
 
# File 'lib/freeclimb/models/call_result.rb', line 27

def revision
  @revision
end

#start_time ⇒ Object

Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.



51
52
53
 
# File 'lib/freeclimb/models/call_result.rb', line 51

def start_time
  @start_time
end

#status ⇒ Object

  • ‘queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered.



48
49
50
 
# File 'lib/freeclimb/models/call_result.rb', line 48

def status
  @status
end

#subresource_uris ⇒ Object

The list of subresources for this Call. These include things like logs and recordings associated with the Call.



72
73
74
 
# File 'lib/freeclimb/models/call_result.rb', line 72

def subresource_uris
  @subresource_uris
end

#to ⇒ Object

Phone number that received this Call.



42
43
44
 
# File 'lib/freeclimb/models/call_result.rb', line 42

def to
  @to
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



18
19
20
 
# File 'lib/freeclimb/models/call_result.rb', line 18

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/freeclimb/models/call_result.rb', line 97

def self.attribute_map
  {
    :'uri' => :'uri',
    :'date_created' => :'dateCreated',
    :'date_updated' => :'dateUpdated',
    :'revision' => :'revision',
    :'call_id' => :'callId',
    :'parent_call_id' => :'parentCallId',
    :'account_id' => :'accountId',
    :'from' => :'from',
    :'to' => :'to',
    :'phone_number_id' => :'phoneNumberId',
    :'status' => :'status',
    :'start_time' => :'startTime',
    :'connect_time' => :'connectTime',
    :'end_time' => :'endTime',
    :'duration' => :'duration',
    :'connect_duration' => :'connectDuration',
    :'direction' => :'direction',
    :'answered_by' => :'answeredBy',
    :'subresource_uris' => :'subresourceUris'
  }
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



318
319
320
 
# File 'lib/freeclimb/models/call_result.rb', line 318

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



153
154
155
156
157
158
 
# File 'lib/freeclimb/models/call_result.rb', line 153

def self.openapi_all_of
  [
  :'CallResultAllOf',
  :'MutableResourceModel'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
 
# File 'lib/freeclimb/models/call_result.rb', line 147

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/freeclimb/models/call_result.rb', line 122

def self.openapi_types
  {
    :'uri' => :'String',
    :'date_created' => :'String',
    :'date_updated' => :'String',
    :'revision' => :'Integer',
    :'call_id' => :'String',
    :'parent_call_id' => :'String',
    :'account_id' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'phone_number_id' => :'String',
    :'status' => :'String',
    :'start_time' => :'String',
    :'connect_time' => :'String',
    :'end_time' => :'String',
    :'duration' => :'Integer',
    :'connect_duration' => :'Integer',
    :'direction' => :'String',
    :'answered_by' => :'String',
    :'subresource_uris' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/freeclimb/models/call_result.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uri == o.uri &&
      date_created == o.date_created &&
      date_updated == o.date_updated &&
      revision == o.revision &&
      call_id == o.call_id &&
      parent_call_id == o.parent_call_id &&
       == o. &&
      from == o.from &&
      to == o.to &&
      phone_number_id == o.phone_number_id &&
      status == o.status &&
      start_time == o.start_time &&
      connect_time == o.connect_time &&
      end_time == o.end_time &&
      duration == o.duration &&
      connect_duration == o.connect_duration &&
      direction == o.direction &&
      answered_by == o.answered_by &&
      subresource_uris == o.subresource_uris
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



346
347
348
349
350
351
352
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
 
# File 'lib/freeclimb/models/call_result.rb', line 346

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
    Freeclimb.const_get(type).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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/freeclimb/models/call_result.rb', line 415

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/freeclimb/models/call_result.rb', line 325

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


305
306
307
 
# File 'lib/freeclimb/models/call_result.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/freeclimb/models/call_result.rb', line 311

def hash
  [uri, date_created, date_updated, revision, call_id, parent_call_id, , from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].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



254
255
256
257
 
# File 'lib/freeclimb/models/call_result.rb', line 254

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



391
392
393
 
# File 'lib/freeclimb/models/call_result.rb', line 391

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/freeclimb/models/call_result.rb', line 397

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



385
386
387
 
# File 'lib/freeclimb/models/call_result.rb', line 385

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



261
262
263
264
265
 
# File 'lib/freeclimb/models/call_result.rb', line 261

def valid?
  status_validator = EnumAttributeValidator.new('String', ["queued", "ringing", "inProgress", "canceled", "completed", "busy", "failed", "noAnswer"])
  return false unless status_validator.valid?(@status)
  true
end