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,16 +1,16 @@
|
|
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
|
-
require
|
13
|
+
require 'cgi'
|
14
14
|
|
15
15
|
module FlatApi
|
16
16
|
class OrganizationApi
|
@@ -19,56 +19,139 @@ module FlatApi
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Count the organization users using the provided filters
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @option opts [Array<String>] :role Filter users by role
|
25
|
+
# @option opts [String] :q The query to search
|
26
|
+
# @option opts [Array<String>] :group Filter users by group
|
27
|
+
# @option opts [Boolean] :no_active_license Filter users who don't have an active license
|
28
|
+
# @return [Array<UserDetailsAdmin>]
|
29
|
+
def count_orga_users(opts = {})
|
30
|
+
data, _status_code, _headers = count_orga_users_with_http_info(opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Count the organization users using the provided filters
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @option opts [Array<String>] :role Filter users by role
|
37
|
+
# @option opts [String] :q The query to search
|
38
|
+
# @option opts [Array<String>] :group Filter users by group
|
39
|
+
# @option opts [Boolean] :no_active_license Filter users who don't have an active license
|
40
|
+
# @return [Array<(Array<UserDetailsAdmin>, Integer, Hash)>] Array<UserDetailsAdmin> data, response status code and response headers
|
41
|
+
def count_orga_users_with_http_info(opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.count_orga_users ...'
|
44
|
+
end
|
45
|
+
allowable_values = ["user", "teacher", "admin"]
|
46
|
+
if @api_client.config.client_side_validation && opts[:'role'] && !opts[:'role'].all? { |item| allowable_values.include?(item) }
|
47
|
+
fail ArgumentError, "invalid value for \"role\", must include one of #{allowable_values}"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/organizations/users/count'
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = opts[:query_params] || {}
|
54
|
+
query_params[:'role'] = @api_client.build_collection_param(opts[:'role'], :multi) if !opts[:'role'].nil?
|
55
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
56
|
+
query_params[:'group'] = @api_client.build_collection_param(opts[:'group'], :multi) if !opts[:'group'].nil?
|
57
|
+
query_params[:'noActiveLicense'] = opts[:'no_active_license'] if !opts[:'no_active_license'].nil?
|
58
|
+
|
59
|
+
# header parameters
|
60
|
+
header_params = opts[:header_params] || {}
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
63
|
+
|
64
|
+
# form parameters
|
65
|
+
form_params = opts[:form_params] || {}
|
66
|
+
|
67
|
+
# http body (model)
|
68
|
+
post_body = opts[:debug_body]
|
69
|
+
|
70
|
+
# return_type
|
71
|
+
return_type = opts[:debug_return_type] || 'Array<UserDetailsAdmin>'
|
72
|
+
|
73
|
+
# auth_names
|
74
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
75
|
+
|
76
|
+
new_options = opts.merge(
|
77
|
+
:operation => :"OrganizationApi.count_orga_users",
|
78
|
+
:header_params => header_params,
|
79
|
+
:query_params => query_params,
|
80
|
+
:form_params => form_params,
|
81
|
+
:body => post_body,
|
82
|
+
:auth_names => auth_names,
|
83
|
+
:return_type => return_type
|
84
|
+
)
|
85
|
+
|
86
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
87
|
+
if @api_client.config.debugging
|
88
|
+
@api_client.config.logger.debug "API called: OrganizationApi#count_orga_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
89
|
+
end
|
90
|
+
return data, status_code, headers
|
91
|
+
end
|
22
92
|
|
23
93
|
# Create a new couple of LTI 1.x credentials
|
24
94
|
# Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
|
25
|
-
# @param body
|
95
|
+
# @param body [LtiCredentialsCreation]
|
26
96
|
# @param [Hash] opts the optional parameters
|
27
97
|
# @return [LtiCredentials]
|
28
98
|
def create_lti_credentials(body, opts = {})
|
29
99
|
data, _status_code, _headers = create_lti_credentials_with_http_info(body, opts)
|
30
|
-
|
100
|
+
data
|
31
101
|
end
|
32
102
|
|
33
103
|
# Create a new couple of LTI 1.x credentials
|
34
104
|
# Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our [Developer Documentation](https://flat.io/developers/docs/lti/).
|
35
|
-
# @param body
|
105
|
+
# @param body [LtiCredentialsCreation]
|
36
106
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @return [Array<(LtiCredentials,
|
107
|
+
# @return [Array<(LtiCredentials, Integer, Hash)>] LtiCredentials data, response status code and response headers
|
38
108
|
def create_lti_credentials_with_http_info(body, opts = {})
|
39
109
|
if @api_client.config.debugging
|
40
|
-
@api_client.config.logger.debug
|
110
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.create_lti_credentials ...'
|
41
111
|
end
|
42
112
|
# verify the required parameter 'body' is set
|
43
113
|
if @api_client.config.client_side_validation && body.nil?
|
44
114
|
fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.create_lti_credentials"
|
45
115
|
end
|
46
116
|
# resource path
|
47
|
-
local_var_path =
|
117
|
+
local_var_path = '/organizations/lti/credentials'
|
48
118
|
|
49
119
|
# query parameters
|
50
|
-
query_params = {}
|
120
|
+
query_params = opts[:query_params] || {}
|
51
121
|
|
52
122
|
# header parameters
|
53
|
-
header_params = {}
|
123
|
+
header_params = opts[:header_params] || {}
|
54
124
|
# HTTP header 'Accept' (if needed)
|
55
125
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
126
|
# HTTP header 'Content-Type'
|
57
|
-
|
127
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
128
|
+
if !content_type.nil?
|
129
|
+
header_params['Content-Type'] = content_type
|
130
|
+
end
|
58
131
|
|
59
132
|
# form parameters
|
60
|
-
form_params = {}
|
133
|
+
form_params = opts[:form_params] || {}
|
61
134
|
|
62
135
|
# http body (model)
|
63
|
-
post_body = @api_client.object_to_http_body(body)
|
64
|
-
|
65
|
-
|
136
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
137
|
+
|
138
|
+
# return_type
|
139
|
+
return_type = opts[:debug_return_type] || 'LtiCredentials'
|
140
|
+
|
141
|
+
# auth_names
|
142
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
143
|
+
|
144
|
+
new_options = opts.merge(
|
145
|
+
:operation => :"OrganizationApi.create_lti_credentials",
|
66
146
|
:header_params => header_params,
|
67
147
|
:query_params => query_params,
|
68
148
|
:form_params => form_params,
|
69
149
|
:body => post_body,
|
70
150
|
:auth_names => auth_names,
|
71
|
-
:return_type =>
|
151
|
+
:return_type => return_type
|
152
|
+
)
|
153
|
+
|
154
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
72
155
|
if @api_client.config.debugging
|
73
156
|
@api_client.config.logger.debug "API called: OrganizationApi#create_lti_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
157
|
end
|
@@ -77,49 +160,66 @@ module FlatApi
|
|
77
160
|
|
78
161
|
# Create a new invitation to join the organization
|
79
162
|
# This method creates and sends invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property `usedBy` will be directly filled with the uniquer identifier of the corresponding user.
|
163
|
+
# @param body [OrganizationInvitationCreation]
|
80
164
|
# @param [Hash] opts the optional parameters
|
81
|
-
# @option opts [OrganizationInvitationCreation] :body
|
82
165
|
# @return [OrganizationInvitation]
|
83
|
-
def create_organization_invitation(opts = {})
|
84
|
-
data, _status_code, _headers = create_organization_invitation_with_http_info(opts)
|
85
|
-
|
166
|
+
def create_organization_invitation(body, opts = {})
|
167
|
+
data, _status_code, _headers = create_organization_invitation_with_http_info(body, opts)
|
168
|
+
data
|
86
169
|
end
|
87
170
|
|
88
171
|
# Create a new invitation to join the organization
|
89
172
|
# This method creates and sends invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property `usedBy` will be directly filled with the uniquer identifier of the corresponding user.
|
173
|
+
# @param body [OrganizationInvitationCreation]
|
90
174
|
# @param [Hash] opts the optional parameters
|
91
|
-
# @
|
92
|
-
|
93
|
-
def create_organization_invitation_with_http_info(opts = {})
|
175
|
+
# @return [Array<(OrganizationInvitation, Integer, Hash)>] OrganizationInvitation data, response status code and response headers
|
176
|
+
def create_organization_invitation_with_http_info(body, opts = {})
|
94
177
|
if @api_client.config.debugging
|
95
|
-
@api_client.config.logger.debug
|
178
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.create_organization_invitation ...'
|
179
|
+
end
|
180
|
+
# verify the required parameter 'body' is set
|
181
|
+
if @api_client.config.client_side_validation && body.nil?
|
182
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.create_organization_invitation"
|
96
183
|
end
|
97
184
|
# resource path
|
98
|
-
local_var_path =
|
185
|
+
local_var_path = '/organizations/invitations'
|
99
186
|
|
100
187
|
# query parameters
|
101
|
-
query_params = {}
|
188
|
+
query_params = opts[:query_params] || {}
|
102
189
|
|
103
190
|
# header parameters
|
104
|
-
header_params = {}
|
191
|
+
header_params = opts[:header_params] || {}
|
105
192
|
# HTTP header 'Accept' (if needed)
|
106
193
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
107
194
|
# HTTP header 'Content-Type'
|
108
|
-
|
195
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
196
|
+
if !content_type.nil?
|
197
|
+
header_params['Content-Type'] = content_type
|
198
|
+
end
|
109
199
|
|
110
200
|
# form parameters
|
111
|
-
form_params = {}
|
201
|
+
form_params = opts[:form_params] || {}
|
112
202
|
|
113
203
|
# http body (model)
|
114
|
-
post_body = @api_client.object_to_http_body(
|
115
|
-
|
116
|
-
|
204
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
205
|
+
|
206
|
+
# return_type
|
207
|
+
return_type = opts[:debug_return_type] || 'OrganizationInvitation'
|
208
|
+
|
209
|
+
# auth_names
|
210
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
211
|
+
|
212
|
+
new_options = opts.merge(
|
213
|
+
:operation => :"OrganizationApi.create_organization_invitation",
|
117
214
|
:header_params => header_params,
|
118
215
|
:query_params => query_params,
|
119
216
|
:form_params => form_params,
|
120
217
|
:body => post_body,
|
121
218
|
:auth_names => auth_names,
|
122
|
-
:return_type =>
|
219
|
+
:return_type => return_type
|
220
|
+
)
|
221
|
+
|
222
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
123
223
|
if @api_client.config.debugging
|
124
224
|
@api_client.config.logger.debug "API called: OrganizationApi#create_organization_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
125
225
|
end
|
@@ -127,99 +227,266 @@ module FlatApi
|
|
127
227
|
end
|
128
228
|
|
129
229
|
# Create a new user account
|
130
|
-
#
|
230
|
+
# @param body [UserCreation]
|
131
231
|
# @param [Hash] opts the optional parameters
|
132
|
-
# @option opts [UserCreation] :body
|
133
232
|
# @return [UserDetailsAdmin]
|
134
|
-
def create_organization_user(opts = {})
|
135
|
-
data, _status_code, _headers = create_organization_user_with_http_info(opts)
|
136
|
-
|
233
|
+
def create_organization_user(body, opts = {})
|
234
|
+
data, _status_code, _headers = create_organization_user_with_http_info(body, opts)
|
235
|
+
data
|
137
236
|
end
|
138
237
|
|
139
238
|
# Create a new user account
|
140
|
-
#
|
239
|
+
# @param body [UserCreation]
|
141
240
|
# @param [Hash] opts the optional parameters
|
142
|
-
# @
|
143
|
-
|
144
|
-
def create_organization_user_with_http_info(opts = {})
|
241
|
+
# @return [Array<(UserDetailsAdmin, Integer, Hash)>] UserDetailsAdmin data, response status code and response headers
|
242
|
+
def create_organization_user_with_http_info(body, opts = {})
|
145
243
|
if @api_client.config.debugging
|
146
|
-
@api_client.config.logger.debug
|
244
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.create_organization_user ...'
|
245
|
+
end
|
246
|
+
# verify the required parameter 'body' is set
|
247
|
+
if @api_client.config.client_side_validation && body.nil?
|
248
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.create_organization_user"
|
147
249
|
end
|
148
250
|
# resource path
|
149
|
-
local_var_path =
|
251
|
+
local_var_path = '/organizations/users'
|
150
252
|
|
151
253
|
# query parameters
|
152
|
-
query_params = {}
|
254
|
+
query_params = opts[:query_params] || {}
|
153
255
|
|
154
256
|
# header parameters
|
155
|
-
header_params = {}
|
257
|
+
header_params = opts[:header_params] || {}
|
156
258
|
# HTTP header 'Accept' (if needed)
|
157
259
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
158
260
|
# HTTP header 'Content-Type'
|
159
|
-
|
261
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
262
|
+
if !content_type.nil?
|
263
|
+
header_params['Content-Type'] = content_type
|
264
|
+
end
|
160
265
|
|
161
266
|
# form parameters
|
162
|
-
form_params = {}
|
267
|
+
form_params = opts[:form_params] || {}
|
163
268
|
|
164
269
|
# http body (model)
|
165
|
-
post_body = @api_client.object_to_http_body(
|
166
|
-
|
167
|
-
|
270
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
271
|
+
|
272
|
+
# return_type
|
273
|
+
return_type = opts[:debug_return_type] || 'UserDetailsAdmin'
|
274
|
+
|
275
|
+
# auth_names
|
276
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
277
|
+
|
278
|
+
new_options = opts.merge(
|
279
|
+
:operation => :"OrganizationApi.create_organization_user",
|
168
280
|
:header_params => header_params,
|
169
281
|
:query_params => query_params,
|
170
282
|
:form_params => form_params,
|
171
283
|
:body => post_body,
|
172
284
|
:auth_names => auth_names,
|
173
|
-
:return_type =>
|
285
|
+
:return_type => return_type
|
286
|
+
)
|
287
|
+
|
288
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
174
289
|
if @api_client.config.debugging
|
175
290
|
@api_client.config.logger.debug "API called: OrganizationApi#create_organization_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
176
291
|
end
|
177
292
|
return data, status_code, headers
|
178
293
|
end
|
179
294
|
|
295
|
+
# Create a delegated API access token for an organization user
|
296
|
+
# This operation will create an API access token for a chosen organization user. This token will be valid for a limited time and can be used to access the API as the organization user.
|
297
|
+
# @param user [String] Unique identifier of the Flat account
|
298
|
+
# @param organization_user_access_token_creation [OrganizationUserAccessTokenCreation]
|
299
|
+
# @param [Hash] opts the optional parameters
|
300
|
+
# @return [ApiAccessToken]
|
301
|
+
def create_organization_user_access_token(user, organization_user_access_token_creation, opts = {})
|
302
|
+
data, _status_code, _headers = create_organization_user_access_token_with_http_info(user, organization_user_access_token_creation, opts)
|
303
|
+
data
|
304
|
+
end
|
305
|
+
|
306
|
+
# Create a delegated API access token for an organization user
|
307
|
+
# This operation will create an API access token for a chosen organization user. This token will be valid for a limited time and can be used to access the API as the organization user.
|
308
|
+
# @param user [String] Unique identifier of the Flat account
|
309
|
+
# @param organization_user_access_token_creation [OrganizationUserAccessTokenCreation]
|
310
|
+
# @param [Hash] opts the optional parameters
|
311
|
+
# @return [Array<(ApiAccessToken, Integer, Hash)>] ApiAccessToken data, response status code and response headers
|
312
|
+
def create_organization_user_access_token_with_http_info(user, organization_user_access_token_creation, opts = {})
|
313
|
+
if @api_client.config.debugging
|
314
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.create_organization_user_access_token ...'
|
315
|
+
end
|
316
|
+
# verify the required parameter 'user' is set
|
317
|
+
if @api_client.config.client_side_validation && user.nil?
|
318
|
+
fail ArgumentError, "Missing the required parameter 'user' when calling OrganizationApi.create_organization_user_access_token"
|
319
|
+
end
|
320
|
+
# verify the required parameter 'organization_user_access_token_creation' is set
|
321
|
+
if @api_client.config.client_side_validation && organization_user_access_token_creation.nil?
|
322
|
+
fail ArgumentError, "Missing the required parameter 'organization_user_access_token_creation' when calling OrganizationApi.create_organization_user_access_token"
|
323
|
+
end
|
324
|
+
# resource path
|
325
|
+
local_var_path = '/organizations/users/{user}/accessToken'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
|
326
|
+
|
327
|
+
# query parameters
|
328
|
+
query_params = opts[:query_params] || {}
|
329
|
+
|
330
|
+
# header parameters
|
331
|
+
header_params = opts[:header_params] || {}
|
332
|
+
# HTTP header 'Accept' (if needed)
|
333
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
334
|
+
# HTTP header 'Content-Type'
|
335
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
336
|
+
if !content_type.nil?
|
337
|
+
header_params['Content-Type'] = content_type
|
338
|
+
end
|
339
|
+
|
340
|
+
# form parameters
|
341
|
+
form_params = opts[:form_params] || {}
|
342
|
+
|
343
|
+
# http body (model)
|
344
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(organization_user_access_token_creation)
|
345
|
+
|
346
|
+
# return_type
|
347
|
+
return_type = opts[:debug_return_type] || 'ApiAccessToken'
|
348
|
+
|
349
|
+
# auth_names
|
350
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
351
|
+
|
352
|
+
new_options = opts.merge(
|
353
|
+
:operation => :"OrganizationApi.create_organization_user_access_token",
|
354
|
+
:header_params => header_params,
|
355
|
+
:query_params => query_params,
|
356
|
+
:form_params => form_params,
|
357
|
+
:body => post_body,
|
358
|
+
:auth_names => auth_names,
|
359
|
+
:return_type => return_type
|
360
|
+
)
|
361
|
+
|
362
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
363
|
+
if @api_client.config.debugging
|
364
|
+
@api_client.config.logger.debug "API called: OrganizationApi#create_organization_user_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
365
|
+
end
|
366
|
+
return data, status_code, headers
|
367
|
+
end
|
368
|
+
|
369
|
+
# Create a sign in link for an organization user
|
370
|
+
# @param user [String] Unique identifier of the Flat account
|
371
|
+
# @param user_signin_link_creation [UserSigninLinkCreation]
|
372
|
+
# @param [Hash] opts the optional parameters
|
373
|
+
# @return [UserSigninLink]
|
374
|
+
def create_organization_user_signin_link(user, user_signin_link_creation, opts = {})
|
375
|
+
data, _status_code, _headers = create_organization_user_signin_link_with_http_info(user, user_signin_link_creation, opts)
|
376
|
+
data
|
377
|
+
end
|
378
|
+
|
379
|
+
# Create a sign in link for an organization user
|
380
|
+
# @param user [String] Unique identifier of the Flat account
|
381
|
+
# @param user_signin_link_creation [UserSigninLinkCreation]
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @return [Array<(UserSigninLink, Integer, Hash)>] UserSigninLink data, response status code and response headers
|
384
|
+
def create_organization_user_signin_link_with_http_info(user, user_signin_link_creation, opts = {})
|
385
|
+
if @api_client.config.debugging
|
386
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.create_organization_user_signin_link ...'
|
387
|
+
end
|
388
|
+
# verify the required parameter 'user' is set
|
389
|
+
if @api_client.config.client_side_validation && user.nil?
|
390
|
+
fail ArgumentError, "Missing the required parameter 'user' when calling OrganizationApi.create_organization_user_signin_link"
|
391
|
+
end
|
392
|
+
# verify the required parameter 'user_signin_link_creation' is set
|
393
|
+
if @api_client.config.client_side_validation && user_signin_link_creation.nil?
|
394
|
+
fail ArgumentError, "Missing the required parameter 'user_signin_link_creation' when calling OrganizationApi.create_organization_user_signin_link"
|
395
|
+
end
|
396
|
+
# resource path
|
397
|
+
local_var_path = '/organizations/users/{user}/signinLink'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
|
398
|
+
|
399
|
+
# query parameters
|
400
|
+
query_params = opts[:query_params] || {}
|
401
|
+
|
402
|
+
# header parameters
|
403
|
+
header_params = opts[:header_params] || {}
|
404
|
+
# HTTP header 'Accept' (if needed)
|
405
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
406
|
+
# HTTP header 'Content-Type'
|
407
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
408
|
+
if !content_type.nil?
|
409
|
+
header_params['Content-Type'] = content_type
|
410
|
+
end
|
411
|
+
|
412
|
+
# form parameters
|
413
|
+
form_params = opts[:form_params] || {}
|
414
|
+
|
415
|
+
# http body (model)
|
416
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_signin_link_creation)
|
417
|
+
|
418
|
+
# return_type
|
419
|
+
return_type = opts[:debug_return_type] || 'UserSigninLink'
|
420
|
+
|
421
|
+
# auth_names
|
422
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
423
|
+
|
424
|
+
new_options = opts.merge(
|
425
|
+
:operation => :"OrganizationApi.create_organization_user_signin_link",
|
426
|
+
:header_params => header_params,
|
427
|
+
:query_params => query_params,
|
428
|
+
:form_params => form_params,
|
429
|
+
:body => post_body,
|
430
|
+
:auth_names => auth_names,
|
431
|
+
:return_type => return_type
|
432
|
+
)
|
433
|
+
|
434
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
435
|
+
if @api_client.config.debugging
|
436
|
+
@api_client.config.logger.debug "API called: OrganizationApi#create_organization_user_signin_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
437
|
+
end
|
438
|
+
return data, status_code, headers
|
439
|
+
end
|
440
|
+
|
180
441
|
# List LTI 1.x credentials
|
181
|
-
#
|
182
442
|
# @param [Hash] opts the optional parameters
|
183
443
|
# @return [Array<LtiCredentials>]
|
184
444
|
def list_lti_credentials(opts = {})
|
185
445
|
data, _status_code, _headers = list_lti_credentials_with_http_info(opts)
|
186
|
-
|
446
|
+
data
|
187
447
|
end
|
188
448
|
|
189
449
|
# List LTI 1.x credentials
|
190
|
-
#
|
191
450
|
# @param [Hash] opts the optional parameters
|
192
|
-
# @return [Array<(Array<LtiCredentials>,
|
451
|
+
# @return [Array<(Array<LtiCredentials>, Integer, Hash)>] Array<LtiCredentials> data, response status code and response headers
|
193
452
|
def list_lti_credentials_with_http_info(opts = {})
|
194
453
|
if @api_client.config.debugging
|
195
|
-
@api_client.config.logger.debug
|
454
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.list_lti_credentials ...'
|
196
455
|
end
|
197
456
|
# resource path
|
198
|
-
local_var_path =
|
457
|
+
local_var_path = '/organizations/lti/credentials'
|
199
458
|
|
200
459
|
# query parameters
|
201
|
-
query_params = {}
|
460
|
+
query_params = opts[:query_params] || {}
|
202
461
|
|
203
462
|
# header parameters
|
204
|
-
header_params = {}
|
463
|
+
header_params = opts[:header_params] || {}
|
205
464
|
# HTTP header 'Accept' (if needed)
|
206
465
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
207
|
-
# HTTP header 'Content-Type'
|
208
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
209
466
|
|
210
467
|
# form parameters
|
211
|
-
form_params = {}
|
468
|
+
form_params = opts[:form_params] || {}
|
212
469
|
|
213
470
|
# http body (model)
|
214
|
-
post_body =
|
215
|
-
|
216
|
-
|
471
|
+
post_body = opts[:debug_body]
|
472
|
+
|
473
|
+
# return_type
|
474
|
+
return_type = opts[:debug_return_type] || 'Array<LtiCredentials>'
|
475
|
+
|
476
|
+
# auth_names
|
477
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
478
|
+
|
479
|
+
new_options = opts.merge(
|
480
|
+
:operation => :"OrganizationApi.list_lti_credentials",
|
217
481
|
:header_params => header_params,
|
218
482
|
:query_params => query_params,
|
219
483
|
:form_params => form_params,
|
220
484
|
:body => post_body,
|
221
485
|
:auth_names => auth_names,
|
222
|
-
:return_type =>
|
486
|
+
:return_type => return_type
|
487
|
+
)
|
488
|
+
|
489
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
223
490
|
if @api_client.config.debugging
|
224
491
|
@api_client.config.logger.debug "API called: OrganizationApi#list_lti_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
225
492
|
end
|
@@ -227,7 +494,6 @@ module FlatApi
|
|
227
494
|
end
|
228
495
|
|
229
496
|
# List the organization invitations
|
230
|
-
#
|
231
497
|
# @param [Hash] opts the optional parameters
|
232
498
|
# @option opts [String] :role Filter users by role
|
233
499
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 50)
|
@@ -236,23 +502,23 @@ module FlatApi
|
|
236
502
|
# @return [Array<OrganizationInvitation>]
|
237
503
|
def list_organization_invitations(opts = {})
|
238
504
|
data, _status_code, _headers = list_organization_invitations_with_http_info(opts)
|
239
|
-
|
505
|
+
data
|
240
506
|
end
|
241
507
|
|
242
508
|
# List the organization invitations
|
243
|
-
#
|
244
509
|
# @param [Hash] opts the optional parameters
|
245
510
|
# @option opts [String] :role Filter users by role
|
246
|
-
# @option opts [Integer] :limit This is the maximum number of objects that may be returned
|
511
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 50)
|
247
512
|
# @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
248
513
|
# @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
249
|
-
# @return [Array<(Array<OrganizationInvitation>,
|
514
|
+
# @return [Array<(Array<OrganizationInvitation>, Integer, Hash)>] Array<OrganizationInvitation> data, response status code and response headers
|
250
515
|
def list_organization_invitations_with_http_info(opts = {})
|
251
516
|
if @api_client.config.debugging
|
252
|
-
@api_client.config.logger.debug
|
517
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.list_organization_invitations ...'
|
253
518
|
end
|
254
|
-
|
255
|
-
|
519
|
+
allowable_values = ["user", "teacher", "admin"]
|
520
|
+
if @api_client.config.client_side_validation && opts[:'role'] && !allowable_values.include?(opts[:'role'])
|
521
|
+
fail ArgumentError, "invalid value for \"role\", must be one of #{allowable_values}"
|
256
522
|
end
|
257
523
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
|
258
524
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationApi.list_organization_invitations, must be smaller than or equal to 1000.'
|
@@ -263,35 +529,43 @@ module FlatApi
|
|
263
529
|
end
|
264
530
|
|
265
531
|
# resource path
|
266
|
-
local_var_path =
|
532
|
+
local_var_path = '/organizations/invitations'
|
267
533
|
|
268
534
|
# query parameters
|
269
|
-
query_params = {}
|
535
|
+
query_params = opts[:query_params] || {}
|
270
536
|
query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
|
271
537
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
272
538
|
query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
|
273
539
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
274
540
|
|
275
541
|
# header parameters
|
276
|
-
header_params = {}
|
542
|
+
header_params = opts[:header_params] || {}
|
277
543
|
# HTTP header 'Accept' (if needed)
|
278
544
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
|
-
# HTTP header 'Content-Type'
|
280
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
281
545
|
|
282
546
|
# form parameters
|
283
|
-
form_params = {}
|
547
|
+
form_params = opts[:form_params] || {}
|
284
548
|
|
285
549
|
# http body (model)
|
286
|
-
post_body =
|
287
|
-
|
288
|
-
|
550
|
+
post_body = opts[:debug_body]
|
551
|
+
|
552
|
+
# return_type
|
553
|
+
return_type = opts[:debug_return_type] || 'Array<OrganizationInvitation>'
|
554
|
+
|
555
|
+
# auth_names
|
556
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
557
|
+
|
558
|
+
new_options = opts.merge(
|
559
|
+
:operation => :"OrganizationApi.list_organization_invitations",
|
289
560
|
:header_params => header_params,
|
290
561
|
:query_params => query_params,
|
291
562
|
:form_params => form_params,
|
292
563
|
:body => post_body,
|
293
564
|
:auth_names => auth_names,
|
294
|
-
:return_type =>
|
565
|
+
:return_type => return_type
|
566
|
+
)
|
567
|
+
|
568
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
295
569
|
if @api_client.config.debugging
|
296
570
|
@api_client.config.logger.debug "API called: OrganizationApi#list_organization_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
297
571
|
end
|
@@ -299,32 +573,53 @@ module FlatApi
|
|
299
573
|
end
|
300
574
|
|
301
575
|
# List the organization users
|
302
|
-
#
|
303
576
|
# @param [Hash] opts the optional parameters
|
304
|
-
# @option opts [String] :
|
305
|
-
# @option opts [
|
577
|
+
# @option opts [Array<String>] :sort The order to sort the user list
|
578
|
+
# @option opts [String] :direction Sort direction
|
306
579
|
# @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
307
580
|
# @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
581
|
+
# @option opts [Array<String>] :role Filter users by role
|
582
|
+
# @option opts [String] :q The query to search
|
583
|
+
# @option opts [Array<String>] :group Filter users by group
|
584
|
+
# @option opts [Boolean] :no_active_license Filter users who don't have an active license
|
585
|
+
# @option opts [Array<String>] :license_expiration_date Filter users by license expiration date or `active` / `notActive`
|
586
|
+
# @option opts [Boolean] :only_ids Return only user ids
|
587
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
308
588
|
# @return [Array<UserDetailsAdmin>]
|
309
589
|
def list_organization_users(opts = {})
|
310
590
|
data, _status_code, _headers = list_organization_users_with_http_info(opts)
|
311
|
-
|
591
|
+
data
|
312
592
|
end
|
313
593
|
|
314
594
|
# List the organization users
|
315
|
-
#
|
316
595
|
# @param [Hash] opts the optional parameters
|
317
|
-
# @option opts [String] :
|
318
|
-
# @option opts [
|
596
|
+
# @option opts [Array<String>] :sort The order to sort the user list
|
597
|
+
# @option opts [String] :direction Sort direction
|
319
598
|
# @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
320
599
|
# @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
|
321
|
-
# @
|
600
|
+
# @option opts [Array<String>] :role Filter users by role
|
601
|
+
# @option opts [String] :q The query to search
|
602
|
+
# @option opts [Array<String>] :group Filter users by group
|
603
|
+
# @option opts [Boolean] :no_active_license Filter users who don't have an active license
|
604
|
+
# @option opts [Array<String>] :license_expiration_date Filter users by license expiration date or `active` / `notActive`
|
605
|
+
# @option opts [Boolean] :only_ids Return only user ids
|
606
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
607
|
+
# @return [Array<(Array<UserDetailsAdmin>, Integer, Hash)>] Array<UserDetailsAdmin> data, response status code and response headers
|
322
608
|
def list_organization_users_with_http_info(opts = {})
|
323
609
|
if @api_client.config.debugging
|
324
|
-
@api_client.config.logger.debug
|
610
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.list_organization_users ...'
|
611
|
+
end
|
612
|
+
allowable_values = ["firstname", "lastname", "lastActivityDate", "licenseExpirationDate"]
|
613
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !opts[:'sort'].all? { |item| allowable_values.include?(item) }
|
614
|
+
fail ArgumentError, "invalid value for \"sort\", must include one of #{allowable_values}"
|
325
615
|
end
|
326
|
-
|
327
|
-
|
616
|
+
allowable_values = ["asc", "desc"]
|
617
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
618
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
619
|
+
end
|
620
|
+
allowable_values = ["user", "teacher", "admin"]
|
621
|
+
if @api_client.config.client_side_validation && opts[:'role'] && !opts[:'role'].all? { |item| allowable_values.include?(item) }
|
622
|
+
fail ArgumentError, "invalid value for \"role\", must include one of #{allowable_values}"
|
328
623
|
end
|
329
624
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
|
330
625
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationApi.list_organization_users, must be smaller than or equal to 1000.'
|
@@ -335,35 +630,50 @@ module FlatApi
|
|
335
630
|
end
|
336
631
|
|
337
632
|
# resource path
|
338
|
-
local_var_path =
|
633
|
+
local_var_path = '/organizations/users'
|
339
634
|
|
340
635
|
# query parameters
|
341
|
-
query_params = {}
|
342
|
-
query_params[:'
|
343
|
-
query_params[:'
|
636
|
+
query_params = opts[:query_params] || {}
|
637
|
+
query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
|
638
|
+
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
344
639
|
query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
|
345
640
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
641
|
+
query_params[:'role'] = @api_client.build_collection_param(opts[:'role'], :multi) if !opts[:'role'].nil?
|
642
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
643
|
+
query_params[:'group'] = @api_client.build_collection_param(opts[:'group'], :multi) if !opts[:'group'].nil?
|
644
|
+
query_params[:'noActiveLicense'] = opts[:'no_active_license'] if !opts[:'no_active_license'].nil?
|
645
|
+
query_params[:'licenseExpirationDate'] = @api_client.build_collection_param(opts[:'license_expiration_date'], :multi) if !opts[:'license_expiration_date'].nil?
|
646
|
+
query_params[:'onlyIds'] = opts[:'only_ids'] if !opts[:'only_ids'].nil?
|
647
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
346
648
|
|
347
649
|
# header parameters
|
348
|
-
header_params = {}
|
650
|
+
header_params = opts[:header_params] || {}
|
349
651
|
# HTTP header 'Accept' (if needed)
|
350
652
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
351
|
-
# HTTP header 'Content-Type'
|
352
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
353
653
|
|
354
654
|
# form parameters
|
355
|
-
form_params = {}
|
655
|
+
form_params = opts[:form_params] || {}
|
356
656
|
|
357
657
|
# http body (model)
|
358
|
-
post_body =
|
359
|
-
|
360
|
-
|
658
|
+
post_body = opts[:debug_body]
|
659
|
+
|
660
|
+
# return_type
|
661
|
+
return_type = opts[:debug_return_type] || 'Array<UserDetailsAdmin>'
|
662
|
+
|
663
|
+
# auth_names
|
664
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
665
|
+
|
666
|
+
new_options = opts.merge(
|
667
|
+
:operation => :"OrganizationApi.list_organization_users",
|
361
668
|
:header_params => header_params,
|
362
669
|
:query_params => query_params,
|
363
670
|
:form_params => form_params,
|
364
671
|
:body => post_body,
|
365
672
|
:auth_names => auth_names,
|
366
|
-
:return_type =>
|
673
|
+
:return_type => return_type
|
674
|
+
)
|
675
|
+
|
676
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
367
677
|
if @api_client.config.debugging
|
368
678
|
@api_client.config.logger.debug "API called: OrganizationApi#list_organization_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
369
679
|
end
|
@@ -371,53 +681,60 @@ module FlatApi
|
|
371
681
|
end
|
372
682
|
|
373
683
|
# Remove an organization invitation
|
374
|
-
#
|
375
|
-
# @param invitation Unique identifier of the invitation
|
684
|
+
# @param invitation [String] Unique identifier of the invitation
|
376
685
|
# @param [Hash] opts the optional parameters
|
377
686
|
# @return [nil]
|
378
687
|
def remove_organization_invitation(invitation, opts = {})
|
379
688
|
remove_organization_invitation_with_http_info(invitation, opts)
|
380
|
-
|
689
|
+
nil
|
381
690
|
end
|
382
691
|
|
383
692
|
# Remove an organization invitation
|
384
|
-
#
|
385
|
-
# @param invitation Unique identifier of the invitation
|
693
|
+
# @param invitation [String] Unique identifier of the invitation
|
386
694
|
# @param [Hash] opts the optional parameters
|
387
|
-
# @return [Array<(nil,
|
695
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
388
696
|
def remove_organization_invitation_with_http_info(invitation, opts = {})
|
389
697
|
if @api_client.config.debugging
|
390
|
-
@api_client.config.logger.debug
|
698
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.remove_organization_invitation ...'
|
391
699
|
end
|
392
700
|
# verify the required parameter 'invitation' is set
|
393
701
|
if @api_client.config.client_side_validation && invitation.nil?
|
394
702
|
fail ArgumentError, "Missing the required parameter 'invitation' when calling OrganizationApi.remove_organization_invitation"
|
395
703
|
end
|
396
704
|
# resource path
|
397
|
-
local_var_path =
|
705
|
+
local_var_path = '/organizations/invitations/{invitation}'.sub('{' + 'invitation' + '}', CGI.escape(invitation.to_s))
|
398
706
|
|
399
707
|
# query parameters
|
400
|
-
query_params = {}
|
708
|
+
query_params = opts[:query_params] || {}
|
401
709
|
|
402
710
|
# header parameters
|
403
|
-
header_params = {}
|
711
|
+
header_params = opts[:header_params] || {}
|
404
712
|
# HTTP header 'Accept' (if needed)
|
405
713
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
406
|
-
# HTTP header 'Content-Type'
|
407
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
408
714
|
|
409
715
|
# form parameters
|
410
|
-
form_params = {}
|
716
|
+
form_params = opts[:form_params] || {}
|
411
717
|
|
412
718
|
# http body (model)
|
413
|
-
post_body =
|
414
|
-
|
415
|
-
|
719
|
+
post_body = opts[:debug_body]
|
720
|
+
|
721
|
+
# return_type
|
722
|
+
return_type = opts[:debug_return_type]
|
723
|
+
|
724
|
+
# auth_names
|
725
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
726
|
+
|
727
|
+
new_options = opts.merge(
|
728
|
+
:operation => :"OrganizationApi.remove_organization_invitation",
|
416
729
|
:header_params => header_params,
|
417
730
|
:query_params => query_params,
|
418
731
|
:form_params => form_params,
|
419
732
|
:body => post_body,
|
420
|
-
:auth_names => auth_names
|
733
|
+
:auth_names => auth_names,
|
734
|
+
:return_type => return_type
|
735
|
+
)
|
736
|
+
|
737
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
421
738
|
if @api_client.config.debugging
|
422
739
|
@api_client.config.logger.debug "API called: OrganizationApi#remove_organization_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
423
740
|
end
|
@@ -426,55 +743,64 @@ module FlatApi
|
|
426
743
|
|
427
744
|
# Remove an account from Flat
|
428
745
|
# This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)
|
429
|
-
# @param user Unique identifier of the Flat account
|
746
|
+
# @param user [String] Unique identifier of the Flat account
|
430
747
|
# @param [Hash] opts the optional parameters
|
431
|
-
# @option opts [
|
748
|
+
# @option opts [Boolean] :convert_to_individual If `true`, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal.
|
432
749
|
# @return [nil]
|
433
750
|
def remove_organization_user(user, opts = {})
|
434
751
|
remove_organization_user_with_http_info(user, opts)
|
435
|
-
|
752
|
+
nil
|
436
753
|
end
|
437
754
|
|
438
755
|
# Remove an account from Flat
|
439
756
|
# This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)
|
440
|
-
# @param user Unique identifier of the Flat account
|
757
|
+
# @param user [String] Unique identifier of the Flat account
|
441
758
|
# @param [Hash] opts the optional parameters
|
442
|
-
# @option opts [
|
443
|
-
# @return [Array<(nil,
|
759
|
+
# @option opts [Boolean] :convert_to_individual If `true`, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal.
|
760
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
444
761
|
def remove_organization_user_with_http_info(user, opts = {})
|
445
762
|
if @api_client.config.debugging
|
446
|
-
@api_client.config.logger.debug
|
763
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.remove_organization_user ...'
|
447
764
|
end
|
448
765
|
# verify the required parameter 'user' is set
|
449
766
|
if @api_client.config.client_side_validation && user.nil?
|
450
767
|
fail ArgumentError, "Missing the required parameter 'user' when calling OrganizationApi.remove_organization_user"
|
451
768
|
end
|
452
769
|
# resource path
|
453
|
-
local_var_path =
|
770
|
+
local_var_path = '/organizations/users/{user}'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
|
454
771
|
|
455
772
|
# query parameters
|
456
|
-
query_params = {}
|
773
|
+
query_params = opts[:query_params] || {}
|
457
774
|
query_params[:'convertToIndividual'] = opts[:'convert_to_individual'] if !opts[:'convert_to_individual'].nil?
|
458
775
|
|
459
776
|
# header parameters
|
460
|
-
header_params = {}
|
777
|
+
header_params = opts[:header_params] || {}
|
461
778
|
# HTTP header 'Accept' (if needed)
|
462
779
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
463
|
-
# HTTP header 'Content-Type'
|
464
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
465
780
|
|
466
781
|
# form parameters
|
467
|
-
form_params = {}
|
782
|
+
form_params = opts[:form_params] || {}
|
468
783
|
|
469
784
|
# http body (model)
|
470
|
-
post_body =
|
471
|
-
|
472
|
-
|
785
|
+
post_body = opts[:debug_body]
|
786
|
+
|
787
|
+
# return_type
|
788
|
+
return_type = opts[:debug_return_type]
|
789
|
+
|
790
|
+
# auth_names
|
791
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
792
|
+
|
793
|
+
new_options = opts.merge(
|
794
|
+
:operation => :"OrganizationApi.remove_organization_user",
|
473
795
|
:header_params => header_params,
|
474
796
|
:query_params => query_params,
|
475
797
|
:form_params => form_params,
|
476
798
|
:body => post_body,
|
477
|
-
:auth_names => auth_names
|
799
|
+
:auth_names => auth_names,
|
800
|
+
:return_type => return_type
|
801
|
+
)
|
802
|
+
|
803
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
478
804
|
if @api_client.config.debugging
|
479
805
|
@api_client.config.logger.debug "API called: OrganizationApi#remove_organization_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
480
806
|
end
|
@@ -482,53 +808,60 @@ module FlatApi
|
|
482
808
|
end
|
483
809
|
|
484
810
|
# Revoke LTI 1.x credentials
|
485
|
-
#
|
486
|
-
# @param credentials Credentials unique identifier
|
811
|
+
# @param credentials [String] Credentials unique identifier
|
487
812
|
# @param [Hash] opts the optional parameters
|
488
813
|
# @return [nil]
|
489
814
|
def revoke_lti_credentials(credentials, opts = {})
|
490
815
|
revoke_lti_credentials_with_http_info(credentials, opts)
|
491
|
-
|
816
|
+
nil
|
492
817
|
end
|
493
818
|
|
494
819
|
# Revoke LTI 1.x credentials
|
495
|
-
#
|
496
|
-
# @param credentials Credentials unique identifier
|
820
|
+
# @param credentials [String] Credentials unique identifier
|
497
821
|
# @param [Hash] opts the optional parameters
|
498
|
-
# @return [Array<(nil,
|
822
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
499
823
|
def revoke_lti_credentials_with_http_info(credentials, opts = {})
|
500
824
|
if @api_client.config.debugging
|
501
|
-
@api_client.config.logger.debug
|
825
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.revoke_lti_credentials ...'
|
502
826
|
end
|
503
827
|
# verify the required parameter 'credentials' is set
|
504
828
|
if @api_client.config.client_side_validation && credentials.nil?
|
505
829
|
fail ArgumentError, "Missing the required parameter 'credentials' when calling OrganizationApi.revoke_lti_credentials"
|
506
830
|
end
|
507
831
|
# resource path
|
508
|
-
local_var_path =
|
832
|
+
local_var_path = '/organizations/lti/credentials/{credentials}'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))
|
509
833
|
|
510
834
|
# query parameters
|
511
|
-
query_params = {}
|
835
|
+
query_params = opts[:query_params] || {}
|
512
836
|
|
513
837
|
# header parameters
|
514
|
-
header_params = {}
|
838
|
+
header_params = opts[:header_params] || {}
|
515
839
|
# HTTP header 'Accept' (if needed)
|
516
840
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
517
|
-
# HTTP header 'Content-Type'
|
518
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
519
841
|
|
520
842
|
# form parameters
|
521
|
-
form_params = {}
|
843
|
+
form_params = opts[:form_params] || {}
|
522
844
|
|
523
845
|
# http body (model)
|
524
|
-
post_body =
|
525
|
-
|
526
|
-
|
846
|
+
post_body = opts[:debug_body]
|
847
|
+
|
848
|
+
# return_type
|
849
|
+
return_type = opts[:debug_return_type]
|
850
|
+
|
851
|
+
# auth_names
|
852
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
853
|
+
|
854
|
+
new_options = opts.merge(
|
855
|
+
:operation => :"OrganizationApi.revoke_lti_credentials",
|
527
856
|
:header_params => header_params,
|
528
857
|
:query_params => query_params,
|
529
858
|
:form_params => form_params,
|
530
859
|
:body => post_body,
|
531
|
-
:auth_names => auth_names
|
860
|
+
:auth_names => auth_names,
|
861
|
+
:return_type => return_type
|
862
|
+
)
|
863
|
+
|
864
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
532
865
|
if @api_client.config.debugging
|
533
866
|
@api_client.config.logger.debug "API called: OrganizationApi#revoke_lti_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
534
867
|
end
|
@@ -536,25 +869,23 @@ module FlatApi
|
|
536
869
|
end
|
537
870
|
|
538
871
|
# Update account information
|
539
|
-
#
|
540
|
-
# @param
|
541
|
-
# @param body
|
872
|
+
# @param user [String] Unique identifier of the Flat account
|
873
|
+
# @param body [UserAdminUpdate]
|
542
874
|
# @param [Hash] opts the optional parameters
|
543
875
|
# @return [UserDetailsAdmin]
|
544
876
|
def update_organization_user(user, body, opts = {})
|
545
877
|
data, _status_code, _headers = update_organization_user_with_http_info(user, body, opts)
|
546
|
-
|
878
|
+
data
|
547
879
|
end
|
548
880
|
|
549
881
|
# Update account information
|
550
|
-
#
|
551
|
-
# @param
|
552
|
-
# @param body
|
882
|
+
# @param user [String] Unique identifier of the Flat account
|
883
|
+
# @param body [UserAdminUpdate]
|
553
884
|
# @param [Hash] opts the optional parameters
|
554
|
-
# @return [Array<(UserDetailsAdmin,
|
885
|
+
# @return [Array<(UserDetailsAdmin, Integer, Hash)>] UserDetailsAdmin data, response status code and response headers
|
555
886
|
def update_organization_user_with_http_info(user, body, opts = {})
|
556
887
|
if @api_client.config.debugging
|
557
|
-
@api_client.config.logger.debug
|
888
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.update_organization_user ...'
|
558
889
|
end
|
559
890
|
# verify the required parameter 'user' is set
|
560
891
|
if @api_client.config.client_side_validation && user.nil?
|
@@ -565,31 +896,44 @@ module FlatApi
|
|
565
896
|
fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.update_organization_user"
|
566
897
|
end
|
567
898
|
# resource path
|
568
|
-
local_var_path =
|
899
|
+
local_var_path = '/organizations/users/{user}'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
|
569
900
|
|
570
901
|
# query parameters
|
571
|
-
query_params = {}
|
902
|
+
query_params = opts[:query_params] || {}
|
572
903
|
|
573
904
|
# header parameters
|
574
|
-
header_params = {}
|
905
|
+
header_params = opts[:header_params] || {}
|
575
906
|
# HTTP header 'Accept' (if needed)
|
576
907
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
577
908
|
# HTTP header 'Content-Type'
|
578
|
-
|
909
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
910
|
+
if !content_type.nil?
|
911
|
+
header_params['Content-Type'] = content_type
|
912
|
+
end
|
579
913
|
|
580
914
|
# form parameters
|
581
|
-
form_params = {}
|
915
|
+
form_params = opts[:form_params] || {}
|
582
916
|
|
583
917
|
# http body (model)
|
584
|
-
post_body = @api_client.object_to_http_body(body)
|
585
|
-
|
586
|
-
|
918
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
919
|
+
|
920
|
+
# return_type
|
921
|
+
return_type = opts[:debug_return_type] || 'UserDetailsAdmin'
|
922
|
+
|
923
|
+
# auth_names
|
924
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
925
|
+
|
926
|
+
new_options = opts.merge(
|
927
|
+
:operation => :"OrganizationApi.update_organization_user",
|
587
928
|
:header_params => header_params,
|
588
929
|
:query_params => query_params,
|
589
930
|
:form_params => form_params,
|
590
931
|
:body => post_body,
|
591
932
|
:auth_names => auth_names,
|
592
|
-
:return_type =>
|
933
|
+
:return_type => return_type
|
934
|
+
)
|
935
|
+
|
936
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
593
937
|
if @api_client.config.debugging
|
594
938
|
@api_client.config.logger.debug "API called: OrganizationApi#update_organization_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
595
939
|
end
|