class Clever::School

Attributes

created[RW]
district[RW]
ext[RW]
high_grade[RW]
id[RW]
last_modified[RW]
location[RW]
low_grade[RW]
mdr_number[RW]
name[RW]
nces_id[RW]
phone[RW]
principal[RW]
school_number[RW]
sis_id[RW]
state_id[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/clever-ruby/models/school.rb, line 72
def self.attribute_map
  {
    :'created' => :'created',
    :'district' => :'district',
    :'ext' => :'ext',
    :'high_grade' => :'high_grade',
    :'id' => :'id',
    :'last_modified' => :'last_modified',
    :'location' => :'location',
    :'low_grade' => :'low_grade',
    :'mdr_number' => :'mdr_number',
    :'name' => :'name',
    :'nces_id' => :'nces_id',
    :'phone' => :'phone',
    :'principal' => :'principal',
    :'school_number' => :'school_number',
    :'sis_id' => :'sis_id',
    :'state_id' => :'state_id'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/clever-ruby/models/school.rb, line 117
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?(:'created')
    self.created = attributes[:'created']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'state_id')
    self.state_id = attributes[:'state_id']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/clever-ruby/models/school.rb, line 94
def self.swagger_types
  {
    :'created' => :'String',
    :'district' => :'String',
    :'ext' => :'Object',
    :'high_grade' => :'String',
    :'id' => :'String',
    :'last_modified' => :'String',
    :'location' => :'Location',
    :'low_grade' => :'String',
    :'mdr_number' => :'String',
    :'name' => :'String',
    :'nces_id' => :'String',
    :'phone' => :'String',
    :'principal' => :'Principal',
    :'school_number' => :'String',
    :'sis_id' => :'String',
    :'state_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/clever-ruby/models/school.rb, line 227
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      district == o.district &&
      ext == o.ext &&
      high_grade == o.high_grade &&
      id == o.id &&
      last_modified == o.last_modified &&
      location == o.location &&
      low_grade == o.low_grade &&
      mdr_number == o.mdr_number &&
      name == o.name &&
      nces_id == o.nces_id &&
      phone == o.phone &&
      principal == o.principal &&
      school_number == o.school_number &&
      sis_id == o.sis_id &&
      state_id == o.state_id
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/clever-ruby/models/school.rb, line 284
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 = Clever.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/clever-ruby/models/school.rb, line 350
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/clever-ruby/models/school.rb, line 263
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 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/clever-ruby/models/school.rb, line 250
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/clever-ruby/models/school.rb, line 256
def hash
  [created, district, ext, high_grade, id, last_modified, location, low_grade, mdr_number, name, nces_id, phone, principal, school_number, sis_id, state_id].hash
end
high_grade=(high_grade) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] high_grade Object to be assigned

# File lib/clever-ruby/models/school.rb, line 207
def high_grade=(high_grade)
  validator = EnumAttributeValidator.new('String', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
  unless validator.valid?(high_grade)
    fail ArgumentError, 'invalid value for "high_grade", must be one of #{validator.allowable_values}.'
  end
  @high_grade = high_grade
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/clever-ruby/models/school.rb, line 190
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
low_grade=(low_grade) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] low_grade Object to be assigned

# File lib/clever-ruby/models/school.rb, line 217
def low_grade=(low_grade)
  validator = EnumAttributeValidator.new('String', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
  unless validator.valid?(low_grade)
    fail ArgumentError, 'invalid value for "low_grade", must be one of #{validator.allowable_values}.'
  end
  @low_grade = low_grade
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/clever-ruby/models/school.rb, line 330
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/clever-ruby/models/school.rb, line 336
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/clever-ruby/models/school.rb, line 324
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/clever-ruby/models/school.rb, line 197
def valid?
  high_grade_validator = EnumAttributeValidator.new('String', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
  return false unless high_grade_validator.valid?(@high_grade)
  low_grade_validator = EnumAttributeValidator.new('String', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
  return false unless low_grade_validator.valid?(@low_grade)
  true
end