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.
Files changed (215) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1 -1
  3. data/lib/flat_api/api/account_api.rb +2 -2
  4. data/lib/flat_api/api/class_api.rb +22 -22
  5. data/lib/flat_api/api/collection_api.rb +6 -6
  6. data/lib/flat_api/api/edu_resources_api.rb +6 -6
  7. data/lib/flat_api/api/group_api.rb +4 -4
  8. data/lib/flat_api/api/omr_api.rb +6 -6
  9. data/lib/flat_api/api/organization_api.rb +8 -8
  10. data/lib/flat_api/api/score_api.rb +38 -38
  11. data/lib/flat_api/api/task_api.rb +6 -6
  12. data/lib/flat_api/api/user_api.rb +6 -6
  13. data/lib/flat_api/api_client.rb +2 -2
  14. data/lib/flat_api/api_error.rb +2 -2
  15. data/lib/flat_api/api_model_base.rb +2 -2
  16. data/lib/flat_api/configuration.rb +2 -2
  17. data/lib/flat_api/models/add_group_user200_response.rb +2 -2
  18. data/lib/flat_api/models/add_group_user_request.rb +2 -2
  19. data/lib/flat_api/models/api_access_token.rb +4 -4
  20. data/lib/flat_api/models/app_scopes.rb +2 -2
  21. data/lib/flat_api/models/assignment.rb +5 -5
  22. data/lib/flat_api/models/assignment_capabilities.rb +2 -2
  23. data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +2 -2
  24. data/lib/flat_api/models/assignment_copy.rb +2 -2
  25. data/lib/flat_api/models/assignment_copy_response.rb +5 -5
  26. data/lib/flat_api/models/assignment_copy_to_class.rb +3 -3
  27. data/lib/flat_api/models/assignment_copy_to_resource_library.rb +3 -3
  28. data/lib/flat_api/models/assignment_group.rb +2 -2
  29. data/lib/flat_api/models/assignment_submission.rb +3 -3
  30. data/lib/flat_api/models/assignment_submission_comment.rb +2 -2
  31. data/lib/flat_api/models/assignment_submission_comment_creation.rb +3 -3
  32. data/lib/flat_api/models/assignment_submission_comments.rb +2 -2
  33. data/lib/flat_api/models/assignment_submission_history.rb +2 -2
  34. data/lib/flat_api/models/assignment_submission_history_attachment.rb +2 -2
  35. data/lib/flat_api/models/assignment_submission_history_state.rb +2 -2
  36. data/lib/flat_api/models/assignment_submission_lti.rb +2 -2
  37. data/lib/flat_api/models/assignment_submission_playback.rb +2 -2
  38. data/lib/flat_api/models/assignment_submission_state.rb +2 -2
  39. data/lib/flat_api/models/assignment_submission_students_mode.rb +2 -2
  40. data/lib/flat_api/models/assignment_submission_update.rb +4 -4
  41. data/lib/flat_api/models/assignment_type.rb +2 -2
  42. data/lib/flat_api/models/assignment_update.rb +5 -5
  43. data/lib/flat_api/models/class_assignment.rb +6 -6
  44. data/lib/flat_api/models/class_assignment_all_of_canvas.rb +3 -3
  45. data/lib/flat_api/models/class_assignment_all_of_lti.rb +2 -2
  46. data/lib/flat_api/models/class_assignment_all_of_mfc.rb +3 -3
  47. data/lib/flat_api/models/class_assignment_update.rb +6 -6
  48. data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +2 -2
  49. data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +2 -2
  50. data/lib/flat_api/models/class_attachment_creation.rb +5 -5
  51. data/lib/flat_api/models/class_creation.rb +2 -2
  52. data/lib/flat_api/models/class_details.rb +5 -5
  53. data/lib/flat_api/models/class_details_canvas.rb +3 -3
  54. data/lib/flat_api/models/class_details_clever.rb +2 -2
  55. data/lib/flat_api/models/class_details_google_classroom.rb +2 -2
  56. data/lib/flat_api/models/class_details_google_drive.rb +2 -2
  57. data/lib/flat_api/models/class_details_issues.rb +2 -2
  58. data/lib/flat_api/models/class_details_issues_sync_inner.rb +2 -2
  59. data/lib/flat_api/models/class_details_lti.rb +2 -2
  60. data/lib/flat_api/models/class_details_mfc.rb +3 -3
  61. data/lib/flat_api/models/class_details_microsoft_graph.rb +2 -2
  62. data/lib/flat_api/models/class_grade_level.rb +2 -2
  63. data/lib/flat_api/models/class_roles.rb +2 -2
  64. data/lib/flat_api/models/class_state.rb +2 -2
  65. data/lib/flat_api/models/class_update.rb +2 -2
  66. data/lib/flat_api/models/collection.rb +3 -3
  67. data/lib/flat_api/models/collection_app.rb +2 -2
  68. data/lib/flat_api/models/collection_capabilities.rb +2 -2
  69. data/lib/flat_api/models/collection_contents.rb +2 -2
  70. data/lib/flat_api/models/collection_creation.rb +2 -2
  71. data/lib/flat_api/models/collection_modification.rb +2 -2
  72. data/lib/flat_api/models/collection_privacy.rb +2 -2
  73. data/lib/flat_api/models/collection_type.rb +2 -2
  74. data/lib/flat_api/models/credit_transaction.rb +2 -2
  75. data/lib/flat_api/models/edu_library.rb +3 -3
  76. data/lib/flat_api/models/edu_resource.rb +2 -2
  77. data/lib/flat_api/models/edu_resource_assignment_creation.rb +2 -2
  78. data/lib/flat_api/models/edu_resource_capabilities.rb +2 -2
  79. data/lib/flat_api/models/edu_resource_copy.rb +3 -3
  80. data/lib/flat_api/models/edu_resource_creation.rb +3 -3
  81. data/lib/flat_api/models/edu_resource_folder.rb +3 -3
  82. data/lib/flat_api/models/edu_resource_lti_link.rb +3 -3
  83. data/lib/flat_api/models/edu_resource_move.rb +3 -3
  84. data/lib/flat_api/models/edu_resource_privacy.rb +2 -2
  85. data/lib/flat_api/models/edu_resource_resource.rb +2 -2
  86. data/lib/flat_api/models/edu_resource_type.rb +2 -2
  87. data/lib/flat_api/models/edu_resource_update.rb +2 -2
  88. data/lib/flat_api/models/edu_resource_use_in_class.rb +3 -3
  89. data/lib/flat_api/models/flat_error_response.rb +3 -3
  90. data/lib/flat_api/models/google_classroom_coursework.rb +2 -2
  91. data/lib/flat_api/models/google_classroom_submission.rb +2 -2
  92. data/lib/flat_api/models/grade.rb +2 -2
  93. data/lib/flat_api/models/group.rb +2 -2
  94. data/lib/flat_api/models/group_creation.rb +2 -2
  95. data/lib/flat_api/models/group_details.rb +5 -5
  96. data/lib/flat_api/models/group_type.rb +2 -2
  97. data/lib/flat_api/models/license_mode.rb +2 -2
  98. data/lib/flat_api/models/license_sources.rb +2 -2
  99. data/lib/flat_api/models/lms_name.rb +2 -2
  100. data/lib/flat_api/models/lti_configuration.rb +2 -2
  101. data/lib/flat_api/models/lti_configuration1p1.rb +2 -2
  102. data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +2 -2
  103. data/lib/flat_api/models/lti_configuration1p3.rb +2 -2
  104. data/lib/flat_api/models/lti_configuration1p3_base.rb +2 -2
  105. data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +2 -2
  106. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +3 -3
  107. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +2 -2
  108. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +3 -3
  109. data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +2 -2
  110. data/lib/flat_api/models/lti_configuration1p3_deployment.rb +2 -2
  111. data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +2 -2
  112. data/lib/flat_api/models/lti_configuration1p3_manual.rb +2 -2
  113. data/lib/flat_api/models/lti_configuration_base.rb +2 -2
  114. data/lib/flat_api/models/lti_configuration_create.rb +2 -2
  115. data/lib/flat_api/models/lti_configuration_create1p1.rb +2 -2
  116. data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +3 -3
  117. data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +2 -2
  118. data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +2 -2
  119. data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +2 -2
  120. data/lib/flat_api/models/lti_configuration_update.rb +2 -2
  121. data/lib/flat_api/models/lti_configuration_update_deployment.rb +2 -2
  122. data/lib/flat_api/models/lti_configuration_update_standalone.rb +2 -2
  123. data/lib/flat_api/models/lti_credentials.rb +6 -6
  124. data/lib/flat_api/models/lti_credentials_creation.rb +4 -4
  125. data/lib/flat_api/models/media_attachment.rb +8 -8
  126. data/lib/flat_api/models/media_score_sharing_mode.rb +2 -2
  127. data/lib/flat_api/models/microsoft_graph_assignment.rb +2 -2
  128. data/lib/flat_api/models/microsoft_graph_submission.rb +2 -2
  129. data/lib/flat_api/models/omr_capabilities.rb +2 -2
  130. data/lib/flat_api/models/omr_details_step_data.rb +3 -3
  131. data/lib/flat_api/models/omr_details_submission.rb +2 -2
  132. data/lib/flat_api/models/omr_detected_instrument.rb +2 -2
  133. data/lib/flat_api/models/omr_imported_metadata.rb +2 -2
  134. data/lib/flat_api/models/omr_instrument_override.rb +2 -2
  135. data/lib/flat_api/models/omr_job.rb +13 -3
  136. data/lib/flat_api/models/omr_job_creation.rb +16 -4
  137. data/lib/flat_api/models/omr_job_file_metadata.rb +2 -2
  138. data/lib/flat_api/models/omr_job_file_upload.rb +2 -2
  139. data/lib/flat_api/models/omr_job_file_upload_result.rb +2 -2
  140. data/lib/flat_api/models/omr_job_input_file.rb +2 -2
  141. data/lib/flat_api/models/omr_job_output.rb +2 -2
  142. data/lib/flat_api/models/omr_job_progress.rb +2 -2
  143. data/lib/flat_api/models/omr_job_result.rb +2 -2
  144. data/lib/flat_api/models/omr_job_retention.rb +3 -3
  145. data/lib/flat_api/models/omr_job_status.rb +2 -2
  146. data/lib/flat_api/models/omr_locale_details.rb +2 -2
  147. data/lib/flat_api/models/omr_pending_step.rb +2 -2
  148. data/lib/flat_api/models/omr_step_name.rb +2 -2
  149. data/lib/flat_api/models/organization_invitation.rb +3 -3
  150. data/lib/flat_api/models/organization_invitation_creation.rb +2 -2
  151. data/lib/flat_api/models/organization_roles.rb +2 -2
  152. data/lib/flat_api/models/organization_user_access_token_creation.rb +2 -2
  153. data/lib/flat_api/models/rename_group_request.rb +2 -2
  154. data/lib/flat_api/models/resource_collaborator.rb +3 -3
  155. data/lib/flat_api/models/resource_collaborator_creation.rb +3 -3
  156. data/lib/flat_api/models/resource_rights.rb +2 -2
  157. data/lib/flat_api/models/score_comment.rb +7 -7
  158. data/lib/flat_api/models/score_comment_context.rb +5 -5
  159. data/lib/flat_api/models/score_comment_creation.rb +3 -3
  160. data/lib/flat_api/models/score_comment_moderation.rb +2 -2
  161. data/lib/flat_api/models/score_comment_update.rb +3 -3
  162. data/lib/flat_api/models/score_comments_counts.rb +2 -2
  163. data/lib/flat_api/models/score_creation.rb +2 -2
  164. data/lib/flat_api/models/score_creation_builder_data.rb +3 -3
  165. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +2 -2
  166. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +2 -2
  167. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +2 -2
  168. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +4 -4
  169. data/lib/flat_api/models/score_creation_common.rb +3 -3
  170. data/lib/flat_api/models/score_creation_file_import.rb +3 -3
  171. data/lib/flat_api/models/score_creation_google_drive_import.rb +3 -3
  172. data/lib/flat_api/models/score_creation_type.rb +2 -2
  173. data/lib/flat_api/models/score_details.rb +7 -7
  174. data/lib/flat_api/models/score_details_all_of_me.rb +2 -2
  175. data/lib/flat_api/models/score_fork.rb +2 -2
  176. data/lib/flat_api/models/score_license.rb +2 -2
  177. data/lib/flat_api/models/score_likes_counts.rb +2 -2
  178. data/lib/flat_api/models/score_modification.rb +2 -2
  179. data/lib/flat_api/models/score_plays_counts.rb +2 -2
  180. data/lib/flat_api/models/score_privacy.rb +2 -2
  181. data/lib/flat_api/models/score_revision.rb +2 -2
  182. data/lib/flat_api/models/score_revision_creation.rb +3 -3
  183. data/lib/flat_api/models/score_revision_statistics.rb +2 -2
  184. data/lib/flat_api/models/score_source.rb +3 -3
  185. data/lib/flat_api/models/score_summary.rb +2 -2
  186. data/lib/flat_api/models/score_track.rb +2 -2
  187. data/lib/flat_api/models/score_track_creation.rb +2 -2
  188. data/lib/flat_api/models/score_track_creation_response.rb +2 -2
  189. data/lib/flat_api/models/score_track_point.rb +2 -2
  190. data/lib/flat_api/models/score_track_purpose.rb +2 -2
  191. data/lib/flat_api/models/score_track_state.rb +2 -2
  192. data/lib/flat_api/models/score_track_type.rb +2 -2
  193. data/lib/flat_api/models/score_track_update.rb +2 -2
  194. data/lib/flat_api/models/score_views_counts.rb +2 -2
  195. data/lib/flat_api/models/task.rb +2 -2
  196. data/lib/flat_api/models/task_export_options.rb +2 -2
  197. data/lib/flat_api/models/task_progress.rb +2 -2
  198. data/lib/flat_api/models/task_result.rb +4 -4
  199. data/lib/flat_api/models/teaching_theme.rb +2 -2
  200. data/lib/flat_api/models/tutteo_product.rb +2 -2
  201. data/lib/flat_api/models/user_admin_update.rb +2 -2
  202. data/lib/flat_api/models/user_azure_details.rb +2 -2
  203. data/lib/flat_api/models/user_basics.rb +2 -2
  204. data/lib/flat_api/models/user_community_profile_links.rb +3 -3
  205. data/lib/flat_api/models/user_creation.rb +2 -2
  206. data/lib/flat_api/models/user_details.rb +7 -7
  207. data/lib/flat_api/models/user_details_admin.rb +2 -2
  208. data/lib/flat_api/models/user_details_admin_all_of_license.rb +3 -3
  209. data/lib/flat_api/models/user_public.rb +6 -6
  210. data/lib/flat_api/models/user_public_summary.rb +2 -2
  211. data/lib/flat_api/models/user_signin_link.rb +2 -2
  212. data/lib/flat_api/models/user_signin_link_creation.rb +2 -2
  213. data/lib/flat_api/version.rb +3 -3
  214. data/lib/flat_api.rb +2 -2
  215. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a704ee84b9748ef7b2af270c65b126da180b094afcd2c3646f22456d58bdb98
