flat_api 0.2.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/CHANGELOG.md +60 -8
- data/LICENSE +201 -0
- data/README.md +62 -241
- data/lib/flat_api/api/account_api.rb +32 -22
- data/lib/flat_api/api/class_api.rb +1671 -453
- data/lib/flat_api/api/collection_api.rb +286 -185
- data/lib/flat_api/api/edu_resources_api.rb +863 -0
- data/lib/flat_api/api/group_api.rb +506 -57
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +808 -192
- data/lib/flat_api/api/score_api.rb +1030 -589
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +151 -82
- data/lib/flat_api/api_client.rb +223 -145
- data/lib/flat_api/api_error.rb +24 -4
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +224 -36
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +201 -0
- data/lib/flat_api/models/app_scopes.rb +61 -0
- data/lib/flat_api/models/assignment.rb +362 -166
- data/lib/flat_api/models/assignment_capabilities.rb +256 -0
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +193 -0
- data/lib/flat_api/models/assignment_copy.rb +79 -169
- data/lib/flat_api/models/assignment_copy_response.rb +535 -0
- data/lib/flat_api/models/assignment_copy_to_class.rb +186 -0
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +176 -0
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +337 -131
- data/lib/flat_api/models/assignment_submission_comment.rb +209 -0
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +166 -0
- data/lib/flat_api/models/assignment_submission_comments.rb +158 -0
- data/lib/flat_api/models/assignment_submission_history.rb +337 -0
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +168 -0
- data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
- data/lib/flat_api/models/assignment_submission_lti.rb +200 -0
- data/lib/flat_api/models/assignment_submission_playback.rb +193 -0
- data/lib/flat_api/models/assignment_submission_state.rb +42 -0
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +157 -113
- data/lib/flat_api/models/assignment_type.rb +45 -0
- data/lib/flat_api/models/assignment_update.rb +538 -0
- data/lib/flat_api/models/class_assignment.rb +750 -0
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +159 -0
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +149 -0
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +159 -0
- data/lib/flat_api/models/class_assignment_update.rb +652 -0
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +150 -0
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +152 -0
- data/lib/flat_api/models/class_attachment_creation.rb +140 -106
- data/lib/flat_api/models/class_creation.rb +142 -108
- data/lib/flat_api/models/class_details.rb +244 -125
- data/lib/flat_api/models/class_details_canvas.rb +59 -99
- data/lib/flat_api/models/class_details_clever.rb +74 -113
- data/lib/flat_api/models/class_details_google_classroom.rb +64 -124
- data/lib/flat_api/models/class_details_google_drive.rb +61 -101
- data/lib/flat_api/models/class_details_issues.rb +151 -0
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +203 -0
- data/lib/flat_api/models/class_details_lti.rb +76 -106
- data/lib/flat_api/models/class_details_mfc.rb +159 -0
- data/lib/flat_api/models/class_details_microsoft_graph.rb +148 -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 +19 -9
- data/lib/flat_api/models/class_update.rb +142 -107
- data/lib/flat_api/models/collection.rb +304 -115
- data/lib/flat_api/models/collection_app.rb +169 -0
- data/lib/flat_api/models/collection_capabilities.rb +157 -112
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +120 -104
- data/lib/flat_api/models/collection_modification.rb +122 -100
- data/lib/flat_api/models/collection_privacy.rb +18 -9
- data/lib/flat_api/models/collection_type.rb +22 -11
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +273 -0
- data/lib/flat_api/models/edu_resource.rb +383 -0
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +179 -0
- data/lib/flat_api/models/edu_resource_copy.rb +166 -0
- data/lib/flat_api/models/edu_resource_creation.rb +311 -0
- data/lib/flat_api/models/edu_resource_folder.rb +171 -0
- data/lib/flat_api/models/edu_resource_lti_link.rb +166 -0
- data/lib/flat_api/models/edu_resource_move.rb +166 -0
- data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
- data/lib/flat_api/models/edu_resource_resource.rb +104 -0
- data/lib/flat_api/models/edu_resource_type.rb +40 -0
- data/lib/flat_api/models/edu_resource_update.rb +292 -0
- data/lib/flat_api/models/edu_resource_use_in_class.rb +176 -0
- data/lib/flat_api/models/flat_error_response.rb +109 -105
- data/lib/flat_api/models/google_classroom_coursework.rb +74 -103
- data/lib/flat_api/models/google_classroom_submission.rb +112 -101
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +70 -122
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +253 -110
- data/lib/flat_api/models/group_type.rb +20 -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_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +108 -114
- data/lib/flat_api/models/lti_credentials_creation.rb +99 -103
- data/lib/flat_api/models/media_attachment.rb +189 -137
- data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
- data/lib/flat_api/models/microsoft_graph_assignment.rb +259 -0
- data/lib/flat_api/models/microsoft_graph_submission.rb +193 -0
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +177 -109
- data/lib/flat_api/models/organization_invitation_creation.rb +97 -100
- data/lib/flat_api/models/organization_roles.rb +19 -10
- data/lib/flat_api/models/organization_user_access_token_creation.rb +168 -0
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +204 -116
- data/lib/flat_api/models/resource_collaborator_creation.rb +72 -112
- data/lib/flat_api/models/resource_rights.rb +168 -107
- data/lib/flat_api/models/score_comment.rb +200 -121
- data/lib/flat_api/models/score_comment_context.rb +161 -124
- data/lib/flat_api/models/score_comment_creation.rb +79 -107
- data/lib/flat_api/models/score_comment_moderation.rb +193 -0
- data/lib/flat_api/models/score_comment_update.rb +81 -115
- data/lib/flat_api/models/score_comments_counts.rb +78 -108
- data/lib/flat_api/models/score_creation.rb +80 -225
- data/lib/flat_api/models/score_creation_builder_data.rb +234 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +173 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +255 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +217 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +222 -0
- data/lib/flat_api/models/score_creation_common.rb +201 -0
- data/lib/flat_api/models/score_creation_file_import.rb +277 -0
- data/lib/flat_api/models/score_creation_google_drive_import.rb +234 -0
- data/lib/flat_api/models/score_creation_type.rb +18 -9
- data/lib/flat_api/models/score_details.rb +428 -146
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +84 -101
- data/lib/flat_api/models/score_license.rb +18 -9
- data/lib/flat_api/models/score_likes_counts.rb +73 -103
- data/lib/flat_api/models/score_modification.rb +178 -115
- data/lib/flat_api/models/score_plays_counts.rb +179 -0
- data/lib/flat_api/models/score_privacy.rb +18 -9
- data/lib/flat_api/models/score_revision.rb +142 -111
- data/lib/flat_api/models/score_revision_creation.rb +113 -105
- data/lib/flat_api/models/score_revision_statistics.rb +81 -101
- data/lib/flat_api/models/score_source.rb +59 -100
- data/lib/flat_api/models/score_summary.rb +172 -105
- data/lib/flat_api/models/score_track.rb +244 -117
- data/lib/flat_api/models/score_track_creation.rb +99 -104
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +78 -103
- 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 +98 -103
- data/lib/flat_api/models/score_views_counts.rb +73 -103
- data/lib/flat_api/models/task.rb +339 -0
- data/lib/flat_api/models/task_export_options.rb +151 -0
- data/lib/flat_api/models/task_progress.rb +159 -0
- data/lib/flat_api/models/task_result.rb +159 -0
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +42 -0
- data/lib/flat_api/models/user_admin_update.rb +206 -106
- data/lib/flat_api/models/user_azure_details.rb +168 -0
- data/lib/flat_api/models/user_basics.rb +215 -120
- data/lib/flat_api/models/user_community_profile_links.rb +205 -0
- data/lib/flat_api/models/user_creation.rb +203 -114
- data/lib/flat_api/models/user_details.rb +331 -161
- data/lib/flat_api/models/user_details_admin.rb +272 -133
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +211 -0
- data/lib/flat_api/models/user_public.rb +303 -145
- data/lib/flat_api/models/user_public_summary.rb +243 -126
- data/lib/flat_api/models/user_signin_link.rb +168 -0
- data/lib/flat_api/models/user_signin_link_creation.rb +150 -0
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +5 -5
- data/lib/flat_api.rb +144 -16
- metadata +154 -434
- data/Gemfile +0 -7
- 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/flat_locales.rb +0 -36
- 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/account_api_spec.rb +0 -46
- data/spec/api/class_api_spec.rb +0 -278
- data/spec/api/collection_api_spec.rb +0 -159
- data/spec/api/group_api_spec.rb +0 -72
- data/spec/api/organization_api_spec.rb +0 -162
- data/spec/api/score_api_spec.rb +0 -426
- data/spec/api/user_api_spec.rb +0 -73
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_copy_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/assignment_spec.rb +0 -106
- data/spec/models/assignment_submission_spec.rb +0 -108
- data/spec/models/assignment_submission_update_spec.rb +0 -60
- data/spec/models/class_attachment_creation_spec.rb +0 -58
- data/spec/models/class_creation_spec.rb +0 -48
- data/spec/models/class_details_canvas_spec.rb +0 -48
- data/spec/models/class_details_clever_spec.rb +0 -82
- data/spec/models/class_details_google_classroom_spec.rb +0 -60
- data/spec/models/class_details_google_drive_spec.rb +0 -48
- data/spec/models/class_details_lti_spec.rb +0 -54
- data/spec/models/class_details_spec.rb +0 -144
- data/spec/models/class_roles_spec.rb +0 -36
- data/spec/models/class_state_spec.rb +0 -36
- data/spec/models/class_update_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -66
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -36
- data/spec/models/collection_spec.rb +0 -102
- data/spec/models/collection_title_spec.rb +0 -36
- data/spec/models/collection_type_spec.rb +0 -36
- data/spec/models/flat_error_response_spec.rb +0 -60
- data/spec/models/flat_locales_spec.rb +0 -36
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -54
- data/spec/models/group_details_spec.rb +0 -78
- data/spec/models/group_spec.rb +0 -82
- data/spec/models/group_type_spec.rb +0 -36
- data/spec/models/license_mode_spec.rb +0 -36
- data/spec/models/license_sources_spec.rb +0 -36
- data/spec/models/lms_name_spec.rb +0 -36
- data/spec/models/lti_credentials_creation_spec.rb +0 -48
- data/spec/models/lti_credentials_spec.rb +0 -90
- data/spec/models/media_attachment_spec.rb +0 -136
- data/spec/models/media_score_sharing_mode_spec.rb +0 -36
- data/spec/models/organization_invitation_creation_spec.rb +0 -48
- data/spec/models/organization_invitation_spec.rb +0 -78
- data/spec/models/organization_roles_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -78
- data/spec/models/resource_collaborator_spec.rb +0 -90
- data/spec/models/resource_rights_spec.rb +0 -54
- data/spec/models/resource_sharing_key_spec.rb +0 -36
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -72
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -60
- data/spec/models/score_comments_counts_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -78
- data/spec/models/score_creation_type_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/score_details_spec.rb +0 -210
- data/spec/models/score_fork_spec.rb +0 -42
- data/spec/models/score_license_spec.rb +0 -36
- data/spec/models/score_likes_counts_spec.rb +0 -54
- data/spec/models/score_modification_spec.rb +0 -78
- data/spec/models/score_privacy_spec.rb +0 -36
- data/spec/models/score_revision_creation_spec.rb +0 -60
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -48
- data/spec/models/score_source_spec.rb +0 -42
- data/spec/models/score_summary_spec.rb +0 -72
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -58
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -36
- data/spec/models/score_track_type_spec.rb +0 -36
- data/spec/models/score_track_update_spec.rb +0 -60
- data/spec/models/score_views_counts_spec.rb +0 -54
- data/spec/models/user_admin_update_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -72
- data/spec/models/user_creation_spec.rb +0 -60
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_details_admin_spec.rb +0 -114
- data/spec/models/user_details_spec.rb +0 -166
- data/spec/models/user_instruments_spec.rb +0 -36
- data/spec/models/user_public_spec.rb +0 -144
- data/spec/models/user_public_summary_spec.rb +0 -96
- data/spec/spec_helper.rb +0 -111
|
@@ -1,20 +1,21 @@
|
|
|
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, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
# The details of a group
|
|
17
|
-
class GroupDetails
|
|
18
|
+
class GroupDetails < ApiModelBase
|
|
18
19
|
# The unique identifier of the group
|
|
19
20
|
attr_accessor :id
|
|
20
21
|
|
|
@@ -26,6 +27,15 @@ module FlatApi
|
|
|
26
27
|
# The unique identifier of the Organization owning the group
|
|
27
28
|
attr_accessor :organization
|
|
28
29
|
|
|
30
|
+
# The unique identifier of the classroom owning the group. Only available for groups of type 'classromStudentsSubGroup' or 'assignmentStudentsSubGroup'
|
|
31
|
+
attr_accessor :classroom
|
|
32
|
+
|
|
33
|
+
# The unique identifier of the assignment owning the group. Only available for groups of type 'assignmentStudentsSubGroup'.
|
|
34
|
+
attr_accessor :assignment
|
|
35
|
+
|
|
36
|
+
# The unique identifier of the parent class group. Only available for groups of type 'assignmentStudentsSubGroup'. May be null if the parent class group was deleted.
|
|
37
|
+
attr_accessor :parent
|
|
38
|
+
|
|
29
39
|
# The date when the group was create
|
|
30
40
|
attr_accessor :creation_date
|
|
31
41
|
|
|
@@ -35,6 +45,30 @@ module FlatApi
|
|
|
35
45
|
# `true` if the properties and members of this group are in in read-only
|
|
36
46
|
attr_accessor :read_only
|
|
37
47
|
|
|
48
|
+
# Tags for categorizing groups. * `edu:testing-students`: Marks this group as containing test student accounts
|
|
49
|
+
attr_accessor :tags
|
|
50
|
+
|
|
51
|
+
class EnumAttributeValidator
|
|
52
|
+
attr_reader :datatype
|
|
53
|
+
attr_reader :allowable_values
|
|
54
|
+
|
|
55
|
+
def initialize(datatype, allowable_values)
|
|
56
|
+
@allowable_values = allowable_values.map do |value|
|
|
57
|
+
case datatype.to_s
|
|
58
|
+
when /Integer/i
|
|
59
|
+
value.to_i
|
|
60
|
+
when /Float/i
|
|
61
|
+
value.to_f
|
|
62
|
+
else
|
|
63
|
+
value
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
def valid?(value)
|
|
69
|
+
!value || allowable_values.include?(value)
|
|
70
|
+
end
|
|
71
|
+
end
|
|
38
72
|
|
|
39
73
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
40
74
|
def self.attribute_map
|
|
@@ -43,74 +77,244 @@ module FlatApi
|
|
|
43
77
|
:'name' => :'name',
|
|
44
78
|
:'type' => :'type',
|
|
45
79
|
:'organization' => :'organization',
|
|
80
|
+
:'classroom' => :'classroom',
|
|
81
|
+
:'assignment' => :'assignment',
|
|
82
|
+
:'parent' => :'parent',
|
|
46
83
|
:'creation_date' => :'creationDate',
|
|
47
84
|
:'users_count' => :'usersCount',
|
|
48
|
-
:'read_only' => :'readOnly'
|
|
85
|
+
:'read_only' => :'readOnly',
|
|
86
|
+
:'tags' => :'tags'
|
|
49
87
|
}
|
|
50
88
|
end
|
|
51
89
|
|
|
90
|
+
# Returns attribute mapping this model knows about
|
|
91
|
+
def self.acceptable_attribute_map
|
|
92
|
+
attribute_map
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Returns all the JSON keys this model knows about
|
|
96
|
+
def self.acceptable_attributes
|
|
97
|
+
acceptable_attribute_map.values
|
|
98
|
+
end
|
|
99
|
+
|
|
52
100
|
# Attribute type mapping.
|
|
53
|
-
def self.
|
|
101
|
+
def self.openapi_types
|
|
54
102
|
{
|
|
55
103
|
:'id' => :'String',
|
|
56
104
|
:'name' => :'String',
|
|
57
105
|
:'type' => :'GroupType',
|
|
58
106
|
:'organization' => :'String',
|
|
59
|
-
:'
|
|
107
|
+
:'classroom' => :'String',
|
|
108
|
+
:'assignment' => :'String',
|
|
109
|
+
:'parent' => :'String',
|
|
110
|
+
:'creation_date' => :'Time',
|
|
60
111
|
:'users_count' => :'Float',
|
|
61
|
-
:'read_only' => :'
|
|
112
|
+
:'read_only' => :'Boolean',
|
|
113
|
+
:'tags' => :'Array<String>'
|
|
62
114
|
}
|
|
63
115
|
end
|
|
64
116
|
|
|
117
|
+
# List of attributes with nullable: true
|
|
118
|
+
def self.openapi_nullable
|
|
119
|
+
Set.new([
|
|
120
|
+
])
|
|
121
|
+
end
|
|
122
|
+
|
|
65
123
|
# Initializes the object
|
|
66
124
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
67
125
|
def initialize(attributes = {})
|
|
68
|
-
|
|
126
|
+
if (!attributes.is_a?(Hash))
|
|
127
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::GroupDetails` initialize method"
|
|
128
|
+
end
|
|
69
129
|
|
|
70
|
-
# convert string to symbol for hash key
|
|
71
|
-
|
|
130
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
131
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
132
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
133
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
134
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GroupDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
135
|
+
end
|
|
136
|
+
h[k.to_sym] = v
|
|
137
|
+
}
|
|
72
138
|
|
|
73
|
-
if attributes.
|
|
139
|
+
if attributes.key?(:'id')
|
|
74
140
|
self.id = attributes[:'id']
|
|
141
|
+
else
|
|
142
|
+
self.id = nil
|
|
75
143
|
end
|
|
76
144
|
|
|
77
|
-
if attributes.
|
|
145
|
+
if attributes.key?(:'name')
|
|
78
146
|
self.name = attributes[:'name']
|
|
147
|
+
else
|
|
148
|
+
self.name = nil
|
|
79
149
|
end
|
|
80
150
|
|
|
81
|
-
if attributes.
|
|
151
|
+
if attributes.key?(:'type')
|
|
82
152
|
self.type = attributes[:'type']
|
|
153
|
+
else
|
|
154
|
+
self.type = nil
|
|
83
155
|
end
|
|
84
156
|
|
|
85
|
-
if attributes.
|
|
157
|
+
if attributes.key?(:'organization')
|
|
86
158
|
self.organization = attributes[:'organization']
|
|
87
159
|
end
|
|
88
160
|
|
|
89
|
-
if attributes.
|
|
90
|
-
self.
|
|
161
|
+
if attributes.key?(:'classroom')
|
|
162
|
+
self.classroom = attributes[:'classroom']
|
|
91
163
|
end
|
|
92
164
|
|
|
93
|
-
if attributes.
|
|
94
|
-
self.
|
|
165
|
+
if attributes.key?(:'assignment')
|
|
166
|
+
self.assignment = attributes[:'assignment']
|
|
95
167
|
end
|
|
96
168
|
|
|
97
|
-
if attributes.
|
|
98
|
-
self.
|
|
169
|
+
if attributes.key?(:'parent')
|
|
170
|
+
self.parent = attributes[:'parent']
|
|
99
171
|
end
|
|
100
172
|
|
|
173
|
+
if attributes.key?(:'creation_date')
|
|
174
|
+
self.creation_date = attributes[:'creation_date']
|
|
175
|
+
else
|
|
176
|
+
self.creation_date = nil
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
if attributes.key?(:'users_count')
|
|
180
|
+
self.users_count = attributes[:'users_count']
|
|
181
|
+
else
|
|
182
|
+
self.users_count = nil
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
if attributes.key?(:'read_only')
|
|
186
|
+
self.read_only = attributes[:'read_only']
|
|
187
|
+
else
|
|
188
|
+
self.read_only = nil
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
if attributes.key?(:'tags')
|
|
192
|
+
if (value = attributes[:'tags']).is_a?(Array)
|
|
193
|
+
self.tags = value
|
|
194
|
+
end
|
|
195
|
+
else
|
|
196
|
+
self.tags = nil
|
|
197
|
+
end
|
|
101
198
|
end
|
|
102
199
|
|
|
103
200
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
104
201
|
# @return Array for valid properties with the reasons
|
|
105
202
|
def list_invalid_properties
|
|
203
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
106
204
|
invalid_properties = Array.new
|
|
107
|
-
|
|
205
|
+
if @id.nil?
|
|
206
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
if @name.nil?
|
|
210
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
if @type.nil?
|
|
214
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
if @creation_date.nil?
|
|
218
|
+
invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
if @users_count.nil?
|
|
222
|
+
invalid_properties.push('invalid value for "users_count", users_count cannot be nil.')
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
if @read_only.nil?
|
|
226
|
+
invalid_properties.push('invalid value for "read_only", read_only cannot be nil.')
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
if @tags.nil?
|
|
230
|
+
invalid_properties.push('invalid value for "tags", tags cannot be nil.')
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
invalid_properties
|
|
108
234
|
end
|
|
109
235
|
|
|
110
236
|
# Check to see if the all the properties in the model are valid
|
|
111
237
|
# @return true if the model is valid
|
|
112
238
|
def valid?
|
|
113
|
-
|
|
239
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
240
|
+
return false if @id.nil?
|
|
241
|
+
return false if @name.nil?
|
|
242
|
+
return false if @type.nil?
|
|
243
|
+
return false if @creation_date.nil?
|
|
244
|
+
return false if @users_count.nil?
|
|
245
|
+
return false if @read_only.nil?
|
|
246
|
+
return false if @tags.nil?
|
|
247
|
+
true
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
# Custom attribute writer method with validation
|
|
251
|
+
# @param [Object] id Value to be assigned
|
|
252
|
+
def id=(id)
|
|
253
|
+
if id.nil?
|
|
254
|
+
fail ArgumentError, 'id cannot be nil'
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
@id = id
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# Custom attribute writer method with validation
|
|
261
|
+
# @param [Object] name Value to be assigned
|
|
262
|
+
def name=(name)
|
|
263
|
+
if name.nil?
|
|
264
|
+
fail ArgumentError, 'name cannot be nil'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
@name = name
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Custom attribute writer method with validation
|
|
271
|
+
# @param [Object] type Value to be assigned
|
|
272
|
+
def type=(type)
|
|
273
|
+
if type.nil?
|
|
274
|
+
fail ArgumentError, 'type cannot be nil'
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
@type = type
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Custom attribute writer method with validation
|
|
281
|
+
# @param [Object] creation_date Value to be assigned
|
|
282
|
+
def creation_date=(creation_date)
|
|
283
|
+
if creation_date.nil?
|
|
284
|
+
fail ArgumentError, 'creation_date cannot be nil'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
@creation_date = creation_date
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Custom attribute writer method with validation
|
|
291
|
+
# @param [Object] users_count Value to be assigned
|
|
292
|
+
def users_count=(users_count)
|
|
293
|
+
if users_count.nil?
|
|
294
|
+
fail ArgumentError, 'users_count cannot be nil'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
@users_count = users_count
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Custom attribute writer method with validation
|
|
301
|
+
# @param [Object] read_only Value to be assigned
|
|
302
|
+
def read_only=(read_only)
|
|
303
|
+
if read_only.nil?
|
|
304
|
+
fail ArgumentError, 'read_only cannot be nil'
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
@read_only = read_only
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# Custom attribute writer method with validation
|
|
311
|
+
# @param [Object] tags Value to be assigned
|
|
312
|
+
def tags=(tags)
|
|
313
|
+
if tags.nil?
|
|
314
|
+
fail ArgumentError, 'tags cannot be nil'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
@tags = tags
|
|
114
318
|
end
|
|
115
319
|
|
|
116
320
|
# Checks equality by comparing each attribute.
|
|
@@ -122,9 +326,13 @@ module FlatApi
|
|
|
122
326
|
name == o.name &&
|
|
123
327
|
type == o.type &&
|
|
124
328
|
organization == o.organization &&
|
|
329
|
+
classroom == o.classroom &&
|
|
330
|
+
assignment == o.assignment &&
|
|
331
|
+
parent == o.parent &&
|
|
125
332
|
creation_date == o.creation_date &&
|
|
126
333
|
users_count == o.users_count &&
|
|
127
|
-
read_only == o.read_only
|
|
334
|
+
read_only == o.read_only &&
|
|
335
|
+
tags == o.tags
|
|
128
336
|
end
|
|
129
337
|
|
|
130
338
|
# @see the `==` method
|
|
@@ -134,83 +342,32 @@ module FlatApi
|
|
|
134
342
|
end
|
|
135
343
|
|
|
136
344
|
# Calculates hash code according to all attributes.
|
|
137
|
-
# @return [
|
|
345
|
+
# @return [Integer] Hash code
|
|
138
346
|
def hash
|
|
139
|
-
[id, name, type, organization, creation_date, users_count, read_only].hash
|
|
347
|
+
[id, name, type, organization, classroom, assignment, parent, creation_date, users_count, read_only, tags].hash
|
|
140
348
|
end
|
|
141
349
|
|
|
142
350
|
# Builds the object from hash
|
|
143
351
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
144
352
|
# @return [Object] Returns the model itself
|
|
145
|
-
def build_from_hash(attributes)
|
|
353
|
+
def self.build_from_hash(attributes)
|
|
146
354
|
return nil unless attributes.is_a?(Hash)
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
355
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
356
|
+
transformed_hash = {}
|
|
357
|
+
openapi_types.each_pair do |key, type|
|
|
358
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
359
|
+
transformed_hash["#{key}"] = nil
|
|
360
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
361
|
+
# check to ensure the input is an array given that the attribute
|
|
150
362
|
# is documented as an array but the input is not
|
|
151
|
-
if attributes[
|
|
152
|
-
|
|
363
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
364
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
153
365
|
end
|
|
154
|
-
elsif !attributes[
|
|
155
|
-
|
|
156
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
157
|
-
end
|
|
158
|
-
|
|
159
|
-
self
|
|
160
|
-
end
|
|
161
|
-
|
|
162
|
-
# Deserializes the data based on type
|
|
163
|
-
# @param string type Data type
|
|
164
|
-
# @param string value Value to be deserialized
|
|
165
|
-
# @return [Object] Deserialized data
|
|
166
|
-
def _deserialize(type, value)
|
|
167
|
-
case type.to_sym
|
|
168
|
-
when :DateTime
|
|
169
|
-
DateTime.parse(value)
|
|
170
|
-
when :Date
|
|
171
|
-
Date.parse(value)
|
|
172
|
-
when :String
|
|
173
|
-
value.to_s
|
|
174
|
-
when :Integer
|
|
175
|
-
value.to_i
|
|
176
|
-
when :Float
|
|
177
|
-
value.to_f
|
|
178
|
-
when :BOOLEAN
|
|
179
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
180
|
-
true
|
|
181
|
-
else
|
|
182
|
-
false
|
|
366
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
367
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
183
368
|
end
|
|
184
|
-
when :Object
|
|
185
|
-
# generic object (usually a Hash), return directly
|
|
186
|
-
value
|
|
187
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
188
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
189
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
190
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
191
|
-
k_type = Regexp.last_match[:k_type]
|
|
192
|
-
v_type = Regexp.last_match[:v_type]
|
|
193
|
-
{}.tap do |hash|
|
|
194
|
-
value.each do |k, v|
|
|
195
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
196
|
-
end
|
|
197
|
-
end
|
|
198
|
-
else # model
|
|
199
|
-
temp_model = FlatApi.const_get(type).new
|
|
200
|
-
temp_model.build_from_hash(value)
|
|
201
369
|
end
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
# Returns the string representation of the object
|
|
205
|
-
# @return [String] String presentation of the object
|
|
206
|
-
def to_s
|
|
207
|
-
to_hash.to_s
|
|
208
|
-
end
|
|
209
|
-
|
|
210
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
211
|
-
# @return [Hash] Returns the object in the form of hash
|
|
212
|
-
def to_body
|
|
213
|
-
to_hash
|
|
370
|
+
new(transformed_hash)
|
|
214
371
|
end
|
|
215
372
|
|
|
216
373
|
# Returns the object in the form of hash
|
|
@@ -219,30 +376,16 @@ module FlatApi
|
|
|
219
376
|
hash = {}
|
|
220
377
|
self.class.attribute_map.each_pair do |attr, param|
|
|
221
378
|
value = self.send(attr)
|
|
222
|
-
|
|
379
|
+
if value.nil?
|
|
380
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
381
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
382
|
+
end
|
|
383
|
+
|
|
223
384
|
hash[param] = _to_hash(value)
|
|
224
385
|
end
|
|
225
386
|
hash
|
|
226
387
|
end
|
|
227
388
|
|
|
228
|
-
# Outputs non-array value in the form of hash
|
|
229
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
230
|
-
# @param [Object] value Any valid value
|
|
231
|
-
# @return [Hash] Returns the value in the form of hash
|
|
232
|
-
def _to_hash(value)
|
|
233
|
-
if value.is_a?(Array)
|
|
234
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
235
|
-
elsif value.is_a?(Hash)
|
|
236
|
-
{}.tap do |hash|
|
|
237
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
238
|
-
end
|
|
239
|
-
elsif value.respond_to? :to_hash
|
|
240
|
-
value.to_hash
|
|
241
|
-
else
|
|
242
|
-
value
|
|
243
|
-
end
|
|
244
|
-
end
|
|
245
|
-
|
|
246
389
|
end
|
|
247
390
|
|
|
248
391
|
end
|
|
@@ -1,32 +1,43 @@
|
|
|
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, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
class GroupType
|
|
17
|
-
|
|
18
18
|
GENERIC = "generic".freeze
|
|
19
19
|
CLASS_TEACHERS = "classTeachers".freeze
|
|
20
20
|
CLASS_STUDENTS = "classStudents".freeze
|
|
21
|
+
CLASS_STUDENTS_SUB_GROUP = "classStudentsSubGroup".freeze
|
|
22
|
+
ASSIGNMENT_STUDENTS_SUB_GROUP = "assignmentStudentsSubGroup".freeze
|
|
23
|
+
|
|
24
|
+
def self.all_vars
|
|
25
|
+
@all_vars ||= [GENERIC, CLASS_TEACHERS, CLASS_STUDENTS, CLASS_STUDENTS_SUB_GROUP, ASSIGNMENT_STUDENTS_SUB_GROUP].freeze
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Builds the enum from string
|
|
29
|
+
# @param [String] The enum value in the form of the string
|
|
30
|
+
# @return [String] The enum value
|
|
31
|
+
def self.build_from_hash(value)
|
|
32
|
+
new.build_from_hash(value)
|
|
33
|
+
end
|
|
21
34
|
|
|
22
35
|
# Builds the enum from string
|
|
23
36
|
# @param [String] The enum value in the form of the string
|
|
24
37
|
# @return [String] The enum value
|
|
25
38
|
def build_from_hash(value)
|
|
26
|
-
|
|
27
|
-
raise "Invalid ENUM value #{value} for class #GroupType"
|
|
28
|
-
value
|
|
39
|
+
return value if GroupType.all_vars.include?(value)
|
|
40
|
+
raise "Invalid ENUM value #{value} for class #GroupType"
|
|
29
41
|
end
|
|
30
42
|
end
|
|
31
|
-
|
|
32
43
|
end
|
|
@@ -1,31 +1,40 @@
|
|
|
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, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
class LicenseMode
|
|
17
|
-
|
|
18
18
|
CREDIT = "credit".freeze
|
|
19
19
|
SITE = "site".freeze
|
|
20
20
|
|
|
21
|
+
def self.all_vars
|
|
22
|
+
@all_vars ||= [CREDIT, SITE].freeze
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# Builds the enum from string
|
|
26
|
+
# @param [String] The enum value in the form of the string
|
|
27
|
+
# @return [String] The enum value
|
|
28
|
+
def self.build_from_hash(value)
|
|
29
|
+
new.build_from_hash(value)
|
|
30
|
+
end
|
|
31
|
+
|
|
21
32
|
# Builds the enum from string
|
|
22
33
|
# @param [String] The enum value in the form of the string
|
|
23
34
|
# @return [String] The enum value
|
|
24
35
|
def build_from_hash(value)
|
|
25
|
-
|
|
26
|
-
raise "Invalid ENUM value #{value} for class #LicenseMode"
|
|
27
|
-
value
|
|
36
|
+
return value if LicenseMode.all_vars.include?(value)
|
|
37
|
+
raise "Invalid ENUM value #{value} for class #LicenseMode"
|
|
28
38
|
end
|
|
29
39
|
end
|
|
30
|
-
|
|
31
40
|
end
|
|
@@ -1,34 +1,46 @@
|
|
|
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, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
class LicenseSources
|
|
17
|
-
|
|
18
18
|
ORDER = "order".freeze
|
|
19
19
|
TRIAL = "trial".freeze
|
|
20
20
|
VOUCHER = "voucher".freeze
|
|
21
21
|
DISTRIBUTOR = "distributor".freeze
|
|
22
22
|
SUBSCRIPTION = "subscription".freeze
|
|
23
|
+
APP_STORE = "appStore".freeze
|
|
24
|
+
PLAY_STORE = "playStore".freeze
|
|
25
|
+
MUSICFIRST = "musicfirst".freeze
|
|
26
|
+
|
|
27
|
+
def self.all_vars
|
|
28
|
+
@all_vars ||= [ORDER, TRIAL, VOUCHER, DISTRIBUTOR, SUBSCRIPTION, APP_STORE, PLAY_STORE, MUSICFIRST].freeze
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Builds the enum from string
|
|
32
|
+
# @param [String] The enum value in the form of the string
|
|
33
|
+
# @return [String] The enum value
|
|
34
|
+
def self.build_from_hash(value)
|
|
35
|
+
new.build_from_hash(value)
|
|
36
|
+
end
|
|
23
37
|
|
|
24
38
|
# Builds the enum from string
|
|
25
39
|
# @param [String] The enum value in the form of the string
|
|
26
40
|
# @return [String] The enum value
|
|
27
41
|
def build_from_hash(value)
|
|
28
|
-
|
|
29
|
-
raise "Invalid ENUM value #{value} for class #LicenseSources"
|
|
30
|
-
value
|
|
42
|
+
return value if LicenseSources.all_vars.include?(value)
|
|
43
|
+
raise "Invalid ENUM value #{value} for class #LicenseSources"
|
|
31
44
|
end
|
|
32
45
|
end
|
|
33
|
-
|
|
34
46
|
end
|