flat_api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9025f173c759fcbc709132102c354e42143d4d6f
-  data.tar.gz: 40f7d15ca1b2851e66aa8a5fd3a5745642ce1358
+  metadata.gz: 6fea1dead831600b117241b809b2d90de9adb548
+  data.tar.gz: 6299f8de69bc2294f4e8e92febdb146c7d1a456d
 SHA512:
-  metadata.gz: c9b059dd84efb99201220c3426f07251c1dd4d93ede80ce637b4aa639e574be4ced5e249a2168701f12901f3958b06768a935c0469786efe8752c8cc30ae1581
-  data.tar.gz: c2a7192280975e474a173bc2ba9cc7a022b1af5191f62cff0b630dfaa0ee2931a7fe5366dabd6b39b2cfbba55c9e40cc19444ba4e5a26745488d2ede805eb454
+  metadata.gz: fd3b6d9e2dc242bb61bc8a50ea3537ac698c466a5f97a35b8de579ad7c43728bff6515ba866a936761694a8c7590ac1da89210aa7324c9697141f6e6f32491f4
+  data.tar.gz: 0b6d20d0ac833e84aae304320911d7cc701a2f59c4ebf6ac680f5036c551bc32e99bd157e41ef22f4b374ad196e79f74bfeb804ee772935172c79775e8534f14

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.0
+
+Spec version 2.6.0
+
 ## 0.1.2
 
 Spec version 2.5.2

data/README.md

@@ -27,15 +27,15 @@ gem build flat_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./flat_api-0.1.2.gem
+gem install ./flat_api-0.2.0.gem
 ```
-(for development, run `gem install --dev ./flat_api-0.1.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./flat_api-0.2.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.2'
+    gem 'flat_api', '~> 0.2.0'
 
 ### Install from Git
 