4
- data.tar.gz: 62cedf0446d8da6c1774b7b64a38b8cbff751bc7566e95f3b1a8c34364a88ee0
3
+ metadata.gz: bb64667d01dbc30d2a2696bd49fbe8e00e40ce4390e1c8db7740365699e0f5d4
4
+ data.tar.gz: 9fde556fae622dd2c741917836b4489568f49906c6b741f3b466921a3616c7a2
5
5
  SHA512:
6
- metadata.gz: 102868229a28bb85e3a8885692f1c87861b229de6c7174c112753f88752c749ca922c0505f814135bb2b60746d39b03e6225bc0ab2ebbe124a0a99850a5fc8c6
7
- data.tar.gz: 3f4d9708b651fe7c9c15abbc96ae8000e4db3e92db063cfaf423ce3ce783f4783e15f13826fb7027d9dc0e3d3464b20f352592e79b5974b7d0e7ac5728e8658a
6
+ metadata.gz: 97bfdf5a5a36fd0cca4d6059b368d6007d9c0e4cc116852e9ae619c9cc7683b3bd891a754d8f7d2d88465446c5b5364a0db51d9fde66bace661349ba46b9e8eb
7
+ data.tar.gz: '09aa69a2a20c3d05f367233ee75e95e7ea61afa53329e08b3b79bf9a38fc04a2567c0261806c6d41735addd4a1fb78c45eb2125be099c42d9db58d4b6fb3760b'
data/CHANGELOG.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Changelog
2
2
 
