flat_api 0.2.0 → 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 (410) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +60 -8
  3. data/LICENSE +201 -0
  4. data/README.md +62 -241
  5. data/lib/flat_api/api/account_api.rb +32 -22
  6. data/lib/flat_api/api/class_api.rb +1671 -453
  7. data/lib/flat_api/api/collection_api.rb +286 -185
  8. data/lib/flat_api/api/edu_resources_api.rb +863 -0
  9. data/lib/flat_api/api/group_api.rb +506 -57
  10. data/lib/flat_api/api/omr_api.rb +894 -0
  11. data/lib/flat_api/api/organization_api.rb +808 -192
  12. data/lib/flat_api/api/score_api.rb +1030 -589
  13. data/lib/flat_api/api/task_api.rb +85 -0
  14. data/lib/flat_api/api/user_api.rb +151 -82
  15. data/lib/flat_api/api_client.rb +223 -145
  16. data/lib/flat_api/api_error.rb +24 -4
  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 +224 -36
  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 +201 -0
  24. data/lib/flat_api/models/app_scopes.rb +61 -0
  25. data/lib/flat_api/models/assignment.rb +362 -166
  26. data/lib/flat_api/models/assignment_capabilities.rb +256 -0
  27. data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +193 -0
  28. data/lib/flat_api/models/assignment_copy.rb +79 -169
  29. data/lib/flat_api/models/assignment_copy_response.rb +535 -0
  30. data/lib/flat_api/models/assignment_copy_to_class.rb +186 -0
  31. data/lib/flat_api/models/assignment_copy_to_resource_library.rb +176 -0
  32. data/lib/flat_api/models/assignment_group.rb +232 -0
  33. data/lib/flat_api/models/assignment_submission.rb +337 -131
  34. data/lib/flat_api/models/assignment_submission_comment.rb +209 -0
  35. data/lib/flat_api/models/assignment_submission_comment_creation.rb +166 -0
  36. data/lib/flat_api/models/assignment_submission_comments.rb +158 -0
  37. data/lib/flat_api/models/assignment_submission_history.rb +337 -0
  38. data/lib/flat_api/models/assignment_submission_history_attachment.rb +168 -0
  39. data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
  40. data/lib/flat_api/models/assignment_submission_lti.rb +200 -0
  41. data/lib/flat_api/models/assignment_submission_playback.rb +193 -0
  42. data/lib/flat_api/models/assignment_submission_state.rb +42 -0
  43. data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
  44. data/lib/flat_api/models/assignment_submission_update.rb +157 -113
  45. data/lib/flat_api/models/assignment_type.rb +45 -0
  46. data/lib/flat_api/models/assignment_update.rb +538 -0
  47. data/lib/flat_api/models/class_assignment.rb +750 -0
  48. data/lib/flat_api/models/class_assignment_all_of_canvas.rb +159 -0
  49. data/lib/flat_api/models/class_assignment_all_of_lti.rb +149 -0
  50. data/lib/flat_api/models/class_assignment_all_of_mfc.rb +159 -0
  51. data/lib/flat_api/models/class_assignment_update.rb +652 -0
  52. data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +150 -0
  53. data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +152 -0
  54. data/lib/flat_api/models/class_attachment_creation.rb +140 -106
  55. data/lib/flat_api/models/class_creation.rb +142 -108
  56. data/lib/flat_api/models/class_details.rb +244 -125
  57. data/lib/flat_api/models/class_details_canvas.rb +59 -99
  58. data/lib/flat_api/models/class_details_clever.rb +74 -113
  59. data/lib/flat_api/models/class_details_google_classroom.rb +64 -124
  60. data/lib/flat_api/models/class_details_google_drive.rb +61 -101
  61. data/lib/flat_api/models/class_details_issues.rb +151 -0
  62. data/lib/flat_api/models/class_details_issues_sync_inner.rb +203 -0
  63. data/lib/flat_api/models/class_details_lti.rb +76 -106
  64. data/lib/flat_api/models/class_details_mfc.rb +159 -0
  65. data/lib/flat_api/models/class_details_microsoft_graph.rb +148 -0
  66. data/lib/flat_api/models/class_grade_level.rb +43 -0
  67. data/lib/flat_api/models/class_roles.rb +18 -9
  68. data/lib/flat_api/models/class_state.rb +19 -9
  69. data/lib/flat_api/models/class_update.rb +142 -107
  70. data/lib/flat_api/models/collection.rb +304 -115
  71. data/lib/flat_api/models/collection_app.rb +169 -0
  72. data/lib/flat_api/models/collection_capabilities.rb +157 -112
  73. data/lib/flat_api/models/collection_contents.rb +166 -0
  74. data/lib/flat_api/models/collection_creation.rb +120 -104
  75. data/lib/flat_api/models/collection_modification.rb +122 -100
  76. data/lib/flat_api/models/collection_privacy.rb +18 -9
  77. data/lib/flat_api/models/collection_type.rb +22 -11
  78. data/lib/flat_api/models/credit_transaction.rb +388 -0
  79. data/lib/flat_api/models/edu_library.rb +273 -0
  80. data/lib/flat_api/models/edu_resource.rb +383 -0
  81. data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
  82. data/lib/flat_api/models/edu_resource_capabilities.rb +179 -0
  83. data/lib/flat_api/models/edu_resource_copy.rb +166 -0
  84. data/lib/flat_api/models/edu_resource_creation.rb +311 -0
  85. data/lib/flat_api/models/edu_resource_folder.rb +171 -0
  86. data/lib/flat_api/models/edu_resource_lti_link.rb +166 -0
  87. data/lib/flat_api/models/edu_resource_move.rb +166 -0
  88. data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
  89. data/lib/flat_api/models/edu_resource_resource.rb +104 -0
  90. data/lib/flat_api/models/edu_resource_type.rb +40 -0
  91. data/lib/flat_api/models/edu_resource_update.rb +292 -0
  92. data/lib/flat_api/models/edu_resource_use_in_class.rb +176 -0
  93. data/lib/flat_api/models/flat_error_response.rb +109 -105
  94. data/lib/flat_api/models/google_classroom_coursework.rb +74 -103
  95. data/lib/flat_api/models/google_classroom_submission.rb +112 -101
  96. data/lib/flat_api/models/grade.rb +51 -0
  97. data/lib/flat_api/models/group.rb +70 -122
  98. data/lib/flat_api/models/group_creation.rb +238 -0
  99. data/lib/flat_api/models/group_details.rb +253 -110
  100. data/lib/flat_api/models/group_type.rb +20 -9
  101. data/lib/flat_api/models/license_mode.rb +18 -9
  102. data/lib/flat_api/models/license_sources.rb +21 -9
  103. data/lib/flat_api/models/lms_name.rb +19 -9
  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 +108 -114
  128. data/lib/flat_api/models/lti_credentials_creation.rb +99 -103
  129. data/lib/flat_api/models/media_attachment.rb +189 -137
  130. data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
  131. data/lib/flat_api/models/microsoft_graph_assignment.rb +259 -0
  132. data/lib/flat_api/models/microsoft_graph_submission.rb +193 -0
  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 +177 -109
  154. data/lib/flat_api/models/organization_invitation_creation.rb +97 -100
  155. data/lib/flat_api/models/organization_roles.rb +19 -10
  156. data/lib/flat_api/models/organization_user_access_token_creation.rb +168 -0
  157. data/lib/flat_api/models/rename_group_request.rb +165 -0
  158. data/lib/flat_api/models/resource_collaborator.rb +204 -116
  159. data/lib/flat_api/models/resource_collaborator_creation.rb +72 -112
  160. data/lib/flat_api/models/resource_rights.rb +168 -107
  161. data/lib/flat_api/models/score_comment.rb +200 -121
  162. data/lib/flat_api/models/score_comment_context.rb +161 -124
  163. data/lib/flat_api/models/score_comment_creation.rb +79 -107
  164. data/lib/flat_api/models/score_comment_moderation.rb +193 -0
  165. data/lib/flat_api/models/score_comment_update.rb +81 -115
  166. data/lib/flat_api/models/score_comments_counts.rb +78 -108
  167. data/lib/flat_api/models/score_creation.rb +80 -225
  168. data/lib/flat_api/models/score_creation_builder_data.rb +234 -0
  169. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +173 -0
  170. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +255 -0
  171. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +217 -0
  172. data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +222 -0
  173. data/lib/flat_api/models/score_creation_common.rb +201 -0
  174. data/lib/flat_api/models/score_creation_file_import.rb +277 -0
  175. data/lib/flat_api/models/score_creation_google_drive_import.rb +234 -0
  176. data/lib/flat_api/models/score_creation_type.rb +18 -9
  177. data/lib/flat_api/models/score_details.rb +428 -146
  178. data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
  179. data/lib/flat_api/models/score_fork.rb +84 -101
  180. data/lib/flat_api/models/score_license.rb +18 -9
  181. data/lib/flat_api/models/score_likes_counts.rb +73 -103
  182. data/lib/flat_api/models/score_modification.rb +178 -115
  183. data/lib/flat_api/models/score_plays_counts.rb +179 -0
  184. data/lib/flat_api/models/score_privacy.rb +18 -9
  185. data/lib/flat_api/models/score_revision.rb +142 -111
  186. data/lib/flat_api/models/score_revision_creation.rb +113 -105
  187. data/lib/flat_api/models/score_revision_statistics.rb +81 -101
  188. data/lib/flat_api/models/score_source.rb +59 -100
  189. data/lib/flat_api/models/score_summary.rb +172 -105
  190. data/lib/flat_api/models/score_track.rb +244 -117
  191. data/lib/flat_api/models/score_track_creation.rb +99 -104
  192. data/lib/flat_api/models/score_track_creation_response.rb +165 -0
  193. data/lib/flat_api/models/score_track_point.rb +78 -103
  194. data/lib/flat_api/models/score_track_purpose.rb +40 -0
  195. data/lib/flat_api/models/score_track_state.rb +18 -9
  196. data/lib/flat_api/models/score_track_type.rb +18 -9
  197. data/lib/flat_api/models/score_track_update.rb +98 -103
  198. data/lib/flat_api/models/score_views_counts.rb +73 -103
  199. data/lib/flat_api/models/task.rb +339 -0
  200. data/lib/flat_api/models/task_export_options.rb +151 -0
  201. data/lib/flat_api/models/task_progress.rb +159 -0
  202. data/lib/flat_api/models/task_result.rb +159 -0
  203. data/lib/flat_api/models/teaching_theme.rb +47 -0
  204. data/lib/flat_api/models/tutteo_product.rb +42 -0
  205. data/lib/flat_api/models/user_admin_update.rb +206 -106
  206. data/lib/flat_api/models/user_azure_details.rb +168 -0
  207. data/lib/flat_api/models/user_basics.rb +215 -120
  208. data/lib/flat_api/models/user_community_profile_links.rb +205 -0
  209. data/lib/flat_api/models/user_creation.rb +203 -114
  210. data/lib/flat_api/models/user_details.rb +331 -161
  211. data/lib/flat_api/models/user_details_admin.rb +272 -133
  212. data/lib/flat_api/models/user_details_admin_all_of_license.rb +211 -0
  213. data/lib/flat_api/models/user_public.rb +303 -145
  214. data/lib/flat_api/models/user_public_summary.rb +243 -126
  215. data/lib/flat_api/models/user_signin_link.rb +168 -0
  216. data/lib/flat_api/models/user_signin_link_creation.rb +150 -0
  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 +5 -5
  221. data/lib/flat_api.rb +144 -16
  222. metadata +154 -434
  223. data/Gemfile +0 -7
  224. data/Rakefile +0 -8
  225. data/docs/AccountApi.md +0 -55
  226. data/docs/Assignment.md +0 -18
  227. data/docs/AssignmentCopy.md +0 -8
  228. data/docs/AssignmentCreation.md +0 -12
  229. data/docs/AssignmentSubmission.md +0 -19
  230. data/docs/AssignmentSubmissionUpdate.md +0 -11
  231. data/docs/ClassApi.md +0 -1051
  232. data/docs/ClassAttachmentCreation.md +0 -10
  233. data/docs/ClassCreation.md +0 -9
  234. data/docs/ClassDetails.md +0 -25
  235. data/docs/ClassDetailsCanvas.md +0 -9
  236. data/docs/ClassDetailsClever.md +0 -14
  237. data/docs/ClassDetailsGoogleClassroom.md +0 -11
  238. data/docs/ClassDetailsGoogleDrive.md +0 -9
  239. data/docs/ClassDetailsLti.md +0 -10
  240. data/docs/ClassRoles.md +0 -7
  241. data/docs/ClassState.md +0 -7
  242. data/docs/ClassUpdate.md +0 -9
  243. data/docs/Collection.md +0 -18
  244. data/docs/CollectionApi.md +0 -521
  245. data/docs/CollectionCapabilities.md +0 -12
  246. data/docs/CollectionCreation.md +0 -8
  247. data/docs/CollectionModification.md +0 -8
  248. data/docs/CollectionPrivacy.md +0 -7
  249. data/docs/CollectionTitle.md +0 -7
  250. data/docs/CollectionType.md +0 -7
  251. data/docs/FlatErrorResponse.md +0 -11
  252. data/docs/FlatLocales.md +0 -7
  253. data/docs/GoogleClassroomCoursework.md +0 -10
  254. data/docs/GoogleClassroomSubmission.md +0 -10
  255. data/docs/Group.md +0 -14
  256. data/docs/GroupApi.md +0 -167
  257. data/docs/GroupDetails.md +0 -14
  258. data/docs/GroupType.md +0 -7
  259. data/docs/LicenseMode.md +0 -7
  260. data/docs/LicenseSources.md +0 -7
  261. data/docs/LmsName.md +0 -7
  262. data/docs/LtiCredentials.md +0 -16
  263. data/docs/LtiCredentialsCreation.md +0 -9
  264. data/docs/MediaAttachment.md +0 -23
  265. data/docs/MediaScoreSharingMode.md +0 -7
  266. data/docs/OrganizationApi.md +0 -538
  267. data/docs/OrganizationInvitation.md +0 -14
  268. data/docs/OrganizationInvitationCreation.md +0 -9
  269. data/docs/OrganizationRoles.md +0 -7
  270. data/docs/ResourceCollaborator.md +0 -16
  271. data/docs/ResourceCollaboratorCreation.md +0 -14
  272. data/docs/ResourceRights.md +0 -10
  273. data/docs/ResourceSharingKey.md +0 -7
  274. data/docs/ScoreApi.md +0 -1658
  275. data/docs/ScoreComment.md +0 -22
  276. data/docs/ScoreCommentContext.md +0 -14
  277. data/docs/ScoreCommentCreation.md +0 -13
  278. data/docs/ScoreCommentUpdate.md +0 -11
  279. data/docs/ScoreCommentsCounts.md +0 -11
  280. data/docs/ScoreCreation.md +0 -14
  281. data/docs/ScoreCreationType.md +0 -7
  282. data/docs/ScoreData.md +0 -7
  283. data/docs/ScoreDataEncoding.md +0 -7
  284. data/docs/ScoreDetails.md +0 -36
  285. data/docs/ScoreFork.md +0 -8
  286. data/docs/ScoreLicense.md +0 -7
  287. data/docs/ScoreLikesCounts.md +0 -10
  288. data/docs/ScoreModification.md +0 -14
  289. data/docs/ScorePrivacy.md +0 -7
  290. data/docs/ScoreRevision.md +0 -14
  291. data/docs/ScoreRevisionCreation.md +0 -11
  292. data/docs/ScoreRevisionStatistics.md +0 -9
  293. data/docs/ScoreSource.md +0 -8
  294. data/docs/ScoreSummary.md +0 -13
  295. data/docs/ScoreTrack.md +0 -19
  296. data/docs/ScoreTrackCreation.md +0 -12
  297. data/docs/ScoreTrackPoint.md +0 -10
  298. data/docs/ScoreTrackState.md +0 -7
  299. data/docs/ScoreTrackType.md +0 -7
  300. data/docs/ScoreTrackUpdate.md +0 -11
  301. data/docs/ScoreViewsCounts.md +0 -10
  302. data/docs/UserAdminUpdate.md +0 -9
  303. data/docs/UserApi.md +0 -173
  304. data/docs/UserBasics.md +0 -13
  305. data/docs/UserCreation.md +0 -11
  306. data/docs/UserDetails.md +0 -28
  307. data/docs/UserDetailsAdmin.md +0 -20
  308. data/docs/UserDetailsAdminLicense.md +0 -12
  309. data/docs/UserInstruments.md +0 -7
  310. data/docs/UserPublic.md +0 -25
  311. data/docs/UserPublicSummary.md +0 -17
  312. data/flat_api.gemspec +0 -48
  313. data/lib/flat_api/models/assignment_creation.rb +0 -230
  314. data/lib/flat_api/models/collection_title.rb +0 -179
  315. data/lib/flat_api/models/flat_locales.rb +0 -36
  316. data/lib/flat_api/models/resource_sharing_key.rb +0 -179
  317. data/lib/flat_api/models/score_data.rb +0 -179
  318. data/lib/flat_api/models/score_data_encoding.rb +0 -30
  319. data/lib/flat_api/models/user_details_admin_license.rb +0 -227
  320. data/lib/flat_api/models/user_instruments.rb +0 -179
  321. data/spec/api/account_api_spec.rb +0 -46
  322. data/spec/api/class_api_spec.rb +0 -278
  323. data/spec/api/collection_api_spec.rb +0 -159
  324. data/spec/api/group_api_spec.rb +0 -72
  325. data/spec/api/organization_api_spec.rb +0 -162
  326. data/spec/api/score_api_spec.rb +0 -426
  327. data/spec/api/user_api_spec.rb +0 -73
  328. data/spec/api_client_spec.rb +0 -226
  329. data/spec/configuration_spec.rb +0 -42
  330. data/spec/models/assignment_copy_spec.rb +0 -42
  331. data/spec/models/assignment_creation_spec.rb +0 -66
  332. data/spec/models/assignment_spec.rb +0 -106
  333. data/spec/models/assignment_submission_spec.rb +0 -108
  334. data/spec/models/assignment_submission_update_spec.rb +0 -60
  335. data/spec/models/class_attachment_creation_spec.rb +0 -58
  336. data/spec/models/class_creation_spec.rb +0 -48
  337. data/spec/models/class_details_canvas_spec.rb +0 -48
  338. data/spec/models/class_details_clever_spec.rb +0 -82
  339. data/spec/models/class_details_google_classroom_spec.rb +0 -60
  340. data/spec/models/class_details_google_drive_spec.rb +0 -48
  341. data/spec/models/class_details_lti_spec.rb +0 -54
  342. data/spec/models/class_details_spec.rb +0 -144
  343. data/spec/models/class_roles_spec.rb +0 -36
  344. data/spec/models/class_state_spec.rb +0 -36
  345. data/spec/models/class_update_spec.rb +0 -48
  346. data/spec/models/collection_capabilities_spec.rb +0 -66
  347. data/spec/models/collection_creation_spec.rb +0 -42
  348. data/spec/models/collection_modification_spec.rb +0 -42
  349. data/spec/models/collection_privacy_spec.rb +0 -36
  350. data/spec/models/collection_spec.rb +0 -102
  351. data/spec/models/collection_title_spec.rb +0 -36
  352. data/spec/models/collection_type_spec.rb +0 -36
  353. data/spec/models/flat_error_response_spec.rb +0 -60
  354. data/spec/models/flat_locales_spec.rb +0 -36
  355. data/spec/models/google_classroom_coursework_spec.rb +0 -54
  356. data/spec/models/google_classroom_submission_spec.rb +0 -54
  357. data/spec/models/group_details_spec.rb +0 -78
  358. data/spec/models/group_spec.rb +0 -82
  359. data/spec/models/group_type_spec.rb +0 -36
  360. data/spec/models/license_mode_spec.rb +0 -36
  361. data/spec/models/license_sources_spec.rb +0 -36
  362. data/spec/models/lms_name_spec.rb +0 -36
  363. data/spec/models/lti_credentials_creation_spec.rb +0 -48
  364. data/spec/models/lti_credentials_spec.rb +0 -90
  365. data/spec/models/media_attachment_spec.rb +0 -136
  366. data/spec/models/media_score_sharing_mode_spec.rb +0 -36
  367. data/spec/models/organization_invitation_creation_spec.rb +0 -48
  368. data/spec/models/organization_invitation_spec.rb +0 -78
  369. data/spec/models/organization_roles_spec.rb +0 -36
  370. data/spec/models/resource_collaborator_creation_spec.rb +0 -78
  371. data/spec/models/resource_collaborator_spec.rb +0 -90
  372. data/spec/models/resource_rights_spec.rb +0 -54
  373. data/spec/models/resource_sharing_key_spec.rb +0 -36
  374. data/spec/models/score_comment_context_spec.rb +0 -78
  375. data/spec/models/score_comment_creation_spec.rb +0 -72
  376. data/spec/models/score_comment_spec.rb +0 -130
  377. data/spec/models/score_comment_update_spec.rb +0 -60
  378. data/spec/models/score_comments_counts_spec.rb +0 -60
  379. data/spec/models/score_creation_spec.rb +0 -78
  380. data/spec/models/score_creation_type_spec.rb +0 -36
  381. data/spec/models/score_data_encoding_spec.rb +0 -36
  382. data/spec/models/score_data_spec.rb +0 -36
  383. data/spec/models/score_details_spec.rb +0 -210
  384. data/spec/models/score_fork_spec.rb +0 -42
  385. data/spec/models/score_license_spec.rb +0 -36
  386. data/spec/models/score_likes_counts_spec.rb +0 -54
  387. data/spec/models/score_modification_spec.rb +0 -78
  388. data/spec/models/score_privacy_spec.rb +0 -36
  389. data/spec/models/score_revision_creation_spec.rb +0 -60
  390. data/spec/models/score_revision_spec.rb +0 -78
  391. data/spec/models/score_revision_statistics_spec.rb +0 -48
  392. data/spec/models/score_source_spec.rb +0 -42
  393. data/spec/models/score_summary_spec.rb +0 -72
  394. data/spec/models/score_track_creation_spec.rb +0 -66
  395. data/spec/models/score_track_point_spec.rb +0 -58
  396. data/spec/models/score_track_spec.rb +0 -108
  397. data/spec/models/score_track_state_spec.rb +0 -36
  398. data/spec/models/score_track_type_spec.rb +0 -36
  399. data/spec/models/score_track_update_spec.rb +0 -60
  400. data/spec/models/score_views_counts_spec.rb +0 -54
  401. data/spec/models/user_admin_update_spec.rb +0 -48
  402. data/spec/models/user_basics_spec.rb +0 -72
  403. data/spec/models/user_creation_spec.rb +0 -60
  404. data/spec/models/user_details_admin_license_spec.rb +0 -66
  405. data/spec/models/user_details_admin_spec.rb +0 -114
  406. data/spec/models/user_details_spec.rb +0 -166
  407. data/spec/models/user_instruments_spec.rb +0 -36
  408. data/spec/models/user_public_spec.rb +0 -144
  409. data/spec/models/user_public_summary_spec.rb +0 -96
  410. data/spec/spec_helper.rb +0 -111
