clever-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4ab7eecb3756666bb0144d9b64011e9cd0879bb
-  data.tar.gz: caed6286d2eaec9c705220a1492ee2813e4373b6
+  metadata.gz: fb13134e4c737626ca779e9b969952f36b717b6d
+  data.tar.gz: 1fc016660cc048e3a5e113db52e69dda26d5969c
 SHA512:
-  metadata.gz: bd012a3d4d3d5b55128b9449e3df053cc96d9fd81c5cf56177c959f11cb4e2772c8ab135c6830b90586e273d5bcad218e308f9733f37c4e03943b8ec2bac0857
-  data.tar.gz: 06a817069a54008b2f1f1207516dc6e5f766ddbc650de71d3ae181643938d90d2a88c2cbc29d862942e92283922f2821ee75ab8335f972090a1232071e293eca
+  metadata.gz: 7e4e7d39ad3746223fbe25d506397a852c804f99490b72292bdf696809d952ce0a2795ef4ef447128b9c54dfca2bdf4a0700a013de836d8cb609debf9b7c8278
+  data.tar.gz: cd498759b72f69e2be00a47d7ae7ccea137dde13d69c25523831b0fdce3f9ec097c7533bca10366627ce0cc3a33626ac30a447ca4de8de5b922db5d11d3e30bd

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.2.0 (2017-06-09)
+
+* Added new fields for students and student contacts
+* Fixed district status endpoint
+
 ## 1.1.0 (2017-05-02)
 
 * Added support for enums

data/README.md

@@ -7,7 +7,7 @@ The Clever API
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.2.0
-- Package version: 1.0.0
+- Package version: 1.2.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build clever-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./clever-ruby-1.0.0.gem
+gem install ./clever-ruby-1.2.0.gem
 ```
-(for development, run `gem install --dev ./clever-ruby-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./clever-ruby-1.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'clever-ruby', '~> 1.0.0'
+    gem 'clever-ruby', '~> 1.2.0'
 
 ### Install from Git
 
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
  - [Clever::DistrictResponse](docs/DistrictResponse.md)
  - [Clever::DistrictStatus](docs/DistrictStatus.md)
  - [Clever::DistrictStatusResponse](docs/DistrictStatusResponse.md)
+ - [Clever::DistrictStatusResponses](docs/DistrictStatusResponses.md)
  - [Clever::DistrictsCreated](docs/DistrictsCreated.md)
  - [Clever::DistrictsDeleted](docs/DistrictsDeleted.md)
  - [Clever::DistrictsResponse](docs/DistrictsResponse.md)

data/docs/DataApi.md

@@ -619,7 +619,7 @@ Name | Type | Description  | Notes
 
 
 # **get_district_status**
-> DistrictStatusResponse get_district_status(id)
+> DistrictStatusResponses get_district_status(id)
 
 
 
@@ -656,7 +656,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**DistrictStatusResponse**](DistrictStatusResponse.md)
+[**DistrictStatusResponses**](DistrictStatusResponses.md)
 
 ### Authorization
 

data/docs/DistrictStatusResponses.md

@@ -0,0 +1,8 @@
+# Clever::DistrictStatusResponses
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DistrictStatusResponse>**](DistrictStatusResponse.md) |  | [optional] 
+
+

data/docs/Student.md

@@ -11,7 +11,9 @@ Name | Type | Description | Notes
 **email** | **String** |  | [optional] 
 **gender** | **String** |  | [optional] 
 **grade** | **String** |  | [optional] 
+**graduation_year** | **String** |  | [optional] 
 **hispanic_ethnicity** | **String** |  | [optional] 
+**home_language** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
 **iep_status** | **String** |  | [optional] 
 **last_modified** | **String** |  | [optional] 
@@ -23,5 +25,7 @@ Name | Type | Description | Notes
 **sis_id** | **String** |  | [optional] 
 **state_id** | **String** |  | [optional] 
 **student_number** | **String** |  | [optional] 
+**unweighted_gpa** | **String** |  | [optional] 
+**weighted_gpa** | **String** |  | [optional] 
 
 

data/docs/StudentContact.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **phone** | **String** |  | [optional] 
 **phone_type** | **String** |  | [optional] 
 **relationship** | **String** |  | [optional] 
+**sis_id** | **String** |  | [optional] 
 **student** | **String** |  | [optional] 
 **type** | **String** |  | [optional] 
 

data/lib/clever-ruby.rb

@@ -26,6 +26,7 @@ require 'clever-ruby/models/district_object'
 require 'clever-ruby/models/district_response'
 require 'clever-ruby/models/district_status'
 require 'clever-ruby/models/district_status_response'
+require 'clever-ruby/models/district_status_responses'
 require 'clever-ruby/models/districts_created'
 require 'clever-ruby/models/districts_deleted'
 require 'clever-ruby/models/districts_response'

data/lib/clever-ruby/api/data_api.rb

@@ -594,7 +594,7 @@ module Clever
     # Returns the status of the district
     # @param id 
     # @param [Hash] opts the optional parameters