3
- ## [1.0.0](https://github.com/FlatIO/api-client-ruby/compare/v0.3.5...1.0.0) (2026-09-11)
3
+ ## [1.0.0](https://github.com/FlatIO/api-client-ruby/compare/v0.3.5...v1.0.0) (2026-09-11)
4
4
 
5
5
  The first stable release. Regenerated against API specification 2.26.1, covering all 123 public
6
6
  operations. See [MIGRATION.md](MIGRATION.md) for the upgrade from 0.3.x.
@@ -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 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 is [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)
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.1
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 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 is [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)
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.1
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
@@ -83,7 +83,7 @@ module FlatApi
83
83
  end
84
84
 
85
85
  # Add a user to the class
86
- # This method can be used by a teacher of the class to enroll another Flat user into the class. Only users that are part of your Organization can be enrolled in a class of this same Organization. When enrolling a user in the class, Flat will automatically add this user to the corresponding Class group, based on this role in the Organization.
86
+ # This method can be used by a teacher of the class to enroll another Flat user into the class. Only users that are part of your Organization can be enrolled in a class of this same Organization. When enrolling a user in the class, Flat will automatically add this user to the corresponding Class group, based on their role in the Organization.
87
87
  # @param _class [String] Unique identifier of the class
88
88
  # @param user [String] Unique identifier of the user
89
89
  # @param [Hash] opts the optional parameters
@@ -94,7 +94,7 @@ module FlatApi
94
94
  end
95
95
 
96
96
  # Add a user to the class
97
- # This method can be used by a teacher of the class to enroll another Flat user into the class. Only users that are part of your Organization can be enrolled in a class of this same Organization. When enrolling a user in the class, Flat will automatically add this user to the corresponding Class group, based on this role in the Organization.
97
+ # This method can be used by a teacher of the class to enroll another Flat user into the class. Only users that are part of your Organization can be enrolled in a class of this same Organization. When enrolling a user in the class, Flat will automatically add this user to the corresponding Class group, based on their role in the Organization.
98
98
  # @param _class [String] Unique identifier of the class
99
99
  # @param user [String] Unique identifier of the user
100
100
  # @param [Hash] opts the optional parameters
@@ -221,7 +221,7 @@ module FlatApi
221
221
  end
222
222
 
223
223
  # Archive the class
224
- # Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated.
224
+ # Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will automatically be updated.
225
225
  # @param _class [String] Unique identifier of the class
226
226
  # @param [Hash] opts the optional parameters
227
227
  # @return [ClassDetails]
@@ -231,7 +231,7 @@ module FlatApi
231
231
  end
232
232
 
233
233
  # Archive the class
234
- # Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated.
234
+ # Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will automatically be updated.
235
235
  # @param _class [String] Unique identifier of the class
236
236
  # @param [Hash] opts the optional parameters
237
237
  # @return [Array<(ClassDetails, Integer, Hash)>] ClassDetails data, response status code and response headers
@@ -364,7 +364,7 @@ module FlatApi
364
364
  end
365
365
 
366
366
  # Create a new class
367
- # Classrooms on Flat allow you to create activities with assignments and post content to a specific group. When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group. If the classsroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated. You can add users to this class using `PUT /classes/{class}/users/{user}`, they will automatically added to the group based on their role on Flat. Users can also enroll themselves to this class using `POST /classes/enroll/{enrollmentCode}` and the `enrollmentCode` returned in the `ClassDetails` response.
367
+ # Classrooms on Flat allow you to create activities with assignments and post content to a specific group. When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group. If the classroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated. You can add users to this class using `PUT /classes/{class}/users/{user}`, they will automatically be added to the group based on their role on Flat. Users can also enroll themselves to this class using `POST /classes/enroll/{enrollmentCode}` and the `enrollmentCode` returned in the `ClassDetails` response.
368
368
  # @param body [ClassCreation]
