Class: Bandwidth::InboundCallbackMessage

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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ InboundCallbackMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
241
242
243
244
245
246
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 149

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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



108
109
110
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 108

def self.acceptable_attributes
  acceptable_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



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

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)



141
142
143
144
145
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 141

def self.openapi_all_of
  [
  :'StatusCallbackMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 113

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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 385

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


408
409
410
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 408

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



414
415
416
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 414

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



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
281
282
283
284
285
286
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 250

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/bandwidth-sdk/models/inbound_callback_message.rb', line 290

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