Class: Bandwidth::MultiChannelChannelListSMSResponseObject

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.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 = {}) ⇒ MultiChannelChannelListSMSResponseObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
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
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 101

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

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

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

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

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

Instance Attribute Details

#application_idObject

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



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

def application_id
  @application_id
end

#channelObject

Returns the value of attribute channel.



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

def channel
  @channel
end

#contentObject

Returns the value of attribute content.



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

def content
  @content
end

#fromObject

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



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

def from
  @from
end

#ownerObject

The Bandwidth senderId associated with the message. Identical to ‘from’.



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

def owner
  @owner
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



65
66
67
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



70
71
72
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 54

def self.attribute_map
  {
    :'from' => :'from',
    :'application_id' => :'applicationId',
    :'channel' => :'channel',
    :'content' => :'content',
    :'owner' => :'owner'
  }
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 263

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_ofObject

List of class defined in allOf (OpenAPI v3)



92
93
94
95
96
97
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 92

def self.openapi_all_of
  [
  :'MultiChannelChannelListOwnerObject',
  :'MultiChannelChannelListSMSObject'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



86
87
88
89
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 86

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

.openapi_typesObject

Attribute type mapping.



75
76
77
78
79
80
81
82
83
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 75

def self.openapi_types
  {
    :'from' => :'String',
    :'application_id' => :'String',
    :'channel' => :'MultiChannelMessageChannelEnum',
    :'content' => :'SmsMessageContent',
    :'owner' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



238
239
240
241
242
243
244
245
246
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      application_id == o.application_id &&
      channel == o.channel &&
      content == o.content &&
      owner == o.owner
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 250

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



256
257
258
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 256

def hash
  [from, application_id, channel, content, owner].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



176
177
178
179
180
181
182
183
184
# File 'lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @from.nil?
  return false if @application_id.nil?
  return false if @channel.nil?
  return false if @content.nil?
  return false if @owner.nil?
  true
end