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
|
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# A Flat for Education resource contained in a resources library
|
|
18
|
-
class EduResource
|
|
18
|
+
class EduResource < ApiModelBase
|
|
19
19
|
# Resource unique identifier
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -35,6 +35,12 @@ module FlatApi
|
|
|
35
35
|
# Title of the resource
|
|
36
36
|
attr_accessor :title
|
|
37
37
|
|
|
38
|
+
# Sharing description of this resource
|
|
39
|
+
attr_accessor :sharing_description
|
|
40
|
+
|
|
41
|
+
# HTML version of sharing description with rich text formatting. Supports safe HTML tags: p, br, strong, b, em, i, u, a.
|
|
42
|
+
attr_accessor :sharing_description_html
|
|
43
|
+
|
|
38
44
|
# The date when the resource was created
|
|
39
45
|
attr_accessor :creation_date
|
|
40
46
|
|
|
@@ -45,6 +51,12 @@ module FlatApi
|
|
|
45
51
|
|
|
46
52
|
attr_accessor :capabilities
|
|
47
53
|
|
|
54
|
+
# The subjects of this resource, or the subjects of the resources included in the folder
|
|
55
|
+
attr_accessor :subjects
|
|
56
|
+
|
|
57
|
+
# The grades of this resource, or the grades of the resources included in the folder.
|
|
58
|
+
attr_accessor :grades
|
|
59
|
+
|
|
48
60
|
class EnumAttributeValidator
|
|
49
61
|
attr_reader :datatype
|
|
50
62
|
attr_reader :allowable_values
|
|
@@ -77,16 +89,25 @@ module FlatApi
|
|
|
77
89
|
:'tags' => :'tags',
|
|
78
90
|
:'parent' => :'parent',
|
|
79
91
|
:'title' => :'title',
|
|
92
|
+
:'sharing_description' => :'sharingDescription',
|
|
93
|
+
:'sharing_description_html' => :'sharingDescriptionHtml',
|
|
80
94
|
:'creation_date' => :'creationDate',
|
|
81
95
|
:'update_date' => :'updateDate',
|
|
82
96
|
:'resource' => :'resource',
|
|
83
|
-
:'capabilities' => :'capabilities'
|
|
97
|
+
:'capabilities' => :'capabilities',
|
|
98
|
+
:'subjects' => :'subjects',
|
|
99
|
+
:'grades' => :'grades'
|
|
84
100
|
}
|
|
85
101
|
end
|
|
86
102
|
|
|
103
|
+
# Returns attribute mapping this model knows about
|
|
104
|
+
def self.acceptable_attribute_map
|
|
105
|
+
attribute_map
|
|
106
|
+
end
|
|
107
|
+
|
|
87
108
|
# Returns all the JSON keys this model knows about
|
|
88
109
|
def self.acceptable_attributes
|
|
89
|
-
|
|
110
|
+
acceptable_attribute_map.values
|
|
90
111
|
end
|
|
91
112
|
|
|
92
113
|
# Attribute type mapping.
|
|
@@ -99,10 +120,14 @@ module FlatApi
|
|
|
99
120
|
:'tags' => :'Array<String>',
|
|
100
121
|
:'parent' => :'String',
|
|
101
122
|
:'title' => :'String',
|
|
123
|
+
:'sharing_description' => :'String',
|
|
124
|
+
:'sharing_description_html' => :'String',
|
|
102
125
|
:'creation_date' => :'Time',
|
|
103
126
|
:'update_date' => :'Time',
|
|
104
127
|
:'resource' => :'EduResourceResource',
|
|
105
|
-
:'capabilities' => :'EduResourceCapabilities'
|
|
128
|
+
:'capabilities' => :'EduResourceCapabilities',
|
|
129
|
+
:'subjects' => :'Array<TeachingTheme>',
|
|
130
|
+
:'grades' => :'Array<Grade>'
|
|
106
131
|
}
|
|
107
132
|
end
|
|
108
133
|
|
|
@@ -120,9 +145,10 @@ module FlatApi
|
|
|
120
145
|
end
|
|
121
146
|
|
|
122
147
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
148
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
123
149
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
124
|
-
if (!
|
|
125
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResource`. Please check the name to make sure it's valid. List of attributes: " +
|
|
150
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
151
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResource`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
126
152
|
end
|
|
127
153
|
h[k.to_sym] = v
|
|
128
154
|
}
|
|
@@ -165,6 +191,14 @@ module FlatApi
|
|
|
165
191
|
self.title = nil
|
|
166
192
|
end
|
|
167
193
|
|
|
194
|
+
if attributes.key?(:'sharing_description')
|
|
195
|
+
self.sharing_description = attributes[:'sharing_description']
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
if attributes.key?(:'sharing_description_html')
|
|
199
|
+
self.sharing_description_html = attributes[:'sharing_description_html']
|
|
200
|
+
end
|
|
201
|
+
|
|
168
202
|
if attributes.key?(:'creation_date')
|
|
169
203
|
self.creation_date = attributes[:'creation_date']
|
|
170
204
|
end
|
|
@@ -182,6 +216,18 @@ module FlatApi
|
|
|
182
216
|
else
|
|
183
217
|
self.capabilities = nil
|
|
184
218
|
end
|
|
219
|
+
|
|
220
|
+
if attributes.key?(:'subjects')
|
|
221
|
+
if (value = attributes[:'subjects']).is_a?(Array)
|
|
222
|
+
self.subjects = value
|
|
223
|
+
end
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
if attributes.key?(:'grades')
|
|
227
|
+
if (value = attributes[:'grades']).is_a?(Array)
|
|
228
|
+
self.grades = value
|
|
229
|
+
end
|
|
230
|
+
end
|
|
185
231
|
end
|
|
186
232
|
|
|
187
233
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -219,6 +265,46 @@ module FlatApi
|
|
|
219
265
|
true
|
|
220
266
|
end
|
|
221
267
|
|
|
268
|
+
# Custom attribute writer method with validation
|
|
269
|
+
# @param [Object] id Value to be assigned
|
|
270
|
+
def id=(id)
|
|
271
|
+
if id.nil?
|
|
272
|
+
fail ArgumentError, 'id cannot be nil'
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
@id = id
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
# Custom attribute writer method with validation
|
|
279
|
+
# @param [Object] type Value to be assigned
|
|
280
|
+
def type=(type)
|
|
281
|
+
if type.nil?
|
|
282
|
+
fail ArgumentError, 'type cannot be nil'
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
@type = type
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
# Custom attribute writer method with validation
|
|
289
|
+
# @param [Object] title Value to be assigned
|
|
290
|
+
def title=(title)
|
|
291
|
+
if title.nil?
|
|
292
|
+
fail ArgumentError, 'title cannot be nil'
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
@title = title
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# Custom attribute writer method with validation
|
|
299
|
+
# @param [Object] capabilities Value to be assigned
|
|
300
|
+
def capabilities=(capabilities)
|
|
301
|
+
if capabilities.nil?
|
|
302
|
+
fail ArgumentError, 'capabilities cannot be nil'
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
@capabilities = capabilities
|
|
306
|
+
end
|
|
307
|
+
|
|
222
308
|
# Checks equality by comparing each attribute.
|
|
223
309
|
# @param [Object] Object to be compared
|
|
224
310
|
def ==(o)
|
|
@@ -231,10 +317,14 @@ module FlatApi
|
|
|
231
317
|
tags == o.tags &&
|
|
232
318
|
parent == o.parent &&
|
|
233
319
|
title == o.title &&
|
|
320
|
+
sharing_description == o.sharing_description &&
|
|
321
|
+
sharing_description_html == o.sharing_description_html &&
|
|
234
322
|
creation_date == o.creation_date &&
|
|
235
323
|
update_date == o.update_date &&
|
|
236
324
|
resource == o.resource &&
|
|
237
|
-
capabilities == o.capabilities
|
|
325
|
+
capabilities == o.capabilities &&
|
|
326
|
+
subjects == o.subjects &&
|
|
327
|
+
grades == o.grades
|
|
238
328
|
end
|
|
239
329
|
|
|
240
330
|
# @see the `==` method
|
|
@@ -246,7 +336,7 @@ module FlatApi
|
|
|
246
336
|
# Calculates hash code according to all attributes.
|
|
247
337
|
# @return [Integer] Hash code
|
|
248
338
|
def hash
|
|
249
|
-
[id, creator, type, privacy, tags, parent, title, creation_date, update_date, resource, capabilities].hash
|
|
339
|
+
[id, creator, type, privacy, tags, parent, title, sharing_description, sharing_description_html, creation_date, update_date, resource, capabilities, subjects, grades].hash
|
|
250
340
|
end
|
|
251
341
|
|
|
252
342
|
# Builds the object from hash
|
|
@@ -272,61 +362,6 @@ module FlatApi
|
|
|
272
362
|
new(transformed_hash)
|
|
273
363
|
end
|
|
274
364
|
|
|
275
|
-
# Deserializes the data based on type
|
|
276
|
-
# @param string type Data type
|
|
277
|
-
# @param string value Value to be deserialized
|
|
278
|
-
# @return [Object] Deserialized data
|
|
279
|
-
def self._deserialize(type, value)
|
|
280
|
-
case type.to_sym
|
|
281
|
-
when :Time
|
|
282
|
-
Time.parse(value)
|
|
283
|
-
when :Date
|
|
284
|
-
Date.parse(value)
|
|
285
|
-
when :String
|
|
286
|
-
value.to_s
|
|
287
|
-
when :Integer
|
|
288
|
-
value.to_i
|
|
289
|
-
when :Float
|
|
290
|
-
value.to_f
|
|
291
|
-
when :Boolean
|
|
292
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
293
|
-
true
|
|
294
|
-
else
|
|
295
|
-
false
|
|
296
|
-
end
|
|
297
|
-
when :Object
|
|
298
|
-
# generic object (usually a Hash), return directly
|
|
299
|
-
value
|
|
300
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
301
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
302
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
303
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
304
|
-
k_type = Regexp.last_match[:k_type]
|
|
305
|
-
v_type = Regexp.last_match[:v_type]
|
|
306
|
-
{}.tap do |hash|
|
|
307
|
-
value.each do |k, v|
|
|
308
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
309
|
-
end
|
|
310
|
-
end
|
|
311
|
-
else # model
|
|
312
|
-
# models (e.g. Pet) or oneOf
|
|
313
|
-
klass = FlatApi.const_get(type)
|
|
314
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
315
|
-
end
|
|
316
|
-
end
|
|
317
|
-
|
|
318
|
-
# Returns the string representation of the object
|
|
319
|
-
# @return [String] String presentation of the object
|
|
320
|
-
def to_s
|
|
321
|
-
to_hash.to_s
|
|
322
|
-
end
|
|
323
|
-
|
|
324
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
325
|
-
# @return [Hash] Returns the object in the form of hash
|
|
326
|
-
def to_body
|
|
327
|
-
to_hash
|
|
328
|
-
end
|
|
329
|
-
|
|
330
365
|
# Returns the object in the form of hash
|
|
331
366
|
# @return [Hash] Returns the object in the form of hash
|
|
332
367
|
def to_hash
|
|
@@ -343,24 +378,6 @@ module FlatApi
|
|
|
343
378
|
hash
|
|
344
379
|
end
|
|
345
380
|
|
|
346
|
-
# Outputs non-array value in the form of hash
|
|
347
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
348
|
-
# @param [Object] value Any valid value
|
|
349
|
-
# @return [Hash] Returns the value in the form of hash
|
|
350
|
-
def _to_hash(value)
|
|
351
|
-
if value.is_a?(Array)
|
|
352
|
-
value.compact.map { |v| _to_hash(v) }
|
|
353
|
-
elsif value.is_a?(Hash)
|
|
354
|
-
{}.tap do |hash|
|
|
355
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
356
|
-
end
|
|
357
|
-
elsif value.respond_to? :to_hash
|
|
358
|
-
value.to_hash
|
|
359
|
-
else
|
|
360
|
-
value
|
|
361
|
-
end
|
|
362
|
-
end
|
|
363
|
-
|
|
364
381
|
end
|
|
365
382
|
|
|
366
383
|
end
|
|
@@ -0,0 +1,170 @@
|
|
|
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
|
+
# Assignment-specific creation options. Only applicable when creating a resource with `type: assignment`. If `type` is not provided, defaults to `none`.
|
|
18
|
+
class EduResourceAssignmentCreation < ApiModelBase
|
|
19
|
+
attr_accessor :type
|
|
20
|
+
|
|
21
|
+
class EnumAttributeValidator
|
|
22
|
+
attr_reader :datatype
|
|
23
|
+
attr_reader :allowable_values
|
|
24
|
+
|
|
25
|
+
def initialize(datatype, allowable_values)
|
|
26
|
+
@allowable_values = allowable_values.map do |value|
|
|
27
|
+
case datatype.to_s
|
|
28
|
+
when /Integer/i
|
|
29
|
+
value.to_i
|
|
30
|
+
when /Float/i
|
|
31
|
+
value.to_f
|
|
32
|
+
else
|
|
33
|
+
value
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
def valid?(value)
|
|
39
|
+
!value || allowable_values.include?(value)
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
44
|
+
def self.attribute_map
|
|
45
|
+
{
|
|
46
|
+
:'type' => :'type'
|
|
47
|
+
}
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Returns attribute mapping this model knows about
|
|
51
|
+
def self.acceptable_attribute_map
|
|
52
|
+
attribute_map
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Returns all the JSON keys this model knows about
|
|
56
|
+
def self.acceptable_attributes
|
|
57
|
+
acceptable_attribute_map.values
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Attribute type mapping.
|
|
61
|
+
def self.openapi_types
|
|
62
|
+
{
|
|
63
|
+
:'type' => :'AssignmentType'
|
|
64
|
+
}
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# List of attributes with nullable: true
|
|
68
|
+
def self.openapi_nullable
|
|
69
|
+
Set.new([
|
|
70
|
+
])
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# Initializes the object
|
|
74
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
75
|
+
def initialize(attributes = {})
|
|
76
|
+
if (!attributes.is_a?(Hash))
|
|
77
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::EduResourceAssignmentCreation` initialize method"
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
81
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
82
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
83
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
84
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceAssignmentCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
85
|
+
end
|
|
86
|
+
h[k.to_sym] = v
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
if attributes.key?(:'type')
|
|
90
|
+
self.type = attributes[:'type']
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
95
|
+
# @return Array for valid properties with the reasons
|
|
96
|
+
def list_invalid_properties
|
|
97
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
98
|
+
invalid_properties = Array.new
|
|
99
|
+
invalid_properties
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Check to see if the all the properties in the model are valid
|
|
103
|
+
# @return true if the model is valid
|
|
104
|
+
def valid?
|
|
105
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
106
|
+
true
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Checks equality by comparing each attribute.
|
|
110
|
+
# @param [Object] Object to be compared
|
|
111
|
+
def ==(o)
|
|
112
|
+
return true if self.equal?(o)
|
|
113
|
+
self.class == o.class &&
|
|
114
|
+
type == o.type
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# @see the `==` method
|
|
118
|
+
# @param [Object] Object to be compared
|
|
119
|
+
def eql?(o)
|
|
120
|
+
self == o
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# Calculates hash code according to all attributes.
|
|
124
|
+
# @return [Integer] Hash code
|
|
125
|
+
def hash
|
|
126
|
+
[type].hash
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Builds the object from hash
|
|
130
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
131
|
+
# @return [Object] Returns the model itself
|
|
132
|
+
def self.build_from_hash(attributes)
|
|
133
|
+
return nil unless attributes.is_a?(Hash)
|
|
134
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
135
|
+
transformed_hash = {}
|
|
136
|
+
openapi_types.each_pair do |key, type|
|
|
137
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
138
|
+
transformed_hash["#{key}"] = nil
|
|
139
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
140
|
+
# check to ensure the input is an array given that the attribute
|
|
141
|
+
# is documented as an array but the input is not
|
|
142
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
143
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
144
|
+
end
|
|
145
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
146
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
147
|
+
end
|
|
148
|
+
end
|
|
149
|
+
new(transformed_hash)
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Returns the object in the form of hash
|
|
153
|
+
# @return [Hash] Returns the object in the form of hash
|
|
154
|
+
def to_hash
|
|
155
|
+
hash = {}
|
|
156
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
157
|
+
value = self.send(attr)
|
|
158
|
+
if value.nil?
|
|
159
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
160
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
hash[param] = _to_hash(value)
|
|
164
|
+
end
|
|
165
|
+
hash
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
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
|
# Capabilities available for this resource
|
|
18
|
-
class EduResourceCapabilities
|
|
18
|
+
class EduResourceCapabilities < ApiModelBase
|
|
19
19
|
# Whether the current user can modify this resource
|
|
20
20
|
attr_accessor :can_edit
|
|
21
21
|
|
|
@@ -25,18 +25,27 @@ module FlatApi
|
|
|
25
25
|
# Whether the current user can add folders within this resource (e.g. `folder` inside `root`)
|
|
26
26
|
attr_accessor :can_add_folders
|
|
27
27
|
|
|
28
|
+
# Whether the current user can change the privacy of this resource (e.g. to share as `organizationPublic` or unshare it with `private`)
|
|
29
|
+
attr_accessor :can_change_privacy
|
|
30
|
+
|
|
28
31
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
29
32
|
def self.attribute_map
|
|
30
33
|
{
|
|
31
34
|
:'can_edit' => :'canEdit',
|
|
32
35
|
:'can_add_resources' => :'canAddResources',
|
|
33
|
-
:'can_add_folders' => :'canAddFolders'
|
|
36
|
+
:'can_add_folders' => :'canAddFolders',
|
|
37
|
+
:'can_change_privacy' => :'canChangePrivacy'
|
|
34
38
|
}
|
|
35
39
|
end
|
|
36
40
|
|
|
41
|
+
# Returns attribute mapping this model knows about
|
|
42
|
+
def self.acceptable_attribute_map
|
|
43
|
+
attribute_map
|
|
44
|
+
end
|
|
45
|
+
|
|
37
46
|
# Returns all the JSON keys this model knows about
|
|
38
47
|
def self.acceptable_attributes
|
|
39
|
-
|
|
48
|
+
acceptable_attribute_map.values
|
|
40
49
|
end
|
|
41
50
|
|
|
42
51
|
# Attribute type mapping.
|
|
@@ -44,7 +53,8 @@ module FlatApi
|
|
|
44
53
|
{
|
|
45
54
|
:'can_edit' => :'Boolean',
|
|
46
55
|
:'can_add_resources' => :'Boolean',
|
|
47
|
-
:'can_add_folders' => :'Boolean'
|
|
56
|
+
:'can_add_folders' => :'Boolean',
|
|
57
|
+
:'can_change_privacy' => :'Boolean'
|
|
48
58
|
}
|
|
49
59
|
end
|
|
50
60
|
|
|
@@ -62,9 +72,10 @@ module FlatApi
|
|
|
62
72
|
end
|
|
63
73
|
|
|
64
74
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
75
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
65
76
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
66
|
-
if (!
|
|
67
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceCapabilities`. Please check the name to make sure it's valid. List of attributes: " +
|
|
77
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
78
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceCapabilities`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
68
79
|
end
|
|
69
80
|
h[k.to_sym] = v
|
|
70
81
|
}
|
|
@@ -80,6 +91,10 @@ module FlatApi
|
|
|
80
91
|
if attributes.key?(:'can_add_folders')
|
|
81
92
|
self.can_add_folders = attributes[:'can_add_folders']
|
|
82
93
|
end
|
|
94
|
+
|
|
95
|
+
if attributes.key?(:'can_change_privacy')
|
|
96
|
+
self.can_change_privacy = attributes[:'can_change_privacy']
|
|
97
|
+
end
|
|
83
98
|
end
|
|
84
99
|
|
|
85
100
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -104,7 +119,8 @@ module FlatApi
|
|
|
104
119
|
self.class == o.class &&
|
|
105
120
|
can_edit == o.can_edit &&
|
|
106
121
|
can_add_resources == o.can_add_resources &&
|
|
107
|
-
can_add_folders == o.can_add_folders
|
|
122
|
+
can_add_folders == o.can_add_folders &&
|
|
123
|
+
can_change_privacy == o.can_change_privacy
|
|
108
124
|
end
|
|
109
125
|
|
|
110
126
|
# @see the `==` method
|
|
@@ -116,7 +132,7 @@ module FlatApi
|
|
|
116
132
|
# Calculates hash code according to all attributes.
|
|
117
133
|
# @return [Integer] Hash code
|
|
118
134
|
def hash
|
|
119
|
-
[can_edit, can_add_resources, can_add_folders].hash
|
|
135
|
+
[can_edit, can_add_resources, can_add_folders, can_change_privacy].hash
|
|
120
136
|
end
|
|
121
137
|
|
|
122
138
|
# Builds the object from hash
|
|
@@ -142,61 +158,6 @@ module FlatApi
|
|
|
142
158
|
new(transformed_hash)
|
|
143
159
|
end
|
|
144
160
|
|
|
145
|
-
# Deserializes the data based on type
|
|
146
|
-
# @param string type Data type
|
|
147
|
-
# @param string value Value to be deserialized
|
|
148
|
-
# @return [Object] Deserialized data
|
|
149
|
-
def self._deserialize(type, value)
|
|
150
|
-
case type.to_sym
|
|
151
|
-
when :Time
|
|
152
|
-
Time.parse(value)
|
|
153
|
-
when :Date
|
|
154
|
-
Date.parse(value)
|
|
155
|
-
when :String
|
|
156
|
-
value.to_s
|
|
157
|
-
when :Integer
|
|
158
|
-
value.to_i
|
|
159
|
-
when :Float
|
|
160
|
-
value.to_f
|
|
161
|
-
when :Boolean
|
|
162
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
163
|
-
true
|
|
164
|
-
else
|
|
165
|
-
false
|
|
166
|
-
end
|
|
167
|
-
when :Object
|
|
168
|
-
# generic object (usually a Hash), return directly
|
|
169
|
-
value
|
|
170
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
171
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
172
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
173
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
174
|
-
k_type = Regexp.last_match[:k_type]
|
|
175
|
-
v_type = Regexp.last_match[:v_type]
|
|
176
|
-
{}.tap do |hash|
|
|
177
|
-
value.each do |k, v|
|
|
178
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
179
|
-
end
|
|
180
|
-
end
|
|
181
|
-
else # model
|
|
182
|
-
# models (e.g. Pet) or oneOf
|
|
183
|
-
klass = FlatApi.const_get(type)
|
|
184
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
185
|
-
end
|
|
186
|
-
end
|
|
187
|
-
|
|
188
|
-
# Returns the string representation of the object
|
|
189
|
-
# @return [String] String presentation of the object
|
|
190
|
-
def to_s
|
|
191
|
-
to_hash.to_s
|
|
192
|
-
end
|
|
193
|
-
|
|
194
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
195
|
-
# @return [Hash] Returns the object in the form of hash
|
|
196
|
-
def to_body
|
|
197
|
-
to_hash
|
|
198
|
-
end
|
|
199
|
-
|
|
200
161
|
# Returns the object in the form of hash
|
|
201
162
|
# @return [Hash] Returns the object in the form of hash
|
|
202
163
|
def to_hash
|
|
@@ -213,24 +174,6 @@ module FlatApi
|
|
|
213
174
|
hash
|
|
214
175
|
end
|
|
215
176
|
|
|
216
|
-
# Outputs non-array value in the form of hash
|
|
217
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
218
|
-
# @param [Object] value Any valid value
|
|
219
|
-
# @return [Hash] Returns the value in the form of hash
|
|
220
|
-
def _to_hash(value)
|
|
221
|
-
if value.is_a?(Array)
|
|
222
|
-
value.compact.map { |v| _to_hash(v) }
|
|
223
|
-
elsif value.is_a?(Hash)
|
|
224
|
-
{}.tap do |hash|
|
|
225
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
226
|
-
end
|
|
227
|
-
elsif value.respond_to? :to_hash
|
|
228
|
-
value.to_hash
|
|
229
|
-
else
|
|
230
|
-
value
|
|
231
|
-
end
|
|
232
|
-
end
|
|
233
|
-
|
|
234
177
|
end
|
|
235
178
|
|
|
236
179
|
end
|