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
 
@@ -21,7 +21,7 @@ module FlatApi
21
21
  end
22
22
  # Add a score to the collection
23
23
  # This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability `canAddScores` on the provided `collection` to perform the action.
24
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
24
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
25
25
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
@@ -33,7 +33,7 @@ module FlatApi
33
33
 
34
34
  # Add a score to the collection
35
35
  # This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability `canAddScores` on the provided `collection` to perform the action.
36
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
36
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
37
37
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
@@ -51,7 +51,7 @@ module FlatApi
51
51
  fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.add_score_to_collection"
52
52
  end
53
53
  # resource path
54
- local_var_path = '/collections/{collection}/scores/{score}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s)).sub('{' + 'score' + '}', CGI.escape(score.to_s))
54
+ local_var_path = '/collections/{collection}/scores/{score}'.sub('{collection}', CGI.escape(collection.to_s)).sub('{score}', CGI.escape(score.to_s))
55
55
 
56
56
  # query parameters
57
57
  query_params = opts[:query_params] || {}
@@ -60,7 +60,12 @@ module FlatApi
60
60
  # header parameters
61
61
  header_params = opts[:header_params] || {}
62
62
  # HTTP header 'Accept' (if needed)
63
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
64
+ # HTTP header 'Content-Type'
65
+ content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
66
+ if !content_type.nil?
67
+ header_params['Content-Type'] = content_type
68
+ end
64
69
 
65
70
  # form parameters
66
71
  form_params = opts[:form_params] || {}
@@ -92,7 +97,7 @@ module FlatApi
92
97
  end
93
98
 
94
99
  # Create a new collection
95
- # This method will create a new collection and add it to your `root` collection.
100
+ # This method will create a new collection in your account.
96
101
  # @param body [CollectionCreation]
97
102
  # @param [Hash] opts the optional parameters
98
103
  # @return [Collection]
@@ -102,7 +107,7 @@ module FlatApi
102
107
  end
103
108
 
104
109
  # Create a new collection
105
- # This method will create a new collection and add it to your `root` collection.
110
+ # This method will create a new collection in your account.
106
111
  # @param body [CollectionCreation]
107
112
  # @param [Hash] opts the optional parameters
108
113
  # @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
@@ -123,7 +128,7 @@ module FlatApi
123
128
  # header parameters
124
129
  header_params = opts[:header_params] || {}
125
130
  # HTTP header 'Accept' (if needed)
126
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
131
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
127
132
  # HTTP header 'Content-Type'
128
133
  content_type = @api_client.select_header_content_type(['application/json'])
129
134
  if !content_type.nil?
@@ -161,7 +166,7 @@ module FlatApi
161
166
 
162
167
  # Delete the collection
163
168
  # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`.
164
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
169
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
165
170
  # @param [Hash] opts the optional parameters
166
171
  # @return [nil]
167
172
  def delete_collection(collection, opts = {})
@@ -171,7 +176,7 @@ module FlatApi
171
176
 
172
177
  # Delete the collection
173
178
  # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the &#x60;trash&#x60;.
174
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
179
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
175
180
  # @param [Hash] opts the optional parameters
176
181
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
177
182
  def delete_collection_with_http_info(collection, opts = {})
@@ -183,7 +188,7 @@ module FlatApi
183
188
  fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_collection"
184
189
  end
185
190
  # resource path
186
- local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
191
+ local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
187
192
 
188
193
  # query parameters
189
194
  query_params = opts[:query_params] || {}
@@ -191,7 +196,7 @@ module FlatApi
191
196
  # header parameters
192
197
  header_params = opts[:header_params] || {}
193
198
  # HTTP header 'Accept' (if needed)
194
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
195
200
 
196
201
  # form parameters
197
202
  form_params = opts[:form_params] || {}
@@ -224,9 +229,10 @@ module FlatApi
224
229
 
225
230
  # Delete a score from the collection
226
231
  # This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
227
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
232
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted
228
233
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
229
234
  # @param [Hash] opts the optional parameters
235
+ # @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
230
236
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
231
237
  # @return [nil]
232
238
  def delete_score_from_collection(collection, score, opts = {})
@@ -236,9 +242,10 @@ module FlatApi
236
242
 
237
243
  # Delete a score from the collection
238
244
  # This method will delete a score from the collection. Unlike [&#x60;DELETE /scores/{score}&#x60;](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
239
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
245
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted
240
246
  # @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. &#x60;ScoreDetails.id&#x60;) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with &#x60;drive-&#x60; (e.g. &#x60;drive-0B000000000&#x60;).
241
247
  # @param [Hash] opts the optional parameters
248
+ # @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - &#x60;?eventProperties&#x3D;{\&quot;context\&quot;:\&quot;discover\&quot;,\&quot;screenLevel0\&quot;:\&quot;home\&quot;}&#x60;
242
249
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
243
250
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
244
251
  def delete_score_from_collection_with_http_info(collection, score, opts = {})
@@ -254,16 +261,22 @@ module FlatApi
254
261
  fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.delete_score_from_collection"
255
262
  end
256
263
  # resource path
257
- local_var_path = '/collections/{collection}/scores/{score}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s)).sub('{' + 'score' + '}', CGI.escape(score.to_s))
264
+ local_var_path = '/collections/{collection}/scores/{score}'.sub('{collection}', CGI.escape(collection.to_s)).sub('{score}', CGI.escape(score.to_s))
258
265
 
259
266
  # query parameters
260
267
  query_params = opts[:query_params] || {}
268
+ query_params[:'eventProperties'] = opts[:'event_properties'] if !opts[:'event_properties'].nil?
261
269
  query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
262
270
 
263
271
  # header parameters
264
272
  header_params = opts[:header_params] || {}
265
273
  # HTTP header 'Accept' (if needed)
266
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
274
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
275
+ # HTTP header 'Content-Type'
276
+ content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
277
+ if !content_type.nil?
278
+ header_params['Content-Type'] = content_type
279
+ end
267
280
 
268
281
  # form parameters
269
282
  form_params = opts[:form_params] || {}
@@ -295,7 +308,7 @@ module FlatApi
295
308
  end
296
309
 
297
310
  # Update a collection's metadata
298
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
311
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
299
312
  # @param body [CollectionModification]
300
313
  # @param [Hash] opts the optional parameters
301
314
  # @return [Collection]
@@ -305,7 +318,7 @@ module FlatApi
305
318
  end
306
319
 
307
320
  # Update a collection&#39;s metadata
308
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
321
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
309
322
  # @param body [CollectionModification]
310
323
  # @param [Hash] opts the optional parameters
311
324
  # @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
@@ -322,7 +335,7 @@ module FlatApi
322
335
  fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.edit_collection"
323
336
  end
324
337
  # resource path
325
- local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
338
+ local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
326
339
 
327
340
  # query parameters
328
341
  query_params = opts[:query_params] || {}
@@ -330,7 +343,7 @@ module FlatApi
330
343
  # header parameters
331
344
  header_params = opts[:header_params] || {}
332
345
  # HTTP header 'Accept' (if needed)
333
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
346
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
334
347
  # HTTP header 'Content-Type'
335
348
  content_type = @api_client.select_header_content_type(['application/json'])
336
349
  if !content_type.nil?
@@ -367,7 +380,7 @@ module FlatApi
367
380
  end
368
381
 
369
382
  # Get collection details
370
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
383
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
371
384
  # @param [Hash] opts the optional parameters
372
385
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
373
386
  # @return [Collection]
@@ -377,7 +390,7 @@ module FlatApi
377
390
  end
378
391
 
379
392
  # Get collection details
380
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
393
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
381
394
  # @param [Hash] opts the optional parameters
382
395
  # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
383
396
  # @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
@@ -390,7 +403,7 @@ module FlatApi
390
403
  fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.get_collection"
391
404
  end
392
405
  # resource path
393
- local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
406
+ local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
394
407
 
395
408
  # query parameters
396
409
  query_params = opts[:query_params] || {}
@@ -399,7 +412,7 @@ module FlatApi
399
412
  # header parameters
400
413
  header_params = opts[:header_params] || {}
401
414
  # HTTP header 'Accept' (if needed)
402
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
415
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
403
416
 
404
417
  # form parameters
405
418
  form_params = opts[:form_params] || {}
@@ -432,14 +445,14 @@ module FlatApi
432
445
 
433
446
  # List the scores contained in a collection
434
447
  # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. For example, to list the scores contained in your app collection, you can use `GET /v2/collections/app/scores`.
435
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
448
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
436
449
  # @param [Hash] opts the optional parameters
437
- # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
438
450
  # @option opts [String] :sort Sort
439
451
  # @option opts [String] :direction Sort direction
440
452
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
441
453
  # @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.
442
454
  # @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.
