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,12 +1,12 @@
1
1
  =begin
2
2
  #Flat API
3
3
 
4
- #The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro (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)
4
+ #The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
5
5
 
6
- The version of the OpenAPI document: 2.20.0
6
+ The version of the OpenAPI document: 2.26.1
7
7
  Contact: developers@flat.io
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0
9
+ Generator version: 7.24.0
10
10
 
11
11
  =end
12
12
 
@@ -25,7 +25,8 @@ module FlatApi
25
25
  # @option opts [String] :q The query to search
26
26
  # @option opts [Array<String>] :group Filter users by group
27
27
  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
28
- # @return [Array<UserDetailsAdmin>]
28
+ # @option opts [String] :test_accounts Filter users based on test account status. Test accounts are student accounts created for testing purposes by teachers. * &#x60;exclude&#x60;: Hide test accounts from results. * &#x60;only&#x60;: Show only test accounts. When omitted, all users are returned.
29
+ # @return [Integer]
29
30
  def count_orga_users(opts = {})
30
31
  data, _status_code, _headers = count_orga_users_with_http_info(opts)
31
32
  data
@@ -37,15 +38,20 @@ module FlatApi
37
38
  # @option opts [String] :q The query to search
38
39
  # @option opts [Array<String>] :group Filter users by group
39
40
  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
40
- # @return [Array<(Array<UserDetailsAdmin>, Integer, Hash)>] Array<UserDetailsAdmin> data, response status code and response headers
41
+ # @option opts [String] :test_accounts Filter users based on test account status. Test accounts are student accounts created for testing purposes by teachers. * &#x60;exclude&#x60;: Hide test accounts from results. * &#x60;only&#x60;: Show only test accounts. When omitted, all users are returned.
42
+ # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers
41
43
  def count_orga_users_with_http_info(opts = {})
42
44
  if @api_client.config.debugging
43
45
  @api_client.config.logger.debug 'Calling API: OrganizationApi.count_orga_users ...'
44
46
  end
45
- allowable_values = ["user", "teacher", "admin"]
47
+ allowable_values = ["user", "teacher", "admin", "accountAdmin"]
46
48
  if @api_client.config.client_side_validation && opts[:'role'] && !opts[:'role'].all? { |item| allowable_values.include?(item) }
47
49
  fail ArgumentError, "invalid value for \"role\", must include one of #{allowable_values}"
48
50
  end
51
+ allowable_values = ["exclude", "only"]
52
+ if @api_client.config.client_side_validation && opts[:'test_accounts'] && !allowable_values.include?(opts[:'test_accounts'])
53
+ fail ArgumentError, "invalid value for \"test_accounts\", must be one of #{allowable_values}"
54
+ end
49
55
  # resource path
50
56
  local_var_path = '/organizations/users/count'
51
57
 
@@ -55,11 +61,12 @@ module FlatApi
55
61
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
56
62
  query_params[:'group'] = @api_client.build_collection_param(opts[:'group'], :multi) if !opts[:'group'].nil?
57
63
  query_params[:'noActiveLicense'] = opts[:'no_active_license'] if !opts[:'no_active_license'].nil?
64
+ query_params[:'testAccounts'] = opts[:'test_accounts'] if !opts[:'test_accounts'].nil?
58
65
 
59
66
  # header parameters
60
67
  header_params = opts[:header_params] || {}
61
68
  # HTTP header 'Accept' (if needed)
62
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
63
70
 
64
71
  # form parameters
65
72
  form_params = opts[:form_params] || {}
@@ -68,7 +75,7 @@ module FlatApi
68
75
  post_body = opts[:debug_body]
69
76
 
70
77
  # return_type
71
- return_type = opts[:debug_return_type] || 'Array<UserDetailsAdmin>'
78
+ return_type = opts[:debug_return_type] || 'Integer'
72
79
 
73
80
  # auth_names
