flat_api 0.3.5 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +69 -0
- data/LICENSE +201 -0
- data/README.md +92 -0
- data/lib/flat_api/api/account_api.rb +4 -4
- data/lib/flat_api/api/class_api.rb +281 -63
- data/lib/flat_api/api/collection_api.rb +63 -50
- data/lib/flat_api/api/edu_resources_api.rb +38 -26
- data/lib/flat_api/api/group_api.rb +432 -9
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +307 -35
- data/lib/flat_api/api/score_api.rb +129 -80
- data/lib/flat_api/api/task_api.rb +5 -5
- data/lib/flat_api/api/user_api.rb +45 -14
- data/lib/flat_api/api_client.rb +169 -96
- data/lib/flat_api/api_error.rb +3 -3
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +124 -25
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +13 -80
- data/lib/flat_api/models/app_scopes.rb +6 -4
- data/lib/flat_api/models/assignment.rb +190 -85
- data/lib/flat_api/models/assignment_capabilities.rb +53 -80
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +33 -80
- data/lib/flat_api/models/assignment_copy.rb +5 -6
- data/lib/flat_api/models/assignment_copy_response.rb +187 -82
- data/lib/flat_api/models/assignment_copy_to_class.rb +23 -80
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +23 -80
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +104 -81
- data/lib/flat_api/models/assignment_submission_comment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +23 -80
- data/lib/flat_api/models/assignment_submission_comments.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history.rb +33 -80
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_lti.rb +64 -86
- data/lib/flat_api/models/{assignment_submission_playback_inner.rb → assignment_submission_playback.rb} +36 -83
- data/lib/flat_api/models/assignment_submission_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +25 -81
- data/lib/flat_api/models/assignment_type.rb +5 -4
- data/lib/flat_api/models/assignment_update.rb +218 -87
- data/lib/flat_api/models/class_assignment.rb +219 -82
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +13 -80
- data/lib/flat_api/models/class_assignment_update.rb +237 -94
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_attachment_creation.rb +51 -86
- data/lib/flat_api/models/class_creation.rb +13 -80
- data/lib/flat_api/models/class_details.rb +85 -81
- data/lib/flat_api/models/class_details_canvas.rb +13 -80
- data/lib/flat_api/models/class_details_clever.rb +13 -80
- data/lib/flat_api/models/class_details_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_details_google_drive.rb +13 -80
- data/lib/flat_api/models/class_details_issues.rb +13 -80
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +15 -82
- data/lib/flat_api/models/class_details_lti.rb +28 -85
- data/lib/flat_api/models/class_details_mfc.rb +13 -80
- data/lib/flat_api/models/class_details_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_grade_level.rb +3 -3
- data/lib/flat_api/models/class_roles.rb +3 -3
- data/lib/flat_api/models/class_state.rb +5 -4
- data/lib/flat_api/models/class_update.rb +13 -80
- data/lib/flat_api/models/collection.rb +182 -81
- data/lib/flat_api/models/collection_app.rb +13 -80
- data/lib/flat_api/models/collection_capabilities.rb +63 -80
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +20 -99
- data/lib/flat_api/models/collection_modification.rb +17 -82
- data/lib/flat_api/models/collection_privacy.rb +3 -3
- data/lib/flat_api/models/collection_type.rb +7 -6
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +63 -82
- data/lib/flat_api/models/edu_resource.rb +101 -84
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +27 -84
- data/lib/flat_api/models/edu_resource_copy.rb +23 -80
- data/lib/flat_api/models/edu_resource_creation.rb +96 -86
- data/lib/flat_api/models/edu_resource_folder.rb +39 -84
- data/lib/flat_api/models/edu_resource_lti_link.rb +23 -80
- data/lib/flat_api/models/edu_resource_move.rb +23 -80
- data/lib/flat_api/models/edu_resource_privacy.rb +3 -3
- data/lib/flat_api/models/edu_resource_resource.rb +5 -6
- data/lib/flat_api/models/edu_resource_type.rb +3 -3
- data/lib/flat_api/models/edu_resource_update.rb +101 -86
- data/lib/flat_api/models/edu_resource_use_in_class.rb +23 -80
- data/lib/flat_api/models/flat_error_response.rb +47 -84
- data/lib/flat_api/models/google_classroom_coursework.rb +13 -80
- data/lib/flat_api/models/google_classroom_submission.rb +43 -80
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +14 -94
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +178 -84
- data/lib/flat_api/models/group_type.rb +6 -4
- data/lib/flat_api/models/license_mode.rb +3 -3
- data/lib/flat_api/models/license_sources.rb +3 -3
- data/lib/flat_api/models/lms_name.rb +3 -3
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +29 -84
- data/lib/flat_api/models/lti_credentials_creation.rb +23 -80
- data/lib/flat_api/models/media_attachment.rb +43 -88
- data/lib/flat_api/models/media_score_sharing_mode.rb +3 -3
- data/lib/flat_api/models/microsoft_graph_assignment.rb +99 -88
- data/lib/flat_api/models/microsoft_graph_submission.rb +33 -80
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +54 -81
- data/lib/flat_api/models/organization_invitation_creation.rb +15 -82
- data/lib/flat_api/models/organization_roles.rb +5 -5
- data/lib/flat_api/models/organization_user_access_token_creation.rb +23 -80
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +43 -85
- data/lib/flat_api/models/resource_collaborator_creation.rb +13 -80
- data/lib/flat_api/models/resource_rights.rb +43 -85
- data/lib/flat_api/models/score_comment.rb +122 -80
- data/lib/flat_api/models/score_comment_context.rb +73 -80
- data/lib/flat_api/models/score_comment_creation.rb +24 -81
- data/lib/flat_api/models/score_comment_moderation.rb +13 -80
- data/lib/flat_api/models/score_comment_update.rb +18 -85
- data/lib/flat_api/models/score_comments_counts.rb +28 -85
- data/lib/flat_api/models/score_creation.rb +5 -6
- data/lib/flat_api/models/score_creation_builder_data.rb +24 -88
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +23 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +13 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +24 -81
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +33 -80
- data/lib/flat_api/models/score_creation_common.rb +14 -81
- data/lib/flat_api/models/score_creation_file_import.rb +39 -86
- data/lib/flat_api/models/score_creation_google_drive_import.rb +24 -81
- data/lib/flat_api/models/score_creation_type.rb +4 -5
- data/lib/flat_api/models/score_details.rb +180 -89
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +14 -83
- data/lib/flat_api/models/score_license.rb +4 -5
- data/lib/flat_api/models/score_likes_counts.rb +28 -106
- data/lib/flat_api/models/score_modification.rb +13 -80
- data/lib/flat_api/models/score_plays_counts.rb +28 -85
- data/lib/flat_api/models/score_privacy.rb +3 -3
- data/lib/flat_api/models/score_revision.rb +81 -87
- data/lib/flat_api/models/score_revision_creation.rb +23 -80
- data/lib/flat_api/models/score_revision_statistics.rb +13 -80
- data/lib/flat_api/models/score_source.rb +13 -80
- data/lib/flat_api/models/score_summary.rb +63 -80
- data/lib/flat_api/models/score_track.rb +94 -88
- data/lib/flat_api/models/score_track_creation.rb +13 -80
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +23 -80
- data/lib/flat_api/models/score_track_purpose.rb +3 -3
- data/lib/flat_api/models/score_track_state.rb +3 -3
- data/lib/flat_api/models/score_track_type.rb +3 -3
- data/lib/flat_api/models/score_track_update.rb +25 -81
- data/lib/flat_api/models/score_views_counts.rb +28 -85
- data/lib/flat_api/models/task.rb +62 -87
- data/lib/flat_api/models/task_export_options.rb +13 -80
- data/lib/flat_api/models/task_progress.rb +13 -80
- data/lib/flat_api/models/task_result.rb +13 -80
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +3 -3
- data/lib/flat_api/models/user_admin_update.rb +17 -95
- data/lib/flat_api/models/user_azure_details.rb +13 -80
- data/lib/flat_api/models/user_basics.rb +43 -80
- data/lib/flat_api/models/user_community_profile_links.rb +13 -80
- data/lib/flat_api/models/user_creation.rb +21 -98
- data/lib/flat_api/models/user_details.rb +101 -96
- data/lib/flat_api/models/user_details_admin.rb +72 -85
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +13 -80
- data/lib/flat_api/models/user_public.rb +89 -94
- data/lib/flat_api/models/user_public_summary.rb +58 -81
- data/lib/flat_api/models/user_signin_link.rb +24 -81
- data/lib/flat_api/models/user_signin_link_creation.rb +13 -80
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +4 -4
- data/lib/flat_api.rb +70 -5
- metadata +98 -330
- data/lib/flat_api/models/flat_locales.rb +0 -56
- data/spec/api/account_api_spec.rb +0 -47
- data/spec/api/class_api_spec.rb +0 -422
- data/spec/api/collection_api_spec.rb +0 -158
- data/spec/api/edu_resources_api_spec.rb +0 -181
- data/spec/api/group_api_spec.rb +0 -71
- data/spec/api/organization_api_spec.rb +0 -201
- data/spec/api/score_api_spec.rb +0 -440
- data/spec/api/task_api_spec.rb +0 -47
- data/spec/api/user_api_spec.rb +0 -75
- data/spec/models/api_access_token_spec.rb +0 -66
- data/spec/models/app_scopes_spec.rb +0 -30
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +0 -42
- data/spec/models/assignment_capabilities_spec.rb +0 -60
- data/spec/models/assignment_copy_response_spec.rb +0 -124
- data/spec/models/assignment_copy_spec.rb +0 -32
- data/spec/models/assignment_copy_to_class_spec.rb +0 -48
- data/spec/models/assignment_copy_to_resource_library_spec.rb +0 -42
- data/spec/models/assignment_spec.rb +0 -118
- data/spec/models/assignment_submission_comment_creation_spec.rb +0 -36
- data/spec/models/assignment_submission_comment_spec.rb +0 -72
- data/spec/models/assignment_submission_comments_spec.rb +0 -42
- data/spec/models/assignment_submission_history_attachment_spec.rb +0 -48
- data/spec/models/assignment_submission_history_spec.rb +0 -112
- data/spec/models/assignment_submission_history_state_spec.rb +0 -30
- data/spec/models/assignment_submission_lti_spec.rb +0 -36
- data/spec/models/assignment_submission_playback_inner_spec.rb +0 -42
- data/spec/models/assignment_submission_spec.rb +0 -144
- data/spec/models/assignment_submission_state_spec.rb +0 -30
- data/spec/models/assignment_submission_update_spec.rb +0 -66
- data/spec/models/assignment_type_spec.rb +0 -30
- data/spec/models/assignment_update_spec.rb +0 -100
- data/spec/models/class_assignment_all_of_canvas_spec.rb +0 -42
- data/spec/models/class_assignment_all_of_lti_spec.rb +0 -36
- data/spec/models/class_assignment_all_of_mfc_spec.rb +0 -42
- data/spec/models/class_assignment_spec.rb +0 -216
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +0 -36
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_assignment_update_spec.rb +0 -150
- data/spec/models/class_attachment_creation_spec.rb +0 -76
- data/spec/models/class_creation_spec.rb +0 -64
- data/spec/models/class_details_canvas_spec.rb +0 -42
- data/spec/models/class_details_clever_spec.rb +0 -76
- data/spec/models/class_details_google_classroom_spec.rb +0 -42
- data/spec/models/class_details_google_drive_spec.rb +0 -42
- data/spec/models/class_details_issues_spec.rb +0 -36
- data/spec/models/class_details_issues_sync_inner_spec.rb +0 -52
- data/spec/models/class_details_lti_spec.rb +0 -48
- data/spec/models/class_details_mfc_spec.rb +0 -42
- data/spec/models/class_details_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_details_spec.rb +0 -178
- data/spec/models/class_grade_level_spec.rb +0 -30
- data/spec/models/class_roles_spec.rb +0 -30
- data/spec/models/class_state_spec.rb +0 -30
- data/spec/models/class_update_spec.rb +0 -64
- data/spec/models/collection_app_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -60
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -30
- data/spec/models/collection_spec.rb +0 -114
- data/spec/models/collection_type_spec.rb +0 -30
- data/spec/models/edu_library_spec.rb +0 -62
- data/spec/models/edu_resource_capabilities_spec.rb +0 -48
- data/spec/models/edu_resource_copy_spec.rb +0 -36
- data/spec/models/edu_resource_creation_spec.rb +0 -48
- data/spec/models/edu_resource_folder_spec.rb +0 -36
- data/spec/models/edu_resource_lti_link_spec.rb +0 -36
- data/spec/models/edu_resource_move_spec.rb +0 -36
- data/spec/models/edu_resource_privacy_spec.rb +0 -30
- data/spec/models/edu_resource_resource_spec.rb +0 -32
- data/spec/models/edu_resource_spec.rb +0 -96
- data/spec/models/edu_resource_type_spec.rb +0 -30
- data/spec/models/edu_resource_update_spec.rb +0 -42
- data/spec/models/edu_resource_use_in_class_spec.rb +0 -42
- data/spec/models/flat_error_response_spec.rb +0 -54
- data/spec/models/flat_locales_spec.rb +0 -30
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -48
- data/spec/models/group_details_spec.rb +0 -72
- data/spec/models/group_spec.rb +0 -76
- data/spec/models/group_type_spec.rb +0 -30
- data/spec/models/license_mode_spec.rb +0 -30
- data/spec/models/license_sources_spec.rb +0 -30
- data/spec/models/lms_name_spec.rb +0 -30
- data/spec/models/lti_credentials_creation_spec.rb +0 -42
- data/spec/models/lti_credentials_spec.rb +0 -84
- data/spec/models/media_attachment_spec.rb +0 -166
- data/spec/models/media_score_sharing_mode_spec.rb +0 -30
- data/spec/models/microsoft_graph_assignment_spec.rb +0 -54
- data/spec/models/microsoft_graph_submission_spec.rb +0 -42
- data/spec/models/organization_invitation_creation_spec.rb +0 -46
- data/spec/models/organization_invitation_spec.rb +0 -84
- data/spec/models/organization_roles_spec.rb +0 -30
- data/spec/models/organization_user_access_token_creation_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -72
- data/spec/models/resource_collaborator_spec.rb +0 -112
- data/spec/models/resource_rights_spec.rb +0 -64
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -66
- data/spec/models/score_comment_moderation_spec.rb +0 -46
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -54
- data/spec/models/score_comments_counts_spec.rb +0 -54
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +0 -82
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +0 -60
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +0 -66
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +0 -42
- data/spec/models/score_creation_builder_data_spec.rb +0 -60
- data/spec/models/score_creation_common_spec.rb +0 -54
- data/spec/models/score_creation_file_import_spec.rb +0 -76
- data/spec/models/score_creation_google_drive_import_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -32
- data/spec/models/score_creation_type_spec.rb +0 -30
- data/spec/models/score_details_spec.rb +0 -240
- data/spec/models/score_fork_spec.rb +0 -48
- data/spec/models/score_license_spec.rb +0 -30
- data/spec/models/score_likes_counts_spec.rb +0 -48
- data/spec/models/score_modification_spec.rb +0 -102
- data/spec/models/score_plays_counts_spec.rb +0 -48
- data/spec/models/score_privacy_spec.rb +0 -30
- data/spec/models/score_revision_creation_spec.rb +0 -58
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -54
- data/spec/models/score_source_spec.rb +0 -36
- data/spec/models/score_summary_spec.rb +0 -66
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -52
- data/spec/models/score_track_purpose_spec.rb +0 -30
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -30
- data/spec/models/score_track_type_spec.rb +0 -30
- data/spec/models/score_track_update_spec.rb +0 -54
- data/spec/models/score_views_counts_spec.rb +0 -48
- data/spec/models/task_export_options_spec.rb +0 -36
- data/spec/models/task_progress_spec.rb +0 -42
- data/spec/models/task_result_spec.rb +0 -42
- data/spec/models/task_spec.rb +0 -100
- data/spec/models/tutteo_product_spec.rb +0 -30
- data/spec/models/user_admin_update_spec.rb +0 -66
- data/spec/models/user_azure_details_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -94
- data/spec/models/user_community_profile_links_spec.rb +0 -66
- data/spec/models/user_creation_spec.rb +0 -76
- data/spec/models/user_details_admin_all_of_license_spec.rb +0 -60
- data/spec/models/user_details_admin_spec.rb +0 -142
- data/spec/models/user_details_spec.rb +0 -214
- data/spec/models/user_public_spec.rb +0 -178
- data/spec/models/user_public_summary_spec.rb +0 -118
- data/spec/models/user_signin_link_creation_spec.rb +0 -36
- data/spec/models/user_signin_link_spec.rb +0 -42
- data/spec/spec_helper.rb +0 -111
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -43,7 +43,7 @@ module FlatApi
|
|
|
43
43
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.activate_class"
|
|
44
44
|
end
|
|
45
45
|
# resource path
|
|
46
|
-
local_var_path = '/classes/{class}/activate'.sub('{
|
|
46
|
+
local_var_path = '/classes/{class}/activate'.sub('{class}', CGI.escape(_class.to_s))
|
|
47
47
|
|
|
48
48
|
# query parameters
|
|
49
49
|
query_params = opts[:query_params] || {}
|
|
@@ -51,7 +51,7 @@ module FlatApi
|
|
|
51
51
|
# header parameters
|
|
52
52
|
header_params = opts[:header_params] || {}
|
|
53
53
|
# HTTP header 'Accept' (if needed)
|
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
55
|
|
|
56
56
|
# form parameters
|
|
57
57
|
form_params = opts[:form_params] || {}
|
|
@@ -112,7 +112,7 @@ module FlatApi
|
|
|
112
112
|
fail ArgumentError, "Missing the required parameter 'user' when calling ClassApi.add_class_user"
|
|
113
113
|
end
|
|
114
114
|
# resource path
|
|
115
|
-
local_var_path = '/classes/{class}/users/{user}'.sub('{
|
|
115
|
+
local_var_path = '/classes/{class}/users/{user}'.sub('{class}', CGI.escape(_class.to_s)).sub('{user}', CGI.escape(user.to_s))
|
|
116
116
|
|
|
117
117
|
# query parameters
|
|
118
118
|
query_params = opts[:query_params] || {}
|
|
@@ -120,7 +120,7 @@ module FlatApi
|
|
|
120
120
|
# header parameters
|
|
121
121
|
header_params = opts[:header_params] || {}
|
|
122
122
|
# HTTP header 'Accept' (if needed)
|
|
123
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
124
124
|
|
|
125
125
|
# form parameters
|
|
126
126
|
form_params = opts[:form_params] || {}
|
|
@@ -181,7 +181,7 @@ module FlatApi
|
|
|
181
181
|
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.archive_assignment"
|
|
182
182
|
end
|
|
183
183
|
# resource path
|
|
184
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/archive'.sub('{
|
|
184
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/archive'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
185
185
|
|
|
186
186
|
# query parameters
|
|
187
187
|
query_params = opts[:query_params] || {}
|
|
@@ -189,7 +189,7 @@ module FlatApi
|
|
|
189
189
|
# header parameters
|
|
190
190
|
header_params = opts[:header_params] || {}
|
|
191
191
|
# HTTP header 'Accept' (if needed)
|
|
192
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
192
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
193
193
|
|
|
194
194
|
# form parameters
|
|
195
195
|
form_params = opts[:form_params] || {}
|
|
@@ -244,7 +244,7 @@ module FlatApi
|
|
|
244
244
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.archive_class"
|
|
245
245
|
end
|
|
246
246
|
# resource path
|
|
247
|
-
local_var_path = '/classes/{class}/archive'.sub('{
|
|
247
|
+
local_var_path = '/classes/{class}/archive'.sub('{class}', CGI.escape(_class.to_s))
|
|
248
248
|
|
|
249
249
|
# query parameters
|
|
250
250
|
query_params = opts[:query_params] || {}
|
|
@@ -252,7 +252,7 @@ module FlatApi
|
|
|
252
252
|
# header parameters
|
|
253
253
|
header_params = opts[:header_params] || {}
|
|
254
254
|
# HTTP header 'Accept' (if needed)
|
|
255
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
255
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
256
256
|
|
|
257
257
|
# form parameters
|
|
258
258
|
form_params = opts[:form_params] || {}
|
|
@@ -319,7 +319,7 @@ module FlatApi
|
|
|
319
319
|
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.copy_assignment"
|
|
320
320
|
end
|
|
321
321
|
# resource path
|
|
322
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/copy'.sub('{
|
|
322
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/copy'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
323
323
|
|
|
324
324
|
# query parameters
|
|
325
325
|
query_params = opts[:query_params] || {}
|
|
@@ -327,7 +327,7 @@ module FlatApi
|
|
|
327
327
|
# header parameters
|
|
328
328
|
header_params = opts[:header_params] || {}
|
|
329
329
|
# HTTP header 'Accept' (if needed)
|
|
330
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
330
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
331
331
|
# HTTP header 'Content-Type'
|
|
332
332
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
333
333
|
if !content_type.nil?
|
|
@@ -395,7 +395,7 @@ module FlatApi
|
|
|
395
395
|
# header parameters
|
|
396
396
|
header_params = opts[:header_params] || {}
|
|
397
397
|
# HTTP header 'Accept' (if needed)
|
|
398
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
398
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
399
399
|
# HTTP header 'Content-Type'
|
|
400
400
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
401
401
|
if !content_type.nil?
|
|
@@ -461,7 +461,7 @@ module FlatApi
|
|
|
461
461
|
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.create_class_assignment"
|
|
462
462
|
end
|
|
463
463
|
# resource path
|
|
464
|
-
local_var_path = '/classes/{class}/assignments'.sub('{
|
|
464
|
+
local_var_path = '/classes/{class}/assignments'.sub('{class}', CGI.escape(_class.to_s))
|
|
465
465
|
|
|
466
466
|
# query parameters
|
|
467
467
|
query_params = opts[:query_params] || {}
|
|
@@ -469,7 +469,7 @@ module FlatApi
|
|
|
469
469
|
# header parameters
|
|
470
470
|
header_params = opts[:header_params] || {}
|
|
471
471
|
# HTTP header 'Accept' (if needed)
|
|
472
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
472
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
473
473
|
# HTTP header 'Content-Type'
|
|
474
474
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
475
475
|
if !content_type.nil?
|
|
@@ -541,7 +541,7 @@ module FlatApi
|
|
|
541
541
|
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.create_submission"
|
|
542
542
|
end
|
|
543
543
|
# resource path
|
|
544
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions'.sub('{
|
|
544
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
545
545
|
|
|
546
546
|
# query parameters
|
|
547
547
|
query_params = opts[:query_params] || {}
|
|
@@ -549,7 +549,7 @@ module FlatApi
|
|
|
549
549
|
# header parameters
|
|
550
550
|
header_params = opts[:header_params] || {}
|
|
551
551
|
# HTTP header 'Accept' (if needed)
|
|
552
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
552
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
553
553
|
# HTTP header 'Content-Type'
|
|
554
554
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
555
555
|
if !content_type.nil?
|
|
@@ -611,7 +611,7 @@ module FlatApi
|
|
|
611
611
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.create_test_student_account"
|
|
612
612
|
end
|
|
613
613
|
# resource path
|
|
614
|
-
local_var_path = '/classes/{class}/testStudent'.sub('{
|
|
614
|
+
local_var_path = '/classes/{class}/testStudent'.sub('{class}', CGI.escape(_class.to_s))
|
|
615
615
|
|
|
616
616
|
# query parameters
|
|
617
617
|
query_params = opts[:query_params] || {}
|
|
@@ -620,7 +620,7 @@ module FlatApi
|
|
|
620
620
|
# header parameters
|
|
621
621
|
header_params = opts[:header_params] || {}
|
|
622
622
|
# HTTP header 'Accept' (if needed)
|
|
623
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
623
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
624
624
|
|
|
625
625
|
# form parameters
|
|
626
626
|
form_params = opts[:form_params] || {}
|
|
@@ -651,8 +651,77 @@ module FlatApi
|
|
|
651
651
|
return data, status_code, headers
|
|
652
652
|
end
|
|
653
653
|
|
|
654
|
+
# Delete an assignment
|
|
655
|
+
# Delete an assignment. This cannot be undone, and it removes a good deal more than the assignment itself: every submission made against it, the students' dedicated copies of the attached scores, the related class stream posts and notifications, and the editor toolset. When the class is synchronized with Google Classroom or Microsoft Teams, the assignment is deleted there too. Requires the teacher role on the class, and the class must not be archived. `archiveAssignment` is almost always what you want instead: it takes the assignment out of the class stream and keeps the submissions and their grades.
|
|
656
|
+
# @param _class [String] Unique identifier of the class
|
|
657
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
658
|
+
# @param [Hash] opts the optional parameters
|
|
659
|
+
# @return [nil]
|
|
660
|
+
def delete_assignment(_class, assignment, opts = {})
|
|
661
|
+
delete_assignment_with_http_info(_class, assignment, opts)
|
|
662
|
+
nil
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
# Delete an assignment
|
|
666
|
+
# Delete an assignment. This cannot be undone, and it removes a good deal more than the assignment itself: every submission made against it, the students' dedicated copies of the attached scores, the related class stream posts and notifications, and the editor toolset. When the class is synchronized with Google Classroom or Microsoft Teams, the assignment is deleted there too. Requires the teacher role on the class, and the class must not be archived. `archiveAssignment` is almost always what you want instead: it takes the assignment out of the class stream and keeps the submissions and their grades.
|
|
667
|
+
# @param _class [String] Unique identifier of the class
|
|
668
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
669
|
+
# @param [Hash] opts the optional parameters
|
|
670
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
671
|
+
def delete_assignment_with_http_info(_class, assignment, opts = {})
|
|
672
|
+
if @api_client.config.debugging
|
|
673
|
+
@api_client.config.logger.debug 'Calling API: ClassApi.delete_assignment ...'
|
|
674
|
+
end
|
|
675
|
+
# verify the required parameter '_class' is set
|
|
676
|
+
if @api_client.config.client_side_validation && _class.nil?
|
|
677
|
+
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.delete_assignment"
|
|
678
|
+
end
|
|
679
|
+
# verify the required parameter 'assignment' is set
|
|
680
|
+
if @api_client.config.client_side_validation && assignment.nil?
|
|
681
|
+
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.delete_assignment"
|
|
682
|
+
end
|
|
683
|
+
# resource path
|
|
684
|
+
local_var_path = '/classes/{class}/assignments/{assignment}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
685
|
+
|
|
686
|
+
# query parameters
|
|
687
|
+
query_params = opts[:query_params] || {}
|
|
688
|
+
|
|
689
|
+
# header parameters
|
|
690
|
+
header_params = opts[:header_params] || {}
|
|
691
|
+
# HTTP header 'Accept' (if needed)
|
|
692
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
693
|
+
|
|
694
|
+
# form parameters
|
|
695
|
+
form_params = opts[:form_params] || {}
|
|
696
|
+
|
|
697
|
+
# http body (model)
|
|
698
|
+
post_body = opts[:debug_body]
|
|
699
|
+
|
|
700
|
+
# return_type
|
|
701
|
+
return_type = opts[:debug_return_type]
|
|
702
|
+
|
|
703
|
+
# auth_names
|
|
704
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
705
|
+
|
|
706
|
+
new_options = opts.merge(
|
|
707
|
+
:operation => :"ClassApi.delete_assignment",
|
|
708
|
+
:header_params => header_params,
|
|
709
|
+
:query_params => query_params,
|
|
710
|
+
:form_params => form_params,
|
|
711
|
+
:body => post_body,
|
|
712
|
+
:auth_names => auth_names,
|
|
713
|
+
:return_type => return_type
|
|
714
|
+
)
|
|
715
|
+
|
|
716
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
717
|
+
if @api_client.config.debugging
|
|
718
|
+
@api_client.config.logger.debug "API called: ClassApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
719
|
+
end
|
|
720
|
+
return data, status_code, headers
|
|
721
|
+
end
|
|
722
|
+
|
|
654
723
|
# Remove a user from the class
|
|
655
|
-
# This method can be used by a teacher to remove
|
|
724
|
+
# This method can be used by a teacher of the class to remove another user from it. Removing your own account is not allowed. Warning: Removing a user from the class will remove the associated resources, including the submissions and feedback related to these submissions.
|
|
656
725
|
# @param _class [String] Unique identifier of the class
|
|
657
726
|
# @param user [String] Unique identifier of the user
|
|
658
727
|
# @param [Hash] opts the optional parameters
|
|
@@ -663,7 +732,7 @@ module FlatApi
|
|
|
663
732
|
end
|
|
664
733
|
|
|
665
734
|
# Remove a user from the class
|
|
666
|
-
# This method can be used by a teacher to remove
|
|
735
|
+
# This method can be used by a teacher of the class to remove another user from it. Removing your own account is not allowed. Warning: Removing a user from the class will remove the associated resources, including the submissions and feedback related to these submissions.
|
|
667
736
|
# @param _class [String] Unique identifier of the class
|
|
668
737
|
# @param user [String] Unique identifier of the user
|
|
669
738
|
# @param [Hash] opts the optional parameters
|
|
@@ -681,7 +750,7 @@ module FlatApi
|
|
|
681
750
|
fail ArgumentError, "Missing the required parameter 'user' when calling ClassApi.delete_class_user"
|
|
682
751
|
end
|
|
683
752
|
# resource path
|
|
684
|
-
local_var_path = '/classes/{class}/users/{user}'.sub('{
|
|
753
|
+
local_var_path = '/classes/{class}/users/{user}'.sub('{class}', CGI.escape(_class.to_s)).sub('{user}', CGI.escape(user.to_s))
|
|
685
754
|
|
|
686
755
|
# query parameters
|
|
687
756
|
query_params = opts[:query_params] || {}
|
|
@@ -689,7 +758,7 @@ module FlatApi
|
|
|
689
758
|
# header parameters
|
|
690
759
|
header_params = opts[:header_params] || {}
|
|
691
760
|
# HTTP header 'Accept' (if needed)
|
|
692
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
761
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
693
762
|
|
|
694
763
|
# form parameters
|
|
695
764
|
form_params = opts[:form_params] || {}
|
|
@@ -756,7 +825,7 @@ module FlatApi
|
|
|
756
825
|
fail ArgumentError, "Missing the required parameter 'submission' when calling ClassApi.delete_submission"
|
|
757
826
|
end
|
|
758
827
|
# resource path
|
|
759
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{
|
|
828
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
760
829
|
|
|
761
830
|
# query parameters
|
|
762
831
|
query_params = opts[:query_params] || {}
|
|
@@ -764,7 +833,7 @@ module FlatApi
|
|
|
764
833
|
# header parameters
|
|
765
834
|
header_params = opts[:header_params] || {}
|
|
766
835
|
# HTTP header 'Accept' (if needed)
|
|
767
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
768
837
|
|
|
769
838
|
# form parameters
|
|
770
839
|
form_params = opts[:form_params] || {}
|
|
@@ -835,7 +904,7 @@ module FlatApi
|
|
|
835
904
|
fail ArgumentError, "Missing the required parameter 'comment' when calling ClassApi.delete_submission_comment"
|
|
836
905
|
end
|
|
837
906
|
# resource path
|
|
838
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment}'.sub('{
|
|
907
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s)).sub('{comment}', CGI.escape(comment.to_s))
|
|
839
908
|
|
|
840
909
|
# query parameters
|
|
841
910
|
query_params = opts[:query_params] || {}
|
|
@@ -843,7 +912,7 @@ module FlatApi
|
|
|
843
912
|
# header parameters
|
|
844
913
|
header_params = opts[:header_params] || {}
|
|
845
914
|
# HTTP header 'Accept' (if needed)
|
|
846
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
915
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
847
916
|
|
|
848
917
|
# form parameters
|
|
849
918
|
form_params = opts[:form_params] || {}
|
|
@@ -916,7 +985,7 @@ module FlatApi
|
|
|
916
985
|
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.edit_submission"
|
|
917
986
|
end
|
|
918
987
|
# resource path
|
|
919
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{
|
|
988
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
920
989
|
|
|
921
990
|
# query parameters
|
|
922
991
|
query_params = opts[:query_params] || {}
|
|
@@ -924,7 +993,7 @@ module FlatApi
|
|
|
924
993
|
# header parameters
|
|
925
994
|
header_params = opts[:header_params] || {}
|
|
926
995
|
# HTTP header 'Accept' (if needed)
|
|
927
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
996
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
928
997
|
# HTTP header 'Content-Type'
|
|
929
998
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
930
999
|
if !content_type.nil?
|
|
@@ -984,7 +1053,7 @@ module FlatApi
|
|
|
984
1053
|
fail ArgumentError, "Missing the required parameter 'enrollment_code' when calling ClassApi.enroll_class"
|
|
985
1054
|
end
|
|
986
1055
|
# resource path
|
|
987
|
-
local_var_path = '/classes/enroll/{enrollmentCode}'.sub('{
|
|
1056
|
+
local_var_path = '/classes/enroll/{enrollmentCode}'.sub('{enrollmentCode}', CGI.escape(enrollment_code.to_s))
|
|
988
1057
|
|
|
989
1058
|
# query parameters
|
|
990
1059
|
query_params = opts[:query_params] || {}
|
|
@@ -992,7 +1061,7 @@ module FlatApi
|
|
|
992
1061
|
# header parameters
|
|
993
1062
|
header_params = opts[:header_params] || {}
|
|
994
1063
|
# HTTP header 'Accept' (if needed)
|
|
995
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1064
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
996
1065
|
|
|
997
1066
|
# form parameters
|
|
998
1067
|
form_params = opts[:form_params] || {}
|
|
@@ -1053,7 +1122,7 @@ module FlatApi
|
|
|
1053
1122
|
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.export_submissions_reviews_as_csv"
|
|
1054
1123
|
end
|
|
1055
1124
|
# resource path
|
|
1056
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/csv'.sub('{
|
|
1125
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/csv'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
1057
1126
|
|
|
1058
1127
|
# query parameters
|
|
1059
1128
|
query_params = opts[:query_params] || {}
|
|
@@ -1061,7 +1130,7 @@ module FlatApi
|
|
|
1061
1130
|
# header parameters
|
|
1062
1131
|
header_params = opts[:header_params] || {}
|
|
1063
1132
|
# HTTP header 'Accept' (if needed)
|
|
1064
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
|
|
1133
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/csv']) unless header_params['Accept']
|
|
1065
1134
|
|
|
1066
1135
|
# form parameters
|
|
1067
1136
|
form_params = opts[:form_params] || {}
|
|
@@ -1122,7 +1191,7 @@ module FlatApi
|
|
|
1122
1191
|
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.export_submissions_reviews_as_excel"
|
|
1123
1192
|
end
|
|
1124
1193
|
# resource path
|
|
1125
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/excel'.sub('{
|
|
1194
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/excel'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
1126
1195
|
|
|
1127
1196
|
# query parameters
|
|
1128
1197
|
query_params = opts[:query_params] || {}
|
|
@@ -1130,7 +1199,7 @@ module FlatApi
|
|
|
1130
1199
|
# header parameters
|
|
1131
1200
|
header_params = opts[:header_params] || {}
|
|
1132
1201
|
# HTTP header 'Accept' (if needed)
|
|
1133
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
|
1202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) unless header_params['Accept']
|
|
1134
1203
|
|
|
1135
1204
|
# form parameters
|
|
1136
1205
|
form_params = opts[:form_params] || {}
|
|
@@ -1161,6 +1230,75 @@ module FlatApi
|
|
|
1161
1230
|
return data, status_code, headers
|
|
1162
1231
|
end
|
|
1163
1232
|
|
|
1233
|
+
# Get an assignment
|
|
1234
|
+
# Retrieve a single assignment, including its attachments, its toolset and its grading settings. Use `listAssignments` to enumerate the assignments of a class. A teacher of the class sees the assignment as authored. A student sees the same document with the teacher-only fields omitted, `teacherInstructions` among them.
|
|
1235
|
+
# @param _class [String] Unique identifier of the class
|
|
1236
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
1237
|
+
# @param [Hash] opts the optional parameters
|
|
1238
|
+
# @return [Assignment]
|
|
1239
|
+
def get_assignment(_class, assignment, opts = {})
|
|
1240
|
+
data, _status_code, _headers = get_assignment_with_http_info(_class, assignment, opts)
|
|
1241
|
+
data
|
|
1242
|
+
end
|
|
1243
|
+
|
|
1244
|
+
# Get an assignment
|
|
1245
|
+
# Retrieve a single assignment, including its attachments, its toolset and its grading settings. Use `listAssignments` to enumerate the assignments of a class. A teacher of the class sees the assignment as authored. A student sees the same document with the teacher-only fields omitted, `teacherInstructions` among them.
|
|
1246
|
+
# @param _class [String] Unique identifier of the class
|
|
1247
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
1248
|
+
# @param [Hash] opts the optional parameters
|
|
1249
|
+
# @return [Array<(Assignment, Integer, Hash)>] Assignment data, response status code and response headers
|
|
1250
|
+
def get_assignment_with_http_info(_class, assignment, opts = {})
|
|
1251
|
+
if @api_client.config.debugging
|
|
1252
|
+
@api_client.config.logger.debug 'Calling API: ClassApi.get_assignment ...'
|
|
1253
|
+
end
|
|
1254
|
+
# verify the required parameter '_class' is set
|
|
1255
|
+
if @api_client.config.client_side_validation && _class.nil?
|
|
1256
|
+
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.get_assignment"
|
|
1257
|
+
end
|
|
1258
|
+
# verify the required parameter 'assignment' is set
|
|
1259
|
+
if @api_client.config.client_side_validation && assignment.nil?
|
|
1260
|
+
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.get_assignment"
|
|
1261
|
+
end
|
|
1262
|
+
# resource path
|
|
1263
|
+
local_var_path = '/classes/{class}/assignments/{assignment}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
1264
|
+
|
|
1265
|
+
# query parameters
|
|
1266
|
+
query_params = opts[:query_params] || {}
|
|
1267
|
+
|
|
1268
|
+
# header parameters
|
|
1269
|
+
header_params = opts[:header_params] || {}
|
|
1270
|
+
# HTTP header 'Accept' (if needed)
|
|
1271
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1272
|
+
|
|
1273
|
+
# form parameters
|
|
1274
|
+
form_params = opts[:form_params] || {}
|
|
1275
|
+
|
|
1276
|
+
# http body (model)
|
|
1277
|
+
post_body = opts[:debug_body]
|
|
1278
|
+
|
|
1279
|
+
# return_type
|
|
1280
|
+
return_type = opts[:debug_return_type] || 'Assignment'
|
|
1281
|
+
|
|
1282
|
+
# auth_names
|
|
1283
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
1284
|
+
|
|
1285
|
+
new_options = opts.merge(
|
|
1286
|
+
:operation => :"ClassApi.get_assignment",
|
|
1287
|
+
:header_params => header_params,
|
|
1288
|
+
:query_params => query_params,
|
|
1289
|
+
:form_params => form_params,
|
|
1290
|
+
:body => post_body,
|
|
1291
|
+
:auth_names => auth_names,
|
|
1292
|
+
:return_type => return_type
|
|
1293
|
+
)
|
|
1294
|
+
|
|
1295
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1296
|
+
if @api_client.config.debugging
|
|
1297
|
+
@api_client.config.logger.debug "API called: ClassApi#get_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1298
|
+
end
|
|
1299
|
+
return data, status_code, headers
|
|
1300
|
+
end
|
|
1301
|
+
|
|
1164
1302
|
# Get the details of a single class
|
|
1165
1303
|
# @param _class [String] Unique identifier of the class
|
|
1166
1304
|
# @param [Hash] opts the optional parameters
|
|
@@ -1183,7 +1321,7 @@ module FlatApi
|
|
|
1183
1321
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.get_class"
|
|
1184
1322
|
end
|
|
1185
1323
|
# resource path
|
|
1186
|
-
local_var_path = '/classes/{class}'.sub('{
|
|
1324
|
+
local_var_path = '/classes/{class}'.sub('{class}', CGI.escape(_class.to_s))
|
|
1187
1325
|
|
|
1188
1326
|
# query parameters
|
|
1189
1327
|
query_params = opts[:query_params] || {}
|
|
@@ -1191,7 +1329,7 @@ module FlatApi
|
|
|
1191
1329
|
# header parameters
|
|
1192
1330
|
header_params = opts[:header_params] || {}
|
|
1193
1331
|
# HTTP header 'Accept' (if needed)
|
|
1194
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1332
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1195
1333
|
|
|
1196
1334
|
# form parameters
|
|
1197
1335
|
form_params = opts[:form_params] || {}
|
|
@@ -1246,7 +1384,7 @@ module FlatApi
|
|
|
1246
1384
|
fail ArgumentError, "Missing the required parameter 'score' when calling ClassApi.get_score_submissions"
|
|
1247
1385
|
end
|
|
1248
1386
|
# resource path
|
|
1249
|
-
local_var_path = '/scores/{score}/submissions'.sub('{
|
|
1387
|
+
local_var_path = '/scores/{score}/submissions'.sub('{score}', CGI.escape(score.to_s))
|
|
1250
1388
|
|
|
1251
1389
|
# query parameters
|
|
1252
1390
|
query_params = opts[:query_params] || {}
|
|
@@ -1254,7 +1392,7 @@ module FlatApi
|
|
|
1254
1392
|
# header parameters
|
|
1255
1393
|
header_params = opts[:header_params] || {}
|
|
1256
1394
|
# HTTP header 'Accept' (if needed)
|
|
1257
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1395
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1258
1396
|
|
|
1259
1397
|
# form parameters
|
|
1260
1398
|
form_params = opts[:form_params] || {}
|
|
@@ -1319,7 +1457,7 @@ module FlatApi
|
|
|
1319
1457
|
fail ArgumentError, "Missing the required parameter 'submission' when calling ClassApi.get_submission"
|
|
1320
1458
|
end
|
|
1321
1459
|
# resource path
|
|
1322
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{
|
|
1460
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
1323
1461
|
|
|
1324
1462
|
# query parameters
|
|
1325
1463
|
query_params = opts[:query_params] || {}
|
|
@@ -1327,7 +1465,7 @@ module FlatApi
|
|
|
1327
1465
|
# header parameters
|
|
1328
1466
|
header_params = opts[:header_params] || {}
|
|
1329
1467
|
# HTTP header 'Accept' (if needed)
|
|
1330
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1468
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1331
1469
|
|
|
1332
1470
|
# form parameters
|
|
1333
1471
|
form_params = opts[:form_params] || {}
|
|
@@ -1392,7 +1530,7 @@ module FlatApi
|
|
|
1392
1530
|
fail ArgumentError, "Missing the required parameter 'submission' when calling ClassApi.get_submission_comments"
|
|
1393
1531
|
end
|
|
1394
1532
|
# resource path
|
|
1395
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments'.sub('{
|
|
1533
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
1396
1534
|
|
|
1397
1535
|
# query parameters
|
|
1398
1536
|
query_params = opts[:query_params] || {}
|
|
@@ -1400,7 +1538,7 @@ module FlatApi
|
|
|
1400
1538
|
# header parameters
|
|
1401
1539
|
header_params = opts[:header_params] || {}
|
|
1402
1540
|
# HTTP header 'Accept' (if needed)
|
|
1403
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1541
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1404
1542
|
|
|
1405
1543
|
# form parameters
|
|
1406
1544
|
form_params = opts[:form_params] || {}
|
|
@@ -1467,7 +1605,7 @@ module FlatApi
|
|
|
1467
1605
|
fail ArgumentError, "Missing the required parameter 'submission' when calling ClassApi.get_submission_history"
|
|
1468
1606
|
end
|
|
1469
1607
|
# resource path
|
|
1470
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/history'.sub('{
|
|
1608
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/history'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
1471
1609
|
|
|
1472
1610
|
# query parameters
|
|
1473
1611
|
query_params = opts[:query_params] || {}
|
|
@@ -1475,7 +1613,7 @@ module FlatApi
|
|
|
1475
1613
|
# header parameters
|
|
1476
1614
|
header_params = opts[:header_params] || {}
|
|
1477
1615
|
# HTTP header 'Accept' (if needed)
|
|
1478
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1616
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1479
1617
|
|
|
1480
1618
|
# form parameters
|
|
1481
1619
|
form_params = opts[:form_params] || {}
|
|
@@ -1534,7 +1672,7 @@ module FlatApi
|
|
|
1534
1672
|
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.get_submissions"
|
|
1535
1673
|
end
|
|
1536
1674
|
# resource path
|
|
1537
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions'.sub('{
|
|
1675
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
1538
1676
|
|
|
1539
1677
|
# query parameters
|
|
1540
1678
|
query_params = opts[:query_params] || {}
|
|
@@ -1542,7 +1680,7 @@ module FlatApi
|
|
|
1542
1680
|
# header parameters
|
|
1543
1681
|
header_params = opts[:header_params] || {}
|
|
1544
1682
|
# HTTP header 'Accept' (if needed)
|
|
1545
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1683
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1546
1684
|
|
|
1547
1685
|
# form parameters
|
|
1548
1686
|
form_params = opts[:form_params] || {}
|
|
@@ -1595,7 +1733,7 @@ module FlatApi
|
|
|
1595
1733
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.list_assignments"
|
|
1596
1734
|
end
|
|
1597
1735
|
# resource path
|
|
1598
|
-
local_var_path = '/classes/{class}/assignments'.sub('{
|
|
1736
|
+
local_var_path = '/classes/{class}/assignments'.sub('{class}', CGI.escape(_class.to_s))
|
|
1599
1737
|
|
|
1600
1738
|
# query parameters
|
|
1601
1739
|
query_params = opts[:query_params] || {}
|
|
@@ -1603,7 +1741,7 @@ module FlatApi
|
|
|
1603
1741
|
# header parameters
|
|
1604
1742
|
header_params = opts[:header_params] || {}
|
|
1605
1743
|
# HTTP header 'Accept' (if needed)
|
|
1606
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1744
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1607
1745
|
|
|
1608
1746
|
# form parameters
|
|
1609
1747
|
form_params = opts[:form_params] || {}
|
|
@@ -1664,7 +1802,7 @@ module FlatApi
|
|
|
1664
1802
|
fail ArgumentError, "Missing the required parameter 'user' when calling ClassApi.list_class_student_submissions"
|
|
1665
1803
|
end
|
|
1666
1804
|
# resource path
|
|
1667
|
-
local_var_path = '/classes/{class}/students/{user}/submissions'.sub('{
|
|
1805
|
+
local_var_path = '/classes/{class}/students/{user}/submissions'.sub('{class}', CGI.escape(_class.to_s)).sub('{user}', CGI.escape(user.to_s))
|
|
1668
1806
|
|
|
1669
1807
|
# query parameters
|
|
1670
1808
|
query_params = opts[:query_params] || {}
|
|
@@ -1672,7 +1810,7 @@ module FlatApi
|
|
|
1672
1810
|
# header parameters
|
|
1673
1811
|
header_params = opts[:header_params] || {}
|
|
1674
1812
|
# HTTP header 'Accept' (if needed)
|
|
1675
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1813
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1676
1814
|
|
|
1677
1815
|
# form parameters
|
|
1678
1816
|
form_params = opts[:form_params] || {}
|
|
@@ -1734,7 +1872,7 @@ module FlatApi
|
|
|
1734
1872
|
# header parameters
|
|
1735
1873
|
header_params = opts[:header_params] || {}
|
|
1736
1874
|
# HTTP header 'Accept' (if needed)
|
|
1737
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1875
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1738
1876
|
|
|
1739
1877
|
# form parameters
|
|
1740
1878
|
form_params = opts[:form_params] || {}
|
|
@@ -1805,7 +1943,7 @@ module FlatApi
|
|
|
1805
1943
|
fail ArgumentError, "Missing the required parameter 'assignment_submission_comment_creation' when calling ClassApi.post_submission_comment"
|
|
1806
1944
|
end
|
|
1807
1945
|
# resource path
|
|
1808
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments'.sub('{
|
|
1946
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s))
|
|
1809
1947
|
|
|
1810
1948
|
# query parameters
|
|
1811
1949
|
query_params = opts[:query_params] || {}
|
|
@@ -1813,7 +1951,7 @@ module FlatApi
|
|
|
1813
1951
|
# header parameters
|
|
1814
1952
|
header_params = opts[:header_params] || {}
|
|
1815
1953
|
# HTTP header 'Accept' (if needed)
|
|
1816
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1954
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1817
1955
|
# HTTP header 'Content-Type'
|
|
1818
1956
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1819
1957
|
if !content_type.nil?
|
|
@@ -1879,7 +2017,7 @@ module FlatApi
|
|
|
1879
2017
|
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.unarchive_assignment"
|
|
1880
2018
|
end
|
|
1881
2019
|
# resource path
|
|
1882
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/archive'.sub('{
|
|
2020
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/archive'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
1883
2021
|
|
|
1884
2022
|
# query parameters
|
|
1885
2023
|
query_params = opts[:query_params] || {}
|
|
@@ -1887,7 +2025,7 @@ module FlatApi
|
|
|
1887
2025
|
# header parameters
|
|
1888
2026
|
header_params = opts[:header_params] || {}
|
|
1889
2027
|
# HTTP header 'Accept' (if needed)
|
|
1890
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2028
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1891
2029
|
|
|
1892
2030
|
# form parameters
|
|
1893
2031
|
form_params = opts[:form_params] || {}
|
|
@@ -1942,7 +2080,7 @@ module FlatApi
|
|
|
1942
2080
|
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.unarchive_class"
|
|
1943
2081
|
end
|
|
1944
2082
|
# resource path
|
|
1945
|
-
local_var_path = '/classes/{class}/archive'.sub('{
|
|
2083
|
+
local_var_path = '/classes/{class}/archive'.sub('{class}', CGI.escape(_class.to_s))
|
|
1946
2084
|
|
|
1947
2085
|
# query parameters
|
|
1948
2086
|
query_params = opts[:query_params] || {}
|
|
@@ -1950,7 +2088,7 @@ module FlatApi
|
|
|
1950
2088
|
# header parameters
|
|
1951
2089
|
header_params = opts[:header_params] || {}
|
|
1952
2090
|
# HTTP header 'Accept' (if needed)
|
|
1953
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2091
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1954
2092
|
|
|
1955
2093
|
# form parameters
|
|
1956
2094
|
form_params = opts[:form_params] || {}
|
|
@@ -2011,7 +2149,7 @@ module FlatApi
|
|
|
2011
2149
|
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.update_class"
|
|
2012
2150
|
end
|
|
2013
2151
|
# resource path
|
|
2014
|
-
local_var_path = '/classes/{class}'.sub('{
|
|
2152
|
+
local_var_path = '/classes/{class}'.sub('{class}', CGI.escape(_class.to_s))
|
|
2015
2153
|
|
|
2016
2154
|
# query parameters
|
|
2017
2155
|
query_params = opts[:query_params] || {}
|
|
@@ -2019,7 +2157,7 @@ module FlatApi
|
|
|
2019
2157
|
# header parameters
|
|
2020
2158
|
header_params = opts[:header_params] || {}
|
|
2021
2159
|
# HTTP header 'Accept' (if needed)
|
|
2022
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2160
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2023
2161
|
# HTTP header 'Content-Type'
|
|
2024
2162
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2025
2163
|
if !content_type.nil?
|
|
@@ -2055,6 +2193,86 @@ module FlatApi
|
|
|
2055
2193
|
return data, status_code, headers
|
|
2056
2194
|
end
|
|
2057
2195
|
|
|
2196
|
+
# Update an assignment
|
|
2197
|
+
# Update an assignment. Only the properties present in the request body are modified, so a partial body leaves everything else as it was. `attachments` is the exception: when present it replaces the whole list. Requires the teacher role on the class. The class must not be archived, and an assignment that is already `active` cannot be moved back to `draft`. Editing an assignment that students have already started does not reset their submissions. To take an assignment out of circulation while keeping the work, use `archiveAssignment`.
|
|
2198
|
+
# @param _class [String] Unique identifier of the class
|
|
2199
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
2200
|
+
# @param body [ClassAssignmentUpdate]
|
|
2201
|
+
# @param [Hash] opts the optional parameters
|
|
2202
|
+
# @return [Assignment]
|
|
2203
|
+
def update_class_assignment(_class, assignment, body, opts = {})
|
|
2204
|
+
data, _status_code, _headers = update_class_assignment_with_http_info(_class, assignment, body, opts)
|
|
2205
|
+
data
|
|
2206
|
+
end
|
|
2207
|
+
|
|
2208
|
+
# Update an assignment
|
|
2209
|
+
# Update an assignment. Only the properties present in the request body are modified, so a partial body leaves everything else as it was. `attachments` is the exception: when present it replaces the whole list. Requires the teacher role on the class. The class must not be archived, and an assignment that is already `active` cannot be moved back to `draft`. Editing an assignment that students have already started does not reset their submissions. To take an assignment out of circulation while keeping the work, use `archiveAssignment`.
|
|
2210
|
+
# @param _class [String] Unique identifier of the class
|
|
2211
|
+
# @param assignment [String] Unique identifier of the assignment
|
|
2212
|
+
# @param body [ClassAssignmentUpdate]
|
|
2213
|
+
# @param [Hash] opts the optional parameters
|
|
2214
|
+
# @return [Array<(Assignment, Integer, Hash)>] Assignment data, response status code and response headers
|
|
2215
|
+
def update_class_assignment_with_http_info(_class, assignment, body, opts = {})
|
|
2216
|
+
if @api_client.config.debugging
|
|
2217
|
+
@api_client.config.logger.debug 'Calling API: ClassApi.update_class_assignment ...'
|
|
2218
|
+
end
|
|
2219
|
+
# verify the required parameter '_class' is set
|
|
2220
|
+
if @api_client.config.client_side_validation && _class.nil?
|
|
2221
|
+
fail ArgumentError, "Missing the required parameter '_class' when calling ClassApi.update_class_assignment"
|
|
2222
|
+
end
|
|
2223
|
+
# verify the required parameter 'assignment' is set
|
|
2224
|
+
if @api_client.config.client_side_validation && assignment.nil?
|
|
2225
|
+
fail ArgumentError, "Missing the required parameter 'assignment' when calling ClassApi.update_class_assignment"
|
|
2226
|
+
end
|
|
2227
|
+
# verify the required parameter 'body' is set
|
|
2228
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
2229
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ClassApi.update_class_assignment"
|
|
2230
|
+
end
|
|
2231
|
+
# resource path
|
|
2232
|
+
local_var_path = '/classes/{class}/assignments/{assignment}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s))
|
|
2233
|
+
|
|
2234
|
+
# query parameters
|
|
2235
|
+
query_params = opts[:query_params] || {}
|
|
2236
|
+
|
|
2237
|
+
# header parameters
|
|
2238
|
+
header_params = opts[:header_params] || {}
|
|
2239
|
+
# HTTP header 'Accept' (if needed)
|
|
2240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2241
|
+
# HTTP header 'Content-Type'
|
|
2242
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2243
|
+
if !content_type.nil?
|
|
2244
|
+
header_params['Content-Type'] = content_type
|
|
2245
|
+
end
|
|
2246
|
+
|
|
2247
|
+
# form parameters
|
|
2248
|
+
form_params = opts[:form_params] || {}
|
|
2249
|
+
|
|
2250
|
+
# http body (model)
|
|
2251
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
2252
|
+
|
|
2253
|
+
# return_type
|
|
2254
|
+
return_type = opts[:debug_return_type] || 'Assignment'
|
|
2255
|
+
|
|
2256
|
+
# auth_names
|
|
2257
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
2258
|
+
|
|
2259
|
+
new_options = opts.merge(
|
|
2260
|
+
:operation => :"ClassApi.update_class_assignment",
|
|
2261
|
+
:header_params => header_params,
|
|
2262
|
+
:query_params => query_params,
|
|
2263
|
+
:form_params => form_params,
|
|
2264
|
+
:body => post_body,
|
|
2265
|
+
:auth_names => auth_names,
|
|
2266
|
+
:return_type => return_type
|
|
2267
|
+
)
|
|
2268
|
+
|
|
2269
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2270
|
+
if @api_client.config.debugging
|
|
2271
|
+
@api_client.config.logger.debug "API called: ClassApi#update_class_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2272
|
+
end
|
|
2273
|
+
return data, status_code, headers
|
|
2274
|
+
end
|
|
2275
|
+
|
|
2058
2276
|
# Update a feedback comment to a submission
|
|
2059
2277
|
# @param _class [String] Unique identifier of the class
|
|
2060
2278
|
# @param assignment [String] Unique identifier of the assignment
|
|
@@ -2101,7 +2319,7 @@ module FlatApi
|
|
|
2101
2319
|
fail ArgumentError, "Missing the required parameter 'assignment_submission_comment_creation' when calling ClassApi.update_submission_comment"
|
|
2102
2320
|
end
|
|
2103
2321
|
# resource path
|
|
2104
|
-
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment}'.sub('{
|
|
2322
|
+
local_var_path = '/classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment}'.sub('{class}', CGI.escape(_class.to_s)).sub('{assignment}', CGI.escape(assignment.to_s)).sub('{submission}', CGI.escape(submission.to_s)).sub('{comment}', CGI.escape(comment.to_s))
|
|
2105
2323
|
|
|
2106
2324
|
# query parameters
|
|
2107
2325
|
query_params = opts[:query_params] || {}
|
|
@@ -2109,7 +2327,7 @@ module FlatApi
|
|
|
2109
2327
|
# header parameters
|
|
2110
2328
|
header_params = opts[:header_params] || {}
|
|
2111
2329
|
# HTTP header 'Accept' (if needed)
|
|
2112
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2330
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2113
2331
|
# HTTP header 'Content-Type'
|
|
2114
2332
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2115
2333
|
if !content_type.nil?
|