455
+ # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
443
456
  # @return [Array<ScoreDetails>]
444
457
  def list_collection_scores(collection, opts = {})
445
458
  data, _status_code, _headers = list_collection_scores_with_http_info(collection, opts)
@@ -448,14 +461,14 @@ module FlatApi
448
461
 
449
462
  # List the scores contained in a collection
450
463
  # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by &#x60;modificationDate&#x60; &#x60;desc&#x60;. For example, to list the scores contained in your app collection, you can use &#x60;GET /v2/collections/app/scores&#x60;.
451
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
464
+ # @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - &#x60;root&#x60;: **Deprecated.** The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;trash&#x60;: Automatically contains resources that have been deleted The following virtual collections are supported: - &#x60;allScores&#x60;: All the scores contained in the user account - &#x60;collaborations&#x60;: All shared scores by the user or someone else - &#x60;likes&#x60;: Liked scores
452
465
  # @param [Hash] opts the optional parameters
453
- # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
454
466
  # @option opts [String] :sort Sort
455
467
  # @option opts [String] :direction Sort direction
456
468
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
457
469
  # @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.
458
470
  # @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.
471
+ # @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a &#x60;privacy&#x60; mode set to &#x60;privateLink&#x60; and the current user is not a collaborator of the document.
459
472
  # @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
460
473
  def list_collection_scores_with_http_info(collection, opts = {})
461
474
  if @api_client.config.debugging
@@ -482,21 +495,21 @@ module FlatApi
482
495
  end
483
496
 
484
497
  # resource path
485
- local_var_path = '/collections/{collection}/scores'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
498
+ local_var_path = '/collections/{collection}/scores'.sub('{collection}', CGI.escape(collection.to_s))
486
499
 
487
500
  # query parameters
488
501
  query_params = opts[:query_params] || {}
489
- query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
490
502
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
491
503
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
492
504
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
493
505
  query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
494
506
  query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
507
+ query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
495
508
 
496
509
  # header parameters
497
510
  header_params = opts[:header_params] || {}
498
511
  # HTTP header 'Accept' (if needed)
499
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
512
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
500
513
 
501
514
  # form parameters
502
515
  form_params = opts[:form_params] || {}
@@ -528,9 +541,9 @@ module FlatApi
528
541
  end
529
542
 
530
543
  # List the collections
531
- # Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`. Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`. To fetch your app collection details, you can use `GET /v2/collections/app`.
544
+ # Use this method to list the user's collections. If no sort option is provided, the collections are sorted by `creationDate` `desc`. By default (`parent=user`), this returns all user account collections with virtual collections on the first page. To fetch your app collection details, you can use `GET /v2/collections/app`.
532
545
  # @param [Hash] opts the optional parameters
533
- # @option opts [String] :parent List the collection contained in this &#x60;parent&#x60; collection. This option doesn&#39;t provide a complete multi-level collection support. When sharing a collection with someone, this one will have as &#x60;parent&#x60; &#x60;sharedWithMe&#x60;. (default to 'root')
546
+ # @option opts [String] :parent List the collections contained in this &#x60;parent&#x60; collection. When set to &#x60;user&#x60; (default), returns the user&#39;s own collections as well as collections shared with the user. Using &#x60;root&#x60; or &#x60;sharedWithMe&#x60; is **deprecated** and will be treated as &#x60;user&#x60;. (default to 'user')
534
547
  # @option opts [String] :sort Sort
535
548
  # @option opts [String] :direction Sort direction
536
549
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
@@ -543,9 +556,9 @@ module FlatApi
543
556
  end
544
557
 
545
558
  # List the collections
546
- # Use this method to list the user&#39;s collections contained in &#x60;parent&#x60; (by default in the &#x60;root&#x60; collection). If no sort option is provided, the collections are sorted by &#x60;creationDate&#x60; &#x60;desc&#x60;. Note that this method will not include the &#x60;parent&#x60; collection in the listing. For example, if you need the details of the &#x60;root&#x60; collection, you can use &#x60;GET /v2/collections/root&#x60;. To fetch your app collection details, you can use &#x60;GET /v2/collections/app&#x60;.
559
+ # Use this method to list the user&#39;s collections. If no sort option is provided, the collections are sorted by &#x60;creationDate&#x60; &#x60;desc&#x60;. By default (&#x60;parent&#x3D;user&#x60;), this returns all user account collections with virtual collections on the first page. To fetch your app collection details, you can use &#x60;GET /v2/collections/app&#x60;.
547
560
  # @param [Hash] opts the optional parameters
