Class: Bandwidth::InitiateCallback
- Inherits:
-
Object
- Object
- Bandwidth::InitiateCallback
- Defined in:
- lib/bandwidth-sdk/models/initiate_callback.rb
Overview
The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#account_id ⇒ Object
The user account associated with the call.
-
#application_id ⇒ Object
The id of the application associated with the call.
-
#call_id ⇒ Object
The call id associated with the event.
-
#call_url ⇒ Object
The URL of the call associated with the event.
-
#direction ⇒ Object
Returns the value of attribute direction.
-
#diversion ⇒ Object
Returns the value of attribute diversion.
-
#event_time ⇒ Object
The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format.
-
#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.
-
#from ⇒ Object
The provided identifier of the caller.
-
#start_time ⇒ Object
Time the call was started, in ISO 8601 format.
-
#stir_shaken ⇒ Object
Returns the value of attribute stir_shaken.
-
#to ⇒ Object
The phone number that received the call, in E.164 format (e.g. +15555555555).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ InitiateCallback
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ InitiateCallback
Initializes the object
123 124 125 126 127 128 129 130 131 132 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 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 123 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::InitiateCallback` 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::InitiateCallback`. 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.account_id = 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?(:'start_time') self.start_time = attributes[:'start_time'] end if attributes.key?(:'diversion') self.diversion = attributes[:'diversion'] end if attributes.key?(:'stir_shaken') self.stir_shaken = attributes[:'stir_shaken'] end end |
Instance Attribute Details
#account_id ⇒ Object
The user account associated with the call.
26 27 28 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 26 def account_id @account_id end |
#application_id ⇒ Object
The id of the application associated with the call.
29 30 31 |
# File 'lib/bandwidth-sdk/models/initiate_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/initiate_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/initiate_callback.rb', line 43 def call_url @call_url end |
#direction ⇒ Object
Returns the value of attribute direction.
37 38 39 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 37 def direction @direction end |
#diversion ⇒ Object
Returns the value of attribute diversion.
48 49 50 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 48 def diversion @diversion 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/initiate_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/initiate_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/initiate_callback.rb', line 32 def from @from end |
#start_time ⇒ Object
Time the call was started, in ISO 8601 format.
46 47 48 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 46 def start_time @start_time end |
#stir_shaken ⇒ Object
Returns the value of attribute stir_shaken.
50 51 52 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 50 def stir_shaken @stir_shaken 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/initiate_callback.rb', line 35 def to @to end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 258 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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
93 94 95 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 93 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 75 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', :'start_time' => :'startTime', :'diversion' => :'diversion', :'stir_shaken' => :'stirShaken' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 234 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
116 117 118 119 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 116 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 98 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', :'start_time' => :'Time', :'diversion' => :'Diversion', :'stir_shaken' => :'StirShaken' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 202 def ==(o) return true if self.equal?(o) self.class == o.class && event_type == o.event_type && event_time == o.event_time && account_id == o.account_id && application_id == o.application_id && from == o.from && to == o.to && direction == o.direction && call_id == o.call_id && call_url == o.call_url && start_time == o.start_time && diversion == o.diversion && stir_shaken == o.stir_shaken end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 329 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
221 222 223 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 221 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
227 228 229 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 227 def hash [event_type, event_time, account_id, application_id, from, to, direction, call_id, call_url, start_time, diversion, stir_shaken].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
187 188 189 190 191 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 187 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
305 306 307 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 305 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 311 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
299 300 301 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 299 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
195 196 197 198 |
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 195 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |