flat_api 0.2.0 → 0.3.5

data/spec/api/class_api_spec.rb

@@ -1,12 +1,12 @@
 =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
 
@@ -14,12 +14,12 @@ require 'spec_helper'
 require 'json'
 
 # Unit tests for FlatApi::ClassApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'ClassApi' do
   before do
     # run before each test
-    @instance = FlatApi::ClassApi.new
+    @api_instance = FlatApi::ClassApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'ClassApi' do
 
   describe 'test an instance of ClassApi' do
     it 'should create an instance of ClassApi' do
-      expect(@instance).to be_instance_of(FlatApi::ClassApi)
+      expect(@api_instance).to be_instance_of(FlatApi::ClassApi)
     end
   end
 
@@ -39,8 +39,8 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'activate_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -52,8 +52,21 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'add_class_user test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for archive_assignment
+  # Archive the assignment
+  # Archive the assignment 
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param [Hash] opts the optional parameters
+  # @return [Assignment]
+  describe 'archive_assignment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -64,61 +77,74 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'archive_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for copy_assignment
   # Copy an assignment
-  # Copy an assignment to a specified class.  If the original assignment has a due date in the past, this new assingment will be created without a due date.  If the new class is synchronized with an external app (e.g. Google Classroom), the copied assignment will also be posted on the external app. 
+  # Copy an assignment to a specified class or the resource library  For class assignments: - If the original assignment has a due date in the past, this new assignment will be created without a due date. - If the class is synchronized with an external app (e.g. Google Classroom), the copied assignment will also be posted on the external app. 
   # @param _class Unique identifier of the class
   # @param assignment Unique identifier of the assignment
   # @param body 
   # @param [Hash] opts the optional parameters
-  # @return [Assignment]
+  # @return [AssignmentCopyResponse]
   describe 'copy_assignment test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for create_assignment
-  # Assignment creation
-  # Use this method as a teacher to create and post a new assignment to a class.  If the class is synchronized with Google Classroom, the assignment will be automatically posted to your Classroom course. 
-  # @param _class Unique identifier of the class
-  # @param [Hash] opts the optional parameters
-  # @option opts [AssignmentCreation] :body 
-  # @return [Assignment]
-  describe 'create_assignment test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for create_class
   # Create a new class
-  # Classrooms on Flat allow you to create activities with assignments and post content to a specific group.  When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group.  If the classsroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated.  You can add users to this class using `POST /classes/{class}/users/{user}`, they will automatically added to the group based on their role on Flat. Users can also enroll themselves to this class using `POST /classes/enroll/{enrollmentCode}` and the `enrollmentCode` returned in the `ClassDetails` response. 
+  # Classrooms on Flat allow you to create activities with assignments and post content to a specific group.  When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group.  If the classsroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated.  You can add users to this class using `PUT /classes/{class}/users/{user}`, they will automatically added to the group based on their role on Flat. Users can also enroll themselves to this class using `POST /classes/enroll/{enrollmentCode}` and the `enrollmentCode` returned in the `ClassDetails` response. 
   # @param body 
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'create_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_class_assignment
+  # Assignment creation
+  # Use this method as a teacher to create and post a new assignment to a class.  If the class is synchronized with Google Classroom, the assignment will be automatically posted to your Classroom course. 
+  # @param _class Unique identifier of the class
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Assignment]
+  describe 'create_class_assignment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for create_submission
   # Create or edit a submission
-  # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set `attachments`, `studentComment` and `submit`.  Teachers can use `PUT /classes/{class}/assignments/{assignment}/submissions/{submission}` to update a submission by id. 
+  # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set `attachments` and `submit`. Teachers can use `PUT /classes/{class}/assignments/{assignment}/submissions/{submission}` to update a submission by id. 
   # @param _class Unique identifier of the class
   # @param assignment Unique identifier of the assignment
   # @param body 
   # @param [Hash] opts the optional parameters
   # @return [AssignmentSubmission]
   describe 'create_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_test_student_account