74
81
  auth_names = opts[:debug_auth_names] || ['OAuth2']
@@ -90,8 +97,74 @@ module FlatApi
90
97
  return data, status_code, headers
91
98
  end
92
99
 
100
+ # Create a new LTI configuration (1.1 or 1.3)
101
+ # @param lti_configuration_create [LtiConfigurationCreate]
102
+ # @param [Hash] opts the optional parameters
103
+ # @return [LtiConfiguration]
104
+ def create_lti_configuration(lti_configuration_create, opts = {})
105
+ data, _status_code, _headers = create_lti_configuration_with_http_info(lti_configuration_create, opts)
106
+ data
107
+ end
108
+
109
+ # Create a new LTI configuration (1.1 or 1.3)
110
+ # @param lti_configuration_create [LtiConfigurationCreate]
111
+ # @param [Hash] opts the optional parameters
112
+ # @return [Array<(LtiConfiguration, Integer, Hash)>] LtiConfiguration data, response status code and response headers
113
+ def create_lti_configuration_with_http_info(lti_configuration_create, opts = {})
114
+ if @api_client.config.debugging
115
+ @api_client.config.logger.debug 'Calling API: OrganizationApi.create_lti_configuration ...'
116
+ end
117
+ # verify the required parameter 'lti_configuration_create' is set
118
+ if @api_client.config.client_side_validation && lti_configuration_create.nil?
119
+ fail ArgumentError, "Missing the required parameter 'lti_configuration_create' when calling OrganizationApi.create_lti_configuration"
120
+ end
121
+ # resource path
122
+ local_var_path = '/organizations/lti/configurations'
123
+
124
+ # query parameters
125
+ query_params = opts[:query_params] || {}
126
+
127
+ # header parameters
128
+ header_params = opts[:header_params] || {}
129
+ # HTTP header 'Accept' (if needed)
130
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
131
+ # HTTP header 'Content-Type'
132
+ content_type = @api_client.select_header_content_type(['application/json'])
133
+ if !content_type.nil?
134
+ header_params['Content-Type'] = content_type
135
+ end
136
+
137
+ # form parameters
138
+ form_params = opts[:form_params] || {}
139
+
140
+ # http body (model)
141
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(lti_configuration_create)
142
+
143
+ # return_type
144
+ return_type = opts[:debug_return_type] || 'LtiConfiguration'
145
+
146
+ # auth_names
147
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
148
+
149
+ new_options = opts.merge(
150
+ :operation => :"OrganizationApi.create_lti_configuration",
151
+ :header_params => header_params,
152
+ :query_params => query_params,
153
+ :form_params => form_params,
154
+ :body => post_body,
155
+ :auth_names => auth_names,
156
+ :return_type => return_type
157
+ )
158
+
159
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug "API called: OrganizationApi#create_lti_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
162
+ end
163
+ return data, status_code, headers
164
+ end
165
+
93
166
  # Create a new couple of LTI 1.x credentials
94
- # Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
167
+ # DEPRECATED. Use the unified endpoints under `/organizations/lti/configurations`. Note: Teachers may be restricted by the organization privacy setting `lti1p1AllowTeachersCredentials`. Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
95
168
  # @param body [LtiCredentialsCreation]
96
169
  # @param [Hash] opts the optional parameters
97
170
  # @return [LtiCredentials]
@@ -101,7 +174,7 @@ module FlatApi
101
174
  end
102
175
 
103
176
  # Create a new couple of LTI 1.x credentials
104
- # Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
177
+ # DEPRECATED. Use the unified endpoints under &#x60;/organizations/lti/configurations&#x60;. Note: Teachers may be restricted by the organization privacy setting &#x60;lti1p1AllowTeachersCredentials&#x60;. Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
105
178
  # @param body [LtiCredentialsCreation]
106
179
  # @param [Hash] opts the optional parameters
