Class: OneRosterClient::DemographicType

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

Overview

…tbd (Class description)…

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DemographicType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 143

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

  # call parent's initialize
  super(attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#american_indian_or_alaska_native ⇒ Object

Model Primitive Datatype = Boolean



24
25
26
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 24

def american_indian_or_alaska_native
  @american_indian_or_alaska_native
end

#asian ⇒ Object

Model Primitive Datatype = Boolean



27
28
29
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 27

def asian
  @asian
end

#birth_date ⇒ Object

Model Primitive Datatype = Date



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

def birth_date
  @birth_date
end

#black_or_african_american ⇒ Object

Model Primitive Datatype = Boolean



30
31
32
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 30

def black_or_african_american
  @black_or_african_american
end

#city_of_birth ⇒ Object

Model Primitive Datatype = NormalizedString



51
52
53
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 51

def city_of_birth
  @city_of_birth
end

#country_of_birth_code ⇒ Object

Model Primitive Datatype = NormalizedString



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

def country_of_birth_code
  @country_of_birth_code
end

#date_last_modified ⇒ Object

Model Primitive Datatype = DateTime



62
63
64
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 62

def date_last_modified
  @date_last_modified
end

#demographic_race_two_or_more_races ⇒ Object

Model Primitive Datatype = Boolean



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

def demographic_race_two_or_more_races
  @demographic_race_two_or_more_races
end

#hispanic_or_latino_ethnicity ⇒ Object

Model Primitive Datatype = Boolean



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

def hispanic_or_latino_ethnicity
  @hispanic_or_latino_ethnicity
end

#metadata ⇒ Object

…tbd (Class description)…



65
66
67
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 65

def metadata
  @metadata
end

#native_hawaiian_or_other_pacific_islander ⇒ Object

Model Primitive Datatype = Boolean



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

def native_hawaiian_or_other_pacific_islander
  @native_hawaiian_or_other_pacific_islander
end

#public_school_residence_status ⇒ Object

Model Primitive Datatype = NormalizedString



54
55
56
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 54

def public_school_residence_status
  @public_school_residence_status
end

#sex ⇒ Object

Returns the value of attribute sex.



21
22
23
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 21

def sex
  @sex
end

#sourced_id ⇒ Object

…tbd (Class description)…



57
58
59
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 57

def sourced_id
  @sourced_id
end

#state_of_birth_abbreviation ⇒ Object

Model Primitive Datatype = NormalizedString



48
49
50
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 48

def state_of_birth_abbreviation
  @state_of_birth_abbreviation
end

#status ⇒ Object

Returns the value of attribute status.



59
60
61
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 59

def status
  @status
end

#white ⇒ Object

Model Primitive Datatype = Boolean



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

def white
  @white
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 90

def self.attribute_map
  {
    :'birth_date' => :'birthDate',
    :'sex' => :'sex',
    :'american_indian_or_alaska_native' => :'americanIndianOrAlaskaNative',
    :'asian' => :'asian',
    :'black_or_african_american' => :'blackOrAfricanAmerican',
    :'native_hawaiian_or_other_pacific_islander' => :'nativeHawaiianOrOtherPacificIslander',
    :'white' => :'white',
    :'demographic_race_two_or_more_races' => :'demographicRaceTwoOrMoreRaces',
    :'hispanic_or_latino_ethnicity' => :'hispanicOrLatinoEthnicity',
    :'country_of_birth_code' => :'countryOfBirthCode',
    :'state_of_birth_abbreviation' => :'stateOfBirthAbbreviation',
    :'city_of_birth' => :'cityOfBirth',
    :'public_school_residence_status' => :'publicSchoolResidenceStatus',
    :'sourced_id' => :'sourcedId',
    :'status' => :'status',
    :'date_last_modified' => :'dateLastModified',
    :'metadata' => :'metadata'
  }
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



319
320
321
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 319

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 136

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

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 113

def self.openapi_types
  {
    :'birth_date' => :'Date',
    :'sex' => :'String',
    :'american_indian_or_alaska_native' => :'Boolean',
    :'asian' => :'Boolean',
    :'black_or_african_american' => :'Boolean',
    :'native_hawaiian_or_other_pacific_islander' => :'Boolean',
    :'white' => :'Boolean',
    :'demographic_race_two_or_more_races' => :'Boolean',
    :'hispanic_or_latino_ethnicity' => :'Boolean',
    :'country_of_birth_code' => :'String',
    :'state_of_birth_abbreviation' => :'String',
    :'city_of_birth' => :'String',
    :'public_school_residence_status' => :'String',
    :'sourced_id' => :'String',
    :'status' => :'String',
    :'date_last_modified' => :'DateTime',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      birth_date == o.birth_date &&
      sex == o.sex &&
      american_indian_or_alaska_native == o.american_indian_or_alaska_native &&
      asian == o.asian &&
      black_or_african_american == o.black_or_african_american &&
      native_hawaiian_or_other_pacific_islander == o.native_hawaiian_or_other_pacific_islander &&
      white == o.white &&
      demographic_race_two_or_more_races == o.demographic_race_two_or_more_races &&
      hispanic_or_latino_ethnicity == o.hispanic_or_latino_ethnicity &&
      country_of_birth_code == o.country_of_birth_code &&
      state_of_birth_abbreviation == o.state_of_birth_abbreviation &&
      city_of_birth == o.city_of_birth &&
      public_school_residence_status == o.public_school_residence_status &&
      sourced_id == o.sourced_id &&
      status == o.status &&
      date_last_modified == o.date_last_modified &&
      metadata == o.metadata && super(o)
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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 350

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 419

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 326

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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


306
307
308
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 312

def hash
  [birth_date, sex, american_indian_or_alaska_native, asian, black_or_african_american, native_hawaiian_or_other_pacific_islander, white, demographic_race_two_or_more_races, hispanic_or_latino_ethnicity, country_of_birth_code, state_of_birth_abbreviation, city_of_birth, public_school_residence_status, sourced_id, status, date_last_modified, metadata].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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 230

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

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

  if @date_last_modified.nil?
    invalid_properties.push('invalid value for "date_last_modified", date_last_modified 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



395
396
397
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 401

def to_hash
  hash = super
  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



389
390
391
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 389

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



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oneroster_client/models/demographic_type.rb', line 249

def valid?
  # sex_validator = EnumAttributeValidator.new('', ['male', 'female'])
  # return false unless sex_validator.valid?(@sex)
  return false if @sourced_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('', ['active', 'tobedeleted'])
  return false unless status_validator.valid?(@status)
  return false if @date_last_modified.nil?
  true
end