Class: Bandwidth::Tag

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/messaging_lib/messaging/models/tag.rb

Overview

Tag Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(key = nil, value = nil) ⇒ Tag

Returns a new instance of Tag.



25
26
27
28
29
 
# File 'lib/bandwidth/messaging_lib/messaging/models/tag.rb', line 25

def initialize(key = nil,
               value = nil)
  @key = key
  @value = value
end

Instance Attribute Details

#key ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


11
12
13
 
# File 'lib/bandwidth/messaging_lib/messaging/models/tag.rb', line 11

def key
  @key
end

#value ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/bandwidth/messaging_lib/messaging/models/tag.rb', line 15

def value
  @value
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bandwidth/messaging_lib/messaging/models/tag.rb', line 32

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  key = hash['key']
  value = hash['value']

  # Create object from extracted values.
  Tag.new(key,
          value)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
23
 
# File 'lib/bandwidth/messaging_lib/messaging/models/tag.rb', line 18

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['key'] = 'key'
  @_hash['value'] = 'value'
  @_hash
end