clever-ruby 1.0.0 → 1.1.0

data/lib/clever-ruby/models/school.rb

@@ -14,20 +14,22 @@ require 'date'
 module Clever
 
   class School
-    attr_accessor :id
-
     attr_accessor :created
 
     attr_accessor :district
 
     attr_accessor :high_grade
 
+    attr_accessor :id
+
     attr_accessor :last_modified
 
     attr_accessor :location
 
     attr_accessor :low_grade
 
+    attr_accessor :mdr_number
+
     attr_accessor :name
 
     attr_accessor :nces_id
@@ -42,48 +44,67 @@ module Clever
 
     attr_accessor :state_id
 
-    attr_accessor :mdr_number
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
         :'created' => :'created',
         :'district' => :'district',
         :'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',
-        :'mdr_number' => :'mdr_number'
+        :'state_id' => :'state_id'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
         :'created' => :'String',
         :'district' => :'String',
         :'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',
-        :'mdr_number' => :'String'
+        :'state_id' => :'String'
       }
     end
 
@@ -95,10 +116,6 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.has_key?(:'created')
         self.created = attributes[:'created']
       end
@@ -111,6 +128,10 @@ module Clever
         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
@@ -123,6 +144,10 @@ module Clever
         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
@@ -151,10 +176,6 @@ module Clever
         self.state_id = attributes[:'state_id']
       end
 
-      if attributes.has_key?(:'mdr_number')
-        self.mdr_number = attributes[:'mdr_number']
-      end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,29 +188,53 @@ module Clever
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      high_grade_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      return false unless high_grade_validator.valid?(@high_grade)
+      low_grade_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      return false unless low_grade_validator.valid?(@low_grade)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] high_grade Object to be assigned
+    def high_grade=(high_grade)
+      validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] low_grade Object to be assigned
+    def low_grade=(low_grade)
+      validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "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
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
           created == o.created &&
           district == o.district &&
           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 &&
-          mdr_number == o.mdr_number
+          state_id == o.state_id
     end
 
     # @see the `==` method
@@ -201,7 +246,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, created, district, high_grade, last_modified, location, low_grade, name, nces_id, phone, principal, school_number, sis_id, state_id, mdr_number].hash
+      [created, district, high_grade, id, last_modified, location, low_grade, mdr_number, name, nces_id, phone, principal, school_number, sis_id, state_id].hash
     end
 
     # Builds the object from hash

data/lib/clever-ruby/models/school_admin.rb

@@ -14,12 +14,14 @@ require 'date'
 module Clever
 
   class SchoolAdmin
-    attr_accessor :id
+    attr_accessor :credentials
 
     attr_accessor :district
 
     attr_accessor :email
 
+    attr_accessor :id
+
     attr_accessor :name
 
     attr_accessor :schools
@@ -32,9 +34,10 @@ module Clever
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
+        :'credentials' => :'credentials',
         :'district' => :'district',
         :'email' => :'email',
+        :'id' => :'id',
         :'name' => :'name',
         :'schools' => :'schools',
         :'staff_id' => :'staff_id',
@@ -45,9 +48,10 @@ module Clever
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
+        :'credentials' => :'Credentials',
         :'district' => :'String',
         :'email' => :'String',
+        :'id' => :'String',
         :'name' => :'Name',
         :'schools' => :'Array<String>',
         :'staff_id' => :'String',
@@ -63,8 +67,8 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.has_key?(:'credentials')
+        self.credentials = attributes[:'credentials']
       end
 
       if attributes.has_key?(:'district')
@@ -75,6 +79,10 @@ module Clever
         self.email = attributes[:'email']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -113,9 +121,10 @@ module Clever
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
+          credentials == o.credentials &&
           district == o.district &&
           email == o.email &&
+          id == o.id &&
           name == o.name &&
           schools == o.schools &&
           staff_id == o.staff_id &&
@@ -131,7 +140,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, district, email, name, schools, staff_id, title].hash
+      [credentials, district, email, id, name, schools, staff_id, title].hash
     end
 
     # Builds the object from hash

data/lib/clever-ruby/models/section.rb

@@ -14,8 +14,6 @@ require 'date'
 module Clever
 
   class Section
-    attr_accessor :id
-
     attr_accessor :course_description
 
     attr_accessor :course_name