-    # @return [DistrictStatusResponse]
+    # @return [DistrictStatusResponses]
     def get_district_status(id, opts = {})
       data, _status_code, _headers = get_district_status_with_http_info(id, opts)
       return data
@@ -604,7 +604,7 @@ module Clever
     # Returns the status of the district
     # @param id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(DistrictStatusResponse, Fixnum, Hash)>] DistrictStatusResponse data, response status code and response headers
+    # @return [Array<(DistrictStatusResponses, Fixnum, Hash)>] DistrictStatusResponses data, response status code and response headers
     def get_district_status_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: DataApi.get_district_status ..."
@@ -634,7 +634,7 @@ module Clever
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'DistrictStatusResponse')
+        :return_type => 'DistrictStatusResponses')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DataApi#get_district_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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

@@ -0,0 +1,189 @@
+=begin
+#Clever API
+
+#The Clever API
+
+OpenAPI spec version: 1.2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module Clever
+
+  class DistrictStatusResponses
+    attr_accessor :data
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data' => :'Array<DistrictStatusResponse>'
+      }
+    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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    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 &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @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|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

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

@@ -30,8 +30,12 @@ module Clever
 
     attr_accessor :grade
 
+    attr_accessor :graduation_year
+
     attr_accessor :hispanic_ethnicity
 
+    attr_accessor :home_language
+
     attr_accessor :id
 
     attr_accessor :iep_status
@@ -54,6 +58,10 @@ module Clever
 
     attr_accessor :student_number
 
+    attr_accessor :unweighted_gpa
+
+    attr_accessor :weighted_gpa
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -87,7 +95,9 @@ module Clever
         :'email' => :'email',
         :'gender' => :'gender',
         :'grade' => :'grade',
+        :'graduation_year' => :'graduation_year',
         :'hispanic_ethnicity' => :'hispanic_ethnicity',
+        :'home_language' => :'home_language',
         :'id' => :'id',
         :'iep_status' => :'iep_status',
         :'last_modified' => :'last_modified',
@@ -98,7 +108,9 @@ module Clever
         :'schools' => :'schools',
         :'sis_id' => :'sis_id',
         :'state_id' => :'state_id',
-        :'student_number' => :'student_number'
+        :'student_number' => :'student_number',
+        :'unweighted_gpa' => :'unweighted_gpa',
+        :'weighted_gpa' => :'weighted_gpa'
       }
     end
 
@@ -113,7 +125,9 @@ module Clever
         :'email' => :'String',
         :'gender' => :'String',
         :'grade' => :'String',
+        :'graduation_year' => :'String',
         :'hispanic_ethnicity' => :'String',
+        :'home_language' => :'String',
         :'id' => :'String',
         :'iep_status' => :'String',
         :'last_modified' => :'String',
@@ -124,7 +138,9 @@ module Clever
         :'schools' => :'Array<String>',
         :'sis_id' => :'String',
         :'state_id' => :'String',
-        :'student_number' => :'String'
+        :'student_number' => :'String',
+        :'unweighted_gpa' => :'String',
+        :'weighted_gpa' => :'String'
       }
     end
 
@@ -168,10 +184,18 @@ module Clever
         self.grade = attributes[:'grade']
       end
 
+      if attributes.has_key?(:'graduation_year')
+        self.graduation_year = attributes[:'graduation_year']
+      end
+
       if attributes.has_key?(:'hispanic_ethnicity')
         self.hispanic_ethnicity = attributes[:'hispanic_ethnicity']
       end
 
+      if attributes.has_key?(:'home_language')
+        self.home_language = attributes[:'home_language']
+      end
+
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -218,6 +242,14 @@ module Clever
         self.student_number = attributes[:'student_number']
       end
 
+      if attributes.has_key?(:'unweighted_gpa')
+        self.unweighted_gpa = attributes[:'unweighted_gpa']
+      end
+
+      if attributes.has_key?(:'weighted_gpa')
+        self.weighted_gpa = attributes[:'weighted_gpa']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -238,6 +270,8 @@ module Clever
       return false unless grade_validator.valid?(@grade)
       hispanic_ethnicity_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
       return false unless hispanic_ethnicity_validator.valid?(@hispanic_ethnicity)
+      home_language_validator = EnumAttributeValidator.new('String', ["English", "Albanian", "Amharic", "Arabic", "Bengali", "Bosnian", "Burmese", "Cantonese", "Chinese", "Dutch", "Farsi", "French", "German", "Hebrew", "Hindi", "Hmong", "Ilocano", "Japanese", "Javanese", "Karen", "Khmer", "Korean", "Laotian", "Latvian", "Malay", "Mandarin", "Nepali", "Oromo", "Polish", "Portuguese", "Punjabi", "Romanian", "Russian", "Samoan", "Serbian", "Somali", "Spanish", "Swahili", "Tagalog", "Tamil", "Telegu", "Thai", "Tigrinya", "Turkish", "Ukrainian", "Urdu", "Vietnamese"])
+      return false unless home_language_validator.valid?(@home_language)
       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