369
369
  # @param [Hash] opts the optional parameters
370
370
  # @return [ClassDetails]
@@ -374,7 +374,7 @@ module FlatApi
374
374
  end
375
375
 
376
376
  # Create a new class
377
- # Classrooms on Flat allow you to create activities with assignments and post content to a specific group. When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group. If the classsroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated. You can add users to this class using &#x60;PUT /classes/{class}/users/{user}&#x60;, they will automatically added to the group based on their role on Flat. Users can also enroll themselves to this class using &#x60;POST /classes/enroll/{enrollmentCode}&#x60; and the &#x60;enrollmentCode&#x60; returned in the &#x60;ClassDetails&#x60; response.
377
+ # Classrooms on Flat allow you to create activities with assignments and post content to a specific group. When creating a class, Flat automatically creates two groups: one for the teachers of the course, one for the students. The creator of this class is automatically added to the teachers group. If the classroom is synchronized with another application like Google Classroom, some of the meta information will automatically be updated. You can add users to this class using &#x60;PUT /classes/{class}/users/{user}&#x60;, they will automatically be added to the group based on their role on Flat. Users can also enroll themselves to this class using &#x60;POST /classes/enroll/{enrollmentCode}&#x60; and the &#x60;enrollmentCode&#x60; returned in the &#x60;ClassDetails&#x60; response.
378
378
  # @param body [ClassCreation]
379
379
  # @param [Hash] opts the optional parameters
380
380
  # @return [Array<(ClassDetails, Integer, Hash)>] ClassDetails data, response status code and response headers
@@ -506,7 +506,7 @@ module FlatApi
506
506
  end
507
507
 
508
508
  # Create or edit a submission
509
- # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set `attachments` and `submit`. Teachers can use `PUT /classes/{class}/assignments/{assignment}/submissions/{submission}` to update a submission by id.
509
+ # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set `attachments`, `playback`, `exercisesIds` and `submit`. Teachers can use `PUT /classes/{class}/assignments/{assignment}/submissions/{submission}` to update a submission by id.
510
510
  # @param _class [String] Unique identifier of the class
511
511
  # @param assignment [String] Unique identifier of the assignment
512
512
  # @param body [AssignmentSubmissionUpdate]
@@ -518,7 +518,7 @@ module FlatApi
518
518
  end
519
519
 
520
520
  # Create or edit a submission
521
- # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set &#x60;attachments&#x60; and &#x60;submit&#x60;. Teachers can use &#x60;PUT /classes/{class}/assignments/{assignment}/submissions/{submission}&#x60; to update a submission by id.
521
+ # Use this method as a student to create, update and submit a submission related to an assignment. Students can only set &#x60;attachments&#x60;, &#x60;playback&#x60;, &#x60;exercisesIds&#x60; and &#x60;submit&#x60;. Teachers can use &#x60;PUT /classes/{class}/assignments/{assignment}/submissions/{submission}&#x60; to update a submission by id.
522
522
  # @param _class [String] Unique identifier of the class
523
523
  # @param assignment [String] Unique identifier of the assignment
524
524
  # @param body [AssignmentSubmissionUpdate]
@@ -586,7 +586,7 @@ module FlatApi
586
586
  end
587
587
 
588
588
  # Create a test student account
589
- # Test students account can be created by teachers an admin and be used to experiment the assignments. - They are automatically added to the class. - They can be reset using this API endpoint (a new account will be created and the previous one scheduled for deletion). - These accounts don't use a user license.
589
+ # Test student accounts can be created by teachers and admins to try out the assignments. - They are automatically added to the class. - They can be reset using this API endpoint (a new account will be created and the previous one scheduled for deletion). - These accounts don't use a user license.
590
590
  # @param _class [String] Unique identifier of the class
591
591
  # @param [Hash] opts the optional parameters
592
592
  # @option opts [Boolean] :reset If true, the testing account will be re-created.
@@ -597,7 +597,7 @@ module FlatApi
597
597
  end
598
598
 
599
599
  # Create a test student account
600
- # Test students account can be created by teachers an admin and be used to experiment the assignments. - They are automatically added to the class. - They can be reset using this API endpoint (a new account will be created and the previous one scheduled for deletion). - These accounts don&#39;t use a user license.
600
+ # Test student accounts can be created by teachers and admins to try out the assignments. - They are automatically added to the class. - They can be reset using this API endpoint (a new account will be created and the previous one scheduled for deletion). - These accounts don&#39;t use a user license.
601
601
  # @param _class [String] Unique identifier of the class
602
602
  # @param [Hash] opts the optional parameters
603
603
  # @option opts [Boolean] :reset If true, the testing account will be re-created.
@@ -790,7 +790,7 @@ module FlatApi
790
790
  end
791
791
 
792
792
  # Reset a submission
793
- # Use this method as a teacher to reset a submission and allow student to start over the assignment
793
+ # Use this method as a teacher to reset a submission and allow the student to start the assignment over
794
794
  # @param _class [String] Unique identifier of the class
795
795
  # @param assignment [String] Unique identifier of the assignment
796
796
  # @param submission [String] Unique identifier of the submission
@@ -802,7 +802,7 @@ module FlatApi
802
802
  end
803
803
 
804
804
  # Reset a submission
805
- # Use this method as a teacher to reset a submission and allow student to start over the assignment
805
+ # Use this method as a teacher to reset a submission and allow the student to start the assignment over
806
806
  # @param _class [String] Unique identifier of the class
807
807
  # @param assignment [String] Unique identifier of the assignment
808
808
  # @param submission [String] Unique identifier of the submission
@@ -944,7 +944,7 @@ module FlatApi
944
944
  end
945
945
 
946
946
  # Edit a submission
947
- # Use this method as a teacher to update the different submission and give feedback. Teachers can only set `return`, `draftGrade` and `grade`
947
+ # Use this method as a teacher to update a submission and give feedback. Teachers can only set `return`, `draftGrade` and `grade`.
948
948
  # @param _class [String] Unique identifier of the class
949
949
  # @param assignment [String] Unique identifier of the assignment
950
950
  # @param submission [String] Unique identifier of the submission
@@ -957,7 +957,7 @@ module FlatApi
957
957
  end
958
958
 
959
959
  # Edit a submission
960
- # Use this method as a teacher to update the different submission and give feedback. Teachers can only set &#x60;return&#x60;, &#x60;draftGrade&#x60; and &#x60;grade&#x60;
960
+ # Use this method as a teacher to update a submission and give feedback. Teachers can only set &#x60;return&#x60;, &#x60;draftGrade&#x60; and &#x60;grade&#x60;.
961
961
  # @param _class [String] Unique identifier of the class
