flat_api 0.2.0 → 0.3.5

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 (416) hide show
  1. checksums.yaml +5 -5
  2. data/lib/flat_api/api/account_api.rb +31 -21
  3. data/lib/flat_api/api/class_api.rb +1405 -405
  4. data/lib/flat_api/api/collection_api.rb +257 -169
  5. data/lib/flat_api/api/edu_resources_api.rb +851 -0
  6. data/lib/flat_api/api/group_api.rb +81 -55
  7. data/lib/flat_api/api/organization_api.rb +524 -180
  8. data/lib/flat_api/api/score_api.rb +944 -552
  9. data/lib/flat_api/api/task_api.rb +85 -0
  10. data/lib/flat_api/api/user_api.rb +112 -74
  11. data/lib/flat_api/api_client.rb +112 -107
  12. data/lib/flat_api/api_error.rb +24 -4
  13. data/lib/flat_api/configuration.rb +105 -16
  14. data/lib/flat_api/models/api_access_token.rb +268 -0
  15. data/lib/flat_api/models/app_scopes.rb +59 -0
  16. data/lib/flat_api/models/assignment.rb +192 -101
  17. data/lib/flat_api/models/assignment_capabilities.rb +283 -0
  18. data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +240 -0
  19. data/lib/flat_api/models/assignment_copy.rb +80 -169
  20. data/lib/flat_api/models/assignment_copy_response.rb +430 -0
  21. data/lib/flat_api/models/assignment_copy_to_class.rb +243 -0
  22. data/lib/flat_api/models/assignment_copy_to_resource_library.rb +233 -0
  23. data/lib/flat_api/models/assignment_submission.rb +249 -66
  24. data/lib/flat_api/models/assignment_submission_comment.rb +276 -0
  25. data/lib/flat_api/models/assignment_submission_comment_creation.rb +223 -0
  26. data/lib/flat_api/models/assignment_submission_comments.rb +225 -0
  27. data/lib/flat_api/models/assignment_submission_history.rb +384 -0
  28. data/lib/flat_api/models/assignment_submission_history_attachment.rb +235 -0
  29. data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
  30. data/lib/flat_api/models/assignment_submission_lti.rb +222 -0
  31. data/lib/flat_api/models/assignment_submission_playback_inner.rb +240 -0
  32. data/lib/flat_api/models/assignment_submission_state.rb +42 -0
  33. data/lib/flat_api/models/assignment_submission_update.rb +150 -50
  34. data/lib/flat_api/models/assignment_type.rb +44 -0
  35. data/lib/flat_api/models/assignment_update.rb +407 -0
  36. data/lib/flat_api/models/class_assignment.rb +613 -0
  37. data/lib/flat_api/models/class_assignment_all_of_canvas.rb +226 -0
  38. data/lib/flat_api/models/class_assignment_all_of_lti.rb +216 -0
  39. data/lib/flat_api/models/class_assignment_all_of_mfc.rb +226 -0
  40. data/lib/flat_api/models/class_assignment_update.rb +509 -0
  41. data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +217 -0
  42. data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +219 -0
  43. data/lib/flat_api/models/class_attachment_creation.rb +110 -41
  44. data/lib/flat_api/models/class_creation.rb +144 -43
  45. data/lib/flat_api/models/class_details.rb +175 -60
  46. data/lib/flat_api/models/class_details_canvas.rb +61 -34
  47. data/lib/flat_api/models/class_details_clever.rb +76 -48
  48. data/lib/flat_api/models/class_details_google_classroom.rb +66 -59
  49. data/lib/flat_api/models/class_details_google_drive.rb +63 -36
  50. data/lib/flat_api/models/class_details_issues.rb +218 -0
  51. data/lib/flat_api/models/class_details_issues_sync_inner.rb +270 -0
  52. data/lib/flat_api/models/class_details_lti.rb +65 -38
  53. data/lib/flat_api/models/class_details_mfc.rb +226 -0
  54. data/lib/flat_api/models/class_details_microsoft_graph.rb +215 -0
  55. data/lib/flat_api/models/class_grade_level.rb +43 -0
  56. data/lib/flat_api/models/class_roles.rb +18 -9
  57. data/lib/flat_api/models/class_state.rb +18 -9
  58. data/lib/flat_api/models/class_update.rb +144 -42
  59. data/lib/flat_api/models/collection.rb +138 -50
  60. data/lib/flat_api/models/collection_app.rb +236 -0
  61. data/lib/flat_api/models/collection_capabilities.rb +109 -47
  62. data/lib/flat_api/models/collection_creation.rb +132 -37
  63. data/lib/flat_api/models/collection_modification.rb +122 -35
  64. data/lib/flat_api/models/collection_privacy.rb +18 -9
  65. data/lib/flat_api/models/collection_type.rb +19 -9
  66. data/lib/flat_api/models/edu_library.rb +292 -0
  67. data/lib/flat_api/models/edu_resource.rb +366 -0
  68. data/lib/flat_api/models/edu_resource_capabilities.rb +236 -0
  69. data/lib/flat_api/models/edu_resource_copy.rb +223 -0
  70. data/lib/flat_api/models/edu_resource_creation.rb +301 -0
  71. data/lib/flat_api/models/edu_resource_folder.rb +216 -0
  72. data/lib/flat_api/models/edu_resource_lti_link.rb +223 -0
  73. data/lib/flat_api/models/edu_resource_move.rb +223 -0
  74. data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
  75. data/lib/flat_api/models/edu_resource_resource.rb +105 -0
  76. data/lib/flat_api/models/edu_resource_type.rb +40 -0
  77. data/lib/flat_api/models/edu_resource_update.rb +277 -0
  78. data/lib/flat_api/models/edu_resource_use_in_class.rb +233 -0
  79. data/lib/flat_api/models/flat_error_response.rb +79 -38
  80. data/lib/flat_api/models/flat_locales.rb +30 -10
  81. data/lib/flat_api/models/google_classroom_coursework.rb +76 -38
  82. data/lib/flat_api/models/google_classroom_submission.rb +84 -36
  83. data/lib/flat_api/models/group.rb +72 -44
  84. data/lib/flat_api/models/group_details.rb +92 -43
  85. data/lib/flat_api/models/group_type.rb +18 -9
  86. data/lib/flat_api/models/license_mode.rb +18 -9
  87. data/lib/flat_api/models/license_sources.rb +21 -9
  88. data/lib/flat_api/models/lms_name.rb +19 -9
  89. data/lib/flat_api/models/lti_credentials.rb +95 -46
  90. data/lib/flat_api/models/lti_credentials_creation.rb +91 -38
  91. data/lib/flat_api/models/media_attachment.rb +167 -70
  92. data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
  93. data/lib/flat_api/models/microsoft_graph_assignment.rb +248 -0
  94. data/lib/flat_api/models/microsoft_graph_submission.rb +240 -0
  95. data/lib/flat_api/models/organization_invitation.rb +139 -44
  96. data/lib/flat_api/models/organization_invitation_creation.rb +99 -35
  97. data/lib/flat_api/models/organization_roles.rb +18 -9
  98. data/lib/flat_api/models/organization_user_access_token_creation.rb +225 -0
  99. data/lib/flat_api/models/resource_collaborator.rb +181 -51
  100. data/lib/flat_api/models/resource_collaborator_creation.rb +74 -47
  101. data/lib/flat_api/models/resource_rights.rb +145 -42
  102. data/lib/flat_api/models/score_comment.rb +93 -56
  103. data/lib/flat_api/models/score_comment_context.rb +103 -59
  104. data/lib/flat_api/models/score_comment_creation.rb +70 -41
  105. data/lib/flat_api/models/score_comment_moderation.rb +260 -0
  106. data/lib/flat_api/models/score_comment_update.rb +82 -49
  107. data/lib/flat_api/models/score_comments_counts.rb +67 -40
  108. data/lib/flat_api/models/score_creation.rb +81 -225
  109. data/lib/flat_api/models/score_creation_builder_data.rb +298 -0
  110. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +230 -0
  111. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +322 -0
  112. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +274 -0
  113. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +269 -0
  114. data/lib/flat_api/models/score_creation_common.rb +268 -0
  115. data/lib/flat_api/models/score_creation_file_import.rb +324 -0
  116. data/lib/flat_api/models/score_creation_google_drive_import.rb +291 -0
  117. data/lib/flat_api/models/score_creation_type.rb +19 -9
  118. data/lib/flat_api/models/score_details.rb +272 -81
  119. data/lib/flat_api/models/score_fork.rb +88 -36
  120. data/lib/flat_api/models/score_license.rb +19 -9
  121. data/lib/flat_api/models/score_likes_counts.rb +83 -35
  122. data/lib/flat_api/models/score_modification.rb +180 -50
  123. data/lib/flat_api/models/score_plays_counts.rb +236 -0
  124. data/lib/flat_api/models/score_privacy.rb +18 -9
  125. data/lib/flat_api/models/score_revision.rb +80 -43
  126. data/lib/flat_api/models/score_revision_creation.rb +105 -40
  127. data/lib/flat_api/models/score_revision_statistics.rb +83 -36
  128. data/lib/flat_api/models/score_source.rb +61 -35
  129. data/lib/flat_api/models/score_summary.rb +124 -40
  130. data/lib/flat_api/models/score_track.rb +172 -51
  131. data/lib/flat_api/models/score_track_creation.rb +101 -39
  132. data/lib/flat_api/models/score_track_point.rb +70 -38
  133. data/lib/flat_api/models/score_track_purpose.rb +40 -0
  134. data/lib/flat_api/models/score_track_state.rb +18 -9
  135. data/lib/flat_api/models/score_track_type.rb +18 -9
  136. data/lib/flat_api/models/score_track_update.rb +88 -37
  137. data/lib/flat_api/models/score_views_counts.rb +62 -35
  138. data/lib/flat_api/models/task.rb +364 -0
  139. data/lib/flat_api/models/task_export_options.rb +218 -0
  140. data/lib/flat_api/models/task_progress.rb +226 -0
  141. data/lib/flat_api/models/task_result.rb +226 -0
  142. data/lib/flat_api/models/tutteo_product.rb +42 -0
  143. data/lib/flat_api/models/user_admin_update.rb +219 -41
  144. data/lib/flat_api/models/user_azure_details.rb +235 -0
  145. data/lib/flat_api/models/user_basics.rb +187 -55
  146. data/lib/flat_api/models/user_community_profile_links.rb +272 -0
  147. data/lib/flat_api/models/user_creation.rb +215 -49
  148. data/lib/flat_api/models/user_details.rb +258 -93
  149. data/lib/flat_api/models/user_details_admin.rb +220 -68
  150. data/lib/flat_api/models/user_details_admin_all_of_license.rb +278 -0
  151. data/lib/flat_api/models/user_public.rb +242 -79
  152. data/lib/flat_api/models/user_public_summary.rb +201 -61
  153. data/lib/flat_api/models/user_signin_link.rb +225 -0
  154. data/lib/flat_api/models/user_signin_link_creation.rb +217 -0
  155. data/lib/flat_api/version.rb +5 -5
  156. data/lib/flat_api.rb +78 -15
  157. data/spec/api/account_api_spec.rb +11 -10
  158. data/spec/api/class_api_spec.rb +212 -68
  159. data/spec/api/collection_api_spec.rb +36 -37
  160. data/spec/api/edu_resources_api_spec.rb +181 -0
  161. data/spec/api/group_api_spec.rb +14 -15
  162. data/spec/api/organization_api_spec.rb +78 -39
  163. data/spec/api/score_api_spec.rb +105 -91
  164. data/spec/api/task_api_spec.rb +47 -0
  165. data/spec/api/user_api_spec.rb +27 -25
  166. data/spec/models/api_access_token_spec.rb +66 -0
  167. data/spec/models/app_scopes_spec.rb +30 -0
  168. data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +42 -0
  169. data/spec/models/assignment_capabilities_spec.rb +60 -0
  170. data/spec/models/assignment_copy_response_spec.rb +124 -0
  171. data/spec/models/assignment_copy_spec.rb +13 -23
  172. data/spec/models/assignment_copy_to_class_spec.rb +48 -0
  173. data/spec/models/assignment_copy_to_resource_library_spec.rb +42 -0
  174. data/spec/models/assignment_spec.rb +51 -39
  175. data/spec/models/assignment_submission_comment_creation_spec.rb +36 -0
  176. data/spec/models/assignment_submission_comment_spec.rb +72 -0
  177. data/spec/models/assignment_submission_comments_spec.rb +42 -0
  178. data/spec/models/assignment_submission_history_attachment_spec.rb +48 -0
  179. data/spec/models/assignment_submission_history_spec.rb +112 -0
  180. data/spec/models/assignment_submission_history_state_spec.rb +30 -0
  181. data/spec/models/assignment_submission_lti_spec.rb +36 -0
  182. data/spec/models/assignment_submission_playback_inner_spec.rb +42 -0
  183. data/spec/models/assignment_submission_spec.rb +68 -32
  184. data/spec/models/assignment_submission_state_spec.rb +30 -0
  185. data/spec/models/assignment_submission_update_spec.rb +29 -23
  186. data/spec/models/assignment_type_spec.rb +30 -0
  187. data/spec/models/assignment_update_spec.rb +100 -0
  188. data/spec/models/class_assignment_all_of_canvas_spec.rb +42 -0
  189. data/spec/models/class_assignment_all_of_lti_spec.rb +36 -0
  190. data/spec/models/class_assignment_all_of_mfc_spec.rb +42 -0
  191. data/spec/models/class_assignment_spec.rb +216 -0
  192. data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +36 -0
  193. data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +36 -0
  194. data/spec/models/class_assignment_update_spec.rb +150 -0
  195. data/spec/models/class_attachment_creation_spec.rb +41 -23
  196. data/spec/models/class_creation_spec.rb +34 -18
  197. data/spec/models/class_details_canvas_spec.rb +12 -18
  198. data/spec/models/class_details_clever_spec.rb +21 -27
  199. data/spec/models/class_details_google_classroom_spec.rb +12 -30
  200. data/spec/models/class_details_google_drive_spec.rb +12 -18
  201. data/spec/models/class_details_issues_spec.rb +36 -0
  202. data/spec/models/class_details_issues_sync_inner_spec.rb +52 -0
  203. data/spec/models/class_details_lti_spec.rb +13 -19
  204. data/spec/models/class_details_mfc_spec.rb +42 -0
  205. data/spec/models/class_details_microsoft_graph_spec.rb +36 -0
  206. data/spec/models/class_details_spec.rb +68 -34
  207. data/spec/models/class_grade_level_spec.rb +30 -0
  208. data/spec/models/class_roles_spec.rb +10 -16
  209. data/spec/models/class_state_spec.rb +10 -16
  210. data/spec/models/class_update_spec.rb +34 -18
  211. data/spec/models/collection_app_spec.rb +48 -0
  212. data/spec/models/collection_capabilities_spec.rb +15 -21
  213. data/spec/models/collection_creation_spec.rb +17 -17
  214. data/spec/models/collection_modification_spec.rb +17 -17
  215. data/spec/models/collection_privacy_spec.rb +10 -16
  216. data/spec/models/collection_spec.rb +39 -27
  217. data/spec/models/collection_type_spec.rb +10 -16
  218. data/spec/models/edu_library_spec.rb +62 -0
  219. data/spec/models/edu_resource_capabilities_spec.rb +48 -0
  220. data/spec/models/edu_resource_copy_spec.rb +36 -0
  221. data/spec/models/edu_resource_creation_spec.rb +48 -0
  222. data/spec/models/edu_resource_folder_spec.rb +36 -0
  223. data/spec/models/edu_resource_lti_link_spec.rb +36 -0
  224. data/spec/models/edu_resource_move_spec.rb +36 -0
  225. data/spec/models/edu_resource_privacy_spec.rb +30 -0
  226. data/spec/models/edu_resource_resource_spec.rb +32 -0
  227. data/spec/models/edu_resource_spec.rb +96 -0
  228. data/spec/models/edu_resource_type_spec.rb +30 -0
  229. data/spec/models/edu_resource_update_spec.rb +42 -0
  230. data/spec/models/edu_resource_use_in_class_spec.rb +42 -0
  231. data/spec/models/flat_error_response_spec.rb +14 -20
  232. data/spec/models/flat_locales_spec.rb +10 -16
  233. data/spec/models/google_classroom_coursework_spec.rb +19 -19
  234. data/spec/models/google_classroom_submission_spec.rb +13 -19
  235. data/spec/models/group_details_spec.rb +17 -23
  236. data/spec/models/group_spec.rb +21 -27
  237. data/spec/models/group_type_spec.rb +10 -16
  238. data/spec/models/license_mode_spec.rb +10 -16
  239. data/spec/models/license_sources_spec.rb +10 -16
  240. data/spec/models/lms_name_spec.rb +10 -16
  241. data/spec/models/lti_credentials_creation_spec.rb +12 -18
  242. data/spec/models/lti_credentials_spec.rb +19 -25
  243. data/spec/models/media_attachment_spec.rb +67 -37
  244. data/spec/models/media_score_sharing_mode_spec.rb +10 -16
  245. data/spec/models/microsoft_graph_assignment_spec.rb +54 -0
  246. data/spec/models/microsoft_graph_submission_spec.rb +42 -0
  247. data/spec/models/organization_invitation_creation_spec.rb +16 -18
  248. data/spec/models/organization_invitation_spec.rb +29 -23
  249. data/spec/models/organization_roles_spec.rb +10 -16
  250. data/spec/models/organization_user_access_token_creation_spec.rb +36 -0
  251. data/spec/models/resource_collaborator_creation_spec.rb +17 -23
  252. data/spec/models/resource_collaborator_spec.rb +47 -25
  253. data/spec/models/resource_rights_spec.rb +29 -19
  254. data/spec/models/score_comment_context_spec.rb +23 -23
  255. data/spec/models/score_comment_creation_spec.rb +16 -22
  256. data/spec/models/score_comment_moderation_spec.rb +46 -0
  257. data/spec/models/score_comment_spec.rb +35 -35
  258. data/spec/models/score_comment_update_spec.rb +14 -20
  259. data/spec/models/score_comments_counts_spec.rb +14 -20
  260. data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +82 -0
  261. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +60 -0
  262. data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +66 -0
  263. data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +42 -0
  264. data/spec/models/score_creation_builder_data_spec.rb +60 -0
  265. data/spec/models/score_creation_common_spec.rb +54 -0
  266. data/spec/models/score_creation_file_import_spec.rb +76 -0
  267. data/spec/models/score_creation_google_drive_import_spec.rb +60 -0
  268. data/spec/models/score_creation_spec.rb +12 -58
  269. data/spec/models/score_creation_type_spec.rb +10 -16
  270. data/spec/models/score_details_spec.rb +75 -45
  271. data/spec/models/score_fork_spec.rb +23 -17
  272. data/spec/models/score_license_spec.rb +10 -16
  273. data/spec/models/score_likes_counts_spec.rb +13 -19
  274. data/spec/models/score_modification_spec.rb +47 -23
  275. data/spec/models/score_plays_counts_spec.rb +48 -0
  276. data/spec/models/score_privacy_spec.rb +10 -16
  277. data/spec/models/score_revision_creation_spec.rb +18 -20
  278. data/spec/models/score_revision_spec.rb +23 -23
  279. data/spec/models/score_revision_statistics_spec.rb +24 -18
  280. data/spec/models/score_source_spec.rb +11 -17
  281. data/spec/models/score_summary_spec.rb +16 -22
  282. data/spec/models/score_track_creation_spec.rb +21 -21
  283. data/spec/models/score_track_point_spec.rb +17 -23
  284. data/spec/models/score_track_purpose_spec.rb +30 -0
  285. data/spec/models/score_track_spec.rb +28 -28
  286. data/spec/models/score_track_state_spec.rb +10 -16
  287. data/spec/models/score_track_type_spec.rb +10 -16
  288. data/spec/models/score_track_update_spec.rb +14 -20
  289. data/spec/models/score_views_counts_spec.rb +13 -19
  290. data/spec/models/task_export_options_spec.rb +36 -0
  291. data/spec/models/task_progress_spec.rb +42 -0
  292. data/spec/models/task_result_spec.rb +42 -0
  293. data/spec/models/task_spec.rb +100 -0
  294. data/spec/models/tutteo_product_spec.rb +30 -0
  295. data/spec/models/user_admin_update_spec.rb +36 -18
  296. data/spec/models/user_azure_details_spec.rb +48 -0
  297. data/spec/models/user_basics_spec.rb +47 -25
  298. data/spec/models/user_community_profile_links_spec.rb +66 -0
  299. data/spec/models/user_creation_spec.rb +36 -20
  300. data/spec/models/user_details_admin_all_of_license_spec.rb +60 -0
  301. data/spec/models/user_details_admin_spec.rb +60 -32
  302. data/spec/models/user_details_spec.rb +93 -45
  303. data/spec/models/user_public_spec.rb +71 -37
  304. data/spec/models/user_public_summary_spec.rb +51 -29
  305. data/spec/models/user_signin_link_creation_spec.rb +36 -0
  306. data/spec/models/user_signin_link_spec.rb +42 -0
  307. data/spec/spec_helper.rb +4 -4
  308. metadata +279 -327
  309. data/CHANGELOG.md +0 -17
  310. data/Gemfile +0 -7
  311. data/README.md +0 -271
  312. data/Rakefile +0 -8
  313. data/docs/AccountApi.md +0 -55
  314. data/docs/Assignment.md +0 -18
  315. data/docs/AssignmentCopy.md +0 -8
  316. data/docs/AssignmentCreation.md +0 -12
  317. data/docs/AssignmentSubmission.md +0 -19
  318. data/docs/AssignmentSubmissionUpdate.md +0 -11
  319. data/docs/ClassApi.md +0 -1051
  320. data/docs/ClassAttachmentCreation.md +0 -10
  321. data/docs/ClassCreation.md +0 -9
  322. data/docs/ClassDetails.md +0 -25
  323. data/docs/ClassDetailsCanvas.md +0 -9
  324. data/docs/ClassDetailsClever.md +0 -14
  325. data/docs/ClassDetailsGoogleClassroom.md +0 -11
  326. data/docs/ClassDetailsGoogleDrive.md +0 -9
  327. data/docs/ClassDetailsLti.md +0 -10
  328. data/docs/ClassRoles.md +0 -7
  329. data/docs/ClassState.md +0 -7
  330. data/docs/ClassUpdate.md +0 -9
  331. data/docs/Collection.md +0 -18
  332. data/docs/CollectionApi.md +0 -521
  333. data/docs/CollectionCapabilities.md +0 -12
  334. data/docs/CollectionCreation.md +0 -8
  335. data/docs/CollectionModification.md +0 -8
  336. data/docs/CollectionPrivacy.md +0 -7
  337. data/docs/CollectionTitle.md +0 -7
  338. data/docs/CollectionType.md +0 -7
  339. data/docs/FlatErrorResponse.md +0 -11
  340. data/docs/FlatLocales.md +0 -7
  341. data/docs/GoogleClassroomCoursework.md +0 -10
  342. data/docs/GoogleClassroomSubmission.md +0 -10
  343. data/docs/Group.md +0 -14
  344. data/docs/GroupApi.md +0 -167
  345. data/docs/GroupDetails.md +0 -14
  346. data/docs/GroupType.md +0 -7
  347. data/docs/LicenseMode.md +0 -7
  348. data/docs/LicenseSources.md +0 -7
  349. data/docs/LmsName.md +0 -7
  350. data/docs/LtiCredentials.md +0 -16
  351. data/docs/LtiCredentialsCreation.md +0 -9
  352. data/docs/MediaAttachment.md +0 -23
  353. data/docs/MediaScoreSharingMode.md +0 -7
  354. data/docs/OrganizationApi.md +0 -538
  355. data/docs/OrganizationInvitation.md +0 -14
  356. data/docs/OrganizationInvitationCreation.md +0 -9
  357. data/docs/OrganizationRoles.md +0 -7
  358. data/docs/ResourceCollaborator.md +0 -16
  359. data/docs/ResourceCollaboratorCreation.md +0 -14
  360. data/docs/ResourceRights.md +0 -10
  361. data/docs/ResourceSharingKey.md +0 -7
  362. data/docs/ScoreApi.md +0 -1658
  363. data/docs/ScoreComment.md +0 -22
  364. data/docs/ScoreCommentContext.md +0 -14
  365. data/docs/ScoreCommentCreation.md +0 -13
  366. data/docs/ScoreCommentUpdate.md +0 -11
  367. data/docs/ScoreCommentsCounts.md +0 -11
  368. data/docs/ScoreCreation.md +0 -14
  369. data/docs/ScoreCreationType.md +0 -7
  370. data/docs/ScoreData.md +0 -7
  371. data/docs/ScoreDataEncoding.md +0 -7
  372. data/docs/ScoreDetails.md +0 -36
  373. data/docs/ScoreFork.md +0 -8
  374. data/docs/ScoreLicense.md +0 -7
  375. data/docs/ScoreLikesCounts.md +0 -10
  376. data/docs/ScoreModification.md +0 -14
  377. data/docs/ScorePrivacy.md +0 -7
  378. data/docs/ScoreRevision.md +0 -14
  379. data/docs/ScoreRevisionCreation.md +0 -11
  380. data/docs/ScoreRevisionStatistics.md +0 -9
  381. data/docs/ScoreSource.md +0 -8
  382. data/docs/ScoreSummary.md +0 -13
  383. data/docs/ScoreTrack.md +0 -19
  384. data/docs/ScoreTrackCreation.md +0 -12
  385. data/docs/ScoreTrackPoint.md +0 -10
  386. data/docs/ScoreTrackState.md +0 -7
  387. data/docs/ScoreTrackType.md +0 -7
  388. data/docs/ScoreTrackUpdate.md +0 -11
  389. data/docs/ScoreViewsCounts.md +0 -10
  390. data/docs/UserAdminUpdate.md +0 -9
  391. data/docs/UserApi.md +0 -173
  392. data/docs/UserBasics.md +0 -13
  393. data/docs/UserCreation.md +0 -11
  394. data/docs/UserDetails.md +0 -28
  395. data/docs/UserDetailsAdmin.md +0 -20
  396. data/docs/UserDetailsAdminLicense.md +0 -12
  397. data/docs/UserInstruments.md +0 -7
  398. data/docs/UserPublic.md +0 -25
  399. data/docs/UserPublicSummary.md +0 -17
  400. data/flat_api.gemspec +0 -48
  401. data/lib/flat_api/models/assignment_creation.rb +0 -230
  402. data/lib/flat_api/models/collection_title.rb +0 -179
  403. data/lib/flat_api/models/resource_sharing_key.rb +0 -179
  404. data/lib/flat_api/models/score_data.rb +0 -179
  405. data/lib/flat_api/models/score_data_encoding.rb +0 -30
  406. data/lib/flat_api/models/user_details_admin_license.rb +0 -227
  407. data/lib/flat_api/models/user_instruments.rb +0 -179
  408. data/spec/api_client_spec.rb +0 -226
  409. data/spec/configuration_spec.rb +0 -42
  410. data/spec/models/assignment_creation_spec.rb +0 -66
  411. data/spec/models/collection_title_spec.rb +0 -36
  412. data/spec/models/resource_sharing_key_spec.rb +0 -36
  413. data/spec/models/score_data_encoding_spec.rb +0 -36
  414. data/spec/models/score_data_spec.rb +0 -36
  415. data/spec/models/user_details_admin_license_spec.rb +0 -66
  416. data/spec/models/user_instruments_spec.rb +0 -36
