Class: Bandwidth::InitiateCallback

Inherits:
ApiModelBase show all
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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ InitiateCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 143

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
  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::InitiateCallback`. 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?(:'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

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

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

  if attributes.key?(:'sip_headers')
    if (value = attributes[:'sip_headers']).is_a?(Hash)
      self.sip_headers = value
    end
  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
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

#sip_call_id ⇒ Object

(optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists.



56
57
58
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 56

def sip_call_id
  @sip_call_id
end

#sip_headers ⇒ Object

(optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth's usual camelCase JSON convention, since these are passthrough values from the caller's SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept.



59
60
61
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 59

def sip_headers
  @sip_headers
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

#uui ⇒ Object

The value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64, jwt and hex encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.



53
54
55
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 53

def uui
  @uui
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



105
106
107
 
# File 'lib/bandwidth-sdk/models/initiate_callback.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/bandwidth-sdk/models/initiate_callback.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.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 84

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',
    :'uui' => :'uui',
    :'sip_call_id' => :'sipCallId',
    :'sip_headers' => :'sipHeaders'
  }
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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 291

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



136
137
138
139
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 136

def self.openapi_nullable
  Set.new([
  ])
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
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 115

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',
    :'uui' => :'String',
    :'sip_call_id' => :'String',
    :'sip_headers' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 256

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 &&
      start_time == o.start_time &&
      diversion == o.diversion &&
      stir_shaken == o.stir_shaken &&
      uui == o.uui &&
      sip_call_id == o.sip_call_id &&
      sip_headers == o.sip_headers
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


278
279
280
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 284

def hash
  [event_type, event_time, , application_id, from, to, direction, call_id, call_url, start_time, diversion, stir_shaken, uui, sip_call_id, sip_headers].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



222
223
224
225
226
227
228
229
230
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 222

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@uui.nil? && @uui.to_s.length > 256
    invalid_properties.push('invalid value for "uui", the character length must be smaller than or equal to 256.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/bandwidth-sdk/models/initiate_callback.rb', line 313

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@uui.nil? && @uui.to_s.length > 256
  true
end