flat_api 0.1.2 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (209) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/README.md +34 -12
  4. data/docs/ClassApi.md +2 -2
  5. data/docs/Collection.md +18 -0
  6. data/docs/CollectionApi.md +521 -0
  7. data/docs/CollectionCapabilities.md +12 -0
  8. data/docs/CollectionCreation.md +8 -0
  9. data/docs/CollectionModification.md +8 -0
  10. data/docs/CollectionPrivacy.md +7 -0
  11. data/docs/CollectionTitle.md +7 -0
  12. data/docs/CollectionType.md +7 -0
  13. data/docs/ResourceCollaborator.md +16 -0
  14. data/docs/{ScoreCollaboratorCreation.md → ResourceCollaboratorCreation.md} +2 -1
  15. data/docs/ResourceRights.md +10 -0
  16. data/docs/ResourceSharingKey.md +7 -0
  17. data/docs/ScoreApi.md +144 -91
  18. data/docs/ScoreCreation.md +2 -1
  19. data/docs/ScoreDetails.md +2 -2
  20. data/docs/ScoreFork.md +1 -0
  21. data/docs/ScoreModification.md +2 -1
  22. data/docs/UserApi.md +1 -1
  23. data/flat_api.gemspec +1 -1
  24. data/lib/flat_api.rb +13 -4
  25. data/lib/flat_api/api/account_api.rb +1 -1
  26. data/lib/flat_api/api/class_api.rb +1 -1
  27. data/lib/flat_api/api/collection_api.rb +596 -0
  28. data/lib/flat_api/api/group_api.rb +1 -1
  29. data/lib/flat_api/api/organization_api.rb +1 -1
  30. data/lib/flat_api/api/score_api.rb +125 -53
  31. data/lib/flat_api/api/user_api.rb +3 -3
  32. data/lib/flat_api/api_client.rb +1 -1
  33. data/lib/flat_api/api_error.rb +1 -1
  34. data/lib/flat_api/configuration.rb +1 -1
  35. data/lib/flat_api/models/assignment.rb +1 -1
  36. data/lib/flat_api/models/assignment_copy.rb +1 -1
  37. data/lib/flat_api/models/assignment_creation.rb +1 -1
  38. data/lib/flat_api/models/assignment_submission.rb +1 -1
  39. data/lib/flat_api/models/assignment_submission_update.rb +1 -1
  40. data/lib/flat_api/models/class_attachment_creation.rb +1 -1
  41. data/lib/flat_api/models/class_creation.rb +1 -1
  42. data/lib/flat_api/models/class_details.rb +1 -1
  43. data/lib/flat_api/models/class_details_canvas.rb +1 -1
  44. data/lib/flat_api/models/class_details_clever.rb +1 -1
  45. data/lib/flat_api/models/class_details_google_classroom.rb +1 -1
  46. data/lib/flat_api/models/class_details_google_drive.rb +1 -1
  47. data/lib/flat_api/models/class_details_lti.rb +1 -1
  48. data/lib/flat_api/models/class_roles.rb +1 -1
  49. data/lib/flat_api/models/class_state.rb +1 -1
  50. data/lib/flat_api/models/class_update.rb +1 -1
  51. data/lib/flat_api/models/collection.rb +285 -0
  52. data/lib/flat_api/models/collection_capabilities.rb +229 -0
  53. data/lib/flat_api/models/collection_creation.rb +193 -0
  54. data/lib/flat_api/models/collection_modification.rb +188 -0
  55. data/lib/flat_api/models/collection_privacy.rb +30 -0
  56. data/lib/flat_api/models/collection_title.rb +179 -0
  57. data/lib/flat_api/models/collection_type.rb +34 -0
  58. data/lib/flat_api/models/flat_error_response.rb +1 -1
  59. data/lib/flat_api/models/flat_locales.rb +1 -1
  60. data/lib/flat_api/models/google_classroom_coursework.rb +1 -1
  61. data/lib/flat_api/models/google_classroom_submission.rb +1 -1
  62. data/lib/flat_api/models/group.rb +1 -1
  63. data/lib/flat_api/models/group_details.rb +1 -1
  64. data/lib/flat_api/models/group_type.rb +1 -1
  65. data/lib/flat_api/models/license_mode.rb +1 -1
  66. data/lib/flat_api/models/license_sources.rb +1 -1
  67. data/lib/flat_api/models/lms_name.rb +1 -1
  68. data/lib/flat_api/models/lti_credentials.rb +1 -1
  69. data/lib/flat_api/models/lti_credentials_creation.rb +1 -1
  70. data/lib/flat_api/models/media_attachment.rb +1 -1
  71. data/lib/flat_api/models/media_score_sharing_mode.rb +1 -1
  72. data/lib/flat_api/models/organization_invitation.rb +1 -1
  73. data/lib/flat_api/models/organization_invitation_creation.rb +1 -1
  74. data/lib/flat_api/models/organization_roles.rb +1 -1
  75. data/lib/flat_api/models/{score_collaborator.rb → resource_collaborator.rb} +54 -44
  76. data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +14 -4
  77. data/lib/flat_api/models/{score_rights.rb → resource_rights.rb} +6 -6
  78. data/lib/flat_api/models/resource_sharing_key.rb +179 -0
  79. data/lib/flat_api/models/score_comment.rb +1 -1
  80. data/lib/flat_api/models/score_comment_context.rb +1 -1
  81. data/lib/flat_api/models/score_comment_creation.rb +1 -1
  82. data/lib/flat_api/models/score_comment_update.rb +1 -1
  83. data/lib/flat_api/models/score_comments_counts.rb +1 -1
  84. data/lib/flat_api/models/score_creation.rb +13 -3
  85. data/lib/flat_api/models/score_creation_type.rb +1 -1
  86. data/lib/flat_api/models/score_data.rb +1 -1
  87. data/lib/flat_api/models/score_data_encoding.rb +1 -1
  88. data/lib/flat_api/models/score_details.rb +3 -3
  89. data/lib/flat_api/models/score_fork.rb +13 -3
  90. data/lib/flat_api/models/score_license.rb +1 -1
  91. data/lib/flat_api/models/score_likes_counts.rb +1 -1
  92. data/lib/flat_api/models/score_modification.rb +13 -20
  93. data/lib/flat_api/models/score_privacy.rb +1 -1
  94. data/lib/flat_api/models/score_revision.rb +1 -1
  95. data/lib/flat_api/models/score_revision_creation.rb +1 -1
  96. data/lib/flat_api/models/score_revision_statistics.rb +1 -1
  97. data/lib/flat_api/models/score_source.rb +1 -1
  98. data/lib/flat_api/models/score_summary.rb +1 -1
  99. data/lib/flat_api/models/score_track.rb +1 -1
  100. data/lib/flat_api/models/score_track_creation.rb +1 -1
  101. data/lib/flat_api/models/score_track_point.rb +1 -1
  102. data/lib/flat_api/models/score_track_state.rb +1 -1
  103. data/lib/flat_api/models/score_track_type.rb +1 -1
  104. data/lib/flat_api/models/score_track_update.rb +1 -1
  105. data/lib/flat_api/models/score_views_counts.rb +1 -1
  106. data/lib/flat_api/models/user_admin_update.rb +1 -1
  107. data/lib/flat_api/models/user_basics.rb +1 -1
  108. data/lib/flat_api/models/user_creation.rb +1 -1
  109. data/lib/flat_api/models/user_details.rb +1 -1
  110. data/lib/flat_api/models/user_details_admin.rb +1 -1
  111. data/lib/flat_api/models/user_details_admin_license.rb +1 -1
  112. data/lib/flat_api/models/user_instruments.rb +1 -1
  113. data/lib/flat_api/models/user_public.rb +1 -1
  114. data/lib/flat_api/models/user_public_summary.rb +1 -1
  115. data/lib/flat_api/version.rb +2 -2
  116. data/spec/api/account_api_spec.rb +2 -2
  117. data/spec/api/class_api_spec.rb +2 -2
  118. data/spec/api/collection_api_spec.rb +159 -0
  119. data/spec/api/group_api_spec.rb +2 -2
  120. data/spec/api/organization_api_spec.rb +2 -2
  121. data/spec/api/score_api_spec.rb +41 -26
  122. data/spec/api/user_api_spec.rb +3 -3
  123. data/spec/api_client_spec.rb +2 -2
  124. data/spec/configuration_spec.rb +2 -2
  125. data/spec/models/assignment_copy_spec.rb +2 -2
  126. data/spec/models/assignment_creation_spec.rb +2 -2
  127. data/spec/models/assignment_spec.rb +2 -2
  128. data/spec/models/assignment_submission_spec.rb +2 -2
  129. data/spec/models/assignment_submission_update_spec.rb +2 -2
  130. data/spec/models/class_attachment_creation_spec.rb +2 -2
  131. data/spec/models/class_creation_spec.rb +2 -2
  132. data/spec/models/class_details_canvas_spec.rb +2 -2
  133. data/spec/models/class_details_clever_spec.rb +2 -2
  134. data/spec/models/class_details_google_classroom_spec.rb +2 -2
  135. data/spec/models/class_details_google_drive_spec.rb +2 -2
  136. data/spec/models/class_details_lti_spec.rb +2 -2
  137. data/spec/models/class_details_spec.rb +2 -2
  138. data/spec/models/class_roles_spec.rb +2 -2
  139. data/spec/models/class_state_spec.rb +2 -2
  140. data/spec/models/class_update_spec.rb +2 -2
  141. data/spec/models/collection_capabilities_spec.rb +66 -0
  142. data/spec/models/collection_creation_spec.rb +42 -0
  143. data/spec/models/collection_modification_spec.rb +42 -0
  144. data/spec/models/collection_privacy_spec.rb +36 -0
  145. data/spec/models/collection_spec.rb +102 -0
  146. data/spec/models/collection_title_spec.rb +36 -0
  147. data/spec/models/collection_type_spec.rb +36 -0
  148. data/spec/models/flat_error_response_spec.rb +2 -2
  149. data/spec/models/flat_locales_spec.rb +2 -2
  150. data/spec/models/google_classroom_coursework_spec.rb +2 -2
  151. data/spec/models/google_classroom_submission_spec.rb +2 -2
  152. data/spec/models/group_details_spec.rb +2 -2
  153. data/spec/models/group_spec.rb +2 -2
  154. data/spec/models/group_type_spec.rb +2 -2
  155. data/spec/models/license_mode_spec.rb +2 -2
  156. data/spec/models/license_sources_spec.rb +2 -2
  157. data/spec/models/lms_name_spec.rb +2 -2
  158. data/spec/models/lti_credentials_creation_spec.rb +2 -2
  159. data/spec/models/lti_credentials_spec.rb +2 -2
  160. data/spec/models/media_attachment_spec.rb +2 -2
  161. data/spec/models/media_score_sharing_mode_spec.rb +2 -2
  162. data/spec/models/organization_invitation_creation_spec.rb +2 -2
  163. data/spec/models/organization_invitation_spec.rb +2 -2
  164. data/spec/models/organization_roles_spec.rb +2 -2
  165. data/spec/models/{score_collaborator_creation_spec.rb → resource_collaborator_creation_spec.rb} +14 -8
  166. data/spec/models/{score_collaborator_spec.rb → resource_collaborator_spec.rb} +22 -16
  167. data/spec/models/{score_rights_spec.rb → resource_rights_spec.rb} +14 -8
  168. data/spec/models/resource_sharing_key_spec.rb +36 -0
  169. data/spec/models/score_comment_context_spec.rb +2 -2
  170. data/spec/models/score_comment_creation_spec.rb +2 -2
  171. data/spec/models/score_comment_spec.rb +2 -2
  172. data/spec/models/score_comment_update_spec.rb +2 -2
  173. data/spec/models/score_comments_counts_spec.rb +2 -2
  174. data/spec/models/score_creation_spec.rb +8 -2
  175. data/spec/models/score_creation_type_spec.rb +2 -2
  176. data/spec/models/score_data_encoding_spec.rb +2 -2
  177. data/spec/models/score_data_spec.rb +2 -2
  178. data/spec/models/score_details_spec.rb +2 -2
  179. data/spec/models/score_fork_spec.rb +8 -2
  180. data/spec/models/score_license_spec.rb +2 -2
  181. data/spec/models/score_likes_counts_spec.rb +2 -2
  182. data/spec/models/score_modification_spec.rb +8 -2
  183. data/spec/models/score_privacy_spec.rb +2 -2
  184. data/spec/models/score_revision_creation_spec.rb +2 -2
  185. data/spec/models/score_revision_spec.rb +2 -2
  186. data/spec/models/score_revision_statistics_spec.rb +2 -2
  187. data/spec/models/score_source_spec.rb +2 -2
  188. data/spec/models/score_summary_spec.rb +2 -2
  189. data/spec/models/score_track_creation_spec.rb +2 -2
  190. data/spec/models/score_track_point_spec.rb +2 -2
  191. data/spec/models/score_track_spec.rb +2 -2
  192. data/spec/models/score_track_state_spec.rb +2 -2
  193. data/spec/models/score_track_type_spec.rb +2 -2
  194. data/spec/models/score_track_update_spec.rb +2 -2
  195. data/spec/models/score_views_counts_spec.rb +2 -2
  196. data/spec/models/user_admin_update_spec.rb +2 -2
  197. data/spec/models/user_basics_spec.rb +2 -2
  198. data/spec/models/user_creation_spec.rb +2 -2
  199. data/spec/models/user_details_admin_license_spec.rb +2 -2
  200. data/spec/models/user_details_admin_spec.rb +2 -2
  201. data/spec/models/user_details_spec.rb +2 -2
  202. data/spec/models/user_instruments_spec.rb +2 -2
  203. data/spec/models/user_public_spec.rb +2 -2
  204. data/spec/models/user_public_summary_spec.rb +2 -2
  205. data/spec/spec_helper.rb +2 -2
  206. metadata +50 -15
  207. data/docs/ScoreCollaborator.md +0 -15
  208. data/docs/ScoreRights.md +0 -10
  209. data/git_push.sh +0 -55
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
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 or MIDI files * 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 interoduction](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
- OpenAPI spec version: 2.5.0
6
+ OpenAPI spec version: 2.6.0
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
9
+ Swagger Codegen version: 2.4.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: flat_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Flat Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-02-07 00:00:00.000000000 Z
11
+ date: 2018-04-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -223,6 +223,14 @@ files:
223
223
  - docs/ClassRoles.md
224
224
  - docs/ClassState.md
225
225
  - docs/ClassUpdate.md
226
+ - docs/Collection.md
227
+ - docs/CollectionApi.md
228
+ - docs/CollectionCapabilities.md
229
+ - docs/CollectionCreation.md
230
+ - docs/CollectionModification.md
231
+ - docs/CollectionPrivacy.md
232
+ - docs/CollectionTitle.md
233
+ - docs/CollectionType.md
226
234
  - docs/FlatErrorResponse.md
227
235
  - docs/FlatLocales.md
228
236
  - docs/GoogleClassroomCoursework.md
@@ -242,9 +250,11 @@ files:
242
250
  - docs/OrganizationInvitation.md
243
251
  - docs/OrganizationInvitationCreation.md
244
252
  - docs/OrganizationRoles.md
253
+ - docs/ResourceCollaborator.md
254
+ - docs/ResourceCollaboratorCreation.md
255
+ - docs/ResourceRights.md
256
+ - docs/ResourceSharingKey.md
245
257
  - docs/ScoreApi.md
246
- - docs/ScoreCollaborator.md
247
- - docs/ScoreCollaboratorCreation.md
248
258
  - docs/ScoreComment.md
249
259
  - docs/ScoreCommentContext.md
250
260
  - docs/ScoreCommentCreation.md
@@ -263,7 +273,6 @@ files:
263
273
  - docs/ScoreRevision.md
264
274
  - docs/ScoreRevisionCreation.md
265
275
  - docs/ScoreRevisionStatistics.md
266
- - docs/ScoreRights.md
267
276
  - docs/ScoreSource.md
268
277
  - docs/ScoreSummary.md
269
278
  - docs/ScoreTrack.md
@@ -284,10 +293,10 @@ files:
284
293
  - docs/UserPublic.md
285
294
  - docs/UserPublicSummary.md
286
295
  - flat_api.gemspec
287
- - git_push.sh
288
296
  - lib/flat_api.rb
289
297
  - lib/flat_api/api/account_api.rb
290
298
  - lib/flat_api/api/class_api.rb
299
+ - lib/flat_api/api/collection_api.rb
291
300
  - lib/flat_api/api/group_api.rb
292
301
  - lib/flat_api/api/organization_api.rb
293
302
  - lib/flat_api/api/score_api.rb
@@ -311,6 +320,13 @@ files:
311
320
  - lib/flat_api/models/class_roles.rb
312
321
  - lib/flat_api/models/class_state.rb
313
322
  - lib/flat_api/models/class_update.rb
323
+ - lib/flat_api/models/collection.rb
324
+ - lib/flat_api/models/collection_capabilities.rb
325
+ - lib/flat_api/models/collection_creation.rb
326
+ - lib/flat_api/models/collection_modification.rb
327
+ - lib/flat_api/models/collection_privacy.rb
328
+ - lib/flat_api/models/collection_title.rb
329
+ - lib/flat_api/models/collection_type.rb
314
330
  - lib/flat_api/models/flat_error_response.rb
315
331
  - lib/flat_api/models/flat_locales.rb
316
332
  - lib/flat_api/models/google_classroom_coursework.rb
@@ -328,8 +344,10 @@ files:
328
344
  - lib/flat_api/models/organization_invitation.rb
329
345
  - lib/flat_api/models/organization_invitation_creation.rb
330
346
  - lib/flat_api/models/organization_roles.rb
331
- - lib/flat_api/models/score_collaborator.rb
332
- - lib/flat_api/models/score_collaborator_creation.rb
347
+ - lib/flat_api/models/resource_collaborator.rb
348
+ - lib/flat_api/models/resource_collaborator_creation.rb
349
+ - lib/flat_api/models/resource_rights.rb
350
+ - lib/flat_api/models/resource_sharing_key.rb
333
351
  - lib/flat_api/models/score_comment.rb
334
352
  - lib/flat_api/models/score_comment_context.rb
335
353
  - lib/flat_api/models/score_comment_creation.rb
@@ -348,7 +366,6 @@ files:
348
366
  - lib/flat_api/models/score_revision.rb
349
367
  - lib/flat_api/models/score_revision_creation.rb
350
368
  - lib/flat_api/models/score_revision_statistics.rb
351
- - lib/flat_api/models/score_rights.rb
352
369
  - lib/flat_api/models/score_source.rb
353
370
  - lib/flat_api/models/score_summary.rb
354
371
  - lib/flat_api/models/score_track.rb
@@ -370,6 +387,7 @@ files:
370
387
  - lib/flat_api/version.rb
371
388
  - spec/api/account_api_spec.rb
372
389
  - spec/api/class_api_spec.rb
390
+ - spec/api/collection_api_spec.rb
373
391
  - spec/api/group_api_spec.rb
374
392
  - spec/api/organization_api_spec.rb
375
393
  - spec/api/score_api_spec.rb
@@ -392,6 +410,13 @@ files:
392
410
  - spec/models/class_roles_spec.rb
393
411
  - spec/models/class_state_spec.rb
394
412
  - spec/models/class_update_spec.rb
413
+ - spec/models/collection_capabilities_spec.rb
414
+ - spec/models/collection_creation_spec.rb
415
+ - spec/models/collection_modification_spec.rb
416
+ - spec/models/collection_privacy_spec.rb
417
+ - spec/models/collection_spec.rb
418
+ - spec/models/collection_title_spec.rb
419
+ - spec/models/collection_type_spec.rb
395
420
  - spec/models/flat_error_response_spec.rb
396
421
  - spec/models/flat_locales_spec.rb
397
422
  - spec/models/google_classroom_coursework_spec.rb
@@ -409,8 +434,10 @@ files:
409
434
  - spec/models/organization_invitation_creation_spec.rb
410
435
  - spec/models/organization_invitation_spec.rb
411
436
  - spec/models/organization_roles_spec.rb
412
- - spec/models/score_collaborator_creation_spec.rb
413
- - spec/models/score_collaborator_spec.rb
437
+ - spec/models/resource_collaborator_creation_spec.rb
438
+ - spec/models/resource_collaborator_spec.rb
439
+ - spec/models/resource_rights_spec.rb
440
+ - spec/models/resource_sharing_key_spec.rb
414
441
  - spec/models/score_comment_context_spec.rb
415
442
  - spec/models/score_comment_creation_spec.rb
416
443
  - spec/models/score_comment_spec.rb
@@ -429,7 +456,6 @@ files:
429
456
  - spec/models/score_revision_creation_spec.rb
430
457
  - spec/models/score_revision_spec.rb
431
458
  - spec/models/score_revision_statistics_spec.rb
432
- - spec/models/score_rights_spec.rb
433
459
  - spec/models/score_source_spec.rb
434
460
  - spec/models/score_summary_spec.rb
435
461
  - spec/models/score_track_creation_spec.rb
@@ -474,6 +500,7 @@ signing_key:
474
500
  specification_version: 4
475
501
  summary: Ruby Client for Flat REST API (https://flat.io)
476
502
  test_files:
503
+ - spec/api/collection_api_spec.rb
477
504
  - spec/api/organization_api_spec.rb
478
505
  - spec/api/score_api_spec.rb
479
506
  - spec/api/account_api_spec.rb
@@ -483,29 +510,33 @@ test_files:
483
510
  - spec/api_client_spec.rb
484
511
  - spec/configuration_spec.rb
485
512
  - spec/models/score_track_update_spec.rb
486
- - spec/models/score_collaborator_creation_spec.rb
487
513
  - spec/models/score_revision_creation_spec.rb
488
514
  - spec/models/score_views_counts_spec.rb
489
515
  - spec/models/organization_roles_spec.rb
516
+ - spec/models/collection_spec.rb
490
517
  - spec/models/user_admin_update_spec.rb
491
518
  - spec/models/user_public_spec.rb
492
519
  - spec/models/class_attachment_creation_spec.rb
493
520
  - spec/models/user_details_admin_license_spec.rb
494
521
  - spec/models/score_creation_type_spec.rb
522
+ - spec/models/resource_sharing_key_spec.rb
495
523
  - spec/models/license_sources_spec.rb
496
524
  - spec/models/score_privacy_spec.rb
497
- - spec/models/score_rights_spec.rb
498
525
  - spec/models/class_details_clever_spec.rb
499
526
  - spec/models/score_track_state_spec.rb
500
527
  - spec/models/user_details_admin_spec.rb
501
528
  - spec/models/user_details_spec.rb
502
529
  - spec/models/score_creation_spec.rb
530
+ - spec/models/resource_collaborator_creation_spec.rb
503
531
  - spec/models/score_comment_context_spec.rb
532
+ - spec/models/collection_capabilities_spec.rb
533
+ - spec/models/collection_privacy_spec.rb
504
534
  - spec/models/class_state_spec.rb
505
535
  - spec/models/assignment_submission_update_spec.rb
506
536
  - spec/models/score_track_type_spec.rb
507
537
  - spec/models/license_mode_spec.rb
508
538
  - spec/models/google_classroom_submission_spec.rb
539
+ - spec/models/collection_title_spec.rb
509
540
  - spec/models/score_likes_counts_spec.rb
510
541
  - spec/models/score_summary_spec.rb
511
542
  - spec/models/score_track_creation_spec.rb
@@ -518,10 +549,10 @@ test_files:
518
549
  - spec/models/score_revision_statistics_spec.rb
519
550
  - spec/models/score_comments_counts_spec.rb
520
551
  - spec/models/lms_name_spec.rb
521
- - spec/models/score_collaborator_spec.rb
522
552
  - spec/models/google_classroom_coursework_spec.rb
523
553
  - spec/models/flat_error_response_spec.rb
524
554
  - spec/models/media_attachment_spec.rb
555
+ - spec/models/collection_creation_spec.rb
525
556
  - spec/models/class_details_lti_spec.rb
526
557
  - spec/models/user_instruments_spec.rb
527
558
  - spec/models/class_details_google_drive_spec.rb
@@ -531,7 +562,9 @@ test_files:
531
562
  - spec/models/score_track_point_spec.rb
532
563
  - spec/models/score_modification_spec.rb
533
564
  - spec/models/class_creation_spec.rb
565
+ - spec/models/collection_modification_spec.rb
534
566
  - spec/models/score_source_spec.rb
567
+ - spec/models/collection_type_spec.rb
535
568
  - spec/models/score_license_spec.rb
536
569
  - spec/models/lti_credentials_creation_spec.rb
537
570
  - spec/models/assignment_submission_spec.rb
@@ -551,7 +584,9 @@ test_files:
551
584
  - spec/models/class_details_spec.rb
552
585
  - spec/models/class_details_google_classroom_spec.rb
553
586
  - spec/models/group_type_spec.rb
587
+ - spec/models/resource_rights_spec.rb
554
588
  - spec/models/user_public_summary_spec.rb
555
589
  - spec/models/user_basics_spec.rb
556
590
  - spec/models/score_revision_spec.rb
591
+ - spec/models/resource_collaborator_spec.rb
557
592
  - spec/spec_helper.rb
@@ -1,15 +0,0 @@
1
- # FlatApi::ScoreCollaborator
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the score permission | [optional]
7
- **score** | **String** | The unique identifier of the score | [optional]
8
- **user** | [**UserPublic**](UserPublic.md) | | [optional]
9
- **group** | [**Group**](Group.md) | | [optional]
10
- **user_email** | **String** | If the collaborator is not a user of Flat yet, this field will contain his email. | [optional]
11
- **acl_read** | **BOOLEAN** | `True` if the related user can read the score. (probably true if the user has a permission on the document). | [optional] [default to true]
12
- **acl_write** | **BOOLEAN** | `True` if the related user can modify the score. | [optional] [default to false]
13
- **acl_admin** | **BOOLEAN** | `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document | [optional] [default to false]
14
-
15
-
@@ -1,10 +0,0 @@
1
- # FlatApi::ScoreRights
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to true]
7
- **acl_write** | **BOOLEAN** | `True` if the current user can modify the current document | [optional] [default to false]
8
- **acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document, i.e. changing the document permissions and deleting the document | [optional] [default to false]
9
-
10
-
@@ -1,55 +0,0 @@
1
- #!/bin/sh
2
- #
3
- # Generated by: https://github.com/swagger-api/swagger-codegen.git
4
- #
5
- # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
6
- #
7
- # Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
8
-
9
- git_user_id=$1
10
- git_repo_id=$2
11
- release_note=$3
12
-
13
- if [ "$git_user_id" = "" ]; then
14
- git_user_id="FlatIO"
15
- echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
16
- fi
17
-
18
- if [ "$git_repo_id" = "" ]; then
19
- git_repo_id="api-client-ruby"
20
- echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
21
- fi
22
-
23
- if [ "$release_note" = "" ]; then
24
- release_note="Minor update"
25
- echo "[INFO] No command line input provided. Set \$release_note to $release_note"
26
- fi
27
-
28
- # Initialize the local directory as a Git repository
29
- git init
30
-
31
- # Adds the files in the local repository and stages them for commit.
32
- git add .
33
-
34
- # Commits the tracked changes and prepares them to be pushed to a remote repository.
35
- git commit -m "$release_note"
36
-
37
- # Sets the new remote
38
- git_remote=`git remote`
39
- if [ "$git_remote" = "" ]; then # git remote not defined
40
-
41
- if [ "$GIT_TOKEN" = "" ]; then
42
- echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
43
- git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
44
- else
45
- git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
46
- fi
47
-
48
- fi
49
-
50
- git pull origin master
51
-
52
- # Pushes (Forces) the changes in the local repository up to the remote repository
53
- echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
54
- git push origin master 2>&1 | grep -v 'To https'
55
-