107
180
  # @return [Array<(LtiCredentials, Integer, Hash)>] LtiCredentials data, response status code and response headers
@@ -122,7 +195,7 @@ module FlatApi
122
195
  # header parameters
123
196
  header_params = opts[:header_params] || {}
124
197
  # HTTP header 'Accept' (if needed)
125
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
198
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
126
199
  # HTTP header 'Content-Type'
127
200
  content_type = @api_client.select_header_content_type(['application/json'])
128
201
  if !content_type.nil?
@@ -190,7 +263,7 @@ module FlatApi
190
263
  # header parameters
191
264
  header_params = opts[:header_params] || {}
192
265
  # HTTP header 'Accept' (if needed)
193
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
266
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
194
267
  # HTTP header 'Content-Type'
195
268
  content_type = @api_client.select_header_content_type(['application/json'])
196
269
  if !content_type.nil?
@@ -256,7 +329,7 @@ module FlatApi
256
329
  # header parameters
257
330
  header_params = opts[:header_params] || {}
258
331
  # HTTP header 'Accept' (if needed)
259
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
332
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
260
333
  # HTTP header 'Content-Type'
261
334
  content_type = @api_client.select_header_content_type(['application/json'])
262
335
  if !content_type.nil?
@@ -322,7 +395,7 @@ module FlatApi
322
395
  fail ArgumentError, "Missing the required parameter 'organization_user_access_token_creation' when calling OrganizationApi.create_organization_user_access_token"
323
396
  end
324
397
  # resource path
325
- local_var_path = '/organizations/users/{user}/accessToken'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
398
+ local_var_path = '/organizations/users/{user}/accessToken'.sub('{user}', CGI.escape(user.to_s))
326
399
 
327
400
  # query parameters
328
401
  query_params = opts[:query_params] || {}
@@ -330,7 +403,7 @@ module FlatApi
330
403
  # header parameters
331
404
  header_params = opts[:header_params] || {}
332
405
  # HTTP header 'Accept' (if needed)
333
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
406
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
334
407
  # HTTP header 'Content-Type'
335
408
  content_type = @api_client.select_header_content_type(['application/json'])
336
409
  if !content_type.nil?
@@ -394,7 +467,7 @@ module FlatApi
394
467
  fail ArgumentError, "Missing the required parameter 'user_signin_link_creation' when calling OrganizationApi.create_organization_user_signin_link"
395
468
  end
396
469
  # resource path
397
- local_var_path = '/organizations/users/{user}/signinLink'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
470
+ local_var_path = '/organizations/users/{user}/signinLink'.sub('{user}', CGI.escape(user.to_s))
398
471
 
399
472
  # query parameters
400
473
  query_params = opts[:query_params] || {}
@@ -402,7 +475,7 @@ module FlatApi
402
475
  # header parameters
403
476
  header_params = opts[:header_params] || {}
404
477
  # HTTP header 'Accept' (if needed)
405
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
478
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
406
479
  # HTTP header 'Content-Type'
407
480
  content_type = @api_client.select_header_content_type(['application/json'])
408
481
  if !content_type.nil?
@@ -438,7 +511,124 @@ module FlatApi
438
511
  return data, status_code, headers
439
512
  end
440
513
 
