Class: Bandwidth::BridgeTargetCompleteCallback

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb

Overview

If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BridgeTargetCompleteCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 133

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

Instance Attribute Details

#account_idObject

The user account associated with the call.



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

def 
  @account_id
end

#answer_timeObject

Time the call was answered, in ISO 8601 format.



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

def answer_time
  @answer_time
end

#application_idObject

The id of the application associated with the call.



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

def application_id
  @application_id
end

#call_idObject

The call id associated with the event.



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

def call_id
  @call_id
end

#call_urlObject

The URL of the call associated with the event.



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

def call_url
  @call_url
end

#directionObject

Returns the value of attribute direction.



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

def direction
  @direction
end

#enqueued_timeObject

(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/bridge_target_complete_callback.rb', line 46

def enqueued_time
  @enqueued_time
end

#event_timeObject

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/bridge_target_complete_callback.rb', line 23

def event_time
  @event_time
end

#event_typeObject

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/bridge_target_complete_callback.rb', line 20

def event_type
  @event_type
end

#fromObject

The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.



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

def from
  @from
end

#start_timeObject

Time the call was started, in ISO 8601 format.



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

def start_time
  @start_time
end

#tagObject

(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/bridge_target_complete_callback.rb', line 55

def tag
  @tag
end

#toObject

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



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

def to
  @to
end

Class Method Details

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 273

def self._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 = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



99
100
101
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 80

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'
  }
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 249

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_nullableObject

List of attributes with nullable: true



123
124
125
126
127
128
129
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 123

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

.openapi_typesObject

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 104

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 216

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



344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 344

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


236
237
238
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 236

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



242
243
244
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 242

def hash
  [event_type, event_time, , application_id, from, to, direction, call_id, call_url, enqueued_time, start_time, answer_time, tag].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



201
202
203
204
205
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 201

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

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



320
321
322
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 320

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 326

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



314
315
316
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 314

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



209
210
211
212
# File 'lib/bandwidth-sdk/models/bridge_target_complete_callback.rb', line 209

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