flat_api 0.2.0 → 0.3.5
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 +5 -5
- data/lib/flat_api/api/account_api.rb +31 -21
- data/lib/flat_api/api/class_api.rb +1405 -405
- data/lib/flat_api/api/collection_api.rb +257 -169
- data/lib/flat_api/api/edu_resources_api.rb +851 -0
- data/lib/flat_api/api/group_api.rb +81 -55
- data/lib/flat_api/api/organization_api.rb +524 -180
- data/lib/flat_api/api/score_api.rb +944 -552
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +112 -74
- data/lib/flat_api/api_client.rb +112 -107
- data/lib/flat_api/api_error.rb +24 -4
- data/lib/flat_api/configuration.rb +105 -16
- data/lib/flat_api/models/api_access_token.rb +268 -0
- data/lib/flat_api/models/app_scopes.rb +59 -0
- data/lib/flat_api/models/assignment.rb +192 -101
- data/lib/flat_api/models/assignment_capabilities.rb +283 -0
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +240 -0
- data/lib/flat_api/models/assignment_copy.rb +80 -169
- data/lib/flat_api/models/assignment_copy_response.rb +430 -0
- data/lib/flat_api/models/assignment_copy_to_class.rb +243 -0
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +233 -0
- data/lib/flat_api/models/assignment_submission.rb +249 -66
- data/lib/flat_api/models/assignment_submission_comment.rb +276 -0
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +223 -0
- data/lib/flat_api/models/assignment_submission_comments.rb +225 -0
- data/lib/flat_api/models/assignment_submission_history.rb +384 -0
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +235 -0
- data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
- data/lib/flat_api/models/assignment_submission_lti.rb +222 -0
- data/lib/flat_api/models/assignment_submission_playback_inner.rb +240 -0
- data/lib/flat_api/models/assignment_submission_state.rb +42 -0
- data/lib/flat_api/models/assignment_submission_update.rb +150 -50
- data/lib/flat_api/models/assignment_type.rb +44 -0
- data/lib/flat_api/models/assignment_update.rb +407 -0
- data/lib/flat_api/models/class_assignment.rb +613 -0
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +226 -0
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +216 -0
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +226 -0
- data/lib/flat_api/models/class_assignment_update.rb +509 -0
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +217 -0
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +219 -0
- data/lib/flat_api/models/class_attachment_creation.rb +110 -41
- data/lib/flat_api/models/class_creation.rb +144 -43
- data/lib/flat_api/models/class_details.rb +175 -60
- data/lib/flat_api/models/class_details_canvas.rb +61 -34
- data/lib/flat_api/models/class_details_clever.rb +76 -48
- data/lib/flat_api/models/class_details_google_classroom.rb +66 -59
- data/lib/flat_api/models/class_details_google_drive.rb +63 -36
- data/lib/flat_api/models/class_details_issues.rb +218 -0
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +270 -0
- data/lib/flat_api/models/class_details_lti.rb +65 -38
- data/lib/flat_api/models/class_details_mfc.rb +226 -0
- data/lib/flat_api/models/class_details_microsoft_graph.rb +215 -0
- data/lib/flat_api/models/class_grade_level.rb +43 -0
- data/lib/flat_api/models/class_roles.rb +18 -9
- data/lib/flat_api/models/class_state.rb +18 -9
- data/lib/flat_api/models/class_update.rb +144 -42
- data/lib/flat_api/models/collection.rb +138 -50
- data/lib/flat_api/models/collection_app.rb +236 -0
- data/lib/flat_api/models/collection_capabilities.rb +109 -47
- data/lib/flat_api/models/collection_creation.rb +132 -37
- data/lib/flat_api/models/collection_modification.rb +122 -35
- data/lib/flat_api/models/collection_privacy.rb +18 -9
- data/lib/flat_api/models/collection_type.rb +19 -9
- data/lib/flat_api/models/edu_library.rb +292 -0
- data/lib/flat_api/models/edu_resource.rb +366 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +236 -0
- data/lib/flat_api/models/edu_resource_copy.rb +223 -0
- data/lib/flat_api/models/edu_resource_creation.rb +301 -0
- data/lib/flat_api/models/edu_resource_folder.rb +216 -0
- data/lib/flat_api/models/edu_resource_lti_link.rb +223 -0
- data/lib/flat_api/models/edu_resource_move.rb +223 -0
- data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
- data/lib/flat_api/models/edu_resource_resource.rb +105 -0
- data/lib/flat_api/models/edu_resource_type.rb +40 -0
- data/lib/flat_api/models/edu_resource_update.rb +277 -0
- data/lib/flat_api/models/edu_resource_use_in_class.rb +233 -0
- data/lib/flat_api/models/flat_error_response.rb +79 -38
- data/lib/flat_api/models/flat_locales.rb +30 -10
- data/lib/flat_api/models/google_classroom_coursework.rb +76 -38
- data/lib/flat_api/models/google_classroom_submission.rb +84 -36
- data/lib/flat_api/models/group.rb +72 -44
- data/lib/flat_api/models/group_details.rb +92 -43
- data/lib/flat_api/models/group_type.rb +18 -9
- data/lib/flat_api/models/license_mode.rb +18 -9
- data/lib/flat_api/models/license_sources.rb +21 -9
- data/lib/flat_api/models/lms_name.rb +19 -9
- data/lib/flat_api/models/lti_credentials.rb +95 -46
- data/lib/flat_api/models/lti_credentials_creation.rb +91 -38
- data/lib/flat_api/models/media_attachment.rb +167 -70
- data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
- data/lib/flat_api/models/microsoft_graph_assignment.rb +248 -0
- data/lib/flat_api/models/microsoft_graph_submission.rb +240 -0
- data/lib/flat_api/models/organization_invitation.rb +139 -44
- data/lib/flat_api/models/organization_invitation_creation.rb +99 -35
- data/lib/flat_api/models/organization_roles.rb +18 -9
- data/lib/flat_api/models/organization_user_access_token_creation.rb +225 -0
- data/lib/flat_api/models/resource_collaborator.rb +181 -51
- data/lib/flat_api/models/resource_collaborator_creation.rb +74 -47
- data/lib/flat_api/models/resource_rights.rb +145 -42
- data/lib/flat_api/models/score_comment.rb +93 -56
- data/lib/flat_api/models/score_comment_context.rb +103 -59
- data/lib/flat_api/models/score_comment_creation.rb +70 -41
- data/lib/flat_api/models/score_comment_moderation.rb +260 -0
- data/lib/flat_api/models/score_comment_update.rb +82 -49
- data/lib/flat_api/models/score_comments_counts.rb +67 -40
- data/lib/flat_api/models/score_creation.rb +81 -225
- data/lib/flat_api/models/score_creation_builder_data.rb +298 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +230 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +322 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +274 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +269 -0
- data/lib/flat_api/models/score_creation_common.rb +268 -0
- data/lib/flat_api/models/score_creation_file_import.rb +324 -0
- data/lib/flat_api/models/score_creation_google_drive_import.rb +291 -0
- data/lib/flat_api/models/score_creation_type.rb +19 -9
- data/lib/flat_api/models/score_details.rb +272 -81
- data/lib/flat_api/models/score_fork.rb +88 -36
- data/lib/flat_api/models/score_license.rb +19 -9
- data/lib/flat_api/models/score_likes_counts.rb +83 -35
- data/lib/flat_api/models/score_modification.rb +180 -50
- data/lib/flat_api/models/score_plays_counts.rb +236 -0
- data/lib/flat_api/models/score_privacy.rb +18 -9
- data/lib/flat_api/models/score_revision.rb +80 -43
- data/lib/flat_api/models/score_revision_creation.rb +105 -40
- data/lib/flat_api/models/score_revision_statistics.rb +83 -36
- data/lib/flat_api/models/score_source.rb +61 -35
- data/lib/flat_api/models/score_summary.rb +124 -40
- data/lib/flat_api/models/score_track.rb +172 -51
- data/lib/flat_api/models/score_track_creation.rb +101 -39
- data/lib/flat_api/models/score_track_point.rb +70 -38
- data/lib/flat_api/models/score_track_purpose.rb +40 -0
- data/lib/flat_api/models/score_track_state.rb +18 -9
- data/lib/flat_api/models/score_track_type.rb +18 -9
- data/lib/flat_api/models/score_track_update.rb +88 -37
- data/lib/flat_api/models/score_views_counts.rb +62 -35
- data/lib/flat_api/models/task.rb +364 -0
- data/lib/flat_api/models/task_export_options.rb +218 -0
- data/lib/flat_api/models/task_progress.rb +226 -0
- data/lib/flat_api/models/task_result.rb +226 -0
- data/lib/flat_api/models/tutteo_product.rb +42 -0
- data/lib/flat_api/models/user_admin_update.rb +219 -41
- data/lib/flat_api/models/user_azure_details.rb +235 -0
- data/lib/flat_api/models/user_basics.rb +187 -55
- data/lib/flat_api/models/user_community_profile_links.rb +272 -0
- data/lib/flat_api/models/user_creation.rb +215 -49
- data/lib/flat_api/models/user_details.rb +258 -93
- data/lib/flat_api/models/user_details_admin.rb +220 -68
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +278 -0
- data/lib/flat_api/models/user_public.rb +242 -79
- data/lib/flat_api/models/user_public_summary.rb +201 -61
- data/lib/flat_api/models/user_signin_link.rb +225 -0
- data/lib/flat_api/models/user_signin_link_creation.rb +217 -0
- data/lib/flat_api/version.rb +5 -5
- data/lib/flat_api.rb +78 -15
- data/spec/api/account_api_spec.rb +11 -10
- data/spec/api/class_api_spec.rb +212 -68
- data/spec/api/collection_api_spec.rb +36 -37
- data/spec/api/edu_resources_api_spec.rb +181 -0
- data/spec/api/group_api_spec.rb +14 -15
- data/spec/api/organization_api_spec.rb +78 -39
- data/spec/api/score_api_spec.rb +105 -91
- data/spec/api/task_api_spec.rb +47 -0
- data/spec/api/user_api_spec.rb +27 -25
- data/spec/models/api_access_token_spec.rb +66 -0
- data/spec/models/app_scopes_spec.rb +30 -0
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +42 -0
- data/spec/models/assignment_capabilities_spec.rb +60 -0
- data/spec/models/assignment_copy_response_spec.rb +124 -0
- data/spec/models/assignment_copy_spec.rb +13 -23
- data/spec/models/assignment_copy_to_class_spec.rb +48 -0
- data/spec/models/assignment_copy_to_resource_library_spec.rb +42 -0
- data/spec/models/assignment_spec.rb +51 -39
- data/spec/models/assignment_submission_comment_creation_spec.rb +36 -0
- data/spec/models/assignment_submission_comment_spec.rb +72 -0
- data/spec/models/assignment_submission_comments_spec.rb +42 -0
- data/spec/models/assignment_submission_history_attachment_spec.rb +48 -0
- data/spec/models/assignment_submission_history_spec.rb +112 -0
- data/spec/models/assignment_submission_history_state_spec.rb +30 -0
- data/spec/models/assignment_submission_lti_spec.rb +36 -0
- data/spec/models/assignment_submission_playback_inner_spec.rb +42 -0
- data/spec/models/assignment_submission_spec.rb +68 -32
- data/spec/models/assignment_submission_state_spec.rb +30 -0
- data/spec/models/assignment_submission_update_spec.rb +29 -23
- data/spec/models/assignment_type_spec.rb +30 -0
- data/spec/models/assignment_update_spec.rb +100 -0
- data/spec/models/class_assignment_all_of_canvas_spec.rb +42 -0
- data/spec/models/class_assignment_all_of_lti_spec.rb +36 -0
- data/spec/models/class_assignment_all_of_mfc_spec.rb +42 -0
- data/spec/models/class_assignment_spec.rb +216 -0
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +36 -0
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +36 -0
- data/spec/models/class_assignment_update_spec.rb +150 -0
- data/spec/models/class_attachment_creation_spec.rb +41 -23
- data/spec/models/class_creation_spec.rb +34 -18
- data/spec/models/class_details_canvas_spec.rb +12 -18
- data/spec/models/class_details_clever_spec.rb +21 -27
- data/spec/models/class_details_google_classroom_spec.rb +12 -30
- data/spec/models/class_details_google_drive_spec.rb +12 -18
- data/spec/models/class_details_issues_spec.rb +36 -0
- data/spec/models/class_details_issues_sync_inner_spec.rb +52 -0
- data/spec/models/class_details_lti_spec.rb +13 -19
- data/spec/models/class_details_mfc_spec.rb +42 -0
- data/spec/models/class_details_microsoft_graph_spec.rb +36 -0
- data/spec/models/class_details_spec.rb +68 -34
- data/spec/models/class_grade_level_spec.rb +30 -0
- data/spec/models/class_roles_spec.rb +10 -16
- data/spec/models/class_state_spec.rb +10 -16
- data/spec/models/class_update_spec.rb +34 -18
- data/spec/models/collection_app_spec.rb +48 -0
- data/spec/models/collection_capabilities_spec.rb +15 -21
- data/spec/models/collection_creation_spec.rb +17 -17
- data/spec/models/collection_modification_spec.rb +17 -17
- data/spec/models/collection_privacy_spec.rb +10 -16
- data/spec/models/collection_spec.rb +39 -27
- data/spec/models/collection_type_spec.rb +10 -16
- data/spec/models/edu_library_spec.rb +62 -0
- data/spec/models/edu_resource_capabilities_spec.rb +48 -0
- data/spec/models/edu_resource_copy_spec.rb +36 -0
- data/spec/models/edu_resource_creation_spec.rb +48 -0
- data/spec/models/edu_resource_folder_spec.rb +36 -0
- data/spec/models/edu_resource_lti_link_spec.rb +36 -0
- data/spec/models/edu_resource_move_spec.rb +36 -0
- data/spec/models/edu_resource_privacy_spec.rb +30 -0
- data/spec/models/edu_resource_resource_spec.rb +32 -0
- data/spec/models/edu_resource_spec.rb +96 -0
- data/spec/models/edu_resource_type_spec.rb +30 -0
- data/spec/models/edu_resource_update_spec.rb +42 -0
- data/spec/models/edu_resource_use_in_class_spec.rb +42 -0
- data/spec/models/flat_error_response_spec.rb +14 -20
- data/spec/models/flat_locales_spec.rb +10 -16
- data/spec/models/google_classroom_coursework_spec.rb +19 -19
- data/spec/models/google_classroom_submission_spec.rb +13 -19
- data/spec/models/group_details_spec.rb +17 -23
- data/spec/models/group_spec.rb +21 -27
- data/spec/models/group_type_spec.rb +10 -16
- data/spec/models/license_mode_spec.rb +10 -16
- data/spec/models/license_sources_spec.rb +10 -16
- data/spec/models/lms_name_spec.rb +10 -16
- data/spec/models/lti_credentials_creation_spec.rb +12 -18
- data/spec/models/lti_credentials_spec.rb +19 -25
- data/spec/models/media_attachment_spec.rb +67 -37
- data/spec/models/media_score_sharing_mode_spec.rb +10 -16
- data/spec/models/microsoft_graph_assignment_spec.rb +54 -0
- data/spec/models/microsoft_graph_submission_spec.rb +42 -0
- data/spec/models/organization_invitation_creation_spec.rb +16 -18
- data/spec/models/organization_invitation_spec.rb +29 -23
- data/spec/models/organization_roles_spec.rb +10 -16
- data/spec/models/organization_user_access_token_creation_spec.rb +36 -0
- data/spec/models/resource_collaborator_creation_spec.rb +17 -23
- data/spec/models/resource_collaborator_spec.rb +47 -25
- data/spec/models/resource_rights_spec.rb +29 -19
- data/spec/models/score_comment_context_spec.rb +23 -23
- data/spec/models/score_comment_creation_spec.rb +16 -22
- data/spec/models/score_comment_moderation_spec.rb +46 -0
- data/spec/models/score_comment_spec.rb +35 -35
- data/spec/models/score_comment_update_spec.rb +14 -20
- data/spec/models/score_comments_counts_spec.rb +14 -20
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +82 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +60 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +66 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +42 -0
- data/spec/models/score_creation_builder_data_spec.rb +60 -0
- data/spec/models/score_creation_common_spec.rb +54 -0
- data/spec/models/score_creation_file_import_spec.rb +76 -0
- data/spec/models/score_creation_google_drive_import_spec.rb +60 -0
- data/spec/models/score_creation_spec.rb +12 -58
- data/spec/models/score_creation_type_spec.rb +10 -16
- data/spec/models/score_details_spec.rb +75 -45
- data/spec/models/score_fork_spec.rb +23 -17
- data/spec/models/score_license_spec.rb +10 -16
- data/spec/models/score_likes_counts_spec.rb +13 -19
- data/spec/models/score_modification_spec.rb +47 -23
- data/spec/models/score_plays_counts_spec.rb +48 -0
- data/spec/models/score_privacy_spec.rb +10 -16
- data/spec/models/score_revision_creation_spec.rb +18 -20
- data/spec/models/score_revision_spec.rb +23 -23
- data/spec/models/score_revision_statistics_spec.rb +24 -18
- data/spec/models/score_source_spec.rb +11 -17
- data/spec/models/score_summary_spec.rb +16 -22
- data/spec/models/score_track_creation_spec.rb +21 -21
- data/spec/models/score_track_point_spec.rb +17 -23
- data/spec/models/score_track_purpose_spec.rb +30 -0
- data/spec/models/score_track_spec.rb +28 -28
- data/spec/models/score_track_state_spec.rb +10 -16
- data/spec/models/score_track_type_spec.rb +10 -16
- data/spec/models/score_track_update_spec.rb +14 -20
- data/spec/models/score_views_counts_spec.rb +13 -19
- data/spec/models/task_export_options_spec.rb +36 -0
- data/spec/models/task_progress_spec.rb +42 -0
- data/spec/models/task_result_spec.rb +42 -0
- data/spec/models/task_spec.rb +100 -0
- data/spec/models/tutteo_product_spec.rb +30 -0
- data/spec/models/user_admin_update_spec.rb +36 -18
- data/spec/models/user_azure_details_spec.rb +48 -0
- data/spec/models/user_basics_spec.rb +47 -25
- data/spec/models/user_community_profile_links_spec.rb +66 -0
- data/spec/models/user_creation_spec.rb +36 -20
- data/spec/models/user_details_admin_all_of_license_spec.rb +60 -0
- data/spec/models/user_details_admin_spec.rb +60 -32
- data/spec/models/user_details_spec.rb +93 -45
- data/spec/models/user_public_spec.rb +71 -37
- data/spec/models/user_public_summary_spec.rb +51 -29
- data/spec/models/user_signin_link_creation_spec.rb +36 -0
- data/spec/models/user_signin_link_spec.rb +42 -0
- data/spec/spec_helper.rb +4 -4
- metadata +279 -327
- data/CHANGELOG.md +0 -17
- data/Gemfile +0 -7
- data/README.md +0 -271
- data/Rakefile +0 -8
- data/docs/AccountApi.md +0 -55
- data/docs/Assignment.md +0 -18
- data/docs/AssignmentCopy.md +0 -8
- data/docs/AssignmentCreation.md +0 -12
- data/docs/AssignmentSubmission.md +0 -19
- data/docs/AssignmentSubmissionUpdate.md +0 -11
- data/docs/ClassApi.md +0 -1051
- data/docs/ClassAttachmentCreation.md +0 -10
- data/docs/ClassCreation.md +0 -9
- data/docs/ClassDetails.md +0 -25
- data/docs/ClassDetailsCanvas.md +0 -9
- data/docs/ClassDetailsClever.md +0 -14
- data/docs/ClassDetailsGoogleClassroom.md +0 -11
- data/docs/ClassDetailsGoogleDrive.md +0 -9
- data/docs/ClassDetailsLti.md +0 -10
- data/docs/ClassRoles.md +0 -7
- data/docs/ClassState.md +0 -7
- data/docs/ClassUpdate.md +0 -9
- data/docs/Collection.md +0 -18
- data/docs/CollectionApi.md +0 -521
- data/docs/CollectionCapabilities.md +0 -12
- data/docs/CollectionCreation.md +0 -8
- data/docs/CollectionModification.md +0 -8
- data/docs/CollectionPrivacy.md +0 -7
- data/docs/CollectionTitle.md +0 -7
- data/docs/CollectionType.md +0 -7
- data/docs/FlatErrorResponse.md +0 -11
- data/docs/FlatLocales.md +0 -7
- data/docs/GoogleClassroomCoursework.md +0 -10
- data/docs/GoogleClassroomSubmission.md +0 -10
- data/docs/Group.md +0 -14
- data/docs/GroupApi.md +0 -167
- data/docs/GroupDetails.md +0 -14
- data/docs/GroupType.md +0 -7
- data/docs/LicenseMode.md +0 -7
- data/docs/LicenseSources.md +0 -7
- data/docs/LmsName.md +0 -7
- data/docs/LtiCredentials.md +0 -16
- data/docs/LtiCredentialsCreation.md +0 -9
- data/docs/MediaAttachment.md +0 -23
- data/docs/MediaScoreSharingMode.md +0 -7
- data/docs/OrganizationApi.md +0 -538
- data/docs/OrganizationInvitation.md +0 -14
- data/docs/OrganizationInvitationCreation.md +0 -9
- data/docs/OrganizationRoles.md +0 -7
- data/docs/ResourceCollaborator.md +0 -16
- data/docs/ResourceCollaboratorCreation.md +0 -14
- data/docs/ResourceRights.md +0 -10
- data/docs/ResourceSharingKey.md +0 -7
- data/docs/ScoreApi.md +0 -1658
- data/docs/ScoreComment.md +0 -22
- data/docs/ScoreCommentContext.md +0 -14
- data/docs/ScoreCommentCreation.md +0 -13
- data/docs/ScoreCommentUpdate.md +0 -11
- data/docs/ScoreCommentsCounts.md +0 -11
- data/docs/ScoreCreation.md +0 -14
- data/docs/ScoreCreationType.md +0 -7
- data/docs/ScoreData.md +0 -7
- data/docs/ScoreDataEncoding.md +0 -7
- data/docs/ScoreDetails.md +0 -36
- data/docs/ScoreFork.md +0 -8
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -14
- data/docs/ScorePrivacy.md +0 -7
- data/docs/ScoreRevision.md +0 -14
- data/docs/ScoreRevisionCreation.md +0 -11
- data/docs/ScoreRevisionStatistics.md +0 -9
- data/docs/ScoreSource.md +0 -8
- data/docs/ScoreSummary.md +0 -13
- data/docs/ScoreTrack.md +0 -19
- data/docs/ScoreTrackCreation.md +0 -12
- data/docs/ScoreTrackPoint.md +0 -10
- data/docs/ScoreTrackState.md +0 -7
- data/docs/ScoreTrackType.md +0 -7
- data/docs/ScoreTrackUpdate.md +0 -11
- data/docs/ScoreViewsCounts.md +0 -10
- data/docs/UserAdminUpdate.md +0 -9
- data/docs/UserApi.md +0 -173
- data/docs/UserBasics.md +0 -13
- data/docs/UserCreation.md +0 -11
- data/docs/UserDetails.md +0 -28
- data/docs/UserDetailsAdmin.md +0 -20
- data/docs/UserDetailsAdminLicense.md +0 -12
- data/docs/UserInstruments.md +0 -7
- data/docs/UserPublic.md +0 -25
- data/docs/UserPublicSummary.md +0 -17
- data/flat_api.gemspec +0 -48
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/collection_title.rb +0 -179
- data/lib/flat_api/models/resource_sharing_key.rb +0 -179
- data/lib/flat_api/models/score_data.rb +0 -179
- data/lib/flat_api/models/score_data_encoding.rb +0 -30
- data/lib/flat_api/models/user_details_admin_license.rb +0 -227
- data/lib/flat_api/models/user_instruments.rb +0 -179
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/collection_title_spec.rb +0 -36
- data/spec/models/resource_sharing_key_spec.rb +0 -36
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_instruments_spec.rb +0 -36
data/CHANGELOG.md
DELETED
data/Gemfile
DELETED
data/README.md
DELETED
@@ -1,271 +0,0 @@
|
|
1
|
-
# Ruby Client for the Flat REST API
|
2
|
-
|
3
|
-
[](https://travis-ci.org/FlatIO/api-client-ruby)
|
4
|
-
[](https://rubygems.org/gems/flat_api)
|
5
|
-
|
6
|
-
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:
|
7
|
-
- Creating and importing new music scores using MusicXML or MIDI files
|
8
|
-
- Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI)
|
9
|
-
- Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.
|
10
|
-
|
11
|
-
You can find the API reference including code samples and our OpenAPI Specification at the following url: [https://flat.io/developers/api/reference](https://flat.io/developers/api/reference).
|
12
|
-
|
13
|
-
To request some API credentials, please visit [https://flat.io/developers](https://flat.io/developers).
|
14
|
-
|
15
|
-
This Ruby package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.
|
16
|
-
|
17
|
-
## Installation
|
18
|
-
|
19
|
-
### Build a gem
|
20
|
-
|
21
|
-
To build the Ruby code into a gem:
|
22
|
-
|
23
|
-
```shell
|
24
|
-
gem build flat_api.gemspec
|
25
|
-
```
|
26
|
-
|
27
|
-
Then either install the gem locally:
|
28
|
-
|
29
|
-
```shell
|
30
|
-
gem install ./flat_api-0.2.0.gem
|
31
|
-
```
|
32
|
-
(for development, run `gem install --dev ./flat_api-0.2.0.gem` to install the development dependencies)
|
33
|
-
|
34
|
-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
|
-
|
36
|
-
Finally add this to the Gemfile:
|
37
|
-
|
38
|
-
gem 'flat_api', '~> 0.2.0'
|
39
|
-
|
40
|
-
### Install from Git
|
41
|
-
|
42
|
-
If the Ruby gem is hosted at a git repository: https://github.com/FlatIO/api-client-ruby, then add the following in the Gemfile:
|
43
|
-
|
44
|
-
gem 'flat_api', :git => 'https://github.com/FlatIO/api-client-ruby.git'
|
45
|
-
|
46
|
-
### Include the Ruby code directly
|
47
|
-
|
48
|
-
Include the Ruby code directly using `-I` as follows:
|
49
|
-
|
50
|
-
```shell
|
51
|
-
ruby -Ilib script.rb
|
52
|
-
```
|
53
|
-
|
54
|
-
## Getting Started
|
55
|
-
|
56
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
57
|
-
```ruby
|
58
|
-
# Load the gem
|
59
|
-
require 'flat_api'
|
60
|
-
|
61
|
-
# Setup authorization
|
62
|
-
FlatApi.configure do |config|
|
63
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
64
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
65
|
-
end
|
66
|
-
|
67
|
-
api_instance = FlatApi::AccountApi.new
|
68
|
-
|
69
|
-
begin
|
70
|
-
#Get current user profile
|
71
|
-
result = api_instance.get_authenticated_user
|
72
|
-
p result
|
73
|
-
rescue FlatApi::ApiError => e
|
74
|
-
puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
|
75
|
-
end
|
76
|
-
|
77
|
-
```
|
78
|
-
|
79
|
-
## Documentation for API Endpoints
|
80
|
-
|
81
|
-
All URIs are relative to *https://api.flat.io/v2*
|
82
|
-
|
83
|
-
Class | Method | HTTP request | Description
|
84
|
-
------------ | ------------- | ------------- | -------------
|
85
|
-
*FlatApi::AccountApi* | [**get_authenticated_user**](docs/AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
|
86
|
-
*FlatApi::ClassApi* | [**activate_class**](docs/ClassApi.md#activate_class) | **POST** /classes/{class}/activate | Activate the class
|
87
|
-
*FlatApi::ClassApi* | [**add_class_user**](docs/ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class
|
88
|
-
*FlatApi::ClassApi* | [**archive_class**](docs/ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class
|
89
|
-
*FlatApi::ClassApi* | [**copy_assignment**](docs/ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
|
90
|
-
*FlatApi::ClassApi* | [**create_assignment**](docs/ClassApi.md#create_assignment) | **POST** /classes/{class}/assignments | Assignment creation
|
91
|
-
*FlatApi::ClassApi* | [**create_class**](docs/ClassApi.md#create_class) | **POST** /classes | Create a new class
|
92
|
-
*FlatApi::ClassApi* | [**create_submission**](docs/ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
|
93
|
-
*FlatApi::ClassApi* | [**delete_class_user**](docs/ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
|
94
|
-
*FlatApi::ClassApi* | [**edit_submission**](docs/ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
|
95
|
-
*FlatApi::ClassApi* | [**enroll_class**](docs/ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class
|
96
|
-
*FlatApi::ClassApi* | [**get_class**](docs/ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class
|
97
|
-
*FlatApi::ClassApi* | [**get_score_submissions**](docs/ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
|
98
|
-
*FlatApi::ClassApi* | [**get_submission**](docs/ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
|
99
|
-
*FlatApi::ClassApi* | [**get_submissions**](docs/ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
|
100
|
-
*FlatApi::ClassApi* | [**list_assignments**](docs/ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing
|
101
|
-
*FlatApi::ClassApi* | [**list_class_student_submissions**](docs/ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
|
102
|
-
*FlatApi::ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user
|
103
|
-
*FlatApi::ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class
|
104
|
-
*FlatApi::ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class
|
105
|
-
*FlatApi::CollectionApi* | [**add_score_to_collection**](docs/CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection
|
106
|
-
*FlatApi::CollectionApi* | [**create_collection**](docs/CollectionApi.md#create_collection) | **POST** /collections | Create a new collection
|
107
|
-
*FlatApi::CollectionApi* | [**delete_collection**](docs/CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection
|
108
|
-
*FlatApi::CollectionApi* | [**delete_score_from_collection**](docs/CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection
|
109
|
-
*FlatApi::CollectionApi* | [**edit_collection**](docs/CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata
|
110
|
-
*FlatApi::CollectionApi* | [**get_collection**](docs/CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details
|
111
|
-
*FlatApi::CollectionApi* | [**list_collection_scores**](docs/CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection
|
112
|
-
*FlatApi::CollectionApi* | [**list_collections**](docs/CollectionApi.md#list_collections) | **GET** /collections | List the collections
|
113
|
-
*FlatApi::CollectionApi* | [**untrash_collection**](docs/CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection
|
114
|
-
*FlatApi::GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information
|
115
|
-
*FlatApi::GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
|
116
|
-
*FlatApi::GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users
|
117
|
-
*FlatApi::OrganizationApi* | [**create_lti_credentials**](docs/OrganizationApi.md#create_lti_credentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials
|
118
|
-
*FlatApi::OrganizationApi* | [**create_organization_invitation**](docs/OrganizationApi.md#create_organization_invitation) | **POST** /organizations/invitations | Create a new invitation to join the organization
|
119
|
-
*FlatApi::OrganizationApi* | [**create_organization_user**](docs/OrganizationApi.md#create_organization_user) | **POST** /organizations/users | Create a new user account
|
120
|
-
*FlatApi::OrganizationApi* | [**list_lti_credentials**](docs/OrganizationApi.md#list_lti_credentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials
|
121
|
-
*FlatApi::OrganizationApi* | [**list_organization_invitations**](docs/OrganizationApi.md#list_organization_invitations) | **GET** /organizations/invitations | List the organization invitations
|
122
|
-
*FlatApi::OrganizationApi* | [**list_organization_users**](docs/OrganizationApi.md#list_organization_users) | **GET** /organizations/users | List the organization users
|
123
|
-
*FlatApi::OrganizationApi* | [**remove_organization_invitation**](docs/OrganizationApi.md#remove_organization_invitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
|
124
|
-
*FlatApi::OrganizationApi* | [**remove_organization_user**](docs/OrganizationApi.md#remove_organization_user) | **DELETE** /organizations/users/{user} | Remove an account from Flat
|
125
|
-
*FlatApi::OrganizationApi* | [**revoke_lti_credentials**](docs/OrganizationApi.md#revoke_lti_credentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
|
126
|
-
*FlatApi::OrganizationApi* | [**update_organization_user**](docs/OrganizationApi.md#update_organization_user) | **PUT** /organizations/users/{user} | Update account information
|
127
|
-
*FlatApi::ScoreApi* | [**add_score_collaborator**](docs/ScoreApi.md#add_score_collaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
|
128
|
-
*FlatApi::ScoreApi* | [**add_score_track**](docs/ScoreApi.md#add_score_track) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score
|
129
|
-
*FlatApi::ScoreApi* | [**create_score**](docs/ScoreApi.md#create_score) | **POST** /scores | Create a new score
|
130
|
-
*FlatApi::ScoreApi* | [**create_score_revision**](docs/ScoreApi.md#create_score_revision) | **POST** /scores/{score}/revisions | Create a new revision
|
131
|
-
*FlatApi::ScoreApi* | [**delete_score**](docs/ScoreApi.md#delete_score) | **DELETE** /scores/{score} | Delete a score
|
132
|
-
*FlatApi::ScoreApi* | [**delete_score_comment**](docs/ScoreApi.md#delete_score_comment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment
|
133
|
-
*FlatApi::ScoreApi* | [**delete_score_track**](docs/ScoreApi.md#delete_score_track) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score
|
134
|
-
*FlatApi::ScoreApi* | [**edit_score**](docs/ScoreApi.md#edit_score) | **PUT** /scores/{score} | Edit a score's metadata
|
135
|
-
*FlatApi::ScoreApi* | [**fork_score**](docs/ScoreApi.md#fork_score) | **POST** /scores/{score}/fork | Fork a score
|
136
|
-
*FlatApi::ScoreApi* | [**ger_user_likes**](docs/ScoreApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
|
137
|
-
*FlatApi::ScoreApi* | [**get_group_scores**](docs/ScoreApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
|
138
|
-
*FlatApi::ScoreApi* | [**get_score**](docs/ScoreApi.md#get_score) | **GET** /scores/{score} | Get a score's metadata
|
139
|
-
*FlatApi::ScoreApi* | [**get_score_collaborator**](docs/ScoreApi.md#get_score_collaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator
|
140
|
-
*FlatApi::ScoreApi* | [**get_score_collaborators**](docs/ScoreApi.md#get_score_collaborators) | **GET** /scores/{score}/collaborators | List the collaborators
|
141
|
-
*FlatApi::ScoreApi* | [**get_score_comments**](docs/ScoreApi.md#get_score_comments) | **GET** /scores/{score}/comments | List comments
|
142
|
-
*FlatApi::ScoreApi* | [**get_score_revision**](docs/ScoreApi.md#get_score_revision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision
|
143
|
-
*FlatApi::ScoreApi* | [**get_score_revision_data**](docs/ScoreApi.md#get_score_revision_data) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data
|
144
|
-
*FlatApi::ScoreApi* | [**get_score_revisions**](docs/ScoreApi.md#get_score_revisions) | **GET** /scores/{score}/revisions | List the revisions
|
145
|
-
*FlatApi::ScoreApi* | [**get_score_submissions**](docs/ScoreApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
|
146
|
-
*FlatApi::ScoreApi* | [**get_score_track**](docs/ScoreApi.md#get_score_track) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score
|
147
|
-
*FlatApi::ScoreApi* | [**get_user_scores**](docs/ScoreApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
|
148
|
-
*FlatApi::ScoreApi* | [**list_score_tracks**](docs/ScoreApi.md#list_score_tracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score
|
149
|
-
*FlatApi::ScoreApi* | [**mark_score_comment_resolved**](docs/ScoreApi.md#mark_score_comment_resolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved
|
150
|
-
*FlatApi::ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
|
151
|
-
*FlatApi::ScoreApi* | [**post_score_comment**](docs/ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment
|
152
|
-
*FlatApi::ScoreApi* | [**remove_score_collaborator**](docs/ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator
|
153
|
-
*FlatApi::ScoreApi* | [**untrash_score**](docs/ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score
|
154
|
-
*FlatApi::ScoreApi* | [**update_score_comment**](docs/ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment
|
155
|
-
*FlatApi::ScoreApi* | [**update_score_track**](docs/ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score
|
156
|
-
*FlatApi::UserApi* | [**ger_user_likes**](docs/UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
|
157
|
-
*FlatApi::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile
|
158
|
-
*FlatApi::UserApi* | [**get_user_scores**](docs/UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
|
159
|
-
|
160
|
-
|
161
|
-
## Documentation for Models
|
162
|
-
|
163
|
-
- [FlatApi::Assignment](docs/Assignment.md)
|
164
|
-
- [FlatApi::AssignmentCopy](docs/AssignmentCopy.md)
|
165
|
-
- [FlatApi::AssignmentCreation](docs/AssignmentCreation.md)
|
166
|
-
- [FlatApi::AssignmentSubmission](docs/AssignmentSubmission.md)
|
167
|
-
- [FlatApi::AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)
|
168
|
-
- [FlatApi::ClassAttachmentCreation](docs/ClassAttachmentCreation.md)
|
169
|
-
- [FlatApi::ClassCreation](docs/ClassCreation.md)
|
170
|
-
- [FlatApi::ClassDetails](docs/ClassDetails.md)
|
171
|
-
- [FlatApi::ClassDetailsCanvas](docs/ClassDetailsCanvas.md)
|
172
|
-
- [FlatApi::ClassDetailsClever](docs/ClassDetailsClever.md)
|
173
|
-
- [FlatApi::ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)
|
174
|
-
- [FlatApi::ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)
|
175
|
-
- [FlatApi::ClassDetailsLti](docs/ClassDetailsLti.md)
|
176
|
-
- [FlatApi::ClassRoles](docs/ClassRoles.md)
|
177
|
-
- [FlatApi::ClassState](docs/ClassState.md)
|
178
|
-
- [FlatApi::ClassUpdate](docs/ClassUpdate.md)
|
179
|
-
- [FlatApi::Collection](docs/Collection.md)
|
180
|
-
- [FlatApi::CollectionCapabilities](docs/CollectionCapabilities.md)
|
181
|
-
- [FlatApi::CollectionCreation](docs/CollectionCreation.md)
|
182
|
-
- [FlatApi::CollectionModification](docs/CollectionModification.md)
|
183
|
-
- [FlatApi::CollectionPrivacy](docs/CollectionPrivacy.md)
|
184
|
-
- [FlatApi::CollectionTitle](docs/CollectionTitle.md)
|
185
|
-
- [FlatApi::CollectionType](docs/CollectionType.md)
|
186
|
-
- [FlatApi::FlatErrorResponse](docs/FlatErrorResponse.md)
|
187
|
-
- [FlatApi::FlatLocales](docs/FlatLocales.md)
|
188
|
-
- [FlatApi::GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
|
189
|
-
- [FlatApi::GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)
|
190
|
-
- [FlatApi::Group](docs/Group.md)
|
191
|
-
- [FlatApi::GroupDetails](docs/GroupDetails.md)
|
192
|
-
- [FlatApi::GroupType](docs/GroupType.md)
|
193
|
-
- [FlatApi::LicenseMode](docs/LicenseMode.md)
|
194
|
-
- [FlatApi::LicenseSources](docs/LicenseSources.md)
|
195
|
-
- [FlatApi::LmsName](docs/LmsName.md)
|
196
|
-
- [FlatApi::LtiCredentials](docs/LtiCredentials.md)
|
197
|
-
- [FlatApi::LtiCredentialsCreation](docs/LtiCredentialsCreation.md)
|
198
|
-
- [FlatApi::MediaAttachment](docs/MediaAttachment.md)
|
199
|
-
- [FlatApi::MediaScoreSharingMode](docs/MediaScoreSharingMode.md)
|
200
|
-
- [FlatApi::OrganizationInvitation](docs/OrganizationInvitation.md)
|
201
|
-
- [FlatApi::OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
|
202
|
-
- [FlatApi::OrganizationRoles](docs/OrganizationRoles.md)
|
203
|
-
- [FlatApi::ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md)
|
204
|
-
- [FlatApi::ResourceRights](docs/ResourceRights.md)
|
205
|
-
- [FlatApi::ResourceSharingKey](docs/ResourceSharingKey.md)
|
206
|
-
- [FlatApi::ScoreComment](docs/ScoreComment.md)
|
207
|
-
- [FlatApi::ScoreCommentContext](docs/ScoreCommentContext.md)
|
208
|
-
- [FlatApi::ScoreCommentCreation](docs/ScoreCommentCreation.md)
|
209
|
-
- [FlatApi::ScoreCommentUpdate](docs/ScoreCommentUpdate.md)
|
210
|
-
- [FlatApi::ScoreCommentsCounts](docs/ScoreCommentsCounts.md)
|
211
|
-
- [FlatApi::ScoreCreation](docs/ScoreCreation.md)
|
212
|
-
- [FlatApi::ScoreCreationType](docs/ScoreCreationType.md)
|
213
|
-
- [FlatApi::ScoreData](docs/ScoreData.md)
|
214
|
-
- [FlatApi::ScoreDataEncoding](docs/ScoreDataEncoding.md)
|
215
|
-
- [FlatApi::ScoreFork](docs/ScoreFork.md)
|
216
|
-
- [FlatApi::ScoreLicense](docs/ScoreLicense.md)
|
217
|
-
- [FlatApi::ScoreLikesCounts](docs/ScoreLikesCounts.md)
|
218
|
-
- [FlatApi::ScoreModification](docs/ScoreModification.md)
|
219
|
-
- [FlatApi::ScorePrivacy](docs/ScorePrivacy.md)
|
220
|
-
- [FlatApi::ScoreRevision](docs/ScoreRevision.md)
|
221
|
-
- [FlatApi::ScoreRevisionCreation](docs/ScoreRevisionCreation.md)
|
222
|
-
- [FlatApi::ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)
|
223
|
-
- [FlatApi::ScoreSource](docs/ScoreSource.md)
|
224
|
-
- [FlatApi::ScoreSummary](docs/ScoreSummary.md)
|
225
|
-
- [FlatApi::ScoreTrack](docs/ScoreTrack.md)
|
226
|
-
- [FlatApi::ScoreTrackCreation](docs/ScoreTrackCreation.md)
|
227
|
-
- [FlatApi::ScoreTrackPoint](docs/ScoreTrackPoint.md)
|
228
|
-
- [FlatApi::ScoreTrackState](docs/ScoreTrackState.md)
|
229
|
-
- [FlatApi::ScoreTrackType](docs/ScoreTrackType.md)
|
230
|
-
- [FlatApi::ScoreTrackUpdate](docs/ScoreTrackUpdate.md)
|
231
|
-
- [FlatApi::ScoreViewsCounts](docs/ScoreViewsCounts.md)
|
232
|
-
- [FlatApi::UserAdminUpdate](docs/UserAdminUpdate.md)
|
233
|
-
- [FlatApi::UserBasics](docs/UserBasics.md)
|
234
|
-
- [FlatApi::UserCreation](docs/UserCreation.md)
|
235
|
-
- [FlatApi::UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
|
236
|
-
- [FlatApi::UserInstruments](docs/UserInstruments.md)
|
237
|
-
- [FlatApi::ResourceCollaborator](docs/ResourceCollaborator.md)
|
238
|
-
- [FlatApi::ScoreDetails](docs/ScoreDetails.md)
|
239
|
-
- [FlatApi::UserPublicSummary](docs/UserPublicSummary.md)
|
240
|
-
- [FlatApi::UserDetailsAdmin](docs/UserDetailsAdmin.md)
|
241
|
-
- [FlatApi::UserPublic](docs/UserPublic.md)
|
242
|
-
- [FlatApi::UserDetails](docs/UserDetails.md)
|
243
|
-
|
244
|
-
|
245
|
-
## Documentation for Authorization
|
246
|
-
|
247
|
-
|
248
|
-
### OAuth2
|
249
|
-
|
250
|
-
- **Type**: OAuth
|
251
|
-
- **Flow**: accessCode
|
252
|
-
- **Authorization URL**: https://flat.io/auth/oauth
|
253
|
-
- **Scopes**:
|
254
|
-
- account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile.
|
255
|
-
- account.education_profile: Provides access to the basic person's education profile and public organization information.
|
256
|
-
- scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
|
257
|
-
- scores.social: Allow to post comments and like scores
|
258
|
-
- scores: Full, permissive scope to access all of a user's scores.
|
259
|
-
- collections.readonly: Allow read-only access to a user's collections.
|
260
|
-
- collections.add_scores: Allow to add scores to a user's collections.
|
261
|
-
- collections: Full, permissive scope to access all of a user's collections.
|
262
|
-
- edu.classes: Full, permissive scope to manage the classes.
|
263
|
-
- edu.classes.readonly: Read-only access to the classes.
|
264
|
-
- edu.assignments: Read-write access to the assignments and submissions.
|
265
|
-
- edu.assignments.readonly: Read-only access to the assignments and submissions.
|
266
|
-
- edu.admin: Full, permissive scope to manage all the admin of an organization.
|
267
|
-
- edu.admin.lti: Access and manage the LTI Credentials for an organization.
|
268
|
-
- edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
|
269
|
-
- edu.admin.users: Access and manage the users and invitations of the organization.
|
270
|
-
- edu.admin.users.readonly: Read-only access to the users and invitations of the organization.
|
271
|
-
|
data/Rakefile
DELETED
data/docs/AccountApi.md
DELETED
@@ -1,55 +0,0 @@
|
|
1
|
-
# FlatApi::AccountApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.flat.io/v2*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_authenticated_user**](AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
|
8
|
-
|
9
|
-
|
10
|
-
# **get_authenticated_user**
|
11
|
-
> UserDetails get_authenticated_user
|
12
|
-
|
13
|
-
Get current user profile
|
14
|
-
|
15
|
-
Get details about the current authenticated User.
|
16
|
-
|
17
|
-
### Example
|
18
|
-
```ruby
|
19
|
-
# load the gem
|
20
|
-
require 'flat_api'
|
21
|
-
# setup authorization
|
22
|
-
FlatApi.configure do |config|
|
23
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
24
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
25
|
-
end
|
26
|
-
|
27
|
-
api_instance = FlatApi::AccountApi.new
|
28
|
-
|
29
|
-
begin
|
30
|
-
#Get current user profile
|
31
|
-
result = api_instance.get_authenticated_user
|
32
|
-
p result
|
33
|
-
rescue FlatApi::ApiError => e
|
34
|
-
puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
|
35
|
-
end
|
36
|
-
```
|
37
|
-
|
38
|
-
### Parameters
|
39
|
-
This endpoint does not need any parameter.
|
40
|
-
|
41
|
-
### Return type
|
42
|
-
|
43
|
-
[**UserDetails**](UserDetails.md)
|
44
|
-
|
45
|
-
### Authorization
|
46
|
-
|
47
|
-
[OAuth2](../README.md#OAuth2)
|
48
|
-
|
49
|
-
### HTTP request headers
|
50
|
-
|
51
|
-
- **Content-Type**: application/json
|
52
|
-
- **Accept**: application/json
|
53
|
-
|
54
|
-
|
55
|
-
|
data/docs/Assignment.md
DELETED
@@ -1,18 +0,0 @@
|
|
1
|
-
# FlatApi::Assignment
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**state** | **String** | State of the assignment | [optional]
|
7
|
-
**title** | **String** | Title of the assignment | [optional]
|
8
|
-
**classroom** | **String** | The unique identifier of the class where this assignment was posted | [optional]
|
9
|
-
**description** | **String** | Description and content of the assignment | [optional]
|
10
|
-
**attachments** | [**Array<MediaAttachment>**](MediaAttachment.md) | | [optional]
|
11
|
-
**submissions** | [**Array<AssignmentSubmission>**](AssignmentSubmission.md) | | [optional]
|
12
|
-
**creator** | **String** | The User unique identifier of the creator of this assignment | [optional]
|
13
|
-
**creation_date** | **DateTime** | The creation date of this assignment | [optional]
|
14
|
-
**scheduled_date** | **DateTime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. | [optional]
|
15
|
-
**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due. | [optional]
|
16
|
-
**google_classroom** | [**GoogleClassroomCoursework**](GoogleClassroomCoursework.md) | | [optional]
|
17
|
-
|
18
|
-
|
data/docs/AssignmentCopy.md
DELETED
data/docs/AssignmentCreation.md
DELETED
@@ -1,12 +0,0 @@
|
|
1
|
-
# FlatApi::AssignmentCreation
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**title** | **String** | Title of the assignment | [optional]
|
7
|
-
**description** | **String** | Description and content of the assignment | [optional]
|
8
|
-
**attachments** | [**Array<ClassAttachmentCreation>**](ClassAttachmentCreation.md) | | [optional]
|
9
|
-
**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won't have a due date. | [optional]
|
10
|
-
**scheduled_date** | **DateTime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. | [optional]
|
11
|
-
|
12
|
-
|
@@ -1,19 +0,0 @@
|
|
1
|
-
# FlatApi::AssignmentSubmission
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **String** | Unique identifier of the submission | [optional]
|
7
|
-
**classroom** | **String** | Unique identifier of the classroom where the assignment was posted | [optional]
|
8
|
-
**assignment** | **String** | Unique identifier of the assignment | [optional]
|
9
|
-
**creator** | **String** | The User identifier of the student who created the submission | [optional]
|
10
|
-
**creation_date** | **String** | The date when the submission was created | [optional]
|
11
|
-
**attachments** | [**Array<MediaAttachment>**](MediaAttachment.md) | | [optional]
|
12
|
-
**submission_date** | **String** | The date when the student submitted his work | [optional]
|
13
|
-
**student_comment** | **String** | An optionnal comment sent by the student when submitting his work | [optional]
|
14
|
-
**return_date** | **String** | The date when the teacher returned the work | [optional]
|
15
|
-
**return_feedback** | **String** | The feedback associated with the return | [optional]
|
16
|
-
**return_creator** | **String** | The User unique identifier of the teacher who returned the submission | [optional]
|
17
|
-
**google_classroom** | [**GoogleClassroomSubmission**](GoogleClassroomSubmission.md) | | [optional]
|
18
|
-
|
19
|
-
|
@@ -1,11 +0,0 @@
|
|
1
|
-
# FlatApi::AssignmentSubmissionUpdate
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**attachments** | [**Array<ClassAttachmentCreation>**](ClassAttachmentCreation.md) | | [optional]
|
7
|
-
**student_comment** | **String** | An optionnal comment sent by the student when submitting his work | [optional]
|
8
|
-
**submit** | **BOOLEAN** | If `true`, the submission will be marked as done | [optional]
|
9
|
-
**return_feedback** | **String** | The feedback associated with the return | [optional]
|
10
|
-
|
11
|
-
|