flat_api 0.1.0

data/docs/ClassAttachmentCreation.md

@@ -0,0 +1,10 @@
+# FlatApi::ClassAttachmentCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the attachment posted | [optional] 
+**score** | **String** | A unique Flat score identifier. The user creating the assignment must at least have read access to the document. If the user has admin rights, new group permissions will be automatically added for the teachers and students of the class.  | [optional] 
+**url** | **String** | The URL of the attachment. | [optional] 
+
+

data/docs/ClassCreation.md

@@ -0,0 +1,9 @@
+# FlatApi::ClassCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the new class | 
+**section** | **String** | The section of the new class | [optional] 
+
+

data/docs/ClassDetails.md

@@ -0,0 +1,25 @@
+# FlatApi::ClassDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the class | [optional] 
+**state** | [**ClassState**](ClassState.md) |  | [optional] 
+**name** | **String** | The name of the class | [optional] 
+**section** | **String** | The section of the class | [optional] 
+**description** | **String** | An optionnal description for this class | [optional] 
+**organization** | **String** | The unique identifier of the Organization owning this class | [optional] 
+**owner** | **String** | The unique identifier of the User owning this class | [optional] 
+**creation_date** | **DateTime** | The date when the class was create | [optional] 
+**enrollment_code** | **String** | [Teachers only] The enrollment code that can be used by the students to join the class  | [optional] 
+**theme** | **String** | The theme identifier using in Flat User Interface | [optional] 
+**assignments_count** | **Float** | The number of assignments created in the class | [optional] 
+**students_group** | [**GroupDetails**](GroupDetails.md) |  | [optional] 
+**teachers_group** | [**GroupDetails**](GroupDetails.md) |  | [optional] 
+**google_classroom** | [**ClassDetailsGoogleClassroom**](ClassDetailsGoogleClassroom.md) |  | [optional] 
+**google_drive** | [**ClassDetailsGoogleDrive**](ClassDetailsGoogleDrive.md) |  | [optional] 
+**lti** | [**ClassDetailsLti**](ClassDetailsLti.md) |  | [optional] 
+**canvas** | [**ClassDetailsCanvas**](ClassDetailsCanvas.md) |  | [optional] 
+**clever** | [**ClassDetailsClever**](ClassDetailsClever.md) |  | [optional] 
+
+

data/docs/ClassDetailsCanvas.md

