flat_api 0.1.2 → 0.3.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (409) hide show
  1. checksums.yaml +5 -5
  2. data/lib/flat_api/api/account_api.rb +31 -21
  3. data/lib/flat_api/api/class_api.rb +1405 -405
  4. data/lib/flat_api/api/collection_api.rb +684 -0
  5. data/lib/flat_api/api/edu_resources_api.rb +851 -0
  6. data/lib/flat_api/api/group_api.rb +81 -55
  7. data/lib/flat_api/api/organization_api.rb +524 -180
  8. data/lib/flat_api/api/score_api.rb +1034 -570
  9. data/lib/flat_api/api/task_api.rb +85 -0
  10. data/lib/flat_api/api/user_api.rb +114 -76
  11. data/lib/flat_api/api_client.rb +112 -107
  12. data/lib/flat_api/api_error.rb +24 -4
  13. data/lib/flat_api/configuration.rb +105 -16
  14. data/lib/flat_api/models/api_access_token.rb +268 -0
  15. data/lib/flat_api/models/app_scopes.rb +59 -0
  16. data/lib/flat_api/models/assignment.rb +192 -101
  17. data/lib/flat_api/models/assignment_capabilities.rb +283 -0
  18. data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +240 -0
  19. data/lib/flat_api/models/assignment_copy.rb +80 -169
  20. data/lib/flat_api/models/assignment_copy_response.rb +430 -0
  21. data/lib/flat_api/models/assignment_copy_to_class.rb +243 -0
  22. data/lib/flat_api/models/assignment_copy_to_resource_library.rb +233 -0
  23. data/lib/flat_api/models/assignment_submission.rb +249 -66
  24. data/lib/flat_api/models/assignment_submission_comment.rb +276 -0
  25. data/lib/flat_api/models/assignment_submission_comment_creation.rb +223 -0
  26. data/lib/flat_api/models/assignment_submission_comments.rb +225 -0
  27. data/lib/flat_api/models/assignment_submission_history.rb +384 -0
  28. data/lib/flat_api/models/assignment_submission_history_attachment.rb +235 -0
  29. data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
  30. data/lib/flat_api/models/assignment_submission_lti.rb +222 -0
  31. data/lib/flat_api/models/assignment_submission_playback_inner.rb +240 -0
  32. data/lib/flat_api/models/assignment_submission_state.rb +42 -0
  33. data/lib/flat_api/models/assignment_submission_update.rb +150 -50
  34. data/lib/flat_api/models/assignment_type.rb +44 -0
  35. data/lib/flat_api/models/assignment_update.rb +407 -0
  36. data/lib/flat_api/models/class_assignment.rb +613 -0
  37. data/lib/flat_api/models/class_assignment_all_of_canvas.rb +226 -0
  38. data/lib/flat_api/models/class_assignment_all_of_lti.rb +216 -0
  39. data/lib/flat_api/models/class_assignment_all_of_mfc.rb +226 -0
  40. data/lib/flat_api/models/class_assignment_update.rb +509 -0
  41. data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +217 -0
  42. data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +219 -0
  43. data/lib/flat_api/models/class_attachment_creation.rb +110 -41
  44. data/lib/flat_api/models/class_creation.rb +144 -43
  45. data/lib/flat_api/models/class_details.rb +175 -60
  46. data/lib/flat_api/models/class_details_canvas.rb +61 -34
  47. data/lib/flat_api/models/class_details_clever.rb +76 -48
  48. data/lib/flat_api/models/class_details_google_classroom.rb +66 -59
  49. data/lib/flat_api/models/class_details_google_drive.rb +63 -36
  50. data/lib/flat_api/models/class_details_issues.rb +218 -0
  51. data/lib/flat_api/models/class_details_issues_sync_inner.rb +270 -0
  52. data/lib/flat_api/models/class_details_lti.rb +65 -38
  53. data/lib/flat_api/models/class_details_mfc.rb +226 -0
  54. data/lib/flat_api/models/class_details_microsoft_graph.rb +215 -0
  55. data/lib/flat_api/models/class_grade_level.rb +43 -0
  56. data/lib/flat_api/models/class_roles.rb +18 -9
  57. data/lib/flat_api/models/class_state.rb +18 -9
  58. data/lib/flat_api/models/class_update.rb +144 -42
  59. data/lib/flat_api/models/collection.rb +373 -0
  60. data/lib/flat_api/models/collection_app.rb +236 -0
  61. data/lib/flat_api/models/collection_capabilities.rb +291 -0
  62. data/lib/flat_api/models/collection_creation.rb +288 -0
  63. data/lib/flat_api/models/collection_modification.rb +275 -0
  64. data/lib/flat_api/models/collection_privacy.rb +39 -0
  65. data/lib/flat_api/models/collection_type.rb +44 -0
  66. data/lib/flat_api/models/edu_library.rb +292 -0
  67. data/lib/flat_api/models/edu_resource.rb +366 -0
  68. data/lib/flat_api/models/edu_resource_capabilities.rb +236 -0
  69. data/lib/flat_api/models/edu_resource_copy.rb +223 -0
  70. data/lib/flat_api/models/edu_resource_creation.rb +301 -0
  71. data/lib/flat_api/models/edu_resource_folder.rb +216 -0
  72. data/lib/flat_api/models/edu_resource_lti_link.rb +223 -0
  73. data/lib/flat_api/models/edu_resource_move.rb +223 -0
  74. data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
  75. data/lib/flat_api/models/edu_resource_resource.rb +105 -0
  76. data/lib/flat_api/models/edu_resource_type.rb +40 -0
  77. data/lib/flat_api/models/edu_resource_update.rb +277 -0
  78. data/lib/flat_api/models/edu_resource_use_in_class.rb +233 -0
  79. data/lib/flat_api/models/flat_error_response.rb +79 -38
  80. data/lib/flat_api/models/flat_locales.rb +30 -10
  81. data/lib/flat_api/models/google_classroom_coursework.rb +76 -38
  82. data/lib/flat_api/models/google_classroom_submission.rb +84 -36
  83. data/lib/flat_api/models/group.rb +72 -44
  84. data/lib/flat_api/models/group_details.rb +92 -43
  85. data/lib/flat_api/models/group_type.rb +18 -9
  86. data/lib/flat_api/models/license_mode.rb +18 -9
  87. data/lib/flat_api/models/license_sources.rb +21 -9
  88. data/lib/flat_api/models/lms_name.rb +19 -9
  89. data/lib/flat_api/models/lti_credentials.rb +95 -46
  90. data/lib/flat_api/models/lti_credentials_creation.rb +91 -38
  91. data/lib/flat_api/models/media_attachment.rb +167 -70
  92. data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
  93. data/lib/flat_api/models/microsoft_graph_assignment.rb +248 -0
  94. data/lib/flat_api/models/microsoft_graph_submission.rb +240 -0
  95. data/lib/flat_api/models/organization_invitation.rb +139 -44
  96. data/lib/flat_api/models/organization_invitation_creation.rb +99 -35
  97. data/lib/flat_api/models/organization_roles.rb +18 -9
  98. data/lib/flat_api/models/organization_user_access_token_creation.rb +225 -0
  99. data/lib/flat_api/models/resource_collaborator.rb +403 -0
  100. data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +85 -48
  101. data/lib/flat_api/models/resource_rights.rb +318 -0
  102. data/lib/flat_api/models/score_comment.rb +93 -56
  103. data/lib/flat_api/models/score_comment_context.rb +103 -59
  104. data/lib/flat_api/models/score_comment_creation.rb +70 -41
  105. data/lib/flat_api/models/score_comment_moderation.rb +260 -0
  106. data/lib/flat_api/models/score_comment_update.rb +82 -49
  107. data/lib/flat_api/models/score_comments_counts.rb +67 -40
  108. data/lib/flat_api/models/score_creation.rb +81 -215
  109. data/lib/flat_api/models/score_creation_builder_data.rb +298 -0
  110. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +230 -0
  111. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +322 -0
  112. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +274 -0
  113. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +269 -0
  114. data/lib/flat_api/models/score_creation_common.rb +268 -0
  115. data/lib/flat_api/models/score_creation_file_import.rb +324 -0
  116. data/lib/flat_api/models/score_creation_google_drive_import.rb +291 -0
  117. data/lib/flat_api/models/score_creation_type.rb +19 -9
  118. data/lib/flat_api/models/score_details.rb +274 -83
  119. data/lib/flat_api/models/score_fork.rb +94 -32
  120. data/lib/flat_api/models/score_license.rb +19 -9
  121. data/lib/flat_api/models/score_likes_counts.rb +83 -35
  122. data/lib/flat_api/models/score_modification.rb +175 -52
  123. data/lib/flat_api/models/score_plays_counts.rb +236 -0
  124. data/lib/flat_api/models/score_privacy.rb +18 -9
  125. data/lib/flat_api/models/score_revision.rb +80 -43
  126. data/lib/flat_api/models/score_revision_creation.rb +105 -40
  127. data/lib/flat_api/models/score_revision_statistics.rb +83 -36
  128. data/lib/flat_api/models/score_source.rb +61 -35
  129. data/lib/flat_api/models/score_summary.rb +124 -40
  130. data/lib/flat_api/models/score_track.rb +172 -51
  131. data/lib/flat_api/models/score_track_creation.rb +101 -39
  132. data/lib/flat_api/models/score_track_point.rb +70 -38
  133. data/lib/flat_api/models/score_track_purpose.rb +40 -0
  134. data/lib/flat_api/models/score_track_state.rb +18 -9
  135. data/lib/flat_api/models/score_track_type.rb +18 -9
  136. data/lib/flat_api/models/score_track_update.rb +88 -37
  137. data/lib/flat_api/models/score_views_counts.rb +62 -35
  138. data/lib/flat_api/models/task.rb +364 -0
  139. data/lib/flat_api/models/task_export_options.rb +218 -0
  140. data/lib/flat_api/models/task_progress.rb +226 -0
  141. data/lib/flat_api/models/task_result.rb +226 -0
  142. data/lib/flat_api/models/tutteo_product.rb +42 -0
  143. data/lib/flat_api/models/user_admin_update.rb +219 -41
  144. data/lib/flat_api/models/user_azure_details.rb +235 -0
  145. data/lib/flat_api/models/user_basics.rb +187 -55
  146. data/lib/flat_api/models/user_community_profile_links.rb +272 -0
  147. data/lib/flat_api/models/user_creation.rb +215 -49
  148. data/lib/flat_api/models/user_details.rb +258 -93
  149. data/lib/flat_api/models/user_details_admin.rb +220 -68
  150. data/lib/flat_api/models/user_details_admin_all_of_license.rb +278 -0
  151. data/lib/flat_api/models/user_public.rb +242 -79
  152. data/lib/flat_api/models/user_public_summary.rb +201 -61
  153. data/lib/flat_api/models/user_signin_link.rb +225 -0
  154. data/lib/flat_api/models/user_signin_link_creation.rb +217 -0
  155. data/lib/flat_api/version.rb +5 -5
  156. data/lib/flat_api.rb +87 -15
  157. data/spec/api/account_api_spec.rb +11 -10
  158. data/spec/api/class_api_spec.rb +212 -68
  159. data/spec/api/collection_api_spec.rb +158 -0
  160. data/spec/api/edu_resources_api_spec.rb +181 -0
  161. data/spec/api/group_api_spec.rb +14 -15
  162. data/spec/api/organization_api_spec.rb +78 -39
  163. data/spec/api/score_api_spec.rb +139 -110
  164. data/spec/api/task_api_spec.rb +47 -0
  165. data/spec/api/user_api_spec.rb +28 -26
  166. data/spec/models/api_access_token_spec.rb +66 -0
  167. data/spec/models/app_scopes_spec.rb +30 -0
  168. data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +42 -0
  169. data/spec/models/assignment_capabilities_spec.rb +60 -0
  170. data/spec/models/assignment_copy_response_spec.rb +124 -0
  171. data/spec/models/assignment_copy_spec.rb +13 -23
  172. data/spec/models/assignment_copy_to_class_spec.rb +48 -0
  173. data/spec/models/assignment_copy_to_resource_library_spec.rb +42 -0
  174. data/spec/models/assignment_spec.rb +51 -39
  175. data/spec/models/assignment_submission_comment_creation_spec.rb +36 -0
  176. data/spec/models/assignment_submission_comment_spec.rb +72 -0
  177. data/spec/models/assignment_submission_comments_spec.rb +42 -0
  178. data/spec/models/assignment_submission_history_attachment_spec.rb +48 -0
  179. data/spec/models/assignment_submission_history_spec.rb +112 -0
  180. data/spec/models/assignment_submission_history_state_spec.rb +30 -0
  181. data/spec/models/assignment_submission_lti_spec.rb +36 -0
  182. data/spec/models/assignment_submission_playback_inner_spec.rb +42 -0
  183. data/spec/models/assignment_submission_spec.rb +68 -32
  184. data/spec/models/assignment_submission_state_spec.rb +30 -0
  185. data/spec/models/assignment_submission_update_spec.rb +29 -23
  186. data/spec/models/assignment_type_spec.rb +30 -0
  187. data/spec/models/assignment_update_spec.rb +100 -0
  188. data/spec/models/class_assignment_all_of_canvas_spec.rb +42 -0
  189. data/spec/models/class_assignment_all_of_lti_spec.rb +36 -0
  190. data/spec/models/class_assignment_all_of_mfc_spec.rb +42 -0
  191. data/spec/models/class_assignment_spec.rb +216 -0
  192. data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +36 -0
  193. data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +36 -0
  194. data/spec/models/class_assignment_update_spec.rb +150 -0
  195. data/spec/models/class_attachment_creation_spec.rb +41 -23
  196. data/spec/models/class_creation_spec.rb +34 -18
  197. data/spec/models/class_details_canvas_spec.rb +12 -18
  198. data/spec/models/class_details_clever_spec.rb +21 -27
  199. data/spec/models/class_details_google_classroom_spec.rb +12 -30
  200. data/spec/models/class_details_google_drive_spec.rb +12 -18
  201. data/spec/models/class_details_issues_spec.rb +36 -0
  202. data/spec/models/class_details_issues_sync_inner_spec.rb +52 -0
  203. data/spec/models/class_details_lti_spec.rb +13 -19
  204. data/spec/models/class_details_mfc_spec.rb +42 -0
  205. data/spec/models/class_details_microsoft_graph_spec.rb +36 -0
  206. data/spec/models/class_details_spec.rb +68 -34
  207. data/spec/models/class_grade_level_spec.rb +30 -0
  208. data/spec/models/class_roles_spec.rb +10 -16
  209. data/spec/models/class_state_spec.rb +10 -16
  210. data/spec/models/class_update_spec.rb +34 -18
  211. data/spec/models/collection_app_spec.rb +48 -0
  212. data/spec/models/collection_capabilities_spec.rb +60 -0
  213. data/spec/models/collection_creation_spec.rb +42 -0
  214. data/spec/models/collection_modification_spec.rb +42 -0
  215. data/spec/models/collection_privacy_spec.rb +30 -0
  216. data/spec/models/collection_spec.rb +114 -0
  217. data/spec/models/collection_type_spec.rb +30 -0
  218. data/spec/models/edu_library_spec.rb +62 -0
  219. data/spec/models/edu_resource_capabilities_spec.rb +48 -0
  220. data/spec/models/edu_resource_copy_spec.rb +36 -0
  221. data/spec/models/edu_resource_creation_spec.rb +48 -0
  222. data/spec/models/edu_resource_folder_spec.rb +36 -0
  223. data/spec/models/edu_resource_lti_link_spec.rb +36 -0
  224. data/spec/models/edu_resource_move_spec.rb +36 -0
  225. data/spec/models/edu_resource_privacy_spec.rb +30 -0
  226. data/spec/models/edu_resource_resource_spec.rb +32 -0
  227. data/spec/models/edu_resource_spec.rb +96 -0
  228. data/spec/models/edu_resource_type_spec.rb +30 -0
  229. data/spec/models/edu_resource_update_spec.rb +42 -0
  230. data/spec/models/edu_resource_use_in_class_spec.rb +42 -0
  231. data/spec/models/flat_error_response_spec.rb +14 -20
  232. data/spec/models/flat_locales_spec.rb +10 -16
  233. data/spec/models/google_classroom_coursework_spec.rb +19 -19
  234. data/spec/models/google_classroom_submission_spec.rb +13 -19
  235. data/spec/models/group_details_spec.rb +17 -23
  236. data/spec/models/group_spec.rb +21 -27
  237. data/spec/models/group_type_spec.rb +10 -16
  238. data/spec/models/license_mode_spec.rb +10 -16
  239. data/spec/models/license_sources_spec.rb +10 -16
  240. data/spec/models/lms_name_spec.rb +10 -16
  241. data/spec/models/lti_credentials_creation_spec.rb +12 -18
  242. data/spec/models/lti_credentials_spec.rb +19 -25
  243. data/spec/models/media_attachment_spec.rb +67 -37
  244. data/spec/models/media_score_sharing_mode_spec.rb +10 -16
  245. data/spec/models/microsoft_graph_assignment_spec.rb +54 -0
  246. data/spec/models/microsoft_graph_submission_spec.rb +42 -0
  247. data/spec/models/organization_invitation_creation_spec.rb +16 -18
  248. data/spec/models/organization_invitation_spec.rb +29 -23
  249. data/spec/models/organization_roles_spec.rb +10 -16
  250. data/spec/models/organization_user_access_token_creation_spec.rb +36 -0
  251. data/spec/models/resource_collaborator_creation_spec.rb +72 -0
  252. data/spec/models/resource_collaborator_spec.rb +112 -0
  253. data/spec/models/resource_rights_spec.rb +64 -0
  254. data/spec/models/score_comment_context_spec.rb +23 -23
  255. data/spec/models/score_comment_creation_spec.rb +16 -22
  256. data/spec/models/score_comment_moderation_spec.rb +46 -0
  257. data/spec/models/score_comment_spec.rb +35 -35
  258. data/spec/models/score_comment_update_spec.rb +14 -20
  259. data/spec/models/score_comments_counts_spec.rb +14 -20
  260. data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +82 -0
  261. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +60 -0
  262. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +66 -0
  263. data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +42 -0
  264. data/spec/models/score_creation_builder_data_spec.rb +60 -0
  265. data/spec/models/score_creation_common_spec.rb +54 -0
  266. data/spec/models/score_creation_file_import_spec.rb +76 -0
  267. data/spec/models/score_creation_google_drive_import_spec.rb +60 -0
  268. data/spec/models/score_creation_spec.rb +12 -52
  269. data/spec/models/score_creation_type_spec.rb +10 -16
  270. data/spec/models/score_details_spec.rb +75 -45
  271. data/spec/models/score_fork_spec.rb +27 -15
  272. data/spec/models/score_license_spec.rb +10 -16
  273. data/spec/models/score_likes_counts_spec.rb +13 -19
  274. data/spec/models/score_modification_spec.rb +51 -21
  275. data/spec/models/score_plays_counts_spec.rb +48 -0
  276. data/spec/models/score_privacy_spec.rb +10 -16
  277. data/spec/models/score_revision_creation_spec.rb +18 -20
  278. data/spec/models/score_revision_spec.rb +23 -23
  279. data/spec/models/score_revision_statistics_spec.rb +24 -18
  280. data/spec/models/score_source_spec.rb +11 -17
  281. data/spec/models/score_summary_spec.rb +16 -22
  282. data/spec/models/score_track_creation_spec.rb +21 -21
  283. data/spec/models/score_track_point_spec.rb +17 -23
  284. data/spec/models/score_track_purpose_spec.rb +30 -0
  285. data/spec/models/score_track_spec.rb +28 -28
  286. data/spec/models/score_track_state_spec.rb +10 -16
  287. data/spec/models/score_track_type_spec.rb +10 -16
  288. data/spec/models/score_track_update_spec.rb +14 -20
  289. data/spec/models/score_views_counts_spec.rb +13 -19
  290. data/spec/models/task_export_options_spec.rb +36 -0
  291. data/spec/models/task_progress_spec.rb +42 -0
  292. data/spec/models/task_result_spec.rb +42 -0
  293. data/spec/models/task_spec.rb +100 -0
  294. data/spec/models/tutteo_product_spec.rb +30 -0
  295. data/spec/models/user_admin_update_spec.rb +36 -18
  296. data/spec/models/user_azure_details_spec.rb +48 -0
  297. data/spec/models/user_basics_spec.rb +47 -25
  298. data/spec/models/user_community_profile_links_spec.rb +66 -0
  299. data/spec/models/user_creation_spec.rb +36 -20
  300. data/spec/models/user_details_admin_all_of_license_spec.rb +60 -0
  301. data/spec/models/user_details_admin_spec.rb +60 -32
  302. data/spec/models/user_details_spec.rb +93 -45
  303. data/spec/models/user_public_spec.rb +71 -37
  304. data/spec/models/user_public_summary_spec.rb +51 -29
  305. data/spec/models/user_signin_link_creation_spec.rb +36 -0
  306. data/spec/models/user_signin_link_spec.rb +42 -0
  307. data/spec/spec_helper.rb +4 -4
  308. metadata +299 -312
  309. data/CHANGELOG.md +0 -13
  310. data/Gemfile +0 -7
  311. data/README.md +0 -249
  312. data/Rakefile +0 -8
  313. data/docs/AccountApi.md +0 -55
  314. data/docs/Assignment.md +0 -18
  315. data/docs/AssignmentCopy.md +0 -8
  316. data/docs/AssignmentCreation.md +0 -12
  317. data/docs/AssignmentSubmission.md +0 -19
  318. data/docs/AssignmentSubmissionUpdate.md +0 -11
  319. data/docs/ClassApi.md +0 -1051
  320. data/docs/ClassAttachmentCreation.md +0 -10
  321. data/docs/ClassCreation.md +0 -9
  322. data/docs/ClassDetails.md +0 -25
  323. data/docs/ClassDetailsCanvas.md +0 -9
  324. data/docs/ClassDetailsClever.md +0 -14
  325. data/docs/ClassDetailsGoogleClassroom.md +0 -11
  326. data/docs/ClassDetailsGoogleDrive.md +0 -9
  327. data/docs/ClassDetailsLti.md +0 -10
  328. data/docs/ClassRoles.md +0 -7
  329. data/docs/ClassState.md +0 -7
  330. data/docs/ClassUpdate.md +0 -9
  331. data/docs/FlatErrorResponse.md +0 -11
  332. data/docs/FlatLocales.md +0 -7
  333. data/docs/GoogleClassroomCoursework.md +0 -10
  334. data/docs/GoogleClassroomSubmission.md +0 -10
  335. data/docs/Group.md +0 -14
  336. data/docs/GroupApi.md +0 -167
  337. data/docs/GroupDetails.md +0 -14
  338. data/docs/GroupType.md +0 -7
  339. data/docs/LicenseMode.md +0 -7
  340. data/docs/LicenseSources.md +0 -7
  341. data/docs/LmsName.md +0 -7
  342. data/docs/LtiCredentials.md +0 -16
  343. data/docs/LtiCredentialsCreation.md +0 -9
  344. data/docs/MediaAttachment.md +0 -23
  345. data/docs/MediaScoreSharingMode.md +0 -7
  346. data/docs/OrganizationApi.md +0 -538
  347. data/docs/OrganizationInvitation.md +0 -14
  348. data/docs/OrganizationInvitationCreation.md +0 -9
  349. data/docs/OrganizationRoles.md +0 -7
  350. data/docs/ScoreApi.md +0 -1605
  351. data/docs/ScoreCollaborator.md +0 -15
  352. data/docs/ScoreCollaboratorCreation.md +0 -13
  353. data/docs/ScoreComment.md +0 -22
  354. data/docs/ScoreCommentContext.md +0 -14
  355. data/docs/ScoreCommentCreation.md +0 -13
  356. data/docs/ScoreCommentUpdate.md +0 -11
  357. data/docs/ScoreCommentsCounts.md +0 -11
  358. data/docs/ScoreCreation.md +0 -13
  359. data/docs/ScoreCreationType.md +0 -7
  360. data/docs/ScoreData.md +0 -7
  361. data/docs/ScoreDataEncoding.md +0 -7
  362. data/docs/ScoreDetails.md +0 -36
  363. data/docs/ScoreFork.md +0 -7
  364. data/docs/ScoreLicense.md +0 -7
  365. data/docs/ScoreLikesCounts.md +0 -10
  366. data/docs/ScoreModification.md +0 -13
  367. data/docs/ScorePrivacy.md +0 -7
  368. data/docs/ScoreRevision.md +0 -14
  369. data/docs/ScoreRevisionCreation.md +0 -11
  370. data/docs/ScoreRevisionStatistics.md +0 -9
  371. data/docs/ScoreRights.md +0 -10
  372. data/docs/ScoreSource.md +0 -8
  373. data/docs/ScoreSummary.md +0 -13
  374. data/docs/ScoreTrack.md +0 -19
  375. data/docs/ScoreTrackCreation.md +0 -12
  376. data/docs/ScoreTrackPoint.md +0 -10
  377. data/docs/ScoreTrackState.md +0 -7
  378. data/docs/ScoreTrackType.md +0 -7
  379. data/docs/ScoreTrackUpdate.md +0 -11
  380. data/docs/ScoreViewsCounts.md +0 -10
  381. data/docs/UserAdminUpdate.md +0 -9
  382. data/docs/UserApi.md +0 -173
  383. data/docs/UserBasics.md +0 -13
  384. data/docs/UserCreation.md +0 -11
  385. data/docs/UserDetails.md +0 -28
  386. data/docs/UserDetailsAdmin.md +0 -20
  387. data/docs/UserDetailsAdminLicense.md +0 -12
  388. data/docs/UserInstruments.md +0 -7
  389. data/docs/UserPublic.md +0 -25
  390. data/docs/UserPublicSummary.md +0 -17
  391. data/flat_api.gemspec +0 -48
  392. data/git_push.sh +0 -55
  393. data/lib/flat_api/models/assignment_creation.rb +0 -230
  394. data/lib/flat_api/models/score_collaborator.rb +0 -263
  395. data/lib/flat_api/models/score_data.rb +0 -179
  396. data/lib/flat_api/models/score_data_encoding.rb +0 -30
  397. data/lib/flat_api/models/score_rights.rb +0 -215
  398. data/lib/flat_api/models/user_details_admin_license.rb +0 -227
  399. data/lib/flat_api/models/user_instruments.rb +0 -179
  400. data/spec/api_client_spec.rb +0 -226
  401. data/spec/configuration_spec.rb +0 -42
  402. data/spec/models/assignment_creation_spec.rb +0 -66
  403. data/spec/models/score_collaborator_creation_spec.rb +0 -72
  404. data/spec/models/score_collaborator_spec.rb +0 -84
  405. data/spec/models/score_data_encoding_spec.rb +0 -36
  406. data/spec/models/score_data_spec.rb +0 -36
  407. data/spec/models/score_rights_spec.rb +0 -48
  408. data/spec/models/user_details_admin_license_spec.rb +0 -66
  409. data/spec/models/user_instruments_spec.rb +0 -36