514
+ # Delete an LTI configuration
515
+ # @param configuration [String] Configuration unique identifier
516
+ # @param [Hash] opts the optional parameters
517
+ # @return [nil]
518
+ def delete_lti_configuration(configuration, opts = {})
519
+ delete_lti_configuration_with_http_info(configuration, opts)
520
+ nil
521
+ end
522
+
523
+ # Delete an LTI configuration
524
+ # @param configuration [String] Configuration unique identifier
525
+ # @param [Hash] opts the optional parameters
526
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
527
+ def delete_lti_configuration_with_http_info(configuration, opts = {})
528
+ if @api_client.config.debugging
529
+ @api_client.config.logger.debug 'Calling API: OrganizationApi.delete_lti_configuration ...'
530
+ end
531
+ # verify the required parameter 'configuration' is set
532
+ if @api_client.config.client_side_validation && configuration.nil?
533
+ fail ArgumentError, "Missing the required parameter 'configuration' when calling OrganizationApi.delete_lti_configuration"
534
+ end
535
+ # resource path
536
+ local_var_path = '/organizations/lti/configurations/{configuration}'.sub('{configuration}', CGI.escape(configuration.to_s))
537
+
538
+ # query parameters
539
+ query_params = opts[:query_params] || {}
540
+
541
+ # header parameters
542
+ header_params = opts[:header_params] || {}
543
+ # HTTP header 'Accept' (if needed)
544
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
545
+
546
+ # form parameters
547
+ form_params = opts[:form_params] || {}
548
+
549
+ # http body (model)
550
+ post_body = opts[:debug_body]
551
+
552
+ # return_type
553
+ return_type = opts[:debug_return_type]
554
+
555
+ # auth_names
556
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
557
+
558
+ new_options = opts.merge(
559
+ :operation => :"OrganizationApi.delete_lti_configuration",
560
+ :header_params => header_params,
561
+ :query_params => query_params,
562
+ :form_params => form_params,
563
+ :body => post_body,
564
+ :auth_names => auth_names,
565
+ :return_type => return_type
566
+ )
567
+
568
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
569
+ if @api_client.config.debugging
570
+ @api_client.config.logger.debug "API called: OrganizationApi#delete_lti_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
571
+ end
572
+ return data, status_code, headers
573
+ end
574
+
575
+ # List LTI configurations (1.1 and 1.3)
576
+ # @param [Hash] opts the optional parameters
577
+ # @return [Array<LtiConfiguration>]
578
+ def list_lti_configurations(opts = {})
579
+ data, _status_code, _headers = list_lti_configurations_with_http_info(opts)
580
+ data
581
+ end
582
+
583
+ # List LTI configurations (1.1 and 1.3)
584
+ # @param [Hash] opts the optional parameters
585
+ # @return [Array<(Array<LtiConfiguration>, Integer, Hash)>] Array<LtiConfiguration> data, response status code and response headers
586
+ def list_lti_configurations_with_http_info(opts = {})
587
+ if @api_client.config.debugging
588
+ @api_client.config.logger.debug 'Calling API: OrganizationApi.list_lti_configurations ...'
589
+ end
590
+ # resource path
591
+ local_var_path = '/organizations/lti/configurations'
592
+
593
+ # query parameters
594
+ query_params = opts[:query_params] || {}
595
+
596
+ # header parameters
597
+ header_params = opts[:header_params] || {}
598
+ # HTTP header 'Accept' (if needed)
599
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
600
+
601
+ # form parameters
602
+ form_params = opts[:form_params] || {}
603
+
604
+ # http body (model)
605
+ post_body = opts[:debug_body]
606
+
607
+ # return_type
608
+ return_type = opts[:debug_return_type] || 'Array<LtiConfiguration>'
609
+
610
+ # auth_names
611
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
612
+
613
+ new_options = opts.merge(
614
+ :operation => :"OrganizationApi.list_lti_configurations",
615
+ :header_params => header_params,
616
+ :query_params => query_params,
617
+ :form_params => form_params,
618
+ :body => post_body,
619
+ :auth_names => auth_names,
620
+ :return_type => return_type
621
+ )
622
+
623
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
624
+ if @api_client.config.debugging
625
+ @api_client.config.logger.debug "API called: OrganizationApi#list_lti_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
626
+ end
627
+ return data, status_code, headers
628
+ end
629
+
441
630
  # List LTI 1.x credentials
631
+ # DEPRECATED. Use the unified endpoints under `/organizations/lti/configurations`. Note: Teachers may be restricted by the organization privacy setting `lti1p1AllowTeachersCredentials`.
442
632
  # @param [Hash] opts the optional parameters
