Class: AlfrescoAPI::Person

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/models/person.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Person

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
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
200
201
202
203
204
205
206
207
 
# File 'lib/alfresco_api/models/person.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = true
  end

  if attributes.has_key?(:'emailNotificationsEnabled')
    self.email_notifications_enabled = attributes[:'emailNotificationsEnabled']
  else
    self.email_notifications_enabled = true
  end

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

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

end

Instance Attribute Details

#aspect_names ⇒ Object

Returns the value of attribute aspect_names.



54
55
56
 
# File 'lib/alfresco_api/models/person.rb', line 54

def aspect_names
  @aspect_names
end

#avatar_id ⇒ Object

Returns the value of attribute avatar_id.



26
27
28
 
# File 'lib/alfresco_api/models/person.rb', line 26

def avatar_id
  @avatar_id
end

#company ⇒ Object

Returns the value of attribute company.



40
41
42
 
# File 'lib/alfresco_api/models/person.rb', line 40

def company
  @company
end

#description ⇒ Object

Returns the value of attribute description.



24
25
26
 
# File 'lib/alfresco_api/models/person.rb', line 24

def description
  @description
end

#email ⇒ Object

Returns the value of attribute email.



28
29
30
 
# File 'lib/alfresco_api/models/person.rb', line 28

def email
  @email
end

#email_notifications_enabled ⇒ Object

Returns the value of attribute email_notifications_enabled.



52
53
54
 
# File 'lib/alfresco_api/models/person.rb', line 52

def email_notifications_enabled
  @email_notifications_enabled
end

#enabled ⇒ Object

Returns the value of attribute enabled.



50
51
52
 
# File 'lib/alfresco_api/models/person.rb', line 50

def enabled
  @enabled
end

#first_name ⇒ Object

Returns the value of attribute first_name.



20
21
22
 
# File 'lib/alfresco_api/models/person.rb', line 20

def first_name
  @first_name
end

#google_id ⇒ Object

Returns the value of attribute google_id.



32
33
34
 
# File 'lib/alfresco_api/models/person.rb', line 32

def google_id
  @google_id
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/alfresco_api/models/person.rb', line 18

def id
  @id
end

#instant_message_id ⇒ Object

Returns the value of attribute instant_message_id.



34
35
36
 
# File 'lib/alfresco_api/models/person.rb', line 34

def instant_message_id
  @instant_message_id
end

#job_title ⇒ Object

Returns the value of attribute job_title.



36
37
38
 
# File 'lib/alfresco_api/models/person.rb', line 36

def job_title
  @job_title
end

#last_name ⇒ Object

Returns the value of attribute last_name.



22
23
24
 
# File 'lib/alfresco_api/models/person.rb', line 22

def last_name
  @last_name
end

#location ⇒ Object

Returns the value of attribute location.



38
39
40
 
# File 'lib/alfresco_api/models/person.rb', line 38

def location
  @location
end

#mobile ⇒ Object

Returns the value of attribute mobile.



42
43
44
 
# File 'lib/alfresco_api/models/person.rb', line 42

def mobile
  @mobile
end

#properties ⇒ Object

Returns the value of attribute properties.



56
57
58
 
# File 'lib/alfresco_api/models/person.rb', line 56

def properties
  @properties
end

#skype_id ⇒ Object

Returns the value of attribute skype_id.



30
31
32
 
# File 'lib/alfresco_api/models/person.rb', line 30

def skype_id
  @skype_id
end

#status_updated_at ⇒ Object

Returns the value of attribute status_updated_at.



46
47
48
 
# File 'lib/alfresco_api/models/person.rb', line 46

def status_updated_at
  @status_updated_at
end

#telephone ⇒ Object

Returns the value of attribute telephone.



44
45
46
 
# File 'lib/alfresco_api/models/person.rb', line 44

def telephone
  @telephone
end

#user_status ⇒ Object

Returns the value of attribute user_status.



48
49
50
 
# File 'lib/alfresco_api/models/person.rb', line 48

def user_status
  @user_status
end

Class Method Details

.attribute_map ⇒ Object

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



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/alfresco_api/models/person.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'description' => :'description',
    :'avatar_id' => :'avatarId',
    :'email' => :'email',
    :'skype_id' => :'skypeId',
    :'google_id' => :'googleId',
    :'instant_message_id' => :'instantMessageId',
    :'job_title' => :'jobTitle',
    :'location' => :'location',
    :'company' => :'company',
    :'mobile' => :'mobile',
    :'telephone' => :'telephone',
    :'status_updated_at' => :'statusUpdatedAt',
    :'user_status' => :'userStatus',
    :'enabled' => :'enabled',
    :'email_notifications_enabled' => :'emailNotificationsEnabled',
    :'aspect_names' => :'aspectNames',
    :'properties' => :'properties'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/alfresco_api/models/person.rb', line 86

def self.swagger_types
  {
    :'id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'description' => :'String',
    :'avatar_id' => :'String',
    :'email' => :'String',
    :'skype_id' => :'String',
    :'google_id' => :'String',
    :'instant_message_id' => :'String',
    :'job_title' => :'String',
    :'location' => :'String',
    :'company' => :'Company',
    :'mobile' => :'String',
    :'telephone' => :'String',
    :'status_updated_at' => :'DateTime',
    :'user_status' => :'String',
    :'enabled' => :'BOOLEAN',
    :'email_notifications_enabled' => :'BOOLEAN',
    :'aspect_names' => :'Array<String>',
    :'properties' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/alfresco_api/models/person.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      description == o.description &&
      avatar_id == o.avatar_id &&
      email == o.email &&
      skype_id == o.skype_id &&
      google_id == o.google_id &&
      instant_message_id == o.instant_message_id &&
      job_title == o.job_title &&
      location == o.location &&
      company == o.company &&
      mobile == o.mobile &&
      telephone == o.telephone &&
      status_updated_at == o.status_updated_at &&
      user_status == o.user_status &&
      enabled == o.enabled &&
      email_notifications_enabled == o.email_notifications_enabled &&
      aspect_names == o.aspect_names &&
      properties == o.properties
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/alfresco_api/models/person.rb', line 305

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = AlfrescoAPI.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/alfresco_api/models/person.rb', line 371

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/alfresco_api/models/person.rb', line 284

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/alfresco_api/models/person.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/alfresco_api/models/person.rb', line 277

def hash
  [id, first_name, last_name, description, avatar_id, email, skype_id, google_id, instant_message_id, job_title, location, company, mobile, telephone, status_updated_at, user_status, enabled, email_notifications_enabled, aspect_names, properties].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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/alfresco_api/models/person.rb', line 211

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @first_name.nil?
    invalid_properties.push("invalid value for 'first_name', first_name cannot be nil.")
  end

  if @email.nil?
    invalid_properties.push("invalid value for 'email', email cannot be nil.")
  end

  if @enabled.nil?
    invalid_properties.push("invalid value for 'enabled', enabled cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
 
# File 'lib/alfresco_api/models/person.rb', line 351

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
 
# File 'lib/alfresco_api/models/person.rb', line 357

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



345
346
347
 
# File 'lib/alfresco_api/models/person.rb', line 345

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



234
235
236
237
238
239
240
 
# File 'lib/alfresco_api/models/person.rb', line 234

def valid?
  return false if @id.nil?
  return false if @first_name.nil?
  return false if @email.nil?
  return false if @enabled.nil?
  return true
end