Class: OneRosterClient::DemographicTypeAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/oneroster_client/models/demographic_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 = {}) ⇒ DemographicTypeAllOf

Initializes the object



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

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

Instance Attribute Details

#american_indian_or_alaska_native ⇒ Object

Model Primitive Datatype = Boolean



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

def american_indian_or_alaska_native
  @american_indian_or_alaska_native
end

#asian ⇒ Object

Model Primitive Datatype = Boolean



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

def asian
  @asian
end

#birth_date ⇒ Object

Model Primitive Datatype = Date



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

def birth_date
  @birth_date
end

#black_or_african_american ⇒ Object

Model Primitive Datatype = Boolean



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

def black_or_african_american
  @black_or_african_american
end

#city_of_birth ⇒ Object

Model Primitive Datatype = NormalizedString



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

def city_of_birth
  @city_of_birth
end

#country_of_birth_code ⇒ Object

Model Primitive Datatype = NormalizedString



43
44
45
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 43

def country_of_birth_code
  @country_of_birth_code
end

#demographic_race_two_or_more_races ⇒ Object

Model Primitive Datatype = Boolean



37
38
39
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 37

def demographic_race_two_or_more_races
  @demographic_race_two_or_more_races
end

#hispanic_or_latino_ethnicity ⇒ Object

Model Primitive Datatype = Boolean



40
41
42
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 40

def hispanic_or_latino_ethnicity
  @hispanic_or_latino_ethnicity
end

#native_hawaiian_or_other_pacific_islander ⇒ Object

Model Primitive Datatype = Boolean



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

def native_hawaiian_or_other_pacific_islander
  @native_hawaiian_or_other_pacific_islander
end

#public_school_residence_status ⇒ Object

Model Primitive Datatype = NormalizedString



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

def public_school_residence_status
  @public_school_residence_status
end

#sex ⇒ Object

Returns the value of attribute sex.



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

def sex
  @sex
end

#state_of_birth_abbreviation ⇒ Object

Model Primitive Datatype = NormalizedString



46
47
48
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 46

def state_of_birth_abbreviation
  @state_of_birth_abbreviation
end

#white ⇒ Object

Model Primitive Datatype = Boolean



34
35
36
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 34

def white
  @white
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 77

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'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



248
249
250
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 96

def self.openapi_types
  {
    :'birth_date' => :'Object',
    :'sex' => :'Object',
    :'american_indian_or_alaska_native' => :'Object',
    :'asian' => :'Object',
    :'black_or_african_american' => :'Object',
    :'native_hawaiian_or_other_pacific_islander' => :'Object',
    :'white' => :'Object',
    :'demographic_race_two_or_more_races' => :'Object',
    :'hispanic_or_latino_ethnicity' => :'Object',
    :'country_of_birth_code' => :'Object',
    :'state_of_birth_abbreviation' => :'Object',
    :'city_of_birth' => :'Object',
    :'public_school_residence_status' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 215

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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 278

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 347

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 255

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

See Also:

  • `==` method


235
236
237
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



241
242
243
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 241

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].hash
end

#list_invalid_properties ⇒ Object

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



190
191
192
193
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



323
324
325
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 323

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 329

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



317
318
319
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 317

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



197
198
199
200
201
 
# File 'lib/oneroster_client/models/demographic_type_all_of.rb', line 197

def valid?
  sex_validator = EnumAttributeValidator.new('Object', ['male', 'female'])
  return false unless sex_validator.valid?(@sex)
  true
end