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,25 +1,39 @@
|
|
|
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
|
# Edit the score metadata
|
|
17
|
-
class ScoreModification
|
|
18
|
+
class ScoreModification < ApiModelBase
|
|
18
19
|
# The title of the score
|
|
19
20
|
attr_accessor :title
|
|
20
21
|
|
|
22
|
+
# The subtitle of the score
|
|
23
|
+
attr_accessor :subtitle
|
|
24
|
+
|
|
25
|
+
# The composer of the score
|
|
26
|
+
attr_accessor :composer
|
|
27
|
+
|
|
28
|
+
# The lyricist of the score
|
|
29
|
+
attr_accessor :lyricist
|
|
30
|
+
|
|
31
|
+
# The arranger of the score
|
|
32
|
+
attr_accessor :arranger
|
|
33
|
+
|
|
21
34
|
attr_accessor :privacy
|
|
22
35
|
|
|
36
|
+
# When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated.
|
|
23
37
|
attr_accessor :sharing_key
|
|
24
38
|
|
|
25
39
|
# Description of the creation
|
|
@@ -32,97 +46,206 @@ module FlatApi
|
|
|
32
46
|
|
|
33
47
|
attr_accessor :license
|
|
34
48
|
|
|
49
|
+
# The rights info written on the score
|
|
50
|
+
attr_accessor :license_text
|
|
51
|
+
|
|
52
|
+
class EnumAttributeValidator
|
|
53
|
+
attr_reader :datatype
|
|
54
|
+
attr_reader :allowable_values
|
|
55
|
+
|
|
56
|
+
def initialize(datatype, allowable_values)
|
|
57
|
+
@allowable_values = allowable_values.map do |value|
|
|
58
|
+
case datatype.to_s
|
|
59
|
+
when /Integer/i
|
|
60
|
+
value.to_i
|
|
61
|
+
when /Float/i
|
|
62
|
+
value.to_f
|
|
63
|
+
else
|
|
64
|
+
value
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
def valid?(value)
|
|
70
|
+
!value || allowable_values.include?(value)
|
|
71
|
+
end
|
|
72
|
+
end
|
|
35
73
|
|
|
36
74
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
37
75
|
def self.attribute_map
|
|
38
76
|
{
|
|
39
77
|
:'title' => :'title',
|
|
78
|
+
:'subtitle' => :'subtitle',
|
|
79
|
+
:'composer' => :'composer',
|
|
80
|
+
:'lyricist' => :'lyricist',
|
|
81
|
+
:'arranger' => :'arranger',
|
|
40
82
|
:'privacy' => :'privacy',
|
|
41
83
|
:'sharing_key' => :'sharingKey',
|
|
42
84
|
:'description' => :'description',
|
|
43
85
|
:'tags' => :'tags',
|
|
44
86
|
:'creation_type' => :'creationType',
|
|
45
|
-
:'license' => :'license'
|
|
87
|
+
:'license' => :'license',
|
|
88
|
+
:'license_text' => :'licenseText'
|
|
46
89
|
}
|
|
47
90
|
end
|
|
48
91
|
|
|
92
|
+
# Returns attribute mapping this model knows about
|
|
93
|
+
def self.acceptable_attribute_map
|
|
94
|
+
attribute_map
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# Returns all the JSON keys this model knows about
|
|
98
|
+
def self.acceptable_attributes
|
|
99
|
+
acceptable_attribute_map.values
|
|
100
|
+
end
|
|
101
|
+
|
|
49
102
|
# Attribute type mapping.
|
|
50
|
-
def self.
|
|
103
|
+
def self.openapi_types
|
|
51
104
|
{
|
|
52
105
|
:'title' => :'String',
|
|
106
|
+
:'subtitle' => :'String',
|
|
107
|
+
:'composer' => :'String',
|
|
108
|
+
:'lyricist' => :'String',
|
|
109
|
+
:'arranger' => :'String',
|
|
53
110
|
:'privacy' => :'ScorePrivacy',
|
|
54
|
-
:'sharing_key' => :'
|
|
111
|
+
:'sharing_key' => :'String',
|
|
55
112
|
:'description' => :'String',
|
|
56
113
|
:'tags' => :'Array<String>',
|
|
57
114
|
:'creation_type' => :'ScoreCreationType',
|
|
58
|
-
:'license' => :'ScoreLicense'
|
|
115
|
+
:'license' => :'ScoreLicense',
|
|
116
|
+
:'license_text' => :'String'
|
|
59
117
|
}
|
|
60
118
|
end
|
|
61
119
|
|
|
120
|
+
# List of attributes with nullable: true
|
|
121
|
+
def self.openapi_nullable
|
|
122
|
+
Set.new([
|
|
123
|
+
:'subtitle',
|
|
124
|
+
:'composer',
|
|
125
|
+
:'lyricist',
|
|
126
|
+
:'arranger',
|
|
127
|
+
:'description',
|
|
128
|
+
:'creation_type',
|
|
129
|
+
:'license',
|
|
130
|
+
:'license_text'
|
|
131
|
+
])
|
|
132
|
+
end
|
|
133
|
+
|
|
62
134
|
# Initializes the object
|
|
63
135
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
64
136
|
def initialize(attributes = {})
|
|
65
|
-
|
|
137
|
+
if (!attributes.is_a?(Hash))
|
|
138
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreModification` initialize method"
|
|
139
|
+
end
|
|
66
140
|
|
|
67
|
-
# convert string to symbol for hash key
|
|
68
|
-
|
|
141
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
142
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
143
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
144
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
145
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreModification`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
146
|
+
end
|
|
147
|
+
h[k.to_sym] = v
|
|
148
|
+
}
|
|
69
149
|
|
|
70
|
-
if attributes.
|
|
150
|
+
if attributes.key?(:'title')
|
|
71
151
|
self.title = attributes[:'title']
|
|
72
152
|
end
|
|
73
153
|
|
|
74
|
-
if attributes.
|
|
154
|
+
if attributes.key?(:'subtitle')
|
|
155
|
+
self.subtitle = attributes[:'subtitle']
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
if attributes.key?(:'composer')
|
|
159
|
+
self.composer = attributes[:'composer']
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
if attributes.key?(:'lyricist')
|
|
163
|
+
self.lyricist = attributes[:'lyricist']
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
if attributes.key?(:'arranger')
|
|
167
|
+
self.arranger = attributes[:'arranger']
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
if attributes.key?(:'privacy')
|
|
75
171
|
self.privacy = attributes[:'privacy']
|
|
172
|
+
else
|
|
173
|
+
self.privacy = 'private'
|
|
76
174
|
end
|
|
77
175
|
|
|
78
|
-
if attributes.
|
|
79
|
-
self.sharing_key = attributes[:'
|
|
176
|
+
if attributes.key?(:'sharing_key')
|
|
177
|
+
self.sharing_key = attributes[:'sharing_key']
|
|
80
178
|
end
|
|
81
179
|
|
|
82
|
-
if attributes.
|
|
180
|
+
if attributes.key?(:'description')
|
|
83
181
|
self.description = attributes[:'description']
|
|
84
182
|
end
|
|
85
183
|
|
|
86
|
-
if attributes.
|
|
184
|
+
if attributes.key?(:'tags')
|
|
87
185
|
if (value = attributes[:'tags']).is_a?(Array)
|
|
88
186
|
self.tags = value
|
|
89
187
|
end
|
|
90
188
|
end
|
|
91
189
|
|
|
92
|
-
if attributes.
|
|
93
|
-
self.creation_type = attributes[:'
|
|
190
|
+
if attributes.key?(:'creation_type')
|
|
191
|
+
self.creation_type = attributes[:'creation_type']
|
|
94
192
|
end
|
|
95
193
|
|
|
96
|
-
if attributes.
|
|
194
|
+
if attributes.key?(:'license')
|
|
97
195
|
self.license = attributes[:'license']
|
|
98
196
|
end
|
|
99
197
|
|
|
198
|
+
if attributes.key?(:'license_text')
|
|
199
|
+
self.license_text = attributes[:'license_text']
|
|
200
|
+
end
|
|
100
201
|
end
|
|
101
202
|
|
|
102
203
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
103
204
|
# @return Array for valid properties with the reasons
|
|
104
205
|
def list_invalid_properties
|
|
206
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
105
207
|
invalid_properties = Array.new
|
|
106
|
-
|
|
107
|
-
|
|
208
|
+
pattern = Regexp.new(/^[a-f0-9]{128}$/)
|
|
209
|
+
if !@sharing_key.nil? && @sharing_key !~ pattern
|
|
210
|
+
invalid_properties.push("invalid value for \"sharing_key\", must conform to the pattern #{pattern}.")
|
|
108
211
|
end
|
|
109
212
|
|
|
110
|
-
|
|
213
|
+
if !@description.nil? && @description.to_s.length > 2000
|
|
214
|
+
invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
invalid_properties
|
|
111
218
|
end
|
|
112
219
|
|
|
113
220
|
# Check to see if the all the properties in the model are valid
|
|
114
221
|
# @return true if the model is valid
|
|
115
222
|
def valid?
|
|
116
|
-
|
|
117
|
-
return
|
|
223
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
224
|
+
return false if !@sharing_key.nil? && @sharing_key !~ Regexp.new(/^[a-f0-9]{128}$/)
|
|
225
|
+
return false if !@description.nil? && @description.to_s.length > 2000
|
|
226
|
+
true
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
# Custom attribute writer method with validation
|
|
230
|
+
# @param [Object] sharing_key Value to be assigned
|
|
231
|
+
def sharing_key=(sharing_key)
|
|
232
|
+
if sharing_key.nil?
|
|
233
|
+
fail ArgumentError, 'sharing_key cannot be nil'
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
pattern = Regexp.new(/^[a-f0-9]{128}$/)
|
|
237
|
+
if sharing_key !~ pattern
|
|
238
|
+
fail ArgumentError, "invalid value for \"sharing_key\", must conform to the pattern #{pattern}."
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
@sharing_key = sharing_key
|
|
118
242
|
end
|
|
119
243
|
|
|
120
244
|
# Custom attribute writer method with validation
|
|
121
245
|
# @param [Object] description Value to be assigned
|
|
122
246
|
def description=(description)
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
fail ArgumentError, "invalid value for 'description', the character length must be smaller than or equal to 1000."
|
|
247
|
+
if !description.nil? && description.to_s.length > 2000
|
|
248
|
+
fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
|
|
126
249
|
end
|
|
127
250
|
|
|
128
251
|
@description = description
|
|
@@ -134,12 +257,17 @@ module FlatApi
|
|
|
134
257
|
return true if self.equal?(o)
|
|
135
258
|
self.class == o.class &&
|
|
136
259
|
title == o.title &&
|
|
260
|
+
subtitle == o.subtitle &&
|
|
261
|
+
composer == o.composer &&
|
|
262
|
+
lyricist == o.lyricist &&
|
|
263
|
+
arranger == o.arranger &&
|
|
137
264
|
privacy == o.privacy &&
|
|
138
265
|
sharing_key == o.sharing_key &&
|
|
139
266
|
description == o.description &&
|
|
140
267
|
tags == o.tags &&
|
|
141
268
|
creation_type == o.creation_type &&
|
|
142
|
-
license == o.license
|
|
269
|
+
license == o.license &&
|
|
270
|
+
license_text == o.license_text
|
|
143
271
|
end
|
|
144
272
|
|
|
145
273
|
# @see the `==` method
|
|
@@ -149,83 +277,32 @@ module FlatApi
|
|
|
149
277
|
end
|
|
150
278
|
|
|
151
279
|
# Calculates hash code according to all attributes.
|
|
152
|
-
# @return [
|
|
280
|
+
# @return [Integer] Hash code
|
|
153
281
|
def hash
|
|
154
|
-
[title, privacy, sharing_key, description, tags, creation_type, license].hash
|
|
282
|
+
[title, subtitle, composer, lyricist, arranger, privacy, sharing_key, description, tags, creation_type, license, license_text].hash
|
|
155
283
|
end
|
|
156
284
|
|
|
157
285
|
# Builds the object from hash
|
|
158
286
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
159
287
|
# @return [Object] Returns the model itself
|
|
160
|
-
def build_from_hash(attributes)
|
|
288
|
+
def self.build_from_hash(attributes)
|
|
161
289
|
return nil unless attributes.is_a?(Hash)
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
290
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
291
|
+
transformed_hash = {}
|
|
292
|
+
openapi_types.each_pair do |key, type|
|
|
293
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
294
|
+
transformed_hash["#{key}"] = nil
|
|
295
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
296
|
+
# check to ensure the input is an array given that the attribute
|
|
165
297
|
# is documented as an array but the input is not
|
|
166
|
-
if attributes[
|
|
167
|
-
|
|
168
|
-
end
|
|
169
|
-
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
170
|
-
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
171
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
172
|
-
end
|
|
173
|
-
|
|
174
|
-
self
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
# Deserializes the data based on type
|
|
178
|
-
# @param string type Data type
|
|
179
|
-
# @param string value Value to be deserialized
|
|
180
|
-
# @return [Object] Deserialized data
|
|
181
|
-
def _deserialize(type, value)
|
|
182
|
-
case type.to_sym
|
|
183
|
-
when :DateTime
|
|
184
|
-
DateTime.parse(value)
|
|
185
|
-
when :Date
|
|
186
|
-
Date.parse(value)
|
|
187
|
-
when :String
|
|
188
|
-
value.to_s
|
|
189
|
-
when :Integer
|
|
190
|
-
value.to_i
|
|
191
|
-
when :Float
|
|
192
|
-
value.to_f
|
|
193
|
-
when :BOOLEAN
|
|
194
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
195
|
-
true
|
|
196
|
-
else
|
|
197
|
-
false
|
|
198
|
-
end
|
|
199
|
-
when :Object
|
|
200
|
-
# generic object (usually a Hash), return directly
|
|
201
|
-
value
|
|
202
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
203
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
204
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
205
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
206
|
-
k_type = Regexp.last_match[:k_type]
|
|
207
|
-
v_type = Regexp.last_match[:v_type]
|
|
208
|
-
{}.tap do |hash|
|
|
209
|
-
value.each do |k, v|
|
|
210
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
298
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
299
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
211
300
|
end
|
|
301
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
302
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
212
303
|
end
|
|
213
|
-
else # model
|
|
214
|
-
temp_model = FlatApi.const_get(type).new
|
|
215
|
-
temp_model.build_from_hash(value)
|
|
216
304
|
end
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
# Returns the string representation of the object
|
|
220
|
-
# @return [String] String presentation of the object
|
|
221
|
-
def to_s
|
|
222
|
-
to_hash.to_s
|
|
223
|
-
end
|
|
224
|
-
|
|
225
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
226
|
-
# @return [Hash] Returns the object in the form of hash
|
|
227
|
-
def to_body
|
|
228
|
-
to_hash
|
|
305
|
+
new(transformed_hash)
|
|
229
306
|
end
|
|
230
307
|
|
|
231
308
|
# Returns the object in the form of hash
|
|
@@ -234,30 +311,16 @@ module FlatApi
|
|
|
234
311
|
hash = {}
|
|
235
312
|
self.class.attribute_map.each_pair do |attr, param|
|
|
236
313
|
value = self.send(attr)
|
|
237
|
-
|
|
314
|
+
if value.nil?
|
|
315
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
316
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
317
|
+
end
|
|
318
|
+
|
|
238
319
|
hash[param] = _to_hash(value)
|
|
239
320
|
end
|
|
240
321
|
hash
|
|
241
322
|
end
|
|
242
323
|
|
|
243
|
-
# Outputs non-array value in the form of hash
|
|
244
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
245
|
-
# @param [Object] value Any valid value
|
|
246
|
-
# @return [Hash] Returns the value in the form of hash
|
|
247
|
-
def _to_hash(value)
|
|
248
|
-
if value.is_a?(Array)
|
|
249
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
250
|
-
elsif value.is_a?(Hash)
|
|
251
|
-
{}.tap do |hash|
|
|
252
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
253
|
-
end
|
|
254
|
-
elsif value.respond_to? :to_hash
|
|
255
|
-
value.to_hash
|
|
256
|
-
else
|
|
257
|
-
value
|
|
258
|
-
end
|
|
259
|
-
end
|
|
260
|
-
|
|
261
324
|
end
|
|
262
325
|
|
|
263
326
|
end
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Flat API
|
|
3
|
+
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
|
+
Contact: developers@flat.io
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module FlatApi
|
|
17
|
+
# A computed version of the total, weekly, monthly, and yearly number of plays of the score
|
|
18
|
+
class ScorePlaysCounts < ApiModelBase
|
|
19
|
+
# The total number of plays of the score
|
|
20
|
+
attr_accessor :total
|
|
21
|
+
|
|
22
|
+
# The weekly number of plays of the score
|
|
23
|
+
attr_accessor :weekly
|
|
24
|
+
|
|
25
|
+
# The monthly number of plays of the score
|
|
26
|
+
attr_accessor :monthly
|
|
27
|
+
|
|
28
|
+
# The yearly number of plays of the score
|
|
29
|
+
attr_accessor :yearly
|
|
30
|
+
|
|
31
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
32
|
+
def self.attribute_map
|
|
33
|
+
{
|
|
34
|
+
:'total' => :'total',
|
|
35
|
+
:'weekly' => :'weekly',
|
|
36
|
+
:'monthly' => :'monthly',
|
|
37
|
+
:'yearly' => :'yearly'
|
|
38
|
+
}
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Returns attribute mapping this model knows about
|
|
42
|
+
def self.acceptable_attribute_map
|
|
43
|
+
attribute_map
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Returns all the JSON keys this model knows about
|
|
47
|
+
def self.acceptable_attributes
|
|
48
|
+
acceptable_attribute_map.values
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Attribute type mapping.
|
|
52
|
+
def self.openapi_types
|
|
53
|
+
{
|
|
54
|
+
:'total' => :'Float',
|
|
55
|
+
:'weekly' => :'Float',
|
|
56
|
+
:'monthly' => :'Float',
|
|
57
|
+
:'yearly' => :'Float'
|
|
58
|
+
}
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# List of attributes with nullable: true
|
|
62
|
+
def self.openapi_nullable
|
|
63
|
+
Set.new([
|
|
64
|
+
])
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Initializes the object
|
|
68
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
69
|
+
def initialize(attributes = {})
|
|
70
|
+
if (!attributes.is_a?(Hash))
|
|
71
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScorePlaysCounts` initialize method"
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
75
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
76
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
77
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
78
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScorePlaysCounts`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
79
|
+
end
|
|
80
|
+
h[k.to_sym] = v
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
if attributes.key?(:'total')
|
|
84
|
+
self.total = attributes[:'total']
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
if attributes.key?(:'weekly')
|
|
88
|
+
self.weekly = attributes[:'weekly']
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
if attributes.key?(:'monthly')
|
|
92
|
+
self.monthly = attributes[:'monthly']
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
if attributes.key?(:'yearly')
|
|
96
|
+
self.yearly = attributes[:'yearly']
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
101
|
+
# @return Array for valid properties with the reasons
|
|
102
|
+
def list_invalid_properties
|
|
103
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
104
|
+
invalid_properties = Array.new
|
|
105
|
+
invalid_properties
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Check to see if the all the properties in the model are valid
|
|
109
|
+
# @return true if the model is valid
|
|
110
|
+
def valid?
|
|
111
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
112
|
+
true
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Checks equality by comparing each attribute.
|
|
116
|
+
# @param [Object] Object to be compared
|
|
117
|
+
def ==(o)
|
|
118
|
+
return true if self.equal?(o)
|
|
119
|
+
self.class == o.class &&
|
|
120
|
+
total == o.total &&
|
|
121
|
+
weekly == o.weekly &&
|
|
122
|
+
monthly == o.monthly &&
|
|
123
|
+
yearly == o.yearly
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# @see the `==` method
|
|
127
|
+
# @param [Object] Object to be compared
|
|
128
|
+
def eql?(o)
|
|
129
|
+
self == o
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Calculates hash code according to all attributes.
|
|
133
|
+
# @return [Integer] Hash code
|
|
134
|
+
def hash
|
|
135
|
+
[total, weekly, monthly, yearly].hash
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Builds the object from hash
|
|
139
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
140
|
+
# @return [Object] Returns the model itself
|
|
141
|
+
def self.build_from_hash(attributes)
|
|
142
|
+
return nil unless attributes.is_a?(Hash)
|
|
143
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
144
|
+
transformed_hash = {}
|
|
145
|
+
openapi_types.each_pair do |key, type|
|
|
146
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
147
|
+
transformed_hash["#{key}"] = nil
|
|
148
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
149
|
+
# check to ensure the input is an array given that the attribute
|
|
150
|
+
# is documented as an array but the input is not
|
|
151
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
152
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
153
|
+
end
|
|
154
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
155
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
156
|
+
end
|
|
157
|
+
end
|
|
158
|
+
new(transformed_hash)
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Returns the object in the form of hash
|
|
162
|
+
# @return [Hash] Returns the object in the form of hash
|
|
163
|
+
def to_hash
|
|
164
|
+
hash = {}
|
|
165
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
166
|
+
value = self.send(attr)
|
|
167
|
+
if value.nil?
|
|
168
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
169
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
hash[param] = _to_hash(value)
|
|
173
|
+
end
|
|
174
|
+
hash
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
end
|
|
@@ -1,33 +1,42 @@
|
|
|
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 ScorePrivacy
|
|
17
|
-
|
|
18
18
|
PUBLIC = "public".freeze
|
|
19
19
|
PRIVATE = "private".freeze
|
|
20
20
|
ORGANIZATION_PUBLIC = "organizationPublic".freeze
|
|
21
21
|
PRIVATE_LINK = "privateLink".freeze
|
|
22
22
|
|
|
23
|
+
def self.all_vars
|
|
24
|
+
@all_vars ||= [PUBLIC, PRIVATE, ORGANIZATION_PUBLIC, PRIVATE_LINK].freeze
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Builds the enum from string
|
|
28
|
+
# @param [String] The enum value in the form of the string
|
|
29
|
+
# @return [String] The enum value
|
|
30
|
+
def self.build_from_hash(value)
|
|
31
|
+
new.build_from_hash(value)
|
|
32
|
+
end
|
|
33
|
+
|
|
23
34
|
# Builds the enum from string
|
|
24
35
|
# @param [String] The enum value in the form of the string
|
|
25
36
|
# @return [String] The enum value
|
|
26
37
|
def build_from_hash(value)
|
|
27
|
-
|
|
28
|
-
raise "Invalid ENUM value #{value} for class #ScorePrivacy"
|
|
29
|
-
value
|
|
38
|
+
return value if ScorePrivacy.all_vars.include?(value)
|
|
39
|
+
raise "Invalid ENUM value #{value} for class #ScorePrivacy"
|
|
30
40
|
end
|
|
31
41
|
end
|
|
32
|
-
|
|
33
42
|
end
|