Class: Bandwidth::MultiChannelMessageData

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MultiChannelMessageData

Initializes the object



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tag')
    self.tag = attributes[:'tag']
  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.



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

def application_id
  @application_id
end

#channel ⇒ Object

Returns the value of attribute channel.



37
38
39
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 37

def channel
  @channel
end

#direction ⇒ Object

Returns the value of attribute direction.



26
27
28
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 26

def direction
  @direction
end

#from ⇒ Object

The sender ID of the message. This could be an alphanumeric sender ID.



29
30
31
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 29

def from
  @from
end

#message_id ⇒ Object

The ID of the message.



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

def message_id
  @message_id
end

#status ⇒ Object

Returns the value of attribute status.



21
22
23
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 21

def status
  @status
end

#tag ⇒ Object

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



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

def tag
  @tag
end

#time ⇒ Object

The time the message was received by the Bandwidth API.



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

def time
  @time
end

#to ⇒ Object

The phone number the message should be sent to in E164 format.



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

def to
  @to
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 227

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



80
81
82
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 65

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'status' => :'status',
    :'time' => :'time',
    :'direction' => :'direction',
    :'from' => :'from',
    :'to' => :'to',
    :'application_id' => :'applicationId',
    :'channel' => :'channel',
    :'tag' => :'tag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 203

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'message_id' => :'String',
    :'status' => :'MultiChannelStatusEnum',
    :'time' => :'Time',
    :'direction' => :'MultiChannelMessageDirectionEnum',
    :'from' => :'String',
    :'to' => :'String',
    :'application_id' => :'String',
    :'channel' => :'MultiChannelMessageChannelEnum',
    :'tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      status == o.status &&
      time == o.time &&
      direction == o.direction &&
      from == o.from &&
      to == o.to &&
      application_id == o.application_id &&
      channel == o.channel &&
      tag == o.tag
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 298

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

See Also:

  • `==` method


190
191
192
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



196
197
198
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 196

def hash
  [message_id, status, time, direction, from, to, application_id, channel, tag].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



159
160
161
162
163
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 159

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)



274
275
276
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 274

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 280

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



268
269
270
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 268

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



167
168
169
170
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_data.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end