Class: Bandwidth::InboundCallbackMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboundCallbackMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 144

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

  if attributes.key?(:'owner')
    self.owner = attributes[:'owner']
  else
    self.owner = nil
  end

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

  if attributes.key?(:'time')
    self.time = attributes[:'time']
  else
    self.time = nil
  end

  if attributes.key?(:'segment_count')
    self.segment_count = attributes[:'segment_count']
  else
    self.segment_count = nil
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.



25
26
27
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 25

def application_id
  @application_id
end

#channel ⇒ Object

Returns the value of attribute channel.



50
51
52
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 50

def channel
  @channel
end

#content ⇒ Object

Returns the value of attribute content.



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

def content
  @content
end

#direction ⇒ Object

Returns the value of attribute direction.



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

def direction
  @direction
end

#from ⇒ Object

The Bandwidth phone number or alphanumeric identifier the message was sent from.



38
39
40
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 38

def from
  @from
end

#id ⇒ Object

A unique identifier of the message.



19
20
21
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 19

def id
  @id
end

#location_response ⇒ Object

Returns the value of attribute location_response.



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

def location_response
  @location_response
end

#media ⇒ Object

Optional media, not applicable for sms



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

def media
  @media
end

#owner ⇒ Object

The Bandwidth phone number or alphanumeric identifier associated with the message.



22
23
24
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 22

def owner
  @owner
end

#priority ⇒ Object

Returns the value of attribute priority.



48
49
50
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 48

def priority
  @priority
end

#segment_count ⇒ Object

The number of segments the user’s message is broken into before sending over carrier networks.



30
31
32
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 30

def segment_count
  @segment_count
end

#suggestion_response ⇒ Object

Returns the value of attribute suggestion_response.



54
55
56
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 54

def suggestion_response
  @suggestion_response
end

#tag ⇒ Object

A custom string that will be included in callback events of the message. Max 1024 characters.



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

def tag
  @tag
end

#text ⇒ Object

Returns the value of attribute text.



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

def text
  @text
end

#time ⇒ Object

Returns the value of attribute time.



27
28
29
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 27

def time
  @time
end

#to ⇒ Object

The phone number recipients of the message.



35
36
37
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 369

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



103
104
105
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 103

def self.acceptable_attributes
  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
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 81

def self.attribute_map
  {
    :'id' => :'id',
    :'owner' => :'owner',
    :'application_id' => :'applicationId',
    :'time' => :'time',
    :'segment_count' => :'segmentCount',
    :'direction' => :'direction',
    :'to' => :'to',
    :'from' => :'from',
    :'text' => :'text',
    :'tag' => :'tag',
    :'media' => :'media',
    :'priority' => :'priority',
    :'channel' => :'channel',
    :'content' => :'content',
    :'suggestion_response' => :'suggestionResponse',
    :'location_response' => :'locationResponse'
  }
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 345

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'StatusCallbackMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 130

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 108

def self.openapi_types
  {
    :'id' => :'String',
    :'owner' => :'String',
    :'application_id' => :'String',
    :'time' => :'Time',
    :'segment_count' => :'Integer',
    :'direction' => :'MessageDirectionEnum',
    :'to' => :'Array<String>',
    :'from' => :'String',
    :'text' => :'String',
    :'tag' => :'String',
    :'media' => :'Array<String>',
    :'priority' => :'PriorityEnum',
    :'channel' => :'MultiChannelMessageChannelEnum',
    :'content' => :'MultiChannelMessageContent',
    :'suggestion_response' => :'RbmSuggestionResponse',
    :'location_response' => :'RbmLocationResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      owner == o.owner &&
      application_id == o.application_id &&
      time == o.time &&
      segment_count == o.segment_count &&
      direction == o.direction &&
      to == o.to &&
      from == o.from &&
      text == o.text &&
      tag == o.tag &&
      media == o.media &&
      priority == o.priority &&
      channel == o.channel &&
      content == o.content &&
      suggestion_response == o.suggestion_response &&
      location_response == o.location_response
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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 440

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


332
333
334
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 338

def hash
  [id, owner, application_id, time, segment_count, direction, to, from, text, tag, media, priority, channel, content, suggestion_response, location_response].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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 244

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @owner.nil?
    invalid_properties.push('invalid value for "owner", owner cannot be nil.')
  end

  if @application_id.nil?
    invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
  end

  if @time.nil?
    invalid_properties.push('invalid value for "time", time cannot be nil.')
  end

  if @segment_count.nil?
    invalid_properties.push('invalid value for "segment_count", segment_count cannot be nil.')
  end

  if @direction.nil?
    invalid_properties.push('invalid value for "direction", direction cannot be nil.')
  end

  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  if @from.nil?
    invalid_properties.push('invalid value for "from", from cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



416
417
418
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 416

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 422

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

Returns:

  • (String) —

    String presentation of the object



410
411
412
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 410

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



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 284

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @owner.nil?
  return false if @application_id.nil?
  return false if @time.nil?
  return false if @segment_count.nil?
  return false if @direction.nil?
  return false if @to.nil?
  return false if @from.nil?
  true
end