flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/assignment_update.rb

@@ -0,0 +1,538 @@
+=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, 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) 
+
+The version of the OpenAPI document: 2.26.1
+Contact: developers@flat.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FlatApi
+  # Assignment Resource Editing
+  class AssignmentUpdate < ApiModelBase
+    attr_accessor :type
+
+    # Title of the assignment
+    attr_accessor :title
+
+    # Student instructions and content of the assignment (plain text)
+    attr_accessor :description
+
+    # HTML version of student instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility. 
+    attr_accessor :description_html
+
+    # Teacher-only instructions (plain text)
+    attr_accessor :teacher_instructions
+
+    # HTML version of teacher-only instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility. 
+    attr_accessor :teacher_instructions_html
+
+    # The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them.  Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`. 
+    attr_accessor :attachments
+
+    # The number of playback authorized on the scores of the assignment.
+    attr_accessor :nb_playback_authorized
+
+    # Restrict the ability to get an audio feedback every time a student adds or selects a note.
+    attr_accessor :restrict_play_note
+
+    # Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback.
+    attr_accessor :restrict_to_audio_tracks
+
+    # The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment. 
+    attr_accessor :toolset
+
+    # The id of the cover to display
+    attr_accessor :cover_file
+
+    # The URL of the cover to display
+    attr_accessor :cover
+
+    # If set, the grading will be enabled for the assignement with this value as the maximum of points 
+    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
+
+    attr_accessor :submission_students_mode
+
+    # For performance assignments: recording type that will be either 'audio' or 'video'.  * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording.  Only set when type is 'performance'. 
+    attr_accessor :recording_type
+
+    # For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'. 
+    attr_accessor :allow_metronome
+
+    # For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'. 
+    attr_accessor :allow_backing_track
+
+    # For performance assignments: whether students can adjust the playback speed of the score during recording.  * `true`: Students can change the tempo/speed during practice and recording * `false`: Tempo is fixed to the original score tempo  Only set when type is 'performance'. 
+    attr_accessor :allow_speed_change
+
+    # For performance assignments: \"Free Record\" mode.  When `true`, no score is attached to the assignment. Students freely record a varied repertoire or an ensemble performance without being constrained by a single score's structure or duration, and all score-dependent options (playback, metronome, backtracking, speed control) are hidden.  Only set when type is 'performance'. 
+    attr_accessor :free_record
+
+    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
+      {
+        :'type' => :'type',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'description_html' => :'descriptionHtml',
+        :'teacher_instructions' => :'teacherInstructions',
+        :'teacher_instructions_html' => :'teacherInstructionsHtml',
+        :'attachments' => :'attachments',
+        :'nb_playback_authorized' => :'nbPlaybackAuthorized',
+        :'restrict_play_note' => :'restrictPlayNote',
+        :'restrict_to_audio_tracks' => :'restrictToAudioTracks',
+        :'toolset' => :'toolset',
+        :'cover_file' => :'coverFile',
+        :'cover' => :'cover',
+        :'max_points' => :'maxPoints',
+        :'release_grades' => :'releaseGrades',
+        :'shuffle_exercises' => :'shuffleExercises',
+        :'submission_students_mode' => :'submissionStudentsMode',
+        :'recording_type' => :'recordingType',
+        :'allow_metronome' => :'allowMetronome',
+        :'allow_backing_track' => :'allowBackingTrack',
+        :'allow_speed_change' => :'allowSpeedChange',
+        :'free_record' => :'freeRecord'
+      }
+    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.openapi_types
+      {
+        :'type' => :'AssignmentType',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'description_html' => :'String',
+        :'teacher_instructions' => :'String',
+        :'teacher_instructions_html' => :'String',
+        :'attachments' => :'Array<ClassAttachmentCreation>',
+        :'nb_playback_authorized' => :'Float',
+        :'restrict_play_note' => :'Boolean',
+        :'restrict_to_audio_tracks' => :'Boolean',
+        :'toolset' => :'String',
+        :'cover_file' => :'String',
+        :'cover' => :'String',
+        :'max_points' => :'Float',
+        :'release_grades' => :'String',
+        :'shuffle_exercises' => :'Boolean',
+        :'submission_students_mode' => :'AssignmentSubmissionStudentsMode',
+        :'recording_type' => :'String',
+        :'allow_metronome' => :'Boolean',
+        :'allow_backing_track' => :'Boolean',
+        :'allow_speed_change' => :'Boolean',
+        :'free_record' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'nb_playback_authorized',
+        :'toolset',
+        :'cover_file',
+        :'cover',
+        :'max_points',
+      ])
+    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::AssignmentUpdate` initialize method"
+      end
+
+      # 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::AssignmentUpdate`. 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.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'description_html')
+        self.description_html = attributes[:'description_html']
+      end
+
+      if attributes.key?(:'teacher_instructions')
+        self.teacher_instructions = attributes[:'teacher_instructions']
+      end
+
+      if attributes.key?(:'teacher_instructions_html')
+        self.teacher_instructions_html = attributes[:'teacher_instructions_html']
+      end
+
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
+      if attributes.key?(:'nb_playback_authorized')
+        self.nb_playback_authorized = attributes[:'nb_playback_authorized']
+      end
+
+      if attributes.key?(:'restrict_play_note')
+        self.restrict_play_note = attributes[:'restrict_play_note']
+      end
+
+      if attributes.key?(:'restrict_to_audio_tracks')
+        self.restrict_to_audio_tracks = attributes[:'restrict_to_audio_tracks']
+      end
+
+      if attributes.key?(:'toolset')
+        self.toolset = attributes[:'toolset']
+      end
+
+      if attributes.key?(:'cover_file')
+        self.cover_file = attributes[:'cover_file']
+      end
+
+      if attributes.key?(:'cover')
+        self.cover = attributes[:'cover']
+      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?(:'submission_students_mode')
+        self.submission_students_mode = attributes[:'submission_students_mode']
+      end
+
+      if attributes.key?(:'recording_type')
+        self.recording_type = attributes[:'recording_type']
+      end
+
+      if attributes.key?(:'allow_metronome')
+        self.allow_metronome = attributes[:'allow_metronome']
+      end
+
+      if attributes.key?(:'allow_backing_track')
+        self.allow_backing_track = attributes[:'allow_backing_track']
+      end
+
+      if attributes.key?(:'allow_speed_change')
+        self.allow_speed_change = attributes[:'allow_speed_change']
+      end
+
+      if attributes.key?(:'free_record')
+        self.free_record = attributes[:'free_record']
+      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 !@title.nil? && @title.to_s.length > 1000
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@title.nil? && @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 100000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100000.')
+      end
+
+      if !@description_html.nil? && @description_html.to_s.length > 20000000
+        invalid_properties.push('invalid value for "description_html", the character length must be smaller than or equal to 20000000.')
+      end
+
+      if !@teacher_instructions.nil? && @teacher_instructions.to_s.length > 100000
+        invalid_properties.push('invalid value for "teacher_instructions", the character length must be smaller than or equal to 100000.')
+      end
+
+      if !@teacher_instructions_html.nil? && @teacher_instructions_html.to_s.length > 20000000
+        invalid_properties.push('invalid value for "teacher_instructions_html", the character length must be smaller than or equal to 20000000.')
+      end
+
+      if !@max_points.nil? && @max_points > 10000
+        invalid_properties.push('invalid value for "max_points", must be smaller than or equal to 10000.')
+      end
+
+      if !@max_points.nil? && @max_points < 0
+        invalid_properties.push('invalid value for "max_points", must be greater than or equal to 0.')
+      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 !@title.nil? && @title.to_s.length > 1000
+      return false if !@title.nil? && @title.to_s.length < 1
+      return false if !@description.nil? && @description.to_s.length > 100000
+      return false if !@description_html.nil? && @description_html.to_s.length > 20000000
+      return false if !@teacher_instructions.nil? && @teacher_instructions.to_s.length > 100000
+      return false if !@teacher_instructions_html.nil? && @teacher_instructions_html.to_s.length > 20000000
+      return false if !@max_points.nil? && @max_points > 10000
+      return false if !@max_points.nil? && @max_points < 0
+      release_grades_validator = EnumAttributeValidator.new('String', ["auto", "manual"])
+      return false unless release_grades_validator.valid?(@release_grades)
+      recording_type_validator = EnumAttributeValidator.new('String', ["audio", "video"])
+      return false unless recording_type_validator.valid?(@recording_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 1000.'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 100000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 100000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description_html Value to be assigned
+    def description_html=(description_html)
+      if description_html.nil?
+        fail ArgumentError, 'description_html cannot be nil'
+      end
+
+      if description_html.to_s.length > 20000000
+        fail ArgumentError, 'invalid value for "description_html", the character length must be smaller than or equal to 20000000.'
+      end
+
+      @description_html = description_html
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] teacher_instructions Value to be assigned
+    def teacher_instructions=(teacher_instructions)
+      if teacher_instructions.nil?
+        fail ArgumentError, 'teacher_instructions cannot be nil'
+      end
+
+      if teacher_instructions.to_s.length > 100000
+        fail ArgumentError, 'invalid value for "teacher_instructions", the character length must be smaller than or equal to 100000.'
+      end
+
+      @teacher_instructions = teacher_instructions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] teacher_instructions_html Value to be assigned
+    def teacher_instructions_html=(teacher_instructions_html)
+      if teacher_instructions_html.nil?
+        fail ArgumentError, 'teacher_instructions_html cannot be nil'
+      end
+
+      if teacher_instructions_html.to_s.length > 20000000
+        fail ArgumentError, 'invalid value for "teacher_instructions_html", the character length must be smaller than or equal to 20000000.'
+      end
+
+      @teacher_instructions_html = teacher_instructions_html
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_points Value to be assigned
+    def max_points=(max_points)
+      if !max_points.nil? && max_points > 10000
+        fail ArgumentError, 'invalid value for "max_points", must be smaller than or equal to 10000.'
+      end
+
+      if !max_points.nil? && max_points < 0
+        fail ArgumentError, 'invalid value for "max_points", must be greater than or equal to 0.'
+      end
+
+      @max_points = max_points
+    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] recording_type Object to be assigned
+    def recording_type=(recording_type)
+      validator = EnumAttributeValidator.new('String', ["audio", "video"])
+      unless validator.valid?(recording_type)
+        fail ArgumentError, "invalid value for \"recording_type\", must be one of #{validator.allowable_values}."
+      end
+      @recording_type = recording_type
+    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 &&
+          type == o.type &&
+          title == o.title &&
+          description == o.description &&
+          description_html == o.description_html &&
+          teacher_instructions == o.teacher_instructions &&
+          teacher_instructions_html == o.teacher_instructions_html &&
+          attachments == o.attachments &&
+          nb_playback_authorized == o.nb_playback_authorized &&
+          restrict_play_note == o.restrict_play_note &&
+          restrict_to_audio_tracks == o.restrict_to_audio_tracks &&
+          toolset == o.toolset &&
+          cover_file == o.cover_file &&
+          cover == o.cover &&
+          max_points == o.max_points &&
+          release_grades == o.release_grades &&
+          shuffle_exercises == o.shuffle_exercises &&
+          submission_students_mode == o.submission_students_mode &&
+          recording_type == o.recording_type &&
+          allow_metronome == o.allow_metronome &&
+          allow_backing_track == o.allow_backing_track &&
+          allow_speed_change == o.allow_speed_change &&
+          free_record == o.free_record
+    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
+      [type, title, description, description_html, teacher_instructions, teacher_instructions_html, attachments, nb_playback_authorized, restrict_play_note, restrict_to_audio_tracks, toolset, cover_file, cover, max_points, release_grades, shuffle_exercises, submission_students_mode, recording_type, allow_metronome, allow_backing_track, allow_speed_change, free_record].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
+
+    # 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
+
+  end
+
+end