Class: Bandwidth::Message

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'media')
    if (value = attributes[:'media']).is_a?(Array)
      self.media = value
    end
  end

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

#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/message.rb', line 25

def application_id
  @application_id
end

#direction ⇒ Object

Returns the value of attribute direction.



33
34
35
 
# File 'lib/bandwidth-sdk/models/message.rb', line 33

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.



53
54
55
 
# File 'lib/bandwidth-sdk/models/message.rb', line 53

def expiration
  @expiration
end

#from ⇒ Object

The phone number the message was sent from.



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

def from
  @from
end

#id ⇒ Object

The id of the message.



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

def id
  @id
end

#media ⇒ Object

The list of media URLs sent in the message. Including a ‘filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name.



42
43
44
 
# File 'lib/bandwidth-sdk/models/message.rb', line 42

def media
  @media
end

#owner ⇒ Object

The Bandwidth phone number associated with the message.



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

def owner
  @owner
end

#priority ⇒ Object

Returns the value of attribute priority.



50
51
52
 
# File 'lib/bandwidth-sdk/models/message.rb', line 50

def priority
  @priority
end

#segment_count ⇒ Object

The number of segments the user’s message is broken into before sending over carrier networks.



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

def segment_count
  @segment_count
end

#tag ⇒ Object

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



48
49
50
 
# File 'lib/bandwidth-sdk/models/message.rb', line 48

def tag
  @tag
end

#text ⇒ Object

The contents of the message.



45
46
47
 
# File 'lib/bandwidth-sdk/models/message.rb', line 45

def text
  @text
end

#time ⇒ Object

The datetime stamp of the message in ISO 8601



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

def time
  @time
end

#to ⇒ Object

The phone number recipients of the message.



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

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



97
98
99
 
# File 'lib/bandwidth-sdk/models/message.rb', line 97

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/models/message.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'owner' => :'owner',
    :'application_id' => :'applicationId',
    :'time' => :'time',
    :'segment_count' => :'segmentCount',
    :'direction' => :'direction',
    :'to' => :'to',
    :'from' => :'from',
    :'media' => :'media',
    :'text' => :'text',
    :'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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/bandwidth-sdk/models/message.rb', line 274

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



126
127
128
129
 
# File 'lib/bandwidth-sdk/models/message.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/bandwidth-sdk/models/message.rb', line 107

def self.openapi_types
  {
    :'id' => :'String',
    :'owner' => :'String',
    :'application_id' => :'String',
    :'time' => :'Time',
    :'segment_count' => :'Integer',
    :'direction' => :'MessageDirectionEnum',
    :'to' => :'Array<String>',
    :'from' => :'String',
    :'media' => :'Array<String>',
    :'text' => :'String',
    :'tag' => :'String',
    :'priority' => :'PriorityEnum',
    :'expiration' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/bandwidth-sdk/models/message.rb', line 241

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 &&
      media == o.media &&
      text == o.text &&
      tag == o.tag &&
      priority == o.priority &&
      expiration == o.expiration
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


261
262
263
 
# File 'lib/bandwidth-sdk/models/message.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/bandwidth-sdk/models/message.rb', line 267

def hash
  [id, owner, application_id, time, segment_count, direction, to, from, media, text, 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



206
207
208
209
210
 
# File 'lib/bandwidth-sdk/models/message.rb', line 206

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



214
215
216
217
 
# File 'lib/bandwidth-sdk/models/message.rb', line 214

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