flat_api 0.1.0

data/docs/ScoreCollaborator.md

@@ -0,0 +1,15 @@
+# FlatApi::ScoreCollaborator
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the score permission | [optional] 
+**score** | **String** | The unique identifier of the score | [optional] 
+**user** | [**UserPublic**](UserPublic.md) |  | [optional] 
+**group** | [**Group**](Group.md) |  | [optional] 
+**user_email** | **String** | If the collaborator is not a user of Flat yet, this field will contain his email.  | [optional] 
+**acl_read** | **BOOLEAN** | `True` if the related user can read the score. (probably true if the user has a permission on the document).  | [optional] [default to true]
+**acl_write** | **BOOLEAN** | `True` if the related user can modify the score.  | [optional] [default to false]
+**acl_admin** | **BOOLEAN** | `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document  | [optional] [default to false]
+
+

data/docs/ScoreCollaboratorCreation.md

@@ -0,0 +1,13 @@
+# FlatApi::ScoreCollaboratorCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** | The unique identifier of a Flat user | [optional] 
+**group** | **String** | The unique identifier of a Flat group | [optional] 
+**user_email** | **String** | Fill this field to invite an individual user by email.  | [optional] 
+**acl_read** | **BOOLEAN** | `True` if the related user can read the score. (probably true if the user has a permission on the document).  | [optional] [default to true]
+**acl_write** | **BOOLEAN** | `True` if the related user can modify the score.  | [optional] [default to false]
+**acl_admin** | **BOOLEAN** | `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document  | [optional] [default to false]
+
+

data/docs/ScoreComment.md

@@ -0,0 +1,22 @@
+# FlatApi::ScoreComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The comment unique identifier | [optional] 
+**type** | **String** | The type of the comment | [optional] 
+**user** | **String** | The author unique identifier | [optional] 
+**score** | **String** | The unique identifier of the score where the comment was posted | [optional] 
+**revision** | **String** | The unique identifier of revision the comment was posted | [optional] 
+**reply_to** | **String** | When the comment is a reply to another comment, the unique identifier of the parent comment  | [optional] 
+**date** | **DateTime** | The date when the comment was posted | [optional] 
+**modification_date** | **DateTime** | The date of the last comment modification | [optional] 
+**comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`.  | [optional] 
+**raw_comment** | **String** | A raw version of the comment, that can be displayed without parsing the mentions.  | [optional] 
+**context** | [**ScoreCommentContext**](ScoreCommentContext.md) |  | [optional] 
+**mentions** | **Array<String>** | The list of user identifier mentioned on the score | [optional] 
+**resolved** | **BOOLEAN** | For inline comments, the comment can be marked as resolved and will be hidden in the future responses  | [optional] 
+**resolved_by** | **String** | If the user is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved  | [optional] 
+**spam** | **BOOLEAN** | `true  if the message has been detected as spam and hidden from other users  | [optional] 
+
+

data/docs/ScoreCommentContext.md

@@ -0,0 +1,14 @@
+# FlatApi::ScoreCommentContext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**part_uuid** | **String** | The unique identifier (UUID) of the score part | 
+**staff_idx** | **Float** | The identififer of the staff | 
+**measure_uuids** | **Array<String>** | The list of measure UUIds | 
+**start_time_pos** | **Float** |  | 
+**stop_time_pos** | **Float** |  | 
+**start_dpq** | **Float** |  | 
+**stop_dpq** | **Float** |  | 
+
+

data/docs/ScoreCommentCreation.md

@@ -0,0 +1,13 @@
+# FlatApi::ScoreCommentCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created.  | [optional] 
+**comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`.  | 
+**raw_comment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set.  | [optional] 
+**mentions** | **Array<String>** | The list of user identifiers mentioned in this comment | [optional] 
+**reply_to** | **String** | When the comment is a reply to another comment, the unique identifier of the parent comment  | [optional] 
+**context** | [**ScoreCommentContext**](ScoreCommentContext.md) |  | [optional] 
+
+

data/docs/ScoreCommentUpdate.md

@@ -0,0 +1,11 @@
+# FlatApi::ScoreCommentUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created.  | [optional] 
+**comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`.  | [optional] 
+**raw_comment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set.  | [optional] 
+**context** | [**ScoreCommentContext**](ScoreCommentContext.md) |  | [optional] 
+
+

