flat_api 0.3.5 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +69 -0
- data/LICENSE +201 -0
- data/README.md +92 -0
- data/lib/flat_api/api/account_api.rb +4 -4
- data/lib/flat_api/api/class_api.rb +281 -63
- data/lib/flat_api/api/collection_api.rb +63 -50
- data/lib/flat_api/api/edu_resources_api.rb +38 -26
- data/lib/flat_api/api/group_api.rb +432 -9
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +307 -35
- data/lib/flat_api/api/score_api.rb +129 -80
- data/lib/flat_api/api/task_api.rb +5 -5
- data/lib/flat_api/api/user_api.rb +45 -14
- data/lib/flat_api/api_client.rb +169 -96
- data/lib/flat_api/api_error.rb +3 -3
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +124 -25
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +13 -80
- data/lib/flat_api/models/app_scopes.rb +6 -4
- data/lib/flat_api/models/assignment.rb +190 -85
- data/lib/flat_api/models/assignment_capabilities.rb +53 -80
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +33 -80
- data/lib/flat_api/models/assignment_copy.rb +5 -6
- data/lib/flat_api/models/assignment_copy_response.rb +187 -82
- data/lib/flat_api/models/assignment_copy_to_class.rb +23 -80
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +23 -80
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +104 -81
- data/lib/flat_api/models/assignment_submission_comment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +23 -80
- data/lib/flat_api/models/assignment_submission_comments.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history.rb +33 -80
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_lti.rb +64 -86
- data/lib/flat_api/models/{assignment_submission_playback_inner.rb → assignment_submission_playback.rb} +36 -83
- data/lib/flat_api/models/assignment_submission_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +25 -81
- data/lib/flat_api/models/assignment_type.rb +5 -4
- data/lib/flat_api/models/assignment_update.rb +218 -87
- data/lib/flat_api/models/class_assignment.rb +219 -82
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +13 -80
- data/lib/flat_api/models/class_assignment_update.rb +237 -94
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_attachment_creation.rb +51 -86
- data/lib/flat_api/models/class_creation.rb +13 -80
- data/lib/flat_api/models/class_details.rb +85 -81
- data/lib/flat_api/models/class_details_canvas.rb +13 -80
- data/lib/flat_api/models/class_details_clever.rb +13 -80
- data/lib/flat_api/models/class_details_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_details_google_drive.rb +13 -80
- data/lib/flat_api/models/class_details_issues.rb +13 -80
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +15 -82
- data/lib/flat_api/models/class_details_lti.rb +28 -85
- data/lib/flat_api/models/class_details_mfc.rb +13 -80
- data/lib/flat_api/models/class_details_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_grade_level.rb +3 -3
- data/lib/flat_api/models/class_roles.rb +3 -3
- data/lib/flat_api/models/class_state.rb +5 -4
- data/lib/flat_api/models/class_update.rb +13 -80
- data/lib/flat_api/models/collection.rb +182 -81
- data/lib/flat_api/models/collection_app.rb +13 -80
- data/lib/flat_api/models/collection_capabilities.rb +63 -80
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +20 -99
- data/lib/flat_api/models/collection_modification.rb +17 -82
- data/lib/flat_api/models/collection_privacy.rb +3 -3
- data/lib/flat_api/models/collection_type.rb +7 -6
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +63 -82
- data/lib/flat_api/models/edu_resource.rb +101 -84
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +27 -84
- data/lib/flat_api/models/edu_resource_copy.rb +23 -80
- data/lib/flat_api/models/edu_resource_creation.rb +96 -86
- data/lib/flat_api/models/edu_resource_folder.rb +39 -84
- data/lib/flat_api/models/edu_resource_lti_link.rb +23 -80
- data/lib/flat_api/models/edu_resource_move.rb +23 -80
- data/lib/flat_api/models/edu_resource_privacy.rb +3 -3
- data/lib/flat_api/models/edu_resource_resource.rb +5 -6
- data/lib/flat_api/models/edu_resource_type.rb +3 -3
- data/lib/flat_api/models/edu_resource_update.rb +101 -86
- data/lib/flat_api/models/edu_resource_use_in_class.rb +23 -80
- data/lib/flat_api/models/flat_error_response.rb +47 -84
- data/lib/flat_api/models/google_classroom_coursework.rb +13 -80
- data/lib/flat_api/models/google_classroom_submission.rb +43 -80
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +14 -94
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +178 -84
- data/lib/flat_api/models/group_type.rb +6 -4
- data/lib/flat_api/models/license_mode.rb +3 -3
- data/lib/flat_api/models/license_sources.rb +3 -3
- data/lib/flat_api/models/lms_name.rb +3 -3
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +29 -84
- data/lib/flat_api/models/lti_credentials_creation.rb +23 -80
- data/lib/flat_api/models/media_attachment.rb +43 -88
- data/lib/flat_api/models/media_score_sharing_mode.rb +3 -3
- data/lib/flat_api/models/microsoft_graph_assignment.rb +99 -88
- data/lib/flat_api/models/microsoft_graph_submission.rb +33 -80
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +54 -81
- data/lib/flat_api/models/organization_invitation_creation.rb +15 -82
- data/lib/flat_api/models/organization_roles.rb +5 -5
- data/lib/flat_api/models/organization_user_access_token_creation.rb +23 -80
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +43 -85
- data/lib/flat_api/models/resource_collaborator_creation.rb +13 -80
- data/lib/flat_api/models/resource_rights.rb +43 -85
- data/lib/flat_api/models/score_comment.rb +122 -80
- data/lib/flat_api/models/score_comment_context.rb +73 -80
- data/lib/flat_api/models/score_comment_creation.rb +24 -81
- data/lib/flat_api/models/score_comment_moderation.rb +13 -80
- data/lib/flat_api/models/score_comment_update.rb +18 -85
- data/lib/flat_api/models/score_comments_counts.rb +28 -85
- data/lib/flat_api/models/score_creation.rb +5 -6
- data/lib/flat_api/models/score_creation_builder_data.rb +24 -88
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +23 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +13 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +24 -81
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +33 -80
- data/lib/flat_api/models/score_creation_common.rb +14 -81
- data/lib/flat_api/models/score_creation_file_import.rb +39 -86
- data/lib/flat_api/models/score_creation_google_drive_import.rb +24 -81
- data/lib/flat_api/models/score_creation_type.rb +4 -5
- data/lib/flat_api/models/score_details.rb +180 -89
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +14 -83
- data/lib/flat_api/models/score_license.rb +4 -5
- data/lib/flat_api/models/score_likes_counts.rb +28 -106
- data/lib/flat_api/models/score_modification.rb +13 -80
- data/lib/flat_api/models/score_plays_counts.rb +28 -85
- data/lib/flat_api/models/score_privacy.rb +3 -3
- data/lib/flat_api/models/score_revision.rb +81 -87
- data/lib/flat_api/models/score_revision_creation.rb +23 -80
- data/lib/flat_api/models/score_revision_statistics.rb +13 -80
- data/lib/flat_api/models/score_source.rb +13 -80
- data/lib/flat_api/models/score_summary.rb +63 -80
- data/lib/flat_api/models/score_track.rb +94 -88
- data/lib/flat_api/models/score_track_creation.rb +13 -80
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +23 -80
- data/lib/flat_api/models/score_track_purpose.rb +3 -3
- data/lib/flat_api/models/score_track_state.rb +3 -3
- data/lib/flat_api/models/score_track_type.rb +3 -3
- data/lib/flat_api/models/score_track_update.rb +25 -81
- data/lib/flat_api/models/score_views_counts.rb +28 -85
- data/lib/flat_api/models/task.rb +62 -87
- data/lib/flat_api/models/task_export_options.rb +13 -80
- data/lib/flat_api/models/task_progress.rb +13 -80
- data/lib/flat_api/models/task_result.rb +13 -80
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +3 -3
- data/lib/flat_api/models/user_admin_update.rb +17 -95
- data/lib/flat_api/models/user_azure_details.rb +13 -80
- data/lib/flat_api/models/user_basics.rb +43 -80
- data/lib/flat_api/models/user_community_profile_links.rb +13 -80
- data/lib/flat_api/models/user_creation.rb +21 -98
- data/lib/flat_api/models/user_details.rb +101 -96
- data/lib/flat_api/models/user_details_admin.rb +72 -85
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +13 -80
- data/lib/flat_api/models/user_public.rb +89 -94
- data/lib/flat_api/models/user_public_summary.rb +58 -81
- data/lib/flat_api/models/user_signin_link.rb +24 -81
- data/lib/flat_api/models/user_signin_link_creation.rb +13 -80
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +4 -4
- data/lib/flat_api.rb +70 -5
- metadata +98 -330
- data/lib/flat_api/models/flat_locales.rb +0 -56
- data/spec/api/account_api_spec.rb +0 -47
- data/spec/api/class_api_spec.rb +0 -422
- data/spec/api/collection_api_spec.rb +0 -158
- data/spec/api/edu_resources_api_spec.rb +0 -181
- data/spec/api/group_api_spec.rb +0 -71
- data/spec/api/organization_api_spec.rb +0 -201
- data/spec/api/score_api_spec.rb +0 -440
- data/spec/api/task_api_spec.rb +0 -47
- data/spec/api/user_api_spec.rb +0 -75
- data/spec/models/api_access_token_spec.rb +0 -66
- data/spec/models/app_scopes_spec.rb +0 -30
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +0 -42
- data/spec/models/assignment_capabilities_spec.rb +0 -60
- data/spec/models/assignment_copy_response_spec.rb +0 -124
- data/spec/models/assignment_copy_spec.rb +0 -32
- data/spec/models/assignment_copy_to_class_spec.rb +0 -48
- data/spec/models/assignment_copy_to_resource_library_spec.rb +0 -42
- data/spec/models/assignment_spec.rb +0 -118
- data/spec/models/assignment_submission_comment_creation_spec.rb +0 -36
- data/spec/models/assignment_submission_comment_spec.rb +0 -72
- data/spec/models/assignment_submission_comments_spec.rb +0 -42
- data/spec/models/assignment_submission_history_attachment_spec.rb +0 -48
- data/spec/models/assignment_submission_history_spec.rb +0 -112
- data/spec/models/assignment_submission_history_state_spec.rb +0 -30
- data/spec/models/assignment_submission_lti_spec.rb +0 -36
- data/spec/models/assignment_submission_playback_inner_spec.rb +0 -42
- data/spec/models/assignment_submission_spec.rb +0 -144
- data/spec/models/assignment_submission_state_spec.rb +0 -30
- data/spec/models/assignment_submission_update_spec.rb +0 -66
- data/spec/models/assignment_type_spec.rb +0 -30
- data/spec/models/assignment_update_spec.rb +0 -100
- data/spec/models/class_assignment_all_of_canvas_spec.rb +0 -42
- data/spec/models/class_assignment_all_of_lti_spec.rb +0 -36
- data/spec/models/class_assignment_all_of_mfc_spec.rb +0 -42
- data/spec/models/class_assignment_spec.rb +0 -216
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +0 -36
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_assignment_update_spec.rb +0 -150
- data/spec/models/class_attachment_creation_spec.rb +0 -76
- data/spec/models/class_creation_spec.rb +0 -64
- data/spec/models/class_details_canvas_spec.rb +0 -42
- data/spec/models/class_details_clever_spec.rb +0 -76
- data/spec/models/class_details_google_classroom_spec.rb +0 -42
- data/spec/models/class_details_google_drive_spec.rb +0 -42
- data/spec/models/class_details_issues_spec.rb +0 -36
- data/spec/models/class_details_issues_sync_inner_spec.rb +0 -52
- data/spec/models/class_details_lti_spec.rb +0 -48
- data/spec/models/class_details_mfc_spec.rb +0 -42
- data/spec/models/class_details_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_details_spec.rb +0 -178
- data/spec/models/class_grade_level_spec.rb +0 -30
- data/spec/models/class_roles_spec.rb +0 -30
- data/spec/models/class_state_spec.rb +0 -30
- data/spec/models/class_update_spec.rb +0 -64
- data/spec/models/collection_app_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -60
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -30
- data/spec/models/collection_spec.rb +0 -114
- data/spec/models/collection_type_spec.rb +0 -30
- data/spec/models/edu_library_spec.rb +0 -62
- data/spec/models/edu_resource_capabilities_spec.rb +0 -48
- data/spec/models/edu_resource_copy_spec.rb +0 -36
- data/spec/models/edu_resource_creation_spec.rb +0 -48
- data/spec/models/edu_resource_folder_spec.rb +0 -36
- data/spec/models/edu_resource_lti_link_spec.rb +0 -36
- data/spec/models/edu_resource_move_spec.rb +0 -36
- data/spec/models/edu_resource_privacy_spec.rb +0 -30
- data/spec/models/edu_resource_resource_spec.rb +0 -32
- data/spec/models/edu_resource_spec.rb +0 -96
- data/spec/models/edu_resource_type_spec.rb +0 -30
- data/spec/models/edu_resource_update_spec.rb +0 -42
- data/spec/models/edu_resource_use_in_class_spec.rb +0 -42
- data/spec/models/flat_error_response_spec.rb +0 -54
- data/spec/models/flat_locales_spec.rb +0 -30
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -48
- data/spec/models/group_details_spec.rb +0 -72
- data/spec/models/group_spec.rb +0 -76
- data/spec/models/group_type_spec.rb +0 -30
- data/spec/models/license_mode_spec.rb +0 -30
- data/spec/models/license_sources_spec.rb +0 -30
- data/spec/models/lms_name_spec.rb +0 -30
- data/spec/models/lti_credentials_creation_spec.rb +0 -42
- data/spec/models/lti_credentials_spec.rb +0 -84
- data/spec/models/media_attachment_spec.rb +0 -166
- data/spec/models/media_score_sharing_mode_spec.rb +0 -30
- data/spec/models/microsoft_graph_assignment_spec.rb +0 -54
- data/spec/models/microsoft_graph_submission_spec.rb +0 -42
- data/spec/models/organization_invitation_creation_spec.rb +0 -46
- data/spec/models/organization_invitation_spec.rb +0 -84
- data/spec/models/organization_roles_spec.rb +0 -30
- data/spec/models/organization_user_access_token_creation_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -72
- data/spec/models/resource_collaborator_spec.rb +0 -112
- data/spec/models/resource_rights_spec.rb +0 -64
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -66
- data/spec/models/score_comment_moderation_spec.rb +0 -46
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -54
- data/spec/models/score_comments_counts_spec.rb +0 -54
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +0 -82
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +0 -60
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +0 -66
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +0 -42
- data/spec/models/score_creation_builder_data_spec.rb +0 -60
- data/spec/models/score_creation_common_spec.rb +0 -54
- data/spec/models/score_creation_file_import_spec.rb +0 -76
- data/spec/models/score_creation_google_drive_import_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -32
- data/spec/models/score_creation_type_spec.rb +0 -30
- data/spec/models/score_details_spec.rb +0 -240
- data/spec/models/score_fork_spec.rb +0 -48
- data/spec/models/score_license_spec.rb +0 -30
- data/spec/models/score_likes_counts_spec.rb +0 -48
- data/spec/models/score_modification_spec.rb +0 -102
- data/spec/models/score_plays_counts_spec.rb +0 -48
- data/spec/models/score_privacy_spec.rb +0 -30
- data/spec/models/score_revision_creation_spec.rb +0 -58
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -54
- data/spec/models/score_source_spec.rb +0 -36
- data/spec/models/score_summary_spec.rb +0 -66
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -52
- data/spec/models/score_track_purpose_spec.rb +0 -30
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -30
- data/spec/models/score_track_type_spec.rb +0 -30
- data/spec/models/score_track_update_spec.rb +0 -54
- data/spec/models/score_views_counts_spec.rb +0 -48
- data/spec/models/task_export_options_spec.rb +0 -36
- data/spec/models/task_progress_spec.rb +0 -42
- data/spec/models/task_result_spec.rb +0 -42
- data/spec/models/task_spec.rb +0 -100
- data/spec/models/tutteo_product_spec.rb +0 -30
- data/spec/models/user_admin_update_spec.rb +0 -66
- data/spec/models/user_azure_details_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -94
- data/spec/models/user_community_profile_links_spec.rb +0 -66
- data/spec/models/user_creation_spec.rb +0 -76
- data/spec/models/user_details_admin_all_of_license_spec.rb +0 -60
- data/spec/models/user_details_admin_spec.rb +0 -142
- data/spec/models/user_details_spec.rb +0 -214
- data/spec/models/user_public_spec.rb +0 -178
- data/spec/models/user_public_summary_spec.rb +0 -118
- data/spec/models/user_signin_link_creation_spec.rb +0 -36
- data/spec/models/user_signin_link_spec.rb +0 -42
- data/spec/spec_helper.rb +0 -111
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# The score and all its details
|
|
18
|
-
class ScoreDetails
|
|
18
|
+
class ScoreDetails < ApiModelBase
|
|
19
19
|
# The unique identifier of the score
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -32,6 +32,9 @@ module FlatApi
|
|
|
32
32
|
# The url where the score can be viewed in a web browser
|
|
33
33
|
attr_accessor :html_url
|
|
34
34
|
|
|
35
|
+
# The url where the score can be edited in a web browser
|
|
36
|
+
attr_accessor :edit_html_url
|
|
37
|
+
|
|
35
38
|
# Subtitle of the score
|
|
36
39
|
attr_accessor :subtitle
|
|
37
40
|
|
|
@@ -83,6 +86,9 @@ module FlatApi
|
|
|
83
86
|
# The date when the score was published on Flat
|
|
84
87
|
attr_accessor :publication_date
|
|
85
88
|
|
|
89
|
+
# The date when the score will be definitively deleted. This date can be in the past if the score will be deleted at the next deletion batch, in this case you can display something like \"Deleted shortly\". Schedule: * For all paying users, the scores will be definitively deleted after 90 days. * For free users, the scores are no longer available after 24 hours, an can be restored with a paying account up to 90 days.
|
|
90
|
+
attr_accessor :scheduled_deletion_date
|
|
91
|
+
|
|
86
92
|
# The date when the score was highlighted (featured) on our community
|
|
87
93
|
attr_accessor :highlighted_date
|
|
88
94
|
|
|
@@ -95,6 +101,9 @@ module FlatApi
|
|
|
95
101
|
# An array of the instrument identifiers used in the last version of the score. This is mainly used to display a list of the instruments in the Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`.
|
|
96
102
|
attr_accessor :instruments
|
|
97
103
|
|
|
104
|
+
# An array of the instrument names used in the last version of the score. This list is localized and ready-to-display and will match the indexes from the `instruments` list.
|
|
105
|
+
attr_accessor :instruments_names
|
|
106
|
+
|
|
98
107
|
# An array of the audio samples identifiers used the different score parts. The format of the strings is `{instrument-group}.{sample-id}`.
|
|
99
108
|
attr_accessor :samples
|
|
100
109
|
|
|
@@ -112,6 +121,8 @@ module FlatApi
|
|
|
112
121
|
# The List of parent collections, which includes all the collections this score is included. Please note that you might not have access to all of them.
|
|
113
122
|
attr_accessor :collections
|
|
114
123
|
|
|
124
|
+
attr_accessor :me
|
|
125
|
+
|
|
115
126
|
class EnumAttributeValidator
|
|
116
127
|
attr_reader :datatype
|
|
117
128
|
attr_reader :allowable_values
|
|
@@ -143,6 +154,7 @@ module FlatApi
|
|
|
143
154
|
:'privacy' => :'privacy',
|
|
144
155
|
:'user' => :'user',
|
|
145
156
|
:'html_url' => :'htmlUrl',
|
|
157
|
+
:'edit_html_url' => :'editHtmlUrl',
|
|
146
158
|
:'subtitle' => :'subtitle',
|
|
147
159
|
:'lyricist' => :'lyricist',
|
|
148
160
|
:'arranger' => :'arranger',
|
|
@@ -161,23 +173,31 @@ module FlatApi
|
|
|
161
173
|
:'creation_date' => :'creationDate',
|
|
162
174
|
:'modification_date' => :'modificationDate',
|
|
163
175
|
:'publication_date' => :'publicationDate',
|
|
176
|
+
:'scheduled_deletion_date' => :'scheduledDeletionDate',
|
|
164
177
|
:'highlighted_date' => :'highlightedDate',
|
|
165
178
|
:'organization' => :'organization',
|
|
166
179
|
:'parent_score' => :'parentScore',
|
|
167
180
|
:'instruments' => :'instruments',
|
|
181
|
+
:'instruments_names' => :'instrumentsNames',
|
|
168
182
|
:'samples' => :'samples',
|
|
169
183
|
:'google_drive_file_id' => :'googleDriveFileId',
|
|
170
184
|
:'likes' => :'likes',
|
|
171
185
|
:'comments' => :'comments',
|
|
172
186
|
:'views' => :'views',
|
|
173
187
|
:'plays' => :'plays',
|
|
174
|
-
:'collections' => :'collections'
|
|
188
|
+
:'collections' => :'collections',
|
|
189
|
+
:'me' => :'me'
|
|
175
190
|
}
|
|
176
191
|
end
|
|
177
192
|
|
|
193
|
+
# Returns attribute mapping this model knows about
|
|
194
|
+
def self.acceptable_attribute_map
|
|
195
|
+
attribute_map
|
|
196
|
+
end
|
|
197
|
+
|
|
178
198
|
# Returns all the JSON keys this model knows about
|
|
179
199
|
def self.acceptable_attributes
|
|
180
|
-
|
|
200
|
+
acceptable_attribute_map.values
|
|
181
201
|
end
|
|
182
202
|
|
|
183
203
|
# Attribute type mapping.
|
|
@@ -189,6 +209,7 @@ module FlatApi
|
|
|
189
209
|
:'privacy' => :'ScorePrivacy',
|
|
190
210
|
:'user' => :'UserPublic',
|
|
191
211
|
:'html_url' => :'String',
|
|
212
|
+
:'edit_html_url' => :'String',
|
|
192
213
|
:'subtitle' => :'String',
|
|
193
214
|
:'lyricist' => :'String',
|
|
194
215
|
:'arranger' => :'String',
|
|
@@ -207,17 +228,20 @@ module FlatApi
|
|
|
207
228
|
:'creation_date' => :'Time',
|
|
208
229
|
:'modification_date' => :'Time',
|
|
209
230
|
:'publication_date' => :'Time',
|
|
231
|
+
:'scheduled_deletion_date' => :'Time',
|
|
210
232
|
:'highlighted_date' => :'Time',
|
|
211
233
|
:'organization' => :'String',
|
|
212
234
|
:'parent_score' => :'String',
|
|
213
235
|
:'instruments' => :'Array<String>',
|
|
236
|
+
:'instruments_names' => :'Array<String>',
|
|
214
237
|
:'samples' => :'Array<String>',
|
|
215
238
|
:'google_drive_file_id' => :'String',
|
|
216
239
|
:'likes' => :'ScoreLikesCounts',
|
|
217
240
|
:'comments' => :'ScoreCommentsCounts',
|
|
218
241
|
:'views' => :'ScoreViewsCounts',
|
|
219
242
|
:'plays' => :'ScorePlaysCounts',
|
|
220
|
-
:'collections' => :'Array<String>'
|
|
243
|
+
:'collections' => :'Array<String>',
|
|
244
|
+
:'me' => :'ScoreDetailsAllOfMe'
|
|
221
245
|
}
|
|
222
246
|
end
|
|
223
247
|
|
|
@@ -244,9 +268,10 @@ module FlatApi
|
|
|
244
268
|
end
|
|
245
269
|
|
|
246
270
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
271
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
247
272
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
248
|
-
if (!
|
|
249
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreDetails`. Please check the name to make sure it's valid. List of attributes: " +
|
|
273
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
274
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
250
275
|
end
|
|
251
276
|
h[k.to_sym] = v
|
|
252
277
|
}
|
|
@@ -285,6 +310,12 @@ module FlatApi
|
|
|
285
310
|
self.html_url = nil
|
|
286
311
|
end
|
|
287
312
|
|
|
313
|
+
if attributes.key?(:'edit_html_url')
|
|
314
|
+
self.edit_html_url = attributes[:'edit_html_url']
|
|
315
|
+
else
|
|
316
|
+
self.edit_html_url = nil
|
|
317
|
+
end
|
|
318
|
+
|
|
288
319
|
if attributes.key?(:'subtitle')
|
|
289
320
|
self.subtitle = attributes[:'subtitle']
|
|
290
321
|
end
|
|
@@ -341,8 +372,6 @@ module FlatApi
|
|
|
341
372
|
|
|
342
373
|
if attributes.key?(:'rights')
|
|
343
374
|
self.rights = attributes[:'rights']
|
|
344
|
-
else
|
|
345
|
-
self.rights = nil
|
|
346
375
|
end
|
|
347
376
|
|
|
348
377
|
if attributes.key?(:'collaborators')
|
|
@@ -367,6 +396,10 @@ module FlatApi
|
|
|
367
396
|
self.publication_date = attributes[:'publication_date']
|
|
368
397
|
end
|
|
369
398
|
|
|
399
|
+
if attributes.key?(:'scheduled_deletion_date')
|
|
400
|
+
self.scheduled_deletion_date = attributes[:'scheduled_deletion_date']
|
|
401
|
+
end
|
|
402
|
+
|
|
370
403
|
if attributes.key?(:'highlighted_date')
|
|
371
404
|
self.highlighted_date = attributes[:'highlighted_date']
|
|
372
405
|
end
|
|
@@ -387,6 +420,14 @@ module FlatApi
|
|
|
387
420
|
self.instruments = nil
|
|
388
421
|
end
|
|
389
422
|
|
|
423
|
+
if attributes.key?(:'instruments_names')
|
|
424
|
+
if (value = attributes[:'instruments_names']).is_a?(Array)
|
|
425
|
+
self.instruments_names = value
|
|
426
|
+
end
|
|
427
|
+
else
|
|
428
|
+
self.instruments_names = nil
|
|
429
|
+
end
|
|
430
|
+
|
|
390
431
|
if attributes.key?(:'samples')
|
|
391
432
|
if (value = attributes[:'samples']).is_a?(Array)
|
|
392
433
|
self.samples = value
|
|
@@ -420,6 +461,10 @@ module FlatApi
|
|
|
420
461
|
self.collections = value
|
|
421
462
|
end
|
|
422
463
|
end
|
|
464
|
+
|
|
465
|
+
if attributes.key?(:'me')
|
|
466
|
+
self.me = attributes[:'me']
|
|
467
|
+
end
|
|
423
468
|
end
|
|
424
469
|
|
|
425
470
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -447,8 +492,8 @@ module FlatApi
|
|
|
447
492
|
invalid_properties.push('invalid value for "html_url", html_url cannot be nil.')
|
|
448
493
|
end
|
|
449
494
|
|
|
450
|
-
if @
|
|
451
|
-
invalid_properties.push('invalid value for "
|
|
495
|
+
if @edit_html_url.nil?
|
|
496
|
+
invalid_properties.push('invalid value for "edit_html_url", edit_html_url cannot be nil.')
|
|
452
497
|
end
|
|
453
498
|
|
|
454
499
|
if @collaborators.nil?
|
|
@@ -463,6 +508,10 @@ module FlatApi
|
|
|
463
508
|
invalid_properties.push('invalid value for "instruments", instruments cannot be nil.')
|
|
464
509
|
end
|
|
465
510
|
|
|
511
|
+
if @instruments_names.nil?
|
|
512
|
+
invalid_properties.push('invalid value for "instruments_names", instruments_names cannot be nil.')
|
|
513
|
+
end
|
|
514
|
+
|
|
466
515
|
if @samples.nil?
|
|
467
516
|
invalid_properties.push('invalid value for "samples", samples cannot be nil.')
|
|
468
517
|
end
|
|
@@ -479,14 +528,125 @@ module FlatApi
|
|
|
479
528
|
return false if @privacy.nil?
|
|
480
529
|
return false if @user.nil?
|
|
481
530
|
return false if @html_url.nil?
|
|
482
|
-
return false if @
|
|
531
|
+
return false if @edit_html_url.nil?
|
|
483
532
|
return false if @collaborators.nil?
|
|
484
533
|
return false if @creation_date.nil?
|
|
485
534
|
return false if @instruments.nil?
|
|
535
|
+
return false if @instruments_names.nil?
|
|
486
536
|
return false if @samples.nil?
|
|
487
537
|
true
|
|
488
538
|
end
|
|
489
539
|
|
|
540
|
+
# Custom attribute writer method with validation
|
|
541
|
+
# @param [Object] id Value to be assigned
|
|
542
|
+
def id=(id)
|
|
543
|
+
if id.nil?
|
|
544
|
+
fail ArgumentError, 'id cannot be nil'
|
|
545
|
+
end
|
|
546
|
+
|
|
547
|
+
@id = id
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
# Custom attribute writer method with validation
|
|
551
|
+
# @param [Object] title Value to be assigned
|
|
552
|
+
def title=(title)
|
|
553
|
+
if title.nil?
|
|
554
|
+
fail ArgumentError, 'title cannot be nil'
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
@title = title
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
# Custom attribute writer method with validation
|
|
561
|
+
# @param [Object] privacy Value to be assigned
|
|
562
|
+
def privacy=(privacy)
|
|
563
|
+
if privacy.nil?
|
|
564
|
+
fail ArgumentError, 'privacy cannot be nil'
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
@privacy = privacy
|
|
568
|
+
end
|
|
569
|
+
|
|
570
|
+
# Custom attribute writer method with validation
|
|
571
|
+
# @param [Object] user Value to be assigned
|
|
572
|
+
def user=(user)
|
|
573
|
+
if user.nil?
|
|
574
|
+
fail ArgumentError, 'user cannot be nil'
|
|
575
|
+
end
|
|
576
|
+
|
|
577
|
+
@user = user
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
# Custom attribute writer method with validation
|
|
581
|
+
# @param [Object] html_url Value to be assigned
|
|
582
|
+
def html_url=(html_url)
|
|
583
|
+
if html_url.nil?
|
|
584
|
+
fail ArgumentError, 'html_url cannot be nil'
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
@html_url = html_url
|
|
588
|
+
end
|
|
589
|
+
|
|
590
|
+
# Custom attribute writer method with validation
|
|
591
|
+
# @param [Object] edit_html_url Value to be assigned
|
|
592
|
+
def edit_html_url=(edit_html_url)
|
|
593
|
+
if edit_html_url.nil?
|
|
594
|
+
fail ArgumentError, 'edit_html_url cannot be nil'
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
@edit_html_url = edit_html_url
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Custom attribute writer method with validation
|
|
601
|
+
# @param [Object] collaborators Value to be assigned
|
|
602
|
+
def collaborators=(collaborators)
|
|
603
|
+
if collaborators.nil?
|
|
604
|
+
fail ArgumentError, 'collaborators cannot be nil'
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
@collaborators = collaborators
|
|
608
|
+
end
|
|
609
|
+
|
|
610
|
+
# Custom attribute writer method with validation
|
|
611
|
+
# @param [Object] creation_date Value to be assigned
|
|
612
|
+
def creation_date=(creation_date)
|
|
613
|
+
if creation_date.nil?
|
|
614
|
+
fail ArgumentError, 'creation_date cannot be nil'
|
|
615
|
+
end
|
|
616
|
+
|
|
617
|
+
@creation_date = creation_date
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Custom attribute writer method with validation
|
|
621
|
+
# @param [Object] instruments Value to be assigned
|
|
622
|
+
def instruments=(instruments)
|
|
623
|
+
if instruments.nil?
|
|
624
|
+
fail ArgumentError, 'instruments cannot be nil'
|
|
625
|
+
end
|
|
626
|
+
|
|
627
|
+
@instruments = instruments
|
|
628
|
+
end
|
|
629
|
+
|
|
630
|
+
# Custom attribute writer method with validation
|
|
631
|
+
# @param [Object] instruments_names Value to be assigned
|
|
632
|
+
def instruments_names=(instruments_names)
|
|
633
|
+
if instruments_names.nil?
|
|
634
|
+
fail ArgumentError, 'instruments_names cannot be nil'
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
@instruments_names = instruments_names
|
|
638
|
+
end
|
|
639
|
+
|
|
640
|
+
# Custom attribute writer method with validation
|
|
641
|
+
# @param [Object] samples Value to be assigned
|
|
642
|
+
def samples=(samples)
|
|
643
|
+
if samples.nil?
|
|
644
|
+
fail ArgumentError, 'samples cannot be nil'
|
|
645
|
+
end
|
|
646
|
+
|
|
647
|
+
@samples = samples
|
|
648
|
+
end
|
|
649
|
+
|
|
490
650
|
# Checks equality by comparing each attribute.
|
|
491
651
|
# @param [Object] Object to be compared
|
|
492
652
|
def ==(o)
|
|
@@ -498,6 +658,7 @@ module FlatApi
|
|
|
498
658
|
privacy == o.privacy &&
|
|
499
659
|
user == o.user &&
|
|
500
660
|
html_url == o.html_url &&
|
|
661
|
+
edit_html_url == o.edit_html_url &&
|
|
501
662
|
subtitle == o.subtitle &&
|
|
502
663
|
lyricist == o.lyricist &&
|
|
503
664
|
arranger == o.arranger &&
|
|
@@ -516,17 +677,20 @@ module FlatApi
|
|
|
516
677
|
creation_date == o.creation_date &&
|
|
517
678
|
modification_date == o.modification_date &&
|
|
518
679
|
publication_date == o.publication_date &&
|
|
680
|
+
scheduled_deletion_date == o.scheduled_deletion_date &&
|
|
519
681
|
highlighted_date == o.highlighted_date &&
|
|
520
682
|
organization == o.organization &&
|
|
521
683
|
parent_score == o.parent_score &&
|
|
522
684
|
instruments == o.instruments &&
|
|
685
|
+
instruments_names == o.instruments_names &&
|
|
523
686
|
samples == o.samples &&
|
|
524
687
|
google_drive_file_id == o.google_drive_file_id &&
|
|
525
688
|
likes == o.likes &&
|
|
526
689
|
comments == o.comments &&
|
|
527
690
|
views == o.views &&
|
|
528
691
|
plays == o.plays &&
|
|
529
|
-
collections == o.collections
|
|
692
|
+
collections == o.collections &&
|
|
693
|
+
me == o.me
|
|
530
694
|
end
|
|
531
695
|
|
|
532
696
|
# @see the `==` method
|
|
@@ -538,7 +702,7 @@ module FlatApi
|
|
|
538
702
|
# Calculates hash code according to all attributes.
|
|
539
703
|
# @return [Integer] Hash code
|
|
540
704
|
def hash
|
|
541
|
-
[id, sharing_key, title, privacy, user, html_url, subtitle, lyricist, arranger, composer, description, tags, creation_type, license, license_text, duration_time, number_measures, main_tempo_qpm, main_key_signature, rights, collaborators, creation_date, modification_date, publication_date, highlighted_date, organization, parent_score, instruments, samples, google_drive_file_id, likes, comments, views, plays, collections].hash
|
|
705
|
+
[id, sharing_key, title, privacy, user, html_url, edit_html_url, subtitle, lyricist, arranger, composer, description, tags, creation_type, license, license_text, duration_time, number_measures, main_tempo_qpm, main_key_signature, rights, collaborators, creation_date, modification_date, publication_date, scheduled_deletion_date, highlighted_date, organization, parent_score, instruments, instruments_names, samples, google_drive_file_id, likes, comments, views, plays, collections, me].hash
|
|
542
706
|
end
|
|
543
707
|
|
|
544
708
|
# Builds the object from hash
|
|
@@ -564,61 +728,6 @@ module FlatApi
|
|
|
564
728
|
new(transformed_hash)
|
|
565
729
|
end
|
|
566
730
|
|
|
567
|
-
# Deserializes the data based on type
|
|
568
|
-
# @param string type Data type
|
|
569
|
-
# @param string value Value to be deserialized
|
|
570
|
-
# @return [Object] Deserialized data
|
|
571
|
-
def self._deserialize(type, value)
|
|
572
|
-
case type.to_sym
|
|
573
|
-
when :Time
|
|
574
|
-
Time.parse(value)
|
|
575
|
-
when :Date
|
|
576
|
-
Date.parse(value)
|
|
577
|
-
when :String
|
|
578
|
-
value.to_s
|
|
579
|
-
when :Integer
|
|
580
|
-
value.to_i
|
|
581
|
-
when :Float
|
|
582
|
-
value.to_f
|
|
583
|
-
when :Boolean
|
|
584
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
585
|
-
true
|
|
586
|
-
else
|
|
587
|
-
false
|
|
588
|
-
end
|
|
589
|
-
when :Object
|
|
590
|
-
# generic object (usually a Hash), return directly
|
|
591
|
-
value
|
|
592
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
593
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
594
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
595
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
596
|
-
k_type = Regexp.last_match[:k_type]
|
|
597
|
-
v_type = Regexp.last_match[:v_type]
|
|
598
|
-
{}.tap do |hash|
|
|
599
|
-
value.each do |k, v|
|
|
600
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
601
|
-
end
|
|
602
|
-
end
|
|
603
|
-
else # model
|
|
604
|
-
# models (e.g. Pet) or oneOf
|
|
605
|
-
klass = FlatApi.const_get(type)
|
|
606
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
607
|
-
end
|
|
608
|
-
end
|
|
609
|
-
|
|
610
|
-
# Returns the string representation of the object
|
|
611
|
-
# @return [String] String presentation of the object
|
|
612
|
-
def to_s
|
|
613
|
-
to_hash.to_s
|
|
614
|
-
end
|
|
615
|
-
|
|
616
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
617
|
-
# @return [Hash] Returns the object in the form of hash
|
|
618
|
-
def to_body
|
|
619
|
-
to_hash
|
|
620
|
-
end
|
|
621
|
-
|
|
622
731
|
# Returns the object in the form of hash
|
|
623
732
|
# @return [Hash] Returns the object in the form of hash
|
|
624
733
|
def to_hash
|
|
@@ -635,24 +744,6 @@ module FlatApi
|
|
|
635
744
|
hash
|
|
636
745
|
end
|
|
637
746
|
|
|
638
|
-
# Outputs non-array value in the form of hash
|
|
639
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
640
|
-
# @param [Object] value Any valid value
|
|
641
|
-
# @return [Hash] Returns the value in the form of hash
|
|
642
|
-
def _to_hash(value)
|
|
643
|
-
if value.is_a?(Array)
|
|
644
|
-
value.compact.map { |v| _to_hash(v) }
|
|
645
|
-
elsif value.is_a?(Hash)
|
|
646
|
-
{}.tap do |hash|
|
|
647
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
648
|
-
end
|
|
649
|
-
elsif value.respond_to? :to_hash
|
|
650
|
-
value.to_hash
|
|
651
|
-
else
|
|
652
|
-
value
|
|
653
|
-
end
|
|
654
|
-
end
|
|
655
|
-
|
|
656
747
|
end
|
|
657
748
|
|
|
658
749
|
end
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Flat API
|
|
3
|
+
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
|
+
Contact: developers@flat.io
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module FlatApi
|
|
17
|
+
# Information about the authenticated user and this score
|
|
18
|
+
class ScoreDetailsAllOfMe < ApiModelBase
|
|
19
|
+
# True if the current user likes this score
|
|
20
|
+
attr_accessor :is_liked
|
|
21
|
+
|
|
22
|
+
# True if the score is stored in one of the user's collections
|
|
23
|
+
attr_accessor :is_in_library
|
|
24
|
+
|
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
|
+
def self.attribute_map
|
|
27
|
+
{
|
|
28
|
+
:'is_liked' => :'isLiked',
|
|
29
|
+
:'is_in_library' => :'isInLibrary'
|
|
30
|
+
}
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Returns attribute mapping this model knows about
|
|
34
|
+
def self.acceptable_attribute_map
|
|
35
|
+
attribute_map
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Returns all the JSON keys this model knows about
|
|
39
|
+
def self.acceptable_attributes
|
|
40
|
+
acceptable_attribute_map.values
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Attribute type mapping.
|
|
44
|
+
def self.openapi_types
|
|
45
|
+
{
|
|
46
|
+
:'is_liked' => :'Boolean',
|
|
47
|
+
:'is_in_library' => :'Boolean'
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# List of attributes with nullable: true
|
|
52
|
+
def self.openapi_nullable
|
|
53
|
+
Set.new([
|
|
54
|
+
])
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Initializes the object
|
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
|
+
def initialize(attributes = {})
|
|
60
|
+
if (!attributes.is_a?(Hash))
|
|
61
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreDetailsAllOfMe` initialize method"
|
|
62
|
+
end
|
|
63
|
+
|
|
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
|
|
66
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
67
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreDetailsAllOfMe`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
69
|
+
end
|
|
70
|
+
h[k.to_sym] = v
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if attributes.key?(:'is_liked')
|
|
74
|
+
self.is_liked = attributes[:'is_liked']
|
|
75
|
+
else
|
|
76
|
+
self.is_liked = nil
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if attributes.key?(:'is_in_library')
|
|
80
|
+
self.is_in_library = attributes[:'is_in_library']
|
|
81
|
+
else
|
|
82
|
+
self.is_in_library = nil
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
87
|
+
# @return Array for valid properties with the reasons
|
|
88
|
+
def list_invalid_properties
|
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
90
|
+
invalid_properties = Array.new
|
|
91
|
+
if @is_liked.nil?
|
|
92
|
+
invalid_properties.push('invalid value for "is_liked", is_liked cannot be nil.')
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
if @is_in_library.nil?
|
|
96
|
+
invalid_properties.push('invalid value for "is_in_library", is_in_library cannot be nil.')
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
invalid_properties
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Check to see if the all the properties in the model are valid
|
|
103
|
+
# @return true if the model is valid
|
|
104
|
+
def valid?
|
|
105
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
106
|
+
return false if @is_liked.nil?
|
|
107
|
+
return false if @is_in_library.nil?
|
|
108
|
+
true
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Custom attribute writer method with validation
|
|
112
|
+
# @param [Object] is_liked Value to be assigned
|
|
113
|
+
def is_liked=(is_liked)
|
|
114
|
+
if is_liked.nil?
|
|
115
|
+
fail ArgumentError, 'is_liked cannot be nil'
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
@is_liked = is_liked
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Custom attribute writer method with validation
|
|
122
|
+
# @param [Object] is_in_library Value to be assigned
|
|
123
|
+
def is_in_library=(is_in_library)
|
|
124
|
+
if is_in_library.nil?
|
|
125
|
+
fail ArgumentError, 'is_in_library cannot be nil'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
@is_in_library = is_in_library
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Checks equality by comparing each attribute.
|
|
132
|
+
# @param [Object] Object to be compared
|
|
133
|
+
def ==(o)
|
|
134
|
+
return true if self.equal?(o)
|
|
135
|
+
self.class == o.class &&
|
|
136
|
+
is_liked == o.is_liked &&
|
|
137
|
+
is_in_library == o.is_in_library
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# @see the `==` method
|
|
141
|
+
# @param [Object] Object to be compared
|
|
142
|
+
def eql?(o)
|
|
143
|
+
self == o
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Calculates hash code according to all attributes.
|
|
147
|
+
# @return [Integer] Hash code
|
|
148
|
+
def hash
|
|
149
|
+
[is_liked, is_in_library].hash
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Builds the object from hash
|
|
153
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
154
|
+
# @return [Object] Returns the model itself
|
|
155
|
+
def self.build_from_hash(attributes)
|
|
156
|
+
return nil unless attributes.is_a?(Hash)
|
|
157
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
158
|
+
transformed_hash = {}
|
|
159
|
+
openapi_types.each_pair do |key, type|
|
|
160
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
161
|
+
transformed_hash["#{key}"] = nil
|
|
162
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
163
|
+
# check to ensure the input is an array given that the attribute
|
|
164
|
+
# is documented as an array but the input is not
|
|
165
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
166
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
167
|
+
end
|
|
168
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
169
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
new(transformed_hash)
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Returns the object in the form of hash
|
|
176
|
+
# @return [Hash] Returns the object in the form of hash
|
|
177
|
+
def to_hash
|
|
178
|
+
hash = {}
|
|
179
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
180
|
+
value = self.send(attr)
|
|
181
|
+
if value.nil?
|
|
182
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
183
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
hash[param] = _to_hash(value)
|
|
187
|
+
end
|
|
188
|
+
hash
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
end
|