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
|
# A coursework submission on Google Classroom
|
|
17
|
-
class GoogleClassroomSubmission
|
|
18
|
+
class GoogleClassroomSubmission < ApiModelBase
|
|
18
19
|
# Identifier of the coursework submission assigned by Classroom
|
|
19
20
|
attr_accessor :id
|
|
20
21
|
|
|
@@ -24,7 +25,6 @@ module FlatApi
|
|
|
24
25
|
# Absolute link to this coursework in the Classroom web UI
|
|
25
26
|
attr_accessor :alternate_link
|
|
26
27
|
|
|
27
|
-
|
|
28
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
29
29
|
def self.attribute_map
|
|
30
30
|
{
|
|
@@ -34,8 +34,18 @@ module FlatApi
|
|
|
34
34
|
}
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
+
# Returns attribute mapping this model knows about
|
|
38
|
+
def self.acceptable_attribute_map
|
|
39
|
+
attribute_map
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Returns all the JSON keys this model knows about
|
|
43
|
+
def self.acceptable_attributes
|
|
44
|
+
acceptable_attribute_map.values
|
|
45
|
+
end
|
|
46
|
+
|
|
37
47
|
# Attribute type mapping.
|
|
38
|
-
def self.
|
|
48
|
+
def self.openapi_types
|
|
39
49
|
{
|
|
40
50
|
:'id' => :'String',
|
|
41
51
|
:'state' => :'String',
|
|
@@ -43,39 +53,105 @@ module FlatApi
|
|
|
43
53
|
}
|
|
44
54
|
end
|
|
45
55
|
|
|
56
|
+
# List of attributes with nullable: true
|
|
57
|
+
def self.openapi_nullable
|
|
58
|
+
Set.new([
|
|
59
|
+
])
|
|
60
|
+
end
|
|
61
|
+
|
|
46
62
|
# Initializes the object
|
|
47
63
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
48
64
|
def initialize(attributes = {})
|
|
49
|
-
|
|
65
|
+
if (!attributes.is_a?(Hash))
|
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::GoogleClassroomSubmission` initialize method"
|
|
67
|
+
end
|
|
50
68
|
|
|
51
|
-
# convert string to symbol for hash key
|
|
52
|
-
|
|
69
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
70
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
71
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
72
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::GoogleClassroomSubmission`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
74
|
+
end
|
|
75
|
+
h[k.to_sym] = v
|
|
76
|
+
}
|
|
53
77
|
|
|
54
|
-
if attributes.
|
|
78
|
+
if attributes.key?(:'id')
|
|
55
79
|
self.id = attributes[:'id']
|
|
80
|
+
else
|
|
81
|
+
self.id = nil
|
|
56
82
|
end
|
|
57
83
|
|
|
58
|
-
if attributes.
|
|
84
|
+
if attributes.key?(:'state')
|
|
59
85
|
self.state = attributes[:'state']
|
|
86
|
+
else
|
|
87
|
+
self.state = nil
|
|
60
88
|
end
|
|
61
89
|
|
|
62
|
-
if attributes.
|
|
63
|
-
self.alternate_link = attributes[:'
|
|
90
|
+
if attributes.key?(:'alternate_link')
|
|
91
|
+
self.alternate_link = attributes[:'alternate_link']
|
|
92
|
+
else
|
|
93
|
+
self.alternate_link = nil
|
|
64
94
|
end
|
|
65
|
-
|
|
66
95
|
end
|
|
67
96
|
|
|
68
97
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
69
98
|
# @return Array for valid properties with the reasons
|
|
70
99
|
def list_invalid_properties
|
|
100
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
71
101
|
invalid_properties = Array.new
|
|
72
|
-
|
|
102
|
+
if @id.nil?
|
|
103
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
if @state.nil?
|
|
107
|
+
invalid_properties.push('invalid value for "state", state cannot be nil.')
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
if @alternate_link.nil?
|
|
111
|
+
invalid_properties.push('invalid value for "alternate_link", alternate_link cannot be nil.')
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
invalid_properties
|
|
73
115
|
end
|
|
74
116
|
|
|
75
117
|
# Check to see if the all the properties in the model are valid
|
|
76
118
|
# @return true if the model is valid
|
|
77
119
|
def valid?
|
|
78
|
-
|
|
120
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
121
|
+
return false if @id.nil?
|
|
122
|
+
return false if @state.nil?
|
|
123
|
+
return false if @alternate_link.nil?
|
|
124
|
+
true
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Custom attribute writer method with validation
|
|
128
|
+
# @param [Object] id Value to be assigned
|
|
129
|
+
def id=(id)
|
|
130
|
+
if id.nil?
|
|
131
|
+
fail ArgumentError, 'id cannot be nil'
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
@id = id
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# Custom attribute writer method with validation
|
|
138
|
+
# @param [Object] state Value to be assigned
|
|
139
|
+
def state=(state)
|
|
140
|
+
if state.nil?
|
|
141
|
+
fail ArgumentError, 'state cannot be nil'
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
@state = state
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Custom attribute writer method with validation
|
|
148
|
+
# @param [Object] alternate_link Value to be assigned
|
|
149
|
+
def alternate_link=(alternate_link)
|
|
150
|
+
if alternate_link.nil?
|
|
151
|
+
fail ArgumentError, 'alternate_link cannot be nil'
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
@alternate_link = alternate_link
|
|
79
155
|
end
|
|
80
156
|
|
|
81
157
|
# Checks equality by comparing each attribute.
|
|
@@ -95,7 +171,7 @@ module FlatApi
|
|
|
95
171
|
end
|
|
96
172
|
|
|
97
173
|
# Calculates hash code according to all attributes.
|
|
98
|
-
# @return [
|
|
174
|
+
# @return [Integer] Hash code
|
|
99
175
|
def hash
|
|
100
176
|
[id, state, alternate_link].hash
|
|
101
177
|
end
|
|
@@ -103,75 +179,24 @@ module FlatApi
|
|
|
103
179
|
# Builds the object from hash
|
|
104
180
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
105
181
|
# @return [Object] Returns the model itself
|
|
106
|
-
def build_from_hash(attributes)
|
|
182
|
+
def self.build_from_hash(attributes)
|
|
107
183
|
return nil unless attributes.is_a?(Hash)
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
184
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
185
|
+
transformed_hash = {}
|
|
186
|
+
openapi_types.each_pair do |key, type|
|
|
187
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
188
|
+
transformed_hash["#{key}"] = nil
|
|
189
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
190
|
+
# check to ensure the input is an array given that the attribute
|
|
111
191
|
# is documented as an array but the input is not
|
|
112
|
-
if attributes[
|
|
113
|
-
|
|
114
|
-
end
|
|
115
|
-
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
116
|
-
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
117
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
self
|
|
121
|
-
end
|
|
122
|
-
|
|
123
|
-
# Deserializes the data based on type
|
|
124
|
-
# @param string type Data type
|
|
125
|
-
# @param string value Value to be deserialized
|
|
126
|
-
# @return [Object] Deserialized data
|
|
127
|
-
def _deserialize(type, value)
|
|
128
|
-
case type.to_sym
|
|
129
|
-
when :DateTime
|
|
130
|
-
DateTime.parse(value)
|
|
131
|
-
when :Date
|
|
132
|
-
Date.parse(value)
|
|
133
|
-
when :String
|
|
134
|
-
value.to_s
|
|
135
|
-
when :Integer
|
|
136
|
-
value.to_i
|
|
137
|
-
when :Float
|
|
138
|
-
value.to_f
|
|
139
|
-
when :BOOLEAN
|
|
140
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
141
|
-
true
|
|
142
|
-
else
|
|
143
|
-
false
|
|
144
|
-
end
|
|
145
|
-
when :Object
|
|
146
|
-
# generic object (usually a Hash), return directly
|
|
147
|
-
value
|
|
148
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
149
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
150
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
151
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
152
|
-
k_type = Regexp.last_match[:k_type]
|
|
153
|
-
v_type = Regexp.last_match[:v_type]
|
|
154
|
-
{}.tap do |hash|
|
|
155
|
-
value.each do |k, v|
|
|
156
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
192
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
193
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
157
194
|
end
|
|
195
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
196
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
158
197
|
end
|
|
159
|
-
else # model
|
|
160
|
-
temp_model = FlatApi.const_get(type).new
|
|
161
|
-
temp_model.build_from_hash(value)
|
|
162
198
|
end
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
# Returns the string representation of the object
|
|
166
|
-
# @return [String] String presentation of the object
|
|
167
|
-
def to_s
|
|
168
|
-
to_hash.to_s
|
|
169
|
-
end
|
|
170
|
-
|
|
171
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
172
|
-
# @return [Hash] Returns the object in the form of hash
|
|
173
|
-
def to_body
|
|
174
|
-
to_hash
|
|
199
|
+
new(transformed_hash)
|
|
175
200
|
end
|
|
176
201
|
|
|
177
202
|
# Returns the object in the form of hash
|
|
@@ -180,30 +205,16 @@ module FlatApi
|
|
|
180
205
|
hash = {}
|
|
181
206
|
self.class.attribute_map.each_pair do |attr, param|
|
|
182
207
|
value = self.send(attr)
|
|
183
|
-
|
|
208
|
+
if value.nil?
|
|
209
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
210
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
211
|
+
end
|
|
212
|
+
|
|
184
213
|
hash[param] = _to_hash(value)
|
|
185
214
|
end
|
|
186
215
|
hash
|
|
187
216
|
end
|
|
188
217
|
|
|
189
|
-
# Outputs non-array value in the form of hash
|
|
190
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
191
|
-
# @param [Object] value Any valid value
|
|
192
|
-
# @return [Hash] Returns the value in the form of hash
|
|
193
|
-
def _to_hash(value)
|
|
194
|
-
if value.is_a?(Array)
|
|
195
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
196
|
-
elsif value.is_a?(Hash)
|
|
197
|
-
{}.tap do |hash|
|
|
198
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
199
|
-
end
|
|
200
|
-
elsif value.respond_to? :to_hash
|
|
201
|
-
value.to_hash
|
|
202
|
-
else
|
|
203
|
-
value
|
|
204
|
-
end
|
|
205
|
-
end
|
|
206
|
-
|
|
207
218
|
end
|
|
208
219
|
|
|
209
220
|
end
|
|
@@ -0,0 +1,51 @@
|
|
|
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
|
+
class Grade
|
|
18
|
+
N1 = "1".freeze
|
|
19
|
+
N2 = "2".freeze
|
|
20
|
+
N3 = "3".freeze
|
|
21
|
+
N4 = "4".freeze
|
|
22
|
+
N5 = "5".freeze
|
|
23
|
+
N6 = "6".freeze
|
|
24
|
+
N7 = "7".freeze
|
|
25
|
+
N8 = "8".freeze
|
|
26
|
+
N9 = "9".freeze
|
|
27
|
+
N10 = "10".freeze
|
|
28
|
+
N11 = "11".freeze
|
|
29
|
+
N12 = "12".freeze
|
|
30
|
+
UNIVERSITY = "university".freeze
|
|
31
|
+
|
|
32
|
+
def self.all_vars
|
|
33
|
+
@all_vars ||= [N1, N2, N3, N4, N5, N6, N7, N8, N9, N10, N11, N12, UNIVERSITY].freeze
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Builds the enum from string
|
|
37
|
+
# @param [String] The enum value in the form of the string
|
|
38
|
+
# @return [String] The enum value
|
|
39
|
+
def self.build_from_hash(value)
|
|
40
|
+
new.build_from_hash(value)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Builds the enum from string
|
|
44
|
+
# @param [String] The enum value in the form of the string
|
|
45
|
+
# @return [String] The enum value
|
|
46
|
+
def build_from_hash(value)
|
|
47
|
+
return value if Grade.all_vars.include?(value)
|
|
48
|
+
raise "Invalid ENUM value #{value} for class #Grade"
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
@@ -1,27 +1,27 @@
|
|
|
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
|
# A group of users
|
|
17
|
-
class Group
|
|
18
|
+
class Group < ApiModelBase
|
|
18
19
|
# The unique identifier of the group
|
|
19
20
|
attr_accessor :id
|
|
20
21
|
|
|
21
22
|
# The display name of the group
|
|
22
23
|
attr_accessor :name
|
|
23
24
|
|
|
24
|
-
# The type of the group: * `generic`: A group created by a Flat user * `classTeachers`: A group created automaticaly by Flat that contains the teachers of a class * `classStudents`: A group created automaticaly by Flat that contains the studnets of a class
|
|
25
25
|
attr_accessor :type
|
|
26
26
|
|
|
27
27
|
# The number of users in this group
|
|
@@ -71,80 +71,93 @@ module FlatApi
|
|
|
71
71
|
}
|
|
72
72
|
end
|
|
73
73
|
|
|
74
|
+
# Returns attribute mapping this model knows about
|
|
75
|
+
def self.acceptable_attribute_map
|
|
76
|
+
attribute_map
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Returns all the JSON keys this model knows about
|
|
80
|
+
def self.acceptable_attributes
|
|
81
|
+
acceptable_attribute_map.values
|
|
82
|
+
end
|
|
83
|
+
|
|
74
84
|
# Attribute type mapping.
|
|
75
|
-
def self.
|
|
85
|
+
def self.openapi_types
|
|
76
86
|
{
|
|
77
87
|
:'id' => :'String',
|
|
78
88
|
:'name' => :'String',
|
|
79
|
-
:'type' => :'
|
|
89
|
+
:'type' => :'GroupType',
|
|
80
90
|
:'users_count' => :'Float',
|
|
81
|
-
:'read_only' => :'
|
|
91
|
+
:'read_only' => :'Boolean',
|
|
82
92
|
:'organization' => :'String',
|
|
83
|
-
:'creation_date' => :'
|
|
93
|
+
:'creation_date' => :'Time'
|
|
84
94
|
}
|
|
85
95
|
end
|
|
86
96
|
|
|
97
|
+
# List of attributes with nullable: true
|
|
98
|
+
def self.openapi_nullable
|
|
99
|
+
Set.new([
|
|
100
|
+
])
|
|
101
|
+
end
|
|
102
|
+
|
|
87
103
|
# Initializes the object
|
|
88
104
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
89
105
|
def initialize(attributes = {})
|
|
90
|
-
|
|
106
|
+
if (!attributes.is_a?(Hash))
|
|
107
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::Group` initialize method"
|
|
108
|
+
end
|
|
91
109
|
|
|
92
|
-
# convert string to symbol for hash key
|
|
93
|
-
|
|
110
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
111
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
112
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
113
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
114
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::Group`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
115
|
+
end
|
|
116
|
+
h[k.to_sym] = v
|
|
117
|
+
}
|
|
94
118
|
|
|
95
|
-
if attributes.
|
|
119
|
+
if attributes.key?(:'id')
|
|
96
120
|
self.id = attributes[:'id']
|
|
97
121
|
end
|
|
98
122
|
|
|
99
|
-
if attributes.
|
|
123
|
+
if attributes.key?(:'name')
|
|
100
124
|
self.name = attributes[:'name']
|
|
101
125
|
end
|
|
102
126
|
|
|
103
|
-
if attributes.
|
|
127
|
+
if attributes.key?(:'type')
|
|
104
128
|
self.type = attributes[:'type']
|
|
105
129
|
end
|
|
106
130
|
|
|
107
|
-
if attributes.
|
|
108
|
-
self.users_count = attributes[:'
|
|
131
|
+
if attributes.key?(:'users_count')
|
|
132
|
+
self.users_count = attributes[:'users_count']
|
|
109
133
|
end
|
|
110
134
|
|
|
111
|
-
if attributes.
|
|
112
|
-
self.read_only = attributes[:'
|
|
135
|
+
if attributes.key?(:'read_only')
|
|
136
|
+
self.read_only = attributes[:'read_only']
|
|
113
137
|
end
|
|
114
138
|
|
|
115
|
-
if attributes.
|
|
139
|
+
if attributes.key?(:'organization')
|
|
116
140
|
self.organization = attributes[:'organization']
|
|
117
141
|
end
|
|
118
142
|
|
|
119
|
-
if attributes.
|
|
120
|
-
self.creation_date = attributes[:'
|
|
143
|
+
if attributes.key?(:'creation_date')
|
|
144
|
+
self.creation_date = attributes[:'creation_date']
|
|
121
145
|
end
|
|
122
|
-
|
|
123
146
|
end
|
|
124
147
|
|
|
125
148
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
126
149
|
# @return Array for valid properties with the reasons
|
|
127
150
|
def list_invalid_properties
|
|
151
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
128
152
|
invalid_properties = Array.new
|
|
129
|
-
|
|
153
|
+
invalid_properties
|
|
130
154
|
end
|
|
131
155
|
|
|
132
156
|
# Check to see if the all the properties in the model are valid
|
|
133
157
|
# @return true if the model is valid
|
|
134
158
|
def valid?
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
return true
|
|
138
|
-
end
|
|
139
|
-
|
|
140
|
-
# Custom attribute writer method checking allowed values (enum).
|
|
141
|
-
# @param [Object] type Object to be assigned
|
|
142
|
-
def type=(type)
|
|
143
|
-
validator = EnumAttributeValidator.new('String', ["generic", "classTeachers", "classStudents"])
|
|
144
|
-
unless validator.valid?(type)
|
|
145
|
-
fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
|
|
146
|
-
end
|
|
147
|
-
@type = type
|
|
159
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
160
|
+
true
|
|
148
161
|
end
|
|
149
162
|
|
|
150
163
|
# Checks equality by comparing each attribute.
|
|
@@ -168,7 +181,7 @@ module FlatApi
|
|
|
168
181
|
end
|
|
169
182
|
|
|
170
183
|
# Calculates hash code according to all attributes.
|
|
171
|
-
# @return [
|
|
184
|
+
# @return [Integer] Hash code
|
|
172
185
|
def hash
|
|
173
186
|
[id, name, type, users_count, read_only, organization, creation_date].hash
|
|
174
187
|
end
|
|
@@ -176,75 +189,24 @@ module FlatApi
|
|
|
176
189
|
# Builds the object from hash
|
|
177
190
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
178
191
|
# @return [Object] Returns the model itself
|
|
179
|
-
def build_from_hash(attributes)
|
|
192
|
+
def self.build_from_hash(attributes)
|
|
180
193
|
return nil unless attributes.is_a?(Hash)
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
194
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
195
|
+
transformed_hash = {}
|
|
196
|
+
openapi_types.each_pair do |key, type|
|
|
197
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
198
|
+
transformed_hash["#{key}"] = nil
|
|
199
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
200
|
+
# check to ensure the input is an array given that the attribute
|
|
184
201
|
# is documented as an array but the input is not
|
|
185
|
-
if attributes[
|
|
186
|
-
|
|
187
|
-
end
|
|
188
|
-
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
189
|
-
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
190
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
191
|
-
end
|
|
192
|
-
|
|
193
|
-
self
|
|
194
|
-
end
|
|
195
|
-
|
|
196
|
-
# Deserializes the data based on type
|
|
197
|
-
# @param string type Data type
|
|
198
|
-
# @param string value Value to be deserialized
|
|
199
|
-
# @return [Object] Deserialized data
|
|
200
|
-
def _deserialize(type, value)
|
|
201
|
-
case type.to_sym
|
|
202
|
-
when :DateTime
|
|
203
|
-
DateTime.parse(value)
|
|
204
|
-
when :Date
|
|
205
|
-
Date.parse(value)
|
|
206
|
-
when :String
|
|
207
|
-
value.to_s
|
|
208
|
-
when :Integer
|
|
209
|
-
value.to_i
|
|
210
|
-
when :Float
|
|
211
|
-
value.to_f
|
|
212
|
-
when :BOOLEAN
|
|
213
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
214
|
-
true
|
|
215
|
-
else
|
|
216
|
-
false
|
|
217
|
-
end
|
|
218
|
-
when :Object
|
|
219
|
-
# generic object (usually a Hash), return directly
|
|
220
|
-
value
|
|
221
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
222
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
223
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
224
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
225
|
-
k_type = Regexp.last_match[:k_type]
|
|
226
|
-
v_type = Regexp.last_match[:v_type]
|
|
227
|
-
{}.tap do |hash|
|
|
228
|
-
value.each do |k, v|
|
|
229
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
202
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
203
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
230
204
|
end
|
|
205
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
206
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
231
207
|
end
|
|
232
|
-
else # model
|
|
233
|
-
temp_model = FlatApi.const_get(type).new
|
|
234
|
-
temp_model.build_from_hash(value)
|
|
235
208
|
end
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
# Returns the string representation of the object
|
|
239
|
-
# @return [String] String presentation of the object
|
|
240
|
-
def to_s
|
|
241
|
-
to_hash.to_s
|
|
242
|
-
end
|
|
243
|
-
|
|
244
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
245
|
-
# @return [Hash] Returns the object in the form of hash
|
|
246
|
-
def to_body
|
|
247
|
-
to_hash
|
|
209
|
+
new(transformed_hash)
|
|
248
210
|
end
|
|
249
211
|
|
|
250
212
|
# Returns the object in the form of hash
|
|
@@ -253,30 +215,16 @@ module FlatApi
|
|
|
253
215
|
hash = {}
|
|
254
216
|
self.class.attribute_map.each_pair do |attr, param|
|
|
255
217
|
value = self.send(attr)
|
|
256
|
-
|
|
218
|
+
if value.nil?
|
|
219
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
220
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
221
|
+
end
|
|
222
|
+
|
|
257
223
|
hash[param] = _to_hash(value)
|
|
258
224
|
end
|
|
259
225
|
hash
|
|
260
226
|
end
|
|
261
227
|
|
|
262
|
-
# Outputs non-array value in the form of hash
|
|
263
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
264
|
-
# @param [Object] value Any valid value
|
|
265
|
-
# @return [Hash] Returns the value in the form of hash
|
|
266
|
-
def _to_hash(value)
|
|
267
|
-
if value.is_a?(Array)
|
|
268
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
269
|
-
elsif value.is_a?(Hash)
|
|
270
|
-
{}.tap do |hash|
|
|
271
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
272
|
-
end
|
|
273
|
-
elsif value.respond_to? :to_hash
|
|
274
|
-
value.to_hash
|
|
275
|
-
else
|
|
276
|
-
value
|
|
277
|
-
end
|
|
278
|
-
end
|
|
279
|
-
|
|
280
228
|
end
|
|
281
229
|
|
|
282
230
|
end
|