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,12 +15,24 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# Update of an education resource
|
|
18
|
-
class EduResourceUpdate
|
|
18
|
+
class EduResourceUpdate < ApiModelBase
|
|
19
19
|
# Title of the resource
|
|
20
20
|
attr_accessor :title
|
|
21
21
|
|
|
22
|
+
# Sharing description of the resource
|
|
23
|
+
attr_accessor :sharing_description
|
|
24
|
+
|
|
25
|
+
# HTML version of sharing description with rich text formatting. Supports safe HTML tags: p, br, strong, b, em, i, u, a.
|
|
26
|
+
attr_accessor :sharing_description_html
|
|
27
|
+
|
|
22
28
|
attr_accessor :privacy
|
|
23
29
|
|
|
30
|
+
# The subjects of this resource, or the subjects of the resources included in the folder
|
|
31
|
+
attr_accessor :subjects
|
|
32
|
+
|
|
33
|
+
# The grades of this resource, or the grades of the resources included in the folder.
|
|
34
|
+
attr_accessor :grades
|
|
35
|
+
|
|
24
36
|
class EnumAttributeValidator
|
|
25
37
|
attr_reader :datatype
|
|
26
38
|
attr_reader :allowable_values
|
|
@@ -47,20 +59,33 @@ module FlatApi
|
|
|
47
59
|
def self.attribute_map
|
|
48
60
|
{
|
|
49
61
|
:'title' => :'title',
|
|
50
|
-
:'
|
|
62
|
+
:'sharing_description' => :'sharingDescription',
|
|
63
|
+
:'sharing_description_html' => :'sharingDescriptionHtml',
|
|
64
|
+
:'privacy' => :'privacy',
|
|
65
|
+
:'subjects' => :'subjects',
|
|
66
|
+
:'grades' => :'grades'
|
|
51
67
|
}
|
|
52
68
|
end
|
|
53
69
|
|
|
70
|
+
# Returns attribute mapping this model knows about
|
|
71
|
+
def self.acceptable_attribute_map
|
|
72
|
+
attribute_map
|
|
73
|
+
end
|
|
74
|
+
|
|
54
75
|
# Returns all the JSON keys this model knows about
|
|
55
76
|
def self.acceptable_attributes
|
|
56
|
-
|
|
77
|
+
acceptable_attribute_map.values
|
|
57
78
|
end
|
|
58
79
|
|
|
59
80
|
# Attribute type mapping.
|
|
60
81
|
def self.openapi_types
|
|
61
82
|
{
|
|
62
83
|
:'title' => :'String',
|
|
63
|
-
:'
|
|
84
|
+
:'sharing_description' => :'String',
|
|
85
|
+
:'sharing_description_html' => :'String',
|
|
86
|
+
:'privacy' => :'EduResourcePrivacy',
|
|
87
|
+
:'subjects' => :'Array<TeachingTheme>',
|
|
88
|
+
:'grades' => :'Array<Grade>'
|
|
64
89
|
}
|
|
65
90
|
end
|
|
66
91
|
|
|
@@ -78,9 +103,10 @@ module FlatApi
|
|
|
78
103
|
end
|
|
79
104
|
|
|
80
105
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
106
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
81
107
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
82
|
-
if (!
|
|
83
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceUpdate`. Please check the name to make sure it's valid. List of attributes: " +
|
|
108
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
109
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceUpdate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
84
110
|
end
|
|
85
111
|
h[k.to_sym] = v
|
|
86
112
|
}
|
|
@@ -89,11 +115,31 @@ module FlatApi
|
|
|
89
115
|
self.title = attributes[:'title']
|
|
90
116
|
end
|
|
91
117
|
|
|
118
|
+
if attributes.key?(:'sharing_description')
|
|
119
|
+
self.sharing_description = attributes[:'sharing_description']
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
if attributes.key?(:'sharing_description_html')
|
|
123
|
+
self.sharing_description_html = attributes[:'sharing_description_html']
|
|
124
|
+
end
|
|
125
|
+
|
|
92
126
|
if attributes.key?(:'privacy')
|
|
93
127
|
self.privacy = attributes[:'privacy']
|
|
94
128
|
else
|
|
95
129
|
self.privacy = 'private'
|
|
96
130
|
end
|
|
131
|
+
|
|
132
|
+
if attributes.key?(:'subjects')
|
|
133
|
+
if (value = attributes[:'subjects']).is_a?(Array)
|
|
134
|
+
self.subjects = value
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
if attributes.key?(:'grades')
|
|
139
|
+
if (value = attributes[:'grades']).is_a?(Array)
|
|
140
|
+
self.grades = value
|
|
141
|
+
end
|
|
142
|
+
end
|
|
97
143
|
end
|
|
98
144
|
|
|
99
145
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -106,7 +152,15 @@ module FlatApi
|
|
|
106
152
|
end
|
|
107
153
|
|
|
108
154
|
if !@title.nil? && @title.to_s.length < 1
|
|
109
|
-
invalid_properties.push('invalid value for "title", the character length must be
|
|
155
|
+
invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
if !@sharing_description.nil? && @sharing_description.to_s.length > 400
|
|
159
|
+
invalid_properties.push('invalid value for "sharing_description", the character length must be smaller than or equal to 400.')
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
if !@sharing_description_html.nil? && @sharing_description_html.to_s.length > 10000
|
|
163
|
+
invalid_properties.push('invalid value for "sharing_description_html", the character length must be smaller than or equal to 10000.')
|
|
110
164
|
end
|
|
111
165
|
|
|
112
166
|
invalid_properties
|
|
@@ -118,6 +172,8 @@ module FlatApi
|
|
|
118
172
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
119
173
|
return false if !@title.nil? && @title.to_s.length > 1000
|
|
120
174
|
return false if !@title.nil? && @title.to_s.length < 1
|
|
175
|
+
return false if !@sharing_description.nil? && @sharing_description.to_s.length > 400
|
|
176
|
+
return false if !@sharing_description_html.nil? && @sharing_description_html.to_s.length > 10000
|
|
121
177
|
true
|
|
122
178
|
end
|
|
123
179
|
|
|
@@ -133,19 +189,51 @@ module FlatApi
|
|
|
133
189
|
end
|
|
134
190
|
|
|
135
191
|
if title.to_s.length < 1
|
|
136
|
-
fail ArgumentError, 'invalid value for "title", the character length must be
|
|
192
|
+
fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
|
|
137
193
|
end
|
|
138
194
|
|
|
139
195
|
@title = title
|
|
140
196
|
end
|
|
141
197
|
|
|
198
|
+
# Custom attribute writer method with validation
|
|
199
|
+
# @param [Object] sharing_description Value to be assigned
|
|
200
|
+
def sharing_description=(sharing_description)
|
|
201
|
+
if sharing_description.nil?
|
|
202
|
+
fail ArgumentError, 'sharing_description cannot be nil'
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
if sharing_description.to_s.length > 400
|
|
206
|
+
fail ArgumentError, 'invalid value for "sharing_description", the character length must be smaller than or equal to 400.'
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
@sharing_description = sharing_description
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
# Custom attribute writer method with validation
|
|
213
|
+
# @param [Object] sharing_description_html Value to be assigned
|
|
214
|
+
def sharing_description_html=(sharing_description_html)
|
|
215
|
+
if sharing_description_html.nil?
|
|
216
|
+
fail ArgumentError, 'sharing_description_html cannot be nil'
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
if sharing_description_html.to_s.length > 10000
|
|
220
|
+
fail ArgumentError, 'invalid value for "sharing_description_html", the character length must be smaller than or equal to 10000.'
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
@sharing_description_html = sharing_description_html
|
|
224
|
+
end
|
|
225
|
+
|
|
142
226
|
# Checks equality by comparing each attribute.
|
|
143
227
|
# @param [Object] Object to be compared
|
|
144
228
|
def ==(o)
|
|
145
229
|
return true if self.equal?(o)
|
|
146
230
|
self.class == o.class &&
|
|
147
231
|
title == o.title &&
|
|
148
|
-
|
|
232
|
+
sharing_description == o.sharing_description &&
|
|
233
|
+
sharing_description_html == o.sharing_description_html &&
|
|
234
|
+
privacy == o.privacy &&
|
|
235
|
+
subjects == o.subjects &&
|
|
236
|
+
grades == o.grades
|
|
149
237
|
end
|
|
150
238
|
|
|
151
239
|
# @see the `==` method
|
|
@@ -157,7 +245,7 @@ module FlatApi
|
|
|
157
245
|
# Calculates hash code according to all attributes.
|
|
158
246
|
# @return [Integer] Hash code
|
|
159
247
|
def hash
|
|
160
|
-
[title, privacy].hash
|
|
248
|
+
[title, sharing_description, sharing_description_html, privacy, subjects, grades].hash
|
|
161
249
|
end
|
|
162
250
|
|
|
163
251
|
# Builds the object from hash
|
|
@@ -183,61 +271,6 @@ module FlatApi
|
|
|
183
271
|
new(transformed_hash)
|
|
184
272
|
end
|
|
185
273
|
|
|
186
|
-
# Deserializes the data based on type
|
|
187
|
-
# @param string type Data type
|
|
188
|
-
# @param string value Value to be deserialized
|
|
189
|
-
# @return [Object] Deserialized data
|
|
190
|
-
def self._deserialize(type, value)
|
|
191
|
-
case type.to_sym
|
|
192
|
-
when :Time
|
|
193
|
-
Time.parse(value)
|
|
194
|
-
when :Date
|
|
195
|
-
Date.parse(value)
|
|
196
|
-
when :String
|
|
197
|
-
value.to_s
|
|
198
|
-
when :Integer
|
|
199
|
-
value.to_i
|
|
200
|
-
when :Float
|
|
201
|
-
value.to_f
|
|
202
|
-
when :Boolean
|
|
203
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
204
|
-
true
|
|
205
|
-
else
|
|
206
|
-
false
|
|
207
|
-
end
|
|
208
|
-
when :Object
|
|
209
|
-
# generic object (usually a Hash), return directly
|
|
210
|
-
value
|
|
211
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
212
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
213
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
214
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
215
|
-
k_type = Regexp.last_match[:k_type]
|
|
216
|
-
v_type = Regexp.last_match[:v_type]
|
|
217
|
-
{}.tap do |hash|
|
|
218
|
-
value.each do |k, v|
|
|
219
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
220
|
-
end
|
|
221
|
-
end
|
|
222
|
-
else # model
|
|
223
|
-
# models (e.g. Pet) or oneOf
|
|
224
|
-
klass = FlatApi.const_get(type)
|
|
225
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
226
|
-
end
|
|
227
|
-
end
|
|
228
|
-
|
|
229
|
-
# Returns the string representation of the object
|
|
230
|
-
# @return [String] String presentation of the object
|
|
231
|
-
def to_s
|
|
232
|
-
to_hash.to_s
|
|
233
|
-
end
|
|
234
|
-
|
|
235
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
236
|
-
# @return [Hash] Returns the object in the form of hash
|
|
237
|
-
def to_body
|
|
238
|
-
to_hash
|
|
239
|
-
end
|
|
240
|
-
|
|
241
274
|
# Returns the object in the form of hash
|
|
242
275
|
# @return [Hash] Returns the object in the form of hash
|
|
243
276
|
def to_hash
|
|
@@ -254,24 +287,6 @@ module FlatApi
|
|
|
254
287
|
hash
|
|
255
288
|
end
|
|
256
289
|
|
|
257
|
-
# Outputs non-array value in the form of hash
|
|
258
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
259
|
-
# @param [Object] value Any valid value
|
|
260
|
-
# @return [Hash] Returns the value in the form of hash
|
|
261
|
-
def _to_hash(value)
|
|
262
|
-
if value.is_a?(Array)
|
|
263
|
-
value.compact.map { |v| _to_hash(v) }
|
|
264
|
-
elsif value.is_a?(Hash)
|
|
265
|
-
{}.tap do |hash|
|
|
266
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
267
|
-
end
|
|
268
|
-
elsif value.respond_to? :to_hash
|
|
269
|
-
value.to_hash
|
|
270
|
-
else
|
|
271
|
-
value
|
|
272
|
-
end
|
|
273
|
-
end
|
|
274
|
-
|
|
275
290
|
end
|
|
276
291
|
|
|
277
292
|
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
|
# Use an education resource in class
|
|
18
|
-
class EduResourceUseInClass
|
|
18
|
+
class EduResourceUseInClass < ApiModelBase
|
|
19
19
|
# The destination classroom where the resource will be copied.
|
|
20
20
|
attr_accessor :classroom
|
|
21
21
|
|
|
@@ -30,9 +30,14 @@ module FlatApi
|
|
|
30
30
|
}
|
|
31
31
|
end
|
|
32
32
|
|
|
33
|
+
# Returns attribute mapping this model knows about
|
|
34
|
+
def self.acceptable_attribute_map
|
|
35
|
+
attribute_map
|
|
36
|
+
end
|
|
37
|
+
|
|
33
38
|
# Returns all the JSON keys this model knows about
|
|
34
39
|
def self.acceptable_attributes
|
|
35
|
-
|
|
40
|
+
acceptable_attribute_map.values
|
|
36
41
|
end
|
|
37
42
|
|
|
38
43
|
# Attribute type mapping.
|
|
@@ -57,9 +62,10 @@ module FlatApi
|
|
|
57
62
|
end
|
|
58
63
|
|
|
59
64
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
65
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
60
66
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
61
|
-
if (!
|
|
62
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceUseInClass`. Please check the name to make sure it's valid. List of attributes: " +
|
|
67
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::EduResourceUseInClass`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
63
69
|
end
|
|
64
70
|
h[k.to_sym] = v
|
|
65
71
|
}
|
|
@@ -95,6 +101,16 @@ module FlatApi
|
|
|
95
101
|
true
|
|
96
102
|
end
|
|
97
103
|
|
|
104
|
+
# Custom attribute writer method with validation
|
|
105
|
+
# @param [Object] classroom Value to be assigned
|
|
106
|
+
def classroom=(classroom)
|
|
107
|
+
if classroom.nil?
|
|
108
|
+
fail ArgumentError, 'classroom cannot be nil'
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
@classroom = classroom
|
|
112
|
+
end
|
|
113
|
+
|
|
98
114
|
# Checks equality by comparing each attribute.
|
|
99
115
|
# @param [Object] Object to be compared
|
|
100
116
|
def ==(o)
|
|
@@ -139,61 +155,6 @@ module FlatApi
|
|
|
139
155
|
new(transformed_hash)
|
|
140
156
|
end
|
|
141
157
|
|
|
142
|
-
# Deserializes the data based on type
|
|
143
|
-
# @param string type Data type
|
|
144
|
-
# @param string value Value to be deserialized
|
|
145
|
-
# @return [Object] Deserialized data
|
|
146
|
-
def self._deserialize(type, value)
|
|
147
|
-
case type.to_sym
|
|
148
|
-
when :Time
|
|
149
|
-
Time.parse(value)
|
|
150
|
-
when :Date
|
|
151
|
-
Date.parse(value)
|
|
152
|
-
when :String
|
|
153
|
-
value.to_s
|
|
154
|
-
when :Integer
|
|
155
|
-
value.to_i
|
|
156
|
-
when :Float
|
|
157
|
-
value.to_f
|
|
158
|
-
when :Boolean
|
|
159
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
160
|
-
true
|
|
161
|
-
else
|
|
162
|
-
false
|
|
163
|
-
end
|
|
164
|
-
when :Object
|
|
165
|
-
# generic object (usually a Hash), return directly
|
|
166
|
-
value
|
|
167
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
168
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
169
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
170
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
171
|
-
k_type = Regexp.last_match[:k_type]
|
|
172
|
-
v_type = Regexp.last_match[:v_type]
|
|
173
|
-
{}.tap do |hash|
|
|
174
|
-
value.each do |k, v|
|
|
175
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
176
|
-
end
|
|
177
|
-
end
|
|
178
|
-
else # model
|
|
179
|
-
# models (e.g. Pet) or oneOf
|
|
180
|
-
klass = FlatApi.const_get(type)
|
|
181
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
182
|
-
end
|
|
183
|
-
end
|
|
184
|
-
|
|
185
|
-
# Returns the string representation of the object
|
|
186
|
-
# @return [String] String presentation of the object
|
|
187
|
-
def to_s
|
|
188
|
-
to_hash.to_s
|
|
189
|
-
end
|
|
190
|
-
|
|
191
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
192
|
-
# @return [Hash] Returns the object in the form of hash
|
|
193
|
-
def to_body
|
|
194
|
-
to_hash
|
|
195
|
-
end
|
|
196
|
-
|
|
197
158
|
# Returns the object in the form of hash
|
|
198
159
|
# @return [Hash] Returns the object in the form of hash
|
|
199
160
|
def to_hash
|
|
@@ -210,24 +171,6 @@ module FlatApi
|
|
|
210
171
|
hash
|
|
211
172
|
end
|
|
212
173
|
|
|
213
|
-
# Outputs non-array value in the form of hash
|
|
214
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
215
|
-
# @param [Object] value Any valid value
|
|
216
|
-
# @return [Hash] Returns the value in the form of hash
|
|
217
|
-
def _to_hash(value)
|
|
218
|
-
if value.is_a?(Array)
|
|
219
|
-
value.compact.map { |v| _to_hash(v) }
|
|
220
|
-
elsif value.is_a?(Hash)
|
|
221
|
-
{}.tap do |hash|
|
|
222
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
223
|
-
end
|
|
224
|
-
elsif value.respond_to? :to_hash
|
|
225
|
-
value.to_hash
|
|
226
|
-
else
|
|
227
|
-
value
|
|
228
|
-
end
|
|
229
|
-
end
|
|
230
|
-
|
|
231
174
|
end
|
|
232
175
|
|
|
233
176
|
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
|
# An API Error response
|
|
18
|
-
class FlatErrorResponse
|
|
18
|
+
class FlatErrorResponse < ApiModelBase
|
|
19
19
|
# A corresponding code for this error
|
|
20
20
|
attr_accessor :code
|
|
21
21
|
|
|
@@ -28,19 +28,28 @@ module FlatApi
|
|
|
28
28
|
# The related parameter that caused the error
|
|
29
29
|
attr_accessor :param
|
|
30
30
|
|
|
31
|
+
# The untranslated error message returned by an external provider (e.g. Google Classroom), when the error originates from one. Only set on errors forwarded from a third party. Meant for support and IT: display it alongside `message`, never in place of it. `message` is the localized, user-facing text; this field is raw provider output and is always in English.
|
|
32
|
+
attr_accessor :provider_message
|
|
33
|
+
|
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
32
35
|
def self.attribute_map
|
|
33
36
|
{
|
|
34
37
|
:'code' => :'code',
|
|
35
38
|
:'message' => :'message',
|
|
36
39
|
:'id' => :'id',
|
|
37
|
-
:'param' => :'param'
|
|
40
|
+
:'param' => :'param',
|
|
41
|
+
:'provider_message' => :'providerMessage'
|
|
38
42
|
}
|
|
39
43
|
end
|
|
40
44
|
|
|
45
|
+
# Returns attribute mapping this model knows about
|
|
46
|
+
def self.acceptable_attribute_map
|
|
47
|
+
attribute_map
|
|
48
|
+
end
|
|
49
|
+
|
|
41
50
|
# Returns all the JSON keys this model knows about
|
|
42
51
|
def self.acceptable_attributes
|
|
43
|
-
|
|
52
|
+
acceptable_attribute_map.values
|
|
44
53
|
end
|
|
45
54
|
|
|
46
55
|
# Attribute type mapping.
|
|
@@ -49,7 +58,8 @@ module FlatApi
|
|
|
49
58
|
:'code' => :'String',
|
|
50
59
|
:'message' => :'String',
|
|
51
60
|
:'id' => :'String',
|
|
52
|
-
:'param' => :'String'
|
|
61
|
+
:'param' => :'String',
|
|
62
|
+
:'provider_message' => :'String'
|
|
53
63
|
}
|
|
54
64
|
end
|
|
55
65
|
|
|
@@ -67,9 +77,10 @@ module FlatApi
|
|
|
67
77
|
end
|
|
68
78
|
|
|
69
79
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
80
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
70
81
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
71
|
-
if (!
|
|
72
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::FlatErrorResponse`. Please check the name to make sure it's valid. List of attributes: " +
|
|
82
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
83
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::FlatErrorResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
73
84
|
end
|
|
74
85
|
h[k.to_sym] = v
|
|
75
86
|
}
|
|
@@ -93,6 +104,10 @@ module FlatApi
|
|
|
93
104
|
if attributes.key?(:'param')
|
|
94
105
|
self.param = attributes[:'param']
|
|
95
106
|
end
|
|
107
|
+
|
|
108
|
+
if attributes.key?(:'provider_message')
|
|
109
|
+
self.provider_message = attributes[:'provider_message']
|
|
110
|
+
end
|
|
96
111
|
end
|
|
97
112
|
|
|
98
113
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -120,6 +135,26 @@ module FlatApi
|
|
|
120
135
|
true
|
|
121
136
|
end
|
|
122
137
|
|
|
138
|
+
# Custom attribute writer method with validation
|
|
139
|
+
# @param [Object] code Value to be assigned
|
|
140
|
+
def code=(code)
|
|
141
|
+
if code.nil?
|
|
142
|
+
fail ArgumentError, 'code cannot be nil'
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
@code = code
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Custom attribute writer method with validation
|
|
149
|
+
# @param [Object] message Value to be assigned
|
|
150
|
+
def message=(message)
|
|
151
|
+
if message.nil?
|
|
152
|
+
fail ArgumentError, 'message cannot be nil'
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
@message = message
|
|
156
|
+
end
|
|
157
|
+
|
|
123
158
|
# Checks equality by comparing each attribute.
|
|
124
159
|
# @param [Object] Object to be compared
|
|
125
160
|
def ==(o)
|
|
@@ -128,7 +163,8 @@ module FlatApi
|
|
|
128
163
|
code == o.code &&
|
|
129
164
|
message == o.message &&
|
|
130
165
|
id == o.id &&
|
|
131
|
-
param == o.param
|
|
166
|
+
param == o.param &&
|
|
167
|
+
provider_message == o.provider_message
|
|
132
168
|
end
|
|
133
169
|
|
|
134
170
|
# @see the `==` method
|
|
@@ -140,7 +176,7 @@ module FlatApi
|
|
|
140
176
|
# Calculates hash code according to all attributes.
|
|
141
177
|
# @return [Integer] Hash code
|
|
142
178
|
def hash
|
|
143
|
-
[code, message, id, param].hash
|
|
179
|
+
[code, message, id, param, provider_message].hash
|
|
144
180
|
end
|
|
145
181
|
|
|
146
182
|
# Builds the object from hash
|
|
@@ -166,61 +202,6 @@ module FlatApi
|
|
|
166
202
|
new(transformed_hash)
|
|
167
203
|
end
|
|
168
204
|
|
|
169
|
-
# Deserializes the data based on type
|
|
170
|
-
# @param string type Data type
|
|
171
|
-
# @param string value Value to be deserialized
|
|
172
|
-
# @return [Object] Deserialized data
|
|
173
|
-
def self._deserialize(type, value)
|
|
174
|
-
case type.to_sym
|
|
175
|
-
when :Time
|
|
176
|
-
Time.parse(value)
|
|
177
|
-
when :Date
|
|
178
|
-
Date.parse(value)
|
|
179
|
-
when :String
|
|
180
|
-
value.to_s
|
|
181
|
-
when :Integer
|
|
182
|
-
value.to_i
|
|
183
|
-
when :Float
|
|
184
|
-
value.to_f
|
|
185
|
-
when :Boolean
|
|
186
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
187
|
-
true
|
|
188
|
-
else
|
|
189
|
-
false
|
|
190
|
-
end
|
|
191
|
-
when :Object
|
|
192
|
-
# generic object (usually a Hash), return directly
|
|
193
|
-
value
|
|
194
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
195
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
196
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
197
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
198
|
-
k_type = Regexp.last_match[:k_type]
|
|
199
|
-
v_type = Regexp.last_match[:v_type]
|
|
200
|
-
{}.tap do |hash|
|
|
201
|
-
value.each do |k, v|
|
|
202
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
203
|
-
end
|
|
204
|
-
end
|
|
205
|
-
else # model
|
|
206
|
-
# models (e.g. Pet) or oneOf
|
|
207
|
-
klass = FlatApi.const_get(type)
|
|
208
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
209
|
-
end
|
|
210
|
-
end
|
|
211
|
-
|
|
212
|
-
# Returns the string representation of the object
|
|
213
|
-
# @return [String] String presentation of the object
|
|
214
|
-
def to_s
|
|
215
|
-
to_hash.to_s
|
|
216
|
-
end
|
|
217
|
-
|
|
218
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
219
|
-
# @return [Hash] Returns the object in the form of hash
|
|
220
|
-
def to_body
|
|
221
|
-
to_hash
|
|
222
|
-
end
|
|
223
|
-
|
|
224
205
|
# Returns the object in the form of hash
|
|
225
206
|
# @return [Hash] Returns the object in the form of hash
|
|
226
207
|
def to_hash
|
|
@@ -237,24 +218,6 @@ module FlatApi
|
|
|
237
218
|
hash
|
|
238
219
|
end
|
|
239
220
|
|
|
240
|
-
# Outputs non-array value in the form of hash
|
|
241
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
242
|
-
# @param [Object] value Any valid value
|
|
243
|
-
# @return [Hash] Returns the value in the form of hash
|
|
244
|
-
def _to_hash(value)
|
|
245
|
-
if value.is_a?(Array)
|
|
246
|
-
value.compact.map { |v| _to_hash(v) }
|
|
247
|
-
elsif value.is_a?(Hash)
|
|
248
|
-
{}.tap do |hash|
|
|
249
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
250
|
-
end
|
|
251
|
-
elsif value.respond_to? :to_hash
|
|
252
|
-
value.to_hash
|
|
253
|
-
else
|
|
254
|
-
value
|
|
255
|
-
end
|
|
256
|
-
end
|
|
257
|
-
|
|
258
221
|
end
|
|
259
222
|
|
|
260
223
|
end
|