443
633
  # @return [Array<LtiCredentials>]
444
634
  def list_lti_credentials(opts = {})
@@ -447,6 +637,7 @@ module FlatApi
447
637
  end
448
638
 
449
639
  # List LTI 1.x credentials
640
+ # DEPRECATED. Use the unified endpoints under &#x60;/organizations/lti/configurations&#x60;. Note: Teachers may be restricted by the organization privacy setting &#x60;lti1p1AllowTeachersCredentials&#x60;.
450
641
  # @param [Hash] opts the optional parameters
451
642
  # @return [Array<(Array<LtiCredentials>, Integer, Hash)>] Array<LtiCredentials> data, response status code and response headers
452
643
  def list_lti_credentials_with_http_info(opts = {})
@@ -462,7 +653,7 @@ module FlatApi
462
653
  # header parameters
463
654
  header_params = opts[:header_params] || {}
464
655
  # HTTP header 'Accept' (if needed)
465
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
656
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
466
657
 
467
658
  # form parameters
468
659
  form_params = opts[:form_params] || {}
@@ -541,7 +732,7 @@ module FlatApi
541
732
  # header parameters
542
733
  header_params = opts[:header_params] || {}
543
734
  # HTTP header 'Accept' (if needed)
544
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
735
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
545
736
 
546
737
  # form parameters
547
738
  form_params = opts[:form_params] || {}
@@ -574,7 +765,7 @@ module FlatApi
574
765
 
575
766
  # List the organization users
576
767
  # @param [Hash] opts the optional parameters
577
- # @option opts [Array<String>] :sort The order to sort the user list
768
+ # @option opts [String] :sort The order to sort the user list. * &#x60;creationDate&#x60;: Order by account creation. * &#x60;firstname&#x60;, &#x60;lastname&#x60;, &#x60;username&#x60;: Order by the user identity. * &#x60;lastActivityDate&#x60;: Order by the last recorded activity. * &#x60;licenseExpirationDate&#x60;: Order by the expiration of the active license.
578
769
  # @option opts [String] :direction Sort direction
579
770
  # @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.
580
771
  # @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.
@@ -582,6 +773,7 @@ module FlatApi
582
773
  # @option opts [String] :q The query to search
583
774
  # @option opts [Array<String>] :group Filter users by group
584
775
  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
776
+ # @option opts [String] :test_accounts Filter users based on test account status. Test accounts are student accounts created for testing purposes by teachers. * &#x60;exclude&#x60;: Hide test accounts from results. * &#x60;only&#x60;: Show only test accounts. When omitted, all users are returned.
585
777
  # @option opts [Array<String>] :license_expiration_date Filter users by license expiration date or &#x60;active&#x60; / &#x60;notActive&#x60;
586
778
  # @option opts [Boolean] :only_ids Return only user ids
587
779
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
@@ -593,7 +785,7 @@ module FlatApi
593
785
 
594
786
  # List the organization users
595
787
  # @param [Hash] opts the optional parameters
596
- # @option opts [Array<String>] :sort The order to sort the user list
788
+ # @option opts [String] :sort The order to sort the user list. * &#x60;creationDate&#x60;: Order by account creation. * &#x60;firstname&#x60;, &#x60;lastname&#x60;, &#x60;username&#x60;: Order by the user identity. * &#x60;lastActivityDate&#x60;: Order by the last recorded activity. * &#x60;licenseExpirationDate&#x60;: Order by the expiration of the active license.
597
789
  # @option opts [String] :direction Sort direction
598
790
  # @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.
599
791
  # @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.
@@ -601,6 +793,7 @@ module FlatApi
601
793
  # @option opts [String] :q The query to search
602
794
  # @option opts [Array<String>] :group Filter users by group
603
795
  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