@@ -0,0 +1,750 @@
1
+ =begin
2
+ #Flat API
3
+
4
+ #The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, 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
+
6
+ The version of the OpenAPI document: 2.26.1
7
+ Contact: developers@flat.io
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.24.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FlatApi
17
+ class ClassAssignment < ApiModelBase
18
+ # Unique identifier of the assignment
19
+ attr_accessor :id
20
+
21
+ attr_accessor :type
22
+
23
+ attr_accessor :capabilities
24
+
25
+ # Title of the assignment
26
+ attr_accessor :title
27
+
28
+ # Student instructions and content of the assignment (plain text)
29
+ attr_accessor :description
30
+
31
+ # HTML version of student instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs.
32
+ attr_accessor :description_html
33
+
34
+ # Teacher-only instructions for this assignment. These instructions are only visible to teachers and are not returned when students view the assignment. If `teacherInstructionsHtml` is provided, this field will contain the plain text version for compatibility.
35
+ attr_accessor :teacher_instructions
36
+
37
+ # HTML version of teacher-only instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs.
38
+ attr_accessor :teacher_instructions_html
39
+
40
+ # The URL of the cover to display
41
+ attr_accessor :cover
42
+
43
+ # The id of the cover to display
44
+ attr_accessor :cover_file
45
+
46
+ # Reference material handed to the students with the assignment: scores, videos, links and Drive files. A score attached here is the one each student receives their own copy of.
47
+ attr_accessor :attachments
48
+
49
+ # For all assignments created after 02/2023, all the underlying resources must be dedicated and stored in the assignment. This boolean indicates that this assignment only supports dedicated attachments.
50
+ attr_accessor :use_dedicated_attachments
51
+
52
+ # If set, the grading will be enabled for the assignement
53
+ attr_accessor :max_points
54
+
55
+ # For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions
56
+ attr_accessor :release_grades
57
+
58
+ # Mixing worksheets exercises for each student
59
+ attr_accessor :shuffle_exercises
60
+
61
+ # The id of the associated toolset
62
+ attr_accessor :toolset
63
+
64
+ # The number of playback authorized on the scores of the assignment.
65
+ attr_accessor :nb_playback_authorized
66
+
67
+ # Restrict the ability to get an audio feedback every time a student adds or selects a note.
68
+ attr_accessor :restrict_play_note
69
+
70
+ # Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback.
71
+ attr_accessor :restrict_to_audio_tracks
72
+
73
+ attr_accessor :submission_students_mode
74
+
75
+ # For performance assignments: recording type that will be either 'audio' or 'video'. * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording. Only set when type is 'performance'.
76
+ attr_accessor :recording_type
77
+
78
+ # For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'.
79
+ attr_accessor :allow_metronome
80
+
81
+ # For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'.
82
+ attr_accessor :allow_backing_track
83
+
84
+ # For performance assignments: whether students can adjust the playback speed of the score during recording. * `true`: Students can change the tempo/speed during practice and recording * `false`: Tempo is fixed to the original score tempo Only set when type is 'performance'.
85
+ attr_accessor :allow_speed_change
86
+
87
+ # For performance assignments: \"Free Record\" mode. When `true`, no score is attached to the assignment. Students freely record a varied repertoire or an ensemble performance without being constrained by a single score's structure or duration, and all score-dependent options (playback, metronome, backtracking, speed control) are hidden. Only set when type is 'performance'.
88
+ attr_accessor :free_record
89
+
90
+ # The User unique identifier of the creator of this assignment
91
+ attr_accessor :creator
92
+
93
+ # State of the assignment
94
+ attr_accessor :state
95
+
96
+ # The unique identifier of the class where this assignment was posted
97
+ attr_accessor :classroom
98
+
99
+ # The creation date of this assignment
100
+ attr_accessor :creation_date
101
+
102
+ # The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.
103
+ attr_accessor :scheduled_date
104
+
105
+ # The due date of this assignment, late submissions will be marked as paste due.
106
+ attr_accessor :due_date
107
+
108
+ # Possible modes of assigning assignments
109
+ attr_accessor :assignee_mode
110
+
111
+ # Identifiers for the students that have access to the assignment
112
+ attr_accessor :assigned_students
113
+
114
+ # Groups that have access to the assignment (for shared writing assignments)
115
+ attr_accessor :assigned_groups
116
+
117
+ attr_accessor :submissions
118
+
119
+ attr_accessor :google_classroom
120
+
121
+ attr_accessor :microsoft_graph
122
+
123
+ attr_accessor :mfc
124
+
125
+ attr_accessor :canvas
126
+
127
+ attr_accessor :lti
128
+
129
+ # Detected issue for this assignment
130
+ attr_accessor :issue
131
+
132
+ class EnumAttributeValidator
133
+ attr_reader :datatype
134
+ attr_reader :allowable_values
135
+
136
+ def initialize(datatype, allowable_values)
137
+ @allowable_values = allowable_values.map do |value|
138
+ case datatype.to_s
139
+ when /Integer/i
140
+ value.to_i
141
+ when /Float/i
142
+ value.to_f
143
+ else
144
+ value
145
+ end
146
+ end
147
+ end
148
+
149
+ def valid?(value)
150
+ !value || allowable_values.include?(value)
151
+ end
152
+ end
153
+
154
+ # Attribute mapping from ruby-style variable name to JSON key.
155
+ def self.attribute_map
156
+ {
157
+ :'id' => :'id',
158
+ :'type' => :'type',
159
+ :'capabilities' => :'capabilities',
160
+ :'title' => :'title',
161
+ :'description' => :'description',
162
+ :'description_html' => :'descriptionHtml',
163
+ :'teacher_instructions' => :'teacherInstructions',
164
+ :'teacher_instructions_html' => :'teacherInstructionsHtml',
165
+ :'cover' => :'cover',
166
+ :'cover_file' => :'coverFile',
167
+ :'attachments' => :'attachments',
168
+ :'use_dedicated_attachments' => :'useDedicatedAttachments',
169
+ :'max_points' => :'maxPoints',
170
+ :'release_grades' => :'releaseGrades',
171
+ :'shuffle_exercises' => :'shuffleExercises',
172
+ :'toolset' => :'toolset',
173
+ :'nb_playback_authorized' => :'nbPlaybackAuthorized',
174
+ :'restrict_play_note' => :'restrictPlayNote',
175
+ :'restrict_to_audio_tracks' => :'restrictToAudioTracks',
176
+ :'submission_students_mode' => :'submissionStudentsMode',
177
+ :'recording_type' => :'recordingType',
178
+ :'allow_metronome' => :'allowMetronome',
179
+ :'allow_backing_track' => :'allowBackingTrack',
180
+ :'allow_speed_change' => :'allowSpeedChange',
181
+ :'free_record' => :'freeRecord',
182
+ :'creator' => :'creator',
183
+ :'state' => :'state',
184
+ :'classroom' => :'classroom',
185
+ :'creation_date' => :'creationDate',
186
+ :'scheduled_date' => :'scheduledDate',
187
+ :'due_date' => :'dueDate',
188
+ :'assignee_mode' => :'assigneeMode',
189
+ :'assigned_students' => :'assignedStudents',
190
+ :'assigned_groups' => :'assignedGroups',
191
+ :'submissions' => :'submissions',
192
+ :'google_classroom' => :'googleClassroom',
193
+ :'microsoft_graph' => :'microsoftGraph',
194
+ :'mfc' => :'mfc',
195
+ :'canvas' => :'canvas',
196
+ :'lti' => :'lti',
197
+ :'issue' => :'issue'
198
+ }
199
+ end
200
+
201
+ # Returns attribute mapping this model knows about
202
+ def self.acceptable_attribute_map
203
+ attribute_map
204
+ end
205
+
206
+ # Returns all the JSON keys this model knows about
207
+ def self.acceptable_attributes
208
+ acceptable_attribute_map.values
209
+ end
210
+
211
+ # Attribute type mapping.
212
+ def self.openapi_types
213
+ {
214
+ :'id' => :'String',
215
+ :'type' => :'AssignmentType',
216
+ :'capabilities' => :'AssignmentCapabilities',
217
+ :'title' => :'String',
218
+ :'description' => :'String',
219
+ :'description_html' => :'String',
220
+ :'teacher_instructions' => :'String',
221
+ :'teacher_instructions_html' => :'String',
222
+ :'cover' => :'String',
223
+ :'cover_file' => :'String',
224
+ :'attachments' => :'Array<MediaAttachment>',
225
+ :'use_dedicated_attachments' => :'Boolean',
226
+ :'max_points' => :'Float',
227
+ :'release_grades' => :'String',
228
+ :'shuffle_exercises' => :'Boolean',
229
+ :'toolset' => :'String',
230
+ :'nb_playback_authorized' => :'Float',
231
+ :'restrict_play_note' => :'Boolean',
232
+ :'restrict_to_audio_tracks' => :'Boolean',
233
+ :'submission_students_mode' => :'AssignmentSubmissionStudentsMode',
234
+ :'recording_type' => :'String',
235
+ :'allow_metronome' => :'Boolean',
236
+ :'allow_backing_track' => :'Boolean',
237
+ :'allow_speed_change' => :'Boolean',
238
+ :'free_record' => :'Boolean',
239
+ :'creator' => :'String',
240
+ :'state' => :'String',
241
+ :'classroom' => :'String',
242
+ :'creation_date' => :'Time',
243
+ :'scheduled_date' => :'Time',
244
+ :'due_date' => :'Time',
245
+ :'assignee_mode' => :'String',
246
+ :'assigned_students' => :'Array<String>',
247
+ :'assigned_groups' => :'Array<AssignmentGroup>',
248
+ :'submissions' => :'Array<AssignmentSubmission>',
249
+ :'google_classroom' => :'GoogleClassroomCoursework',
250
+ :'microsoft_graph' => :'MicrosoftGraphAssignment',
251
+ :'mfc' => :'ClassAssignmentAllOfMfc',
252
+ :'canvas' => :'ClassAssignmentAllOfCanvas',
253
+ :'lti' => :'ClassAssignmentAllOfLti',
254
+ :'issue' => :'String'
255
+ }
256
+ end
257
+
258
+ # List of attributes with nullable: true
259
+ def self.openapi_nullable
260
+ Set.new([
261
+ ])
262
+ end
263
+
264
+ # List of class defined in allOf (OpenAPI v3)
265
+ def self.openapi_all_of
266
+ [
267
+ :'Assignment'
268
+ ]
269
+ end
270
+
271
+ # Initializes the object
272
+ # @param [Hash] attributes Model attributes in the form of hash
273
+ def initialize(attributes = {})
274
+ if (!attributes.is_a?(Hash))
275
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ClassAssignment` initialize method"
276
+ end
277
+
278
+ # check to see if the attribute exists and convert string to symbol for hash key
279
+ acceptable_attribute_map = self.class.acceptable_attribute_map
280
+ attributes = attributes.each_with_object({}) { |(k, v), h|
281
+ if (!acceptable_attribute_map.key?(k.to_sym))
282
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ClassAssignment`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
283
+ end
284
+ h[k.to_sym] = v
285
+ }
286
+
287
+ if attributes.key?(:'id')
288
+ self.id = attributes[:'id']
289
+ else
290
+ self.id = nil
291
+ end
292
+
293
+ if attributes.key?(:'type')
294
+ self.type = attributes[:'type']
295
+ else
296
+ self.type = nil
297
+ end
298
+
299
+ if attributes.key?(:'capabilities')
300
+ self.capabilities = attributes[:'capabilities']
301
+ else
302
+ self.capabilities = nil
303
+ end
304
+
305
+ if attributes.key?(:'title')
306
+ self.title = attributes[:'title']
307
+ else
308
+ self.title = nil
309
+ end
310
+
311
+ if attributes.key?(:'description')
312
+ self.description = attributes[:'description']
313
+ end
314
+
315
+ if attributes.key?(:'description_html')
316
+ self.description_html = attributes[:'description_html']
317
+ end
318
+
319
+ if attributes.key?(:'teacher_instructions')
320
+ self.teacher_instructions = attributes[:'teacher_instructions']
321
+ end
322
+
323
+ if attributes.key?(:'teacher_instructions_html')
324
+ self.teacher_instructions_html = attributes[:'teacher_instructions_html']
325
+ end
326
+
327
+ if attributes.key?(:'cover')
328
+ self.cover = attributes[:'cover']
329
+ end
330
+
331
+ if attributes.key?(:'cover_file')
332
+ self.cover_file = attributes[:'cover_file']
333
+ end
334
+
335
+ if attributes.key?(:'attachments')
336
+ if (value = attributes[:'attachments']).is_a?(Array)
337
+ self.attachments = value
338
+ end
339
+ else
340
+ self.attachments = nil
341
+ end
342
+
343
+ if attributes.key?(:'use_dedicated_attachments')
344
+ self.use_dedicated_attachments = attributes[:'use_dedicated_attachments']
345
+ end
346
+
347
+ if attributes.key?(:'max_points')
348
+ self.max_points = attributes[:'max_points']
349
+ end
350
+
351
+ if attributes.key?(:'release_grades')
352
+ self.release_grades = attributes[:'release_grades']
353
+ end
354
+
355
+ if attributes.key?(:'shuffle_exercises')
356
+ self.shuffle_exercises = attributes[:'shuffle_exercises']
357
+ end
358
+
359
+ if attributes.key?(:'toolset')
360
+ self.toolset = attributes[:'toolset']
361
+ end
362
+
363
+ if attributes.key?(:'nb_playback_authorized')
364
+ self.nb_playback_authorized = attributes[:'nb_playback_authorized']
365
+ end
366
+
367
+ if attributes.key?(:'restrict_play_note')
368
+ self.restrict_play_note = attributes[:'restrict_play_note']
369
+ end
370
+
371
+ if attributes.key?(:'restrict_to_audio_tracks')
372
+ self.restrict_to_audio_tracks = attributes[:'restrict_to_audio_tracks']
373
+ end
374
+
375
+ if attributes.key?(:'submission_students_mode')
376
+ self.submission_students_mode = attributes[:'submission_students_mode']
377
+ end
378
+
379
+ if attributes.key?(:'recording_type')
380
+ self.recording_type = attributes[:'recording_type']
381
+ end
382
+
383
+ if attributes.key?(:'allow_metronome')
384
+ self.allow_metronome = attributes[:'allow_metronome']
385
+ end
386
+
387
+ if attributes.key?(:'allow_backing_track')
388
+ self.allow_backing_track = attributes[:'allow_backing_track']
389
+ end
390
+
391
+ if attributes.key?(:'allow_speed_change')
392
+ self.allow_speed_change = attributes[:'allow_speed_change']
393
+ end
394
+
395
+ if attributes.key?(:'free_record')
396
+ self.free_record = attributes[:'free_record']
397
+ end
398
+
399
+ if attributes.key?(:'creator')
400
+ self.creator = attributes[:'creator']
401
+ end
402
+
403
+ if attributes.key?(:'state')
404
+ self.state = attributes[:'state']
405
+ else
406
+ self.state = nil
407
+ end
408
+
409
+ if attributes.key?(:'classroom')
410
+ self.classroom = attributes[:'classroom']
411
+ end
412
+
413
+ if attributes.key?(:'creation_date')
414
+ self.creation_date = attributes[:'creation_date']
415
+ else
416
+ self.creation_date = nil
417
+ end
418
+
419
+ if attributes.key?(:'scheduled_date')
420
+ self.scheduled_date = attributes[:'scheduled_date']
421
+ end
422
+
423
+ if attributes.key?(:'due_date')
424
+ self.due_date = attributes[:'due_date']
425
+ end
426
+
427
+ if attributes.key?(:'assignee_mode')
428
+ self.assignee_mode = attributes[:'assignee_mode']
429
+ end
430
+
431
+ if attributes.key?(:'assigned_students')
432
+ if (value = attributes[:'assigned_students']).is_a?(Array)
433
+ self.assigned_students = value
434
+ end
435
+ end
436
+
437
+ if attributes.key?(:'assigned_groups')
438
+ if (value = attributes[:'assigned_groups']).is_a?(Array)
439
+ self.assigned_groups = value
440
+ end
441
+ end
442
+
443
+ if attributes.key?(:'submissions')
444
+ if (value = attributes[:'submissions']).is_a?(Array)
445
+ self.submissions = value
446
+ end
447
+ else
448
+ self.submissions = nil
449
+ end
450
+
451
+ if attributes.key?(:'google_classroom')
452
+ self.google_classroom = attributes[:'google_classroom']
453
+ end
454
+
455
+ if attributes.key?(:'microsoft_graph')
456
+ self.microsoft_graph = attributes[:'microsoft_graph']
457
+ end
458
+
459
+ if attributes.key?(:'mfc')
460
+ self.mfc = attributes[:'mfc']
461
+ end
462
+
463
+ if attributes.key?(:'canvas')
464
+ self.canvas = attributes[:'canvas']
465
+ end
466
+
467
+ if attributes.key?(:'lti')
468
+ self.lti = attributes[:'lti']
469
+ end
470
+
471
+ if attributes.key?(:'issue')
472
+ self.issue = attributes[:'issue']
473
+ end
474
+ end
475
+
476
+ # Show invalid properties with the reasons. Usually used together with valid?
477
+ # @return Array for valid properties with the reasons
478
+ def list_invalid_properties
479
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
480
+ invalid_properties = Array.new
481
+ if @id.nil?
482
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
483
+ end
484
+
485
+ if @type.nil?
486
+ invalid_properties.push('invalid value for "type", type cannot be nil.')
487
+ end
488
+
489
+ if @capabilities.nil?
490
+ invalid_properties.push('invalid value for "capabilities", capabilities cannot be nil.')
491
+ end
492
+
493
+ if @title.nil?
494
+ invalid_properties.push('invalid value for "title", title cannot be nil.')
495
+ end
496
+
497
+ if @attachments.nil?
498
+ invalid_properties.push('invalid value for "attachments", attachments cannot be nil.')
499
+ end
500
+
501
+ if @state.nil?
502
+ invalid_properties.push('invalid value for "state", state cannot be nil.')
503
+ end
504
+
505
+ if @creation_date.nil?
506
+ invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
507
+ end
508
+
509
+ if @submissions.nil?
510
+ invalid_properties.push('invalid value for "submissions", submissions cannot be nil.')
511
+ end
512
+
513
+ invalid_properties
514
+ end
515
+
516
+ # Check to see if the all the properties in the model are valid
517
+ # @return true if the model is valid
518
+ def valid?
519
+ warn '[DEPRECATED] the `valid?` method is obsolete'
520
+ return false if @id.nil?
521
+ return false if @type.nil?
522
+ return false if @capabilities.nil?
523
+ return false if @title.nil?
524
+ return false if @attachments.nil?
525
+ release_grades_validator = EnumAttributeValidator.new('String', ["auto", "manual"])
526
+ return false unless release_grades_validator.valid?(@release_grades)
527
+ recording_type_validator = EnumAttributeValidator.new('String', ["audio", "video"])
528
+ return false unless recording_type_validator.valid?(@recording_type)
529
+ return false if @state.nil?
530
+ state_validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
531
+ return false unless state_validator.valid?(@state)
532
+ return false if @creation_date.nil?
533
+ assignee_mode_validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
534
+ return false unless assignee_mode_validator.valid?(@assignee_mode)
535
+ return false if @submissions.nil?
536
+ true
537
+ end
538
+
539
+ # Custom attribute writer method with validation
540
+ # @param [Object] id Value to be assigned
541
+ def id=(id)
542
+ if id.nil?
543
+ fail ArgumentError, 'id cannot be nil'
544
+ end
545
+
546
+ @id = id
547
+ end
548
+
549
+ # Custom attribute writer method with validation
550
+ # @param [Object] type Value to be assigned
551
+ def type=(type)
552
+ if type.nil?
553
+ fail ArgumentError, 'type cannot be nil'
554
+ end
555
+
556
+ @type = type
557
+ end
558
+
559
+ # Custom attribute writer method with validation
560
+ # @param [Object] capabilities Value to be assigned
561
+ def capabilities=(capabilities)
562
+ if capabilities.nil?
563
+ fail ArgumentError, 'capabilities cannot be nil'
564
+ end
565
+
566
+ @capabilities = capabilities
567
+ end
568
+
569
+ # Custom attribute writer method with validation
570
+ # @param [Object] title Value to be assigned
571
+ def title=(title)
572
+ if title.nil?
573
+ fail ArgumentError, 'title cannot be nil'
574
+ end
575
+
576
+ @title = title
577
+ end
578
+
579
+ # Custom attribute writer method with validation
580
+ # @param [Object] attachments Value to be assigned
581
+ def attachments=(attachments)
582
+ if attachments.nil?
583
+ fail ArgumentError, 'attachments cannot be nil'
584
+ end
585
+
586
+ @attachments = attachments
587
+ end
588
+
589
+ # Custom attribute writer method checking allowed values (enum).
590
+ # @param [Object] release_grades Object to be assigned
591
+ def release_grades=(release_grades)
592
+ validator = EnumAttributeValidator.new('String', ["auto", "manual"])
593
+ unless validator.valid?(release_grades)
594
+ fail ArgumentError, "invalid value for \"release_grades\", must be one of #{validator.allowable_values}."
595
+ end
596
+ @release_grades = release_grades
597
+ end
598
+
599
+ # Custom attribute writer method checking allowed values (enum).
600
+ # @param [Object] recording_type Object to be assigned
601
+ def recording_type=(recording_type)
602
+ validator = EnumAttributeValidator.new('String', ["audio", "video"])
603
+ unless validator.valid?(recording_type)
604
+ fail ArgumentError, "invalid value for \"recording_type\", must be one of #{validator.allowable_values}."
605
+ end
606
+ @recording_type = recording_type
607
+ end
608
+
609
+ # Custom attribute writer method checking allowed values (enum).
610
+ # @param [Object] state Object to be assigned
611
+ def state=(state)
612
+ validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
613
+ unless validator.valid?(state)
614
+ fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
615
+ end
616
+ @state = state
617
+ end
618
+
619
+ # Custom attribute writer method with validation
620
+ # @param [Object] creation_date Value to be assigned
621
+ def creation_date=(creation_date)
622
+ if creation_date.nil?
623
+ fail ArgumentError, 'creation_date cannot be nil'
624
+ end
625
+
626
+ @creation_date = creation_date
627
+ end
628
+
629
+ # Custom attribute writer method checking allowed values (enum).
630
+ # @param [Object] assignee_mode Object to be assigned
631
+ def assignee_mode=(assignee_mode)
632
+ validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
633
+ unless validator.valid?(assignee_mode)
634
+ fail ArgumentError, "invalid value for \"assignee_mode\", must be one of #{validator.allowable_values}."
635
+ end
636
+ @assignee_mode = assignee_mode
637
+ end
638
+
639
+ # Custom attribute writer method with validation
640
+ # @param [Object] submissions Value to be assigned
641
+ def submissions=(submissions)
642
+ if submissions.nil?
643
+ fail ArgumentError, 'submissions cannot be nil'
644
+ end
645
+
646
+ @submissions = submissions
647
+ end
648
+
649
+ # Checks equality by comparing each attribute.
650
+ # @param [Object] Object to be compared
651
+ def ==(o)
652
+ return true if self.equal?(o)
653
+ self.class == o.class &&
654
+ id == o.id &&
655
+ type == o.type &&
656
+ capabilities == o.capabilities &&
657
+ title == o.title &&
658
+ description == o.description &&
659
+ description_html == o.description_html &&
660
+ teacher_instructions == o.teacher_instructions &&
661
+ teacher_instructions_html == o.teacher_instructions_html &&
662
+ cover == o.cover &&
663
+ cover_file == o.cover_file &&
664
+ attachments == o.attachments &&
665
+ use_dedicated_attachments == o.use_dedicated_attachments &&
666
+ max_points == o.max_points &&
667
+ release_grades == o.release_grades &&
668
+ shuffle_exercises == o.shuffle_exercises &&
669
+ toolset == o.toolset &&
670
+ nb_playback_authorized == o.nb_playback_authorized &&
671
+ restrict_play_note == o.restrict_play_note &&
672
+ restrict_to_audio_tracks == o.restrict_to_audio_tracks &&
673
+ submission_students_mode == o.submission_students_mode &&
674
+ recording_type == o.recording_type &&
675
+ allow_metronome == o.allow_metronome &&
676
+ allow_backing_track == o.allow_backing_track &&
677
+ allow_speed_change == o.allow_speed_change &&
678
+ free_record == o.free_record &&
679
+ creator == o.creator &&
680
+ state == o.state &&
681
+ classroom == o.classroom &&
682
+ creation_date == o.creation_date &&
683
+ scheduled_date == o.scheduled_date &&
684
+ due_date == o.due_date &&
685
+ assignee_mode == o.assignee_mode &&
686
+ assigned_students == o.assigned_students &&
687
+ assigned_groups == o.assigned_groups &&
688
+ submissions == o.submissions &&
689
+ google_classroom == o.google_classroom &&
690
+ microsoft_graph == o.microsoft_graph &&
691
+ mfc == o.mfc &&
692
+ canvas == o.canvas &&
693
+ lti == o.lti &&
694
+ issue == o.issue
695
+ end
696
+
697
+ # @see the `==` method
698
+ # @param [Object] Object to be compared
699
+ def eql?(o)
700
+ self == o
701
+ end
702
+
703
+ # Calculates hash code according to all attributes.
704
+ # @return [Integer] Hash code
705
+ def hash
706
+ [id, type, capabilities, title, description, description_html, teacher_instructions, teacher_instructions_html, cover, cover_file, attachments, use_dedicated_attachments, max_points, release_grades, shuffle_exercises, toolset, nb_playback_authorized, restrict_play_note, restrict_to_audio_tracks, submission_students_mode, recording_type, allow_metronome, allow_backing_track, allow_speed_change, free_record, creator, state, classroom, creation_date, scheduled_date, due_date, assignee_mode, assigned_students, assigned_groups, submissions, google_classroom, microsoft_graph, mfc, canvas, lti, issue].hash
707
+ end
708
+
709
+ # Builds the object from hash
710
+ # @param [Hash] attributes Model attributes in the form of hash
711
+ # @return [Object] Returns the model itself
712
+ def self.build_from_hash(attributes)
713
+ return nil unless attributes.is_a?(Hash)
714
+ attributes = attributes.transform_keys(&:to_sym)
715
+ transformed_hash = {}
716
+ openapi_types.each_pair do |key, type|
717
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
718
+ transformed_hash["#{key}"] = nil
719
+ elsif type =~ /\AArray<(.*)>/i
720
+ # check to ensure the input is an array given that the attribute
721
+ # is documented as an array but the input is not
722
+ if attributes[attribute_map[key]].is_a?(Array)
723
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
724
+ end
725
+ elsif !attributes[attribute_map[key]].nil?
726
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
727
+ end
728
+ end
729
+ new(transformed_hash)
730
+ end
731
+
732
+ # Returns the object in the form of hash
733
+ # @return [Hash] Returns the object in the form of hash
734
+ def to_hash
735
+ hash = {}
736
+ self.class.attribute_map.each_pair do |attr, param|
737
+ value = self.send(attr)
738
+ if value.nil?
739
+ is_nullable = self.class.openapi_nullable.include?(attr)
740
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
741
+ end
742
+
743
+ hash[param] = _to_hash(value)
744
+ end
745
+ hash
746
+ end
747
+
748
+ end
749
+
750
+ end