flat_api 0.2.0 → 0.3.5

data/lib/flat_api/models/class_assignment.rb

@@ -0,0 +1,613 @@
+=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, 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) 
+
+The version of the OpenAPI document: 2.20.0
+Contact: developers@flat.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FlatApi
+  class ClassAssignment
+    # Unique identifier of the assignment
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :capabilities
+
+    # Title of the assignment
+    attr_accessor :title
+
+    # 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
+
+    # 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
+
+    # If set, the grading will be enabled for the assignement 
+    attr_accessor :max_points
+
+    # 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
+
+    # Mixing worksheets exercises for each student
+    attr_accessor :shuffle_exercises
+
+    # The id of the associated toolset
+    attr_accessor :toolset
+
+    # The number of playback authorized on the scores of the assignment.
+    attr_accessor :nb_playback_authorized
+
+    # The User unique identifier of the creator of this assignment 
+    attr_accessor :creator
+
+    # State of the assignment
+    attr_accessor :state
+
+    # The unique identifier of the class where this assignment was posted
+    attr_accessor :classroom
+
+    # The creation date of this assignment
+    attr_accessor :creation_date
+
+    # 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
+
+    # The due date of this assignment, late submissions will be marked as paste due. 
+    attr_accessor :due_date
+
+    # Possible modes of assigning assignments
+    attr_accessor :assignee_mode
+
+    # Identifiers for the students that have access to the assignment
+    attr_accessor :assigned_students
+
+    attr_accessor :submissions
+
+    attr_accessor :google_classroom
+
+    attr_accessor :microsoft_graph
+
+    attr_accessor :mfc
+
+    attr_accessor :canvas
+
+    attr_accessor :lti
+
+    # Detected issue for this assignment
+    attr_accessor :issue
+
+    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',
+        :'type' => :'type',
+        :'capabilities' => :'capabilities',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'cover' => :'cover',
+        :'cover_file' => :'coverFile',
+        :'attachments' => :'attachments',
+        :'use_dedicated_attachments' => :'useDedicatedAttachments',
+        :'max_points' => :'maxPoints',
+        :'release_grades' => :'releaseGrades',
+        :'shuffle_exercises' => :'shuffleExercises',
+        :'toolset' => :'toolset',
+        :'nb_playback_authorized' => :'nbPlaybackAuthorized',
+        :'creator' => :'creator',
+        :'state' => :'state',
+        :'classroom' => :'classroom',
+        :'creation_date' => :'creationDate',
+        :'scheduled_date' => :'scheduledDate',
+        :'due_date' => :'dueDate',
+        :'assignee_mode' => :'assigneeMode',
+        :'assigned_students' => :'assignedStudents',
+        :'submissions' => :'submissions',
+        :'google_classroom' => :'googleClassroom',
+        :'microsoft_graph' => :'microsoftGraph',
+        :'mfc' => :'mfc',
+        :'canvas' => :'canvas',
+        :'lti' => :'lti',
+        :'issue' => :'issue'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'type' => :'AssignmentType',
+        :'capabilities' => :'AssignmentCapabilities',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'cover' => :'String',
+        :'cover_file' => :'String',
+        :'attachments' => :'Array<MediaAttachment>',
+        :'use_dedicated_attachments' => :'Boolean',
+        :'max_points' => :'Float',
+        :'release_grades' => :'String',
+        :'shuffle_exercises' => :'Boolean',
+        :'toolset' => :'String',
+        :'nb_playback_authorized' => :'Float',
+        :'creator' => :'String',
+        :'state' => :'String',
+        :'classroom' => :'String',
+        :'creation_date' => :'Time',
+        :'scheduled_date' => :'Time',
+        :'due_date' => :'Time',
+        :'assignee_mode' => :'String',
+        :'assigned_students' => :'Array<String>',
+        :'submissions' => :'Array<AssignmentSubmission>',
+        :'google_classroom' => :'GoogleClassroomCoursework',
+        :'microsoft_graph' => :'MicrosoftGraphAssignment',
+        :'mfc' => :'ClassAssignmentAllOfMfc',
+        :'canvas' => :'ClassAssignmentAllOfCanvas',
+        :'lti' => :'ClassAssignmentAllOfLti',
+        :'issue' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Assignment'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ClassAssignment` initialize method"
+      end
+
+      # 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::ClassAssignment`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      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.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      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.key?(:'use_dedicated_attachments')
+        self.use_dedicated_attachments = attributes[:'use_dedicated_attachments']
+      end
+
+      if attributes.key?(:'max_points')
+        self.max_points = attributes[:'max_points']
+      end
+
+      if attributes.key?(:'release_grades')
+        self.release_grades = attributes[:'release_grades']
+      end
+
+      if attributes.key?(:'shuffle_exercises')
+        self.shuffle_exercises = attributes[:'shuffle_exercises']
+      end
+
+      if attributes.key?(:'toolset')
+        self.toolset = attributes[:'toolset']
+      end
+
+      if attributes.key?(:'nb_playback_authorized')
+        self.nb_playback_authorized = attributes[:'nb_playback_authorized']
+      end
+
+      if attributes.key?(:'creator')
+        self.creator = attributes[:'creator']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'classroom')
+        self.classroom = attributes[:'classroom']
+      end
+
+      if attributes.key?(:'creation_date')
+        self.creation_date = attributes[:'creation_date']
+      else
+        self.creation_date = nil
+      end
+
+      if attributes.key?(:'scheduled_date')
+        self.scheduled_date = attributes[:'scheduled_date']
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'assignee_mode')
+        self.assignee_mode = attributes[:'assignee_mode']
+      end
+
+      if attributes.key?(:'assigned_students')
+        if (value = attributes[:'assigned_students']).is_a?(Array)
+          self.assigned_students = value
+        end
+      end
+
+      if attributes.key?(:'submissions')
+        if (value = attributes[:'submissions']).is_a?(Array)
+          self.submissions = value
+        end
+      else
+        self.submissions = 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?(:'mfc')
+        self.mfc = attributes[:'mfc']
+      end
+
+      if attributes.key?(:'canvas')
+        self.canvas = attributes[:'canvas']
+      end
+
+      if attributes.key?(:'lti')
+        self.lti = attributes[:'lti']
+      end
+
+      if attributes.key?(:'issue')
+        self.issue = attributes[:'issue']
+      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
+      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
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @creation_date.nil?
+        invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
+      end
+
+      if @submissions.nil?
+        invalid_properties.push('invalid value for "submissions", submissions 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?
+      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)
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
+      return false unless state_validator.valid?(@state)
+      return false if @creation_date.nil?
+      assignee_mode_validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
+      return false unless assignee_mode_validator.valid?(@assignee_mode)
+      return false if @submissions.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @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
+      @release_grades = release_grades
+    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}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] assignee_mode Object to be assigned
+    def assignee_mode=(assignee_mode)
+      validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
+      unless validator.valid?(assignee_mode)
+        fail ArgumentError, "invalid value for \"assignee_mode\", must be one of #{validator.allowable_values}."
+      end
+      @assignee_mode = assignee_mode
+    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 &&
+          type == o.type &&
+          capabilities == o.capabilities &&
+          title == o.title &&
+          description == o.description &&
+          cover == o.cover &&
+          cover_file == o.cover_file &&
+          attachments == o.attachments &&
+          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 &&
+          creator == o.creator &&
+          state == o.state &&
+          classroom == o.classroom &&
+          creation_date == o.creation_date &&
+          scheduled_date == o.scheduled_date &&
+          due_date == o.due_date &&
+          assignee_mode == o.assignee_mode &&
+          assigned_students == o.assigned_students &&
+          submissions == o.submissions &&
+          google_classroom == o.google_classroom &&
+          microsoft_graph == o.microsoft_graph &&
+          mfc == o.mfc &&
+          canvas == o.canvas &&
+          lti == o.lti &&
+          issue == o.issue
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, type, capabilities, title, description, cover, cover_file, attachments, use_dedicated_attachments, max_points, release_grades, shuffle_exercises, toolset, nb_playback_authorized, creator, state, classroom, creation_date, scheduled_date, due_date, assignee_mode, assigned_students, submissions, google_classroom, microsoft_graph, mfc, canvas, lti, issue].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)
+      return nil unless attributes.is_a?(Hash)
+      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[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
+      end
+      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 self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # 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
+
+    # 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)
+        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