796
+ # @option opts [String] :test_accounts Filter users based on test account status. Test accounts are student accounts created for testing purposes by teachers. * &#x60;exclude&#x60;: Hide test accounts from results. * &#x60;only&#x60;: Show only test accounts. When omitted, all users are returned.
604
797
  # @option opts [Array<String>] :license_expiration_date Filter users by license expiration date or &#x60;active&#x60; / &#x60;notActive&#x60;
605
798
  # @option opts [Boolean] :only_ids Return only user ids
606
799
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
@@ -609,18 +802,22 @@ module FlatApi
609
802
  if @api_client.config.debugging
610
803
  @api_client.config.logger.debug 'Calling API: OrganizationApi.list_organization_users ...'
611
804
  end
612
- allowable_values = ["firstname", "lastname", "lastActivityDate", "licenseExpirationDate"]
613
- if @api_client.config.client_side_validation && opts[:'sort'] && !opts[:'sort'].all? { |item| allowable_values.include?(item) }
614
- fail ArgumentError, "invalid value for \"sort\", must include one of #{allowable_values}"
805
+ allowable_values = ["creationDate", "firstname", "lastname", "username", "lastActivityDate", "licenseExpirationDate"]
806
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
807
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
615
808
  end
616
809
  allowable_values = ["asc", "desc"]
617
810
  if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
618
811
  fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
619
812
  end
620
- allowable_values = ["user", "teacher", "admin"]
813
+ allowable_values = ["user", "teacher", "admin", "accountAdmin"]
621
814
  if @api_client.config.client_side_validation && opts[:'role'] && !opts[:'role'].all? { |item| allowable_values.include?(item) }
622
815
  fail ArgumentError, "invalid value for \"role\", must include one of #{allowable_values}"
623
816
  end
817
+ allowable_values = ["exclude", "only"]
818
+ if @api_client.config.client_side_validation && opts[:'test_accounts'] && !allowable_values.include?(opts[:'test_accounts'])
819
+ fail ArgumentError, "invalid value for \"test_accounts\", must be one of #{allowable_values}"
820
+ end
624
821
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
625
822
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationApi.list_organization_users, must be smaller than or equal to 1000.'
626
823
  end
@@ -634,7 +831,7 @@ module FlatApi
634
831
 
635
832
  # query parameters
636
833
  query_params = opts[:query_params] || {}
637
- query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
834
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
638
835
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
639
836
  query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
640
837
  query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
@@ -642,6 +839,7 @@ module FlatApi
642
839
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
643
840
  query_params[:'group'] = @api_client.build_collection_param(opts[:'group'], :multi) if !opts[:'group'].nil?
644
841
  query_params[:'noActiveLicense'] = opts[:'no_active_license'] if !opts[:'no_active_license'].nil?
842
+ query_params[:'testAccounts'] = opts[:'test_accounts'] if !opts[:'test_accounts'].nil?
645
843
  query_params[:'licenseExpirationDate'] = @api_client.build_collection_param(opts[:'license_expiration_date'], :multi) if !opts[:'license_expiration_date'].nil?
646
844
  query_params[:'onlyIds'] = opts[:'only_ids'] if !opts[:'only_ids'].nil?
647
845
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
@@ -649,7 +847,7 @@ module FlatApi
649
847
  # header parameters
650
848
  header_params = opts[:header_params] || {}
651
849
  # HTTP header 'Accept' (if needed)
652
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
850
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
653
851
 
654
852
  # form parameters
655
853
  form_params = opts[:form_params] || {}
@@ -702,7 +900,7 @@ module FlatApi
702
900
  fail ArgumentError, "Missing the required parameter 'invitation' when calling OrganizationApi.remove_organization_invitation"
703
901
  end
704
902
  # resource path
705
- local_var_path = '/organizations/invitations/{invitation}'.sub('{' + 'invitation' + '}', CGI.escape(invitation.to_s))
903
+ local_var_path = '/organizations/invitations/{invitation}'.sub('{invitation}', CGI.escape(invitation.to_s))
706
904
 