@@ -0,0 +1,851 @@
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 'cgi'
14
+
15
+ module FlatApi
16
+ class EduResourcesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Copy an education resource to a Resource Library
23
+ # @param resource [String] Unique identifier of the resource
24
+ # @param edu_resource_copy [EduResourceCopy]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [EduResource]
27
+ def copy_edu_resource(resource, edu_resource_copy, opts = {})
28
+ data, _status_code, _headers = copy_edu_resource_with_http_info(resource, edu_resource_copy, opts)
29
+ data
30
+ end
31
+
32
+ # Copy an education resource to a Resource Library
33
+ # @param resource [String] Unique identifier of the resource
34
+ # @param edu_resource_copy [EduResourceCopy]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(EduResource, Integer, Hash)>] EduResource data, response status code and response headers
37
+ def copy_edu_resource_with_http_info(resource, edu_resource_copy, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.copy_edu_resource ...'
40
+ end
41
+ # verify the required parameter 'resource' is set
42
+ if @api_client.config.client_side_validation && resource.nil?
43
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.copy_edu_resource"
44
+ end
45
+ # verify the required parameter 'edu_resource_copy' is set
46
+ if @api_client.config.client_side_validation && edu_resource_copy.nil?
47
+ fail ArgumentError, "Missing the required parameter 'edu_resource_copy' when calling EduResourcesApi.copy_edu_resource"
48
+ end
49
+ # resource path
50
+ local_var_path = '/eduResources/{resource}/copy'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
59
+ # HTTP header 'Content-Type'
60
+ content_type = @api_client.select_header_content_type(['application/json'])
61
+ if !content_type.nil?
62
+ header_params['Content-Type'] = content_type
63
+ end
64
+
65
+ # form parameters
66
+ form_params = opts[:form_params] || {}
67
+
68
+ # http body (model)
69
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(edu_resource_copy)
70
+
71
+ # return_type
72
+ return_type = opts[:debug_return_type] || 'EduResource'
73
+
74
+ # auth_names
75
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
76
+
77
+ new_options = opts.merge(
78
+ :operation => :"EduResourcesApi.copy_edu_resource",
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => return_type
85
+ )
86
+
87
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: EduResourcesApi#copy_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
93
+
94
+ # Copy an education assignment to a teacher demo class
95
+ # Once a resource library can be published to a class (`Assignment.capabilities.canPublishInClass = true`), this endpoint can be used for the feature \"View as student\". It will ensure the teacher has a demo class, then copy the assignment to the demo class. You can then use `POST /classes/{class}/testStudent` to create a testing student account in the demo class.
96
+ # @param resource [String] Unique identifier of the resource
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [ClassAssignment]
99
+ def copy_edu_resource_to_demo_class(resource, opts = {})
100
+ data, _status_code, _headers = copy_edu_resource_to_demo_class_with_http_info(resource, opts)
101
+ data
102
+ end
103
+
104
+ # Copy an education assignment to a teacher demo class
105
+ # Once a resource library can be published to a class (&#x60;Assignment.capabilities.canPublishInClass &#x3D; true&#x60;), this endpoint can be used for the feature \&quot;View as student\&quot;. It will ensure the teacher has a demo class, then copy the assignment to the demo class. You can then use &#x60;POST /classes/{class}/testStudent&#x60; to create a testing student account in the demo class.
106
+ # @param resource [String] Unique identifier of the resource
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [Array<(ClassAssignment, Integer, Hash)>] ClassAssignment data, response status code and response headers
109
+ def copy_edu_resource_to_demo_class_with_http_info(resource, opts = {})
110
+ if @api_client.config.debugging
111
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.copy_edu_resource_to_demo_class ...'
112
+ end
113
+ # verify the required parameter 'resource' is set
114
+ if @api_client.config.client_side_validation && resource.nil?
115
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.copy_edu_resource_to_demo_class"
116
+ end
117
+ # resource path
118
+ local_var_path = '/eduResources/{resource}/copyToDemoClass'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
119
+
120
+ # query parameters
121
+ query_params = opts[:query_params] || {}
122
+
123
+ # header parameters
124
+ header_params = opts[:header_params] || {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:debug_body]
133
+
134
+ # return_type
135
+ return_type = opts[:debug_return_type] || 'ClassAssignment'
136
+
137
+ # auth_names
138
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
139
+
140
+ new_options = opts.merge(
141
+ :operation => :"EduResourcesApi.copy_edu_resource_to_demo_class",
142
+ :header_params => header_params,
143
+ :query_params => query_params,
144
+ :form_params => form_params,
145
+ :body => post_body,
146
+ :auth_names => auth_names,
147
+ :return_type => return_type
148
+ )
149
+
150
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "API called: EduResourcesApi#copy_edu_resource_to_demo_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
+ end
154
+ return data, status_code, headers
155
+ end
156
+
157
+ # Create a new education resource
158
+ # @param edu_resource_creation [EduResourceCreation]
159
+ # @param [Hash] opts the optional parameters
160
+ # @return [EduResource]
161
+ def create_edu_resource(edu_resource_creation, opts = {})
162
+ data, _status_code, _headers = create_edu_resource_with_http_info(edu_resource_creation, opts)
163
+ data
164
+ end
165
+
166
+ # Create a new education resource
167
+ # @param edu_resource_creation [EduResourceCreation]
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [Array<(EduResource, Integer, Hash)>] EduResource data, response status code and response headers
170
+ def create_edu_resource_with_http_info(edu_resource_creation, opts = {})
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.create_edu_resource ...'
173
+ end
174
+ # verify the required parameter 'edu_resource_creation' is set
175
+ if @api_client.config.client_side_validation && edu_resource_creation.nil?
176
+ fail ArgumentError, "Missing the required parameter 'edu_resource_creation' when calling EduResourcesApi.create_edu_resource"
177
+ end
178
+ # resource path
179
+ local_var_path = '/eduResources'
180
+
181
+ # query parameters
182
+ query_params = opts[:query_params] || {}
183
+
184
+ # header parameters
185
+ header_params = opts[:header_params] || {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
188
+ # HTTP header 'Content-Type'
189
+ content_type = @api_client.select_header_content_type(['application/json'])
190
+ if !content_type.nil?
191
+ header_params['Content-Type'] = content_type
192
+ end
193
+
194
+ # form parameters
195
+ form_params = opts[:form_params] || {}
196
+
197
+ # http body (model)
198
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(edu_resource_creation)
199
+
200
+ # return_type
201
+ return_type = opts[:debug_return_type] || 'EduResource'
202
+
203
+ # auth_names
204
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
205
+
206
+ new_options = opts.merge(
207
+ :operation => :"EduResourcesApi.create_edu_resource",
208
+ :header_params => header_params,
209
+ :query_params => query_params,
210
+ :form_params => form_params,
211
+ :body => post_body,
212
+ :auth_names => auth_names,
213
+ :return_type => return_type
214
+ )
215
+
216
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "API called: EduResourcesApi#create_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
+ end
220
+ return data, status_code, headers
221
+ end
222
+
223
+ # Create an LTI link for an education resource
224
+ # This endpoint will return an LTI link that can be used to launch Flat for Education. The link, in a context from a class, will ensure the assignment has been copied in the class.
225
+ # @param resource [String] Unique identifier of the resource
226
+ # @param [Hash] opts the optional parameters
227
+ # @return [EduResourceLtiLink]
228
+ def create_edu_resource_lti_link(resource, opts = {})
229
+ data, _status_code, _headers = create_edu_resource_lti_link_with_http_info(resource, opts)
230
+ data
231
+ end
232
+
233
+ # Create an LTI link for an education resource
234
+ # This endpoint will return an LTI link that can be used to launch Flat for Education. The link, in a context from a class, will ensure the assignment has been copied in the class.
235
+ # @param resource [String] Unique identifier of the resource
236
+ # @param [Hash] opts the optional parameters
237
+ # @return [Array<(EduResourceLtiLink, Integer, Hash)>] EduResourceLtiLink data, response status code and response headers
238
+ def create_edu_resource_lti_link_with_http_info(resource, opts = {})
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.create_edu_resource_lti_link ...'
241
+ end
242
+ # verify the required parameter 'resource' is set
243
+ if @api_client.config.client_side_validation && resource.nil?
244
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.create_edu_resource_lti_link"
245
+ end
246
+ # resource path
247
+ local_var_path = '/eduResources/{resource}/createLtiLink'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
248
+
249
+ # query parameters
250
+ query_params = opts[:query_params] || {}
251
+
252
+ # header parameters
253
+ header_params = opts[:header_params] || {}
254
+ # HTTP header 'Accept' (if needed)
255
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
256
+
257
+ # form parameters
258
+ form_params = opts[:form_params] || {}
259
+
260
+ # http body (model)
261
+ post_body = opts[:debug_body]
262
+
263
+ # return_type
264
+ return_type = opts[:debug_return_type] || 'EduResourceLtiLink'
265
+
266
+ # auth_names
267
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
268
+
269
+ new_options = opts.merge(
270
+ :operation => :"EduResourcesApi.create_edu_resource_lti_link",
271
+ :header_params => header_params,
272
+ :query_params => query_params,
273
+ :form_params => form_params,
274
+ :body => post_body,
275
+ :auth_names => auth_names,
276
+ :return_type => return_type
277
+ )
278
+
279
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
280
+ if @api_client.config.debugging
281
+ @api_client.config.logger.debug "API called: EduResourcesApi#create_edu_resource_lti_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
282
+ end
283
+ return data, status_code, headers
284
+ end
285
+
286
+ # Delete an education resource
287
+ # @param resource [String] Unique identifier of the resource
288
+ # @param [Hash] opts the optional parameters
289
+ # @return [nil]
290
+ def delete_edu_resource(resource, opts = {})
291
+ delete_edu_resource_with_http_info(resource, opts)
292
+ nil
293
+ end
294
+
295
+ # Delete an education resource
296
+ # @param resource [String] Unique identifier of the resource
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
299
+ def delete_edu_resource_with_http_info(resource, opts = {})
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.delete_edu_resource ...'
302
+ end
303
+ # verify the required parameter 'resource' is set
304
+ if @api_client.config.client_side_validation && resource.nil?
305
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.delete_edu_resource"
306
+ end
307
+ # resource path
308
+ local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
309
+
310
+ # query parameters
311
+ query_params = opts[:query_params] || {}
312
+
313
+ # header parameters
314
+ header_params = opts[:header_params] || {}
315
+ # HTTP header 'Accept' (if needed)
316
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
317
+
318
+ # form parameters
319
+ form_params = opts[:form_params] || {}
320
+
321
+ # http body (model)
322
+ post_body = opts[:debug_body]
323
+
324
+ # return_type
325
+ return_type = opts[:debug_return_type]
326
+
327
+ # auth_names
328
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
329
+
330
+ new_options = opts.merge(
331
+ :operation => :"EduResourcesApi.delete_edu_resource",
332
+ :header_params => header_params,
333
+ :query_params => query_params,
334
+ :form_params => form_params,
335
+ :body => post_body,
336
+ :auth_names => auth_names,
337
+ :return_type => return_type
338
+ )
339
+
340
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
341
+ if @api_client.config.debugging
342
+ @api_client.config.logger.debug "API called: EduResourcesApi#delete_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
+ end
344
+ return data, status_code, headers
345
+ end
346
+
347
+ # Get an education resource
348
+ # @param resource [String] Unique identifier of the resource
349
+ # @param [Hash] opts the optional parameters
350
+ # @return [EduResource]
351
+ def get_edu_resource(resource, opts = {})
352
+ data, _status_code, _headers = get_edu_resource_with_http_info(resource, opts)
353
+ data
354
+ end
355
+
356
+ # Get an education resource
357
+ # @param resource [String] Unique identifier of the resource
358
+ # @param [Hash] opts the optional parameters
359
+ # @return [Array<(EduResource, Integer, Hash)>] EduResource data, response status code and response headers
360
+ def get_edu_resource_with_http_info(resource, opts = {})
361
+ if @api_client.config.debugging
362
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.get_edu_resource ...'
363
+ end
364
+ # verify the required parameter 'resource' is set
365
+ if @api_client.config.client_side_validation && resource.nil?
366
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.get_edu_resource"
367
+ end
368
+ # resource path
369
+ local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
370
+
371
+ # query parameters
372
+ query_params = opts[:query_params] || {}
373
+
374
+ # header parameters
375
+ header_params = opts[:header_params] || {}
376
+ # HTTP header 'Accept' (if needed)
377
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
378
+
379
+ # form parameters
380
+ form_params = opts[:form_params] || {}
381
+
382
+ # http body (model)
383
+ post_body = opts[:debug_body]
384
+
385
+ # return_type
386
+ return_type = opts[:debug_return_type] || 'EduResource'
387
+
388
+ # auth_names
389
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
390
+
391
+ new_options = opts.merge(
392
+ :operation => :"EduResourcesApi.get_edu_resource",
393
+ :header_params => header_params,
394
+ :query_params => query_params,
395
+ :form_params => form_params,
396
+ :body => post_body,
397
+ :auth_names => auth_names,
398
+ :return_type => return_type
399
+ )
400
+
401
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
402
+ if @api_client.config.debugging
403
+ @api_client.config.logger.debug "API called: EduResourcesApi#get_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
404
+ end
405
+ return data, status_code, headers
406
+ end
407
+
408
+ # List the education libraries
409
+ # @param [Hash] opts the optional parameters
410
+ # @return [Array<EduLibrary>]
411
+ def list_edu_libraries(opts = {})
412
+ data, _status_code, _headers = list_edu_libraries_with_http_info(opts)
413
+ data
414
+ end
415
+
416
+ # List the education libraries
417
+ # @param [Hash] opts the optional parameters
418
+ # @return [Array<(Array<EduLibrary>, Integer, Hash)>] Array<EduLibrary> data, response status code and response headers
419
+ def list_edu_libraries_with_http_info(opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.list_edu_libraries ...'
422
+ end
423
+ # resource path
424
+ local_var_path = '/eduResources/libraries'
425
+
426
+ # query parameters
427
+ query_params = opts[:query_params] || {}
428
+
429
+ # header parameters
430
+ header_params = opts[:header_params] || {}
431
+ # HTTP header 'Accept' (if needed)
432
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
433
+
434
+ # form parameters
435
+ form_params = opts[:form_params] || {}
436
+
437
+ # http body (model)
438
+ post_body = opts[:debug_body]
439
+
440
+ # return_type
441
+ return_type = opts[:debug_return_type] || 'Array<EduLibrary>'
442
+
443
+ # auth_names
444
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
445
+
446
+ new_options = opts.merge(
447
+ :operation => :"EduResourcesApi.list_edu_libraries",
448
+ :header_params => header_params,
449
+ :query_params => query_params,
450
+ :form_params => form_params,
451
+ :body => post_body,
452
+ :auth_names => auth_names,
453
+ :return_type => return_type
454
+ )
455
+
456
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "API called: EduResourcesApi#list_edu_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
459
+ end
460
+ return data, status_code, headers
461
+ end
462
+
463
+ # List education resources in a library or folder
464
+ # @param [Hash] opts the optional parameters
465
+ # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder (default to 'root')
466
+ # @option opts [String] :type Filter the returned resources by type
467
+ # @option opts [String] :sort Sort (default to 'creationDate')
468
+ # @option opts [String] :direction Sort direction
469
+ # @option opts [Integer] :limit This is the maximum number of resources that may be returned (default to 25)
470
+ # @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.
471
+ # @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.
472
+ # @return [Array<EduResource>]
473
+ def list_edu_resources(opts = {})
474
+ data, _status_code, _headers = list_edu_resources_with_http_info(opts)
475
+ data
476
+ end
477
+
478
+ # List education resources in a library or folder
479
+ # @param [Hash] opts the optional parameters
480
+ # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder (default to 'root')
481
+ # @option opts [String] :type Filter the returned resources by type
482
+ # @option opts [String] :sort Sort (default to 'creationDate')
483
+ # @option opts [String] :direction Sort direction
484
+ # @option opts [Integer] :limit This is the maximum number of resources that may be returned (default to 25)
485
+ # @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.
486
+ # @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.
487
+ # @return [Array<(Array<EduResource>, Integer, Hash)>] Array<EduResource> data, response status code and response headers
488
+ def list_edu_resources_with_http_info(opts = {})
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.list_edu_resources ...'
491
+ end
492
+ allowable_values = ["assignment", "folder"]
493
+ if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
494
+ fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
495
+ end
496
+ allowable_values = ["creationDate", "updateDate", "title"]
497
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
498
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
499
+ end
500
+ allowable_values = ["asc", "desc"]
501
+ if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
502
+ fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
503
+ end
504
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
505
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EduResourcesApi.list_edu_resources, must be smaller than or equal to 100.'
506
+ end
507
+
508
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
509
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EduResourcesApi.list_edu_resources, must be greater than or equal to 1.'
510
+ end
511
+
512
+ # resource path
513
+ local_var_path = '/eduResources'
514
+
515
+ # query parameters
516
+ query_params = opts[:query_params] || {}
517
+ query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
518
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
519
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
520
+ query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
521
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
522
+ query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
523
+ query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
524
+
525
+ # header parameters
526
+ header_params = opts[:header_params] || {}
527
+ # HTTP header 'Accept' (if needed)
528
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
529
+
530
+ # form parameters
531
+ form_params = opts[:form_params] || {}
532
+
533
+ # http body (model)
534
+ post_body = opts[:debug_body]
535
+
536
+ # return_type
537
+ return_type = opts[:debug_return_type] || 'Array<EduResource>'
538
+
539
+ # auth_names
540
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
541
+
542
+ new_options = opts.merge(
543
+ :operation => :"EduResourcesApi.list_edu_resources",
544
+ :header_params => header_params,
545
+ :query_params => query_params,
546
+ :form_params => form_params,
547
+ :body => post_body,
548
+ :auth_names => auth_names,
549
+ :return_type => return_type
550
+ )
551
+
552
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
553
+ if @api_client.config.debugging
554
+ @api_client.config.logger.debug "API called: EduResourcesApi#list_edu_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
555
+ end
556
+ return data, status_code, headers
557
+ end
558
+
559
+ # Move an education resource
560
+ # @param resource [String] Unique identifier of the resource
561
+ # @param edu_resource_move [EduResourceMove]
562
+ # @param [Hash] opts the optional parameters
563
+ # @return [EduResource]
564
+ def move_edu_resource(resource, edu_resource_move, opts = {})
565
+ data, _status_code, _headers = move_edu_resource_with_http_info(resource, edu_resource_move, opts)
566
+ data
567
+ end
568
+
569
+ # Move an education resource
570
+ # @param resource [String] Unique identifier of the resource
571
+ # @param edu_resource_move [EduResourceMove]
572
+ # @param [Hash] opts the optional parameters
573
+ # @return [Array<(EduResource, Integer, Hash)>] EduResource data, response status code and response headers
574
+ def move_edu_resource_with_http_info(resource, edu_resource_move, opts = {})
575
+ if @api_client.config.debugging
576
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.move_edu_resource ...'
577
+ end
578
+ # verify the required parameter 'resource' is set
579
+ if @api_client.config.client_side_validation && resource.nil?
580
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.move_edu_resource"
581
+ end
582
+ # verify the required parameter 'edu_resource_move' is set
583
+ if @api_client.config.client_side_validation && edu_resource_move.nil?
584
+ fail ArgumentError, "Missing the required parameter 'edu_resource_move' when calling EduResourcesApi.move_edu_resource"
585
+ end
586
+ # resource path
587
+ local_var_path = '/eduResources/{resource}/move'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
588
+
589
+ # query parameters
590
+ query_params = opts[:query_params] || {}
591
+
592
+ # header parameters
593
+ header_params = opts[:header_params] || {}
594
+ # HTTP header 'Accept' (if needed)
595
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
596
+ # HTTP header 'Content-Type'
597
+ content_type = @api_client.select_header_content_type(['application/json'])
598
+ if !content_type.nil?
599
+ header_params['Content-Type'] = content_type
600
+ end
601
+
602
+ # form parameters
603
+ form_params = opts[:form_params] || {}
604
+
605
+ # http body (model)
606
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(edu_resource_move)
607
+
608
+ # return_type
609
+ return_type = opts[:debug_return_type] || 'EduResource'
610
+
611
+ # auth_names
612
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
613
+
614
+ new_options = opts.merge(
615
+ :operation => :"EduResourcesApi.move_edu_resource",
616
+ :header_params => header_params,
617
+ :query_params => query_params,
618
+ :form_params => form_params,
619
+ :body => post_body,
620
+ :auth_names => auth_names,
621
+ :return_type => return_type
622
+ )
623
+
624
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
625
+ if @api_client.config.debugging
626
+ @api_client.config.logger.debug "API called: EduResourcesApi#move_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
627
+ end
628
+ return data, status_code, headers
629
+ end
630
+
631
+ # Update an education resource metadata
632
+ # Update any resources metadata (e.g. title). Use this method to rename education resources folders or assignments.
633
+ # @param resource [String] Unique identifier of the resource
634
+ # @param edu_resource_update [EduResourceUpdate]
635
+ # @param [Hash] opts the optional parameters
636
+ # @return [EduResource]
637
+ def update_edu_resource(resource, edu_resource_update, opts = {})
638
+ data, _status_code, _headers = update_edu_resource_with_http_info(resource, edu_resource_update, opts)
639
+ data
640
+ end
641
+
642
+ # Update an education resource metadata
643
+ # Update any resources metadata (e.g. title). Use this method to rename education resources folders or assignments.
644
+ # @param resource [String] Unique identifier of the resource
645
+ # @param edu_resource_update [EduResourceUpdate]
646
+ # @param [Hash] opts the optional parameters
647
+ # @return [Array<(EduResource, Integer, Hash)>] EduResource data, response status code and response headers
648
+ def update_edu_resource_with_http_info(resource, edu_resource_update, opts = {})
649
+ if @api_client.config.debugging
650
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.update_edu_resource ...'
651
+ end
652
+ # verify the required parameter 'resource' is set
653
+ if @api_client.config.client_side_validation && resource.nil?
654
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.update_edu_resource"
655
+ end
656
+ # verify the required parameter 'edu_resource_update' is set
657
+ if @api_client.config.client_side_validation && edu_resource_update.nil?
658
+ fail ArgumentError, "Missing the required parameter 'edu_resource_update' when calling EduResourcesApi.update_edu_resource"
659
+ end
660
+ # resource path
661
+ local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
662
+
663
+ # query parameters
664
+ query_params = opts[:query_params] || {}
665
+
666
+ # header parameters
667
+ header_params = opts[:header_params] || {}
668
+ # HTTP header 'Accept' (if needed)
669
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
670
+ # HTTP header 'Content-Type'
671
+ content_type = @api_client.select_header_content_type(['application/json'])
672
+ if !content_type.nil?
673
+ header_params['Content-Type'] = content_type
674
+ end
675
+
676
+ # form parameters
677
+ form_params = opts[:form_params] || {}
678
+
679
+ # http body (model)
680
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(edu_resource_update)
681
+
682
+ # return_type
683
+ return_type = opts[:debug_return_type] || 'EduResource'
684
+
685
+ # auth_names
686
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
687
+
688
+ new_options = opts.merge(
689
+ :operation => :"EduResourcesApi.update_edu_resource",
690
+ :header_params => header_params,
691
+ :query_params => query_params,
692
+ :form_params => form_params,
693
+ :body => post_body,
694
+ :auth_names => auth_names,
695
+ :return_type => return_type
696
+ )
697
+
698
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
699
+ if @api_client.config.debugging
700
+ @api_client.config.logger.debug "API called: EduResourcesApi#update_edu_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
701
+ end
702
+ return data, status_code, headers
703
+ end
704
+
705
+ # Update an education resource assignment
706
+ # @param resource [String] Unique identifier of the resource
707
+ # @param assignment_update [AssignmentUpdate]
708
+ # @param [Hash] opts the optional parameters
709
+ # @return [Assignment]
710
+ def update_edu_resource_assignment(resource, assignment_update, opts = {})
711
+ data, _status_code, _headers = update_edu_resource_assignment_with_http_info(resource, assignment_update, opts)
712
+ data
713
+ end
714
+
715
+ # Update an education resource assignment
716
+ # @param resource [String] Unique identifier of the resource
717
+ # @param assignment_update [AssignmentUpdate]
718
+ # @param [Hash] opts the optional parameters
719
+ # @return [Array<(Assignment, Integer, Hash)>] Assignment data, response status code and response headers
720
+ def update_edu_resource_assignment_with_http_info(resource, assignment_update, opts = {})
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.update_edu_resource_assignment ...'
723
+ end
724
+ # verify the required parameter 'resource' is set
725
+ if @api_client.config.client_side_validation && resource.nil?
726
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.update_edu_resource_assignment"
727
+ end
728
+ # verify the required parameter 'assignment_update' is set
729
+ if @api_client.config.client_side_validation && assignment_update.nil?
730
+ fail ArgumentError, "Missing the required parameter 'assignment_update' when calling EduResourcesApi.update_edu_resource_assignment"
731
+ end
732
+ # resource path
733
+ local_var_path = '/eduResources/{resource}/assignment'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
734
+
735
+ # query parameters
736
+ query_params = opts[:query_params] || {}
737
+
738
+ # header parameters
739
+ header_params = opts[:header_params] || {}
740
+ # HTTP header 'Accept' (if needed)
741
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
742
+ # HTTP header 'Content-Type'
743
+ content_type = @api_client.select_header_content_type(['application/json'])
744
+ if !content_type.nil?
745
+ header_params['Content-Type'] = content_type
746
+ end
747
+
748
+ # form parameters
749
+ form_params = opts[:form_params] || {}
750
+
751
+ # http body (model)
752
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(assignment_update)
753
+
754
+ # return_type
755
+ return_type = opts[:debug_return_type] || 'Assignment'
756
+
757
+ # auth_names
758
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
759
+
760
+ new_options = opts.merge(
761
+ :operation => :"EduResourcesApi.update_edu_resource_assignment",
762
+ :header_params => header_params,
763
+ :query_params => query_params,
764
+ :form_params => form_params,
765
+ :body => post_body,
766
+ :auth_names => auth_names,
767
+ :return_type => return_type
768
+ )
769
+
770
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
771
+ if @api_client.config.debugging
772
+ @api_client.config.logger.debug "API called: EduResourcesApi#update_edu_resource_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
773
+ end
774
+ return data, status_code, headers
775
+ end
776
+
777
+ # Use an education resource in a class
778
+ # This endpoint will copy a resource and the underlying resources. The assignment will be created as a draft that can be completed with other options before publishing (e.g. due date, publication date for scheduling, etc.).
779
+ # @param resource [String] Unique identifier of the resource
780
+ # @param edu_resource_use_in_class [EduResourceUseInClass]
781
+ # @param [Hash] opts the optional parameters
782
+ # @return [ClassAssignment]
783
+ def use_edu_resource_in_class(resource, edu_resource_use_in_class, opts = {})
784
+ data, _status_code, _headers = use_edu_resource_in_class_with_http_info(resource, edu_resource_use_in_class, opts)
785
+ data
786
+ end
787
+
788
+ # Use an education resource in a class
789
+ # This endpoint will copy a resource and the underlying resources. The assignment will be created as a draft that can be completed with other options before publishing (e.g. due date, publication date for scheduling, etc.).
790
+ # @param resource [String] Unique identifier of the resource
791
+ # @param edu_resource_use_in_class [EduResourceUseInClass]
792
+ # @param [Hash] opts the optional parameters
793
+ # @return [Array<(ClassAssignment, Integer, Hash)>] ClassAssignment data, response status code and response headers
794
+ def use_edu_resource_in_class_with_http_info(resource, edu_resource_use_in_class, opts = {})
795
+ if @api_client.config.debugging
796
+ @api_client.config.logger.debug 'Calling API: EduResourcesApi.use_edu_resource_in_class ...'
797
+ end
798
+ # verify the required parameter 'resource' is set
799
+ if @api_client.config.client_side_validation && resource.nil?
800
+ fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.use_edu_resource_in_class"
801
+ end
802
+ # verify the required parameter 'edu_resource_use_in_class' is set
803
+ if @api_client.config.client_side_validation && edu_resource_use_in_class.nil?
804
+ fail ArgumentError, "Missing the required parameter 'edu_resource_use_in_class' when calling EduResourcesApi.use_edu_resource_in_class"
805
+ end
806
+ # resource path
807
+ local_var_path = '/eduResources/{resource}/useInClass'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
808
+
809
+ # query parameters
810
+ query_params = opts[:query_params] || {}
811
+
812
+ # header parameters
813
+ header_params = opts[:header_params] || {}
814
+ # HTTP header 'Accept' (if needed)
815
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
816
+ # HTTP header 'Content-Type'
817
+ content_type = @api_client.select_header_content_type(['application/json'])
818
+ if !content_type.nil?
819
+ header_params['Content-Type'] = content_type
820
+ end
821
+
822
+ # form parameters
823
+ form_params = opts[:form_params] || {}
824
+
825
+ # http body (model)
826
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(edu_resource_use_in_class)
827
+
828
+ # return_type
829
+ return_type = opts[:debug_return_type] || 'ClassAssignment'
830
+
831
+ # auth_names
832
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
833
+
834
+ new_options = opts.merge(
835
+ :operation => :"EduResourcesApi.use_edu_resource_in_class",
836
+ :header_params => header_params,
837
+ :query_params => query_params,
838
+ :form_params => form_params,
839
+ :body => post_body,
840
+ :auth_names => auth_names,
841
+ :return_type => return_type
842
+ )
843
+
844
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
845
+ if @api_client.config.debugging
846
+ @api_client.config.logger.debug "API called: EduResourcesApi#use_edu_resource_in_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
847
+ end
848
+ return data, status_code, headers
849
+ end
850
+ end
851
+ end