commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta2

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

@@ -1,53 +1,67 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
 require 'date'
 
 module Clever
   class Principal
-    attr_accessor :name
-
     attr_accessor :email
 
+    attr_accessor :name
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
-        :'email' => :'email'
+        :'email' => :'email',
+        :'name' => :'name'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'name' => :'String',
-        :'email' => :'String'
+        :'email' => :'Object',
+        :'name' => :'Object'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'email',
+        :'name'
+      ])
+    end
+  
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Clever::Principal` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `Clever::Principal`. 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.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'email')
-        self.email = attributes[:'email']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
     end
 
@@ -69,8 +83,8 @@ module Clever
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
-          email == o.email
+          email == o.email &&
+          name == o.name
     end
 
     # @see the `==` method
@@ -80,9 +94,16 @@ module Clever
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [name, email].hash
+      [email, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
@@ -90,7 +111,7 @@ module Clever
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      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
@@ -99,7 +120,9 @@ module Clever
           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
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
       end
 
       self
@@ -121,7 +144,7 @@ module Clever
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -142,8 +165,7 @@ module Clever
           end
         end
       else # model
-        temp_model = Clever.const_get(type).new
-        temp_model.build_from_hash(value)
+        Clever.const_get(type).build_from_hash(value)
       end
     end
 
@@ -165,7 +187,11 @@ module Clever
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -187,7 +213,5 @@ module Clever
       else
         value
       end
-    end
-
-  end
+    end  end
 end

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

@@ -1,33 +1,36 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
 require 'date'
 
 module Clever
   class School
-    attr_accessor :id
-
     attr_accessor :created
 
     attr_accessor :district
 
+    attr_accessor :ext
+
     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,10 +45,6 @@ module Clever
 
     attr_accessor :state_id
 
-    attr_accessor :mdr_number
-
-    attr_accessor :ext
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -71,118 +70,137 @@ module Clever
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
         :'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',
-        :'mdr_number' => :'mdr_number',
-        :'ext' => :'ext'
+        :'state_id' => :'state_id'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'id' => :'String',
-        :'created' => :'String',
-        :'district' => :'String',
-        :'high_grade' => :'String',
-        :'last_modified' => :'String',
-        :'location' => :'Location',
-        :'low_grade' => :'String',
-        :'name' => :'String',
-        :'nces_id' => :'String',
-        :'phone' => :'String',
-        :'principal' => :'Principal',
-        :'school_number' => :'String',
-        :'sis_id' => :'String',
-        :'state_id' => :'String',
-        :'mdr_number' => :'String',
-        :'ext' => :'Object'
+        :'created' => :'Object',
+        :'district' => :'Object',
+        :'ext' => :'Object',
+        :'high_grade' => :'Object',
+        :'id' => :'Object',
+        :'last_modified' => :'Object',
+        :'location' => :'Object',
+        :'low_grade' => :'Object',
+        :'mdr_number' => :'Object',
+        :'name' => :'Object',
+        :'nces_id' => :'Object',
+        :'phone' => :'Object',
+        :'principal' => :'Object',
+        :'school_number' => :'Object',
+        :'sis_id' => :'Object',
+        :'state_id' => :'Object'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'high_grade',
+        :'low_grade',
+        :'mdr_number',
+        :'nces_id',
+        :'phone',
+        :'state_id'
+      ])
+    end
+  
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     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?(:'id')
-        self.id = attributes[:'id']
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Clever::School` initialize method"
       end
 
-      if attributes.has_key?(:'created')
+      # 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 `Clever::School`. 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?(:'created')
         self.created = attributes[:'created']
       end
 
-      if attributes.has_key?(:'district')
+      if attributes.key?(:'district')
         self.district = attributes[:'district']
       end
 
-      if attributes.has_key?(:'high_grade')
+      if attributes.key?(:'ext')
+        self.ext = attributes[:'ext']
+      end
+
+      if attributes.key?(:'high_grade')
         self.high_grade = attributes[:'high_grade']
       end
 
-      if attributes.has_key?(:'last_modified')
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'last_modified')
         self.last_modified = attributes[:'last_modified']
       end
 
-      if attributes.has_key?(:'location')
+      if attributes.key?(:'location')
         self.location = attributes[:'location']
       end
 
-      if attributes.has_key?(:'low_grade')
+      if attributes.key?(:'low_grade')
         self.low_grade = attributes[:'low_grade']
       end
 
-      if attributes.has_key?(:'name')
+      if attributes.key?(:'mdr_number')
+        self.mdr_number = attributes[:'mdr_number']
+      end
+
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'nces_id')
+      if attributes.key?(:'nces_id')
         self.nces_id = attributes[:'nces_id']
       end
 
-      if attributes.has_key?(:'phone')
+      if attributes.key?(:'phone')
         self.phone = attributes[:'phone']
       end
 
-      if attributes.has_key?(:'principal')
+      if attributes.key?(:'principal')
         self.principal = attributes[:'principal']
       end
 
-      if attributes.has_key?(:'school_number')
+      if attributes.key?(:'school_number')
         self.school_number = attributes[:'school_number']
       end
 
-      if attributes.has_key?(:'sis_id')
+      if attributes.key?(:'sis_id')
         self.sis_id = attributes[:'sis_id']
       end
 
-      if attributes.has_key?(:'state_id')
+      if attributes.key?(:'state_id')
         self.state_id = attributes[:'state_id']
       end
-
-      if attributes.has_key?(:'mdr_number')
-        self.mdr_number = attributes[:'mdr_number']
-      end
-
-      if attributes.has_key?(:'ext')
-        self.ext = attributes[:'ext']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -195,9 +213,9 @@ 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', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
+      high_grade_validator = EnumAttributeValidator.new('Object', ['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', ''])
+      low_grade_validator = EnumAttributeValidator.new('Object', ['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
@@ -205,9 +223,9 @@ module Clever
     # 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', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
+      validator = EnumAttributeValidator.new('Object', ['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}.'
+        fail ArgumentError, "invalid value for \"high_grade\", must be one of #{validator.allowable_values}."
       end
       @high_grade = high_grade
     end
@@ -215,9 +233,9 @@ module Clever
     # 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', ['InfantToddler', 'Preschool', 'PreKindergarten', 'TransitionalKindergarten', 'Kindergarten', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', 'PostGraduate', 'Ungraded', 'Other', ''])
+      validator = EnumAttributeValidator.new('Object', ['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}.'
+        fail ArgumentError, "invalid value for \"low_grade\", must be one of #{validator.allowable_values}."
       end
       @low_grade = low_grade
     end
@@ -227,22 +245,22 @@ module Clever
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
           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 &&
-          mdr_number == o.mdr_number &&
-          ext == o.ext
+          state_id == o.state_id
     end
 
     # @see the `==` method
@@ -252,9 +270,16 @@ module Clever
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] 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, ext].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
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
@@ -262,7 +287,7 @@ module Clever
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      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
@@ -271,7 +296,9 @@ module Clever
           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
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
       end
 
       self
@@ -293,7 +320,7 @@ module Clever
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -314,8 +341,7 @@ module Clever
           end
         end
       else # model
-        temp_model = Clever.const_get(type).new
-        temp_model.build_from_hash(value)
+        Clever.const_get(type).build_from_hash(value)
       end
     end
 
@@ -337,7 +363,11 @@ module Clever
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -359,7 +389,5 @@ module Clever
       else
         value
       end
-    end
-
-  end
+    end  end
 end