flat_api 0.2.0 → 0.3.5

data/lib/flat_api/models/assignment.rb

@@ -1,49 +1,59 @@
 =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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore 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 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.20.0
 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
+OpenAPI Generator version: 7.3.0
 
 =end
 
 require 'date'
+require 'time'
 
 module FlatApi
   # Assignment details
   class Assignment
-    # State of the assignment
-    attr_accessor :state
+    # Unique identifier of the assignment
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :capabilities
 
     # Title of the assignment
     attr_accessor :title
 
-    # The unique identifier of the class where this assignment was posted
-    attr_accessor :classroom
-
     # Description and content of the assignment
     attr_accessor :description
 
+    # The URL of the cover to display
+    attr_accessor :cover
+
+    # The id of the cover to display
+    attr_accessor :cover_file
+
     attr_accessor :attachments
 
-    attr_accessor :submissions
+    # For all assignments created after 02/2023, all the underlying resources must be dedicated and stored in the assignment. This boolean indicates that this assignment only supports dedicated attachments. 
+    attr_accessor :use_dedicated_attachments
 
-    # The User unique identifier of the creator of this assignment 
-    attr_accessor :creator
+    # If set, the grading will be enabled for the assignement 
+    attr_accessor :max_points
 
-    # The creation date of this assignment
-    attr_accessor :creation_date
+    # For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions 
+    attr_accessor :release_grades
 
-    # The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. 
-    attr_accessor :scheduled_date
+    # Mixing worksheets exercises for each student
+    attr_accessor :shuffle_exercises
 
-    # The due date of this assignment, late submissions will be marked as paste due. 
-    attr_accessor :due_date
+    # The id of the associated toolset
+    attr_accessor :toolset
 
-    attr_accessor :google_classroom
+    # The number of playback authorized on the scores of the assignment.
+    attr_accessor :nb_playback_authorized
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -70,118 +80,188 @@ module FlatApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'state' => :'state',
+        :'id' => :'id',
+        :'type' => :'type',
+        :'capabilities' => :'capabilities',
         :'title' => :'title',
-        :'classroom' => :'classroom',
         :'description' => :'description',
+        :'cover' => :'cover',
+        :'cover_file' => :'coverFile',
         :'attachments' => :'attachments',
-        :'submissions' => :'submissions',
-        :'creator' => :'creator',
-        :'creation_date' => :'creationDate',
-        :'scheduled_date' => :'scheduledDate',
-        :'due_date' => :'dueDate',
-        :'google_classroom' => :'googleClassroom'
+        :'use_dedicated_attachments' => :'useDedicatedAttachments',
+        :'max_points' => :'maxPoints',
+        :'release_grades' => :'releaseGrades',
+        :'shuffle_exercises' => :'shuffleExercises',
+        :'toolset' => :'toolset',
+        :'nb_playback_authorized' => :'nbPlaybackAuthorized'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'state' => :'String',
+        :'id' => :'String',
+        :'type' => :'AssignmentType',
+        :'capabilities' => :'AssignmentCapabilities',
         :'title' => :'String',
-        :'classroom' => :'String',
         :'description' => :'String',
+        :'cover' => :'String',
+        :'cover_file' => :'String',
         :'attachments' => :'Array<MediaAttachment>',
