flat_api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1 -1
- data/lib/flat_api/api/account_api.rb +2 -2
- data/lib/flat_api/api/class_api.rb +22 -22
- data/lib/flat_api/api/collection_api.rb +6 -6
- data/lib/flat_api/api/edu_resources_api.rb +6 -6
- data/lib/flat_api/api/group_api.rb +4 -4
- data/lib/flat_api/api/omr_api.rb +6 -6
- data/lib/flat_api/api/organization_api.rb +8 -8
- data/lib/flat_api/api/score_api.rb +38 -38
- data/lib/flat_api/api/task_api.rb +6 -6
- data/lib/flat_api/api/user_api.rb +6 -6
- data/lib/flat_api/api_client.rb +2 -2
- data/lib/flat_api/api_error.rb +2 -2
- data/lib/flat_api/api_model_base.rb +2 -2
- data/lib/flat_api/configuration.rb +2 -2
- data/lib/flat_api/models/add_group_user200_response.rb +2 -2
- data/lib/flat_api/models/add_group_user_request.rb +2 -2
- data/lib/flat_api/models/api_access_token.rb +4 -4
- data/lib/flat_api/models/app_scopes.rb +2 -2
- data/lib/flat_api/models/assignment.rb +5 -5
- data/lib/flat_api/models/assignment_capabilities.rb +2 -2
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +2 -2
- data/lib/flat_api/models/assignment_copy.rb +2 -2
- data/lib/flat_api/models/assignment_copy_response.rb +5 -5
- data/lib/flat_api/models/assignment_copy_to_class.rb +3 -3
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +3 -3
- data/lib/flat_api/models/assignment_group.rb +2 -2
- data/lib/flat_api/models/assignment_submission.rb +3 -3
- data/lib/flat_api/models/assignment_submission_comment.rb +2 -2
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +3 -3
- data/lib/flat_api/models/assignment_submission_comments.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history_state.rb +2 -2
- data/lib/flat_api/models/assignment_submission_lti.rb +2 -2
- data/lib/flat_api/models/assignment_submission_playback.rb +2 -2
- data/lib/flat_api/models/assignment_submission_state.rb +2 -2
- data/lib/flat_api/models/assignment_submission_students_mode.rb +2 -2
- data/lib/flat_api/models/assignment_submission_update.rb +4 -4
- data/lib/flat_api/models/assignment_type.rb +2 -2
- data/lib/flat_api/models/assignment_update.rb +5 -5
- data/lib/flat_api/models/class_assignment.rb +6 -6
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +3 -3
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +2 -2
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +3 -3
- data/lib/flat_api/models/class_assignment_update.rb +6 -6
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +2 -2
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +2 -2
- data/lib/flat_api/models/class_attachment_creation.rb +5 -5
- data/lib/flat_api/models/class_creation.rb +2 -2
- data/lib/flat_api/models/class_details.rb +5 -5
- data/lib/flat_api/models/class_details_canvas.rb +3 -3
- data/lib/flat_api/models/class_details_clever.rb +2 -2
- data/lib/flat_api/models/class_details_google_classroom.rb +2 -2
- data/lib/flat_api/models/class_details_google_drive.rb +2 -2
- data/lib/flat_api/models/class_details_issues.rb +2 -2
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +2 -2
- data/lib/flat_api/models/class_details_lti.rb +2 -2
- data/lib/flat_api/models/class_details_mfc.rb +3 -3
- data/lib/flat_api/models/class_details_microsoft_graph.rb +2 -2
- data/lib/flat_api/models/class_grade_level.rb +2 -2
- data/lib/flat_api/models/class_roles.rb +2 -2
- data/lib/flat_api/models/class_state.rb +2 -2
- data/lib/flat_api/models/class_update.rb +2 -2
- data/lib/flat_api/models/collection.rb +3 -3
- data/lib/flat_api/models/collection_app.rb +2 -2
- data/lib/flat_api/models/collection_capabilities.rb +2 -2
- data/lib/flat_api/models/collection_contents.rb +2 -2
- data/lib/flat_api/models/collection_creation.rb +2 -2
- data/lib/flat_api/models/collection_modification.rb +2 -2
- data/lib/flat_api/models/collection_privacy.rb +2 -2
- data/lib/flat_api/models/collection_type.rb +2 -2
- data/lib/flat_api/models/credit_transaction.rb +2 -2
- data/lib/flat_api/models/edu_library.rb +3 -3
- data/lib/flat_api/models/edu_resource.rb +2 -2
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +2 -2
- data/lib/flat_api/models/edu_resource_capabilities.rb +2 -2
- data/lib/flat_api/models/edu_resource_copy.rb +3 -3
- data/lib/flat_api/models/edu_resource_creation.rb +3 -3
- data/lib/flat_api/models/edu_resource_folder.rb +3 -3
- data/lib/flat_api/models/edu_resource_lti_link.rb +3 -3
- data/lib/flat_api/models/edu_resource_move.rb +3 -3
- data/lib/flat_api/models/edu_resource_privacy.rb +2 -2
- data/lib/flat_api/models/edu_resource_resource.rb +2 -2
- data/lib/flat_api/models/edu_resource_type.rb +2 -2
- data/lib/flat_api/models/edu_resource_update.rb +2 -2
- data/lib/flat_api/models/edu_resource_use_in_class.rb +3 -3
- data/lib/flat_api/models/flat_error_response.rb +3 -3
- data/lib/flat_api/models/google_classroom_coursework.rb +2 -2
- data/lib/flat_api/models/google_classroom_submission.rb +2 -2
- data/lib/flat_api/models/grade.rb +2 -2
- data/lib/flat_api/models/group.rb +2 -2
- data/lib/flat_api/models/group_creation.rb +2 -2
- data/lib/flat_api/models/group_details.rb +5 -5
- data/lib/flat_api/models/group_type.rb +2 -2
- data/lib/flat_api/models/license_mode.rb +2 -2
- data/lib/flat_api/models/license_sources.rb +2 -2
- data/lib/flat_api/models/lms_name.rb +2 -2
- data/lib/flat_api/models/lti_configuration.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p1.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +3 -3
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +3 -3
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +2 -2
- data/lib/flat_api/models/lti_configuration_base.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p1.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +3 -3
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +2 -2
- data/lib/flat_api/models/lti_credentials.rb +6 -6
- data/lib/flat_api/models/lti_credentials_creation.rb +4 -4
- data/lib/flat_api/models/media_attachment.rb +8 -8
- data/lib/flat_api/models/media_score_sharing_mode.rb +2 -2
- data/lib/flat_api/models/microsoft_graph_assignment.rb +2 -2
- data/lib/flat_api/models/microsoft_graph_submission.rb +2 -2
- data/lib/flat_api/models/omr_capabilities.rb +2 -2
- data/lib/flat_api/models/omr_details_step_data.rb +3 -3
- data/lib/flat_api/models/omr_details_submission.rb +2 -2
- data/lib/flat_api/models/omr_detected_instrument.rb +2 -2
- data/lib/flat_api/models/omr_imported_metadata.rb +2 -2
- data/lib/flat_api/models/omr_instrument_override.rb +2 -2
- data/lib/flat_api/models/omr_job.rb +13 -3
- data/lib/flat_api/models/omr_job_creation.rb +16 -4
- data/lib/flat_api/models/omr_job_file_metadata.rb +2 -2
- data/lib/flat_api/models/omr_job_file_upload.rb +2 -2
- data/lib/flat_api/models/omr_job_file_upload_result.rb +2 -2
- data/lib/flat_api/models/omr_job_input_file.rb +2 -2
- data/lib/flat_api/models/omr_job_output.rb +2 -2
- data/lib/flat_api/models/omr_job_progress.rb +2 -2
- data/lib/flat_api/models/omr_job_result.rb +2 -2
- data/lib/flat_api/models/omr_job_retention.rb +3 -3
- data/lib/flat_api/models/omr_job_status.rb +2 -2
- data/lib/flat_api/models/omr_locale_details.rb +2 -2
- data/lib/flat_api/models/omr_pending_step.rb +2 -2
- data/lib/flat_api/models/omr_step_name.rb +2 -2
- data/lib/flat_api/models/organization_invitation.rb +3 -3
- data/lib/flat_api/models/organization_invitation_creation.rb +2 -2
- data/lib/flat_api/models/organization_roles.rb +2 -2
- data/lib/flat_api/models/organization_user_access_token_creation.rb +2 -2
- data/lib/flat_api/models/rename_group_request.rb +2 -2
- data/lib/flat_api/models/resource_collaborator.rb +3 -3
- data/lib/flat_api/models/resource_collaborator_creation.rb +3 -3
- data/lib/flat_api/models/resource_rights.rb +2 -2
- data/lib/flat_api/models/score_comment.rb +7 -7
- data/lib/flat_api/models/score_comment_context.rb +5 -5
- data/lib/flat_api/models/score_comment_creation.rb +3 -3
- data/lib/flat_api/models/score_comment_moderation.rb +2 -2
- data/lib/flat_api/models/score_comment_update.rb +3 -3
- data/lib/flat_api/models/score_comments_counts.rb +2 -2
- data/lib/flat_api/models/score_creation.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data.rb +3 -3
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +4 -4
- data/lib/flat_api/models/score_creation_common.rb +3 -3
- data/lib/flat_api/models/score_creation_file_import.rb +3 -3
- data/lib/flat_api/models/score_creation_google_drive_import.rb +3 -3
- data/lib/flat_api/models/score_creation_type.rb +2 -2
- data/lib/flat_api/models/score_details.rb +7 -7
- data/lib/flat_api/models/score_details_all_of_me.rb +2 -2
- data/lib/flat_api/models/score_fork.rb +2 -2
- data/lib/flat_api/models/score_license.rb +2 -2
- data/lib/flat_api/models/score_likes_counts.rb +2 -2
- data/lib/flat_api/models/score_modification.rb +2 -2
- data/lib/flat_api/models/score_plays_counts.rb +2 -2
- data/lib/flat_api/models/score_privacy.rb +2 -2
- data/lib/flat_api/models/score_revision.rb +2 -2
- data/lib/flat_api/models/score_revision_creation.rb +3 -3
- data/lib/flat_api/models/score_revision_statistics.rb +2 -2
- data/lib/flat_api/models/score_source.rb +3 -3
- data/lib/flat_api/models/score_summary.rb +2 -2
- data/lib/flat_api/models/score_track.rb +2 -2
- data/lib/flat_api/models/score_track_creation.rb +2 -2
- data/lib/flat_api/models/score_track_creation_response.rb +2 -2
- data/lib/flat_api/models/score_track_point.rb +2 -2
- data/lib/flat_api/models/score_track_purpose.rb +2 -2
- data/lib/flat_api/models/score_track_state.rb +2 -2
- data/lib/flat_api/models/score_track_type.rb +2 -2
- data/lib/flat_api/models/score_track_update.rb +2 -2
- data/lib/flat_api/models/score_views_counts.rb +2 -2
- data/lib/flat_api/models/task.rb +2 -2
- data/lib/flat_api/models/task_export_options.rb +2 -2
- data/lib/flat_api/models/task_progress.rb +2 -2
- data/lib/flat_api/models/task_result.rb +4 -4
- data/lib/flat_api/models/teaching_theme.rb +2 -2
- data/lib/flat_api/models/tutteo_product.rb +2 -2
- data/lib/flat_api/models/user_admin_update.rb +2 -2
- data/lib/flat_api/models/user_azure_details.rb +2 -2
- data/lib/flat_api/models/user_basics.rb +2 -2
- data/lib/flat_api/models/user_community_profile_links.rb +3 -3
- data/lib/flat_api/models/user_creation.rb +2 -2
- data/lib/flat_api/models/user_details.rb +7 -7
- data/lib/flat_api/models/user_details_admin.rb +2 -2
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +3 -3
- data/lib/flat_api/models/user_public.rb +6 -6
- data/lib/flat_api/models/user_public_summary.rb +2 -2
- data/lib/flat_api/models/user_signin_link.rb +2 -2
- data/lib/flat_api/models/user_signin_link_creation.rb +2 -2
- data/lib/flat_api/version.rb +3 -3
- data/lib/flat_api.rb +2 -2
- metadata +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -20,7 +20,7 @@ module FlatApi
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add a new collaborator
|
|
23
|
-
# 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
|
|
23
|
+
# Share a score with a single user or a group. This API call allows you to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify their unique identifier in the `user` property. - To invite an external user to the resource, specify their 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.
|
|
24
24
|
# @param 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`).
|
|
25
25
|
# @param body [ResourceCollaboratorCreation]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module FlatApi
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Add a new collaborator
|
|
34
|
-
# 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
|
|
34
|
+
# Share a score with a single user or a group. This API call allows you to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify their unique identifier in the `user` property. - To invite an external user to the resource, specify their 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.
|
|
35
35
|
# @param 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`).
|
|
36
36
|
# @param body [ResourceCollaboratorCreation]
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -94,7 +94,7 @@ module FlatApi
|
|
|
94
94
|
end
|
|
95
95
|
|
|
96
96
|
# Add a new video or audio track to the score
|
|
97
|
-
# Use this method to add new track to the score. This track can then be played on flat.io or in an embedded score. This API method
|
|
97
|
+
# Use this method to add a new track to the score. This track can then be played on flat.io or in an embedded score. This API method supports media hosted on SoundCloud, YouTube and Vimeo.
|
|
98
98
|
# @param 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`).
|
|
99
99
|
# @param body [ScoreTrackCreation]
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
@@ -105,7 +105,7 @@ module FlatApi
|
|
|
105
105
|
end
|
|
106
106
|
|
|
107
107
|
# Add a new video or audio track to the score
|
|
108
|
-
# Use this method to add new track to the score. This track can then be played on flat.io or in an embedded score. This API method
|
|
108
|
+
# Use this method to add a new track to the score. This track can then be played on flat.io or in an embedded score. This API method supports media hosted on SoundCloud, YouTube and Vimeo.
|
|
109
109
|
# @param 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`).
|
|
110
110
|
# @param body [ScoreTrackCreation]
|
|
111
111
|
# @param [Hash] opts the optional parameters
|
|
@@ -168,7 +168,7 @@ module FlatApi
|
|
|
168
168
|
end
|
|
169
169
|
|
|
170
170
|
# Create a new score export task
|
|
171
|
-
# Some
|
|
171
|
+
# Some score exports take longer to process than a single API request allows. Use this endpoint to launch a new export of one score hosted on Flat.
|
|
172
172
|
# @param 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`).
|
|
173
173
|
# @param revision [String] Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
|
174
174
|
# @param format [String] The format of the file that will be generated or the target service name where the file will be exported
|
|
@@ -182,7 +182,7 @@ module FlatApi
|
|
|
182
182
|
end
|
|
183
183
|
|
|
184
184
|
# Create a new score export task
|
|
185
|
-
# Some
|
|
185
|
+
# Some score exports take longer to process than a single API request allows. Use this endpoint to launch a new export of one score hosted on Flat.
|
|
186
186
|
# @param 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`).
|
|
187
187
|
# @param revision [String] Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
|
188
188
|
# @param format [String] The format of the file that will be generated or the target service name where the file will be exported
|
|
@@ -258,7 +258,7 @@ module FlatApi
|
|
|
258
258
|
end
|
|
259
259
|
|
|
260
260
|
# Create a new score
|
|
261
|
-
# Use this API method to **create a new music score in the current User account**. This
|
|
261
|
+
# Use this API method to **create a new music score in the current User account**. This endpoint provides 3 ways to create scores: * `ScoreCreationBuilderData` : Create a blank score by providing the list of instruments to use. You can optionally customize the initial key signature, time signature, enable TABs, Chord grids, as well as the page layout. * `ScoreCreationFileImport`: Import a file to create the new Flat document. **Preferred formats**: * **MusicXML**: `.xml`, `.musicxml`, `.mxl` (compressed) — MIME: `vnd.recordare.musicxml+xml`, `vnd.recordare.musicxml`. This is the only format that preserves all notation data (articulations, dynamics, layout, etc.) with full round-trip support. * **MIDI**: `.mid`, `.midi` — MIME: `audio/midi`. Only preserves pitch, timing, and instrument data; notation details are lost. **Also supported** (converted to MusicXML on import, some notation details may be lost): * **Guitar Pro**: `.gp`, `.gp3`, `.gp4`, `.gp5`, `.gpx`, `.gtp` * **MuseScore**: `.mscz`, `.mscx` * **Finale**: `.musx` * **ABC notation**: `.abc` — MIME: `text/vnd.abc` * **PowerTab**: `.ptb` * **Capella**: `.cap`, `.capx` * **MEI**: `.mei` * **Overture**: `.ove` * **TablEdit**: `.tef` * **Band-in-a-Box**: `.mgu`, `.sgu` * **Karaoke MIDI**: `.kar` * **MuseData**: `.md` * **Score Writer**: `.scw` * **Bagpipe Music Writer**: `.bmw`, `.bww` * **Encore**: `.enc` **Scanned music** (requires `supportsTasks`, runs our music recognition and spends credits): * **PDF**: `.pdf` * **Images**: `.jpg`, `.png`, `.webp`, `.tiff`, `.gif`, `.avif`, `.heic`, `.heif` The file is identified by its own content, so its extension and any declared type do not have to match. **One file per request**: a multi-page PDF or a multi-frame TIFF is fine, but several separate images of the same score (a page photographed at a time) need `createOmrJob`, which takes many inputs in one job and bills them as a single document. Its live limits are served by `getOmrCapabilities`. * `ScoreCreationGoogleDriveImport`: Import an existing Google Drive file from the connected Google Drive account. This API call will automatically create the first revision of the document, the score can then be modified using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions`). The currently authenticated user will be the 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. When using an OAuth2 access token or a personal token, the score will be automatically added to your dedicated app collection in the account (`/v2/collections/app`). 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}`.
|
|
262
262
|
# @param body [ScoreCreation]
|
|
263
263
|
# @param [Hash] opts the optional parameters
|
|
264
264
|
# @return [ScoreDetails]
|
|
@@ -268,7 +268,7 @@ module FlatApi
|
|
|
268
268
|
end
|
|
269
269
|
|
|
270
270
|
# Create a new score
|
|
271
|
-
# Use this API method to **create a new music score in the current User account**. This
|
|
271
|
+
# Use this API method to **create a new music score in the current User account**. This endpoint provides 3 ways to create scores: * `ScoreCreationBuilderData` : Create a blank score by providing the list of instruments to use. You can optionally customize the initial key signature, time signature, enable TABs, Chord grids, as well as the page layout. * `ScoreCreationFileImport`: Import a file to create the new Flat document. **Preferred formats**: * **MusicXML**: `.xml`, `.musicxml`, `.mxl` (compressed) — MIME: `vnd.recordare.musicxml+xml`, `vnd.recordare.musicxml`. This is the only format that preserves all notation data (articulations, dynamics, layout, etc.) with full round-trip support. * **MIDI**: `.mid`, `.midi` — MIME: `audio/midi`. Only preserves pitch, timing, and instrument data; notation details are lost. **Also supported** (converted to MusicXML on import, some notation details may be lost): * **Guitar Pro**: `.gp`, `.gp3`, `.gp4`, `.gp5`, `.gpx`, `.gtp` * **MuseScore**: `.mscz`, `.mscx` * **Finale**: `.musx` * **ABC notation**: `.abc` — MIME: `text/vnd.abc` * **PowerTab**: `.ptb` * **Capella**: `.cap`, `.capx` * **MEI**: `.mei` * **Overture**: `.ove` * **TablEdit**: `.tef` * **Band-in-a-Box**: `.mgu`, `.sgu` * **Karaoke MIDI**: `.kar` * **MuseData**: `.md` * **Score Writer**: `.scw` * **Bagpipe Music Writer**: `.bmw`, `.bww` * **Encore**: `.enc` **Scanned music** (requires `supportsTasks`, runs our music recognition and spends credits): * **PDF**: `.pdf` * **Images**: `.jpg`, `.png`, `.webp`, `.tiff`, `.gif`, `.avif`, `.heic`, `.heif` The file is identified by its own content, so its extension and any declared type do not have to match. **One file per request**: a multi-page PDF or a multi-frame TIFF is fine, but several separate images of the same score (a page photographed at a time) need `createOmrJob`, which takes many inputs in one job and bills them as a single document. Its live limits are served by `getOmrCapabilities`. * `ScoreCreationGoogleDriveImport`: Import an existing Google Drive file from the connected Google Drive account. This API call will automatically create the first revision of the document, the score can then be modified using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions`). The currently authenticated user will be the 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. When using an OAuth2 access token or a personal token, the score will be automatically added to your dedicated app collection in the account (`/v2/collections/app`). 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}`.
|
|
272
272
|
# @param body [ScoreCreation]
|
|
273
273
|
# @param [Hash] opts the optional parameters
|
|
274
274
|
# @return [Array<(ScoreDetails, Integer, Hash)>] ScoreDetails data, response status code and response headers
|
|
@@ -400,10 +400,10 @@ module FlatApi
|
|
|
400
400
|
end
|
|
401
401
|
|
|
402
402
|
# Delete a score
|
|
403
|
-
# This method can be used by anyone that has at least read access to the document: - 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 collaborator, the score will be unshared (i.e. removed from the account & own collections). - When called by another user that has the score in its collections, the score will be removed from all the user collections.
|
|
403
|
+
# This method can be used by anyone that has at least read access to the document: - 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 collaborator, the score will be unshared (i.e. removed from the account & own collections). - When called by another user that has the score in its collections, the score will be removed from all the user's collections.
|
|
404
404
|
# @param 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`).
|
|
405
405
|
# @param [Hash] opts the optional parameters
|
|
406
|
-
# @option opts [Boolean] :now If `true`, the score deletion will be scheduled
|
|
406
|
+
# @option opts [Boolean] :now If `true`, the score deletion will be scheduled as soon as possible (default to false)
|
|
407
407
|
# @return [nil]
|
|
408
408
|
def delete_score(score, opts = {})
|
|
409
409
|
delete_score_with_http_info(score, opts)
|
|
@@ -411,10 +411,10 @@ module FlatApi
|
|
|
411
411
|
end
|
|
412
412
|
|
|
413
413
|
# Delete a score
|
|
414
|
-
# This method can be used by anyone that has at least read access to the document: - 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 collaborator, the score will be unshared (i.e. removed from the account & own collections). - When called by another user that has the score in its collections, the score will be removed from all the user collections.
|
|
414
|
+
# This method can be used by anyone that has at least read access to the document: - 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 collaborator, the score will be unshared (i.e. removed from the account & own collections). - When called by another user that has the score in its collections, the score will be removed from all the user's collections.
|
|
415
415
|
# @param 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`).
|
|
416
416
|
# @param [Hash] opts the optional parameters
|
|
417
|
-
# @option opts [Boolean] :now If `true`, the score deletion will be scheduled
|
|
417
|
+
# @option opts [Boolean] :now If `true`, the score deletion will be scheduled as soon as possible (default to false)
|
|
418
418
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
419
419
|
def delete_score_with_http_info(score, opts = {})
|
|
420
420
|
if @api_client.config.debugging
|
|
@@ -469,7 +469,7 @@ module FlatApi
|
|
|
469
469
|
# @param 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`).
|
|
470
470
|
# @param comment [String] Unique identifier of a sheet music comment
|
|
471
471
|
# @param [Hash] opts the optional parameters
|
|
472
|
-
# @option opts [String] :event_properties Optional analytics properties merged into
|
|
472
|
+
# @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
473
473
|
# @option opts [String] :sharing_key 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.
|
|
474
474
|
# @return [nil]
|
|
475
475
|
def delete_score_comment(score, comment, opts = {})
|
|
@@ -481,7 +481,7 @@ module FlatApi
|
|
|
481
481
|
# @param 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`).
|
|
482
482
|
# @param comment [String] Unique identifier of a sheet music comment
|
|
483
483
|
# @param [Hash] opts the optional parameters
|
|
484
|
-
# @option opts [String] :event_properties Optional analytics properties merged into
|
|
484
|
+
# @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
485
485
|
# @option opts [String] :sharing_key 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.
|
|
486
486
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
487
487
|
def delete_score_comment_with_http_info(score, comment, opts = {})
|
|
@@ -611,7 +611,7 @@ module FlatApi
|
|
|
611
611
|
end
|
|
612
612
|
|
|
613
613
|
# Edit a score's metadata
|
|
614
|
-
# 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
|
|
614
|
+
# 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`). When editing the `title`, `subtitle`, `composer`, `lyricist`, `arranger` or `licenseText`, the metadata is updated immediately, and a real-time action is pushed to update the document lazily. This pending document modification is automatically saved as a new revision, either by a connected client or by Flat.
|
|
615
615
|
# @param 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`).
|
|
616
616
|
# @param body [ScoreModification]
|
|
617
617
|
# @param [Hash] opts the optional parameters
|
|
@@ -622,7 +622,7 @@ module FlatApi
|
|
|
622
622
|
end
|
|
623
623
|
|
|
624
624
|
# Edit a score's metadata
|
|
625
|
-
# 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
|
|
625
|
+
# 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`). When editing the `title`, `subtitle`, `composer`, `lyricist`, `arranger` or `licenseText`, the metadata is updated immediately, and a real-time action is pushed to update the document lazily. This pending document modification is automatically saved as a new revision, either by a connected client or by Flat.
|
|
626
626
|
# @param 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`).
|
|
627
627
|
# @param body [ScoreModification]
|
|
628
628
|
# @param [Hash] opts the optional parameters
|
|
@@ -765,7 +765,7 @@ module FlatApi
|
|
|
765
765
|
# Get the list of scores shared with a group.
|
|
766
766
|
# @param group [String] Unique identifier of a Flat group
|
|
767
767
|
# @param [Hash] opts the optional parameters
|
|
768
|
-
# @option opts [String] :parent
|
|
768
|
+
# @option opts [String] :parent Only return the scores forked from the score `parent`
|
|
769
769
|
# @return [Array<ScoreDetails>]
|
|
770
770
|
def get_group_scores(group, opts = {})
|
|
771
771
|
data, _status_code, _headers = get_group_scores_with_http_info(group, opts)
|
|
@@ -776,7 +776,7 @@ module FlatApi
|
|
|
776
776
|
# Get the list of scores shared with a group.
|
|
777
777
|
# @param group [String] Unique identifier of a Flat group
|
|
778
778
|
# @param [Hash] opts the optional parameters
|
|
779
|
-
# @option opts [String] :parent
|
|
779
|
+
# @option opts [String] :parent Only return the scores forked from the score `parent`
|
|
780
780
|
# @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
|
781
781
|
def get_group_scores_with_http_info(group, opts = {})
|
|
782
782
|
if @api_client.config.debugging
|
|
@@ -1191,13 +1191,13 @@ module FlatApi
|
|
|
1191
1191
|
end
|
|
1192
1192
|
|
|
1193
1193
|
# Get a score revision data
|
|
1194
|
-
# Retrieve the file corresponding to a score revision (the following formats are available): Flat JSON
|
|
1194
|
+
# Retrieve the file corresponding to a score revision (the following formats are available): Flat JSON `json`, MusicXML `mxl`/`xml`, ABC notation `abc`, MP3 `mp3`, WAV `wav`, MIDI `midi`, Flat `flat`, a thumbnail of the first page `thumbnail.png` or auto sync points `synchronizationPoints`. ABC notation is a text format that cannot express everything a score contains. Like MIDI, the export is lossy: notation that ABC has no equivalent for is approximated or dropped rather than failing the request.
|
|
1195
1195
|
# @param 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`).
|
|
1196
1196
|
# @param revision [String] Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
|
1197
1197
|
# @param format [String] The format of the file you will retrieve
|
|
1198
1198
|
# @param [Hash] opts the optional parameters
|
|
1199
1199
|
# @option opts [String] :sharing_key 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.
|
|
1200
|
-
# @option opts [String] :parts An optional
|
|
1200
|
+
# @option opts [String] :parts An optional set of part UUIDs to export. This parameter must be composed of part UUIDs separated by commas. For example \"59df645f-bb1c-f1b4-b573-d2afc4491f94,34ef645f-1aef-f3bc-1564-34cca4492b87\".
|
|
1201
1201
|
# @option opts [Boolean] :default_track When `format` is `mp3`, this property is set to true and the score has a default `ScoreTrack` (mp3), this one will be returned instead of the playback file.
|
|
1202
1202
|
# @option opts [Boolean] :url Returns a json with the `url` in it instead of redirecting
|
|
1203
1203
|
# @return [File]
|
|
@@ -1207,13 +1207,13 @@ module FlatApi
|
|
|
1207
1207
|
end
|
|
1208
1208
|
|
|
1209
1209
|
# Get a score revision data
|
|
1210
|
-
# Retrieve the file corresponding to a score revision (the following formats are available): Flat JSON
|
|
1210
|
+
# Retrieve the file corresponding to a score revision (the following formats are available): Flat JSON `json`, MusicXML `mxl`/`xml`, ABC notation `abc`, MP3 `mp3`, WAV `wav`, MIDI `midi`, Flat `flat`, a thumbnail of the first page `thumbnail.png` or auto sync points `synchronizationPoints`. ABC notation is a text format that cannot express everything a score contains. Like MIDI, the export is lossy: notation that ABC has no equivalent for is approximated or dropped rather than failing the request.
|
|
1211
1211
|
# @param 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`).
|
|
1212
1212
|
# @param revision [String] Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
|
1213
1213
|
# @param format [String] The format of the file you will retrieve
|
|
1214
1214
|
# @param [Hash] opts the optional parameters
|
|
1215
1215
|
# @option opts [String] :sharing_key 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.
|
|
1216
|
-
# @option opts [String] :parts An optional
|
|
1216
|
+
# @option opts [String] :parts An optional set of part UUIDs to export. This parameter must be composed of part UUIDs separated by commas. For example \"59df645f-bb1c-f1b4-b573-d2afc4491f94,34ef645f-1aef-f3bc-1564-34cca4492b87\".
|
|
1217
1217
|
# @option opts [Boolean] :default_track When `format` is `mp3`, this property is set to true and the score has a default `ScoreTrack` (mp3), this one will be returned instead of the playback file.
|
|
1218
1218
|
# @option opts [Boolean] :url Returns a json with the `url` in it instead of redirecting
|
|
1219
1219
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
@@ -1283,7 +1283,7 @@ module FlatApi
|
|
|
1283
1283
|
end
|
|
1284
1284
|
|
|
1285
1285
|
# List the revisions
|
|
1286
|
-
# When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list
|
|
1286
|
+
# When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending on the plan of the account, this list may be truncated to the most recent revisions.
|
|
1287
1287
|
# @param 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`).
|
|
1288
1288
|
# @param [Hash] opts the optional parameters
|
|
1289
1289
|
# @option opts [String] :sharing_key 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.
|
|
@@ -1294,7 +1294,7 @@ module FlatApi
|
|
|
1294
1294
|
end
|
|
1295
1295
|
|
|
1296
1296
|
# List the revisions
|
|
1297
|
-
# When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list
|
|
1297
|
+
# When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending on the plan of the account, this list may be truncated to the most recent revisions.
|
|
1298
1298
|
# @param 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`).
|
|
1299
1299
|
# @param [Hash] opts the optional parameters
|
|
1300
1300
|
# @option opts [String] :sharing_key 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.
|
|
@@ -1349,7 +1349,7 @@ module FlatApi
|
|
|
1349
1349
|
end
|
|
1350
1350
|
|
|
1351
1351
|
# List submissions related to the score
|
|
1352
|
-
# This API call will list the different assignments submissions where the score is attached. This method can be used by anyone
|
|
1352
|
+
# This API call will list the different assignments submissions where the score is attached. This method can be used by anyone who is part of the organization and has at least read access to the document.
|
|
1353
1353
|
# @param 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`).
|
|
1354
1354
|
# @param [Hash] opts the optional parameters
|
|
1355
1355
|
# @return [Array<AssignmentSubmission>]
|
|
@@ -1359,7 +1359,7 @@ module FlatApi
|
|
|
1359
1359
|
end
|
|
1360
1360
|
|
|
1361
1361
|
# List submissions related to the score
|
|
1362
|
-
# This API call will list the different assignments submissions where the score is attached. This method can be used by anyone
|
|
1362
|
+
# This API call will list the different assignments submissions where the score is attached. This method can be used by anyone who is part of the organization and has at least read access to the document.
|
|
1363
1363
|
# @param 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`).
|
|
1364
1364
|
# @param [Hash] opts the optional parameters
|
|
1365
1365
|
# @return [Array<(Array<AssignmentSubmission>, Integer, Hash)>] Array<AssignmentSubmission> data, response status code and response headers
|
|
@@ -1563,7 +1563,7 @@ module FlatApi
|
|
|
1563
1563
|
end
|
|
1564
1564
|
|
|
1565
1565
|
# List user's scores
|
|
1566
|
-
# Get the list of public scores owned by a User. If you want to access
|
|
1566
|
+
# Get the list of public scores owned by a User. If you want to access private scores, please use the [Collections API](#tag/Collection). For example `GET /v2/collections/allScores/scores` to list all recently updated scores.
|
|
1567
1567
|
# @param user [String] Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
|
1568
1568
|
# @param [Hash] opts the optional parameters
|
|
1569
1569
|
# @option opts [Boolean] :paginate When set to `true`, the API will return a paginated result. When set to `false` or unset, the API will return all the scores. If this parameter is unset or false, then limit/sort/direction/next/previous will be ignored. (default to false)
|
|
@@ -1579,7 +1579,7 @@ module FlatApi
|
|
|
1579
1579
|
end
|
|
1580
1580
|
|
|
1581
1581
|
# List user's scores
|
|
1582
|
-
# Get the list of public scores owned by a User. If you want to access
|
|
1582
|
+
# Get the list of public scores owned by a User. If you want to access private scores, please use the [Collections API](#tag/Collection). For example `GET /v2/collections/allScores/scores` to list all recently updated scores.
|
|
1583
1583
|
# @param user [String] Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
|
1584
1584
|
# @param [Hash] opts the optional parameters
|
|
1585
1585
|
# @option opts [Boolean] :paginate When set to `true`, the API will return a paginated result. When set to `false` or unset, the API will return all the scores. If this parameter is unset or false, then limit/sort/direction/next/previous will be ignored. (default to false)
|
|
@@ -1664,8 +1664,8 @@ module FlatApi
|
|
|
1664
1664
|
# @param 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`).
|
|
1665
1665
|
# @param [Hash] opts the optional parameters
|
|
1666
1666
|
# @option opts [String] :sharing_key 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.
|
|
1667
|
-
# @option opts [String] :assignment
|
|
1668
|
-
# @option opts [Boolean] :list_auto_track If true
|
|
1667
|
+
# @option opts [String] :assignment Only return the tracks related to this assignment
|
|
1668
|
+
# @option opts [Boolean] :list_auto_track If `true`, and when available, also return the latest MP3 export automatically generated by Flat as an additional track
|
|
1669
1669
|
# @return [Array<ScoreTrack>]
|
|
1670
1670
|
def list_score_tracks(score, opts = {})
|
|
1671
1671
|
data, _status_code, _headers = list_score_tracks_with_http_info(score, opts)
|
|
@@ -1677,8 +1677,8 @@ module FlatApi
|
|
|
1677
1677
|
# @param 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`).
|
|
1678
1678
|
# @param [Hash] opts the optional parameters
|
|
1679
1679
|
# @option opts [String] :sharing_key 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.
|
|
1680
|
-
# @option opts [String] :assignment
|
|
1681
|
-
# @option opts [Boolean] :list_auto_track If true
|
|
1680
|
+
# @option opts [String] :assignment Only return the tracks related to this assignment
|
|
1681
|
+
# @option opts [Boolean] :list_auto_track If `true`, and when available, also return the latest MP3 export automatically generated by Flat as an additional track
|
|
1682
1682
|
# @return [Array<(Array<ScoreTrack>, Integer, Hash)>] Array<ScoreTrack> data, response status code and response headers
|
|
1683
1683
|
def list_score_tracks_with_http_info(score, opts = {})
|
|
1684
1684
|
if @api_client.config.debugging
|
|
@@ -1872,7 +1872,7 @@ module FlatApi
|
|
|
1872
1872
|
end
|
|
1873
1873
|
|
|
1874
1874
|
# Post a new comment
|
|
1875
|
-
# Post a document or a contextualized comment on a document. Please note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end
|
|
1875
|
+
# Post a document or a contextualized comment on a document. Please note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end users. Comments can be blocked by returning a `403` HTTP error and hidden from other users when the `spam` property is `true`.
|
|
1876
1876
|
# @param 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`).
|
|
1877
1877
|
# @param body [ScoreCommentCreation]
|
|
1878
1878
|
# @param [Hash] opts the optional parameters
|
|
@@ -1884,7 +1884,7 @@ module FlatApi
|
|
|
1884
1884
|
end
|
|
1885
1885
|
|
|
1886
1886
|
# Post a new comment
|
|
1887
|
-
# Post a document or a contextualized comment on a document. Please note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end
|
|
1887
|
+
# Post a document or a contextualized comment on a document. Please note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end users. Comments can be blocked by returning a `403` HTTP error and hidden from other users when the `spam` property is `true`.
|
|
1888
1888
|
# @param 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`).
|
|
1889
1889
|
# @param body [ScoreCommentCreation]
|
|
1890
1890
|
# @param [Hash] opts the optional parameters
|
|
@@ -1953,7 +1953,7 @@ module FlatApi
|
|
|
1953
1953
|
# @param 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`).
|
|
1954
1954
|
# @param collaborator [String] Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
|
|
1955
1955
|
# @param [Hash] opts the optional parameters
|
|
1956
|
-
# @option opts [String] :event_properties Optional analytics properties merged into
|
|
1956
|
+
# @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
1957
1957
|
# @return [nil]
|
|
1958
1958
|
def remove_score_collaborator(score, collaborator, opts = {})
|
|
1959
1959
|
remove_score_collaborator_with_http_info(score, collaborator, opts)
|
|
@@ -1965,7 +1965,7 @@ module FlatApi
|
|
|
1965
1965
|
# @param 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`).
|
|
1966
1966
|
# @param collaborator [String] Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
|
|
1967
1967
|
# @param [Hash] opts the optional parameters
|
|
1968
|
-
# @option opts [String] :event_properties Optional analytics properties merged into
|
|
1968
|
+
# @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
1969
1969
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1970
1970
|
def remove_score_collaborator_with_http_info(score, collaborator, opts = {})
|
|
1971
1971
|
if @api_client.config.debugging
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -19,8 +19,8 @@ module FlatApi
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Get
|
|
23
|
-
# This method can be used to follow a task
|
|
22
|
+
# Get task details
|
|
23
|
+
# This method can be used to follow the progress of a task, for example while a score is being exported.
|
|
24
24
|
# @param task [String] Unique identifier for the task
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [Task]
|
|
@@ -29,8 +29,8 @@ module FlatApi
|
|
|
29
29
|
data
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Get
|
|
33
|
-
# This method can be used to follow a task
|
|
32
|
+
# Get task details
|
|
33
|
+
# This method can be used to follow the progress of a task, for example while a score is being exported.
|
|
34
34
|
# @param task [String] Unique identifier for the task
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -21,7 +21,7 @@ module FlatApi
|
|
|
21
21
|
end
|
|
22
22
|
# Get a public user profile
|
|
23
23
|
# Get a profile of a Flat or Flat for Education User.
|
|
24
|
-
# @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of
|
|
24
|
+
# @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of a 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.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [UserPublic]
|
|
27
27
|
def get_user(user, opts = {})
|
|
@@ -31,7 +31,7 @@ module FlatApi
|
|
|
31
31
|
|
|
32
32
|
# Get a public user profile
|
|
33
33
|
# Get a profile of a Flat or Flat for Education User.
|
|
34
|
-
# @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of
|
|
34
|
+
# @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of a 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.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(UserPublic, Integer, Hash)>] UserPublic data, response status code and response headers
|
|
37
37
|
def get_user_with_http_info(user, opts = {})
|
|
@@ -164,7 +164,7 @@ module FlatApi
|
|
|
164
164
|
end
|
|
165
165
|
|
|
166
166
|
# List user's scores
|
|
167
|
-
# Get the list of public scores owned by a User. If you want to access
|
|
167
|
+
# Get the list of public scores owned by a User. If you want to access private scores, please use the [Collections API](#tag/Collection). For example `GET /v2/collections/allScores/scores` to list all recently updated scores.
|
|
168
168
|
# @param user [String] Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
|
169
169
|
# @param [Hash] opts the optional parameters
|
|
170
170
|
# @option opts [Boolean] :paginate When set to `true`, the API will return a paginated result. When set to `false` or unset, the API will return all the scores. If this parameter is unset or false, then limit/sort/direction/next/previous will be ignored. (default to false)
|
|
@@ -180,7 +180,7 @@ module FlatApi
|
|
|
180
180
|
end
|
|
181
181
|
|
|
182
182
|
# List user's scores
|
|
183
|
-
# Get the list of public scores owned by a User. If you want to access
|
|
183
|
+
# Get the list of public scores owned by a User. If you want to access private scores, please use the [Collections API](#tag/Collection). For example `GET /v2/collections/allScores/scores` to list all recently updated scores.
|
|
184
184
|
# @param user [String] Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
|
185
185
|
# @param [Hash] opts the optional parameters
|
|
186
186
|
# @option opts [Boolean] :paginate When set to `true`, the API will return a paginated result. When set to `false` or unset, the API will return all the scores. If this parameter is unset or false, then limit/sort/direction/next/previous will be ignored. (default to false)
|
data/lib/flat_api/api_client.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
data/lib/flat_api/api_error.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful: it has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|