Class: Bandwidth::MultiChannelMessageResponseData

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

Overview

The data returned in a multichannel message response.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 109

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

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

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

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

Instance Attribute Details

#channel_list ⇒ Object

A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored.



31
32
33
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 31

def channel_list
  @channel_list
end

#direction ⇒ Object

Returns the value of attribute direction.



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

def direction
  @direction
end

#expiration ⇒ Object

A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.



39
40
41
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 39

def expiration
  @expiration
end

#id ⇒ Object

The ID of the message.



20
21
22
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 20

def id
  @id
end

#priority ⇒ Object

Returns the value of attribute priority.



36
37
38
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 36

def priority
  @priority
end

#tag ⇒ Object

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



34
35
36
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 34

def tag
  @tag
end

#time ⇒ Object

The time the message was received by the Bandwidth API.



23
24
25
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 23

def time
  @time
end

#to ⇒ Object

The destination phone number(s) of the message, in E164 format.



28
29
30
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 28

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'time' => :'time',
    :'direction' => :'direction',
    :'to' => :'to',
    :'channel_list' => :'channelList',
    :'tag' => :'tag',
    :'priority' => :'priority',
    :'expiration' => :'expiration'
  }
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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 299

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'time' => :'Time',
    :'direction' => :'MessageDirectionEnum',
    :'to' => :'Array<String>',
    :'channel_list' => :'Array<MultiChannelChannelListResponseObject>',
    :'tag' => :'String',
    :'priority' => :'PriorityEnum',
    :'expiration' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      time == o.time &&
      direction == o.direction &&
      to == o.to &&
      channel_list == o.channel_list &&
      tag == o.tag &&
      priority == o.priority &&
      expiration == o.expiration
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



292
293
294
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 292

def hash
  [id, time, direction, to, channel_list, tag, priority, expiration].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



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

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 @time.nil?
    invalid_properties.push('invalid value for "time", time 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 @channel_list.nil?
    invalid_properties.push('invalid value for "channel_list", channel_list cannot be nil.')
  end

  if @channel_list.length > 4
    invalid_properties.push('invalid value for "channel_list", number of items must be less than or equal to 4.')
  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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 321

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/bandwidth-sdk/models/multi_channel_message_response_data.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @time.nil?
  return false if @direction.nil?
  return false if @to.nil?
  return false if @channel_list.nil?
  return false if @channel_list.length > 4
  true
end