-        :'submissions' => :'Array<AssignmentSubmission>',
-        :'creator' => :'String',
-        :'creation_date' => :'DateTime',
-        :'scheduled_date' => :'DateTime',
-        :'due_date' => :'DateTime',
-        :'google_classroom' => :'GoogleClassroomCoursework'
+        :'use_dedicated_attachments' => :'Boolean',
+        :'max_points' => :'Float',
+        :'release_grades' => :'String',
+        :'shuffle_exercises' => :'Boolean',
+        :'toolset' => :'String',
+        :'nb_playback_authorized' => :'Float'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::Assignment` 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 `FlatApi::Assignment`. 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?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.has_key?(:'title')
-        self.title = attributes[:'title']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'capabilities')
+        self.capabilities = attributes[:'capabilities']
+      else
+        self.capabilities = nil
       end
 
-      if attributes.has_key?(:'classroom')
-        self.classroom = attributes[:'classroom']
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
       end
 
-      if attributes.has_key?(:'description')
+      if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
-      if attributes.has_key?(:'attachments')
+      if attributes.key?(:'cover')
+        self.cover = attributes[:'cover']
+      end
+
+      if attributes.key?(:'cover_file')
+        self.cover_file = attributes[:'cover_file']
+      end
+
+      if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
         end
+      else
+        self.attachments = nil
       end
 
-      if attributes.has_key?(:'submissions')
-        if (value = attributes[:'submissions']).is_a?(Array)
-          self.submissions = value
-        end
+      if attributes.key?(:'use_dedicated_attachments')
+        self.use_dedicated_attachments = attributes[:'use_dedicated_attachments']
       end
 
-      if attributes.has_key?(:'creator')
-        self.creator = attributes[:'creator']
+      if attributes.key?(:'max_points')
+        self.max_points = attributes[:'max_points']
       end
 
-      if attributes.has_key?(:'creationDate')
-        self.creation_date = attributes[:'creationDate']
+      if attributes.key?(:'release_grades')
+        self.release_grades = attributes[:'release_grades']
       end
 
-      if attributes.has_key?(:'scheduledDate')
-        self.scheduled_date = attributes[:'scheduledDate']
+      if attributes.key?(:'shuffle_exercises')
+        self.shuffle_exercises = attributes[:'shuffle_exercises']
       end
 
-      if attributes.has_key?(:'dueDate')
-        self.due_date = attributes[:'dueDate']
+      if attributes.key?(:'toolset')
+        self.toolset = attributes[:'toolset']
       end
 
-      if attributes.has_key?(:'googleClassroom')
-        self.google_classroom = attributes[:'googleClassroom']
+      if attributes.key?(:'nb_playback_authorized')
+        self.nb_playback_authorized = attributes[:'nb_playback_authorized']
       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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @capabilities.nil?
+        invalid_properties.push('invalid value for "capabilities", capabilities cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @attachments.nil?
+        invalid_properties.push('invalid value for "attachments", attachments 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?
-      state_validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
-      return false unless state_validator.valid?(@state)
-      return true
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @type.nil?
+      return false if @capabilities.nil?
+      return false if @title.nil?
+      return false if @attachments.nil?
+      release_grades_validator = EnumAttributeValidator.new('String', ["auto", "manual"])
+      return false unless release_grades_validator.valid?(@release_grades)
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] state Object to be assigned
-    def state=(state)
-      validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
-      unless validator.valid?(state)
-        fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}."
+    # @param [Object] release_grades Object to be assigned
+    def release_grades=(release_grades)
+      validator = EnumAttributeValidator.new('String', ["auto", "manual"])
+      unless validator.valid?(release_grades)
+        fail ArgumentError, "invalid value for \"release_grades\", must be one of #{validator.allowable_values}."
       end
-      @state = state
+      @release_grades = release_grades
     end
 
     # Checks equality by comparing each attribute.
@@ -189,17 +269,20 @@ module FlatApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          state == o.state &&
+          id == o.id &&
+          type == o.type &&
+          capabilities == o.capabilities &&
           title == o.title &&
-          classroom == o.classroom &&
           description == o.description &&
+          cover == o.cover &&
+          cover_file == o.cover_file &&
           attachments == o.attachments &&
-          submissions == o.submissions &&
-          creator == o.creator &&
-          creation_date == o.creation_date &&
-          scheduled_date == o.scheduled_date &&
-          due_date == o.due_date &&
-          google_classroom == o.google_classroom
+          use_dedicated_attachments == o.use_dedicated_attachments &&
+          max_points == o.max_points &&
+          release_grades == o.release_grades &&
+          shuffle_exercises == o.shuffle_exercises &&
+          toolset == o.toolset &&
+          nb_playback_authorized == o.nb_playback_authorized
     end
 
     # @see the `==` method
@@ -209,39 +292,42 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [state, title, classroom, description, attachments, submissions, creator, creation_date, scheduled_date, due_date, google_classroom].hash
+      [id, type, capabilities, title, description, cover, cover_file, attachments, use_dedicated_attachments, max_points, release_grades, shuffle_exercises, toolset, nb_playback_authorized].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) } )
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -250,7 +336,7 @@ module FlatApi
         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
@@ -271,8 +357,9 @@ module FlatApi
           end
         end
       else # model
-        temp_model = FlatApi.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = FlatApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -294,7 +381,11 @@ 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
@@ -306,7 +397,7 @@ module FlatApi
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }