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
|
|
|
@@ -14,13 +14,13 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
class ScoreCreationCommon
|
|
17
|
+
class ScoreCreationCommon < ApiModelBase
|
|
18
18
|
# The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Use the name of the file for files from a specified `source` (e.g. Google Drive) or the one in the `filename` property - Set a default title (e.g. \"New Music Score\")
|
|
19
19
|
attr_accessor :title
|
|
20
20
|
|
|
21
21
|
attr_accessor :privacy
|
|
22
22
|
|
|
23
|
-
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be
|
|
23
|
+
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will not be added to any collection and will only be visible in the `allScores` virtual collection.
|
|
24
24
|
attr_accessor :collection
|
|
25
25
|
|
|
26
26
|
# If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.
|
|
@@ -58,9 +58,14 @@ module FlatApi
|
|
|
58
58
|
}
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
+
# Returns attribute mapping this model knows about
|
|
62
|
+
def self.acceptable_attribute_map
|
|
63
|
+
attribute_map
|
|
64
|
+
end
|
|
65
|
+
|
|
61
66
|
# Returns all the JSON keys this model knows about
|
|
62
67
|
def self.acceptable_attributes
|
|
63
|
-
|
|
68
|
+
acceptable_attribute_map.values
|
|
64
69
|
end
|
|
65
70
|
|
|
66
71
|
# Attribute type mapping.
|
|
@@ -87,9 +92,10 @@ module FlatApi
|
|
|
87
92
|
end
|
|
88
93
|
|
|
89
94
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
95
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
90
96
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
91
|
-
if (!
|
|
92
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationCommon`. Please check the name to make sure it's valid. List of attributes: " +
|
|
97
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
98
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationCommon`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
93
99
|
end
|
|
94
100
|
h[k.to_sym] = v
|
|
95
101
|
}
|
|
@@ -174,61 +180,6 @@ module FlatApi
|
|
|
174
180
|
new(transformed_hash)
|
|
175
181
|
end
|
|
176
182
|
|
|
177
|
-
# Deserializes the data based on type
|
|
178
|
-
# @param string type Data type
|
|
179
|
-
# @param string value Value to be deserialized
|
|
180
|
-
# @return [Object] Deserialized data
|
|
181
|
-
def self._deserialize(type, value)
|
|
182
|
-
case type.to_sym
|
|
183
|
-
when :Time
|
|
184
|
-
Time.parse(value)
|
|
185
|
-
when :Date
|
|
186
|
-
Date.parse(value)
|
|
187
|
-
when :String
|
|
188
|
-
value.to_s
|
|
189
|
-
when :Integer
|
|
190
|
-
value.to_i
|
|
191
|
-
when :Float
|
|
192
|
-
value.to_f
|
|
193
|
-
when :Boolean
|
|
194
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
195
|
-
true
|
|
196
|
-
else
|
|
197
|
-
false
|
|
198
|
-
end
|
|
199
|
-
when :Object
|
|
200
|
-
# generic object (usually a Hash), return directly
|
|
201
|
-
value
|
|
202
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
203
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
204
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
205
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
206
|
-
k_type = Regexp.last_match[:k_type]
|
|
207
|
-
v_type = Regexp.last_match[:v_type]
|
|
208
|
-
{}.tap do |hash|
|
|
209
|
-
value.each do |k, v|
|
|
210
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
211
|
-
end
|
|
212
|
-
end
|
|
213
|
-
else # model
|
|
214
|
-
# models (e.g. Pet) or oneOf
|
|
215
|
-
klass = FlatApi.const_get(type)
|
|
216
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
217
|
-
end
|
|
218
|
-
end
|
|
219
|
-
|
|
220
|
-
# Returns the string representation of the object
|
|
221
|
-
# @return [String] String presentation of the object
|
|
222
|
-
def to_s
|
|
223
|
-
to_hash.to_s
|
|
224
|
-
end
|
|
225
|
-
|
|
226
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
227
|
-
# @return [Hash] Returns the object in the form of hash
|
|
228
|
-
def to_body
|
|
229
|
-
to_hash
|
|
230
|
-
end
|
|
231
|
-
|
|
232
183
|
# Returns the object in the form of hash
|
|
233
184
|
# @return [Hash] Returns the object in the form of hash
|
|
234
185
|
def to_hash
|
|
@@ -245,24 +196,6 @@ module FlatApi
|
|
|
245
196
|
hash
|
|
246
197
|
end
|
|
247
198
|
|
|
248
|
-
# Outputs non-array value in the form of hash
|
|
249
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
250
|
-
# @param [Object] value Any valid value
|
|
251
|
-
# @return [Hash] Returns the value in the form of hash
|
|
252
|
-
def _to_hash(value)
|
|
253
|
-
if value.is_a?(Array)
|
|
254
|
-
value.compact.map { |v| _to_hash(v) }
|
|
255
|
-
elsif value.is_a?(Hash)
|
|
256
|
-
{}.tap do |hash|
|
|
257
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
258
|
-
end
|
|
259
|
-
elsif value.respond_to? :to_hash
|
|
260
|
-
value.to_hash
|
|
261
|
-
else
|
|
262
|
-
value
|
|
263
|
-
end
|
|
264
|
-
end
|
|
265
|
-
|
|
266
199
|
end
|
|
267
200
|
|
|
268
201
|
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
|
|
|
@@ -14,13 +14,13 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
class ScoreCreationFileImport
|
|
17
|
+
class ScoreCreationFileImport < ApiModelBase
|
|
18
18
|
# The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Use the name of the file for files from a specified `source` (e.g. Google Drive) or the one in the `filename` property - Set a default title (e.g. \"New Music Score\")
|
|
19
19
|
attr_accessor :title
|
|
20
20
|
|
|
21
21
|
attr_accessor :privacy
|
|
22
22
|
|
|
23
|
-
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be
|
|
23
|
+
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will not be added to any collection and will only be visible in the `allScores` virtual collection.
|
|
24
24
|
attr_accessor :collection
|
|
25
25
|
|
|
26
26
|
# If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.
|
|
@@ -29,12 +29,15 @@ module FlatApi
|
|
|
29
29
|
# If this is an imported file, its filename
|
|
30
30
|
attr_accessor :filename
|
|
31
31
|
|
|
32
|
-
# The data of the score file.
|
|
32
|
+
# The data of the score file. See the `POST /scores` endpoint description for the full list of supported formats. Binary payloads (e.g. compressed MusicXML, MIDI, Guitar Pro) can be encoded in Base64, in this case the `dataEncoding` property must match the encoding used for the API request.
|
|
33
33
|
attr_accessor :data
|
|
34
34
|
|
|
35
35
|
# The optional encoding of the score data. This property must match the encoding used for the `data` property.
|
|
36
36
|
attr_accessor :data_encoding
|
|
37
37
|
|
|
38
|
+
# Set this to `true` if the client supports asynchronous task flows. When importing a score that requires OMR processing (a PDF or a page image), the API will return a 202 Accepted response along with a task reference. The client can then check the task status using the endpoint `GET /v2/tasks/{task}`.
|
|
39
|
+
attr_accessor :supports_tasks
|
|
40
|
+
|
|
38
41
|
class EnumAttributeValidator
|
|
39
42
|
attr_reader :datatype
|
|
40
43
|
attr_reader :allowable_values
|
|
@@ -66,13 +69,19 @@ module FlatApi
|
|
|
66
69
|
:'google_drive_folder' => :'googleDriveFolder',
|
|
67
70
|
:'filename' => :'filename',
|
|
68
71
|
:'data' => :'data',
|
|
69
|
-
:'data_encoding' => :'dataEncoding'
|
|
72
|
+
:'data_encoding' => :'dataEncoding',
|
|
73
|
+
:'supports_tasks' => :'supportsTasks'
|
|
70
74
|
}
|
|
71
75
|
end
|
|
72
76
|
|
|
77
|
+
# Returns attribute mapping this model knows about
|
|
78
|
+
def self.acceptable_attribute_map
|
|
79
|
+
attribute_map
|
|
80
|
+
end
|
|
81
|
+
|
|
73
82
|
# Returns all the JSON keys this model knows about
|
|
74
83
|
def self.acceptable_attributes
|
|
75
|
-
|
|
84
|
+
acceptable_attribute_map.values
|
|
76
85
|
end
|
|
77
86
|
|
|
78
87
|
# Attribute type mapping.
|
|
@@ -84,7 +93,8 @@ module FlatApi
|
|
|
84
93
|
:'google_drive_folder' => :'String',
|
|
85
94
|
:'filename' => :'String',
|
|
86
95
|
:'data' => :'String',
|
|
87
|
-
:'data_encoding' => :'String'
|
|
96
|
+
:'data_encoding' => :'String',
|
|
97
|
+
:'supports_tasks' => :'Boolean'
|
|
88
98
|
}
|
|
89
99
|
end
|
|
90
100
|
|
|
@@ -109,9 +119,10 @@ module FlatApi
|
|
|
109
119
|
end
|
|
110
120
|
|
|
111
121
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
122
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
112
123
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
113
|
-
if (!
|
|
114
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationFileImport`. Please check the name to make sure it's valid. List of attributes: " +
|
|
124
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
125
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationFileImport`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
115
126
|
end
|
|
116
127
|
h[k.to_sym] = v
|
|
117
128
|
}
|
|
@@ -147,6 +158,10 @@ module FlatApi
|
|
|
147
158
|
if attributes.key?(:'data_encoding')
|
|
148
159
|
self.data_encoding = attributes[:'data_encoding']
|
|
149
160
|
end
|
|
161
|
+
|
|
162
|
+
if attributes.key?(:'supports_tasks')
|
|
163
|
+
self.supports_tasks = attributes[:'supports_tasks']
|
|
164
|
+
end
|
|
150
165
|
end
|
|
151
166
|
|
|
152
167
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -171,6 +186,16 @@ module FlatApi
|
|
|
171
186
|
true
|
|
172
187
|
end
|
|
173
188
|
|
|
189
|
+
# Custom attribute writer method with validation
|
|
190
|
+
# @param [Object] data Value to be assigned
|
|
191
|
+
def data=(data)
|
|
192
|
+
if data.nil?
|
|
193
|
+
fail ArgumentError, 'data cannot be nil'
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
@data = data
|
|
197
|
+
end
|
|
198
|
+
|
|
174
199
|
# Custom attribute writer method checking allowed values (enum).
|
|
175
200
|
# @param [Object] data_encoding Object to be assigned
|
|
176
201
|
def data_encoding=(data_encoding)
|
|
@@ -192,7 +217,8 @@ module FlatApi
|
|
|
192
217
|
google_drive_folder == o.google_drive_folder &&
|
|
193
218
|
filename == o.filename &&
|
|
194
219
|
data == o.data &&
|
|
195
|
-
data_encoding == o.data_encoding
|
|
220
|
+
data_encoding == o.data_encoding &&
|
|
221
|
+
supports_tasks == o.supports_tasks
|
|
196
222
|
end
|
|
197
223
|
|
|
198
224
|
# @see the `==` method
|
|
@@ -204,7 +230,7 @@ module FlatApi
|
|
|
204
230
|
# Calculates hash code according to all attributes.
|
|
205
231
|
# @return [Integer] Hash code
|
|
206
232
|
def hash
|
|
207
|
-
[title, privacy, collection, google_drive_folder, filename, data, data_encoding].hash
|
|
233
|
+
[title, privacy, collection, google_drive_folder, filename, data, data_encoding, supports_tasks].hash
|
|
208
234
|
end
|
|
209
235
|
|
|
210
236
|
# Builds the object from hash
|
|
@@ -230,61 +256,6 @@ module FlatApi
|
|
|
230
256
|
new(transformed_hash)
|
|
231
257
|
end
|
|
232
258
|
|
|
233
|
-
# Deserializes the data based on type
|
|
234
|
-
# @param string type Data type
|
|
235
|
-
# @param string value Value to be deserialized
|
|
236
|
-
# @return [Object] Deserialized data
|
|
237
|
-
def self._deserialize(type, value)
|
|
238
|
-
case type.to_sym
|
|
239
|
-
when :Time
|
|
240
|
-
Time.parse(value)
|
|
241
|
-
when :Date
|
|
242
|
-
Date.parse(value)
|
|
243
|
-
when :String
|
|
244
|
-
value.to_s
|
|
245
|
-
when :Integer
|
|
246
|
-
value.to_i
|
|
247
|
-
when :Float
|
|
248
|
-
value.to_f
|
|
249
|
-
when :Boolean
|
|
250
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
251
|
-
true
|
|
252
|
-
else
|
|
253
|
-
false
|
|
254
|
-
end
|
|
255
|
-
when :Object
|
|
256
|
-
# generic object (usually a Hash), return directly
|
|
257
|
-
value
|
|
258
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
259
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
260
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
261
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
262
|
-
k_type = Regexp.last_match[:k_type]
|
|
263
|
-
v_type = Regexp.last_match[:v_type]
|
|
264
|
-
{}.tap do |hash|
|
|
265
|
-
value.each do |k, v|
|
|
266
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
267
|
-
end
|
|
268
|
-
end
|
|
269
|
-
else # model
|
|
270
|
-
# models (e.g. Pet) or oneOf
|
|
271
|
-
klass = FlatApi.const_get(type)
|
|
272
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
273
|
-
end
|
|
274
|
-
end
|
|
275
|
-
|
|
276
|
-
# Returns the string representation of the object
|
|
277
|
-
# @return [String] String presentation of the object
|
|
278
|
-
def to_s
|
|
279
|
-
to_hash.to_s
|
|
280
|
-
end
|
|
281
|
-
|
|
282
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
283
|
-
# @return [Hash] Returns the object in the form of hash
|
|
284
|
-
def to_body
|
|
285
|
-
to_hash
|
|
286
|
-
end
|
|
287
|
-
|
|
288
259
|
# Returns the object in the form of hash
|
|
289
260
|
# @return [Hash] Returns the object in the form of hash
|
|
290
261
|
def to_hash
|
|
@@ -301,24 +272,6 @@ module FlatApi
|
|
|
301
272
|
hash
|
|
302
273
|
end
|
|
303
274
|
|
|
304
|
-
# Outputs non-array value in the form of hash
|
|
305
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
306
|
-
# @param [Object] value Any valid value
|
|
307
|
-
# @return [Hash] Returns the value in the form of hash
|
|
308
|
-
def _to_hash(value)
|
|
309
|
-
if value.is_a?(Array)
|
|
310
|
-
value.compact.map { |v| _to_hash(v) }
|
|
311
|
-
elsif value.is_a?(Hash)
|
|
312
|
-
{}.tap do |hash|
|
|
313
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
314
|
-
end
|
|
315
|
-
elsif value.respond_to? :to_hash
|
|
316
|
-
value.to_hash
|
|
317
|
-
else
|
|
318
|
-
value
|
|
319
|
-
end
|
|
320
|
-
end
|
|
321
|
-
|
|
322
275
|
end
|
|
323
276
|
|
|
324
277
|
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
|
|
|
@@ -14,13 +14,13 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
class ScoreCreationGoogleDriveImport
|
|
17
|
+
class ScoreCreationGoogleDriveImport < ApiModelBase
|
|
18
18
|
# The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Use the name of the file for files from a specified `source` (e.g. Google Drive) or the one in the `filename` property - Set a default title (e.g. \"New Music Score\")
|
|
19
19
|
attr_accessor :title
|
|
20
20
|
|
|
21
21
|
attr_accessor :privacy
|
|
22
22
|
|
|
23
|
-
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be
|
|
23
|
+
# Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will not be added to any collection and will only be visible in the `allScores` virtual collection.
|
|
24
24
|
attr_accessor :collection
|
|
25
25
|
|
|
26
26
|
# If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.
|
|
@@ -61,9 +61,14 @@ module FlatApi
|
|
|
61
61
|
}
|
|
62
62
|
end
|
|
63
63
|
|
|
64
|
+
# Returns attribute mapping this model knows about
|
|
65
|
+
def self.acceptable_attribute_map
|
|
66
|
+
attribute_map
|
|
67
|
+
end
|
|
68
|
+
|
|
64
69
|
# Returns all the JSON keys this model knows about
|
|
65
70
|
def self.acceptable_attributes
|
|
66
|
-
|
|
71
|
+
acceptable_attribute_map.values
|
|
67
72
|
end
|
|
68
73
|
|
|
69
74
|
# Attribute type mapping.
|
|
@@ -98,9 +103,10 @@ module FlatApi
|
|
|
98
103
|
end
|
|
99
104
|
|
|
100
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
|
|
101
107
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
102
|
-
if (!
|
|
103
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationGoogleDriveImport`. 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::ScoreCreationGoogleDriveImport`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
104
110
|
end
|
|
105
111
|
h[k.to_sym] = v
|
|
106
112
|
}
|
|
@@ -150,6 +156,16 @@ module FlatApi
|
|
|
150
156
|
true
|
|
151
157
|
end
|
|
152
158
|
|
|
159
|
+
# Custom attribute writer method with validation
|
|
160
|
+
# @param [Object] source Value to be assigned
|
|
161
|
+
def source=(source)
|
|
162
|
+
if source.nil?
|
|
163
|
+
fail ArgumentError, 'source cannot be nil'
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
@source = source
|
|
167
|
+
end
|
|
168
|
+
|
|
153
169
|
# Checks equality by comparing each attribute.
|
|
154
170
|
# @param [Object] Object to be compared
|
|
155
171
|
def ==(o)
|
|
@@ -197,61 +213,6 @@ module FlatApi
|
|
|
197
213
|
new(transformed_hash)
|
|
198
214
|
end
|
|
199
215
|
|
|
200
|
-
# Deserializes the data based on type
|
|
201
|
-
# @param string type Data type
|
|
202
|
-
# @param string value Value to be deserialized
|
|
203
|
-
# @return [Object] Deserialized data
|
|
204
|
-
def self._deserialize(type, value)
|
|
205
|
-
case type.to_sym
|
|
206
|
-
when :Time
|
|
207
|
-
Time.parse(value)
|
|
208
|
-
when :Date
|
|
209
|
-
Date.parse(value)
|
|
210
|
-
when :String
|
|
211
|
-
value.to_s
|
|
212
|
-
when :Integer
|
|
213
|
-
value.to_i
|
|
214
|
-
when :Float
|
|
215
|
-
value.to_f
|
|
216
|
-
when :Boolean
|
|
217
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
218
|
-
true
|
|
219
|
-
else
|
|
220
|
-
false
|
|
221
|
-
end
|
|
222
|
-
when :Object
|
|
223
|
-
# generic object (usually a Hash), return directly
|
|
224
|
-
value
|
|
225
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
226
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
227
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
228
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
229
|
-
k_type = Regexp.last_match[:k_type]
|
|
230
|
-
v_type = Regexp.last_match[:v_type]
|
|
231
|
-
{}.tap do |hash|
|
|
232
|
-
value.each do |k, v|
|
|
233
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
234
|
-
end
|
|
235
|
-
end
|
|
236
|
-
else # model
|
|
237
|
-
# models (e.g. Pet) or oneOf
|
|
238
|
-
klass = FlatApi.const_get(type)
|
|
239
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
240
|
-
end
|
|
241
|
-
end
|
|
242
|
-
|
|
243
|
-
# Returns the string representation of the object
|
|
244
|
-
# @return [String] String presentation of the object
|
|
245
|
-
def to_s
|
|
246
|
-
to_hash.to_s
|
|
247
|
-
end
|
|
248
|
-
|
|
249
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
250
|
-
# @return [Hash] Returns the object in the form of hash
|
|
251
|
-
def to_body
|
|
252
|
-
to_hash
|
|
253
|
-
end
|
|
254
|
-
|
|
255
216
|
# Returns the object in the form of hash
|
|
256
217
|
# @return [Hash] Returns the object in the form of hash
|
|
257
218
|
def to_hash
|
|
@@ -268,24 +229,6 @@ module FlatApi
|
|
|
268
229
|
hash
|
|
269
230
|
end
|
|
270
231
|
|
|
271
|
-
# Outputs non-array value in the form of hash
|
|
272
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
273
|
-
# @param [Object] value Any valid value
|
|
274
|
-
# @return [Hash] Returns the value in the form of hash
|
|
275
|
-
def _to_hash(value)
|
|
276
|
-
if value.is_a?(Array)
|
|
277
|
-
value.compact.map { |v| _to_hash(v) }
|
|
278
|
-
elsif value.is_a?(Hash)
|
|
279
|
-
{}.tap do |hash|
|
|
280
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
281
|
-
end
|
|
282
|
-
elsif value.respond_to? :to_hash
|
|
283
|
-
value.to_hash
|
|
284
|
-
else
|
|
285
|
-
value
|
|
286
|
-
end
|
|
287
|
-
end
|
|
288
|
-
|
|
289
232
|
end
|
|
290
233
|
|
|
291
234
|
end
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -18,10 +18,9 @@ module FlatApi
|
|
|
18
18
|
ORIGINAL = "original".freeze
|
|
19
19
|
ARRANGEMENT = "arrangement".freeze
|
|
20
20
|
OTHER = "other".freeze
|
|
21
|
-
NULL = "null".freeze
|
|
22
21
|
|
|
23
22
|
def self.all_vars
|
|
24
|
-
@all_vars ||= [ORIGINAL, ARRANGEMENT, OTHER
|
|
23
|
+
@all_vars ||= [ORIGINAL, ARRANGEMENT, OTHER].freeze
|
|
25
24
|
end
|
|
26
25
|
|
|
27
26
|
# Builds the enum from string
|