707
905
  # query parameters
708
906
  query_params = opts[:query_params] || {}
@@ -710,7 +908,7 @@ module FlatApi
710
908
  # header parameters
711
909
  header_params = opts[:header_params] || {}
712
910
  # HTTP header 'Accept' (if needed)
713
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
911
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
714
912
 
715
913
  # form parameters
716
914
  form_params = opts[:form_params] || {}
@@ -767,7 +965,7 @@ module FlatApi
767
965
  fail ArgumentError, "Missing the required parameter 'user' when calling OrganizationApi.remove_organization_user"
768
966
  end
769
967
  # resource path
770
- local_var_path = '/organizations/users/{user}'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
968
+ local_var_path = '/organizations/users/{user}'.sub('{user}', CGI.escape(user.to_s))
771
969
 
772
970
  # query parameters
773
971
  query_params = opts[:query_params] || {}
@@ -776,7 +974,7 @@ module FlatApi
776
974
  # header parameters
777
975
  header_params = opts[:header_params] || {}
778
976
  # HTTP header 'Accept' (if needed)
779
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
977
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
780
978
 
781
979
  # form parameters
782
980
  form_params = opts[:form_params] || {}
@@ -808,6 +1006,7 @@ module FlatApi
808
1006
  end
809
1007
 
810
1008
  # Revoke LTI 1.x credentials
1009
+ # DEPRECATED. Use the unified endpoints under `/organizations/lti/configurations`. Note: Teachers may be restricted by the organization privacy setting `lti1p1AllowTeachersCredentials`.
811
1010
  # @param credentials [String] Credentials unique identifier
812
1011
  # @param [Hash] opts the optional parameters
813
1012
  # @return [nil]
@@ -817,6 +1016,7 @@ module FlatApi
817
1016
  end
818
1017
 
819
1018
  # Revoke LTI 1.x credentials
1019
+ # DEPRECATED. Use the unified endpoints under &#x60;/organizations/lti/configurations&#x60;. Note: Teachers may be restricted by the organization privacy setting &#x60;lti1p1AllowTeachersCredentials&#x60;.
820
1020
  # @param credentials [String] Credentials unique identifier
821
1021
  # @param [Hash] opts the optional parameters
822
1022
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -829,7 +1029,7 @@ module FlatApi
829
1029
  fail ArgumentError, "Missing the required parameter 'credentials' when calling OrganizationApi.revoke_lti_credentials"
830
1030
  end
831
1031
  # resource path
832
- local_var_path = '/organizations/lti/credentials/{credentials}'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))
1032
+ local_var_path = '/organizations/lti/credentials/{credentials}'.sub('{credentials}', CGI.escape(credentials.to_s))
833
1033
 
834
1034
  # query parameters
835
1035
  query_params = opts[:query_params] || {}
@@ -837,7 +1037,7 @@ module FlatApi
837
1037
  # header parameters
838
1038
  header_params = opts[:header_params] || {}
839
1039
  # HTTP header 'Accept' (if needed)
840
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1040
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
841
1041
 
842
1042
  # form parameters
843
1043
  form_params = opts[:form_params] || {}
@@ -868,6 +1068,78 @@ module FlatApi
868
1068
  return data, status_code, headers
869
1069
  end
870
1070
 