data/docs/ScoreCommentsCounts.md

@@ -0,0 +1,11 @@
+# FlatApi::ScoreCommentsCounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** | The total number of comments added on the score | [optional] 
+**unique** | **Float** | The unique (1/user) number of comments added on the score | [optional] 
+**weekly** | **Float** | The weekly unique number of comments added on the score | [optional] 
+**monthly** | **Float** | The monthly unique number of comments added on the score | [optional] 
+
+

data/docs/ScoreCreation.md

@@ -0,0 +1,13 @@
+# FlatApi::ScoreCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The title of the new score.  If this title is not specified, the API will try to (in this order):   - Use the name of the file for files from a specified `source` (e.g. Google Drive)   - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files).   - Set a default title (e.g. \"New Music Score\")  If the title is already used, the API will append the creation date after the title. If the title is too long, the API may trim this one.  | [optional] 
+**privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | 
+**data** | [**ScoreData**](ScoreData.md) |  | [optional] 
+**data_encoding** | [**ScoreDataEncoding**](ScoreDataEncoding.md) |  | [optional] 
+**source** | [**ScoreSource**](ScoreSource.md) |  | [optional] 
+**google_drive_folder** | **String** | If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.  | [optional] 
+
+

data/docs/ScoreCreationType.md

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

data/docs/ScoreData.md

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

data/docs/ScoreDataEncoding.md

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

data/docs/ScoreDetails.md

@@ -0,0 +1,36 @@
+# FlatApi::ScoreDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the score | [optional] 
+**sharing_key** | **String** | The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) | [optional] 
+**title** | **String** | The title of the score | [optional] 
+**privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | [optional] 
+**user** | [**UserPublicSummary**](UserPublicSummary.md) |  | [optional] 
+**html_url** | **String** | The url where the score can be viewed in a web browser | [optional] 
+**subtitle** | **String** | Subtitle of the score | [optional] 
+**lyricist** | **String** | Lyricist of the score | [optional] 
+**composer** | **String** | Composer of the score | [optional] 
+**description** | **String** | Description of the creation | [optional] 
+**tags** | **Array<String>** | Tags describing the score | [optional] 
+**creation_type** | [**ScoreCreationType**](ScoreCreationType.md) |  | [optional] 
+**license** | [**ScoreLicense**](ScoreLicense.md) |  | [optional] 
+**license_text** | **String** | Additional license text written on the exported/printed score | [optional] 
+**duration_time** | **Integer** | In seconds, an approximative duration of the score | [optional] 
+**number_measures** | **Integer** | The number of measures in the score | [optional] 
+**main_tempo_qpm** | **Integer** | The main tempo of the score (in QPM) | [optional] 
+**rights** | [**ScoreRights**](ScoreRights.md) |  | [optional] 
+**collaborators** | [**Array<ScoreCollaborator>**](ScoreCollaborator.md) | The list of the collaborators of the score | [optional] 
+**creation_date** | **DateTime** | The date when the score was created | [optional] 
+**modification_date** | **DateTime** | The date of the last revision of the score | [optional] 
+**publication_date** | **DateTime** | The date when the score was published on Flat | [optional] 
+**organization** | **String** | If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`.  | [optional] 
+**parent_score** | **String** | If the score has been forked, the unique identifier of the parent score.  | [optional] 
+**instruments** | **Array<String>** | An array of the instrument identifiers used in the last version of the score. This is mainly used to display a list of the instruments in the Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`.  | [optional] 
+**google_drive_file_id** | **String** | If the user uses Google Drive and the score exists on Google Drive, this field will contain the unique identifier of the Flat score on Google Drive. You can access the document using the url: `https://drive.google.com/open?id={googleDriveFileId}`  | [optional] 
+**likes** | [**ScoreLikesCounts**](ScoreLikesCounts.md) |  | [optional] 
+**comments** | [**ScoreCommentsCounts**](ScoreCommentsCounts.md) |  | [optional] 
+**views** | [**ScoreViewsCounts**](ScoreViewsCounts.md) |  | [optional] 
+
+

