Class: PureCloud::Group

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Group

Returns a new instance of Group.



72
73
74
75
76
77
78
79
80
81
82
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
 
# File 'lib/purecloud/models/group.rb', line 72

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'memberCount']
    self.member_count = attributes[:'memberCount']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'images']
    if (value = attributes[:'images']).is_a?(Array)
      self.images = value
    end
  end
  
  if attributes[:'addresses']
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#addresses ⇒ Object

Returns the value of attribute addresses.



23
24
25
 
# File 'lib/purecloud/models/group.rb', line 23

def addresses
  @addresses
end

#date_modified ⇒ Object

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



13
14
15
 
# File 'lib/purecloud/models/group.rb', line 13

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



10
11
12
 
# File 'lib/purecloud/models/group.rb', line 10

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/group.rb', line 6

def id
  @id
end

#images ⇒ Object

Returns the value of attribute images.



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

def images
  @images
end

#member_count ⇒ Object

Returns the value of attribute member_count.



15
16
17
 
# File 'lib/purecloud/models/group.rb', line 15

def member_count
  @member_count
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/group.rb', line 8

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



17
18
19
 
# File 'lib/purecloud/models/group.rb', line 17

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/purecloud/models/group.rb', line 19

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloud/models/group.rb', line 29

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

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloud/models/group.rb', line 56

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/purecloud/models/group.rb', line 135

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 &&
      images == o.images &&
      addresses == o.addresses &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloud/models/group.rb', line 180

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



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

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloud/models/group.rb', line 161

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


151
152
153
 
# File 'lib/purecloud/models/group.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



156
157
158
 
# File 'lib/purecloud/models/group.rb', line 156

def hash
  [id, name, description, date_modified, member_count, state, version, images, addresses, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



220
221
222
 
# File 'lib/purecloud/models/group.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloud/models/group.rb', line 225

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 



215
216
217
 
# File 'lib/purecloud/models/group.rb', line 215

def to_s
  to_hash.to_s
end