962
962
  # @param assignment [String] Unique identifier of the assignment
963
963
  # @param submission [String] Unique identifier of the submission
@@ -1030,7 +1030,7 @@ module FlatApi
1030
1030
  end
1031
1031
 
1032
1032
  # Join a class
1033
- # Use this method to join a class using an enrollment code given one of the teacher of this class. This code is also available in the `ClassDetails` returned to the teachers when creating the class or listing / fetching a specific class. Flat will automatically add the user to the corresponding class group based on this role in the organization.
1033
+ # Use this method to join a class using an enrollment code given by one of the teachers of this class. This code is also available in the `ClassDetails` returned to the teachers when creating the class or listing / fetching a specific class. Flat will automatically add the user to the corresponding class group based on their role in the organization.
1034
1034
  # @param enrollment_code [String] The enrollment code, available to the teacher in &#x60;ClassDetails&#x60;
1035
1035
  # @param [Hash] opts the optional parameters
1036
1036
  # @return [ClassDetails]
@@ -1040,7 +1040,7 @@ module FlatApi
1040
1040
  end
1041
1041
 
1042
1042
  # Join a class
1043
- # Use this method to join a class using an enrollment code given one of the teacher of this class. This code is also available in the &#x60;ClassDetails&#x60; returned to the teachers when creating the class or listing / fetching a specific class. Flat will automatically add the user to the corresponding class group based on this role in the organization.
1043
+ # Use this method to join a class using an enrollment code given by one of the teachers of this class. This code is also available in the &#x60;ClassDetails&#x60; returned to the teachers when creating the class or listing / fetching a specific class. Flat will automatically add the user to the corresponding class group based on their role in the organization.
1044
1044
  # @param enrollment_code [String] The enrollment code, available to the teacher in &#x60;ClassDetails&#x60;
1045
1045
  # @param [Hash] opts the optional parameters
1046
1046
  # @return [Array<(ClassDetails, Integer, Hash)>] ClassDetails data, response status code and response headers
@@ -1361,7 +1361,7 @@ module FlatApi
1361
1361
  end
1362
1362
 
1363
1363
  # List submissions related to the score
1364
- # This API call will list the different assignments submissions where the score is attached. This method can be used by anyone that are part of the organization and have at least read access to the document.
1364
+ # 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.
1365
1365
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
1366
1366
  # @param [Hash] opts the optional parameters
1367
1367
  # @return [Array<AssignmentSubmission>]
@@ -1371,7 +1371,7 @@ module FlatApi
1371
1371
  end
1372
1372
 
1373
1373
  # List submissions related to the score
1374
- # This API call will list the different assignments submissions where the score is attached. This method can be used by anyone that are part of the organization and have at least read access to the document.
1374
+ # 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.
1375
1375
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
1376
1376
  # @param [Hash] opts the optional parameters
1377
1377
  # @return [Array<(Array<AssignmentSubmission>, Integer, Hash)>] Array<AssignmentSubmission> data, response status code and response headers
@@ -2057,7 +2057,7 @@ module FlatApi
2057
2057
  end
2058
2058
 
2059
2059
  # Unarchive the class
2060
- # Mark the class as `active`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated.
2060
+ # Mark the class as `active`. When this course is synchronized with another app, like Google Classroom, this state will automatically be updated.
2061
2061
  # @param _class [String] Unique identifier of the class
2062
2062
  # @param [Hash] opts the optional parameters
2063
2063
  # @return [ClassDetails]
@@ -2067,7 +2067,7 @@ module FlatApi
2067
2067
  end
2068
2068
 
2069
2069
  # Unarchive the class
2070
- # Mark the class as &#x60;active&#x60;. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated.
2070
+ # Mark the class as &#x60;active&#x60;. When this course is synchronized with another app, like Google Classroom, this state will automatically be updated.
2071
2071
  # @param _class [String] Unique identifier of the class
2072
2072
  # @param [Hash] opts the optional parameters
2073
2073
  # @return [Array<(ClassDetails, Integer, Hash)>] ClassDetails 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 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 is [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)
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.1
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
@@ -228,11 +228,11 @@ module FlatApi
228
228
  end
229
229
 
230
230
  # Delete a score from the collection
231
- # This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
231
+ # This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
232
232
  # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted
233
233
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
234
234
  # @param [Hash] opts the optional parameters
235
- # @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
235
+ # @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
236
236
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
237
237
  # @return [nil]
238
238
  def delete_score_from_collection(collection, score, opts = {})
@@ -241,11 +241,11 @@ module FlatApi
241
241
  end
242
242
 
243
243
  # Delete a score from the collection
244
- # This method will delete a score from the collection. Unlike [&#x60;DELETE /scores/{score}&#x60;](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
244
+ # This method will delete a score from the collection. Unlike [&#x60;DELETE /scores/{score}&#x60;](#operation/deleteScore), this will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
245
245
  # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted
246
246
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
247
247
  # @param [Hash] opts the optional parameters
248
- # @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
248
+ # @option opts [String] :event_properties Optional analytics properties merged into the analytics events recorded for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
249
249
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
250
250
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
251
251
  def delete_score_from_collection_with_http_info(collection, score, opts = {})
@@ -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 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 is [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)
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.1
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
@@ -463,7 +463,7 @@ module FlatApi
463
463
  # List education resources in a library or folder
464
464
  # @param [Hash] opts the optional parameters
465
465
  # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder. Accepts a folder identifier, or the identifier of one of the libraries returned by [&#x60;listEduLibraries&#x60;](#tag/EduResources/operation/listEduLibraries). Which libraries are available depends on the account, so use the &#x60;id&#x60; values that endpoint returns rather than hardcoding this list: * &#x60;root&#x60;: the user&#39;s own resources * &#x60;organization&#x60;: resources shared with the organization (default to 'root')
466
- # @option opts [Boolean] :without_subfolders_resources For the &#x60;parent&#x60; &#x3D; &#x60;organization&#x60;, do not include resources from subfolders. By default in the Resource Library UI, we include resources from subfolders, but for example in a picker like LTI, we don&#39;t want to include them.
466
+ # @option opts [Boolean] :without_subfolders_resources For the &#x60;parent&#x60; &#x3D; &#x60;organization&#x60;, do not include resources from subfolders. Resources from subfolders are included by default; set this to &#x60;true&#x60; to list only the direct children, for example in a picker.
467
467
  # @option opts [String] :type Filter the returned resources by type
468
468
  # @option opts [Array<TeachingTheme>] :subjects Filter the returned resources by subjects
469
469
  # @option opts [Array<AssignmentType>] :assignment_types Filter the returned resources by assignment types
@@ -482,7 +482,7 @@ module FlatApi
482
482
  # List education resources in a library or folder
483
483
  # @param [Hash] opts the optional parameters
