flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/assignment_submission.rb

@@ -1,23 +1,26 @@
 =begin
 #Flat API
 
-#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
+#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
 
-OpenAPI spec version: 2.6.0
+The version of the OpenAPI document: 2.26.1
 Contact: developers@flat.io
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
 
 =end
 
 require 'date'
+require 'time'
 
 module FlatApi
   # Assignment Submission
-  class AssignmentSubmission
+  class AssignmentSubmission < ApiModelBase
     # Unique identifier of the submission
     attr_accessor :id
 
+    attr_accessor :state
+
     # Unique identifier of the classroom where the assignment was posted 
     attr_accessor :classroom
 
@@ -32,131 +35,392 @@ module FlatApi
 
     attr_accessor :attachments
 
-    # The date when the student submitted his work
+    # The date when the student submitted their work
     attr_accessor :submission_date
 
-    # An optionnal comment sent by the student when submitting his work 
-    attr_accessor :student_comment
-
     # The date when the teacher returned the work
     attr_accessor :return_date
 
-    # The feedback associated with the return
-    attr_accessor :return_feedback
-
     # The User unique identifier of the teacher who returned the submission 
     attr_accessor :return_creator
 
+    # Optional grade. If unset, no grade was set.
+    attr_accessor :grade
+
+    # Optional grade. If unset, no grade was set. This value is only visible by the teacher, and we will be set to `grade` once the teacher returns the submission
+    attr_accessor :draft_grade
+
+    # Optional max points for the grade. If set, a corresponding `draftGrade` or `grade` will be set.
+    attr_accessor :max_points
+
+    # The ids of exercises when they need to be in a specific order
+    attr_accessor :exercises_ids
+
+    attr_accessor :playback
+
+    attr_accessor :comments
+
     attr_accessor :google_classroom
 
+    attr_accessor :microsoft_graph
+
+    attr_accessor :lti
+
+    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',
+        :'state' => :'state',
         :'classroom' => :'classroom',
         :'assignment' => :'assignment',
         :'creator' => :'creator',
         :'creation_date' => :'creationDate',
         :'attachments' => :'attachments',
         :'submission_date' => :'submissionDate',
-        :'student_comment' => :'studentComment',
         :'return_date' => :'returnDate',
-        :'return_feedback' => :'returnFeedback',
         :'return_creator' => :'returnCreator',
-        :'google_classroom' => :'googleClassroom'
+        :'grade' => :'grade',
+        :'draft_grade' => :'draftGrade',
+        :'max_points' => :'maxPoints',
+        :'exercises_ids' => :'exercisesIds',
+        :'playback' => :'playback',
+        :'comments' => :'comments',
+        :'google_classroom' => :'googleClassroom',
+        :'microsoft_graph' => :'microsoftGraph',
+        :'lti' => :'lti'
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'id' => :'String',
+        :'state' => :'AssignmentSubmissionState',
         :'classroom' => :'String',
         :'assignment' => :'String',
         :'creator' => :'String',
         :'creation_date' => :'String',
         :'attachments' => :'Array<MediaAttachment>',
         :'submission_date' => :'String',
-        :'student_comment' => :'String',
         :'return_date' => :'String',
-        :'return_feedback' => :'String',
         :'return_creator' => :'String',
