flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/assignment_copy_response.rb

@@ -0,0 +1,535 @@
+=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
+  class AssignmentCopyResponse < ApiModelBase
+    # Unique identifier of the assignment
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :capabilities
+
+    # Title of the assignment
+    attr_accessor :title
+
+    # Student instructions and content of the assignment (plain text)
+    attr_accessor :description
+
+    # HTML version of student instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs. 
+    attr_accessor :description_html
+
+    # Teacher-only instructions for this assignment. These instructions are only visible to teachers and are not returned when students view the assignment. If `teacherInstructionsHtml` is provided, this field will contain the plain text version for compatibility. 
+    attr_accessor :teacher_instructions
+
+    # HTML version of teacher-only instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs. 
+    attr_accessor :teacher_instructions_html
+
+    # The URL of the cover to display
+    attr_accessor :cover
+
+    # The id of the cover to display
+    attr_accessor :cover_file
+
+    # Reference material handed to the students with the assignment: scores, videos, links and Drive files. A score attached here is the one each student receives their own copy of. 
+    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
+
+    # 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
+
+    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
+
+    # If this assignment is stored as a resource in the Flat for Education Resource Library, the unique identifier of the resource.
+    attr_accessor :resource
+
+    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',
+        :'description_html' => :'descriptionHtml',
+        :'teacher_instructions' => :'teacherInstructions',
+        :'teacher_instructions_html' => :'teacherInstructionsHtml',
+        :'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',
+        :'restrict_play_note' => :'restrictPlayNote',
+        :'restrict_to_audio_tracks' => :'restrictToAudioTracks',
+        :'submission_students_mode' => :'submissionStudentsMode',
+        :'recording_type' => :'recordingType',
+        :'allow_metronome' => :'allowMetronome',
+        :'allow_backing_track' => :'allowBackingTrack',
+        :'allow_speed_change' => :'allowSpeedChange',
+        :'free_record' => :'freeRecord',
+        :'resource' => :'resource'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'type' => :'AssignmentType',
+        :'capabilities' => :'AssignmentCapabilities',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'description_html' => :'String',
+        :'teacher_instructions' => :'String',
+        :'teacher_instructions_html' => :'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',
+        :'restrict_play_note' => :'Boolean',
+        :'restrict_to_audio_tracks' => :'Boolean',
+        :'submission_students_mode' => :'AssignmentSubmissionStudentsMode',
+        :'recording_type' => :'String',
+        :'allow_metronome' => :'Boolean',
+        :'allow_backing_track' => :'Boolean',
+        :'allow_speed_change' => :'Boolean',
+        :'free_record' => :'Boolean',
+        :'resource' => :'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::AssignmentCopyResponse` 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::AssignmentCopyResponse`. 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?(:'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?(:'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?(:'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?(:'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?(:'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
+
+      if attributes.key?(:'resource')
+        self.resource = attributes[:'resource']
+      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
+
+      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)
+      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] 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] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] capabilities Value to be assigned
+    def capabilities=(capabilities)
+      if capabilities.nil?
+        fail ArgumentError, 'capabilities cannot be nil'
+      end
+
+      @capabilities = capabilities
+    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
+
+      @title = title
+    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 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 &&
+          id == o.id &&
+          type == o.type &&
+          capabilities == o.capabilities &&
+          title == o.title &&
+          description == o.description &&
+          description_html == o.description_html &&
+          teacher_instructions == o.teacher_instructions &&
+          teacher_instructions_html == o.teacher_instructions_html &&
+          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 &&
+          restrict_play_note == o.restrict_play_note &&
+          restrict_to_audio_tracks == o.restrict_to_audio_tracks &&
+          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 &&
+          resource == o.resource
+    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, description_html, teacher_instructions, teacher_instructions_html, cover, cover_file, attachments, use_dedicated_attachments, max_points, release_grades, shuffle_exercises, toolset, nb_playback_authorized, restrict_play_note, restrict_to_audio_tracks, submission_students_mode, recording_type, allow_metronome, allow_backing_track, allow_speed_change, free_record, resource].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