flat_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d1cf464397084163fdddb5b7a2b08fbaf747025
+  data.tar.gz: 1ca103733be95b85353dce1670f3fa35ef81be7d
+SHA512:
+  metadata.gz: 945b9e041ee2ff343ba8883092f90dc3a0cc1a1b38e14e859d445b865595a31e4b030ca4c97d2d38f0d24b68f09f31712f75ea324a09d1d8d73095c6c44ff2f0
+  data.tar.gz: 54d182633a9aa20388caa71e427bd8da1d35905dbfee574bc7a63603dce4e35508ce8200e3c5e0a43d5f221cd6d3b31bd792d15c7dc57d917fcf897a85ab5e9b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,248 @@
+# Ruby Client for the Flat REST API
+
+[![Build Status](https://travis-ci.org/FlatIO/api-client-ruby.svg?branch=master)](https://travis-ci.org/FlatIO/api-client-ruby)
+
+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.
+
+You can find the API reference including code samples and our OpenAPI Specification at the following url: [https://flat.io/developers/api/reference](https://flat.io/developers/api/reference).
+
+To request some API credentials, please visit [https://flat.io/developers](https://flat.io/developers).
+
+This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build flat_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./flat_api-0.1.0.gem
+```
+(for development, run `gem install --dev ./flat_api-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'flat_api', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/FlatIO/api-client-ruby, then add the following in the Gemfile:
+
+    gem 'flat_api', :git => 'https://github.com/FlatIO/api-client-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'flat_api'
+
+# Setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::AccountApi.new
+
+begin
+  #Get current user profile
+  result = api_instance.get_authenticated_user
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*FlatApi::AccountApi* | [**get_authenticated_user**](docs/AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
+*FlatApi::ClassApi* | [**activate_class**](docs/ClassApi.md#activate_class) | **POST** /classes/{class}/activate | Activate the class
+*FlatApi::ClassApi* | [**add_class_user**](docs/ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class
+*FlatApi::ClassApi* | [**archive_class**](docs/ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class
+*FlatApi::ClassApi* | [**copy_assignment**](docs/ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
+*FlatApi::ClassApi* | [**create_assignment**](docs/ClassApi.md#create_assignment) | **POST** /classes/{class}/assignments | Assignment creation
+*FlatApi::ClassApi* | [**create_class**](docs/ClassApi.md#create_class) | **POST** /classes | Create a new class
+*FlatApi::ClassApi* | [**create_submission**](docs/ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
+*FlatApi::ClassApi* | [**delete_class_user**](docs/ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
+*FlatApi::ClassApi* | [**edit_submission**](docs/ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
+*FlatApi::ClassApi* | [**enroll_class**](docs/ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class
+*FlatApi::ClassApi* | [**get_class**](docs/ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class
+*FlatApi::ClassApi* | [**get_score_submissions**](docs/ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
+*FlatApi::ClassApi* | [**get_submission**](docs/ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
+*FlatApi::ClassApi* | [**get_submissions**](docs/ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
+*FlatApi::ClassApi* | [**list_assignments**](docs/ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing
+*FlatApi::ClassApi* | [**list_class_student_submissions**](docs/ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
+*FlatApi::ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user
+*FlatApi::ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class
+*FlatApi::ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class
+*FlatApi::GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information
+*FlatApi::GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
+*FlatApi::GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users
+*FlatApi::OrganizationApi* | [**create_lti_credentials**](docs/OrganizationApi.md#create_lti_credentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials
+*FlatApi::OrganizationApi* | [**create_organization_invitation**](docs/OrganizationApi.md#create_organization_invitation) | **POST** /organizations/invitations | Create a new invitation to join the organization
+*FlatApi::OrganizationApi* | [**create_organization_user**](docs/OrganizationApi.md#create_organization_user) | **POST** /organizations/users | Create a new user account
+*FlatApi::OrganizationApi* | [**list_lti_credentials**](docs/OrganizationApi.md#list_lti_credentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials
+*FlatApi::OrganizationApi* | [**list_organization_invitations**](docs/OrganizationApi.md#list_organization_invitations) | **GET** /organizations/invitations | List the organization invitations
+*FlatApi::OrganizationApi* | [**list_organization_users**](docs/OrganizationApi.md#list_organization_users) | **GET** /organizations/users | List the organization users
+*FlatApi::OrganizationApi* | [**remove_organization_invitation**](docs/OrganizationApi.md#remove_organization_invitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
+*FlatApi::OrganizationApi* | [**remove_organization_user**](docs/OrganizationApi.md#remove_organization_user) | **DELETE** /organizations/users/{user} | Remove an account from Flat
+*FlatApi::OrganizationApi* | [**revoke_lti_credentials**](docs/OrganizationApi.md#revoke_lti_credentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
+*FlatApi::OrganizationApi* | [**update_organization_user**](docs/OrganizationApi.md#update_organization_user) | **PUT** /organizations/users/{user} | Update account information
+*FlatApi::ScoreApi* | [**add_score_collaborator**](docs/ScoreApi.md#add_score_collaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
+*FlatApi::ScoreApi* | [**add_score_track**](docs/ScoreApi.md#add_score_track) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score
+*FlatApi::ScoreApi* | [**create_score**](docs/ScoreApi.md#create_score) | **POST** /scores | Create a new score
+*FlatApi::ScoreApi* | [**create_score_revision**](docs/ScoreApi.md#create_score_revision) | **POST** /scores/{score}/revisions | Create a new revision
+*FlatApi::ScoreApi* | [**delete_score**](docs/ScoreApi.md#delete_score) | **DELETE** /scores/{score} | Delete a score
+*FlatApi::ScoreApi* | [**delete_score_comment**](docs/ScoreApi.md#delete_score_comment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment
+*FlatApi::ScoreApi* | [**delete_score_track**](docs/ScoreApi.md#delete_score_track) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score
+*FlatApi::ScoreApi* | [**edit_score**](docs/ScoreApi.md#edit_score) | **PUT** /scores/{score} | Edit a score's metadata
+*FlatApi::ScoreApi* | [**fork_score**](docs/ScoreApi.md#fork_score) | **POST** /scores/{score}/fork | Fork a score
+*FlatApi::ScoreApi* | [**ger_user_likes**](docs/ScoreApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
+*FlatApi::ScoreApi* | [**get_group_scores**](docs/ScoreApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
+*FlatApi::ScoreApi* | [**get_score**](docs/ScoreApi.md#get_score) | **GET** /scores/{score} | Get a score's metadata
+*FlatApi::ScoreApi* | [**get_score_collaborator**](docs/ScoreApi.md#get_score_collaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator
+*FlatApi::ScoreApi* | [**get_score_collaborators**](docs/ScoreApi.md#get_score_collaborators) | **GET** /scores/{score}/collaborators | List the collaborators
+*FlatApi::ScoreApi* | [**get_score_comments**](docs/ScoreApi.md#get_score_comments) | **GET** /scores/{score}/comments | List comments
+*FlatApi::ScoreApi* | [**get_score_revision**](docs/ScoreApi.md#get_score_revision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision
+*FlatApi::ScoreApi* | [**get_score_revision_data**](docs/ScoreApi.md#get_score_revision_data) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data
+*FlatApi::ScoreApi* | [**get_score_revisions**](docs/ScoreApi.md#get_score_revisions) | **GET** /scores/{score}/revisions | List the revisions
+*FlatApi::ScoreApi* | [**get_score_submissions**](docs/ScoreApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
+*FlatApi::ScoreApi* | [**get_score_track**](docs/ScoreApi.md#get_score_track) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score
+*FlatApi::ScoreApi* | [**get_user_scores**](docs/ScoreApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
+*FlatApi::ScoreApi* | [**list_score_tracks**](docs/ScoreApi.md#list_score_tracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score
+*FlatApi::ScoreApi* | [**mark_score_comment_resolved**](docs/ScoreApi.md#mark_score_comment_resolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved
+*FlatApi::ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
+*FlatApi::ScoreApi* | [**post_score_comment**](docs/ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment
+*FlatApi::ScoreApi* | [**remove_score_collaborator**](docs/ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator
+*FlatApi::ScoreApi* | [**update_score_comment**](docs/ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment
+*FlatApi::ScoreApi* | [**update_score_track**](docs/ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score
+*FlatApi::UserApi* | [**ger_user_likes**](docs/UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
+*FlatApi::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile
+*FlatApi::UserApi* | [**get_user_scores**](docs/UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
+
+
+## Documentation for Models
+
+ - [FlatApi::Assignment](docs/Assignment.md)
+ - [FlatApi::AssignmentCopy](docs/AssignmentCopy.md)
+ - [FlatApi::AssignmentCreation](docs/AssignmentCreation.md)
+ - [FlatApi::AssignmentSubmission](docs/AssignmentSubmission.md)
+ - [FlatApi::AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)
+ - [FlatApi::ClassAttachmentCreation](docs/ClassAttachmentCreation.md)
+ - [FlatApi::ClassCreation](docs/ClassCreation.md)
+ - [FlatApi::ClassDetails](docs/ClassDetails.md)
+ - [FlatApi::ClassDetailsCanvas](docs/ClassDetailsCanvas.md)
+ - [FlatApi::ClassDetailsClever](docs/ClassDetailsClever.md)
+ - [FlatApi::ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)
+ - [FlatApi::ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)
+ - [FlatApi::ClassDetailsLti](docs/ClassDetailsLti.md)
+ - [FlatApi::ClassRoles](docs/ClassRoles.md)
+ - [FlatApi::ClassState](docs/ClassState.md)
+ - [FlatApi::ClassUpdate](docs/ClassUpdate.md)
+ - [FlatApi::FlatErrorResponse](docs/FlatErrorResponse.md)
+ - [FlatApi::FlatLocales](docs/FlatLocales.md)
+ - [FlatApi::GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
+ - [FlatApi::GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)
+ - [FlatApi::Group](docs/Group.md)
+ - [FlatApi::GroupDetails](docs/GroupDetails.md)
+ - [FlatApi::GroupType](docs/GroupType.md)
+ - [FlatApi::LicenseMode](docs/LicenseMode.md)
+ - [FlatApi::LicenseSources](docs/LicenseSources.md)
+ - [FlatApi::LmsName](docs/LmsName.md)
+ - [FlatApi::LtiCredentials](docs/LtiCredentials.md)
+ - [FlatApi::LtiCredentialsCreation](docs/LtiCredentialsCreation.md)
+ - [FlatApi::MediaAttachment](docs/MediaAttachment.md)
+ - [FlatApi::MediaScoreSharingMode](docs/MediaScoreSharingMode.md)
+ - [FlatApi::OrganizationInvitation](docs/OrganizationInvitation.md)
+ - [FlatApi::OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
+ - [FlatApi::OrganizationRoles](docs/OrganizationRoles.md)
+ - [FlatApi::ScoreCollaborator](docs/ScoreCollaborator.md)
+ - [FlatApi::ScoreCollaboratorCreation](docs/ScoreCollaboratorCreation.md)
+ - [FlatApi::ScoreComment](docs/ScoreComment.md)
+ - [FlatApi::ScoreCommentContext](docs/ScoreCommentContext.md)
+ - [FlatApi::ScoreCommentCreation](docs/ScoreCommentCreation.md)
+ - [FlatApi::ScoreCommentUpdate](docs/ScoreCommentUpdate.md)
+ - [FlatApi::ScoreCommentsCounts](docs/ScoreCommentsCounts.md)
+ - [FlatApi::ScoreCreation](docs/ScoreCreation.md)
+ - [FlatApi::ScoreCreationType](docs/ScoreCreationType.md)
+ - [FlatApi::ScoreData](docs/ScoreData.md)
+ - [FlatApi::ScoreDataEncoding](docs/ScoreDataEncoding.md)
+ - [FlatApi::ScoreFork](docs/ScoreFork.md)
+ - [FlatApi::ScoreLicense](docs/ScoreLicense.md)
+ - [FlatApi::ScoreLikesCounts](docs/ScoreLikesCounts.md)
+ - [FlatApi::ScoreModification](docs/ScoreModification.md)
+ - [FlatApi::ScorePrivacy](docs/ScorePrivacy.md)
+ - [FlatApi::ScoreRevision](docs/ScoreRevision.md)
+ - [FlatApi::ScoreRevisionCreation](docs/ScoreRevisionCreation.md)
+ - [FlatApi::ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)
+ - [FlatApi::ScoreRights](docs/ScoreRights.md)
+ - [FlatApi::ScoreSource](docs/ScoreSource.md)
+ - [FlatApi::ScoreSummary](docs/ScoreSummary.md)
+ - [FlatApi::ScoreTrack](docs/ScoreTrack.md)
+ - [FlatApi::ScoreTrackCreation](docs/ScoreTrackCreation.md)
+ - [FlatApi::ScoreTrackPoint](docs/ScoreTrackPoint.md)
+ - [FlatApi::ScoreTrackState](docs/ScoreTrackState.md)
+ - [FlatApi::ScoreTrackType](docs/ScoreTrackType.md)
+ - [FlatApi::ScoreTrackUpdate](docs/ScoreTrackUpdate.md)
+ - [FlatApi::ScoreViewsCounts](docs/ScoreViewsCounts.md)
+ - [FlatApi::UserAdminUpdate](docs/UserAdminUpdate.md)
+ - [FlatApi::UserBasics](docs/UserBasics.md)
+ - [FlatApi::UserCreation](docs/UserCreation.md)
+ - [FlatApi::UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
+ - [FlatApi::UserInstruments](docs/UserInstruments.md)
+ - [FlatApi::ScoreDetails](docs/ScoreDetails.md)
+ - [FlatApi::UserPublicSummary](docs/UserPublicSummary.md)
+ - [FlatApi::UserDetailsAdmin](docs/UserDetailsAdmin.md)
+ - [FlatApi::UserPublic](docs/UserPublic.md)
+ - [FlatApi::UserDetails](docs/UserDetails.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://flat.io/auth/oauth
+- **Scopes**:
+  - account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile.
+  - account.education_profile: Provides access to the basic person's education profile and public organization information.
+  - scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
+  - scores.social: Allow to post comments and like scores
+  - scores: Full, permissive scope to access all of a user's scores.
+  - edu.classes: Full, permissive scope to manage the classes.
+  - edu.classes.readonly: Read-only access to the classes.
+  - edu.assignments: Read-write access to the assignments and submissions.
+  - edu.assignments.readonly: Read-only access to the assignments and submissions.
+  - edu.admin: Full, permissive scope to manage all the admin of an organization.
+  - edu.admin.lti: Access and manage the LTI Credentials for an organization.
+  - edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
+  - edu.admin.users: Access and manage the users and invitations of the organization.
+  - edu.admin.users.readonly: Read-only access to the users and invitations of the organization.

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,55 @@
+# FlatApi::AccountApi
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_authenticated_user**](AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
+
+
+# **get_authenticated_user**
+> UserDetails get_authenticated_user
+
+Get current user profile
+
+Get details about the current authenticated User. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::AccountApi.new
+
+begin
+  #Get current user profile
+  result = api_instance.get_authenticated_user
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserDetails**](UserDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Assignment.md

@@ -0,0 +1,18 @@
+# FlatApi::Assignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**state** | **String** | State of the assignment | [optional] 
+**title** | **String** | Title of the assignment | [optional] 
+**classroom** | **String** | The unique identifier of the class where this assignment was posted | [optional] 
+**description** | **String** | Description and content of the assignment | [optional] 
+**attachments** | [**Array<MediaAttachment>**](MediaAttachment.md) |  | [optional] 
+**submissions** | [**Array<AssignmentSubmission>**](AssignmentSubmission.md) |  | [optional] 
+**creator** | **String** | The User unique identifier of the creator of this assignment  | [optional] 
+**creation_date** | **DateTime** | The creation date of this assignment | [optional] 
+**scheduled_date** | **DateTime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.  | [optional] 
+**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due.  | [optional] 
+**google_classroom** | [**GoogleClassroomCoursework**](GoogleClassroomCoursework.md) |  | [optional] 
+
+

data/docs/AssignmentCopy.md

@@ -0,0 +1,8 @@
+# FlatApi::AssignmentCopy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classroom** | **String** | The destination classroom where the assignment will be copied | 
+
+

data/docs/AssignmentCreation.md

@@ -0,0 +1,12 @@
+# FlatApi::AssignmentCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the assignment | [optional] 
+**description** | **String** | Description and content of the assignment | [optional] 
+**attachments** | [**Array<ClassAttachmentCreation>**](ClassAttachmentCreation.md) |  | [optional] 
+**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won't have a due date.  | [optional] 
+**scheduled_date** | **DateTime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.  | [optional] 
+
+

data/docs/AssignmentSubmission.md

@@ -0,0 +1,19 @@
+# FlatApi::AssignmentSubmission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the submission | [optional] 
+**classroom** | **String** | Unique identifier of the classroom where the assignment was posted  | [optional] 
+**assignment** | **String** | Unique identifier of the assignment | [optional] 
+**creator** | **String** | The User identifier of the student who created the submission | [optional] 
+**creation_date** | **String** | The date when the submission was created | [optional] 
+**attachments** | [**Array<MediaAttachment>**](MediaAttachment.md) |  | [optional] 
+**submission_date** | **String** | The date when the student submitted his work | [optional] 
+**student_comment** | **String** | An optionnal comment sent by the student when submitting his work  | [optional] 
+**return_date** | **String** | The date when the teacher returned the work | [optional] 
+**return_feedback** | **String** | The feedback associated with the return | [optional] 
+**return_creator** | **String** | The User unique identifier of the teacher who returned the submission  | [optional] 
+**google_classroom** | [**GoogleClassroomSubmission**](GoogleClassroomSubmission.md) |  | [optional] 
+
+

data/docs/AssignmentSubmissionUpdate.md

@@ -0,0 +1,11 @@
+# FlatApi::AssignmentSubmissionUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attachments** | [**Array<ClassAttachmentCreation>**](ClassAttachmentCreation.md) |  | [optional] 
+**student_comment** | **String** | An optionnal comment sent by the student when submitting his work  | [optional] 
+**submit** | **BOOLEAN** | If `true`, the submission will be marked as done | [optional] 
+**return_feedback** | **String** | The feedback associated with the return | [optional] 
+
+

data/docs/ClassApi.md

@@ -0,0 +1,1051 @@
+# FlatApi::ClassApi
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**activate_class**](ClassApi.md#activate_class) | **POST** /classes/{class}/activate | Activate the class
+[**add_class_user**](ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class
+[**archive_class**](ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class
+[**copy_assignment**](ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
+[**create_assignment**](ClassApi.md#create_assignment) | **POST** /classes/{class}/assignments | Assignment creation
+[**create_class**](ClassApi.md#create_class) | **POST** /classes | Create a new class
+[**create_submission**](ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
+[**delete_class_user**](ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
+[**edit_submission**](ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
+[**enroll_class**](ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class
+[**get_class**](ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class
+[**get_score_submissions**](ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
+[**get_submission**](ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
+[**get_submissions**](ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
+[**list_assignments**](ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing
+[**list_class_student_submissions**](ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
+[**list_classes**](ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user
+[**unarchive_class**](ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class
+[**update_class**](ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class
+
+
+# **activate_class**
+> ClassDetails activate_class(_class)
+
+Activate the class
+
+Mark the class as `active`. This is mainly used for classes synchronized from Clever that are initially with an `inactive` state and hidden in the UI. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+
+begin
+  #Activate the class
+  result = api_instance.activate_class(_class)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->activate_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **add_class_user**
+> add_class_user(_class, user)
+
+Add a user to the class
+
+This method can be used by a teacher of the class to enroll another Flat user into the class.  Only users that are part of your Organization can be enrolled in a class of this same Organization.  When enrolling a user in the class, Flat will automatically add this user to the corresponding Class group, based on this role in the Organization. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+user = "user_example" # String | Unique identifier of the user
+
+
+begin
+  #Add a user to the class
+  api_instance.add_class_user(_class, user)
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->add_class_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **user** | **String**| Unique identifier of the user | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **archive_class**
+> ClassDetails archive_class(_class)
+
+Archive the class
+
+Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+
+begin
+  #Archive the class
+  result = api_instance.archive_class(_class)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->archive_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **copy_assignment**
+> Assignment copy_assignment(_class, assignment, body)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+assignment = "assignment_example" # String | Unique identifier of the assignment
+
+body = FlatApi::AssignmentCopy.new # AssignmentCopy | 
+
+
+begin
+  #Copy an assignment
+  result = api_instance.copy_assignment(_class, assignment, body)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->copy_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **assignment** | **String**| Unique identifier of the assignment | 
+ **body** | [**AssignmentCopy**](AssignmentCopy.md)|  | 
+
+### Return type
+
+[**Assignment**](Assignment.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_assignment**
+> Assignment create_assignment(_class, opts)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+opts = { 
+  body: FlatApi::AssignmentCreation.new # AssignmentCreation | 
+}
+
+begin
+  #Assignment creation
+  result = api_instance.create_assignment(_class, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->create_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **body** | [**AssignmentCreation**](AssignmentCreation.md)|  | [optional] 
+
+### Return type
+
+[**Assignment**](Assignment.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_class**
+> ClassDetails create_class(body)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+body = FlatApi::ClassCreation.new # ClassCreation | 
+
+
+begin
+  #Create a new class
+  result = api_instance.create_class(body)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->create_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ClassCreation**](ClassCreation.md)|  | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_submission**
+> AssignmentSubmission create_submission(_class, assignment, body)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+assignment = "assignment_example" # String | Unique identifier of the assignment
+
+body = FlatApi::AssignmentSubmissionUpdate.new # AssignmentSubmissionUpdate | 
+
+
+begin
+  #Create or edit a submission
+  result = api_instance.create_submission(_class, assignment, body)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->create_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **assignment** | **String**| Unique identifier of the assignment | 
+ **body** | [**AssignmentSubmissionUpdate**](AssignmentSubmissionUpdate.md)|  | 
+
+### Return type
+
+[**AssignmentSubmission**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_class_user**
+> delete_class_user(_class, user)
+
+Remove a user from the class
+
+This method can be used by a teacher to remove a user from the class, or by a student to leave the classroom.  Warning: Removing a user from the class will remove the associated resources, including the submissions and feedback related to these submissions. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+user = "user_example" # String | Unique identifier of the user
+
+
+begin
+  #Remove a user from the class
+  api_instance.delete_class_user(_class, user)
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->delete_class_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **user** | **String**| Unique identifier of the user | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **edit_submission**
+> AssignmentSubmission edit_submission(_class, assignment, submission, body)
+
+Edit a submission
+
+Use this method as a teacher to update the different submission and give feedback. Teachers can only set `returnFeedback` 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+assignment = "assignment_example" # String | Unique identifier of the assignment
+
+submission = "submission_example" # String | Unique identifier of the submission
+
+body = FlatApi::AssignmentSubmissionUpdate.new # AssignmentSubmissionUpdate | 
+
+
+begin
+  #Edit a submission
+  result = api_instance.edit_submission(_class, assignment, submission, body)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->edit_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **assignment** | **String**| Unique identifier of the assignment | 
+ **submission** | **String**| Unique identifier of the submission | 
+ **body** | [**AssignmentSubmissionUpdate**](AssignmentSubmissionUpdate.md)|  | 
+
+### Return type
+
+[**AssignmentSubmission**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **enroll_class**
+> ClassDetails enroll_class(enrollment_code)
+
+Join a class
+
+Use this method to join a class using an enrollment code given one of the teacher of this class. This code is also available in the `ClassDetails` returned to the teachers when creating the class or listing / fetching a specific class.  Flat will automatically add the user to the corresponding class group based on this role in the organization. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+enrollment_code = "enrollment_code_example" # String | The enrollment code, available to the teacher in `ClassDetails` 
+
+
+begin
+  #Join a class
+  result = api_instance.enroll_class(enrollment_code)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->enroll_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **enrollment_code** | **String**| The enrollment code, available to the teacher in `ClassDetails`  | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_class**
+> ClassDetails get_class(_class)
+
+Get the details of a single class
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+
+begin
+  #Get the details of a single class
+  result = api_instance.get_class(_class)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->get_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_score_submissions**
+> Array<AssignmentSubmission> get_score_submissions(score, )
+
+List submissions related to the score
+
+This API call will list the different assignments submissions where the score is attached. This method can be used by anyone that are part of the organization and have at least read access to the document. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+score = "score_example" # String | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). 
+
+
+begin
+  #List submissions related to the score
+  result = api_instance.get_score_submissions(score, )
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->get_score_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **score** | **String**| Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).  | 
+
+### Return type
+
+[**Array<AssignmentSubmission>**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_submission**
+> AssignmentSubmission get_submission(_class, assignment, submission)
+
+Get a student submission
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+assignment = "assignment_example" # String | Unique identifier of the assignment
+
+submission = "submission_example" # String | Unique identifier of the submission
+
+
+begin
+  #Get a student submission
+  result = api_instance.get_submission(_class, assignment, submission)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->get_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **assignment** | **String**| Unique identifier of the assignment | 
+ **submission** | **String**| Unique identifier of the submission | 
+
+### Return type
+
+[**AssignmentSubmission**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_submissions**
+> Array<AssignmentSubmission> get_submissions(_class, assignment)
+
+List the students' submissions
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+assignment = "assignment_example" # String | Unique identifier of the assignment
+
+
+begin
+  #List the students' submissions
+  result = api_instance.get_submissions(_class, assignment)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->get_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **assignment** | **String**| Unique identifier of the assignment | 
+
+### Return type
+
+[**Array<AssignmentSubmission>**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_assignments**
+> Array<Assignment> list_assignments(_class)
+
+Assignments listing
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+
+begin
+  #Assignments listing
+  result = api_instance.list_assignments(_class)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->list_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+
+### Return type
+
+[**Array<Assignment>**](Assignment.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_class_student_submissions**
+> Array<AssignmentSubmission> list_class_student_submissions(_class, user)
+
+List the submissions for a student
+
+Use this method as a teacher to list all the assignment submissions sent by a student of the class 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+user = "user_example" # String | Unique identifier of the user
+
+
+begin
+  #List the submissions for a student
+  result = api_instance.list_class_student_submissions(_class, user)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->list_class_student_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **user** | **String**| Unique identifier of the user | 
+
+### Return type
+
+[**Array<AssignmentSubmission>**](AssignmentSubmission.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_classes**
+> Array<ClassDetails> list_classes(opts)
+
+List the classes available for the current user
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+opts = { 
+  state: "active" # String | Filter the classes by state
+}
+
+begin
+  #List the classes available for the current user
+  result = api_instance.list_classes(opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->list_classes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | **String**| Filter the classes by state | [optional] [default to active]
+
+### Return type
+
+[**Array<ClassDetails>**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **unarchive_class**
+> ClassDetails unarchive_class(_class)
+
+Unarchive the class
+
+Mark the class as `active`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated. 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+
+begin
+  #Unarchive the class
+  result = api_instance.unarchive_class(_class)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->unarchive_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_class**
+> ClassDetails update_class(_class, opts)
+
+Update the class
+
+Update the meta information of the class 
+
+### Example
+```ruby
+# load the gem
+require 'flat_api'
+# setup authorization
+FlatApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FlatApi::ClassApi.new
+
+_class = "_class_example" # String | Unique identifier of the class
+
+opts = { 
+  body: FlatApi::ClassUpdate.new # ClassUpdate | Details of the Class
+}
+
+begin
+  #Update the class
+  result = api_instance.update_class(_class, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling ClassApi->update_class: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_class** | **String**| Unique identifier of the class | 
+ **body** | [**ClassUpdate**](ClassUpdate.md)| Details of the Class | [optional] 
+
+### Return type
+
+[**ClassDetails**](ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+