Class: Zernio::WebhookPayloadCallEndedCall

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/webhook_payload_call_ended_call.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ WebhookPayloadCallEndedCall

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



22
23
24
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 22

def 
  @account_id
end

#billing ⇒ Object

Returns the value of attribute billing.



56
57
58
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 56

def billing
  @billing
end

#call_errors ⇒ Object

Failures recorded on the call up to hangup (bridge failed, dial failed, recording error). Empty on a clean call. message is free-form diagnostic text and is not stable, do not parse it. code is 0 unless a provider code is known. Errors the carrier reports after hangup appear only on GET /v1/calls/#id.



50
51
52
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 50

def call_errors
  @call_errors
end

#direction ⇒ Object

Returns the value of attribute direction.



26
27
28
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 26

def direction
  @direction
end

#duration_seconds ⇒ Object

Returns the value of attribute duration_seconds.



36
37
38
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 36

def duration_seconds
  @duration_seconds
end

#end_reason ⇒ Object

Returns the value of attribute end_reason.



38
39
40
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 38

def end_reason
  @end_reason
end

#ended_at ⇒ Object

Returns the value of attribute ended_at.



34
35
36
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 34

def ended_at
  @ended_at
end

#from ⇒ Object

Returns the value of attribute from.



28
29
30
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 28

def from
  @from
end

#hangup_cause ⇒ Object

Raw carrier hangup cause behind endReason (e.g. normal_clearing, call_rejected, not_found). Null when the carrier reported none.



41
42
43
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 41

def hangup_cause
  @hangup_cause
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 18

def id
  @id
end

#is_voicemail ⇒ Object

True when the inbound call was handled by voicemail, whether scheduled or because the forward did not connect.



47
48
49
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 47

def is_voicemail
  @is_voicemail
end

#meta_call_id ⇒ Object

Returns the value of attribute meta_call_id.



20
21
22
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 20

def meta_call_id
  @meta_call_id
end

#phone_number_id ⇒ Object

Returns the value of attribute phone_number_id.



24
25
26
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 24

def phone_number_id
  @phone_number_id
end

#recording_expires_at ⇒ Object

Returns the value of attribute recording_expires_at.



54
55
56
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 54

def recording_expires_at
  @recording_expires_at
end

#recording_url ⇒ Object

Returns the value of attribute recording_url.



52
53
54
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 52

def recording_url
  @recording_url
end

#sip_hangup_cause ⇒ Object

SIP response code that ended the call when SIP-signalled (e.g. '403', '486', '603'). endReason collapses all three to 'rejected', so this is what separates a refused destination from a busy line. Null on non-SIP legs.



44
45
46
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 44

def sip_hangup_cause
  @sip_hangup_cause
end

#started_at ⇒ Object

Returns the value of attribute started_at.



32
33
34
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 32

def started_at
  @started_at
end

#to ⇒ Object

Returns the value of attribute to.



30
31
32
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 30

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



105
106
107
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 105

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 110

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.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
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 81

def self.attribute_map
  {
    :'id' => :'id',
    :'meta_call_id' => :'metaCallId',
    :'account_id' => :'accountId',
    :'phone_number_id' => :'phoneNumberId',
    :'direction' => :'direction',
    :'from' => :'from',
    :'to' => :'to',
    :'started_at' => :'startedAt',
    :'ended_at' => :'endedAt',
    :'duration_seconds' => :'durationSeconds',
    :'end_reason' => :'endReason',
    :'hangup_cause' => :'hangupCause',
    :'sip_hangup_cause' => :'sipHangupCause',
    :'is_voicemail' => :'isVoicemail',
    :'call_errors' => :'callErrors',
    :'recording_url' => :'recordingUrl',
    :'recording_expires_at' => :'recordingExpiresAt',
    :'billing' => :'billing'
  }
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 317

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
143
144
145
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 139

def self.openapi_nullable
  Set.new([
    :'meta_call_id',
    :'hangup_cause',
    :'sip_hangup_cause',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 115

def self.openapi_types
  {
    :'id' => :'String',
    :'meta_call_id' => :'String',
    :'account_id' => :'String',
    :'phone_number_id' => :'String',
    :'direction' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'started_at' => :'Time',
    :'ended_at' => :'Time',
    :'duration_seconds' => :'Integer',
    :'end_reason' => :'String',
    :'hangup_cause' => :'String',
    :'sip_hangup_cause' => :'String',
    :'is_voicemail' => :'Boolean',
    :'call_errors' => :'Array<CallRecordCallErrorsInner>',
    :'recording_url' => :'String',
    :'recording_expires_at' => :'Time',
    :'billing' => :'WebhookPayloadCallEndedCallBilling'
  }
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
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      meta_call_id == o.meta_call_id &&
       == o. &&
      phone_number_id == o.phone_number_id &&
      direction == o.direction &&
      from == o.from &&
      to == o.to &&
      started_at == o.started_at &&
      ended_at == o.ended_at &&
      duration_seconds == o.duration_seconds &&
      end_reason == o.end_reason &&
      hangup_cause == o.hangup_cause &&
      sip_hangup_cause == o.sip_hangup_cause &&
      is_voicemail == o.is_voicemail &&
      call_errors == o.call_errors &&
      recording_url == o.recording_url &&
      recording_expires_at == o.recording_expires_at &&
      billing == o.billing
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


304
305
306
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 304

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



310
311
312
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 310

def hash
  [id, meta_call_id, , phone_number_id, direction, from, to, started_at, ended_at, duration_seconds, end_reason, hangup_cause, sip_hangup_cause, is_voicemail, call_errors, recording_url, recording_expires_at, billing].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



240
241
242
243
244
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 240

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 339

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



248
249
250
251
252
253
254
255
 
# File 'lib/zernio-sdk/models/webhook_payload_call_ended_call.rb', line 248

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
  return false unless direction_validator.valid?(@direction)
  end_reason_validator = EnumAttributeValidator.new('String', ["hangup", "no_answer", "rejected", "error"])
  return false unless end_reason_validator.valid?(@end_reason)
  true
end