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
|
# Add a collaborator to a resource.
|
|
17
|
-
class ResourceCollaboratorCreation
|
|
18
|
+
class ResourceCollaboratorCreation < ApiModelBase
|
|
18
19
|
# The unique identifier of a Flat user
|
|
19
20
|
attr_accessor :user
|
|
20
21
|
|
|
@@ -36,7 +37,6 @@ module FlatApi
|
|
|
36
37
|
# `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document
|
|
37
38
|
attr_accessor :acl_admin
|
|
38
39
|
|
|
39
|
-
|
|
40
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
41
41
|
def self.attribute_map
|
|
42
42
|
{
|
|
@@ -50,74 +50,99 @@ module FlatApi
|
|
|
50
50
|
}
|
|
51
51
|
end
|
|
52
52
|
|
|
53
|
+
# Returns attribute mapping this model knows about
|
|
54
|
+
def self.acceptable_attribute_map
|
|
55
|
+
attribute_map
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# Returns all the JSON keys this model knows about
|
|
59
|
+
def self.acceptable_attributes
|
|
60
|
+
acceptable_attribute_map.values
|
|
61
|
+
end
|
|
62
|
+
|
|
53
63
|
# Attribute type mapping.
|
|
54
|
-
def self.
|
|
64
|
+
def self.openapi_types
|
|
55
65
|
{
|
|
56
66
|
:'user' => :'String',
|
|
57
67
|
:'group' => :'String',
|
|
58
68
|
:'user_email' => :'String',
|
|
59
69
|
:'user_token' => :'String',
|
|
60
|
-
:'acl_read' => :'
|
|
61
|
-
:'acl_write' => :'
|
|
62
|
-
:'acl_admin' => :'
|
|
70
|
+
:'acl_read' => :'Boolean',
|
|
71
|
+
:'acl_write' => :'Boolean',
|
|
72
|
+
:'acl_admin' => :'Boolean'
|
|
63
73
|
}
|
|
64
74
|
end
|
|
65
75
|
|
|
76
|
+
# List of attributes with nullable: true
|
|
77
|
+
def self.openapi_nullable
|
|
78
|
+
Set.new([
|
|
79
|
+
])
|
|
80
|
+
end
|
|
81
|
+
|
|
66
82
|
# Initializes the object
|
|
67
83
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
68
84
|
def initialize(attributes = {})
|
|
69
|
-
|
|
85
|
+
if (!attributes.is_a?(Hash))
|
|
86
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ResourceCollaboratorCreation` initialize method"
|
|
87
|
+
end
|
|
70
88
|
|
|
71
|
-
# convert string to symbol for hash key
|
|
72
|
-
|
|
89
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
90
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
91
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
92
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
93
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ResourceCollaboratorCreation`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
94
|
+
end
|
|
95
|
+
h[k.to_sym] = v
|
|
96
|
+
}
|
|
73
97
|
|
|
74
|
-
if attributes.
|
|
98
|
+
if attributes.key?(:'user')
|
|
75
99
|
self.user = attributes[:'user']
|
|
76
100
|
end
|
|
77
101
|
|
|
78
|
-
if attributes.
|
|
102
|
+
if attributes.key?(:'group')
|
|
79
103
|
self.group = attributes[:'group']
|
|
80
104
|
end
|
|
81
105
|
|
|
82
|
-
if attributes.
|
|
83
|
-
self.user_email = attributes[:'
|
|
106
|
+
if attributes.key?(:'user_email')
|
|
107
|
+
self.user_email = attributes[:'user_email']
|
|
84
108
|
end
|
|
85
109
|
|
|
86
|
-
if attributes.
|
|
87
|
-
self.user_token = attributes[:'
|
|
110
|
+
if attributes.key?(:'user_token')
|
|
111
|
+
self.user_token = attributes[:'user_token']
|
|
88
112
|
end
|
|
89
113
|
|
|
90
|
-
if attributes.
|
|
91
|
-
self.acl_read = attributes[:'
|
|
114
|
+
if attributes.key?(:'acl_read')
|
|
115
|
+
self.acl_read = attributes[:'acl_read']
|
|
92
116
|
else
|
|
93
117
|
self.acl_read = true
|
|
94
118
|
end
|
|
95
119
|
|
|
96
|
-
if attributes.
|
|
97
|
-
self.acl_write = attributes[:'
|
|
120
|
+
if attributes.key?(:'acl_write')
|
|
121
|
+
self.acl_write = attributes[:'acl_write']
|
|
98
122
|
else
|
|
99
123
|
self.acl_write = false
|
|
100
124
|
end
|
|
101
125
|
|
|
102
|
-
if attributes.
|
|
103
|
-
self.acl_admin = attributes[:'
|
|
126
|
+
if attributes.key?(:'acl_admin')
|
|
127
|
+
self.acl_admin = attributes[:'acl_admin']
|
|
104
128
|
else
|
|
105
129
|
self.acl_admin = false
|
|
106
130
|
end
|
|
107
|
-
|
|
108
131
|
end
|
|
109
132
|
|
|
110
133
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
111
134
|
# @return Array for valid properties with the reasons
|
|
112
135
|
def list_invalid_properties
|
|
136
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
113
137
|
invalid_properties = Array.new
|
|
114
|
-
|
|
138
|
+
invalid_properties
|
|
115
139
|
end
|
|
116
140
|
|
|
117
141
|
# Check to see if the all the properties in the model are valid
|
|
118
142
|
# @return true if the model is valid
|
|
119
143
|
def valid?
|
|
120
|
-
|
|
144
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
145
|
+
true
|
|
121
146
|
end
|
|
122
147
|
|
|
123
148
|
# Checks equality by comparing each attribute.
|
|
@@ -141,7 +166,7 @@ module FlatApi
|
|
|
141
166
|
end
|
|
142
167
|
|
|
143
168
|
# Calculates hash code according to all attributes.
|
|
144
|
-
# @return [
|
|
169
|
+
# @return [Integer] Hash code
|
|
145
170
|
def hash
|
|
146
171
|
[user, group, user_email, user_token, acl_read, acl_write, acl_admin].hash
|
|
147
172
|
end
|
|
@@ -149,75 +174,24 @@ module FlatApi
|
|
|
149
174
|
# Builds the object from hash
|
|
150
175
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
151
176
|
# @return [Object] Returns the model itself
|
|
152
|
-
def build_from_hash(attributes)
|
|
177
|
+
def self.build_from_hash(attributes)
|
|
153
178
|
return nil unless attributes.is_a?(Hash)
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
179
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
180
|
+
transformed_hash = {}
|
|
181
|
+
openapi_types.each_pair do |key, type|
|
|
182
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
183
|
+
transformed_hash["#{key}"] = nil
|
|
184
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
185
|
+
# check to ensure the input is an array given that the attribute
|
|
157
186
|
# is documented as an array but the input is not
|
|
158
|
-
if attributes[
|
|
159
|
-
|
|
187
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
188
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
160
189
|
end
|
|
161
|
-
elsif !attributes[
|
|
162
|
-
|
|
163
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
164
|
-
end
|
|
165
|
-
|
|
166
|
-
self
|
|
167
|
-
end
|
|
168
|
-
|
|
169
|
-
# Deserializes the data based on type
|
|
170
|
-
# @param string type Data type
|
|
171
|
-
# @param string value Value to be deserialized
|
|
172
|
-
# @return [Object] Deserialized data
|
|
173
|
-
def _deserialize(type, value)
|
|
174
|
-
case type.to_sym
|
|
175
|
-
when :DateTime
|
|
176
|
-
DateTime.parse(value)
|
|
177
|
-
when :Date
|
|
178
|
-
Date.parse(value)
|
|
179
|
-
when :String
|
|
180
|
-
value.to_s
|
|
181
|
-
when :Integer
|
|
182
|
-
value.to_i
|
|
183
|
-
when :Float
|
|
184
|
-
value.to_f
|
|
185
|
-
when :BOOLEAN
|
|
186
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
187
|
-
true
|
|
188
|
-
else
|
|
189
|
-
false
|
|
190
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
191
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
190
192
|
end
|
|
191
|
-
when :Object
|
|
192
|
-
# generic object (usually a Hash), return directly
|
|
193
|
-
value
|
|
194
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
195
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
196
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
197
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
198
|
-
k_type = Regexp.last_match[:k_type]
|
|
199
|
-
v_type = Regexp.last_match[:v_type]
|
|
200
|
-
{}.tap do |hash|
|
|
201
|
-
value.each do |k, v|
|
|
202
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
203
|
-
end
|
|
204
|
-
end
|
|
205
|
-
else # model
|
|
206
|
-
temp_model = FlatApi.const_get(type).new
|
|
207
|
-
temp_model.build_from_hash(value)
|
|
208
193
|
end
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
# Returns the string representation of the object
|
|
212
|
-
# @return [String] String presentation of the object
|
|
213
|
-
def to_s
|
|
214
|
-
to_hash.to_s
|
|
215
|
-
end
|
|
216
|
-
|
|
217
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
218
|
-
# @return [Hash] Returns the object in the form of hash
|
|
219
|
-
def to_body
|
|
220
|
-
to_hash
|
|
194
|
+
new(transformed_hash)
|
|
221
195
|
end
|
|
222
196
|
|
|
223
197
|
# Returns the object in the form of hash
|
|
@@ -226,30 +200,16 @@ module FlatApi
|
|
|
226
200
|
hash = {}
|
|
227
201
|
self.class.attribute_map.each_pair do |attr, param|
|
|
228
202
|
value = self.send(attr)
|
|
229
|
-
|
|
203
|
+
if value.nil?
|
|
204
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
205
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
206
|
+
end
|
|
207
|
+
|
|
230
208
|
hash[param] = _to_hash(value)
|
|
231
209
|
end
|
|
232
210
|
hash
|
|
233
211
|
end
|
|
234
212
|
|
|
235
|
-
# Outputs non-array value in the form of hash
|
|
236
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
237
|
-
# @param [Object] value Any valid value
|
|
238
|
-
# @return [Hash] Returns the value in the form of hash
|
|
239
|
-
def _to_hash(value)
|
|
240
|
-
if value.is_a?(Array)
|
|
241
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
242
|
-
elsif value.is_a?(Hash)
|
|
243
|
-
{}.tap do |hash|
|
|
244
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
245
|
-
end
|
|
246
|
-
elsif value.respond_to? :to_hash
|
|
247
|
-
value.to_hash
|
|
248
|
-
else
|
|
249
|
-
value
|
|
250
|
-
end
|
|
251
|
-
end
|
|
252
|
-
|
|
253
213
|
end
|
|
254
214
|
|
|
255
215
|
end
|
|
@@ -1,20 +1,21 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
# The rights of the current user on a score or collection
|
|
17
|
-
class ResourceRights
|
|
18
|
+
class ResourceRights < ApiModelBase
|
|
18
19
|
# `True` if the current user can read the current document
|
|
19
20
|
attr_accessor :acl_read
|
|
20
21
|
|
|
@@ -24,64 +25,187 @@ module FlatApi
|
|
|
24
25
|
# `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.
|
|
25
26
|
attr_accessor :acl_admin
|
|
26
27
|
|
|
28
|
+
# `True` if the current user is a collaborator of the current document (direct or via group).
|
|
29
|
+
attr_accessor :is_collaborator
|
|
30
|
+
|
|
31
|
+
# The type of the collaborator for the resource
|
|
32
|
+
attr_accessor :collaborator_type
|
|
33
|
+
|
|
34
|
+
class EnumAttributeValidator
|
|
35
|
+
attr_reader :datatype
|
|
36
|
+
attr_reader :allowable_values
|
|
37
|
+
|
|
38
|
+
def initialize(datatype, allowable_values)
|
|
39
|
+
@allowable_values = allowable_values.map do |value|
|
|
40
|
+
case datatype.to_s
|
|
41
|
+
when /Integer/i
|
|
42
|
+
value.to_i
|
|
43
|
+
when /Float/i
|
|
44
|
+
value.to_f
|
|
45
|
+
else
|
|
46
|
+
value
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def valid?(value)
|
|
52
|
+
!value || allowable_values.include?(value)
|
|
53
|
+
end
|
|
54
|
+
end
|
|
27
55
|
|
|
28
56
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
29
57
|
def self.attribute_map
|
|
30
58
|
{
|
|
31
59
|
:'acl_read' => :'aclRead',
|
|
32
60
|
:'acl_write' => :'aclWrite',
|
|
33
|
-
:'acl_admin' => :'aclAdmin'
|
|
61
|
+
:'acl_admin' => :'aclAdmin',
|
|
62
|
+
:'is_collaborator' => :'isCollaborator',
|
|
63
|
+
:'collaborator_type' => :'collaboratorType'
|
|
34
64
|
}
|
|
35
65
|
end
|
|
36
66
|
|
|
67
|
+
# Returns attribute mapping this model knows about
|
|
68
|
+
def self.acceptable_attribute_map
|
|
69
|
+
attribute_map
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Returns all the JSON keys this model knows about
|
|
73
|
+
def self.acceptable_attributes
|
|
74
|
+
acceptable_attribute_map.values
|
|
75
|
+
end
|
|
76
|
+
|
|
37
77
|
# Attribute type mapping.
|
|
38
|
-
def self.
|
|
78
|
+
def self.openapi_types
|
|
39
79
|
{
|
|
40
|
-
:'acl_read' => :'
|
|
41
|
-
:'acl_write' => :'
|
|
42
|
-
:'acl_admin' => :'
|
|
80
|
+
:'acl_read' => :'Boolean',
|
|
81
|
+
:'acl_write' => :'Boolean',
|
|
82
|
+
:'acl_admin' => :'Boolean',
|
|
83
|
+
:'is_collaborator' => :'Boolean',
|
|
84
|
+
:'collaborator_type' => :'String'
|
|
43
85
|
}
|
|
44
86
|
end
|
|
45
87
|
|
|
88
|
+
# List of attributes with nullable: true
|
|
89
|
+
def self.openapi_nullable
|
|
90
|
+
Set.new([
|
|
91
|
+
])
|
|
92
|
+
end
|
|
93
|
+
|
|
46
94
|
# Initializes the object
|
|
47
95
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
48
96
|
def initialize(attributes = {})
|
|
49
|
-
|
|
97
|
+
if (!attributes.is_a?(Hash))
|
|
98
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ResourceRights` initialize method"
|
|
99
|
+
end
|
|
50
100
|
|
|
51
|
-
# convert string to symbol for hash key
|
|
52
|
-
|
|
101
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
102
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
103
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
104
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
105
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ResourceRights`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
106
|
+
end
|
|
107
|
+
h[k.to_sym] = v
|
|
108
|
+
}
|
|
53
109
|
|
|
54
|
-
if attributes.
|
|
55
|
-
self.acl_read = attributes[:'
|
|
110
|
+
if attributes.key?(:'acl_read')
|
|
111
|
+
self.acl_read = attributes[:'acl_read']
|
|
56
112
|
else
|
|
57
113
|
self.acl_read = false
|
|
58
114
|
end
|
|
59
115
|
|
|
60
|
-
if attributes.
|
|
61
|
-
self.acl_write = attributes[:'
|
|
116
|
+
if attributes.key?(:'acl_write')
|
|
117
|
+
self.acl_write = attributes[:'acl_write']
|
|
62
118
|
else
|
|
63
119
|
self.acl_write = false
|
|
64
120
|
end
|
|
65
121
|
|
|
66
|
-
if attributes.
|
|
67
|
-
self.acl_admin = attributes[:'
|
|
122
|
+
if attributes.key?(:'acl_admin')
|
|
123
|
+
self.acl_admin = attributes[:'acl_admin']
|
|
68
124
|
else
|
|
69
125
|
self.acl_admin = false
|
|
70
126
|
end
|
|
71
127
|
|
|
128
|
+
if attributes.key?(:'is_collaborator')
|
|
129
|
+
self.is_collaborator = attributes[:'is_collaborator']
|
|
130
|
+
else
|
|
131
|
+
self.is_collaborator = false
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if attributes.key?(:'collaborator_type')
|
|
135
|
+
self.collaborator_type = attributes[:'collaborator_type']
|
|
136
|
+
end
|
|
72
137
|
end
|
|
73
138
|
|
|
74
139
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
75
140
|
# @return Array for valid properties with the reasons
|
|
76
141
|
def list_invalid_properties
|
|
142
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
77
143
|
invalid_properties = Array.new
|
|
78
|
-
|
|
144
|
+
if @acl_read.nil?
|
|
145
|
+
invalid_properties.push('invalid value for "acl_read", acl_read cannot be nil.')
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
if @acl_write.nil?
|
|
149
|
+
invalid_properties.push('invalid value for "acl_write", acl_write cannot be nil.')
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
if @acl_admin.nil?
|
|
153
|
+
invalid_properties.push('invalid value for "acl_admin", acl_admin cannot be nil.')
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
invalid_properties
|
|
79
157
|
end
|
|
80
158
|
|
|
81
159
|
# Check to see if the all the properties in the model are valid
|
|
82
160
|
# @return true if the model is valid
|
|
83
161
|
def valid?
|
|
84
|
-
|
|
162
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
163
|
+
return false if @acl_read.nil?
|
|
164
|
+
return false if @acl_write.nil?
|
|
165
|
+
return false if @acl_admin.nil?
|
|
166
|
+
collaborator_type_validator = EnumAttributeValidator.new('String', ["owner", "user", "group"])
|
|
167
|
+
return false unless collaborator_type_validator.valid?(@collaborator_type)
|
|
168
|
+
true
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Custom attribute writer method with validation
|
|
172
|
+
# @param [Object] acl_read Value to be assigned
|
|
173
|
+
def acl_read=(acl_read)
|
|
174
|
+
if acl_read.nil?
|
|
175
|
+
fail ArgumentError, 'acl_read cannot be nil'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
@acl_read = acl_read
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Custom attribute writer method with validation
|
|
182
|
+
# @param [Object] acl_write Value to be assigned
|
|
183
|
+
def acl_write=(acl_write)
|
|
184
|
+
if acl_write.nil?
|
|
185
|
+
fail ArgumentError, 'acl_write cannot be nil'
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
@acl_write = acl_write
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Custom attribute writer method with validation
|
|
192
|
+
# @param [Object] acl_admin Value to be assigned
|
|
193
|
+
def acl_admin=(acl_admin)
|
|
194
|
+
if acl_admin.nil?
|
|
195
|
+
fail ArgumentError, 'acl_admin cannot be nil'
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
@acl_admin = acl_admin
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
202
|
+
# @param [Object] collaborator_type Object to be assigned
|
|
203
|
+
def collaborator_type=(collaborator_type)
|
|
204
|
+
validator = EnumAttributeValidator.new('String', ["owner", "user", "group"])
|
|
205
|
+
unless validator.valid?(collaborator_type)
|
|
206
|
+
fail ArgumentError, "invalid value for \"collaborator_type\", must be one of #{validator.allowable_values}."
|
|
207
|
+
end
|
|
208
|
+
@collaborator_type = collaborator_type
|
|
85
209
|
end
|
|
86
210
|
|
|
87
211
|
# Checks equality by comparing each attribute.
|
|
@@ -91,7 +215,9 @@ module FlatApi
|
|
|
91
215
|
self.class == o.class &&
|
|
92
216
|
acl_read == o.acl_read &&
|
|
93
217
|
acl_write == o.acl_write &&
|
|
94
|
-
acl_admin == o.acl_admin
|
|
218
|
+
acl_admin == o.acl_admin &&
|
|
219
|
+
is_collaborator == o.is_collaborator &&
|
|
220
|
+
collaborator_type == o.collaborator_type
|
|
95
221
|
end
|
|
96
222
|
|
|
97
223
|
# @see the `==` method
|
|
@@ -101,83 +227,32 @@ module FlatApi
|
|
|
101
227
|
end
|
|
102
228
|
|
|
103
229
|
# Calculates hash code according to all attributes.
|
|
104
|
-
# @return [
|
|
230
|
+
# @return [Integer] Hash code
|
|
105
231
|
def hash
|
|
106
|
-
[acl_read, acl_write, acl_admin].hash
|
|
232
|
+
[acl_read, acl_write, acl_admin, is_collaborator, collaborator_type].hash
|
|
107
233
|
end
|
|
108
234
|
|
|
109
235
|
# Builds the object from hash
|
|
110
236
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
111
237
|
# @return [Object] Returns the model itself
|
|
112
|
-
def build_from_hash(attributes)
|
|
238
|
+
def self.build_from_hash(attributes)
|
|
113
239
|
return nil unless attributes.is_a?(Hash)
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
240
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
241
|
+
transformed_hash = {}
|
|
242
|
+
openapi_types.each_pair do |key, type|
|
|
243
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
244
|
+
transformed_hash["#{key}"] = nil
|
|
245
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
246
|
+
# check to ensure the input is an array given that the attribute
|
|
117
247
|
# is documented as an array but the input is not
|
|
118
|
-
if attributes[
|
|
119
|
-
|
|
248
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
249
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
120
250
|
end
|
|
121
|
-
elsif !attributes[
|
|
122
|
-
|
|
123
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
self
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# Deserializes the data based on type
|
|
130
|
-
# @param string type Data type
|
|
131
|
-
# @param string value Value to be deserialized
|
|
132
|
-
# @return [Object] Deserialized data
|
|
133
|
-
def _deserialize(type, value)
|
|
134
|
-
case type.to_sym
|
|
135
|
-
when :DateTime
|
|
136
|
-
DateTime.parse(value)
|
|
137
|
-
when :Date
|
|
138
|
-
Date.parse(value)
|
|
139
|
-
when :String
|
|
140
|
-
value.to_s
|
|
141
|
-
when :Integer
|
|
142
|
-
value.to_i
|
|
143
|
-
when :Float
|
|
144
|
-
value.to_f
|
|
145
|
-
when :BOOLEAN
|
|
146
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
147
|
-
true
|
|
148
|
-
else
|
|
149
|
-
false
|
|
251
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
252
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
150
253
|
end
|
|
151
|
-
when :Object
|
|
152
|
-
# generic object (usually a Hash), return directly
|
|
153
|
-
value
|
|
154
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
155
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
156
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
157
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
158
|
-
k_type = Regexp.last_match[:k_type]
|
|
159
|
-
v_type = Regexp.last_match[:v_type]
|
|
160
|
-
{}.tap do |hash|
|
|
161
|
-
value.each do |k, v|
|
|
162
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
163
|
-
end
|
|
164
|
-
end
|
|
165
|
-
else # model
|
|
166
|
-
temp_model = FlatApi.const_get(type).new
|
|
167
|
-
temp_model.build_from_hash(value)
|
|
168
254
|
end
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
# Returns the string representation of the object
|
|
172
|
-
# @return [String] String presentation of the object
|
|
173
|
-
def to_s
|
|
174
|
-
to_hash.to_s
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
178
|
-
# @return [Hash] Returns the object in the form of hash
|
|
179
|
-
def to_body
|
|
180
|
-
to_hash
|
|
255
|
+
new(transformed_hash)
|
|
181
256
|
end
|
|
182
257
|
|
|
183
258
|
# Returns the object in the form of hash
|
|
@@ -186,30 +261,16 @@ module FlatApi
|
|
|
186
261
|
hash = {}
|
|
187
262
|
self.class.attribute_map.each_pair do |attr, param|
|
|
188
263
|
value = self.send(attr)
|
|
189
|
-
|
|
264
|
+
if value.nil?
|
|
265
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
266
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
267
|
+
end
|
|
268
|
+
|
|
190
269
|
hash[param] = _to_hash(value)
|
|
191
270
|
end
|
|
192
271
|
hash
|
|
193
272
|
end
|
|
194
273
|
|
|
195
|
-
# Outputs non-array value in the form of hash
|
|
196
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
197
|
-
# @param [Object] value Any valid value
|
|
198
|
-
# @return [Hash] Returns the value in the form of hash
|
|
199
|
-
def _to_hash(value)
|
|
200
|
-
if value.is_a?(Array)
|
|
201
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
202
|
-
elsif value.is_a?(Hash)
|
|
203
|
-
{}.tap do |hash|
|
|
204
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
205
|
-
end
|
|
206
|
-
elsif value.respond_to? :to_hash
|
|
207
|
-
value.to_hash
|
|
208
|
-
else
|
|
209
|
-
value
|
|
210
|
-
end
|
|
211
|
-
end
|
|
212
|
-
|
|
213
274
|
end
|
|
214
275
|
|
|
215
276
|
end
|