1071
+ # Update an existing LTI configuration (edit 1.3; 1.1 not editable)
1072
+ # @param configuration [String] Configuration unique identifier
1073
+ # @param lti_configuration_update [LtiConfigurationUpdate]
1074
+ # @param [Hash] opts the optional parameters
1075
+ # @return [LtiConfiguration]
1076
+ def update_lti_configuration(configuration, lti_configuration_update, opts = {})
1077
+ data, _status_code, _headers = update_lti_configuration_with_http_info(configuration, lti_configuration_update, opts)
1078
+ data
1079
+ end
1080
+
1081
+ # Update an existing LTI configuration (edit 1.3; 1.1 not editable)
1082
+ # @param configuration [String] Configuration unique identifier
1083
+ # @param lti_configuration_update [LtiConfigurationUpdate]
1084
+ # @param [Hash] opts the optional parameters
1085
+ # @return [Array<(LtiConfiguration, Integer, Hash)>] LtiConfiguration data, response status code and response headers
1086
+ def update_lti_configuration_with_http_info(configuration, lti_configuration_update, opts = {})
1087
+ if @api_client.config.debugging
1088
+ @api_client.config.logger.debug 'Calling API: OrganizationApi.update_lti_configuration ...'
1089
+ end
1090
+ # verify the required parameter 'configuration' is set
1091
+ if @api_client.config.client_side_validation && configuration.nil?
1092
+ fail ArgumentError, "Missing the required parameter 'configuration' when calling OrganizationApi.update_lti_configuration"
1093
+ end
1094
+ # verify the required parameter 'lti_configuration_update' is set
1095
+ if @api_client.config.client_side_validation && lti_configuration_update.nil?
1096
+ fail ArgumentError, "Missing the required parameter 'lti_configuration_update' when calling OrganizationApi.update_lti_configuration"
1097
+ end
1098
+ # resource path
1099
+ local_var_path = '/organizations/lti/configurations/{configuration}'.sub('{configuration}', CGI.escape(configuration.to_s))
1100
+
1101
+ # query parameters
1102
+ query_params = opts[:query_params] || {}
1103
+
1104
+ # header parameters
1105
+ header_params = opts[:header_params] || {}
1106
+ # HTTP header 'Accept' (if needed)
1107
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1108
+ # HTTP header 'Content-Type'
1109
+ content_type = @api_client.select_header_content_type(['application/json'])
1110
+ if !content_type.nil?
1111
+ header_params['Content-Type'] = content_type
1112
+ end
1113
+
1114
+ # form parameters
1115
+ form_params = opts[:form_params] || {}
1116
+
1117
+ # http body (model)
1118
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(lti_configuration_update)
1119
+
1120
+ # return_type
1121
+ return_type = opts[:debug_return_type] || 'LtiConfiguration'
1122
+
1123
+ # auth_names
1124
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1125
+
1126
+ new_options = opts.merge(
1127
+ :operation => :"OrganizationApi.update_lti_configuration",
1128
+ :header_params => header_params,
1129
+ :query_params => query_params,
1130
+ :form_params => form_params,
1131
+ :body => post_body,
1132
+ :auth_names => auth_names,
1133
+ :return_type => return_type
1134
+ )
1135
+
1136
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1137
+ if @api_client.config.debugging
1138
+ @api_client.config.logger.debug "API called: OrganizationApi#update_lti_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1139
+ end
1140
+ return data, status_code, headers
1141
+ end
1142
+
871
1143
  # Update account information
872
1144
  # @param user [String] Unique identifier of the Flat account
873
1145
  # @param body [UserAdminUpdate]
@@ -896,7 +1168,7 @@ module FlatApi
896
1168
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.update_organization_user"
897
1169
  end
898
1170
  # resource path
899
- local_var_path = '/organizations/users/{user}'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
1171
+ local_var_path = '/organizations/users/{user}'.sub('{user}', CGI.escape(user.to_s))
900
1172
 
901
1173
  # query parameters
902
1174
  query_params = opts[:query_params] || {}
@@ -904,7 +1176,7 @@ module FlatApi
904
1176
  # header parameters
905
1177
  header_params = opts[:header_params] || {}
906
1178
  # HTTP header 'Accept' (if needed)
907
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1179
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
908
1180
  # HTTP header 'Content-Type'
909
1181
  content_type = @api_client.select_header_content_type(['application/json'])
910
1182
  if !content_type.nil?