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
|
|
@@ -21,7 +21,10 @@ module FlatApi
|
|
|
21
21
|
# Steps at which the pipeline should pause for this client. Omit or send `[]` for a fully automatic import. The server only pauses at the steps listed here; declare only steps your client can actually render.
|
|
22
22
|
attr_accessor :interactive_steps
|
|
23
23
|
|
|
24
|
-
#
|
|
24
|
+
# Let the server detect and correct pages uploaded sideways or upside down (90/180/270°) before recognition. Off by default: pages are recognized in the orientation they are uploaded in, which is the right choice when your client lets the user rotate pages before upload. Enable it when it does not, for example a server-to-server integration importing scans as they come. Small tilt correction (a few degrees) always runs.
|
|
25
|
+
attr_accessor :auto_rotate
|
|
26
|
+
|
|
27
|
+
# Locale hints (BCP 47) to improve text and lyric detection, for example `[\"ja\", \"en\"]`. The first entry is the primary reading language. This is the input hint; the main language can be confirmed or corrected at the `details` step.
|
|
25
28
|
attr_accessor :locales
|
|
26
29
|
|
|
27
30
|
# Target collection ID. Only used when `output` is `library`.
|
|
@@ -63,6 +66,7 @@ module FlatApi
|
|
|
63
66
|
{
|
|
64
67
|
:'output' => :'output',
|
|
65
68
|
:'interactive_steps' => :'interactiveSteps',
|
|
69
|
+
:'auto_rotate' => :'autoRotate',
|
|
66
70
|
:'locales' => :'locales',
|
|
67
71
|
:'collection' => :'collection',
|
|
68
72
|
:'idempotency_key' => :'idempotencyKey',
|
|
@@ -86,6 +90,7 @@ module FlatApi
|
|
|
86
90
|
{
|
|
87
91
|
:'output' => :'OmrJobOutput',
|
|
88
92
|
:'interactive_steps' => :'Array<OmrStepName>',
|
|
93
|
+
:'auto_rotate' => :'Boolean',
|
|
89
94
|
:'locales' => :'Array<String>',
|
|
90
95
|
:'collection' => :'String',
|
|
91
96
|
:'idempotency_key' => :'String',
|
|
@@ -128,6 +133,12 @@ module FlatApi
|
|
|
128
133
|
end
|
|
129
134
|
end
|
|
130
135
|
|
|
136
|
+
if attributes.key?(:'auto_rotate')
|
|
137
|
+
self.auto_rotate = attributes[:'auto_rotate']
|
|
138
|
+
else
|
|
139
|
+
self.auto_rotate = false
|
|
140
|
+
end
|
|
141
|
+
|
|
131
142
|
if attributes.key?(:'locales')
|
|
132
143
|
if (value = attributes[:'locales']).is_a?(Array)
|
|
133
144
|
self.locales = value
|
|
@@ -175,6 +186,7 @@ module FlatApi
|
|
|
175
186
|
self.class == o.class &&
|
|
176
187
|
output == o.output &&
|
|
177
188
|
interactive_steps == o.interactive_steps &&
|
|
189
|
+
auto_rotate == o.auto_rotate &&
|
|
178
190
|
locales == o.locales &&
|
|
179
191
|
collection == o.collection &&
|
|
180
192
|
idempotency_key == o.idempotency_key &&
|
|
@@ -191,7 +203,7 @@ module FlatApi
|
|
|
191
203
|
# Calculates hash code according to all attributes.
|
|
192
204
|
# @return [Integer] Hash code
|
|
193
205
|
def hash
|
|
194
|
-
[output, interactive_steps, locales, collection, idempotency_key, files, auto_start].hash
|
|
206
|
+
[output, interactive_steps, auto_rotate, locales, collection, idempotency_key, files, auto_start].hash
|
|
195
207
|
end
|
|
196
208
|
|
|
197
209
|
# Builds the object from hash
|
|
@@ -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
|
|
@@ -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
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
# Data-retention state of the job. Present only on jobs whose `output` is `musicxml`. Jobs imported into the Flat library are part of your library content, are not covered by this policy, and omit this object entirely. Erasure
|
|
17
|
+
# Data-retention state of the job. Present only on jobs whose `output` is `musicxml`. Jobs imported into the Flat library are part of your library content, are not covered by this policy, and omit this object entirely. Erasure happens shortly after `expiryDate` rather than exactly on it. Plan for the deadline, not the instant.
|
|
18
18
|
class OmrJobRetention < ApiModelBase
|
|
19
19
|
# When this job's uploaded files and recognition results become eligible for erasure. Fixed when the job is created: changing the account's retention period does not move the deadline of jobs that already exist.
|
|
20
20
|
attr_accessor :expiry_date
|
|
@@ -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
|
|
@@ -22,7 +22,7 @@ module FlatApi
|
|
|
22
22
|
# The creation date of the invitation
|
|
23
23
|
attr_accessor :creation_date
|
|
24
24
|
|
|
25
|
-
# The unique identifier of the Organization
|
|
25
|
+
# The unique identifier of the Organization this invitation belongs to
|
|
26
26
|
attr_accessor :organization
|
|
27
27
|
|
|
28
28
|
attr_accessor :organization_role
|
|
@@ -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
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
# A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (
|
|
17
|
+
# A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (otherwise these permissions are not listed or exposed publicly).
|
|
18
18
|
class ResourceCollaborator < ApiModelBase
|
|
19
19
|
# `True` if the current user can read the current document
|
|
20
20
|
attr_accessor :acl_read
|
|
@@ -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
|
|
@@ -34,7 +34,7 @@ module FlatApi
|
|
|
34
34
|
# `True` if the related user can modify the score.
|
|
35
35
|
attr_accessor :acl_write
|
|
36
36
|
|
|
37
|
-
# `True` if the related user can
|
|
37
|
+
# `True` if the related user can manage the current document, i.e. changing the document permissions and deleting the document
|
|
38
38
|
attr_accessor :acl_admin
|
|
39
39
|
|
|
40
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -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
|
|
@@ -28,7 +28,7 @@ module FlatApi
|
|
|
28
28
|
# The unique identifier of the score where the comment was posted
|
|
29
29
|
attr_accessor :score
|
|
30
30
|
|
|
31
|
-
# The unique identifier of revision the comment was posted
|
|
31
|
+
# The unique identifier of the revision where the comment was posted
|
|
32
32
|
attr_accessor :revision
|
|
33
33
|
|
|
34
34
|
# When the comment is a reply to another comment, the unique identifier of the parent comment
|
|
@@ -40,7 +40,7 @@ module FlatApi
|
|
|
40
40
|
# The date of the last comment modification
|
|
41
41
|
attr_accessor :modification_date
|
|
42
42
|
|
|
43
|
-
# The comment text that can
|
|
43
|
+
# The comment text that can include mentions using the following format: `@[id:username]`.
|
|
44
44
|
attr_accessor :comment
|
|
45
45
|
|
|
46
46
|
# A raw version of the comment, that can be displayed without parsing the mentions.
|
|
@@ -48,18 +48,18 @@ module FlatApi
|
|
|
48
48
|
|
|
49
49
|
attr_accessor :context
|
|
50
50
|
|
|
51
|
-
# The list of user
|
|
51
|
+
# The list of user identifiers mentioned in this comment
|
|
52
52
|
attr_accessor :mentions
|
|
53
53
|
|
|
54
54
|
# For inline comments, the comment can be marked as resolved and will be hidden in the future responses
|
|
55
55
|
attr_accessor :resolved
|
|
56
56
|
|
|
57
|
-
# If the
|
|
57
|
+
# If the comment is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved
|
|
58
58
|
attr_accessor :resolved_by
|
|
59
59
|
|
|
60
60
|
attr_accessor :moderation
|
|
61
61
|
|
|
62
|
-
# `true
|
|
62
|
+
# `true` if the message has been detected as spam and hidden from other users
|
|
63
63
|
attr_accessor :spam
|
|
64
64
|
|
|
65
65
|
class EnumAttributeValidator
|