548
- # @option opts [String] :parent List the collection contained in this &#x60;parent&#x60; collection. This option doesn&#39;t provide a complete multi-level collection support. When sharing a collection with someone, this one will have as &#x60;parent&#x60; &#x60;sharedWithMe&#x60;. (default to 'root')
561
+ # @option opts [String] :parent List the collections contained in this &#x60;parent&#x60; collection. When set to &#x60;user&#x60; (default), returns the user&#39;s own collections as well as collections shared with the user. Using &#x60;root&#x60; or &#x60;sharedWithMe&#x60; is **deprecated** and will be treated as &#x60;user&#x60;. (default to 'user')
549
562
  # @option opts [String] :sort Sort
550
563
  # @option opts [String] :direction Sort direction
551
564
  # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
@@ -556,7 +569,7 @@ module FlatApi
556
569
  if @api_client.config.debugging
557
570
  @api_client.config.logger.debug 'Calling API: CollectionApi.list_collections ...'
558
571
  end
559
- allowable_values = ["creationDate", "title"]
572
+ allowable_values = ["creationDate", "modificationDate", "title"]
560
573
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
561
574
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
562
575
  end
@@ -587,7 +600,7 @@ module FlatApi
587
600
  # header parameters
588
601
  header_params = opts[:header_params] || {}
589
602
  # HTTP header 'Accept' (if needed)
590
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
603
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
591
604
 
592
605
  # form parameters
593
606
  form_params = opts[:form_params] || {}
@@ -619,20 +632,20 @@ module FlatApi
619
632
  end
620
633
 
621
634
  # Untrash a collection
622
- # This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
623
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
635
+ # **DEPRECATED** This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
636
+ # @param collection [String] Unique identifier of the collection.
624
637
  # @param [Hash] opts the optional parameters
625
- # @return [nil]
638
+ # @return [FlatErrorResponse]
626
639
  def untrash_collection(collection, opts = {})
627
- untrash_collection_with_http_info(collection, opts)
628
- nil
640
+ data, _status_code, _headers = untrash_collection_with_http_info(collection, opts)
641
+ data
629
642
  end
630
643
 
631
644
  # Untrash a collection
632
- # This method will restore the collection by removing it from the &#x60;trash&#x60; and add it back to the &#x60;root&#x60; collection.
633
- # @param collection [String] Unique identifier of the collection. The following aliases are supported: - &#x60;root&#x60;: The root collection of the account - &#x60;app&#x60;: Alias for the current app collection - &#x60;sharedWithMe&#x60;: Automatically contains new resources that have been shared individually - &#x60;trash&#x60;: Automatically contains resources that have been deleted
645
+ # **DEPRECATED** This method will restore the collection by removing it from the &#x60;trash&#x60; and add it back to the &#x60;root&#x60; collection.
646
+ # @param collection [String] Unique identifier of the collection.
634
647
  # @param [Hash] opts the optional parameters
635
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
648
+ # @return [Array<(FlatErrorResponse, Integer, Hash)>] FlatErrorResponse data, response status code and response headers
636
649
  def untrash_collection_with_http_info(collection, opts = {})
637
650
  if @api_client.config.debugging
638
651
  @api_client.config.logger.debug 'Calling API: CollectionApi.untrash_collection ...'
@@ -642,7 +655,7 @@ module FlatApi
642
655
  fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.untrash_collection"
643
656
  end
644
657
  # resource path
645
- local_var_path = '/collections/{collection}/untrash'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
658
+ local_var_path = '/collections/{collection}/untrash'.sub('{collection}', CGI.escape(collection.to_s))
646
659
 
647
660
  # query parameters
648
661
  query_params = opts[:query_params] || {}
@@ -650,7 +663,7 @@ module FlatApi
650
663
  # header parameters
651
664
  header_params = opts[:header_params] || {}
652
665
  # HTTP header 'Accept' (if needed)
653
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
666
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
654
667
 
655
668
  # form parameters
656
669
  form_params = opts[:form_params] || {}
@@ -659,7 +672,7 @@ module FlatApi
659
672
  post_body = opts[:debug_body]
660
673
 
661
674
  # return_type
662
- return_type = opts[:debug_return_type]
675
+ return_type = opts[:debug_return_type] || 'FlatErrorResponse'
663
676
 
664
677
  # auth_names
665
678
  auth_names = opts[:debug_auth_names] || ['OAuth2']