data/docs/ScoreFork.md

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

data/docs/ScoreLicense.md

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

data/docs/ScoreLikesCounts.md

@@ -0,0 +1,10 @@
+# FlatApi::ScoreLikesCounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** | The total number of likes of the score | [optional] 
+**weekly** | **Float** | The number of new likes during the last week | [optional] 
+**monthly** | **Float** | The number of new likes during the last month | [optional] 
+
+

data/docs/ScoreModification.md

@@ -0,0 +1,13 @@
+# FlatApi::ScoreModification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | [optional] 
+**sharing_key** | **String** | When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated. | [optional] 
+**description** | **String** | Description of the creation | [optional] 
+**tags** | **Array<String>** | Tags describing the score | [optional] 
+**creation_type** | [**ScoreCreationType**](ScoreCreationType.md) |  | [optional] 
+**license** | [**ScoreLicense**](ScoreLicense.md) |  | [optional] 
+
+

data/docs/ScorePrivacy.md

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

data/docs/ScoreRevision.md

@@ -0,0 +1,14 @@
+# FlatApi::ScoreRevision
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the revision. | [optional] 
+**user** | **String** | The user identifier who created the revision | [optional] 
+**collaborators** | **Array<String>** |  | [optional] 
+**creation_date** | **DateTime** | The date when this revision was created | [optional] 
+**description** | **String** | A description associated to the revision | [optional] 
+**autosave** | **BOOLEAN** | True if this revision was automatically generated by Flat and not on purpose by the user.  | [optional] 
+**statistics** | [**ScoreRevisionStatistics**](ScoreRevisionStatistics.md) |  | [optional] 
+
+

data/docs/ScoreRevisionCreation.md

@@ -0,0 +1,11 @@
+# FlatApi::ScoreRevisionCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ScoreData**](ScoreData.md) |  | 
+**data_encoding** | [**ScoreDataEncoding**](ScoreDataEncoding.md) |  | [optional] 
+**autosave** | **BOOLEAN** | Must be set to `true` if the revision was created automatically.  | [optional] 
+**description** | **String** | A description associated to the revision | [optional] 
+
+

data/docs/ScoreRevisionStatistics.md

@@ -0,0 +1,9 @@
+# FlatApi::ScoreRevisionStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additions** | **Float** | The number of additions operations in the last revision | [optional] 
+**deletions** | **Float** | The number of deletions operations in the last revision | [optional] 
+
+

data/docs/ScoreRights.md

@@ -0,0 +1,9 @@
+# FlatApi::ScoreRights
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document  | [optional] [default to false]
+**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document, i.e. changing the document permissions and deleting the document  | [optional] [default to false]
+
+

data/docs/ScoreSource.md

@@ -0,0 +1,8 @@
+# FlatApi::ScoreSource
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**google_drive** | **String** | If the score is a file on Google Drive, this field property must contain its identifier. To use this method, the Drive file must be public or the Flat Drive App must have access to the file.  | [optional] 
+
+

data/docs/ScoreSummary.md

@@ -0,0 +1,13 @@
+# FlatApi::ScoreSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the score | [optional] 
+**sharing_key** | **String** | The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) | [optional] 
+**title** | **String** | The title of the score | [optional] 
+**privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | [optional] 
+**user** | [**UserPublicSummary**](UserPublicSummary.md) |  | [optional] 
+**html_url** | **String** | The url where the score can be viewed in a web browser | [optional] 
+
+

data/docs/ScoreTrack.md

@@ -0,0 +1,19 @@
+# FlatApi::ScoreTrack
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the score track | [optional] 
+**title** | **String** | Title of the track | [optional] 
+**score** | **String** | The unique identifier of the score | [optional] 
+**creator** | **String** | The unique identifier of the track creator | [optional] 
+**creation_date** | **DateTime** | The creation date of the track | [optional] 
+**modification_date** | **DateTime** | The modification date of the track | [optional] 
+**default** | **BOOLEAN** | True if the track should be used as default audio source | [optional] 
+**state** | [**ScoreTrackState**](ScoreTrackState.md) |  | [optional] 
+**type** | [**ScoreTrackType**](ScoreTrackType.md) |  | [optional] 
+**url** | **String** | The URL of the track | [optional] 
+**media_id** | **String** | The unique identifier of the track when hosted on an external service. For example, if the url is `https://www.youtube.com/watch?v=dQw4w9WgXcQ`, `mediaId` will be `dQw4w9WgXcQ`  | [optional] 
+**synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) |  | [optional] 
+
+