-        :'google_classroom' => :'GoogleClassroomSubmission'
+        :'grade' => :'Float',
+        :'draft_grade' => :'Float',
+        :'max_points' => :'Float',
+        :'exercises_ids' => :'Array<String>',
+        :'playback' => :'Array<AssignmentSubmissionPlayback>',
+        :'comments' => :'AssignmentSubmissionComments',
+        :'google_classroom' => :'GoogleClassroomSubmission',
+        :'microsoft_graph' => :'MicrosoftGraphSubmission',
+        :'lti' => :'AssignmentSubmissionLti'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'grade',
+        :'draft_grade',
+      ])
+    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 `FlatApi::AssignmentSubmission` 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
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::AssignmentSubmission`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
-      if attributes.has_key?(:'classroom')
+      if attributes.key?(:'classroom')
         self.classroom = attributes[:'classroom']
+      else
+        self.classroom = nil
       end
 
-      if attributes.has_key?(:'assignment')
+      if attributes.key?(:'assignment')
         self.assignment = attributes[:'assignment']
+      else
+        self.assignment = nil
       end
 
-      if attributes.has_key?(:'creator')
+      if attributes.key?(:'creator')
         self.creator = attributes[:'creator']
+      else
+        self.creator = nil
       end
 
-      if attributes.has_key?(:'creationDate')
-        self.creation_date = attributes[:'creationDate']
+      if attributes.key?(:'creation_date')
+        self.creation_date = attributes[:'creation_date']
+      else
+        self.creation_date = nil
       end
 
-      if attributes.has_key?(:'attachments')
+      if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
         end
+      else
+        self.attachments = nil
+      end
+
+      if attributes.key?(:'submission_date')
+        self.submission_date = attributes[:'submission_date']
+      end
+
+      if attributes.key?(:'return_date')
+        self.return_date = attributes[:'return_date']
+      end
+
+      if attributes.key?(:'return_creator')
+        self.return_creator = attributes[:'return_creator']
       end
 
-      if attributes.has_key?(:'submissionDate')
-        self.submission_date = attributes[:'submissionDate']
+      if attributes.key?(:'grade')
+        self.grade = attributes[:'grade']
       end
 
-      if attributes.has_key?(:'studentComment')
-        self.student_comment = attributes[:'studentComment']
+      if attributes.key?(:'draft_grade')
+        self.draft_grade = attributes[:'draft_grade']
       end
 
-      if attributes.has_key?(:'returnDate')
-        self.return_date = attributes[:'returnDate']
+      if attributes.key?(:'max_points')
+        self.max_points = attributes[:'max_points']
       end
 
-      if attributes.has_key?(:'returnFeedback')
-        self.return_feedback = attributes[:'returnFeedback']
+      if attributes.key?(:'exercises_ids')
+        if (value = attributes[:'exercises_ids']).is_a?(Array)
+          self.exercises_ids = value
+        end
       end
 
-      if attributes.has_key?(:'returnCreator')
-        self.return_creator = attributes[:'returnCreator']
+      if attributes.key?(:'playback')
+        if (value = attributes[:'playback']).is_a?(Array)
+          self.playback = value
+        end
+      else
+        self.playback = nil
       end
 
-      if attributes.has_key?(:'googleClassroom')
-        self.google_classroom = attributes[:'googleClassroom']
+      if attributes.key?(:'comments')
+        self.comments = attributes[:'comments']
+      else
+        self.comments = nil
       end
 
+      if attributes.key?(:'google_classroom')
+        self.google_classroom = attributes[:'google_classroom']
+      end
+
+      if attributes.key?(:'microsoft_graph')
+        self.microsoft_graph = attributes[:'microsoft_graph']
+      end
+
+      if attributes.key?(:'lti')
+        self.lti = attributes[:'lti']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      return invalid_properties
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @classroom.nil?
+        invalid_properties.push('invalid value for "classroom", classroom cannot be nil.')
+      end
+
+      if @assignment.nil?
+        invalid_properties.push('invalid value for "assignment", assignment cannot be nil.')
+      end
+
+      if @creator.nil?
+        invalid_properties.push('invalid value for "creator", creator cannot be nil.')
+      end
+
+      if @creation_date.nil?
+        invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
+      end
+
+      if @attachments.nil?
+        invalid_properties.push('invalid value for "attachments", attachments cannot be nil.')
+      end
+
+      if @playback.nil?
+        invalid_properties.push('invalid value for "playback", playback cannot be nil.')
+      end
+
+      if @comments.nil?
+        invalid_properties.push('invalid value for "comments", comments cannot be nil.')
+      end
+
+      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
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @state.nil?
+      return false if @classroom.nil?
+      return false if @assignment.nil?
+      return false if @creator.nil?
+      return false if @creation_date.nil?
+      return false if @attachments.nil?
+      return false if @playback.nil?
+      return false if @comments.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] classroom Value to be assigned
+    def classroom=(classroom)
+      if classroom.nil?
+        fail ArgumentError, 'classroom cannot be nil'
+      end
+
+      @classroom = classroom
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] assignment Value to be assigned
+    def assignment=(assignment)
+      if assignment.nil?
+        fail ArgumentError, 'assignment cannot be nil'
+      end
+
+      @assignment = assignment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creator Value to be assigned
+    def creator=(creator)
+      if creator.nil?
+        fail ArgumentError, 'creator cannot be nil'
+      end
+
+      @creator = creator
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creation_date Value to be assigned
+    def creation_date=(creation_date)
+      if creation_date.nil?
+        fail ArgumentError, 'creation_date cannot be nil'
+      end
+
+      @creation_date = creation_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attachments Value to be assigned
+    def attachments=(attachments)
+      if attachments.nil?
+        fail ArgumentError, 'attachments cannot be nil'
+      end
+
+      @attachments = attachments
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] playback Value to be assigned
+    def playback=(playback)
+      if playback.nil?
+        fail ArgumentError, 'playback cannot be nil'
+      end
+
+      @playback = playback
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comments Value to be assigned
+    def comments=(comments)
+      if comments.nil?
+        fail ArgumentError, 'comments cannot be nil'
+      end
+
+      @comments = comments
     end
 
     # Checks equality by comparing each attribute.
@@ -165,17 +429,24 @@ module FlatApi
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          state == o.state &&
           classroom == o.classroom &&
           assignment == o.assignment &&
           creator == o.creator &&
           creation_date == o.creation_date &&
           attachments == o.attachments &&
           submission_date == o.submission_date &&
-          student_comment == o.student_comment &&
           return_date == o.return_date &&
-          return_feedback == o.return_feedback &&
           return_creator == o.return_creator &&
-          google_classroom == o.google_classroom
+          grade == o.grade &&
+          draft_grade == o.draft_grade &&
+          max_points == o.max_points &&
+          exercises_ids == o.exercises_ids &&
+          playback == o.playback &&
+          comments == o.comments &&
+          google_classroom == o.google_classroom &&
+          microsoft_graph == o.microsoft_graph &&
+          lti == o.lti
     end
 
     # @see the `==` method
@@ -185,83 +456,32 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, classroom, assignment, creator, creation_date, attachments, submission_date, student_comment, return_date, return_feedback, return_creator, google_classroom].hash
+      [id, state, classroom, assignment, creator, creation_date, attachments, submission_date, return_date, return_creator, grade, draft_grade, max_points, exercises_ids, playback, comments, google_classroom, microsoft_graph, lti].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)
+    def self.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
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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
-
-    # 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)
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
-      else # model
-        temp_model = FlatApi.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
+      new(transformed_hash)
     end
 
     # Returns the object in the form of hash
@@ -270,30 +490,16 @@ module FlatApi
       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
     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