flat_api 0.2.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/CHANGELOG.md +60 -8
- data/LICENSE +201 -0
- data/README.md +62 -241
- data/lib/flat_api/api/account_api.rb +32 -22
- data/lib/flat_api/api/class_api.rb +1671 -453
- data/lib/flat_api/api/collection_api.rb +286 -185
- data/lib/flat_api/api/edu_resources_api.rb +863 -0
- data/lib/flat_api/api/group_api.rb +506 -57
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +808 -192
- data/lib/flat_api/api/score_api.rb +1030 -589
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +151 -82
- data/lib/flat_api/api_client.rb +223 -145
- data/lib/flat_api/api_error.rb +24 -4
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +224 -36
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +201 -0
- data/lib/flat_api/models/app_scopes.rb +61 -0
- data/lib/flat_api/models/assignment.rb +362 -166
- data/lib/flat_api/models/assignment_capabilities.rb +256 -0
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +193 -0
- data/lib/flat_api/models/assignment_copy.rb +79 -169
- data/lib/flat_api/models/assignment_copy_response.rb +535 -0
- data/lib/flat_api/models/assignment_copy_to_class.rb +186 -0
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +176 -0
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +337 -131
- data/lib/flat_api/models/assignment_submission_comment.rb +209 -0
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +166 -0
- data/lib/flat_api/models/assignment_submission_comments.rb +158 -0
- data/lib/flat_api/models/assignment_submission_history.rb +337 -0
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +168 -0
- data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
- data/lib/flat_api/models/assignment_submission_lti.rb +200 -0
- data/lib/flat_api/models/assignment_submission_playback.rb +193 -0
- data/lib/flat_api/models/assignment_submission_state.rb +42 -0
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +157 -113
- data/lib/flat_api/models/assignment_type.rb +45 -0
- data/lib/flat_api/models/assignment_update.rb +538 -0
- data/lib/flat_api/models/class_assignment.rb +750 -0
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +159 -0
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +149 -0
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +159 -0
- data/lib/flat_api/models/class_assignment_update.rb +652 -0
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +150 -0
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +152 -0
- data/lib/flat_api/models/class_attachment_creation.rb +140 -106
- data/lib/flat_api/models/class_creation.rb +142 -108
- data/lib/flat_api/models/class_details.rb +244 -125
- data/lib/flat_api/models/class_details_canvas.rb +59 -99
- data/lib/flat_api/models/class_details_clever.rb +74 -113
- data/lib/flat_api/models/class_details_google_classroom.rb +64 -124
- data/lib/flat_api/models/class_details_google_drive.rb +61 -101
- data/lib/flat_api/models/class_details_issues.rb +151 -0
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +203 -0
- data/lib/flat_api/models/class_details_lti.rb +76 -106
- data/lib/flat_api/models/class_details_mfc.rb +159 -0
- data/lib/flat_api/models/class_details_microsoft_graph.rb +148 -0
- data/lib/flat_api/models/class_grade_level.rb +43 -0
- data/lib/flat_api/models/class_roles.rb +18 -9
- data/lib/flat_api/models/class_state.rb +19 -9
- data/lib/flat_api/models/class_update.rb +142 -107
- data/lib/flat_api/models/collection.rb +304 -115
- data/lib/flat_api/models/collection_app.rb +169 -0
- data/lib/flat_api/models/collection_capabilities.rb +157 -112
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +120 -104
- data/lib/flat_api/models/collection_modification.rb +122 -100
- data/lib/flat_api/models/collection_privacy.rb +18 -9
- data/lib/flat_api/models/collection_type.rb +22 -11
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +273 -0
- data/lib/flat_api/models/edu_resource.rb +383 -0
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +179 -0
- data/lib/flat_api/models/edu_resource_copy.rb +166 -0
- data/lib/flat_api/models/edu_resource_creation.rb +311 -0
- data/lib/flat_api/models/edu_resource_folder.rb +171 -0
- data/lib/flat_api/models/edu_resource_lti_link.rb +166 -0
- data/lib/flat_api/models/edu_resource_move.rb +166 -0
- data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
- data/lib/flat_api/models/edu_resource_resource.rb +104 -0
- data/lib/flat_api/models/edu_resource_type.rb +40 -0
- data/lib/flat_api/models/edu_resource_update.rb +292 -0
- data/lib/flat_api/models/edu_resource_use_in_class.rb +176 -0
- data/lib/flat_api/models/flat_error_response.rb +109 -105
- data/lib/flat_api/models/google_classroom_coursework.rb +74 -103
- data/lib/flat_api/models/google_classroom_submission.rb +112 -101
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +70 -122
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +253 -110
- data/lib/flat_api/models/group_type.rb +20 -9
- data/lib/flat_api/models/license_mode.rb +18 -9
- data/lib/flat_api/models/license_sources.rb +21 -9
- data/lib/flat_api/models/lms_name.rb +19 -9
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +108 -114
- data/lib/flat_api/models/lti_credentials_creation.rb +99 -103
- data/lib/flat_api/models/media_attachment.rb +189 -137
- data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
- data/lib/flat_api/models/microsoft_graph_assignment.rb +259 -0
- data/lib/flat_api/models/microsoft_graph_submission.rb +193 -0
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +177 -109
- data/lib/flat_api/models/organization_invitation_creation.rb +97 -100
- data/lib/flat_api/models/organization_roles.rb +19 -10
- data/lib/flat_api/models/organization_user_access_token_creation.rb +168 -0
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +204 -116
- data/lib/flat_api/models/resource_collaborator_creation.rb +72 -112
- data/lib/flat_api/models/resource_rights.rb +168 -107
- data/lib/flat_api/models/score_comment.rb +200 -121
- data/lib/flat_api/models/score_comment_context.rb +161 -124
- data/lib/flat_api/models/score_comment_creation.rb +79 -107
- data/lib/flat_api/models/score_comment_moderation.rb +193 -0
- data/lib/flat_api/models/score_comment_update.rb +81 -115
- data/lib/flat_api/models/score_comments_counts.rb +78 -108
- data/lib/flat_api/models/score_creation.rb +80 -225
- data/lib/flat_api/models/score_creation_builder_data.rb +234 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +173 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +255 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +217 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +222 -0
- data/lib/flat_api/models/score_creation_common.rb +201 -0
- data/lib/flat_api/models/score_creation_file_import.rb +277 -0
- data/lib/flat_api/models/score_creation_google_drive_import.rb +234 -0
- data/lib/flat_api/models/score_creation_type.rb +18 -9
- data/lib/flat_api/models/score_details.rb +428 -146
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +84 -101
- data/lib/flat_api/models/score_license.rb +18 -9
- data/lib/flat_api/models/score_likes_counts.rb +73 -103
- data/lib/flat_api/models/score_modification.rb +178 -115
- data/lib/flat_api/models/score_plays_counts.rb +179 -0
- data/lib/flat_api/models/score_privacy.rb +18 -9
- data/lib/flat_api/models/score_revision.rb +142 -111
- data/lib/flat_api/models/score_revision_creation.rb +113 -105
- data/lib/flat_api/models/score_revision_statistics.rb +81 -101
- data/lib/flat_api/models/score_source.rb +59 -100
- data/lib/flat_api/models/score_summary.rb +172 -105
- data/lib/flat_api/models/score_track.rb +244 -117
- data/lib/flat_api/models/score_track_creation.rb +99 -104
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +78 -103
- data/lib/flat_api/models/score_track_purpose.rb +40 -0
- data/lib/flat_api/models/score_track_state.rb +18 -9
- data/lib/flat_api/models/score_track_type.rb +18 -9
- data/lib/flat_api/models/score_track_update.rb +98 -103
- data/lib/flat_api/models/score_views_counts.rb +73 -103
- data/lib/flat_api/models/task.rb +339 -0
- data/lib/flat_api/models/task_export_options.rb +151 -0
- data/lib/flat_api/models/task_progress.rb +159 -0
- data/lib/flat_api/models/task_result.rb +159 -0
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +42 -0
- data/lib/flat_api/models/user_admin_update.rb +206 -106
- data/lib/flat_api/models/user_azure_details.rb +168 -0
- data/lib/flat_api/models/user_basics.rb +215 -120
- data/lib/flat_api/models/user_community_profile_links.rb +205 -0
- data/lib/flat_api/models/user_creation.rb +203 -114
- data/lib/flat_api/models/user_details.rb +331 -161
- data/lib/flat_api/models/user_details_admin.rb +272 -133
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +211 -0
- data/lib/flat_api/models/user_public.rb +303 -145
- data/lib/flat_api/models/user_public_summary.rb +243 -126
- data/lib/flat_api/models/user_signin_link.rb +168 -0
- data/lib/flat_api/models/user_signin_link_creation.rb +150 -0
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +5 -5
- data/lib/flat_api.rb +144 -16
- metadata +154 -434
- data/Gemfile +0 -7
- data/Rakefile +0 -8
- data/docs/AccountApi.md +0 -55
- data/docs/Assignment.md +0 -18
- data/docs/AssignmentCopy.md +0 -8
- data/docs/AssignmentCreation.md +0 -12
- data/docs/AssignmentSubmission.md +0 -19
- data/docs/AssignmentSubmissionUpdate.md +0 -11
- data/docs/ClassApi.md +0 -1051
- data/docs/ClassAttachmentCreation.md +0 -10
- data/docs/ClassCreation.md +0 -9
- data/docs/ClassDetails.md +0 -25
- data/docs/ClassDetailsCanvas.md +0 -9
- data/docs/ClassDetailsClever.md +0 -14
- data/docs/ClassDetailsGoogleClassroom.md +0 -11
- data/docs/ClassDetailsGoogleDrive.md +0 -9
- data/docs/ClassDetailsLti.md +0 -10
- data/docs/ClassRoles.md +0 -7
- data/docs/ClassState.md +0 -7
- data/docs/ClassUpdate.md +0 -9
- data/docs/Collection.md +0 -18
- data/docs/CollectionApi.md +0 -521
- data/docs/CollectionCapabilities.md +0 -12
- data/docs/CollectionCreation.md +0 -8
- data/docs/CollectionModification.md +0 -8
- data/docs/CollectionPrivacy.md +0 -7
- data/docs/CollectionTitle.md +0 -7
- data/docs/CollectionType.md +0 -7
- data/docs/FlatErrorResponse.md +0 -11
- data/docs/FlatLocales.md +0 -7
- data/docs/GoogleClassroomCoursework.md +0 -10
- data/docs/GoogleClassroomSubmission.md +0 -10
- data/docs/Group.md +0 -14
- data/docs/GroupApi.md +0 -167
- data/docs/GroupDetails.md +0 -14
- data/docs/GroupType.md +0 -7
- data/docs/LicenseMode.md +0 -7
- data/docs/LicenseSources.md +0 -7
- data/docs/LmsName.md +0 -7
- data/docs/LtiCredentials.md +0 -16
- data/docs/LtiCredentialsCreation.md +0 -9
- data/docs/MediaAttachment.md +0 -23
- data/docs/MediaScoreSharingMode.md +0 -7
- data/docs/OrganizationApi.md +0 -538
- data/docs/OrganizationInvitation.md +0 -14
- data/docs/OrganizationInvitationCreation.md +0 -9
- data/docs/OrganizationRoles.md +0 -7
- data/docs/ResourceCollaborator.md +0 -16
- data/docs/ResourceCollaboratorCreation.md +0 -14
- data/docs/ResourceRights.md +0 -10
- data/docs/ResourceSharingKey.md +0 -7
- data/docs/ScoreApi.md +0 -1658
- data/docs/ScoreComment.md +0 -22
- data/docs/ScoreCommentContext.md +0 -14
- data/docs/ScoreCommentCreation.md +0 -13
- data/docs/ScoreCommentUpdate.md +0 -11
- data/docs/ScoreCommentsCounts.md +0 -11
- data/docs/ScoreCreation.md +0 -14
- data/docs/ScoreCreationType.md +0 -7
- data/docs/ScoreData.md +0 -7
- data/docs/ScoreDataEncoding.md +0 -7
- data/docs/ScoreDetails.md +0 -36
- data/docs/ScoreFork.md +0 -8
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -14
- data/docs/ScorePrivacy.md +0 -7
- data/docs/ScoreRevision.md +0 -14
- data/docs/ScoreRevisionCreation.md +0 -11
- data/docs/ScoreRevisionStatistics.md +0 -9
- data/docs/ScoreSource.md +0 -8
- data/docs/ScoreSummary.md +0 -13
- data/docs/ScoreTrack.md +0 -19
- data/docs/ScoreTrackCreation.md +0 -12
- data/docs/ScoreTrackPoint.md +0 -10
- data/docs/ScoreTrackState.md +0 -7
- data/docs/ScoreTrackType.md +0 -7
- data/docs/ScoreTrackUpdate.md +0 -11
- data/docs/ScoreViewsCounts.md +0 -10
- data/docs/UserAdminUpdate.md +0 -9
- data/docs/UserApi.md +0 -173
- data/docs/UserBasics.md +0 -13
- data/docs/UserCreation.md +0 -11
- data/docs/UserDetails.md +0 -28
- data/docs/UserDetailsAdmin.md +0 -20
- data/docs/UserDetailsAdminLicense.md +0 -12
- data/docs/UserInstruments.md +0 -7
- data/docs/UserPublic.md +0 -25
- data/docs/UserPublicSummary.md +0 -17
- data/flat_api.gemspec +0 -48
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/collection_title.rb +0 -179
- data/lib/flat_api/models/flat_locales.rb +0 -36
- data/lib/flat_api/models/resource_sharing_key.rb +0 -179
- data/lib/flat_api/models/score_data.rb +0 -179
- data/lib/flat_api/models/score_data_encoding.rb +0 -30
- data/lib/flat_api/models/user_details_admin_license.rb +0 -227
- data/lib/flat_api/models/user_instruments.rb +0 -179
- data/spec/api/account_api_spec.rb +0 -46
- data/spec/api/class_api_spec.rb +0 -278
- data/spec/api/collection_api_spec.rb +0 -159
- data/spec/api/group_api_spec.rb +0 -72
- data/spec/api/organization_api_spec.rb +0 -162
- data/spec/api/score_api_spec.rb +0 -426
- data/spec/api/user_api_spec.rb +0 -73
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_copy_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/assignment_spec.rb +0 -106
- data/spec/models/assignment_submission_spec.rb +0 -108
- data/spec/models/assignment_submission_update_spec.rb +0 -60
- data/spec/models/class_attachment_creation_spec.rb +0 -58
- data/spec/models/class_creation_spec.rb +0 -48
- data/spec/models/class_details_canvas_spec.rb +0 -48
- data/spec/models/class_details_clever_spec.rb +0 -82
- data/spec/models/class_details_google_classroom_spec.rb +0 -60
- data/spec/models/class_details_google_drive_spec.rb +0 -48
- data/spec/models/class_details_lti_spec.rb +0 -54
- data/spec/models/class_details_spec.rb +0 -144
- data/spec/models/class_roles_spec.rb +0 -36
- data/spec/models/class_state_spec.rb +0 -36
- data/spec/models/class_update_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -66
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -36
- data/spec/models/collection_spec.rb +0 -102
- data/spec/models/collection_title_spec.rb +0 -36
- data/spec/models/collection_type_spec.rb +0 -36
- data/spec/models/flat_error_response_spec.rb +0 -60
- data/spec/models/flat_locales_spec.rb +0 -36
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -54
- data/spec/models/group_details_spec.rb +0 -78
- data/spec/models/group_spec.rb +0 -82
- data/spec/models/group_type_spec.rb +0 -36
- data/spec/models/license_mode_spec.rb +0 -36
- data/spec/models/license_sources_spec.rb +0 -36
- data/spec/models/lms_name_spec.rb +0 -36
- data/spec/models/lti_credentials_creation_spec.rb +0 -48
- data/spec/models/lti_credentials_spec.rb +0 -90
- data/spec/models/media_attachment_spec.rb +0 -136
- data/spec/models/media_score_sharing_mode_spec.rb +0 -36
- data/spec/models/organization_invitation_creation_spec.rb +0 -48
- data/spec/models/organization_invitation_spec.rb +0 -78
- data/spec/models/organization_roles_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -78
- data/spec/models/resource_collaborator_spec.rb +0 -90
- data/spec/models/resource_rights_spec.rb +0 -54
- data/spec/models/resource_sharing_key_spec.rb +0 -36
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -72
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -60
- data/spec/models/score_comments_counts_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -78
- data/spec/models/score_creation_type_spec.rb +0 -36
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/score_details_spec.rb +0 -210
- data/spec/models/score_fork_spec.rb +0 -42
- data/spec/models/score_license_spec.rb +0 -36
- data/spec/models/score_likes_counts_spec.rb +0 -54
- data/spec/models/score_modification_spec.rb +0 -78
- data/spec/models/score_privacy_spec.rb +0 -36
- data/spec/models/score_revision_creation_spec.rb +0 -60
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -48
- data/spec/models/score_source_spec.rb +0 -42
- data/spec/models/score_summary_spec.rb +0 -72
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -58
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -36
- data/spec/models/score_track_type_spec.rb +0 -36
- data/spec/models/score_track_update_spec.rb +0 -60
- data/spec/models/score_views_counts_spec.rb +0 -54
- data/spec/models/user_admin_update_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -72
- data/spec/models/user_creation_spec.rb +0 -60
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_details_admin_spec.rb +0 -114
- data/spec/models/user_details_spec.rb +0 -166
- data/spec/models/user_instruments_spec.rb +0 -36
- data/spec/models/user_public_spec.rb +0 -144
- data/spec/models/user_public_summary_spec.rb +0 -96
- data/spec/spec_helper.rb +0 -111
|
@@ -1,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, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
|
-
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.
|
|
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 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
|
+
# @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.
|
|
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 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
|
+
# @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,45 @@ 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
|
-
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']
|
|
65
64
|
# HTTP header 'Content-Type'
|
|
66
|
-
|
|
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
|
|
67
69
|
|
|
68
70
|
# form parameters
|
|
69
|
-
form_params = {}
|
|
71
|
+
form_params = opts[:form_params] || {}
|
|
70
72
|
|
|
71
73
|
# http body (model)
|
|
72
|
-
post_body =
|
|
73
|
-
|
|
74
|
-
|
|
74
|
+
post_body = opts[:debug_body]
|
|
75
|
+
|
|
76
|
+
# return_type
|
|
77
|
+
return_type = opts[:debug_return_type] || 'ScoreDetails'
|
|
78
|
+
|
|
79
|
+
# auth_names
|
|
80
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
81
|
+
|
|
82
|
+
new_options = opts.merge(
|
|
83
|
+
:operation => :"CollectionApi.add_score_to_collection",
|
|
75
84
|
:header_params => header_params,
|
|
76
85
|
:query_params => query_params,
|
|
77
86
|
:form_params => form_params,
|
|
78
87
|
:body => post_body,
|
|
79
88
|
:auth_names => auth_names,
|
|
80
|
-
:return_type =>
|
|
89
|
+
:return_type => return_type
|
|
90
|
+
)
|
|
91
|
+
|
|
92
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
81
93
|
if @api_client.config.debugging
|
|
82
94
|
@api_client.config.logger.debug "API called: CollectionApi#add_score_to_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
83
95
|
end
|
|
@@ -85,54 +97,67 @@ module FlatApi
|
|
|
85
97
|
end
|
|
86
98
|
|
|
87
99
|
# Create a new collection
|
|
88
|
-
# This method will create a new collection
|
|
89
|
-
# @param body
|
|
100
|
+
# This method will create a new collection in your account.
|
|
101
|
+
# @param body [CollectionCreation]
|
|
90
102
|
# @param [Hash] opts the optional parameters
|
|
91
103
|
# @return [Collection]
|
|
92
104
|
def create_collection(body, opts = {})
|
|
93
105
|
data, _status_code, _headers = create_collection_with_http_info(body, opts)
|
|
94
|
-
|
|
106
|
+
data
|
|
95
107
|
end
|
|
96
108
|
|
|
97
109
|
# Create a new collection
|
|
98
|
-
# This method will create a new collection
|
|
99
|
-
# @param body
|
|
110
|
+
# This method will create a new collection in your account.
|
|
111
|
+
# @param body [CollectionCreation]
|
|
100
112
|
# @param [Hash] opts the optional parameters
|
|
101
|
-
# @return [Array<(Collection,
|
|
113
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
102
114
|
def create_collection_with_http_info(body, opts = {})
|
|
103
115
|
if @api_client.config.debugging
|
|
104
|
-
@api_client.config.logger.debug
|
|
116
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.create_collection ...'
|
|
105
117
|
end
|
|
106
118
|
# verify the required parameter 'body' is set
|
|
107
119
|
if @api_client.config.client_side_validation && body.nil?
|
|
108
120
|
fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.create_collection"
|
|
109
121
|
end
|
|
110
122
|
# resource path
|
|
111
|
-
local_var_path =
|
|
123
|
+
local_var_path = '/collections'
|
|
112
124
|
|
|
113
125
|
# query parameters
|
|
114
|
-
query_params = {}
|
|
126
|
+
query_params = opts[:query_params] || {}
|
|
115
127
|
|
|
116
128
|
# header parameters
|
|
117
|
-
header_params = {}
|
|
129
|
+
header_params = opts[:header_params] || {}
|
|
118
130
|
# HTTP header 'Accept' (if needed)
|
|
119
|
-
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']
|
|
120
132
|
# HTTP header 'Content-Type'
|
|
121
|
-
|
|
133
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
134
|
+
if !content_type.nil?
|
|
135
|
+
header_params['Content-Type'] = content_type
|
|
136
|
+
end
|
|
122
137
|
|
|
123
138
|
# form parameters
|
|
124
|
-
form_params = {}
|
|
139
|
+
form_params = opts[:form_params] || {}
|
|
125
140
|
|
|
126
141
|
# http body (model)
|
|
127
|
-
post_body = @api_client.object_to_http_body(body)
|
|
128
|
-
|
|
129
|
-
|
|
142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
143
|
+
|
|
144
|
+
# return_type
|
|
145
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
|
146
|
+
|
|
147
|
+
# auth_names
|
|
148
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
149
|
+
|
|
150
|
+
new_options = opts.merge(
|
|
151
|
+
:operation => :"CollectionApi.create_collection",
|
|
130
152
|
:header_params => header_params,
|
|
131
153
|
:query_params => query_params,
|
|
132
154
|
:form_params => form_params,
|
|
133
155
|
:body => post_body,
|
|
134
156
|
:auth_names => auth_names,
|
|
135
|
-
:return_type =>
|
|
157
|
+
:return_type => return_type
|
|
158
|
+
)
|
|
159
|
+
|
|
160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
136
161
|
if @api_client.config.debugging
|
|
137
162
|
@api_client.config.logger.debug "API called: CollectionApi#create_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
138
163
|
end
|
|
@@ -141,52 +166,61 @@ module FlatApi
|
|
|
141
166
|
|
|
142
167
|
# Delete the collection
|
|
143
168
|
# 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.
|
|
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
|
|
145
170
|
# @param [Hash] opts the optional parameters
|
|
146
171
|
# @return [nil]
|
|
147
172
|
def delete_collection(collection, opts = {})
|
|
148
173
|
delete_collection_with_http_info(collection, opts)
|
|
149
|
-
|
|
174
|
+
nil
|
|
150
175
|
end
|
|
151
176
|
|
|
152
177
|
# Delete the collection
|
|
153
178
|
# 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.
|
|
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
|
|
155
180
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @return [Array<(nil,
|
|
181
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
157
182
|
def delete_collection_with_http_info(collection, opts = {})
|
|
158
183
|
if @api_client.config.debugging
|
|
159
|
-
@api_client.config.logger.debug
|
|
184
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.delete_collection ...'
|
|
160
185
|
end
|
|
161
186
|
# verify the required parameter 'collection' is set
|
|
162
187
|
if @api_client.config.client_side_validation && collection.nil?
|
|
163
188
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_collection"
|
|
164
189
|
end
|
|
165
190
|
# resource path
|
|
166
|
-
local_var_path =
|
|
191
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
167
192
|
|
|
168
193
|
# query parameters
|
|
169
|
-
query_params = {}
|
|
194
|
+
query_params = opts[:query_params] || {}
|
|
170
195
|
|
|
171
196
|
# header parameters
|
|
172
|
-
header_params = {}
|
|
197
|
+
header_params = opts[:header_params] || {}
|
|
173
198
|
# HTTP header 'Accept' (if needed)
|
|
174
|
-
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'])
|
|
199
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
177
200
|
|
|
178
201
|
# form parameters
|
|
179
|
-
form_params = {}
|
|
202
|
+
form_params = opts[:form_params] || {}
|
|
180
203
|
|
|
181
204
|
# http body (model)
|
|
182
|
-
post_body =
|
|
183
|
-
|
|
184
|
-
|
|
205
|
+
post_body = opts[:debug_body]
|
|
206
|
+
|
|
207
|
+
# return_type
|
|
208
|
+
return_type = opts[:debug_return_type]
|
|
209
|
+
|
|
210
|
+
# auth_names
|
|
211
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
212
|
+
|
|
213
|
+
new_options = opts.merge(
|
|
214
|
+
:operation => :"CollectionApi.delete_collection",
|
|
185
215
|
:header_params => header_params,
|
|
186
216
|
:query_params => query_params,
|
|
187
217
|
:form_params => form_params,
|
|
188
218
|
:body => post_body,
|
|
189
|
-
:auth_names => auth_names
|
|
219
|
+
:auth_names => auth_names,
|
|
220
|
+
:return_type => return_type
|
|
221
|
+
)
|
|
222
|
+
|
|
223
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
190
224
|
if @api_client.config.debugging
|
|
191
225
|
@api_client.config.logger.debug "API called: CollectionApi#delete_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
192
226
|
end
|
|
@@ -195,24 +229,28 @@ module FlatApi
|
|
|
195
229
|
|
|
196
230
|
# Delete a score from the collection
|
|
197
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.
|
|
198
|
-
# @param collection Unique identifier of the collection.
|
|
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`).
|
|
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
|
|
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`).
|
|
200
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\"}`
|
|
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.
|
|
201
237
|
# @return [nil]
|
|
202
238
|
def delete_score_from_collection(collection, score, opts = {})
|
|
203
239
|
delete_score_from_collection_with_http_info(collection, score, opts)
|
|
204
|
-
|
|
240
|
+
nil
|
|
205
241
|
end
|
|
206
242
|
|
|
207
243
|
# Delete a score from the collection
|
|
208
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.
|
|
209
|
-
# @param collection Unique identifier of the collection.
|
|
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`).
|
|
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
|
|
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`).
|
|
211
247
|
# @param [Hash] opts the optional parameters
|
|
212
|
-
# @
|
|
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\"}`
|
|
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.
|
|
250
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
213
251
|
def delete_score_from_collection_with_http_info(collection, score, opts = {})
|
|
214
252
|
if @api_client.config.debugging
|
|
215
|
-
@api_client.config.logger.debug
|
|
253
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.delete_score_from_collection ...'
|
|
216
254
|
end
|
|
217
255
|
# verify the required parameter 'collection' is set
|
|
218
256
|
if @api_client.config.client_side_validation && collection.nil?
|
|
@@ -223,30 +261,46 @@ module FlatApi
|
|
|
223
261
|
fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.delete_score_from_collection"
|
|
224
262
|
end
|
|
225
263
|
# resource path
|
|
226
|
-
local_var_path =
|
|
264
|
+
local_var_path = '/collections/{collection}/scores/{score}'.sub('{collection}', CGI.escape(collection.to_s)).sub('{score}', CGI.escape(score.to_s))
|
|
227
265
|
|
|
228
266
|
# query parameters
|
|
229
|
-
query_params = {}
|
|
267
|
+
query_params = opts[:query_params] || {}
|
|
268
|
+
query_params[:'eventProperties'] = opts[:'event_properties'] if !opts[:'event_properties'].nil?
|
|
269
|
+
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
230
270
|
|
|
231
271
|
# header parameters
|
|
232
|
-
header_params = {}
|
|
272
|
+
header_params = opts[:header_params] || {}
|
|
233
273
|
# HTTP header 'Accept' (if needed)
|
|
234
|
-
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']
|
|
235
275
|
# HTTP header 'Content-Type'
|
|
236
|
-
|
|
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
|
|
237
280
|
|
|
238
281
|
# form parameters
|
|
239
|
-
form_params = {}
|
|
282
|
+
form_params = opts[:form_params] || {}
|
|
240
283
|
|
|
241
284
|
# http body (model)
|
|
242
|
-
post_body =
|
|
243
|
-
|
|
244
|
-
|
|
285
|
+
post_body = opts[:debug_body]
|
|
286
|
+
|
|
287
|
+
# return_type
|
|
288
|
+
return_type = opts[:debug_return_type]
|
|
289
|
+
|
|
290
|
+
# auth_names
|
|
291
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
292
|
+
|
|
293
|
+
new_options = opts.merge(
|
|
294
|
+
:operation => :"CollectionApi.delete_score_from_collection",
|
|
245
295
|
:header_params => header_params,
|
|
246
296
|
:query_params => query_params,
|
|
247
297
|
:form_params => form_params,
|
|
248
298
|
:body => post_body,
|
|
249
|
-
:auth_names => auth_names
|
|
299
|
+
:auth_names => auth_names,
|
|
300
|
+
:return_type => return_type
|
|
301
|
+
)
|
|
302
|
+
|
|
303
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
250
304
|
if @api_client.config.debugging
|
|
251
305
|
@api_client.config.logger.debug "API called: CollectionApi#delete_score_from_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
252
306
|
end
|
|
@@ -254,56 +308,71 @@ module FlatApi
|
|
|
254
308
|
end
|
|
255
309
|
|
|
256
310
|
# Update a collection's metadata
|
|
257
|
-
#
|
|
258
|
-
# @param
|
|
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
|
|
312
|
+
# @param body [CollectionModification]
|
|
259
313
|
# @param [Hash] opts the optional parameters
|
|
260
|
-
# @option opts [CollectionModification] :body
|
|
261
314
|
# @return [Collection]
|
|
262
|
-
def edit_collection(collection, opts = {})
|
|
263
|
-
data, _status_code, _headers = edit_collection_with_http_info(collection, opts)
|
|
264
|
-
|
|
315
|
+
def edit_collection(collection, body, opts = {})
|
|
316
|
+
data, _status_code, _headers = edit_collection_with_http_info(collection, body, opts)
|
|
317
|
+
data
|
|
265
318
|
end
|
|
266
319
|
|
|
267
320
|
# Update a collection's metadata
|
|
268
|
-
#
|
|
269
|
-
# @param
|
|
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
|
|
322
|
+
# @param body [CollectionModification]
|
|
270
323
|
# @param [Hash] opts the optional parameters
|
|
271
|
-
# @
|
|
272
|
-
|
|
273
|
-
def edit_collection_with_http_info(collection, opts = {})
|
|
324
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
325
|
+
def edit_collection_with_http_info(collection, body, opts = {})
|
|
274
326
|
if @api_client.config.debugging
|
|
275
|
-
@api_client.config.logger.debug
|
|
327
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.edit_collection ...'
|
|
276
328
|
end
|
|
277
329
|
# verify the required parameter 'collection' is set
|
|
278
330
|
if @api_client.config.client_side_validation && collection.nil?
|
|
279
331
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.edit_collection"
|
|
280
332
|
end
|
|
333
|
+
# verify the required parameter 'body' is set
|
|
334
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
335
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.edit_collection"
|
|
336
|
+
end
|
|
281
337
|
# resource path
|
|
282
|
-
local_var_path =
|
|
338
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
283
339
|
|
|
284
340
|
# query parameters
|
|
285
|
-
query_params = {}
|
|
341
|
+
query_params = opts[:query_params] || {}
|
|
286
342
|
|
|
287
343
|
# header parameters
|
|
288
|
-
header_params = {}
|
|
344
|
+
header_params = opts[:header_params] || {}
|
|
289
345
|
# HTTP header 'Accept' (if needed)
|
|
290
|
-
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']
|
|
291
347
|
# HTTP header 'Content-Type'
|
|
292
|
-
|
|
348
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
349
|
+
if !content_type.nil?
|
|
350
|
+
header_params['Content-Type'] = content_type
|
|
351
|
+
end
|
|
293
352
|
|
|
294
353
|
# form parameters
|
|
295
|
-
form_params = {}
|
|
354
|
+
form_params = opts[:form_params] || {}
|
|
296
355
|
|
|
297
356
|
# http body (model)
|
|
298
|
-
post_body = @api_client.object_to_http_body(
|
|
299
|
-
|
|
300
|
-
|
|
357
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
358
|
+
|
|
359
|
+
# return_type
|
|
360
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
|
361
|
+
|
|
362
|
+
# auth_names
|
|
363
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
364
|
+
|
|
365
|
+
new_options = opts.merge(
|
|
366
|
+
:operation => :"CollectionApi.edit_collection",
|
|
301
367
|
:header_params => header_params,
|
|
302
368
|
:query_params => query_params,
|
|
303
369
|
:form_params => form_params,
|
|
304
370
|
:body => post_body,
|
|
305
371
|
:auth_names => auth_names,
|
|
306
|
-
:return_type =>
|
|
372
|
+
:return_type => return_type
|
|
373
|
+
)
|
|
374
|
+
|
|
375
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
307
376
|
if @api_client.config.debugging
|
|
308
377
|
@api_client.config.logger.debug "API called: CollectionApi#edit_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
309
378
|
end
|
|
@@ -311,57 +380,63 @@ module FlatApi
|
|
|
311
380
|
end
|
|
312
381
|
|
|
313
382
|
# 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
|
|
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
|
|
316
384
|
# @param [Hash] opts the optional parameters
|
|
317
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.
|
|
318
386
|
# @return [Collection]
|
|
319
387
|
def get_collection(collection, opts = {})
|
|
320
388
|
data, _status_code, _headers = get_collection_with_http_info(collection, opts)
|
|
321
|
-
|
|
389
|
+
data
|
|
322
390
|
end
|
|
323
391
|
|
|
324
392
|
# 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
|
|
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
|
|
327
394
|
# @param [Hash] opts the optional parameters
|
|
328
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.
|
|
329
|
-
# @return [Array<(Collection,
|
|
396
|
+
# @return [Array<(Collection, Integer, Hash)>] Collection data, response status code and response headers
|
|
330
397
|
def get_collection_with_http_info(collection, opts = {})
|
|
331
398
|
if @api_client.config.debugging
|
|
332
|
-
@api_client.config.logger.debug
|
|
399
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.get_collection ...'
|
|
333
400
|
end
|
|
334
401
|
# verify the required parameter 'collection' is set
|
|
335
402
|
if @api_client.config.client_side_validation && collection.nil?
|
|
336
403
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.get_collection"
|
|
337
404
|
end
|
|
338
405
|
# resource path
|
|
339
|
-
local_var_path =
|
|
406
|
+
local_var_path = '/collections/{collection}'.sub('{collection}', CGI.escape(collection.to_s))
|
|
340
407
|
|
|
341
408
|
# query parameters
|
|
342
|
-
query_params = {}
|
|
409
|
+
query_params = opts[:query_params] || {}
|
|
343
410
|
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
344
411
|
|
|
345
412
|
# header parameters
|
|
346
|
-
header_params = {}
|
|
413
|
+
header_params = opts[:header_params] || {}
|
|
347
414
|
# HTTP header 'Accept' (if needed)
|
|
348
|
-
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'])
|
|
415
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
351
416
|
|
|
352
417
|
# form parameters
|
|
353
|
-
form_params = {}
|
|
418
|
+
form_params = opts[:form_params] || {}
|
|
354
419
|
|
|
355
420
|
# http body (model)
|
|
356
|
-
post_body =
|
|
357
|
-
|
|
358
|
-
|
|
421
|
+
post_body = opts[:debug_body]
|
|
422
|
+
|
|
423
|
+
# return_type
|
|
424
|
+
return_type = opts[:debug_return_type] || 'Collection'
|
|
425
|
+
|
|
426
|
+
# auth_names
|
|
427
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
428
|
+
|
|
429
|
+
new_options = opts.merge(
|
|
430
|
+
:operation => :"CollectionApi.get_collection",
|
|
359
431
|
:header_params => header_params,
|
|
360
432
|
:query_params => query_params,
|
|
361
433
|
:form_params => form_params,
|
|
362
434
|
:body => post_body,
|
|
363
435
|
:auth_names => auth_names,
|
|
364
|
-
:return_type =>
|
|
436
|
+
:return_type => return_type
|
|
437
|
+
)
|
|
438
|
+
|
|
439
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
365
440
|
if @api_client.config.debugging
|
|
366
441
|
@api_client.config.logger.debug "API called: CollectionApi#get_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
367
442
|
end
|
|
@@ -369,45 +444,47 @@ module FlatApi
|
|
|
369
444
|
end
|
|
370
445
|
|
|
371
446
|
# 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.
|
|
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`.
|
|
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
|
|
374
449
|
# @param [Hash] opts the optional parameters
|
|
375
|
-
# @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
450
|
# @option opts [String] :sort Sort
|
|
377
451
|
# @option opts [String] :direction Sort direction
|
|
378
452
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
379
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.
|
|
380
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.
|
|
381
456
|
# @return [Array<ScoreDetails>]
|
|
382
457
|
def list_collection_scores(collection, opts = {})
|
|
383
458
|
data, _status_code, _headers = list_collection_scores_with_http_info(collection, opts)
|
|
384
|
-
|
|
459
|
+
data
|
|
385
460
|
end
|
|
386
461
|
|
|
387
462
|
# 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.
|
|
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`.
|
|
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
|
|
390
465
|
# @param [Hash] opts the optional parameters
|
|
391
|
-
# @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
466
|
# @option opts [String] :sort Sort
|
|
393
467
|
# @option opts [String] :direction Sort direction
|
|
394
|
-
# @option opts [Integer] :limit This is the maximum number of objects that may be returned
|
|
468
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
395
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.
|
|
396
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.
|
|
397
|
-
# @
|
|
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.
|
|
472
|
+
# @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
|
|
398
473
|
def list_collection_scores_with_http_info(collection, opts = {})
|
|
399
474
|
if @api_client.config.debugging
|
|
400
|
-
@api_client.config.logger.debug
|
|
475
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.list_collection_scores ...'
|
|
401
476
|
end
|
|
402
477
|
# verify the required parameter 'collection' is set
|
|
403
478
|
if @api_client.config.client_side_validation && collection.nil?
|
|
404
479
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.list_collection_scores"
|
|
405
480
|
end
|
|
406
|
-
|
|
407
|
-
|
|
481
|
+
allowable_values = ["creationDate", "modificationDate", "title"]
|
|
482
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
483
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
408
484
|
end
|
|
409
|
-
|
|
410
|
-
|
|
485
|
+
allowable_values = ["asc", "desc"]
|
|
486
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
|
487
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
|
411
488
|
end
|
|
412
489
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
413
490
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collection_scores, must be smaller than or equal to 100.'
|
|
@@ -418,37 +495,45 @@ module FlatApi
|
|
|
418
495
|
end
|
|
419
496
|
|
|
420
497
|
# resource path
|
|
421
|
-
local_var_path =
|
|
498
|
+
local_var_path = '/collections/{collection}/scores'.sub('{collection}', CGI.escape(collection.to_s))
|
|
422
499
|
|
|
423
500
|
# query parameters
|
|
424
|
-
query_params = {}
|
|
425
|
-
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
501
|
+
query_params = opts[:query_params] || {}
|
|
426
502
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
427
503
|
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
|
428
504
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
429
505
|
query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
|
|
430
506
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
|
507
|
+
query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil?
|
|
431
508
|
|
|
432
509
|
# header parameters
|
|
433
|
-
header_params = {}
|
|
510
|
+
header_params = opts[:header_params] || {}
|
|
434
511
|
# HTTP header 'Accept' (if needed)
|
|
435
|
-
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'])
|
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
438
513
|
|
|
439
514
|
# form parameters
|
|
440
|
-
form_params = {}
|
|
515
|
+
form_params = opts[:form_params] || {}
|
|
441
516
|
|
|
442
517
|
# http body (model)
|
|
443
|
-
post_body =
|
|
444
|
-
|
|
445
|
-
|
|
518
|
+
post_body = opts[:debug_body]
|
|
519
|
+
|
|
520
|
+
# return_type
|
|
521
|
+
return_type = opts[:debug_return_type] || 'Array<ScoreDetails>'
|
|
522
|
+
|
|
523
|
+
# auth_names
|
|
524
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
525
|
+
|
|
526
|
+
new_options = opts.merge(
|
|
527
|
+
:operation => :"CollectionApi.list_collection_scores",
|
|
446
528
|
:header_params => header_params,
|
|
447
529
|
:query_params => query_params,
|
|
448
530
|
:form_params => form_params,
|
|
449
531
|
:body => post_body,
|
|
450
532
|
:auth_names => auth_names,
|
|
451
|
-
:return_type =>
|
|
533
|
+
:return_type => return_type
|
|
534
|
+
)
|
|
535
|
+
|
|
536
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
452
537
|
if @api_client.config.debugging
|
|
453
538
|
@api_client.config.logger.debug "API called: CollectionApi#list_collection_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
454
539
|
end
|
|
@@ -456,9 +541,9 @@ module FlatApi
|
|
|
456
541
|
end
|
|
457
542
|
|
|
458
543
|
# List the collections
|
|
459
|
-
# 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`.
|
|
460
545
|
# @param [Hash] opts the optional parameters
|
|
461
|
-
# @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')
|
|
462
547
|
# @option opts [String] :sort Sort
|
|
463
548
|
# @option opts [String] :direction Sort direction
|
|
464
549
|
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
@@ -467,31 +552,30 @@ module FlatApi
|
|
|
467
552
|
# @return [Array<Collection>]
|
|
468
553
|
def list_collections(opts = {})
|
|
469
554
|
data, _status_code, _headers = list_collections_with_http_info(opts)
|
|
470
|
-
|
|
555
|
+
data
|
|
471
556
|
end
|
|
472
557
|
|
|
473
558
|
# List the collections
|
|
474
|
-
# 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`.
|
|
475
560
|
# @param [Hash] opts the optional parameters
|
|
476
|
-
# @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')
|
|
477
562
|
# @option opts [String] :sort Sort
|
|
478
563
|
# @option opts [String] :direction Sort direction
|
|
479
|
-
# @option opts [Integer] :limit This is the maximum number of objects that may be returned
|
|
564
|
+
# @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
|
|
480
565
|
# @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
566
|
# @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>,
|
|
567
|
+
# @return [Array<(Array<Collection>, Integer, Hash)>] Array<Collection> data, response status code and response headers
|
|
483
568
|
def list_collections_with_http_info(opts = {})
|
|
484
569
|
if @api_client.config.debugging
|
|
485
|
-
@api_client.config.logger.debug
|
|
486
|
-
end
|
|
487
|
-
if @api_client.config.client_side_validation && opts[:'parent'] && !['root', 'sharedWithMe', 'trash'].include?(opts[:'parent'])
|
|
488
|
-
fail ArgumentError, 'invalid value for "parent", must be one of root, sharedWithMe, trash'
|
|
570
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.list_collections ...'
|
|
489
571
|
end
|
|
490
|
-
|
|
491
|
-
|
|
572
|
+
allowable_values = ["creationDate", "modificationDate", "title"]
|
|
573
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
574
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
492
575
|
end
|
|
493
|
-
|
|
494
|
-
|
|
576
|
+
allowable_values = ["asc", "desc"]
|
|
577
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
|
578
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
|
495
579
|
end
|
|
496
580
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
497
581
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collections, must be smaller than or equal to 100.'
|
|
@@ -502,10 +586,10 @@ module FlatApi
|
|
|
502
586
|
end
|
|
503
587
|
|
|
504
588
|
# resource path
|
|
505
|
-
local_var_path =
|
|
589
|
+
local_var_path = '/collections'
|
|
506
590
|
|
|
507
591
|
# query parameters
|
|
508
|
-
query_params = {}
|
|
592
|
+
query_params = opts[:query_params] || {}
|
|
509
593
|
query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
|
|
510
594
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
511
595
|
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
|
@@ -514,25 +598,33 @@ module FlatApi
|
|
|
514
598
|
query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
|
|
515
599
|
|
|
516
600
|
# header parameters
|
|
517
|
-
header_params = {}
|
|
601
|
+
header_params = opts[:header_params] || {}
|
|
518
602
|
# HTTP header 'Accept' (if needed)
|
|
519
|
-
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'])
|
|
603
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
522
604
|
|
|
523
605
|
# form parameters
|
|
524
|
-
form_params = {}
|
|
606
|
+
form_params = opts[:form_params] || {}
|
|
525
607
|
|
|
526
608
|
# http body (model)
|
|
527
|
-
post_body =
|
|
528
|
-
|
|
529
|
-
|
|
609
|
+
post_body = opts[:debug_body]
|
|
610
|
+
|
|
611
|
+
# return_type
|
|
612
|
+
return_type = opts[:debug_return_type] || 'Array<Collection>'
|
|
613
|
+
|
|
614
|
+
# auth_names
|
|
615
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
616
|
+
|
|
617
|
+
new_options = opts.merge(
|
|
618
|
+
:operation => :"CollectionApi.list_collections",
|
|
530
619
|
:header_params => header_params,
|
|
531
620
|
:query_params => query_params,
|
|
532
621
|
:form_params => form_params,
|
|
533
622
|
:body => post_body,
|
|
534
623
|
:auth_names => auth_names,
|
|
535
|
-
:return_type =>
|
|
624
|
+
:return_type => return_type
|
|
625
|
+
)
|
|
626
|
+
|
|
627
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
536
628
|
if @api_client.config.debugging
|
|
537
629
|
@api_client.config.logger.debug "API called: CollectionApi#list_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
538
630
|
end
|
|
@@ -540,53 +632,62 @@ module FlatApi
|
|
|
540
632
|
end
|
|
541
633
|
|
|
542
634
|
# Untrash a collection
|
|
543
|
-
# 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.
|
|
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.
|
|
545
637
|
# @param [Hash] opts the optional parameters
|
|
546
|
-
# @return [
|
|
638
|
+
# @return [FlatErrorResponse]
|
|
547
639
|
def untrash_collection(collection, opts = {})
|
|
548
|
-
untrash_collection_with_http_info(collection, opts)
|
|
549
|
-
|
|
640
|
+
data, _status_code, _headers = untrash_collection_with_http_info(collection, opts)
|
|
641
|
+
data
|
|
550
642
|
end
|
|
551
643
|
|
|
552
644
|
# Untrash a collection
|
|
553
|
-
# 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.
|
|
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.
|
|
555
647
|
# @param [Hash] opts the optional parameters
|
|
556
|
-
# @return [Array<(
|
|
648
|
+
# @return [Array<(FlatErrorResponse, Integer, Hash)>] FlatErrorResponse data, response status code and response headers
|
|
557
649
|
def untrash_collection_with_http_info(collection, opts = {})
|
|
558
650
|
if @api_client.config.debugging
|
|
559
|
-
@api_client.config.logger.debug
|
|
651
|
+
@api_client.config.logger.debug 'Calling API: CollectionApi.untrash_collection ...'
|
|
560
652
|
end
|
|
561
653
|
# verify the required parameter 'collection' is set
|
|
562
654
|
if @api_client.config.client_side_validation && collection.nil?
|
|
563
655
|
fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.untrash_collection"
|
|
564
656
|
end
|
|
565
657
|
# resource path
|
|
566
|
-
local_var_path =
|
|
658
|
+
local_var_path = '/collections/{collection}/untrash'.sub('{collection}', CGI.escape(collection.to_s))
|
|
567
659
|
|
|
568
660
|
# query parameters
|
|
569
|
-
query_params = {}
|
|
661
|
+
query_params = opts[:query_params] || {}
|
|
570
662
|
|
|
571
663
|
# header parameters
|
|
572
|
-
header_params = {}
|
|
664
|
+
header_params = opts[:header_params] || {}
|
|
573
665
|
# HTTP header 'Accept' (if needed)
|
|
574
|
-
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'])
|
|
666
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
577
667
|
|
|
578
668
|
# form parameters
|
|
579
|
-
form_params = {}
|
|
669
|
+
form_params = opts[:form_params] || {}
|
|
580
670
|
|
|
581
671
|
# http body (model)
|
|
582
|
-
post_body =
|
|
583
|
-
|
|
584
|
-
|
|
672
|
+
post_body = opts[:debug_body]
|
|
673
|
+
|
|
674
|
+
# return_type
|
|
675
|
+
return_type = opts[:debug_return_type] || 'FlatErrorResponse'
|
|
676
|
+
|
|
677
|
+
# auth_names
|
|
678
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
679
|
+
|
|
680
|
+
new_options = opts.merge(
|
|
681
|
+
:operation => :"CollectionApi.untrash_collection",
|
|
585
682
|
:header_params => header_params,
|
|
586
683
|
:query_params => query_params,
|
|
587
684
|
:form_params => form_params,
|
|
588
685
|
:body => post_body,
|
|
589
|
-
:auth_names => auth_names
|
|
686
|
+
:auth_names => auth_names,
|
|
687
|
+
:return_type => return_type
|
|
688
|
+
)
|
|
689
|
+
|
|
690
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
590
691
|
if @api_client.config.debugging
|
|
591
692
|
@api_client.config.logger.debug "API called: CollectionApi#untrash_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
592
693
|
end
|