Class: PureCloud::Group

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Group

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/group.rb', line 97

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#addresses ⇒ Object

Returns the value of attribute addresses.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 46

def addresses
  @addresses
end

#date_modified ⇒ Object

Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 30

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 27

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 22

def id
  @id
end

#images ⇒ Object

Returns the value of attribute images.



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 44

def images
  @images
end

#member_count ⇒ Object

Number of members.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 33

def member_count
  @member_count
end

#name ⇒ Object

The group name.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 25

def name
  @name
end

#rules_visible ⇒ Object

Are membership rules visible to the person requesting to view the group



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 49

def rules_visible
  @rules_visible
end

#self_uri ⇒ Object

The URI for this object



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 55

def self_uri
  @self_uri
end

#state ⇒ Object

Active, inactive, or deleted state.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 36

def state
  @state
end

#type ⇒ Object

Type of group.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 42

def type
  @type
end

#version ⇒ Object

Current version for this resource.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 39

def version
  @version
end

#visibility ⇒ Object

Who can view this group



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 52

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'date_modified' => :'dateModified',
    :'member_count' => :'memberCount',
    :'state' => :'state',
    :'version' => :'version',
    :'type' => :'type',
    :'images' => :'images',
    :'addresses' => :'addresses',
    :'rules_visible' => :'rulesVisible',
    :'visibility' => :'visibility',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 77

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'date_modified' => :'DateTime',
    :'member_count' => :'Integer',
    :'state' => :'String',
    :'version' => :'Integer',
    :'type' => :'String',
    :'images' => :'Array<UserImage>',
    :'addresses' => :'Array<GroupContact>',
    :'rules_visible' => :'BOOLEAN',
    :'visibility' => :'String',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      date_modified == o.date_modified &&
      member_count == o.member_count &&
      state == o.state &&
      version == o.version &&
      type == o.type &&
      images == o.images &&
      addresses == o.addresses &&
      rules_visible == o.rules_visible &&
      visibility == o.visibility &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



283
284
285
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
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 283

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 343

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



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

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


253
254
255
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 259

def hash
  [id, name, description, date_modified, member_count, state, version, type, images, addresses, rules_visible, visibility, self_uri].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
 
# File 'lib/purecloudplatformclientv2/models/group.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))



326
327
328
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 326

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



331
332
333
334
335
336
337
338
339
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 331

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 



321
322
323
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 321

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



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
 
# File 'lib/purecloudplatformclientv2/models/group.rb', line 170

def valid?
  if @name.nil?
    return false
  end

  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  if @type.nil?
    return false
  end

  allowed_values = ["official", "social"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  if @rules_visible.nil?
    return false
  end

  if @visibility.nil?
    return false
  end

  allowed_values = ["public", "owners", "members"]
  if @visibility && !allowed_values.include?(@visibility)
    return false
  end
end