@@ -0,0 +1,9 @@
+# FlatApi::ClassDetailsCanvas
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the course on Canvas | [optional] 
+**domain** | **String** | Canvas instance domain (e.g. \"canvas.instructure.com\") | [optional] 
+
+

data/docs/ClassDetailsClever.md

@@ -0,0 +1,14 @@
+# FlatApi::ClassDetailsClever
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Clever section unique identifier | [optional] 
+**creation_date** | **DateTime** | The creation date of the section on clever | [optional] 
+**modification_date** | **DateTime** | The last modification date of the section on clever | [optional] 
+**subject** | **String** | Normalized subject of the course | [optional] 
+**term_name** | **String** | Name of the term when this course happens | [optional] 
+**term_start_date** | **DateTime** | Beginning date of the term | [optional] 
+**term_end_date** | **DateTime** | End date of the term | [optional] 
+
+

data/docs/ClassDetailsGoogleClassroom.md

@@ -0,0 +1,11 @@
+# FlatApi::ClassDetailsGoogleClassroom
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The course identifier on Google Classroom | [optional] 
+**alternate_link** | **String** | Absolute link to this course in the Classroom web UI | [optional] 
+**name** | **String** | The name of the course on Google Classroom | [optional] 
+**section** | **String** | The section of the course on Google Classroom | [optional] 
+
+

data/docs/ClassDetailsGoogleDrive.md

@@ -0,0 +1,9 @@
+# FlatApi::ClassDetailsGoogleDrive
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**teacher_folder_id** | **String** | [Teachers only] The Drive directory identifier of the teachers' folder  | [optional] 
+**teacher_folder_alternate_link** | **String** | [Teachers only] The Drive URL of the teachers' folder  | [optional] 
+
+

data/docs/ClassDetailsLti.md

@@ -0,0 +1,10 @@
+# FlatApi::ClassDetailsLti
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context_id** | **String** | Unique context identifier provided | [optional] 
+**context_title** | **String** | Context title | [optional] 
+**context_label** | **String** | Context label | [optional] 
+
+

data/docs/ClassRoles.md

@@ -0,0 +1,7 @@
+# FlatApi::ClassRoles
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ClassState.md

@@ -0,0 +1,7 @@
+# FlatApi::ClassState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ClassUpdate.md

@@ -0,0 +1,9 @@
+# FlatApi::ClassUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the class | [optional] 
+**section** | **String** | The section of the class | [optional] 
+
+

data/docs/FlatErrorResponse.md

@@ -0,0 +1,11 @@
+# FlatApi::FlatErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | A corresponding code for this error | [optional] 
+**message** | **String** | A printable message for this message | [optional] 
+**id** | **String** | An unique error identifier generated for the request | [optional] 
+**param** | **String** | The related parameter that caused the error | [optional] 
+
+

data/docs/FlatLocales.md

@@ -0,0 +1,7 @@
+# FlatApi::FlatLocales
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/GoogleClassroomCoursework.md

@@ -0,0 +1,10 @@
+# FlatApi::GoogleClassroomCoursework
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Identifier of the coursework assigned by Classroom | [optional] 
+**state** | **String** | State of the coursework | [optional] 
+**alternate_link** | **String** | Absolute link to this coursework in the Classroom web UI | [optional] 
+
+

data/docs/GoogleClassroomSubmission.md

@@ -0,0 +1,10 @@
+# FlatApi::GoogleClassroomSubmission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Identifier of the coursework submission assigned by Classroom | [optional] 
+**state** | **String** | State of the submission on Google Classroom | [optional] 
+**alternate_link** | **String** | Absolute link to this coursework in the Classroom web UI | [optional] 
+
+

data/docs/Group.md

@@ -0,0 +1,14 @@
+# FlatApi::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the group | [optional] 
+**name** | **String** | The display name of the group | [optional] 
+**type** | **String** | The type of the group: * `generic`: A group created by a Flat user * `classTeachers`: A group created automaticaly by Flat that contains   the teachers of a class * `classStudents`: A group created automaticaly by Flat that contains   the studnets of a class  | [optional] 
+**users_count** | **Float** | The number of users in this group | [optional] 
+**read_only** | **BOOLEAN** | `True` if the group is set in read-only  | [optional] 
+**organization** | **String** | If the group is related to an organization, this field will contain the unique identifier of the organization  | [optional] 
+**creation_date** | **DateTime** | The creation date of the group | [optional] 
+
+

data/docs/GroupApi.md

@@ -0,0 +1,167 @@
+# FlatApi::GroupApi
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_group_details**](GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information
+[**get_group_scores**](GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
+[**list_group_users**](GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users
+
+
+# **get_group_details**
+> GroupDetails get_group_details(group)
+
+Get group information
+
+### 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::GroupApi.new
+
+group = "group_example" # String | Unique identifier of a Flat group 
+
+
+begin
+  #Get group information
+  result = api_instance.get_group_details(group)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling GroupApi->get_group_details: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group** | **String**| Unique identifier of a Flat group  | 
+
+### Return type
+
+[**GroupDetails**](GroupDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_group_scores**
+> Array<ScoreDetails> get_group_scores(group, opts)
+
+List group's scores
+
+Get the list of scores shared with a group. 
+
+### 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::GroupApi.new
+
+group = "group_example" # String | Unique identifier of a Flat group 
+
+opts = { 
+  parent: "parent_example" # String | Filter the score forked from the score id `parent`
+}
+
+begin
+  #List group's scores
+  result = api_instance.get_group_scores(group, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling GroupApi->get_group_scores: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group** | **String**| Unique identifier of a Flat group  | 
+ **parent** | **String**| Filter the score forked from the score id `parent` | [optional] 
+
+### Return type
+
+[**Array<ScoreDetails>**](ScoreDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_group_users**
+> Array<UserPublic> list_group_users(group)
+
+List group's users
+
+### 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::GroupApi.new
+
+group = "group_example" # String | Unique identifier of a Flat group 
+
+
+begin
+  #List group's users
+  result = api_instance.list_group_users(group)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling GroupApi->list_group_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group** | **String**| Unique identifier of a Flat group  | 
+
+### Return type
+
+[**Array<UserPublic>**](UserPublic.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GroupDetails.md

@@ -0,0 +1,14 @@
+# FlatApi::GroupDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the group | [optional] 
+**name** | **String** | The displayable name of the group | [optional] 
+**type** | [**GroupType**](GroupType.md) |  | [optional] 
+**organization** | **String** | The unique identifier of the Organization owning the group | [optional] 
+**creation_date** | **DateTime** | The date when the group was create | [optional] 
+**users_count** | **Float** | The number of students in this group | [optional] 
+**read_only** | **BOOLEAN** | `true` if the properties and members of this group are in in read-only  | [optional] 
+
+

data/docs/GroupType.md

@@ -0,0 +1,7 @@
+# FlatApi::GroupType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/LicenseMode.md

@@ -0,0 +1,7 @@
+# FlatApi::LicenseMode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/LicenseSources.md

@@ -0,0 +1,7 @@
+# FlatApi::LicenseSources
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/LmsName.md

@@ -0,0 +1,7 @@
+# FlatApi::LmsName
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/LtiCredentials.md

@@ -0,0 +1,16 @@
+# FlatApi::LtiCredentials
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of this couple of credentials | [optional] 
+**name** | **String** | Name of the couple of credentials | [optional] 
+**lms** | [**LmsName**](LmsName.md) |  | [optional] 
+**organization** | **String** | The unique identifier of the Organization associated to these credentials | [optional] 
+**creator** | **String** | Unique identifier of the user who created these credentials | [optional] 
+**creation_date** | **DateTime** | The creation date of thse credentials | [optional] 
+**last_usage** | **DateTime** | The last time these credentials were used | [optional] 
+**consumer_key** | **String** | OAuth 1 Consumer Key | [optional] 
+**consumer_secret** | **String** | OAuth 1 Consumer Secret | [optional] 
+
+

data/docs/LtiCredentialsCreation.md

@@ -0,0 +1,9 @@
+# FlatApi::LtiCredentialsCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the couple of credentials | 
+**lms** | [**LmsName**](LmsName.md) |  | 
+
+