@@ -283,6 +317,16 @@ module Clever
       @hispanic_ethnicity = hispanic_ethnicity
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] home_language Object to be assigned
+    def home_language=(home_language)
+      validator = EnumAttributeValidator.new('String', ["English", "Albanian", "Amharic", "Arabic", "Bengali", "Bosnian", "Burmese", "Cantonese", "Chinese", "Dutch", "Farsi", "French", "German", "Hebrew", "Hindi", "Hmong", "Ilocano", "Japanese", "Javanese", "Karen", "Khmer", "Korean", "Laotian", "Latvian", "Malay", "Mandarin", "Nepali", "Oromo", "Polish", "Portuguese", "Punjabi", "Romanian", "Russian", "Samoan", "Serbian", "Somali", "Spanish", "Swahili", "Tagalog", "Tamil", "Telegu", "Thai", "Tigrinya", "Turkish", "Ukrainian", "Urdu", "Vietnamese"])
+      unless validator.valid?(home_language)
+        fail ArgumentError, "invalid value for 'home_language', must be one of #{validator.allowable_values}."
+      end
+      @home_language = home_language
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] race Object to be assigned
     def race=(race)
@@ -306,7 +350,9 @@ module Clever
           email == o.email &&
           gender == o.gender &&
           grade == o.grade &&
+          graduation_year == o.graduation_year &&
           hispanic_ethnicity == o.hispanic_ethnicity &&
+          home_language == o.home_language &&
           id == o.id &&
           iep_status == o.iep_status &&
           last_modified == o.last_modified &&
@@ -317,7 +363,9 @@ module Clever
           schools == o.schools &&
           sis_id == o.sis_id &&
           state_id == o.state_id &&
-          student_number == o.student_number
+          student_number == o.student_number &&
+          unweighted_gpa == o.unweighted_gpa &&
+          weighted_gpa == o.weighted_gpa
     end
 
     # @see the `==` method
@@ -329,7 +377,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def 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
+      [created, credentials, district, dob, ell_status, email, gender, grade, graduation_year, hispanic_ethnicity, home_language, id, iep_status, last_modified, location, name, race, school, schools, sis_id, state_id, student_number, unweighted_gpa, weighted_gpa].hash
     end
 
     # Builds the object from hash

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

@@ -28,6 +28,8 @@ module Clever
 
     attr_accessor :relationship
 
+    attr_accessor :sis_id
+
     attr_accessor :student
 
     attr_accessor :type
@@ -43,6 +45,7 @@ module Clever
         :'phone' => :'phone',
         :'phone_type' => :'phone_type',
         :'relationship' => :'relationship',
+        :'sis_id' => :'sis_id',
         :'student' => :'student',
         :'type' => :'type'
       }
@@ -58,6 +61,7 @@ module Clever
         :'phone' => :'String',
         :'phone_type' => :'String',
         :'relationship' => :'String',
+        :'sis_id' => :'String',
         :'student' => :'String',
         :'type' => :'String'
       }
@@ -99,6 +103,10 @@ module Clever
         self.relationship = attributes[:'relationship']
       end
 
+      if attributes.has_key?(:'sis_id')
+        self.sis_id = attributes[:'sis_id']
+      end
+
       if attributes.has_key?(:'student')
         self.student = attributes[:'student']
       end
@@ -134,6 +142,7 @@ module Clever
           phone == o.phone &&
           phone_type == o.phone_type &&
           relationship == o.relationship &&
+          sis_id == o.sis_id &&
           student == o.student &&
           type == o.type
     end
@@ -147,7 +156,7 @@ module Clever
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [district, email, id, name, phone, phone_type, relationship, student, type].hash
+      [district, email, id, name, phone, phone_type, relationship, sis_id, student, type].hash
     end
 
     # Builds the object from hash

data/lib/clever-ruby/version.rb

@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module Clever
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/override/config.json

@@ -1,5 +1,5 @@
 {
    "gemName": "clever-ruby",
    "moduleName": "Clever",
-   "gemVersion": "1.1.0"
+   "gemVersion": "1.2.0"
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Swagger-Codegen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -217,6 +217,7 @@ files:
 - docs/DistrictResponse.md
 - docs/DistrictStatus.md
 - docs/DistrictStatusResponse.md
+- docs/DistrictStatusResponses.md
 - docs/DistrictsCreated.md
 - docs/DistrictsDeleted.md
 - docs/DistrictsResponse.md
@@ -291,6 +292,7 @@ files:
 - lib/clever-ruby/models/district_response.rb
 - lib/clever-ruby/models/district_status.rb
 - lib/clever-ruby/models/district_status_response.rb
+- lib/clever-ruby/models/district_status_responses.rb
 - lib/clever-ruby/models/districts_created.rb
 - lib/clever-ruby/models/districts_deleted.rb
 - lib/clever-ruby/models/districts_response.rb