@@ -102,6 +102,15 @@ Class | Method | HTTP request | Description
 *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::CollectionApi* | [**add_score_to_collection**](docs/CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection
+*FlatApi::CollectionApi* | [**create_collection**](docs/CollectionApi.md#create_collection) | **POST** /collections | Create a new collection
+*FlatApi::CollectionApi* | [**delete_collection**](docs/CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection
+*FlatApi::CollectionApi* | [**delete_score_from_collection**](docs/CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection
+*FlatApi::CollectionApi* | [**edit_collection**](docs/CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata
+*FlatApi::CollectionApi* | [**get_collection**](docs/CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details
+*FlatApi::CollectionApi* | [**list_collection_scores**](docs/CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection
+*FlatApi::CollectionApi* | [**list_collections**](docs/CollectionApi.md#list_collections) | **GET** /collections | List the collections
+*FlatApi::CollectionApi* | [**untrash_collection**](docs/CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection
 *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
@@ -141,6 +150,7 @@ Class | Method | HTTP request | Description
 *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* | [**untrash_score**](docs/ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score
 *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
@@ -166,6 +176,13 @@ Class | Method | HTTP request | Description
  - [FlatApi::ClassRoles](docs/ClassRoles.md)
  - [FlatApi::ClassState](docs/ClassState.md)
  - [FlatApi::ClassUpdate](docs/ClassUpdate.md)
+ - [FlatApi::Collection](docs/Collection.md)
+ - [FlatApi::CollectionCapabilities](docs/CollectionCapabilities.md)
+ - [FlatApi::CollectionCreation](docs/CollectionCreation.md)
+ - [FlatApi::CollectionModification](docs/CollectionModification.md)
+ - [FlatApi::CollectionPrivacy](docs/CollectionPrivacy.md)
+ - [FlatApi::CollectionTitle](docs/CollectionTitle.md)
+ - [FlatApi::CollectionType](docs/CollectionType.md)
  - [FlatApi::FlatErrorResponse](docs/FlatErrorResponse.md)
  - [FlatApi::FlatLocales](docs/FlatLocales.md)
  - [FlatApi::GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
@@ -183,8 +200,9 @@ Class | Method | HTTP request | Description
  - [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::ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md)
+ - [FlatApi::ResourceRights](docs/ResourceRights.md)
+ - [FlatApi::ResourceSharingKey](docs/ResourceSharingKey.md)
  - [FlatApi::ScoreComment](docs/ScoreComment.md)
  - [FlatApi::ScoreCommentContext](docs/ScoreCommentContext.md)
  - [FlatApi::ScoreCommentCreation](docs/ScoreCommentCreation.md)
@@ -202,7 +220,6 @@ Class | Method | HTTP request | Description
  - [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)
@@ -217,6 +234,7 @@ Class | Method | HTTP request | Description
  - [FlatApi::UserCreation](docs/UserCreation.md)
  - [FlatApi::UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
  - [FlatApi::UserInstruments](docs/UserInstruments.md)
+ - [FlatApi::ResourceCollaborator](docs/ResourceCollaborator.md)
  - [FlatApi::ScoreDetails](docs/ScoreDetails.md)
  - [FlatApi::UserPublicSummary](docs/UserPublicSummary.md)
  - [FlatApi::UserDetailsAdmin](docs/UserDetailsAdmin.md)
@@ -232,12 +250,15 @@ Class | Method | HTTP request | Description
 - **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.
+- **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. 
+  - collections.readonly: Allow read-only access to a user's collections.
+  - collections.add_scores: Allow to add scores to a user's collections.
+  - collections: Full, permissive scope to access all of a user's collections.
   - 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.
@@ -247,3 +268,4 @@ Class | Method | HTTP request | Description
   - 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/docs/ClassApi.md

@@ -625,7 +625,7 @@ Name | Type | Description  | Notes
 
 
 # **get_score_submissions**
-> Array<AssignmentSubmission> get_score_submissions(score, )
+> Array<AssignmentSubmission> get_score_submissions(score)
 
 List submissions related to the score
 
@@ -648,7 +648,7 @@ score = "score_example" # String | Unique identifier of the score document. This
 
 begin
   #List submissions related to the score
-  result = api_instance.get_score_submissions(score, )
+  result = api_instance.get_score_submissions(score)
   p result
 rescue FlatApi::ApiError => e
   puts "Exception when calling ClassApi->get_score_submissions: #{e}"

data/docs/Collection.md

@@ -0,0 +1,18 @@
+# FlatApi::Collection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the collection | [optional] 
+**title** | [**CollectionTitle**](CollectionTitle.md) |  | [optional] 
+**html_url** | **String** | The url where the collection can be viewed in a web browser | [optional] 
+**type** | [**CollectionType**](CollectionType.md) |  | [optional] 
+**privacy** | [**CollectionPrivacy**](CollectionPrivacy.md) |  | [optional] 
+**sharing_key** | **String** | The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`) | [optional] 
+**app** | **String** | If this directory is dedicated to an app, the unique idenfier of this app | [optional] 
+**user** | [**UserPublicSummary**](UserPublicSummary.md) |  | [optional] 
+**rights** | [**ResourceRights**](ResourceRights.md) |  | [optional] 
+**collaborators** | [**Array<ResourceCollaborator>**](ResourceCollaborator.md) | The list of the collaborators of the collection | [optional] 
+**capabilities** | [**CollectionCapabilities**](CollectionCapabilities.md) |  | [optional] 
+
+

data/docs/CollectionApi.md

@@ -0,0 +1,521 @@
+# FlatApi::CollectionApi
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_score_to_collection**](CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection
+[**create_collection**](CollectionApi.md#create_collection) | **POST** /collections | Create a new collection
+[**delete_collection**](CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection
+[**delete_score_from_collection**](CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection
+[**edit_collection**](CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata
+[**get_collection**](CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details
+[**list_collection_scores**](CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection
+[**list_collections**](CollectionApi.md#list_collections) | **GET** /collections | List the collections
+[**untrash_collection**](CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection
+
+
+# **add_score_to_collection**
+> ScoreDetails add_score_to_collection(collection, score, opts)
+
+Add a score to the collection
+
+This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability `canAddScores` on the provided `collection` to perform the action. 
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+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`). 
+
+opts = { 
+  sharing_key: "sharing_key_example" # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
+}
+
+begin
+  #Add a score to the collection
+  result = api_instance.add_score_to_collection(collection, score, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->add_score_to_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+ **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`).  | 
+ **sharing_key** | **String**| This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.  | [optional] 
+
+### Return type
+
+[**ScoreDetails**](ScoreDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_collection**
+> Collection create_collection(body)
+
+Create a new collection
+
+This method will create a new collection and add it to your `root` collection. 
+
+### 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::CollectionApi.new
+
+body = FlatApi::CollectionCreation.new # CollectionCreation | 
+
+
+begin
+  #Create a new collection
+  result = api_instance.create_collection(body)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->create_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CollectionCreation**](CollectionCreation.md)|  | 
+
+### Return type
+
+[**Collection**](Collection.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_collection**
+> delete_collection(collection, )
+
+Delete the collection
+
+This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`. 
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+
+begin
+  #Delete the collection
+  api_instance.delete_collection(collection, )
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->delete_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_score_from_collection**
+> delete_score_from_collection(collection, score)
+
+Delete a score from the collection
+
+This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections. 
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+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
+  #Delete a score from the collection
+  api_instance.delete_score_from_collection(collection, score)
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->delete_score_from_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+ **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
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **edit_collection**
+> Collection edit_collection(collection, , opts)
+
+Update a collection's metadata
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+opts = { 
+  body: FlatApi::CollectionModification.new # CollectionModification | 
+}
+
+begin
+  #Update a collection's metadata
+  result = api_instance.edit_collection(collection, , opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->edit_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+ **body** | [**CollectionModification**](CollectionModification.md)|  | [optional] 
+
+### Return type
+
+[**Collection**](Collection.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_collection**
+> Collection get_collection(collection, , opts)
+
+Get collection details
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+opts = { 
+  sharing_key: "sharing_key_example" # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
+}
+
+begin
+  #Get collection details
+  result = api_instance.get_collection(collection, , opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->get_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+ **sharing_key** | **String**| This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.  | [optional] 
+
+### Return type
+
+[**Collection**](Collection.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_collection_scores**
+> Array<ScoreDetails> list_collection_scores(collection, , opts)
+
+List the scores contained in a collection
+
+Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. 
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+opts = { 
+  sharing_key: "sharing_key_example" # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
+  sort: "sort_example", # String | Sort
+  direction: "direction_example", # String | Sort direction
+  limit: 25, # Integer | This is the maximum number of objects that may be returned
+  _next: "_next_example", # String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
+  previous: "previous_example" # String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
+}
+
+begin
+  #List the scores contained in a collection
+  result = api_instance.list_collection_scores(collection, , opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->list_collection_scores: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+ **sharing_key** | **String**| This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.  | [optional] 
+ **sort** | **String**| Sort | [optional] 
+ **direction** | **String**| Sort direction | [optional] 
+ **limit** | **Integer**| This is the maximum number of objects that may be returned | [optional] [default to 25]
+ **_next** | **String**| An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.  | [optional] 
+ **previous** | **String**| An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.  | [optional] 
+
+### Return type
+
+[**Array<ScoreDetails>**](ScoreDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_collections**
+> Array<Collection> list_collections(opts)
+
+List the collections
+
+Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`.  Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`. 
+
+### 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::CollectionApi.new
+
+opts = { 
+  parent: "root", # String | List the collection contained in this `parent` collection.  This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`. 
+  sort: "sort_example", # String | Sort
+  direction: "direction_example", # String | Sort direction
+  limit: 25, # Integer | This is the maximum number of objects that may be returned
+  _next: "_next_example", # String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
+  previous: "previous_example" # String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
+}
+
+begin
+  #List the collections
+  result = api_instance.list_collections(opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->list_collections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent** | **String**| List the collection contained in this `parent` collection.  This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`.  | [optional] [default to root]
+ **sort** | **String**| Sort | [optional] 
+ **direction** | **String**| Sort direction | [optional] 
+ **limit** | **Integer**| This is the maximum number of objects that may be returned | [optional] [default to 25]
+ **_next** | **String**| An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.  | [optional] 
+ **previous** | **String**| An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.  | [optional] 
+
+### Return type
+
+[**Array<Collection>**](Collection.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **untrash_collection**
+> untrash_collection(collection, )
+
+Untrash a collection
+
+This method will restore the collection by removing it from the `trash` and add it back to the `root` collection. 
+
+### 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::CollectionApi.new
+
+collection = "collection_example" # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
+
+
+begin
+  #Untrash a collection
+  api_instance.untrash_collection(collection, )
+rescue FlatApi::ApiError => e
+  puts "Exception when calling CollectionApi->untrash_collection: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection** | **String**| Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+