flat_api 0.3.5 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +69 -0
- data/LICENSE +201 -0
- data/README.md +92 -0
- data/lib/flat_api/api/account_api.rb +4 -4
- data/lib/flat_api/api/class_api.rb +281 -63
- data/lib/flat_api/api/collection_api.rb +63 -50
- data/lib/flat_api/api/edu_resources_api.rb +38 -26
- data/lib/flat_api/api/group_api.rb +432 -9
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +307 -35
- data/lib/flat_api/api/score_api.rb +129 -80
- data/lib/flat_api/api/task_api.rb +5 -5
- data/lib/flat_api/api/user_api.rb +45 -14
- data/lib/flat_api/api_client.rb +169 -96
- data/lib/flat_api/api_error.rb +3 -3
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +124 -25
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +13 -80
- data/lib/flat_api/models/app_scopes.rb +6 -4
- data/lib/flat_api/models/assignment.rb +190 -85
- data/lib/flat_api/models/assignment_capabilities.rb +53 -80
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +33 -80
- data/lib/flat_api/models/assignment_copy.rb +5 -6
- data/lib/flat_api/models/assignment_copy_response.rb +187 -82
- data/lib/flat_api/models/assignment_copy_to_class.rb +23 -80
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +23 -80
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +104 -81
- data/lib/flat_api/models/assignment_submission_comment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +23 -80
- data/lib/flat_api/models/assignment_submission_comments.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history.rb +33 -80
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_lti.rb +64 -86
- data/lib/flat_api/models/{assignment_submission_playback_inner.rb → assignment_submission_playback.rb} +36 -83
- data/lib/flat_api/models/assignment_submission_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +25 -81
- data/lib/flat_api/models/assignment_type.rb +5 -4
- data/lib/flat_api/models/assignment_update.rb +218 -87
- data/lib/flat_api/models/class_assignment.rb +219 -82
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +13 -80
- data/lib/flat_api/models/class_assignment_update.rb +237 -94
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_attachment_creation.rb +51 -86
- data/lib/flat_api/models/class_creation.rb +13 -80
- data/lib/flat_api/models/class_details.rb +85 -81
- data/lib/flat_api/models/class_details_canvas.rb +13 -80
- data/lib/flat_api/models/class_details_clever.rb +13 -80
- data/lib/flat_api/models/class_details_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_details_google_drive.rb +13 -80
- data/lib/flat_api/models/class_details_issues.rb +13 -80
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +15 -82
- data/lib/flat_api/models/class_details_lti.rb +28 -85
- data/lib/flat_api/models/class_details_mfc.rb +13 -80
- data/lib/flat_api/models/class_details_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_grade_level.rb +3 -3
- data/lib/flat_api/models/class_roles.rb +3 -3
- data/lib/flat_api/models/class_state.rb +5 -4
- data/lib/flat_api/models/class_update.rb +13 -80
- data/lib/flat_api/models/collection.rb +182 -81
- data/lib/flat_api/models/collection_app.rb +13 -80
- data/lib/flat_api/models/collection_capabilities.rb +63 -80
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +20 -99
- data/lib/flat_api/models/collection_modification.rb +17 -82
- data/lib/flat_api/models/collection_privacy.rb +3 -3
- data/lib/flat_api/models/collection_type.rb +7 -6
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +63 -82
- data/lib/flat_api/models/edu_resource.rb +101 -84
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +27 -84
- data/lib/flat_api/models/edu_resource_copy.rb +23 -80
- data/lib/flat_api/models/edu_resource_creation.rb +96 -86
- data/lib/flat_api/models/edu_resource_folder.rb +39 -84
- data/lib/flat_api/models/edu_resource_lti_link.rb +23 -80
- data/lib/flat_api/models/edu_resource_move.rb +23 -80
- data/lib/flat_api/models/edu_resource_privacy.rb +3 -3
- data/lib/flat_api/models/edu_resource_resource.rb +5 -6
- data/lib/flat_api/models/edu_resource_type.rb +3 -3
- data/lib/flat_api/models/edu_resource_update.rb +101 -86
- data/lib/flat_api/models/edu_resource_use_in_class.rb +23 -80
- data/lib/flat_api/models/flat_error_response.rb +47 -84
- data/lib/flat_api/models/google_classroom_coursework.rb +13 -80
- data/lib/flat_api/models/google_classroom_submission.rb +43 -80
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +14 -94
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +178 -84
- data/lib/flat_api/models/group_type.rb +6 -4
- data/lib/flat_api/models/license_mode.rb +3 -3
- data/lib/flat_api/models/license_sources.rb +3 -3
- data/lib/flat_api/models/lms_name.rb +3 -3
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +29 -84
- data/lib/flat_api/models/lti_credentials_creation.rb +23 -80
- data/lib/flat_api/models/media_attachment.rb +43 -88
- data/lib/flat_api/models/media_score_sharing_mode.rb +3 -3
- data/lib/flat_api/models/microsoft_graph_assignment.rb +99 -88
- data/lib/flat_api/models/microsoft_graph_submission.rb +33 -80
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +54 -81
- data/lib/flat_api/models/organization_invitation_creation.rb +15 -82
- data/lib/flat_api/models/organization_roles.rb +5 -5
- data/lib/flat_api/models/organization_user_access_token_creation.rb +23 -80
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +43 -85
- data/lib/flat_api/models/resource_collaborator_creation.rb +13 -80
- data/lib/flat_api/models/resource_rights.rb +43 -85
- data/lib/flat_api/models/score_comment.rb +122 -80
- data/lib/flat_api/models/score_comment_context.rb +73 -80
- data/lib/flat_api/models/score_comment_creation.rb +24 -81
- data/lib/flat_api/models/score_comment_moderation.rb +13 -80
- data/lib/flat_api/models/score_comment_update.rb +18 -85
- data/lib/flat_api/models/score_comments_counts.rb +28 -85
- data/lib/flat_api/models/score_creation.rb +5 -6
- data/lib/flat_api/models/score_creation_builder_data.rb +24 -88
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +23 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +13 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +24 -81
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +33 -80
- data/lib/flat_api/models/score_creation_common.rb +14 -81
- data/lib/flat_api/models/score_creation_file_import.rb +39 -86
- data/lib/flat_api/models/score_creation_google_drive_import.rb +24 -81
- data/lib/flat_api/models/score_creation_type.rb +4 -5
- data/lib/flat_api/models/score_details.rb +180 -89
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +14 -83
- data/lib/flat_api/models/score_license.rb +4 -5
- data/lib/flat_api/models/score_likes_counts.rb +28 -106
- data/lib/flat_api/models/score_modification.rb +13 -80
- data/lib/flat_api/models/score_plays_counts.rb +28 -85
- data/lib/flat_api/models/score_privacy.rb +3 -3
- data/lib/flat_api/models/score_revision.rb +81 -87
- data/lib/flat_api/models/score_revision_creation.rb +23 -80
- data/lib/flat_api/models/score_revision_statistics.rb +13 -80
- data/lib/flat_api/models/score_source.rb +13 -80
- data/lib/flat_api/models/score_summary.rb +63 -80
- data/lib/flat_api/models/score_track.rb +94 -88
- data/lib/flat_api/models/score_track_creation.rb +13 -80
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +23 -80
- data/lib/flat_api/models/score_track_purpose.rb +3 -3
- data/lib/flat_api/models/score_track_state.rb +3 -3
- data/lib/flat_api/models/score_track_type.rb +3 -3
- data/lib/flat_api/models/score_track_update.rb +25 -81
- data/lib/flat_api/models/score_views_counts.rb +28 -85
- data/lib/flat_api/models/task.rb +62 -87
- data/lib/flat_api/models/task_export_options.rb +13 -80
- data/lib/flat_api/models/task_progress.rb +13 -80
- data/lib/flat_api/models/task_result.rb +13 -80
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +3 -3
- data/lib/flat_api/models/user_admin_update.rb +17 -95
- data/lib/flat_api/models/user_azure_details.rb +13 -80
- data/lib/flat_api/models/user_basics.rb +43 -80
- data/lib/flat_api/models/user_community_profile_links.rb +13 -80
- data/lib/flat_api/models/user_creation.rb +21 -98
- data/lib/flat_api/models/user_details.rb +101 -96
- data/lib/flat_api/models/user_details_admin.rb +72 -85
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +13 -80
- data/lib/flat_api/models/user_public.rb +89 -94
- data/lib/flat_api/models/user_public_summary.rb +58 -81
- data/lib/flat_api/models/user_signin_link.rb +24 -81
- data/lib/flat_api/models/user_signin_link_creation.rb +13 -80
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +4 -4
- data/lib/flat_api.rb +70 -5
- metadata +98 -330
- data/lib/flat_api/models/flat_locales.rb +0 -56
- data/spec/api/account_api_spec.rb +0 -47
- data/spec/api/class_api_spec.rb +0 -422
- data/spec/api/collection_api_spec.rb +0 -158
- data/spec/api/edu_resources_api_spec.rb +0 -181
- data/spec/api/group_api_spec.rb +0 -71
- data/spec/api/organization_api_spec.rb +0 -201
- data/spec/api/score_api_spec.rb +0 -440
- data/spec/api/task_api_spec.rb +0 -47
- data/spec/api/user_api_spec.rb +0 -75
- data/spec/models/api_access_token_spec.rb +0 -66
- data/spec/models/app_scopes_spec.rb +0 -30
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +0 -42
- data/spec/models/assignment_capabilities_spec.rb +0 -60
- data/spec/models/assignment_copy_response_spec.rb +0 -124
- data/spec/models/assignment_copy_spec.rb +0 -32
- data/spec/models/assignment_copy_to_class_spec.rb +0 -48
- data/spec/models/assignment_copy_to_resource_library_spec.rb +0 -42
- data/spec/models/assignment_spec.rb +0 -118
- data/spec/models/assignment_submission_comment_creation_spec.rb +0 -36
- data/spec/models/assignment_submission_comment_spec.rb +0 -72
- data/spec/models/assignment_submission_comments_spec.rb +0 -42
- data/spec/models/assignment_submission_history_attachment_spec.rb +0 -48
- data/spec/models/assignment_submission_history_spec.rb +0 -112
- data/spec/models/assignment_submission_history_state_spec.rb +0 -30
- data/spec/models/assignment_submission_lti_spec.rb +0 -36
- data/spec/models/assignment_submission_playback_inner_spec.rb +0 -42
- data/spec/models/assignment_submission_spec.rb +0 -144
- data/spec/models/assignment_submission_state_spec.rb +0 -30
- data/spec/models/assignment_submission_update_spec.rb +0 -66
- data/spec/models/assignment_type_spec.rb +0 -30
- data/spec/models/assignment_update_spec.rb +0 -100
- data/spec/models/class_assignment_all_of_canvas_spec.rb +0 -42
- data/spec/models/class_assignment_all_of_lti_spec.rb +0 -36
- data/spec/models/class_assignment_all_of_mfc_spec.rb +0 -42
- data/spec/models/class_assignment_spec.rb +0 -216
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +0 -36
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_assignment_update_spec.rb +0 -150
- data/spec/models/class_attachment_creation_spec.rb +0 -76
- data/spec/models/class_creation_spec.rb +0 -64
- data/spec/models/class_details_canvas_spec.rb +0 -42
- data/spec/models/class_details_clever_spec.rb +0 -76
- data/spec/models/class_details_google_classroom_spec.rb +0 -42
- data/spec/models/class_details_google_drive_spec.rb +0 -42
- data/spec/models/class_details_issues_spec.rb +0 -36
- data/spec/models/class_details_issues_sync_inner_spec.rb +0 -52
- data/spec/models/class_details_lti_spec.rb +0 -48
- data/spec/models/class_details_mfc_spec.rb +0 -42
- data/spec/models/class_details_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_details_spec.rb +0 -178
- data/spec/models/class_grade_level_spec.rb +0 -30
- data/spec/models/class_roles_spec.rb +0 -30
- data/spec/models/class_state_spec.rb +0 -30
- data/spec/models/class_update_spec.rb +0 -64
- data/spec/models/collection_app_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -60
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -30
- data/spec/models/collection_spec.rb +0 -114
- data/spec/models/collection_type_spec.rb +0 -30
- data/spec/models/edu_library_spec.rb +0 -62
- data/spec/models/edu_resource_capabilities_spec.rb +0 -48
- data/spec/models/edu_resource_copy_spec.rb +0 -36
- data/spec/models/edu_resource_creation_spec.rb +0 -48
- data/spec/models/edu_resource_folder_spec.rb +0 -36
- data/spec/models/edu_resource_lti_link_spec.rb +0 -36
- data/spec/models/edu_resource_move_spec.rb +0 -36
- data/spec/models/edu_resource_privacy_spec.rb +0 -30
- data/spec/models/edu_resource_resource_spec.rb +0 -32
- data/spec/models/edu_resource_spec.rb +0 -96
- data/spec/models/edu_resource_type_spec.rb +0 -30
- data/spec/models/edu_resource_update_spec.rb +0 -42
- data/spec/models/edu_resource_use_in_class_spec.rb +0 -42
- data/spec/models/flat_error_response_spec.rb +0 -54
- data/spec/models/flat_locales_spec.rb +0 -30
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -48
- data/spec/models/group_details_spec.rb +0 -72
- data/spec/models/group_spec.rb +0 -76
- data/spec/models/group_type_spec.rb +0 -30
- data/spec/models/license_mode_spec.rb +0 -30
- data/spec/models/license_sources_spec.rb +0 -30
- data/spec/models/lms_name_spec.rb +0 -30
- data/spec/models/lti_credentials_creation_spec.rb +0 -42
- data/spec/models/lti_credentials_spec.rb +0 -84
- data/spec/models/media_attachment_spec.rb +0 -166
- data/spec/models/media_score_sharing_mode_spec.rb +0 -30
- data/spec/models/microsoft_graph_assignment_spec.rb +0 -54
- data/spec/models/microsoft_graph_submission_spec.rb +0 -42
- data/spec/models/organization_invitation_creation_spec.rb +0 -46
- data/spec/models/organization_invitation_spec.rb +0 -84
- data/spec/models/organization_roles_spec.rb +0 -30
- data/spec/models/organization_user_access_token_creation_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -72
- data/spec/models/resource_collaborator_spec.rb +0 -112
- data/spec/models/resource_rights_spec.rb +0 -64
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -66
- data/spec/models/score_comment_moderation_spec.rb +0 -46
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -54
- data/spec/models/score_comments_counts_spec.rb +0 -54
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +0 -82
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +0 -60
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +0 -66
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +0 -42
- data/spec/models/score_creation_builder_data_spec.rb +0 -60
- data/spec/models/score_creation_common_spec.rb +0 -54
- data/spec/models/score_creation_file_import_spec.rb +0 -76
- data/spec/models/score_creation_google_drive_import_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -32
- data/spec/models/score_creation_type_spec.rb +0 -30
- data/spec/models/score_details_spec.rb +0 -240
- data/spec/models/score_fork_spec.rb +0 -48
- data/spec/models/score_license_spec.rb +0 -30
- data/spec/models/score_likes_counts_spec.rb +0 -48
- data/spec/models/score_modification_spec.rb +0 -102
- data/spec/models/score_plays_counts_spec.rb +0 -48
- data/spec/models/score_privacy_spec.rb +0 -30
- data/spec/models/score_revision_creation_spec.rb +0 -58
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -54
- data/spec/models/score_source_spec.rb +0 -36
- data/spec/models/score_summary_spec.rb +0 -66
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -52
- data/spec/models/score_track_purpose_spec.rb +0 -30
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -30
- data/spec/models/score_track_type_spec.rb +0 -30
- data/spec/models/score_track_update_spec.rb +0 -54
- data/spec/models/score_views_counts_spec.rb +0 -48
- data/spec/models/task_export_options_spec.rb +0 -36
- data/spec/models/task_progress_spec.rb +0 -42
- data/spec/models/task_result_spec.rb +0 -42
- data/spec/models/task_spec.rb +0 -100
- data/spec/models/tutteo_product_spec.rb +0 -30
- data/spec/models/user_admin_update_spec.rb +0 -66
- data/spec/models/user_azure_details_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -94
- data/spec/models/user_community_profile_links_spec.rb +0 -66
- data/spec/models/user_creation_spec.rb +0 -76
- data/spec/models/user_details_admin_all_of_license_spec.rb +0 -60
- data/spec/models/user_details_admin_spec.rb +0 -142
- data/spec/models/user_details_spec.rb +0 -214
- data/spec/models/user_public_spec.rb +0 -178
- data/spec/models/user_public_summary_spec.rb +0 -118
- data/spec/models/user_signin_link_creation_spec.rb +0 -36
- data/spec/models/user_signin_link_spec.rb +0 -42
- data/spec/spec_helper.rb +0 -111
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# A coursework on Google Classroom
|
|
18
|
-
class GoogleClassroomCoursework
|
|
18
|
+
class GoogleClassroomCoursework < ApiModelBase
|
|
19
19
|
# Identifier of the coursework assigned by Classroom
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -38,9 +38,14 @@ module FlatApi
|
|
|
38
38
|
}
|
|
39
39
|
end
|
|
40
40
|
|
|
41
|
+
# Returns attribute mapping this model knows about
|
|
42
|
+
def self.acceptable_attribute_map
|
|
43
|
+
attribute_map
|
|
44
|
+
end
|
|
45
|
+
|
|
41
46
|
# Returns all the JSON keys this model knows about
|
|
42
47
|
def self.acceptable_attributes
|
|
43
|
-
|
|
48
|
+
acceptable_attribute_map.values
|
|
44
49
|
end
|
|
45
50
|
|
|
46
51
|
# Attribute type mapping.
|
|
@@ -68,9 +73,10 @@ module FlatApi
|
|
|
68
73
|
end
|
|
69
74
|
|
|
70
75
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
76
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
71
77
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
72
|
-
if (!
|
|
73
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GoogleClassroomCoursework`. Please check the name to make sure it's valid. List of attributes: " +
|
|
78
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
79
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GoogleClassroomCoursework`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
74
80
|
end
|
|
75
81
|
h[k.to_sym] = v
|
|
76
82
|
}
|
|
@@ -153,61 +159,6 @@ module FlatApi
|
|
|
153
159
|
new(transformed_hash)
|
|
154
160
|
end
|
|
155
161
|
|
|
156
|
-
# Deserializes the data based on type
|
|
157
|
-
# @param string type Data type
|
|
158
|
-
# @param string value Value to be deserialized
|
|
159
|
-
# @return [Object] Deserialized data
|
|
160
|
-
def self._deserialize(type, value)
|
|
161
|
-
case type.to_sym
|
|
162
|
-
when :Time
|
|
163
|
-
Time.parse(value)
|
|
164
|
-
when :Date
|
|
165
|
-
Date.parse(value)
|
|
166
|
-
when :String
|
|
167
|
-
value.to_s
|
|
168
|
-
when :Integer
|
|
169
|
-
value.to_i
|
|
170
|
-
when :Float
|
|
171
|
-
value.to_f
|
|
172
|
-
when :Boolean
|
|
173
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
174
|
-
true
|
|
175
|
-
else
|
|
176
|
-
false
|
|
177
|
-
end
|
|
178
|
-
when :Object
|
|
179
|
-
# generic object (usually a Hash), return directly
|
|
180
|
-
value
|
|
181
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
182
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
183
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
184
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
185
|
-
k_type = Regexp.last_match[:k_type]
|
|
186
|
-
v_type = Regexp.last_match[:v_type]
|
|
187
|
-
{}.tap do |hash|
|
|
188
|
-
value.each do |k, v|
|
|
189
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
190
|
-
end
|
|
191
|
-
end
|
|
192
|
-
else # model
|
|
193
|
-
# models (e.g. Pet) or oneOf
|
|
194
|
-
klass = FlatApi.const_get(type)
|
|
195
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
196
|
-
end
|
|
197
|
-
end
|
|
198
|
-
|
|
199
|
-
# Returns the string representation of the object
|
|
200
|
-
# @return [String] String presentation of the object
|
|
201
|
-
def to_s
|
|
202
|
-
to_hash.to_s
|
|
203
|
-
end
|
|
204
|
-
|
|
205
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
206
|
-
# @return [Hash] Returns the object in the form of hash
|
|
207
|
-
def to_body
|
|
208
|
-
to_hash
|
|
209
|
-
end
|
|
210
|
-
|
|
211
162
|
# Returns the object in the form of hash
|
|
212
163
|
# @return [Hash] Returns the object in the form of hash
|
|
213
164
|
def to_hash
|
|
@@ -224,24 +175,6 @@ module FlatApi
|
|
|
224
175
|
hash
|
|
225
176
|
end
|
|
226
177
|
|
|
227
|
-
# Outputs non-array value in the form of hash
|
|
228
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
229
|
-
# @param [Object] value Any valid value
|
|
230
|
-
# @return [Hash] Returns the value in the form of hash
|
|
231
|
-
def _to_hash(value)
|
|
232
|
-
if value.is_a?(Array)
|
|
233
|
-
value.compact.map { |v| _to_hash(v) }
|
|
234
|
-
elsif value.is_a?(Hash)
|
|
235
|
-
{}.tap do |hash|
|
|
236
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
237
|
-
end
|
|
238
|
-
elsif value.respond_to? :to_hash
|
|
239
|
-
value.to_hash
|
|
240
|
-
else
|
|
241
|
-
value
|
|
242
|
-
end
|
|
243
|
-
end
|
|
244
|
-
|
|
245
178
|
end
|
|
246
179
|
|
|
247
180
|
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
|
# A coursework submission on Google Classroom
|
|
18
|
-
class GoogleClassroomSubmission
|
|
18
|
+
class GoogleClassroomSubmission < ApiModelBase
|
|
19
19
|
# Identifier of the coursework submission assigned by Classroom
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
@@ -34,9 +34,14 @@ module FlatApi
|
|
|
34
34
|
}
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
+
# Returns attribute mapping this model knows about
|
|
38
|
+
def self.acceptable_attribute_map
|
|
39
|
+
attribute_map
|
|
40
|
+
end
|
|
41
|
+
|
|
37
42
|
# Returns all the JSON keys this model knows about
|
|
38
43
|
def self.acceptable_attributes
|
|
39
|
-
|
|
44
|
+
acceptable_attribute_map.values
|
|
40
45
|
end
|
|
41
46
|
|
|
42
47
|
# Attribute type mapping.
|
|
@@ -62,9 +67,10 @@ module FlatApi
|
|
|
62
67
|
end
|
|
63
68
|
|
|
64
69
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
70
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
65
71
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
66
|
-
if (!
|
|
67
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GoogleClassroomSubmission`. Please check the name to make sure it's valid. List of attributes: " +
|
|
72
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GoogleClassroomSubmission`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
68
74
|
end
|
|
69
75
|
h[k.to_sym] = v
|
|
70
76
|
}
|
|
@@ -118,6 +124,36 @@ module FlatApi
|
|
|
118
124
|
true
|
|
119
125
|
end
|
|
120
126
|
|
|
127
|
+
# Custom attribute writer method with validation
|
|
128
|
+
# @param [Object] id Value to be assigned
|
|
129
|
+
def id=(id)
|
|
130
|
+
if id.nil?
|
|
131
|
+
fail ArgumentError, 'id cannot be nil'
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
@id = id
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# Custom attribute writer method with validation
|
|
138
|
+
# @param [Object] state Value to be assigned
|
|
139
|
+
def state=(state)
|
|
140
|
+
if state.nil?
|
|
141
|
+
fail ArgumentError, 'state cannot be nil'
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
@state = state
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Custom attribute writer method with validation
|
|
148
|
+
# @param [Object] alternate_link Value to be assigned
|
|
149
|
+
def alternate_link=(alternate_link)
|
|
150
|
+
if alternate_link.nil?
|
|
151
|
+
fail ArgumentError, 'alternate_link cannot be nil'
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
@alternate_link = alternate_link
|
|
155
|
+
end
|
|
156
|
+
|
|
121
157
|
# Checks equality by comparing each attribute.
|
|
122
158
|
# @param [Object] Object to be compared
|
|
123
159
|
def ==(o)
|
|
@@ -163,61 +199,6 @@ module FlatApi
|
|
|
163
199
|
new(transformed_hash)
|
|
164
200
|
end
|
|
165
201
|
|
|
166
|
-
# Deserializes the data based on type
|
|
167
|
-
# @param string type Data type
|
|
168
|
-
# @param string value Value to be deserialized
|
|
169
|
-
# @return [Object] Deserialized data
|
|
170
|
-
def self._deserialize(type, value)
|
|
171
|
-
case type.to_sym
|
|
172
|
-
when :Time
|
|
173
|
-
Time.parse(value)
|
|
174
|
-
when :Date
|
|
175
|
-
Date.parse(value)
|
|
176
|
-
when :String
|
|
177
|
-
value.to_s
|
|
178
|
-
when :Integer
|
|
179
|
-
value.to_i
|
|
180
|
-
when :Float
|
|
181
|
-
value.to_f
|
|
182
|
-
when :Boolean
|
|
183
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
184
|
-
true
|
|
185
|
-
else
|
|
186
|
-
false
|
|
187
|
-
end
|
|
188
|
-
when :Object
|
|
189
|
-
# generic object (usually a Hash), return directly
|
|
190
|
-
value
|
|
191
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
192
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
193
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
194
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
195
|
-
k_type = Regexp.last_match[:k_type]
|
|
196
|
-
v_type = Regexp.last_match[:v_type]
|
|
197
|
-
{}.tap do |hash|
|
|
198
|
-
value.each do |k, v|
|
|
199
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
200
|
-
end
|
|
201
|
-
end
|
|
202
|
-
else # model
|
|
203
|
-
# models (e.g. Pet) or oneOf
|
|
204
|
-
klass = FlatApi.const_get(type)
|
|
205
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
206
|
-
end
|
|
207
|
-
end
|
|
208
|
-
|
|
209
|
-
# Returns the string representation of the object
|
|
210
|
-
# @return [String] String presentation of the object
|
|
211
|
-
def to_s
|
|
212
|
-
to_hash.to_s
|
|
213
|
-
end
|
|
214
|
-
|
|
215
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
216
|
-
# @return [Hash] Returns the object in the form of hash
|
|
217
|
-
def to_body
|
|
218
|
-
to_hash
|
|
219
|
-
end
|
|
220
|
-
|
|
221
202
|
# Returns the object in the form of hash
|
|
222
203
|
# @return [Hash] Returns the object in the form of hash
|
|
223
204
|
def to_hash
|
|
@@ -234,24 +215,6 @@ module FlatApi
|
|
|
234
215
|
hash
|
|
235
216
|
end
|
|
236
217
|
|
|
237
|
-
# Outputs non-array value in the form of hash
|
|
238
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
239
|
-
# @param [Object] value Any valid value
|
|
240
|
-
# @return [Hash] Returns the value in the form of hash
|
|
241
|
-
def _to_hash(value)
|
|
242
|
-
if value.is_a?(Array)
|
|
243
|
-
value.compact.map { |v| _to_hash(v) }
|
|
244
|
-
elsif value.is_a?(Hash)
|
|
245
|
-
{}.tap do |hash|
|
|
246
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
247
|
-
end
|
|
248
|
-
elsif value.respond_to? :to_hash
|
|
249
|
-
value.to_hash
|
|
250
|
-
else
|
|
251
|
-
value
|
|
252
|
-
end
|
|
253
|
-
end
|
|
254
|
-
|
|
255
218
|
end
|
|
256
219
|
|
|
257
220
|
end
|
|
@@ -0,0 +1,51 @@
|
|
|
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
|
+
class Grade
|
|
18
|
+
N1 = "1".freeze
|
|
19
|
+
N2 = "2".freeze
|
|
20
|
+
N3 = "3".freeze
|
|
21
|
+
N4 = "4".freeze
|
|
22
|
+
N5 = "5".freeze
|
|
23
|
+
N6 = "6".freeze
|
|
24
|
+
N7 = "7".freeze
|
|
25
|
+
N8 = "8".freeze
|
|
26
|
+
N9 = "9".freeze
|
|
27
|
+
N10 = "10".freeze
|
|
28
|
+
N11 = "11".freeze
|
|
29
|
+
N12 = "12".freeze
|
|
30
|
+
UNIVERSITY = "university".freeze
|
|
31
|
+
|
|
32
|
+
def self.all_vars
|
|
33
|
+
@all_vars ||= [N1, N2, N3, N4, N5, N6, N7, N8, N9, N10, N11, N12, UNIVERSITY].freeze
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Builds the enum from string
|
|
37
|
+
# @param [String] The enum value in the form of the string
|
|
38
|
+
# @return [String] The enum value
|
|
39
|
+
def self.build_from_hash(value)
|
|
40
|
+
new.build_from_hash(value)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Builds the enum from string
|
|
44
|
+
# @param [String] The enum value in the form of the string
|
|
45
|
+
# @return [String] The enum value
|
|
46
|
+
def build_from_hash(value)
|
|
47
|
+
return value if Grade.all_vars.include?(value)
|
|
48
|
+
raise "Invalid ENUM value #{value} for class #Grade"
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
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,14 +15,13 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# A group of users
|
|
18
|
-
class Group
|
|
18
|
+
class Group < ApiModelBase
|
|
19
19
|
# The unique identifier of the group
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
22
22
|
# The display name of the group
|
|
23
23
|
attr_accessor :name
|
|
24
24
|
|
|
25
|
-
# The type of the group: * `generic`: A group created by a Flat user * `classTeachers`: A group created automaticaly by Flat that contains the teachers of a class * `classStudents`: A group created automaticaly by Flat that contains the studnets of a class
|
|
26
25
|
attr_accessor :type
|
|
27
26
|
|
|
28
27
|
# The number of users in this group
|
|
@@ -72,9 +71,14 @@ module FlatApi
|
|
|
72
71
|
}
|
|
73
72
|
end
|
|
74
73
|
|
|
74
|
+
# Returns attribute mapping this model knows about
|
|
75
|
+
def self.acceptable_attribute_map
|
|
76
|
+
attribute_map
|
|
77
|
+
end
|
|
78
|
+
|
|
75
79
|
# Returns all the JSON keys this model knows about
|
|
76
80
|
def self.acceptable_attributes
|
|
77
|
-
|
|
81
|
+
acceptable_attribute_map.values
|
|
78
82
|
end
|
|
79
83
|
|
|
80
84
|
# Attribute type mapping.
|
|
@@ -82,7 +86,7 @@ module FlatApi
|
|
|
82
86
|
{
|
|
83
87
|
:'id' => :'String',
|
|
84
88
|
:'name' => :'String',
|
|
85
|
-
:'type' => :'
|
|
89
|
+
:'type' => :'GroupType',
|
|
86
90
|
:'users_count' => :'Float',
|
|
87
91
|
:'read_only' => :'Boolean',
|
|
88
92
|
:'organization' => :'String',
|
|
@@ -104,9 +108,10 @@ module FlatApi
|
|
|
104
108
|
end
|
|
105
109
|
|
|
106
110
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
111
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
107
112
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
108
|
-
if (!
|
|
109
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::Group`. Please check the name to make sure it's valid. List of attributes: " +
|
|
113
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
114
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::Group`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
110
115
|
end
|
|
111
116
|
h[k.to_sym] = v
|
|
112
117
|
}
|
|
@@ -152,21 +157,9 @@ module FlatApi
|
|
|
152
157
|
# @return true if the model is valid
|
|
153
158
|
def valid?
|
|
154
159
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
155
|
-
type_validator = EnumAttributeValidator.new('String', ["generic", "classTeachers", "classStudents"])
|
|
156
|
-
return false unless type_validator.valid?(@type)
|
|
157
160
|
true
|
|
158
161
|
end
|
|
159
162
|
|
|
160
|
-
# Custom attribute writer method checking allowed values (enum).
|
|
161
|
-
# @param [Object] type Object to be assigned
|
|
162
|
-
def type=(type)
|
|
163
|
-
validator = EnumAttributeValidator.new('String', ["generic", "classTeachers", "classStudents"])
|
|
164
|
-
unless validator.valid?(type)
|
|
165
|
-
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
|
166
|
-
end
|
|
167
|
-
@type = type
|
|
168
|
-
end
|
|
169
|
-
|
|
170
163
|
# Checks equality by comparing each attribute.
|
|
171
164
|
# @param [Object] Object to be compared
|
|
172
165
|
def ==(o)
|
|
@@ -216,61 +209,6 @@ module FlatApi
|
|
|
216
209
|
new(transformed_hash)
|
|
217
210
|
end
|
|
218
211
|
|
|
219
|
-
# Deserializes the data based on type
|
|
220
|
-
# @param string type Data type
|
|
221
|
-
# @param string value Value to be deserialized
|
|
222
|
-
# @return [Object] Deserialized data
|
|
223
|
-
def self._deserialize(type, value)
|
|
224
|
-
case type.to_sym
|
|
225
|
-
when :Time
|
|
226
|
-
Time.parse(value)
|
|
227
|
-
when :Date
|
|
228
|
-
Date.parse(value)
|
|
229
|
-
when :String
|
|
230
|
-
value.to_s
|
|
231
|
-
when :Integer
|
|
232
|
-
value.to_i
|
|
233
|
-
when :Float
|
|
234
|
-
value.to_f
|
|
235
|
-
when :Boolean
|
|
236
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
237
|
-
true
|
|
238
|
-
else
|
|
239
|
-
false
|
|
240
|
-
end
|
|
241
|
-
when :Object
|
|
242
|
-
# generic object (usually a Hash), return directly
|
|
243
|
-
value
|
|
244
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
245
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
246
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
247
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
248
|
-
k_type = Regexp.last_match[:k_type]
|
|
249
|
-
v_type = Regexp.last_match[:v_type]
|
|
250
|
-
{}.tap do |hash|
|
|
251
|
-
value.each do |k, v|
|
|
252
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
253
|
-
end
|
|
254
|
-
end
|
|
255
|
-
else # model
|
|
256
|
-
# models (e.g. Pet) or oneOf
|
|
257
|
-
klass = FlatApi.const_get(type)
|
|
258
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
259
|
-
end
|
|
260
|
-
end
|
|
261
|
-
|
|
262
|
-
# Returns the string representation of the object
|
|
263
|
-
# @return [String] String presentation of the object
|
|
264
|
-
def to_s
|
|
265
|
-
to_hash.to_s
|
|
266
|
-
end
|
|
267
|
-
|
|
268
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
269
|
-
# @return [Hash] Returns the object in the form of hash
|
|
270
|
-
def to_body
|
|
271
|
-
to_hash
|
|
272
|
-
end
|
|
273
|
-
|
|
274
212
|
# Returns the object in the form of hash
|
|
275
213
|
# @return [Hash] Returns the object in the form of hash
|
|
276
214
|
def to_hash
|
|
@@ -287,24 +225,6 @@ module FlatApi
|
|
|
287
225
|
hash
|
|
288
226
|
end
|
|
289
227
|
|
|
290
|
-
# Outputs non-array value in the form of hash
|
|
291
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
292
|
-
# @param [Object] value Any valid value
|
|
293
|
-
# @return [Hash] Returns the value in the form of hash
|
|
294
|
-
def _to_hash(value)
|
|
295
|
-
if value.is_a?(Array)
|
|
296
|
-
value.compact.map { |v| _to_hash(v) }
|
|
297
|
-
elsif value.is_a?(Hash)
|
|
298
|
-
{}.tap do |hash|
|
|
299
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
300
|
-
end
|
|
301
|
-
elsif value.respond_to? :to_hash
|
|
302
|
-
value.to_hash
|
|
303
|
-
else
|
|
304
|
-
value
|
|
305
|
-
end
|
|
306
|
-
end
|
|
307
|
-
|
|
308
228
|
end
|
|
309
229
|
|
|
310
230
|
end
|