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
|
@@ -0,0 +1,238 @@
|
|
|
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 GroupCreation < ApiModelBase
|
|
18
|
+
# Type of group (currently only classStudentsSubGroup is supported)
|
|
19
|
+
attr_accessor :type
|
|
20
|
+
|
|
21
|
+
# Classroom ID
|
|
22
|
+
attr_accessor :classroom
|
|
23
|
+
|
|
24
|
+
# Name of the group (optional - auto-generated if not provided). **Special names:** * `edu:testing-students`: Creates a group tagged for test student accounts. The display name will be localized (e.g., \"Test Students\") and the group will be tagged with `edu:testing-students`.
|
|
25
|
+
attr_accessor :name
|
|
26
|
+
|
|
27
|
+
# Array of student IDs to add to the group
|
|
28
|
+
attr_accessor :members
|
|
29
|
+
|
|
30
|
+
class EnumAttributeValidator
|
|
31
|
+
attr_reader :datatype
|
|
32
|
+
attr_reader :allowable_values
|
|
33
|
+
|
|
34
|
+
def initialize(datatype, allowable_values)
|
|
35
|
+
@allowable_values = allowable_values.map do |value|
|
|
36
|
+
case datatype.to_s
|
|
37
|
+
when /Integer/i
|
|
38
|
+
value.to_i
|
|
39
|
+
when /Float/i
|
|
40
|
+
value.to_f
|
|
41
|
+
else
|
|
42
|
+
value
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def valid?(value)
|
|
48
|
+
!value || allowable_values.include?(value)
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
53
|
+
def self.attribute_map
|
|
54
|
+
{
|
|
55
|
+
:'type' => :'type',
|
|
56
|
+
:'classroom' => :'classroom',
|
|
57
|
+
:'name' => :'name',
|
|
58
|
+
:'members' => :'members'
|
|
59
|
+
}
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# Returns attribute mapping this model knows about
|
|
63
|
+
def self.acceptable_attribute_map
|
|
64
|
+
attribute_map
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Returns all the JSON keys this model knows about
|
|
68
|
+
def self.acceptable_attributes
|
|
69
|
+
acceptable_attribute_map.values
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Attribute type mapping.
|
|
73
|
+
def self.openapi_types
|
|
74
|
+
{
|
|
75
|
+
:'type' => :'String',
|
|
76
|
+
:'classroom' => :'String',
|
|
77
|
+
:'name' => :'String',
|
|
78
|
+
:'members' => :'Array<String>'
|
|
79
|
+
}
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# List of attributes with nullable: true
|
|
83
|
+
def self.openapi_nullable
|
|
84
|
+
Set.new([
|
|
85
|
+
])
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Initializes the object
|
|
89
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
90
|
+
def initialize(attributes = {})
|
|
91
|
+
if (!attributes.is_a?(Hash))
|
|
92
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::GroupCreation` initialize method"
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
96
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
97
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
98
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
99
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GroupCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
100
|
+
end
|
|
101
|
+
h[k.to_sym] = v
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
if attributes.key?(:'type')
|
|
105
|
+
self.type = attributes[:'type']
|
|
106
|
+
else
|
|
107
|
+
self.type = nil
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
if attributes.key?(:'classroom')
|
|
111
|
+
self.classroom = attributes[:'classroom']
|
|
112
|
+
else
|
|
113
|
+
self.classroom = nil
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
if attributes.key?(:'name')
|
|
117
|
+
self.name = attributes[:'name']
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
if attributes.key?(:'members')
|
|
121
|
+
if (value = attributes[:'members']).is_a?(Array)
|
|
122
|
+
self.members = value
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
128
|
+
# @return Array for valid properties with the reasons
|
|
129
|
+
def list_invalid_properties
|
|
130
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
131
|
+
invalid_properties = Array.new
|
|
132
|
+
if @type.nil?
|
|
133
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
if @classroom.nil?
|
|
137
|
+
invalid_properties.push('invalid value for "classroom", classroom cannot be nil.')
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
invalid_properties
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# Check to see if the all the properties in the model are valid
|
|
144
|
+
# @return true if the model is valid
|
|
145
|
+
def valid?
|
|
146
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
147
|
+
return false if @type.nil?
|
|
148
|
+
type_validator = EnumAttributeValidator.new('String', ["classStudentsSubGroup"])
|
|
149
|
+
return false unless type_validator.valid?(@type)
|
|
150
|
+
return false if @classroom.nil?
|
|
151
|
+
true
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
155
|
+
# @param [Object] type Object to be assigned
|
|
156
|
+
def type=(type)
|
|
157
|
+
validator = EnumAttributeValidator.new('String', ["classStudentsSubGroup"])
|
|
158
|
+
unless validator.valid?(type)
|
|
159
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
|
160
|
+
end
|
|
161
|
+
@type = type
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Custom attribute writer method with validation
|
|
165
|
+
# @param [Object] classroom Value to be assigned
|
|
166
|
+
def classroom=(classroom)
|
|
167
|
+
if classroom.nil?
|
|
168
|
+
fail ArgumentError, 'classroom cannot be nil'
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
@classroom = classroom
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# Checks equality by comparing each attribute.
|
|
175
|
+
# @param [Object] Object to be compared
|
|
176
|
+
def ==(o)
|
|
177
|
+
return true if self.equal?(o)
|
|
178
|
+
self.class == o.class &&
|
|
179
|
+
type == o.type &&
|
|
180
|
+
classroom == o.classroom &&
|
|
181
|
+
name == o.name &&
|
|
182
|
+
members == o.members
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# @see the `==` method
|
|
186
|
+
# @param [Object] Object to be compared
|
|
187
|
+
def eql?(o)
|
|
188
|
+
self == o
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Calculates hash code according to all attributes.
|
|
192
|
+
# @return [Integer] Hash code
|
|
193
|
+
def hash
|
|
194
|
+
[type, classroom, name, members].hash
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
# Builds the object from hash
|
|
198
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
199
|
+
# @return [Object] Returns the model itself
|
|
200
|
+
def self.build_from_hash(attributes)
|
|
201
|
+
return nil unless attributes.is_a?(Hash)
|
|
202
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
203
|
+
transformed_hash = {}
|
|
204
|
+
openapi_types.each_pair do |key, type|
|
|
205
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
206
|
+
transformed_hash["#{key}"] = nil
|
|
207
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
208
|
+
# check to ensure the input is an array given that the attribute
|
|
209
|
+
# is documented as an array but the input is not
|
|
210
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
211
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
212
|
+
end
|
|
213
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
214
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
new(transformed_hash)
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Returns the object in the form of hash
|
|
221
|
+
# @return [Hash] Returns the object in the form of hash
|
|
222
|
+
def to_hash
|
|
223
|
+
hash = {}
|
|
224
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
225
|
+
value = self.send(attr)
|
|
226
|
+
if value.nil?
|
|
227
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
228
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
hash[param] = _to_hash(value)
|
|
232
|
+
end
|
|
233
|
+
hash
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
end
|
|
@@ -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
|
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# The details of a group
|
|
18
|
-
class GroupDetails
|
|
18
|
+
class GroupDetails < ApiModelBase
|
|
19
19
|
# The unique identifier of the group
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -27,6 +27,15 @@ module FlatApi
|
|
|
27
27
|
# The unique identifier of the Organization owning the group
|
|
28
28
|
attr_accessor :organization
|
|
29
29
|
|
|
30
|
+
# The unique identifier of the classroom owning the group. Only available for groups of type 'classromStudentsSubGroup' or 'assignmentStudentsSubGroup'
|
|
31
|
+
attr_accessor :classroom
|
|
32
|
+
|
|
33
|
+
# The unique identifier of the assignment owning the group. Only available for groups of type 'assignmentStudentsSubGroup'.
|
|
34
|
+
attr_accessor :assignment
|
|
35
|
+
|
|
36
|
+
# The unique identifier of the parent class group. Only available for groups of type 'assignmentStudentsSubGroup'. May be null if the parent class group was deleted.
|
|
37
|
+
attr_accessor :parent
|
|
38
|
+
|
|
30
39
|
# The date when the group was create
|
|
31
40
|
attr_accessor :creation_date
|
|
32
41
|
|
|
@@ -36,6 +45,9 @@ module FlatApi
|
|
|
36
45
|
# `true` if the properties and members of this group are in in read-only
|
|
37
46
|
attr_accessor :read_only
|
|
38
47
|
|
|
48
|
+
# Tags for categorizing groups. * `edu:testing-students`: Marks this group as containing test student accounts
|
|
49
|
+
attr_accessor :tags
|
|
50
|
+
|
|
39
51
|
class EnumAttributeValidator
|
|
40
52
|
attr_reader :datatype
|
|
41
53
|
attr_reader :allowable_values
|
|
@@ -65,15 +77,24 @@ module FlatApi
|
|
|
65
77
|
:'name' => :'name',
|
|
66
78
|
:'type' => :'type',
|
|
67
79
|
:'organization' => :'organization',
|
|
80
|
+
:'classroom' => :'classroom',
|
|
81
|
+
:'assignment' => :'assignment',
|
|
82
|
+
:'parent' => :'parent',
|
|
68
83
|
:'creation_date' => :'creationDate',
|
|
69
84
|
:'users_count' => :'usersCount',
|
|
70
|
-
:'read_only' => :'readOnly'
|
|
85
|
+
:'read_only' => :'readOnly',
|
|
86
|
+
:'tags' => :'tags'
|
|
71
87
|
}
|
|
72
88
|
end
|
|
73
89
|
|
|
90
|
+
# Returns attribute mapping this model knows about
|
|
91
|
+
def self.acceptable_attribute_map
|
|
92
|
+
attribute_map
|
|
93
|
+
end
|
|
94
|
+
|
|
74
95
|
# Returns all the JSON keys this model knows about
|
|
75
96
|
def self.acceptable_attributes
|
|
76
|
-
|
|
97
|
+
acceptable_attribute_map.values
|
|
77
98
|
end
|
|
78
99
|
|
|
79
100
|
# Attribute type mapping.
|
|
@@ -83,9 +104,13 @@ module FlatApi
|
|
|
83
104
|
:'name' => :'String',
|
|
84
105
|
:'type' => :'GroupType',
|
|
85
106
|
:'organization' => :'String',
|
|
107
|
+
:'classroom' => :'String',
|
|
108
|
+
:'assignment' => :'String',
|
|
109
|
+
:'parent' => :'String',
|
|
86
110
|
:'creation_date' => :'Time',
|
|
87
111
|
:'users_count' => :'Float',
|
|
88
|
-
:'read_only' => :'Boolean'
|
|
112
|
+
:'read_only' => :'Boolean',
|
|
113
|
+
:'tags' => :'Array<String>'
|
|
89
114
|
}
|
|
90
115
|
end
|
|
91
116
|
|
|
@@ -103,39 +128,72 @@ module FlatApi
|
|
|
103
128
|
end
|
|
104
129
|
|
|
105
130
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
131
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
106
132
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
107
|
-
if (!
|
|
108
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GroupDetails`. Please check the name to make sure it's valid. List of attributes: " +
|
|
133
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
134
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GroupDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
109
135
|
end
|
|
110
136
|
h[k.to_sym] = v
|
|
111
137
|
}
|
|
112
138
|
|
|
113
139
|
if attributes.key?(:'id')
|
|
114
140
|
self.id = attributes[:'id']
|
|
141
|
+
else
|
|
142
|
+
self.id = nil
|
|
115
143
|
end
|
|
116
144
|
|
|
117
145
|
if attributes.key?(:'name')
|
|
118
146
|
self.name = attributes[:'name']
|
|
147
|
+
else
|
|
148
|
+
self.name = nil
|
|
119
149
|
end
|
|
120
150
|
|
|
121
151
|
if attributes.key?(:'type')
|
|
122
152
|
self.type = attributes[:'type']
|
|
153
|
+
else
|
|
154
|
+
self.type = nil
|
|
123
155
|
end
|
|
124
156
|
|
|
125
157
|
if attributes.key?(:'organization')
|
|
126
158
|
self.organization = attributes[:'organization']
|
|
127
159
|
end
|
|
128
160
|
|
|
161
|
+
if attributes.key?(:'classroom')
|
|
162
|
+
self.classroom = attributes[:'classroom']
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
if attributes.key?(:'assignment')
|
|
166
|
+
self.assignment = attributes[:'assignment']
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
if attributes.key?(:'parent')
|
|
170
|
+
self.parent = attributes[:'parent']
|
|
171
|
+
end
|
|
172
|
+
|
|
129
173
|
if attributes.key?(:'creation_date')
|
|
130
174
|
self.creation_date = attributes[:'creation_date']
|
|
175
|
+
else
|
|
176
|
+
self.creation_date = nil
|
|
131
177
|
end
|
|
132
178
|
|
|
133
179
|
if attributes.key?(:'users_count')
|
|
134
180
|
self.users_count = attributes[:'users_count']
|
|
181
|
+
else
|
|
182
|
+
self.users_count = nil
|
|
135
183
|
end
|
|
136
184
|
|
|
137
185
|
if attributes.key?(:'read_only')
|
|
138
186
|
self.read_only = attributes[:'read_only']
|
|
187
|
+
else
|
|
188
|
+
self.read_only = nil
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
if attributes.key?(:'tags')
|
|
192
|
+
if (value = attributes[:'tags']).is_a?(Array)
|
|
193
|
+
self.tags = value
|
|
194
|
+
end
|
|
195
|
+
else
|
|
196
|
+
self.tags = nil
|
|
139
197
|
end
|
|
140
198
|
end
|
|
141
199
|
|
|
@@ -144,6 +202,34 @@ module FlatApi
|
|
|
144
202
|
def list_invalid_properties
|
|
145
203
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
146
204
|
invalid_properties = Array.new
|
|
205
|
+
if @id.nil?
|
|
206
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
if @name.nil?
|
|
210
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
if @type.nil?
|
|
214
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
if @creation_date.nil?
|
|
218
|
+
invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
if @users_count.nil?
|
|
222
|
+
invalid_properties.push('invalid value for "users_count", users_count cannot be nil.')
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
if @read_only.nil?
|
|
226
|
+
invalid_properties.push('invalid value for "read_only", read_only cannot be nil.')
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
if @tags.nil?
|
|
230
|
+
invalid_properties.push('invalid value for "tags", tags cannot be nil.')
|
|
231
|
+
end
|
|
232
|
+
|
|
147
233
|
invalid_properties
|
|
148
234
|
end
|
|
149
235
|
|
|
@@ -151,9 +237,86 @@ module FlatApi
|
|
|
151
237
|
# @return true if the model is valid
|
|
152
238
|
def valid?
|
|
153
239
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
240
|
+
return false if @id.nil?
|
|
241
|
+
return false if @name.nil?
|
|
242
|
+
return false if @type.nil?
|
|
243
|
+
return false if @creation_date.nil?
|
|
244
|
+
return false if @users_count.nil?
|
|
245
|
+
return false if @read_only.nil?
|
|
246
|
+
return false if @tags.nil?
|
|
154
247
|
true
|
|
155
248
|
end
|
|
156
249
|
|
|
250
|
+
# Custom attribute writer method with validation
|
|
251
|
+
# @param [Object] id Value to be assigned
|
|
252
|
+
def id=(id)
|
|
253
|
+
if id.nil?
|
|
254
|
+
fail ArgumentError, 'id cannot be nil'
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
@id = id
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# Custom attribute writer method with validation
|
|
261
|
+
# @param [Object] name Value to be assigned
|
|
262
|
+
def name=(name)
|
|
263
|
+
if name.nil?
|
|
264
|
+
fail ArgumentError, 'name cannot be nil'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
@name = name
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Custom attribute writer method with validation
|
|
271
|
+
# @param [Object] type Value to be assigned
|
|
272
|
+
def type=(type)
|
|
273
|
+
if type.nil?
|
|
274
|
+
fail ArgumentError, 'type cannot be nil'
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
@type = type
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Custom attribute writer method with validation
|
|
281
|
+
# @param [Object] creation_date Value to be assigned
|
|
282
|
+
def creation_date=(creation_date)
|
|
283
|
+
if creation_date.nil?
|
|
284
|
+
fail ArgumentError, 'creation_date cannot be nil'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
@creation_date = creation_date
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Custom attribute writer method with validation
|
|
291
|
+
# @param [Object] users_count Value to be assigned
|
|
292
|
+
def users_count=(users_count)
|
|
293
|
+
if users_count.nil?
|
|
294
|
+
fail ArgumentError, 'users_count cannot be nil'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
@users_count = users_count
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Custom attribute writer method with validation
|
|
301
|
+
# @param [Object] read_only Value to be assigned
|
|
302
|
+
def read_only=(read_only)
|
|
303
|
+
if read_only.nil?
|
|
304
|
+
fail ArgumentError, 'read_only cannot be nil'
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
@read_only = read_only
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# Custom attribute writer method with validation
|
|
311
|
+
# @param [Object] tags Value to be assigned
|
|
312
|
+
def tags=(tags)
|
|
313
|
+
if tags.nil?
|
|
314
|
+
fail ArgumentError, 'tags cannot be nil'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
@tags = tags
|
|
318
|
+
end
|
|
319
|
+
|
|
157
320
|
# Checks equality by comparing each attribute.
|
|
158
321
|
# @param [Object] Object to be compared
|
|
159
322
|
def ==(o)
|
|
@@ -163,9 +326,13 @@ module FlatApi
|
|
|
163
326
|
name == o.name &&
|
|
164
327
|
type == o.type &&
|
|
165
328
|
organization == o.organization &&
|
|
329
|
+
classroom == o.classroom &&
|
|
330
|
+
assignment == o.assignment &&
|
|
331
|
+
parent == o.parent &&
|
|
166
332
|
creation_date == o.creation_date &&
|
|
167
333
|
users_count == o.users_count &&
|
|
168
|
-
read_only == o.read_only
|
|
334
|
+
read_only == o.read_only &&
|
|
335
|
+
tags == o.tags
|
|
169
336
|
end
|
|
170
337
|
|
|
171
338
|
# @see the `==` method
|
|
@@ -177,7 +344,7 @@ module FlatApi
|
|
|
177
344
|
# Calculates hash code according to all attributes.
|
|
178
345
|
# @return [Integer] Hash code
|
|
179
346
|
def hash
|
|
180
|
-
[id, name, type, organization, creation_date, users_count, read_only].hash
|
|
347
|
+
[id, name, type, organization, classroom, assignment, parent, creation_date, users_count, read_only, tags].hash
|
|
181
348
|
end
|
|
182
349
|
|
|
183
350
|
# Builds the object from hash
|
|
@@ -203,61 +370,6 @@ module FlatApi
|
|
|
203
370
|
new(transformed_hash)
|
|
204
371
|
end
|
|
205
372
|
|
|
206
|
-
# Deserializes the data based on type
|
|
207
|
-
# @param string type Data type
|
|
208
|
-
# @param string value Value to be deserialized
|
|
209
|
-
# @return [Object] Deserialized data
|
|
210
|
-
def self._deserialize(type, value)
|
|
211
|
-
case type.to_sym
|
|
212
|
-
when :Time
|
|
213
|
-
Time.parse(value)
|
|
214
|
-
when :Date
|
|
215
|
-
Date.parse(value)
|
|
216
|
-
when :String
|
|
217
|
-
value.to_s
|
|
218
|
-
when :Integer
|
|
219
|
-
value.to_i
|
|
220
|
-
when :Float
|
|
221
|
-
value.to_f
|
|
222
|
-
when :Boolean
|
|
223
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
224
|
-
true
|
|
225
|
-
else
|
|
226
|
-
false
|
|
227
|
-
end
|
|
228
|
-
when :Object
|
|
229
|
-
# generic object (usually a Hash), return directly
|
|
230
|
-
value
|
|
231
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
232
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
233
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
234
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
235
|
-
k_type = Regexp.last_match[:k_type]
|
|
236
|
-
v_type = Regexp.last_match[:v_type]
|
|
237
|
-
{}.tap do |hash|
|
|
238
|
-
value.each do |k, v|
|
|
239
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
240
|
-
end
|
|
241
|
-
end
|
|
242
|
-
else # model
|
|
243
|
-
# models (e.g. Pet) or oneOf
|
|
244
|
-
klass = FlatApi.const_get(type)
|
|
245
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
246
|
-
end
|
|
247
|
-
end
|
|
248
|
-
|
|
249
|
-
# Returns the string representation of the object
|
|
250
|
-
# @return [String] String presentation of the object
|
|
251
|
-
def to_s
|
|
252
|
-
to_hash.to_s
|
|
253
|
-
end
|
|
254
|
-
|
|
255
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
256
|
-
# @return [Hash] Returns the object in the form of hash
|
|
257
|
-
def to_body
|
|
258
|
-
to_hash
|
|
259
|
-
end
|
|
260
|
-
|
|
261
373
|
# Returns the object in the form of hash
|
|
262
374
|
# @return [Hash] Returns the object in the form of hash
|
|
263
375
|
def to_hash
|
|
@@ -274,24 +386,6 @@ module FlatApi
|
|
|
274
386
|
hash
|
|
275
387
|
end
|
|
276
388
|
|
|
277
|
-
# Outputs non-array value in the form of hash
|
|
278
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
279
|
-
# @param [Object] value Any valid value
|
|
280
|
-
# @return [Hash] Returns the value in the form of hash
|
|
281
|
-
def _to_hash(value)
|
|
282
|
-
if value.is_a?(Array)
|
|
283
|
-
value.compact.map { |v| _to_hash(v) }
|
|
284
|
-
elsif value.is_a?(Hash)
|
|
285
|
-
{}.tap do |hash|
|
|
286
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
287
|
-
end
|
|
288
|
-
elsif value.respond_to? :to_hash
|
|
289
|
-
value.to_hash
|
|
290
|
-
else
|
|
291
|
-
value
|
|
292
|
-
end
|
|
293
|
-
end
|
|
294
|
-
|
|
295
389
|
end
|
|
296
390
|
|
|
297
391
|
end
|
|
@@ -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
|
|
|
@@ -18,9 +18,11 @@ module FlatApi
|
|
|
18
18
|
GENERIC = "generic".freeze
|
|
19
19
|
CLASS_TEACHERS = "classTeachers".freeze
|
|
20
20
|
CLASS_STUDENTS = "classStudents".freeze
|
|
21
|
+
CLASS_STUDENTS_SUB_GROUP = "classStudentsSubGroup".freeze
|
|
22
|
+
ASSIGNMENT_STUDENTS_SUB_GROUP = "assignmentStudentsSubGroup".freeze
|
|
21
23
|
|
|
22
24
|
def self.all_vars
|
|
23
|
-
@all_vars ||= [GENERIC, CLASS_TEACHERS, CLASS_STUDENTS].freeze
|
|
25
|
+
@all_vars ||= [GENERIC, CLASS_TEACHERS, CLASS_STUDENTS, CLASS_STUDENTS_SUB_GROUP, ASSIGNMENT_STUDENTS_SUB_GROUP].freeze
|
|
24
26
|
end
|
|
25
27
|
|
|
26
28
|
# Builds the enum from string
|