Class: PureCloud::AvailableTopic

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AvailableTopic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 83

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

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

  
  if attributes.has_key?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

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

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

  
  if attributes.has_key?(:'requiresCurrentUser')
    
    
    self.requires_current_user = attributes[:'requiresCurrentUser']
    
  
  end

  
  if attributes.has_key?(:'requiresCurrentUserOrPermission')
    
    
    self.requires_current_user_or_permission = attributes[:'requiresCurrentUserOrPermission']
    
  
  end

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

  
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 23

def id
  @id
end

#requires_current_user ⇒ Object

True if the topic user ID is required to match the subscribing user ID



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 31

def requires_current_user
  @requires_current_user
end

#requires_current_user_or_permission ⇒ Object

True if permissions are only required when the topic user ID does not match the subscribing user ID



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 34

def requires_current_user_or_permission
  @requires_current_user_or_permission
end

#requires_permissions ⇒ Object

Permissions required to subscribe to the topic



26
27
28
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/models/available_topic.rb', line 28

def schema
  @schema
end

#transports ⇒ Object

Transports that support events for the topic



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 37

def transports
  @transports
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 40

def self.attribute_map
  {
    
    :'description' => :'description',
    
    :'id' => :'id',
    
    :'requires_permissions' => :'requiresPermissions',
    
    :'schema' => :'schema',
    
    :'requires_current_user' => :'requiresCurrentUser',
    
    :'requires_current_user_or_permission' => :'requiresCurrentUserOrPermission',
    
    :'transports' => :'transports'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 61

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 242

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 &&
      requires_current_user == o.requires_current_user &&
      requires_current_user_or_permission == o.requires_current_user_or_permission &&
      transports == o.transports
end

#_deserialize(type, value) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 286

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 346

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 267

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


256
257
258
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



262
263
264
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 262

def hash
  [description, id, requires_permissions, schema, requires_current_user, requires_current_user_or_permission, transports].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



163
164
165
166
167
168
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



329
330
331
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 329

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



334
335
336
337
338
339
340
341
342
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 334

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 



324
325
326
 
# File 'lib/purecloudplatformclientv2/models/available_topic.rb', line 324

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



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/purecloudplatformclientv2/models/available_topic.rb', line 172

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end