Class: Bandwidth::TransferCompleteCallback

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/transfer_complete_callback.rb

Overview

This event is sent to the transferCompleteUrl of the A-leg’s <Transfer> verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs.

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 = {}) ⇒ TransferCompleteCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/bandwidth-sdk/models/transfer_complete_callback.rb', line 165

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::TransferCompleteCallback` 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 `Bandwidth::TransferCompleteCallback`. 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?(:'event_type')
    self.event_type = attributes[:'event_type']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The user account associated with the call.



26
27
28
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 26

def 
  @account_id
end

#answer_time ⇒ Object

Time the call was answered, in ISO 8601 format.



52
53
54
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 52

def answer_time
  @answer_time
end

#application_id ⇒ Object

The id of the application associated with the call.



29
30
31
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 29

def application_id
  @application_id
end

#call_id ⇒ Object

The call id associated with the event.



40
41
42
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 40

def call_id
  @call_id
end

#call_url ⇒ Object

The URL of the call associated with the event.



43
44
45
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 43

def call_url
  @call_url
end

#cause ⇒ Object

Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.



64
65
66
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 64

def cause
  @cause
end

#direction ⇒ Object

Returns the value of attribute direction.



37
38
39
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 37

def direction
  @direction
end

#enqueued_time ⇒ Object

(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.



46
47
48
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 46

def enqueued_time
  @enqueued_time
end

#error_id ⇒ Object

Bandwidth’s internal id that references the error event.



70
71
72
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 70

def error_id
  @error_id
end

#error_message ⇒ Object

Text explaining the reason that caused the call to fail in case of errors.



67
68
69
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 67

def error_message
  @error_message
end

#event_time ⇒ Object

The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.



23
24
25
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 23

def event_time
  @event_time
end

#event_type ⇒ Object

The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.



20
21
22
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 20

def event_type
  @event_type
end

#from ⇒ Object

The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).



32
33
34
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 32

def from
  @from
end

#start_time ⇒ Object

Time the call was started, in ISO 8601 format.



49
50
51
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 49

def start_time
  @start_time
end

#tag ⇒ Object

(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.



55
56
57
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 55

def tag
  @tag
end

#to ⇒ Object

The phone number that received the call, in E.164 format (e.g. +15555555555).



35
36
37
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 35

def to
  @to
end

#transfer_caller_id ⇒ Object

The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).



58
59
60
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 58

def transfer_caller_id
  @transfer_caller_id
end

#transfer_to ⇒ Object

The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).



61
62
63
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 61

def transfer_to
  @transfer_to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



119
120
121
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 119

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



124
125
126
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 124

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 95

def self.attribute_map
  {
    :'event_type' => :'eventType',
    :'event_time' => :'eventTime',
    :'account_id' => :'accountId',
    :'application_id' => :'applicationId',
    :'from' => :'from',
    :'to' => :'to',
    :'direction' => :'direction',
    :'call_id' => :'callId',
    :'call_url' => :'callUrl',
    :'enqueued_time' => :'enqueuedTime',
    :'start_time' => :'startTime',
    :'answer_time' => :'answerTime',
    :'tag' => :'tag',
    :'transfer_caller_id' => :'transferCallerId',
    :'transfer_to' => :'transferTo',
    :'cause' => :'cause',
    :'error_message' => :'errorMessage',
    :'error_id' => :'errorId'
  }
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 307

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



153
154
155
156
157
158
159
160
161
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 153

def self.openapi_nullable
  Set.new([
    :'enqueued_time',
    :'answer_time',
    :'tag',
    :'error_message',
    :'error_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'event_type' => :'String',
    :'event_time' => :'Time',
    :'account_id' => :'String',
    :'application_id' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'direction' => :'CallDirectionEnum',
    :'call_id' => :'String',
    :'call_url' => :'String',
    :'enqueued_time' => :'Time',
    :'start_time' => :'Time',
    :'answer_time' => :'Time',
    :'tag' => :'String',
    :'transfer_caller_id' => :'String',
    :'transfer_to' => :'String',
    :'cause' => :'String',
    :'error_message' => :'String',
    :'error_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_type == o.event_type &&
      event_time == o.event_time &&
       == o. &&
      application_id == o.application_id &&
      from == o.from &&
      to == o.to &&
      direction == o.direction &&
      call_id == o.call_id &&
      call_url == o.call_url &&
      enqueued_time == o.enqueued_time &&
      start_time == o.start_time &&
      answer_time == o.answer_time &&
      tag == o.tag &&
      transfer_caller_id == o.transfer_caller_id &&
      transfer_to == o.transfer_to &&
      cause == o.cause &&
      error_message == o.error_message &&
      error_id == o.error_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 300

def hash
  [event_type, event_time, , application_id, from, to, direction, call_id, call_url, enqueued_time, start_time, answer_time, tag, transfer_caller_id, transfer_to, cause, error_message, error_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



254
255
256
257
258
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 254

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 329

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



262
263
264
265
 
# File 'lib/bandwidth-sdk/models/transfer_complete_callback.rb', line 262

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end