Class: OneRosterClient::UserTypeAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/oneroster_client/models/user_type_all_of.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserTypeAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OneRosterClient::UserTypeAllOf` 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 `OneRosterClient::UserTypeAllOf`. 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?(:'username')
    self.username = attributes[:'username']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agents ⇒ Object

Returns the value of attribute agents.



47
48
49
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 47

def agents
  @agents
end

#email ⇒ Object

Model Primitive Datatype = NormalizedString



39
40
41
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 39

def email
  @email
end

#enabled_user ⇒ Object

Model Primitive Datatype = Boolean



22
23
24
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 22

def enabled_user
  @enabled_user
end

#family_name ⇒ Object

Model Primitive Datatype = NormalizedString



28
29
30
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 28

def family_name
  @family_name
end

#given_name ⇒ Object

Model Primitive Datatype = NormalizedString



25
26
27
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 25

def given_name
  @given_name
end

#grades ⇒ Object

Model Primitive Datatype = NormalizedString



52
53
54
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 52

def grades
  @grades
end

#identifier ⇒ Object

…tbd (Class description)…



36
37
38
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 36

def identifier
  @identifier
end

#middle_name ⇒ Object

Model Primitive Datatype = NormalizedString



31
32
33
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 31

def middle_name
  @middle_name
end

#orgs ⇒ Object

Returns the value of attribute orgs.



49
50
51
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 49

def orgs
  @orgs
end

#password ⇒ Object

Model Primitive Datatype = String



55
56
57
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 55

def password
  @password
end

#phone ⇒ Object

Model Primitive Datatype = NormalizedString



45
46
47
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 45

def phone
  @phone
end

#role ⇒ Object

Returns the value of attribute role.



33
34
35
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 33

def role
  @role
end

#sms ⇒ Object

Model Primitive Datatype = NormalizedString



42
43
44
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 42

def sms
  @sms
end

#user_ids ⇒ Object

Returns the value of attribute user_ids.



19
20
21
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 19

def user_ids
  @user_ids
end

#username ⇒ Object

Model Primitive Datatype = NormalizedString



17
18
19
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 17

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 80

def self.attribute_map
  {
    :'username' => :'username',
    :'user_ids' => :'userIds',
    :'enabled_user' => :'enabledUser',
    :'given_name' => :'givenName',
    :'family_name' => :'familyName',
    :'middle_name' => :'middleName',
    :'role' => :'role',
    :'identifier' => :'identifier',
    :'email' => :'email',
    :'sms' => :'sms',
    :'phone' => :'phone',
    :'agents' => :'agents',
    :'orgs' => :'orgs',
    :'grades' => :'grades',
    :'password' => :'password'
  }
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



298
299
300
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 298

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
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 122

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 101

def self.openapi_types
  {
    :'username' => :'Object',
    :'user_ids' => :'Object',
    :'enabled_user' => :'Object',
    :'given_name' => :'Object',
    :'family_name' => :'Object',
    :'middle_name' => :'Object',
    :'role' => :'Object',
    :'identifier' => :'Object',
    :'email' => :'Object',
    :'sms' => :'Object',
    :'phone' => :'Object',
    :'agents' => :'Object',
    :'orgs' => :'Object',
    :'grades' => :'Object',
    :'password' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      username == o.username &&
      user_ids == o.user_ids &&
      enabled_user == o.enabled_user &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      middle_name == o.middle_name &&
      role == o.role &&
      identifier == o.identifier &&
      email == o.email &&
      sms == o.sms &&
      phone == o.phone &&
      agents == o.agents &&
      orgs == o.orgs &&
      grades == o.grades &&
      password == o.password
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



328
329
330
331
332
333
334
335
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
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 328

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
    OneRosterClient.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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 397

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 305

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 291

def hash
  [username, user_ids, enabled_user, given_name, family_name, middle_name, role, identifier, email, sms, phone, agents, orgs, grades, password].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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 213

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

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

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

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

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

  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



373
374
375
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 379

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



367
368
369
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 367

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



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oneroster_client/models/user_type_all_of.rb', line 240

def valid?
  return false if @username.nil?
  return false if @given_name.nil?
  return false if @family_name.nil?
  return false if @role.nil?
  role_validator = EnumAttributeValidator.new('Object', ['administrator', 'aide', 'guardian', 'parent', 'proctor', 'relative', 'student', 'teacher'])
  return false unless role_validator.valid?(@role)
  return false if @orgs.nil?
  true
end