@@ -28,6 +26,8 @@ module Clever
 
     attr_accessor :grade
 
+    attr_accessor :id
+
     attr_accessor :last_modified
 
     attr_accessor :name
@@ -50,17 +50,38 @@ module Clever
 
     attr_accessor :term
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
         :'course_description' => :'course_description',
         :'course_name' => :'course_name',
         :'course_number' => :'course_number',
         :'created' => :'created',
         :'district' => :'district',
         :'grade' => :'grade',
+        :'id' => :'id',
         :'last_modified' => :'last_modified',
         :'name' => :'name',
         :'period' => :'period',
@@ -78,13 +99,13 @@ module Clever
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
         :'course_description' => :'String',
         :'course_name' => :'String',
         :'course_number' => :'String',
         :'created' => :'String',
         :'district' => :'String',
         :'grade' => :'String',
+        :'id' => :'String',
         :'last_modified' => :'String',
         :'name' => :'String',
         :'period' => :'String',
@@ -107,10 +128,6 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.has_key?(:'course_description')
         self.course_description = attributes[:'course_description']
       end
@@ -135,6 +152,10 @@ module Clever
         self.grade = attributes[:'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
@@ -195,21 +216,45 @@ module Clever
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      grade_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      return false unless grade_validator.valid?(@grade)
+      subject_validator = EnumAttributeValidator.new('String', ["english/language arts", "math", "science", "social studies", "language", "homeroom/advisory", "interventions/online learning", "technology and engineering", "PE and health", "arts and music", "other"])
+      return false unless subject_validator.valid?(@subject)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] grade Object to be assigned
+    def grade=(grade)
+      validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      unless validator.valid?(grade)
+        fail ArgumentError, "invalid value for 'grade', must be one of #{validator.allowable_values}."
+      end
+      @grade = grade
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] subject Object to be assigned
+    def subject=(subject)
+      validator = EnumAttributeValidator.new('String', ["english/language arts", "math", "science", "social studies", "language", "homeroom/advisory", "interventions/online learning", "technology and engineering", "PE and health", "arts and music", "other"])
+      unless validator.valid?(subject)
+        fail ArgumentError, "invalid value for 'subject', must be one of #{validator.allowable_values}."
+      end
+      @subject = subject
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
           course_description == o.course_description &&
           course_name == o.course_name &&
           course_number == o.course_number &&
           created == o.created &&
           district == o.district &&
           grade == o.grade &&
+          id == o.id &&
           last_modified == o.last_modified &&
           name == o.name &&
           period == o.period &&
@@ -232,7 +277,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, course_description, course_name, course_number, created, district, grade, last_modified, name, period, school, section_number, sis_id, students, subject, teacher, teachers, term].hash
+      [course_description, course_name, course_number, created, district, grade, id, last_modified, name, period, school, section_number, sis_id, students, subject, teacher, teachers, term].hash
     end
 
     # Builds the object from hash

data/lib/clever-ruby/models/student.rb

@@ -14,10 +14,10 @@ require 'date'
 module Clever
 
   class Student
-    attr_accessor :id
-
     attr_accessor :created
 
+    attr_accessor :credentials
+
     attr_accessor :district
 
     attr_accessor :dob
@@ -26,14 +26,14 @@ module Clever
 
     attr_accessor :email
 
-    attr_accessor :frl_status
-
     attr_accessor :gender
 
     attr_accessor :grade
 
     attr_accessor :hispanic_ethnicity
 
+    attr_accessor :id
+
     attr_accessor :iep_status
 
     attr_accessor :last_modified
@@ -54,20 +54,41 @@ module Clever
 
     attr_accessor :student_number
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
         :'created' => :'created',
+        :'credentials' => :'credentials',
         :'district' => :'district',
         :'dob' => :'dob',
         :'ell_status' => :'ell_status',
         :'email' => :'email',
-        :'frl_status' => :'frl_status',
         :'gender' => :'gender',
         :'grade' => :'grade',
         :'hispanic_ethnicity' => :'hispanic_ethnicity',
+        :'id' => :'id',
         :'iep_status' => :'iep_status',
         :'last_modified' => :'last_modified',
         :'location' => :'location',
