flat_api 0.2.0 → 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 +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
@@ -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 creation
|
@@ -18,6 +19,12 @@ module FlatApi
|
|
18
19
|
# Username of the new account
|
19
20
|
attr_accessor :username
|
20
21
|
|
22
|
+
# First name of the user
|
23
|
+
attr_accessor :firstname
|
24
|
+
|
25
|
+
# Last name of the user
|
26
|
+
attr_accessor :lastname
|
27
|
+
|
21
28
|
# Email of the new account
|
22
29
|
attr_accessor :email
|
23
30
|
|
@@ -26,123 +33,274 @@ module FlatApi
|
|
26
33
|
|
27
34
|
attr_accessor :locale
|
28
35
|
|
36
|
+
# Role of the new account
|
37
|
+
attr_accessor :role
|
38
|
+
|
39
|
+
class EnumAttributeValidator
|
40
|
+
attr_reader :datatype
|
41
|
+
attr_reader :allowable_values
|
42
|
+
|
43
|
+
def initialize(datatype, allowable_values)
|
44
|
+
@allowable_values = allowable_values.map do |value|
|
45
|
+
case datatype.to_s
|
46
|
+
when /Integer/i
|
47
|
+
value.to_i
|
48
|
+
when /Float/i
|
49
|
+
value.to_f
|
50
|
+
else
|
51
|
+
value
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
def valid?(value)
|
57
|
+
!value || allowable_values.include?(value)
|
58
|
+
end
|
59
|
+
end
|
29
60
|
|
30
61
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
62
|
def self.attribute_map
|
32
63
|
{
|
33
64
|
:'username' => :'username',
|
65
|
+
:'firstname' => :'firstname',
|
66
|
+
:'lastname' => :'lastname',
|
34
67
|
:'email' => :'email',
|
35
68
|
:'password' => :'password',
|
36
|
-
:'locale' => :'locale'
|
69
|
+
:'locale' => :'locale',
|
70
|
+
:'role' => :'role'
|
37
71
|
}
|
38
72
|
end
|
39
73
|
|
74
|
+
# Returns all the JSON keys this model knows about
|
75
|
+
def self.acceptable_attributes
|
76
|
+
attribute_map.values
|
77
|
+
end
|
78
|
+
|
40
79
|
# Attribute type mapping.
|
41
|
-
def self.
|
80
|
+
def self.openapi_types
|
42
81
|
{
|
43
82
|
:'username' => :'String',
|
83
|
+
:'firstname' => :'String',
|
84
|
+
:'lastname' => :'String',
|
44
85
|
:'email' => :'String',
|
45
86
|
:'password' => :'String',
|
46
|
-
:'locale' => :'FlatLocales'
|
87
|
+
:'locale' => :'FlatLocales',
|
88
|
+
:'role' => :'String'
|
47
89
|
}
|
48
90
|
end
|
49
91
|
|
92
|
+
# List of attributes with nullable: true
|
93
|
+
def self.openapi_nullable
|
94
|
+
Set.new([
|
95
|
+
])
|
96
|
+
end
|
97
|
+
|
50
98
|
# Initializes the object
|
51
99
|
# @param [Hash] attributes Model attributes in the form of hash
|
52
100
|
def initialize(attributes = {})
|
53
|
-
|
101
|
+
if (!attributes.is_a?(Hash))
|
102
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserCreation` initialize method"
|
103
|
+
end
|
54
104
|
|
55
|
-
# convert string to symbol for hash key
|
56
|
-
attributes = attributes.each_with_object({}){|(k,v), h|
|
105
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
106
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
107
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
108
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserCreation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
109
|
+
end
|
110
|
+
h[k.to_sym] = v
|
111
|
+
}
|
57
112
|
|
58
|
-
if attributes.
|
113
|
+
if attributes.key?(:'username')
|
59
114
|
self.username = attributes[:'username']
|
115
|
+
else
|
116
|
+
self.username = nil
|
60
117
|
end
|
61
118
|
|
62
|
-
if attributes.
|
119
|
+
if attributes.key?(:'firstname')
|
120
|
+
self.firstname = attributes[:'firstname']
|
121
|
+
end
|
122
|
+
|
123
|
+
if attributes.key?(:'lastname')
|
124
|
+
self.lastname = attributes[:'lastname']
|
125
|
+
end
|
126
|
+
|
127
|
+
if attributes.key?(:'email')
|
63
128
|
self.email = attributes[:'email']
|
64
129
|
end
|
65
130
|
|
66
|
-
if attributes.
|
131
|
+
if attributes.key?(:'password')
|
67
132
|
self.password = attributes[:'password']
|
133
|
+
else
|
134
|
+
self.password = nil
|
68
135
|
end
|
69
136
|
|
70
|
-
if attributes.
|
137
|
+
if attributes.key?(:'locale')
|
71
138
|
self.locale = attributes[:'locale']
|
139
|
+
else
|
140
|
+
self.locale = 'en'
|
72
141
|
end
|
73
142
|
|
143
|
+
if attributes.key?(:'role')
|
144
|
+
self.role = attributes[:'role']
|
145
|
+
else
|
146
|
+
self.role = 'user'
|
147
|
+
end
|
74
148
|
end
|
75
149
|
|
76
150
|
# Show invalid properties with the reasons. Usually used together with valid?
|
77
151
|
# @return Array for valid properties with the reasons
|
78
152
|
def list_invalid_properties
|
153
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
79
154
|
invalid_properties = Array.new
|
80
155
|
if @username.nil?
|
81
|
-
invalid_properties.push(
|
156
|
+
invalid_properties.push('invalid value for "username", username cannot be nil.')
|
82
157
|
end
|
83
158
|
|
84
|
-
if @username
|
85
|
-
invalid_properties.push(
|
159
|
+
if @username.to_s.length > 30
|
160
|
+
invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 30.')
|
161
|
+
end
|
162
|
+
|
163
|
+
if @username.to_s.length < 1
|
164
|
+
invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
|
165
|
+
end
|
166
|
+
|
167
|
+
pattern = Regexp.new(/^[A-Za-z0-9\-_.]+$/)
|
168
|
+
if @username !~ pattern
|
169
|
+
invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
|
170
|
+
end
|
171
|
+
|
172
|
+
if !@firstname.nil? && @firstname.to_s.length > 60
|
173
|
+
invalid_properties.push('invalid value for "firstname", the character length must be smaller than or equal to 60.')
|
174
|
+
end
|
175
|
+
|
176
|
+
if !@lastname.nil? && @lastname.to_s.length > 60
|
177
|
+
invalid_properties.push('invalid value for "lastname", the character length must be smaller than or equal to 60.')
|
86
178
|
end
|
87
179
|
|
88
180
|
if @password.nil?
|
89
|
-
invalid_properties.push(
|
181
|
+
invalid_properties.push('invalid value for "password", password cannot be nil.')
|
182
|
+
end
|
183
|
+
|
184
|
+
if @password.to_s.length > 1000
|
185
|
+
invalid_properties.push('invalid value for "password", the character length must be smaller than or equal to 1000.')
|
90
186
|
end
|
91
187
|
|
92
188
|
if @password.to_s.length < 6
|
93
|
-
invalid_properties.push(
|
189
|
+
invalid_properties.push('invalid value for "password", the character length must be great than or equal to 6.')
|
94
190
|
end
|
95
191
|
|
96
|
-
|
192
|
+
invalid_properties
|
97
193
|
end
|
98
194
|
|
99
195
|
# Check to see if the all the properties in the model are valid
|
100
196
|
# @return true if the model is valid
|
101
197
|
def valid?
|
198
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
102
199
|
return false if @username.nil?
|
103
|
-
return false if @username
|
200
|
+
return false if @username.to_s.length > 30
|
201
|
+
return false if @username.to_s.length < 1
|
202
|
+
return false if @username !~ Regexp.new(/^[A-Za-z0-9\-_.]+$/)
|
203
|
+
return false if !@firstname.nil? && @firstname.to_s.length > 60
|
204
|
+
return false if !@lastname.nil? && @lastname.to_s.length > 60
|
104
205
|
return false if @password.nil?
|
206
|
+
return false if @password.to_s.length > 1000
|
105
207
|
return false if @password.to_s.length < 6
|
106
|
-
|
208
|
+
role_validator = EnumAttributeValidator.new('String', ["user", "teacher", "admin"])
|
209
|
+
return false unless role_validator.valid?(@role)
|
210
|
+
true
|
107
211
|
end
|
108
212
|
|
109
213
|
# Custom attribute writer method with validation
|
110
214
|
# @param [Object] username Value to be assigned
|
111
215
|
def username=(username)
|
112
216
|
if username.nil?
|
113
|
-
fail ArgumentError,
|
217
|
+
fail ArgumentError, 'username cannot be nil'
|
218
|
+
end
|
219
|
+
|
220
|
+
if username.to_s.length > 30
|
221
|
+
fail ArgumentError, 'invalid value for "username", the character length must be smaller than or equal to 30.'
|
222
|
+
end
|
223
|
+
|
224
|
+
if username.to_s.length < 1
|
225
|
+
fail ArgumentError, 'invalid value for "username", the character length must be great than or equal to 1.'
|
114
226
|
end
|
115
227
|
|
116
|
-
|
117
|
-
|
228
|
+
pattern = Regexp.new(/^[A-Za-z0-9\-_.]+$/)
|
229
|
+
if username !~ pattern
|
230
|
+
fail ArgumentError, "invalid value for \"username\", must conform to the pattern #{pattern}."
|
118
231
|
end
|
119
232
|
|
120
233
|
@username = username
|
121
234
|
end
|
122
235
|
|
236
|
+
# Custom attribute writer method with validation
|
237
|
+
# @param [Object] firstname Value to be assigned
|
238
|
+
def firstname=(firstname)
|
239
|
+
if firstname.nil?
|
240
|
+
fail ArgumentError, 'firstname cannot be nil'
|
241
|
+
end
|
242
|
+
|
243
|
+
if firstname.to_s.length > 60
|
244
|
+
fail ArgumentError, 'invalid value for "firstname", the character length must be smaller than or equal to 60.'
|
245
|
+
end
|
246
|
+
|
247
|
+
@firstname = firstname
|
248
|
+
end
|
249
|
+
|
250
|
+
# Custom attribute writer method with validation
|
251
|
+
# @param [Object] lastname Value to be assigned
|
252
|
+
def lastname=(lastname)
|
253
|
+
if lastname.nil?
|
254
|
+
fail ArgumentError, 'lastname cannot be nil'
|
255
|
+
end
|
256
|
+
|
257
|
+
if lastname.to_s.length > 60
|
258
|
+
fail ArgumentError, 'invalid value for "lastname", the character length must be smaller than or equal to 60.'
|
259
|
+
end
|
260
|
+
|
261
|
+
@lastname = lastname
|
262
|
+
end
|
263
|
+
|
123
264
|
# Custom attribute writer method with validation
|
124
265
|
# @param [Object] password Value to be assigned
|
125
266
|
def password=(password)
|
126
267
|
if password.nil?
|
127
|
-
fail ArgumentError,
|
268
|
+
fail ArgumentError, 'password cannot be nil'
|
269
|
+
end
|
270
|
+
|
271
|
+
if password.to_s.length > 1000
|
272
|
+
fail ArgumentError, 'invalid value for "password", the character length must be smaller than or equal to 1000.'
|
128
273
|
end
|
129
274
|
|
130
275
|
if password.to_s.length < 6
|
131
|
-
fail ArgumentError,
|
276
|
+
fail ArgumentError, 'invalid value for "password", the character length must be great than or equal to 6.'
|
132
277
|
end
|
133
278
|
|
134
279
|
@password = password
|
135
280
|
end
|
136
281
|
|
282
|
+
# Custom attribute writer method checking allowed values (enum).
|
283
|
+
# @param [Object] role Object to be assigned
|
284
|
+
def role=(role)
|
285
|
+
validator = EnumAttributeValidator.new('String', ["user", "teacher", "admin"])
|
286
|
+
unless validator.valid?(role)
|
287
|
+
fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
|
288
|
+
end
|
289
|
+
@role = role
|
290
|
+
end
|
291
|
+
|
137
292
|
# Checks equality by comparing each attribute.
|
138
293
|
# @param [Object] Object to be compared
|
139
294
|
def ==(o)
|
140
295
|
return true if self.equal?(o)
|
141
296
|
self.class == o.class &&
|
142
297
|
username == o.username &&
|
298
|
+
firstname == o.firstname &&
|
299
|
+
lastname == o.lastname &&
|
143
300
|
email == o.email &&
|
144
301
|
password == o.password &&
|
145
|
-
locale == o.locale
|
302
|
+
locale == o.locale &&
|
303
|
+
role == o.role
|
146
304
|
end
|
147
305
|
|
148
306
|
# @see the `==` method
|
@@ -152,39 +310,42 @@ module FlatApi
|
|
152
310
|
end
|
153
311
|
|
154
312
|
# Calculates hash code according to all attributes.
|
155
|
-
# @return [
|
313
|
+
# @return [Integer] Hash code
|
156
314
|
def hash
|
157
|
-
[username, email, password, locale].hash
|
315
|
+
[username, firstname, lastname, email, password, locale, role].hash
|
158
316
|
end
|
159
317
|
|
160
318
|
# Builds the object from hash
|
161
319
|
# @param [Hash] attributes Model attributes in the form of hash
|
162
320
|
# @return [Object] Returns the model itself
|
163
|
-
def build_from_hash(attributes)
|
321
|
+
def self.build_from_hash(attributes)
|
164
322
|
return nil unless attributes.is_a?(Hash)
|
165
|
-
|
166
|
-
|
167
|
-
|
323
|
+
attributes = attributes.transform_keys(&:to_sym)
|
324
|
+
transformed_hash = {}
|
325
|
+
openapi_types.each_pair do |key, type|
|
326
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
327
|
+
transformed_hash["#{key}"] = nil
|
328
|
+
elsif type =~ /\AArray<(.*)>/i
|
329
|
+
# check to ensure the input is an array given that the attribute
|
168
330
|
# is documented as an array but the input is not
|
169
|
-
if attributes[
|
170
|
-
|
331
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
332
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
171
333
|
end
|
172
|
-
elsif !attributes[
|
173
|
-
|
174
|
-
end
|
334
|
+
elsif !attributes[attribute_map[key]].nil?
|
335
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
336
|
+
end
|
175
337
|
end
|
176
|
-
|
177
|
-
self
|
338
|
+
new(transformed_hash)
|
178
339
|
end
|
179
340
|
|
180
341
|
# Deserializes the data based on type
|
181
342
|
# @param string type Data type
|
182
343
|
# @param string value Value to be deserialized
|
183
344
|
# @return [Object] Deserialized data
|
184
|
-
def _deserialize(type, value)
|
345
|
+
def self._deserialize(type, value)
|
185
346
|
case type.to_sym
|
186
|
-
when :
|
187
|
-
|
347
|
+
when :Time
|
348
|
+
Time.parse(value)
|
188
349
|
when :Date
|
189
350
|
Date.parse(value)
|
190
351
|
when :String
|
@@ -193,7 +354,7 @@ module FlatApi
|
|
193
354
|
value.to_i
|
194
355
|
when :Float
|
195
356
|
value.to_f
|
196
|
-
when :
|
357
|
+
when :Boolean
|
197
358
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
198
359
|
true
|
199
360
|
else
|
@@ -214,8 +375,9 @@ module FlatApi
|
|
214
375
|
end
|
215
376
|
end
|
216
377
|
else # model
|
217
|
-
|
218
|
-
|
378
|
+
# models (e.g. Pet) or oneOf
|
379
|
+
klass = FlatApi.const_get(type)
|
380
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
219
381
|
end
|
220
382
|
end
|
221
383
|
|
@@ -237,7 +399,11 @@ module FlatApi
|
|
237
399
|
hash = {}
|
238
400
|
self.class.attribute_map.each_pair do |attr, param|
|
239
401
|
value = self.send(attr)
|
240
|
-
|
402
|
+
if value.nil?
|
403
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
404
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
405
|
+
end
|
406
|
+
|
241
407
|
hash[param] = _to_hash(value)
|
242
408
|
end
|
243
409
|
hash
|
@@ -249,7 +415,7 @@ module FlatApi
|
|
249
415
|
# @return [Hash] Returns the value in the form of hash
|
250
416
|
def _to_hash(value)
|
251
417
|
if value.is_a?(Array)
|
252
|
-
value.compact.map{ |v| _to_hash(v) }
|
418
|
+
value.compact.map { |v| _to_hash(v) }
|
253
419
|
elsif value.is_a?(Hash)
|
254
420
|
{}.tap do |hash|
|
255
421
|
value.each { |k, v| hash[k] = _to_hash(v) }
|