flat_api 0.2.0 → 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 +257 -169
- 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 +944 -552
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +112 -74
- 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 +138 -50
- data/lib/flat_api/models/collection_app.rb +236 -0
- data/lib/flat_api/models/collection_capabilities.rb +109 -47
- data/lib/flat_api/models/collection_creation.rb +132 -37
- data/lib/flat_api/models/collection_modification.rb +122 -35
- data/lib/flat_api/models/collection_privacy.rb +18 -9
- data/lib/flat_api/models/collection_type.rb +19 -9
- 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 +181 -51
- data/lib/flat_api/models/resource_collaborator_creation.rb +74 -47
- data/lib/flat_api/models/resource_rights.rb +145 -42
- 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 -225
- 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 +272 -81
- data/lib/flat_api/models/score_fork.rb +88 -36
- 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 +180 -50
- 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 +78 -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 +36 -37
- 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 +105 -91
- data/spec/api/task_api_spec.rb +47 -0
- data/spec/api/user_api_spec.rb +27 -25
- 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 +15 -21
- data/spec/models/collection_creation_spec.rb +17 -17
- data/spec/models/collection_modification_spec.rb +17 -17
- data/spec/models/collection_privacy_spec.rb +10 -16
- data/spec/models/collection_spec.rb +39 -27
- data/spec/models/collection_type_spec.rb +10 -16
- 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 +17 -23
- data/spec/models/resource_collaborator_spec.rb +47 -25
- data/spec/models/resource_rights_spec.rb +29 -19
- 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 -58
- 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 +23 -17
- 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 +47 -23
- 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 +279 -327
- data/CHANGELOG.md +0 -17
- data/Gemfile +0 -7
- data/README.md +0 -271
- data/Rakefile +0 -8
- data/docs/AccountApi.md +0 -55
- data/docs/Assignment.md +0 -18
- data/docs/AssignmentCopy.md +0 -8
- data/docs/AssignmentCreation.md +0 -12
- data/docs/AssignmentSubmission.md +0 -19
- data/docs/AssignmentSubmissionUpdate.md +0 -11
- data/docs/ClassApi.md +0 -1051
- data/docs/ClassAttachmentCreation.md +0 -10
- data/docs/ClassCreation.md +0 -9
- data/docs/ClassDetails.md +0 -25
- data/docs/ClassDetailsCanvas.md +0 -9
- data/docs/ClassDetailsClever.md +0 -14
- data/docs/ClassDetailsGoogleClassroom.md +0 -11
- data/docs/ClassDetailsGoogleDrive.md +0 -9
- data/docs/ClassDetailsLti.md +0 -10
- data/docs/ClassRoles.md +0 -7
- data/docs/ClassState.md +0 -7
- data/docs/ClassUpdate.md +0 -9
- data/docs/Collection.md +0 -18
- data/docs/CollectionApi.md +0 -521
- data/docs/CollectionCapabilities.md +0 -12
- data/docs/CollectionCreation.md +0 -8
- data/docs/CollectionModification.md +0 -8
- data/docs/CollectionPrivacy.md +0 -7
- data/docs/CollectionTitle.md +0 -7
- data/docs/CollectionType.md +0 -7
- data/docs/FlatErrorResponse.md +0 -11
- data/docs/FlatLocales.md +0 -7
- data/docs/GoogleClassroomCoursework.md +0 -10
- data/docs/GoogleClassroomSubmission.md +0 -10
- data/docs/Group.md +0 -14
- data/docs/GroupApi.md +0 -167
- data/docs/GroupDetails.md +0 -14
- data/docs/GroupType.md +0 -7
- data/docs/LicenseMode.md +0 -7
- data/docs/LicenseSources.md +0 -7
- data/docs/LmsName.md +0 -7
- data/docs/LtiCredentials.md +0 -16
- data/docs/LtiCredentialsCreation.md +0 -9
- data/docs/MediaAttachment.md +0 -23
- data/docs/MediaScoreSharingMode.md +0 -7
- data/docs/OrganizationApi.md +0 -538
- data/docs/OrganizationInvitation.md +0 -14
- data/docs/OrganizationInvitationCreation.md +0 -9
- data/docs/OrganizationRoles.md +0 -7
- data/docs/ResourceCollaborator.md +0 -16
- data/docs/ResourceCollaboratorCreation.md +0 -14
- data/docs/ResourceRights.md +0 -10
- data/docs/ResourceSharingKey.md +0 -7
- data/docs/ScoreApi.md +0 -1658
- data/docs/ScoreComment.md +0 -22
- data/docs/ScoreCommentContext.md +0 -14
- data/docs/ScoreCommentCreation.md +0 -13
- data/docs/ScoreCommentUpdate.md +0 -11
- data/docs/ScoreCommentsCounts.md +0 -11
- data/docs/ScoreCreation.md +0 -14
- data/docs/ScoreCreationType.md +0 -7
- data/docs/ScoreData.md +0 -7
- data/docs/ScoreDataEncoding.md +0 -7
- data/docs/ScoreDetails.md +0 -36
- data/docs/ScoreFork.md +0 -8
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -14
- data/docs/ScorePrivacy.md +0 -7
- data/docs/ScoreRevision.md +0 -14
- data/docs/ScoreRevisionCreation.md +0 -11
- data/docs/ScoreRevisionStatistics.md +0 -9
- data/docs/ScoreSource.md +0 -8
- data/docs/ScoreSummary.md +0 -13
- data/docs/ScoreTrack.md +0 -19
- data/docs/ScoreTrackCreation.md +0 -12
- data/docs/ScoreTrackPoint.md +0 -10
- data/docs/ScoreTrackState.md +0 -7
- data/docs/ScoreTrackType.md +0 -7
- data/docs/ScoreTrackUpdate.md +0 -11
- data/docs/ScoreViewsCounts.md +0 -10
- data/docs/UserAdminUpdate.md +0 -9
- data/docs/UserApi.md +0 -173
- data/docs/UserBasics.md +0 -13
- data/docs/UserCreation.md +0 -11
- data/docs/UserDetails.md +0 -28
- data/docs/UserDetailsAdmin.md +0 -20
- data/docs/UserDetailsAdminLicense.md +0 -12
- data/docs/UserInstruments.md +0 -7
- data/docs/UserPublic.md +0 -25
- data/docs/UserPublicSummary.md +0 -17
- data/flat_api.gemspec +0 -48
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/collection_title.rb +0 -179
- data/lib/flat_api/models/resource_sharing_key.rb +0 -179
- data/lib/flat_api/models/score_data.rb +0 -179
- data/lib/flat_api/models/score_data_encoding.rb +0 -30
- data/lib/flat_api/models/user_details_admin_license.rb +0 -227
- data/lib/flat_api/models/user_instruments.rb +0 -179
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/collection_title_spec.rb +0 -36
- data/spec/models/resource_sharing_key_spec.rb +0 -36
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/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 CollectionApi
|
@@ -19,29 +19,28 @@ module FlatApi
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
|
23
22
|
# Add a score to the collection
|
24
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.
|
25
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
26
|
-
# @param score 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`).
|
24
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
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`).
|
27
26
|
# @param [Hash] opts the optional parameters
|
28
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.
|
29
28
|
# @return [ScoreDetails]
|
30
29
|
def add_score_to_collection(collection, score, opts = {})
|
31
30
|
data, _status_code, _headers = add_score_to_collection_with_http_info(collection, score, opts)
|
32
|
-
|
31
|
+
data
|
33
32
|
end
|
34
33
|
|
35
34
|
# Add a score to the collection
|
36
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.
|
37
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
38
|
-
# @param score 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`).
|
36
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
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`).
|
39
38
|
# @param [Hash] opts the optional parameters
|
40
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.
|
41
|
-
# @return [Array<(ScoreDetails,
|
40
|
+
# @return [Array<(ScoreDetails, Integer, Hash)>] ScoreDetails data, response status code and response headers
|
42
41
|
def add_score_to_collection_with_http_info(collection, score, opts = {})
|
43
42
|
if @api_client.config.debugging
|
44
|
-
@api_client.config.logger.debug
|
43
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.add_score_to_collection ...'
|
45
44
|
end
|
46
45
|
# verify the required parameter 'collection' is set
|
47
46
|
if @api_client.config.client_side_validation && collection.nil?
|
@@ -52,32 +51,40 @@ module FlatApi
|
|
52
51
|
fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.add_score_to_collection"
|
53
52
|
end
|
54
53
|
# resource path
|
55
|
-
local_var_path =
|
54
|
+
local_var_path = '/collections/{collection}/scores/{score}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s)).sub('{' + 'score' + '}', CGI.escape(score.to_s))
|
56
55
|
|
57
56
|
# query parameters
|
58
|
-
query_params = {}
|
57
|
+
query_params = opts[:query_params] || {}
|
59
58
|
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
60
59
|
|
61
60
|
# header parameters
|
62
|
-
header_params = {}
|
61
|
+
header_params = opts[:header_params] || {}
|
63
62
|
# HTTP header 'Accept' (if needed)
|
64
63
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
65
|
-
# HTTP header 'Content-Type'
|
66
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
67
64
|
|
68
65
|
# form parameters
|
69
|
-
form_params = {}
|
66
|
+
form_params = opts[:form_params] || {}
|
70
67
|
|
71
68
|
# http body (model)
|
72
|
-
post_body =
|
73
|
-
|
74
|
-
|
69
|
+
post_body = opts[:debug_body]
|
70
|
+
|
71
|
+
# return_type
|
72
|
+
return_type = opts[:debug_return_type] || 'ScoreDetails'
|
73
|
+
|
74
|
+
# auth_names
|
75
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
76
|
+
|
77
|
+
new_options = opts.merge(
|
78
|
+
:operation => :"CollectionApi.add_score_to_collection",
|
75
79
|
:header_params => header_params,
|
76
80
|
:query_params => query_params,
|
77
81
|
:form_params => form_params,
|
78
82
|
:body => post_body,
|
79
83
|
:auth_names => auth_names,
|
80
|
-
:return_type =>
|
84
|
+
:return_type => return_type
|
85
|
+
)
|
86
|
+
|
87
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
81
88
|
if @api_client.config.debugging
|
82
89
|
@api_client.config.logger.debug "API called: CollectionApi#add_score_to_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
83
90
|
end
|
@@ -86,53 +93,66 @@ module FlatApi
|
|
86
93
|
|
87
94
|
# Create a new collection
|
88
95
|
# This method will create a new collection and add it to your `root` collection.
|
89
|
-
# @param body
|
96
|
+
# @param body [CollectionCreation]
|
90
97
|
# @param [Hash] opts the optional parameters
|
91
98
|
# @return [Collection]
|
92
99
|
def create_collection(body, opts = {})
|
93
100
|
data, _status_code, _headers = create_collection_with_http_info(body, opts)
|
94
|
-
|
101
|
+
data
|
95
102
|
end
|
96
103
|
|
97
104
|
# Create a new collection
|
98
105
|
# This method will create a new collection and add it to your `root` collection.
|
99
|
-
# @param body
|
106
|
+
# @param body [CollectionCreation]
|
100
107
|
# @param [Hash] opts the optional parameters
|
101
|
-
# @return [Array<(Collection,
|
108
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
102
109
|
def create_collection_with_http_info(body, opts = {})
|
103
110
|
if @api_client.config.debugging
|
104
|
-
@api_client.config.logger.debug
|
111
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.create_collection ...'
|
105
112
|
end
|
106
113
|
# verify the required parameter 'body' is set
|
107
114
|
if @api_client.config.client_side_validation && body.nil?
|
108
115
|
fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.create_collection"
|
109
116
|
end
|
110
117
|
# resource path
|
111
|
-
local_var_path =
|
118
|
+
local_var_path = '/collections'
|
112
119
|
|
113
120
|
# query parameters
|
114
|
-
query_params = {}
|
121
|
+
query_params = opts[:query_params] || {}
|
115
122
|
|
116
123
|
# header parameters
|
117
|
-
header_params = {}
|
124
|
+
header_params = opts[:header_params] || {}
|
118
125
|
# HTTP header 'Accept' (if needed)
|
119
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
120
127
|
# HTTP header 'Content-Type'
|
121
|
-
|
128
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
129
|
+
if !content_type.nil?
|
130
|
+
header_params['Content-Type'] = content_type
|
131
|
+
end
|
122
132
|
|
123
133
|
# form parameters
|
124
|
-
form_params = {}
|
134
|
+
form_params = opts[:form_params] || {}
|
125
135
|
|
126
136
|
# http body (model)
|
127
|
-
post_body = @api_client.object_to_http_body(body)
|
128
|
-
|
129
|
-
|
137
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
138
|
+
|
139
|
+
# return_type
|
140
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
141
|
+
|
142
|
+
# auth_names
|
143
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
144
|
+
|
145
|
+
new_options = opts.merge(
|
146
|
+
:operation => :"CollectionApi.create_collection",
|
130
147
|
:header_params => header_params,
|
131
148
|
:query_params => query_params,
|
132
149
|
:form_params => form_params,
|
133
150
|
:body => post_body,
|
134
151
|
:auth_names => auth_names,
|
135
|
-
:return_type =>
|
152
|
+
:return_type => return_type
|
153
|
+
)
|
154
|
+
|
155
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
136
156
|
if @api_client.config.debugging
|
137
157
|
@api_client.config.logger.debug "API called: CollectionApi#create_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
138
158
|
end
|
@@ -141,52 +161,61 @@ module FlatApi
|
|
141
161
|
|
142
162
|
# Delete the collection
|
143
163
|
# This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`.
|
144
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
164
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
145
165
|
# @param [Hash] opts the optional parameters
|
146
166
|
# @return [nil]
|
147
167
|
def delete_collection(collection, opts = {})
|
148
168
|
delete_collection_with_http_info(collection, opts)
|
149
|
-
|
169
|
+
nil
|
150
170
|
end
|
151
171
|
|
152
172
|
# Delete the collection
|
153
173
|
# This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`.
|
154
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
174
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
155
175
|
# @param [Hash] opts the optional parameters
|
156
|
-
# @return [Array<(nil,
|
176
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
157
177
|
def delete_collection_with_http_info(collection, opts = {})
|
158
178
|
if @api_client.config.debugging
|
159
|
-
@api_client.config.logger.debug
|
179
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.delete_collection ...'
|
160
180
|
end
|
161
181
|
# verify the required parameter 'collection' is set
|
162
182
|
if @api_client.config.client_side_validation && collection.nil?
|
163
183
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_collection"
|
164
184
|
end
|
165
185
|
# resource path
|
166
|
-
local_var_path =
|
186
|
+
local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
|
167
187
|
|
168
188
|
# query parameters
|
169
|
-
query_params = {}
|
189
|
+
query_params = opts[:query_params] || {}
|
170
190
|
|
171
191
|
# header parameters
|
172
|
-
header_params = {}
|
192
|
+
header_params = opts[:header_params] || {}
|
173
193
|
# HTTP header 'Accept' (if needed)
|
174
194
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
175
|
-
# HTTP header 'Content-Type'
|
176
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
177
195
|
|
178
196
|
# form parameters
|
179
|
-
form_params = {}
|
197
|
+
form_params = opts[:form_params] || {}
|
180
198
|
|
181
199
|
# http body (model)
|
182
|
-
post_body =
|
183
|
-
|
184
|
-
|
200
|
+
post_body = opts[:debug_body]
|
201
|
+
|
202
|
+
# return_type
|
203
|
+
return_type = opts[:debug_return_type]
|
204
|
+
|
205
|
+
# auth_names
|
206
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
207
|
+
|
208
|
+
new_options = opts.merge(
|
209
|
+
:operation => :"CollectionApi.delete_collection",
|
185
210
|
:header_params => header_params,
|
186
211
|
:query_params => query_params,
|
187
212
|
:form_params => form_params,
|
188
213
|
:body => post_body,
|
189
|
-
:auth_names => auth_names
|
214
|
+
:auth_names => auth_names,
|
215
|
+
:return_type => return_type
|
216
|
+
)
|
217
|
+
|
218
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
190
219
|
if @api_client.config.debugging
|
191
220
|
@api_client.config.logger.debug "API called: CollectionApi#delete_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
192
221
|
end
|
@@ -195,24 +224,26 @@ module FlatApi
|
|
195
224
|
|
196
225
|
# Delete a score from the collection
|
197
226
|
# 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.
|
198
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
199
|
-
# @param score 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`).
|
227
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
228
|
+
# @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`).
|
200
229
|
# @param [Hash] opts the optional parameters
|
230
|
+
# @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.
|
201
231
|
# @return [nil]
|
202
232
|
def delete_score_from_collection(collection, score, opts = {})
|
203
233
|
delete_score_from_collection_with_http_info(collection, score, opts)
|
204
|
-
|
234
|
+
nil
|
205
235
|
end
|
206
236
|
|
207
237
|
# Delete a score from the collection
|
208
238
|
# 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.
|
209
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
210
|
-
# @param score 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`).
|
239
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
240
|
+
# @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`).
|
211
241
|
# @param [Hash] opts the optional parameters
|
212
|
-
# @
|
242
|
+
# @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
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
213
244
|
def delete_score_from_collection_with_http_info(collection, score, opts = {})
|
214
245
|
if @api_client.config.debugging
|
215
|
-
@api_client.config.logger.debug
|
246
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.delete_score_from_collection ...'
|
216
247
|
end
|
217
248
|
# verify the required parameter 'collection' is set
|
218
249
|
if @api_client.config.client_side_validation && collection.nil?
|
@@ -223,30 +254,40 @@ module FlatApi
|
|
223
254
|
fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.delete_score_from_collection"
|
224
255
|
end
|
225
256
|
# resource path
|
226
|
-
local_var_path =
|
257
|
+
local_var_path = '/collections/{collection}/scores/{score}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s)).sub('{' + 'score' + '}', CGI.escape(score.to_s))
|
227
258
|
|
228
259
|
# query parameters
|
229
|
-
query_params = {}
|
260
|
+
query_params = opts[:query_params] || {}
|
261
|
+
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
230
262
|
|
231
263
|
# header parameters
|
232
|
-
header_params = {}
|
264
|
+
header_params = opts[:header_params] || {}
|
233
265
|
# HTTP header 'Accept' (if needed)
|
234
266
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
235
|
-
# HTTP header 'Content-Type'
|
236
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
237
267
|
|
238
268
|
# form parameters
|
239
|
-
form_params = {}
|
269
|
+
form_params = opts[:form_params] || {}
|
240
270
|
|
241
271
|
# http body (model)
|
242
|
-
post_body =
|
243
|
-
|
244
|
-
|
272
|
+
post_body = opts[:debug_body]
|
273
|
+
|
274
|
+
# return_type
|
275
|
+
return_type = opts[:debug_return_type]
|
276
|
+
|
277
|
+
# auth_names
|
278
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
279
|
+
|
280
|
+
new_options = opts.merge(
|
281
|
+
:operation => :"CollectionApi.delete_score_from_collection",
|
245
282
|
:header_params => header_params,
|
246
283
|
:query_params => query_params,
|
247
284
|
:form_params => form_params,
|
248
285
|
:body => post_body,
|
249
|
-
:auth_names => auth_names
|
286
|
+
:auth_names => auth_names,
|
287
|
+
:return_type => return_type
|
288
|
+
)
|
289
|
+
|
290
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
250
291
|
if @api_client.config.debugging
|
251
292
|
@api_client.config.logger.debug "API called: CollectionApi#delete_score_from_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
252
293
|
end
|
@@ -254,56 +295,71 @@ module FlatApi
|
|
254
295
|
end
|
255
296
|
|
256
297
|
# Update a collection's metadata
|
257
|
-
#
|
258
|
-
# @param
|
298
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
299
|
+
# @param body [CollectionModification]
|
259
300
|
# @param [Hash] opts the optional parameters
|
260
|
-
# @option opts [CollectionModification] :body
|
261
301
|
# @return [Collection]
|
262
|
-
def edit_collection(collection, opts = {})
|
263
|
-
data, _status_code, _headers = edit_collection_with_http_info(collection, opts)
|
264
|
-
|
302
|
+
def edit_collection(collection, body, opts = {})
|
303
|
+
data, _status_code, _headers = edit_collection_with_http_info(collection, body, opts)
|
304
|
+
data
|
265
305
|
end
|
266
306
|
|
267
307
|
# Update a collection's metadata
|
268
|
-
#
|
269
|
-
# @param
|
308
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
309
|
+
# @param body [CollectionModification]
|
270
310
|
# @param [Hash] opts the optional parameters
|
271
|
-
# @
|
272
|
-
|
273
|
-
def edit_collection_with_http_info(collection, opts = {})
|
311
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
312
|
+
def edit_collection_with_http_info(collection, body, opts = {})
|
274
313
|
if @api_client.config.debugging
|
275
|
-
@api_client.config.logger.debug
|
314
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.edit_collection ...'
|
276
315
|
end
|
277
316
|
# verify the required parameter 'collection' is set
|
278
317
|
if @api_client.config.client_side_validation && collection.nil?
|
279
318
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.edit_collection"
|
280
319
|
end
|
320
|
+
# verify the required parameter 'body' is set
|
321
|
+
if @api_client.config.client_side_validation && body.nil?
|
322
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.edit_collection"
|
323
|
+
end
|
281
324
|
# resource path
|
282
|
-
local_var_path =
|
325
|
+
local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
|
283
326
|
|
284
327
|
# query parameters
|
285
|
-
query_params = {}
|
328
|
+
query_params = opts[:query_params] || {}
|
286
329
|
|
287
330
|
# header parameters
|
288
|
-
header_params = {}
|
331
|
+
header_params = opts[:header_params] || {}
|
289
332
|
# HTTP header 'Accept' (if needed)
|
290
333
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
291
334
|
# HTTP header 'Content-Type'
|
292
|
-
|
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
|
293
339
|
|
294
340
|
# form parameters
|
295
|
-
form_params = {}
|
341
|
+
form_params = opts[:form_params] || {}
|
296
342
|
|
297
343
|
# http body (model)
|
298
|
-
post_body = @api_client.object_to_http_body(
|
299
|
-
|
300
|
-
|
344
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
345
|
+
|
346
|
+
# return_type
|
347
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
348
|
+
|
349
|
+
# auth_names
|
350
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
351
|
+
|
352
|
+
new_options = opts.merge(
|
353
|
+
:operation => :"CollectionApi.edit_collection",
|
301
354
|
:header_params => header_params,
|
302
355
|
:query_params => query_params,
|
303
356
|
:form_params => form_params,
|
304
357
|
:body => post_body,
|
305
358
|
:auth_names => auth_names,
|
306
|
-
:return_type =>
|
359
|
+
:return_type => return_type
|
360
|
+
)
|
361
|
+
|
362
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
307
363
|
if @api_client.config.debugging
|
308
364
|
@api_client.config.logger.debug "API called: CollectionApi#edit_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
309
365
|
end
|
@@ -311,57 +367,63 @@ module FlatApi
|
|
311
367
|
end
|
312
368
|
|
313
369
|
# Get collection details
|
314
|
-
#
|
315
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
370
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
316
371
|
# @param [Hash] opts the optional parameters
|
317
372
|
# @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.
|
318
373
|
# @return [Collection]
|
319
374
|
def get_collection(collection, opts = {})
|
320
375
|
data, _status_code, _headers = get_collection_with_http_info(collection, opts)
|
321
|
-
|
376
|
+
data
|
322
377
|
end
|
323
378
|
|
324
379
|
# Get collection details
|
325
|
-
#
|
326
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
380
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
327
381
|
# @param [Hash] opts the optional parameters
|
328
382
|
# @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.
|
329
|
-
# @return [Array<(Collection,
|
383
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
330
384
|
def get_collection_with_http_info(collection, opts = {})
|
331
385
|
if @api_client.config.debugging
|
332
|
-
@api_client.config.logger.debug
|
386
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.get_collection ...'
|
333
387
|
end
|
334
388
|
# verify the required parameter 'collection' is set
|
335
389
|
if @api_client.config.client_side_validation && collection.nil?
|
336
390
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.get_collection"
|
337
391
|
end
|
338
392
|
# resource path
|
339
|
-
local_var_path =
|
393
|
+
local_var_path = '/collections/{collection}'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
|
340
394
|
|
341
395
|
# query parameters
|
342
|
-
query_params = {}
|
396
|
+
query_params = opts[:query_params] || {}
|
343
397
|
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
344
398
|
|
345
399
|
# header parameters
|
346
|
-
header_params = {}
|
400
|
+
header_params = opts[:header_params] || {}
|
347
401
|
# HTTP header 'Accept' (if needed)
|
348
402
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
|
-
# HTTP header 'Content-Type'
|
350
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
351
403
|
|
352
404
|
# form parameters
|
353
|
-
form_params = {}
|
405
|
+
form_params = opts[:form_params] || {}
|
354
406
|
|
355
407
|
# http body (model)
|
356
|
-
post_body =
|
357
|
-
|
358
|
-
|
408
|
+
post_body = opts[:debug_body]
|
409
|
+
|
410
|
+
# return_type
|
411
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
412
|
+
|
413
|
+
# auth_names
|
414
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
415
|
+
|
416
|
+
new_options = opts.merge(
|
417
|
+
:operation => :"CollectionApi.get_collection",
|
359
418
|
:header_params => header_params,
|
360
419
|
:query_params => query_params,
|
361
420
|
:form_params => form_params,
|
362
421
|
:body => post_body,
|
363
422
|
:auth_names => auth_names,
|
364
|
-
:return_type =>
|
423
|
+
:return_type => return_type
|
424
|
+
)
|
425
|
+
|
426
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
365
427
|
if @api_client.config.debugging
|
366
428
|
@api_client.config.logger.debug "API called: CollectionApi#get_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
367
429
|
end
|
@@ -369,8 +431,8 @@ module FlatApi
|
|
369
431
|
end
|
370
432
|
|
371
433
|
# List the scores contained in a collection
|
372
|
-
# Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`.
|
373
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
434
|
+
# 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. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
374
436
|
# @param [Hash] opts the optional parameters
|
375
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.
|
376
438
|
# @option opts [String] :sort Sort
|
@@ -381,33 +443,35 @@ module FlatApi
|
|
381
443
|
# @return [Array<ScoreDetails>]
|
382
444
|
def list_collection_scores(collection, opts = {})
|
383
445
|
data, _status_code, _headers = list_collection_scores_with_http_info(collection, opts)
|
384
|
-
|
446
|
+
data
|
385
447
|
end
|
386
448
|
|
387
449
|
# List the scores contained in a collection
|
388
|
-
# Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`.
|
389
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
450
|
+
# 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. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
390
452
|
# @param [Hash] opts the optional parameters
|
391
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.
|
392
454
|
# @option opts [String] :sort Sort
|
393
455
|
# @option opts [String] :direction Sort direction
|
394
|
-
# @option opts [Integer] :limit This is the maximum number of objects that may be returned
|
456
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
395
457
|
# @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.
|
396
458
|
# @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.
|
397
|
-
# @return [Array<(Array<ScoreDetails>,
|
459
|
+
# @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
398
460
|
def list_collection_scores_with_http_info(collection, opts = {})
|
399
461
|
if @api_client.config.debugging
|
400
|
-
@api_client.config.logger.debug
|
462
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.list_collection_scores ...'
|
401
463
|
end
|
402
464
|
# verify the required parameter 'collection' is set
|
403
465
|
if @api_client.config.client_side_validation && collection.nil?
|
404
466
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.list_collection_scores"
|
405
467
|
end
|
406
|
-
|
407
|
-
|
468
|
+
allowable_values = ["creationDate", "modificationDate", "title"]
|
469
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
470
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
408
471
|
end
|
409
|
-
|
410
|
-
|
472
|
+
allowable_values = ["asc", "desc"]
|
473
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
474
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
411
475
|
end
|
412
476
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
413
477
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collection_scores, must be smaller than or equal to 100.'
|
@@ -418,10 +482,10 @@ module FlatApi
|
|
418
482
|
end
|
419
483
|
|
420
484
|
# resource path
|
421
|
-
local_var_path =
|
485
|
+
local_var_path = '/collections/{collection}/scores'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
|
422
486
|
|
423
487
|
# query parameters
|
424
|
-
query_params = {}
|
488
|
+
query_params = opts[:query_params] || {}
|
425
489
|
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
426
490
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
427
491
|
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
@@ -430,25 +494,33 @@ module FlatApi
|
|
430
494
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
431
495
|
|
432
496
|
# header parameters
|
433
|
-
header_params = {}
|
497
|
+
header_params = opts[:header_params] || {}
|
434
498
|
# HTTP header 'Accept' (if needed)
|
435
499
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
436
|
-
# HTTP header 'Content-Type'
|
437
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
438
500
|
|
439
501
|
# form parameters
|
440
|
-
form_params = {}
|
502
|
+
form_params = opts[:form_params] || {}
|
441
503
|
|
442
504
|
# http body (model)
|
443
|
-
post_body =
|
444
|
-
|
445
|
-
|
505
|
+
post_body = opts[:debug_body]
|
506
|
+
|
507
|
+
# return_type
|
508
|
+
return_type = opts[:debug_return_type] || 'Array<ScoreDetails>'
|
509
|
+
|
510
|
+
# auth_names
|
511
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
512
|
+
|
513
|
+
new_options = opts.merge(
|
514
|
+
:operation => :"CollectionApi.list_collection_scores",
|
446
515
|
:header_params => header_params,
|
447
516
|
:query_params => query_params,
|
448
517
|
:form_params => form_params,
|
449
518
|
:body => post_body,
|
450
519
|
:auth_names => auth_names,
|
451
|
-
:return_type =>
|
520
|
+
:return_type => return_type
|
521
|
+
)
|
522
|
+
|
523
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
452
524
|
if @api_client.config.debugging
|
453
525
|
@api_client.config.logger.debug "API called: CollectionApi#list_collection_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
454
526
|
end
|
@@ -456,9 +528,9 @@ module FlatApi
|
|
456
528
|
end
|
457
529
|
|
458
530
|
# List the collections
|
459
|
-
# Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`. Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`.
|
531
|
+
# Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`. Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`. To fetch your app collection details, you can use `GET /v2/collections/app`.
|
460
532
|
# @param [Hash] opts the optional parameters
|
461
|
-
# @option opts [String] :parent List the collection contained in this `parent` collection. This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`. (default to root)
|
533
|
+
# @option opts [String] :parent List the collection contained in this `parent` collection. This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`. (default to 'root')
|
462
534
|
# @option opts [String] :sort Sort
|
463
535
|
# @option opts [String] :direction Sort direction
|
464
536
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
@@ -467,31 +539,30 @@ module FlatApi
|
|
467
539
|
# @return [Array<Collection>]
|
468
540
|
def list_collections(opts = {})
|
469
541
|
data, _status_code, _headers = list_collections_with_http_info(opts)
|
470
|
-
|
542
|
+
data
|
471
543
|
end
|
472
544
|
|
473
545
|
# List the collections
|
474
|
-
# Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`. Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`.
|
546
|
+
# Use this method to list the user's collections contained in `parent` (by default in the `root` collection). If no sort option is provided, the collections are sorted by `creationDate` `desc`. Note that this method will not include the `parent` collection in the listing. For example, if you need the details of the `root` collection, you can use `GET /v2/collections/root`. To fetch your app collection details, you can use `GET /v2/collections/app`.
|
475
547
|
# @param [Hash] opts the optional parameters
|
476
|
-
# @option opts [String] :parent List the collection contained in this `parent` collection. This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`.
|
548
|
+
# @option opts [String] :parent List the collection contained in this `parent` collection. This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`. (default to 'root')
|
477
549
|
# @option opts [String] :sort Sort
|
478
550
|
# @option opts [String] :direction Sort direction
|
479
|
-
# @option opts [Integer] :limit This is the maximum number of objects that may be returned
|
551
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
480
552
|
# @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.
|
481
553
|
# @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.
|
482
|
-
# @return [Array<(Array<Collection>,
|
554
|
+
# @return [Array<(Array<Collection>, Integer, Hash)>] Array<Collection> data, response status code and response headers
|
483
555
|
def list_collections_with_http_info(opts = {})
|
484
556
|
if @api_client.config.debugging
|
485
|
-
@api_client.config.logger.debug
|
557
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.list_collections ...'
|
486
558
|
end
|
487
|
-
|
488
|
-
|
559
|
+
allowable_values = ["creationDate", "title"]
|
560
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
561
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
489
562
|
end
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
if @api_client.config.client_side_validation && opts[:'direction'] && !['asc', 'desc'].include?(opts[:'direction'])
|
494
|
-
fail ArgumentError, 'invalid value for "direction", must be one of asc, desc'
|
563
|
+
allowable_values = ["asc", "desc"]
|
564
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
565
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
495
566
|
end
|
496
567
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
497
568
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collections, must be smaller than or equal to 100.'
|
@@ -502,10 +573,10 @@ module FlatApi
|
|
502
573
|
end
|
503
574
|
|
504
575
|
# resource path
|
505
|
-
local_var_path =
|
576
|
+
local_var_path = '/collections'
|
506
577
|
|
507
578
|
# query parameters
|
508
|
-
query_params = {}
|
579
|
+
query_params = opts[:query_params] || {}
|
509
580
|
query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
|
510
581
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
511
582
|
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
@@ -514,25 +585,33 @@ module FlatApi
|
|
514
585
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
515
586
|
|
516
587
|
# header parameters
|
517
|
-
header_params = {}
|
588
|
+
header_params = opts[:header_params] || {}
|
518
589
|
# HTTP header 'Accept' (if needed)
|
519
590
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
520
|
-
# HTTP header 'Content-Type'
|
521
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
522
591
|
|
523
592
|
# form parameters
|
524
|
-
form_params = {}
|
593
|
+
form_params = opts[:form_params] || {}
|
525
594
|
|
526
595
|
# http body (model)
|
527
|
-
post_body =
|
528
|
-
|
529
|
-
|
596
|
+
post_body = opts[:debug_body]
|
597
|
+
|
598
|
+
# return_type
|
599
|
+
return_type = opts[:debug_return_type] || 'Array<Collection>'
|
600
|
+
|
601
|
+
# auth_names
|
602
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
603
|
+
|
604
|
+
new_options = opts.merge(
|
605
|
+
:operation => :"CollectionApi.list_collections",
|
530
606
|
:header_params => header_params,
|
531
607
|
:query_params => query_params,
|
532
608
|
:form_params => form_params,
|
533
609
|
:body => post_body,
|
534
610
|
:auth_names => auth_names,
|
535
|
-
:return_type =>
|
611
|
+
:return_type => return_type
|
612
|
+
)
|
613
|
+
|
614
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
536
615
|
if @api_client.config.debugging
|
537
616
|
@api_client.config.logger.debug "API called: CollectionApi#list_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
538
617
|
end
|
@@ -541,52 +620,61 @@ module FlatApi
|
|
541
620
|
|
542
621
|
# Untrash a collection
|
543
622
|
# This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
544
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
623
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
545
624
|
# @param [Hash] opts the optional parameters
|
546
625
|
# @return [nil]
|
547
626
|
def untrash_collection(collection, opts = {})
|
548
627
|
untrash_collection_with_http_info(collection, opts)
|
549
|
-
|
628
|
+
nil
|
550
629
|
end
|
551
630
|
|
552
631
|
# Untrash a collection
|
553
632
|
# This method will restore the collection by removing it from the `trash` and add it back to the `root` collection.
|
554
|
-
# @param collection Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
633
|
+
# @param collection [String] Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
|
555
634
|
# @param [Hash] opts the optional parameters
|
556
|
-
# @return [Array<(nil,
|
635
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
557
636
|
def untrash_collection_with_http_info(collection, opts = {})
|
558
637
|
if @api_client.config.debugging
|
559
|
-
@api_client.config.logger.debug
|
638
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.untrash_collection ...'
|
560
639
|
end
|
561
640
|
# verify the required parameter 'collection' is set
|
562
641
|
if @api_client.config.client_side_validation && collection.nil?
|
563
642
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.untrash_collection"
|
564
643
|
end
|
565
644
|
# resource path
|
566
|
-
local_var_path =
|
645
|
+
local_var_path = '/collections/{collection}/untrash'.sub('{' + 'collection' + '}', CGI.escape(collection.to_s))
|
567
646
|
|
568
647
|
# query parameters
|
569
|
-
query_params = {}
|
648
|
+
query_params = opts[:query_params] || {}
|
570
649
|
|
571
650
|
# header parameters
|
572
|
-
header_params = {}
|
651
|
+
header_params = opts[:header_params] || {}
|
573
652
|
# HTTP header 'Accept' (if needed)
|
574
653
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
575
|
-
# HTTP header 'Content-Type'
|
576
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
577
654
|
|
578
655
|
# form parameters
|
579
|
-
form_params = {}
|
656
|
+
form_params = opts[:form_params] || {}
|
580
657
|
|
581
658
|
# http body (model)
|
582
|
-
post_body =
|
583
|
-
|
584
|
-
|
659
|
+
post_body = opts[:debug_body]
|
660
|
+
|
661
|
+
# return_type
|
662
|
+
return_type = opts[:debug_return_type]
|
663
|
+
|
664
|
+
# auth_names
|
665
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
666
|
+
|
667
|
+
new_options = opts.merge(
|
668
|
+
:operation => :"CollectionApi.untrash_collection",
|
585
669
|
:header_params => header_params,
|
586
670
|
:query_params => query_params,
|
587
671
|
:form_params => form_params,
|
588
672
|
:body => post_body,
|
589
|
-
:auth_names => auth_names
|
673
|
+
:auth_names => auth_names,
|
674
|
+
:return_type => return_type
|
675
|
+
)
|
676
|
+
|
677
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
590
678
|
if @api_client.config.debugging
|
591
679
|
@api_client.config.logger.debug "API called: CollectionApi#untrash_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
680
|
end
|