484
484
  # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder. Accepts a folder identifier, or the identifier of one of the libraries returned by [&#x60;listEduLibraries&#x60;](#tag/EduResources/operation/listEduLibraries). Which libraries are available depends on the account, so use the &#x60;id&#x60; values that endpoint returns rather than hardcoding this list: * &#x60;root&#x60;: the user&#39;s own resources * &#x60;organization&#x60;: resources shared with the organization (default to 'root')
485
- # @option opts [Boolean] :without_subfolders_resources For the &#x60;parent&#x60; &#x3D; &#x60;organization&#x60;, do not include resources from subfolders. By default in the Resource Library UI, we include resources from subfolders, but for example in a picker like LTI, we don&#39;t want to include them.
485
+ # @option opts [Boolean] :without_subfolders_resources For the &#x60;parent&#x60; &#x3D; &#x60;organization&#x60;, do not include resources from subfolders. Resources from subfolders are included by default; set this to &#x60;true&#x60; to list only the direct children, for example in a picker.
486
486
  # @option opts [String] :type Filter the returned resources by type
487
487
  # @option opts [Array<TeachingTheme>] :subjects Filter the returned resources by subjects
488
488
  # @option opts [Array<AssignmentType>] :assignment_types Filter the returned resources by assignment types
@@ -641,7 +641,7 @@ module FlatApi
641
641
  end
642
642
 
643
643
  # Update an education resource metadata
644
- # Update any resources metadata (e.g. title). Use this method to rename education resources folders or assignments.
644
+ # Update the metadata of a resource (e.g. its title). Use this method to rename education resources folders or assignments.
645
645
  # @param resource [String] Unique identifier of the resource
646
646
  # @param edu_resource_update [EduResourceUpdate]
647
647
  # @param [Hash] opts the optional parameters
@@ -652,7 +652,7 @@ module FlatApi
652
652
  end
653
653
 
654
654
  # Update an education resource metadata
655
- # Update any resources metadata (e.g. title). Use this method to rename education resources folders or assignments.
655
+ # Update the metadata of a resource (e.g. its title). Use this method to rename education resources folders or assignments.
656
656
  # @param resource [String] Unique identifier of the resource
657
657
  # @param edu_resource_update [EduResourceUpdate]
658
658
  # @param [Hash] opts the optional parameters
@@ -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 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 is [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)
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.1
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
@@ -289,7 +289,7 @@ module FlatApi
289
289
  # Get the list of scores shared with a group.
290
290
  # @param group [String] Unique identifier of a Flat group
291
291
  # @param [Hash] opts the optional parameters
292
- # @option opts [String] :parent Filter the score forked from the score id &#x60;parent&#x60;
292
+ # @option opts [String] :parent Only return the scores forked from the score &#x60;parent&#x60;
293
293
  # @return [Array<ScoreDetails>]
294
294
  def get_group_scores(group, opts = {})
295
295
  data, _status_code, _headers = get_group_scores_with_http_info(group, opts)
@@ -300,7 +300,7 @@ module FlatApi
300
300
  # Get the list of scores shared with a group.
301
301
  # @param group [String] Unique identifier of a Flat group
302
302
  # @param [Hash] opts the optional parameters
303
- # @option opts [String] :parent Filter the score forked from the score id &#x60;parent&#x60;
303
+ # @option opts [String] :parent Only return the scores forked from the score &#x60;parent&#x60;
304
304
  # @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
305
305
  def get_group_scores_with_http_info(group, opts = {})
306
306
  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 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 is [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)
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.1
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
@@ -163,7 +163,7 @@ module FlatApi
163
163
  end
164
164
 
165
165
  # Create an OMR job
166
- # Create an Optical Music Recognition job. There are two ways to call this endpoint: * **Draft:** send the parameters without `files` to create an empty job, then add files with `addOmrJobFile`, then run it with `startOmrJob`. Best for multiple images or incremental mobile capture. * **One-shot:** include `files` and `autoStart: true` to import in a single request. Best for a single PDF or a third-party integration. Declare the interactive steps your client supports in `interactiveSteps`: the pipeline runs fully automatically and only pauses at the steps you list. Steps you do not list, including ones added in the future, are auto-resolved with server defaults, so older clients never break.
166
+ # Create an Optical Music Recognition job. There are two ways to call this endpoint: * **Draft:** send the parameters without `files` to create an empty job, then add files with `addOmrJobFile`, then run it with `startOmrJob`. Best for multiple images or incremental mobile capture. * **One-shot:** include `files` and `autoStart: true` to import in a single request. Best for a single PDF or a third-party integration. Declare the interactive steps your client supports in `interactiveSteps`: the pipeline runs fully automatically and only pauses at the steps you list. Steps you do not list, including ones added in the future, are auto-resolved with server defaults, so older clients never break. Pages are recognized in the orientation they are uploaded in. If your client does not let the user rotate pages before upload, set `autoRotate: true` and the server corrects pages uploaded sideways or upside down.
167
167
  # @param omr_job_creation [OmrJobCreation]
168
168
  # @param [Hash] opts the optional parameters
169
169
  # @option opts [String] :x_flat_locale Preferred locale for localized content in the response (translated error messages, emails, etc.). Accepts any IETF language tag. The API best-matches the value to a supported locale and never rejects an unknown one (it falls back to the closest match, then to &#x60;en&#x60;). Supported normalized locales: &#x60;da&#x60;, &#x60;de&#x60;, &#x60;en&#x60;, &#x60;en-GB&#x60;, &#x60;es&#x60;, &#x60;fi&#x60;, &#x60;fil&#x60;, &#x60;fr&#x60;, &#x60;fr-CA&#x60;, &#x60;hi&#x60;, &#x60;id&#x60;, &#x60;it&#x60;, &#x60;ja&#x60;, &#x60;ko&#x60;, &#x60;ms&#x60;, &#x60;nl&#x60;, &#x60;nb&#x60;, &#x60;pl&#x60;, &#x60;pt&#x60;, &#x60;pt-BR&#x60;, &#x60;ro&#x60;, &#x60;ru&#x60;, &#x60;sv&#x60;, &#x60;tr&#x60;, &#x60;zh-Hans&#x60;, &#x60;zh-HK&#x60;, &#x60;zh-TW&#x60;. Precedence (highest first): this &#x60;X-Flat-Locale&#x60; header, the authenticated user&#39;s account locale, the &#x60;Accept-Language&#x60; header, then &#x60;en&#x60;.
@@ -174,7 +174,7 @@ module FlatApi
174
174
  end
175
175
 
176
176
  # Create an OMR job
