flat_api 0.2.0 → 1.0.0

data/docs/ClassAttachmentCreation.md

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

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

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

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

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

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

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

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

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

data/docs/ClassState.md

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

data/docs/ClassUpdate.md

@@ -1,9 +0,0 @@
-# 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/Collection.md

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

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