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,37 +1,49 @@
|
|
|
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
|
# Public User details summary
|
|
17
|
-
class UserPublicSummary
|
|
18
|
+
class UserPublicSummary < ApiModelBase
|
|
18
19
|
# The user unique identifier
|
|
19
20
|
attr_accessor :id
|
|
20
21
|
|
|
22
|
+
# The type of user account
|
|
23
|
+
attr_accessor :type
|
|
24
|
+
|
|
25
|
+
attr_accessor :product
|
|
26
|
+
|
|
21
27
|
# The user name (unique for the organization)
|
|
22
28
|
attr_accessor :username
|
|
23
29
|
|
|
24
|
-
#
|
|
25
|
-
attr_accessor :name
|
|
26
|
-
|
|
27
|
-
# The name that can be directly printed (name or username)
|
|
30
|
+
# The name that can be directly printed (name, firstname & lastname, or username)
|
|
28
31
|
attr_accessor :printable_name
|
|
29
32
|
|
|
30
|
-
#
|
|
33
|
+
# Firstname of the user (for education users)
|
|
34
|
+
attr_accessor :firstname
|
|
35
|
+
|
|
36
|
+
# Lastname of the user (for education users)
|
|
37
|
+
attr_accessor :lastname
|
|
38
|
+
|
|
39
|
+
# A displayable name for the user (for consumer users)
|
|
40
|
+
attr_accessor :name
|
|
41
|
+
|
|
42
|
+
# The URL of the picture to display
|
|
31
43
|
attr_accessor :picture
|
|
32
44
|
|
|
33
|
-
#
|
|
34
|
-
attr_accessor :
|
|
45
|
+
# List of badges for the user profile: - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge`
|
|
46
|
+
attr_accessor :badges
|
|
35
47
|
|
|
36
48
|
# Organization ID (for Edu users only)
|
|
37
49
|
attr_accessor :organization
|
|
@@ -43,16 +55,41 @@ module FlatApi
|
|
|
43
55
|
# Link to user profile (for Indiv. users only)
|
|
44
56
|
attr_accessor :html_url
|
|
45
57
|
|
|
58
|
+
class EnumAttributeValidator
|
|
59
|
+
attr_reader :datatype
|
|
60
|
+
attr_reader :allowable_values
|
|
61
|
+
|
|
62
|
+
def initialize(datatype, allowable_values)
|
|
63
|
+
@allowable_values = allowable_values.map do |value|
|
|
64
|
+
case datatype.to_s
|
|
65
|
+
when /Integer/i
|
|
66
|
+
value.to_i
|
|
67
|
+
when /Float/i
|
|
68
|
+
value.to_f
|
|
69
|
+
else
|
|
70
|
+
value
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def valid?(value)
|
|
76
|
+
!value || allowable_values.include?(value)
|
|
77
|
+
end
|
|
78
|
+
end
|
|
46
79
|
|
|
47
80
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
48
81
|
def self.attribute_map
|
|
49
82
|
{
|
|
50
83
|
:'id' => :'id',
|
|
84
|
+
:'type' => :'type',
|
|
85
|
+
:'product' => :'product',
|
|
51
86
|
:'username' => :'username',
|
|
52
|
-
:'name' => :'name',
|
|
53
87
|
:'printable_name' => :'printableName',
|
|
88
|
+
:'firstname' => :'firstname',
|
|
89
|
+
:'lastname' => :'lastname',
|
|
90
|
+
:'name' => :'name',
|
|
54
91
|
:'picture' => :'picture',
|
|
55
|
-
:'
|
|
92
|
+
:'badges' => :'badges',
|
|
56
93
|
:'organization' => :'organization',
|
|
57
94
|
:'organization_role' => :'organizationRole',
|
|
58
95
|
:'class_role' => :'classRole',
|
|
@@ -60,15 +97,29 @@ module FlatApi
|
|
|
60
97
|
}
|
|
61
98
|
end
|
|
62
99
|
|
|
100
|
+
# Returns attribute mapping this model knows about
|
|
101
|
+
def self.acceptable_attribute_map
|
|
102
|
+
attribute_map
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Returns all the JSON keys this model knows about
|
|
106
|
+
def self.acceptable_attributes
|
|
107
|
+
acceptable_attribute_map.values
|
|
108
|
+
end
|
|
109
|
+
|
|
63
110
|
# Attribute type mapping.
|
|
64
|
-
def self.
|
|
111
|
+
def self.openapi_types
|
|
65
112
|
{
|
|
66
113
|
:'id' => :'String',
|
|
114
|
+
:'type' => :'String',
|
|
115
|
+
:'product' => :'TutteoProduct',
|
|
67
116
|
:'username' => :'String',
|
|
68
|
-
:'name' => :'String',
|
|
69
117
|
:'printable_name' => :'String',
|
|
118
|
+
:'firstname' => :'String',
|
|
119
|
+
:'lastname' => :'String',
|
|
120
|
+
:'name' => :'String',
|
|
70
121
|
:'picture' => :'String',
|
|
71
|
-
:'
|
|
122
|
+
:'badges' => :'Array<String>',
|
|
72
123
|
:'organization' => :'String',
|
|
73
124
|
:'organization_role' => :'OrganizationRoles',
|
|
74
125
|
:'class_role' => :'ClassRoles',
|
|
@@ -76,67 +127,194 @@ module FlatApi
|
|
|
76
127
|
}
|
|
77
128
|
end
|
|
78
129
|
|
|
130
|
+
# List of attributes with nullable: true
|
|
131
|
+
def self.openapi_nullable
|
|
132
|
+
Set.new([
|
|
133
|
+
])
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# List of class defined in allOf (OpenAPI v3)
|
|
137
|
+
def self.openapi_all_of
|
|
138
|
+
[
|
|
139
|
+
:'UserBasics'
|
|
140
|
+
]
|
|
141
|
+
end
|
|
142
|
+
|
|
79
143
|
# Initializes the object
|
|
80
144
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
81
145
|
def initialize(attributes = {})
|
|
82
|
-
|
|
146
|
+
if (!attributes.is_a?(Hash))
|
|
147
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserPublicSummary` initialize method"
|
|
148
|
+
end
|
|
83
149
|
|
|
84
|
-
# convert string to symbol for hash key
|
|
85
|
-
|
|
150
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
151
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
152
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
153
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
154
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserPublicSummary`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
155
|
+
end
|
|
156
|
+
h[k.to_sym] = v
|
|
157
|
+
}
|
|
86
158
|
|
|
87
|
-
if attributes.
|
|
159
|
+
if attributes.key?(:'id')
|
|
88
160
|
self.id = attributes[:'id']
|
|
161
|
+
else
|
|
162
|
+
self.id = nil
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
if attributes.key?(:'type')
|
|
166
|
+
self.type = attributes[:'type']
|
|
167
|
+
else
|
|
168
|
+
self.type = nil
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
if attributes.key?(:'product')
|
|
172
|
+
self.product = attributes[:'product']
|
|
173
|
+
else
|
|
174
|
+
self.product = 'flat'
|
|
89
175
|
end
|
|
90
176
|
|
|
91
|
-
if attributes.
|
|
177
|
+
if attributes.key?(:'username')
|
|
92
178
|
self.username = attributes[:'username']
|
|
179
|
+
else
|
|
180
|
+
self.username = nil
|
|
93
181
|
end
|
|
94
182
|
|
|
95
|
-
if attributes.
|
|
96
|
-
self.
|
|
183
|
+
if attributes.key?(:'printable_name')
|
|
184
|
+
self.printable_name = attributes[:'printable_name']
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
if attributes.key?(:'firstname')
|
|
188
|
+
self.firstname = attributes[:'firstname']
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
if attributes.key?(:'lastname')
|
|
192
|
+
self.lastname = attributes[:'lastname']
|
|
97
193
|
end
|
|
98
194
|
|
|
99
|
-
if attributes.
|
|
100
|
-
self.
|
|
195
|
+
if attributes.key?(:'name')
|
|
196
|
+
self.name = attributes[:'name']
|
|
101
197
|
end
|
|
102
198
|
|
|
103
|
-
if attributes.
|
|
199
|
+
if attributes.key?(:'picture')
|
|
104
200
|
self.picture = attributes[:'picture']
|
|
201
|
+
else
|
|
202
|
+
self.picture = nil
|
|
105
203
|
end
|
|
106
204
|
|
|
107
|
-
if attributes.
|
|
108
|
-
|
|
205
|
+
if attributes.key?(:'badges')
|
|
206
|
+
if (value = attributes[:'badges']).is_a?(Array)
|
|
207
|
+
self.badges = value
|
|
208
|
+
end
|
|
109
209
|
end
|
|
110
210
|
|
|
111
|
-
if attributes.
|
|
211
|
+
if attributes.key?(:'organization')
|
|
112
212
|
self.organization = attributes[:'organization']
|
|
113
213
|
end
|
|
114
214
|
|
|
115
|
-
if attributes.
|
|
116
|
-
self.organization_role = attributes[:'
|
|
215
|
+
if attributes.key?(:'organization_role')
|
|
216
|
+
self.organization_role = attributes[:'organization_role']
|
|
117
217
|
end
|
|
118
218
|
|
|
119
|
-
if attributes.
|
|
120
|
-
self.class_role = attributes[:'
|
|
219
|
+
if attributes.key?(:'class_role')
|
|
220
|
+
self.class_role = attributes[:'class_role']
|
|
121
221
|
end
|
|
122
222
|
|
|
123
|
-
if attributes.
|
|
124
|
-
self.html_url = attributes[:'
|
|
223
|
+
if attributes.key?(:'html_url')
|
|
224
|
+
self.html_url = attributes[:'html_url']
|
|
125
225
|
end
|
|
126
|
-
|
|
127
226
|
end
|
|
128
227
|
|
|
129
228
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
130
229
|
# @return Array for valid properties with the reasons
|
|
131
230
|
def list_invalid_properties
|
|
231
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
132
232
|
invalid_properties = Array.new
|
|
133
|
-
|
|
233
|
+
if @id.nil?
|
|
234
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
if @type.nil?
|
|
238
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
if @product.nil?
|
|
242
|
+
invalid_properties.push('invalid value for "product", product cannot be nil.')
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
if @username.nil?
|
|
246
|
+
invalid_properties.push('invalid value for "username", username cannot be nil.')
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
if @picture.nil?
|
|
250
|
+
invalid_properties.push('invalid value for "picture", picture cannot be nil.')
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
invalid_properties
|
|
134
254
|
end
|
|
135
255
|
|
|
136
256
|
# Check to see if the all the properties in the model are valid
|
|
137
257
|
# @return true if the model is valid
|
|
138
258
|
def valid?
|
|
139
|
-
|
|
259
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
260
|
+
return false if @id.nil?
|
|
261
|
+
return false if @type.nil?
|
|
262
|
+
type_validator = EnumAttributeValidator.new('String', ["user", "guest"])
|
|
263
|
+
return false unless type_validator.valid?(@type)
|
|
264
|
+
return false if @product.nil?
|
|
265
|
+
return false if @username.nil?
|
|
266
|
+
return false if @picture.nil?
|
|
267
|
+
true
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Custom attribute writer method with validation
|
|
271
|
+
# @param [Object] id Value to be assigned
|
|
272
|
+
def id=(id)
|
|
273
|
+
if id.nil?
|
|
274
|
+
fail ArgumentError, 'id cannot be nil'
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
@id = id
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
281
|
+
# @param [Object] type Object to be assigned
|
|
282
|
+
def type=(type)
|
|
283
|
+
validator = EnumAttributeValidator.new('String', ["user", "guest"])
|
|
284
|
+
unless validator.valid?(type)
|
|
285
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
|
286
|
+
end
|
|
287
|
+
@type = type
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Custom attribute writer method with validation
|
|
291
|
+
# @param [Object] product Value to be assigned
|
|
292
|
+
def product=(product)
|
|
293
|
+
if product.nil?
|
|
294
|
+
fail ArgumentError, 'product cannot be nil'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
@product = product
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Custom attribute writer method with validation
|
|
301
|
+
# @param [Object] username Value to be assigned
|
|
302
|
+
def username=(username)
|
|
303
|
+
if username.nil?
|
|
304
|
+
fail ArgumentError, 'username cannot be nil'
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
@username = username
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# Custom attribute writer method with validation
|
|
311
|
+
# @param [Object] picture Value to be assigned
|
|
312
|
+
def picture=(picture)
|
|
313
|
+
if picture.nil?
|
|
314
|
+
fail ArgumentError, 'picture cannot be nil'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
@picture = picture
|
|
140
318
|
end
|
|
141
319
|
|
|
142
320
|
# Checks equality by comparing each attribute.
|
|
@@ -145,11 +323,15 @@ module FlatApi
|
|
|
145
323
|
return true if self.equal?(o)
|
|
146
324
|
self.class == o.class &&
|
|
147
325
|
id == o.id &&
|
|
326
|
+
type == o.type &&
|
|
327
|
+
product == o.product &&
|
|
148
328
|
username == o.username &&
|
|
149
|
-
name == o.name &&
|
|
150
329
|
printable_name == o.printable_name &&
|
|
330
|
+
firstname == o.firstname &&
|
|
331
|
+
lastname == o.lastname &&
|
|
332
|
+
name == o.name &&
|
|
151
333
|
picture == o.picture &&
|
|
152
|
-
|
|
334
|
+
badges == o.badges &&
|
|
153
335
|
organization == o.organization &&
|
|
154
336
|
organization_role == o.organization_role &&
|
|
155
337
|
class_role == o.class_role &&
|
|
@@ -163,83 +345,32 @@ module FlatApi
|
|
|
163
345
|
end
|
|
164
346
|
|
|
165
347
|
# Calculates hash code according to all attributes.
|
|
166
|
-
# @return [
|
|
348
|
+
# @return [Integer] Hash code
|
|
167
349
|
def hash
|
|
168
|
-
[id,
|
|
350
|
+
[id, type, product, username, printable_name, firstname, lastname, name, picture, badges, organization, organization_role, class_role, html_url].hash
|
|
169
351
|
end
|
|
170
352
|
|
|
171
353
|
# Builds the object from hash
|
|
172
354
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
173
355
|
# @return [Object] Returns the model itself
|
|
174
|
-
def build_from_hash(attributes)
|
|
356
|
+
def self.build_from_hash(attributes)
|
|
175
357
|
return nil unless attributes.is_a?(Hash)
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
358
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
359
|
+
transformed_hash = {}
|
|
360
|
+
openapi_types.each_pair do |key, type|
|
|
361
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
362
|
+
transformed_hash["#{key}"] = nil
|
|
363
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
364
|
+
# check to ensure the input is an array given that the attribute
|
|
179
365
|
# is documented as an array but the input is not
|
|
180
|
-
if attributes[
|
|
181
|
-
|
|
182
|
-
end
|
|
183
|
-
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
184
|
-
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
185
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
186
|
-
end
|
|
187
|
-
|
|
188
|
-
self
|
|
189
|
-
end
|
|
190
|
-
|
|
191
|
-
# Deserializes the data based on type
|
|
192
|
-
# @param string type Data type
|
|
193
|
-
# @param string value Value to be deserialized
|
|
194
|
-
# @return [Object] Deserialized data
|
|
195
|
-
def _deserialize(type, value)
|
|
196
|
-
case type.to_sym
|
|
197
|
-
when :DateTime
|
|
198
|
-
DateTime.parse(value)
|
|
199
|
-
when :Date
|
|
200
|
-
Date.parse(value)
|
|
201
|
-
when :String
|
|
202
|
-
value.to_s
|
|
203
|
-
when :Integer
|
|
204
|
-
value.to_i
|
|
205
|
-
when :Float
|
|
206
|
-
value.to_f
|
|
207
|
-
when :BOOLEAN
|
|
208
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
209
|
-
true
|
|
210
|
-
else
|
|
211
|
-
false
|
|
212
|
-
end
|
|
213
|
-
when :Object
|
|
214
|
-
# generic object (usually a Hash), return directly
|
|
215
|
-
value
|
|
216
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
217
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
218
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
219
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
220
|
-
k_type = Regexp.last_match[:k_type]
|
|
221
|
-
v_type = Regexp.last_match[:v_type]
|
|
222
|
-
{}.tap do |hash|
|
|
223
|
-
value.each do |k, v|
|
|
224
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
366
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
367
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
225
368
|
end
|
|
369
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
370
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
226
371
|
end
|
|
227
|
-
else # model
|
|
228
|
-
temp_model = FlatApi.const_get(type).new
|
|
229
|
-
temp_model.build_from_hash(value)
|
|
230
372
|
end
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
# Returns the string representation of the object
|
|
234
|
-
# @return [String] String presentation of the object
|
|
235
|
-
def to_s
|
|
236
|
-
to_hash.to_s
|
|
237
|
-
end
|
|
238
|
-
|
|
239
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
240
|
-
# @return [Hash] Returns the object in the form of hash
|
|
241
|
-
def to_body
|
|
242
|
-
to_hash
|
|
373
|
+
new(transformed_hash)
|
|
243
374
|
end
|
|
244
375
|
|
|
245
376
|
# Returns the object in the form of hash
|
|
@@ -248,30 +379,16 @@ module FlatApi
|
|
|
248
379
|
hash = {}
|
|
249
380
|
self.class.attribute_map.each_pair do |attr, param|
|
|
250
381
|
value = self.send(attr)
|
|
251
|
-
|
|
382
|
+
if value.nil?
|
|
383
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
384
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
385
|
+
end
|
|
386
|
+
|
|
252
387
|
hash[param] = _to_hash(value)
|
|
253
388
|
end
|
|
254
389
|
hash
|
|
255
390
|
end
|
|
256
391
|
|
|
257
|
-
# Outputs non-array value in the form of hash
|
|
258
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
259
|
-
# @param [Object] value Any valid value
|
|
260
|
-
# @return [Hash] Returns the value in the form of hash
|
|
261
|
-
def _to_hash(value)
|
|
262
|
-
if value.is_a?(Array)
|
|
263
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
264
|
-
elsif value.is_a?(Hash)
|
|
265
|
-
{}.tap do |hash|
|
|
266
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
267
|
-
end
|
|
268
|
-
elsif value.respond_to? :to_hash
|
|
269
|
-
value.to_hash
|
|
270
|
-
else
|
|
271
|
-
value
|
|
272
|
-
end
|
|
273
|
-
end
|
|
274
|
-
|
|
275
392
|
end
|
|
276
393
|
|
|
277
394
|
end
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Flat API
|
|
3
|
+
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
|
+
Contact: developers@flat.io
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module FlatApi
|
|
17
|
+
class UserSigninLink < ApiModelBase
|
|
18
|
+
# URL to use to sign in to this account
|
|
19
|
+
attr_accessor :url
|
|
20
|
+
|
|
21
|
+
# Raw sign-in token, can be used to build custom URLs (e.g. deep links)
|
|
22
|
+
attr_accessor :token
|
|
23
|
+
|
|
24
|
+
# Date when the link expires
|
|
25
|
+
attr_accessor :expiration_date
|
|
26
|
+
|
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
28
|
+
def self.attribute_map
|
|
29
|
+
{
|
|
30
|
+
:'url' => :'url',
|
|
31
|
+
:'token' => :'token',
|
|
32
|
+
:'expiration_date' => :'expirationDate'
|
|
33
|
+
}
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Returns attribute mapping this model knows about
|
|
37
|
+
def self.acceptable_attribute_map
|
|
38
|
+
attribute_map
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Returns all the JSON keys this model knows about
|
|
42
|
+
def self.acceptable_attributes
|
|
43
|
+
acceptable_attribute_map.values
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Attribute type mapping.
|
|
47
|
+
def self.openapi_types
|
|
48
|
+
{
|
|
49
|
+
:'url' => :'String',
|
|
50
|
+
:'token' => :'String',
|
|
51
|
+
:'expiration_date' => :'Time'
|
|
52
|
+
}
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# List of attributes with nullable: true
|
|
56
|
+
def self.openapi_nullable
|
|
57
|
+
Set.new([
|
|
58
|
+
])
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# Initializes the object
|
|
62
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
63
|
+
def initialize(attributes = {})
|
|
64
|
+
if (!attributes.is_a?(Hash))
|
|
65
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::UserSigninLink` initialize method"
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
69
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
70
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
71
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
72
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::UserSigninLink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
73
|
+
end
|
|
74
|
+
h[k.to_sym] = v
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
if attributes.key?(:'url')
|
|
78
|
+
self.url = attributes[:'url']
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
if attributes.key?(:'token')
|
|
82
|
+
self.token = attributes[:'token']
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
if attributes.key?(:'expiration_date')
|
|
86
|
+
self.expiration_date = attributes[:'expiration_date']
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
91
|
+
# @return Array for valid properties with the reasons
|
|
92
|
+
def list_invalid_properties
|
|
93
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
94
|
+
invalid_properties = Array.new
|
|
95
|
+
invalid_properties
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Check to see if the all the properties in the model are valid
|
|
99
|
+
# @return true if the model is valid
|
|
100
|
+
def valid?
|
|
101
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
102
|
+
true
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Checks equality by comparing each attribute.
|
|
106
|
+
# @param [Object] Object to be compared
|
|
107
|
+
def ==(o)
|
|
108
|
+
return true if self.equal?(o)
|
|
109
|
+
self.class == o.class &&
|
|
110
|
+
url == o.url &&
|
|
111
|
+
token == o.token &&
|
|
112
|
+
expiration_date == o.expiration_date
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# @see the `==` method
|
|
116
|
+
# @param [Object] Object to be compared
|
|
117
|
+
def eql?(o)
|
|
118
|
+
self == o
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Calculates hash code according to all attributes.
|
|
122
|
+
# @return [Integer] Hash code
|
|
123
|
+
def hash
|
|
124
|
+
[url, token, expiration_date].hash
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Builds the object from hash
|
|
128
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
129
|
+
# @return [Object] Returns the model itself
|
|
130
|
+
def self.build_from_hash(attributes)
|
|
131
|
+
return nil unless attributes.is_a?(Hash)
|
|
132
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
133
|
+
transformed_hash = {}
|
|
134
|
+
openapi_types.each_pair do |key, type|
|
|
135
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
136
|
+
transformed_hash["#{key}"] = nil
|
|
137
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
138
|
+
# check to ensure the input is an array given that the attribute
|
|
139
|
+
# is documented as an array but the input is not
|
|
140
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
141
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
142
|
+
end
|
|
143
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
144
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
new(transformed_hash)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# Returns the object in the form of hash
|
|
151
|
+
# @return [Hash] Returns the object in the form of hash
|
|
152
|
+
def to_hash
|
|
153
|
+
hash = {}
|
|
154
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
155
|
+
value = self.send(attr)
|
|
156
|
+
if value.nil?
|
|
157
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
158
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
hash[param] = _to_hash(value)
|
|
162
|
+
end
|
|
163
|
+
hash
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
end
|