Class: Bandwidth::StatusCallback

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/status_callback.rb

Overview

Represents a status callback for an outbound MT SMS or MMS or RBM message.

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 = {}) ⇒ StatusCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 108

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_name ⇒ Object

The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled.



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

def carrier_name
  @carrier_name
end

#description ⇒ Object

A detailed description of the event described by the callback.



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

def description
  @description
end

#error_code ⇒ Object

Optional error code, applicable only when type is ‘message-failed`.



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

def error_code
  @error_code
end

#event_time ⇒ Object

Represents the time at which the message was read, for ‘message-read` callbacks.



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

def event_time
  @event_time
end

#message ⇒ Object

Returns the value of attribute message.



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

def message
  @message
end

#time ⇒ Object

Returns the value of attribute time.



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

def time
  @time
end

#to ⇒ Object

The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user’s client phone number.



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

def to
  @to
end

#type ⇒ Object

Returns the value of attribute type.



24
25
26
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 24

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 63

def self.attribute_map
  {
    :'time' => :'time',
    :'event_time' => :'eventTime',
    :'type' => :'type',
    :'to' => :'to',
    :'description' => :'description',
    :'message' => :'message',
    :'error_code' => :'errorCode',
    :'carrier_name' => :'carrierName'
  }
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 285

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



101
102
103
104
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 87

def self.openapi_types
  {
    :'time' => :'Time',
    :'event_time' => :'Time',
    :'type' => :'StatusCallbackTypeEnum',
    :'to' => :'String',
    :'description' => :'String',
    :'message' => :'StatusCallbackMessage',
    :'error_code' => :'Integer',
    :'carrier_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      time == o.time &&
      event_time == o.event_time &&
      type == o.type &&
      to == o.to &&
      description == o.description &&
      message == o.message &&
      error_code == o.error_code &&
      carrier_name == o.carrier_name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [time, event_time, type, to, description, message, error_code, carrier_name].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



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

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

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

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

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

  if @message.nil?
    invalid_properties.push('invalid value for "message", message 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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 307

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/bandwidth-sdk/models/status_callback.rb', line 195

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @time.nil?
  return false if @type.nil?
  return false if @to.nil?
  return false if @description.nil?
  return false if @message.nil?
  true
end