data/docs/ScoreComment.md DELETED
@@ -1,22 +0,0 @@
1
- # FlatApi::ScoreComment
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The comment unique identifier | [optional]
7
- **type** | **String** | The type of the comment | [optional]
8
- **user** | **String** | The author unique identifier | [optional]
9
- **score** | **String** | The unique identifier of the score where the comment was posted | [optional]
10
- **revision** | **String** | The unique identifier of revision the comment was posted | [optional]
11
- **reply_to** | **String** | When the comment is a reply to another comment, the unique identifier of the parent comment | [optional]
12
- **date** | **DateTime** | The date when the comment was posted | [optional]
13
- **modification_date** | **DateTime** | The date of the last comment modification | [optional]
14
- **comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`. | [optional]
15
- **raw_comment** | **String** | A raw version of the comment, that can be displayed without parsing the mentions. | [optional]
16
- **context** | [**ScoreCommentContext**](ScoreCommentContext.md) | | [optional]
17
- **mentions** | **Array<String>** | The list of user identifier mentioned on the score | [optional]
18
- **resolved** | **BOOLEAN** | For inline comments, the comment can be marked as resolved and will be hidden in the future responses | [optional]
19
- **resolved_by** | **String** | If the user is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved | [optional]
20
- **spam** | **BOOLEAN** | `true if the message has been detected as spam and hidden from other users | [optional]
21
-
22
-
@@ -1,14 +0,0 @@
1
- # FlatApi::ScoreCommentContext
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **part_uuid** | **String** | The unique identifier (UUID) of the score part |
7
- **staff_idx** | **Float** | The identififer of the staff |
8
- **measure_uuids** | **Array<String>** | The list of measure UUIds |
9
- **start_time_pos** | **Float** | |
10
- **stop_time_pos** | **Float** | |
11
- **start_dpq** | **Float** | |
12
- **stop_dpq** | **Float** | |
13
-
14
-
@@ -1,13 +0,0 @@
1
- # FlatApi::ScoreCommentCreation
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created. | [optional]
7
- **comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`. |
8
- **raw_comment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set. | [optional]
9
- **mentions** | **Array<String>** | The list of user identifiers mentioned in this comment | [optional]
10
- **reply_to** | **String** | When the comment is a reply to another comment, the unique identifier of the parent comment | [optional]
11
- **context** | [**ScoreCommentContext**](ScoreCommentContext.md) | | [optional]
12
-
13
-
@@ -1,11 +0,0 @@
1
- # FlatApi::ScoreCommentUpdate
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created. | [optional]
7
- **comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`. | [optional]
8
- **raw_comment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set. | [optional]
9
- **context** | [**ScoreCommentContext**](ScoreCommentContext.md) | | [optional]
10
-
11
-
@@ -1,11 +0,0 @@
1
- # FlatApi::ScoreCommentsCounts
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **total** | **Float** | The total number of comments added on the score | [optional]
7
- **unique** | **Float** | The unique (1/user) number of comments added on the score | [optional]
8
- **weekly** | **Float** | The weekly unique number of comments added on the score | [optional]
9
- **monthly** | **Float** | The monthly unique number of comments added on the score | [optional]
10
-
11
-
@@ -1,14 +0,0 @@
1
- # FlatApi::ScoreCreation
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **title** | **String** | The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Set a default title (e.g. \"New Music Score\") | [optional]
7
- **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | |
8
- **data** | [**ScoreData**](ScoreData.md) | | [optional]
9
- **data_encoding** | [**ScoreDataEncoding**](ScoreDataEncoding.md) | | [optional]
10
- **source** | [**ScoreSource**](ScoreSource.md) | | [optional]
11
- **collection** | **String** | Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the `root` directory. | [optional]
12
- **google_drive_folder** | **String** | If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory. | [optional]
13
-
14
-
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreCreationType
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
data/docs/ScoreData.md DELETED
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreData
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreDataEncoding
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
data/docs/ScoreDetails.md DELETED
@@ -1,36 +0,0 @@
1
- # FlatApi::ScoreDetails
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the score | [optional]
7
- **sharing_key** | **String** | The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) | [optional]
8
- **title** | **String** | The title of the score | [optional]
9
- **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional]
10
- **user** | [**UserPublicSummary**](UserPublicSummary.md) | | [optional]
11
- **html_url** | **String** | The url where the score can be viewed in a web browser | [optional]
12
- **subtitle** | **String** | Subtitle of the score | [optional]
13
- **lyricist** | **String** | Lyricist of the score | [optional]
14
- **composer** | **String** | Composer of the score | [optional]
15
- **description** | **String** | Description of the creation | [optional]
16
- **tags** | **Array<String>** | Tags describing the score | [optional]
17
- **creation_type** | [**ScoreCreationType**](ScoreCreationType.md) | | [optional]
18
- **license** | [**ScoreLicense**](ScoreLicense.md) | | [optional]
19
- **license_text** | **String** | Additional license text written on the exported/printed score | [optional]
20
- **duration_time** | **Integer** | In seconds, an approximative duration of the score | [optional]
21
- **number_measures** | **Integer** | The number of measures in the score | [optional]
22
- **main_tempo_qpm** | **Integer** | The main tempo of the score (in QPM) | [optional]
23
- **rights** | [**ResourceRights**](ResourceRights.md) | | [optional]
24
- **collaborators** | [**Array<ResourceCollaborator>**](ResourceCollaborator.md) | The list of the collaborators of the score | [optional]
25
- **creation_date** | **DateTime** | The date when the score was created | [optional]
26
- **modification_date** | **DateTime** | The date of the last revision of the score | [optional]
27
- **publication_date** | **DateTime** | The date when the score was published on Flat | [optional]
28
- **organization** | **String** | If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`. | [optional]
29
- **parent_score** | **String** | If the score has been forked, the unique identifier of the parent score. | [optional]
30
- **instruments** | **Array<String>** | An array of the instrument identifiers used in the last version of the score. This is mainly used to display a list of the instruments in the Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`. | [optional]
31
- **google_drive_file_id** | **String** | If the user uses Google Drive and the score exists on Google Drive, this field will contain the unique identifier of the Flat score on Google Drive. You can access the document using the url: `https://drive.google.com/open?id={googleDriveFileId}` | [optional]
32
- **likes** | [**ScoreLikesCounts**](ScoreLikesCounts.md) | | [optional]
33
- **comments** | [**ScoreCommentsCounts**](ScoreCommentsCounts.md) | | [optional]
34
- **views** | [**ScoreViewsCounts**](ScoreViewsCounts.md) | | [optional]
35
-
36
-
data/docs/ScoreFork.md DELETED
@@ -1,8 +0,0 @@
1
- # FlatApi::ScoreFork
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **collection** | **String** | Unique identifier of a collection where the score will be copied. If no collection identifier is provided, the score will be stored in the `root` directory. | [optional]
7
-
8
-
data/docs/ScoreLicense.md DELETED
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreLicense
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,10 +0,0 @@
1
- # FlatApi::ScoreLikesCounts
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **total** | **Float** | The total number of likes of the score | [optional]
7
- **weekly** | **Float** | The number of new likes during the last week | [optional]
8
- **monthly** | **Float** | The number of new likes during the last month | [optional]
9
-
10
-
@@ -1,14 +0,0 @@
1
- # FlatApi::ScoreModification
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **title** | **String** | The title of the score | [optional]
7
- **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional]
8
- **sharing_key** | [**ResourceSharingKey**](ResourceSharingKey.md) | | [optional]
9
- **description** | **String** | Description of the creation | [optional]
10
- **tags** | **Array<String>** | Tags describing the score | [optional]
11
- **creation_type** | [**ScoreCreationType**](ScoreCreationType.md) | | [optional]
12
- **license** | [**ScoreLicense**](ScoreLicense.md) | | [optional]
13
-
14
-
data/docs/ScorePrivacy.md DELETED
@@ -1,7 +0,0 @@
1
- # FlatApi::ScorePrivacy
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,14 +0,0 @@
1
- # FlatApi::ScoreRevision
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the revision. | [optional]
7
- **user** | **String** | The user identifier who created the revision | [optional]
8
- **collaborators** | **Array<String>** | | [optional]
9
- **creation_date** | **DateTime** | The date when this revision was created | [optional]
10
- **description** | **String** | A description associated to the revision | [optional]
11
- **autosave** | **BOOLEAN** | True if this revision was automatically generated by Flat and not on purpose by the user. | [optional]
12
- **statistics** | [**ScoreRevisionStatistics**](ScoreRevisionStatistics.md) | | [optional]
13
-
14
-
@@ -1,11 +0,0 @@
1
- # FlatApi::ScoreRevisionCreation
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**ScoreData**](ScoreData.md) | |
7
- **data_encoding** | [**ScoreDataEncoding**](ScoreDataEncoding.md) | | [optional]
8
- **autosave** | **BOOLEAN** | Must be set to `true` if the revision was created automatically. | [optional]
9
- **description** | **String** | A description associated to the revision | [optional]
10
-
11
-
@@ -1,9 +0,0 @@
1
- # FlatApi::ScoreRevisionStatistics
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **additions** | **Float** | The number of additions operations in the last revision | [optional]
7
- **deletions** | **Float** | The number of deletions operations in the last revision | [optional]
8
-
9
-
data/docs/ScoreSource.md DELETED
@@ -1,8 +0,0 @@
1
- # FlatApi::ScoreSource
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **google_drive** | **String** | If the score is a file on Google Drive, this field property must contain its identifier. To use this method, the Drive file must be public or the Flat Drive App must have access to the file. | [optional]
7
-
8
-
data/docs/ScoreSummary.md DELETED
@@ -1,13 +0,0 @@
1
- # FlatApi::ScoreSummary
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the score | [optional]
7
- **sharing_key** | **String** | The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) | [optional]
8
- **title** | **String** | The title of the score | [optional]
9
- **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional]
10
- **user** | [**UserPublicSummary**](UserPublicSummary.md) | | [optional]
11
- **html_url** | **String** | The url where the score can be viewed in a web browser | [optional]
12
-
13
-
data/docs/ScoreTrack.md DELETED
@@ -1,19 +0,0 @@
1
- # FlatApi::ScoreTrack
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the score track | [optional]
7
- **title** | **String** | Title of the track | [optional]
8
- **score** | **String** | The unique identifier of the score | [optional]
9
- **creator** | **String** | The unique identifier of the track creator | [optional]
10
- **creation_date** | **DateTime** | The creation date of the track | [optional]
11
- **modification_date** | **DateTime** | The modification date of the track | [optional]
12
- **default** | **BOOLEAN** | True if the track should be used as default audio source | [optional]
13
- **state** | [**ScoreTrackState**](ScoreTrackState.md) | | [optional]
14
- **type** | [**ScoreTrackType**](ScoreTrackType.md) | | [optional]
15
- **url** | **String** | The URL of the track | [optional]
16
- **media_id** | **String** | The unique identifier of the track when hosted on an external service. For example, if the url is `https://www.youtube.com/watch?v=dQw4w9WgXcQ`, `mediaId` will be `dQw4w9WgXcQ` | [optional]
17
- **synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) | | [optional]
18
-
19
-
@@ -1,12 +0,0 @@
1
- # FlatApi::ScoreTrackCreation
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **title** | **String** | Title of the track | [optional]
7
- **default** | **BOOLEAN** | True if the track should be used as default audio source | [optional]
8
- **state** | [**ScoreTrackState**](ScoreTrackState.md) | | [optional]
9
- **url** | **String** | The URL of the track | [optional]
10
- **synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) | | [optional]
11
-
12
-
@@ -1,10 +0,0 @@
1
- # FlatApi::ScoreTrackPoint
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The type of the synchronization point. If the type is `measure`, the measure uuid must be present in `measureUuid` |
7
- **measure_uuid** | **String** | The measure unique identifier | [optional]
8
- **time** | **Float** | The corresponding time in seconds |
9
-
10
-
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreTrackState
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,7 +0,0 @@
1
- # FlatApi::ScoreTrackType
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,11 +0,0 @@
1
- # FlatApi::ScoreTrackUpdate
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **title** | **String** | Title of the track | [optional]
7
- **default** | **BOOLEAN** | True if the track should be used as default audio source | [optional]
8
- **state** | [**ScoreTrackState**](ScoreTrackState.md) | | [optional]
9
- **synchronization_points** | [**Array<ScoreTrackPoint>**](ScoreTrackPoint.md) | | [optional]
10
-
11
-
@@ -1,10 +0,0 @@
1
- # FlatApi::ScoreViewsCounts
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **total** | **Float** | The total number of views of the score | [optional]
7
- **weekly** | **Float** | The weekly number of views of the score | [optional]
8
- **monthly** | **Float** | The monthly number of views of the score | [optional]
9
-
10
-
@@ -1,9 +0,0 @@
1
- # FlatApi::UserAdminUpdate
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **password** | **String** | Password of the new account | [optional]
7
- **organization_role** | [**OrganizationRoles**](OrganizationRoles.md) | | [optional]
8
-
9
-
data/docs/UserApi.md DELETED
@@ -1,173 +0,0 @@
1
- # FlatApi::UserApi
2
-
3
- All URIs are relative to *https://api.flat.io/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**ger_user_likes**](UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
8
- [**get_user**](UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile
9
- [**get_user_scores**](UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
10
-
11
-
12
- # **ger_user_likes**
13
- > Array<ScoreDetails> ger_user_likes(user, opts)
14
-
15
- List liked scores
16
-
17
- ### Example
18
- ```ruby
19
- # load the gem
20
- require 'flat_api'
21
- # setup authorization
22
- FlatApi.configure do |config|
23
- # Configure OAuth2 access token for authorization: OAuth2
24
- config.access_token = 'YOUR ACCESS TOKEN'
25
- end
26
-
27
- api_instance = FlatApi::UserApi.new
28
-
29
- user = "user_example" # String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
30
-
31
- opts = {
32
- ids: true # BOOLEAN | Return only the identifiers of the scores
33
- }
34
-
35
- begin
36
- #List liked scores
37
- result = api_instance.ger_user_likes(user, opts)
38
- p result
39
- rescue FlatApi::ApiError => e
40
- puts "Exception when calling UserApi->ger_user_likes: #{e}"
41
- end
42
- ```
43
-
44
- ### Parameters
45
-
46
- Name | Type | Description | Notes
47
- ------------- | ------------- | ------------- | -------------
48
- **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. |
49
- **ids** | **BOOLEAN**| Return only the identifiers of the scores | [optional]
50
-
51
- ### Return type
52
-
53
- [**Array<ScoreDetails>**](ScoreDetails.md)
54
-
55
- ### Authorization
56
-
57
- [OAuth2](../README.md#OAuth2)
58
-
59
- ### HTTP request headers
60
-
61
- - **Content-Type**: application/json
62
- - **Accept**: application/json
63
-
64
-
65
-
66
- # **get_user**
67
- > UserPublic get_user(user)
68
-
69
- Get a public user profile
70
-
71
- Get a public profile of a Flat User.
72
-
73
- ### Example
74
- ```ruby
75
- # load the gem
76
- require 'flat_api'
77
- # setup authorization
78
- FlatApi.configure do |config|
79
- # Configure OAuth2 access token for authorization: OAuth2
80
- config.access_token = 'YOUR ACCESS TOKEN'
81
- end
82
-
83
- api_instance = FlatApi::UserApi.new
84
-
85
- user = "user_example" # String | This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user.
86
-
87
-
88
- begin
89
- #Get a public user profile
90
- result = api_instance.get_user(user)
91
- p result
92
- rescue FlatApi::ApiError => e
93
- puts "Exception when calling UserApi->get_user: #{e}"
94
- end
95
- ```
96
-
97
- ### Parameters
98
-
99
- Name | Type | Description | Notes
100
- ------------- | ------------- | ------------- | -------------
101
- **user** | **String**| This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user. |
102
-
103
- ### Return type
104
-
105
- [**UserPublic**](UserPublic.md)
106
-
107
- ### Authorization
108
-
109
- [OAuth2](../README.md#OAuth2)
110
-
111
- ### HTTP request headers
112
-
113
- - **Content-Type**: application/json
114
- - **Accept**: application/json
115
-
116
-
117
-
118
- # **get_user_scores**
119
- > Array<ScoreDetails> get_user_scores(user, opts)
120
-
121
- List user's scores
122
-
123
- Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead.
124
-
125
- ### Example
126
- ```ruby
127
- # load the gem
128
- require 'flat_api'
129
- # setup authorization
130
- FlatApi.configure do |config|
131
- # Configure OAuth2 access token for authorization: OAuth2
132
- config.access_token = 'YOUR ACCESS TOKEN'
133
- end
134
-
135
- api_instance = FlatApi::UserApi.new
136
-
137
- user = "user_example" # String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
138
-
139
- opts = {
140
- parent: "parent_example" # String | Filter the score forked from the score id `parent`
141
- }
142
-
143
- begin
144
- #List user's scores
145
- result = api_instance.get_user_scores(user, opts)
146
- p result
147
- rescue FlatApi::ApiError => e
148
- puts "Exception when calling UserApi->get_user_scores: #{e}"
149
- end
150
- ```
151
-
152
- ### Parameters
153
-
154
- Name | Type | Description | Notes
155
- ------------- | ------------- | ------------- | -------------
156
- **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. |
157
- **parent** | **String**| Filter the score forked from the score id `parent` | [optional]
158
-
159
- ### Return type
160
-
161
- [**Array<ScoreDetails>**](ScoreDetails.md)
162
-
163
- ### Authorization
164
-
165
- [OAuth2](../README.md#OAuth2)
166
-
167
- ### HTTP request headers
168
-
169
- - **Content-Type**: application/json
170
- - **Accept**: application/json
171
-
172
-
173
-
data/docs/UserBasics.md DELETED
@@ -1,13 +0,0 @@
1
- # FlatApi::UserBasics
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The user unique identifier | [optional]
7
- **username** | **String** | The user name (unique for the organization) | [optional]
8
- **name** | **String** | A displayable name for the user | [optional]
9
- **printable_name** | **String** | The name that can be directly printed (name or username) | [optional]
10
- **picture** | **String** | User pictue | [optional]
11
- **is_power_user** | **BOOLEAN** | User license status. 'True' if user is an individual Power user | [optional]
12
-
13
-
data/docs/UserCreation.md DELETED
@@ -1,11 +0,0 @@
1
- # FlatApi::UserCreation
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **username** | **String** | Username of the new account |
7
- **email** | **String** | Email of the new account | [optional]
8
- **password** | **String** | Password of the new account |
9
- **locale** | [**FlatLocales**](FlatLocales.md) | | [optional]
10
-
11
-
data/docs/UserDetails.md DELETED
@@ -1,28 +0,0 @@
1
- # FlatApi::UserDetails
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | Identifier of the user | [optional]
7
- **username** | **String** | The user name (unique for the organization) | [optional]
8
- **name** | **String** | A displayable name for the user | [optional]
9
- **printable_name** | **String** | The name that can be directly printed (name or username) | [optional]
10
- **picture** | **String** | User pictue | [optional]
11
- **is_power_user** | **BOOLEAN** | User license status. 'True' if user is an individual Power user | [optional]
12
- **organization** | **String** | Organization ID (for Edu users only) | [optional]
13
- **organization_role** | [**OrganizationRoles**](OrganizationRoles.md) | | [optional]
14
- **class_role** | [**ClassRoles**](ClassRoles.md) | | [optional]
15
- **html_url** | **String** | Link to user profile (for Indiv. users only) | [optional]
16
- **bio** | **String** | User's biography | [optional]
17
- **registration_date** | **DateTime** | Date the user signed up | [optional]
18
- **liked_scores_count** | **Integer** | Number of the scores liked by the user | [optional]
19
- **followers_count** | **Integer** | Number of followers the user have | [optional]
20
- **following_count** | **Integer** | Number of people the user follow | [optional]
21
- **owned_public_scores_count** | **Integer** | Number of public scores the user have | [optional]
22
- **profile_theme** | **String** | Theme (background) for the profile | [optional]
23
- **instruments** | [**UserInstruments**](UserInstruments.md) | | [optional]
24
- **type** | **String** | The type of account | [optional]
25
- **private_profile** | **BOOLEAN** | Tell either this user profile is private or not (individual accounts only) | [optional]
26
- **locale** | [**FlatLocales**](FlatLocales.md) | | [optional]
27
-
28
-
@@ -1,20 +0,0 @@
1
- # FlatApi::UserDetailsAdmin
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The user unique identifier | [optional]
7
- **username** | **String** | The user name (unique for the organization) | [optional]
8
- **name** | **String** | A displayable name for the user | [optional]
9
- **printable_name** | **String** | The name that can be directly printed (name or username) | [optional]
10
- **picture** | **String** | User pictue | [optional]
11
- **is_power_user** | **BOOLEAN** | User license status. 'True' if user is an individual Power user | [optional]
12
- **organization** | **String** | Organization ID (for Edu users only) | [optional]
13
- **organization_role** | [**OrganizationRoles**](OrganizationRoles.md) | | [optional]
14
- **class_role** | [**ClassRoles**](ClassRoles.md) | | [optional]
15
- **html_url** | **String** | Link to user profile (for Indiv. users only) | [optional]
16
- **email** | **String** | Email of the user | [optional]
17
- **last_activity_date** | **DateTime** | Date of the last user activity | [optional]
18
- **license** | [**UserDetailsAdminLicense**](UserDetailsAdminLicense.md) | | [optional]
19
-
20
-
@@ -1,12 +0,0 @@
1
- # FlatApi::UserDetailsAdminLicense
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | ID of the current license | [optional]
7
- **expiration_date** | **DateTime** | Date when the license expires | [optional]
8
- **source** | [**LicenseSources**](LicenseSources.md) | | [optional]
9
- **mode** | [**LicenseMode**](LicenseMode.md) | | [optional]
10
- **active** | **BOOLEAN** | ID of the current license | [optional]
11
-
12
-
@@ -1,7 +0,0 @@
1
- # FlatApi::UserInstruments
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-