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
|
# Details of an invitation to join an organization
|
|
18
|
-
class OrganizationInvitation
|
|
18
|
+
class OrganizationInvitation < ApiModelBase
|
|
19
19
|
# The invitation unique identifier
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -36,6 +36,9 @@ module FlatApi
|
|
|
36
36
|
# The unique identifier of the User who created this invitation
|
|
37
37
|
attr_accessor :invited_by
|
|
38
38
|
|
|
39
|
+
# URL to join the organization using this invitation
|
|
40
|
+
attr_accessor :html_url
|
|
41
|
+
|
|
39
42
|
# If true, the invitation can be used multiple times. If false, the invitation can only be used once.
|
|
40
43
|
attr_accessor :allow_multiple_use
|
|
41
44
|
|
|
@@ -74,14 +77,20 @@ module FlatApi
|
|
|
74
77
|
:'custom_code' => :'customCode',
|
|
75
78
|
:'email' => :'email',
|
|
76
79
|
:'invited_by' => :'invitedBy',
|
|
80
|
+
:'html_url' => :'htmlUrl',
|
|
77
81
|
:'allow_multiple_use' => :'allowMultipleUse',
|
|
78
82
|
:'used_by' => :'usedBy'
|
|
79
83
|
}
|
|
80
84
|
end
|
|
81
85
|
|
|
86
|
+
# Returns attribute mapping this model knows about
|
|
87
|
+
def self.acceptable_attribute_map
|
|
88
|
+
attribute_map
|
|
89
|
+
end
|
|
90
|
+
|
|
82
91
|
# Returns all the JSON keys this model knows about
|
|
83
92
|
def self.acceptable_attributes
|
|
84
|
-
|
|
93
|
+
acceptable_attribute_map.values
|
|
85
94
|
end
|
|
86
95
|
|
|
87
96
|
# Attribute type mapping.
|
|
@@ -94,6 +103,7 @@ module FlatApi
|
|
|
94
103
|
:'custom_code' => :'String',
|
|
95
104
|
:'email' => :'String',
|
|
96
105
|
:'invited_by' => :'String',
|
|
106
|
+
:'html_url' => :'String',
|
|
97
107
|
:'allow_multiple_use' => :'Boolean',
|
|
98
108
|
:'used_by' => :'Array<String>'
|
|
99
109
|
}
|
|
@@ -114,9 +124,10 @@ module FlatApi
|
|
|
114
124
|
end
|
|
115
125
|
|
|
116
126
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
127
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
117
128
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
118
|
-
if (!
|
|
119
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationInvitation`. Please check the name to make sure it's valid. List of attributes: " +
|
|
129
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
130
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationInvitation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
120
131
|
end
|
|
121
132
|
h[k.to_sym] = v
|
|
122
133
|
}
|
|
@@ -155,6 +166,10 @@ module FlatApi
|
|
|
155
166
|
self.invited_by = attributes[:'invited_by']
|
|
156
167
|
end
|
|
157
168
|
|
|
169
|
+
if attributes.key?(:'html_url')
|
|
170
|
+
self.html_url = attributes[:'html_url']
|
|
171
|
+
end
|
|
172
|
+
|
|
158
173
|
if attributes.key?(:'allow_multiple_use')
|
|
159
174
|
self.allow_multiple_use = attributes[:'allow_multiple_use']
|
|
160
175
|
else
|
|
@@ -198,6 +213,36 @@ module FlatApi
|
|
|
198
213
|
true
|
|
199
214
|
end
|
|
200
215
|
|
|
216
|
+
# Custom attribute writer method with validation
|
|
217
|
+
# @param [Object] organization Value to be assigned
|
|
218
|
+
def organization=(organization)
|
|
219
|
+
if organization.nil?
|
|
220
|
+
fail ArgumentError, 'organization cannot be nil'
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
@organization = organization
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
# Custom attribute writer method with validation
|
|
227
|
+
# @param [Object] organization_role Value to be assigned
|
|
228
|
+
def organization_role=(organization_role)
|
|
229
|
+
if organization_role.nil?
|
|
230
|
+
fail ArgumentError, 'organization_role cannot be nil'
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
@organization_role = organization_role
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Custom attribute writer method with validation
|
|
237
|
+
# @param [Object] allow_multiple_use Value to be assigned
|
|
238
|
+
def allow_multiple_use=(allow_multiple_use)
|
|
239
|
+
if allow_multiple_use.nil?
|
|
240
|
+
fail ArgumentError, 'allow_multiple_use cannot be nil'
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
@allow_multiple_use = allow_multiple_use
|
|
244
|
+
end
|
|
245
|
+
|
|
201
246
|
# Checks equality by comparing each attribute.
|
|
202
247
|
# @param [Object] Object to be compared
|
|
203
248
|
def ==(o)
|
|
@@ -210,6 +255,7 @@ module FlatApi
|
|
|
210
255
|
custom_code == o.custom_code &&
|
|
211
256
|
email == o.email &&
|
|
212
257
|
invited_by == o.invited_by &&
|
|
258
|
+
html_url == o.html_url &&
|
|
213
259
|
allow_multiple_use == o.allow_multiple_use &&
|
|
214
260
|
used_by == o.used_by
|
|
215
261
|
end
|
|
@@ -223,7 +269,7 @@ module FlatApi
|
|
|
223
269
|
# Calculates hash code according to all attributes.
|
|
224
270
|
# @return [Integer] Hash code
|
|
225
271
|
def hash
|
|
226
|
-
[id, creation_date, organization, organization_role, custom_code, email, invited_by, allow_multiple_use, used_by].hash
|
|
272
|
+
[id, creation_date, organization, organization_role, custom_code, email, invited_by, html_url, allow_multiple_use, used_by].hash
|
|
227
273
|
end
|
|
228
274
|
|
|
229
275
|
# Builds the object from hash
|
|
@@ -249,61 +295,6 @@ module FlatApi
|
|
|
249
295
|
new(transformed_hash)
|
|
250
296
|
end
|
|
251
297
|
|
|
252
|
-
# Deserializes the data based on type
|
|
253
|
-
# @param string type Data type
|
|
254
|
-
# @param string value Value to be deserialized
|
|
255
|
-
# @return [Object] Deserialized data
|
|
256
|
-
def self._deserialize(type, value)
|
|
257
|
-
case type.to_sym
|
|
258
|
-
when :Time
|
|
259
|
-
Time.parse(value)
|
|
260
|
-
when :Date
|
|
261
|
-
Date.parse(value)
|
|
262
|
-
when :String
|
|
263
|
-
value.to_s
|
|
264
|
-
when :Integer
|
|
265
|
-
value.to_i
|
|
266
|
-
when :Float
|
|
267
|
-
value.to_f
|
|
268
|
-
when :Boolean
|
|
269
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
270
|
-
true
|
|
271
|
-
else
|
|
272
|
-
false
|
|
273
|
-
end
|
|
274
|
-
when :Object
|
|
275
|
-
# generic object (usually a Hash), return directly
|
|
276
|
-
value
|
|
277
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
278
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
279
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
280
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
281
|
-
k_type = Regexp.last_match[:k_type]
|
|
282
|
-
v_type = Regexp.last_match[:v_type]
|
|
283
|
-
{}.tap do |hash|
|
|
284
|
-
value.each do |k, v|
|
|
285
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
286
|
-
end
|
|
287
|
-
end
|
|
288
|
-
else # model
|
|
289
|
-
# models (e.g. Pet) or oneOf
|
|
290
|
-
klass = FlatApi.const_get(type)
|
|
291
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
292
|
-
end
|
|
293
|
-
end
|
|
294
|
-
|
|
295
|
-
# Returns the string representation of the object
|
|
296
|
-
# @return [String] String presentation of the object
|
|
297
|
-
def to_s
|
|
298
|
-
to_hash.to_s
|
|
299
|
-
end
|
|
300
|
-
|
|
301
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
302
|
-
# @return [Hash] Returns the object in the form of hash
|
|
303
|
-
def to_body
|
|
304
|
-
to_hash
|
|
305
|
-
end
|
|
306
|
-
|
|
307
298
|
# Returns the object in the form of hash
|
|
308
299
|
# @return [Hash] Returns the object in the form of hash
|
|
309
300
|
def to_hash
|
|
@@ -320,24 +311,6 @@ module FlatApi
|
|
|
320
311
|
hash
|
|
321
312
|
end
|
|
322
313
|
|
|
323
|
-
# Outputs non-array value in the form of hash
|
|
324
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
325
|
-
# @param [Object] value Any valid value
|
|
326
|
-
# @return [Hash] Returns the value in the form of hash
|
|
327
|
-
def _to_hash(value)
|
|
328
|
-
if value.is_a?(Array)
|
|
329
|
-
value.compact.map { |v| _to_hash(v) }
|
|
330
|
-
elsif value.is_a?(Hash)
|
|
331
|
-
{}.tap do |hash|
|
|
332
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
333
|
-
end
|
|
334
|
-
elsif value.respond_to? :to_hash
|
|
335
|
-
value.to_hash
|
|
336
|
-
else
|
|
337
|
-
value
|
|
338
|
-
end
|
|
339
|
-
end
|
|
340
|
-
|
|
341
314
|
end
|
|
342
315
|
|
|
343
316
|
end
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# The parameters to create an organization invitation
|
|
18
|
-
class OrganizationInvitationCreation
|
|
18
|
+
class OrganizationInvitationCreation < ApiModelBase
|
|
19
19
|
# The email address you want to send the invitation to
|
|
20
20
|
attr_accessor :email
|
|
21
21
|
|
|
@@ -52,9 +52,14 @@ module FlatApi
|
|
|
52
52
|
}
|
|
53
53
|
end
|
|
54
54
|
|
|
55
|
+
# Returns attribute mapping this model knows about
|
|
56
|
+
def self.acceptable_attribute_map
|
|
57
|
+
attribute_map
|
|
58
|
+
end
|
|
59
|
+
|
|
55
60
|
# Returns all the JSON keys this model knows about
|
|
56
61
|
def self.acceptable_attributes
|
|
57
|
-
|
|
62
|
+
acceptable_attribute_map.values
|
|
58
63
|
end
|
|
59
64
|
|
|
60
65
|
# Attribute type mapping.
|
|
@@ -79,9 +84,10 @@ module FlatApi
|
|
|
79
84
|
end
|
|
80
85
|
|
|
81
86
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
87
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
82
88
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
83
|
-
if (!
|
|
84
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationInvitationCreation`. Please check the name to make sure it's valid. List of attributes: " +
|
|
89
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
90
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationInvitationCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
85
91
|
end
|
|
86
92
|
h[k.to_sym] = v
|
|
87
93
|
}
|
|
@@ -109,7 +115,7 @@ module FlatApi
|
|
|
109
115
|
# @return true if the model is valid
|
|
110
116
|
def valid?
|
|
111
117
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
112
|
-
organization_role_validator = EnumAttributeValidator.new('String', ["admin", "teacher"])
|
|
118
|
+
organization_role_validator = EnumAttributeValidator.new('String', ["admin", "teacher", "accountAdmin"])
|
|
113
119
|
return false unless organization_role_validator.valid?(@organization_role)
|
|
114
120
|
true
|
|
115
121
|
end
|
|
@@ -117,7 +123,7 @@ module FlatApi
|
|
|
117
123
|
# Custom attribute writer method checking allowed values (enum).
|
|
118
124
|
# @param [Object] organization_role Object to be assigned
|
|
119
125
|
def organization_role=(organization_role)
|
|
120
|
-
validator = EnumAttributeValidator.new('String', ["admin", "teacher"])
|
|
126
|
+
validator = EnumAttributeValidator.new('String', ["admin", "teacher", "accountAdmin"])
|
|
121
127
|
unless validator.valid?(organization_role)
|
|
122
128
|
fail ArgumentError, "invalid value for \"organization_role\", must be one of #{validator.allowable_values}."
|
|
123
129
|
end
|
|
@@ -168,61 +174,6 @@ module FlatApi
|
|
|
168
174
|
new(transformed_hash)
|
|
169
175
|
end
|
|
170
176
|
|
|
171
|
-
# Deserializes the data based on type
|
|
172
|
-
# @param string type Data type
|
|
173
|
-
# @param string value Value to be deserialized
|
|
174
|
-
# @return [Object] Deserialized data
|
|
175
|
-
def self._deserialize(type, value)
|
|
176
|
-
case type.to_sym
|
|
177
|
-
when :Time
|
|
178
|
-
Time.parse(value)
|
|
179
|
-
when :Date
|
|
180
|
-
Date.parse(value)
|
|
181
|
-
when :String
|
|
182
|
-
value.to_s
|
|
183
|
-
when :Integer
|
|
184
|
-
value.to_i
|
|
185
|
-
when :Float
|
|
186
|
-
value.to_f
|
|
187
|
-
when :Boolean
|
|
188
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
189
|
-
true
|
|
190
|
-
else
|
|
191
|
-
false
|
|
192
|
-
end
|
|
193
|
-
when :Object
|
|
194
|
-
# generic object (usually a Hash), return directly
|
|
195
|
-
value
|
|
196
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
197
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
198
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
199
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
200
|
-
k_type = Regexp.last_match[:k_type]
|
|
201
|
-
v_type = Regexp.last_match[:v_type]
|
|
202
|
-
{}.tap do |hash|
|
|
203
|
-
value.each do |k, v|
|
|
204
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
205
|
-
end
|
|
206
|
-
end
|
|
207
|
-
else # model
|
|
208
|
-
# models (e.g. Pet) or oneOf
|
|
209
|
-
klass = FlatApi.const_get(type)
|
|
210
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
211
|
-
end
|
|
212
|
-
end
|
|
213
|
-
|
|
214
|
-
# Returns the string representation of the object
|
|
215
|
-
# @return [String] String presentation of the object
|
|
216
|
-
def to_s
|
|
217
|
-
to_hash.to_s
|
|
218
|
-
end
|
|
219
|
-
|
|
220
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
221
|
-
# @return [Hash] Returns the object in the form of hash
|
|
222
|
-
def to_body
|
|
223
|
-
to_hash
|
|
224
|
-
end
|
|
225
|
-
|
|
226
177
|
# Returns the object in the form of hash
|
|
227
178
|
# @return [Hash] Returns the object in the form of hash
|
|
228
179
|
def to_hash
|
|
@@ -239,24 +190,6 @@ module FlatApi
|
|
|
239
190
|
hash
|
|
240
191
|
end
|
|
241
192
|
|
|
242
|
-
# Outputs non-array value in the form of hash
|
|
243
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
244
|
-
# @param [Object] value Any valid value
|
|
245
|
-
# @return [Hash] Returns the value in the form of hash
|
|
246
|
-
def _to_hash(value)
|
|
247
|
-
if value.is_a?(Array)
|
|
248
|
-
value.compact.map { |v| _to_hash(v) }
|
|
249
|
-
elsif value.is_a?(Hash)
|
|
250
|
-
{}.tap do |hash|
|
|
251
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
252
|
-
end
|
|
253
|
-
elsif value.respond_to? :to_hash
|
|
254
|
-
value.to_hash
|
|
255
|
-
else
|
|
256
|
-
value
|
|
257
|
-
end
|
|
258
|
-
end
|
|
259
|
-
|
|
260
193
|
end
|
|
261
194
|
|
|
262
195
|
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
|
|
|
@@ -16,12 +16,12 @@ require 'time'
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
class OrganizationRoles
|
|
18
18
|
ADMIN = "admin".freeze
|
|
19
|
-
|
|
19
|
+
ACCOUNT_ADMIN = "accountAdmin".freeze
|
|
20
20
|
TEACHER = "teacher".freeze
|
|
21
21
|
USER = "user".freeze
|
|
22
22
|
|
|
23
23
|
def self.all_vars
|
|
24
|
-
@all_vars ||= [ADMIN,
|
|
24
|
+
@all_vars ||= [ADMIN, ACCOUNT_ADMIN, TEACHER, USER].freeze
|
|
25
25
|
end
|
|
26
26
|
|
|
27
27
|
# Builds the enum from string
|
|
@@ -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
|
# Creation of a delegated API access token for an organization user
|
|
18
|
-
class OrganizationUserAccessTokenCreation
|
|
18
|
+
class OrganizationUserAccessTokenCreation < ApiModelBase
|
|
19
19
|
# List of requested scopes for this credential
|
|
20
20
|
attr_accessor :scopes
|
|
21
21
|
|
|
@@ -26,9 +26,14 @@ module FlatApi
|
|
|
26
26
|
}
|
|
27
27
|
end
|
|
28
28
|
|
|
29
|
+
# Returns attribute mapping this model knows about
|
|
30
|
+
def self.acceptable_attribute_map
|
|
31
|
+
attribute_map
|
|
32
|
+
end
|
|
33
|
+
|
|
29
34
|
# Returns all the JSON keys this model knows about
|
|
30
35
|
def self.acceptable_attributes
|
|
31
|
-
|
|
36
|
+
acceptable_attribute_map.values
|
|
32
37
|
end
|
|
33
38
|
|
|
34
39
|
# Attribute type mapping.
|
|
@@ -52,9 +57,10 @@ module FlatApi
|
|
|
52
57
|
end
|
|
53
58
|
|
|
54
59
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
60
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
55
61
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
56
|
-
if (!
|
|
57
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationUserAccessTokenCreation`. Please check the name to make sure it's valid. List of attributes: " +
|
|
62
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OrganizationUserAccessTokenCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
58
64
|
end
|
|
59
65
|
h[k.to_sym] = v
|
|
60
66
|
}
|
|
@@ -88,6 +94,16 @@ module FlatApi
|
|
|
88
94
|
true
|
|
89
95
|
end
|
|
90
96
|
|
|
97
|
+
# Custom attribute writer method with validation
|
|
98
|
+
# @param [Object] scopes Value to be assigned
|
|
99
|
+
def scopes=(scopes)
|
|
100
|
+
if scopes.nil?
|
|
101
|
+
fail ArgumentError, 'scopes cannot be nil'
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
@scopes = scopes
|
|
105
|
+
end
|
|
106
|
+
|
|
91
107
|
# Checks equality by comparing each attribute.
|
|
92
108
|
# @param [Object] Object to be compared
|
|
93
109
|
def ==(o)
|
|
@@ -131,61 +147,6 @@ module FlatApi
|
|
|
131
147
|
new(transformed_hash)
|
|
132
148
|
end
|
|
133
149
|
|
|
134
|
-
# Deserializes the data based on type
|
|
135
|
-
# @param string type Data type
|
|
136
|
-
# @param string value Value to be deserialized
|
|
137
|
-
# @return [Object] Deserialized data
|
|
138
|
-
def self._deserialize(type, value)
|
|
139
|
-
case type.to_sym
|
|
140
|
-
when :Time
|
|
141
|
-
Time.parse(value)
|
|
142
|
-
when :Date
|
|
143
|
-
Date.parse(value)
|
|
144
|
-
when :String
|
|
145
|
-
value.to_s
|
|
146
|
-
when :Integer
|
|
147
|
-
value.to_i
|
|
148
|
-
when :Float
|
|
149
|
-
value.to_f
|
|
150
|
-
when :Boolean
|
|
151
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
152
|
-
true
|
|
153
|
-
else
|
|
154
|
-
false
|
|
155
|
-
end
|
|
156
|
-
when :Object
|
|
157
|
-
# generic object (usually a Hash), return directly
|
|
158
|
-
value
|
|
159
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
160
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
161
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
162
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
163
|
-
k_type = Regexp.last_match[:k_type]
|
|
164
|
-
v_type = Regexp.last_match[:v_type]
|
|
165
|
-
{}.tap do |hash|
|
|
166
|
-
value.each do |k, v|
|
|
167
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
168
|
-
end
|
|
169
|
-
end
|
|
170
|
-
else # model
|
|
171
|
-
# models (e.g. Pet) or oneOf
|
|
172
|
-
klass = FlatApi.const_get(type)
|
|
173
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
174
|
-
end
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
# Returns the string representation of the object
|
|
178
|
-
# @return [String] String presentation of the object
|
|
179
|
-
def to_s
|
|
180
|
-
to_hash.to_s
|
|
181
|
-
end
|
|
182
|
-
|
|
183
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
184
|
-
# @return [Hash] Returns the object in the form of hash
|
|
185
|
-
def to_body
|
|
186
|
-
to_hash
|
|
187
|
-
end
|
|
188
|
-
|
|
189
150
|
# Returns the object in the form of hash
|
|
190
151
|
# @return [Hash] Returns the object in the form of hash
|
|
191
152
|
def to_hash
|
|
@@ -202,24 +163,6 @@ module FlatApi
|
|
|
202
163
|
hash
|
|
203
164
|
end
|
|
204
165
|
|
|
205
|
-
# Outputs non-array value in the form of hash
|
|
206
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
207
|
-
# @param [Object] value Any valid value
|
|
208
|
-
# @return [Hash] Returns the value in the form of hash
|
|
209
|
-
def _to_hash(value)
|
|
210
|
-
if value.is_a?(Array)
|
|
211
|
-
value.compact.map { |v| _to_hash(v) }
|
|
212
|
-
elsif value.is_a?(Hash)
|
|
213
|
-
{}.tap do |hash|
|
|
214
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
215
|
-
end
|
|
216
|
-
elsif value.respond_to? :to_hash
|
|
217
|
-
value.to_hash
|
|
218
|
-
else
|
|
219
|
-
value
|
|
220
|
-
end
|
|
221
|
-
end
|
|
222
|
-
|
|
223
166
|
end
|
|
224
167
|
|
|
225
168
|
end
|