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



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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/freeclimb/models/call_result.rb', line 183

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?(:call_status)
    self.call_status = attributes[:call_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

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

Instance Attribute Details

#account_id ⇒ Object

ID of the account that owns this Call.



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

def 
  @account_id
end

#answered_by ⇒ Object

Returns the value of attribute answered_by.



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

def answered_by
  @answered_by
end

#application_id ⇒ Object

ApplicationId associated with the Call.



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

def application_id
  @application_id
end

#call_id ⇒ Object

String that uniquely identifies this Call resource.



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

def call_id
  @call_id
end

#call_status ⇒ Object

Returns the value of attribute call_status.



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

def call_status
  @call_status
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.



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

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.



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

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



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

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



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

def date_updated
  @date_updated
end

#direction ⇒ Object

Returns the value of attribute direction.



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

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.



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

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.



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

def end_time
  @end_time
end

#from ⇒ Object

Phone number that initiated this Call.



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

def from
  @from
end

#parent_call_id ⇒ Object

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



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

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



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

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.



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

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.



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

def start_time
  @start_time
end

#subresource_uris ⇒ Object

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



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

def subresource_uris
  @subresource_uris
end

#to ⇒ Object

Phone number that received this Call.



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

def to
  @to
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



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

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/freeclimb/models/call_result.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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,
    call_status: :callStatus,
    start_time: :startTime,
    connect_time: :connectTime,
    end_time: :endTime,
    duration: :duration,
    connect_duration: :connectDuration,
    direction: :direction,
    answered_by: :answeredBy,
    subresource_uris: :subresourceUris,
    application_id: :applicationId
  }
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



335
336
337
 
# File 'lib/freeclimb/models/call_result.rb', line 335

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



175
176
177
178
179
 
# File 'lib/freeclimb/models/call_result.rb', line 175

def self.openapi_all_of
  [
    :MutableResourceModel
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/freeclimb/models/call_result.rb', line 153

def self.openapi_nullable
  Set.new([
    :call_id,
    :parent_call_id,
    :account_id,
    :from,
    :to,
    :phone_number_id,
    :call_status,
    :start_time,
    :connect_time,
    :end_time,
    :duration,
    :connect_duration,
    :direction,
    :answered_by,
    :subresource_uris,
    :application_id
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/freeclimb/models/call_result.rb', line 127

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,
    call_status: :CallStatus,
    start_time: :String,
    connect_time: :String,
    end_time: :String,
    duration: :Integer,
    connect_duration: :Integer,
    direction: :CallDirection,
    answered_by: :AnsweredBy,
    subresource_uris: :Object,
    application_id: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



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
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/freeclimb/models/call_result.rb', line 365

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/freeclimb/models/call_result.rb', line 436

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/freeclimb/models/call_result.rb', line 342

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{key}=", nil)
    elsif 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)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/freeclimb/models/call_result.rb', line 322

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/freeclimb/models/call_result.rb', line 328

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



279
280
281
 
# File 'lib/freeclimb/models/call_result.rb', line 279

def list_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



412
413
414
 
# File 'lib/freeclimb/models/call_result.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/freeclimb/models/call_result.rb', line 418

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



406
407
408
 
# File 'lib/freeclimb/models/call_result.rb', line 406

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



285
286
287
288
289
290
291
 
# File 'lib/freeclimb/models/call_result.rb', line 285

def valid?
  if @uri.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end