Class: CMV4APIClient::User

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/models/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 144

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CMV4APIClient::User` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CMV4APIClient::User`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'created_by')
    self.created_by = attributes[:'created_by']
  end

  if attributes.key?(:'database_id')
    self.database_id = attributes[:'database_id']
  end

  if attributes.key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.key?(:'department')
    self.department = attributes[:'department']
  end

  if attributes.key?(:'descriptor')
    self.descriptor = attributes[:'descriptor']
  end

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

  if attributes.key?(:'fax')
    self.fax = attributes[:'fax']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

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

  if attributes.key?(:'login')
    self. = attributes[:'login']
  end

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

  if attributes.key?(:'modified')
    self.modified = attributes[:'modified']
  end

  if attributes.key?(:'modified_by')
    self.modified_by = attributes[:'modified_by']
  end

  if attributes.key?(:'modified_end_time')
    self.modified_end_time = attributes[:'modified_end_time']
  end

  if attributes.key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.key?(:'oauth_name_identifier')
    self.oauth_name_identifier = attributes[:'oauth_name_identifier']
  end

  if attributes.key?(:'organisation')
    self.organisation = attributes[:'organisation']
  end

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.key?(:'position')
    self.position = attributes[:'position']
  end

  if attributes.key?(:'use_legacy_login')
    self. = attributes[:'use_legacy_login']
  end

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

Instance Attribute Details

#created ⇒ Object

Returns the value of attribute created.



19
20
21
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 19

def created
  @created
end

#created_by ⇒ Object

Returns the value of attribute created_by.



21
22
23
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 21

def created_by
  @created_by
end

#database_id ⇒ Object

Returns the value of attribute database_id.



23
24
25
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 23

def database_id
  @database_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



25
26
27
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 25

def deleted
  @deleted
end

#department ⇒ Object

Returns the value of attribute department.



27
28
29
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 27

def department
  @department
end

#descriptor ⇒ Object

Returns the value of attribute descriptor.



29
30
31
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 29

def descriptor
  @descriptor
end

#email ⇒ Object

Returns the value of attribute email.



31
32
33
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 31

def email
  @email
end

#fax ⇒ Object

Returns the value of attribute fax.



33
34
35
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 33

def fax
  @fax
end

#first_name ⇒ Object

Returns the value of attribute first_name.



35
36
37
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 35

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 17

def id
  @id
end

#last_name ⇒ Object

Returns the value of attribute last_name.



37
38
39
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 37

def last_name
  @last_name
end

#login ⇒ Object

Returns the value of attribute login.



39
40
41
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 39

def 
  @login
end

#mobile ⇒ Object

Returns the value of attribute mobile.



41
42
43
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 41

def mobile
  @mobile
end

#modified ⇒ Object

Returns the value of attribute modified.



43
44
45
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 43

def modified
  @modified
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



45
46
47
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 45

def modified_by
  @modified_by
end

#modified_end_time ⇒ Object

Returns the value of attribute modified_end_time.



47
48
49
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 47

def modified_end_time
  @modified_end_time
end

#notes ⇒ Object

Returns the value of attribute notes.



49
50
51
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 49

def notes
  @notes
end

#oauth_name_identifier ⇒ Object

Returns the value of attribute oauth_name_identifier.



51
52
53
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 51

def oauth_name_identifier
  @oauth_name_identifier
end

#organisation ⇒ Object

Returns the value of attribute organisation.



53
54
55
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 53

def organisation
  @organisation
end

#phone ⇒ Object

Returns the value of attribute phone.



55
56
57
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 55

def phone
  @phone
end

#position ⇒ Object

Returns the value of attribute position.



57
58
59
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 57

def position
  @position
end

#use_legacy_login ⇒ Object

Returns the value of attribute use_legacy_login.



59
60
61
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 59

def 
  @use_legacy_login
end

#visibility ⇒ Object

Returns the value of attribute visibility.



61
62
63
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 61

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'database_id' => :'databaseId',
    :'deleted' => :'deleted',
    :'department' => :'department',
    :'descriptor' => :'descriptor',
    :'email' => :'email',
    :'fax' => :'fax',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'login' => :'login',
    :'mobile' => :'mobile',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'modified_end_time' => :'modifiedEndTime',
    :'notes' => :'notes',
    :'oauth_name_identifier' => :'oauthNameIdentifier',
    :'organisation' => :'organisation',
    :'phone' => :'phone',
    :'position' => :'position',
    :'use_legacy_login' => :'useLegacyLogin',
    :'visibility' => :'visibility'
  }
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



308
309
310
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 308

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 122

def self.openapi_nullable
  Set.new([
    :'created_by',
    :'department',
    :'descriptor',
    :'email',
    :'fax',
    :'first_name',
    :'last_name',
    :'login',
    :'mobile',
    :'modified_by',
    :'notes',
    :'oauth_name_identifier',
    :'organisation',
    :'phone',
    :'position',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 93

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'created_by' => :'IdentityModel',
    :'database_id' => :'String',
    :'deleted' => :'Boolean',
    :'department' => :'String',
    :'descriptor' => :'String',
    :'email' => :'String',
    :'fax' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'login' => :'String',
    :'mobile' => :'String',
    :'modified' => :'DateTime',
    :'modified_by' => :'IdentityModel',
    :'modified_end_time' => :'DateTime',
    :'notes' => :'String',
    :'oauth_name_identifier' => :'String',
    :'organisation' => :'String',
    :'phone' => :'String',
    :'position' => :'String',
    :'use_legacy_login' => :'Boolean',
    :'visibility' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      created_by == o.created_by &&
      database_id == o.database_id &&
      deleted == o.deleted &&
      department == o.department &&
      descriptor == o.descriptor &&
      email == o.email &&
      fax == o.fax &&
      first_name == o.first_name &&
      last_name == o.last_name &&
       == o. &&
      mobile == o.mobile &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      modified_end_time == o.modified_end_time &&
      notes == o.notes &&
      oauth_name_identifier == o.oauth_name_identifier &&
      organisation == o.organisation &&
      phone == o.phone &&
      position == o.position &&
       == o. &&
      visibility == o.visibility
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 336

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
    CMV4APIClient.const_get(type).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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 405

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 315

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


295
296
297
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 301

def hash
  [id, created, created_by, database_id, deleted, department, descriptor, email, fax, first_name, last_name, , mobile, modified, modified_by, modified_end_time, notes, oauth_name_identifier, organisation, phone, position, , visibility].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



252
253
254
255
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 252

def list_invalid_properties
  invalid_properties = Array.new
  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



381
382
383
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 387

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



375
376
377
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 375

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



259
260
261
 
# File 'lib/cmv4-openapi-client/models/user.rb', line 259

def valid?
  true
end