@@ -84,16 +105,16 @@ module Clever
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
         :'created' => :'String',
+        :'credentials' => :'Credentials',
         :'district' => :'String',
         :'dob' => :'String',
         :'ell_status' => :'String',
         :'email' => :'String',
-        :'frl_status' => :'String',
         :'gender' => :'String',
         :'grade' => :'String',
         :'hispanic_ethnicity' => :'String',
+        :'id' => :'String',
         :'iep_status' => :'String',
         :'last_modified' => :'String',
         :'location' => :'Location',
@@ -115,14 +136,14 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.has_key?(:'created')
         self.created = attributes[:'created']
       end
 
+      if attributes.has_key?(:'credentials')
+        self.credentials = attributes[:'credentials']
+      end
+
       if attributes.has_key?(:'district')
         self.district = attributes[:'district']
       end
@@ -139,10 +160,6 @@ module Clever
         self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'frl_status')
-        self.frl_status = attributes[:'frl_status']
-      end
-
       if attributes.has_key?(:'gender')
         self.gender = attributes[:'gender']
       end
@@ -155,6 +172,10 @@ module Clever
         self.hispanic_ethnicity = attributes[:'hispanic_ethnicity']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'iep_status')
         self.iep_status = attributes[:'iep_status']
       end
@@ -209,24 +230,84 @@ module Clever
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      ell_status_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
+      return false unless ell_status_validator.valid?(@ell_status)
+      gender_validator = EnumAttributeValidator.new('String', ["M", "F", ""])
+      return false unless gender_validator.valid?(@gender)
+      grade_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      return false unless grade_validator.valid?(@grade)
+      hispanic_ethnicity_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
+      return false unless hispanic_ethnicity_validator.valid?(@hispanic_ethnicity)
+      race_validator = EnumAttributeValidator.new('String', ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races", "Unknown", ""])
+      return false unless race_validator.valid?(@race)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ell_status Object to be assigned
+    def ell_status=(ell_status)
+      validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
+      unless validator.valid?(ell_status)
+        fail ArgumentError, "invalid value for 'ell_status', must be one of #{validator.allowable_values}."
+      end
+      @ell_status = ell_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] gender Object to be assigned
+    def gender=(gender)
+      validator = EnumAttributeValidator.new('String', ["M", "F", ""])
+      unless validator.valid?(gender)
+        fail ArgumentError, "invalid value for 'gender', must be one of #{validator.allowable_values}."
+      end
+      @gender = gender
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] grade Object to be assigned
+    def grade=(grade)
+      validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
+      unless validator.valid?(grade)
+        fail ArgumentError, "invalid value for 'grade', must be one of #{validator.allowable_values}."
+      end
+      @grade = grade
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] hispanic_ethnicity Object to be assigned
+    def hispanic_ethnicity=(hispanic_ethnicity)
+      validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
+      unless validator.valid?(hispanic_ethnicity)
+        fail ArgumentError, "invalid value for 'hispanic_ethnicity', must be one of #{validator.allowable_values}."
+      end
+      @hispanic_ethnicity = hispanic_ethnicity
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] race Object to be assigned
+    def race=(race)
+      validator = EnumAttributeValidator.new('String', ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races", "Unknown", ""])
+      unless validator.valid?(race)
+        fail ArgumentError, "invalid value for 'race', must be one of #{validator.allowable_values}."
+      end
+      @race = race
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
           created == o.created &&
+          credentials == o.credentials &&
           district == o.district &&
           dob == o.dob &&
           ell_status == o.ell_status &&
           email == o.email &&
-          frl_status == o.frl_status &&
           gender == o.gender &&
           grade == o.grade &&
           hispanic_ethnicity == o.hispanic_ethnicity &&
+          id == o.id &&
           iep_status == o.iep_status &&
           last_modified == o.last_modified &&
           location == o.location &&
@@ -248,7 +329,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, created, district, dob, ell_status, email, frl_status, gender, grade, hispanic_ethnicity, iep_status, last_modified, location, name, race, school, schools, sis_id, state_id, student_number].hash
+      [created, credentials, district, dob, ell_status, email, gender, grade, hispanic_ethnicity, id, iep_status, last_modified, location, name, race, school, schools, sis_id, state_id, student_number].hash
     end
 
     # Builds the object from hash