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,652 @@
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 ClassAssignmentUpdate < ApiModelBase
18
+ attr_accessor :type
19
+
20
+ # Title of the assignment
21
+ attr_accessor :title
22
+
23
+ # Student instructions and content of the assignment (plain text)
24
+ attr_accessor :description
25
+
26
+ # HTML version of student instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility.
27
+ attr_accessor :description_html
28
+
29
+ # Teacher-only instructions (plain text)
30
+ attr_accessor :teacher_instructions
31
+
32
+ # HTML version of teacher-only instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility.
33
+ attr_accessor :teacher_instructions_html
34
+
35
+ # The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`.
36
+ attr_accessor :attachments
37
+
38
+ # The number of playback authorized on the scores of the assignment.
39
+ attr_accessor :nb_playback_authorized
40
+
41
+ # Restrict the ability to get an audio feedback every time a student adds or selects a note.
42
+ attr_accessor :restrict_play_note
43
+
44
+ # Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback.
45
+ attr_accessor :restrict_to_audio_tracks
46
+
47
+ # The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment.
48
+ attr_accessor :toolset
49
+
50
+ # The id of the cover to display
51
+ attr_accessor :cover_file
52
+
53
+ # The URL of the cover to display
54
+ attr_accessor :cover
55
+
56
+ # If set, the grading will be enabled for the assignement with this value as the maximum of points
57
+ attr_accessor :max_points
58
+
59
+ # 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
60
+ attr_accessor :release_grades
61
+
62
+ # Mixing worksheets exercises for each student
63
+ attr_accessor :shuffle_exercises
64
+
65
+ attr_accessor :submission_students_mode
66
+
67
+ # 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'.
68
+ attr_accessor :recording_type
69
+
70
+ # For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'.
71
+ attr_accessor :allow_metronome
72
+
73
+ # For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'.
74
+ attr_accessor :allow_backing_track
75
+
76
+ # 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'.
77
+ attr_accessor :allow_speed_change
78
+
79
+ # 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'.
80
+ attr_accessor :free_record
81
+
82
+ # State of the assignment
83
+ attr_accessor :state
84
+
85
+ # The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won't have a due date.
86
+ attr_accessor :due_date
87
+
88
+ # The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.
89
+ attr_accessor :scheduled_date
90
+
91
+ attr_accessor :google_classroom
92
+
93
+ attr_accessor :microsoft_graph
94
+
95
+ # Possible modes of assigning assignments
96
+ attr_accessor :assignee_mode
97
+
98
+ # Identifiers for the students that have access to the assignment
99
+ attr_accessor :assigned_students
100
+
101
+ # Optional list of specific class group IDs to apply to the assignment. When transitioning to active state with group submission mode: - If provided: Only these specific groups will be applied - If not provided: All class groups will be applied, or randomized groups created if none exist
102
+ attr_accessor :class_group_ids
103
+
104
+ class EnumAttributeValidator
105
+ attr_reader :datatype
106
+ attr_reader :allowable_values
107
+
108
+ def initialize(datatype, allowable_values)
109
+ @allowable_values = allowable_values.map do |value|
110
+ case datatype.to_s
111
+ when /Integer/i
112
+ value.to_i
113
+ when /Float/i
114
+ value.to_f
115
+ else
116
+ value
117
+ end
118
+ end
119
+ end
120
+
121
+ def valid?(value)
122
+ !value || allowable_values.include?(value)
123
+ end
124
+ end
125
+
126
+ # Attribute mapping from ruby-style variable name to JSON key.
127
+ def self.attribute_map
128
+ {
129
+ :'type' => :'type',
130
+ :'title' => :'title',
131
+ :'description' => :'description',
132
+ :'description_html' => :'descriptionHtml',
133
+ :'teacher_instructions' => :'teacherInstructions',
134
+ :'teacher_instructions_html' => :'teacherInstructionsHtml',
135
+ :'attachments' => :'attachments',
136
+ :'nb_playback_authorized' => :'nbPlaybackAuthorized',
137
+ :'restrict_play_note' => :'restrictPlayNote',
138
+ :'restrict_to_audio_tracks' => :'restrictToAudioTracks',
139
+ :'toolset' => :'toolset',
140
+ :'cover_file' => :'coverFile',
141
+ :'cover' => :'cover',
142
+ :'max_points' => :'maxPoints',
143
+ :'release_grades' => :'releaseGrades',
144
+ :'shuffle_exercises' => :'shuffleExercises',
145
+ :'submission_students_mode' => :'submissionStudentsMode',
146
+ :'recording_type' => :'recordingType',
147
+ :'allow_metronome' => :'allowMetronome',
148
+ :'allow_backing_track' => :'allowBackingTrack',
149
+ :'allow_speed_change' => :'allowSpeedChange',
150
+ :'free_record' => :'freeRecord',
151
+ :'state' => :'state',
152
+ :'due_date' => :'dueDate',
153
+ :'scheduled_date' => :'scheduledDate',
154
+ :'google_classroom' => :'googleClassroom',
155
+ :'microsoft_graph' => :'microsoftGraph',
156
+ :'assignee_mode' => :'assigneeMode',
157
+ :'assigned_students' => :'assignedStudents',
158
+ :'class_group_ids' => :'classGroupIds'
159
+ }
160
+ end
161
+
162
+ # Returns attribute mapping this model knows about
163
+ def self.acceptable_attribute_map
164
+ attribute_map
165
+ end
166
+
167
+ # Returns all the JSON keys this model knows about
168
+ def self.acceptable_attributes
169
+ acceptable_attribute_map.values
170
+ end
171
+
172
+ # Attribute type mapping.
173
+ def self.openapi_types
174
+ {
175
+ :'type' => :'AssignmentType',
176
+ :'title' => :'String',
177
+ :'description' => :'String',
178
+ :'description_html' => :'String',
179
+ :'teacher_instructions' => :'String',
180
+ :'teacher_instructions_html' => :'String',
181
+ :'attachments' => :'Array<ClassAttachmentCreation>',
182
+ :'nb_playback_authorized' => :'Float',
183
+ :'restrict_play_note' => :'Boolean',
184
+ :'restrict_to_audio_tracks' => :'Boolean',
185
+ :'toolset' => :'String',
186
+ :'cover_file' => :'String',
187
+ :'cover' => :'String',
188
+ :'max_points' => :'Float',
189
+ :'release_grades' => :'String',
190
+ :'shuffle_exercises' => :'Boolean',
191
+ :'submission_students_mode' => :'AssignmentSubmissionStudentsMode',
192
+ :'recording_type' => :'String',
193
+ :'allow_metronome' => :'Boolean',
194
+ :'allow_backing_track' => :'Boolean',
195
+ :'allow_speed_change' => :'Boolean',
196
+ :'free_record' => :'Boolean',
197
+ :'state' => :'String',
198
+ :'due_date' => :'Time',
199
+ :'scheduled_date' => :'Time',
200
+ :'google_classroom' => :'ClassAssignmentUpdateAllOfGoogleClassroom',
201
+ :'microsoft_graph' => :'ClassAssignmentUpdateAllOfMicrosoftGraph',
202
+ :'assignee_mode' => :'String',
203
+ :'assigned_students' => :'Array<String>',
204
+ :'class_group_ids' => :'Array<String>'
205
+ }
206
+ end
207
+
208
+ # List of attributes with nullable: true
209
+ def self.openapi_nullable
210
+ Set.new([
211
+ :'due_date',
212
+ :'scheduled_date',
213
+ :'class_group_ids'
214
+ ])
215
+ end
216
+
217
+ # List of class defined in allOf (OpenAPI v3)
218
+ def self.openapi_all_of
219
+ [
220
+ :'AssignmentUpdate'
221
+ ]
222
+ end
223
+
224
+ # Initializes the object
225
+ # @param [Hash] attributes Model attributes in the form of hash
226
+ def initialize(attributes = {})
227
+ if (!attributes.is_a?(Hash))
228
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ClassAssignmentUpdate` initialize method"
229
+ end
230
+
231
+ # check to see if the attribute exists and convert string to symbol for hash key
232
+ acceptable_attribute_map = self.class.acceptable_attribute_map
233
+ attributes = attributes.each_with_object({}) { |(k, v), h|
234
+ if (!acceptable_attribute_map.key?(k.to_sym))
235
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ClassAssignmentUpdate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
236
+ end
237
+ h[k.to_sym] = v
238
+ }
239
+
240
+ if attributes.key?(:'type')
241
+ self.type = attributes[:'type']
242
+ end
243
+
244
+ if attributes.key?(:'title')
245
+ self.title = attributes[:'title']
246
+ end
247
+
248
+ if attributes.key?(:'description')
249
+ self.description = attributes[:'description']
250
+ end
251
+
252
+ if attributes.key?(:'description_html')
253
+ self.description_html = attributes[:'description_html']
254
+ end
255
+
256
+ if attributes.key?(:'teacher_instructions')
257
+ self.teacher_instructions = attributes[:'teacher_instructions']
258
+ end
259
+
260
+ if attributes.key?(:'teacher_instructions_html')
261
+ self.teacher_instructions_html = attributes[:'teacher_instructions_html']
262
+ end
263
+
264
+ if attributes.key?(:'attachments')
265
+ if (value = attributes[:'attachments']).is_a?(Array)
266
+ self.attachments = value
267
+ end
268
+ end
269
+
270
+ if attributes.key?(:'nb_playback_authorized')
271
+ self.nb_playback_authorized = attributes[:'nb_playback_authorized']
272
+ end
273
+
274
+ if attributes.key?(:'restrict_play_note')
275
+ self.restrict_play_note = attributes[:'restrict_play_note']
276
+ end
277
+
278
+ if attributes.key?(:'restrict_to_audio_tracks')
279
+ self.restrict_to_audio_tracks = attributes[:'restrict_to_audio_tracks']
280
+ end
281
+
282
+ if attributes.key?(:'toolset')
283
+ self.toolset = attributes[:'toolset']
284
+ end
285
+
286
+ if attributes.key?(:'cover_file')
287
+ self.cover_file = attributes[:'cover_file']
288
+ end
289
+
290
+ if attributes.key?(:'cover')
291
+ self.cover = attributes[:'cover']
292
+ end
293
+
294
+ if attributes.key?(:'max_points')
295
+ self.max_points = attributes[:'max_points']
296
+ end
297
+
298
+ if attributes.key?(:'release_grades')
299
+ self.release_grades = attributes[:'release_grades']
300
+ end
301
+
302
+ if attributes.key?(:'shuffle_exercises')
303
+ self.shuffle_exercises = attributes[:'shuffle_exercises']
304
+ end
305
+
306
+ if attributes.key?(:'submission_students_mode')
307
+ self.submission_students_mode = attributes[:'submission_students_mode']
308
+ end
309
+
310
+ if attributes.key?(:'recording_type')
311
+ self.recording_type = attributes[:'recording_type']
312
+ end
313
+
314
+ if attributes.key?(:'allow_metronome')
315
+ self.allow_metronome = attributes[:'allow_metronome']
316
+ end
317
+
318
+ if attributes.key?(:'allow_backing_track')
319
+ self.allow_backing_track = attributes[:'allow_backing_track']
320
+ end
321
+
322
+ if attributes.key?(:'allow_speed_change')
323
+ self.allow_speed_change = attributes[:'allow_speed_change']
324
+ end
325
+
326
+ if attributes.key?(:'free_record')
327
+ self.free_record = attributes[:'free_record']
328
+ end
329
+
330
+ if attributes.key?(:'state')
331
+ self.state = attributes[:'state']
332
+ end
333
+
334
+ if attributes.key?(:'due_date')
335
+ self.due_date = attributes[:'due_date']
336
+ end
337
+
338
+ if attributes.key?(:'scheduled_date')
339
+ self.scheduled_date = attributes[:'scheduled_date']
340
+ end
341
+
342
+ if attributes.key?(:'google_classroom')
343
+ self.google_classroom = attributes[:'google_classroom']
344
+ end
345
+
346
+ if attributes.key?(:'microsoft_graph')
347
+ self.microsoft_graph = attributes[:'microsoft_graph']
348
+ end
349
+
350
+ if attributes.key?(:'assignee_mode')
351
+ self.assignee_mode = attributes[:'assignee_mode']
352
+ end
353
+
354
+ if attributes.key?(:'assigned_students')
355
+ if (value = attributes[:'assigned_students']).is_a?(Array)
356
+ self.assigned_students = value
357
+ end
358
+ end
359
+
360
+ if attributes.key?(:'class_group_ids')
361
+ if (value = attributes[:'class_group_ids']).is_a?(Array)
362
+ self.class_group_ids = value
363
+ end
364
+ end
365
+ end
366
+
367
+ # Show invalid properties with the reasons. Usually used together with valid?
368
+ # @return Array for valid properties with the reasons
369
+ def list_invalid_properties
370
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
371
+ invalid_properties = Array.new
372
+ if !@title.nil? && @title.to_s.length > 1000
373
+ invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 1000.')
374
+ end
375
+
376
+ if !@title.nil? && @title.to_s.length < 1
377
+ invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
378
+ end
379
+
380
+ if !@description.nil? && @description.to_s.length > 100000
381
+ invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100000.')
382
+ end
383
+
384
+ if !@description_html.nil? && @description_html.to_s.length > 20000000
385
+ invalid_properties.push('invalid value for "description_html", the character length must be smaller than or equal to 20000000.')
386
+ end
387
+
388
+ if !@teacher_instructions.nil? && @teacher_instructions.to_s.length > 100000
389
+ invalid_properties.push('invalid value for "teacher_instructions", the character length must be smaller than or equal to 100000.')
390
+ end
391
+
392
+ if !@teacher_instructions_html.nil? && @teacher_instructions_html.to_s.length > 20000000
393
+ invalid_properties.push('invalid value for "teacher_instructions_html", the character length must be smaller than or equal to 20000000.')
394
+ end
395
+
396
+ if !@max_points.nil? && @max_points > 10000
397
+ invalid_properties.push('invalid value for "max_points", must be smaller than or equal to 10000.')
398
+ end
399
+
400
+ if !@max_points.nil? && @max_points < 0
401
+ invalid_properties.push('invalid value for "max_points", must be greater than or equal to 0.')
402
+ end
403
+
404
+ invalid_properties
405
+ end
406
+
407
+ # Check to see if the all the properties in the model are valid
408
+ # @return true if the model is valid
409
+ def valid?
410
+ warn '[DEPRECATED] the `valid?` method is obsolete'
411
+ return false if !@title.nil? && @title.to_s.length > 1000
412
+ return false if !@title.nil? && @title.to_s.length < 1
413
+ return false if !@description.nil? && @description.to_s.length > 100000
414
+ return false if !@description_html.nil? && @description_html.to_s.length > 20000000
415
+ return false if !@teacher_instructions.nil? && @teacher_instructions.to_s.length > 100000
416
+ return false if !@teacher_instructions_html.nil? && @teacher_instructions_html.to_s.length > 20000000
417
+ return false if !@max_points.nil? && @max_points > 10000
418
+ return false if !@max_points.nil? && @max_points < 0
419
+ release_grades_validator = EnumAttributeValidator.new('String', ["auto", "manual"])
420
+ return false unless release_grades_validator.valid?(@release_grades)
421
+ recording_type_validator = EnumAttributeValidator.new('String', ["audio", "video"])
422
+ return false unless recording_type_validator.valid?(@recording_type)
423
+ state_validator = EnumAttributeValidator.new('String', ["draft", "active"])
424
+ return false unless state_validator.valid?(@state)
425
+ assignee_mode_validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
426
+ return false unless assignee_mode_validator.valid?(@assignee_mode)
427
+ true
428
+ end
429
+
430
+ # Custom attribute writer method with validation
431
+ # @param [Object] title Value to be assigned
432
+ def title=(title)
433
+ if title.nil?
434
+ fail ArgumentError, 'title cannot be nil'
435
+ end
436
+
437
+ if title.to_s.length > 1000
438
+ fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 1000.'
439
+ end
440
+
441
+ if title.to_s.length < 1
442
+ fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
443
+ end
444
+
445
+ @title = title
446
+ end
447
+
448
+ # Custom attribute writer method with validation
449
+ # @param [Object] description Value to be assigned
450
+ def description=(description)
451
+ if description.nil?
452
+ fail ArgumentError, 'description cannot be nil'
453
+ end
454
+
455
+ if description.to_s.length > 100000
456
+ fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 100000.'
457
+ end
458
+
459
+ @description = description
460
+ end
461
+
462
+ # Custom attribute writer method with validation
463
+ # @param [Object] description_html Value to be assigned
464
+ def description_html=(description_html)
465
+ if description_html.nil?
466
+ fail ArgumentError, 'description_html cannot be nil'
467
+ end
468
+
469
+ if description_html.to_s.length > 20000000
470
+ fail ArgumentError, 'invalid value for "description_html", the character length must be smaller than or equal to 20000000.'
471
+ end
472
+
473
+ @description_html = description_html
474
+ end
475
+
476
+ # Custom attribute writer method with validation
477
+ # @param [Object] teacher_instructions Value to be assigned
478
+ def teacher_instructions=(teacher_instructions)
479
+ if teacher_instructions.nil?
480
+ fail ArgumentError, 'teacher_instructions cannot be nil'
481
+ end
482
+
483
+ if teacher_instructions.to_s.length > 100000
484
+ fail ArgumentError, 'invalid value for "teacher_instructions", the character length must be smaller than or equal to 100000.'
485
+ end
486
+
487
+ @teacher_instructions = teacher_instructions
488
+ end
489
+
490
+ # Custom attribute writer method with validation
491
+ # @param [Object] teacher_instructions_html Value to be assigned
492
+ def teacher_instructions_html=(teacher_instructions_html)
493
+ if teacher_instructions_html.nil?
494
+ fail ArgumentError, 'teacher_instructions_html cannot be nil'
495
+ end
496
+
497
+ if teacher_instructions_html.to_s.length > 20000000
498
+ fail ArgumentError, 'invalid value for "teacher_instructions_html", the character length must be smaller than or equal to 20000000.'
499
+ end
500
+
501
+ @teacher_instructions_html = teacher_instructions_html
502
+ end
503
+
504
+ # Custom attribute writer method with validation
505
+ # @param [Object] max_points Value to be assigned
506
+ def max_points=(max_points)
507
+ if max_points.nil?
508
+ fail ArgumentError, 'max_points cannot be nil'
509
+ end
510
+
511
+ if max_points > 10000
512
+ fail ArgumentError, 'invalid value for "max_points", must be smaller than or equal to 10000.'
513
+ end
514
+
515
+ if max_points < 0
516
+ fail ArgumentError, 'invalid value for "max_points", must be greater than or equal to 0.'
517
+ end
518
+
519
+ @max_points = max_points
520
+ end
521
+
522
+ # Custom attribute writer method checking allowed values (enum).
523
+ # @param [Object] release_grades Object to be assigned
524
+ def release_grades=(release_grades)
525
+ validator = EnumAttributeValidator.new('String', ["auto", "manual"])
526
+ unless validator.valid?(release_grades)
527
+ fail ArgumentError, "invalid value for \"release_grades\", must be one of #{validator.allowable_values}."
528
+ end
529
+ @release_grades = release_grades
530
+ end
531
+
532
+ # Custom attribute writer method checking allowed values (enum).
533
+ # @param [Object] recording_type Object to be assigned
534
+ def recording_type=(recording_type)
535
+ validator = EnumAttributeValidator.new('String', ["audio", "video"])
536
+ unless validator.valid?(recording_type)
537
+ fail ArgumentError, "invalid value for \"recording_type\", must be one of #{validator.allowable_values}."
538
+ end
539
+ @recording_type = recording_type
540
+ end
541
+
542
+ # Custom attribute writer method checking allowed values (enum).
543
+ # @param [Object] state Object to be assigned
544
+ def state=(state)
545
+ validator = EnumAttributeValidator.new('String', ["draft", "active"])
546
+ unless validator.valid?(state)
547
+ fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
548
+ end
549
+ @state = state
550
+ end
551
+
552
+ # Custom attribute writer method checking allowed values (enum).
553
+ # @param [Object] assignee_mode Object to be assigned
554
+ def assignee_mode=(assignee_mode)
555
+ validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
556
+ unless validator.valid?(assignee_mode)
557
+ fail ArgumentError, "invalid value for \"assignee_mode\", must be one of #{validator.allowable_values}."
558
+ end
559
+ @assignee_mode = assignee_mode
560
+ end
561
+
562
+ # Checks equality by comparing each attribute.
563
+ # @param [Object] Object to be compared
564
+ def ==(o)
565
+ return true if self.equal?(o)
566
+ self.class == o.class &&
567
+ type == o.type &&
568
+ title == o.title &&
569
+ description == o.description &&
570
+ description_html == o.description_html &&
571
+ teacher_instructions == o.teacher_instructions &&
572
+ teacher_instructions_html == o.teacher_instructions_html &&
573
+ attachments == o.attachments &&
574
+ nb_playback_authorized == o.nb_playback_authorized &&
575
+ restrict_play_note == o.restrict_play_note &&
576
+ restrict_to_audio_tracks == o.restrict_to_audio_tracks &&
577
+ toolset == o.toolset &&
578
+ cover_file == o.cover_file &&
579
+ cover == o.cover &&
580
+ max_points == o.max_points &&
581
+ release_grades == o.release_grades &&
582
+ shuffle_exercises == o.shuffle_exercises &&
583
+ submission_students_mode == o.submission_students_mode &&
584
+ recording_type == o.recording_type &&
585
+ allow_metronome == o.allow_metronome &&
586
+ allow_backing_track == o.allow_backing_track &&
587
+ allow_speed_change == o.allow_speed_change &&
588
+ free_record == o.free_record &&
589
+ state == o.state &&
590
+ due_date == o.due_date &&
591
+ scheduled_date == o.scheduled_date &&
592
+ google_classroom == o.google_classroom &&
593
+ microsoft_graph == o.microsoft_graph &&
594
+ assignee_mode == o.assignee_mode &&
595
+ assigned_students == o.assigned_students &&
596
+ class_group_ids == o.class_group_ids
597
+ end
598
+
599
+ # @see the `==` method
600
+ # @param [Object] Object to be compared
601
+ def eql?(o)
602
+ self == o
603
+ end
604
+
605
+ # Calculates hash code according to all attributes.
606
+ # @return [Integer] Hash code
607
+ def hash
608
+ [type, title, description, description_html, teacher_instructions, teacher_instructions_html, attachments, nb_playback_authorized, restrict_play_note, restrict_to_audio_tracks, toolset, cover_file, cover, max_points, release_grades, shuffle_exercises, submission_students_mode, recording_type, allow_metronome, allow_backing_track, allow_speed_change, free_record, state, due_date, scheduled_date, google_classroom, microsoft_graph, assignee_mode, assigned_students, class_group_ids].hash
609
+ end
610
+
611
+ # Builds the object from hash
612
+ # @param [Hash] attributes Model attributes in the form of hash
613
+ # @return [Object] Returns the model itself
614
+ def self.build_from_hash(attributes)
615
+ return nil unless attributes.is_a?(Hash)
616
+ attributes = attributes.transform_keys(&:to_sym)
617
+ transformed_hash = {}
618
+ openapi_types.each_pair do |key, type|
619
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
620
+ transformed_hash["#{key}"] = nil
621
+ elsif type =~ /\AArray<(.*)>/i
622
+ # check to ensure the input is an array given that the attribute
623
+ # is documented as an array but the input is not
624
+ if attributes[attribute_map[key]].is_a?(Array)
625
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
626
+ end
627
+ elsif !attributes[attribute_map[key]].nil?
628
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
629
+ end
630
+ end
631
+ new(transformed_hash)
632
+ end
633
+
634
+ # Returns the object in the form of hash
635
+ # @return [Hash] Returns the object in the form of hash
636
+ def to_hash
637
+ hash = {}
638
+ self.class.attribute_map.each_pair do |attr, param|
639
+ value = self.send(attr)
640
+ if value.nil?
641
+ is_nullable = self.class.openapi_nullable.include?(attr)
642
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
643
+ end
644
+
645
+ hash[param] = _to_hash(value)
646
+ end
647
+ hash
648
+ end
649
+
650
+ end
651
+
652
+ end