flat_api 0.1.2 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/flat_api/api/account_api.rb +31 -21
- data/lib/flat_api/api/class_api.rb +1405 -405
- data/lib/flat_api/api/collection_api.rb +684 -0
- data/lib/flat_api/api/edu_resources_api.rb +851 -0
- data/lib/flat_api/api/group_api.rb +81 -55
- data/lib/flat_api/api/organization_api.rb +524 -180
- data/lib/flat_api/api/score_api.rb +1034 -570
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +114 -76
- data/lib/flat_api/api_client.rb +112 -107
- data/lib/flat_api/api_error.rb +24 -4
- data/lib/flat_api/configuration.rb +105 -16
- data/lib/flat_api/models/api_access_token.rb +268 -0
- data/lib/flat_api/models/app_scopes.rb +59 -0
- data/lib/flat_api/models/assignment.rb +192 -101
- data/lib/flat_api/models/assignment_capabilities.rb +283 -0
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +240 -0
- data/lib/flat_api/models/assignment_copy.rb +80 -169
- data/lib/flat_api/models/assignment_copy_response.rb +430 -0
- data/lib/flat_api/models/assignment_copy_to_class.rb +243 -0
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +233 -0
- data/lib/flat_api/models/assignment_submission.rb +249 -66
- data/lib/flat_api/models/assignment_submission_comment.rb +276 -0
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +223 -0
- data/lib/flat_api/models/assignment_submission_comments.rb +225 -0
- data/lib/flat_api/models/assignment_submission_history.rb +384 -0
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +235 -0
- data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
- data/lib/flat_api/models/assignment_submission_lti.rb +222 -0
- data/lib/flat_api/models/assignment_submission_playback_inner.rb +240 -0
- data/lib/flat_api/models/assignment_submission_state.rb +42 -0
- data/lib/flat_api/models/assignment_submission_update.rb +150 -50
- data/lib/flat_api/models/assignment_type.rb +44 -0
- data/lib/flat_api/models/assignment_update.rb +407 -0
- data/lib/flat_api/models/class_assignment.rb +613 -0
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +226 -0
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +216 -0
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +226 -0
- data/lib/flat_api/models/class_assignment_update.rb +509 -0
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +217 -0
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +219 -0
- data/lib/flat_api/models/class_attachment_creation.rb +110 -41
- data/lib/flat_api/models/class_creation.rb +144 -43
- data/lib/flat_api/models/class_details.rb +175 -60
- data/lib/flat_api/models/class_details_canvas.rb +61 -34
- data/lib/flat_api/models/class_details_clever.rb +76 -48
- data/lib/flat_api/models/class_details_google_classroom.rb +66 -59
- data/lib/flat_api/models/class_details_google_drive.rb +63 -36
- data/lib/flat_api/models/class_details_issues.rb +218 -0
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +270 -0
- data/lib/flat_api/models/class_details_lti.rb +65 -38
- data/lib/flat_api/models/class_details_mfc.rb +226 -0
- data/lib/flat_api/models/class_details_microsoft_graph.rb +215 -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 +18 -9
- data/lib/flat_api/models/class_update.rb +144 -42
- data/lib/flat_api/models/collection.rb +373 -0
- data/lib/flat_api/models/collection_app.rb +236 -0
- data/lib/flat_api/models/collection_capabilities.rb +291 -0
- data/lib/flat_api/models/collection_creation.rb +288 -0
- data/lib/flat_api/models/collection_modification.rb +275 -0
- data/lib/flat_api/models/collection_privacy.rb +39 -0
- data/lib/flat_api/models/collection_type.rb +44 -0
- data/lib/flat_api/models/edu_library.rb +292 -0
- data/lib/flat_api/models/edu_resource.rb +366 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +236 -0
- data/lib/flat_api/models/edu_resource_copy.rb +223 -0
- data/lib/flat_api/models/edu_resource_creation.rb +301 -0
- data/lib/flat_api/models/edu_resource_folder.rb +216 -0
- data/lib/flat_api/models/edu_resource_lti_link.rb +223 -0
- data/lib/flat_api/models/edu_resource_move.rb +223 -0
- data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
- data/lib/flat_api/models/edu_resource_resource.rb +105 -0
- data/lib/flat_api/models/edu_resource_type.rb +40 -0
- data/lib/flat_api/models/edu_resource_update.rb +277 -0
- data/lib/flat_api/models/edu_resource_use_in_class.rb +233 -0
- data/lib/flat_api/models/flat_error_response.rb +79 -38
- data/lib/flat_api/models/flat_locales.rb +30 -10
- data/lib/flat_api/models/google_classroom_coursework.rb +76 -38
- data/lib/flat_api/models/google_classroom_submission.rb +84 -36
- data/lib/flat_api/models/group.rb +72 -44
- data/lib/flat_api/models/group_details.rb +92 -43
- data/lib/flat_api/models/group_type.rb +18 -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_credentials.rb +95 -46
- data/lib/flat_api/models/lti_credentials_creation.rb +91 -38
- data/lib/flat_api/models/media_attachment.rb +167 -70
- data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
- data/lib/flat_api/models/microsoft_graph_assignment.rb +248 -0
- data/lib/flat_api/models/microsoft_graph_submission.rb +240 -0
- data/lib/flat_api/models/organization_invitation.rb +139 -44
- data/lib/flat_api/models/organization_invitation_creation.rb +99 -35
- data/lib/flat_api/models/organization_roles.rb +18 -9
- data/lib/flat_api/models/organization_user_access_token_creation.rb +225 -0
- data/lib/flat_api/models/resource_collaborator.rb +403 -0
- data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +85 -48
- data/lib/flat_api/models/resource_rights.rb +318 -0
- data/lib/flat_api/models/score_comment.rb +93 -56
- data/lib/flat_api/models/score_comment_context.rb +103 -59
- data/lib/flat_api/models/score_comment_creation.rb +70 -41
- data/lib/flat_api/models/score_comment_moderation.rb +260 -0
- data/lib/flat_api/models/score_comment_update.rb +82 -49
- data/lib/flat_api/models/score_comments_counts.rb +67 -40
- data/lib/flat_api/models/score_creation.rb +81 -215
- data/lib/flat_api/models/score_creation_builder_data.rb +298 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +230 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +322 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +274 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +269 -0
- data/lib/flat_api/models/score_creation_common.rb +268 -0
- data/lib/flat_api/models/score_creation_file_import.rb +324 -0
- data/lib/flat_api/models/score_creation_google_drive_import.rb +291 -0
- data/lib/flat_api/models/score_creation_type.rb +19 -9
- data/lib/flat_api/models/score_details.rb +274 -83
- data/lib/flat_api/models/score_fork.rb +94 -32
- data/lib/flat_api/models/score_license.rb +19 -9
- data/lib/flat_api/models/score_likes_counts.rb +83 -35
- data/lib/flat_api/models/score_modification.rb +175 -52
- data/lib/flat_api/models/score_plays_counts.rb +236 -0
- data/lib/flat_api/models/score_privacy.rb +18 -9
- data/lib/flat_api/models/score_revision.rb +80 -43
- data/lib/flat_api/models/score_revision_creation.rb +105 -40
- data/lib/flat_api/models/score_revision_statistics.rb +83 -36
- data/lib/flat_api/models/score_source.rb +61 -35
- data/lib/flat_api/models/score_summary.rb +124 -40
- data/lib/flat_api/models/score_track.rb +172 -51
- data/lib/flat_api/models/score_track_creation.rb +101 -39
- data/lib/flat_api/models/score_track_point.rb +70 -38
- 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 +88 -37
- data/lib/flat_api/models/score_views_counts.rb +62 -35
- data/lib/flat_api/models/task.rb +364 -0
- data/lib/flat_api/models/task_export_options.rb +218 -0
- data/lib/flat_api/models/task_progress.rb +226 -0
- data/lib/flat_api/models/task_result.rb +226 -0
- data/lib/flat_api/models/tutteo_product.rb +42 -0
- data/lib/flat_api/models/user_admin_update.rb +219 -41
- data/lib/flat_api/models/user_azure_details.rb +235 -0
- data/lib/flat_api/models/user_basics.rb +187 -55
- data/lib/flat_api/models/user_community_profile_links.rb +272 -0
- data/lib/flat_api/models/user_creation.rb +215 -49
- data/lib/flat_api/models/user_details.rb +258 -93
- data/lib/flat_api/models/user_details_admin.rb +220 -68
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +278 -0
- data/lib/flat_api/models/user_public.rb +242 -79
- data/lib/flat_api/models/user_public_summary.rb +201 -61
- data/lib/flat_api/models/user_signin_link.rb +225 -0
- data/lib/flat_api/models/user_signin_link_creation.rb +217 -0
- data/lib/flat_api/version.rb +5 -5
- data/lib/flat_api.rb +87 -15
- data/spec/api/account_api_spec.rb +11 -10
- data/spec/api/class_api_spec.rb +212 -68
- data/spec/api/collection_api_spec.rb +158 -0
- data/spec/api/edu_resources_api_spec.rb +181 -0
- data/spec/api/group_api_spec.rb +14 -15
- data/spec/api/organization_api_spec.rb +78 -39
- data/spec/api/score_api_spec.rb +139 -110
- data/spec/api/task_api_spec.rb +47 -0
- data/spec/api/user_api_spec.rb +28 -26
- data/spec/models/api_access_token_spec.rb +66 -0
- data/spec/models/app_scopes_spec.rb +30 -0
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +42 -0
- data/spec/models/assignment_capabilities_spec.rb +60 -0
- data/spec/models/assignment_copy_response_spec.rb +124 -0
- data/spec/models/assignment_copy_spec.rb +13 -23
- data/spec/models/assignment_copy_to_class_spec.rb +48 -0
- data/spec/models/assignment_copy_to_resource_library_spec.rb +42 -0
- data/spec/models/assignment_spec.rb +51 -39
- data/spec/models/assignment_submission_comment_creation_spec.rb +36 -0
- data/spec/models/assignment_submission_comment_spec.rb +72 -0
- data/spec/models/assignment_submission_comments_spec.rb +42 -0
- data/spec/models/assignment_submission_history_attachment_spec.rb +48 -0
- data/spec/models/assignment_submission_history_spec.rb +112 -0
- data/spec/models/assignment_submission_history_state_spec.rb +30 -0
- data/spec/models/assignment_submission_lti_spec.rb +36 -0
- data/spec/models/assignment_submission_playback_inner_spec.rb +42 -0
- data/spec/models/assignment_submission_spec.rb +68 -32
- data/spec/models/assignment_submission_state_spec.rb +30 -0
- data/spec/models/assignment_submission_update_spec.rb +29 -23
- data/spec/models/assignment_type_spec.rb +30 -0
- data/spec/models/assignment_update_spec.rb +100 -0
- data/spec/models/class_assignment_all_of_canvas_spec.rb +42 -0
- data/spec/models/class_assignment_all_of_lti_spec.rb +36 -0
- data/spec/models/class_assignment_all_of_mfc_spec.rb +42 -0
- data/spec/models/class_assignment_spec.rb +216 -0
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +36 -0
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +36 -0
- data/spec/models/class_assignment_update_spec.rb +150 -0
- data/spec/models/class_attachment_creation_spec.rb +41 -23
- data/spec/models/class_creation_spec.rb +34 -18
- data/spec/models/class_details_canvas_spec.rb +12 -18
- data/spec/models/class_details_clever_spec.rb +21 -27
- data/spec/models/class_details_google_classroom_spec.rb +12 -30
- data/spec/models/class_details_google_drive_spec.rb +12 -18
- data/spec/models/class_details_issues_spec.rb +36 -0
- data/spec/models/class_details_issues_sync_inner_spec.rb +52 -0
- data/spec/models/class_details_lti_spec.rb +13 -19
- data/spec/models/class_details_mfc_spec.rb +42 -0
- data/spec/models/class_details_microsoft_graph_spec.rb +36 -0
- data/spec/models/class_details_spec.rb +68 -34
- data/spec/models/class_grade_level_spec.rb +30 -0
- data/spec/models/class_roles_spec.rb +10 -16
- data/spec/models/class_state_spec.rb +10 -16
- data/spec/models/class_update_spec.rb +34 -18
- data/spec/models/collection_app_spec.rb +48 -0
- data/spec/models/collection_capabilities_spec.rb +60 -0
- data/spec/models/collection_creation_spec.rb +42 -0
- data/spec/models/collection_modification_spec.rb +42 -0
- data/spec/models/collection_privacy_spec.rb +30 -0
- data/spec/models/collection_spec.rb +114 -0
- data/spec/models/collection_type_spec.rb +30 -0
- data/spec/models/edu_library_spec.rb +62 -0
- data/spec/models/edu_resource_capabilities_spec.rb +48 -0
- data/spec/models/edu_resource_copy_spec.rb +36 -0
- data/spec/models/edu_resource_creation_spec.rb +48 -0
- data/spec/models/edu_resource_folder_spec.rb +36 -0
- data/spec/models/edu_resource_lti_link_spec.rb +36 -0
- data/spec/models/edu_resource_move_spec.rb +36 -0
- data/spec/models/edu_resource_privacy_spec.rb +30 -0
- data/spec/models/edu_resource_resource_spec.rb +32 -0
- data/spec/models/edu_resource_spec.rb +96 -0
- data/spec/models/edu_resource_type_spec.rb +30 -0
- data/spec/models/edu_resource_update_spec.rb +42 -0
- data/spec/models/edu_resource_use_in_class_spec.rb +42 -0
- data/spec/models/flat_error_response_spec.rb +14 -20
- data/spec/models/flat_locales_spec.rb +10 -16
- data/spec/models/google_classroom_coursework_spec.rb +19 -19
- data/spec/models/google_classroom_submission_spec.rb +13 -19
- data/spec/models/group_details_spec.rb +17 -23
- data/spec/models/group_spec.rb +21 -27
- data/spec/models/group_type_spec.rb +10 -16
- data/spec/models/license_mode_spec.rb +10 -16
- data/spec/models/license_sources_spec.rb +10 -16
- data/spec/models/lms_name_spec.rb +10 -16
- data/spec/models/lti_credentials_creation_spec.rb +12 -18
- data/spec/models/lti_credentials_spec.rb +19 -25
- data/spec/models/media_attachment_spec.rb +67 -37
- data/spec/models/media_score_sharing_mode_spec.rb +10 -16
- data/spec/models/microsoft_graph_assignment_spec.rb +54 -0
- data/spec/models/microsoft_graph_submission_spec.rb +42 -0
- data/spec/models/organization_invitation_creation_spec.rb +16 -18
- data/spec/models/organization_invitation_spec.rb +29 -23
- data/spec/models/organization_roles_spec.rb +10 -16
- data/spec/models/organization_user_access_token_creation_spec.rb +36 -0
- data/spec/models/resource_collaborator_creation_spec.rb +72 -0
- data/spec/models/resource_collaborator_spec.rb +112 -0
- data/spec/models/resource_rights_spec.rb +64 -0
- data/spec/models/score_comment_context_spec.rb +23 -23
- data/spec/models/score_comment_creation_spec.rb +16 -22
- data/spec/models/score_comment_moderation_spec.rb +46 -0
- data/spec/models/score_comment_spec.rb +35 -35
- data/spec/models/score_comment_update_spec.rb +14 -20
- data/spec/models/score_comments_counts_spec.rb +14 -20
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +82 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +60 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +66 -0
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +42 -0
- data/spec/models/score_creation_builder_data_spec.rb +60 -0
- data/spec/models/score_creation_common_spec.rb +54 -0
- data/spec/models/score_creation_file_import_spec.rb +76 -0
- data/spec/models/score_creation_google_drive_import_spec.rb +60 -0
- data/spec/models/score_creation_spec.rb +12 -52
- data/spec/models/score_creation_type_spec.rb +10 -16
- data/spec/models/score_details_spec.rb +75 -45
- data/spec/models/score_fork_spec.rb +27 -15
- data/spec/models/score_license_spec.rb +10 -16
- data/spec/models/score_likes_counts_spec.rb +13 -19
- data/spec/models/score_modification_spec.rb +51 -21
- data/spec/models/score_plays_counts_spec.rb +48 -0
- data/spec/models/score_privacy_spec.rb +10 -16
- data/spec/models/score_revision_creation_spec.rb +18 -20
- data/spec/models/score_revision_spec.rb +23 -23
- data/spec/models/score_revision_statistics_spec.rb +24 -18
- data/spec/models/score_source_spec.rb +11 -17
- data/spec/models/score_summary_spec.rb +16 -22
- data/spec/models/score_track_creation_spec.rb +21 -21
- data/spec/models/score_track_point_spec.rb +17 -23
- data/spec/models/score_track_purpose_spec.rb +30 -0
- data/spec/models/score_track_spec.rb +28 -28
- data/spec/models/score_track_state_spec.rb +10 -16
- data/spec/models/score_track_type_spec.rb +10 -16
- data/spec/models/score_track_update_spec.rb +14 -20
- data/spec/models/score_views_counts_spec.rb +13 -19
- data/spec/models/task_export_options_spec.rb +36 -0
- data/spec/models/task_progress_spec.rb +42 -0
- data/spec/models/task_result_spec.rb +42 -0
- data/spec/models/task_spec.rb +100 -0
- data/spec/models/tutteo_product_spec.rb +30 -0
- data/spec/models/user_admin_update_spec.rb +36 -18
- data/spec/models/user_azure_details_spec.rb +48 -0
- data/spec/models/user_basics_spec.rb +47 -25
- data/spec/models/user_community_profile_links_spec.rb +66 -0
- data/spec/models/user_creation_spec.rb +36 -20
- data/spec/models/user_details_admin_all_of_license_spec.rb +60 -0
- data/spec/models/user_details_admin_spec.rb +60 -32
- data/spec/models/user_details_spec.rb +93 -45
- data/spec/models/user_public_spec.rb +71 -37
- data/spec/models/user_public_summary_spec.rb +51 -29
- data/spec/models/user_signin_link_creation_spec.rb +36 -0
- data/spec/models/user_signin_link_spec.rb +42 -0
- data/spec/spec_helper.rb +4 -4
- metadata +299 -312
- data/CHANGELOG.md +0 -13
- data/Gemfile +0 -7
- data/README.md +0 -249
- 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/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/ScoreApi.md +0 -1605
- data/docs/ScoreCollaborator.md +0 -15
- data/docs/ScoreCollaboratorCreation.md +0 -13
- 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 -13
- 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 -7
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -13
- 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/ScoreRights.md +0 -10
- 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/git_push.sh +0 -55
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/score_collaborator.rb +0 -263
- 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/score_rights.rb +0 -215
- 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_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/score_collaborator_creation_spec.rb +0 -72
- data/spec/models/score_collaborator_spec.rb +0 -84
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/score_rights_spec.rb +0 -48
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_instruments_spec.rb +0 -36
@@ -1,34 +1,46 @@
|
|
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * 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.20.0
|
7
7
|
Contact: developers@flat.io
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module FlatApi
|
16
17
|
class LicenseSources
|
17
|
-
|
18
18
|
ORDER = "order".freeze
|
19
19
|
TRIAL = "trial".freeze
|
20
20
|
VOUCHER = "voucher".freeze
|
21
21
|
DISTRIBUTOR = "distributor".freeze
|
22
22
|
SUBSCRIPTION = "subscription".freeze
|
23
|
+
APP_STORE = "appStore".freeze
|
24
|
+
PLAY_STORE = "playStore".freeze
|
25
|
+
MUSICFIRST = "musicfirst".freeze
|
26
|
+
|
27
|
+
def self.all_vars
|
28
|
+
@all_vars ||= [ORDER, TRIAL, VOUCHER, DISTRIBUTOR, SUBSCRIPTION, APP_STORE, PLAY_STORE, MUSICFIRST].freeze
|
29
|
+
end
|
30
|
+
|
31
|
+
# Builds the enum from string
|
32
|
+
# @param [String] The enum value in the form of the string
|
33
|
+
# @return [String] The enum value
|
34
|
+
def self.build_from_hash(value)
|
35
|
+
new.build_from_hash(value)
|
36
|
+
end
|
23
37
|
|
24
38
|
# Builds the enum from string
|
25
39
|
# @param [String] The enum value in the form of the string
|
26
40
|
# @return [String] The enum value
|
27
41
|
def build_from_hash(value)
|
28
|
-
|
29
|
-
raise "Invalid ENUM value #{value} for class #LicenseSources"
|
30
|
-
value
|
42
|
+
return value if LicenseSources.all_vars.include?(value)
|
43
|
+
raise "Invalid ENUM value #{value} for class #LicenseSources"
|
31
44
|
end
|
32
45
|
end
|
33
|
-
|
34
46
|
end
|
@@ -1,36 +1,46 @@
|
|
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * 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.20.0
|
7
7
|
Contact: developers@flat.io
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module FlatApi
|
16
17
|
class LmsName
|
17
|
-
|
18
18
|
CANVAS = "canvas".freeze
|
19
19
|
MOODLE = "moodle".freeze
|
20
20
|
SCHOOLOGY = "schoology".freeze
|
21
21
|
BLACKBOARD = "blackboard".freeze
|
22
22
|
DESIRE2LEARN = "desire2learn".freeze
|
23
23
|
SAKAI = "sakai".freeze
|
24
|
+
SCHOOLBOX = "schoolbox".freeze
|
24
25
|
OTHER = "other".freeze
|
25
26
|
|
27
|
+
def self.all_vars
|
28
|
+
@all_vars ||= [CANVAS, MOODLE, SCHOOLOGY, BLACKBOARD, DESIRE2LEARN, SAKAI, SCHOOLBOX, OTHER].freeze
|
29
|
+
end
|
30
|
+
|
31
|
+
# Builds the enum from string
|
32
|
+
# @param [String] The enum value in the form of the string
|
33
|
+
# @return [String] The enum value
|
34
|
+
def self.build_from_hash(value)
|
35
|
+
new.build_from_hash(value)
|
36
|
+
end
|
37
|
+
|
26
38
|
# Builds the enum from string
|
27
39
|
# @param [String] The enum value in the form of the string
|
28
40
|
# @return [String] The enum value
|
29
41
|
def build_from_hash(value)
|
30
|
-
|
31
|
-
raise "Invalid ENUM value #{value} for class #LmsName"
|
32
|
-
value
|
42
|
+
return value if LmsName.all_vars.include?(value)
|
43
|
+
raise "Invalid ENUM value #{value} for class #LmsName"
|
33
44
|
end
|
34
45
|
end
|
35
|
-
|
36
46
|
end
|
@@ -1,16 +1,17 @@
|
|
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * 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.20.0
|
7
7
|
Contact: developers@flat.io
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module FlatApi
|
16
17
|
# A couple of LTI 1.x OAuth credentials
|
@@ -41,6 +42,27 @@ module FlatApi
|
|
41
42
|
# OAuth 1 Consumer Secret
|
42
43
|
attr_accessor :consumer_secret
|
43
44
|
|
45
|
+
class EnumAttributeValidator
|
46
|
+
attr_reader :datatype
|
47
|
+
attr_reader :allowable_values
|
48
|
+
|
49
|
+
def initialize(datatype, allowable_values)
|
50
|
+
@allowable_values = allowable_values.map do |value|
|
51
|
+
case datatype.to_s
|
52
|
+
when /Integer/i
|
53
|
+
value.to_i
|
54
|
+
when /Float/i
|
55
|
+
value.to_f
|
56
|
+
else
|
57
|
+
value
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
def valid?(value)
|
63
|
+
!value || allowable_values.include?(value)
|
64
|
+
end
|
65
|
+
end
|
44
66
|
|
45
67
|
# Attribute mapping from ruby-style variable name to JSON key.
|
46
68
|
def self.attribute_map
|
@@ -57,78 +79,97 @@ module FlatApi
|
|
57
79
|
}
|
58
80
|
end
|
59
81
|
|
82
|
+
# Returns all the JSON keys this model knows about
|
83
|
+
def self.acceptable_attributes
|
84
|
+
attribute_map.values
|
85
|
+
end
|
86
|
+
|
60
87
|
# Attribute type mapping.
|
61
|
-
def self.
|
88
|
+
def self.openapi_types
|
62
89
|
{
|
63
90
|
:'id' => :'String',
|
64
91
|
:'name' => :'String',
|
65
92
|
:'lms' => :'LmsName',
|
66
93
|
:'organization' => :'String',
|
67
94
|
:'creator' => :'String',
|
68
|
-
:'creation_date' => :'
|
69
|
-
:'last_usage' => :'
|
95
|
+
:'creation_date' => :'Time',
|
96
|
+
:'last_usage' => :'Time',
|
70
97
|
:'consumer_key' => :'String',
|
71
98
|
:'consumer_secret' => :'String'
|
72
99
|
}
|
73
100
|
end
|
74
101
|
|
102
|
+
# List of attributes with nullable: true
|
103
|
+
def self.openapi_nullable
|
104
|
+
Set.new([
|
105
|
+
])
|
106
|
+
end
|
107
|
+
|
75
108
|
# Initializes the object
|
76
109
|
# @param [Hash] attributes Model attributes in the form of hash
|
77
110
|
def initialize(attributes = {})
|
78
|
-
|
111
|
+
if (!attributes.is_a?(Hash))
|
112
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::LtiCredentials` initialize method"
|
113
|
+
end
|
79
114
|
|
80
|
-
# convert string to symbol for hash key
|
81
|
-
attributes = attributes.each_with_object({}){|(k,v), h|
|
115
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
116
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
117
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
118
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::LtiCredentials`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
119
|
+
end
|
120
|
+
h[k.to_sym] = v
|
121
|
+
}
|
82
122
|
|
83
|
-
if attributes.
|
123
|
+
if attributes.key?(:'id')
|
84
124
|
self.id = attributes[:'id']
|
85
125
|
end
|
86
126
|
|
87
|
-
if attributes.
|
127
|
+
if attributes.key?(:'name')
|
88
128
|
self.name = attributes[:'name']
|
89
129
|
end
|
90
130
|
|
91
|
-
if attributes.
|
131
|
+
if attributes.key?(:'lms')
|
92
132
|
self.lms = attributes[:'lms']
|
93
133
|
end
|
94
134
|
|
95
|
-
if attributes.
|
135
|
+
if attributes.key?(:'organization')
|
96
136
|
self.organization = attributes[:'organization']
|
97
137
|
end
|
98
138
|
|
99
|
-
if attributes.
|
139
|
+
if attributes.key?(:'creator')
|
100
140
|
self.creator = attributes[:'creator']
|
101
141
|
end
|
102
142
|
|
103
|
-
if attributes.
|
104
|
-
self.creation_date = attributes[:'
|
143
|
+
if attributes.key?(:'creation_date')
|
144
|
+
self.creation_date = attributes[:'creation_date']
|
105
145
|
end
|
106
146
|
|
107
|
-
if attributes.
|
108
|
-
self.last_usage = attributes[:'
|
147
|
+
if attributes.key?(:'last_usage')
|
148
|
+
self.last_usage = attributes[:'last_usage']
|
109
149
|
end
|
110
150
|
|
111
|
-
if attributes.
|
112
|
-
self.consumer_key = attributes[:'
|
151
|
+
if attributes.key?(:'consumer_key')
|
152
|
+
self.consumer_key = attributes[:'consumer_key']
|
113
153
|
end
|
114
154
|
|
115
|
-
if attributes.
|
116
|
-
self.consumer_secret = attributes[:'
|
155
|
+
if attributes.key?(:'consumer_secret')
|
156
|
+
self.consumer_secret = attributes[:'consumer_secret']
|
117
157
|
end
|
118
|
-
|
119
158
|
end
|
120
159
|
|
121
160
|
# Show invalid properties with the reasons. Usually used together with valid?
|
122
161
|
# @return Array for valid properties with the reasons
|
123
162
|
def list_invalid_properties
|
163
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
124
164
|
invalid_properties = Array.new
|
125
|
-
|
165
|
+
invalid_properties
|
126
166
|
end
|
127
167
|
|
128
168
|
# Check to see if the all the properties in the model are valid
|
129
169
|
# @return true if the model is valid
|
130
170
|
def valid?
|
131
|
-
|
171
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
172
|
+
true
|
132
173
|
end
|
133
174
|
|
134
175
|
# Checks equality by comparing each attribute.
|
@@ -154,7 +195,7 @@ module FlatApi
|
|
154
195
|
end
|
155
196
|
|
156
197
|
# Calculates hash code according to all attributes.
|
157
|
-
# @return [
|
198
|
+
# @return [Integer] Hash code
|
158
199
|
def hash
|
159
200
|
[id, name, lms, organization, creator, creation_date, last_usage, consumer_key, consumer_secret].hash
|
160
201
|
end
|
@@ -162,31 +203,34 @@ module FlatApi
|
|
162
203
|
# Builds the object from hash
|
163
204
|
# @param [Hash] attributes Model attributes in the form of hash
|
164
205
|
# @return [Object] Returns the model itself
|
165
|
-
def build_from_hash(attributes)
|
206
|
+
def self.build_from_hash(attributes)
|
166
207
|
return nil unless attributes.is_a?(Hash)
|
167
|
-
|
168
|
-
|
169
|
-
|
208
|
+
attributes = attributes.transform_keys(&:to_sym)
|
209
|
+
transformed_hash = {}
|
210
|
+
openapi_types.each_pair do |key, type|
|
211
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
212
|
+
transformed_hash["#{key}"] = nil
|
213
|
+
elsif type =~ /\AArray<(.*)>/i
|
214
|
+
# check to ensure the input is an array given that the attribute
|
170
215
|
# is documented as an array but the input is not
|
171
|
-
if attributes[
|
172
|
-
|
216
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
217
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
173
218
|
end
|
174
|
-
elsif !attributes[
|
175
|
-
|
176
|
-
end
|
219
|
+
elsif !attributes[attribute_map[key]].nil?
|
220
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
221
|
+
end
|
177
222
|
end
|
178
|
-
|
179
|
-
self
|
223
|
+
new(transformed_hash)
|
180
224
|
end
|
181
225
|
|
182
226
|
# Deserializes the data based on type
|
183
227
|
# @param string type Data type
|
184
228
|
# @param string value Value to be deserialized
|
185
229
|
# @return [Object] Deserialized data
|
186
|
-
def _deserialize(type, value)
|
230
|
+
def self._deserialize(type, value)
|
187
231
|
case type.to_sym
|
188
|
-
when :
|
189
|
-
|
232
|
+
when :Time
|
233
|
+
Time.parse(value)
|
190
234
|
when :Date
|
191
235
|
Date.parse(value)
|
192
236
|
when :String
|
@@ -195,7 +239,7 @@ module FlatApi
|
|
195
239
|
value.to_i
|
196
240
|
when :Float
|
197
241
|
value.to_f
|
198
|
-
when :
|
242
|
+
when :Boolean
|
199
243
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
200
244
|
true
|
201
245
|
else
|
@@ -216,8 +260,9 @@ module FlatApi
|
|
216
260
|
end
|
217
261
|
end
|
218
262
|
else # model
|
219
|
-
|
220
|
-
|
263
|
+
# models (e.g. Pet) or oneOf
|
264
|
+
klass = FlatApi.const_get(type)
|
265
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
221
266
|
end
|
222
267
|
end
|
223
268
|
|
@@ -239,7 +284,11 @@ module FlatApi
|
|
239
284
|
hash = {}
|
240
285
|
self.class.attribute_map.each_pair do |attr, param|
|
241
286
|
value = self.send(attr)
|
242
|
-
|
287
|
+
if value.nil?
|
288
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
289
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
290
|
+
end
|
291
|
+
|
243
292
|
hash[param] = _to_hash(value)
|
244
293
|
end
|
245
294
|
hash
|
@@ -251,7 +300,7 @@ module FlatApi
|
|
251
300
|
# @return [Hash] Returns the value in the form of hash
|
252
301
|
def _to_hash(value)
|
253
302
|
if value.is_a?(Array)
|
254
|
-
value.compact.map{ |v| _to_hash(v) }
|
303
|
+
value.compact.map { |v| _to_hash(v) }
|
255
304
|
elsif value.is_a?(Hash)
|
256
305
|
{}.tap do |hash|
|
257
306
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -1,16 +1,17 @@
|
|
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * 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.20.0
|
7
7
|
Contact: developers@flat.io
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module FlatApi
|
16
17
|
# Creation of a couple of LTI 1.x OAuth credentials
|
@@ -20,6 +21,27 @@ module FlatApi
|
|
20
21
|
|
21
22
|
attr_accessor :lms
|
22
23
|
|
24
|
+
class EnumAttributeValidator
|
25
|
+
attr_reader :datatype
|
26
|
+
attr_reader :allowable_values
|
27
|
+
|
28
|
+
def initialize(datatype, allowable_values)
|
29
|
+
@allowable_values = allowable_values.map do |value|
|
30
|
+
case datatype.to_s
|
31
|
+
when /Integer/i
|
32
|
+
value.to_i
|
33
|
+
when /Float/i
|
34
|
+
value.to_f
|
35
|
+
else
|
36
|
+
value
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def valid?(value)
|
42
|
+
!value || allowable_values.include?(value)
|
43
|
+
end
|
44
|
+
end
|
23
45
|
|
24
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
25
47
|
def self.attribute_map
|
@@ -29,69 +51,92 @@ module FlatApi
|
|
29
51
|
}
|
30
52
|
end
|
31
53
|
|
54
|
+
# Returns all the JSON keys this model knows about
|
55
|
+
def self.acceptable_attributes
|
56
|
+
attribute_map.values
|
57
|
+
end
|
58
|
+
|
32
59
|
# Attribute type mapping.
|
33
|
-
def self.
|
60
|
+
def self.openapi_types
|
34
61
|
{
|
35
62
|
:'name' => :'String',
|
36
63
|
:'lms' => :'LmsName'
|
37
64
|
}
|
38
65
|
end
|
39
66
|
|
67
|
+
# List of attributes with nullable: true
|
68
|
+
def self.openapi_nullable
|
69
|
+
Set.new([
|
70
|
+
])
|
71
|
+
end
|
72
|
+
|
40
73
|
# Initializes the object
|
41
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
42
75
|
def initialize(attributes = {})
|
43
|
-
|
76
|
+
if (!attributes.is_a?(Hash))
|
77
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::LtiCredentialsCreation` initialize method"
|
78
|
+
end
|
44
79
|
|
45
|
-
# convert string to symbol for hash key
|
46
|
-
attributes = attributes.each_with_object({}){|(k,v), h|
|
80
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
81
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
82
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
83
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::LtiCredentialsCreation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
84
|
+
end
|
85
|
+
h[k.to_sym] = v
|
86
|
+
}
|
47
87
|
|
48
|
-
if attributes.
|
88
|
+
if attributes.key?(:'name')
|
49
89
|
self.name = attributes[:'name']
|
90
|
+
else
|
91
|
+
self.name = nil
|
50
92
|
end
|
51
93
|
|
52
|
-
if attributes.
|
94
|
+
if attributes.key?(:'lms')
|
53
95
|
self.lms = attributes[:'lms']
|
96
|
+
else
|
97
|
+
self.lms = nil
|
54
98
|
end
|
55
|
-
|
56
99
|
end
|
57
100
|
|
58
101
|
# Show invalid properties with the reasons. Usually used together with valid?
|
59
102
|
# @return Array for valid properties with the reasons
|
60
103
|
def list_invalid_properties
|
104
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
61
105
|
invalid_properties = Array.new
|
62
106
|
if @name.nil?
|
63
|
-
invalid_properties.push(
|
107
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
64
108
|
end
|
65
109
|
|
66
110
|
if @name.to_s.length > 300
|
67
|
-
invalid_properties.push(
|
111
|
+
invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 300.')
|
68
112
|
end
|
69
113
|
|
70
114
|
if @lms.nil?
|
71
|
-
invalid_properties.push(
|
115
|
+
invalid_properties.push('invalid value for "lms", lms cannot be nil.')
|
72
116
|
end
|
73
117
|
|
74
|
-
|
118
|
+
invalid_properties
|
75
119
|
end
|
76
120
|
|
77
121
|
# Check to see if the all the properties in the model are valid
|
78
122
|
# @return true if the model is valid
|
79
123
|
def valid?
|
124
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
80
125
|
return false if @name.nil?
|
81
126
|
return false if @name.to_s.length > 300
|
82
127
|
return false if @lms.nil?
|
83
|
-
|
128
|
+
true
|
84
129
|
end
|
85
130
|
|
86
131
|
# Custom attribute writer method with validation
|
87
132
|
# @param [Object] name Value to be assigned
|
88
133
|
def name=(name)
|
89
134
|
if name.nil?
|
90
|
-
fail ArgumentError,
|
135
|
+
fail ArgumentError, 'name cannot be nil'
|
91
136
|
end
|
92
137
|
|
93
138
|
if name.to_s.length > 300
|
94
|
-
fail ArgumentError,
|
139
|
+
fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 300.'
|
95
140
|
end
|
96
141
|
|
97
142
|
@name = name
|
@@ -113,7 +158,7 @@ module FlatApi
|
|
113
158
|
end
|
114
159
|
|
115
160
|
# Calculates hash code according to all attributes.
|
116
|
-
# @return [
|
161
|
+
# @return [Integer] Hash code
|
117
162
|
def hash
|
118
163
|
[name, lms].hash
|
119
164
|
end
|
@@ -121,31 +166,34 @@ module FlatApi
|
|
121
166
|
# Builds the object from hash
|
122
167
|
# @param [Hash] attributes Model attributes in the form of hash
|
123
168
|
# @return [Object] Returns the model itself
|
124
|
-
def build_from_hash(attributes)
|
169
|
+
def self.build_from_hash(attributes)
|
125
170
|
return nil unless attributes.is_a?(Hash)
|
126
|
-
|
127
|
-
|
128
|
-
|
171
|
+
attributes = attributes.transform_keys(&:to_sym)
|
172
|
+
transformed_hash = {}
|
173
|
+
openapi_types.each_pair do |key, type|
|
174
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
175
|
+
transformed_hash["#{key}"] = nil
|
176
|
+
elsif type =~ /\AArray<(.*)>/i
|
177
|
+
# check to ensure the input is an array given that the attribute
|
129
178
|
# is documented as an array but the input is not
|
130
|
-
if attributes[
|
131
|
-
|
179
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
180
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
132
181
|
end
|
133
|
-
elsif !attributes[
|
134
|
-
|
135
|
-
end
|
182
|
+
elsif !attributes[attribute_map[key]].nil?
|
183
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
184
|
+
end
|
136
185
|
end
|
137
|
-
|
138
|
-
self
|
186
|
+
new(transformed_hash)
|
139
187
|
end
|
140
188
|
|
141
189
|
# Deserializes the data based on type
|
142
190
|
# @param string type Data type
|
143
191
|
# @param string value Value to be deserialized
|
144
192
|
# @return [Object] Deserialized data
|
145
|
-
def _deserialize(type, value)
|
193
|
+
def self._deserialize(type, value)
|
146
194
|
case type.to_sym
|
147
|
-
when :
|
148
|
-
|
195
|
+
when :Time
|
196
|
+
Time.parse(value)
|
149
197
|
when :Date
|
150
198
|
Date.parse(value)
|
151
199
|
when :String
|
@@ -154,7 +202,7 @@ module FlatApi
|
|
154
202
|
value.to_i
|
155
203
|
when :Float
|
156
204
|
value.to_f
|
157
|
-
when :
|
205
|
+
when :Boolean
|
158
206
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
159
207
|
true
|
160
208
|
else
|
@@ -175,8 +223,9 @@ module FlatApi
|
|
175
223
|
end
|
176
224
|
end
|
177
225
|
else # model
|
178
|
-
|
179
|
-
|
226
|
+
# models (e.g. Pet) or oneOf
|
227
|
+
klass = FlatApi.const_get(type)
|
228
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
180
229
|
end
|
181
230
|
end
|
182
231
|
|
@@ -198,7 +247,11 @@ module FlatApi
|
|
198
247
|
hash = {}
|
199
248
|
self.class.attribute_map.each_pair do |attr, param|
|
200
249
|
value = self.send(attr)
|
201
|
-
|
250
|
+
if value.nil?
|
251
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
252
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
253
|
+
end
|
254
|
+
|
202
255
|
hash[param] = _to_hash(value)
|
203
256
|
end
|
204
257
|
hash
|
@@ -210,7 +263,7 @@ module FlatApi
|
|
210
263
|
# @return [Hash] Returns the value in the form of hash
|
211
264
|
def _to_hash(value)
|
212
265
|
if value.is_a?(Array)
|
213
|
-
value.compact.map{ |v| _to_hash(v) }
|
266
|
+
value.compact.map { |v| _to_hash(v) }
|
214
267
|
elsif value.is_a?(Hash)
|
215
268
|
{}.tap do |hash|
|
216
269
|
value.each { |k, v| hash[k] = _to_hash(v) }
|