flat_api 0.1.2 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +34 -12
- data/docs/ClassApi.md +2 -2
- data/docs/Collection.md +18 -0
- data/docs/CollectionApi.md +521 -0
- data/docs/CollectionCapabilities.md +12 -0
- data/docs/CollectionCreation.md +8 -0
- data/docs/CollectionModification.md +8 -0
- data/docs/CollectionPrivacy.md +7 -0
- data/docs/CollectionTitle.md +7 -0
- data/docs/CollectionType.md +7 -0
- data/docs/ResourceCollaborator.md +16 -0
- data/docs/{ScoreCollaboratorCreation.md → ResourceCollaboratorCreation.md} +2 -1
- data/docs/ResourceRights.md +10 -0
- data/docs/ResourceSharingKey.md +7 -0
- data/docs/ScoreApi.md +144 -91
- data/docs/ScoreCreation.md +2 -1
- data/docs/ScoreDetails.md +2 -2
- data/docs/ScoreFork.md +1 -0
- data/docs/ScoreModification.md +2 -1
- data/docs/UserApi.md +1 -1
- data/flat_api.gemspec +1 -1
- data/lib/flat_api.rb +13 -4
- data/lib/flat_api/api/account_api.rb +1 -1
- data/lib/flat_api/api/class_api.rb +1 -1
- data/lib/flat_api/api/collection_api.rb +596 -0
- data/lib/flat_api/api/group_api.rb +1 -1
- data/lib/flat_api/api/organization_api.rb +1 -1
- data/lib/flat_api/api/score_api.rb +125 -53
- data/lib/flat_api/api/user_api.rb +3 -3
- data/lib/flat_api/api_client.rb +1 -1
- data/lib/flat_api/api_error.rb +1 -1
- data/lib/flat_api/configuration.rb +1 -1
- data/lib/flat_api/models/assignment.rb +1 -1
- data/lib/flat_api/models/assignment_copy.rb +1 -1
- data/lib/flat_api/models/assignment_creation.rb +1 -1
- data/lib/flat_api/models/assignment_submission.rb +1 -1
- data/lib/flat_api/models/assignment_submission_update.rb +1 -1
- data/lib/flat_api/models/class_attachment_creation.rb +1 -1
- data/lib/flat_api/models/class_creation.rb +1 -1
- data/lib/flat_api/models/class_details.rb +1 -1
- data/lib/flat_api/models/class_details_canvas.rb +1 -1
- data/lib/flat_api/models/class_details_clever.rb +1 -1
- data/lib/flat_api/models/class_details_google_classroom.rb +1 -1
- data/lib/flat_api/models/class_details_google_drive.rb +1 -1
- data/lib/flat_api/models/class_details_lti.rb +1 -1
- data/lib/flat_api/models/class_roles.rb +1 -1
- data/lib/flat_api/models/class_state.rb +1 -1
- data/lib/flat_api/models/class_update.rb +1 -1
- data/lib/flat_api/models/collection.rb +285 -0
- data/lib/flat_api/models/collection_capabilities.rb +229 -0
- data/lib/flat_api/models/collection_creation.rb +193 -0
- data/lib/flat_api/models/collection_modification.rb +188 -0
- data/lib/flat_api/models/collection_privacy.rb +30 -0
- data/lib/flat_api/models/collection_title.rb +179 -0
- data/lib/flat_api/models/collection_type.rb +34 -0
- data/lib/flat_api/models/flat_error_response.rb +1 -1
- data/lib/flat_api/models/flat_locales.rb +1 -1
- data/lib/flat_api/models/google_classroom_coursework.rb +1 -1
- data/lib/flat_api/models/google_classroom_submission.rb +1 -1
- data/lib/flat_api/models/group.rb +1 -1
- data/lib/flat_api/models/group_details.rb +1 -1
- data/lib/flat_api/models/group_type.rb +1 -1
- data/lib/flat_api/models/license_mode.rb +1 -1
- data/lib/flat_api/models/license_sources.rb +1 -1
- data/lib/flat_api/models/lms_name.rb +1 -1
- data/lib/flat_api/models/lti_credentials.rb +1 -1
- data/lib/flat_api/models/lti_credentials_creation.rb +1 -1
- data/lib/flat_api/models/media_attachment.rb +1 -1
- data/lib/flat_api/models/media_score_sharing_mode.rb +1 -1
- data/lib/flat_api/models/organization_invitation.rb +1 -1
- data/lib/flat_api/models/organization_invitation_creation.rb +1 -1
- data/lib/flat_api/models/organization_roles.rb +1 -1
- data/lib/flat_api/models/{score_collaborator.rb → resource_collaborator.rb} +54 -44
- data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +14 -4
- data/lib/flat_api/models/{score_rights.rb → resource_rights.rb} +6 -6
- data/lib/flat_api/models/resource_sharing_key.rb +179 -0
- data/lib/flat_api/models/score_comment.rb +1 -1
- data/lib/flat_api/models/score_comment_context.rb +1 -1
- data/lib/flat_api/models/score_comment_creation.rb +1 -1
- data/lib/flat_api/models/score_comment_update.rb +1 -1
- data/lib/flat_api/models/score_comments_counts.rb +1 -1
- data/lib/flat_api/models/score_creation.rb +13 -3
- data/lib/flat_api/models/score_creation_type.rb +1 -1
- data/lib/flat_api/models/score_data.rb +1 -1
- data/lib/flat_api/models/score_data_encoding.rb +1 -1
- data/lib/flat_api/models/score_details.rb +3 -3
- data/lib/flat_api/models/score_fork.rb +13 -3
- data/lib/flat_api/models/score_license.rb +1 -1
- data/lib/flat_api/models/score_likes_counts.rb +1 -1
- data/lib/flat_api/models/score_modification.rb +13 -20
- data/lib/flat_api/models/score_privacy.rb +1 -1
- data/lib/flat_api/models/score_revision.rb +1 -1
- data/lib/flat_api/models/score_revision_creation.rb +1 -1
- data/lib/flat_api/models/score_revision_statistics.rb +1 -1
- data/lib/flat_api/models/score_source.rb +1 -1
- data/lib/flat_api/models/score_summary.rb +1 -1
- data/lib/flat_api/models/score_track.rb +1 -1
- data/lib/flat_api/models/score_track_creation.rb +1 -1
- data/lib/flat_api/models/score_track_point.rb +1 -1
- data/lib/flat_api/models/score_track_state.rb +1 -1
- data/lib/flat_api/models/score_track_type.rb +1 -1
- data/lib/flat_api/models/score_track_update.rb +1 -1
- data/lib/flat_api/models/score_views_counts.rb +1 -1
- data/lib/flat_api/models/user_admin_update.rb +1 -1
- data/lib/flat_api/models/user_basics.rb +1 -1
- data/lib/flat_api/models/user_creation.rb +1 -1
- data/lib/flat_api/models/user_details.rb +1 -1
- data/lib/flat_api/models/user_details_admin.rb +1 -1
- data/lib/flat_api/models/user_details_admin_license.rb +1 -1
- data/lib/flat_api/models/user_instruments.rb +1 -1
- data/lib/flat_api/models/user_public.rb +1 -1
- data/lib/flat_api/models/user_public_summary.rb +1 -1
- data/lib/flat_api/version.rb +2 -2
- data/spec/api/account_api_spec.rb +2 -2
- data/spec/api/class_api_spec.rb +2 -2
- data/spec/api/collection_api_spec.rb +159 -0
- data/spec/api/group_api_spec.rb +2 -2
- data/spec/api/organization_api_spec.rb +2 -2
- data/spec/api/score_api_spec.rb +41 -26
- data/spec/api/user_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/assignment_copy_spec.rb +2 -2
- data/spec/models/assignment_creation_spec.rb +2 -2
- data/spec/models/assignment_spec.rb +2 -2
- data/spec/models/assignment_submission_spec.rb +2 -2
- data/spec/models/assignment_submission_update_spec.rb +2 -2
- data/spec/models/class_attachment_creation_spec.rb +2 -2
- data/spec/models/class_creation_spec.rb +2 -2
- data/spec/models/class_details_canvas_spec.rb +2 -2
- data/spec/models/class_details_clever_spec.rb +2 -2
- data/spec/models/class_details_google_classroom_spec.rb +2 -2
- data/spec/models/class_details_google_drive_spec.rb +2 -2
- data/spec/models/class_details_lti_spec.rb +2 -2
- data/spec/models/class_details_spec.rb +2 -2
- data/spec/models/class_roles_spec.rb +2 -2
- data/spec/models/class_state_spec.rb +2 -2
- data/spec/models/class_update_spec.rb +2 -2
- data/spec/models/collection_capabilities_spec.rb +66 -0
- data/spec/models/collection_creation_spec.rb +42 -0
- data/spec/models/collection_modification_spec.rb +42 -0
- data/spec/models/collection_privacy_spec.rb +36 -0
- data/spec/models/collection_spec.rb +102 -0
- data/spec/models/collection_title_spec.rb +36 -0
- data/spec/models/collection_type_spec.rb +36 -0
- data/spec/models/flat_error_response_spec.rb +2 -2
- data/spec/models/flat_locales_spec.rb +2 -2
- data/spec/models/google_classroom_coursework_spec.rb +2 -2
- data/spec/models/google_classroom_submission_spec.rb +2 -2
- data/spec/models/group_details_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/group_type_spec.rb +2 -2
- data/spec/models/license_mode_spec.rb +2 -2
- data/spec/models/license_sources_spec.rb +2 -2
- data/spec/models/lms_name_spec.rb +2 -2
- data/spec/models/lti_credentials_creation_spec.rb +2 -2
- data/spec/models/lti_credentials_spec.rb +2 -2
- data/spec/models/media_attachment_spec.rb +2 -2
- data/spec/models/media_score_sharing_mode_spec.rb +2 -2
- data/spec/models/organization_invitation_creation_spec.rb +2 -2
- data/spec/models/organization_invitation_spec.rb +2 -2
- data/spec/models/organization_roles_spec.rb +2 -2
- data/spec/models/{score_collaborator_creation_spec.rb → resource_collaborator_creation_spec.rb} +14 -8
- data/spec/models/{score_collaborator_spec.rb → resource_collaborator_spec.rb} +22 -16
- data/spec/models/{score_rights_spec.rb → resource_rights_spec.rb} +14 -8
- data/spec/models/resource_sharing_key_spec.rb +36 -0
- data/spec/models/score_comment_context_spec.rb +2 -2
- data/spec/models/score_comment_creation_spec.rb +2 -2
- data/spec/models/score_comment_spec.rb +2 -2
- data/spec/models/score_comment_update_spec.rb +2 -2
- data/spec/models/score_comments_counts_spec.rb +2 -2
- data/spec/models/score_creation_spec.rb +8 -2
- data/spec/models/score_creation_type_spec.rb +2 -2
- data/spec/models/score_data_encoding_spec.rb +2 -2
- data/spec/models/score_data_spec.rb +2 -2
- data/spec/models/score_details_spec.rb +2 -2
- data/spec/models/score_fork_spec.rb +8 -2
- data/spec/models/score_license_spec.rb +2 -2
- data/spec/models/score_likes_counts_spec.rb +2 -2
- data/spec/models/score_modification_spec.rb +8 -2
- data/spec/models/score_privacy_spec.rb +2 -2
- data/spec/models/score_revision_creation_spec.rb +2 -2
- data/spec/models/score_revision_spec.rb +2 -2
- data/spec/models/score_revision_statistics_spec.rb +2 -2
- data/spec/models/score_source_spec.rb +2 -2
- data/spec/models/score_summary_spec.rb +2 -2
- data/spec/models/score_track_creation_spec.rb +2 -2
- data/spec/models/score_track_point_spec.rb +2 -2
- data/spec/models/score_track_spec.rb +2 -2
- data/spec/models/score_track_state_spec.rb +2 -2
- data/spec/models/score_track_type_spec.rb +2 -2
- data/spec/models/score_track_update_spec.rb +2 -2
- data/spec/models/score_views_counts_spec.rb +2 -2
- data/spec/models/user_admin_update_spec.rb +2 -2
- data/spec/models/user_basics_spec.rb +2 -2
- data/spec/models/user_creation_spec.rb +2 -2
- data/spec/models/user_details_admin_license_spec.rb +2 -2
- data/spec/models/user_details_admin_spec.rb +2 -2
- data/spec/models/user_details_spec.rb +2 -2
- data/spec/models/user_instruments_spec.rb +2 -2
- data/spec/models/user_public_spec.rb +2 -2
- data/spec/models/user_public_summary_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +50 -15
- data/docs/ScoreCollaborator.md +0 -15
- data/docs/ScoreRights.md +0 -10
- data/git_push.sh +0 -55
@@ -0,0 +1,12 @@
|
|
1
|
+
# FlatApi::CollectionCapabilities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**can_edit** | **BOOLEAN** | Whether the current user can modify the metadata for the collection | [optional]
|
7
|
+
**can_share** | **BOOLEAN** | Whether the current user can modify the sharing settings for the collection | [optional]
|
8
|
+
**can_delete** | **BOOLEAN** | Whether the current user can delete the collection | [optional]
|
9
|
+
**can_add_scores** | **BOOLEAN** | Whether the current user can add scores to the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score. | [optional]
|
10
|
+
**can_delete_scores** | **BOOLEAN** | Whether the current user can delete scores from the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score. | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# FlatApi::ResourceCollaborator
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to false]
|
7
|
+
**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false]
|
8
|
+
**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false]
|
9
|
+
**id** | **String** | The unique identifier of the permission | [optional]
|
10
|
+
**score** | **String** | If this object is a permission of a score, this property will contain the unique identifier of the score | [optional]
|
11
|
+
**collection** | **String** | If this object is a permission of a collection, this property will contain the unique identifier of the collection | [optional]
|
12
|
+
**user** | [**UserPublic**](UserPublic.md) | | [optional]
|
13
|
+
**group** | [**Group**](Group.md) | | [optional]
|
14
|
+
**user_email** | **String** | If the collaborator is not a user of Flat yet, this field will contain his email. | [optional]
|
15
|
+
|
16
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# FlatApi::
|
1
|
+
# FlatApi::ResourceCollaboratorCreation
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**user** | **String** | The unique identifier of a Flat user | [optional]
|
7
7
|
**group** | **String** | The unique identifier of a Flat group | [optional]
|
8
8
|
**user_email** | **String** | Fill this field to invite an individual user by email. | [optional]
|
9
|
+
**user_token** | **String** | Token received in an invitation to join the score. | [optional]
|
9
10
|
**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]
|
10
11
|
**acl_write** | **BOOLEAN** | `True` if the related user can modify the score. | [optional] [default to false]
|
11
12
|
**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]
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# FlatApi::ResourceRights
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to false]
|
7
|
+
**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false]
|
8
|
+
**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false]
|
9
|
+
|
10
|
+
|
data/docs/ScoreApi.md
CHANGED
@@ -30,16 +30,17 @@ Method | HTTP request | Description
|
|
30
30
|
[**mark_score_comment_unresolved**](ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
|
31
31
|
[**post_score_comment**](ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment
|
32
32
|
[**remove_score_collaborator**](ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator
|
33
|
+
[**untrash_score**](ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score
|
33
34
|
[**update_score_comment**](ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment
|
34
35
|
[**update_score_track**](ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score
|
35
36
|
|
36
37
|
|
37
38
|
# **add_score_collaborator**
|
38
|
-
>
|
39
|
+
> ResourceCollaborator add_score_collaborator(scorebody)
|
39
40
|
|
40
41
|
Add a new collaborator
|
41
42
|
|
42
|
-
Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a
|
43
|
+
Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights.
|
43
44
|
|
44
45
|
### Example
|
45
46
|
```ruby
|
@@ -55,12 +56,12 @@ api_instance = FlatApi::ScoreApi.new
|
|
55
56
|
|
56
57
|
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`).
|
57
58
|
|
58
|
-
body = FlatApi::
|
59
|
+
body = FlatApi::ResourceCollaboratorCreation.new # ResourceCollaboratorCreation |
|
59
60
|
|
60
61
|
|
61
62
|
begin
|
62
63
|
#Add a new collaborator
|
63
|
-
result = api_instance.add_score_collaborator(
|
64
|
+
result = api_instance.add_score_collaborator(scorebody)
|
64
65
|
p result
|
65
66
|
rescue FlatApi::ApiError => e
|
66
67
|
puts "Exception when calling ScoreApi->add_score_collaborator: #{e}"
|
@@ -72,11 +73,11 @@ end
|
|
72
73
|
Name | Type | Description | Notes
|
73
74
|
------------- | ------------- | ------------- | -------------
|
74
75
|
**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`). |
|
75
|
-
**body** | [**
|
76
|
+
**body** | [**ResourceCollaboratorCreation**](ResourceCollaboratorCreation.md)| |
|
76
77
|
|
77
78
|
### Return type
|
78
79
|
|
79
|
-
[**
|
80
|
+
[**ResourceCollaborator**](ResourceCollaborator.md)
|
80
81
|
|
81
82
|
### Authorization
|
82
83
|
|
@@ -90,7 +91,7 @@ Name | Type | Description | Notes
|
|
90
91
|
|
91
92
|
|
92
93
|
# **add_score_track**
|
93
|
-
> ScoreTrack add_score_track(
|
94
|
+
> ScoreTrack add_score_track(scorebody)
|
94
95
|
|
95
96
|
Add a new video or audio track to the score
|
96
97
|
|
@@ -115,7 +116,7 @@ body = FlatApi::ScoreTrackCreation.new # ScoreTrackCreation |
|
|
115
116
|
|
116
117
|
begin
|
117
118
|
#Add a new video or audio track to the score
|
118
|
-
result = api_instance.add_score_track(
|
119
|
+
result = api_instance.add_score_track(scorebody)
|
119
120
|
p result
|
120
121
|
rescue FlatApi::ApiError => e
|
121
122
|
puts "Exception when calling ScoreApi->add_score_track: #{e}"
|
@@ -149,7 +150,7 @@ Name | Type | Description | Notes
|
|
149
150
|
|
150
151
|
Create a new score
|
151
152
|
|
152
|
-
Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups).
|
153
|
+
Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`.
|
153
154
|
|
154
155
|
### Example
|
155
156
|
```ruby
|
@@ -197,7 +198,7 @@ Name | Type | Description | Notes
|
|
197
198
|
|
198
199
|
|
199
200
|
# **create_score_revision**
|
200
|
-
> ScoreRevision create_score_revision(
|
201
|
+
> ScoreRevision create_score_revision(scorebody)
|
201
202
|
|
202
203
|
Create a new revision
|
203
204
|
|
@@ -222,7 +223,7 @@ body = FlatApi::ScoreRevisionCreation.new # ScoreRevisionCreation |
|
|
222
223
|
|
223
224
|
begin
|
224
225
|
#Create a new revision
|
225
|
-
result = api_instance.create_score_revision(
|
226
|
+
result = api_instance.create_score_revision(scorebody)
|
226
227
|
p result
|
227
228
|
rescue FlatApi::ApiError => e
|
228
229
|
puts "Exception when calling ScoreApi->create_score_revision: #{e}"
|
@@ -252,11 +253,11 @@ Name | Type | Description | Notes
|
|
252
253
|
|
253
254
|
|
254
255
|
# **delete_score**
|
255
|
-
> delete_score(score
|
256
|
+
> delete_score(score)
|
256
257
|
|
257
258
|
Delete a score
|
258
259
|
|
259
|
-
This
|
260
|
+
This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections).
|
260
261
|
|
261
262
|
### Example
|
262
263
|
```ruby
|
@@ -275,7 +276,7 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
275
276
|
|
276
277
|
begin
|
277
278
|
#Delete a score
|
278
|
-
api_instance.delete_score(score
|
279
|
+
api_instance.delete_score(score)
|
279
280
|
rescue FlatApi::ApiError => e
|
280
281
|
puts "Exception when calling ScoreApi->delete_score: #{e}"
|
281
282
|
end
|
@@ -303,7 +304,7 @@ nil (empty response body)
|
|
303
304
|
|
304
305
|
|
305
306
|
# **delete_score_comment**
|
306
|
-
> delete_score_comment(
|
307
|
+
> delete_score_comment(scorecomment, opts)
|
307
308
|
|
308
309
|
Delete a comment
|
309
310
|
|
@@ -324,12 +325,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
324
325
|
comment = "comment_example" # String | Unique identifier of a sheet music comment
|
325
326
|
|
326
327
|
opts = {
|
327
|
-
sharing_key: "sharing_key_example"
|
328
|
+
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.
|
328
329
|
}
|
329
330
|
|
330
331
|
begin
|
331
332
|
#Delete a comment
|
332
|
-
api_instance.delete_score_comment(
|
333
|
+
api_instance.delete_score_comment(scorecomment, opts)
|
333
334
|
rescue FlatApi::ApiError => e
|
334
335
|
puts "Exception when calling ScoreApi->delete_score_comment: #{e}"
|
335
336
|
end
|
@@ -341,7 +342,7 @@ Name | Type | Description | Notes
|
|
341
342
|
------------- | ------------- | ------------- | -------------
|
342
343
|
**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`). |
|
343
344
|
**comment** | **String**| Unique identifier of a sheet music comment |
|
344
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
345
|
+
**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]
|
345
346
|
|
346
347
|
### Return type
|
347
348
|
|
@@ -359,7 +360,7 @@ nil (empty response body)
|
|
359
360
|
|
360
361
|
|
361
362
|
# **delete_score_track**
|
362
|
-
> delete_score_track(
|
363
|
+
> delete_score_track(scoretrack)
|
363
364
|
|
364
365
|
Remove an audio or video track linked to the score
|
365
366
|
|
@@ -382,7 +383,7 @@ track = "track_example" # String | Unique identifier of a score audio track
|
|
382
383
|
|
383
384
|
begin
|
384
385
|
#Remove an audio or video track linked to the score
|
385
|
-
api_instance.delete_score_track(
|
386
|
+
api_instance.delete_score_track(scoretrack)
|
386
387
|
rescue FlatApi::ApiError => e
|
387
388
|
puts "Exception when calling ScoreApi->delete_score_track: #{e}"
|
388
389
|
end
|
@@ -411,11 +412,11 @@ nil (empty response body)
|
|
411
412
|
|
412
413
|
|
413
414
|
# **edit_score**
|
414
|
-
> ScoreDetails edit_score(score,
|
415
|
+
> ScoreDetails edit_score(score, opts)
|
415
416
|
|
416
417
|
Edit a score's metadata
|
417
418
|
|
418
|
-
This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`).
|
419
|
+
This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save.
|
419
420
|
|
420
421
|
### Example
|
421
422
|
```ruby
|
@@ -437,7 +438,7 @@ opts = {
|
|
437
438
|
|
438
439
|
begin
|
439
440
|
#Edit a score's metadata
|
440
|
-
result = api_instance.edit_score(score,
|
441
|
+
result = api_instance.edit_score(score, opts)
|
441
442
|
p result
|
442
443
|
rescue FlatApi::ApiError => e
|
443
444
|
puts "Exception when calling ScoreApi->edit_score: #{e}"
|
@@ -467,7 +468,7 @@ Name | Type | Description | Notes
|
|
467
468
|
|
468
469
|
|
469
470
|
# **fork_score**
|
470
|
-
> ScoreDetails fork_score(
|
471
|
+
> ScoreDetails fork_score(scorebody, opts)
|
471
472
|
|
472
473
|
Fork a score
|
473
474
|
|
@@ -490,12 +491,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
490
491
|
body = FlatApi::ScoreFork.new # ScoreFork |
|
491
492
|
|
492
493
|
opts = {
|
493
|
-
sharing_key: "sharing_key_example"
|
494
|
+
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.
|
494
495
|
}
|
495
496
|
|
496
497
|
begin
|
497
498
|
#Fork a score
|
498
|
-
result = api_instance.fork_score(
|
499
|
+
result = api_instance.fork_score(scorebody, opts)
|
499
500
|
p result
|
500
501
|
rescue FlatApi::ApiError => e
|
501
502
|
puts "Exception when calling ScoreApi->fork_score: #{e}"
|
@@ -508,7 +509,7 @@ Name | Type | Description | Notes
|
|
508
509
|
------------- | ------------- | ------------- | -------------
|
509
510
|
**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`). |
|
510
511
|
**body** | [**ScoreFork**](ScoreFork.md)| |
|
511
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
512
|
+
**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]
|
512
513
|
|
513
514
|
### Return type
|
514
515
|
|
@@ -636,7 +637,7 @@ Name | Type | Description | Notes
|
|
636
637
|
|
637
638
|
|
638
639
|
# **get_score**
|
639
|
-
> ScoreDetails get_score(score,
|
640
|
+
> ScoreDetails get_score(score, opts)
|
640
641
|
|
641
642
|
Get a score's metadata
|
642
643
|
|
@@ -657,12 +658,12 @@ api_instance = FlatApi::ScoreApi.new
|
|
657
658
|
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`).
|
658
659
|
|
659
660
|
opts = {
|
660
|
-
sharing_key: "sharing_key_example"
|
661
|
+
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.
|
661
662
|
}
|
662
663
|
|
663
664
|
begin
|
664
665
|
#Get a score's metadata
|
665
|
-
result = api_instance.get_score(score,
|
666
|
+
result = api_instance.get_score(score, opts)
|
666
667
|
p result
|
667
668
|
rescue FlatApi::ApiError => e
|
668
669
|
puts "Exception when calling ScoreApi->get_score: #{e}"
|
@@ -674,7 +675,7 @@ end
|
|
674
675
|
Name | Type | Description | Notes
|
675
676
|
------------- | ------------- | ------------- | -------------
|
676
677
|
**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`). |
|
677
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
678
|
+
**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]
|
678
679
|
|
679
680
|
### Return type
|
680
681
|
|
@@ -692,7 +693,7 @@ Name | Type | Description | Notes
|
|
692
693
|
|
693
694
|
|
694
695
|
# **get_score_collaborator**
|
695
|
-
>
|
696
|
+
> ResourceCollaborator get_score_collaborator(scorecollaborator, opts)
|
696
697
|
|
697
698
|
Get a collaborator
|
698
699
|
|
@@ -715,12 +716,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
715
716
|
collaborator = "collaborator_example" # String | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
|
716
717
|
|
717
718
|
opts = {
|
718
|
-
sharing_key: "sharing_key_example"
|
719
|
+
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.
|
719
720
|
}
|
720
721
|
|
721
722
|
begin
|
722
723
|
#Get a collaborator
|
723
|
-
result = api_instance.get_score_collaborator(
|
724
|
+
result = api_instance.get_score_collaborator(scorecollaborator, opts)
|
724
725
|
p result
|
725
726
|
rescue FlatApi::ApiError => e
|
726
727
|
puts "Exception when calling ScoreApi->get_score_collaborator: #{e}"
|
@@ -733,11 +734,11 @@ Name | Type | Description | Notes
|
|
733
734
|
------------- | ------------- | ------------- | -------------
|
734
735
|
**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`). |
|
735
736
|
**collaborator** | **String**| Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** |
|
736
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
737
|
+
**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]
|
737
738
|
|
738
739
|
### Return type
|
739
740
|
|
740
|
-
[**
|
741
|
+
[**ResourceCollaborator**](ResourceCollaborator.md)
|
741
742
|
|
742
743
|
### Authorization
|
743
744
|
|
@@ -751,7 +752,7 @@ Name | Type | Description | Notes
|
|
751
752
|
|
752
753
|
|
753
754
|
# **get_score_collaborators**
|
754
|
-
> Array<
|
755
|
+
> Array<ResourceCollaborator> get_score_collaborators(score, opts)
|
755
756
|
|
756
757
|
List the collaborators
|
757
758
|
|
@@ -772,12 +773,12 @@ api_instance = FlatApi::ScoreApi.new
|
|
772
773
|
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`).
|
773
774
|
|
774
775
|
opts = {
|
775
|
-
sharing_key: "sharing_key_example"
|
776
|
+
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.
|
776
777
|
}
|
777
778
|
|
778
779
|
begin
|
779
780
|
#List the collaborators
|
780
|
-
result = api_instance.get_score_collaborators(score,
|
781
|
+
result = api_instance.get_score_collaborators(score, opts)
|
781
782
|
p result
|
782
783
|
rescue FlatApi::ApiError => e
|
783
784
|
puts "Exception when calling ScoreApi->get_score_collaborators: #{e}"
|
@@ -789,11 +790,11 @@ end
|
|
789
790
|
Name | Type | Description | Notes
|
790
791
|
------------- | ------------- | ------------- | -------------
|
791
792
|
**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`). |
|
792
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
793
|
+
**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]
|
793
794
|
|
794
795
|
### Return type
|
795
796
|
|
796
|
-
[**Array<
|
797
|
+
[**Array<ResourceCollaborator>**](ResourceCollaborator.md)
|
797
798
|
|
798
799
|
### Authorization
|
799
800
|
|
@@ -807,7 +808,7 @@ Name | Type | Description | Notes
|
|
807
808
|
|
808
809
|
|
809
810
|
# **get_score_comments**
|
810
|
-
> Array<ScoreComment> get_score_comments(score,
|
811
|
+
> Array<ScoreComment> get_score_comments(score, opts)
|
811
812
|
|
812
813
|
List comments
|
813
814
|
|
@@ -828,12 +829,15 @@ api_instance = FlatApi::ScoreApi.new
|
|
828
829
|
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`).
|
829
830
|
|
830
831
|
opts = {
|
831
|
-
sharing_key: "sharing_key_example"
|
832
|
+
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.
|
833
|
+
type: "type_example", # String | Filter the comments by type
|
834
|
+
sort: "sort_example", # String | Sort
|
835
|
+
direction: "direction_example", # String | Sort direction
|
832
836
|
}
|
833
837
|
|
834
838
|
begin
|
835
839
|
#List comments
|
836
|
-
result = api_instance.get_score_comments(score,
|
840
|
+
result = api_instance.get_score_comments(score, opts)
|
837
841
|
p result
|
838
842
|
rescue FlatApi::ApiError => e
|
839
843
|
puts "Exception when calling ScoreApi->get_score_comments: #{e}"
|
@@ -845,7 +849,10 @@ end
|
|
845
849
|
Name | Type | Description | Notes
|
846
850
|
------------- | ------------- | ------------- | -------------
|
847
851
|
**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`). |
|
848
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
852
|
+
**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]
|
853
|
+
**type** | **String**| Filter the comments by type | [optional]
|
854
|
+
**sort** | **String**| Sort | [optional]
|
855
|
+
**direction** | **String**| Sort direction | [optional]
|
849
856
|
|
850
857
|
### Return type
|
851
858
|
|
@@ -863,7 +870,7 @@ Name | Type | Description | Notes
|
|
863
870
|
|
864
871
|
|
865
872
|
# **get_score_revision**
|
866
|
-
> ScoreRevision get_score_revision(
|
873
|
+
> ScoreRevision get_score_revision(scorerevision, , opts)
|
867
874
|
|
868
875
|
Get a score revision
|
869
876
|
|
@@ -886,12 +893,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
886
893
|
revision = "revision_example" # String | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
887
894
|
|
888
895
|
opts = {
|
889
|
-
sharing_key: "sharing_key_example"
|
896
|
+
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.
|
890
897
|
}
|
891
898
|
|
892
899
|
begin
|
893
900
|
#Get a score revision
|
894
|
-
result = api_instance.get_score_revision(
|
901
|
+
result = api_instance.get_score_revision(scorerevision, , opts)
|
895
902
|
p result
|
896
903
|
rescue FlatApi::ApiError => e
|
897
904
|
puts "Exception when calling ScoreApi->get_score_revision: #{e}"
|
@@ -904,7 +911,7 @@ Name | Type | Description | Notes
|
|
904
911
|
------------- | ------------- | ------------- | -------------
|
905
912
|
**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`). |
|
906
913
|
**revision** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. |
|
907
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
914
|
+
**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]
|
908
915
|
|
909
916
|
### Return type
|
910
917
|
|
@@ -922,7 +929,7 @@ Name | Type | Description | Notes
|
|
922
929
|
|
923
930
|
|
924
931
|
# **get_score_revision_data**
|
925
|
-
> String get_score_revision_data(
|
932
|
+
> String get_score_revision_data(scorerevision, format, opts)
|
926
933
|
|
927
934
|
Get a score revision data
|
928
935
|
|
@@ -947,14 +954,14 @@ revision = "revision_example" # String | Unique identifier of a score revision.
|
|
947
954
|
format = "format_example" # String | The format of the file you will retrieve
|
948
955
|
|
949
956
|
opts = {
|
950
|
-
sharing_key: "sharing_key_example"
|
951
|
-
|
952
|
-
|
957
|
+
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.
|
958
|
+
parts: "parts_example", # String | An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\".
|
959
|
+
only_cached: true # BOOLEAN | Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned
|
953
960
|
}
|
954
961
|
|
955
962
|
begin
|
956
963
|
#Get a score revision data
|
957
|
-
result = api_instance.get_score_revision_data(
|
964
|
+
result = api_instance.get_score_revision_data(scorerevision, format, opts)
|
958
965
|
p result
|
959
966
|
rescue FlatApi::ApiError => e
|
960
967
|
puts "Exception when calling ScoreApi->get_score_revision_data: #{e}"
|
@@ -968,9 +975,9 @@ Name | Type | Description | Notes
|
|
968
975
|
**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`). |
|
969
976
|
**revision** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. |
|
970
977
|
**format** | **String**| The format of the file you will retrieve |
|
971
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
972
|
-
**only_cached** | **BOOLEAN**| Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned | [optional]
|
978
|
+
**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]
|
973
979
|
**parts** | **String**| An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". | [optional]
|
980
|
+
**only_cached** | **BOOLEAN**| Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned | [optional]
|
974
981
|
|
975
982
|
### Return type
|
976
983
|
|
@@ -988,7 +995,7 @@ Name | Type | Description | Notes
|
|
988
995
|
|
989
996
|
|
990
997
|
# **get_score_revisions**
|
991
|
-
> Array<ScoreRevision> get_score_revisions(score,
|
998
|
+
> Array<ScoreRevision> get_score_revisions(score, opts)
|
992
999
|
|
993
1000
|
List the revisions
|
994
1001
|
|
@@ -1009,12 +1016,12 @@ api_instance = FlatApi::ScoreApi.new
|
|
1009
1016
|
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`).
|
1010
1017
|
|
1011
1018
|
opts = {
|
1012
|
-
sharing_key: "sharing_key_example"
|
1019
|
+
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.
|
1013
1020
|
}
|
1014
1021
|
|
1015
1022
|
begin
|
1016
1023
|
#List the revisions
|
1017
|
-
result = api_instance.get_score_revisions(score,
|
1024
|
+
result = api_instance.get_score_revisions(score, opts)
|
1018
1025
|
p result
|
1019
1026
|
rescue FlatApi::ApiError => e
|
1020
1027
|
puts "Exception when calling ScoreApi->get_score_revisions: #{e}"
|
@@ -1026,7 +1033,7 @@ end
|
|
1026
1033
|
Name | Type | Description | Notes
|
1027
1034
|
------------- | ------------- | ------------- | -------------
|
1028
1035
|
**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`). |
|
1029
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1036
|
+
**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]
|
1030
1037
|
|
1031
1038
|
### Return type
|
1032
1039
|
|
@@ -1044,7 +1051,7 @@ Name | Type | Description | Notes
|
|
1044
1051
|
|
1045
1052
|
|
1046
1053
|
# **get_score_submissions**
|
1047
|
-
> Array<AssignmentSubmission> get_score_submissions(score
|
1054
|
+
> Array<AssignmentSubmission> get_score_submissions(score)
|
1048
1055
|
|
1049
1056
|
List submissions related to the score
|
1050
1057
|
|
@@ -1067,7 +1074,7 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
1067
1074
|
|
1068
1075
|
begin
|
1069
1076
|
#List submissions related to the score
|
1070
|
-
result = api_instance.get_score_submissions(score
|
1077
|
+
result = api_instance.get_score_submissions(score)
|
1071
1078
|
p result
|
1072
1079
|
rescue FlatApi::ApiError => e
|
1073
1080
|
puts "Exception when calling ScoreApi->get_score_submissions: #{e}"
|
@@ -1096,7 +1103,7 @@ Name | Type | Description | Notes
|
|
1096
1103
|
|
1097
1104
|
|
1098
1105
|
# **get_score_track**
|
1099
|
-
> ScoreTrack get_score_track(
|
1106
|
+
> ScoreTrack get_score_track(scoretrack, opts)
|
1100
1107
|
|
1101
1108
|
Retrieve the details of an audio or video track linked to a score
|
1102
1109
|
|
@@ -1117,12 +1124,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
1117
1124
|
track = "track_example" # String | Unique identifier of a score audio track
|
1118
1125
|
|
1119
1126
|
opts = {
|
1120
|
-
sharing_key: "sharing_key_example"
|
1127
|
+
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.
|
1121
1128
|
}
|
1122
1129
|
|
1123
1130
|
begin
|
1124
1131
|
#Retrieve the details of an audio or video track linked to a score
|
1125
|
-
result = api_instance.get_score_track(
|
1132
|
+
result = api_instance.get_score_track(scoretrack, opts)
|
1126
1133
|
p result
|
1127
1134
|
rescue FlatApi::ApiError => e
|
1128
1135
|
puts "Exception when calling ScoreApi->get_score_track: #{e}"
|
@@ -1135,7 +1142,7 @@ Name | Type | Description | Notes
|
|
1135
1142
|
------------- | ------------- | ------------- | -------------
|
1136
1143
|
**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`). |
|
1137
1144
|
**track** | **String**| Unique identifier of a score audio track |
|
1138
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1145
|
+
**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]
|
1139
1146
|
|
1140
1147
|
### Return type
|
1141
1148
|
|
@@ -1157,7 +1164,7 @@ Name | Type | Description | Notes
|
|
1157
1164
|
|
1158
1165
|
List user's scores
|
1159
1166
|
|
1160
|
-
Get the list of scores owned by
|
1167
|
+
Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead.
|
1161
1168
|
|
1162
1169
|
### Example
|
1163
1170
|
```ruby
|
@@ -1209,7 +1216,7 @@ Name | Type | Description | Notes
|
|
1209
1216
|
|
1210
1217
|
|
1211
1218
|
# **list_score_tracks**
|
1212
|
-
> Array<ScoreTrack> list_score_tracks(score,
|
1219
|
+
> Array<ScoreTrack> list_score_tracks(score, opts)
|
1213
1220
|
|
1214
1221
|
List the audio or video tracks linked to a score
|
1215
1222
|
|
@@ -1228,12 +1235,12 @@ api_instance = FlatApi::ScoreApi.new
|
|
1228
1235
|
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`).
|
1229
1236
|
|
1230
1237
|
opts = {
|
1231
|
-
sharing_key: "sharing_key_example"
|
1238
|
+
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.
|
1232
1239
|
}
|
1233
1240
|
|
1234
1241
|
begin
|
1235
1242
|
#List the audio or video tracks linked to a score
|
1236
|
-
result = api_instance.list_score_tracks(score,
|
1243
|
+
result = api_instance.list_score_tracks(score, opts)
|
1237
1244
|
p result
|
1238
1245
|
rescue FlatApi::ApiError => e
|
1239
1246
|
puts "Exception when calling ScoreApi->list_score_tracks: #{e}"
|
@@ -1245,7 +1252,7 @@ end
|
|
1245
1252
|
Name | Type | Description | Notes
|
1246
1253
|
------------- | ------------- | ------------- | -------------
|
1247
1254
|
**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`). |
|
1248
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1255
|
+
**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]
|
1249
1256
|
|
1250
1257
|
### Return type
|
1251
1258
|
|
@@ -1263,7 +1270,7 @@ Name | Type | Description | Notes
|
|
1263
1270
|
|
1264
1271
|
|
1265
1272
|
# **mark_score_comment_resolved**
|
1266
|
-
> mark_score_comment_resolved(
|
1273
|
+
> mark_score_comment_resolved(scorecomment, opts)
|
1267
1274
|
|
1268
1275
|
Mark the comment as resolved
|
1269
1276
|
|
@@ -1284,12 +1291,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
1284
1291
|
comment = "comment_example" # String | Unique identifier of a sheet music comment
|
1285
1292
|
|
1286
1293
|
opts = {
|
1287
|
-
sharing_key: "sharing_key_example"
|
1294
|
+
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.
|
1288
1295
|
}
|
1289
1296
|
|
1290
1297
|
begin
|
1291
1298
|
#Mark the comment as resolved
|
1292
|
-
api_instance.mark_score_comment_resolved(
|
1299
|
+
api_instance.mark_score_comment_resolved(scorecomment, opts)
|
1293
1300
|
rescue FlatApi::ApiError => e
|
1294
1301
|
puts "Exception when calling ScoreApi->mark_score_comment_resolved: #{e}"
|
1295
1302
|
end
|
@@ -1301,7 +1308,7 @@ Name | Type | Description | Notes
|
|
1301
1308
|
------------- | ------------- | ------------- | -------------
|
1302
1309
|
**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`). |
|
1303
1310
|
**comment** | **String**| Unique identifier of a sheet music comment |
|
1304
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1311
|
+
**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]
|
1305
1312
|
|
1306
1313
|
### Return type
|
1307
1314
|
|
@@ -1319,7 +1326,7 @@ nil (empty response body)
|
|
1319
1326
|
|
1320
1327
|
|
1321
1328
|
# **mark_score_comment_unresolved**
|
1322
|
-
> mark_score_comment_unresolved(
|
1329
|
+
> mark_score_comment_unresolved(scorecomment, opts)
|
1323
1330
|
|
1324
1331
|
Mark the comment as unresolved
|
1325
1332
|
|
@@ -1340,12 +1347,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
1340
1347
|
comment = "comment_example" # String | Unique identifier of a sheet music comment
|
1341
1348
|
|
1342
1349
|
opts = {
|
1343
|
-
sharing_key: "sharing_key_example"
|
1350
|
+
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.
|
1344
1351
|
}
|
1345
1352
|
|
1346
1353
|
begin
|
1347
1354
|
#Mark the comment as unresolved
|
1348
|
-
api_instance.mark_score_comment_unresolved(
|
1355
|
+
api_instance.mark_score_comment_unresolved(scorecomment, opts)
|
1349
1356
|
rescue FlatApi::ApiError => e
|
1350
1357
|
puts "Exception when calling ScoreApi->mark_score_comment_unresolved: #{e}"
|
1351
1358
|
end
|
@@ -1357,7 +1364,7 @@ Name | Type | Description | Notes
|
|
1357
1364
|
------------- | ------------- | ------------- | -------------
|
1358
1365
|
**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`). |
|
1359
1366
|
**comment** | **String**| Unique identifier of a sheet music comment |
|
1360
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1367
|
+
**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]
|
1361
1368
|
|
1362
1369
|
### Return type
|
1363
1370
|
|
@@ -1375,7 +1382,7 @@ nil (empty response body)
|
|
1375
1382
|
|
1376
1383
|
|
1377
1384
|
# **post_score_comment**
|
1378
|
-
> ScoreComment post_score_comment(
|
1385
|
+
> ScoreComment post_score_comment(scorebody, opts)
|
1379
1386
|
|
1380
1387
|
Post a new comment
|
1381
1388
|
|
@@ -1398,12 +1405,12 @@ score = "score_example" # String | Unique identifier of the score document. This
|
|
1398
1405
|
body = FlatApi::ScoreCommentCreation.new # ScoreCommentCreation |
|
1399
1406
|
|
1400
1407
|
opts = {
|
1401
|
-
sharing_key: "sharing_key_example"
|
1408
|
+
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.
|
1402
1409
|
}
|
1403
1410
|
|
1404
1411
|
begin
|
1405
1412
|
#Post a new comment
|
1406
|
-
result = api_instance.post_score_comment(
|
1413
|
+
result = api_instance.post_score_comment(scorebody, opts)
|
1407
1414
|
p result
|
1408
1415
|
rescue FlatApi::ApiError => e
|
1409
1416
|
puts "Exception when calling ScoreApi->post_score_comment: #{e}"
|
@@ -1416,7 +1423,7 @@ Name | Type | Description | Notes
|
|
1416
1423
|
------------- | ------------- | ------------- | -------------
|
1417
1424
|
**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`). |
|
1418
1425
|
**body** | [**ScoreCommentCreation**](ScoreCommentCreation.md)| |
|
1419
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1426
|
+
**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]
|
1420
1427
|
|
1421
1428
|
### Return type
|
1422
1429
|
|
@@ -1434,7 +1441,7 @@ Name | Type | Description | Notes
|
|
1434
1441
|
|
1435
1442
|
|
1436
1443
|
# **remove_score_collaborator**
|
1437
|
-
> remove_score_collaborator(
|
1444
|
+
> remove_score_collaborator(scorecollaborator)
|
1438
1445
|
|
1439
1446
|
Delete a collaborator
|
1440
1447
|
|
@@ -1459,7 +1466,7 @@ collaborator = "collaborator_example" # String | Unique identifier of a **collab
|
|
1459
1466
|
|
1460
1467
|
begin
|
1461
1468
|
#Delete a collaborator
|
1462
|
-
api_instance.remove_score_collaborator(
|
1469
|
+
api_instance.remove_score_collaborator(scorecollaborator)
|
1463
1470
|
rescue FlatApi::ApiError => e
|
1464
1471
|
puts "Exception when calling ScoreApi->remove_score_collaborator: #{e}"
|
1465
1472
|
end
|
@@ -1487,8 +1494,54 @@ nil (empty response body)
|
|
1487
1494
|
|
1488
1495
|
|
1489
1496
|
|
1497
|
+
# **untrash_score**
|
1498
|
+
> untrash_score(score)
|
1499
|
+
|
1500
|
+
Untrash a score
|
1501
|
+
|
1502
|
+
This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections.
|
1503
|
+
|
1504
|
+
### Example
|
1505
|
+
```ruby
|
1506
|
+
# load the gem
|
1507
|
+
require 'flat_api'
|
1508
|
+
|
1509
|
+
api_instance = FlatApi::ScoreApi.new
|
1510
|
+
|
1511
|
+
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`).
|
1512
|
+
|
1513
|
+
|
1514
|
+
begin
|
1515
|
+
#Untrash a score
|
1516
|
+
api_instance.untrash_score(score)
|
1517
|
+
rescue FlatApi::ApiError => e
|
1518
|
+
puts "Exception when calling ScoreApi->untrash_score: #{e}"
|
1519
|
+
end
|
1520
|
+
```
|
1521
|
+
|
1522
|
+
### Parameters
|
1523
|
+
|
1524
|
+
Name | Type | Description | Notes
|
1525
|
+
------------- | ------------- | ------------- | -------------
|
1526
|
+
**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`). |
|
1527
|
+
|
1528
|
+
### Return type
|
1529
|
+
|
1530
|
+
nil (empty response body)
|
1531
|
+
|
1532
|
+
### Authorization
|
1533
|
+
|
1534
|
+
No authorization required
|
1535
|
+
|
1536
|
+
### HTTP request headers
|
1537
|
+
|
1538
|
+
- **Content-Type**: application/json
|
1539
|
+
- **Accept**: application/json
|
1540
|
+
|
1541
|
+
|
1542
|
+
|
1490
1543
|
# **update_score_comment**
|
1491
|
-
> ScoreComment update_score_comment(
|
1544
|
+
> ScoreComment update_score_comment(scorecommentbody, opts)
|
1492
1545
|
|
1493
1546
|
Update an existing comment
|
1494
1547
|
|
@@ -1511,12 +1564,12 @@ comment = "comment_example" # String | Unique identifier of a sheet music commen
|
|
1511
1564
|
body = FlatApi::ScoreCommentUpdate.new # ScoreCommentUpdate |
|
1512
1565
|
|
1513
1566
|
opts = {
|
1514
|
-
sharing_key: "sharing_key_example"
|
1567
|
+
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.
|
1515
1568
|
}
|
1516
1569
|
|
1517
1570
|
begin
|
1518
1571
|
#Update an existing comment
|
1519
|
-
result = api_instance.update_score_comment(
|
1572
|
+
result = api_instance.update_score_comment(scorecommentbody, opts)
|
1520
1573
|
p result
|
1521
1574
|
rescue FlatApi::ApiError => e
|
1522
1575
|
puts "Exception when calling ScoreApi->update_score_comment: #{e}"
|
@@ -1530,7 +1583,7 @@ Name | Type | Description | Notes
|
|
1530
1583
|
**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`). |
|
1531
1584
|
**comment** | **String**| Unique identifier of a sheet music comment |
|
1532
1585
|
**body** | [**ScoreCommentUpdate**](ScoreCommentUpdate.md)| |
|
1533
|
-
**sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional]
|
1586
|
+
**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]
|
1534
1587
|
|
1535
1588
|
### Return type
|
1536
1589
|
|
@@ -1548,7 +1601,7 @@ Name | Type | Description | Notes
|
|
1548
1601
|
|
1549
1602
|
|
1550
1603
|
# **update_score_track**
|
1551
|
-
> ScoreTrack update_score_track(
|
1604
|
+
> ScoreTrack update_score_track(scoretrackbody)
|
1552
1605
|
|
1553
1606
|
Update an audio or video track linked to a score
|
1554
1607
|
|
@@ -1573,7 +1626,7 @@ body = FlatApi::ScoreTrackUpdate.new # ScoreTrackUpdate |
|
|
1573
1626
|
|
1574
1627
|
begin
|
1575
1628
|
#Update an audio or video track linked to a score
|
1576
|
-
result = api_instance.update_score_track(
|
1629
|
+
result = api_instance.update_score_track(scoretrackbody)
|
1577
1630
|
p result
|
1578
1631
|
rescue FlatApi::ApiError => e
|
1579
1632
|
puts "Exception when calling ScoreApi->update_score_track: #{e}"
|