Skip to content

Commit 1b30b03

Browse files
committed
feat(client): Update to API specification v2.6.0
1 parent 55a81a3 commit 1b30b03

File tree

206 files changed

+3879
-567
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

206 files changed

+3879
-567
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 0.2.0
4+
5+
Spec version 2.6.0
6+
37
## 0.1.2
48

59
Spec version 2.5.2

README.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ gem build flat_api.gemspec
2727
Then either install the gem locally:
2828

2929
```shell
30-
gem install ./flat_api-0.1.2.gem
30+
gem install ./flat_api-0.2.0.gem
3131
```
32-
(for development, run `gem install --dev ./flat_api-0.1.2.gem` to install the development dependencies)
32+
(for development, run `gem install --dev ./flat_api-0.2.0.gem` to install the development dependencies)
3333

3434
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
3535

3636
Finally add this to the Gemfile:
3737

38-
gem 'flat_api', '~> 0.1.2'
38+
gem 'flat_api', '~> 0.2.0'
3939

4040
### Install from Git
4141

@@ -102,6 +102,15 @@ Class | Method | HTTP request | Description
102102
*FlatApi::ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user
103103
*FlatApi::ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class
104104
*FlatApi::ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class
105+
*FlatApi::CollectionApi* | [**add_score_to_collection**](docs/CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection
106+
*FlatApi::CollectionApi* | [**create_collection**](docs/CollectionApi.md#create_collection) | **POST** /collections | Create a new collection
107+
*FlatApi::CollectionApi* | [**delete_collection**](docs/CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection
108+
*FlatApi::CollectionApi* | [**delete_score_from_collection**](docs/CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection
109+
*FlatApi::CollectionApi* | [**edit_collection**](docs/CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata
110+
*FlatApi::CollectionApi* | [**get_collection**](docs/CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details
111+
*FlatApi::CollectionApi* | [**list_collection_scores**](docs/CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection
112+
*FlatApi::CollectionApi* | [**list_collections**](docs/CollectionApi.md#list_collections) | **GET** /collections | List the collections
113+
*FlatApi::CollectionApi* | [**untrash_collection**](docs/CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection
105114
*FlatApi::GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information
106115
*FlatApi::GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
107116
*FlatApi::GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users
@@ -141,6 +150,7 @@ Class | Method | HTTP request | Description
141150
*FlatApi::ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
142151
*FlatApi::ScoreApi* | [**post_score_comment**](docs/ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment
143152
*FlatApi::ScoreApi* | [**remove_score_collaborator**](docs/ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator
153+
*FlatApi::ScoreApi* | [**untrash_score**](docs/ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score
144154
*FlatApi::ScoreApi* | [**update_score_comment**](docs/ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment
145155
*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
146156
*FlatApi::UserApi* | [**ger_user_likes**](docs/UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
@@ -166,6 +176,13 @@ Class | Method | HTTP request | Description
166176
- [FlatApi::ClassRoles](docs/ClassRoles.md)
167177
- [FlatApi::ClassState](docs/ClassState.md)
168178
- [FlatApi::ClassUpdate](docs/ClassUpdate.md)
179+
- [FlatApi::Collection](docs/Collection.md)
180+
- [FlatApi::CollectionCapabilities](docs/CollectionCapabilities.md)
181+
- [FlatApi::CollectionCreation](docs/CollectionCreation.md)
182+
- [FlatApi::CollectionModification](docs/CollectionModification.md)
183+
- [FlatApi::CollectionPrivacy](docs/CollectionPrivacy.md)
184+
- [FlatApi::CollectionTitle](docs/CollectionTitle.md)
185+
- [FlatApi::CollectionType](docs/CollectionType.md)
169186
- [FlatApi::FlatErrorResponse](docs/FlatErrorResponse.md)
170187
- [FlatApi::FlatLocales](docs/FlatLocales.md)
171188
- [FlatApi::GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
@@ -183,8 +200,9 @@ Class | Method | HTTP request | Description
183200
- [FlatApi::OrganizationInvitation](docs/OrganizationInvitation.md)
184201
- [FlatApi::OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
185202
- [FlatApi::OrganizationRoles](docs/OrganizationRoles.md)
186-
- [FlatApi::ScoreCollaborator](docs/ScoreCollaborator.md)
187-
- [FlatApi::ScoreCollaboratorCreation](docs/ScoreCollaboratorCreation.md)
203+
- [FlatApi::ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md)
204+
- [FlatApi::ResourceRights](docs/ResourceRights.md)
205+
- [FlatApi::ResourceSharingKey](docs/ResourceSharingKey.md)
188206
- [FlatApi::ScoreComment](docs/ScoreComment.md)
189207
- [FlatApi::ScoreCommentContext](docs/ScoreCommentContext.md)
190208
- [FlatApi::ScoreCommentCreation](docs/ScoreCommentCreation.md)
@@ -202,7 +220,6 @@ Class | Method | HTTP request | Description
202220
- [FlatApi::ScoreRevision](docs/ScoreRevision.md)
203221
- [FlatApi::ScoreRevisionCreation](docs/ScoreRevisionCreation.md)
204222
- [FlatApi::ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)
205-
- [FlatApi::ScoreRights](docs/ScoreRights.md)
206223
- [FlatApi::ScoreSource](docs/ScoreSource.md)
207224
- [FlatApi::ScoreSummary](docs/ScoreSummary.md)
208225
- [FlatApi::ScoreTrack](docs/ScoreTrack.md)
@@ -217,6 +234,7 @@ Class | Method | HTTP request | Description
217234
- [FlatApi::UserCreation](docs/UserCreation.md)
218235
- [FlatApi::UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
219236
- [FlatApi::UserInstruments](docs/UserInstruments.md)
237+
- [FlatApi::ResourceCollaborator](docs/ResourceCollaborator.md)
220238
- [FlatApi::ScoreDetails](docs/ScoreDetails.md)
221239
- [FlatApi::UserPublicSummary](docs/UserPublicSummary.md)
222240
- [FlatApi::UserDetailsAdmin](docs/UserDetailsAdmin.md)
@@ -232,12 +250,15 @@ Class | Method | HTTP request | Description
232250
- **Type**: OAuth
233251
- **Flow**: accessCode
234252
- **Authorization URL**: https://flat.io/auth/oauth
235-
- **Scopes**:
236-
- 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.
237-
- account.education_profile: Provides access to the basic person's education profile and public organization information.
238-
- scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
239-
- scores.social: Allow to post comments and like scores
240-
- scores: Full, permissive scope to access all of a user's scores.
253+
- **Scopes**:
254+
- 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.
255+
- account.education_profile: Provides access to the basic person's education profile and public organization information.
256+
- scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
257+
- scores.social: Allow to post comments and like scores
258+
- scores: Full, permissive scope to access all of a user's scores.
259+
- collections.readonly: Allow read-only access to a user's collections.
260+
- collections.add_scores: Allow to add scores to a user's collections.
261+
- collections: Full, permissive scope to access all of a user's collections.
241262
- edu.classes: Full, permissive scope to manage the classes.
242263
- edu.classes.readonly: Read-only access to the classes.
243264
- edu.assignments: Read-write access to the assignments and submissions.
@@ -247,3 +268,4 @@ Class | Method | HTTP request | Description
247268
- edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
248269
- edu.admin.users: Access and manage the users and invitations of the organization.
249270
- edu.admin.users.readonly: Read-only access to the users and invitations of the organization.
271+

docs/ClassApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,7 @@ Name | Type | Description | Notes
625625

626626

627627
# **get_score_submissions**
628-
> Array<AssignmentSubmission> get_score_submissions(score, )
628+
> Array<AssignmentSubmission> get_score_submissions(score)
629629
630630
List submissions related to the score
631631

@@ -648,7 +648,7 @@ score = "score_example" # String | Unique identifier of the score document. This
648648

649649
begin
650650
#List submissions related to the score
651-
result = api_instance.get_score_submissions(score, )
651+
result = api_instance.get_score_submissions(score)
652652
p result
653653
rescue FlatApi::ApiError => e
654654
puts "Exception when calling ClassApi->get_score_submissions: #{e}"

docs/Collection.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# FlatApi::Collection
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | Unique identifier of the collection | [optional]
7+
**title** | [**CollectionTitle**](CollectionTitle.md) | | [optional]
8+
**html_url** | **String** | The url where the collection can be viewed in a web browser | [optional]
9+
**type** | [**CollectionType**](CollectionType.md) | | [optional]
10+
**privacy** | [**CollectionPrivacy**](CollectionPrivacy.md) | | [optional]
11+
**sharing_key** | **String** | The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`) | [optional]
12+
**app** | **String** | If this directory is dedicated to an app, the unique idenfier of this app | [optional]
13+
**user** | [**UserPublicSummary**](UserPublicSummary.md) | | [optional]
14+
**rights** | [**ResourceRights**](ResourceRights.md) | | [optional]
15+
**collaborators** | [**Array<ResourceCollaborator>**](ResourceCollaborator.md) | The list of the collaborators of the collection | [optional]
16+
**capabilities** | [**CollectionCapabilities**](CollectionCapabilities.md) | | [optional]
17+
18+

0 commit comments

Comments
 (0)