177
- # Create an Optical Music Recognition job. There are two ways to call this endpoint: * **Draft:** send the parameters without &#x60;files&#x60; to create an empty job, then add files with &#x60;addOmrJobFile&#x60;, then run it with &#x60;startOmrJob&#x60;. Best for multiple images or incremental mobile capture. * **One-shot:** include &#x60;files&#x60; and &#x60;autoStart: true&#x60; to import in a single request. Best for a single PDF or a third-party integration. Declare the interactive steps your client supports in &#x60;interactiveSteps&#x60;: the pipeline runs fully automatically and only pauses at the steps you list. Steps you do not list, including ones added in the future, are auto-resolved with server defaults, so older clients never break.
177
+ # Create an Optical Music Recognition job. There are two ways to call this endpoint: * **Draft:** send the parameters without &#x60;files&#x60; to create an empty job, then add files with &#x60;addOmrJobFile&#x60;, then run it with &#x60;startOmrJob&#x60;. Best for multiple images or incremental mobile capture. * **One-shot:** include &#x60;files&#x60; and &#x60;autoStart: true&#x60; to import in a single request. Best for a single PDF or a third-party integration. Declare the interactive steps your client supports in &#x60;interactiveSteps&#x60;: the pipeline runs fully automatically and only pauses at the steps you list. Steps you do not list, including ones added in the future, are auto-resolved with server defaults, so older clients never break. Pages are recognized in the orientation they are uploaded in. If your client does not let the user rotate pages before upload, set &#x60;autoRotate: true&#x60; and the server corrects pages uploaded sideways or upside down.
178
178
  # @param omr_job_creation [OmrJobCreation]
179
179
  # @param [Hash] opts the optional parameters
180
180
  # @option opts [String] :x_flat_locale Preferred locale for localized content in the response (translated error messages, emails, etc.). Accepts any IETF language tag. The API best-matches the value to a supported locale and never rejects an unknown one (it falls back to the closest match, then to &#x60;en&#x60;). Supported normalized locales: &#x60;da&#x60;, &#x60;de&#x60;, &#x60;en&#x60;, &#x60;en-GB&#x60;, &#x60;es&#x60;, &#x60;fi&#x60;, &#x60;fil&#x60;, &#x60;fr&#x60;, &#x60;fr-CA&#x60;, &#x60;hi&#x60;, &#x60;id&#x60;, &#x60;it&#x60;, &#x60;ja&#x60;, &#x60;ko&#x60;, &#x60;ms&#x60;, &#x60;nl&#x60;, &#x60;nb&#x60;, &#x60;pl&#x60;, &#x60;pt&#x60;, &#x60;pt-BR&#x60;, &#x60;ro&#x60;, &#x60;ru&#x60;, &#x60;sv&#x60;, &#x60;tr&#x60;, &#x60;zh-Hans&#x60;, &#x60;zh-HK&#x60;, &#x60;zh-TW&#x60;. Precedence (highest first): this &#x60;X-Flat-Locale&#x60; header, the authenticated user&#39;s account locale, the &#x60;Accept-Language&#x60; header, then &#x60;en&#x60;.
@@ -234,7 +234,7 @@ module FlatApi
234
234
  end
235
235
 
236
236
  # Delete an OMR job's data
237
- # Erase a job's uploaded files and recognition results now, instead of waiting for its retention deadline. Use this to serve a deletion request from your own end user. Reaches the same end state as the scheduled cleanup: the files are gone, the job keeps the `status` it finished with, stays listable, and reports `retention.expiredDate`. Downloads then fail with `OMR_JOB_EXPIRED`. Only available for jobs whose `output` is `musicxml`. Library imports are not covered by the retention policy and are rejected with `OMR_JOB_NOT_EXPIRABLE`; delete the resulting score instead. The job must have finished (`done`, `error` or `canceled`). A draft or in-flight job is rejected with `OMR_JOB_IN_PROGRESS`: cancel it first, then delete. Deleting never cancels on your behalf, because cancellation reverses charged credits and that must not happen as a side effect of erasing data. Calling this again on an already-erased job succeeds and changes nothing.
237
+ # Erase a job's uploaded files and recognition results now, instead of waiting for its retention deadline. Use this to serve a deletion request from your own end user. Reaches the same end state as retention expiry: the files are gone, the job keeps the `status` it finished with, stays listable, and reports `retention.expiredDate`. Downloads then fail with `OMR_JOB_EXPIRED`. Only available for jobs whose `output` is `musicxml`. Library imports are not covered by the retention policy and are rejected with `OMR_JOB_NOT_EXPIRABLE`; delete the resulting score instead. The job must have finished (`done`, `error` or `canceled`). A draft or in-flight job is rejected with `OMR_JOB_IN_PROGRESS`: cancel it first, then delete. Deleting never cancels on your behalf, because cancellation reverses charged credits and that must not happen as a side effect of erasing data. Calling this again on an already-erased job succeeds and changes nothing.
238
238
  # @param job [String] Unique identifier of the OMR job
239
239
  # @param [Hash] opts the optional parameters
240
240
  # @option opts [String] :x_flat_locale Preferred locale for localized content in the response (translated error messages, emails, etc.). Accepts any IETF language tag. The API best-matches the value to a supported locale and never rejects an unknown one (it falls back to the closest match, then to &#x60;en&#x60;). Supported normalized locales: &#x60;da&#x60;, &#x60;de&#x60;, &#x60;en&#x60;, &#x60;en-GB&#x60;, &#x60;es&#x60;, &#x60;fi&#x60;, &#x60;fil&#x60;, &#x60;fr&#x60;, &#x60;fr-CA&#x60;, &#x60;hi&#x60;, &#x60;id&#x60;, &#x60;it&#x60;, &#x60;ja&#x60;, &#x60;ko&#x60;, &#x60;ms&#x60;, &#x60;nl&#x60;, &#x60;nb&#x60;, &#x60;pl&#x60;, &#x60;pt&#x60;, &#x60;pt-BR&#x60;, &#x60;ro&#x60;, &#x60;ru&#x60;, &#x60;sv&#x60;, &#x60;tr&#x60;, &#x60;zh-Hans&#x60;, &#x60;zh-HK&#x60;, &#x60;zh-TW&#x60;. Precedence (highest first): this &#x60;X-Flat-Locale&#x60; header, the authenticated user&#39;s account locale, the &#x60;Accept-Language&#x60; header, then &#x60;en&#x60;.
@@ -245,7 +245,7 @@ module FlatApi
245
245
  end
246
246
 
247
247
  # Delete an OMR job&#39;s data
