flat_api 0.3.5 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +69 -0
- data/LICENSE +201 -0
- data/README.md +92 -0
- data/lib/flat_api/api/account_api.rb +4 -4
- data/lib/flat_api/api/class_api.rb +281 -63
- data/lib/flat_api/api/collection_api.rb +63 -50
- data/lib/flat_api/api/edu_resources_api.rb +38 -26
- data/lib/flat_api/api/group_api.rb +432 -9
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +307 -35
- data/lib/flat_api/api/score_api.rb +129 -80
- data/lib/flat_api/api/task_api.rb +5 -5
- data/lib/flat_api/api/user_api.rb +45 -14
- data/lib/flat_api/api_client.rb +169 -96
- data/lib/flat_api/api_error.rb +3 -3
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +124 -25
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +13 -80
- data/lib/flat_api/models/app_scopes.rb +6 -4
- data/lib/flat_api/models/assignment.rb +190 -85
- data/lib/flat_api/models/assignment_capabilities.rb +53 -80
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +33 -80
- data/lib/flat_api/models/assignment_copy.rb +5 -6
- data/lib/flat_api/models/assignment_copy_response.rb +187 -82
- data/lib/flat_api/models/assignment_copy_to_class.rb +23 -80
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +23 -80
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +104 -81
- data/lib/flat_api/models/assignment_submission_comment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +23 -80
- data/lib/flat_api/models/assignment_submission_comments.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history.rb +33 -80
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +13 -80
- data/lib/flat_api/models/assignment_submission_history_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_lti.rb +64 -86
- data/lib/flat_api/models/{assignment_submission_playback_inner.rb → assignment_submission_playback.rb} +36 -83
- data/lib/flat_api/models/assignment_submission_state.rb +3 -3
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +25 -81
- data/lib/flat_api/models/assignment_type.rb +5 -4
- data/lib/flat_api/models/assignment_update.rb +218 -87
- data/lib/flat_api/models/class_assignment.rb +219 -82
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +13 -80
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +13 -80
- data/lib/flat_api/models/class_assignment_update.rb +237 -94
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_attachment_creation.rb +51 -86
- data/lib/flat_api/models/class_creation.rb +13 -80
- data/lib/flat_api/models/class_details.rb +85 -81
- data/lib/flat_api/models/class_details_canvas.rb +13 -80
- data/lib/flat_api/models/class_details_clever.rb +13 -80
- data/lib/flat_api/models/class_details_google_classroom.rb +13 -80
- data/lib/flat_api/models/class_details_google_drive.rb +13 -80
- data/lib/flat_api/models/class_details_issues.rb +13 -80
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +15 -82
- data/lib/flat_api/models/class_details_lti.rb +28 -85
- data/lib/flat_api/models/class_details_mfc.rb +13 -80
- data/lib/flat_api/models/class_details_microsoft_graph.rb +13 -80
- data/lib/flat_api/models/class_grade_level.rb +3 -3
- data/lib/flat_api/models/class_roles.rb +3 -3
- data/lib/flat_api/models/class_state.rb +5 -4
- data/lib/flat_api/models/class_update.rb +13 -80
- data/lib/flat_api/models/collection.rb +182 -81
- data/lib/flat_api/models/collection_app.rb +13 -80
- data/lib/flat_api/models/collection_capabilities.rb +63 -80
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +20 -99
- data/lib/flat_api/models/collection_modification.rb +17 -82
- data/lib/flat_api/models/collection_privacy.rb +3 -3
- data/lib/flat_api/models/collection_type.rb +7 -6
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +63 -82
- data/lib/flat_api/models/edu_resource.rb +101 -84
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +27 -84
- data/lib/flat_api/models/edu_resource_copy.rb +23 -80
- data/lib/flat_api/models/edu_resource_creation.rb +96 -86
- data/lib/flat_api/models/edu_resource_folder.rb +39 -84
- data/lib/flat_api/models/edu_resource_lti_link.rb +23 -80
- data/lib/flat_api/models/edu_resource_move.rb +23 -80
- data/lib/flat_api/models/edu_resource_privacy.rb +3 -3
- data/lib/flat_api/models/edu_resource_resource.rb +5 -6
- data/lib/flat_api/models/edu_resource_type.rb +3 -3
- data/lib/flat_api/models/edu_resource_update.rb +101 -86
- data/lib/flat_api/models/edu_resource_use_in_class.rb +23 -80
- data/lib/flat_api/models/flat_error_response.rb +47 -84
- data/lib/flat_api/models/google_classroom_coursework.rb +13 -80
- data/lib/flat_api/models/google_classroom_submission.rb +43 -80
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +14 -94
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +178 -84
- data/lib/flat_api/models/group_type.rb +6 -4
- data/lib/flat_api/models/license_mode.rb +3 -3
- data/lib/flat_api/models/license_sources.rb +3 -3
- data/lib/flat_api/models/lms_name.rb +3 -3
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +29 -84
- data/lib/flat_api/models/lti_credentials_creation.rb +23 -80
- data/lib/flat_api/models/media_attachment.rb +43 -88
- data/lib/flat_api/models/media_score_sharing_mode.rb +3 -3
- data/lib/flat_api/models/microsoft_graph_assignment.rb +99 -88
- data/lib/flat_api/models/microsoft_graph_submission.rb +33 -80
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +54 -81
- data/lib/flat_api/models/organization_invitation_creation.rb +15 -82
- data/lib/flat_api/models/organization_roles.rb +5 -5
- data/lib/flat_api/models/organization_user_access_token_creation.rb +23 -80
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +43 -85
- data/lib/flat_api/models/resource_collaborator_creation.rb +13 -80
- data/lib/flat_api/models/resource_rights.rb +43 -85
- data/lib/flat_api/models/score_comment.rb +122 -80
- data/lib/flat_api/models/score_comment_context.rb +73 -80
- data/lib/flat_api/models/score_comment_creation.rb +24 -81
- data/lib/flat_api/models/score_comment_moderation.rb +13 -80
- data/lib/flat_api/models/score_comment_update.rb +18 -85
- data/lib/flat_api/models/score_comments_counts.rb +28 -85
- data/lib/flat_api/models/score_creation.rb +5 -6
- data/lib/flat_api/models/score_creation_builder_data.rb +24 -88
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +23 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +13 -80
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +24 -81
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +33 -80
- data/lib/flat_api/models/score_creation_common.rb +14 -81
- data/lib/flat_api/models/score_creation_file_import.rb +39 -86
- data/lib/flat_api/models/score_creation_google_drive_import.rb +24 -81
- data/lib/flat_api/models/score_creation_type.rb +4 -5
- data/lib/flat_api/models/score_details.rb +180 -89
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +14 -83
- data/lib/flat_api/models/score_license.rb +4 -5
- data/lib/flat_api/models/score_likes_counts.rb +28 -106
- data/lib/flat_api/models/score_modification.rb +13 -80
- data/lib/flat_api/models/score_plays_counts.rb +28 -85
- data/lib/flat_api/models/score_privacy.rb +3 -3
- data/lib/flat_api/models/score_revision.rb +81 -87
- data/lib/flat_api/models/score_revision_creation.rb +23 -80
- data/lib/flat_api/models/score_revision_statistics.rb +13 -80
- data/lib/flat_api/models/score_source.rb +13 -80
- data/lib/flat_api/models/score_summary.rb +63 -80
- data/lib/flat_api/models/score_track.rb +94 -88
- data/lib/flat_api/models/score_track_creation.rb +13 -80
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +23 -80
- data/lib/flat_api/models/score_track_purpose.rb +3 -3
- data/lib/flat_api/models/score_track_state.rb +3 -3
- data/lib/flat_api/models/score_track_type.rb +3 -3
- data/lib/flat_api/models/score_track_update.rb +25 -81
- data/lib/flat_api/models/score_views_counts.rb +28 -85
- data/lib/flat_api/models/task.rb +62 -87
- data/lib/flat_api/models/task_export_options.rb +13 -80
- data/lib/flat_api/models/task_progress.rb +13 -80
- data/lib/flat_api/models/task_result.rb +13 -80
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +3 -3
- data/lib/flat_api/models/user_admin_update.rb +17 -95
- data/lib/flat_api/models/user_azure_details.rb +13 -80
- data/lib/flat_api/models/user_basics.rb +43 -80
- data/lib/flat_api/models/user_community_profile_links.rb +13 -80
- data/lib/flat_api/models/user_creation.rb +21 -98
- data/lib/flat_api/models/user_details.rb +101 -96
- data/lib/flat_api/models/user_details_admin.rb +72 -85
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +13 -80
- data/lib/flat_api/models/user_public.rb +89 -94
- data/lib/flat_api/models/user_public_summary.rb +58 -81
- data/lib/flat_api/models/user_signin_link.rb +24 -81
- data/lib/flat_api/models/user_signin_link_creation.rb +13 -80
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +4 -4
- data/lib/flat_api.rb +70 -5
- metadata +98 -330
- data/lib/flat_api/models/flat_locales.rb +0 -56
- data/spec/api/account_api_spec.rb +0 -47
- data/spec/api/class_api_spec.rb +0 -422
- data/spec/api/collection_api_spec.rb +0 -158
- data/spec/api/edu_resources_api_spec.rb +0 -181
- data/spec/api/group_api_spec.rb +0 -71
- data/spec/api/organization_api_spec.rb +0 -201
- data/spec/api/score_api_spec.rb +0 -440
- data/spec/api/task_api_spec.rb +0 -47
- data/spec/api/user_api_spec.rb +0 -75
- data/spec/models/api_access_token_spec.rb +0 -66
- data/spec/models/app_scopes_spec.rb +0 -30
- data/spec/models/assignment_capabilities_can_publish_in_class_error_spec.rb +0 -42
- data/spec/models/assignment_capabilities_spec.rb +0 -60
- data/spec/models/assignment_copy_response_spec.rb +0 -124
- data/spec/models/assignment_copy_spec.rb +0 -32
- data/spec/models/assignment_copy_to_class_spec.rb +0 -48
- data/spec/models/assignment_copy_to_resource_library_spec.rb +0 -42
- data/spec/models/assignment_spec.rb +0 -118
- data/spec/models/assignment_submission_comment_creation_spec.rb +0 -36
- data/spec/models/assignment_submission_comment_spec.rb +0 -72
- data/spec/models/assignment_submission_comments_spec.rb +0 -42
- data/spec/models/assignment_submission_history_attachment_spec.rb +0 -48
- data/spec/models/assignment_submission_history_spec.rb +0 -112
- data/spec/models/assignment_submission_history_state_spec.rb +0 -30
- data/spec/models/assignment_submission_lti_spec.rb +0 -36
- data/spec/models/assignment_submission_playback_inner_spec.rb +0 -42
- data/spec/models/assignment_submission_spec.rb +0 -144
- data/spec/models/assignment_submission_state_spec.rb +0 -30
- data/spec/models/assignment_submission_update_spec.rb +0 -66
- data/spec/models/assignment_type_spec.rb +0 -30
- data/spec/models/assignment_update_spec.rb +0 -100
- data/spec/models/class_assignment_all_of_canvas_spec.rb +0 -42
- data/spec/models/class_assignment_all_of_lti_spec.rb +0 -36
- data/spec/models/class_assignment_all_of_mfc_spec.rb +0 -42
- data/spec/models/class_assignment_spec.rb +0 -216
- data/spec/models/class_assignment_update_all_of_google_classroom_spec.rb +0 -36
- data/spec/models/class_assignment_update_all_of_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_assignment_update_spec.rb +0 -150
- data/spec/models/class_attachment_creation_spec.rb +0 -76
- data/spec/models/class_creation_spec.rb +0 -64
- data/spec/models/class_details_canvas_spec.rb +0 -42
- data/spec/models/class_details_clever_spec.rb +0 -76
- data/spec/models/class_details_google_classroom_spec.rb +0 -42
- data/spec/models/class_details_google_drive_spec.rb +0 -42
- data/spec/models/class_details_issues_spec.rb +0 -36
- data/spec/models/class_details_issues_sync_inner_spec.rb +0 -52
- data/spec/models/class_details_lti_spec.rb +0 -48
- data/spec/models/class_details_mfc_spec.rb +0 -42
- data/spec/models/class_details_microsoft_graph_spec.rb +0 -36
- data/spec/models/class_details_spec.rb +0 -178
- data/spec/models/class_grade_level_spec.rb +0 -30
- data/spec/models/class_roles_spec.rb +0 -30
- data/spec/models/class_state_spec.rb +0 -30
- data/spec/models/class_update_spec.rb +0 -64
- data/spec/models/collection_app_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -60
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -30
- data/spec/models/collection_spec.rb +0 -114
- data/spec/models/collection_type_spec.rb +0 -30
- data/spec/models/edu_library_spec.rb +0 -62
- data/spec/models/edu_resource_capabilities_spec.rb +0 -48
- data/spec/models/edu_resource_copy_spec.rb +0 -36
- data/spec/models/edu_resource_creation_spec.rb +0 -48
- data/spec/models/edu_resource_folder_spec.rb +0 -36
- data/spec/models/edu_resource_lti_link_spec.rb +0 -36
- data/spec/models/edu_resource_move_spec.rb +0 -36
- data/spec/models/edu_resource_privacy_spec.rb +0 -30
- data/spec/models/edu_resource_resource_spec.rb +0 -32
- data/spec/models/edu_resource_spec.rb +0 -96
- data/spec/models/edu_resource_type_spec.rb +0 -30
- data/spec/models/edu_resource_update_spec.rb +0 -42
- data/spec/models/edu_resource_use_in_class_spec.rb +0 -42
- data/spec/models/flat_error_response_spec.rb +0 -54
- data/spec/models/flat_locales_spec.rb +0 -30
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -48
- data/spec/models/group_details_spec.rb +0 -72
- data/spec/models/group_spec.rb +0 -76
- data/spec/models/group_type_spec.rb +0 -30
- data/spec/models/license_mode_spec.rb +0 -30
- data/spec/models/license_sources_spec.rb +0 -30
- data/spec/models/lms_name_spec.rb +0 -30
- data/spec/models/lti_credentials_creation_spec.rb +0 -42
- data/spec/models/lti_credentials_spec.rb +0 -84
- data/spec/models/media_attachment_spec.rb +0 -166
- data/spec/models/media_score_sharing_mode_spec.rb +0 -30
- data/spec/models/microsoft_graph_assignment_spec.rb +0 -54
- data/spec/models/microsoft_graph_submission_spec.rb +0 -42
- data/spec/models/organization_invitation_creation_spec.rb +0 -46
- data/spec/models/organization_invitation_spec.rb +0 -84
- data/spec/models/organization_roles_spec.rb +0 -30
- data/spec/models/organization_user_access_token_creation_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -72
- data/spec/models/resource_collaborator_spec.rb +0 -112
- data/spec/models/resource_rights_spec.rb +0 -64
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -66
- data/spec/models/score_comment_moderation_spec.rb +0 -46
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -54
- data/spec/models/score_comments_counts_spec.rb +0 -54
- data/spec/models/score_creation_builder_data_all_of_builder_data_layout_data_spec.rb +0 -82
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_instruments_spec.rb +0 -60
- data/spec/models/score_creation_builder_data_all_of_builder_data_score_data_spec.rb +0 -66
- data/spec/models/score_creation_builder_data_all_of_builder_data_spec.rb +0 -42
- data/spec/models/score_creation_builder_data_spec.rb +0 -60
- data/spec/models/score_creation_common_spec.rb +0 -54
- data/spec/models/score_creation_file_import_spec.rb +0 -76
- data/spec/models/score_creation_google_drive_import_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -32
- data/spec/models/score_creation_type_spec.rb +0 -30
- data/spec/models/score_details_spec.rb +0 -240
- data/spec/models/score_fork_spec.rb +0 -48
- data/spec/models/score_license_spec.rb +0 -30
- data/spec/models/score_likes_counts_spec.rb +0 -48
- data/spec/models/score_modification_spec.rb +0 -102
- data/spec/models/score_plays_counts_spec.rb +0 -48
- data/spec/models/score_privacy_spec.rb +0 -30
- data/spec/models/score_revision_creation_spec.rb +0 -58
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -54
- data/spec/models/score_source_spec.rb +0 -36
- data/spec/models/score_summary_spec.rb +0 -66
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -52
- data/spec/models/score_track_purpose_spec.rb +0 -30
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -30
- data/spec/models/score_track_type_spec.rb +0 -30
- data/spec/models/score_track_update_spec.rb +0 -54
- data/spec/models/score_views_counts_spec.rb +0 -48
- data/spec/models/task_export_options_spec.rb +0 -36
- data/spec/models/task_progress_spec.rb +0 -42
- data/spec/models/task_result_spec.rb +0 -42
- data/spec/models/task_spec.rb +0 -100
- data/spec/models/tutteo_product_spec.rb +0 -30
- data/spec/models/user_admin_update_spec.rb +0 -66
- data/spec/models/user_azure_details_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -94
- data/spec/models/user_community_profile_links_spec.rb +0 -66
- data/spec/models/user_creation_spec.rb +0 -76
- data/spec/models/user_details_admin_all_of_license_spec.rb +0 -60
- data/spec/models/user_details_admin_spec.rb +0 -142
- data/spec/models/user_details_spec.rb +0 -214
- data/spec/models/user_public_spec.rb +0 -178
- data/spec/models/user_public_summary_spec.rb +0 -118
- data/spec/models/user_signin_link_creation_spec.rb +0 -36
- data/spec/models/user_signin_link_spec.rb +0 -42
- data/spec/spec_helper.rb +0 -111
|
@@ -1,12 +1,12 @@
|
|
|
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, MIDI, Guitar Pro
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ module FlatApi
|
|
|
21
21
|
end
|
|
22
22
|
# Add a score to the collection
|
|
23
23
|
# This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability `canAddScores` on the provided `collection` to perform the action.
|
|
24
|
-
# @param collection [String] Unique identifier of the collection.
|
|
24
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
|
|
25
25
|
# @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
@@ -33,7 +33,7 @@ module FlatApi
|
|
|
33
33
|
|
|
34
34
|
# Add a score to the collection
|
|
35
35
|
# This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability `canAddScores` on the provided `collection` to perform the action.
|
|
36
|
-
# @param collection [String] Unique identifier of the collection.
|
|
36
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
|
|
37
37
|
# @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
39
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
@@ -51,7 +51,7 @@ module FlatApi
|
|
|
51
51
|
fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.add_score_to_collection"
|
|
52
52
|
end
|
|
53
53
|
# resource path
|
|
54
|
-
local_var_path = '/collections/{collection}/scores/{score}'.sub('{
|
|
54
|
+
local_var_path = '/collections/{collection}/scores/{score}'.sub('{collection}', CGI.escape(collection.to_s)).sub('{score}', CGI.escape(score.to_s))
|
|
55
55
|
|
|
56
56
|
# query parameters
|
|
57
57
|
query_params = opts[:query_params] || {}
|
|
@@ -60,7 +60,12 @@ module FlatApi
|
|
|
60
60
|
# header parameters
|
|
61
61
|
header_params = opts[:header_params] || {}
|
|
62
62
|
# HTTP header 'Accept' (if needed)
|
|
63
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
63
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
64
|
+
# HTTP header 'Content-Type'
|
|
65
|
+
content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
|
66
|
+
if !content_type.nil?
|
|
67
|
+
header_params['Content-Type'] = content_type
|
|
68
|
+
end
|
|
64
69
|
|
|
65
70
|
# form parameters
|
|
66
71
|
form_params = opts[:form_params] || {}
|
|
@@ -92,7 +97,7 @@ module FlatApi
|
|
|
92
97
|
end
|
|
93
98
|
|
|
94
99
|
# Create a new collection
|
|
95
|
-
# This method will create a new collection
|
|
100
|
+
# This method will create a new collection in your account.
|
|
96
101
|
# @param body [CollectionCreation]
|
|
97
102
|
# @param [Hash] opts the optional parameters
|
|
98
103
|
# @return [Collection]
|
|
@@ -102,7 +107,7 @@ module FlatApi
|
|
|
102
107
|
end
|
|
103
108
|
|
|
104
109
|
# Create a new collection
|
|
105
|
-
# This method will create a new collection
|
|
110
|
+
# This method will create a new collection in your account.
|
|
106
111
|
# @param body [CollectionCreation]
|
|
107
112
|
# @param [Hash] opts the optional parameters
|
|
108
113
|
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
@@ -123,7 +128,7 @@ module FlatApi
|
|
|
123
128
|
# header parameters
|
|
124
129
|
header_params = opts[:header_params] || {}
|
|
125
130
|
# HTTP header 'Accept' (if needed)
|
|
126
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
131
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
127
132
|
# HTTP header 'Content-Type'
|
|
128
133
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
129
134
|
if !content_type.nil?
|
|
@@ -161,7 +166,7 @@ module FlatApi
|
|
|
161
166
|
|
|
162
167
|
# Delete the collection
|
|
163
168
|
# This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`.
|
|
164
|
-
# @param collection [String] Unique identifier of the collection.
|
|
169
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
165
170
|
# @param [Hash] opts the optional parameters
|
|
166
171
|
# @return [nil]
|
|
167
172
|
def delete_collection(collection, opts = {})
|
|
@@ -171,7 +176,7 @@ module FlatApi
|
|
|
171
176
|
|
|
172
177
|
# Delete the collection
|
|
173
178
|
# This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`.
|
|
174
|
-
# @param collection [String] Unique identifier of the collection.
|
|
179
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
175
180
|
# @param [Hash] opts the optional parameters
|
|
176
181
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
177
182
|
def delete_collection_with_http_info(collection, opts = {})
|
|
@@ -183,7 +188,7 @@ module FlatApi
|
|
|
183
188
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_collection"
|
|
184
189
|
end
|
|
185
190
|
# resource path
|
|
186
|
-
local_var_path = '/collections/{collection}'.sub('{
|
|
191
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
187
192
|
|
|
188
193
|
# query parameters
|
|
189
194
|
query_params = opts[:query_params] || {}
|
|
@@ -191,7 +196,7 @@ module FlatApi
|
|
|
191
196
|
# header parameters
|
|
192
197
|
header_params = opts[:header_params] || {}
|
|
193
198
|
# HTTP header 'Accept' (if needed)
|
|
194
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
199
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
195
200
|
|
|
196
201
|
# form parameters
|
|
197
202
|
form_params = opts[:form_params] || {}
|
|
@@ -224,9 +229,10 @@ module FlatApi
|
|
|
224
229
|
|
|
225
230
|
# Delete a score from the collection
|
|
226
231
|
# This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
|
|
227
|
-
# @param collection [String] Unique identifier of the collection.
|
|
232
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
|
|
228
233
|
# @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
|
229
234
|
# @param [Hash] opts the optional parameters
|
|
235
|
+
# @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
230
236
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
231
237
|
# @return [nil]
|
|
232
238
|
def delete_score_from_collection(collection, score, opts = {})
|
|
@@ -236,9 +242,10 @@ module FlatApi
|
|
|
236
242
|
|
|
237
243
|
# Delete a score from the collection
|
|
238
244
|
# This method will delete a score from the collection. Unlike [`DELETE /scores/{score}`](#operation/deleteScore), this score will not remove the score from your account, but only from the collection. This can be used to *move* a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.
|
|
239
|
-
# @param collection [String] Unique identifier of the collection.
|
|
245
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted
|
|
240
246
|
# @param score [String] Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
|
241
247
|
# @param [Hash] opts the optional parameters
|
|
248
|
+
# @option opts [String] :event_properties Optional analytics properties merged into XP tracking for this request. JSON-encoded string representing event properties. Example: - `?eventProperties={\"context\":\"discover\",\"screenLevel0\":\"home\"}`
|
|
242
249
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
243
250
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
244
251
|
def delete_score_from_collection_with_http_info(collection, score, opts = {})
|
|
@@ -254,16 +261,22 @@ module FlatApi
|
|
|
254
261
|
fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.delete_score_from_collection"
|
|
255
262
|
end
|
|
256
263
|
# resource path
|
|
257
|
-
local_var_path = '/collections/{collection}/scores/{score}'.sub('{
|
|
264
|
+
local_var_path = '/collections/{collection}/scores/{score}'.sub('{collection}', CGI.escape(collection.to_s)).sub('{score}', CGI.escape(score.to_s))
|
|
258
265
|
|
|
259
266
|
# query parameters
|
|
260
267
|
query_params = opts[:query_params] || {}
|
|
268
|
+
query_params[:'eventProperties'] = opts[:'event_properties'] if !opts[:'event_properties'].nil?
|
|
261
269
|
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
262
270
|
|
|
263
271
|
# header parameters
|
|
264
272
|
header_params = opts[:header_params] || {}
|
|
265
273
|
# HTTP header 'Accept' (if needed)
|
|
266
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
274
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
275
|
+
# HTTP header 'Content-Type'
|
|
276
|
+
content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
|
277
|
+
if !content_type.nil?
|
|
278
|
+
header_params['Content-Type'] = content_type
|
|
279
|
+
end
|
|
267
280
|
|
|
268
281
|
# form parameters
|
|
269
282
|
form_params = opts[:form_params] || {}
|
|
@@ -295,7 +308,7 @@ module FlatApi
|
|
|
295
308
|
end
|
|
296
309
|
|
|
297
310
|
# Update a collection's metadata
|
|
298
|
-
# @param collection [String] Unique identifier of the collection.
|
|
311
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
299
312
|
# @param body [CollectionModification]
|
|
300
313
|
# @param [Hash] opts the optional parameters
|
|
301
314
|
# @return [Collection]
|
|
@@ -305,7 +318,7 @@ module FlatApi
|
|
|
305
318
|
end
|
|
306
319
|
|
|
307
320
|
# Update a collection's metadata
|
|
308
|
-
# @param collection [String] Unique identifier of the collection.
|
|
321
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
309
322
|
# @param body [CollectionModification]
|
|
310
323
|
# @param [Hash] opts the optional parameters
|
|
311
324
|
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
@@ -322,7 +335,7 @@ module FlatApi
|
|
|
322
335
|
fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.edit_collection"
|
|
323
336
|
end
|
|
324
337
|
# resource path
|
|
325
|
-
local_var_path = '/collections/{collection}'.sub('{
|
|
338
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
326
339
|
|
|
327
340
|
# query parameters
|
|
328
341
|
query_params = opts[:query_params] || {}
|
|
@@ -330,7 +343,7 @@ module FlatApi
|
|
|
330
343
|
# header parameters
|
|
331
344
|
header_params = opts[:header_params] || {}
|
|
332
345
|
# HTTP header 'Accept' (if needed)
|
|
333
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
346
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
334
347
|
# HTTP header 'Content-Type'
|
|
335
348
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
336
349
|
if !content_type.nil?
|
|
@@ -367,7 +380,7 @@ module FlatApi
|
|
|
367
380
|
end
|
|
368
381
|
|
|
369
382
|
# Get collection details
|
|
370
|
-
# @param collection [String] Unique identifier of the collection.
|
|
383
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
371
384
|
# @param [Hash] opts the optional parameters
|
|
372
385
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
373
386
|
# @return [Collection]
|
|
@@ -377,7 +390,7 @@ module FlatApi
|
|
|
377
390
|
end
|
|
378
391
|
|
|
379
392
|
# Get collection details
|
|
380
|
-
# @param collection [String] Unique identifier of the collection.
|
|
393
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
381
394
|
# @param [Hash] opts the optional parameters
|
|
382
395
|
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
383
396
|
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
@@ -390,7 +403,7 @@ module FlatApi
|
|
|
390
403
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.get_collection"
|
|
391
404
|
end
|
|
392
405
|
# resource path
|
|
393
|
-
local_var_path = '/collections/{collection}'.sub('{
|
|
406
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
394
407
|
|
|
395
408
|
# query parameters
|
|
396
409
|
query_params = opts[:query_params] || {}
|
|
@@ -399,7 +412,7 @@ module FlatApi
|
|
|
399
412
|
# header parameters
|
|
400
413
|
header_params = opts[:header_params] || {}
|
|
401
414
|
# HTTP header 'Accept' (if needed)
|
|
402
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
415
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
403
416
|
|
|
404
417
|
# form parameters
|
|
405
418
|
form_params = opts[:form_params] || {}
|
|
@@ -432,14 +445,14 @@ module FlatApi
|
|
|
432
445
|
|
|
433
446
|
# List the scores contained in a collection
|
|
434
447
|
# Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. For example, to list the scores contained in your app collection, you can use `GET /v2/collections/app/scores`.
|
|
435
|
-
# @param collection [String] Unique identifier of the collection.
|
|
448
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
436
449
|
# @param [Hash] opts the optional parameters
|
|
437
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
438
450
|
# @option opts [String] :sort Sort
|
|
439
451
|
# @option opts [String] :direction Sort direction
|
|
440
452
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
441
453
|
# @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.
|
|
442
454
|
# @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.
|
|
455
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
443
456
|
# @return [Array<ScoreDetails>]
|
|
444
457
|
def list_collection_scores(collection, opts = {})
|
|
445
458
|
data, _status_code, _headers = list_collection_scores_with_http_info(collection, opts)
|
|
@@ -448,14 +461,14 @@ module FlatApi
|
|
|
448
461
|
|
|
449
462
|
# List the scores contained in a collection
|
|
450
463
|
# Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. For example, to list the scores contained in your app collection, you can use `GET /v2/collections/app/scores`.
|
|
451
|
-
# @param collection [String] Unique identifier of the collection.
|
|
464
|
+
# @param collection [String] Unique identifier of the collection. The following collection aliases are supported: - `root`: **Deprecated.** The root collection of the account - `app`: Alias for the current app collection - `trash`: Automatically contains resources that have been deleted The following virtual collections are supported: - `allScores`: All the scores contained in the user account - `collaborations`: All shared scores by the user or someone else - `likes`: Liked scores
|
|
452
465
|
# @param [Hash] opts the optional parameters
|
|
453
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
454
466
|
# @option opts [String] :sort Sort
|
|
455
467
|
# @option opts [String] :direction Sort direction
|
|
456
468
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
457
469
|
# @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.
|
|
458
470
|
# @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.
|
|
471
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
|
459
472
|
# @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
|
460
473
|
def list_collection_scores_with_http_info(collection, opts = {})
|
|
461
474
|
if @api_client.config.debugging
|
|
@@ -482,21 +495,21 @@ module FlatApi
|
|
|
482
495
|
end
|
|
483
496
|
|
|
484
497
|
# resource path
|
|
485
|
-
local_var_path = '/collections/{collection}/scores'.sub('{
|
|
498
|
+
local_var_path = '/collections/{collection}/scores'.sub('{collection}', CGI.escape(collection.to_s))
|
|
486
499
|
|
|
487
500
|
# query parameters
|
|
488
501
|
query_params = opts[:query_params] || {}
|
|
489
|
-
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
490
502
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
491
503
|
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
|
492
504
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
493
505
|
query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
|
|
494
506
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
|
507
|
+
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
495
508
|
|
|
496
509
|
# header parameters
|
|
497
510
|
header_params = opts[:header_params] || {}
|
|
498
511
|
# HTTP header 'Accept' (if needed)
|
|
499
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
500
513
|
|
|
501
514
|
# form parameters
|
|
502
515
|
form_params = opts[:form_params] || {}
|
|
@@ -528,9 +541,9 @@ module FlatApi
|
|
|
528
541
|
end
|
|
529
542
|
|
|
530
543
|
# List the collections
|
|
531
|
-
# Use this method to list the user's collections
|
|
544
|
+
# Use this method to list the user's collections. If no sort option is provided, the collections are sorted by `creationDate` `desc`. By default (`parent=user`), this returns all user account collections with virtual collections on the first page. To fetch your app collection details, you can use `GET /v2/collections/app`.
|
|
532
545
|
# @param [Hash] opts the optional parameters
|
|
533
|
-
# @option opts [String] :parent List the
|
|
546
|
+
# @option opts [String] :parent List the collections contained in this `parent` collection. When set to `user` (default), returns the user's own collections as well as collections shared with the user. Using `root` or `sharedWithMe` is **deprecated** and will be treated as `user`. (default to 'user')
|
|
534
547
|
# @option opts [String] :sort Sort
|
|
535
548
|
# @option opts [String] :direction Sort direction
|
|
536
549
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
@@ -543,9 +556,9 @@ module FlatApi
|
|
|
543
556
|
end
|
|
544
557
|
|
|
545
558
|
# List the collections
|
|
546
|
-
# Use this method to list the user's collections
|
|
559
|
+
# Use this method to list the user's collections. If no sort option is provided, the collections are sorted by `creationDate` `desc`. By default (`parent=user`), this returns all user account collections with virtual collections on the first page. To fetch your app collection details, you can use `GET /v2/collections/app`.
|
|
547
560
|
# @param [Hash] opts the optional parameters
|
|
548
|
-
# @option opts [String] :parent List the
|
|
561
|
+
# @option opts [String] :parent List the collections contained in this `parent` collection. When set to `user` (default), returns the user's own collections as well as collections shared with the user. Using `root` or `sharedWithMe` is **deprecated** and will be treated as `user`. (default to 'user')
|
|
549
562
|
# @option opts [String] :sort Sort
|
|
550
563
|
# @option opts [String] :direction Sort direction
|
|
551
564
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
@@ -556,7 +569,7 @@ module FlatApi
|
|
|
556
569
|
if @api_client.config.debugging
|
|
557
570
|
@api_client.config.logger.debug 'Calling API: CollectionApi.list_collections ...'
|
|
558
571
|
end
|
|
559
|
-
allowable_values = ["creationDate", "title"]
|
|
572
|
+
allowable_values = ["creationDate", "modificationDate", "title"]
|
|
560
573
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
561
574
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
562
575
|
end
|
|
@@ -587,7 +600,7 @@ module FlatApi
|
|
|
587
600
|
# header parameters
|
|
588
601
|
header_params = opts[:header_params] || {}
|
|
589
602
|
# HTTP header 'Accept' (if needed)
|
|
590
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
603
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
591
604
|
|
|
592
605
|
# form parameters
|
|
593
606
|
form_params = opts[:form_params] || {}
|
|
@@ -619,20 +632,20 @@ module FlatApi
|
|
|
619
632
|
end
|
|
620
633
|
|
|
621
634
|
# Untrash a collection
|
|
622
|
-
# This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
|
623
|
-
# @param collection [String] Unique identifier of the collection.
|
|
635
|
+
# **DEPRECATED** This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
|
636
|
+
# @param collection [String] Unique identifier of the collection.
|
|
624
637
|
# @param [Hash] opts the optional parameters
|
|
625
|
-
# @return [
|
|
638
|
+
# @return [FlatErrorResponse]
|
|
626
639
|
def untrash_collection(collection, opts = {})
|
|
627
|
-
untrash_collection_with_http_info(collection, opts)
|
|
628
|
-
|
|
640
|
+
data, _status_code, _headers = untrash_collection_with_http_info(collection, opts)
|
|
641
|
+
data
|
|
629
642
|
end
|
|
630
643
|
|
|
631
644
|
# Untrash a collection
|
|
632
|
-
# This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
|
633
|
-
# @param collection [String] Unique identifier of the collection.
|
|
645
|
+
# **DEPRECATED** This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
|
646
|
+
# @param collection [String] Unique identifier of the collection.
|
|
634
647
|
# @param [Hash] opts the optional parameters
|
|
635
|
-
# @return [Array<(
|
|
648
|
+
# @return [Array<(FlatErrorResponse, Integer, Hash)>] FlatErrorResponse data, response status code and response headers
|
|
636
649
|
def untrash_collection_with_http_info(collection, opts = {})
|
|
637
650
|
if @api_client.config.debugging
|
|
638
651
|
@api_client.config.logger.debug 'Calling API: CollectionApi.untrash_collection ...'
|
|
@@ -642,7 +655,7 @@ module FlatApi
|
|
|
642
655
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.untrash_collection"
|
|
643
656
|
end
|
|
644
657
|
# resource path
|
|
645
|
-
local_var_path = '/collections/{collection}/untrash'.sub('{
|
|
658
|
+
local_var_path = '/collections/{collection}/untrash'.sub('{collection}', CGI.escape(collection.to_s))
|
|
646
659
|
|
|
647
660
|
# query parameters
|
|
648
661
|
query_params = opts[:query_params] || {}
|
|
@@ -650,7 +663,7 @@ module FlatApi
|
|
|
650
663
|
# header parameters
|
|
651
664
|
header_params = opts[:header_params] || {}
|
|
652
665
|
# HTTP header 'Accept' (if needed)
|
|
653
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
666
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
654
667
|
|
|
655
668
|
# form parameters
|
|
656
669
|
form_params = opts[:form_params] || {}
|
|
@@ -659,7 +672,7 @@ module FlatApi
|
|
|
659
672
|
post_body = opts[:debug_body]
|
|
660
673
|
|
|
661
674
|
# return_type
|
|
662
|
-
return_type = opts[:debug_return_type]
|
|
675
|
+
return_type = opts[:debug_return_type] || 'FlatErrorResponse'
|
|
663
676
|
|
|
664
677
|
# auth_names
|
|
665
678
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|