flat_api 0.2.0 → 1.0.0

data/docs/CollectionCapabilities.md

@@ -1,12 +0,0 @@
-# FlatApi::CollectionCapabilities
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**can_edit** | **BOOLEAN** | Whether the current user can modify the metadata for the collection  | [optional] 
-**can_share** | **BOOLEAN** | Whether the current user can modify the sharing settings for the collection  | [optional] 
-**can_delete** | **BOOLEAN** | Whether the current user can delete the collection  | [optional] 
-**can_add_scores** | **BOOLEAN** | Whether the current user can add scores to the collection  If this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score.  | [optional] 
-**can_delete_scores** | **BOOLEAN** | Whether the current user can delete scores from the collection  If this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score.  | [optional] 
-
-

data/docs/CollectionCreation.md

@@ -1,8 +0,0 @@
-# FlatApi::CollectionCreation
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | [**CollectionTitle**](CollectionTitle.md) |  | 
-
-

data/docs/CollectionModification.md

@@ -1,8 +0,0 @@
-# FlatApi::CollectionModification
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | [**CollectionTitle**](CollectionTitle.md) |  | [optional] 
-
-

data/docs/CollectionPrivacy.md

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

data/docs/CollectionTitle.md

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

data/docs/CollectionType.md

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

data/docs/FlatErrorResponse.md

@@ -1,11 +0,0 @@
-# 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

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

data/docs/GoogleClassroomCoursework.md

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,14 +0,0 @@
-# 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

@@ -1,167 +0,0 @@
-# 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

@@ -1,14 +0,0 @@
-# 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

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

data/docs/LicenseMode.md

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

data/docs/LicenseSources.md

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

data/docs/LmsName.md

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

data/docs/LtiCredentials.md

@@ -1,16 +0,0 @@
-# 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

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

data/docs/MediaAttachment.md

@@ -1,23 +0,0 @@
-# FlatApi::MediaAttachment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | The type of the assignment resolved: * `rich`, `photo`, `video` are attachment types that are automatically resolved from a `link` attachment. * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property.  | [optional] 
-**score** | **String** | An unique Flat score identifier | [optional] 
-**revision** | **String** | An unique revision identifier of a score | [optional] 
-**correct** | **BOOLEAN** | If the attachment is an exercise question, this state will describe if it is correct or not.For exercise assignments only. | [optional] 
-**sharing_mode** | [**MediaScoreSharingMode**](MediaScoreSharingMode.md) |  | [optional] 
-**title** | **String** | The resolved title of the attachment | [optional] 
-**description** | **String** | The resolved description of the attachment | [optional] 
-**html** | **String** | If the attachment type is `rich` or `video`, the HTML code of the media to display  | [optional] 
-**html_width** | **String** | If the `html` is available, the width of the widget | [optional] 
-**html_height** | **String** | If the `html` is available, the height of the widget | [optional] 
-**url** | **String** | The url of the attachment | [optional] 
-**thumbnail_url** | **String** | If the attachment type is `rich`, `video`, `photo` or `link`, a displayable thumbnail for this attachment  | [optional] 
-**thumbnail_width** | **String** | If the `thumbnailUrl` is available, the width of the thumbnail  | [optional] 
-**thumbnail_height** | **String** | If the `thumbnailUrl` is available, the width of the thumbnail  | [optional] 
-**author_name** | **String** | The resolved author name of the attachment | [optional] 
-**author_url** | **String** | The resolved author url of the attachment | [optional] 
-
-

data/docs/MediaScoreSharingMode.md

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