248
- # Erase a job&#39;s uploaded files and recognition results now, instead of waiting for its retention deadline. Use this to serve a deletion request from your own end user. Reaches the same end state as the scheduled cleanup: the files are gone, the job keeps the &#x60;status&#x60; it finished with, stays listable, and reports &#x60;retention.expiredDate&#x60;. Downloads then fail with &#x60;OMR_JOB_EXPIRED&#x60;. Only available for jobs whose &#x60;output&#x60; is &#x60;musicxml&#x60;. Library imports are not covered by the retention policy and are rejected with &#x60;OMR_JOB_NOT_EXPIRABLE&#x60;; delete the resulting score instead. The job must have finished (&#x60;done&#x60;, &#x60;error&#x60; or &#x60;canceled&#x60;). A draft or in-flight job is rejected with &#x60;OMR_JOB_IN_PROGRESS&#x60;: cancel it first, then delete. Deleting never cancels on your behalf, because cancellation reverses charged credits and that must not happen as a side effect of erasing data. Calling this again on an already-erased job succeeds and changes nothing.
248
+ # Erase a job&#39;s uploaded files and recognition results now, instead of waiting for its retention deadline. Use this to serve a deletion request from your own end user. Reaches the same end state as retention expiry: the files are gone, the job keeps the &#x60;status&#x60; it finished with, stays listable, and reports &#x60;retention.expiredDate&#x60;. Downloads then fail with &#x60;OMR_JOB_EXPIRED&#x60;. Only available for jobs whose &#x60;output&#x60; is &#x60;musicxml&#x60;. Library imports are not covered by the retention policy and are rejected with &#x60;OMR_JOB_NOT_EXPIRABLE&#x60;; delete the resulting score instead. The job must have finished (&#x60;done&#x60;, &#x60;error&#x60; or &#x60;canceled&#x60;). A draft or in-flight job is rejected with &#x60;OMR_JOB_IN_PROGRESS&#x60;: cancel it first, then delete. Deleting never cancels on your behalf, because cancellation reverses charged credits and that must not happen as a side effect of erasing data. Calling this again on an already-erased job succeeds and changes nothing.
249
249
  # @param job [String] Unique identifier of the OMR job
250
250
  # @param [Hash] opts the optional parameters
251
251
  # @option opts [String] :x_flat_locale Preferred locale for localized content in the response (translated error messages, emails, etc.). Accepts any IETF language tag. The API best-matches the value to a supported locale and never rejects an unknown one (it falls back to the closest match, then to &#x60;en&#x60;). Supported normalized locales: &#x60;da&#x60;, &#x60;de&#x60;, &#x60;en&#x60;, &#x60;en-GB&#x60;, &#x60;es&#x60;, &#x60;fi&#x60;, &#x60;fil&#x60;, &#x60;fr&#x60;, &#x60;fr-CA&#x60;, &#x60;hi&#x60;, &#x60;id&#x60;, &#x60;it&#x60;, &#x60;ja&#x60;, &#x60;ko&#x60;, &#x60;ms&#x60;, &#x60;nl&#x60;, &#x60;nb&#x60;, &#x60;pl&#x60;, &#x60;pt&#x60;, &#x60;pt-BR&#x60;, &#x60;ro&#x60;, &#x60;ru&#x60;, &#x60;sv&#x60;, &#x60;tr&#x60;, &#x60;zh-Hans&#x60;, &#x60;zh-HK&#x60;, &#x60;zh-TW&#x60;. Precedence (highest first): this &#x60;X-Flat-Locale&#x60; header, the authenticated user&#39;s account locale, the &#x60;Accept-Language&#x60; header, then &#x60;en&#x60;.
@@ -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 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 is [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)
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.1
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
@@ -163,7 +163,7 @@ module FlatApi
163
163
  return data, status_code, headers
164
164
  end
165
165
 
166
- # Create a new couple of LTI 1.x credentials
166
+ # Create a new pair of LTI 1.1 credentials
167
167
  # DEPRECATED. Use the unified endpoints under `/organizations/lti/configurations`. Note: Teachers may be restricted by the organization privacy setting `lti1p1AllowTeachersCredentials`. Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
168
168
  # @param body [LtiCredentialsCreation]
169
169
  # @param [Hash] opts the optional parameters
@@ -173,7 +173,7 @@ module FlatApi
173
173
  data
174
174
  end
175
175
 
176
- # Create a new couple of LTI 1.x credentials
176
+ # Create a new pair of LTI 1.1 credentials
177
177
  # DEPRECATED. Use the unified endpoints under &#x60;/organizations/lti/configurations&#x60;. Note: Teachers may be restricted by the organization privacy setting &#x60;lti1p1AllowTeachersCredentials&#x60;. Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
178
178
  # @param body [LtiCredentialsCreation]
179
179
  # @param [Hash] opts the optional parameters
@@ -232,7 +232,7 @@ module FlatApi
232
232
  end
233
233
 
234
234
  # Create a new invitation to join the organization
235
- # This method creates and sends invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property `usedBy` will be directly filled with the uniquer identifier of the corresponding user.
235
+ # This method creates and sends an invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property `usedBy` will be directly filled with the unique identifier of the corresponding user.
236
236
  # @param body [OrganizationInvitationCreation]
237
237
  # @param [Hash] opts the optional parameters
238
238
  # @return [OrganizationInvitation]
@@ -242,7 +242,7 @@ module FlatApi
242
242
  end
243
243
 
244
244
  # Create a new invitation to join the organization
245
- # This method creates and sends invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won&#39;t send an invitation. In this case, the property &#x60;usedBy&#x60; will be directly filled with the uniquer identifier of the corresponding user.
245
+ # This method creates and sends an invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won&#39;t send an invitation. In this case, the property &#x60;usedBy&#x60; will be directly filled with the unique identifier of the corresponding user.
246
246
  # @param body [OrganizationInvitationCreation]
247
247
  # @param [Hash] opts the optional parameters
248
248
  # @return [Array<(OrganizationInvitation, Integer, Hash)>] OrganizationInvitation data, response status code and response headers
@@ -943,7 +943,7 @@ module FlatApi
943
943
  # This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)
944
944
  # @param user [String] Unique identifier of the Flat account
945
945
  # @param [Hash] opts the optional parameters
946
- # @option opts [Boolean] :convert_to_individual If &#x60;true&#x60;, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal.
946
+ # @option opts [Boolean] :convert_to_individual If &#x60;true&#x60;, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before performing this operation, you need to be sure that the user is at least 13 years old and has read and agreed to the Individual Terms of Service of Flat available on https://flat.io/legal.
947
947
  # @return [nil]
948
948
  def remove_organization_user(user, opts = {})
949
949
  remove_organization_user_with_http_info(user, opts)
@@ -954,7 +954,7 @@ module FlatApi
954
954
  # This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)
955
955
  # @param user [String] Unique identifier of the Flat account
956
956
  # @param [Hash] opts the optional parameters
957
- # @option opts [Boolean] :convert_to_individual If &#x60;true&#x60;, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal.
957
+ # @option opts [Boolean] :convert_to_individual If &#x60;true&#x60;, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before performing this operation, you need to be sure that the user is at least 13 years old and has read and agreed to the Individual Terms of Service of Flat available on https://flat.io/legal.
958
958
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
959
959
  def remove_organization_user_with_http_info(user, opts = {})
960
960
  if @api_client.config.debugging