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
|
@@ -0,0 +1,205 @@
|
|
|
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
|
+
# Social networks links
|
|
18
|
+
class UserCommunityProfileLinks < ApiModelBase
|
|
19
|
+
# Spotify Profile URL
|
|
20
|
+
attr_accessor :spotify_url
|
|
21
|
+
|
|
22
|
+
# YouTube channel URL
|
|
23
|
+
attr_accessor :youtube_url
|
|
24
|
+
|
|
25
|
+
# SoundCloud Profile URL
|
|
26
|
+
attr_accessor :soundcloud_url
|
|
27
|
+
|
|
28
|
+
# TikTok profile URL. For updates, also accepts TikTok usernames
|
|
29
|
+
attr_accessor :tiktok_url
|
|
30
|
+
|
|
31
|
+
# Instagram profile URL. For updates, also accepts Instagram usernames
|
|
32
|
+
attr_accessor :instagram_url
|
|
33
|
+
|
|
34
|
+
# Personnal website URL
|
|
35
|
+
attr_accessor :website_url
|
|
36
|
+
|
|
37
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
38
|
+
def self.attribute_map
|
|
39
|
+
{
|
|
40
|
+
:'spotify_url' => :'spotifyUrl',
|
|
41
|
+
:'youtube_url' => :'youtubeUrl',
|
|
42
|
+
:'soundcloud_url' => :'soundcloudUrl',
|
|
43
|
+
:'tiktok_url' => :'tiktokUrl',
|
|
44
|
+
:'instagram_url' => :'instagramUrl',
|
|
45
|
+
:'website_url' => :'websiteUrl'
|
|
46
|
+
}
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Returns attribute mapping this model knows about
|
|
50
|
+
def self.acceptable_attribute_map
|
|
51
|
+
attribute_map
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# Returns all the JSON keys this model knows about
|
|
55
|
+
def self.acceptable_attributes
|
|
56
|
+
acceptable_attribute_map.values
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Attribute type mapping.
|
|
60
|
+
def self.openapi_types
|
|
61
|
+
{
|
|
62
|
+
:'spotify_url' => :'String',
|
|
63
|
+
:'youtube_url' => :'String',
|
|
64
|
+
:'soundcloud_url' => :'String',
|
|
65
|
+
:'tiktok_url' => :'String',
|
|
66
|
+
:'instagram_url' => :'String',
|
|
67
|
+
:'website_url' => :'String'
|
|
68
|
+
}
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# List of attributes with nullable: true
|
|
72
|
+
def self.openapi_nullable
|
|
73
|
+
Set.new([
|
|
74
|
+
:'spotify_url',
|
|
75
|
+
:'youtube_url',
|
|
76
|
+
:'soundcloud_url',
|
|
77
|
+
:'tiktok_url',
|
|
78
|
+
:'instagram_url',
|
|
79
|
+
:'website_url'
|
|
80
|
+
])
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Initializes the object
|
|
84
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
85
|
+
def initialize(attributes = {})
|
|
86
|
+
if (!attributes.is_a?(Hash))
|
|
87
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserCommunityProfileLinks` initialize method"
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
91
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
92
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
93
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
94
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserCommunityProfileLinks`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
95
|
+
end
|
|
96
|
+
h[k.to_sym] = v
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
if attributes.key?(:'spotify_url')
|
|
100
|
+
self.spotify_url = attributes[:'spotify_url']
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
if attributes.key?(:'youtube_url')
|
|
104
|
+
self.youtube_url = attributes[:'youtube_url']
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
if attributes.key?(:'soundcloud_url')
|
|
108
|
+
self.soundcloud_url = attributes[:'soundcloud_url']
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
if attributes.key?(:'tiktok_url')
|
|
112
|
+
self.tiktok_url = attributes[:'tiktok_url']
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
if attributes.key?(:'instagram_url')
|
|
116
|
+
self.instagram_url = attributes[:'instagram_url']
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
if attributes.key?(:'website_url')
|
|
120
|
+
self.website_url = attributes[:'website_url']
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
125
|
+
# @return Array for valid properties with the reasons
|
|
126
|
+
def list_invalid_properties
|
|
127
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
128
|
+
invalid_properties = Array.new
|
|
129
|
+
invalid_properties
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Check to see if the all the properties in the model are valid
|
|
133
|
+
# @return true if the model is valid
|
|
134
|
+
def valid?
|
|
135
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
136
|
+
true
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Checks equality by comparing each attribute.
|
|
140
|
+
# @param [Object] Object to be compared
|
|
141
|
+
def ==(o)
|
|
142
|
+
return true if self.equal?(o)
|
|
143
|
+
self.class == o.class &&
|
|
144
|
+
spotify_url == o.spotify_url &&
|
|
145
|
+
youtube_url == o.youtube_url &&
|
|
146
|
+
soundcloud_url == o.soundcloud_url &&
|
|
147
|
+
tiktok_url == o.tiktok_url &&
|
|
148
|
+
instagram_url == o.instagram_url &&
|
|
149
|
+
website_url == o.website_url
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# @see the `==` method
|
|
153
|
+
# @param [Object] Object to be compared
|
|
154
|
+
def eql?(o)
|
|
155
|
+
self == o
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Calculates hash code according to all attributes.
|
|
159
|
+
# @return [Integer] Hash code
|
|
160
|
+
def hash
|
|
161
|
+
[spotify_url, youtube_url, soundcloud_url, tiktok_url, instagram_url, website_url].hash
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Builds the object from hash
|
|
165
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
166
|
+
# @return [Object] Returns the model itself
|
|
167
|
+
def self.build_from_hash(attributes)
|
|
168
|
+
return nil unless attributes.is_a?(Hash)
|
|
169
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
170
|
+
transformed_hash = {}
|
|
171
|
+
openapi_types.each_pair do |key, type|
|
|
172
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
173
|
+
transformed_hash["#{key}"] = nil
|
|
174
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
175
|
+
# check to ensure the input is an array given that the attribute
|
|
176
|
+
# is documented as an array but the input is not
|
|
177
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
178
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
179
|
+
end
|
|
180
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
181
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
new(transformed_hash)
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# Returns the object in the form of hash
|
|
188
|
+
# @return [Hash] Returns the object in the form of hash
|
|
189
|
+
def to_hash
|
|
190
|
+
hash = {}
|
|
191
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
192
|
+
value = self.send(attr)
|
|
193
|
+
if value.nil?
|
|
194
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
195
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
hash[param] = _to_hash(value)
|
|
199
|
+
end
|
|
200
|
+
hash
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
end
|
|
@@ -1,148 +1,302 @@
|
|
|
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
|
# User creation
|
|
17
|
-
class UserCreation
|
|
18
|
+
class UserCreation < ApiModelBase
|
|
18
19
|
# Username of the new account
|
|
19
20
|
attr_accessor :username
|
|
20
21
|
|
|
22
|
+
# First name of the user
|
|
23
|
+
attr_accessor :firstname
|
|
24
|
+
|
|
25
|
+
# Last name of the user
|
|
26
|
+
attr_accessor :lastname
|
|
27
|
+
|
|
21
28
|
# Email of the new account
|
|
22
29
|
attr_accessor :email
|
|
23
30
|
|
|
24
31
|
# Password of the new account
|
|
25
32
|
attr_accessor :password
|
|
26
33
|
|
|
34
|
+
# User language. Input values will be automatically normalized to a supported locale code.
|
|
27
35
|
attr_accessor :locale
|
|
28
36
|
|
|
37
|
+
# Role of the new account
|
|
38
|
+
attr_accessor :role
|
|
39
|
+
|
|
40
|
+
class EnumAttributeValidator
|
|
41
|
+
attr_reader :datatype
|
|
42
|
+
attr_reader :allowable_values
|
|
43
|
+
|
|
44
|
+
def initialize(datatype, allowable_values)
|
|
45
|
+
@allowable_values = allowable_values.map do |value|
|
|
46
|
+
case datatype.to_s
|
|
47
|
+
when /Integer/i
|
|
48
|
+
value.to_i
|
|
49
|
+
when /Float/i
|
|
50
|
+
value.to_f
|
|
51
|
+
else
|
|
52
|
+
value
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
def valid?(value)
|
|
58
|
+
!value || allowable_values.include?(value)
|
|
59
|
+
end
|
|
60
|
+
end
|
|
29
61
|
|
|
30
62
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
31
63
|
def self.attribute_map
|
|
32
64
|
{
|
|
33
65
|
:'username' => :'username',
|
|
66
|
+
:'firstname' => :'firstname',
|
|
67
|
+
:'lastname' => :'lastname',
|
|
34
68
|
:'email' => :'email',
|
|
35
69
|
:'password' => :'password',
|
|
36
|
-
:'locale' => :'locale'
|
|
70
|
+
:'locale' => :'locale',
|
|
71
|
+
:'role' => :'role'
|
|
37
72
|
}
|
|
38
73
|
end
|
|
39
74
|
|
|
75
|
+
# Returns attribute mapping this model knows about
|
|
76
|
+
def self.acceptable_attribute_map
|
|
77
|
+
attribute_map
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Returns all the JSON keys this model knows about
|
|
81
|
+
def self.acceptable_attributes
|
|
82
|
+
acceptable_attribute_map.values
|
|
83
|
+
end
|
|
84
|
+
|
|
40
85
|
# Attribute type mapping.
|
|
41
|
-
def self.
|
|
86
|
+
def self.openapi_types
|
|
42
87
|
{
|
|
43
88
|
:'username' => :'String',
|
|
89
|
+
:'firstname' => :'String',
|
|
90
|
+
:'lastname' => :'String',
|
|
44
91
|
:'email' => :'String',
|
|
45
92
|
:'password' => :'String',
|
|
46
|
-
:'locale' => :'
|
|
93
|
+
:'locale' => :'String',
|
|
94
|
+
:'role' => :'String'
|
|
47
95
|
}
|
|
48
96
|
end
|
|
49
97
|
|
|
98
|
+
# List of attributes with nullable: true
|
|
99
|
+
def self.openapi_nullable
|
|
100
|
+
Set.new([
|
|
101
|
+
])
|
|
102
|
+
end
|
|
103
|
+
|
|
50
104
|
# Initializes the object
|
|
51
105
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
106
|
def initialize(attributes = {})
|
|
53
|
-
|
|
107
|
+
if (!attributes.is_a?(Hash))
|
|
108
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserCreation` initialize method"
|
|
109
|
+
end
|
|
54
110
|
|
|
55
|
-
# convert string to symbol for hash key
|
|
56
|
-
|
|
111
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
112
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
113
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
114
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
115
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
116
|
+
end
|
|
117
|
+
h[k.to_sym] = v
|
|
118
|
+
}
|
|
57
119
|
|
|
58
|
-
if attributes.
|
|
120
|
+
if attributes.key?(:'username')
|
|
59
121
|
self.username = attributes[:'username']
|
|
122
|
+
else
|
|
123
|
+
self.username = nil
|
|
60
124
|
end
|
|
61
125
|
|
|
62
|
-
if attributes.
|
|
126
|
+
if attributes.key?(:'firstname')
|
|
127
|
+
self.firstname = attributes[:'firstname']
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
if attributes.key?(:'lastname')
|
|
131
|
+
self.lastname = attributes[:'lastname']
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if attributes.key?(:'email')
|
|
63
135
|
self.email = attributes[:'email']
|
|
64
136
|
end
|
|
65
137
|
|
|
66
|
-
if attributes.
|
|
138
|
+
if attributes.key?(:'password')
|
|
67
139
|
self.password = attributes[:'password']
|
|
140
|
+
else
|
|
141
|
+
self.password = nil
|
|
68
142
|
end
|
|
69
143
|
|
|
70
|
-
if attributes.
|
|
144
|
+
if attributes.key?(:'locale')
|
|
71
145
|
self.locale = attributes[:'locale']
|
|
146
|
+
else
|
|
147
|
+
self.locale = 'en'
|
|
72
148
|
end
|
|
73
149
|
|
|
150
|
+
if attributes.key?(:'role')
|
|
151
|
+
self.role = attributes[:'role']
|
|
152
|
+
else
|
|
153
|
+
self.role = 'user'
|
|
154
|
+
end
|
|
74
155
|
end
|
|
75
156
|
|
|
76
157
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
77
158
|
# @return Array for valid properties with the reasons
|
|
78
159
|
def list_invalid_properties
|
|
160
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
79
161
|
invalid_properties = Array.new
|
|
80
162
|
if @username.nil?
|
|
81
|
-
invalid_properties.push(
|
|
163
|
+
invalid_properties.push('invalid value for "username", username cannot be nil.')
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
if @username.to_s.length > 30
|
|
167
|
+
invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 30.')
|
|
82
168
|
end
|
|
83
169
|
|
|
84
|
-
if @username
|
|
85
|
-
invalid_properties.push(
|
|
170
|
+
if @username.to_s.length < 1
|
|
171
|
+
invalid_properties.push('invalid value for "username", the character length must be greater than or equal to 1.')
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
if !@firstname.nil? && @firstname.to_s.length > 60
|
|
175
|
+
invalid_properties.push('invalid value for "firstname", the character length must be smaller than or equal to 60.')
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
if !@lastname.nil? && @lastname.to_s.length > 60
|
|
179
|
+
invalid_properties.push('invalid value for "lastname", the character length must be smaller than or equal to 60.')
|
|
86
180
|
end
|
|
87
181
|
|
|
88
182
|
if @password.nil?
|
|
89
|
-
invalid_properties.push(
|
|
183
|
+
invalid_properties.push('invalid value for "password", password cannot be nil.')
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
if @password.to_s.length > 1000
|
|
187
|
+
invalid_properties.push('invalid value for "password", the character length must be smaller than or equal to 1000.')
|
|
90
188
|
end
|
|
91
189
|
|
|
92
190
|
if @password.to_s.length < 6
|
|
93
|
-
invalid_properties.push(
|
|
191
|
+
invalid_properties.push('invalid value for "password", the character length must be greater than or equal to 6.')
|
|
94
192
|
end
|
|
95
193
|
|
|
96
|
-
|
|
194
|
+
invalid_properties
|
|
97
195
|
end
|
|
98
196
|
|
|
99
197
|
# Check to see if the all the properties in the model are valid
|
|
100
198
|
# @return true if the model is valid
|
|
101
199
|
def valid?
|
|
200
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
102
201
|
return false if @username.nil?
|
|
103
|
-
return false if @username
|
|
202
|
+
return false if @username.to_s.length > 30
|
|
203
|
+
return false if @username.to_s.length < 1
|
|
204
|
+
return false if !@firstname.nil? && @firstname.to_s.length > 60
|
|
205
|
+
return false if !@lastname.nil? && @lastname.to_s.length > 60
|
|
104
206
|
return false if @password.nil?
|
|
207
|
+
return false if @password.to_s.length > 1000
|
|
105
208
|
return false if @password.to_s.length < 6
|
|
106
|
-
|
|
209
|
+
role_validator = EnumAttributeValidator.new('String', ["user", "teacher", "admin", "accountAdmin"])
|
|
210
|
+
return false unless role_validator.valid?(@role)
|
|
211
|
+
true
|
|
107
212
|
end
|
|
108
213
|
|
|
109
214
|
# Custom attribute writer method with validation
|
|
110
215
|
# @param [Object] username Value to be assigned
|
|
111
216
|
def username=(username)
|
|
112
217
|
if username.nil?
|
|
113
|
-
fail ArgumentError,
|
|
218
|
+
fail ArgumentError, 'username cannot be nil'
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
if username.to_s.length > 30
|
|
222
|
+
fail ArgumentError, 'invalid value for "username", the character length must be smaller than or equal to 30.'
|
|
114
223
|
end
|
|
115
224
|
|
|
116
|
-
if username
|
|
117
|
-
fail ArgumentError,
|
|
225
|
+
if username.to_s.length < 1
|
|
226
|
+
fail ArgumentError, 'invalid value for "username", the character length must be greater than or equal to 1.'
|
|
118
227
|
end
|
|
119
228
|
|
|
120
229
|
@username = username
|
|
121
230
|
end
|
|
122
231
|
|
|
232
|
+
# Custom attribute writer method with validation
|
|
233
|
+
# @param [Object] firstname Value to be assigned
|
|
234
|
+
def firstname=(firstname)
|
|
235
|
+
if firstname.nil?
|
|
236
|
+
fail ArgumentError, 'firstname cannot be nil'
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
if firstname.to_s.length > 60
|
|
240
|
+
fail ArgumentError, 'invalid value for "firstname", the character length must be smaller than or equal to 60.'
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
@firstname = firstname
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Custom attribute writer method with validation
|
|
247
|
+
# @param [Object] lastname Value to be assigned
|
|
248
|
+
def lastname=(lastname)
|
|
249
|
+
if lastname.nil?
|
|
250
|
+
fail ArgumentError, 'lastname cannot be nil'
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
if lastname.to_s.length > 60
|
|
254
|
+
fail ArgumentError, 'invalid value for "lastname", the character length must be smaller than or equal to 60.'
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
@lastname = lastname
|
|
258
|
+
end
|
|
259
|
+
|
|
123
260
|
# Custom attribute writer method with validation
|
|
124
261
|
# @param [Object] password Value to be assigned
|
|
125
262
|
def password=(password)
|
|
126
263
|
if password.nil?
|
|
127
|
-
fail ArgumentError,
|
|
264
|
+
fail ArgumentError, 'password cannot be nil'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
if password.to_s.length > 1000
|
|
268
|
+
fail ArgumentError, 'invalid value for "password", the character length must be smaller than or equal to 1000.'
|
|
128
269
|
end
|
|
129
270
|
|
|
130
271
|
if password.to_s.length < 6
|
|
131
|
-
fail ArgumentError,
|
|
272
|
+
fail ArgumentError, 'invalid value for "password", the character length must be greater than or equal to 6.'
|
|
132
273
|
end
|
|
133
274
|
|
|
134
275
|
@password = password
|
|
135
276
|
end
|
|
136
277
|
|
|
278
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
279
|
+
# @param [Object] role Object to be assigned
|
|
280
|
+
def role=(role)
|
|
281
|
+
validator = EnumAttributeValidator.new('String', ["user", "teacher", "admin", "accountAdmin"])
|
|
282
|
+
unless validator.valid?(role)
|
|
283
|
+
fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
|
|
284
|
+
end
|
|
285
|
+
@role = role
|
|
286
|
+
end
|
|
287
|
+
|
|
137
288
|
# Checks equality by comparing each attribute.
|
|
138
289
|
# @param [Object] Object to be compared
|
|
139
290
|
def ==(o)
|
|
140
291
|
return true if self.equal?(o)
|
|
141
292
|
self.class == o.class &&
|
|
142
293
|
username == o.username &&
|
|
294
|
+
firstname == o.firstname &&
|
|
295
|
+
lastname == o.lastname &&
|
|
143
296
|
email == o.email &&
|
|
144
297
|
password == o.password &&
|
|
145
|
-
locale == o.locale
|
|
298
|
+
locale == o.locale &&
|
|
299
|
+
role == o.role
|
|
146
300
|
end
|
|
147
301
|
|
|
148
302
|
# @see the `==` method
|
|
@@ -152,83 +306,32 @@ module FlatApi
|
|
|
152
306
|
end
|
|
153
307
|
|
|
154
308
|
# Calculates hash code according to all attributes.
|
|
155
|
-
# @return [
|
|
309
|
+
# @return [Integer] Hash code
|
|
156
310
|
def hash
|
|
157
|
-
[username, email, password, locale].hash
|
|
311
|
+
[username, firstname, lastname, email, password, locale, role].hash
|
|
158
312
|
end
|
|
159
313
|
|
|
160
314
|
# Builds the object from hash
|
|
161
315
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
162
316
|
# @return [Object] Returns the model itself
|
|
163
|
-
def build_from_hash(attributes)
|
|
317
|
+
def self.build_from_hash(attributes)
|
|
164
318
|
return nil unless attributes.is_a?(Hash)
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
319
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
320
|
+
transformed_hash = {}
|
|
321
|
+
openapi_types.each_pair do |key, type|
|
|
322
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
323
|
+
transformed_hash["#{key}"] = nil
|
|
324
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
325
|
+
# check to ensure the input is an array given that the attribute
|
|
168
326
|
# is documented as an array but the input is not
|
|
169
|
-
if attributes[
|
|
170
|
-
|
|
327
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
328
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
171
329
|
end
|
|
172
|
-
elsif !attributes[
|
|
173
|
-
|
|
174
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
self
|
|
178
|
-
end
|
|
179
|
-
|
|
180
|
-
# Deserializes the data based on type
|
|
181
|
-
# @param string type Data type
|
|
182
|
-
# @param string value Value to be deserialized
|
|
183
|
-
# @return [Object] Deserialized data
|
|
184
|
-
def _deserialize(type, value)
|
|
185
|
-
case type.to_sym
|
|
186
|
-
when :DateTime
|
|
187
|
-
DateTime.parse(value)
|
|
188
|
-
when :Date
|
|
189
|
-
Date.parse(value)
|
|
190
|
-
when :String
|
|
191
|
-
value.to_s
|
|
192
|
-
when :Integer
|
|
193
|
-
value.to_i
|
|
194
|
-
when :Float
|
|
195
|
-
value.to_f
|
|
196
|
-
when :BOOLEAN
|
|
197
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
198
|
-
true
|
|
199
|
-
else
|
|
200
|
-
false
|
|
330
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
331
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
201
332
|
end
|
|
202
|
-
when :Object
|
|
203
|
-
# generic object (usually a Hash), return directly
|
|
204
|
-
value
|
|
205
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
206
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
207
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
208
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
209
|
-
k_type = Regexp.last_match[:k_type]
|
|
210
|
-
v_type = Regexp.last_match[:v_type]
|
|
211
|
-
{}.tap do |hash|
|
|
212
|
-
value.each do |k, v|
|
|
213
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
214
|
-
end
|
|
215
|
-
end
|
|
216
|
-
else # model
|
|
217
|
-
temp_model = FlatApi.const_get(type).new
|
|
218
|
-
temp_model.build_from_hash(value)
|
|
219
333
|
end
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
# Returns the string representation of the object
|
|
223
|
-
# @return [String] String presentation of the object
|
|
224
|
-
def to_s
|
|
225
|
-
to_hash.to_s
|
|
226
|
-
end
|
|
227
|
-
|
|
228
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
229
|
-
# @return [Hash] Returns the object in the form of hash
|
|
230
|
-
def to_body
|
|
231
|
-
to_hash
|
|
334
|
+
new(transformed_hash)
|
|
232
335
|
end
|
|
233
336
|
|
|
234
337
|
# Returns the object in the form of hash
|
|
@@ -237,30 +340,16 @@ module FlatApi
|
|
|
237
340
|
hash = {}
|
|
238
341
|
self.class.attribute_map.each_pair do |attr, param|
|
|
239
342
|
value = self.send(attr)
|
|
240
|
-
|
|
343
|
+
if value.nil?
|
|
344
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
345
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
346
|
+
end
|
|
347
|
+
|
|
241
348
|
hash[param] = _to_hash(value)
|
|
242
349
|
end
|
|
243
350
|
hash
|
|
244
351
|
end
|
|
245
352
|
|
|
246
|
-
# Outputs non-array value in the form of hash
|
|
247
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
248
|
-
# @param [Object] value Any valid value
|
|
249
|
-
# @return [Hash] Returns the value in the form of hash
|
|
250
|
-
def _to_hash(value)
|
|
251
|
-
if value.is_a?(Array)
|
|
252
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
253
|
-
elsif value.is_a?(Hash)
|
|
254
|
-
{}.tap do |hash|
|
|
255
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
256
|
-
end
|
|
257
|
-
elsif value.respond_to? :to_hash
|
|
258
|
-
value.to_hash
|
|
259
|
-
else
|
|
260
|
-
value
|
|
261
|
-
end
|
|
262
|
-
end
|
|
263
|
-
|
|
264
353
|
end
|
|
265
354
|
|
|
266
355
|
end
|