Class: PureCloud::AvailableTopic

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/available_topic.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AvailableTopic

Returns a new instance of AvailableTopic.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloud/models/available_topic.rb', line 56

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'requiresPermissions']
    if (value = attributes[:'requiresPermissions']).is_a?(Array)
      self.requires_permissions = value
    end
  end
  
  if attributes[:'schema']
    if (value = attributes[:'schema']).is_a?(Array)
      self.schema = value
    end
  end
  
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



21
22
23
 
# File 'lib/purecloud/models/available_topic.rb', line 21

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



24
25
26
 
# File 'lib/purecloud/models/available_topic.rb', line 24

def id
  @id
end

#requires_permissions ⇒ Object

Returns the value of attribute requires_permissions.



26
27
28
 
# File 'lib/purecloud/models/available_topic.rb', line 26

def requires_permissions
  @requires_permissions
end

#schema ⇒ Object

Returns the value of attribute schema.



28
29
30
 
# File 'lib/purecloud/models/available_topic.rb', line 28

def schema
  @schema
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/purecloud/models/available_topic.rb', line 31

def self.attribute_map
  {
    
    :'description' => :'description',
    
    :'id' => :'id',
    
    :'requires_permissions' => :'requiresPermissions',
    
    :'schema' => :'schema'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloud/models/available_topic.rb', line 46

def self.swagger_types
  {
    :'description' => :'String',
    :'id' => :'String',
    :'requires_permissions' => :'Array<String>',
    :'schema' => :'Hash<String, Object>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



86
87
88
89
90
91
92
93
 
# File 'lib/purecloud/models/available_topic.rb', line 86

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      id == o.id &&
      requires_permissions == o.requires_permissions &&
      schema == o.schema
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/available_topic.rb', line 125

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/purecloud/models/available_topic.rb', line 185

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

#build_from_hash(attributes) ⇒ Object

build the object from hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/purecloud/models/available_topic.rb', line 106

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


96
97
98
 
# File 'lib/purecloud/models/available_topic.rb', line 96

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



101
102
103
 
# File 'lib/purecloud/models/available_topic.rb', line 101

def hash
  [description, id, requires_permissions, schema].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



168
169
170
 
# File 'lib/purecloud/models/available_topic.rb', line 168

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



173
174
175
176
177
178
179
180
181
 
# File 'lib/purecloud/models/available_topic.rb', line 173

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



163
164
165
 
# File 'lib/purecloud/models/available_topic.rb', line 163

def to_s
  to_hash.to_s
end