+  # Create a test student account
+  # Test students account can be created by teachers an admin and be used to experiment the assignments.  - They are automatically added to the class. - They can be reset using this API endpoint (a new account will be created and the previous one scheduled for deletion). - These accounts don't use a user license. 
+  # @param _class Unique identifier of the class
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :reset If true, the testing account will be re-created. 
+  # @return [UserDetails]
+  describe 'create_test_student_account test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -130,14 +156,42 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_class_user test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_submission
+  # Reset a submission
+  # Use this method as a teacher to reset a submission and allow student to start over the assignment 
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param [Hash] opts the optional parameters
+  # @return [AssignmentSubmission]
+  describe 'delete_submission test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_submission_comment
+  # Delete a feedback comment to a submission
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param comment Unique identifier of the comment
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_submission_comment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for edit_submission
   # Edit a submission
-  # Use this method as a teacher to update the different submission and give feedback. Teachers can only set `returnFeedback` 
+  # Use this method as a teacher to update the different submission and give feedback. Teachers can only set `return`, `draftGrade` and `grade` 
   # @param _class Unique identifier of the class
   # @param assignment Unique identifier of the assignment
   # @param submission Unique identifier of the submission
@@ -145,8 +199,8 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [AssignmentSubmission]
   describe 'edit_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -157,20 +211,45 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'enroll_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for export_submissions_reviews_as_csv
+  # CSV Grades exports
+  # Export list of submissions grades to a CSV file
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'export_submissions_reviews_as_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for export_submissions_reviews_as_excel
+  # Excel Grades exports
+  # Export list of submissions grades to an Excel file
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'export_submissions_reviews_as_excel test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for get_class
   # Get the details of a single class
-  # 
   # @param _class Unique identifier of the class
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'get_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -181,47 +260,71 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [Array<AssignmentSubmission>]
   describe 'get_score_submissions test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for get_submission
   # Get a student submission
-  # 
   # @param _class Unique identifier of the class
   # @param assignment Unique identifier of the assignment
   # @param submission Unique identifier of the submission
   # @param [Hash] opts the optional parameters
   # @return [AssignmentSubmission]
   describe 'get_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_submission_comments
+  # List the feedback comments of a submission
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param [Hash] opts the optional parameters
+  # @return [Array<AssignmentSubmissionComment>]
+  describe 'get_submission_comments test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_submission_history
+  # Get the history of the submission
+  # For teachers only. Returns a detailed history of the submission. This currently includes state and grade histories. 
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param [Hash] opts the optional parameters
+  # @return [Array<AssignmentSubmissionHistory>]
+  describe 'get_submission_history test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for get_submissions
   # List the students&#39; submissions
-  # 
   # @param _class Unique identifier of the class
   # @param assignment Unique identifier of the assignment
   # @param [Hash] opts the optional parameters
   # @return [Array<AssignmentSubmission>]
   describe 'get_submissions test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_assignments
   # Assignments listing
-  # 
   # @param _class Unique identifier of the class
   # @param [Hash] opts the optional parameters
-  # @return [Array<Assignment>]
+  # @return [Array<ClassAssignment>]
   describe 'list_assignments test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -233,20 +336,46 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [Array<AssignmentSubmission>]
   describe 'list_class_student_submissions test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_classes
   # List the classes available for the current user
-  # 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :state Filter the classes by state
   # @return [Array<ClassDetails>]
   describe 'list_classes test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_submission_comment
+  # Add a feedback comment to a submission
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param assignment_submission_comment_creation 
+  # @param [Hash] opts the optional parameters
+  # @return [AssignmentSubmissionComment]
+  describe 'post_submission_comment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for unarchive_assignment
+  # Unarchive the assignment.
+  # Mark the assignment as &#x60;active&#x60;. 
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param [Hash] opts the optional parameters
+  # @return [Assignment]
+  describe 'unarchive_assignment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -257,8 +386,8 @@ describe 'ClassApi' do
   # @param [Hash] opts the optional parameters
   # @return [ClassDetails]
   describe 'unarchive_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -266,12 +395,27 @@ describe 'ClassApi' do
   # Update the class
   # Update the meta information of the class 
   # @param _class Unique identifier of the class
+  # @param body Details of the Class
   # @param [Hash] opts the optional parameters
-  # @option opts [ClassUpdate] :body Details of the Class
   # @return [ClassDetails]
   describe 'update_class test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_submission_comment
+  # Update a feedback comment to a submission
+  # @param _class Unique identifier of the class
+  # @param assignment Unique identifier of the assignment
+  # @param submission Unique identifier of the submission
+  # @param comment Unique identifier of the comment
+  # @param assignment_submission_comment_creation 
+  # @param [Hash] opts the optional parameters
+  # @return [AssignmentSubmissionComment]
+  describe 'update_submission_comment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end