data/docs/ScoreTrackCreation.md

@@ -0,0 +1,12 @@
+# FlatApi::ScoreTrackCreation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the track | [optional] 
+**default** | **BOOLEAN** | True if the track should be used as default audio source | [optional] 
+**state** | [**ScoreTrackState**](ScoreTrackState.md) |  | [optional] 
+**url** | **String** | The URL of the track | [optional] 
+**synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) |  | [optional] 
+
+

data/docs/ScoreTrackPoint.md

@@ -0,0 +1,10 @@
+# FlatApi::ScoreTrackPoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the synchronization point. If the type is `measure`, the measure uuid must be present in `measureUuid` | 
+**measure_uuid** | **String** | The measure unique identifier | [optional] 
+**time** | **Float** | The corresponding time in seconds | 
+
+

data/docs/ScoreTrackState.md

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

data/docs/ScoreTrackType.md

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

data/docs/ScoreTrackUpdate.md

@@ -0,0 +1,11 @@
+# FlatApi::ScoreTrackUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the track | [optional] 
+**default** | **BOOLEAN** | True if the track should be used as default audio source | [optional] 
+**state** | [**ScoreTrackState**](ScoreTrackState.md) |  | [optional] 
+**synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) |  | [optional] 
+
+

data/docs/ScoreViewsCounts.md

@@ -0,0 +1,10 @@
+# FlatApi::ScoreViewsCounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** | The total number of views of the score | [optional] 
+**weekly** | **Float** | The weekly number of views of the score | [optional] 
+**monthly** | **Float** | The monthly number of views of the score | [optional] 
+
+

data/docs/UserAdminUpdate.md

@@ -0,0 +1,9 @@
+# FlatApi::UserAdminUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **String** | Password of the new account | [optional] 
+**organization_role** | [**OrganizationRoles**](OrganizationRoles.md) |  | [optional] 
+
+

data/docs/UserApi.md

@@ -0,0 +1,173 @@
+# FlatApi::UserApi
+
+All URIs are relative to *https://api.flat.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ger_user_likes**](UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
+[**get_user**](UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile
+[**get_user_scores**](UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
+
+
+# **ger_user_likes**
+> Array<ScoreDetails> ger_user_likes(user, opts)
+
+List liked scores
+
+### 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::UserApi.new
+
+user = "user_example" # String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. 
+
+opts = { 
+  ids: true # BOOLEAN | Return only the identifiers of the scores
+}
+
+begin
+  #List liked scores
+  result = api_instance.ger_user_likes(user, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling UserApi->ger_user_likes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.  | 
+ **ids** | **BOOLEAN**| Return only the identifiers of the scores | [optional] 
+
+### Return type
+
+[**Array<ScoreDetails>**](ScoreDetails.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user**
+> UserPublic get_user(user)
+
+Get a public user profile
+
+Get a public profile of a Flat User. 
+
+### 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::UserApi.new
+
+user = "user_example" # String | This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user. 
+
+
+begin
+  #Get a public user profile
+  result = api_instance.get_user(user)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling UserApi->get_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | **String**| This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user.  | 
+
+### Return type
+
+[**UserPublic**](UserPublic.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user_scores**
+> Array<ScoreDetails> get_user_scores(user, opts)
+
+List user's scores
+
+Get the list of scores owned by the User 
+
+### 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::UserApi.new
+
+user = "user_example" # String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. 
+
+opts = { 
+  parent: "parent_example" # String | Filter the score forked from the score id `parent`
+}
+
+begin
+  #List user's scores
+  result = api_instance.get_user_scores(user, opts)
+  p result
+rescue FlatApi::ApiError => e
+  puts "Exception when calling UserApi->get_user_scores: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.  | 
+ **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
+
+
+