flat_api 0.3.5 → 1.0.0

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 (374) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +69 -0
  3. data/LICENSE +201 -0
  4. data/README.md +92 -0
  5. data/lib/flat_api/api/account_api.rb +4 -4
  6. data/lib/flat_api/api/class_api.rb +281 -63
  7. data/lib/flat_api/api/collection_api.rb +63 -50
  8. data/lib/flat_api/api/edu_resources_api.rb +38 -26
  9. data/lib/flat_api/api/group_api.rb +432 -9
  10. data/lib/flat_api/api/omr_api.rb +894 -0
  11. data/lib/flat_api/api/organization_api.rb +307 -35
  12. data/lib/flat_api/api/score_api.rb +129 -80
  13. data/lib/flat_api/api/task_api.rb +5 -5
  14. data/lib/flat_api/api/user_api.rb +45 -14
  15. data/lib/flat_api/api_client.rb +169 -96
  16. data/lib/flat_api/api_error.rb +3 -3
  17. data/lib/flat_api/api_model_base.rb +88 -0
  18. data/lib/flat_api/client.rb +69 -0
  19. data/lib/flat_api/configuration.rb +124 -25
  20. data/lib/flat_api/errors.rb +86 -0
  21. data/lib/flat_api/models/add_group_user200_response.rb +148 -0
  22. data/lib/flat_api/models/add_group_user_request.rb +165 -0
  23. data/lib/flat_api/models/api_access_token.rb +13 -80
  24. data/lib/flat_api/models/app_scopes.rb +6 -4
  25. data/lib/flat_api/models/assignment.rb +190 -85
  26. data/lib/flat_api/models/assignment_capabilities.rb +53 -80
  27. data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +33 -80
  28. data/lib/flat_api/models/assignment_copy.rb +5 -6
  29. data/lib/flat_api/models/assignment_copy_response.rb +187 -82
  30. data/lib/flat_api/models/assignment_copy_to_class.rb +23 -80
  31. data/lib/flat_api/models/assignment_copy_to_resource_library.rb +23 -80
  32. data/lib/flat_api/models/assignment_group.rb +232 -0
  33. data/lib/flat_api/models/assignment_submission.rb +104 -81
  34. data/lib/flat_api/models/assignment_submission_comment.rb +13 -80
  35. data/lib/flat_api/models/assignment_submission_comment_creation.rb +23 -80
  36. data/lib/flat_api/models/assignment_submission_comments.rb +13 -80
  37. data/lib/flat_api/models/assignment_submission_history.rb +33 -80
  38. data/lib/flat_api/models/assignment_submission_history_attachment.rb +13 -80
  39. data/lib/flat_api/models/assignment_submission_history_state.rb +3 -3
  40. data/lib/flat_api/models/assignment_submission_lti.rb +64 -86
  41. data/lib/flat_api/models/{assignment_submission_playback_inner.rb → assignment_submission_playback.rb} +36 -83
  42. data/lib/flat_api/models/assignment_submission_state.rb +3 -3
  43. data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
  44. data/lib/flat_api/models/assignment_submission_update.rb +25 -81
  45. data/lib/flat_api/models/assignment_type.rb +5 -4
  46. data/lib/flat_api/models/assignment_update.rb +218 -87
  47. data/lib/flat_api/models/class_assignment.rb +219 -82
  48. data/lib/flat_api/models/class_assignment_all_of_canvas.rb +13 -80
  49. data/lib/flat_api/models/class_assignment_all_of_lti.rb +13 -80
  50. data/lib/flat_api/models/class_assignment_all_of_mfc.rb +13 -80
  51. data/lib/flat_api/models/class_assignment_update.rb +237 -94
  52. data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +13 -80
  53. data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +13 -80
  54. data/lib/flat_api/models/class_attachment_creation.rb +51 -86
  55. data/lib/flat_api/models/class_creation.rb +13 -80
  56. data/lib/flat_api/models/class_details.rb +85 -81
  57. data/lib/flat_api/models/class_details_canvas.rb +13 -80
  58. data/lib/flat_api/models/class_details_clever.rb +13 -80
  59. data/lib/flat_api/models/class_details_google_classroom.rb +13 -80
  60. data/lib/flat_api/models/class_details_google_drive.rb +13 -80
  61. data/lib/flat_api/models/class_details_issues.rb +13 -80
  62. data/lib/flat_api/models/class_details_issues_sync_inner.rb +15 -82
  63. data/lib/flat_api/models/class_details_lti.rb +28 -85
  64. data/lib/flat_api/models/class_details_mfc.rb +13 -80
  65. data/lib/flat_api/models/class_details_microsoft_graph.rb +13 -80
  66. data/lib/flat_api/models/class_grade_level.rb +3 -3
  67. data/lib/flat_api/models/class_roles.rb +3 -3
  68. data/lib/flat_api/models/class_state.rb +5 -4
  69. data/lib/flat_api/models/class_update.rb +13 -80
  70. data/lib/flat_api/models/collection.rb +182 -81
  71. data/lib/flat_api/models/collection_app.rb +13 -80
  72. data/lib/flat_api/models/collection_capabilities.rb +63 -80
  73. data/lib/flat_api/models/collection_contents.rb +166 -0
  74. data/lib/flat_api/models/collection_creation.rb +20 -99
  75. data/lib/flat_api/models/collection_modification.rb +17 -82
  76. data/lib/flat_api/models/collection_privacy.rb +3 -3
  77. data/lib/flat_api/models/collection_type.rb +7 -6
  78. data/lib/flat_api/models/credit_transaction.rb +388 -0
  79. data/lib/flat_api/models/edu_library.rb +63 -82
  80. data/lib/flat_api/models/edu_resource.rb +101 -84
  81. data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
  82. data/lib/flat_api/models/edu_resource_capabilities.rb +27 -84
  83. data/lib/flat_api/models/edu_resource_copy.rb +23 -80
  84. data/lib/flat_api/models/edu_resource_creation.rb +96 -86
  85. data/lib/flat_api/models/edu_resource_folder.rb +39 -84
  86. data/lib/flat_api/models/edu_resource_lti_link.rb +23 -80
  87. data/lib/flat_api/models/edu_resource_move.rb +23 -80
  88. data/lib/flat_api/models/edu_resource_privacy.rb +3 -3
  89. data/lib/flat_api/models/edu_resource_resource.rb +5 -6
  90. data/lib/flat_api/models/edu_resource_type.rb +3 -3
  91. data/lib/flat_api/models/edu_resource_update.rb +101 -86
  92. data/lib/flat_api/models/edu_resource_use_in_class.rb +23 -80
  93. data/lib/flat_api/models/flat_error_response.rb +47 -84
  94. data/lib/flat_api/models/google_classroom_coursework.rb +13 -80
  95. data/lib/flat_api/models/google_classroom_submission.rb +43 -80
  96. data/lib/flat_api/models/grade.rb +51 -0
  97. data/lib/flat_api/models/group.rb +14 -94
  98. data/lib/flat_api/models/group_creation.rb +238 -0
  99. data/lib/flat_api/models/group_details.rb +178 -84
  100. data/lib/flat_api/models/group_type.rb +6 -4
  101. data/lib/flat_api/models/license_mode.rb +3 -3
  102. data/lib/flat_api/models/license_sources.rb +3 -3
  103. data/lib/flat_api/models/lms_name.rb +3 -3
  104. data/lib/flat_api/models/lti_configuration.rb +56 -0
  105. data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
  106. data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
  107. data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
  108. data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
  109. data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
  110. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
  111. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
  112. data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
  113. data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
  114. data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
  115. data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
  116. data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
  117. data/lib/flat_api/models/lti_configuration_base.rb +306 -0
  118. data/lib/flat_api/models/lti_configuration_create.rb +60 -0
  119. data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
  120. data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
  121. data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
  122. data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
  123. data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
  124. data/lib/flat_api/models/lti_configuration_update.rb +104 -0
  125. data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
  126. data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
  127. data/lib/flat_api/models/lti_credentials.rb +29 -84
  128. data/lib/flat_api/models/lti_credentials_creation.rb +23 -80
  129. data/lib/flat_api/models/media_attachment.rb +43 -88
  130. data/lib/flat_api/models/media_score_sharing_mode.rb +3 -3
  131. data/lib/flat_api/models/microsoft_graph_assignment.rb +99 -88
  132. data/lib/flat_api/models/microsoft_graph_submission.rb +33 -80
  133. data/lib/flat_api/models/omr_capabilities.rb +480 -0
  134. data/lib/flat_api/models/omr_details_step_data.rb +228 -0
  135. data/lib/flat_api/models/omr_details_submission.rb +288 -0
  136. data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
  137. data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
  138. data/lib/flat_api/models/omr_instrument_override.rb +311 -0
  139. data/lib/flat_api/models/omr_job.rb +394 -0
  140. data/lib/flat_api/models/omr_job_creation.rb +238 -0
  141. data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
  142. data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
  143. data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
  144. data/lib/flat_api/models/omr_job_input_file.rb +176 -0
  145. data/lib/flat_api/models/omr_job_output.rb +40 -0
  146. data/lib/flat_api/models/omr_job_progress.rb +169 -0
  147. data/lib/flat_api/models/omr_job_result.rb +161 -0
  148. data/lib/flat_api/models/omr_job_retention.rb +176 -0
  149. data/lib/flat_api/models/omr_job_status.rb +44 -0
  150. data/lib/flat_api/models/omr_locale_details.rb +193 -0
  151. data/lib/flat_api/models/omr_pending_step.rb +213 -0
  152. data/lib/flat_api/models/omr_step_name.rb +39 -0
  153. data/lib/flat_api/models/organization_invitation.rb +54 -81
  154. data/lib/flat_api/models/organization_invitation_creation.rb +15 -82
  155. data/lib/flat_api/models/organization_roles.rb +5 -5
  156. data/lib/flat_api/models/organization_user_access_token_creation.rb +23 -80
  157. data/lib/flat_api/models/rename_group_request.rb +165 -0
  158. data/lib/flat_api/models/resource_collaborator.rb +43 -85
  159. data/lib/flat_api/models/resource_collaborator_creation.rb +13 -80
  160. data/lib/flat_api/models/resource_rights.rb +43 -85
  161. data/lib/flat_api/models/score_comment.rb +122 -80
  162. data/lib/flat_api/models/score_comment_context.rb +73 -80
  163. data/lib/flat_api/models/score_comment_creation.rb +24 -81
  164. data/lib/flat_api/models/score_comment_moderation.rb +13 -80
  165. data/lib/flat_api/models/score_comment_update.rb +18 -85
  166. data/lib/flat_api/models/score_comments_counts.rb +28 -85
  167. data/lib/flat_api/models/score_creation.rb +5 -6
  168. data/lib/flat_api/models/score_creation_builder_data.rb +24 -88
  169. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +23 -80
  170. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +13 -80
  171. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +24 -81
  172. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +33 -80
  173. data/lib/flat_api/models/score_creation_common.rb +14 -81
  174. data/lib/flat_api/models/score_creation_file_import.rb +39 -86
  175. data/lib/flat_api/models/score_creation_google_drive_import.rb +24 -81
  176. data/lib/flat_api/models/score_creation_type.rb +4 -5
  177. data/lib/flat_api/models/score_details.rb +180 -89
  178. data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
  179. data/lib/flat_api/models/score_fork.rb +14 -83
  180. data/lib/flat_api/models/score_license.rb +4 -5
  181. data/lib/flat_api/models/score_likes_counts.rb +28 -106
  182. data/lib/flat_api/models/score_modification.rb +13 -80
  183. data/lib/flat_api/models/score_plays_counts.rb +28 -85
  184. data/lib/flat_api/models/score_privacy.rb +3 -3
  185. data/lib/flat_api/models/score_revision.rb +81 -87
  186. data/lib/flat_api/models/score_revision_creation.rb +23 -80
  187. data/lib/flat_api/models/score_revision_statistics.rb +13 -80
  188. data/lib/flat_api/models/score_source.rb +13 -80
  189. data/lib/flat_api/models/score_summary.rb +63 -80
  190. data/lib/flat_api/models/score_track.rb +94 -88
  191. data/lib/flat_api/models/score_track_creation.rb +13 -80
  192. data/lib/flat_api/models/score_track_creation_response.rb +165 -0
  193. data/lib/flat_api/models/score_track_point.rb +23 -80
  194. data/lib/flat_api/models/score_track_purpose.rb +3 -3
  195. data/lib/flat_api/models/score_track_state.rb +3 -3
  196. data/lib/flat_api/models/score_track_type.rb +3 -3
  197. data/lib/flat_api/models/score_track_update.rb +25 -81
  198. data/lib/flat_api/models/score_views_counts.rb +28 -85
  199. data/lib/flat_api/models/task.rb +62 -87
  200. data/lib/flat_api/models/task_export_options.rb +13 -80
  201. data/lib/flat_api/models/task_progress.rb +13 -80
  202. data/lib/flat_api/models/task_result.rb +13 -80
  203. data/lib/flat_api/models/teaching_theme.rb +47 -0
  204. data/lib/flat_api/models/tutteo_product.rb +3 -3
  205. data/lib/flat_api/models/user_admin_update.rb +17 -95
  206. data/lib/flat_api/models/user_azure_details.rb +13 -80
  207. data/lib/flat_api/models/user_basics.rb +43 -80
  208. data/lib/flat_api/models/user_community_profile_links.rb +13 -80
  209. data/lib/flat_api/models/user_creation.rb +21 -98
  210. data/lib/flat_api/models/user_details.rb +101 -96
  211. data/lib/flat_api/models/user_details_admin.rb +72 -85
  212. data/lib/flat_api/models/user_details_admin_all_of_license.rb +13 -80
  213. data/lib/flat_api/models/user_public.rb +89 -94
  214. data/lib/flat_api/models/user_public_summary.rb +58 -81
  215. data/lib/flat_api/models/user_signin_link.rb +24 -81
  216. data/lib/flat_api/models/user_signin_link_creation.rb +13 -80
  217. data/lib/flat_api/oauth.rb +128 -0
  218. data/lib/flat_api/pagination.rb +88 -0
  219. data/lib/flat_api/retry.rb +56 -0
  220. data/lib/flat_api/version.rb +4 -4
  221. data/lib/flat_api.rb +70 -5
  222. metadata +98 -330
  223. data/lib/flat_api/models/flat_locales.rb +0 -56
  224. data/spec/api/account_api_spec.rb +0 -47
  225. data/spec/api/class_api_spec.rb +0 -422
  226. data/spec/api/collection_api_spec.rb +0 -158
  227. data/spec/api/edu_resources_api_spec.rb +0 -181
  228. data/spec/api/group_api_spec.rb +0 -71
  229. data/spec/api/organization_api_spec.rb +0 -201
  230. data/spec/api/score_api_spec.rb +0 -440
  231. data/spec/api/task_api_spec.rb +0 -47
  232. data/spec/api/user_api_spec.rb +0 -75
  233. data/spec/models/api_access_token_spec.rb +0 -66
  234. data/spec/models/app_scopes_spec.rb +0 -30
  235. data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +0 -42
  236. data/spec/models/assignment_capabilities_spec.rb +0 -60
  237. data/spec/models/assignment_copy_response_spec.rb +0 -124
  238. data/spec/models/assignment_copy_spec.rb +0 -32
  239. data/spec/models/assignment_copy_to_class_spec.rb +0 -48
  240. data/spec/models/assignment_copy_to_resource_library_spec.rb +0 -42
  241. data/spec/models/assignment_spec.rb +0 -118
  242. data/spec/models/assignment_submission_comment_creation_spec.rb +0 -36
  243. data/spec/models/assignment_submission_comment_spec.rb +0 -72
  244. data/spec/models/assignment_submission_comments_spec.rb +0 -42
  245. data/spec/models/assignment_submission_history_attachment_spec.rb +0 -48
  246. data/spec/models/assignment_submission_history_spec.rb +0 -112
  247. data/spec/models/assignment_submission_history_state_spec.rb +0 -30
  248. data/spec/models/assignment_submission_lti_spec.rb +0 -36
  249. data/spec/models/assignment_submission_playback_inner_spec.rb +0 -42
  250. data/spec/models/assignment_submission_spec.rb +0 -144
  251. data/spec/models/assignment_submission_state_spec.rb +0 -30
  252. data/spec/models/assignment_submission_update_spec.rb +0 -66
  253. data/spec/models/assignment_type_spec.rb +0 -30
  254. data/spec/models/assignment_update_spec.rb +0 -100
  255. data/spec/models/class_assignment_all_of_canvas_spec.rb +0 -42
  256. data/spec/models/class_assignment_all_of_lti_spec.rb +0 -36
  257. data/spec/models/class_assignment_all_of_mfc_spec.rb +0 -42
  258. data/spec/models/class_assignment_spec.rb +0 -216
  259. data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +0 -36
  260. data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +0 -36
  261. data/spec/models/class_assignment_update_spec.rb +0 -150
  262. data/spec/models/class_attachment_creation_spec.rb +0 -76
  263. data/spec/models/class_creation_spec.rb +0 -64
  264. data/spec/models/class_details_canvas_spec.rb +0 -42
  265. data/spec/models/class_details_clever_spec.rb +0 -76
  266. data/spec/models/class_details_google_classroom_spec.rb +0 -42
  267. data/spec/models/class_details_google_drive_spec.rb +0 -42
  268. data/spec/models/class_details_issues_spec.rb +0 -36
  269. data/spec/models/class_details_issues_sync_inner_spec.rb +0 -52
  270. data/spec/models/class_details_lti_spec.rb +0 -48
  271. data/spec/models/class_details_mfc_spec.rb +0 -42
  272. data/spec/models/class_details_microsoft_graph_spec.rb +0 -36
  273. data/spec/models/class_details_spec.rb +0 -178
  274. data/spec/models/class_grade_level_spec.rb +0 -30
  275. data/spec/models/class_roles_spec.rb +0 -30
  276. data/spec/models/class_state_spec.rb +0 -30
  277. data/spec/models/class_update_spec.rb +0 -64
  278. data/spec/models/collection_app_spec.rb +0 -48
  279. data/spec/models/collection_capabilities_spec.rb +0 -60
  280. data/spec/models/collection_creation_spec.rb +0 -42
  281. data/spec/models/collection_modification_spec.rb +0 -42
  282. data/spec/models/collection_privacy_spec.rb +0 -30
  283. data/spec/models/collection_spec.rb +0 -114
  284. data/spec/models/collection_type_spec.rb +0 -30
  285. data/spec/models/edu_library_spec.rb +0 -62
  286. data/spec/models/edu_resource_capabilities_spec.rb +0 -48
  287. data/spec/models/edu_resource_copy_spec.rb +0 -36
  288. data/spec/models/edu_resource_creation_spec.rb +0 -48
  289. data/spec/models/edu_resource_folder_spec.rb +0 -36
  290. data/spec/models/edu_resource_lti_link_spec.rb +0 -36
  291. data/spec/models/edu_resource_move_spec.rb +0 -36
  292. data/spec/models/edu_resource_privacy_spec.rb +0 -30
  293. data/spec/models/edu_resource_resource_spec.rb +0 -32
  294. data/spec/models/edu_resource_spec.rb +0 -96
  295. data/spec/models/edu_resource_type_spec.rb +0 -30
  296. data/spec/models/edu_resource_update_spec.rb +0 -42
  297. data/spec/models/edu_resource_use_in_class_spec.rb +0 -42
  298. data/spec/models/flat_error_response_spec.rb +0 -54
  299. data/spec/models/flat_locales_spec.rb +0 -30
  300. data/spec/models/google_classroom_coursework_spec.rb +0 -54
  301. data/spec/models/google_classroom_submission_spec.rb +0 -48
  302. data/spec/models/group_details_spec.rb +0 -72
  303. data/spec/models/group_spec.rb +0 -76
  304. data/spec/models/group_type_spec.rb +0 -30
  305. data/spec/models/license_mode_spec.rb +0 -30
  306. data/spec/models/license_sources_spec.rb +0 -30
  307. data/spec/models/lms_name_spec.rb +0 -30
  308. data/spec/models/lti_credentials_creation_spec.rb +0 -42
  309. data/spec/models/lti_credentials_spec.rb +0 -84
  310. data/spec/models/media_attachment_spec.rb +0 -166
  311. data/spec/models/media_score_sharing_mode_spec.rb +0 -30
  312. data/spec/models/microsoft_graph_assignment_spec.rb +0 -54
  313. data/spec/models/microsoft_graph_submission_spec.rb +0 -42
  314. data/spec/models/organization_invitation_creation_spec.rb +0 -46
  315. data/spec/models/organization_invitation_spec.rb +0 -84
  316. data/spec/models/organization_roles_spec.rb +0 -30
  317. data/spec/models/organization_user_access_token_creation_spec.rb +0 -36
  318. data/spec/models/resource_collaborator_creation_spec.rb +0 -72
  319. data/spec/models/resource_collaborator_spec.rb +0 -112
  320. data/spec/models/resource_rights_spec.rb +0 -64
  321. data/spec/models/score_comment_context_spec.rb +0 -78
  322. data/spec/models/score_comment_creation_spec.rb +0 -66
  323. data/spec/models/score_comment_moderation_spec.rb +0 -46
  324. data/spec/models/score_comment_spec.rb +0 -130
  325. data/spec/models/score_comment_update_spec.rb +0 -54
  326. data/spec/models/score_comments_counts_spec.rb +0 -54
  327. data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +0 -82
  328. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +0 -60
  329. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +0 -66
  330. data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +0 -42
  331. data/spec/models/score_creation_builder_data_spec.rb +0 -60
  332. data/spec/models/score_creation_common_spec.rb +0 -54
  333. data/spec/models/score_creation_file_import_spec.rb +0 -76
  334. data/spec/models/score_creation_google_drive_import_spec.rb +0 -60
  335. data/spec/models/score_creation_spec.rb +0 -32
  336. data/spec/models/score_creation_type_spec.rb +0 -30
  337. data/spec/models/score_details_spec.rb +0 -240
  338. data/spec/models/score_fork_spec.rb +0 -48
  339. data/spec/models/score_license_spec.rb +0 -30
  340. data/spec/models/score_likes_counts_spec.rb +0 -48
  341. data/spec/models/score_modification_spec.rb +0 -102
  342. data/spec/models/score_plays_counts_spec.rb +0 -48
  343. data/spec/models/score_privacy_spec.rb +0 -30
  344. data/spec/models/score_revision_creation_spec.rb +0 -58
  345. data/spec/models/score_revision_spec.rb +0 -78
  346. data/spec/models/score_revision_statistics_spec.rb +0 -54
  347. data/spec/models/score_source_spec.rb +0 -36
  348. data/spec/models/score_summary_spec.rb +0 -66
  349. data/spec/models/score_track_creation_spec.rb +0 -66
  350. data/spec/models/score_track_point_spec.rb +0 -52
  351. data/spec/models/score_track_purpose_spec.rb +0 -30
  352. data/spec/models/score_track_spec.rb +0 -108
  353. data/spec/models/score_track_state_spec.rb +0 -30
  354. data/spec/models/score_track_type_spec.rb +0 -30
  355. data/spec/models/score_track_update_spec.rb +0 -54
  356. data/spec/models/score_views_counts_spec.rb +0 -48
  357. data/spec/models/task_export_options_spec.rb +0 -36
  358. data/spec/models/task_progress_spec.rb +0 -42
  359. data/spec/models/task_result_spec.rb +0 -42
  360. data/spec/models/task_spec.rb +0 -100
  361. data/spec/models/tutteo_product_spec.rb +0 -30
  362. data/spec/models/user_admin_update_spec.rb +0 -66
  363. data/spec/models/user_azure_details_spec.rb +0 -48
  364. data/spec/models/user_basics_spec.rb +0 -94
  365. data/spec/models/user_community_profile_links_spec.rb +0 -66
  366. data/spec/models/user_creation_spec.rb +0 -76
  367. data/spec/models/user_details_admin_all_of_license_spec.rb +0 -60
  368. data/spec/models/user_details_admin_spec.rb +0 -142
  369. data/spec/models/user_details_spec.rb +0 -214
  370. data/spec/models/user_public_spec.rb +0 -178
  371. data/spec/models/user_public_summary_spec.rb +0 -118
  372. data/spec/models/user_signin_link_creation_spec.rb +0 -36
  373. data/spec/models/user_signin_link_spec.rb +0 -42
  374. data/spec/spec_helper.rb +0 -111
