flat_api 0.1.2 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- 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 +684 -0
- 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 +1034 -570
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +114 -76
- 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 +373 -0
- data/lib/flat_api/models/collection_app.rb +236 -0
- data/lib/flat_api/models/collection_capabilities.rb +291 -0
- data/lib/flat_api/models/collection_creation.rb +288 -0
- data/lib/flat_api/models/collection_modification.rb +275 -0
- data/lib/flat_api/models/collection_privacy.rb +39 -0
- data/lib/flat_api/models/collection_type.rb +44 -0
- 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 +403 -0
- data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +85 -48
- data/lib/flat_api/models/resource_rights.rb +318 -0
- 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 -215
- 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 +274 -83
- data/lib/flat_api/models/score_fork.rb +94 -32
- 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 +175 -52
- 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 +87 -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 +158 -0
- 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 +139 -110
- data/spec/api/task_api_spec.rb +47 -0
- data/spec/api/user_api_spec.rb +28 -26
- 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 +60 -0
- data/spec/models/collection_creation_spec.rb +42 -0
- data/spec/models/collection_modification_spec.rb +42 -0
- data/spec/models/collection_privacy_spec.rb +30 -0
- data/spec/models/collection_spec.rb +114 -0
- data/spec/models/collection_type_spec.rb +30 -0
- 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 +72 -0
- data/spec/models/resource_collaborator_spec.rb +112 -0
- data/spec/models/resource_rights_spec.rb +64 -0
- 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 -52
- 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 +27 -15
- 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 +51 -21
- 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 +299 -312
- data/CHANGELOG.md +0 -13
- data/Gemfile +0 -7
- data/README.md +0 -249
- 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/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/ScoreApi.md +0 -1605
- data/docs/ScoreCollaborator.md +0 -15
- data/docs/ScoreCollaboratorCreation.md +0 -13
- 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 -13
- 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 -7
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -13
- 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/ScoreRights.md +0 -10
- 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/git_push.sh +0 -55
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/score_collaborator.rb +0 -263
- 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/score_rights.rb +0 -215
- 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/score_collaborator_creation_spec.rb +0 -72
- data/spec/models/score_collaborator_spec.rb +0 -84
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/score_rights_spec.rb +0 -48
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_instruments_spec.rb +0 -36
@@ -1,16 +1,17 @@
|
|
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
|
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * 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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.20.0
|
7
7
|
Contact: developers@flat.io
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module FlatApi
|
16
17
|
# User details (view for organization teacher / admin)
|
@@ -18,20 +19,31 @@ module FlatApi
|
|
18
19
|
# The user unique identifier
|
19
20
|
attr_accessor :id
|
20
21
|
|
22
|
+
# The type of user account
|
23
|
+
attr_accessor :type
|
24
|
+
|
25
|
+
attr_accessor :product
|
26
|
+
|
21
27
|
# The user name (unique for the organization)
|
22
28
|
attr_accessor :username
|
23
29
|
|
24
|
-
#
|
25
|
-
attr_accessor :name
|
26
|
-
|
27
|
-
# The name that can be directly printed (name or username)
|
30
|
+
# The name that can be directly printed (name, firstname & lastname, or username)
|
28
31
|
attr_accessor :printable_name
|
29
32
|
|
30
|
-
#
|
33
|
+
# Firstname of the user (for education users)
|
34
|
+
attr_accessor :firstname
|
35
|
+
|
36
|
+
# Lastname of the user (for education users)
|
37
|
+
attr_accessor :lastname
|
38
|
+
|
39
|
+
# A displayable name for the user (for consumer users)
|
40
|
+
attr_accessor :name
|
41
|
+
|
42
|
+
# The URL of the picture to display
|
31
43
|
attr_accessor :picture
|
32
44
|
|
33
|
-
#
|
34
|
-
attr_accessor :
|
45
|
+
# List of badges for the user profile: - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge`
|
46
|
+
attr_accessor :badges
|
35
47
|
|
36
48
|
# Organization ID (for Edu users only)
|
37
49
|
attr_accessor :organization
|
@@ -51,118 +63,245 @@ module FlatApi
|
|
51
63
|
|
52
64
|
attr_accessor :license
|
53
65
|
|
66
|
+
# For Flat for Education accounts, list of Group identifiers the user is part of.
|
67
|
+
attr_accessor :groups
|
68
|
+
|
69
|
+
class EnumAttributeValidator
|
70
|
+
attr_reader :datatype
|
71
|
+
attr_reader :allowable_values
|
72
|
+
|
73
|
+
def initialize(datatype, allowable_values)
|
74
|
+
@allowable_values = allowable_values.map do |value|
|
75
|
+
case datatype.to_s
|
76
|
+
when /Integer/i
|
77
|
+
value.to_i
|
78
|
+
when /Float/i
|
79
|
+
value.to_f
|
80
|
+
else
|
81
|
+
value
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
def valid?(value)
|
87
|
+
!value || allowable_values.include?(value)
|
88
|
+
end
|
89
|
+
end
|
54
90
|
|
55
91
|
# Attribute mapping from ruby-style variable name to JSON key.
|
56
92
|
def self.attribute_map
|
57
93
|
{
|
58
94
|
:'id' => :'id',
|
95
|
+
:'type' => :'type',
|
96
|
+
:'product' => :'product',
|
59
97
|
:'username' => :'username',
|
60
|
-
:'name' => :'name',
|
61
98
|
:'printable_name' => :'printableName',
|
99
|
+
:'firstname' => :'firstname',
|
100
|
+
:'lastname' => :'lastname',
|
101
|
+
:'name' => :'name',
|
62
102
|
:'picture' => :'picture',
|
63
|
-
:'
|
103
|
+
:'badges' => :'badges',
|
64
104
|
:'organization' => :'organization',
|
65
105
|
:'organization_role' => :'organizationRole',
|
66
106
|
:'class_role' => :'classRole',
|
67
107
|
:'html_url' => :'htmlUrl',
|
68
108
|
:'email' => :'email',
|
69
109
|
:'last_activity_date' => :'lastActivityDate',
|
70
|
-
:'license' => :'license'
|
110
|
+
:'license' => :'license',
|
111
|
+
:'groups' => :'groups'
|
71
112
|
}
|
72
113
|
end
|
73
114
|
|
115
|
+
# Returns all the JSON keys this model knows about
|
116
|
+
def self.acceptable_attributes
|
117
|
+
attribute_map.values
|
118
|
+
end
|
119
|
+
|
74
120
|
# Attribute type mapping.
|
75
|
-
def self.
|
121
|
+
def self.openapi_types
|
76
122
|
{
|
77
123
|
:'id' => :'String',
|
124
|
+
:'type' => :'String',
|
125
|
+
:'product' => :'TutteoProduct',
|
78
126
|
:'username' => :'String',
|
79
|
-
:'name' => :'String',
|
80
127
|
:'printable_name' => :'String',
|
128
|
+
:'firstname' => :'String',
|
129
|
+
:'lastname' => :'String',
|
130
|
+
:'name' => :'String',
|
81
131
|
:'picture' => :'String',
|
82
|
-
:'
|
132
|
+
:'badges' => :'Array<String>',
|
83
133
|
:'organization' => :'String',
|
84
134
|
:'organization_role' => :'OrganizationRoles',
|
85
135
|
:'class_role' => :'ClassRoles',
|
86
136
|
:'html_url' => :'String',
|
87
137
|
:'email' => :'String',
|
88
|
-
:'last_activity_date' => :'
|
89
|
-
:'license' => :'
|
138
|
+
:'last_activity_date' => :'Time',
|
139
|
+
:'license' => :'UserDetailsAdminAllOfLicense',
|
140
|
+
:'groups' => :'Array<String>'
|
90
141
|
}
|
91
142
|
end
|
92
143
|
|
144
|
+
# List of attributes with nullable: true
|
145
|
+
def self.openapi_nullable
|
146
|
+
Set.new([
|
147
|
+
:'picture',
|
148
|
+
])
|
149
|
+
end
|
150
|
+
|
151
|
+
# List of class defined in allOf (OpenAPI v3)
|
152
|
+
def self.openapi_all_of
|
153
|
+
[
|
154
|
+
:'UserPublicSummary'
|
155
|
+
]
|
156
|
+
end
|
157
|
+
|
93
158
|
# Initializes the object
|
94
159
|
# @param [Hash] attributes Model attributes in the form of hash
|
95
160
|
def initialize(attributes = {})
|
96
|
-
|
161
|
+
if (!attributes.is_a?(Hash))
|
162
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserDetailsAdmin` initialize method"
|
163
|
+
end
|
97
164
|
|
98
|
-
# convert string to symbol for hash key
|
99
|
-
attributes = attributes.each_with_object({}){|(k,v), h|
|
165
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
166
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
167
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
168
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserDetailsAdmin`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
169
|
+
end
|
170
|
+
h[k.to_sym] = v
|
171
|
+
}
|
100
172
|
|
101
|
-
if attributes.
|
173
|
+
if attributes.key?(:'id')
|
102
174
|
self.id = attributes[:'id']
|
175
|
+
else
|
176
|
+
self.id = nil
|
177
|
+
end
|
178
|
+
|
179
|
+
if attributes.key?(:'type')
|
180
|
+
self.type = attributes[:'type']
|
181
|
+
else
|
182
|
+
self.type = nil
|
103
183
|
end
|
104
184
|
|
105
|
-
if attributes.
|
185
|
+
if attributes.key?(:'product')
|
186
|
+
self.product = attributes[:'product']
|
187
|
+
else
|
188
|
+
self.product = 'flat'
|
189
|
+
end
|
190
|
+
|
191
|
+
if attributes.key?(:'username')
|
106
192
|
self.username = attributes[:'username']
|
193
|
+
else
|
194
|
+
self.username = nil
|
107
195
|
end
|
108
196
|
|
109
|
-
if attributes.
|
110
|
-
self.
|
197
|
+
if attributes.key?(:'printable_name')
|
198
|
+
self.printable_name = attributes[:'printable_name']
|
199
|
+
end
|
200
|
+
|
201
|
+
if attributes.key?(:'firstname')
|
202
|
+
self.firstname = attributes[:'firstname']
|
203
|
+
end
|
204
|
+
|
205
|
+
if attributes.key?(:'lastname')
|
206
|
+
self.lastname = attributes[:'lastname']
|
111
207
|
end
|
112
208
|
|
113
|
-
if attributes.
|
114
|
-
self.
|
209
|
+
if attributes.key?(:'name')
|
210
|
+
self.name = attributes[:'name']
|
115
211
|
end
|
116
212
|
|
117
|
-
if attributes.
|
213
|
+
if attributes.key?(:'picture')
|
118
214
|
self.picture = attributes[:'picture']
|
215
|
+
else
|
216
|
+
self.picture = nil
|
119
217
|
end
|
120
218
|
|
121
|
-
if attributes.
|
122
|
-
|
219
|
+
if attributes.key?(:'badges')
|
220
|
+
if (value = attributes[:'badges']).is_a?(Array)
|
221
|
+
self.badges = value
|
222
|
+
end
|
123
223
|
end
|
124
224
|
|
125
|
-
if attributes.
|
225
|
+
if attributes.key?(:'organization')
|
126
226
|
self.organization = attributes[:'organization']
|
127
227
|
end
|
128
228
|
|
129
|
-
if attributes.
|
130
|
-
self.organization_role = attributes[:'
|
229
|
+
if attributes.key?(:'organization_role')
|
230
|
+
self.organization_role = attributes[:'organization_role']
|
131
231
|
end
|
132
232
|
|
133
|
-
if attributes.
|
134
|
-
self.class_role = attributes[:'
|
233
|
+
if attributes.key?(:'class_role')
|
234
|
+
self.class_role = attributes[:'class_role']
|
135
235
|
end
|
136
236
|
|
137
|
-
if attributes.
|
138
|
-
self.html_url = attributes[:'
|
237
|
+
if attributes.key?(:'html_url')
|
238
|
+
self.html_url = attributes[:'html_url']
|
139
239
|
end
|
140
240
|
|
141
|
-
if attributes.
|
241
|
+
if attributes.key?(:'email')
|
142
242
|
self.email = attributes[:'email']
|
143
243
|
end
|
144
244
|
|
145
|
-
if attributes.
|
146
|
-
self.last_activity_date = attributes[:'
|
245
|
+
if attributes.key?(:'last_activity_date')
|
246
|
+
self.last_activity_date = attributes[:'last_activity_date']
|
147
247
|
end
|
148
248
|
|
149
|
-
if attributes.
|
249
|
+
if attributes.key?(:'license')
|
150
250
|
self.license = attributes[:'license']
|
151
251
|
end
|
152
252
|
|
253
|
+
if attributes.key?(:'groups')
|
254
|
+
if (value = attributes[:'groups']).is_a?(Array)
|
255
|
+
self.groups = value
|
256
|
+
end
|
257
|
+
end
|
153
258
|
end
|
154
259
|
|
155
260
|
# Show invalid properties with the reasons. Usually used together with valid?
|
156
261
|
# @return Array for valid properties with the reasons
|
157
262
|
def list_invalid_properties
|
263
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
158
264
|
invalid_properties = Array.new
|
159
|
-
|
265
|
+
if @id.nil?
|
266
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
267
|
+
end
|
268
|
+
|
269
|
+
if @type.nil?
|
270
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
271
|
+
end
|
272
|
+
|
273
|
+
if @product.nil?
|
274
|
+
invalid_properties.push('invalid value for "product", product cannot be nil.')
|
275
|
+
end
|
276
|
+
|
277
|
+
if @username.nil?
|
278
|
+
invalid_properties.push('invalid value for "username", username cannot be nil.')
|
279
|
+
end
|
280
|
+
|
281
|
+
invalid_properties
|
160
282
|
end
|
161
283
|
|
162
284
|
# Check to see if the all the properties in the model are valid
|
163
285
|
# @return true if the model is valid
|
164
286
|
def valid?
|
165
|
-
|
287
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
288
|
+
return false if @id.nil?
|
289
|
+
return false if @type.nil?
|
290
|
+
type_validator = EnumAttributeValidator.new('String', ["user", "guest"])
|
291
|
+
return false unless type_validator.valid?(@type)
|
292
|
+
return false if @product.nil?
|
293
|
+
return false if @username.nil?
|
294
|
+
true
|
295
|
+
end
|
296
|
+
|
297
|
+
# Custom attribute writer method checking allowed values (enum).
|
298
|
+
# @param [Object] type Object to be assigned
|
299
|
+
def type=(type)
|
300
|
+
validator = EnumAttributeValidator.new('String', ["user", "guest"])
|
301
|
+
unless validator.valid?(type)
|
302
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
303
|
+
end
|
304
|
+
@type = type
|
166
305
|
end
|
167
306
|
|
168
307
|
# Checks equality by comparing each attribute.
|
@@ -171,18 +310,23 @@ module FlatApi
|
|
171
310
|
return true if self.equal?(o)
|
172
311
|
self.class == o.class &&
|
173
312
|
id == o.id &&
|
313
|
+
type == o.type &&
|
314
|
+
product == o.product &&
|
174
315
|
username == o.username &&
|
175
|
-
name == o.name &&
|
176
316
|
printable_name == o.printable_name &&
|
317
|
+
firstname == o.firstname &&
|
318
|
+
lastname == o.lastname &&
|
319
|
+
name == o.name &&
|
177
320
|
picture == o.picture &&
|
178
|
-
|
321
|
+
badges == o.badges &&
|
179
322
|
organization == o.organization &&
|
180
323
|
organization_role == o.organization_role &&
|
181
324
|
class_role == o.class_role &&
|
182
325
|
html_url == o.html_url &&
|
183
326
|
email == o.email &&
|
184
327
|
last_activity_date == o.last_activity_date &&
|
185
|
-
license == o.license
|
328
|
+
license == o.license &&
|
329
|
+
groups == o.groups
|
186
330
|
end
|
187
331
|
|
188
332
|
# @see the `==` method
|
@@ -192,39 +336,42 @@ module FlatApi
|
|
192
336
|
end
|
193
337
|
|
194
338
|
# Calculates hash code according to all attributes.
|
195
|
-
# @return [
|
339
|
+
# @return [Integer] Hash code
|
196
340
|
def hash
|
197
|
-
[id,
|
341
|
+
[id, type, product, username, printable_name, firstname, lastname, name, picture, badges, organization, organization_role, class_role, html_url, email, last_activity_date, license, groups].hash
|
198
342
|
end
|
199
343
|
|
200
344
|
# Builds the object from hash
|
201
345
|
# @param [Hash] attributes Model attributes in the form of hash
|
202
346
|
# @return [Object] Returns the model itself
|
203
|
-
def build_from_hash(attributes)
|
347
|
+
def self.build_from_hash(attributes)
|
204
348
|
return nil unless attributes.is_a?(Hash)
|
205
|
-
|
206
|
-
|
207
|
-
|
349
|
+
attributes = attributes.transform_keys(&:to_sym)
|
350
|
+
transformed_hash = {}
|
351
|
+
openapi_types.each_pair do |key, type|
|
352
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
353
|
+
transformed_hash["#{key}"] = nil
|
354
|
+
elsif type =~ /\AArray<(.*)>/i
|
355
|
+
# check to ensure the input is an array given that the attribute
|
208
356
|
# is documented as an array but the input is not
|
209
|
-
if attributes[
|
210
|
-
|
357
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
358
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
211
359
|
end
|
212
|
-
elsif !attributes[
|
213
|
-
|
214
|
-
end
|
360
|
+
elsif !attributes[attribute_map[key]].nil?
|
361
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
362
|
+
end
|
215
363
|
end
|
216
|
-
|
217
|
-
self
|
364
|
+
new(transformed_hash)
|
218
365
|
end
|
219
366
|
|
220
367
|
# Deserializes the data based on type
|
221
368
|
# @param string type Data type
|
222
369
|
# @param string value Value to be deserialized
|
223
370
|
# @return [Object] Deserialized data
|
224
|
-
def _deserialize(type, value)
|
371
|
+
def self._deserialize(type, value)
|
225
372
|
case type.to_sym
|
226
|
-
when :
|
227
|
-
|
373
|
+
when :Time
|
374
|
+
Time.parse(value)
|
228
375
|
when :Date
|
229
376
|
Date.parse(value)
|
230
377
|
when :String
|
@@ -233,7 +380,7 @@ module FlatApi
|
|
233
380
|
value.to_i
|
234
381
|
when :Float
|
235
382
|
value.to_f
|
236
|
-
when :
|
383
|
+
when :Boolean
|
237
384
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
238
385
|
true
|
239
386
|
else
|
@@ -254,8 +401,9 @@ module FlatApi
|
|
254
401
|
end
|
255
402
|
end
|
256
403
|
else # model
|
257
|
-
|
258
|
-
|
404
|
+
# models (e.g. Pet) or oneOf
|
405
|
+
klass = FlatApi.const_get(type)
|
406
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
259
407
|
end
|
260
408
|
end
|
261
409
|
|
@@ -277,7 +425,11 @@ module FlatApi
|
|
277
425
|
hash = {}
|
278
426
|
self.class.attribute_map.each_pair do |attr, param|
|
279
427
|
value = self.send(attr)
|
280
|
-
|
428
|
+
if value.nil?
|
429
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
430
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
431
|
+
end
|
432
|
+
|
281
433
|
hash[param] = _to_hash(value)
|
282
434
|
end
|
283
435
|
hash
|
@@ -289,7 +441,7 @@ module FlatApi
|
|
289
441
|
# @return [Hash] Returns the value in the form of hash
|
290
442
|
def _to_hash(value)
|
291
443
|
if value.is_a?(Array)
|
292
|
-
value.compact.map{ |v| _to_hash(v) }
|
444
|
+
value.compact.map { |v| _to_hash(v) }
|
293
445
|
elsif value.is_a?(Hash)
|
294
446
|
{}.tap do |hash|
|
295
447
|
value.each { |k, v| hash[k] = _to_hash(v) }
|