@@ -1,47 +0,0 @@
1
- =begin
2
- #Flat API
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore 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 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
-
6
- The version of the OpenAPI document: 2.20.0
7
- Contact: developers@flat.io
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for FlatApi::AccountApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'AccountApi' do
20
- before do
21
- # run before each test
22
- @api_instance = FlatApi::AccountApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of AccountApi' do
30
- it 'should create an instance of AccountApi' do
31
- expect(@api_instance).to be_instance_of(FlatApi::AccountApi)
32
- end
33
- end
34
-
35
- # unit tests for get_authenticated_user
36
- # Get current user account
37
- # Get details about the current authenticated User.
38
- # @param [Hash] opts the optional parameters
39
- # @option opts [Boolean] :only_id Only return the user id
40
- # @return [UserDetails]
41
- describe 'get_authenticated_user test' do
42
- it 'should work' do
43
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
44
- end
45
- end
46
-
47
- end
@@ -1,422 +0,0 @@
1
- =begin
2
- #Flat API
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore 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 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
-
6
- The version of the OpenAPI document: 2.20.0
7
- Contact: developers@flat.io
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for FlatApi::ClassApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'ClassApi' do
20
- before do
21
- # run before each test
22
- @api_instance = FlatApi::ClassApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of ClassApi' do
30
- it 'should create an instance of ClassApi' do
31
- expect(@api_instance).to be_instance_of(FlatApi::ClassApi)
32
- end
33
- end
34
-
35
- # unit tests for activate_class
36
- # Activate the class
37
- # Mark the class as `active`. This is mainly used for classes synchronized from Clever that are initially with an `inactive` state and hidden in the UI.
38
- # @param _class Unique identifier of the class
39
- # @param [Hash] opts the optional parameters
40
- # @return [ClassDetails]
41
- describe 'activate_class test' do
42
- it 'should work' do
43
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
44
- end
45
- end
46
-
47
- # unit tests for add_class_user
48
- # Add a user to the class
49
- # 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.
50
- # @param _class Unique identifier of the class
51
- # @param user Unique identifier of the user
52
- # @param [Hash] opts the optional parameters
53
- # @return [nil]
54
- describe 'add_class_user test' do
55
- it 'should work' do
56
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
- end
58
- end
59
-
60
- # unit tests for archive_assignment
61
- # Archive the assignment
62
- # Archive the assignment
63
- # @param _class Unique identifier of the class
64
- # @param assignment Unique identifier of the assignment
65
- # @param [Hash] opts the optional parameters
66
- # @return [Assignment]
67
- describe 'archive_assignment test' do
68
- it 'should work' do
69
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
70
- end
71
- end
72
-
73
- # unit tests for archive_class
74
- # Archive the class
75
- # Mark the class as `archived`. When this course is synchronized with another app, like Google Classroom, this state will be automatically be updated.
76
- # @param _class Unique identifier of the class
77
- # @param [Hash] opts the optional parameters
78
- # @return [ClassDetails]
79
- describe 'archive_class test' do
80
- it 'should work' do
81
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
82
- end
83
- end
84
-
85
- # unit tests for copy_assignment
86
- # Copy an assignment
87
- # Copy an assignment to a specified class or the resource library For class assignments: - If the original assignment has a due date in the past, this new assignment will be created without a due date. - If the class is synchronized with an external app (e.g. Google Classroom), the copied assignment will also be posted on the external app.
88
- # @param _class Unique identifier of the class
89
- # @param assignment Unique identifier of the assignment
90
- # @param body
91
- # @param [Hash] opts the optional parameters
92
- # @return [AssignmentCopyResponse]
93
- describe 'copy_assignment test' do
94
- it 'should work' do
95
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
96
- end
97
- end
98
-
99
- # unit tests for create_class
100
- # Create a new class
101
- # 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.
102
- # @param body
103
- # @param [Hash] opts the optional parameters
104
- # @return [ClassDetails]
105
- describe 'create_class test' do
106
- it 'should work' do
107
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
108
- end
109
- end
110
-
111
- # unit tests for create_class_assignment
112
- # Assignment creation
113
- # Use this method as a teacher to create and post a new assignment to a class. If the class is synchronized with Google Classroom, the assignment will be automatically posted to your Classroom course.
114
- # @param _class Unique identifier of the class
115
- # @param body
116
- # @param [Hash] opts the optional parameters
117
- # @return [Assignment]
118
- describe 'create_class_assignment test' do
119
- it 'should work' do
120
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
121
- end
122
- end
123
-
124
- # unit tests for create_submission
125
- # Create or edit a submission
126
- # 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.
127
- # @param _class Unique identifier of the class
128
- # @param assignment Unique identifier of the assignment
129
- # @param body
130
- # @param [Hash] opts the optional parameters
131
- # @return [AssignmentSubmission]
132
- describe 'create_submission test' do
133
- it 'should work' do
134
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
135
- end
136
- end
137
-
138
- # unit tests for create_test_student_account
139
- # Create a test student account
140
- # 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.
141
- # @param _class Unique identifier of the class
142
- # @param [Hash] opts the optional parameters
143
- # @option opts [Boolean] :reset If true, the testing account will be re-created.
144
- # @return [UserDetails]
145
- describe 'create_test_student_account test' do
146
- it 'should work' do
147
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
148
- end
149
- end
150
-
151
- # unit tests for delete_class_user
152
- # Remove a user from the class
153
- # This method can be used by a teacher to remove a user from the class, or by a student to leave the classroom. Warning: Removing a user from the class will remove the associated resources, including the submissions and feedback related to these submissions.
154
- # @param _class Unique identifier of the class
155
- # @param user Unique identifier of the user
156
- # @param [Hash] opts the optional parameters
157
- # @return [nil]
158
- describe 'delete_class_user test' do
159
- it 'should work' do
160
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
161
- end
162
- end
163
-
164
- # unit tests for delete_submission
165
- # Reset a submission
166
- # Use this method as a teacher to reset a submission and allow student to start over the assignment
167
- # @param _class Unique identifier of the class
168
- # @param assignment Unique identifier of the assignment
169
- # @param submission Unique identifier of the submission
170
- # @param [Hash] opts the optional parameters
171
- # @return [AssignmentSubmission]
172
- describe 'delete_submission test' do
173
- it 'should work' do
174
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
175
- end
176
- end
177
-
178
- # unit tests for delete_submission_comment
179
- # Delete a feedback comment to a submission
180
- # @param _class Unique identifier of the class
181
- # @param assignment Unique identifier of the assignment
182
- # @param submission Unique identifier of the submission
183
- # @param comment Unique identifier of the comment
184
- # @param [Hash] opts the optional parameters
185
- # @return [nil]
186
- describe 'delete_submission_comment test' do
187
- it 'should work' do
188
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
189
- end
190
- end
191
-
192
- # unit tests for edit_submission
193
- # Edit a submission
194
- # Use this method as a teacher to update the different submission and give feedback. Teachers can only set `return`, `draftGrade` and `grade`
195
- # @param _class Unique identifier of the class
196
- # @param assignment Unique identifier of the assignment
197
- # @param submission Unique identifier of the submission
198
- # @param body
199
- # @param [Hash] opts the optional parameters
200
- # @return [AssignmentSubmission]
201
- describe 'edit_submission test' do
202
- it 'should work' do
203
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
204
- end
205
- end
206
-
207
- # unit tests for enroll_class
208
- # Join a class
209
- # 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.
210
- # @param enrollment_code The enrollment code, available to the teacher in `ClassDetails`
211
- # @param [Hash] opts the optional parameters
212
- # @return [ClassDetails]
213
- describe 'enroll_class test' do
214
- it 'should work' do
215
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
216
- end
217
- end
218
-
219
- # unit tests for export_submissions_reviews_as_csv
220
- # CSV Grades exports
221
- # Export list of submissions grades to a CSV file
222
- # @param _class Unique identifier of the class
223
- # @param assignment Unique identifier of the assignment
224
- # @param [Hash] opts the optional parameters
225
- # @return [File]
226
- describe 'export_submissions_reviews_as_csv test' do
227
- it 'should work' do
228
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
229
- end
230
- end
231
-
232
- # unit tests for export_submissions_reviews_as_excel
233
- # Excel Grades exports
234
- # Export list of submissions grades to an Excel file
235
- # @param _class Unique identifier of the class
236
- # @param assignment Unique identifier of the assignment
237
- # @param [Hash] opts the optional parameters
238
- # @return [File]
239
- describe 'export_submissions_reviews_as_excel test' do
240
- it 'should work' do
241
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
242
- end
243
- end
244
-
245
- # unit tests for get_class
246
- # Get the details of a single class
247
- # @param _class Unique identifier of the class
248
- # @param [Hash] opts the optional parameters
249
- # @return [ClassDetails]
250
- describe 'get_class test' do
251
- it 'should work' do
252
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
253
- end
254
- end
255
-
256
- # unit tests for get_score_submissions
257
- # List submissions related to the score
258
- # 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.
259
- # @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
260
- # @param [Hash] opts the optional parameters
261
- # @return [Array<AssignmentSubmission>]
262
- describe 'get_score_submissions test' do
263
- it 'should work' do
264
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
265
- end
266
- end
267
-
268
- # unit tests for get_submission
269
- # Get a student submission
270
- # @param _class Unique identifier of the class
271
- # @param assignment Unique identifier of the assignment
272
- # @param submission Unique identifier of the submission
273
- # @param [Hash] opts the optional parameters
274
- # @return [AssignmentSubmission]
275
- describe 'get_submission test' do
276
- it 'should work' do
277
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
278
- end
279
- end
280
-
281
- # unit tests for get_submission_comments
282
- # List the feedback comments of a submission
283
- # @param _class Unique identifier of the class
284
- # @param assignment Unique identifier of the assignment
285
- # @param submission Unique identifier of the submission
286
- # @param [Hash] opts the optional parameters
287
- # @return [Array<AssignmentSubmissionComment>]
288
- describe 'get_submission_comments test' do
289
- it 'should work' do
290
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
291
- end
292
- end
293
-
294
- # unit tests for get_submission_history
295
- # Get the history of the submission
296
- # For teachers only. Returns a detailed history of the submission. This currently includes state and grade histories.
297
- # @param _class Unique identifier of the class
298
- # @param assignment Unique identifier of the assignment
299
- # @param submission Unique identifier of the submission
300
- # @param [Hash] opts the optional parameters
301
- # @return [Array<AssignmentSubmissionHistory>]
302
- describe 'get_submission_history test' do
303
- it 'should work' do
304
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
305
- end
306
- end
307
-
308
- # unit tests for get_submissions
309
- # List the students&#39; submissions
310
- # @param _class Unique identifier of the class
311
- # @param assignment Unique identifier of the assignment
312
- # @param [Hash] opts the optional parameters
313
- # @return [Array<AssignmentSubmission>]
314
- describe 'get_submissions test' do
315
- it 'should work' do
316
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
317
- end
318
- end
319
-
320
- # unit tests for list_assignments
321
- # Assignments listing
322
- # @param _class Unique identifier of the class
323
- # @param [Hash] opts the optional parameters
324
- # @return [Array<ClassAssignment>]
325
- describe 'list_assignments test' do
326
- it 'should work' do
327
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
328
- end
329
- end
330
-
331
- # unit tests for list_class_student_submissions
332
- # List the submissions for a student
333
- # Use this method as a teacher to list all the assignment submissions sent by a student of the class
334
- # @param _class Unique identifier of the class
335
- # @param user Unique identifier of the user
336
- # @param [Hash] opts the optional parameters
337
- # @return [Array<AssignmentSubmission>]
338
- describe 'list_class_student_submissions test' do
339
- it 'should work' do
340
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
341
- end
342
- end
343
-
344
- # unit tests for list_classes
345
- # List the classes available for the current user
346
- # @param [Hash] opts the optional parameters
347
- # @option opts [String] :state Filter the classes by state
348
- # @return [Array<ClassDetails>]
349
- describe 'list_classes test' do
350
- it 'should work' do
351
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
352
- end
353
- end
354
-
355
- # unit tests for post_submission_comment
356
- # Add a feedback comment to a submission
357
- # @param _class Unique identifier of the class
358
- # @param assignment Unique identifier of the assignment
359
- # @param submission Unique identifier of the submission
360
- # @param assignment_submission_comment_creation
361
- # @param [Hash] opts the optional parameters
362
- # @return [AssignmentSubmissionComment]
363
- describe 'post_submission_comment test' do
364
- it 'should work' do
365
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
366
- end
367
- end
368
-
369
- # unit tests for unarchive_assignment
370
- # Unarchive the assignment.
371
- # Mark the assignment as &#x60;active&#x60;.
372
- # @param _class Unique identifier of the class
373
- # @param assignment Unique identifier of the assignment
374
- # @param [Hash] opts the optional parameters
375
- # @return [Assignment]
376
- describe 'unarchive_assignment test' do
377
- it 'should work' do
378
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
379
- end
380
- end
381
-
382
- # unit tests for unarchive_class
383
- # Unarchive the class
384
- # 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.
385
- # @param _class Unique identifier of the class
386
- # @param [Hash] opts the optional parameters
387
- # @return [ClassDetails]
388
- describe 'unarchive_class test' do
389
- it 'should work' do
390
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
391
- end
392
- end
393
-
394
- # unit tests for update_class
395
- # Update the class
396
- # Update the meta information of the class
397
- # @param _class Unique identifier of the class
398
- # @param body Details of the Class
399
- # @param [Hash] opts the optional parameters
400
- # @return [ClassDetails]
401
- describe 'update_class test' do
402
- it 'should work' do
403
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
404
- end
405
- end
406
-
407
- # unit tests for update_submission_comment
408
- # Update a feedback comment to a submission
409
- # @param _class Unique identifier of the class
410
- # @param assignment Unique identifier of the assignment
411
- # @param submission Unique identifier of the submission
412
- # @param comment Unique identifier of the comment
413
- # @param assignment_submission_comment_creation
414
- # @param [Hash] opts the optional parameters
415
- # @return [AssignmentSubmissionComment]
416
- describe 'update_submission_comment test' do
417
- it 'should work' do
418
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
419
- end
420
- end
421
-
422
- end
@@ -1,158 +0,0 @@
1
- =begin
2
- #Flat API
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore 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 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
-
6
- The version of the OpenAPI document: 2.20.0
7
- Contact: developers@flat.io
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for FlatApi::CollectionApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'CollectionApi' do
20
- before do
21
- # run before each test
22
- @api_instance = FlatApi::CollectionApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of CollectionApi' do
30
- it 'should create an instance of CollectionApi' do
31
- expect(@api_instance).to be_instance_of(FlatApi::CollectionApi)
32
- end
33
- end
34
-
35
- # unit tests for add_score_to_collection
36
- # Add a score to the collection
37
- # This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability &#x60;canAddScores&#x60; on the provided &#x60;collection&#x60; to perform the action.
38
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
39
- # @param score 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;).
40
- # @param [Hash] opts the optional parameters
41
- # @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.
42
- # @return [ScoreDetails]
43
- describe 'add_score_to_collection test' do
44
- it 'should work' do
45
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
46
- end
47
- end
48
-
49
- # unit tests for create_collection
50
- # Create a new collection
51
- # This method will create a new collection and add it to your &#x60;root&#x60; collection.
52
- # @param body
53
- # @param [Hash] opts the optional parameters
54
- # @return [Collection]
55
- describe 'create_collection test' do
56
- it 'should work' do
57
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
58
- end
59
- end
60
-
61
- # unit tests for delete_collection
62
- # Delete the collection
63
- # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the &#x60;trash&#x60;.
64
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
65
- # @param [Hash] opts the optional parameters
66
- # @return [nil]
67
- describe 'delete_collection test' do
68
- it 'should work' do
69
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
70
- end
71
- end
72
-
73
- # unit tests for delete_score_from_collection
74
- # Delete a score from the collection
75
- # 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.
76
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
77
- # @param score 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;).
78
- # @param [Hash] opts the optional parameters
79
- # @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.
80
- # @return [nil]
81
- describe 'delete_score_from_collection test' do
82
- it 'should work' do
83
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
84
- end
85
- end
86
-
87
- # unit tests for edit_collection
88
- # Update a collection&#39;s metadata
89
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
90
- # @param body
91
- # @param [Hash] opts the optional parameters
92
- # @return [Collection]
93
- describe 'edit_collection test' do
94
- it 'should work' do
95
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
96
- end
97
- end
98
-
99
- # unit tests for get_collection
100
- # Get collection details
101
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
102
- # @param [Hash] opts the optional parameters
103
- # @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.
104
- # @return [Collection]
105
- describe 'get_collection test' do
106
- it 'should work' do
107
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
108
- end
109
- end
110
-
111
- # unit tests for list_collection_scores
112
- # List the scores contained in a collection
113
- # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by &#x60;modificationDate&#x60; &#x60;desc&#x60;. For example, to list the scores contained in your app collection, you can use &#x60;GET /v2/collections/app/scores&#x60;.
114
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
115
- # @param [Hash] opts the optional parameters
116
- # @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.
117
- # @option opts [String] :sort Sort
118
- # @option opts [String] :direction Sort direction
119
- # @option opts [Integer] :limit This is the maximum number of objects that may be returned
120
- # @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data.
121
- # @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data.
122
- # @return [Array<ScoreDetails>]
123
- describe 'list_collection_scores test' do
124
- it 'should work' do
125
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
126
- end
127
- end
128
-
129
- # unit tests for list_collections
130
- # List the collections
131
- # Use this method to list the user&#39;s collections contained in &#x60;parent&#x60; (by default in the &#x60;root&#x60; collection). If no sort option is provided, the collections are sorted by &#x60;creationDate&#x60; &#x60;desc&#x60;. Note that this method will not include the &#x60;parent&#x60; collection in the listing. For example, if you need the details of the &#x60;root&#x60; collection, you can use &#x60;GET /v2/collections/root&#x60;. To fetch your app collection details, you can use &#x60;GET /v2/collections/app&#x60;.
132
- # @param [Hash] opts the optional parameters
133
- # @option opts [String] :parent List the collection contained in this &#x60;parent&#x60; collection. This option doesn&#39;t provide a complete multi-level collection support. When sharing a collection with someone, this one will have as &#x60;parent&#x60; &#x60;sharedWithMe&#x60;.
134
- # @option opts [String] :sort Sort
135
- # @option opts [String] :direction Sort direction
136
- # @option opts [Integer] :limit This is the maximum number of objects that may be returned
137
- # @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data.
138
- # @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data.
139
- # @return [Array<Collection>]
140
- describe 'list_collections test' do
141
- it 'should work' do
142
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
143
- end
144
- end
145
-
146
- # unit tests for untrash_collection
147
- # Untrash a collection
148
- # This method will restore the collection by removing it from the &#x60;trash&#x60; and add it back to the &#x60;root&#x60; collection.
149
- # @param collection Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
150
- # @param [Hash] opts the optional parameters
151
- # @return [nil]
152
- describe 'untrash_collection test' do
153
- it 'should work' do
154
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
155
- end
156
- end
157
-
158
- end